@spiffcommerce/core 0.6.15 → 0.7.1

package/dist/types.d.ts

@@ -1,13 +1,8 @@
-import { StepAspect, Workflow, AnyStepData, Step, Asset, AssetType, IServerModel, MaterialResource, IllustrationStepData, VariantResource, DigitalContentStepData, FrameStepData, MaterialStepData, ModelStepData, ModuleStepData, PatchworkStepData, PictureStepData, QuestionStepData, ShapeStepData, TextStepData as _TextStepData1, OptionResource, StepType, TextStepData } from "papyrus/build/main/generation/Workflow";
-import { PatternImageData, FrameData as _FrameData1, Point, ScaleAxis, UnitOfMeasurement } from "papyrus/build/main/types";
-import { FrameOffsets, ColorDefinition, ILayout, IllustrationElement as _IllustrationElement1, LayoutsState as _LayoutsState1, Region, FrameElement as _FrameElement1, PatchworkOffsets, TextboxElement as _TextboxElement1, FontData, SerializableStep, StepStorage, FrameElement, IllustrationElement, LayoutElement, LayoutsState, PatchworkElement, TextboxElement, ImageElement } from "papyrus/build/main/LayoutsState/types";
+import { Workflow, StepAspect, Step, AnyStepData, FrameOffsets, PatternImageData, IServerModel, Asset, MaterialResource, AssetType, ColorDefinition, IllustrationStepData, Region, ILayout, CreateElementCommand as _CreateElementCommand1, IllustrationElement as _IllustrationElement1, LayoutsState as _LayoutsState1, VariantResource, CanvasCommand, LayoutData as _LayoutData1, DigitalContentStepData, FrameStepData, FrameElement as _FrameElement1, MaterialStepData, ModelStepData, ModuleStepData, PatchworkStepData, PatchworkOffsets, PictureStepData, QuestionStepData, ShapeStepData, FontData, GroupCommand, TextboxElement as _TextboxElement1, TextStepData as _TextStepData1, StepStorage, SerializableStep, CommandState, OptionResource, CommandContext as _CommandContext1, Point, ScaleAxis, UnitOfMeasurement, StepType, CommandContext, CreateElementCommand, FontAlignmentCommand, FontColorCommand, FrameElement, generate, IllustrationElement, LayoutData, LayoutElement, LayoutElementFactory, LayoutsState, PatchworkElement, TextboxElement, TextChangeCommand, TextStepData } from "@spiffcommerce/papyrus";
 import { ApolloClient } from "@apollo/client";
-import { CanvasCommand, CreateElementCommand as _CreateElementCommand1, GroupCommand, CreateElementCommand, FontAlignmentCommand, FontColorCommand, TextChangeCommand } from "papyrus/build/main/command";
-import { LayoutData as _LayoutData1, CommandState, CommandContext as _CommandContext1, CommandContext, LayoutData } from "papyrus/build/main/CommandContext";
-import { ModuleProduct } from "papyrus/build/main/module/ModuleProduct";
-import { ThreeDPreviewService as _ThreeDPreviewService1, LoadProgressEventData, ProductCameraRig, SpiffCommerce3DPreviewService, ThreeDPreviewService } from "spiff-preview";
+import { ThreeDPreviewService as _ThreeDPreviewService1, SpiffCommerce3DPreviewService, ThreeDPreviewService } from "@spiffcommerce/preview";
 import { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent, MouseEvent } from "react";
