@endora-commerce/contracts 0.109.0 → 0.111.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/accept-language.d.ts +31 -0
- package/dist/accept-language.js +64 -0
- package/dist/actor.d.ts +16 -0
- package/dist/addresses.d.ts +35 -0
- package/dist/addresses.js +8 -1
- package/dist/admin-actions.d.ts +2 -0
- package/dist/admin-actions.js +18 -0
- package/dist/admin-contributions.d.ts +99 -12
- package/dist/admin-contributions.js +36 -10
- package/dist/admin-roles.d.ts +17 -2
- package/dist/admin-users.d.ts +9 -0
- package/dist/admin.d.ts +114 -4
- package/dist/admin.js +98 -3
- package/dist/api-keys.d.ts +22 -0
- package/dist/api-keys.js +4 -0
- package/dist/assets-library.d.ts +45 -0
- package/dist/assets-library.js +20 -3
- package/dist/audit-logs.d.ts +12 -0
- package/dist/audit-logs.js +12 -0
- package/dist/auth.d.ts +9 -0
- package/dist/auth.js +9 -0
- package/dist/blog.d.ts +382 -22
- package/dist/blog.js +199 -17
- package/dist/carts.d.ts +423 -36
- package/dist/carts.js +150 -12
- package/dist/catalog.d.ts +379 -208
- package/dist/catalog.js +241 -163
- package/dist/cms-brand.d.ts +14 -14
- package/dist/cms.d.ts +71 -16
- package/dist/cms.js +15 -0
- package/dist/command-hooks.d.ts +301 -0
- package/dist/command-hooks.js +248 -0
- package/dist/common.d.ts +23 -6
- package/dist/common.js +25 -2
- package/dist/comparisons.d.ts +21 -14
- package/dist/comparisons.js +2 -1
- package/dist/credit-limits.d.ts +22 -0
- package/dist/credit-limits.js +35 -0
- package/dist/crm.d.ts +134 -78
- package/dist/crm.js +21 -5
- package/dist/custom-fields.d.ts +417 -49
- package/dist/custom-fields.js +142 -1
- package/dist/customer-accounts.d.ts +324 -22
- package/dist/customer-accounts.js +43 -0
- package/dist/customer-notifications.d.ts +143 -0
- package/dist/customer-notifications.js +41 -0
- package/dist/customers.d.ts +92 -73
- package/dist/customers.js +98 -10
- package/dist/dictionary.d.ts +53 -0
- package/dist/dictionary.js +25 -0
- package/dist/document-templates.d.ts +12 -12
- package/dist/email.d.ts +34 -0
- package/dist/email.js +6 -0
- package/dist/errors.d.ts +431 -3
- package/dist/errors.js +523 -3
- package/dist/forms-logic.d.ts +79 -0
- package/dist/forms-logic.fixtures.d.ts +52 -0
- package/dist/forms-logic.fixtures.js +610 -0
- package/dist/forms-logic.js +699 -0
- package/dist/forms.d.ts +9833 -0
- package/dist/forms.js +827 -0
- package/dist/i18n.d.ts +34 -0
- package/dist/i18n.js +15 -0
- package/dist/import-export.d.ts +180 -0
- package/dist/import-export.js +60 -0
- package/dist/index.d.ts +16 -1
- package/dist/index.js +30 -1
- package/dist/inventory.d.ts +9 -9
- package/dist/invoice-ledger.d.ts +13 -13
- package/dist/invoices.d.ts +126 -0
- package/dist/invoices.js +53 -0
- package/dist/line-bounds.d.ts +53 -0
- package/dist/line-bounds.js +65 -0
- package/dist/megamenu.d.ts +27 -27
- package/dist/mfa.d.ts +210 -4
- package/dist/mfa.js +136 -0
- package/dist/modules.d.ts +56 -8
- package/dist/modules.js +128 -3
- package/dist/money-decimal.d.ts +54 -0
- package/dist/money-decimal.js +95 -0
- package/dist/newsletter.d.ts +4 -4
- package/dist/orders.d.ts +246 -12
- package/dist/orders.js +140 -7
- package/dist/organization-hooks.d.ts +99 -0
- package/dist/organization-hooks.js +22 -0
- package/dist/organization-registry-lookup.d.ts +362 -0
- package/dist/organization-registry-lookup.js +196 -0
- package/dist/organization-roles.d.ts +341 -0
- package/dist/organization-roles.js +218 -0
- package/dist/organizations.d.ts +1074 -103
- package/dist/organizations.js +293 -28
- package/dist/page-builder-props.d.ts +56 -56
- package/dist/pim-connector.d.ts +7 -3
- package/dist/pim-connector.js +6 -2
- package/dist/pim-field-path.d.ts +5 -1
- package/dist/pim-field-path.js +37 -81
- package/dist/pim-locale-mapping.d.ts +131 -0
- package/dist/pim-locale-mapping.js +193 -0
- package/dist/price-books.d.ts +215 -63
- package/dist/price-books.js +47 -2
- package/dist/price-lists.d.ts +13 -10
- package/dist/product-feeds.d.ts +249 -100
- package/dist/product-feeds.js +46 -2
- package/dist/product-scope-model.d.ts +161 -0
- package/dist/product-scope-model.js +161 -0
- package/dist/product-scope-overrides.d.ts +0 -103
- package/dist/product-scope-overrides.js +0 -54
- package/dist/product-scoped-values.d.ts +2610 -0
- package/dist/product-scoped-values.js +425 -0
- package/dist/product-scopes.d.ts +199 -64
- package/dist/product-scopes.js +120 -23
- package/dist/product-tax-rates.d.ts +38 -0
- package/dist/product-tax-rates.js +45 -0
- package/dist/product-url-keys.d.ts +51 -45
- package/dist/product-url-keys.js +73 -39
- package/dist/product-value-resolver.d.ts +37 -60
- package/dist/product-value-resolver.js +36 -96
- package/dist/projects.d.ts +76 -28
- package/dist/projects.js +53 -9
- package/dist/promotions.d.ts +163 -11
- package/dist/promotions.js +23 -1
- package/dist/pwa.d.ts +41 -2
- package/dist/quick-order.d.ts +159 -9
- package/dist/quick-order.js +79 -4
- package/dist/quote-requests.d.ts +231 -17
- package/dist/quote-requests.js +111 -9
- package/dist/record-references.d.ts +15 -15
- package/dist/record-references.js +2 -3
- package/dist/record-rich-text.js +2 -1
- package/dist/returns.d.ts +214 -52
- package/dist/returns.js +143 -28
- package/dist/sales-channels.d.ts +34 -3
- package/dist/sales-channels.js +16 -1
- package/dist/saved-list-views.d.ts +28 -0
- package/dist/saved-list-views.js +14 -1
- package/dist/schema-extensions.d.ts +36 -0
- package/dist/schema-extensions.js +29 -0
- package/dist/scoped-write-encoding.d.ts +100 -0
- package/dist/scoped-write-encoding.js +135 -0
- package/dist/search.d.ts +18 -16
- package/dist/seo.d.ts +83 -30
- package/dist/seo.js +8 -1
- package/dist/settings.d.ts +173 -2
- package/dist/settings.js +53 -2
- package/dist/shopping-lists.d.ts +63 -4
- package/dist/shopping-lists.js +57 -3
- package/dist/storefront-cache-tags.d.ts +22 -0
- package/dist/storefront-cache-tags.js +12 -0
- package/dist/storefront-value-overrides.d.ts +18 -56
- package/dist/storefront-value-overrides.js +11 -86
- package/dist/tasks.d.ts +27 -27
- package/dist/taxes.d.ts +27 -0
- package/dist/taxes.js +4 -0
- package/dist/transactional-emails.d.ts +48 -22
- package/dist/webhooks.d.ts +75 -0
- package/dist/webhooks.js +24 -0
- package/package.json +5 -3
- package/dist/actor.d.ts.map +0 -1
- package/dist/actor.js.map +0 -1
- package/dist/addresses.d.ts.map +0 -1
- package/dist/addresses.js.map +0 -1
- package/dist/admin-actions.d.ts.map +0 -1
- package/dist/admin-actions.js.map +0 -1
- package/dist/admin-contributions.d.ts.map +0 -1
- package/dist/admin-contributions.js.map +0 -1
- package/dist/admin-feedback.d.ts.map +0 -1
- package/dist/admin-feedback.js.map +0 -1
- package/dist/admin-i18n.d.ts.map +0 -1
- package/dist/admin-i18n.js.map +0 -1
- package/dist/admin-name.d.ts.map +0 -1
- package/dist/admin-name.js.map +0 -1
- package/dist/admin-notifications.d.ts.map +0 -1
- package/dist/admin-notifications.js.map +0 -1
- package/dist/admin-preferences.d.ts.map +0 -1
- package/dist/admin-preferences.js.map +0 -1
- package/dist/admin-roles.d.ts.map +0 -1
- package/dist/admin-roles.js.map +0 -1
- package/dist/admin-search.d.ts.map +0 -1
- package/dist/admin-search.js.map +0 -1
- package/dist/admin-users.d.ts.map +0 -1
- package/dist/admin-users.js.map +0 -1
- package/dist/admin.d.ts.map +0 -1
- package/dist/admin.js.map +0 -1
- package/dist/analytics.d.ts.map +0 -1
- package/dist/analytics.js.map +0 -1
- package/dist/api-keys.d.ts.map +0 -1
- package/dist/api-keys.js.map +0 -1
- package/dist/assets-library.d.ts.map +0 -1
- package/dist/assets-library.js.map +0 -1
- package/dist/audit-logs.d.ts.map +0 -1
- package/dist/audit-logs.js.map +0 -1
- package/dist/auth.d.ts.map +0 -1
- package/dist/auth.js.map +0 -1
- package/dist/blog.d.ts.map +0 -1
- package/dist/blog.js.map +0 -1
- package/dist/capabilities.d.ts.map +0 -1
- package/dist/capabilities.js.map +0 -1
- package/dist/carts.d.ts.map +0 -1
- package/dist/carts.js.map +0 -1
- package/dist/catalog.d.ts.map +0 -1
- package/dist/catalog.js.map +0 -1
- package/dist/cms-brand.d.ts.map +0 -1
- package/dist/cms-brand.js.map +0 -1
- package/dist/cms-contact-form.d.ts.map +0 -1
- package/dist/cms-contact-form.js.map +0 -1
- package/dist/cms.d.ts.map +0 -1
- package/dist/cms.js.map +0 -1
- package/dist/common.d.ts.map +0 -1
- package/dist/common.js.map +0 -1
- package/dist/comparisons.d.ts.map +0 -1
- package/dist/comparisons.js.map +0 -1
- package/dist/credentials.d.ts.map +0 -1
- package/dist/credentials.js.map +0 -1
- package/dist/credit-limits.d.ts.map +0 -1
- package/dist/credit-limits.js.map +0 -1
- package/dist/crm-rich-text.d.ts.map +0 -1
- package/dist/crm-rich-text.js.map +0 -1
- package/dist/crm.d.ts.map +0 -1
- package/dist/crm.js.map +0 -1
- package/dist/currencies.d.ts.map +0 -1
- package/dist/currencies.js.map +0 -1
- package/dist/custom-fields.d.ts.map +0 -1
- package/dist/custom-fields.js.map +0 -1
- package/dist/customer-accounts.d.ts.map +0 -1
- package/dist/customer-accounts.js.map +0 -1
- package/dist/customers.d.ts.map +0 -1
- package/dist/customers.js.map +0 -1
- package/dist/dictionary.d.ts.map +0 -1
- package/dist/dictionary.js.map +0 -1
- package/dist/document-templates.d.ts.map +0 -1
- package/dist/document-templates.js.map +0 -1
- package/dist/document-values.d.ts.map +0 -1
- package/dist/document-values.js.map +0 -1
- package/dist/email-address.d.ts.map +0 -1
- package/dist/email-address.js.map +0 -1
- package/dist/email.d.ts.map +0 -1
- package/dist/email.js.map +0 -1
- package/dist/envelopes.d.ts.map +0 -1
- package/dist/envelopes.js.map +0 -1
- package/dist/environment-inputs.d.ts.map +0 -1
- package/dist/environment-inputs.js.map +0 -1
- package/dist/erp-connector.d.ts.map +0 -1
- package/dist/erp-connector.js.map +0 -1
- package/dist/errors.d.ts.map +0 -1
- package/dist/errors.js.map +0 -1
- package/dist/google-analytics.d.ts.map +0 -1
- package/dist/google-analytics.js.map +0 -1
- package/dist/google-tag-manager.d.ts.map +0 -1
- package/dist/google-tag-manager.js.map +0 -1
- package/dist/i18n.d.ts.map +0 -1
- package/dist/i18n.js.map +0 -1
- package/dist/import-export.d.ts.map +0 -1
- package/dist/import-export.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/inventory.d.ts.map +0 -1
- package/dist/inventory.js.map +0 -1
- package/dist/invoice-ledger.d.ts.map +0 -1
- package/dist/invoice-ledger.js.map +0 -1
- package/dist/invoices.d.ts.map +0 -1
- package/dist/invoices.js.map +0 -1
- package/dist/kernel.d.ts.map +0 -1
- package/dist/kernel.js.map +0 -1
- package/dist/languages.d.ts.map +0 -1
- package/dist/languages.js.map +0 -1
- package/dist/line-groups.d.ts.map +0 -1
- package/dist/line-groups.js.map +0 -1
- package/dist/linkedin-ads.d.ts.map +0 -1
- package/dist/linkedin-ads.js.map +0 -1
- package/dist/localized-name.d.ts.map +0 -1
- package/dist/localized-name.js.map +0 -1
- package/dist/megamenu.d.ts.map +0 -1
- package/dist/megamenu.js.map +0 -1
- package/dist/meta-ads.d.ts.map +0 -1
- package/dist/meta-ads.js.map +0 -1
- package/dist/mfa.d.ts.map +0 -1
- package/dist/mfa.js.map +0 -1
- package/dist/modules.d.ts.map +0 -1
- package/dist/modules.js.map +0 -1
- package/dist/money-decimal.d.ts.map +0 -1
- package/dist/money-decimal.js.map +0 -1
- package/dist/money-input.d.ts.map +0 -1
- package/dist/money-input.js.map +0 -1
- package/dist/newsletter.d.ts.map +0 -1
- package/dist/newsletter.js.map +0 -1
- package/dist/order-minimums.d.ts.map +0 -1
- package/dist/order-minimums.js.map +0 -1
- package/dist/orders.d.ts.map +0 -1
- package/dist/orders.js.map +0 -1
- package/dist/organizations.d.ts.map +0 -1
- package/dist/organizations.js.map +0 -1
- package/dist/page-builder-props.d.ts.map +0 -1
- package/dist/page-builder-props.js.map +0 -1
- package/dist/page-builder-values.d.ts.map +0 -1
- package/dist/page-builder-values.js.map +0 -1
- package/dist/pagination.d.ts.map +0 -1
- package/dist/pagination.js.map +0 -1
- package/dist/payment-methods.d.ts.map +0 -1
- package/dist/payment-methods.js.map +0 -1
- package/dist/payment-return-url.d.ts.map +0 -1
- package/dist/payment-return-url.js.map +0 -1
- package/dist/payments.d.ts.map +0 -1
- package/dist/payments.js.map +0 -1
- package/dist/pim-connector.d.ts.map +0 -1
- package/dist/pim-connector.js.map +0 -1
- package/dist/pim-field-path.d.ts.map +0 -1
- package/dist/pim-field-path.js.map +0 -1
- package/dist/platform-info.d.ts.map +0 -1
- package/dist/platform-info.js.map +0 -1
- package/dist/platform-language.d.ts.map +0 -1
- package/dist/platform-language.js.map +0 -1
- package/dist/price-book-decimal.d.ts.map +0 -1
- package/dist/price-book-decimal.js.map +0 -1
- package/dist/price-books.d.ts.map +0 -1
- package/dist/price-books.js.map +0 -1
- package/dist/price-lists.d.ts.map +0 -1
- package/dist/price-lists.js.map +0 -1
- package/dist/product-feeds.d.ts.map +0 -1
- package/dist/product-feeds.js.map +0 -1
- package/dist/product-scope-overrides.d.ts.map +0 -1
- package/dist/product-scope-overrides.js.map +0 -1
- package/dist/product-scopes.d.ts.map +0 -1
- package/dist/product-scopes.js.map +0 -1
- package/dist/product-summary-text.d.ts.map +0 -1
- package/dist/product-summary-text.js.map +0 -1
- package/dist/product-url-keys.d.ts.map +0 -1
- package/dist/product-url-keys.js.map +0 -1
- package/dist/product-value-resolver.d.ts.map +0 -1
- package/dist/product-value-resolver.js.map +0 -1
- package/dist/projects.d.ts.map +0 -1
- package/dist/projects.js.map +0 -1
- package/dist/promotions.d.ts.map +0 -1
- package/dist/promotions.js.map +0 -1
- package/dist/prompt-actions.d.ts.map +0 -1
- package/dist/prompt-actions.js.map +0 -1
- package/dist/pwa.d.ts.map +0 -1
- package/dist/pwa.js.map +0 -1
- package/dist/quick-order.d.ts.map +0 -1
- package/dist/quick-order.js.map +0 -1
- package/dist/quote-requests.d.ts.map +0 -1
- package/dist/quote-requests.js.map +0 -1
- package/dist/record-references.d.ts.map +0 -1
- package/dist/record-references.js.map +0 -1
- package/dist/record-rich-text.d.ts.map +0 -1
- package/dist/record-rich-text.js.map +0 -1
- package/dist/returns.d.ts.map +0 -1
- package/dist/returns.js.map +0 -1
- package/dist/sales-channels.d.ts.map +0 -1
- package/dist/sales-channels.js.map +0 -1
- package/dist/saved-list-views.d.ts.map +0 -1
- package/dist/saved-list-views.js.map +0 -1
- package/dist/scope-notice.d.ts.map +0 -1
- package/dist/scope-notice.js.map +0 -1
- package/dist/scoped-translations.d.ts +0 -48
- package/dist/scoped-translations.d.ts.map +0 -1
- package/dist/scoped-translations.js +0 -78
- package/dist/scoped-translations.js.map +0 -1
- package/dist/search.d.ts.map +0 -1
- package/dist/search.js.map +0 -1
- package/dist/seo.d.ts.map +0 -1
- package/dist/seo.js.map +0 -1
- package/dist/settings.d.ts.map +0 -1
- package/dist/settings.js.map +0 -1
- package/dist/shipments.d.ts.map +0 -1
- package/dist/shipments.js.map +0 -1
- package/dist/shipping-methods.d.ts.map +0 -1
- package/dist/shipping-methods.js.map +0 -1
- package/dist/shopping-lists.d.ts.map +0 -1
- package/dist/shopping-lists.js.map +0 -1
- package/dist/storefront-cache-tags.d.ts.map +0 -1
- package/dist/storefront-cache-tags.js.map +0 -1
- package/dist/storefront-language-path.d.ts.map +0 -1
- package/dist/storefront-language-path.js.map +0 -1
- package/dist/storefront-value-overrides.d.ts.map +0 -1
- package/dist/storefront-value-overrides.js.map +0 -1
- package/dist/tasks.d.ts.map +0 -1
- package/dist/tasks.js.map +0 -1
- package/dist/taxes.d.ts.map +0 -1
- package/dist/taxes.js.map +0 -1
- package/dist/text-normalization.d.ts.map +0 -1
- package/dist/text-normalization.js.map +0 -1
- package/dist/transactional-emails.d.ts.map +0 -1
- package/dist/transactional-emails.js.map +0 -1
- package/dist/webhooks.d.ts.map +0 -1
- package/dist/webhooks.js.map +0 -1
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
import { type answerValueSchema, type FormDefinition, type FormDefinitionIssue, type FormFieldErrorCode, type FormFieldType, type VisibilityRule } from './forms.js';
|
|
3
|
+
/**
|
|
4
|
+
* The forms evaluator (`specs/170-forms-module/contracts/form-definition.md` §2–§3): visibility,
|
|
5
|
+
* the publish rules, server-authoritative validation, text resolution and the small helpers the
|
|
6
|
+
* entry pipeline shares. **Pure and browser-safe** — no Node built-in, no I/O — because the backend,
|
|
7
|
+
* the storefront renderer and the admin preview must evaluate one implementation (research R-5);
|
|
8
|
+
* the shared fixture set beside this file is run by all three (B12).
|
|
9
|
+
*/
|
|
10
|
+
export type AnswerValue = z.infer<typeof answerValueSchema>;
|
|
11
|
+
/** A visible consent as the shopper answered it; the server attaches the text shown (B11). */
|
|
12
|
+
export interface ConsentInput {
|
|
13
|
+
fieldKey: string;
|
|
14
|
+
kind: 'privacy' | 'marketing' | 'terms';
|
|
15
|
+
given: boolean;
|
|
16
|
+
}
|
|
17
|
+
export interface SubmissionContext {
|
|
18
|
+
/** Validates a country code; the server passes the dictionary check, the client a set lookup. */
|
|
19
|
+
isKnownCountry(code: string): boolean;
|
|
20
|
+
/** "Now" for date bounds that are relative — none in Phase 1; reserved for determinism in tests. */
|
|
21
|
+
now?: Date;
|
|
22
|
+
}
|
|
23
|
+
export type SubmissionResult = {
|
|
24
|
+
ok: true;
|
|
25
|
+
answers: Record<string, AnswerValue>;
|
|
26
|
+
consents: ConsentInput[];
|
|
27
|
+
} | {
|
|
28
|
+
ok: false;
|
|
29
|
+
errors: {
|
|
30
|
+
fieldKey: string;
|
|
31
|
+
code: FormFieldErrorCode;
|
|
32
|
+
}[];
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* The part of a definition visibility reads. Structural, so the storefront renderer can evaluate
|
|
36
|
+
* the **public** read (whose fields carry the same ids, keys, types and rules) with this function.
|
|
37
|
+
*/
|
|
38
|
+
export interface VisibilitySource {
|
|
39
|
+
readonly sections: readonly {
|
|
40
|
+
readonly id: string;
|
|
41
|
+
readonly visibility?: VisibilityRule | undefined;
|
|
42
|
+
readonly fields: readonly {
|
|
43
|
+
readonly id: string;
|
|
44
|
+
readonly type: FormFieldType;
|
|
45
|
+
readonly key?: string;
|
|
46
|
+
readonly visibility?: VisibilityRule | undefined;
|
|
47
|
+
}[];
|
|
48
|
+
}[];
|
|
49
|
+
}
|
|
50
|
+
/** Element ids visible for these answers (sections and fields), FR-030–FR-032. */
|
|
51
|
+
export declare function visibleElements(definition: VisibilitySource, answers: Readonly<Record<string, unknown>>): {
|
|
52
|
+
sections: ReadonlySet<string>;
|
|
53
|
+
fields: ReadonlySet<string>;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* The publish-time rules; `[]` = publishable (data-model §3.5, FR-011, FR-033). The default
|
|
57
|
+
* language is the form row's (it is live, not part of the definition), so it is passed in.
|
|
58
|
+
*/
|
|
59
|
+
export declare function definitionIssues(definition: FormDefinition, defaultLanguage: string): FormDefinitionIssue[];
|
|
60
|
+
/**
|
|
61
|
+
* Server-authoritative validation of raw posted values against a version: drops values of hidden
|
|
62
|
+
* and unknown fields, coerces by type, applies required/limits/patterns, and returns either the
|
|
63
|
+
* normalised answers + consents or per-field errors. FR-032, FR-034, FR-036.
|
|
64
|
+
*/
|
|
65
|
+
export declare function validateSubmission(definition: FormDefinition, raw: Readonly<Record<string, string | readonly string[]>>, ctx: SubmissionContext): SubmissionResult;
|
|
66
|
+
/** Texts for one language with the R-7 fallback; built-ins are the caller's. */
|
|
67
|
+
export declare function resolveTexts(definition: Pick<FormDefinition, 'texts'>, language: string, defaultLanguage: string): (textId: string) => string | undefined;
|
|
68
|
+
/** Per language, the text ids that fall back to the default language. FR-018, US7-2. */
|
|
69
|
+
export declare function textCompleteness(definition: FormDefinition, languages: readonly string[], defaultLanguage: string): {
|
|
70
|
+
language: string;
|
|
71
|
+
missing: string[];
|
|
72
|
+
}[];
|
|
73
|
+
/** The answers that `shareWithIntegrations` fields of this version expose. FR-064. */
|
|
74
|
+
export declare function sharedAnswers(definition: FormDefinition, answers: Readonly<Record<string, AnswerValue>>): Record<string, AnswerValue>;
|
|
75
|
+
/** Text answers joined for search, lower-cased, capped. R-18 (hidden values excluded). */
|
|
76
|
+
export declare function searchTextOf(definition: FormDefinition, answers: Readonly<Record<string, AnswerValue>>): string;
|
|
77
|
+
/** One CSV-safe cell: prefixes =, +, -, @, TAB, CR with an apostrophe. R-18. */
|
|
78
|
+
export declare function neutraliseSpreadsheetCell(value: string): string;
|
|
79
|
+
//# sourceMappingURL=forms-logic.d.ts.map
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import type { FormDefinitionInput, FormFieldErrorCode } from './forms.js';
|
|
2
|
+
import type { AnswerValue, ConsentInput } from './forms-logic.js';
|
|
3
|
+
/**
|
|
4
|
+
* The shared fixture set of the forms evaluator (`specs/170-forms-module/contracts/form-definition.md`
|
|
5
|
+
* B12). **Plain data**: no test runner is imported, so the same file is run by the contracts suite
|
|
6
|
+
* (`forms-logic.test.ts`), by `mod-forms`' submission tests and by `cms-components`' block-state
|
|
7
|
+
* test — three consumers, one expectation, which is what makes "the client and the server agree" a
|
|
8
|
+
* fact rather than a hope.
|
|
9
|
+
*
|
|
10
|
+
* A definition is written in the schema's **input** shape (`FormDefinitionInput`) and parsed by
|
|
11
|
+
* the consumer with `formDefinitionSchema.parse`, so the defaults (`width`, `required`,
|
|
12
|
+
* `shareWithIntegrations`) are the schema's and not restated here.
|
|
13
|
+
*/
|
|
14
|
+
/** One visibility case: the answers given and the element ids that must be visible. */
|
|
15
|
+
export interface FormsVisibilityFixture {
|
|
16
|
+
readonly name: string;
|
|
17
|
+
/** The behaviour line of form-definition.md §3 this case holds. */
|
|
18
|
+
readonly behaviour: string;
|
|
19
|
+
readonly definition: FormDefinitionInput;
|
|
20
|
+
readonly answers: Readonly<Record<string, unknown>>;
|
|
21
|
+
readonly expected: {
|
|
22
|
+
readonly sections: readonly string[];
|
|
23
|
+
readonly fields: readonly string[];
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
/** One submission case: the raw posted values and the server's verdict. */
|
|
27
|
+
export interface FormsSubmissionFixture {
|
|
28
|
+
readonly name: string;
|
|
29
|
+
readonly behaviour: string;
|
|
30
|
+
readonly definition: FormDefinitionInput;
|
|
31
|
+
readonly raw: Readonly<Record<string, string | readonly string[]>>;
|
|
32
|
+
/** The country codes the context's `isKnownCountry` accepts. */
|
|
33
|
+
readonly knownCountries: readonly string[];
|
|
34
|
+
readonly expected: {
|
|
35
|
+
readonly ok: true;
|
|
36
|
+
readonly answers: Readonly<Record<string, AnswerValue>>;
|
|
37
|
+
readonly consents: readonly ConsentInput[];
|
|
38
|
+
} | {
|
|
39
|
+
readonly ok: false;
|
|
40
|
+
readonly errors: readonly {
|
|
41
|
+
fieldKey: string;
|
|
42
|
+
code: FormFieldErrorCode;
|
|
43
|
+
}[];
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
type SectionInput = FormDefinitionInput['sections'][number];
|
|
47
|
+
/** A definition with the neutral behaviour and restrictions; only the sections vary. */
|
|
48
|
+
export declare function fixtureDefinition(sections: readonly SectionInput[], texts?: FormDefinitionInput['texts']): FormDefinitionInput;
|
|
49
|
+
export declare const FORMS_VISIBILITY_FIXTURES: readonly FormsVisibilityFixture[];
|
|
50
|
+
export declare const FORMS_SUBMISSION_FIXTURES: readonly FormsSubmissionFixture[];
|
|
51
|
+
export {};
|
|
52
|
+
//# sourceMappingURL=forms-logic.fixtures.d.ts.map
|