@typesql/core 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @typesql/core
 
+## 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.
+
+## 0.1.1
+
+### Patch Changes
+
+- Docs, package descriptions and error messages spell the project name TypeSQL.
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -9,6 +9,8 @@ dependencies.
 pnpm add @typesql/core
 ```
 
+[Open an example in the TypeScript Playground](https://www.typescriptlang.org/play/#code/PTAEBUE8AcFMGUCKAZAXKACgewM4BcBzAJ1h1CWQBpRoBDInWAE1ACNIIYEBjIgS2h4A5GTxdQOSPlgBbAHSgAokz55QeABaxyKULQB2LDVgBusIuq3quOVACgQoIlgDuZAyzpFaM2HnNkAGZYADYhrtQeoDJ8+LQA1qR6JKDcWDLQfCHa5s4MoFj6ltr4-PoEcnZ8GVhEagDeqSS0-vAAjiHUYnCgAMKhXeIA4rD65i3Mgz0AcgCuYbSs2VPaGPQ+OFBwK6AASq5b2gC+oIHOMqAARAAC3aQdwGkklwDcdlX6-kSBtNzaACIAIVA9TsoFAs0YDHQoPB4L4THQIzG3n8TAAPJc+J8ACyXAB8L1Ajg0tHcoCYsB+8zw6Cwgj4hVoIQKRQAktN4IpduAwXDZLQsuh+iFMf4AB54AlvOEU2LQEK0SAAfX0Plg6DmCyWsDFsEl0r54N4sAmTGVLSRo3GaLF1VIeB8ggAXobwUcZTRcHhbCCjaAEVaUWbMdi8AAON1w2izTS1ZWBvqhUO4qPgvCqbLC5OXCVSwn+1hYJiQTXzRU6vUGgvut5Hd5pfT4CQdUAAXiaptaHXRQPxAAoAJRvBxgZCKABi4FAACkAPIc6IJJKabT8AgaNQ4BHafTlxbZIkAEgAjOpl2RVKJxGd0hC5AjKo3m212y2Qv2AAZc8e9aezB8mGoACBSyahoDkDM8Gyf1ZTg8EJ12OcAFkIShMhZlAccp1nBdpi9fAyGgUA53wiCYzjIgExYDsAIRWD4NlAB1AAJblFHvBE31PT9qAAdmHOw7j2Vw332FxDnRO4sECUA2gLRxwQAPQAfiE8Q1m8GQyA7TSNkk6TZPkt5FNAVT3kcABBAhiFgAgJncQxUlCWYZCKNVfCCUJwhcTBvVs300lmT5+wAKkHANL0+cNIgkPAygICFDHMUB9GLWAAFpoH8kgcCfQpmziH03xwDovx-RQ-z0WNjCohFqCCkLwuoGRaHFfsoOyCLLPgUBFX8ZtEJQgjiqGJCAFUMFAQEAE1qso6jP0E4T4EdYqO3EgyuBkuKWhwBSwGUtTR1ANl9BCbFtBMZlZiSegSlGNQyVAI8ii8dUvkclhuC0bhEhYWh7OxZsXC0FJVw4e60OYfKmzUUCWQ7S5aCYWhrn1J1sjkNIZFeOxnzUE0zRKsrPw5LkeVO6ZwDnaH8n7BGIoANUs5BxsUXr+yPepSpCOR3pkBnWqyQcjgi3ZFHAcbdmmDkhgDIDOzNC08CWt5hN6Zo0TEg4uCk7bZKJtEDrhcyTuQ2JHUSdwUhxzJslAXJajIQpih0ZA4oShQJz4cVihkexefKxRf2nfRfFAIbUMhAI1eJMAnaIdA0hCVyikucPYEuCksCSNL4fFS27CDsnOW5acORpkayA6zNYGZ1n2c509B14q4WNgMIsEuYd48dog8nQCjauoyLQGmOdp2mcbkA9qJSTINKKSpGMQjwOwgA) <!-- playground:core --> to hover the types and edit the SQL, with nothing to install.
+
 Add the adapter for your driver to run queries: [`@typesql/pg`](https://www.npmjs.com/package/@typesql/pg)
 (node-postgres) or [`@typesql/postgres`](https://www.npmjs.com/package/@typesql/postgres)
 (postgres.js). Already describing your database for an ORM? `@typesql/kysely`,

package/dist/engine/ddl/apply.d.ts

@@ -187,7 +187,7 @@ type GetRel<DB, Ref extends TableRef> = IsTop<Ref["schema"]> extends true ? Ref[
 type SchemaExists<DB, S> = IsTop<S> extends true ? true : S extends string ? IsSchemaKey<DB, S> : false;
 type NoSchema<S> = SqlError<`schema "${S & string}" does not exist`, null>;
 /** A new top-level relation would overwrite a schema (schemas and public relations share `DB`'s keys). */
-type SchemaClash<DB, Ref extends TableRef> = IsTop<Ref["schema"]> extends true ? Ref["name"] extends keyof DB ? SqlError<`cannot create relation "${Ref["name"]}": a schema with that name exists (typesql keeps schemas and public relations in one object)`, null> : null : null;
+type SchemaClash<DB, Ref extends TableRef> = IsTop<Ref["schema"]> extends true ? Ref["name"] extends keyof DB ? SqlError<`cannot create relation "${Ref["name"]}": a schema with that name exists (TypeSQL keeps schemas and public relations in one object)`, null> : null : null;
 /** Checks before adding a relation at `Ref`: `null` when it can be added. */
 type CanCreate<DB, Ref extends TableRef> = SchemaExists<DB, Ref["schema"]> extends false ? NoSchema<Ref["schema"]> : SchemaClash<DB, Ref>;
 type PutRel<DB, Ref extends TableRef, V> = IsTop<Ref["schema"]> extends true ? SetKey<DB, Ref["name"], V> : Ref["schema"] extends keyof DB ? SetKey<DB, Ref["schema"] & string, SetKey<DB[Ref["schema"]], Ref["name"], V>> : NoSchema<Ref["schema"]>;
@@ -281,7 +281,7 @@ type NameCols<C extends Cols, Names, Acc extends Cols, TooMany extends string> =
 } ? NameCols<R, NR, [...Acc, {
     readonly n: N;
     readonly t: I;
-}], TooMany> : SqlError<"a column name list cannot rename the columns of a * projection (typesql limitation): list the columns explicitly", null> : SqlError<TooMany, null> : [...Acc, ...C];
+}], TooMany> : SqlError<"a column name list cannot rename the columns of a * projection (TypeSQL limitation): list the columns explicitly", null> : SqlError<TooMany, null> : [...Acc, ...C];
 /** First duplicate output name, or null. */
 type DupCol<C extends Cols, Seen> = C extends readonly [infer H, ...infer R extends Cols] ? H extends {
     readonly star: infer M;
@@ -438,7 +438,7 @@ type DropTypeNs<NS, N extends string> = Rebuild<{
 type StripCols<Tbl, N extends string> = Rebuild<{
     [K in keyof Tbl as ColUses<Tbl[K], N> extends true ? never : K]: Tbl[K];
 }>;
-type ApplyCreateSchema<DB, Ine, Name extends string> = Name extends "public" ? (Ine extends true ? DB : SqlError<`schema "public" already exists`, null>) : Name extends keyof DB ? IsSchemaKey<DB, Name> extends true ? (Ine extends true ? DB : SqlError<`schema "${Name}" already exists`, null>) : SqlError<`cannot create schema "${Name}": a relation with that name exists (typesql keeps schemas and public relations in one object)`, null> : SetKey<DB, Name, {}>;
+type ApplyCreateSchema<DB, Ine, Name extends string> = Name extends "public" ? (Ine extends true ? DB : SqlError<`schema "public" already exists`, null>) : Name extends keyof DB ? IsSchemaKey<DB, Name> extends true ? (Ine extends true ? DB : SqlError<`schema "${Name}" already exists`, null>) : SqlError<`cannot create schema "${Name}": a relation with that name exists (TypeSQL keeps schemas and public relations in one object)`, null> : SetKey<DB, Name, {}>;
 type ApplyDropSchemas<DB, Names, Ife, Casc> = Names extends readonly [infer N extends string, ...infer Rest] ? N extends "public" ? SqlError<"DROP SCHEMA public is not supported", null> : IsSchemaKey<DB, N> extends true ? [keyof DB[N & keyof DB]] extends [never] ? ApplyDropSchemas<DelKey<DB, N>, Rest, Ife, Casc> : Casc extends true ? ApplyDropSchemas<DelKey<DB, N>, Rest, Ife, Casc> : SqlError<`cannot drop schema ${N} because other objects depend on it`, null> : Ife extends true ? ApplyDropSchemas<DB, Rest, Ife, Casc> : SqlError<`schema "${N}" does not exist`, null> : DB;
 type ApplyRenameSchema<DB, F extends string, To extends string> = IsSchemaKey<DB, F> extends true ? To extends keyof DB | "public" ? SqlError<`schema "${To}" already exists`, null> : RenameKey<DB, F, To> : SqlError<`schema "${F}" does not exist`, null>;
 export {};

package/dist/schema/pg-catalog.d.ts

@@ -1,7 +1,7 @@
 import type { Col, Nullable, View } from "./column.js";
 /**
  * Relations of `pg_catalog` in the {@link PgCatalog} slice. Catalog tables are declared as
- * views too: typesql treats the whole slice as read-only.
+ * views too: TypeSQL treats the whole slice as read-only.
  */
 export interface PgCatalogNamespace {
     /** Table `pg_catalog.pg_am`: Access methods. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typesql/core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Type-level Postgres SQL inference for TypeScript. Zero runtime dependencies.",
   "license": "MIT",
   "repository": {
@@ -34,6 +34,23 @@
     "typescript": "7.0.2",
     "vitest": "^5.0.4"
   },
+  "homepage": "https://typesql.karsli.net",
+  "bugs": {
+    "url": "https://github.com/ismailkarsli/typesql/issues"
+  },
+  "author": "İsmail Karslı",
+  "keywords": [
+    "sql",
+    "postgres",
+    "postgresql",
+    "typescript",
+    "type-safe",
+    "type-level",
+    "raw-sql",
+    "no-codegen",
+    "sql-parser",
+    "database"
+  ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc -p tsconfig.json --noEmit",

package/src/engine/ddl/apply.ts

@@ -177,7 +177,7 @@ type NoSchema<S> = SqlError<`schema "${S & string}" does not exist`, null>;
 /** A new top-level relation would overwrite a schema (schemas and public relations share `DB`'s keys). */
 type SchemaClash<DB, Ref extends TableRef> =
   IsTop<Ref["schema"]> extends true
-    ? Ref["name"] extends keyof DB ? SqlError<`cannot create relation "${Ref["name"]}": a schema with that name exists (typesql keeps schemas and public relations in one object)`, null> : null
+    ? Ref["name"] extends keyof DB ? SqlError<`cannot create relation "${Ref["name"]}": a schema with that name exists (TypeSQL keeps schemas and public relations in one object)`, null> : null
     : null;
 /** Checks before adding a relation at `Ref`: `null` when it can be added. */
 type CanCreate<DB, Ref extends TableRef> =
@@ -326,7 +326,7 @@ type NameCols<C extends Cols, Names, Acc extends Cols, TooMany extends string> =
   Names extends readonly [infer N extends string, ...infer NR]
     ? C extends readonly [infer H, ...infer R extends Cols]
       ? H extends { readonly n: string; readonly t: infer I extends ColInfo } ? NameCols<R, NR, [...Acc, { readonly n: N; readonly t: I }], TooMany>
-      : SqlError<"a column name list cannot rename the columns of a * projection (typesql limitation): list the columns explicitly", null>
+      : SqlError<"a column name list cannot rename the columns of a * projection (TypeSQL limitation): list the columns explicitly", null>
       : SqlError<TooMany, null>
     : [...Acc, ...C];
 
@@ -585,7 +585,7 @@ type ApplyCreateSchema<DB, Ine, Name extends string> =
   Name extends "public" ? (Ine extends true ? DB : SqlError<`schema "public" already exists`, null>)
   : Name extends keyof DB
     ? IsSchemaKey<DB, Name> extends true ? (Ine extends true ? DB : SqlError<`schema "${Name}" already exists`, null>)
-    : SqlError<`cannot create schema "${Name}": a relation with that name exists (typesql keeps schemas and public relations in one object)`, null>
+    : SqlError<`cannot create schema "${Name}": a relation with that name exists (TypeSQL keeps schemas and public relations in one object)`, null>
   : SetKey<DB, Name, {}>;
 
 type ApplyDropSchemas<DB, Names, Ife, Casc> =

package/src/schema/pg-catalog.ts

@@ -3,7 +3,7 @@ import type { Col, Nullable, View } from "./column.js";
 
 /**
  * Relations of `pg_catalog` in the {@link PgCatalog} slice. Catalog tables are declared as
- * views too: typesql treats the whole slice as read-only.
+ * views too: TypeSQL treats the whole slice as read-only.
  */
 export interface PgCatalogNamespace {
   /** Table `pg_catalog.pg_am`: Access methods. */