@cesdk/node 1.9.0-preview.0 → 1.9.0-preview.2

package/README.md

@@ -1,19 +1,19 @@
 ![Hero image showing the configuration abilities of CE.SDK](https://img.ly/static/cesdk_release_header.png)
 
-# Creative Engine
+# IMG.LY Creative Engine
 
-The (**IMGLYEngine**) for Node.js is the rendering engine that powers CE.SDK. 
+This package contains the Node.js version of the IMG.LY *Creative Engine*, the core of CE.SDK. 
+The Creative Engine enables you to build any design editing UI, automation and creative workflow in any Node environment.
+It offers performant and robust graphics processing capabilities combining the best of layout, typography and image processing with advanced workflows centered around templating and adaptation. 
 
-Seamlessly integrate it into any Node.js script with just a few lines of code. The
-engine enables automated image processing as well as building creative editing experiences.
+The Creative Engine seamlessly integrates into any Node.js app whether you are building a photo editor, template-based design tool or scalable automation of content creation for your application.
 
-This package contains the Node.JS version of the Creative Engine, the core of
-our SDK. It is suitable for integrating image processing and editing into
-SwiftUI or UIKit applications.
-
-Visit our [website](https://img.ly/docs/cesdk) for more tutorials on how to integrate and
+Visit our [documentation](https://img.ly/docs/cesdk) for more tutorials on how to integrate and
 customize the engine for your specific use case.
 
+## License
+The CreativeEditor SDK is a commercial product. To use it as such and get access to its white-label version - without the watermark in the export - you need to unlock the SDK with a license file. You can purchase a license at https://img.ly/pricing.
+
 ## Usage 
 
 ## 1. Install the Creative Engine dependency to your project

package/index.d.ts

@@ -789,6 +789,18 @@ export declare class BlockAPI {
      * @returns A list of the property names.
      */
     findAllProperties(id: DesignBlockId): string[];
+    /**
+     * Check if a property with a given name is readable
+     * @param property - The name of the property whose type should be queried.
+     * @returns Whether the property is readable or not. Will return false for unknown properties
+     */
+    isPropertyReadable(property: string): boolean;
+    /**
+     * Check if a property with a given name is writable
+     * @param property - The name of the property whose type should be queried.
+     * @returns Whether the property is writable or not. Will return false for unknown properties
+     */
+    isPropertyWritable(property: string): boolean;
     /**
      * Get the type of a property given its name.
      * @param property - The name of the property whose type should be queried.
@@ -1792,15 +1804,17 @@ export declare class BlockAPI {
     /**
      * Generate a thumbnail for the given video fill.
      * @param id - The video fill.
-     * @returns A thumbnail encoded as PNG with a height of 128px.
+     * @returns A thumbnail encoded as JPEG with a height of 128px.
      */
     getVideoFillThumbnail(id: DesignBlockId): Promise<Blob>;
     /**
-     * Generate an 8x8 thumbnail atlas for the given video fill.
+     * Generate a thumbnail atlas for the given video fill.
      * @param id - The video fill.
-     * @returns A thumbnail atlas of the video as PNG.
+     * @param numberOfColumns - The number of columns to generate.
+     * @param numberOfRows - The number of rows to generate.
+     * @returns A thumbnail atlas of the video as JPEG.
      */
-    getVideoFillThumbnailAtlas(id: DesignBlockId): Promise<Blob>;
+    getVideoFillThumbnailAtlas(id: DesignBlockId, numberOfColumns: number, numberOfRows: number): Promise<Blob>;
 }
 
 /** @public */
@@ -1957,6 +1971,7 @@ export declare enum DesignBlockType {
     Page = "//ly.img.ubq/page",
     Image = "//ly.img.ubq/image",
     Video = "//ly.img.ubq/video",
+    Audio = "//ly.img.ubq/audio",
     Text = "//ly.img.ubq/text",
     Sticker = "//ly.img.ubq/sticker",
     VectorPath = "//ly.img.ubq/vector_path",
@@ -2048,14 +2063,14 @@ export declare class EditorAPI {
     onSettingsChanged(callback: () => void): () => void;
     /**
      * Set a boolean setting.
-     * @param keypath - The settings keypath, e.g. `ubq://doubleClickToCropEnabled`
+     * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
     setSettingBool(keypath: string, value: boolean): void;
     /**
      * Get a boolean setting.
-     * @param keypath - The settings keypath, e.g. `ubq://doubleClickToCropEnabled`
+     * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`
      * @throws An error, if the keypath is invalid.
      */
     getSettingBool(keypath: string): boolean;
@@ -2074,33 +2089,33 @@ export declare class EditorAPI {
     getSettingInt(keypath: string): number;
     /**
      * Set a float setting.
-     * @param keypath - The settings keypath, e.g. `ubq://positionSnappingThreshold`
+     * @param keypath - The settings keypath, e.g. `positionSnappingThreshold`
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
     setSettingFloat(keypath: string, value: number): void;
     /**
      * Get a float setting.
-     * @param keypath - The settings keypath, e.g. `ubq://positionSnappingThreshold`
+     * @param keypath - The settings keypath, e.g. `positionSnappingThreshold`
      * @throws An error, if the keypath is invalid.
      */
     getSettingFloat(keypath: string): number;
     /**
      * Set a string setting.
-     * @param keypath - The settings keypath, e.g. `ubq://license`
+     * @param keypath - The settings keypath, e.g. `license`
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
     setSettingString(keypath: string, value: string): void;
     /**
      * Get a string setting.
-     * @param keypath - The settings keypath, e.g. `ubq://license`
+     * @param keypath - The settings keypath, e.g. `license`
      * @throws An error, if the keypath is invalid.
      */
     getSettingString(keypath: string): string;
     /**
      * Set a color setting.
-     * @param keypath - The settings keypath, e.g. `ubq://highlightColor`.
+     * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @param r - The red color component in the range of 0 to 1.
      * @param g - The green color component in the range of 0 to 1.
      * @param b - The blue color component in the range of 0 to 1.
@@ -2109,19 +2124,19 @@ export declare class EditorAPI {
     setSettingColorRGBA(keypath: string, r: number, g: number, b: number, a?: number): void;
     /**
      * Get a color setting.
-     * @param keypath - The settings keypath, e.g. `ubq://highlightColor`.
+     * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
      */
     getSettingColorRGBA(keypath: string): RGBA;
     /**
      * Set an enum setting.
-     * @param keypath - The settings keypath, e.g. `ubq://role`.
+     * @param keypath - The settings keypath, e.g. `role`.
      * @param value - The enum value as string.
      */
     setSettingEnum(keypath: string, value: string): void;
     /**
      * Get an enum setting.
-     * @param keypath - The settings keypath, e.g. `ubq://role`.
+     * @param keypath - The settings keypath, e.g. `role`.
      * @returns The value as string.
      */
     getSettingEnum(keypath: string): string;
@@ -2135,7 +2150,7 @@ export declare class EditorAPI {
     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.
+     * It resolves the given path relative to the `basePath` setting.
      * @param relativePath - The relative path that should be resolved.
      * @returns The resolved absolute URI.
      */
@@ -2143,7 +2158,7 @@ export declare class EditorAPI {
     /**
      * Resolves the given path.
      * If a custom resolver has been set with `setURIResolver`, it invokes it with the given path.
-     * Else, it resolves it as relative to the `ubq://basePath` setting.
+     * Else, it resolves it as relative to the `basePath` setting.
      * This performs NO validation of whether a file exists at the specified location.
      * @param relativePath - A relative path string
      * @returns The resolved absolute uri or an error if an invalid path was given.
@@ -2592,6 +2607,13 @@ export declare class SceneAPI {
      * @returns A promise that resolves once the zoom was set or rejects with an error otherwise.
      */
     zoomToBlock(id: DesignBlockId, paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number): Promise<void>;
+    /**
+     * Subscribe to changes to the zoom level.
+     * @param callback - This function is called at the end of the engine update, if the zoom level has changed.
+     * @returns A method to unsubscribe.
+     * @privateRemarks This will currently fire on _all_ changes to camera properties
+     */
+    onZoomLevelChanged(callback: (zoomLevel: number) => void): () => void;
     /**
      * Converts all values of the current scene into the given design unit.
      * @param designUnit - The new design unit of the scene