@fedify/cfworkers 1.9.0-pr.388.1454 → 1.9.0-pr.388.1457

package/README.md

@@ -0,0 +1,110 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/cfworkers: Adapt Fedify with Cloudflare Workers
+======================================================
+
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+[![Follow @fedify@hollo.social][@fedify@hollo.social badge]][@fedify@hollo.social]
+
+*This package is available since Fedify 1.9.0.*
+
+This package provides [Fedify]'s [`KvStore`] and [`MessageQueue`]
+implementations for [Cloudflare Workers]:
+
+ -  [`WorkersKvStore`]
+ -  [`WorkersMessageQueue`]
+
+~~~~ typescript
+import type { Federation } from "@fedify/fedify";
+import { WorkersKvStore, WorkersMessageQueue } from "@fedify/cfworkers";
+
+export default {
+  async fetch(request, env, ctx) {
+    const federation = createFederation({
+      kv: new WorkersKvStore(env.KV_BINDING),
+      queue: new WorkersMessageQueue(env.QUEUE_BINDING),
+      // ... other options
+    });
+    
+    return federation.handle(request, { contextData: env });
+  },
+  
+  async queue(batch, env, ctx) {
+    const federation = createFederation({
+      kv: new WorkersKvStore(env.KV_BINDING),
+      queue: new WorkersMessageQueue(env.QUEUE_BINDING),
+      // ... other options
+    });
+    
+    for (const message of batch.messages) {
+      await federation.processQueuedTask(message.body);
+    }
+  }
+} satisfies ExportedHandler<{ 
+  KV_BINDING: KVNamespace<string>;
+  QUEUE_BINDING: Queue;
+}>;
+~~~~
+
+`WorkersKvStore`
+----------------
+
+`WorkersKvStore` is a key–value store implementation for [Cloudflare Workers]
+that uses Cloudflare's built-in [Cloudflare Workers KV] API.  It provides
+persistent storage and good performance for Cloudflare Workers environments.
+It's suitable for production use in Cloudflare Workers applications.
+
+`WorkersMessageQueue`
+---------------------
+
+`WorkersMessageQueue` is a message queue implementation for [Cloudflare Workers]
+that uses Cloudflare's built-in [Cloudflare Queues] API.  It provides
+scalability and high performance, making it suitable for production use in
+Cloudflare Workers environments.  It requires a Cloudflare Queues setup and
+management.
+
+> [!NOTE]
+> Since your `KVNamespace` and `Queue` are not bound to global variables, but rather
+> passed as arguments to the `fetch()` and `queue()` methods, you need to instantiate
+> your `Federation` object inside these methods, rather than at the top level.
+>
+> For better organization, you probably want to use a builder pattern to
+> register your dispatchers and listeners before instantiating the `Federation`
+> object.
+
+> [!NOTE]
+> The [Cloudflare Queues] API does not provide a way to poll messages from
+> the queue, so `WorkersMessageQueue.listen()` method always throws
+> a `TypeError` when invoked.  Instead, you should define a `queue()` method
+> in your Cloudflare worker, which will be called by the Cloudflare Queues
+> API when new messages are available in the queue.  Inside the `queue()`
+> method, you need to call `Federation.processQueuedTask()` method to manually
+> process the messages.  The `queue()` method is the only way to consume
+> messages from the queue in Cloudflare Workers.
+
+Installation
+------------
+
+~~~~ sh
+deno add jsr:@fedify/cfworkers  # Deno
+npm  add     @fedify/cfworkers  # npm
+pnpm add     @fedify/cfworkers  # pnpm
+yarn add     @fedify/cfworkers  # Yarn
+bun  add     @fedify/cfworkers  # Bun
+~~~~
+
+[JSR]: https://jsr.io/@fedify/cfworkers
+[JSR badge]: https://jsr.io/badges/@fedify/cfworkers
+[npm]: https://www.npmjs.com/package/@fedify/cfworkers
+[npm badge]: https://img.shields.io/npm/v/@fedify/cfworkers?logo=npm
+[@fedify@hollo.social badge]: https://fedi-badge.deno.dev/@fedify@hollo.social/followers.svg
+[@fedify@hollo.social]: https://hollo.social/@fedify
+[Fedify]: https://fedify.dev/
+[`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
+[`MessageQueue`]: https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue
+[`WorkersKvStore`]: https://jsr.io/@fedify/cfworkers/doc/~/WorkersKvStore
+[`WorkersMessageQueue`]: https://jsr.io/@fedify/cfworkers/doc/~/WorkersMessageQueue
+[Cloudflare Workers]: https://workers.cloudflare.com/
+[Cloudflare Workers KV]: https://developers.cloudflare.com/kv/
+[Cloudflare Queues]: https://developers.cloudflare.com/queues/

package/dist/mod.d.ts

@@ -12,7 +12,7 @@ import { KvKey, KvStore, KvStoreSetOptions, MessageQueue, MessageQueueEnqueueOpt
  * operation, as Cloudflare Workers KV does not support atomic compare-and-swap
  * operations.  If you need this functionality, consider using a different
  * key–value store that supports atomic operations.
- * @since 1.6.0
+ * @since 1.9.0
  */
 declare class WorkersKvStore implements KvStore {
   #private;
@@ -31,7 +31,7 @@ declare class WorkersKvStore implements KvStore {
  * way as other message queue systems.  Instead, you should use
  * the {@link Federation.processQueuedTask} method to process messages
  * passed to the queue.
- * @since 1.6.0
+ * @since 1.9.0
  */
 declare class WorkersMessageQueue implements MessageQueue {
   #private;

package/dist/mod.js

@@ -8,7 +8,7 @@
 * operation, as Cloudflare Workers KV does not support atomic compare-and-swap
 * operations.  If you need this functionality, consider using a different
 * key–value store that supports atomic operations.
-* @since 1.6.0
+* @since 1.9.0
 */
 var WorkersKvStore = class {
 	#namespace;
@@ -45,7 +45,7 @@ var WorkersKvStore = class {
 * way as other message queue systems.  Instead, you should use
 * the {@link Federation.processQueuedTask} method to process messages
 * passed to the queue.
-* @since 1.6.0
+* @since 1.9.0
 */
 var WorkersMessageQueue = class {
 	#queue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/cfworkers",
-  "version": "1.9.0-pr.388.1454+d7cc8c70",
+  "version": "1.9.0-pr.388.1457+92d31874",
   "description": "Adapt Fedify with Cloudflare Workers",
   "keywords": [
     "Fedify",
@@ -52,7 +52,7 @@
   ],
   "peerDependencies": {
     "@cloudflare/workers-types": "^4.20250529.0",
-    "@fedify/fedify": "1.9.0-pr.388.1454+d7cc8c70"
+    "@fedify/fedify": "1.9.0-pr.388.1457+92d31874"
   },
   "devDependencies": {
     "tsdown": "^0.12.9",