durable-cf-streams 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,76 @@
+import { O as Offset } from './interface-DFfkkkVM.js';
+export { A as AppendOptions, b as AppendResult, G as GetOptions, c as GetResult, H as HeadResult, P as PutOptions, a as PutResult, d as StreamMessage, e as StreamMetadata, S as StreamStore, W as WaitResult } from './interface-DFfkkkVM.js';
+
+declare const generateCursor: () => string;
+declare const parseCursor: (cursor: string) => number | null;
+declare const isValidCursor: (cursor: string) => boolean;
+declare const compareCursors: (a: string, b: string) => number;
+declare const isNewerCursor: (cursor: string, clientCursor: string | undefined) => boolean;
+declare const getNextCursor: (clientCursor: string | undefined) => string;
+
+declare class StreamNotFoundError extends Error {
+    readonly _tag: "StreamNotFoundError";
+    readonly path: string;
+    constructor(path: string);
+}
+declare class StreamConflictError extends Error {
+    readonly _tag: "StreamConflictError";
+    constructor(message: string);
+}
+declare class SequenceConflictError extends Error {
+    readonly _tag: "SequenceConflictError";
+    readonly expected: string;
+    readonly received: string;
+    constructor(expected: string, received: string);
+}
+declare class ContentTypeMismatchError extends Error {
+    readonly _tag: "ContentTypeMismatchError";
+    readonly expected: string;
+    readonly received: string;
+    constructor(expected: string, received: string);
+}
+declare class InvalidJsonError extends Error {
+    readonly _tag: "InvalidJsonError";
+    constructor(message: string);
+}
+declare class InvalidOffsetError extends Error {
+    readonly _tag: "InvalidOffsetError";
+    constructor(offset: string);
+}
+declare class PayloadTooLargeError extends Error {
+    readonly _tag: "PayloadTooLargeError";
+    readonly maxBytes: number;
+    readonly receivedBytes: number;
+    constructor(maxBytes: number, receivedBytes: number);
+}
+type StreamError = StreamNotFoundError | StreamConflictError | SequenceConflictError | ContentTypeMismatchError | InvalidJsonError | InvalidOffsetError | PayloadTooLargeError;
+
+type ParsedOffset = {
+    readonly seq: number;
+    readonly pos: number;
+};
+declare const initialOffset: () => Offset;
+declare const isSentinelOffset: (offset: string) => boolean;
+declare const isValidOffset: (offset: string) => boolean;
+declare const normalizeOffset: (offset: string) => Offset;
+declare const parseOffset: (offset: string) => ParsedOffset | null;
+declare const formatOffset: (seq: number, pos: number) => Offset;
+declare const compareOffsets: (a: Offset, b: Offset) => -1 | 0 | 1;
+declare const advanceOffset: (offset: Offset, byteCount: number) => Offset;
+declare const incrementSeq: (offset: Offset) => Offset;
+
+declare const normalizeContentType: (contentType: string) => string;
+declare const isJsonContentType: (contentType: string) => boolean;
+declare const validateTTL: (ttl: string) => number | null;
+declare const validateExpiresAt: (value: string) => Date | null;
+declare const generateETag: (path: string, startOffset: Offset, endOffset: Offset) => string;
+declare const parseETag: (etag: string) => {
+    path: string;
+    startOffset: Offset;
+    endOffset: Offset;
+} | null;
+declare const processJsonAppend: (existing: Uint8Array, newData: Uint8Array) => Uint8Array;
+declare const formatJsonResponse: (data: Uint8Array) => Uint8Array;
+declare const validateJsonCreate: (data: Uint8Array, isPut: boolean) => Uint8Array;
+
+export { ContentTypeMismatchError, InvalidJsonError, InvalidOffsetError, Offset, type ParsedOffset, PayloadTooLargeError, SequenceConflictError, StreamConflictError, type StreamError, StreamNotFoundError, advanceOffset, compareCursors, compareOffsets, formatJsonResponse, formatOffset, generateCursor, generateETag, getNextCursor, incrementSeq, initialOffset, isJsonContentType, isNewerCursor, isSentinelOffset, isValidCursor, isValidOffset, normalizeContentType, normalizeOffset, parseCursor, parseETag, parseOffset, processJsonAppend, validateExpiresAt, validateJsonCreate, validateTTL };

