@deenruv/react-ui-devkit 1.0.16 → 1.0.17-dev.15

package/dist/components/templates/DetailView/useDetailView.d.ts

@@ -3,10 +3,10 @@ import { ModelTypes } from "@deenruv/admin-types";
 import { type DetailKeys, type ExternalDetailLocationSelector } from "../../../types";
 import type { PropsType, StoreContextType } from "./types";
 export declare const DetailViewStoreContext: React.Context<StoreContextType<"orders-summary" | "countries-detail-view" | "admins-detail-view" | "channels-detail-view" | "collections-detail-view" | "customers-detail-view" | "facets-detail-view" | "orders-detail-view" | "products-detail-view" | "promotions-detail-view" | "roles-detail-view" | "sellers-detail-view" | "zones-detail-view" | "globalSettings-detail-view" | "customerGroups-detail-view" | "paymentMethods-detail-view" | "shippingMethods-detail-view" | "stockLocations-detail-view" | "taxCategories-detail-view" | "taxRates-detail-view", {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     code: string;
     channels: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         code: string;
     }[];
     createdAt: string;
@@ -14,7 +14,7 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     description: string;
     permissions: import("@deenruv/admin-types").Permission[];
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     firstName: string;
@@ -22,10 +22,10 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     emailAddress: string;
     user: {
         roles: {
-            id: string;
+            id: import("@deenruv/admin-types").GraphQLTypes["ID"];
             code: string;
             channels: {
-                id: string;
+                id: import("@deenruv/admin-types").GraphQLTypes["ID"];
                 code: string;
             }[];
             createdAt: string;
@@ -35,37 +35,37 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         }[];
     };
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     code: string;
     createdAt: string;
     updatedAt: string;
     token: string;
     defaultTaxZone?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
     } | undefined;
     defaultShippingZone?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
     } | undefined;
-    defaultLanguageCode: import("@deenruv/admin-types").LanguageCode;
+    defaultLanguageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
     availableLanguageCodes?: import("@deenruv/admin-types").LanguageCode[] | null | undefined;
-    defaultCurrencyCode: import("@deenruv/admin-types").CurrencyCode;
+    defaultCurrencyCode: import("@deenruv/admin-types").GraphQLTypes["CurrencyCode"];
     availableCurrencyCodes: import("@deenruv/admin-types").CurrencyCode[];
     pricesIncludeTax: boolean;
     seller?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
     } | undefined;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     name: string;
     members: (({
         [x: string]: unknown;
     } & {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         code: string;
         createdAt: string;
         updatedAt: string;
@@ -74,7 +74,7 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     }) | ({
         [x: string]: unknown;
     } & {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         code: string;
         createdAt: string;
         updatedAt: string;
@@ -82,14 +82,14 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         enabled: boolean;
     }))[];
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     assets: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         source: string;
         preview: string;
     }[];
     channels: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         code: string;
     }[];
     collections: {
@@ -105,51 +105,51 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     slug: string;
     description: string;
     featuredAsset?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         source: string;
         preview: string;
     } | undefined;
     translations: {
-        id: string;
-        languageCode: import("@deenruv/admin-types").LanguageCode;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+        languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
         name: string;
         slug: string;
         description: string;
     }[];
     enabled: boolean;
     optionGroups: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         code: string;
         name: string;
     }[];
     facetValues: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
         translations: {
-            id: string;
-            languageCode: import("@deenruv/admin-types").LanguageCode;
+            id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+            languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
             name: string;
         }[];
         facet: {
-            id: string;
+            id: import("@deenruv/admin-types").GraphQLTypes["ID"];
             name: string;
             translations: {
-                id: string;
-                languageCode: import("@deenruv/admin-types").LanguageCode;
+                id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+                languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
                 name: string;
             }[];
         };
     }[];
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     trackInventory: boolean;
     outOfStockThreshold: number;
     availableLanguages: import("@deenruv/admin-types").LanguageCode[];
 } | {
-    id: string;
-    title?: string | null | undefined;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+    title?: string | undefined | null | undefined;
     createdAt: string;
     updatedAt: string;
     firstName: string;
@@ -159,43 +159,43 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         verified: boolean;
     } | undefined;
     groups: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
     }[];
