@flighthq/requirement-codegen 0.5.1-next.1669.c9827a8

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright (c) 2013-2026 Joshua Granick and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @flighthq/requirement-codegen
+
+Emission-neutral planning kernel for selective registry generation
+
+## Install
+
+```sh
+npm install @flighthq/requirement-codegen
+```
+
+Import the supported application-facing API from `@flighthq/requirement-codegen`. The `@flighthq/requirement-codegen/contract` export is the wider package-to-package contract used to compose Flight itself.
+
+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/requirement-codegen@0.5.1-next.1669.c9827a8](https://github.com/flighthq/flight/tree/c9827a8363ff130c75c633b9455fecfcf27c36bb/packages/requirement-codegen)
+- [License](https://github.com/flighthq/flight/blob/c9827a8363ff130c75c633b9455fecfcf27c36bb/LICENSE.md)

package/dist/contract.d.ts

@@ -0,0 +1,3 @@
+export * from './requirementCodegen';
+export { initializeRequirementCodegenPlan } from './requirementCodegen';
+//# sourceMappingURL=contract.d.ts.map

package/dist/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/contract.js

@@ -0,0 +1,3 @@
+export * from './requirementCodegen';
+export { initializeRequirementCodegenPlan } from './requirementCodegen';
+//# sourceMappingURL=contract.js.map

package/dist/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createRequirementCodegenPlan } from './requirementCodegen';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createRequirementCodegenPlan } from './requirementCodegen';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/requirementCodegen.d.ts

@@ -0,0 +1,4 @@
+import type { Entity, EntityConstruction, RequirementCatalog, RequirementCodegenPlan, RequirementSet } from '@flighthq/types/contract';
+export declare function createRequirementCodegenPlan(catalog: Readonly<RequirementCatalog>, requirements: Readonly<RequirementSet>, backend: string): RequirementCodegenPlan & Entity;
+export declare function initializeRequirementCodegenPlan(out: EntityConstruction<RequirementCodegenPlan & Entity>, catalog: Readonly<RequirementCatalog>, requirements: Readonly<RequirementSet>, backend: string): void;
+//# sourceMappingURL=requirementCodegen.d.ts.map

package/dist/requirementCodegen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requirementCodegen.d.ts","sourceRoot":"","sources":["../src/requirementCodegen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,MAAM,EACN,kBAAkB,EAClB,kBAAkB,EAElB,sBAAsB,EAEtB,cAAc,EACf,MAAM,0BAA0B,CAAC;AAElC,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EACrC,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,EACtC,OAAO,EAAE,MAAM,GACd,sBAAsB,GAAG,MAAM,CAIjC;AAID,wBAAgB,gCAAgC,CAC9C,GAAG,EAAE,kBAAkB,CAAC,sBAAsB,GAAG,MAAM,CAAC,EACxD,OAAO,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EACrC,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,EACtC,OAAO,EAAE,MAAM,GACd,IAAI,CAkBN"}

package/dist/requirementCodegen.js

@@ -0,0 +1,34 @@
+import { allocateEntity, finishEntity } from '@flighthq/entity/contract';
+import { findRequirementCatalogEntries } from '@flighthq/requirement-catalog/contract';
+export function createRequirementCodegenPlan(catalog, requirements, backend) {
+    const out = allocateEntity();
+    initializeRequirementCodegenPlan(out, catalog, requirements, backend);
+    return finishEntity(out);
+}
+// Resolve only facts here. A later emitter may choose how a row becomes source after the ownership lane
+// is ruled; this kernel cannot encode that decision accidentally because it returns no source text.
+export function initializeRequirementCodegenPlan(out, catalog, requirements, backend) {
+    const entries = [];
+    const unresolved = [];
+    const seen = new Set();
+    for (const requirement of requirements.requirements) {
+        const identity = requirementIdentity(requirement);
+        if (seen.has(identity))
+            continue;
+        seen.add(identity);
+        const matches = findRequirementCatalogEntries(catalog, backend, requirement.facet, requirement.key);
+        if (matches.length === 0) {
+            unresolved.push({ facet: requirement.facet, key: requirement.key });
+        }
+        else {
+            entries.push(...matches);
+        }
+    }
+    out.backend = backend;
+    out.entries = entries;
+    out.unresolved = unresolved;
+}
+function requirementIdentity(requirement) {
+    return `${requirement.facet}\0${requirement.key}`;
+}
+//# sourceMappingURL=requirementCodegen.js.map

