tempest-db-js 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mauricio Benjamin
+
+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

@@ -0,0 +1,54 @@
+# tempest-db-js
+
+> Type-safe, class-based ORM for TypeScript — **SQLAlchemy 2.0 ergonomics** for the JS/TS world.
+> Foundation package for the future **`tempest-ts-sdk`**.
+
+📖 **Documentation:** [Português (BR)](https://mauriciobenjamin700.github.io/tempest-db-js/) · [English (US)](https://mauriciobenjamin700.github.io/tempest-db-js/en/)
+
+> ⚠️ **Status: pre-alpha (v0.0.0).** Phase 1 type-inference is proven; the public API is still taking shape. Not yet published to npm.
+
+## Why tempest-db-js
+
+You define a model **once**, as a class — tempest-db-js infers everything else:
+
+```ts
+import { Model, column, type InferModel, type InferInsert } from "tempest-db-js";
+
+class User extends Model {
+  static tablename = "users";
+  id = column.integer().primaryKey();
+  name = column.text().notNull();
+  age = column.integer().notNull();
+  nickname = column.text();                 // nullable
+  createdAt = column.timestamp().default(new Date());
+}
+
+type UserRow    = InferModel<typeof User>;
+// { id: number; name: string; age: number; nickname: string | null; createdAt: Date | null }
+
+type UserInsert = InferInsert<typeof User>;
+// { name: string; age: number; nickname: string | null; id?: number; createdAt?: Date | null }
+```
+
+No manual `interface`, no codegen step, no schema/type drift. The class **is** the source of truth — just like SQLAlchemy's declarative `Mapped[...]`.
+
+## The TypeScript reality
+
+SQLAlchemy reads `Mapped[int]` at runtime via descriptors; TypeScript erases types at compile time. tempest-db-js bridges this by making each column a **runtime-typed builder** (`column.integer()`) that carries both its SQL type (runtime) and its static type (inference). You get class-based ergonomics **and** strong query-result inference — the trade-off being that returned rows are inferred plain objects, not active-record class instances (a post-MVP stretch goal).
+
+## Roadmap
+
+See [ROADMAP.md](./ROADMAP.md). Targets: **SQLite** (`better-sqlite3`) then **PostgreSQL** (`postgres.js`), performance-first.
+
+## Development
+
+```bash
+npm install
+npm run test:types   # tsc --noEmit — the type-level test suite
+npm test             # vitest runtime tests
+npm run build        # tsup → dual ESM + CJS + .d.ts
+```
+
+## License
+
+MIT