@spiffcommerce/core 10.2.0 → 10.3.1

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, TextFillImage, 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 { 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, TextFillImage, 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, Theme as _Theme1, 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, Theme } from "@spiffcommerce/papyrus";
 import { ApolloClient } from "@apollo/client";
 import React, { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
@@ -699,6 +699,10 @@ export interface Transaction {
     bulkSourceUrl?: string;
     bulkEmailAddress?: string;
     lastSyncedAt?: string;
+    /**
+     * The users who have access to this transaction.
+     */
+    stakeholders?: Stakeholder[];
 }
 interface IntegrationProduct {
     id: string;
@@ -978,6 +982,9 @@ export interface Customer {
     firstName?: string;
     lastName?: string;
     phoneNumber?: string;
+    loginToken?: string;
+    partner?: Partner;
+    stakeholders?: Stakeholder[];
 }
 export interface CustomerDetailsInput {
     emailAddress: string;
@@ -985,7 +992,7 @@ export interface CustomerDetailsInput {
     lastName?: string;
     phoneNumber?: string;
 }
-enum StakeholderType {
+export enum StakeholderType {
     Owner = "Owner",
     Approver = "Approver",
     Editor = "Editor",
@@ -1864,18 +1871,39 @@ export class SpiffCommerceClient {
     getAssetManager(): AssetManager;
     getCurrencyCode(): string;
     /**
-     * Initialize the client from an integration product.
-     * @param integrationProductId The integration product to use.
-     * @deprecated Use getWorkflowExperience to initialize the experience.
+     * Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
+     * @param transactionId The ID of the transaction that the user is attempting to load.
+     * @returns An object containing the following:
+     * - `customLogoLink`: A link to a custom logo to display in the header.
+     * - `transactionReadOnly`: Whether or not the transaction is read-only. Shadow will not accept any changes to the transaction if this is set to true.
+     * - `stakeholderType`: The type of stakeholder that the user is authenticated as.
+     * - `success`: Whether or not the authentication was successful.
+     * @throws An error if the transaction is not found.
+     */
+    loadTransactionAuth(transactionId: string): Promise<{
+        customLogoLink?: string;
+        transactionReadOnly?: boolean;
+        stakeholderType?: StakeholderType;
+        success: boolean;
+        theme?: _Theme1;
+    }>;
+    /**
+     * Generates a verification code for the given email address. An error will be thrown if the email address is not associated with the transaction.
+     * @param transactionId The ID of the transaction that the user is attempting to load.
+     * @param emailAddress The email address to generate a verification code for. The user will be sent an email with the verification code.
      */
-    initFromIntegrationProduct(integrationProductId: string): Promise<void>;
+    generateVerificationCode(transactionId: string, emailAddress: string): Promise<void>;
     /**
-     * Initialize the client from an existing transaction.
-     * @param transactionId The id of the transaction
-     * @returns A promise resolving at initialization completion.
-     * @deprecated Use getWorkflowExperience to initialize the experience.
+     * Verifies the given email address with the given verification code.
+     * @param transactionId The ID of the transaction that the user is attempting to load.
+     * @param emailAddress The email address to verify.
+     * @param verificationCode The verification code to verify the email address with.
+     * @returns An object containing the success status of the verification attempt, and a stakeholder type if the verification was successful.
      */
-    initFromTransaction(transactionId: string, readOnly?: boolean): Promise<void>;
+    verifyCode(transactionId: string, emailAddress: string, verificationCode: string): Promise<{
+        success: boolean;
+        stakeholderType?: StakeholderType;
+    }>;
     /**
      * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
      * @param workflowId The id of the workflow to be run. Deprecated: Provide options instead.
@@ -1885,6 +1913,19 @@ export class SpiffCommerceClient {
      * @returns A workflow experience configured as requested.
      */
     getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: _Workflow1) => any, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
+    /**
+     * Initialize the client from an integration product.
+     * @param integrationProductId The integration product to use.
+     * @deprecated Use getWorkflowExperience to initialize the experience.
+     */
+    initFromIntegrationProduct(integrationProductId: string): Promise<void>;
+    /**
+     * Initialize the client from an existing transaction.
+     * @param transactionId The id of the transaction
+     * @returns A promise resolving at initialization completion.
+     * @deprecated Use getWorkflowExperience to initialize the experience.
+     */
+    initFromTransaction(transactionId: string, readOnly?: boolean): Promise<void>;
     /**
      * @returns The preview service that was provided during construction.
      */
@@ -1997,6 +2038,6 @@ export class FrameStepHandle extends StepHandle<_FrameStepData1> {
 export const TransformWrapper: React.FunctionComponent;
 export { CommandContext };
 export { AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, CanvasCommand, CreateElementCommand, CreateLayoutCommand, DeleteElementCommand, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, GroupCommand, LayoutElementFactory, LayoutElementType, MoveCommand, ResizeCommand, RotateCommand, SendBackwardsCommand, StepAspectType, StepType, TextChangeCommand, UnitOfMeasurement, dataUrlFromExternalUrl, findElement, frameDataCache, generate, getAxisAlignedBoundingBox, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, rehydrateSerializedLayout, getFrameData, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, determineCorrectFontSizeAndLines, patternImageDataCache, registerJSDOM };
-export { Animatable, AnyStepData, Asset, BulkStepData, ColorProfileProps, ColorDefinition, CommandState, WorkflowPanel, DigitalContentStepData, FrameElement, FrameStepData, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, OptionResource, PictureStepData, QuestionStepData, ShapeStepData, Step, StepAspect, StepStorage, TextStepData, TextboxElement, VariantResource, Workflow };
+export { Animatable, AnyStepData, Asset, BulkStepData, ColorProfileProps, ColorDefinition, CommandState, WorkflowPanel, DigitalContentStepData, FrameElement, FrameStepData, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, OptionResource, PictureStepData, QuestionStepData, ShapeStepData, Step, StepAspect, StepStorage, TextStepData, TextboxElement, Theme, VariantResource, Workflow };
 
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "10.2.0",
+    "version": "10.3.1",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -87,7 +87,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "^2.0.3",
+        "@spiffcommerce/papyrus": "^2.0.4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",
         "lodash.clonedeep": "^4.5.0",