@danielfgray/pg-sourcerer 0.1.0

package/dist/services/type-hints.js

@@ -0,0 +1,117 @@
+/**
+ * Type Hint Registry Service
+ *
+ * Provides user-configured type overrides that plugins can query.
+ *
+ * Precedence rules (higher score wins):
+ * - schema + table + column: 9 points
+ * - table + column: 7 points
+ * - schema + column: 6 points
+ * - schema + table: 5 points
+ * - column: 4 points
+ * - table: 3 points
+ * - schema: 2 points
+ * - pgType: 1 point
+ *
+ * For same specificity, later rules in config override earlier ones.
+ */
+import { Context, Layer, Option, Order, pipe, Array as Arr } from "effect";
+/**
+ * TypeHintRegistry service tag
+ */
+export class TypeHints extends Context.Tag("TypeHints")() {
+}
+/**
+ * Calculate specificity score for a match pattern.
+ *
+ * Scoring:
+ * - schema: 2 points
+ * - table: 3 points
+ * - column: 4 points
+ * - pgType: 1 point
+ *
+ * Combinations add up:
+ * - schema+table+column = 9 points
+ * - table+column = 7 points
+ * - etc.
+ */
+function calculateScore(match) {
+    let score = 0;
+    if (match.schema !== undefined)
+        score += 2;
+    if (match.table !== undefined)
+        score += 3;
+    if (match.column !== undefined)
+        score += 4;
+    if (match.pgType !== undefined)
+        score += 1;
+    return score;
+}
+/**
+ * Check if a hint's match pattern matches a field
+ */
+function matchesField(match, field) {
+    // All specified criteria must match
+    if (match.schema !== undefined && match.schema !== field.schema)
+        return false;
+    if (match.table !== undefined && match.table !== field.table)
+        return false;
+    if (match.column !== undefined && match.column !== field.column)
+        return false;
+    if (match.pgType !== undefined && match.pgType !== field.pgType)
+        return false;
+    // At least one criterion must be specified
+    return (match.schema !== undefined ||
+        match.table !== undefined ||
+        match.column !== undefined ||
+        match.pgType !== undefined);
+}
+/**
+ * Order for sorting scored hints by (score, index) ascending.
+ * Lower scores come first, so higher scores override them.
+ */
+const scoredHintOrder = Order.combine(Order.mapInput(Order.number, (sh) => sh.score), Order.mapInput(Order.number, (sh) => sh.index));
+/**
+ * Create a type hint registry from configuration
+ */
+export function createTypeHintRegistry(hints) {
+    // Pre-calculate scores for all hints with their original index
+    const scoredHints = pipe(hints, Arr.map((hint, index) => ({
+        hint,
+        score: calculateScore(hint.match),
+        index,
+    })));
+    const getHintsImpl = (field) => {
+        // Find all matching hints
+        const matching = pipe(scoredHints, Arr.filter((sh) => matchesField(sh.hint.match, field)));
+        // Sort by score (ascending), then by index (ascending)
+        // Lower score/index first, so later ones override
+        const sorted = Arr.sort(matching, scoredHintOrder);
+        // Merge hints - later (higher score/index) overrides earlier
+        return Arr.reduce(sorted, {}, (merged, sh) => ({
+            ...merged,
+            ...sh.hint.hints,
+        }));
+    };
+    return {
+        getHints: getHintsImpl,
+        getHint: (field, key) => {
+            const allHints = getHintsImpl(field);
+            return Option.fromNullable(allHints[key]);
+        },
+    };
+}
+/**
+ * Empty registry for testing
+ */
+export const emptyTypeHintRegistry = {
+    getHints: () => ({}),
+    getHint: () => Option.none(),
+};
+/**
+ * Create a live layer from config
+ */
+export function TypeHintsLive(hints) {
+    return Layer.succeed(TypeHints, createTypeHintRegistry(hints));
+}
+//# sourceMappingURL=type-hints.js.map

