@mediaclip/library 12.0.1 → 12.0.3

package/README.md

@@ -1,22 +1,8 @@
-# @mediaclip/library
+# Mediaclip Library EcmaScript Themes Typings
 
-To build:
+Learn more about EcmaScript themes at [doc.mediaclip.ca](https://doc.mediaclip.ca/library/themes/es/).
 
 ```bash
-npm i
-npm run build
-```
-
-To link for development:
-
-```bash
-npm link
-cd ../../../../mediaclip-library-test/Library
-npm link @mediaclip/library
-```
-
-To unlink (from the library folder):
-
-```bash
-npm unlink @mediaclip/library
+npm init --yes
+npm i @mediaclip/library
 ```

package/dist/shared/CollageBuilder.d.ts

@@ -1,5 +1,5 @@
-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 { Rect } from "./Rect";
 export interface CollageBuilder {
     readonly marginRect: Rect;
@@ -17,6 +17,7 @@ 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;

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/arguments/AddGeneratedImageElementArgument.d.ts

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

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

@@ -1,8 +1,10 @@
-import { ElementBorder, PhotoFitting } from "../elements";
+import { ElementBorder, FilterInfo, PhotoFitting } from "../elements";
 import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
 export interface AddPhotoElementArgument extends AddVisualElementArgumentBase {
     tag?: string;
     required?: boolean;
+    behavior?: string;
     border?: ElementBorder;
     fitting?: PhotoFitting;
+    filters?: FilterInfo[];
 }

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 { VisualElement } from "./VisualElement";
 export interface BackgroundElement extends VisualElement {
-    readonly type: "BackgroundElement";
     image?: ImageBackgroundResource;
     color: string;
     spotColor?: string;

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

@@ -2,7 +2,6 @@ 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;

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

@@ -3,10 +3,11 @@ import { PhotoFitting } from "./PhotoFitting";
 import { PhotoResource } from "../resources";
 import { VisualElement } from "./VisualElement";
 export interface PhotoElement extends VisualElement {
-    readonly type: "PhotoElement";
     photo: PhotoResource;
     tag?: string;
     required?: boolean;
+    behavior?: string;
     fitting?: PhotoFitting;
     border?: ElementBorder;
+    addFilter(filterType: string): void;
 }

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

@@ -2,7 +2,6 @@ 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;

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

@@ -4,7 +4,6 @@ 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;

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

@@ -5,7 +5,6 @@ import { TextElementMode } from "./TextElementMode";
 import { VAlign } from "./VAlign";
 import { VisualElement } from "./VisualElement";
 export interface TextElement extends VisualElement {
-    readonly type: "TextElement";
     text: string;
     tag?: string;
     mode: TextElementMode;

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/themes/ThemeCollageBuilder.d.ts

@@ -1,5 +1,5 @@
-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";
 export interface ThemeCollageBuilder extends CollageBuilder {
@@ -7,8 +7,6 @@ export interface ThemeCollageBuilder extends CollageBuilder {
     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/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@mediaclip/library",
-  "version": "12.0.1",
+  "version": "12.0.3",
   "description": "",
   "types": "dist/index.d.ts",
   "keywords": [],
   "author": "Mediaclip inc.",
   "license": "GPL-3.0-or-later",
   "files": [
+    "README.md",
     "dist/**/*.d.ts"
   ],
   "scripts": {

package/dist/layouts/index.d.ts

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