@realtimex/sdk 1.6.0 → 1.7.4

package/dist/index.mjs

@@ -1,3 +1,13 @@
+import {
+  AuthenticationError,
+  DeveloperApiClient,
+  DeveloperApiError,
+  NotFoundError,
+  ServerError,
+  V1ApiNamespace,
+  ValidationError
+} from "./chunk-PDAMNSF2.mjs";
+
 // src/modules/api.ts
 var PermissionDeniedError = class extends Error {
   constructor(permission, message, code = "PERMISSION_DENIED") {
@@ -3641,6 +3651,7 @@ var _RealtimeXSDK = class _RealtimeXSDK {
     this.database = new DatabaseModule(this.realtimexUrl, this.appId, this.apiKey);
     this.auth = new AuthModule(this.realtimexUrl, this.appId, this.apiKey);
     this.credentials = new CredentialsModule(this.httpClient);
+    this.v1 = this.apiKey || this.appId ? new V1ApiNamespace(this.realtimexUrl, this.apiKey ?? "", this.appId || void 0) : void 0;
     if (this.permissions.length > 0 && this.appId && !this.apiKey) {
       this.register().catch((err) => {
         console.error("[RealtimeX SDK] Auto-registration failed:", err.message);
@@ -3750,6 +3761,7 @@ export {
   AgentModule,
   ApiModule,
   AuthModule,
+  AuthenticationError,
   CONTRACT_ATTEMPT_PREFIX,
   CONTRACT_EVENT_ID_HEADER,
   CONTRACT_SIGNATURE_ALGORITHM,
@@ -3764,12 +3776,15 @@ export {
   ContractRuntime,
   ContractValidationError,
   DatabaseModule,
+  DeveloperApiClient,
+  DeveloperApiError,
   GeminiToolAdapter,
   LLMModule,
   LLMPermissionError,
   LLMProviderError,
   LOCAL_APP_CONTRACT_VERSION,
   MCPModule,
+  NotFoundError,
   PermissionDeniedError,
   PermissionRequiredError,
   PortModule,
@@ -3779,12 +3794,15 @@ export {
   STTModule,
   ScopeDeniedError,
   ScopeGuard,
+  ServerError,
   StaticAuthProvider,
   TTSModule,
   TaskModule,
   ToolNotFoundError,
   ToolProjector,
   ToolValidationError,
+  V1ApiNamespace,
+  ValidationError,
   VectorStore,
   WebhookModule,
   buildContractIdempotencyKey,

package/dist/v1/index.d.mts

@@ -0,0 +1,117 @@
+import { D as DeveloperApiClient } from '../errors-DoCX7LOD.mjs';
+export { A as AuthenticationError, a as DeveloperApiError, N as NotFoundError, S as ServerError, d as V1AdminModule, V as V1ApiNamespace, c as V1AuthModule, e as V1DocumentModule, k as V1EmbedModule, j as V1OpenAIModule, g as V1SystemModule, h as V1ThreadModule, i as V1UsersModule, f as V1WorkspaceModule, b as ValidationError } from '../errors-DoCX7LOD.mjs';
+
+interface WorkspaceStreamChunk {
+    /** The text fragment emitted by this SSE event */
+    textResponse: string;
+    /** Unique identifier for this chat session */
+    id: string;
+    /** Human-readable source references used for this response, if any */
+    sources: Array<{
+        id: string;
+        url?: string;
+        title?: string;
+        score?: number;
+    }>;
+    /** Whether this is the final chunk in the stream */
+    close: boolean;
+    /** Error message, present only when the server emits an error event */
+    error: string | null;
+}
+/**
+ * Execute a streamable chat with a workspace and yield typed SSE chunks.
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * for await (const chunk of streamWorkspaceChat(sdk.v1!._client, 'my-workspace', { message: 'Hello' })) {
+ *   process.stdout.write(chunk.textResponse);
+ * }
+ * ```
+ */
+declare function streamWorkspaceChat(client: DeveloperApiClient, slug: string, body?: Record<string, unknown>): AsyncGenerator<WorkspaceStreamChunk, void, unknown>;
+
+interface ThreadStreamChunk {
+    /** The text fragment emitted by this SSE event */
+    textResponse: string;
+    /** Unique identifier for this chat session */
+    id: string;
+    /** Human-readable source references used for this response, if any */
+    sources: Array<{
+        id: string;
+        url?: string;
+        title?: string;
+        score?: number;
+    }>;
+    /** Whether this is the final chunk in the stream */
+    close: boolean;
+    /** Error message, present only when the server emits an error event */
+    error: string | null;
+}
+/**
+ * Execute a streamable chat with a workspace thread and yield typed SSE chunks.
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * for await (const chunk of streamThreadChat(sdk.v1!._client, 'my-workspace', 'my-thread', { message: 'Hello' })) {
+ *   process.stdout.write(chunk.textResponse);
+ * }
+ * ```
+ */
+declare function streamThreadChat(client: DeveloperApiClient, slug: string, threadSlug: string, body?: Record<string, unknown>): AsyncGenerator<ThreadStreamChunk, void, unknown>;
+
+interface UploadedDocument {
+    /** Whether the upload succeeded */
+    success: boolean;
+    /** Parsed document metadata returned by the server */
+    document?: {
+        id: string;
+        name: string;
+        location: string;
+        url: string | null;
+        title: string | null;
+        docAuthor: string | null;
+        description: string | null;
+        docSource: string | null;
+        chunkSource: string | null;
+        published: string | null;
+        wordCount: number;
+        token_count_estimate: number;
+        createdAt: string;
+        pinnedWorkspaces: string[];
+        canWatch: boolean;
+    };
+    /** Server-level error message when success is false */
+    error?: string | null;
+}
+interface UploadFileOptions {
+    /**
+     * Override the filename sent in the multipart form.
+     * Defaults to the `name` property of the `File` / `Blob`.
+     */
+    filename?: string;
+}
+/**
+ * Upload a `File` or `Blob` to the root documents directory.
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * const result = await uploadFile(sdk.v1!._client, myFile);
+ * console.log(result.document?.location);
+ * ```
+ */
+declare function uploadFile(client: DeveloperApiClient, file: File | Blob, options?: UploadFileOptions): Promise<UploadedDocument>;
+/**
+ * Upload a `File` or `Blob` to a specific folder (created automatically if absent).
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * const result = await uploadFileToFolder(sdk.v1!._client, myFile, 'contracts');
+ * ```
+ */
+declare function uploadFileToFolder(client: DeveloperApiClient, file: File | Blob, folderName: string, options?: UploadFileOptions): Promise<UploadedDocument>;
+
+export { DeveloperApiClient, type ThreadStreamChunk, type UploadFileOptions, type UploadedDocument, type WorkspaceStreamChunk, streamThreadChat, streamWorkspaceChat, uploadFile, uploadFileToFolder };

package/dist/v1/index.d.ts

@@ -0,0 +1,117 @@
+import { D as DeveloperApiClient } from '../errors-DoCX7LOD.js';
+export { A as AuthenticationError, a as DeveloperApiError, N as NotFoundError, S as ServerError, d as V1AdminModule, V as V1ApiNamespace, c as V1AuthModule, e as V1DocumentModule, k as V1EmbedModule, j as V1OpenAIModule, g as V1SystemModule, h as V1ThreadModule, i as V1UsersModule, f as V1WorkspaceModule, b as ValidationError } from '../errors-DoCX7LOD.js';
+
+interface WorkspaceStreamChunk {
+    /** The text fragment emitted by this SSE event */
+    textResponse: string;
+    /** Unique identifier for this chat session */
+    id: string;
+    /** Human-readable source references used for this response, if any */
+    sources: Array<{
+        id: string;
+        url?: string;
+        title?: string;
+        score?: number;
+    }>;
+    /** Whether this is the final chunk in the stream */
+    close: boolean;
+    /** Error message, present only when the server emits an error event */
+    error: string | null;
+}
+/**
+ * Execute a streamable chat with a workspace and yield typed SSE chunks.
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * for await (const chunk of streamWorkspaceChat(sdk.v1!._client, 'my-workspace', { message: 'Hello' })) {
+ *   process.stdout.write(chunk.textResponse);
+ * }
+ * ```
+ */
+declare function streamWorkspaceChat(client: DeveloperApiClient, slug: string, body?: Record<string, unknown>): AsyncGenerator<WorkspaceStreamChunk, void, unknown>;
+
+interface ThreadStreamChunk {
+    /** The text fragment emitted by this SSE event */
+    textResponse: string;
+    /** Unique identifier for this chat session */
+    id: string;
+    /** Human-readable source references used for this response, if any */
+    sources: Array<{
+        id: string;
+        url?: string;
+        title?: string;
+        score?: number;
+    }>;
+    /** Whether this is the final chunk in the stream */
+    close: boolean;
+    /** Error message, present only when the server emits an error event */
+    error: string | null;
+}
+/**
+ * Execute a streamable chat with a workspace thread and yield typed SSE chunks.
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * for await (const chunk of streamThreadChat(sdk.v1!._client, 'my-workspace', 'my-thread', { message: 'Hello' })) {
+ *   process.stdout.write(chunk.textResponse);
+ * }
+ * ```
+ */
+declare function streamThreadChat(client: DeveloperApiClient, slug: string, threadSlug: string, body?: Record<string, unknown>): AsyncGenerator<ThreadStreamChunk, void, unknown>;
+
+interface UploadedDocument {
+    /** Whether the upload succeeded */
+    success: boolean;
+    /** Parsed document metadata returned by the server */
+    document?: {
+        id: string;
+        name: string;
+        location: string;
+        url: string | null;
+        title: string | null;
+        docAuthor: string | null;
+        description: string | null;
+        docSource: string | null;
+        chunkSource: string | null;
+        published: string | null;
+        wordCount: number;
+        token_count_estimate: number;
+        createdAt: string;
+        pinnedWorkspaces: string[];
+        canWatch: boolean;
+    };
+    /** Server-level error message when success is false */
+    error?: string | null;
+}
+interface UploadFileOptions {
+    /**
+     * Override the filename sent in the multipart form.
+     * Defaults to the `name` property of the `File` / `Blob`.
+     */
+    filename?: string;
+}
+/**
+ * Upload a `File` or `Blob` to the root documents directory.
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * const result = await uploadFile(sdk.v1!._client, myFile);
+ * console.log(result.document?.location);
+ * ```
+ */
+declare function uploadFile(client: DeveloperApiClient, file: File | Blob, options?: UploadFileOptions): Promise<UploadedDocument>;
+/**
+ * Upload a `File` or `Blob` to a specific folder (created automatically if absent).
+ *
+ * @example
+ * ```ts
+ * const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ * const result = await uploadFileToFolder(sdk.v1!._client, myFile, 'contracts');
+ * ```
+ */
+declare function uploadFileToFolder(client: DeveloperApiClient, file: File | Blob, folderName: string, options?: UploadFileOptions): Promise<UploadedDocument>;
+
+export { DeveloperApiClient, type ThreadStreamChunk, type UploadFileOptions, type UploadedDocument, type WorkspaceStreamChunk, streamThreadChat, streamWorkspaceChat, uploadFile, uploadFileToFolder };