@aimee.shop/sdk 0.26.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/LICENSE +21 -0
- package/README.md +144 -0
- package/dist/browser/browser-auth.d.ts +115 -0
- package/dist/browser/browser-auth.d.ts.map +1 -0
- package/dist/browser/browser-auth.js +234 -0
- package/dist/browser/browser-auth.js.map +1 -0
- package/dist/browser/index.d.ts +62 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +69 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/core/auth/api-key.authenticator.d.ts +16 -0
- package/dist/core/auth/api-key.authenticator.d.ts.map +1 -0
- package/dist/core/auth/api-key.authenticator.js +28 -0
- package/dist/core/auth/api-key.authenticator.js.map +1 -0
- package/dist/core/auth/auth-chain.d.ts +33 -0
- package/dist/core/auth/auth-chain.d.ts.map +1 -0
- package/dist/core/auth/auth-chain.js +65 -0
- package/dist/core/auth/auth-chain.js.map +1 -0
- package/dist/core/auth/authenticator.d.ts +19 -0
- package/dist/core/auth/authenticator.d.ts.map +1 -0
- package/dist/core/auth/authenticator.js +2 -0
- package/dist/core/auth/authenticator.js.map +1 -0
- package/dist/core/auth/cognito.authenticator.d.ts +28 -0
- package/dist/core/auth/cognito.authenticator.d.ts.map +1 -0
- package/dist/core/auth/cognito.authenticator.js +89 -0
- package/dist/core/auth/cognito.authenticator.js.map +1 -0
- package/dist/core/auth/index.d.ts +8 -0
- package/dist/core/auth/index.d.ts.map +1 -0
- package/dist/core/auth/index.js +6 -0
- package/dist/core/auth/index.js.map +1 -0
- package/dist/core/auth/interactive.authenticator.d.ts +22 -0
- package/dist/core/auth/interactive.authenticator.d.ts.map +1 -0
- package/dist/core/auth/interactive.authenticator.js +126 -0
- package/dist/core/auth/interactive.authenticator.js.map +1 -0
- package/dist/core/auth/lazy-interactive.authenticator.d.ts +51 -0
- package/dist/core/auth/lazy-interactive.authenticator.d.ts.map +1 -0
- package/dist/core/auth/lazy-interactive.authenticator.js +112 -0
- package/dist/core/auth/lazy-interactive.authenticator.js.map +1 -0
- package/dist/core/auth/token.authenticator.d.ts +20 -0
- package/dist/core/auth/token.authenticator.d.ts.map +1 -0
- package/dist/core/auth/token.authenticator.js +45 -0
- package/dist/core/auth/token.authenticator.js.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/config.js +120 -0
- package/dist/core/config.js.map +1 -0
- package/dist/core/errors/index.d.ts +101 -0
- package/dist/core/errors/index.d.ts.map +1 -0
- package/dist/core/errors/index.js +119 -0
- package/dist/core/errors/index.js.map +1 -0
- package/dist/core/events/event-envelope.d.ts +34 -0
- package/dist/core/events/event-envelope.d.ts.map +1 -0
- package/dist/core/events/event-envelope.js +2 -0
- package/dist/core/events/event-envelope.js.map +1 -0
- package/dist/core/events/event-names.d.ts +552 -0
- package/dist/core/events/event-names.d.ts.map +1 -0
- package/dist/core/events/event-names.js +593 -0
- package/dist/core/events/event-names.js.map +1 -0
- package/dist/core/events/index.d.ts +4 -0
- package/dist/core/events/index.d.ts.map +1 -0
- package/dist/core/events/index.js +11 -0
- package/dist/core/events/index.js.map +1 -0
- package/dist/core/http-client.d.ts +88 -0
- package/dist/core/http-client.d.ts.map +1 -0
- package/dist/core/http-client.js +293 -0
- package/dist/core/http-client.js.map +1 -0
- package/dist/core/retry.d.ts +48 -0
- package/dist/core/retry.d.ts.map +1 -0
- package/dist/core/retry.js +57 -0
- package/dist/core/retry.js.map +1 -0
- package/dist/core/sdk.d.ts +153 -0
- package/dist/core/sdk.d.ts.map +1 -0
- package/dist/core/sdk.js +327 -0
- package/dist/core/sdk.js.map +1 -0
- package/dist/core/types/address.d.ts +18 -0
- package/dist/core/types/address.d.ts.map +1 -0
- package/dist/core/types/address.js +2 -0
- package/dist/core/types/address.js.map +1 -0
- package/dist/core/types/geo.d.ts +59 -0
- package/dist/core/types/geo.d.ts.map +1 -0
- package/dist/core/types/geo.js +78 -0
- package/dist/core/types/geo.js.map +1 -0
- package/dist/core/types/pagination.d.ts +42 -0
- package/dist/core/types/pagination.d.ts.map +1 -0
- package/dist/core/types/pagination.js +2 -0
- package/dist/core/types/pagination.js.map +1 -0
- package/dist/index.d.ts +68 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +37 -0
- package/dist/index.js.map +1 -0
- package/dist/services/core/assets.client.d.ts +520 -0
- package/dist/services/core/assets.client.d.ts.map +1 -0
- package/dist/services/core/assets.client.js +297 -0
- package/dist/services/core/assets.client.js.map +1 -0
- package/dist/services/core/base-resource.d.ts +70 -0
- package/dist/services/core/base-resource.d.ts.map +1 -0
- package/dist/services/core/base-resource.js +97 -0
- package/dist/services/core/base-resource.js.map +1 -0
- package/dist/services/core/cart-messages/cart-messages.client.d.ts +30 -0
- package/dist/services/core/cart-messages/cart-messages.client.d.ts.map +1 -0
- package/dist/services/core/cart-messages/cart-messages.client.js +30 -0
- package/dist/services/core/cart-messages/cart-messages.client.js.map +1 -0
- package/dist/services/core/cart-messages/index.d.ts +4 -0
- package/dist/services/core/cart-messages/index.d.ts.map +1 -0
- package/dist/services/core/cart-messages/index.js +3 -0
- package/dist/services/core/cart-messages/index.js.map +1 -0
- package/dist/services/core/cart-messages/types.d.ts +106 -0
- package/dist/services/core/cart-messages/types.d.ts.map +1 -0
- package/dist/services/core/cart-messages/types.js +6 -0
- package/dist/services/core/cart-messages/types.js.map +1 -0
- package/dist/services/core/carts.client.d.ts +253 -0
- package/dist/services/core/carts.client.d.ts.map +1 -0
- package/dist/services/core/carts.client.js +110 -0
- package/dist/services/core/carts.client.js.map +1 -0
- package/dist/services/core/categories.client.d.ts +105 -0
- package/dist/services/core/categories.client.d.ts.map +1 -0
- package/dist/services/core/categories.client.js +135 -0
- package/dist/services/core/categories.client.js.map +1 -0
- package/dist/services/core/checkout.client.d.ts +414 -0
- package/dist/services/core/checkout.client.d.ts.map +1 -0
- package/dist/services/core/checkout.client.js +153 -0
- package/dist/services/core/checkout.client.js.map +1 -0
- package/dist/services/core/cms/cms.client.d.ts +111 -0
- package/dist/services/core/cms/cms.client.d.ts.map +1 -0
- package/dist/services/core/cms/cms.client.js +148 -0
- package/dist/services/core/cms/cms.client.js.map +1 -0
- package/dist/services/core/cms/collections.client.d.ts +45 -0
- package/dist/services/core/cms/collections.client.d.ts.map +1 -0
- package/dist/services/core/cms/collections.client.js +67 -0
- package/dist/services/core/cms/collections.client.js.map +1 -0
- package/dist/services/core/cms/content-types.client.d.ts +101 -0
- package/dist/services/core/cms/content-types.client.d.ts.map +1 -0
- package/dist/services/core/cms/content-types.client.js +143 -0
- package/dist/services/core/cms/content-types.client.js.map +1 -0
- package/dist/services/core/cms/entries.client.d.ts +187 -0
- package/dist/services/core/cms/entries.client.d.ts.map +1 -0
- package/dist/services/core/cms/entries.client.js +265 -0
- package/dist/services/core/cms/entries.client.js.map +1 -0
- package/dist/services/core/cms/index.d.ts +10 -0
- package/dist/services/core/cms/index.d.ts.map +1 -0
- package/dist/services/core/cms/index.js +10 -0
- package/dist/services/core/cms/index.js.map +1 -0
- package/dist/services/core/cms/media.client.d.ts +63 -0
- package/dist/services/core/cms/media.client.d.ts.map +1 -0
- package/dist/services/core/cms/media.client.js +95 -0
- package/dist/services/core/cms/media.client.js.map +1 -0
- package/dist/services/core/cms/modules.client.d.ts +64 -0
- package/dist/services/core/cms/modules.client.d.ts.map +1 -0
- package/dist/services/core/cms/modules.client.js +88 -0
- package/dist/services/core/cms/modules.client.js.map +1 -0
- package/dist/services/core/cms/navigation.client.d.ts +78 -0
- package/dist/services/core/cms/navigation.client.d.ts.map +1 -0
- package/dist/services/core/cms/navigation.client.js +116 -0
- package/dist/services/core/cms/navigation.client.js.map +1 -0
- package/dist/services/core/cms/public.client.d.ts +64 -0
- package/dist/services/core/cms/public.client.d.ts.map +1 -0
- package/dist/services/core/cms/public.client.js +102 -0
- package/dist/services/core/cms/public.client.js.map +1 -0
- package/dist/services/core/cms/types.d.ts +804 -0
- package/dist/services/core/cms/types.d.ts.map +1 -0
- package/dist/services/core/cms/types.js +43 -0
- package/dist/services/core/cms/types.js.map +1 -0
- package/dist/services/core/customers.client.d.ts +285 -0
- package/dist/services/core/customers.client.d.ts.map +1 -0
- package/dist/services/core/customers.client.js +133 -0
- package/dist/services/core/customers.client.js.map +1 -0
- package/dist/services/core/discounts.client.d.ts +197 -0
- package/dist/services/core/discounts.client.d.ts.map +1 -0
- package/dist/services/core/discounts.client.js +81 -0
- package/dist/services/core/discounts.client.js.map +1 -0
- package/dist/services/core/exports/exports.client.d.ts +55 -0
- package/dist/services/core/exports/exports.client.d.ts.map +1 -0
- package/dist/services/core/exports/exports.client.js +80 -0
- package/dist/services/core/exports/exports.client.js.map +1 -0
- package/dist/services/core/exports/index.d.ts +4 -0
- package/dist/services/core/exports/index.d.ts.map +1 -0
- package/dist/services/core/exports/index.js +3 -0
- package/dist/services/core/exports/index.js.map +1 -0
- package/dist/services/core/exports/types.d.ts +68 -0
- package/dist/services/core/exports/types.d.ts.map +1 -0
- package/dist/services/core/exports/types.js +25 -0
- package/dist/services/core/exports/types.js.map +1 -0
- package/dist/services/core/facets.client.d.ts +127 -0
- package/dist/services/core/facets.client.d.ts.map +1 -0
- package/dist/services/core/facets.client.js +81 -0
- package/dist/services/core/facets.client.js.map +1 -0
- package/dist/services/core/fulfillments.client.d.ts +94 -0
- package/dist/services/core/fulfillments.client.d.ts.map +1 -0
- package/dist/services/core/fulfillments.client.js +66 -0
- package/dist/services/core/fulfillments.client.js.map +1 -0
- package/dist/services/core/inventory/adjustments.client.d.ts +60 -0
- package/dist/services/core/inventory/adjustments.client.d.ts.map +1 -0
- package/dist/services/core/inventory/adjustments.client.js +76 -0
- package/dist/services/core/inventory/adjustments.client.js.map +1 -0
- package/dist/services/core/inventory/index.d.ts +8 -0
- package/dist/services/core/inventory/index.d.ts.map +1 -0
- package/dist/services/core/inventory/index.js +7 -0
- package/dist/services/core/inventory/index.js.map +1 -0
- package/dist/services/core/inventory/inventory.client.d.ts +90 -0
- package/dist/services/core/inventory/inventory.client.d.ts.map +1 -0
- package/dist/services/core/inventory/inventory.client.js +135 -0
- package/dist/services/core/inventory/inventory.client.js.map +1 -0
- package/dist/services/core/inventory/locations.client.d.ts +71 -0
- package/dist/services/core/inventory/locations.client.d.ts.map +1 -0
- package/dist/services/core/inventory/locations.client.js +107 -0
- package/dist/services/core/inventory/locations.client.js.map +1 -0
- package/dist/services/core/inventory/reservations.client.d.ts +58 -0
- package/dist/services/core/inventory/reservations.client.d.ts.map +1 -0
- package/dist/services/core/inventory/reservations.client.js +87 -0
- package/dist/services/core/inventory/reservations.client.js.map +1 -0
- package/dist/services/core/inventory/stock.client.d.ts +74 -0
- package/dist/services/core/inventory/stock.client.d.ts.map +1 -0
- package/dist/services/core/inventory/stock.client.js +113 -0
- package/dist/services/core/inventory/stock.client.js.map +1 -0
- package/dist/services/core/inventory/types.d.ts +337 -0
- package/dist/services/core/inventory/types.d.ts.map +1 -0
- package/dist/services/core/inventory/types.js +2 -0
- package/dist/services/core/inventory/types.js.map +1 -0
- package/dist/services/core/invoices.client.d.ts +92 -0
- package/dist/services/core/invoices.client.d.ts.map +1 -0
- package/dist/services/core/invoices.client.js +68 -0
- package/dist/services/core/invoices.client.js.map +1 -0
- package/dist/services/core/notification-config.client.d.ts +57 -0
- package/dist/services/core/notification-config.client.d.ts.map +1 -0
- package/dist/services/core/notification-config.client.js +41 -0
- package/dist/services/core/notification-config.client.js.map +1 -0
- package/dist/services/core/openai-feed.client.d.ts +90 -0
- package/dist/services/core/openai-feed.client.d.ts.map +1 -0
- package/dist/services/core/openai-feed.client.js +63 -0
- package/dist/services/core/openai-feed.client.js.map +1 -0
- package/dist/services/core/option-types.client.d.ts +119 -0
- package/dist/services/core/option-types.client.d.ts.map +1 -0
- package/dist/services/core/option-types.client.js +81 -0
- package/dist/services/core/option-types.client.js.map +1 -0
- package/dist/services/core/option-values.client.d.ts +72 -0
- package/dist/services/core/option-values.client.d.ts.map +1 -0
- package/dist/services/core/option-values.client.js +64 -0
- package/dist/services/core/option-values.client.js.map +1 -0
- package/dist/services/core/order-edits.client.d.ts +88 -0
- package/dist/services/core/order-edits.client.d.ts.map +1 -0
- package/dist/services/core/order-edits.client.js +62 -0
- package/dist/services/core/order-edits.client.js.map +1 -0
- package/dist/services/core/orders.client.d.ts +284 -0
- package/dist/services/core/orders.client.d.ts.map +1 -0
- package/dist/services/core/orders.client.js +150 -0
- package/dist/services/core/orders.client.js.map +1 -0
- package/dist/services/core/pricing/currencies.client.d.ts +109 -0
- package/dist/services/core/pricing/currencies.client.d.ts.map +1 -0
- package/dist/services/core/pricing/currencies.client.js +145 -0
- package/dist/services/core/pricing/currencies.client.js.map +1 -0
- package/dist/services/core/pricing/customer-groups.client.d.ts +126 -0
- package/dist/services/core/pricing/customer-groups.client.d.ts.map +1 -0
- package/dist/services/core/pricing/customer-groups.client.js +154 -0
- package/dist/services/core/pricing/customer-groups.client.js.map +1 -0
- package/dist/services/core/pricing/geo-zones.client.d.ts +89 -0
- package/dist/services/core/pricing/geo-zones.client.d.ts.map +1 -0
- package/dist/services/core/pricing/geo-zones.client.js +116 -0
- package/dist/services/core/pricing/geo-zones.client.js.map +1 -0
- package/dist/services/core/pricing/index.d.ts +13 -0
- package/dist/services/core/pricing/index.d.ts.map +1 -0
- package/dist/services/core/pricing/index.js +13 -0
- package/dist/services/core/pricing/index.js.map +1 -0
- package/dist/services/core/pricing/markets.client.d.ts +154 -0
- package/dist/services/core/pricing/markets.client.d.ts.map +1 -0
- package/dist/services/core/pricing/markets.client.js +194 -0
- package/dist/services/core/pricing/markets.client.js.map +1 -0
- package/dist/services/core/pricing/pricing.client.d.ts +280 -0
- package/dist/services/core/pricing/pricing.client.d.ts.map +1 -0
- package/dist/services/core/pricing/pricing.client.js +363 -0
- package/dist/services/core/pricing/pricing.client.js.map +1 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.d.ts +79 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.d.ts.map +1 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.js +109 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.js.map +1 -0
- package/dist/services/core/pricing/product-market-settings.client.d.ts +168 -0
- package/dist/services/core/pricing/product-market-settings.client.d.ts.map +1 -0
- package/dist/services/core/pricing/product-market-settings.client.js +213 -0
- package/dist/services/core/pricing/product-market-settings.client.js.map +1 -0
- package/dist/services/core/pricing/rules.client.d.ts +46 -0
- package/dist/services/core/pricing/rules.client.d.ts.map +1 -0
- package/dist/services/core/pricing/rules.client.js +57 -0
- package/dist/services/core/pricing/rules.client.js.map +1 -0
- package/dist/services/core/pricing/store-markets.client.d.ts +168 -0
- package/dist/services/core/pricing/store-markets.client.d.ts.map +1 -0
- package/dist/services/core/pricing/store-markets.client.js +209 -0
- package/dist/services/core/pricing/store-markets.client.js.map +1 -0
- package/dist/services/core/pricing/tiers.client.d.ts +57 -0
- package/dist/services/core/pricing/tiers.client.d.ts.map +1 -0
- package/dist/services/core/pricing/tiers.client.js +72 -0
- package/dist/services/core/pricing/tiers.client.js.map +1 -0
- package/dist/services/core/pricing/types.d.ts +782 -0
- package/dist/services/core/pricing/types.d.ts.map +1 -0
- package/dist/services/core/pricing/types.js +2 -0
- package/dist/services/core/pricing/types.js.map +1 -0
- package/dist/services/core/pricing/variant-prices.client.d.ts +307 -0
- package/dist/services/core/pricing/variant-prices.client.d.ts.map +1 -0
- package/dist/services/core/pricing/variant-prices.client.js +347 -0
- package/dist/services/core/pricing/variant-prices.client.js.map +1 -0
- package/dist/services/core/product-relations.client.d.ts +260 -0
- package/dist/services/core/product-relations.client.d.ts.map +1 -0
- package/dist/services/core/product-relations.client.js +141 -0
- package/dist/services/core/product-relations.client.js.map +1 -0
- package/dist/services/core/products.client.d.ts +564 -0
- package/dist/services/core/products.client.d.ts.map +1 -0
- package/dist/services/core/products.client.js +277 -0
- package/dist/services/core/products.client.js.map +1 -0
- package/dist/services/core/returns.client.d.ts +199 -0
- package/dist/services/core/returns.client.d.ts.map +1 -0
- package/dist/services/core/returns.client.js +106 -0
- package/dist/services/core/returns.client.js.map +1 -0
- package/dist/services/core/reviews.client.d.ts +218 -0
- package/dist/services/core/reviews.client.d.ts.map +1 -0
- package/dist/services/core/reviews.client.js +161 -0
- package/dist/services/core/reviews.client.js.map +1 -0
- package/dist/services/core/search.client.d.ts +127 -0
- package/dist/services/core/search.client.d.ts.map +1 -0
- package/dist/services/core/search.client.js +120 -0
- package/dist/services/core/search.client.js.map +1 -0
- package/dist/services/core/shipping/classes.client.d.ts +20 -0
- package/dist/services/core/shipping/classes.client.d.ts.map +1 -0
- package/dist/services/core/shipping/classes.client.js +43 -0
- package/dist/services/core/shipping/classes.client.js.map +1 -0
- package/dist/services/core/shipping/index.d.ts +11 -0
- package/dist/services/core/shipping/index.d.ts.map +1 -0
- package/dist/services/core/shipping/index.js +11 -0
- package/dist/services/core/shipping/index.js.map +1 -0
- package/dist/services/core/shipping/labels.client.d.ts +20 -0
- package/dist/services/core/shipping/labels.client.d.ts.map +1 -0
- package/dist/services/core/shipping/labels.client.js +49 -0
- package/dist/services/core/shipping/labels.client.js.map +1 -0
- package/dist/services/core/shipping/providers.client.d.ts +19 -0
- package/dist/services/core/shipping/providers.client.d.ts.map +1 -0
- package/dist/services/core/shipping/providers.client.js +46 -0
- package/dist/services/core/shipping/providers.client.js.map +1 -0
- package/dist/services/core/shipping/rates.client.d.ts +19 -0
- package/dist/services/core/shipping/rates.client.d.ts.map +1 -0
- package/dist/services/core/shipping/rates.client.js +37 -0
- package/dist/services/core/shipping/rates.client.js.map +1 -0
- package/dist/services/core/shipping/rules.client.d.ts +17 -0
- package/dist/services/core/shipping/rules.client.d.ts.map +1 -0
- package/dist/services/core/shipping/rules.client.js +34 -0
- package/dist/services/core/shipping/rules.client.js.map +1 -0
- package/dist/services/core/shipping/shipper-identity.client.d.ts +49 -0
- package/dist/services/core/shipping/shipper-identity.client.d.ts.map +1 -0
- package/dist/services/core/shipping/shipper-identity.client.js +61 -0
- package/dist/services/core/shipping/shipper-identity.client.js.map +1 -0
- package/dist/services/core/shipping/shipping.client.d.ts +99 -0
- package/dist/services/core/shipping/shipping.client.d.ts.map +1 -0
- package/dist/services/core/shipping/shipping.client.js +165 -0
- package/dist/services/core/shipping/shipping.client.js.map +1 -0
- package/dist/services/core/shipping/store-providers.client.d.ts +48 -0
- package/dist/services/core/shipping/store-providers.client.d.ts.map +1 -0
- package/dist/services/core/shipping/store-providers.client.js +59 -0
- package/dist/services/core/shipping/store-providers.client.js.map +1 -0
- package/dist/services/core/shipping/types.d.ts +488 -0
- package/dist/services/core/shipping/types.d.ts.map +1 -0
- package/dist/services/core/shipping/types.js +3 -0
- package/dist/services/core/shipping/types.js.map +1 -0
- package/dist/services/core/shipping/zones.client.d.ts +16 -0
- package/dist/services/core/shipping/zones.client.d.ts.map +1 -0
- package/dist/services/core/shipping/zones.client.js +29 -0
- package/dist/services/core/shipping/zones.client.js.map +1 -0
- package/dist/services/core/storefront/index.d.ts +10 -0
- package/dist/services/core/storefront/index.d.ts.map +1 -0
- package/dist/services/core/storefront/index.js +10 -0
- package/dist/services/core/storefront/index.js.map +1 -0
- package/dist/services/core/storefront/storefront-addresses.client.d.ts +67 -0
- package/dist/services/core/storefront/storefront-addresses.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-addresses.client.js +95 -0
- package/dist/services/core/storefront/storefront-addresses.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-auth.client.d.ts +104 -0
- package/dist/services/core/storefront/storefront-auth.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-auth.client.js +132 -0
- package/dist/services/core/storefront/storefront-auth.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-orders.client.d.ts +73 -0
- package/dist/services/core/storefront/storefront-orders.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-orders.client.js +78 -0
- package/dist/services/core/storefront/storefront-orders.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-plans.client.d.ts +76 -0
- package/dist/services/core/storefront/storefront-plans.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-plans.client.js +52 -0
- package/dist/services/core/storefront/storefront-plans.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-reviews.client.d.ts +60 -0
- package/dist/services/core/storefront/storefront-reviews.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-reviews.client.js +88 -0
- package/dist/services/core/storefront/storefront-reviews.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.d.ts +199 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.js +149 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.js.map +1 -0
- package/dist/services/core/storefront/storefront.client.d.ts +166 -0
- package/dist/services/core/storefront/storefront.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront.client.js +228 -0
- package/dist/services/core/storefront/storefront.client.js.map +1 -0
- package/dist/services/core/storefront/types.d.ts +131 -0
- package/dist/services/core/storefront/types.d.ts.map +1 -0
- package/dist/services/core/storefront/types.js +3 -0
- package/dist/services/core/storefront/types.js.map +1 -0
- package/dist/services/core/storefront-redirects/index.d.ts +4 -0
- package/dist/services/core/storefront-redirects/index.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/index.js +3 -0
- package/dist/services/core/storefront-redirects/index.js.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.d.ts +79 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.js +132 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.js.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.d.ts +35 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.js +42 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.js.map +1 -0
- package/dist/services/core/storefront-redirects/types.d.ts +117 -0
- package/dist/services/core/storefront-redirects/types.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/types.js +2 -0
- package/dist/services/core/storefront-redirects/types.js.map +1 -0
- package/dist/services/core/stores/ai-discovery.client.d.ts +98 -0
- package/dist/services/core/stores/ai-discovery.client.d.ts.map +1 -0
- package/dist/services/core/stores/ai-discovery.client.js +72 -0
- package/dist/services/core/stores/ai-discovery.client.js.map +1 -0
- package/dist/services/core/stores/configuration.client.d.ts +238 -0
- package/dist/services/core/stores/configuration.client.d.ts.map +1 -0
- package/dist/services/core/stores/configuration.client.js +88 -0
- package/dist/services/core/stores/configuration.client.js.map +1 -0
- package/dist/services/core/stores/index.d.ts +11 -0
- package/dist/services/core/stores/index.d.ts.map +1 -0
- package/dist/services/core/stores/index.js +6 -0
- package/dist/services/core/stores/index.js.map +1 -0
- package/dist/services/core/stores/members.client.d.ts +91 -0
- package/dist/services/core/stores/members.client.d.ts.map +1 -0
- package/dist/services/core/stores/members.client.js +70 -0
- package/dist/services/core/stores/members.client.js.map +1 -0
- package/dist/services/core/stores/stores.client.d.ts +190 -0
- package/dist/services/core/stores/stores.client.d.ts.map +1 -0
- package/dist/services/core/stores/stores.client.js +177 -0
- package/dist/services/core/stores/stores.client.js.map +1 -0
- package/dist/services/core/stores/theme.types.d.ts +109 -0
- package/dist/services/core/stores/theme.types.d.ts.map +1 -0
- package/dist/services/core/stores/theme.types.js +27 -0
- package/dist/services/core/stores/theme.types.js.map +1 -0
- package/dist/services/core/taxes/index.d.ts +7 -0
- package/dist/services/core/taxes/index.d.ts.map +1 -0
- package/dist/services/core/taxes/index.js +7 -0
- package/dist/services/core/taxes/index.js.map +1 -0
- package/dist/services/core/taxes/jurisdictions.client.d.ts +61 -0
- package/dist/services/core/taxes/jurisdictions.client.d.ts.map +1 -0
- package/dist/services/core/taxes/jurisdictions.client.js +93 -0
- package/dist/services/core/taxes/jurisdictions.client.js.map +1 -0
- package/dist/services/core/taxes/providers.client.d.ts +111 -0
- package/dist/services/core/taxes/providers.client.d.ts.map +1 -0
- package/dist/services/core/taxes/providers.client.js +188 -0
- package/dist/services/core/taxes/providers.client.js.map +1 -0
- package/dist/services/core/taxes/rates.client.d.ts +63 -0
- package/dist/services/core/taxes/rates.client.d.ts.map +1 -0
- package/dist/services/core/taxes/rates.client.js +97 -0
- package/dist/services/core/taxes/rates.client.js.map +1 -0
- package/dist/services/core/taxes/store-providers.client.d.ts +48 -0
- package/dist/services/core/taxes/store-providers.client.d.ts.map +1 -0
- package/dist/services/core/taxes/store-providers.client.js +59 -0
- package/dist/services/core/taxes/store-providers.client.js.map +1 -0
- package/dist/services/core/taxes/taxes.client.d.ts +81 -0
- package/dist/services/core/taxes/taxes.client.d.ts.map +1 -0
- package/dist/services/core/taxes/taxes.client.js +117 -0
- package/dist/services/core/taxes/taxes.client.js.map +1 -0
- package/dist/services/core/taxes/types.d.ts +406 -0
- package/dist/services/core/taxes/types.d.ts.map +1 -0
- package/dist/services/core/taxes/types.js +3 -0
- package/dist/services/core/taxes/types.js.map +1 -0
- package/dist/services/core/variants.client.d.ts +415 -0
- package/dist/services/core/variants.client.d.ts.map +1 -0
- package/dist/services/core/variants.client.js +289 -0
- package/dist/services/core/variants.client.js.map +1 -0
- package/dist/services/core/wishlists.client.d.ts +151 -0
- package/dist/services/core/wishlists.client.d.ts.map +1 -0
- package/dist/services/core/wishlists.client.js +125 -0
- package/dist/services/core/wishlists.client.js.map +1 -0
- package/dist/storefront/index.d.ts +152 -0
- package/dist/storefront/index.d.ts.map +1 -0
- package/dist/storefront/index.js +189 -0
- package/dist/storefront/index.js.map +1 -0
- package/package.json +66 -0
|
@@ -0,0 +1,804 @@
|
|
|
1
|
+
export type CollectionType = 'blog' | 'landing_pages' | 'help_articles' | 'legal_pages' | 'custom';
|
|
2
|
+
/** Summary of the content type bound to a collection (when loaded). */
|
|
3
|
+
export interface ContentTypeSummary {
|
|
4
|
+
id: string;
|
|
5
|
+
key: string;
|
|
6
|
+
name: string;
|
|
7
|
+
publishedVersion?: number | null;
|
|
8
|
+
publishedVersionId?: string | null;
|
|
9
|
+
}
|
|
10
|
+
export interface ContentCollection {
|
|
11
|
+
id: string;
|
|
12
|
+
tenantId: string;
|
|
13
|
+
storeId?: string;
|
|
14
|
+
name: string;
|
|
15
|
+
slug: string;
|
|
16
|
+
description?: string;
|
|
17
|
+
type: CollectionType;
|
|
18
|
+
/** Authoritative tenant-owned content type definition id. */
|
|
19
|
+
contentTypeDefinitionId?: string | null;
|
|
20
|
+
/** Content type summary when the API includes the relation. */
|
|
21
|
+
contentType?: ContentTypeSummary | null;
|
|
22
|
+
settings?: Record<string, unknown>;
|
|
23
|
+
isActive: boolean;
|
|
24
|
+
createdAt: string;
|
|
25
|
+
updatedAt: string;
|
|
26
|
+
}
|
|
27
|
+
export interface CreateCollectionDto {
|
|
28
|
+
name: string;
|
|
29
|
+
slug: string;
|
|
30
|
+
/** @deprecated Prefer contentTypeDefinitionId; type is derived when definition is set. */
|
|
31
|
+
type: CollectionType;
|
|
32
|
+
description?: string;
|
|
33
|
+
contentTypeDefinitionId?: string;
|
|
34
|
+
settings?: Record<string, unknown>;
|
|
35
|
+
isActive?: boolean;
|
|
36
|
+
}
|
|
37
|
+
export interface UpdateCollectionDto {
|
|
38
|
+
name?: string;
|
|
39
|
+
slug?: string;
|
|
40
|
+
/** @deprecated Prefer contentTypeDefinitionId; type is derived when definition is set. */
|
|
41
|
+
type?: CollectionType;
|
|
42
|
+
description?: string;
|
|
43
|
+
contentTypeDefinitionId?: string | null;
|
|
44
|
+
settings?: Record<string, unknown>;
|
|
45
|
+
isActive?: boolean;
|
|
46
|
+
}
|
|
47
|
+
export interface CollectionFilters {
|
|
48
|
+
type?: string;
|
|
49
|
+
isActive?: boolean;
|
|
50
|
+
page?: number;
|
|
51
|
+
limit?: number;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Flat paginated envelope used by CMS admin list controllers
|
|
55
|
+
* (collections, entries, modules, navigation).
|
|
56
|
+
* Not the platform PaginatedResponse shape (`{ data, meta }`).
|
|
57
|
+
*/
|
|
58
|
+
export interface CmsListResponse<T> {
|
|
59
|
+
data: T[];
|
|
60
|
+
total: number;
|
|
61
|
+
page: number;
|
|
62
|
+
limit: number;
|
|
63
|
+
}
|
|
64
|
+
export type CollectionListResponse = CmsListResponse<ContentCollection>;
|
|
65
|
+
export type ContentStatus = 'draft' | 'in_review' | 'published' | 'scheduled' | 'archived';
|
|
66
|
+
export interface ContentEntry {
|
|
67
|
+
id: string;
|
|
68
|
+
tenantId: string;
|
|
69
|
+
storeId?: string;
|
|
70
|
+
collectionId: string;
|
|
71
|
+
/** Pinned published content-type schema version for this entry. */
|
|
72
|
+
contentTypeVersionId?: string | null;
|
|
73
|
+
/** Content type key derived from the pinned version definition. */
|
|
74
|
+
contentTypeKey?: string | null;
|
|
75
|
+
/** Published content-type version number. */
|
|
76
|
+
contentTypeVersion?: number | null;
|
|
77
|
+
slug: string;
|
|
78
|
+
title: string;
|
|
79
|
+
excerpt?: string;
|
|
80
|
+
featuredImageUrl?: string;
|
|
81
|
+
/** Schema-validated structured fields for the content type. */
|
|
82
|
+
fields?: Record<string, unknown>;
|
|
83
|
+
status: ContentStatus;
|
|
84
|
+
currentVersionNumber: number;
|
|
85
|
+
publishedAt?: string;
|
|
86
|
+
scheduledPublishAt?: string;
|
|
87
|
+
scheduledUnpublishAt?: string;
|
|
88
|
+
author?: string;
|
|
89
|
+
authorId?: string;
|
|
90
|
+
seoTitle?: string;
|
|
91
|
+
seoDescription?: string;
|
|
92
|
+
seoKeywords: string[];
|
|
93
|
+
tags: string[];
|
|
94
|
+
metadata?: Record<string, unknown>;
|
|
95
|
+
createdAt: string;
|
|
96
|
+
updatedAt: string;
|
|
97
|
+
blocks?: ContentBlock[];
|
|
98
|
+
}
|
|
99
|
+
export interface CreateEntryDto {
|
|
100
|
+
collectionId: string;
|
|
101
|
+
slug: string;
|
|
102
|
+
title: string;
|
|
103
|
+
excerpt?: string;
|
|
104
|
+
featuredImageUrl?: string;
|
|
105
|
+
/** Schema-validated structured fields for the content type. */
|
|
106
|
+
fields?: Record<string, unknown>;
|
|
107
|
+
author?: string;
|
|
108
|
+
authorId?: string;
|
|
109
|
+
seoTitle?: string;
|
|
110
|
+
seoDescription?: string;
|
|
111
|
+
seoKeywords?: string[];
|
|
112
|
+
tags?: string[];
|
|
113
|
+
metadata?: Record<string, unknown>;
|
|
114
|
+
blocks?: CreateBlockDto[];
|
|
115
|
+
}
|
|
116
|
+
export interface UpdateEntryDto {
|
|
117
|
+
slug?: string;
|
|
118
|
+
title?: string;
|
|
119
|
+
excerpt?: string;
|
|
120
|
+
featuredImageUrl?: string;
|
|
121
|
+
/** Schema-validated structured fields for the content type. */
|
|
122
|
+
fields?: Record<string, unknown>;
|
|
123
|
+
author?: string;
|
|
124
|
+
authorId?: string;
|
|
125
|
+
seoTitle?: string;
|
|
126
|
+
seoDescription?: string;
|
|
127
|
+
seoKeywords?: string[];
|
|
128
|
+
tags?: string[];
|
|
129
|
+
metadata?: Record<string, unknown>;
|
|
130
|
+
changelog?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Optional ISO 8601 publish timestamp for already-published entries
|
|
133
|
+
* (archive backfill). Only valid when the entry is already published.
|
|
134
|
+
* Future timestamps are rejected by the API; use entries.schedule for
|
|
135
|
+
* future publish.
|
|
136
|
+
*/
|
|
137
|
+
publishedAt?: string;
|
|
138
|
+
}
|
|
139
|
+
export interface EntryFilters {
|
|
140
|
+
collectionId?: string;
|
|
141
|
+
status?: string;
|
|
142
|
+
authorId?: string;
|
|
143
|
+
tags?: string[];
|
|
144
|
+
page?: number;
|
|
145
|
+
limit?: number;
|
|
146
|
+
}
|
|
147
|
+
export type EntryListResponse = CmsListResponse<ContentEntry>;
|
|
148
|
+
/** Max entries per synchronous batch (core-api CMS_ENTRY_BATCH_MAX_SIZE). */
|
|
149
|
+
export declare const CMS_ENTRY_BATCH_MAX_SIZE = 200;
|
|
150
|
+
/** Per-item outcome from POST /v1/cms/entries/batch. */
|
|
151
|
+
export type BatchContentEntryItemStatus = 'created' | 'updated' | 'skipped' | 'error';
|
|
152
|
+
/** Overall batch outcome from POST /v1/cms/entries/batch. */
|
|
153
|
+
export type BatchContentEntriesStatus = 'success' | 'partial' | 'failed';
|
|
154
|
+
/**
|
|
155
|
+
* Batch create/upsert request (1..200 entries).
|
|
156
|
+
* Mirrors core-api BatchCreateContentEntriesDto.
|
|
157
|
+
*/
|
|
158
|
+
export interface BatchCreateEntriesDto {
|
|
159
|
+
/** Entries to create or upsert (max {@link CMS_ENTRY_BATCH_MAX_SIZE}). */
|
|
160
|
+
entries: CreateEntryDto[];
|
|
161
|
+
/**
|
|
162
|
+
* When true, existing slugs in the same collection are updated;
|
|
163
|
+
* when false (default), they are skipped.
|
|
164
|
+
*/
|
|
165
|
+
updateExisting?: boolean;
|
|
166
|
+
/**
|
|
167
|
+
* When true, successfully created/updated draft entries are published after write.
|
|
168
|
+
*/
|
|
169
|
+
publish?: boolean;
|
|
170
|
+
}
|
|
171
|
+
/** Per-item result from batch create/upsert. */
|
|
172
|
+
export interface BatchContentEntryResult {
|
|
173
|
+
/** Zero-based index in the request entries array. */
|
|
174
|
+
index: number;
|
|
175
|
+
/** Entry id when known. */
|
|
176
|
+
id?: string;
|
|
177
|
+
/** Entry slug when known. */
|
|
178
|
+
slug?: string;
|
|
179
|
+
status: BatchContentEntryItemStatus;
|
|
180
|
+
/** Error message when status is error. */
|
|
181
|
+
error?: string;
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Batch create/upsert response.
|
|
185
|
+
* HTTP status is always 200; branch on `status` and per-item `results`.
|
|
186
|
+
*/
|
|
187
|
+
export interface BatchCreateEntriesResult {
|
|
188
|
+
status: BatchContentEntriesStatus;
|
|
189
|
+
createdCount: number;
|
|
190
|
+
updatedCount: number;
|
|
191
|
+
skippedCount: number;
|
|
192
|
+
errorCount: number;
|
|
193
|
+
results: BatchContentEntryResult[];
|
|
194
|
+
}
|
|
195
|
+
export type BlockType = 'text' | 'heading' | 'image' | 'gallery' | 'video' | 'embed' | 'cta' | 'product_card' | 'product_grid' | 'quote' | 'code' | 'divider' | 'spacer' | 'accordion' | 'tabs' | 'custom' | 'form_embed' | 'hero' | 'promo_banner' | 'card_grid' | 'comparison_table' | 'video_lightbox' | 'columns' | 'container';
|
|
196
|
+
/**
|
|
197
|
+
* Nested block payload embedded in composition block content
|
|
198
|
+
* (`columns` / `container`). Not a separate CMS ContentBlock row.
|
|
199
|
+
*/
|
|
200
|
+
export interface NestedBlock {
|
|
201
|
+
type: BlockType;
|
|
202
|
+
content: Record<string, unknown>;
|
|
203
|
+
settings?: Record<string, unknown>;
|
|
204
|
+
}
|
|
205
|
+
/** Content shape for BlockType 'columns' (Adaptive Cards ColumnSet parity). */
|
|
206
|
+
export interface ColumnsBlockContent {
|
|
207
|
+
columns: Array<{
|
|
208
|
+
width: 'auto' | number;
|
|
209
|
+
blocks: NestedBlock[];
|
|
210
|
+
}>;
|
|
211
|
+
}
|
|
212
|
+
/** Content shape for BlockType 'container' (Adaptive Cards Container parity). */
|
|
213
|
+
export interface ContainerBlockContent {
|
|
214
|
+
blocks: NestedBlock[];
|
|
215
|
+
style?: 'default' | 'emphasis' | 'accent';
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Narrow a block's `Record<string, unknown>` content to ColumnsBlockContent.
|
|
219
|
+
* Structural check only -- children are validated server-side.
|
|
220
|
+
*/
|
|
221
|
+
export declare function isColumnsBlockContent(content: Record<string, unknown>): content is Record<string, unknown> & ColumnsBlockContent;
|
|
222
|
+
/**
|
|
223
|
+
* Narrow a block's `Record<string, unknown>` content to ContainerBlockContent.
|
|
224
|
+
* Structural check only -- children are validated server-side.
|
|
225
|
+
*/
|
|
226
|
+
export declare function isContainerBlockContent(content: Record<string, unknown>): content is Record<string, unknown> & ContainerBlockContent;
|
|
227
|
+
export interface ContentBlock {
|
|
228
|
+
id: string;
|
|
229
|
+
entryId: string;
|
|
230
|
+
type: BlockType;
|
|
231
|
+
sortOrder: number;
|
|
232
|
+
content: Record<string, unknown>;
|
|
233
|
+
settings?: Record<string, unknown>;
|
|
234
|
+
createdAt: string;
|
|
235
|
+
updatedAt: string;
|
|
236
|
+
}
|
|
237
|
+
export interface CreateBlockDto {
|
|
238
|
+
type: BlockType;
|
|
239
|
+
content: Record<string, unknown>;
|
|
240
|
+
sortOrder?: number;
|
|
241
|
+
settings?: Record<string, unknown>;
|
|
242
|
+
}
|
|
243
|
+
export interface UpdateBlockDto {
|
|
244
|
+
type?: BlockType;
|
|
245
|
+
content?: Record<string, unknown>;
|
|
246
|
+
sortOrder?: number;
|
|
247
|
+
settings?: Record<string, unknown>;
|
|
248
|
+
}
|
|
249
|
+
export interface ReorderBlocksDto {
|
|
250
|
+
blocks: Array<{
|
|
251
|
+
id: string;
|
|
252
|
+
sortOrder: number;
|
|
253
|
+
}>;
|
|
254
|
+
}
|
|
255
|
+
export interface WorkflowStatus {
|
|
256
|
+
currentStatus: string;
|
|
257
|
+
validActions: string[];
|
|
258
|
+
scheduledPublishAt?: string;
|
|
259
|
+
scheduledUnpublishAt?: string;
|
|
260
|
+
currentVersion: number;
|
|
261
|
+
publishedAt?: string;
|
|
262
|
+
}
|
|
263
|
+
export interface SubmitForReviewDto {
|
|
264
|
+
reviewNotes?: string;
|
|
265
|
+
}
|
|
266
|
+
export interface ApproveContentDto {
|
|
267
|
+
publishImmediately?: boolean;
|
|
268
|
+
}
|
|
269
|
+
export interface RejectContentDto {
|
|
270
|
+
feedback?: string;
|
|
271
|
+
}
|
|
272
|
+
export interface PublishContentDto {
|
|
273
|
+
changelog?: string;
|
|
274
|
+
/**
|
|
275
|
+
* Optional ISO 8601 publish timestamp (backdate). Omitted -> server uses
|
|
276
|
+
* now. Future timestamps are rejected by the API; use entries.schedule for
|
|
277
|
+
* future publish.
|
|
278
|
+
*/
|
|
279
|
+
publishedAt?: string;
|
|
280
|
+
}
|
|
281
|
+
export interface ScheduleContentDto {
|
|
282
|
+
scheduledPublishAt?: string;
|
|
283
|
+
scheduledUnpublishAt?: string;
|
|
284
|
+
changelog?: string;
|
|
285
|
+
}
|
|
286
|
+
export interface ContentVersion {
|
|
287
|
+
id: string;
|
|
288
|
+
entryId: string;
|
|
289
|
+
version: number;
|
|
290
|
+
title: string;
|
|
291
|
+
excerpt?: string;
|
|
292
|
+
blocks: Record<string, unknown>[] | string[];
|
|
293
|
+
/** Structured fields snapshot when entry used a content type. */
|
|
294
|
+
fields?: Record<string, unknown>;
|
|
295
|
+
contentTypeVersionId?: string | null;
|
|
296
|
+
changelog?: string;
|
|
297
|
+
publishedBy?: string;
|
|
298
|
+
publishedAt?: string;
|
|
299
|
+
createdBy: string;
|
|
300
|
+
createdAt: string;
|
|
301
|
+
}
|
|
302
|
+
export interface CreateVersionDto {
|
|
303
|
+
changelog?: string;
|
|
304
|
+
}
|
|
305
|
+
export interface VersionFilters {
|
|
306
|
+
skip?: number;
|
|
307
|
+
take?: number;
|
|
308
|
+
}
|
|
309
|
+
export interface PreviewToken {
|
|
310
|
+
token: string;
|
|
311
|
+
expiresAt: string;
|
|
312
|
+
previewUrl: string;
|
|
313
|
+
}
|
|
314
|
+
export interface ContentModule {
|
|
315
|
+
id: string;
|
|
316
|
+
tenantId: string;
|
|
317
|
+
storeId?: string;
|
|
318
|
+
name: string;
|
|
319
|
+
slug: string;
|
|
320
|
+
description?: string;
|
|
321
|
+
blocks: Record<string, unknown>[];
|
|
322
|
+
isActive: boolean;
|
|
323
|
+
createdAt: string;
|
|
324
|
+
updatedAt: string;
|
|
325
|
+
}
|
|
326
|
+
export interface CreateModuleDto {
|
|
327
|
+
name: string;
|
|
328
|
+
slug: string;
|
|
329
|
+
description?: string;
|
|
330
|
+
blocks: CreateBlockDto[];
|
|
331
|
+
isActive?: boolean;
|
|
332
|
+
}
|
|
333
|
+
export interface UpdateModuleDto {
|
|
334
|
+
name?: string;
|
|
335
|
+
slug?: string;
|
|
336
|
+
description?: string;
|
|
337
|
+
blocks?: CreateBlockDto[];
|
|
338
|
+
isActive?: boolean;
|
|
339
|
+
}
|
|
340
|
+
export interface ModuleFilters {
|
|
341
|
+
isActive?: boolean;
|
|
342
|
+
page?: number;
|
|
343
|
+
limit?: number;
|
|
344
|
+
}
|
|
345
|
+
export type ModuleListResponse = CmsListResponse<ContentModule>;
|
|
346
|
+
export interface AttachModuleDto {
|
|
347
|
+
entityType: string;
|
|
348
|
+
entityId: string;
|
|
349
|
+
placement?: string;
|
|
350
|
+
sortOrder?: number;
|
|
351
|
+
}
|
|
352
|
+
export interface ModuleAttachment {
|
|
353
|
+
id: string;
|
|
354
|
+
moduleId: string;
|
|
355
|
+
entityType: string;
|
|
356
|
+
entityId: string;
|
|
357
|
+
placement: string;
|
|
358
|
+
sortOrder: number;
|
|
359
|
+
isActive: boolean;
|
|
360
|
+
createdAt: string;
|
|
361
|
+
module?: ContentModule;
|
|
362
|
+
}
|
|
363
|
+
export interface ContentMedia {
|
|
364
|
+
id: string;
|
|
365
|
+
tenantId: string;
|
|
366
|
+
storeId?: string;
|
|
367
|
+
filename: string;
|
|
368
|
+
originalName: string;
|
|
369
|
+
url: string;
|
|
370
|
+
cdnUrl?: string;
|
|
371
|
+
mimeType: string;
|
|
372
|
+
size: number;
|
|
373
|
+
width?: number;
|
|
374
|
+
height?: number;
|
|
375
|
+
altText?: string;
|
|
376
|
+
caption?: string;
|
|
377
|
+
folderId?: string;
|
|
378
|
+
metadata?: Record<string, unknown>;
|
|
379
|
+
isOptimized: boolean;
|
|
380
|
+
optimizedVersions?: Record<string, unknown>;
|
|
381
|
+
createdAt: string;
|
|
382
|
+
updatedAt: string;
|
|
383
|
+
}
|
|
384
|
+
export interface PresignedUrlRequest {
|
|
385
|
+
filename: string;
|
|
386
|
+
mimeType: string;
|
|
387
|
+
folderId?: string;
|
|
388
|
+
}
|
|
389
|
+
export interface PresignedUrlResponse {
|
|
390
|
+
uploadUrl: string;
|
|
391
|
+
s3Key: string;
|
|
392
|
+
publicUrl: string;
|
|
393
|
+
cdnUrl?: string;
|
|
394
|
+
expiresAt: string;
|
|
395
|
+
}
|
|
396
|
+
export interface ConfirmUploadDto {
|
|
397
|
+
s3Key: string;
|
|
398
|
+
filename: string;
|
|
399
|
+
originalName: string;
|
|
400
|
+
mimeType: string;
|
|
401
|
+
size: number;
|
|
402
|
+
width?: number;
|
|
403
|
+
height?: number;
|
|
404
|
+
altText?: string;
|
|
405
|
+
caption?: string;
|
|
406
|
+
folderId?: string;
|
|
407
|
+
metadata?: Record<string, unknown>;
|
|
408
|
+
}
|
|
409
|
+
export interface UpdateMediaDto {
|
|
410
|
+
altText?: string;
|
|
411
|
+
caption?: string;
|
|
412
|
+
folderId?: string;
|
|
413
|
+
metadata?: Record<string, unknown>;
|
|
414
|
+
}
|
|
415
|
+
export interface MediaFilters {
|
|
416
|
+
folderId?: string;
|
|
417
|
+
mimeType?: string;
|
|
418
|
+
skip?: number;
|
|
419
|
+
take?: number;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Media list envelope from GET /v1/cms/media.
|
|
423
|
+
* Uses `items` (not `data`) and has no page/limit in the body.
|
|
424
|
+
*/
|
|
425
|
+
export interface MediaListResponse {
|
|
426
|
+
items: ContentMedia[];
|
|
427
|
+
total: number;
|
|
428
|
+
}
|
|
429
|
+
export interface DownloadUrlResponse {
|
|
430
|
+
downloadUrl: string;
|
|
431
|
+
expiresAt: string;
|
|
432
|
+
}
|
|
433
|
+
export interface PublicContentFilters {
|
|
434
|
+
page?: number;
|
|
435
|
+
limit?: number;
|
|
436
|
+
tags?: string;
|
|
437
|
+
}
|
|
438
|
+
export interface PublicContentEntry {
|
|
439
|
+
id: string;
|
|
440
|
+
slug: string;
|
|
441
|
+
title: string;
|
|
442
|
+
excerpt?: string | null;
|
|
443
|
+
featuredImageUrl?: string | null;
|
|
444
|
+
publishedAt?: string | null;
|
|
445
|
+
author?: string | null;
|
|
446
|
+
contentTypeKey?: string | null;
|
|
447
|
+
contentTypeVersion?: number | null;
|
|
448
|
+
fields?: Record<string, unknown>;
|
|
449
|
+
tags: string[];
|
|
450
|
+
blocks?: Array<{
|
|
451
|
+
type: string;
|
|
452
|
+
content: Record<string, unknown>;
|
|
453
|
+
sortOrder: number;
|
|
454
|
+
}>;
|
|
455
|
+
seo?: {
|
|
456
|
+
title?: string | null;
|
|
457
|
+
description?: string | null;
|
|
458
|
+
keywords?: string[];
|
|
459
|
+
};
|
|
460
|
+
collection?: {
|
|
461
|
+
name: string;
|
|
462
|
+
slug: string;
|
|
463
|
+
};
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* Public list response from GET /v1/content/:collectionSlug
|
|
467
|
+
* (matches core CmsDeliveryService PublicContentListResponse).
|
|
468
|
+
*/
|
|
469
|
+
export interface PublicContentList {
|
|
470
|
+
items: PublicContentEntry[];
|
|
471
|
+
total: number;
|
|
472
|
+
page: number;
|
|
473
|
+
limit: number;
|
|
474
|
+
totalPages: number;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* Published module payload nested on public attachments
|
|
478
|
+
* (matches core CmsDeliveryService PublicModuleAttachment.module).
|
|
479
|
+
*/
|
|
480
|
+
export interface PublicModule {
|
|
481
|
+
id: string;
|
|
482
|
+
name: string;
|
|
483
|
+
slug: string;
|
|
484
|
+
description: string | null;
|
|
485
|
+
blocks: unknown[];
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* Public module attachment from GET /v1/content/modules/by-entity
|
|
489
|
+
* (matches core CmsDeliveryService PublicModuleAttachment).
|
|
490
|
+
*/
|
|
491
|
+
export interface PublicModuleAttachment {
|
|
492
|
+
id: string;
|
|
493
|
+
entityType: string;
|
|
494
|
+
entityId: string;
|
|
495
|
+
placement: string;
|
|
496
|
+
sortOrder: number;
|
|
497
|
+
module: PublicModule;
|
|
498
|
+
}
|
|
499
|
+
export interface PublicModulesResponse {
|
|
500
|
+
items: PublicModuleAttachment[];
|
|
501
|
+
}
|
|
502
|
+
export interface PublicModulesByEntityQuery {
|
|
503
|
+
entityType: string;
|
|
504
|
+
entityId: string;
|
|
505
|
+
}
|
|
506
|
+
export interface PublicModulesByEntityOptions {
|
|
507
|
+
/**
|
|
508
|
+
* Prior ETag for this tenant/store entity. When the resolved attachments
|
|
509
|
+
* are unchanged, the API returns 304 (surfaced as NotModifiedError).
|
|
510
|
+
* The SDK transport returns response bodies only; store ETags client-side if needed.
|
|
511
|
+
*/
|
|
512
|
+
ifNoneMatch?: string;
|
|
513
|
+
}
|
|
514
|
+
export declare const CONTENT_FIELD_TYPES: readonly ["short_text", "long_text", "rich_text", "number", "boolean", "date", "datetime", "url", "select", "asset_reference", "content_reference", "product_reference"];
|
|
515
|
+
export type ContentFieldType = (typeof CONTENT_FIELD_TYPES)[number];
|
|
516
|
+
export interface BaseFieldDefinition {
|
|
517
|
+
key: string;
|
|
518
|
+
label: string;
|
|
519
|
+
helpText?: string;
|
|
520
|
+
required: boolean;
|
|
521
|
+
type: ContentFieldType;
|
|
522
|
+
defaultValue?: unknown;
|
|
523
|
+
multiple?: boolean;
|
|
524
|
+
validations?: Record<string, unknown>;
|
|
525
|
+
}
|
|
526
|
+
export interface ShortTextFieldDefinition extends BaseFieldDefinition {
|
|
527
|
+
type: 'short_text';
|
|
528
|
+
validations?: {
|
|
529
|
+
minLength?: number;
|
|
530
|
+
maxLength?: number;
|
|
531
|
+
allowedValues?: string[];
|
|
532
|
+
};
|
|
533
|
+
}
|
|
534
|
+
export interface LongTextFieldDefinition extends BaseFieldDefinition {
|
|
535
|
+
type: 'long_text';
|
|
536
|
+
validations?: {
|
|
537
|
+
minLength?: number;
|
|
538
|
+
maxLength?: number;
|
|
539
|
+
};
|
|
540
|
+
}
|
|
541
|
+
export interface RichTextFieldDefinition extends BaseFieldDefinition {
|
|
542
|
+
type: 'rich_text';
|
|
543
|
+
}
|
|
544
|
+
export interface NumberFieldDefinition extends BaseFieldDefinition {
|
|
545
|
+
type: 'number';
|
|
546
|
+
validations?: {
|
|
547
|
+
min?: number;
|
|
548
|
+
max?: number;
|
|
549
|
+
integerOnly?: boolean;
|
|
550
|
+
};
|
|
551
|
+
}
|
|
552
|
+
export interface BooleanFieldDefinition extends BaseFieldDefinition {
|
|
553
|
+
type: 'boolean';
|
|
554
|
+
}
|
|
555
|
+
export interface DateFieldDefinition extends BaseFieldDefinition {
|
|
556
|
+
type: 'date';
|
|
557
|
+
}
|
|
558
|
+
export interface DateTimeFieldDefinition extends BaseFieldDefinition {
|
|
559
|
+
type: 'datetime';
|
|
560
|
+
}
|
|
561
|
+
export interface UrlFieldDefinition extends BaseFieldDefinition {
|
|
562
|
+
type: 'url';
|
|
563
|
+
}
|
|
564
|
+
export interface SelectFieldDefinition extends BaseFieldDefinition {
|
|
565
|
+
type: 'select';
|
|
566
|
+
multiple?: boolean;
|
|
567
|
+
validations: {
|
|
568
|
+
options: Array<{
|
|
569
|
+
value: string;
|
|
570
|
+
label: string;
|
|
571
|
+
}>;
|
|
572
|
+
};
|
|
573
|
+
}
|
|
574
|
+
export interface AssetReferenceFieldDefinition extends BaseFieldDefinition {
|
|
575
|
+
type: 'asset_reference';
|
|
576
|
+
multiple?: boolean;
|
|
577
|
+
}
|
|
578
|
+
export interface ContentReferenceFieldDefinition extends BaseFieldDefinition {
|
|
579
|
+
type: 'content_reference';
|
|
580
|
+
multiple?: boolean;
|
|
581
|
+
validations?: {
|
|
582
|
+
contentTypeKey?: string;
|
|
583
|
+
};
|
|
584
|
+
}
|
|
585
|
+
export interface ProductReferenceFieldDefinition extends BaseFieldDefinition {
|
|
586
|
+
type: 'product_reference';
|
|
587
|
+
multiple?: boolean;
|
|
588
|
+
}
|
|
589
|
+
/** Discriminated union of closed field-definition DSL primitives. */
|
|
590
|
+
export type ContentFieldDefinition = ShortTextFieldDefinition | LongTextFieldDefinition | RichTextFieldDefinition | NumberFieldDefinition | BooleanFieldDefinition | DateFieldDefinition | DateTimeFieldDefinition | UrlFieldDefinition | SelectFieldDefinition | AssetReferenceFieldDefinition | ContentReferenceFieldDefinition | ProductReferenceFieldDefinition;
|
|
591
|
+
export type ContentTypeDefinitionStatus = 'active' | 'archived';
|
|
592
|
+
export type ContentTypeSource = 'starter' | 'custom';
|
|
593
|
+
export type ContentTypeVersionStatus = 'draft' | 'published' | 'archived';
|
|
594
|
+
export interface ContentTypeDefinition {
|
|
595
|
+
id: string;
|
|
596
|
+
tenantId: string;
|
|
597
|
+
key: string;
|
|
598
|
+
name: string;
|
|
599
|
+
description?: string | null;
|
|
600
|
+
source: ContentTypeSource;
|
|
601
|
+
starterKey?: string | null;
|
|
602
|
+
status: ContentTypeDefinitionStatus;
|
|
603
|
+
publishedVersionId?: string | null;
|
|
604
|
+
createdAt: string;
|
|
605
|
+
updatedAt: string;
|
|
606
|
+
}
|
|
607
|
+
export interface ContentTypeVersion {
|
|
608
|
+
id: string;
|
|
609
|
+
tenantId: string;
|
|
610
|
+
contentTypeDefinitionId: string;
|
|
611
|
+
version: number;
|
|
612
|
+
status: ContentTypeVersionStatus;
|
|
613
|
+
schemaVersion: number;
|
|
614
|
+
/** Closed field-definition DSL (not free JSON Schema). */
|
|
615
|
+
fields: ContentFieldDefinition[];
|
|
616
|
+
publishedAt?: string | null;
|
|
617
|
+
publishedBy?: string | null;
|
|
618
|
+
createdAt: string;
|
|
619
|
+
updatedAt: string;
|
|
620
|
+
}
|
|
621
|
+
export interface ContentTypeDefinitionList {
|
|
622
|
+
data: ContentTypeDefinition[];
|
|
623
|
+
total: number;
|
|
624
|
+
}
|
|
625
|
+
export interface ContentTypeDefinitionWithVersion {
|
|
626
|
+
definition: ContentTypeDefinition;
|
|
627
|
+
version: ContentTypeVersion;
|
|
628
|
+
}
|
|
629
|
+
export interface CreateContentTypeDefinitionDto {
|
|
630
|
+
key: string;
|
|
631
|
+
name: string;
|
|
632
|
+
description?: string;
|
|
633
|
+
fields?: ContentFieldDefinition[];
|
|
634
|
+
}
|
|
635
|
+
export interface UpdateContentTypeDefinitionDto {
|
|
636
|
+
name?: string;
|
|
637
|
+
description?: string | null;
|
|
638
|
+
}
|
|
639
|
+
export interface CloneContentTypeDefinitionDto {
|
|
640
|
+
key: string;
|
|
641
|
+
name?: string;
|
|
642
|
+
}
|
|
643
|
+
export interface InstallStarterDto {
|
|
644
|
+
starterKey: string;
|
|
645
|
+
}
|
|
646
|
+
export interface ContentTypeVersionDraftDto {
|
|
647
|
+
fields: ContentFieldDefinition[];
|
|
648
|
+
}
|
|
649
|
+
export interface ValidateSchemaDto {
|
|
650
|
+
fields: ContentFieldDefinition[];
|
|
651
|
+
}
|
|
652
|
+
export interface ValidateFieldsDto {
|
|
653
|
+
fields: Record<string, unknown>;
|
|
654
|
+
}
|
|
655
|
+
export interface ContentTypeDefinitionFilters {
|
|
656
|
+
status?: ContentTypeDefinitionStatus;
|
|
657
|
+
page?: number;
|
|
658
|
+
limit?: number;
|
|
659
|
+
}
|
|
660
|
+
export interface ContentTypeStarter {
|
|
661
|
+
key: string;
|
|
662
|
+
name: string;
|
|
663
|
+
description: string;
|
|
664
|
+
fields: ContentFieldDefinition[];
|
|
665
|
+
}
|
|
666
|
+
export interface ContentTypeValidationError {
|
|
667
|
+
field: string;
|
|
668
|
+
message: string;
|
|
669
|
+
code: string;
|
|
670
|
+
}
|
|
671
|
+
export interface ContentTypeValidationResult {
|
|
672
|
+
valid: boolean;
|
|
673
|
+
errors?: ContentTypeValidationError[];
|
|
674
|
+
fields?: Record<string, unknown>;
|
|
675
|
+
}
|
|
676
|
+
export type NavigationTargetType = 'product' | 'category' | 'content_entry' | 'internal_path' | 'external_url' | 'anchor';
|
|
677
|
+
export interface Navigation {
|
|
678
|
+
id: string;
|
|
679
|
+
tenantId: string;
|
|
680
|
+
storeId: string;
|
|
681
|
+
handle: string;
|
|
682
|
+
title: string;
|
|
683
|
+
locale: string;
|
|
684
|
+
isActive: boolean;
|
|
685
|
+
revision: number;
|
|
686
|
+
createdAt: string;
|
|
687
|
+
updatedAt: string;
|
|
688
|
+
}
|
|
689
|
+
export interface CreateNavigationDto {
|
|
690
|
+
handle: string;
|
|
691
|
+
title: string;
|
|
692
|
+
locale?: string;
|
|
693
|
+
isActive?: boolean;
|
|
694
|
+
}
|
|
695
|
+
export interface UpdateNavigationDto {
|
|
696
|
+
handle?: string;
|
|
697
|
+
title?: string;
|
|
698
|
+
locale?: string;
|
|
699
|
+
isActive?: boolean;
|
|
700
|
+
}
|
|
701
|
+
export interface NavigationFilters {
|
|
702
|
+
locale?: string;
|
|
703
|
+
isActive?: boolean;
|
|
704
|
+
page?: number;
|
|
705
|
+
limit?: number;
|
|
706
|
+
}
|
|
707
|
+
export type NavigationListResponse = CmsListResponse<Navigation>;
|
|
708
|
+
export interface ReplaceTreeItemDto {
|
|
709
|
+
/** Client id for parent references (UUID or temp key). */
|
|
710
|
+
clientId?: string;
|
|
711
|
+
parentClientId?: string | null;
|
|
712
|
+
label: string;
|
|
713
|
+
position: number;
|
|
714
|
+
targetType: NavigationTargetType;
|
|
715
|
+
productId?: string | null;
|
|
716
|
+
categoryId?: string | null;
|
|
717
|
+
contentEntryId?: string | null;
|
|
718
|
+
path?: string | null;
|
|
719
|
+
externalUrl?: string | null;
|
|
720
|
+
anchor?: string | null;
|
|
721
|
+
opensInNewTab?: boolean;
|
|
722
|
+
badge?: string | null;
|
|
723
|
+
isActive?: boolean;
|
|
724
|
+
}
|
|
725
|
+
export interface ReplaceNavigationTreeDto {
|
|
726
|
+
items: ReplaceTreeItemDto[];
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* Max nesting depth for navigation trees (matches core-api validator).
|
|
730
|
+
* Trees deeper than this are rejected on replaceTree.
|
|
731
|
+
*/
|
|
732
|
+
export declare const NAVIGATION_MAX_DEPTH: 3;
|
|
733
|
+
/**
|
|
734
|
+
* Why an admin tree node is marked broken. Aligns with core-api evaluateBroken.
|
|
735
|
+
*/
|
|
736
|
+
export type NavigationBrokenReason = 'missing_product_id' | 'product_not_found' | 'product_wrong_tenant' | 'product_wrong_store' | 'product_disabled' | 'missing_category_id' | 'category_not_found' | 'category_wrong_tenant' | 'category_wrong_store' | 'category_inactive' | 'missing_content_entry_id' | 'content_entry_missing_or_deleted' | 'content_entry_wrong_tenant' | 'content_entry_wrong_store' | 'content_entry_not_published' | 'missing_path' | 'missing_external_url' | 'missing_anchor' | 'unknown_target_type';
|
|
737
|
+
export interface AdminNavigationNode {
|
|
738
|
+
id: string;
|
|
739
|
+
parentId: string | null;
|
|
740
|
+
label: string;
|
|
741
|
+
position: number;
|
|
742
|
+
targetType: NavigationTargetType;
|
|
743
|
+
productId: string | null;
|
|
744
|
+
categoryId: string | null;
|
|
745
|
+
contentEntryId: string | null;
|
|
746
|
+
path: string | null;
|
|
747
|
+
externalUrl: string | null;
|
|
748
|
+
anchor: string | null;
|
|
749
|
+
opensInNewTab: boolean;
|
|
750
|
+
badge: string | null;
|
|
751
|
+
isActive: boolean;
|
|
752
|
+
broken: boolean;
|
|
753
|
+
brokenReason: NavigationBrokenReason | null;
|
|
754
|
+
children: AdminNavigationNode[];
|
|
755
|
+
}
|
|
756
|
+
export interface AdminNavigationTree {
|
|
757
|
+
id: string;
|
|
758
|
+
handle: string;
|
|
759
|
+
title: string;
|
|
760
|
+
locale: string;
|
|
761
|
+
isActive: boolean;
|
|
762
|
+
revision: number;
|
|
763
|
+
items: AdminNavigationNode[];
|
|
764
|
+
}
|
|
765
|
+
/**
|
|
766
|
+
* Options for mutations that require a revision precondition.
|
|
767
|
+
* SDK always sends If-Match; update/replaceTree also send body expectedRevision.
|
|
768
|
+
*/
|
|
769
|
+
export interface NavigationRevisionOptions {
|
|
770
|
+
/** Current menu revision (API returns 400 if missing, 409 if stale). */
|
|
771
|
+
expectedRevision: number;
|
|
772
|
+
}
|
|
773
|
+
export interface PublicNavTarget {
|
|
774
|
+
type: NavigationTargetType;
|
|
775
|
+
id?: string;
|
|
776
|
+
slug?: string;
|
|
777
|
+
path?: string;
|
|
778
|
+
url?: string;
|
|
779
|
+
anchor?: string;
|
|
780
|
+
}
|
|
781
|
+
export interface PublicNavNode {
|
|
782
|
+
label: string;
|
|
783
|
+
badge: string | null;
|
|
784
|
+
opensInNewTab: boolean;
|
|
785
|
+
target: PublicNavTarget;
|
|
786
|
+
children: PublicNavNode[];
|
|
787
|
+
}
|
|
788
|
+
export interface PublicNavigation {
|
|
789
|
+
handle: string;
|
|
790
|
+
title: string;
|
|
791
|
+
locale: string;
|
|
792
|
+
revision: number;
|
|
793
|
+
items: PublicNavNode[];
|
|
794
|
+
}
|
|
795
|
+
export interface PublicNavigationOptions {
|
|
796
|
+
locale?: string;
|
|
797
|
+
/**
|
|
798
|
+
* Prior ETag for this tenant/store menu. When the resolved tree is unchanged,
|
|
799
|
+
* the API returns 304 (surfaced as NotModifiedError).
|
|
800
|
+
* The SDK transport returns response bodies only; store ETags client-side if needed.
|
|
801
|
+
*/
|
|
802
|
+
ifNoneMatch?: string;
|
|
803
|
+
}
|
|
804
|
+
//# sourceMappingURL=types.d.ts.map
|