@cesdk/node 1.17.0 → 1.18.0-rc.0

package/LICENSE.md

@@ -1,36 +1,36 @@
 # Creative Editor Software Development Kit (SDK)
-## Terms of Service
 
+## Terms of Service
 
 ### 1. Subject Matter
 
-1.1 These Terms of Service (together with any applicable Order Form the “__Agreement__”) governs all rights granted by Licensor to use and commercially exploit the Creative Editor Software Development Kit (the “__Software__”).
+1.1 These Terms of Service (together with any applicable Order Form the “**Agreement**”) governs all rights granted by Licensor to use and commercially exploit the Creative Editor Software Development Kit (the “**Software**”).
 
-1.2 The Agreement is entered into by and between img.ly GmbH, Kortumstraße 68, 44787 Bochum, Germany (the “__Licensor__”) and the entity identified in the Order Form (the “__Licensee__”, together with Licensor the “__Parties__”) as of the effective date the Order Form is last signed on.
+1.2 The Agreement is entered into by and between img.ly GmbH, Kortumstraße 19-21, 44787 Bochum, Germany (the “**Licensor**”) and the entity identified in the Order Form (the “**Licensee**”, together with Licensor the “**Parties**”) as of the effective date the Order Form is last signed on.
 
 1.3 This Agreement shall govern the use of the Software for commercial purposes. To the extent the Software is intended to be used for non-commercial purposes only, an alternative licensing scheme may be available upon Licensor’s discretion.
 
-### 2. Order Form 
+### 2. Order Form
 
-2.1 An “__Order Form__” may either be executed (i) by the Parties upon individual negotiation or (ii) via an online order issued by Licensee via Licensor`s website at www.photoeditorsdk.com (the “__Website__”) that has been confirmed by Licensor. Online orders not confirmed within 14 days after issuance shall be considered denied.
+2.1 An “**Order Form**” may either be executed (i) by the Parties upon individual negotiation or (ii) via an online order issued by Licensee via Licensor`s website at https://img.ly (the “**Website**”) that has been confirmed by Licensor. Online orders not confirmed within 14 days after issuance shall be considered denied.
 
 2.2 No rights shall be granted to Licensee by virtue of these Terms of Service alone as such grant requires the execution of an Order Form making reference to these Terms of Service.
 
 2.3 The Order Form shall specify the environment for the Software that shall be licensed by Licensee.
 
-2.4 The Order Form shall specify (i) the Subscription Term and (ii) the License Fees. Unless specified otherwise in the Order Form, the Subscription Term shall be based on monthly or annual periods for payment of the License Fees (the “__Payment Periods__”).
+2.4 The Order Form shall specify (i) the Subscription Term and (ii) the License Fees. Unless specified otherwise in the Order Form, the Subscription Term shall be based on monthly or annual periods for payment of the License Fees (the “**Payment Periods**”).
 
-2.5 Licensor may choose to offer Licensee a trial period of 30 days to test the Software in a dedicated testing environment not subject to License Fees (the “__Trial Period__”). Upon expiration of the Trial Period, the right to test the Software shall cease without further notice. Licensee shall then be required to execute an Order Form to obtain a License for a Subscription Term in case the Software shall be further used.
+2.5 Licensor may choose to offer Licensee a trial period of 30 days to test the Software in a dedicated testing environment not subject to License Fees (the “**Trial Period**”). Upon expiration of the Trial Period, the right to test the Software shall cease without further notice. Licensee shall then be required to execute an Order Form to obtain a License for a Subscription Term in case the Software shall be further used.
 
 ### 3. Grant of Rights
 
-3.1 Licensor shall grant to Licensee a worldwide, non-exclusive, non-transferable, non-sublicensable right to use the Software subject to the terms of this Agreement, in particular with the specifications as set out in the Order Form (the “__License__”).
+3.1 Licensor shall grant to Licensee a worldwide, non-exclusive, non-transferable, non-sublicensable right to use the Software subject to the terms of this Agreement, in particular with the specifications as set out in the Order Form (the “**License**”).
 
 3.2 The License shall pertain to the Software in object code format as well as to content data (fonts, stickers, stock images, etc.) included therein. In case the disclosure of the Software in source code format is agreed upon in the Order Form, the License shall also pertain to the Software in source code format.
 
