@cesdk/cesdk-js 1.4.5 → 1.5.0

package/types.d.ts

@@ -1,759 +0,0 @@
-/* eslint-disable max-classes-per-file */
-/* eslint-disable spaced-comment */
-import API from './api';
-
-//#region utils
-
-export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;
-
-//#endregion
-
-//#region ui/utils/color.ts
-
-// All values in [0-1]
-export interface RGBColor {
-  r: number;
-  g: number;
-  b: number;
-}
-
-// All values in [0-1]
-export interface HSLColor {
-  h: number;
-  s: number;
-  l: number;
-}
-
-// All values in [0-1]
-export interface HSVColor {
-  h: number;
-  s: number;
-  v: number;
-}
-
-//#endregion
-
-//#region api/types/cesdk/engine
-
-export const enum DesignUnit {
-  Pixel = 'px',
-  Millimeter = 'mm',
-  Inch = 'in'
-}
-
-export enum LogLevel {
-  Info = 'Info',
-  Warning = 'Warning',
-  Error = 'Error'
-}
-
-export type Logger = (message: string, level: LogLevel) => void;
-
-export interface AssetElement {
-  id: string;
-  name: string;
-  uri: string;
-  thumbUri: string;
-}
-
-export interface ImageElement extends AssetElement {
-  size: {
-    width: number;
-    height: number;
-  };
-}
-
-export interface VectorShapeElement extends ImageElement {
-  vectorPath: string;
-}
-
-// All components between 0 and 1
-export interface RGBAColor {
-  r: number;
-  g: number;
-  b: number;
-  a: number;
-}
-
-// All components between 0 and 1
-export interface CMYKColor {
-  c: number;
-  m: number;
-  y: number;
-  k: number;
-}
-//#endregion
-
-//#region Types
-
-export type Theme = 'light' | 'dark';
-
-export type Scale = 'normal' | 'large';
-
-export type PartialImageElement = Optional<ImageElement, 'size'>;
-
-export type SpotColor = {
-  name: string;
-  rgbApproximation: RGBColor;
-  cmykApproximation: CMYKColor;
-};
-
-/**
- * A hexadecimal color value (RGB or RGBA) that starts with a '#'
- * @example #6686FF or #6686FFFF
- */
-export type HexColorString = string;
-
-/**
- * A color definition for the custom color palette.
- * The RGB and CMYK components must all be specified in the range [0-1].
- */
-export type ColorPaletteColor =
-  | HexColorString
-  | RGBColor
-  | RGBAColor
-  | SpotColor;
-
-export type Asset = {
-  src: string;
-};
-
-export type Assets = {
-  [id: string]: Asset;
-};
-
-export interface QueryData {
-  /**
-   * A query string used for (fuzzy) searching of labels and tags
-   */
-  query?: string;
-
-  /**
-   * The number of results queried. How many assets shall be returned regardless
-   * of the total number of assets available.
-   *
-   * Together with `page` this can be used for pagination.
-   */
-  perPage: number;
-
-  /**
-   * The current page queried for paginated views.
-   */
-  page: number;
-}
-
-/**
- * Single asset result of a query from the engine.
- */
-export interface AssetResult {
-  /**
-   *  A unique id of this asset
-   */
-  id: string;
-
-  /**
-   *  E.g. `ly.img.image`
-   */
-  type: string;
-
-  /**
-   * URI to a thumbnail of the asset used e.g. in the content library UI
-   */
-  thumbUri: string;
-
-  /**
-   * Original size of the asset.
-   */
-  size: {
-    width: number;
-    height: number;
-  };
-
-  /**
-   * Asset-specific and custom meta information
-   */
-  meta?: { uri?: string; filename?: string } & Record<string, unknown>;
-
-  /**
-   * The locale of the label and tags
-   */
-  locale?: string;
-
-  /**
-   * The label of the result. Used for description and tooltips.
-   */
-  label?: string;
-
-  /**
-   * The tags of this asset. Used for filtering and free-text searching.
-   */
-  tags?: string[];
-
-  /**
-   * Credits for the artist of the asset
-   */
-  credits?: {
-    name: string;
-    url?: string;
-  };
-
-  /**
-   * License for this asset. Overwrites the source license if present
-   */
-  license?: {
-    name: string;
-    url?: string;
-  };
-}
-
-/**
- * Return type of a `findAssets` query.
- */
-export interface AssetsQueryResult {
-  /**
-   * The assets in the requested page
-   */
-  assets: AssetResult[];
-
-  /**
-   * The current, requested page
-   */
-  currentPage: number;
-
-  /**
-   * The next page to query if it exists
-   */
-  nextPage: number | undefined;
-
-  /**
-   * How many assets are there in total for the current query regardless of the page
-   */
-  total: number;
-}
-
-/**
- * API to query for assets
- */
-export interface AssetSource {
-  /**
-   * The asset types returned by this source. Will default to ['ly.img.image'].
-   */
-  types?: string[];
-
-  /**
-   * Find all asset for the given type and the provided query data.
-   */
-  findAssets(
-    type: string,
-    queryData?: QueryData
-  ): Promise<AssetsQueryResult | undefined>;
-
-  /**
-   * Indicates if the asset shall be downloaded to handle the raw data instead
-   * of an URL reference. Do this if you do not want to depend on
-   * a service after adding the asset to the scene. If this is your own API
-   * with your own service, you do not need to set this and avoid downloading /
-   * re-uploading the assets.
-   */
-  downloadAssets?: (asset: AssetResult) => Promise<Blob>;
-
-  /**
-   * Credits for the source/api
-   */
-  credits?: {
-    name: string;
-    url?: string;
-  };
-
-  /**
-   * General license for all asset from this source
-   */
-  license?: {
-    name: string;
-    url?: string;
-  };
-}
-
-export type AssetSources = {
-  [id: string]: AssetSource;
-};
-
-export type Preset = {
-  meta?: {
-    default?: boolean;
-    library?: string;
-    categories?: string[];
-  };
-};
-
-export type VariableDefinition = Preset & {
-  value: string | number;
-};
-export type ColorDefinition = Preset & {
-  value: ColorPaletteColor;
-};
-export type ColorPaletteDefinition = Preset & {
-  entries: ColorPaletteColor[];
-};
-
-export type PageFormatDefinition = Preset & {
-  width: number;
-  height: number;
-  unit: DesignUnit;
-  dpi?: number;
-  bleedMargin?: number;
-};
-
-export type TemplateDefinition = Preset & {
-  scene: string | URL | (() => Promise<string>);
-  thumbnailURL?: string | URL;
-};
-
-export type DuoToneFilterDefinition = {
-  lookupTableURL: string;
-  thumbnailURL?: string;
-  colors: {
-    light: ColorPaletteColor;
-    dark: ColorPaletteColor;
-  };
-};
-
-export type LUTFilterDefinition = {
-  lookupTableURL: string;
-  thumbnailURL: string;
-  horizontalTileCount: number;
-  verticalTileCount: number;
-};
-
-export type FontWeight =
-  | 'thin'
-  | 'extraLight'
-  | 'Light'
-  | 'normal'
-  | 'medium'
-  | 'semiBold'
-  | 'bold'
-  | 'extraBold'
-  | 'heavy';
-
-export type FontStyle = 'normal' | 'italic';
-
-export type TypefaceDefinition = Preset & {
-  family: string;
-  fonts: [
-    {
-      fontURL: string;
-      weight: FontWeight;
-      style: FontStyle;
-    }
-  ];
-};
-
-export type ImageDefinition = Preset & {
-  imageURL: string;
-  thumbnailURL?: string; // might be moved to general preset Probs
-  width: number;
-  height: number;
-  levelOfDetail?: {
-    [lod: number]: string;
-  };
-};
-
-export type Presets = {
-  colors?: { [id: string]: ColorDefinition };
-  typefaces?: { [id: string]: TypefaceDefinition };
-  images?: { [id: string]: ImageDefinition };
-  pageFormats?: { [id: string]: PageFormatDefinition };
-  colorPalettes?: { [id: string]: ColorPaletteDefinition };
-  templates?: { [id: string]: TemplateDefinition };
-  [type: string]: { [id: string]: Preset } | undefined;
-};
-
-export type Variables = { [id: string]: VariableDefinition };
-
-/** I18n Settings
- * Note: this will append keys and not override keys
- */
-export type I18n = { [key: string]: I18n | string };
-
-/** A11 Settings
- *
- */
-export type A11y = {
-  /**
-   * The option define a level of heading to start from (in a range 1-6)
-   */
-  headingsHierarchyStart: 1 | 2 | 3 | 4 | 5 | 6;
-};
-
-export type Core = {
-  baseURL: string;
-};
-
-export type Extensions = {
-  baseURL: string;
-  entries: string[]; // FIXME Should be URLs
-};
-
-/** Export Settings
- *
- */
-export type Scene = {
-  maskSpotColor?: SpotColor;
-  /**
-   * The DPI value to use when exporting and when converting between pixels and inches or millimeter units.
-   * (In the CESDK, this value is synonymous with PPI).
-   *
-   * This is only relevant for new scenes that are created in the editor. Loaded scenes will use the
-   * value stored in their serialization file.
-   */
-  dpi: number;
-
-  /**
-   * A scale factor that is applied to the final export resolution.
-   *
-   * This is only relevant for new scenes that are created in the editor. Loaded scenes will use the
-   * value stored in their serialization file.
-   */
-  pixelScaleFactor: number;
-};
-
-export type OnUploadCallback = (
-  file: File,
-  onProgress: (progress: number) => void
-) => Promise<PartialImageElement>;
-
-export type OnUploadOptions = {
-  supportedMimeTypes: string[];
-};
-
-export type Callbacks = {
-  onBack?: () => void;
-  onClose?: () => void;
-
-  onSave?: (s: string) => void | Promise<void>;
-  onLoad?: () => Promise<string>;
-
-  onDownload?: (s: string) => void | Promise<void>;
-  onExport?: (blobs: Blob[], options: ExportOptions) => void | Promise<void>;
-
-  onUpload?:
-    | OnUploadCallback
-    | 'local'
-    | (Partial<OnUploadOptions> & { callback: OnUploadCallback });
-
-  onUnsupportedBrowser?: () => void;
-
-  log?: Logger;
-};
-
-/**
- * Bleed margin configuration options for a single design unit type.
- */
-export interface BleedMarginOptions {
-  /**
-   * The bleed margin options that can be selected from a dropdown in the UI.
-   * Other bleed margin values can be entered directly using the input field.
-   */
-  dropdownOptions: number[];
-
-  /**
-   * The default bleed margin value.
-   */
-  defaultBleedMargin: number;
-}
-
-export interface FontSizeOptions {
-  /**
-   * The font size options that can be selected from a dropdown in the UI.
-   * Other font size values can be entered directly using the input field.
-   */
-  dropdownOptions: number[];
-}
-
-export interface UIOptionsForSingleDesignUnit {
-  bleedMargin: BleedMarginOptions;
-}
-
-export interface UIOptionsPerDesignUnit {
-  mm: UIOptionsForSingleDesignUnit;
-  px: UIOptionsForSingleDesignUnit;
-  in: UIOptionsForSingleDesignUnit;
-}
-
-//#endregion
-
-//#region userInterface/elements/types
-
-export enum NavigationPosition {
-  Top = 'top',
-  Bottom = 'bottom'
-}
-
-export interface UserInterfaceElement {
-  show?: boolean;
-}
-
-export interface UserInterfaceInspectorBlocks {
-  opacity?: UserInterfaceElement | boolean;
-  transform?: UserInterfaceElement | boolean;
-
-  // Hardcoding the ids in this map for now for easier handling
-  '//ly.img.ubq/image': UserInterfaceInspectorBlockImage;
-  '//ly.img.ubq/text': UserInterfaceInspectorBlockText;
-}
-
-// At some point this will extend an element if we have solutions to not show
-// inspectors for some blocks.
-export interface UserInterfaceInspectorBlock {} // extends UserInterfaceElement {}
-
-export interface UserInterfaceInspectorBlockText
-  extends UserInterfaceInspectorBlock {
-  advanced?: UserInterfaceElement | boolean;
-  color?: UserInterfaceElement | boolean;
-  backgroundColor?: UserInterfaceElement | boolean;
-}
-
-export interface UserInterfaceInspectorBlockImage
-  extends UserInterfaceInspectorBlock {
-  crop?: UserInterfaceElement | boolean;
-  filters?: UserInterfaceElement | boolean;
-  adjustments?: UserInterfaceElement | boolean;
-  effects?: UserInterfaceElement | boolean;
-  blur?: UserInterfaceElement | boolean;
-}
-
-export interface UserInterfaceInspector extends UserInterfaceElement {
-  position?: 'left' | 'right'; // This was simplified from an enum
-}
-
-export interface UserInterfaceSettings extends UserInterfaceElement {}
-
-export interface UserInterfaceNavigation extends UserInterfaceElement {
-  position: NavigationPosition;
-  action?: {
-    close: UserInterfaceElement | boolean;
-    back: UserInterfaceElement | boolean;
-
-    save: UserInterfaceElement | boolean;
-    load: UserInterfaceElement | boolean;
-
-    export: UserInterfaceElement | boolean;
-    download: UserInterfaceElement | boolean;
-  };
-}
-
-export interface UserInterfaceElements {
-  view?: {
-    adopter?: {
-      style?: 'default' | 'advanced';
-    };
-  };
-
-  panels?: {
-    inspector?: UserInterfaceInspector | boolean;
-    settings?: UserInterfaceSettings | boolean;
-  };
-
-  templates?: UserInterfaceElement | boolean;
-
-  libraries?: {
-    image?: UserInterfaceElement | boolean;
-    text?: UserInterfaceElement | boolean;
-    element?: UserInterfaceElement | boolean;
-  };
-
-  blocks?: UserInterfaceInspectorBlocks;
-
-  navigation: UserInterfaceNavigation;
-}
-
-//#endregion
-
-//#region userInterface/types
-export interface UserInterface {
-  baseURL: string;
-  elements: UserInterfaceElements;
-}
-//#endregion
-
-//#region Configuration
-export class Configuration {
-  static initWithDefaults(config: Partial<Configuration>): Configuration;
-
-  extend(update: Partial<Configuration>): Configuration;
-
-  baseURL: string;
-
-  license?: string;
-
-  role: string;
-
-  locale: string;
-
-  theme: Theme;
-
-  devMode: boolean;
-
-  initialSceneString?: string;
-
-  initialSceneURL?: string;
-
-  extensions: Extensions;
-
-  core: Core;
-
-  ui: UserInterface;
-
-  i18n: I18n;
-
-  a11y: A11y;
-
-  scene: Scene;
-
-  assets: Assets;
-
-  assetSources: AssetSources;
-
-  presets: Presets;
-
-  variables: Variables;
-
-  callbacks: Callbacks;
-
-  /**
-   * The default font used by a text added to the scene. Needs to be the id of
-   * the font from a extension pack including namespace, e.g.
-   *
-   * '//ly.img.cesdk.fonts/roboto_regular'
-   *
-   * If not configured the fallback font is used.
-   */
-  public defaultFont?: string;
-}
-
-type DeepPartial<T> = {
-  [P in keyof T]?: DeepPartial<T[P]>;
-};
-
-// Make the properties K of T DeepPartial
-type DeepOptional<T, K extends keyof T> = Pick<DeepPartial<T>, K> & Omit<T, K>;
-
-export type UserConfiguration = Partial<DeepOptional<Configuration, 'ui'>>;
-
-//#endregion
-
-//#region packages/api/types/engine.ts
-
-export interface ExportOptions {
-  mimeType: 'image/png' | 'image/jpeg';
-  quality?: number;
-  pages?: number[];
-}
-
-//#endregion
-
-//#region CESDK index
-
-export default class CreativeEditorSDK {
-  public static Configuration: Configuration;
-
-  public engine: API;
-
-  /**
-   * Exports one or multiple page(s) as an file in the given mimeType
-   *
-   * Please note: the `onExport` callback provided in the configuration will be
-   * not called. This callback is for exports triggered by an user interaction.
-   *
-   * @param {Object} options options for the export
-   * @param {string} options.mimeType - The mime type of the exported blob.
-   * @param {string} options.pages [pages] - the pages to export with the selected page as the default.
-   *
-   * @returns a promise with a blob of the exported page.
-   */
-  export(options: ExportOptions): Promise<Blob[]>;
-
-  /**
-   * Load a base64 encoded scene.
-   *
-   * @returns a promise which resolves if the scene was successfully loaded.
-   */
-  load(scene: string): Promise<void>;
-
-  /**
-   * Save and return a scene as a base64 encoded string.
-   *
-   * @return a promise with the scene as a string
-   */
-  save(): Promise<string>;
-
-  /**
-   * Adds or update text variable definition.
-   *
-   * Translations can be added inside the custom locale translations under the
-   * key `variables.${id}.label`.
-   *
-   * @typedef {Object} Variable
-   * @property {string} value the value of the variable
-   * @param {Object.<string, Variable>} definitions text variable definitions to add or update
-   *
-   * @returns a resolved promise if all variables were set successfully.
-   */
-  setVariableDefinitions(definitions: {
-    [id: string]: VariableDefinition;
-  }): Promise<void>;
-
-  /**
-   * Adds an image definition which can be used in the image library.
-   *
-   * @typedef {Object} ImageElement
-   * @property {string} imageURL URL to the image
-   * @property {string} [thumbnailURL] URL to thumbnail of the image
-   * @property {string} width width of the image
-   * @property {string} height height of the image
-   *
-   * @param {Object.<string, ImageElement>} definitions image definitions
-   *
-   * @returns a resolved promise if all images were add successfully
-   */
-  setImageDefinitions(definitions: {
-    [id: string]: ImageDefinition;
-  }): Promise<void[]>;
-
-  /**
-   * Adds translations to be used by the editor.
-   *
-   * @param {Object.<string, Object>} translations locale to a translation object
-   *
-   * @example
-   * setTranslations({
-   *  en: {
-   *    presets: {
-   *      scene: ...
-   *    }
-   *  }
-   * })
-   */
-  setTranslations(definitions: { [locale: string]: object }): void;
-
-  /**
-   * Disposes the editor and engine if no longer needed.
-   */
-  dispose(): void;
-
-  /**
-   * Initializes the editor and renders it for the given container.
-   *
-   * @param {(string|HTMLElement)} [container] the container to mount the editor as a HTML element or selector
-   * @param {Object} [configuration] the initial configuration to start the editor
-   *
-   * @returns a promise which resolves after the engine is ready to receive further commands on the CreativeEditorSDK instance
-   */
-  static init(
-    container: HTMLDivElement | string,
-    config?: UserConfiguration
-  ): Promise<CreativeEditorSDK>;
-}
-
-//#endregion