@mediaclip/library 1.0.7 → 12.0.1

package/README.md

@@ -0,0 +1,22 @@
+# @mediaclip/library
+
+To build:
+
+```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
+```

package/dist/LayoutInterface.d.ts

@@ -0,0 +1,4 @@
+import * as lib from ".";
+export interface LayoutInterface {
+    create?: (collage: lib.CollageBuilder) => void;
+}

package/dist/ThemeInterface.d.ts

@@ -0,0 +1,9 @@
+import * as lib from "./themes";
+export interface ThemeInterface {
+    beforeAutofill?: (autofill: lib.AutofillData) => void;
+    clustering?: (algo: lib.ClusteringAlgorithmSelector) => void;
+    preload?: (resources: lib.ResourcesLoader) => void;
+    styles?: (styles: lib.StylesContainer) => void;
+    configure?: (selector: lib.CreateSelector) => void;
+    create?: (collage: lib.ThemeCollageBuilder) => void;
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { CollageBuilder, Rect } from "./shared/";
+export * from "./themes/";
+export { ThemeInterface } from "./ThemeInterface";
+export { LayoutInterface } from "./LayoutInterface";

package/dist/layouts/index.d.ts

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

package/dist/shared/CollageBuilder.d.ts

@@ -0,0 +1,23 @@
+import { AddClipartElementArgument, AddPhotoElementArgument, AddStaticImageElementArgument, AddStaticTextElementArgument, AddTextElementArgument } from "./arguments";
+import { ClipartElement, PhotoElement, StaticImageElement, StaticTextElement, TextElement, VisualElement } from "./elements";
+import { Rect } from "./Rect";
+export interface CollageBuilder {
+    readonly marginRect: Rect;
+    readonly fullPageRect: Rect;
+    readonly width: number;
+    readonly height: number;
+    readonly bleed: number;
+    spacing: number;
+    marginTop: number;
+    marginRight: number;
+    marginBottom: number;
+    marginLeft: number;
+    readonly elements: VisualElement[];
+    readonly staticElements: VisualElement[];
+    addPhoto(value?: AddPhotoElementArgument): PhotoElement;
+    addText(value?: AddTextElementArgument): TextElement;
+    addClipart(value?: AddClipartElementArgument): ClipartElement;
+    addStaticText(value?: AddStaticTextElementArgument): StaticTextElement;
+    addStaticImage(value?: AddStaticImageElementArgument): StaticImageElement;
+    log(value: undefined | number | string | unknown): void;
+}

package/dist/shared/Modules.d.ts

@@ -0,0 +1 @@
+export type Modules = "Photobook" | "Gifting" | "Print";

package/dist/shared/Rect.d.ts

@@ -0,0 +1,16 @@
+export interface IRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    rotation: number;
+    right: number;
+    bottom: number;
+}
+export interface Rect extends IRect {
+    split(value: {
+        rows?: number | number[];
+        columns?: number | number[];
+        spacing?: number;
+    }): Rect[];
+}

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

@@ -0,0 +1,8 @@
+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/AddPhotoElementArgument.d.ts

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

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,17 @@
+import { ElementBackground, ElementBorder, HAlign, VAlign } from "../elements";
+import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
+export interface AddStaticTextElementArgument extends AddVisualElementArgumentBase {
+    text?: string;
+    tag?: string;
+    hAlign?: HAlign;
+    vAlign?: VAlign;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    fontFamily?: string;
+    fontSize?: number;
+    color?: string;
+    spotColor?: string;
+    background?: ElementBackground;
+    border?: ElementBorder;
+}

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

@@ -0,0 +1,22 @@
+import { ElementBackground, ElementBorder, HAlign, TextElementMode, VAlign } from "../elements";
+import { AddVisualElementArgumentBase } from "./AddVisualElementArgumentBase";
+export interface AddTextElementArgument extends AddVisualElementArgumentBase {
+    text?: string;
+    tag?: string;
+    mode?: TextElementMode;
+    required?: boolean;
+    behavior?: string;
+    maxCharacters?: number;
+    maxHeight?: number;
+    hAlign?: HAlign;
+    vAlign?: VAlign;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    fontFamily?: string;
+    fontSize?: number;
+    color?: string;
+    spotColor?: string;
+    background?: ElementBackground;
+    border?: ElementBorder;
+}

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

