@spiffcommerce/core 0.10.150 → 0.10.151

package/dist/types.d.ts

@@ -1177,42 +1177,6 @@ export const AdvancedEditor: FunctionComponent<{
     onElementSelected?: (id: string | undefined, element: PointerEvent) => void;
     onDragEnd?: () => void;
 }>;
-export const createDesign: (workflowManager: WorkflowManager, workflow: _Workflow1, layouts: _ILayout1[], getReducerState: () => _CommandState1, product: Product, transaction: Transaction, workflowSelections: WorkflowSelections, designName: string, onProgressUpdate: DesignCreationProgressUpdate, updateVariationRecords: (variationRecords: VariationRecord[]) => Promise<void>, variationRecords: VariationRecord[], createPreviewImage: (shouldRender3D?: boolean) => Promise<string>, workflowMetadata?: WorkflowMetadata) => Promise<DesignCreationMessage>;
-export interface SavedDesign {
-    /**
-     * The user's name for this saved design.
-     */
-    title: string;
-    /**
-     * A URL pointing to an image of the design. Typically a data URL
-     */
-    thumbnail?: string;
-    /**
-     * The ID of the transaction relating to this design.
-     */
-    transactionId: string;
-    /**
-     * The product ID for this transaction.
-     */
-    productId: string;
-    /**
-     * The integration product ID related to this order.
-     */
-    integrationProductId: string;
-    /**
-     * The name of the workflow annotated at time of save (may be different from current workflow name).
-     */
-    workflowName: string;
-    /**
-     * The ID of the workflow annotated at time of save.
-     */
-    workflowId: string;
-    /**
-     * The last edit that occured on this saved design.
-     */
-    lastEdited: Date;
-}
-export default designService;
 /**
  * A StepHandle allows for managing the state of a specific step in a workflow. This class
  * abstracts away the complexities of dealing with a step directly and allows for using high level
@@ -1389,6 +1353,76 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
     hasVaryingSelection(): boolean | undefined;
     getRegions(): import("@spiffcommerce/papyrus").Region[];
 }
+export const createDesign: (workflowManager: WorkflowManager, workflow: _Workflow1, layouts: _ILayout1[], getReducerState: () => _CommandState1, product: Product, transaction: Transaction, workflowSelections: WorkflowSelections, designName: string, onProgressUpdate: DesignCreationProgressUpdate, updateVariationRecords: (variationRecords: VariationRecord[]) => Promise<void>, variationRecords: VariationRecord[], createPreviewImage: (shouldRender3D?: boolean) => Promise<string>, workflowMetadata?: WorkflowMetadata) => Promise<DesignCreationMessage>;
+export interface SavedDesign {
+    /**
+     * The user's name for this saved design.
+     */
+    title: string;
+    /**
+     * A URL pointing to an image of the design. Typically a data URL
+     */
+    thumbnail?: string;
+    /**
+     * The ID of the transaction relating to this design.
+     */
+    transactionId: string;
+    /**
+     * The product ID for this transaction.
+     */
+    productId: string;
+    /**
+     * The integration product ID related to this order.
+     */
+    integrationProductId: string;
+    /**
+     * The name of the workflow annotated at time of save (may be different from current workflow name).
+     */
+    workflowName: string;
+    /**
+     * The ID of the workflow annotated at time of save.
+     */
+    workflowId: string;
+    /**
+     * The last edit that occured on this saved design.
+     */
+    lastEdited: Date;
+}
+/**
+ * The design service exposes helper functionality wrapping important design management operations.
+ * NOTE: In the future this interface should allow for storing/pulling designs from the server.
+ */
+declare class DesignService {
+    /**
+     * @param func The function to call when a design is saved.
+     */
+    attachSaveListener(func: (design: SavedDesign) => void): void;
+    /**
+     * @param func The function to remove from the list of listeners.
+     */
+    detachSaveListener(func: (design: SavedDesign) => void): void;
+    /**
+     * Gets the currently persisted designs.
+     */
+    getSavedDesigns(): Promise<SavedDesign[]>;
+    /**
+     * Search for a transaction that has been saved.
+     * @param transactionId The id to search for.
+     * @returns The transaction for the given id provided it has been saved. undefined if it doesn't exist.
+     */
+    getSavedDesignByTransaction(transactionId: string): Promise<SavedDesign | undefined>;
+    /**
+     * Saves a design to storage.
+     * @param design The design to save.
+     */
+    addDesign(design: SavedDesign): Promise<void>;
+    /**
+     * Removes a given design from storage.
+     * @param transactionId
+     */
+    removeDesign(transactionId: string): Promise<void>;
+}
+export const designService: DesignService;
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
  * provides a simplified interface for interacting with the workflow manager. You

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.10.150",
+    "version": "0.10.151",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",