package/dist/index.js

@@ -0,0 +1,66 @@
+import {
+  ContentTypeMismatchError,
+  InvalidJsonError,
+  InvalidOffsetError,
+  PayloadTooLargeError,
+  SequenceConflictError,
+  StreamConflictError,
+  StreamNotFoundError,
+  advanceOffset,
+  compareCursors,
+  compareOffsets,
+  formatJsonResponse,
+  formatOffset,
+  generateCursor,
+  generateETag,
+  getNextCursor,
+  incrementSeq,
+  initialOffset,
+  isJsonContentType,
+  isNewerCursor,
+  isSentinelOffset,
+  isValidCursor,
+  isValidOffset,
+  normalizeContentType,
+  normalizeOffset,
+  parseCursor,
+  parseETag,
+  parseOffset,
+  processJsonAppend,
+  validateExpiresAt,
+  validateJsonCreate,
+  validateTTL
+} from "./chunk-5N2UNHIW.js";
+export {
+  ContentTypeMismatchError,
+  InvalidJsonError,
+  InvalidOffsetError,
+  PayloadTooLargeError,
+  SequenceConflictError,
+  StreamConflictError,
+  StreamNotFoundError,
+  advanceOffset,
+  compareCursors,
+  compareOffsets,
+  formatJsonResponse,
+  formatOffset,
+  generateCursor,
+  generateETag,
+  getNextCursor,
+  incrementSeq,
+  initialOffset,
+  isJsonContentType,
+  isNewerCursor,
+  isSentinelOffset,
+  isValidCursor,
+  isValidOffset,
+  normalizeContentType,
+  normalizeOffset,
+  parseCursor,
+  parseETag,
+  parseOffset,
+  processJsonAppend,
+  validateExpiresAt,
+  validateJsonCreate,
+  validateTTL
+};

package/dist/interface-DFfkkkVM.d.ts

@@ -0,0 +1,63 @@
+type Offset = string;
+type StreamMessage = {
+    readonly offset: Offset;
+    readonly timestamp: number;
+    readonly data: Uint8Array;
+};
+type StreamMetadata = {
+    readonly path: string;
+    readonly contentType: string;
+    readonly ttlSeconds?: number;
+    readonly expiresAt?: string;
+    readonly createdAt: number;
+};
+type PutOptions = {
+    readonly contentType: string;
+    readonly ttlSeconds?: number;
+    readonly expiresAt?: string;
+    readonly data?: Uint8Array;
+};
+type PutResult = {
+    readonly created: boolean;
+    readonly nextOffset: Offset;
+};
+type AppendOptions = {
+    readonly contentType?: string;
+    readonly seq?: string;
+};
+type AppendResult = {
+    readonly nextOffset: Offset;
+};
+type GetOptions = {
+    readonly offset?: Offset;
+};
+type GetResult = {
+    readonly messages: StreamMessage[];
+    readonly nextOffset: Offset;
+    readonly upToDate: boolean;
+    readonly cursor: string;
+    readonly etag: string;
+    readonly contentType: string;
+};
+type HeadResult = {
+    readonly contentType: string;
+    readonly nextOffset: Offset;
+    readonly etag: string;
+};
+type WaitResult = {
+    readonly messages: StreamMessage[];
+    readonly timedOut: boolean;
+};
+
+type StreamStore = {
+    put(path: string, options: PutOptions): Promise<PutResult>;
+    append(path: string, data: Uint8Array, options?: AppendOptions): Promise<AppendResult>;
+    get(path: string, options?: GetOptions): Promise<GetResult>;
+    head(path: string): Promise<HeadResult | null>;
+    delete(path: string): Promise<void>;
+    has(path: string): boolean;
+    waitForData(path: string, offset: Offset, timeoutMs: number): Promise<WaitResult>;
+    formatResponse(path: string, messages: StreamMessage[]): Uint8Array;
+};
+
+export type { AppendOptions as A, GetOptions as G, HeadResult as H, Offset as O, PutOptions as P, StreamStore as S, WaitResult as W, PutResult as a, AppendResult as b, GetResult as c, StreamMessage as d, StreamMetadata as e };

