@endora-commerce/contracts 0.110.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/admin-actions.d.ts +2 -0
- package/dist/admin-actions.js +18 -0
- package/dist/admin-contributions.d.ts +37 -5
- package/dist/admin-contributions.js +9 -2
- package/dist/admin-roles.d.ts +9 -0
- package/dist/admin.d.ts +37 -0
- package/dist/admin.js +19 -0
- package/dist/api-keys.d.ts +22 -0
- package/dist/api-keys.js +4 -0
- package/dist/assets-library.d.ts +19 -0
- package/dist/assets-library.js +14 -0
- package/dist/auth.d.ts +9 -0
- package/dist/auth.js +9 -0
- package/dist/carts.d.ts +30 -1
- package/dist/carts.js +20 -5
- package/dist/catalog.d.ts +61 -22
- package/dist/catalog.js +32 -6
- package/dist/cms.d.ts +33 -3
- package/dist/cms.js +15 -0
- package/dist/command-hooks.d.ts +301 -0
- package/dist/command-hooks.js +248 -0
- package/dist/comparisons.d.ts +14 -14
- package/dist/credit-limits.d.ts +21 -0
- package/dist/credit-limits.js +21 -0
- package/dist/crm.d.ts +81 -55
- package/dist/crm.js +15 -5
- package/dist/custom-fields.d.ts +403 -49
- package/dist/custom-fields.js +127 -0
- package/dist/customer-accounts.d.ts +138 -0
- package/dist/customer-accounts.js +4 -0
- package/dist/customer-notifications.d.ts +143 -0
- package/dist/customer-notifications.js +41 -0
- package/dist/customers.d.ts +52 -0
- package/dist/customers.js +53 -0
- package/dist/dictionary.d.ts +53 -0
- package/dist/dictionary.js +25 -0
- package/dist/document-templates.d.ts +4 -4
- package/dist/email.d.ts +34 -0
- package/dist/email.js +6 -0
- package/dist/errors.d.ts +312 -2
- package/dist/errors.js +377 -2
- package/dist/forms.d.ts +88 -88
- package/dist/i18n.d.ts +34 -0
- package/dist/i18n.js +15 -0
- package/dist/index.d.ts +7 -1
- package/dist/index.js +12 -1
- package/dist/invoice-ledger.d.ts +6 -6
- package/dist/invoices.d.ts +126 -0
- package/dist/invoices.js +49 -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 +86 -0
- package/dist/mfa.js +90 -0
- package/dist/modules.d.ts +21 -5
- package/dist/modules.js +60 -3
- package/dist/orders.d.ts +141 -0
- package/dist/orders.js +80 -3
- package/dist/organization-hooks.d.ts +99 -0
- package/dist/organization-hooks.js +22 -0
- package/dist/organization-registry-lookup.d.ts +5 -5
- package/dist/organization-roles.d.ts +1 -0
- package/dist/organization-roles.js +7 -0
- package/dist/organizations.d.ts +954 -17
- package/dist/organizations.js +229 -8
- package/dist/price-books.d.ts +173 -25
- package/dist/price-books.js +41 -0
- package/dist/price-lists.d.ts +5 -2
- package/dist/product-feeds.d.ts +157 -8
- package/dist/product-feeds.js +41 -2
- package/dist/product-scopes.d.ts +17 -0
- package/dist/product-scopes.js +31 -5
- package/dist/projects.d.ts +61 -28
- package/dist/projects.js +47 -9
- package/dist/promotions.d.ts +157 -5
- package/dist/promotions.js +23 -1
- package/dist/pwa.d.ts +39 -0
- package/dist/quick-order.d.ts +9 -3
- package/dist/quick-order.js +4 -3
- package/dist/quote-requests.d.ts +168 -5
- package/dist/quote-requests.js +69 -8
- package/dist/record-references.d.ts +15 -15
- package/dist/returns.d.ts +6 -0
- package/dist/returns.js +4 -2
- package/dist/sales-channels.d.ts +34 -3
- package/dist/sales-channels.js +16 -1
- package/dist/schema-extensions.d.ts +36 -0
- package/dist/schema-extensions.js +29 -0
- package/dist/seo.d.ts +2 -2
- package/dist/settings.d.ts +44 -2
- package/dist/settings.js +17 -2
- package/dist/shopping-lists.d.ts +39 -1
- package/dist/shopping-lists.js +37 -3
- package/dist/storefront-cache-tags.d.ts +10 -0
- package/dist/tasks.d.ts +21 -21
- package/dist/taxes.d.ts +27 -0
- package/dist/taxes.js +4 -0
- package/dist/transactional-emails.d.ts +39 -13
- package/dist/webhooks.d.ts +75 -0
- package/dist/webhooks.js +24 -0
- package/package.json +4 -2
- 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/forms-logic.d.ts.map +0 -1
- package/dist/forms-logic.fixtures.d.ts.map +0 -1
- package/dist/forms-logic.fixtures.js.map +0 -1
- package/dist/forms-logic.js.map +0 -1
- package/dist/forms.d.ts.map +0 -1
- package/dist/forms.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/organization-registry-lookup.d.ts.map +0 -1
- package/dist/organization-registry-lookup.js.map +0 -1
- package/dist/organization-roles.d.ts.map +0 -1
- package/dist/organization-roles.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/pim-locale-mapping.d.ts.map +0 -1
- package/dist/pim-locale-mapping.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-model.d.ts.map +0 -1
- package/dist/product-scope-model.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-scoped-values.d.ts.map +0 -1
- package/dist/product-scoped-values.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-tax-rates.d.ts.map +0 -1
- package/dist/product-tax-rates.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-write-encoding.d.ts.map +0 -1
- package/dist/scoped-write-encoding.js.map +0 -1
- package/dist/search.d.ts.map +0 -1
- package/dist/search.js.map +0 -1
- package/dist/seo.d.ts.map +0 -1
- package/dist/seo.js.map +0 -1
- package/dist/settings.d.ts.map +0 -1
- package/dist/settings.js.map +0 -1
- package/dist/shipments.d.ts.map +0 -1
- package/dist/shipments.js.map +0 -1
- package/dist/shipping-methods.d.ts.map +0 -1
- package/dist/shipping-methods.js.map +0 -1
- package/dist/shopping-lists.d.ts.map +0 -1
- package/dist/shopping-lists.js.map +0 -1
- package/dist/storefront-cache-tags.d.ts.map +0 -1
- package/dist/storefront-cache-tags.js.map +0 -1
- package/dist/storefront-language-path.d.ts.map +0 -1
- package/dist/storefront-language-path.js.map +0 -1
- package/dist/storefront-value-overrides.d.ts.map +0 -1
- package/dist/storefront-value-overrides.js.map +0 -1
- package/dist/tasks.d.ts.map +0 -1
- package/dist/tasks.js.map +0 -1
- package/dist/taxes.d.ts.map +0 -1
- package/dist/taxes.js.map +0 -1
- package/dist/text-normalization.d.ts.map +0 -1
- package/dist/text-normalization.js.map +0 -1
- package/dist/transactional-emails.d.ts.map +0 -1
- package/dist/transactional-emails.js.map +0 -1
- package/dist/webhooks.d.ts.map +0 -1
- package/dist/webhooks.js.map +0 -1
package/dist/organizations.js
CHANGED
|
@@ -2,9 +2,12 @@ import { z } from 'zod';
|
|
|
2
2
|
import { addressSnapshotSchema, isoDateTimeSchema, uuidSchema, } from './common.js';
|
|
3
3
|
import { fulfilmentStrategySchema } from './inventory.js';
|
|
4
4
|
import { organizationRoleRefSchema } from './organization-roles.js';
|
|
5
|
+
import { paginationSchema } from './pagination.js';
|
|
5
6
|
import { SalesChannelOptionSchema } from './sales-channels.js';
|
|
6
7
|
import { foldDiacritics } from './text-normalization.js';
|
|
7
|
-
import { registryLookupIdSchema } from './organization-registry-lookup.js';
|
|
8
|
+
import { registryLookupIdSchema, vatValidationOutcomeSchema, vatValidationProviderSchema, } from './organization-registry-lookup.js';
|
|
9
|
+
import { ExtensionAttributesSchema } from './schema-extensions.js';
|
|
10
|
+
import { customFieldValuesSchema } from './custom-fields.js';
|
|
8
11
|
/**
|
|
9
12
|
* Organizations, customer accounts, addresses, invitations — Source of truth
|
|
10
13
|
* per Principle V. Drives US2 + US3.
|
|
@@ -66,7 +69,11 @@ export const addressKindSchema = z.enum(['delivery', 'billing']);
|
|
|
66
69
|
export const organizationSchema = z.object({
|
|
67
70
|
id: uuidSchema,
|
|
68
71
|
name: z.string(),
|
|
69
|
-
|
|
72
|
+
/**
|
|
73
|
+
* `specs/177-tax-id-scope/` — `null` for a personal (B2C) organization, which
|
|
74
|
+
* has no tax ID; a company organization always has one (FR-001, FR-004).
|
|
75
|
+
*/
|
|
76
|
+
taxId: z.string().nullable(),
|
|
70
77
|
status: organizationStatusSchema,
|
|
71
78
|
vatStatus: vatStatusSchema,
|
|
72
79
|
/** Feature 051 — true for a single-member personal (B2C) organization. */
|
|
@@ -96,6 +103,44 @@ export const organizationSchema = z.object({
|
|
|
96
103
|
createdAt: isoDateTimeSchema,
|
|
97
104
|
updatedAt: isoDateTimeSchema,
|
|
98
105
|
});
|
|
106
|
+
/**
|
|
107
|
+
* `specs/178-extensible-columns/` FR-051 — an Organization as the admin detail
|
|
108
|
+
* and list reads return it. `extensions` is present only when the request named
|
|
109
|
+
* modules with `?extensions=` (`ExtensionsQuerySchema`): per
|
|
110
|
+
* named module that declares columns on `organizations` with `adminReads` and is
|
|
111
|
+
* present, its declared keys and values; an absent, switched-off or
|
|
112
|
+
* non-exposing module is simply not a key (FR-052).
|
|
113
|
+
*/
|
|
114
|
+
export const adminOrganizationSchema = organizationSchema.extend({
|
|
115
|
+
/*
|
|
116
|
+
* Issue #599 — the keys every admin organization reply (the list, the detail
|
|
117
|
+
* and each write's answer) has carried, which the contract did not declare.
|
|
118
|
+
* The Admin UI's organization page reads them. Declared optional, so a client
|
|
119
|
+
* that does not read them is unaffected.
|
|
120
|
+
*/
|
|
121
|
+
legalName: z.string().nullable().optional(),
|
|
122
|
+
/** Feature 038 (US4) — additional addresses copied on this Organization's order confirmations. */
|
|
123
|
+
orderConfirmationEmails: z.array(z.string()).optional(),
|
|
124
|
+
/** The optimistic-concurrency token the moderation and restriction writes check. */
|
|
125
|
+
version: z.number().int().nonnegative().optional(),
|
|
126
|
+
blockedReason: z.string().nullable().optional(),
|
|
127
|
+
blockedAt: isoDateTimeSchema.nullable().optional(),
|
|
128
|
+
rejectedReason: z.string().nullable().optional(),
|
|
129
|
+
rejectedAt: isoDateTimeSchema.nullable().optional(),
|
|
130
|
+
approvedAt: isoDateTimeSchema.nullable().optional(),
|
|
131
|
+
approvedByAdminUserId: uuidSchema.nullable().optional(),
|
|
132
|
+
/** The latest tax-ID validation; each member is `null` while none has run. */
|
|
133
|
+
vatValidation: z
|
|
134
|
+
.object({
|
|
135
|
+
outcome: vatValidationOutcomeSchema.nullable(),
|
|
136
|
+
provider: vatValidationProviderSchema.nullable(),
|
|
137
|
+
validatedAt: isoDateTimeSchema.nullable(),
|
|
138
|
+
})
|
|
139
|
+
.optional(),
|
|
140
|
+
/** Feature 055 — this Organization's custom-field values. */
|
|
141
|
+
customFieldValues: customFieldValuesSchema.optional(),
|
|
142
|
+
extensions: ExtensionAttributesSchema.optional(),
|
|
143
|
+
});
|
|
99
144
|
// --- Hierarchy (feature 056) ------------------------------------------------
|
|
100
145
|
/**
|
|
101
146
|
* A single node in an organization subtree / ancestor chain. `depth` is the
|
|
@@ -147,6 +192,12 @@ export const customerAccountSchema = z.object({
|
|
|
147
192
|
permissions: z.array(z.string()),
|
|
148
193
|
emailVerifiedAt: isoDateTimeSchema.nullable(),
|
|
149
194
|
twoFactorEnabled: z.boolean(),
|
|
195
|
+
/**
|
|
196
|
+
* Issue #652 (D-292) — the account's e-mail language, `null` while unknown
|
|
197
|
+
* (see `CustomerAccountRecord.preferredLanguage`). Answered by
|
|
198
|
+
* `GET /api/v1/me`; the registration and sign-in answers do not carry it.
|
|
199
|
+
*/
|
|
200
|
+
preferredLanguage: z.string().nullable().optional(),
|
|
150
201
|
createdAt: isoDateTimeSchema,
|
|
151
202
|
updatedAt: isoDateTimeSchema,
|
|
152
203
|
});
|
|
@@ -163,12 +214,24 @@ export const addressSchema = z.object({
|
|
|
163
214
|
isDefault: z.boolean(),
|
|
164
215
|
});
|
|
165
216
|
// --- Requests --------------------------------------------------------------
|
|
166
|
-
/**
|
|
167
|
-
|
|
217
|
+
/**
|
|
218
|
+
* `specs/177-tax-id-scope/` — the one normalisation a tax ID gets before it is
|
|
219
|
+
* stored or looked up: whitespace and dashes stripped, upper-cased. It is the
|
|
220
|
+
* admin boundary's rule (`organizations`' `schemas/organization.ts`), published
|
|
221
|
+
* so the lookups (`OrganizationDetailsPort.findByTaxId`) and the conversion body
|
|
222
|
+
* apply exactly the same one. Pure, so it is a function and not a port.
|
|
223
|
+
*/
|
|
224
|
+
export function normalizeTaxId(input) {
|
|
225
|
+
return input.replace(/[\s-]+/g, '').toUpperCase();
|
|
226
|
+
}
|
|
227
|
+
/** A tax ID as an operator types it, normalised, then held to the stored length (8–32). */
|
|
228
|
+
const normalizedTaxIdSchema = z.string().transform(normalizeTaxId).pipe(z.string().min(8).max(32));
|
|
168
229
|
export const registerOrganizationRequestSchema = z.object({
|
|
169
230
|
organization: z.object({
|
|
170
231
|
name: z.string().min(1).max(255),
|
|
171
|
-
|
|
232
|
+
// `specs/177-tax-id-scope/` — normalised, then held to the stored length,
|
|
233
|
+
// so `--------` is refused instead of storing an empty tax ID.
|
|
234
|
+
taxId: normalizedTaxIdSchema,
|
|
172
235
|
registeredAddress: z.object({
|
|
173
236
|
street: z.string().min(1).max(255),
|
|
174
237
|
city: z.string().min(1).max(120),
|
|
@@ -176,12 +239,25 @@ export const registerOrganizationRequestSchema = z.object({
|
|
|
176
239
|
country: z.string().length(2),
|
|
177
240
|
}),
|
|
178
241
|
vatStatus: vatStatusSchema.optional(),
|
|
242
|
+
/**
|
|
243
|
+
* Feature 175 — the Organization's custom-field values (entity type
|
|
244
|
+
* `organization`). On registration they are validated as BUYER input on
|
|
245
|
+
* the `organization.register` surface; on the admin create, which derives
|
|
246
|
+
* from this member (`AdminOrganizationCreateBodySchema`), with the
|
|
247
|
+
* administrator's rules — the two routes never share a validator (FR-023).
|
|
248
|
+
*/
|
|
249
|
+
customFieldValues: customFieldValuesSchema.optional(),
|
|
179
250
|
}),
|
|
180
251
|
firstUser: z.object({
|
|
181
252
|
email: z.string().email(),
|
|
182
253
|
password: z.string().min(12).max(256),
|
|
183
254
|
firstName: z.string().min(1).max(120),
|
|
184
255
|
lastName: z.string().min(1).max(120),
|
|
256
|
+
/**
|
|
257
|
+
* Feature 175 — the registering person's custom-field values (entity type
|
|
258
|
+
* `customer`), validated as buyer input on `organization.register`.
|
|
259
|
+
*/
|
|
260
|
+
customFieldValues: customFieldValuesSchema.optional(),
|
|
185
261
|
}),
|
|
186
262
|
acceptedTermsVersion: z.string(),
|
|
187
263
|
/**
|
|
@@ -325,6 +401,81 @@ export const registerOrganizationResponseSchema = z.object({
|
|
|
325
401
|
customerAccount: customerAccountSchema,
|
|
326
402
|
emailVerificationSent: z.boolean(),
|
|
327
403
|
});
|
|
404
|
+
// --- Admin organization replies (issue #599) --------------------------------
|
|
405
|
+
/** `GET /api/v1/admin/organizations` — one page of Organizations. */
|
|
406
|
+
export const adminOrganizationListResponseSchema = z.object({
|
|
407
|
+
data: z.array(adminOrganizationSchema),
|
|
408
|
+
pagination: paginationSchema,
|
|
409
|
+
});
|
|
410
|
+
/**
|
|
411
|
+
* A member as the operator's screens show it: the detail's member roster and
|
|
412
|
+
* the answer of every admin member write (profile, roll-up, role, block,
|
|
413
|
+
* unblock). The role is `organizationRole` (`specs/170-organization-roles/`
|
|
414
|
+
* FR-008, FR-073); an operator view carries no effective permissions.
|
|
415
|
+
*/
|
|
416
|
+
export const adminOrganizationMemberSchema = z.object({
|
|
417
|
+
id: uuidSchema,
|
|
418
|
+
email: z.string().email(),
|
|
419
|
+
firstName: z.string(),
|
|
420
|
+
lastName: z.string(),
|
|
421
|
+
/** Feature 056 — this login sees and acts across its Organization's subtree. */
|
|
422
|
+
subtreeRollupEnabled: z.boolean(),
|
|
423
|
+
emailVerifiedAt: isoDateTimeSchema.nullable(),
|
|
424
|
+
twoFactorEnabled: z.boolean(),
|
|
425
|
+
lastLoginAt: isoDateTimeSchema.nullable(),
|
|
426
|
+
organizationRole: organizationRoleRefSchema,
|
|
427
|
+
createdAt: isoDateTimeSchema,
|
|
428
|
+
updatedAt: isoDateTimeSchema,
|
|
429
|
+
});
|
|
430
|
+
/**
|
|
431
|
+
* `GET /api/v1/admin/organizations/:id` — the Organization, its active members,
|
|
432
|
+
* and its two predefined roles, so the member role select can offer
|
|
433
|
+
* Administrator and Member to an operator who may assign roles but not read the
|
|
434
|
+
* role list (`specs/170-organization-roles/contracts/operator-api.md` §5).
|
|
435
|
+
*/
|
|
436
|
+
export const adminOrganizationDetailSchema = adminOrganizationSchema.extend({
|
|
437
|
+
members: z.array(adminOrganizationMemberSchema),
|
|
438
|
+
predefinedRoles: z.array(organizationRoleRefSchema),
|
|
439
|
+
});
|
|
440
|
+
// --- Buyer member and invitation replies (issue #599) -----------------------
|
|
441
|
+
/**
|
|
442
|
+
* A member as the buyer's roster shows it — `GET /api/v1/organizations/mine/members`
|
|
443
|
+
* and `PATCH …/mine/members/:id/role`. A session view (`customerAccountSchema`)
|
|
444
|
+
* adds the member's effective permissions; a roster row does not.
|
|
445
|
+
*/
|
|
446
|
+
export const organizationMemberSchema = z.object({
|
|
447
|
+
id: uuidSchema,
|
|
448
|
+
organizationId: uuidSchema,
|
|
449
|
+
email: z.string().email(),
|
|
450
|
+
firstName: z.string(),
|
|
451
|
+
lastName: z.string(),
|
|
452
|
+
organizationRole: organizationRoleRefSchema,
|
|
453
|
+
emailVerifiedAt: isoDateTimeSchema.nullable(),
|
|
454
|
+
twoFactorEnabled: z.boolean(),
|
|
455
|
+
createdAt: isoDateTimeSchema,
|
|
456
|
+
updatedAt: isoDateTimeSchema,
|
|
457
|
+
});
|
|
458
|
+
export const organizationMemberListResponseSchema = z.object({ data: z.array(organizationMemberSchema) });
|
|
459
|
+
/** A pending invitation — `GET /api/v1/organizations/mine/invitations`. */
|
|
460
|
+
export const organizationInvitationSchema = z.object({
|
|
461
|
+
id: uuidSchema,
|
|
462
|
+
organizationId: uuidSchema,
|
|
463
|
+
email: z.string().email(),
|
|
464
|
+
/** The role the invitee will hold (FR-008, FR-073). */
|
|
465
|
+
organizationRole: organizationRoleRefSchema,
|
|
466
|
+
invitedByCustomerAccountId: uuidSchema.nullable(),
|
|
467
|
+
expiresAt: isoDateTimeSchema,
|
|
468
|
+
createdAt: isoDateTimeSchema,
|
|
469
|
+
});
|
|
470
|
+
export const organizationInvitationListResponseSchema = z.object({ data: z.array(organizationInvitationSchema) });
|
|
471
|
+
/** `POST /api/v1/organizations/mine/invitations` — 201. */
|
|
472
|
+
export const inviteMemberResponseSchema = z.object({
|
|
473
|
+
data: z.object({ invitationId: uuidSchema, expiresAt: isoDateTimeSchema }),
|
|
474
|
+
});
|
|
475
|
+
/** `POST /api/v1/organizations/invitations/:token/accept` — the account the invitation created, as a session view. */
|
|
476
|
+
export const acceptInvitationResponseSchema = z.object({
|
|
477
|
+
data: z.object({ customerAccount: customerAccountSchema }),
|
|
478
|
+
});
|
|
328
479
|
// --- Organization picker (feature 091, P2) ----------------------------------
|
|
329
480
|
/**
|
|
330
481
|
* One row of the admin Organization picker.
|
|
@@ -379,10 +530,73 @@ export const salesRepOrganizationSchema = z.object({
|
|
|
379
530
|
openRfqCount: z.number().int().nonnegative(),
|
|
380
531
|
assignedAt: isoDateTimeSchema,
|
|
381
532
|
});
|
|
533
|
+
// --- Tax-ID scope (specs/177-tax-id-scope/) ----------------------------------
|
|
534
|
+
/**
|
|
535
|
+
* Where the same tax ID may appear twice (`contracts/tax-id-scope.md` §1):
|
|
536
|
+
* `global` — nowhere, every tax ID belongs to one organization (the default of
|
|
537
|
+
* every installation); `per-tree-root` — only inside one organization tree, so
|
|
538
|
+
* a head office and its branches may share it. Enforced by the database and
|
|
539
|
+
* changed only by the audited `organization.tax_id_scope.set` Command.
|
|
540
|
+
*/
|
|
541
|
+
export const taxIdScopeSchema = z.enum(['global', 'per-tree-root']);
|
|
542
|
+
/** `PUT /api/v1/admin/organizations/tax-id-scope` — the scope to switch to. */
|
|
543
|
+
export const adminTaxIdScopeSetBodySchema = z.object({ scope: taxIdScopeSchema });
|
|
544
|
+
/**
|
|
545
|
+
* `GET` / `PUT /api/v1/admin/organizations/tax-id-scope` — the installation's
|
|
546
|
+
* scope, who set it last, how many tax IDs are on more than one organization,
|
|
547
|
+
* and whether the database enforcement agrees with the stored scope
|
|
548
|
+
* (`mismatch` only after a hand edit; re-applying the scope repairs it).
|
|
549
|
+
*/
|
|
550
|
+
export const adminTaxIdScopeResponseSchema = z.object({
|
|
551
|
+
data: z.object({
|
|
552
|
+
scope: taxIdScopeSchema,
|
|
553
|
+
updatedAt: isoDateTimeSchema,
|
|
554
|
+
updatedByAdminUserId: uuidSchema.nullable(),
|
|
555
|
+
sharedTaxIdCount: z.number().int().nonnegative(),
|
|
556
|
+
enforcement: z.enum(['consistent', 'mismatch']),
|
|
557
|
+
}),
|
|
558
|
+
});
|
|
559
|
+
// --- Personal → company conversion (specs/177-tax-id-scope/) -----------------
|
|
560
|
+
/**
|
|
561
|
+
* `POST /api/v1/admin/organizations/:id/convert-to-company`
|
|
562
|
+
* (`contracts/convert-to-company.md` §2). The tax ID is normalised exactly as
|
|
563
|
+
* the admin boundary normalises it. `validateTaxId` is the route's own switch
|
|
564
|
+
* — a VAT validation after the conversion commits — and is not part of the
|
|
565
|
+
* Command's input.
|
|
566
|
+
*/
|
|
567
|
+
export const adminOrganizationConvertToCompanyBodySchema = z.object({
|
|
568
|
+
name: z.string().trim().min(1).max(255),
|
|
569
|
+
legalName: z.string().trim().min(1).max(255).optional(),
|
|
570
|
+
taxId: normalizedTaxIdSchema,
|
|
571
|
+
registeredAddress: z.object({
|
|
572
|
+
street: z.string().min(1).max(255),
|
|
573
|
+
city: z.string().min(1).max(120),
|
|
574
|
+
postalCode: z.string().min(1).max(20),
|
|
575
|
+
country: z.string().length(2),
|
|
576
|
+
}),
|
|
577
|
+
vatStatus: vatStatusSchema.default('vat_payer'),
|
|
578
|
+
validateTaxId: z.boolean().default(false),
|
|
579
|
+
});
|
|
580
|
+
// --- Tax-ID correction (issue #1040, follow-up to specs/177-tax-id-scope/) ----
|
|
581
|
+
/**
|
|
582
|
+
* `POST /api/v1/admin/organizations/:id/change-tax-id`. The tax ID is
|
|
583
|
+
* normalised exactly as the admin boundary normalises it on creation.
|
|
584
|
+
* `validateTaxId` is the route's own switch — a VAT validation after the change
|
|
585
|
+
* commits, whose failure never undoes it — and is not part of the Command's
|
|
586
|
+
* input.
|
|
587
|
+
*/
|
|
588
|
+
export const adminOrganizationChangeTaxIdBodySchema = z.object({
|
|
589
|
+
taxId: normalizedTaxIdSchema,
|
|
590
|
+
validateTaxId: z.boolean().default(false),
|
|
591
|
+
});
|
|
592
|
+
/** Container name of {@link OrganizationWritePort}. */
|
|
593
|
+
export const ORGANIZATION_WRITE_PORT = 'organizationWritePort';
|
|
382
594
|
/**
|
|
383
595
|
* The tax id a reader may print or hand out for an Organization: a company's,
|
|
384
|
-
* never a personal (B2C) Organization's
|
|
385
|
-
*
|
|
596
|
+
* never a personal (B2C) Organization's. A personal Organization stores no tax
|
|
597
|
+
* id at all since `specs/177-tax-id-scope/` (it carried an internal 32-hex
|
|
598
|
+
* placeholder derived from the account id until then, issue #767), and the flag
|
|
599
|
+
* is still honoured for a payload written before that. `null` — not an empty
|
|
386
600
|
* string — when there is nothing to show, so every renderer drops its tax-id
|
|
387
601
|
* line rather than printing a label with no value.
|
|
388
602
|
*
|
|
@@ -396,7 +610,7 @@ export const salesRepOrganizationSchema = z.object({
|
|
|
396
610
|
export function organizationCompanyTaxId(organization) {
|
|
397
611
|
if (organization.isPersonal)
|
|
398
612
|
return null;
|
|
399
|
-
const taxId = organization.taxId
|
|
613
|
+
const taxId = organization.taxId?.trim() ?? '';
|
|
400
614
|
return taxId === '' ? null : taxId;
|
|
401
615
|
}
|
|
402
616
|
/**
|
|
@@ -505,6 +719,13 @@ export const AdminOrganizationCreateBodySchema = registerOrganizationRequestSche
|
|
|
505
719
|
.extend({
|
|
506
720
|
status: z.enum(['active', 'pending_verification']).default('active'),
|
|
507
721
|
salesChannelIds: organizationSalesChannelIdsSchema,
|
|
722
|
+
/**
|
|
723
|
+
* `specs/177-tax-id-scope/` (FR-018) — create the organization as a branch
|
|
724
|
+
* under this parent, in the same Command, so that in `per-tree-root` it may
|
|
725
|
+
* carry the head office's tax ID. Naming a parent requires an unscoped
|
|
726
|
+
* platform administrator (D-260).
|
|
727
|
+
*/
|
|
728
|
+
parentId: uuidSchema.optional(),
|
|
508
729
|
});
|
|
509
730
|
/**
|
|
510
731
|
* `GET /api/v1/admin/organizations/sales-channel-options` — what the *New
|