edgequake-sdk 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to `@edgequake/sdk` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-02-11
+
+### Added
+
+- **Core client** with config-based initialization (`EdgeQuake` class)
+- **21 resource classes**: Auth, Users, ApiKeys, Documents (+ PDF sub-resource), Query, Chat, Graph (+ Entities, Relationships), Conversations (+ Messages), Folders, Shared, Tenants, Workspaces, Tasks, Pipeline, Costs, Lineage, Chunks, Provenance, Settings, Models, Ollama
+- **Transport layer** with native `fetch()` — zero runtime dependencies
+- **Middleware system** for auth, tenant headers, logging
+- **Retry middleware** with exponential backoff and jitter
+- **SSE streaming** via `parseSSEStream()` async generator
+- **WebSocket wrapper** via `EdgeQuakeWebSocket` async iterable
+- **Paginator** class implementing `AsyncIterable` for paginated endpoints
+- **Typed error hierarchy**: `EdgeQuakeError`, `NotFoundError`, `UnauthorizedError`, `RateLimitedError`, `ValidationError`, `ConflictError`, `NetworkError`, `TimeoutError`
+- **Dual module output**: ESM (.js) + CJS (.cjs) + TypeScript declarations (.d.ts)
+- **243 unit tests** with 98.52% line coverage
+- **8 usage examples** covering all major features
+- **CI/CD pipelines** for testing (Node 18/20/22) and npm publishing

package/LICENSE

