ecsjs 1.0.0-beta.2 → 1.0.0-beta.4

package/README.md

@@ -58,8 +58,6 @@ ecs.set(entityId, new PositionComponent(25, 25))
 </script>
 ```
 
-[Library API](https://ecsjs.gitlab.io/ecs/)
-
 ## License
 
 Licensed under GNU GPL v3

package/dist/ecs.js

@@ -1,2 +1,2 @@
-var s=class extends Map{constructor(e=[]){super(e)}firstEntry(){return this.size===0?[void 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 of this.entries()){let r=n[1],o={};e==!1&&(o["entity.key"]=n[0]),o["entity.type"]=r.constructor.name,t.push({...o,...r})}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)}[Symbol.iterator](){return this.values()}static get[Symbol.species](){return Map}};var i=class a{componentMaps=new s;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 r=new s;this.componentMaps.set(n,r)}return this}getMap(e){return this.componentMaps.get(e.name)}get(e,t){let n=this.componentMaps.get(t.name);if(n===void 0)throw new ReferenceError(`"${t}" component class does not exist in the componentMaps`);return n.get(e)}getByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new ReferenceError(`"${t}" component does not exist in the componentMaps`);return n.get(e)}has(e,t){let n=this.componentMaps.get(t.name);return n===void 0?!1:n.has(e)}set(e,t){let n=this.componentMaps.get(t.constructor.name);if(n===void 0)throw new ReferenceError(`Component map does not exist using the name: ${t.constructor.name}`);return n.set(e,t),t}remove(e,t){return this.removeByKey(e,t.name)}removeByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new ReferenceError(`A registered entity map does not exist for the given key: ${t}`);return n.get(e)===void 0?!1:n.delete(e)}destroyEntity(e){this.componentMaps.forEach(t=>{t.has(e)&&t.delete(e)})}getNextId(){return this.nextId++,this.nextId}clear(){return this.componentMaps.clear(),this}printTable(){return this.componentMaps.forEach(e=>console.table(e.toTable(!0))),this}static parse(e){let t=new a,n=JSON.parse(e,function(r,o){return o.hasOwnProperty("componentMaps")?(Reflect.setPrototypeOf(o,a.prototype),o):o.hasOwnProperty("__KeyMap__")?new s(o.iterable):this[r]});return t.componentMaps=n.componentMaps,t.nextId=n.nextId,t}static createWithTracing(e){let t={get(n,r,o){let p=n[r];return typeof p=="function"&&(e.length===0||e.includes(r))?function(...u){return console.groupCollapsed("ecs trace",r,u),console.trace(),console.groupEnd(),p.apply(this,u)}:p}};return new Proxy(new a,t)}};var l=new i;typeof window<"u"?window.ecs=l:typeof module<"u"&&module!==null&&(module.exports={ecs:l});export{l as ecs};
+var s=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 of this.entries()){let o=n[1],r={};e==!1&&(r["entity.key"]=n[0]),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)}[Symbol.iterator](){return this.values()}static get[Symbol.species](){return Map}};var i=class a{componentMaps=new s;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 o=new s;this.componentMaps.set(n,o)}return this}getMap(e){return this.componentMaps.get(e.name)}firstEntry(e){return this.getMap(e)?.firstEntry()}firstKey(e){return this.getMap(e)?.firstKey()}firstValue(e){return this.getMap(e)?.firstValue()}get(e,t){let n=this.componentMaps.get(t.name);if(n===void 0)throw new ReferenceError(`"${t}" component class does not exist in the componentMaps`);return n.get(e)}getByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new ReferenceError(`"${t}" component does not exist in the componentMaps`);return n.get(e)}has(e,t){let n=this.componentMaps.get(t.name);return n===void 0?!1:n.has(e)}set(e,t){let n=this.componentMaps.get(t.constructor.name);if(n===void 0)throw new ReferenceError(`Component map does not exist using the name: ${t.constructor.name}`);return n.set(e,t),t}remove(e,t){return this.removeByKey(e,t.name)}removeByKey(e,t){let n=this.componentMaps.get(t);if(n===void 0)throw new ReferenceError(`A registered entity map does not exist for the given key: ${t}`);return n.get(e)===void 0?!1:n.delete(e)}destroyEntity(e){this.componentMaps.forEach(t=>{t.has(e)&&t.delete(e)})}getNextId(){return this.nextId++,this.nextId}clear(){return this.componentMaps.clear(),this}printTable(){return this.componentMaps.forEach(e=>console.table(e.toTable(!0))),this}static parse(e){let t=new a,n=JSON.parse(e,function(o,r){return r.hasOwnProperty("componentMaps")?(Reflect.setPrototypeOf(r,a.prototype),r):r.hasOwnProperty("__KeyMap__")?new s(r.iterable):this[o]});return t.componentMaps=n.componentMaps,t.nextId=n.nextId,t}static createWithTracing(e){let t={get(n,o){let r=n[o];return typeof r=="function"&&(e.length===0||e.includes(o))?function(...p){return console.groupCollapsed("ecs trace",o,p),console.trace(),console.groupEnd(),r.apply(this,p)}:r}};return new Proxy(new a,t)}};var u=new i;typeof window<"u"?window.ecs=u:typeof module<"u"&&module!==null&&(module.exports={ecs:u});export{u as ecs};
 //# sourceMappingURL=ecs.js.map

package/dist/ecs.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/key-map.ts", "../src/entity-map.ts", "../src/ecs.ts"],
-  "sourcesContent": ["/*\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: any, value: any] | undefined {\n    if (this.size === 0) return [undefined, 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 value of this.entries()) {\n      let entity = value[1] as { new(): TValue }\n      let meta: KeyCollection<any> = {}\n\n      if (excludeKeys == false) meta[\"entity.key\"] = value[0]\n      meta[\"entity.type\"] = entity.constructor.name\n\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<any> {\n    return super.entries().filter(x => x !== undefined && x !== null)\n  }\n\n  keys(): MapIterator<any> {\n    return super.keys().filter(x => x !== undefined && x !== null)\n  }\n\n  values(): MapIterator<any> {\n    return super.values().filter(x => x !== undefined && x !== null)\n  }\n\n  // default iterator\n  [Symbol.iterator]() {\n    return this.values()\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  Component,\n  type ComponentDataMap,\n  type ComponentClass,\n  type ComponentMap\n} from './definitions.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: ComponentMap = new KeyMap()\n\n  private nextId: number = 0\n\n  constructor() { }\n\n  /**\n   * Registers a component class\n   * \n   * @example\n   *\n   * ```javascript\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   */\n  register(...component: ComponentClass[]) {\n    for (const definition of component) {\n      const componentName = definition.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: ComponentDataMap = new KeyMap();\n      this.componentMaps.set(componentName, componentDataMap);\n    }\n\n    // chain\n    return this;\n  }\n\n  /**\n   * Retrieves an entity map by it's registered type\n   */\n  getMap(component: ComponentClass) {\n    return this.componentMaps.get(component.name);\n  }\n\n  /**\n   * Retrieves an entity from its registered entity map\n   *\n   * @example\n   *\n   * ```javascript\n   *   // get an entity\n   *   let positionData = ecs.get(entityId, Components.PositionComponent);\n   * ```\n   */\n  get(entityId: number, component: ComponentClass) {\n    let cm = this.componentMaps.get(component.name);\n    if (cm === undefined)\n      throw new ReferenceError(`\"${component}\" component class does not exist in the componentMaps`);\n\n    return cm.get(entityId);\n  }\n\n  /**\n   * Retrieves an entity from its registered entity map\n   *\n   * @example\n   *\n   * ```javascript\n   *   // get an entity\n   *   let positionData = ecs.getByKey(entityId, \"PositionComponent\");\n   * ```\n   */\n  getByKey(entityId: number, componentName: string) {\n    // get the component map\n    let map = this.componentMaps.get(componentName);\n    if (map === undefined)\n      throw new ReferenceError(`\"${componentName}\" component does not exist in the componentMaps`);\n\n    return map.get(entityId);\n  }\n\n  /**\n   * Checks if the entity exists in it's registed component map\n   * The entity type must be registered before calling this method\n   * \n   * @example\n   *\n   * ```javascript\n   *   // get an entity\n   *   let exists = ecs.has(entityId, PositionComponent);\n   * ```\n   */\n  has(entityId: number, component: ComponentClass): boolean {\n    // get the component map\n    let map = this.componentMaps.get(component.name);\n    if (map === undefined) return false\n\n    return map.has(entityId);\n  }\n\n  /**\n   * Adds or updates an entity to it's registered entity map\n   *\n   * @example\n   *\n   * ```javascript\n   *   // add/update an entity\n   *   let playerPos = ecs.set(entityId, new Components.PositionComponent(0, 0));\n   * ```\n   */\n  set<T extends Component>(entityId: number, componentData: Component): T {\n    // get the component map\n    let map = this.componentMaps.get(componentData.constructor.name);\n    if (map === undefined)\n      throw new ReferenceError(`Component map does not exist using the name: ${componentData.constructor.name}`);\n\n    // set the entity on the entity map\n    map.set(entityId, componentData);\n\n    // return instance\n    return componentData as T;\n  }\n\n  /**\n   * Removes an entity from its entity map.\n   * Removes any related Node entities that are mapped to the entity\n   * \n   * @example\n   *\n   * ```javascript\n   *   // remove an entity from its entity map\n   *   EntityMap.remove(entityId, Components.PositionComponent);\n   * ```\n   */\n  remove(entityId: number, component: ComponentClass) {\n    return this.removeByKey(entityId, component.name);\n  }\n\n  /**\n   * Removes an entity from its entity map.\n   * Removes any related Node entities that are mapped to the entity\n   * \n   * @example\n   *\n   * ```javascript\n   *   // remove an entity from its entity map\n   *   EntityMap.removeByKey(entityId, \"PositionComponent\");\n   * ```\n   */\n  removeByKey(entityId: number, componentName: string) {\n    // get the entity map\n    let entityMap = this.componentMaps.get(componentName);\n\n    // ensure the map is defined\n    if (entityMap === undefined)\n      throw new ReferenceError(`A registered entity map does not exist for the given key: ${componentName}`);\n\n    // get the entity\n    let 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   * Destroys an entity across all component maps\n   */\n  destroyEntity(entityId: number) {\n    this.componentMaps.forEach((dataMap: ComponentDataMap) => {\n      if (dataMap.has(entityId)) dataMap.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   * Prints all entity 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   * Parse's the JSON and returns an EntityMap object\n   * \n   * @example\n   *\n   * ```javascript\n   *   // remove an entity from its entity map\n   *   const json = JSON.stringfy(ecs);\n   *   const restoredMap = EntityMap.parse(json);\n   * ```\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      // TODO pass in user defined entity types ?\n      // if (value.hasOwnProperty('uniqueid')) {\n      //   Reflect.setPrototypeOf(value, ecs.Entity.prototype);\n      //   return value;\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    let traceHandler = {\n      get(target: any, propKey: string, receiver: any) {\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'\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": "AAsBO,IAAMA,EAAN,cAAmC,GAAkB,CAE1D,YAAYC,EAAiB,CAAC,EAAG,CAC/B,MAAMA,CAAO,CACf,CAEA,YAAiD,CAC/C,OAAI,KAAK,OAAS,EAAU,CAAC,OAAW,MAAS,EAEhC,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,QAAWC,KAAS,KAAK,QAAQ,EAAG,CAClC,IAAIC,EAASD,EAAM,CAAC,EAChBE,EAA2B,CAAC,EAE5BJ,GAAe,KAAOI,EAAK,YAAY,EAAIF,EAAM,CAAC,GACtDE,EAAK,aAAa,EAAID,EAAO,YAAY,KAEzCF,EAAM,KAAK,CAAE,GAAGG,EAAM,GAAGD,CAAO,CAAC,CACnC,CACA,OAAOF,CACT,CAKA,WAAWD,EAAc,GAAa,CACpC,QAAQ,MAAM,KAAK,QAAQA,CAAW,CAAC,CACzC,CAEA,SAA4B,CAC1B,OAAO,MAAM,QAAQ,EAAE,OAAOK,GAAwBA,GAAM,IAAI,CAClE,CAEA,MAAyB,CACvB,OAAO,MAAM,KAAK,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CAC/D,CAEA,QAA2B,CACzB,OAAO,MAAM,OAAO,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CACjE,CAGA,CAAC,OAAO,QAAQ,GAAI,CAClB,OAAO,KAAK,OAAO,CACrB,CAEA,WAAY,OAAO,OAAO,GAAI,CAAE,OAAO,GAAK,CAE9C,EC9DO,IAAMC,EAAN,MAAMC,CAAU,CAGb,cAA8B,IAAIC,EAElC,OAAiB,EAEzB,aAAc,CAAE,CAoBhB,YAAYC,EAA6B,CACvC,QAAWC,KAAcD,EAAW,CAClC,IAAME,EAAgBD,EAAW,KACjC,GAAIC,IAAkB,OACpB,MAAM,IAAI,eAAe,2EAA2E,EAGtG,IAAMC,EAAqC,IAAIJ,EAC/C,KAAK,cAAc,IAAIG,EAAeC,CAAgB,CACxD,CAGA,OAAO,IACT,CAKA,OAAOH,EAA2B,CAChC,OAAO,KAAK,cAAc,IAAIA,EAAU,IAAI,CAC9C,CAYA,IAAII,EAAkBJ,EAA2B,CAC/C,IAAIK,EAAK,KAAK,cAAc,IAAIL,EAAU,IAAI,EAC9C,GAAIK,IAAO,OACT,MAAM,IAAI,eAAe,IAAIL,CAAS,uDAAuD,EAE/F,OAAOK,EAAG,IAAID,CAAQ,CACxB,CAYA,SAASA,EAAkBF,EAAuB,CAEhD,IAAII,EAAM,KAAK,cAAc,IAAIJ,CAAa,EAC9C,GAAII,IAAQ,OACV,MAAM,IAAI,eAAe,IAAIJ,CAAa,iDAAiD,EAE7F,OAAOI,EAAI,IAAIF,CAAQ,CACzB,CAaA,IAAIA,EAAkBJ,EAAoC,CAExD,IAAIM,EAAM,KAAK,cAAc,IAAIN,EAAU,IAAI,EAC/C,OAAIM,IAAQ,OAAkB,GAEvBA,EAAI,IAAIF,CAAQ,CACzB,CAYA,IAAyBA,EAAkBG,EAA6B,CAEtE,IAAID,EAAM,KAAK,cAAc,IAAIC,EAAc,YAAY,IAAI,EAC/D,GAAID,IAAQ,OACV,MAAM,IAAI,eAAe,gDAAgDC,EAAc,YAAY,IAAI,EAAE,EAG3G,OAAAD,EAAI,IAAIF,EAAUG,CAAa,EAGxBA,CACT,CAaA,OAAOH,EAAkBJ,EAA2B,CAClD,OAAO,KAAK,YAAYI,EAAUJ,EAAU,IAAI,CAClD,CAaA,YAAYI,EAAkBF,EAAuB,CAEnD,IAAIM,EAAY,KAAK,cAAc,IAAIN,CAAa,EAGpD,GAAIM,IAAc,OAChB,MAAM,IAAI,eAAe,6DAA6DN,CAAa,EAAE,EAIvG,OADaM,EAAU,IAAIJ,CAAQ,IACpB,OAAkB,GAG1BI,EAAU,OAAOJ,CAAQ,CAClC,CAKA,cAAcA,EAAkB,CAC9B,KAAK,cAAc,QAASK,GAA8B,CACpDA,EAAQ,IAAIL,CAAQ,GAAGK,EAAQ,OAAOL,CAAQ,CACpD,CAAC,CACH,CAGA,WAAY,CACV,YAAK,SACE,KAAK,MACd,CAEA,OAAQ,CACN,YAAK,cAAc,MAAM,EAClB,IACT,CAKA,YAAa,CACX,YAAK,cAAc,QAAQE,GAAO,QAAQ,MAAMA,EAAI,QAAQ,EAAI,CAAC,CAAC,EAC3D,IACT,CAaA,OAAO,MAAMI,EAAc,CACzB,IAAMC,EAAM,IAAIb,EAEVc,EAAW,KAAK,MAAMF,EAAM,SAAUG,EAAaC,EAAY,CAEnE,OAAIA,EAAM,eAAe,eAAe,GACtC,QAAQ,eAAeA,EAAOhB,EAAU,SAAS,EAC1CgB,GAGLA,EAAM,eAAe,YAAY,EAC5B,IAAIf,EAAOe,EAAM,QAAQ,EAS3B,KAAKD,CAAG,CACjB,CAAC,EAED,OAAAF,EAAI,cAAgBC,EAAS,cAC7BD,EAAI,OAASC,EAAS,OACfD,CACT,CAWA,OAAO,kBAAkBI,EAAiB,CACxC,IAAIC,EAAe,CACjB,IAAIC,EAAaC,EAAiBC,EAAe,CAC/C,IAAMC,EAAcH,EAAOC,CAAO,EAElC,OAAI,OAAOE,GAAgB,aAAeL,EAAW,SAAW,GAAKA,EAAW,SAASG,CAAO,GACvF,YAAwBG,EAAa,CAC1C,eAAQ,eAAe,YAAaH,EAASG,CAAI,EACjD,QAAQ,MAAM,EACd,QAAQ,SAAS,EACVD,EAAY,MAAM,KAAMC,CAAI,CACrC,EAGKD,CACT,CACF,EAEA,OAAO,IAAI,MAAM,IAAItB,EAAakB,CAAY,CAChD,CAEF,ECnRO,IAAMM,EAAM,IAAIC,EAEnB,OAAO,OAAW,IAEpB,OAAO,IAAMD,EACJ,OAAO,OAAW,KAAe,SAAW,OAErD,OAAO,QAAU,CAAE,IAAAA,CAAI",
-  "names": ["KeyMap", "entries", "excludeKeys", "table", "value", "entity", "meta", "x", "EntityMap", "_EntityMap", "KeyMap", "component", "definition", "componentName", "componentDataMap", "entityId", "cm", "map", "componentData", "entityMap", "dataMap", "json", "ecs", "restored", "key", "value", "funcFilter", "traceHandler", "target", "propKey", "receiver", "targetValue", "args", "ecs", "EntityMap"]
+  "sourcesContent": ["/*\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 value of this.entries()) {\n      let entity = value[1] as { new(): TValue }\n      let meta: KeyCollection<any> = {}\n\n      if (excludeKeys == false) meta[\"entity.key\"] = value[0]\n      meta[\"entity.type\"] = entity.constructor.name\n\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<any> {\n    return super.entries().filter(x => x !== undefined && x !== null)\n  }\n\n  keys(): MapIterator<any> {\n    return super.keys().filter(x => x !== undefined && x !== null)\n  }\n\n  values(): MapIterator<any> {\n    return super.values().filter(x => x !== undefined && x !== null)\n  }\n\n  // default iterator\n  [Symbol.iterator]() {\n    return this.values()\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 ComponentDataMap,\n  type ComponentClass,\n  type ComponentMap,\n  type IComponent\n} from './definitions.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: ComponentMap = new KeyMap()\n\n  private nextId: number = 0\n\n  constructor() { }\n\n  /**\n   * Registers a component class\n   * \n   * @example\n   *\n   * ```javascript\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   */\n  register(...component: ComponentClass<any>[]) {\n    for (const definition of component) {\n      const componentName = definition.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: ComponentDataMap<any> = new KeyMap();\n      this.componentMaps.set(componentName, componentDataMap);\n    }\n\n    // chain\n    return this;\n  }\n\n  /**\n   * Retrieves an entity map by it's registered type\n   */\n  getMap<T extends IComponent>(component: ComponentClass<T>): ComponentDataMap<T> | undefined {\n    return this.componentMaps.get(component.name);\n  }\n\n  /**\n   * Get the first entity entry for a component class\n   * \n   * @example\n   *\n   * ```javascript\n   *    const [entityId, player] = ecs.firstEntry(PlayerComponent) ?? [];\n   * ```\n   */\n  firstEntry<T extends IComponent>(component: ComponentClass<T>) {\n    return this.getMap(component)?.firstEntry();\n  }\n\n  /**\n   * Get the first entity id for a component class\n   * \n   * @example\n   *\n   * ```javascript\n   *    const entityId = ecs.firstKey(PlayerComponent);\n   * ```\n   */\n  firstKey<T extends IComponent>(component: ComponentClass<T>) {\n    return this.getMap(component)?.firstKey();\n  }\n\n  /**\n   * Get the first entity component value for a component class\n   * \n   * @example\n   *\n   * ```javascript\n   *    const player = ecs.firstValue(PlayerComponent);\n   * ```\n   */\n  firstValue<T extends IComponent>(component: ComponentClass<T>) {\n    return this.getMap(component)?.firstValue();\n  }\n\n  /**\n   * Retrieves an entity from its registered entity map\n   *\n   * @example\n   *\n   * ```javascript\n   *   // get an entity\n   *   let positionData = ecs.get(entityId, Components.PositionComponent);\n   * ```\n   */\n  get<T extends IComponent>(entityId: number, component: ComponentClass<T>): T {\n    let cm = this.componentMaps.get(component.name);\n    if (cm === undefined)\n      throw new ReferenceError(`\"${component}\" component class does not exist in the componentMaps`);\n\n    return cm.get(entityId);\n  }\n\n  /**\n   * Retrieves an entity from its registered entity map\n   *\n   * @example\n   *\n   * ```javascript\n   *   // get an entity\n   *   let positionData = ecs.getByKey(entityId, \"PositionComponent\");\n   * ```\n   */\n  getByKey(entityId: number, componentName: string) {\n    // get the component map\n    let map = this.componentMaps.get(componentName);\n    if (map === undefined)\n      throw new ReferenceError(`\"${componentName}\" component does not exist in the componentMaps`);\n\n    return map.get(entityId);\n  }\n\n  /**\n   * Checks if the entity exists in it's registed component map\n   * The entity type must be registered before calling this method\n   * \n   * @example\n   *\n   * ```javascript\n   *   // get an entity\n   *   let exists = ecs.has(entityId, PositionComponent);\n   * ```\n   */\n  has<T extends IComponent>(entityId: number, component: ComponentClass<T>): boolean {\n    // get the component map\n    let map = this.componentMaps.get(component.name);\n    if (map === undefined) return false\n\n    return map.has(entityId);\n  }\n\n  /**\n   * Adds or updates an entity to it's registered entity map\n   *\n   * @example\n   *\n   * ```javascript\n   *   // add/update an entity\n   *   let playerPos = ecs.set(entityId, new Components.PositionComponent(0, 0));\n   * ```\n   */\n  set<T extends IComponent>(entityId: number, componentData: T): T {\n    // get the component map\n    let map = this.componentMaps.get(componentData.constructor.name);\n    if (map === undefined)\n      throw new ReferenceError(`Component map does not exist using the name: ${componentData.constructor.name}`);\n\n    // set the entity on the entity map\n    map.set(entityId, componentData);\n\n    // return instance\n    return componentData as T;\n  }\n\n  /**\n   * Removes an entity from its entity map.\n   * Removes any related Node entities that are mapped to the entity\n   * \n   * @example\n   *\n   * ```javascript\n   *   // remove an entity from its entity map\n   *   EntityMap.remove(entityId, Components.PositionComponent);\n   * ```\n   */\n  remove<T extends IComponent>(entityId: number, component: ComponentClass<T>) {\n    return this.removeByKey(entityId, component.name);\n  }\n\n  /**\n   * Removes an entity from its entity map.\n   * Removes any related Node entities that are mapped to the entity\n   * \n   * @example\n   *\n   * ```javascript\n   *   // remove an entity from its entity map\n   *   EntityMap.removeByKey(entityId, \"PositionComponent\");\n   * ```\n   */\n  removeByKey(entityId: number, componentName: string) {\n    // get the entity map\n    let entityMap = this.componentMaps.get(componentName);\n\n    // ensure the map is defined\n    if (entityMap === undefined)\n      throw new ReferenceError(`A registered entity map does not exist for the given key: ${componentName}`);\n\n    // get the entity\n    let 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   * Destroys an entity across all component maps\n   */\n  destroyEntity(entityId: number) {\n    this.componentMaps.forEach((dataMap: ComponentDataMap<any>) => {\n      if (dataMap.has(entityId)) dataMap.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   * Prints all entity 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   * Parse's the JSON and returns an EntityMap object\n   * \n   * @example\n   *\n   * ```javascript\n   *   // remove an entity from its entity map\n   *   const json = JSON.stringfy(ecs);\n   *   const restoredMap = EntityMap.parse(json);\n   * ```\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    let 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'\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": "AAsBO,IAAMA,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,QAAWC,KAAS,KAAK,QAAQ,EAAG,CAClC,IAAIC,EAASD,EAAM,CAAC,EAChBE,EAA2B,CAAC,EAE5BJ,GAAe,KAAOI,EAAK,YAAY,EAAIF,EAAM,CAAC,GACtDE,EAAK,aAAa,EAAID,EAAO,YAAY,KAEzCF,EAAM,KAAK,CAAE,GAAGG,EAAM,GAAGD,CAAO,CAAC,CACnC,CACA,OAAOF,CACT,CAKA,WAAWD,EAAc,GAAa,CACpC,QAAQ,MAAM,KAAK,QAAQA,CAAW,CAAC,CACzC,CAEA,SAA4B,CAC1B,OAAO,MAAM,QAAQ,EAAE,OAAOK,GAAwBA,GAAM,IAAI,CAClE,CAEA,MAAyB,CACvB,OAAO,MAAM,KAAK,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CAC/D,CAEA,QAA2B,CACzB,OAAO,MAAM,OAAO,EAAE,OAAOA,GAAwBA,GAAM,IAAI,CACjE,CAGA,CAAC,OAAO,QAAQ,GAAI,CAClB,OAAO,KAAK,OAAO,CACrB,CAEA,WAAY,OAAO,OAAO,GAAI,CAAE,OAAO,GAAK,CAE9C,EC9DO,IAAMC,EAAN,MAAMC,CAAU,CAGb,cAA8B,IAAIC,EAElC,OAAiB,EAEzB,aAAc,CAAE,CAoBhB,YAAYC,EAAkC,CAC5C,QAAWC,KAAcD,EAAW,CAClC,IAAME,EAAgBD,EAAW,KACjC,GAAIC,IAAkB,OACpB,MAAM,IAAI,eAAe,2EAA2E,EAGtG,IAAMC,EAA0C,IAAIJ,EACpD,KAAK,cAAc,IAAIG,EAAeC,CAAgB,CACxD,CAGA,OAAO,IACT,CAKA,OAA6BH,EAA+D,CAC1F,OAAO,KAAK,cAAc,IAAIA,EAAU,IAAI,CAC9C,CAWA,WAAiCA,EAA8B,CAC7D,OAAO,KAAK,OAAOA,CAAS,GAAG,WAAW,CAC5C,CAWA,SAA+BA,EAA8B,CAC3D,OAAO,KAAK,OAAOA,CAAS,GAAG,SAAS,CAC1C,CAWA,WAAiCA,EAA8B,CAC7D,OAAO,KAAK,OAAOA,CAAS,GAAG,WAAW,CAC5C,CAYA,IAA0BI,EAAkBJ,EAAiC,CAC3E,IAAIK,EAAK,KAAK,cAAc,IAAIL,EAAU,IAAI,EAC9C,GAAIK,IAAO,OACT,MAAM,IAAI,eAAe,IAAIL,CAAS,uDAAuD,EAE/F,OAAOK,EAAG,IAAID,CAAQ,CACxB,CAYA,SAASA,EAAkBF,EAAuB,CAEhD,IAAII,EAAM,KAAK,cAAc,IAAIJ,CAAa,EAC9C,GAAII,IAAQ,OACV,MAAM,IAAI,eAAe,IAAIJ,CAAa,iDAAiD,EAE7F,OAAOI,EAAI,IAAIF,CAAQ,CACzB,CAaA,IAA0BA,EAAkBJ,EAAuC,CAEjF,IAAIM,EAAM,KAAK,cAAc,IAAIN,EAAU,IAAI,EAC/C,OAAIM,IAAQ,OAAkB,GAEvBA,EAAI,IAAIF,CAAQ,CACzB,CAYA,IAA0BA,EAAkBG,EAAqB,CAE/D,IAAID,EAAM,KAAK,cAAc,IAAIC,EAAc,YAAY,IAAI,EAC/D,GAAID,IAAQ,OACV,MAAM,IAAI,eAAe,gDAAgDC,EAAc,YAAY,IAAI,EAAE,EAG3G,OAAAD,EAAI,IAAIF,EAAUG,CAAa,EAGxBA,CACT,CAaA,OAA6BH,EAAkBJ,EAA8B,CAC3E,OAAO,KAAK,YAAYI,EAAUJ,EAAU,IAAI,CAClD,CAaA,YAAYI,EAAkBF,EAAuB,CAEnD,IAAIM,EAAY,KAAK,cAAc,IAAIN,CAAa,EAGpD,GAAIM,IAAc,OAChB,MAAM,IAAI,eAAe,6DAA6DN,CAAa,EAAE,EAIvG,OADaM,EAAU,IAAIJ,CAAQ,IACpB,OAAkB,GAG1BI,EAAU,OAAOJ,CAAQ,CAClC,CAKA,cAAcA,EAAkB,CAC9B,KAAK,cAAc,QAASK,GAAmC,CACzDA,EAAQ,IAAIL,CAAQ,GAAGK,EAAQ,OAAOL,CAAQ,CACpD,CAAC,CACH,CAGA,WAAY,CACV,YAAK,SACE,KAAK,MACd,CAEA,OAAQ,CACN,YAAK,cAAc,MAAM,EAClB,IACT,CAKA,YAAa,CACX,YAAK,cAAc,QAAQE,GAAO,QAAQ,MAAMA,EAAI,QAAQ,EAAI,CAAC,CAAC,EAC3D,IACT,CAaA,OAAO,MAAMI,EAAc,CACzB,IAAMC,EAAM,IAAIb,EAEVc,EAAW,KAAK,MAAMF,EAAM,SAAUG,EAAaC,EAAY,CAEnE,OAAIA,EAAM,eAAe,eAAe,GACtC,QAAQ,eAAeA,EAAOhB,EAAU,SAAS,EAC1CgB,GAGLA,EAAM,eAAe,YAAY,EAC5B,IAAIf,EAAOe,EAAM,QAAQ,EAG3B,KAAKD,CAAG,CACjB,CAAC,EAED,OAAAF,EAAI,cAAgBC,EAAS,cAC7BD,EAAI,OAASC,EAAS,OACfD,CACT,CAWA,OAAO,kBAAkBI,EAAiB,CACxC,IAAIC,EAAe,CACjB,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,IAAIrB,EAAakB,CAAY,CAChD,CAEF,ECpTO,IAAMK,EAAM,IAAIC,EAEnB,OAAO,OAAW,IAEpB,OAAO,IAAMD,EACJ,OAAO,OAAW,KAAe,SAAW,OAErD,OAAO,QAAU,CAAE,IAAAA,CAAI",
+  "names": ["KeyMap", "entries", "excludeKeys", "table", "value", "entity", "meta", "x", "EntityMap", "_EntityMap", "KeyMap", "component", "definition", "componentName", "componentDataMap", "entityId", "cm", "map", "componentData", "entityMap", "dataMap", "json", "ecs", "restored", "key", "value", "funcFilter", "traceHandler", "target", "propKey", "targetValue", "args", "ecs", "EntityMap"]
 }

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

@@ -2,11 +2,11 @@ import type { KeyMap } from './key-map.js';
 export type KeyCollection<T> = {
     [key: string]: T;
 };
-export declare class Component {
+export interface IComponent {
 }
-export type ComponentClass = {
-    new (...args: any[]): Component;
+export type ComponentClass<T extends IComponent> = {
+    new (...args: any[]): T;
 };
-export type ComponentDataMap = KeyMap<number, Component>;
-export type ComponentMap = KeyMap<string, ComponentDataMap>;
+export type ComponentDataMap<T> = KeyMap<number, T>;
+export type ComponentMap = KeyMap<string, ComponentDataMap<any>>;
 //# 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,qBAAa,SAAS;CAAI;AAE1B,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,SAAS,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAExD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,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,UAAU;CAAI;AAE/B,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,UAAU,IAAI;IACjD,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AAEnD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAA"}

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

@@ -1,7 +1,7 @@
 /**
  * @module ecsjs
  */
-import { Component, type ComponentDataMap, type ComponentClass } from './definitions.js';
+import { type ComponentDataMap, type ComponentClass, type IComponent } from './definitions.js';
 /**
  * Class for storing entities and their relationships
  *
@@ -29,11 +29,41 @@ export declare class EntityMap {
      *    ecs.register(MyComponent1, MyComponent2);
      * ```
      */
-    register(...component: ComponentClass[]): this;
+    register(...component: ComponentClass<any>[]): this;
     /**
      * Retrieves an entity map by it's registered type
      */
-    getMap(component: ComponentClass): ComponentDataMap | undefined;
+    getMap<T extends IComponent>(component: ComponentClass<T>): ComponentDataMap<T> | undefined;
+    /**
+     * Get the first entity entry for a component class
+     *
+     * @example
+     *
+     * ```javascript
+     *    const [entityId, player] = ecs.firstEntry(PlayerComponent) ?? [];
+     * ```
+     */
+    firstEntry<T extends IComponent>(component: ComponentClass<T>): [key: number, value: T] | undefined;
+    /**
+     * Get the first entity id for a component class
+     *
+     * @example
+     *
+     * ```javascript
+     *    const entityId = ecs.firstKey(PlayerComponent);
+     * ```
+     */
+    firstKey<T extends IComponent>(component: ComponentClass<T>): number | undefined;
+    /**
+     * Get the first entity component value for a component class
+     *
+     * @example
+     *
+     * ```javascript
+     *    const player = ecs.firstValue(PlayerComponent);
+     * ```
+     */
+    firstValue<T extends IComponent>(component: ComponentClass<T>): T | undefined;
     /**
      * Retrieves an entity from its registered entity map
      *
@@ -44,7 +74,7 @@ export declare class EntityMap {
      *   let positionData = ecs.get(entityId, Components.PositionComponent);
      * ```
      */
-    get(entityId: number, component: ComponentClass): Component | undefined;
+    get<T extends IComponent>(entityId: number, component: ComponentClass<T>): T;
     /**
      * Retrieves an entity from its registered entity map
      *
@@ -55,7 +85,7 @@ export declare class EntityMap {
      *   let positionData = ecs.getByKey(entityId, "PositionComponent");
      * ```
      */
-    getByKey(entityId: number, componentName: string): Component | undefined;
+    getByKey(entityId: number, componentName: string): any;
     /**
      * Checks if the entity exists in it's registed component map
      * The entity type must be registered before calling this method
@@ -67,7 +97,7 @@ export declare class EntityMap {
      *   let exists = ecs.has(entityId, PositionComponent);
      * ```
      */
-    has(entityId: number, component: ComponentClass): boolean;
+    has<T extends IComponent>(entityId: number, component: ComponentClass<T>): boolean;
     /**
      * Adds or updates an entity to it's registered entity map
      *
@@ -78,7 +108,7 @@ export declare class EntityMap {
      *   let playerPos = ecs.set(entityId, new Components.PositionComponent(0, 0));
      * ```
      */
-    set<T extends Component>(entityId: number, componentData: Component): T;
+    set<T extends IComponent>(entityId: number, componentData: T): T;
     /**
      * Removes an entity from its entity map.
      * Removes any related Node entities that are mapped to the entity
@@ -90,7 +120,7 @@ export declare class EntityMap {
      *   EntityMap.remove(entityId, Components.PositionComponent);
      * ```
      */
-    remove(entityId: number, component: ComponentClass): boolean;
+    remove<T extends IComponent>(entityId: number, component: ComponentClass<T>): boolean;
     /**
      * Removes an entity from its entity map.
      * Removes any related Node entities that are mapped to the entity

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,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,cAAc,EAEpB,MAAM,kBAAkB,CAAC;AAG1B;;;;GAIG;AACH,qBAAa,SAAS;IAGpB,OAAO,CAAC,aAAa,CAA6B;IAElD,OAAO,CAAC,MAAM,CAAY;;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,GAAG,SAAS,EAAE,cAAc,EAAE;IAevC;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,cAAc;IAIhC;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc;IAQ/C;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAShD;;;;;;;;;;OAUG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO;IAQzD;;;;;;;;;OASG;IACH,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,GAAG,CAAC;IAavE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc;IAIlD;;;;;;;;;;OAUG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAgBnD;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM;IAO9B,SAAS;IAKT,KAAK;IAKL;;OAEG;IACH,UAAU;IAKV;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM;IA4BzB;;;;;;;;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,gBAAgB,EACrB,KAAK,cAAc,EAEnB,KAAK,UAAU,EAChB,MAAM,kBAAkB,CAAC;AAG1B;;;;GAIG;AACH,qBAAa,SAAS;IAGpB,OAAO,CAAC,aAAa,CAA6B;IAElD,OAAO,CAAC,MAAM,CAAY;;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE;IAe5C;;OAEG;IACH,MAAM,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS;IAI3F;;;;;;;;OAQG;IACH,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;IAI7D;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;IAI3D;;;;;;;;OAQG;IACH,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;IAI7D;;;;;;;;;OASG;IACH,GAAG,CAAC,CAAC,SAAS,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC;IAQ5E;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAShD;;;;;;;;;;OAUG;IACH,GAAG,CAAC,CAAC,SAAS,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO;IAQlF;;;;;;;;;OASG;IACH,GAAG,CAAC,CAAC,SAAS,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,GAAG,CAAC;IAahE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,CAAC,SAAS,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;IAI3E;;;;;;;;;;OAUG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAgBnD;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM;IAO9B,SAAS;IAKT,KAAK;IAKL;;OAEG;IACH,UAAU;IAKV;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM;IAsBzB;;;;;;;;OAQG;IACH,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,GAAG;CAqBzC"}

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

@@ -3,7 +3,7 @@
  */
 export declare class KeyMap<TKey, TValue> extends Map<TKey, TValue> {
     constructor(entries?: any[]);
-    firstEntry(): [key: any, value: any] | undefined;
+    firstEntry(): [key: TKey, value: TValue] | undefined;
     firstKey(): TKey | undefined;
     firstValue(): TValue | undefined;
     toJSON(): {

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

@@ -1 +1 @@
-{"version":3,"file":"key-map.d.ts","sourceRoot":"","sources":["../../../src/key-map.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,qBAAa,MAAM,CAAC,IAAI,EAAE,MAAM,CAAE,SAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;gBAE7C,OAAO,GAAE,GAAG,EAAO;IAI/B,UAAU,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,SAAS;IAQhD,QAAQ,IAAI,IAAI,GAAG,SAAS;IAQ5B,UAAU,IAAI,MAAM,GAAG,SAAS;IAQhC,MAAM;;;;IAIN,OAAO,CAAC,WAAW,UAAQ,GAAG,GAAG,EAAE;IAcnC;;OAEG;IACH,UAAU,CAAC,WAAW,UAAQ,GAAG,IAAI;IAIrC,OAAO,IAAI,WAAW,CAAC,GAAG,CAAC;IAI3B,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC;IAIxB,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC;IAK1B,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAkB;CAE9C"}
+{"version":3,"file":"key-map.d.ts","sourceRoot":"","sources":["../../../src/key-map.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,qBAAa,MAAM,CAAC,IAAI,EAAE,MAAM,CAAE,SAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;gBAE7C,OAAO,GAAE,GAAG,EAAO;IAI/B,UAAU,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS;IAQpD,QAAQ,IAAI,IAAI,GAAG,SAAS;IAQ5B,UAAU,IAAI,MAAM,GAAG,SAAS;IAQhC,MAAM;;;;IAIN,OAAO,CAAC,WAAW,UAAQ,GAAG,GAAG,EAAE;IAcnC;;OAEG;IACH,UAAU,CAAC,WAAW,UAAQ,GAAG,IAAI;IAIrC,OAAO,IAAI,WAAW,CAAC,GAAG,CAAC;IAI3B,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC;IAIxB,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC;IAK1B,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAkB;CAE9C"}

package/package.json

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

package/src/definitions.ts

@@ -2,12 +2,12 @@ import type { KeyMap } from './key-map.js'
 
 export type KeyCollection<T> = { [key: string]: T }
 
-export class Component { }
+export interface IComponent { }
 
-export type ComponentClass = {
-  new(...args: any[]): Component
+export type ComponentClass<T extends IComponent> = {
+  new(...args: any[]): T
 }
 
-export type ComponentDataMap = KeyMap<number, Component>
+export type ComponentDataMap<T> = KeyMap<number, T>
 
-export type ComponentMap = KeyMap<string, ComponentDataMap>
+export type ComponentMap = KeyMap<string, ComponentDataMap<any>>

package/src/entity-map.ts

@@ -20,10 +20,10 @@
  * @module ecsjs
  */
 import {
-  Component,
   type ComponentDataMap,
   type ComponentClass,
-  type ComponentMap
+  type ComponentMap,
+  type IComponent
 } from './definitions.js';
 import { KeyMap } from './key-map.js'
 
@@ -59,14 +59,14 @@ export class EntityMap {
    *    ecs.register(MyComponent1, MyComponent2);
    * ```
    */
-  register(...component: ComponentClass[]) {
+  register(...component: ComponentClass<any>[]) {
     for (const definition of component) {
       const componentName = definition.name;
       if (componentName === undefined)
         throw new ReferenceError("The component class does not have a name defined. i.e. a constructor name");
 
       // create the component map
-      const componentDataMap: ComponentDataMap = new KeyMap();
+      const componentDataMap: ComponentDataMap<any> = new KeyMap();
       this.componentMaps.set(componentName, componentDataMap);
     }
 
@@ -77,10 +77,49 @@ export class EntityMap {
   /**
    * Retrieves an entity map by it's registered type
    */
-  getMap(component: ComponentClass) {
+  getMap<T extends IComponent>(component: ComponentClass<T>): ComponentDataMap<T> | undefined {
     return this.componentMaps.get(component.name);
   }
 
+  /**
+   * Get the first entity entry for a component class
+   * 
+   * @example
+   *
+   * ```javascript
+   *    const [entityId, player] = ecs.firstEntry(PlayerComponent) ?? [];
+   * ```
+   */
+  firstEntry<T extends IComponent>(component: ComponentClass<T>) {
+    return this.getMap(component)?.firstEntry();
+  }
+
+  /**
+   * Get the first entity id for a component class
+   * 
+   * @example
+   *
+   * ```javascript
+   *    const entityId = ecs.firstKey(PlayerComponent);
+   * ```
+   */
+  firstKey<T extends IComponent>(component: ComponentClass<T>) {
+    return this.getMap(component)?.firstKey();
+  }
+
+  /**
+   * Get the first entity component value for a component class
+   * 
+   * @example
+   *
+   * ```javascript
+   *    const player = ecs.firstValue(PlayerComponent);
+   * ```
+   */
+  firstValue<T extends IComponent>(component: ComponentClass<T>) {
+    return this.getMap(component)?.firstValue();
+  }
+
   /**
    * Retrieves an entity from its registered entity map
    *
@@ -91,7 +130,7 @@ export class EntityMap {
    *   let positionData = ecs.get(entityId, Components.PositionComponent);
    * ```
    */
-  get(entityId: number, component: ComponentClass) {
+  get<T extends IComponent>(entityId: number, component: ComponentClass<T>): T {
     let cm = this.componentMaps.get(component.name);
     if (cm === undefined)
       throw new ReferenceError(`"${component}" component class does not exist in the componentMaps`);
@@ -129,7 +168,7 @@ export class EntityMap {
    *   let exists = ecs.has(entityId, PositionComponent);
    * ```
    */
-  has(entityId: number, component: ComponentClass): boolean {
+  has<T extends IComponent>(entityId: number, component: ComponentClass<T>): boolean {
     // get the component map
     let map = this.componentMaps.get(component.name);
     if (map === undefined) return false
@@ -147,7 +186,7 @@ export class EntityMap {
    *   let playerPos = ecs.set(entityId, new Components.PositionComponent(0, 0));
    * ```
    */
-  set<T extends Component>(entityId: number, componentData: Component): T {
+  set<T extends IComponent>(entityId: number, componentData: T): T {
     // get the component map
     let map = this.componentMaps.get(componentData.constructor.name);
     if (map === undefined)
@@ -171,7 +210,7 @@ export class EntityMap {
    *   EntityMap.remove(entityId, Components.PositionComponent);
    * ```
    */
-  remove(entityId: number, component: ComponentClass) {
+  remove<T extends IComponent>(entityId: number, component: ComponentClass<T>) {
     return this.removeByKey(entityId, component.name);
   }
 
@@ -206,7 +245,7 @@ export class EntityMap {
    * Destroys an entity across all component maps
    */
   destroyEntity(entityId: number) {
-    this.componentMaps.forEach((dataMap: ComponentDataMap) => {
+    this.componentMaps.forEach((dataMap: ComponentDataMap<any>) => {
       if (dataMap.has(entityId)) dataMap.delete(entityId);
     });
   }
@@ -255,12 +294,6 @@ export class EntityMap {
         return new KeyMap(value.iterable);
       }
 
-      // TODO pass in user defined entity types ?
-      // if (value.hasOwnProperty('uniqueid')) {
-      //   Reflect.setPrototypeOf(value, ecs.Entity.prototype);
-      //   return value;
-      // }
-
       return this[key];
     });
 
@@ -280,7 +313,7 @@ export class EntityMap {
    */
   static createWithTracing(funcFilter: any) {
     let traceHandler = {
-      get(target: any, propKey: string, receiver: any) {
+      get(target: any, propKey: string) {
         const targetValue = target[propKey]
 
         if (typeof targetValue === 'function' && (funcFilter.length === 0 || funcFilter.includes(propKey))) {

package/src/key-map.ts

@@ -26,8 +26,8 @@ export class KeyMap<TKey, TValue> extends Map<TKey, TValue> {
     super(entries)
   }
 
-  firstEntry(): [key: any, value: any] | undefined {
-    if (this.size === 0) return [undefined, undefined];
+  firstEntry(): [key: TKey, value: TValue] | undefined {
+    if (this.size === 0) return undefined;
 
     const iterator = this.entries();
     const result = iterator.next();