@spiffcommerce/core 0.10.255 → 1.1.0

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, Asset as _Asset1, Region, VariantResource as _VariantResource1, FrameOffsets, PatternImageData, DigitalContentStepData as _DigitalContentStepData1, LayoutsState as _LayoutsState1, CanvasCommand as _CanvasCommand1, FrameStepData as _FrameStepData1, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, FrameElement as _FrameElement1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, IllustrationElement as _IllustrationElement1, LayoutData as _LayoutData1, MaterialStepData as _MaterialStepData1, ModelStepData as _ModelStepData1, ModuleStepData as _ModuleStepData1, PictureStepData as _PictureStepData1, QuestionStepData as _QuestionStepData1, ShapeStepData as _ShapeStepData1, FontData, GroupCommand as _GroupCommand1, OptionResource as _OptionResource1, TextboxElement as _TextboxElement1, TextStepData as _TextStepData1, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, CommandContext as _CommandContext1, LayoutState, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, StepGroup, FrameData as _FrameData1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, BulkStepData, CanvasCommand, ColorDefinition, CommandContext, CommandState, CreateElementCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, MoveCommand, OptionResource, PictureStepData, QuestionStepData, ResizeCommand, RotateCommand, SendBackwardsCommand, ShapeStepData, Step, StepAspect, StepAspectType, StepStorage, StepType, TextChangeCommand, TextStepData, TextboxElement, UnitOfMeasurement, VariantResource, Workflow, dataUrlFromExternalUrl, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getFrameData, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, CreateLayoutCommand, rehydrateSerializedLayout, ColorProfileProps, WorkflowPanel, determineCorrectFontSizeAndLines, registerJSDOM, getAxisAlignedBoundingBox } from "@spiffcommerce/papyrus";
+import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, Asset as _Asset1, Region, VariantResource as _VariantResource1, FrameOffsets, PatternImageData, DigitalContentStepData as _DigitalContentStepData1, LayoutsState as _LayoutsState1, CanvasCommand as _CanvasCommand1, FrameStepData as _FrameStepData1, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, FrameElement as _FrameElement1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, IllustrationElement as _IllustrationElement1, LayoutData as _LayoutData1, MaterialStepData as _MaterialStepData1, ModelStepData as _ModelStepData1, ModuleStepData as _ModuleStepData1, PictureStepData as _PictureStepData1, QuestionStepData as _QuestionStepData1, ShapeStepData as _ShapeStepData1, FontData, GroupCommand as _GroupCommand1, OptionResource as _OptionResource1, TextboxElement as _TextboxElement1, TextStepData as _TextStepData1, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, CommandContext as _CommandContext1, LayoutState, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, FrameData as _FrameData1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, BulkStepData, CanvasCommand, ColorDefinition, CommandContext, CommandState, CreateElementCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, MoveCommand, OptionResource, PictureStepData, QuestionStepData, ResizeCommand, RotateCommand, SendBackwardsCommand, ShapeStepData, Step, StepAspect, StepAspectType, StepStorage, StepType, TextChangeCommand, TextStepData, TextboxElement, UnitOfMeasurement, VariantResource, Workflow, dataUrlFromExternalUrl, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getFrameData, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, CreateLayoutCommand, rehydrateSerializedLayout, ColorProfileProps, WorkflowPanel, determineCorrectFontSizeAndLines, registerJSDOM, getAxisAlignedBoundingBox } from "@spiffcommerce/papyrus";
 import { ApolloClient } from "@apollo/client";
 import React, { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
@@ -492,6 +492,11 @@ export interface WorkflowManager {
     getWorkflowMetadata: () => WorkflowMetadata;
     getInformationResults(): InformationResult[];
     getTransaction: () => Transaction;
+    getTransactionCustomer: () => Customer | undefined;
+    setTransactionCustomer: (customer: Customer) => void;
+    /**
+     * @deprecated Use setTransactionCustomer instead.
+     */
     setTransactionCustomerDetails: (details: {
         email: string;
     }) => void;
@@ -935,8 +940,15 @@ export enum ConversionLocation {
 /**
  * The data configured to be requested.
  */
-export enum ConversionData {
-    Email = "Email"
+export enum ConversionDataType {
+    Email = "Email",
+    FirstName = "FirstName",
+    LastName = "LastName",
+    Phone = "Phone"
+}
+export interface ConversionData {
+    type: ConversionDataType;
+    mandatory: boolean;
 }
 /**
  * The configuration for conversion, exposed on products currently.
@@ -948,6 +960,34 @@ export interface ConversionConfiguration {
     requestedData: ConversionData[];
     mandatory?: boolean;
 }
+/**
+ * Someone who has used a workflow experience and entered their contact details.
+ */
+export interface Customer {
+    id?: string;
+    emailAddress: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+}
+export interface CustomerDetailsInput {
+    emailAddress: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+}
+enum StakeholderType {
+    Owner = "Owner",
+    Approver = "Approver",
+    Editor = "Editor",
+    Viewer = "Viewer"
+}
+export interface Stakeholder {
+    id: string;
+    type?: StakeholderType;
+    transaction?: Transaction;
+    customer?: Customer;
+}
 interface StorageService {
     /**
      * Get a value.
@@ -1536,6 +1576,23 @@ declare class DesignService {
     removeDesign(transactionId: string): Promise<void>;
 }
 export const designService: DesignService;
+/**
+ * A scene is a collection of steps that can be used to group steps together.
+ */
+interface Scene {
+    /**
+     * The unique identifier for the scene.
+     */
+    id?: string;
+    /**
+     * The name of the scene.
+     */
+    name: string;
+    /**
+     * The steps that are part of the scene. A list of ids. See getStepById.
+     */
+    stepIds: string[];
+}
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
  * provides a simplified interface for interacting with the workflow manager. You
@@ -1585,15 +1642,21 @@ export interface WorkflowExperience {
      * Returns all steps that are children of a given scene.
      * @param scene The scene you want the steps for.
      */
-    getStepsByScene(scene: StepGroup): StepHandle<_AnyStepData1>[];
+    getStepsByScene(scene: Scene): StepHandle<_AnyStepData1>[];
     /**
      * Returns all steps in the workflow that are currently active. Ordered by scene and appearance within their respective scenes.
      */
     getSteps(): StepHandle<_AnyStepData1>[];
+    /**
+     * Returns a list of scenes that are configured in the workflow. Each scene
+     * contains a list of steps. See getStepsByScene to access these.
+     */
+    getScenes(): Scene[];
     /**
      * Attach specific details about the customer to the experience. This is useful for things like retargeting. Currently only
      * email is supported. From SpiffCommerce hosted experiences these details will be attached whenever the customer has provided & given permission.
      * @param details The new customer details. Only email is supported.
+     * @deprecated Use assignCustomerDetails instead.
      */
     attachCustomerDetails(details: {
         /**
@@ -1601,6 +1664,12 @@ export interface WorkflowExperience {
          */
         email: string;
     }): Promise<void>;
+    /**
+     * Attach specific details about the customer to the experience. This is useful for things like retargeting.
+     * From SpiffCommerce hosted experiences these details will be attached whenever the customer has provided & given permission.
+     * @param details The new customer details.
+     */
+    assignCustomerDetails(details: CustomerDetailsInput): Promise<void>;
     /**
      * Attaches a listener to the scenes on a workflow experience. The scenes returned are a subset of the scenes configured in the
      * workflow and are based on the current state of the experience. This is useful for building a navigation menu.
@@ -1740,6 +1809,8 @@ export class MockWorkflowManager implements WorkflowManager {
     getTransaction(): {
         id: string;
     };
+    getTransactionCustomer(): undefined;
+    setTransactionCustomer(): void;
     setTransactionCustomerDetails(): void;
     getWorkflow(): {
         id: string;

package/package.json

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