@dcl/ecs 7.0.6-4057700455.commit-453395e → 7.0.6-4076330908.commit-cd40e5f

package/dist/engine/types.d.ts

@@ -2,10 +2,9 @@ import type { ISchema } from '../schemas/ISchema';
 import { MapResult, Spec } from '../schemas/Map';
 import { Transport } from '../systems/crdt/types';
 import { ComponentDefinition } from './component';
-import { Entity, EntityContainer, EntityState } from './entity';
+import { Entity, EntityState } from './entity';
 import { ReadonlyComponentSchema } from './readonly';
 import { SystemFn } from './systems';
-export { ISchema } from '../schemas/ISchema';
 /**
  * @public
  */
@@ -16,6 +15,10 @@ export type Unpacked<T> = T extends (infer U)[] ? U : T;
 export type ComponentSchema<T extends [ComponentDefinition<any>, ...ComponentDefinition<any>[]]> = {
     [K in keyof T]: T[K] extends ComponentDefinition<any> ? ReturnType<T[K]['getMutable']> : never;
 };
+/**
+ * @public
+ * Overrides component definition to support partial default values
+ */
 export interface MapComponentDefinition<T> extends ComponentDefinition<T> {
     /**
      * Add the current component to an entity, throw an error if the component already exists (use `createOrReplace` instead).
@@ -35,14 +38,16 @@ export interface MapComponentDefinition<T> extends ComponentDefinition<T> {
 /**
  * @public
  */
-export type IEngine = {
+export interface IEngine {
     /**
+     * @public
      * Increment the used entity counter and return the next one.
      * @param dynamic - whether or no the entity should be considered as Dynamic (vs Static)
      * @returns the next entity unused
      */
     addEntity(dynamic?: boolean): Entity;
     /**
+     * @public
      * Remove all components of an entity
      * @param entity - entity
      */
@@ -53,18 +58,21 @@ export type IEngine = {
      */
     removeEntityWithChildren(firstEntity: Entity): void;
     /**
+     *
+     * @public
      * Check the state of an entityin  the engine
      * @param entity - the entity to validate
-     * @returns known enum value
+     * @returns EntityState enum
      */
     getEntityState(entity: Entity): EntityState;
     /**
+     * @public
      * Add the system to the engine. It will be called every tick updated.
      * @param system - function that receives the delta time between last tick and current one.
      * @param priority - a number with the priority, big number are called before smaller ones
      * @param name - optional: a unique name to identify it
      *
-     * Example:
+     * @example
      * ```ts
      * function mySystem(dt: number) {
      *   const entitiesWithMeshRenderer = engine.getEntitiesWith(MeshRenderer, Transform)
@@ -77,26 +85,30 @@ export type IEngine = {
      */
     addSystem(system: SystemFn, priority?: number, name?: string): void;
     /**
+     * @public
      * Remove a system from the engine.
      * @param selector - the function or the unique name to identify
      * @returns if it was found and removed
      */
     removeSystem(selector: string | SystemFn): boolean;
     /**
+     * @public
      * Registers a custom component definition.
      * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param componentDefinition - The component definition
      */
     registerComponentDefinition<T>(componentName: string, componentDefinition: ComponentDefinition<T>): ComponentDefinition<T>;
     /**
+     * @public
      * Define a component and add it to the engine.
-     * @param spec - An object with schema fields
      * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
+     * @param spec - An object with schema fields
      * @param constructorDefault - the initial value prefilled when a component is created without a value
      * @returns The component definition
      *
+     * @example
      * ```ts
-     * const Door = engine.defineComponent("my-scene::Door", {
+     * const CustomComponent = engine.defineComponent("my-scene::custom-name", {
      *   id: Schemas.Int,
      *   name: Schemas.String
      * })
@@ -104,11 +116,13 @@ export type IEngine = {
      */
     defineComponent<T extends Spec>(componentName: string, spec: T, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
     /**
+     * @public
      * Define a component and add it to the engine.
      * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param spec - An object with schema fields
      * @returns The component definition
      *
+     * @example
      * ```ts
      * const StateComponentId = 10023
      * const StateComponent = engine.defineComponentFromSchema("my-lib::VisibleComponent", Schemas.Bool)
@@ -116,6 +130,7 @@ export type IEngine = {
      */
     defineComponentFromSchema<T>(componentName: string, spec: ISchema<T>): ComponentDefinition<T>;
     /**
+     * @public
      * Get the component definition from the component id.
      * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition, throw an error if it doesn't exist
@@ -136,6 +151,7 @@ export type IEngine = {
      */
     getComponentOrNull<T>(componentId: number): ComponentDefinition<T> | null;
     /**
+     * @public
      * Get a iterator of entities that has all the component requested.
      * @param components - a list of component definitions
      * @returns An iterator of an array with the [entity, component1, component2, ...]
@@ -149,6 +165,7 @@ export type IEngine = {
      */
     getEntitiesWith<T extends [ComponentDefinition<any>, ...ComponentDefinition<any>[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
     /**
+     * @public
      * @param deltaTime - deltaTime in seconds
      */
     update(deltaTime: number): Promise<void>;
@@ -168,14 +185,12 @@ export type IEngine = {
      */
     readonly CameraEntity: Entity;
     /**
+     * @alpha
      * @param transport - transport which changes its onmessage to process CRDT messages
      */
     addTransport(transport: Transport): void;
     /**
-     * Entity continaer
-     */
-    entityContainer: EntityContainer;
-    /**
+     * @public
      * Iterator of registered components
      */
     componentsIter(): Iterable<ComponentDefinition<unknown>>;
@@ -184,4 +199,4 @@ export type IEngine = {
      * components that will be available to this engine and to run optimizations.
      */
     seal(): void;
-};
+}

package/dist/index.d.ts

@@ -7,11 +7,12 @@ export * from './systems/events';
 export * from './systems/async-task';
 export * from './engine/entity';
 export * from './components/types';
-export declare const Transform: import("./components/types").TransformComponentExtended;
-export declare const Animator: import("./components/types").AnimatorComponentDefinitionExtended;
-export declare const Material: import("./components/types").MaterialComponentDefinitionExtended;
-export declare const MeshRenderer: import("./components/types").MeshRendererComponentDefinitionExtended;
-export declare const MeshCollider: import("./components/types").MeshColliderComponentDefinitionExtended;
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended } from './components/types';
+export declare const Transform: TransformComponentExtended;
+export declare const Animator: AnimatorComponentDefinitionExtended;
+export declare const Material: MaterialComponentDefinitionExtended;
+export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
+export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 export * from './components/generated/global.gen';
 export * from './components/generated/types.gen';
 export * from './serialization/crdt';

package/dist/runtime/initialization/index.d.ts

@@ -4,18 +4,43 @@
  */
 import { IEngine } from '../../engine';
 import { Task } from '../../systems/async-task';
+import { PointerEventsSystem } from '../../systems/events';
+import { IInputSystem } from './../../engine/input';
+/**
+ * @public
+ * The engine is the part of the scene that sits in the middle and manages all of the other parts.
+ * It determines what entities are rendered and how players interact with them.
+ * It also coordinates what functions from systems are executed and when.
+ *
+ * @example
+ * import { engine } from '@dcl/sdk/ecs'
+ * const entity = engine.addEntity()
+ * engine.addSystem(someSystemFunction)
+ *
+ */
 export declare const engine: IEngine;
-export declare const inputSystem: import("../../engine").IInputSystem;
-export declare const pointerEventsSystem: {
-    removeOnClick(entity: import("../../engine").Entity): void;
-    removeOnPointerDown(entity: import("../../engine").Entity): void;
-    removeOnPointerUp(entity: import("../../engine").Entity): void;
-    onClick(entity: import("../../engine").Entity, cb: import("../../systems/events").EventSystemCallback, opts?: Partial<import("../../systems/events").EventSystemOptions> | undefined): void;
-    onPointerDown(entity: import("../../engine").Entity, cb: import("../../systems/events").EventSystemCallback, opts?: Partial<import("../../systems/events").EventSystemOptions> | undefined): void;
-    onPointerUp(entity: import("../../engine").Entity, cb: import("../../systems/events").EventSystemCallback, opts?: Partial<import("../../systems/events").EventSystemOptions> | undefined): void;
-};
 /**
  * @public
+ * Input system manager. Check for button events
+ * @example
+ * inputSystem.isTriggered: Returns true if an input action ocurred since the last tick.
+ * inputSystem.isPressed: Returns true if an input is currently being pressed down. It will return true on every tick until the button goes up again.
+ * inputSystem.getInputCommand: Returns an object with data about the input action.
+ */
+export declare const inputSystem: IInputSystem;
+export { IInputSystem };
+/**
+ * @public
+ * Register callback functions to a particular entity.
+ */
+export declare const pointerEventsSystem: PointerEventsSystem;
+export { PointerEventsSystem };
+/**
+ * @public
+ * Runs an async function
  */
 export declare const executeTask: (task: Task<unknown>) => void;
+/**
+ * @public
+ */
 export type { Task };

package/dist/runtime/initialization/index.js

@@ -6,15 +6,39 @@ import { Engine } from '../../engine';
 import { createTaskSystem } from '../../systems/async-task';
 import { createPointerEventSystem } from '../../systems/events';
 import { createInputSystem } from './../../engine/input';
+/**
+ * @public
+ * The engine is the part of the scene that sits in the middle and manages all of the other parts.
+ * It determines what entities are rendered and how players interact with them.
+ * It also coordinates what functions from systems are executed and when.
+ *
+ * @example
+ * import { engine } from '@dcl/sdk/ecs'
+ * const entity = engine.addEntity()
+ * engine.addSystem(someSystemFunction)
+ *
+ */
 /*#__PURE__*/
 export const engine = Engine();
-// INPUT Manager
+/**
+ * @public
+ * Input system manager. Check for button events
+ * @example
+ * inputSystem.isTriggered: Returns true if an input action ocurred since the last tick.
+ * inputSystem.isPressed: Returns true if an input is currently being pressed down. It will return true on every tick until the button goes up again.
+ * inputSystem.getInputCommand: Returns an object with data about the input action.
+ */
 /*#__PURE__*/
 export const inputSystem = createInputSystem(engine);
+/**
+ * @public
+ * Register callback functions to a particular entity.
+ */
 /*#__PURE__*/
 export const pointerEventsSystem = createPointerEventSystem(engine, inputSystem);
 /**
  * @public
+ * Runs an async function
  */
 /*#__PURE__*/
 export const executeTask = createTaskSystem(engine).executeTask;

package/dist/runtime/types.d.ts

@@ -5,4 +5,3 @@ export * from '../engine/component';
 export * from '../schemas/typing';
 export type { MapResult, Spec } from '../schemas/Map';
 export * from '../engine/component';
-export * from '../schemas/typing';

package/dist/runtime/types.js

@@ -1,4 +1,3 @@
 export * from '../engine/component';
 export * from '../schemas/typing';
 export * from '../engine/component';
-export * from '../schemas/typing';

package/dist/schemas/Array.d.ts

@@ -1,5 +1 @@
-import { ISchema } from './ISchema';
-/**
- * @public
- */
-export declare function IArray<T>(type: ISchema<T>): ISchema<Array<T>>;
+export {};

package/dist/schemas/Array.js

@@ -1,7 +1,7 @@
 /**
- * @public
+ * @internal
  */
-export function IArray(type) {
+export const IArray = (type) => {
     return {
         serialize(value, builder) {
             builder.writeUint32(value.length);
@@ -21,4 +21,4 @@ export function IArray(type) {
             return [];
         }
     };
-}
+};

package/dist/schemas/ISchema.d.ts

@@ -2,9 +2,9 @@ import { ByteBuffer } from '../serialization/ByteBuffer';
 /**
  * @public
  */
-export type ISchema<T = any> = {
+export interface ISchema<T = any> {
     serialize(value: T, builder: ByteBuffer): void;
     deserialize(reader: ByteBuffer): T;
     create(): T;
     extend?: (base?: T) => T;
-};
+}

package/dist/schemas/Map.d.ts

@@ -19,7 +19,3 @@ export type MapResultWithOptional<T extends Spec> = ToOptional<{
     [K in keyof T]?: T[K] extends ISchema ? ReturnType<T[K]['deserialize']> : T[K] extends Spec ? MapResult<T[K]> : never;
 }>;
 export type MapSchemaType<T extends Spec> = ISchema<MapResult<T>>;
-/**
- * @public
- */
-export declare function IMap<T extends Spec>(spec: T, defaultValue?: Partial<MapResult<T>>): ISchema<MapResult<T>>;

package/dist/schemas/Map.js

@@ -1,7 +1,7 @@
 /**
- * @public
+ * @internal
  */
-export function IMap(spec, defaultValue) {
+export const IMap = (spec, defaultValue) => {
     return {
         serialize(value, builder) {
             for (const key in spec) {
@@ -33,4 +33,4 @@ export function IMap(spec, defaultValue) {
             return { ...newValue, ...defaultValue, ...base };
         }
     };
-}
+};

package/dist/schemas/Optional.d.ts

@@ -1,5 +1 @@
-import { ISchema } from './ISchema';
-/**
- * @public
- */
-export declare function IOptional<T>(spec: ISchema<T>): ISchema<T | undefined>;
+export {};

package/dist/schemas/Optional.js

@@ -1,7 +1,7 @@
 /**
- * @public
+ * @internal
  */
-export function IOptional(spec) {
+export const IOptional = (spec) => {
     return {
         serialize(value, builder) {
             if (value) {
@@ -22,4 +22,4 @@ export function IOptional(spec) {
             return undefined;
         }
     };
-}
+};

package/dist/schemas/basic/Boolean.d.ts

@@ -1,5 +1 @@
-import { ISchema } from '../ISchema';
-/**
- * @public
- */
-export declare const Bool: ISchema<boolean>;
+export {};

package/dist/schemas/basic/Boolean.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const Bool = {
     serialize(value, builder) {

package/dist/schemas/basic/Enum.d.ts

@@ -1,5 +1 @@
-import { ISchema } from '../ISchema';
-/**
- * @public
- */
-export declare function IEnum<T>(type: ISchema<any>): ISchema<T>;
+export {};

package/dist/schemas/basic/Enum.js

@@ -1,7 +1,7 @@
 /**
- * @public
+ * @internal
  */
-export function IEnum(type) {
+export const IEnum = (type) => {
     return {
         serialize(value, builder) {
             type.serialize(value, builder);
@@ -13,4 +13,4 @@ export function IEnum(type) {
             return type.create();
         }
     };
-}
+};

package/dist/schemas/basic/Float.d.ts

@@ -1,9 +1 @@
-import { ISchema } from '../ISchema';
-/**
- * @public
- */
-export declare const Float32: ISchema<number>;
-/**
- * @public
- */
-export declare const Float64: ISchema<number>;
+export {};

package/dist/schemas/basic/Float.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const Float32 = {
     serialize(value, builder) {
@@ -13,7 +13,7 @@ export const Float32 = {
     }
 };
 /**
- * @public
+ * @internal
  */
 export const Float64 = {
     serialize(value, builder) {

package/dist/schemas/basic/Integer.d.ts

@@ -1,12 +1,4 @@
 import { ISchema } from '../ISchema';
-/**
- * @public
- */
-export declare const Int64: ISchema<number>;
-/**
- * @public
- */
-export declare const Int32: ISchema<number>;
 /**
  * @public
  */

package/dist/schemas/basic/Integer.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const Int64 = {
     serialize(value, builder) {
@@ -13,7 +13,7 @@ export const Int64 = {
     }
 };
 /**
- * @public
+ * @internal
  */
 export const Int32 = {
     serialize(value, builder) {

package/dist/schemas/basic/String.d.ts

@@ -1,9 +1 @@
-import { ISchema } from '../ISchema';
-/**
- * @public
- */
-export declare const FlatString: ISchema<string>;
-/**
- * @public
- */
-export declare const EcsString: ISchema<string>;
+export {};

package/dist/schemas/basic/String.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const FlatString = {
     serialize(value, builder) {
@@ -13,6 +13,6 @@ export const FlatString = {
     }
 };
 /**
- * @public
+ * @internal
  */
 export const EcsString = FlatString;

package/dist/schemas/custom/Color3.d.ts

@@ -1,4 +1,3 @@
-import { ISchema } from '../ISchema';
 /**
  * @public
  */
@@ -7,7 +6,3 @@ export type Color3Type = {
     g: number;
     b: number;
 };
-/**
- * @public
- */
-export declare const Color3Schema: ISchema<Color3Type>;

package/dist/schemas/custom/Color3.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const Color3Schema = {
     serialize(value, builder) {

package/dist/schemas/custom/Color4.d.ts

@@ -1,4 +1,3 @@
-import { ISchema } from '../ISchema';
 /**
  * @public
  */
@@ -8,7 +7,3 @@ export type Color4Type = {
     b: number;
     a: number;
 };
-/**
- * @public
- */
-export declare const Color4Schema: ISchema<Color4Type>;

package/dist/schemas/custom/Color4.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const Color4Schema = {
     serialize(value, builder) {

package/dist/schemas/custom/Entity.d.ts

@@ -1,6 +1 @@
-import { Entity } from '../../engine/entity';
-import { ISchema } from '../ISchema';
-/**
- * @public
- */
-export declare const EntitySchema: ISchema<Entity>;
+export {};

package/dist/schemas/custom/Entity.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const EntitySchema = {
     serialize(value, builder) {

package/dist/schemas/custom/Quaternion.d.ts

@@ -1,4 +1,3 @@
-import { ISchema } from '../ISchema';
 /**
  * @public
  */
@@ -8,7 +7,3 @@ export type QuaternionType = {
     z: number;
     w: number;
 };
-/**
- * @public
- */
-export declare const QuaternionSchema: ISchema<QuaternionType>;

package/dist/schemas/custom/Quaternion.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const QuaternionSchema = {
     serialize(value, builder) {

package/dist/schemas/custom/Vector3.d.ts

@@ -1,4 +1,3 @@
-import { ISchema } from '../ISchema';
 /**
  * @public
  */
@@ -7,7 +6,3 @@ export type Vector3Type = {
     y: number;
     z: number;
 };
-/**
- * @public
- */
-export declare const Vector3Schema: ISchema<Vector3Type>;

package/dist/schemas/custom/Vector3.js

@@ -1,5 +1,5 @@
 /**
- * @public
+ * @internal
  */
 export const Vector3Schema = {
     serialize(value, builder) {