ecsjs 1.0.0-beta.13 → 1.0.0-beta.14

package/dist/ecs.js

@@ -1,2 +1,2 @@
-var r=class extends Error{constructor(t){super(`Component map does not exist for '${t}'`);this.componentName=t}};var u=class{constructor(e,t,...n){this.ecs=e;this.key=t;this.keyMap=this.ecs.getMap(t),this.entries=this.keyMap.entries(),this.components=n.map(s=>this.ecs.getMap(s))}keyMap;components;entries;next(){let e=this.entries.next(),{value:t,done:n}=e;if(n)return{value:t,done:n};let[s]=t;for(let o of this.components)t.push(o.get(s));return{value:t,done:n}}reset(){this.entries=this.keyMap.entries()}[Symbol.iterator](){return this}};var p=class extends Map{constructor(e=[]){super(e)}firstEntry(){return this.size===0?void 0:this.entries().next().value}firstKey(){return this.size===0?void 0:this.keys().next().value}firstValue(){return this.size===0?void 0:this.values().next().value}toJSON(){return{__KeyMap__:1,iterable:[...this.entries()]}}toTable(e=!1){let t=[];for(let[n,s]of this.entries()){let o=s,i={};e==!1&&(i["entity.key"]=n),i["entity.type"]=o.constructor.name,t.push({...i,...o})}return t}printTable(e=!1){console.table(this.toTable(e))}entries(){return super.entries().filter(e=>e!=null)}keys(){return super.keys().filter(e=>e!=null)}values(){return super.values().filter(e=>e!=null)}static get[Symbol.species](){return Map}};var m=class a{componentMaps=new p;nextId=0;constructor(){}register(...e){for(let t of e){let n=t.name;if(n===void 0)throw new ReferenceError("The component class does not have a name defined. i.e. a constructor name");let s=new p;this.componentMaps.set(n,s)}return this}getMap(e){let t=this.componentMaps.get(e.name);if(t===void 0)throw new r(e.name);return t}firstEntry(e){return this.getMap(e)?.firstEntry()}firstKey(e,...t){let n=this.getMap(e)?.firstKey();if(arguments.length===1)return n;if(n!==void 0)return[n,...t.map(s=>this.getEntity(n,s))]}firstValue(e,...t){if(arguments.length===1)return this.getMap(e)?.firstValue();let[n,s]=this.getMap(e)?.firstEntry()??[];if(n!==void 0)return[s,...t.map(o=>this.getEntity(n,o))]}getEntity(e,t){let n=this.componentMaps.get(t.name);if(n===void 0)throw new r(t.name);return n.get(e)}get(e,...t){return t.length>1?t.map(n=>this.getEntity(e,n)):this.getEntity(e,t[0])}getByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new r(t);return n.get(e)}has(e,t){let n=this.componentMaps.get(t.name);return n===void 0?!1:n.has(e)}setEntity(e,t){let n=this.componentMaps.get(t.constructor.name);if(n===void 0)throw new r(t.constructor.name);return n.set(e,t),t}set(e,...t){return t.length>1?t.map(n=>this.setEntity(e,n)):this.setEntity(e,t[0])}remove(e,...t){for(let n of t)this.removeByKey(e,n.name)}removeByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new r(t);return n.get(e)===void 0?!1:n.delete(e)}destroyEntity(e){for(let t of this.componentMaps.values())t.has(e)&&t.delete(e)}getNextId(){return this.nextId++,this.nextId}clear(){return this.componentMaps.clear(),this}iterator(e,...t){return new u(this,e,...t)}printTable(){return this.componentMaps.forEach(e=>console.table(e.toTable(!0))),this}printEntity(e){for(let t of this.componentMaps.values()){if(t.has(e)===!1)continue;let n=t.get(e),s={name:n.constructor.name,...n};console.table({[e]:s})}return this}static parse(e){let t=new a,n=JSON.parse(e,function(s,o){return o.hasOwnProperty("componentMaps")?(Reflect.setPrototypeOf(o,a.prototype),o):o.hasOwnProperty("__KeyMap__")?new p(o.iterable):this[s]});return t.componentMaps=n.componentMaps,t.nextId=n.nextId,t}static createWithTracing(e){let t={get(n,s){let o=n[s];return typeof o=="function"&&(e.length===0||e.includes(s))?function(...i){return console.groupCollapsed("ecs trace",s,i),console.trace(),console.groupEnd(),o.apply(this,i)}:o}};return new Proxy(new a,t)}};var l=new m;typeof window<"u"?window.ecs=l:typeof module<"u"&&module!==null&&(module.exports={ecs:l});export{u as ComponentIterator,m as EntityMap,l as ecs};
+var a=class extends Error{constructor(t){super(`Component map does not exist for '${t}'`);this.componentName=t}};var u=class{constructor(e,t,...n){this.ecs=e;this.key=t;this.keyMap=this.ecs.getMap(t),this.entries=this.keyMap.entries(),this.components=n.map(s=>this.ecs.getMap(s))}keyMap;components;entries;next(){let e=this.entries.next(),{value:t,done:n}=e;if(n)return{value:t,done:n};let[s,o]=t,r=[s,o];for(let c of this.components)r.push(c.get(s));return{value:r,done:!1}}reset(){this.entries=this.keyMap.entries()}[Symbol.iterator](){return this}};var p=class extends Map{constructor(e=[]){super(e)}firstEntry(){return this.size===0?void 0:this.entries().next().value}firstKey(){return this.size===0?void 0:this.keys().next().value}firstValue(){return this.size===0?void 0:this.values().next().value}toJSON(){return{__KeyMap__:1,iterable:[...this.entries()]}}toTable(e=!1){let t=[];for(let[n,s]of this.entries()){let o=s,r={};e==!1&&(r["entity.key"]=n),r["entity.type"]=o.constructor.name,t.push({...r,...o})}return t}printTable(e=!1){console.table(this.toTable(e))}entries(){return super.entries().filter(e=>e!=null)}keys(){return super.keys().filter(e=>e!=null)}values(){return super.values().filter(e=>e!=null)}static get[Symbol.species](){return Map}};var m=class i{componentMaps=new p;nextId=0;constructor(){}register(...e){for(let t of e){let n=t.name;if(n===void 0)throw new ReferenceError("The component class does not have a name defined. i.e. a constructor name");let s=new p;this.componentMaps.set(n,s)}return this}getMap(e){let t=this.componentMaps.get(e.name);if(t===void 0)throw new a(e.name);return t}firstEntry(e){return this.getMap(e)?.firstEntry()}firstKey(e,...t){let n=this.getMap(e)?.firstKey();if(arguments.length===1)return n;if(n!==void 0)return[n,...t.map(s=>this.getEntity(n,s))]}firstValue(e,...t){if(arguments.length===1)return this.getMap(e)?.firstValue();let[n,s]=this.getMap(e)?.firstEntry()??[];if(n!==void 0)return[s,...t.map(o=>this.getEntity(n,o))]}getEntity(e,t){let n=this.componentMaps.get(t.name);if(n===void 0)throw new a(t.name);return n.get(e)}get(e,...t){return t.length>1?t.map(n=>this.getEntity(e,n)):this.getEntity(e,t[0])}getByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new a(t);return n.get(e)}has(e,t){let n=this.componentMaps.get(t.name);return n===void 0?!1:n.has(e)}setEntity(e,t){let n=this.componentMaps.get(t.constructor.name);if(n===void 0)throw new a(t.constructor.name);return n.set(e,t),t}set(e,...t){return t.length>1?t.map(n=>this.setEntity(e,n)):this.setEntity(e,t[0])}remove(e,...t){for(let n of t)this.removeByKey(e,n.name)}removeByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new a(t);return n.get(e)===void 0?!1:n.delete(e)}destroyEntity(e){for(let t of this.componentMaps.values())t.has(e)&&t.delete(e)}getNextId(){return this.nextId++,this.nextId}clear(){return this.componentMaps.clear(),this}iterator(e,...t){return new u(this,e,...t)}printTable(){return this.componentMaps.forEach(e=>console.table(e.toTable(!0))),this}printEntity(e){for(let t of this.componentMaps.values()){if(t.has(e)===!1)continue;let n=t.get(e),s={name:n.constructor.name,...n};console.table({[e]:s})}return this}static parse(e){let t=new i,n=JSON.parse(e,function(s,o){return o.hasOwnProperty("componentMaps")?(Reflect.setPrototypeOf(o,i.prototype),o):o.hasOwnProperty("__KeyMap__")?new p(o.iterable):this[s]});return t.componentMaps=n.componentMaps,t.nextId=n.nextId,t}static createWithTracing(e){let t={get(n,s){let o=n[s];return typeof o=="function"&&(e.length===0||e.includes(s))?function(...r){return console.groupCollapsed("ecs trace",s,r),console.trace(),console.groupEnd(),o.apply(this,r)}:o}};return new Proxy(new i,t)}};var l=new m;typeof window<"u"?window.ecs=l:typeof module<"u"&&module!==null&&(module.exports={ecs:l});export{u as ComponentIterator,m as EntityMap,l as ecs};
 //# sourceMappingURL=ecs.js.map

