@typesql/kysely 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @typesql/kysely
 
+## 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

@@ -1,6 +1,6 @@
 # @typesql/kysely
 
-Use the `DB` interface you already have for [Kysely](https://kysely.dev) as a typesql schema:
+Use the `DB` interface you already have for [Kysely](https://kysely.dev) as a TypeSQL schema:
 the one generated by [kysely-codegen](https://github.com/RobinBlomberg/kysely-codegen), by
 [prisma-kysely](https://github.com/valtyr/prisma-kysely), or written by hand. The conversion is
 type-level only; nothing is generated and no database is contacted.
@@ -9,6 +9,8 @@ type-level only; nothing is generated and no database is contacted.
 pnpm add @typesql/core @typesql/kysely kysely
 ```
 
+[Open an example in the TypeScript Playground](https://www.typescriptlang.org/play/#code/PTAEBUE8AcFMGUCKAZUB3AlgFwBagNKQDOsANpKABQACWMsRAjqcANbFmQCUAdKAJoB7AK4AnAh3KgAIgCFQGAHZZYogGYBDAMawq7EuQC0WwQBNYAc1iLQIrNGFZbogFAhQODYtOG0o7CqKXApEoLi6RFo4sAC2GgA0oF6moKIaaKBIqKLCiqGCNpAi4oQGFEpEWF46fAASggBuqmHRqQzCpFhEPC4YMdCCok4A3hJliQAKgpUWogzSGBqksFpYiXRwoADCgqTCMYpQcOv0oADi1qoaKikAvqBqooIxoABE+pyvANy9-YMjoCmu1A90ezze0As31+AyGoFGWjm1wQzBBDyeL1etHoTBYH3I0LcYHxkGMZks1lsjgcazC-hiMVgphcG10AEllAAOUAAXm2u32h3oAB5Kv5FBZEgAjDAWJROAA+oEU+ylzSVYqUktAMrlylASpVMTV4g1WHFFgAfD9WRA+gwqv1efy9gcjrBhdJkYkvSoDaBNRKfcj-YGrTbTgBZQRmZ2vTzQaCQV7+15EDSmQny1SaHQyeTDFygUDCEiiIgALnhReLClMVYuiiuN2FRpN1prxdiGgwpCrYZ+tdAMRj9dA0djho6pEHtcRsGRpgA+tcG5c0i3wPbKhp+h3i7dZwNKpXq0OMGPG82mcKOVhOfvaxpHDhBkuL1W26pZ8WsNhlv25paj+oAOFKpAYEQ0SXuui7ClKMbLF4j6Hi4twuC4Jh5E4phSs6TYZKUnCerIlqUKMpiLMsqyfrAGRTDMcxEAsSwrFg5GgYhtH0YhlDBLc-FcD8WGVAGqJ8vOyLwMwJFkbhQkYe44CtIwwiqBQUrCL25jiGogzoJ4TjYKApiCAw6BkKQiRZA8+nhG0lSJFEKysEySQWD22EtBEu66FU4EMD0Ik4WkahdM66Q9jhUo8AYbEAGIYpQrzHl0ry8HFqyUAA2q8F6vIkrx-lgyyvAAurwaDRHMyVgRBUFMgVbw8k1mikCQvCwAAHisjiwHxPyYQUolITpCEaKIKR8rilAAAbwAAosgC1bOAJY8N2vaJMIPAjmYTkiMolDQDwF7BAAgvAnEnvEnZDvdD2PQ9aSKKwfGgAA8gAagtABKVAfb90h-aAsj8KAJi5OxJ1nTIC3wFsF1XdApDaLAd1PZjtbxb9H2RiWZahMIoDLfFa0AFIfWyABy13hdAn20ydz64G+F7Ojt7PndT0igTwdWQdBGNY5jADqtR-Qt617VNoAACQAIzCyLj1nLjACqEyg+DnOmLNhUJkm6XCcNTgva5suRcZo2qONk0bT1Wh9QNRJDgAegA-IpYAckQF66BoYycHSXjpqsGAFNKSgpIHuJhIIChOFgCcxBgXU6lppA6Uk3iZCgoCqaoGCBS4VvRTw5qh9of4FHxDu9SolAaEQkCKFoVDml1wQ8paZ5JGgUV0l1PDCNApjIuAGgBbV0xpRlsDsaMAsNWO5pqSClXVf1rws6+ojvpmhUtYkCudY7zsKcWZcQ0iKjSaQsmUJ3XBzcDy3gFLON43ToTi5LSQvjZrLRWoBua82ph9Nay9oL61AKfeuTtG4KQEoNGa80lorTWuzL++NSyqF-hLX6UsZbOkVrAneEpRDJiEqAdwqgniiE-IIJwgcGhLHXoINQ3lhyjlANYfYLggA) <!-- playground:kysely --> to hover the types and edit the SQL, with nothing to install.
+
 ```ts
 import { createSql } from "@typesql/kysely";
 import type { DB } from "./db"; // kysely-codegen output
@@ -58,7 +60,7 @@ const same = createCoreSql<FromKysely<DB>, PgTypeMap>(); // types only, no clien
 ```
 
 Queries are sent as `CompiledQuery.raw(q.text, q.values)` through
-`db.withoutPlugins().executeQuery(...)`. Plugins are bypassed on purpose: typesql's row types
+`db.withoutPlugins().executeQuery(...)`. Plugins are bypassed on purpose: TypeSQL's row types
 describe what Postgres returns (`created_at`), and a result transformer such as
 `CamelCasePlugin` would rename the keys (use `{ rowKeys: "camelCase" }` for camelCase rows).
 Logging, the dialect and the connection pool are unaffected. Inside a Kysely transaction,
@@ -66,7 +68,7 @@ Logging, the dialect and the connection pool are unaffected. Inside a Kysely tra
 
 ## How columns are converted
 
-Kysely describes a column by its TS type; typesql needs a Postgres type name. The TS shape
+Kysely describes a column by its TS type; TypeSQL needs a Postgres type name. The TS shape
 is read back as follows (for `ColumnType<S, I, U>` the select type `S` decides, the insert type
 `I` breaks ties):
 
@@ -187,7 +189,7 @@ const post = await sql("SELECT author_id, created_at FROM blog_posts WHERE id =
   `unknown` either way; only `INSERT` stops requiring the column. Override with
   `{ nullable: false }` to get the not-null check back.
 - **JSON shapes are not kept.** `JSONColumnType<{ a: number }>` becomes `jsonb`, read as
-  `unknown` (the type map decides; typesql has no per-column TS types).
+  `unknown` (the type map decides; TypeSQL has no per-column TS types).
 - **Views look like tables.** Kysely interfaces do not mark views; mark them with `$view: true`
   to have writes rejected.
 - **Defaults come from `Generated`/`GeneratedAlways` only.** A column with a default that the

package/dist/client.d.ts

@@ -2,7 +2,7 @@ import { CompiledQuery, type QueryResult } from "kysely";
 import { type Executor, type SqlDriver } from "@typesql/core";
 /**
  * What the adapter uses from a `Kysely<DB>` or `Transaction<DB>`. Queries run through
- * `withoutPlugins()`: typesql's row types describe what the driver returns, so result
+ * `withoutPlugins()`: TypeSQL's row types describe what the driver returns, so result
  * transformers such as `CamelCasePlugin` must not rename the columns (`createSql(db,
  * { rowKeys: "camelCase" })` renames the top-level keys instead, in the types too).
  */

package/dist/from-kysely.d.ts

@@ -1,7 +1,7 @@
 import type { ColDesc, PgScalarName, View } from "@typesql/core";
 /**
  * Converting a Kysely `DB` interface (kysely-codegen, prisma-kysely or hand-written) into a
- * typesql schema. Kysely describes columns with TS types, typesql with Postgres type names, so
+ * TypeSQL schema. Kysely describes columns with TS types, TypeSQL with Postgres type names, so
  * the conversion reads the TS shape back into a type name. That is lossy (`number` may be
  * `int4` or `float8`); `Overrides` pins the exact type per column.
  *
@@ -46,10 +46,10 @@ export type KyselyOptions = {
     readonly camelCase?: boolean;
 };
 /**
- * A typesql schema from a Kysely `DB` interface.
+ * A TypeSQL schema from a Kysely `DB` interface.
  *
  *   type Schema = FromKysely<DB, { users: { id: "int8" } }>;
- *   const sql = createSql<Schema>();            // typesql's createSql
+ *   const sql = createSql<Schema>();            // TypeSQL's createSql
  *
  * `"auth.users"` becomes `Schema["auth"]["users"]`; `"public.users"` becomes `Schema["users"]`.
  * String-literal unions become enums registered in `Schema["$types"]` (see `KyselyOverrides`).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@typesql/kysely",
-  "version": "0.1.0",
-  "description": "Use Kysely database interfaces (kysely-codegen, prisma-kysely) as a typesql schema.",
+  "version": "0.1.2",
+  "description": "Use Kysely database interfaces (kysely-codegen, prisma-kysely) as a TypeSQL schema.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@typesql/core": "0.1.0"
+    "@typesql/core": "0.1.2"
   },
   "peerDependencies": {
     "kysely": ">=0.27"
@@ -40,6 +40,24 @@
     "typescript": "7.0.2",
     "vitest": "^5.0.4"
   },
+  "homepage": "https://typesql.karsli.net/adapters/kysely",
+  "bugs": {
+    "url": "https://github.com/ismailkarsli/typesql/issues"
+  },
+  "author": "İsmail Karslı",
+  "keywords": [
+    "sql",
+    "postgres",
+    "postgresql",
+    "typescript",
+    "type-safe",
+    "type-level",
+    "raw-sql",
+    "no-codegen",
+    "kysely",
+    "kysely-codegen",
+    "orm"
+  ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc -p tsconfig.json --noEmit",

package/src/client.ts

@@ -3,7 +3,7 @@ import { runTransaction, type Executor, type SqlDriver } from "@typesql/core";
 
 /**
  * What the adapter uses from a `Kysely<DB>` or `Transaction<DB>`. Queries run through
- * `withoutPlugins()`: typesql's row types describe what the driver returns, so result
+ * `withoutPlugins()`: TypeSQL's row types describe what the driver returns, so result
  * transformers such as `CamelCasePlugin` must not rename the columns (`createSql(db,
  * { rowKeys: "camelCase" })` renames the top-level keys instead, in the types too).
  */

package/src/from-kysely.ts

@@ -2,7 +2,7 @@ import type { ColDesc, PgScalarName, View } from "@typesql/core";
 
 /**
  * Converting a Kysely `DB` interface (kysely-codegen, prisma-kysely or hand-written) into a
- * typesql schema. Kysely describes columns with TS types, typesql with Postgres type names, so
+ * TypeSQL schema. Kysely describes columns with TS types, TypeSQL with Postgres type names, so
  * the conversion reads the TS shape back into a type name. That is lossy (`number` may be
  * `int4` or `float8`); `Overrides` pins the exact type per column.
  *
@@ -48,10 +48,10 @@ export type KyselyOverrides = { readonly [table: string]: TableOverride };
 export type KyselyOptions = { readonly camelCase?: boolean };
 
 /**
- * A typesql schema from a Kysely `DB` interface.
+ * A TypeSQL schema from a Kysely `DB` interface.
  *
  *   type Schema = FromKysely<DB, { users: { id: "int8" } }>;
- *   const sql = createSql<Schema>();            // typesql's createSql
+ *   const sql = createSql<Schema>();            // TypeSQL's createSql
  *
  * `"auth.users"` becomes `Schema["auth"]["users"]`; `"public.users"` becomes `Schema["users"]`.
  * String-literal unions become enums registered in `Schema["$types"]` (see `KyselyOverrides`).