@chili-publish/studio-sdk 0.121.0

package/lib/src/types/ColorStyleTypes.d.ts

@@ -0,0 +1,73 @@
+export declare enum ColorType {
+    rgb = "rgb",
+    cmyk = "cmyk",
+    lab = "lab",
+    gray = "gray",
+    xyz = "xyz",
+    hls = "hls",
+    spotCmyk = "spotCmyk",
+    spotRgb = "spotRgb",
+    custom = "custom"
+}
+export declare type ColorUpdate = {
+    r: number;
+    g: number;
+    b: number;
+    colorType: ColorType;
+};
+export declare type Color = {
+    colorType: ColorType;
+    r: number;
+    g: number;
+    b: number;
+    displayValue?: string;
+};
+export declare type DocumentColor = {
+    id: string;
+    name: string;
+    color: Color;
+};
+export declare type ColorUsageUpdate = {
+    /**
+     * Reference to the stylekit color, can only be used if it is a stylekit color.
+     */
+    colorId?: string;
+    /**
+     * The local color object, can only be used if it is a local color.
+     */
+    color?: ColorUpdate;
+    usageType: ColorUsageType;
+    /**
+     * Opacity of the color (0-100) where 0 = fully transparent.
+     */
+    opacity?: number;
+    /**
+     * Indicates if the color will be applied or not.
+     */
+    isApplied?: boolean;
+};
+export declare type ColorUsage = {
+    /**
+     * Reference to the stylekit color, can only be used if it is a stylekit color.
+     */
+    colorId?: string;
+    /**
+     * The local color object, can only be used if it is a local color.
+     */
+    color?: Color;
+    usageType: ColorUsageType;
+    /**
+     * Opacity of the color (0-100) where 0 = fully transparent.
+     */
+    opacity?: number;
+};
+export declare enum ColorUsageType {
+    /**
+     * The color is defined locally on the object
+     */
+    local = "local",
+    /**
+     * THe color is referencing a stylekit color
+     */
+    stylekit = "stylekit"
+}

package/lib/src/types/ColorStyleTypes.js

@@ -0,0 +1,24 @@
+export var ColorType;
+(function (ColorType) {
+    ColorType["rgb"] = "rgb";
+    ColorType["cmyk"] = "cmyk";
+    ColorType["lab"] = "lab";
+    ColorType["gray"] = "gray";
+    ColorType["xyz"] = "xyz";
+    ColorType["hls"] = "hls";
+    ColorType["spotCmyk"] = "spotCmyk";
+    ColorType["spotRgb"] = "spotRgb";
+    ColorType["custom"] = "custom";
+})(ColorType || (ColorType = {}));
+export var ColorUsageType;
+(function (ColorUsageType) {
+    /**
+     * The color is defined locally on the object
+     */
+    ColorUsageType["local"] = "local";
+    /**
+     * THe color is referencing a stylekit color
+     */
+    ColorUsageType["stylekit"] = "stylekit";
+})(ColorUsageType || (ColorUsageType = {}));
+//# sourceMappingURL=ColorStyleTypes.js.map

package/lib/src/types/ColorStyleTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ColorStyleTypes.js","sourceRoot":"","sources":["../../../src/types/ColorStyleTypes.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACjB,wBAAW,CAAA;IACX,0BAAa,CAAA;IACb,wBAAW,CAAA;IACX,0BAAa,CAAA;IACb,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;AACrB,CAAC,EAVW,SAAS,KAAT,SAAS,QAUpB;AA2DD,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACtB;;OAEG;IACH,iCAAe,CAAA;IACf;;OAEG;IACH,uCAAqB,CAAA;AACzB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB"}

package/lib/src/types/CommonTypes.d.ts

