@aurigma/design-atoms-interfaces 0.0.6

package/Types/ItemData/IViolationSettings.d.ts

@@ -0,0 +1,29 @@
+/**
+* A structure containing the configuration of preflight warnings.
+* @example
+* ```json
+* {
+*    "violationWarningsSettings": {
+*        "allowSafetyLines": true,
+*        "allowTextCrop": false
+*    }
+* }
+* ```
+* @public
+*/
+export interface IViolationSettings {
+    /** Enables a warning displayed if an item crosses a safety line. The default value is `true`. */
+    allowSafetyLines?: boolean;
+    /** Enables a warning displayed if an item goes out of a region. The default value is `true`. */
+    allowRegion?: boolean;
+    /** Enables a warning displayed if an item crosses the bleed area. The default value is `true`. */
+    allowBleedArea?: boolean;
+    /** Enables a warning displayed if the Asset Manager can import PDF and SVG graphics only with the loss of colors and raster images. The default value is `true`. */
+    allowShape?: boolean;
+    /** Enables a warning displayed if the text is too long for the bounding rectangle, and some strings are clipped. The default value is `true`. */
+    allowTextCrop?: boolean;
+    /** Enables a warning displayed if a selected image has a resolution that is too low. */
+    allowImageQuality?: boolean;
+    /** Enables a warning displayed if selected text has features that are disallowed at in-place editing mode. */
+    allowInPlaceText?: boolean;
+}

package/Types/ItemData/IViolationSettings.js

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

package/Types/ItemData/IVisualizationPermissionsData.d.ts

@@ -0,0 +1,22 @@
+/**
+* A structure defining visualization of design elements.
+* @example
+* ```json
+* {
+*    "defaultItemsConfig": {
+*        "rectangle": {
+*            "visualizationPermissions": {
+*                "noPrint": true
+*            }
+*        }
+*    }
+* }
+* ```
+* @public
+*/
+export interface IVisualizationPermissionsData {
+    /** If `true`, the corresponding element appears only on the canvas. By default, Customer's Canvas shows all design elements on the canvas, proof images, and high-resolution images. */
+    noPrint?: boolean;
+    /** If `true`, the corresponding element does not appear on the canvas but it is rendered on the print-ready file and proof images. By default, Customer's Canvas shows all design elements on the canvas, proof images, and high-resolution images. */
+    noShow?: boolean;
+}

package/Types/ItemData/IVisualizationPermissionsData.js

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

package/Types/ItemData/ImageEffect.d.ts

@@ -0,0 +1 @@
+export type ImageEffect = "none" | "blackAndWhite" | "flipVertical" | "flipHorizontal" | "colorize" | "blackAndTransparent";

package/Types/ItemData/ImageEffect.js

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

package/Types/ItemData/OverflowStrategy.d.ts

@@ -0,0 +1,4 @@
+/**
+* Copyfitting rules.
+*/
+export type OverflowStrategy = "clip" | "fitToWidth" | "fitToBox" | "expandBox";

package/Types/ItemData/OverflowStrategy.js

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

package/Types/ItemData/ResizeGripsCorner.d.ts

@@ -0,0 +1,3 @@
+export type ArbitraryCorner = "Arbitrary";
+export type ProportionalCorner = "Proportional";
+export type ResizeGripsCorner = ArbitraryCorner | ProportionalCorner;

package/Types/ItemData/ResizeGripsCorner.js

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

package/Types/ItemData/ShrinkMode.d.ts

@@ -0,0 +1,4 @@
+/**
+* Shrink modes for overflowing text.
+*/
+export type ShrinkMode = "scale" | "size";

package/Types/ItemData/ShrinkMode.js

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

package/Types/ItemData/VerticalAlignmentType.d.ts

@@ -0,0 +1,4 @@
+/**
+* Vertical alignment.
+*/
+export type VerticalAlignmentType = "top" | "center" | "bottom";

package/Types/ItemData/VerticalAlignmentType.js

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

package/Types/ItemData/WrappingMode.d.ts

@@ -0,0 +1 @@
+export type WrappingMode = "none" | "square" | "tight";

package/Types/ItemData/WrappingMode.js

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

package/Types/ItemData/index.d.ts

