@typesql/pg 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @typesql/pg
 
+## 0.1.2
+
+### Patch Changes
+
+- npm package pages link to the documentation site and the issue tracker, and list keywords.
+
+- READMEs link to an example in the TypeScript Playground.
+
+- Updated dependencies:
+  - @typesql/core@0.1.2
+
+## 0.1.1
+
+### Patch Changes
+
+- Docs, package descriptions and error messages spell the project name TypeSQL.
+
+- Updated dependencies:
+  - @typesql/core@0.1.1
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -8,6 +8,8 @@ map of `pg`'s default parsers, whose queries run on your pool and return rows ty
 pnpm add @typesql/core @typesql/pg pg
 ```
 
+[Open an example in the TypeScript Playground](https://www.typescriptlang.org/play/#code/PTAEBUE8AcFMGUCKAZUB3AlgFwBagHYD2AJrALTSEDOWA5gE6xWgAUAAljEwI4A2w0WgEoAdKEQBXWPQxNQ9CflCElkQhPqgACoUK8ANKACG+YvMJpmRxqE5wzAI0jocRrACgQoQQHJmpADMjCV4sb2sqaWZGLA18AC5QDHwsAA5jUwIJAFtpDABjY2YaGXxaKkMsDFyaI2zoK2YAETdYMQAJQgA3aVscWHkmEKwqEXdqynowgG9tXV5QAF9QAPpCbNAAIkFNgG5x+sIp0Fn8xlb4PiWVtY3Nji4qPgFaPYPJsLsB2YBhPUMAOKwfDSVrEQwAORCvCMDl4A2Wq3WWwecCe-HyR1gb08YAA6jIsANcBhmE5QK5TIYjqBaMDQUSkmEkRs1BpQMQ3LCjJFEgADL7opIpNZUOD5MJkMgaBaAMgJQFL1GEqPl+tkjCIRnzxilpEF8gMmgAhE7uUCgCSRehURLTM3mpLERJAkH0MEAHk2ySwABZNgA+fYO0CwdUYXiJP68T1EgAeWADQYdxFJ0BhkAA+vg6rBElDeDC4bAY7B44n7eaHEYYfgDZG9J78Dk8vly8GzrAwRm3M76W6icQY9UmFg6tAsAAvNtLJOUGg203BjBO0AuhmwQdelKpafm4K4I4Z5f16Nb3272zYeEnktlwMV7wSOGk-rEbtYPPQ2Hwoc1Uf1Sdp0WfZFncdxMXwGhvHmUAAF4CFgNA5j0FhThUEEJQwFR4CwUpaESbZqDoRgbRAXhCHyascCI4AjGgaBNiWIR9ggqChXgjsLj4d1jX9FhKD0ZiwNYsInAAQQkA9NHg9EWD5eAAFFkAUn5wG8ERl0MaBNSvWAtJEaAn14F8N3fQwJBEUMjHDB9gzs+yHQAMQAJQAeQAWWg+dvFAAApVyAEkIQtK1mAkUBXOCizlzg9T92o+gj2IWyHNS808XaBTnIUuLJISpLYoAEgARj5QwAHYhJEryRliow0Gs0TIAkqTLNjWB8kk2AWCErwHQAPQAfmElQoMtXp4PqxrQFk+SlJUtTNNAKsawNQxOIHd9QBcjyQqiUAMqynKrPDIrSsMTYjE5NhSzHeERExbJNlEUsOq68AjAAa1gRyMGtLBXPocAcDWNAev2PrzSGkbILCTFFFqyaGuwGa+DkxTlNU4w8sPJb4ZSFgACohFAMT4AIba3M8udaoBNyAFUtFAI0AE1sakpK+Re9rOqJcHcWDaGBawWMkmKK4HHUTIsEIZQQVsN1IKMTCVEjDz3ICtS0H6JRcAGAJFBVpQSL0HoKlANzkGQI0xJ+ABpFxgSZPpQdGcDRrCGmArMJHpvRTVFaoZWqhUFgeUgWtWBFknYP9RdQD66HzWq2YYuWX2UZFuSgsU5y1KC8BXL261WBOgxlurEwDRJgA1MTkHphTyZYErDEKgAmEnsvAennIhIKAUdMqtgYZXYBu2M7raR7NkMAAGbm3qJD7vt+-7AeB0H+eTj2arq5HPljbOIVz-OIULmrmDDnHEqWqosHhWv68b5vW9ADuu4Unu+4HofDCWzY7RYAFkIM9NqS9YArx+n9GgG8QYWG3oMWI9AlA0w0sQECQkBZaGsDmIkJdrADFVB1b6ZgjC0GsrDPosA-qgExLwHICR2b5RiqSYUvoxhTRRrNJo81wA5R2tTIizBDrZWYbjH279zpbHKmA16vNurMQTmAaQax6CJCMDNXCyRaBiwIIQMIJh2E+ncEAA) <!-- playground:pg --> to hover the types and edit the SQL, with nothing to install.
+
 ## Usage
 
 ```ts

