@spiffcommerce/core 0.2.0 → 0.2.2

package/dist/types.d.ts

@@ -1,13 +1,15 @@
-import { AnyStepData, Step, Asset, AssetType, IServerModel, MaterialResource, VariantResource, Workflow, CameraAnimation, ModelAnimation, OptionResource, StepType, TextStepData } from "papyrus/build/main/generation/Workflow";
-import { PatternImageData, ScaleAxis, UnitOfMeasurement } from "papyrus/build/main/types";
+import { StepAspect, Workflow, AnyStepData, Step, Asset, AssetType, IServerModel, MaterialResource, VariantResource, CameraAnimation, ModelAnimation, OptionResource, StepType, TextStepData } from "papyrus/build/main/generation/Workflow";
+import { PatternImageData, Point, ScaleAxis, UnitOfMeasurement } from "papyrus/build/main/types";
 import { FrameOffsets, ILayout, SerializableStep, StepStorage, Region, LayoutsState as _LayoutsState1, LayoutElement, LayoutsState, TextboxElement, ImageElement } from "papyrus/build/main/LayoutsState/types";
+import { ApolloClient } from "@apollo/client";
 import { ModuleProduct } from "papyrus/build/main/module/ModuleProduct";
 import { CanvasCommand, CreateElementCommand, FontAlignmentCommand, FontColorCommand, TextChangeCommand } from "papyrus/build/main/command";
 import { CommandState, CommandContext as _CommandContext1, LayoutData as _LayoutData1, CommandContext, LayoutData } from "papyrus/build/main/CommandContext";
-import { Dispatch, FunctionComponent, ReactNode, MouseEvent, PointerEvent } from "react";
+import { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent, MouseEvent } from "react";
 import { ThreeDPreviewService as _ThreeDPreviewService1, SpiffCommerce3DPreviewService } from "spiff-preview";
 import { LayoutElementFactory } from "papyrus/build/main/Elements/factory";
-interface WorkflowScene {
+export const gatherVaryingStepAspects: (workflow: Workflow) => StepAspect[];
+export interface WorkflowScene {
     name: string;
     title: string;
     renderableSteps: Step<AnyStepData>[];
@@ -97,12 +99,27 @@ 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;
+    getServicesApiUrl(): string;
+    setServerUrl(serverUrl: string): void;
+    setServicesApiUrl(servicesApiUrl: 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();
     /**
@@ -143,10 +160,10 @@ type StepMetadata = FrameMetadata | IllustrationMetadata | ModuleMetadata | Text
 interface WorkflowStorage {
     [stepName: string]: StepStorage;
 }
-interface WorkflowMetadata {
+export interface WorkflowMetadata {
     [stepName: string]: StepMetadata;
 }
-interface WorkflowSelections {
+export interface WorkflowSelections {
     [stepName: string]: {
         groupName?: string;
         optionName: string;
@@ -189,7 +206,7 @@ type StorageCallback = (storage: WorkflowStorage) => void;
 type UpdateCallback = (isUpdating: boolean) => void;
 type CurrentVariationRecordCallback = (variationRecord: null | VariationRecord) => void;
 type VariationRecordsCallback = (records: VariationRecord[]) => void;
-interface WorkflowManager {
+export interface WorkflowManager {
     addPoller: (poller: Poller) => void;
     addConfirmCallback: (callback: ConfirmCallback) => void;
     addCurrentVariationCallback: (callback: CurrentVariationRecordCallback) => void;
@@ -287,7 +304,7 @@ export interface DesignCreationMessage {
 /**
  * Represents a transaction.
  */
-interface Transaction {
+export interface Transaction {
     id: string;
     bulk?: boolean;
     /**
@@ -459,7 +476,7 @@ interface Product {
  * Represents a variation as seen in Google sheets.
  * Record number = row# - 1
  */
-interface VariationRecord {
+export interface VariationRecord {
     recordNumber: number;
     transactionId: string;
     values: {
@@ -881,6 +898,16 @@ export const useLayouts: () => {
 export type CommandDispatcher = (command: CanvasCommand) => void;
 export type LayoutGetter = (layoutId: string) => _LayoutData1;
 export type LayoutsGetter = () => _LayoutData1[];
+/**
+ * Details about a guideline that can be drawn on the canvas.
+ */
+interface SnapPoint {
+    type: "x" | "y" | "rotation";
+    value: number;
+    svgNode?: ReactNode;
+    anchorPoint: number;
+    guidelineCoordinates?: Point[];
+}
 enum ElementEventType {
     Translate = "Translate",
     Rotate = "Rotate",
@@ -1004,6 +1031,53 @@ export const useEditorState: () => {
     uiDispatcher: Dispatch<UICommand>;
     state: AdvancedEditorState;
 };
+/**
+ * The minimum zoom that can be applied to a canvas.
+ */
+export const minZoom = 0.5;
+export const useEditorInteraction: (editorRef: RefObject<SVGRectElement>, interactionRef: RefObject<HTMLDivElement>, zoomableElementRef: RefObject<HTMLDivElement>, defaultAdjustmentZoom: number | undefined, mode: "adjustment" | "advanced", canvasDispatcher: CommandDispatcher, guidelinePrimaryColor?: string) => {
+    guidelines: SnapPoint[];
+    scale: number;
+    zoomableElementRef: RefObject<HTMLDivElement>;
+    setElementEvent: (newEvent: ElementEvent | undefined) => void;
+    handleZoom: (_event: any, value: any) => void;
+    handleKeyDown: (event: KeyboardEvent, adjustmentBoundary?: Region) => void;
+    handleKeyUp: (event: KeyboardEvent) => void;
+    handlePointerPressedBackground: () => void;
+    handlePointerReleased: () => void;
+    handlePointerMove: (e: PointerEvent, adjustmentBoundary?: Region) => void;
+    handleScroll: () => void;
+    handleSequenceStart: () => void;
+};
+export const EditorCore: FunctionComponent<{
+    color?: string;
+    editorRef: RefObject<SVGRectElement>;
+    zoomableElementRef: RefObject<HTMLDivElement>;
+    interactionElementRef: RefObject<HTMLDivElement>;
+    guidelines: SnapPoint[];
+    isMakingAdjustments?: boolean;
+    viewmask?: {
+        x: number;
+        y: number;
+        height: number;
+        width: number;
+    };
+    visibleLayoutId: string;
+    xTranslation: number;
+    yTranslation: number;
+    targetedElements?: string[];
+    borderRadius?: number;
+    handleContextMenu?: (e: any) => void;
+    handleKeyDown: (event: KeyboardEvent, adjustmentBoundary?: Region) => void;
+    handleKeyUp: (event: KeyboardEvent) => void;
+    handlePointerMove: (e: PointerEvent, adjustmentBoundary?: Region) => void;
+    handlePointerPressedBackground: () => void;
+    handlePointerReleased: () => void;
+    handleScroll: () => void;
+    onSequenceStart: () => void;
+    setElementEvent: (e: ElementEvent | undefined) => void;
+    onElementSelected: (elementId: string | undefined, event: PointerEvent) => void;
+}>;
 /**
  * The advanced editor encapsulates the logic required to allow users to manipulate a design
  * with more granular control such as toolbars, direct element manipulation, and more.

package/package.json

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