@offlinejs/queue 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { EntityRecord, MutationOperation, PartialEntity, StorageAdapter, QueuedMutation, QueueProcessingOptions, RetryOptions } from '@offlinejs/types';
+
+interface MutationQueueOptions {
+    collectionName?: string;
+    storage: StorageAdapter;
+}
+interface AddMutationInput<TRecord extends EntityRecord = EntityRecord> {
+    base?: TRecord | null;
+    collection: string;
+    operation: MutationOperation;
+    payload?: PartialEntity<TRecord>;
+    priority?: number;
+    recordId: string;
+}
+declare const defaultRetryOptions: RetryOptions;
+declare const defaultQueueProcessingOptions: QueueProcessingOptions;
+declare class MutationQueue {
+    private readonly collectionName;
+    private readonly storage;
+    private paused;
+    constructor(options: MutationQueueOptions);
+    add<TRecord extends EntityRecord>(input: AddMutationInput<TRecord>): Promise<QueuedMutation<TRecord>>;
+    all(): Promise<QueuedMutation[]>;
+    due(options?: QueueProcessingOptions): Promise<QueuedMutation[]>;
+    remove(id: string): Promise<void>;
+    markAttempt(id: string, status?: QueuedMutation["status"]): Promise<QueuedMutation | null>;
+    pause(): void;
+    resume(): void;
+    isPaused(): boolean;
+    clear(): Promise<void>;
+}
+declare const createMutationQueue: (options: MutationQueueOptions) => MutationQueue;
+
+export { type AddMutationInput, MutationQueue, type MutationQueueOptions, createMutationQueue, defaultQueueProcessingOptions, defaultRetryOptions };

package/dist/index.js

