@cesdk/node 1.32.0 → 1.33.0

package/index.d.ts

@@ -286,7 +286,7 @@ export declare type AssetMetaData = {
  */
 export declare interface AssetNumberProperty {
     property: string;
-    type: 'Integer' | 'Float' | 'Double';
+    type: 'Int' | 'Float' | 'Double';
     value: number;
     defaultValue: number;
     min: number;
@@ -3830,6 +3830,28 @@ export declare class EditorAPI {
      * @throws An error if the resource could not be downloaded or the mimetype could not be determined.
      */
     getMimeType(uri: string): Promise<string>;
+    /**
+     * Returns the URLs and sizes of all resources whose data would be lost if the scene was exported.
+     * This function is useful for determining which resources need to be relocated (e.g., to a CDN) before
+     * exporting a scene since the resources are not included in the exported scene.
+     * @returns The URLs and sizes of transient resources.
+     */
+    findAllTransientResources(): TransientResource[];
+    /**
+     * Provides the data of a resource at the given URL.
+     * @param url - The URL of the resource.
+     * @param chunkSize - The size of the chunks in which the resource data is provided.
+     * @param onData - The callback function that is called with the resource data or an error if an error occurred.
+     * The callback will be called as long as there is data left to provide and the callback returns `true`.
+     */
+    getResourceData(uri: string, chunkSize: number, onData: (result: Uint8Array) => boolean): void;
+    /**
+     * Changes the URL associated with a resource.
+     * This function can be used change the URL of a resource that has been relocated (e.g., to a CDN).
+     * @param currentURL - The current URL of the resource.
+     * @param relocatedURL - The new URL of the resource.
+     */
+    relocateResource(currentUrl: string, relocatedUrl: string): void;
 }
 
 /**
@@ -3853,6 +3875,25 @@ export declare type EffectTypeLonghand = `//ly.img.ubq/effect/${EffectTypeShorth
  */
 export declare type EffectTypeShorthand = 'adjustments' | 'cross_cut' | 'dot_pattern' | 'duotone_filter' | 'extrude_blur' | 'glow' | 'green_screen' | 'half_tone' | 'linocut' | 'liquid' | 'lut_filter' | 'mirror' | 'outliner' | 'pixelize' | 'posterize' | 'radial_pixel' | 'recolor' | 'sharpie' | 'shifter' | 'tilt_shift' | 'tv_glitch' | 'vignette';
 
+/** @public */
+export declare interface EnginePlugin {
+    name: string;
+    version: string;
+    initialize: (context: EnginePluginContext) => void;
+}
+
+/** @public */
+declare type EnginePluginContext = {
+    engine: {
+        asset: AssetAPI;
+        block: BlockAPI;
+        scene: SceneAPI;
+        editor: EditorAPI;
+        event: EventAPI;
+        variable: VariableAPI;
+    };
+};
+
 /**
  * @public
  */
@@ -4058,6 +4099,12 @@ export declare type HistoryId = number;
  */
 export declare type HorizontalBlockAlignment = 'Left' | 'Right' | 'Center';
 
+/**
+ * The horizontal text alignment options.
+ * @public
+ */
+export declare type HorizontalTextAlignment = 'Left' | 'Right' | 'Center';
+
 /**
  * Type guard for {@link CMYKColor}
  * @public
@@ -4326,20 +4373,21 @@ export declare class SceneAPI {
      */
     getPages(): DesignBlockId[];
     /**
-     * Get the current page, i.e., the page nearest to the view port center.
+     * Get the current page, i.e., the page of the first selected element if this page
+     * is at least 25% visible or, otherwise, the page nearest to the viewport 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.
+     * Find all blocks with the given type sorted by the distance to viewport center.
      * @param type - The type to search for.
-     * @returns A list of block ids sorted by distance to view port center.
+     * @returns A list of block ids sorted by distance to viewport center.
      */
     findNearestToViewPortCenterByType(type: DesignBlockType): DesignBlockId[];
     /**
-     * Find all blocks with the given kind sorted by the distance to view port center.
+     * Find all blocks with the given kind sorted by the distance to viewport center.
      * @param kind - The kind to search for.
-     * @returns A list of block ids sorted by distance to view port center.
+     * @returns A list of block ids sorted by distance to viewport center.
      */
     findNearestToViewPortCenterByKind(kind: string): DesignBlockId[];
     /**
@@ -4497,7 +4545,7 @@ export declare type SceneMode = 'Design' | 'Video';
 export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'appearance/animation' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
 
 /** @public */
-export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
+export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
 
 /** @public
  */
@@ -4602,6 +4650,12 @@ declare type Subscription = number;
  */
 export declare type TextCase = 'Normal' | 'Uppercase' | 'Lowercase' | 'Titlecase';
 
+/** @public */
+export declare interface TransientResource {
+    uri: string;
+    size: number;
+}
+
 /** @public */
 export declare interface Typeface {
     /** The unique name of this typeface */
@@ -4679,6 +4733,12 @@ export declare interface Vec3 {
  */
 export declare type VerticalBlockAlignment = 'Top' | 'Bottom' | 'Center';
 
+/**
+ * The vertical text alignment options.
+ * @public
+ */
+export declare type VerticalTextAlignment = 'Top' | 'Bottom' | 'Center';
+
 /**
  * @public
  */