@@ -0,0 +1,45 @@
+export * from "./BarcodeContentType";
+export * from "./BlendMode";
+export * from "./ContentResizeMode";
+export * from "./IArchedTextItemData";
+export * from "./IBarcodeItemData";
+export * from "./IBarcodeOptions";
+export * from "./IBarcodePermissionsData";
+export * from "./IBaseTextItemData";
+export * from "./IBoundedTextItemData";
+export * from "./IClipartItemData";
+export * from "./IContentItemData";
+export * from "./IContentPermissionsData";
+export * from "./IEllipseItemData";
+export * from "./IFontSettingsData";
+export * from "./IGroupItemData";
+export * from "./IImageItemData";
+export * from "./IImagePermissionsData";
+export * from "./IItemData";
+export * from "./IItemPermissionsData";
+export * from "./IItemToolbarPermissionsData";
+export * from "./ILineItemData";
+export * from "./ILinePermissionsData";
+export * from "./ILocationData";
+export * from "./ImageEffect";
+export * from "./IManipulationPermissionsData";
+export * from "./IParagraphSettingsData";
+export * from "./IPlaceholderItemData";
+export * from "./IPlaceholderPermissionsData";
+export * from "./IPlainTextItemData";
+export * from "./IPointF";
+export * from "./IRectangleItemData";
+export * from "./IResizeGripsPermissions";
+export * from "./IRichTextData";
+export * from "./IShapeItemData";
+export * from "./IShapePermissionsData";
+export * from "./ITextItemData";
+export * from "./ITextPermissionsData";
+export * from "./IThemeBindingData";
+export * from "./IViolationSettings";
+export * from "./IVisualizationPermissionsData";
+export * from "./OverflowStrategy";
+export * from "./ResizeGripsCorner";
+export * from "./ShrinkMode";
+export * from "./VerticalAlignmentType";
+export * from "./WrappingMode";

package/Types/ItemData/index.js

@@ -0,0 +1,45 @@
+export * from "./BarcodeContentType";
+export * from "./BlendMode";
+export * from "./ContentResizeMode";
+export * from "./IArchedTextItemData";
+export * from "./IBarcodeItemData";
+export * from "./IBarcodeOptions";
+export * from "./IBarcodePermissionsData";
+export * from "./IBaseTextItemData";
+export * from "./IBoundedTextItemData";
+export * from "./IClipartItemData";
+export * from "./IContentItemData";
+export * from "./IContentPermissionsData";
+export * from "./IEllipseItemData";
+export * from "./IFontSettingsData";
+export * from "./IGroupItemData";
+export * from "./IImageItemData";
+export * from "./IImagePermissionsData";
+export * from "./IItemData";
+export * from "./IItemPermissionsData";
+export * from "./IItemToolbarPermissionsData";
+export * from "./ILineItemData";
+export * from "./ILinePermissionsData";
+export * from "./ILocationData";
+export * from "./ImageEffect";
+export * from "./IManipulationPermissionsData";
+export * from "./IParagraphSettingsData";
+export * from "./IPlaceholderItemData";
+export * from "./IPlaceholderPermissionsData";
+export * from "./IPlainTextItemData";
+export * from "./IPointF";
+export * from "./IRectangleItemData";
+export * from "./IResizeGripsPermissions";
+export * from "./IRichTextData";
+export * from "./IShapeItemData";
+export * from "./IShapePermissionsData";
+export * from "./ITextItemData";
+export * from "./ITextPermissionsData";
+export * from "./IThemeBindingData";
+export * from "./IViolationSettings";
+export * from "./IVisualizationPermissionsData";
+export * from "./OverflowStrategy";
+export * from "./ResizeGripsCorner";
+export * from "./ShrinkMode";
+export * from "./VerticalAlignmentType";
+export * from "./WrappingMode";

package/Types/ItemType.d.ts

@@ -0,0 +1,18 @@
+export declare enum ItemType {
+    AutoScaledTextItem = 0,
+    BarcodeItem = 1,
+    BoundedTextItem = 2,
+    CurvedTextItem = 3,
+    EllipseItem = 4,
+    ImageItem = 5,
+    LineItem = 6,
+    PathBoundedTextItem = 7,
+    PlaceholderItem = 8,
+    PlainTextItem = 9,
+    RectangleItem = 10,
+    ArchedTextItem = 11,
+    ShapeItem = 12,
+    GroupItem = 13,
+    LayoutItem = 14,
+    ClipartItem = 15
+}

package/Types/ItemType.js

@@ -0,0 +1,19 @@
+export var ItemType;
+(function (ItemType) {
+    ItemType[ItemType["AutoScaledTextItem"] = 0] = "AutoScaledTextItem";
+    ItemType[ItemType["BarcodeItem"] = 1] = "BarcodeItem";
+    ItemType[ItemType["BoundedTextItem"] = 2] = "BoundedTextItem";
+    ItemType[ItemType["CurvedTextItem"] = 3] = "CurvedTextItem";
+    ItemType[ItemType["EllipseItem"] = 4] = "EllipseItem";
+    ItemType[ItemType["ImageItem"] = 5] = "ImageItem";
+    ItemType[ItemType["LineItem"] = 6] = "LineItem";
+    ItemType[ItemType["PathBoundedTextItem"] = 7] = "PathBoundedTextItem";
+    ItemType[ItemType["PlaceholderItem"] = 8] = "PlaceholderItem";
+    ItemType[ItemType["PlainTextItem"] = 9] = "PlainTextItem";
+    ItemType[ItemType["RectangleItem"] = 10] = "RectangleItem";
+    ItemType[ItemType["ArchedTextItem"] = 11] = "ArchedTextItem";
+    ItemType[ItemType["ShapeItem"] = 12] = "ShapeItem";
+    ItemType[ItemType["GroupItem"] = 13] = "GroupItem";
+    ItemType[ItemType["LayoutItem"] = 14] = "LayoutItem";
+    ItemType[ItemType["ClipartItem"] = 15] = "ClipartItem";
+})(ItemType || (ItemType = {}));

