@spiffcommerce/core 16.0.0-beta.8 → 16.0.0

package/dist/index.d.ts

@@ -1097,7 +1097,7 @@ declare class Variant {
      */
     getAssetResource(): Asset | undefined;
     /**
-     * @returns The URL for a thumbnail resource configured on this variant. When no thumbnail is configured explicitly we fall back to the base asset and see if a thumbnail is genererated for that.
+     * @returns The URL for a thumbnail resource configured on this variant.
      */
     getThumbnail(): string | undefined;
     /**
@@ -1536,6 +1536,7 @@ declare abstract class GlobalPropertyHandle {
 }
 
 interface GlobalPropertyStateManager {
+    getInitializationPromise(): Promise<void>;
     getGlobalPropertyState(): GlobalPropertyState | undefined;
     getAspect(name: string): string | undefined;
     setAspect(name: string, value: string): Promise<void>;
@@ -1793,8 +1794,70 @@ interface WorkflowExperienceHoverEventData {
     workflowExperience: WorkflowExperience;
 }
 
+/**
+ * A list of node types available in executions
+ */
+declare enum NodeType {
+    Split = "Split",
+    TextJoin = "TextJoin",
+    TextSlice = "TextSlice",
+    TextUpper = "TextUpper",
+    TextLower = "TextLower",
+    ParseJson = "ParseJson",
+    TextBuilder = "TextBuilder",
+    Design = "Design",
+    OverlayImage = "OverlayImage",
+    OverlayText = "OverlayText",
+    TableGenerator = "TableGenerator",
+    QR = "QR",
+    CSV = "CSV",
+    PDF = "PDF",
+    PNG = "PNG",
+    Email = "Email",
+    LocationDelivery = "LocationDelivery",
+    TemplateEmail = "TemplateEmail",
+    Map = "Map",
+    Sort = "Sort",
+    Group = "Group",
+    InnerJoin = "InnerJoin",
+    Contains = "Contains",
+    Flatten = "Flatten",
+    KeyValuePairs = "KeyValuePairs",
+    ListConcatenate = "ListConcatenate",
+    Repeat = "Repeat",
+    Size = "Size",
+    ListBuilder = "ListBuilder",
+    MapBuilder = "MapBuilder",
+    PairBuilder = "PairBuilder",
+    AND = "AND",
+    OR = "OR",
+    NOT = "NOT",
+    Equals = "Equals",
+    Present = "Present",
+    ManualOperation = "ManualOperation",
+    Switch = "Switch",
+    AssetMetadata = "AssetMetadata",
+    DataSelect = "DataSelect",
+    LayoutSelect = "LayoutSelect",
+    TransactionMetadata = "TransactionMetadata",
+    VariantSelection = "VariantSelection",
+    StartTerminal = "StartTerminal",
+    EndTerminal = "EndTerminal",
+    MiscNote = "MiscNote",
+    Assign = "Assign",
+    CsvVlookup = "CsvVlookup",
+    ProcessFlow = "ProcessFlow",
+    TemporaryAssetUrl = "TemporaryAssetUrl",
+    WebRequest = "WebRequest"
+}
+interface ExecutionNodeResponse {
+    id: string;
+    type: NodeType;
+    artifacts: string;
+}
 interface ExecutionResponse {
     id: string;
+    nodes: ExecutionNodeResponse[];
     completedAt?: string;
     failedAt?: string;
 }
@@ -1802,9 +1865,64 @@ interface ExecutionResponse {
  * A service containing functionality for interacting with the Spiff Commerce API to execute and inspect the result of process flows.
  */
 declare class FlowService {
+    /**
+     *
+     * @param id
+     * @param inputs
+     * @param options
+     * @returns
+     */
     execute(id: string, inputs: FlowExecutionInput[], options?: {
-        sleepTime: number;
-    }): Promise<ExecutionResponse>;
+        sleepTime?: number;
+        repeats?: number;
+    }): Promise<FlowExecutionResult>;
+}
+/**
+ * Handles preparing a flow input for transmission to the server.
+ */
+declare class FlowExecutionResult {
+    protected readonly execution: ExecutionResponse;
+    constructor(execution: ExecutionResponse);
+    /**
+     * @returns The raw response from the server.
+     */
+    getRaw(): ExecutionResponse;
+    /**
+     * @returns The nodes contained within the execution.
+     */
+    getNodes(): FlowExecutionNodeResult[];
+    /**
+     * @param type The type of node to return.
+     * @returns A list of nodes matching the requested type.
+     */
+    getNodesByType(type: NodeType): FlowExecutionNodeResult[];
+    /**
+     * @returns A list of input nodes that exist in this execution.
+     */
+    getInputs(): FlowExecutionNodeResult[];
+    /**
+     * @returns A list of out put nodes that exist in this execution.
+     */
+    getOutputs(): FlowExecutionNodeResult[];
+    /**
+     * @returns A date object representing the point in time this execution completed.
+     */
+    getCompletedAt(): Date | undefined;
+    /**
+     * @returns A date object representing the point in time this execution failed.
+     */
+    getFailedAt(): Date | undefined;
+}
+/**
+ * Handles preparing a flow input for transmission to the server.
+ */
+declare class FlowExecutionNodeResult {
+    protected readonly node: ExecutionNodeResponse;
+    constructor(node: ExecutionNodeResponse);
+    getId(): string;
+    getType(): NodeType;
+    getArtifacts(): Map<string, any>;
+    getArtifactByName<T>(name: string): T;
 }
 /**
  * Handles preparing a flow input for transmission to the server.
@@ -1834,12 +1952,6 @@ declare class ObjectInput extends FlowExecutionInput {
     constructor(id: string, type: ObjectInputType);
     static validUUID(uuid: string): RegExpMatchArray | null;
 }
-/**
- * Handles validation of text input for transmission to the server.
- */
-declare class TextInput extends FlowExecutionInput {
-    constructor(id: string);
-}
 
 declare const getWorkflows: (ids: string[], options?: GetWorkflowGraphqlOptions) => Promise<Workflow[]>;
 declare const getWorkflow: (id: string, options?: GetWorkflowGraphqlOptions) => Promise<Workflow>;
@@ -2654,4 +2766,4 @@ interface StepAspectValue {
 declare const stepAspectValuesToDesignInputSteps: (stepAspectValues: StepAspectValue[], workflow: Workflow) => DesignInputStep[];
 declare const generateStateFromDesignInputSteps: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<LayoutsState>;
 
-export { AssetNotFoundError, BulkPriceCalculationStrategy, BulkStepHandle, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FrameService, FrameStep, FrameStepHandle, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, UnhandledBehaviorError, Variant, VariationRecord, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, gatherVaryingStepAspects, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+export { AssetNotFoundError, BulkPriceCalculationStrategy, BulkStepHandle, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextStepHandle, TextStepStorage, Transaction, UnhandledBehaviorError, Variant, VariationRecord, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, gatherVaryingStepAspects, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };