@spiffcommerce/core 15.2.4 → 15.3.1

package/dist/types.d.ts

@@ -2350,18 +2350,135 @@ interface ConditionalGlobalPropertiesChangedEventData {
 interface WorkflowExperienceHoverEventData {
     workflowExperience: WorkflowExperience;
 }
+/**
+ * A list of node types available in executions
+ */
+export 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;
 }
 /**
  * A service containing functionality for interacting with the Spiff Commerce API to execute and inspect the result of process flows.
  */
-declare class FlowService {
+export 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.
+ */
+export 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.
+ */
+export 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.

package/package.json

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