@flighthq/entity 0.3.0 → 0.3.1-next.1041.35b950c

package/dist/enableEntityRuntimeGuards.js

@@ -7,7 +7,7 @@ export function disableEntityRuntimeGuards() {
     setEntityRuntimeWriteGuard(null);
 }
 // Opt-in development guard mode. When enabled, a direct write to an entity's runtime slot — or to an
-// EntityRuntime's binding slot — that bypasses ensureEntityRuntime / attachEntityBinding is reported,
+// EntityRuntime's binding slot — that bypasses attachEntityBinding is reported,
 // making "the write landed on the wrong entity" and raw-slot-poke bugs visible early. The write is still
 // allowed: the guard observes, it does not block.
 //
@@ -27,7 +27,7 @@ function warnOnDirectWrite(slot) {
         return;
     }
     logOnce('entity:direct-runtime-write', LogLevel.Warn, {
-        message: "An entity's runtime slot was written directly. Use ensureEntityRuntime or attachEntityBinding; the write was allowed, but bypassing them is how a runtime ends up on the wrong entity.",
+        message: "An entity's runtime slot was written directly. Use attachEntityBinding, which allocates the slot for you; the write was allowed, but bypassing it is how a runtime ends up on the wrong entity.",
     }, 'entity');
 }
 //# sourceMappingURL=enableEntityRuntimeGuards.js.map

package/dist/enableEntityRuntimeGuards.js.map