-3.3 The term of the License shall be determined in the Order Form (the “__Subscription Term__”). The License shall commence upon initial payment of the License Fees and terminate upon the end of the Subscription Term(s). Unless stated otherwise in the Order Form, the initial Subscription Term shall automatically be extended by further consecutive Subscription Terms unless either of the Parties notifies the other in writing of its intent to terminate the License at least one month (one week in case of a monthly Subscription Term) prior to the end of the current Subscription Term. Upon expiration of the Subscription Term(s), the right to use the Software shall cease without further notice. To the extent the Subscription Term is not specified in the Order Form, Licensor shall be entitled to terminate the Agreement and revoke the License at any time.
+3.3 The term of the License shall be determined in the Order Form (the “**Subscription Term**”). The License shall commence upon initial payment of the License Fees and terminate upon the end of the Subscription Term(s). Unless stated otherwise in the Order Form, the initial Subscription Term shall automatically be extended by further consecutive Subscription Terms unless either of the Parties notifies the other in writing of its intent to terminate the License at least one month (one week in case of a monthly Subscription Term) prior to the end of the current Subscription Term. Upon expiration of the Subscription Term(s), the right to use the Software shall cease without further notice. To the extent the Subscription Term is not specified in the Order Form, Licensor shall be entitled to terminate the Agreement and revoke the License at any time.
 
-3.4 The License shall be limited to the right (i) to copy and – in case of disclosure in source code format – modify the Software for integration into one of Licensee’s products (website or app) (the “__Licenses Product__”) in accordance with the requirements of interfaces and implementation guidelines as issued by Licensor (the “__Integrated Software__”) and (ii) to copy, distribute and make available the Integrated Software to Licensee’s end customers.
+3.4 The License shall be limited to the right (i) to copy and – in case of disclosure in source code format – modify the Software for integration into one of Licensee’s products (website or app) (the “**Licenses Product**”) in accordance with the requirements of interfaces and implementation guidelines as issued by Licensor (the “**Integrated Software**”) and (ii) to copy, distribute and make available the Integrated Software to Licensee’s end customers.
 
 ### 4. Obligations and Restrictions
 
@@ -50,13 +50,13 @@
 
 ### 6. Third Party Components
 
-6.1 The Software implements components licensed under open source licenses as identified in Annex 1 (the “__OSS Components__”) and further software components and content data (fonts, stickers, stock images, etc.) provided by third parties as identified in Annex 2 (the “__Third Party Components__”). The use of the OSS Components and the Third Party Components is subject to the applicable separate licensing terms. Licensor does not act as sublicensor or agent in this regard and assumes or acknowledges no warranty or liability for the OSS Components and the Third Party Components.
+6.1 The Software implements components licensed under open source licenses as identified in Annex 1 (the “**OSS Components**”) and further software components and content data (fonts, stickers, stock images, etc.) provided by third parties as identified in Annex 2 (the “**Third Party Components**”). The use of the OSS Components and the Third Party Components is subject to the applicable separate licensing terms. Licensor does not act as sublicensor or agent in this regard and assumes or acknowledges no warranty or liability for the OSS Components and the Third Party Components.
 
 6.2 Licensee shall only use further third party software components or content data (fonts, stickers, stock images, etc.) with the Software to the extent that Licensee is entitled to such use. Licensor shall not be liable or responsible for any use of third party software components or content data by Licensee. Licensee shall indemnify and hold harmless Licensor from any third-party claims caused by Licensee’s actions involving third party software components or content data.
 
 ### 7. Payment
 