@@ -0,0 +1,10 @@
+import { Rect } from "../Rect";
+import { VisualElement } from "../elements/VisualElement";
+export interface AddVisualElementArgumentBase {
+    rect?: VisualElement | Rect;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    rotation?: number;
+}

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

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

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

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

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

@@ -0,0 +1,11 @@
+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/ElementBackground.d.ts

@@ -0,0 +1,6 @@
+export interface ElementBackground {
+    /** A hexadecimal color, e.g. #000000 for black */
+    color: string;
+    /** Between 0 (transparent) and 1 (opaque) */
+    opacity: number;
+}

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

@@ -0,0 +1,6 @@
+export interface ElementBorder {
+    /** A hexadecimal color, e.g. #000000 for black */
+    color: string;
+    /** The size of the border in 300 DPI points */
+    size: number;
+}

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

@@ -0,0 +1 @@
+export type HAlign = "Left" | "Middle" | "Right";

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

@@ -0,0 +1,12 @@
+import { ElementBorder } from "./ElementBorder";
+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;
+    fitting?: PhotoFitting;
+    border?: ElementBorder;
+}

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

@@ -0,0 +1 @@
+export type PhotoFitting = "FillIn" | "FitIn" | "FitFrame";

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,21 @@
+import { ElementBackground } from "./ElementBackground";
+import { ElementBorder } 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;
+    vAlign: VAlign;
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    fontFamily: string;
+    fontSize: number;
+    color: string;
+    spotColor?: string;
+    background?: ElementBackground;
+    border?: ElementBorder;
+}

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

@@ -0,0 +1,27 @@
+import { ElementBackground } from "./ElementBackground";
+import { ElementBorder } from "./ElementBorder";
+import { HAlign } from "./HAlign";
+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;
+    required: boolean;
+    behavior?: string;
+    maxCharacters: number;
+    maxHeight: number;
+    hAlign: HAlign;
+    vAlign: VAlign;
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    fontFamily: string;
+    fontSize: number;
+    color: string;
+    spotColor?: string;
+    background?: ElementBackground;
+    border?: ElementBorder;
+}

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

@@ -0,0 +1 @@
+export type TextElementMode = "TextElementMode" | "DynamicFontSize" | "Fixed";

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

@@ -0,0 +1 @@
+export type VAlign = "Top" | "Middle" | "Bottom";

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

