@01.software/sdk 0.49.0 → 0.56.1
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 +257 -1
- package/MIGRATION.md +56 -0
- package/README.md +269 -56
- package/dist/client.cjs +608 -190
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +6 -6
- package/dist/client.d.ts +6 -6
- package/dist/client.js +608 -190
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-DnDt6EQz.d.ts → collection-client-Bmr53saa.d.ts} +6 -4
- package/dist/{collection-client-XfGLPuTf.d.cts → collection-client-DxuBDso_.d.cts} +6 -4
- package/dist/{const-CBba4lDo.d.cts → const-BKUqg96Q.d.ts} +5 -5
- package/dist/{const-DCNV5Kq7.d.ts → const-Cv1DCsp6.d.cts} +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 +1 -0
- package/dist/errors.cjs.map +1 -1
- package/dist/errors.d.cts +3 -3
- package/dist/errors.d.ts +3 -3
- package/dist/errors.js +1 -0
- package/dist/errors.js.map +1 -1
- package/dist/{index-DUuIqUS8.d.ts → index-CGsT4AQ8.d.cts} +89 -10
- package/dist/{index-CbKyoEzy.d.cts → index-DFHLLqYu.d.ts} +89 -10
- package/dist/index.cjs +752 -436
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +12 -69
- package/dist/index.d.ts +12 -69
- package/dist/index.js +752 -436
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-MKbx5MuJ.d.cts → payload-types-Bk-duc5k.d.cts} +545 -141
- package/dist/{payload-types-MKbx5MuJ.d.ts → payload-types-Bk-duc5k.d.ts} +545 -141
- package/dist/query.cjs +108 -71
- 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 +108 -71
- 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 +502 -175
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +9 -8
- package/dist/server.d.ts +9 -8
- package/dist/server.js +502 -175
- package/dist/server.js.map +1 -1
- package/dist/storefront-cache.cjs +1 -0
- package/dist/storefront-cache.cjs.map +1 -1
- package/dist/storefront-cache.js +1 -0
- package/dist/storefront-cache.js.map +1 -1
- package/dist/{types-1UeOk1Uy.d.cts → types-CEK8uTvU.d.ts} +287 -30
- package/dist/{types-BKr_2avj.d.cts → types-CNdpj2fI.d.cts} +2 -2
- package/dist/{types-L_nh-ED7.d.ts → types-D4mjGFj4.d.ts} +2 -2
- package/dist/{types-Du4s5anw.d.ts → types-Dhk5NX7Z.d.cts} +287 -30
- 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 +135 -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 +135 -80
- package/dist/webhook.js.map +1 -1
- package/package.json +28 -6
package/dist/index.d.cts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
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,
|
|
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 { cy as BaseApi, aF as ServerApiOptions, aI as SubscribeMembershipParams, aJ as SubscribeMembershipResponse, e as CancelMembershipParams, f as CancelMembershipResponse, cz as ProductDetail, cA as ProductDetailCatalog, cB as StockSnapshotResponse, h as ClientConfig, cC as RootClientWithEvents } from './types-Dhk5NX7Z.cjs';
|
|
2
|
+
export { A as AddItemParams, i as ApiQueryOptions, cD as BulkImportFulfillmentsParams, cE as BulkImportFulfillmentsResponse, cF as CalculateShippingParams, cG as CalculateShippingResult, j as CancelBrowserPaymentSessionParams, cH as CancelOrderParams, cI as CancelOrderResponse, cJ as CancelReasonCode, cK as CartDiscountCode, k as CartMergeParams, l as CartMergeResult, m as CartMineResult, n as CartMutationResult, cL as CartWarning, cM 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, cN as Comment, C as CommerceClient, cO as CommerceClientOptions, a as CommunityClient, cP as CommunityClientOptions, cQ as CommunityComment, cR as CommunityCommentListSort, cS as CommunityPost, cT as CommunityPostCategory, cU as CommunityPostListSort, cV as CommunityPostTag, cW as CommunityPublicAuthorSnapshot, cX as CommunityPublicMediaAsset, cY as CommunityPublicReference, cZ as CompatibilityProductSelectionParamEvent, b as ContentClient, v as ContentClientOptions, w as CreateCartParams, x as CreateCartResult, y as CreateCheckoutParams, z as CreateCheckoutResult, c_ as CreateFulfillmentParams, B as CreatePaymentSessionParams, D as CreatePortOnePaymentSessionParams, c$ as CreateReturnParams, ch as CustomerAuth, d0 as CustomerAuthOptions, cj as CustomerAuthResponse, d1 as CustomerAuthorizationUrlInput, d2 as CustomerAuthorizationUrlResult, aK as CustomerGroupApi, ba as CustomerGroupApiOptions, bb as CustomerGroupManualSource, bc as CustomerGroupMember, bd as CustomerGroupMemberCommandResponse, be as CustomerGroupMemberSource, bf as CustomerGroupMembershipSource, bg as CustomerGroupMembershipState, ck as CustomerLoginData, d as CustomerMembershipView, c as CustomerNamespace, d3 as CustomerOAuth, d4 as CustomerOAuthCallbackResult, d5 as CustomerOAuthConfig, d6 as CustomerOAuthTokenSet, d7 as CustomerOrderListOptions, ci as CustomerProfile, cn as CustomerRefreshResponse, cm as CustomerRegisterData, cl as CustomerRegisterResponse, F as CustomerSnapshot, G as DebugConfig, H as DeepPartial, d8 as DiscountApi, d9 as DiscountApiOptions, da as DiscountErrorReasonCode, bh as EventAdmissionAvailabilityParams, bi as EventAdmissionAvailabilityResponse, bj as EventAdmissionAvailabilityType, bk as EventAdmissionPricePresentment, bl as EventGuestCancelParams, bm as EventGuestRegistration, bn as EventGuestRegistrationResponse, bo as EventRegistrationAnswerInput, bp as EventRegistrationAttendeeInput, bq as EventRegistrationPublic, br as EventRegistrationRegisterParams, bs as EventRegistrationRegisterResponse, bt as EventsCalendarItem, E as EventsClient, bu as EventsClientOptions, bv as EventsDateParam, bw as EventsExternalSource, bx as EventsLocation, by as EventsOccurrenceLocation, bz as EventsRangeEvent, bA as EventsRangeOccurrence, bB as EventsRangeParams, bC as EventsRangeResponse, bD as EventsTaxonomyItem, I as ExtractArrayType, db as FeaturedImagePointerInput, dc as GetOrderByPaymentIdParams, bG as GrantCustomerGroupMemberParams, dd as LegacyProductSelectionParamEvent, bH as ListCustomerGroupMembersParams, bI as ListCustomerGroupMembersResponse, de as ListingGroupsParams, df as MAX_CART_LINE_ADMISSIONS, dg as ManagedPaymentNextAction, dh as ManagedPublicPaymentSession, di as MarketDTO, dj as MediaValue, J as MembershipStatus, K as Money, dk as NormalizedOptionSwatch, dl as NormalizedProductSelection, O as OpenCheckoutPaymentState, dm as OrderApi, dn as OrderApiOptions, dp as OrderByPaymentResult, dq as PRODUCT_PLP_FIND_OPTIONS, dr as PRODUCT_UPSERT_READONLY_FIELD_REASON, ds 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, dt as PrepareFulfillmentOrderParams, du as PrepareFulfillmentOrderResponse, dv as ProductApi, dw as ProductApiOptions, dx as ProductDetailBrand, cs as ProductDetailCatalogResult, dy as ProductDetailCatalogVariant, dz as ProductDetailCategory, dA as ProductDetailImage, dB as ProductDetailImageMedia, dC as ProductDetailMedia, dD as ProductDetailOption, dE as ProductDetailOptionValue, cr as ProductDetailParams, dF as ProductDetailResult, dG as ProductDetailTag, dH as ProductDetailUnavailableReason, dI as ProductDetailVariant, dJ as ProductDetailVariantOptionValue, dK as ProductDetailVideo, dL as ProductDisplayMediaSource, dM as ProductFallbackLocaleOption, dN as ProductHrefGroup, dO as ProductHrefOptions, dP as ProductHrefProduct, dQ as ProductListingCard, dR as ProductListingCardOptions, dS as ProductListingCardPriceRange, dT as ProductListingCardRepresentativeVariant, dU as ProductListingGroup, dV as ProductListingGroupCatalogSummary, dW as ProductListingGroupCatalogVariant, dX as ProductListingGroupProjection, dY as ProductListingGroupSummary, dZ as ProductListingGroupVariant, cv as ProductListingGroupsCatalogItem, d_ as ProductListingGroupsCatalogProduct, d$ as ProductListingGroupsCatalogResponse, cx as ProductListingGroupsItem, e0 as ProductListingGroupsProduct, e1 as ProductListingGroupsResponse, cq as ProductListingPageBaseParams, ct as ProductListingPageCatalogParams, e2 as ProductListingPageFilters, cw as ProductListingPageFullParams, cp as ProductListingPageParams, cu as ProductListingPageResult, e3 as ProductListingPageSort, e4 as ProductListingProductShape, e5 as ProductListingSwatch, e6 as ProductLocaleOption, e7 as ProductLocaleReadParams, e8 as ProductLocalizedText, e9 as ProductLocalizedValue, ea as ProductMediaResolutionSource, eb as ProductMoneyRange, ec as ProductOptionMatrix, ed as ProductOptionMatrixOption, ee as ProductOptionMatrixValue, ef as ProductOptionMatrixVariant, eg as ProductOptionShape, eh as ProductOptionValueShape, ei as ProductOptionValueSwatch, ej as ProductOptionValueSwatchInput, ek as ProductPriceRange, el as ProductSelectionAvailableSwatch, em as ProductSelectionAvailableValue, en as ProductSelectionByOptionValue, eo as ProductSelectionCodecError, ep as ProductSelectionCodecOptions, eq as ProductSelectionInput, er as ProductSelectionMediaPointer, es as ProductSelectionMediaSource, et as ProductSelectionOptionValue, eu as ProductSelectionResolution, ev as ProductSelectionResolutionContext, ew as ProductSelectionUrlEmit, ex as ProductSelectionVariant, ey as ProductUpsertFieldValidationErrorBody, ez as ProductUpsertFieldValidationErrorReason, X as ProductUpsertInput, Y as ProductUpsertParams, Z as ProductUpsertResponse, _ as ProductUpsertVariantInput, eA 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, eB 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, cg as PublicReadQueryOptions, af as ReconciliationRequired, ag as RemoveItemParams, eC as RequestOptions, eD as ResolveCancelRefundFailedResponse, eE as ResolveCancelRefundOutcome, eF as ResolveCancelRefundParams, eG as ResolveCancelRefundResponse, eH as ResolveCancelRefundSucceededResponse, eI as ResolveProductDisplayMediaInput, eJ as ResolveProductDisplayMediaResult, eK as ResolveProductSelectionMediaInput, eL as ResolveProductSelectionMediaResult, eM as ResolvedCatalogPrice, ah as RetrieveBrowserPaymentSessionParams, ai as RetrieveCartParams, aj as RetrieveCheckoutParams, bT as RetrieveServerCheckoutParams, ak as RetryConfig, eN as ReturnCancellationReasonCode, eO as ReturnItem, eP as ReturnReason, eQ as ReturnWithRefundItem, eR as ReturnWithRefundParams, bW as RevokeCustomerGroupMemberParams, al as RootClient, am as RootCollectionClient, an as RootReadOnlyQueryBuilder, eS as ShippingApi, eT as ShippingApiOptions, ao as ShippingLine, ap as Sort, aq as SpentCheckoutPaymentState, eU as StockCheckParams, eV as StockCheckResponse, eW as StockCheckResult, eX as StockSnapshotItem, eY 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, eZ as UpdateFulfillmentParams, aB as UpdateItemParams, e_ as UpdateOrderParams, co as UpdateProfileData, e$ as UpdateReturnParams, f0 as ValidateDiscountParams, f1 as ValidateDiscountResult, aC as VariantInput, aD as Where, f2 as WithIdempotencyKey, f3 as buildProductHref, f4 as buildProductListingCard, f5 as buildProductListingGroupProjection, f6 as buildProductListingGroupsByOption, f7 as buildProductOptionMatrix, f8 as buildProductOptionMatrixFromDetail, f9 as createProductSelectionCodec, fa as getAvailableOptionValues, fb as getProductSelectionImages, fc as getSelectedValueByOptionId, fd as getVariantAvailableForSale, fe as getVariantAvailableStock, ff as isProductUpsertFieldValidationErrorBody, fg as normalizeProductSelection, fh as normalizeProductSelectionFromMatrix, fi as normalizeSelectedValueIds, fj as parseProductSelection, fk as projectProductToListingShape, fl as resolveFeaturedImagePointer, fm as resolveProductDisplayMedia, fn as resolveProductSelection, fo as resolveProductSelectionFromMatrix, fp as resolveProductSelectionMedia, fq as resolveVariantForSelection, fr as selectNext, fs as selectedSwatchMediaItemId, ft as stringifyProductSelection, fu as toShopifyPriceRangeV2 } from './types-Dhk5NX7Z.cjs';
|
|
3
|
+
import { P as Product } from './payload-types-Bk-duc5k.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-Bk-duc5k.cjs';
|
|
5
|
+
export { C as CollectionType, P as Market, a as Product, b as ProductCollection, c as ProductVariant } from './types-CNdpj2fI.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, a2 as CustomerCommerceNotificationEventName, t as CustomerPasswordResetWebhookData, u as CustomerPasswordResetWebhookEvent, M as MembershipNotificationData, v as MembershipNotificationEventName, O as ORDER_CHANGED_EVENT_TYPE, w as OrderChangedWebhookEvent, P as PaymentIncidentMoney, x as PaymentIncidentNotificationData, y as PaymentIncidentNotificationEventName, z as PaymentIncidentNotificationReason, A as PaymentIncidentNotificationSourceCollection, B as PaymentIncidentNotificationStatus, D as PaymentIncidentProviderObject, a3 as PaymentReconciliationRequiredNotificationData, a4 as PaymentRefundRequiresAttentionNotificationData, E as WebhookChange, F as WebhookCommerceNotificationChange, G as WebhookEvent, W as WebhookHandler, H as WebhookKnownOperation, I as WebhookOperation, J as WebhookOptions, K as WebhookOrderChange, L as WebhookOrderMoved, N as WebhookOrderScope, Q as createCommerceEmailWebhookHandler, R as createCommerceNotificationWebhookHandler, S as createCustomerAuthWebhookHandler, T as createTypedWebhookHandler, U as defineCommerceEmailConfig, V as getCommerceNotificationIdempotencyKey, X as handleWebhook, Y as isCommerceNotificationWebhookEvent, Z as isCustomerPasswordResetWebhookEvent, _ as isOrderChangedWebhookEvent, $ as isValidWebhookEvent, a0 as isWebhookCollection, a1 as isWebhookOperation } from './index-CGsT4AQ8.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-Cv1DCsp6.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';
|
|
@@ -26,9 +26,10 @@ type MembershipApiOptions = ServerApiOptions;
|
|
|
26
26
|
declare class MembershipApi extends BaseApi {
|
|
27
27
|
constructor(options: MembershipApiOptions);
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* `
|
|
29
|
+
* Prepare a delegated first charge for a paid Membership, or immediately
|
|
30
|
+
* start a trial. For a paid response, charge through the tenant PSP with
|
|
31
|
+
* `firstCharge.idempotencyKey`, then post the existing signed charge result
|
|
32
|
+
* to activate the membership.
|
|
32
33
|
*
|
|
33
34
|
* `subscribeIntentKey` is used as the HTTP idempotency key so the call is
|
|
34
35
|
* safely retryable.
|
|
@@ -50,64 +51,6 @@ interface MergedProductDetailResult {
|
|
|
50
51
|
}
|
|
51
52
|
declare function mergeProductDetailWithStock(catalog: ProductDetailCatalog, snapshot: StockSnapshotResponse): MergedProductDetailResult;
|
|
52
53
|
|
|
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
54
|
declare const generateOrderNumber: () => string;
|
|
112
55
|
|
|
113
56
|
type OrderItem = {
|
|
@@ -129,4 +72,4 @@ declare function resolveRelation<T>(ref: unknown): T | null;
|
|
|
129
72
|
|
|
130
73
|
declare function createClient(options: ClientConfig): RootClientWithEvents;
|
|
131
74
|
|
|
132
|
-
export { BaseApi, CancelMembershipParams, CancelMembershipResponse, ClientConfig,
|
|
75
|
+
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,10 +1,10 @@
|
|
|
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,
|
|
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 { cy as BaseApi, aF as ServerApiOptions, aI as SubscribeMembershipParams, aJ as SubscribeMembershipResponse, e as CancelMembershipParams, f as CancelMembershipResponse, cz as ProductDetail, cA as ProductDetailCatalog, cB as StockSnapshotResponse, h as ClientConfig, cC as RootClientWithEvents } from './types-CEK8uTvU.js';
|
|
2
|
+
export { A as AddItemParams, i as ApiQueryOptions, cD as BulkImportFulfillmentsParams, cE as BulkImportFulfillmentsResponse, cF as CalculateShippingParams, cG as CalculateShippingResult, j as CancelBrowserPaymentSessionParams, cH as CancelOrderParams, cI as CancelOrderResponse, cJ as CancelReasonCode, cK as CartDiscountCode, k as CartMergeParams, l as CartMergeResult, m as CartMineResult, n as CartMutationResult, cL as CartWarning, cM 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, cN as Comment, C as CommerceClient, cO as CommerceClientOptions, a as CommunityClient, cP as CommunityClientOptions, cQ as CommunityComment, cR as CommunityCommentListSort, cS as CommunityPost, cT as CommunityPostCategory, cU as CommunityPostListSort, cV as CommunityPostTag, cW as CommunityPublicAuthorSnapshot, cX as CommunityPublicMediaAsset, cY as CommunityPublicReference, cZ as CompatibilityProductSelectionParamEvent, b as ContentClient, v as ContentClientOptions, w as CreateCartParams, x as CreateCartResult, y as CreateCheckoutParams, z as CreateCheckoutResult, c_ as CreateFulfillmentParams, B as CreatePaymentSessionParams, D as CreatePortOnePaymentSessionParams, c$ as CreateReturnParams, ch as CustomerAuth, d0 as CustomerAuthOptions, cj as CustomerAuthResponse, d1 as CustomerAuthorizationUrlInput, d2 as CustomerAuthorizationUrlResult, aK as CustomerGroupApi, ba as CustomerGroupApiOptions, bb as CustomerGroupManualSource, bc as CustomerGroupMember, bd as CustomerGroupMemberCommandResponse, be as CustomerGroupMemberSource, bf as CustomerGroupMembershipSource, bg as CustomerGroupMembershipState, ck as CustomerLoginData, d as CustomerMembershipView, c as CustomerNamespace, d3 as CustomerOAuth, d4 as CustomerOAuthCallbackResult, d5 as CustomerOAuthConfig, d6 as CustomerOAuthTokenSet, d7 as CustomerOrderListOptions, ci as CustomerProfile, cn as CustomerRefreshResponse, cm as CustomerRegisterData, cl as CustomerRegisterResponse, F as CustomerSnapshot, G as DebugConfig, H as DeepPartial, d8 as DiscountApi, d9 as DiscountApiOptions, da as DiscountErrorReasonCode, bh as EventAdmissionAvailabilityParams, bi as EventAdmissionAvailabilityResponse, bj as EventAdmissionAvailabilityType, bk as EventAdmissionPricePresentment, bl as EventGuestCancelParams, bm as EventGuestRegistration, bn as EventGuestRegistrationResponse, bo as EventRegistrationAnswerInput, bp as EventRegistrationAttendeeInput, bq as EventRegistrationPublic, br as EventRegistrationRegisterParams, bs as EventRegistrationRegisterResponse, bt as EventsCalendarItem, E as EventsClient, bu as EventsClientOptions, bv as EventsDateParam, bw as EventsExternalSource, bx as EventsLocation, by as EventsOccurrenceLocation, bz as EventsRangeEvent, bA as EventsRangeOccurrence, bB as EventsRangeParams, bC as EventsRangeResponse, bD as EventsTaxonomyItem, I as ExtractArrayType, db as FeaturedImagePointerInput, dc as GetOrderByPaymentIdParams, bG as GrantCustomerGroupMemberParams, dd as LegacyProductSelectionParamEvent, bH as ListCustomerGroupMembersParams, bI as ListCustomerGroupMembersResponse, de as ListingGroupsParams, df as MAX_CART_LINE_ADMISSIONS, dg as ManagedPaymentNextAction, dh as ManagedPublicPaymentSession, di as MarketDTO, dj as MediaValue, J as MembershipStatus, K as Money, dk as NormalizedOptionSwatch, dl as NormalizedProductSelection, O as OpenCheckoutPaymentState, dm as OrderApi, dn as OrderApiOptions, dp as OrderByPaymentResult, dq as PRODUCT_PLP_FIND_OPTIONS, dr as PRODUCT_UPSERT_READONLY_FIELD_REASON, ds 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, dt as PrepareFulfillmentOrderParams, du as PrepareFulfillmentOrderResponse, dv as ProductApi, dw as ProductApiOptions, dx as ProductDetailBrand, cs as ProductDetailCatalogResult, dy as ProductDetailCatalogVariant, dz as ProductDetailCategory, dA as ProductDetailImage, dB as ProductDetailImageMedia, dC as ProductDetailMedia, dD as ProductDetailOption, dE as ProductDetailOptionValue, cr as ProductDetailParams, dF as ProductDetailResult, dG as ProductDetailTag, dH as ProductDetailUnavailableReason, dI as ProductDetailVariant, dJ as ProductDetailVariantOptionValue, dK as ProductDetailVideo, dL as ProductDisplayMediaSource, dM as ProductFallbackLocaleOption, dN as ProductHrefGroup, dO as ProductHrefOptions, dP as ProductHrefProduct, dQ as ProductListingCard, dR as ProductListingCardOptions, dS as ProductListingCardPriceRange, dT as ProductListingCardRepresentativeVariant, dU as ProductListingGroup, dV as ProductListingGroupCatalogSummary, dW as ProductListingGroupCatalogVariant, dX as ProductListingGroupProjection, dY as ProductListingGroupSummary, dZ as ProductListingGroupVariant, cv as ProductListingGroupsCatalogItem, d_ as ProductListingGroupsCatalogProduct, d$ as ProductListingGroupsCatalogResponse, cx as ProductListingGroupsItem, e0 as ProductListingGroupsProduct, e1 as ProductListingGroupsResponse, cq as ProductListingPageBaseParams, ct as ProductListingPageCatalogParams, e2 as ProductListingPageFilters, cw as ProductListingPageFullParams, cp as ProductListingPageParams, cu as ProductListingPageResult, e3 as ProductListingPageSort, e4 as ProductListingProductShape, e5 as ProductListingSwatch, e6 as ProductLocaleOption, e7 as ProductLocaleReadParams, e8 as ProductLocalizedText, e9 as ProductLocalizedValue, ea as ProductMediaResolutionSource, eb as ProductMoneyRange, ec as ProductOptionMatrix, ed as ProductOptionMatrixOption, ee as ProductOptionMatrixValue, ef as ProductOptionMatrixVariant, eg as ProductOptionShape, eh as ProductOptionValueShape, ei as ProductOptionValueSwatch, ej as ProductOptionValueSwatchInput, ek as ProductPriceRange, el as ProductSelectionAvailableSwatch, em as ProductSelectionAvailableValue, en as ProductSelectionByOptionValue, eo as ProductSelectionCodecError, ep as ProductSelectionCodecOptions, eq as ProductSelectionInput, er as ProductSelectionMediaPointer, es as ProductSelectionMediaSource, et as ProductSelectionOptionValue, eu as ProductSelectionResolution, ev as ProductSelectionResolutionContext, ew as ProductSelectionUrlEmit, ex as ProductSelectionVariant, ey as ProductUpsertFieldValidationErrorBody, ez as ProductUpsertFieldValidationErrorReason, X as ProductUpsertInput, Y as ProductUpsertParams, Z as ProductUpsertResponse, _ as ProductUpsertVariantInput, eA 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, eB 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, cg as PublicReadQueryOptions, af as ReconciliationRequired, ag as RemoveItemParams, eC as RequestOptions, eD as ResolveCancelRefundFailedResponse, eE as ResolveCancelRefundOutcome, eF as ResolveCancelRefundParams, eG as ResolveCancelRefundResponse, eH as ResolveCancelRefundSucceededResponse, eI as ResolveProductDisplayMediaInput, eJ as ResolveProductDisplayMediaResult, eK as ResolveProductSelectionMediaInput, eL as ResolveProductSelectionMediaResult, eM as ResolvedCatalogPrice, ah as RetrieveBrowserPaymentSessionParams, ai as RetrieveCartParams, aj as RetrieveCheckoutParams, bT as RetrieveServerCheckoutParams, ak as RetryConfig, eN as ReturnCancellationReasonCode, eO as ReturnItem, eP as ReturnReason, eQ as ReturnWithRefundItem, eR as ReturnWithRefundParams, bW as RevokeCustomerGroupMemberParams, al as RootClient, am as RootCollectionClient, an as RootReadOnlyQueryBuilder, eS as ShippingApi, eT as ShippingApiOptions, ao as ShippingLine, ap as Sort, aq as SpentCheckoutPaymentState, eU as StockCheckParams, eV as StockCheckResponse, eW as StockCheckResult, eX as StockSnapshotItem, eY 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, eZ as UpdateFulfillmentParams, aB as UpdateItemParams, e_ as UpdateOrderParams, co as UpdateProfileData, e$ as UpdateReturnParams, f0 as ValidateDiscountParams, f1 as ValidateDiscountResult, aC as VariantInput, aD as Where, f2 as WithIdempotencyKey, f3 as buildProductHref, f4 as buildProductListingCard, f5 as buildProductListingGroupProjection, f6 as buildProductListingGroupsByOption, f7 as buildProductOptionMatrix, f8 as buildProductOptionMatrixFromDetail, f9 as createProductSelectionCodec, fa as getAvailableOptionValues, fb as getProductSelectionImages, fc as getSelectedValueByOptionId, fd as getVariantAvailableForSale, fe as getVariantAvailableStock, ff as isProductUpsertFieldValidationErrorBody, fg as normalizeProductSelection, fh as normalizeProductSelectionFromMatrix, fi as normalizeSelectedValueIds, fj as parseProductSelection, fk as projectProductToListingShape, fl as resolveFeaturedImagePointer, fm as resolveProductDisplayMedia, fn as resolveProductSelection, fo as resolveProductSelectionFromMatrix, fp as resolveProductSelectionMedia, fq as resolveVariantForSelection, fr as selectNext, fs as selectedSwatchMediaItemId, ft as stringifyProductSelection, fu as toShopifyPriceRangeV2 } from './types-CEK8uTvU.js';
|
|
3
|
+
import { P as Product } from './payload-types-Bk-duc5k.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-Bk-duc5k.js';
|
|
5
|
+
export { C as CollectionType, P as Market, a as Product, b as ProductCollection, c as ProductVariant } from './types-D4mjGFj4.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, a2 as CustomerCommerceNotificationEventName, t as CustomerPasswordResetWebhookData, u as CustomerPasswordResetWebhookEvent, M as MembershipNotificationData, v as MembershipNotificationEventName, O as ORDER_CHANGED_EVENT_TYPE, w as OrderChangedWebhookEvent, P as PaymentIncidentMoney, x as PaymentIncidentNotificationData, y as PaymentIncidentNotificationEventName, z as PaymentIncidentNotificationReason, A as PaymentIncidentNotificationSourceCollection, B as PaymentIncidentNotificationStatus, D as PaymentIncidentProviderObject, a3 as PaymentReconciliationRequiredNotificationData, a4 as PaymentRefundRequiresAttentionNotificationData, E as WebhookChange, F as WebhookCommerceNotificationChange, G as WebhookEvent, W as WebhookHandler, H as WebhookKnownOperation, I as WebhookOperation, J as WebhookOptions, K as WebhookOrderChange, L as WebhookOrderMoved, N as WebhookOrderScope, Q as createCommerceEmailWebhookHandler, R as createCommerceNotificationWebhookHandler, S as createCustomerAuthWebhookHandler, T as createTypedWebhookHandler, U as defineCommerceEmailConfig, V as getCommerceNotificationIdempotencyKey, X as handleWebhook, Y as isCommerceNotificationWebhookEvent, Z as isCustomerPasswordResetWebhookEvent, _ as isOrderChangedWebhookEvent, $ as isValidWebhookEvent, a0 as isWebhookCollection, a1 as isWebhookOperation } from './index-DFHLLqYu.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-BKUqg96Q.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';
|
|
@@ -26,9 +26,10 @@ type MembershipApiOptions = ServerApiOptions;
|
|
|
26
26
|
declare class MembershipApi extends BaseApi {
|
|
27
27
|
constructor(options: MembershipApiOptions);
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* `
|
|
29
|
+
* Prepare a delegated first charge for a paid Membership, or immediately
|
|
30
|
+
* start a trial. For a paid response, charge through the tenant PSP with
|
|
31
|
+
* `firstCharge.idempotencyKey`, then post the existing signed charge result
|
|
32
|
+
* to activate the membership.
|
|
32
33
|
*
|
|
33
34
|
* `subscribeIntentKey` is used as the HTTP idempotency key so the call is
|
|
34
35
|
* safely retryable.
|
|
@@ -50,64 +51,6 @@ interface MergedProductDetailResult {
|
|
|
50
51
|
}
|
|
51
52
|
declare function mergeProductDetailWithStock(catalog: ProductDetailCatalog, snapshot: StockSnapshotResponse): MergedProductDetailResult;
|
|
52
53
|
|
|
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
54
|
declare const generateOrderNumber: () => string;
|
|
112
55
|
|
|
113
56
|
type OrderItem = {
|
|
@@ -129,4 +72,4 @@ declare function resolveRelation<T>(ref: unknown): T | null;
|
|
|
129
72
|
|
|
130
73
|
declare function createClient(options: ClientConfig): RootClientWithEvents;
|
|
131
74
|
|
|
132
|
-
export { BaseApi, CancelMembershipParams, CancelMembershipResponse, ClientConfig,
|
|
75
|
+
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 };
|