@coji/durably 0.0.1

package/README.md

@@ -0,0 +1,54 @@
+# durably
+
+Step-oriented resumable batch execution for Node.js and browsers using SQLite.
+
+> **Note**: This package is under development. The API is not yet implemented.
+
+## Features (Planned)
+
+- Resumable batch processing with step-level persistence
+- Works in both Node.js and browsers
+- Uses SQLite for state management (better-sqlite3, libsql, or WASM)
+- Minimal dependencies - just Kysely as a peer dependency
+- Event system for monitoring and extensibility
+- Plugin architecture for optional features
+
+## Installation
+
+```bash
+npm install durably kysely better-sqlite3
+```
+
+## Usage (Preview)
+
+```ts
+import { createClient, defineJob } from 'durably'
+import Database from 'better-sqlite3'
+import { BetterSqlite3Dialect } from 'kysely'
+
+const dialect = new BetterSqlite3Dialect({
+  database: new Database('app.db'),
+})
+
+const client = createClient({ dialect })
+
+const syncUsers = defineJob('sync-users', async (ctx, payload: { orgId: string }) => {
+  const users = await ctx.run('fetch-users', async () => {
+    return api.fetchUsers(payload.orgId)
+  })
+
+  await ctx.run('save-to-db', async () => {
+    await db.upsertUsers(users)
+  })
+})
+
+client.register(syncUsers)
+await client.migrate()
+client.start()
+
+await syncUsers.trigger({ orgId: 'org_123' })
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * durably - Step-oriented resumable batch execution for Node.js and browsers
+ *
+ * This package is under development. See https://github.com/coji/durably for updates.
+ */
+interface ClientOptions {
+    dialect: unknown;
+    pollingInterval?: number;
+    heartbeatInterval?: number;
+    staleThreshold?: number;
+}
+interface JobContext<TPayload> {
+    run<T>(name: string, fn: () => Promise<T>): Promise<T>;
+    log: {
+        info(message: string, data?: Record<string, unknown>): void;
+        warn(message: string, data?: Record<string, unknown>): void;
+        error(message: string, data?: Record<string, unknown>): void;
+    };
+}
+interface Job<TPayload> {
+    name: string;
+    trigger(payload: TPayload, options?: {
+        idempotencyKey?: string;
+        concurrencyKey?: string;
+    }): Promise<{
+        runId: string;
+    }>;
+    batchTrigger(items: Array<{
+        payload: TPayload;
+        options?: {
+            idempotencyKey?: string;
+            concurrencyKey?: string;
+        };
+    }>): Promise<Array<{
+        runId: string;
+    }>>;
+}
+interface Client {
+    register<TPayload>(job: Job<TPayload>): void;
+    migrate(): Promise<void>;
+    start(): void;
+    stop(): Promise<void>;
+    retry(runId: string): Promise<void>;
+    getRuns(filter?: {
+        status?: string;
+    }): Promise<Array<{
+        id: string;
+    }>>;
+    on(event: string, handler: (event: unknown) => void): void;
+    use(plugin: unknown): void;
+}
+declare function createClient(_options: ClientOptions): Client;
+declare function defineJob<TPayload>(_name: string, _handler: (ctx: JobContext<TPayload>, payload: TPayload) => Promise<void>): Job<TPayload>;
+
+export { type Client, type ClientOptions, type Job, type JobContext, createClient, defineJob };

package/dist/index.js

@@ -0,0 +1,16 @@
+// src/index.ts
+function createClient(_options) {
+  throw new Error(
+    "durably is not yet implemented. This is a placeholder package. See https://github.com/coji/durably for updates."
+  );
+}
+function defineJob(_name, _handler) {
+  throw new Error(
+    "durably is not yet implemented. This is a placeholder package. See https://github.com/coji/durably for updates."
+  );
+}
+export {
+  createClient,
+  defineJob
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * durably - Step-oriented resumable batch execution for Node.js and browsers\n *\n * This package is under development. See https://github.com/coji/durably for updates.\n */\n\nexport interface ClientOptions {\n  dialect: unknown\n  pollingInterval?: number\n  heartbeatInterval?: number\n  staleThreshold?: number\n}\n\nexport interface JobContext<TPayload> {\n  run<T>(name: string, fn: () => Promise<T>): Promise<T>\n  log: {\n    info(message: string, data?: Record<string, unknown>): void\n    warn(message: string, data?: Record<string, unknown>): void\n    error(message: string, data?: Record<string, unknown>): void\n  }\n}\n\nexport interface Job<TPayload> {\n  name: string\n  trigger(\n    payload: TPayload,\n    options?: { idempotencyKey?: string; concurrencyKey?: string }\n  ): Promise<{ runId: string }>\n  batchTrigger(\n    items: Array<{\n      payload: TPayload\n      options?: { idempotencyKey?: string; concurrencyKey?: string }\n    }>\n  ): Promise<Array<{ runId: string }>>\n}\n\nexport interface Client {\n  register<TPayload>(job: Job<TPayload>): void\n  migrate(): Promise<void>\n  start(): void\n  stop(): Promise<void>\n  retry(runId: string): Promise<void>\n  getRuns(filter?: { status?: string }): Promise<Array<{ id: string }>>\n  on(event: string, handler: (event: unknown) => void): void\n  use(plugin: unknown): void\n}\n\nexport function createClient(_options: ClientOptions): Client {\n  throw new Error(\n    'durably is not yet implemented. This is a placeholder package. See https://github.com/coji/durably for updates.'\n  )\n}\n\nexport function defineJob<TPayload>(\n  _name: string,\n  _handler: (ctx: JobContext<TPayload>, payload: TPayload) => Promise<void>\n): Job<TPayload> {\n  throw new Error(\n    'durably is not yet implemented. This is a placeholder package. See https://github.com/coji/durably for updates.'\n  )\n}\n"],"mappings":";AA+CO,SAAS,aAAa,UAAiC;AAC5D,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;AAEO,SAAS,UACd,OACA,UACe;AACf,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;","names":[]}

package/dist/plugins/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * durably plugins
+ *
+ * This package is under development. See https://github.com/coji/durably for updates.
+ */
+declare function withLogPersistence(): unknown;
+
+export { withLogPersistence };

package/dist/plugins/index.js

@@ -0,0 +1,10 @@
+// src/plugins/index.ts
+function withLogPersistence() {
+  throw new Error(
+    "durably is not yet implemented. This is a placeholder package. See https://github.com/coji/durably for updates."
+  );
+}
+export {
+  withLogPersistence
+};
+//# sourceMappingURL=index.js.map

package/dist/plugins/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/plugins/index.ts"],"sourcesContent":["/**\n * durably plugins\n *\n * This package is under development. See https://github.com/coji/durably for updates.\n */\n\nexport function withLogPersistence(): unknown {\n  throw new Error(\n    'durably is not yet implemented. This is a placeholder package. See https://github.com/coji/durably for updates.'\n  )\n}\n"],"mappings":";AAMO,SAAS,qBAA8B;AAC5C,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@coji/durably",
+  "version": "0.0.1",
+  "description": "Step-oriented resumable batch execution for Node.js and browsers using SQLite",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./plugins": {
+      "types": "./dist/plugins/index.d.ts",
+      "import": "./dist/plugins/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "batch",
+    "job",
+    "queue",
+    "workflow",
+    "durable",
+    "resumable",
+    "sqlite",
+    "kysely"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coji/durably.git"
+  },
+  "bugs": {
+    "url": "https://github.com/coji/durably/issues"
+  },
+  "homepage": "https://github.com/coji/durably#readme",
+  "peerDependencies": {
+    "kysely": ">=0.27.0"
+  },
+  "peerDependenciesMeta": {
+    "kysely": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "kysely": "^0.27.0",
+    "tsup": "8.5.1",
+    "typescript": "^5.7.2"
+  },
+  "scripts": {
+    "build": "tsup"
+  }
+}