@cesdk/node 1.8.0 → 1.9.0-preview.1

package/README.md

@@ -1,21 +1,18 @@
 ![Hero image showing the configuration abilities of CE.SDK](https://img.ly/static/cesdk_release_header.png)
 
-# Creative Engine
+# IMG.LY Creative Engine
 
-The CreativeEditor SDK (**CE.SDK**) for Web is a fully customizable,
-simple-to-use design editor. 
+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 Web app with just a few lines of code. The
-editor combines the best of layout, typography and photo editing. **CE.SDK**
-also facilitates both template creation and adaption workflows, also featuring
-constraints and text placeholders for database automations.
+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.  This version is suitable for automating image processing in a server
-environment or for rendering scenes generated with our web SDK.
+Visit our [documentation](https://img.ly/docs/cesdk) for more tutorials on how to integrate and
+customize the engine for your specific use case.
 
-Visit our [website](https://img.ly) 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 
 

package/ThirdPartyLicenses.md

@@ -1419,19 +1419,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
--------------------------------------------------------------------------------
-## popmotion (https://popmotion.io)
-
-The MIT License (MIT)
-
-Copyright © 2019 Framer BV
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
 -------------------------------------------------------------------------------
 ## react (https://reactjs.org/)
 

package/index.d.ts

@@ -1792,9 +1792,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 a thumbnail atlas for the given video fill.
+     * @param id - The video fill.
+     * @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, numberOfColumns: number, numberOfRows: number): Promise<Blob>;
 }
 
 /** @public */
@@ -1951,6 +1959,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",
@@ -2042,14 +2051,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;
@@ -2068,33 +2077,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.
@@ -2103,19 +2112,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;
@@ -2129,7 +2138,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.
      */
@@ -2137,7 +2146,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.
@@ -2519,10 +2528,15 @@ export declare class SceneAPI {
      */
     saveToArchive(): Promise<Blob>;
     /**
-     * Create a new scene, along with its own camera.
-     * @returns The scenes handle.
+     * Create a new design scene, along with its own camera.
+     * @returns The scene's handle.
      */
     create(): DesignBlockId;
+    /**
+     * Create a new scene in video mode, along with its own camera and page stack.
+     * @returns The scene's handle.
+     */
+    createVideo(): DesignBlockId;
     /**
      * Loads the given image and creates a scene with a single page showing the image.
      * Fetching the image may take an arbitrary amount of time, so the scene isn't immediately