@endora-commerce/contracts 0.106.0 → 0.108.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-contributions.d.ts +11 -6
- package/dist/admin-contributions.d.ts.map +1 -1
- package/dist/admin-contributions.js +9 -6
- 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-roles.d.ts +32 -2
- package/dist/admin-roles.d.ts.map +1 -1
- package/dist/admin-roles.js +21 -1
- package/dist/admin-roles.js.map +1 -1
- package/dist/admin-search.d.ts +655 -0
- package/dist/admin-search.d.ts.map +1 -0
- package/dist/admin-search.js +179 -0
- package/dist/admin-search.js.map +1 -0
- package/dist/analytics.d.ts +5 -0
- package/dist/analytics.d.ts.map +1 -1
- package/dist/analytics.js +8 -0
- package/dist/analytics.js.map +1 -1
- package/dist/api-keys.d.ts +6 -0
- package/dist/api-keys.d.ts.map +1 -1
- package/dist/api-keys.js +5 -0
- package/dist/api-keys.js.map +1 -1
- package/dist/assets-library.d.ts +102 -0
- package/dist/assets-library.d.ts.map +1 -1
- package/dist/assets-library.js +89 -0
- package/dist/assets-library.js.map +1 -1
- package/dist/auth.d.ts +20 -0
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +20 -0
- package/dist/auth.js.map +1 -1
- package/dist/blog.d.ts +1 -1
- package/dist/carts.d.ts +218 -7
- package/dist/carts.d.ts.map +1 -1
- package/dist/carts.js +29 -0
- package/dist/carts.js.map +1 -1
- package/dist/catalog.d.ts +299 -14
- package/dist/catalog.d.ts.map +1 -1
- package/dist/catalog.js +136 -2
- package/dist/catalog.js.map +1 -1
- package/dist/cms.d.ts +183 -3
- package/dist/cms.d.ts.map +1 -1
- package/dist/cms.js +132 -1
- 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 +80 -0
- package/dist/comparisons.d.ts.map +1 -1
- package/dist/comparisons.js +24 -0
- package/dist/comparisons.js.map +1 -1
- package/dist/credentials.d.ts +23 -0
- package/dist/credentials.d.ts.map +1 -1
- package/dist/credentials.js +24 -0
- package/dist/credentials.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 +64 -0
- package/dist/crm-rich-text.d.ts.map +1 -0
- package/dist/crm-rich-text.js +303 -0
- package/dist/crm-rich-text.js.map +1 -0
- package/dist/crm.d.ts +92 -2
- package/dist/crm.d.ts.map +1 -1
- package/dist/crm.js +49 -34
- package/dist/crm.js.map +1 -1
- package/dist/custom-fields.d.ts +417 -4
- package/dist/custom-fields.d.ts.map +1 -1
- package/dist/custom-fields.js +319 -10
- package/dist/custom-fields.js.map +1 -1
- package/dist/customer-accounts.d.ts +92 -2
- package/dist/customer-accounts.d.ts.map +1 -1
- package/dist/document-templates.d.ts +1368 -0
- package/dist/document-templates.d.ts.map +1 -0
- package/dist/document-templates.js +569 -0
- package/dist/document-templates.js.map +1 -0
- package/dist/document-values.d.ts +159 -0
- package/dist/document-values.d.ts.map +1 -0
- package/dist/document-values.js +220 -0
- package/dist/document-values.js.map +1 -0
- package/dist/errors.d.ts +122 -0
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +172 -0
- package/dist/errors.js.map +1 -1
- package/dist/import-export.d.ts +11 -0
- package/dist/import-export.d.ts.map +1 -1
- package/dist/import-export.js +9 -0
- package/dist/import-export.js.map +1 -1
- package/dist/index.d.ts +15 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +28 -1
- package/dist/index.js.map +1 -1
- package/dist/invoice-ledger.d.ts +6 -6
- package/dist/invoices.d.ts +88 -0
- package/dist/invoices.d.ts.map +1 -1
- package/dist/invoices.js +19 -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/mfa.d.ts +20 -0
- package/dist/mfa.d.ts.map +1 -1
- package/dist/modules.d.ts +20 -10
- package/dist/modules.d.ts.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 +2 -0
- package/dist/newsletter.d.ts.map +1 -1
- package/dist/newsletter.js +4 -0
- package/dist/newsletter.js.map +1 -1
- 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 +212 -2
- package/dist/orders.d.ts.map +1 -1
- package/dist/orders.js +124 -21
- package/dist/orders.js.map +1 -1
- package/dist/organizations.d.ts +78 -0
- package/dist/organizations.d.ts.map +1 -1
- package/dist/organizations.js +54 -0
- package/dist/organizations.js.map +1 -1
- package/dist/payment-methods.d.ts +2 -2
- 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/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 +398 -248
- package/dist/price-lists.d.ts.map +1 -1
- package/dist/price-lists.js +136 -244
- package/dist/price-lists.js.map +1 -1
- package/dist/product-feeds.d.ts +102 -21
- package/dist/product-feeds.d.ts.map +1 -1
- package/dist/product-feeds.js +18 -1
- package/dist/product-feeds.js.map +1 -1
- 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/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 +25 -6
- package/dist/prompt-actions.d.ts.map +1 -1
- package/dist/prompt-actions.js +17 -1
- package/dist/prompt-actions.js.map +1 -1
- package/dist/pwa.d.ts +25 -0
- package/dist/pwa.d.ts.map +1 -1
- package/dist/pwa.js +38 -0
- package/dist/pwa.js.map +1 -1
- package/dist/quick-order.d.ts +39 -0
- package/dist/quick-order.d.ts.map +1 -1
- package/dist/quick-order.js +43 -0
- package/dist/quick-order.js.map +1 -1
- package/dist/quote-requests.d.ts +903 -9
- package/dist/quote-requests.d.ts.map +1 -1
- package/dist/quote-requests.js +515 -8
- package/dist/quote-requests.js.map +1 -1
- package/dist/returns.d.ts +55 -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 +48 -0
- package/dist/sales-channels.d.ts.map +1 -1
- package/dist/sales-channels.js +42 -0
- package/dist/sales-channels.js.map +1 -1
- package/dist/saved-list-views.d.ts +140 -0
- package/dist/saved-list-views.d.ts.map +1 -0
- package/dist/saved-list-views.js +108 -0
- package/dist/saved-list-views.js.map +1 -0
- package/dist/search.d.ts +66 -0
- 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 +2 -0
- package/dist/seo.d.ts.map +1 -1
- package/dist/seo.js +11 -0
- package/dist/seo.js.map +1 -1
- package/dist/shipping-methods.d.ts +2 -2
- 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-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/package.json +1 -1
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Typed values of a document's lines, and the pure functions that format them,
|
|
4
|
+
* decide whether one is there, evaluate a visibility rule over them and sum
|
|
5
|
+
* them (`specs/153-quote-request-pdf-template/research.md` R-5, R-6;
|
|
6
|
+
* `contracts/document-collections.md` §3.4).
|
|
7
|
+
*
|
|
8
|
+
* They live here, in the one dependency-free package both the backend renderer
|
|
9
|
+
* and the admin editor canvas import, so the canvas shows exactly what the PDF
|
|
10
|
+
* prints (FR-036) and a later repeater block evaluates the same rules over the
|
|
11
|
+
* same item scope (owner decision D3, FR-044).
|
|
12
|
+
*/
|
|
13
|
+
/**
|
|
14
|
+
* A line field's key: a plain key (`sku`, `lineNet`) or one family segment
|
|
15
|
+
* (`attributes.colour`). Never more than one dot, so a later item-level
|
|
16
|
+
* placeholder `{{item.<path>}}` stays unambiguous.
|
|
17
|
+
*/
|
|
18
|
+
export declare const documentFieldPathRe: RegExp;
|
|
19
|
+
/**
|
|
20
|
+
* Families a host may not declare: `row` is the facility's (`row.number`, the
|
|
21
|
+
* position it adds to every collection) and `item` is reserved for the
|
|
22
|
+
* repeater's placeholders (research R-23).
|
|
23
|
+
*/
|
|
24
|
+
export declare const RESERVED_FIELD_FAMILIES: readonly ["row", "item"];
|
|
25
|
+
/** The facility's own field, prepended to every collection's catalogue. */
|
|
26
|
+
export declare const DOCUMENT_POSITION_FIELD = "row.number";
|
|
27
|
+
export declare function isReservedFieldPath(path: string): boolean;
|
|
28
|
+
export declare const documentValueKindSchema: z.ZodEnum<{
|
|
29
|
+
number: "number";
|
|
30
|
+
date: "date";
|
|
31
|
+
text: "text";
|
|
32
|
+
percent: "percent";
|
|
33
|
+
money: "money";
|
|
34
|
+
}>;
|
|
35
|
+
export type DocumentValueKind = z.infer<typeof documentValueKindSchema>;
|
|
36
|
+
export declare const documentValueSchema: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
37
|
+
kind: z.ZodLiteral<"text">;
|
|
38
|
+
value: z.ZodString;
|
|
39
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
40
|
+
kind: z.ZodLiteral<"number">;
|
|
41
|
+
value: z.ZodNumber;
|
|
42
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
43
|
+
kind: z.ZodLiteral<"money">;
|
|
44
|
+
amount: z.ZodNumber;
|
|
45
|
+
currency: z.ZodString;
|
|
46
|
+
unitPrice: z.ZodOptional<z.ZodBoolean>;
|
|
47
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
48
|
+
kind: z.ZodLiteral<"percent">;
|
|
49
|
+
value: z.ZodNumber;
|
|
50
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
51
|
+
kind: z.ZodLiteral<"date">;
|
|
52
|
+
value: z.ZodString;
|
|
53
|
+
}, z.core.$strip>], "kind">>;
|
|
54
|
+
export type DocumentValue = {
|
|
55
|
+
readonly kind: 'text';
|
|
56
|
+
readonly value: string;
|
|
57
|
+
} | {
|
|
58
|
+
readonly kind: 'number';
|
|
59
|
+
readonly value: number;
|
|
60
|
+
} | {
|
|
61
|
+
readonly kind: 'money';
|
|
62
|
+
readonly amount: number;
|
|
63
|
+
readonly currency: string;
|
|
64
|
+
readonly unitPrice?: boolean;
|
|
65
|
+
} | {
|
|
66
|
+
readonly kind: 'percent';
|
|
67
|
+
readonly value: number;
|
|
68
|
+
} | {
|
|
69
|
+
readonly kind: 'date';
|
|
70
|
+
readonly value: string;
|
|
71
|
+
} | null;
|
|
72
|
+
export declare const documentValueFormatSchema: z.ZodObject<{
|
|
73
|
+
decimals: z.ZodOptional<z.ZodNumber>;
|
|
74
|
+
currencyDisplay: z.ZodOptional<z.ZodEnum<{
|
|
75
|
+
symbol: "symbol";
|
|
76
|
+
code: "code";
|
|
77
|
+
none: "none";
|
|
78
|
+
}>>;
|
|
79
|
+
dateStyle: z.ZodOptional<z.ZodEnum<{
|
|
80
|
+
medium: "medium";
|
|
81
|
+
short: "short";
|
|
82
|
+
long: "long";
|
|
83
|
+
}>>;
|
|
84
|
+
}, z.core.$strip>;
|
|
85
|
+
export interface DocumentValueFormat {
|
|
86
|
+
readonly decimals?: number;
|
|
87
|
+
readonly currencyDisplay?: 'symbol' | 'code' | 'none';
|
|
88
|
+
readonly dateStyle?: 'short' | 'medium' | 'long';
|
|
89
|
+
}
|
|
90
|
+
export type DocumentAlign = 'left' | 'center' | 'right';
|
|
91
|
+
/** One line of a collection: its values by field path. */
|
|
92
|
+
export interface DocumentItem {
|
|
93
|
+
readonly values: Readonly<Record<string, DocumentValue>>;
|
|
94
|
+
}
|
|
95
|
+
export declare const documentItemSchema: z.ZodObject<{
|
|
96
|
+
values: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
97
|
+
kind: z.ZodLiteral<"text">;
|
|
98
|
+
value: z.ZodString;
|
|
99
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
100
|
+
kind: z.ZodLiteral<"number">;
|
|
101
|
+
value: z.ZodNumber;
|
|
102
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
103
|
+
kind: z.ZodLiteral<"money">;
|
|
104
|
+
amount: z.ZodNumber;
|
|
105
|
+
currency: z.ZodString;
|
|
106
|
+
unitPrice: z.ZodOptional<z.ZodBoolean>;
|
|
107
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
108
|
+
kind: z.ZodLiteral<"percent">;
|
|
109
|
+
value: z.ZodNumber;
|
|
110
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
111
|
+
kind: z.ZodLiteral<"date">;
|
|
112
|
+
value: z.ZodString;
|
|
113
|
+
}, z.core.$strip>], "kind">>>;
|
|
114
|
+
}, z.core.$strip>;
|
|
115
|
+
/**
|
|
116
|
+
* A visibility rule, evaluated over a scope. `field` omitted means "the field
|
|
117
|
+
* of the column, entry or row carrying the rule". Data rather than an enum so
|
|
118
|
+
* later operators (`equals`, `all_of`, …) are additions, not a migration
|
|
119
|
+
* (research R-6).
|
|
120
|
+
*/
|
|
121
|
+
export type DocumentCondition = {
|
|
122
|
+
readonly op: 'always';
|
|
123
|
+
} | {
|
|
124
|
+
readonly op: 'never';
|
|
125
|
+
} | {
|
|
126
|
+
readonly op: 'has_value';
|
|
127
|
+
readonly field?: string;
|
|
128
|
+
} | {
|
|
129
|
+
readonly op: 'any_has_value';
|
|
130
|
+
readonly field?: string;
|
|
131
|
+
};
|
|
132
|
+
/** What a rule is evaluated over: every item, one item, or the totals. */
|
|
133
|
+
export interface DocumentConditionScope {
|
|
134
|
+
readonly items?: readonly DocumentItem[];
|
|
135
|
+
readonly item?: DocumentItem;
|
|
136
|
+
readonly summary?: Readonly<Record<string, DocumentValue>>;
|
|
137
|
+
}
|
|
138
|
+
/** `null`, a missing value and blank text have none; every number has one, `0` included. */
|
|
139
|
+
export declare function documentValueHasValue(value: DocumentValue | undefined): boolean;
|
|
140
|
+
/**
|
|
141
|
+
* A value as printed in `language`. No value prints `''`; anything Intl cannot
|
|
142
|
+
* format prints the raw value rather than failing the document.
|
|
143
|
+
*/
|
|
144
|
+
export declare function formatDocumentValue(value: DocumentValue | undefined, format: DocumentValueFormat | undefined, language: string): string;
|
|
145
|
+
/**
|
|
146
|
+
* Whether a rule holds over a scope. An unreadable rule — stored by an older
|
|
147
|
+
* editor, pasted, hand-edited — reads as `always`, the facility's hostile-props
|
|
148
|
+
* rule: a column never vanishes because its rule could not be read.
|
|
149
|
+
*/
|
|
150
|
+
export declare function evaluateDocumentCondition(condition: unknown, scope: DocumentConditionScope, defaultField: string): boolean;
|
|
151
|
+
/**
|
|
152
|
+
* The sum of the values that have one: numbers, or money of one currency
|
|
153
|
+
* rounded to the minor unit. Mixed kinds or currencies — and nothing to sum —
|
|
154
|
+
* answer no value rather than a misleading total.
|
|
155
|
+
*/
|
|
156
|
+
export declare function sumDocumentValues(values: readonly (DocumentValue | undefined)[]): DocumentValue;
|
|
157
|
+
/** An explicit alignment, else the field's default, else right for numeric kinds and left otherwise. */
|
|
158
|
+
export declare function resolveDocumentAlign(align: 'auto' | DocumentAlign | undefined, fieldDefault: DocumentAlign | undefined, kind: DocumentValueKind | undefined): DocumentAlign;
|
|
159
|
+
//# sourceMappingURL=document-values.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"document-values.d.ts","sourceRoot":"","sources":["../src/document-values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;;;;GAUG;AAMH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,QAAiD,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,0BAA2B,CAAC;AAEhE,2EAA2E;AAC3E,eAAO,MAAM,uBAAuB,eAAe,CAAC;AAEpD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGzD;AAMD,eAAO,MAAM,uBAAuB;;;;;;EAAyD,CAAC;AAC9F,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;4BAgBnB,CAAC;AAEd,MAAM,MAAM,aAAa,GACrB;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACjD;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,GAC5G;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACpD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACjD,IAAI,CAAC;AAET,eAAO,MAAM,yBAAyB;;;;;;;;;;;;iBAIpC,CAAC;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IACtD,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;CAClD;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAExD,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;CAC1D;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;iBAAkE,CAAC;AAMlG;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GACzB;IAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAA;CAAE,GACzB;IAAE,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAA;CAAE,GACxB;IAAE,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACrD;IAAE,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9D,0EAA0E;AAC1E,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IACzC,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;CAC5D;AAMD,4FAA4F;AAC5F,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAc/E;AAyBD;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,aAAa,GAAG,SAAS,EAChC,MAAM,EAAE,mBAAmB,GAAG,SAAS,EACvC,QAAQ,EAAE,MAAM,GACf,MAAM,CA+CR;AAQD;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,OAAO,EAClB,KAAK,EAAE,sBAAsB,EAC7B,YAAY,EAAE,MAAM,GACnB,OAAO,CAiBT;AAID;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE,GAAG,aAAa,CAgB/F;AAED,wGAAwG;AACxG,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,EACzC,YAAY,EAAE,aAAa,GAAG,SAAS,EACvC,IAAI,EAAE,iBAAiB,GAAG,SAAS,GAClC,aAAa,CAIf"}
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { unitPriceFractionDigits } from './money-decimal.js';
|
|
3
|
+
/**
|
|
4
|
+
* Typed values of a document's lines, and the pure functions that format them,
|
|
5
|
+
* decide whether one is there, evaluate a visibility rule over them and sum
|
|
6
|
+
* them (`specs/153-quote-request-pdf-template/research.md` R-5, R-6;
|
|
7
|
+
* `contracts/document-collections.md` §3.4).
|
|
8
|
+
*
|
|
9
|
+
* They live here, in the one dependency-free package both the backend renderer
|
|
10
|
+
* and the admin editor canvas import, so the canvas shows exactly what the PDF
|
|
11
|
+
* prints (FR-036) and a later repeater block evaluates the same rules over the
|
|
12
|
+
* same item scope (owner decision D3, FR-044).
|
|
13
|
+
*/
|
|
14
|
+
// ---------------------------------------------------------------------------
|
|
15
|
+
// Field paths
|
|
16
|
+
// ---------------------------------------------------------------------------
|
|
17
|
+
/**
|
|
18
|
+
* A line field's key: a plain key (`sku`, `lineNet`) or one family segment
|
|
19
|
+
* (`attributes.colour`). Never more than one dot, so a later item-level
|
|
20
|
+
* placeholder `{{item.<path>}}` stays unambiguous.
|
|
21
|
+
*/
|
|
22
|
+
export const documentFieldPathRe = /^[a-z][A-Za-z0-9]*(\.[A-Za-z0-9_-]{1,100})?$/;
|
|
23
|
+
/**
|
|
24
|
+
* Families a host may not declare: `row` is the facility's (`row.number`, the
|
|
25
|
+
* position it adds to every collection) and `item` is reserved for the
|
|
26
|
+
* repeater's placeholders (research R-23).
|
|
27
|
+
*/
|
|
28
|
+
export const RESERVED_FIELD_FAMILIES = ['row', 'item'];
|
|
29
|
+
/** The facility's own field, prepended to every collection's catalogue. */
|
|
30
|
+
export const DOCUMENT_POSITION_FIELD = 'row.number';
|
|
31
|
+
export function isReservedFieldPath(path) {
|
|
32
|
+
const family = path.split('.')[0] ?? '';
|
|
33
|
+
return RESERVED_FIELD_FAMILIES.includes(family);
|
|
34
|
+
}
|
|
35
|
+
// ---------------------------------------------------------------------------
|
|
36
|
+
// Values
|
|
37
|
+
// ---------------------------------------------------------------------------
|
|
38
|
+
export const documentValueKindSchema = z.enum(['text', 'number', 'money', 'percent', 'date']);
|
|
39
|
+
export const documentValueSchema = z
|
|
40
|
+
.discriminatedUnion('kind', [
|
|
41
|
+
z.object({ kind: z.literal('text'), value: z.string() }),
|
|
42
|
+
z.object({ kind: z.literal('number'), value: z.number() }),
|
|
43
|
+
/**
|
|
44
|
+
* `unitPrice` marks a **unit price** (owner ruling of 2026-10-25): it is
|
|
45
|
+
* carried at four places and shown with its significant places, up to
|
|
46
|
+
* four, never fewer than the format's `decimals` (`unitPriceFractionDigits`).
|
|
47
|
+
* A line value or a total is an amount and has no mark.
|
|
48
|
+
*/
|
|
49
|
+
z.object({ kind: z.literal('money'), amount: z.number(), currency: z.string(), unitPrice: z.boolean().optional() }),
|
|
50
|
+
/** `12.5` means 12.5 %. */
|
|
51
|
+
z.object({ kind: z.literal('percent'), value: z.number() }),
|
|
52
|
+
/** An ISO date (`2026-10-17`) or date-time. */
|
|
53
|
+
z.object({ kind: z.literal('date'), value: z.string() }),
|
|
54
|
+
])
|
|
55
|
+
.nullable();
|
|
56
|
+
export const documentValueFormatSchema = z.object({
|
|
57
|
+
decimals: z.number().int().min(0).max(4).optional(),
|
|
58
|
+
currencyDisplay: z.enum(['symbol', 'code', 'none']).optional(),
|
|
59
|
+
dateStyle: z.enum(['short', 'medium', 'long']).optional(),
|
|
60
|
+
});
|
|
61
|
+
export const documentItemSchema = z.object({ values: z.record(z.string(), documentValueSchema) });
|
|
62
|
+
// ---------------------------------------------------------------------------
|
|
63
|
+
// The pure functions
|
|
64
|
+
// ---------------------------------------------------------------------------
|
|
65
|
+
/** `null`, a missing value and blank text have none; every number has one, `0` included. */
|
|
66
|
+
export function documentValueHasValue(value) {
|
|
67
|
+
if (value === null || value === undefined || typeof value !== 'object')
|
|
68
|
+
return false;
|
|
69
|
+
switch (value.kind) {
|
|
70
|
+
case 'text':
|
|
71
|
+
case 'date':
|
|
72
|
+
return typeof value.value === 'string' && value.value.trim() !== '';
|
|
73
|
+
case 'number':
|
|
74
|
+
case 'percent':
|
|
75
|
+
return typeof value.value === 'number' && Number.isFinite(value.value);
|
|
76
|
+
case 'money':
|
|
77
|
+
return typeof value.amount === 'number' && Number.isFinite(value.amount);
|
|
78
|
+
default:
|
|
79
|
+
return false;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
function decimalsFor(value, format, fallback) {
|
|
83
|
+
const wanted = format.decimals;
|
|
84
|
+
if (typeof wanted === 'number' && Number.isInteger(wanted) && wanted >= 0 && wanted <= 4)
|
|
85
|
+
return wanted;
|
|
86
|
+
return Number.isInteger(value) ? 0 : fallback;
|
|
87
|
+
}
|
|
88
|
+
function plainNumber(value, decimals, language) {
|
|
89
|
+
return plainNumberRange(value, decimals, decimals, language);
|
|
90
|
+
}
|
|
91
|
+
function plainNumberRange(value, least, most, language) {
|
|
92
|
+
return new Intl.NumberFormat(language, {
|
|
93
|
+
minimumFractionDigits: least,
|
|
94
|
+
maximumFractionDigits: most,
|
|
95
|
+
}).format(value);
|
|
96
|
+
}
|
|
97
|
+
const DATE_ONLY_RE = /^\d{4}-\d{2}-\d{2}$/;
|
|
98
|
+
function rawOf(value) {
|
|
99
|
+
return value.kind === 'money' ? String(value.amount) : String(value.value);
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* A value as printed in `language`. No value prints `''`; anything Intl cannot
|
|
103
|
+
* format prints the raw value rather than failing the document.
|
|
104
|
+
*/
|
|
105
|
+
export function formatDocumentValue(value, format, language) {
|
|
106
|
+
if (!documentValueHasValue(value))
|
|
107
|
+
return '';
|
|
108
|
+
const v = value;
|
|
109
|
+
const f = format ?? {};
|
|
110
|
+
try {
|
|
111
|
+
switch (v.kind) {
|
|
112
|
+
case 'text':
|
|
113
|
+
return v.value;
|
|
114
|
+
case 'number':
|
|
115
|
+
return plainNumber(v.value, decimalsFor(v.value, f, 2), language);
|
|
116
|
+
case 'percent':
|
|
117
|
+
return `${plainNumber(v.value, decimalsFor(v.value, f, 2), language)} %`;
|
|
118
|
+
case 'money': {
|
|
119
|
+
const decimals = typeof f.decimals === 'number' && Number.isInteger(f.decimals) && f.decimals >= 0 && f.decimals <= 4
|
|
120
|
+
? f.decimals
|
|
121
|
+
: 2;
|
|
122
|
+
// A unit price never shows fewer places than it carries (up to four).
|
|
123
|
+
const most = v.unitPrice ? Math.max(decimals, unitPriceFractionDigits(v.amount)) : decimals;
|
|
124
|
+
if (f.currencyDisplay === 'none')
|
|
125
|
+
return plainNumberRange(v.amount, decimals, most, language);
|
|
126
|
+
try {
|
|
127
|
+
return new Intl.NumberFormat(language, {
|
|
128
|
+
style: 'currency',
|
|
129
|
+
currency: v.currency,
|
|
130
|
+
currencyDisplay: f.currencyDisplay === 'code' ? 'code' : 'symbol',
|
|
131
|
+
minimumFractionDigits: decimals,
|
|
132
|
+
maximumFractionDigits: most,
|
|
133
|
+
}).format(v.amount);
|
|
134
|
+
}
|
|
135
|
+
catch {
|
|
136
|
+
// A currency code Intl does not accept: the number and the code as stored.
|
|
137
|
+
return `${plainNumberRange(v.amount, decimals, most, language)} ${v.currency}`;
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
case 'date': {
|
|
141
|
+
const dateOnly = DATE_ONLY_RE.test(v.value);
|
|
142
|
+
const date = new Date(v.value);
|
|
143
|
+
if (Number.isNaN(date.getTime()))
|
|
144
|
+
return v.value;
|
|
145
|
+
return new Intl.DateTimeFormat(language, {
|
|
146
|
+
dateStyle: f.dateStyle ?? 'medium',
|
|
147
|
+
...(dateOnly ? { timeZone: 'UTC' } : {}),
|
|
148
|
+
}).format(date);
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
catch {
|
|
153
|
+
return rawOf(v);
|
|
154
|
+
}
|
|
155
|
+
return '';
|
|
156
|
+
}
|
|
157
|
+
function isCondition(value) {
|
|
158
|
+
if (value === null || typeof value !== 'object')
|
|
159
|
+
return false;
|
|
160
|
+
const op = value.op;
|
|
161
|
+
return op === 'always' || op === 'never' || op === 'has_value' || op === 'any_has_value';
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Whether a rule holds over a scope. An unreadable rule — stored by an older
|
|
165
|
+
* editor, pasted, hand-edited — reads as `always`, the facility's hostile-props
|
|
166
|
+
* rule: a column never vanishes because its rule could not be read.
|
|
167
|
+
*/
|
|
168
|
+
export function evaluateDocumentCondition(condition, scope, defaultField) {
|
|
169
|
+
if (!isCondition(condition))
|
|
170
|
+
return true;
|
|
171
|
+
switch (condition.op) {
|
|
172
|
+
case 'always':
|
|
173
|
+
return true;
|
|
174
|
+
case 'never':
|
|
175
|
+
return false;
|
|
176
|
+
case 'has_value': {
|
|
177
|
+
const field = typeof condition.field === 'string' && condition.field !== '' ? condition.field : defaultField;
|
|
178
|
+
const value = scope.item ? scope.item.values[field] : scope.summary?.[field];
|
|
179
|
+
return documentValueHasValue(value);
|
|
180
|
+
}
|
|
181
|
+
case 'any_has_value': {
|
|
182
|
+
const field = typeof condition.field === 'string' && condition.field !== '' ? condition.field : defaultField;
|
|
183
|
+
return (scope.items ?? []).some((candidate) => documentValueHasValue(candidate.values[field]));
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
const round2 = (value) => Math.round((value + Number.EPSILON) * 100) / 100;
|
|
188
|
+
/**
|
|
189
|
+
* The sum of the values that have one: numbers, or money of one currency
|
|
190
|
+
* rounded to the minor unit. Mixed kinds or currencies — and nothing to sum —
|
|
191
|
+
* answer no value rather than a misleading total.
|
|
192
|
+
*/
|
|
193
|
+
export function sumDocumentValues(values) {
|
|
194
|
+
const present = values.filter(documentValueHasValue);
|
|
195
|
+
if (present.length === 0)
|
|
196
|
+
return null;
|
|
197
|
+
if (present.every((value) => value.kind === 'number')) {
|
|
198
|
+
return { kind: 'number', value: present.reduce((sum, value) => sum + value.value, 0) };
|
|
199
|
+
}
|
|
200
|
+
if (present.every((value) => value.kind === 'money')) {
|
|
201
|
+
const currency = present[0].currency;
|
|
202
|
+
if (present.some((value) => value.currency !== currency))
|
|
203
|
+
return null;
|
|
204
|
+
return {
|
|
205
|
+
kind: 'money',
|
|
206
|
+
amount: round2(present.reduce((sum, value) => sum + value.amount, 0)),
|
|
207
|
+
currency,
|
|
208
|
+
};
|
|
209
|
+
}
|
|
210
|
+
return null;
|
|
211
|
+
}
|
|
212
|
+
/** An explicit alignment, else the field's default, else right for numeric kinds and left otherwise. */
|
|
213
|
+
export function resolveDocumentAlign(align, fieldDefault, kind) {
|
|
214
|
+
if (align === 'left' || align === 'center' || align === 'right')
|
|
215
|
+
return align;
|
|
216
|
+
if (fieldDefault === 'left' || fieldDefault === 'center' || fieldDefault === 'right')
|
|
217
|
+
return fieldDefault;
|
|
218
|
+
return kind === 'number' || kind === 'money' || kind === 'percent' ? 'right' : 'left';
|
|
219
|
+
}
|
|
220
|
+
//# sourceMappingURL=document-values.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"document-values.js","sourceRoot":"","sources":["../src/document-values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D;;;;;;;;;;GAUG;AAEH,8EAA8E;AAC9E,cAAc;AACd,8EAA8E;AAE9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,8CAA8C,CAAC;AAElF;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAK,EAAE,MAAM,CAAU,CAAC;AAEhE,2EAA2E;AAC3E,MAAM,CAAC,MAAM,uBAAuB,GAAG,YAAY,CAAC;AAEpD,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACxC,OAAQ,uBAA6C,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACzE,CAAC;AAED,8EAA8E;AAC9E,SAAS;AACT,8EAA8E;AAE9E,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;AAG9F,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,kBAAkB,CAAC,MAAM,EAAE;IAC1B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IACxD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IAC1D;;;;;OAKG;IACH,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;IACnH,2BAA2B;IAC3B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IAC3D,+CAA+C;IAC/C,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;CACzD,CAAC;KACD,QAAQ,EAAE,CAAC;AAUd,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnD,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9D,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC;AAcH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAAC;AAyBlG,8EAA8E;AAC9E,qBAAqB;AACrB,8EAA8E;AAE9E,4FAA4F;AAC5F,MAAM,UAAU,qBAAqB,CAAC,KAAgC;IACpE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACrF,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACT,OAAO,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QACtE,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS;YACZ,OAAO,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzE,KAAK,OAAO;YACV,OAAO,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3E;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,MAA2B,EAAE,QAAgB;IAC/E,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC;IAC/B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC;QAAE,OAAO,MAAM,CAAC;IACxG,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AAChD,CAAC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,QAAgB,EAAE,QAAgB;IACpE,OAAO,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAa,EAAE,KAAa,EAAE,IAAY,EAAE,QAAgB;IACpF,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;QACrC,qBAAqB,EAAE,KAAK;QAC5B,qBAAqB,EAAE,IAAI;KAC5B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC;AAED,MAAM,YAAY,GAAG,qBAAqB,CAAC;AAE3C,SAAS,KAAK,CAAC,KAAiC;IAC9C,OAAO,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAgC,EAChC,MAAuC,EACvC,QAAgB;IAEhB,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAC7C,MAAM,CAAC,GAAG,KAAmC,CAAC;IAC9C,MAAM,CAAC,GAAG,MAAM,IAAI,EAAE,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,MAAM;gBACT,OAAO,CAAC,CAAC,KAAK,CAAC;YACjB,KAAK,QAAQ;gBACX,OAAO,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YACpE,KAAK,SAAS;gBACZ,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;YAC3E,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,QAAQ,GACZ,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,CAAC;oBAClG,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACZ,CAAC,CAAC,CAAC,CAAC;gBACR,sEAAsE;gBACtE,MAAM,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAC5F,IAAI,CAAC,CAAC,eAAe,KAAK,MAAM;oBAAE,OAAO,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAC9F,IAAI,CAAC;oBACH,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;wBACrC,KAAK,EAAE,UAAU;wBACjB,QAAQ,EAAE,CAAC,CAAC,QAAQ;wBACpB,eAAe,EAAE,CAAC,CAAC,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ;wBACjE,qBAAqB,EAAE,QAAQ;wBAC/B,qBAAqB,EAAE,IAAI;qBAC5B,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;gBACtB,CAAC;gBAAC,MAAM,CAAC;oBACP,2EAA2E;oBAC3E,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACjF,CAAC;YACH,CAAC;YACD,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBAC5C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBAC/B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;oBAAE,OAAO,CAAC,CAAC,KAAK,CAAC;gBACjD,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE;oBACvC,SAAS,EAAE,CAAC,CAAC,SAAS,IAAI,QAAQ;oBAClC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACzC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,EAAE,GAAI,KAA0B,CAAC,EAAE,CAAC;IAC1C,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,OAAO,IAAI,EAAE,KAAK,WAAW,IAAI,EAAE,KAAK,eAAe,CAAC;AAC3F,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,SAAkB,EAClB,KAA6B,EAC7B,YAAoB;IAEpB,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,QAAQ,SAAS,CAAC,EAAE,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC;QACd,KAAK,OAAO;YACV,OAAO,KAAK,CAAC;QACf,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC;YAC7G,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;YAC7E,OAAO,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,KAAK,GAAG,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC;YAC7G,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,qBAAqB,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjG,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;AAE3F;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAA8C;IAC9E,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAiC,CAAC;IACrF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACtC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;QACtD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAI,KAA2B,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC;IAChH,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAI,OAAO,CAAC,CAAC,CAA0B,CAAC,QAAQ,CAAC;QAC/D,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAE,KAA8B,CAAC,QAAQ,KAAK,QAAQ,CAAC;YAAE,OAAO,IAAI,CAAC;QAChG,OAAO;YACL,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAI,KAA4B,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC7F,QAAQ;SACT,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,oBAAoB,CAClC,KAAyC,EACzC,YAAuC,EACvC,IAAmC;IAEnC,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC;IAC9E,IAAI,YAAY,KAAK,MAAM,IAAI,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,OAAO;QAAE,OAAO,YAAY,CAAC;IAC1G,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;AACxF,CAAC"}
|
package/dist/errors.d.ts
CHANGED
|
@@ -13,12 +13,15 @@ export declare const ERROR_CODES: {
|
|
|
13
13
|
readonly FORBIDDEN: "FORBIDDEN";
|
|
14
14
|
readonly RATE_LIMITED: "RATE_LIMITED";
|
|
15
15
|
readonly VERSION_CONFLICT: "VERSION_CONFLICT";
|
|
16
|
+
readonly AMOUNT_PRECISION_EXCEEDED: "AMOUNT_PRECISION_EXCEEDED";
|
|
17
|
+
readonly UNIT_PRICE_PRECISION_EXCEEDED: "UNIT_PRICE_PRECISION_EXCEEDED";
|
|
16
18
|
readonly FILTER_NOT_ALLOWED: "FILTER_NOT_ALLOWED";
|
|
17
19
|
readonly PRODUCT_NOT_FOUND: "PRODUCT_NOT_FOUND";
|
|
18
20
|
readonly PRICE_ORDERING_UNAVAILABLE: "PRICE_ORDERING_UNAVAILABLE";
|
|
19
21
|
readonly PRICE_RANGE_INVALID: "PRICE_RANGE_INVALID";
|
|
20
22
|
readonly PRODUCT_ARCHIVED: "PRODUCT_ARCHIVED";
|
|
21
23
|
readonly PRODUCT_DELETE_BLOCKED: "PRODUCT_DELETE_BLOCKED";
|
|
24
|
+
readonly PRODUCT_SAVED_VIEW_NAME_TAKEN: "PRODUCT_SAVED_VIEW_NAME_TAKEN";
|
|
22
25
|
readonly SKU_ALREADY_EXISTS: "SKU_ALREADY_EXISTS";
|
|
23
26
|
readonly VARIANT_COMBINATION_EXISTS: "VARIANT_COMBINATION_EXISTS";
|
|
24
27
|
readonly VARIANT_AXIS_MISSING: "VARIANT_AXIS_MISSING";
|
|
@@ -40,6 +43,10 @@ export declare const ERROR_CODES: {
|
|
|
40
43
|
readonly PACKAGING_UNIT_NOT_FOUND: "PACKAGING_UNIT_NOT_FOUND";
|
|
41
44
|
readonly PACKAGING_UNIT_NAME_CONFLICT: "PACKAGING_UNIT_NAME_CONFLICT";
|
|
42
45
|
readonly PACKAGING_UNIT_NOT_SUPPORTED_FOR_TYPE: "PACKAGING_UNIT_NOT_SUPPORTED_FOR_TYPE";
|
|
46
|
+
readonly PRODUCT_BELOW_MINIMUM_QUANTITY: "PRODUCT_BELOW_MINIMUM_QUANTITY";
|
|
47
|
+
readonly PACKAGING_UNIT_BELOW_MINIMUM_QUANTITY: "PACKAGING_UNIT_BELOW_MINIMUM_QUANTITY";
|
|
48
|
+
readonly PACKAGING_UNIT_MISMATCH: "PACKAGING_UNIT_MISMATCH";
|
|
49
|
+
readonly PRICE_SET_IN_PRICE_BOOKS: "PRICE_SET_IN_PRICE_BOOKS";
|
|
43
50
|
readonly SELF_LINK_NOT_ALLOWED: "SELF_LINK_NOT_ALLOWED";
|
|
44
51
|
readonly LINK_ALREADY_EXISTS: "LINK_ALREADY_EXISTS";
|
|
45
52
|
readonly TARGET_PRODUCT_NOT_FOUND: "TARGET_PRODUCT_NOT_FOUND";
|
|
@@ -61,8 +68,19 @@ export declare const ERROR_CODES: {
|
|
|
61
68
|
readonly RFQ_NOT_NEW: "RFQ_NOT_NEW";
|
|
62
69
|
readonly RFQ_ALREADY_CLAIMED: "RFQ_ALREADY_CLAIMED";
|
|
63
70
|
readonly RFQ_EXPIRED: "RFQ_EXPIRED";
|
|
71
|
+
readonly RFQ_PRICE_PROPOSAL_NOT_ALLOWED: "RFQ_PRICE_PROPOSAL_NOT_ALLOWED";
|
|
72
|
+
readonly RFQ_SAVED_VIEW_NAME_TAKEN: "RFQ_SAVED_VIEW_NAME_TAKEN";
|
|
64
73
|
readonly QUOTE_INCOMPLETE: "QUOTE_INCOMPLETE";
|
|
65
74
|
readonly QUOTE_VALIDITY_ENDED: "QUOTE_VALIDITY_ENDED";
|
|
75
|
+
/** The quote PDF is larger than an e-mail may carry; `details.maxBytes` names the limit. */
|
|
76
|
+
readonly QUOTE_REQUEST_PDF_TOO_LARGE: "QUOTE_REQUEST_PDF_TOO_LARGE";
|
|
77
|
+
/**
|
|
78
|
+
* The *Quote request PDF* e-mail cannot be sent at all — switched off, no
|
|
79
|
+
* mail transport, or no definition; `details.code` says which.
|
|
80
|
+
*/
|
|
81
|
+
readonly QUOTE_REQUEST_PDF_EMAIL_UNAVAILABLE: "QUOTE_REQUEST_PDF_EMAIL_UNAVAILABLE";
|
|
82
|
+
/** Every recipient's delivery failed at the mail transport. */
|
|
83
|
+
readonly QUOTE_REQUEST_PDF_SEND_FAILED: "QUOTE_REQUEST_PDF_SEND_FAILED";
|
|
66
84
|
readonly SHOPPING_LIST_CANNOT_DELETE_DEFAULT: "SHOPPING_LIST_CANNOT_DELETE_DEFAULT";
|
|
67
85
|
readonly SHOPPING_LIST_CANNOT_DELETE_LAST: "SHOPPING_LIST_CANNOT_DELETE_LAST";
|
|
68
86
|
readonly ORGANIZATION_TAX_ID_EXISTS: "ORGANIZATION_TAX_ID_EXISTS";
|
|
@@ -97,15 +115,28 @@ export declare const ERROR_CODES: {
|
|
|
97
115
|
readonly CART_PRODUCT_QUOTE_ONLY: "CART_PRODUCT_QUOTE_ONLY";
|
|
98
116
|
/** A cart line's quantity is below the minimum a line may hold (`details.minimum`). */
|
|
99
117
|
readonly CART_QUANTITY_INVALID: "CART_QUANTITY_INVALID";
|
|
118
|
+
/** No price list and no price of the Product's own applies, so the line has no price to be ordered at. */
|
|
119
|
+
readonly CART_PRODUCT_UNPRICED: "CART_PRODUCT_UNPRICED";
|
|
120
|
+
/**
|
|
121
|
+
* Order placement: a cart line's stored unit price is not the price it may be
|
|
122
|
+
* ordered at now (`details.lines`). The cart has been brought up to date and
|
|
123
|
+
* the buyer reviews it before placing again.
|
|
124
|
+
*/
|
|
125
|
+
readonly CART_PRICE_CHANGED: "CART_PRICE_CHANGED";
|
|
100
126
|
readonly STOCK_UNAVAILABLE: "STOCK_UNAVAILABLE";
|
|
101
127
|
readonly PROMOTION_INVALID: "PROMOTION_INVALID";
|
|
102
128
|
readonly ORGANIZATION_SUSPENDED: "ORGANIZATION_SUSPENDED";
|
|
103
129
|
readonly ORDER_NOT_FOUND: "ORDER_NOT_FOUND";
|
|
104
130
|
readonly ORDER_NOT_CANCELLABLE: "ORDER_NOT_CANCELLABLE";
|
|
131
|
+
/** 422 — the basket handed to placement belongs to another sales channel (feature 154). */
|
|
132
|
+
readonly ORDER_SALES_CHANNEL_MISMATCH: "ORDER_SALES_CHANNEL_MISMATCH";
|
|
133
|
+
readonly ORDER_SAVED_VIEW_NAME_TAKEN: "ORDER_SAVED_VIEW_NAME_TAKEN";
|
|
105
134
|
readonly INVOICE_NOT_READY: "INVOICE_NOT_READY";
|
|
106
135
|
readonly INVOICE_NUMBER_PATTERN_COLLIDES: "INVOICE_NUMBER_PATTERN_COLLIDES";
|
|
107
136
|
readonly INVOICE_NUMBER_ALREADY_ISSUED: "INVOICE_NUMBER_ALREADY_ISSUED";
|
|
137
|
+
readonly INVOICE_ORDER_REFUNDED: "INVOICE_ORDER_REFUNDED";
|
|
108
138
|
readonly INVALID_TRANSITION: "INVALID_TRANSITION";
|
|
139
|
+
readonly RETURN_LINE_NOT_RETURNABLE: "RETURN_LINE_NOT_RETURNABLE";
|
|
109
140
|
readonly CREDIT_LIMIT_NOT_GRANTED: "CREDIT_LIMIT_NOT_GRANTED";
|
|
110
141
|
readonly CREDIT_LIMIT_ALREADY_GRANTED: "CREDIT_LIMIT_ALREADY_GRANTED";
|
|
111
142
|
readonly LIMIT_INSUFFICIENT: "LIMIT_INSUFFICIENT";
|
|
@@ -115,6 +146,8 @@ export declare const ERROR_CODES: {
|
|
|
115
146
|
readonly ALREADY_SUBSCRIBED: "ALREADY_SUBSCRIBED";
|
|
116
147
|
readonly PRODUCT_IN_STOCK: "PRODUCT_IN_STOCK";
|
|
117
148
|
readonly API_KEY_OUT_OF_SCOPE: "API_KEY_OUT_OF_SCOPE";
|
|
149
|
+
/** An administrator asked for an API key scope their own role does not hold. */
|
|
150
|
+
readonly API_KEY_SCOPE_NOT_HELD: "API_KEY_SCOPE_NOT_HELD";
|
|
118
151
|
readonly WEBHOOK_DELIVERY_NOT_REPLAYABLE: "WEBHOOK_DELIVERY_NOT_REPLAYABLE";
|
|
119
152
|
/**
|
|
120
153
|
* A webhook subscription names an event type nothing delivers — one that is
|
|
@@ -129,10 +162,20 @@ export declare const ERROR_CODES: {
|
|
|
129
162
|
readonly PRICE_UNAVAILABLE: "PRICE_UNAVAILABLE";
|
|
130
163
|
readonly ADMIN_ROLE_CODE_TAKEN: "ADMIN_ROLE_CODE_TAKEN";
|
|
131
164
|
readonly ADMIN_ROLE_IN_USE: "ADMIN_ROLE_IN_USE";
|
|
165
|
+
/**
|
|
166
|
+
* A role write or a role assignment would hand out permissions the acting
|
|
167
|
+
* administrator's own role does not hold.
|
|
168
|
+
*/
|
|
169
|
+
readonly ADMIN_ROLE_GRANT_EXCEEDED: "ADMIN_ROLE_GRANT_EXCEEDED";
|
|
132
170
|
/** The acting administrator holds no role, so nothing says what they may do or reach. */
|
|
133
171
|
readonly ADMIN_ROLE_REQUIRED: "ADMIN_ROLE_REQUIRED";
|
|
134
172
|
/** A write would leave an administrator account without a role. */
|
|
135
173
|
readonly ADMIN_USER_ROLE_REQUIRED: "ADMIN_USER_ROLE_REQUIRED";
|
|
174
|
+
/**
|
|
175
|
+
* The target account's role holds permissions the acting administrator's own
|
|
176
|
+
* role does not, so the actor may not change, reset, deactivate or delete it.
|
|
177
|
+
*/
|
|
178
|
+
readonly ADMIN_USER_OUTRANKS_ACTOR: "ADMIN_USER_OUTRANKS_ACTOR";
|
|
136
179
|
/** An administrator changing their own password chose the one they already have. */
|
|
137
180
|
readonly NEW_PASSWORD_UNCHANGED: "NEW_PASSWORD_UNCHANGED";
|
|
138
181
|
/**
|
|
@@ -145,6 +188,17 @@ export declare const ERROR_CODES: {
|
|
|
145
188
|
* answer, so the attempt was refused without being checked; answered with 503.
|
|
146
189
|
*/
|
|
147
190
|
readonly ADMIN_AUTHENTICATION_UNAVAILABLE: "ADMIN_AUTHENTICATION_UNAVAILABLE";
|
|
191
|
+
/**
|
|
192
|
+
* Too many wrong passwords, wrong second-factor codes or password-reset
|
|
193
|
+
* requests for one customer account; answered with 429 and `Retry-After`
|
|
194
|
+
* until the delay has passed.
|
|
195
|
+
*/
|
|
196
|
+
readonly CUSTOMER_AUTHENTICATION_THROTTLED: "CUSTOMER_AUTHENTICATION_THROTTLED";
|
|
197
|
+
/**
|
|
198
|
+
* The store the customer authentication throttle counts in did not answer,
|
|
199
|
+
* so the attempt was refused without being checked; answered with 503.
|
|
200
|
+
*/
|
|
201
|
+
readonly CUSTOMER_AUTHENTICATION_UNAVAILABLE: "CUSTOMER_AUTHENTICATION_UNAVAILABLE";
|
|
148
202
|
readonly SETTING_NOT_REGISTERED: "SETTING_NOT_REGISTERED";
|
|
149
203
|
readonly SETTING_OUT_OF_SCOPE_FOR_CHANNEL: "SETTING_OUT_OF_SCOPE_FOR_CHANNEL";
|
|
150
204
|
readonly SETTING_VALUE_SHAPE_MISMATCH: "SETTING_VALUE_SHAPE_MISMATCH";
|
|
@@ -181,6 +235,10 @@ export declare const ERROR_CODES: {
|
|
|
181
235
|
readonly STALE_SALES_CHANNEL_WRITE: "STALE_SALES_CHANNEL_WRITE";
|
|
182
236
|
readonly SALES_CHANNEL_ATTRIBUTION_IMMUTABLE: "SALES_CHANNEL_ATTRIBUTION_IMMUTABLE";
|
|
183
237
|
readonly SALES_CHANNEL_CODE_IMMUTABLE: "SALES_CHANNEL_CODE_IMMUTABLE";
|
|
238
|
+
/** 403 — an anonymous request on a channel closed to anonymous visitors. */
|
|
239
|
+
readonly SALES_CHANNEL_SIGN_IN_REQUIRED: "SALES_CHANNEL_SIGN_IN_REQUIRED";
|
|
240
|
+
/** 403 — a customer request on a channel its Organization is not assigned to. */
|
|
241
|
+
readonly SALES_CHANNEL_NOT_PERMITTED: "SALES_CHANNEL_NOT_PERMITTED";
|
|
184
242
|
readonly COMPARISON_FULL: "COMPARISON_FULL";
|
|
185
243
|
readonly COMPARISON_NOT_FOUND: "COMPARISON_NOT_FOUND";
|
|
186
244
|
readonly COMPARISON_EMPTY: "COMPARISON_EMPTY";
|
|
@@ -214,6 +272,13 @@ export declare const ERROR_CODES: {
|
|
|
214
272
|
readonly ASSET_FILE_MISSING: "ASSET_FILE_MISSING";
|
|
215
273
|
readonly ASSET_GONE: "ASSET_GONE";
|
|
216
274
|
readonly ASSET_ACCESS_DENIED: "ASSET_ACCESS_DENIED";
|
|
275
|
+
readonly ASSET_REPLACE_KIND_MISMATCH: "ASSET_REPLACE_KIND_MISMATCH";
|
|
276
|
+
readonly ASSET_LEGACY_CANNOT_REPLACE: "ASSET_LEGACY_CANNOT_REPLACE";
|
|
277
|
+
readonly ASSET_REPLACE_CONFLICT: "ASSET_REPLACE_CONFLICT";
|
|
278
|
+
readonly ASSET_NO_PREVIOUS_VERSION: "ASSET_NO_PREVIOUS_VERSION";
|
|
279
|
+
readonly ASSET_PERMALINK_TAKEN: "ASSET_PERMALINK_TAKEN";
|
|
280
|
+
readonly ASSET_PERMALINK_PREVIOUSLY_USED: "ASSET_PERMALINK_PREVIOUSLY_USED";
|
|
281
|
+
readonly ASSET_PERMALINK_INVALID: "ASSET_PERMALINK_INVALID";
|
|
217
282
|
readonly CMS_PAGE_NOT_FOUND: "CMS_PAGE_NOT_FOUND";
|
|
218
283
|
readonly CMS_BLOCK_NOT_FOUND: "CMS_BLOCK_NOT_FOUND";
|
|
219
284
|
readonly CMS_TEMPLATE_NOT_FOUND: "CMS_TEMPLATE_NOT_FOUND";
|
|
@@ -224,6 +289,12 @@ export declare const ERROR_CODES: {
|
|
|
224
289
|
readonly CMS_REFERENCED: "CMS_REFERENCED";
|
|
225
290
|
readonly CMS_HOOK_SYSTEM_PROTECTED: "CMS_HOOK_SYSTEM_PROTECTED";
|
|
226
291
|
readonly CMS_LANGUAGE_NOT_IN_CHANNEL_SCOPE: "CMS_LANGUAGE_NOT_IN_CHANNEL_SCOPE";
|
|
292
|
+
readonly CMS_TRANSLATION_DISABLED: "CMS_TRANSLATION_DISABLED";
|
|
293
|
+
readonly CMS_TRANSLATION_NOT_CONFIGURED: "CMS_TRANSLATION_NOT_CONFIGURED";
|
|
294
|
+
readonly CMS_TRANSLATION_UNAVAILABLE: "CMS_TRANSLATION_UNAVAILABLE";
|
|
295
|
+
readonly CMS_TRANSLATION_TOO_LARGE: "CMS_TRANSLATION_TOO_LARGE";
|
|
296
|
+
readonly CMS_TRANSLATION_SELECTION_NOT_FOUND: "CMS_TRANSLATION_SELECTION_NOT_FOUND";
|
|
297
|
+
readonly CMS_TRANSLATION_PROVIDER_FAILED: "CMS_TRANSLATION_PROVIDER_FAILED";
|
|
227
298
|
readonly CMS_SCHEMA_UPGRADE_FAILED: "CMS_SCHEMA_UPGRADE_FAILED";
|
|
228
299
|
readonly MEGAMENU_NOT_FOUND: "MEGAMENU_NOT_FOUND";
|
|
229
300
|
readonly MEGAMENU_HAS_ACTIVE_BINDINGS: "MEGAMENU_HAS_ACTIVE_BINDINGS";
|
|
@@ -303,6 +374,11 @@ export declare const ERROR_CODES: {
|
|
|
303
374
|
readonly BULK_TOO_LARGE: "BULK_TOO_LARGE";
|
|
304
375
|
readonly ATTRIBUTE_NOT_MASS_EDITABLE: "ATTRIBUTE_NOT_MASS_EDITABLE";
|
|
305
376
|
readonly SELECTION_TOO_LARGE: "SELECTION_TOO_LARGE";
|
|
377
|
+
/**
|
|
378
|
+
* `mfa` cannot be switched off while administrators are required to sign in
|
|
379
|
+
* with a second factor; the requirement is turned off first.
|
|
380
|
+
*/
|
|
381
|
+
readonly MFA_DEACTIVATION_BLOCKED: "MFA_DEACTIVATION_BLOCKED";
|
|
306
382
|
readonly MFA_INVALID_CODE: "MFA_INVALID_CODE";
|
|
307
383
|
readonly MFA_INVALID_CHALLENGE: "MFA_INVALID_CHALLENGE";
|
|
308
384
|
readonly MFA_TOO_MANY_ATTEMPTS: "MFA_TOO_MANY_ATTEMPTS";
|
|
@@ -318,10 +394,20 @@ export declare const ERROR_CODES: {
|
|
|
318
394
|
readonly CUSTOM_FIELD_DEFINITION_INVALID: "CUSTOM_FIELD_DEFINITION_INVALID";
|
|
319
395
|
readonly CUSTOM_FIELD_VALUE_INVALID: "CUSTOM_FIELD_VALUE_INVALID";
|
|
320
396
|
readonly CUSTOM_FIELD_HOST_MANAGED: "CUSTOM_FIELD_HOST_MANAGED";
|
|
397
|
+
readonly CUSTOM_FIELD_FILTER_UNAVAILABLE: "CUSTOM_FIELD_FILTER_UNAVAILABLE";
|
|
398
|
+
readonly CUSTOM_FIELD_OPTION_IN_USE: "CUSTOM_FIELD_OPTION_IN_USE";
|
|
399
|
+
readonly CUSTOM_FIELD_VALUE_TYPE_LOCKED: "CUSTOM_FIELD_VALUE_TYPE_LOCKED";
|
|
400
|
+
readonly CUSTOM_FIELD_STORED_VALUES_EXIST: "CUSTOM_FIELD_STORED_VALUES_EXIST";
|
|
401
|
+
readonly CUSTOM_FIELD_CARRY_INCOMPATIBLE: "CUSTOM_FIELD_CARRY_INCOMPATIBLE";
|
|
321
402
|
readonly CREDENTIAL_NOT_FOUND: "CREDENTIAL_NOT_FOUND";
|
|
322
403
|
readonly CREDENTIAL_CODE_TAKEN: "CREDENTIAL_CODE_TAKEN";
|
|
323
404
|
readonly CREDENTIAL_TYPE_UNKNOWN: "CREDENTIAL_TYPE_UNKNOWN";
|
|
324
405
|
readonly CREDENTIAL_VALIDATION_FAILED: "CREDENTIAL_VALIDATION_FAILED";
|
|
406
|
+
/**
|
|
407
|
+
* An update changed where a credential record's secrets are sent without
|
|
408
|
+
* re-entering them; stored secrets are not carried over to a new endpoint.
|
|
409
|
+
*/
|
|
410
|
+
readonly CREDENTIAL_SECRET_REENTRY_REQUIRED: "CREDENTIAL_SECRET_REENTRY_REQUIRED";
|
|
325
411
|
readonly CREDENTIAL_IN_USE: "CREDENTIAL_IN_USE";
|
|
326
412
|
readonly CREDENTIAL_TYPE_IMMUTABLE: "CREDENTIAL_TYPE_IMMUTABLE";
|
|
327
413
|
readonly PRODUCT_FEED_DISABLED: "PRODUCT_FEED_DISABLED";
|
|
@@ -356,6 +442,26 @@ export declare const ERROR_CODES: {
|
|
|
356
442
|
* identifiers says nothing about which one was wrong.
|
|
357
443
|
*/
|
|
358
444
|
readonly PRICE_LIST_NOT_FOUND: "PRICE_LIST_NOT_FOUND";
|
|
445
|
+
/** Feature 160 — a channel of a price book's set does not offer the book's currency (FR-003). */
|
|
446
|
+
readonly PRICE_BOOK_CHANNEL_CURRENCY: "PRICE_BOOK_CHANNEL_CURRENCY";
|
|
447
|
+
/** Feature 160 — an audience set names members of another kind, or that do not exist (FR-002, A4). */
|
|
448
|
+
readonly PRICE_BOOK_AUDIENCE_KIND: "PRICE_BOOK_AUDIENCE_KIND";
|
|
449
|
+
/** Feature 160 — the currency, or the audience kind of a book once active, may not change (FR-004). */
|
|
450
|
+
readonly PRICE_BOOK_IMMUTABLE_FIELD: "PRICE_BOOK_IMMUTABLE_FIELD";
|
|
451
|
+
/** Feature 160 — the book would apply nowhere or to no one, so it cannot be activated. */
|
|
452
|
+
readonly PRICE_BOOK_NOT_APPLICABLE: "PRICE_BOOK_NOT_APPLICABLE";
|
|
453
|
+
/** Feature 160 — two rows of one selection overlap in their quantity windows (FR-006); `details.errors` names them. */
|
|
454
|
+
readonly PRICE_BOOK_ROW_OVERLAP: "PRICE_BOOK_ROW_OVERLAP";
|
|
455
|
+
/** Feature 160 — rows break a shape rule (FR-005–FR-009); `details.errors` names every failing row. */
|
|
456
|
+
readonly PRICE_BOOK_ROW_SHAPE: "PRICE_BOOK_ROW_SHAPE";
|
|
457
|
+
/** Feature 160 — a row names a product, variant, category or attribute value that does not exist or cannot select prices. */
|
|
458
|
+
readonly PRICE_BOOK_ROW_TARGET: "PRICE_BOOK_ROW_TARGET";
|
|
459
|
+
/** Feature 160 — the book would hold more rows than its limit. */
|
|
460
|
+
readonly PRICE_BOOK_ROW_LIMIT: "PRICE_BOOK_ROW_LIMIT";
|
|
461
|
+
/** Feature 160 — the book changed since the version the write was made against; `details.currentVersion`. */
|
|
462
|
+
readonly PRICE_BOOK_STALE: "PRICE_BOOK_STALE";
|
|
463
|
+
/** Feature 160 — the precedence is read-only until the change flow ships (FR-023). */
|
|
464
|
+
readonly PRECEDENCE_CHANGE_UNAVAILABLE: "PRECEDENCE_CHANGE_UNAVAILABLE";
|
|
359
465
|
/** Another PIM connector is operator-active; activation refused (FR-003). */
|
|
360
466
|
readonly PIM_CONNECTOR_ALREADY_ACTIVE: "PIM_CONNECTOR_ALREADY_ACTIVE";
|
|
361
467
|
/** Another invoice-ledger vendor is operator-active; activation refused. */
|
|
@@ -412,6 +518,22 @@ export declare const ERROR_CODES: {
|
|
|
412
518
|
* saved is larger than `CRAWLER_TEXT_MAX_BYTES`; `details.maxBytes` names the limit.
|
|
413
519
|
*/
|
|
414
520
|
readonly SEO_CRAWLER_TEXT_TOO_LARGE: "SEO_CRAWLER_TEXT_TOO_LARGE";
|
|
521
|
+
/** No template with that id, or its document type is not available (indistinguishable, FR-051). */
|
|
522
|
+
readonly DOCUMENT_TEMPLATE_NOT_FOUND: "DOCUMENT_TEMPLATE_NOT_FOUND";
|
|
523
|
+
/** The document type is not registered by a present module. */
|
|
524
|
+
readonly DOCUMENT_TYPE_NOT_AVAILABLE: "DOCUMENT_TYPE_NOT_AVAILABLE";
|
|
525
|
+
/** A layout breaks a limit or offers a block the type does not; `details` names which. */
|
|
526
|
+
readonly DOCUMENT_TEMPLATE_INVALID: "DOCUMENT_TEMPLATE_INVALID";
|
|
527
|
+
/** Deleting the default template of a scope needs explicit confirmation (FR-007). */
|
|
528
|
+
readonly DOCUMENT_TEMPLATE_IS_DEFAULT: "DOCUMENT_TEMPLATE_IS_DEFAULT";
|
|
529
|
+
/** A template was named for a document whose type, channel or selection rule forbids it (FR-038). */
|
|
530
|
+
readonly DOCUMENT_TEMPLATE_NOT_SELECTABLE: "DOCUMENT_TEMPLATE_NOT_SELECTABLE";
|
|
531
|
+
/** Producing the document failed. */
|
|
532
|
+
readonly DOCUMENT_RENDER_FAILED: "DOCUMENT_RENDER_FAILED";
|
|
533
|
+
/** The relay address is empty or not an http(s) URL: sending is switched off. */
|
|
534
|
+
readonly ADMIN_FEEDBACK_NOT_CONFIGURED: "ADMIN_FEEDBACK_NOT_CONFIGURED";
|
|
535
|
+
/** The relay could not be reached in time, refused the message, or redirected. */
|
|
536
|
+
readonly ADMIN_FEEDBACK_DELIVERY_FAILED: "ADMIN_FEEDBACK_DELIVERY_FAILED";
|
|
415
537
|
};
|
|
416
538
|
export type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
|
|
417
539
|
/**
|