@deenruv/react-ui-devkit 1.0.0

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

@@ -0,0 +1,563 @@
+import React from "react";
+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;
+    channels: {
+        id: string;
+        code: string;
+    }[];
+    createdAt: string;
+    updatedAt: string;
+    description: string;
+    code: string;
+    permissions: import("@deenruv/admin-types").Permission[];
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    firstName: string;
+    lastName: string;
+    emailAddress: string;
+    user: {
+        roles: {
+            id: string;
+            channels: {
+                id: string;
+                code: string;
+            }[];
+            createdAt: string;
+            updatedAt: string;
+            description: string;
+            code: string;
+            permissions: import("@deenruv/admin-types").Permission[];
+        }[];
+    };
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    code: string;
+    token: string;
+    defaultTaxZone?: {
+        id: string;
+        name: string;
+    } | undefined;
+    defaultShippingZone?: {
+        id: string;
+        name: string;
+    } | undefined;
+    defaultLanguageCode: import("@deenruv/admin-types").LanguageCode;
+    availableLanguageCodes?: import("@deenruv/admin-types").LanguageCode[] | null | undefined;
+    defaultCurrencyCode: import("@deenruv/admin-types").CurrencyCode;
+    availableCurrencyCodes: import("@deenruv/admin-types").CurrencyCode[];
+    pricesIncludeTax: boolean;
+    seller?: {
+        id: string;
+        name: string;
+    } | undefined;
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    members: (({
+        [x: string]: unknown;
+    } & {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        name: string;
+        code: string;
+        enabled: boolean;
+    }) | ({
+        [x: string]: unknown;
+    } & {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        name: string;
+        code: string;
+        enabled: boolean;
+    }))[];
+} | {
+    id: string;
+    assets: {
+        id: string;
+        preview: string;
+        source: string;
+    }[];
+    channels: {
+        id: string;
+        code: string;
+    }[];
+    collections: {
+        name: string;
+        slug: string;
+        parent?: {
+            slug: string;
+        } | undefined;
+    }[];
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    slug: string;
+    description: string;
+    featuredAsset?: {
+        id: string;
+        preview: string;
+        source: string;
+    } | undefined;
+    translations: {
+        id: string;
+        languageCode: import("@deenruv/admin-types").LanguageCode;
+        name: string;
+        slug: string;
+        description: string;
+    }[];
+    enabled: boolean;
+    optionGroups: {
+        id: string;
+        name: string;
+        code: string;
+    }[];
+    facetValues: {
+        id: string;
+        name: string;
+        translations: {
+            id: string;
+            languageCode: import("@deenruv/admin-types").LanguageCode;
+            name: string;
+        }[];
+        facet: {
+            id: string;
+            name: string;
+            translations: {
+                id: string;
+                languageCode: import("@deenruv/admin-types").LanguageCode;
+                name: string;
+            }[];
+        };
+    }[];
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    trackInventory: boolean;
+    outOfStockThreshold: number;
+    availableLanguages: import("@deenruv/admin-types").LanguageCode[];
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    firstName: string;
+    lastName: string;
+    emailAddress: string;
+    user?: {
+        verified: boolean;
+    } | undefined;
+    groups: {
+        id: string;
+        name: string;
+    }[];
+    title?: string | null | undefined;
+    phoneNumber?: string | null | undefined;
+    addresses?: {
+        id: string;
+        phoneNumber?: string | null | undefined;
+        fullName?: string | null | undefined;
+        company?: string | null | undefined;
+        streetLine1: string;
+        streetLine2?: string | null | undefined;
+        city?: string | null | undefined;
+        province?: string | null | undefined;
+        postalCode?: string | null | undefined;
+        country: {
+            code: string;
+        };
+        defaultShippingAddress?: boolean | null | undefined;
+        defaultBillingAddress?: boolean | null | undefined;
+    }[] | undefined;
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    description: string;
+    translations: {
+        languageCode: import("@deenruv/admin-types").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;
+    conditions: {
+        code: string;
+        args: {
+            name: string;
+            value: string;
+        }[];
+    }[];
+    actions: {
+        code: string;
+        args: {
+            name: string;
+            value: string;
+        }[];
+    }[];
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    description: string;
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    isDefault: boolean;
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+} | {
+    id: string;
+    assets: {
+        id: string;
+    }[];
+    isPrivate: boolean;
+    inheritFilters: boolean;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    slug: string;
+    description: string;
+    featuredAsset?: {
+        id: string;
+        preview: string;
+    } | undefined;
+    parent?: {
+        name: string;
+        slug: string;
+    } | undefined;
+    children?: {
+        id: string;
+        name: string;
+        slug: string;
+        featuredAsset?: {
+            preview: string;
+        } | undefined;
+    }[] | undefined;
+    filters: {
+        code: string;
+        args: {
+            name: string;
+            value: string;
+        }[];
+    }[];
+    translations: {
+        id: string;
+        languageCode: import("@deenruv/admin-types").LanguageCode;
+        name: string;
+        slug: string;
+        description: string;
+    }[];
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    description: string;
+    translations: {
+        languageCode: import("@deenruv/admin-types").LanguageCode;
+        name: string;
+        description: string;
+    }[];
+    code: string;
+    checker: {
+        code: string;
+        args: {
+            name: string;
+            value: string;
+        }[];
+    };
+    fulfillmentHandlerCode: string;
+    calculator: {
+        code: string;
+        args: {
+            name: string;
+            value: string;
+        }[];
+    };
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    translations: {
+        languageCode: import("@deenruv/admin-types").LanguageCode;
+        name: string;
+        description: string;
+    }[];
+    code: string;
+    enabled: boolean;
+    checker?: {
+        code: string;
+        args: {
+            name: string;
+            value: string;
+        }[];
+    } | undefined;
+    handler: {
+        code: string;
+        args: {
+            name: string;
+            value: string;
+        }[];
+    };
+} | {
+    id: string;
+    values: {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        name: string;
+        code: string;
+    }[];
+    isPrivate: boolean;
+    createdAt: string;
+    updatedAt: string;
+    languageCode: import("@deenruv/admin-types").LanguageCode;
+    name: string;
+    translations: {
+        languageCode: import("@deenruv/admin-types").LanguageCode;
+        name: string;
+    }[];
+    code: string;
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    translations: {
+        languageCode: import("@deenruv/admin-types").LanguageCode;
+        name: string;
+    }[];
+    code: string;
+    enabled: boolean;
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+} | {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    value: number;
+    enabled: boolean;
+    category: {
+        id: string;
+        name: string;
+    };
+    zone: {
+        id: string;
+        name: string;
+    };
+    customerGroup?: {
+        id: string;
+        name: string;
+    } | undefined;
+} | {
+    id: string;
+    promotions: {
+        id: string;
+        name: string;
+        couponCode?: string | null | undefined;
+    }[];
+    createdAt: string;
+    updatedAt: string;
+    code: string;
+    currencyCode: import("@deenruv/admin-types").CurrencyCode;
+    nextStates: string[];
+    modifications: {
+        id: string;
+        note: string;
+    }[];
+    state: string;
+    customer?: {
+        id: string;
+        firstName: string;
+        lastName: string;
+        emailAddress: string;
+        title?: string | null | undefined;
+        phoneNumber?: string | null | undefined;
+        addresses?: {
+            id: string;
+            phoneNumber?: string | null | undefined;
+            fullName?: string | null | undefined;
+            company?: string | null | undefined;
+            streetLine1: string;
+            streetLine2?: string | null | undefined;
+            city?: string | null | undefined;
+            province?: string | null | undefined;
+            postalCode?: string | null | undefined;
+            country: {
+                name: string;
+                code: string;
+            };
+            defaultShippingAddress?: boolean | null | undefined;
+            defaultBillingAddress?: boolean | 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;
+    } | 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;
+    } | undefined;
+    lines: {
+        id: string;
+        productVariant: {
+            id: string;
+            name: string;
+            featuredAsset?: {
+                id: string;
+                preview: string;
+            } | undefined;
+            currencyCode: import("@deenruv/admin-types").CurrencyCode;
+            stockLevels: {
+                stockOnHand: number;
+            }[];
+            product: {
+                id: string;
+                name: string;
+                slug: string;
+                featuredAsset?: {
+                    id: string;
+                    preview: string;
+                } | undefined;
+            };
+            productId: string;
+            sku: string;
+            price: number;
+            priceWithTax: number;
+        };
+        unitPrice: number;
+        unitPriceWithTax: number;
+        discountedUnitPrice: number;
+        discountedUnitPriceWithTax: number;
+        quantity: number;
+        taxRate: number;
+        linePrice: number;
+        linePriceWithTax: number;
+        discountedLinePrice: number;
+        discountedLinePriceWithTax: number;
+    }[];
+    surcharges: {
+        createdAt: string;
+        description: string;
+        sku?: string | null | undefined;
+        price: number;
+        priceWithTax: number;
+        taxRate: number;
+    }[];
+    discounts: {
+        description: string;
+        type: import("@deenruv/admin-types").AdjustmentType;
+        amount: number;
+        adjustmentSource: string;
+        amountWithTax: number;
+    }[];
+    couponCodes: string[];
+    excludedPromotionIds?: string[] | null | undefined;
+    payments?: {
+        id: string;
+        createdAt: string;
+        state: string;
+        method: string;
+        amount: number;
+        transactionId?: string | null | undefined;
+        errorMessage?: string | null | undefined;
+        refunds: {
+            id: string;
+            state: string;
+            lines: {
+                quantity: number;
+                orderLineId: string;
+            }[];
+            total: number;
+            transactionId?: string | null | undefined;
+        }[];
+        metadata?: any;
+    }[] | undefined;
+    fulfillments?: {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        nextStates: string[];
+        state: string;
+        lines: {
+            quantity: number;
+            orderLineId: string;
+        }[];
+        method: string;
+        summary: {
+            quantity: number;
+            orderLineId: string;
+            fulfillmentId: string;
+        }[];
+        trackingCode?: string | null | undefined;
+    }[] | undefined;
+    subTotalWithTax: number;
+    shippingLines: {
+        id: string;
+        price: number;
+        priceWithTax: number;
+        discountedPrice: number;
+        discountedPriceWithTax: number;
+        shippingMethod: {
+            id: string;
+            name: string;
+            code: string;
+            fulfillmentHandlerCode: string;
+        };
+    }[];
+    shipping: number;
+    total: number;
+    totalWithTax: number;
+    taxSummary: {
+        description: string;
+        taxRate: number;
+        taxBase: number;
+        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 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>;