@anker-in/shopify-react 1.3.0-beta.13 → 1.3.0-beta.15

package/dist/hooks/index.d.mts

@@ -1,7 +1,7 @@
 import * as swr_mutation from 'swr/mutation';
 import { SWRMutationConfiguration } from 'swr/mutation';
 import * as _anker_in_shopify_sdk from '@anker-in/shopify-sdk';
-import { CartLineInput, BuyerIdentityInput, NormalizedCart, NormalizedProduct, NormalizedProductVariant, NormalizedLineItem, UpdateCartLinesOptions, HasMetafieldsIdentifier, Media, NormalizedCollection, CollectionsConnection, NormalizedBlog, NormalizedArticle, NormalizedShop, NormalizedAttribute } from '@anker-in/shopify-sdk';
+import { CartLineInput, BuyerIdentityInput, NormalizedCart, NormalizedProduct, NormalizedProductVariant, NormalizedLineItem, UpdateCartLinesOptions, HasMetafieldsIdentifier, MetafieldIdentifier, Media, NormalizedCollection, CollectionsConnection, NormalizedBlog, NormalizedArticle, NormalizedShop, NormalizedAttribute } from '@anker-in/shopify-sdk';
 import { h as UseAddToCartOptions, g as AddToCartInput, A as AddToCartLineItem, G as GtmParams, C as BuyNowTrackConfig, e as UseScriptAutoFreeGiftResult, m as PlusMemberShippingMethodConfig, n as PlusMemberSettingsMetafields, D as DeliveryPlusType, o as SelectedPlusMemberVariant } from '../types-C0UyuPrG.mjs';
 export { p as DeliveryCustomData, P as PLUS_MEMBER_TYPE, j as PlusMemberMode, l as PlusMemberShippingMethodMetafields, S as ScriptAutoFreeGiftConfig, k as ShippingMethodMode, U as UseAutoRemoveFreeGiftsOptions, a as UseAutoRemoveFreeGiftsResult, d as isAnyGift, c as isBuyGetGift, i as isFunctionGift, b as isScriptGift, u as useAutoRemoveFreeGifts, f as useScriptAutoFreeGift } from '../types-C0UyuPrG.mjs';
 import * as swr from 'swr';
