@relayfile/sdk 0.7.9 → 0.7.11

package/README.md

@@ -81,7 +81,11 @@ import { RelayFileClient } from "@relayfile/sdk";
 
 const client = new RelayFileClient({
   baseUrl: "https://api.relayfile.com",
-  token: process.env.RELAYFILE_TOKEN ?? ""
+  token: process.env.RELAYFILE_TOKEN ?? "",
+  changeLog: {
+    retentionMs: 7 * 24 * 60 * 60 * 1000,
+    maxEntries: 10_000
+  }
 });
 
 const workspaceId = "workspace_123";
@@ -108,6 +112,8 @@ await client.writeFile({
 
 Use a relayfile JWT whose claims include `workspace_id`, `agent_name`, and `aud: ["relayfile"]`. The SDK adds `X-Correlation-Id` automatically for API calls.
 
+The optional `changeLog` block configures the SDK's local per-workspace retained-change mirror used by `subscribe()`, `open({ replayOnStart })`, and `getResourceAtEvent(eventId)`. Durable retention still lives on the Relayfile backend.
+
 ## Full Docs
 
 Full documentation is available in the [relayfile docs](https://github.com/AgentWorkforce/relayfile/tree/main/docs).

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { type AdminIngressStatusResponse, type AdminSyncStatusResponse, type BulkWriteInput, type BulkWriteResponse, type BackendStatusResponse, type AckResponse, type CommitForkInput, type CommitForkResponse, type CreateForkInput, type DeleteFileInput, type DeadLetterItem, type DeadLetterFeedResponse, type DiscardForkInput, type EventFeedResponse, type ExportJsonResponse, type ExportOptions, type FileQueryResponse, type FileReadResponse, type FilesystemEvent, type GetEventsOptions, type GetAdminIngressStatusOptions, type GetAdminSyncStatusOptions, type GetOperationsOptions, type GetSyncDeadLettersOptions, type GetSyncIngressStatusOptions, type GetSyncStatusOptions, type ListTreeOptions, type OperationFeedResponse, type OperationStatusResponse, type QueuedResponse, type ReadFileInput, type QueryFilesOptions, type SyncIngressStatusResponse, type SyncStatusResponse, type TreeResponse, type WriteFileInput, type WriteQueuedResponse, type IngestWebhookInput, type WritebackItem, type AckWritebackInput, type AckWritebackResponse } from "./types.js";
+import { type AdminIngressStatusResponse, type AdminSyncStatusResponse, type BulkWriteInput, type BulkWriteResponse, type BackendStatusResponse, type AckResponse, type CommitForkInput, type CommitForkResponse, type CreateForkInput, type DeleteFileInput, type DeadLetterItem, type DeadLetterFeedResponse, type DiscardForkInput, type EventFeedResponse, type ExportJsonResponse, type ExportOptions, type FileQueryResponse, type FileReadResponse, type FilesystemEvent, type GetEventsOptions, type GetAdminIngressStatusOptions, type GetAdminSyncStatusOptions, type GetOperationsOptions, type GetSyncDeadLettersOptions, type GetSyncIngressStatusOptions, type GetSyncStatusOptions, type ListTreeOptions, type OperationFeedResponse, type OperationStatusResponse, type QueuedResponse, type ResourceAtEventResult, type ReadFileInput, type QueryFilesOptions, type Subscription, type SyncIngressStatusResponse, type SyncStatusResponse, type TreeResponse, type WriteFileInput, type WriteQueuedResponse, type IngestWebhookInput, type WritebackItem, type AckWritebackInput, type AckWritebackResponse, type ChangeEvent, type ChangeLogQueryResult, type ChangeStreamConnection, type ChangeStreamConnectionOptions, type SubscribeOptions } from "./types.js";
 import type { ForkHandle } from "@relayfile/core";
 /**
  * Bearer token or token factory used for Relayfile API requests.
@@ -13,6 +13,18 @@ export interface RelayFileRetryOptions {
     maxDelayMs?: number;
     jitterRatio?: number;
 }
+export interface RelayFileChangeLogOptions {
+    /**
+     * Local retained-change cache TTL in milliseconds.
+     *
+     * This mirrors the backend retention window opportunistically for delivered
+     * or replayed events; durable change-log retention remains a server-side
+     * responsibility.
+     */
+    retentionMs?: number;
+    /** Maximum number of retained change entries to keep per workspace locally. */
+    maxEntries?: number;
+}
 /** Default base URL for the hosted Relayfile API */
 export declare const DEFAULT_RELAYFILE_BASE_URL = "https://api.relayfile.dev";
 export interface RelayFileClientOptions {
@@ -28,6 +40,7 @@ export interface RelayFileClientOptions {
     fetchImpl?: typeof fetch;
     userAgent?: string;
     retry?: RelayFileRetryOptions;
+    changeLog?: RelayFileChangeLogOptions;
 }
 type WebSocketEventName = "event" | "error" | "open" | "close";
 type WebSocketHandlerMap = {
@@ -44,6 +57,10 @@ export interface ConnectWebSocketOptions {
     token?: string;
     onEvent?: (event: FilesystemEvent) => void;
 }
+interface ProactiveRequestContext {
+    workspaceId: string;
+    token?: string;
+}
 export declare class RelayFileClient {
     private readonly baseUrl;
     private readonly tokenProvider;
@@ -82,6 +99,11 @@ export declare class RelayFileClient {
     discardFork(input: DiscardForkInput): Promise<void>;
     commitFork(input: CommitForkInput): Promise<CommitForkResponse>;
     getEvents(workspaceId: string, options?: GetEventsOptions): Promise<EventFeedResponse>;
+    subscribe(globs: string[], onChange: (event: ChangeEvent) => void, options?: SubscribeOptions): Subscription;
+    open(options: ChangeStreamConnectionOptions): ChangeStreamConnection;
+    getResourceAtEvent(eventId: string, context?: ProactiveRequestContext): Promise<ResourceAtEventResult>;
+    listChangesSince(isoTimestamp: string, context?: ProactiveRequestContext): Promise<ChangeLogQueryResult>;
+    listLastNChanges(limit: number, context?: ProactiveRequestContext): Promise<ChangeLogQueryResult>;
     exportWorkspace(options: ExportOptions): Promise<ExportJsonResponse | Blob>;
     connectWebSocket(workspaceId: string, options?: ConnectWebSocketOptions): WebSocketConnection;
     getOp(workspaceId: string, opId: string, correlationId?: string, signal?: AbortSignal): Promise<OperationStatusResponse>;
@@ -102,6 +124,9 @@ export declare class RelayFileClient {
     ingestWebhook(input: IngestWebhookInput): Promise<QueuedResponse>;
     listPendingWritebacks(workspaceId: string, correlationId?: string, signal?: AbortSignal): Promise<WritebackItem[]>;
     ackWriteback(input: AckWritebackInput): Promise<AckWritebackResponse>;
+    private cacheWireChangeEvent;
+    private primeReplayCache;
+    private resolveWorkspaceId;
     private request;
     private performRequest;
     private shouldRetryStatus;