@@ -0,0 +1,92 @@
+import { CallSender } from 'penpal';
+import { AnimationPlaybackType, FrameAnimationType } from './AnimationTypes';
+import { LayoutListItemType, LayoutPropertiesType, LayoutWithFrameProperties } from './LayoutTypes';
+import type { FrameType } from './FrameTypes';
+import { Frame, FrameLayoutType, FrameTypeEnum } from './FrameTypes';
+import { Variable } from './VariableTypes';
+import { DocumentAction, ToolType } from '..';
+import { DocumentType, UndoState } from './DocumentTypes';
+import { DocumentColor } from './ColorStyleTypes';
+import { ParagraphStyle } from './ParagraphStyleTypes';
+import { DocumentFont } from './FontTypes';
+import { CharacterStyle } from './CharacterStyleTypes';
+import { ConnectorEvent } from './ConnectorTypes';
+import { PageSize } from './PageTypes';
+import { SelectedTextStyle } from './TextStyleTypes';
+import { CornerRadius } from './ShapeTypes';
+export declare type Id = string;
+export declare type ConfigType = {
+    onActionsChanged?: (state: DocumentAction[]) => void;
+    onStateChanged?: () => void;
+    onDocumentLoaded?: () => void;
+    onSelectedFrameLayoutChanged?: (state: FrameLayoutType) => void;
+    onSelectedFrameContentChanged?: (state: Frame) => void;
+    editorLink?: string;
+    editorId?: string;
+    chiliEnvironmentUrl?: string;
+    documentType?: DocumentType;
+    onPageSelectionChanged?: () => void;
+    onSelectedLayoutPropertiesChanged?: (state: LayoutPropertiesType) => void;
+    onScrubberPositionChanged?: (state: AnimationPlaybackType) => void;
+    onFrameAnimationsChanged?: (animationState: FrameAnimationType[]) => void;
+    onVariableListChanged?: (variableList: Variable[]) => void;
+    onSelectedToolChanged?: (tool: ToolType) => void;
+    onUndoStackStateChanged?: (undoStackState: UndoState) => void;
+    onSelectedLayoutFramesChanged?: (frames: SelectedLayoutFrame[]) => void;
+    onSelectedTextStyleChanged?: (styles: SelectedTextStyle) => void;
+    onColorsChanged?: (colors: DocumentColor[]) => void;
+    onParagraphStylesChanged?: (paragraphStyles: ParagraphStyle[]) => void;
+    onCharacterStylesChanged?: (characterStyles: CharacterStyle[]) => void;
+    onFontsChanged?: (fonts: DocumentFont[]) => void;
+    onSelectedLayoutIdChanged?: (layoutId: string) => void;
+    onLayoutsChanged?: (layouts: LayoutListItemType[]) => void;
+    onConnectorEvent?: (event: ConnectorEvent) => void;
+    onZoomChanged?: (scaleFactor: number) => void;
+    onPageSizeChanged?: (pageSize: PageSize) => void;
+    onShapeCornerRadiusChanged?: (cornerRadius: CornerRadius) => void;
+};
+export interface EditorResponse<T> {
+    success: boolean;
+    status: number;
+    data?: string | null;
+    error?: string | {
+        code: number;
+        error: Record<string, unknown>;
+    } | null;
+    parsedData: T | null;
+}
+export interface EditorRawAPI extends CallSender {
+    [index: string]: <T>(...args: unknown[]) => Promise<T>;
+}
+export interface EditorAPI extends CallSender {
+    [index: string]: <T>(...args: unknown[]) => Promise<EditorResponse<T>>;
+}
+export declare type PageType = {
+    pageId: Id;
+    pageNumber: number;
+    width: number | null;
+    height: number | null;
+    frames: FrameType[];
+};
+export declare type InitialStateType = {
+    layouts: LayoutWithFrameProperties[];
+    selectedLayoutId: Id;
+    pages: PageType[];
+    variables: Variable[];
+};
+export interface PropertyState<T> {
+    value: T;
+    isOverride: boolean;
+}
+export interface SelectedLayoutFrame {
+    frameId: Id;
+    frameName: string;
+    frameType: FrameTypeEnum;
+    included: boolean;
+}
+export interface MetaData {
+    [key: string]: string;
+}
+export interface ConnectorOptions {
+    [key: string]: string;
+}

