@spiffcommerce/core 0.10.50 → 0.10.52

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/types.d.ts CHANGED
@@ -24,10 +24,28 @@ declare class GraphQlManager {
24
24
  getShadowGraphqlClient(): ApolloClient<any>;
25
25
  }
26
26
  export const graphQlManager: GraphQlManager;
27
+ /**
28
+ * Information parsed froma workflow structure that is relevant
29
+ * to a given scene.
30
+ */
27
31
  export interface WorkflowScene {
32
+ /**
33
+ * A unique identifier for the scene.
34
+ */
28
35
  name: string;
36
+ /**
37
+ * A human-readable title for the scene.
38
+ */
29
39
  title: string;
40
+ /**
41
+ * Steps which can display to the user.
42
+ * But may be conditionally hidden based on workflow logic
43
+ */
30
44
  renderableSteps: _Step1<_AnyStepData1>[];
45
+ /**
46
+ * Steps which don't display to the user.
47
+ * Their behavior is always silent & executed in the background.
48
+ */
31
49
  silentSteps: _Step1<_AnyStepData1>[];
32
50
  }
33
51
  /**
@@ -462,6 +480,7 @@ export interface WorkflowManager {
462
480
  getTransaction: () => Transaction;
463
481
  getWorkflow: () => _Workflow1;
464
482
  getWorkflowSelections: () => WorkflowSelections;
483
+ getProduct: () => Product;
465
484
  /**
466
485
  * A promise resolving when the initial state of the workflow has completed loading.
467
486
  */
@@ -1297,6 +1316,7 @@ export class Client {
1297
1316
  }
1298
1317
  export class MockWorkflowManager implements WorkflowManager {
1299
1318
  getInitializationPromise(): Promise<void>;
1319
+ getProduct: () => Product;
1300
1320
  isInitialized(): boolean;
1301
1321
  getCommandContext: () => _CommandContext1;
1302
1322
  getAllLayoutData: () => LayoutState[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spiffcommerce/core",
3
- "version": "0.10.50",
3
+ "version": "0.10.52",
4
4
  "description": "Core client API for interacting with the Spiff Commerce backend.",
5
5
  "source": "src/index.ts",
6
6
  "main": "dist/main.js",
@@ -80,7 +80,7 @@
80
80
  },
81
81
  "dependencies": {
82
82
  "@apollo/client": "^3.7.0",
83
- "@spiffcommerce/papyrus": "^1.5.18",
83
+ "@spiffcommerce/papyrus": "^1.5.19",
84
84
  "canvg": "https://github.com/spiffdev/canvg.git#03bcd151b12441e88ecb552bb658356f5bbe92c4",
85
85
  "cross-fetch": "^3.1.5",
86
86
  "graphql": "^16.6.0",