@endora-commerce/contracts 0.108.0 → 0.110.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/actor.d.ts +16 -0
- package/dist/actor.d.ts.map +1 -1
- package/dist/addresses.d.ts +35 -0
- package/dist/addresses.d.ts.map +1 -1
- package/dist/addresses.js +8 -1
- package/dist/addresses.js.map +1 -1
- package/dist/admin-actions.d.ts +12 -3
- package/dist/admin-actions.d.ts.map +1 -1
- package/dist/admin-actions.js +34 -3
- package/dist/admin-actions.js.map +1 -1
- package/dist/admin-contributions.d.ts +94 -10
- package/dist/admin-contributions.d.ts.map +1 -1
- package/dist/admin-contributions.js +65 -0
- package/dist/admin-contributions.js.map +1 -1
- package/dist/admin-notifications.d.ts +17 -1
- package/dist/admin-notifications.d.ts.map +1 -1
- package/dist/admin-preferences.d.ts +108 -0
- package/dist/admin-preferences.d.ts.map +1 -0
- package/dist/admin-preferences.js +133 -0
- package/dist/admin-preferences.js.map +1 -0
- package/dist/admin-roles.d.ts +8 -2
- package/dist/admin-roles.d.ts.map +1 -1
- package/dist/admin-roles.js.map +1 -1
- package/dist/admin-users.d.ts +9 -0
- package/dist/admin-users.d.ts.map +1 -1
- package/dist/admin.d.ts +92 -5
- package/dist/admin.d.ts.map +1 -1
- package/dist/admin.js +86 -3
- package/dist/admin.js.map +1 -1
- package/dist/assets-library.d.ts +123 -3
- package/dist/assets-library.d.ts.map +1 -1
- package/dist/assets-library.js +11 -3
- package/dist/assets-library.js.map +1 -1
- package/dist/audit-logs.d.ts +12 -0
- package/dist/audit-logs.d.ts.map +1 -1
- package/dist/audit-logs.js +12 -0
- package/dist/audit-logs.js.map +1 -1
- package/dist/blog.d.ts +431 -14
- package/dist/blog.d.ts.map +1 -1
- package/dist/blog.js +251 -7
- package/dist/blog.js.map +1 -1
- package/dist/carts.d.ts +507 -92
- package/dist/carts.d.ts.map +1 -1
- package/dist/carts.js +197 -21
- package/dist/carts.js.map +1 -1
- package/dist/catalog.d.ts +515 -144
- package/dist/catalog.d.ts.map +1 -1
- package/dist/catalog.js +356 -68
- package/dist/catalog.js.map +1 -1
- package/dist/cms-brand.d.ts +2233 -0
- package/dist/cms-brand.d.ts.map +1 -0
- package/dist/cms-brand.js +311 -0
- package/dist/cms-brand.js.map +1 -0
- package/dist/cms-contact-form.d.ts +55 -0
- package/dist/cms-contact-form.d.ts.map +1 -0
- package/dist/cms-contact-form.js +100 -0
- package/dist/cms-contact-form.js.map +1 -0
- package/dist/cms.d.ts +576 -17
- package/dist/cms.d.ts.map +1 -1
- package/dist/cms.js +251 -0
- package/dist/cms.js.map +1 -1
- package/dist/common.d.ts +23 -6
- package/dist/common.d.ts.map +1 -1
- package/dist/common.js +25 -2
- package/dist/common.js.map +1 -1
- package/dist/comparisons.d.ts +28 -21
- package/dist/comparisons.d.ts.map +1 -1
- package/dist/comparisons.js +2 -1
- package/dist/comparisons.js.map +1 -1
- package/dist/credit-limits.d.ts +1 -0
- package/dist/credit-limits.d.ts.map +1 -1
- package/dist/credit-limits.js +14 -0
- package/dist/credit-limits.js.map +1 -1
- package/dist/crm-rich-text.d.ts +10 -61
- package/dist/crm-rich-text.d.ts.map +1 -1
- package/dist/crm-rich-text.js +10 -300
- package/dist/crm-rich-text.js.map +1 -1
- package/dist/crm.d.ts +173 -115
- package/dist/crm.d.ts.map +1 -1
- package/dist/crm.js +35 -88
- package/dist/crm.js.map +1 -1
- package/dist/custom-fields.d.ts +54 -22
- package/dist/custom-fields.d.ts.map +1 -1
- package/dist/custom-fields.js +21 -1
- package/dist/custom-fields.js.map +1 -1
- package/dist/customer-accounts.d.ts +216 -22
- package/dist/customer-accounts.d.ts.map +1 -1
- package/dist/customer-accounts.js +70 -0
- package/dist/customer-accounts.js.map +1 -1
- package/dist/customers.d.ts +40 -73
- package/dist/customers.d.ts.map +1 -1
- package/dist/customers.js +45 -10
- package/dist/customers.js.map +1 -1
- package/dist/document-templates.d.ts +35 -23
- package/dist/document-templates.d.ts.map +1 -1
- package/dist/document-values.d.ts +8 -0
- package/dist/document-values.d.ts.map +1 -1
- package/dist/document-values.js +24 -6
- package/dist/document-values.js.map +1 -1
- package/dist/email.d.ts +5 -0
- package/dist/email.d.ts.map +1 -1
- package/dist/errors.d.ts +224 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +269 -1
- package/dist/errors.js.map +1 -1
- package/dist/forms-logic.d.ts +79 -0
- package/dist/forms-logic.d.ts.map +1 -0
- package/dist/forms-logic.fixtures.d.ts +52 -0
- package/dist/forms-logic.fixtures.d.ts.map +1 -0
- package/dist/forms-logic.fixtures.js +610 -0
- package/dist/forms-logic.fixtures.js.map +1 -0
- package/dist/forms-logic.js +699 -0
- package/dist/forms-logic.js.map +1 -0
- package/dist/forms.d.ts +9833 -0
- package/dist/forms.d.ts.map +1 -0
- package/dist/forms.js +827 -0
- package/dist/forms.js.map +1 -0
- package/dist/import-export.d.ts +180 -0
- package/dist/import-export.d.ts.map +1 -1
- package/dist/import-export.js +60 -0
- package/dist/import-export.js.map +1 -1
- package/dist/index.d.ts +22 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +45 -1
- package/dist/index.js.map +1 -1
- package/dist/inventory.d.ts +6 -6
- package/dist/invoice-ledger.d.ts +7 -7
- package/dist/invoices.d.ts +6 -2
- package/dist/invoices.d.ts.map +1 -1
- package/dist/invoices.js +7 -0
- package/dist/invoices.js.map +1 -1
- package/dist/megamenu.d.ts +674 -0
- package/dist/megamenu.d.ts.map +1 -1
- package/dist/megamenu.js +96 -3
- package/dist/megamenu.js.map +1 -1
- package/dist/mfa.d.ts +125 -4
- package/dist/mfa.d.ts.map +1 -1
- package/dist/mfa.js +54 -2
- package/dist/mfa.js.map +1 -1
- package/dist/modules.d.ts +44 -5
- package/dist/modules.d.ts.map +1 -1
- package/dist/modules.js +73 -0
- package/dist/modules.js.map +1 -1
- package/dist/money-decimal.d.ts +54 -0
- package/dist/money-decimal.d.ts.map +1 -1
- package/dist/money-decimal.js +95 -0
- package/dist/money-decimal.js.map +1 -1
- package/dist/newsletter.d.ts +7 -7
- package/dist/orders.d.ts +128 -10
- package/dist/orders.d.ts.map +1 -1
- package/dist/orders.js +74 -4
- package/dist/orders.js.map +1 -1
- package/dist/organization-registry-lookup.d.ts +362 -0
- package/dist/organization-registry-lookup.d.ts.map +1 -0
- package/dist/organization-registry-lookup.js +196 -0
- package/dist/organization-registry-lookup.js.map +1 -0
- package/dist/organization-roles.d.ts +340 -0
- package/dist/organization-roles.d.ts.map +1 -0
- package/dist/organization-roles.js +211 -0
- package/dist/organization-roles.js.map +1 -0
- package/dist/organizations.d.ts +123 -89
- package/dist/organizations.d.ts.map +1 -1
- package/dist/organizations.js +68 -24
- package/dist/organizations.js.map +1 -1
- package/dist/page-builder-props.d.ts +1401 -0
- package/dist/page-builder-props.d.ts.map +1 -0
- package/dist/page-builder-props.js +266 -0
- package/dist/page-builder-props.js.map +1 -0
- package/dist/page-builder-values.d.ts +95 -0
- package/dist/page-builder-values.d.ts.map +1 -0
- package/dist/page-builder-values.js +164 -0
- package/dist/page-builder-values.js.map +1 -0
- package/dist/pim-connector.d.ts +6 -2
- package/dist/pim-connector.d.ts.map +1 -1
- package/dist/pim-connector.js +6 -2
- package/dist/pim-connector.js.map +1 -1
- package/dist/pim-field-path.d.ts +5 -1
- package/dist/pim-field-path.d.ts.map +1 -1
- package/dist/pim-field-path.js +37 -81
- package/dist/pim-field-path.js.map +1 -1
- package/dist/pim-locale-mapping.d.ts +131 -0
- package/dist/pim-locale-mapping.d.ts.map +1 -0
- package/dist/pim-locale-mapping.js +193 -0
- package/dist/pim-locale-mapping.js.map +1 -0
- package/dist/platform-language.d.ts +9 -0
- package/dist/platform-language.d.ts.map +1 -1
- package/dist/platform-language.js +14 -0
- package/dist/platform-language.js.map +1 -1
- package/dist/price-books.d.ts +47 -43
- package/dist/price-books.d.ts.map +1 -1
- package/dist/price-books.js +6 -2
- package/dist/price-books.js.map +1 -1
- package/dist/price-lists.d.ts +48 -14
- package/dist/price-lists.d.ts.map +1 -1
- package/dist/price-lists.js +24 -1
- package/dist/price-lists.js.map +1 -1
- package/dist/product-feeds.d.ts +144 -84
- package/dist/product-feeds.d.ts.map +1 -1
- package/dist/product-feeds.js +23 -0
- package/dist/product-feeds.js.map +1 -1
- package/dist/product-scope-model.d.ts +161 -0
- package/dist/product-scope-model.d.ts.map +1 -0
- package/dist/product-scope-model.js +161 -0
- package/dist/product-scope-model.js.map +1 -0
- package/dist/product-scope-overrides.d.ts +0 -103
- package/dist/product-scope-overrides.d.ts.map +1 -1
- package/dist/product-scope-overrides.js +0 -54
- package/dist/product-scope-overrides.js.map +1 -1
- package/dist/product-scoped-values.d.ts +2610 -0
- package/dist/product-scoped-values.d.ts.map +1 -0
- package/dist/product-scoped-values.js +425 -0
- package/dist/product-scoped-values.js.map +1 -0
- package/dist/product-scopes.d.ts +746 -0
- package/dist/product-scopes.d.ts.map +1 -0
- package/dist/product-scopes.js +436 -0
- package/dist/product-scopes.js.map +1 -0
- package/dist/product-summary-text.d.ts +23 -0
- package/dist/product-summary-text.d.ts.map +1 -0
- package/dist/product-summary-text.js +64 -0
- package/dist/product-summary-text.js.map +1 -0
- package/dist/product-tax-rates.d.ts +38 -0
- package/dist/product-tax-rates.d.ts.map +1 -0
- package/dist/product-tax-rates.js +45 -0
- package/dist/product-tax-rates.js.map +1 -0
- package/dist/product-url-keys.d.ts +210 -0
- package/dist/product-url-keys.d.ts.map +1 -0
- package/dist/product-url-keys.js +200 -0
- package/dist/product-url-keys.js.map +1 -0
- package/dist/product-value-resolver.d.ts +37 -60
- package/dist/product-value-resolver.d.ts.map +1 -1
- package/dist/product-value-resolver.js +36 -96
- package/dist/product-value-resolver.js.map +1 -1
- package/dist/projects.d.ts +2370 -0
- package/dist/projects.d.ts.map +1 -0
- package/dist/projects.js +843 -0
- package/dist/projects.js.map +1 -0
- package/dist/promotions.d.ts +10 -10
- package/dist/prompt-actions.d.ts +19 -1
- package/dist/prompt-actions.d.ts.map +1 -1
- package/dist/prompt-actions.js +31 -2
- package/dist/prompt-actions.js.map +1 -1
- package/dist/pwa.d.ts +2 -2
- package/dist/quick-order.d.ts +150 -7
- package/dist/quick-order.d.ts.map +1 -1
- package/dist/quick-order.js +76 -2
- package/dist/quick-order.js.map +1 -1
- package/dist/quote-requests.d.ts +99 -13
- package/dist/quote-requests.d.ts.map +1 -1
- package/dist/quote-requests.js +66 -1
- package/dist/quote-requests.js.map +1 -1
- package/dist/record-references.d.ts +252 -0
- package/dist/record-references.d.ts.map +1 -0
- package/dist/record-references.js +178 -0
- package/dist/record-references.js.map +1 -0
- package/dist/record-rich-text.d.ts +66 -0
- package/dist/record-rich-text.d.ts.map +1 -0
- package/dist/record-rich-text.js +304 -0
- package/dist/record-rich-text.js.map +1 -0
- package/dist/returns.d.ts +234 -52
- package/dist/returns.d.ts.map +1 -1
- package/dist/returns.js +139 -26
- package/dist/returns.js.map +1 -1
- package/dist/sales-channels.d.ts +51 -7
- package/dist/sales-channels.d.ts.map +1 -1
- package/dist/sales-channels.js +38 -4
- package/dist/sales-channels.js.map +1 -1
- package/dist/saved-list-views.d.ts +56 -0
- package/dist/saved-list-views.d.ts.map +1 -1
- package/dist/saved-list-views.js +27 -1
- package/dist/saved-list-views.js.map +1 -1
- package/dist/scoped-write-encoding.d.ts +100 -0
- package/dist/scoped-write-encoding.d.ts.map +1 -0
- package/dist/scoped-write-encoding.js +135 -0
- package/dist/scoped-write-encoding.js.map +1 -0
- package/dist/search.d.ts +25 -15
- package/dist/search.d.ts.map +1 -1
- package/dist/seo.d.ts +127 -15
- package/dist/seo.d.ts.map +1 -1
- package/dist/seo.js +38 -4
- package/dist/seo.js.map +1 -1
- package/dist/settings.d.ts +161 -3
- package/dist/settings.d.ts.map +1 -1
- package/dist/settings.js +73 -3
- package/dist/settings.js.map +1 -1
- package/dist/shopping-lists.d.ts +24 -3
- package/dist/shopping-lists.d.ts.map +1 -1
- package/dist/shopping-lists.js +20 -0
- package/dist/shopping-lists.js.map +1 -1
- package/dist/storefront-cache-tags.d.ts +41 -0
- package/dist/storefront-cache-tags.d.ts.map +1 -1
- package/dist/storefront-cache-tags.js +36 -0
- package/dist/storefront-cache-tags.js.map +1 -1
- package/dist/storefront-language-path.d.ts +77 -0
- package/dist/storefront-language-path.d.ts.map +1 -0
- package/dist/storefront-language-path.js +123 -0
- package/dist/storefront-language-path.js.map +1 -0
- package/dist/storefront-value-overrides.d.ts +18 -56
- package/dist/storefront-value-overrides.d.ts.map +1 -1
- package/dist/storefront-value-overrides.js +11 -86
- package/dist/storefront-value-overrides.js.map +1 -1
- package/dist/tasks.d.ts +2842 -0
- package/dist/tasks.d.ts.map +1 -0
- package/dist/tasks.js +901 -0
- package/dist/tasks.js.map +1 -0
- package/dist/transactional-emails.d.ts +14 -11
- package/dist/transactional-emails.d.ts.map +1 -1
- package/dist/transactional-emails.js +13 -0
- package/dist/transactional-emails.js.map +1 -1
- package/package.json +3 -3
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Feature 174 (`specs/174-product-editor-scope-switcher/contracts/write-encoding.md`; research R3;
|
|
3
|
+
* FR-110…FR-118) — the **one** write encoding of scoped product values, for JSON (the admin API,
|
|
4
|
+
* the connector port) and CSV (import and export).
|
|
5
|
+
*
|
|
6
|
+
* | Intent | JSON | CSV |
|
|
7
|
+
* | --- | --- | --- |
|
|
8
|
+
* | No change | absent, or `""` | empty cell |
|
|
9
|
+
* | Empty override (at Global: no value) | `null` | `NULL` |
|
|
10
|
+
* | Remove the own value, inherit | `{ "inherit": true }` | `INHERIT` |
|
|
11
|
+
* | A value | the value | the text (`\` escapes a token) |
|
|
12
|
+
*
|
|
13
|
+
* This differs from JSON Merge Patch (`null` = remove the member) and from Magento's
|
|
14
|
+
* `__EMPTY__VALUE__` (FR-115). Applies to scoped product values only (FR-117). Adding a token
|
|
15
|
+
* later is additive; changing a meaning is a breaking, versioned change (FR-111).
|
|
16
|
+
*/
|
|
17
|
+
import { z } from 'zod';
|
|
18
|
+
export const INHERIT_TOKEN = 'INHERIT';
|
|
19
|
+
export const EMPTY_TOKEN = 'NULL';
|
|
20
|
+
/** The JSON marker that removes the own value. Strict: `{ inherit: true }` and nothing else. */
|
|
21
|
+
export const inheritMarkerSchema = z.object({ inherit: z.literal(true) }).strict();
|
|
22
|
+
/**
|
|
23
|
+
* The Zod schema of one scoped write: `null | { inherit: true } | valueSchema`, optional, with
|
|
24
|
+
* `""` read as absent (no change). `null` and the marker are tried before the value schema, so a
|
|
25
|
+
* permissive value schema never swallows them.
|
|
26
|
+
*/
|
|
27
|
+
export function scopedWrite(valueSchema) {
|
|
28
|
+
return z.preprocess((raw) => (raw === '' ? undefined : raw), z
|
|
29
|
+
.union([z.null(), inheritMarkerSchema, valueSchema])
|
|
30
|
+
.optional()
|
|
31
|
+
// C1 review — an object naming `inherit` that is not exactly `{ inherit: true }` is a
|
|
32
|
+
// malformed marker, refused even when a permissive value schema would accept it as a value.
|
|
33
|
+
.refine((value) => !looksLikeMalformedMarker(value), { message: 'Malformed inherit marker.' }));
|
|
34
|
+
}
|
|
35
|
+
function looksLikeMalformedMarker(raw) {
|
|
36
|
+
return (typeof raw === 'object' &&
|
|
37
|
+
raw !== null &&
|
|
38
|
+
!Array.isArray(raw) &&
|
|
39
|
+
Object.prototype.hasOwnProperty.call(raw, 'inherit') &&
|
|
40
|
+
!isInheritMarker(raw));
|
|
41
|
+
}
|
|
42
|
+
function isInheritMarker(raw) {
|
|
43
|
+
return (typeof raw === 'object' &&
|
|
44
|
+
raw !== null &&
|
|
45
|
+
!Array.isArray(raw) &&
|
|
46
|
+
Object.keys(raw).length === 1 &&
|
|
47
|
+
raw.inherit === true);
|
|
48
|
+
}
|
|
49
|
+
/** The op a parsed {@link scopedWrite} value means; `undefined` = no change. */
|
|
50
|
+
export function toScopedWriteOp(raw) {
|
|
51
|
+
if (raw === undefined)
|
|
52
|
+
return undefined;
|
|
53
|
+
if (raw === null)
|
|
54
|
+
return { op: 'empty' };
|
|
55
|
+
if (isInheritMarker(raw))
|
|
56
|
+
return { op: 'inherit' };
|
|
57
|
+
return { op: 'set', value: raw };
|
|
58
|
+
}
|
|
59
|
+
/** The wire form of an op — the inverse of {@link toScopedWriteOp}. */
|
|
60
|
+
export function fromScopedWriteOp(op) {
|
|
61
|
+
if (op.op === 'empty')
|
|
62
|
+
return null;
|
|
63
|
+
if (op.op === 'inherit')
|
|
64
|
+
return { inherit: true };
|
|
65
|
+
return op.value;
|
|
66
|
+
}
|
|
67
|
+
const TOKEN_ESCAPED = /^\\+(NULL|INHERIT)$/;
|
|
68
|
+
const TOKEN_TO_ESCAPE = /^\\*(NULL|INHERIT)$/;
|
|
69
|
+
const FORMULA_LEAD = /^[=+\-@\t\r]/;
|
|
70
|
+
/**
|
|
71
|
+
* Decode one CSV cell (§3, §3a). Tokens are matched on the raw, whole cell; then, in a text
|
|
72
|
+
* column, one leading `'` is dropped; then a cell of backslashes before a token loses one
|
|
73
|
+
* backslash. Anything else is text, verbatim.
|
|
74
|
+
*/
|
|
75
|
+
export function decodeCsvScopedCell(cell, options = { column: 'text' }) {
|
|
76
|
+
if (cell === '')
|
|
77
|
+
return { kind: 'no_change' };
|
|
78
|
+
if (cell === EMPTY_TOKEN)
|
|
79
|
+
return { kind: 'empty' };
|
|
80
|
+
if (cell === INHERIT_TOKEN)
|
|
81
|
+
return { kind: 'inherit' };
|
|
82
|
+
let text = cell;
|
|
83
|
+
if (options.column === 'text' && text.startsWith("'"))
|
|
84
|
+
text = text.slice(1);
|
|
85
|
+
if (TOKEN_ESCAPED.test(text))
|
|
86
|
+
text = text.slice(1);
|
|
87
|
+
return { kind: 'text', text };
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Encode one CSV cell — the inverse of {@link decodeCsvScopedCell}: `decode(encode(x)) = x` for
|
|
91
|
+
* every non-empty text. An empty text has no CSV form (an empty cell means no change); write the
|
|
92
|
+
* empty override as `{ kind: 'empty' }` instead.
|
|
93
|
+
*/
|
|
94
|
+
export function encodeCsvScopedCell(cell, options = { column: 'text' }) {
|
|
95
|
+
if (cell.kind === 'empty')
|
|
96
|
+
return EMPTY_TOKEN;
|
|
97
|
+
if (cell.kind === 'inherit')
|
|
98
|
+
return INHERIT_TOKEN;
|
|
99
|
+
const { text } = cell;
|
|
100
|
+
if (text === '')
|
|
101
|
+
throw new Error('An empty text has no CSV form: an empty cell means "no change".');
|
|
102
|
+
if (options.column === 'text' && (text.startsWith("'") || FORMULA_LEAD.test(text)))
|
|
103
|
+
return `'${text}`;
|
|
104
|
+
if (TOKEN_TO_ESCAPE.test(text))
|
|
105
|
+
return `\\${text}`;
|
|
106
|
+
return text;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* The one place an op is refused for what it means (FR-062, FR-113): `inherit` at Global for
|
|
110
|
+
* every field; `empty` on a required field (name, URL key, required attribute), then on a field
|
|
111
|
+
* that takes no empty override (single selects, booleans). Value shapes and lengths are the
|
|
112
|
+
* value schema's; the scope set is the caller's `FIELD_NOT_AT_SCOPE` check.
|
|
113
|
+
*/
|
|
114
|
+
export function validateScopedWrite(field, op, level) {
|
|
115
|
+
if (op.op === 'inherit')
|
|
116
|
+
return level === 'G' ? 'inherit_at_global' : null;
|
|
117
|
+
if (op.op === 'empty') {
|
|
118
|
+
if (field.required)
|
|
119
|
+
return 'required_empty';
|
|
120
|
+
if (!field.emptyable)
|
|
121
|
+
return 'not_emptyable';
|
|
122
|
+
}
|
|
123
|
+
return null;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* `products.scope_version` as the client echoes it: digits within the bigint range, so an
|
|
127
|
+
* over-long token is a 400 and never a database overflow (C2/C3 security review). It lives in this leaf
|
|
128
|
+
* file so `catalog.ts` (the product `PATCH`) and `product-scoped-values.ts` both import it
|
|
129
|
+
* without an import cycle.
|
|
130
|
+
*/
|
|
131
|
+
export const scopeVersionTokenSchema = z
|
|
132
|
+
.string()
|
|
133
|
+
.regex(/^\d{1,19}$/)
|
|
134
|
+
.refine((value) => BigInt(value) <= 9223372036854775807n, 'out of range');
|
|
135
|
+
//# sourceMappingURL=scoped-write-encoding.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scoped-write-encoding.js","sourceRoot":"","sources":["../src/scoped-write-encoding.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC;AAKlC,gGAAgG;AAChG,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAMnF;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAsB,WAAc;IAC7D,OAAO,CAAC,CAAC,UAAU,CACjB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EACvC,CAAC;SACE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,mBAAmB,EAAE,WAAW,CAAC,CAAC;SACnD,QAAQ,EAAE;QACX,sFAAsF;QACtF,4FAA4F;SAC3F,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC,CACjG,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,GAAY;IAC5C,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACnB,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC;QACpD,CAAC,eAAe,CAAC,GAAG,CAAC,CACtB,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,GAAY;IACnC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACnB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC;QAC5B,GAA6B,CAAC,OAAO,KAAK,IAAI,CAChD,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,eAAe,CAAI,GAAyC;IAC1E,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;IACzC,IAAI,eAAe,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC;IACnD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAQ,EAAE,CAAC;AACxC,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,iBAAiB,CAAI,EAAoB;IACvD,IAAI,EAAE,CAAC,EAAE,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC;IACnC,IAAI,EAAE,CAAC,EAAE,KAAK,SAAS;QAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAClD,OAAO,EAAE,CAAC,KAAK,CAAC;AAClB,CAAC;AAcD,MAAM,aAAa,GAAG,qBAAqB,CAAC;AAC5C,MAAM,eAAe,GAAG,qBAAqB,CAAC;AAC9C,MAAM,YAAY,GAAG,cAAc,CAAC;AAEpC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY,EAAE,UAA4B,EAAE,MAAM,EAAE,MAAM,EAAE;IAC9F,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC9C,IAAI,IAAI,KAAK,WAAW;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACnD,IAAI,IAAI,KAAK,aAAa;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACvD,IAAI,IAAI,GAAG,IAAI,CAAC;IAChB,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5E,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAChC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAA8E,EAC9E,UAA4B,EAAE,MAAM,EAAE,MAAM,EAAE;IAE9C,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,WAAW,CAAC;IAC9C,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,aAAa,CAAC;IAClD,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACtB,IAAI,IAAI,KAAK,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;IACpG,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,IAAI,EAAE,CAAC;IACtG,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,IAAI,EAAE,CAAC;IACnD,OAAO,IAAI,CAAC;AACd,CAAC;AAMD;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAqD,EACrD,EAA0B,EAC1B,KAAiB;IAEjB,IAAI,EAAE,CAAC,EAAE,KAAK,SAAS;QAAE,OAAO,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,IAAI,EAAE,CAAC,EAAE,KAAK,OAAO,EAAE,CAAC;QACtB,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,gBAAgB,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,SAAS;YAAE,OAAO,eAAe,CAAC;IAC/C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,EAAE;KACR,KAAK,CAAC,YAAY,CAAC;KACnB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,oBAAoB,EAAE,cAAc,CAAC,CAAC"}
|
package/dist/search.d.ts
CHANGED
|
@@ -58,6 +58,7 @@ export declare const searchSuggestItemSchema: z.ZodObject<{
|
|
|
58
58
|
}>;
|
|
59
59
|
name: z.ZodString;
|
|
60
60
|
slug: z.ZodString;
|
|
61
|
+
summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
61
62
|
categorySlugs: z.ZodArray<z.ZodString>;
|
|
62
63
|
primaryAssetUrl: z.ZodNullable<z.ZodString>;
|
|
63
64
|
price: z.ZodNullable<z.ZodObject<{
|
|
@@ -70,19 +71,19 @@ export declare const searchSuggestItemSchema: z.ZodObject<{
|
|
|
70
71
|
}, z.core.$strip>>>;
|
|
71
72
|
priceVariesByVariant: z.ZodOptional<z.ZodBoolean>;
|
|
72
73
|
stockIndicator: z.ZodNullable<z.ZodEnum<{
|
|
73
|
-
available: "available";
|
|
74
74
|
out_of_stock: "out_of_stock";
|
|
75
|
+
available: "available";
|
|
75
76
|
to_order: "to_order";
|
|
76
77
|
}>>;
|
|
77
78
|
stockLevel: z.ZodNullable<z.ZodNumber>;
|
|
78
79
|
priceUnavailable: z.ZodOptional<z.ZodBoolean>;
|
|
79
80
|
availability: z.ZodOptional<z.ZodObject<{
|
|
80
81
|
band: z.ZodEnum<{
|
|
81
|
-
available: "available";
|
|
82
|
-
out_of_stock: "out_of_stock";
|
|
83
82
|
high: "high";
|
|
84
83
|
medium: "medium";
|
|
85
84
|
low: "low";
|
|
85
|
+
out_of_stock: "out_of_stock";
|
|
86
|
+
available: "available";
|
|
86
87
|
}>;
|
|
87
88
|
inStock: z.ZodBoolean;
|
|
88
89
|
}, z.core.$strip>>;
|
|
@@ -97,16 +98,17 @@ export declare const searchSuggestItemSchema: z.ZodObject<{
|
|
|
97
98
|
currency: z.ZodString;
|
|
98
99
|
}, z.core.$strip>>;
|
|
99
100
|
displayMode: z.ZodEnum<{
|
|
100
|
-
both: "both";
|
|
101
|
-
none: "none";
|
|
102
101
|
gross_only: "gross_only";
|
|
103
102
|
net_only: "net_only";
|
|
103
|
+
both: "both";
|
|
104
|
+
none: "none";
|
|
104
105
|
}>;
|
|
105
106
|
listPrice: z.ZodOptional<z.ZodObject<{
|
|
106
107
|
amount: z.ZodString;
|
|
107
108
|
currency: z.ZodString;
|
|
108
109
|
}, z.core.$strip>>;
|
|
109
110
|
}, z.core.$strip>>>;
|
|
111
|
+
vatRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
110
112
|
basePrice: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
111
113
|
amount: z.ZodString;
|
|
112
114
|
currency: z.ZodString;
|
|
@@ -116,10 +118,10 @@ export declare const searchSuggestItemSchema: z.ZodObject<{
|
|
|
116
118
|
currency: z.ZodString;
|
|
117
119
|
}, z.core.$strip>>>;
|
|
118
120
|
priceDisplayMode: z.ZodOptional<z.ZodEnum<{
|
|
119
|
-
both: "both";
|
|
120
|
-
none: "none";
|
|
121
121
|
gross_only: "gross_only";
|
|
122
122
|
net_only: "net_only";
|
|
123
|
+
both: "both";
|
|
124
|
+
none: "none";
|
|
123
125
|
}>>;
|
|
124
126
|
listPrice: z.ZodOptional<z.ZodObject<{
|
|
125
127
|
amount: z.ZodString;
|
|
@@ -140,6 +142,7 @@ export declare const SearchSuggestResponseSchema: z.ZodObject<{
|
|
|
140
142
|
}>;
|
|
141
143
|
name: z.ZodString;
|
|
142
144
|
slug: z.ZodString;
|
|
145
|
+
summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
143
146
|
categorySlugs: z.ZodArray<z.ZodString>;
|
|
144
147
|
primaryAssetUrl: z.ZodNullable<z.ZodString>;
|
|
145
148
|
price: z.ZodNullable<z.ZodObject<{
|
|
@@ -152,19 +155,19 @@ export declare const SearchSuggestResponseSchema: z.ZodObject<{
|
|
|
152
155
|
}, z.core.$strip>>>;
|
|
153
156
|
priceVariesByVariant: z.ZodOptional<z.ZodBoolean>;
|
|
154
157
|
stockIndicator: z.ZodNullable<z.ZodEnum<{
|
|
155
|
-
available: "available";
|
|
156
158
|
out_of_stock: "out_of_stock";
|
|
159
|
+
available: "available";
|
|
157
160
|
to_order: "to_order";
|
|
158
161
|
}>>;
|
|
159
162
|
stockLevel: z.ZodNullable<z.ZodNumber>;
|
|
160
163
|
priceUnavailable: z.ZodOptional<z.ZodBoolean>;
|
|
161
164
|
availability: z.ZodOptional<z.ZodObject<{
|
|
162
165
|
band: z.ZodEnum<{
|
|
163
|
-
available: "available";
|
|
164
|
-
out_of_stock: "out_of_stock";
|
|
165
166
|
high: "high";
|
|
166
167
|
medium: "medium";
|
|
167
168
|
low: "low";
|
|
169
|
+
out_of_stock: "out_of_stock";
|
|
170
|
+
available: "available";
|
|
168
171
|
}>;
|
|
169
172
|
inStock: z.ZodBoolean;
|
|
170
173
|
}, z.core.$strip>>;
|
|
@@ -179,16 +182,17 @@ export declare const SearchSuggestResponseSchema: z.ZodObject<{
|
|
|
179
182
|
currency: z.ZodString;
|
|
180
183
|
}, z.core.$strip>>;
|
|
181
184
|
displayMode: z.ZodEnum<{
|
|
182
|
-
both: "both";
|
|
183
|
-
none: "none";
|
|
184
185
|
gross_only: "gross_only";
|
|
185
186
|
net_only: "net_only";
|
|
187
|
+
both: "both";
|
|
188
|
+
none: "none";
|
|
186
189
|
}>;
|
|
187
190
|
listPrice: z.ZodOptional<z.ZodObject<{
|
|
188
191
|
amount: z.ZodString;
|
|
189
192
|
currency: z.ZodString;
|
|
190
193
|
}, z.core.$strip>>;
|
|
191
194
|
}, z.core.$strip>>>;
|
|
195
|
+
vatRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
192
196
|
basePrice: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
193
197
|
amount: z.ZodString;
|
|
194
198
|
currency: z.ZodString;
|
|
@@ -198,10 +202,10 @@ export declare const SearchSuggestResponseSchema: z.ZodObject<{
|
|
|
198
202
|
currency: z.ZodString;
|
|
199
203
|
}, z.core.$strip>>>;
|
|
200
204
|
priceDisplayMode: z.ZodOptional<z.ZodEnum<{
|
|
201
|
-
both: "both";
|
|
202
|
-
none: "none";
|
|
203
205
|
gross_only: "gross_only";
|
|
204
206
|
net_only: "net_only";
|
|
207
|
+
both: "both";
|
|
208
|
+
none: "none";
|
|
205
209
|
}>>;
|
|
206
210
|
listPrice: z.ZodOptional<z.ZodObject<{
|
|
207
211
|
amount: z.ZodString;
|
|
@@ -268,9 +272,15 @@ export type SearchReindexResponse = z.infer<typeof SearchReindexResponseSchema>;
|
|
|
268
272
|
export interface ResolvedSearchChannel {
|
|
269
273
|
id: string;
|
|
270
274
|
code: string;
|
|
271
|
-
isPublic: boolean;
|
|
272
275
|
defaultCurrency: string;
|
|
273
276
|
defaultLanguage: string;
|
|
277
|
+
/**
|
|
278
|
+
* Feature 163 — the channel's content languages, from the resolved channel
|
|
279
|
+
* record. The scope language a query filters on is the request's
|
|
280
|
+
* `Accept-Language` pick resolved against them. Absent: the default
|
|
281
|
+
* language alone.
|
|
282
|
+
*/
|
|
283
|
+
languages?: readonly string[] | undefined;
|
|
274
284
|
}
|
|
275
285
|
export interface SearchQueryContext {
|
|
276
286
|
resolvedChannel: ResolvedSearchChannel;
|
package/dist/search.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,MAAM,cAAc,CAAC;AAOtB;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,wBAAwB;;;iBAWnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,uBAAuB;;;;iBASlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uBAAuB
|
|
1
|
+
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,MAAM,cAAc,CAAC;AAOtB;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,wBAAwB;;;iBAWnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,uBAAuB;;;;iBASlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAalC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAMhF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB;;;;iBAcjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,uBAAuB;;;;;iBAWlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAMxE;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;iBAOpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,0BAA0B;;iBAErC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAM9E;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAWhF,wEAAwE;AACxE,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CAC3C;AAED,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,qBAAqB,CAAC;IACvC;;;;;;OAMG;IACH,QAAQ,EAAE,eAAe,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC;CACzD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CACxE;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,iBAAiB,GACzB;IAAE,MAAM,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE;AAC5C,+EAA+E;GAC7E;IAAE,MAAM,EAAE,mBAAmB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,eAAe;IAC9B,YAAY,CACV,MAAM,EAAE,wBAAwB,EAChC,GAAG,EAAE,kBAAkB,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,IAAI,OAAO,CAAC;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClD"}
|
package/dist/seo.d.ts
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
+
import type { ScopeRef, ScopedSource, SeoProductMetaField } from './product-scope-model.js';
|
|
3
|
+
import type { ScopedFieldView } from './product-scoped-values.js';
|
|
4
|
+
import type { ScopedWriteOp } from './scoped-write-encoding.js';
|
|
2
5
|
/**
|
|
3
6
|
* SEO meta + sitemap contracts (T235 / FR-101, FR-102).
|
|
4
7
|
*
|
|
@@ -6,9 +9,9 @@ import { z } from 'zod';
|
|
|
6
9
|
* renders public pages for can carry meta overrides.
|
|
7
10
|
*/
|
|
8
11
|
export declare const seoEntityTypeSchema: z.ZodEnum<{
|
|
12
|
+
product: "product";
|
|
9
13
|
category: "category";
|
|
10
14
|
cms_page: "cms_page";
|
|
11
|
-
product: "product";
|
|
12
15
|
}>;
|
|
13
16
|
export type SeoEntityType = z.infer<typeof seoEntityTypeSchema>;
|
|
14
17
|
export declare const resolvedMetaSchema: z.ZodObject<{
|
|
@@ -29,12 +32,13 @@ export type ResolvedMeta = z.infer<typeof resolvedMetaSchema>;
|
|
|
29
32
|
export declare const seoMetaOverrideSchema: z.ZodObject<{
|
|
30
33
|
id: z.ZodString;
|
|
31
34
|
entityType: z.ZodEnum<{
|
|
35
|
+
product: "product";
|
|
32
36
|
category: "category";
|
|
33
37
|
cms_page: "cms_page";
|
|
34
|
-
product: "product";
|
|
35
38
|
}>;
|
|
36
39
|
entityId: z.ZodString;
|
|
37
|
-
locale: z.ZodString
|
|
40
|
+
locale: z.ZodNullable<z.ZodString>;
|
|
41
|
+
channelId: z.ZodNullable<z.ZodString>;
|
|
38
42
|
title: z.ZodNullable<z.ZodString>;
|
|
39
43
|
description: z.ZodNullable<z.ZodString>;
|
|
40
44
|
ogTitle: z.ZodNullable<z.ZodString>;
|
|
@@ -43,8 +47,27 @@ export declare const seoMetaOverrideSchema: z.ZodObject<{
|
|
|
43
47
|
createdAt: z.ZodString;
|
|
44
48
|
updatedAt: z.ZodString;
|
|
45
49
|
}, z.core.$strip>;
|
|
50
|
+
/**
|
|
51
|
+
* Where an override sits (feature 163, `contracts/seo-media-attachments.md` §1):
|
|
52
|
+
* `locale` only = the language row, `channelId` only = the sales channel row,
|
|
53
|
+
* both = the channel × language row. Naming **neither** keeps the meaning every
|
|
54
|
+
* caller before feature 163 relied on — the `en-US` language row. Only a
|
|
55
|
+
* `product` takes a `channelId`.
|
|
56
|
+
*/
|
|
57
|
+
export declare const seoMetaScopeQuerySchema: z.ZodObject<{
|
|
58
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
59
|
+
channelId: z.ZodOptional<z.ZodString>;
|
|
60
|
+
}, z.core.$strip>;
|
|
61
|
+
export type SeoMetaScopeQuery = z.infer<typeof seoMetaScopeQuerySchema>;
|
|
62
|
+
/**
|
|
63
|
+
* Feature 163 (checkpoint E security review, I5) — an Open Graph image URL: an
|
|
64
|
+
* absolute `http(s)` URL or a site-relative path (`/…`, never `//…` or `/\…`). It is
|
|
65
|
+
* written into every page's `og:image`, so no other scheme is accepted.
|
|
66
|
+
*/
|
|
67
|
+
export declare const ogImageUrlSchema: z.ZodString;
|
|
46
68
|
export declare const upsertSeoMetaOverrideRequestSchema: z.ZodObject<{
|
|
47
|
-
locale: z.ZodString
|
|
69
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
70
|
+
channelId: z.ZodOptional<z.ZodString>;
|
|
48
71
|
title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
49
72
|
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
50
73
|
ogTitle: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -363,8 +386,8 @@ export declare const adminCrawlerFilePreviewSchema: z.ZodObject<{
|
|
|
363
386
|
savedExtra: z.ZodString;
|
|
364
387
|
savedExtraSource: z.ZodEnum<{
|
|
365
388
|
default: "default";
|
|
366
|
-
channel: "channel";
|
|
367
389
|
global: "global";
|
|
390
|
+
channel: "channel";
|
|
368
391
|
}>;
|
|
369
392
|
channelsWithOwnValue: z.ZodArray<z.ZodString>;
|
|
370
393
|
policy: z.ZodObject<{
|
|
@@ -399,8 +422,8 @@ export declare const adminCrawlerFilePreviewResponseSchema: z.ZodObject<{
|
|
|
399
422
|
savedExtra: z.ZodString;
|
|
400
423
|
savedExtraSource: z.ZodEnum<{
|
|
401
424
|
default: "default";
|
|
402
|
-
channel: "channel";
|
|
403
425
|
global: "global";
|
|
426
|
+
channel: "channel";
|
|
404
427
|
}>;
|
|
405
428
|
channelsWithOwnValue: z.ZodArray<z.ZodString>;
|
|
406
429
|
policy: z.ZodObject<{
|
|
@@ -419,19 +442,108 @@ export declare const adminCrawlerFilePreviewResponseSchema: z.ZodObject<{
|
|
|
419
442
|
}, z.core.$strip>;
|
|
420
443
|
export type AdminCrawlerFilePreviewResponse = z.infer<typeof adminCrawlerFilePreviewResponseSchema>;
|
|
421
444
|
/**
|
|
422
|
-
*
|
|
445
|
+
* Feature 174 (`specs/174-product-editor-scope-switcher/contracts/seo-ports.md`; research R9,
|
|
446
|
+
* R21) — product metadata at the three product scopes: Global (no channel, no locale),
|
|
447
|
+
* Channel (channel, no locale) and Channel × language. There is no locale-only product row any
|
|
448
|
+
* more (FR-010). `SeoProductMetaField` is declared once, in `product-scope-model.ts`.
|
|
449
|
+
*/
|
|
450
|
+
/** Where an effective metadata value came from; `derived` = the product page's own fallback. */
|
|
451
|
+
export type SeoProductMetaSource = ScopedSource | 'derived';
|
|
452
|
+
export interface SeoProductMetaValues {
|
|
453
|
+
title: string;
|
|
454
|
+
description: string;
|
|
455
|
+
ogTitle: string;
|
|
456
|
+
ogDescription: string;
|
|
457
|
+
ogImageUrl: string | null;
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* `GET /api/v1/admin/seo/meta/product/:entityId` query — `catalog:read` (FR-093). The scope
|
|
461
|
+
* request every scoped read takes (`scopeRequestSchema`, resolved with `scopeFromRequest`): no
|
|
462
|
+
* locale-only scope.
|
|
463
|
+
*/
|
|
464
|
+
export declare const seoProductMetaQuerySchema: z.ZodObject<{
|
|
465
|
+
channelId: z.ZodOptional<z.ZodString>;
|
|
466
|
+
languageCode: z.ZodOptional<z.ZodString>;
|
|
467
|
+
}, z.core.$strict>;
|
|
468
|
+
export type SeoProductMetaQuery = z.infer<typeof seoProductMetaQuerySchema>;
|
|
469
|
+
/**
|
|
470
|
+
* Container name: `seoProductMetaPort`. Owner: `seo` (feature 163 R13, rewritten by 174).
|
|
471
|
+
*
|
|
472
|
+
* `catalog` declares the edge as degrades-without and probes `seo`'s presence before resolving
|
|
473
|
+
* it; with `seo` off the product editor shows no SEO section (FR-092).
|
|
474
|
+
*
|
|
475
|
+
* **Owner off:** resolving this port throws `ModuleDisabledError` (503).
|
|
476
|
+
*/
|
|
477
|
+
export interface SeoProductMetaPort {
|
|
478
|
+
/**
|
|
479
|
+
* Storefront: effective values at (C, L) along C×L → C → G, then the caller's derived
|
|
480
|
+
* fallback. A field whose effective source is an empty override (`set_empty`) also takes the
|
|
481
|
+
* derived value (owner round 6).
|
|
482
|
+
*/
|
|
483
|
+
resolveForProduct(input: {
|
|
484
|
+
productId: string;
|
|
485
|
+
channelId: string;
|
|
486
|
+
languageCode: string;
|
|
487
|
+
fallback: SeoProductMetaValues;
|
|
488
|
+
}): Promise<SeoProductMetaValues & {
|
|
489
|
+
sources: Record<SeoProductMetaField, SeoProductMetaSource>;
|
|
490
|
+
}>;
|
|
491
|
+
/** Admin: each field's view at one scope; an invalid scope → `422 SCOPE_INVALID`, never an empty view. */
|
|
492
|
+
readScoped(productId: string, scope: ScopeRef): Promise<Record<SeoProductMetaField, ScopedFieldView<string>>>;
|
|
493
|
+
/** Overview: every scope holding a product row. */
|
|
494
|
+
listScopesForProduct(productId: string): Promise<Array<{
|
|
495
|
+
channelId: string | null;
|
|
496
|
+
languageCode: string | null;
|
|
497
|
+
fields: SeoProductMetaField[];
|
|
498
|
+
}>>;
|
|
499
|
+
}
|
|
500
|
+
/** A field's own value at a scope for an audit before-state: a text, an empty override, or none. */
|
|
501
|
+
export type SeoProductMetaOwnValue = {
|
|
502
|
+
own: string | {
|
|
503
|
+
empty: true;
|
|
504
|
+
};
|
|
505
|
+
} | {
|
|
506
|
+
inherited: true;
|
|
507
|
+
};
|
|
508
|
+
/**
|
|
509
|
+
* Container name: `seoProductMetaWritePort`. Owner: `seo` (feature 174, FR-091), registered by T121.
|
|
510
|
+
*
|
|
511
|
+
* Writes product metadata **on the caller's EntityManager**: no fork, no flush, no audit entry,
|
|
512
|
+
* no event — `catalog`'s save Command commits or rolls the rows back with its own. `catalog`
|
|
513
|
+
* resolves it with `lazyPort` inside the Command only when the save changes SEO, and declares the
|
|
514
|
+
* edge `refuses-without`.
|
|
515
|
+
*
|
|
516
|
+
* Row mapping: G = (no channel, no locale); C = (channel, no locale); C×L = (channel, locale).
|
|
517
|
+
* `set` → the column holds the value; `empty` → `''`; `inherit` → `NULL`, and a row whose every
|
|
518
|
+
* column is `NULL` is deleted. Refuses (`422 SCOPED_VALUE_INVALID`) `inherit` at Global, an
|
|
519
|
+
* over-long value (title 160, description 400, OG title 160, OG description 400, image URL 2048)
|
|
520
|
+
* and an image URL that is not `http:` / `https:` or carries credentials (`unsafe_url`).
|
|
423
521
|
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
522
|
+
* **No scope check:** it writes any scope it is given — membership and the channel's languages are
|
|
523
|
+
* the caller's to check (`catalog`'s save resolves the scope first; a duplicate writes the copy's
|
|
524
|
+
* scopes in the same transaction).
|
|
426
525
|
*
|
|
427
526
|
* **Owner off:** resolving this port throws `ModuleDisabledError` (503).
|
|
428
527
|
*/
|
|
429
|
-
export interface
|
|
430
|
-
|
|
528
|
+
export interface SeoProductMetaWritePort<EM = unknown> {
|
|
529
|
+
/**
|
|
530
|
+
* The current own values of the named fields at `scope`, for the caller's audit before-state:
|
|
531
|
+
* one entry per named field — `{ own: text }`, `{ own: { empty: true } }` for an empty override,
|
|
532
|
+
* `{ inherited: true }` for no own value there; `own` is never `null`
|
|
533
|
+
* (`contracts/seo-ports.md` §2).
|
|
534
|
+
*/
|
|
535
|
+
readWithin(em: EM, input: {
|
|
431
536
|
productId: string;
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
537
|
+
scope: ScopeRef;
|
|
538
|
+
fields: SeoProductMetaField[];
|
|
539
|
+
}): Promise<Partial<Record<SeoProductMetaField, SeoProductMetaOwnValue>>>;
|
|
540
|
+
applyWithin(em: EM, input: {
|
|
541
|
+
productId: string;
|
|
542
|
+
scope: ScopeRef;
|
|
543
|
+
changes: Partial<Record<SeoProductMetaField, ScopedWriteOp<string>>>;
|
|
544
|
+
}): Promise<{
|
|
545
|
+
before: Record<string, unknown>;
|
|
546
|
+
after: Record<string, unknown>;
|
|
547
|
+
}>;
|
|
436
548
|
}
|
|
437
549
|
//# sourceMappingURL=seo.d.ts.map
|
package/dist/seo.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"seo.d.ts","sourceRoot":"","sources":["../src/seo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"seo.d.ts","sourceRoot":"","sources":["../src/seo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE;;;;;GAKG;AAEH,eAAO,MAAM,mBAAmB;;;;EAA8C,CAAC;AAC/E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;iBAW7B,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;iBAgBhC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,aAM1B,CAAC;AAEJ,eAAO,MAAM,kCAAkC;;;;;;;;iBAU7C,CAAC;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F,eAAO,MAAM,mBAAmB;;;;iBAI9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;iBAKrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;iBAE3C,CAAC;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,4BAA4B;;;iBAKvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF,eAAO,MAAM,oCAAoC;;;;;iBAE/C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAElG;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB,QAAS,CAAC;AAE7C,2FAA2F;AAC3F,eAAO,MAAM,+BAA+B,WAAW,CAAC;AACxD,iFAAiF;AACjF,eAAO,MAAM,iCAAiC,sBAAsB,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;iBAsBvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF,eAAO,MAAM,oCAAoC;;;;;;;;;;;;iBAE/C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAMtE;AAYD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,+BAA+B,2BAA2B,CAAC;AAExE,+CAA+C;AAC/C,eAAO,MAAM,sBAAsB;;;EAA6B,CAAC;AACjE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kCAAkC;;;;;IAE7C;;;;;OAKG;;kBAEH,CAAC;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,kCAAkC;;;;;;EAM7C,CAAC;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAS9F;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoCtC,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAEhD,CAAC;AACH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AAEpG;;;;;GAKG;AAEH,gGAAgG;AAChG,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,SAAS,CAAC;AAE5D,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;kBAAqB,CAAC;AAC5D,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,oBAAoB,CAAC;KAChC,GAAG,OAAO,CAAC,oBAAoB,GAAG;QAAE,OAAO,EAAE,MAAM,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CAAA;KAAE,CAAC,CAAC;IACnG,0GAA0G;IAC1G,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC9G,mDAAmD;IACnD,oBAAoB,CAClB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,MAAM,EAAE,mBAAmB,EAAE,CAAA;KAAE,CAAC,CAAC,CAAC;CAC7G;AAED,oGAAoG;AACpG,MAAM,MAAM,sBAAsB,GAAG;IAAE,GAAG,EAAE,MAAM,GAAG;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,IAAI,CAAA;CAAE,CAAC;AAE7F;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,uBAAuB,CAAC,EAAE,GAAG,OAAO;IACnD;;;;;OAKG;IACH,UAAU,CACR,EAAE,EAAE,EAAE,EACN,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,QAAQ,CAAC;QAAC,MAAM,EAAE,mBAAmB,EAAE,CAAA;KAAE,GAC3E,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IACzE,WAAW,CACT,EAAE,EAAE,EAAE,EACN,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,QAAQ,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACtE,GACA,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAAC;CACjF"}
|
package/dist/seo.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
import { isoDateTimeSchema, uuidSchema } from './common.js';
|
|
3
3
|
import { SalesChannelCodeSchema } from './sales-channels.js';
|
|
4
|
+
import { scopeRequestSchema } from './product-scopes.js';
|
|
4
5
|
/**
|
|
5
6
|
* SEO meta + sitemap contracts (T235 / FR-101, FR-102).
|
|
6
7
|
*
|
|
@@ -24,22 +25,49 @@ export const seoMetaOverrideSchema = z.object({
|
|
|
24
25
|
id: uuidSchema,
|
|
25
26
|
entityType: seoEntityTypeSchema,
|
|
26
27
|
entityId: uuidSchema,
|
|
27
|
-
|
|
28
|
+
/** `null` = a sales channel row (feature 163). */
|
|
29
|
+
locale: z.string().min(2).max(10).nullable(),
|
|
30
|
+
/** Feature 163 — `null` = a language row, for every channel. */
|
|
31
|
+
channelId: uuidSchema.nullable(),
|
|
28
32
|
title: z.string().nullable(),
|
|
29
33
|
description: z.string().nullable(),
|
|
30
34
|
ogTitle: z.string().nullable(),
|
|
31
35
|
ogDescription: z.string().nullable(),
|
|
32
|
-
|
|
36
|
+
/** As written: an http(s) URL or a site-relative path ({@link ogImageUrlSchema}). */
|
|
37
|
+
ogImageUrl: z.string().nullable(),
|
|
33
38
|
createdAt: isoDateTimeSchema,
|
|
34
39
|
updatedAt: isoDateTimeSchema,
|
|
35
40
|
});
|
|
41
|
+
/**
|
|
42
|
+
* Where an override sits (feature 163, `contracts/seo-media-attachments.md` §1):
|
|
43
|
+
* `locale` only = the language row, `channelId` only = the sales channel row,
|
|
44
|
+
* both = the channel × language row. Naming **neither** keeps the meaning every
|
|
45
|
+
* caller before feature 163 relied on — the `en-US` language row. Only a
|
|
46
|
+
* `product` takes a `channelId`.
|
|
47
|
+
*/
|
|
48
|
+
export const seoMetaScopeQuerySchema = z.object({
|
|
49
|
+
locale: z.string().min(2).max(10).optional(),
|
|
50
|
+
channelId: uuidSchema.optional(),
|
|
51
|
+
});
|
|
52
|
+
/**
|
|
53
|
+
* Feature 163 (checkpoint E security review, I5) — an Open Graph image URL: an
|
|
54
|
+
* absolute `http(s)` URL or a site-relative path (`/…`, never `//…` or `/\…`). It is
|
|
55
|
+
* written into every page's `og:image`, so no other scheme is accepted.
|
|
56
|
+
*/
|
|
57
|
+
export const ogImageUrlSchema = z
|
|
58
|
+
.string()
|
|
59
|
+
.max(2048)
|
|
60
|
+
.refine((value) => /^https?:\/\/[^\s/?#\\@]+(?:[/?#][^\s\\]*)?$/i.test(value) || /^\/(?![/\\])[^\s\\]*$/.test(value), { message: 'an http(s) URL or a path starting with a single /' });
|
|
36
61
|
export const upsertSeoMetaOverrideRequestSchema = z.object({
|
|
37
|
-
|
|
62
|
+
/** Optional since feature 163 — see {@link seoMetaScopeQuerySchema} for the addressing rule. */
|
|
63
|
+
locale: z.string().min(2).max(10).optional(),
|
|
64
|
+
/** Feature 163 — the sales channel scope of a product override. */
|
|
65
|
+
channelId: uuidSchema.optional(),
|
|
38
66
|
title: z.string().min(1).max(160).nullable().optional(),
|
|
39
67
|
description: z.string().min(1).max(400).nullable().optional(),
|
|
40
68
|
ogTitle: z.string().min(1).max(160).nullable().optional(),
|
|
41
69
|
ogDescription: z.string().min(1).max(400).nullable().optional(),
|
|
42
|
-
ogImageUrl:
|
|
70
|
+
ogImageUrl: ogImageUrlSchema.nullable().optional(),
|
|
43
71
|
});
|
|
44
72
|
export const sitemapStatusSchema = z.object({
|
|
45
73
|
generatedAt: isoDateTimeSchema.nullable(),
|
|
@@ -363,4 +391,10 @@ export const adminCrawlerFilePreviewSchema = z
|
|
|
363
391
|
export const adminCrawlerFilePreviewResponseSchema = z.object({
|
|
364
392
|
data: adminCrawlerFilePreviewSchema,
|
|
365
393
|
});
|
|
394
|
+
/**
|
|
395
|
+
* `GET /api/v1/admin/seo/meta/product/:entityId` query — `catalog:read` (FR-093). The scope
|
|
396
|
+
* request every scoped read takes (`scopeRequestSchema`, resolved with `scopeFromRequest`): no
|
|
397
|
+
* locale-only scope.
|
|
398
|
+
*/
|
|
399
|
+
export const seoProductMetaQuerySchema = scopeRequestSchema;
|
|
366
400
|
//# sourceMappingURL=seo.js.map
|
package/dist/seo.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"seo.js","sourceRoot":"","sources":["../src/seo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"seo.js","sourceRoot":"","sources":["../src/seo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAI7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAG/E,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;QAClB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC7B,CAAC;IACF,2EAA2E;IAC3E,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,EAAE,EAAE,UAAU;IACd,UAAU,EAAE,mBAAmB;IAC/B,QAAQ,EAAE,UAAU;IACpB,kDAAkD;IAClD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,gEAAgE;IAChE,SAAS,EAAE,UAAU,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,qFAAqF;IACrF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,iBAAiB;IAC5B,SAAS,EAAE,iBAAiB;CAC7B,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,SAAS,EAAE,UAAU,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,EAAE;KACR,GAAG,CAAC,IAAI,CAAC;KACT,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,8CAA8C,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,EAC5G,EAAE,OAAO,EAAE,mDAAmD,EAAE,CACjE,CAAC;AAEJ,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,gGAAgG;IAChG,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,mEAAmE;IACnE,SAAS,EAAE,UAAU,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACvD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC7D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACzD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC/D,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACnD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IACnD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC;AAGH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,MAAM,CAAC;IACnE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,mBAAmB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;CAC5D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC;CAC1C,CAAC,CAAC;AAGH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,yEAAyE;IACzE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;IAClB,wEAAwE;IACxE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;CACpB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,IAAI,EAAE,4BAA4B;CACnC,CAAC,CAAC;AAGH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE7C,2FAA2F;AAC3F,MAAM,CAAC,MAAM,+BAA+B,GAAG,QAAQ,CAAC;AACxD,iFAAiF;AACjF,MAAM,CAAC,MAAM,iCAAiC,GAAG,mBAAmB,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,4BAA4B,CAAC,MAAM,CAAC;IAC9E,yDAAyD;IACzD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,sBAAsB,CAAC;IACvD,6DAA6D;IAC7D,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,sBAAsB,CAAC;IACzD,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,oEAAoE;QACpE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC;IACF,mEAAmE;IACnE,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C;;;;;;;;;OASG;IACH,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,IAAI,EAAE,4BAA4B;CACnC,CAAC,CAAC;AAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,KAAa;IAC5D,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACjF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7C,gFAAgF;IAChF,MAAM,IAAI,GAAG,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;IACvE,OAAO,GAAG,wBAAwB,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;AAC1D,CAAC;AAED,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,MAAM,SAAS,GAAG,IAAI,CAAC;AAEvB,0EAA0E;AAC1E,SAAS,wBAAwB,CAAC,IAAY;IAC5C,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;IACtB,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,SAAS;QAAE,GAAG,IAAI,CAAC,CAAC;IACnE,OAAO,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AAExE,+CAA+C;AAC/C,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAGjE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/D,IAAI,EAAE,sBAAsB;IAC5B;;;;;OAKG;IACH,gBAAgB,EAAE,sBAAsB,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC;AAGH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,IAAI,CAAC;IACvD,IAAI;IACJ,qBAAqB;IACrB,YAAY;IACZ,wBAAwB;IACxB,iBAAiB;CAClB,CAAC,CAAC;AAGH,uEAAuE;AACvE,MAAM,mBAAmB,GAA4C;IACnE,YAAY;IACZ,wBAAwB;IACxB,iBAAiB;CAClB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC;KAC3C,MAAM,CAAC;IACN,IAAI,EAAE,sBAAsB;IAC5B,gBAAgB,EAAE,sBAAsB;IACxC,KAAK,EAAE,kCAAkC;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,8DAA8D;IAC9D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,+FAA+F;IAC/F,gBAAgB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC1D,8EAA8E;IAC9E,oBAAoB,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;IACrD,wEAAwE;IACxE,MAAM,EAAE,4BAA4B;IACpC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,8DAA8D;QAC9D,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf;;;;WAIG;QACH,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;KAC/C,CAAC;CACH,CAAC;KACD,WAAW,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;IAC5B,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACpD,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACzE,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,MAAM,CAAC;YACd,OAAO,EAAE,UAAU,OAAO,CAAC,KAAK,2CAA2C;SAC5E,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5D,IAAI,EAAE,6BAA6B;CACpC,CAAC,CAAC;AAqBH;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,kBAAkB,CAAC"}
|