@spiffcommerce/core 0.10.30 → 0.10.32

package/dist/types.d.ts

@@ -2,6 +2,28 @@ import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, Any
 import { ApolloClient } from "@apollo/client";
 import { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
+declare class Configuration {
+    constructor();
+    getServerUrl(): string;
+    getServicesApiUrl(): string;
+    getHubUrl(): string;
+    setServerUrl(serverUrl: string): void;
+    setServicesApiUrl(servicesApiUrl: string): void;
+    setHubUrl(hubUrl: string): void;
+    addServerUrlCallback(callback: () => void): void;
+}
+export const spiffCoreConfiguration: Configuration;
+declare class SwaggerServer implements ServerService {
+    constructor();
+    setUncachedOperations(operationIds: string[]): void;
+    execute(operationName: string, parameters?: object): Promise<ServerResponse>;
+}
+export const server: SwaggerServer;
+declare class GraphQlManager {
+    constructor();
+    getShadowGraphqlClient(): ApolloClient<any>;
+}
+export const graphQlManager: GraphQlManager;
 export interface WorkflowScene {
     name: string;
     title: string;
@@ -161,28 +183,6 @@ interface StorageService {
     setMap<K = any, V = any>(key: string, val: Map<K, V>): void;
 }
 export const persistenceService: StorageService;
-declare class Configuration {
-    constructor();
-    getServerUrl(): string;
-    getServicesApiUrl(): string;
-    getHubUrl(): string;
-    setServerUrl(serverUrl: string): void;
-    setServicesApiUrl(servicesApiUrl: string): void;
-    setHubUrl(hubUrl: string): void;
-    addServerUrlCallback(callback: () => void): void;
-}
-export const spiffCoreConfiguration: Configuration;
-declare class SwaggerServer implements ServerService {
-    constructor();
-    setUncachedOperations(operationIds: string[]): void;
-    execute(operationName: string, parameters?: object): Promise<ServerResponse>;
-}
-export const server: SwaggerServer;
-declare class GraphQlManager {
-    constructor();
-    getShadowGraphqlClient(): ApolloClient<any>;
-}
-export const graphQlManager: GraphQlManager;
 declare class AssetService {
     constructor();
     /**
@@ -236,10 +236,10 @@ declare class IllustrationStepService implements StepService<_IllustrationStepDa
     getIllustrationBody(src: string): Promise<string>;
     getCreateElementCommand(id: string, region: Region, layout: _ILayout1, options: SVGCreateOpts): _CreateElementCommand1<_IllustrationElement1>;
     init(stepData: _Step1<_IllustrationStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
-    availableColors(stepData: _Step1<_IllustrationStepData1>): {
+    availableColors(stepData: _Step1<_IllustrationStepData1>): Promise<{
         fill: string;
         stroke: string;
-    }[];
+    }[]>;
     changeColorsCommand(svg: string, illustrationWidth: number, illustrationHeight: number, elements: string[], newFills: Map<string, string>): Promise<_CanvasCommand1>;
     changeColors(stepData: _Step1<_IllustrationStepData1>, elements: RegionElement[], workflowManager: WorkflowManager, getAllLayouts: () => _LayoutData1[], newFills: Map<string, string>): Promise<void>;
     selectVariant(stepData: _Step1<_IllustrationStepData1>, variant: _VariantResource1, elements: RegionElement[], setIsUpdating: (isUpdating: boolean) => void, workflowManager: WorkflowManager): Promise<void>;
@@ -305,10 +305,10 @@ declare class QuestionStepService implements StepService<_QuestionStepData1> {
 }
 export const questionStepService: QuestionStepService;
 declare class ShapeStepService implements StepService<_ShapeStepData1> {
-    colourOptions(stepData: _Step1<_ShapeStepData1>): {
+    availableColours(stepData: _Step1<_ShapeStepData1>): Promise<{
         fill: string;
         stroke: string;
-    }[];
+    }[]>;
     init(stepData: _Step1<_ShapeStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
     selectVariant(stepData: _Step1<_ShapeStepData1>, colourOption: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): void;
 }
@@ -343,7 +343,7 @@ declare class TextStepService implements StepService<_TextStepData1> {
      * @param stepData The text step to get colors for.
      * @returns A list of color objects containg fill, stroke and variant if available.
      */
-    availableColors(stepData: _Step1<_TextStepData1>): ColorOption[];
+    availableColors(stepData: _Step1<_TextStepData1>): Promise<ColorOption[]>;
     changeFill(stepData: _Step1<_TextStepData1>, newColor: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
     /**
      * Given an element and a string, filters any characters from the string that are
@@ -395,8 +395,6 @@ export interface WorkflowMetadata {
 }
 export interface WorkflowSelections {
     [stepName: string]: {
-        groupName?: string;
-        optionName: string;
         selections: _VariantResource1[];
     };
 }
@@ -417,7 +415,7 @@ interface StepSpecificServices {
     frameService?: FrameService;
     module?: ModuleProduct;
 }
-type DesignCreationProgressUpdate = (message: string) => void;
+export type DesignCreationProgressUpdate = (message: string) => void;
 type ConfirmCallback = (isConfirmed: boolean) => void;
 type EditedCallback = (editedSteps: EditedSteps) => void;
 type ElementsCallback = (elements: StepElements) => void;
@@ -824,23 +822,12 @@ export enum ProductCameraRig {
     Pan = 1
 }
 declare class OptionService {
-    /**
-     * Returns a promise that resolves once all options required for a given workflow
-     * have been loaded and cached ready for use.
-     * @param workflow The workflow to load options for.
-     */
-    cacheRequiredOptions(workflow: _Workflow1): Promise<void>;
     /**
      * Allows for retrieving an option, returns the option from a cache if possible.
      * @param server The server service for making the request.
      * @param id The option ID to be retrieved.
      */
-    getLocalOrFromServer(server: ServerService, id: string): Promise<IServerModel<_OptionResource1>>;
-    /**
-     * Returns an option from the cache, or null
-     * @param id The ID to search for.
-     */
-    getLocalOrUndefined(id?: string): IServerModel<_OptionResource1>;
+    getOption(server: ServerService, id: string): Promise<IServerModel<_OptionResource1>>;
     getAssetTileImageForVariant(variant: _VariantResource1): Promise<string>;
     getDefaultVariant(option: _OptionResource1): _VariantResource1 | undefined;
     getDisplayImageSource: (variant?: _VariantResource1) => undefined | string;
@@ -1095,7 +1082,7 @@ export abstract class StepHandle<T extends _AnyStepData1> {
     /**
      * Gets the currently selected variant, or undefined if no variant is selected.
      */
-    getCurrentVariant(): _VariantResource1;
+    getCurrentVariant(): Promise<_VariantResource1>;
     /**
      * Returns a list of valid variants for this step.
      */
@@ -1157,7 +1144,7 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
     /**
      * @returns A list of colors that can be used to fill the text.
      */
-    getAvailableColors(): ColorOption[];
+    getAvailableColors(): Promise<ColorOption[]>;
     /**
      * Changes the fill of text related to this step to the new fill value.
      * @param fill A new fill value to use.
@@ -1172,7 +1159,7 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
      * abled to edit the entire text string including the non-replaceable text.
      * @param shouldCustomizeAll When true the user can configure the entire text string.
      */
-    setFullTextCustomization(shouldCustomizeAll: boolean): void;
+    setFullTextCustomization(shouldCustomizeAll: boolean): TextChangeResult;
     /**
      * Changes the text value of text related to this step to a new value.
      * @param userInput Input from the user.
@@ -1240,7 +1227,7 @@ export interface WorkflowExperience {
     /**
      * Creates a data URL preview for the current design.
      */
-    createPreviewImage(resolution?: number): Promise<string>;
+    createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
     /**
      * To be called when the workflow experience is considered completed by the user.
      * @param product

package/package.json

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