@gate-forge/pack-fastapi 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 UKD
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,171 @@
+# @gate-forge/pack-fastapi — FastAPI server-route detector
+
+Python-AST detector (stdlib only, no app import, no execution, no network)
+served over GPP/3 using the pack-sqlalchemy two-tier structure (ADR 0002):
+the in-process TypeScript wrapper spawns the SAME hardened python plugin
+the subprocess transport runs, so one detector implementation serves both.
+
+## What it finds
+
+- `FastAPI()` app instances and `APIRouter(prefix="…")` routers with
+  **literal** prefixes; computed prefixes emit a typed
+  `FASTAPI_PREFIX_UNRESOLVED` entry (blocking) — never a guess.
+- Route decorators (`@app.get`, `@router.post`, `@router.api_route(
+  methods=[...])`, sync and `async` handlers) with **literal** paths;
+  computed paths emit `HTTP_PATH_DYNAMIC`.
+- Cross-file mount trees: `include_router(...)` with literal prefixes,
+  resolved through scanned-file imports (absolute and relative), including
+  import-aliased router names (`from .routers import router as r`) whose
+  routes merge into the defining router, and module-import attribute
+  chains (`from api.v1 import endpoints` + `endpoints.health.router`).
+  Repeated mounts yield one fact per mount. Unresolvable or ambiguous
+  targets/aliases and include cycles emit `FASTAPI_PREFIX_UNRESOLVED`.
+- Package-attribute imports: `from pkg import attr` where `pkg/attr.py`
+  does not exist resolves `attr` through the package's `__init__.py`
+  module-level bindings — an assignment (`router = APIRouter()`) or an
+  import re-export (`from .endpoints import router`), followed up to 8
+  hops. Ambiguity stays a typed `FASTAPI_PREFIX_UNRESOLVED` entry.
+- **Registry functions** (the central-registrar pattern): a function
+  whose body calls `include_router` on one of its own parameters —
+  `def register_all_routers(app): app.include_router(r, prefix=...)` —
+  has those includes rewired onto whatever the call-site argument names
+  (details below).
+- Verbs outside the supported set (e.g. `@router.trace`) emit
+  `HTTP_METHOD_DYNAMIC` — nothing disappears silently.
+- Per fact: handler symbol, `isAsync`, `response_model`, request schema
+  symbols (non-primitive, non-path parameter annotations), `tags`,
+  `operationId`, and `mountProvenance` (`include-chain` | `standalone`).
+
+## Configuration: `.gateforge/fastapi.json`
+
+Optional, JSON-only, read from the repo root (same precedent as
+pack-http's `.gateforge/http-clients.json`): **absence is normal,
+malformed documents throw.**
+
+```json
+{ "importRoots": ["backend"] }
+```
+
+`importRoots` lists repo-root-relative directories that act as Python
+import roots for ABSOLUTE imports — the central-router-registry pattern
+where one module registers everything
+(`from api.v1.endpoints import activities` /
+`app.include_router(activities.router, prefix="/api/v1")`). With roots
+configured:
+
+- `from api.v1.endpoints import activities` binds the scanned file
+  `<importRoot>/api/v1/endpoints/activities.py` (or its package
+  `__init__.py`), so registry includes resolve and effective paths carry
+  their real prefixes (`/api/v1/activities/{id}`).
+- `from api.v1 import activities` + `activities.router` (the imported
+  name is the module) and deeper chains
+  (`from api.v1 import endpoints` + `endpoints.health.router`) resolve
+  through the same roots.
+- **Uniqueness is mandatory**: a dotted module matching MORE THAN ONE
+  scanned file across the roots is a typed blocking
+  `FASTAPI_PREFIX_UNRESOLVED` entry that names the conflicting files —
+  never a guess. Imports resolving to nothing scanned stay typed-
+  unresolved as usual (closed world: no scan hole is hidden). With roots
+  configured the absolute-import suffix heuristic is disabled (explicit
+  roots govern); relative imports and everything else are unchanged.
+- Without the config file the detector behaves exactly as before.
+
+The in-process wrapper passes the roots to the python scanner as an
+explicit `--import-roots <json-array>` argv flag; the subprocess
+transport can pass the same flag directly.
+
+## Registry functions: `include_router` through a function parameter
+
+Real backends often register every router inside one function
+(`backend/router_registry.py`):
+
+```python
+def register_all_routers(app):        # app is a PARAMETER
+    app.include_router(activities_router, prefix="/api/v1/activities")
+    ...                                # × 79 includes
+
+# server.py
+fastapi_app = FastAPI(...)
+register_all_routers(fastapi_app)     # module-level call site
+```
+
+Without interprocedural support the parameter breaks the mount-graph
+walk: the routers are provably included (so suppressed from standalone
+emission) yet contribute ZERO endpoints. The detector closes that gap,
+bounded and deterministic:
+
+- **Collection**: a top-level function whose body calls
+  `include_router` on one of its own parameters collects those include
+  edges keyed by the parameter (nested functions count for the
+  enclosing top-level function; positional parameters only — call sites
+  bind positionally).
+- **Materialization**: every call site of such a function whose argument
+  resolves to a known `FastAPI()`/`APIRouter()` instance variable — a
+  same-file assignment (module-level **or** factory-local:
+  `def create_app(): app = FastAPI(); register(app)` works because the
+  local instance is walked) or an import binding to another scanned
+  file's instance — receives the edges as ordinary includes on that
+  instance. Provenance is unchanged: `include-chain` at the include
+  call's own source location; repeated call sites duplicate mounts,
+  exactly like written includes.
+- **Chaining**: a registry function may pass its parameter to another
+  helper (`def create_app(app): register_all_routers(app)`) up to
+  **8 helper hops** (`MAX_RESOLUTION_DEPTH`). Chains beyond the bound
+  yield one typed unresolved entry naming the function that would need
+  hop 9 — no silent drop, no guess.
+- **Unresolvable arguments** (a name bound to no known instance, or a
+  computed expression): the honest outcome is a typed
+  `FASTAPI_PREFIX_UNRESOLVED` entry at the exact call site and **no
+  emission** — the routers are provably included somewhere and their
+  source carries prefixes, so prefix-less standalone paths would
+  fabricate routes. A never-called registry function mounts nothing and
+  stays silent (closed world: no scan hole is hidden, and no mount is
+  invented). A parameter name shadowing a same-file instance variable
+  keeps the module-level reading only (no double emission).
+
+## Output model (ADR 0004 D1)
+
+One `http.contract` resource per (effective mounted path, concrete
+method). These are **evidence-only**: the engine-owned graph excludes
+them from business classification (no route/table collision) and the
+endpoint compiler joins them against frontend-call facts
+(`@gate-forge/http-contract`). The TypeScript wrapper fills the canonical
+`normalizedPath` (single canonicalization implementation across
+languages) and mints **no classification signals** (dogfood remediation
+phase 4): the earlier `exposure: route` / `lifecycle.*` signals were
+targeted at the path-derived business name — a guess that mostly names
+no discovered resource (`/admin-bypasses` vs the real table), producing
+`STALE_SIGNAL_TARGET` blockers while adding nothing, since unknown
+exposure defaults `user-facing` and unknown lifecycle operations default
+enabled (ADR 0003 D5). Route→resource linkage belongs to the CLI
+endpoint compiler, which corroborates the candidate name against the
+schema symbols (`requestSchemaSymbols`/`responseSchemaSymbols`) and
+handler names these very facts carry, and blocks ambiguity with typed
+`ENDPOINT_RESOURCE_LINK_UNRESOLVED`. Core's `STALE_SIGNAL_TARGET`
+detection remains for genuinely stale authority signals (declaration
+markers, adapter bindings, read-only declarations).
+
+## Setup
+
+```yaml
+# .gateforge.yml
+plugins:
+  - id: gateforge.pack-fastapi
+    version: 0.1.0
+    transport: in-process
+    module: '@gate-forge/pack-fastapi'
+```
+
+Requires Node >= 20 and `python3` >= 3.11 on PATH; no network at any
+point.
+
+Subprocess transport (equivalent):
+
+```yaml
+plugins:
+  - id: gateforge.pack-fastapi
+    version: 0.1.0
+    transport: subprocess
+    command: ['python3', '-m', 'gateforge_fastapi_detector']
+# with PYTHONPATH=<pack>/python:<plugin-protocol>/python
+```

package/dist/detector.d.ts

@@ -0,0 +1,73 @@
+/** The subprocess command the in-process transport spawns (G4 surface). */
+export declare const DEFAULT_COMMAND: string[];
+/**
+ * The detector's config channel: a JSON document read from the repo root
+ * (same precedent as pack-http's `.gateforge/http-clients.json`). Absence
+ * is normal; a malformed document throws (fail closed).
+ */
+export declare const FASTAPI_SCAN_CONFIG_PATH = ".gateforge/fastapi.json";
+/** Parsed `.gateforge/fastapi.json` document (strict schema). */
+export interface FastapiScanConfig {
+    /**
+     * Repo-root-relative directories that act as Python import roots for
+     * ABSOLUTE imports — the central-router-registry pattern
+     * (`from api.v1.endpoints import activities` +
+     * `app.include_router(activities.router, prefix=...)`). Resolution is
+     * unique or typed-unresolved: an import matching more than one scanned
+     * file across the roots never guesses.
+     */
+    importRoots?: readonly string[];
+}
+export declare const DEFAULT_FASTAPI_SCAN_CONFIG: FastapiScanConfig;
+/**
+ * Reads a fastapi detector config document. Returns the default config
+ * when the file is absent; malformed documents throw (fail closed — the
+ * CLI surfaces the error instead of scanning with partial trust).
+ */
+export declare function readFastapiScanConfigOrNull(path: string | null): FastapiScanConfig;
+/**
+ * Builds the environment the python detector runs under: the host env
+ * plus a `PYTHONPATH` that makes both this pack's detector and the GPP/3
+ * client importable.
+ */
+export declare function pythonEnvironment(extra?: readonly string[]): NodeJS.ProcessEnv;
+/** Options for {@link createFastapiDetector}. */
+export interface FastapiDetectorOptions {
+    /** Subprocess argv (default: `python3 -m gateforge_fastapi_detector`). */
+    command?: readonly string[];
+    /** Subprocess environment (default: {@link pythonEnvironment}). */
+    env?: NodeJS.ProcessEnv;
+    /** Working directory the repo-relative paths resolve against. */
+    cwd?: string;
+    /** Handshake-pinned plugin id (default: the pack id). */
+    pluginId?: string;
+    /** Handshake-pinned plugin version (default: the pack version). */
+    pluginVersion?: string;
+    /**
+     * Explicit import roots (repo-root-relative); overrides the config
+     * document entirely when given.
+     */
+    importRoots?: readonly string[];
+    /**
+     * Repo-relative path of a config document (JSON) read from `cwd` when
+     * `importRoots` is not given (default: `.gateforge/fastapi.json`;
+     * absence is normal, malformed throws).
+     */
+    importRootsConfigPath?: string;
+}
+/** The pinned in-process plugin contract: `{ discover(paths) }`. */
+export interface FastapiDetector {
+    discover(paths: readonly string[]): Promise<{
+        resources: unknown[];
+        unresolved: unknown[];
+        findings: unknown[];
+        classificationSignals: unknown[];
+        scannedPaths?: string[];
+    }>;
+}
+/**
+ * Creates a discover-capable detector module. The default export of the
+ * pack is `createFastapiDetector()` — the CLI in-process contract.
+ */
+export declare function createFastapiDetector(options?: FastapiDetectorOptions): FastapiDetector;
+//# sourceMappingURL=detector.d.ts.map

package/dist/detector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detector.d.ts","sourceRoot":"","sources":["../src/detector.ts"],"names":[],"mappings":"AA4CA,2EAA2E;AAC3E,eAAO,MAAM,eAAe,UAAkD,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,4BAA4B,CAAC;AAElE,iEAAiE;AACjE,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACjC;AAED,eAAO,MAAM,2BAA2B,EAAE,iBAAsB,CAAC;AAsBjE;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,iBAAiB,CAkClF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,GAAE,SAAS,MAAM,EAAO,GAAG,MAAM,CAAC,UAAU,CAGlF;AAED,iDAAiD;AACjD,MAAM,WAAW,sBAAsB;IACrC,0EAA0E;IAC1E,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,iEAAiE;IACjE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mEAAmE;IACnE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,oEAAoE;AACpE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CACN,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,OAAO,CAAC;QACT,SAAS,EAAE,OAAO,EAAE,CAAC;QACrB,UAAU,EAAE,OAAO,EAAE,CAAC;QACtB,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,qBAAqB,EAAE,OAAO,EAAE,CAAC;QACjC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;KACzB,CAAC,CAAC;CACJ;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,GAAE,sBAA2B,GAAG,eAAe,CAuC3F"}

package/dist/detector.js

@@ -0,0 +1,192 @@
+/**
+ * The pack's discover entry: a thin TypeScript GPP/3 client over the
+ * Python AST detector, usable from BOTH CLI transports (the pack-sqlalchemy
+ * pattern; see ADR 0002 for the two-tier boundary).
+ *
+ * - **in-process**: `.gateforge.yml` declares
+ *   `transport: in-process, module: "@gate-forge/pack-fastapi"`; the CLI
+ *   imports this package's default export and calls `discover(paths)`.
+ *   The implementation spawns the SAME python detector (GPP/3, hardened
+ *   host) with a computed `PYTHONPATH`, so one detector implementation
+ *   serves both transports.
+ * - **subprocess**: `.gateforge.yml` declares
+ *   `transport: subprocess, command: ["python3","-m","gateforge_fastapi_detector"]`
+ *   (with the pack's `python/` dir on `PYTHONPATH`); the CLI drives the
+ *   plugin directly — see the README.
+ *
+ * Post-processing (`facts.ts`): effective paths are canonicalized with the
+ * shared `@gate-forge/http-contract` rules. The wrapper mints NO
+ * classification signals (dogfood remediation phase 4): a path-derived
+ * target is a guess that mostly names no discovered resource — route→resource
+ * linkage is the CLI endpoint compiler's exclusive job (schema-symbol/
+ * handler corroboration over the facts this pack emits).
+ *
+ * Determinism: the python scan is pure over (paths, file bytes). The
+ * optional `.gateforge/fastapi.json` config (import roots for absolute
+ * imports, the central-router-registry pattern) is read once at factory
+ * time and passed to the scanner as an explicit `--import-roots` argv
+ * flag — never environment state, never per-request mutation.
+ */
+import { readFileSync } from 'node:fs';
+import { delimiter, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { PluginSession } from '@gate-forge/plugin-protocol';
+import { canonicalizeFacts } from './facts.js';
+import { PACK_PLUGIN_ID, PACK_VERSION } from './version.js';
+/** Absolute dir of this pack's `python/` tree (the detector package). */
+const PACK_PYTHON_DIR = fileURLToPath(new URL('../python', import.meta.url));
+/** Absolute dir of the sibling `@gate-forge/plugin-protocol` python client. */
+const PROTOCOL_PYTHON_DIR = fileURLToPath(new URL('../../../plugin-protocol/python', import.meta.url));
+/** The subprocess command the in-process transport spawns (G4 surface). */
+export const DEFAULT_COMMAND = ['python3', '-m', 'gateforge_fastapi_detector'];
+/**
+ * The detector's config channel: a JSON document read from the repo root
+ * (same precedent as pack-http's `.gateforge/http-clients.json`). Absence
+ * is normal; a malformed document throws (fail closed).
+ */
+export const FASTAPI_SCAN_CONFIG_PATH = '.gateforge/fastapi.json';
+export const DEFAULT_FASTAPI_SCAN_CONFIG = {};
+/** One repo-relative import root, validated (fail closed on malformed). */
+function normalizeImportRoot(raw, path) {
+    if (typeof raw !== 'string') {
+        throw new Error(`invalid fastapi detector config: import roots must be strings at ${path}`);
+    }
+    const stripped = raw.replace(/\\/g, '/').replace(/\/+$/, '');
+    let normalized = stripped;
+    while (normalized.startsWith('./'))
+        normalized = normalized.slice(2);
+    const segments = normalized.split('/');
+    if (normalized === '' || normalized.startsWith('/') || segments.includes('..')) {
+        throw new Error(`invalid fastapi detector config: import root must be a repo-root-relative ` +
+            `directory at ${path}: ${JSON.stringify(raw)}`);
+    }
+    return normalized;
+}
+/**
+ * Reads a fastapi detector config document. Returns the default config
+ * when the file is absent; malformed documents throw (fail closed — the
+ * CLI surfaces the error instead of scanning with partial trust).
+ */
+export function readFastapiScanConfigOrNull(path) {
+    if (path === null)
+        return DEFAULT_FASTAPI_SCAN_CONFIG;
+    let text;
+    try {
+        text = readFileSync(path, 'utf8');
+    }
+    catch {
+        return DEFAULT_FASTAPI_SCAN_CONFIG; // absence is normal; malformed is not (below)
+    }
+    const parsed = JSON.parse(text);
+    if (parsed === null || typeof parsed !== 'object' || Array.isArray(parsed)) {
+        throw new Error(`invalid fastapi detector config: expected an object at ${path}`);
+    }
+    const document = parsed;
+    const unknownKeys = Object.keys(document).filter((key) => key !== 'importRoots');
+    if (unknownKeys.length > 0) {
+        // Strict on purpose: a typo'd key would otherwise silently disable the
+        // import roots and hide exactly the routes they exist to expose.
+        throw new Error(`invalid fastapi detector config: unknown key(s) ` +
+            `${unknownKeys.sort().join(', ')} at ${path}`);
+    }
+    const config = {};
+    const roots = document['importRoots'];
+    if (roots !== undefined) {
+        if (!Array.isArray(roots)) {
+            throw new Error(`invalid fastapi detector config: 'importRoots' must be an array of ` +
+                `repo-root-relative directories at ${path}`);
+        }
+        config.importRoots = roots.map((root) => normalizeImportRoot(root, path));
+    }
+    return config;
+}
+/**
+ * Builds the environment the python detector runs under: the host env
+ * plus a `PYTHONPATH` that makes both this pack's detector and the GPP/3
+ * client importable.
+ */
+export function pythonEnvironment(extra = []) {
+    const entries = [...extra, PACK_PYTHON_DIR, PROTOCOL_PYTHON_DIR];
+    return { ...process.env, PYTHONPATH: entries.join(delimiter) };
+}
+/**
+ * Creates a discover-capable detector module. The default export of the
+ * pack is `createFastapiDetector()` — the CLI in-process contract.
+ */
+export function createFastapiDetector(options = {}) {
+    const command = options.command ?? DEFAULT_COMMAND;
+    const env = options.env ?? pythonEnvironment();
+    const cwd = options.cwd ?? process.cwd();
+    const pluginId = options.pluginId ?? PACK_PLUGIN_ID;
+    const pluginVersion = options.pluginVersion ?? PACK_VERSION;
+    // Explicit roots win; otherwise the config document (absence normal,
+    // malformed throws). With no roots at all the spawned command is
+    // byte-identical to the pre-config surface.
+    const importRoots = options.importRoots ??
+        readFastapiScanConfigOrNull(resolve(cwd, options.importRootsConfigPath ?? FASTAPI_SCAN_CONFIG_PATH))
+            .importRoots ??
+        [];
+    const argv = importRoots.length > 0 ? [...command, '--import-roots', JSON.stringify(importRoots)] : [...command];
+    return {
+        async discover(paths) {
+            if (paths.length === 0) {
+                return { resources: [], unresolved: [], findings: [], classificationSignals: [] };
+            }
+            const session = new PluginSession({
+                command: argv,
+                pluginId,
+                pluginVersion,
+                cwd,
+                env,
+                timeouts: { handshakeMs: 10_000, requestMs: 30_000, shutdownMs: 10_000 },
+            });
+            try {
+                await session.start();
+                const outcome = await session.discover([...paths]);
+                return postprocess(outcome);
+            }
+            finally {
+                await session.dispose();
+            }
+        },
+    };
+}
+/**
+ * Canonicalizes facts and merges the wrapper's unresolved entries with the
+ * python scanner's, keeping the whole outcome deterministic.
+ */
+function postprocess(outcome) {
+    const canonical = canonicalizeFacts(outcome.resources);
+    const unresolved = [
+        ...outcome.unresolved,
+        ...canonical.unresolved,
+    ].sort((a, b) => {
+        const locationA = a['location'];
+        const locationB = b['location'];
+        const fileA = locationA?.['file'] ?? '';
+        const fileB = locationB?.['file'] ?? '';
+        if (fileA !== fileB)
+            return fileA < fileB ? -1 : 1;
+        const lineA = locationA?.['line'] ?? 0;
+        const lineB = locationB?.['line'] ?? 0;
+        if (lineA !== lineB)
+            return lineA - lineB;
+        const codeA = String(a['code'] ?? '');
+        const codeB = String(b['code'] ?? '');
+        if (codeA !== codeB)
+            return codeA < codeB ? -1 : 1;
+        const detailA = String(a['detail'] ?? '');
+        const detailB = String(b['detail'] ?? '');
+        if (detailA === detailB)
+            return 0;
+        return detailA < detailB ? -1 : 1;
+    });
+    return {
+        resources: canonical.resources,
+        unresolved,
+        findings: outcome.findings,
+        classificationSignals: canonical.classificationSignals,
+        ...(outcome.scannedPaths !== undefined ? { scannedPaths: outcome.scannedPaths } : {}),
+    };
+}
+//# sourceMappingURL=detector.js.map

package/dist/detector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detector.js","sourceRoot":"","sources":["../src/detector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,aAAa,EAAyB,MAAM,6BAA6B,CAAC;AACnF,OAAO,EAAE,iBAAiB,EAAyB,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5D,yEAAyE;AACzE,MAAM,eAAe,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE7E,+EAA+E;AAC/E,MAAM,mBAAmB,GAAG,aAAa,CACvC,IAAI,GAAG,CAAC,iCAAiC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAC5D,CAAC;AAEF,2EAA2E;AAC3E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,4BAA4B,CAAC,CAAC;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,yBAAyB,CAAC;AAelE,MAAM,CAAC,MAAM,2BAA2B,GAAsB,EAAE,CAAC;AAEjE,2EAA2E;AAC3E,SAAS,mBAAmB,CAAC,GAAY,EAAE,IAAY;IACrD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,oEAAoE,IAAI,EAAE,CAC3E,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7D,IAAI,UAAU,GAAG,QAAQ,CAAC;IAC1B,OAAO,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,UAAU,KAAK,EAAE,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,KAAK,CACb,4EAA4E;YAC1E,gBAAgB,IAAI,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CACjD,CAAC;IACJ,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,IAAmB;IAC7D,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,2BAA2B,CAAC;IACtD,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,2BAA2B,CAAC,CAAC,8CAA8C;IACpF,CAAC;IACD,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,0DAA0D,IAAI,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,MAAM,QAAQ,GAAG,MAAiC,CAAC;IACnD,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC,CAAC;IACjF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,uEAAuE;QACvE,iEAAiE;QACjE,MAAM,IAAI,KAAK,CACb,kDAAkD;YAChD,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAChD,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,qEAAqE;gBACnE,qCAAqC,IAAI,EAAE,CAC9C,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAA2B,EAAE;IAC7D,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;IACjE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;AACjE,CAAC;AAwCD;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAkC,EAAE;IACxE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,eAAe,CAAC;IACnD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,iBAAiB,EAAE,CAAC;IAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,cAAc,CAAC;IACpD,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,YAAY,CAAC;IAC5D,qEAAqE;IACrE,iEAAiE;IACjE,4CAA4C;IAC5C,MAAM,WAAW,GACf,OAAO,CAAC,WAAW;QACnB,2BAA2B,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,qBAAqB,IAAI,wBAAwB,CAAC,CAAC;aACjG,WAAW;QACd,EAAE,CAAC;IACL,MAAM,IAAI,GACR,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;IAEtG,OAAO;QACL,KAAK,CAAC,QAAQ,CAAC,KAAK;YAClB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,qBAAqB,EAAE,EAAE,EAAE,CAAC;YACpF,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC;gBAChC,OAAO,EAAE,IAAI;gBACb,QAAQ;gBACR,aAAa;gBACb,GAAG;gBACH,GAAG;gBACH,QAAQ,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE;aACzE,CAAC,CAAC;YACH,IAAI,CAAC;gBACH,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;gBACtB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;gBACnD,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;oBAAS,CAAC;gBACT,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YAC1B,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,OAAyB;IAC5C,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,CAAC,SAAwC,CAAC,CAAC;IACtF,MAAM,UAAU,GAAG;QACjB,GAAG,OAAO,CAAC,UAAU;QACrB,GAAG,SAAS,CAAC,UAAU;KACxB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACd,MAAM,SAAS,GAAG,CAAC,CAAC,UAAU,CAA+C,CAAC;QAC9E,MAAM,SAAS,GAAG,CAAC,CAAC,UAAU,CAA+C,CAAC;QAC9E,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACxC,IAAI,KAAK,KAAK,KAAK;YAAE,OAAO,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,KAAK,KAAK,KAAK;YAAE,OAAO,KAAK,GAAG,KAAK,CAAC;QAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACtC,IAAI,KAAK,KAAK,KAAK;YAAE,OAAO,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1C,IAAI,OAAO,KAAK,OAAO;YAAE,OAAO,CAAC,CAAC;QAClC,OAAO,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,OAAO;QACL,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,UAAU;QACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;QACtD,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtF,CAAC;AACJ,CAAC"}