@coji/durably 0.4.0 → 0.6.1

package/README.md

@@ -4,65 +4,36 @@ Step-oriented resumable batch execution for Node.js and browsers using SQLite.
 
 **[Documentation](https://coji.github.io/durably/)** | **[GitHub](https://github.com/coji/durably)** | **[Live Demo](https://durably-demo.vercel.app)**
 
-## Features
-
-- Resumable batch processing with step-level persistence
-- Works in both Node.js and browsers
-- Uses SQLite for state management (better-sqlite3/libsql for Node.js, SQLite WASM for browsers)
-- Minimal dependencies - just Kysely and Zod as peer dependencies
-- Event system for monitoring and extensibility
-- Type-safe input/output with Zod schemas
+> **Note:** This package is ESM-only. CommonJS is not supported.
 
 ## Installation
 
 ```bash
-# Node.js with better-sqlite3
 npm install @coji/durably kysely zod better-sqlite3
-
-# Node.js with libsql
-npm install @coji/durably kysely zod @libsql/client @libsql/kysely-libsql
-
-# Browser with SQLocal
-npm install @coji/durably kysely zod sqlocal
 ```
 
-## Usage
+See the [Getting Started Guide](https://coji.github.io/durably/guide/getting-started) for other SQLite backends (libsql, SQLocal for browsers).
+
+## Quick Start
 
 ```ts
-import { createDurably } from '@coji/durably'
-import SQLite from 'better-sqlite3'
-import { SqliteDialect } from 'kysely'
+import { createDurably, defineJob } from '@coji/durably'
 import { z } from 'zod'
 
-const dialect = new SqliteDialect({
-  database: new SQLite('local.db'),
-})
-
-const durably = createDurably({ dialect })
-
-const syncUsers = durably.defineJob(
-  {
-    name: 'sync-users',
-    input: z.object({ orgId: z.string() }),
-    output: z.object({ syncedCount: z.number() }),
-  },
-  async (step, payload) => {
-    const users = await step.run('fetch-users', async () => {
-      return api.fetchUsers(payload.orgId)
-    })
-
-    await step.run('save-to-db', async () => {
-      await db.upsertUsers(users)
+const myJob = defineJob({
+  name: 'my-job',
+  input: z.object({ id: z.string() }),
+  run: async (step, payload) => {
+    await step.run('step-1', async () => {
+      /* ... */
     })
-
-    return { syncedCount: users.length }
   },
-)
+})
 
-await durably.migrate()
-durably.start()
+const durably = createDurably({ dialect }).register({ myJob })
 
-await syncUsers.trigger({ orgId: 'org_123' })
+await durably.init() // migrate + start
+await durably.jobs.myJob.trigger({ id: '123' })
 ```
 
 ## Documentation

package/dist/chunk-UCUP6NMJ.js

@@ -0,0 +1,22 @@
+// src/plugins/log-persistence.ts
+function withLogPersistence() {
+  return {
+    name: "log-persistence",
+    install(durably) {
+      durably.on("log:write", async (event) => {
+        await durably.storage.createLog({
+          runId: event.runId,
+          stepName: event.stepName,
+          level: event.level,
+          message: event.message,
+          data: event.data
+        });
+      });
+    }
+  };
+}
+
+export {
+  withLogPersistence
+};
+//# sourceMappingURL=chunk-UCUP6NMJ.js.map

package/dist/chunk-UCUP6NMJ.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugins/log-persistence.ts"],"sourcesContent":["import type { DurablyPlugin } from '../durably'\n\n/**\n * Plugin that persists log events to the database\n */\nexport function withLogPersistence(): DurablyPlugin {\n  return {\n    name: 'log-persistence',\n    install(durably) {\n      durably.on('log:write', async (event) => {\n        await durably.storage.createLog({\n          runId: event.runId,\n          stepName: event.stepName,\n          level: event.level,\n          message: event.message,\n          data: event.data,\n        })\n      })\n    },\n  }\n}\n"],"mappings":";AAKO,SAAS,qBAAoC;AAClD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ,SAAS;AACf,cAAQ,GAAG,aAAa,OAAO,UAAU;AACvC,cAAM,QAAQ,QAAQ,UAAU;AAAA,UAC9B,OAAO,MAAM;AAAA,UACb,UAAU,MAAM;AAAA,UAChB,OAAO,MAAM;AAAA,UACb,SAAS,MAAM;AAAA,UACf,MAAM,MAAM;AAAA,QACd,CAAC;AAAA,MACH,CAAC;AAAA,IACH;AAAA,EACF;AACF;","names":[]}