@commercelayer/app-elements 0.1.1 → 0.2.0

package/dist/dictionaries/customers.d.ts

@@ -0,0 +1,6 @@
+import type { Customer } from '@commercelayer/sdk';
+import type { DisplayStatus } from './types';
+export interface CustomerDisplayStatus extends DisplayStatus {
+}
+export declare function getCustomerDisplayStatus(customerObj: Customer): CustomerDisplayStatus;
+export declare function getCustomerStatusName(status: Customer['status']): string;

package/dist/dictionaries/orders.d.ts

@@ -1,8 +1,9 @@
-import { type TriggerAttribute } from '../helpers/resources';
-import { type IconProps } from '../ui/atoms/Icon';
+import type { TriggerAttribute } from '../helpers/resources';
+import type { IconProps } from '../ui/atoms/Icon';
 import type { Order, OrderUpdate } from '@commercelayer/sdk';
+import type { DisplayStatus } from './types';
 type UITriggerAttributes = Extract<TriggerAttribute<OrderUpdate>, '_approve' | '_cancel' | '_capture' | '_refund' | '_archive' | '_unarchive'> | '_return';
-interface OrderDisplayStatus {
+export interface OrderDisplayStatus extends DisplayStatus {
     label: string;
     icon: IconProps['name'];
     color: IconProps['background'];

package/dist/dictionaries/returns.d.ts

@@ -0,0 +1,16 @@
+import type { TriggerAttribute } from '../helpers/resources';
+import { type IconProps } from '../ui/atoms/Icon';
+import type { Return, ReturnUpdate } from '@commercelayer/sdk';
+import type { DisplayStatus } from './types';
+type UITriggerAttributes = Extract<TriggerAttribute<ReturnUpdate>, '_approve' | '_cancel' | '_ship' | '_reject' | '_receive' | '_restock' | '_archive' | '_unarchive'>;
+export interface ReturnDisplayStatus extends DisplayStatus {
+    label: string;
+    icon: IconProps['name'];
+    color: IconProps['background'];
+    task?: string;
+    triggerAttributes: UITriggerAttributes[];
+}
+export declare function getReturnDisplayStatus(returnObj: Return): ReturnDisplayStatus;
+export declare function getReturnStatusName(status: Return['status']): string;
+export declare function getReturnTriggerAttributeName(triggerAttribute: UITriggerAttributes): string;
+export {};

package/dist/dictionaries/types.d.ts

@@ -0,0 +1,7 @@
+import { type IconProps } from '../ui/atoms/Icon';
+export interface DisplayStatus {
+    label: string;
+    icon: IconProps['name'];
+    color: IconProps['background'];
+    task?: string;
+}

package/dist/helpers/appsNavigation.d.ts

@@ -23,7 +23,7 @@ export declare function goBack({ setLocation, defaultRelativePath }: {
      */
     defaultRelativePath: string;
 }): void;
-interface NavigateToInternalDetailsParams {
+interface NavigateToInternalParams {
     /**
      * React router's history.push method, this is used when linking internal app pages.
      */
@@ -39,10 +39,10 @@ interface NavigateToInternalDetailsParams {
         /**
          * resource id to open
          */
-        resourceId: string;
+        resourceId?: string;
     };
 }
-interface NavigateToExternalDetailsParams {
+interface NavigateToExternalParams {
     /**
      * destination instructions to navigate to a detail page
      */
@@ -54,7 +54,7 @@ interface NavigateToExternalDetailsParams {
         /**
          * resource id to open
          */
-        resourceId: string;
+        resourceId?: string;
         /**
          * required when linking to another app, it indicates if the destination app should be opened in test or live mode
          */
@@ -65,7 +65,7 @@ interface NavigateToExternalDetailsParams {
  * Navigate to an internal or external URL or pathname and store the current url in sessionStorage
  * to be able to navigate back to it with the `goBack` function.
  */
-export declare function navigateToDetail(params: NavigateToInternalDetailsParams | NavigateToExternalDetailsParams): {
+export declare function navigateTo(params: NavigateToInternalParams | NavigateToExternalParams): {
     href: string;
     onClick: (e: React.MouseEvent<HTMLAnchorElement | HTMLDivElement, MouseEvent>) => void;
 } | null;