@spiffcommerce/core 13.2.0 → 14.0.0-alpha.0

package/dist/types.d.ts

@@ -165,7 +165,13 @@ export class ParseError extends ImplementationError {
  */
 export function getBoundedOffsets(newOffsets: FrameOffsets, frameData: FrameData, imageData: PatternImageData, mustCover?: boolean): FrameOffsets;
 export class FrameService {
+    /**
+     * The calculated minimum zoom value. Note: This is calculated based on the first frame.
+     */
     minZoomScale: number;
+    /**
+     * The calculated maximum zoom value. Note: This is calculated based on the first frame.
+     */
     maxZoomScale: number;
     constructor(forceImageCover?: boolean);
     /**
@@ -185,12 +191,12 @@ export class FrameService {
      * Gets the current calculated frame data
      * @returns A FrameData object or undefined if no frame has been set.
      */
-    getFrameData(): FrameData | undefined;
+    getFrameData(): FrameData[] | undefined;
     /**
-     * Sets the current frame data
-     * @param path The path to lookup in our frame data cache.
+     * Sets the current frame data. Note:
+     * @param paths The paths to lookup in our frame data cache.
      */
-    setFrameData(path: string): Promise<void>;
+    setFrameData(paths: string[] | undefined): void;
     /**
      * Gets the currently set image of the frame..
      * @returns A PatternImageData object, or undefined if no image is set.
@@ -200,11 +206,11 @@ export class FrameService {
      * Gets the current calculated offsets of the pattern within the frame.
      * @returns A FrameOffsets object or undefined if no offsets are defined.
      */
-    getOffsets(): FrameOffsets | undefined;
+    getOffsets(): FrameOffsets[] | undefined;
     /**
      * Updates the frame offsets explicitly.
      */
-    setOffsets(offsets: FrameOffsets): void;
+    setOffsets(offsets: FrameOffsets[]): void;
     /**
      * Sets the zoom of the cropper that owns this service.
      * @param zoom The new zoom value.
@@ -220,11 +226,11 @@ export class FrameService {
     setPatternData(value: PatternImageData): void;
     /**
      * Modify the offsets of the frame.
-     * @param value The new FrameOffsets object.
+     * @param value The new FrameOffsets objects.
      * @param onComplete A callback, called when the modification is complete
      */
-    updateOffsets(value: FrameOffsets, onComplete?: () => void): void;
-    onFrameDataChanged(newListener: (frameData: FrameData | undefined) => void): void;
+    updateOffsets(value: FrameOffsets[], onComplete?: () => void): void;
+    onFrameDataChanged(newListener: (frameData: FrameData[] | undefined) => void): void;
     /**
      * Append a new listener to zoom events on this frame.
      * @param newListener
@@ -1899,7 +1905,7 @@ export enum FrameStep {
 export class FrameStepHandle extends StepHandle<_FrameStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_FrameStepData1>);
     selectVariant(variant: Variant): Promise<void>;
-    onFrameDataChanged(callback: (frameData: _FrameData1) => void): void;
+    onFrameDataChanged(callback: (frameData: _FrameData1[]) => void): void;
     selectImage(asset: _Asset1): void;
     getImageData(): PatternImageData | undefined;
     getCurrentFrameStep(frameData: _FrameData1, uploading?: any, imageUploadComplete?: any, variants?: _VariantResource1[]): FrameStep;
@@ -2067,6 +2073,53 @@ interface _Bundle1 {
     removeEventListener(event: BundleEvent, listener: () => void): void;
 }
 type BundleEvent = "conditional-global-properties-changed";
+interface ExecutionResponse {
+    id: string;
+    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 {
+    execute(id: string, inputs: FlowExecutionInput[], options?: {
+        sleepTime: number;
+    }): Promise<ExecutionResponse>;
+}
+/**
+ * Handles preparing a flow input for transmission to the server.
+ */
+declare abstract class FlowExecutionInput {
+    protected readonly value: string;
+    constructor(value: string);
+    getRaw(): string;
+    getValueForTransmission(): string;
+}
+/**
+ * Represents the type of object being referenced by the input.
+ */
+export const enum ObjectInputType {
+    Transaction = "Transaction",
+    Bundle = "Bundle",
+    Product = "Product",
+    Variant = "Variant",
+    Option = "Option",
+    LineItem = "LineItem",
+    Asset = "Asset"
+}
+/**
+ * Handles validation of spiffObject structure for transmission to the server.
+ */
+export 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.
+ */
+export class TextInput extends FlowExecutionInput {
+    constructor(id: string);
+}
 export const getWorkflow: (id: string) => Promise<_Workflow1>;
 /**
  * Options that can be used during instantiation of the SpiffCommerce Javascript Client.
@@ -2134,6 +2187,7 @@ export class SpiffCommerceClient {
      */
     getAssetManager(): AssetManager;
     getCurrencyCode(): string;
+    getFlowService(): FlowService;
     /**
      * Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
      * @param bundleId The ID of the bundle you intend to load.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "13.2.0",
+    "version": "14.0.0-alpha.0",
     "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": "^3.1.0",
+        "@spiffcommerce/papyrus": "4.0.1-alpha.1",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",
         "lodash.clonedeep": "^4.5.0",