package/dist/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-/** `typesql`: `typesql introspect` writes the typesql schema of a live database. */
+/** `typesql`: `typesql introspect` writes the TypeSQL schema of a live database. */
 import { main } from "./introspect/cli.js";
 process.exitCode = await main(process.argv.slice(2));
 //# sourceMappingURL=bin.js.map

package/dist/introspect/cli.js

@@ -6,7 +6,7 @@ import { generateSource } from "./emit.js";
 import { introspect } from "./introspect.js";
 const USAGE = `Usage: typesql introspect [options]
 
-Reads a live Postgres database and writes its typesql schema (tables, views, enums).
+Reads a live Postgres database and writes its TypeSQL schema (tables, views, enums).
 
 Options:
   --url <url>          connection string (default: $DATABASE_URL)

package/dist/introspect/emit.d.ts

@@ -22,7 +22,7 @@ export interface GenerateOptions {
     readonly comments?: boolean;
 }
 /**
- * TypeScript source declaring the typesql schema of an introspected database: `public`
+ * TypeScript source declaring the TypeSQL schema of an introspected database: `public`
  * relations at the top level, other schemas nested (`DB["auth"]["sessions"]`), views and
  * materialized views as `View<…>`, enums under `$types`.
  */

package/dist/introspect/emit.js

@@ -25,7 +25,7 @@ function columnNotes(c) {
     return notes;
 }
 /**
- * TypeScript source declaring the typesql schema of an introspected database: `public`
+ * TypeScript source declaring the TypeSQL schema of an introspected database: `public`
  * relations at the top level, other schemas nested (`DB["auth"]["sessions"]`), views and
  * materialized views as `View<…>`, enums under `$types`.
  */
@@ -102,13 +102,13 @@ export function generateSource(db, options = {}) {
     }
     for (const [schema, rels] of namespaces) {
         if (topLevel.has(schema)) {
-            throw new Error(`schema "${schema}" has the same name as the table "public.${schema}": typesql keeps public relations and schemas in one object`);
+            throw new Error(`schema "${schema}" has the same name as the table "public.${schema}": TypeSQL keeps public relations and schemas in one object`);
         }
         const body = rels.map((r) => `${relDoc(r, "    ")}    ${key(r.name)}: ${relation(r, "    ")};`);
         lines.push(`  ${key(schema)}: {\n${body.join("\n")}\n  };`);
     }
     if (db.enums.length > 0) {
-        // typesql's enum registry is flat (`Col<"mood">`, schema qualifiers are dropped), so enums
+        // TypeSQL's enum registry is flat (`Col<"mood">`, schema qualifiers are dropped), so enums
         // of the same name in different schemas share an entry.
         const byName = new Map();
         for (const e of db.enums) {

package/dist/introspect/introspect.d.ts

@@ -4,7 +4,7 @@ export type RelationKind = "table" | "partitioned table" | "view" | "materialize
 export interface IntrospectedColumn {
     readonly name: string;
     /**
-     * Canonical Postgres type name as typesql spells it: `int4`, `timestamptz`, `varchar`, an enum
+     * Canonical Postgres type name as TypeSQL spells it: `int4`, `timestamptz`, `varchar`, an enum
      * name, `${T}[]` for arrays. Domains are replaced by their base type; `citext` is `text`.
      */
     readonly type: string;

package/dist/introspect/introspect.js

@@ -7,7 +7,7 @@ const KINDS = {
     m: "materialized view",
     f: "foreign table",
 };
-/** Postgres type names typesql spells differently. */
+/** Postgres type names TypeSQL spells differently. */
 const TYPE_ALIASES = { citext: "text" };
 function resolver(types) {
     const resolve = (oid) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@typesql/pg",
-  "version": "0.1.0",
-  "description": "node-postgres (pg) adapter for typesql, with `typesql introspect` to generate a schema from a live database.",
+  "version": "0.1.2",
+  "description": "node-postgres (pg) adapter for TypeSQL, with `typesql introspect` to generate a schema from a live database.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -35,7 +35,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@typesql/core": "0.1.0"
+    "@typesql/core": "0.1.2"
   },
   "peerDependencies": {
     "pg": ">=8"
@@ -46,6 +46,24 @@
     "typescript": "7.0.2",
     "vitest": "^5.0.4"
   },
+  "homepage": "https://typesql.karsli.net/adapters/pg",
+  "bugs": {
+    "url": "https://github.com/ismailkarsli/typesql/issues"
+  },
+  "author": "İsmail Karslı",
+  "keywords": [
+    "sql",
+    "postgres",
+    "postgresql",
+    "typescript",
+    "type-safe",
+    "type-level",
+    "raw-sql",
+    "no-codegen",
+    "pg",
+    "node-postgres",
+    "introspection"
+  ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc -p tsconfig.json --noEmit",

package/src/bin.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-/** `typesql`: `typesql introspect` writes the typesql schema of a live database. */
+/** `typesql`: `typesql introspect` writes the TypeSQL schema of a live database. */
 import { main } from "./introspect/cli.js";
 
 process.exitCode = await main(process.argv.slice(2));

package/src/introspect/cli.ts

@@ -16,7 +16,7 @@ export interface IntrospectConfig extends GenerateOptions, IntrospectOptions {
 
 const USAGE = `Usage: typesql introspect [options]
 