@@ -0,0 +1,100 @@
+import { now, createId, backoffDelay } from '@offlinejs/utils';
+
+// src/index.ts
+var defaultRetryOptions = {
+  baseDelayMs: 500,
+  factor: 2,
+  jitter: true,
+  maxAttempts: 5,
+  maxDelayMs: 3e4
+};
+var defaultQueueProcessingOptions = {
+  batchSize: 25,
+  retry: defaultRetryOptions
+};
+var MutationQueue = class {
+  collectionName;
+  storage;
+  paused = false;
+  constructor(options) {
+    this.collectionName = options.collectionName ?? "__offline_queue";
+    this.storage = options.storage;
+  }
+  async add(input) {
+    const mutation = {
+      id: createId(),
+      collection: input.collection,
+      operation: input.operation,
+      recordId: input.recordId,
+      createdAt: now(),
+      priority: input.priority ?? 0,
+      retries: 0,
+      status: "pending"
+    };
+    if (input.payload !== void 0) {
+      mutation.payload = input.payload;
+    }
+    if (input.base !== void 0) {
+      mutation.base = input.base;
+    }
+    await this.storage.set(this.collectionName, mutation);
+    return mutation;
+  }
+  async all() {
+    const mutations = await this.storage.find(this.collectionName);
+    return mutations.sort((left, right) => {
+      if (left.priority !== right.priority) {
+        return right.priority - left.priority;
+      }
+      return left.createdAt - right.createdAt;
+    });
+  }
+  async due(options = defaultQueueProcessingOptions) {
+    if (this.paused) {
+      return [];
+    }
+    const timestamp = now();
+    const mutations = await this.all();
+    return mutations.filter((mutation) => mutation.status !== "processing").filter((mutation) => mutation.retries < options.retry.maxAttempts).filter((mutation) => {
+      if (!mutation.lastAttemptAt) {
+        return true;
+      }
+      const delay = backoffDelay(mutation.retries, options.retry);
+      return mutation.lastAttemptAt + delay <= timestamp;
+    }).slice(0, options.batchSize);
+  }
+  async remove(id) {
+    await this.storage.delete(this.collectionName, id);
+  }
+  async markAttempt(id, status = "failed") {
+    const mutation = await this.storage.get(this.collectionName, id);
+    if (!mutation) {
+      return null;
+    }
+    const updated = {
+      ...mutation,
+      lastAttemptAt: now(),
+      retries: mutation.retries + 1,
+      status
+    };
+    await this.storage.set(this.collectionName, updated);
+    return updated;
+  }
+  pause() {
+    this.paused = true;
+  }
+  resume() {
+    this.paused = false;
+  }
+  isPaused() {
+    return this.paused;
+  }
+  async clear() {
+    await this.storage.clear(this.collectionName);
+  }
+};
+var createMutationQueue = (options) => new MutationQueue(options);
+
+export { MutationQueue, createMutationQueue, defaultQueueProcessingOptions, defaultRetryOptions };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AAyBO,IAAM,mBAAA,GAAoC;AAAA,EAC/C,WAAA,EAAa,GAAA;AAAA,EACb,MAAA,EAAQ,CAAA;AAAA,EACR,MAAA,EAAQ,IAAA;AAAA,EACR,WAAA,EAAa,CAAA;AAAA,EACb,UAAA,EAAY;AACd;AAEO,IAAM,6BAAA,GAAwD;AAAA,EACnE,SAAA,EAAW,EAAA;AAAA,EACX,KAAA,EAAO;AACT;AAEO,IAAM,gBAAN,MAAoB;AAAA,EACR,cAAA;AAAA,EACA,OAAA;AAAA,EACT,MAAA,GAAS,KAAA;AAAA,EAEjB,YAAY,OAAA,EAA+B;AACzC,IAAA,IAAA,CAAK,cAAA,GAAiB,QAAQ,cAAA,IAAkB,iBAAA;AAChD,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,OAAA;AAAA,EACzB;AAAA,EAEA,MAAM,IACJ,KAAA,EACkC;AAClC,IAAA,MAAM,QAAA,GAAoC;AAAA,MACxC,IAAI,QAAA,EAAS;AAAA,MACb,YAAY,KAAA,CAAM,UAAA;AAAA,MAClB,WAAW,KAAA,CAAM,SAAA;AAAA,MACjB,UAAU,KAAA,CAAM,QAAA;AAAA,MAChB,WAAW,GAAA,EAAI;AAAA,MACf,QAAA,EAAU,MAAM,QAAA,IAAY,CAAA;AAAA,MAC5B,OAAA,EAAS,CAAA;AAAA,MACT,MAAA,EAAQ;AAAA,KACV;AAEA,IAAA,IAAI,KAAA,CAAM,YAAY,MAAA,EAAW;AAC/B,MAAA,QAAA,CAAS,UAAU,KAAA,CAAM,OAAA;AAAA,IAC3B;AAEA,IAAA,IAAI,KAAA,CAAM,SAAS,MAAA,EAAW;AAC5B,MAAA,QAAA,CAAS,OAAO,KAAA,CAAM,IAAA;AAAA,IACxB;AAEA,IAAA,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,IAAA,CAAK,gBAAgB,QAAQ,CAAA;AACpD,IAAA,OAAO,QAAA;AAAA,EACT;AAAA,EAEA,MAAM,GAAA,GAAiC;AACrC,IAAA,MAAM,YAAY,MAAM,IAAA,CAAK,OAAA,CAAQ,IAAA,CAAqB,KAAK,cAAc,CAAA;AAE7E,IAAA,OAAO,SAAA,CAAU,IAAA,CAAK,CAAC,IAAA,EAAM,KAAA,KAAU;AACrC,MAAA,IAAI,IAAA,CAAK,QAAA,KAAa,KAAA,CAAM,QAAA,EAAU;AACpC,QAAA,OAAO,KAAA,CAAM,WAAW,IAAA,CAAK,QAAA;AAAA,MAC/B;AAEA,MAAA,OAAO,IAAA,CAAK,YAAY,KAAA,CAAM,SAAA;AAAA,IAChC,CAAC,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,GAAA,CACJ,OAAA,GAAkC,6BAAA,EACP;AAC3B,IAAA,IAAI,KAAK,MAAA,EAAQ;AACf,MAAA,OAAO,EAAC;AAAA,IACV;AAEA,IAAA,MAAM,YAAY,GAAA,EAAI;AACtB,IAAA,MAAM,SAAA,GAAY,MAAM,IAAA,CAAK,GAAA,EAAI;AAEjC,IAAA,OAAO,UACJ,MAAA,CAAO,CAAC,aAAa,QAAA,CAAS,MAAA,KAAW,YAAY,CAAA,CACrD,MAAA,CAAO,CAAC,QAAA,KAAa,QAAA,CAAS,UAAU,OAAA,CAAQ,KAAA,CAAM,WAAW,CAAA,CACjE,MAAA,CAAO,CAAC,QAAA,KAAa;AACpB,MAAA,IAAI,CAAC,SAAS,aAAA,EAAe;AAC3B,QAAA,OAAO,IAAA;AAAA,MACT;AAEA,MAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,CAAS,OAAA,EAAS,QAAQ,KAAK,CAAA;AAC1D,MAAA,OAAO,QAAA,CAAS,gBAAgB,KAAA,IAAS,SAAA;AAAA,IAC3C,CAAC,CAAA,CACA,KAAA,CAAM,CAAA,EAAG,QAAQ,SAAS,CAAA;AAAA,EAC/B;AAAA,EAEA,MAAM,OAAO,EAAA,EAA2B;AACtC,IAAA,MAAM,IAAA,CAAK,OAAA,CAAQ,MAAA,CAAO,IAAA,CAAK,gBAAgB,EAAE,CAAA;AAAA,EACnD;AAAA,EAEA,MAAM,WAAA,CACJ,EAAA,EACA,MAAA,GAAmC,QAAA,EACH;AAChC,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,QAAQ,GAAA,CAAoB,IAAA,CAAK,gBAAgB,EAAE,CAAA;AAE/E,IAAA,IAAI,CAAC,QAAA,EAAU;AACb,MAAA,OAAO,IAAA;AAAA,IACT;AAEA,IAAA,MAAM,OAAA,GAA0B;AAAA,MAC9B,GAAG,QAAA;AAAA,MACH,eAAe,GAAA,EAAI;AAAA,MACnB,OAAA,EAAS,SAAS,OAAA,GAAU,CAAA;AAAA,MAC5B;AAAA,KACF;AAEA,IAAA,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,IAAA,CAAK,gBAAgB,OAAO,CAAA;AACnD,IAAA,OAAO,OAAA;AAAA,EACT;AAAA,EAEA,KAAA,GAAc;AACZ,IAAA,IAAA,CAAK,MAAA,GAAS,IAAA;AAAA,EAChB;AAAA,EAEA,MAAA,GAAe;AACb,IAAA,IAAA,CAAK,MAAA,GAAS,KAAA;AAAA,EAChB;AAAA,EAEA,QAAA,GAAoB;AAClB,IAAA,OAAO,IAAA,CAAK,MAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAA,GAAuB;AAC3B,IAAA,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAA,CAAM,IAAA,CAAK,cAAc,CAAA;AAAA,EAC9C;AACF;AAEO,IAAM,mBAAA,GAAsB,CAAC,OAAA,KAClC,IAAI,cAAc,OAAO","file":"index.js","sourcesContent":["import type {\n  EntityRecord,\n  MutationOperation,\n  PartialEntity,\n  QueueProcessingOptions,\n  QueuedMutation,\n  RetryOptions,\n  StorageAdapter\n} from \"@offlinejs/types\";\nimport { backoffDelay, createId, now } from \"@offlinejs/utils\";\n\nexport interface MutationQueueOptions {\n  collectionName?: string;\n  storage: StorageAdapter;\n}\n\nexport interface AddMutationInput<TRecord extends EntityRecord = EntityRecord> {\n  base?: TRecord | null;\n  collection: string;\n  operation: MutationOperation;\n  payload?: PartialEntity<TRecord>;\n  priority?: number;\n  recordId: string;\n}\n\nexport const defaultRetryOptions: RetryOptions = {\n  baseDelayMs: 500,\n  factor: 2,\n  jitter: true,\n  maxAttempts: 5,\n  maxDelayMs: 30_000\n};\n\nexport const defaultQueueProcessingOptions: QueueProcessingOptions = {\n  batchSize: 25,\n  retry: defaultRetryOptions\n};\n\nexport class MutationQueue {\n  private readonly collectionName: string;\n  private readonly storage: StorageAdapter;\n  private paused = false;\n\n  constructor(options: MutationQueueOptions) {\n    this.collectionName = options.collectionName ?? \"__offline_queue\";\n    this.storage = options.storage;\n  }\n\n  async add<TRecord extends EntityRecord>(\n    input: AddMutationInput<TRecord>\n  ): Promise<QueuedMutation<TRecord>> {\n    const mutation: QueuedMutation<TRecord> = {\n      id: createId(),\n      collection: input.collection,\n      operation: input.operation,\n      recordId: input.recordId,\n      createdAt: now(),\n      priority: input.priority ?? 0,\n      retries: 0,\n      status: \"pending\"\n    };\n\n    if (input.payload !== undefined) {\n      mutation.payload = input.payload;\n    }\n\n    if (input.base !== undefined) {\n      mutation.base = input.base;\n    }\n\n    await this.storage.set(this.collectionName, mutation);\n    return mutation;\n  }\n\n  async all(): Promise<QueuedMutation[]> {\n    const mutations = await this.storage.find<QueuedMutation>(this.collectionName);\n\n    return mutations.sort((left, right) => {\n      if (left.priority !== right.priority) {\n        return right.priority - left.priority;\n      }\n\n      return left.createdAt - right.createdAt;\n    });\n  }\n\n  async due(\n    options: QueueProcessingOptions = defaultQueueProcessingOptions\n  ): Promise<QueuedMutation[]> {\n    if (this.paused) {\n      return [];\n    }\n\n    const timestamp = now();\n    const mutations = await this.all();\n\n    return mutations\n      .filter((mutation) => mutation.status !== \"processing\")\n      .filter((mutation) => mutation.retries < options.retry.maxAttempts)\n      .filter((mutation) => {\n        if (!mutation.lastAttemptAt) {\n          return true;\n        }\n\n        const delay = backoffDelay(mutation.retries, options.retry);\n        return mutation.lastAttemptAt + delay <= timestamp;\n      })\n      .slice(0, options.batchSize);\n  }\n\n  async remove(id: string): Promise<void> {\n    await this.storage.delete(this.collectionName, id);\n  }\n\n  async markAttempt(\n    id: string,\n    status: QueuedMutation[\"status\"] = \"failed\"\n  ): Promise<QueuedMutation | null> {\n    const mutation = await this.storage.get<QueuedMutation>(this.collectionName, id);\n\n    if (!mutation) {\n      return null;\n    }\n\n    const updated: QueuedMutation = {\n      ...mutation,\n      lastAttemptAt: now(),\n      retries: mutation.retries + 1,\n      status\n    };\n\n    await this.storage.set(this.collectionName, updated);\n    return updated;\n  }\n\n  pause(): void {\n    this.paused = true;\n  }\n\n  resume(): void {\n    this.paused = false;\n  }\n\n  isPaused(): boolean {\n    return this.paused;\n  }\n\n  async clear(): Promise<void> {\n    await this.storage.clear(this.collectionName);\n  }\n}\n\nexport const createMutationQueue = (options: MutationQueueOptions): MutationQueue =>\n  new MutationQueue(options);\n"]}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@offlinejs/queue",
+  "version": "0.1.0",
+  "description": "Persistent mutation queue with priority, retries, pause/resume, and batching.",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@offlinejs/utils": "0.1.0",
+    "@offlinejs/types": "0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "latest",
+    "typescript": "latest"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit"
+  }
+}