-import { LayoutElementFactory } from "papyrus/build/main/Elements/factory";
+import { ImageElement } from "canvg";
 export const gatherVaryingStepAspects: (workflow: Workflow) => StepAspect[];
 export interface WorkflowScene {
     name: string;
@@ -138,7 +133,6 @@ declare class Poller {
      */
     constructor(predicate: () => Promise<boolean>, onSuccess: () => void, onFailure: () => void, interval?: number, maxAttempts?: number);
 }
-export const generate: () => string;
 declare class Configuration {
     constructor();
     getServerUrl(): string;
@@ -217,7 +211,7 @@ declare class DigitalContentStepService implements StepService<DigitalContentSte
 export const digitalContentStepService: DigitalContentStepService;
 interface FrameCreateOpts {
     stepName?: string;
-    frameData: _FrameData1;
+    frameData: FrameData;
     disablePlaceholder?: boolean;
     focalBlur?: boolean;
     focalBlurStrength?: number;
@@ -336,6 +330,20 @@ declare class TextStepService implements StepService<_TextStepData1> {
     textAlign: (stepData: _TextStepData1) => string;
 }
 export const textStepService: TextStepService;
+declare abstract class ModuleProduct {
+    /**
+     * Name used by class. Usually product or brand name.
+     */
+    abstract moduleName: string;
+    /**
+     * SVG with styled path positioned on a background image. To be displayed to user.
+     */
+    abstract svgPreview(text: string): string;
+    /**
+     * SVG with styled path positioned on a background image. To be submitted for print.
+     */
+    abstract svgPrint(text: string): string;
+}
 export interface EditedSteps {
     [stepName: string]: boolean;
 }
@@ -768,6 +776,25 @@ interface FrameData {
      */
     height: number;
 }
+/**
+ * Defines the different behaviors supported by the camera system
+ * for control when viewing a product.
+ */
+export enum ProductCameraRig {
+    Orbit = 0,
+    Pan = 1
+}
+export type LoadProgressEventData = {
+    /**
+     * The total load value of the scene, this is an average of all
+     * 'in progress' loading events. when all events are fully loaded this value will be 100.
+     */
+    readonly loadValue: number;
+    /**
+     * This value is true when the base model and scene have been initialized.
+     */
+    readonly sceneInitialized: boolean;
+};
 declare class OptionService {
     /**
      * Returns a promise that resolves once all options required for a given workflow
@@ -1102,6 +1129,9 @@ interface ClientOptions {
      * containing multiple variations of the base design.
      */
     bulk?: boolean;
+    /**
+     * When set to true caching will be disabled. This is only useful for debugging. Don't use in production code!
+     */
     useUncachedEndpoints?: boolean;
 }
 /**
@@ -1211,9 +1241,9 @@ export class MockWorkflowManager implements WorkflowManager {
     updateStorage(_stepName: string, _update: StepStorage): Promise<void>;
 }
 export { CommandContext };
-export { CreateElementCommand, TextChangeCommand, FontAlignmentCommand, FontColorCommand, LayoutElementFactory };
+export { generate, CreateElementCommand, TextChangeCommand, FontAlignmentCommand, FontColorCommand, LayoutElementFactory };
 export { LayoutElement, ImageElement, TextboxElement, TextStepData, FrameElement, PatchworkElement, IllustrationElement, LayoutData, LayoutsState };
-export { SpiffCommerce3DPreviewService, ProductCameraRig };
-export { ThreeDPreviewService, LoadProgressEventData };
+export { SpiffCommerce3DPreviewService };
+export { ThreeDPreviewService };
 
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.6.15",
+    "version": "0.7.1",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -44,6 +44,7 @@
         "@types/lodash.isequal": "^4.5.6",
         "@types/qrcode": "^1.3.5",
         "@types/react": "^17.0.9",
+        "@types/opentype.js": "^0.7.2",
         "@types/react-dom": "^17.0.9",
         "@wojtekmaj/enzyme-adapter-react-17": "^0.6.7",
         "enzyme": "^3.11.0",
@@ -53,21 +54,23 @@
         "parcel": "^2.7.0",
         "react-test-renderer": "^18.2.0",
         "ts-jest": "^29.0.2",
-        "typescript": "4.7.3"
+        "typescript": "4.7.2"
     },
     "dependencies": {
         "@apollo/client": "^3.6.0",
+        "@spiffcommerce/papyrus": "^1.3.0",
+        "@spiffcommerce/preview": "^2.0.0",
         "canvg": "https://github.com/spiffdev/canvg.git#03bcd151b12441e88ecb552bb658356f5bbe92c4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.4.0",
+        "opentype.js": "^1.3.1",
         "lodash.clonedeep": "^4.5.0",
         "lodash.debounce": "^4.0.8",
         "lodash.isequal": "^4.5.0",
-        "papyrus": "git+ssh://git@bitbucket.org:spiffdev/papyrus.git#6a2783887029083549e11a86337f808dda050ac8",
         "qrcode": "^1.4.4",
         "react": "^17.0.2",
         "react-dom": "^17.0.2",
-        "spiff-preview": "git+ssh://git@bitbucket.org:spiffdev/spiff-preview.git#2fb43c88d9326f20829ea3b3a6119220c66b5395",
-        "swagger-client": "git+https://github.com/spiffdev/swagger-js.git"
+        "svg-path-bbox": "^1.2.2",
+        "swagger-client": "spiffdev/swagger-js.git"
     }
 }