package/dist/storage/d1.d.ts

@@ -0,0 +1,21 @@
+import { S as StreamStore, P as PutOptions, a as PutResult, A as AppendOptions, b as AppendResult, G as GetOptions, c as GetResult, H as HeadResult, O as Offset, W as WaitResult, d as StreamMessage } from '../interface-DFfkkkVM.js';
+
+declare class D1Store implements StreamStore {
+    private readonly db;
+    private readonly waiters;
+    private readonly streamCache;
+    constructor(db: D1Database);
+    static schema: string;
+    initialize(): Promise<void>;
+    put(path: string, options: PutOptions): Promise<PutResult>;
+    append(path: string, data: Uint8Array, options?: AppendOptions): Promise<AppendResult>;
+    get(path: string, options?: GetOptions): Promise<GetResult>;
+    head(path: string): Promise<HeadResult | null>;
+    delete(path: string): Promise<void>;
+    has(path: string): boolean;
+    waitForData(path: string, offset: Offset, timeoutMs: number): Promise<WaitResult>;
+    formatResponse(path: string, messages: StreamMessage[]): Uint8Array;
+    private notifyWaiters;
+}
+
+export { D1Store };

package/dist/storage/d1.js

@@ -0,0 +1,8 @@
+import {
+  D1Store
+} from "../chunk-E7XMLPFW.js";
+import "../chunk-VLDLQ6TP.js";
+import "../chunk-5N2UNHIW.js";
+export {
+  D1Store
+};

package/dist/storage/index.d.ts

@@ -0,0 +1,5 @@
+export { D1Store } from './d1.js';
+export { S as StreamStore } from '../interface-DFfkkkVM.js';
+export { KVStore } from './kv.js';
+export { MemoryStore } from './memory.js';
+export { R2Store } from './r2.js';

package/dist/storage/index.js

@@ -0,0 +1,20 @@
+import {
+  D1Store
+} from "../chunk-E7XMLPFW.js";
+import {
+  KVStore
+} from "../chunk-KHGAPSJ7.js";
+import {
+  MemoryStore
+} from "../chunk-AU5YTPHF.js";
+import {
+  R2Store
+} from "../chunk-LK4KY5UI.js";
+import "../chunk-VLDLQ6TP.js";
+import "../chunk-5N2UNHIW.js";
+export {
+  D1Store,
+  KVStore,
+  MemoryStore,
+  R2Store
+};

package/dist/storage/kv.d.ts

@@ -0,0 +1,21 @@
+import { S as StreamStore, P as PutOptions, a as PutResult, A as AppendOptions, b as AppendResult, G as GetOptions, c as GetResult, H as HeadResult, O as Offset, W as WaitResult, d as StreamMessage } from '../interface-DFfkkkVM.js';
+
+declare class KVStore implements StreamStore {
+    private readonly kv;
+    private readonly waiters;
+    private readonly streamCache;
+    constructor(kv: KVNamespace);
+    private metaKey;
+    private dataKey;
+    put(path: string, options: PutOptions): Promise<PutResult>;
+    append(path: string, data: Uint8Array, options?: AppendOptions): Promise<AppendResult>;
+    get(path: string, options?: GetOptions): Promise<GetResult>;
+    head(path: string): Promise<HeadResult | null>;
+    delete(path: string): Promise<void>;
+    has(path: string): boolean;
+    waitForData(path: string, offset: Offset, timeoutMs: number): Promise<WaitResult>;
+    formatResponse(path: string, messages: StreamMessage[]): Uint8Array;
+    private notifyWaiters;
+}
+
+export { KVStore };

package/dist/storage/kv.js

@@ -0,0 +1,8 @@
+import {
+  KVStore
+} from "../chunk-KHGAPSJ7.js";
+import "../chunk-VLDLQ6TP.js";
+import "../chunk-5N2UNHIW.js";
+export {
+  KVStore
+};

package/dist/storage/memory.d.ts