-    phoneNumber?: string | null | undefined;
+    phoneNumber?: string | undefined | null | undefined;
     addresses?: {
-        id: string;
-        phoneNumber?: string | null | undefined;
-        fullName?: string | null | undefined;
-        company?: string | null | undefined;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+        phoneNumber?: string | undefined | null | undefined;
+        fullName?: string | undefined | null | undefined;
+        company?: string | undefined | null | undefined;
         streetLine1: string;
-        streetLine2?: string | null | undefined;
-        city?: string | null | undefined;
-        province?: string | null | undefined;
-        postalCode?: string | null | undefined;
+        streetLine2?: string | undefined | null | undefined;
+        city?: string | undefined | null | undefined;
+        province?: string | undefined | null | undefined;
+        postalCode?: string | undefined | null | undefined;
         country: {
             code: string;
         };
-        defaultShippingAddress?: boolean | null | undefined;
-        defaultBillingAddress?: boolean | null | undefined;
+        defaultShippingAddress?: boolean | undefined | null | undefined;
+        defaultBillingAddress?: boolean | undefined | null | undefined;
     }[] | undefined;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     name: string;
     description: string;
     translations: {
-        languageCode: import("@deenruv/admin-types").LanguageCode;
+        languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
         name: string;
         description: string;
     }[];
     enabled: boolean;
     startsAt?: string | null | undefined;
     endsAt?: string | null | undefined;
-    couponCode?: string | null | undefined;
-    perCustomerUsageLimit?: number | null | undefined;
-    usageLimit?: number | null | undefined;
+    couponCode?: string | undefined | null | undefined;
+    perCustomerUsageLimit?: number | undefined | null | undefined;
+    usageLimit?: number | undefined | null | undefined;
     conditions: {
         code: string;
         args: {
@@ -211,26 +211,26 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         }[];
     }[];
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     name: string;
     description: string;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     name: string;
     isDefault: boolean;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     name: string;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     children?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
         slug: string;
         featuredAsset?: {
@@ -238,7 +238,7 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         } | undefined;
     }[] | undefined;
     assets: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     }[];
     isPrivate: boolean;
     inheritFilters: boolean;
@@ -246,9 +246,13 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     updatedAt: string;
     name: string;
     slug: string;
+    breadcrumbs: {
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+        slug: string;
+    }[];
     description: string;
     featuredAsset?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         preview: string;
     } | undefined;
     parent?: {
@@ -263,21 +267,21 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         }[];
     }[];
     translations: {
-        id: string;
-        languageCode: import("@deenruv/admin-types").LanguageCode;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+        languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
         name: string;
         slug: string;
         description: string;
     }[];
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     code: string;
     createdAt: string;
     updatedAt: string;
     name: string;
     description: string;
     translations: {
-        languageCode: import("@deenruv/admin-types").LanguageCode;
+        languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
         name: string;
         description: string;
     }[];
@@ -297,13 +301,13 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         }[];
     };
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     code: string;
     createdAt: string;
     updatedAt: string;
     name: string;
     translations: {
-        languageCode: import("@deenruv/admin-types").LanguageCode;
+        languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
         name: string;
         description: string;
     }[];
@@ -323,9 +327,9 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         }[];
     };
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     values: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         code: string;
         createdAt: string;
         updatedAt: string;
@@ -335,136 +339,136 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     isPrivate: boolean;
     createdAt: string;
     updatedAt: string;
-    languageCode: import("@deenruv/admin-types").LanguageCode;
+    languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
     name: string;
     translations: {
-        languageCode: import("@deenruv/admin-types").LanguageCode;
+        languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
         name: string;
     }[];
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     code: string;
     createdAt: string;
     updatedAt: string;
     name: string;
     translations: {
-        languageCode: import("@deenruv/admin-types").LanguageCode;
+        languageCode: import("@deenruv/admin-types").GraphQLTypes["LanguageCode"];
         name: string;
     }[];
     enabled: boolean;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     name: string;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     createdAt: string;
     updatedAt: string;
     name: string;
     value: number;
     enabled: boolean;
     category: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
     };
     zone: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
     };
     customerGroup?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
     } | undefined;
 } | {
-    id: string;
+    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
     code: string;
     promotions: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         name: string;
-        couponCode?: string | null | undefined;
+        couponCode?: string | undefined | null | undefined;
     }[];
     createdAt: string;
     updatedAt: string;
