@storecraft/dashboard 1.0.35 → 1.0.36

package/dist/lib/src/comps/resource-browse.d.ts

@@ -1,51 +0,0 @@
-import { App } from '@storecraft/core';
-export function BrowseCustomers({ onSave, onCancel }: BrowseCustomersParams): import("react").JSX.Element;
-export function BrowseProducts({ onSave, onCancel }: BrowseProductsParams): import("react").JSX.Element;
-export default BrowseCollection;
-/**
- * `BrowseCollection` is used to :
- * - **view** and **select** items in big collections
- * - Infinite pagination
- * - query and filtering with `vql` search query
- * - designed to be used inside a popup modal.
- */
-export type BrowseCollectionParams<T extends import('@storecraft/core/api').BaseType = import('@storecraft/core/api').BaseType> = {
-    resource: keyof App["db"]["resources"];
-    title?: string;
-    Comp?: React.FC<{
-        data: object;
-    }>;
-    onSave: (v: T[]) => void;
-    onCancel: () => void;
-};
-export type BrowseCustomersParams = {
-    onSave: (v: import('@storecraft/core/api').CustomerType[]) => void;
-    onCancel: () => void;
-};
-export type BrowseProductsParams = {
-    onSave: (v: import('@storecraft/core/api').ProductType[]) => void;
-    onCancel: () => void;
-};
-/**
- * `BrowseCollection` is used to :
- * - **view** and **select** items in big collections
- * - Infinite pagination
- * - query and filtering with `vql` search query
- * - designed to be used inside a popup modal.
- *
- * @template {import('@storecraft/core/api').BaseType} [T=import('@storecraft/core/api').BaseType]
- *
- *
- * @typedef {object} BrowseCollectionParams
- * @prop {keyof App["db"]["resources"]} resource
- * @prop {string} [title]
- * @prop {React.FC<{data: object}>} [Comp]
- * @prop {(v: T[]) => void} onSave
- * @prop {() => void} onCancel
- */
-/**
- * @template {import('@storecraft/core/api').BaseType} [T=import('@storecraft/core/api').BaseType]
- *
- * @param {BrowseCollectionParams<T>} params
- */
-declare function BrowseCollection<T extends import('@storecraft/core/api').BaseType = import('@storecraft/core/api').BaseType>({ resource, title, Comp, onSave, onCancel }: BrowseCollectionParams<T>): import("react").JSX.Element;

package/dist/lib/src/comps/resource-onboard-svg.d.ts

@@ -1,2 +0,0 @@
-export function ResourceOnboardSvg(props: React.SVGProps<SVGSVGElement>): React.JSX.Element;
-import * as React from "react";

package/dist/lib/src/comps/resource-title.d.ts

@@ -1,7 +0,0 @@
-export function ResourceTitle({ resource, should_onboard, hasLoaded, overallCollectionCount: overallCollectionCount }: ResourceTitleParams): import("react").JSX.Element;
-export type ResourceTitleParams = {
-    resource: string;
-    should_onboard?: boolean;
-    hasLoaded?: boolean;
-    overallCollectionCount?: number;
-};

package/dist/lib/src/comps/secret-view.d.ts

@@ -1,9 +0,0 @@
-export default SecretView;
-/**
- *
- * @param {import('./fields-view.jsx').FieldLeafViewParams<
- *  string> &
- *  React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
- * } params
- */
-declare function SecretView({ value, field, onChange, context, setError, ...rest }: import('./fields-view.jsx').FieldLeafViewParams<string> & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): import("react").JSX.Element;

package/dist/lib/src/comps/select-resource.d.ts