package/lib/src/types/CommonTypes.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CommonTypes.js.map

package/lib/src/types/CommonTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonTypes.js","sourceRoot":"","sources":["../../../src/types/CommonTypes.ts"],"names":[],"mappings":""}

package/lib/src/types/ConfigurationTypes.d.ts

@@ -0,0 +1,6 @@
+export declare enum WellKnownConfigurationKeys {
+    GraFxStudioEnvironmentApiUrl = "ENVIRONMENT_API",
+    GraFxStudioSdkVersion = "SDK_VERSION",
+    GraFxStudioDocumentType = "DOCUMENT_TYPE",
+    GraFxStudioTemplateId = "TEMPLATE_ID"
+}

package/lib/src/types/ConfigurationTypes.js

@@ -0,0 +1,8 @@
+export var WellKnownConfigurationKeys;
+(function (WellKnownConfigurationKeys) {
+    WellKnownConfigurationKeys["GraFxStudioEnvironmentApiUrl"] = "ENVIRONMENT_API";
+    WellKnownConfigurationKeys["GraFxStudioSdkVersion"] = "SDK_VERSION";
+    WellKnownConfigurationKeys["GraFxStudioDocumentType"] = "DOCUMENT_TYPE";
+    WellKnownConfigurationKeys["GraFxStudioTemplateId"] = "TEMPLATE_ID";
+})(WellKnownConfigurationKeys || (WellKnownConfigurationKeys = {}));
+//# sourceMappingURL=ConfigurationTypes.js.map

package/lib/src/types/ConfigurationTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationTypes.js","sourceRoot":"","sources":["../../../src/types/ConfigurationTypes.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,0BAKX;AALD,WAAY,0BAA0B;IAClC,8EAAgD,CAAA;IAChD,mEAAqC,CAAA;IACrC,uEAAyC,CAAA;IACzC,mEAAqC,CAAA;AACzC,CAAC,EALW,0BAA0B,KAA1B,0BAA0B,QAKrC"}

package/lib/src/types/ConnectorTypes.d.ts

@@ -0,0 +1,115 @@
+export declare enum DeprecatedMediaType {
+    file = 0,
+    collection = 1
+}
+export declare enum MediaType {
+    file = "file",
+    collection = "collection"
+}
+export declare enum SortBy {
+    name = "name",
+    path = "relativePath",
+    id = "id"
+}
+export declare enum SortOrder {
+    ascending = "asc",
+    descending = "desc"
+}
+export declare type QueryOptions = {
+    filter?: string[] | null;
+    collection?: string | null;
+    pageToken?: string | null;
+    pageSize?: number | null;
+    sortBy?: SortBy | null;
+    sortOrder?: SortOrder | null;
+};
+export declare type ConnectorCapabilities = {
+    filtering?: boolean;
+    upload?: boolean;
+    query?: boolean;
+    remove?: boolean;
+    copy?: boolean;
+};
+export declare type ConnectorRegistration = {
+    id: string;
+    source: ConnectorRegistrationSource;
+    url: string;
+};
+export declare enum ConnectorRegistrationSource {
+    url = "url"
+}
+export declare class ConnectorMapping {
+    name: string;
+    value: string;
+    constructor(mapTo: ConnectorMappingTarget, contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string);
+}
+export declare type ConnectorState = {
+    id: string;
+    type: ConnectorStateType;
+};
+export declare type ConnectorEvent = {
+    id: string;
+    type: ConnectorEventType;
+};
+export declare type QueryPage<T> = {
+    nextPageToken?: string;
+    data: T[];
+};
+export declare enum ConnectorMappingTarget {
+    query = "query",
+    download = "download"
+}
+export declare enum ConnectorMappingSource {
+    variable = "var"
+}
+export declare enum ConnectorStateType {
+    /**
+     * Connector loading process has started.
+     * Any SDK methods that required the connector id, will start working now.
+     */
+    loading = "loading",
+    /**
+     * Connector loading completed.
+     */
+    loaded = "loaded",
+    /**
+     * Connector is running in QuickJS.
+     */
+    running = "running",
+    /**
+     * Connector is fully configured and has the correct authentication information.
+     * At this point the connector is ready to make requests.
+     */
+    ready = "ready",
+    /**
+     * Something went wrong, the connector is in error state.
+     * Check the error message for more information.
+     */
+    error = "error"
+}
+export declare enum ConnectorEventType {
+    /**
+     * This event will be triggered by the following state changes of the connector
+     * - loading
+     * - loaded
+     * - running
+     * - ready
+     * - error
+     */
+    stateChanged = "stateChanged",
+    /**
+     * Authentication information is changed
+     */
+    authChanged = "authChanged",
+    /**
+     * Connector configuration changed that requires the connector to be reloaded in QuickJS.
+     * This will trigger multiple 'stateChanged' events while it is reloading.
+     * Wait until 'ready'-stateChanged event is received to start using the connector again.
+     */
+    reloadRequired = "reloadRequired",
+    /**
+     * Connector is unregistered and no longer exists inside the editor engine.
+     * Don't use the 'connectorId' after receiving this event.
+     */
+    unloaded = "unloaded"
+}

