@cesdk/engine 1.7.0 → 1.8.0-alpha.2

package/index.d.ts

@@ -77,6 +77,8 @@ export declare class AssetAPI {
         url: string | undefined;
     } | undefined;
     canManageAssets(sourceId: string): boolean;
+
+
     /**
      * Apply an asset result to the active scene.
      * The default behavior will instantiate a block and configure it according to the asset's properties.
@@ -85,6 +87,12 @@ export declare class AssetAPI {
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
     apply(sourceId: string, assetResult: AssetResult): Promise<void>;
+    /**
+     * The default implementation for applying an asset to the scene.
+     * This implementation is used when no `applyAsset` function is provided to `addSource`.
+     * @param assetResult - A single assetResult of a `findAssets` query.
+     */
+    defaultApplyAsset(assetResult: AssetResult): Promise<void>;
 }
 
 /**
@@ -243,7 +251,7 @@ export declare interface AssetSource {
     /**
      * @returns the asset or undefined if no asset with the given id could be found
      */
-    getAsset(id: string): Promise<AssetResult | undefined>;
+    getAsset?(id: string): Promise<AssetResult | undefined>;
     /**
      * Can the source add, update and remove assets dynamically? If `false`
      * methods like `addAsset` `updateAsset` and `removeAsset` will throw an
@@ -261,20 +269,20 @@ export declare interface AssetSource {
      *
      * @returns the id of the added asset
      */
-    addAsset(asset: AssetDefinition): Promise<string>;
+    addAsset?(asset: AssetDefinition): Promise<string>;
     /**
      * Updates the asset of this source. Throws an error if `canManageAssets`
      * is `false` or no asset with the given id could not be found.
      *
      * @returns the id of the added asset
      */
-    updateAsset(assetId: string, asset: AssetDefinition): Promise<void>;
+    updateAsset?(assetId: string, asset: AssetDefinition): Promise<void>;
     /**
      * Removes the given asset from this source.
      *
      * @returns true if asset was found and removed, and false otherwise
      */
-    removeAsset(assetId: string): Promise<boolean>;
+    removeAsset?(assetId: string): Promise<boolean>;
 }
 
 /**
@@ -351,9 +359,6 @@ declare interface AssetsQueryResult_2 {
  */
 export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply' | 'ColorBurn' | 'Lighten' | 'Screen' | 'ColorDodge' | 'Overlay' | 'SoftLight' | 'HardLight' | 'Difference' | 'Exclusion' | 'Hue' | 'Saturation' | 'Color' | 'Luminosity';
 
-/** @public */
-declare type Block = number;
-
 /**
  * @public
  */
@@ -1603,17 +1608,9 @@ export declare class BlockAPI {
     isAllowedByScope(id: DesignBlockId, key: string): boolean;
 }
 
-/**
- * @public
- */
-export declare type BlockEvent = {
-    block: DesignBlockId;
-    type: 'Created' | 'Updated' | 'Destroyed';
-};
-
 /** @public */
-declare interface BlockEvent_2 {
-    block: Block;
+export declare interface BlockEvent {
+    block: DesignBlockId;
     type: 'Created' | 'Updated' | 'Destroyed';
 }
 
@@ -1744,21 +1741,40 @@ declare class CreativeEngine {
     scene: SceneAPI;
     variable: VariableAPI;
 
+    get element(): HTMLCreativeEngineCanvasElement | undefined;
     /**
      * Dispose the engine.
      */
     dispose(): void;
     /**
      * Initialize a `CreativeEngine` using the given `canvas` element and an optional config.
-     * @param config - A configuration object.
+     * @param config - An optional configuration object.
      * @param canvas - The canvas to use for drawing. Optional, if no canvas is provided,
      *                 the engine works with an internal offscreen-canvas.
      * @returns An engine instance.
      */
-    static init(config?: Partial<Configuration>, canvas?: HTMLCanvasElement | OffscreenCanvas): Promise<CreativeEngine>;
+    static init(config?: Partial<Configuration>): Promise<CreativeEngine & {
+        readonly element: HTMLCreativeEngineCanvasElement;
+    }>;
+    static init(config: Partial<Configuration> | undefined, canvas: HTMLCanvasElement | OffscreenCanvas): Promise<CreativeEngine & {
+        readonly element: undefined;
+    }>;
 }
 export default CreativeEngine;
 
+/**
+ * Dispatched on the engine canvas when the text input has been blurred.
+ * Call `preventDefault()` to disallow this and refocus the engine text input.
+ * @public
+ */
+export declare interface CursorEvent extends CustomEvent<string> {
+    readonly type: 'cesdk-cursor';
+    /** Contains the cursor style */
+    readonly detail: string;
+    /** If default is prevented, the Creative Engine won't apply the cursor style to itself. */
+    preventDefault(): void;
+}
+
 /**
  * A numerical identifier for a design block
  * @public
@@ -1951,6 +1967,13 @@ export declare class EditorAPI {
      * @param resolver - Custom resolution function.
      */
     setURIResolver(resolver: (URI: string) => string): void;
+    /**
+     * This is the default implementation for the URI resolver.
+     * It resolves the given path relative to the `ubq://basePath` setting.
+     * @param relativePath - The relative path that should be resolved.
+     * @returns The resolved absolute URI.
+     */
+    defaultURIResolver(relativePath: string): string;
     /**
      * Resolves the given path.
      * If a custom resolver has been set with `setURIResolver`, it invokes it with the given path.
@@ -2023,6 +2046,12 @@ export declare type ExportOptions = {
      * size entirely while maintaining its aspect ratio.
      */
     targetHeight?: number;
+    /**
+     * Export the PDF document with a higher compatibility to different PDF viewers.
+     * Bitmap images and some effects like gradients will be rasterized with the DPI
+     * setting instead of embedding them directly.
+     */
+    exportPdfWithHighCompatibility?: boolean;
 };
 
 /** @public */
@@ -2032,6 +2061,7 @@ declare interface ExportOptions_2 {
     useTargetSize: boolean;
     targetWidth: number;
     targetHeight: number;
+    exportPdfWithHighCompatibility: boolean;
 }
 
 /** @public */
@@ -2117,6 +2147,23 @@ declare type Groups = string[];
  */
 declare type HexColorString = string;
 
+/**
+ * A wrapper around a plain canvas
+ *
+ * The idea is to shield the user from the weird semantics of changing width
+ * and height of a canvas by making this a opaque block element instead and
+ * managing the internal render resolution of the canvas dynamically
+ *
+ * @public
+ */
+export declare class HTMLCreativeEngineCanvasElement extends HTMLElement {
+    #private;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+
+}
+
 /** @public */
 declare type ImageDefinition = Preset & {
     imageURL: string;
@@ -2182,6 +2229,7 @@ declare type PageFormatDefinition = Preset & {
     unit: DesignUnit;
     dpi?: number;
     bleedMargin?: number;
+    fixedOrientation?: boolean;
 };
 
 /**