@cesdk/cesdk-js 1.28.0 → 1.29.0

package/index.d.ts

@@ -622,13 +622,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.
@@ -2722,6 +2739,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;
+}
+
 /**
  * Interface for all available builder. Depending on the context different
  * implementation might be used. A "Button" in the canvas menu might render
@@ -2770,6 +2793,7 @@ declare type Callbacks = {
     onShare?: (s: string) => void | Promise<void>;
     onSave?: (s: string) => void | Promise<void>;
     onLoad?: (() => Promise<string>) | 'upload';
+    onLoadArchive?: (() => Promise<string>) | 'uploadArchive';
     onDownload?: ((s: string) => void | Promise<void>) | 'download';
     onExport?: ((blobs: Blob[], options: ExportOptions) => void | Promise<void>) | 'download';
     onUpload?: OnUploadCallback | 'local' | (Partial<OnUploadOptions> & {
@@ -3783,6 +3807,8 @@ export declare class EditorAPI {
      * @returns The length of the buffer in bytes.
      */
     getBufferLength(uri: string): number;
+
+
 }
 
 /** @public */
@@ -4470,7 +4496,7 @@ declare enum NavigationPosition {
 }
 
 declare interface Notification_2 {
-    type?: NotificationType;
+    type?: NotificationType_2;
     message: string;
     duration?: NotificationDuration;
     onDismiss?: () => void;
@@ -4484,7 +4510,7 @@ declare interface Notification_2 {
 
 declare type NotificationDuration = number | 'infinite' | 'short' | 'medium' | 'long';
 
-declare type NotificationType = 'success' | 'error' | 'info' | 'warning' | 'loading';
+declare type NotificationType_2 = 'success' | 'error' | 'info' | 'warning' | 'loading';
 
 declare interface NumberInputOptions extends InputOptions<number> {
 }
@@ -4739,7 +4765,10 @@ export declare interface _RequiredConfiguration extends Omit<_EngineConfiguratio
  */
 export declare interface _RequiredCreateConfiguration extends Omit<_RequiredConfiguration, 'initialSceneMode' | 'initialSceneString' | 'initialSceneURL' | 'initialImageURL' | 'page' | 'scene' | 'assetSources' | 'variables' | 'presets' | 'callbacks'> {
     callbacks: Callbacks;
-    presets: _RequiredConfiguration['presets'];
+    /**
+     * @deprecated This config key is not used anymore and will be removed.
+     */
+    presets: Pick<_RequiredConfiguration['presets'], 'typefaces'>;
 }
 
 /**
@@ -4804,11 +4833,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.
@@ -5465,6 +5502,34 @@ declare class UserInterfaceAPI {
      * be replaced or even removed completely in future versions.
      */
     unstable_getDockOrder(orderContext?: OrderContext): string[];
+    /**
+     * Defines in what order components are rendered in the inspector bar. The
+     * id in this order refer to registered default components or custom components
+     * registered in `unstable_registerComponent`.
+     *
+     * Different orders can be set depending on different contexts. The context
+     * consists of the edit mode (e.g. `Transform` or `Text`) right now. If no
+     * context is given, the default order is set for the `Transform` edit mode.
+     *
+     * Please be aware that this is experimental right now. This API can change or
+     * be replaced or even removed completely in future versions.
+     */
+    unstable_setInspectorBarOrder(inspectorBarOrder: string[], orderContext?: OrderContext): void;
+    /**
+     * Returns the current order of components that are rendered in the inspector bar.
+     *
+     * The id in this order refer to registered default components or custom components
+     * registered in `unstable_registerComponent`.
+     *
+     * Different orders could have been set depending on different contexts.
+     * The context consists of the edit mode (e.g. `Transform` or `Text`) right now.
+     * If no context is given, the default order (with `Transform` edit mode) is
+     * returned.
+     *
+     * Please be aware that this is experimental right now. This API can change or
+     * be replaced or even removed completely in future versions.
+     */
+    unstable_getInspectorBarOrder(orderContext?: OrderContext): string[];
     /**
      * Defines what in what order components are rendered in the canvas menu. The
      * id in this order refer to registered default components or custom components