@cesdk/engine 1.44.0-rc.3 → 1.45.0-rc.0

package/index.d.ts

@@ -42,8 +42,41 @@ export declare interface Asset {
 export declare class AssetAPI {
     #private;
 
-
-
+    /**
+     * Register a middleware that is called before applying an asset to the scene.
+     *
+     * @example
+     * ```ts
+     * engine.asset.unstable_registerApplyAssetMiddleware(async (sourceId, assetResult, apply) => {
+     *   // do something before applying the asset
+     *   // You still have the choice to call apply or skip it
+     *   const blockId = await apply(sourceId, assetResult);
+     *   // do something after applying the asset
+     *   return blockId;
+     * })
+     * ```
+     *
+     * @param middleware - The middleware function that is called before applying the asset.
+     * @returns A function that can be used to remove the middleware.
+     */
+    unstable_registerApplyAssetMiddleware(middleware: (sourceId: string, assetResult: AssetResult, apply: AssetAPI['apply']) => Promise<DesignBlockId | undefined>): VoidFunction;
+    /**
+     * Register a middleware that is called before applying an asset to a block.
+     *
+     * @example
+     * ```ts
+     * engine.asset.unstable_registerApplyAssetToBlockMiddleware(async (sourceId, assetResult, block, applyToBlock) => {
+     *   // do something before applying the asset
+     *   // You still have the choice to call applyToBlock or skip it
+     *   await applyToBlock(sourceId, assetResult, block);
+     *   // do something after applying the asset
+     * })
+     * ```
+     *
+     * @param middleware - The middleware function that is called before applying the asset.
+     * @returns A function that can be used to remove the middleware.
+     */
+    unstable_registerApplyAssetToBlockMiddleware(middleware: (sourceId: string, assetResult: AssetResult, block: DesignBlockId, applyToBlock: AssetAPI['applyToBlock']) => Promise<void>): VoidFunction;
     /**
      * Adds a custom asset source. Its ID has to be unique.
      * @param source - The asset source.
@@ -2825,6 +2858,7 @@ export declare class BlockAPI {
     getVolume(id: DesignBlockId): number;
     /**
      * Begins loading the required audio and video resource for the given video fill or audio block.
+     * If the resource had been loaded earlier and resulted in an error, it will be reloaded.
      * @param id - The video fill or audio block whose resource should be loaded.
      * @returns A Promise that resolves once the resource has finished loading.
      */
@@ -2988,6 +3022,7 @@ export declare class BlockAPI {
     onStateChanged: (ids: DesignBlockId[], callback: (ids: DesignBlockId[]) => void) => (() => void);
     /**
      * Begins loading the resources of the given blocks and their children.
+     * If the resource had been loaded earlier and resulted in an error, it will be reloaded.
      * This function is useful for preloading resources before they are needed.
      * Warning: For elements with a source set, all elements in the source set will be loaded.
      * @param ids - The blocks whose resources should be loaded. The given blocks don't require to have resources and
@@ -3655,7 +3690,7 @@ export declare class EditorAPI {
      * Sets a custom URI resolver.
      * This function can be called more than once. Subsequent calls will overwrite previous calls.
      * To remove a previously set resolver, pass the value `null`.
-     * The given function must return an absolute path with a scheme.
+     * The given function must return an absolute path with a scheme. The input is allowed to be invalid URI, e.g., due to placeholders.
      * @param resolver - Custom resolution function. The resolution function
      *                   should not reference variables outside of its scope.
      *                   It receives the default URI resolver as its second argument