@spiffcommerce/core 0.10.174 → 0.10.175

package/dist/types.d.ts

@@ -659,11 +659,19 @@ export interface DesignCreationMessage {
  * Represents a transaction.
  */
 export interface Transaction {
+    /**
+     * A unique identifier for this transaction. Useful for reloading and
+     * modifying state of the transaction.
+     */
     id: string;
     /**
      * User-supplied name for the associated design.
      */
     designName?: string;
+    /**
+     * When true the transaction is a bulk transaction & will allow for modifying
+     * variations based on bulk configuration on the workflow.
+     */
     bulk?: boolean;
     /**
      * The workflow associated with this transaction.
@@ -1234,12 +1242,26 @@ export abstract class StepHandle<T extends _AnyStepData1> {
 }
 export class BulkStepHandle extends StepHandle<_BulkStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_BulkStepData1>);
+    /**
+     * @param variant The variant to select. This is not supported in the bulk step.
+     */
     selectVariant(variant: _VariantResource1): Promise<void>;
-    addVariationRecord(): void;
+    setDesignName(designName: string): Promise<void>;
+    addVariationRecord(): VariationRecord;
     updateBulkIsConnected(bulkIsConnected: boolean): void;
+    /**
+     * Opens the bulk source in a seperate tab. This bulk source could be a google sheet or a csv file.
+     */
     openBulkSourceUrl(): void;
-    sendGoogleSheetLinkToEmail(email: string): void;
-    deleteVariationRecord(): void;
+    sendGoogleSheetLinkToEmail(email: string): Promise<void>;
+    /**
+     * Removes a variation from the bulk step.
+     * @param recordNumber The record number of the variation to remove.
+     */
+    deleteVariationRecord(recordNumber: number): void;
+    /**
+     * @returns The aspects of each step that are modifiable from the bulk handle. These are configured in the workflow.
+     */
     getAspects(): import("@spiffcommerce/papyrus").StepAspect[];
 }
 export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {

package/package.json

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