@nebula-ai/sdk 1.2.2 → 1.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Nebula AI Inc
+Copyright (c) 2026 Nebula
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,18 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-
-
-
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,192 +1,67 @@
 # @nebula-ai/sdk
 
-Persistent memory layer for AI applications. Store, search, and retrieve information with semantic understanding.
+Official Nebula API SDK for TypeScript. Provides typed access to the public
+Nebula REST API: collections, memories, connectors, snapshots, and system
+health.
 
-## Requirements
-
-- Node.js 18.0.0 or higher
-
-## Installation
+## Install
 
 ```bash
 npm install @nebula-ai/sdk
+# or
+bun add @nebula-ai/sdk
 ```
 
-## Quick Start
+## Quick start
 
-```typescript
-import Nebula from '@nebula-ai/sdk';
+```ts
+import { Nebula } from "@nebula-ai/sdk";
 
-// Initialize client
 const client = new Nebula({
-  apiKey: 'your-api-key'
-});
-
-// Create a collection
-const collection = await client.createCluster({
-  name: 'my_notes'
-});
-
-// Store a memory
-const memoryId = await client.storeMemory({
-  collection_id: collection.id,
-  content: 'Machine learning is transforming healthcare',
-  metadata: { topic: 'AI', importance: 'high' }
-});
-
-// Search memories
-const results = await client.search({
-  query: 'machine learning healthcare',
-  collection_ids: [collection.id],
-});
-
-results.forEach(result => {
-  console.log(`Score: ${result.score?.toFixed(2)}`);
-  console.log(`Content: ${result.content}`);
-});
-```
-
-## Core Operations
-
-### Collections
-
-```typescript
-// Create
-const collection = await client.createCluster({
-  name: 'my_collection',
-  description: 'Optional description'
-});
-
-// List
-const collections = await client.listClusters();
-
-// Get by ID or name
-const collection = await client.getCluster(collectionId);
-const collection = await client.getClusterByName('my_collection');
-
-// Update
-await client.updateCluster({
-  collectionId,
-  name: 'new_name'
-});
-
-// Delete
-await client.deleteCluster(collectionId);
-```
-
-### Store Memories
-
-```typescript
-// Single memory
-const memoryId = await client.storeMemory({
-  collection_id: collection.id,
-  content: 'Your content here',
-  metadata: { category: 'example' }
+  apiKey: process.env.NEBULA_API_KEY,
+  // or: bearerToken: process.env.NEBULA_BEARER_TOKEN,
 });
 
-// Batch storage
-const memoryIds = await client.storeMemories([
-  { collection_id: collection.id, content: 'First memory' },
-  { collection_id: collection.id, content: 'Second memory' }
-]);
-```
-
-### Retrieve Memories
-
-```typescript
-// List memories
-const memories = await client.listMemories({
-  collection_ids: [collection.id],
-  limit: 10
+const id = await client.storeMemory({
+  collection_id: "01234567-...",
+  raw_text: "hello, world",
 });
 
-// Filter with metadata
-const memories = await client.listMemories({
-  collection_ids: [collection.id],
-  metadata_filters: {
-    'metadata.category': { $eq: 'example' }
-  }
-});
-
-// Get specific memory
-const memory = await client.getMemory('memory-id');
+const results = await client.search({ query: "hello" });
 ```
 
-### Search
+The high-level methods (`storeMemory`, `search`, `deleteMemory`, ...) come
+from the handwritten DX layer at `src/lib/dx.ts`. The low-level resource
+clients (`client.memories.*`, `client.collections.*`, ...) are generated
+directly from the OpenAPI spec and remain available as
+`client.memories.create(...)`, `client.memories.search(...)`, etc.
 
-```typescript
-// Semantic search
-const results = await client.search({
-  query: 'your search query',
-  collection_ids: [collection.id],
-});
-```
+## Auth
 
-### Delete
+The constructor accepts both `apiKey` / `bearerToken` (camelCase) and the
+snake_case aliases `api_key` / `access_token`. If you pass an API key that
+doesn't look like a Nebula key (not prefixed with `key_` or `neb_`), the
+DX layer automatically routes it through the bearer-token header instead.
 
-```typescript
-// Single deletion
-const deleted = await client.delete('memory-id'); // Returns boolean
+## Errors
 
-// Batch deletion
-const result = await client.delete(['id1', 'id2', 'id3']); // Returns detailed results
-```
+All HTTP errors map to a typed exception hierarchy:
 
-## Conversations
-
-```typescript
-// Store conversation messages
-const conversationId = await client.storeMemory({
-  collection_id: collection.id,
-  content: 'What is machine learning?',
-  role: 'user',
-  metadata: { content_type: 'conversation' }
-});
-
-await client.storeMemory({
-  collection_id: collection.id,
-  content: 'Machine learning is a subset of AI...',
-  role: 'assistant',
-  parent_id: conversationId,
-  metadata: { content_type: 'conversation' }
-});
-
-// List conversation memories
-const conversations = await client.listMemories({
-  collection_ids: [collection.id],
-  metadata_filters: { 'metadata.content_type': { $eq: 'conversation' } }
-});
-
-// Get messages from a conversation memory
-const conversation = await client.getMemory(conversationId);
-const messages = conversation.chunks ?? [];
-```
-
-## Error Handling
-
-```typescript
-import Nebula, {
-  NebulaAuthenticationException,
-  NebulaRateLimitException,
-  NebulaValidationException
-} from '@nebula-ai/sdk';
-
-try {
-  await client.search({ query: 'query', collection_ids: [collectionId] });
-} catch (error) {
-  if (error instanceof NebulaAuthenticationException) {
-    console.log('Invalid API key');
-  } else if (error instanceof NebulaRateLimitException) {
-    console.log('Rate limit exceeded');
-  }
-}
-```
+- `NebulaBadRequestError` (400)
+- `NebulaUnauthorizedError` (401)
+- `NebulaForbiddenError` (403)
+- `NebulaNotFoundError` (404)
+- `NebulaConflictError` (409)
+- `NebulaValidationError` (422)
+- `NebulaRateLimitError` (429) — carries `retryAfter` when the server returns `Retry-After`
+- `NebulaServerError` (5xx)
+- `NebulaConnectionError` / `NebulaTimeoutError` — transport-level
 
-## Documentation
+## Docs
 
-- [Full Documentation](https://docs.trynebula.ai)
-- [API Reference](https://docs.trynebula.ai/clients/nodejs)
+- API reference: https://docs.zeroset.com
+- Migration notes: see `MIGRATION.md` in the source repo
 
-## Support
+## License
 
-Email [support@trynebula.ai](mailto:support@trynebula.ai)
+MIT