package/lib/src/types/ConnectorTypes.js

@@ -0,0 +1,94 @@
+export var DeprecatedMediaType;
+(function (DeprecatedMediaType) {
+    DeprecatedMediaType[DeprecatedMediaType["file"] = 0] = "file";
+    DeprecatedMediaType[DeprecatedMediaType["collection"] = 1] = "collection";
+})(DeprecatedMediaType || (DeprecatedMediaType = {}));
+export var MediaType;
+(function (MediaType) {
+    MediaType["file"] = "file";
+    MediaType["collection"] = "collection";
+})(MediaType || (MediaType = {}));
+export var SortBy;
+(function (SortBy) {
+    SortBy["name"] = "name";
+    SortBy["path"] = "relativePath";
+    SortBy["id"] = "id";
+})(SortBy || (SortBy = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ascending"] = "asc";
+    SortOrder["descending"] = "desc";
+})(SortOrder || (SortOrder = {}));
+export var ConnectorRegistrationSource;
+(function (ConnectorRegistrationSource) {
+    ConnectorRegistrationSource["url"] = "url";
+})(ConnectorRegistrationSource || (ConnectorRegistrationSource = {}));
+export class ConnectorMapping {
+    constructor(mapTo, contextProperty, mapFrom, sourceValue) {
+        this.name = `${mapTo}.${contextProperty}`;
+        this.value = `${mapFrom}.${sourceValue}`;
+    }
+}
+export var ConnectorMappingTarget;
+(function (ConnectorMappingTarget) {
+    ConnectorMappingTarget["query"] = "query";
+    ConnectorMappingTarget["download"] = "download";
+})(ConnectorMappingTarget || (ConnectorMappingTarget = {}));
+export var ConnectorMappingSource;
+(function (ConnectorMappingSource) {
+    ConnectorMappingSource["variable"] = "var";
+})(ConnectorMappingSource || (ConnectorMappingSource = {}));
+export var ConnectorStateType;
+(function (ConnectorStateType) {
+    /**
+     * Connector loading process has started.
+     * Any SDK methods that required the connector id, will start working now.
+     */
+    ConnectorStateType["loading"] = "loading";
+    /**
+     * Connector loading completed.
+     */
+    ConnectorStateType["loaded"] = "loaded";
+    /**
+     * Connector is running in QuickJS.
+     */
+    ConnectorStateType["running"] = "running";
+    /**
+     * Connector is fully configured and has the correct authentication information.
+     * At this point the connector is ready to make requests.
+     */
+    ConnectorStateType["ready"] = "ready";
+    /**
+     * Something went wrong, the connector is in error state.
+     * Check the error message for more information.
+     */
+    ConnectorStateType["error"] = "error";
+})(ConnectorStateType || (ConnectorStateType = {}));
+export var ConnectorEventType;
+(function (ConnectorEventType) {
+    /**
+     * This event will be triggered by the following state changes of the connector
+     * - loading
+     * - loaded
+     * - running
+     * - ready
+     * - error
+     */
+    ConnectorEventType["stateChanged"] = "stateChanged";
+    /**
+     * Authentication information is changed
+     */
+    ConnectorEventType["authChanged"] = "authChanged";
+    /**
+     * Connector configuration changed that requires the connector to be reloaded in QuickJS.
+     * This will trigger multiple 'stateChanged' events while it is reloading.
+     * Wait until 'ready'-stateChanged event is received to start using the connector again.
+     */
+    ConnectorEventType["reloadRequired"] = "reloadRequired";
+    /**
+     * Connector is unregistered and no longer exists inside the editor engine.
+     * Don't use the 'connectorId' after receiving this event.
+     */
+    ConnectorEventType["unloaded"] = "unloaded";
+})(ConnectorEventType || (ConnectorEventType = {}));
+//# sourceMappingURL=ConnectorTypes.js.map

