@spiffcommerce/core 34.1.0-beta.3fb0da60-1da5-5e84-b959-ca75a31ba2e9 → 34.1.0-beta.5c20ac87-d494-52d7-bb93-ed7eb8ed1d81

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/index.d.ts CHANGED
@@ -1095,10 +1095,6 @@ interface WorkflowExperience {
1095
1095
  * Get the bundle this experience is part of. May be undefined.
1096
1096
  */
1097
1097
  getBundle(): Bundle$1 | undefined;
1098
- /**
1099
- * The index of this transaction against its bundle, if part of one.
1100
- */
1101
- getBundleIndex(): number | undefined;
1102
1098
  /**
1103
1099
  * Set the bundle this experience is part of. Can be cleared using undefined.
1104
1100
  */
@@ -1346,7 +1342,6 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
1346
1342
  attachAddress(streetAddress?: string, apartment?: string, city?: string, country?: string, state?: string, postCode?: string): Promise<void>;
1347
1343
  attachOrganization(name: string): Promise<void>;
1348
1344
  getBundle(): Bundle$1 | undefined;
1349
- getBundleIndex(): number | undefined;
1350
1345
  setBundle(bundle: Bundle$1): void;
1351
1346
  getClient(): SpiffCommerceClient;
1352
1347
  getIsReadOnly(): boolean;
@@ -2030,12 +2025,13 @@ interface Bundle$1 {
2030
2025
  * Finalizes all experiences within the bundle. This will return a promise that resolves when all experiences have been finalized.
2031
2026
  * The promise resolves with a list of messages that indicate the status of each experience including
2032
2027
  * helpful details like what product to add to cart on supported e-commerce platforms.
2033
- * @param onProgressUpdate A callback that will be called when the progress of the finalization changes.
2028
+ * @param onProgressUpdate Deprecated: A callback that will be called when the progress of the finalization changes.
2034
2029
  * @param createPreviewImage A callback that will be called when a preview image is required. This is used to generate a preview image for the design.
2035
2030
  * If this callback is not provided, no preview image will be generated.
2031
+ * @param onProgress A callback that will be called when using the background process method (currently in beta).
2036
2032
  * @returns {BundleDesignCreationMessage} An object containing an array of design messages, along with the Bundle's Id and the event type.
2037
2033
  */
2038
- finish(onProgressUpdate?: DesignCreationProgressUpdate, createPreviewImage?: (workflowExperience: WorkflowExperience, shouldRender3D?: boolean) => Promise<string | undefined>): Promise<BundleDesignCreationMessage>;
2034
+ finish(onProgressUpdate?: DesignCreationProgressUpdate, createPreviewImage?: (workflowExperience: WorkflowExperience, shouldRender3D?: boolean) => Promise<string | undefined>, onProgress?: (completed: number, total: number) => void): Promise<BundleDesignCreationMessage>;
2039
2035
  /**
2040
2036
  * A convenience function allowing you to place an order with all the items in the bundle.
2041
2037
  */
@@ -3774,10 +3770,6 @@ interface Transaction {
3774
3770
  * modifying state of the transaction.
3775
3771
  */
3776
3772
  id: string;
3777
- /**
3778
- * The index of this transaction against its bundle, if part of one.
3779
- */
3780
- bundleIndex?: number;
3781
3773
  /**
3782
3774
  * User-supplied name for the associated design.
3783
3775
  */
@@ -3902,6 +3894,7 @@ interface Transaction {
3902
3894
  marketplaceThemeInstallConfiguration?: ThemeInstallConfigurationGraphQl;
3903
3895
  completed?: boolean;
3904
3896
  addressValidationStatus?: AddressValidationStatus;
3897
+ design?: Design;
3905
3898
  }
3906
3899
  declare enum AddressValidationStatus {
3907
3900
  Pending = "Pending",
@@ -4266,6 +4259,14 @@ declare enum ProductCameraRig {
4266
4259
  Orbit = 0,
4267
4260
  Pan = 1
4268
4261
  }
4262
+ interface Design {
4263
+ id?: string;
4264
+ sku?: string;
4265
+ transaction?: Transaction;
4266
+ processExecution?: {
4267
+ id?: string;
4268
+ };
4269
+ }
4269
4270
  /**
4270
4271
  * Someone who has used a workflow experience and entered their contact details.
4271
4272
  */