@endora-commerce/contracts 0.109.0 → 0.111.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/accept-language.d.ts +31 -0
- package/dist/accept-language.js +64 -0
- package/dist/actor.d.ts +16 -0
- package/dist/addresses.d.ts +35 -0
- package/dist/addresses.js +8 -1
- package/dist/admin-actions.d.ts +2 -0
- package/dist/admin-actions.js +18 -0
- package/dist/admin-contributions.d.ts +99 -12
- package/dist/admin-contributions.js +36 -10
- package/dist/admin-roles.d.ts +17 -2
- package/dist/admin-users.d.ts +9 -0
- package/dist/admin.d.ts +114 -4
- package/dist/admin.js +98 -3
- package/dist/api-keys.d.ts +22 -0
- package/dist/api-keys.js +4 -0
- package/dist/assets-library.d.ts +45 -0
- package/dist/assets-library.js +20 -3
- package/dist/audit-logs.d.ts +12 -0
- package/dist/audit-logs.js +12 -0
- package/dist/auth.d.ts +9 -0
- package/dist/auth.js +9 -0
- package/dist/blog.d.ts +382 -22
- package/dist/blog.js +199 -17
- package/dist/carts.d.ts +423 -36
- package/dist/carts.js +150 -12
- package/dist/catalog.d.ts +379 -208
- package/dist/catalog.js +241 -163
- package/dist/cms-brand.d.ts +14 -14
- package/dist/cms.d.ts +71 -16
- package/dist/cms.js +15 -0
- package/dist/command-hooks.d.ts +301 -0
- package/dist/command-hooks.js +248 -0
- package/dist/common.d.ts +23 -6
- package/dist/common.js +25 -2
- package/dist/comparisons.d.ts +21 -14
- package/dist/comparisons.js +2 -1
- package/dist/credit-limits.d.ts +22 -0
- package/dist/credit-limits.js +35 -0
- package/dist/crm.d.ts +134 -78
- package/dist/crm.js +21 -5
- package/dist/custom-fields.d.ts +417 -49
- package/dist/custom-fields.js +142 -1
- package/dist/customer-accounts.d.ts +324 -22
- package/dist/customer-accounts.js +43 -0
- package/dist/customer-notifications.d.ts +143 -0
- package/dist/customer-notifications.js +41 -0
- package/dist/customers.d.ts +92 -73
- package/dist/customers.js +98 -10
- package/dist/dictionary.d.ts +53 -0
- package/dist/dictionary.js +25 -0
- package/dist/document-templates.d.ts +12 -12
- package/dist/email.d.ts +34 -0
- package/dist/email.js +6 -0
- package/dist/errors.d.ts +431 -3
- package/dist/errors.js +523 -3
- package/dist/forms-logic.d.ts +79 -0
- package/dist/forms-logic.fixtures.d.ts +52 -0
- package/dist/forms-logic.fixtures.js +610 -0
- package/dist/forms-logic.js +699 -0
- package/dist/forms.d.ts +9833 -0
- package/dist/forms.js +827 -0
- package/dist/i18n.d.ts +34 -0
- package/dist/i18n.js +15 -0
- package/dist/import-export.d.ts +180 -0
- package/dist/import-export.js +60 -0
- package/dist/index.d.ts +16 -1
- package/dist/index.js +30 -1
- package/dist/inventory.d.ts +9 -9
- package/dist/invoice-ledger.d.ts +13 -13
- package/dist/invoices.d.ts +126 -0
- package/dist/invoices.js +53 -0
- package/dist/line-bounds.d.ts +53 -0
- package/dist/line-bounds.js +65 -0
- package/dist/megamenu.d.ts +27 -27
- package/dist/mfa.d.ts +210 -4
- package/dist/mfa.js +136 -0
- package/dist/modules.d.ts +56 -8
- package/dist/modules.js +128 -3
- package/dist/money-decimal.d.ts +54 -0
- package/dist/money-decimal.js +95 -0
- package/dist/newsletter.d.ts +4 -4
- package/dist/orders.d.ts +246 -12
- package/dist/orders.js +140 -7
- package/dist/organization-hooks.d.ts +99 -0
- package/dist/organization-hooks.js +22 -0
- package/dist/organization-registry-lookup.d.ts +362 -0
- package/dist/organization-registry-lookup.js +196 -0
- package/dist/organization-roles.d.ts +341 -0
- package/dist/organization-roles.js +218 -0
- package/dist/organizations.d.ts +1074 -103
- package/dist/organizations.js +293 -28
- package/dist/page-builder-props.d.ts +56 -56
- package/dist/pim-connector.d.ts +7 -3
- package/dist/pim-connector.js +6 -2
- package/dist/pim-field-path.d.ts +5 -1
- package/dist/pim-field-path.js +37 -81
- package/dist/pim-locale-mapping.d.ts +131 -0
- package/dist/pim-locale-mapping.js +193 -0
- package/dist/price-books.d.ts +215 -63
- package/dist/price-books.js +47 -2
- package/dist/price-lists.d.ts +13 -10
- package/dist/product-feeds.d.ts +249 -100
- package/dist/product-feeds.js +46 -2
- package/dist/product-scope-model.d.ts +161 -0
- package/dist/product-scope-model.js +161 -0
- package/dist/product-scope-overrides.d.ts +0 -103
- package/dist/product-scope-overrides.js +0 -54
- package/dist/product-scoped-values.d.ts +2610 -0
- package/dist/product-scoped-values.js +425 -0
- package/dist/product-scopes.d.ts +199 -64
- package/dist/product-scopes.js +120 -23
- package/dist/product-tax-rates.d.ts +38 -0
- package/dist/product-tax-rates.js +45 -0
- package/dist/product-url-keys.d.ts +51 -45
- package/dist/product-url-keys.js +73 -39
- package/dist/product-value-resolver.d.ts +37 -60
- package/dist/product-value-resolver.js +36 -96
- package/dist/projects.d.ts +76 -28
- package/dist/projects.js +53 -9
- package/dist/promotions.d.ts +163 -11
- package/dist/promotions.js +23 -1
- package/dist/pwa.d.ts +41 -2
- package/dist/quick-order.d.ts +159 -9
- package/dist/quick-order.js +79 -4
- package/dist/quote-requests.d.ts +231 -17
- package/dist/quote-requests.js +111 -9
- package/dist/record-references.d.ts +15 -15
- package/dist/record-references.js +2 -3
- package/dist/record-rich-text.js +2 -1
- package/dist/returns.d.ts +214 -52
- package/dist/returns.js +143 -28
- package/dist/sales-channels.d.ts +34 -3
- package/dist/sales-channels.js +16 -1
- package/dist/saved-list-views.d.ts +28 -0
- package/dist/saved-list-views.js +14 -1
- package/dist/schema-extensions.d.ts +36 -0
- package/dist/schema-extensions.js +29 -0
- package/dist/scoped-write-encoding.d.ts +100 -0
- package/dist/scoped-write-encoding.js +135 -0
- package/dist/search.d.ts +18 -16
- package/dist/seo.d.ts +83 -30
- package/dist/seo.js +8 -1
- package/dist/settings.d.ts +173 -2
- package/dist/settings.js +53 -2
- package/dist/shopping-lists.d.ts +63 -4
- package/dist/shopping-lists.js +57 -3
- package/dist/storefront-cache-tags.d.ts +22 -0
- package/dist/storefront-cache-tags.js +12 -0
- package/dist/storefront-value-overrides.d.ts +18 -56
- package/dist/storefront-value-overrides.js +11 -86
- package/dist/tasks.d.ts +27 -27
- package/dist/taxes.d.ts +27 -0
- package/dist/taxes.js +4 -0
- package/dist/transactional-emails.d.ts +48 -22
- package/dist/webhooks.d.ts +75 -0
- package/dist/webhooks.js +24 -0
- package/package.json +5 -3
- package/dist/actor.d.ts.map +0 -1
- package/dist/actor.js.map +0 -1
- package/dist/addresses.d.ts.map +0 -1
- package/dist/addresses.js.map +0 -1
- package/dist/admin-actions.d.ts.map +0 -1
- package/dist/admin-actions.js.map +0 -1
- package/dist/admin-contributions.d.ts.map +0 -1
- package/dist/admin-contributions.js.map +0 -1
- package/dist/admin-feedback.d.ts.map +0 -1
- package/dist/admin-feedback.js.map +0 -1
- package/dist/admin-i18n.d.ts.map +0 -1
- package/dist/admin-i18n.js.map +0 -1
- package/dist/admin-name.d.ts.map +0 -1
- package/dist/admin-name.js.map +0 -1
- package/dist/admin-notifications.d.ts.map +0 -1
- package/dist/admin-notifications.js.map +0 -1
- package/dist/admin-preferences.d.ts.map +0 -1
- package/dist/admin-preferences.js.map +0 -1
- package/dist/admin-roles.d.ts.map +0 -1
- package/dist/admin-roles.js.map +0 -1
- package/dist/admin-search.d.ts.map +0 -1
- package/dist/admin-search.js.map +0 -1
- package/dist/admin-users.d.ts.map +0 -1
- package/dist/admin-users.js.map +0 -1
- package/dist/admin.d.ts.map +0 -1
- package/dist/admin.js.map +0 -1
- package/dist/analytics.d.ts.map +0 -1
- package/dist/analytics.js.map +0 -1
- package/dist/api-keys.d.ts.map +0 -1
- package/dist/api-keys.js.map +0 -1
- package/dist/assets-library.d.ts.map +0 -1
- package/dist/assets-library.js.map +0 -1
- package/dist/audit-logs.d.ts.map +0 -1
- package/dist/audit-logs.js.map +0 -1
- package/dist/auth.d.ts.map +0 -1
- package/dist/auth.js.map +0 -1
- package/dist/blog.d.ts.map +0 -1
- package/dist/blog.js.map +0 -1
- package/dist/capabilities.d.ts.map +0 -1
- package/dist/capabilities.js.map +0 -1
- package/dist/carts.d.ts.map +0 -1
- package/dist/carts.js.map +0 -1
- package/dist/catalog.d.ts.map +0 -1
- package/dist/catalog.js.map +0 -1
- package/dist/cms-brand.d.ts.map +0 -1
- package/dist/cms-brand.js.map +0 -1
- package/dist/cms-contact-form.d.ts.map +0 -1
- package/dist/cms-contact-form.js.map +0 -1
- package/dist/cms.d.ts.map +0 -1
- package/dist/cms.js.map +0 -1
- package/dist/common.d.ts.map +0 -1
- package/dist/common.js.map +0 -1
- package/dist/comparisons.d.ts.map +0 -1
- package/dist/comparisons.js.map +0 -1
- package/dist/credentials.d.ts.map +0 -1
- package/dist/credentials.js.map +0 -1
- package/dist/credit-limits.d.ts.map +0 -1
- package/dist/credit-limits.js.map +0 -1
- package/dist/crm-rich-text.d.ts.map +0 -1
- package/dist/crm-rich-text.js.map +0 -1
- package/dist/crm.d.ts.map +0 -1
- package/dist/crm.js.map +0 -1
- package/dist/currencies.d.ts.map +0 -1
- package/dist/currencies.js.map +0 -1
- package/dist/custom-fields.d.ts.map +0 -1
- package/dist/custom-fields.js.map +0 -1
- package/dist/customer-accounts.d.ts.map +0 -1
- package/dist/customer-accounts.js.map +0 -1
- package/dist/customers.d.ts.map +0 -1
- package/dist/customers.js.map +0 -1
- package/dist/dictionary.d.ts.map +0 -1
- package/dist/dictionary.js.map +0 -1
- package/dist/document-templates.d.ts.map +0 -1
- package/dist/document-templates.js.map +0 -1
- package/dist/document-values.d.ts.map +0 -1
- package/dist/document-values.js.map +0 -1
- package/dist/email-address.d.ts.map +0 -1
- package/dist/email-address.js.map +0 -1
- package/dist/email.d.ts.map +0 -1
- package/dist/email.js.map +0 -1
- package/dist/envelopes.d.ts.map +0 -1
- package/dist/envelopes.js.map +0 -1
- package/dist/environment-inputs.d.ts.map +0 -1
- package/dist/environment-inputs.js.map +0 -1
- package/dist/erp-connector.d.ts.map +0 -1
- package/dist/erp-connector.js.map +0 -1
- package/dist/errors.d.ts.map +0 -1
- package/dist/errors.js.map +0 -1
- package/dist/google-analytics.d.ts.map +0 -1
- package/dist/google-analytics.js.map +0 -1
- package/dist/google-tag-manager.d.ts.map +0 -1
- package/dist/google-tag-manager.js.map +0 -1
- package/dist/i18n.d.ts.map +0 -1
- package/dist/i18n.js.map +0 -1
- package/dist/import-export.d.ts.map +0 -1
- package/dist/import-export.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/inventory.d.ts.map +0 -1
- package/dist/inventory.js.map +0 -1
- package/dist/invoice-ledger.d.ts.map +0 -1
- package/dist/invoice-ledger.js.map +0 -1
- package/dist/invoices.d.ts.map +0 -1
- package/dist/invoices.js.map +0 -1
- package/dist/kernel.d.ts.map +0 -1
- package/dist/kernel.js.map +0 -1
- package/dist/languages.d.ts.map +0 -1
- package/dist/languages.js.map +0 -1
- package/dist/line-groups.d.ts.map +0 -1
- package/dist/line-groups.js.map +0 -1
- package/dist/linkedin-ads.d.ts.map +0 -1
- package/dist/linkedin-ads.js.map +0 -1
- package/dist/localized-name.d.ts.map +0 -1
- package/dist/localized-name.js.map +0 -1
- package/dist/megamenu.d.ts.map +0 -1
- package/dist/megamenu.js.map +0 -1
- package/dist/meta-ads.d.ts.map +0 -1
- package/dist/meta-ads.js.map +0 -1
- package/dist/mfa.d.ts.map +0 -1
- package/dist/mfa.js.map +0 -1
- package/dist/modules.d.ts.map +0 -1
- package/dist/modules.js.map +0 -1
- package/dist/money-decimal.d.ts.map +0 -1
- package/dist/money-decimal.js.map +0 -1
- package/dist/money-input.d.ts.map +0 -1
- package/dist/money-input.js.map +0 -1
- package/dist/newsletter.d.ts.map +0 -1
- package/dist/newsletter.js.map +0 -1
- package/dist/order-minimums.d.ts.map +0 -1
- package/dist/order-minimums.js.map +0 -1
- package/dist/orders.d.ts.map +0 -1
- package/dist/orders.js.map +0 -1
- package/dist/organizations.d.ts.map +0 -1
- package/dist/organizations.js.map +0 -1
- package/dist/page-builder-props.d.ts.map +0 -1
- package/dist/page-builder-props.js.map +0 -1
- package/dist/page-builder-values.d.ts.map +0 -1
- package/dist/page-builder-values.js.map +0 -1
- package/dist/pagination.d.ts.map +0 -1
- package/dist/pagination.js.map +0 -1
- package/dist/payment-methods.d.ts.map +0 -1
- package/dist/payment-methods.js.map +0 -1
- package/dist/payment-return-url.d.ts.map +0 -1
- package/dist/payment-return-url.js.map +0 -1
- package/dist/payments.d.ts.map +0 -1
- package/dist/payments.js.map +0 -1
- package/dist/pim-connector.d.ts.map +0 -1
- package/dist/pim-connector.js.map +0 -1
- package/dist/pim-field-path.d.ts.map +0 -1
- package/dist/pim-field-path.js.map +0 -1
- package/dist/platform-info.d.ts.map +0 -1
- package/dist/platform-info.js.map +0 -1
- package/dist/platform-language.d.ts.map +0 -1
- package/dist/platform-language.js.map +0 -1
- package/dist/price-book-decimal.d.ts.map +0 -1
- package/dist/price-book-decimal.js.map +0 -1
- package/dist/price-books.d.ts.map +0 -1
- package/dist/price-books.js.map +0 -1
- package/dist/price-lists.d.ts.map +0 -1
- package/dist/price-lists.js.map +0 -1
- package/dist/product-feeds.d.ts.map +0 -1
- package/dist/product-feeds.js.map +0 -1
- package/dist/product-scope-overrides.d.ts.map +0 -1
- package/dist/product-scope-overrides.js.map +0 -1
- package/dist/product-scopes.d.ts.map +0 -1
- package/dist/product-scopes.js.map +0 -1
- package/dist/product-summary-text.d.ts.map +0 -1
- package/dist/product-summary-text.js.map +0 -1
- package/dist/product-url-keys.d.ts.map +0 -1
- package/dist/product-url-keys.js.map +0 -1
- package/dist/product-value-resolver.d.ts.map +0 -1
- package/dist/product-value-resolver.js.map +0 -1
- package/dist/projects.d.ts.map +0 -1
- package/dist/projects.js.map +0 -1
- package/dist/promotions.d.ts.map +0 -1
- package/dist/promotions.js.map +0 -1
- package/dist/prompt-actions.d.ts.map +0 -1
- package/dist/prompt-actions.js.map +0 -1
- package/dist/pwa.d.ts.map +0 -1
- package/dist/pwa.js.map +0 -1
- package/dist/quick-order.d.ts.map +0 -1
- package/dist/quick-order.js.map +0 -1
- package/dist/quote-requests.d.ts.map +0 -1
- package/dist/quote-requests.js.map +0 -1
- package/dist/record-references.d.ts.map +0 -1
- package/dist/record-references.js.map +0 -1
- package/dist/record-rich-text.d.ts.map +0 -1
- package/dist/record-rich-text.js.map +0 -1
- package/dist/returns.d.ts.map +0 -1
- package/dist/returns.js.map +0 -1
- package/dist/sales-channels.d.ts.map +0 -1
- package/dist/sales-channels.js.map +0 -1
- package/dist/saved-list-views.d.ts.map +0 -1
- package/dist/saved-list-views.js.map +0 -1
- package/dist/scope-notice.d.ts.map +0 -1
- package/dist/scope-notice.js.map +0 -1
- package/dist/scoped-translations.d.ts +0 -48
- package/dist/scoped-translations.d.ts.map +0 -1
- package/dist/scoped-translations.js +0 -78
- package/dist/scoped-translations.js.map +0 -1
- package/dist/search.d.ts.map +0 -1
- package/dist/search.js.map +0 -1
- package/dist/seo.d.ts.map +0 -1
- package/dist/seo.js.map +0 -1
- package/dist/settings.d.ts.map +0 -1
- package/dist/settings.js.map +0 -1
- package/dist/shipments.d.ts.map +0 -1
- package/dist/shipments.js.map +0 -1
- package/dist/shipping-methods.d.ts.map +0 -1
- package/dist/shipping-methods.js.map +0 -1
- package/dist/shopping-lists.d.ts.map +0 -1
- package/dist/shopping-lists.js.map +0 -1
- package/dist/storefront-cache-tags.d.ts.map +0 -1
- package/dist/storefront-cache-tags.js.map +0 -1
- package/dist/storefront-language-path.d.ts.map +0 -1
- package/dist/storefront-language-path.js.map +0 -1
- package/dist/storefront-value-overrides.d.ts.map +0 -1
- package/dist/storefront-value-overrides.js.map +0 -1
- package/dist/tasks.d.ts.map +0 -1
- package/dist/tasks.js.map +0 -1
- package/dist/taxes.d.ts.map +0 -1
- package/dist/taxes.js.map +0 -1
- package/dist/text-normalization.d.ts.map +0 -1
- package/dist/text-normalization.js.map +0 -1
- package/dist/transactional-emails.d.ts.map +0 -1
- package/dist/transactional-emails.js.map +0 -1
- package/dist/webhooks.d.ts.map +0 -1
- package/dist/webhooks.js.map +0 -1
package/dist/custom-fields.js
CHANGED
|
@@ -30,7 +30,50 @@ export const supportedEntityTypeSchema = z.enum([
|
|
|
30
30
|
// while that module is present.
|
|
31
31
|
'task',
|
|
32
32
|
]);
|
|
33
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* The one custom-field host binding registry (`specs/178-extensible-columns/`
|
|
35
|
+
* FR-010, research R-8).
|
|
36
|
+
*
|
|
37
|
+
* Moved here from `custom_fields`' module-internal storage binding so that two
|
|
38
|
+
* readers can share one answer: `custom_fields` reads it for the table and the
|
|
39
|
+
* value column its host probes and list filters build against, and the platform
|
|
40
|
+
* derives its extensible host list from it — every custom-field host table is
|
|
41
|
+
* extensible (OD-15), so a second list of them would be a second answer waiting
|
|
42
|
+
* to disagree. Purely a storage binding: no host logic lives here, and neither
|
|
43
|
+
* the table nor the column ever comes from a caller.
|
|
44
|
+
*/
|
|
45
|
+
export const CUSTOM_FIELD_HOST_BINDINGS = {
|
|
46
|
+
category: { table: 'categories', valueColumn: 'custom_field_values', ownerModuleId: 'catalog' },
|
|
47
|
+
order: { table: 'orders', valueColumn: 'custom_field_values', ownerModuleId: 'orders' },
|
|
48
|
+
organization: {
|
|
49
|
+
table: 'organizations',
|
|
50
|
+
valueColumn: 'custom_field_values',
|
|
51
|
+
ownerModuleId: 'organizations',
|
|
52
|
+
},
|
|
53
|
+
customer: {
|
|
54
|
+
table: 'customer_accounts',
|
|
55
|
+
valueColumn: 'custom_field_values',
|
|
56
|
+
ownerModuleId: 'customer_accounts',
|
|
57
|
+
},
|
|
58
|
+
quote_request: {
|
|
59
|
+
table: 'quote_requests',
|
|
60
|
+
valueColumn: 'custom_field_values',
|
|
61
|
+
ownerModuleId: 'quote_requests',
|
|
62
|
+
},
|
|
63
|
+
product: { table: 'products', valueColumn: 'attribute_values', ownerModuleId: 'catalog' },
|
|
64
|
+
opportunity: { table: 'crm_opportunities', valueColumn: 'custom_field_values', ownerModuleId: 'crm' },
|
|
65
|
+
project: { table: 'projects', valueColumn: 'custom_field_values', ownerModuleId: 'projects' },
|
|
66
|
+
task: { table: 'tasks', valueColumn: 'custom_field_values', ownerModuleId: 'tasks' },
|
|
67
|
+
};
|
|
68
|
+
/**
|
|
69
|
+
* The set of runtime value types. `text` is stored as a string; `select` stores one option value; `multiselect` an array.
|
|
70
|
+
*
|
|
71
|
+
* `page_builder` (feature 172) is a Page Builder document per language. It is
|
|
72
|
+
* never a field value: the generic value path refuses it, no list filter
|
|
73
|
+
* applies to it, and a definition may take it only on an entity type whose
|
|
74
|
+
* registry entry offers it (`product` alone) — the document lives in its
|
|
75
|
+
* host's own storage.
|
|
76
|
+
*/
|
|
34
77
|
export const customFieldValueTypeSchema = z.enum([
|
|
35
78
|
'text',
|
|
36
79
|
'number',
|
|
@@ -38,6 +81,7 @@ export const customFieldValueTypeSchema = z.enum([
|
|
|
38
81
|
'date',
|
|
39
82
|
'select',
|
|
40
83
|
'multiselect',
|
|
84
|
+
'page_builder',
|
|
41
85
|
]);
|
|
42
86
|
/** Per-locale label map (BCP-47-keyed). Empty is allowed when only `labelDefault` is filled. */
|
|
43
87
|
/**
|
|
@@ -53,6 +97,23 @@ export const customFieldValueTypeSchema = z.enum([
|
|
|
53
97
|
* already being answered.
|
|
54
98
|
*/
|
|
55
99
|
export const customFieldAudienceSchema = z.enum(['customer', 'internal']);
|
|
100
|
+
/**
|
|
101
|
+
* Feature 175 — the forms on which a BUYER may supply a custom-field value
|
|
102
|
+
* (`specs/175-buyer-input-custom-fields/`, OD-3). A closed vocabulary: the
|
|
103
|
+
* next surface is a release, not data an operator types. A definition names
|
|
104
|
+
* the surfaces it is open on (`customerInput`); an entity type's registry entry
|
|
105
|
+
* names the surfaces it offers at all.
|
|
106
|
+
*/
|
|
107
|
+
export const customFieldInputSurfaceSchema = z.enum(['organization.register']);
|
|
108
|
+
/**
|
|
109
|
+
* Feature 175 — how the admin custom-field panel offers a field: `edit`
|
|
110
|
+
* (an input), `read` (the value, no input) or `hidden` (not rendered).
|
|
111
|
+
*
|
|
112
|
+
* **A panel convenience, not access control** (OD-8, FR-007): no API endpoint
|
|
113
|
+
* reads it, so what the admin API accepts, answers, filters, exports and
|
|
114
|
+
* audits is the same at every level. A `required` field is always `edit`.
|
|
115
|
+
*/
|
|
116
|
+
export const customFieldAdminAccessSchema = z.enum(['edit', 'read', 'hidden']);
|
|
56
117
|
export const localizedLabelSchema = z.record(z.string(), z.string());
|
|
57
118
|
/** A select/multiselect option. `id` absent on create. */
|
|
58
119
|
export const customFieldOptionSchema = z.object({
|
|
@@ -115,10 +176,27 @@ export const customFieldDefinitionSchema = z.object({
|
|
|
115
176
|
listFilter: z.boolean(),
|
|
116
177
|
/** See {@link customFieldCarryToSchema} (feature 162). */
|
|
117
178
|
carryTo: customFieldCarryToSchema,
|
|
179
|
+
/**
|
|
180
|
+
* Feature 175 — the input surfaces a buyer may supply this field's value on
|
|
181
|
+
* ({@link customFieldInputSurfaceSchema}). Only surfaces the entity type
|
|
182
|
+
* offers ({@link customFieldEntityTypeInfoSchema}); non-empty only with the
|
|
183
|
+
* `customer` audience and never for `page_builder`. Stored deduplicated and
|
|
184
|
+
* sorted.
|
|
185
|
+
*/
|
|
186
|
+
customerInput: z.array(customFieldInputSurfaceSchema),
|
|
187
|
+
/** Feature 175 — see {@link customFieldAdminAccessSchema}. */
|
|
188
|
+
adminAccess: customFieldAdminAccessSchema,
|
|
118
189
|
options: z.array(customFieldOptionSchema).default([]),
|
|
119
190
|
createdAt: isoDateTimeSchema,
|
|
120
191
|
updatedAt: isoDateTimeSchema,
|
|
121
192
|
});
|
|
193
|
+
/**
|
|
194
|
+
* `GET /api/v1/admin/custom-fields/definitions` — the definitions, optionally of
|
|
195
|
+
* one entity type, whose type's owner module is present (issue #599).
|
|
196
|
+
*/
|
|
197
|
+
export const customFieldDefinitionListResponseSchema = z.object({
|
|
198
|
+
data: z.array(customFieldDefinitionSchema),
|
|
199
|
+
});
|
|
122
200
|
/** Create a definition. `entityType` + `key` are immutable after create. */
|
|
123
201
|
export const createCustomFieldDefinitionSchema = customFieldDefinitionSchema
|
|
124
202
|
.omit({ id: true, createdAt: true, updatedAt: true })
|
|
@@ -127,10 +205,14 @@ export const createCustomFieldDefinitionSchema = customFieldDefinitionSchema
|
|
|
127
205
|
// A definition created without `listFilter` is not a list filter; the
|
|
128
206
|
// server reads the absence as `false` rather than the schema defaulting it.
|
|
129
207
|
// A definition created without `carryTo` carries nothing (feature 162).
|
|
208
|
+
// Feature 175 — one created without `customerInput` is open on no surface,
|
|
209
|
+
// and one without `adminAccess` is editable in the admin panel.
|
|
130
210
|
.extend({
|
|
131
211
|
audience: customFieldAudienceSchema.default('internal'),
|
|
132
212
|
listFilter: z.boolean().optional(),
|
|
133
213
|
carryTo: customFieldCarryToSchema.default([]),
|
|
214
|
+
customerInput: z.array(customFieldInputSurfaceSchema).default([]),
|
|
215
|
+
adminAccess: customFieldAdminAccessSchema.default('edit'),
|
|
134
216
|
});
|
|
135
217
|
/** Patch a definition. `entityType` and `key` cannot change once records may hold values. */
|
|
136
218
|
export const updateCustomFieldDefinitionSchema = createCustomFieldDefinitionSchema
|
|
@@ -146,6 +228,8 @@ export const updateCustomFieldDefinitionSchema = createCustomFieldDefinitionSche
|
|
|
146
228
|
config: z.record(z.string(), z.unknown()).optional(),
|
|
147
229
|
listFilter: z.boolean().optional(),
|
|
148
230
|
carryTo: customFieldCarryToSchema.optional(),
|
|
231
|
+
customerInput: z.array(customFieldInputSurfaceSchema).optional(),
|
|
232
|
+
adminAccess: customFieldAdminAccessSchema.optional(),
|
|
149
233
|
});
|
|
150
234
|
/**
|
|
151
235
|
* One supported host entity type as served by the admin entity-types listing
|
|
@@ -171,6 +255,16 @@ export const customFieldEntityTypeInfoSchema = z.object({
|
|
|
171
255
|
* (feature 162), filtered to targets whose owner module is present.
|
|
172
256
|
*/
|
|
173
257
|
carryTargets: z.array(supportedEntityTypeSchema).default([]),
|
|
258
|
+
/**
|
|
259
|
+
* Feature 175 — the input surfaces definitions of this type may be opened
|
|
260
|
+
* on; the definition editor offers the buyer-input option only when it is
|
|
261
|
+
* non-empty (FR-035).
|
|
262
|
+
*/
|
|
263
|
+
customerInputSurfaces: z.array(customFieldInputSurfaceSchema).default([]),
|
|
264
|
+
});
|
|
265
|
+
/** `GET /api/v1/admin/custom-fields/entity-types` — the served entity types (issue #599). */
|
|
266
|
+
export const customFieldEntityTypeListResponseSchema = z.object({
|
|
267
|
+
data: z.array(customFieldEntityTypeInfoSchema),
|
|
174
268
|
});
|
|
175
269
|
/** A validated value bag keyed by definition `key`. Values are typed by their definition's `valueType`. */
|
|
176
270
|
export const customFieldValuesSchema = z.record(z.string(), z.unknown());
|
|
@@ -183,6 +277,12 @@ export const customFieldValidationErrorSchema = z.object({
|
|
|
183
277
|
'unknown_option',
|
|
184
278
|
'out_of_range',
|
|
185
279
|
'duplicate_option',
|
|
280
|
+
// Feature 175 — a buyer-supplied key that is not a live definition open on
|
|
281
|
+
// the surface (also every key when the value port is not composed).
|
|
282
|
+
'not_open_for_input',
|
|
283
|
+
// Feature 175 — more than 50 keys in one buyer-supplied group; `field` is
|
|
284
|
+
// the group's name, not a key.
|
|
285
|
+
'too_many_keys',
|
|
186
286
|
]),
|
|
187
287
|
message: z.string(),
|
|
188
288
|
});
|
|
@@ -221,6 +321,9 @@ export const CUSTOM_FIELD_FILTER_OPERATORS = {
|
|
|
221
321
|
date: ['from', 'to'],
|
|
222
322
|
select: ['in'],
|
|
223
323
|
multiselect: ['in'],
|
|
324
|
+
// Feature 172 — a Page Builder document is not a filterable value: every
|
|
325
|
+
// operator on such a field is refused, never ignored.
|
|
326
|
+
page_builder: [],
|
|
224
327
|
};
|
|
225
328
|
/**
|
|
226
329
|
* Throws the `ZodError` naming every operator of `filters` that does not apply
|
|
@@ -323,6 +426,33 @@ export const customFieldListFilterFieldSchema = z
|
|
|
323
426
|
options: z.array(z.object({ value: z.string(), label: localizedLabelSchema, labelDefault: z.string() })),
|
|
324
427
|
})
|
|
325
428
|
.strict();
|
|
429
|
+
/**
|
|
430
|
+
* Feature 175 — one field open on a buyer input surface, as the public read
|
|
431
|
+
* `GET /api/v1/custom-fields/input-surfaces/:surface` answers it
|
|
432
|
+
* (`specs/175-buyer-input-custom-fields/contracts/input-surface-read.md`).
|
|
433
|
+
* Labels are resolved in the request's language with `labelDefault` as the
|
|
434
|
+
* fallback. Never a stored value, the audience, the admin access level or
|
|
435
|
+
* `config`; never a `page_builder` field.
|
|
436
|
+
*/
|
|
437
|
+
export const inputSurfaceFieldSchema = z.object({
|
|
438
|
+
key: z.string(),
|
|
439
|
+
valueType: customFieldValueTypeSchema.exclude(['page_builder']),
|
|
440
|
+
required: z.boolean(),
|
|
441
|
+
label: z.string(),
|
|
442
|
+
/** `[]` unless the field is `select` / `multiselect`. */
|
|
443
|
+
options: z.array(z.object({ value: z.string(), label: z.string() })),
|
|
444
|
+
sortOrder: z.number().int(),
|
|
445
|
+
});
|
|
446
|
+
/**
|
|
447
|
+
* The fields open on one surface, per entity type in display order. An
|
|
448
|
+
* unknown surface, or one no entity type declares, answers `entities: {}`.
|
|
449
|
+
*/
|
|
450
|
+
export const inputSurfaceFieldsResponseSchema = z.object({
|
|
451
|
+
data: z.object({
|
|
452
|
+
surface: z.string(),
|
|
453
|
+
entities: z.partialRecord(supportedEntityTypeSchema, z.array(inputSurfaceFieldSchema)),
|
|
454
|
+
}),
|
|
455
|
+
});
|
|
326
456
|
export const customFieldListFilterFieldsResponseSchema = z.object({
|
|
327
457
|
data: z.array(customFieldListFilterFieldSchema),
|
|
328
458
|
});
|
|
@@ -388,6 +518,17 @@ export const CUSTOM_FIELD_DEFINITION_ERROR_CODES = [
|
|
|
388
518
|
'list_filter_unsupported',
|
|
389
519
|
// Feature 162 — a carry target turned on that cannot take the definition's values.
|
|
390
520
|
'carry_incompatible',
|
|
521
|
+
// Feature 172 — a value type the definition's entity type does not offer (`page_builder` off `product`).
|
|
522
|
+
'value_type_unsupported',
|
|
523
|
+
// Feature 175 (research R-4) — the four refusals of the buyer-input and
|
|
524
|
+
// admin-access attributes, each judged on the RESULTING definition: a
|
|
525
|
+
// surface the entity type does not offer; an open field whose audience is
|
|
526
|
+
// not `customer`; an open `page_builder` field; a `required` field that is
|
|
527
|
+
// not `edit` in the admin.
|
|
528
|
+
'customer_input_unsupported',
|
|
529
|
+
'customer_input_audience',
|
|
530
|
+
'customer_input_value_type',
|
|
531
|
+
'admin_access_required',
|
|
391
532
|
];
|
|
392
533
|
/**
|
|
393
534
|
* Whether `error` is a refused definition write, narrowed by shape.
|