package/dist/ecs.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/errors.ts", "../src/iterators.ts", "../src/key-map.ts", "../src/entity-map.ts", "../src/ecs.ts"],
-  "sourcesContent": ["export class ComponentNotRegistered extends Error {\n  constructor(public componentName: string) {\n    super(`Component map does not exist for '${componentName}'`);\n  }\n}", "import type { ComponentClass, ComponentClassMap, ComponentInstances } from './definitions.js';\nimport type { EntityMap } from './entity-map.js';\n\nexport class ComponentIterator<\n  K extends ComponentClass<any>,\n  T extends ComponentClass<any>[]\n> {\n\n  private keyMap: ComponentClassMap<any>\n  private components: ComponentClassMap<any>[]\n  // iteration state\n  private entries: MapIterator<[number, ComponentClass<any>]>\n\n  /**\n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // iterate each component value that is related to the Components.Player entity\n   * const iterator = new ComponentIterator(ecs, Components.Player, Components.Position)\n   * \n   * for(const [playerId, player, position] of iterator) {\n   * \n   * }\n   */\n  constructor(public ecs: EntityMap, public key: K, ...components: T) {\n    this.keyMap = this.ecs.getMap(key)!;\n    this.entries = this.keyMap.entries();\n    this.components = components.map(x => this.ecs.getMap(x)!);\n  }\n\n  next(): IteratorResult<ComponentInstances<[ComponentClass<number>, K, ...T]>> {\n    const entry = this.entries.next();\n    const { value, done } = entry;\n    if (done) return { value: value as any, done };\n\n    const [entityId] = value;\n    for (const x of this.components) {\n      value.push(x.get(entityId));\n    }\n\n    return { value: value as any, done: done as boolean };\n  }\n\n  /**\n   * reset the iterator back to the first entry\n   */\n  reset() {\n    this.entries = this.keyMap.entries();\n  }\n\n  [Symbol.iterator]() { return this; }\n\n}", "/*\n ecsjs is an entity component system library for JavaScript\n Copyright (C) 2014 Peter Flannery\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program.  If not, see <http://www.gnu.org/licenses/>.\n */\nimport type { KeyCollection } from './definitions.js';\n\n/**\n * Class for storing keys and values\n */\nexport class KeyMap<TKey, TValue> extends Map<TKey, TValue> {\n\n  constructor(entries: any[] = []) {\n    super(entries)\n  }\n\n  firstEntry(): [key: TKey, value: TValue] | undefined {\n    if (this.size === 0) return undefined;\n\n    const iterator = this.entries();\n    const result = iterator.next();\n    return result.value;\n  }\n\n  firstKey(): TKey | undefined {\n    if (this.size === 0) return undefined;\n\n    const iterator = this.keys();\n    const result = iterator.next();\n    return result.value;\n  }\n\n  firstValue(): TValue | undefined {\n    if (this.size === 0) return undefined;\n\n    const iterator = this.values();\n    const result = iterator.next();\n    return result.value;\n  }\n\n  toJSON() {\n    return { __KeyMap__: 1, iterable: [...this.entries()] }\n  }\n\n  toTable(excludeKeys = false): any[] {\n    const table = []\n    for (const [key, value] of this.entries()) {\n      const entity = value as { new(): TValue }\n      const meta: KeyCollection<any> = {}\n      if (excludeKeys == false) meta[\"entity.key\"] = key\n      meta[\"entity.type\"] = entity.constructor.name\n      table.push({ ...meta, ...entity })\n    }\n    return table\n  }\n\n  /**\n   * Outputs keys and values in a tabular format to the console\n   */\n  printTable(excludeKeys = false): void {\n    console.table(this.toTable(excludeKeys))\n  }\n\n  entries(): MapIterator<[TKey, TValue]> {\n    return super.entries().filter(x => x !== undefined && x !== null)\n  }\n\n  keys(): MapIterator<TKey> {\n    return super.keys().filter(x => x !== undefined && x !== null)\n  }\n\n  values(): MapIterator<TValue> {\n    return super.values().filter(x => x !== undefined && x !== null)\n  }\n\n  static get [Symbol.species]() { return Map; }\n\n}", "/*\n ecsjs is an entity component system library for JavaScript\n Copyright (C) 2014 Peter Flannery\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program.  If not, see <http://www.gnu.org/licenses/>.\n */\n\n/**\n * @module ecsjs\n */\nimport {\n  type Component,\n  type ComponentClass,\n  type ComponentClassesMap,\n  type ComponentClassMap,\n  type ComponentInstances\n} from './definitions.js';\nimport { ComponentNotRegistered } from './errors.js';\nimport { ComponentIterator } from './iterators.js';\nimport { KeyMap } from './key-map.js';\n\n/**\n * Class for storing entities and their relationships\n * \n * @class EntityMap\n */\nexport class EntityMap {\n\n  // entity class maps\n  private componentMaps: ComponentClassesMap = new KeyMap()\n\n  private nextId: number = 0\n\n  constructor() { }\n\n  /**\n   * Registers component classes\n   * \n   * @example\n   * // component class\n   * class MyComponent {\n   *   constructor(x) {\n   *     this.x = x;\n   *   }\n   * }\n   *\n   * ecs.register(MyComponent);\n   * // or\n   * ecs.register(MyComponent1, MyComponent2);\n   */\n  register<TArgs extends ComponentClass<any>[]>(...componentClasses: TArgs) {\n    for (const componentClass of componentClasses) {\n      const componentName = componentClass.name;\n      if (componentName === undefined)\n        throw new ReferenceError(\"The component class does not have a name defined. i.e. a constructor name\");\n\n      // create the component map\n      const componentDataMap: ComponentClassMap<any> = new KeyMap();\n      this.componentMaps.set(componentName, componentDataMap);\n    }\n\n    // chain\n    return this;\n  }\n\n  /**\n   * Get a component class map\n   * \n   * @throws {ComponentNotRegistered} when the specified component is not registered\n   */\n  getMap<T>(component: ComponentClass<T>): ComponentClassMap<T> | undefined {\n    const map = this.componentMaps.get(component.name);\n    if (map === undefined) throw new ComponentNotRegistered(component.name)\n    return map\n  }\n\n  /**\n   * Get the first entity entry for a component class\n   * \n   * @throws {ComponentNotRegistered} when the specified component is not registered\n   * \n   * @example\n   * const [entityId, player] = ecs.firstEntry(PlayerComponent) ?? [];\n   */\n  firstEntry<T>(component: ComponentClass<T>) {\n    return this.getMap(component)?.firstEntry();\n  }\n\n  /**\n   * Get the first entity id for a component class\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // return the first component id\n   * const entityId = ecs.firstKey(PlayerComponent);\n   * \n   * // or multiple related values in addition to the first component id\n   * const [entityId, position, direction] = ecs.firstKey(\n   *   PlayerComponent,\n   *   PositionComponent,\n   *   DirectionComponent\n   * ) ?? [];\n   */\n  firstKey<TKey extends ComponentClass<any>, T extends ComponentClass<any>[]>(\n    keyComponent: TKey,\n    ...components: T\n  ): ComponentInstances<[ComponentClass<number>, ...T]> | undefined;\n  firstKey(keyComponent: ComponentClass<any>, ...components: ComponentClass<any>[]) {\n    const entityId = this.getMap(keyComponent)?.firstKey();\n\n    // single component key\n    if (arguments.length === 1) return entityId;\n    if (entityId === undefined) return undefined;\n\n    // attach multiple related component values\n    return [entityId, ...components.map(x => this.getEntity(entityId, x))];\n  }\n\n  /**\n   * Get the first entity component value for a component class\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // return the first component value\n   * const player = ecs.firstValue(PlayerComponent);\n   * \n   * // or multiple related values in addition to the first component\n   * const [player, position, direction] = ecs.firstValue(\n   *   PlayerComponent,\n   *   PositionComponent,\n   *   DirectionComponent\n   * );\n   */\n  firstValue<TKey extends ComponentClass<any>, T extends ComponentClass<any>[]>(\n    keyComponent: TKey,\n    ...components: T\n  ): ComponentInstances<[TKey, ...T]> | undefined;\n  firstValue(keyComponent: ComponentClass<any>, ...components: ComponentClass<any>[]) {\n    // single component\n    if (arguments.length === 1) return this.getMap(keyComponent)?.firstValue();\n\n    // get the first entry\n    const [entityId, value] = this.getMap(keyComponent)?.firstEntry() ?? [];\n    if (entityId === undefined) return undefined;\n\n    // attach multiple related components\n    return [value, ...components.map(x => this.getEntity(entityId, x))]\n  }\n\n  /**\n   * @throws {ComponentNotRegistered} when the specified component is not registered \n   */\n  private getEntity<T>(entityId: number, component: ComponentClass<T>): T | undefined {\n    const map = this.componentMaps.get(component.name);\n    if (map === undefined) throw new ComponentNotRegistered(component.name)\n\n    return map.get(entityId);\n  }\n\n  /**\n   * Get multiple component values related to an entity\n   * \n   * @param entityId\n   * @param components: ComponentClass<any>[]\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // get one\n   * const player = ecs.get(entityId, PlayerComponent);\n   * \n   * // or get multiple\n   * const [player, position] = ecs.get(entityId, PlayerComponent, PositionComponent);\n   */\n  get<T extends ComponentClass<any>[]>(\n    entityId: number,\n    ...components: T\n  ): ComponentInstances<T> | undefined;\n  get<T extends Component>(entityId: number, ...components: ComponentClass<T>[]): T | (T | undefined)[] | undefined {\n    if (components.length > 1) return components.map(x => this.getEntity(entityId, x))\n\n    // return a single component\n    return this.getEntity(entityId, components[0])\n  }\n\n  /**\n   * Retrieves an entity from its registered entity map\n   *\n   * @throws {ComponentNotRegistered} when the specified component name is not registered\n   * \n   * @example\n   * const positionData = ecs.getByKey(entityId, \"PositionComponent\");\n   */\n  getByKey(entityId: number, componentName: string) {\n    // get the component map\n    const map = this.componentMaps.get(componentName);\n    if (map === undefined) throw new ComponentNotRegistered(componentName)\n\n    return map.get(entityId);\n  }\n\n  /**\n   * Check if a component exists for an entity\n   * \n   * @example\n   * const exists = ecs.has(entityId, PositionComponent);\n   */\n  has<T>(entityId: number, component: ComponentClass<T>): boolean {\n    // get the component map\n    const map = this.componentMaps.get(component.name);\n    if (map === undefined) return false\n\n    return map.has(entityId);\n  }\n\n  private setEntity<T extends Component>(entityId: number, componentData: T): T {\n    // get the component map\n    const map = this.componentMaps.get(componentData.constructor.name);\n    if (map === undefined) throw new ComponentNotRegistered(componentData.constructor.name)\n\n    // set the entity on the entity map\n    map.set(entityId, componentData);\n\n    // return instance\n    return componentData;\n  }\n\n  /**\n   * Add or update multiple component values for an entity\n   * \n   * @example\n   * \n   * // get one\n   * const player = ecs.set(entityId, new PlayerComponent());\n   * \n   * // or get multiple\n   * const [player, position] = ecs.set(\n   *   entityId,\n   *   new PlayerComponent(),\n   *   new PositionComponent()\n   * );\n   */\n  set<T extends Component>(entityId: number, component: T): T;\n  set<T extends Component[]>(entityId: number, ...components: T): T;\n  set(entityId: number, ...components: Component[]): Component | Component[] {\n    if (components.length > 1) return components.map(x => this.setEntity(entityId, x))\n\n    // set and return a single component\n    return this.setEntity(entityId, components[0])\n  }\n\n  /**\n   * Removes the specified component(s) from an entity\n   * \n   * @example\n   * ecs.remove(entityId, Components.PositionComponent);\n   */\n  remove<T extends ComponentClass<any>[]>(entityId: number, ...components: T) {\n    for (const component of components) {\n      this.removeByKey(entityId, component.name)\n    }\n  }\n\n  /**\n   * Removes the specified component from an entity\n   * \n   * @throws {ComponentNotRegistered} when the specified component is not registered\n   * \n   * @example\n   * ecs.removeByKey(entityId, \"PositionComponent\");\n   */\n  removeByKey(entityId: number, componentName: string) {\n    // get the entity map\n    const entityMap = this.componentMaps.get(componentName);\n\n    // ensure the map is defined\n    if (entityMap === undefined) throw new ComponentNotRegistered(componentName);\n\n    // get the entity\n    const entity = entityMap.get(entityId);\n    if (entity === undefined) return false;\n\n    // remove the entity from the entity map\n    return entityMap.delete(entityId);\n  }\n\n  /**\n   * Deletes an entity from all component maps\n   * \n   * @example\n   * ecs.destroyEntity(entityId);\n   */\n  destroyEntity(entityId: number) {\n    for (const map of this.componentMaps.values()) {\n      if (map.has(entityId)) map.delete(entityId);\n    }\n  }\n\n  // TODO generate a non repeatable id for network play?\n  getNextId() {\n    this.nextId++;\n    return this.nextId;\n  }\n\n  clear() {\n    this.componentMaps.clear();\n    return this;\n  }\n\n  /**\n   * Iterates over each component value that is related to the key component\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // iterate each component value that is related to the Components.Player entity\n   * const iterator = ecs.iterator(Components.Player, Components.Position)\n   * \n   * for(const [playerId, player, position] of iterator) {\n   * \n   * }\n   */\n  iterator<K extends ComponentClass<any>, T extends ComponentClass<any>[]>(\n    keyComponent: ComponentClass<any>,\n    ...components: T\n  ): ComponentIterator<K, T>;\n  iterator(keyComponent: ComponentClass<any>, ...components: ComponentClass<any>[]) {\n    return new ComponentIterator(this, keyComponent, ...components);\n  }\n\n  /**\n   * Prints all component maps in a tabular format to the console\n   */\n  printTable() {\n    this.componentMaps.forEach(map => console.table(map.toTable(true)));\n    return this;\n  }\n\n  /**\n   * Prints an entity component data in tabular format to the console\n   */\n  printEntity(entityId: number) {\n    for (const map of this.componentMaps.values()) {\n      if (map.has(entityId) === false) continue;\n\n      const data = map.get(entityId);\n      const columns = {\n        name: data.constructor.name,\n        ...data\n      };\n      console.table({ [entityId]: columns });\n    }\n\n    return this;\n  }\n\n  /**\n   * Parse's the JSON and returns an EntityMap object\n   * \n   * @example\n   * const json = JSON.stringfy(ecs);\n   * const restoredMap = ecs.parse(json);\n   */\n  static parse(json: string) {\n    const ecs = new EntityMap();\n\n    const restored = JSON.parse(json, function (key: string, value: any) {\n\n      if (value.hasOwnProperty('componentMaps')) {\n        Reflect.setPrototypeOf(value, EntityMap.prototype);\n        return value;\n      }\n\n      if (value.hasOwnProperty('__KeyMap__')) {\n        return new KeyMap(value.iterable);\n      }\n\n      return this[key];\n    });\n\n    ecs.componentMaps = restored.componentMaps;\n    ecs.nextId = restored.nextId;\n    return ecs;\n  }\n\n  /**\n   * A tracing method used for debugging.\n   * Intercepts all functions specified and logs each call to the console.\n   * \n   * @method createWithTracing\n   * @static\n   * @param {Array} funcFilter A list of function names you want to intercept. If no function names are specified then will log all functions called\n   * @return {EntityMap} A new entity map with tracing enabled\n   */\n  static createWithTracing(funcFilter: any) {\n    const traceHandler = {\n      get(target: any, propKey: string) {\n        const targetValue = target[propKey]\n\n        if (typeof targetValue === 'function' && (funcFilter.length === 0 || funcFilter.includes(propKey))) {\n          return function (this: any, ...args: any[]) {\n            console.groupCollapsed('ecs trace', propKey, args);\n            console.trace();\n            console.groupEnd();\n            return targetValue.apply(this, args);\n          }\n        }\n\n        return targetValue;\n      }\n    }\n\n    return new Proxy(new EntityMap(), traceHandler)\n  }\n\n}", "/*\n ecsjs is an entity component system library for JavaScript\n Copyright (C) 2014 Peter Flannery\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program.  If not, see <http://www.gnu.org/licenses/>.\n */\n\n/**\n * ### An entity component system library for JavaScript\n *\n * @module ecsjs\n * @main ecsjs\n */\nimport { EntityMap } from './entity-map.js'\nexport type { ComponentClass, ComponentClassesMap, ComponentClassMap } from './definitions.js'\nexport { EntityMap } from './entity-map.js'\nexport type { ComponentNotRegistered } from './errors.js'\nexport { ComponentIterator } from './iterators.js'\n\nexport const ecs = new EntityMap()\n\nif (typeof window !== 'undefined') {\n  // @ts-ignore: exports to window\n  window.ecs = ecs\n} else if (typeof module !== 'undefined' && module !== null) {\n  // exports to nodejs\n  module.exports = { ecs };\n}"],
-  "mappings": "AAAO,IAAMA,EAAN,cAAqC,KAAM,CAChD,YAAmBC,EAAuB,CACxC,MAAM,qCAAqCA,CAAa,GAAG,EAD1C,mBAAAA,CAEnB,CACF,ECDO,IAAMC,EAAN,KAGL,CAkBA,YAAmBC,EAAuBC,KAAWC,EAAe,CAAjD,SAAAF,EAAuB,SAAAC,EACxC,KAAK,OAAS,KAAK,IAAI,OAAOA,CAAG,EACjC,KAAK,QAAU,KAAK,OAAO,QAAQ,EACnC,KAAK,WAAaC,EAAW,IAAIC,GAAK,KAAK,IAAI,OAAOA,CAAC,CAAE,CAC3D,CApBQ,OACA,WAEA,QAmBR,MAA8E,CAC5E,IAAMC,EAAQ,KAAK,QAAQ,KAAK,EAC1B,CAAE,MAAAC,EAAO,KAAAC,CAAK,EAAIF,EACxB,GAAIE,EAAM,MAAO,CAAE,MAAOD,EAAc,KAAAC,CAAK,EAE7C,GAAM,CAACC,CAAQ,EAAIF,EACnB,QAAWF,KAAK,KAAK,WACnBE,EAAM,KAAKF,EAAE,IAAII,CAAQ,CAAC,EAG5B,MAAO,CAAE,MAAOF,EAAc,KAAMC,CAAgB,CACtD,CAKA,OAAQ,CACN,KAAK,QAAU,KAAK,OAAO,QAAQ,CACrC,CAEA,CAAC,OAAO,QAAQ,GAAI,CAAE,OAAO,IAAM,CAErC,EC9BO,IAAME,EAAN,cAAmC,GAAkB,CAE1D,YAAYC,EAAiB,CAAC,EAAG,CAC/B,MAAMA,CAAO,CACf,CAEA,YAAqD,CACnD,OAAI,KAAK,OAAS,EAAG,OAEJ,KAAK,QAAQ,EACN,KAAK,EACf,KAChB,CAEA,UAA6B,CAC3B,OAAI,KAAK,OAAS,EAAG,OAEJ,KAAK,KAAK,EACH,KAAK,EACf,KAChB,CAEA,YAAiC,CAC/B,OAAI,KAAK,OAAS,EAAG,OAEJ,KAAK,OAAO,EACL,KAAK,EACf,KAChB,CAEA,QAAS,CACP,MAAO,CAAE,WAAY,EAAG,SAAU,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAE,CACxD,CAEA,QAAQC,EAAc,GAAc,CAClC,IAAMC,EAAQ,CAAC,EACf,OAAW,CAACC,EAAKC,CAAK,IAAK,KAAK,QAAQ,EAAG,CACzC,IAAMC,EAASD,EACTE,EAA2B,CAAC,EAC9BL,GAAe,KAAOK,EAAK,YAAY,EAAIH,GAC/CG,EAAK,aAAa,EAAID,EAAO,YAAY,KACzCH,EAAM,KAAK,CAAE,GAAGI,EAAM,GAAGD,CAAO,CAAC,CACnC,CACA,OAAOH,CACT,CAKA,WAAWD,EAAc,GAAa,CACpC,QAAQ,MAAM,KAAK,QAAQA,CAAW,CAAC,CACzC,CAEA,SAAuC,CACrC,OAAO,MAAM,QAAQ,EAAE,OAAOM,GAAwBA,GAAM,IAAI,CAClE,CAEA,MAA0B,CACxB,OAAO,MAAM,KAAK,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CAC/D,CAEA,QAA8B,CAC5B,OAAO,MAAM,OAAO,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CACjE,CAEA,WAAY,OAAO,OAAO,GAAI,CAAE,OAAO,GAAK,CAE9C,ECpDO,IAAMC,EAAN,MAAMC,CAAU,CAGb,cAAqC,IAAIC,EAEzC,OAAiB,EAEzB,aAAc,CAAE,CAiBhB,YAAiDC,EAAyB,CACxE,QAAWC,KAAkBD,EAAkB,CAC7C,IAAME,EAAgBD,EAAe,KACrC,GAAIC,IAAkB,OACpB,MAAM,IAAI,eAAe,2EAA2E,EAGtG,IAAMC,EAA2C,IAAIJ,EACrD,KAAK,cAAc,IAAIG,EAAeC,CAAgB,CACxD,CAGA,OAAO,IACT,CAOA,OAAUC,EAAgE,CACxE,IAAMC,EAAM,KAAK,cAAc,IAAID,EAAU,IAAI,EACjD,GAAIC,IAAQ,OAAW,MAAM,IAAIC,EAAuBF,EAAU,IAAI,EACtE,OAAOC,CACT,CAUA,WAAcD,EAA8B,CAC1C,OAAO,KAAK,OAAOA,CAAS,GAAG,WAAW,CAC5C,CAsBA,SAASG,KAAsCC,EAAmC,CAChF,IAAMC,EAAW,KAAK,OAAOF,CAAY,GAAG,SAAS,EAGrD,GAAI,UAAU,SAAW,EAAG,OAAOE,EACnC,GAAIA,IAAa,OAGjB,MAAO,CAACA,EAAU,GAAGD,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,CAAC,CACvE,CAsBA,WAAWH,KAAsCC,EAAmC,CAElF,GAAI,UAAU,SAAW,EAAG,OAAO,KAAK,OAAOD,CAAY,GAAG,WAAW,EAGzE,GAAM,CAACE,EAAUE,CAAK,EAAI,KAAK,OAAOJ,CAAY,GAAG,WAAW,GAAK,CAAC,EACtE,GAAIE,IAAa,OAGjB,MAAO,CAACE,EAAO,GAAGH,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,CAAC,CACpE,CAKQ,UAAaD,EAAkBL,EAA6C,CAClF,IAAMC,EAAM,KAAK,cAAc,IAAID,EAAU,IAAI,EACjD,GAAIC,IAAQ,OAAW,MAAM,IAAIC,EAAuBF,EAAU,IAAI,EAEtE,OAAOC,EAAI,IAAII,CAAQ,CACzB,CAqBA,IAAyBA,KAAqBD,EAAoE,CAChH,OAAIA,EAAW,OAAS,EAAUA,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,EAG1E,KAAK,UAAUD,EAAUD,EAAW,CAAC,CAAC,CAC/C,CAUA,SAASC,EAAkBP,EAAuB,CAEhD,IAAMG,EAAM,KAAK,cAAc,IAAIH,CAAa,EAChD,GAAIG,IAAQ,OAAW,MAAM,IAAIC,EAAuBJ,CAAa,EAErE,OAAOG,EAAI,IAAII,CAAQ,CACzB,CAQA,IAAOA,EAAkBL,EAAuC,CAE9D,IAAMC,EAAM,KAAK,cAAc,IAAID,EAAU,IAAI,EACjD,OAAIC,IAAQ,OAAkB,GAEvBA,EAAI,IAAII,CAAQ,CACzB,CAEQ,UAA+BA,EAAkBG,EAAqB,CAE5E,IAAMP,EAAM,KAAK,cAAc,IAAIO,EAAc,YAAY,IAAI,EACjE,GAAIP,IAAQ,OAAW,MAAM,IAAIC,EAAuBM,EAAc,YAAY,IAAI,EAGtF,OAAAP,EAAI,IAAII,EAAUG,CAAa,EAGxBA,CACT,CAmBA,IAAIH,KAAqBD,EAAkD,CACzE,OAAIA,EAAW,OAAS,EAAUA,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,EAG1E,KAAK,UAAUD,EAAUD,EAAW,CAAC,CAAC,CAC/C,CAQA,OAAwCC,KAAqBD,EAAe,CAC1E,QAAWJ,KAAaI,EACtB,KAAK,YAAYC,EAAUL,EAAU,IAAI,CAE7C,CAUA,YAAYK,EAAkBP,EAAuB,CAEnD,IAAMW,EAAY,KAAK,cAAc,IAAIX,CAAa,EAGtD,GAAIW,IAAc,OAAW,MAAM,IAAIP,EAAuBJ,CAAa,EAI3E,OADeW,EAAU,IAAIJ,CAAQ,IACtB,OAAkB,GAG1BI,EAAU,OAAOJ,CAAQ,CAClC,CAQA,cAAcA,EAAkB,CAC9B,QAAWJ,KAAO,KAAK,cAAc,OAAO,EACtCA,EAAI,IAAII,CAAQ,GAAGJ,EAAI,OAAOI,CAAQ,CAE9C,CAGA,WAAY,CACV,YAAK,SACE,KAAK,MACd,CAEA,OAAQ,CACN,YAAK,cAAc,MAAM,EAClB,IACT,CAmBA,SAASF,KAAsCC,EAAmC,CAChF,OAAO,IAAIM,EAAkB,KAAMP,EAAc,GAAGC,CAAU,CAChE,CAKA,YAAa,CACX,YAAK,cAAc,QAAQH,GAAO,QAAQ,MAAMA,EAAI,QAAQ,EAAI,CAAC,CAAC,EAC3D,IACT,CAKA,YAAYI,EAAkB,CAC5B,QAAWJ,KAAO,KAAK,cAAc,OAAO,EAAG,CAC7C,GAAIA,EAAI,IAAII,CAAQ,IAAM,GAAO,SAEjC,IAAMM,EAAOV,EAAI,IAAII,CAAQ,EACvBO,EAAU,CACd,KAAMD,EAAK,YAAY,KACvB,GAAGA,CACL,EACA,QAAQ,MAAM,CAAE,CAACN,CAAQ,EAAGO,CAAQ,CAAC,CACvC,CAEA,OAAO,IACT,CASA,OAAO,MAAMC,EAAc,CACzB,IAAMC,EAAM,IAAIpB,EAEVqB,EAAW,KAAK,MAAMF,EAAM,SAAUG,EAAaT,EAAY,CAEnE,OAAIA,EAAM,eAAe,eAAe,GACtC,QAAQ,eAAeA,EAAOb,EAAU,SAAS,EAC1Ca,GAGLA,EAAM,eAAe,YAAY,EAC5B,IAAIZ,EAAOY,EAAM,QAAQ,EAG3B,KAAKS,CAAG,CACjB,CAAC,EAED,OAAAF,EAAI,cAAgBC,EAAS,cAC7BD,EAAI,OAASC,EAAS,OACfD,CACT,CAWA,OAAO,kBAAkBG,EAAiB,CACxC,IAAMC,EAAe,CACnB,IAAIC,EAAaC,EAAiB,CAChC,IAAMC,EAAcF,EAAOC,CAAO,EAElC,OAAI,OAAOC,GAAgB,aAAeJ,EAAW,SAAW,GAAKA,EAAW,SAASG,CAAO,GACvF,YAAwBE,EAAa,CAC1C,eAAQ,eAAe,YAAaF,EAASE,CAAI,EACjD,QAAQ,MAAM,EACd,QAAQ,SAAS,EACVD,EAAY,MAAM,KAAMC,CAAI,CACrC,EAGKD,CACT,CACF,EAEA,OAAO,IAAI,MAAM,IAAI3B,EAAawB,CAAY,CAChD,CAEF,EC9YO,IAAMK,EAAM,IAAIC,EAEnB,OAAO,OAAW,IAEpB,OAAO,IAAMD,EACJ,OAAO,OAAW,KAAe,SAAW,OAErD,OAAO,QAAU,CAAE,IAAAA,CAAI",
-  "names": ["ComponentNotRegistered", "componentName", "ComponentIterator", "ecs", "key", "components", "x", "entry", "value", "done", "entityId", "KeyMap", "entries", "excludeKeys", "table", "key", "value", "entity", "meta", "x", "EntityMap", "_EntityMap", "KeyMap", "componentClasses", "componentClass", "componentName", "componentDataMap", "component", "map", "ComponentNotRegistered", "keyComponent", "components", "entityId", "x", "value", "componentData", "entityMap", "ComponentIterator", "data", "columns", "json", "ecs", "restored", "key", "funcFilter", "traceHandler", "target", "propKey", "targetValue", "args", "ecs", "EntityMap"]
+  "sourcesContent": ["export class ComponentNotRegistered extends Error {\n  constructor(public componentName: string) {\n    super(`Component map does not exist for '${componentName}'`);\n  }\n}", "import type {\n  ComponentClass,\n  ComponentClassMap,\n  ComponentInstances,\n  IteratorResult\n} from './definitions.js';\nimport type { EntityMap } from './entity-map.js';\n\nexport class ComponentIterator<\n  K extends ComponentClass<any>,\n  T extends ComponentClass<any>[]\n> {\n\n  private keyMap: ComponentClassMap<any>\n  private components: ComponentClassMap<any>[]\n  // iteration state\n  private entries: MapIterator<[number, K]>\n\n  /**\n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // iterate each component value that is related to the Components.Player entity\n   * const iterator = new ComponentIterator(ecs, Components.Player, Components.Position)\n   * \n   * for(const [playerId, player, position] of iterator) {\n   * \n   * }\n   */\n  constructor(public ecs: EntityMap, public key: K, ...components: T) {\n    this.keyMap = this.ecs.getMap(key)!;\n    this.entries = this.keyMap.entries();\n    this.components = components.map(x => this.ecs.getMap(x)!);\n  }\n\n  next(): IteratorResult<ComponentInstances<[ComponentClass<number>, K, ...T]>> {\n    const entry = this.entries.next();\n    const { value, done } = entry;\n    if (done) return { value: value as any, done };\n\n    const [entityId, entityValue] = value;\n    const results = [entityId, entityValue]\n    for (const x of this.components) {\n      results.push(x.get(entityId));\n    }\n\n    return { value: results as any, done: false };\n  }\n\n  /**\n   * reset the iterator back to the first entry\n   */\n  reset() {\n    this.entries = this.keyMap.entries();\n  }\n\n  [Symbol.iterator]() { return this; }\n\n}", "/*\n ecsjs is an entity component system library for JavaScript\n Copyright (C) 2014 Peter Flannery\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program.  If not, see <http://www.gnu.org/licenses/>.\n */\nimport type { KeyCollection } from './definitions.js';\n\n/**\n * Class for storing keys and values\n */\nexport class KeyMap<TKey, TValue> extends Map<TKey, TValue> {\n\n  constructor(entries: any[] = []) {\n    super(entries)\n  }\n\n  firstEntry(): [key: TKey, value: TValue] | undefined {\n    if (this.size === 0) return undefined;\n\n    const iterator = this.entries();\n    const result = iterator.next();\n    return result.value;\n  }\n\n  firstKey(): TKey | undefined {\n    if (this.size === 0) return undefined;\n\n    const iterator = this.keys();\n    const result = iterator.next();\n    return result.value;\n  }\n\n  firstValue(): TValue | undefined {\n    if (this.size === 0) return undefined;\n\n    const iterator = this.values();\n    const result = iterator.next();\n    return result.value;\n  }\n\n  toJSON() {\n    return { __KeyMap__: 1, iterable: [...this.entries()] }\n  }\n\n  toTable(excludeKeys = false): any[] {\n    const table = []\n    for (const [key, value] of this.entries()) {\n      const entity = value as { new(): TValue }\n      const meta: KeyCollection<any> = {}\n      if (excludeKeys == false) meta[\"entity.key\"] = key\n      meta[\"entity.type\"] = entity.constructor.name\n      table.push({ ...meta, ...entity })\n    }\n    return table\n  }\n\n  /**\n   * Outputs keys and values in a tabular format to the console\n   */\n  printTable(excludeKeys = false): void {\n    console.table(this.toTable(excludeKeys))\n  }\n\n  entries(): MapIterator<[TKey, TValue]> {\n    return super.entries().filter(x => x !== undefined && x !== null)\n  }\n\n  keys(): MapIterator<TKey> {\n    return super.keys().filter(x => x !== undefined && x !== null)\n  }\n\n  values(): MapIterator<TValue> {\n    return super.values().filter(x => x !== undefined && x !== null)\n  }\n\n  static get [Symbol.species]() { return Map; }\n\n}", "/*\n ecsjs is an entity component system library for JavaScript\n Copyright (C) 2014 Peter Flannery\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program.  If not, see <http://www.gnu.org/licenses/>.\n */\n\n/**\n * @module ecsjs\n */\nimport {\n  type Component,\n  type ComponentClass,\n  type ComponentClassesMap,\n  type ComponentClassMap,\n  type ComponentInstances\n} from './definitions.js';\nimport { ComponentNotRegistered } from './errors.js';\nimport { ComponentIterator } from './iterators.js';\nimport { KeyMap } from './key-map.js';\n\n/**\n * Class for storing entities and their relationships\n * \n * @class EntityMap\n */\nexport class EntityMap {\n\n  // entity class maps\n  private componentMaps: ComponentClassesMap = new KeyMap()\n\n  private nextId: number = 0\n\n  constructor() { }\n\n  /**\n   * Registers component classes\n   * \n   * @example\n   * // component class\n   * class MyComponent {\n   *   constructor(x) {\n   *     this.x = x;\n   *   }\n   * }\n   *\n   * ecs.register(MyComponent);\n   * // or\n   * ecs.register(MyComponent1, MyComponent2);\n   */\n  register<TArgs extends ComponentClass<any>[]>(...componentClasses: TArgs) {\n    for (const componentClass of componentClasses) {\n      const componentName = componentClass.name;\n      if (componentName === undefined)\n        throw new ReferenceError(\"The component class does not have a name defined. i.e. a constructor name\");\n\n      // create the component map\n      const componentDataMap: ComponentClassMap<any> = new KeyMap();\n      this.componentMaps.set(componentName, componentDataMap);\n    }\n\n    // chain\n    return this;\n  }\n\n  /**\n   * Get a component class map\n   * \n   * @throws {ComponentNotRegistered} when the specified component is not registered\n   */\n  getMap<T>(component: ComponentClass<T>): ComponentClassMap<T> | undefined {\n    const map = this.componentMaps.get(component.name);\n    if (map === undefined) throw new ComponentNotRegistered(component.name)\n    return map\n  }\n\n  /**\n   * Get the first entity entry for a component class\n   * \n   * @throws {ComponentNotRegistered} when the specified component is not registered\n   * \n   * @example\n   * const [entityId, player] = ecs.firstEntry(PlayerComponent) ?? [];\n   */\n  firstEntry<T>(component: ComponentClass<T>) {\n    return this.getMap(component)?.firstEntry();\n  }\n\n  /**\n   * Get the first entity id for a component class\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // return the first component id\n   * const entityId = ecs.firstKey(PlayerComponent);\n   * \n   * // or multiple related values in addition to the first component id\n   * const [entityId, position, direction] = ecs.firstKey(\n   *   PlayerComponent,\n   *   PositionComponent,\n   *   DirectionComponent\n   * ) ?? [];\n   */\n  firstKey<TKey extends ComponentClass<any>, T extends ComponentClass<any>[]>(\n    keyComponent: TKey,\n    ...components: T\n  ): ComponentInstances<[ComponentClass<number>, ...T]> | undefined;\n  firstKey(keyComponent: ComponentClass<any>, ...components: ComponentClass<any>[]) {\n    const entityId = this.getMap(keyComponent)?.firstKey();\n\n    // single component key\n    if (arguments.length === 1) return entityId;\n    if (entityId === undefined) return undefined;\n\n    // attach multiple related component values\n    return [entityId, ...components.map(x => this.getEntity(entityId, x))];\n  }\n\n  /**\n   * Get the first entity component value for a component class\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // return the first component value\n   * const player = ecs.firstValue(PlayerComponent);\n   * \n   * // or multiple related values in addition to the first component\n   * const [player, position, direction] = ecs.firstValue(\n   *   PlayerComponent,\n   *   PositionComponent,\n   *   DirectionComponent\n   * );\n   */\n  firstValue<TKey extends ComponentClass<any>, T extends ComponentClass<any>[]>(\n    keyComponent: TKey,\n    ...components: T\n  ): ComponentInstances<[TKey, ...T]> | undefined;\n  firstValue(keyComponent: ComponentClass<any>, ...components: ComponentClass<any>[]) {\n    // single component\n    if (arguments.length === 1) return this.getMap(keyComponent)?.firstValue();\n\n    // get the first entry\n    const [entityId, value] = this.getMap(keyComponent)?.firstEntry() ?? [];\n    if (entityId === undefined) return undefined;\n\n    // attach multiple related components\n    return [value, ...components.map(x => this.getEntity(entityId, x))]\n  }\n\n  /**\n   * @throws {ComponentNotRegistered} when the specified component is not registered \n   */\n  private getEntity<T>(entityId: number, component: ComponentClass<T>): T | undefined {\n    const map = this.componentMaps.get(component.name);\n    if (map === undefined) throw new ComponentNotRegistered(component.name)\n\n    return map.get(entityId);\n  }\n\n  /**\n   * Get multiple component values related to an entity\n   * \n   * @param entityId\n   * @param components: ComponentClass<any>[]\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // get one\n   * const player = ecs.get(entityId, PlayerComponent);\n   * \n   * // or get multiple\n   * const [player, position] = ecs.get(entityId, PlayerComponent, PositionComponent);\n   */\n  get<T extends ComponentClass<any>[]>(\n    entityId: number,\n    ...components: T\n  ): ComponentInstances<T> | undefined;\n  get<T extends Component>(entityId: number, ...components: ComponentClass<T>[]): T | (T | undefined)[] | undefined {\n    if (components.length > 1) return components.map(x => this.getEntity(entityId, x))\n\n    // return a single component\n    return this.getEntity(entityId, components[0])\n  }\n\n  /**\n   * Retrieves an entity from its registered entity map\n   *\n   * @throws {ComponentNotRegistered} when the specified component name is not registered\n   * \n   * @example\n   * const positionData = ecs.getByKey(entityId, \"PositionComponent\");\n   */\n  getByKey(entityId: number, componentName: string) {\n    // get the component map\n    const map = this.componentMaps.get(componentName);\n    if (map === undefined) throw new ComponentNotRegistered(componentName)\n\n    return map.get(entityId);\n  }\n\n  /**\n   * Check if a component exists for an entity\n   * \n   * @example\n   * const exists = ecs.has(entityId, PositionComponent);\n   */\n  has<T>(entityId: number, component: ComponentClass<T>): boolean {\n    // get the component map\n    const map = this.componentMaps.get(component.name);\n    if (map === undefined) return false\n\n    return map.has(entityId);\n  }\n\n  private setEntity<T extends Component>(entityId: number, componentData: T): T {\n    // get the component map\n    const map = this.componentMaps.get(componentData.constructor.name);\n    if (map === undefined) throw new ComponentNotRegistered(componentData.constructor.name)\n\n    // set the entity on the entity map\n    map.set(entityId, componentData);\n\n    // return instance\n    return componentData;\n  }\n\n  /**\n   * Add or update multiple component values for an entity\n   * \n   * @example\n   * \n   * // get one\n   * const player = ecs.set(entityId, new PlayerComponent());\n   * \n   * // or get multiple\n   * const [player, position] = ecs.set(\n   *   entityId,\n   *   new PlayerComponent(),\n   *   new PositionComponent()\n   * );\n   */\n  set<T extends Component>(entityId: number, component: T): T;\n  set<T extends Component[]>(entityId: number, ...components: T): T;\n  set(entityId: number, ...components: Component[]): Component | Component[] {\n    if (components.length > 1) return components.map(x => this.setEntity(entityId, x))\n\n    // set and return a single component\n    return this.setEntity(entityId, components[0])\n  }\n\n  /**\n   * Removes the specified component(s) from an entity\n   * \n   * @example\n   * ecs.remove(entityId, Components.PositionComponent);\n   */\n  remove<T extends ComponentClass<any>[]>(entityId: number, ...components: T) {\n    for (const component of components) {\n      this.removeByKey(entityId, component.name)\n    }\n  }\n\n  /**\n   * Removes the specified component from an entity\n   * \n   * @throws {ComponentNotRegistered} when the specified component is not registered\n   * \n   * @example\n   * ecs.removeByKey(entityId, \"PositionComponent\");\n   */\n  removeByKey(entityId: number, componentName: string) {\n    // get the entity map\n    const entityMap = this.componentMaps.get(componentName);\n\n    // ensure the map is defined\n    if (entityMap === undefined) throw new ComponentNotRegistered(componentName);\n\n    // get the entity\n    const entity = entityMap.get(entityId);\n    if (entity === undefined) return false;\n\n    // remove the entity from the entity map\n    return entityMap.delete(entityId);\n  }\n\n  /**\n   * Deletes an entity from all component maps\n   * \n   * @example\n   * ecs.destroyEntity(entityId);\n   */\n  destroyEntity(entityId: number) {\n    for (const map of this.componentMaps.values()) {\n      if (map.has(entityId)) map.delete(entityId);\n    }\n  }\n\n  // TODO generate a non repeatable id for network play?\n  getNextId() {\n    this.nextId++;\n    return this.nextId;\n  }\n\n  clear() {\n    this.componentMaps.clear();\n    return this;\n  }\n\n  /**\n   * Iterates over each component value that is related to the key component\n   * \n   * @throws {ComponentNotRegistered} when any of specified component(s) are not registered\n   * \n   * @example\n   * // iterate each component value that is related to the Components.Player entity\n   * const iterator = ecs.iterator(Components.Player, Components.Position)\n   * \n   * for(const [playerId, player, position] of iterator) {\n   * \n   * }\n   * \n   * // you can declare the type of iterator before it's assigned\n   * let iterator: IComponentIterator<[Components.Player, Components.Position]>\n   * \n   * // then with late bound assignment (keeping the iterator intellisense)\n   * iterator = ecs.iterator(Components.Player, Components.Position)\n   * \n   * for(const [playerId, player, position] of iterator) {\n   *    const moving = player.isMoving\n   * }\n   */\n  iterator<K extends ComponentClass<any>, T extends ComponentClass<any>[]>(\n    keyComponent: K,\n    ...components: T\n  ): ComponentIterator<K, T>\n  iterator(keyComponent: ComponentClass<any>, ...components: ComponentClass<any>[]) {\n    return new ComponentIterator(this, keyComponent, ...components) as any;\n  }\n\n  /**\n   * Prints all component maps in a tabular format to the console\n   */\n  printTable() {\n    this.componentMaps.forEach(map => console.table(map.toTable(true)));\n    return this;\n  }\n\n  /**\n   * Prints an entity component data in tabular format to the console\n   */\n  printEntity(entityId: number) {\n    for (const map of this.componentMaps.values()) {\n      if (map.has(entityId) === false) continue;\n\n      const data = map.get(entityId);\n      const columns = {\n        name: data.constructor.name,\n        ...data\n      };\n      console.table({ [entityId]: columns });\n    }\n\n    return this;\n  }\n\n  /**\n   * Parse's the JSON and returns an EntityMap object\n   * \n   * @example\n   * const json = JSON.stringfy(ecs);\n   * const restoredMap = ecs.parse(json);\n   */\n  static parse(json: string) {\n    const ecs = new EntityMap();\n\n    const restored = JSON.parse(json, function (key: string, value: any) {\n\n      if (value.hasOwnProperty('componentMaps')) {\n        Reflect.setPrototypeOf(value, EntityMap.prototype);\n        return value;\n      }\n\n      if (value.hasOwnProperty('__KeyMap__')) {\n        return new KeyMap(value.iterable);\n      }\n\n      return this[key];\n    });\n\n    ecs.componentMaps = restored.componentMaps;\n    ecs.nextId = restored.nextId;\n    return ecs;\n  }\n\n  /**\n   * A tracing method used for debugging.\n   * Intercepts all functions specified and logs each call to the console.\n   * \n   * @method createWithTracing\n   * @static\n   * @param {Array} funcFilter A list of function names you want to intercept. If no function names are specified then will log all functions called\n   * @return {EntityMap} A new entity map with tracing enabled\n   */\n  static createWithTracing(funcFilter: any) {\n    const traceHandler = {\n      get(target: any, propKey: string) {\n        const targetValue = target[propKey]\n\n        if (typeof targetValue === 'function' && (funcFilter.length === 0 || funcFilter.includes(propKey))) {\n          return function (this: any, ...args: any[]) {\n            console.groupCollapsed('ecs trace', propKey, args);\n            console.trace();\n            console.groupEnd();\n            return targetValue.apply(this, args);\n          }\n        }\n\n        return targetValue;\n      }\n    }\n\n    return new Proxy(new EntityMap(), traceHandler)\n  }\n\n}", "/*\n ecsjs is an entity component system library for JavaScript\n Copyright (C) 2014 Peter Flannery\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program.  If not, see <http://www.gnu.org/licenses/>.\n */\n\n/**\n * ### An entity component system library for JavaScript\n *\n * @module ecsjs\n * @main ecsjs\n */\nimport { EntityMap } from './entity-map.js'\nexport type { ComponentClass, ComponentClassesMap, ComponentClassMap, IComponentIterator } from './definitions.js'\nexport { EntityMap } from './entity-map.js'\nexport type { ComponentNotRegistered } from './errors.js'\nexport { ComponentIterator } from './iterators.js'\n\nexport const ecs = new EntityMap()\n\nif (typeof window !== 'undefined') {\n  // @ts-ignore: exports to window\n  window.ecs = ecs\n} else if (typeof module !== 'undefined' && module !== null) {\n  // exports to nodejs\n  module.exports = { ecs };\n}"],
+  "mappings": "AAAO,IAAMA,EAAN,cAAqC,KAAM,CAChD,YAAmBC,EAAuB,CACxC,MAAM,qCAAqCA,CAAa,GAAG,EAD1C,mBAAAA,CAEnB,CACF,ECIO,IAAMC,EAAN,KAGL,CAkBA,YAAmBC,EAAuBC,KAAWC,EAAe,CAAjD,SAAAF,EAAuB,SAAAC,EACxC,KAAK,OAAS,KAAK,IAAI,OAAOA,CAAG,EACjC,KAAK,QAAU,KAAK,OAAO,QAAQ,EACnC,KAAK,WAAaC,EAAW,IAAIC,GAAK,KAAK,IAAI,OAAOA,CAAC,CAAE,CAC3D,CApBQ,OACA,WAEA,QAmBR,MAA8E,CAC5E,IAAMC,EAAQ,KAAK,QAAQ,KAAK,EAC1B,CAAE,MAAAC,EAAO,KAAAC,CAAK,EAAIF,EACxB,GAAIE,EAAM,MAAO,CAAE,MAAOD,EAAc,KAAAC,CAAK,EAE7C,GAAM,CAACC,EAAUC,CAAW,EAAIH,EAC1BI,EAAU,CAACF,EAAUC,CAAW,EACtC,QAAWL,KAAK,KAAK,WACnBM,EAAQ,KAAKN,EAAE,IAAII,CAAQ,CAAC,EAG9B,MAAO,CAAE,MAAOE,EAAgB,KAAM,EAAM,CAC9C,CAKA,OAAQ,CACN,KAAK,QAAU,KAAK,OAAO,QAAQ,CACrC,CAEA,CAAC,OAAO,QAAQ,GAAI,CAAE,OAAO,IAAM,CAErC,ECpCO,IAAMC,EAAN,cAAmC,GAAkB,CAE1D,YAAYC,EAAiB,CAAC,EAAG,CAC/B,MAAMA,CAAO,CACf,CAEA,YAAqD,CACnD,OAAI,KAAK,OAAS,EAAG,OAEJ,KAAK,QAAQ,EACN,KAAK,EACf,KAChB,CAEA,UAA6B,CAC3B,OAAI,KAAK,OAAS,EAAG,OAEJ,KAAK,KAAK,EACH,KAAK,EACf,KAChB,CAEA,YAAiC,CAC/B,OAAI,KAAK,OAAS,EAAG,OAEJ,KAAK,OAAO,EACL,KAAK,EACf,KAChB,CAEA,QAAS,CACP,MAAO,CAAE,WAAY,EAAG,SAAU,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAE,CACxD,CAEA,QAAQC,EAAc,GAAc,CAClC,IAAMC,EAAQ,CAAC,EACf,OAAW,CAACC,EAAKC,CAAK,IAAK,KAAK,QAAQ,EAAG,CACzC,IAAMC,EAASD,EACTE,EAA2B,CAAC,EAC9BL,GAAe,KAAOK,EAAK,YAAY,EAAIH,GAC/CG,EAAK,aAAa,EAAID,EAAO,YAAY,KACzCH,EAAM,KAAK,CAAE,GAAGI,EAAM,GAAGD,CAAO,CAAC,CACnC,CACA,OAAOH,CACT,CAKA,WAAWD,EAAc,GAAa,CACpC,QAAQ,MAAM,KAAK,QAAQA,CAAW,CAAC,CACzC,CAEA,SAAuC,CACrC,OAAO,MAAM,QAAQ,EAAE,OAAOM,GAAwBA,GAAM,IAAI,CAClE,CAEA,MAA0B,CACxB,OAAO,MAAM,KAAK,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CAC/D,CAEA,QAA8B,CAC5B,OAAO,MAAM,OAAO,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CACjE,CAEA,WAAY,OAAO,OAAO,GAAI,CAAE,OAAO,GAAK,CAE9C,ECpDO,IAAMC,EAAN,MAAMC,CAAU,CAGb,cAAqC,IAAIC,EAEzC,OAAiB,EAEzB,aAAc,CAAE,CAiBhB,YAAiDC,EAAyB,CACxE,QAAWC,KAAkBD,EAAkB,CAC7C,IAAME,EAAgBD,EAAe,KACrC,GAAIC,IAAkB,OACpB,MAAM,IAAI,eAAe,2EAA2E,EAGtG,IAAMC,EAA2C,IAAIJ,EACrD,KAAK,cAAc,IAAIG,EAAeC,CAAgB,CACxD,CAGA,OAAO,IACT,CAOA,OAAUC,EAAgE,CACxE,IAAMC,EAAM,KAAK,cAAc,IAAID,EAAU,IAAI,EACjD,GAAIC,IAAQ,OAAW,MAAM,IAAIC,EAAuBF,EAAU,IAAI,EACtE,OAAOC,CACT,CAUA,WAAcD,EAA8B,CAC1C,OAAO,KAAK,OAAOA,CAAS,GAAG,WAAW,CAC5C,CAsBA,SAASG,KAAsCC,EAAmC,CAChF,IAAMC,EAAW,KAAK,OAAOF,CAAY,GAAG,SAAS,EAGrD,GAAI,UAAU,SAAW,EAAG,OAAOE,EACnC,GAAIA,IAAa,OAGjB,MAAO,CAACA,EAAU,GAAGD,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,CAAC,CACvE,CAsBA,WAAWH,KAAsCC,EAAmC,CAElF,GAAI,UAAU,SAAW,EAAG,OAAO,KAAK,OAAOD,CAAY,GAAG,WAAW,EAGzE,GAAM,CAACE,EAAUE,CAAK,EAAI,KAAK,OAAOJ,CAAY,GAAG,WAAW,GAAK,CAAC,EACtE,GAAIE,IAAa,OAGjB,MAAO,CAACE,EAAO,GAAGH,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,CAAC,CACpE,CAKQ,UAAaD,EAAkBL,EAA6C,CAClF,IAAMC,EAAM,KAAK,cAAc,IAAID,EAAU,IAAI,EACjD,GAAIC,IAAQ,OAAW,MAAM,IAAIC,EAAuBF,EAAU,IAAI,EAEtE,OAAOC,EAAI,IAAII,CAAQ,CACzB,CAqBA,IAAyBA,KAAqBD,EAAoE,CAChH,OAAIA,EAAW,OAAS,EAAUA,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,EAG1E,KAAK,UAAUD,EAAUD,EAAW,CAAC,CAAC,CAC/C,CAUA,SAASC,EAAkBP,EAAuB,CAEhD,IAAMG,EAAM,KAAK,cAAc,IAAIH,CAAa,EAChD,GAAIG,IAAQ,OAAW,MAAM,IAAIC,EAAuBJ,CAAa,EAErE,OAAOG,EAAI,IAAII,CAAQ,CACzB,CAQA,IAAOA,EAAkBL,EAAuC,CAE9D,IAAMC,EAAM,KAAK,cAAc,IAAID,EAAU,IAAI,EACjD,OAAIC,IAAQ,OAAkB,GAEvBA,EAAI,IAAII,CAAQ,CACzB,CAEQ,UAA+BA,EAAkBG,EAAqB,CAE5E,IAAMP,EAAM,KAAK,cAAc,IAAIO,EAAc,YAAY,IAAI,EACjE,GAAIP,IAAQ,OAAW,MAAM,IAAIC,EAAuBM,EAAc,YAAY,IAAI,EAGtF,OAAAP,EAAI,IAAII,EAAUG,CAAa,EAGxBA,CACT,CAmBA,IAAIH,KAAqBD,EAAkD,CACzE,OAAIA,EAAW,OAAS,EAAUA,EAAW,IAAIE,GAAK,KAAK,UAAUD,EAAUC,CAAC,CAAC,EAG1E,KAAK,UAAUD,EAAUD,EAAW,CAAC,CAAC,CAC/C,CAQA,OAAwCC,KAAqBD,EAAe,CAC1E,QAAWJ,KAAaI,EACtB,KAAK,YAAYC,EAAUL,EAAU,IAAI,CAE7C,CAUA,YAAYK,EAAkBP,EAAuB,CAEnD,IAAMW,EAAY,KAAK,cAAc,IAAIX,CAAa,EAGtD,GAAIW,IAAc,OAAW,MAAM,IAAIP,EAAuBJ,CAAa,EAI3E,OADeW,EAAU,IAAIJ,CAAQ,IACtB,OAAkB,GAG1BI,EAAU,OAAOJ,CAAQ,CAClC,CAQA,cAAcA,EAAkB,CAC9B,QAAWJ,KAAO,KAAK,cAAc,OAAO,EACtCA,EAAI,IAAII,CAAQ,GAAGJ,EAAI,OAAOI,CAAQ,CAE9C,CAGA,WAAY,CACV,YAAK,SACE,KAAK,MACd,CAEA,OAAQ,CACN,YAAK,cAAc,MAAM,EAClB,IACT,CA6BA,SAASF,KAAsCC,EAAmC,CAChF,OAAO,IAAIM,EAAkB,KAAMP,EAAc,GAAGC,CAAU,CAChE,CAKA,YAAa,CACX,YAAK,cAAc,QAAQH,GAAO,QAAQ,MAAMA,EAAI,QAAQ,EAAI,CAAC,CAAC,EAC3D,IACT,CAKA,YAAYI,EAAkB,CAC5B,QAAWJ,KAAO,KAAK,cAAc,OAAO,EAAG,CAC7C,GAAIA,EAAI,IAAII,CAAQ,IAAM,GAAO,SAEjC,IAAMM,EAAOV,EAAI,IAAII,CAAQ,EACvBO,EAAU,CACd,KAAMD,EAAK,YAAY,KACvB,GAAGA,CACL,EACA,QAAQ,MAAM,CAAE,CAACN,CAAQ,EAAGO,CAAQ,CAAC,CACvC,CAEA,OAAO,IACT,CASA,OAAO,MAAMC,EAAc,CACzB,IAAMC,EAAM,IAAIpB,EAEVqB,EAAW,KAAK,MAAMF,EAAM,SAAUG,EAAaT,EAAY,CAEnE,OAAIA,EAAM,eAAe,eAAe,GACtC,QAAQ,eAAeA,EAAOb,EAAU,SAAS,EAC1Ca,GAGLA,EAAM,eAAe,YAAY,EAC5B,IAAIZ,EAAOY,EAAM,QAAQ,EAG3B,KAAKS,CAAG,CACjB,CAAC,EAED,OAAAF,EAAI,cAAgBC,EAAS,cAC7BD,EAAI,OAASC,EAAS,OACfD,CACT,CAWA,OAAO,kBAAkBG,EAAiB,CACxC,IAAMC,EAAe,CACnB,IAAIC,EAAaC,EAAiB,CAChC,IAAMC,EAAcF,EAAOC,CAAO,EAElC,OAAI,OAAOC,GAAgB,aAAeJ,EAAW,SAAW,GAAKA,EAAW,SAASG,CAAO,GACvF,YAAwBE,EAAa,CAC1C,eAAQ,eAAe,YAAaF,EAASE,CAAI,EACjD,QAAQ,MAAM,EACd,QAAQ,SAAS,EACVD,EAAY,MAAM,KAAMC,CAAI,CACrC,EAGKD,CACT,CACF,EAEA,OAAO,IAAI,MAAM,IAAI3B,EAAawB,CAAY,CAChD,CAEF,ECxZO,IAAMK,EAAM,IAAIC,EAEnB,OAAO,OAAW,IAEpB,OAAO,IAAMD,EACJ,OAAO,OAAW,KAAe,SAAW,OAErD,OAAO,QAAU,CAAE,IAAAA,CAAI",
+  "names": ["ComponentNotRegistered", "componentName", "ComponentIterator", "ecs", "key", "components", "x", "entry", "value", "done", "entityId", "entityValue", "results", "KeyMap", "entries", "excludeKeys", "table", "key", "value", "entity", "meta", "x", "EntityMap", "_EntityMap", "KeyMap", "componentClasses", "componentClass", "componentName", "componentDataMap", "component", "map", "ComponentNotRegistered", "keyComponent", "components", "entityId", "x", "value", "componentData", "entityMap", "ComponentIterator", "data", "columns", "json", "ecs", "restored", "key", "funcFilter", "traceHandler", "target", "propKey", "targetValue", "args", "ecs", "EntityMap"]
 }

