@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
package/dist/blog.js
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
import { z } from 'zod';
|
|
8
8
|
import { cmsContentEnvelopeSchema } from './cms.js';
|
|
9
9
|
import { isoDateTimeSchema, multilingualStringSchema, uuidSchema } from './common.js';
|
|
10
|
+
import { storefrontPagePath } from './storefront-language-path.js';
|
|
10
11
|
// ────────────────────────────────────────────────────────────────────
|
|
11
12
|
// Domain primitives
|
|
12
13
|
// ────────────────────────────────────────────────────────────────────
|
|
@@ -81,6 +82,23 @@ export const blogPostTagRefSchema = z.object({
|
|
|
81
82
|
code: blogTagCodeSchema,
|
|
82
83
|
position: z.number().int().nonnegative(),
|
|
83
84
|
});
|
|
85
|
+
/**
|
|
86
|
+
* Feature 171 (US7) — a post's author as the admin editor sees it: an administrator,
|
|
87
|
+
* whose `state` says whether they can still be picked (`inactive`) or are gone
|
|
88
|
+
* (`deleted` — the storefront then shows no author).
|
|
89
|
+
*/
|
|
90
|
+
export const blogPostAuthorAdminSchema = z.object({
|
|
91
|
+
id: uuidSchema,
|
|
92
|
+
name: z.string(),
|
|
93
|
+
avatarUrl: z.string().nullable(),
|
|
94
|
+
state: z.enum(['active', 'inactive', 'deleted']),
|
|
95
|
+
});
|
|
96
|
+
/** `GET /api/v1/admin/blog/author-candidates` — who may be named the author: active administrators, nothing else about them. */
|
|
97
|
+
export const blogAuthorCandidateSchema = z.object({
|
|
98
|
+
id: uuidSchema,
|
|
99
|
+
name: z.string(),
|
|
100
|
+
avatarUrl: z.string().nullable(),
|
|
101
|
+
});
|
|
84
102
|
export const blogPostDetailSchema = blogPostSummarySchema.extend({
|
|
85
103
|
metaTitle: multilingualStringSchema.nullable(),
|
|
86
104
|
metaDescription: multilingualStringSchema.nullable(),
|
|
@@ -90,6 +108,8 @@ export const blogPostDetailSchema = blogPostSummarySchema.extend({
|
|
|
90
108
|
tags: z.array(blogPostTagRefSchema),
|
|
91
109
|
relatedPostIds: z.array(uuidSchema),
|
|
92
110
|
relatedProductIds: z.array(uuidSchema),
|
|
111
|
+
/** Feature 171 (US7). Optional for clients that predate it. */
|
|
112
|
+
author: blogPostAuthorAdminSchema.nullable().optional(),
|
|
93
113
|
});
|
|
94
114
|
export const createBlogPostRequestSchema = z.object({
|
|
95
115
|
name: multilingualStringSchema,
|
|
@@ -97,6 +117,8 @@ export const createBlogPostRequestSchema = z.object({
|
|
|
97
117
|
active: z.boolean().default(true),
|
|
98
118
|
description: z.string().nullable().optional(),
|
|
99
119
|
mainImageAssetId: uuidSchema.nullable().optional(),
|
|
120
|
+
/** Feature 171 (US7) — the administrator named as the post's author; `null` names none. */
|
|
121
|
+
authorAdminUserId: uuidSchema.nullable().optional(),
|
|
100
122
|
salesChannelIds: z.array(uuidSchema).min(1),
|
|
101
123
|
languages: z.array(z.string().min(2)).min(1),
|
|
102
124
|
categoryIds: z.array(uuidSchema).default([]),
|
|
@@ -224,6 +246,119 @@ export const blogTagInboundReferencesResponseSchema = z.object({
|
|
|
224
246
|
posts: z.array(blogPostInboundReferenceSchema),
|
|
225
247
|
totalPosts: z.number().int().nonnegative(),
|
|
226
248
|
});
|
|
249
|
+
/** The logical (language-less) blog path: `/<prefix>[/<key> | /tag/<code>][?page=N]`. */
|
|
250
|
+
function blogLogicalPath(input) {
|
|
251
|
+
let path = `/${input.prefix}`;
|
|
252
|
+
if (input.view === 'entry')
|
|
253
|
+
path += `/${encodeURIComponent(input.key)}`;
|
|
254
|
+
if (input.view === 'tag')
|
|
255
|
+
path += `/tag/${encodeURIComponent(input.code)}`;
|
|
256
|
+
if (input.page !== undefined && input.page >= 2)
|
|
257
|
+
path += `?page=${input.page}`;
|
|
258
|
+
return path;
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* The storefront path of a blog view under the blog prefix of its language and the
|
|
262
|
+
* language's path prefix (feature 167): `/pl/aktualnosci/porady`, `/en/news/tag/diy`.
|
|
263
|
+
*
|
|
264
|
+
* **This is the only place a blog URL is composed.** Every blog URL the platform
|
|
265
|
+
* emits — cards, tiles, tag chips, breadcrumbs, canonical and alternate URLs, the
|
|
266
|
+
* sitemap — is built here by the backend, as product URLs are by `productPath`.
|
|
267
|
+
* Page 1 carries no `?page=` (it is the canonical URL). Throws on a language the
|
|
268
|
+
* channel does not have.
|
|
269
|
+
*/
|
|
270
|
+
export function blogPath(input) {
|
|
271
|
+
return storefrontPagePath({
|
|
272
|
+
path: blogLogicalPath(input),
|
|
273
|
+
languageCode: input.languageCode,
|
|
274
|
+
channel: input.channel,
|
|
275
|
+
});
|
|
276
|
+
}
|
|
277
|
+
/** The unprefixed blog path — the `x-default` target. */
|
|
278
|
+
export function blogDefaultPath(input) {
|
|
279
|
+
return blogLogicalPath(input);
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* `GET /api/v1/blog/routing` — what the storefront middleware maps the public blog
|
|
283
|
+
* prefix with (feature 171, `contracts/storefront-api.md`). One channel: the resolved one.
|
|
284
|
+
*/
|
|
285
|
+
export const blogRoutingResponseSchema = z.object({
|
|
286
|
+
data: z.object({
|
|
287
|
+
/** `blog.url_prefix` of the channel. */
|
|
288
|
+
defaultPrefix: blogUrlPrefixSchema,
|
|
289
|
+
/** Every language of the channel → its effective prefix. */
|
|
290
|
+
prefixes: z.record(z.string(), blogUrlPrefixSchema),
|
|
291
|
+
/** Prefixes the channel served before; empty while `seo` is absent (redirects are its to serve). */
|
|
292
|
+
formerPrefixes: z.array(z.object({
|
|
293
|
+
/** `null` = a former channel default. */
|
|
294
|
+
languageCode: z.string().nullable(),
|
|
295
|
+
prefix: blogUrlPrefixSchema,
|
|
296
|
+
})),
|
|
297
|
+
}),
|
|
298
|
+
});
|
|
299
|
+
/** One row of `GET /api/v1/admin/blog/addresses` (feature 171, data-model §1.3). */
|
|
300
|
+
export const blogUrlPrefixRowSchema = z.object({
|
|
301
|
+
id: uuidSchema,
|
|
302
|
+
salesChannelId: uuidSchema,
|
|
303
|
+
languageCode: z.string().nullable(),
|
|
304
|
+
prefix: blogUrlPrefixSchema,
|
|
305
|
+
state: z.enum(['current', 'former']),
|
|
306
|
+
updatedAt: isoDateTimeSchema,
|
|
307
|
+
});
|
|
308
|
+
// ────────────────────────────────────────────────────────────────────
|
|
309
|
+
// Per-language URL keys — feature 171 (US4, data-model §1.1–1.2)
|
|
310
|
+
// ────────────────────────────────────────────────────────────────────
|
|
311
|
+
export const blogUrlKeyEntityKindSchema = z.enum(['post', 'category']);
|
|
312
|
+
/**
|
|
313
|
+
* `GET /api/v1/admin/blog/{posts|categories}/:id/url-keys`. `keys` are the language
|
|
314
|
+
* keys the editor set; a language without one is served at `slug`. `effective` is the
|
|
315
|
+
* key and path per (channel, language) the entity is served at. `redirects` is omitted
|
|
316
|
+
* while `seo` is absent — serving them is its decision.
|
|
317
|
+
*/
|
|
318
|
+
export const blogUrlKeysResponseSchema = z.object({
|
|
319
|
+
slug: blogSlugSchema,
|
|
320
|
+
keys: z.array(z.object({ languageCode: z.string(), key: blogSlugSchema })),
|
|
321
|
+
effective: z.array(z.object({ salesChannelId: uuidSchema, languageCode: z.string(), key: blogSlugSchema, path: z.string() })),
|
|
322
|
+
redirects: z.array(z.object({ id: uuidSchema, languageCode: z.string(), key: blogSlugSchema })).optional(),
|
|
323
|
+
version: z.number().int(),
|
|
324
|
+
});
|
|
325
|
+
/**
|
|
326
|
+
* `PUT …/url-keys`. Each entry sets (or, with `key: null`, removes) the key of one
|
|
327
|
+
* language; languages not named are left alone. A key another entity holds as a
|
|
328
|
+
* redirect is refused with `BLOG_URL_KEY_REDIRECT_TAKEOVER_REQUIRED` until the retry
|
|
329
|
+
* names it in `confirmTakeover`.
|
|
330
|
+
*/
|
|
331
|
+
export const putBlogUrlKeysRequestSchema = z.object({
|
|
332
|
+
keys: z.array(z.object({ languageCode: z.string().min(2), key: blogSlugSchema.nullable() })),
|
|
333
|
+
confirmTakeover: z.array(z.object({ languageCode: z.string().min(2), key: blogSlugSchema })).optional(),
|
|
334
|
+
version: z.number().int(),
|
|
335
|
+
});
|
|
336
|
+
/** The other languages of a post or category page, for `hreflang` and the language switcher. */
|
|
337
|
+
export const blogAlternatesSchema = z.object({
|
|
338
|
+
/** Language code → path, for every language of the channel the entity is in. */
|
|
339
|
+
languages: z.record(z.string(), z.string()),
|
|
340
|
+
/** The unprefixed path of the channel's default language, when the entity is in it. */
|
|
341
|
+
xDefault: z.string().nullable(),
|
|
342
|
+
});
|
|
343
|
+
/** A former key or pre-171 slug of the request language: the storefront answers 301 to `path`. */
|
|
344
|
+
export const blogRedirectResolutionSchema = z.object({
|
|
345
|
+
kind: z.literal('redirect'),
|
|
346
|
+
path: z.string(),
|
|
347
|
+
permanent: z.literal(true),
|
|
348
|
+
});
|
|
349
|
+
/**
|
|
350
|
+
* Feature 171 (US7) — the author on a post card: an administrator's display name and
|
|
351
|
+
* avatar, and nothing else about them (no e-mail, role or status).
|
|
352
|
+
*/
|
|
353
|
+
export const blogAuthorCardSchema = z.object({
|
|
354
|
+
id: uuidSchema,
|
|
355
|
+
name: z.string(),
|
|
356
|
+
avatarUrl: z.string().nullable(),
|
|
357
|
+
});
|
|
358
|
+
/** The author on the post page: the card plus the biography in the request language, else the channel default. */
|
|
359
|
+
export const blogAuthorSchema = blogAuthorCardSchema.extend({
|
|
360
|
+
bio: z.string().nullable(),
|
|
361
|
+
});
|
|
227
362
|
// ────────────────────────────────────────────────────────────────────
|
|
228
363
|
// Storefront resolved payloads
|
|
229
364
|
// ────────────────────────────────────────────────────────────────────
|
|
@@ -241,28 +376,51 @@ export const blogPostCardSchema = z.object({
|
|
|
241
376
|
* still parses.
|
|
242
377
|
*/
|
|
243
378
|
primaryCategoryName: z.string().nullable().optional(),
|
|
379
|
+
/** Feature 171 — the storefront path, composed by {@link blogPath}. Optional so a payload cached before it existed still parses. */
|
|
380
|
+
url: z.string().optional(),
|
|
381
|
+
/** Feature 171 (US7) — the administrator named as author, whoever they are now. */
|
|
382
|
+
authorId: uuidSchema.nullable().optional(),
|
|
383
|
+
/** Feature 171 (US7) — the author, filled per request (never cached); `null` when there is none. */
|
|
384
|
+
author: blogAuthorCardSchema.nullable().optional(),
|
|
244
385
|
});
|
|
245
386
|
/** Most cards one `GET /api/v1/blog/posts` returns (feature 163, contract §3). */
|
|
246
387
|
export const BLOG_POSTS_LIST_MAX_LIMIT = 24;
|
|
247
388
|
/** Cards returned when the request names no `limit`. */
|
|
248
389
|
export const BLOG_POSTS_LIST_DEFAULT_LIMIT = 6;
|
|
249
390
|
/**
|
|
250
|
-
* `GET /api/v1/blog/posts` — the
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
* nothing.
|
|
391
|
+
* `GET /api/v1/blog/posts` — the published posts of the resolved channel, newest
|
|
392
|
+
* first, page by page (feature 163; paginated by feature 171, US2), optionally
|
|
393
|
+
* filtered by category, tag and author. An unknown filter value yields an empty list
|
|
394
|
+
* rather than a 404, so a stale block setting renders nothing.
|
|
395
|
+
*
|
|
396
|
+
* `perPage` is the page size; `limit` stays as its synonym for the callers written
|
|
397
|
+
* before pagination, and `perPage` wins when both are sent. With neither, the page
|
|
398
|
+
* size is {@link BLOG_POSTS_LIST_DEFAULT_LIMIT}, as before. A page past the last
|
|
399
|
+
* answers an empty `data` with the real totals.
|
|
254
400
|
*/
|
|
255
|
-
export const blogPostsListQuerySchema = z
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
.max(BLOG_POSTS_LIST_MAX_LIMIT)
|
|
261
|
-
.default(BLOG_POSTS_LIST_DEFAULT_LIMIT),
|
|
401
|
+
export const blogPostsListQuerySchema = z
|
|
402
|
+
.object({
|
|
403
|
+
page: z.coerce.number().int().min(1).default(1),
|
|
404
|
+
perPage: z.coerce.number().int().min(1).max(BLOG_POSTS_LIST_MAX_LIMIT).optional(),
|
|
405
|
+
limit: z.coerce.number().int().min(1).max(BLOG_POSTS_LIST_MAX_LIMIT).optional(),
|
|
262
406
|
categorySlug: blogSlugSchema.optional(),
|
|
407
|
+
tagCode: blogTagCodeSchema.optional(),
|
|
408
|
+
authorId: uuidSchema.optional(),
|
|
409
|
+
})
|
|
410
|
+
.transform(({ perPage, limit, ...rest }) => ({
|
|
411
|
+
...rest,
|
|
412
|
+
perPage: perPage ?? limit ?? BLOG_POSTS_LIST_DEFAULT_LIMIT,
|
|
413
|
+
}));
|
|
414
|
+
export const blogPaginationSchema = z.object({
|
|
415
|
+
page: z.number().int().positive(),
|
|
416
|
+
perPage: z.number().int().positive(),
|
|
417
|
+
totalPages: z.number().int().nonnegative(),
|
|
418
|
+
totalItems: z.number().int().nonnegative(),
|
|
263
419
|
});
|
|
264
420
|
export const blogPostsListResponseSchema = z.object({
|
|
265
421
|
data: z.array(blogPostCardSchema),
|
|
422
|
+
/** Feature 171 — optional so a response from a backend that predates it still parses. */
|
|
423
|
+
pagination: blogPaginationSchema.optional(),
|
|
266
424
|
});
|
|
267
425
|
/**
|
|
268
426
|
* @deprecated Since issue #590 — kept parseable for one minor release, then
|
|
@@ -296,18 +454,19 @@ export const blogCategoryTileSchema = z.object({
|
|
|
296
454
|
name: z.string(),
|
|
297
455
|
slug: blogSlugSchema,
|
|
298
456
|
mainImageUrl: z.string().nullable(),
|
|
457
|
+
/** Feature 171 — the storefront path, composed by {@link blogPath}. Optional so a payload cached before it existed still parses. */
|
|
458
|
+
url: z.string().optional(),
|
|
299
459
|
});
|
|
300
460
|
export const blogIndexResponseSchema = z.object({
|
|
301
461
|
urlPrefix: blogUrlPrefixSchema,
|
|
462
|
+
/** Feature 171 — the storefront path, composed by {@link blogPath}. Optional so a payload cached before it existed still parses. */
|
|
463
|
+
url: z.string().optional(),
|
|
464
|
+
/** @deprecated Since feature 171 — equals `posts.data`; read `posts`. */
|
|
302
465
|
latestPosts: z.array(blogPostCardSchema),
|
|
466
|
+
/** Feature 171 — the index's page of posts. Optional so a payload cached before it existed still parses. */
|
|
467
|
+
posts: z.object({ data: z.array(blogPostCardSchema), pagination: blogPaginationSchema }).optional(),
|
|
303
468
|
topLevelCategories: z.array(blogCategoryTileSchema),
|
|
304
469
|
});
|
|
305
|
-
export const blogPaginationSchema = z.object({
|
|
306
|
-
page: z.number().int().positive(),
|
|
307
|
-
perPage: z.number().int().positive(),
|
|
308
|
-
totalPages: z.number().int().nonnegative(),
|
|
309
|
-
totalItems: z.number().int().nonnegative(),
|
|
310
|
-
});
|
|
311
470
|
export const blogBreadcrumbEntrySchema = z.object({
|
|
312
471
|
name: z.string(),
|
|
313
472
|
url: z.string(),
|
|
@@ -323,11 +482,17 @@ export const blogResolvedCategorySchema = z.object({
|
|
|
323
482
|
metaKeywords: z.string().nullable(),
|
|
324
483
|
childCategories: z.array(blogCategoryTileSchema),
|
|
325
484
|
breadcrumb: z.array(blogBreadcrumbEntrySchema),
|
|
485
|
+
/** Feature 171 — the storefront path, composed by {@link blogPath}. Optional so a payload cached before it existed still parses. */
|
|
486
|
+
url: z.string().optional(),
|
|
487
|
+
/** Feature 171 — the category in the channel's other languages. */
|
|
488
|
+
alternates: blogAlternatesSchema.optional(),
|
|
326
489
|
});
|
|
327
490
|
export const blogResolvedTagRefSchema = z.object({
|
|
328
491
|
id: uuidSchema,
|
|
329
492
|
code: blogTagCodeSchema,
|
|
330
493
|
name: z.string(),
|
|
494
|
+
/** Feature 171 — the storefront path, composed by {@link blogPath}. Optional so a payload cached before it existed still parses. */
|
|
495
|
+
url: z.string().optional(),
|
|
331
496
|
});
|
|
332
497
|
export const blogResolvedPostSchema = z.object({
|
|
333
498
|
id: uuidSchema,
|
|
@@ -360,6 +525,14 @@ export const blogResolvedPostSchema = z.object({
|
|
|
360
525
|
relatedProductIds: z.array(uuidSchema).optional(),
|
|
361
526
|
categories: z.array(z.object({ id: uuidSchema, name: z.string(), slug: blogSlugSchema })),
|
|
362
527
|
breadcrumb: z.array(blogBreadcrumbEntrySchema),
|
|
528
|
+
/** Feature 171 — the storefront path, composed by {@link blogPath}. Optional so a payload cached before it existed still parses. */
|
|
529
|
+
url: z.string().optional(),
|
|
530
|
+
/** Feature 171 — the post in the channel's other languages. */
|
|
531
|
+
alternates: blogAlternatesSchema.optional(),
|
|
532
|
+
/** Feature 171 (US7) — the administrator named as author, whoever they are now. */
|
|
533
|
+
authorId: uuidSchema.nullable().optional(),
|
|
534
|
+
/** Feature 171 (US7) — the author, filled per request (never cached); `null` when there is none. */
|
|
535
|
+
author: blogAuthorSchema.nullable().optional(),
|
|
363
536
|
});
|
|
364
537
|
export const blogBySlugCategoryResponseSchema = z.object({
|
|
365
538
|
kind: z.literal('category'),
|
|
@@ -376,6 +549,8 @@ export const blogBySlugPostResponseSchema = z.object({
|
|
|
376
549
|
export const blogBySlugResponseSchema = z.discriminatedUnion('kind', [
|
|
377
550
|
blogBySlugCategoryResponseSchema,
|
|
378
551
|
blogBySlugPostResponseSchema,
|
|
552
|
+
// Feature 171 — a former key, or a pre-171 slug of a language that has its own key.
|
|
553
|
+
blogRedirectResolutionSchema,
|
|
379
554
|
]);
|
|
380
555
|
export const blogTagByCodeResponseSchema = z.object({
|
|
381
556
|
tag: z.object({
|
|
@@ -383,6 +558,8 @@ export const blogTagByCodeResponseSchema = z.object({
|
|
|
383
558
|
code: blogTagCodeSchema,
|
|
384
559
|
name: z.string(),
|
|
385
560
|
description: z.string().nullable(),
|
|
561
|
+
/** Feature 171 — the storefront path, composed by {@link blogPath}. Optional so a payload cached before it existed still parses. */
|
|
562
|
+
url: z.string().optional(),
|
|
386
563
|
}),
|
|
387
564
|
posts: z.object({
|
|
388
565
|
data: z.array(blogPostCardSchema),
|
|
@@ -397,6 +574,7 @@ export const blogTagByCodeResponseSchema = z.object({
|
|
|
397
574
|
export const BLOG_SETTING_CODES = {
|
|
398
575
|
ENABLED: 'blog.enabled',
|
|
399
576
|
URL_PREFIX: 'blog.url_prefix',
|
|
577
|
+
URL_PREFIX_BY_LANGUAGE: 'blog.url_prefix_by_language',
|
|
400
578
|
LATEST_COUNT: 'blog.latest_count',
|
|
401
579
|
POSTS_PER_PAGE: 'blog.posts_per_page',
|
|
402
580
|
};
|
|
@@ -412,6 +590,10 @@ export const BLOG_SETTING_DEFAULTS = {
|
|
|
412
590
|
* setter callback (R-5) refuses any value in this set.
|
|
413
591
|
*/
|
|
414
592
|
export const BLOG_RESERVED_URL_PREFIXES = new Set([
|
|
593
|
+
// Feature 171 — the blog's own fixed sub-segments (OR-6): `/<prefix>/tag/…` and the
|
|
594
|
+
// reserved `/<prefix>/author/…` would read as a prefix of their own.
|
|
595
|
+
'tag',
|
|
596
|
+
'author',
|
|
415
597
|
'api',
|
|
416
598
|
'_next',
|
|
417
599
|
'manifest.webmanifest',
|