@aurios/mizzle 1.1.3 → 1.1.4

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @aurios/mizzle@1.1.3 build /home/runner/work/mizzle/mizzle/packages/mizzle
+> @aurios/mizzle@1.1.4 build /home/runner/work/mizzle/mizzle/packages/mizzle
 > tsup
 
 CLI Building entry: {"index":"src/index.ts","columns":"src/columns/index.ts","table":"src/core/table.ts","snapshot":"src/core/snapshot.ts","diff":"src/core/diff.ts","introspection":"src/core/introspection.ts","db":"src/db.ts"}
@@ -10,22 +10,22 @@
 CLI Cleaning output folder
 ESM Build start
 ESM dist/index.js                2.32 KB
-ESM dist/table.js                144.00 B
+ESM dist/columns.js              299.00 B
 ESM dist/snapshot.js             193.00 B
+ESM dist/table.js                144.00 B
 ESM dist/chunk-TOYV2M4M.js       866.00 B
 ESM dist/diff.js                 147.00 B
-ESM dist/chunk-AQVECMXP.js       2.38 KB
 ESM dist/introspection.js        1.47 KB
+ESM dist/chunk-AQVECMXP.js       2.38 KB
 ESM dist/db.js                   166.00 B
-ESM dist/chunk-NPPZW6VT.js       9.59 KB
 ESM dist/transaction-RE7LXTGV.js 193.00 B
+ESM dist/chunk-NPPZW6VT.js       9.59 KB
 ESM dist/chunk-UM3YF5EC.js       15.21 KB
 ESM dist/chunk-GPYZK4WY.js       1.12 KB
 ESM dist/chunk-DU7UPWBW.js       5.17 KB
-ESM dist/columns.js              299.00 B
-ESM ⚡️ Build success in 50ms
+ESM ⚡️ Build success in 45ms
 DTS Build start
-DTS ⚡️ Build success in 5003ms
+DTS ⚡️ Build success in 3819ms
 DTS dist/index.d.ts              3.84 KB
 DTS dist/diff.d.ts               485.00 B
 DTS dist/introspection.d.ts      258.00 B

package/README.md

@@ -1,8 +1,24 @@
-# @aurios/mizzle
+# 🌧️ mizzle
 