-    currencyCode: import("@deenruv/admin-types").CurrencyCode;
+    currencyCode: import("@deenruv/admin-types").GraphQLTypes["CurrencyCode"];
     nextStates: string[];
     modifications: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         note: string;
     }[];
     state: string;
     customer?: {
-        id: string;
-        title?: string | null | undefined;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+        title?: string | undefined | null | undefined;
         firstName: string;
         lastName: string;
         emailAddress: string;
-        phoneNumber?: string | null | undefined;
+        phoneNumber?: string | undefined | null | undefined;
         addresses?: {
-            id: string;
-            phoneNumber?: string | null | undefined;
-            fullName?: string | null | undefined;
-            company?: string | null | undefined;
+            id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+            phoneNumber?: string | undefined | null | undefined;
+            fullName?: string | undefined | null | undefined;
+            company?: string | undefined | null | undefined;
             streetLine1: string;
-            streetLine2?: string | null | undefined;
-            city?: string | null | undefined;
-            province?: string | null | undefined;
-            postalCode?: string | null | undefined;
+            streetLine2?: string | undefined | null | undefined;
+            city?: string | undefined | null | undefined;
+            province?: string | undefined | null | undefined;
+            postalCode?: string | undefined | null | undefined;
             country: {
                 code: string;
                 name: string;
             };
-            defaultShippingAddress?: boolean | null | undefined;
-            defaultBillingAddress?: boolean | null | undefined;
+            defaultShippingAddress?: boolean | undefined | null | undefined;
+            defaultBillingAddress?: boolean | undefined | null | undefined;
         }[] | undefined;
     } | undefined;
     shippingAddress?: {
-        phoneNumber?: string | null | undefined;
-        fullName?: string | null | undefined;
-        company?: string | null | undefined;
-        streetLine1?: string | null | undefined;
-        streetLine2?: string | null | undefined;
-        city?: string | null | undefined;
-        province?: string | null | undefined;
-        postalCode?: string | null | undefined;
-        country?: string | null | undefined;
-        countryCode?: string | null | undefined;
+        phoneNumber?: string | undefined | null | undefined;
+        fullName?: string | undefined | null | undefined;
+        company?: string | undefined | null | undefined;
+        streetLine1?: string | undefined | null | undefined;
+        streetLine2?: string | undefined | null | undefined;
+        city?: string | undefined | null | undefined;
+        province?: string | undefined | null | undefined;
+        postalCode?: string | undefined | null | undefined;
+        country?: string | undefined | null | undefined;
+        countryCode?: string | undefined | null | undefined;
     } | undefined;
     billingAddress?: {
-        phoneNumber?: string | null | undefined;
-        fullName?: string | null | undefined;
-        company?: string | null | undefined;
-        streetLine1?: string | null | undefined;
-        streetLine2?: string | null | undefined;
-        city?: string | null | undefined;
-        province?: string | null | undefined;
-        postalCode?: string | null | undefined;
-        country?: string | null | undefined;
-        countryCode?: string | null | undefined;
+        phoneNumber?: string | undefined | null | undefined;
+        fullName?: string | undefined | null | undefined;
+        company?: string | undefined | null | undefined;
+        streetLine1?: string | undefined | null | undefined;
+        streetLine2?: string | undefined | null | undefined;
+        city?: string | undefined | null | undefined;
+        province?: string | undefined | null | undefined;
+        postalCode?: string | undefined | null | undefined;
+        country?: string | undefined | null | undefined;
+        countryCode?: string | undefined | null | undefined;
     } | undefined;
     lines: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         productVariant: {
-            id: string;
-            name: string;
-            featuredAsset?: {
-                id: string;
-                preview: string;
-            } | undefined;
-            currencyCode: import("@deenruv/admin-types").CurrencyCode;
-            stockLevels: {
-                stockOnHand: number;
-            }[];
             product: {
-                id: string;
+                id: import("@deenruv/admin-types").GraphQLTypes["ID"];
                 name: string;
                 slug: string;
                 featuredAsset?: {
-                    id: string;
+                    id: import("@deenruv/admin-types").GraphQLTypes["ID"];
                     preview: string;
                 } | undefined;
             };
-            productId: string;
+            id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+            name: string;
+            featuredAsset?: {
+                id: import("@deenruv/admin-types").GraphQLTypes["ID"];
+                preview: string;
+            } | undefined;
+            currencyCode: import("@deenruv/admin-types").GraphQLTypes["CurrencyCode"];
+            stockLevels: {
+                stockOnHand: number;
+            }[];
+            productId: import("@deenruv/admin-types").GraphQLTypes["ID"];
             sku: string;
             price: number;
             priceWithTax: number;
@@ -483,14 +487,14 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     surcharges: {
         createdAt: string;
         description: string;
-        sku?: string | null | undefined;
+        sku?: string | undefined | null | undefined;
         price: number;
         priceWithTax: number;
         taxRate: number;
     }[];
     discounts: {
         description: string;
-        type: import("@deenruv/admin-types").AdjustmentType;
+        type: import("@deenruv/admin-types").GraphQLTypes["AdjustmentType"];
         amount: number;
         adjustmentSource: string;
         amountWithTax: number;
@@ -498,31 +502,31 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
     couponCodes: string[];
     excludedPromotionIds?: string[] | null | undefined;
     payments?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         metadata?: any;
         createdAt: string;
         state: string;
         method: string;
         amount: number;
-        transactionId?: string | null | undefined;
-        errorMessage?: string | null | undefined;
+        transactionId?: string | undefined | null | undefined;
+        errorMessage?: string | undefined | null | undefined;
         refunds: {
-            id: string;
+            id: import("@deenruv/admin-types").GraphQLTypes["ID"];
             state: string;
             lines: {
                 quantity: number;
-                orderLineId: string;
+                orderLineId: import("@deenruv/admin-types").GraphQLTypes["ID"];
             }[];
             total: number;
-            transactionId?: string | null | undefined;
+            transactionId?: string | undefined | null | undefined;
         }[];
     }[] | undefined;
     fulfillments?: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         summary: {
             quantity: number;
-            orderLineId: string;
-            fulfillmentId: string;
+            orderLineId: import("@deenruv/admin-types").GraphQLTypes["ID"];
+            fulfillmentId: import("@deenruv/admin-types").GraphQLTypes["ID"];
         }[];
         createdAt: string;
         updatedAt: string;
@@ -530,20 +534,20 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         state: string;
         lines: {
             quantity: number;
-            orderLineId: string;
+            orderLineId: import("@deenruv/admin-types").GraphQLTypes["ID"];
         }[];
         method: string;
-        trackingCode?: string | null | undefined;
+        trackingCode?: string | undefined | null | undefined;
     }[] | undefined;
     subTotalWithTax: number;
     shippingLines: {
-        id: string;
+        id: import("@deenruv/admin-types").GraphQLTypes["ID"];
         price: number;
         priceWithTax: number;
         discountedPrice: number;
         discountedPriceWithTax: number;
         shippingMethod: {
-            id: string;
+            id: import("@deenruv/admin-types").GraphQLTypes["ID"];
             code: string;
             name: string;
             fulfillmentHandlerCode: string;
@@ -559,7 +563,7 @@ export declare const DetailViewStoreContext: React.Context<StoreContextType<"ord
         taxTotal: number;
     }[];
 }, keyof ModelTypes, string | number | symbol>>;