package/dist/requirementCodegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requirementCodegen.js","sourceRoot":"","sources":["../src/requirementCodegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAWvF,MAAM,UAAU,4BAA4B,CAC1C,OAAqC,EACrC,YAAsC,EACtC,OAAe;IAEf,MAAM,GAAG,GAAG,cAAc,EAAmC,CAAC;IAC9D,gCAAgC,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACtE,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED,wGAAwG;AACxG,oGAAoG;AACpG,MAAM,UAAU,gCAAgC,CAC9C,GAAwD,EACxD,OAAqC,EACrC,YAAsC,EACtC,OAAe;IAEf,MAAM,OAAO,GAA8B,EAAE,CAAC;IAC9C,MAAM,UAAU,GAAkB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,YAAY,EAAE,CAAC;QACpD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;YAAE,SAAS;QACjC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACnB,MAAM,OAAO,GAAG,6BAA6B,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;QACpG,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;IACtB,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;IACtB,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;AAC9B,CAAC;AAED,SAAS,mBAAmB,CAAC,WAAkC;IAC7D,OAAO,GAAG,WAAW,CAAC,KAAK,KAAK,WAAW,CAAC,GAAG,EAAE,CAAC;AACpD,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@flighthq/requirement-codegen",
+  "version": "0.5.1-next.1669.c9827a8",
+  "author": "Joshua Granick and other contributors",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/flighthq/flight.git",
+    "directory": "packages/requirement-codegen"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./contract": {
+      "types": "./dist/contract.d.ts",
+      "default": "./dist/contract.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src/**/*.test.ts",
+    "!dist/**/*.test.js",
+    "!dist/**/*.test.d.ts",
+    "!dist/**/*.test.js.map",
+    "!dist/**/*.test.d.ts.map"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "tsc -b --clean",
+    "test": "vitest run --config vitest.config.ts",
+    "test:watch": "vitest --watch --config vitest.config.ts",
+    "prepack": "npm run clean && npm run clean:dist && npm run build",
+    "clean:dist": "tsx ../../scripts/clean-package-dist.ts"
+  },
+  "dependencies": {
+    "@flighthq/entity": "0.5.1-next.1669.c9827a8",
+    "@flighthq/requirement-catalog": "0.5.1-next.1669.c9827a8",
+    "@flighthq/types": "0.5.1-next.1669.c9827a8"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0"
+  },
+  "description": "Emission-neutral planning kernel for selective registry generation",
+  "sideEffects": false
+}

package/src/requirementCodegen.test.ts

@@ -0,0 +1,86 @@
+import { allocateEntity, finishEntity } from '@flighthq/entity/contract';
+import { createRequirementCatalog } from '@flighthq/requirement-catalog/contract';
+import type { RequirementCatalogEntry, RequirementSet } from '@flighthq/types/contract';
+import { EntityRuntimeKey, RequirementFacet } from '@flighthq/types/contract';
+
+import { createRequirementCodegenPlan, initializeRequirementCodegenPlan } from './requirementCodegen';
+
+const shapeRenderer: RequirementCatalogEntry = {
+  backend: 'webgl',
+  facet: RequirementFacet.SceneNodeKind,
+  implementationImport: '@flighthq/scene2d-gl',
+  implementationSymbol: 'glShapeRenderer',
+  kind: 'Shape',
+  registrarImport: '@flighthq/render',
+  registrarSymbol: 'registerNodeRenderer',
+};
+
+const shapeCommands: RequirementCatalogEntry = {
+  ...shapeRenderer,
+  registrarImport: '@flighthq/scene2d-gl',
+  registrarSymbol: 'registerGlShapeCommands',
+};
+
+describe('createRequirementCodegenPlan', () => {
+  it('selects the matching backend rows in requirement and catalog order', () => {
+    const catalog = createRequirementCatalog([shapeRenderer, shapeCommands, { ...shapeRenderer, backend: 'webgpu' }]);
+    const requirements = (() => {
+      const out = allocateEntity<RequirementSet>();
+      out.covers = [RequirementFacet.SceneNodeKind];
+      out.requirements = [
+        { facet: RequirementFacet.SceneNodeKind, key: 'Shape' },
+        { facet: RequirementFacet.SceneNodeKind, key: 'Sprite' },
+      ];
+      return finishEntity(out);
+    })();
+
+    const plan = createRequirementCodegenPlan(catalog, requirements, 'webgl');
+    expect(EntityRuntimeKey in plan).toBe(true);
+    expect(plan).toMatchObject({
+      backend: 'webgl',
+      entries: [shapeRenderer, shapeCommands],
+      unresolved: [{ facet: RequirementFacet.SceneNodeKind, key: 'Sprite' }],
+    });
+  });
+
+  it('deduplicates repeated positive requirements without treating covers as requests', () => {
+    const catalog = createRequirementCatalog([shapeRenderer]);
+    const requirement = { facet: RequirementFacet.SceneNodeKind, key: 'Shape' } as const;
+    const requirements = (() => {
+      const out = allocateEntity<RequirementSet>();
+      out.covers = [RequirementFacet.SceneNodeKind, RequirementFacet.SceneShapeCommand];
+      out.requirements = [requirement, requirement];
+      return finishEntity(out);
+    })();
+
+    expect(createRequirementCodegenPlan(catalog, requirements, 'webgl')).toMatchObject({
+      backend: 'webgl',
+      entries: [shapeRenderer],
+      unresolved: [],
+    });
+  });
+
+  it('returns an empty plan for empty catalog contents and requirements', () => {
+    expect(
+      createRequirementCodegenPlan(
+        createRequirementCatalog(),
+        (() => {
+          const out = allocateEntity<any>();
+          out.covers = [];
+          out.requirements = [];
+          return finishEntity(out);
+        })(),
+        'webgl',
+      ),
+    ).toMatchObject({
+      backend: 'webgl',
+      entries: [],
+      unresolved: [],
+    });
+  });
+});
+describe('initializeRequirementCodegenPlan', () => {
+  it('is the construction initializer of createRequirementCodegenPlan', () => {
+    expect(typeof initializeRequirementCodegenPlan).toBe('function');
+  });
+});