@@ -841,10 +841,10 @@ declare const formatFunctionAutoFreeGift: ({ qualifyingGift, giftProductsResult,
 
 interface UseProductOptions extends SWRConfiguration<NormalizedProduct | undefined> {
     handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 /**
  * Hook to fetch a single product by handle
@@ -880,10 +880,10 @@ interface UseAllProductsOptions extends SWRConfiguration<NormalizedProduct[]> {
     query?: string;
     sortKey?: 'TITLE' | 'PRODUCT_TYPE' | 'VENDOR' | 'UPDATED_AT' | 'CREATED_AT' | 'BEST_SELLING' | 'PRICE' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 /**
  * Hook to fetch all products
@@ -923,8 +923,8 @@ declare function useAllProducts(options?: UseAllProductsOptions): swr.SWRRespons
 interface UseProductsByHandlesOptions extends SWRConfiguration<(NormalizedProduct | undefined)[]> {
     handles?: string[];
     metafieldIdentifiers?: {
-        product: HasMetafieldsIdentifier[];
-        variant: HasMetafieldsIdentifier[];
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
     };
 }
 /**
@@ -1236,10 +1236,11 @@ declare function useVariantMedia({ product, variant, }: {
 
 interface UseCollectionOptions extends SWRConfiguration<NormalizedCollection | undefined> {
     handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        collection?: MetafieldIdentifier[];
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 declare function useCollection(options?: UseCollectionOptions): swr.SWRResponse<NormalizedCollection | undefined, any, SWRConfiguration<NormalizedCollection | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection | undefined>)> | undefined>;
 
@@ -1248,10 +1249,11 @@ interface UseAllCollectionsOptions extends SWRConfiguration<NormalizedCollection
     query?: string;
     sortKey?: 'TITLE' | 'UPDATED_AT' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        collection?: MetafieldIdentifier[];
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 declare function useAllCollections(options?: UseAllCollectionsOptions): swr.SWRResponse<NormalizedCollection[], any, SWRConfiguration<NormalizedCollection[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection[]>)> | undefined>;
 
@@ -1261,39 +1263,40 @@ interface UseCollectionsOptions extends SWRConfiguration<CollectionsConnection>
     query?: string;
     sortKey?: 'TITLE' | 'UPDATED_AT' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        product: MetafieldIdentifier[];
+        variant: MetafieldIdentifier[];
+        collection: MetafieldIdentifier[];
+    };
 }
 declare function useCollections(options?: UseCollectionsOptions): swr.SWRResponse<CollectionsConnection, any, SWRConfiguration<CollectionsConnection, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<CollectionsConnection>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<CollectionsConnection>)> | undefined>;
 
 interface UseBlogOptions extends SWRConfiguration<NormalizedBlog | undefined> {
     handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useBlog(options?: UseBlogOptions): swr.SWRResponse<NormalizedBlog | undefined, any, SWRConfiguration<NormalizedBlog | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog | undefined>)> | undefined>;
 
 interface UseAllBlogsOptions extends SWRConfiguration<NormalizedBlog[]> {
     first?: number;
     query?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useAllBlogs(options?: UseAllBlogsOptions): swr.SWRResponse<NormalizedBlog[], any, SWRConfiguration<NormalizedBlog[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog[]>)> | undefined>;
 
 interface UseArticleOptions extends SWRConfiguration<NormalizedArticle | undefined> {
     blogHandle?: string;
     articleHandle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useArticle(options?: UseArticleOptions): swr.SWRResponse<NormalizedArticle | undefined, any, SWRConfiguration<NormalizedArticle | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle | undefined>)> | undefined>;
 
@@ -1302,10 +1305,10 @@ interface UseArticlesOptions extends SWRConfiguration<NormalizedArticle[]> {
     query?: string;
     sortKey?: 'PUBLISHED_AT' | 'UPDATED_AT' | 'TITLE' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useArticles(options?: UseArticlesOptions): swr.SWRResponse<NormalizedArticle[], any, SWRConfiguration<NormalizedArticle[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>)> | undefined>;
 
@@ -1314,10 +1317,10 @@ interface UseArticlesInBlogOptions extends SWRConfiguration<NormalizedArticle[]>
     first?: number;
     sortKey?: 'PUBLISHED_AT' | 'UPDATED_AT' | 'TITLE' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useArticlesInBlog(options?: UseArticlesInBlogOptions): swr.SWRResponse<NormalizedArticle[], any, SWRConfiguration<NormalizedArticle[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>)> | undefined>;
 
@@ -1352,10 +1355,9 @@ declare function useSearch(options?: UseSearchOptions): swr.SWRResponse<SearchRe
 
 type SiteInfo = NormalizedShop;
 interface UseSiteOptions extends SWRConfiguration<SiteInfo | undefined> {
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        shop?: MetafieldIdentifier[];
+    };
 }
 declare function useSite(options?: UseSiteOptions): swr.SWRResponse<NormalizedShop | undefined, any, SWRConfiguration<NormalizedShop | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedShop | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedShop | undefined>)> | undefined>;
 

package/dist/hooks/index.d.ts

@@ -1,7 +1,7 @@
 import * as swr_mutation from 'swr/mutation';
 import { SWRMutationConfiguration } from 'swr/mutation';
 import * as _anker_in_shopify_sdk from '@anker-in/shopify-sdk';
-import { CartLineInput, BuyerIdentityInput, NormalizedCart, NormalizedProduct, NormalizedProductVariant, NormalizedLineItem, UpdateCartLinesOptions, HasMetafieldsIdentifier, Media, NormalizedCollection, CollectionsConnection, NormalizedBlog, NormalizedArticle, NormalizedShop, NormalizedAttribute } from '@anker-in/shopify-sdk';
+import { CartLineInput, BuyerIdentityInput, NormalizedCart, NormalizedProduct, NormalizedProductVariant, NormalizedLineItem, UpdateCartLinesOptions, HasMetafieldsIdentifier, MetafieldIdentifier, Media, NormalizedCollection, CollectionsConnection, NormalizedBlog, NormalizedArticle, NormalizedShop, NormalizedAttribute } from '@anker-in/shopify-sdk';
 import { h as UseAddToCartOptions, g as AddToCartInput, A as AddToCartLineItem, G as GtmParams, C as BuyNowTrackConfig, e as UseScriptAutoFreeGiftResult, m as PlusMemberShippingMethodConfig, n as PlusMemberSettingsMetafields, D as DeliveryPlusType, o as SelectedPlusMemberVariant } from '../types-C0UyuPrG.js';
 export { p as DeliveryCustomData, P as PLUS_MEMBER_TYPE, j as PlusMemberMode, l as PlusMemberShippingMethodMetafields, S as ScriptAutoFreeGiftConfig, k as ShippingMethodMode, U as UseAutoRemoveFreeGiftsOptions, a as UseAutoRemoveFreeGiftsResult, d as isAnyGift, c as isBuyGetGift, i as isFunctionGift, b as isScriptGift, u as useAutoRemoveFreeGifts, f as useScriptAutoFreeGift } from '../types-C0UyuPrG.js';
 import * as swr from 'swr';
@@ -841,10 +841,10 @@ declare const formatFunctionAutoFreeGift: ({ qualifyingGift, giftProductsResult,
 
 interface UseProductOptions extends SWRConfiguration<NormalizedProduct | undefined> {
     handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 /**
  * Hook to fetch a single product by handle
@@ -880,10 +880,10 @@ interface UseAllProductsOptions extends SWRConfiguration<NormalizedProduct[]> {
     query?: string;
     sortKey?: 'TITLE' | 'PRODUCT_TYPE' | 'VENDOR' | 'UPDATED_AT' | 'CREATED_AT' | 'BEST_SELLING' | 'PRICE' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 /**
  * Hook to fetch all products
@@ -923,8 +923,8 @@ declare function useAllProducts(options?: UseAllProductsOptions): swr.SWRRespons
 interface UseProductsByHandlesOptions extends SWRConfiguration<(NormalizedProduct | undefined)[]> {
     handles?: string[];
     metafieldIdentifiers?: {
-        product: HasMetafieldsIdentifier[];
-        variant: HasMetafieldsIdentifier[];
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
     };
 }
 /**
@@ -1236,10 +1236,11 @@ declare function useVariantMedia({ product, variant, }: {
 
 interface UseCollectionOptions extends SWRConfiguration<NormalizedCollection | undefined> {
     handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        collection?: MetafieldIdentifier[];
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 declare function useCollection(options?: UseCollectionOptions): swr.SWRResponse<NormalizedCollection | undefined, any, SWRConfiguration<NormalizedCollection | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection | undefined>)> | undefined>;
 
@@ -1248,10 +1249,11 @@ interface UseAllCollectionsOptions extends SWRConfiguration<NormalizedCollection
     query?: string;
     sortKey?: 'TITLE' | 'UPDATED_AT' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        collection?: MetafieldIdentifier[];
+        product?: MetafieldIdentifier[];
+        variant?: MetafieldIdentifier[];
+    };
 }
 declare function useAllCollections(options?: UseAllCollectionsOptions): swr.SWRResponse<NormalizedCollection[], any, SWRConfiguration<NormalizedCollection[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection[]>)> | undefined>;
 
@@ -1261,39 +1263,40 @@ interface UseCollectionsOptions extends SWRConfiguration<CollectionsConnection>
     query?: string;
     sortKey?: 'TITLE' | 'UPDATED_AT' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        product: MetafieldIdentifier[];
+        variant: MetafieldIdentifier[];
+        collection: MetafieldIdentifier[];
+    };
 }
 declare function useCollections(options?: UseCollectionsOptions): swr.SWRResponse<CollectionsConnection, any, SWRConfiguration<CollectionsConnection, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<CollectionsConnection>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<CollectionsConnection>)> | undefined>;
 
 interface UseBlogOptions extends SWRConfiguration<NormalizedBlog | undefined> {
     handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useBlog(options?: UseBlogOptions): swr.SWRResponse<NormalizedBlog | undefined, any, SWRConfiguration<NormalizedBlog | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog | undefined>)> | undefined>;
 
 interface UseAllBlogsOptions extends SWRConfiguration<NormalizedBlog[]> {
     first?: number;
     query?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useAllBlogs(options?: UseAllBlogsOptions): swr.SWRResponse<NormalizedBlog[], any, SWRConfiguration<NormalizedBlog[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog[]>)> | undefined>;
 
 interface UseArticleOptions extends SWRConfiguration<NormalizedArticle | undefined> {
     blogHandle?: string;
     articleHandle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useArticle(options?: UseArticleOptions): swr.SWRResponse<NormalizedArticle | undefined, any, SWRConfiguration<NormalizedArticle | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle | undefined>)> | undefined>;
 
@@ -1302,10 +1305,10 @@ interface UseArticlesOptions extends SWRConfiguration<NormalizedArticle[]> {
     query?: string;
     sortKey?: 'PUBLISHED_AT' | 'UPDATED_AT' | 'TITLE' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useArticles(options?: UseArticlesOptions): swr.SWRResponse<NormalizedArticle[], any, SWRConfiguration<NormalizedArticle[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>)> | undefined>;
 
@@ -1314,10 +1317,10 @@ interface UseArticlesInBlogOptions extends SWRConfiguration<NormalizedArticle[]>
     first?: number;
     sortKey?: 'PUBLISHED_AT' | 'UPDATED_AT' | 'TITLE' | 'ID' | 'RELEVANCE';
     reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        blog?: MetafieldIdentifier[];
+        article?: MetafieldIdentifier[];
+    };
 }
 declare function useArticlesInBlog(options?: UseArticlesInBlogOptions): swr.SWRResponse<NormalizedArticle[], any, SWRConfiguration<NormalizedArticle[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>)> | undefined>;
 
@@ -1352,10 +1355,9 @@ declare function useSearch(options?: UseSearchOptions): swr.SWRResponse<SearchRe
 
 type SiteInfo = NormalizedShop;
 interface UseSiteOptions extends SWRConfiguration<SiteInfo | undefined> {
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
+    metafieldIdentifiers?: {
+        shop?: MetafieldIdentifier[];
+    };
 }
 declare function useSite(options?: UseSiteOptions): swr.SWRResponse<NormalizedShop | undefined, any, SWRConfiguration<NormalizedShop | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedShop | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedShop | undefined>)> | undefined>;