@spiffcommerce/core 16.4.3 → 16.5.0-rc.0

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
@@ -67,6 +67,7 @@ interface WorkflowScene {
67
67
  /**
68
68
  * Steps which don't display to the user.
69
69
  * Their behavior is always silent & executed in the background.
70
+ * @deprecated Silent steps are no longer handled seperately from normal steps.
70
71
  */
71
72
  silentSteps: Step<AnyStepData>[];
72
73
  }
@@ -1375,6 +1376,9 @@ interface ExperienceOptions {
1375
1376
  product: Product;
1376
1377
  transaction: Transaction;
1377
1378
  workflow?: Workflow;
1379
+ /**
1380
+ * @deprecated favor inject / eject functions.
1381
+ */
1378
1382
  previewService?: ThreeDPreviewService;
1379
1383
  modelContainer?: ModelContainer;
1380
1384
  renderableContextService?: LayoutPreviewService;
@@ -1390,8 +1394,15 @@ interface ExperienceOptions {
1390
1394
  stateMutationFunc: StateMutationFunc;
1391
1395
  /**
1392
1396
  * Should be set to true when the experience is loaded from an existing transaction.
1397
+ * FIXME: Wouldn't we know this from existance of reloadedState
1393
1398
  */
1394
1399
  isReloadedTransaction?: boolean;
1400
+ /**
1401
+ * When true the system will treat steps with
1402
+ * a single variant as renderable. False
1403
+ * by default.
1404
+ */
1405
+ singleVariantsRenderable?: boolean;
1395
1406
  }
1396
1407
  /**
1397
1408
  * A Workflow experience encapsulates the workflow manager and command context. It
@@ -2118,6 +2129,18 @@ interface GetWorkflowOptionsBase {
2118
2129
  * An existing preview service to use, instead of creating a new one.
2119
2130
  */
2120
2131
  previewService?: ThreeDPreviewService;
2132
+ /**
2133
+ * Coniguration related to the
2134
+ * workflow and how the system interprets it.
2135
+ */
2136
+ workflowConfiguration?: {
2137
+ /**
2138
+ * False by default, when true the system will treat
2139
+ * steps with a single variant
2140
+ * as being renderable.
2141
+ */
2142
+ singleVariantsRenderable?: boolean;
2143
+ };
2121
2144
  /**
2122
2145
  * Configuration for the graphQL request made for workflows. Allows for retrieval
2123
2146
  * of additional data.