-7.1 The license fees as specified in the Order Form (the “__License Fees__”) shall be due and payable in line with the Payment Periods. To the extent the due date is not specified in the Order Form, the License Fees shall be due upon the execution of the Order Form and then upon the commencement of each further Payment Period for all of the Subscription Term.
+7.1 The license fees as specified in the Order Form (the “**License Fees**”) shall be due and payable in line with the Payment Periods. To the extent the due date is not specified in the Order Form, the License Fees shall be due upon the execution of the Order Form and then upon the commencement of each further Payment Period for all of the Subscription Term.
 
 7.2 Licensor shall invoice the License Fees to Licensee. Invoices are payable without deduction within 14 days of the date of the invoice and may be made by direct payment on the Website via credit card, if a respective option is provided by Licensor. If Licensee is in default of payment, the outstanding amount shall bear interest as applicable under statutory law. Licensor reserves all further rights resulting from default.
 
@@ -124,19 +124,19 @@
 
 13.8 Should any provision of this Agreement be or become invalid, this shall not affect the validity of the remaining terms. In such event, the Parties shall be obliged to cooperate in the creation of terms which achieve such legally valid result as comes closest commercially to that of the invalid provision. The above shall apply accordingly to the closing of any gaps in the Agreement.
 
-
 ### Annex 1
+
 #### OSS Components
 
 The Open-source software components and their licenses are listed in ThirdPartyLicenses.md
 
 ### Annex 2
+
 #### Third Party Components
 
-| Component  |
-|---|
-| Sticker: Flat Icons Vol.2 |
-| Sticker: Filled Outlined Icon Pack  |
-| Fonts: Aleo Bold, Amatic SC, Lobster, Open Sans Bold, Ostrich Sans Black, Ostrich Sans Bold, Trash Hand: _SIL Open Font License_ |
+| Component                                                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Sticker: Flat Icons Vol.2                                                                                                                                                                            |
+| Sticker: Filled Outlined Icon Pack                                                                                                                                                                   |
+| Fonts: Aleo Bold, Amatic SC, Lobster, Open Sans Bold, Ostrich Sans Black, Ostrich Sans Bold, Trash Hand: _SIL Open Font License_                                                                     |
 | Fonts by FontFabric: Bernier Regular, Cheque Regular, Gagalin Regular, Hagin Caps Thin, Intro Inline, Nexa Script, Panton Black Italic Caps, Panton Light Italic Caps, Perfograma: _EULA Free Fonts_ |
-

package/assets/default/ly.img.filter.lut/content.json

@@ -620,7 +620,7 @@
     },
     {
       "id": "//ly.img.cesdk.filters.lut/lomo",
-      "groups": [],
+      "groups": ["//ly.img.cesdk.filters.lut/category/legacy"],
       "label": {
         "en": "Lomo"
       },

package/assets/default/ly.img.sticker/content.json

@@ -104,23 +104,6 @@
         "height": 2048
       }
     },
-    {
-      "id": "//ly.img.cesdk.stickers.doodle/pipe",
-      "groups": ["//ly.img.cesdk.stickers.doodle/category/doodle"],
-      "label": {
-        "en": "Pipe",
-        "de": "Pfeife"
-      },
-      "tags": {},
-      "meta": {
-        "uri": "{{base_url}}/ly.img.sticker/images/doodle/doodle_pipe.svg",
-        "thumbUri": "{{base_url}}/ly.img.sticker/thumbnails/doodle/doodle_pipe.png",
-        "filename": "doodle_pipe.svg",
-        "blockType": "//ly.img.ubq/sticker",
-        "width": 1551,
-        "height": 2048
-      }
-    },
     {
       "id": "//ly.img.cesdk.stickers.doodle/rocket",
       "groups": ["//ly.img.cesdk.stickers.doodle/category/doodle"],
@@ -345,23 +328,6 @@
         "height": 1696
       }
     },
