@fedify/cfworkers 2.1.4 → 2.1.5

package/dist/mod.d.ts

@@ -1,7 +1,46 @@
-import { KVNamespace, Queue } from "@cloudflare/workers-types";
+import { Queue } from "@cloudflare/workers-types";
 import { KvKey, KvStore, KvStoreListEntry, KvStoreSetOptions, MessageQueue, MessageQueueEnqueueOptions, MessageQueueListenOptions } from "@fedify/fedify/federation";
 
 //#region src/mod.d.ts
+interface WorkersKvNamespaceGetWithMetadataResult<Value, Metadata> {
+  readonly value: Value | null;
+  readonly metadata: Metadata | null;
+}
+interface WorkersKvNamespaceListKey<Metadata, Key extends string = string> {
+  readonly name: Key;
+  readonly expiration?: number;
+  readonly metadata?: Metadata;
+}
+interface WorkersKvNamespaceListResult<Metadata, Key extends string = string> {
+  readonly list_complete: boolean;
+  readonly keys: readonly WorkersKvNamespaceListKey<Metadata, Key>[];
+  readonly cursor?: string;
+}
+interface WorkersKvNamespaceListOptions {
+  readonly limit?: number;
+  readonly prefix?: string | null;
+  readonly cursor?: string | null;
+}
+interface WorkersKvNamespacePutOptions {
+  readonly expiration?: number;
+  readonly expirationTtl?: number;
+  readonly metadata?: unknown;
+}
+/**
+* Minimal Cloudflare Workers KV binding shape used by this package.
+* Compatible with both `@cloudflare/workers-types` and `wrangler types`
+* generated declarations.
+* @since 2.0.12
+*/
+interface WorkersKvNamespaceLike<Key extends string = string> {
+  get(key: Key): Promise<string | null>;
+  get<ExpectedValue = unknown>(key: Key, type: "json"): Promise<ExpectedValue | null>;
+  getWithMetadata<Metadata = unknown>(key: Key): Promise<WorkersKvNamespaceGetWithMetadataResult<string, Metadata>>;
+  getWithMetadata<ExpectedValue = unknown, Metadata = unknown>(key: Key, type: "json"): Promise<WorkersKvNamespaceGetWithMetadataResult<ExpectedValue, Metadata>>;
+  put(key: Key, value: string, options?: WorkersKvNamespacePutOptions): Promise<void>;
+  delete(key: Key): Promise<void>;
+  list<Metadata = unknown>(options?: WorkersKvNamespaceListOptions): Promise<WorkersKvNamespaceListResult<Metadata, Key>>;
+}
 /**
 * Result from {@link WorkersMessageQueue.processMessage}.
 * @since 2.0.0
@@ -39,7 +78,7 @@ interface ProcessMessageResult {
 */
 declare class WorkersKvStore implements KvStore {
   #private;
-  constructor(namespace: KVNamespace<string>);
+  constructor(namespace: WorkersKvNamespaceLike<string>);
   get<T = unknown>(key: KvKey): Promise<T | undefined>;
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions): Promise<void>;
   delete(key: KvKey): Promise<void>;
@@ -62,7 +101,7 @@ interface WorkersMessageQueueOptions {
   * guarantees are best-effort.  For strict ordering requirements, consider
   * using Durable Objects.
   */
-  readonly orderingKv?: KVNamespace<string>;
+  readonly orderingKv?: WorkersKvNamespaceLike<string>;
   /**
   * The prefix for ordering key lock keys.  Defaults to `"__fedify_ordering_"`.
   * @default `"__fedify_ordering_"`
@@ -145,4 +184,4 @@ declare class WorkersMessageQueue implements MessageQueue {
   listen(_handler: (message: any) => Promise<void> | void, _options?: MessageQueueListenOptions): Promise<void>;
 }
 //#endregion
-export { ProcessMessageResult, WorkersKvStore, WorkersMessageQueue, WorkersMessageQueueOptions };
+export { ProcessMessageResult, WorkersKvNamespaceLike, WorkersKvStore, WorkersMessageQueue, WorkersMessageQueueOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/cfworkers",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "description": "Adapt Fedify with Cloudflare Workers",
   "keywords": [
     "Fedify",
@@ -52,7 +52,7 @@
   ],
   "peerDependencies": {
     "@cloudflare/workers-types": "^4.20250906.0",
-    "@fedify/fedify": "^2.1.4"
+    "@fedify/fedify": "^2.1.5"
   },
   "devDependencies": {
     "@cloudflare/vitest-pool-workers": "^0.8.31",
@@ -65,6 +65,7 @@
     "build:self": "tsdown",
     "build": "pnpm --filter @fedify/cfworkers... run build:self",
     "prepublish": "pnpm build",
-    "test": "vitest run"
+    "pretest": "pnpm build",
+    "test": "tsc -p test/typecheck/tsconfig.json --noEmit && vitest run"
   }
 }