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

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.
  *
@@ -6849,6 +6868,25 @@ export declare class EditorAPI {
      * @throws Error if the resource cannot be downloaded or MIME type determined.
      */
     getMimeType(uri: string): Promise<string>;
+    /**
+     * Gets the font metrics for a given font file URI.
+     *
+     * If the font is not yet loaded, it will be fetched asynchronously.
+     * The returned metrics are in the font's design units coordinate space.
+     *
+     * ```javascript
+     * const metrics = await engine.editor.getFontMetrics('/extensions/ly.img.cesdk.fonts/fonts/Roboto/Roboto-Regular.ttf');
+     * console.log(metrics.ascender, metrics.descender, metrics.unitsPerEm);
+     * console.log(metrics.lineGap);
+     * console.log(metrics.capHeight, metrics.xHeight);
+     * console.log(metrics.underlineOffset, metrics.underlineSize, metrics.strikeoutOffset, metrics.strikeoutSize);
+     * ```
+     *
+     * @category Resource Management
+     * @param fontFileUri - The URI of the font file to get metrics from.
+     * @returns A promise resolving to the font metrics.
+     */
+    getFontMetrics(fontFileUri: string): Promise<FontMetrics>;
     /**
      * Get all transient resources that would be lost during export.
      *
@@ -7236,6 +7274,34 @@ export declare interface Font {
     style?: FontStyle;
 }
 
+/**
+ * Font metrics extracted from a font file.
+ * Values are in the font's design units coordinate space.
+ * @public
+ */
+export declare interface FontMetrics {
+    /** The ascender value in font design units. */
+    ascender: number;
+    /** The descender value in font design units (typically negative). */
+    descender: number;
+    /** The number of units per em square (typically 1000 or 2048). */
+    unitsPerEm: number;
+    /** The OS/2 sTypoLineGap value in font design units. */
+    lineGap: number;
+    /** The OS/2 sCapHeight value in font design units. */
+    capHeight: number;
+    /** The OS/2 sxHeight value in font design units. */
+    xHeight: number;
+    /** The post.underlinePosition value in font design units (typically negative). */
+    underlineOffset: number;
+    /** The post.underlineThickness value in font design units. */
+    underlineSize: number;
+    /** The OS/2 yStrikeoutPosition value in font design units. */
+    strikeoutOffset: number;
+    /** The OS/2 yStrikeoutSize value in font design units. */
+    strikeoutSize: number;
+}
+
 /**
  * Extended design unit type that includes Point for font size operations.
  * Maintains consistency with SceneDesignUnit's capitalized naming convention.
@@ -7636,6 +7702,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 +7818,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>;
+    /**
+     * 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(allowedResourceSchemes?: string[], onDisallowedResourceScheme?: (url: string, dataHash: string) => Promise<string>): Promise<string>;
+    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.
      *