@@ -1,88 +0,0 @@
-import { App } from '@storecraft/core';
-export function default_name_fn(it: import('@storecraft/core/api').BaseType): any;
-export function default_transform_fn(window: any[]): any[];
-export default SelectResource;
-export function SelectResourceWithTags<T extends import('@storecraft/core/api').BaseType>({ field, context, value, onChange, resource, add_all, transform_fn, name_fn, slug, label, className, ...rest }: SelectResourceWithTagsParams<T>): import("react").JSX.Element;
-/**
- * A simple `select` control, that fetches all documents in a `collection`,
- * this is a good option for super small collections/tables such as:
- * - `Shipping Methods`
- * - `Collections`
- * - `Posts`
- * - `Discounts`
- * Which will mostly have no more that 50 items each.
- *
- * If you need something with pagination, try `BrowseCollection` instead.
- */
-export type SelectResourceParams<T, TRANSFORM = T> = {
-    /**
-     * callback when selection is made (value) => any
-     */
-    onSelect: (value: TRANSFORM) => any;
-    header: string;
-    /**
-     * add all sentinal
-     */
-    add_all?: boolean;
-    /**
-     * add all sentinal
-     */
-    layout: 0 | 1;
-    /**
-     * table identifier to query
-     */
-    resource: keyof App["db"]["resources"];
-    /**
-     * number of item to query
-     */
-    limit?: number;
-    className?: string;
-    clsHeader?: string;
-    clsReload?: string;
-    transform_fn?: (value: T[]) => TRANSFORM[];
-    name_fn?: (value: TRANSFORM) => string;
-};
-/**
- * A `FieldView` `select` control with `capsules`
- */
-export type InnerSelectResourceWithTagsParams = {
-    label: string;
-    slug: string;
-};
-export type SelectResourceWithTagsParams<T> = InnerSelectResourceWithTagsParams & SelectResourceParams<T> & import('./fields-view.jsx').FieldLeafViewParams<T[], import('../pages/index.jsx').BaseDocumentContext>;
-/**
- * A simple `select` control, that fetches all documents in a `collection`,
- * this is a good option for super small collections/tables such as:
- * - `Shipping Methods`
- * - `Collections`
- * - `Posts`
- * - `Discounts`
- * Which will mostly have no more that 50 items each.
- *
- * If you need something with pagination, try `BrowseCollection` instead.
- *
- * @template T
- * @template [TRANSFORM=T]
- *
- * @typedef {object} SelectResourceParams
- * @property {(value: TRANSFORM) => any} onSelect callback when selection is made (value) => any
- * @property {string} header
- * @property {boolean} [add_all] add all sentinal
- * @property {0 | 1} layout add all sentinal
- * @property {keyof App["db"]["resources"]} resource table identifier to query
- * @property {number} [limit] number of item to query
- * @property {string} [className]
- * @property {string} [clsHeader]
- * @property {string} [clsReload]
- * @property {(value: T[]) => TRANSFORM[]} [transform_fn]
- * @property {(value: TRANSFORM) => string} [name_fn]
- */
-/**
- *
- * @template T
- * @template [TRANSFORM=T]
- *
- * @param {SelectResourceParams<T, TRANSFORM>} params
- *
- */
-declare function SelectResource<T, TRANSFORM = T>({ onSelect, header, resource, limit, layout, add_all, transform_fn, name_fn, className, clsHeader, clsReload, ...rest }: SelectResourceParams<T, TRANSFORM>): import("react").JSX.Element;

package/dist/lib/src/comps/settings-api-keys.d.ts

@@ -1,2 +0,0 @@
-export function SettingsApiKeys({ ...rest }: SettingsApiKeysParams & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): import("react").JSX.Element;
-export type SettingsApiKeysParams = object;

package/dist/lib/src/comps/settings-change-password.d.ts

@@ -1,2 +0,0 @@
-export function SettingsChangePassword({ ...rest }: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): import("react").JSX.Element;
-export type SettingsChangePasswordParams = object;

package/dist/lib/src/comps/settings-storage.d.ts

@@ -1,15 +0,0 @@
-export default StorageSettingsView;
-export type StorageProvider = {
-    key: string;
-    name: string;
-    select_comp: any;
-    config_comp: any;
-};
-/**
- *
- * @param {object} param0
- * @param {StorageSettings} param0.value
- */
-declare function StorageSettingsView({ field, value, onChange, className, ...rest }: {
-    value: StorageSettings;
-}): import("react").JSX.Element;

package/dist/lib/src/comps/show-if.d.ts

