@driftengine/entities 4.8.1 → 4.8.3

package/dist/prefab.d.ts

@@ -16,6 +16,13 @@ export interface Prefab {
     readonly name: string;
     readonly components: readonly (readonly [ComponentType, Readonly<Record<string, unknown>>])[];
 }
+/**
+ * A prefab, refused here if it names a field one of its components does not have.
+ *
+ * **At definition rather than at the first spawn**, which is the same refusal `World.add` makes,
+ * moved to where a game builds its content: a misspelt field found the first time a rare enemy
+ * spawns is found by a player.
+ */
 export declare function definePrefab(name: string, components: readonly (readonly [ComponentType, Readonly<Record<string, unknown>>])[]): Prefab;
 /**
  * Make one.

package/dist/prefab.js

@@ -1,4 +1,19 @@
+/**
+ * A prefab, refused here if it names a field one of its components does not have.
+ *
+ * **At definition rather than at the first spawn**, which is the same refusal `World.add` makes,
+ * moved to where a game builds its content: a misspelt field found the first time a rare enemy
+ * spawns is found by a player.
+ */
 export function definePrefab(name, components) {
+    for (const [type, values] of components) {
+        for (const field of Object.keys(values)) {
+            if (type.schema.fields.some((declared) => declared.name === field))
+                continue;
+            throw new Error(`\`${name}\` gives \`${type.name}\` a field \`${field}\` it does not have. It has ` +
+                `${type.schema.fields.map((declared) => `\`${declared.name}\``).join(', ')}.`);
+        }
+    }
     return { name, components };
 }
 /**

package/dist/store.d.ts

@@ -124,6 +124,8 @@ export declare class ComponentStore {
      * not carry an object per field name it will never hand out.
      */
     private viewObject;
+    /** The schema's own field names, which a value handed to `add` must be among. */
+    private readonly fieldNames;
     constructor(type: ComponentType, options?: ComponentStoreOptions);
     get size(): number;
     /** The entities this store holds, oldest first. Valid up to `size`; the rest is capacity. */

package/dist/store.js

@@ -184,12 +184,15 @@ export class ComponentStore {
      * not carry an object per field name it will never hand out.
      */
     viewObject = null;
+    /** The schema's own field names, which a value handed to `add` must be among. */
+    fieldNames = new Set();
     constructor(type, options = {}) {
         this.type = type;
         const capacity = Math.max(1, options.capacity ?? 16);
         this.denseArray = new Float64Array(capacity);
         this.sparse = new Int32Array(64).fill(-1);
         for (const field of type.schema.fields) {
+            this.fieldNames.add(field.name);
             const inner = optionInner(field.type);
             const declared = inner ?? field.type;
             /* A discriminant is an integer, so it takes an integer column rather than being boxed. */
@@ -247,6 +250,16 @@ export class ComponentStore {
                 this.write(entity, field, value);
             return;
         }
+        /*
+         * **A key the schema does not declare is refused before anything is stored**, as `write` and
+         * `defineComponent`'s defaults refuse one. The loop below walks the schema and never looked at
+         * the other keys, so a misspelt field was dropped without a word and the field it meant took
+         * its default; one consumer's had been dropped since the component was written.
+         */
+        for (const field in values) {
+            if (!this.fieldNames.has(field))
+                throw new Error(this.noField(field));
+        }
         const at = this.count;
         this.grow(at + 1);
         this.growSparse(entityIndex(entity) + 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driftengine/entities",
-  "version": "4.8.1",
+  "version": "4.8.3",
   "description": "Entities with generational identity, component storage, systems and scenes",
   "license": "Apache-2.0",
   "type": "module",
@@ -27,7 +27,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "driftscript": "1.16.0"
+    "driftscript": "1.17.0"
   },
   "author": "Drift Technologies",
   "repository": {

package/src/prefab.ts

@@ -18,10 +18,26 @@ export interface Prefab {
   readonly components: readonly (readonly [ComponentType, Readonly<Record<string, unknown>>])[];
 }
 
+/**
+ * A prefab, refused here if it names a field one of its components does not have.
+ *
+ * **At definition rather than at the first spawn**, which is the same refusal `World.add` makes,
+ * moved to where a game builds its content: a misspelt field found the first time a rare enemy
+ * spawns is found by a player.
+ */
 export function definePrefab(
   name: string,
   components: readonly (readonly [ComponentType, Readonly<Record<string, unknown>>])[],
 ): Prefab {
+  for (const [type, values] of components) {
+    for (const field of Object.keys(values)) {
+      if (type.schema.fields.some((declared) => declared.name === field)) continue;
+      throw new Error(
+        `\`${name}\` gives \`${type.name}\` a field \`${field}\` it does not have. It has ` +
+          `${type.schema.fields.map((declared) => `\`${declared.name}\``).join(', ')}.`,
+      );
+    }
+  }
   return { name, components };
 }
 

package/src/store.ts

@@ -312,12 +312,16 @@ export class ComponentStore {
    */
   private viewObject: ComponentView | null = null;
 
+  /** The schema's own field names, which a value handed to `add` must be among. */
+  private readonly fieldNames = new Set<string>();
+
   constructor(type: ComponentType, options: ComponentStoreOptions = {}) {
     this.type = type;
     const capacity = Math.max(1, options.capacity ?? 16);
     this.denseArray = new Float64Array(capacity);
     this.sparse = new Int32Array(64).fill(-1);
     for (const field of type.schema.fields) {
+      this.fieldNames.add(field.name);
       const inner = optionInner(field.type);
       const declared = inner ?? field.type;
       /* A discriminant is an integer, so it takes an integer column rather than being boxed. */
@@ -381,6 +385,15 @@ export class ComponentStore {
       for (const [field, value] of Object.entries(values)) this.write(entity, field, value);
       return;
     }
+    /*
+     * **A key the schema does not declare is refused before anything is stored**, as `write` and
+     * `defineComponent`'s defaults refuse one. The loop below walks the schema and never looked at
+     * the other keys, so a misspelt field was dropped without a word and the field it meant took
+     * its default; one consumer's had been dropped since the component was written.
+     */
+    for (const field in values) {
+      if (!this.fieldNames.has(field)) throw new Error(this.noField(field));
+    }
 
     const at = this.count;
     this.grow(at + 1);