@@ -0,0 +1,16 @@
+import { S as StreamStore, P as PutOptions, a as PutResult, A as AppendOptions, b as AppendResult, G as GetOptions, c as GetResult, H as HeadResult, O as Offset, W as WaitResult, d as StreamMessage } from '../interface-DFfkkkVM.js';
+
+declare class MemoryStore implements StreamStore {
+    private readonly streams;
+    put(path: string, options: PutOptions): Promise<PutResult>;
+    append(path: string, data: Uint8Array, options?: AppendOptions): Promise<AppendResult>;
+    get(path: string, options?: GetOptions): Promise<GetResult>;
+    head(path: string): Promise<HeadResult | null>;
+    delete(path: string): Promise<void>;
+    has(path: string): boolean;
+    waitForData(path: string, offset: Offset, timeoutMs: number): Promise<WaitResult>;
+    formatResponse(path: string, messages: StreamMessage[]): Uint8Array;
+    private notifyWaiters;
+}
+
+export { MemoryStore };

package/dist/storage/memory.js

@@ -0,0 +1,8 @@
+import {
+  MemoryStore
+} from "../chunk-AU5YTPHF.js";
+import "../chunk-VLDLQ6TP.js";
+import "../chunk-5N2UNHIW.js";
+export {
+  MemoryStore
+};

package/dist/storage/r2.d.ts

@@ -0,0 +1,23 @@
+import { S as StreamStore, P as PutOptions, a as PutResult, A as AppendOptions, b as AppendResult, G as GetOptions, c as GetResult, H as HeadResult, O as Offset, W as WaitResult, d as StreamMessage } from '../interface-DFfkkkVM.js';
+
+declare class R2Store implements StreamStore {
+    private readonly bucket;
+    private readonly waiters;
+    private readonly streamCache;
+    constructor(bucket: R2Bucket);
+    private metaKey;
+    private dataKey;
+    private getMetadata;
+    private getData;
+    put(path: string, options: PutOptions): Promise<PutResult>;
+    append(path: string, data: Uint8Array, options?: AppendOptions): Promise<AppendResult>;
+    get(path: string, options?: GetOptions): Promise<GetResult>;
+    head(path: string): Promise<HeadResult | null>;
+    delete(path: string): Promise<void>;
+    has(path: string): boolean;
+    waitForData(path: string, offset: Offset, timeoutMs: number): Promise<WaitResult>;
+    formatResponse(path: string, messages: StreamMessage[]): Uint8Array;
+    private notifyWaiters;
+}
+
+export { R2Store };

package/dist/storage/r2.js

@@ -0,0 +1,8 @@
+import {
+  R2Store
+} from "../chunk-LK4KY5UI.js";
+import "../chunk-VLDLQ6TP.js";
+import "../chunk-5N2UNHIW.js";
+export {
+  R2Store
+};

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "durable-cf-streams",
+  "version": "0.1.0",
+  "description": "pure building blocks for durable streams on cloudflare",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/flbn/durable-cf-streams.git",
+    "directory": "packages/durable-cf-streams"
+  },
+  "keywords": [
+    "cloudflare",
+    "workers",
+    "durable-objects",
+    "streams",
+    "d1",
+    "kv",
+    "r2"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./storage": {
+      "types": "./dist/storage/index.d.ts",
+      "import": "./dist/storage/index.js"
+    },
+    "./storage/memory": {
+      "types": "./dist/storage/memory.d.ts",
+      "import": "./dist/storage/memory.js"
+    },
+    "./storage/d1": {
+      "types": "./dist/storage/d1.d.ts",
+      "import": "./dist/storage/d1.js"
+    },
+    "./storage/kv": {
+      "types": "./dist/storage/kv.d.ts",
+      "import": "./dist/storage/kv.js"
+    },
+    "./storage/r2": {
+      "types": "./dist/storage/r2.d.ts",
+      "import": "./dist/storage/r2.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "volta": {
+    "node": "22.16.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "effect": "^3.19.13"
+  },
+  "devDependencies": {
+    "@cloudflare/workers-types": "^4.20241218.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@cloudflare/workers-types": "^4.0.0"
+  }
+}