@storecraft/dashboard 1.0.19 → 1.0.20

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

@@ -11,19 +11,11 @@ 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/api').ApiQuery;
     onClickImage?: (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>, data: import('@storecraft/core/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,30 +3,18 @@ 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-fields.d.ts

@@ -53,10 +53,6 @@ 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,16 +5,10 @@ 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,9 +52,6 @@ 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

@@ -3,17 +3,10 @@ export function CopyableView({ value, process_before_copy, ...rest }: CopyableVi
  * 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-filters.d.ts

@@ -52,23 +52,14 @@ export type AddFilterParams = {
     onAdd: (filter_id: string | number) => void;
 };
 export type DiscountFiltersParams = {
-    /**
-     * bunch of filters
-     */
     /**
      * bunch of filters
      */
     value: import('@storecraft/core/api').Filter[];
-    /**
-     * bunch of filters
-     */
     /**
      * bunch of filters
      */
     types: ("product" | "order")[];
-    /**
-     * bunch of filters
-     */
     /**
      * bunch of filters
      */

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

@@ -10,47 +10,29 @@ 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
      */
@@ -63,9 +45,6 @@ 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
      */
@@ -77,9 +56,6 @@ 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
      */
@@ -104,9 +80,6 @@ export type FieldLeafViewParams<V, C = {}, O = {}> = {
     error?: string;
 };
 export type FieldViewImperativeInterface<T> = {
-    /**
-     * Drill and get all nodes rendered data
-     */
     /**
      * Drill and get all nodes rendered data
      */

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

@@ -4,9 +4,6 @@ export type StatCardParams = {
     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

@@ -40,30 +40,18 @@ export type TransformValues = {
  * `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
      */

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

@@ -7,9 +7,6 @@ export type LoginFormFieldsType = {
 export type InnerFieldParams = {
     value: object;
     desc: string;
-    /**
-     * key in value
-     */
     /**
      * key in value
      */

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

@@ -3,23 +3,14 @@ export function MarkdownViewCard({ value, title, description, ...rest }: Markdow
  * 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/product-discounts.d.ts

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

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

@@ -3,23 +3,14 @@ export default QuickSearchBrowser;
 export type SearchGroupParams = {
     name: string;
     group: import('@storecraft/core/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,26 +3,16 @@ 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
      */

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

@@ -15,38 +15,23 @@ export function SelectResourceWithTags<T extends import('@storecraft/core/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/table-schema-view.d.ts

@@ -10,9 +10,6 @@ export function TableSchemaView<T>({ context, fields, data, recordClassName, cla
  * components of `TableSchemaView`
  */
 export type TableSchemaViewContext<T extends unknown> = {
-    /**
-     * item
-     */
     /**
      * item
      */
@@ -30,37 +27,22 @@ export type Params<T> = T extends React.FC<infer P> ? P : never;
  * components
  */
 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
      */
@@ -71,23 +53,14 @@ 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/transition.d.ts

@@ -3,44 +3,26 @@ 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

@@ -35,7 +35,7 @@ export type HookReturnType<T> = Omit<ReturnType<typeof useCollectionsActions<T>>
  * @param {import('@storecraft/core/api').ApiQuery} [autoLoadQuery=q_initial]
  */
 declare function useCollectionsActions<T extends unknown = any>(resource: ((keyof App["db"]["resources"]) | "payments/gateways" | "extensions"), slug?: string, autoLoad?: boolean, autoLoadQuery?: import('@storecraft/core/api').ApiQuery): {
-    resource: "search" | "auth_users" | "tags" | "collections" | "customers" | "products" | "storefronts" | "images" | "posts" | "templates" | "shipping_methods" | "notifications" | "discounts" | "orders" | "payments/gateways" | "extensions";
+    resource: "auth_users" | "tags" | "collections" | "customers" | "products" | "storefronts" | "images" | "posts" | "templates" | "shipping_methods" | "notifications" | "discounts" | "orders" | "search" | "payments/gateways" | "extensions";
     query_api: import('@storecraft/core/api').ApiQuery;
     ref_actions: import('react').MutableRefObject<import('../comps/collection-actions.jsx').ImperativeInterface>;
     context: {

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

@@ -2,23 +2,14 @@ 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

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