@flighthq/entity 0.5.0-next.1944.cd6b6e7 → 0.5.1-edge.638.d4dbd4e

package/README.md

@@ -13,5 +13,5 @@ Import the supported application-facing API from `@flighthq/entity`. The `@fligh
 This package is part of the locked-version Flight SDK graph. Applications may instead install and import `@flighthq/sdk` when package-level tree shaking is sufficient.
 
 - [Flight project](https://github.com/flighthq/flight)
-- [Source for @flighthq/entity@0.5.0-next.1944.cd6b6e7](https://github.com/flighthq/flight/tree/cd6b6e71eb472b3a4249830a7743333f019fa7b7/packages/entity)
-- [License](https://github.com/flighthq/flight/blob/cd6b6e71eb472b3a4249830a7743333f019fa7b7/LICENSE.md)
+- [Source for @flighthq/entity@0.5.1-edge.638.d4dbd4e](https://github.com/flighthq/flight/tree/d4dbd4e347dc8be10b180c85a766ab50333dcb51/packages/entity)
+- [License](https://github.com/flighthq/flight/blob/d4dbd4e347dc8be10b180c85a766ab50333dcb51/LICENSE.md)

package/dist/contract.d.ts

@@ -2,6 +2,8 @@ export * from './binding';
 export * from './clone';
 export * from './entity';
 export * from './enableEntityRuntimeGuards';
+export * from './entityUid';
 export * from './guards';
+export * from './host';
 export * from './runtime';
 //# sourceMappingURL=contract.d.ts.map

package/dist/contract.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,6BAA6B,CAAC;AAC5C,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC"}

package/dist/contract.js

@@ -2,6 +2,8 @@ export * from './binding';
 export * from './clone';
 export * from './entity';
 export * from './enableEntityRuntimeGuards';
+export * from './entityUid';
 export * from './guards';
+export * from './host';
 export * from './runtime';
 //# sourceMappingURL=contract.js.map

package/dist/contract.js.map

@@ -1 +1 @@
-{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,6BAA6B,CAAC;AAC5C,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC"}

package/dist/entityUid.d.ts

@@ -0,0 +1,4 @@
+import type { Entity } from '@flighthq/types/contract';
+export declare function getEntityUid(source: Entity): string;
+export declare function setEntityUid(source: Entity, uid: string): void;
+//# sourceMappingURL=entityUid.d.ts.map

package/dist/entityUid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityUid.d.ts","sourceRoot":"","sources":["../src/entityUid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,0BAA0B,CAAC;AAKtE,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAMnD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAG9D"}

package/dist/entityUid.js

@@ -0,0 +1,25 @@
+import { EntityRuntimeKey } from '@flighthq/types/contract';
+import { createEntityRuntime } from './runtime';
+export function getEntityUid(source) {
+    const runtime = ensureEntityRuntime(source);
+    if (runtime.uid !== undefined)
+        return runtime.uid;
+    const uid = generateEntityUid();
+    runtime.uid = uid;
+    return uid;
+}
+export function setEntityUid(source, uid) {
+    const runtime = ensureEntityRuntime(source);
+    runtime.uid = uid;
+}
+function ensureEntityRuntime(source) {
+    if (source[EntityRuntimeKey] === undefined) {
+        source[EntityRuntimeKey] = createEntityRuntime();
+    }
+    return source[EntityRuntimeKey];
+}
+function generateEntityUid() {
+    return `entity-${_nextEntityUidCounter++}`;
+}
+let _nextEntityUidCounter = 1;
+//# sourceMappingURL=entityUid.js.map

package/dist/entityUid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityUid.js","sourceRoot":"","sources":["../src/entityUid.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC;IAClD,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;IAChC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;IAClB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,GAAW;IACtD,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5C,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AACpB,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAc;IACzC,IAAI,MAAM,CAAC,gBAAgB,CAAC,KAAK,SAAS,EAAE,CAAC;QAC3C,MAAM,CAAC,gBAAgB,CAAC,GAAG,mBAAmB,EAAE,CAAC;IACnD,CAAC;IACD,OAAO,MAAM,CAAC,gBAAgB,CAAE,CAAC;AACnC,CAAC;AAED,SAAS,iBAAiB;IACxB,OAAO,UAAU,qBAAqB,EAAE,EAAE,CAAC;AAC7C,CAAC;AAED,IAAI,qBAAqB,GAAG,CAAC,CAAC"}

package/dist/host.d.ts

@@ -0,0 +1,3 @@
+import type { EntityWithoutRuntime, Host } from '@flighthq/types/contract';
+export declare function createHost<Capabilities extends Partial<EntityWithoutRuntime<Host>>>(capabilities?: Readonly<Capabilities>): Host & Capabilities;
+//# sourceMappingURL=host.d.ts.map

package/dist/host.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAI3E,wBAAgB,UAAU,CAAC,YAAY,SAAS,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EACjF,YAAY,GAAE,QAAQ,CAAC,YAAY,CAAsB,GACxD,IAAI,GAAG,YAAY,CA8BrB"}

package/dist/host.js

@@ -0,0 +1,33 @@
+import { createEntity } from './entity';
+export function createHost(capabilities = {}) {
+    return createEntity({
+        accessibility: {},
+        app: {},
+        clipboard: {},
+        connectivity: {},
+        dialog: {},
+        graphics: {},
+        input: {},
+        ipc: {},
+        media: {},
+        menu: {},
+        midi: {},
+        net: {},
+        notification: {},
+        power: {},
+        protocol: {},
+        screen: {},
+        share: {},
+        shell: {},
+        shortcut: {},
+        storage: {},
+        system: {},
+        text: {},
+        tray: {},
+        ui: {},
+        updater: {},
+        window: {},
+        ...capabilities,
+    });
+}
+//# sourceMappingURL=host.js.map

package/dist/host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.js","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,MAAM,UAAU,UAAU,CACxB,eAAuC,EAAkB;IAEzD,OAAO,YAAY,CAAC;QAClB,aAAa,EAAE,EAAE;QACjB,GAAG,EAAE,EAAE;QACP,SAAS,EAAE,EAAE;QACb,YAAY,EAAE,EAAE;QAChB,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,EAAE;QACZ,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,KAAK,EAAE,EAAE;QACT,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;QACR,GAAG,EAAE,EAAE;QACP,YAAY,EAAE,EAAE;QAChB,KAAK,EAAE,EAAE;QACT,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,EAAE;QACT,KAAK,EAAE,EAAE;QACT,QAAQ,EAAE,EAAE;QACZ,OAAO,EAAE,EAAE;QACX,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;QACR,EAAE,EAAE,EAAE;QACN,OAAO,EAAE,EAAE;QACX,MAAM,EAAE,EAAE;QACV,GAAG,YAAY;KAChB,CAAC,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export {} from './contract';
+export { getEntityUid, setEntityUid } from './contract';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -1,2 +1,2 @@
-export {};
+export { getEntityUid, setEntityUid } from './contract';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flighthq/entity",
-  "version": "0.5.0-next.1944.cd6b6e7",
+  "version": "0.5.1-edge.638.d4dbd4e",
   "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.5.0-next.1944.cd6b6e7",
-    "@flighthq/types": "0.5.0-next.1944.cd6b6e7"
+    "@flighthq/log": "0.5.1-edge.638.d4dbd4e",
+    "@flighthq/types": "0.5.1-edge.638.d4dbd4e"
   },
   "devDependencies": {
     "typescript": "^5.3.0"

package/src/entityUid.test.ts

@@ -0,0 +1,64 @@
+import { EntityRuntimeKey } from '@flighthq/types/contract';
+
+import { createEntity } from './entity';
+import { getEntityUid, setEntityUid } from './entityUid';
+import { createEntityRuntime } from './runtime';
+
+describe('getEntityUid', () => {
+  it('has no uid property on an untouched runtime before any access', () => {
+    const entity = createEntity();
+    entity[EntityRuntimeKey] = createEntityRuntime();
+    expect('uid' in entity[EntityRuntimeKey]!).toBe(false);
+  });
+
+  it('lazily generates a uid on first access', () => {
+    const entity = createEntity();
+    const uid = getEntityUid(entity);
+    expect(uid).toEqual(expect.any(String));
+    expect(uid.length).toBeGreaterThan(0);
+  });
+
+  it('returns the same uid on repeated access', () => {
+    const entity = createEntity();
+    const first = getEntityUid(entity);
+    const second = getEntityUid(entity);
+    expect(second).toBe(first);
+  });
+
+  it('generates distinct uids for different entities', () => {
+    const a = createEntity();
+    const b = createEntity();
+    expect(getEntityUid(a)).not.toBe(getEntityUid(b));
+  });
+
+  it('creates the runtime if the entity has none', () => {
+    const entity = createEntity();
+    expect(entity[EntityRuntimeKey]).toBeUndefined();
+    getEntityUid(entity);
+    expect(entity[EntityRuntimeKey]).toBeDefined();
+  });
+});
+
+describe('setEntityUid', () => {
+  it('sets a stable id before any get', () => {
+    const entity = createEntity();
+    setEntityUid(entity, 'my-stable-id');
+    expect(getEntityUid(entity)).toBe('my-stable-id');
+  });
+
+  it('replaces a previously generated uid', () => {
+    const entity = createEntity();
+    const generated = getEntityUid(entity);
+    setEntityUid(entity, 'override');
+    expect(getEntityUid(entity)).toBe('override');
+    expect(getEntityUid(entity)).not.toBe(generated);
+  });
+
+  it('creates the runtime if the entity has none', () => {
+    const entity = createEntity();
+    expect(entity[EntityRuntimeKey]).toBeUndefined();
+    setEntityUid(entity, 'pre-bind');
+    expect(entity[EntityRuntimeKey]).toBeDefined();
+    expect(getEntityUid(entity)).toBe('pre-bind');
+  });
+});

package/src/host.test.ts

@@ -0,0 +1,71 @@
+import { EntityRuntimeKey } from '@flighthq/types/contract';
+
+import * as entity from './contract';
+
+const HOST_GROUPS = [
+  'accessibility',
+  'app',
+  'clipboard',
+  'connectivity',
+  'dialog',
+  'graphics',
+  'input',
+  'ipc',
+  'media',
+  'menu',
+  'midi',
+  'net',
+  'notification',
+  'power',
+  'protocol',
+  'screen',
+  'share',
+  'shell',
+  'shortcut',
+  'storage',
+  'system',
+  'text',
+  'tray',
+  'ui',
+  'updater',
+  'window',
+] as const;
+
+describe('createHost', () => {
+  it('creates an Entity immediately while leaving its runtime allocation lazy', () => {
+    const host = requiredFunction(entity, 'createHost')();
+
+    expect(EntityRuntimeKey in host).toBe(true);
+    expect(host[EntityRuntimeKey]).toBeUndefined();
+  });
+
+  it('materializes the complete stable Host shape with truthful empty groups', () => {
+    const host = requiredFunction(entity, 'createHost')();
+
+    expect(
+      Object.keys(host)
+        .filter((key) => key !== String(EntityRuntimeKey))
+        .sort(),
+    ).toEqual(HOST_GROUPS);
+    for (const group of HOST_GROUPS) expect(host[group]).toEqual({});
+  });
+
+  it('preserves supplied capability-group and provider identities without populating another group', () => {
+    const provider = {};
+    const accessibility = { provider };
+    const host = requiredFunction(entity, 'createHost')({ accessibility });
+
+    expect(host.accessibility).toBe(accessibility);
+    expect(host.accessibility.provider).toBe(provider);
+    for (const group of HOST_GROUPS) {
+      if (group !== 'accessibility') expect(host[group]).toEqual({});
+    }
+  });
+});
+
+function requiredFunction(module: object, name: string): (...args: any[]) => any {
+  const value = Reflect.get(module, name);
+  expect(value, `${name} export`).toBeTypeOf('function');
+  if (typeof value !== 'function') throw new TypeError(`${name} is not exported`);
+  return value as (...args: any[]) => any;
+}