@cesdk/engine 1.18.1-rc.0 → 1.18.1

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: DesignBlockTypes): DesignBlockId;
+    create(type: DesignBlockType): 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: FillTypes): DesignBlockId;
+    createFill(type: string): 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): BlockTypesLonghand;
+    getType(id: DesignBlockId): DesignBlockType;
     /**
      * 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: BlockTypes): DesignBlockId[];
+    findByType(type: DesignBlockType): 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: ShapeTypes): DesignBlockId;
+    createShape(type: string): DesignBlockId;
     /**
      * Query if the given block has a shape property.
      * @param id - The block to query.
@@ -1399,7 +1399,7 @@ export declare class BlockAPI {
      * @param type - The type id of the effect.
      * @returns The created effects handle.
      */
-    createEffect(type: EffectTypes): DesignBlockId;
+    createEffect(type: string): DesignBlockId;
     /**
      * Queries whether the block supports effects.
      * @param id - The block to query.
@@ -1456,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: BlurTypes): DesignBlockId;
+    createBlur(type: string): DesignBlockId;
     /**
      * Checks whether the block supports blur.
      * @param id - The block to query.
@@ -2263,27 +2263,6 @@ 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}`;
-
 /**
  * Dispatched on the engine canvas when the text input has been blurred.
  * Call `preventDefault()` to disallow this and refocus the engine text input.
@@ -2297,27 +2276,6 @@ export declare interface BlurEvent extends CustomEvent<EventTarget | null> {
     preventDefault(): void;
 }
 
-/**
- * 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';
-
 declare type CameraSettings = {
     /** Horizontal resolution in physical pixels */
     width: number;
@@ -2633,9 +2591,6 @@ export declare interface Configuration {
     featureFlags?: {
         [flag: string]: boolean | string;
     };
-    /**
-     * @deprecated Extensions have been superseded by AssetSources and should no longer be used.
-     */
     extensions: {
         baseURL: string;
         entries: string[];
@@ -2864,7 +2819,6 @@ 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",
@@ -2893,27 +2847,6 @@ 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
@@ -3249,27 +3182,6 @@ 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
  */
@@ -3354,27 +3266,6 @@ 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;
@@ -3480,14 +3371,6 @@ export declare interface HTMLCreativeEngineCanvasElement extends HTMLElement {
     clear(): void;
 }
 
-/**
- * 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
@@ -3778,7 +3661,7 @@ export declare class SceneAPI {
      * @param type - The type to search for.
      * @returns A list of block ids sorted by distance to view port center.
      */
-    findNearestToViewPortCenterByType(type: DesignBlockTypes): DesignBlockId[];
+    findNearestToViewPortCenterByType(type: DesignBlockType): DesignBlockId[];
     /**
      * Find all blocks with the given kind sorted by the distance to view port center.
      * @param kind - The kind to search for.
@@ -3964,27 +3847,6 @@ 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;