@dcl/playground-assets 7.0.5 → 7.0.6-3713220614.commit-d02ef9f

package/dist/playground/sdk/dcl-sdk.package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/sdk",
-  "version": "7.0.5",
+  "version": "7.0.6-3713220614.commit-d02ef9f",
   "description": "",
   "main": "./index.js",
   "typings": "./index.d.ts",
@@ -25,5 +25,5 @@
     "@dcl/unity-renderer": "1.0.66458-20221207172857.commit-1a83854"
   },
   "minCliVersion": "3.14.1",
-  "commit": "ad4efbcb7b87a23d25c26ca96f80d3ff795fcd9d"
+  "commit": "d02ef9fa9c36da3f26f7b1313e57cb4ccce5c539"
 }

package/dist/playground-assets.d.ts

@@ -1042,6 +1042,7 @@ export declare type ComponentDefinition<T extends ISchema<ConstructorType>, Cons
      */
     createOrReplace(entity: Entity, val?: ConstructorType): ComponentType<T>;
     /**
+     * @public
      * Delete the current component to an entity, return null if the entity doesn't have the current component.
      * - Internal comment: This method adds the &lt;entity,component&gt; to the list to be reviewed next frame
      * @param entity - Entity to delete the component from
@@ -1350,6 +1351,12 @@ export declare type IEngine = {
      * @returns if it was found and removed
      */
     removeSystem(selector: string | SystemFn): boolean;
+    /**
+     * Registers a custom component definition.
+     * @param component - The component definition
+     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
+     */
+    registerCustomComponent<T extends ISchema, V>(component: ComponentDefinition<T, V>, componentId: number): ComponentDefinition<T, V>;
     /**
      * Define a component and add it to the engine.
      * @param spec - An object with schema fields
@@ -1415,7 +1422,7 @@ export declare type IEngine = {
     /**
      * @param deltaTime - deltaTime in seconds
      */
-    update(deltaTime: number): void;
+    update(deltaTime: number): Promise<void>;
     /**
      * @public
      * Refer to the root of the scene, all Transforms without a parent are parenting with RootEntity.
@@ -4031,7 +4038,7 @@ export declare type ReceiveMessage = {
     entity: Entity;
     componentId: number;
     timestamp: number;
-    transportType?: string;
+    transportId?: number;
     data?: Uint8Array;
     messageBuffer: Uint8Array;
 };
@@ -4406,8 +4413,7 @@ export declare type TransformType = {
 };
 
 export declare type Transport = {
-    type: string;
-    send(message: Uint8Array): void;
+    send(message: Uint8Array): Promise<void>;
     onmessage?(message: Uint8Array): void;
     filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
 };
@@ -5120,6 +5126,7 @@ export declare namespace WireMessage {
      */
     export function validate(buf: ByteBuffer): boolean;
     export function readHeader(buf: ByteBuffer): Header | null;
+    export function getType(component: ComponentDefinition<ISchema<unknown>, unknown>, entity: Entity): Enum;
 }
 
 export declare const enum YGAlign {

package/etc/playground-assets.api.json

@@ -7430,7 +7430,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -7439,7 +7439,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -7456,7 +7456,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -9564,7 +9564,34 @@
             },
             {
               "kind": "Content",
-              "text": "): boolean;\n    defineComponent<T extends "
+              "text": "): boolean;\n    registerCustomComponent<T extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "ISchema",
+              "canonicalReference": "@dcl/playground-assets!ISchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", V>(component: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentDefinition",
+              "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T, V>, componentId: number): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentDefinition",
+              "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T, V>;\n    defineComponent<T extends "
             },
             {
               "kind": "Reference",
@@ -9595,7 +9622,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -9649,7 +9676,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -9667,7 +9694,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -9685,7 +9712,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -9694,7 +9721,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -9703,7 +9730,7 @@
             },
             {
               "kind": "Reference",
-              "text": "CompDef",
+              "text": "ComponentDefinition",
               "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
             },
             {
@@ -9735,7 +9762,16 @@
             },
             {
               "kind": "Content",
-              "text": "<T>]>;\n    update(deltaTime: number): void;\n    readonly RootEntity: "
+              "text": "<T>]>;\n    update(deltaTime: number): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<void>;\n    readonly RootEntity: "
             },
             {
               "kind": "Reference",
@@ -9783,7 +9819,7 @@
           "name": "IEngine",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 60
+            "endIndex": 68
           }
         },
         {
@@ -36902,7 +36938,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    componentId: number;\n    timestamp: number;\n    transportType?: string;\n    data?: "
+              "text": ";\n    componentId: number;\n    timestamp: number;\n    transportId?: number;\n    data?: "
             },
             {
               "kind": "Reference",
@@ -40337,7 +40373,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    type: string;\n    send(message: "
+              "text": "{\n    send(message: "
             },
             {
               "kind": "Reference",
@@ -40346,7 +40382,16 @@
             },
             {
               "kind": "Content",
-              "text": "): void;\n    onmessage?(message: "
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<void>;\n    onmessage?(message: "
             },
             {
               "kind": "Reference",
@@ -40385,7 +40430,7 @@
           "name": "Transport",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 10
+            "endIndex": 12
           }
         },
         {
@@ -46919,6 +46964,82 @@
                 }
               ]
             },
