@spiffcommerce/core 0.10.81 → 0.10.83
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.
- package/dist/main.js +1 -1
- package/dist/module.js +1 -1
- package/dist/types.d.ts +37 -0
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -1284,6 +1284,32 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
|
|
|
1284
1284
|
getRegions(): import("@spiffcommerce/papyrus").Region[];
|
|
1285
1285
|
}
|
|
1286
1286
|
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>;
|
|
1287
|
+
interface SavedDesign {
|
|
1288
|
+
/**
|
|
1289
|
+
* The user's name for this saved design.
|
|
1290
|
+
*/
|
|
1291
|
+
title: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* A URL pointing to an image of the design.
|
|
1294
|
+
*/
|
|
1295
|
+
thumbnail: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* The ID of the transaction relating to this design.
|
|
1298
|
+
*/
|
|
1299
|
+
transactionId: string;
|
|
1300
|
+
/**
|
|
1301
|
+
* The product ID for this transaction.
|
|
1302
|
+
*/
|
|
1303
|
+
productId: string;
|
|
1304
|
+
/**
|
|
1305
|
+
* The name of the workflow annotated at time of save (may be different from current workflow name).
|
|
1306
|
+
*/
|
|
1307
|
+
workflowName: string;
|
|
1308
|
+
/**
|
|
1309
|
+
* The last edit that occured on this saved design.
|
|
1310
|
+
*/
|
|
1311
|
+
lastEdited: Date;
|
|
1312
|
+
}
|
|
1287
1313
|
/**
|
|
1288
1314
|
* A Workflow experience encapsulates the workflow manager and command context. It
|
|
1289
1315
|
* provides a simplified interface for interacting with the workflow manager. You
|
|
@@ -1330,6 +1356,17 @@ export interface WorkflowExperience {
|
|
|
1330
1356
|
* @param scene The scene you want the steps for.
|
|
1331
1357
|
*/
|
|
1332
1358
|
getStepsByScene(scene: StepGroup): StepHandle<_AnyStepData1>[];
|
|
1359
|
+
/**
|
|
1360
|
+
* Saves this experience to storage. This may be local or remote depending
|
|
1361
|
+
* on configuration.
|
|
1362
|
+
* @param title The title for the saved design.
|
|
1363
|
+
*/
|
|
1364
|
+
save(title: string): Promise<SavedDesign>;
|
|
1365
|
+
/**
|
|
1366
|
+
* Returns a copy of the currently loaded design as a new, seperated workflow experience with
|
|
1367
|
+
* a fresh transaction.
|
|
1368
|
+
*/
|
|
1369
|
+
copy(): Promise<WorkflowExperience>;
|
|
1333
1370
|
/**
|
|
1334
1371
|
* Creates a data URL preview for the current design.
|
|
1335
1372
|
*/
|