npm - @storecraft/dashboard - Versions diffs - 1.0.37 → 1.2.5 - Mend

@storecraft/dashboard 1.0.37 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (161) hide show

package/README.md CHANGED Viewed

@@ -11,9 +11,10 @@
 </div><hr/><br/>
 The Official `storecraft` Dashboard 🏆,
 - Leveraging `static rendering` / `client side rendering` / `swr`
 - Can be deployed into cost effective **CDN**
-- Also available at `jsDelivr` **CDN**
+- Also available at **CDN** like `unpkg` for consuming as a component.
 Effectively, **TWO** Build Targets
 1. A `library` with
@@ -23,7 +24,6 @@ Effectively, **TWO** Build Targets
 Build is handled by `Vite`
 ```bash
 npm i @storecraft/dashboard
 ```
@@ -35,8 +35,6 @@ First, run the development server:
 ```bash
 npm run dashboard:dev
 # or
-yarn dashboard:dev
-# or
 npm start
 ```
@@ -48,18 +46,16 @@ Simply, run any of the following command
 ```bash
 npm run dashboard:build
-# or
-yarn dashboard:build
 ```
 Artifacts are in the `dist` folder
 ```txt
 dist
-├── lib
-│   ├── index.js      // ES module
-│   ├── index.cjs     // common js
-│   └── index.umd.cjs // UMD
-├── website
+├── /lib
+├───┼── /src
+│   │   ├── index.js      // ES module
+│   │   └── index.umd.cjs // UMD
+├── /website
 │   ├── index.html
 │   └── assets
@@ -75,33 +71,77 @@ npm i @storecraft/dashboard
 Then,
-```jsx
+```tsx
 import { Dashboard } from '@storecraft/dashboard'
 export const Root = () => {
   return (
     <div className='w-screen h-screen'>
-      <Dashboard />
+      <Dashboard is_backend_endpoint_editable={true} />
     </div>
   )
 }
 ```
