@dcl/playground-assets 7.23.4-26770223094.commit-52b9415 → 7.23.4-26955626649.commit-5d040fd

package/dist/alpha.d.ts

@@ -1488,14 +1488,16 @@ export declare namespace Composite {
     /** @public */
     export function toBinary(composite: Composite.Definition): Uint8Array;
     /**
-     * Instance a composite and returns its root entity
-     * @param compositeData - state serialized by the CRDT protocol
-     * @param getNextAvailableEntity - function that gives unused entities
-     * @param rootEntity - (optional) suggested mapped rootEntity for the composite
+     * Instance a composite and return its root entity.
+     * @param engine - the engine that will own the new entities
+     * @param compositeData - the composite resource to instance
+     * @param compositeProvider - provider used to resolve nested composite references
+     * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)
+     * @returns the root entity of the instanced composite
      *
      * @public
      */
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     /**
      * Resolve and normalize a composite path
      * @param src - the source path
@@ -1568,6 +1570,11 @@ export declare namespace CompositeDefinition {
  */
 export declare type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 /**
@@ -2276,6 +2283,13 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
     parent?: Entity;
 }>): Generator<Entity>;
 
+/**
+ * Get the composite provider registered via setCompositeProvider. Returns null if
+ * no provider has been set.
+ * @public
+ */
+export declare function getCompositeProvider(): CompositeProvider | null;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -8589,6 +8603,14 @@ export declare namespace Schemas {
  */
 export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
 
+/**
+ * Register the composite provider used to resolve composite files. Also registers
+ * any `provider.schemas` on the engine pre-seal so composites that reference those
+ * components can be instanced without further setup.
+ * @public
+ */
+export declare function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public

package/dist/beta.d.ts

@@ -1488,14 +1488,16 @@ export declare namespace Composite {
     /** @public */
     export function toBinary(composite: Composite.Definition): Uint8Array;
     /**
-     * Instance a composite and returns its root entity
-     * @param compositeData - state serialized by the CRDT protocol
-     * @param getNextAvailableEntity - function that gives unused entities
-     * @param rootEntity - (optional) suggested mapped rootEntity for the composite
+     * Instance a composite and return its root entity.
+     * @param engine - the engine that will own the new entities
+     * @param compositeData - the composite resource to instance
+     * @param compositeProvider - provider used to resolve nested composite references
+     * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)
+     * @returns the root entity of the instanced composite
      *
      * @public
      */
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     /**
      * Resolve and normalize a composite path
      * @param src - the source path
@@ -1568,6 +1570,11 @@ export declare namespace CompositeDefinition {
  */
 export declare type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 /**
@@ -2276,6 +2283,13 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
     parent?: Entity;
 }>): Generator<Entity>;
 
+/**
+ * Get the composite provider registered via setCompositeProvider. Returns null if
+ * no provider has been set.
+ * @public
+ */
+export declare function getCompositeProvider(): CompositeProvider | null;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -8561,6 +8575,14 @@ export declare namespace Schemas {
  */
 export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
 
+/**
+ * Register the composite provider used to resolve composite files. Also registers
+ * any `provider.schemas` on the engine pre-seal so composites that reference those
+ * components can be instanced without further setup.
+ * @public
+ */
+export declare function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public

package/dist/index.bundled.d.ts

@@ -1488,14 +1488,16 @@ export declare namespace Composite {
     /** @public */
     export function toBinary(composite: Composite.Definition): Uint8Array;
     /**
-     * Instance a composite and returns its root entity
-     * @param compositeData - state serialized by the CRDT protocol
-     * @param getNextAvailableEntity - function that gives unused entities
-     * @param rootEntity - (optional) suggested mapped rootEntity for the composite
+     * Instance a composite and return its root entity.
+     * @param engine - the engine that will own the new entities
+     * @param compositeData - the composite resource to instance
+     * @param compositeProvider - provider used to resolve nested composite references
+     * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)
+     * @returns the root entity of the instanced composite
      *
      * @public
      */
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     /**
      * Resolve and normalize a composite path
      * @param src - the source path
@@ -1568,6 +1570,11 @@ export declare namespace CompositeDefinition {
  */
 export declare type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 /**
@@ -2276,6 +2283,13 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
     parent?: Entity;
 }>): Generator<Entity>;
 
+/**
+ * Get the composite provider registered via setCompositeProvider. Returns null if
+ * no provider has been set.
+ * @public
+ */
+export declare function getCompositeProvider(): CompositeProvider | null;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -8561,6 +8575,14 @@ export declare namespace Schemas {
  */
 export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
 
+/**
+ * Register the composite provider used to resolve composite files. Also registers
+ * any `provider.schemas` on the engine pre-seal so composites that reference those
+ * components can be instanced without further setup.
+ * @public
+ */
+export declare function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public