Custom Entities & Fields

entities · @open-mercato/core In every app in 0.8.0

User-defined entities, custom fields, and dynamic records storage.

Found by static analysis of the 0.8.0 source. Links that only appear at runtime are not visible here.

1 of the 1 module outside the starter set that entities needs in code is missing from its requires.

A newer release exists: entities in 0.9.0.

Before you enable `entities` in 0.8.0

4 modules its code requires

✓ 1 declared⚠ 1 not declared, outside the starter set2 not declared, in every app

Enable these yourself, they are not in every starter app

translations⚠ Gap

Already enabled in every starter app: 3 modules.

2 more are optional: the module loses a feature without them.

Before you disable `entities` in 0.8.0

14 modules require it in code

None of them declares it in requires.

Not declared by

auth⚠ Gapin every app catalog⚠ Gapin every app checkout⚠ Gapin every app configs⚠ Gapin every app customers⚠ Gapin every app directory⚠ Gapin every app integrations⚠ Gapin every app resources⚠ Gapin every app sales⚠ Gapin every app staff⚠ Gapin every app sync_akeneo⚠ Gapin every app sync_excel⚠ Gapin every app translations⚠ Gapin every app workflows⚠ Gapin every app

1 more uses it optionally or for collaboration.

Required, declared ⚠ Gap: required in code, not in requires ⚠ Gap into a module every starter app has (lower risk) Optional Collaboration In requires only, not seen in code In every starter appA dot takes its module's area colour. Each side lists the areas in the order of the map.Reads left to right: what uses it → entities → what it needs. Select a module to go to its row.

Needs

Modules entities needs in 0.8.0
Module	In code	requires	package.json
Module: `translations`	In code: Required · ui	requires: ⚠ Gap	package.json: Same package
1 place Import → Required · ui · `packages/core/src/modules/entities/backend/entities/user/[entityId]/page.tsx:29` · `@open-mercato/core/modules/translations/components/TranslationManager`
Module: `currencies`	In code: Optional · api	requires: Not declared	package.json: Same package
1 place Entity import in try/catch → Optional · api · `packages/core/src/modules/entities/api/definitions.ts:104` · `@open-mercato/core/modules/currencies/data/entities`
Module: `dictionaries`	In code: Optional · api	requires: Not declared	package.json: Same package
1 place Entity import in try/catch → Optional · api · `packages/core/src/modules/entities/api/definitions.ts:85` · `@open-mercato/core/modules/dictionaries/data/entities`

In every app (3)

Modules entities needs in 0.8.0 that every starter app enables
Module	In code	requires	package.json
Module: `auth`	In code: Required · lib	requires: ⚠ Gap in every app	package.json: Same package
1 place Entity import → Required · lib · `packages/core/src/modules/entities/lib/makeActivityRoute.ts:7` · `@open-mercato/core/modules/auth/data/entities`
Module: `directory`	In code: Required · api, cli, lib	requires: ⚠ Gap in every app	package.json: Same package
6 places Import → Required · api · `packages/core/src/modules/entities/api/definitions.ts:18` · `@open-mercato/core/modules/directory/utils/organizationScope` Import → Required · api · `packages/core/src/modules/entities/api/encryption.ts:14` · `@open-mercato/core/modules/directory/utils/organizationScope` Import → Required · api · `packages/core/src/modules/entities/api/records.ts:8` · `@open-mercato/core/modules/directory/utils/organizationScope` Entity import → Required · cli · `packages/core/src/modules/entities/cli.ts:29` · `../directory/data/entities` Import → Required · lib · `packages/core/src/modules/entities/lib/definition-scope.ts:2` · `@open-mercato/core/modules/directory/utils/organizationScope` Entity import → Required · lib · `packages/core/src/modules/entities/lib/install-from-ce.ts:5` · `@open-mercato/core/modules/directory/data/entities`
Module: `query_index`	In code: Required · api	requires: ✓ Declared	package.json: Same package
1 place Service lookup (DI) → Required · api · `packages/core/src/modules/entities/api/relations/options.ts:48` · `queryEngine`

Used by

