@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
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
import { recordReferenceTypeSchema } from './record-references.js';
|
|
2
|
+
/** The order marks are written in, outermost first — what makes the writer deterministic. */
|
|
3
|
+
const MARK_ORDER = ['bold', 'italic', 'strike'];
|
|
4
|
+
const MARK_DELIMITER = { bold: '**', italic: '_', strike: '~~' };
|
|
5
|
+
/** Characters a backslash makes literal. */
|
|
6
|
+
const ESCAPABLE = new Set(['\\', '*', '_', '~', '[', ']']);
|
|
7
|
+
const SAFE_HREF = /^(https?:\/\/[^\s()<>]+|mailto:[^\s()<>]+)$/i;
|
|
8
|
+
const REFERENCE_AT = new RegExp(`\\[\\[(${recordReferenceTypeSchema.options.join('|')}):([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})\\]\\]`, 'y');
|
|
9
|
+
const BULLET_LINE = /^- (.*)$/s;
|
|
10
|
+
const ORDERED_LINE = /^(\d{1,9})\. (.*)$/s;
|
|
11
|
+
const WORD_CHARACTER = /[\p{L}\p{N}]/u;
|
|
12
|
+
/** Whether `href` may be a link's address. */
|
|
13
|
+
export function isSafeRecordRichHref(href) {
|
|
14
|
+
return SAFE_HREF.test(href);
|
|
15
|
+
}
|
|
16
|
+
function isWord(character) {
|
|
17
|
+
return character !== undefined && WORD_CHARACTER.test(character);
|
|
18
|
+
}
|
|
19
|
+
/** Whether the delimiter at the cursor may close `mark`. */
|
|
20
|
+
function closesHere(cursor, mark) {
|
|
21
|
+
const delimiter = MARK_DELIMITER[mark];
|
|
22
|
+
if (!cursor.source.startsWith(delimiter, cursor.at))
|
|
23
|
+
return false;
|
|
24
|
+
if (mark === 'italic')
|
|
25
|
+
return !isWord(cursor.source[cursor.at + 1]);
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
/** Whether the delimiter at the cursor may open `mark`. */
|
|
29
|
+
function opensHere(cursor, mark) {
|
|
30
|
+
const delimiter = MARK_DELIMITER[mark];
|
|
31
|
+
if (!cursor.source.startsWith(delimiter, cursor.at))
|
|
32
|
+
return false;
|
|
33
|
+
const next = cursor.source[cursor.at + delimiter.length];
|
|
34
|
+
if (next === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (mark === 'italic')
|
|
37
|
+
return !isWord(cursor.source[cursor.at - 1]) && next !== ' ';
|
|
38
|
+
return true;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Inline content from the cursor up to `until` — a mark's closing delimiter, a
|
|
42
|
+
* link label's `]` — or to the end. Returns `null` when `until` is never met:
|
|
43
|
+
* the opener is then plain characters.
|
|
44
|
+
*/
|
|
45
|
+
function readInline(cursor, marks, href, until) {
|
|
46
|
+
const out = [];
|
|
47
|
+
const pushText = (value) => {
|
|
48
|
+
const last = out[out.length - 1];
|
|
49
|
+
if (last && last.kind === 'text' && sameMarks(last.marks, marks) && last.href === href) {
|
|
50
|
+
last.text += value;
|
|
51
|
+
return;
|
|
52
|
+
}
|
|
53
|
+
out.push({ kind: 'text', text: value, marks: [...marks], ...(href ? { href } : {}) });
|
|
54
|
+
};
|
|
55
|
+
while (cursor.at < cursor.source.length) {
|
|
56
|
+
if (until && 'mark' in until && closesHere(cursor, until.mark)) {
|
|
57
|
+
cursor.at += MARK_DELIMITER[until.mark].length;
|
|
58
|
+
return out;
|
|
59
|
+
}
|
|
60
|
+
if (until && 'linkLabel' in until && cursor.source[cursor.at] === ']') {
|
|
61
|
+
cursor.at += 1;
|
|
62
|
+
return out;
|
|
63
|
+
}
|
|
64
|
+
const character = cursor.source[cursor.at];
|
|
65
|
+
if (character === '\\' && ESCAPABLE.has(cursor.source[cursor.at + 1] ?? '')) {
|
|
66
|
+
pushText(cursor.source[cursor.at + 1]);
|
|
67
|
+
cursor.at += 2;
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
REFERENCE_AT.lastIndex = cursor.at;
|
|
71
|
+
const reference = REFERENCE_AT.exec(cursor.source);
|
|
72
|
+
if (reference) {
|
|
73
|
+
out.push({
|
|
74
|
+
kind: 'reference',
|
|
75
|
+
type: reference[1],
|
|
76
|
+
id: reference[2].toLowerCase(),
|
|
77
|
+
marks: [...marks],
|
|
78
|
+
});
|
|
79
|
+
cursor.at += reference[0].length;
|
|
80
|
+
continue;
|
|
81
|
+
}
|
|
82
|
+
if (character === '[' && href === undefined && !cursor.exhausted.has('link')) {
|
|
83
|
+
const link = tryLink(cursor, marks);
|
|
84
|
+
if (link) {
|
|
85
|
+
out.push(...link);
|
|
86
|
+
continue;
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
const opened = MARK_ORDER.find((mark) => !marks.includes(mark) && !cursor.exhausted.has(mark) && opensHere(cursor, mark));
|
|
90
|
+
if (opened) {
|
|
91
|
+
const start = cursor.at;
|
|
92
|
+
cursor.at += MARK_DELIMITER[opened].length;
|
|
93
|
+
const inner = readInline(cursor, [...marks, opened].sort(byMarkOrder), href, { mark: opened });
|
|
94
|
+
if (inner) {
|
|
95
|
+
for (const node of inner) {
|
|
96
|
+
if (node.kind === 'text')
|
|
97
|
+
pushTextNode(out, node);
|
|
98
|
+
else
|
|
99
|
+
out.push(node);
|
|
100
|
+
}
|
|
101
|
+
continue;
|
|
102
|
+
}
|
|
103
|
+
cursor.at = start;
|
|
104
|
+
cursor.exhausted.add(opened);
|
|
105
|
+
pushText(MARK_DELIMITER[opened]);
|
|
106
|
+
cursor.at += MARK_DELIMITER[opened].length;
|
|
107
|
+
continue;
|
|
108
|
+
}
|
|
109
|
+
pushText(character);
|
|
110
|
+
cursor.at += 1;
|
|
111
|
+
}
|
|
112
|
+
return until ? null : out;
|
|
113
|
+
}
|
|
114
|
+
function pushTextNode(out, node) {
|
|
115
|
+
const last = out[out.length - 1];
|
|
116
|
+
if (last && last.kind === 'text' && sameMarks(last.marks, node.marks) && last.href === node.href) {
|
|
117
|
+
last.text += node.text;
|
|
118
|
+
return;
|
|
119
|
+
}
|
|
120
|
+
out.push(node);
|
|
121
|
+
}
|
|
122
|
+
/** `[label](href)` at the cursor, or `null` — and the cursor untouched — when it is not one. */
|
|
123
|
+
function tryLink(cursor, marks) {
|
|
124
|
+
const start = cursor.at;
|
|
125
|
+
cursor.at += 1;
|
|
126
|
+
// The address is only known after the label: read the label once to find
|
|
127
|
+
// where it ends, then again with the address on every piece.
|
|
128
|
+
const probe = readInline(cursor, marks, '', { linkLabel: true });
|
|
129
|
+
if (probe && cursor.source[cursor.at] === '(') {
|
|
130
|
+
const close = cursor.source.indexOf(')', cursor.at);
|
|
131
|
+
const href = close === -1 ? '' : cursor.source.slice(cursor.at + 1, close);
|
|
132
|
+
if (close !== -1 && isSafeRecordRichHref(href) && probe.length > 0) {
|
|
133
|
+
const labelCursor = { ...cursor, at: start + 1 };
|
|
134
|
+
const label = readInline(labelCursor, marks, href, { linkLabel: true }) ?? [];
|
|
135
|
+
cursor.at = close + 1;
|
|
136
|
+
// A reference inside a label carries no address: a chip is a link of its own.
|
|
137
|
+
return label;
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
if (!probe)
|
|
141
|
+
cursor.exhausted.add('link');
|
|
142
|
+
cursor.at = start;
|
|
143
|
+
return null;
|
|
144
|
+
}
|
|
145
|
+
function byMarkOrder(a, b) {
|
|
146
|
+
return MARK_ORDER.indexOf(a) - MARK_ORDER.indexOf(b);
|
|
147
|
+
}
|
|
148
|
+
function sameMarks(a, b) {
|
|
149
|
+
return a.length === b.length && a.every((mark, index) => mark === b[index]);
|
|
150
|
+
}
|
|
151
|
+
function readLine(line) {
|
|
152
|
+
return readInline({ source: line, at: 0, exhausted: new Set() }, [], undefined, null) ?? [];
|
|
153
|
+
}
|
|
154
|
+
/** The blocks a stored text stands for. The empty text is no blocks. */
|
|
155
|
+
export function parseRecordRichText(source) {
|
|
156
|
+
if (source === '')
|
|
157
|
+
return [];
|
|
158
|
+
const blocks = [];
|
|
159
|
+
for (const line of source.split('\n')) {
|
|
160
|
+
const bullet = BULLET_LINE.exec(line);
|
|
161
|
+
if (bullet) {
|
|
162
|
+
const last = blocks[blocks.length - 1];
|
|
163
|
+
const item = readLine(bullet[1]);
|
|
164
|
+
if (last?.kind === 'bullet_list')
|
|
165
|
+
last.items.push(item);
|
|
166
|
+
else
|
|
167
|
+
blocks.push({ kind: 'bullet_list', items: [item] });
|
|
168
|
+
continue;
|
|
169
|
+
}
|
|
170
|
+
const ordered = ORDERED_LINE.exec(line);
|
|
171
|
+
if (ordered) {
|
|
172
|
+
const last = blocks[blocks.length - 1];
|
|
173
|
+
const item = readLine(ordered[2]);
|
|
174
|
+
if (last?.kind === 'ordered_list')
|
|
175
|
+
last.items.push(item);
|
|
176
|
+
else
|
|
177
|
+
blocks.push({ kind: 'ordered_list', start: Number(ordered[1]), items: [item] });
|
|
178
|
+
continue;
|
|
179
|
+
}
|
|
180
|
+
// An escaped list marker at the start of a line is the characters of one.
|
|
181
|
+
const escapedOrdered = /^(\d{1,9})\\\. /.exec(line);
|
|
182
|
+
const content = line.startsWith('\\- ')
|
|
183
|
+
? [{ kind: 'text', text: '- ', marks: [] }, ...readLine(line.slice(3))]
|
|
184
|
+
: escapedOrdered
|
|
185
|
+
? [
|
|
186
|
+
{ kind: 'text', text: `${escapedOrdered[1]}. `, marks: [] },
|
|
187
|
+
...readLine(line.slice(escapedOrdered[0].length)),
|
|
188
|
+
]
|
|
189
|
+
: readLine(line);
|
|
190
|
+
blocks.push({ kind: 'paragraph', content: mergeTexts(content) });
|
|
191
|
+
}
|
|
192
|
+
return blocks;
|
|
193
|
+
}
|
|
194
|
+
function mergeTexts(nodes) {
|
|
195
|
+
const out = [];
|
|
196
|
+
for (const node of nodes) {
|
|
197
|
+
if (node.kind === 'text') {
|
|
198
|
+
if (node.text === '')
|
|
199
|
+
continue;
|
|
200
|
+
pushTextNode(out, { ...node, marks: [...node.marks] });
|
|
201
|
+
}
|
|
202
|
+
else
|
|
203
|
+
out.push(node);
|
|
204
|
+
}
|
|
205
|
+
return out;
|
|
206
|
+
}
|
|
207
|
+
// --- Writing ---------------------------------------------------------------------
|
|
208
|
+
function escapeText(value) {
|
|
209
|
+
return value.replace(/[\\*_~[\]]/g, (character) => `\\${character}`);
|
|
210
|
+
}
|
|
211
|
+
/** One line of inline content, with the fewest delimiters that say what it is. */
|
|
212
|
+
function writeInline(nodes) {
|
|
213
|
+
let out = '';
|
|
214
|
+
let open = [];
|
|
215
|
+
let link;
|
|
216
|
+
const closeMarksTo = (depth) => {
|
|
217
|
+
while (open.length > depth)
|
|
218
|
+
out += MARK_DELIMITER[open.pop()];
|
|
219
|
+
};
|
|
220
|
+
const closeLink = () => {
|
|
221
|
+
if (link === undefined)
|
|
222
|
+
return;
|
|
223
|
+
closeMarksTo(0);
|
|
224
|
+
out += `](${link})`;
|
|
225
|
+
link = undefined;
|
|
226
|
+
};
|
|
227
|
+
for (const node of nodes) {
|
|
228
|
+
if (node.kind === 'text' && node.text === '')
|
|
229
|
+
continue;
|
|
230
|
+
const wanted = [...node.marks].sort(byMarkOrder);
|
|
231
|
+
const href = node.kind === 'text' && node.href && isSafeRecordRichHref(node.href) ? node.href : undefined;
|
|
232
|
+
if (href !== link) {
|
|
233
|
+
closeLink();
|
|
234
|
+
if (href !== undefined) {
|
|
235
|
+
out += '[';
|
|
236
|
+
link = href;
|
|
237
|
+
}
|
|
238
|
+
}
|
|
239
|
+
let keep = 0;
|
|
240
|
+
while (keep < open.length && keep < wanted.length && open[keep] === wanted[keep])
|
|
241
|
+
keep += 1;
|
|
242
|
+
closeMarksTo(keep);
|
|
243
|
+
for (const mark of wanted.slice(keep)) {
|
|
244
|
+
out += MARK_DELIMITER[mark];
|
|
245
|
+
open.push(mark);
|
|
246
|
+
}
|
|
247
|
+
out += node.kind === 'text' ? escapeText(node.text) : `[[${node.type}:${node.id}]]`;
|
|
248
|
+
}
|
|
249
|
+
closeLink();
|
|
250
|
+
closeMarksTo(0);
|
|
251
|
+
open = [];
|
|
252
|
+
return out;
|
|
253
|
+
}
|
|
254
|
+
/** The stored text of `blocks` — the inverse of `parseRecordRichText`. */
|
|
255
|
+
export function formatRecordRichText(blocks) {
|
|
256
|
+
const lines = [];
|
|
257
|
+
for (const block of blocks) {
|
|
258
|
+
if (block.kind === 'paragraph') {
|
|
259
|
+
const line = writeInline(block.content);
|
|
260
|
+
// A paragraph that begins like a list item says it is not one.
|
|
261
|
+
lines.push(line.startsWith('- ') ? `\\${line}` : line.replace(/^(\d{1,9})\. /, '$1\\. '));
|
|
262
|
+
continue;
|
|
263
|
+
}
|
|
264
|
+
block.items.forEach((item, index) => {
|
|
265
|
+
const marker = block.kind === 'bullet_list' ? '- ' : `${block.start + index}. `;
|
|
266
|
+
lines.push(`${marker}${writeInline(item)}`);
|
|
267
|
+
});
|
|
268
|
+
}
|
|
269
|
+
return lines.join('\n');
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* The text without its formatting, for a place that shows text plainly — an
|
|
273
|
+
* e-mail's text part, a bell entry, a preview. Reference tokens are kept for
|
|
274
|
+
* the caller to resolve; list items keep their markers, links their address.
|
|
275
|
+
*/
|
|
276
|
+
export function recordRichTextToPlain(source) {
|
|
277
|
+
const inline = (nodes) => {
|
|
278
|
+
let out = '';
|
|
279
|
+
let link;
|
|
280
|
+
for (const node of nodes) {
|
|
281
|
+
const href = node.kind === 'text' ? node.href : undefined;
|
|
282
|
+
if (link !== undefined && href !== link) {
|
|
283
|
+
out += ` (${link})`;
|
|
284
|
+
link = undefined;
|
|
285
|
+
}
|
|
286
|
+
if (href !== undefined)
|
|
287
|
+
link = href;
|
|
288
|
+
out += node.kind === 'text' ? node.text : `[[${node.type}:${node.id}]]`;
|
|
289
|
+
}
|
|
290
|
+
if (link !== undefined)
|
|
291
|
+
out += ` (${link})`;
|
|
292
|
+
return out;
|
|
293
|
+
};
|
|
294
|
+
const lines = [];
|
|
295
|
+
for (const block of parseRecordRichText(source)) {
|
|
296
|
+
if (block.kind === 'paragraph')
|
|
297
|
+
lines.push(inline(block.content));
|
|
298
|
+
else
|
|
299
|
+
block.items.forEach((item, index) => lines.push(`${block.kind === 'bullet_list' ? '- ' : `${block.start + index}. `}${inline(item)}`));
|
|
300
|
+
}
|
|
301
|
+
return lines.join('\n');
|
|
302
|
+
}
|
|
303
|
+
//# sourceMappingURL=record-rich-text.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"record-rich-text.js","sourceRoot":"","sources":["../src/record-rich-text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAA4B,MAAM,wBAAwB,CAAC;AAkC7F,6FAA6F;AAC7F,MAAM,UAAU,GAA8B,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC3E,MAAM,cAAc,GAAmC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAWjG,4CAA4C;AAC5C,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAC3D,MAAM,SAAS,GAAG,8CAA8C,CAAC;AACjE,MAAM,YAAY,GAAG,IAAI,MAAM,CAC7B,UAAU,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,uFAAuF,EAC5I,GAAG,CACJ,CAAC;AACF,MAAM,WAAW,GAAG,WAAW,CAAC;AAChC,MAAM,YAAY,GAAG,qBAAqB,CAAC;AAC3C,MAAM,cAAc,GAAG,eAAe,CAAC;AAEvC,8CAA8C;AAC9C,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAeD,SAAS,MAAM,CAAC,SAA6B;IAC3C,OAAO,SAAS,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnE,CAAC;AAED,4DAA4D;AAC5D,SAAS,UAAU,CAAC,MAAc,EAAE,IAAoB;IACtD,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;QAAE,OAAO,KAAK,CAAC;IAClE,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,2DAA2D;AAC3D,SAAS,SAAS,CAAC,MAAc,EAAE,IAAoB;IACrD,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;QAAE,OAAO,KAAK,CAAC;IAClE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACzD,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACrC,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,KAAK,GAAG,CAAC;IACpF,OAAO,IAAI,CAAC;AACd,CAAC;AAID;;;;GAIG;AACH,SAAS,UAAU,CACjB,MAAc,EACd,KAAuB,EACvB,IAAwB,EACxB,KAAY;IAEZ,MAAM,GAAG,GAAuB,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAQ,EAAE;QACvC,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACvF,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC;YACnB,OAAO;QACT,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,CAAC;IAEF,OAAO,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/D,MAAM,CAAC,EAAE,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;YAC/C,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,KAAK,IAAI,WAAW,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;YACtE,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;YACf,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAW,CAAC;QAErD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5E,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAW,CAAC,CAAC;YACjD,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;YACf,SAAS;QACX,CAAC;QAED,YAAY,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,SAAS,EAAE,CAAC;YACd,GAAG,CAAC,IAAI,CAAC;gBACP,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAwB;gBACzC,EAAE,EAAG,SAAS,CAAC,CAAC,CAAY,CAAC,WAAW,EAAE;gBAC1C,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC;aAClB,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YACjC,SAAS;QACX,CAAC;QAED,IAAI,SAAS,KAAK,GAAG,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7E,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACpC,IAAI,IAAI,EAAE,CAAC;gBACT,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;gBAClB,SAAS;YACX,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAC5B,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAC1F,CAAC;QACF,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,EAAE,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;YAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YAC/F,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;wBAAE,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;;wBAC7C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC;gBACD,SAAS;YACX,CAAC;YACD,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC;YAClB,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC7B,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;YACjC,MAAM,CAAC,EAAE,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;YAC3C,SAAS;QACX,CAAC;QAED,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;AAC5B,CAAC;AAED,SAAS,YAAY,CAAC,GAAuB,EAAE,IAAiD;IAC9F,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACjC,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QACjG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;QACvB,OAAO;IACT,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,gGAAgG;AAChG,SAAS,OAAO,CAAC,MAAc,EAAE,KAAuB;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IACf,yEAAyE;IACzE,6DAA6D;IAC7D,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3E,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnE,MAAM,WAAW,GAAW,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC;YACzD,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;YAC9E,MAAM,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;YACtB,8EAA8E;YAC9E,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,IAAI,CAAC,KAAK;QAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC;IAClB,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,WAAW,CAAC,CAAiB,EAAE,CAAiB;IACvD,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,SAAS,CAAC,CAA4B,EAAE,CAA4B;IAC3E,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC5B,OAAO,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;AAC9F,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,mBAAmB,CAAC,MAAc;IAChD,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAW,CAAC,CAAC;YAC3C,IAAI,IAAI,EAAE,IAAI,KAAK,aAAa;gBAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;gBACnD,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACzD,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAW,CAAC,CAAC;YAC5C,IAAI,IAAI,EAAE,IAAI,KAAK,cAAc;gBAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;gBACpD,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrF,SAAS;QACX,CAAC;QACD,0EAA0E;QAC1E,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YACrC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAsB,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3F,CAAC,CAAC,cAAc;gBACd,CAAC,CAAC;oBACE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAsB;oBAC/E,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;iBAClD;gBACH,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,UAAU,CAAC,KAAyB;IAC3C,MAAM,GAAG,GAAuB,EAAE,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE;gBAAE,SAAS;YAC/B,YAAY,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;;YAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,oFAAoF;AAEpF,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,SAAS,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,kFAAkF;AAClF,SAAS,WAAW,CAAC,KAAkC;IACrD,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI,IAAI,GAAqB,EAAE,CAAC;IAChC,IAAI,IAAwB,CAAC;IAE7B,MAAM,YAAY,GAAG,CAAC,KAAa,EAAQ,EAAE;QAC3C,OAAO,IAAI,CAAC,MAAM,GAAG,KAAK;YAAE,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,EAAoB,CAAC,CAAC;IAClF,CAAC,CAAC;IACF,MAAM,SAAS,GAAG,GAAS,EAAE;QAC3B,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO;QAC/B,YAAY,CAAC,CAAC,CAAC,CAAC;QAChB,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC;QACpB,IAAI,GAAG,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE;YAAE,SAAS;QACvD,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1G,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,SAAS,EAAE,CAAC;YACZ,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,GAAG,IAAI,GAAG,CAAC;gBACX,IAAI,GAAG,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,OAAO,IAAI,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC;YAAE,IAAI,IAAI,CAAC,CAAC;QAC5F,YAAY,CAAC,IAAI,CAAC,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QACD,GAAG,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,IAAI,CAAC;IACtF,CAAC;IACD,SAAS,EAAE,CAAC;IACZ,YAAY,CAAC,CAAC,CAAC,CAAC;IAChB,IAAI,GAAG,EAAE,CAAC;IACV,OAAO,GAAG,CAAC;AACb,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,oBAAoB,CAAC,MAAkC;IACrE,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACxC,+DAA+D;YAC/D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC1F,SAAS;QACX,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAClC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,IAAI,CAAC;YAChF,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAc;IAClD,MAAM,MAAM,GAAG,CAAC,KAAkC,EAAU,EAAE;QAC5D,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,IAAI,IAAwB,CAAC;QAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBACxC,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC;gBACpB,IAAI,GAAG,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,IAAI,KAAK,SAAS;gBAAE,IAAI,GAAG,IAAI,CAAC;YACpC,GAAG,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,IAAI,CAAC;QAC1E,CAAC;QACD,IAAI,IAAI,KAAK,SAAS;YAAE,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC;QAC5C,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IACF,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;;YAEhE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAClC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CACjG,CAAC;IACN,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}
|
package/dist/returns.d.ts
CHANGED
|
@@ -114,6 +114,7 @@ export declare const returnCaseItemSchema: z.ZodObject<{
|
|
|
114
114
|
}>>;
|
|
115
115
|
defaultRefundAmount: z.ZodNumber;
|
|
116
116
|
approvedRefundAmount: z.ZodNumber;
|
|
117
|
+
returnableAtPurchase: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
117
118
|
}, z.core.$strip>;
|
|
118
119
|
export type ReturnCaseItemDto = z.infer<typeof returnCaseItemSchema>;
|
|
119
120
|
export declare const returnCaseCommentSchema: z.ZodObject<{
|
|
@@ -223,6 +224,7 @@ export declare const returnCaseDetailSchema: z.ZodObject<{
|
|
|
223
224
|
}>>;
|
|
224
225
|
defaultRefundAmount: z.ZodNumber;
|
|
225
226
|
approvedRefundAmount: z.ZodNumber;
|
|
227
|
+
returnableAtPurchase: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
226
228
|
}, z.core.$strip>>;
|
|
227
229
|
comments: z.ZodArray<z.ZodObject<{
|
|
228
230
|
id: z.ZodString;
|
|
@@ -252,6 +254,10 @@ export declare const returnableLineSchema: z.ZodObject<{
|
|
|
252
254
|
remainingReturnableQty: z.ZodNumber;
|
|
253
255
|
paidUnitAmount: z.ZodNumber;
|
|
254
256
|
currency: z.ZodString;
|
|
257
|
+
returnable: z.ZodBoolean;
|
|
258
|
+
notReturnableReason: z.ZodOptional<z.ZodEnum<{
|
|
259
|
+
product_not_returnable: "product_not_returnable";
|
|
260
|
+
}>>;
|
|
255
261
|
}, z.core.$strip>;
|
|
256
262
|
export declare const returnableResponseSchema: z.ZodObject<{
|
|
257
263
|
eligible: z.ZodBoolean;
|
|
@@ -259,6 +265,7 @@ export declare const returnableResponseSchema: z.ZodObject<{
|
|
|
259
265
|
order_not_completing: "order_not_completing";
|
|
260
266
|
window_passed: "window_passed";
|
|
261
267
|
fully_returned: "fully_returned";
|
|
268
|
+
no_returnable_lines: "no_returnable_lines";
|
|
262
269
|
}>>;
|
|
263
270
|
freeReturnEligible: z.ZodBoolean;
|
|
264
271
|
lines: z.ZodArray<z.ZodObject<{
|
|
@@ -269,6 +276,10 @@ export declare const returnableResponseSchema: z.ZodObject<{
|
|
|
269
276
|
remainingReturnableQty: z.ZodNumber;
|
|
270
277
|
paidUnitAmount: z.ZodNumber;
|
|
271
278
|
currency: z.ZodString;
|
|
279
|
+
returnable: z.ZodBoolean;
|
|
280
|
+
notReturnableReason: z.ZodOptional<z.ZodEnum<{
|
|
281
|
+
product_not_returnable: "product_not_returnable";
|
|
282
|
+
}>>;
|
|
272
283
|
}, z.core.$strip>>;
|
|
273
284
|
}, z.core.$strip>;
|
|
274
285
|
export type ReturnableResponse = z.infer<typeof returnableResponseSchema>;
|
|
@@ -638,6 +649,32 @@ export interface PaymentRefundResult {
|
|
|
638
649
|
export interface PaymentRefundPort {
|
|
639
650
|
refund(input: PaymentRefundInput): Promise<PaymentRefundResult>;
|
|
640
651
|
}
|
|
652
|
+
/**
|
|
653
|
+
* One money-moving resolution a settled return case recorded for an order
|
|
654
|
+
* (issue #428): a refund (`resolutionType: 'refund'`) or a credit-limit top-up
|
|
655
|
+
* (`'credit'`), its two-place amount, and whether it was issued.
|
|
656
|
+
*/
|
|
657
|
+
export interface OrderReturnRefund {
|
|
658
|
+
resolutionType: 'refund' | 'credit';
|
|
659
|
+
/** A two-place decimal string, as stored. */
|
|
660
|
+
amount: string;
|
|
661
|
+
settlementState: 'issued' | 'pending_manual' | 'failed';
|
|
662
|
+
}
|
|
663
|
+
/**
|
|
664
|
+
* Container name: `returnRefundReadPort`. Owner: `returns`.
|
|
665
|
+
*
|
|
666
|
+
* What the order's settled return cases refunded, so a reader that states what
|
|
667
|
+
* was paid for an order — the invoice — can count a refund that never passed
|
|
668
|
+
* through `payments`: a manual bank transfer for an order paid offline, or a
|
|
669
|
+
* credit-limit top-up. A gateway order's refunds also appear here, and the
|
|
670
|
+
* reader is the one that knows `payments` reports those (issue #428).
|
|
671
|
+
*
|
|
672
|
+
* **Owner off:** the seam fails closed — resolving this port throws
|
|
673
|
+
* `ModuleDisabledError`. A reader that may degrade decides presence first.
|
|
674
|
+
*/
|
|
675
|
+
export interface ReturnRefundReadPort {
|
|
676
|
+
listForOrder(orderId: string): Promise<OrderReturnRefund[]>;
|
|
677
|
+
}
|
|
641
678
|
/**
|
|
642
679
|
* A "credit toward future orders" resolution credits the customer's
|
|
643
680
|
* organisation credit limit, which `credit_limits` already grants and the
|
|
@@ -674,10 +711,24 @@ export interface OrderReturnContextLine {
|
|
|
674
711
|
productId: string;
|
|
675
712
|
name: string;
|
|
676
713
|
purchasedQty: number;
|
|
677
|
-
/**
|
|
714
|
+
/** The line's stored gross over its quantity, at four places — informational. */
|
|
678
715
|
paidUnitAmount: number;
|
|
679
|
-
/**
|
|
716
|
+
/**
|
|
717
|
+
* The line's gross as the order stored it (`lineTotal`), never recomputed
|
|
718
|
+
* (issue #417): what an order placed before 0.108.0 charged for the line, and
|
|
719
|
+
* the line's own rounding of its gross for one placed after.
|
|
720
|
+
*/
|
|
680
721
|
paidLineAmount: number;
|
|
722
|
+
/** The line's net unit price, as stored (a two-place decimal string). */
|
|
723
|
+
unitNetPrice: string;
|
|
724
|
+
/** The line's VAT rate as a fraction, as stored (`0.2300`). */
|
|
725
|
+
taxRate: string;
|
|
726
|
+
/**
|
|
727
|
+
* Feature 155 (FR-016a) — the product's returnable flag recorded when the order was placed.
|
|
728
|
+
* `null`: the order was placed before the flag was recorded. `orders` reports the fact; the
|
|
729
|
+
* policy for `null` (returnable, FR-025) is `returns`'.
|
|
730
|
+
*/
|
|
731
|
+
returnableAtPurchase: boolean | null;
|
|
681
732
|
}
|
|
682
733
|
export interface OrderReturnContext {
|
|
683
734
|
salesChannelId: string;
|
|
@@ -686,6 +737,21 @@ export interface OrderReturnContext {
|
|
|
686
737
|
currency: string;
|
|
687
738
|
/** When the order entered its fulfilment-completing status; null if it has not. */
|
|
688
739
|
completingStatusEnteredAt: Date | null;
|
|
740
|
+
/**
|
|
741
|
+
* The VAT method the order was placed under (issue #417): `per_rate` — VAT
|
|
742
|
+
* per rate on the sum of the nets — from 0.108.0; `null` before, when the
|
|
743
|
+
* stored totals followed the rule of their day. Decides how a return groups
|
|
744
|
+
* what was paid.
|
|
745
|
+
*/
|
|
746
|
+
vatMethod: 'per_rate' | null;
|
|
747
|
+
/**
|
|
748
|
+
* What the order charged for its products, as stored: subtotal + tax total −
|
|
749
|
+
* discount total (two places). The discount is taken off the gross without tax
|
|
750
|
+
* of its own; delivery and the payment surcharge are not products.
|
|
751
|
+
*/
|
|
752
|
+
productsPaidTotal: string;
|
|
753
|
+
/** The order-level discount, as stored (two places) — the part of it a return carries is credited back as a discount. */
|
|
754
|
+
discountTotal: string;
|
|
689
755
|
lines: OrderReturnContextLine[];
|
|
690
756
|
}
|
|
691
757
|
/**
|
|
@@ -716,6 +782,13 @@ export interface CorrectiveInvoiceLine {
|
|
|
716
782
|
quantity: number;
|
|
717
783
|
/** Credited amount for this line, gross (as paid, including its tax). */
|
|
718
784
|
amount: number;
|
|
785
|
+
/**
|
|
786
|
+
* The part of the order-level discount `amount` carries (issue #417). The
|
|
787
|
+
* invoice charged the goods in full and the discount on a 0 % line, so the
|
|
788
|
+
* correction credits the goods at `amount + discount` and the discount back on
|
|
789
|
+
* a 0 % line; it still totals `amount`. Absent: no discount.
|
|
790
|
+
*/
|
|
791
|
+
discount?: number;
|
|
719
792
|
}
|
|
720
793
|
export interface CorrectiveInvoiceInput {
|
|
721
794
|
orderId: string;
|
|
@@ -770,5 +843,11 @@ export type CorrectiveInvoiceResult = CorrectiveInvoiceIssued | CorrectiveInvoic
|
|
|
770
843
|
*/
|
|
771
844
|
export interface CorrectiveInvoicePort {
|
|
772
845
|
createCorrection(input: CorrectiveInvoiceInput): Promise<CorrectiveInvoiceResult>;
|
|
846
|
+
/**
|
|
847
|
+
* Refuse, writing nothing, what `createCorrection` would refuse for the same
|
|
848
|
+
* input (issue #417): a settlement asks before it moves any money, so a
|
|
849
|
+
* correction that cannot be made never follows a refund that was made.
|
|
850
|
+
*/
|
|
851
|
+
validateCorrection(input: CorrectiveInvoiceInput): Promise<void>;
|
|
773
852
|
}
|
|
774
853
|
//# sourceMappingURL=returns.d.ts.map
|
package/dist/returns.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"returns.d.ts","sourceRoot":"","sources":["../src/returns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"returns.d.ts","sourceRoot":"","sources":["../src/returns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;;;GAMG;AAMH,0EAA0E;AAC1E,eAAO,MAAM,gBAAgB;;;EAAkC,CAAC;AAChE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,iDAAiD;AACjD,eAAO,MAAM,oBAAoB;;;;;EAAwD,CAAC;AAC1F,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,mDAAmD;AACnD,eAAO,MAAM,qBAAqB;;;;EAAiD,CAAC;AACpF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,0CAA0C;AAC1C,eAAO,MAAM,sBAAsB;;;EAA+B,CAAC;AACnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,8CAA8C;AAC9C,eAAO,MAAM,uBAAuB;;;;EAA0C,CAAC;AAC/E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,oFAAoF;AACpF,eAAO,MAAM,sBAAsB,aAA4B,CAAC;AAMhE,eAAO,MAAM,kBAAkB;;;;;;;;;iBAS7B,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEjE,eAAO,MAAM,sBAAsB;;;;iBAIjC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEzE,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;iBAG1C,CAAC;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF,eAAO,MAAM,wBAAwB;;;;;;;iBAOnC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;iBAMnC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;iBAIrC,CAAC;AAMH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;iBAoB/B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAErE,eAAO,MAAM,uBAAuB;;;;;;;;;iBAMlC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE3E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;iBAUlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,8BAA8B;;;;EAAiD,CAAC;AAC7F,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF;;;;;;;;;GASG;AACH,eAAO,MAAM,iCAAiC;;;;;;;iBAI5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE5F,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAMtE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;iBAe/B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;iBAWnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;iBAexC,CAAC;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF,eAAO,MAAM,+BAA+B;;iBAAkD,CAAC;AAE/F,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;iBAMjC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAMzE,eAAO,MAAM,4BAA4B;;;iBAGvC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;iBAAoD,CAAC;AAE1F,eAAO,MAAM,4BAA4B;;;;iBAIvC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;iBAG/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMlE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;iBAYlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;iBAwBlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;;;;GAOG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;6BAW5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE5F,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;iBAajC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAMtE,eAAO,MAAM,0BAA0B;;;;;;iBAMrC,CAAC;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAEjF,eAAO,MAAM,gCAAgC;;;;;iBAK3C,CAAC;AAEH,eAAO,MAAM,gCAAgC;;;;iBAI3C,CAAC;AAEH,eAAO,MAAM,uCAAuC;;iBAElD,CAAC;AAEH,eAAO,MAAM,sCAAsC;;;;;;;iBAIjD,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;EAAqC,CAAC;AAEhF,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;iBAO/B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAErE,eAAO,MAAM,iCAAiC;;;;;;;iBAI5C,CAAC;AAMH,eAAO,MAAM,qBAAqB;;;;EAA0C,CAAC;AAE7E,eAAO,MAAM,kBAAkB;;;;;;;;;;iBAM7B,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEjE,eAAO,MAAM,wBAAwB;;;;;;;;;iBAKnC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;iBAKnC,CAAC;AAMH,eAAO,MAAM,sBAAsB;;;;;EAKjC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;iBAStC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;iBAIzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF,eAAO,MAAM,2BAA2B;;;;iBAItC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;iBAGrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,yBAAyB;;;;;;iBAGpC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;iBAOhC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEvE,eAAO,MAAM,2BAA2B;;;;;;;;;;;;iBAMtC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;iBAMtC,CAAC;AAiBH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,QAAQ,GAAG,gBAAgB,GAAG,QAAQ,CAAC;IAC9C,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACjE;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc,EAAE,QAAQ,GAAG,QAAQ,CAAC;IACpC,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,QAAQ,GAAG,gBAAgB,GAAG,QAAQ,CAAC;CACzD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;CAC7D;AAWD;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,YAAY,EAAE,MAAM,CAAC;IACrB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,yBAAyB,EAAE,IAAI,GAAG,IAAI,CAAC;IACvC;;;;;OAKG;IACH,SAAS,EAAE,UAAU,GAAG,IAAI,CAAC;IAC7B;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yHAAyH;IACzH,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,sBAAsB,EAAE,CAAC;CACjC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,sBAAsB;IACrC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,qBAAqB,EAAE,CAAC;IAC/B,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,+EAA+E;AAC/E,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,IAAI,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC;CAC3C;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,KAAK,CAAC;IACd,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,GAAG,uBAAuB,CAAC;AAExF;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAClF;;;;OAIG;IACH,kBAAkB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE"}
|
package/dist/returns.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
import { isoDateTimeSchema, uuidSchema } from './common.js';
|
|
3
|
+
import { twoDecimalAmount } from './money-input.js';
|
|
3
4
|
/**
|
|
4
5
|
* Returns & Complaints (Refunds, RMA) — feature 046.
|
|
5
6
|
*
|
|
@@ -76,6 +77,15 @@ export const returnCaseItemSchema = z.object({
|
|
|
76
77
|
inspectionOutcome: inspectionOutcomeSchema.nullable(),
|
|
77
78
|
defaultRefundAmount: z.number().finite(),
|
|
78
79
|
approvedRefundAmount: z.number().finite(),
|
|
80
|
+
/**
|
|
81
|
+
* Feature 155 (owner ruling R1) — whether the order line was returnable when
|
|
82
|
+
* it was bought, as recorded at placement (`OrderReturnContextLine`); `null`
|
|
83
|
+
* for a line placed before the record existed (treated as returnable) or one
|
|
84
|
+
* the order no longer lists. A complaint line recorded `false` starts with an
|
|
85
|
+
* approved refund of 0 and is marked in the admin case view. Optional on the
|
|
86
|
+
* wire, so an older producer still parses.
|
|
87
|
+
*/
|
|
88
|
+
returnableAtPurchase: z.boolean().nullable().optional(),
|
|
79
89
|
});
|
|
80
90
|
export const returnCaseCommentSchema = z.object({
|
|
81
91
|
id: uuidSchema,
|
|
@@ -152,10 +162,23 @@ export const returnableLineSchema = z.object({
|
|
|
152
162
|
remainingReturnableQty: z.number().int().nonnegative(),
|
|
153
163
|
paidUnitAmount: z.number().finite(),
|
|
154
164
|
currency: z.string().length(3),
|
|
165
|
+
/**
|
|
166
|
+
* Feature 155 — may this line be included in a `return` case? (complaints are never
|
|
167
|
+
* restricted). From the value recorded at placement; a line placed before the feature
|
|
168
|
+
* is returnable (FR-025).
|
|
169
|
+
*/
|
|
170
|
+
returnable: z.boolean(),
|
|
171
|
+
notReturnableReason: z.enum(['product_not_returnable']).optional(),
|
|
155
172
|
});
|
|
156
173
|
export const returnableResponseSchema = z.object({
|
|
174
|
+
/**
|
|
175
|
+
* `false` = no `return`-kind case can be opened. With `reason: 'no_returnable_lines'`
|
|
176
|
+
* (feature 155) a `complaint` is still accepted.
|
|
177
|
+
*/
|
|
157
178
|
eligible: z.boolean(),
|
|
158
|
-
reason: z
|
|
179
|
+
reason: z
|
|
180
|
+
.enum(['order_not_completing', 'window_passed', 'fully_returned', 'no_returnable_lines'])
|
|
181
|
+
.optional(),
|
|
159
182
|
freeReturnEligible: z.boolean(),
|
|
160
183
|
lines: z.array(returnableLineSchema),
|
|
161
184
|
});
|
|
@@ -221,8 +244,20 @@ export const settlementRequestSchema = z.object({
|
|
|
221
244
|
lines: z
|
|
222
245
|
.array(z.object({
|
|
223
246
|
returnCaseItemId: uuidSchema,
|
|
224
|
-
approvedRefundAmount: z.number().finite().nonnegative(),
|
|
247
|
+
approvedRefundAmount: twoDecimalAmount(z.number().finite().nonnegative()),
|
|
225
248
|
}))
|
|
249
|
+
// A case line named twice is refused before anything moves (issue #417,
|
|
250
|
+
// review of PR #423): the refund would sum both entries and the correction
|
|
251
|
+
// keep one, refusing only after the gateway had refunded.
|
|
252
|
+
.superRefine((lines, ctx) => {
|
|
253
|
+
const seen = new Set();
|
|
254
|
+
lines.forEach((line, index) => {
|
|
255
|
+
if (seen.has(line.returnCaseItemId)) {
|
|
256
|
+
ctx.addIssue({ code: 'custom', path: [index, 'returnCaseItemId'], message: 'duplicate_line' });
|
|
257
|
+
}
|
|
258
|
+
seen.add(line.returnCaseItemId);
|
|
259
|
+
});
|
|
260
|
+
})
|
|
226
261
|
.default([]),
|
|
227
262
|
refundPaymentMethodId: uuidSchema.optional(),
|
|
228
263
|
createCorrectiveInvoice: z.boolean().optional(),
|
|
@@ -273,12 +308,12 @@ export const returnDeliveryMethodSchema = z.object({
|
|
|
273
308
|
});
|
|
274
309
|
export const returnDeliveryMethodCreateSchema = z.object({
|
|
275
310
|
deliveryMethodId: uuidSchema,
|
|
276
|
-
returnCost: z.number().finite().nonnegative(),
|
|
311
|
+
returnCost: twoDecimalAmount(z.number().finite().nonnegative()),
|
|
277
312
|
currency: z.string().length(3),
|
|
278
313
|
isActive: z.boolean().optional(),
|
|
279
314
|
});
|
|
280
315
|
export const returnDeliveryMethodUpdateSchema = z.object({
|
|
281
|
-
returnCost: z.number().finite().nonnegative().optional(),
|
|
316
|
+
returnCost: twoDecimalAmount(z.number().finite().nonnegative()).optional(),
|
|
282
317
|
currency: z.string().length(3).optional(),
|
|
283
318
|
isActive: z.boolean().optional(),
|
|
284
319
|
});
|