@@ -1,25 +0,0 @@
-import { default as React } from 'react';
-export function ShowSwitch({ index, children, ...rest }: ShowSwitchParams): React.JSX.Element;
-export function ShowBinarySwitch({ toggle, children, ...rest }: InternalShowBinarySwitchParams & ShowSwitchParams): React.JSX.Element;
-export default ShowIf;
-export type ShowIfParams = {
-    show: any;
-    children: React.ReactNode;
-};
-export type internalShowSwitchParams = {
-    index?: number;
-};
-export type ShowSwitchParams = internalShowSwitchParams & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
-export type InternalShowBinarySwitchParams = {
-    toggle?: any;
-};
-/**
- *
- * @typedef {object} ShowIfParams
- * @prop {any} show
- * @prop {React.ReactNode} children
- *
- *
- * @param {ShowIfParams} params
- */
-declare function ShowIf({ show, children }: ShowIfParams): React.ReactNode;

package/dist/lib/src/comps/side-menu.d.ts

@@ -1,50 +0,0 @@
-import { default as React } from 'react';
-export default SideMenu;
-export type MenuItemType = {
-    name: string;
-    slug?: string;
-    icon?: React.JSX.Element;
-    extra?: object;
-    items?: MenuItemType[];
-};
-export type MenuType = {
-    items: MenuItemType[];
-    info: {
-        name?: string;
-        icon?: React.JSX.Element;
-    };
-};
-export type InnerSideMenuParams = {
-    menu: MenuType;
-    onCloseClick: () => void;
-};
-/**
- *
- * @typedef {object} MenuItemType
- * @prop {string} name
- * @prop {string} [slug]
- * @prop {React.JSX.Element} [icon]
- * @prop {object} [extra]
- * @prop {MenuItemType[]} [items]
- *
- *
- * @typedef {object} MenuType
- * @prop {MenuItemType[]} items
- * @prop {object} info
- * @prop {string} [info.name]
- * @prop {React.JSX.Element} [info.icon]
- *
- */
-/**
- *
- * @typedef {object} InnerSideMenuParams
- * @prop {MenuType} menu
- * @prop {() => void} onCloseClick
- *
- *
- * @param {InnerSideMenuParams &
- *  React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
- * } params
- *
- */
-declare function SideMenu({ className, onCloseClick, menu: { items, info } }: InnerSideMenuParams & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): React.JSX.Element;

package/dist/lib/src/comps/splitter-view.d.ts

@@ -1 +0,0 @@
-export function Splitter({ children, ...rest }: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): import("react").JSX.Element;

package/dist/lib/src/comps/storefront-products.d.ts

@@ -1,12 +0,0 @@
-export default StorefrontProducts;
-/**
- * `StorefrontProducts` is located at the `storefront.jsx` page.
- * It consists of abutton, that opens a modal to query `products`
- * with pagination and selecting them.
- *
- * @param {import('./fields-view.jsx').FieldLeafViewParams<
- *  import('@storecraft/core/api').ProductType[],
- *  import('../pages/storefront.jsx').Context>} params
- *
- */
-declare function StorefrontProducts({ field, context, value, onChange }: import('./fields-view.jsx').FieldLeafViewParams<import('@storecraft/core/api').ProductType[], import('../pages/storefront.jsx').Context>): import("react").JSX.Element;

package/dist/lib/src/comps/symbols.d.ts

@@ -1,4 +0,0 @@
-export function WhiteSpace({ n }: {
-    n?: number;
-}): import("react").JSX.Element;
-export function SpaceShip(): import("react").JSX.Element;

package/dist/lib/src/comps/tag-values.d.ts

@@ -1,9 +0,0 @@
-export function values_validator(v: any): (string | number)[];
-export default TagValues;
-/**
- *
- * @param {import("./fields-view.jsx").FieldLeafViewParams<
- *  string[]>
- * } params
- */
-declare function TagValues({ field, value, onChange, ...rest }: import('./fields-view.jsx').FieldLeafViewParams<string[]>): import("react").JSX.Element;

package/dist/lib/src/comps/tags-edit.d.ts

@@ -1,13 +0,0 @@
-export function SelectTags({ onSelect, header, limit, layout, className, clsHeader, clsReload, ...rest }: Omit<import('./select-resource.jsx').SelectResourceParams<import('@storecraft/core/api').TagType, string>, "resource" | "transform_fn" | "name_fn">): import("react").JSX.Element;
-export default TagsEdit;
-export type InternalManualTagParams = {
-    onAdd: (values: string[]) => void;
-};
-/**
- *
- * @param {import("./fields-view.jsx").FieldLeafViewParams<string[],
- *  import("../pages/index.jsx").BaseDocumentContext> &
- *  React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
- * } param0
- */
-declare function TagsEdit({ field, context, value, onChange, setError, ...rest }: import('./fields-view.jsx').FieldLeafViewParams<string[], import('../pages/index.jsx').BaseDocumentContext> & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): import("react").JSX.Element;

