@storecraft/dashboard 1.0.34 → 1.0.36

package/dist/lib/src/src/hooks/use-document-actions.d.ts

@@ -0,0 +1,64 @@
+import { InferQueryableType, queryable_resources } from '@storecraft/sdk-react-hooks';
+import { FieldViewImperativeInterface } from '../comps/fields-view';
+import { BaseDocumentContext } from '../pages';
+import { CreateDateImperativeInterface } from '../comps/common-ui';
+/**
+ * @template T the `document` type
+ *
+ * @typedef {Omit<ReturnType<typeof useDocumentActions<T>>, 'doc'> &
+ *  {
+ *    doc: T
+ *  }
+ * } HookReturnType This `type` will give you the return type of the hook
+ *
+ */
+export type DocumentActionsMode = 'edit' | 'view' | 'create';
+/**
+ * Your definitive hook for `document` adventures with UI. Compared
+ * to `useDocument`, it adds:
+ * - Aggregating from a functional component
+ * - Paginating by url navigation, for state saving.
+ * - Context
+ *
+ *
+ * @template T The type of `document`
+ *
+ *
+ * @param {string | queryable_resources} resource
+ * resource `identifier`
+ * @param resource the collection id in backend
+ * @param document document `handle` or `id`
+ * @param slug resource `slug` at backend
+ * @param {DocumentActionsMode} mode
+ * @param {string} [base] base64 encoded base `document` to merge with
+ *
+ */
+export declare const useDocumentActions: <RESOURCE extends (string | queryable_resources) = queryable_resources, T extends InferQueryableType<RESOURCE> = InferQueryableType<RESOURCE>>(resource: RESOURCE, document: string, slug: string, mode?: DocumentActionsMode, base?: string) => {
+    actions: {
+        reloadPromise: (try_cache?: boolean) => Promise<void>;
+        reload_hard: import('react').MutableRefObject<(try_cache?: boolean) => Promise<InferQueryableType<RESOURCE>>>;
+        savePromise: () => Promise<InferQueryableType<RESOURCE>>;
+        deletePromise: () => Promise<string>;
+        duplicate: (state_next_extra?: Partial<T>) => Promise<void>;
+        navWithState: (to: import('react-router').To, current_state?: (() => any) | any, next_state?: (() => any) | any) => void;
+        reload: (try_cache?: boolean) => Promise<InferQueryableType<RESOURCE>>;
+        setError: import('react').Dispatch<any>;
+    };
+    error: any;
+    key: string;
+    ref_head: import('react').RefObject<CreateDateImperativeInterface>;
+    ref_root: import('react').RefObject<FieldViewImperativeInterface<T>>;
+    doc: T;
+    sdk: import('@storecraft/sdk').StorecraftSDK;
+    isEditMode: boolean;
+    isCreateMode: boolean;
+    isViewMode: boolean;
+    op: import('@storecraft/sdk-react-hooks').Op;
+    loading: boolean;
+    hasChanged: any;
+    hasLoaded: boolean;
+    context: BaseDocumentContext<{
+        hasChanged?: boolean;
+        data?: T;
+    }>;
+};

package/dist/lib/src/src/hooks/use-interval.d.ts

@@ -0,0 +1,8 @@
+/**
+ * can be a finite integer or `Number.POSITIVE_INFINITY`
+ */
+declare const useInterval: (cb: (count: number) => void, millis?: number, autoStart?: boolean, runCount?: number) => {
+    start: () => void;
+    stop: () => void;
+};
+export default useInterval;

package/dist/lib/src/src/hooks/use-keyboard-match.d.ts

@@ -0,0 +1,5 @@
+export type KeyboardMatch = string[];
+/**
+ * Create a `hook`, that matches any of the given keyboard matches.
+ */
+export declare const createKeyboardMatchHook: (...matches: KeyboardMatch[]) => (onMatch: (match: KeyboardMatch) => void) => void;

package/dist/lib/src/src/hooks/use-media-query.d.ts

@@ -0,0 +1 @@
+export declare const useBreakpoint: (breakpoint: any, defaultValue?: boolean) => boolean, useBreakpointEffect: (breakpoint: any, effect: any) => any, useBreakpointValue: (breakpoint: any, valid: any, invalid: any) => any;

package/dist/lib/src/src/hooks/use-mounted.d.ts

@@ -0,0 +1 @@
+export declare function useMounted(): () => boolean;