@@ -0,0 +1,189 @@
+                                 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.
+
+      "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 the 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 the 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 any 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
+
+   Copyright 2025 EdgeQuake Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,185 @@
+# @edgequake/sdk
+
+TypeScript SDK for the [EdgeQuake](https://github.com/raphaelmansuy/edgequake) RAG API.
+
+## Features
+
+- **Full API Coverage** — All 131+ endpoints across 27 resource categories
+- **Type-Safe** — Complete TypeScript definitions for every request/response
+- **Zero Dependencies** — Uses native `fetch()` (Node 18+, Deno, Bun, Browser)
+- **Streaming** — Server-Sent Events (SSE) and WebSocket support with `AsyncIterable`
+- **Auto-Pagination** — `for await...of` over paginated results
+- **Retry & Backoff** — Configurable exponential backoff with jitter
+- **Multi-Tenant** — Built-in tenant/workspace header management
+- **Dual Format** — ESM + CommonJS output with `.d.ts` declarations
+
+## Installation
+
+```bash
+npm install @edgequake/sdk
+```
+
+## Quick Start
+
+```typescript
+import { EdgeQuake } from "@edgequake/sdk";
+
+const client = new EdgeQuake({
+  baseUrl: "http://localhost:8080",
+  apiKey: "eq-key-xxx",
+});
+
+// Health check
+const health = await client.health();
+console.log(health.status); // "healthy"
+
+// Upload a document
+const doc = await client.documents.upload({
+  title: "My Document",
+  content: "EdgeQuake is a graph-based RAG framework...",
+});
+
+// Query the knowledge graph
+const result = await client.query.execute({
+  query: "What is EdgeQuake?",
+  mode: "hybrid",
+});
+console.log(result.answer);
+
+// Stream chat completions
+for await (const event of client.chat.stream({
+  messages: [{ role: "user", content: "Summarize the documents" }],
+})) {
+  process.stdout.write(event.choices?.[0]?.delta?.content ?? "");
+}
+```
+
+## Configuration
+
+```typescript
+const client = new EdgeQuake({
+  baseUrl: "http://localhost:8080", // Default
+  apiKey: "eq-key-xxx", // API key auth
+  accessToken: "jwt-token", // Or JWT auth
+  tenantId: "tenant-1", // Multi-tenant
+  workspaceId: "workspace-1", // Workspace scope
+  timeout: 30000, // 30s default
+  maxRetries: 3, // Retry on 429/503
+});
+```
+
+Environment variables are used as fallbacks:
+
+- `EDGEQUAKE_BASE_URL`
+- `EDGEQUAKE_API_KEY`
+- `EDGEQUAKE_TENANT_ID`
+- `EDGEQUAKE_WORKSPACE_ID`
+
+## Resource Namespaces
+
+| Namespace                       | Description                          |
+| ------------------------------- | ------------------------------------ |
+| `client.auth`                   | Login, refresh, logout, current user |
+| `client.users`                  | User management (admin)              |
+| `client.apiKeys`                | API key management                   |
+| `client.documents`              | Document ingestion & management      |
+| `client.documents.pdf`          | PDF upload, extraction, download     |
+| `client.query`                  | RAG query execution & streaming      |
+| `client.chat`                   | Chat completions (unified API)       |
+| `client.conversations`          | Conversation history                 |
+| `client.conversations.messages` | Message CRUD                         |
+| `client.folders`                | Conversation folders                 |
+| `client.shared`                 | Public shared conversations          |
+| `client.graph`                  | Knowledge graph queries              |
+| `client.graph.entities`         | Entity CRUD & merge                  |
+| `client.graph.relationships`    | Relationship CRUD                    |
+| `client.tenants`                | Multi-tenant management              |
+| `client.workspaces`             | Workspace management                 |
+| `client.tasks`                  | Async task tracking                  |
+| `client.pipeline`               | Pipeline status & control            |
+| `client.costs`                  | Cost tracking & budgets              |
+| `client.lineage`                | Entity & document lineage            |
+| `client.chunks`                 | Chunk-level details                  |
+| `client.provenance`             | Entity provenance                    |
+| `client.settings`               | Provider settings                    |
+| `client.models`                 | Model configuration                  |
+| `client.ollama`                 | Ollama-compatible API                |
+
+## Pagination
+
+```typescript
+// Auto-iterate through all pages
+for await (const doc of client.documents.list({ status: "completed" })) {
+  console.log(doc.title);
+}
+
+// Get a specific page
+const page = await client.documents.list().getPage(2);
+console.log(page.items, page.hasMore);
+
+// Collect all into array
+const all = await client.documents.list().toArray();
+```
+
+## Error Handling
+
+```typescript
+import {
+  NotFoundError,
+  RateLimitedError,
+  EdgeQuakeError,
+} from "@edgequake/sdk";
+
+try {
+  await client.documents.get("missing-id");
+} catch (error) {
+  if (error instanceof NotFoundError) {
+    console.log("Document not found");
+  } else if (error instanceof RateLimitedError) {
+    console.log("Rate limited, retry later");
+  } else if (error instanceof EdgeQuakeError) {
+    console.log(`API error: ${error.code} (${error.status})`);
+  }
+}
+```
+
+## Examples
+
+See the [`examples/`](./examples/) directory for complete working examples:
+
+| Example                                                     | Description                                |
+| ----------------------------------------------------------- | ------------------------------------------ |
+| [`basic_usage.ts`](./examples/basic_usage.ts)               | Setup, health check, upload, query         |
+| [`document_upload.ts`](./examples/document_upload.ts)       | Text + PDF upload, tracking, pagination    |
+| [`query_demo.ts`](./examples/query_demo.ts)                 | Simple, hybrid, and chat queries           |
+| [`graph_exploration.ts`](./examples/graph_exploration.ts)   | Entity search, neighborhood, relationships |
+| [`streaming_query.ts`](./examples/streaming_query.ts)       | SSE streaming query + chat + abort         |
+| [`websocket_progress.ts`](./examples/websocket_progress.ts) | WebSocket pipeline progress                |
+| [`multi_tenant.ts`](./examples/multi_tenant.ts)             | Tenant/workspace management                |
+| [`batch_operations.ts`](./examples/batch_operations.ts)     | Bulk operations, pagination, cost estimate |
+
+Run any example with:
+
+```bash
+npx tsx examples/basic_usage.ts
+```
+
+## Documentation
+
+- [**API Reference**](./docs/API.md) — All endpoints, methods, and types
+- [**Authentication**](./docs/AUTHENTICATION.md) — API key, JWT, multi-tenant
+- [**Streaming**](./docs/STREAMING.md) — SSE + WebSocket patterns
+
+## Development
+
+```bash
+npm install          # Install dependencies
+npm run build        # Build ESM + CJS + .d.ts
+npm test             # Run 243 unit tests
+npm run test:coverage # Run tests with coverage report
+npm run lint         # TypeScript type check
+```
+
+## License
+
+Apache-2.0