+![NPM Last Update](https://img.shields.io/npm/last-update/%40aurios%2Fmizzle?style=flat&color=0EA5E9)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/realfakenerd/mizzle/release.yml?style=flat&color=0EA5E9)
+![GitHub License](https://img.shields.io/github/license/realfakenerd/mizzle?style=flat&color=0EA5E9)
+
+![NPM Downloads](https://img.shields.io/npm/dw/%40aurios%2Fmizzle?style=flat&color=0EA5E9)
 A Drizzle-like ORM for DynamoDB. Mizzle provides a type-safe, fluent API for interacting with DynamoDB, supporting relational queries, batch operations, and transactions.
 
-## Installation
+## Key Features
+
+- **Type-Safe Schema Definition**: Define your tables and entities with strict TypeScript types.
+- **Fluent Query Builder**: precise API for `insert`, `select`, `update`, and `delete` operations.
+- **Relational Queries**: Query related entities with `db.query`.
+- **Batch Operations**: `batchGet` and `batchWrite` support.
+- **Transactions**: Atomic operations using `db.transaction`.
+- **Automatic Type Inference**: `InferSelectModel` and `InferInsertModel` utilities.
+
+> Skip this with the [way less boring docs](https://mizzle-docs.vercel.app)
+
+## 🚀 Installation
 
 ```bash
 npm install @aurios/mizzle
@@ -10,48 +26,141 @@ npm install @aurios/mizzle
 bun add @aurios/mizzle
 ```
 
-## Usage
+## Get Started
+
+### Defining the Table
+
+In DynamoDB, you first need a physical table. Mizzle separates the definition of the physical table structure (PK, SK, Indexes) from the logical entities that live within it and with this making your database well organized and easier to reason about.
+
+```ts
+import { dynamoTable, string } from "@aurios/mizzle";
+
+// This matches your actual DynamoDB table configuration
+export const myTable = dynamoTable("JediOrder", {
+  pk: string("pk"), // The partition key attribute name
+  sk: string("sk"), // The sort key attribute name (optional)
+});
+```
+
+### Defining the Entity
+
+An Entity represents your data model (e.g., an user, an item on an user). You map the Entity to a Physical Table and define how its keys are generated, so every entity looks kinda like an separated table.
+
+```ts
+import { dynamoEntity, string, uuid, number, enum, date, prefixKey, staticKey } from "@aurios/mizzle";
+
+export const jedi = dynamoEntity(
+  myTable,
+  "Jedi",
+  {
+    id: uuid(), // Automatically generates a v7 UUID
+    name: string(),
+    homeworld: string()
+  },
+  (cols) => ({
+    // PK will look like "JEDI#<uuid>"
+    pk: prefixKey("JEDI#", cols.id),
+    // SK will be a static string "PROFILE"
+    sk: staticKey("PROFILE"),
+  }),
+);
+
+export const jediRank = dynamoEntity(
+  myTable,
+  'JediRank',
+  {
+    jediId: uuid(),
+    position: string().default('initiate'),
+    joinedCouncilDate: string(),
+  },
+  (cols) => ({
+    // Same as the jedi so they can be related
+    pk: prefixKey('JEDI#', cols.jediId),
+    // RANK#initiate
+    sk: prefixKey('RANK#', cols.position),
+  })
+)
+```
+
+> The UUID V7 was chosen for better sorting, since the values are time-sortable with 1 millisecond precision.
+
+### Define the Relations
+
+Relationships in Mizzle are established using the defineRelations function. This step creates a logical map of how your entities interact, enabling you to perform powerful relational queries—such as fetching a Jedi along with their entire rank history—in a single operation.
+
+```ts
+import { defineRelations } from "@aurios/mizzle";
+import * as schema from "./schema";
+
+export const relations = defineRelations(schema, (r) => ({
+  jedi: {
+    // A Jedi could've a lot of ranks throughout his year
+    ranks: r.many.jediRank({
+      fields: [r.jedi.id],
+      references: [r.jediRank.jediId],
+    }),
+  },
+  jediRank: {
+    // Every registry points to one Jedi only
+    member: r.one.jedi({
+      fields: [r.jediRank.jediId],
+      references: [r.jedi.id],
+    }),
+  },
+}));
+```
 
 ### Initialization
 
+Initialize the mizzle client by passing it an instance of the standard AWS DynamoDBClient and the relations we just defined.
+
 ```ts
 import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 import { mizzle } from "@aurios/mizzle";
+import { relations } from "./relations";
 
-const client = new DynamoDBClient({});
-const db = mizzle(client);
+const client = new DynamoDBClient({ region: "us-east-1" });
+export const db = mizzle({ client, relations });
 ```
 
-### Key Features
+### Query
 
-- **Type-Safe Schema Definition**: Define your tables and entities with strict TypeScript types.
-- **Fluent Query Builder**: precise API for `insert`, `select`, `update`, and `delete` operations.
-- **Relational Queries**: Query related entities with `db.query`.
-- **Batch Operations**: `batchGet` and `batchWrite` support.
-- **Transactions**: Atomic operations using `db.transaction`.
-- **Automatic Type Inference**: `InferSelectModel` and `InferInsertModel` utilities.
+Now you can use the fluent API to interact with your data in the best way possible.
 
-### Example
+#### Insert Data
 
-```ts
-// Define your schema (simplified)
-import { dynamoTable, dynamoEntity, string } from "@aurios/mizzle";
+```typescript
+// api/jedi/new.ts
+import { jedi } from "$lib/schema.ts";
 
-const myTable = dynamoTable("my-app-table", {
-  pk: string("pk"),
-  sk: string("sk"),
-});
+const newJedi = await db
+  .insert(jedi)
+  .values({
+    name: "Luke Skywalker",
+    homeworld: "Tatooine",
+  })
+  .returning();
 
-const users = dynamoEntity(myTable, "users", {
-  id: string("id"),
-  name: string("name"),
-  email: string("email"),
-});
+console.log(newJedi.id); // The auto-generated UUID
+```
 
-// Query
-const result = await db.select().from(users).where(eq(users.id, "123"));
+#### Select Data
+
+Mizzle intelligently routes your request to `GetItem`, `Query`, or `Scan` based on the filters you provide.
+
+```typescript
+// /api/jedi/get.ts
+import { jedi } from "$lib/schema.ts";
+import { eq } from "@aurios/mizzle";
+
+// This will use GetItem because both PK and SK are fully resolved
+const user = await db.select().from(jedi).where(eq(jedi.id, "some-uuid")).execute();
 ```
 
-## License
+## Mizzling
+
+This will work if you already has a DynamoDB table with data in it. If you want to create a new table with the schema you defined, you can use the [`mizzling`](https://www.npmjs.com/package/@aurios/mizzling) CLI.
+
+## 📄 License
 
-MIT
+This project is licensed under the MIT License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurios/mizzle",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "a drizzle-like orm for dynamoDB",
   "publishConfig": {
     "access": "public",
@@ -79,8 +79,8 @@
   "devDependencies": {
     "tsup": "^8.5.1",
     "@repo/shared": "0.0.3",
-    "@repo/vitest-config": "0.0.0",
-    "@repo/typescript-config": "0.0.0"
+    "@repo/typescript-config": "0.0.0",
+    "@repo/vitest-config": "0.0.0"
   },
   "scripts": {
     "check": "tsc --noEmit",