@dcl/sdk 7.0.0-2947735169.commit-65163b3 → 7.0.0-2965783764.commit-18f9e1c

package/dist/ecs7/index.d.ts

@@ -250,6 +250,8 @@ export declare namespace Components {
     const TextShape: ComponentDefinition<ISchema<PBTextShape>, PBTextShape>;
     /** @public */
     const UiText: ComponentDefinition<ISchema<PBUiText>, PBUiText>;
+    /** @public */
+    const VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
 }
 
 /**
@@ -405,14 +407,36 @@ declare interface CreateByteBufferOptions {
 /** @public */
 export declare const CylinderShape: ComponentDefinition<ISchema<PBCylinderShape>, PBCylinderShape>;
 
+/**
+ * @public
+ */
+export declare type DeepReadonly<T> = T extends ReadonlyPrimitive ? T : T extends Map<infer K, infer V> ? DeepReadonlyMap<K, V> : T extends Set<infer M> ? DeepReadonlySet<M> : DeepReadonlyObject<T>;
+
 /**
  * Make each field readonly deeply
  * @public
  */
-export declare type DeepReadonly<T> = {
-    readonly [P in keyof T]: DeepReadonly<T[P]>;
+declare type DeepReadonly_2<T> = {
+    readonly [P in keyof T]: DeepReadonly_2<T[P]>;
+};
+
+/**
+ * @public
+ */
+export declare type DeepReadonlyMap<K, V> = ReadonlyMap<DeepReadonly<K>, DeepReadonly<V>>;
+
+/**
+ * @public
+ */
+export declare type DeepReadonlyObject<T> = {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
 };
 
+/**
+ * @public
+ */
+export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
+
 declare function defineSdkComponents(engine: PreEngine): {
     Transform: ComponentDefinition<ISchema<TransformType>, Partial<TransformType>>;
     MeshRenderer: ComponentDefinition<ISchema<PBMeshRenderer>, Partial<PBMeshRenderer>>;
@@ -438,6 +462,7 @@ declare function defineSdkComponents(engine: PreEngine): {
     SphereShape: ComponentDefinition<ISchema<PBSphereShape>, PBSphereShape>;
     TextShape: ComponentDefinition<ISchema<PBTextShape>, PBTextShape>;
     UiText: ComponentDefinition<ISchema<PBUiText>, PBUiText>;
+    VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
 };
 
 /**
@@ -459,10 +484,6 @@ declare type EcsResult<T extends ISchema> = T extends ISchema ? ReturnType<T['de
  */
 export declare function Engine({ transports }?: IEngineParams): IEngine;
 
-/**
- * @alpha * This file initialization is an alpha one. This is based on the old-ecs
- * init and it'll be changing.
- */
 export declare const engine: IEngine;
 
 /**
@@ -567,7 +588,7 @@ export declare type IEngine = {
      *
      * ```
      */
-    defineComponent<T extends Spec, ConstructorType = Partial<Result<T>>>(spec: Spec, componentId: number, constructorDefault?: Partial<Result<T>>): ComponentDefinition<ISchema<Result<T>>, ConstructorType>;
+    defineComponent<T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: Partial<Result<T>>): ComponentDefinition<ISchema<Result<T>>, ConstructorType>;
     /**
      * Define a component and add it to the engine.
      * @param spec An object with schema fields
@@ -598,11 +619,11 @@ export declare type IEngine = {
      * Example:
      * ```ts
      * for (const [entity, boxShape, transform] of engine.getEntitiesWith(BoxShape, Transform)) {
-     * // the properties of boxShape and transform are read only
+     *   // the properties of boxShape and transform are read only
      * }
      * ```
      */
-    getEntitiesWith<T extends [ComponentDefinition, ...ComponentDefinition[]]>(...components: T): Iterable<[Entity, ...DeepReadonly<ComponentSchema<T>>]>;
+    getEntitiesWith<T extends [ComponentDefinition, ...ComponentDefinition[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
     baseComponents: SdkComponents;
 };
 
@@ -636,7 +657,7 @@ declare function IOptional<T>(spec: ISchema<T>): ISchema<T | undefined>;
 /**
  * @public
  */
-declare type ISchema<T = any> = {
+export declare type ISchema<T = any> = {
     serialize(value: T, builder: ByteBuffer): void;
     deserialize(reader: ByteBuffer): T;
     create(): T;
@@ -698,7 +719,7 @@ declare namespace Matrix {
         _isIdentity3x2Dirty: boolean;
         _m: Matrix4x4;
     };
-    type ReadonlyMatrix = DeepReadonly<MutableMatrix>;
+    type ReadonlyMatrix = DeepReadonly_2<MutableMatrix>;
     /**
      * Gets the internal data of the matrix
      */
@@ -1717,6 +1738,11 @@ declare interface PBUiText {
     textColor: Color3 | undefined;
 }
 
+declare interface PBVisibilityComponent {
+    /** default=true */
+    visible?: boolean | undefined;
+}
+
 /**
  * Represens a plane by the equation ax + by + cz + d = 0
  * @public
@@ -1732,7 +1758,7 @@ declare namespace Plane {
          */
         d: number;
     };
-    type ReadonlyPlane = DeepReadonly<MutablePlane>;
+    type ReadonlyPlane = DeepReadonly_2<MutablePlane>;
     /**
      * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
      * @param a - a component of the plane
@@ -1852,7 +1878,7 @@ declare function preEngine(): {
     removeSystem: (selector: string | Update) => boolean;
     defineComponent: <T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: ConstructorType | undefined) => ComponentDefinition<ISchema<Result<T>>, ConstructorType>;
     defineComponentFromSchema: <T_1 extends ISchema<any>, ConstructorType_1 = EcsResult<T_1>>(spec: T_1, componentId: number, constructorDefault?: ConstructorType_1 | undefined) => ComponentDefinition<T_1, ConstructorType_1>;
-    getEntitiesWith: <T_2 extends [ComponentDefinition<ISchema<any>, any>, ...ComponentDefinition<ISchema<any>, any>[]]>(...components: T_2) => Iterable<[Entity, ...DeepReadonly<ComponentSchema<T_2>>]>;
+    getEntitiesWith: <T_2 extends [ComponentDefinition<ISchema<any>, any>, ...ComponentDefinition<ISchema<any>, any>[]]>(...components: T_2) => Iterable<[Entity, ...ReadonlyComponentSchema<T_2>]>;
     getComponent: <T_3 extends ISchema<any>>(componentId: number) => ComponentDefinition<T_3, EcsResult<T_3>>;
     removeComponentDefinition: (componentId: number) => void;
 };
@@ -1873,7 +1899,7 @@ export declare namespace Quaternion {
     /**
      * @public
      */
-    export type ReadonlyQuaternion = DeepReadonly<MutableQuaternion>;
+    export type ReadonlyQuaternion = DeepReadonly_2<MutableQuaternion>;
     /**
      * Creates a new Quaternion from the given floats
      * @param x - defines the first component (0 by default)
@@ -2027,6 +2053,18 @@ export declare namespace Quaternion {
  */
 export declare const RAD2DEG: number;
 
+/**
+ * @public
+ */
+export declare type ReadonlyComponentSchema<T extends [ComponentDefinition, ...ComponentDefinition[]]> = {
+    [K in keyof T]: T[K] extends ComponentDefinition ? ReturnType<T[K]['get']> : never;
+};
+
+/**
+ * @public
+ */
+export declare type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
+
 declare type ReceiveMessage = {
     type: WireMessage.Enum;
     entity: Entity;
@@ -2191,7 +2229,7 @@ export declare namespace Vector3 {
     /**
      * @public
      */
-    export type ReadonlyVector3 = DeepReadonly<MutableVector3>;
+    export type ReadonlyVector3 = DeepReadonly_2<MutableVector3>;
     /**
      * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
      * @param x - defines the first coordinates (on X axis)
@@ -2385,6 +2423,9 @@ declare interface Vector3_2 {
     z: number;
 }
 
+/** @public */
+export declare const VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
+
 declare namespace WireMessage {
     enum Enum {
         RESERVED = 0,