+            {
+              "kind": "Function",
+              "canonicalReference": "@dcl/playground-assets!WireMessage.getType:function(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "function getType(component: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ComponentDefinition",
+                  "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ISchema",
+                  "canonicalReference": "@dcl/playground-assets!ISchema:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<unknown>, unknown>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Enum",
+                  "canonicalReference": "@dcl/playground-assets!WireMessage.Enum:enum"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "returnTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "component",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 5
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 6,
+                    "endIndex": 7
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "getType"
+            },
             {
               "kind": "Variable",
               "canonicalReference": "@dcl/playground-assets!WireMessage.HEADER_LENGTH:var",

package/etc/playground-assets.api.md

@@ -654,12 +654,13 @@ export type IEngine = {
     entityExists(entity: Entity): boolean;
     addSystem(system: SystemFn, priority?: number, name?: string): void;
     removeSystem(selector: string | SystemFn): boolean;
+    registerCustomComponent<T extends ISchema, V>(component: ComponentDefinition<T, V>, componentId: number): ComponentDefinition<T, V>;
     defineComponent<T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: ConstructorType): ComponentDefinition<ISchema<Result<T>>, Partial<Result<T>>>;
     defineComponentFromSchema<T extends ISchema<ConstructorType>, ConstructorType>(spec: T, componentId: number, constructorDefault?: ConstructorType): ComponentDefinition<T, ConstructorType>;
     getComponent<T extends ISchema>(componentId: number): ComponentDefinition<T>;
     getComponentOrNull<T extends ISchema>(componentId: number): ComponentDefinition<T> | null;
     getEntitiesWith<T extends [ComponentDefinition<any>, ...ComponentDefinition<any>[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
-    update(deltaTime: number): void;
+    update(deltaTime: number): Promise<void>;
     readonly RootEntity: Entity;
     readonly PlayerEntity: Entity;
     readonly CameraEntity: Entity;
@@ -2598,7 +2599,7 @@ export type ReceiveMessage = {
     entity: Entity;
     componentId: number;
     timestamp: number;
-    transportType?: string;
+    transportId?: number;
     data?: Uint8Array;
     messageBuffer: Uint8Array;
 };
@@ -2850,8 +2851,7 @@ export type TransformType = {
 //
 // @public (undocumented)
 export type Transport = {
-    type: string;
-    send(message: Uint8Array): void;
+    send(message: Uint8Array): Promise<void>;
     onmessage?(message: Uint8Array): void;
     filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
 };
@@ -3079,15 +3079,17 @@ export namespace WireMessage {
         RESERVED = 0
     }
     // (undocumented)
+    export function getType(component: ComponentDefinition<ISchema<unknown>, unknown>, entity: Entity): Enum;
+    // (undocumented)
     export type Header = {
         length: Uint32;
         type: Uint32;
     };
-    // (undocumented)
-    export function readHeader(buf: ByteBuffer): Header | null;
     const // (undocumented)
     HEADER_LENGTH = 8;
     // (undocumented)
+    export function readHeader(buf: ByteBuffer): Header | null;
+    // (undocumented)
     export type Uint32 = number;
     export function validate(buf: ByteBuffer): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/playground-assets",
-  "version": "7.0.5",
+  "version": "7.0.6-3713220614.commit-d02ef9f",
   "description": "",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -17,12 +17,12 @@
   "author": "Decentraland",
   "license": "Apache-2.0",
   "dependencies": {
-    "@dcl/sdk": "7.0.5"
+    "@dcl/sdk": "7.0.6-3713220614.commit-d02ef9f"
   },
   "minCliVersion": "3.12.3",
   "files": [
     "dist",
     "etc"
   ],
-  "commit": "ad4efbcb7b87a23d25c26ca96f80d3ff795fcd9d"
+  "commit": "d02ef9fa9c36da3f26f7b1313e57cb4ccce5c539"
 }