package/dist/lib/src/src/hooks/use-navigate-with-state.d.ts

@@ -0,0 +1,18 @@
+import { default as React } from 'react';
+export type LinkWithStateProps = {
+    to: import('react-router-dom').To;
+    current_state: any | (() => any);
+    next_state?: any | (() => any);
+    onClick?: () => any;
+} & React.AnchorHTMLAttributes<HTMLAnchorElement>;
+export declare const LinkWithState: ({ to, current_state, next_state, onClick, ...rest }: LinkWithStateProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A hook that navigates, BUT saves the state of the current
+ */
+declare const useNavigateWithState: () => {
+    nav: import('react-router').NavigateFunction;
+    navWithState: (to: import('react-router-dom').To, current_state?: (() => any) | any, next_state?: (() => any) | any) => void;
+    location: import('react-router').Location<any>;
+    state: any;
+};
+export default useNavigateWithState;

package/dist/lib/src/src/hooks/use-on-click-outside.d.ts

@@ -0,0 +1,5 @@
+/**
+ *
+ */
+declare const useOnClickOutside: (handler: (e: Event) => void) => import('react').RefObject<HTMLDivElement>;
+export default useOnClickOutside;

package/dist/lib/src/{hooks → src/hooks}/use-preferences.d.ts

@@ -1,7 +1,7 @@
-export const usePreferences: () => {
-    state: StorecraftDashboardPreferences;
-    setState: ($state: StorecraftDashboardPreferences) => void;
-};
 export type StorecraftDashboardPreferences = {
     darkMode?: boolean;
 };
+export declare const usePreferences: () => {
+    state: StorecraftDashboardPreferences;
+    setState: ($state: StorecraftDashboardPreferences) => void;
+};

package/dist/lib/src/src/hooks/use-scroll-delta.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This hook will give a `div` reference and will decide based
+ * on scrolling if a `delta` area was going up or down more than
+ * `delta` threshold.
+ *
+ * This can be used to `open` or `close` a switch, which can be
+ * used for many things.
+ *
+ */
+export declare const useScrollDelta: (scroll_delta?: number, default_open?: boolean) => {
+    ref_scroll_element: import('react').RefObject<HTMLDivElement>;
+    open: boolean;
+};

package/dist/lib/src/src/hooks/use-toggle.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Hook for triggering an update
+ */
+declare const useToggle: (initial?: boolean) => (boolean | (() => void))[];
+export default useToggle;

package/dist/lib/src/{hooks → src/hooks}/use-trigger.d.ts

@@ -1,5 +1,5 @@
-export default useTrigger;
 /**
  * Hook for triggering an update
  */
-declare function useTrigger(): () => void;
+declare const useTrigger: () => () => void;
+export default useTrigger;

package/dist/lib/src/src/hooks/utils.browser.d.ts

@@ -0,0 +1,11 @@
+export declare const hasWindow: () => boolean;
+export declare const LS: {
+    get: (key: string) => any;
+    set: (key: string, value: any) => void;
+    remove: (key: string) => void;
+};
+export declare const SS: {
+    get: (key: string) => any;
+    set: (key: string, value: any) => void;
+    remove: (key: string) => void;
+};

package/dist/lib/src/src/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ *
+ * @description mount `storecraft` inside an `HTML` element.
+ * This method returns an invokable `unmount` function.
+ * @param el html element to mount the dashboard
+ * @param is_backend_endpoint_editable to show the backend endpoint input field ?
+ */
+export declare const mountStorecraftDashboard: (el: HTMLElement, is_backend_endpoint_editable?: boolean) => () => void;
+type DashboardParams = {
+    is_backend_endpoint_editable?: boolean;
+};
+export declare const Dashboard: ({ is_backend_endpoint_editable }: DashboardParams) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/lib/src/src/layout.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+export declare const MainPortal: {
+    Portal: React.FC<{}>;
+    PortalChild: React.FC<{
+        children?: React.ReactNode;
+    }>;
+};
+declare const Layout: ({ children, className, ...rest }: React.ComponentProps<"div">) => import("react/jsx-runtime").JSX.Element;
+export default Layout;

package/dist/lib/src/src/login.d.ts

@@ -0,0 +1,5 @@
+declare const Login: ({ is_backend_endpoint_editable }: {
+    is_backend_endpoint_editable?: boolean;
+    trigger?: () => void;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Login;

package/dist/lib/src/src/pages/collection.d.ts

@@ -0,0 +1,17 @@
+import { CollectionType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state of `collection`
+ */
+export type State = {
+    data: CollectionType;
+    hasChanged: boolean;
+};
+/**
+ * Public `collection` context
+ */
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    mode: "view" | "edit" | "create";
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/collections.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/customer.d.ts

@@ -0,0 +1,17 @@
+import { CustomerType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state
+ */
+export type State = {
+    data: CustomerType;
+    hasChanged: boolean;
+};
+/**
+* Public `tag` context
+*/
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    mode: "view" | "edit" | "create";
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/customers.d.ts

@@ -0,0 +1,4 @@
+import { CustomerType } from '@storecraft/core/api';
+export declare const extract_contact_field: (item: CustomerType) => string;
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/discount.d.ts

@@ -0,0 +1,18 @@
+import { DocumentActionsMode } from '../hooks/use-document-actions';
+import { DiscountType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state
+ */
+export type State = {
+    data: DiscountType;
+    hasChanged: boolean;
+};
+/**
+* Public context
+*/
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    mode: DocumentActionsMode;
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/discounts.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/extension.d.ts

@@ -0,0 +1,14 @@
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state
+ */
+export type State = {
+    data: undefined;
+    hasChanged: boolean;
+};
+/**
+ * Public context
+ */
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/extensions.d.ts

@@ -0,0 +1,8 @@
+import { TableSchemaViewComponentParams } from '../comps/table-schema-view';
+import { ExtensionItemGet } from '@storecraft/core/api';
+export type SpanWithLogoParams = TableSchemaViewComponentParams<ExtensionItemGet["info"]["name"], ExtensionItemGet> & React.ComponentProps<'div'> & {
+    extra?: string;
+};
+export declare const SpanWithLogo: ({ value, children, className, context, extra, ...rest }: SpanWithLogoParams) => import("react/jsx-runtime").JSX.Element;
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/home.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/index.d.ts

@@ -0,0 +1,33 @@
+export { default as Home } from './home';
+export { default as Orders } from './orders';
+export { default as Order } from './order';
+export { default as Customers } from './customers';
+export { default as Customer } from './customer';
+export { default as Tags } from './tags';
+export { default as Tag } from './tag';
+export { default as Templates } from './templates';
+export { default as Template } from './template';
+export { default as Products } from './products';
+export { default as Product } from './product';
+export { default as Collections } from './collections';
+export { default as Collection } from './collection';
+export { default as Discounts } from './discounts';
+export { default as Discount } from './discount';
+export { default as ShippingMethods } from './shipping-methods';
+export { default as ShippingMethod } from './shipping-method';
+export { default as Storefronts } from './storefronts';
+export { default as Storefront } from './storefront';
+export { default as Posts } from './posts';
+export { default as Post } from './post';
+export { default as PaymentGateways } from './payment-gateways';
+export { default as PaymentGateway } from './payment-gateway';
+export { default as Extensions } from './extensions';
+export { default as Extension } from './extension';
+export { default as Settings } from './settings';
+export type BaseDocumentState<T = any> = {
+    hasChanged?: boolean;
+    data?: T;
+};
+export type BaseDocumentContext<State extends BaseDocumentState = any> = {
+    getState?: () => State;
+};

package/dist/lib/src/src/pages/order.d.ts

@@ -0,0 +1,24 @@
+import { DocumentActionsMode } from '../hooks/use-document-actions';
+import { OrderData } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state of `order`
+ */
+export type State = {
+    data: OrderData;
+    hasChanged: boolean;
+};
+/**
+ * Inner `order` context
+ */
+export type InnerContext = {
+    create_checkout: (gateay: string) => Promise<any>;
+};
+/**
+ * Public `order` context
+ */
+export type Context = BaseDocumentContext<State> & InnerContext;
+declare const _default: ({ mode, ...rest }: {
+    mode: DocumentActionsMode;
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/orders.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/payment-gateway.d.ts

@@ -0,0 +1,14 @@
+import { BaseDocumentContext } from './index';
+/**
+ * Intrinsic state
+ */
+export type State = {
+    data: undefined;
+    hasChanged: boolean;
+};
+/**
+* Public context
+*/
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/payment-gateways.d.ts

@@ -0,0 +1,8 @@
+import { TableSchemaViewComponentParams } from '../comps/table-schema-view';
+import { PaymentGatewayItemGet } from '@storecraft/core/api';
+export type SpanWithLogoParams = TableSchemaViewComponentParams<PaymentGatewayItemGet["info"]["name"], PaymentGatewayItemGet> & React.ComponentProps<'div'> & {
+    extra?: string;
+};
+export declare const SpanWithLogo: ({ value, children, className, context, extra, ...rest }: SpanWithLogoParams) => import("react/jsx-runtime").JSX.Element;
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/post.d.ts

@@ -0,0 +1,18 @@
+import { PostType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state of `post`
+ */
+export type State = {
+    data: PostType;
+    hasChanged: boolean;
+};
+/**
+ * Public `post` context
+ */
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    [x: string]: any;
+    mode: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/posts.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/product.d.ts

@@ -0,0 +1,30 @@
+import { ProductType, VariantType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state of `product`
+ */
+export type State = {
+    data: ProductType | VariantType;
+    hasChanged: boolean;
+};
+/**
+* Inner `product` context
+*/
+export type InnerProductContext = {
+    removeVariant: (product_variant_handle: string) => Promise<void>;
+    preCreateVariant: () => Promise<void>;
+};
+/**
+* Public `product` context
+*/
+export type Context = InnerProductContext & BaseDocumentContext<State>;
+/**
+ * @param {{
+ *  mode: import('@/hooks/use-document-actions.js').DocumentActionsMode
+ * }} params
+ */
+declare const _default: ({ mode, ...rest }: {
+    [x: string]: any;
+    mode: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/products.d.ts

@@ -0,0 +1,2 @@
+declare function _default({}: {}): import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/settings.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/shipping-method.d.ts

@@ -0,0 +1,18 @@
+import { DocumentActionsMode } from '../hooks/use-document-actions';
+import { ShippingMethodType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state of `shipping`
+ */
+export type State = {
+    data: ShippingMethodType;
+    hasChanged: boolean;
+};
+/**
+ * Public `shipping` context
+ */
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    mode: DocumentActionsMode;
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/shipping-methods.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/storefront.d.ts

@@ -0,0 +1,18 @@
+import { DocumentActionsMode } from '../hooks/use-document-actions';
+import { StorefrontType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state
+ */
+export type State = {
+    data: StorefrontType;
+    hasChanged: boolean;
+};
+/**
+ * Public context
+ */
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    mode: DocumentActionsMode;
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/storefronts.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/tag.d.ts

@@ -0,0 +1,17 @@
+import { TagType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/**
+ * Intrinsic state of `tag`
+ */
+export type State = {
+    data: TagType;
+    hasChanged: boolean;
+};
+/**
+* Public `tag` context
+*/
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    mode: "create" | "edit" | "view";
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/tags.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/template.d.ts

@@ -0,0 +1,13 @@
+import { TemplateType } from '@storecraft/core/api';
+import { BaseDocumentContext } from '.';
+/** Intrinsic state */
+export type State = {
+    data: TemplateType;
+    hasChanged: boolean;
+};
+/** Public context */
+export type Context = BaseDocumentContext<State>;
+declare const _default: ({ mode, ...rest }: {
+    mode: "view" | "edit" | "create";
+}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/pages/templates.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({}: {}) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/dist/lib/src/src/routes.d.ts

@@ -0,0 +1 @@
+export default function Main(props: any): import("react/jsx-runtime").JSX.Element;

package/dist/lib/src/src/screens.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    xs: string;
+    sm: string;
+    md: string;
+    'md-lg': string;
+    lg: string;
+    xl: string;
+    '2xl': string;
+};
+export default _default;

package/dist/lib/src/src/utils/index.d.ts

@@ -0,0 +1,7 @@
+export declare const to_slug: (val: string) => string;
+export declare const capFirstLetter: (v: string) => string;
+export declare const read_clipboard: () => Promise<any>;
+export declare const write_clipboard: (text: string) => Promise<void>;
+export declare const hasTouchScreen: () => boolean;
+export declare const encode: (o: object) => string;
+export declare const decode: (c: string) => any;

package/dist/lib/src/src/utils/time.d.ts

@@ -0,0 +1,7 @@
+export declare const SECOND = 1000;
+export declare const MINUTE: number;
+export declare const HOUR: number;
+export declare const DAY: number;
+export declare const MONTH: number;
+export declare const YEAR: number;
+export declare const timeSince: (date: number | string | Date) => string;