@askdb/introspect 0.3.0-beta.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 accept and charge a
+      fee for, the 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 Yahya Gilany
+
+   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/NOTICE

@@ -0,0 +1,10 @@
+AskDB
+Copyright 2026 Yahya Gilany
+
+This product includes software developed by Yahya Gilany and contributors.
+
+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

package/README.md

@@ -0,0 +1,56 @@
+# `@askdb/introspect`
+
+Engine-agnostic introspection orchestrator for AskDB. Defines the `Connector` contract and turns the integration package's `SqlSchema` output into a Schema v2 directory.
+
+> Status: pre-1.0. `@askdb/introspect` itself does not bundle any engine support — integration packages (e.g. `@askdb/postgres`, `@askdb/prisma`) supply connectors and input shapes.
+
+## Install
+
+```bash
+pnpm add @askdb/introspect @askdb/core
+# Plus an integration package for the engine you're targeting, e.g.:
+pnpm add @askdb/postgres pg
+# Or for Prisma schema-file introspection:
+pnpm add @askdb/prisma
+```
+
+## Programmatic usage
+
+```ts
+import { introspect } from "@askdb/introspect";
+import { createPostgresCatalogQueryRunner, createPostgresConnector } from "@askdb/postgres";
+
+const result = await introspect(
+  { mode: "live", runner: createPostgresCatalogQueryRunner(process.env.DATABASE_URL!) },
+  { outDir: "./my-app.schema", schemaId: "my-app" },
+  { connector: createPostgresConnector() },
+);
+```
+
+The output directory contains a physical Schema v2 artifact (`schema.json`) plus the Phase 5 describable layer.
+
+For Prisma projects, use `@askdb/prisma` to read schema files without connecting to the database:
+
+```ts
+import { introspect } from "@askdb/introspect";
+import { createPrismaConnector } from "@askdb/prisma";
+
+const result = await introspect(
+  { schemaPath: "./prisma", schemaId: "my-app" },
+  { outDir: "./my-app.schema", schemaId: "my-app" },
+  { connector: createPrismaConnector() },
+);
+```
+
+## CLI
+
+The user-facing CLI for introspection ships in the [`askdb`](https://www.npmjs.com/package/askdb) package as `askdb introspect`. `@askdb/introspect` does not provide a standalone binary.
+
+## Implementing a new connector
+
+A `Connector<TInput>` has two methods:
+
+- `describe(input: TInput): Promise<IntrospectionResult>` — the integration's input shape goes through unchanged.
+- `templates?(): SqlTemplateBundle` — optional; only relevant for engines that introspect via catalog SQL.
+
+The integration package owns its own input type (e.g. `PostgresIntrospectionInput`, `PrismaIntrospectionInput`). `@askdb/introspect` does not assume a live catalog runner exists, a bundle path exists, a schema-file path exists, or a template suite exists.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export type { SqlSchema, SqlNamespace, SqlTable, SqlColumn, SqlForeignKey, SqlForeignKeyAction, SqlUnique, SqlIndex, SqlCheck, SqlEnum, SqlSequence, SqlView, IntrospectionFilters, IntrospectionResult, IntrospectionWarning, SqlTemplate, SqlTemplateBundle, CatalogQueryResult, CatalogQueryRunner, Connector, } from "./types.js";
+export type { RenderOptions, RenderResult } from "./render/types.js";
+export { introspect, type IntrospectOptions, type IntrospectResult, } from "./introspect.js";
+export { renderToSchemaV2, toV2SchemaJson, compactPostgresType } from "./render/render.js";
+//# 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,YAAY,EACV,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,aAAa,EACb,mBAAmB,EACnB,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,WAAW,EACX,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,SAAS,GACV,MAAM,YAAY,CAAC;AAEpB,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EACL,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { introspect, } from "./introspect.js";
+export { renderToSchemaV2, toV2SchemaJson, compactPostgresType } from "./render/render.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EACL,UAAU,GAGX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/introspect.d.ts

@@ -0,0 +1,24 @@
+import type { Connector, IntrospectionResult } from "./types.js";
+import type { RenderOptions, RenderResult } from "./render/types.js";
+/**
+ * Options for the introspection orchestrator. The `connector` is the integration package's
+ * `Connector` (e.g. `createPostgresConnector()` from `@askdb/postgres`). Engine-agnostic
+ * introspect has no default — callers wire up the integration explicitly.
+ */
+export type IntrospectOptions<TInput> = {
+    connector: Connector<TInput>;
+};
+export type IntrospectResult = IntrospectionResult & {
+    /** Present when `renderOptions` was supplied; points at the written `schema.json`. */
+    render?: RenderResult;
+};
+/**
+ * Run an integration connector against the given input and (optionally) render the result
+ * into a Schema v2 directory.
+ *
+ * The input shape is owned by the integration package — for `@askdb/postgres` it is
+ * `PostgresIntrospectionInput` (live or from-export). For a future Prisma integration it
+ * would be a `schema.prisma` file path.
+ */
+export declare function introspect<TInput>(input: TInput, renderOptions: RenderOptions | undefined, options: IntrospectOptions<TInput>): Promise<IntrospectResult>;
+//# sourceMappingURL=introspect.d.ts.map

package/dist/introspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.d.ts","sourceRoot":"","sources":["../src/introspect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGrE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,MAAM,IAAI;IACtC,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG;IACnD,sFAAsF;IACtF,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,MAAM,EACrC,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,GACjC,OAAO,CAAC,gBAAgB,CAAC,CAW3B"}

package/dist/introspect.js

@@ -0,0 +1,21 @@
+import { renderToSchemaV2 } from "./render/render.js";
+/**
+ * Run an integration connector against the given input and (optionally) render the result
+ * into a Schema v2 directory.
+ *
+ * The input shape is owned by the integration package — for `@askdb/postgres` it is
+ * `PostgresIntrospectionInput` (live or from-export). For a future Prisma integration it
+ * would be a `schema.prisma` file path.
+ */
+export async function introspect(input, renderOptions, options) {
+    const result = await options.connector.describe(input);
+    if (!renderOptions)
+        return result;
+    const render = renderToSchemaV2(result.schema, renderOptions);
+    return {
+        ...result,
+        warnings: [...result.warnings, ...render.warnings],
+        render,
+    };
+}
+//# sourceMappingURL=introspect.js.map

package/dist/introspect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.js","sourceRoot":"","sources":["../src/introspect.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAgBtD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,KAAa,EACb,aAAwC,EACxC,OAAkC;IAElC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAEvD,IAAI,CAAC,aAAa;QAAE,OAAO,MAAM,CAAC;IAElC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC9D,OAAO;QACL,GAAG,MAAM;QACT,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;QAClD,MAAM;KACP,CAAC;AACJ,CAAC"}

package/dist/render/render.d.ts

@@ -0,0 +1,34 @@
+import { type V2SchemaJson } from "@askdb/core";
+import type { SqlSchema } from "../types.js";
+import type { RenderOptions, RenderResult } from "./types.js";
+/**
+ * Render a `SqlSchema` to a Schema v2 directory.
+ *
+ * Clean writes and ID-anchored re-introspection merges write `schema.json`
+ * only. The describable layer (`tables/*.md`, `concepts.md`) is read only for
+ * orphan detection when `existingArtifactDir` is supplied.
+ *
+ * Determinism contract (requirements.md §5):
+ *   - Schemas alphabetical at the source (the connector already produces
+ *     this); tables alphabetical by `(schema, name)` in the emitted v2 file.
+ *   - Columns in `ordinalPosition` order.
+ *   - FKs sorted by constraint name; `relationships[]` derived in the same
+ *     order so the file is byte-identical across runs.
+ *
+ * Output format: `JSON.stringify(value, null, 2) + "\n"` (matches the
+ * hand-authored Phase 5 fixtures).
+ */
+export declare function renderToSchemaV2(schema: SqlSchema, options: RenderOptions): RenderResult;
+/**
+ * Pure-function form of {@link renderToSchemaV2} — exposed so callers (and
+ * M6's merge) can produce the V2 JSON without writing it to disk.
+ */
+export declare function toV2SchemaJson(schema: SqlSchema, schemaId: string): V2SchemaJson;
+/**
+ * Map Postgres `format_type` strings to the short names AskDB Schema v2
+ * uses in its hand-authored fixtures. Only the standard SQL ↔ pg-short-name
+ * aliases are touched; unknown strings (and length/precision modifiers)
+ * pass through unchanged.
+ */
+export declare function compactPostgresType(dataType: string, _udtName: string): string;
+//# sourceMappingURL=render.d.ts.map

package/dist/render/render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/render/render.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,KAAK,YAAY,EAGlB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAIV,SAAS,EAEV,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE9D;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,aAAa,GACrB,YAAY,CAad;AA2HD;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,SAAS,EACjB,QAAQ,EAAE,MAAM,GACf,YAAY,CAqBd;AAkED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,MAAM,CAaR"}

package/dist/render/render.js

@@ -0,0 +1,225 @@
+import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync, } from "node:fs";
+import { join, resolve } from "node:path";
+import { parseTableMarkdown, } from "@askdb/core";
+/**
+ * Render a `SqlSchema` to a Schema v2 directory.
+ *
+ * Clean writes and ID-anchored re-introspection merges write `schema.json`
+ * only. The describable layer (`tables/*.md`, `concepts.md`) is read only for
+ * orphan detection when `existingArtifactDir` is supplied.
+ *
+ * Determinism contract (requirements.md §5):
+ *   - Schemas alphabetical at the source (the connector already produces
+ *     this); tables alphabetical by `(schema, name)` in the emitted v2 file.
+ *   - Columns in `ordinalPosition` order.
+ *   - FKs sorted by constraint name; `relationships[]` derived in the same
+ *     order so the file is byte-identical across runs.
+ *
+ * Output format: `JSON.stringify(value, null, 2) + "\n"` (matches the
+ * hand-authored Phase 5 fixtures).
+ */
+export function renderToSchemaV2(schema, options) {
+    const warnings = [];
+    const fresh = toV2SchemaJson(schema, options.schemaId);
+    const v2 = options.existingArtifactDir
+        ? mergeWithExistingArtifact(fresh, options.existingArtifactDir, warnings)
+        : fresh;
+    mkdirSync(options.outDir, { recursive: true });
+    const schemaJsonPath = resolve(options.outDir, "schema.json");
+    const body = JSON.stringify(v2, null, 2) + "\n";
+    writeFileSync(schemaJsonPath, body, "utf8");
+    return { schemaJsonPath, warnings };
+}
+function mergeWithExistingArtifact(fresh, existingArtifactDir, warnings) {
+    const existing = readExistingPhysical(existingArtifactDir);
+    const existingTables = new Map(existing.tables.map((table) => [table.id, table]));
+    const existingColumns = new Map();
+    for (const table of existing.tables) {
+        for (const column of table.columns) {
+            existingColumns.set(column.id, column);
+        }
+    }
+    for (const table of fresh.tables) {
+        const existingTable = existingTables.get(table.id);
+        if (existingTable?.sensitive !== undefined) {
+            table.sensitive = existingTable.sensitive;
+        }
+        for (const column of table.columns) {
+            const existingColumn = existingColumns.get(column.id);
+            if (existingColumn) {
+                if (existingColumn.sensitive !== undefined) {
+                    column.sensitive = existingColumn.sensitive;
+                }
+            }
+            else {
+                warnings.push({ code: "new_column", id: column.id, tableId: table.id });
+            }
+        }
+    }
+    warnings.push(...findOrphanWarnings(existingArtifactDir, fresh));
+    return fresh;
+}
+function readExistingPhysical(existingArtifactDir) {
+    const schemaJsonPath = resolve(existingArtifactDir, "schema.json");
+    const parsed = JSON.parse(readFileSync(schemaJsonPath, "utf8"));
+    return assertV2SchemaJson(parsed, schemaJsonPath);
+}
+function assertV2SchemaJson(value, filePath) {
+    if (!isRecord(value) || value.version !== 2) {
+        throw new Error(`@askdb/introspect: invalid Schema v2 file at ${filePath}`);
+    }
+    if (typeof value.schemaId !== "string" || !Array.isArray(value.tables)) {
+        throw new Error(`@askdb/introspect: invalid Schema v2 file at ${filePath}`);
+    }
+    for (const table of value.tables) {
+        if (!isRecord(table) ||
+            typeof table.id !== "string" ||
+            typeof table.name !== "string" ||
+            typeof table.schema !== "string" ||
+            !Array.isArray(table.columns)) {
+            throw new Error(`@askdb/introspect: invalid Schema v2 table in ${filePath}`);
+        }
+        for (const column of table.columns) {
+            if (!isRecord(column) ||
+                typeof column.id !== "string" ||
+                typeof column.name !== "string" ||
+                typeof column.type !== "string" ||
+                typeof column.nullable !== "boolean") {
+                throw new Error(`@askdb/introspect: invalid Schema v2 column in ${filePath}`);
+            }
+        }
+    }
+    return value;
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function findOrphanWarnings(existingArtifactDir, fresh) {
+    const tableIds = new Set(fresh.tables.map((table) => table.id));
+    const columnIds = new Set(fresh.tables.flatMap((table) => table.columns.map((column) => column.id)));
+    const tableDir = join(existingArtifactDir, "tables");
+    if (!existsSync(tableDir))
+        return [];
+    const warnings = [];
+    const seen = new Set();
+    for (const entry of readdirSync(tableDir)) {
+        if (!entry.endsWith(".md"))
+            continue;
+        const filePath = join(tableDir, entry);
+        const relativeFile = `tables/${entry}`;
+        const parsed = parseTableMarkdown(readFileSync(filePath, "utf8"), filePath);
+        appendOrphanWarning(parsed.frontmatter.id, relativeFile, tableIds, warnings, seen);
+        for (const column of parsed.frontmatter.columns ?? []) {
+            appendOrphanWarning(column.id, relativeFile, columnIds, warnings, seen);
+        }
+    }
+    return warnings;
+}
+function appendOrphanWarning(id, file, validIds, warnings, seen) {
+    const key = `${file}\0${id}`;
+    if (validIds.has(id) || seen.has(key))
+        return;
+    seen.add(key);
+    warnings.push({ code: "orphan_id", id, file });
+}
+/**
+ * Pure-function form of {@link renderToSchemaV2} — exposed so callers (and
+ * M6's merge) can produce the V2 JSON without writing it to disk.
+ */
+export function toV2SchemaJson(schema, schemaId) {
+    const tables = [];
+    for (const ns of schema.schemas) {
+        for (const t of ns.tables) {
+            tables.push(toV2Table(t));
+        }
+    }
+    tables.sort((a, b) => {
+        const aSchema = a.schema;
+        const bSchema = b.schema;
+        if (aSchema !== bSchema)
+            return aSchema.localeCompare(bSchema);
+        return a.name.localeCompare(b.name);
+    });
+    return {
+        version: 2,
+        schemaId,
+        tables,
+    };
+}
+function toV2Table(table) {
+    const columns = table.columns
+        .slice()
+        .sort((a, b) => a.ordinalPosition - b.ordinalPosition)
+        .map(toV2Column);
+    const v2Table = {
+        id: table.id,
+        name: table.name,
+        schema: table.schema,
+        sensitive: false,
+        columns,
+    };
+    const relationships = buildRelationships(table);
+    if (relationships.length > 0) {
+        v2Table.relationships = relationships;
+    }
+    return v2Table;
+}
+function toV2Column(column) {
+    // Field order matches the Phase 5 hand-authored fixtures:
+    //   id, name, type, nullable, [primaryKey], sensitive.
+    return {
+        id: column.id,
+        name: column.name,
+        type: compactPostgresType(column.dataType, column.udtName),
+        nullable: column.nullable,
+        ...(column.primaryKey ? { primaryKey: true } : {}),
+        sensitive: false,
+    };
+}
+function buildRelationships(table) {
+    const out = [];
+    // FKs are already sorted by constraint name in the connector — preserve.
+    for (const fk of table.foreignKeys) {
+        appendFkRelationships(out, table, fk);
+    }
+    return out;
+}
+function appendFkRelationships(acc, table, fk) {
+    const local = fk.columns;
+    const referenced = fk.references.columns;
+    // The connector guarantees both lists have equal length and the same
+    // declared (conkey/confkey) order — emit one relationship per pair.
+    const len = Math.min(local.length, referenced.length);
+    for (let i = 0; i < len; i++) {
+        acc.push({
+            from: `${table.id}#${local[i]}`,
+            to: `table:${fk.references.schema}.${fk.references.table}#${referenced[i]}`,
+        });
+    }
+}
+/**
+ * Map Postgres `format_type` strings to the short names AskDB Schema v2
+ * uses in its hand-authored fixtures. Only the standard SQL ↔ pg-short-name
+ * aliases are touched; unknown strings (and length/precision modifiers)
+ * pass through unchanged.
+ */
+export function compactPostgresType(dataType, _udtName) {
+    if (dataType === "timestamp with time zone")
+        return "timestamptz";
+    if (dataType === "time with time zone")
+        return "timetz";
+    if (dataType === "timestamp without time zone")
+        return "timestamp";
+    if (dataType === "time without time zone")
+        return "time";
+    if (dataType.startsWith("character varying")) {
+        return dataType.replace("character varying", "varchar");
+    }
+    if (dataType === "character")
+        return "char";
+    if (dataType.startsWith("character(")) {
+        return dataType.replace("character(", "char(");
+    }
+    return dataType;
+}
+//# sourceMappingURL=render.js.map

package/dist/render/render.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/render/render.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACZ,WAAW,EACX,aAAa,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EACL,kBAAkB,GAInB,MAAM,aAAa,CAAC;AAUrB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAiB,EACjB,OAAsB;IAEtB,MAAM,QAAQ,GAA2B,EAAE,CAAC;IAC5C,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvD,MAAM,EAAE,GAAG,OAAO,CAAC,mBAAmB;QACpC,CAAC,CAAC,yBAAyB,CAAC,KAAK,EAAE,OAAO,CAAC,mBAAmB,EAAE,QAAQ,CAAC;QACzE,CAAC,CAAC,KAAK,CAAC;IAEV,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IAChD,aAAa,CAAC,cAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAE5C,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;AACtC,CAAC;AAED,SAAS,yBAAyB,CAChC,KAAmB,EACnB,mBAA2B,EAC3B,QAAgC;IAEhC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAC3D,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAClF,MAAM,eAAe,GAAG,IAAI,GAAG,EAAoB,CAAC;IAEpD,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnD,IAAI,aAAa,EAAE,SAAS,KAAK,SAAS,EAAE,CAAC;YAC3C,KAAK,CAAC,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;QAC5C,CAAC;QAED,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,MAAM,cAAc,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACtD,IAAI,cAAc,EAAE,CAAC;gBACnB,IAAI,cAAc,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;oBAC3C,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;gBAC9C,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC,CAAC;IACjE,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAAC,mBAA2B;IACvD,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;IACnE,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IACzE,OAAO,kBAAkB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAc,EAAE,QAAgB;IAC1D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,gDAAgD,QAAQ,EAAE,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACvE,MAAM,IAAI,KAAK,CAAC,gDAAgD,QAAQ,EAAE,CAAC,CAAC;IAC9E,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;YAChB,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ;YAC5B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC9B,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;YAChC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAC7B,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,iDAAiD,QAAQ,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,IACE,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACjB,OAAO,MAAM,CAAC,EAAE,KAAK,QAAQ;gBAC7B,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;gBAC/B,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;gBAC/B,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,EACpC,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,kDAAkD,QAAQ,EAAE,CAC7D,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,KAAqB,CAAC;AAC/B,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,kBAAkB,CACzB,mBAA2B,EAC3B,KAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAChE,MAAM,SAAS,GAAG,IAAI,GAAG,CACvB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAC1E,CAAC;IACF,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACrD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAC;IAErC,MAAM,QAAQ,GAA2B,EAAE,CAAC;IAC5C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,SAAS;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,YAAY,GAAG,UAAU,KAAK,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,kBAAkB,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;QAE5E,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnF,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YACtD,mBAAmB,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,mBAAmB,CAC1B,EAAU,EACV,IAAY,EACZ,QAAqB,EACrB,QAAgC,EAChC,IAAiB;IAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,KAAK,EAAE,EAAE,CAAC;IAC7B,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO;IAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACd,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAiB,EACjB,QAAgB;IAEhB,MAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAChC,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACnB,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;QACzB,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;QACzB,IAAI,OAAO,KAAK,OAAO;YAAE,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC/D,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,CAAC;QACV,QAAQ;QACR,MAAM;KACP,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAe;IAChC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO;SAC1B,KAAK,EAAE;SACP,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,GAAG,CAAC,CAAC,eAAe,CAAC;SACrD,GAAG,CAAC,UAAU,CAAC,CAAC;IAEnB,MAAM,OAAO,GAAY;QACvB,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,SAAS,EAAE,KAAK;QAChB,OAAO;KACR,CAAC;IAEF,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAChD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,CAAC,aAAa,GAAG,aAAa,CAAC;IACxC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,UAAU,CAAC,MAAiB;IACnC,0DAA0D;IAC1D,uDAAuD;IACvD,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,mBAAmB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC;QAC1D,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,SAAS,EAAE,KAAK;KACjB,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAe;IAEf,MAAM,GAAG,GAA0C,EAAE,CAAC;IACtD,yEAAyE;IACzE,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QACnC,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,qBAAqB,CAC5B,GAA0C,EAC1C,KAAe,EACf,EAAiB;IAEjB,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC;IACzB,MAAM,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;IACzC,qEAAqE;IACrE,oEAAoE;IACpE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,GAAG,CAAC,IAAI,CAAC;YACP,IAAI,EAAE,GAAG,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;YAC/B,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE;SAC5E,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,QAAgB,EAChB,QAAgB;IAEhB,IAAI,QAAQ,KAAK,0BAA0B;QAAE,OAAO,aAAa,CAAC;IAClE,IAAI,QAAQ,KAAK,qBAAqB;QAAE,OAAO,QAAQ,CAAC;IACxD,IAAI,QAAQ,KAAK,6BAA6B;QAAE,OAAO,WAAW,CAAC;IACnE,IAAI,QAAQ,KAAK,wBAAwB;QAAE,OAAO,MAAM,CAAC;IACzD,IAAI,QAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC7C,OAAO,QAAQ,CAAC,OAAO,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,MAAM,CAAC;IAC5C,IAAI,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/render/types.d.ts

@@ -0,0 +1,18 @@
+import type { IntrospectionWarning } from "../types.js";
+export type RenderOptions = {
+    /** Output directory, typically `"<schemaId>.schema/"`. */
+    outDir: string;
+    schemaId: string;
+    /**
+     * When present, ID-anchored merge runs against this directory's existing
+     * `schema.json`. Sensitive flags are preserved; the describable layer
+     * (`tables/*.md`, `concepts.md`) is read for orphan-warning detection only
+     * and is **never** modified.
+     */
+    existingArtifactDir?: string;
+};
+export type RenderResult = {
+    schemaJsonPath: string;
+    warnings: IntrospectionWarning[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/render/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/render/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAExD,MAAM,MAAM,aAAa,GAAG;IAC1B,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC,CAAC"}

package/dist/render/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/render/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/render/types.ts"],"names":[],"mappings":""}

package/dist/types.d.ts

@@ -0,0 +1,192 @@
+/**
+ * Intermediate representation produced by every connector. Renders into a
+ * Schema v2 `schema.json`. See docs/specs/phase-6-introspection/requirements.md §2.
+ */
+export type SqlSchema = {
+    schemaId: string;
+    schemas: SqlNamespace[];
+};
+export type SqlNamespace = {
+    name: string;
+    tables: SqlTable[];
+    views: SqlView[];
+    enums: SqlEnum[];
+    sequences: SqlSequence[];
+};
+export type SqlTable = {
+    /** "table:<schema>.<name>" (or "table:<name>" in public per Schema v2 ID conventions). */
+    id: string;
+    schema: string;
+    name: string;
+    /** pg_description-derived; surfaced as informational only. */
+    comment?: string;
+    columns: SqlColumn[];
+    primaryKey?: {
+        columns: string[];
+    };
+    /** Ordered by constraint name; column lists preserve `pg_constraint.conkey` order. */
+    foreignKeys: SqlForeignKey[];
+    uniqueConstraints: SqlUnique[];
+    indexes: SqlIndex[];
+    /** Captured but not yet emitted into Schema v2. */
+    checkConstraints: SqlCheck[];
+    rowLevelSecurity?: {
+        enabled: boolean;
+    };
+};
+export type SqlColumn = {
+    /** "table:<schema>.<name>#<col>". */
+    id: string;
+    name: string;
+    ordinalPosition: number;
+    /** Canonical Postgres type string (e.g. "uuid", "text", "numeric(10,2)", "timestamp with time zone"). */
+    dataType: string;
+    /** Raw udt_name for arrays / enums. */
+    udtName: string;
+    nullable: boolean;
+    primaryKey: boolean;
+    defaultExpression?: string;
+    comment?: string;
+};
+export type SqlForeignKeyAction = "no action" | "restrict" | "cascade" | "set null" | "set default";
+export type SqlForeignKey = {
+    name: string;
+    /** Preserves pg_constraint.conkey order — multi-column FK fix. */
+    columns: string[];
+    references: {
+        schema: string;
+        table: string;
+        /** Preserves pg_constraint.confkey order. */
+        columns: string[];
+    };
+    onDelete?: SqlForeignKeyAction;
+    onUpdate?: SqlForeignKeyAction;
+};
+export type SqlUnique = {
+    name: string;
+    columns: string[];
+};
+export type SqlIndex = {
+    name: string;
+    columns: string[];
+    /** Index expression text when the index is on an expression rather than a plain column. */
+    expressions?: string[];
+    unique: boolean;
+    /** pg_am.amname (e.g. "btree", "gin", "gist"). */
+    method: string;
+};
+export type SqlCheck = {
+    name: string;
+    /** Constraint expression text from pg_get_constraintdef. */
+    expression: string;
+};
+export type SqlEnum = {
+    schema: string;
+    name: string;
+    /** Preserves pg_enum.enumsortorder. */
+    values: string[];
+};
+export type SqlSequence = {
+    schema: string;
+    name: string;
+    dataType: string;
+    startValue: string;
+    increment: string;
+    minValue?: string;
+    maxValue?: string;
+    cycle: boolean;
+};
+export type SqlView = {
+    schema: string;
+    name: string;
+    definition: string;
+    columns: SqlColumn[];
+};
+export type IntrospectionFilters = {
+    /** Include-list; default `["public"]`. */
+    schemas?: string[];
+    /**
+     * Always excludes `information_schema`, `pg_catalog`, `pg_toast*`, `pg_temp_*`
+     * regardless of this list; entries here are additive.
+     */
+    excludeSchemas?: string[];
+    /** Glob patterns; matches against `"<schema>.<name>"`. */
+    tables?: string[];
+};
+export type IntrospectionWarning = {
+    code: "orphan_id";
+    id: string;
+    file: string;
+} | {
+    code: "new_column";
+    id: string;
+    tableId: string;
+} | {
+    code: "unsupported_type";
+    column: string;
+    type: string;
+} | {
+    code: "view_with_array_columns";
+    view: string;
+    columns: string[];
+} | {
+    code: "ambiguous_filter";
+    filter: string;
+};
+export type IntrospectionResult = {
+    schema: SqlSchema;
+    warnings: IntrospectionWarning[];
+    isEmpty: boolean;
+    /** Keyed by `"table:<schema>.<view>"`. */
+    viewDefinitions: Record<string, string>;
+};
+/**
+ * Generic catalog query template. Integration packages (e.g. `@askdb/postgres`) own the
+ * concrete set of template names; the engine-agnostic introspect package treats names as
+ * opaque strings used for bundle-file mapping and header validation.
+ */
+export type SqlTemplate = {
+    name: string;
+    /** Parameterized SQL string. The connector binds params at run time. */
+    sql: string;
+    /**
+     * Stable ordered column list emitted by the SQL — used by the bundle reader
+     * to validate CSV headers and to coerce JSON rows.
+     */
+    columns: readonly string[];
+};
+export type SqlTemplateBundle = {
+    /** Engine identifier (e.g. `"postgres"`, `"mysql"`). Set by the integration package. */
+    engine: string;
+    /** Schema/version of the template suite. Bumped whenever templates change shape. */
+    version: number;
+    templates: readonly SqlTemplate[];
+};
+/**
+ * Row shape returned by a connector's catalog query runner.
+ *
+ * This is intentionally scoped to introspection. It is for connector-owned
+ * catalog templates, not for running generated user SQL.
+ */
+export type CatalogQueryResult = {
+    columns: string[];
+    rows: unknown[][];
+};
+/**
+ * Introspection-only query port used by live connectors to run documented
+ * catalog SQL templates.
+ */
+export type CatalogQueryRunner = (sql: string, params?: ReadonlyArray<unknown>) => Promise<CatalogQueryResult>;
+/**
+ * Engine-agnostic introspection connector. Each integration package (`@askdb/postgres`,
+ * a future `@askdb/mysql`, `@askdb/prisma`, ...) exports its own connector and its own
+ * input shape; the introspect orchestrator just hands the input through.
+ *
+ * `templates()` is optional — integrations like Prisma that read schema files do not have
+ * a catalog template suite.
+ */
+export interface Connector<TInput = unknown> {
+    describe(input: TInput): Promise<IntrospectionResult>;
+    templates?(): SqlTemplateBundle;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,SAAS,EAAE,WAAW,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,0FAA0F;IAC1F,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,UAAU,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IACnC,sFAAsF;IACtF,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,iBAAiB,EAAE,SAAS,EAAE,CAAC;IAC/B,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,mDAAmD;IACnD,gBAAgB,EAAE,QAAQ,EAAE,CAAC;IAC7B,gBAAgB,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,yGAAyG;IACzG,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B,WAAW,GACX,UAAU,GACV,SAAS,GACT,UAAU,GACV,aAAa,CAAC;AAElB,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE;QACV,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,6CAA6C;QAC7C,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IACF,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,2FAA2F;IAC3F,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,yBAAyB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,GACpE;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjD,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,SAAS,CAAC;IAClB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wFAAwF;IACxF,MAAM,EAAE,MAAM,CAAC;IACf,oFAAoF;IACpF,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,WAAW,EAAE,CAAC;CACnC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,KAC5B,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS,CAAC,MAAM,GAAG,OAAO;IACzC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACtD,SAAS,CAAC,IAAI,iBAAiB,CAAC;CACjC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@askdb/introspect",
+  "version": "0.3.0-beta.1",
+  "description": "AskDB schema introspection: engine-agnostic Connector contract + orchestrator + Schema v2 renderer. Integration packages (e.g. @askdb/postgres) supply connectors.",
+  "keywords": [
+    "askdb",
+    "introspection",
+    "schema",
+    "schema-v2"
+  ],
+  "homepage": "https://github.com/Ygilany/AskDB#readme",
+  "bugs": {
+    "url": "https://github.com/Ygilany/AskDB/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ygilany/AskDB.git",
+    "directory": "packages/introspect"
+  },
+  "license": "Apache-2.0",
+  "author": "Yahya Gilany",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@askdb/core": "0.5.0-beta.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.9"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "tsc -p tsconfig.build.json --noEmit",
+    "test": "vitest run --config ../../vitest.config.ts"
+  }
+}