@aurigma/design-atoms-interfaces 1.0.8 → 1.0.11

package/CommandManager/ProductCommand/IAddSurfacesCmdArgs.d.ts

@@ -0,0 +1,6 @@
+export interface IAddSurfacesBaseCommandArgs<TSurface> {
+    surfaces: TSurface[];
+    position?: number;
+    switchToNewSurface: boolean;
+    surfacesName?: string;
+}

package/CommandManager/ProductCommand/IAddSurfacesCmdArgs.js

@@ -0,0 +1 @@
+export {};

package/CommandManager/ProductCommand/IRemoveSurfaceCmdArgs.d.ts

@@ -0,0 +1,3 @@
+export interface IRemoveSurfaceCommandsArgs {
+    surfaceId: string;
+}

package/CommandManager/ProductCommand/IRemoveSurfaceCmdArgs.js

@@ -0,0 +1 @@
+export {};

package/CommandManager/ProductCommand/IUpdateSurfacesCmdArgs.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Surface insertion mode.
+ * @remarks You can use this structure in {@link Product.updateSurfaces|updateSurfaces}.
+ * @public
+ */
+export declare enum UpdateSurfaceBehavior {
+    /** The number of pages remains the same, and the sizes of the `surfaces` and `newProductSurfaces` arrays must match. */
+    keepCurrentSurfaceLength = "keepCurrentSurfaceLength",
+    /** First deletes all the surfaces of the loaded product and then takes the pages from the new product. */
+    changeSurfaceLength = "changeSurfaceLength"
+}
+export interface ISetPrintAreasOptions {
+    /** If `true`, the changes made by a user are restored in the new print areas or surfaces if it is possible. Otherwise, all changes made by the user are wiped. The default value is `true`. */
+    preserveUserChanges?: boolean;
+    /** If `true`, the current safety lines, if any, are restored in new print areas. If `false`, safety lines from new print areas are applied. The default value is `true`. */
+    preserveSafetyLines?: boolean;
+    /** If `true`, design elements whose names do not match move to the new print area in a random order according to their types. If `false`, only design elements with the same names are moved to the new print area. The default value is `false`. */
+    replaceAll?: boolean;
+    /** If `true`, changes the surface size to match the new print area or surface. If it's `false` and a mockup is defined, then the surface size remains unchanged. By default, `updateSurfaceSize` is `false`, and the surface size changes only if no mockups are specified. */
+    updateSurfaceSize?: boolean;
+    /** If true, clears user-deleted items after merging */
+    clearRemovedItems?: boolean;
+}
+export interface IUpdateSurfaceOptions<TProduct> extends ISetPrintAreasOptions {
+    product: TProduct;
+    /** An array of surfaces in the current product to be removed. */
+    surfaces?: number[];
+    /** An array of surfaces in the new product to be inserted. */
+    newProductSurfaces?: number[];
+    /** Defines how new surfaces will replace existing surfaces in the product. If `changeSurfaceLength`, removes all pages in the product and replaces them with pages of the new product. */
+    updateBehavior?: UpdateSurfaceBehavior;
+}

package/CommandManager/ProductCommand/IUpdateSurfacesCmdArgs.js

@@ -0,0 +1,12 @@
+/**
+ * Surface insertion mode.
+ * @remarks You can use this structure in {@link Product.updateSurfaces|updateSurfaces}.
+ * @public
+ */
+export var UpdateSurfaceBehavior;
+(function (UpdateSurfaceBehavior) {
+    /** The number of pages remains the same, and the sizes of the `surfaces` and `newProductSurfaces` arrays must match. */
+    UpdateSurfaceBehavior["keepCurrentSurfaceLength"] = "keepCurrentSurfaceLength";
+    /** First deletes all the surfaces of the loaded product and then takes the pages from the new product. */
+    UpdateSurfaceBehavior["changeSurfaceLength"] = "changeSurfaceLength";
+})(UpdateSurfaceBehavior || (UpdateSurfaceBehavior = {}));

package/CommandManager/ProductCommand/ProductCommand.d.ts

@@ -4,5 +4,8 @@ export declare enum ProductCommand {
     changeBackground = "changeBackground",
     applyProductTheme = "applyProductTheme",
     fillPlaceholders = "fillPlaceholders",
-    resize = "resize"
+    resize = "resize",
+    removeSurface = "removeSurface",
+    addSurfaces = "addSurfaces",
+    updateSurfaces = "updateSurfaces"
 }

package/CommandManager/ProductCommand/ProductCommand.js

@@ -6,4 +6,7 @@ export var ProductCommand;
     ProductCommand["applyProductTheme"] = "applyProductTheme";
     ProductCommand["fillPlaceholders"] = "fillPlaceholders";
     ProductCommand["resize"] = "resize";
+    ProductCommand["removeSurface"] = "removeSurface";
+    ProductCommand["addSurfaces"] = "addSurfaces";
+    ProductCommand["updateSurfaces"] = "updateSurfaces";
 })(ProductCommand || (ProductCommand = {}));

package/CommandManager/ProductCommand/index.d.ts

@@ -2,4 +2,7 @@ export * from "./IApplyProductThemeCmdArgs";
 export * from "./IChangeBgArgs";
 export * from "./IResizeArgs";
 export * from "./IRotateProductCmdArgs";
+export * from "./IAddSurfacesCmdArgs";
+export * from "./IRemoveSurfaceCmdArgs";
+export * from "./IUpdateSurfacesCmdArgs";
 export * from "./ProductCommand";

package/CommandManager/ProductCommand/index.js

@@ -2,4 +2,7 @@ export * from "./IApplyProductThemeCmdArgs";
 export * from "./IChangeBgArgs";
 export * from "./IResizeArgs";
 export * from "./IRotateProductCmdArgs";
+export * from "./IAddSurfacesCmdArgs";
+export * from "./IRemoveSurfaceCmdArgs";
+export * from "./IUpdateSurfacesCmdArgs";
 export * from "./ProductCommand";

package/package.json

@@ -1 +1 @@
-{"name":"@aurigma/design-atoms-interfaces","version":"1.0.8","description":"","main":"index.js","author":"Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)","license":"SEE LICENSE IN License.md","keywords":["customer's canvas","web-to-print","image manipulation","design","personalization","web-to-print editor","design editor"]}
+{"name":"@aurigma/design-atoms-interfaces","version":"1.0.11","description":"","main":"index.js","author":"Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)","license":"SEE LICENSE IN License.md","keywords":["customer's canvas","web-to-print","image manipulation","design","personalization","web-to-print editor","design editor"]}