@mediaclip/library 12.0.2 → 12.1.0-cd.15420

package/dist/shared/CollageBuilder.d.ts

@@ -1,5 +1,6 @@
-import { AddClipartElementArgument, AddPhotoElementArgument, AddStaticImageElementArgument, AddStaticTextElementArgument, AddTextElementArgument } from "./arguments";
-import { ClipartElement, PhotoElement, StaticImageElement, StaticTextElement, TextElement, VisualElement } from "./elements";
+import { AddClipartElementArgument, AddGeneratedImageElementArgument, AddPhotoElementArgument, AddStaticImageElementArgument, AddStaticTextElementArgument, AddTextElementArgument } from "./arguments";
+import { ClipartElement, GeneratedImageElement, PhotoElement, StaticImageElement, StaticTextElement, TextElement, VisualElement } from "./elements";
+import { MarginArgument } from "./MarginArgument";
 import { Rect } from "./Rect";
 export interface CollageBuilder {
     readonly marginRect: Rect;
@@ -17,7 +18,19 @@ export interface CollageBuilder {
     addPhoto(value?: AddPhotoElementArgument): PhotoElement;
     addText(value?: AddTextElementArgument): TextElement;
     addClipart(value?: AddClipartElementArgument): ClipartElement;
+    addGeneratedImageElement(value?: AddGeneratedImageElementArgument): GeneratedImageElement;
     addStaticText(value?: AddStaticTextElementArgument): StaticTextElement;
     addStaticImage(value?: AddStaticImageElementArgument): StaticImageElement;
     log(value: undefined | number | string | unknown): void;
+    newRect(value: {
+        x?: number;
+        y?: number;
+        width?: number;
+        height?: number;
+        rotation?: number;
+    }): Rect;
+    setLayout(value: {
+        spacing?: number;
+        margin?: MarginArgument;
+    }): void;
 }

package/dist/shared/MarginArgument.d.ts

@@ -0,0 +1,8 @@
+export type MarginArgument = number | {
+    top?: number;
+    right?: number;
+    bottom?: number;
+    left?: number;
+    horizontal?: number;
+    vertical?: number;
+};

package/dist/shared/Rect.d.ts

@@ -1,13 +1,21 @@
-export interface IRect {
+export interface RectBase {
     x: number;
     y: number;
     width: number;
     height: number;
     rotation: number;
+    left: number;
+    top: number;
     right: number;
     bottom: number;
+    centerX: number;
+    centerY: number;
+    getRect(): RectBase;
+    setRect(rect: RectBase): void;
+    rotateAroundPoint(rotation: number, x: number, y: number): void;
+    fitIn(rect: RectBase): void;
 }
-export interface Rect extends IRect {
+export interface Rect extends RectBase {
     split(value: {
         rows?: number | number[];
         columns?: number | number[];

package/dist/shared/arguments/AddClipartElementArgument.d.ts

@@ -1,8 +1,6 @@
-import { ElementBorder } from "../elements";
 import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
 export interface AddClipartElementArgument extends AddVisualElementArgumentBase {
     tag?: string;
-    border?: ElementBorder;
     colorize?: string;
     colorizeSpotColor?: string;
 }

package/dist/shared/arguments/AddGeneratedImageElementArgument.d.ts

@@ -0,0 +1,7 @@
+import { GeneratedImageField } from "../elements";
+import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
+export interface AddGeneratedImageElementArgument extends AddVisualElementArgumentBase {
+    type?: string;
+    empty?: boolean;
+    fields?: GeneratedImageField[];
+}

package/dist/shared/arguments/AddPhotoElementArgument.d.ts

@@ -1,8 +1,13 @@
-import { ElementBorder, PhotoFitting } from "../elements";
+import { ElementFrameBorder, ElementMaskBorder, ElementStraightBorder, FilterInfo, PhotoFitting } from "../elements";
+import { PhotoResource } from "../resources";
 import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
 export interface AddPhotoElementArgument extends AddVisualElementArgumentBase {
     tag?: string;
     required?: boolean;
-    border?: ElementBorder;
+    behavior?: string;
+    border?: ElementStraightBorder | ElementFrameBorder | ElementMaskBorder;
     fitting?: PhotoFitting;
+    filters?: FilterInfo[];
+    photo?: PhotoResource;
+    id?: string;
 }

package/dist/shared/arguments/AddStaticImageElementArgument.d.ts

@@ -1,7 +1,5 @@
 import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
-import { ElementBorder } from "../elements";
 export interface AddStaticImageElementArgument extends AddVisualElementArgumentBase {
-    border?: ElementBorder;
     colorize?: string;
     colorizeSpotColor?: string;
 }

package/dist/shared/arguments/AddStaticTextElementArgument.d.ts

@@ -1,4 +1,4 @@
-import { ElementBackground, ElementBorder, HAlign, VAlign } from "../elements";
+import { ElementBackground, ElementFrameBorder, ElementStraightBorder, HAlign, VAlign } from "../elements";
 import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
 export interface AddStaticTextElementArgument extends AddVisualElementArgumentBase {
     text?: string;
@@ -13,5 +13,5 @@ export interface AddStaticTextElementArgument extends AddVisualElementArgumentBa
     color?: string;
     spotColor?: string;
     background?: ElementBackground;
-    border?: ElementBorder;
+    border?: ElementStraightBorder | ElementFrameBorder;
 }

package/dist/shared/arguments/AddTextElementArgument.d.ts

@@ -1,4 +1,4 @@
-import { ElementBackground, ElementBorder, HAlign, TextElementMode, VAlign } from "../elements";
+import { ElementBackground, ElementFrameBorder, ElementStraightBorder, HAlign, TextElementMode, VAlign } from "../elements";
 import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
 export interface AddTextElementArgument extends AddVisualElementArgumentBase {
     text?: string;
@@ -18,5 +18,5 @@ export interface AddTextElementArgument extends AddVisualElementArgumentBase {
     color?: string;
     spotColor?: string;
     background?: ElementBackground;
-    border?: ElementBorder;
+    border?: ElementStraightBorder | ElementFrameBorder;
 }

package/dist/shared/arguments/index.d.ts

@@ -1,5 +1,6 @@
 export * from "../CollageBuilder";
 export * from "./AddClipartElementArgument";
+export * from "./AddGeneratedImageElementArgument";
 export * from "./AddPhotoElementArgument";
 export * from "./AddStaticImageElementArgument";
 export * from "./AddStaticTextElementArgument";

package/dist/shared/elements/BackgroundElement.d.ts

@@ -1,7 +1,6 @@
-import { ImageBackgroundResource } from "../resources/ImageBackgroundResource";
+import { ImageBackgroundResource } from "../resources";
 import { VisualElement } from "./VisualElement";
 export interface BackgroundElement extends VisualElement {
-    readonly type: "BackgroundElement";
     image?: ImageBackgroundResource;
     color: string;
     spotColor?: string;

package/dist/shared/elements/ClipartElement.d.ts

@@ -1,11 +1,8 @@
 import { ClipartResource } from "../resources";
-import { ElementBorder } from "./ElementBorder";
 import { VisualElement } from "./VisualElement";
 export interface ClipartElement extends VisualElement {
-    readonly type: "ClipartElement";
     tag?: string;
     clipart?: ClipartResource;
-    border?: ElementBorder;
     colorize?: string;
     colorizeSpotColor?: string;
 }

package/dist/shared/elements/ElementBorder.d.ts

@@ -1,6 +1,17 @@
-export interface ElementBorder {
+export interface ElementStraightBorder {
+    type: 'straight';
     /** A hexadecimal color, e.g. #000000 for black */
     color: string;
     /** The size of the border in 300 DPI points */
     size: number;
 }
+export interface ElementFrameBorder {
+    type: 'frame';
+    /** Id for frameBorder to load */
+    id: string;
+}
+export interface ElementMaskBorder {
+    type: 'mask';
+    /** Id for maskBorder to load */
+    id: string;
+}

package/dist/shared/elements/FilterInfo.d.ts

@@ -0,0 +1,3 @@
+export interface FilterInfo {
+    filterType: string;
+}

package/dist/shared/elements/GeneratedImageElement.d.ts

@@ -0,0 +1,11 @@
+import { VisualElement } from "./VisualElement";
+export interface GeneratedImageElement extends VisualElement {
+    type: string;
+    empty: boolean;
+    fields?: GeneratedImageField[];
+    addField(key: string, value: string): void;
+}
+export interface GeneratedImageField {
+    key: string;
+    value: string;
+}

package/dist/shared/elements/PhotoElement.d.ts

@@ -1,12 +1,16 @@
-import { ElementBorder } from "./ElementBorder";
+import { ElementFrameBorder, ElementMaskBorder, ElementStraightBorder } from "./ElementBorder";
 import { PhotoFitting } from "./PhotoFitting";
 import { PhotoResource } from "../resources";
 import { VisualElement } from "./VisualElement";
+type PhotoBorder = ElementStraightBorder | ElementFrameBorder | ElementMaskBorder;
 export interface PhotoElement extends VisualElement {
-    readonly type: "PhotoElement";
     photo: PhotoResource;
     tag?: string;
     required?: boolean;
+    behavior?: string;
     fitting?: PhotoFitting;
-    border?: ElementBorder;
+    readonly border?: PhotoBorder;
+    addFilter(filterType: string): void;
+    setBorder(value: PhotoBorder): void;
 }
+export {};

package/dist/shared/elements/StaticImageElement.d.ts

@@ -1,10 +1,7 @@
 import { ClipartResource } from "../resources";
-import { ElementBorder } from "./ElementBorder";
 import { VisualElement } from "./VisualElement";
 export interface StaticImageElement extends VisualElement {
-    readonly type: "StaticImageElement";
     clipart?: ClipartResource;
-    border?: ElementBorder;
     colorize?: string;
     colorizeSpotColor?: string;
 }

package/dist/shared/elements/StaticTextElement.d.ts

@@ -1,10 +1,9 @@
 import { ElementBackground } from "./ElementBackground";
-import { ElementBorder } from "./ElementBorder";
+import { ElementFrameBorder, ElementStraightBorder } from "./ElementBorder";
 import { HAlign } from "./HAlign";
 import { VAlign } from "./VAlign";
 import { VisualElement } from "./VisualElement";
 export interface StaticTextElement extends VisualElement {
-    readonly type: "StaticTextElement";
     text?: string;
     tag?: string;
     hAlign: HAlign;
@@ -17,5 +16,6 @@ export interface StaticTextElement extends VisualElement {
     color: string;
     spotColor?: string;
     background?: ElementBackground;
-    border?: ElementBorder;
+    readonly border?: ElementFrameBorder | ElementStraightBorder;
+    setBorder(value: ElementStraightBorder | ElementFrameBorder): void;
 }

package/dist/shared/elements/TextElement.d.ts

@@ -1,11 +1,11 @@
 import { ElementBackground } from "./ElementBackground";
-import { ElementBorder } from "./ElementBorder";
+import { ElementFrameBorder, ElementStraightBorder } from "./ElementBorder";
 import { HAlign } from "./HAlign";
 import { TextElementMode } from "./TextElementMode";
 import { VAlign } from "./VAlign";
 import { VisualElement } from "./VisualElement";
+type TextBorder = ElementStraightBorder | ElementFrameBorder;
 export interface TextElement extends VisualElement {
-    readonly type: "TextElement";
     text: string;
     tag?: string;
     mode: TextElementMode;
@@ -23,5 +23,7 @@ export interface TextElement extends VisualElement {
     color: string;
     spotColor?: string;
     background?: ElementBackground;
-    border?: ElementBorder;
+    readonly border?: TextBorder;
+    setBorder(value: TextBorder): void;
 }
+export {};

package/dist/shared/elements/VisualElement.d.ts

@@ -1,12 +1,6 @@
-import { IRect, Rect } from "../Rect";
-export interface VisualElement extends IRect {
+import { RectBase, Rect } from "../Rect";
+export interface VisualElement extends RectBase {
     readonly type: string;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    readonly right: number;
-    readonly bottom: number;
     getRect: () => Rect;
     setRect: (rect: Rect) => void;
 }

package/dist/shared/elements/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./BackgroundElement";
 export * from "./ClipartElement";
+export * from "./GeneratedImageElement";
 export * from "./ElementBackground";
 export * from "./ElementBorder";
+export * from "./FilterInfo";
 export * from "./HAlign";
 export * from "./PhotoElement";
 export * from "./StaticImageElement";

package/dist/shared/index.d.ts

@@ -1,3 +1,4 @@
 export { CollageBuilder } from "./CollageBuilder";
 export { Rect } from "./Rect";
 export { Modules } from "./Modules";
+export { MarginArgument } from "./MarginArgument";

package/dist/shared/resources/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./ClipartResource";
+export * from "./ImageBackgroundResource";
 export * from "./PhotoResource";

package/dist/themes/Format.d.ts

@@ -1,9 +1,11 @@
 export type Format = PhotobookFormat | GiftingFormat | PrintFormat;
 export interface FormatBase {
     getCollageIds: () => string[];
-    getCollageDimensions: (collageId: string) => CollageDimensions;
+    getCollageDimensions: (collageId: string) => CollageSpecifications;
+    getProperty: (key: string, defaultValue: string) => string;
 }
-export interface CollageDimensions {
+export interface CollageSpecifications {
+    readonly id: string;
     readonly width: number;
     readonly height: number;
     readonly bleed: number;

package/dist/themes/ResourcesLoader.d.ts

@@ -1,6 +1,10 @@
+import { ClipartResource, ImageBackgroundResource, PhotoResource } from "../shared/resources";
 export interface ResourcesLoader {
     load(value: string | string[] | {
         name: string;
-        resources: string[];
+        resources: string | string[];
     }): void;
+    getPhoto(id: string): PhotoResource;
+    getClipart(id: string): ClipartResource;
+    getBackground(id: string): ImageBackgroundResource;
 }

package/dist/themes/ThemeCollageBuilder.d.ts

@@ -1,14 +1,14 @@
-import { AddClipartElementArgument, AddPhotoElementArgument, AddStaticImageElementArgument, AddTextElementArgument, SetBackgroundElementArgument } from "./arguments";
-import { BackgroundElement, ClipartElement, PhotoElement, StaticImageElement, TextElement } from "../shared/elements";
+import { AddClipartElementArgument, AddStaticImageElementArgument, SetBackgroundElementArgument } from "./arguments";
+import { BackgroundElement, ClipartElement, StaticImageElement } from "../shared/elements";
 import { CollageBuilder } from "../shared";
 import { PhotosContainer } from "./PhotosContainer";
+import { ResourcesLoader } from "./ResourcesLoader";
 export interface ThemeCollageBuilder extends CollageBuilder {
+    readonly resources: ResourcesLoader;
     customizable: boolean;
     readonly photos: PhotosContainer;
     readonly background: BackgroundElement;
     setBackground(value?: string | SetBackgroundElementArgument): BackgroundElement;
-    addPhoto(value?: AddPhotoElementArgument): PhotoElement;
-    addText(value?: AddTextElementArgument): TextElement;
-    addClipart(value?: AddClipartElementArgument): ClipartElement;
-    addStaticImage(value?: AddStaticImageElementArgument): StaticImageElement;
+    addClipart(value?: string | AddClipartElementArgument): ClipartElement;
+    addStaticImage(value?: string | AddStaticImageElementArgument): StaticImageElement;
 }

package/dist/themes/ThemeContext.d.ts

@@ -3,6 +3,11 @@ import { Modules } from "../shared";
 export interface ThemeContext {
     readonly module: Modules;
     readonly culture: string;
+    readonly language: string;
     readonly format: Format;
-    getOption(key: string): string;
+    readonly isPreview: boolean;
+    getOption(key: string, defaultValue: string): string;
+    switchLang<T>(lang: {
+        [key: string]: T;
+    }): T;
 }

package/dist/themes/selector/SelectorEntry.d.ts

@@ -1,13 +1,16 @@
+import { CollageSpecifications } from "../Format";
 import { StyleEntry } from "../styles";
 import { ThemeCollageBuilder } from "../ThemeCollageBuilder";
+type ResourcesToLoad = string | string[] | {
+    name: string;
+    resources: string | string[];
+};
 export interface SelectorEntry {
     name: (name?: string) => SelectorEntry;
     style: (style: string | StyleEntry) => SelectorEntry;
-    load: (value: string | string[] | {
-        name: string;
-        resources: string[];
-    }) => SelectorEntry;
+    load: (value: (ResourcesToLoad | ((collage: CollageSpecifications) => ResourcesToLoad | undefined))) => SelectorEntry;
     autoLayout: (ids: string | string[]) => SelectorEntry;
     empty: () => void;
     create: (fn: (collage: ThemeCollageBuilder) => void) => void;
 }
+export {};

package/dist/themes/styles/StyleEntry.d.ts

@@ -1,20 +1,25 @@
-import { ElementBackground, ElementBorder, HAlign, VAlign } from "../../shared/elements";
+import { ElementBackground, ElementFrameBorder, ElementMaskBorder, ElementStraightBorder, HAlign, TextElementMode, VAlign } from "../../shared/elements";
+import { CollageSpecifications } from "../Format";
 import { SetBackgroundElementArgument } from "../arguments";
-export interface StyleEntry {
-    extends?: string;
-    id?: string;
+import { MarginArgument } from "../../shared";
+interface StyleDefinition {
     background?: string | SetBackgroundElementArgument;
     texts?: TextStyleArgument | TextStyleArgument[];
     clipart?: ClipartStyleArgument | ClipartStyleArgument[];
     photos?: PhotoStyleArgument | PhotoStyleArgument[];
-    margin?: number | {
-        top: number;
-        right: number;
-        bottom: number;
-        left: number;
-    };
+    margin?: MarginArgument;
     spacing?: number;
 }
+interface FixedStyle extends StyleDefinition {
+    extends?: string;
+    id?: string;
+}
+interface DynamicStyle {
+    extends?: string;
+    id?: string;
+    build: (collage: CollageSpecifications) => StyleDefinition;
+}
+export type StyleEntry = FixedStyle | DynamicStyle;
 interface TextStyleArgument {
     tag?: string;
     hAlign?: HAlign;
@@ -27,17 +32,18 @@ interface TextStyleArgument {
     color?: string;
     spotColor?: string;
     background?: ElementBackground;
-    border?: ElementBorder;
+    border?: ElementStraightBorder | ElementFrameBorder;
+    mode?: TextElementMode;
     computeTextHeight?: boolean;
 }
 interface ClipartStyleArgument {
-    tag: string;
+    tag?: string;
     id: string;
     colorize?: string;
     colorizeSpotColor?: string;
 }
 interface PhotoStyleArgument {
-    tag: string;
-    border?: ElementBorder;
+    tag?: string;
+    border?: ElementStraightBorder | ElementFrameBorder | ElementMaskBorder;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediaclip/library",
-  "version": "12.0.2",
+  "version": "12.1.0-cd.15420",
   "description": "",
   "types": "dist/index.d.ts",
   "keywords": [],

package/dist/layouts/index.d.ts

@@ -1 +0,0 @@
-export { CollageBuilder } from "../shared/builder";