@brownandroot/api 0.11.0 → 0.13.0

package/dist/index.d.ts

@@ -40,6 +40,8 @@ export interface Employee {
 export interface ApiHubClientOptions {
     baseUrl: string;
     apiKey: string;
+    /** Default cache TTL in milliseconds. Set to 0 to disable caching. Default: 5 minutes. */
+    cacheTtl?: number;
 }
 export interface DropdownOption {
     value: number | string;
@@ -81,6 +83,38 @@ export interface ChatResponse {
         totalTokens: number | null;
     };
 }
+export interface DocumentRecord {
+    id: number;
+    fileName: string;
+    fileType: 'pdf' | 'csv';
+    documentType: string | null;
+    summary: string | null;
+    totalChunks: number;
+    uploadedAt: string | null;
+    uploadedBy: string | null;
+}
+export interface SearchResult {
+    chunkId: number;
+    content: string;
+    fileName: string;
+    documentType: string | null;
+    score: number;
+}
+export interface StreamChatUserContext {
+    name: string;
+    department?: string;
+    roles?: string[];
+}
+export interface StreamChatRequest {
+    messages: {
+        role: 'user' | 'assistant';
+        content: string;
+    }[];
+    userContext?: StreamChatUserContext;
+    useRag?: boolean;
+    tools?: string[];
+    source?: string;
+}
 export interface BusinessUnit {
     id: string;
     companyId: string;
@@ -158,7 +192,12 @@ export interface Jobtypejobstep {
 export declare class ApiHubClient {
     private baseUrl;
     private apiKey;
+    private cacheTtl;
+    private cache;
     constructor(options: ApiHubClientOptions);
+    /** Clear all cached responses, or a specific path */
+    clearCache(path?: string): void;
+    private cachedRequest;
     private request;
     /** Get all employees */
     getEmployees(): Promise<Employee[]>;
@@ -183,12 +222,26 @@ export declare class ApiHubClient {
     getLlmLogs(): Promise<LlmLog[]>;
     /** Send a chat completion request to the LLM */
     chat(request: ChatRequest): Promise<ChatResponse>;
+    /** Start a streaming chat session — returns the raw SSE Response for proxying */
+    chatStream(request: StreamChatRequest): Promise<Response>;
+    /** Upload and process a document */
+    uploadDocument(fileName: string, base64Content: string, uploadedBy: string): Promise<DocumentRecord>;
+    /** List all documents in the knowledge base */
+    listDocuments(): Promise<DocumentRecord[]>;
+    /** Delete a document and its chunks */
+    deleteDocument(id: number): Promise<void>;
+    /** Search the knowledge base with a natural language query */
+    searchDocuments(query: string, topK?: number): Promise<SearchResult[]>;
     getBusinessUnits(): Promise<BusinessUnit[]>;
     getBusinessUnitsDropdown(): Promise<DropdownOption[]>;
     getBusinessUnit(id: string): Promise<BusinessUnit>;
     getCostcodes(): Promise<Costcode[]>;
     getCostcodesDropdown(): Promise<DropdownOption[]>;
     getCostcode(id: string): Promise<Costcode>;
+    /** Get cost codes for a specific business unit, formatted for dropdown controls */
+    getCostcodesDropdownByBu(businessUnitId: string): Promise<DropdownOption[]>;
+    /** Get cost codes for a specific business unit and pay type, formatted for dropdown controls */
+    getCostcodesDropdownByBuAndPayType(businessUnitId: string, payTypeCode: string): Promise<DropdownOption[]>;
     getPaytypes(): Promise<Paytype[]>;
     getPaytypesDropdown(): Promise<PaytypeDropdownOption[]>;
     getPaytype(id: string): Promise<Paytype>;

package/dist/index.js

@@ -1,9 +1,35 @@
 export class ApiHubClient {
     baseUrl;
     apiKey;
+    cacheTtl;
+    cache = new Map();
     constructor(options) {
         this.baseUrl = options.baseUrl.replace(/\/+$/, '');
         this.apiKey = options.apiKey;
+        this.cacheTtl = options.cacheTtl ?? 5 * 60 * 1000;
+    }
+    /** Clear all cached responses, or a specific path */
+    clearCache(path) {
+        if (path) {
+            this.cache.delete(path);
+        }
+        else {
+            this.cache.clear();
+        }
+    }
+    async cachedRequest(path, ttl) {
+        const effectiveTtl = ttl ?? this.cacheTtl;
+        if (effectiveTtl > 0) {
+            const entry = this.cache.get(path);
+            if (entry && entry.expires > Date.now()) {
+                return entry.data;
+            }
+        }
+        const data = await this.request(path);
+        if (effectiveTtl > 0) {
+            this.cache.set(path, { data, expires: Date.now() + effectiveTtl });
+        }
+        return data;
     }
     async request(path) {
         let res;
@@ -25,11 +51,11 @@ export class ApiHubClient {
     }
     /** Get all employees */
     async getEmployees() {
-        return this.request('/employees');
+        return this.cachedRequest('/employees');
     }
     /** Get employees formatted for dropdown controls */
     async getEmployeesDropdown() {
-        return this.request('/employees/dropdown');
+        return this.cachedRequest('/employees/dropdown');
     }
     /** Get a single employee by employeeId */
     async getEmployee(employeeId) {
@@ -60,7 +86,7 @@ export class ApiHubClient {
     // -----------------------------------------------------------------------
     /** List all LLM log entries (newest first) */
     async getLlmLogs() {
-        return this.request('/llm-logs');
+        return this.cachedRequest('/llm-logs');
     }
     /** Send a chat completion request to the LLM */
     async chat(request) {
@@ -87,13 +113,114 @@ export class ApiHubClient {
         return res.json();
     }
     // -----------------------------------------------------------------------
+    // Streaming Chat
+    // -----------------------------------------------------------------------
+    /** Start a streaming chat session — returns the raw SSE Response for proxying */
+    async chatStream(request) {
+        let res;
+        try {
+            res = await fetch(`${this.baseUrl}/ai/chat/stream`, {
+                method: 'POST',
+                headers: {
+                    'x-api-key': this.apiKey,
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify(request),
+            });
+        }
+        catch {
+            throw new Error(`APIHub unavailable: ${this.baseUrl}/ai/chat/stream`);
+        }
+        if (!res.ok) {
+            const body = await res.json().catch(() => null);
+            const message = (body && typeof body === 'object' && 'error' in body && typeof body.error === 'string' ? body.error : null) ??
+                `Request failed: ${res.status} ${res.statusText}`;
+            throw new Error(message);
+        }
+        return res;
+    }
+    // -----------------------------------------------------------------------
+    // RAG Documents
+    // -----------------------------------------------------------------------
+    /** Upload and process a document */
+    async uploadDocument(fileName, base64Content, uploadedBy) {
+        let res;
+        try {
+            res = await fetch(`${this.baseUrl}/ai/documents`, {
+                method: 'POST',
+                headers: {
+                    'x-api-key': this.apiKey,
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({ fileName, base64Content, uploadedBy }),
+            });
+        }
+        catch {
+            throw new Error(`APIHub unavailable: ${this.baseUrl}/ai/documents`);
+        }
+        if (!res.ok) {
+            const body = await res.json().catch(() => null);
+            const message = (body && typeof body === 'object' && 'error' in body && typeof body.error === 'string' ? body.error : null) ??
+                `Request failed: ${res.status} ${res.statusText}`;
+            throw new Error(message);
+        }
+        return res.json();
+    }
+    /** List all documents in the knowledge base */
+    async listDocuments() {
+        return this.cachedRequest('/ai/documents');
+    }
+    /** Delete a document and its chunks */
+    async deleteDocument(id) {
+        let res;
+        try {
+            res = await fetch(`${this.baseUrl}/ai/documents/${id}`, {
+                method: 'DELETE',
+                headers: { 'x-api-key': this.apiKey },
+            });
+        }
+        catch {
+            throw new Error(`APIHub unavailable: ${this.baseUrl}/ai/documents/${id}`);
+        }
+        if (!res.ok) {
+            const body = await res.json().catch(() => null);
+            const message = (body && typeof body === 'object' && 'error' in body && typeof body.error === 'string' ? body.error : null) ??
+                `Request failed: ${res.status} ${res.statusText}`;
+            throw new Error(message);
+        }
+    }
+    /** Search the knowledge base with a natural language query */
+    async searchDocuments(query, topK) {
+        let res;
+        try {
+            res = await fetch(`${this.baseUrl}/ai/search`, {
+                method: 'POST',
+                headers: {
+                    'x-api-key': this.apiKey,
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({ query, topK }),
+            });
+        }
+        catch {
+            throw new Error(`APIHub unavailable: ${this.baseUrl}/ai/search`);
+        }
+        if (!res.ok) {
+            const body = await res.json().catch(() => null);
+            const message = (body && typeof body === 'object' && 'error' in body && typeof body.error === 'string' ? body.error : null) ??
+                `Request failed: ${res.status} ${res.statusText}`;
+            throw new Error(message);
+        }
+        return res.json();
+    }
+    // -----------------------------------------------------------------------
     // Business Units
     // -----------------------------------------------------------------------
     async getBusinessUnits() {
-        return this.request('/business-units');
+        return this.cachedRequest('/business-units');
     }
     async getBusinessUnitsDropdown() {
-        return this.request('/business-units/dropdown');
+        return this.cachedRequest('/business-units/dropdown');
     }
     async getBusinessUnit(id) {
         return this.request(`/business-units/${encodeURIComponent(id)}`);
@@ -102,22 +229,30 @@ export class ApiHubClient {
     // Cost Codes
     // -----------------------------------------------------------------------
     async getCostcodes() {
-        return this.request('/costcodes');
+        return this.cachedRequest('/costcodes');
     }
     async getCostcodesDropdown() {
-        return this.request('/costcodes/dropdown');
+        return this.cachedRequest('/costcodes/dropdown');
     }
     async getCostcode(id) {
         return this.request(`/costcodes/${encodeURIComponent(id)}`);
     }
+    /** Get cost codes for a specific business unit, formatted for dropdown controls */
+    async getCostcodesDropdownByBu(businessUnitId) {
+        return this.cachedRequest(`/costcodes/by-bu/${encodeURIComponent(businessUnitId)}/dropdown`);
+    }
+    /** Get cost codes for a specific business unit and pay type, formatted for dropdown controls */
+    async getCostcodesDropdownByBuAndPayType(businessUnitId, payTypeCode) {
+        return this.cachedRequest(`/costcodes/by-bu/${encodeURIComponent(businessUnitId)}/by-paytype/${encodeURIComponent(payTypeCode)}/dropdown`);
+    }
     // -----------------------------------------------------------------------
     // Pay Types
     // -----------------------------------------------------------------------
     async getPaytypes() {
-        return this.request('/paytypes');
+        return this.cachedRequest('/paytypes');
     }
     async getPaytypesDropdown() {
-        return this.request('/paytypes/dropdown');
+        return this.cachedRequest('/paytypes/dropdown');
     }
     async getPaytype(id) {
         return this.request(`/paytypes/${encodeURIComponent(id)}`);
@@ -126,14 +261,14 @@ export class ApiHubClient {
     // Work Orders
     // -----------------------------------------------------------------------
     async getWorkorders() {
-        return this.request('/workorders');
+        return this.cachedRequest('/workorders');
     }
     async getWorkordersDropdown() {
-        return this.request('/workorders/dropdown');
+        return this.cachedRequest('/workorders/dropdown');
     }
     /** Get work orders for a specific business unit, formatted for dropdown controls */
     async getWorkordersDropdownByBu(businessUnitId) {
-        return this.request(`/workorders/by-bu/${encodeURIComponent(businessUnitId)}/dropdown`);
+        return this.cachedRequest(`/workorders/by-bu/${encodeURIComponent(businessUnitId)}/dropdown`);
     }
     async getWorkorder(id) {
         return this.request(`/workorders/${encodeURIComponent(id)}`);
@@ -142,10 +277,10 @@ export class ApiHubClient {
     // Job Type / Job Steps
     // -----------------------------------------------------------------------
     async getJobtypejobsteps() {
-        return this.request('/jobtypejobsteps');
+        return this.cachedRequest('/jobtypejobsteps');
     }
     async getJobtypejobstepsDropdown() {
-        return this.request('/jobtypejobsteps/dropdown');
+        return this.cachedRequest('/jobtypejobsteps/dropdown');
     }
     async getJobtypejobstep(id) {
         return this.request(`/jobtypejobsteps/${encodeURIComponent(id)}`);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@brownandroot/api",
-	"version": "0.11.0",
+	"version": "0.13.0",
 	"type": "module",
 	"repository": {
 		"type": "git",