@cesdk/node 1.70.0-nightly.20260219 → 1.70.0-nightly.20260220

package/index.d.ts

@@ -5737,6 +5737,25 @@ export declare interface CompleteAssetResult extends AssetResult {
     active: boolean;
 }
 
+/**
+ * Compression format for scene serialization.
+ * @public
+ */
+export declare enum CompressionFormat {
+    None = 0,
+    Zstd = 1
+}
+
+/**
+ * Compression level for scene serialization.
+ * @public
+ */
+export declare enum CompressionLevel {
+    Fastest = 0,
+    Default = 1,
+    Best = 2
+}
+
 /**
  * Specifies the configuration for the Creative Editor SDK.
  *
@@ -7636,6 +7655,34 @@ export declare interface RGBColor {
  */
 export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
 
+/**
+ * Options for saveSceneToString operation.
+ * @public
+ */
+declare interface SaveToStringOptions {
+    /**
+     * List of resource URL schemes that are allowed in the serialized scene.
+     * Resources with other schemes will trigger the persistence callback.
+     */
+    resourceSchemesAllowed?: string[];
+    /**
+     * Optional callback for persisting resources with disallowed schemes.
+     */
+    persistenceCallback?: (url: string, dataHash: string, persistedCallback?: {
+        invoke(url: string, persistedUrl: string): void;
+    }) => void;
+    /**
+     * Compression options for the serialized scene.
+     * When compression is enabled, base64 encoding is skipped and raw binary data is returned.
+     */
+    compression?: {
+        /** Compression format (None = no compression, Zstd = zstd compression) */
+        format?: CompressionFormat;
+        /** Compression level (Fastest, Default, Best) */
+        level?: CompressionLevel;
+    };
+}
+
 /**
  * @public Create, load, save, and manipulate scenes.
  *
@@ -7724,14 +7771,38 @@ export declare class SceneAPI {
      * Serializes the current scene into a string. Selection is discarded.
      *
      * @category Scene Saving
-     * @param allowedResourceSchemes - The resource schemes to allow in the saved string. Defaults to ['blob', 'bundle', 'file', 'http', 'https', 'opfs'].
+     * @param allowedResourceSchemes - The resource schemes to allow in the saved string.
      * @param onDisallowedResourceScheme - An optional callback that is called for each resource URL that has a scheme absent from
      * `resourceSchemesAllowed`. The `url` parameter is the resource URL and the `dataHash` parameter is the hash of the
      * resource's data. The callback should return a new URL for the resource, which will be used in the serialized
      * scene. The callback is expected to return the original URL if no persistence is needed.
      * @returns A promise that resolves with a string on success or an error on failure.
+     * @deprecated Use saveToString(options) instead for better extensibility and to access compression features.
      */
-    saveToString(allowedResourceSchemes?: string[], onDisallowedResourceScheme?: (url: string, dataHash: string) => Promise<string>): Promise<string>;
+    saveToString(allowedResourceSchemes: string[], onDisallowedResourceScheme?: (url: string, dataHash: string) => Promise<string>): Promise<string>;
+    /**
+     * Serializes the current scene into a string. Selection is discarded.
+     *
+     * @category Scene Saving
+     * @param options - Save options containing:
+     *   - allowedResourceSchemes: The resource schemes to allow in the saved string. Defaults to ['blob', 'bundle', 'file', 'http', 'https', 'opfs'].
+     *   - onDisallowedResourceScheme: An optional callback that is called for each resource URL that has a scheme absent from
+     *     `resourceSchemesAllowed`. The `url` parameter is the resource URL and the `dataHash` parameter is the hash of the
+     *     resource's data. The callback should return a new URL for the resource, which will be used in the serialized
+     *     scene. The callback is expected to return the original URL if no persistence is needed.
+     *   - compression: Optional compression settings containing:
+     *     - format: Compression format (None or Zstd). Defaults to None.
+     *     - level: Compression level (Fastest, Default, or Best). Defaults to Default.
+     * @returns A promise that resolves with a string on success or an error on failure.
+     */
+    saveToString(options?: {
+        allowedResourceSchemes?: string[];
+        onDisallowedResourceScheme?: (url: string, dataHash: string) => Promise<string>;
+        compression?: {
+            format?: CompressionFormat;
+            level?: CompressionLevel;
+        };
+    }): Promise<string>;
     /**
      * Saves the current scene and all of its referenced assets into an archive.
      *