@robosystems/client 0.2.37 → 0.2.39

package/sdk-extensions/DocumentClient.d.ts

@@ -0,0 +1,77 @@
+import type { BulkDocumentUploadResponse, DocumentListResponse, DocumentSection, DocumentUploadResponse, SearchResponse } from '../sdk/types.gen';
+export interface DocumentSearchOptions {
+    /** Filter by source type (xbrl_textblock, narrative_section, ixbrl_disclosure, uploaded_doc, memory) */
+    sourceType?: string;
+    /** Filter by ticker, CIK, or entity name */
+    entity?: string;
+    /** Filter by SEC form type (10-K, 10-Q) */
+    formType?: string;
+    /** Filter by section ID (item_1, item_1a, item_7, etc.) */
+    section?: string;
+    /** Filter by XBRL element qname (e.g., us-gaap:Goodwill) */
+    element?: string;
+    /** Filter by fiscal year */
+    fiscalYear?: number;
+    /** Filter filings on or after date (YYYY-MM-DD) */
+    dateFrom?: string;
+    /** Filter filings on or before date (YYYY-MM-DD) */
+    dateTo?: string;
+    /** Max results to return (default: 10) */
+    size?: number;
+    /** Pagination offset */
+    offset?: number;
+}
+export interface DocumentUploadOptions {
+    /** Optional tags for filtering */
+    tags?: string[];
+    /** Optional folder/category */
+    folder?: string;
+    /** Optional external ID for upsert behavior */
+    externalId?: string;
+}
+export declare class DocumentClient {
+    private config;
+    constructor(config: {
+        baseUrl: string;
+        credentials?: 'include' | 'same-origin' | 'omit';
+        headers?: Record<string, string>;
+        token?: string;
+    });
+    /**
+     * Upload a markdown document for text indexing.
+     *
+     * The document is sectioned on headings, embedded, and indexed
+     * into OpenSearch for full-text and semantic search.
+     */
+    upload(graphId: string, title: string, content: string, options?: DocumentUploadOptions): Promise<DocumentUploadResponse>;
+    /**
+     * Upload multiple markdown documents (max 50 per request).
+     */
+    uploadBulk(graphId: string, documents: Array<{
+        title: string;
+        content: string;
+        tags?: string[];
+        folder?: string;
+        externalId?: string;
+    }>): Promise<BulkDocumentUploadResponse>;
+    /**
+     * Search documents with hybrid (BM25 + kNN) search.
+     */
+    search(graphId: string, query: string, options?: DocumentSearchOptions): Promise<SearchResponse>;
+    /**
+     * Retrieve the full text of a document section by ID.
+     *
+     * @returns DocumentSection or null if not found.
+     */
+    getSection(graphId: string, documentId: string): Promise<DocumentSection | null>;
+    /**
+     * List indexed documents for a graph.
+     */
+    list(graphId: string, sourceType?: string): Promise<DocumentListResponse>;
+    /**
+     * Delete a document and all its sections.
+     *
+     * @returns true if deleted, false if not found.
+     */
+    delete(graphId: string, documentId: string): Promise<boolean>;
+}

package/sdk-extensions/DocumentClient.js