package/dist/services/type-hints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-hints.js","sourceRoot":"","sources":["../../src/services/type-hints.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,GAAG,EAAE,MAAM,QAAQ,CAAA;AA6B1E;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAGpD;CAAG;AAWN;;;;;;;;;;;;;GAaG;AACH,SAAS,cAAc,CAAC,KAAoB;IAC1C,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,KAAK,IAAI,CAAC,CAAA;IAC1C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;QAAE,KAAK,IAAI,CAAC,CAAA;IACzC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,KAAK,IAAI,CAAC,CAAA;IAC1C,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,KAAK,IAAI,CAAC,CAAA;IAC1C,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,KAAoB,EAAE,KAAyB;IACnE,oCAAoC;IACpC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IAC7E,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;QAAE,OAAO,KAAK,CAAA;IAC1E,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IAC7E,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IAC7E,2CAA2C;IAC3C,OAAO,CACL,KAAK,CAAC,MAAM,KAAK,SAAS;QAC1B,KAAK,CAAC,KAAK,KAAK,SAAS;QACzB,KAAK,CAAC,MAAM,KAAK,SAAS;QAC1B,KAAK,CAAC,MAAM,KAAK,SAAS,CAC3B,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,eAAe,GAA4B,KAAK,CAAC,OAAO,CAC5D,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAc,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,EAC1D,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAc,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAC3D,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAA0B;IAC/D,+DAA+D;IAC/D,MAAM,WAAW,GAA0B,IAAI,CAC7C,KAAK,EACL,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACxB,IAAI;QACJ,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC;QACjC,KAAK;KACN,CAAC,CAAC,CACJ,CAAA;IAED,MAAM,YAAY,GAAG,CAAC,KAAyB,EAA2B,EAAE;QAC1E,0BAA0B;QAC1B,MAAM,QAAQ,GAAG,IAAI,CACnB,WAAW,EACX,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CACvD,CAAA;QAED,uDAAuD;QACvD,kDAAkD;QAClD,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAElD,6DAA6D;QAC7D,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,EAA6B,EAAE,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YACxE,GAAG,MAAM;YACT,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK;SACjB,CAAC,CAAC,CAAA;IACL,CAAC,CAAA;IAED,OAAO;QACL,QAAQ,EAAE,YAAY;QAEtB,OAAO,EAAE,CAAI,KAAyB,EAAE,GAAW,EAAoB,EAAE;YACvE,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;YACpC,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAkB,CAAC,CAAA;QAC5D,CAAC;KACF,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAqB;IACrD,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;IACpB,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE;CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,KAA0B;IACtD,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAA;AAChE,CAAC"}