-export declare const DetailViewStoreProvider: <T extends "orders-summary" | "countries-detail-view" | "admins-detail-view" | "channels-detail-view" | "collections-detail-view" | "customers-detail-view" | "facets-detail-view" | "orders-detail-view" | "products-detail-view" | "promotions-detail-view" | "roles-detail-view" | "sellers-detail-view" | "zones-detail-view" | "globalSettings-detail-view" | "customerGroups-detail-view" | "paymentMethods-detail-view" | "shippingMethods-detail-view" | "stockLocations-detail-view" | "taxCategories-detail-view" | "taxRates-detail-view", F extends keyof ModelTypes, FK extends keyof ModelTypes[F]>({ children, ...props }: React.PropsWithChildren<PropsType<T, F, FK>>) => React.JSX.Element;
+export declare const DetailViewStoreProvider: <T extends DetailKeys, F extends keyof ModelTypes, FK extends keyof ModelTypes[F]>({ children, ...props }: React.PropsWithChildren<PropsType<T, F, FK>>) => React.JSX.Element;
 export declare function useDetailView<T extends DetailKeys, E extends ExternalDetailLocationSelector[T], F extends keyof ModelTypes, FK extends keyof ModelTypes[F]>(_type?: T, _key?: F, ..._pick: FK[]): StoreContextType<T, E, F, FK>;
 /**
  * Like `useDetailView`, but returns `null` when there is no