@@ -0,0 +1,12 @@
+import { IRect, Rect } from "../Rect";
+export interface VisualElement extends IRect {
+    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

@@ -0,0 +1,13 @@
+export * from "./BackgroundElement";
+export * from "./ClipartElement";
+export * from "./ElementBackground";
+export * from "./ElementBorder";
+export * from "./HAlign";
+export * from "./PhotoElement";
+export * from "./StaticImageElement";
+export * from "./StaticTextElement";
+export * from "./TextElement";
+export * from "./TextElementMode";
+export * from "./VAlign";
+export * from "./VisualElement";
+export * from "./PhotoFitting";

package/dist/shared/index.d.ts

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

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

@@ -0,0 +1,11 @@
+export declare enum Anchor {
+    "Center" = 0,
+    "TopLeft" = 1,
+    "Top" = 2,
+    "TopRight" = 3,
+    "Left" = 4,
+    "Right" = 5,
+    "BottomLeft" = 6,
+    "Bottom" = 7,
+    "BottomRight" = 8
+}

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

@@ -0,0 +1,5 @@
+import { ImageResourceBase } from "./ImageResourceBase";
+export interface ClipartResource extends ImageResourceBase {
+    readonly colorize: string;
+    readonly colorizeSpotColor: string;
+}

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

@@ -0,0 +1,10 @@
+import { Anchor } from "./Anchor";
+import { ImageResourceBase } from "./ImageResourceBase";
+export interface ImageBackgroundResource extends ImageResourceBase {
+    readonly anchor: Anchor;
+    readonly transparent: boolean;
+    readonly color: string;
+    readonly colorize: string;
+    readonly spotColor: string;
+    readonly colorizeSpotColor: string;
+}

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

@@ -0,0 +1,5 @@
+import { ResourceBase } from "./ResourceBase";
+export interface ImageResourceBase extends ResourceBase {
+    readonly width: number;
+    readonly height: number;
+}

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

@@ -0,0 +1,6 @@
+export interface PhotoResource {
+    readonly width: number;
+    readonly height: number;
+    readonly filename: string;
+    readonly metadata: Record<string, string>;
+}

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

@@ -0,0 +1,3 @@
+export interface ResourceBase {
+    readonly id: string;
+}

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

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

package/dist/themes/AutofillData.d.ts

@@ -0,0 +1,7 @@
+import { PhotoResource } from "../shared/resources";
+export interface AutofillData {
+    sets: Record<string, AutofillSet>;
+}
+export interface AutofillSet {
+    photos: PhotoResource[];
+}

package/dist/themes/Format.d.ts

@@ -0,0 +1,19 @@
+export type Format = PhotobookFormat | GiftingFormat | PrintFormat;
+export interface FormatBase {
+    getCollageIds: () => string[];
+    getCollageDimensions: (collageId: string) => CollageDimensions;
+}
+export interface CollageDimensions {
+    readonly width: number;
+    readonly height: number;
+    readonly bleed: number;
+}
+export interface PhotobookFormat extends FormatBase {
+    readonly type: "photobook";
+}
+export interface GiftingFormat extends FormatBase {
+    readonly type: "gifting";
+}
+export interface PrintFormat extends FormatBase {
+    readonly type: "print";
+}

package/dist/themes/PhotosContainer.d.ts

@@ -0,0 +1,6 @@
+import { PhotoResource } from "../shared/resources";
+export interface PhotosContainer {
+    remaining: number;
+    take(): PhotoResource | undefined;
+    take(count: number): PhotoResource[];
+}

package/dist/themes/ResourcesLoader.d.ts

@@ -0,0 +1,6 @@
+export interface ResourcesLoader {
+    load(value: string | string[] | {
+        name: string;
+        resources: string[];
+    }): void;
+}

package/dist/themes/ThemeCollageBuilder.d.ts

@@ -0,0 +1,14 @@
+import { AddClipartElementArgument, AddPhotoElementArgument, AddStaticImageElementArgument, AddTextElementArgument, SetBackgroundElementArgument } from "./arguments";
+import { BackgroundElement, ClipartElement, PhotoElement, StaticImageElement, TextElement } from "../shared/elements";
+import { CollageBuilder } from "../shared";
+import { PhotosContainer } from "./PhotosContainer";
+export interface ThemeCollageBuilder extends CollageBuilder {
+    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;
+}

package/dist/themes/ThemeContext.d.ts

@@ -0,0 +1,8 @@
+import { Format } from "./Format";
+import { Modules } from "../shared";
+export interface ThemeContext {
+    readonly module: Modules;
+    readonly culture: string;
+    readonly format: Format;
+    getOption(key: string): string;
+}

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

@@ -0,0 +1,4 @@
+import { AddClipartElementArgument as AddClipartElementArgumentBase } from "../../shared/arguments";
+export interface AddClipartElementArgument extends AddClipartElementArgumentBase {
+    id?: string;
+}

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

@@ -0,0 +1,5 @@
+import { AddPhotoElementArgument as AddPhotoElementArgumentBase } from "../../shared/arguments";
+import { PhotoResource } from "../../shared/resources";
+export interface AddPhotoElementArgument extends AddPhotoElementArgumentBase {
+    photo?: PhotoResource;
+}

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

@@ -0,0 +1,4 @@
+import { AddStaticImageElementArgument as AddStaticImageElementArgumentBase } from "../../shared/arguments";
+export interface AddStaticImageElementArgument extends AddStaticImageElementArgumentBase {
+    id?: string;
+}

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

@@ -0,0 +1,3 @@
+import { AddStaticTextElementArgument as AddStaticTextElementArgumentBase } from "../../shared/arguments";
+export interface AddStaticTextElementArgument extends AddStaticTextElementArgumentBase {
+}

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

@@ -0,0 +1,3 @@
+import { AddTextElementArgument as AddTextElementArgumentBase } from "../../shared/arguments";
+export interface AddTextElementArgument extends AddTextElementArgumentBase {
+}

package/dist/themes/arguments/SetBackgroundElementArgument.d.ts

@@ -0,0 +1,7 @@
+export interface SetBackgroundElementArgument {
+    id?: string;
+    color?: string;
+    spotColor?: string;
+    colorize?: string;
+    colorizeSpotColor?: string;
+}

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

@@ -0,0 +1,6 @@
+export * from "./AddClipartElementArgument";
+export * from "./AddPhotoElementArgument";
+export * from "./AddStaticImageElementArgument";
+export * from "./AddStaticTextElementArgument";
+export * from "./AddTextElementArgument";
+export * from "./SetBackgroundElementArgument";

package/dist/themes/clustering/BlankAlgorithmSettings.d.ts

@@ -0,0 +1,3 @@
+import { ClusteringAlgorithmSettingsBase } from "./ClusteringAlgorithmSettingsBase";
+export interface BlankAlgorithmSettings extends ClusteringAlgorithmSettingsBase {
+}

package/dist/themes/clustering/ClusteringAlgorithmSelector.d.ts

@@ -0,0 +1,8 @@
+import { BlankAlgorithmSettings } from "./BlankAlgorithmSettings";
+import { FixedGroupAlgorithmSettings } from "./FixedGroupAlgorithmSettings";
+import { GroupByDateAlgorithmSettings } from "./GroupByDateAlgorithmSettings";
+export interface ClusteringAlgorithmSelector {
+    blank: (settings: BlankAlgorithmSettings) => void;
+    fixedGroup: (settings: FixedGroupAlgorithmSettings) => void;
+    groupByDate: (settings: GroupByDateAlgorithmSettings) => void;
+}

package/dist/themes/clustering/ClusteringAlgorithmSettingsBase.d.ts

@@ -0,0 +1,7 @@
+import { AutofillSet } from "../AutofillData";
+import { PhotoResource } from "../../shared/resources";
+export interface ClusteringAlgorithmSettingsBase {
+    source?: string;
+    ids?: string[];
+    filter?: (set: AutofillSet) => PhotoResource[];
+}

package/dist/themes/clustering/FixedGroupAlgorithmSettings.d.ts

@@ -0,0 +1,4 @@
+import { ClusteringAlgorithmSettingsBase } from "./ClusteringAlgorithmSettingsBase";
+export interface FixedGroupAlgorithmSettings extends ClusteringAlgorithmSettingsBase {
+    photosPerGroup: number;
+}

package/dist/themes/clustering/GroupByDateAlgorithmSettings.d.ts

@@ -0,0 +1,4 @@
+import { ClusteringAlgorithmSettingsBase } from "./ClusteringAlgorithmSettingsBase";
+export interface GroupByDateAlgorithmSettings extends ClusteringAlgorithmSettingsBase {
+    maxPhotosPerGroup?: number;
+}

package/dist/themes/clustering/index.d.ts

@@ -0,0 +1 @@
+export * from "./ClusteringAlgorithmSelector";

package/dist/themes/index.d.ts

@@ -0,0 +1,8 @@
+export { ClusteringAlgorithmSelector } from "./clustering/";
+export { PhotosContainer } from "./PhotosContainer";
+export { ResourcesLoader } from "./ResourcesLoader";
+export { CreateSelector } from "./selector/";
+export { StylesContainer } from "./styles/";
+export { ThemeCollageBuilder } from "./ThemeCollageBuilder";
+export { AutofillData, AutofillSet } from "./AutofillData";
+export { ThemeContext } from "./ThemeContext";

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

@@ -0,0 +1,5 @@
+import { SelectorEntry } from "./SelectorEntry";
+import { SelectorRule } from "./SelectorRule";
+export interface CreateSelector {
+    when: (rule: SelectorRule) => SelectorEntry;
+}

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

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

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

@@ -0,0 +1,7 @@
+export interface SelectorRule {
+    id: string | string[];
+    photos?: number | {
+        min: number;
+        max: number;
+    };
+}

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

@@ -0,0 +1 @@
+export * from "./CreateSelector";