package/dist/lib/src/comps/template-example-input.d.ts

@@ -1,3 +0,0 @@
-export function TemplateExampleInput({ field, context, setError, value, onChange, ...rest }: TemplateTemplateParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "onChange">): import("react").JSX.Element;
-export default TemplateExampleInput;
-export type TemplateTemplateParams = import('./fields-view.jsx').FieldLeafViewParams<import('@storecraft/core/api').TemplateType["reference_example_input"]>;

package/dist/lib/src/comps/template-template.d.ts

@@ -1,15 +0,0 @@
-export function TemplateTemplate({ field, context, setError, value, onChange, isHtml, editor, defaultMode, showLayoutSwitcher, ...rest }: TemplateTemplateParams & Omit<React.ComponentProps<"div">, "onChange"> & {
-    editor?: {
-        width?: string;
-        height?: string;
-        options?: import('@monaco-editor/react').EditorProps["options"];
-    };
-    isHtml?: boolean;
-    defaultMode?: 0 | 1 | 2;
-    showLayoutSwitcher?: boolean;
-}): import("react").JSX.Element;
-export default TemplateTemplate;
-export type DangerousHTMLViewParams = {
-    value?: string | TrustedHTML;
-};
-export type TemplateTemplateParams = import('./fields-view.jsx').FieldLeafViewParams<import('@storecraft/core/api').TemplateType["template_html" | "template_text" | "template_subject"]>;

package/dist/lib/src/comps/transition.d.ts

@@ -1,51 +0,0 @@
-export default Transition;
-export type InnerTransitionParams = {
-    show: boolean;
-    unMountOnExit: boolean;
-    duration: number;
-    /**
-     * class-names for `event`
-     */
-    enter: string;
-    /**
-     * class-names for `event`
-     */
-    enterFrom: string;
-    /**
-     * class-names for `event`
-     */
-    enterTo: string;
-    /**
-     * class-names for `event`
-     */
-    leave: string;
-    /**
-     * class-names for `event`
-     */
-    leaveFrom: string;
-    /**
-     * class-names for `event`
-     */
-    leaveTo: string;
-};
-/**
- *
- * @typedef {object} InnerTransitionParams
- * @prop {boolean} show
- * @prop {boolean} unMountOnExit
- * @prop {number} duration
- * @prop {string} enter class-names for `event`
- * @prop {string} enterFrom class-names for `event`
- * @prop {string} enterTo class-names for `event`
- * @prop {string} leave class-names for `event`
- * @prop {string} leaveFrom class-names for `event`
- * @prop {string} leaveTo class-names for `event`
- *
- *
- *
- * @param {InnerTransitionParams &
- *  React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
- * } params
- *
- */
-declare function Transition({ show, duration, unMountOnExit, enter, enterFrom, enterTo, leave, leaveFrom, leaveTo, children, className, ...rest }: InnerTransitionParams & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): import("react").JSX.Element;

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

@@ -1,43 +0,0 @@
-import { queryable_resources, InferQueryableType } from '@storecraft/sdk-react-hooks';
-import { ApiQuery } from '@storecraft/core/api';
-export default useCollectionsActions;
-/**
- * `useCollectionsActions` is a hook designed for the collections pages,
- * for performing:
- * - Viewing of collections
- * - Pagination through querying or navigation
- * - Querying
- *
- * This hook wraps `useCollection` hook
- *
- * @template {string | queryable_resources} [RESOURCE=(queryable_resources)]
- * @template {InferQueryableType<RESOURCE>} [T=(InferQueryableType<RESOURCE>)]
- *
- * @param {RESOURCE} resource the collection id in backend
- * @param {string} [slug] front end slug
- * @param {boolean} [autoLoad=true]
- * @param {ApiQuery<T>} [autoLoadQuery=q_initial]
- */
-declare function useCollectionsActions<RESOURCE extends string | queryable_resources = queryable_resources, T extends InferQueryableType<RESOURCE> = InferQueryableType<RESOURCE>>(resource: RESOURCE, slug?: string, autoLoad?: boolean, autoLoadQuery?: ApiQuery<T>): {
-    resource: RESOURCE;
-    query_api: ApiQuery<T>;
-    ref_actions: import('react').MutableRefObject<import('../comps/collection-actions.jsx').ImperativeInterface>;
-    context: {
-        viewDocumentUrl: (id: string) => string;
-        editDocumentUrl: (id: string) => string;
-        deleteDocument: (document: string) => Promise<string>;
-    };
-    pages: T[][];
-    page: T[];
-    loading: boolean;
-    hasLoaded: boolean;
-    resource_is_probably_empty: boolean;
-    error: any;
-    queryCount: number;
-    actions: {
-        onLimitChange: ($limit: number, perform_navigation?: boolean) => ApiQuery<T>;
-        onReload: (perform_navigation?: boolean) => Promise<ApiQuery<T>>;
-        prev: (perform_navigation?: boolean) => Promise<ApiQuery<T>>;
-        next: (perform_navigation?: boolean) => Promise<ApiQuery<T>>;
-    };
-};

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