Modules that use entities in 0.8.0
Module	In code	requires	package.json
Module: `catalog`	In code: Required · api, seed	requires: ⚠ Gap in every app	package.json: Same package
3 places Import → Required · api · `packages/core/src/modules/catalog/api/products/route.ts:43` · `@open-mercato/core/modules/entities/data/validators` Import → Required · seed · `packages/core/src/modules/catalog/seed/examples.ts:17` · `@open-mercato/core/modules/entities/lib/field-definitions` Entity import → Required · seed · `packages/core/src/modules/catalog/seed/examples.ts:21` · `@open-mercato/core/modules/entities/data/entities`
Module: `checkout`	In code: Required · lib, seed	requires: ⚠ Gap in every app	package.json: ✓ Declared
3 places Import → Required · lib · `packages/checkout/src/modules/checkout/lib/customFields.ts:8` · `@open-mercato/core/modules/entities/lib/fieldsets` Entity import → Required · seed · `packages/checkout/src/modules/checkout/seed/customFields.ts:2` · `@open-mercato/core/modules/entities/data/entities` Import → Required · seed · `packages/checkout/src/modules/checkout/seed/customFields.ts:3` · `@open-mercato/core/modules/entities/lib/field-definitions`
Module: `customers`	In code: Required · cli, command, lib	requires: ⚠ Gap in every app	package.json: Same package
5 places Import → Required · cli · `packages/core/src/modules/customers/cli.ts:7` · `@open-mercato/core/modules/entities/lib/install-from-ce` Import → Required · cli · `packages/core/src/modules/customers/cli.ts:9` · `@open-mercato/core/modules/entities/lib/field-definitions` Entity import → Required · command · `packages/core/src/modules/customers/commands/companies.ts:55` · `@open-mercato/core/modules/entities/data/entities` Entity import → Required · command · `packages/core/src/modules/customers/commands/people.ts:28` · `@open-mercato/core/modules/entities/data/entities` Entity import → Required · lib · `packages/core/src/modules/customers/lib/customFieldRouting.ts:2` · `@open-mercato/core/modules/entities/data/entities`
Module: `integrations`	In code: Required · lib	requires: ⚠ Gap in every app	package.json: Same package
1 place Entity import → Required · lib · `packages/core/src/modules/integrations/lib/credentials-service.ts:12` · `../../entities/data/entities`
Module: `resources`	In code: Required · api, lib	requires: ⚠ Gap in every app	package.json: Same package
4 places Import → Required · api · `packages/core/src/modules/resources/api/activities.ts:1` · `@open-mercato/core/modules/entities/lib/makeActivityRoute` Import → Required · lib · `packages/core/src/modules/resources/lib/seeds.ts:5` · `@open-mercato/core/modules/entities/lib/field-definitions` Entity import → Required · lib · `packages/core/src/modules/resources/lib/seeds.ts:6` · `@open-mercato/core/modules/entities/data/entities` Import → Required · lib · `packages/core/src/modules/resources/lib/seeds.ts:7` · `@open-mercato/core/modules/entities/lib/helpers`
Module: `sales`	In code: Required · command	requires: ⚠ Gap in every app	package.json: Same package
4 places Import → Required · command · `packages/core/src/modules/sales/commands/documents.ts:28` · `@open-mercato/core/modules/entities/lib/helpers` Entity import → Required · command · `packages/core/src/modules/sales/commands/documents.ts:65` · `@open-mercato/core/modules/entities/data/entities` Import → Required · command · `packages/core/src/modules/sales/commands/payments.ts:9` · `@open-mercato/core/modules/entities/lib/helpers` Import → Required · command · `packages/core/src/modules/sales/commands/shipments.ts:10` · `@open-mercato/core/modules/entities/lib/helpers`
Module: `staff`	In code: Required · api, lib	requires: ⚠ Gap in every app	package.json: Same package
4 places Import → Required · api · `packages/core/src/modules/staff/api/activities.ts:1` · `@open-mercato/core/modules/entities/lib/makeActivityRoute` Entity import → Required · lib · `packages/core/src/modules/staff/lib/seeds.ts:5` · `@open-mercato/core/modules/entities/data/entities` Import → Required · lib · `packages/core/src/modules/staff/lib/seeds.ts:6` · `@open-mercato/core/modules/entities/lib/field-definitions` Import → Required · lib · `packages/core/src/modules/staff/lib/seeds.ts:7` · `@open-mercato/core/modules/entities/lib/helpers`
Module: `sync_akeneo`	In code: Required · api, lib	requires: ⚠ Gap in every app	package.json: ✓ Declared
5 places Entity import → Required · api · `packages/sync-akeneo/src/modules/sync_akeneo/api/custom-fields/route.ts:8` · `@open-mercato/core/modules/entities/data/entities` Import → Required · lib · `packages/sync-akeneo/src/modules/sync_akeneo/lib/catalog-importer.ts:22` · `@open-mercato/core/modules/entities/lib/field-definitions` Entity import → Required · lib · `packages/sync-akeneo/src/modules/sync_akeneo/lib/catalog-importer.ts:23` · `@open-mercato/core/modules/entities/data/entities` Import → Required · lib · `packages/sync-akeneo/src/modules/sync_akeneo/lib/catalog-importer.ts:24` · `@open-mercato/core/modules/entities/lib/fieldsets` Import → Required · lib · `packages/sync-akeneo/src/modules/sync_akeneo/lib/catalog-importer.ts:25` · `@open-mercato/core/modules/entities/api/definitions.cache`
Module: `sync_excel`	In code: Required · lib	requires: ⚠ Gap in every app	package.json: Same package
1 place Entity import → Required · lib · `packages/core/src/modules/sync_excel/lib/adapters/customers.ts:18` · `../../../entities/data/entities`
Module: `translations`	In code: Required · di	requires: ⚠ Gap in every app	package.json: Same package
1 place Import → Required · di · `packages/core/src/modules/translations/di.ts:6` · `../entities/translations`
Module: `workflows`	In code: Required · lib	requires: ⚠ Gap in every app	package.json: Same package
3 places Import → Required · lib · `packages/core/src/modules/workflows/lib/task-entity-access.ts:40` · `@open-mercato/core/modules/entities/lib/entityClassification` Import → Required · lib · `packages/core/src/modules/workflows/lib/task-entity-access.ts:41` · `@open-mercato/core/modules/entities/lib/entityAcl` Import → Required · lib · `packages/core/src/modules/workflows/lib/task-entity-access.ts:42` · `@open-mercato/core/modules/entities/lib/recordFeatures`
Module: `auth`	In code: Required · api, lib, ui	requires: ⚠ Gap in every app	package.json: Same package
3 places Import → Required · api · `packages/core/src/modules/auth/api/features.ts:7` · `@open-mercato/core/modules/entities/lib/restrictedEntityFeatures` Entity import → Required · ui · `packages/core/src/modules/auth/lib/backendChrome.tsx:35` · `@open-mercato/core/modules/entities/data/entities` Entity import → Required · lib · `packages/core/src/modules/auth/lib/setup-app.ts:11` · `@open-mercato/core/modules/entities/data/entities`
Module: `configs`	In code: Required · lib	requires: ⚠ Gap in every app	package.json: Same package
2 places Dynamic import → Required · lib · `packages/core/src/modules/configs/lib/upgrade-actions.ts:81` · `@open-mercato/core/modules/entities/cli` Dynamic import → Required · lib · `packages/core/src/modules/configs/lib/upgrade-actions.ts:144` · `@open-mercato/core/modules/entities/cli`
Module: `directory`	In code: Required · api	requires: ⚠ Gap in every app	package.json: Same package
1 place Entity import → Required · api · `packages/core/src/modules/directory/api/tenants/tenant-cf-filter.ts:4` · `@open-mercato/core/modules/entities/data/entities`
Module: `attachments`	In code: Optional · api	requires: Not declared	package.json: Same package
1 place Entity import in try/catch → Optional · api · `packages/core/src/modules/attachments/api/route.ts:347` · `@open-mercato/core/modules/entities/data/entities`

Facts

Hosts widget spots (2)

data-table:entities.system.list · packages/core/src/modules/entities/extension-points.ts:6
data-table:entities.user.list · packages/core/src/modules/entities/extension-points.ts:7

Entities (6)

CustomFieldDef · packages/core/src/modules/entities/data/entities.ts:25
CustomFieldEntityConfig · packages/core/src/modules/entities/data/entities.ts:80
CustomEntity · packages/core/src/modules/entities/data/entities.ts:112
CustomEntityStorage · packages/core/src/modules/entities/data/entities.ts:171
CustomFieldValue · packages/core/src/modules/entities/data/entities.ts:206
EncryptionMap · packages/core/src/modules/entities/data/entities.ts:257