@01.software/sdk 0.48.0 → 0.51.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/CHANGELOG.md +157 -1
- package/MIGRATION.md +56 -0
- package/README.md +276 -49
- package/dist/client.cjs +375 -161
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +7 -6
- package/dist/client.d.ts +7 -6
- package/dist/client.js +375 -161
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-CBup9yOx.d.cts → collection-client-CWAeuzV4.d.cts} +6 -4
- package/dist/{collection-client-D3ExJU-7.d.ts → collection-client-hYvVfHIm.d.ts} +6 -4
- package/dist/{const-k9gHylYa.d.ts → const-D8LixhAJ.d.cts} +5 -5
- package/dist/{const-BXEi1Kix.d.cts → const-JD8obaKg.d.ts} +5 -5
- package/dist/embedded-admin/server.cjs +306 -0
- package/dist/embedded-admin/server.cjs.map +1 -0
- package/dist/embedded-admin/server.d.cts +33 -0
- package/dist/embedded-admin/server.d.ts +33 -0
- package/dist/embedded-admin/server.js +288 -0
- package/dist/embedded-admin/server.js.map +1 -0
- package/dist/embedded-admin.cjs +400 -0
- package/dist/embedded-admin.cjs.map +1 -0
- package/dist/embedded-admin.d.cts +61 -0
- package/dist/embedded-admin.d.ts +61 -0
- package/dist/embedded-admin.js +377 -0
- package/dist/embedded-admin.js.map +1 -0
- package/dist/errors.cjs +64 -15
- package/dist/errors.cjs.map +1 -1
- package/dist/errors.d.cts +13 -4
- package/dist/errors.d.ts +13 -4
- package/dist/errors.js +64 -15
- package/dist/errors.js.map +1 -1
- package/dist/{index-BCM9CTL7.d.cts → index-B0Hjh3Ey.d.ts} +72 -10
- package/dist/{index-CHGGkcLj.d.ts → index-Bu0kCc6o.d.cts} +72 -10
- package/dist/index.cjs +470 -429
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +9 -67
- package/dist/index.d.ts +9 -67
- package/dist/index.js +470 -429
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-B6AZQcB7.d.cts → payload-types-BOsckg8B.d.cts} +396 -57
- package/dist/{payload-types-B6AZQcB7.d.ts → payload-types-BOsckg8B.d.ts} +396 -57
- package/dist/query.cjs +115 -70
- package/dist/query.cjs.map +1 -1
- package/dist/query.d.cts +5 -5
- package/dist/query.d.ts +5 -5
- package/dist/query.js +115 -70
- package/dist/query.js.map +1 -1
- package/dist/realtime.d.cts +2 -2
- package/dist/realtime.d.ts +2 -2
- package/dist/server.cjs +591 -186
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +8 -7
- package/dist/server.d.ts +8 -7
- package/dist/server.js +591 -186
- package/dist/server.js.map +1 -1
- package/dist/storefront-cache.cjs +22 -0
- package/dist/storefront-cache.cjs.map +1 -1
- package/dist/storefront-cache.js +22 -0
- package/dist/storefront-cache.js.map +1 -1
- package/dist/{types-ByD2zii1.d.ts → types-5ZlcAFuU.d.ts} +2 -2
- package/dist/{types-8us-_C-Q.d.cts → types-B14sEt1z.d.cts} +2 -2
- package/dist/{types-CM2je9Kw.d.cts → types-Bj8j7VHU.d.ts} +107 -26
- package/dist/{types-DbA5V3mt.d.ts → types-CM5qiR2k.d.cts} +107 -26
- package/dist/ui/form.d.cts +1 -1
- package/dist/ui/form.d.ts +1 -1
- package/dist/ui/video.d.cts +1 -1
- package/dist/ui/video.d.ts +1 -1
- package/dist/webhook.cjs +124 -80
- package/dist/webhook.cjs.map +1 -1
- package/dist/webhook.d.cts +21 -5
- package/dist/webhook.d.ts +21 -5
- package/dist/webhook.js +124 -80
- package/dist/webhook.js.map +1 -1
- package/package.json +27 -5
package/dist/index.d.cts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export { A as AddItemParams, i as ApiQueryOptions,
|
|
3
|
-
import { P as Product } from './payload-types-
|
|
4
|
-
export { A as Article, f as ArticleAuthor, g as ArticleCategory, h as ArticleTag, D as Document, I as Image, i as Post, j as PostCategory, T as Tenant, V as Video } from './payload-types-
|
|
5
|
-
export { C as CollectionType, P as Market, a as Product, b as ProductCollection, c as ProductVariant } from './types-
|
|
6
|
-
export { C as COMMERCE_NOTIFICATION_EVENTS, a as COMMERCE_NOTIFICATION_EVENT_TYPE, b as COMMERCE_NOTIFICATION_OPERATION, c as CUSTOMER_PASSWORD_RESET_OPERATION, d as CollectionWebhookOperation, e as CommerceEmailChannel, f as CommerceEmailConfig, g as CommerceEmailEventConfig, h as CommerceEmailEventHandlers, i as CommerceEmailHandlerContext, j as CommerceNotification, k as CommerceNotificationData, l as CommerceNotificationEventHandlers, m as CommerceNotificationEventName, n as CommerceNotificationHandlerContext, o as CommerceNotificationSource, p as CommerceNotificationSourceCollection, q as CommerceNotificationWebhookEvent, r as CustomerAuthWebhookEvent, s as CustomerAuthWebhookHandlers, t as CustomerPasswordResetWebhookData, u as CustomerPasswordResetWebhookEvent, O as ORDER_CHANGED_EVENT_TYPE, v as OrderChangedWebhookEvent,
|
|
7
|
-
export { a as COLLECTIONS, C as Collection, I as INTERNAL_COLLECTIONS, P as PublicCollection, b as SERVER_COLLECTIONS, c as SERVER_ONLY_COLLECTIONS } from './const-
|
|
1
|
+
import { cm as BaseApi, aF as ServerApiOptions, aI as SubscribeMembershipParams, aJ as SubscribeMembershipResponse, e as CancelMembershipParams, f as CancelMembershipResponse, cn as ProductDetail, co as ProductDetailCatalog, cp as StockSnapshotResponse, h as ClientConfig, cq as RootClientWithEvents } from './types-CM5qiR2k.cjs';
|
|
2
|
+
export { A as AddItemParams, i as ApiQueryOptions, cr as BulkImportFulfillmentsParams, cs as BulkImportFulfillmentsResponse, ct as CalculateShippingParams, cu as CalculateShippingResult, j as CancelBrowserPaymentSessionParams, cv as CancelOrderParams, cw as CancelOrderResponse, cx as CancelReasonCode, cy as CartDiscountCode, k as CartMergeParams, l as CartMergeResult, m as CartMineResult, n as CartMutationResult, cz as CartWarning, cA as CartWarningCode, o as CheckoutAbandonedReason, p as CheckoutAmounts, q as CheckoutOrderReference, r as CheckoutPaymentSessionRef, s as CheckoutShippingAddress, t as ClearCartParams, al as Client, u as ClientMetadata, g as ClientState, al as ClientType, cB as Comment, C as CommerceClient, cC as CommerceClientOptions, a as CommunityClient, cD as CommunityClientOptions, cE as CommunityComment, cF as CommunityCommentListSort, cG as CommunityPost, cH as CommunityPostCategory, cI as CommunityPostListSort, cJ as CommunityPostTag, cK as CommunityPublicAuthorSnapshot, cL as CommunityPublicMediaAsset, cM as CommunityPublicReference, cN as CompatibilityProductSelectionParamEvent, b as ContentClient, v as ContentClientOptions, w as CreateCartParams, x as CreateCartResult, y as CreateCheckoutParams, z as CreateCheckoutResult, cO as CreateFulfillmentParams, B as CreatePaymentSessionParams, D as CreatePortOnePaymentSessionParams, cP as CreateReturnParams, c5 as CustomerAuth, cQ as CustomerAuthOptions, c7 as CustomerAuthResponse, cR as CustomerAuthorizationUrlInput, cS as CustomerAuthorizationUrlResult, c8 as CustomerLoginData, d as CustomerMembershipView, c as CustomerNamespace, cT as CustomerOAuth, cU as CustomerOAuthCallbackResult, cV as CustomerOAuthConfig, cW as CustomerOAuthTokenSet, cX as CustomerOrderListOptions, c6 as CustomerProfile, cb as CustomerRefreshResponse, ca as CustomerRegisterData, c9 as CustomerRegisterResponse, F as CustomerSnapshot, G as DebugConfig, H as DeepPartial, cY as DiscountApi, cZ as DiscountApiOptions, c_ as DiscountErrorReasonCode, b9 as EventAdmissionAvailabilityParams, ba as EventAdmissionAvailabilityResponse, bb as EventAdmissionAvailabilityType, bc as EventAdmissionPricePresentment, bd as EventGuestCancelParams, be as EventGuestRegistration, bf as EventGuestRegistrationResponse, bg as EventRegistrationAnswerInput, bh as EventRegistrationAttendeeInput, bi as EventRegistrationPublic, bj as EventRegistrationRegisterParams, bk as EventRegistrationRegisterResponse, bl as EventsCalendarItem, E as EventsClient, bm as EventsClientOptions, bn as EventsDateParam, bo as EventsExternalSource, bp as EventsLocation, bq as EventsOccurrenceLocation, br as EventsRangeEvent, bs as EventsRangeOccurrence, bt as EventsRangeParams, bu as EventsRangeResponse, bv as EventsTaxonomyItem, I as ExtractArrayType, c$ as FeaturedImagePointerInput, d0 as GetOrderByPaymentIdParams, d1 as LegacyProductSelectionParamEvent, d2 as ListingGroupsParams, d3 as MAX_CART_LINE_ADMISSIONS, d4 as ManagedPaymentNextAction, d5 as ManagedPublicPaymentSession, d6 as MarketDTO, d7 as MediaValue, J as MembershipStatus, K as Money, d8 as NormalizedOptionSwatch, d9 as NormalizedProductSelection, O as OpenCheckoutPaymentState, da as OrderApi, db as OrderApiOptions, dc as OrderByPaymentResult, dd as PRODUCT_PLP_FIND_OPTIONS, de as PRODUCT_UPSERT_READONLY_FIELD_REASON, df as PRODUCT_UPSERT_UNKNOWN_FIELD_REASON, P as PayloadFindResponse, L as PayloadMutationResponse, N as PaymentFailureReason, Q as PaymentNextAction, R as PaymentProviderStatus, S as PaymentReconciliationReason, T as PaymentSessionRole, U as PortOneHostedPaymentMethod, V as PortOnePaymentNextAction, W as PortOnePublicPaymentSession, dg as PrepareFulfillmentOrderParams, dh as PrepareFulfillmentOrderResponse, di as ProductApi, dj as ProductApiOptions, dk as ProductDetailBrand, cg as ProductDetailCatalogResult, dl as ProductDetailCatalogVariant, dm as ProductDetailCategory, dn as ProductDetailImage, dp as ProductDetailImageMedia, dq as ProductDetailMedia, dr as ProductDetailOption, ds as ProductDetailOptionValue, cf as ProductDetailParams, dt as ProductDetailResult, du as ProductDetailTag, dv as ProductDetailUnavailableReason, dw as ProductDetailVariant, dx as ProductDetailVariantOptionValue, dy as ProductDetailVideo, dz as ProductDisplayMediaSource, dA as ProductFallbackLocaleOption, dB as ProductHrefGroup, dC as ProductHrefOptions, dD as ProductHrefProduct, dE as ProductListingCard, dF as ProductListingCardOptions, dG as ProductListingCardPriceRange, dH as ProductListingCardRepresentativeVariant, dI as ProductListingGroup, dJ as ProductListingGroupCatalogSummary, dK as ProductListingGroupCatalogVariant, dL as ProductListingGroupProjection, dM as ProductListingGroupSummary, dN as ProductListingGroupVariant, cj as ProductListingGroupsCatalogItem, dO as ProductListingGroupsCatalogProduct, dP as ProductListingGroupsCatalogResponse, cl as ProductListingGroupsItem, dQ as ProductListingGroupsProduct, dR as ProductListingGroupsResponse, ce as ProductListingPageBaseParams, ch as ProductListingPageCatalogParams, dS as ProductListingPageFilters, ck as ProductListingPageFullParams, cd as ProductListingPageParams, ci as ProductListingPageResult, dT as ProductListingPageSort, dU as ProductListingProductShape, dV as ProductListingSwatch, dW as ProductLocaleOption, dX as ProductLocaleReadParams, dY as ProductLocalizedText, dZ as ProductLocalizedValue, d_ as ProductMediaResolutionSource, d$ as ProductMoneyRange, e0 as ProductOptionMatrix, e1 as ProductOptionMatrixOption, e2 as ProductOptionMatrixValue, e3 as ProductOptionMatrixVariant, e4 as ProductOptionShape, e5 as ProductOptionValueShape, e6 as ProductOptionValueSwatch, e7 as ProductOptionValueSwatchInput, e8 as ProductPriceRange, e9 as ProductSelectionAvailableSwatch, ea as ProductSelectionAvailableValue, eb as ProductSelectionByOptionValue, ec as ProductSelectionCodecError, ed as ProductSelectionCodecOptions, ee as ProductSelectionInput, ef as ProductSelectionMediaPointer, eg as ProductSelectionMediaSource, eh as ProductSelectionOptionValue, ei as ProductSelectionResolution, ej as ProductSelectionResolutionContext, ek as ProductSelectionUrlEmit, el as ProductSelectionVariant, em as ProductUpsertFieldValidationErrorBody, en as ProductUpsertFieldValidationErrorReason, X as ProductUpsertInput, Y as ProductUpsertParams, Z as ProductUpsertResponse, _ as ProductUpsertVariantInput, eo as ProductVariantShape, $ as PublicAttribute, a0 as PublicCaptureEvidence, a1 as PublicCart, a2 as PublicCartItem, a3 as PublicCartItemAdmission, a4 as PublicCartMarket, a5 as PublicCartReference, a6 as PublicCheckout, ep as PublicCheckoutBase, a7 as PublicCheckoutItem, a8 as PublicMediaAsset, a9 as PublicMediaSize, aa as PublicOrder, ab as PublicOrderAmounts, ac as PublicOrderItem, ad as PublicOrderReference, ae as PublicPaymentSession, c4 as PublicReadQueryOptions, af as ReconciliationRequired, ag as RemoveItemParams, eq as RequestOptions, er as ResolveCancelRefundFailedResponse, es as ResolveCancelRefundOutcome, et as ResolveCancelRefundParams, eu as ResolveCancelRefundResponse, ev as ResolveCancelRefundSucceededResponse, ew as ResolveProductDisplayMediaInput, ex as ResolveProductDisplayMediaResult, ey as ResolveProductSelectionMediaInput, ez as ResolveProductSelectionMediaResult, eA as ResolvedCatalogPrice, ah as RetrieveBrowserPaymentSessionParams, ai as RetrieveCartParams, aj as RetrieveCheckoutParams, bI as RetrieveServerCheckoutParams, ak as RetryConfig, eB as ReturnCancellationReasonCode, eC as ReturnItem, eD as ReturnReason, eE as ReturnWithRefundItem, eF as ReturnWithRefundParams, al as RootClient, am as RootCollectionClient, an as RootReadOnlyQueryBuilder, eG as ShippingApi, eH as ShippingApiOptions, ao as ShippingLine, ap as Sort, aq as SpentCheckoutPaymentState, eI as StockCheckParams, eJ as StockCheckResponse, eK as StockCheckResult, eL as StockSnapshotItem, eM as StockSnapshotParams, ar as StorefrontContentListOptions, as as StorefrontContentReference, at as StorefrontGalleryItem, au as StorefrontGalleryItemsListOptions, av as StorefrontGalleryItemsSort, aw as StorefrontLink, ax as StorefrontLinksListOptions, ay as StorefrontLinksSort, az as UpdateCartAttributesParams, aA as UpdateDiscountCodesParams, eN as UpdateFulfillmentParams, aB as UpdateItemParams, eO as UpdateOrderParams, cc as UpdateProfileData, eP as UpdateReturnParams, eQ as ValidateDiscountParams, eR as ValidateDiscountResult, aC as VariantInput, aD as Where, eS as WithIdempotencyKey, eT as buildProductHref, eU as buildProductListingCard, eV as buildProductListingGroupProjection, eW as buildProductListingGroupsByOption, eX as buildProductOptionMatrix, eY as buildProductOptionMatrixFromDetail, eZ as createProductSelectionCodec, e_ as getAvailableOptionValues, e$ as getProductSelectionImages, f0 as getSelectedValueByOptionId, f1 as getVariantAvailableForSale, f2 as getVariantAvailableStock, f3 as isProductUpsertFieldValidationErrorBody, f4 as normalizeProductSelection, f5 as normalizeProductSelectionFromMatrix, f6 as normalizeSelectedValueIds, f7 as parseProductSelection, f8 as projectProductToListingShape, f9 as resolveFeaturedImagePointer, fa as resolveProductDisplayMedia, fb as resolveProductSelection, fc as resolveProductSelectionFromMatrix, fd as resolveProductSelectionMedia, fe as resolveVariantForSelection, ff as selectNext, fg as selectedSwatchMediaItemId, fh as stringifyProductSelection, fi as toShopifyPriceRangeV2 } from './types-CM5qiR2k.cjs';
|
|
3
|
+
import { P as Product } from './payload-types-BOsckg8B.cjs';
|
|
4
|
+
export { A as Article, f as ArticleAuthor, g as ArticleCategory, h as ArticleTag, D as Document, I as Image, i as Post, j as PostCategory, T as Tenant, V as Video } from './payload-types-BOsckg8B.cjs';
|
|
5
|
+
export { C as CollectionType, P as Market, a as Product, b as ProductCollection, c as ProductVariant } from './types-B14sEt1z.cjs';
|
|
6
|
+
export { C as COMMERCE_NOTIFICATION_EVENTS, a as COMMERCE_NOTIFICATION_EVENT_TYPE, b as COMMERCE_NOTIFICATION_OPERATION, c as CUSTOMER_PASSWORD_RESET_OPERATION, d as CollectionWebhookOperation, e as CommerceEmailChannel, f as CommerceEmailConfig, g as CommerceEmailEventConfig, h as CommerceEmailEventHandlers, i as CommerceEmailHandlerContext, j as CommerceNotification, k as CommerceNotificationData, l as CommerceNotificationEventHandlers, m as CommerceNotificationEventName, n as CommerceNotificationHandlerContext, o as CommerceNotificationSource, p as CommerceNotificationSourceCollection, q as CommerceNotificationWebhookEvent, r as CustomerAuthWebhookEvent, s as CustomerAuthWebhookHandlers, a0 as CustomerCommerceNotificationEventName, t as CustomerPasswordResetWebhookData, u as CustomerPasswordResetWebhookEvent, O as ORDER_CHANGED_EVENT_TYPE, v as OrderChangedWebhookEvent, P as PaymentIncidentMoney, w as PaymentIncidentNotificationData, x as PaymentIncidentNotificationEventName, y as PaymentIncidentNotificationReason, z as PaymentIncidentNotificationSourceCollection, A as PaymentIncidentNotificationStatus, B as PaymentIncidentProviderObject, a1 as PaymentReconciliationRequiredNotificationData, a2 as PaymentRefundRequiresAttentionNotificationData, D as WebhookChange, E as WebhookCommerceNotificationChange, F as WebhookEvent, W as WebhookHandler, G as WebhookKnownOperation, H as WebhookOperation, I as WebhookOptions, J as WebhookOrderChange, K as WebhookOrderMoved, L as WebhookOrderScope, M as createCommerceEmailWebhookHandler, N as createCommerceNotificationWebhookHandler, Q as createCustomerAuthWebhookHandler, R as createTypedWebhookHandler, S as defineCommerceEmailConfig, T as getCommerceNotificationIdempotencyKey, U as handleWebhook, V as isCommerceNotificationWebhookEvent, X as isCustomerPasswordResetWebhookEvent, Y as isOrderChangedWebhookEvent, Z as isValidWebhookEvent, _ as isWebhookCollection, $ as isWebhookOperation } from './index-Bu0kCc6o.cjs';
|
|
7
|
+
export { a as COLLECTIONS, C as Collection, I as INTERNAL_COLLECTIONS, P as PublicCollection, b as SERVER_COLLECTIONS, c as SERVER_ONLY_COLLECTIONS } from './const-D8LixhAJ.cjs';
|
|
8
8
|
export { a as RealtimeConnection, R as RealtimeEvent, b as RealtimeListener } from './realtime-D7HtUpqt.cjs';
|
|
9
9
|
export { a as IMAGE_SIZES, I as ImageData, b as ImageDataSizeEntry, c as ImageDataSizes, d as ImagePalette, e as ImagePlaceholderOptions, g as getImageLqip, f as getImagePalette, h as getImagePlaceholderStyle, i as getImageSrcSet, j as getImageUrl } from './image-BDjHp03R.cjs';
|
|
10
10
|
export { V as VideoGifOptions, a as VideoThumbnailOptions, g as getVideoGif, b as getVideoMp4Url, c as getVideoStoryboard, d as getVideoStreamUrl, e as getVideoThumbnail } from './video-WR_TFO9a.cjs';
|
|
11
11
|
export { Analytics, AnalyticsConfig, createAnalytics } from './analytics.cjs';
|
|
12
|
-
export { ApiError, AuthError, COMMERCE_ERROR_CODES, CommerceErrorCode, CommerceSDKError, ConfigError, ConflictError, GoneError, NetworkError, NotFoundError, PermissionError, RateLimitError, SDKError, ServiceUnavailableError, TimeoutError, UsageLimitError, ValidationError, createAuthError, createConflictError, createNotFoundError, createPermissionError, createRateLimitError, isApiError, isAuthError, isCommerceSDKError, isConfigError, isConflictError, isGoneError, isNetworkError, isNotFoundError, isPermissionError, isRateLimitError, isSDKError, isServiceUnavailableError, isTimeoutError, isUsageLimitError, isValidationError } from './errors.cjs';
|
|
12
|
+
export { ApiError, AuthError, COMMERCE_ERROR_CODES, CommerceErrorCode, CommerceSDKError, ConfigError, ConflictError, GoneError, NetworkError, NotFoundError, PermissionError, RateLimitError, SDKError, ServiceUnavailableError, TimeoutError, UsageLimitError, ValidationError, createAuthError, createConflictError, createNotFoundError, createPermissionError, createRateLimitError, getSDKErrorReason, isApiError, isAuthError, isCommerceSDKError, isConfigError, isConflictError, isGoneError, isNetworkError, isNotFoundError, isPermissionError, isRateLimitError, isSDKError, isServiceUnavailableError, isTimeoutError, isUsageLimitError, isValidationError } from './errors.cjs';
|
|
13
13
|
|
|
14
14
|
declare function isCommerceIdempotencyKey(value: unknown): value is string;
|
|
15
15
|
declare function assertCommerceIdempotencyKey(value: unknown): asserts value is string;
|
|
@@ -50,64 +50,6 @@ interface MergedProductDetailResult {
|
|
|
50
50
|
}
|
|
51
51
|
declare function mergeProductDetailWithStock(catalog: ProductDetailCatalog, snapshot: StockSnapshotResponse): MergedProductDetailResult;
|
|
52
52
|
|
|
53
|
-
/** @deprecated Use `ProductSelectionMediaSource` or `ProductDisplayMediaSource`. */
|
|
54
|
-
type MediaPointerSource = ProductSelectionMediaSource | ProductDisplayMediaSource | 'variant_featured';
|
|
55
|
-
/** @deprecated Use `ResolveProductSelectionMediaInput`. */
|
|
56
|
-
type ResolveProductMediaInput<TMedia> = ResolveProductSelectionMediaInput<TMedia> & {
|
|
57
|
-
variantFeaturedMediaItemId?: string | number | null;
|
|
58
|
-
selectedOptionValueMediaItemIds?: Array<string | number | null | undefined>;
|
|
59
|
-
legacy?: {
|
|
60
|
-
variantThumbnail?: TMedia | null;
|
|
61
|
-
variantImages?: TMedia[] | null;
|
|
62
|
-
optionValueThumbnails?: Array<TMedia | null | undefined>;
|
|
63
|
-
optionValueImages?: Array<TMedia[] | null | undefined>;
|
|
64
|
-
productThumbnail?: TMedia | null;
|
|
65
|
-
productImages?: TMedia[] | null;
|
|
66
|
-
};
|
|
67
|
-
};
|
|
68
|
-
/** @deprecated Use `ResolveProductSelectionMediaResult`. */
|
|
69
|
-
type ResolveProductMediaResult<TMedia> = Omit<ResolveProductSelectionMediaResult<TMedia>, 'source'> & {
|
|
70
|
-
source: MediaPointerSource;
|
|
71
|
-
};
|
|
72
|
-
/**
|
|
73
|
-
* @deprecated One-release shim for ADR 0025. Prefer
|
|
74
|
-
* `resolveProductSelectionMedia()`. Legacy direct-media fallbacks are ignored;
|
|
75
|
-
* callers fall through to product display media (`resolveProductDisplayMedia`)
|
|
76
|
-
* or `none`.
|
|
77
|
-
*/
|
|
78
|
-
declare function resolveProductMedia<TMedia>(input: ResolveProductMediaInput<TMedia>): ResolveProductMediaResult<TMedia>;
|
|
79
|
-
|
|
80
|
-
/** @deprecated ADR 0025 replaces media sets with variant `images[]` subsets. */
|
|
81
|
-
type ProductMediaSetMatchType = 'default' | 'option-values' | 'exact-variant';
|
|
82
|
-
/** @deprecated Use `ResolveProductSelectionMediaInput` and variant `images[]`. */
|
|
83
|
-
type ProductMediaSetInput = {
|
|
84
|
-
label?: string | null;
|
|
85
|
-
matchType: ProductMediaSetMatchType;
|
|
86
|
-
optionValueIds?: Array<string | number | null | undefined> | null;
|
|
87
|
-
variantIds?: Array<string | number | null | undefined> | null;
|
|
88
|
-
items: Array<string | number | null | undefined>;
|
|
89
|
-
primaryMediaItemId?: string | number | null;
|
|
90
|
-
};
|
|
91
|
-
type LegacyProductGallerySource = 'exact_variant_set' | 'option_value_set' | 'default_set';
|
|
92
|
-
/** @deprecated Use `ResolveProductSelectionMediaInput`. */
|
|
93
|
-
type ResolveProductGalleryInput<TMedia> = ResolveProductSelectionMediaInput<TMedia> & {
|
|
94
|
-
pool?: TMedia[] | null;
|
|
95
|
-
mediaSets?: ProductMediaSetInput[] | null;
|
|
96
|
-
selectedVariantId?: string | number | null;
|
|
97
|
-
selectedOptionValueIds?: Array<string | number | null | undefined> | null;
|
|
98
|
-
featuredImage?: ProductSelectionMediaPointer;
|
|
99
|
-
};
|
|
100
|
-
/** @deprecated Use selection or display media source types. */
|
|
101
|
-
type ProductGallerySource = ProductSelectionMediaSource | ProductDisplayMediaSource | LegacyProductGallerySource;
|
|
102
|
-
/** @deprecated Use `ResolveProductSelectionMediaResult`. */
|
|
103
|
-
type ResolveProductGalleryResult<TMedia> = {
|
|
104
|
-
primaryImage: TMedia | null;
|
|
105
|
-
images: TMedia[];
|
|
106
|
-
source: ProductGallerySource;
|
|
107
|
-
};
|
|
108
|
-
/** @deprecated Use `resolveProductSelectionMedia()`. */
|
|
109
|
-
declare function resolveProductGallery<TMedia>(input: ResolveProductGalleryInput<TMedia>): ResolveProductGalleryResult<TMedia>;
|
|
110
|
-
|
|
111
53
|
declare const generateOrderNumber: () => string;
|
|
112
54
|
|
|
113
55
|
type OrderItem = {
|
|
@@ -129,4 +71,4 @@ declare function resolveRelation<T>(ref: unknown): T | null;
|
|
|
129
71
|
|
|
130
72
|
declare function createClient(options: ClientConfig): RootClientWithEvents;
|
|
131
73
|
|
|
132
|
-
export { BaseApi, CancelMembershipParams, CancelMembershipResponse, ClientConfig,
|
|
74
|
+
export { BaseApi, CancelMembershipParams, CancelMembershipResponse, ClientConfig, MembershipApi, type MembershipApiOptions, type MergedProductDetailResult, ProductDetail, ProductDetailCatalog, type ProductDetailStockMergeStatus, RootClientWithEvents, ServerApiOptions, StockSnapshotResponse, SubscribeMembershipParams, SubscribeMembershipResponse, assertCommerceIdempotencyKey, createClient, createCommerceIdempotencyKey, formatOrderName, generateOrderNumber, isCommerceIdempotencyKey, mergeProductDetailWithStock, resolveRelation };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export { A as AddItemParams, i as ApiQueryOptions,
|
|
3
|
-
import { P as Product } from './payload-types-
|
|
4
|
-
export { A as Article, f as ArticleAuthor, g as ArticleCategory, h as ArticleTag, D as Document, I as Image, i as Post, j as PostCategory, T as Tenant, V as Video } from './payload-types-
|
|
5
|
-
export { C as CollectionType, P as Market, a as Product, b as ProductCollection, c as ProductVariant } from './types-
|
|
6
|
-
export { C as COMMERCE_NOTIFICATION_EVENTS, a as COMMERCE_NOTIFICATION_EVENT_TYPE, b as COMMERCE_NOTIFICATION_OPERATION, c as CUSTOMER_PASSWORD_RESET_OPERATION, d as CollectionWebhookOperation, e as CommerceEmailChannel, f as CommerceEmailConfig, g as CommerceEmailEventConfig, h as CommerceEmailEventHandlers, i as CommerceEmailHandlerContext, j as CommerceNotification, k as CommerceNotificationData, l as CommerceNotificationEventHandlers, m as CommerceNotificationEventName, n as CommerceNotificationHandlerContext, o as CommerceNotificationSource, p as CommerceNotificationSourceCollection, q as CommerceNotificationWebhookEvent, r as CustomerAuthWebhookEvent, s as CustomerAuthWebhookHandlers, t as CustomerPasswordResetWebhookData, u as CustomerPasswordResetWebhookEvent, O as ORDER_CHANGED_EVENT_TYPE, v as OrderChangedWebhookEvent,
|
|
7
|
-
export { a as COLLECTIONS, C as Collection, I as INTERNAL_COLLECTIONS, P as PublicCollection, b as SERVER_COLLECTIONS, c as SERVER_ONLY_COLLECTIONS } from './const-
|
|
1
|
+
import { cm as BaseApi, aF as ServerApiOptions, aI as SubscribeMembershipParams, aJ as SubscribeMembershipResponse, e as CancelMembershipParams, f as CancelMembershipResponse, cn as ProductDetail, co as ProductDetailCatalog, cp as StockSnapshotResponse, h as ClientConfig, cq as RootClientWithEvents } from './types-Bj8j7VHU.js';
|
|
2
|
+
export { A as AddItemParams, i as ApiQueryOptions, cr as BulkImportFulfillmentsParams, cs as BulkImportFulfillmentsResponse, ct as CalculateShippingParams, cu as CalculateShippingResult, j as CancelBrowserPaymentSessionParams, cv as CancelOrderParams, cw as CancelOrderResponse, cx as CancelReasonCode, cy as CartDiscountCode, k as CartMergeParams, l as CartMergeResult, m as CartMineResult, n as CartMutationResult, cz as CartWarning, cA as CartWarningCode, o as CheckoutAbandonedReason, p as CheckoutAmounts, q as CheckoutOrderReference, r as CheckoutPaymentSessionRef, s as CheckoutShippingAddress, t as ClearCartParams, al as Client, u as ClientMetadata, g as ClientState, al as ClientType, cB as Comment, C as CommerceClient, cC as CommerceClientOptions, a as CommunityClient, cD as CommunityClientOptions, cE as CommunityComment, cF as CommunityCommentListSort, cG as CommunityPost, cH as CommunityPostCategory, cI as CommunityPostListSort, cJ as CommunityPostTag, cK as CommunityPublicAuthorSnapshot, cL as CommunityPublicMediaAsset, cM as CommunityPublicReference, cN as CompatibilityProductSelectionParamEvent, b as ContentClient, v as ContentClientOptions, w as CreateCartParams, x as CreateCartResult, y as CreateCheckoutParams, z as CreateCheckoutResult, cO as CreateFulfillmentParams, B as CreatePaymentSessionParams, D as CreatePortOnePaymentSessionParams, cP as CreateReturnParams, c5 as CustomerAuth, cQ as CustomerAuthOptions, c7 as CustomerAuthResponse, cR as CustomerAuthorizationUrlInput, cS as CustomerAuthorizationUrlResult, c8 as CustomerLoginData, d as CustomerMembershipView, c as CustomerNamespace, cT as CustomerOAuth, cU as CustomerOAuthCallbackResult, cV as CustomerOAuthConfig, cW as CustomerOAuthTokenSet, cX as CustomerOrderListOptions, c6 as CustomerProfile, cb as CustomerRefreshResponse, ca as CustomerRegisterData, c9 as CustomerRegisterResponse, F as CustomerSnapshot, G as DebugConfig, H as DeepPartial, cY as DiscountApi, cZ as DiscountApiOptions, c_ as DiscountErrorReasonCode, b9 as EventAdmissionAvailabilityParams, ba as EventAdmissionAvailabilityResponse, bb as EventAdmissionAvailabilityType, bc as EventAdmissionPricePresentment, bd as EventGuestCancelParams, be as EventGuestRegistration, bf as EventGuestRegistrationResponse, bg as EventRegistrationAnswerInput, bh as EventRegistrationAttendeeInput, bi as EventRegistrationPublic, bj as EventRegistrationRegisterParams, bk as EventRegistrationRegisterResponse, bl as EventsCalendarItem, E as EventsClient, bm as EventsClientOptions, bn as EventsDateParam, bo as EventsExternalSource, bp as EventsLocation, bq as EventsOccurrenceLocation, br as EventsRangeEvent, bs as EventsRangeOccurrence, bt as EventsRangeParams, bu as EventsRangeResponse, bv as EventsTaxonomyItem, I as ExtractArrayType, c$ as FeaturedImagePointerInput, d0 as GetOrderByPaymentIdParams, d1 as LegacyProductSelectionParamEvent, d2 as ListingGroupsParams, d3 as MAX_CART_LINE_ADMISSIONS, d4 as ManagedPaymentNextAction, d5 as ManagedPublicPaymentSession, d6 as MarketDTO, d7 as MediaValue, J as MembershipStatus, K as Money, d8 as NormalizedOptionSwatch, d9 as NormalizedProductSelection, O as OpenCheckoutPaymentState, da as OrderApi, db as OrderApiOptions, dc as OrderByPaymentResult, dd as PRODUCT_PLP_FIND_OPTIONS, de as PRODUCT_UPSERT_READONLY_FIELD_REASON, df as PRODUCT_UPSERT_UNKNOWN_FIELD_REASON, P as PayloadFindResponse, L as PayloadMutationResponse, N as PaymentFailureReason, Q as PaymentNextAction, R as PaymentProviderStatus, S as PaymentReconciliationReason, T as PaymentSessionRole, U as PortOneHostedPaymentMethod, V as PortOnePaymentNextAction, W as PortOnePublicPaymentSession, dg as PrepareFulfillmentOrderParams, dh as PrepareFulfillmentOrderResponse, di as ProductApi, dj as ProductApiOptions, dk as ProductDetailBrand, cg as ProductDetailCatalogResult, dl as ProductDetailCatalogVariant, dm as ProductDetailCategory, dn as ProductDetailImage, dp as ProductDetailImageMedia, dq as ProductDetailMedia, dr as ProductDetailOption, ds as ProductDetailOptionValue, cf as ProductDetailParams, dt as ProductDetailResult, du as ProductDetailTag, dv as ProductDetailUnavailableReason, dw as ProductDetailVariant, dx as ProductDetailVariantOptionValue, dy as ProductDetailVideo, dz as ProductDisplayMediaSource, dA as ProductFallbackLocaleOption, dB as ProductHrefGroup, dC as ProductHrefOptions, dD as ProductHrefProduct, dE as ProductListingCard, dF as ProductListingCardOptions, dG as ProductListingCardPriceRange, dH as ProductListingCardRepresentativeVariant, dI as ProductListingGroup, dJ as ProductListingGroupCatalogSummary, dK as ProductListingGroupCatalogVariant, dL as ProductListingGroupProjection, dM as ProductListingGroupSummary, dN as ProductListingGroupVariant, cj as ProductListingGroupsCatalogItem, dO as ProductListingGroupsCatalogProduct, dP as ProductListingGroupsCatalogResponse, cl as ProductListingGroupsItem, dQ as ProductListingGroupsProduct, dR as ProductListingGroupsResponse, ce as ProductListingPageBaseParams, ch as ProductListingPageCatalogParams, dS as ProductListingPageFilters, ck as ProductListingPageFullParams, cd as ProductListingPageParams, ci as ProductListingPageResult, dT as ProductListingPageSort, dU as ProductListingProductShape, dV as ProductListingSwatch, dW as ProductLocaleOption, dX as ProductLocaleReadParams, dY as ProductLocalizedText, dZ as ProductLocalizedValue, d_ as ProductMediaResolutionSource, d$ as ProductMoneyRange, e0 as ProductOptionMatrix, e1 as ProductOptionMatrixOption, e2 as ProductOptionMatrixValue, e3 as ProductOptionMatrixVariant, e4 as ProductOptionShape, e5 as ProductOptionValueShape, e6 as ProductOptionValueSwatch, e7 as ProductOptionValueSwatchInput, e8 as ProductPriceRange, e9 as ProductSelectionAvailableSwatch, ea as ProductSelectionAvailableValue, eb as ProductSelectionByOptionValue, ec as ProductSelectionCodecError, ed as ProductSelectionCodecOptions, ee as ProductSelectionInput, ef as ProductSelectionMediaPointer, eg as ProductSelectionMediaSource, eh as ProductSelectionOptionValue, ei as ProductSelectionResolution, ej as ProductSelectionResolutionContext, ek as ProductSelectionUrlEmit, el as ProductSelectionVariant, em as ProductUpsertFieldValidationErrorBody, en as ProductUpsertFieldValidationErrorReason, X as ProductUpsertInput, Y as ProductUpsertParams, Z as ProductUpsertResponse, _ as ProductUpsertVariantInput, eo as ProductVariantShape, $ as PublicAttribute, a0 as PublicCaptureEvidence, a1 as PublicCart, a2 as PublicCartItem, a3 as PublicCartItemAdmission, a4 as PublicCartMarket, a5 as PublicCartReference, a6 as PublicCheckout, ep as PublicCheckoutBase, a7 as PublicCheckoutItem, a8 as PublicMediaAsset, a9 as PublicMediaSize, aa as PublicOrder, ab as PublicOrderAmounts, ac as PublicOrderItem, ad as PublicOrderReference, ae as PublicPaymentSession, c4 as PublicReadQueryOptions, af as ReconciliationRequired, ag as RemoveItemParams, eq as RequestOptions, er as ResolveCancelRefundFailedResponse, es as ResolveCancelRefundOutcome, et as ResolveCancelRefundParams, eu as ResolveCancelRefundResponse, ev as ResolveCancelRefundSucceededResponse, ew as ResolveProductDisplayMediaInput, ex as ResolveProductDisplayMediaResult, ey as ResolveProductSelectionMediaInput, ez as ResolveProductSelectionMediaResult, eA as ResolvedCatalogPrice, ah as RetrieveBrowserPaymentSessionParams, ai as RetrieveCartParams, aj as RetrieveCheckoutParams, bI as RetrieveServerCheckoutParams, ak as RetryConfig, eB as ReturnCancellationReasonCode, eC as ReturnItem, eD as ReturnReason, eE as ReturnWithRefundItem, eF as ReturnWithRefundParams, al as RootClient, am as RootCollectionClient, an as RootReadOnlyQueryBuilder, eG as ShippingApi, eH as ShippingApiOptions, ao as ShippingLine, ap as Sort, aq as SpentCheckoutPaymentState, eI as StockCheckParams, eJ as StockCheckResponse, eK as StockCheckResult, eL as StockSnapshotItem, eM as StockSnapshotParams, ar as StorefrontContentListOptions, as as StorefrontContentReference, at as StorefrontGalleryItem, au as StorefrontGalleryItemsListOptions, av as StorefrontGalleryItemsSort, aw as StorefrontLink, ax as StorefrontLinksListOptions, ay as StorefrontLinksSort, az as UpdateCartAttributesParams, aA as UpdateDiscountCodesParams, eN as UpdateFulfillmentParams, aB as UpdateItemParams, eO as UpdateOrderParams, cc as UpdateProfileData, eP as UpdateReturnParams, eQ as ValidateDiscountParams, eR as ValidateDiscountResult, aC as VariantInput, aD as Where, eS as WithIdempotencyKey, eT as buildProductHref, eU as buildProductListingCard, eV as buildProductListingGroupProjection, eW as buildProductListingGroupsByOption, eX as buildProductOptionMatrix, eY as buildProductOptionMatrixFromDetail, eZ as createProductSelectionCodec, e_ as getAvailableOptionValues, e$ as getProductSelectionImages, f0 as getSelectedValueByOptionId, f1 as getVariantAvailableForSale, f2 as getVariantAvailableStock, f3 as isProductUpsertFieldValidationErrorBody, f4 as normalizeProductSelection, f5 as normalizeProductSelectionFromMatrix, f6 as normalizeSelectedValueIds, f7 as parseProductSelection, f8 as projectProductToListingShape, f9 as resolveFeaturedImagePointer, fa as resolveProductDisplayMedia, fb as resolveProductSelection, fc as resolveProductSelectionFromMatrix, fd as resolveProductSelectionMedia, fe as resolveVariantForSelection, ff as selectNext, fg as selectedSwatchMediaItemId, fh as stringifyProductSelection, fi as toShopifyPriceRangeV2 } from './types-Bj8j7VHU.js';
|
|
3
|
+
import { P as Product } from './payload-types-BOsckg8B.js';
|
|
4
|
+
export { A as Article, f as ArticleAuthor, g as ArticleCategory, h as ArticleTag, D as Document, I as Image, i as Post, j as PostCategory, T as Tenant, V as Video } from './payload-types-BOsckg8B.js';
|
|
5
|
+
export { C as CollectionType, P as Market, a as Product, b as ProductCollection, c as ProductVariant } from './types-5ZlcAFuU.js';
|
|
6
|
+
export { C as COMMERCE_NOTIFICATION_EVENTS, a as COMMERCE_NOTIFICATION_EVENT_TYPE, b as COMMERCE_NOTIFICATION_OPERATION, c as CUSTOMER_PASSWORD_RESET_OPERATION, d as CollectionWebhookOperation, e as CommerceEmailChannel, f as CommerceEmailConfig, g as CommerceEmailEventConfig, h as CommerceEmailEventHandlers, i as CommerceEmailHandlerContext, j as CommerceNotification, k as CommerceNotificationData, l as CommerceNotificationEventHandlers, m as CommerceNotificationEventName, n as CommerceNotificationHandlerContext, o as CommerceNotificationSource, p as CommerceNotificationSourceCollection, q as CommerceNotificationWebhookEvent, r as CustomerAuthWebhookEvent, s as CustomerAuthWebhookHandlers, a0 as CustomerCommerceNotificationEventName, t as CustomerPasswordResetWebhookData, u as CustomerPasswordResetWebhookEvent, O as ORDER_CHANGED_EVENT_TYPE, v as OrderChangedWebhookEvent, P as PaymentIncidentMoney, w as PaymentIncidentNotificationData, x as PaymentIncidentNotificationEventName, y as PaymentIncidentNotificationReason, z as PaymentIncidentNotificationSourceCollection, A as PaymentIncidentNotificationStatus, B as PaymentIncidentProviderObject, a1 as PaymentReconciliationRequiredNotificationData, a2 as PaymentRefundRequiresAttentionNotificationData, D as WebhookChange, E as WebhookCommerceNotificationChange, F as WebhookEvent, W as WebhookHandler, G as WebhookKnownOperation, H as WebhookOperation, I as WebhookOptions, J as WebhookOrderChange, K as WebhookOrderMoved, L as WebhookOrderScope, M as createCommerceEmailWebhookHandler, N as createCommerceNotificationWebhookHandler, Q as createCustomerAuthWebhookHandler, R as createTypedWebhookHandler, S as defineCommerceEmailConfig, T as getCommerceNotificationIdempotencyKey, U as handleWebhook, V as isCommerceNotificationWebhookEvent, X as isCustomerPasswordResetWebhookEvent, Y as isOrderChangedWebhookEvent, Z as isValidWebhookEvent, _ as isWebhookCollection, $ as isWebhookOperation } from './index-B0Hjh3Ey.js';
|
|
7
|
+
export { a as COLLECTIONS, C as Collection, I as INTERNAL_COLLECTIONS, P as PublicCollection, b as SERVER_COLLECTIONS, c as SERVER_ONLY_COLLECTIONS } from './const-JD8obaKg.js';
|
|
8
8
|
export { a as RealtimeConnection, R as RealtimeEvent, b as RealtimeListener } from './realtime-D7HtUpqt.js';
|
|
9
9
|
export { a as IMAGE_SIZES, I as ImageData, b as ImageDataSizeEntry, c as ImageDataSizes, d as ImagePalette, e as ImagePlaceholderOptions, g as getImageLqip, f as getImagePalette, h as getImagePlaceholderStyle, i as getImageSrcSet, j as getImageUrl } from './image-BDjHp03R.js';
|
|
10
10
|
export { V as VideoGifOptions, a as VideoThumbnailOptions, g as getVideoGif, b as getVideoMp4Url, c as getVideoStoryboard, d as getVideoStreamUrl, e as getVideoThumbnail } from './video-WR_TFO9a.js';
|
|
11
11
|
export { Analytics, AnalyticsConfig, createAnalytics } from './analytics.js';
|
|
12
|
-
export { ApiError, AuthError, COMMERCE_ERROR_CODES, CommerceErrorCode, CommerceSDKError, ConfigError, ConflictError, GoneError, NetworkError, NotFoundError, PermissionError, RateLimitError, SDKError, ServiceUnavailableError, TimeoutError, UsageLimitError, ValidationError, createAuthError, createConflictError, createNotFoundError, createPermissionError, createRateLimitError, isApiError, isAuthError, isCommerceSDKError, isConfigError, isConflictError, isGoneError, isNetworkError, isNotFoundError, isPermissionError, isRateLimitError, isSDKError, isServiceUnavailableError, isTimeoutError, isUsageLimitError, isValidationError } from './errors.js';
|
|
12
|
+
export { ApiError, AuthError, COMMERCE_ERROR_CODES, CommerceErrorCode, CommerceSDKError, ConfigError, ConflictError, GoneError, NetworkError, NotFoundError, PermissionError, RateLimitError, SDKError, ServiceUnavailableError, TimeoutError, UsageLimitError, ValidationError, createAuthError, createConflictError, createNotFoundError, createPermissionError, createRateLimitError, getSDKErrorReason, isApiError, isAuthError, isCommerceSDKError, isConfigError, isConflictError, isGoneError, isNetworkError, isNotFoundError, isPermissionError, isRateLimitError, isSDKError, isServiceUnavailableError, isTimeoutError, isUsageLimitError, isValidationError } from './errors.js';
|
|
13
13
|
|
|
14
14
|
declare function isCommerceIdempotencyKey(value: unknown): value is string;
|
|
15
15
|
declare function assertCommerceIdempotencyKey(value: unknown): asserts value is string;
|
|
@@ -50,64 +50,6 @@ interface MergedProductDetailResult {
|
|
|
50
50
|
}
|
|
51
51
|
declare function mergeProductDetailWithStock(catalog: ProductDetailCatalog, snapshot: StockSnapshotResponse): MergedProductDetailResult;
|
|
52
52
|
|
|
53
|
-
/** @deprecated Use `ProductSelectionMediaSource` or `ProductDisplayMediaSource`. */
|
|
54
|
-
type MediaPointerSource = ProductSelectionMediaSource | ProductDisplayMediaSource | 'variant_featured';
|
|
55
|
-
/** @deprecated Use `ResolveProductSelectionMediaInput`. */
|
|
56
|
-
type ResolveProductMediaInput<TMedia> = ResolveProductSelectionMediaInput<TMedia> & {
|
|
57
|
-
variantFeaturedMediaItemId?: string | number | null;
|
|
58
|
-
selectedOptionValueMediaItemIds?: Array<string | number | null | undefined>;
|
|
59
|
-
legacy?: {
|
|
60
|
-
variantThumbnail?: TMedia | null;
|
|
61
|
-
variantImages?: TMedia[] | null;
|
|
62
|
-
optionValueThumbnails?: Array<TMedia | null | undefined>;
|
|
63
|
-
optionValueImages?: Array<TMedia[] | null | undefined>;
|
|
64
|
-
productThumbnail?: TMedia | null;
|
|
65
|
-
productImages?: TMedia[] | null;
|
|
66
|
-
};
|
|
67
|
-
};
|
|
68
|
-
/** @deprecated Use `ResolveProductSelectionMediaResult`. */
|
|
69
|
-
type ResolveProductMediaResult<TMedia> = Omit<ResolveProductSelectionMediaResult<TMedia>, 'source'> & {
|
|
70
|
-
source: MediaPointerSource;
|
|
71
|
-
};
|
|
72
|
-
/**
|
|
73
|
-
* @deprecated One-release shim for ADR 0025. Prefer
|
|
74
|
-
* `resolveProductSelectionMedia()`. Legacy direct-media fallbacks are ignored;
|
|
75
|
-
* callers fall through to product display media (`resolveProductDisplayMedia`)
|
|
76
|
-
* or `none`.
|
|
77
|
-
*/
|
|
78
|
-
declare function resolveProductMedia<TMedia>(input: ResolveProductMediaInput<TMedia>): ResolveProductMediaResult<TMedia>;
|
|
79
|
-
|
|
80
|
-
/** @deprecated ADR 0025 replaces media sets with variant `images[]` subsets. */
|
|
81
|
-
type ProductMediaSetMatchType = 'default' | 'option-values' | 'exact-variant';
|
|
82
|
-
/** @deprecated Use `ResolveProductSelectionMediaInput` and variant `images[]`. */
|
|
83
|
-
type ProductMediaSetInput = {
|
|
84
|
-
label?: string | null;
|
|
85
|
-
matchType: ProductMediaSetMatchType;
|
|
86
|
-
optionValueIds?: Array<string | number | null | undefined> | null;
|
|
87
|
-
variantIds?: Array<string | number | null | undefined> | null;
|
|
88
|
-
items: Array<string | number | null | undefined>;
|
|
89
|
-
primaryMediaItemId?: string | number | null;
|
|
90
|
-
};
|
|
91
|
-
type LegacyProductGallerySource = 'exact_variant_set' | 'option_value_set' | 'default_set';
|
|
92
|
-
/** @deprecated Use `ResolveProductSelectionMediaInput`. */
|
|
93
|
-
type ResolveProductGalleryInput<TMedia> = ResolveProductSelectionMediaInput<TMedia> & {
|
|
94
|
-
pool?: TMedia[] | null;
|
|
95
|
-
mediaSets?: ProductMediaSetInput[] | null;
|
|
96
|
-
selectedVariantId?: string | number | null;
|
|
97
|
-
selectedOptionValueIds?: Array<string | number | null | undefined> | null;
|
|
98
|
-
featuredImage?: ProductSelectionMediaPointer;
|
|
99
|
-
};
|
|
100
|
-
/** @deprecated Use selection or display media source types. */
|
|
101
|
-
type ProductGallerySource = ProductSelectionMediaSource | ProductDisplayMediaSource | LegacyProductGallerySource;
|
|
102
|
-
/** @deprecated Use `ResolveProductSelectionMediaResult`. */
|
|
103
|
-
type ResolveProductGalleryResult<TMedia> = {
|
|
104
|
-
primaryImage: TMedia | null;
|
|
105
|
-
images: TMedia[];
|
|
106
|
-
source: ProductGallerySource;
|
|
107
|
-
};
|
|
108
|
-
/** @deprecated Use `resolveProductSelectionMedia()`. */
|
|
109
|
-
declare function resolveProductGallery<TMedia>(input: ResolveProductGalleryInput<TMedia>): ResolveProductGalleryResult<TMedia>;
|
|
110
|
-
|
|
111
53
|
declare const generateOrderNumber: () => string;
|
|
112
54
|
|
|
113
55
|
type OrderItem = {
|
|
@@ -129,4 +71,4 @@ declare function resolveRelation<T>(ref: unknown): T | null;
|
|
|
129
71
|
|
|
130
72
|
declare function createClient(options: ClientConfig): RootClientWithEvents;
|
|
131
73
|
|
|
132
|
-
export { BaseApi, CancelMembershipParams, CancelMembershipResponse, ClientConfig,
|
|
74
|
+
export { BaseApi, CancelMembershipParams, CancelMembershipResponse, ClientConfig, MembershipApi, type MembershipApiOptions, type MergedProductDetailResult, ProductDetail, ProductDetailCatalog, type ProductDetailStockMergeStatus, RootClientWithEvents, ServerApiOptions, StockSnapshotResponse, SubscribeMembershipParams, SubscribeMembershipResponse, assertCommerceIdempotencyKey, createClient, createCommerceIdempotencyKey, formatOrderName, generateOrderNumber, isCommerceIdempotencyKey, mergeProductDetailWithStock, resolveRelation };
|