@@ -1 +1 @@
-{"version":3,"file":"enableEntityRuntimeGuards.js","sourceRoot":"","sources":["../src/enableEntityRuntimeGuards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAEjF,6FAA6F;AAC7F,MAAM,UAAU,0BAA0B;IACxC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IACjC,0BAA0B,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,qGAAqG;AACrG,sGAAsG;AACtG,yGAAyG;AACzG,kDAAkD;AAClD,EAAE;AACF,2GAA2G;AAC3G,0GAA0G;AAC1G,0GAA0G;AAC1G,uGAAuG;AACvG,MAAM,UAAU,yBAAyB;IACvC,yBAAyB,CAAC,IAAI,CAAC,CAAC;IAChC,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,iBAAiB,CAAC,IAA4B;IACrD,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;QAC5B,OAAO,CACL,6BAA6B,EAC7B,QAAQ,CAAC,IAAI,EACb;YACE,OAAO,EACL,0LAA0L;SAC7L,EACD,QAAQ,CACT,CAAC;QACF,OAAO;IACT,CAAC;IACD,OAAO,CACL,6BAA6B,EAC7B,QAAQ,CAAC,IAAI,EACb;QACE,OAAO,EACL,wLAAwL;KAC3L,EACD,QAAQ,CACT,CAAC;AACJ,CAAC"}
+{"version":3,"file":"enableEntityRuntimeGuards.js","sourceRoot":"","sources":["../src/enableEntityRuntimeGuards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAEjF,6FAA6F;AAC7F,MAAM,UAAU,0BAA0B;IACxC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IACjC,0BAA0B,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,qGAAqG;AACrG,gFAAgF;AAChF,yGAAyG;AACzG,kDAAkD;AAClD,EAAE;AACF,2GAA2G;AAC3G,0GAA0G;AAC1G,0GAA0G;AAC1G,uGAAuG;AACvG,MAAM,UAAU,yBAAyB;IACvC,yBAAyB,CAAC,IAAI,CAAC,CAAC;IAChC,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,iBAAiB,CAAC,IAA4B;IACrD,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;QAC5B,OAAO,CACL,6BAA6B,EAC7B,QAAQ,CAAC,IAAI,EACb;YACE,OAAO,EACL,0LAA0L;SAC7L,EACD,QAAQ,CACT,CAAC;QACF,OAAO;IACT,CAAC;IACD,OAAO,CACL,6BAA6B,EAC7B,QAAQ,CAAC,IAAI,EACb;QACE,OAAO,EACL,iMAAiM;KACpM,EACD,QAAQ,CACT,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flighthq/entity",
-  "version": "0.3.0",
+  "version": "0.3.1-next.1041.35b950c",
   "author": "Joshua Granick and other contributors",
   "license": "MIT",
   "repository": {
@@ -38,8 +38,8 @@
     "clean:dist": "tsx ../../scripts/clean-package-dist.ts"
   },
   "dependencies": {
-    "@flighthq/log": "0.3.0",
-    "@flighthq/types": "0.3.0"
+    "@flighthq/log": "0.3.1-next.1041.35b950c",
+    "@flighthq/types": "0.3.1-next.1041.35b950c"
   },
   "devDependencies": {
     "typescript": "^5.3.0"

package/src/binding.test.ts

@@ -18,6 +18,18 @@ describe('attachEntityBinding', () => {
     attachEntityBinding(entity, binding);
     expect(getEntityRuntime(entity).binding).toStrictEqual(binding);
   });
+
+  it('preserves an existing runtime while assigning its binding', () => {
+    const entity = createEntity();
+    const runtime = createEntityRuntime();
+    const binding = {};
+    entity[EntityRuntimeKey] = runtime;
+
+    attachEntityBinding(entity, binding);
+
+    expect(getEntityRuntime(entity)).toBe(runtime);
+    expect(runtime.binding).toBe(binding);
+  });
 });
 
 describe('getEntityBinding', () => {

package/src/enableEntityRuntimeGuards.test.ts

@@ -46,7 +46,9 @@ describe('enableEntityRuntimeGuards', () => {
       }
     });
     expect(entries.length).toBe(1);
-    expect(messageOf(entries[0])).toContain('ensureEntityRuntime');
+    // Names a function that actually exists: the point of the warning is that the caller can act on it,
+    // and this guard spent its life directing readers to `ensureEntityRuntime`, which never existed.
+    expect(messageOf(entries[0])).toContain('attachEntityBinding');
   });
 
   it('WARNS separately for a direct binding-slot write', () => {

package/src/guards.test.ts

@@ -45,6 +45,41 @@ describe('setEntityRuntimeGuardMode', () => {
     }
     expect(areEntityRuntimeGuardsEnabled()).toBe(false);
   });
+
+  it('stays disabled when Proxy is unavailable', () => {
+    const originalProxy = globalThis.Proxy;
+    let enabled: boolean;
+    Object.defineProperty(globalThis, 'Proxy', { configurable: true, value: undefined, writable: true });
+    try {
+      setEntityRuntimeGuardMode(true);
+      enabled = areEntityRuntimeGuardsEnabled();
+    } finally {
+      Object.defineProperty(globalThis, 'Proxy', { configurable: true, value: originalProxy, writable: true });
+      setEntityRuntimeGuardMode(false);
+    }
+
+    expect(enabled!).toBe(false);
+  });
+
+  it('returns the original values when Proxy disappears after guards are enabled', () => {
+    const entity = createEntity({ x: 1 });
+    const runtime = createEntityRuntime();
+    const originalProxy = globalThis.Proxy;
+    let guardedEntity: typeof entity;
+    let guardedRuntime: typeof runtime;
+    setEntityRuntimeGuardMode(true);
+    Object.defineProperty(globalThis, 'Proxy', { configurable: true, value: undefined, writable: true });
+    try {
+      guardedEntity = createGuardedEntity(entity);
+      guardedRuntime = createGuardedEntityRuntime(runtime);
+    } finally {
+      Object.defineProperty(globalThis, 'Proxy', { configurable: true, value: originalProxy, writable: true });
+      setEntityRuntimeGuardMode(false);
+    }
+
+    expect(guardedEntity!).toBe(entity);
+    expect(guardedRuntime!).toBe(runtime);
+  });
 });
 
 describe('setEntityRuntimeWriteGuard', () => {
@@ -78,4 +113,42 @@ describe('setEntityRuntimeWriteGuard', () => {
       setEntityRuntimeGuardMode(false);
     }
   });
+
+  it('ignores writes to ordinary properties', () => {
+    const slots: EntityRuntimeWriteSlot[] = [];
+    setEntityRuntimeGuardMode(true);
+    setEntityRuntimeWriteGuard((slot) => slots.push(slot));
+    try {
+      const guardedEntity = createGuardedEntity(createEntity({ x: 1 }));
+      guardedEntity.x = 2;
+      const guardedRuntime = createGuardedEntityRuntime(createEntityRuntime()) as ReturnType<
+        typeof createEntityRuntime
+      > & { other?: number };
+      guardedRuntime.other = 3;
+      expect(guardedEntity.x).toBe(2);
+      expect(guardedRuntime.other).toBe(3);
+      expect(slots).toEqual([]);
+    } finally {
+      setEntityRuntimeWriteGuard(null);
+      setEntityRuntimeGuardMode(false);
+    }
+  });
+
+  it('keeps existing proxies silent after guard mode is disabled', () => {
+    const slots: EntityRuntimeWriteSlot[] = [];
+    setEntityRuntimeGuardMode(true);
+    setEntityRuntimeWriteGuard((slot) => slots.push(slot));
+    const guardedEntity = createGuardedEntity(createEntity());
+    const guardedRuntime = createGuardedEntityRuntime(createEntityRuntime());
+    setEntityRuntimeGuardMode(false);
+    try {
+      guardedEntity[EntityRuntimeKey] = undefined;
+      guardedRuntime.binding = {};
+      expect(slots).toEqual([]);
+      expect(guardedRuntime.binding).toEqual({});
+    } finally {
+      setEntityRuntimeWriteGuard(null);
+      setEntityRuntimeGuardMode(false);
+    }
+  });
 });