@storecraft/dashboard 1.0.5 → 1.0.7

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

@@ -15,23 +15,38 @@ export function SelectResourceWithTags<T extends import('@storecraft/core/v-api'
  * If you need something with pagination, try `BrowseCollection` instead.
  */
 export type SelectResourceParams<T, TRANSFORM = T> = {
+    /**
+     * callback when selection is made (value) => any
+     */
     /**
      * callback when selection is made (value) => any
      */
     onSelect: (value: TRANSFORM) => any;
     header: string;
+    /**
+     * add all sentinal
+     */
     /**
      * add all sentinal
      */
     add_all?: boolean;
+    /**
+     * add all sentinal
+     */
     /**
      * add all sentinal
      */
     layout: 0 | 1;
+    /**
+     * table identifier to query
+     */
     /**
      * table identifier to query
      */
     resource: keyof App["db"]["resources"];
+    /**
+     * number of item to query
+     */
     /**
      * number of item to query
      */

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

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

package/dist/lib/src/comps/table-schema-view.d.ts

@@ -1,6 +1,6 @@
 export function TableSchemaView<T>({ context, fields, data, recordClassName, className }: {
     context: any;
-    fields: TableSchemaViewField<T, keyof T, import('react').FC<TableSchemaViewComponentParams<T, keyof T>>>[];
+    fields: TableSchemaViewField<T>[];
     data: object[];
     recordClassName?: string;
     className?: string;
@@ -10,6 +10,9 @@ export function TableSchemaView<T>({ context, fields, data, recordClassName, cla
  * components of `TableSchemaView`
  */
 export type TableSchemaViewContext<T extends import('@storecraft/core/v-api').BaseType> = {
+    /**
+     * item
+     */
     /**
      * item
      */
@@ -21,28 +24,43 @@ export type TableSchemaViewContext<T extends import('@storecraft/core/v-api').Ba
 /**
  * infer `params` of `react` functional component
  */
-export type Params<T> = T extends import('react').FC<infer P> ? P : never;
+export type Params<T> = T extends React.FC<infer P> ? P : never;
 /**
  * The `field` parameter given to `TableSchemaView`
  * components
  */
-export type TableSchemaViewField<T extends unknown, Key extends keyof T = keyof T, Comp extends import('react').FC<{}> = import('react').FC<TableSchemaViewComponentParams<T, Key>>> = {
+export type TableSchemaViewField<T extends unknown, Key extends keyof T = keyof T, Comp extends React.FC = import('react').FC<TableSchemaViewComponentParams<T, Key>>> = {
+    /**
+     * Key of field in the data
+     */
     /**
      * Key of field in the data
      */
     key: Key;
+    /**
+     * Name of field
+     */
     /**
      * Name of field
      */
     name: string;
+    /**
+     * Name of field
+     */
     /**
      * Name of field
      */
     comp: React.FC<Params<Comp> & TableSchemaViewComponentParams<T[Key], T>>;
+    /**
+     * component parameters
+     */
     /**
      * component parameters
      */
     comp_params?: Params<Comp>;
+    /**
+     * transform data
+     */
     /**
      * transform data
      */
@@ -53,14 +71,23 @@ export type TableSchemaViewField<T extends unknown, Key extends keyof T = keyof
  * `TableSchemaView`
  */
 export type TableSchemaViewComponentParams<V extends unknown, T extends unknown = any> = {
+    /**
+     * Key of field in the data
+     */
     /**
      * Key of field in the data
      */
     field?: TableSchemaViewField<T>;
+    /**
+     * Context
+     */
     /**
      * Context
      */
     context?: TableSchemaViewContext<T>;
+    /**
+     * Value of field
+     */
     /**
      * Value of field
      */

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

@@ -1,4 +1,4 @@
-export function SelectTags({ onSelect, header, limit, layout, className, clsHeader, clsReload, ...rest }: Omit<import('./select-resource.jsx').SelectResourceParams<import('@storecraft/core/v-api').TagType, string>, 'resource' | 'transform_fn' | 'name_fn'>): import("react").JSX.Element;
+export function SelectTags({ onSelect, header, limit, layout, className, clsHeader, clsReload, ...rest }: Omit<import('./select-resource.jsx').SelectResourceParams<import('@storecraft/core/v-api').TagType, string>, "resource" | "transform_fn" | "name_fn">): import("react").JSX.Element;
 export default TagsEdit;
 export type InternalManualTagParams = {
     onAdd: (values: string[]) => void;

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

@@ -1,3 +1,3 @@
-export function TemplateExampleInput({ field, context, setError, value, onChange, ...rest }: TemplateTemplateParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'onChange'>): import("react").JSX.Element;
+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/v-api').TemplateType["reference_example_input"]>;

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

@@ -1,4 +1,4 @@
-export function TemplateTemplate({ field, context, setError, value, onChange, ...rest }: TemplateTemplateParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'onChange'>): import("react").JSX.Element;
+export function TemplateTemplate({ field, context, setError, value, onChange, ...rest }: TemplateTemplateParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "onChange">): import("react").JSX.Element;
 export default TemplateTemplate;
 export type DangerousHTMLViewParams = {
     value?: string | TrustedHTML;

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

@@ -3,26 +3,44 @@ export type InnerTransitionParams = {
     show: boolean;
     unMountOnExit: boolean;
     duration: number;
+    /**
+     * class-names for `event`
+     */
     /**
      * class-names for `event`
      */
     enter: string;
+    /**
+     * class-names for `event`
+     */
     /**
      * class-names for `event`
      */
     enterFrom: string;
+    /**
+     * class-names for `event`
+     */
     /**
      * class-names for `event`
      */
     enterTo: string;
+    /**
+     * class-names for `event`
+     */
     /**
      * class-names for `event`
      */
     leave: string;
+    /**
+     * class-names for `event`
+     */
     /**
      * class-names for `event`
      */
     leaveFrom: string;
+    /**
+     * class-names for `event`
+     */
     /**
      * class-names for `event`
      */

package/dist/lib/src/hooks/useCollectionsActions.d.ts

@@ -3,7 +3,7 @@ export default useCollectionsActions;
 /**
  * This `type` will give you the return type of the hook
  */
-export type HookReturnType<T> = Omit<ReturnType<typeof useCollectionsActions<T>>, 'page' | 'pages'> & {
+export type HookReturnType<T> = Omit<ReturnType<typeof useCollectionsActions<T>>, "page" | "pages"> & {
     page: T[];
     pages: T[][];
 };
@@ -27,15 +27,15 @@ export type HookReturnType<T> = Omit<ReturnType<typeof useCollectionsActions<T>>
  *
  * This hook wraps `useCollection` hook
  *
- * @template {Partial<import('@storecraft/core/v-api').BaseType>} T
+ * @template {Partial<import('@storecraft/core/v-api').BaseType> | any} [T=any]
  *
  * @param {((keyof App["db"]["resources"]) | 'payments/gateways' | 'extensions')} resource the collection id in backend
  * @param {string} [slug] front end slug
  * @param {boolean} [autoLoad=true]
  * @param {import('@storecraft/core/v-api').ApiQuery} [autoLoadQuery=q_initial]
  */
-declare function useCollectionsActions<T extends Partial<import('@storecraft/core/v-api').BaseType>>(resource: ((keyof App["db"]["resources"]) | 'payments/gateways' | 'extensions'), slug?: string, autoLoad?: boolean, autoLoadQuery?: import('@storecraft/core/v-api').ApiQuery): {
-    resource: "search" | "products" | "collections" | "discounts" | "tags" | "shipping_methods" | "posts" | "auth_users" | "customers" | "storefronts" | "images" | "templates" | "notifications" | "orders" | "extensions" | "payments/gateways";
+declare function useCollectionsActions<T extends unknown = any>(resource: ((keyof App["db"]["resources"]) | "payments/gateways" | "extensions"), slug?: string, autoLoad?: boolean, autoLoadQuery?: import('@storecraft/core/v-api').ApiQuery): {
+    resource: "search" | "auth_users" | "tags" | "collections" | "customers" | "products" | "storefronts" | "images" | "posts" | "templates" | "shipping_methods" | "notifications" | "discounts" | "orders" | "payments/gateways" | "extensions";
     query_api: import('@storecraft/core/v-api').ApiQuery;
     ref_actions: import('react').MutableRefObject<import('../comps/collection-actions.jsx').ImperativeInterface>;
     context: {
@@ -56,7 +56,7 @@ declare function useCollectionsActions<T extends Partial<import('@storecraft/cor
             limit: number;
             vql: string;
             expand?: import('@storecraft/core/v-api').ExpandQuery;
-            vqlParsed?: import("@storecraft/core/v-ql").VQL.Node;
+            vqlParsed?: import("@storecraft/core/v-ql").VQL.AST;
             sortBy?: import('@storecraft/core/v-api').SortCursor;
             order?: import('@storecraft/core/v-api').SortOrder;
         }>;

package/dist/lib/src/hooks/useDocumentActions.d.ts

@@ -1,11 +1,12 @@
 import { App } from '@storecraft/core';
-export function useDocumentActions<T extends {}>(resource: (keyof App["db"]["resources"] | 'payments/gateways' | 'extensions'), document: string, slug: string, mode?: DocumentActionsMode, base?: string): {
+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, next_state?: any) => 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>;
     };
@@ -18,6 +19,7 @@ export function useDocumentActions<T extends {}>(resource: (keyof App["db"]["res
     isEditMode: boolean;
     isCreateMode: boolean;
     isViewMode: boolean;
+    op: import('@storecraft/sdk-react-hooks').Op;
     loading: boolean;
     hasChanged: any;
     hasLoaded: boolean;
@@ -29,7 +31,7 @@ export function useDocumentActions<T extends {}>(resource: (keyof App["db"]["res
 /**
  * This `type` will give you the return type of the hook
  */
-export type HookReturnType<T> = Omit<ReturnType<typeof useDocumentActions<T>>, 'doc'> & {
+export type HookReturnType<T> = Omit<ReturnType<typeof useDocumentActions<T>>, "doc"> & {
     doc: T;
 };
-export type DocumentActionsMode = 'edit' | 'view' | 'create';
+export type DocumentActionsMode = "edit" | "view" | "create";

package/dist/lib/src/hooks/useNavigateWithState.d.ts

@@ -2,14 +2,23 @@ export function LinkWithState({ to, current_state, next_state, onClick, ...rest
 export default useNavigateWithState;
 export type Params = {
     to: import('react-router-dom').To;
+    /**
+     * object or function
+     */
     /**
      * object or function
      */
     current_state: () => any | object;
+    /**
+     * object or function
+     */
     /**
      * object or function
      */
     next_state?: () => any | object;
+    /**
+     * callback
+     */
     /**
      * callback
      */

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

@@ -28,7 +28,10 @@ export type BaseDocumentState<T extends unknown = any> = {
     hasChanged?: boolean;
     data?: T;
 };
-export type BaseDocumentContext<State extends BaseDocumentState<any> = any> = {
+export type BaseDocumentContext<State extends BaseDocumentState = any> = {
+    /**
+     * Get the values of the `fields-view` tree
+     */
     /**
      * Get the values of the `fields-view` tree
      */

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

@@ -3,13 +3,19 @@ declare function _default({ mode, ...rest }: {
 }): import("react").JSX.Element;
 export default _default;
 /**
- * Intrinsic state of `tag`
+ * Intrinsic state of `order`
  */
 export type State = {
     data: import('@storecraft/core/v-api').OrderData;
     hasChanged: boolean;
 };
 /**
- * Public `tag` context
+ * Inner `order` context
  */
-export type Context = import('./index.jsx').BaseDocumentContext<State>;
+export type InnerContext = {
+    create_checkout: (gateay: string) => Promise<any>;
+};
+/**
+ * Public `order` context
+ */
+export type Context = import('./index.jsx').BaseDocumentContext<State> & InnerContext;