semola 0.5.4 → 0.6.1

package/README.md

@@ -26,12 +26,12 @@ Type-safe APIs, Redis queues, pub/sub, i18n, caching & auth with tree-shakeable
 | **🔐 Policy**        | Policy-based authorization with type-safe guards       | `semola/policy`   |
 | **🌍 i18n**          | Compile-time validated internationalization            | `semola/i18n`     |
 | **💾 Cache**         | Redis cache wrapper with TTL & automatic serialization | `semola/cache`    |
-| **⏰ Cron**          | In-memory cron scheduler for periodic task execution   | `semola/cron`     |
-| **🔁 Workflow**      | Durable resumable workflows with step persistence      | `semola/workflow` |
+| **⏰ Cron**          | In-memory and OS cron scheduler for periodic task execution   | `semola/cron`     |
+| **🔁 Workflow**      | Durable resumable workflows with retries and hooks   | `semola/workflow` |
 | **⚠️ Errors**        | Result-based error handling without try/catch          | `semola/errors`   |
 | **📃 Logging**       | A simple logging utility                               | `semola/logging`  |
 | **⌨️ Prompts**       | Interactive zero-dependency CLI prompts                | `semola/prompts`  |
-| **🗄️ ORM**           | Type-safe data layer with query APIs + migrations      | `semola/orm`      |
+| **🗄️ ORM**           | Type-safe data layer with query APIs                   | `semola/orm`      |
 
 ---
 
@@ -122,16 +122,14 @@ const pubsub = new PubSub({
 });
 
 // Subscribe to messages
-const [, unsubscribeHandler] = await pubsub.subscribe((message) => {
+const unsubscribe = await pubsub.subscribe((message) => {
   console.log("Received:", message);
 });
 
 // Publish a message
 await pubsub.publish({ userId: 123, text: "New alert!" });
 
-if (unsubscribeHandler) {
-  await unsubscribeHandler();
-}
+await unsubscribe();
 ```
 
 ### Cache Data with TTL
@@ -148,84 +146,71 @@ const cache = new Cache({
 await cache.set("user:123", { name: "John", age: 30 });
 
 // Retrieve data
-const [error, user] = await cache.get("user:123");
-if (!error) console.log(user);
+const user = await cache.get("user:123");
+console.log(user);
 ```
 
 ### Schedule Recurring Tasks
 
 ```typescript
-import { Cron } from "semola/cron";
+import { Cron, RetryCronJob } from "semola/cron";
 
 const cleanup = new Cron({
   name: "daily-cleanup",
-  schedule: "0 0 * * *", // Daily at midnight
+  schedule: "@daily",
   handler: async () => {
     await deleteOldLogs();
     await archiveInactiveUsers();
   },
+  retry: new RetryCronJob({
+    maxAttempts: 2,
+    onError: (err) => console.log(`An error: ${err.error.message}`),
+    onFailedAttempt: async ({ attemptNumber, delay, error, retriesLeft }) => {
+      console.log(
+        `Attempt ${attemptNumber} failed. Retrying in ${delay}ms. ${retriesLeft} retries left.`,
+      );
+
+      await recover();
+    },
+  }),
 });
 
-cleanup.start();
+cleanup.run();
+
 ```
 
 ### Query a Database
 
 ```typescript
-import { createOrm, createTable, string, uuid } from "semola/orm";
+import { createOrm, defineTable, json, string, uuid } from "semola/orm";
 
-const users = createTable("users", {
-  id: uuid("id").primaryKey(),
+const users = defineTable("users", {
+  id: uuid("id").primaryKey().notNull(),
   name: string("name").notNull(),
   email: string("email").unique().notNull(),
+  metadata: json<{ plan: string }>("metadata"),
 });
 
 const db = createOrm({
-  url: "sqlite::memory:",
+  adapter: "sqlite",
+  url: ":memory:",
   tables: { users },
 });
 
-// Result-pattern query
-const [findErr, rows] = await db.users.findMany({
+const rows = await db.users.findMany({
   where: { name: { contains: "John" } },
   take: 10,
 });
 
-if (findErr) {
-  console.error(findErr.type, findErr.message);
-}
-
-// Create record (result pattern)
-const [createErr, user] = await db.users.create({
+const user = await db.users.create({
   data: {
+    id: "1",
     name: "John Doe",
     email: "john@example.com",
   },
 });
 
-// Low-level SQL-style methods are also available
-const insertedRows = await db.users.insert({
-  data: {
-    name: "Jane Doe",
-    email: "jane@example.com",
-  },
-  returning: true,
-});
-
-console.log(rows, user, createErr, insertedRows);
-```
-
-### Run ORM Migrations
-
-```bash
-# create migration from schema diff
-semola orm migrations create add-users
-
-# apply pending migrations
-semola orm migrations apply
-
-# rollback last applied migration
-semola orm migrations rollback
+console.log(rows, user);
 ```
 
 ### Check Permissions
@@ -344,15 +329,15 @@ _Higher is better for req/sec, lower is better for latency._
 - [API Framework](./docs/api.md) - Type-safe REST API framework with OpenAPI
 - [Queue](./docs/queue.md) - Redis-backed job queue with timeouts & concurrency
 - [PubSub](./docs/pubsub.md) - Type-safe Redis pub/sub
-- [Cron](./docs/cron.md) - In-memory cron scheduler for periodic task execution
-- [Workflow](./docs/workflow.md) - Durable and resumable workflows with step persistence
+- [Cron](./docs/cron.md) - In-memory and OS cron scheduler for periodic task execution
+- [Workflow](./docs/workflow.md) - Durable and resumable workflows with retries and hooks
 - [Policy](./docs/policy.md) - Policy-based authorization
 - [i18n](./docs/i18n.md) - Type-safe internationalization
 - [Cache](./docs/cache.md) - Redis cache wrapper with TTL
 - [Errors](./docs/errors.md) - Result-based error handling
 - [Logging](./docs/logging.md) - Logging utility
 - [Prompts](./docs/prompts.md) - Interactive CLI prompts
-- [ORM](./docs/orm.md) - Type-safe data layer, result-pattern DX, and migrations
+- [ORM](./docs/orm.md) - Type-safe data layer with SQLite support
 
 ---