@@ -1,37 +0,0 @@
-import { App } from '@storecraft/core';
-export function useDocumentActions<T>(resource: (keyof App["db"]["resources"] | "payments/gateways" | "extensions"), document: string, slug: string, mode?: DocumentActionsMode, base?: string): {
-    actions: {
-        reloadPromise: (try_cache?: boolean) => Promise<void>;
-        reload_hard: import('react').MutableRefObject<(try_cache?: boolean) => Promise<T>>;
-        savePromise: () => Promise<T>;
-        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<T>;
-        setError: import('react').Dispatch<any>;
-    };
-    error: any;
-    key: string;
-    ref_head: import('react').MutableRefObject<import('../comps/common-ui.jsx').CreateDateImperativeInterface>;
-    ref_root: import('react').MutableRefObject<import('../comps/fields-view.jsx').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: import('../pages/index.jsx').BaseDocumentContext<{
-        hasChanged?: boolean;
-        data?: T;
-    }>;
-};
-/**
- * This `type` will give you the return type of the hook
- */
-export type HookReturnType<T> = Omit<ReturnType<typeof useDocumentActions<T>>, "doc"> & {
-    doc: T;
-};
-export type DocumentActionsMode = "edit" | "view" | "create";

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

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

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

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

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

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

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

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

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

@@ -1,26 +0,0 @@
-export function LinkWithState({ to, current_state, next_state, onClick, ...rest }: Params & import('react').AnchorHTMLAttributes<any>): import("react").JSX.Element;
-export default useNavigateWithState;
-export type Params = {
-    to: import('react-router-dom').To;
-    /**
-     * object or function
-     */
-    current_state: () => any | object;
-    /**
-     * object or function
-     */
-    next_state?: () => any | object;
-    /**
-     * callback
-     */
-    onClick?: () => any;
-};
-/**
- * A hook that navigates, BUT saves the state of the current
- */
-declare function useNavigateWithState(): {
-    nav: import('react-router-dom').NavigateFunction;
-    navWithState: (to: import('react-router-dom').To, current_state?: (() => any) | any, next_state?: (() => any) | any) => void;
-    location: import('react-router-dom').Location<any>;
-    state: any;
-};

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

@@ -1,7 +0,0 @@
-export default useOnClickOutside;
-/**
- *
- * @param {(e: Event) => void} handler
- *
- */
-declare function useOnClickOutside(handler: (e: Event) => void): import('react').MutableRefObject<HTMLElement>;

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

@@ -1,4 +0,0 @@
-export function useScrollDelta(scroll_delta?: number, default_open?: boolean): {
-    ref_scroll_element: import('react').RefObject<HTMLDivElement>;
-    open: boolean;
-};

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

@@ -1,7 +0,0 @@
-export default useToggle;
-/**
- * Hook for triggering an update
- *
- * @returns {[state: boolean, toggle: () => void]}
- */
-declare function useToggle(initial?: boolean): [state: boolean, toggle: () => void];

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

@@ -1,7 +0,0 @@
-export function hasWindow(): boolean;
-export namespace LS {
-    function get(key: string): any;
-    function set(key: string, value: any): void;
-    function remove(key: string): void;
-}
-export namespace SS { }