package/dist/testing.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Testing Utilities
+ *
+ * Provides reusable test layers and helpers for plugin testing.
+ */
+import { Layer } from "effect";
+import { PluginMeta } from "./services/plugin-meta.js";
+import { IR } from "./services/ir.js";
+import { PluginRunner } from "./services/plugin-runner.js";
+import type { SemanticIR } from "./ir/semantic-ir.js";
+/**
+ * Base test layers for direct plugin testing (bypassing PluginRunner).
+ *
+ * Provides all shared services except IR and PluginMeta,
+ * which are test-specific.
+ *
+ * Usage:
+ * ```typescript
+ * const TestLayer = Layer.mergeAll(
+ *   PluginTestLayers,
+ *   Layer.succeed(IR, testIR),
+ *   Layer.succeed(PluginMeta, { name: "test-plugin" }),
+ * )
+ * ```
+ */
+export declare const PluginTestLayers: Layer.Layer<import("./index.js").Inflection | import("./testing.js").Symbols | import("./index.js").TypeHints | import("./testing.js").Emissions | import("./index.js").ArtifactStore, never, never>;
+/**
+ * Test layer for PluginRunner integration tests.
+ *
+ * PluginRunner.Default includes InflectionLive by default.
+ * Add TypeHintsLive for complete test setup.
+ *
+ * Usage:
+ * ```typescript
+ * layer(PluginRunnerTestLayer)("my tests", (it) => {
+ *   it.effect("runs plugins", () =>
+ *     Effect.gen(function* () {
+ *       const runner = yield* PluginRunner
+ *       const prepared = yield* runner.prepare(plugins)
+ *       const result = yield* runner.run(prepared, ir)
+ *     })
+ *   )
+ * })
+ * ```
+ */
+export declare const PluginRunnerTestLayer: Layer.Layer<import("./index.js").TypeHints | PluginRunner, never, never>;
+/**
+ * Create a complete test layer for a specific plugin test.
+ *
+ * @param ir - The SemanticIR to provide
+ * @param pluginName - The plugin name for PluginMeta
+ * @returns Layer with all services for plugin testing
+ *
+ * Usage:
+ * ```typescript
+ * const testIR = freezeIR(createIRBuilder(["public"]))
+ * const TestLayer = createPluginTestLayer(testIR, "my-plugin")
+ *
+ * layer(TestLayer)("MyPlugin tests", (it) => {
+ *   it.effect("generates types", () =>
+ *     Effect.gen(function* () {
+ *       yield* myPlugin.run(config)
+ *       const emissions = yield* Emissions
+ *       expect(emissions.getAll()).toHaveLength(1)
+ *     })
+ *   )
+ * })
+ * ```
+ */
+export declare function createPluginTestLayer(ir: SemanticIR, pluginName: string): Layer.Layer<import("./index.js").Inflection | import("./testing.js").Symbols | import("./index.js").TypeHints | import("./testing.js").Emissions | IR | import("./index.js").ArtifactStore | PluginMeta, never, never>;
+export { IR } from "./services/ir.js";
+export { PluginMeta } from "./services/plugin-meta.js";
+export { Emissions } from "./services/emissions.js";
+export { Symbols } from "./services/symbols.js";
+export { PluginRunner } from "./services/plugin-runner.js";
+export { createIRBuilder, freezeIR } from "./ir/semantic-ir.js";
+//# sourceMappingURL=testing.d.ts.map

package/dist/testing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAM9B,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAErD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,sMAM5B,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB,0EAGjC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,0NAMvE;AAGD,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA"}

package/dist/testing.js

@@ -0,0 +1,84 @@
+/**
+ * Testing Utilities
+ *
+ * Provides reusable test layers and helpers for plugin testing.
+ */
+import { Layer } from "effect";
+import { InflectionLive } from "./services/inflection.js";
+import { EmissionsLive } from "./services/emissions.js";
+import { SymbolsLive } from "./services/symbols.js";
+import { TypeHintsLive } from "./services/type-hints.js";
+import { ArtifactStoreLive } from "./services/artifact-store.js";
+import { PluginMeta } from "./services/plugin-meta.js";
+import { IR } from "./services/ir.js";
+import { PluginRunner } from "./services/plugin-runner.js";
+/**
+ * Base test layers for direct plugin testing (bypassing PluginRunner).
+ *
+ * Provides all shared services except IR and PluginMeta,
+ * which are test-specific.
+ *
+ * Usage:
+ * ```typescript
+ * const TestLayer = Layer.mergeAll(
+ *   PluginTestLayers,
+ *   Layer.succeed(IR, testIR),
+ *   Layer.succeed(PluginMeta, { name: "test-plugin" }),
+ * )
+ * ```
+ */
+export const PluginTestLayers = Layer.mergeAll(InflectionLive, EmissionsLive, SymbolsLive, TypeHintsLive([]), ArtifactStoreLive);
+/**
+ * Test layer for PluginRunner integration tests.
+ *
+ * PluginRunner.Default includes InflectionLive by default.
+ * Add TypeHintsLive for complete test setup.
+ *
+ * Usage:
+ * ```typescript
+ * layer(PluginRunnerTestLayer)("my tests", (it) => {
+ *   it.effect("runs plugins", () =>
+ *     Effect.gen(function* () {
+ *       const runner = yield* PluginRunner
+ *       const prepared = yield* runner.prepare(plugins)
+ *       const result = yield* runner.run(prepared, ir)
+ *     })
+ *   )
+ * })
+ * ```
+ */
+export const PluginRunnerTestLayer = Layer.mergeAll(PluginRunner.Default, TypeHintsLive([]));
+/**
+ * Create a complete test layer for a specific plugin test.
+ *
+ * @param ir - The SemanticIR to provide
+ * @param pluginName - The plugin name for PluginMeta
+ * @returns Layer with all services for plugin testing
+ *
+ * Usage:
+ * ```typescript
+ * const testIR = freezeIR(createIRBuilder(["public"]))
+ * const TestLayer = createPluginTestLayer(testIR, "my-plugin")
+ *
+ * layer(TestLayer)("MyPlugin tests", (it) => {
+ *   it.effect("generates types", () =>
+ *     Effect.gen(function* () {
+ *       yield* myPlugin.run(config)
+ *       const emissions = yield* Emissions
+ *       expect(emissions.getAll()).toHaveLength(1)
+ *     })
+ *   )
+ * })
+ * ```
+ */
+export function createPluginTestLayer(ir, pluginName) {
+    return Layer.mergeAll(PluginTestLayers, Layer.succeed(IR, ir), Layer.succeed(PluginMeta, { name: pluginName }));
+}
+// Re-export commonly needed items for tests
+export { IR } from "./services/ir.js";
+export { PluginMeta } from "./services/plugin-meta.js";
+export { Emissions } from "./services/emissions.js";
+export { Symbols } from "./services/symbols.js";
+export { PluginRunner } from "./services/plugin-runner.js";
+export { createIRBuilder, freezeIR } from "./ir/semantic-ir.js";
+//# sourceMappingURL=testing.js.map

