@endora-commerce/contracts 0.109.0 → 0.111.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/accept-language.d.ts +31 -0
- package/dist/accept-language.js +64 -0
- package/dist/actor.d.ts +16 -0
- package/dist/addresses.d.ts +35 -0
- package/dist/addresses.js +8 -1
- package/dist/admin-actions.d.ts +2 -0
- package/dist/admin-actions.js +18 -0
- package/dist/admin-contributions.d.ts +99 -12
- package/dist/admin-contributions.js +36 -10
- package/dist/admin-roles.d.ts +17 -2
- package/dist/admin-users.d.ts +9 -0
- package/dist/admin.d.ts +114 -4
- package/dist/admin.js +98 -3
- package/dist/api-keys.d.ts +22 -0
- package/dist/api-keys.js +4 -0
- package/dist/assets-library.d.ts +45 -0
- package/dist/assets-library.js +20 -3
- package/dist/audit-logs.d.ts +12 -0
- package/dist/audit-logs.js +12 -0
- package/dist/auth.d.ts +9 -0
- package/dist/auth.js +9 -0
- package/dist/blog.d.ts +382 -22
- package/dist/blog.js +199 -17
- package/dist/carts.d.ts +423 -36
- package/dist/carts.js +150 -12
- package/dist/catalog.d.ts +379 -208
- package/dist/catalog.js +241 -163
- package/dist/cms-brand.d.ts +14 -14
- package/dist/cms.d.ts +71 -16
- package/dist/cms.js +15 -0
- package/dist/command-hooks.d.ts +301 -0
- package/dist/command-hooks.js +248 -0
- package/dist/common.d.ts +23 -6
- package/dist/common.js +25 -2
- package/dist/comparisons.d.ts +21 -14
- package/dist/comparisons.js +2 -1
- package/dist/credit-limits.d.ts +22 -0
- package/dist/credit-limits.js +35 -0
- package/dist/crm.d.ts +134 -78
- package/dist/crm.js +21 -5
- package/dist/custom-fields.d.ts +417 -49
- package/dist/custom-fields.js +142 -1
- package/dist/customer-accounts.d.ts +324 -22
- package/dist/customer-accounts.js +43 -0
- package/dist/customer-notifications.d.ts +143 -0
- package/dist/customer-notifications.js +41 -0
- package/dist/customers.d.ts +92 -73
- package/dist/customers.js +98 -10
- package/dist/dictionary.d.ts +53 -0
- package/dist/dictionary.js +25 -0
- package/dist/document-templates.d.ts +12 -12
- package/dist/email.d.ts +34 -0
- package/dist/email.js +6 -0
- package/dist/errors.d.ts +431 -3
- package/dist/errors.js +523 -3
- package/dist/forms-logic.d.ts +79 -0
- package/dist/forms-logic.fixtures.d.ts +52 -0
- package/dist/forms-logic.fixtures.js +610 -0
- package/dist/forms-logic.js +699 -0
- package/dist/forms.d.ts +9833 -0
- package/dist/forms.js +827 -0
- package/dist/i18n.d.ts +34 -0
- package/dist/i18n.js +15 -0
- package/dist/import-export.d.ts +180 -0
- package/dist/import-export.js +60 -0
- package/dist/index.d.ts +16 -1
- package/dist/index.js +30 -1
- package/dist/inventory.d.ts +9 -9
- package/dist/invoice-ledger.d.ts +13 -13
- package/dist/invoices.d.ts +126 -0
- package/dist/invoices.js +53 -0
- package/dist/line-bounds.d.ts +53 -0
- package/dist/line-bounds.js +65 -0
- package/dist/megamenu.d.ts +27 -27
- package/dist/mfa.d.ts +210 -4
- package/dist/mfa.js +136 -0
- package/dist/modules.d.ts +56 -8
- package/dist/modules.js +128 -3
- package/dist/money-decimal.d.ts +54 -0
- package/dist/money-decimal.js +95 -0
- package/dist/newsletter.d.ts +4 -4
- package/dist/orders.d.ts +246 -12
- package/dist/orders.js +140 -7
- package/dist/organization-hooks.d.ts +99 -0
- package/dist/organization-hooks.js +22 -0
- package/dist/organization-registry-lookup.d.ts +362 -0
- package/dist/organization-registry-lookup.js +196 -0
- package/dist/organization-roles.d.ts +341 -0
- package/dist/organization-roles.js +218 -0
- package/dist/organizations.d.ts +1074 -103
- package/dist/organizations.js +293 -28
- package/dist/page-builder-props.d.ts +56 -56
- package/dist/pim-connector.d.ts +7 -3
- package/dist/pim-connector.js +6 -2
- package/dist/pim-field-path.d.ts +5 -1
- package/dist/pim-field-path.js +37 -81
- package/dist/pim-locale-mapping.d.ts +131 -0
- package/dist/pim-locale-mapping.js +193 -0
- package/dist/price-books.d.ts +215 -63
- package/dist/price-books.js +47 -2
- package/dist/price-lists.d.ts +13 -10
- package/dist/product-feeds.d.ts +249 -100
- package/dist/product-feeds.js +46 -2
- package/dist/product-scope-model.d.ts +161 -0
- package/dist/product-scope-model.js +161 -0
- package/dist/product-scope-overrides.d.ts +0 -103
- package/dist/product-scope-overrides.js +0 -54
- package/dist/product-scoped-values.d.ts +2610 -0
- package/dist/product-scoped-values.js +425 -0
- package/dist/product-scopes.d.ts +199 -64
- package/dist/product-scopes.js +120 -23
- package/dist/product-tax-rates.d.ts +38 -0
- package/dist/product-tax-rates.js +45 -0
- package/dist/product-url-keys.d.ts +51 -45
- package/dist/product-url-keys.js +73 -39
- package/dist/product-value-resolver.d.ts +37 -60
- package/dist/product-value-resolver.js +36 -96
- package/dist/projects.d.ts +76 -28
- package/dist/projects.js +53 -9
- package/dist/promotions.d.ts +163 -11
- package/dist/promotions.js +23 -1
- package/dist/pwa.d.ts +41 -2
- package/dist/quick-order.d.ts +159 -9
- package/dist/quick-order.js +79 -4
- package/dist/quote-requests.d.ts +231 -17
- package/dist/quote-requests.js +111 -9
- package/dist/record-references.d.ts +15 -15
- package/dist/record-references.js +2 -3
- package/dist/record-rich-text.js +2 -1
- package/dist/returns.d.ts +214 -52
- package/dist/returns.js +143 -28
- package/dist/sales-channels.d.ts +34 -3
- package/dist/sales-channels.js +16 -1
- package/dist/saved-list-views.d.ts +28 -0
- package/dist/saved-list-views.js +14 -1
- package/dist/schema-extensions.d.ts +36 -0
- package/dist/schema-extensions.js +29 -0
- package/dist/scoped-write-encoding.d.ts +100 -0
- package/dist/scoped-write-encoding.js +135 -0
- package/dist/search.d.ts +18 -16
- package/dist/seo.d.ts +83 -30
- package/dist/seo.js +8 -1
- package/dist/settings.d.ts +173 -2
- package/dist/settings.js +53 -2
- package/dist/shopping-lists.d.ts +63 -4
- package/dist/shopping-lists.js +57 -3
- package/dist/storefront-cache-tags.d.ts +22 -0
- package/dist/storefront-cache-tags.js +12 -0
- package/dist/storefront-value-overrides.d.ts +18 -56
- package/dist/storefront-value-overrides.js +11 -86
- package/dist/tasks.d.ts +27 -27
- package/dist/taxes.d.ts +27 -0
- package/dist/taxes.js +4 -0
- package/dist/transactional-emails.d.ts +48 -22
- package/dist/webhooks.d.ts +75 -0
- package/dist/webhooks.js +24 -0
- package/package.json +5 -3
- package/dist/actor.d.ts.map +0 -1
- package/dist/actor.js.map +0 -1
- package/dist/addresses.d.ts.map +0 -1
- package/dist/addresses.js.map +0 -1
- package/dist/admin-actions.d.ts.map +0 -1
- package/dist/admin-actions.js.map +0 -1
- package/dist/admin-contributions.d.ts.map +0 -1
- package/dist/admin-contributions.js.map +0 -1
- package/dist/admin-feedback.d.ts.map +0 -1
- package/dist/admin-feedback.js.map +0 -1
- package/dist/admin-i18n.d.ts.map +0 -1
- package/dist/admin-i18n.js.map +0 -1
- package/dist/admin-name.d.ts.map +0 -1
- package/dist/admin-name.js.map +0 -1
- package/dist/admin-notifications.d.ts.map +0 -1
- package/dist/admin-notifications.js.map +0 -1
- package/dist/admin-preferences.d.ts.map +0 -1
- package/dist/admin-preferences.js.map +0 -1
- package/dist/admin-roles.d.ts.map +0 -1
- package/dist/admin-roles.js.map +0 -1
- package/dist/admin-search.d.ts.map +0 -1
- package/dist/admin-search.js.map +0 -1
- package/dist/admin-users.d.ts.map +0 -1
- package/dist/admin-users.js.map +0 -1
- package/dist/admin.d.ts.map +0 -1
- package/dist/admin.js.map +0 -1
- package/dist/analytics.d.ts.map +0 -1
- package/dist/analytics.js.map +0 -1
- package/dist/api-keys.d.ts.map +0 -1
- package/dist/api-keys.js.map +0 -1
- package/dist/assets-library.d.ts.map +0 -1
- package/dist/assets-library.js.map +0 -1
- package/dist/audit-logs.d.ts.map +0 -1
- package/dist/audit-logs.js.map +0 -1
- package/dist/auth.d.ts.map +0 -1
- package/dist/auth.js.map +0 -1
- package/dist/blog.d.ts.map +0 -1
- package/dist/blog.js.map +0 -1
- package/dist/capabilities.d.ts.map +0 -1
- package/dist/capabilities.js.map +0 -1
- package/dist/carts.d.ts.map +0 -1
- package/dist/carts.js.map +0 -1
- package/dist/catalog.d.ts.map +0 -1
- package/dist/catalog.js.map +0 -1
- package/dist/cms-brand.d.ts.map +0 -1
- package/dist/cms-brand.js.map +0 -1
- package/dist/cms-contact-form.d.ts.map +0 -1
- package/dist/cms-contact-form.js.map +0 -1
- package/dist/cms.d.ts.map +0 -1
- package/dist/cms.js.map +0 -1
- package/dist/common.d.ts.map +0 -1
- package/dist/common.js.map +0 -1
- package/dist/comparisons.d.ts.map +0 -1
- package/dist/comparisons.js.map +0 -1
- package/dist/credentials.d.ts.map +0 -1
- package/dist/credentials.js.map +0 -1
- package/dist/credit-limits.d.ts.map +0 -1
- package/dist/credit-limits.js.map +0 -1
- package/dist/crm-rich-text.d.ts.map +0 -1
- package/dist/crm-rich-text.js.map +0 -1
- package/dist/crm.d.ts.map +0 -1
- package/dist/crm.js.map +0 -1
- package/dist/currencies.d.ts.map +0 -1
- package/dist/currencies.js.map +0 -1
- package/dist/custom-fields.d.ts.map +0 -1
- package/dist/custom-fields.js.map +0 -1
- package/dist/customer-accounts.d.ts.map +0 -1
- package/dist/customer-accounts.js.map +0 -1
- package/dist/customers.d.ts.map +0 -1
- package/dist/customers.js.map +0 -1
- package/dist/dictionary.d.ts.map +0 -1
- package/dist/dictionary.js.map +0 -1
- package/dist/document-templates.d.ts.map +0 -1
- package/dist/document-templates.js.map +0 -1
- package/dist/document-values.d.ts.map +0 -1
- package/dist/document-values.js.map +0 -1
- package/dist/email-address.d.ts.map +0 -1
- package/dist/email-address.js.map +0 -1
- package/dist/email.d.ts.map +0 -1
- package/dist/email.js.map +0 -1
- package/dist/envelopes.d.ts.map +0 -1
- package/dist/envelopes.js.map +0 -1
- package/dist/environment-inputs.d.ts.map +0 -1
- package/dist/environment-inputs.js.map +0 -1
- package/dist/erp-connector.d.ts.map +0 -1
- package/dist/erp-connector.js.map +0 -1
- package/dist/errors.d.ts.map +0 -1
- package/dist/errors.js.map +0 -1
- package/dist/google-analytics.d.ts.map +0 -1
- package/dist/google-analytics.js.map +0 -1
- package/dist/google-tag-manager.d.ts.map +0 -1
- package/dist/google-tag-manager.js.map +0 -1
- package/dist/i18n.d.ts.map +0 -1
- package/dist/i18n.js.map +0 -1
- package/dist/import-export.d.ts.map +0 -1
- package/dist/import-export.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/inventory.d.ts.map +0 -1
- package/dist/inventory.js.map +0 -1
- package/dist/invoice-ledger.d.ts.map +0 -1
- package/dist/invoice-ledger.js.map +0 -1
- package/dist/invoices.d.ts.map +0 -1
- package/dist/invoices.js.map +0 -1
- package/dist/kernel.d.ts.map +0 -1
- package/dist/kernel.js.map +0 -1
- package/dist/languages.d.ts.map +0 -1
- package/dist/languages.js.map +0 -1
- package/dist/line-groups.d.ts.map +0 -1
- package/dist/line-groups.js.map +0 -1
- package/dist/linkedin-ads.d.ts.map +0 -1
- package/dist/linkedin-ads.js.map +0 -1
- package/dist/localized-name.d.ts.map +0 -1
- package/dist/localized-name.js.map +0 -1
- package/dist/megamenu.d.ts.map +0 -1
- package/dist/megamenu.js.map +0 -1
- package/dist/meta-ads.d.ts.map +0 -1
- package/dist/meta-ads.js.map +0 -1
- package/dist/mfa.d.ts.map +0 -1
- package/dist/mfa.js.map +0 -1
- package/dist/modules.d.ts.map +0 -1
- package/dist/modules.js.map +0 -1
- package/dist/money-decimal.d.ts.map +0 -1
- package/dist/money-decimal.js.map +0 -1
- package/dist/money-input.d.ts.map +0 -1
- package/dist/money-input.js.map +0 -1
- package/dist/newsletter.d.ts.map +0 -1
- package/dist/newsletter.js.map +0 -1
- package/dist/order-minimums.d.ts.map +0 -1
- package/dist/order-minimums.js.map +0 -1
- package/dist/orders.d.ts.map +0 -1
- package/dist/orders.js.map +0 -1
- package/dist/organizations.d.ts.map +0 -1
- package/dist/organizations.js.map +0 -1
- package/dist/page-builder-props.d.ts.map +0 -1
- package/dist/page-builder-props.js.map +0 -1
- package/dist/page-builder-values.d.ts.map +0 -1
- package/dist/page-builder-values.js.map +0 -1
- package/dist/pagination.d.ts.map +0 -1
- package/dist/pagination.js.map +0 -1
- package/dist/payment-methods.d.ts.map +0 -1
- package/dist/payment-methods.js.map +0 -1
- package/dist/payment-return-url.d.ts.map +0 -1
- package/dist/payment-return-url.js.map +0 -1
- package/dist/payments.d.ts.map +0 -1
- package/dist/payments.js.map +0 -1
- package/dist/pim-connector.d.ts.map +0 -1
- package/dist/pim-connector.js.map +0 -1
- package/dist/pim-field-path.d.ts.map +0 -1
- package/dist/pim-field-path.js.map +0 -1
- package/dist/platform-info.d.ts.map +0 -1
- package/dist/platform-info.js.map +0 -1
- package/dist/platform-language.d.ts.map +0 -1
- package/dist/platform-language.js.map +0 -1
- package/dist/price-book-decimal.d.ts.map +0 -1
- package/dist/price-book-decimal.js.map +0 -1
- package/dist/price-books.d.ts.map +0 -1
- package/dist/price-books.js.map +0 -1
- package/dist/price-lists.d.ts.map +0 -1
- package/dist/price-lists.js.map +0 -1
- package/dist/product-feeds.d.ts.map +0 -1
- package/dist/product-feeds.js.map +0 -1
- package/dist/product-scope-overrides.d.ts.map +0 -1
- package/dist/product-scope-overrides.js.map +0 -1
- package/dist/product-scopes.d.ts.map +0 -1
- package/dist/product-scopes.js.map +0 -1
- package/dist/product-summary-text.d.ts.map +0 -1
- package/dist/product-summary-text.js.map +0 -1
- package/dist/product-url-keys.d.ts.map +0 -1
- package/dist/product-url-keys.js.map +0 -1
- package/dist/product-value-resolver.d.ts.map +0 -1
- package/dist/product-value-resolver.js.map +0 -1
- package/dist/projects.d.ts.map +0 -1
- package/dist/projects.js.map +0 -1
- package/dist/promotions.d.ts.map +0 -1
- package/dist/promotions.js.map +0 -1
- package/dist/prompt-actions.d.ts.map +0 -1
- package/dist/prompt-actions.js.map +0 -1
- package/dist/pwa.d.ts.map +0 -1
- package/dist/pwa.js.map +0 -1
- package/dist/quick-order.d.ts.map +0 -1
- package/dist/quick-order.js.map +0 -1
- package/dist/quote-requests.d.ts.map +0 -1
- package/dist/quote-requests.js.map +0 -1
- package/dist/record-references.d.ts.map +0 -1
- package/dist/record-references.js.map +0 -1
- package/dist/record-rich-text.d.ts.map +0 -1
- package/dist/record-rich-text.js.map +0 -1
- package/dist/returns.d.ts.map +0 -1
- package/dist/returns.js.map +0 -1
- package/dist/sales-channels.d.ts.map +0 -1
- package/dist/sales-channels.js.map +0 -1
- package/dist/saved-list-views.d.ts.map +0 -1
- package/dist/saved-list-views.js.map +0 -1
- package/dist/scope-notice.d.ts.map +0 -1
- package/dist/scope-notice.js.map +0 -1
- package/dist/scoped-translations.d.ts +0 -48
- package/dist/scoped-translations.d.ts.map +0 -1
- package/dist/scoped-translations.js +0 -78
- package/dist/scoped-translations.js.map +0 -1
- package/dist/search.d.ts.map +0 -1
- package/dist/search.js.map +0 -1
- package/dist/seo.d.ts.map +0 -1
- package/dist/seo.js.map +0 -1
- package/dist/settings.d.ts.map +0 -1
- package/dist/settings.js.map +0 -1
- package/dist/shipments.d.ts.map +0 -1
- package/dist/shipments.js.map +0 -1
- package/dist/shipping-methods.d.ts.map +0 -1
- package/dist/shipping-methods.js.map +0 -1
- package/dist/shopping-lists.d.ts.map +0 -1
- package/dist/shopping-lists.js.map +0 -1
- package/dist/storefront-cache-tags.d.ts.map +0 -1
- package/dist/storefront-cache-tags.js.map +0 -1
- package/dist/storefront-language-path.d.ts.map +0 -1
- package/dist/storefront-language-path.js.map +0 -1
- package/dist/storefront-value-overrides.d.ts.map +0 -1
- package/dist/storefront-value-overrides.js.map +0 -1
- package/dist/tasks.d.ts.map +0 -1
- package/dist/tasks.js.map +0 -1
- package/dist/taxes.d.ts.map +0 -1
- package/dist/taxes.js.map +0 -1
- package/dist/text-normalization.d.ts.map +0 -1
- package/dist/text-normalization.js.map +0 -1
- package/dist/transactional-emails.d.ts.map +0 -1
- package/dist/transactional-emails.js.map +0 -1
- package/dist/webhooks.d.ts.map +0 -1
- package/dist/webhooks.js.map +0 -1
package/dist/carts.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
import { isoDateTimeSchema, moneySchema, uuidSchema } from './common.js';
|
|
3
|
+
import { boundedLineQuantity, lineQuantitySchema } from './line-bounds.js';
|
|
3
4
|
/**
|
|
4
5
|
* Cart + CartItem contracts. The Cart can be anonymous (cookie-held) or
|
|
5
6
|
* logged-in; `mergeAnonymousOnLogin` merges the anonymous basket into the
|
|
@@ -54,9 +55,10 @@ export const addCartItemRequestSchema = z.object({
|
|
|
54
55
|
/**
|
|
55
56
|
* Without `packagingUnitId` this is the number of base pieces. With
|
|
56
57
|
* `packagingUnitId` it is the number of packaging units, and the resulting
|
|
57
|
-
* line quantity is `unit.baseQuantity × quantity` (feature 043).
|
|
58
|
+
* line quantity is `unit.baseQuantity × quantity` (feature 043). At most
|
|
59
|
+
* `LINE_QUANTITY_MAX` (issue #351).
|
|
58
60
|
*/
|
|
59
|
-
quantity:
|
|
61
|
+
quantity: lineQuantitySchema,
|
|
60
62
|
/** Feature 043 — order by a packaging unit (e.g. a pallet) of this product. */
|
|
61
63
|
packagingUnitId: uuidSchema.optional(),
|
|
62
64
|
});
|
|
@@ -66,10 +68,15 @@ export const addCartItemRequestSchema = z.object({
|
|
|
66
68
|
// is kept as `updateCartItemRequestStrictSchema` for any caller that still
|
|
67
69
|
// needs the positive-only check.
|
|
68
70
|
export const updateCartItemRequestStrictSchema = z.object({
|
|
69
|
-
quantity:
|
|
71
|
+
quantity: lineQuantitySchema,
|
|
70
72
|
});
|
|
73
|
+
/**
|
|
74
|
+
* `0` removes the line; anything else up to `LINE_QUANTITY_MAX` (issue #351,
|
|
75
|
+
* architect ruling R3 — it stopped at 999, below what the add path accepts, so a
|
|
76
|
+
* buyer could add a line they could then not edit).
|
|
77
|
+
*/
|
|
71
78
|
export const updateCartItemRequestSchema = z.object({
|
|
72
|
-
quantity: z.number().int().min(0)
|
|
79
|
+
quantity: boundedLineQuantity(z.number().int().min(0)),
|
|
73
80
|
});
|
|
74
81
|
// ────────────────────────────────────────────────────────────────────────
|
|
75
82
|
// Feature 027 — status & approval enums (shared across surfaces)
|
|
@@ -167,6 +174,53 @@ export const cartViewLineSchema = z.object({
|
|
|
167
174
|
})
|
|
168
175
|
.nullable()
|
|
169
176
|
.optional(),
|
|
177
|
+
/**
|
|
178
|
+
* Issue #436 — the line's VAT rate as a fraction (`0.23`), resolved the way
|
|
179
|
+
* placement resolves it: the product's tax class against the Organization's
|
|
180
|
+
* VAT status and country. Answered by `GET /api/v1/cart`; absent on the
|
|
181
|
+
* line-mutation replies, and `null` when the read could not resolve it.
|
|
182
|
+
*/
|
|
183
|
+
taxRate: z.number().finite().nonnegative().nullable().optional(),
|
|
184
|
+
/**
|
|
185
|
+
* Issue #436 — the line's own gross, `round_half_up(lineTotal × (1 + taxRate))`
|
|
186
|
+
* (owner ruling of 2026-10-24). Informational: the line grosses may add up to
|
|
187
|
+
* a cent more or less than the cart's gross, which is the per-rate figure in
|
|
188
|
+
* {@link cartVatSchema}. Present and absent with `taxRate`.
|
|
189
|
+
*/
|
|
190
|
+
lineGross: moneySchema.nullable().optional(),
|
|
191
|
+
});
|
|
192
|
+
/** Issue #436 — one rate's row of the cart's VAT: two-place amounts in the cart's currency. */
|
|
193
|
+
export const cartVatRowSchema = z.object({
|
|
194
|
+
/** The rate as a fraction, `0.23`. */
|
|
195
|
+
taxRate: z.number().finite().nonnegative(),
|
|
196
|
+
/** The sum of the line nets at this rate. */
|
|
197
|
+
net: z.number().finite(),
|
|
198
|
+
/** `round_half_up(net × taxRate)`, once per rate. */
|
|
199
|
+
vat: z.number().finite(),
|
|
200
|
+
/** `net + vat`. */
|
|
201
|
+
gross: z.number().finite(),
|
|
202
|
+
});
|
|
203
|
+
/**
|
|
204
|
+
* Issue #436 — the cart's VAT under the one VAT method (owner ruling of
|
|
205
|
+
* 2026-10-24): per rate, on the sum of the line nets at that rate, rounded
|
|
206
|
+
* half-up once; gross = net + VAT. The same computation the order makes at
|
|
207
|
+
* placement, for the same lines and rates, so the cart's gross is the order's
|
|
208
|
+
* before the checkout's delivery and payment charges, which the order adds
|
|
209
|
+
* untaxed. A client renders these figures and does not compute VAT itself.
|
|
210
|
+
*/
|
|
211
|
+
export const cartVatSchema = z.object({
|
|
212
|
+
currency: z.string().length(3),
|
|
213
|
+
/** One row per rate, ascending. */
|
|
214
|
+
rows: z.array(cartVatRowSchema),
|
|
215
|
+
/** The sum of the rows' VAT. */
|
|
216
|
+
vatTotal: z.number().finite(),
|
|
217
|
+
/** `subtotal + vatTotal`. */
|
|
218
|
+
subtotalGross: z.number().finite(),
|
|
219
|
+
/**
|
|
220
|
+
* `subtotalGross − discount`, never below zero: the discount comes off the
|
|
221
|
+
* gross, untaxed, as it does on the order.
|
|
222
|
+
*/
|
|
223
|
+
grandTotalGross: z.number().finite(),
|
|
170
224
|
});
|
|
171
225
|
export const cartMiniLineSchema = z.object({
|
|
172
226
|
id: uuidSchema,
|
|
@@ -211,6 +265,38 @@ const couponDroppedThisReadSchema = z
|
|
|
211
265
|
reason: couponDropReasonSchema,
|
|
212
266
|
})
|
|
213
267
|
.nullable();
|
|
268
|
+
/**
|
|
269
|
+
* Issue #650 — the rejection of the buyer's previous basket on this channel.
|
|
270
|
+
*
|
|
271
|
+
* A rejection closes the basket it rejects (`status = 'rejected'`), so the
|
|
272
|
+
* buyer's next cart read is a new active basket whose own `approvalStatus` is
|
|
273
|
+
* `not_required` and can never say `rejected_by_org_admin`. Without this the
|
|
274
|
+
* buyer was never told. It is answered while (a) the buyer has a rejected
|
|
275
|
+
* basket on the channel — the most recent one is answered — and
|
|
276
|
+
* (b) the current basket has not been sent for approval since. A basket
|
|
277
|
+
* ordered or converted to a quote request after the rejection ends it too.
|
|
278
|
+
* `null` otherwise, and always `null` for an anonymous basket.
|
|
279
|
+
*/
|
|
280
|
+
export const cartPreviousRejectionSchema = z.object({
|
|
281
|
+
/** The rejected basket. */
|
|
282
|
+
cartId: uuidSchema,
|
|
283
|
+
rejectedAt: isoDateTimeSchema,
|
|
284
|
+
/** The reason the administrator gave; `null` only for a row stored without one. */
|
|
285
|
+
reason: z.string().nullable(),
|
|
286
|
+
/**
|
|
287
|
+
* Issue #755 — how many of the rejected basket's lines were restored into
|
|
288
|
+
* the basket answered. The basket opened after a rejection starts with them,
|
|
289
|
+
* once; `0` when nothing was restored into this basket (it already existed,
|
|
290
|
+
* the buyer may not create baskets, or nothing could be added).
|
|
291
|
+
*/
|
|
292
|
+
restoredLineCount: z.number().int().nonnegative().default(0),
|
|
293
|
+
/**
|
|
294
|
+
* Issue #755 — the rejected basket's lines the restore skipped, because they
|
|
295
|
+
* can no longer be bought here, with the reason. `[]` when none was skipped
|
|
296
|
+
* or nothing was restored.
|
|
297
|
+
*/
|
|
298
|
+
skippedLines: z.array(cartDroppedLineSchema).default([]),
|
|
299
|
+
});
|
|
214
300
|
export const cartFullPayloadSchema = z.object({
|
|
215
301
|
id: uuidSchema.nullable(),
|
|
216
302
|
customerAccountId: uuidSchema.nullable(),
|
|
@@ -237,6 +323,17 @@ export const cartFullPayloadSchema = z.object({
|
|
|
237
323
|
createdAt: isoDateTimeSchema.nullable(),
|
|
238
324
|
updatedAt: isoDateTimeSchema.nullable(),
|
|
239
325
|
lastActivityAt: isoDateTimeSchema.nullable(),
|
|
326
|
+
/**
|
|
327
|
+
* Issue #650 — see {@link cartPreviousRejectionSchema}. Additive: a reply
|
|
328
|
+
* without the key parses as `null`.
|
|
329
|
+
*/
|
|
330
|
+
previousRejection: cartPreviousRejectionSchema.nullable().default(null),
|
|
331
|
+
/**
|
|
332
|
+
* Issue #436 — see {@link cartVatSchema}. Answered by `GET /api/v1/cart`;
|
|
333
|
+
* `null` on the empty basket, on the line-mutation replies and when the read
|
|
334
|
+
* could not resolve a rate. Additive: a reply without the key parses as `null`.
|
|
335
|
+
*/
|
|
336
|
+
vat: cartVatSchema.nullable().default(null),
|
|
240
337
|
});
|
|
241
338
|
export const cartFullResponseSchema = z.object({ data: cartFullPayloadSchema });
|
|
242
339
|
/**
|
|
@@ -336,7 +433,18 @@ export const cartFromShoppingListResponseSchema = z.object({
|
|
|
336
433
|
export const orgCartSummarySchema = z.object({
|
|
337
434
|
id: uuidSchema,
|
|
338
435
|
ownerCustomerAccountId: uuidSchema,
|
|
436
|
+
/**
|
|
437
|
+
* The owner as the members page names a member: first and last name, else
|
|
438
|
+
* the e-mail, else the account id (issue #751; it was the e-mail alone).
|
|
439
|
+
*/
|
|
339
440
|
ownerDisplayName: z.string(),
|
|
441
|
+
/** The owner's e-mail, shown beside the name; `null` when the account is gone (issue #751). */
|
|
442
|
+
ownerEmail: z.string().nullable(),
|
|
443
|
+
/**
|
|
444
|
+
* The order a completed cart produced (`carts.completed_order_id`); `null` for
|
|
445
|
+
* any other cart, and for a completed one no order emptied (issue #751).
|
|
446
|
+
*/
|
|
447
|
+
orderId: uuidSchema.nullable(),
|
|
340
448
|
status: cartStatusSchema,
|
|
341
449
|
approvalStatus: cartApprovalStatusSchema,
|
|
342
450
|
itemCount: z.number().int().nonnegative(),
|
|
@@ -361,22 +469,52 @@ export const cartAuditFeedEntrySchema = z.object({
|
|
|
361
469
|
toState: z.string().nullable(),
|
|
362
470
|
reason: z.string().nullable(),
|
|
363
471
|
});
|
|
472
|
+
/**
|
|
473
|
+
* @deprecated Since issue #657 — not the shape of `GET
|
|
474
|
+
* /api/v1/organization/carts/:id`, and never was: the route has never answered
|
|
475
|
+
* `cartFullPayloadSchema`'s fields or `auditEntries`, so a real reply fails
|
|
476
|
+
* this schema. Use {@link orgCartDetailViewSchema}, which the route is typed
|
|
477
|
+
* against. Kept, unchanged, until the next breaking-change release removes it.
|
|
478
|
+
*/
|
|
364
479
|
export const orgCartDetailPayloadSchema = cartFullPayloadSchema.extend({
|
|
365
480
|
ownerCustomerAccountId: uuidSchema,
|
|
366
481
|
ownerDisplayName: z.string(),
|
|
367
482
|
auditEntries: z.array(cartAuditFeedEntrySchema),
|
|
368
483
|
});
|
|
484
|
+
/** @deprecated Since issue #657 — use {@link orgCartDetailViewResponseSchema}. */
|
|
369
485
|
export const orgCartDetailResponseSchema = z.object({ data: orgCartDetailPayloadSchema });
|
|
370
|
-
|
|
371
|
-
|
|
486
|
+
/**
|
|
487
|
+
* Issue #650 — one line of {@link orgCartDetailViewSchema}: what the
|
|
488
|
+
* administrator is approving, at the price stored on the line.
|
|
489
|
+
*/
|
|
490
|
+
export const orgCartDetailLineSchema = z.object({
|
|
491
|
+
id: uuidSchema,
|
|
492
|
+
productId: uuidSchema,
|
|
493
|
+
variantId: uuidSchema.nullable(),
|
|
494
|
+
/** The product's name in the response language, the packaging unit appended; `null` when the product is gone. */
|
|
495
|
+
displayName: z.string().nullable(),
|
|
496
|
+
productSku: z.string().nullable(),
|
|
497
|
+
quantity: z.number().int().positive(),
|
|
498
|
+
unitPrice: moneySchema,
|
|
499
|
+
lineTotal: moneySchema,
|
|
372
500
|
});
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
501
|
+
/**
|
|
502
|
+
* `GET /api/v1/organization/carts/:id` — the Organization administrator's view
|
|
503
|
+
* of one cart, as the route answers it (issue #650 added `items`).
|
|
504
|
+
*
|
|
505
|
+
* {@link orgCartDetailPayloadSchema} above is not this route's shape and never
|
|
506
|
+
* was: the route has answered the summary fields plus the approval timestamps
|
|
507
|
+
* since feature 027. It is left as published rather than changed under its
|
|
508
|
+
* consumers, and deprecated since issue #657.
|
|
509
|
+
*/
|
|
510
|
+
export const orgCartDetailViewSchema = orgCartSummarySchema.extend({
|
|
511
|
+
ownerCustomerAccountId: uuidSchema.nullable(),
|
|
512
|
+
approvedAt: isoDateTimeSchema.nullable(),
|
|
513
|
+
rejectedAt: isoDateTimeSchema.nullable(),
|
|
514
|
+
rejectedReason: z.string().nullable(),
|
|
515
|
+
items: z.array(orgCartDetailLineSchema),
|
|
379
516
|
});
|
|
517
|
+
export const orgCartDetailViewResponseSchema = z.object({ data: orgCartDetailViewSchema });
|
|
380
518
|
export const rejectOrgCartSchema = z.object({
|
|
381
519
|
reason: z.string().min(1).max(2000),
|
|
382
520
|
});
|