@relayfile/sdk 0.1.0

package/README.md

@@ -0,0 +1,40 @@
+# @relayfile/sdk
+
+TypeScript SDK for relayfile — real-time filesystem for humans and agents.
+
+## Install
+
+```bash
+npm install @relayfile/sdk
+```
+
+## Quick Example
+
+```ts
+import { RelayFileClient } from "@relayfile/sdk";
+
+const client = new RelayFileClient({
+  baseUrl: "https://api.relayfile.com",
+  token: process.env.RELAYFILE_TOKEN ?? ""
+});
+
+const workspaceId = "workspace_123";
+
+const tree = await client.listTree(workspaceId, { path: "/", depth: 2 });
+console.log(tree.entries.map((entry) => entry.path));
+
+const file = await client.readFile(workspaceId, "/notes/todo.md");
+console.log(file.content);
+
+await client.writeFile({
+  workspaceId,
+  path: "/notes/todo.md",
+  baseRevision: file.revision,
+  content: `${file.content}\n- Follow up with SDK publish`,
+  contentType: "text/markdown"
+});
+```
+
+## Full Docs
+
+Full documentation is available at https://github.com/AgentWorkforce/relayfile

package/dist/client.d.ts

@@ -0,0 +1,73 @@
+import { type AdminIngressStatusResponse, type AdminSyncStatusResponse, type BulkWriteInput, type BulkWriteResponse, type BackendStatusResponse, type AckResponse, type DeleteFileInput, type DeadLetterItem, type DeadLetterFeedResponse, 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 QueryFilesOptions, type SyncIngressStatusResponse, type SyncStatusResponse, type TreeResponse, type WriteFileInput, type WriteQueuedResponse } from "./types.js";
+export type AccessTokenProvider = string | (() => string | Promise<string>);
+export interface RelayFileRetryOptions {
+    maxRetries?: number;
+    baseDelayMs?: number;
+    maxDelayMs?: number;
+    jitterRatio?: number;
+}
+export interface RelayFileClientOptions {
+    baseUrl: string;
+    token: AccessTokenProvider;
+    fetchImpl?: typeof fetch;
+    userAgent?: string;
+    retry?: RelayFileRetryOptions;
+}
+type WebSocketEventName = "event" | "error" | "open" | "close";
+type WebSocketHandlerMap = {
+    event: (event: FilesystemEvent) => void;
+    error: (event: Event | Error) => void;
+    open: (event: Event) => void;
+    close: (event: CloseEvent) => void;
+};
+export interface WebSocketConnection {
+    close(code?: number, reason?: string): void;
+    on<TEventName extends WebSocketEventName>(event: TEventName, handler: WebSocketHandlerMap[TEventName]): () => void;
+}
+export interface ConnectWebSocketOptions {
+    token?: string;
+    onEvent?: (event: FilesystemEvent) => void;
+}
+export declare class RelayFileClient {
+    private readonly baseUrl;
+    private readonly tokenProvider;
+    private readonly fetchImpl;
+    private readonly userAgent?;
+    private readonly retryOptions;
+    constructor(options: RelayFileClientOptions);
+    listTree(workspaceId: string, options?: ListTreeOptions): Promise<TreeResponse>;
+    readFile(workspaceId: string, path: string, correlationId?: string, signal?: AbortSignal): Promise<FileReadResponse>;
+    queryFiles(workspaceId: string, options?: QueryFilesOptions): Promise<FileQueryResponse>;
+    writeFile(input: WriteFileInput): Promise<WriteQueuedResponse>;
+    bulkWrite(input: BulkWriteInput): Promise<BulkWriteResponse>;
+    deleteFile(input: DeleteFileInput): Promise<WriteQueuedResponse>;
+    getEvents(workspaceId: string, options?: GetEventsOptions): Promise<EventFeedResponse>;
+    exportWorkspace(options: ExportOptions): Promise<ExportJsonResponse | Blob>;
+    connectWebSocket(workspaceId: string, options?: ConnectWebSocketOptions): WebSocketConnection;
+    getOp(workspaceId: string, opId: string, correlationId?: string, signal?: AbortSignal): Promise<OperationStatusResponse>;
+    listOps(workspaceId: string, options?: GetOperationsOptions): Promise<OperationFeedResponse>;
+    replayOp(workspaceId: string, opId: string, correlationId?: string, signal?: AbortSignal): Promise<QueuedResponse>;
+    replayAdminEnvelope(envelopeId: string, correlationId?: string, signal?: AbortSignal): Promise<QueuedResponse>;
+    replayAdminOp(opId: string, correlationId?: string, signal?: AbortSignal): Promise<QueuedResponse>;
+    getBackendStatus(correlationId?: string, signal?: AbortSignal): Promise<BackendStatusResponse>;
+    getAdminIngressStatus(optionsOrCorrelationId?: GetAdminIngressStatusOptions | string, signal?: AbortSignal): Promise<AdminIngressStatusResponse>;
+    getAdminSyncStatus(optionsOrCorrelationId?: GetAdminSyncStatusOptions | string, signal?: AbortSignal): Promise<AdminSyncStatusResponse>;
+    getSyncStatus(workspaceId: string, options?: GetSyncStatusOptions): Promise<SyncStatusResponse>;
+    getSyncIngressStatus(workspaceId: string, options?: GetSyncIngressStatusOptions): Promise<SyncIngressStatusResponse>;
+    getSyncDeadLetters(workspaceId: string, options?: GetSyncDeadLettersOptions): Promise<DeadLetterFeedResponse>;
+    getSyncDeadLetter(workspaceId: string, envelopeId: string, correlationId?: string, signal?: AbortSignal): Promise<DeadLetterItem>;
+    replaySyncDeadLetter(workspaceId: string, envelopeId: string, correlationId?: string, signal?: AbortSignal): Promise<QueuedResponse>;
+    ackSyncDeadLetter(workspaceId: string, envelopeId: string, correlationId?: string, signal?: AbortSignal): Promise<AckResponse>;
+    triggerSyncRefresh(workspaceId: string, provider: string, reason?: string, correlationId?: string, signal?: AbortSignal): Promise<QueuedResponse>;
+    private request;
+    private performRequest;
+    private shouldRetryStatus;
+    private shouldRetryError;
+    private computeRetryDelayMs;
+    private parseRetryAfterMs;
+    private sleep;
+    private readPayload;
+    private throwForError;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAE3B,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACzB,MAAM,YAAY,CAAC;AASpB,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,qBAAqB,CAAC;CAC/B;AASD,KAAK,kBAAkB,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;AAC/D,KAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACxC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,KAAK,IAAI,CAAC;IACtC,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC7B,KAAK,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;CACpC,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,EAAE,CAAC,UAAU,SAAS,kBAAkB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC;CACpH;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;CAC5C;AAwID,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;IACpD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyB;gBAE1C,OAAO,EAAE,sBAAsB;IAQrC,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAcnF,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAUpH,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA0B5F,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAmB9D,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAY5D,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAahE,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAc1F,eAAe,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAmBjF,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,uBAA4B,GACpC,mBAAmB;IAUhB,KAAK,CACT,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,uBAAuB,CAAC;IAS7B,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAgBhG,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;IASlH,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;IAS9G,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;IASlG,gBAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAS9F,qBAAqB,CACzB,sBAAsB,GAAE,4BAA4B,GAAG,MAAW,EAClE,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,0BAA0B,CAAC;IA4BhC,kBAAkB,CACtB,sBAAsB,GAAE,yBAAyB,GAAG,MAAW,EAC/D,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,uBAAuB,CAAC;IA2B7B,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAUnG,oBAAoB,CACxB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,yBAAyB,CAAC;IAY/B,kBAAkB,CACtB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,sBAAsB,CAAC;IAc5B,iBAAiB,CACrB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC;IASpB,oBAAoB,CACxB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC;IASpB,iBAAiB,CACrB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,WAAW,CAAC;IASjB,kBAAkB,CACtB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,EACf,aAAa,CAAC,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC;YAaZ,OAAO;YAYP,cAAc;IAoE5B,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,iBAAiB;YAeX,KAAK;YAqBL,WAAW;IAezB,OAAO,CAAC,aAAa;CAqEtB"}