@storecraft/dashboard 1.0.5 → 1.0.7

package/dist/lib/src/apps/gallery/gallery.d.ts

@@ -11,11 +11,19 @@ export default Gallery;
  *    this is useful for re-routing of all kinds
  */
 export type InnerGalleryParams = {
+    /**
+     * { vql: '', limit: 5}
+     */
     /**
      * { vql: '', limit: 5}
      */
     query_params?: import('@storecraft/core/v-api').ApiQuery;
     onClickImage?: (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>, data: import('@storecraft/core/v-api').ImageType) => void;
+    /**
+     * Use url navigation
+     * to paginate through search params, as opposed to in-memory. This
+     * is suited for pages, the later for individual components.
+     */
     /**
      * Use url navigation
      * to paginate through search params, as opposed to in-memory. This

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

@@ -3,18 +3,30 @@ export type ImpInterface = {
     refresh: () => Promise<void>;
 };
 export type CollectionBaseParams = {
+    /**
+     * `handle` or `id`
+     */
     /**
      * `handle` or `id`
      */
     collection_handle_or_id: string;
+    /**
+     * `limit` of query
+     */
     /**
      * `limit` of query
      */
     limit: number;
+    /**
+     * when loaded reports query count
+     */
     /**
      * when loaded reports query count
      */
     onLoaded: (count: number) => void;
+    /**
+     * context
+     */
     /**
      * context
      */

package/dist/lib/src/comps/common-button.d.ts

@@ -4,9 +4,9 @@ export function LoadingButton({ Icon, show, text, keep_text_on_load, className,
 /**
  * A loading button which expects a promise for onClick
  */
-export type PromisableLoadingButton = InternalPromisableLoadingButton & Omit<LoadingButtonParams, 'onClick'>;
+export type PromisableLoadingButton = InternalPromisableLoadingButton & Omit<LoadingButtonParams, "onClick">;
 export function PromisableLoadingButton({ onClick, loading: $loading, ...rest }: PromisableLoadingButton): import("react").JSX.Element;
-export type PromisableLoadingBlingButton = InternalPromisableLoadingBlingButton & Omit<LoadingButtonParams, 'onClick'>;
+export type PromisableLoadingBlingButton = InternalPromisableLoadingBlingButton & Omit<LoadingButtonParams, "onClick">;
 export function PromisableLoadingBlingButton({ onClick, show, className, loading: $loading, stroke, rounded, from, to, ...rest }: PromisableLoadingBlingButton): import("react").JSX.Element;
 export function BlingButton({ from, to, rounded, stroke, children, text, className, btnClassName, ...rest }: import('./common-ui.jsx').InternalBlingParams & {
     btnClassName?: string;

package/dist/lib/src/comps/common-fields.d.ts

@@ -53,6 +53,10 @@ export type SwitchParams = InternalSwitchParams & React.DetailedHTMLProps<React.
 export type ClipBoardCopyButtonParams = {
     value: string;
     config?: 0 | 1;
+    /**
+     * process the value
+     * before copying
+     */
     /**
      * process the value
      * before copying

package/dist/lib/src/comps/common-table-fields.d.ts

@@ -5,10 +5,16 @@ export function SimpleLink({ context, value, children, className, extra, url_fn,
 export type InternalSpanParams<T extends unknown> = {
     className?: string;
     extra?: string;
+    /**
+     * create a `url`
+     */
     /**
      * create a `url`
      */
     url_fn: (item: T) => string;
+    /**
+     * get current navigatio `state`
+     */
     /**
      * get current navigatio `state`
      */

package/dist/lib/src/comps/common-ui.d.ts

@@ -52,6 +52,9 @@ export function Card({ name, setError, error, children, border, desc, rightView,
 export type InternalCreateDateParams = {
     time: string;
     changes_made?: boolean;
+    /**
+     * override
+     */
     /**
      * override
      */

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

@@ -1,12 +1,19 @@
-export function CopyableView({ value, process_before_copy, ...rest }: CopyableViewParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'value'>): import("react").JSX.Element;
+export function CopyableView({ value, process_before_copy, ...rest }: CopyableViewParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "value">): import("react").JSX.Element;
 /**
  * A view with `markdown` context, that is `copyable`
  */
 export type CopyableViewParams = {
+    /**
+     * markdown text
+     */
     /**
      * markdown text
      */
     value: string;
+    /**
+     * process the value
+     * before copying
+     */
     /**
      * process the value
      * before copying

package/dist/lib/src/comps/discount-details.d.ts

@@ -11,12 +11,12 @@ export type DiscountTypesParams = {
     onChange: (meta: import('@storecraft/core/v-api').DiscountDetails["meta"]) => void;
 };
 export type BulkDiscountParams = {
-    type: 'bulk';
+    type: "bulk";
     value: import('@storecraft/core/v-api').BulkDiscountExtra;
     onChange: (extra: import('@storecraft/core/v-api').BulkDiscountExtra) => void;
 };
 export type BundleDiscountParams = {
-    meta: 'bundle';
+    meta: "bundle";
     value: import('@storecraft/core/v-api').BundleDiscountExtra;
     context: import('./fields-view.jsx').FieldContextData;
     onChange: (extra: import('@storecraft/core/v-api').BundleDiscountExtra) => void;
@@ -27,18 +27,18 @@ export type ExplainPriceParams = {
     fixed: number;
 };
 export type RegularDiscountParams = {
-    type: 'regular';
+    type: "regular";
     value: import('@storecraft/core/v-api').RegularDiscountExtra;
     onChange: (extra: import('@storecraft/core/v-api').RegularDiscountExtra) => void;
 };
 export type BuyXGetYDiscountParams = {
-    type: 'buy_x_get_y';
+    type: "buy_x_get_y";
     value: import('@storecraft/core/v-api').BuyXGetYDiscountExtra;
     onChange: (extra: import('@storecraft/core/v-api').BuyXGetYDiscountExtra) => void;
     context: import('../pages/discount.jsx').Context;
 };
 export type OrderDiscountParams = {
-    type: 'order';
+    type: "order";
     value: import('@storecraft/core/v-api').OrderDiscountExtra;
     onChange: (extra: import('@storecraft/core/v-api').OrderDiscountExtra) => void;
 };

package/dist/lib/src/comps/discount-filters.d.ts

@@ -39,78 +39,8 @@ export type Filter_OrderHasCustomersParams = {
 export type ProductFilterContainerParams = {
     name: string;
     value: import('@storecraft/core/v-api').Filter["value"];
-    Comp: ({
-        Comp: ({ onChange, value, context }: Filter_ProductInCollectionsParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value, context }: Filter_ProductHasTagsParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value, }: Filter_ProductPriceInRangeParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value }: Filter_OrderDateParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value, context }: Filter_OrderHasCustomersParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    })[][0]["Comp"];
-    CompParams: ({
-        Comp: ({ onChange, value, context }: Filter_ProductInCollectionsParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value, context }: Filter_ProductHasTagsParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value, }: Filter_ProductPriceInRangeParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value }: Filter_OrderDateParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    } | {
-        Comp: ({ onChange, value, context }: Filter_OrderHasCustomersParams) => import("react").JSX.Element;
-        CompParams: {};
-        id: number;
-        type: string;
-        op: string;
-        name: string;
-    })[][0]["CompParams"];
+    Comp: (({ onChange, value, context }: Filter_ProductInCollectionsParams) => import("react").JSX.Element) | (({ onChange, value, context }: Filter_ProductHasTagsParams) => import("react").JSX.Element) | (({ onChange, value, }: Filter_ProductPriceInRangeParams) => import("react").JSX.Element) | (({ onChange, value }: Filter_OrderDateParams) => import("react").JSX.Element) | (({ onChange, value, context }: Filter_OrderHasCustomersParams) => import("react").JSX.Element);
+    CompParams: {} | {} | {} | {} | {};
     type: import('@storecraft/core/v-api').Filter["meta"]["type"];
     onChange: (value: import('@storecraft/core/v-api').Filter["value"]) => void;
     onRemove: () => void;
@@ -122,6 +52,9 @@ export type AddFilterParams = {
     onAdd: (filter_id: string | number) => void;
 };
 export type DiscountFiltersParams = {
+    /**
+     * bunch of filters
+     */
     /**
      * bunch of filters
      */
@@ -129,7 +62,13 @@ export type DiscountFiltersParams = {
     /**
      * bunch of filters
      */
-    types: ('product' | 'order')[];
+    /**
+     * bunch of filters
+     */
+    types: ("product" | "order")[];
+    /**
+     * bunch of filters
+     */
     /**
      * bunch of filters
      */

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

@@ -10,29 +10,47 @@ export type FieldData = {
     defaultValue?: any;
     name?: string;
     desc?: string;
+    /**
+     * nested fields
+     */
     /**
      * nested fields
      */
     fields?: FieldData[];
+    /**
+     * a react component
+     */
     /**
      * a react component
      */
     comp?: React.ComponentType;
+    /**
+     * params for comp
+     */
     /**
      * params for comp
      */
     comp_params?: object;
 };
 export type FieldContextData<D extends unknown = {}> = {
+    /**
+     * running key for leafs
+     */
     /**
      * running key for leafs
      */
     running_key?: string;
     pubsub?: PubSub;
+    /**
+     * the entire original data
+     */
     /**
      * the entire original data
      */
     data?: D;
+    /**
+     * the entire original data
+     */
     /**
      * the entire original data
      */
@@ -45,6 +63,9 @@ export type FieldContextData<D extends unknown = {}> = {
  * Root view params
  */
 export type FieldViewParams<O extends unknown = {}, C extends unknown = {}> = {
+    /**
+     * running key for leafs
+     */
     /**
      * running key for leafs
      */
@@ -56,6 +77,9 @@ export type FieldViewParams<O extends unknown = {}, C extends unknown = {}> = {
     isViewMode: boolean;
 };
 export type FieldNodeViewParams<V extends unknown = any, C extends {} = {}, O extends unknown = {}> = {
+    /**
+     * running key for leafs
+     */
     /**
      * running key for leafs
      */
@@ -79,7 +103,10 @@ export type FieldLeafViewParams<V, C = {}, O = {}> = {
     setError?: (error: string) => void;
     error?: string;
 };
-export type FieldViewImperativeInterface<T extends import('@storecraft/core/v-api').BaseType = {}> = {
+export type FieldViewImperativeInterface<T> = {
+    /**
+     * Drill and get all nodes rendered data
+     */
     /**
      * Drill and get all nodes rendered data
      */

package/dist/lib/src/comps/home-sales-chart.d.ts

@@ -2,7 +2,7 @@ export default SalesChart;
 export type InnerSalesChartParams = {
     data: import('@storecraft/core/v-api').OrdersStatisticsType;
 };
-export type SalesChartParams = InnerSalesChartParams & Omit<import('./base-chart-view.jsx').BaseChartViewParams, 'config'>;
+export type SalesChartParams = InnerSalesChartParams & Omit<import('./base-chart-view.jsx').BaseChartViewParams, "config">;
 /**
  *
  * @typedef {object} InnerSalesChartParams

package/dist/lib/src/comps/home-stat-card.d.ts

@@ -1,8 +1,12 @@
+import { default as Statistics } from '@storecraft/sdk/src/statistics.js';
 export default StatCard;
 export type StatCardParams = {
-    which_table: [table: "search" | "products" | "collections" | "discounts" | "tags" | "shipping_methods" | "posts" | "auth_users" | "customers" | "storefronts" | "images" | "templates" | "notifications" | "orders", query?: import('@storecraft/core/v-api').ApiQuery]["0"];
+    which_table: Parameters<Statistics["countOf"]>["0"];
     msg: string;
     link: string;
+    /**
+     * `VQL` search query
+     */
     /**
      * `VQL` search query
      */

package/dist/lib/src/comps/image-editor.d.ts

@@ -1,3 +1,4 @@
+import { useState } from 'react';
 export function Switch({ left: $left, onSwitch, children, className, ...rest }: SwitchParams & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>): import("react").JSX.Element;
 export default ImageEditor;
 /**
@@ -19,8 +20,8 @@ export type OptionsImpInterface = {
  * image editor options
  */
 export type EditingOptions = {
-    format: 'jpeg' | 'png' | 'webp';
-    quality: 0.5 | 0.75 | 0.8 | 0.9 | 1.0;
+    format: "jpeg" | "png" | "webp";
+    quality: 0.5 | 0.75 | 0.8 | 0.9 | 1;
     height: 128 | 256 | 384 | 512 | 640 | 768 | 896 | 1024;
 };
 /**
@@ -33,24 +34,36 @@ export type TransformValues = {
         x: number;
         y: number;
     };
-    mode: 'crop' | 'move';
+    mode: "crop" | "move";
 };
 /**
  * `TopPanel` view of image editor
  */
 export type InnerTopPanelParams = {
+    /**
+     * current values
+     */
     /**
      * current values
      */
     values: TransformValues;
+    /**
+     * notify editing action
+     */
     /**
      * notify editing action
      */
     notify: (values: TransformValues) => void;
+    /**
+     * notify close
+     */
     /**
      * notify close
      */
     onComplete: ImageEditorParams["onComplete"];
+    /**
+     * approve editing
+     */
     /**
      * approve editing
      */
@@ -60,7 +73,7 @@ export type InnerTopPanelParams = {
  * `TopPanel` view of image editor
  */
 export type TopPanelParams = InnerTopPanelParams & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
-export type useStateInfer<T> = [T, import('react').Dispatch<import('react').SetStateAction<T>>];
+export type useStateInfer<T> = ReturnType<typeof useState<T>>;
 /**
  * `ImageEditor` is a simple and effective image editor, supports:
  * - Transformations: `translate`, `rotate`, `scale`

package/dist/lib/src/comps/login-form.d.ts

@@ -7,6 +7,9 @@ export type LoginFormFieldsType = {
 export type InnerFieldParams = {
     value: object;
     desc: string;
+    /**
+     * key in value
+     */
     /**
      * key in value
      */
@@ -41,4 +44,4 @@ export type InnerLoginFormParams = {
 * } params
 *
 */
-declare function LoginForm({ onChange, onSubmit, error, className, credentials, is_backend_endpoint_editable, ...rest }: InnerLoginFormParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'value' | 'onChange' | 'onSubmit'>): import("react").JSX.Element;
+declare function LoginForm({ onChange, onSubmit, error, className, credentials, is_backend_endpoint_editable, ...rest }: InnerLoginFormParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "value" | "onChange" | "onSubmit">): import("react").JSX.Element;

package/dist/lib/src/comps/markdown-card.d.ts

@@ -1,16 +1,25 @@
-export function MarkdownViewCard({ value, title, description, ...rest }: MarkdownViewCardParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'value'>): import("react").JSX.Element;
+export function MarkdownViewCard({ value, title, description, ...rest }: MarkdownViewCardParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "value">): import("react").JSX.Element;
 /**
  * A card with `markdown content`
  */
 export type MarkdownViewCardParams = {
+    /**
+     * markdown text
+     */
     /**
      * markdown text
      */
     value: string;
+    /**
+     * card title
+     */
     /**
      * card title
      */
     title: string;
+    /**
+     * card description
+     */
     /**
      * card description
      */

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

@@ -2,7 +2,7 @@ export default MDView;
 export type InternalMDViewParams = {
     value?: string;
 };
-export type MDViewParams = InternalMDViewParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'value'>;
+export type MDViewParams = InternalMDViewParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "value">;
 /**
  * @typedef {object} InternalMDViewParams
  * @prop {string} [value]

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

@@ -1,3 +1,4 @@
+import { useState } from 'react';
 export default Media;
 /**
  * `CameraSource` will fetch image from local camera
@@ -20,7 +21,7 @@ export type GallerySourceParams = {
     onFinish: (url: string, requires_edit?: boolean) => void;
     className: string;
 };
-export type useStateInfer<T> = [T, import('react').Dispatch<import('react').SetStateAction<T>>];
+export type useStateInfer<T> = ReturnType<typeof useState<T>>;
 /**
  * `UrlSource` will fetch image from a simple `url`
  */
@@ -38,7 +39,7 @@ export type InnerMediaParams = {
  * `Media` wraps a few media fetching sources together.
  */
 export type Upload = {
-    status: 'working' | 'failed';
+    status: "working" | "failed";
     id: string | number;
     preview: string;
     error_code?: string;

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

@@ -11,5 +11,5 @@ export type InnerModalParams = {
     title?: React.ReactElement;
     onApprove: (key: string, value: any) => void;
 };
-export type ModalParams = InnerModalParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'title'>;
+export type ModalParams = InnerModalParams & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "title">;
 declare const Modal: import('react').ForwardRefExoticComponent<Omit<ModalParams, "ref"> & import('react').RefAttributes<any>>;

package/dist/lib/src/comps/order-line-items.d.ts

@@ -1,5 +1,5 @@
 export default OrderLineItems;
-export type Op = 'change-qty' | 'stock-change';
+export type Op = "change-qty" | "stock-change";
 export type InternalLineitemsTableParams = {
     items?: import('@storecraft/core/v-api').LineItem[];
     context?: import('./fields-view.jsx').FieldContextData & import('../pages/order.jsx').Context;

package/dist/lib/src/comps/order-payment-gateway.d.ts

@@ -7,7 +7,11 @@ export type ActionButtonParams = {
     action: import('@storecraft/core/v-api').PaymentGatewayAction;
     onClick: (action: import('@storecraft/core/v-api').PaymentGatewayAction) => Promise<void>;
 };
-export type OrderPaymentGatewayParams = import('./fields-view.jsx').FieldLeafViewParams<import('@storecraft/core/v-api').OrderPaymentGatewayData, import('../pages/order.jsx').Context, import('@storecraft/core/v-api').OrderData> & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
+export type ChoosePaymentGatewayParams = {
+    full_order?: import('@storecraft/core/v-api').OrderData;
+    onCreate: (pg_handle: string) => Promise<any>;
+};
+export type OrderPaymentGatewayParams = import('./fields-view.jsx').FieldLeafViewParams<import('@storecraft/core/v-api').OrderPaymentGatewayData, import('../pages/order.jsx').Context, import('@storecraft/core/v-api').OrderData> & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "onChange">;
 /**
  *
  * @typedef {import('./fields-view.jsx').FieldLeafViewParams<
@@ -15,7 +19,7 @@ export type OrderPaymentGatewayParams = import('./fields-view.jsx').FieldLeafVie
  *   import('../pages/order.jsx').Context,
  *   import('@storecraft/core/v-api').OrderData
  *  > &
- *   React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
+ *   Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'onChange'>
  * } OrderPaymentGatewayParams
  *
  * @param {OrderPaymentGatewayParams} param

package/dist/lib/src/comps/order-price.d.ts

@@ -1,12 +1,17 @@
 export default OrderPrice;
 export type EntryParams = {
     title: string;
+    link?: string;
     value: number;
+    context?: import('../pages/order.jsx').Context;
 };
-export type OrderPriceParams = import('./fields-view.jsx').FieldLeafViewParams<import('@storecraft/core/v-api').PricingData> & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
+export type OrderPriceParams = import('./fields-view.jsx').FieldLeafViewParams<import('@storecraft/core/v-api').PricingData, import('../pages/order.jsx').Context, import('@storecraft/core/v-api').OrderData> & React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
 /**
  * @typedef {import('./fields-view.jsx').FieldLeafViewParams<
- *  import('@storecraft/core/v-api').PricingData> &
+ *  import('@storecraft/core/v-api').PricingData,
+ *  import('@/pages/order.jsx').Context,
+ *  import('@storecraft/core/v-api').OrderData
+ * > &
  *   React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
  * } OrderPriceParams
  *

package/dist/lib/src/comps/product-discounts.d.ts

@@ -1,9 +1,15 @@
 export default ProductDiscounts;
 export type ItemParams = {
+    /**
+     * `discount`
+     */
     /**
      * `discount`
      */
     value: import('@storecraft/core/v-api').DiscountType;
+    /**
+     * callback
+     */
     /**
      * callback
      */

package/dist/lib/src/comps/quick-search-browser.d.ts

@@ -3,14 +3,23 @@ export default QuickSearchBrowser;
 export type SearchGroupParams = {
     name: string;
     group: import('@storecraft/core/v-api').QuickSearchResource[];
+    /**
+     * The group index
+     */
     /**
      * The group index
      */
     index: number;
+    /**
+     * The item index
+     */
     /**
      * The item index
      */
     selectedItemIndex: number;
+    /**
+     * The item index
+     */
     /**
      * The item index
      */

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

@@ -3,16 +3,26 @@ export type ImpInterface = {
     refresh: () => Promise<void>;
 };
 export type ResourceViewParams = {
+    /**
+     * `resource` at the backend endpoint, that supports
+     * querying
+     */
     /**
      * `resource` at the backend endpoint, that supports
      * querying
      */
     resource: string;
+    /**
+     * `limit` of query
+     */
     /**
      * `limit` of query
      */
     limit?: number;
     schema: any[];
+    /**
+     * context
+     */
     /**
      * context
      */