@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
|
@@ -0,0 +1,425 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Feature 174 (`specs/174-product-editor-scope-switcher/contracts/scoped-values-api.md`; research
|
|
3
|
+
* R4–R8, R21) — the product editor's one read, one save, copy to channels and the editor scope
|
|
4
|
+
* preference. Owner: `catalog`.
|
|
5
|
+
*
|
|
6
|
+
* Every scoped value is written in the one write encoding (`scoped-write-encoding.ts`): absent or
|
|
7
|
+
* `""` = no change, `null` = empty override, `{ inherit: true }` = inherit, else the value. Field
|
|
8
|
+
* paths and scope sets: `product-scope-model.ts`. Bounds (R21): every object is strict, record
|
|
9
|
+
* keys are validated (and `__proto__` / `constructor` / `prototype` refused), lengths and the
|
|
10
|
+
* changed-cell count are capped; the service reads the records into a `Map`.
|
|
11
|
+
*/
|
|
12
|
+
import { z } from 'zod';
|
|
13
|
+
import { ERROR_CODES } from './errors.js';
|
|
14
|
+
import { isoDateTimeSchema, productVisibilitySchema, UUID_SHAPE_PATTERN, uuidSchema } from './common.js';
|
|
15
|
+
import { PRODUCT_DESCRIPTION_MAX, PRODUCT_NAME_MAX, productStatusSchema, productTypeSchema } from './catalog.js';
|
|
16
|
+
import { ORDER_MINIMUM_MAX } from './order-minimums.js';
|
|
17
|
+
import { SCOPED_SOURCES } from './product-scope-model.js';
|
|
18
|
+
import { fieldPathSchema, scopeMissingValueSchema, scopeRequestSchema, scopeWarningSchema } from './product-scopes.js';
|
|
19
|
+
import { PRODUCT_URL_KEY_MAX, productSlugSchema, URL_KEY_TAKEOVER_MAX } from './product-url-keys.js';
|
|
20
|
+
import { scopeVersionTokenSchema, scopedWrite } from './scoped-write-encoding.js';
|
|
21
|
+
// --- Bounds (R21) -----------------------------------------------------------------------------
|
|
22
|
+
/** The longest text attribute value at any scope. */
|
|
23
|
+
export const SCOPED_TEXT_ATTRIBUTE_MAX = 4000;
|
|
24
|
+
/** The most organisations one audience value names. */
|
|
25
|
+
export const SCOPED_AUDIENCE_ORGANIZATIONS_MAX = 500;
|
|
26
|
+
/** The most changed cells one save carries. */
|
|
27
|
+
export const SCOPED_SAVE_CELLS_MAX = 500;
|
|
28
|
+
/** Route body limits, in bytes. */
|
|
29
|
+
export const SCOPED_VALUES_BODY_LIMIT = 1024 * 1024;
|
|
30
|
+
export const SCOPED_VALUES_COPY_BODY_LIMIT = 64 * 1024;
|
|
31
|
+
/** A before / after audit cell longer than this is stored `{ truncated, length, sha256 }`. */
|
|
32
|
+
export const SCOPED_AUDIT_CELL_MAX_BYTES = 4096;
|
|
33
|
+
/** The most target channels one copy names. */
|
|
34
|
+
export const SCOPED_COPY_TARGETS_MAX = 64;
|
|
35
|
+
/** SEO field lengths (`contracts/seo-ports.md` §2). */
|
|
36
|
+
export const SEO_PRODUCT_META_MAX = {
|
|
37
|
+
title: 160,
|
|
38
|
+
description: 400,
|
|
39
|
+
ogTitle: 160,
|
|
40
|
+
ogDescription: 400,
|
|
41
|
+
ogImageUrl: 2048,
|
|
42
|
+
};
|
|
43
|
+
const FORBIDDEN_RECORD_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
|
|
44
|
+
/** A gallery, attachment or packaging-unit key: the shared uuid shape, lowercase only, as the rows store it. */
|
|
45
|
+
const uuidKeySchema = z.string().regex(new RegExp(`^${UUID_SHAPE_PATTERN.replaceAll('a-fA-F', 'a-f')}$`), 'uuid key');
|
|
46
|
+
const attributeKeySchema = z
|
|
47
|
+
.string()
|
|
48
|
+
.regex(/^[a-z0-9_]{1,64}$/, 'attribute key')
|
|
49
|
+
.refine((key) => !FORBIDDEN_RECORD_KEYS.has(key), 'reserved key');
|
|
50
|
+
/** An absolute `http:` / `https:` URL — the only image URLs product SEO accepts (R21). */
|
|
51
|
+
/**
|
|
52
|
+
* A record of at most `max` keys, every key matching `keySchema` and none reserved — checked on
|
|
53
|
+
* the raw object **before** any entry is parsed (R21, C1 review), so an oversized body is refused
|
|
54
|
+
* without parsing it and a `__proto__` own key (as `JSON.parse` produces it) is refused rather
|
|
55
|
+
* than silently dropped when the parsed record is assembled.
|
|
56
|
+
*/
|
|
57
|
+
function boundedRecord(keySchema, valueSchema, max) {
|
|
58
|
+
return z
|
|
59
|
+
.unknown()
|
|
60
|
+
.superRefine((raw, ctx) => {
|
|
61
|
+
if (typeof raw !== 'object' || raw === null || Array.isArray(raw))
|
|
62
|
+
return;
|
|
63
|
+
const keys = Object.keys(raw);
|
|
64
|
+
if (keys.length > max) {
|
|
65
|
+
ctx.addIssue({ code: 'custom', message: `At most ${max} keys.` });
|
|
66
|
+
return;
|
|
67
|
+
}
|
|
68
|
+
for (const key of keys) {
|
|
69
|
+
if (FORBIDDEN_RECORD_KEYS.has(key))
|
|
70
|
+
ctx.addIssue({ code: 'custom', path: [key], message: 'reserved key' });
|
|
71
|
+
}
|
|
72
|
+
})
|
|
73
|
+
.pipe(z.record(keySchema, valueSchema));
|
|
74
|
+
}
|
|
75
|
+
export const httpUrlSchema = z
|
|
76
|
+
.string()
|
|
77
|
+
.max(SEO_PRODUCT_META_MAX.ogImageUrl)
|
|
78
|
+
.regex(/^https?:\/\/[^\s/?#\\@]+(?:[/?#][^\s\\]*)?$/i, 'http(s) URL');
|
|
79
|
+
// --- §1 Scope ---------------------------------------------------------------------------------
|
|
80
|
+
export const scopeRefSchema = z.discriminatedUnion('level', [
|
|
81
|
+
z.object({ level: z.literal('global') }),
|
|
82
|
+
z.object({ level: z.literal('channel'), channelId: uuidSchema }),
|
|
83
|
+
z.object({ level: z.literal('channel_language'), channelId: uuidSchema, languageCode: z.string().min(1).max(16) }),
|
|
84
|
+
]);
|
|
85
|
+
export { scopeRequestSchema };
|
|
86
|
+
// --- §2 Read ----------------------------------------------------------------------------------
|
|
87
|
+
export const scopedSourceSchema = z.enum(SCOPED_SOURCES);
|
|
88
|
+
export const scopeLevelShortSchema = z.enum(['G', 'C', 'CL']);
|
|
89
|
+
/** The level an inherited value comes from: the channel (`C`) or Global (`G`). */
|
|
90
|
+
export const INHERITED_LEVELS = ['G', 'C'];
|
|
91
|
+
/** One field at the read's scope (FR-109). */
|
|
92
|
+
export function scopedFieldViewSchema(valueSchema) {
|
|
93
|
+
return z.object({
|
|
94
|
+
/** The effective value; `null` when the source is `set_empty` or `absent`. */
|
|
95
|
+
value: valueSchema.nullable(),
|
|
96
|
+
source: scopedSourceSchema,
|
|
97
|
+
/** Present when the source is `set` / `set_empty`: the value stored at this scope. */
|
|
98
|
+
ownValue: valueSchema.nullable().optional(),
|
|
99
|
+
/**
|
|
100
|
+
* Present at Channel and Channel × language, absent at Global (owner decision 2026-11-03):
|
|
101
|
+
* what the field would read if it inherited at this scope — the parent's effective value
|
|
102
|
+
* (`null` for a deliberately empty parent, or for no value at Global) and the level it comes
|
|
103
|
+
* from.
|
|
104
|
+
*/
|
|
105
|
+
inheritedValue: z
|
|
106
|
+
.object({ value: valueSchema.nullable(), level: z.enum(INHERITED_LEVELS) })
|
|
107
|
+
.strict()
|
|
108
|
+
.optional(),
|
|
109
|
+
levels: z.array(scopeLevelShortSchema),
|
|
110
|
+
/** The scope's level is in `levels` (FR-082). */
|
|
111
|
+
supportedHere: z.boolean(),
|
|
112
|
+
/** Refuses an empty override (FR-062). */
|
|
113
|
+
required: z.boolean(),
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
const windowValueSchema = z.object({ from: isoDateTimeSchema.nullable(), until: isoDateTimeSchema.nullable() }).strict();
|
|
117
|
+
const audienceValueSchema = z
|
|
118
|
+
.object({
|
|
119
|
+
visibility: productVisibilitySchema,
|
|
120
|
+
allowedOrganizationIds: z.array(uuidSchema).max(SCOPED_AUDIENCE_ORGANIZATIONS_MAX),
|
|
121
|
+
})
|
|
122
|
+
.strict();
|
|
123
|
+
/**
|
|
124
|
+
* The roles keyed by the camelCase name of the gallery label (`baseImage` = `base_image`,
|
|
125
|
+
* Principle VI: API keys are camelCase; the label spelling stays a value).
|
|
126
|
+
*/
|
|
127
|
+
const galleryRolesView = z.object({
|
|
128
|
+
baseImage: scopedFieldViewSchema(uuidSchema),
|
|
129
|
+
smallImage: scopedFieldViewSchema(uuidSchema),
|
|
130
|
+
thumbnail: scopedFieldViewSchema(uuidSchema),
|
|
131
|
+
});
|
|
132
|
+
const seoView = z.object({
|
|
133
|
+
title: scopedFieldViewSchema(z.string()),
|
|
134
|
+
description: scopedFieldViewSchema(z.string()),
|
|
135
|
+
ogTitle: scopedFieldViewSchema(z.string()),
|
|
136
|
+
ogDescription: scopedFieldViewSchema(z.string()),
|
|
137
|
+
ogImageUrl: scopedFieldViewSchema(z.string()),
|
|
138
|
+
});
|
|
139
|
+
/** §2.1 — what the completeness gate reports at the read's scope (FR-097). */
|
|
140
|
+
export const completenessSummarySchema = z.discriminatedUnion('level', [
|
|
141
|
+
z.object({ level: z.literal('channel_language'), missing: z.array(scopeMissingValueSchema) }),
|
|
142
|
+
z.object({
|
|
143
|
+
level: z.literal('channel'),
|
|
144
|
+
missing: z.array(z.object({ field: scopeMissingValueSchema, languages: z.array(z.string()) })),
|
|
145
|
+
}),
|
|
146
|
+
z.object({ level: z.literal('global'), incompleteScopes: z.number().int().nonnegative() }),
|
|
147
|
+
]);
|
|
148
|
+
export const scopedValuesDataSchema = z.object({
|
|
149
|
+
scope: scopeRefSchema,
|
|
150
|
+
/** `products.scope_version`, opaque (R7). */
|
|
151
|
+
version: z.string(),
|
|
152
|
+
validScopes: z.object({
|
|
153
|
+
channels: z.array(z.object({
|
|
154
|
+
channelId: uuidSchema,
|
|
155
|
+
name: z.string(),
|
|
156
|
+
languages: z.array(z.object({ code: z.string(), name: z.string() })),
|
|
157
|
+
})),
|
|
158
|
+
}),
|
|
159
|
+
/** Global-only fields, always the Global value (FR-081). */
|
|
160
|
+
product: z.object({
|
|
161
|
+
sku: z.string(),
|
|
162
|
+
type: productTypeSchema,
|
|
163
|
+
attributeSetId: uuidSchema,
|
|
164
|
+
categoryIds: z.array(uuidSchema),
|
|
165
|
+
archivedAt: isoDateTimeSchema.nullable(),
|
|
166
|
+
slugGlobal: z.string(),
|
|
167
|
+
manageStock: z.boolean(),
|
|
168
|
+
backorderEnabled: z.boolean(),
|
|
169
|
+
lowStockThreshold: z.number().int().nullable(),
|
|
170
|
+
lowStockThresholdMode: z.enum(['cumulative', 'per_warehouse']),
|
|
171
|
+
fulfilmentStrategy: z.string().nullable(),
|
|
172
|
+
fulfilmentStrategyWarehouseOrder: z.array(uuidSchema).nullable(),
|
|
173
|
+
downloadAssetId: uuidSchema.nullable(),
|
|
174
|
+
downloadUrl: z.string().nullable(),
|
|
175
|
+
allowedOrganizationIds: z.array(uuidSchema),
|
|
176
|
+
}),
|
|
177
|
+
fields: z.object({
|
|
178
|
+
name: scopedFieldViewSchema(z.string()),
|
|
179
|
+
description: scopedFieldViewSchema(z.string()),
|
|
180
|
+
status: scopedFieldViewSchema(productStatusSchema),
|
|
181
|
+
window: scopedFieldViewSchema(windowValueSchema),
|
|
182
|
+
audience: scopedFieldViewSchema(audienceValueSchema),
|
|
183
|
+
minOrderQuantity: scopedFieldViewSchema(z.number().int()),
|
|
184
|
+
returnable: scopedFieldViewSchema(z.boolean()),
|
|
185
|
+
urlKey: scopedFieldViewSchema(z.string()),
|
|
186
|
+
}),
|
|
187
|
+
attributes: z.array(z.object({
|
|
188
|
+
key: z.string(),
|
|
189
|
+
label: z.record(z.string(), z.string()),
|
|
190
|
+
valueType: z.string(),
|
|
191
|
+
isRequired: z.boolean(),
|
|
192
|
+
view: scopedFieldViewSchema(z.unknown()),
|
|
193
|
+
})),
|
|
194
|
+
gallery: z.object({
|
|
195
|
+
items: z.array(z.object({
|
|
196
|
+
id: uuidSchema,
|
|
197
|
+
assetId: uuidSchema,
|
|
198
|
+
url: z.string(),
|
|
199
|
+
position: z.number().int().nonnegative(),
|
|
200
|
+
altText: scopedFieldViewSchema(z.string()),
|
|
201
|
+
hidden: scopedFieldViewSchema(z.boolean()),
|
|
202
|
+
/** The asset's own alt text in the scope's language — the derived fallback. */
|
|
203
|
+
assetAltText: z.string().nullable(),
|
|
204
|
+
})),
|
|
205
|
+
roles: galleryRolesView,
|
|
206
|
+
}),
|
|
207
|
+
attachments: z.array(z.object({
|
|
208
|
+
id: uuidSchema,
|
|
209
|
+
assetId: uuidSchema,
|
|
210
|
+
typeId: uuidSchema,
|
|
211
|
+
position: z.number().int().nonnegative(),
|
|
212
|
+
fileName: z.string(),
|
|
213
|
+
name: scopedFieldViewSchema(z.string()),
|
|
214
|
+
description: scopedFieldViewSchema(z.string()),
|
|
215
|
+
hidden: scopedFieldViewSchema(z.boolean()),
|
|
216
|
+
})),
|
|
217
|
+
packagingUnits: z.array(z.object({
|
|
218
|
+
id: uuidSchema,
|
|
219
|
+
baseQuantity: z.number().int().positive(),
|
|
220
|
+
position: z.number().int().nonnegative(),
|
|
221
|
+
isDefault: z.boolean(),
|
|
222
|
+
minOrderUnits: z.number().int().positive().nullable(),
|
|
223
|
+
name: scopedFieldViewSchema(z.string()),
|
|
224
|
+
})),
|
|
225
|
+
/** `null` when `seo` is not effectively present (FR-092). */
|
|
226
|
+
seo: seoView.nullable(),
|
|
227
|
+
completeness: completenessSummarySchema,
|
|
228
|
+
/** Names for audience lists (163 U1). */
|
|
229
|
+
organizations: z.array(z.object({ id: uuidSchema, name: z.string() })),
|
|
230
|
+
});
|
|
231
|
+
export const scopedValuesResponseSchema = z.object({ data: scopedValuesDataSchema });
|
|
232
|
+
/** `GET …/scoped-values` query: the scope (§1). */
|
|
233
|
+
export const scopedValuesQuerySchema = scopeRequestSchema;
|
|
234
|
+
// --- §3 Save ----------------------------------------------------------------------------------
|
|
235
|
+
const nameValue = z.string().min(1).max(PRODUCT_NAME_MAX);
|
|
236
|
+
const descriptionValue = z.string().max(PRODUCT_DESCRIPTION_MAX);
|
|
237
|
+
const textValue = (max) => z.string().max(max);
|
|
238
|
+
/** The Global-only product fields a save writes at Global (FR-081); elsewhere `GLOBAL_ONLY_FIELD`. */
|
|
239
|
+
export const globalOnlyProductFieldsSchema = z
|
|
240
|
+
.object({
|
|
241
|
+
sku: z.string().min(1).max(255),
|
|
242
|
+
attributeSetId: uuidSchema,
|
|
243
|
+
categoryIds: z.array(uuidSchema).max(500),
|
|
244
|
+
manageStock: z.boolean(),
|
|
245
|
+
backorderEnabled: z.boolean(),
|
|
246
|
+
lowStockThreshold: z.number().int().nonnegative().nullable(),
|
|
247
|
+
lowStockThresholdMode: z.enum(['cumulative', 'per_warehouse']),
|
|
248
|
+
fulfilmentStrategy: z
|
|
249
|
+
.enum(['any', 'default_first', 'lowest_stock_first', 'highest_stock_first', 'defined_order'])
|
|
250
|
+
.nullable(),
|
|
251
|
+
fulfilmentStrategyWarehouseOrder: z.array(uuidSchema).max(500).nullable(),
|
|
252
|
+
downloadAssetId: uuidSchema.nullable(),
|
|
253
|
+
downloadUrl: z.string().url().max(2048).nullable(),
|
|
254
|
+
})
|
|
255
|
+
.partial()
|
|
256
|
+
.strict();
|
|
257
|
+
/**
|
|
258
|
+
* An attribute value: its schema is the attribute's value type, checked by the service against
|
|
259
|
+
* the definition (scope set, type, options, the 4 000-character text cap).
|
|
260
|
+
*/
|
|
261
|
+
const attributeValue = z.union([
|
|
262
|
+
z.string().max(SCOPED_TEXT_ATTRIBUTE_MAX),
|
|
263
|
+
z.number(),
|
|
264
|
+
z.boolean(),
|
|
265
|
+
z.array(z.string().max(255)).max(500),
|
|
266
|
+
]);
|
|
267
|
+
export const scopedValueChangesSchema = z
|
|
268
|
+
.object({
|
|
269
|
+
product: globalOnlyProductFieldsSchema.optional(),
|
|
270
|
+
name: scopedWrite(nameValue),
|
|
271
|
+
description: scopedWrite(descriptionValue),
|
|
272
|
+
status: scopedWrite(productStatusSchema),
|
|
273
|
+
window: scopedWrite(windowValueSchema),
|
|
274
|
+
audience: scopedWrite(audienceValueSchema),
|
|
275
|
+
minOrderQuantity: scopedWrite(z.number().int().min(1).max(ORDER_MINIMUM_MAX)),
|
|
276
|
+
returnable: scopedWrite(z.boolean()),
|
|
277
|
+
urlKey: scopedWrite(z
|
|
278
|
+
.string()
|
|
279
|
+
.max(PRODUCT_URL_KEY_MAX)
|
|
280
|
+
.transform((raw) => raw.normalize('NFC').toLowerCase())
|
|
281
|
+
.pipe(productSlugSchema)),
|
|
282
|
+
/** Honoured only by interactive `catalog:write` routes (163 FR-072). */
|
|
283
|
+
confirmTakeover: z.array(productSlugSchema).max(URL_KEY_TAKEOVER_MAX).optional(),
|
|
284
|
+
attributes: boundedRecord(attributeKeySchema, scopedWrite(attributeValue), SCOPED_SAVE_CELLS_MAX).optional(),
|
|
285
|
+
gallery: z
|
|
286
|
+
.object({
|
|
287
|
+
items: boundedRecord(uuidKeySchema, z.object({ altText: scopedWrite(textValue(255)), hidden: scopedWrite(z.boolean()) }).strict(), SCOPED_SAVE_CELLS_MAX).optional(),
|
|
288
|
+
roles: z
|
|
289
|
+
.object({
|
|
290
|
+
baseImage: scopedWrite(uuidSchema),
|
|
291
|
+
smallImage: scopedWrite(uuidSchema),
|
|
292
|
+
thumbnail: scopedWrite(uuidSchema),
|
|
293
|
+
})
|
|
294
|
+
.strict()
|
|
295
|
+
.optional(),
|
|
296
|
+
})
|
|
297
|
+
.strict()
|
|
298
|
+
.optional(),
|
|
299
|
+
attachments: boundedRecord(uuidKeySchema, z
|
|
300
|
+
.object({
|
|
301
|
+
name: scopedWrite(z.string().min(1).max(160)),
|
|
302
|
+
description: scopedWrite(textValue(4000)),
|
|
303
|
+
hidden: scopedWrite(z.boolean()),
|
|
304
|
+
})
|
|
305
|
+
.strict(), SCOPED_SAVE_CELLS_MAX).optional(),
|
|
306
|
+
packagingUnits: boundedRecord(uuidKeySchema, z.object({ name: scopedWrite(z.string().min(1).max(160)) }).strict(), SCOPED_SAVE_CELLS_MAX).optional(),
|
|
307
|
+
seo: z
|
|
308
|
+
.object({
|
|
309
|
+
title: scopedWrite(textValue(SEO_PRODUCT_META_MAX.title)),
|
|
310
|
+
description: scopedWrite(textValue(SEO_PRODUCT_META_MAX.description)),
|
|
311
|
+
ogTitle: scopedWrite(textValue(SEO_PRODUCT_META_MAX.ogTitle)),
|
|
312
|
+
ogDescription: scopedWrite(textValue(SEO_PRODUCT_META_MAX.ogDescription)),
|
|
313
|
+
ogImageUrl: scopedWrite(httpUrlSchema),
|
|
314
|
+
})
|
|
315
|
+
.strict()
|
|
316
|
+
.optional(),
|
|
317
|
+
})
|
|
318
|
+
.strict();
|
|
319
|
+
/** The number of changed cells in a `changes` body — the 500-cell cap counts these. */
|
|
320
|
+
export function countChangedCells(changes) {
|
|
321
|
+
let count = 0;
|
|
322
|
+
const countObject = (value) => {
|
|
323
|
+
if (value === undefined)
|
|
324
|
+
return;
|
|
325
|
+
for (const entry of Object.values(value))
|
|
326
|
+
if (entry !== undefined)
|
|
327
|
+
count += 1;
|
|
328
|
+
};
|
|
329
|
+
for (const key of ['name', 'description', 'status', 'window', 'audience', 'minOrderQuantity', 'returnable', 'urlKey']) {
|
|
330
|
+
if (changes[key] !== undefined)
|
|
331
|
+
count += 1;
|
|
332
|
+
}
|
|
333
|
+
countObject(changes.product);
|
|
334
|
+
countObject(changes.attributes);
|
|
335
|
+
for (const item of Object.values(changes.gallery?.items ?? {}))
|
|
336
|
+
countObject(item);
|
|
337
|
+
countObject(changes.gallery?.roles);
|
|
338
|
+
for (const attachment of Object.values(changes.attachments ?? {}))
|
|
339
|
+
countObject(attachment);
|
|
340
|
+
for (const unit of Object.values(changes.packagingUnits ?? {}))
|
|
341
|
+
countObject(unit);
|
|
342
|
+
countObject(changes.seo);
|
|
343
|
+
return count;
|
|
344
|
+
}
|
|
345
|
+
export const saveScopedValuesRequestSchema = z
|
|
346
|
+
.object({
|
|
347
|
+
scope: scopeRequestSchema,
|
|
348
|
+
version: scopeVersionTokenSchema,
|
|
349
|
+
changes: scopedValueChangesSchema,
|
|
350
|
+
})
|
|
351
|
+
.strict()
|
|
352
|
+
.refine((body) => countChangedCells(body.changes) <= SCOPED_SAVE_CELLS_MAX, {
|
|
353
|
+
message: `At most ${SCOPED_SAVE_CELLS_MAX} changed cells.`,
|
|
354
|
+
path: ['changes'],
|
|
355
|
+
});
|
|
356
|
+
export const saveScopedValuesResponseSchema = z.object({
|
|
357
|
+
data: scopedValuesDataSchema,
|
|
358
|
+
warnings: z.array(scopeWarningSchema),
|
|
359
|
+
});
|
|
360
|
+
// --- §4 Copy to channels ----------------------------------------------------------------------
|
|
361
|
+
export const copyScopedValueRequestSchema = z
|
|
362
|
+
.object({
|
|
363
|
+
field: fieldPathSchema,
|
|
364
|
+
from: z.object({ channelId: uuidSchema, languageCode: z.string().min(1).max(16) }).strict(),
|
|
365
|
+
toChannelIds: z.array(uuidSchema).min(1).max(SCOPED_COPY_TARGETS_MAX),
|
|
366
|
+
version: scopeVersionTokenSchema,
|
|
367
|
+
dryRun: z.boolean().optional(),
|
|
368
|
+
})
|
|
369
|
+
.strict();
|
|
370
|
+
export const copyScopedValueResponseSchema = z.object({
|
|
371
|
+
data: z.object({
|
|
372
|
+
/** Targets that hold an own value the copy overwrites. */
|
|
373
|
+
overwrites: z.array(z.object({
|
|
374
|
+
channelId: uuidSchema,
|
|
375
|
+
/**
|
|
376
|
+
* The target's own value: the stored value (a text — copy is limited to {G,C,CL} text
|
|
377
|
+
* fields, R21) or the empty-override marker. Typed as the union so a client narrows on
|
|
378
|
+
* `typeof currentValue === 'string'`.
|
|
379
|
+
*/
|
|
380
|
+
currentValue: z.union([z.string(), z.object({ empty: z.literal(true) }).strict()]),
|
|
381
|
+
})),
|
|
382
|
+
/** Cells written; 0 on a dry run. */
|
|
383
|
+
applied: z.number().int().nonnegative(),
|
|
384
|
+
version: z.string(),
|
|
385
|
+
}),
|
|
386
|
+
});
|
|
387
|
+
// --- §5 Editor preference ---------------------------------------------------------------------
|
|
388
|
+
//
|
|
389
|
+
// `PUT` / `GET …/products/:id/editor-preference` keep the body of feature 022
|
|
390
|
+
// (`productEditorPreferenceRequestSchema` in `product-scope-overrides.ts`): `lastChannelId` `null`
|
|
391
|
+
// = Global, a channel without a language = Channel, both = Channel × language; a language without
|
|
392
|
+
// a channel is refused `422 VALIDATION_FAILED` by the route (data-model §10).
|
|
393
|
+
// --- Error details ----------------------------------------------------------------------------
|
|
394
|
+
/** `422 FIELD_NOT_AT_SCOPE` details. */
|
|
395
|
+
export const fieldNotAtScopeDetailsSchema = z.object({
|
|
396
|
+
fields: z.array(z.object({ field: z.string(), levels: z.array(scopeLevelShortSchema) })),
|
|
397
|
+
});
|
|
398
|
+
/** `422 SCOPED_VALUE_INVALID` details. */
|
|
399
|
+
export const scopedValueInvalidDetailsSchema = z.object({
|
|
400
|
+
fields: z.array(z.object({
|
|
401
|
+
field: z.string(),
|
|
402
|
+
scope: scopeRefSchema,
|
|
403
|
+
reason: z.enum([
|
|
404
|
+
'required_empty',
|
|
405
|
+
'not_emptyable',
|
|
406
|
+
'inherit_at_global',
|
|
407
|
+
'source_inherits',
|
|
408
|
+
'subject_not_found',
|
|
409
|
+
'not_supported',
|
|
410
|
+
'invalid',
|
|
411
|
+
]),
|
|
412
|
+
})),
|
|
413
|
+
});
|
|
414
|
+
/** `422 GLOBAL_ONLY_FIELD` details. */
|
|
415
|
+
export const globalOnlyFieldDetailsSchema = z.object({ fields: z.array(z.string()) });
|
|
416
|
+
/**
|
|
417
|
+
* The `details` each scoped-values refusal carries (`contracts/error-codes.md`): the one table a
|
|
418
|
+
* client reads a refusal's shape from.
|
|
419
|
+
*/
|
|
420
|
+
export const scopedValuesErrorDetailsSchemas = {
|
|
421
|
+
[ERROR_CODES.FIELD_NOT_AT_SCOPE]: fieldNotAtScopeDetailsSchema,
|
|
422
|
+
[ERROR_CODES.SCOPED_VALUE_INVALID]: scopedValueInvalidDetailsSchema,
|
|
423
|
+
[ERROR_CODES.GLOBAL_ONLY_FIELD]: globalOnlyFieldDetailsSchema,
|
|
424
|
+
};
|
|
425
|
+
//# sourceMappingURL=product-scoped-values.js.map
|