package/dist/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAG1D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC,QAAQ,CAC5C,cAAc,EACd,aAAa,EACb,WAAW,EACX,aAAa,CAAC,EAAE,CAAC,EACjB,iBAAiB,CAClB,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC,QAAQ,CACjD,YAAY,CAAC,OAAO,EACpB,aAAa,CAAC,EAAE,CAAC,CAClB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAAc,EAAE,UAAkB;IACtE,OAAO,KAAK,CAAC,QAAQ,CACnB,gBAAgB,EAChB,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,EACrB,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAChD,CAAA;AACH,CAAC;AAED,4CAA4C;AAC5C,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA"}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@danielfgray/pg-sourcerer",
+  "version": "0.1.0",
+  "description": "PostgreSQL code generation framework with a plugin ecosystem",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./plugins/*": {
+      "types": "./dist/plugins/*.d.ts",
+      "import": "./dist/plugins/*.js"
+    }
+  },
+  "bin": {
+    "pgsourcerer": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "bun run clean && bun run build",
+    "test": "vitest run",
+    "test:all": "bun --env-file=../example/.env vitest run --config vitest.all.config.ts",
+    "test:unit": "vitest run",
+    "test:integration": "bun --env-file=../example/.env vitest run --config vitest.integration.config.ts",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "postgresql",
+    "postgres",
+    "codegen",
+    "code-generation",
+    "typescript",
+    "effect",
+    "zod",
+    "introspection"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DanielFGray/pg-sourcerer.git",
+    "directory": "packages/pg-sourcerer"
+  },
+  "license": "MIT",
+  "author": "Daniel Gray",
+  "dependencies": {
+    "@effect/cli": "catalog:",
+    "@effect/platform": "catalog:",
+    "@effect/platform-node": "catalog:",
+    "effect": "catalog:",
+    "lilconfig": "^3.1.3",
+    "pg": "catalog:",
+    "postgres": "catalog:",
+    "@pg-sourcerer/pg-introspection": "workspace:*",
+    "recast": "^0.23.11"
+  },
+  "devDependencies": {
+    "@effect/vitest": "catalog:",
+    "@types/bun": "catalog:",
+    "@types/pg": "catalog:",
+    "@vitest/coverage-v8": "3.2.4",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  }
+}