-## Consuming via `jsDelivr`
+## Consuming via `unpkg` as **UMD** (smaller bundle)
 ```html
-<script id='_storecraft_script_' type="module">
-  import { mountStorecraftDashboard } from 'https://cdn.jsdelivr.net/npm/@storecraft/dashboard@latest/dist/lib/index.min.js';
-  mountStorecraftDashboard(
-    document.getElementById('root'), false
-  );
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" sizes="any" type="image/svg+xml" href="/api/dashboard/favicon.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Storecraft - Next Gen Commerce-As-Code</title>
+  </head>
+  <body style="background-color: black">
+    <div id="root"></div>
+    <script
+      type="application/javascript"
+      src="https://www.unpkg.com/@storecraft/dashboard@latest/dist/lib/src/index.umd.cjs">
+    </script>
+    <script>
+      console.log({StorecraftDashboard});
+      const show_configurable_endpoint = true;
+      StorecraftDashboard.mountStorecraftDashboard(
+        document.getElementById('root'),
+        show_configurable_endpoint
+      );
+    </script>
+  </body>
+</html>
+```
-</script>
+## Consuming via `unpkg` as **ESM** (bigger bundle)
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" sizes="any" type="image/svg+xml" href="/api/dashboard/favicon.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Storecraft - Next Gen Commerce-As-Code</title>
+    <script type="module">
+      import { mountStorecraftDashboard } from 'https://www.unpkg.com/@storecraft/dashboard@latest/dist/lib/src/index.js';
+      const show_configurable_endpoint = true;
+      mountStorecraftDashboard(
+        document.getElementById('root'),
+        show_configurable_endpoint
+      );
+    </script>
+  </head>
+  <body style="background-color: black">
+    <div id="root"></div>
+  </body>
+</html>
 ```

package/dist/lib/src/{src/comps → comps}/discount-details.d.ts RENAMED Viewed

@@ -1,9 +1,11 @@
+import { DiscountMetaEnum } from '@storecraft/core/api/types.api.enums.js';
 import { BulkDiscountExtra, BundleDiscountExtra, BuyXGetYDiscountExtra, DiscountDetails, DiscountType, OrderDiscountExtra, RegularDiscountExtra } from '@storecraft/core/api';
 import { FieldContextData, FieldLeafViewParams } from './fields-view';
 export declare const discount_details_validator: (v: any) => (string | boolean)[];
+type DiscountMeta = typeof DiscountMetaEnum[keyof typeof DiscountMetaEnum];
 export type DiscountTypesParams = {
-    selectedType: DiscountDetails["meta"];
-    onChange: (meta: DiscountDetails["meta"]) => void;
+    selectedMeta: DiscountMeta;
+    onChange: (meta: DiscountMeta) => void;
 };
 export type BulkDiscountParams = {
     type: "bulk";
@@ -11,7 +13,6 @@ export type BulkDiscountParams = {
     onChange: (extra: BulkDiscountExtra) => void;
 };
 export type BundleDiscountParams = {
-    meta: "bundle";
     value: BundleDiscountExtra;
     context: FieldContextData;
     onChange: (extra: BundleDiscountExtra) => void;
@@ -38,17 +39,37 @@ export type OrderDiscountParams = {
     onChange: (extra: OrderDiscountExtra) => void;
 };
 export type Type2CompParams = {
-    meta: DiscountDetails["meta"];
+    meta: DiscountMeta;
     context: FieldContextData<DiscountType>;
     onChange: (extra: DiscountDetails["extra"]) => void;
     value: DiscountDetails["extra"];
 };
 export type DiscountDetailsViewParams = FieldLeafViewParams<DiscountDetails, import('../pages/discount.js').Context, DiscountType>;
-export declare const discount_types: {
-    id: number;
-    type: string;
-    name: string;
+export declare const discount_types: ({
     desc: string;
-}[];
+    id: 0;
+    type: "regular";
+    name?: string;
+} | {
+    desc: string;
+    id: 1;
+    type: "bulk";
+    name?: string;
+} | {
+    desc: string;
+    id: 2;
+    type: "buy_x_get_y";
+    name?: string;
+} | {
+    desc: string;
+    id: 3;
+    type: "order";
+    name?: string;
+} | {
+    desc: string;
+    id: 4;
+    type: "bundle";
+    name?: string;
+})[];
 declare const DiscountDetailsView: ({ field, value, context, onChange, ...rest }: DiscountDetailsViewParams) => import("react/jsx-runtime").JSX.Element;
 export default DiscountDetailsView;

package/dist/lib/src/{src/comps → comps}/discount-filters.d.ts RENAMED Viewed

@@ -1,36 +1,37 @@
 import { default as React } from 'react';
-import { CustomerType, DiscountType, Filter, FilterValue_o_date_in_range, FilterValue_o_items_count_in_range, FilterValue_o_subtotal_in_range, FilterValue_p_in_collections, FilterValue_p_in_price_range, FilterValue_p_in_products, FilterValue_p_in_tags } from '@storecraft/core/api';
+import { FilterMetaEnum } from '@storecraft/core/api/types.api.enums.js';
+import { CustomerType, DiscountType, Filter, Filter_o_date_in_range, Filter_o_items_count_in_range, Filter_o_subtotal_in_range, Filter_p_in_collections, Filter_p_in_price_range, Filter_p_in_products, Filter_p_in_tags } from '@storecraft/core/api';
 import { FieldLeafViewParams } from './fields-view.js';
 export type Filter_ProductInCollectionsParams = {
-    value: FilterValue_p_in_collections;
-    onChange: (filter_value: FilterValue_p_in_collections) => void;
+    value: Filter_p_in_collections["value"];
+    onChange: (filter_value: Filter_p_in_collections["value"]) => void;
     context: import('../pages/discount.js').Context;
 };
 export type Filter_ProductHasTagsParams = {
-    value: FilterValue_p_in_tags;
-    onChange: (filter_value: FilterValue_p_in_tags) => void;
+    value: Filter_p_in_tags["value"];
+    onChange: (filter_value: Filter_p_in_tags["value"]) => void;
     context: import('../pages/discount.js').Context;
 };
 export type Filter_ProductHasHandleParams = {
-    value: FilterValue_p_in_products;
-    onChange: (filter_value: FilterValue_p_in_products) => void;
+    value: Filter_p_in_products["value"];
+    onChange: (filter_value: Filter_p_in_products["value"]) => void;
     context: import('../pages/discount.js').Context;
 };
 export type Filter_ProductPriceInRangeParams = {
-    value: FilterValue_p_in_price_range;
-    onChange: (filter_value: FilterValue_p_in_price_range) => void;
+    value: Filter_p_in_price_range["value"];
+    onChange: (filter_value: Filter_p_in_price_range["value"]) => void;
 };
 export type Filter_OrderSubTotalParams = {
-    value: FilterValue_o_subtotal_in_range;
-    onChange: (filter_value: FilterValue_o_subtotal_in_range) => void;
+    value: Filter_o_subtotal_in_range["value"];
+    onChange: (filter_value: Filter_o_subtotal_in_range["value"]) => void;
 };
 export type Filter_OrderItemCountParams = {
-    value?: FilterValue_o_items_count_in_range;
-    onChange: (filter_value: FilterValue_o_items_count_in_range) => void;
+    value?: Filter_o_items_count_in_range["value"];
+    onChange: (filter_value: Filter_o_items_count_in_range["value"]) => void;
 };
 export type Filter_OrderDateParams = {
-    onChange: (value: FilterValue_o_date_in_range) => void;
-    value?: FilterValue_o_date_in_range;
+    onChange: (value: Filter_o_date_in_range["value"]) => void;
+    value?: Filter_o_date_in_range["value"];
 };
 export type Filter_OrderHasCustomersParams = {
     onChange: (value: CustomerType[]) => void;
@@ -42,7 +43,7 @@ export type ProductFilterContainerParams = {
     value: Filter["value"];
     Comp: any;
     CompParams: any;
-    type: Filter["meta"]["type"];
+    type: typeof FilterMetaEnum[Exclude<keyof typeof FilterMetaEnum, 'any'>]["type"];
     onChange: (value: Filter["value"]) => void;
     onRemove: () => void;
     ix: number;
@@ -55,6 +56,5 @@ export type AddFilterParams = {
 export type DiscountFiltersParams = FieldLeafViewParams<Filter[], import('../pages/discount.js').Context, DiscountType> & React.ComponentProps<'div'> & {
     types: ("product" | "order")[];
 };
-export declare const discount_filters_validator: (v: Filter["meta"][]) => (string | boolean)[];
 declare const DiscountFilters: ({ value, onChange, types, context, ...rest }: DiscountFiltersParams) => import("react/jsx-runtime").JSX.Element;
 export default DiscountFilters;

package/dist/lib/src/{src/comps → comps}/discounts-table-type.d.ts RENAMED Viewed

@@ -1,6 +1,6 @@
 import { DiscountDetails } from '@storecraft/core/api';
 import { TableSchemaViewComponentParams } from './table-schema-view';
-export declare const discount_types_to_color: (type: DiscountDetails["meta"]["type"]) => "bg-kf-400 dark:bg-kf-400/40" | "bg-red-400 dark:bg-red-400/40" | "bg-teal-600 dark:bg-teal-600/40" | "bg-cyan-500 dark:bg-cyan-500/40" | "bg-sky-500 dark:bg-sky-400/40" | "bg-slate-400 dark:bg-slate-400/20";
-export type DiscountTypeParams = TableSchemaViewComponentParams<DiscountDetails["meta"]>;
+export declare const discount_types_to_color: (type: DiscountDetails["meta"]["type"]) => "bg-red-400 dark:bg-red-400/40" | "bg-teal-600 dark:bg-teal-600/40" | "bg-cyan-500 dark:bg-cyan-500/40" | "bg-kf-400 dark:bg-kf-400/40" | "bg-sky-500 dark:bg-sky-400/40" | "bg-slate-400 dark:bg-slate-400/20";
+export type DiscountTypeParams = TableSchemaViewComponentParams<DiscountDetails>;
 declare const DiscountType: ({ value, ...rest }: DiscountTypeParams) => import("react/jsx-runtime").JSX.Element;
 export default DiscountType;

package/dist/lib/src/{src/comps → comps}/error-message.d.ts RENAMED Viewed

@@ -1,5 +1,5 @@
 /**
- * error message view from document pages
+ * @description error message view from document pages
  */
 export type EditMessageParams = {
     error?: import('@storecraft/core/api').error;
@@ -7,12 +7,11 @@ export type EditMessageParams = {
     className?: string;
 } & React.ComponentProps<'div'>;
 /**
- * Easily `format` errors coming from the `storecraft` backend
- *
+ * @description Easily `format` errors coming from the `storecraft` backend
  */
 export declare const format_storecraft_errors: (error: import('@storecraft/core/api').error) => string[];
 /**
- * error message view from document pages
+ * @description error message view from document pages
  */
 declare const ErrorMessage: ({ error, positive, className, ...rest }: EditMessageParams) => import("react/jsx-runtime").JSX.Element;
 export default ErrorMessage;

package/dist/lib/src/comps/marquee.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import { default as React } from 'react';
2	+ export declare const Marquee: ({ ...rest }: React.ComponentProps<"div">) => import("react/jsx-runtime").JSX.Element;

package/dist/lib/src/comps/orders-quick-search-actions.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { FulfillOptionsEnum, PaymentOptionsEnum } from '@storecraft/core/api/types.api.enums.js';
+type key_fulfill = typeof FulfillOptionsEnum[keyof typeof FulfillOptionsEnum]["name2"];
+type key_payment = typeof PaymentOptionsEnum[keyof typeof PaymentOptionsEnum]["name2"];
+export declare const id2ColorFulfill: (key: key_fulfill) => "bg-gray-400 dark:bg-gray-400/40" | "bg-red-500 dark:bg-red-500/40" | "bg-green-600 dark:bg-green-600/40" | "bg-black dark:bg-black/40" | "bg-pink-400 dark:bg-pink-400/40";
+export declare const id2ColorPayment: (key: key_payment) => "bg-gray-400 dark:bg-gray-400/40" | "bg-green-600 dark:bg-green-600/40" | "bg-pink-400 dark:bg-pink-400/40" | "bg-green-700/50 dark:bg-green-500/40" | "bg-kf-400/70 dark:bg-kf-400/40" | "bg-malibu-500 dark:bg-malibu-500/40" | "bg-red-400 dark:bg-red-400/40" | "bg-cyan-400 dark:bg-cyan-400/40" | "bg-teal-500 dark:bg-teal-500/40" | "bg-teal-800/50 dark:bg-teal-400/40";
+declare const OrdersQuickSearchActions: ({ ...rest }: React.ComponentProps<"div">) => import("react/jsx-runtime").JSX.Element;
+export default OrdersQuickSearchActions;

package/dist/lib/src/{src/comps → comps}/table-schema-view.d.ts RENAMED Viewed

@@ -10,6 +10,7 @@ export type TableSchemaViewContext<T extends unknown> = {
     deleteDocument: (id: string) => Promise<void>;
     editDocumentUrl: (id: string) => string;
     viewDocumentUrl: (id: string) => string;
+    linkExternalUrl: (id: string) => string;
 };
 /**
  * infer `params` of `react` functional component

package/dist/lib/src/{src/hooks → hooks}/use-collections-actions.d.ts RENAMED Viewed

@@ -1,13 +1,20 @@
 import { InferQueryableType, queryable_resources } from '@storecraft/sdk-react-hooks';
 import { ApiQuery } from '@storecraft/core/api';
 /**
- * `useCollectionsActions` is a hook designed for the collections pages,
- * for performing:
+ * @description `useCollectionsActions` is a hook designed for
+ * the collections pages, for performing:
  * - Viewing of collections
  * - Pagination through querying or navigation
  * - Querying
+ * It's main use case is for performing url navigation with query params
+ * although can be used without.
  *
- * This hook wraps `useCollection` hook
+ * TODO: Rewrite the cursors to be used by `vql` in later versions.
+ * currently, i dont do that because it is a breaking change for dashboards
+ * that dont have the backend to support it.
+ * Also, `limit` always resets the query.
+ *
+ * This hook wraps {@link useCollection} hook
  *
  * @param resource the collection id in backend
  * @param slug front end slug
@@ -36,7 +43,7 @@ declare const useCollectionsActions: <RESOURCE extends (string | queryable_resou
             limit: number;
             vql: string;
             expand?: import('@storecraft/core/api').ExpandQuery<T>;
-            vqlParsed?: import("@storecraft/core/vql").VQL.AST;
+            __vql_as_string?: string;
             sortBy?: import('@storecraft/core/api').SortCursor<T>;
             order?: import('@storecraft/core/api').SortOrder;
             equals?: import('@storecraft/core/api').Cursor<T>;