-Reads a live Postgres database and writes its typesql schema (tables, views, enums).
+Reads a live Postgres database and writes its TypeSQL schema (tables, views, enums).
 
 Options:
   --url <url>          connection string (default: $DATABASE_URL)

package/src/introspect/emit.ts

@@ -51,7 +51,7 @@ function columnNotes(c: IntrospectedColumn): string[] {
 }
 
 /**
- * TypeScript source declaring the typesql schema of an introspected database: `public`
+ * TypeScript source declaring the TypeSQL schema of an introspected database: `public`
  * relations at the top level, other schemas nested (`DB["auth"]["sessions"]`), views and
  * materialized views as `View<…>`, enums under `$types`.
  */
@@ -126,14 +126,14 @@ export function generateSource(db: IntrospectedDatabase, options: GenerateOption
   }
   for (const [schema, rels] of namespaces) {
     if (topLevel.has(schema)) {
-      throw new Error(`schema "${schema}" has the same name as the table "public.${schema}": typesql keeps public relations and schemas in one object`);
+      throw new Error(`schema "${schema}" has the same name as the table "public.${schema}": TypeSQL keeps public relations and schemas in one object`);
     }
     const body = rels.map((r) => `${relDoc(r, "    ")}    ${key(r.name)}: ${relation(r, "    ")};`);
     lines.push(`  ${key(schema)}: {\n${body.join("\n")}\n  };`);
   }
 
   if (db.enums.length > 0) {
-    // typesql's enum registry is flat (`Col<"mood">`, schema qualifiers are dropped), so enums
+    // TypeSQL's enum registry is flat (`Col<"mood">`, schema qualifiers are dropped), so enums
     // of the same name in different schemas share an entry.
     const byName = new Map<string, { values: Set<string>; schemas: string[] }>();
     for (const e of db.enums) {

package/src/introspect/introspect.ts

@@ -6,7 +6,7 @@ export type RelationKind = "table" | "partitioned table" | "view" | "materialize
 export interface IntrospectedColumn {
   readonly name: string;
   /**
-   * Canonical Postgres type name as typesql spells it: `int4`, `timestamptz`, `varchar`, an enum
+   * Canonical Postgres type name as TypeSQL spells it: `int4`, `timestamptz`, `varchar`, an enum
    * name, `${T}[]` for arrays. Domains are replaced by their base type; `citext` is `text`.
    */
   readonly type: string;
@@ -77,7 +77,7 @@ const KINDS: Readonly<Record<string, RelationKind>> = {
   f: "foreign table",
 };
 
-/** Postgres type names typesql spells differently. */
+/** Postgres type names TypeSQL spells differently. */
 const TYPE_ALIASES: Readonly<Record<string, string>> = { citext: "text" };
 
 interface TypeRow {