-    {
-      "id": "//ly.img.cesdk.stickers.emoji/beer",
-      "groups": ["//ly.img.cesdk.stickers.emoji/category/emoji"],
-      "label": {
-        "en": "Beer",
-        "de": "Bier"
-      },
-      "tags": {},
-      "meta": {
-        "uri": "{{base_url}}/ly.img.sticker/images/emoji/emoji_beer.svg",
-        "thumbUri": "{{base_url}}/ly.img.sticker/thumbnails/emoji/emoji_beer.png",
-        "filename": "emoji_beer.svg",
-        "blockType": "//ly.img.ubq/sticker",
-        "width": 1656,
-        "height": 2048
-      }
-    },
     {
       "id": "//ly.img.cesdk.stickers.emoji/crying",
       "groups": ["//ly.img.cesdk.stickers.emoji/category/emoji"],
@@ -1025,23 +991,6 @@
         "height": 58
       }
     },
-    {
-      "id": "//ly.img.cesdk.stickers.emoticons/beer",
-      "groups": ["//ly.img.cesdk.stickers.emoticons/category/emoticons"],
-      "label": {
-        "en": "Beer",
-        "de": "Bier"
-      },
-      "tags": {},
-      "meta": {
-        "uri": "{{base_url}}/ly.img.sticker/images/emoticons/imgly_sticker_emoticons_beer.svg",
-        "thumbUri": "{{base_url}}/ly.img.sticker/thumbnails/emoticons/imgly_sticker_emoticons_beer.png",
-        "filename": "imgly_sticker_emoticons_beer.svg",
-        "blockType": "//ly.img.ubq/sticker",
-        "width": 62,
-        "height": 59
-      }
-    },
     {
       "id": "//ly.img.cesdk.stickers.emoticons/blush",
       "groups": ["//ly.img.cesdk.stickers.emoticons/category/emoticons"],
@@ -1280,23 +1229,6 @@
         "height": 62
       }
     },
-    {
-      "id": "//ly.img.cesdk.stickers.emoticons/hitman",
-      "groups": ["//ly.img.cesdk.stickers.emoticons/category/emoticons"],
-      "label": {
-        "en": "Hitman",
-        "de": "Auftragsmörder"
-      },
-      "tags": {},
-      "meta": {
-        "uri": "{{base_url}}/ly.img.sticker/images/emoticons/imgly_sticker_emoticons_hitman.svg",
-        "thumbUri": "{{base_url}}/ly.img.sticker/thumbnails/emoticons/imgly_sticker_emoticons_hitman.png",
-        "filename": "imgly_sticker_emoticons_hitman.svg",
-        "blockType": "//ly.img.ubq/sticker",
-        "width": 64,
-        "height": 60
-      }
-    },
     {
       "id": "//ly.img.cesdk.stickers.emoticons/humourous",
       "groups": ["//ly.img.cesdk.stickers.emoticons/category/emoticons"],
@@ -1688,23 +1620,6 @@
         "height": 58
       }
     },
-    {
-      "id": "//ly.img.cesdk.stickers.emoticons/smoking",
-      "groups": ["//ly.img.cesdk.stickers.emoticons/category/emoticons"],
-      "label": {
-        "en": "Smoking",
-        "de": "rauchen"
-      },
-      "tags": {},
-      "meta": {
-        "uri": "{{base_url}}/ly.img.sticker/images/emoticons/imgly_sticker_emoticons_smoking.svg",
-        "thumbUri": "{{base_url}}/ly.img.sticker/thumbnails/emoticons/imgly_sticker_emoticons_smoking.png",
-        "filename": "imgly_sticker_emoticons_smoking.svg",
-        "blockType": "//ly.img.ubq/sticker",
-        "width": 62,
-        "height": 58
-      }
-    },
     {
       "id": "//ly.img.cesdk.stickers.emoticons/sobbing",
       "groups": ["//ly.img.cesdk.stickers.emoticons/category/emoticons"],
@@ -1875,26 +1790,6 @@
         "height": 60
       }
     },