package/lib/src/types/ConnectorTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectorTypes.js","sourceRoot":"","sources":["../../../src/types/ConnectorTypes.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,6DAAQ,CAAA;IACR,yEAAc,CAAA;AAClB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AAED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,0BAAa,CAAA;IACb,sCAAyB,CAAA;AAC7B,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IACd,uBAAa,CAAA;IACb,+BAAqB,CAAA;IACrB,mBAAS,CAAA;AACb,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AAED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;AACvB,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAyBD,MAAM,CAAN,IAAY,2BAEX;AAFD,WAAY,2BAA2B;IACnC,0CAAW,CAAA;AACf,CAAC,EAFW,2BAA2B,KAA3B,2BAA2B,QAEtC;AAED,MAAM,OAAO,gBAAgB;IAIzB,YACI,KAA6B,EAC7B,eAAuB,EACvB,OAA+B,EAC/B,WAAmB;QAEnB,IAAI,CAAC,IAAI,GAAG,GAAG,KAAK,IAAI,eAAe,EAAE,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,GAAG,OAAO,IAAI,WAAW,EAAE,CAAC;IAC7C,CAAC;CACJ;AAiBD,MAAM,CAAN,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAC9B,yCAAe,CAAA;IACf,+CAAqB,CAAA;AACzB,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,QAGjC;AAED,MAAM,CAAN,IAAY,sBAEX;AAFD,WAAY,sBAAsB;IAC9B,0CAAgB,CAAA;AACpB,CAAC,EAFW,sBAAsB,KAAtB,sBAAsB,QAEjC;AAED,MAAM,CAAN,IAAY,kBA6BX;AA7BD,WAAY,kBAAkB;IAC1B;;;OAGG;IACH,yCAAmB,CAAA;IAEnB;;OAEG;IACH,uCAAiB,CAAA;IAEjB;;OAEG;IAEH,yCAAmB,CAAA;IAEnB;;;OAGG;IACH,qCAAe,CAAA;IAEf;;;OAGG;IACH,qCAAe,CAAA;AACnB,CAAC,EA7BW,kBAAkB,KAAlB,kBAAkB,QA6B7B;AAED,MAAM,CAAN,IAAY,kBA4BX;AA5BD,WAAY,kBAAkB;IAC1B;;;;;;;OAOG;IACH,mDAA6B,CAAA;IAE7B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;;;OAIG;IACH,uDAAiC,CAAA;IAEjC;;;OAGG;IACH,2CAAqB,CAAA;AACzB,CAAC,EA5BW,kBAAkB,KAAlB,kBAAkB,QA4B7B"}

package/lib/src/types/DebugTypes.d.ts

@@ -0,0 +1,25 @@
+declare enum CallStatus {
+    loading = "loading",
+    success = "success",
+    error = "error"
+}
+declare type DebugVar = {
+    name: string;
+    type: string;
+};
+declare type ApiResponse = {
+    status: number;
+    error: string;
+    data: string;
+    type: string;
+};
+export declare type DebugData = {
+    title: string;
+    vars: DebugVar[];
+    response: ApiResponse;
+    startTime: Date;
+    endTime: Date;
+    incoming: boolean;
+    status: CallStatus;
+};
+export {};

