@spiffcommerce/core 0.10.82 → 0.10.84

package/dist/types.d.ts

@@ -1156,6 +1156,33 @@ export const AdvancedEditor: FunctionComponent<{
     onMouseMove?: (event: React.MouseEvent<SVGRectElement, MouseEvent>) => void;
     onElementSelected?: (id: string | undefined, element: PointerEvent) => 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.
+     */
+    thumbnail: string;
+    /**
+     * The ID of the transaction relating to this design.
+     */
+    transactionId: string;
+    /**
+     * The product ID for this transaction.
+     */
+    productId: string;
+    /**
+     * The name of the workflow annotated at time of save (may be different from current workflow name).
+     */
+    workflowName: string;
+    /**
+     * The last edit that occured on this saved design.
+     */
+    lastEdited: Date;
+}
 /**
  * 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
@@ -1283,7 +1310,6 @@ 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>;
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
  * provides a simplified interface for interacting with the workflow manager. You
@@ -1335,7 +1361,7 @@ export interface WorkflowExperience {
      * on configuration.
      * @param title The title for the saved design.
      */
-    save(title: string): Promise<void>;
+    save(title: string): Promise<SavedDesign>;
     /**
      * Returns a copy of the currently loaded design as a new, seperated workflow experience with
      * a fresh transaction.
@@ -1382,6 +1408,15 @@ interface ClientOptions {
  */
 export class SpiffCommerceClient {
     constructor(options: ClientOptions);
+    /**
+     * @returns A list of designs saved.
+     */
+    getSavedDesigns(): Promise<SavedDesign[]>;
+    /**
+     * Removes a design from storage. This will be a noop if the design isn't already saved.
+     * @param experience The workflow experience to remove from storage.
+     */
+    deleteDesign(experience: WorkflowExperience): Promise<void>;
     /**
      * Initialize the client from an integration product.
      * @param integrationProductId The integration product to use.

package/package.json

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