-    {
-      "id": "//ly.img.cesdk.stickers.hand/alive",
-      "groups": ["//ly.img.cesdk.stickers.hand/category/hand"],
-      "label": {
-        "en": "Alive",
-        "de": "Alive"
-      },
-      "tags": {
-        "en": ["hand"],
-        "de": ["hand"]
-      },
-      "meta": {
-        "uri": "{{base_url}}/ly.img.sticker/images/hand/hand_alive.svg",
-        "thumbUri": "{{base_url}}/ly.img.sticker/thumbnails/hand/hand_alive.png",
-        "filename": "hand_alive.svg",
-        "blockType": "//ly.img.ubq/sticker",
-        "width": 1425,
-        "height": 2048
-      }
-    },
     {
       "id": "//ly.img.cesdk.stickers.hand/five",
       "groups": ["//ly.img.cesdk.stickers.hand/category/hand"],
@@ -1935,26 +1830,6 @@
         "height": 2048
       }
     },
-    {
-      "id": "//ly.img.cesdk.stickers.hand/fuck",
-      "groups": ["//ly.img.cesdk.stickers.hand/category/hand"],
-      "label": {
-        "en": "Fuck the rules",
-        "de": "Fuck the rules"
-      },
-      "tags": {
-        "en": ["hand"],
-        "de": ["hand"]
-      },
-      "meta": {
-        "uri": "{{base_url}}/ly.img.sticker/images/hand/hand_fuck.svg",
-        "thumbUri": "{{base_url}}/ly.img.sticker/thumbnails/hand/hand_fuck.png",
-        "filename": "hand_fuck.svg",
-        "blockType": "//ly.img.ubq/sticker",
-        "width": 849,
-        "height": 2048
-      }
-    },
     {
       "id": "//ly.img.cesdk.stickers.hand/heart",
       "groups": ["//ly.img.cesdk.stickers.hand/category/hand"],

package/index.d.ts

@@ -463,19 +463,19 @@ export declare class BlockAPI {
      * @param type - The type of the block that shall be created.
      * @returns The created blocks handle.
      */
-    create(type: DesignBlockType): DesignBlockId;
+    create(type: DesignBlockTypes): DesignBlockId;
     /**
      * Create a new fill, fails if type is unknown.
      * @param type - The type of the fill object that shall be created.
      * @returns The created fill's handle.
      */
-    createFill(type: string): DesignBlockId;
+    createFill(type: FillTypes): DesignBlockId;
     /**
      * Get the type of the given block, fails if the block is invalid.
      * @param id - The block to query.
      * @returns The blocks type.
      */
-    getType(id: DesignBlockId): DesignBlockType;
+    getType(id: DesignBlockId): BlockTypesLonghand;
     /**
      * Get the kind of the given block, fails if the block is invalid.
      * @param id - The block to query.
@@ -580,7 +580,7 @@ export declare class BlockAPI {
      * @param type - The type to search for.
      * @returns A list of block ids.
      */
-    findByType(type: DesignBlockType): DesignBlockId[];
+    findByType(type: BlockTypes): DesignBlockId[];
     /**
      * Finds all blocks with the given kind.
      * @param kind - The kind to search for.
@@ -602,7 +602,7 @@ export declare class BlockAPI {
      * @param type - The type of the shape object that shall be created.
      * @returns The created shape's handle.
      */
-    createShape(type: string): DesignBlockId;
+    createShape(type: ShapeTypes): DesignBlockId;
     /**
      * Query if the given block has a shape property.
      * @param id - The block to query.
@@ -707,6 +707,15 @@ export declare class BlockAPI {
      * @param enabled - whether the block shall be always-on-top.
      */
     setAlwaysOnTop(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Update the block's always-on-bottom property. If true, this blocks's global sorting order is automatically
+     * adjusted to be lower than all other siblings without this property. If more than one block is set to be always-on-bottom,
+     * the child order decides which is on bottom.
+     *
+     * @param id - the block to update.
+     * @param enabled - whether the block shall always be below its siblings.
+     */
+    setAlwaysOnBottom(id: DesignBlockId, enabled: boolean): void;
     /**
      * Query a block's always-on-top property.
      *
@@ -714,6 +723,13 @@ export declare class BlockAPI {
      * @returns true if the block is set to be always-on-top, false otherwise.
      */
     isAlwaysOnTop(id: DesignBlockId): boolean;
+    /**
+     * Query a block's always-on-bottom property.
+     *
+     * @param id - the block to query.
+     * @returns true if the block is set to be always-on-bottom, false otherwise.
+     */
+    isAlwaysOnBottom(id: DesignBlockId): boolean;
     /**
      * Updates the sorting order of this block and all of its manually created siblings
      * so that the given block has the highest sorting order.
@@ -987,6 +1003,11 @@ export declare class BlockAPI {
      * @returns Whether the blocks can be distributed.
      */
     isDistributable(ids: DesignBlockId[]): boolean;
+    /**
+     * Resize and position a block to entirely fill its parent block.
+     * @param id - The block that should fill its parent.
+     */
+    fillParent(id: DesignBlockId): void;
     /**
      * Resize all blocks to the given size. The content of the blocks is automatically adjusted
      * to fit the new dimensions.
@@ -1378,7 +1399,7 @@ export declare class BlockAPI {
      * @param type - The type id of the effect.
      * @returns The created effects handle.
      */
-    createEffect(type: string): DesignBlockId;
+    createEffect(type: EffectTypes): DesignBlockId;
     /**
      * Queries whether the block supports effects.
      * @param id - The block to query.
@@ -1435,7 +1456,7 @@ export declare class BlockAPI {
      * @param type - The type id of the block.
      * @returns The handle of the newly created blur.
      */
-    createBlur(type: string): DesignBlockId;
+    createBlur(type: BlurTypes): DesignBlockId;
     /**
      * Checks whether the block supports blur.
      * @param id - The block to query.
@@ -2242,6 +2263,48 @@ export declare interface BlockEvent {
     type: 'Created' | 'Updated' | 'Destroyed';
 }
 
+/**
+ * The block type IDs for all blocks types in the Creative Engine. Those are the types that can be
+ * passed to `cesdk.engine.block.findByType(type)` for example.
+ * @public
+ */
+export declare type BlockTypes = BlockTypesShorthand | BlockTypesLonghand;
+
+/**
+ * The longhand block type IDs for all blocks types in the Creative Engine. Those are the Types returned by the
+ * engine when calling `cesdk.engine.block.getType(blockId)` for example.
+ * @public
+ */
+export declare type BlockTypesLonghand = DesignBlockTypesLonghand | ShapeTypesLonghand | FillTypesLonghand | EffectTypesLonghand | BlurTypesLonghand;
+
+/**
+ * The shorthand block type IDs for all blocks types in the Creative Engine. Those are the types that can be
+ * passed to `cesdk.engine.block.findByType(type)` for example.
+ * @public
+ */
+export declare type BlockTypesShorthand = DesignBlockTypesShorthand | `shape/${ShapeTypesShorthand}` | `fill/${FillTypesShorthand}` | `effect/${EffectTypesShorthand}` | `blur/${BlurTypesShorthand}`;
+
+/**
+ * The block type IDs for the blur blocks. These are the IDs used to create new blurs
+ * using `cesdk.engine.editor.createBlur(id)`.
+ * @public
+ */
+export declare type BlurTypes = BlurTypesShorthand | BlurTypesLonghand;
+
+/**
+ * The longhand block type IDs for the blur blocks. These are the IDs used to create new blurs
+ * using `cesdk.engine.editor.createBlur(id)`.
+ * @public
+ */
+export declare type BlurTypesLonghand = `//ly.img.ubq/blur/${BlurTypesShorthand}`;
+
+/**
+ * The shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs
+ * using `cesdk.engine.editor.createBlur(id)`.
+ * @public
+ */
+export declare type BlurTypesShorthand = 'uniform' | 'linear' | 'mirrored' | 'radial';
+
 /**
  * @public
  */
@@ -2690,6 +2753,7 @@ export declare type DesignBlockId = number;
 
 /**
  * @public
+ * @deprecated The DesignBlockType enum is deprecated and replaced with string literals. See `BlockTypes`, `ShapeTypes`, and `FillTypes`.
  */
 export declare enum DesignBlockType {
     Scene = "//ly.img.ubq/scene",
@@ -2718,6 +2782,27 @@ export declare enum DesignBlockType {
     ConicalGradientFill = "//ly.img.ubq/fill/gradient/conical"
 }
 
+/**
+ * The block type IDs for the top-level design blocks. These are the IDs used to create new blocks
+ * using `cesdk.engine.editor.cerate(id)`.
+ * @public
+ */
+export declare type DesignBlockTypes = DesignBlockTypesShorthand | DesignBlockTypesLonghand;
+
+/**
+ * The longhand block type IDs for the top-level design blocks. These are the IDs used to create new blocks
+ * using `cesdk.engine.editor.cerate(id)`.
+ * @public
+ */
+export declare type DesignBlockTypesLonghand = `//ly.img.ubq/${DesignBlockTypesShorthand}`;
+
+/**
+ * The shorthand block type IDs for the top-level design blocks. These are the IDs used to create new blocks
+ * using `cesdk.engine.editor.cerate(id)`.
+ * @public
+ */
+export declare type DesignBlockTypesShorthand = 'scene' | 'stack' | 'camera' | 'page' | 'graphic' | 'audio' | 'text' | 'group' | 'cutout' | LegacyDesignBlockTypesShorthand;
+
 /**
  * The unit type in which the page values (size, distances, etc.) are defined.
  * @public
@@ -3053,6 +3138,27 @@ export declare class EditorAPI {
     convertColorToColorSpace(color: Color, colorSpace: ColorSpace): never;
 }
 
+/**
+ * The block type IDs for the effect blocks. These are the IDs used to create new effects
+ * using `cesdk.engine.editor.createEffect(id)`.
+ * @public
+ */
+export declare type EffectTypes = EffectTypesShorthand | EffectTypesLonghand;
+
+/**
+ * The longhand block type IDs for the effect blocks. These are the IDs used to create new effects
+ * using `cesdk.engine.editor.createEffect(id)`.
+ * @public
+ */
+export declare type EffectTypesLonghand = `//ly.img.ubq/effect/${EffectTypesShorthand}`;
+
+/**
+ * The shorthand block type IDs for the effect blocks. These are the IDs used to create new effects
+ * using `cesdk.engine.editor.createEffect(id)`.
+ * @public
+ */
+export declare type EffectTypesShorthand = 'pixelize' | 'radial_pixel' | 'cross_cut' | 'liquid' | 'outliner' | 'dot_pattern' | 'posterize' | 'tv_glitch' | 'half_tone' | 'linocut' | 'shifter' | 'mirror' | 'glow' | 'vignette' | 'tilt_shift' | 'extrude_blur' | 'sharpie' | 'lut_filter' | 'duotone_filter' | 'adjustments';
+
 /**
  * @public
  */
@@ -3137,6 +3243,27 @@ declare interface ExportVideoOptions {
     targetHeight: number;
 }
 
+/**
+ * The block type IDs for the fill blocks. These are the IDs used to create new fills
+ * using `cesdk.engine.editor.createFill(id)`.
+ * @public
+ */
+export declare type FillTypes = FillTypesShorthand | FillTypesLonghand;
+
+/**
+ * The longhand block type IDs for the fill blocks. These are the IDs used to create new fills
+ * using `cesdk.engine.editor.createFill(id)`.
+ * @public
+ */
+export declare type FillTypesLonghand = `//ly.img.ubq/fill/${FillTypesShorthand}`;
+
+/**
+ * The shorthand block type IDs for the fill blocks. These are the IDs used to create new fills
+ * using `cesdk.engine.editor.createFill(id)`.
+ * @public
+ */
+export declare type FillTypesShorthand = 'video' | 'image' | 'color' | 'gradient/linear' | 'gradient/radial' | 'gradient/conical' | 'pixelStream';
+
 /** @public */
 declare interface FindAssetsQuery {
     perPage: number;
@@ -3203,6 +3330,14 @@ export declare type HistoryId = number;
  */
 export declare type HorizontalBlockAlignment = 'Left' | 'Right' | 'Center';
 
+/**
+ * The shorthand block type IDs for legacy design blocks.
+ * @public
+ * @deprecated These design block IDs are deprecated, you should migrate to using the new graphic design block
+ * instead by setting `cesdk.engine.editor.setSettingBool('features/unifiedBlocksEnabled', true)`
+ */
+export declare type LegacyDesignBlockTypesShorthand = 'image' | 'video' | 'sticker' | 'vector_path' | 'shapes/rect' | 'shapes/line' | 'shapes/star' | 'shapes/polygon' | 'shapes/ellipse';
+
 /**
  * e.g. `en`, `de`, etc.
  * @public
@@ -3422,6 +3557,23 @@ export declare class SceneAPI {
      * @returns The sorted list of pages in the scene.
      */
     getPages(): DesignBlockId[];
+    /**
+     * Get the current page, i.e., the page nearest to the view port center.
+     * @returns The current page in the scene or null.
+     */
+    getCurrentPage(): DesignBlockId | null;
+    /**
+     * Find all blocks with the given type sorted by the distance to view port center.
+     * @param type - The type to search for.
+     * @returns A list of block ids sorted by distance to view port center.
+     */
+    findNearestToViewPortCenterByType(type: DesignBlockTypes): DesignBlockId[];
+    /**
+     * Find all blocks with the given kind sorted by the distance to view port center.
+     * @param kind - The kind to search for.
+     * @returns A list of block ids sorted by distance to view port center.
+     */
+    findNearestToViewPortCenterByKind(kind: string): DesignBlockId[];
     /**
      * Set the zoom level of the scene, e.g., for headless versions.
      * This only shows an effect if the zoom level is not handled/overwritten by the UI.
@@ -3572,7 +3724,7 @@ export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' |
 export declare type SceneMode = 'Design' | 'Video';
 
 /** @public */
-export declare type SettingsBool = 'doubleClickToCropEnabled' | 'features/effectsEnabled' | 'features/hspSelectiveAdjustmentsEnabled' | 'features/layerListEnabled' | 'features/singlePageModeEnabled' | 'features/templatingEnabled' | 'page/dimOutOfPageAreas' | 'page/title/show' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'trackActivePage' | ArbitraryString;
+export declare type SettingsBool = 'doubleClickToCropEnabled' | 'features/effectsEnabled' | 'features/hspSelectiveAdjustmentsEnabled' | 'features/layerListEnabled' | 'features/singlePageModeEnabled' | 'features/templatingEnabled' | 'page/dimOutOfPageAreas' | 'page/title/show' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | ArbitraryString;
 
 /** @public
  */
@@ -3601,6 +3753,27 @@ export declare type SettingsString = 'basePath' | 'license' | 'page/title/fontFi
 /** @public */
 export declare type SettingType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum';
 
+/**
+ * The block type IDs for the shape blocks. These are the IDs used to create new shapes
+ * using `cesdk.engine.editor.createShape(id)`.
+ * @public
+ */
+export declare type ShapeTypes = ShapeTypesShorthand | ShapeTypesLonghand;
+
+/**
+ * The longhand block type IDs for the blocks. These are the IDs used to create new shapes
+ * using `cesdk.engine.editor.createShape(id)`.
+ * @public
+ */
+export declare type ShapeTypesLonghand = `//ly.img.ubq/shape/${ShapeTypesShorthand}`;
+
+/**
+ * The shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes
+ * using `cesdk.engine.editor.createShape(id)`.
+ * @public
+ */
+export declare type ShapeTypesShorthand = 'vector_path' | 'rect' | 'line' | 'star' | 'polygon' | 'ellipse';
+
 /** @public */
 export declare interface Size2 {
     width: number;