package/lib/src/types/DebugTypes.js

@@ -0,0 +1,8 @@
+var CallStatus;
+(function (CallStatus) {
+    CallStatus["loading"] = "loading";
+    CallStatus["success"] = "success";
+    CallStatus["error"] = "error";
+})(CallStatus || (CallStatus = {}));
+export {};
+//# sourceMappingURL=DebugTypes.js.map

package/lib/src/types/DebugTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DebugTypes.js","sourceRoot":"","sources":["../../../src/types/DebugTypes.ts"],"names":[],"mappings":"AAAA,IAAK,UAIJ;AAJD,WAAK,UAAU;IACX,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,6BAAe,CAAA;AACnB,CAAC,EAJI,UAAU,KAAV,UAAU,QAId"}

package/lib/src/types/DocumentTypes.d.ts

@@ -0,0 +1,180 @@
+import { BasicAnimationsEmphasisType, BasicAnimationsIntroType, BasicAnimationsOutroType } from './AnimationTypes';
+import { DocumentColor } from './ColorStyleTypes';
+import { Id } from './CommonTypes';
+import { BlendMode, FrameTypeEnum } from './FrameTypes';
+import { LayoutType } from './LayoutTypes';
+import { ParagraphStyle } from './ParagraphStyleTypes';
+import { Variable } from './VariableTypes';
+import { CharacterStyle } from './CharacterStyleTypes';
+import { DocumentAction } from './ActionTypes';
+import { ShapeProperties, ShapeType } from './ShapeTypes';
+export declare type DocumentError = {
+    error: Record<string, unknown>;
+    code: number;
+};
+export declare type UndoState = {
+    canUndo: boolean;
+    canRedo: boolean;
+    undoItemName: OperationName;
+    redoItemName: OperationName;
+};
+export declare type OperationName = {
+    translationKey: number;
+    name: string;
+};
+/**
+ * This type should give a clear indication of how the JSON document is structured. This could help you with building a test document yourself.
+ */
+export interface ChiliDocument {
+    selectedLayoutId: string;
+    properties?: TemplateDocumentProperties | ProjectDocumentProperties;
+    pages: DocumentPage[];
+    layouts: (ChildLayout | TopLayout)[];
+    styleKit: DocumentStyleKit;
+    variables: Variable[];
+    actions: DocumentAction[];
+}
+export interface DocumentPage {
+    pageId: string;
+    pageNumber: number;
+    frames: (ImageFrame | TextFrame | ShapeFrame)[];
+}
+export interface DocumentFrame {
+    frameId: string;
+    frameName: string;
+    frameType: FrameTypeEnum;
+    blendMode: BlendMode;
+    constrainProportions: boolean;
+}
+export interface ImageFrame extends DocumentFrame {
+    src: VariableImageFrameSource | AssetProviderImageFrameSource | UrlImageFrameSource;
+}
+export interface ShapeFrame extends DocumentFrame {
+    shapeType: ShapeType;
+    shapeProperties: ShapeProperties;
+}
+export interface TextFrame extends DocumentFrame {
+    textContent: string;
+    paddingLeft: number;
+    paddingTop: number;
+    paddingRight: number;
+    paddingBottom: number;
+    numberOfColumns: number;
+    columnGap: number;
+    textDirection: string;
+    flowDirection: string;
+    verticalAlign: string;
+    textStroke: boolean;
+    textStrokeWeight: number;
+    textStrokeColor: number;
+    hasClippingPath: boolean;
+}
+export declare enum ImageFrameSourceType {
+    url = "url",
+    assetProvider = "assetProvider",
+    variable = "variable"
+}
+export interface ImageFrameSource {
+    sourceType: ImageFrameSourceType;
+}
+export interface UrlImageFrameSource extends ImageFrameSource {
+    url: string;
+}
+export interface AssetProviderImageFrameSource extends ImageFrameSource {
+    providerId: string;
+    assetId: string;
+}
+export interface VariableImageFrameSource extends ImageFrameSource {
+    variableId: string;
+}
+export interface Layout {
+    layoutId: string;
+    layoutName: string;
+    frameProperties: (ChildFrameProperty | TopFrameProperty)[];
+    width?: number;
+    height?: number;
+    childLayouts: string[];
+    layoutType: LayoutType;
+    frameAnimations?: FrameAnimation[];
+    timelineLengthMs?: number;
+    animated?: boolean;
+}
+export interface TopLayout extends Layout {
+    frameAnimations: FrameAnimation[];
+    timelineLengthMs: number;
+    animated: boolean;
+    parentLayoutId: Id;
+    width: number;
+    height: number;
+}
+export interface ChildLayout extends Layout {
+    parentLayoutId: Id;
+}
+export declare enum FramePropertiesType {
+    top = "top",
+    child = "child"
+}
+export interface FrameProperty {
+    frameId: Id;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    rotationDegrees?: number;
+    rotationOriginY?: number;
+    scaleX?: number;
+    scaleY?: number;
+    included?: boolean;
+    framePropertiesType: FramePropertiesType;
+}
+export declare type ChildFrameProperty = FrameProperty;
+export interface TopFrameProperty extends FrameProperty {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    rotationDegrees: number;
+    rotationOriginY: number;
+    scaleX: number;
+    scaleY: number;
+    included: boolean;
+}
+export interface FrameAnimation {
+    frameId: Id;
+    from: number;
+    to: number;
+    basicAnimations: BasicAnimations;
+}
+export interface BasicAnimations {
+    intro?: BasicAnimationsIntroType;
+    emphasis?: BasicAnimationsEmphasisType;
+    outro?: BasicAnimationsOutroType;
+}
+export interface DocumentStyleKit {
+    colors: DocumentColor[];
+    characterStyles: DocumentCharacterStyle[];
+    paragraphStyles: DocumentParagraphStyle[];
+}
+export declare type DocumentCharacterStyle = CharacterStyle;
+export declare type DocumentParagraphStyle = ParagraphStyle;
+export interface DocumentVariable extends Variable {
+    parentId: Id;
+    name: string;
+    label: string;
+    isHidden: boolean;
+    isReadonly: boolean;
+    isRequired: boolean;
+    value: string;
+    defaultValue: string;
+}
+export declare enum DocumentType {
+    project = "project",
+    template = "template"
+}
+export interface DocumentProperties {
+    type: DocumentType;
+}
+export declare type TemplateDocumentProperties = DocumentProperties;
+export interface ProjectDocumentProperties extends DocumentProperties {
+    templateId: string;
+}