@@ -0,0 +1,136 @@
+'use client';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentClient = void 0;
+/**
+ * Document Client for RoboSystems API
+ *
+ * Upload, search, list, and delete text documents indexed in OpenSearch.
+ * Documents are sectioned on markdown headings, embedded for semantic search,
+ * and searchable alongside structured graph data.
+ */
+const sdk_gen_1 = require("../sdk/sdk.gen");
+class DocumentClient {
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Upload a markdown document for text indexing.
+     *
+     * The document is sectioned on headings, embedded, and indexed
+     * into OpenSearch for full-text and semantic search.
+     */
+    async upload(graphId, title, content, options = {}) {
+        const response = await (0, sdk_gen_1.uploadDocument)({
+            path: { graph_id: graphId },
+            body: {
+                title,
+                content,
+                tags: options.tags ?? null,
+                folder: options.folder ?? null,
+                external_id: options.externalId ?? null,
+            },
+        });
+        if (response.error) {
+            throw new Error(`Document upload failed: ${JSON.stringify(response.error)}`);
+        }
+        return response.data;
+    }
+    /**
+     * Upload multiple markdown documents (max 50 per request).
+     */
+    async uploadBulk(graphId, documents) {
+        const response = await (0, sdk_gen_1.uploadDocumentsBulk)({
+            path: { graph_id: graphId },
+            body: {
+                documents: documents.map((doc) => ({
+                    title: doc.title,
+                    content: doc.content,
+                    tags: doc.tags ?? null,
+                    folder: doc.folder ?? null,
+                    external_id: doc.externalId ?? null,
+                })),
+            },
+        });
+        if (response.error) {
+            throw new Error(`Bulk upload failed: ${JSON.stringify(response.error)}`);
+        }
+        return response.data;
+    }
+    /**
+     * Search documents with hybrid (BM25 + kNN) search.
+     */
+    async search(graphId, query, options = {}) {
+        const response = await (0, sdk_gen_1.searchDocuments)({
+            path: { graph_id: graphId },
+            body: {
+                query,
+                source_type: options.sourceType ?? null,
+                entity: options.entity ?? null,
+                form_type: options.formType ?? null,
+                section: options.section ?? null,
+                element: options.element ?? null,
+                fiscal_year: options.fiscalYear ?? null,
+                date_from: options.dateFrom ?? null,
+                date_to: options.dateTo ?? null,
+                size: options.size,
+                offset: options.offset,
+            },
+        });
+        if (response.error) {
+            throw new Error(`Document search failed: ${JSON.stringify(response.error)}`);
+        }
+        return response.data;
+    }
+    /**
+     * Retrieve the full text of a document section by ID.
+     *
+     * @returns DocumentSection or null if not found.
+     */
+    async getSection(graphId, documentId) {
+        const response = await (0, sdk_gen_1.getDocumentSection)({
+            path: { graph_id: graphId, document_id: documentId },
+        });
+        if (response.response.status === 404) {
+            return null;
+        }
+        if (response.error) {
+            throw new Error(`Get section failed: ${JSON.stringify(response.error)}`);
+        }
+        return response.data;
+    }
+    /**
+     * List indexed documents for a graph.
+     */
+    async list(graphId, sourceType) {
+        const response = await (0, sdk_gen_1.listDocuments)({
+            path: { graph_id: graphId },
+            query: sourceType ? { source_type: sourceType } : undefined,
+        });
+        if (response.error) {
+            throw new Error(`List documents failed: ${JSON.stringify(response.error)}`);
+        }
+        return response.data;
+    }
+    /**
+     * Delete a document and all its sections.
+     *
+     * @returns true if deleted, false if not found.
+     */
+    async delete(graphId, documentId) {
+        const response = await (0, sdk_gen_1.deleteDocument)({
+            path: { graph_id: graphId, document_id: documentId },
+        });
+        if (response.response.status === 204) {
+            return true;
+        }
+        if (response.response.status === 404) {
+            return false;
+        }
+        if (response.error) {
+            throw new Error(`Delete document failed: ${JSON.stringify(response.error)}`);
+        }
+        return true;
+    }
+}
+exports.DocumentClient = DocumentClient;

package/sdk-extensions/DocumentClient.ts