package/Types/OriginPointType.d.ts

@@ -0,0 +1,19 @@
+/**
+* The origin of coordinates.
+*
+* {@link ILocationData|See an example}.
+*/
+export declare enum OriginPointType {
+    /**  The left edge. */
+    Left = "left",
+    /** The right edge. */
+    Right = "right",
+    /** The top edge. */
+    Top = "top",
+    /** The bottom edge. */
+    Bottom = "bottom",
+    /** The center of the product. */
+    Center = "center"
+}
+export type HorizontalOriginPointType = OriginPointType.Left | OriginPointType.Right | OriginPointType.Center;
+export type VerticalOriginPointType = OriginPointType.Top | OriginPointType.Bottom | OriginPointType.Center;

package/Types/OriginPointType.js

@@ -0,0 +1,18 @@
+/**
+* The origin of coordinates.
+*
+* {@link ILocationData|See an example}.
+*/
+export var OriginPointType;
+(function (OriginPointType) {
+    /**  The left edge. */
+    OriginPointType["Left"] = "left";
+    /** The right edge. */
+    OriginPointType["Right"] = "right";
+    /** The top edge. */
+    OriginPointType["Top"] = "top";
+    /** The bottom edge. */
+    OriginPointType["Bottom"] = "bottom";
+    /** The center of the product. */
+    OriginPointType["Center"] = "center";
+})(OriginPointType || (OriginPointType = {}));

package/Types/ResizeRectangleType.d.ts

@@ -0,0 +1,6 @@
+export declare enum ResizeRectangleType {
+    Fit = 0,
+    Fill = 1,
+    Arbitrary = 2,
+    Original = 3
+}

package/Types/ResizeRectangleType.js

@@ -0,0 +1,7 @@
+export var ResizeRectangleType;
+(function (ResizeRectangleType) {
+    ResizeRectangleType[ResizeRectangleType["Fit"] = 0] = "Fit";
+    ResizeRectangleType[ResizeRectangleType["Fill"] = 1] = "Fill";
+    ResizeRectangleType[ResizeRectangleType["Arbitrary"] = 2] = "Arbitrary";
+    ResizeRectangleType[ResizeRectangleType["Original"] = 3] = "Original";
+})(ResizeRectangleType || (ResizeRectangleType = {}));

package/Types/RotationType.d.ts

@@ -0,0 +1,7 @@
+export declare enum RotationType {
+    None = 0,
+    Rotate90 = 90,
+    Rotate180 = 180,
+    Rotate270 = 270,
+    Auto = -1
+}

package/Types/RotationType.js

@@ -0,0 +1,8 @@
+export var RotationType;
+(function (RotationType) {
+    RotationType[RotationType["None"] = 0] = "None";
+    RotationType[RotationType["Rotate90"] = 90] = "Rotate90";
+    RotationType[RotationType["Rotate180"] = 180] = "Rotate180";
+    RotationType[RotationType["Rotate270"] = 270] = "Rotate270";
+    RotationType[RotationType["Auto"] = -1] = "Auto";
+})(RotationType || (RotationType = {}));

package/Types/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./ItemData";
+export * from "./AlignTargetType";
+export * from "./AlignType";
+export * from "./DistributeType";
+export * from "./IQueryOptions";
+export * from "./ItemType";
+export * from "./OriginPointType";
+export * from "./ResizeRectangleType";
+export * from "./RotationType";

package/Types/index.js

@@ -0,0 +1,9 @@
+export * from "./ItemData";
+export * from "./AlignTargetType";
+export * from "./AlignType";
+export * from "./DistributeType";
+export * from "./IQueryOptions";
+export * from "./ItemType";
+export * from "./OriginPointType";
+export * from "./ResizeRectangleType";
+export * from "./RotationType";

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./CommandManager";
+export * from "./Types";

package/index.js

@@ -0,0 +1,2 @@
+export * from "./CommandManager";
+export * from "./Types";

package/license.md

@@ -0,0 +1,10 @@
+DESIGN ATOMS LICENSING TERMS
+============================
+
+The design-atoms module is a part of Aurigma's Customer's Canvas software. It is covered by the same terms as Customer's Canvas:
+
+https://customerscanvas.com/dev/licensing.html
+
+It means that if you already have a valid Customer's Canvas license or in a process of its evaluation, feel free to use the design-atoms.
+
+You can not use any part of this library separately.

package/package.json

@@ -0,0 +1 @@
+{"name":"@aurigma/design-atoms-interfaces","version":"0.0.6","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"]}

package/readme.md

@@ -0,0 +1 @@
+# About DesignAtomsInterfaces module