@endora-commerce/contracts 0.107.0 → 0.109.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/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 +35 -6
- package/dist/admin-contributions.d.ts.map +1 -1
- package/dist/admin-contributions.js +46 -0
- package/dist/admin-contributions.js.map +1 -1
- package/dist/admin-feedback.d.ts +61 -0
- package/dist/admin-feedback.d.ts.map +1 -0
- package/dist/admin-feedback.js +71 -0
- package/dist/admin-feedback.js.map +1 -0
- package/dist/admin-name.d.ts +21 -0
- package/dist/admin-name.d.ts.map +1 -0
- package/dist/admin-name.js +30 -0
- package/dist/admin-name.js.map +1 -0
- 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.d.ts +15 -1
- package/dist/admin.d.ts.map +1 -1
- package/dist/admin.js +7 -0
- package/dist/admin.js.map +1 -1
- package/dist/assets-library.d.ts +97 -3
- package/dist/assets-library.d.ts.map +1 -1
- package/dist/assets-library.js +5 -0
- package/dist/assets-library.js.map +1 -1
- package/dist/blog.d.ts +57 -0
- package/dist/blog.d.ts.map +1 -1
- package/dist/blog.js +63 -1
- package/dist/blog.js.map +1 -1
- package/dist/carts.d.ts +303 -50
- package/dist/carts.d.ts.map +1 -1
- package/dist/carts.js +95 -13
- package/dist/carts.js.map +1 -1
- package/dist/catalog.d.ts +512 -40
- package/dist/catalog.d.ts.map +1 -1
- package/dist/catalog.js +362 -23
- 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 +537 -3
- 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 +4 -0
- package/dist/common.d.ts.map +1 -1
- package/dist/common.js +14 -0
- package/dist/common.js.map +1 -1
- package/dist/comparisons.d.ts +7 -0
- package/dist/comparisons.d.ts.map +1 -1
- package/dist/comparisons.js +2 -0
- package/dist/comparisons.js.map +1 -1
- package/dist/credit-limits.d.ts.map +1 -1
- package/dist/credit-limits.js +3 -2
- package/dist/credit-limits.js.map +1 -1
- package/dist/crm-rich-text.d.ts +13 -0
- package/dist/crm-rich-text.d.ts.map +1 -0
- package/dist/crm-rich-text.js +13 -0
- package/dist/crm-rich-text.js.map +1 -0
- package/dist/crm.d.ts +180 -62
- package/dist/crm.d.ts.map +1 -1
- package/dist/crm.js +63 -107
- package/dist/crm.js.map +1 -1
- package/dist/custom-fields.d.ts +436 -5
- package/dist/custom-fields.d.ts.map +1 -1
- package/dist/custom-fields.js +325 -10
- package/dist/custom-fields.js.map +1 -1
- package/dist/customer-accounts.d.ts +30 -0
- package/dist/customer-accounts.d.ts.map +1 -1
- package/dist/customer-accounts.js +31 -0
- package/dist/customer-accounts.js.map +1 -1
- package/dist/document-templates.d.ts +211 -23
- package/dist/document-templates.d.ts.map +1 -1
- package/dist/document-templates.js +98 -1
- package/dist/document-templates.js.map +1 -1
- package/dist/document-values.d.ts +12 -1
- package/dist/document-values.d.ts.map +1 -1
- package/dist/document-values.js +41 -11
- 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 +142 -8
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +189 -8
- package/dist/errors.js.map +1 -1
- package/dist/index.d.ts +24 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +43 -1
- package/dist/index.js.map +1 -1
- package/dist/inventory.d.ts +3 -3
- package/dist/invoices.d.ts +6 -2
- package/dist/invoices.d.ts.map +1 -1
- package/dist/invoices.js +10 -4
- package/dist/invoices.js.map +1 -1
- package/dist/line-groups.d.ts +80 -0
- package/dist/line-groups.d.ts.map +1 -0
- package/dist/line-groups.js +130 -0
- package/dist/line-groups.js.map +1 -0
- package/dist/localized-name.d.ts +20 -0
- package/dist/localized-name.d.ts.map +1 -0
- package/dist/localized-name.js +45 -0
- package/dist/localized-name.js.map +1 -0
- 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 +1 -0
- package/dist/mfa.d.ts.map +1 -1
- package/dist/mfa.js +8 -2
- package/dist/mfa.js.map +1 -1
- package/dist/modules.d.ts +8 -1
- package/dist/modules.d.ts.map +1 -1
- package/dist/modules.js +5 -0
- package/dist/modules.js.map +1 -1
- package/dist/money-decimal.d.ts +162 -0
- package/dist/money-decimal.d.ts.map +1 -0
- package/dist/money-decimal.js +365 -0
- package/dist/money-decimal.js.map +1 -0
- package/dist/money-input.d.ts +64 -0
- package/dist/money-input.d.ts.map +1 -0
- package/dist/money-input.js +111 -0
- package/dist/money-input.js.map +1 -0
- package/dist/newsletter.d.ts +3 -3
- package/dist/order-minimums.d.ts +111 -0
- package/dist/order-minimums.d.ts.map +1 -0
- package/dist/order-minimums.js +196 -0
- package/dist/order-minimums.js.map +1 -0
- package/dist/orders.d.ts +206 -2
- package/dist/orders.d.ts.map +1 -1
- package/dist/orders.js +106 -5
- package/dist/orders.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/payment-methods.d.ts.map +1 -1
- package/dist/payment-methods.js +2 -1
- package/dist/payment-methods.js.map +1 -1
- package/dist/pim-connector.d.ts +1 -1
- 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-book-decimal.d.ts +84 -0
- package/dist/price-book-decimal.d.ts.map +1 -0
- package/dist/price-book-decimal.js +175 -0
- package/dist/price-book-decimal.js.map +1 -0
- package/dist/price-books.d.ts +2206 -0
- package/dist/price-books.d.ts.map +1 -0
- package/dist/price-books.js +777 -0
- package/dist/price-books.js.map +1 -0
- package/dist/price-lists.d.ts +309 -614
- package/dist/price-lists.d.ts.map +1 -1
- package/dist/price-lists.js +113 -453
- package/dist/price-lists.js.map +1 -1
- package/dist/product-feeds.d.ts +195 -54
- package/dist/product-feeds.d.ts.map +1 -1
- package/dist/product-feeds.js +36 -1
- package/dist/product-feeds.js.map +1 -1
- package/dist/product-scopes.d.ts +628 -0
- package/dist/product-scopes.d.ts.map +1 -0
- package/dist/product-scopes.js +365 -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-url-keys.d.ts +204 -0
- package/dist/product-url-keys.d.ts.map +1 -0
- package/dist/product-url-keys.js +166 -0
- package/dist/product-url-keys.js.map +1 -0
- package/dist/product-value-resolver.d.ts +6 -0
- package/dist/product-value-resolver.d.ts.map +1 -1
- package/dist/product-value-resolver.js +6 -1
- package/dist/product-value-resolver.js.map +1 -1
- package/dist/projects.d.ts +2355 -0
- package/dist/projects.d.ts.map +1 -0
- package/dist/projects.js +837 -0
- package/dist/projects.js.map +1 -0
- package/dist/promotions.d.ts +2 -2
- package/dist/promotions.d.ts.map +1 -1
- package/dist/promotions.js +8 -2
- package/dist/promotions.js.map +1 -1
- 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/quick-order.d.ts +39 -1
- package/dist/quick-order.d.ts.map +1 -1
- package/dist/quick-order.js +44 -1
- package/dist/quick-order.js.map +1 -1
- package/dist/quote-requests.d.ts +305 -1
- package/dist/quote-requests.d.ts.map +1 -1
- package/dist/quote-requests.js +173 -5
- 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 +179 -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 +303 -0
- package/dist/record-rich-text.js.map +1 -0
- package/dist/returns.d.ts +81 -2
- package/dist/returns.d.ts.map +1 -1
- package/dist/returns.js +39 -4
- package/dist/returns.js.map +1 -1
- package/dist/sales-channels.d.ts +53 -7
- package/dist/sales-channels.d.ts.map +1 -1
- package/dist/sales-channels.js +40 -4
- package/dist/sales-channels.js.map +1 -1
- package/dist/saved-list-views.d.ts +28 -0
- package/dist/saved-list-views.d.ts.map +1 -1
- package/dist/saved-list-views.js +14 -1
- package/dist/saved-list-views.js.map +1 -1
- package/dist/scoped-translations.d.ts +48 -0
- package/dist/scoped-translations.d.ts.map +1 -0
- package/dist/scoped-translations.js +78 -0
- package/dist/scoped-translations.js.map +1 -0
- package/dist/search.d.ts +73 -5
- package/dist/search.d.ts.map +1 -1
- package/dist/search.js +4 -0
- package/dist/search.js.map +1 -1
- package/dist/seo.d.ts +64 -5
- package/dist/seo.d.ts.map +1 -1
- package/dist/seo.js +31 -4
- package/dist/seo.js.map +1 -1
- package/dist/settings.d.ts +32 -3
- package/dist/settings.d.ts.map +1 -1
- package/dist/settings.js +37 -3
- package/dist/settings.js.map +1 -1
- package/dist/shipping-methods.d.ts.map +1 -1
- package/dist/shipping-methods.js +2 -1
- package/dist/shipping-methods.js.map +1 -1
- package/dist/shopping-lists.d.ts +24 -0
- package/dist/shopping-lists.d.ts.map +1 -1
- package/dist/shopping-lists.js +20 -1
- package/dist/shopping-lists.js.map +1 -1
- package/dist/storefront-cache-tags.d.ts +29 -0
- package/dist/storefront-cache-tags.d.ts.map +1 -1
- package/dist/storefront-cache-tags.js +24 -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 +67 -0
- package/dist/storefront-value-overrides.d.ts.map +1 -0
- package/dist/storefront-value-overrides.js +93 -0
- package/dist/storefront-value-overrides.js.map +1 -0
- 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 +7 -4
- 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 +2 -2
package/dist/catalog.d.ts
CHANGED
|
@@ -22,8 +22,13 @@ export declare const productTypeSchema: z.ZodEnum<{
|
|
|
22
22
|
virtual: "virtual";
|
|
23
23
|
}>;
|
|
24
24
|
export type ProductType = z.infer<typeof productTypeSchema>;
|
|
25
|
+
/**
|
|
26
|
+
* Feature 163, spec Session 2026-10-25 (FR-010, FR-112) — `active` | `inactive` at
|
|
27
|
+
* every scope; `inactive` is plain off. `draft` is gone and the legacy `archived`
|
|
28
|
+
* write alias is refused: archiving is the separate Archive / Restore action
|
|
29
|
+
* (`archivedAt`), never a status.
|
|
30
|
+
*/
|
|
25
31
|
export declare const productStatusSchema: z.ZodEnum<{
|
|
26
|
-
draft: "draft";
|
|
27
32
|
active: "active";
|
|
28
33
|
inactive: "inactive";
|
|
29
34
|
}>;
|
|
@@ -31,18 +36,10 @@ export type ProductStatus = z.infer<typeof productStatusSchema>;
|
|
|
31
36
|
/**
|
|
32
37
|
* The most products one admin selection may carry: the cap of the admin product
|
|
33
38
|
* browser (a session refuses to select a 201st row) and the `.max()` of every
|
|
34
|
-
* request that submits such a selection in one call,
|
|
35
|
-
* `bulkAddPriceListProductsRequestSchema`. One home for the number, so the
|
|
39
|
+
* request that submits such a selection in one call. One home for the number, so the
|
|
36
40
|
* screen and the endpoint cannot disagree about it.
|
|
37
41
|
*/
|
|
38
42
|
export declare const ADMIN_PRODUCT_SELECTION_MAX = 200;
|
|
39
|
-
/** Maps legacy `archived` writes to `inactive` (feature 032). */
|
|
40
|
-
export declare function coerceProductStatusWrite(value: unknown): 'draft' | 'active' | 'inactive' | unknown;
|
|
41
|
-
export declare const productStatusWriteSchema: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodEnum<{
|
|
42
|
-
draft: "draft";
|
|
43
|
-
active: "active";
|
|
44
|
-
inactive: "inactive";
|
|
45
|
-
}>>;
|
|
46
43
|
export declare const stockModeSchema: z.ZodEnum<{
|
|
47
44
|
categorical: "categorical";
|
|
48
45
|
numeric: "numeric";
|
|
@@ -164,19 +161,19 @@ export type ProductAsset = z.infer<typeof productAssetSchema>;
|
|
|
164
161
|
* storefront shows (`available` = stock not managed for the product).
|
|
165
162
|
*/
|
|
166
163
|
export declare const productAvailabilityBandSchema: z.ZodEnum<{
|
|
164
|
+
medium: "medium";
|
|
167
165
|
available: "available";
|
|
168
166
|
out_of_stock: "out_of_stock";
|
|
169
167
|
high: "high";
|
|
170
|
-
medium: "medium";
|
|
171
168
|
low: "low";
|
|
172
169
|
}>;
|
|
173
170
|
export type ProductAvailabilityBand = z.infer<typeof productAvailabilityBandSchema>;
|
|
174
171
|
export declare const productAvailabilitySchema: z.ZodObject<{
|
|
175
172
|
band: z.ZodEnum<{
|
|
173
|
+
medium: "medium";
|
|
176
174
|
available: "available";
|
|
177
175
|
out_of_stock: "out_of_stock";
|
|
178
176
|
high: "high";
|
|
179
|
-
medium: "medium";
|
|
180
177
|
low: "low";
|
|
181
178
|
}>;
|
|
182
179
|
inStock: z.ZodBoolean;
|
|
@@ -193,6 +190,53 @@ export declare const productPriceTierSchema: z.ZodObject<{
|
|
|
193
190
|
isSale: z.ZodBoolean;
|
|
194
191
|
}, z.core.$strip>;
|
|
195
192
|
export type ProductPriceTier = z.infer<typeof productPriceTierSchema>;
|
|
193
|
+
/**
|
|
194
|
+
* D-287 P0 — the price a storefront surface renders, from the **same**
|
|
195
|
+
* resolution that produced `ProductSummary.price`: the regular (base) price,
|
|
196
|
+
* the sale price when a sale list priced the product, and the display mode.
|
|
197
|
+
*
|
|
198
|
+
* The product page used to fetch this separately from
|
|
199
|
+
* `GET /api/v1/storefront/products/:id/resolved-price` after the catalogue had
|
|
200
|
+
* already priced the product for `price`, so every product page resolved its
|
|
201
|
+
* product twice, and the home page's cards fanned out one such request per card
|
|
202
|
+
* (`specs/pricing/read-paths-and-performance.md` §2.1). Carrying it here makes
|
|
203
|
+
* a catalogue read the one resolution those surfaces need.
|
|
204
|
+
*
|
|
205
|
+
* `basePrice` is the base partition's figure, else the Product's own price
|
|
206
|
+
* when that is what `price` came from; `salePrice` is set only when a sale list
|
|
207
|
+
* priced the product (it is then also `price`). Both are `null` when nothing
|
|
208
|
+
* prices the product; `displayMode` is still the viewer's, so a page can tell
|
|
209
|
+
* "sold on request only" (`none`) from "no price".
|
|
210
|
+
*
|
|
211
|
+
* Issue #491 — under `displayMode: 'none'` the server sends **no amount**:
|
|
212
|
+
* `basePrice` and `salePrice` are `null`, `listPrice` is absent, and so are
|
|
213
|
+
* `ProductSummary.price`, `compareAtPrice` and `priceVariesByVariant` beside it,
|
|
214
|
+
* whatever the price books would charge. The storefront renders "price on
|
|
215
|
+
* request" from `displayMode`; there is no figure to hide. The display-mode values are
|
|
216
|
+
* `displayModeSchema`'s (`price-lists.ts`, which imports this file and checks
|
|
217
|
+
* the two agree at compile time).
|
|
218
|
+
*/
|
|
219
|
+
export declare const productResolvedPriceSchema: z.ZodObject<{
|
|
220
|
+
basePrice: z.ZodNullable<z.ZodObject<{
|
|
221
|
+
amount: z.ZodString;
|
|
222
|
+
currency: z.ZodString;
|
|
223
|
+
}, z.core.$strip>>;
|
|
224
|
+
salePrice: z.ZodNullable<z.ZodObject<{
|
|
225
|
+
amount: z.ZodString;
|
|
226
|
+
currency: z.ZodString;
|
|
227
|
+
}, z.core.$strip>>;
|
|
228
|
+
displayMode: z.ZodEnum<{
|
|
229
|
+
none: "none";
|
|
230
|
+
both: "both";
|
|
231
|
+
gross_only: "gross_only";
|
|
232
|
+
net_only: "net_only";
|
|
233
|
+
}>;
|
|
234
|
+
listPrice: z.ZodOptional<z.ZodObject<{
|
|
235
|
+
amount: z.ZodString;
|
|
236
|
+
currency: z.ZodString;
|
|
237
|
+
}, z.core.$strip>>;
|
|
238
|
+
}, z.core.$strip>;
|
|
239
|
+
export type ProductResolvedPrice = z.infer<typeof productResolvedPriceSchema>;
|
|
196
240
|
export declare const productSummarySchema: z.ZodObject<{
|
|
197
241
|
id: z.ZodString;
|
|
198
242
|
sku: z.ZodString;
|
|
@@ -205,12 +249,18 @@ export declare const productSummarySchema: z.ZodObject<{
|
|
|
205
249
|
}>;
|
|
206
250
|
name: z.ZodString;
|
|
207
251
|
slug: z.ZodString;
|
|
252
|
+
summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
208
253
|
categorySlugs: z.ZodArray<z.ZodString>;
|
|
209
254
|
primaryAssetUrl: z.ZodNullable<z.ZodString>;
|
|
210
255
|
price: z.ZodNullable<z.ZodObject<{
|
|
211
256
|
amount: z.ZodNumber;
|
|
212
257
|
currency: z.ZodString;
|
|
213
258
|
}, z.core.$strip>>;
|
|
259
|
+
compareAtPrice: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
260
|
+
amount: z.ZodNumber;
|
|
261
|
+
currency: z.ZodString;
|
|
262
|
+
}, z.core.$strip>>>;
|
|
263
|
+
priceVariesByVariant: z.ZodOptional<z.ZodBoolean>;
|
|
214
264
|
stockIndicator: z.ZodNullable<z.ZodEnum<{
|
|
215
265
|
available: "available";
|
|
216
266
|
out_of_stock: "out_of_stock";
|
|
@@ -220,21 +270,41 @@ export declare const productSummarySchema: z.ZodObject<{
|
|
|
220
270
|
priceUnavailable: z.ZodOptional<z.ZodBoolean>;
|
|
221
271
|
availability: z.ZodOptional<z.ZodObject<{
|
|
222
272
|
band: z.ZodEnum<{
|
|
273
|
+
medium: "medium";
|
|
223
274
|
available: "available";
|
|
224
275
|
out_of_stock: "out_of_stock";
|
|
225
276
|
high: "high";
|
|
226
|
-
medium: "medium";
|
|
227
277
|
low: "low";
|
|
228
278
|
}>;
|
|
229
279
|
inStock: z.ZodBoolean;
|
|
230
280
|
}, z.core.$strip>>;
|
|
281
|
+
minOrderQuantity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
282
|
+
resolvedPrice: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
283
|
+
basePrice: z.ZodNullable<z.ZodObject<{
|
|
284
|
+
amount: z.ZodString;
|
|
285
|
+
currency: z.ZodString;
|
|
286
|
+
}, z.core.$strip>>;
|
|
287
|
+
salePrice: z.ZodNullable<z.ZodObject<{
|
|
288
|
+
amount: z.ZodString;
|
|
289
|
+
currency: z.ZodString;
|
|
290
|
+
}, z.core.$strip>>;
|
|
291
|
+
displayMode: z.ZodEnum<{
|
|
292
|
+
none: "none";
|
|
293
|
+
both: "both";
|
|
294
|
+
gross_only: "gross_only";
|
|
295
|
+
net_only: "net_only";
|
|
296
|
+
}>;
|
|
297
|
+
listPrice: z.ZodOptional<z.ZodObject<{
|
|
298
|
+
amount: z.ZodString;
|
|
299
|
+
currency: z.ZodString;
|
|
300
|
+
}, z.core.$strip>>;
|
|
301
|
+
}, z.core.$strip>>>;
|
|
231
302
|
}, z.core.$strip>;
|
|
232
303
|
export type ProductSummary = z.infer<typeof productSummarySchema>;
|
|
233
304
|
export declare const productVariantSchema: z.ZodObject<{
|
|
234
305
|
id: z.ZodString;
|
|
235
306
|
sku: z.ZodString;
|
|
236
307
|
variantAttributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
237
|
-
priceOverride: z.ZodNullable<z.ZodNumber>;
|
|
238
308
|
stockLevel: z.ZodNullable<z.ZodNumber>;
|
|
239
309
|
}, z.core.$strip>;
|
|
240
310
|
export type ProductVariant = z.infer<typeof productVariantSchema>;
|
|
@@ -260,12 +330,18 @@ export declare const productDetailSchema: z.ZodObject<{
|
|
|
260
330
|
}>;
|
|
261
331
|
name: z.ZodString;
|
|
262
332
|
slug: z.ZodString;
|
|
333
|
+
summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
263
334
|
categorySlugs: z.ZodArray<z.ZodString>;
|
|
264
335
|
primaryAssetUrl: z.ZodNullable<z.ZodString>;
|
|
265
336
|
price: z.ZodNullable<z.ZodObject<{
|
|
266
337
|
amount: z.ZodNumber;
|
|
267
338
|
currency: z.ZodString;
|
|
268
339
|
}, z.core.$strip>>;
|
|
340
|
+
compareAtPrice: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
341
|
+
amount: z.ZodNumber;
|
|
342
|
+
currency: z.ZodString;
|
|
343
|
+
}, z.core.$strip>>>;
|
|
344
|
+
priceVariesByVariant: z.ZodOptional<z.ZodBoolean>;
|
|
269
345
|
stockIndicator: z.ZodNullable<z.ZodEnum<{
|
|
270
346
|
available: "available";
|
|
271
347
|
out_of_stock: "out_of_stock";
|
|
@@ -275,14 +351,35 @@ export declare const productDetailSchema: z.ZodObject<{
|
|
|
275
351
|
priceUnavailable: z.ZodOptional<z.ZodBoolean>;
|
|
276
352
|
availability: z.ZodOptional<z.ZodObject<{
|
|
277
353
|
band: z.ZodEnum<{
|
|
354
|
+
medium: "medium";
|
|
278
355
|
available: "available";
|
|
279
356
|
out_of_stock: "out_of_stock";
|
|
280
357
|
high: "high";
|
|
281
|
-
medium: "medium";
|
|
282
358
|
low: "low";
|
|
283
359
|
}>;
|
|
284
360
|
inStock: z.ZodBoolean;
|
|
285
361
|
}, z.core.$strip>>;
|
|
362
|
+
minOrderQuantity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
363
|
+
resolvedPrice: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
364
|
+
basePrice: z.ZodNullable<z.ZodObject<{
|
|
365
|
+
amount: z.ZodString;
|
|
366
|
+
currency: z.ZodString;
|
|
367
|
+
}, z.core.$strip>>;
|
|
368
|
+
salePrice: z.ZodNullable<z.ZodObject<{
|
|
369
|
+
amount: z.ZodString;
|
|
370
|
+
currency: z.ZodString;
|
|
371
|
+
}, z.core.$strip>>;
|
|
372
|
+
displayMode: z.ZodEnum<{
|
|
373
|
+
none: "none";
|
|
374
|
+
both: "both";
|
|
375
|
+
gross_only: "gross_only";
|
|
376
|
+
net_only: "net_only";
|
|
377
|
+
}>;
|
|
378
|
+
listPrice: z.ZodOptional<z.ZodObject<{
|
|
379
|
+
amount: z.ZodString;
|
|
380
|
+
currency: z.ZodString;
|
|
381
|
+
}, z.core.$strip>>;
|
|
382
|
+
}, z.core.$strip>>>;
|
|
286
383
|
description: z.ZodString;
|
|
287
384
|
attributeValues: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
|
|
288
385
|
assets: z.ZodArray<z.ZodObject<{
|
|
@@ -301,7 +398,6 @@ export declare const productDetailSchema: z.ZodObject<{
|
|
|
301
398
|
id: z.ZodString;
|
|
302
399
|
sku: z.ZodString;
|
|
303
400
|
variantAttributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
304
|
-
priceOverride: z.ZodNullable<z.ZodNumber>;
|
|
305
401
|
stockLevel: z.ZodNullable<z.ZodNumber>;
|
|
306
402
|
}, z.core.$strip>>;
|
|
307
403
|
categories: z.ZodArray<z.ZodObject<{
|
|
@@ -318,6 +414,14 @@ export declare const productDetailSchema: z.ZodObject<{
|
|
|
318
414
|
imageUrl: z.ZodNullable<z.ZodString>;
|
|
319
415
|
}, z.core.$strip>;
|
|
320
416
|
}, z.core.$strip>;
|
|
417
|
+
paths: z.ZodObject<{
|
|
418
|
+
canonical: z.ZodString;
|
|
419
|
+
alternates: z.ZodArray<z.ZodObject<{
|
|
420
|
+
languageCode: z.ZodString;
|
|
421
|
+
path: z.ZodString;
|
|
422
|
+
}, z.core.$strip>>;
|
|
423
|
+
xDefault: z.ZodString;
|
|
424
|
+
}, z.core.$strip>;
|
|
321
425
|
structuredDataJsonLd: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
322
426
|
attributeSet: z.ZodOptional<z.ZodObject<{
|
|
323
427
|
id: z.ZodString;
|
|
@@ -337,6 +441,7 @@ export declare const productDetailSchema: z.ZodObject<{
|
|
|
337
441
|
kind: z.ZodString;
|
|
338
442
|
url: z.ZodString;
|
|
339
443
|
}, z.core.$strip>;
|
|
444
|
+
altText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
340
445
|
}, z.core.$strip>>>;
|
|
341
446
|
groupedItems: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
342
447
|
id: z.ZodString;
|
|
@@ -483,6 +588,7 @@ export declare const productDetailSchema: z.ZodObject<{
|
|
|
483
588
|
baseQuantity: z.ZodNumber;
|
|
484
589
|
position: z.ZodNumber;
|
|
485
590
|
isDefault: z.ZodBoolean;
|
|
591
|
+
minOrderUnits: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
486
592
|
}, z.core.$strip>>>;
|
|
487
593
|
priceTiers: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
488
594
|
minQuantity: z.ZodNumber;
|
|
@@ -619,11 +725,10 @@ export declare const createProductRequestSchema: z.ZodObject<{
|
|
|
619
725
|
logged_in_only: "logged_in_only";
|
|
620
726
|
organization_restricted: "organization_restricted";
|
|
621
727
|
}>;
|
|
622
|
-
status: z.ZodOptional<z.
|
|
623
|
-
draft: "draft";
|
|
728
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
624
729
|
active: "active";
|
|
625
730
|
inactive: "inactive";
|
|
626
|
-
}
|
|
731
|
+
}>>;
|
|
627
732
|
allowedOrganizationIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
628
733
|
assetIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
629
734
|
initialStock: z.ZodOptional<z.ZodNumber>;
|
|
@@ -645,24 +750,27 @@ export declare const createProductRequestSchema: z.ZodObject<{
|
|
|
645
750
|
defined_order: "defined_order";
|
|
646
751
|
}>>>;
|
|
647
752
|
fulfilmentStrategyWarehouseOrder: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
753
|
+
minOrderQuantity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
754
|
+
returnable: z.ZodOptional<z.ZodBoolean>;
|
|
648
755
|
}, z.core.$strip>;
|
|
649
756
|
export type CreateProductRequest = z.infer<typeof createProductRequestSchema>;
|
|
650
757
|
export declare const updateProductRequestSchema: z.ZodObject<{
|
|
651
758
|
description: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
652
|
-
status: z.ZodOptional<z.ZodOptional<z.
|
|
653
|
-
draft: "draft";
|
|
759
|
+
status: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
|
|
654
760
|
active: "active";
|
|
655
761
|
inactive: "inactive";
|
|
656
|
-
}
|
|
762
|
+
}>>>;
|
|
657
763
|
visibility: z.ZodOptional<z.ZodEnum<{
|
|
658
764
|
public: "public";
|
|
659
765
|
logged_in_only: "logged_in_only";
|
|
660
766
|
organization_restricted: "organization_restricted";
|
|
661
767
|
}>>;
|
|
662
768
|
name: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
769
|
+
returnable: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
663
770
|
assetIds: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
664
771
|
categoryIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
665
772
|
sku: z.ZodOptional<z.ZodString>;
|
|
773
|
+
minOrderQuantity: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
|
|
666
774
|
manageStock: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
667
775
|
backorderEnabled: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
668
776
|
lowStockThreshold: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
|
|
@@ -688,6 +796,8 @@ export declare const updateProductRequestSchema: z.ZodObject<{
|
|
|
688
796
|
defined_order: "defined_order";
|
|
689
797
|
}>>>>;
|
|
690
798
|
fulfilmentStrategyWarehouseOrder: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>>;
|
|
799
|
+
publishFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
800
|
+
publishUntil: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
691
801
|
}, z.core.$strip>;
|
|
692
802
|
export type UpdateProductRequest = z.infer<typeof updateProductRequestSchema>;
|
|
693
803
|
export declare const batchByIdProductsRequestSchema: z.ZodObject<{
|
|
@@ -697,9 +807,19 @@ export declare const batchByIdProductsRequestSchema: z.ZodObject<{
|
|
|
697
807
|
}, z.core.$strip>;
|
|
698
808
|
export type BatchByIdProductsRequest = z.infer<typeof batchByIdProductsRequestSchema>;
|
|
699
809
|
export declare const MAX_RESOLVE_SELECTION_SIZE = 10000;
|
|
810
|
+
/**
|
|
811
|
+
* Feature 163 (FR-113, research R30.4) — which archived products a list or a
|
|
812
|
+
* selection shows, independently of the status: `exclude` hides them, `include`
|
|
813
|
+
* shows them beside the rest, `only` shows nothing else.
|
|
814
|
+
*/
|
|
815
|
+
export declare const productArchivedModeSchema: z.ZodEnum<{
|
|
816
|
+
only: "only";
|
|
817
|
+
exclude: "exclude";
|
|
818
|
+
include: "include";
|
|
819
|
+
}>;
|
|
820
|
+
export type ProductArchivedMode = z.infer<typeof productArchivedModeSchema>;
|
|
700
821
|
export declare const resolveProductIdsRequestSchema: z.ZodObject<{
|
|
701
822
|
status: z.ZodOptional<z.ZodEnum<{
|
|
702
|
-
draft: "draft";
|
|
703
823
|
active: "active";
|
|
704
824
|
inactive: "inactive";
|
|
705
825
|
}>>;
|
|
@@ -712,6 +832,11 @@ export declare const resolveProductIdsRequestSchema: z.ZodObject<{
|
|
|
712
832
|
}>>;
|
|
713
833
|
q: z.ZodOptional<z.ZodString>;
|
|
714
834
|
includeArchived: z.ZodOptional<z.ZodBoolean>;
|
|
835
|
+
archived: z.ZodOptional<z.ZodEnum<{
|
|
836
|
+
only: "only";
|
|
837
|
+
exclude: "exclude";
|
|
838
|
+
include: "include";
|
|
839
|
+
}>>;
|
|
715
840
|
}, z.core.$strip>;
|
|
716
841
|
export type ResolveProductIdsRequest = z.infer<typeof resolveProductIdsRequestSchema>;
|
|
717
842
|
export declare const resolveProductIdsResponseSchema: z.ZodObject<{
|
|
@@ -724,11 +849,10 @@ export type ResolveProductIdsResponse = z.infer<typeof resolveProductIdsResponse
|
|
|
724
849
|
export declare const bulkUpdateProductsRequestSchema: z.ZodObject<{
|
|
725
850
|
productIds: z.ZodArray<z.ZodString>;
|
|
726
851
|
fields: z.ZodObject<{
|
|
727
|
-
status: z.ZodOptional<z.
|
|
728
|
-
draft: "draft";
|
|
852
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
729
853
|
active: "active";
|
|
730
854
|
inactive: "inactive";
|
|
731
|
-
}
|
|
855
|
+
}>>;
|
|
732
856
|
visibility: z.ZodOptional<z.ZodEnum<{
|
|
733
857
|
public: "public";
|
|
734
858
|
logged_in_only: "logged_in_only";
|
|
@@ -751,6 +875,17 @@ export declare const bulkUpdateProductsRequestSchema: z.ZodObject<{
|
|
|
751
875
|
}, z.core.$strip>>;
|
|
752
876
|
attributeSetId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
753
877
|
attributeValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
878
|
+
returnable: z.ZodOptional<z.ZodBoolean>;
|
|
879
|
+
scopedStatus: z.ZodOptional<z.ZodObject<{
|
|
880
|
+
channelId: z.ZodString;
|
|
881
|
+
languageCode: z.ZodNullable<z.ZodString>;
|
|
882
|
+
value: z.ZodEnum<{
|
|
883
|
+
active: "active";
|
|
884
|
+
inactive: "inactive";
|
|
885
|
+
inherit: "inherit";
|
|
886
|
+
}>;
|
|
887
|
+
}, z.core.$strip>>;
|
|
888
|
+
archived: z.ZodOptional<z.ZodBoolean>;
|
|
754
889
|
}, z.core.$strip>;
|
|
755
890
|
}, z.core.$strip>;
|
|
756
891
|
export type BulkUpdateProductsRequest = z.infer<typeof bulkUpdateProductsRequestSchema>;
|
|
@@ -767,6 +902,8 @@ export declare const bulkUpdateProductResultSchema: z.ZodObject<{
|
|
|
767
902
|
validation_failed: "validation_failed";
|
|
768
903
|
permission_denied: "permission_denied";
|
|
769
904
|
concurrent_modification: "concurrent_modification";
|
|
905
|
+
scope_invalid: "scope_invalid";
|
|
906
|
+
completeness_gate: "completeness_gate";
|
|
770
907
|
}>>;
|
|
771
908
|
details: z.ZodOptional<z.ZodObject<{
|
|
772
909
|
code: z.ZodOptional<z.ZodString>;
|
|
@@ -798,6 +935,8 @@ export declare const bulkUpdateProductsResponseSchema: z.ZodObject<{
|
|
|
798
935
|
validation_failed: "validation_failed";
|
|
799
936
|
permission_denied: "permission_denied";
|
|
800
937
|
concurrent_modification: "concurrent_modification";
|
|
938
|
+
scope_invalid: "scope_invalid";
|
|
939
|
+
completeness_gate: "completeness_gate";
|
|
801
940
|
}>>;
|
|
802
941
|
details: z.ZodOptional<z.ZodObject<{
|
|
803
942
|
code: z.ZodOptional<z.ZodString>;
|
|
@@ -827,6 +966,12 @@ export type BulkOperationStatus = z.infer<typeof bulkOperationStatusSchema>;
|
|
|
827
966
|
/**
|
|
828
967
|
* One timestamped lifecycle event in a bulk operation's log trail, surfaced
|
|
829
968
|
* in the bulk-operations detail view next to the per-element results.
|
|
969
|
+
*
|
|
970
|
+
* The trail is stored and read later by administrators in languages of their
|
|
971
|
+
* own, so an entry carries `messageKey` — a key in `catalog`'s bundle and the
|
|
972
|
+
* params that fill it — for its reader to translate, and `message`, the
|
|
973
|
+
* finished English sentence, for a reader that cannot resolve the key. Entries
|
|
974
|
+
* written before `messageKey` existed carry only `message`.
|
|
830
975
|
*/
|
|
831
976
|
export declare const bulkOperationLogEntrySchema: z.ZodObject<{
|
|
832
977
|
ts: z.ZodString;
|
|
@@ -836,6 +981,10 @@ export declare const bulkOperationLogEntrySchema: z.ZodObject<{
|
|
|
836
981
|
warn: "warn";
|
|
837
982
|
}>;
|
|
838
983
|
message: z.ZodString;
|
|
984
|
+
messageKey: z.ZodOptional<z.ZodObject<{
|
|
985
|
+
key: z.ZodString;
|
|
986
|
+
params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
|
|
987
|
+
}, z.core.$strip>>;
|
|
839
988
|
}, z.core.$strip>;
|
|
840
989
|
export type BulkOperationLogEntry = z.infer<typeof bulkOperationLogEntrySchema>;
|
|
841
990
|
/**
|
|
@@ -879,6 +1028,8 @@ export declare const bulkOperationSchema: z.ZodObject<{
|
|
|
879
1028
|
validation_failed: "validation_failed";
|
|
880
1029
|
permission_denied: "permission_denied";
|
|
881
1030
|
concurrent_modification: "concurrent_modification";
|
|
1031
|
+
scope_invalid: "scope_invalid";
|
|
1032
|
+
completeness_gate: "completeness_gate";
|
|
882
1033
|
}>>;
|
|
883
1034
|
details: z.ZodOptional<z.ZodObject<{
|
|
884
1035
|
code: z.ZodOptional<z.ZodString>;
|
|
@@ -895,6 +1046,10 @@ export declare const bulkOperationSchema: z.ZodObject<{
|
|
|
895
1046
|
warn: "warn";
|
|
896
1047
|
}>;
|
|
897
1048
|
message: z.ZodString;
|
|
1049
|
+
messageKey: z.ZodOptional<z.ZodObject<{
|
|
1050
|
+
key: z.ZodString;
|
|
1051
|
+
params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
|
|
1052
|
+
}, z.core.$strip>>;
|
|
898
1053
|
}, z.core.$strip>>>;
|
|
899
1054
|
error: z.ZodNullable<z.ZodString>;
|
|
900
1055
|
createdAt: z.ZodString;
|
|
@@ -955,6 +1110,8 @@ export declare const bulkOperationsListResponseSchema: z.ZodObject<{
|
|
|
955
1110
|
validation_failed: "validation_failed";
|
|
956
1111
|
permission_denied: "permission_denied";
|
|
957
1112
|
concurrent_modification: "concurrent_modification";
|
|
1113
|
+
scope_invalid: "scope_invalid";
|
|
1114
|
+
completeness_gate: "completeness_gate";
|
|
958
1115
|
}>>;
|
|
959
1116
|
details: z.ZodOptional<z.ZodObject<{
|
|
960
1117
|
code: z.ZodOptional<z.ZodString>;
|
|
@@ -971,6 +1128,10 @@ export declare const bulkOperationsListResponseSchema: z.ZodObject<{
|
|
|
971
1128
|
warn: "warn";
|
|
972
1129
|
}>;
|
|
973
1130
|
message: z.ZodString;
|
|
1131
|
+
messageKey: z.ZodOptional<z.ZodObject<{
|
|
1132
|
+
key: z.ZodString;
|
|
1133
|
+
params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
|
|
1134
|
+
}, z.core.$strip>>;
|
|
974
1135
|
}, z.core.$strip>>>;
|
|
975
1136
|
error: z.ZodNullable<z.ZodString>;
|
|
976
1137
|
createdAt: z.ZodString;
|
|
@@ -1021,6 +1182,8 @@ export declare const bulkOperationResponseSchema: z.ZodObject<{
|
|
|
1021
1182
|
validation_failed: "validation_failed";
|
|
1022
1183
|
permission_denied: "permission_denied";
|
|
1023
1184
|
concurrent_modification: "concurrent_modification";
|
|
1185
|
+
scope_invalid: "scope_invalid";
|
|
1186
|
+
completeness_gate: "completeness_gate";
|
|
1024
1187
|
}>>;
|
|
1025
1188
|
details: z.ZodOptional<z.ZodObject<{
|
|
1026
1189
|
code: z.ZodOptional<z.ZodString>;
|
|
@@ -1037,6 +1200,10 @@ export declare const bulkOperationResponseSchema: z.ZodObject<{
|
|
|
1037
1200
|
warn: "warn";
|
|
1038
1201
|
}>;
|
|
1039
1202
|
message: z.ZodString;
|
|
1203
|
+
messageKey: z.ZodOptional<z.ZodObject<{
|
|
1204
|
+
key: z.ZodString;
|
|
1205
|
+
params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
|
|
1206
|
+
}, z.core.$strip>>;
|
|
1040
1207
|
}, z.core.$strip>>>;
|
|
1041
1208
|
error: z.ZodNullable<z.ZodString>;
|
|
1042
1209
|
createdAt: z.ZodString;
|
|
@@ -1052,19 +1219,58 @@ export declare const bulkOperationResponseSchema: z.ZodObject<{
|
|
|
1052
1219
|
}, z.core.$strip>;
|
|
1053
1220
|
}, z.core.$strip>;
|
|
1054
1221
|
export type BulkOperationResponse = z.infer<typeof bulkOperationResponseSchema>;
|
|
1222
|
+
/**
|
|
1223
|
+
* A variant's price is a row of a price book (feature 160, D-287 §5.8), not a
|
|
1224
|
+
* field of the variant: a `priceOverride` in the body is refused with
|
|
1225
|
+
* `400 PRICE_SET_IN_PRICE_BOOKS` by the route, before this schema strips it
|
|
1226
|
+
* (FR-043; {@link PRICE_FIELDS_REFUSED_ON_VARIANTS}).
|
|
1227
|
+
*/
|
|
1228
|
+
/**
|
|
1229
|
+
* A variant as the admin reads it (`serializeAdminVariant`) — the answer of
|
|
1230
|
+
* `GET /api/v1/admin/catalog/products/:productId/variants` (feature 161):
|
|
1231
|
+
* every variant of the product, whatever its channels, status or audience.
|
|
1232
|
+
*/
|
|
1233
|
+
export declare const adminProductVariantSchema: z.ZodObject<{
|
|
1234
|
+
id: z.ZodString;
|
|
1235
|
+
parentProductId: z.ZodString;
|
|
1236
|
+
sku: z.ZodString;
|
|
1237
|
+
variantAttributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1238
|
+
stockLevel: z.ZodNullable<z.ZodNumber>;
|
|
1239
|
+
createdAt: z.ZodString;
|
|
1240
|
+
updatedAt: z.ZodString;
|
|
1241
|
+
}, z.core.$strip>;
|
|
1242
|
+
export type AdminProductVariant = z.infer<typeof adminProductVariantSchema>;
|
|
1243
|
+
export declare const adminProductVariantsResponseSchema: z.ZodObject<{
|
|
1244
|
+
data: z.ZodArray<z.ZodObject<{
|
|
1245
|
+
id: z.ZodString;
|
|
1246
|
+
parentProductId: z.ZodString;
|
|
1247
|
+
sku: z.ZodString;
|
|
1248
|
+
variantAttributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1249
|
+
stockLevel: z.ZodNullable<z.ZodNumber>;
|
|
1250
|
+
createdAt: z.ZodString;
|
|
1251
|
+
updatedAt: z.ZodString;
|
|
1252
|
+
}, z.core.$strip>>;
|
|
1253
|
+
}, z.core.$strip>;
|
|
1254
|
+
export type AdminProductVariantsResponse = z.infer<typeof adminProductVariantsResponseSchema>;
|
|
1055
1255
|
export declare const createVariantRequestSchema: z.ZodObject<{
|
|
1056
1256
|
sku: z.ZodString;
|
|
1057
1257
|
variantAttributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1058
|
-
priceOverride: z.ZodOptional<z.ZodNumber>;
|
|
1059
1258
|
stockLevel: z.ZodOptional<z.ZodNumber>;
|
|
1060
1259
|
}, z.core.$strip>;
|
|
1061
1260
|
export type CreateVariantRequest = z.infer<typeof createVariantRequestSchema>;
|
|
1062
1261
|
export declare const updateVariantRequestSchema: z.ZodObject<{
|
|
1063
1262
|
stockLevel: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
|
|
1064
1263
|
variantAttributeValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1065
|
-
priceOverride: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
|
|
1066
1264
|
}, z.core.$strip>;
|
|
1067
1265
|
export type UpdateVariantRequest = z.infer<typeof updateVariantRequestSchema>;
|
|
1266
|
+
/**
|
|
1267
|
+
* Feature 160 (FR-043) — the old price fields a product or variant write
|
|
1268
|
+
* refuses with `400 PRICE_SET_IN_PRICE_BOOKS`: prices are set in price books.
|
|
1269
|
+
* On a product they are keys of `attributeValues` (the old *default price*) or,
|
|
1270
|
+
* from an old client, of the body itself; on a variant, the old price override.
|
|
1271
|
+
*/
|
|
1272
|
+
export declare const PRICE_FIELDS_REFUSED_ON_PRODUCTS: readonly ["defaultPrice", "price"];
|
|
1273
|
+
export declare const PRICE_FIELDS_REFUSED_ON_VARIANTS: readonly ["priceOverride", "defaultPrice", "price"];
|
|
1068
1274
|
/**
|
|
1069
1275
|
* Slider-numeric-kind discriminant (feature 002 T013/T021/T022). The API
|
|
1070
1276
|
* `type=slider` form needs an extra hint so the service knows whether the
|
|
@@ -1178,10 +1384,10 @@ export declare const adminAttributeResponseSchema: z.ZodObject<{
|
|
|
1178
1384
|
multiselect: "multiselect";
|
|
1179
1385
|
slider: "slider";
|
|
1180
1386
|
}>;
|
|
1181
|
-
numericKind: z.ZodOptional<z.ZodEnum<{
|
|
1387
|
+
numericKind: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
1182
1388
|
number: "number";
|
|
1183
1389
|
price: "price";
|
|
1184
|
-
}
|
|
1390
|
+
}>>>;
|
|
1185
1391
|
valueType: z.ZodEnum<{
|
|
1186
1392
|
string: "string";
|
|
1187
1393
|
number: "number";
|
|
@@ -1206,6 +1412,8 @@ export declare const adminAttributeResponseSchema: z.ZodObject<{
|
|
|
1206
1412
|
massEditable: z.ZodBoolean;
|
|
1207
1413
|
quickSearchable: z.ZodBoolean;
|
|
1208
1414
|
customFieldDefinitionId: z.ZodString;
|
|
1415
|
+
channelScoped: z.ZodOptional<z.ZodBoolean>;
|
|
1416
|
+
languageScoped: z.ZodOptional<z.ZodBoolean>;
|
|
1209
1417
|
createdAt: z.ZodString;
|
|
1210
1418
|
updatedAt: z.ZodString;
|
|
1211
1419
|
}, z.core.$strip>;
|
|
@@ -1304,8 +1512,33 @@ export declare const productListSortSchema: z.ZodEnum<{
|
|
|
1304
1512
|
export type ProductListSort = z.infer<typeof productListSortSchema>;
|
|
1305
1513
|
/** The two orderings feature 086 added, as a narrowing a consumer can reuse. */
|
|
1306
1514
|
export declare function isPriceSort(sort: ProductListSort | undefined): sort is 'price' | '-price';
|
|
1515
|
+
/**
|
|
1516
|
+
* Issue #590 — the most products one `GET /api/v1/catalog/products?ids=` names.
|
|
1517
|
+
* A hand-picked set (a blog post's related products) is a strip, not a
|
|
1518
|
+
* catalogue: two dozen is twice the widest strip any surface renders, and it
|
|
1519
|
+
* keeps the one batched price resolution behind the read small.
|
|
1520
|
+
*/
|
|
1521
|
+
export declare const PRODUCT_LIST_MAX_IDS = 24;
|
|
1522
|
+
/**
|
|
1523
|
+
* Issue #590 — `?ids=` on the public listing: a comma-separated list of product
|
|
1524
|
+
* ids, trimmed and de-duplicated (first occurrence wins), at least one and at
|
|
1525
|
+
* most {@link PRODUCT_LIST_MAX_IDS}. A value that is not a uuid is refused
|
|
1526
|
+
* (`400 VALIDATION_FAILED`) rather than dropped, because a caller naming
|
|
1527
|
+
* products by id is a program, and silently answering fewer products than it
|
|
1528
|
+
* asked for would hide its bug.
|
|
1529
|
+
*
|
|
1530
|
+
* The listing answers **the subset of those products this viewer may see** —
|
|
1531
|
+
* channel membership, status, window and audience are the listing's own
|
|
1532
|
+
* availability condition — each priced exactly as any listing card is: one
|
|
1533
|
+
* batched resolution for the viewer (`resolveListingPriceDetails`). An id that
|
|
1534
|
+
* is unknown, deleted, out of channel or hidden from the viewer is simply not
|
|
1535
|
+
* in the answer. The order is the listing's, not the list's; a caller that
|
|
1536
|
+
* cares about its own order re-orders by id.
|
|
1537
|
+
*/
|
|
1538
|
+
export declare const productListIdsSchema: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodString>>;
|
|
1307
1539
|
export declare const productListQuerySchema: z.ZodObject<{
|
|
1308
1540
|
q: z.ZodOptional<z.ZodString>;
|
|
1541
|
+
ids: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodString>>>;
|
|
1309
1542
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
1310
1543
|
cursor: z.ZodOptional<z.ZodString>;
|
|
1311
1544
|
sort: z.ZodOptional<z.ZodEnum<{
|
|
@@ -1327,8 +1560,8 @@ export type ProductListQuery = z.infer<typeof productListQuerySchema>;
|
|
|
1327
1560
|
*
|
|
1328
1561
|
* It rides on the listing response because the storefront has to decide whether
|
|
1329
1562
|
* to *render* the price controls, and the answer depends on the viewer and the
|
|
1330
|
-
* channel:
|
|
1331
|
-
*
|
|
1563
|
+
* channel: `pricing.unauthenticated_display_mode = none` hides prices until
|
|
1564
|
+
* login, on one channel or on all of them. A
|
|
1332
1565
|
* storefront that guessed would guess wrong on exactly the deployments that
|
|
1333
1566
|
* care, and a control that offers an ordering the API refuses is a worse defect
|
|
1334
1567
|
* than no control.
|
|
@@ -1435,6 +1668,10 @@ export declare const galleryLabelSchema: z.ZodEnum<{
|
|
|
1435
1668
|
thumbnail: "thumbnail";
|
|
1436
1669
|
}>;
|
|
1437
1670
|
export type GalleryLabel = z.infer<typeof galleryLabelSchema>;
|
|
1671
|
+
/** Feature 163 (FR-077) — the longest alt text of one image in one language. */
|
|
1672
|
+
export declare const GALLERY_ALT_TEXT_MAX = 255;
|
|
1673
|
+
/** Feature 163 — the most channels one write names. */
|
|
1674
|
+
export declare const SCOPED_CHANNELS_MAX = 256;
|
|
1438
1675
|
export declare const galleryItemSchema: z.ZodObject<{
|
|
1439
1676
|
id: z.ZodString;
|
|
1440
1677
|
productId: z.ZodString;
|
|
@@ -1445,6 +1682,8 @@ export declare const galleryItemSchema: z.ZodObject<{
|
|
|
1445
1682
|
small_image: "small_image";
|
|
1446
1683
|
thumbnail: "thumbnail";
|
|
1447
1684
|
}>>;
|
|
1685
|
+
altText: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1686
|
+
hiddenInChannels: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1448
1687
|
createdAt: z.ZodString;
|
|
1449
1688
|
updatedAt: z.ZodString;
|
|
1450
1689
|
}, z.core.$strip>;
|
|
@@ -1466,8 +1705,41 @@ export declare const updateGalleryItemRequestSchema: z.ZodObject<{
|
|
|
1466
1705
|
small_image: "small_image";
|
|
1467
1706
|
thumbnail: "thumbnail";
|
|
1468
1707
|
}>>>;
|
|
1708
|
+
altText: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1709
|
+
hiddenInChannels: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1469
1710
|
}, z.core.$strict>;
|
|
1470
1711
|
export type UpdateGalleryItemRequest = z.infer<typeof updateGalleryItemRequestSchema>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Feature 163 (FR-076, R14) — a channel's own holders of the gallery roles. `null` =
|
|
1714
|
+
* the global holder applies there. Read with `GET …/gallery/channel-roles`.
|
|
1715
|
+
*
|
|
1716
|
+
* The keys are the camelCase names of the gallery labels (`baseImage` = the
|
|
1717
|
+
* `base_image` label, `smallImage` = `small_image`, `thumbnail` = `thumbnail`); the
|
|
1718
|
+
* label spelling stays a value (`galleryLabelSchema`), never an API key.
|
|
1719
|
+
*/
|
|
1720
|
+
export declare const galleryChannelRolesSchema: z.ZodObject<{
|
|
1721
|
+
channelId: z.ZodString;
|
|
1722
|
+
roles: z.ZodObject<{
|
|
1723
|
+
baseImage: z.ZodNullable<z.ZodString>;
|
|
1724
|
+
smallImage: z.ZodNullable<z.ZodString>;
|
|
1725
|
+
thumbnail: z.ZodNullable<z.ZodString>;
|
|
1726
|
+
}, z.core.$strip>;
|
|
1727
|
+
}, z.core.$strip>;
|
|
1728
|
+
export type GalleryChannelRoles = z.infer<typeof galleryChannelRolesSchema>;
|
|
1729
|
+
/**
|
|
1730
|
+
* `PUT …/gallery/channel-roles` — a role named with an item id moves to that item in
|
|
1731
|
+
* the channel, `null` = use inherited (the global holder), an absent role is left as
|
|
1732
|
+
* it is.
|
|
1733
|
+
*/
|
|
1734
|
+
export declare const putGalleryChannelRolesRequestSchema: z.ZodObject<{
|
|
1735
|
+
channelId: z.ZodString;
|
|
1736
|
+
roles: z.ZodObject<{
|
|
1737
|
+
baseImage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1738
|
+
smallImage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1739
|
+
thumbnail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1740
|
+
}, z.core.$strict>;
|
|
1741
|
+
}, z.core.$strict>;
|
|
1742
|
+
export type PutGalleryChannelRolesRequest = z.infer<typeof putGalleryChannelRolesRequestSchema>;
|
|
1471
1743
|
export declare const reorderGalleryRequestSchema: z.ZodObject<{
|
|
1472
1744
|
orderedGalleryItemIds: z.ZodArray<z.ZodString>;
|
|
1473
1745
|
}, z.core.$strict>;
|
|
@@ -1494,6 +1766,10 @@ export declare const updateAttachmentTypeRequestSchema: z.ZodObject<{
|
|
|
1494
1766
|
position: z.ZodOptional<z.ZodNumber>;
|
|
1495
1767
|
}, z.core.$strict>;
|
|
1496
1768
|
export type UpdateAttachmentTypeRequest = z.infer<typeof updateAttachmentTypeRequestSchema>;
|
|
1769
|
+
/** Feature 163 (FR-078) — the longest attachment description one language may carry. */
|
|
1770
|
+
export declare const ATTACHMENT_DESCRIPTION_TRANSLATION_MAX = 4000;
|
|
1771
|
+
/** Feature 163 (FR-078) — an attachment name per language, as long as the global one. */
|
|
1772
|
+
export declare const ATTACHMENT_NAME_MAX = 160;
|
|
1497
1773
|
export declare const productAttachmentSchema: z.ZodObject<{
|
|
1498
1774
|
id: z.ZodString;
|
|
1499
1775
|
productId: z.ZodString;
|
|
@@ -1502,6 +1778,9 @@ export declare const productAttachmentSchema: z.ZodObject<{
|
|
|
1502
1778
|
name: z.ZodString;
|
|
1503
1779
|
description: z.ZodNullable<z.ZodString>;
|
|
1504
1780
|
position: z.ZodNumber;
|
|
1781
|
+
nameTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1782
|
+
descriptionTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1783
|
+
hiddenInChannels: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1505
1784
|
createdAt: z.ZodString;
|
|
1506
1785
|
updatedAt: z.ZodString;
|
|
1507
1786
|
}, z.core.$strip>;
|
|
@@ -1512,6 +1791,9 @@ export declare const createAttachmentRequestSchema: z.ZodObject<{
|
|
|
1512
1791
|
name: z.ZodString;
|
|
1513
1792
|
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1514
1793
|
position: z.ZodOptional<z.ZodNumber>;
|
|
1794
|
+
nameTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1795
|
+
descriptionTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1796
|
+
hiddenInChannels: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1515
1797
|
}, z.core.$strict>;
|
|
1516
1798
|
export type CreateAttachmentRequest = z.infer<typeof createAttachmentRequestSchema>;
|
|
1517
1799
|
export declare const updateAttachmentRequestSchema: z.ZodObject<{
|
|
@@ -1519,8 +1801,13 @@ export declare const updateAttachmentRequestSchema: z.ZodObject<{
|
|
|
1519
1801
|
name: z.ZodOptional<z.ZodString>;
|
|
1520
1802
|
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1521
1803
|
position: z.ZodOptional<z.ZodNumber>;
|
|
1804
|
+
nameTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1805
|
+
descriptionTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1806
|
+
hiddenInChannels: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1522
1807
|
}, z.core.$strict>;
|
|
1523
1808
|
export type UpdateAttachmentRequest = z.infer<typeof updateAttachmentRequestSchema>;
|
|
1809
|
+
/** The longest packaging-unit name, global or (feature 163, FR-079) per language. */
|
|
1810
|
+
export declare const PACKAGING_UNIT_NAME_MAX = 160;
|
|
1524
1811
|
/**
|
|
1525
1812
|
* A named ordering unit attached to a product (e.g. "Paleta" = 480 pieces).
|
|
1526
1813
|
* Managed in the Inventory section of the admin product card; surfaced on the
|
|
@@ -1530,9 +1817,11 @@ export declare const packagingUnitSchema: z.ZodObject<{
|
|
|
1530
1817
|
id: z.ZodString;
|
|
1531
1818
|
productId: z.ZodString;
|
|
1532
1819
|
name: z.ZodString;
|
|
1820
|
+
nameTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1533
1821
|
baseQuantity: z.ZodNumber;
|
|
1534
1822
|
position: z.ZodNumber;
|
|
1535
1823
|
isDefault: z.ZodBoolean;
|
|
1824
|
+
minOrderUnits: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1536
1825
|
createdAt: z.ZodString;
|
|
1537
1826
|
updatedAt: z.ZodString;
|
|
1538
1827
|
}, z.core.$strip>;
|
|
@@ -1542,6 +1831,8 @@ export declare const createPackagingUnitRequestSchema: z.ZodObject<{
|
|
|
1542
1831
|
baseQuantity: z.ZodNumber;
|
|
1543
1832
|
isDefault: z.ZodOptional<z.ZodBoolean>;
|
|
1544
1833
|
position: z.ZodOptional<z.ZodNumber>;
|
|
1834
|
+
minOrderUnits: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1835
|
+
nameTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1545
1836
|
}, z.core.$strict>;
|
|
1546
1837
|
export type CreatePackagingUnitRequest = z.infer<typeof createPackagingUnitRequestSchema>;
|
|
1547
1838
|
export declare const updatePackagingUnitRequestSchema: z.ZodObject<{
|
|
@@ -1549,6 +1840,8 @@ export declare const updatePackagingUnitRequestSchema: z.ZodObject<{
|
|
|
1549
1840
|
baseQuantity: z.ZodOptional<z.ZodNumber>;
|
|
1550
1841
|
isDefault: z.ZodOptional<z.ZodBoolean>;
|
|
1551
1842
|
position: z.ZodOptional<z.ZodNumber>;
|
|
1843
|
+
minOrderUnits: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1844
|
+
nameTranslations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1552
1845
|
}, z.core.$strict>;
|
|
1553
1846
|
export type UpdatePackagingUnitRequest = z.infer<typeof updatePackagingUnitRequestSchema>;
|
|
1554
1847
|
export declare const reorderPackagingUnitsRequestSchema: z.ZodObject<{
|
|
@@ -1768,6 +2061,17 @@ export interface CatalogProductRecord {
|
|
|
1768
2061
|
lowStockThresholdMode: 'cumulative' | 'per_warehouse';
|
|
1769
2062
|
fulfilmentStrategy: FulfilmentStrategy | null;
|
|
1770
2063
|
fulfilmentStrategyWarehouseOrder: string[] | null;
|
|
2064
|
+
/** Feature 155 — pieces minimum; `null` = none. Stored for any type, applied to simple/configurable only. */
|
|
2065
|
+
minOrderQuantity: number | null;
|
|
2066
|
+
/** Feature 155 — the product's current flag; order lines record their own copy at placement. */
|
|
2067
|
+
returnable: boolean;
|
|
2068
|
+
/**
|
|
2069
|
+
* Feature 163 — the global publication window, inclusive at both ends; `null` =
|
|
2070
|
+
* open on that side. Optional for good, so a record literal built without it keeps
|
|
2071
|
+
* compiling; the channel-effective window comes from `catalogProductAvailabilityPort`.
|
|
2072
|
+
*/
|
|
2073
|
+
publishFrom?: Date | null;
|
|
2074
|
+
publishUntil?: Date | null;
|
|
1771
2075
|
}
|
|
1772
2076
|
/**
|
|
1773
2077
|
* Who is asking for a product — the single input every enforcing read path
|
|
@@ -1791,6 +2095,15 @@ export interface ProductAudience {
|
|
|
1791
2095
|
readonly organizationId: string | null;
|
|
1792
2096
|
/** `true` for any caller the platform has identified; `false` for the public. */
|
|
1793
2097
|
readonly authenticated: boolean;
|
|
2098
|
+
/**
|
|
2099
|
+
* D-287 P0 — the signed-in customer account, when the caller is one. **Not a
|
|
2100
|
+
* visibility input**: `isProductVisibleTo` never reads it. It travels with
|
|
2101
|
+
* the audience because the audience is the one sanctioned answer to "who is
|
|
2102
|
+
* asking", and the price beside a product depends on the customer's own
|
|
2103
|
+
* customer group, which overrides the organisation's (feature 040 R6). Absent
|
|
2104
|
+
* for every other caller.
|
|
2105
|
+
*/
|
|
2106
|
+
readonly customerAccountId?: string | null;
|
|
1794
2107
|
}
|
|
1795
2108
|
/**
|
|
1796
2109
|
* The most restrictive audience there is. Anything it may see, every other
|
|
@@ -1973,8 +2286,6 @@ export interface CatalogProductVariantRecord {
|
|
|
1973
2286
|
parentProductId: string;
|
|
1974
2287
|
sku: string;
|
|
1975
2288
|
variantAttributeValues: Record<string, unknown>;
|
|
1976
|
-
/** Decimal string, or `null` when the variant inherits the parent's price. */
|
|
1977
|
-
priceOverride: string | null;
|
|
1978
2289
|
stockLevel: number | null;
|
|
1979
2290
|
createdAt: Date;
|
|
1980
2291
|
updatedAt: Date;
|
|
@@ -1989,6 +2300,14 @@ export interface CatalogPackagingUnitRecord {
|
|
|
1989
2300
|
isDefault: boolean;
|
|
1990
2301
|
createdAt: Date;
|
|
1991
2302
|
updatedAt: Date;
|
|
2303
|
+
/** Feature 155 — minimum units of this packaging unit per order of the product; `null` = none. */
|
|
2304
|
+
minOrderUnits: number | null;
|
|
2305
|
+
/**
|
|
2306
|
+
* Feature 163 (FR-079) — the name per language; the snapshot of a basket or quote
|
|
2307
|
+
* line takes `effectivePackagingUnitName(record, L)`. Optional so other builders of
|
|
2308
|
+
* the record keep compiling; `catalog` always sets it.
|
|
2309
|
+
*/
|
|
2310
|
+
nameTranslations?: Record<string, string>;
|
|
1992
2311
|
}
|
|
1993
2312
|
/** A directed product↔product relation (cross-sell, up-sell, related). */
|
|
1994
2313
|
export interface CatalogProductLinkRow {
|
|
@@ -1998,6 +2317,19 @@ export interface CatalogProductLinkRow {
|
|
|
1998
2317
|
kind: ProductLinkKind;
|
|
1999
2318
|
position: number;
|
|
2000
2319
|
}
|
|
2320
|
+
/**
|
|
2321
|
+
* A product as pricing resolves it ({@link CatalogProductReadPort.listPricingRefs}):
|
|
2322
|
+
* the id, and the attribute values an attribute row of a price book matches.
|
|
2323
|
+
*/
|
|
2324
|
+
export interface CatalogProductPricingRef {
|
|
2325
|
+
id: string;
|
|
2326
|
+
attributeValues: Record<string, unknown>;
|
|
2327
|
+
}
|
|
2328
|
+
/** {@link CatalogProductReadPort.listValueOverridesByProductIds}' narrowing. */
|
|
2329
|
+
export interface CatalogValueOverrideLookupOptions {
|
|
2330
|
+
/** One sales channel's rows only; absent, every channel's. */
|
|
2331
|
+
channelId?: string;
|
|
2332
|
+
}
|
|
2001
2333
|
/** A per-channel / per-language override of one attribute value (feature 022). */
|
|
2002
2334
|
export interface CatalogProductValueOverrideRecord {
|
|
2003
2335
|
id: string;
|
|
@@ -2047,6 +2379,16 @@ export interface CatalogProductReadPort {
|
|
|
2047
2379
|
countByIds(ids: readonly string[]): Promise<number>;
|
|
2048
2380
|
/** Every product, ordered by sku — the bulk export and the price-list backfill. */
|
|
2049
2381
|
listAll(options?: CatalogProductLookupOptions): Promise<CatalogProductRecord[]>;
|
|
2382
|
+
/**
|
|
2383
|
+
* Every product as pricing resolves it — its id and its own attribute values
|
|
2384
|
+
* — ordered by id: the products `listAll()` answers (soft-deleted and inactive
|
|
2385
|
+
* included), without building a record of each. The price surface's worker
|
|
2386
|
+
* reads it at the start of every whole build of a profile that may price any
|
|
2387
|
+
* product (issue #416), so it is one statement and no hydration.
|
|
2388
|
+
*/
|
|
2389
|
+
listPricingRefs(): Promise<CatalogProductPricingRef[]>;
|
|
2390
|
+
/** {@link listPricingRefs} for the given ids: the ones that exist, as `findByIds(ids)` answers them. */
|
|
2391
|
+
findPricingRefsByIds(ids: readonly string[]): Promise<CatalogProductPricingRef[]>;
|
|
2050
2392
|
/** Variants of the given parent products, ordered by sku. */
|
|
2051
2393
|
listVariantsByProductIds(productIds: readonly string[]): Promise<CatalogProductVariantRecord[]>;
|
|
2052
2394
|
findVariantsBySkus(skus: readonly string[]): Promise<CatalogProductVariantRecord[]>;
|
|
@@ -2054,10 +2396,26 @@ export interface CatalogProductReadPort {
|
|
|
2054
2396
|
findVariantInProduct(parentProductId: string, variantId: string): Promise<CatalogProductVariantRecord | null>;
|
|
2055
2397
|
/** A packaging unit, but only if it belongs to that product. */
|
|
2056
2398
|
findPackagingUnitInProduct(productId: string, packagingUnitId: string): Promise<CatalogPackagingUnitRecord | null>;
|
|
2399
|
+
/**
|
|
2400
|
+
* Feature 155 — the packaging units of the given products, ordered by product id, then
|
|
2401
|
+
* `position`, then `name`. The batch twin of `listVariantsByProductIds`. Unknown ids contribute
|
|
2402
|
+
* nothing.
|
|
2403
|
+
*
|
|
2404
|
+
* **No policy, like every method of this port: it answers for any id.** Callers MUST pass only
|
|
2405
|
+
* product ids they have already vetted — resolved through the buyer-visibility and channel checks
|
|
2406
|
+
* (`isProductVisibleTo`, the request-channel filter) or taken from a document the caller owns on the
|
|
2407
|
+
* buyer's behalf (their basket, quote request or order). Passing an id straight from a request body
|
|
2408
|
+
* turns this method into a catalogue enumeration oracle.
|
|
2409
|
+
*/
|
|
2410
|
+
listPackagingUnitsByProductIds(productIds: readonly string[]): Promise<CatalogPackagingUnitRecord[]>;
|
|
2057
2411
|
/** Links out of the given products, optionally narrowed to one kind. */
|
|
2058
2412
|
listLinksBySourceIds(sourceProductIds: readonly string[], kind?: ProductLinkKind): Promise<CatalogProductLinkRow[]>;
|
|
2059
|
-
/**
|
|
2060
|
-
|
|
2413
|
+
/**
|
|
2414
|
+
* Attribute-value overrides for the given products — every channel's, or
|
|
2415
|
+
* only `options.channelId`'s rows when it is given (issue #384: a storefront
|
|
2416
|
+
* read shows one sales channel's overrides and reads only those).
|
|
2417
|
+
*/
|
|
2418
|
+
listValueOverridesByProductIds(productIds: readonly string[], options?: CatalogValueOverrideLookupOptions): Promise<CatalogProductValueOverrideRecord[]>;
|
|
2061
2419
|
/**
|
|
2062
2420
|
* The ids of products whose own attribute value selects `value` — feature
|
|
2063
2421
|
* 148 (owner decision Q1): the price matrix selects products by attribute
|
|
@@ -2073,6 +2431,49 @@ export interface CatalogProductReadPort {
|
|
|
2073
2431
|
* consulted.
|
|
2074
2432
|
*/
|
|
2075
2433
|
listProductIdsByAttributeValue(query: CatalogAttributeValueQuery): Promise<string[]>;
|
|
2434
|
+
/**
|
|
2435
|
+
* Feature 161 (G15, `specs/161-price-book-editor/research.md` R14) — one page
|
|
2436
|
+
* of the products a caller's **membership seam** names, ordered by the stored
|
|
2437
|
+
* admin name key of the admin language (`en`, `pl`; any other reads `en`),
|
|
2438
|
+
* then SKU, then id, and how many there are. `search` narrows to the products
|
|
2439
|
+
* whose stored search key (folded shown name and SKU) or one of whose
|
|
2440
|
+
* variants' SKU contains it — case- and accent-folded, taken literally. How
|
|
2441
|
+
* `price_lists` pages a price book's product lines by label without either
|
|
2442
|
+
* module naming the other's table.
|
|
2443
|
+
*
|
|
2444
|
+
* The seam is embedded as `(p.id in (<sql>)) is true`: a hashed probe while
|
|
2445
|
+
* this module walks its own order index. It must select one uuid column.
|
|
2446
|
+
* **Structural**: soft-deleted and inactive products answer like any other.
|
|
2447
|
+
* One statement without a search (two with one: a count, then the page — by
|
|
2448
|
+
* the trigram hits when they are few, by the ordered walk when many).
|
|
2449
|
+
* `withTotal: false` skips the count of an unsearched page (`total` is then
|
|
2450
|
+
* `null`) for a caller that counts its membership itself.
|
|
2451
|
+
*/
|
|
2452
|
+
pageProductsByAdminName(query: CatalogAdminNamePageQuery): Promise<{
|
|
2453
|
+
ids: string[];
|
|
2454
|
+
total: number | null;
|
|
2455
|
+
}>;
|
|
2456
|
+
}
|
|
2457
|
+
/**
|
|
2458
|
+
* A subquery another module hands the catalogue to name a set of products
|
|
2459
|
+
* (feature 161, G15): `sql` selects one uuid column, `params` bind its `?`.
|
|
2460
|
+
* The precedent is `CustomFieldListFilterPort.condition`; the owner of the
|
|
2461
|
+
* table the subquery reads is the module that wrote it.
|
|
2462
|
+
*/
|
|
2463
|
+
export interface CatalogProductMembership {
|
|
2464
|
+
readonly sql: string;
|
|
2465
|
+
readonly params: readonly unknown[];
|
|
2466
|
+
}
|
|
2467
|
+
/** {@link CatalogProductReadPort.pageProductsByAdminName}'s query. */
|
|
2468
|
+
export interface CatalogAdminNamePageQuery {
|
|
2469
|
+
readonly membership: CatalogProductMembership;
|
|
2470
|
+
readonly search?: string | null;
|
|
2471
|
+
/** A language tag (`pl`, `pl-PL`); its primary subtag picks the key, `en` when it has none. */
|
|
2472
|
+
readonly language: string | null;
|
|
2473
|
+
readonly offset: number;
|
|
2474
|
+
readonly limit: number;
|
|
2475
|
+
/** Default `true`. Without a search, `false` skips the count. */
|
|
2476
|
+
readonly withTotal?: boolean;
|
|
2076
2477
|
}
|
|
2077
2478
|
/** {@link CatalogProductReadPort.listProductIdsByAttributeValue}'s question. */
|
|
2078
2479
|
export interface CatalogAttributeValueQuery {
|
|
@@ -2234,7 +2635,39 @@ export interface ProductImportRow {
|
|
|
2234
2635
|
/** Per-locale, merged into the stored JSONB rather than replacing it. */
|
|
2235
2636
|
name?: Record<string, string>;
|
|
2236
2637
|
description?: Record<string, string>;
|
|
2638
|
+
/**
|
|
2639
|
+
* Feature 163 (FR-092) — the status at a sales channel (`languageCode: null`) or
|
|
2640
|
+
* a sales channel × language scope, one entry per `status@…` column the file
|
|
2641
|
+
* carries. `status: null` = use inherited. A scope the file has no column for is
|
|
2642
|
+
* untouched.
|
|
2643
|
+
*/
|
|
2644
|
+
scopedStatus?: ScopedStatusCell[];
|
|
2645
|
+
}
|
|
2646
|
+
/** One `status@<channel code>[/<language>]` cell of a products file (feature 163, FR-092). */
|
|
2647
|
+
export interface ScopedStatusCell {
|
|
2648
|
+
channelCode: string;
|
|
2649
|
+
/** `null` = the channel scope. */
|
|
2650
|
+
languageCode: string | null;
|
|
2651
|
+
/** `null` = use inherited (an empty cell). */
|
|
2652
|
+
status: ProductStatus | null;
|
|
2653
|
+
}
|
|
2654
|
+
/** The scoped-status columns a products export carries, and each product's overrides in them. */
|
|
2655
|
+
export interface ScopedStatusExport {
|
|
2656
|
+
/** Every channel scope, then its channel × language scopes, in a stable order. */
|
|
2657
|
+
columns: Array<{
|
|
2658
|
+
channelCode: string;
|
|
2659
|
+
languageCode: string | null;
|
|
2660
|
+
}>;
|
|
2661
|
+
/** Product id → column name ({@link scopedStatusColumn}) → the override there. An inherited scope is absent. */
|
|
2662
|
+
values: Record<string, Record<string, ProductStatus>>;
|
|
2237
2663
|
}
|
|
2664
|
+
/** The products-file column of a scope: `status@<channel code>` or `status@<channel code>/<language>`. */
|
|
2665
|
+
export declare function scopedStatusColumn(channelCode: string, languageCode: string | null): string;
|
|
2666
|
+
/** The scope a products-file column names, or `null` when it is not a scoped-status column. */
|
|
2667
|
+
export declare function parseScopedStatusColumn(column: string): {
|
|
2668
|
+
channelCode: string;
|
|
2669
|
+
languageCode: string | null;
|
|
2670
|
+
} | null;
|
|
2238
2671
|
/**
|
|
2239
2672
|
* Container name: `catalogBulkImportPort`. Owner: `catalog`.
|
|
2240
2673
|
*
|
|
@@ -2251,6 +2684,8 @@ export interface ProductImportRow {
|
|
|
2251
2684
|
export interface CatalogBulkImportPort {
|
|
2252
2685
|
importCategories(rows: readonly CategoryImportRow[]): Promise<BulkImportReport>;
|
|
2253
2686
|
importProducts(rows: readonly ProductImportRow[]): Promise<BulkImportReport>;
|
|
2687
|
+
/** Feature 163 (FR-092) — the scoped-status columns of a products export, and their values. */
|
|
2688
|
+
exportScopedStatuses(): Promise<ScopedStatusExport>;
|
|
2254
2689
|
}
|
|
2255
2690
|
export interface CatalogAttributeOptionView {
|
|
2256
2691
|
/** `custom_field_options` id. */
|
|
@@ -2352,6 +2787,13 @@ export interface CatalogQuickSearchParams {
|
|
|
2352
2787
|
* See {@link CatalogQuickSearchPort} for what it restricts.
|
|
2353
2788
|
*/
|
|
2354
2789
|
organizationId: string;
|
|
2790
|
+
/**
|
|
2791
|
+
* Feature 163 — the request's language tag (its first `Accept-Language`
|
|
2792
|
+
* pick). Resolved against the channel's own languages by
|
|
2793
|
+
* `resolveScopeLanguage`; absent means the channel's default language. A
|
|
2794
|
+
* product switched off at (channel, that language) is not a hit.
|
|
2795
|
+
*/
|
|
2796
|
+
languageCode?: string | undefined;
|
|
2355
2797
|
}
|
|
2356
2798
|
export interface CatalogQuickSearchHit {
|
|
2357
2799
|
productId: string;
|
|
@@ -2359,6 +2801,12 @@ export interface CatalogQuickSearchHit {
|
|
|
2359
2801
|
slug: string;
|
|
2360
2802
|
/** Per-locale JSONB as stored — the caller picks its own language. */
|
|
2361
2803
|
name: Record<string, string>;
|
|
2804
|
+
/**
|
|
2805
|
+
* Feature 163 (FR-017 a) — the Name the storefront shows at the request's
|
|
2806
|
+
* (channel, language): the channel's override where one applies, else the
|
|
2807
|
+
* baseline pick. What a type-ahead should display.
|
|
2808
|
+
*/
|
|
2809
|
+
effectiveName?: string;
|
|
2362
2810
|
status: ProductStatus;
|
|
2363
2811
|
matchedOn: CatalogQuickSearchField[];
|
|
2364
2812
|
}
|
|
@@ -2685,8 +3133,12 @@ export interface CatalogGalleryPort {
|
|
|
2685
3133
|
* because both consumers render them identically (no image) and telling them
|
|
2686
3134
|
* apart would need exactly the product-existence probe that makes `list`
|
|
2687
3135
|
* unusable for a batch.
|
|
3136
|
+
*
|
|
3137
|
+
* Feature 163 (FR-076, owner decision MED-1 = A) — `channelId` is the channel the
|
|
3138
|
+
* caller serves (a feed's channel): an item hidden there is left out. `null` names no
|
|
3139
|
+
* channel and answers the global gallery.
|
|
2688
3140
|
*/
|
|
2689
|
-
listForProducts(productIds: readonly string[]): Promise<CatalogGalleryBatchItem[]>;
|
|
3141
|
+
listForProducts(productIds: readonly string[], channelId: string | null): Promise<CatalogGalleryBatchItem[]>;
|
|
2690
3142
|
/**
|
|
2691
3143
|
* The `base_image` url of each of a batch of products — `base_image` only,
|
|
2692
3144
|
* with no fallback to `thumbnail` or to the first item by position.
|
|
@@ -2702,8 +3154,13 @@ export interface CatalogGalleryPort {
|
|
|
2702
3154
|
* `gallery_items` plus the asset read port it already holds, so a consumer
|
|
2703
3155
|
* gets the url without joining `assets_library`'s table itself — which is the
|
|
2704
3156
|
* third of the three reaches this method retires (feature 075 / D-87).
|
|
3157
|
+
*
|
|
3158
|
+
* Feature 163 (FR-076, owner decision MED-1 = A) — the base image **in `channelId`**
|
|
3159
|
+
* (the request's resolved channel): the channel's own holder of the role when it has
|
|
3160
|
+
* one, else the global holder; `null` when that holder is hidden there. `null` names
|
|
3161
|
+
* no channel and answers the global holder.
|
|
2705
3162
|
*/
|
|
2706
|
-
baseImageUrls(productIds: readonly string[]): Promise<Map<string, string | null>>;
|
|
3163
|
+
baseImageUrls(productIds: readonly string[], channelId: string | null): Promise<Map<string, string | null>>;
|
|
2707
3164
|
create(productId: string, req: CreateGalleryItemRequest, options: CatalogGalleryWriteOptions): Promise<GalleryItem>;
|
|
2708
3165
|
delete(productId: string, itemId: string): Promise<void>;
|
|
2709
3166
|
reorder(productId: string, orderedIds: string[]): Promise<void>;
|
|
@@ -2930,6 +3387,19 @@ export interface CatalogSellableProductQuery {
|
|
|
2930
3387
|
afterId?: string | null;
|
|
2931
3388
|
/** Page size. Defaults to 500, the size the feed pipeline already walks in. */
|
|
2932
3389
|
limit?: number;
|
|
3390
|
+
/**
|
|
3391
|
+
* Feature 163 — where the products are sold: the feed's sales channel and
|
|
3392
|
+
* its language tag (resolved by `catalog` against the channel's own
|
|
3393
|
+
* languages; absent or unknown = the channel's default). When given, the
|
|
3394
|
+
* floor is **effective availability** there for the anonymous audience, now
|
|
3395
|
+
* (`isProductEffectivelyAvailable`: the scoped status at (channel, language),
|
|
3396
|
+
* the publication window and the channel's audience rule) instead of the
|
|
3397
|
+
* global `status` and audience columns — still not overridable by `filter`.
|
|
3398
|
+
*/
|
|
3399
|
+
scope?: {
|
|
3400
|
+
channelId: string;
|
|
3401
|
+
languageTag?: string | null | undefined;
|
|
3402
|
+
} | undefined;
|
|
2933
3403
|
}
|
|
2934
3404
|
/**
|
|
2935
3405
|
* Container name: `catalogProductFilterPort`. Owner: `catalog`.
|
|
@@ -2992,8 +3462,10 @@ export declare const ProductUpdatedEventV1Schema: z.ZodObject<{
|
|
|
2992
3462
|
}, z.core.$strict>;
|
|
2993
3463
|
export type ProductUpdatedEventV1 = z.infer<typeof ProductUpdatedEventV1Schema>;
|
|
2994
3464
|
/**
|
|
2995
|
-
* Payload of `product.archived.v1` —
|
|
2996
|
-
*
|
|
3465
|
+
* Payload of `product.archived.v1` — the product was archived by the Archive action
|
|
3466
|
+
* (feature 163, FR-019; `POST …/products/:id/archive` or bulk `fields.archived`).
|
|
3467
|
+
* Emitted after the `product.updated.v1` `['archivedAt']` of the same action. A
|
|
3468
|
+
* status write never emits it: `inactive` is plain off.
|
|
2997
3469
|
*/
|
|
2998
3470
|
export declare const ProductArchivedEventV1Schema: z.ZodObject<{
|
|
2999
3471
|
productId: z.ZodString;
|