@@ -0,0 +1,232 @@
+'use client'
+
+/**
+ * Document Client for RoboSystems API
+ *
+ * Upload, search, list, and delete text documents indexed in OpenSearch.
+ * Documents are sectioned on markdown headings, embedded for semantic search,
+ * and searchable alongside structured graph data.
+ */
+
+import {
+  deleteDocument,
+  getDocumentSection,
+  listDocuments,
+  searchDocuments,
+  uploadDocument,
+  uploadDocumentsBulk,
+} from '../sdk/sdk.gen'
+import type {
+  BulkDocumentUploadResponse,
+  DocumentListResponse,
+  DocumentSection,
+  DocumentUploadResponse,
+  SearchResponse,
+} from '../sdk/types.gen'
+
+export interface DocumentSearchOptions {
+  /** Filter by source type (xbrl_textblock, narrative_section, ixbrl_disclosure, uploaded_doc, memory) */
+  sourceType?: string
+  /** Filter by ticker, CIK, or entity name */
+  entity?: string
+  /** Filter by SEC form type (10-K, 10-Q) */
+  formType?: string
+  /** Filter by section ID (item_1, item_1a, item_7, etc.) */
+  section?: string
+  /** Filter by XBRL element qname (e.g., us-gaap:Goodwill) */
+  element?: string
+  /** Filter by fiscal year */
+  fiscalYear?: number
+  /** Filter filings on or after date (YYYY-MM-DD) */
+  dateFrom?: string
+  /** Filter filings on or before date (YYYY-MM-DD) */
+  dateTo?: string
+  /** Max results to return (default: 10) */
+  size?: number
+  /** Pagination offset */
+  offset?: number
+}
+
+export interface DocumentUploadOptions {
+  /** Optional tags for filtering */
+  tags?: string[]
+  /** Optional folder/category */
+  folder?: string
+  /** Optional external ID for upsert behavior */
+  externalId?: string
+}
+
+export class DocumentClient {
+  private config: {
+    baseUrl: string
+    credentials?: 'include' | 'same-origin' | 'omit'
+    headers?: Record<string, string>
+    token?: string
+  }
+
+  constructor(config: {
+    baseUrl: string
+    credentials?: 'include' | 'same-origin' | 'omit'
+    headers?: Record<string, string>
+    token?: string
+  }) {
+    this.config = config
+  }
+
+  /**
+   * Upload a markdown document for text indexing.
+   *
+   * The document is sectioned on headings, embedded, and indexed
+   * into OpenSearch for full-text and semantic search.
+   */
+  async upload(
+    graphId: string,
+    title: string,
+    content: string,
+    options: DocumentUploadOptions = {}
+  ): Promise<DocumentUploadResponse> {
+    const response = await uploadDocument({
+      path: { graph_id: graphId },
+      body: {
+        title,
+        content,
+        tags: options.tags ?? null,
+        folder: options.folder ?? null,
+        external_id: options.externalId ?? null,
+      },
+    })
+
+    if (response.error) {
+      throw new Error(`Document upload failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return response.data as DocumentUploadResponse
+  }
+
+  /**
+   * Upload multiple markdown documents (max 50 per request).
+   */
+  async uploadBulk(
+    graphId: string,
+    documents: Array<{
+      title: string
+      content: string
+      tags?: string[]
+      folder?: string
+      externalId?: string
+    }>
+  ): Promise<BulkDocumentUploadResponse> {
+    const response = await uploadDocumentsBulk({
+      path: { graph_id: graphId },
+      body: {
+        documents: documents.map((doc) => ({
+          title: doc.title,
+          content: doc.content,
+          tags: doc.tags ?? null,
+          folder: doc.folder ?? null,
+          external_id: doc.externalId ?? null,
+        })),
+      },
+    })
+
+    if (response.error) {
+      throw new Error(`Bulk upload failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return response.data as BulkDocumentUploadResponse
+  }
+
+  /**
+   * Search documents with hybrid (BM25 + kNN) search.
+   */
+  async search(
+    graphId: string,
+    query: string,
+    options: DocumentSearchOptions = {}
+  ): Promise<SearchResponse> {
+    const response = await searchDocuments({
+      path: { graph_id: graphId },
+      body: {
+        query,
+        source_type: options.sourceType ?? null,
+        entity: options.entity ?? null,
+        form_type: options.formType ?? null,
+        section: options.section ?? null,
+        element: options.element ?? null,
+        fiscal_year: options.fiscalYear ?? null,
+        date_from: options.dateFrom ?? null,
+        date_to: options.dateTo ?? null,
+        size: options.size,
+        offset: options.offset,
+      },
+    })
+
+    if (response.error) {
+      throw new Error(`Document search failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return response.data as SearchResponse
+  }
+
+  /**
+   * Retrieve the full text of a document section by ID.
+   *
+   * @returns DocumentSection or null if not found.
+   */
+  async getSection(graphId: string, documentId: string): Promise<DocumentSection | null> {
+    const response = await getDocumentSection({
+      path: { graph_id: graphId, document_id: documentId },
+    })
+
+    if (response.response.status === 404) {
+      return null
+    }
+
+    if (response.error) {
+      throw new Error(`Get section failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return response.data as DocumentSection
+  }
+
+  /**
+   * List indexed documents for a graph.
+   */
+  async list(graphId: string, sourceType?: string): Promise<DocumentListResponse> {
+    const response = await listDocuments({
+      path: { graph_id: graphId },
+      query: sourceType ? { source_type: sourceType } : undefined,
+    })
+
+    if (response.error) {
+      throw new Error(`List documents failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return response.data as DocumentListResponse
+  }
+
+  /**
+   * Delete a document and all its sections.
+   *
+   * @returns true if deleted, false if not found.
+   */
+  async delete(graphId: string, documentId: string): Promise<boolean> {
+    const response = await deleteDocument({
+      path: { graph_id: graphId, document_id: documentId },
+    })
+
+    if (response.response.status === 204) {
+      return true
+    }
+
+    if (response.response.status === 404) {
+      return false
+    }
+
+    if (response.error) {
+      throw new Error(`Delete document failed: ${JSON.stringify(response.error)}`)
+    }
+
+    return true
+  }
+}

package/sdk-extensions/index.d.ts

@@ -10,6 +10,7 @@ import { FileClient } from './FileClient';
 import { MaterializationClient } from './MaterializationClient';
 import { TableClient } from './TableClient';
 import { GraphClient } from './GraphClient';
+import { DocumentClient } from './DocumentClient';
 export interface RoboSystemsExtensionConfig {
     baseUrl?: string;
     credentials?: 'include' | 'same-origin' | 'omit';
@@ -27,6 +28,7 @@ export declare class RoboSystemsExtensions {
     readonly materialization: MaterializationClient;
     readonly tables: TableClient;
     readonly graphs: GraphClient;
+    readonly documents: DocumentClient;
     private config;
     constructor(config?: RoboSystemsExtensionConfig);
     /**
@@ -49,10 +51,11 @@ export * from './SSEClient';
 export * from './FileClient';
 export * from './MaterializationClient';
 export * from './GraphClient';
+export * from './DocumentClient';
 export * from './config';
 export type { TableInfo, TableQueryResult } from './TableClient';
 export { TableClient } from './TableClient';
-export { OperationClient, QueryClient, AgentClient, SSEClient, FileClient, MaterializationClient, GraphClient, };
+export { OperationClient, QueryClient, AgentClient, SSEClient, FileClient, MaterializationClient, GraphClient, DocumentClient, };
 export { useMultipleOperations, useOperation, useQuery, useSDKClients, useStreamingQuery, useTableUpload, } from './hooks';
 export declare const extensions: {
     readonly query: QueryClient;
@@ -62,6 +65,7 @@ export declare const extensions: {
     readonly materialization: MaterializationClient;
     readonly tables: TableClient;
     readonly graphs: GraphClient;
+    readonly documents: DocumentClient;
     monitorOperation: (operationId: string, onProgress?: (progress: any) => void) => Promise<any>;
     createSSEClient: () => SSEClient;
     close: () => void;

package/sdk-extensions/index.js

@@ -18,7 +18,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.analyzeFinancials = exports.agentQuery = exports.streamQuery = exports.executeQuery = exports.monitorOperation = exports.extensions = exports.useTableUpload = exports.useStreamingQuery = exports.useSDKClients = exports.useQuery = exports.useOperation = exports.useMultipleOperations = exports.GraphClient = exports.MaterializationClient = exports.FileClient = exports.SSEClient = exports.AgentClient = exports.QueryClient = exports.OperationClient = exports.TableClient = exports.RoboSystemsExtensions = void 0;
+exports.analyzeFinancials = exports.agentQuery = exports.streamQuery = exports.executeQuery = exports.monitorOperation = exports.extensions = exports.useTableUpload = exports.useStreamingQuery = exports.useSDKClients = exports.useQuery = exports.useOperation = exports.useMultipleOperations = exports.DocumentClient = exports.GraphClient = exports.MaterializationClient = exports.FileClient = exports.SSEClient = exports.AgentClient = exports.QueryClient = exports.OperationClient = exports.TableClient = exports.RoboSystemsExtensions = void 0;
 const client_gen_1 = require("../sdk/client.gen");
 const config_1 = require("./config");
 const OperationClient_1 = require("./OperationClient");
@@ -36,6 +36,8 @@ Object.defineProperty(exports, "MaterializationClient", { enumerable: true, get:
 const TableClient_1 = require("./TableClient");
 const GraphClient_1 = require("./GraphClient");
 Object.defineProperty(exports, "GraphClient", { enumerable: true, get: function () { return GraphClient_1.GraphClient; } });
+const DocumentClient_1 = require("./DocumentClient");
+Object.defineProperty(exports, "DocumentClient", { enumerable: true, get: function () { return DocumentClient_1.DocumentClient; } });
 class RoboSystemsExtensions {
     constructor(config = {}) {
         // Get base URL from SDK client config or use provided/default
@@ -95,6 +97,12 @@ class RoboSystemsExtensions {
             token: this.config.token,
             headers: this.config.headers,
         });
+        this.documents = new DocumentClient_1.DocumentClient({
+            baseUrl: this.config.baseUrl,
+            credentials: this.config.credentials,
+            token: this.config.token,
+            headers: this.config.headers,
+        });
     }
     /**
      * Convenience method to monitor any operation
@@ -134,6 +142,7 @@ __exportStar(require("./SSEClient"), exports);
 __exportStar(require("./FileClient"), exports);
 __exportStar(require("./MaterializationClient"), exports);
 __exportStar(require("./GraphClient"), exports);
+__exportStar(require("./DocumentClient"), exports);
 __exportStar(require("./config"), exports);
 var TableClient_2 = require("./TableClient");
 Object.defineProperty(exports, "TableClient", { enumerable: true, get: function () { return TableClient_2.TableClient; } });
@@ -175,6 +184,9 @@ exports.extensions = {
     get graphs() {
         return getExtensions().graphs;
     },
+    get documents() {
+        return getExtensions().documents;
+    },
     monitorOperation: (operationId, onProgress) => getExtensions().monitorOperation(operationId, onProgress),
     createSSEClient: () => getExtensions().createSSEClient(),
     close: () => getExtensions().close(),

package/sdk-extensions/index.ts

@@ -13,6 +13,7 @@ import { FileClient } from './FileClient'
 import { MaterializationClient } from './MaterializationClient'
 import { TableClient } from './TableClient'
 import { GraphClient } from './GraphClient'
+import { DocumentClient } from './DocumentClient'
 
 export interface RoboSystemsExtensionConfig {
   baseUrl?: string
@@ -43,6 +44,7 @@ export class RoboSystemsExtensions {
   public readonly materialization: MaterializationClient
   public readonly tables: TableClient
   public readonly graphs: GraphClient
+  public readonly documents: DocumentClient
   private config: ResolvedConfig
 
   constructor(config: RoboSystemsExtensionConfig = {}) {
@@ -112,6 +114,13 @@ export class RoboSystemsExtensions {
       token: this.config.token,
       headers: this.config.headers,
     })
+
+    this.documents = new DocumentClient({
+      baseUrl: this.config.baseUrl,
+      credentials: this.config.credentials,
+      token: this.config.token,
+      headers: this.config.headers,
+    })
   }
 
   /**
@@ -154,6 +163,7 @@ export * from './SSEClient'
 export * from './FileClient'
 export * from './MaterializationClient'
 export * from './GraphClient'
+export * from './DocumentClient'
 export * from './config'
 
 // Export TableClient types individually to avoid conflicts with QueryClient's QueryResult
@@ -168,6 +178,7 @@ export {
   FileClient,
   MaterializationClient,
   GraphClient,
+  DocumentClient,
 }
 
 // Export React hooks
@@ -212,6 +223,9 @@ export const extensions = {
   get graphs() {
     return getExtensions().graphs
   },
+  get documents() {
+    return getExtensions().documents
+  },
   monitorOperation: (operationId: string, onProgress?: (progress: any) => void) =>
     getExtensions().monitorOperation(operationId, onProgress),
   createSSEClient: () => getExtensions().createSSEClient(),