@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/projects.d.ts
CHANGED
|
@@ -42,8 +42,8 @@ export declare const projectVisibilitySchema: z.ZodEnum<{
|
|
|
42
42
|
export type ProjectVisibility = z.infer<typeof projectVisibilitySchema>;
|
|
43
43
|
/** The module setting `projects.visibility` (FR-018); default `members`. */
|
|
44
44
|
export declare const projectVisibilitySettingSchema: z.ZodEnum<{
|
|
45
|
-
everyone: "everyone";
|
|
46
45
|
members: "members";
|
|
46
|
+
everyone: "everyone";
|
|
47
47
|
}>;
|
|
48
48
|
export type ProjectVisibilitySetting = z.infer<typeof projectVisibilitySettingSchema>;
|
|
49
49
|
/** What a Project links to (R-10). */
|
|
@@ -57,8 +57,8 @@ export type ProjectRecordKind = z.infer<typeof projectRecordKindSchema>;
|
|
|
57
57
|
export declare const projectPanelRecordKindSchema: z.ZodEnum<{
|
|
58
58
|
order: "order";
|
|
59
59
|
quote_request: "quote_request";
|
|
60
|
-
task: "task";
|
|
61
60
|
opportunity: "opportunity";
|
|
61
|
+
task: "task";
|
|
62
62
|
}>;
|
|
63
63
|
export type ProjectPanelRecordKind = z.infer<typeof projectPanelRecordKindSchema>;
|
|
64
64
|
export declare const projectCommentKindSchema: z.ZodEnum<{
|
|
@@ -254,8 +254,9 @@ export declare const UpdateProjectBodySchema: z.ZodObject<{
|
|
|
254
254
|
version: z.ZodNumber;
|
|
255
255
|
}, z.core.$strict>;
|
|
256
256
|
export type UpdateProjectBody = z.infer<typeof UpdateProjectBodySchema>;
|
|
257
|
-
/** `PUT /projects/:id/organizations` — the whole set (409 `PROJECT_ORGANIZATION_IN_USE`). */
|
|
257
|
+
/** `PUT /projects/:id/organizations` — the whole set, in one transaction (409 `PROJECT_ORGANIZATION_IN_USE`). */
|
|
258
258
|
export declare const SetProjectOrganizationsBodySchema: z.ZodObject<{
|
|
259
|
+
configurationVersion: z.ZodOptional<z.ZodNumber>;
|
|
259
260
|
organizationIds: z.ZodArray<z.ZodString>;
|
|
260
261
|
}, z.core.$strict>;
|
|
261
262
|
export type SetProjectOrganizationsBody = z.infer<typeof SetProjectOrganizationsBodySchema>;
|
|
@@ -273,6 +274,7 @@ export declare const ProjectOutOfReachAfterWriteSchema: z.ZodObject<{
|
|
|
273
274
|
export type ProjectOutOfReachAfterWrite = z.infer<typeof ProjectOutOfReachAfterWriteSchema>;
|
|
274
275
|
/** `PUT /projects/:id/members` — the whole set, Members and their Roles, in one Command. */
|
|
275
276
|
export declare const SetProjectMembersBodySchema: z.ZodObject<{
|
|
277
|
+
configurationVersion: z.ZodOptional<z.ZodNumber>;
|
|
276
278
|
members: z.ZodArray<z.ZodObject<{
|
|
277
279
|
adminUserId: z.ZodString;
|
|
278
280
|
roleIds: z.ZodArray<z.ZodString>;
|
|
@@ -281,6 +283,7 @@ export declare const SetProjectMembersBodySchema: z.ZodObject<{
|
|
|
281
283
|
export type SetProjectMembersBody = z.infer<typeof SetProjectMembersBodySchema>;
|
|
282
284
|
/** `POST /projects/:id/stages`. */
|
|
283
285
|
export declare const CreateProjectStageBodySchema: z.ZodObject<{
|
|
286
|
+
configurationVersion: z.ZodOptional<z.ZodNumber>;
|
|
284
287
|
name: z.ZodString;
|
|
285
288
|
color: z.ZodString;
|
|
286
289
|
plannedDurationDays: z.ZodOptional<z.ZodNumber>;
|
|
@@ -304,10 +307,12 @@ export declare const UpdateProjectStageBodySchema: z.ZodObject<{
|
|
|
304
307
|
alertOffsetsDays: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodNumber>>>;
|
|
305
308
|
completionGate: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
306
309
|
completionPermitted: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
310
|
+
version: z.ZodOptional<z.ZodNumber>;
|
|
307
311
|
}, z.core.$strict>;
|
|
308
312
|
export type UpdateProjectStageBody = z.infer<typeof UpdateProjectStageBodySchema>;
|
|
309
313
|
/** `PUT /projects/:id/stages/order` — every Stage id of the Project, in the new order. */
|
|
310
314
|
export declare const ReorderProjectStagesBodySchema: z.ZodObject<{
|
|
315
|
+
configurationVersion: z.ZodOptional<z.ZodNumber>;
|
|
311
316
|
stageIds: z.ZodArray<z.ZodString>;
|
|
312
317
|
}, z.core.$strict>;
|
|
313
318
|
export type ReorderProjectStagesBody = z.infer<typeof ReorderProjectStagesBodySchema>;
|
|
@@ -318,6 +323,7 @@ export declare const ProjectStageMoveSchema: z.ZodObject<{
|
|
|
318
323
|
export type ProjectStageMove = z.infer<typeof ProjectStageMoveSchema>;
|
|
319
324
|
/** `PUT /projects/:id/moves` — the whole set of permitted moves (FR-011). */
|
|
320
325
|
export declare const SetProjectMovesBodySchema: z.ZodObject<{
|
|
326
|
+
configurationVersion: z.ZodOptional<z.ZodNumber>;
|
|
321
327
|
moves: z.ZodArray<z.ZodObject<{
|
|
322
328
|
fromStageId: z.ZodString;
|
|
323
329
|
toStageId: z.ZodString;
|
|
@@ -326,6 +332,7 @@ export declare const SetProjectMovesBodySchema: z.ZodObject<{
|
|
|
326
332
|
export type SetProjectMovesBody = z.infer<typeof SetProjectMovesBodySchema>;
|
|
327
333
|
/** `PUT /projects/:id/stages/:stageId/tasks` — the Stage's Task definitions, replaced whole. */
|
|
328
334
|
export declare const SetProjectStageTasksBodySchema: z.ZodObject<{
|
|
335
|
+
version: z.ZodOptional<z.ZodNumber>;
|
|
329
336
|
tasks: z.ZodArray<z.ZodObject<{
|
|
330
337
|
title: z.ZodString;
|
|
331
338
|
description: z.ZodOptional<z.ZodString>;
|
|
@@ -375,8 +382,8 @@ export declare const RecordProjectParamsSchema: z.ZodObject<{
|
|
|
375
382
|
kind: z.ZodEnum<{
|
|
376
383
|
order: "order";
|
|
377
384
|
quote_request: "quote_request";
|
|
378
|
-
task: "task";
|
|
379
385
|
opportunity: "opportunity";
|
|
386
|
+
task: "task";
|
|
380
387
|
}>;
|
|
381
388
|
recordId: z.ZodString;
|
|
382
389
|
}, z.core.$strip>;
|
|
@@ -672,6 +679,7 @@ export declare const ProjectStageSchema: z.ZodObject<{
|
|
|
672
679
|
id: z.ZodString;
|
|
673
680
|
position: z.ZodNumber;
|
|
674
681
|
}, z.core.$strict>>;
|
|
682
|
+
version: z.ZodNumber;
|
|
675
683
|
}, z.core.$strip>;
|
|
676
684
|
export type ProjectStage = z.infer<typeof ProjectStageSchema>;
|
|
677
685
|
export declare const ProjectMemberSchema: z.ZodObject<{
|
|
@@ -722,13 +730,13 @@ export declare const ProjectDetailSchema: z.ZodObject<{
|
|
|
722
730
|
description: z.ZodString;
|
|
723
731
|
references: z.ZodArray<z.ZodObject<{
|
|
724
732
|
type: z.ZodEnum<{
|
|
725
|
-
product: "product";
|
|
726
733
|
order: "order";
|
|
727
|
-
admin_user: "admin_user";
|
|
728
734
|
quote_request: "quote_request";
|
|
729
|
-
|
|
735
|
+
product: "product";
|
|
730
736
|
opportunity: "opportunity";
|
|
731
737
|
project: "project";
|
|
738
|
+
task: "task";
|
|
739
|
+
admin_user: "admin_user";
|
|
732
740
|
}>;
|
|
733
741
|
id: z.ZodString;
|
|
734
742
|
available: z.ZodBoolean;
|
|
@@ -786,6 +794,7 @@ export declare const ProjectDetailSchema: z.ZodObject<{
|
|
|
786
794
|
id: z.ZodString;
|
|
787
795
|
position: z.ZodNumber;
|
|
788
796
|
}, z.core.$strict>>;
|
|
797
|
+
version: z.ZodNumber;
|
|
789
798
|
}, z.core.$strip>>;
|
|
790
799
|
moves: z.ZodArray<z.ZodObject<{
|
|
791
800
|
fromStageId: z.ZodString;
|
|
@@ -810,6 +819,7 @@ export declare const ProjectDetailSchema: z.ZodObject<{
|
|
|
810
819
|
unreadMessageCount: z.ZodNumber;
|
|
811
820
|
customFieldValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
812
821
|
version: z.ZodNumber;
|
|
822
|
+
configurationVersion: z.ZodNumber;
|
|
813
823
|
permissions: z.ZodObject<{
|
|
814
824
|
canWrite: z.ZodBoolean;
|
|
815
825
|
canConfigure: z.ZodBoolean;
|
|
@@ -846,6 +856,7 @@ export declare const SetProjectMovesResultSchema: z.ZodObject<{
|
|
|
846
856
|
toStageId: z.ZodString;
|
|
847
857
|
}, z.core.$strip>>;
|
|
848
858
|
unreachableStageIds: z.ZodArray<z.ZodString>;
|
|
859
|
+
configurationVersion: z.ZodNumber;
|
|
849
860
|
}, z.core.$strip>;
|
|
850
861
|
export type SetProjectMovesResult = z.infer<typeof SetProjectMovesResultSchema>;
|
|
851
862
|
/** `POST /projects/:id/move` — the Project after the move and what the move recorded. */
|
|
@@ -883,13 +894,13 @@ export declare const ProjectMoveResultSchema: z.ZodObject<{
|
|
|
883
894
|
description: z.ZodString;
|
|
884
895
|
references: z.ZodArray<z.ZodObject<{
|
|
885
896
|
type: z.ZodEnum<{
|
|
886
|
-
product: "product";
|
|
887
897
|
order: "order";
|
|
888
|
-
admin_user: "admin_user";
|
|
889
898
|
quote_request: "quote_request";
|
|
890
|
-
|
|
899
|
+
product: "product";
|
|
891
900
|
opportunity: "opportunity";
|
|
892
901
|
project: "project";
|
|
902
|
+
task: "task";
|
|
903
|
+
admin_user: "admin_user";
|
|
893
904
|
}>;
|
|
894
905
|
id: z.ZodString;
|
|
895
906
|
available: z.ZodBoolean;
|
|
@@ -947,6 +958,7 @@ export declare const ProjectMoveResultSchema: z.ZodObject<{
|
|
|
947
958
|
id: z.ZodString;
|
|
948
959
|
position: z.ZodNumber;
|
|
949
960
|
}, z.core.$strict>>;
|
|
961
|
+
version: z.ZodNumber;
|
|
950
962
|
}, z.core.$strip>>;
|
|
951
963
|
moves: z.ZodArray<z.ZodObject<{
|
|
952
964
|
fromStageId: z.ZodString;
|
|
@@ -971,6 +983,7 @@ export declare const ProjectMoveResultSchema: z.ZodObject<{
|
|
|
971
983
|
unreadMessageCount: z.ZodNumber;
|
|
972
984
|
customFieldValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
973
985
|
version: z.ZodNumber;
|
|
986
|
+
configurationVersion: z.ZodNumber;
|
|
974
987
|
permissions: z.ZodObject<{
|
|
975
988
|
canWrite: z.ZodBoolean;
|
|
976
989
|
canConfigure: z.ZodBoolean;
|
|
@@ -1028,6 +1041,7 @@ export declare const ProjectLinkSchema: z.ZodObject<{
|
|
|
1028
1041
|
available: z.ZodBoolean;
|
|
1029
1042
|
number: z.ZodOptional<z.ZodString>;
|
|
1030
1043
|
status: z.ZodOptional<z.ZodString>;
|
|
1044
|
+
statusName: z.ZodOptional<z.ZodString>;
|
|
1031
1045
|
amount: z.ZodOptional<z.ZodString>;
|
|
1032
1046
|
currency: z.ZodOptional<z.ZodString>;
|
|
1033
1047
|
agreement: z.ZodOptional<z.ZodEnum<{
|
|
@@ -1122,13 +1136,13 @@ export declare const ProjectCommentSchema: z.ZodObject<{
|
|
|
1122
1136
|
body: z.ZodString;
|
|
1123
1137
|
references: z.ZodArray<z.ZodObject<{
|
|
1124
1138
|
type: z.ZodEnum<{
|
|
1125
|
-
product: "product";
|
|
1126
1139
|
order: "order";
|
|
1127
|
-
admin_user: "admin_user";
|
|
1128
1140
|
quote_request: "quote_request";
|
|
1129
|
-
|
|
1141
|
+
product: "product";
|
|
1130
1142
|
opportunity: "opportunity";
|
|
1131
1143
|
project: "project";
|
|
1144
|
+
task: "task";
|
|
1145
|
+
admin_user: "admin_user";
|
|
1132
1146
|
}>;
|
|
1133
1147
|
id: z.ZodString;
|
|
1134
1148
|
available: z.ZodBoolean;
|
|
@@ -1245,13 +1259,13 @@ export declare const ProjectDetailResponseSchema: z.ZodObject<{
|
|
|
1245
1259
|
description: z.ZodString;
|
|
1246
1260
|
references: z.ZodArray<z.ZodObject<{
|
|
1247
1261
|
type: z.ZodEnum<{
|
|
1248
|
-
product: "product";
|
|
1249
1262
|
order: "order";
|
|
1250
|
-
admin_user: "admin_user";
|
|
1251
1263
|
quote_request: "quote_request";
|
|
1252
|
-
|
|
1264
|
+
product: "product";
|
|
1253
1265
|
opportunity: "opportunity";
|
|
1254
1266
|
project: "project";
|
|
1267
|
+
task: "task";
|
|
1268
|
+
admin_user: "admin_user";
|
|
1255
1269
|
}>;
|
|
1256
1270
|
id: z.ZodString;
|
|
1257
1271
|
available: z.ZodBoolean;
|
|
@@ -1309,6 +1323,7 @@ export declare const ProjectDetailResponseSchema: z.ZodObject<{
|
|
|
1309
1323
|
id: z.ZodString;
|
|
1310
1324
|
position: z.ZodNumber;
|
|
1311
1325
|
}, z.core.$strict>>;
|
|
1326
|
+
version: z.ZodNumber;
|
|
1312
1327
|
}, z.core.$strip>>;
|
|
1313
1328
|
moves: z.ZodArray<z.ZodObject<{
|
|
1314
1329
|
fromStageId: z.ZodString;
|
|
@@ -1333,6 +1348,7 @@ export declare const ProjectDetailResponseSchema: z.ZodObject<{
|
|
|
1333
1348
|
unreadMessageCount: z.ZodNumber;
|
|
1334
1349
|
customFieldValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1335
1350
|
version: z.ZodNumber;
|
|
1351
|
+
configurationVersion: z.ZodNumber;
|
|
1336
1352
|
permissions: z.ZodObject<{
|
|
1337
1353
|
canWrite: z.ZodBoolean;
|
|
1338
1354
|
canConfigure: z.ZodBoolean;
|
|
@@ -1397,6 +1413,7 @@ export declare const ProjectStageResponseSchema: z.ZodObject<{
|
|
|
1397
1413
|
id: z.ZodString;
|
|
1398
1414
|
position: z.ZodNumber;
|
|
1399
1415
|
}, z.core.$strict>>;
|
|
1416
|
+
version: z.ZodNumber;
|
|
1400
1417
|
}, z.core.$strip>;
|
|
1401
1418
|
}, z.core.$strip>;
|
|
1402
1419
|
export declare const ProjectStageEntryListResponseSchema: z.ZodObject<{
|
|
@@ -1431,6 +1448,7 @@ export declare const SetProjectMovesResponseSchema: z.ZodObject<{
|
|
|
1431
1448
|
toStageId: z.ZodString;
|
|
1432
1449
|
}, z.core.$strip>>;
|
|
1433
1450
|
unreachableStageIds: z.ZodArray<z.ZodString>;
|
|
1451
|
+
configurationVersion: z.ZodNumber;
|
|
1434
1452
|
}, z.core.$strip>;
|
|
1435
1453
|
}, z.core.$strip>;
|
|
1436
1454
|
export declare const ProjectMoveResponseSchema: z.ZodObject<{
|
|
@@ -1468,13 +1486,13 @@ export declare const ProjectMoveResponseSchema: z.ZodObject<{
|
|
|
1468
1486
|
description: z.ZodString;
|
|
1469
1487
|
references: z.ZodArray<z.ZodObject<{
|
|
1470
1488
|
type: z.ZodEnum<{
|
|
1471
|
-
product: "product";
|
|
1472
1489
|
order: "order";
|
|
1473
|
-
admin_user: "admin_user";
|
|
1474
1490
|
quote_request: "quote_request";
|
|
1475
|
-
|
|
1491
|
+
product: "product";
|
|
1476
1492
|
opportunity: "opportunity";
|
|
1477
1493
|
project: "project";
|
|
1494
|
+
task: "task";
|
|
1495
|
+
admin_user: "admin_user";
|
|
1478
1496
|
}>;
|
|
1479
1497
|
id: z.ZodString;
|
|
1480
1498
|
available: z.ZodBoolean;
|
|
@@ -1532,6 +1550,7 @@ export declare const ProjectMoveResponseSchema: z.ZodObject<{
|
|
|
1532
1550
|
id: z.ZodString;
|
|
1533
1551
|
position: z.ZodNumber;
|
|
1534
1552
|
}, z.core.$strict>>;
|
|
1553
|
+
version: z.ZodNumber;
|
|
1535
1554
|
}, z.core.$strip>>;
|
|
1536
1555
|
moves: z.ZodArray<z.ZodObject<{
|
|
1537
1556
|
fromStageId: z.ZodString;
|
|
@@ -1556,6 +1575,7 @@ export declare const ProjectMoveResponseSchema: z.ZodObject<{
|
|
|
1556
1575
|
unreadMessageCount: z.ZodNumber;
|
|
1557
1576
|
customFieldValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1558
1577
|
version: z.ZodNumber;
|
|
1578
|
+
configurationVersion: z.ZodNumber;
|
|
1559
1579
|
permissions: z.ZodObject<{
|
|
1560
1580
|
canWrite: z.ZodBoolean;
|
|
1561
1581
|
canConfigure: z.ZodBoolean;
|
|
@@ -1609,6 +1629,7 @@ export declare const ProjectLinkResponseSchema: z.ZodObject<{
|
|
|
1609
1629
|
available: z.ZodBoolean;
|
|
1610
1630
|
number: z.ZodOptional<z.ZodString>;
|
|
1611
1631
|
status: z.ZodOptional<z.ZodString>;
|
|
1632
|
+
statusName: z.ZodOptional<z.ZodString>;
|
|
1612
1633
|
amount: z.ZodOptional<z.ZodString>;
|
|
1613
1634
|
currency: z.ZodOptional<z.ZodString>;
|
|
1614
1635
|
agreement: z.ZodOptional<z.ZodEnum<{
|
|
@@ -1636,6 +1657,7 @@ export declare const ProjectLinkListResponseSchema: z.ZodObject<{
|
|
|
1636
1657
|
available: z.ZodBoolean;
|
|
1637
1658
|
number: z.ZodOptional<z.ZodString>;
|
|
1638
1659
|
status: z.ZodOptional<z.ZodString>;
|
|
1660
|
+
statusName: z.ZodOptional<z.ZodString>;
|
|
1639
1661
|
amount: z.ZodOptional<z.ZodString>;
|
|
1640
1662
|
currency: z.ZodOptional<z.ZodString>;
|
|
1641
1663
|
agreement: z.ZodOptional<z.ZodEnum<{
|
|
@@ -1731,13 +1753,13 @@ export declare const ProjectCommentResponseSchema: z.ZodObject<{
|
|
|
1731
1753
|
body: z.ZodString;
|
|
1732
1754
|
references: z.ZodArray<z.ZodObject<{
|
|
1733
1755
|
type: z.ZodEnum<{
|
|
1734
|
-
product: "product";
|
|
1735
1756
|
order: "order";
|
|
1736
|
-
admin_user: "admin_user";
|
|
1737
1757
|
quote_request: "quote_request";
|
|
1738
|
-
|
|
1758
|
+
product: "product";
|
|
1739
1759
|
opportunity: "opportunity";
|
|
1740
1760
|
project: "project";
|
|
1761
|
+
task: "task";
|
|
1762
|
+
admin_user: "admin_user";
|
|
1741
1763
|
}>;
|
|
1742
1764
|
id: z.ZodString;
|
|
1743
1765
|
available: z.ZodBoolean;
|
|
@@ -1769,13 +1791,13 @@ export declare const ProjectCommentListResponseSchema: z.ZodObject<{
|
|
|
1769
1791
|
body: z.ZodString;
|
|
1770
1792
|
references: z.ZodArray<z.ZodObject<{
|
|
1771
1793
|
type: z.ZodEnum<{
|
|
1772
|
-
product: "product";
|
|
1773
1794
|
order: "order";
|
|
1774
|
-
admin_user: "admin_user";
|
|
1775
1795
|
quote_request: "quote_request";
|
|
1776
|
-
|
|
1796
|
+
product: "product";
|
|
1777
1797
|
opportunity: "opportunity";
|
|
1778
1798
|
project: "project";
|
|
1799
|
+
task: "task";
|
|
1800
|
+
admin_user: "admin_user";
|
|
1779
1801
|
}>;
|
|
1780
1802
|
id: z.ZodString;
|
|
1781
1803
|
available: z.ZodBoolean;
|
|
@@ -1865,16 +1887,16 @@ export declare const ProjectAdminUserLookupResponseSchema: z.ZodObject<{
|
|
|
1865
1887
|
*/
|
|
1866
1888
|
export declare const ProjectVisibilitySettingSchema: z.ZodObject<{
|
|
1867
1889
|
setting: z.ZodEnum<{
|
|
1868
|
-
everyone: "everyone";
|
|
1869
1890
|
members: "members";
|
|
1891
|
+
everyone: "everyone";
|
|
1870
1892
|
}>;
|
|
1871
1893
|
}, z.core.$strip>;
|
|
1872
1894
|
export type ProjectVisibilitySettingInfo = z.infer<typeof ProjectVisibilitySettingSchema>;
|
|
1873
1895
|
export declare const ProjectVisibilitySettingResponseSchema: z.ZodObject<{
|
|
1874
1896
|
data: z.ZodObject<{
|
|
1875
1897
|
setting: z.ZodEnum<{
|
|
1876
|
-
everyone: "everyone";
|
|
1877
1898
|
members: "members";
|
|
1899
|
+
everyone: "everyone";
|
|
1878
1900
|
}>;
|
|
1879
1901
|
}, z.core.$strip>;
|
|
1880
1902
|
}, z.core.$strip>;
|
|
@@ -1977,7 +1999,10 @@ export declare const ProjectCurrencyAmountSchema: z.ZodObject<{
|
|
|
1977
1999
|
export type ProjectCurrencyAmount = z.infer<typeof ProjectCurrencyAmountSchema>;
|
|
1978
2000
|
/**
|
|
1979
2001
|
* Every figure states the period it covers, how many Projects it was computed
|
|
1980
|
-
* from and how many it left out for a missing value (FR-038)
|
|
2002
|
+
* from and how many it left out for a missing value (FR-038) — and the time
|
|
2003
|
+
* zone its days were counted in (issue #475): the `analytics` module's
|
|
2004
|
+
* reporting time zone, or `UTC` while that module is off. An IANA name;
|
|
2005
|
+
* additive, so a reply without it parses as before.
|
|
1981
2006
|
*/
|
|
1982
2007
|
export declare function projectAnalyticsEnvelope<T extends z.ZodTypeAny>(data: T): z.ZodObject<{
|
|
1983
2008
|
from: z.ZodString;
|
|
@@ -1986,6 +2011,7 @@ export declare function projectAnalyticsEnvelope<T extends z.ZodTypeAny>(data: T
|
|
|
1986
2011
|
excluded: z.ZodObject<{
|
|
1987
2012
|
noValue: z.ZodNumber;
|
|
1988
2013
|
}, z.core.$strip>;
|
|
2014
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
1989
2015
|
data: T;
|
|
1990
2016
|
}, z.core.$strip>;
|
|
1991
2017
|
export declare const ProjectAnalyticsSummarySchema: z.ZodObject<{
|
|
@@ -2076,6 +2102,7 @@ export declare const ProjectAnalyticsSummaryResponseSchema: z.ZodObject<{
|
|
|
2076
2102
|
excluded: z.ZodObject<{
|
|
2077
2103
|
noValue: z.ZodNumber;
|
|
2078
2104
|
}, z.core.$strip>;
|
|
2105
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
2079
2106
|
data: z.ZodObject<{
|
|
2080
2107
|
opened: z.ZodNumber;
|
|
2081
2108
|
completed: z.ZodNumber;
|
|
@@ -2090,6 +2117,7 @@ export declare const ProjectAnalyticsDurationsResponseSchema: z.ZodObject<{
|
|
|
2090
2117
|
excluded: z.ZodObject<{
|
|
2091
2118
|
noValue: z.ZodNumber;
|
|
2092
2119
|
}, z.core.$strip>;
|
|
2120
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
2093
2121
|
data: z.ZodObject<{
|
|
2094
2122
|
completedAverageDays: z.ZodNullable<z.ZodNumber>;
|
|
2095
2123
|
completedCount: z.ZodNumber;
|
|
@@ -2104,6 +2132,7 @@ export declare const ProjectAnalyticsTimeInStageResponseSchema: z.ZodObject<{
|
|
|
2104
2132
|
excluded: z.ZodObject<{
|
|
2105
2133
|
noValue: z.ZodNumber;
|
|
2106
2134
|
}, z.core.$strip>;
|
|
2135
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
2107
2136
|
data: z.ZodArray<z.ZodObject<{
|
|
2108
2137
|
stageName: z.ZodString;
|
|
2109
2138
|
averageDays: z.ZodNullable<z.ZodNumber>;
|
|
@@ -2117,6 +2146,7 @@ export declare const ProjectAnalyticsLossesResponseSchema: z.ZodObject<{
|
|
|
2117
2146
|
excluded: z.ZodObject<{
|
|
2118
2147
|
noValue: z.ZodNumber;
|
|
2119
2148
|
}, z.core.$strip>;
|
|
2149
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
2120
2150
|
data: z.ZodObject<{
|
|
2121
2151
|
byStage: z.ZodArray<z.ZodObject<{
|
|
2122
2152
|
stageName: z.ZodString;
|
|
@@ -2143,6 +2173,7 @@ export declare const ProjectAnalyticsValueResponseSchema: z.ZodObject<{
|
|
|
2143
2173
|
excluded: z.ZodObject<{
|
|
2144
2174
|
noValue: z.ZodNumber;
|
|
2145
2175
|
}, z.core.$strip>;
|
|
2176
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
2146
2177
|
data: z.ZodObject<{
|
|
2147
2178
|
average: z.ZodArray<z.ZodObject<{
|
|
2148
2179
|
currency: z.ZodString;
|
|
@@ -2158,6 +2189,7 @@ export declare const ProjectAnalyticsTopOpenResponseSchema: z.ZodObject<{
|
|
|
2158
2189
|
excluded: z.ZodObject<{
|
|
2159
2190
|
noValue: z.ZodNumber;
|
|
2160
2191
|
}, z.core.$strip>;
|
|
2192
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
2161
2193
|
data: z.ZodArray<z.ZodObject<{
|
|
2162
2194
|
id: z.ZodString;
|
|
2163
2195
|
number: z.ZodString;
|
|
@@ -2197,6 +2229,7 @@ export declare const ProjectAnalyticsManagersResponseSchema: z.ZodObject<{
|
|
|
2197
2229
|
excluded: z.ZodObject<{
|
|
2198
2230
|
noValue: z.ZodNumber;
|
|
2199
2231
|
}, z.core.$strip>;
|
|
2232
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
2200
2233
|
data: z.ZodArray<z.ZodObject<{
|
|
2201
2234
|
adminUser: z.ZodObject<{
|
|
2202
2235
|
id: z.ZodString;
|
package/dist/projects.js
CHANGED
|
@@ -230,9 +230,24 @@ export const UpdateProjectBodySchema = z
|
|
|
230
230
|
version: z.number().int().positive(),
|
|
231
231
|
})
|
|
232
232
|
.strict();
|
|
233
|
-
/**
|
|
233
|
+
/**
|
|
234
|
+
* Optimistic concurrency for a Project's configuration (issue #449) — two
|
|
235
|
+
* tokens, each optional, so a client that sends none is served as before. Sent
|
|
236
|
+
* and stale, the write answers 409 `PROJECT_CHANGED` and nothing is written.
|
|
237
|
+
* Neither is the Project's `version`, which no write of its configuration moves.
|
|
238
|
+
*
|
|
239
|
+
* - `configurationVersion` (`ProjectDetail.configurationVersion`) — the
|
|
240
|
+
* Project's sets: `POST …/stages`, `PUT …/stages/order`, `PUT …/moves`,
|
|
241
|
+
* `PUT …/organizations`, `PUT …/members`; each of them, and
|
|
242
|
+
* `DELETE …/stages/:stageId`, moves it.
|
|
243
|
+
* - `version` (`ProjectStage.version`) — a Stage's own edits:
|
|
244
|
+
* `PATCH …/stages/:stageId`, `PUT …/stages/:stageId/tasks`; each moves it.
|
|
245
|
+
*/
|
|
246
|
+
const configurationVersionShape = { configurationVersion: z.number().int().positive().optional() };
|
|
247
|
+
const stageVersionShape = { version: z.number().int().positive().optional() };
|
|
248
|
+
/** `PUT /projects/:id/organizations` — the whole set, in one transaction (409 `PROJECT_ORGANIZATION_IN_USE`). */
|
|
234
249
|
export const SetProjectOrganizationsBodySchema = z
|
|
235
|
-
.object({ organizationIds: distinctIds(50) })
|
|
250
|
+
.object({ organizationIds: distinctIds(50), ...configurationVersionShape })
|
|
236
251
|
.strict();
|
|
237
252
|
/**
|
|
238
253
|
* The answer of `PUT /projects/:id/organizations` when the change the caller
|
|
@@ -243,12 +258,12 @@ export const SetProjectOrganizationsBodySchema = z
|
|
|
243
258
|
*/
|
|
244
259
|
export const ProjectOutOfReachAfterWriteSchema = z.object({ id: uuid, outOfReach: z.literal(true) }).strict();
|
|
245
260
|
/** `PUT /projects/:id/members` — the whole set, Members and their Roles, in one Command. */
|
|
246
|
-
export const SetProjectMembersBodySchema = z.object({ members: membersSchema }).strict();
|
|
261
|
+
export const SetProjectMembersBodySchema = z.object({ members: membersSchema, ...configurationVersionShape }).strict();
|
|
247
262
|
// ---------------------------------------------------------------------------
|
|
248
263
|
// §2.2 Stages and moves — requests
|
|
249
264
|
// ---------------------------------------------------------------------------
|
|
250
265
|
/** `POST /projects/:id/stages`. */
|
|
251
|
-
export const CreateProjectStageBodySchema = z.object(stageAttributesShape).strict();
|
|
266
|
+
export const CreateProjectStageBodySchema = z.object({ ...stageAttributesShape, ...configurationVersionShape }).strict();
|
|
252
267
|
/**
|
|
253
268
|
* `PATCH /projects/:id/stages/:stageId` — any attribute, at least one.
|
|
254
269
|
* `deadlineOn` sets the deadline by hand; `null` drops the manual deadline and
|
|
@@ -257,11 +272,15 @@ export const CreateProjectStageBodySchema = z.object(stageAttributesShape).stric
|
|
|
257
272
|
export const UpdateProjectStageBodySchema = z
|
|
258
273
|
.object({ ...stageAttributesShape, deadlineOn: calendarDateSchema.nullable() })
|
|
259
274
|
.partial()
|
|
275
|
+
.extend(stageVersionShape)
|
|
260
276
|
.strict()
|
|
261
|
-
.refine((body) => Object.keys(body).
|
|
277
|
+
.refine((body) => Object.keys(body).some((key) => key !== 'version'), { message: 'Nothing to change' });
|
|
262
278
|
/** `PUT /projects/:id/stages/order` — every Stage id of the Project, in the new order. */
|
|
263
279
|
export const ReorderProjectStagesBodySchema = z
|
|
264
|
-
.object({
|
|
280
|
+
.object({
|
|
281
|
+
stageIds: distinctIds(PROJECT_STAGES_MAX).refine((ids) => ids.length > 0, 'At least one Stage'),
|
|
282
|
+
...configurationVersionShape,
|
|
283
|
+
})
|
|
265
284
|
.strict();
|
|
266
285
|
export const ProjectStageMoveSchema = z
|
|
267
286
|
.object({ fromStageId: uuid, toStageId: uuid })
|
|
@@ -271,10 +290,13 @@ export const ProjectStageMoveSchema = z
|
|
|
271
290
|
});
|
|
272
291
|
/** `PUT /projects/:id/moves` — the whole set of permitted moves (FR-011). */
|
|
273
292
|
export const SetProjectMovesBodySchema = z
|
|
274
|
-
.object({
|
|
293
|
+
.object({
|
|
294
|
+
moves: z.array(ProjectStageMoveSchema).max(PROJECT_STAGES_MAX * PROJECT_STAGES_MAX),
|
|
295
|
+
...configurationVersionShape,
|
|
296
|
+
})
|
|
275
297
|
.strict();
|
|
276
298
|
/** `PUT /projects/:id/stages/:stageId/tasks` — the Stage's Task definitions, replaced whole. */
|
|
277
|
-
export const SetProjectStageTasksBodySchema = z.object({ tasks: stageTasksSchema }).strict();
|
|
299
|
+
export const SetProjectStageTasksBodySchema = z.object({ tasks: stageTasksSchema, ...stageVersionShape }).strict();
|
|
278
300
|
/** `POST /projects/:id/move`. */
|
|
279
301
|
export const MoveProjectBodySchema = z
|
|
280
302
|
.object({ toStageId: uuid, version: z.number().int().positive() })
|
|
@@ -531,6 +553,8 @@ export const ProjectStageSchema = z.object({
|
|
|
531
553
|
tasksMaterializeFailed: z.boolean(),
|
|
532
554
|
/** The Stage's own Task definitions (R-7). */
|
|
533
555
|
stageTasks: z.array(StageTaskDefinitionSchema.extend({ id: uuid, position: z.number().int() })),
|
|
556
|
+
/** What `PATCH …/stages/:stageId` and `PUT …/stages/:stageId/tasks` name (issue #449). */
|
|
557
|
+
version: z.number().int().positive(),
|
|
534
558
|
});
|
|
535
559
|
export const ProjectMemberSchema = z.object({
|
|
536
560
|
id: uuid,
|
|
@@ -558,6 +582,8 @@ export const ProjectDetailSchema = ProjectSummarySchema.extend({
|
|
|
558
582
|
unreadMessageCount: z.number().int().nonnegative(),
|
|
559
583
|
customFieldValues: customFieldValuesSchema,
|
|
560
584
|
version: z.number().int().positive(),
|
|
585
|
+
/** What the Project's sets — Stages added or reordered, workflow, Organizations, Members — name (issue #449). */
|
|
586
|
+
configurationVersion: z.number().int().positive(),
|
|
561
587
|
permissions: z.object({ canWrite: z.boolean(), canConfigure: z.boolean() }),
|
|
562
588
|
});
|
|
563
589
|
export const ProjectStageEntrySchema = z.object({
|
|
@@ -574,6 +600,8 @@ export const ProjectStageEntrySchema = z.object({
|
|
|
574
600
|
export const SetProjectMovesResultSchema = z.object({
|
|
575
601
|
moves: z.array(z.object({ fromStageId: uuid, toStageId: uuid })),
|
|
576
602
|
unreachableStageIds: z.array(uuid),
|
|
603
|
+
/** The Project's `configurationVersion` after the write — what the next of its sets names (issue #449). */
|
|
604
|
+
configurationVersion: z.number().int().positive(),
|
|
577
605
|
});
|
|
578
606
|
/** `POST /projects/:id/move` — the Project after the move and what the move recorded. */
|
|
579
607
|
export const ProjectMoveResultSchema = z.object({
|
|
@@ -595,7 +623,13 @@ export const ProjectLinkSchema = z.object({
|
|
|
595
623
|
recordId: uuid,
|
|
596
624
|
available: z.boolean(),
|
|
597
625
|
number: z.string().optional(),
|
|
626
|
+
/** The record's status code, as its owner stores it. */
|
|
598
627
|
status: z.string().optional(),
|
|
628
|
+
/**
|
|
629
|
+
* The status's name in the response language, as the record's owner names it
|
|
630
|
+
* (issue #455) — what a reader is shown; `status` stays the machine token.
|
|
631
|
+
*/
|
|
632
|
+
statusName: z.string().optional(),
|
|
599
633
|
amount: z.string().optional(),
|
|
600
634
|
currency: z.string().optional(),
|
|
601
635
|
/**
|
|
@@ -707,7 +741,10 @@ export const ProjectTemplateResponseSchema = dataEnvelope(ProjectTemplateDetailS
|
|
|
707
741
|
export const ProjectCurrencyAmountSchema = z.object({ currency: z.string(), amount: z.string() });
|
|
708
742
|
/**
|
|
709
743
|
* Every figure states the period it covers, how many Projects it was computed
|
|
710
|
-
* from and how many it left out for a missing value (FR-038)
|
|
744
|
+
* from and how many it left out for a missing value (FR-038) — and the time
|
|
745
|
+
* zone its days were counted in (issue #475): the `analytics` module's
|
|
746
|
+
* reporting time zone, or `UTC` while that module is off. An IANA name;
|
|
747
|
+
* additive, so a reply without it parses as before.
|
|
711
748
|
*/
|
|
712
749
|
export function projectAnalyticsEnvelope(data) {
|
|
713
750
|
return z.object({
|
|
@@ -715,6 +752,7 @@ export function projectAnalyticsEnvelope(data) {
|
|
|
715
752
|
to: z.string(),
|
|
716
753
|
projectCount: z.number().int().nonnegative(),
|
|
717
754
|
excluded: z.object({ noValue: z.number().int().nonnegative() }),
|
|
755
|
+
timeZone: z.string().min(1).optional(),
|
|
718
756
|
data,
|
|
719
757
|
});
|
|
720
758
|
}
|