package/dist/types/src/definitions.d.ts

@@ -5,9 +5,28 @@ export type KeyCollection<T> = {
 export interface Component {
 }
 export type ComponentClass<ComponentInstance> = new (...args: any[]) => ComponentInstance;
+/**
+* Used for infering generic type spread for classes
+*/
+export type ComponentClasses<TClasses extends Component[]> = TClasses['length'] extends 1 ? TClasses[0] : {
+    [Index in keyof TClasses]: TClasses[Index];
+};
+/**
+ * Used for infering generic type spread for class instances
+ */
 export type ComponentInstances<TClasses extends ComponentClass<any>[]> = TClasses['length'] extends 1 ? TClasses[0] extends ComponentClass<infer R> ? R : never : {
     [Index in keyof TClasses]: TClasses[Index] extends ComponentClass<infer R> ? R : never;
 };
 export type ComponentClassMap<T> = KeyMap<number, T>;
 export type ComponentClassesMap = KeyMap<string, ComponentClassMap<any>>;
+export type IteratorResult<T> = {
+    done: boolean;
+    value: T;
+};
+export type Iterator<T> = {
+    next: () => IteratorResult<T>;
+    reset: () => void;
+    [Symbol.iterator]: () => Iterator<T>;
+};
+export type IComponentIterator<T extends Component[]> = Iterator<ComponentClasses<[number, ...T]>>;
 //# sourceMappingURL=definitions.d.ts.map

package/dist/types/src/definitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../../src/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE1C,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,CAAA;AAEnD,MAAM,WAAW,SAAS;CAAI;AAE9B,MAAM,MAAM,cAAc,CAAC,iBAAiB,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,iBAAiB,CAAA;AAEzF,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,IAEnE,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAEpF;KACC,KAAK,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CACvF,CAAA;AAEH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AAEpD,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAA"}
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../../src/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE1C,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,CAAA;AAEnD,MAAM,WAAW,SAAS;CAAI;AAE9B,MAAM,MAAM,cAAc,CAAC,iBAAiB,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,iBAAiB,CAAA;AAEzF;;EAEE;AACF,MAAM,MAAM,gBAAgB,CAAC,QAAQ,SAAS,SAAS,EAAE,IAEvD,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAExC;KACC,KAAK,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;CAC3C,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,IAEnE,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAEpF;KACC,KAAK,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CACvF,CAAA;AAEH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AAEpD,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAA;AAExE,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,CAAC,CAAA;CACT,CAAA;AAED,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;IACxB,IAAI,EAAE,MAAM,cAAc,CAAC,CAAC,CAAC,CAAA;IAC7B,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAA;CACrC,CAAA;AAID,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,SAAS,EAAE,IAChD,QAAQ,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA"}

package/dist/types/src/ecs.d.ts

@@ -5,7 +5,7 @@
  * @main ecsjs
  */
 import { EntityMap } from './entity-map.js';
-export type { ComponentClass, ComponentClassesMap, ComponentClassMap } from './definitions.js';
+export type { ComponentClass, ComponentClassesMap, ComponentClassMap, IComponentIterator } from './definitions.js';
 export { EntityMap } from './entity-map.js';
 export type { ComponentNotRegistered } from './errors.js';
 export { ComponentIterator } from './iterators.js';

package/dist/types/src/ecs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ecs.d.ts","sourceRoot":"","sources":["../../../src/ecs.ts"],"names":[],"mappings":"AAkBA;;;;;GAKG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,YAAY,EAAE,cAAc,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,YAAY,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAElD,eAAO,MAAM,GAAG,WAAkB,CAAA"}
+{"version":3,"file":"ecs.d.ts","sourceRoot":"","sources":["../../../src/ecs.ts"],"names":[],"mappings":"AAkBA;;;;;GAKG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,YAAY,EAAE,cAAc,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AAClH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,YAAY,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAElD,eAAO,MAAM,GAAG,WAAkB,CAAA"}

package/dist/types/src/entity-map.d.ts

@@ -168,8 +168,18 @@ export declare class EntityMap {
      * for(const [playerId, player, position] of iterator) {
      *
      * }
+     *
+     * // you can declare the type of iterator before it's assigned
+     * let iterator: IComponentIterator<[Components.Player, Components.Position]>
+     *
+     * // then with late bound assignment (keeping the iterator intellisense)
+     * iterator = ecs.iterator(Components.Player, Components.Position)
+     *
+     * for(const [playerId, player, position] of iterator) {
+     *    const moving = player.isMoving
+     * }
      */
-    iterator<K extends ComponentClass<any>, T extends ComponentClass<any>[]>(keyComponent: ComponentClass<any>, ...components: T): ComponentIterator<K, T>;
+    iterator<K extends ComponentClass<any>, T extends ComponentClass<any>[]>(keyComponent: K, ...components: T): ComponentIterator<K, T>;
     /**
      * Prints all component maps in a tabular format to the console
      */

package/dist/types/src/entity-map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entity-map.d.ts","sourceRoot":"","sources":["../../../src/entity-map.ts"],"names":[],"mappings":"AAkBA;;GAEG;AACH,OAAO,EACL,KAAK,SAAS,EACd,KAAK,cAAc,EAEnB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACxB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGnD;;;;GAIG;AACH,qBAAa,SAAS;IAGpB,OAAO,CAAC,aAAa,CAAoC;IAEzD,OAAO,CAAC,MAAM,CAAY;;IAI1B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAK,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,gBAAgB,EAAE,KAAK;IAexE;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,SAAS;IAMzE;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;IAI1C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EACxE,YAAY,EAAE,IAAI,EAClB,GAAG,UAAU,EAAE,CAAC,GACf,kBAAkB,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAYjE;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,IAAI,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EAC1E,YAAY,EAAE,IAAI,EAClB,GAAG,UAAU,EAAE,CAAC,GACf,kBAAkB,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAa/C;;OAEG;IACH,OAAO,CAAC,SAAS;IAOjB;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EACjC,QAAQ,EAAE,MAAM,EAChB,GAAG,UAAU,EAAE,CAAC,GACf,kBAAkB,CAAC,CAAC,CAAC,GAAG,SAAS;IAQpC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAQhD;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO;IAQ/D,OAAO,CAAC,SAAS;IAYjB;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC;IAC3D,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC,GAAG,CAAC;IAQjE;;;;;OAKG;IACH,MAAM,CAAC,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC;IAM1E;;;;;;;OAOG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAenD;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM;IAO9B,SAAS;IAKT,KAAK;IAKL;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EACrE,YAAY,EAAE,cAAc,CAAC,GAAG,CAAC,EACjC,GAAG,UAAU,EAAE,CAAC,GACf,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC;IAK1B;;OAEG;IACH,UAAU;IAKV;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM;IAe5B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM;IAsBzB;;;;;;;;OAQG;IACH,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,GAAG;CAqBzC"}
+{"version":3,"file":"entity-map.d.ts","sourceRoot":"","sources":["../../../src/entity-map.ts"],"names":[],"mappings":"AAkBA;;GAEG;AACH,OAAO,EACL,KAAK,SAAS,EACd,KAAK,cAAc,EAEnB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACxB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGnD;;;;GAIG;AACH,qBAAa,SAAS;IAGpB,OAAO,CAAC,aAAa,CAAoC;IAEzD,OAAO,CAAC,MAAM,CAAY;;IAI1B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAK,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,gBAAgB,EAAE,KAAK;IAexE;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,SAAS;IAMzE;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;IAI1C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EACxE,YAAY,EAAE,IAAI,EAClB,GAAG,UAAU,EAAE,CAAC,GACf,kBAAkB,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAYjE;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,IAAI,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EAC1E,YAAY,EAAE,IAAI,EAClB,GAAG,UAAU,EAAE,CAAC,GACf,kBAAkB,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAa/C;;OAEG;IACH,OAAO,CAAC,SAAS;IAOjB;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EACjC,QAAQ,EAAE,MAAM,EAChB,GAAG,UAAU,EAAE,CAAC,GACf,kBAAkB,CAAC,CAAC,CAAC,GAAG,SAAS;IAQpC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAQhD;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO;IAQ/D,OAAO,CAAC,SAAS;IAYjB;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC;IAC3D,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC,GAAG,CAAC;IAQjE;;;;;OAKG;IACH,MAAM,CAAC,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC;IAM1E;;;;;;;OAOG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAenD;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM;IAO9B,SAAS;IAKT,KAAK;IAKL;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE,EACrE,YAAY,EAAE,CAAC,EACf,GAAG,UAAU,EAAE,CAAC,GACf,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC;IAK1B;;OAEG;IACH,UAAU;IAKV;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM;IAe5B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM;IAsBzB;;;;;;;;OAQG;IACH,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,GAAG;CAqBzC"}

package/dist/types/src/iterators.d.ts

@@ -1,4 +1,4 @@
-import type { ComponentClass, ComponentInstances } from './definitions.js';
+import type { ComponentClass, ComponentInstances, IteratorResult } from './definitions.js';
 import type { EntityMap } from './entity-map.js';
 export declare class ComponentIterator<K extends ComponentClass<any>, T extends ComponentClass<any>[]> {
     ecs: EntityMap;

package/dist/types/src/iterators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"iterators.d.ts","sourceRoot":"","sources":["../../../src/iterators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAqB,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC9F,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,qBAAa,iBAAiB,CAC5B,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAC7B,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE;IAmBZ,GAAG,EAAE,SAAS;IAAS,GAAG,EAAE,CAAC;IAhBhD,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,UAAU,CAA0B;IAE5C,OAAO,CAAC,OAAO,CAA4C;IAE3D;;;;;;;;;;OAUG;gBACgB,GAAG,EAAE,SAAS,EAAS,GAAG,EAAE,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC;IAMlE,IAAI,IAAI,cAAc,CAAC,kBAAkB,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAa7E;;OAEG;IACH,KAAK;IAIL,CAAC,MAAM,CAAC,QAAQ,CAAC;CAElB"}
+{"version":3,"file":"iterators.d.ts","sourceRoot":"","sources":["../../../src/iterators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EAEd,kBAAkB,EAClB,cAAc,EACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,qBAAa,iBAAiB,CAC5B,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAC7B,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,EAAE;IAmBZ,GAAG,EAAE,SAAS;IAAS,GAAG,EAAE,CAAC;IAhBhD,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,UAAU,CAA0B;IAE5C,OAAO,CAAC,OAAO,CAA0B;IAEzC;;;;;;;;;;OAUG;gBACgB,GAAG,EAAE,SAAS,EAAS,GAAG,EAAE,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC;IAMlE,IAAI,IAAI,cAAc,CAAC,kBAAkB,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAc7E;;OAEG;IACH,KAAK;IAIL,CAAC,MAAM,CAAC,QAAQ,CAAC;CAElB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "title": "ECS JS",
   "name": "ecsjs",
-  "version": "1.0.0-beta.13",
+  "version": "1.0.0-beta.14",
   "description": "An entity component system library for JavaScript",
   "author": "2013+ pflannery (https://github.com/pflannery)",
   "license": "GNU GPL v3",

package/src/definitions.ts

@@ -6,6 +6,20 @@ export interface Component { }
 
 export type ComponentClass<ComponentInstance> = new (...args: any[]) => ComponentInstance
 
+/**
+* Used for infering generic type spread for classes
+*/
+export type ComponentClasses<TClasses extends Component[]> =
+  // return a single variadic item when only 1 item is specified
+  TClasses['length'] extends 1 ? TClasses[0]
+  // otherwise return an array of variadic types
+  : {
+    [Index in keyof TClasses]: TClasses[Index]
+  }
+
+/**
+ * Used for infering generic type spread for class instances
+ */
 export type ComponentInstances<TClasses extends ComponentClass<any>[]> =
   // return a single variadic item when only 1 item is specified
   TClasses['length'] extends 1 ? TClasses[0] extends ComponentClass<infer R> ? R : never
@@ -16,4 +30,20 @@ export type ComponentInstances<TClasses extends ComponentClass<any>[]> =
 
 export type ComponentClassMap<T> = KeyMap<number, T>
 
-export type ComponentClassesMap = KeyMap<string, ComponentClassMap<any>>
+export type ComponentClassesMap = KeyMap<string, ComponentClassMap<any>>
+
+export type IteratorResult<T> = {
+  done: boolean,
+  value: T
+}
+
+export type Iterator<T> = {
+  next: () => IteratorResult<T>
+  reset: () => void
+  [Symbol.iterator]: () => Iterator<T>
+}
+
+// allow late bound assignment
+// e.g. let iterator: IComponentIterator<[Components.Player, Components.Position]>
+export type IComponentIterator<T extends Component[]>
+  = Iterator<ComponentClasses<[number, ...T]>>

package/src/ecs.ts

@@ -23,7 +23,7 @@
  * @main ecsjs
  */
 import { EntityMap } from './entity-map.js'
-export type { ComponentClass, ComponentClassesMap, ComponentClassMap } from './definitions.js'
+export type { ComponentClass, ComponentClassesMap, ComponentClassMap, IComponentIterator } from './definitions.js'
 export { EntityMap } from './entity-map.js'
 export type { ComponentNotRegistered } from './errors.js'
 export { ComponentIterator } from './iterators.js'

package/src/entity-map.ts

@@ -332,13 +332,23 @@ export class EntityMap {
    * for(const [playerId, player, position] of iterator) {
    * 
    * }
+   * 
+   * // you can declare the type of iterator before it's assigned
+   * let iterator: IComponentIterator<[Components.Player, Components.Position]>
+   * 
+   * // then with late bound assignment (keeping the iterator intellisense)
+   * iterator = ecs.iterator(Components.Player, Components.Position)
+   * 
+   * for(const [playerId, player, position] of iterator) {
+   *    const moving = player.isMoving
+   * }
    */
   iterator<K extends ComponentClass<any>, T extends ComponentClass<any>[]>(
-    keyComponent: ComponentClass<any>,
+    keyComponent: K,
     ...components: T
-  ): ComponentIterator<K, T>;
+  ): ComponentIterator<K, T>
   iterator(keyComponent: ComponentClass<any>, ...components: ComponentClass<any>[]) {
-    return new ComponentIterator(this, keyComponent, ...components);
+    return new ComponentIterator(this, keyComponent, ...components) as any;
   }
 
   /**

package/src/iterators.ts

@@ -1,4 +1,9 @@
-import type { ComponentClass, ComponentClassMap, ComponentInstances } from './definitions.js';
+import type {
+  ComponentClass,
+  ComponentClassMap,
+  ComponentInstances,
+  IteratorResult
+} from './definitions.js';
 import type { EntityMap } from './entity-map.js';
 
 export class ComponentIterator<
@@ -9,7 +14,7 @@ export class ComponentIterator<
   private keyMap: ComponentClassMap<any>
   private components: ComponentClassMap<any>[]
   // iteration state
-  private entries: MapIterator<[number, ComponentClass<any>]>
+  private entries: MapIterator<[number, K]>
 
   /**
    * @throws {ComponentNotRegistered} when any of specified component(s) are not registered
@@ -33,12 +38,13 @@ export class ComponentIterator<
     const { value, done } = entry;
     if (done) return { value: value as any, done };
 
-    const [entityId] = value;
+    const [entityId, entityValue] = value;
+    const results = [entityId, entityValue]
     for (const x of this.components) {
-      value.push(x.get(entityId));
+      results.push(x.get(entityId));
     }
 
-    return { value: value as any, done: done as boolean };
+    return { value: results as any, done: false };
   }
 
   /**