kern-orm 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ilya Semenov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,66 @@
-# Temporary Holding Version
+# kern-orm
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Fully typed relational query builder for PostgreSQL with ambient transactions and single-query relation loading.
+
+kern-orm is in early development, and the API changes between minor versions.
+
+See the [documentation](https://ilyasemenov.github.io/kern-orm/).
+
+## Install
+
+```sh
+npm install kern-orm @kern-orm/postgres-js postgres
+```
+
+See [Getting Started](https://ilyasemenov.github.io/kern-orm/getting-started) for the supported runtimes, TypeScript, and PostgreSQL versions.
+
+## Usage
+
+Describe the tables and their relations, then load forms with their fields in one SQL statement, and insert a form with its fields in a transaction:
+
+```ts
+import { postgresJsDriver } from "@kern-orm/postgres-js"
+import { createDatabase, defineSchema, defineTable, many } from "kern-orm"
+import * as t from "kern-orm/types"
+import postgres from "postgres"
+
+const form = defineTable("form", {
+  id: t.uuid.primaryKey().hasDefault(),
+  name: t.text,
+  published: t.boolean,
+})
+
+const field = defineTable("form_field", {
+  id: t.uuid.primaryKey().hasDefault(),
+  formId: t.uuid.columnName("form_id"),
+  label: t.text,
+})
+
+const schema = defineSchema({ form, field }).$relations({
+  form: {
+    fields: many(field, { from: "id", to: "formId" }),
+  },
+})
+
+const database = createDatabase({
+  driver: postgresJsDriver(postgres(process.env.DATABASE_URL!)),
+})
+const db = database.bind(schema)
+
+const forms = await db.form
+  .where({ published: true })
+  .select("id", "name")
+  .select(form => ({
+    fields: form.fields.select("id", "label"),
+  }))
+// forms: { id: string; name: string; fields: { id: string; label: string }[] }[]
+
+// Queries in the callback, including in called functions, join the transaction.
+await db.$transaction(async () => {
+  const formId = await db.form.insert({ name: "Survey", published: false }).get("id")
+  await db.field.insertMany([
+    { formId, label: "Name" },
+    { formId, label: "Email" },
+  ])
+})
+```