@trustgraph/client 0.2.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,319 @@
+# @trustgraph/client
+
+TypeScript/JavaScript client library for TrustGraph WebSocket API. This package provides a framework-agnostic client for communicating with TrustGraph services.
+
+## Features
+
+- 🌐 **WebSocket-based** - Real-time communication with TrustGraph services
+- 📦 **Zero Dependencies** - No external runtime dependencies
+- 🔐 **Authentication Support** - Optional API key authentication
+- 🔄 **Auto-reconnection** - Handles connection failures gracefully
+- 📝 **Full TypeScript Support** - Complete type definitions
+- 🎯 **Framework Agnostic** - Works with any JavaScript framework or vanilla JS
+
+## Installation
+
+```bash
+npm install @trustgraph/client
+```
+
+## Quick Start
+
+```typescript
+import { createTrustGraphSocket } from "@trustgraph/client";
+
+// Create a socket connection
+const socket = createTrustGraphSocket("your-username");
+
+// Query triples from the knowledge graph
+const triples = await socket.triplesQuery(
+  { v: "http://example.org/subject", e: true },
+  { v: "http://example.org/predicate", e: true },
+  undefined,
+  10, // limit
+);
+
+console.log(triples);
+```
+
+## With Authentication
+
+```typescript
+const socket = createTrustGraphSocket("your-username", "your-api-key");
+```
+
+## Core APIs
+
+### Knowledge Graph Operations
+
+**Query Triples**
+
+```typescript
+const triples = await socket.triplesQuery(
+  subject?: Value,    // Optional subject filter
+  predicate?: Value,  // Optional predicate filter
+  object?: Value,     // Optional object filter
+  limit: number,      // Maximum results
+  collection?: string // Optional collection name
+);
+```
+
+**Graph Embeddings Query**
+
+```typescript
+const entities = await socket.graphEmbeddingsQuery(
+  vectors: number[][],  // Embedding vectors
+  limit: number,        // Maximum results
+  collection?: string   // Optional collection name
+);
+```
+
+### Text & LLM Operations
+
+**Text Completion**
+
+```typescript
+const response = await socket.textCompletion(
+  system: string,    // System prompt
+  prompt: string,    // User prompt
+  temperature?: number
+);
+```
+
+**Graph RAG**
+
+```typescript
+const answer = await socket.graphRag(
+  query: string,
+  options?: {
+    'entity-limit'?: number,
+    'triple-limit'?: number,
+    'max-subgraph-size'?: number,
+    'max-path-length'?: number
+  },
+  collection?: string
+);
+```
+
+**Agent**
+
+```typescript
+socket.agent(
+  question: string,
+  think: (thought: string) => void,      // Called when agent is thinking
+  observe: (observation: string) => void, // Called on observations
+  answer: (answer: string) => void,      // Called with final answer
+  error: (error: string) => void,        // Called on errors
+  collection?: string
+);
+```
+
+**Embeddings**
+
+```typescript
+const vectors = await socket.embeddings(text: string);
+```
+
+### Document Operations
+
+**Load Document**
+
+```typescript
+await socket.loadDocument(
+  id: string,           // Document ID
+  data: string,         // Base64-encoded document
+  metadata: Triple[],   // Document metadata as triples
+  collection?: string
+);
+```
+
+**Load Text**
+
+```typescript
+await socket.loadText(
+  id: string,           // Document ID
+  text: string,         // Plain text content
+  charset: string,      // Character encoding (e.g., 'utf-8')
+  metadata: Triple[],   // Document metadata as triples
+  collection?: string
+);
+```
+
+### Library Operations
+
+**List Documents**
+
+```typescript
+const docs = await socket.library.listDocuments(
+  user?: string,
+  collection?: string
+);
+```
+
+**Get Document**
+
+```typescript
+const doc = await socket.library.getDocument(
+  id: string,
+  user?: string,
+  collection?: string
+);
+```
+
+**Delete Document**
+
+```typescript
+await socket.library.deleteDocument(
+  id: string,
+  user?: string,
+  collection?: string
+);
+```
+
+### Flow Operations
+
+Flows represent processing pipelines for documents and queries.
+
+**Create Flow API**
+
+```typescript
+const flowApi = socket.flow("flow-id");
+// flowApi has same methods as socket but scoped to this flow
+```
+
+**Start Flow**
+
+```typescript
+await socket.flows.startFlow(
+  flowId: string,
+  className: string,
+  description: string
+);
+```
+
+**Stop Flow**
+
+```typescript
+await socket.flows.stopFlow(flowId: string);
+```
+
+**List Flows**
+
+```typescript
+const flowIds = await socket.flows.getFlows();
+```
+
+**Get Flow Definition**
+
+```typescript
+const flowDef = await socket.flows.getFlow(flowId: string);
+```
+
+**List Flow Classes**
+
+```typescript
+const classes = await socket.flows.getFlowClasses();
+```
+
+**Get Flow Class**
+
+```typescript
+const classDef = await socket.flows.getFlowClass(className: string);
+```
+
+## Connection State Monitoring
+
+```typescript
+// Subscribe to connection state changes
+const unsubscribe = socket.onConnectionStateChange((state) => {
+  console.log("Status:", state.status); // 'connecting' | 'connected' | 'authenticated' | 'disconnected' | 'error'
+  console.log("Authenticated:", state.authenticated);
+  console.log("Error:", state.error);
+});
+
+// Unsubscribe when done
+unsubscribe();
+```
+
+## Data Types
+
+### Value
+
+Represents a subject, predicate, or object in a triple:
+
+```typescript
+interface Value {
+  v: string; // Value (URI or literal)
+  e: boolean; // Is entity (true) or literal (false)
+  label?: string; // Optional human-readable label
+}
+```
+
+### Triple
+
+Represents a subject-predicate-object relationship:
+
+```typescript
+interface Triple {
+  s: Value; // Subject
+  p: Value; // Predicate
+  o: Value; // Object
+}
+```
+
+## Advanced Usage
+
+### Custom Timeout and Retries
+
+Most methods accept optional timeout and retry parameters:
+
+```typescript
+await socket.triplesQuery(
+  subject,
+  predicate,
+  object,
+  limit,
+  collection,
+  30000, // timeout in ms
+  5, // retry attempts
+);
+```
+
+### Closing the Connection
+
+```typescript
+socket.close();
+```
+
+## Error Handling
+
+All async methods return Promises that reject on error:
+
+```typescript
+try {
+  const result = await socket.triplesQuery(...);
+} catch (error) {
+  console.error('Query failed:', error);
+}
+```
+
+## React Integration
+
+For React applications, use the companion package:
+
+```bash
+npm install @trustgraph/react-provider
+```
+
+See [@trustgraph/react-provider](https://github.com/trustgraph-ai/trustgraph-client) for React-specific hooks and providers.
+
+## API Reference
+
+Full API documentation is available in the TypeScript definitions. Your IDE will provide autocomplete and inline documentation for all methods.
+
+## License
+
+Apache 2.0
+
+(c) KnowNext Inc., KnowNext Limited 2025
+

package/dist/__tests__/flows-api.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flows-api.test.d.ts.map

package/dist/__tests__/flows-api.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flows-api.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/flows-api.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/messages.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=messages.test.d.ts.map

package/dist/__tests__/messages.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/messages.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/service-call-multi.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=service-call-multi.test.d.ts.map

package/dist/__tests__/service-call-multi.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-call-multi.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/service-call-multi.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/service-call.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=service-call.test.d.ts.map

package/dist/__tests__/service-call.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-call.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/service-call.test.ts"],"names":[],"mappings":""}

package/dist/api/authenticated-fetch.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Authenticated fetch utility
+ *
+ * Provides fetch functions that automatically include Bearer token authentication
+ * when an API key is configured in settings.
+ */
+/**
+ * Creates an authenticated fetch function that includes Bearer token when available
+ * @param apiKey - Optional API key for authentication
+ * @returns Fetch function with automatic auth headers
+ */
+export declare const createAuthenticatedFetch: (apiKey?: string) => (url: string, options?: RequestInit) => Promise<Response>;
+/**
+ * Hook-based authenticated fetch that uses current settings
+ * This is a React hook that must be called from within a component
+ */
+export declare const useAuthenticatedFetch: () => never;
+//# sourceMappingURL=authenticated-fetch.d.ts.map

package/dist/api/authenticated-fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticated-fetch.d.ts","sourceRoot":"","sources":["../../src/api/authenticated-fetch.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GAAI,SAAS,MAAM,MAC9C,KAAK,MAAM,EAAE,UAAS,WAAgB,sBAe/C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,aAMjC,CAAC"}

package/dist/api/trustgraph/SocketContext.d.ts

@@ -0,0 +1,2 @@
+export declare const SocketContext: import("react").Context<import("./trustgraph-socket").Socket>;
+//# sourceMappingURL=SocketContext.d.ts.map

package/dist/api/trustgraph/SocketContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketContext.d.ts","sourceRoot":"","sources":["../../../src/api/trustgraph/SocketContext.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,aAAa,+DAAwB,CAAC"}

package/dist/api/trustgraph/SocketProvider.d.ts

@@ -0,0 +1,21 @@
+import React from "react";
+import { type ConnectionState } from "./trustgraph-socket";
+import type { Socket } from "./trustgraph-socket";
+export declare const SocketContext: React.Context<Socket | null>;
+export declare const ConnectionStateContext: React.Context<ConnectionState | null>;
+export declare const useSocket: () => Socket;
+export declare const useConnectionState: () => ConnectionState;
+interface SocketProviderProps {
+    children: React.ReactNode;
+}
+/**
+ * SocketProvider - Manages WebSocket connection with authentication
+ *
+ * Critical requirements:
+ * 1. Wait for settings to load before creating socket
+ * 2. Create socket with user and token if apiKey is present
+ * 3. Reconnect when user or authentication settings change
+ */
+export declare const SocketProvider: React.FC<SocketProviderProps>;
+export {};
+//# sourceMappingURL=SocketProvider.d.ts.map

package/dist/api/trustgraph/SocketProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketProvider.d.ts","sourceRoot":"","sources":["../../../src/api/trustgraph/SocketProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAyD,MAAM,OAAO,CAAC;AAE9E,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGlD,eAAO,MAAM,aAAa,8BAAqC,CAAC;AAChE,eAAO,MAAM,sBAAsB,uCAElC,CAAC;AAGF,eAAO,MAAM,SAAS,cAQrB,CAAC;AAGF,eAAO,MAAM,kBAAkB,uBAU9B,CAAC;AAEF,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAoFxD,CAAC"}

package/dist/api/trustgraph/Triple.d.ts

@@ -0,0 +1,17 @@
+export interface Value {
+    v: string;
+    e: boolean;
+    label?: string;
+}
+export interface PartialTriple {
+    s?: Value;
+    p?: Value;
+    o?: Value;
+}
+export interface Triple {
+    s: Value;
+    p: Value;
+    o: Value;
+    direc?: string;
+}
+//# sourceMappingURL=Triple.d.ts.map

package/dist/api/trustgraph/Triple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Triple.d.ts","sourceRoot":"","sources":["../../../src/api/trustgraph/Triple.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,OAAO,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,CAAC,EAAE,KAAK,CAAC;IACV,CAAC,CAAC,EAAE,KAAK,CAAC;IACV,CAAC,CAAC,EAAE,KAAK,CAAC;CACX;AAED,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,KAAK,CAAC;IACT,CAAC,EAAE,KAAK,CAAC;IACT,CAAC,EAAE,KAAK,CAAC;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}