@cesdk/engine 1.28.0 → 1.29.0

package/index.d.ts

@@ -441,13 +441,30 @@ export declare class BlockAPI {
      * @returns A promise that resolves with a list of handles representing the found blocks or an error.
      */
     loadFromString(content: string): Promise<DesignBlockId[]>;
+    /**
+     * Loads existing blocks from the given URL.
+     * The blocks are not attached by default and won't be visible until attached to a page or the scene.
+     * The UUID of the loaded blocks is replaced with a new one.
+     * @param url - The URL to load the blocks from.
+     * @returns A promise that resolves with a list of handles representing the found blocks or an error.
+     */
+    loadFromArchiveURL(url: string): Promise<DesignBlockId[]>;
     /**
      * Saves the given blocks into a string. If given the root of a block hierarchy, e.g. a
      * page with multiple children, the entire hierarchy is saved.
      * @param blocks - The blocks to save
      * @returns A promise that resolves to a string representing the blocks or an error.
      */
-    saveToString(blocks: DesignBlockId[]): Promise<string>;
+    saveToString(blocks: DesignBlockId[], allowedResourceSchemes?: string[]): Promise<string>;
+    /**
+     * Saves the given blocks and all of their referenced assets into an archive.
+     * The archive contains all assets that were accessible when this function was called.
+     * Blocks in the archived scene reference assets relative from to the location of the scene
+     * file. These references are resolved when loading such a scene via `loadSceneFromURL`.
+     * @param blocks - The blocks to save
+     * @returns A promise that resolves with a Blob on success or an error on failure.
+     */
+    saveToArchive(blocks: DesignBlockId[]): Promise<Blob>;
     /**
      * Create a new block, fails if type is unknown.
      * @param type - The type of the block that shall be created.
@@ -2554,6 +2571,12 @@ export declare type BlurTypeShorthand = 'uniform' | 'linear' | 'mirrored' | 'rad
  */
 export declare type BooleanOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
 
+/** @public */
+export declare interface Buffer {
+    handle: string;
+    buffer: Uint8Array;
+}
+
 declare type CameraSettings = {
     /** Horizontal resolution in physical pixels */
     width: number;
@@ -3564,6 +3587,8 @@ export declare class EditorAPI {
      * @returns The length of the buffer in bytes.
      */
     getBufferLength(uri: string): number;
+
+
 }
 
 /**
@@ -4053,11 +4078,19 @@ export declare class SceneAPI {
      * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
      */
     loadFromURL(url: string): Promise<DesignBlockId>;
+    /**
+     * Load a previously archived scene from the URL to the scene file.
+     * The scene file will be fetched asynchronously by the engine. This requires continuous `render`
+     * calls on this engines instance.
+     * @param url - The URL of the scene file.
+     * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
+     */
+    loadFromArchiveURL(url: string): Promise<DesignBlockId>;
     /**
      * Serializes the current scene into a string. Selection is discarded.
      * @returns A promise that resolves with a string on success or an error on failure.
      */
-    saveToString(): Promise<string>;
+    saveToString(allowedResourceSchemes?: string[]): Promise<string>;
     /**
      * Saves the current scene and all of its referenced assets into an archive.
      * The archive contains all assets, that were accessible when this function was called.