npm - @storecraft/dashboard - Versions diffs - 1.0.38 → 1.3.0 - Mend

@storecraft/dashboard 1.0.38 → 1.3.0

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 (160) 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}/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 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}/login-form.d.ts RENAMED Viewed

@@ -5,12 +5,10 @@ export type LoginFormFieldsType = {
     endpoint?: string;
 };
 export type LoginFormProps = withDashDiv<{
-    onChange: (id: string, value: string) => void;
-    onSubmit: React.FormEventHandler<HTMLFormElement>;
-    error: object;
-    credentials: LoginFormFieldsType;
+    defaultCredentials: LoginFormFieldsType;
+    signinWithErrorHandling: (email: string, password: string, endpoint?: string) => Promise<void>;
     is_backend_endpoint_editable?: boolean;
 }>;
-declare const LoginForm: ({ dash: { onChange, onSubmit, error, credentials, is_backend_endpoint_editable, }, ...rest }: LoginFormProps) => import("react/jsx-runtime").JSX.Element;
+declare const LoginForm: ({ dash: { signinWithErrorHandling, is_backend_endpoint_editable, defaultCredentials, }, ...rest }: LoginFormProps) => import("react/jsx-runtime").JSX.Element;
 export declare const SocialLogin: ({}: {}) => import("react/jsx-runtime").JSX.Element;
 export default LoginForm;

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/hooks/use-preferences.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+export type StorecraftDashboardPreferences = {
+    darkMode?: boolean;
+};
+export declare const usePreferences: (defaultValue?: StorecraftDashboardPreferences) => {
+    state: StorecraftDashboardPreferences;
+    setState: ($state: StorecraftDashboardPreferences | ((prev: StorecraftDashboardPreferences) => StorecraftDashboardPreferences)) => void;
+};