true-pg 0.1.1 → 0.2.0

package/README.md

@@ -51,12 +51,13 @@ Example config file:
 
 ## Configuration Options
 
-| Option          | Description                                              | Default    |
-| --------------- | -------------------------------------------------------- | ---------- |
-| `uri`           | PostgreSQL connection URI                                | Required   |
-| `out`           | Output directory for generated files                     | `"models"` |
-| `adapters`      | Adapters to use (e.g. `kysely`, `zod`)                   | `"kysely"` |
-| `defaultSchema` | Default schema to use (Kysely schema will be unprefixed) | `"public"` |
+| Option             | Description                                              | Default                       |
+| ------------------ | -------------------------------------------------------- | ----------------------------- |
+| `uri`              | PostgreSQL connection URI                                | Required, or connectionConfig |
+| `connectionConfig` | PostgreSQL connection config object                      | Required, or uri              |
+| `out`              | Output directory for generated files                     | `"models"`                    |
+| `adapters`         | Adapters to use (e.g. `kysely`, `zod`)                   | `"kysely"`                    |
+| `defaultSchema`    | Default schema to use (Kysely schema will be unprefixed) | `"public"`                    |
 
 ## Customising Code Generation
 

package/lib/index.js

@@ -135,7 +135,10 @@ const multifile = async (generators, schemas, opts) => {
 };
 export async function generate(opts, generators) {
     const out = opts.out || "./models";
-    const extractor = new Extractor(opts.uri);
+    const conn = opts.uri ?? opts.connectionConfig;
+    if (!conn)
+        throw new Error("Either uri or connectionConfig is required. Add either option to your .truepgrc.json.");
+    const extractor = new Extractor(conn);
     const schemas = await extractor.extractSchemas();
     generators ??= opts.adapters.map(adapter => {
         const selected = adapters[adapter];

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { CanonicalType, CompositeTypeDetails, EnumDetails, FunctionDetails, TableDetails, SchemaType, Schema } from "pg-extract";
+import type { CanonicalType, CompositeTypeDetails, EnumDetails, FunctionDetails, TableDetails, SchemaType, Schema, Extractor } from "pg-extract";
 export declare const allowed_kind_names: readonly ["tables", "enums", "composites", "functions"];
 export type allowed_kind_names = (typeof allowed_kind_names)[number];
 export interface FolderStructure {
@@ -64,8 +64,10 @@ export declare namespace Nodes {
         star: boolean;
     }
 }
+export type ConnectionConfig = Exclude<ConstructorParameters<typeof Extractor>[0], string | undefined>;
 export interface TruePGOpts {
-    uri: string;
+    uri?: string;
+    connectionConfig?: ConnectionConfig;
     out: string;
     adapters: string[];
     defaultSchema?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "true-pg",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"type": "module",
 	"module": "lib/index.js",
 	"main": "lib/index.js",
@@ -10,6 +10,11 @@
 	"files": [
 		"lib"
 	],
+	"homepage": "https://github.com/feathers-studio/true-pg",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/feathers-studio/true-pg.git"
+	},
 	"scripts": {
 		"check": "tsc --noEmit",
 		"build": "tsc",