package/lib/src/types/DocumentTypes.js

@@ -0,0 +1,17 @@
+export var ImageFrameSourceType;
+(function (ImageFrameSourceType) {
+    ImageFrameSourceType["url"] = "url";
+    ImageFrameSourceType["assetProvider"] = "assetProvider";
+    ImageFrameSourceType["variable"] = "variable";
+})(ImageFrameSourceType || (ImageFrameSourceType = {}));
+export var FramePropertiesType;
+(function (FramePropertiesType) {
+    FramePropertiesType["top"] = "top";
+    FramePropertiesType["child"] = "child";
+})(FramePropertiesType || (FramePropertiesType = {}));
+export var DocumentType;
+(function (DocumentType) {
+    DocumentType["project"] = "project";
+    DocumentType["template"] = "template";
+})(DocumentType || (DocumentType = {}));
+//# sourceMappingURL=DocumentTypes.js.map

package/lib/src/types/DocumentTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentTypes.js","sourceRoot":"","sources":["../../../src/types/DocumentTypes.ts"],"names":[],"mappings":"AA2EA,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC5B,mCAAW,CAAA;IACX,uDAA+B,CAAA;IAC/B,6CAAqB,CAAA;AACzB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B;AA6CD,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,sCAAe,CAAA;AACnB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AA6DD,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;AACzB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB"}