@shopify/hydrogen-react 0.0.0-next-a6c2b91 → 0.0.0-next-90b5ccf
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser-dev/AddToCartButton.mjs.map +1 -1
- package/dist/browser-dev/BaseButton.mjs.map +1 -1
- package/dist/browser-dev/BuyNowButton.mjs.map +1 -1
- package/dist/browser-dev/CartCheckoutButton.mjs.map +1 -1
- package/dist/browser-dev/CartProvider.mjs.map +1 -1
- package/dist/browser-dev/ExternalVideo.mjs.map +1 -1
- package/dist/browser-dev/Image.mjs.map +1 -1
- package/dist/browser-dev/MediaFile.mjs.map +1 -1
- package/dist/browser-dev/Metafield.mjs.map +1 -1
- package/dist/browser-dev/ModelViewer.mjs.map +1 -1
- package/dist/browser-dev/Money.mjs.map +1 -1
- package/dist/browser-dev/ProductPrice.mjs.map +1 -1
- package/dist/browser-dev/ProductProvider.mjs.map +1 -1
- package/dist/browser-dev/ShopPayButton.mjs.map +1 -1
- package/dist/browser-dev/ShopifyProvider.mjs.map +1 -1
- package/dist/browser-dev/Video.mjs.map +1 -1
- package/dist/browser-dev/cart-hooks.mjs.map +1 -1
- package/dist/browser-dev/load-script.mjs.map +1 -1
- package/dist/browser-dev/useCartAPIStateMachine.mjs.map +1 -1
- package/dist/browser-dev/useCartActions.mjs.map +1 -1
- package/dist/browser-dev/useMoney.mjs.map +1 -1
- package/dist/browser-prod/AddToCartButton.mjs.map +1 -1
- package/dist/browser-prod/BaseButton.mjs.map +1 -1
- package/dist/browser-prod/BuyNowButton.mjs.map +1 -1
- package/dist/browser-prod/CartCheckoutButton.mjs.map +1 -1
- package/dist/browser-prod/CartProvider.mjs.map +1 -1
- package/dist/browser-prod/ExternalVideo.mjs.map +1 -1
- package/dist/browser-prod/Image.mjs.map +1 -1
- package/dist/browser-prod/MediaFile.mjs.map +1 -1
- package/dist/browser-prod/Metafield.mjs.map +1 -1
- package/dist/browser-prod/ModelViewer.mjs.map +1 -1
- package/dist/browser-prod/Money.mjs.map +1 -1
- package/dist/browser-prod/ProductPrice.mjs.map +1 -1
- package/dist/browser-prod/ProductProvider.mjs.map +1 -1
- package/dist/browser-prod/ShopPayButton.mjs.map +1 -1
- package/dist/browser-prod/ShopifyProvider.mjs.map +1 -1
- package/dist/browser-prod/Video.mjs.map +1 -1
- package/dist/browser-prod/cart-hooks.mjs.map +1 -1
- package/dist/browser-prod/load-script.mjs.map +1 -1
- package/dist/browser-prod/useCartAPIStateMachine.mjs.map +1 -1
- package/dist/browser-prod/useCartActions.mjs.map +1 -1
- package/dist/browser-prod/useMoney.mjs.map +1 -1
- package/dist/node-dev/AddToCartButton.js.map +1 -1
- package/dist/node-dev/AddToCartButton.mjs.map +1 -1
- package/dist/node-dev/BaseButton.js.map +1 -1
- package/dist/node-dev/BaseButton.mjs.map +1 -1
- package/dist/node-dev/BuyNowButton.js.map +1 -1
- package/dist/node-dev/BuyNowButton.mjs.map +1 -1
- package/dist/node-dev/CartCheckoutButton.js.map +1 -1
- package/dist/node-dev/CartCheckoutButton.mjs.map +1 -1
- package/dist/node-dev/CartProvider.js.map +1 -1
- package/dist/node-dev/CartProvider.mjs.map +1 -1
- package/dist/node-dev/ExternalVideo.js.map +1 -1
- package/dist/node-dev/ExternalVideo.mjs.map +1 -1
- package/dist/node-dev/Image.js.map +1 -1
- package/dist/node-dev/Image.mjs.map +1 -1
- package/dist/node-dev/MediaFile.js.map +1 -1
- package/dist/node-dev/MediaFile.mjs.map +1 -1
- package/dist/node-dev/Metafield.js.map +1 -1
- package/dist/node-dev/Metafield.mjs.map +1 -1
- package/dist/node-dev/ModelViewer.js.map +1 -1
- package/dist/node-dev/ModelViewer.mjs.map +1 -1
- package/dist/node-dev/Money.js.map +1 -1
- package/dist/node-dev/Money.mjs.map +1 -1
- package/dist/node-dev/ProductPrice.js.map +1 -1
- package/dist/node-dev/ProductPrice.mjs.map +1 -1
- package/dist/node-dev/ProductProvider.js.map +1 -1
- package/dist/node-dev/ProductProvider.mjs.map +1 -1
- package/dist/node-dev/ShopPayButton.js.map +1 -1
- package/dist/node-dev/ShopPayButton.mjs.map +1 -1
- package/dist/node-dev/ShopifyProvider.js.map +1 -1
- package/dist/node-dev/ShopifyProvider.mjs.map +1 -1
- package/dist/node-dev/Video.js.map +1 -1
- package/dist/node-dev/Video.mjs.map +1 -1
- package/dist/node-dev/cart-hooks.js.map +1 -1
- package/dist/node-dev/cart-hooks.mjs.map +1 -1
- package/dist/node-dev/load-script.js.map +1 -1
- package/dist/node-dev/load-script.mjs.map +1 -1
- package/dist/node-dev/useCartAPIStateMachine.js.map +1 -1
- package/dist/node-dev/useCartAPIStateMachine.mjs.map +1 -1
- package/dist/node-dev/useCartActions.js.map +1 -1
- package/dist/node-dev/useCartActions.mjs.map +1 -1
- package/dist/node-dev/useMoney.js.map +1 -1
- package/dist/node-dev/useMoney.mjs.map +1 -1
- package/dist/node-prod/AddToCartButton.js.map +1 -1
- package/dist/node-prod/AddToCartButton.mjs.map +1 -1
- package/dist/node-prod/BaseButton.js.map +1 -1
- package/dist/node-prod/BaseButton.mjs.map +1 -1
- package/dist/node-prod/BuyNowButton.js.map +1 -1
- package/dist/node-prod/BuyNowButton.mjs.map +1 -1
- package/dist/node-prod/CartCheckoutButton.js.map +1 -1
- package/dist/node-prod/CartCheckoutButton.mjs.map +1 -1
- package/dist/node-prod/CartProvider.js.map +1 -1
- package/dist/node-prod/CartProvider.mjs.map +1 -1
- package/dist/node-prod/ExternalVideo.js.map +1 -1
- package/dist/node-prod/ExternalVideo.mjs.map +1 -1
- package/dist/node-prod/Image.js.map +1 -1
- package/dist/node-prod/Image.mjs.map +1 -1
- package/dist/node-prod/MediaFile.js.map +1 -1
- package/dist/node-prod/MediaFile.mjs.map +1 -1
- package/dist/node-prod/Metafield.js.map +1 -1
- package/dist/node-prod/Metafield.mjs.map +1 -1
- package/dist/node-prod/ModelViewer.js.map +1 -1
- package/dist/node-prod/ModelViewer.mjs.map +1 -1
- package/dist/node-prod/Money.js.map +1 -1
- package/dist/node-prod/Money.mjs.map +1 -1
- package/dist/node-prod/ProductPrice.js.map +1 -1
- package/dist/node-prod/ProductPrice.mjs.map +1 -1
- package/dist/node-prod/ProductProvider.js.map +1 -1
- package/dist/node-prod/ProductProvider.mjs.map +1 -1
- package/dist/node-prod/ShopPayButton.js.map +1 -1
- package/dist/node-prod/ShopPayButton.mjs.map +1 -1
- package/dist/node-prod/ShopifyProvider.js.map +1 -1
- package/dist/node-prod/ShopifyProvider.mjs.map +1 -1
- package/dist/node-prod/Video.js.map +1 -1
- package/dist/node-prod/Video.mjs.map +1 -1
- package/dist/node-prod/cart-hooks.js.map +1 -1
- package/dist/node-prod/cart-hooks.mjs.map +1 -1
- package/dist/node-prod/load-script.js.map +1 -1
- package/dist/node-prod/load-script.mjs.map +1 -1
- package/dist/node-prod/useCartAPIStateMachine.js.map +1 -1
- package/dist/node-prod/useCartAPIStateMachine.mjs.map +1 -1
- package/dist/node-prod/useCartActions.js.map +1 -1
- package/dist/node-prod/useCartActions.mjs.map +1 -1
- package/dist/node-prod/useMoney.js.map +1 -1
- package/dist/node-prod/useMoney.mjs.map +1 -1
- package/dist/types/BaseButton.d.ts +1 -1
- package/dist/types/CartCheckoutButton.d.ts +1 -1
- package/dist/types/ExternalVideo.d.ts +3 -3
- package/dist/types/Image.d.ts +4 -4
- package/dist/types/MediaFile.d.ts +1 -1
- package/dist/types/Metafield.d.ts +2 -2
- package/dist/types/ModelViewer.d.ts +2 -2
- package/dist/types/Money.d.ts +1 -1
- package/dist/types/ProductProvider.d.ts +3 -3
- package/dist/types/ShopPayButton.d.ts +1 -1
- package/dist/types/ShopifyProvider.d.ts +2 -2
- package/dist/types/cart-types.d.ts +21 -21
- package/dist/types/image-size.d.ts +3 -3
- package/dist/types/load-script.d.ts +2 -2
- package/dist/types/metafield-parser.d.ts +27 -27
- package/dist/types/storefront-api-response.types.d.ts +6 -6
- package/dist/types/storefront-client.d.ts +3 -3
- package/dist/types/useCartActions.d.ts +1 -1
- package/dist/types/useMoney.d.ts +1 -1
- package/dist/umd/hydrogen-react.dev.js.map +1 -1
- package/dist/umd/hydrogen-react.prod.js.map +1 -1
- package/package.json +10 -10
|
@@ -14,7 +14,7 @@ export declare function useShop(): ShopifyContextValue;
|
|
|
14
14
|
/**
|
|
15
15
|
* Shopify-specific values that are used in various Hydrogen-UI components and hooks.
|
|
16
16
|
*/
|
|
17
|
-
export
|
|
17
|
+
export type ShopifyContextProps = {
|
|
18
18
|
/** The globally-unique identifier for the Shop */
|
|
19
19
|
storefrontId?: string;
|
|
20
20
|
/** The host name of the domain (eg: `{shop}.myshopify.com`). If a URL with a scheme (for example `https://`) is passed in, then the scheme is removed. */
|
|
@@ -40,7 +40,7 @@ export declare type ShopifyContextProps = {
|
|
|
40
40
|
*/
|
|
41
41
|
locale?: string;
|
|
42
42
|
};
|
|
43
|
-
export
|
|
43
|
+
export type ShopifyContextValue = ShopifyContextProps & {
|
|
44
44
|
/**
|
|
45
45
|
* Creates the fully-qualified URL to your store's GraphQL endpoint.
|
|
46
46
|
*
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { Cart as CartType, CartInput, CartLine, CartLineInput, CartLineUpdateInput, MutationCartNoteUpdateArgs, CartBuyerIdentityInput, MutationCartAttributesUpdateArgs } from './storefront-api-types.js';
|
|
2
2
|
import { StateMachine } from '@xstate/fsm';
|
|
3
3
|
import type { PartialDeep } from 'type-fest';
|
|
4
|
-
export
|
|
5
|
-
export
|
|
4
|
+
export type CartStatus = CartState['status'];
|
|
5
|
+
export type Cart = PartialDeep<{
|
|
6
6
|
/** The cart's ID if it has been created through the Storefront API. */
|
|
7
7
|
id?: string;
|
|
8
8
|
/** The cart lines. */
|
|
@@ -50,7 +50,7 @@ export interface CartWithActions extends Cart {
|
|
|
50
50
|
/** The fragment used to query the cart object for all queries and mutations. */
|
|
51
51
|
cartFragment: string;
|
|
52
52
|
}
|
|
53
|
-
export
|
|
53
|
+
export type CartState =
|
|
54
54
|
/** A cart has not been created yet, or an error occurred when a cart was attempting to be created or fetched. */
|
|
55
55
|
{
|
|
56
56
|
status: 'uninitialized';
|
|
@@ -76,7 +76,7 @@ export declare type CartState =
|
|
|
76
76
|
cart: Cart;
|
|
77
77
|
error?: string;
|
|
78
78
|
};
|
|
79
|
-
export
|
|
79
|
+
export type CartAction = {
|
|
80
80
|
type: 'cartFetch';
|
|
81
81
|
} | {
|
|
82
82
|
type: 'cartCreate';
|
|
@@ -108,7 +108,7 @@ export declare type CartAction = {
|
|
|
108
108
|
} | {
|
|
109
109
|
type: 'resetCart';
|
|
110
110
|
};
|
|
111
|
-
export
|
|
111
|
+
export type CartMachineContext = {
|
|
112
112
|
cart?: PartialDeep<Cart, {
|
|
113
113
|
recurseIntoArrays: true;
|
|
114
114
|
}>;
|
|
@@ -123,66 +123,66 @@ export declare type CartMachineContext = {
|
|
|
123
123
|
}>;
|
|
124
124
|
errors?: unknown;
|
|
125
125
|
};
|
|
126
|
-
export
|
|
126
|
+
export type CartFetchEvent = {
|
|
127
127
|
type: 'CART_FETCH';
|
|
128
128
|
payload: {
|
|
129
129
|
cartId: string;
|
|
130
130
|
};
|
|
131
131
|
};
|
|
132
|
-
export
|
|
132
|
+
export type CartCreateEvent = {
|
|
133
133
|
type: 'CART_CREATE';
|
|
134
134
|
payload: CartInput;
|
|
135
135
|
};
|
|
136
|
-
export
|
|
136
|
+
export type CartSetEvent = {
|
|
137
137
|
type: 'CART_SET';
|
|
138
138
|
payload: {
|
|
139
139
|
cart: CartType;
|
|
140
140
|
};
|
|
141
141
|
};
|
|
142
|
-
export
|
|
142
|
+
export type CartLineAddEvent = {
|
|
143
143
|
type: 'CARTLINE_ADD';
|
|
144
144
|
payload: {
|
|
145
145
|
lines: CartLineInput[];
|
|
146
146
|
};
|
|
147
147
|
};
|
|
148
|
-
export
|
|
148
|
+
export type CartLineRemoveEvent = {
|
|
149
149
|
type: 'CARTLINE_REMOVE';
|
|
150
150
|
payload: {
|
|
151
151
|
lines: string[];
|
|
152
152
|
};
|
|
153
153
|
};
|
|
154
|
-
export
|
|
154
|
+
export type CartLineUpdateEvent = {
|
|
155
155
|
type: 'CARTLINE_UPDATE';
|
|
156
156
|
payload: {
|
|
157
157
|
lines: CartLineUpdateInput[];
|
|
158
158
|
};
|
|
159
159
|
};
|
|
160
|
-
export
|
|
160
|
+
export type NoteUpdateEvent = {
|
|
161
161
|
type: 'NOTE_UPDATE';
|
|
162
162
|
payload: {
|
|
163
163
|
note: MutationCartNoteUpdateArgs['note'];
|
|
164
164
|
};
|
|
165
165
|
};
|
|
166
|
-
export
|
|
166
|
+
export type BuyerIdentityUpdateEvent = {
|
|
167
167
|
type: 'BUYER_IDENTITY_UPDATE';
|
|
168
168
|
payload: {
|
|
169
169
|
buyerIdentity: CartBuyerIdentityInput;
|
|
170
170
|
};
|
|
171
171
|
};
|
|
172
|
-
export
|
|
172
|
+
export type CartAttributesUpdateEvent = {
|
|
173
173
|
type: 'CART_ATTRIBUTES_UPDATE';
|
|
174
174
|
payload: {
|
|
175
175
|
attributes: MutationCartAttributesUpdateArgs['attributes'];
|
|
176
176
|
};
|
|
177
177
|
};
|
|
178
|
-
export
|
|
178
|
+
export type DiscountCodesUpdateEvent = {
|
|
179
179
|
type: 'DISCOUNT_CODES_UPDATE';
|
|
180
180
|
payload: {
|
|
181
181
|
discountCodes: string[];
|
|
182
182
|
};
|
|
183
183
|
};
|
|
184
|
-
export
|
|
185
|
-
export
|
|
184
|
+
export type CartMachineActionEvent = CartFetchEvent | CartCreateEvent | CartSetEvent | CartLineAddEvent | CartLineRemoveEvent | CartLineUpdateEvent | NoteUpdateEvent | BuyerIdentityUpdateEvent | CartAttributesUpdateEvent | DiscountCodesUpdateEvent;
|
|
185
|
+
export type CartMachineFetchResultEvent = {
|
|
186
186
|
type: 'CART_COMPLETED';
|
|
187
187
|
payload: {
|
|
188
188
|
cartActionEvent: CartMachineActionEvent;
|
|
@@ -203,8 +203,8 @@ export declare type CartMachineFetchResultEvent = {
|
|
|
203
203
|
errors: unknown;
|
|
204
204
|
};
|
|
205
205
|
};
|
|
206
|
-
export
|
|
207
|
-
export
|
|
206
|
+
export type CartMachineEvent = CartMachineActionEvent | CartMachineFetchResultEvent;
|
|
207
|
+
export type CartMachineTypeState = {
|
|
208
208
|
value: 'uninitialized';
|
|
209
209
|
context: CartMachineContext & {
|
|
210
210
|
cart: undefined;
|
|
@@ -272,8 +272,8 @@ export declare type CartMachineTypeState = {
|
|
|
272
272
|
value: 'discountCodesUpdating';
|
|
273
273
|
context: CartMachineContext;
|
|
274
274
|
};
|
|
275
|
-
export
|
|
276
|
-
export
|
|
275
|
+
export type CartMachineAction = StateMachine.ActionFunction<CartMachineContext, CartMachineEvent>;
|
|
276
|
+
export type CartMachineActions = {
|
|
277
277
|
cartFetchAction: CartMachineAction;
|
|
278
278
|
cartCreateAction: CartMachineAction;
|
|
279
279
|
cartLineRemoveAction: CartMachineAction;
|
|
@@ -7,8 +7,8 @@ export declare const IMG_SRC_SET_SIZES: number[];
|
|
|
7
7
|
*/
|
|
8
8
|
export declare function addImageSizeParametersToUrl({ src, width, height, crop, scale, }: ShopifyLoaderParams): string;
|
|
9
9
|
export declare function shopifyImageLoader(params: ShopifyLoaderParams): string;
|
|
10
|
-
|
|
11
|
-
export
|
|
10
|
+
type HtmlImageProps = React.ImgHTMLAttributes<HTMLImageElement>;
|
|
11
|
+
export type GetShopifyImageDimensionsProps = {
|
|
12
12
|
data: Pick<PartialDeep<ImageType, {
|
|
13
13
|
recurseIntoArrays: true;
|
|
14
14
|
}>, 'altText' | 'url' | 'id' | 'width' | 'height'>;
|
|
@@ -18,7 +18,7 @@ export declare type GetShopifyImageDimensionsProps = {
|
|
|
18
18
|
height?: HtmlImageProps['height'];
|
|
19
19
|
};
|
|
20
20
|
};
|
|
21
|
-
|
|
21
|
+
type GetShopifyImageDimensionsPropsReturn = {
|
|
22
22
|
width: number | string | null;
|
|
23
23
|
height: number | string | null;
|
|
24
24
|
};
|
|
@@ -2,10 +2,10 @@ export declare function loadScript(src: string, options?: {
|
|
|
2
2
|
module?: boolean;
|
|
3
3
|
in?: 'head' | 'body';
|
|
4
4
|
}): Promise<boolean>;
|
|
5
|
-
|
|
5
|
+
type LoadScriptParams = Parameters<typeof loadScript>;
|
|
6
6
|
/**
|
|
7
7
|
* The `useLoadScript` hook loads an external script tag in the browser. It allows React components to lazy-load large third-party dependencies.
|
|
8
8
|
*/
|
|
9
9
|
export declare function useLoadScript(url: LoadScriptParams[0], options?: LoadScriptParams[1]): ScriptState;
|
|
10
|
-
|
|
10
|
+
type ScriptState = 'loading' | 'done' | 'error';
|
|
11
11
|
export {};
|
|
@@ -16,7 +16,7 @@ export declare function metafieldParser<ReturnGeneric>(metafield: PartialDeep<Me
|
|
|
16
16
|
}>): ReturnGeneric;
|
|
17
17
|
export declare const allMetafieldTypesArray: readonly ["boolean", "collection_reference", "color", "date", "date_time", "dimension", "file_reference", "json", "money", "multi_line_text_field", "number_decimal", "number_integer", "page_reference", "product_reference", "rating", "single_line_text_field", "url", "variant_reference", "volume", "weight", "list.collection_reference", "list.color", "list.date", "list.date_time", "list.dimension", "list.file_reference", "list.number_integer", "list.number_decimal", "list.page_reference", "list.product_reference", "list.rating", "list.single_line_text_field", "list.url", "list.variant_reference", "list.volume", "list.weight"];
|
|
18
18
|
/** A union of all the supported `metafield.type`s */
|
|
19
|
-
export
|
|
19
|
+
export type MetafieldTypeTypes = typeof allMetafieldTypesArray[number];
|
|
20
20
|
/**
|
|
21
21
|
* A mapping of a Metafield's `type` to the TypeScript type that is returned from `metafieldParser()`
|
|
22
22
|
* For example, when using `metafieldParser()`, the type will be correctly returned when used like the following:
|
|
@@ -26,7 +26,7 @@ export declare type MetafieldTypeTypes = typeof allMetafieldTypesArray[number];
|
|
|
26
26
|
* ```
|
|
27
27
|
* `parsedMetafield.parsedValue`'s type is now `boolean`
|
|
28
28
|
*/
|
|
29
|
-
export
|
|
29
|
+
export type ParsedMetafields<ExtraTypeGeneric = void> = {
|
|
30
30
|
/** A Metafield that's been parsed, with a `parsedValue` of `boolean` */
|
|
31
31
|
boolean: Simplify<BooleanParsedMetafield>;
|
|
32
32
|
/** A Metafield that's been parsed, with a `parsedValue` of a `Collection` object (as defined by the Storefront API) */
|
|
@@ -114,103 +114,103 @@ interface BooleanParsedMetafield extends ParsedBase {
|
|
|
114
114
|
type: 'boolean';
|
|
115
115
|
parsedValue: boolean | null;
|
|
116
116
|
}
|
|
117
|
-
|
|
117
|
+
type CollectionParsedRefMetafield = MetafieldBaseType & {
|
|
118
118
|
type: 'collection_reference';
|
|
119
119
|
parsedValue: Collection | null;
|
|
120
120
|
};
|
|
121
|
-
|
|
121
|
+
type ColorParsedMetafield = MetafieldBaseType & {
|
|
122
122
|
type: 'color';
|
|
123
123
|
parsedValue: string | null;
|
|
124
124
|
};
|
|
125
|
-
|
|
125
|
+
type DatesParsedMetafield = MetafieldBaseType & {
|
|
126
126
|
type: 'date' | 'date_time';
|
|
127
127
|
parsedValue: Date | null;
|
|
128
128
|
};
|
|
129
|
-
|
|
129
|
+
type MeasurementParsedMetafield = MetafieldBaseType & {
|
|
130
130
|
type: 'dimension' | 'weight' | 'volume';
|
|
131
131
|
parsedValue: Measurement | null;
|
|
132
132
|
};
|
|
133
|
-
|
|
133
|
+
type FileRefParsedMetafield = MetafieldBaseType & {
|
|
134
134
|
type: 'file_reference';
|
|
135
135
|
parsedValue: GenericFile | null;
|
|
136
136
|
};
|
|
137
|
-
|
|
137
|
+
type JsonParsedMetafield<JsonTypeGeneric = void> = MetafieldBaseType & {
|
|
138
138
|
type: 'json';
|
|
139
139
|
parsedValue: JsonTypeGeneric extends void ? unknown : JsonTypeGeneric | null;
|
|
140
140
|
};
|
|
141
|
-
|
|
141
|
+
type MoneyParsedMetafield = MetafieldBaseType & {
|
|
142
142
|
type: 'money';
|
|
143
143
|
parsedValue: MoneyV2 | null;
|
|
144
144
|
};
|
|
145
|
-
|
|
145
|
+
type TextParsedMetafield = MetafieldBaseType & {
|
|
146
146
|
type: 'single_line_text_field' | 'multi_line_text_field' | 'url';
|
|
147
147
|
parsedValue: string | null;
|
|
148
148
|
};
|
|
149
|
-
|
|
149
|
+
type NumberParsedMetafield = MetafieldBaseType & {
|
|
150
150
|
type: 'number_decimal' | 'number_integer';
|
|
151
151
|
parsedValue: number | null;
|
|
152
152
|
};
|
|
153
|
-
|
|
153
|
+
type PageParsedRefMetafield = MetafieldBaseType & {
|
|
154
154
|
type: 'page_reference';
|
|
155
155
|
parsedValue: Page | null;
|
|
156
156
|
};
|
|
157
|
-
|
|
157
|
+
type ProductParsedRefMetafield = MetafieldBaseType & {
|
|
158
158
|
type: 'product_reference';
|
|
159
159
|
parsedValue: Product | null;
|
|
160
160
|
};
|
|
161
|
-
|
|
161
|
+
type RatingParsedMetafield = MetafieldBaseType & {
|
|
162
162
|
type: 'rating';
|
|
163
163
|
parsedValue: Rating | null;
|
|
164
164
|
};
|
|
165
|
-
|
|
165
|
+
type VariantParsedRefMetafield = MetafieldBaseType & {
|
|
166
166
|
type: 'variant_reference';
|
|
167
167
|
parsedValue: ProductVariant | null;
|
|
168
168
|
};
|
|
169
|
-
|
|
169
|
+
type CollectionListParsedRefMetafield = MetafieldBaseType & {
|
|
170
170
|
type: 'list.collection_reference';
|
|
171
171
|
parsedValue: Array<Collection> | null;
|
|
172
172
|
};
|
|
173
|
-
|
|
173
|
+
type ColorListParsedMetafield = MetafieldBaseType & {
|
|
174
174
|
type: 'list.color';
|
|
175
175
|
parsedValue: Array<string> | null;
|
|
176
176
|
};
|
|
177
|
-
|
|
177
|
+
type DatesListParsedMetafield = MetafieldBaseType & {
|
|
178
178
|
type: 'list.date' | 'list.date_time';
|
|
179
179
|
parsedValue: Array<Date> | null;
|
|
180
180
|
};
|
|
181
|
-
|
|
181
|
+
type MeasurementListParsedMetafield = MetafieldBaseType & {
|
|
182
182
|
type: 'list.dimension' | 'list.weight' | 'list.volume';
|
|
183
183
|
parsedValue: Array<Measurement> | null;
|
|
184
184
|
};
|
|
185
|
-
|
|
185
|
+
type FileListParsedRefMetafield = MetafieldBaseType & {
|
|
186
186
|
type: 'list.file_reference';
|
|
187
187
|
parsedValue: Array<GenericFile> | null;
|
|
188
188
|
};
|
|
189
|
-
|
|
189
|
+
type TextListParsedMetafield = MetafieldBaseType & {
|
|
190
190
|
type: 'list.single_line_text_field' | 'list.url';
|
|
191
191
|
parsedValue: Array<string> | null;
|
|
192
192
|
};
|
|
193
|
-
|
|
193
|
+
type NumberListParsedMetafield = MetafieldBaseType & {
|
|
194
194
|
type: 'list.number_decimal' | 'list.number_integer';
|
|
195
195
|
parsedValue: Array<number> | null;
|
|
196
196
|
};
|
|
197
|
-
|
|
197
|
+
type PageListParsedRefMetafield = MetafieldBaseType & {
|
|
198
198
|
type: 'list.page_reference';
|
|
199
199
|
parsedValue: Array<Page> | null;
|
|
200
200
|
};
|
|
201
|
-
|
|
201
|
+
type ProductListParsedRefMetafield = MetafieldBaseType & {
|
|
202
202
|
type: 'list.product_reference';
|
|
203
203
|
parsedValue: Array<Product> | null;
|
|
204
204
|
};
|
|
205
|
-
|
|
205
|
+
type RatingListParsedMetafield = MetafieldBaseType & {
|
|
206
206
|
type: 'list.rating';
|
|
207
207
|
parsedValue: Array<Rating> | null;
|
|
208
208
|
};
|
|
209
|
-
|
|
209
|
+
type VariantListParsedRefMetafield = MetafieldBaseType & {
|
|
210
210
|
type: 'list.variant_reference';
|
|
211
211
|
parsedValue: Array<ProductVariant> | null;
|
|
212
212
|
};
|
|
213
|
-
export
|
|
213
|
+
export type Measurement = {
|
|
214
214
|
unit: string;
|
|
215
215
|
value: number;
|
|
216
216
|
};
|
|
@@ -4,7 +4,7 @@ import type { PartialDeep } from 'type-fest';
|
|
|
4
4
|
* Provides more information about the error(s) including properties and metadata.
|
|
5
5
|
* Refer to https://shopify.dev/api/storefront#status_and_error_codes for more information.
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
type StorefrontApiExtensions = {
|
|
8
8
|
/**
|
|
9
9
|
* Shows error codes common to Shopify. Additional error codes may also be shown.
|
|
10
10
|
* https://shopify.dev/api/storefront#status_and_error_codes
|
|
@@ -18,7 +18,7 @@ declare type StorefrontApiExtensions = {
|
|
|
18
18
|
*
|
|
19
19
|
* Refer to https://shopify.dev/api/storefront#status_and_error_codes for more information.
|
|
20
20
|
*/
|
|
21
|
-
export
|
|
21
|
+
export type StorefrontApiResponseOk<DataGeneric> = FormattedExecutionResult<DataGeneric, StorefrontApiExtensions>;
|
|
22
22
|
/**
|
|
23
23
|
* The Storefront API can return a 200 OK response code when the query succeeds, and will populate the `data` property. The generic you pass in through type parameters will be the shape of the `data` object, with `Partial` deeply-applied to all nested objects and properties, if successful. If you prefer not using this "deeply-partial" generic data object, consider using `StorefrontApiResponseOk` instead.
|
|
24
24
|
*
|
|
@@ -26,7 +26,7 @@ export declare type StorefrontApiResponseOk<DataGeneric> = FormattedExecutionRes
|
|
|
26
26
|
*
|
|
27
27
|
* Refer to https://shopify.dev/api/storefront#status_and_error_codes for more information.
|
|
28
28
|
*/
|
|
29
|
-
export
|
|
29
|
+
export type StorefrontApiResponseOkPartial<DataGeneric> = FormattedExecutionResult<PartialDeep<DataGeneric, {
|
|
30
30
|
recurseIntoArrays: true;
|
|
31
31
|
}>, StorefrontApiExtensions>;
|
|
32
32
|
/**
|
|
@@ -38,7 +38,7 @@ export declare type StorefrontApiResponseOkPartial<DataGeneric> = FormattedExecu
|
|
|
38
38
|
*
|
|
39
39
|
* Refer to https://shopify.dev/api/storefront#status_and_error_codes for more information.
|
|
40
40
|
*/
|
|
41
|
-
export
|
|
41
|
+
export type StorefrontApiResponseError = string | {
|
|
42
42
|
errors: {
|
|
43
43
|
query: string;
|
|
44
44
|
};
|
|
@@ -54,7 +54,7 @@ export declare type StorefrontApiResponseError = string | {
|
|
|
54
54
|
*
|
|
55
55
|
* Refer to https://shopify.dev/api/storefront#status_and_error_codes for more information.
|
|
56
56
|
*/
|
|
57
|
-
export
|
|
57
|
+
export type StorefrontApiResponse<DataGeneric> = StorefrontApiResponseOk<DataGeneric> | StorefrontApiResponseError;
|
|
58
58
|
/**
|
|
59
59
|
* The Storefront API can return a 200 OK response code when the query succeeds, and will populate the `data` property. The generic you pass in through type parameters will be the shape of the `data` object, with `Partial` deeply-applied to all nested objects and properties, if successful. If you prefer not using this "deeply-partial" generic data object, consider using `StorefrontApiResponseOk` instead.
|
|
60
60
|
*
|
|
@@ -64,5 +64,5 @@ export declare type StorefrontApiResponse<DataGeneric> = StorefrontApiResponseOk
|
|
|
64
64
|
*
|
|
65
65
|
* Refer to https://shopify.dev/api/storefront#status_and_error_codes for more information.
|
|
66
66
|
*/
|
|
67
|
-
export
|
|
67
|
+
export type StorefrontApiResponsePartial<DataGeneric> = StorefrontApiResponseOkPartial<DataGeneric> | StorefrontApiResponseError;
|
|
68
68
|
export {};
|
|
@@ -11,7 +11,7 @@ export declare function getPublicTokenHeadersRaw(contentType: 'graphql' | 'json'
|
|
|
11
11
|
'X-SDK-Version': string;
|
|
12
12
|
'X-Shopify-Storefront-Access-Token': string;
|
|
13
13
|
};
|
|
14
|
-
|
|
14
|
+
type StorefrontClientProps = {
|
|
15
15
|
/** The host name of the domain (eg: `{shop}.myshopify.com`). */
|
|
16
16
|
storeDomain: string;
|
|
17
17
|
/** The Storefront API delegate access token. Refer to the [authentication](https://shopify.dev/api/storefront#authentication) and [delegate access token](https://shopify.dev/apps/auth/oauth/delegate-access-tokens) documentation for more details. */
|
|
@@ -27,8 +27,8 @@ declare type StorefrontClientProps = {
|
|
|
27
27
|
*/
|
|
28
28
|
contentType?: 'json' | 'graphql';
|
|
29
29
|
};
|
|
30
|
-
|
|
31
|
-
|
|
30
|
+
type OverrideTokenHeaderProps = Partial<Pick<StorefrontClientProps, 'contentType'>>;
|
|
31
|
+
type StorefrontClientReturn = {
|
|
32
32
|
/**
|
|
33
33
|
* Creates the fully-qualified URL to your myshopify.com domain.
|
|
34
34
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AttributeInput, CartBuyerIdentityInput, CartInput, CartLineInput, CartLineUpdateInput, CountryCode, Cart as CartType, MutationCartDiscountCodesUpdateArgs, MutationCartNoteUpdateArgs } from './storefront-api-types.js';
|
|
2
2
|
import { PartialDeep } from 'type-fest';
|
|
3
|
-
|
|
3
|
+
type CartResponse = PartialDeep<CartType, {
|
|
4
4
|
recurseIntoArrays: true;
|
|
5
5
|
}>;
|
|
6
6
|
/**
|
package/dist/types/useMoney.d.ts
CHANGED