@dooor-ai/cortexdb 0.6.0 → 0.6.2

package/README.md

@@ -1,6 +1,24 @@
 # CortexDB TypeScript SDK
 
-Official TypeScript/JavaScript client for CortexDB.
+<div align="center">
+
+```
+██████╗  ██████╗  ██████╗  ██████╗ ██████╗ 
+██╔══██╗██╔═══██╗██╔═══██╗██╔═══██╗██╔══██╗
+██║  ██║██║   ██║██║   ██║██║   ██║██████╔╝
+██║  ██║██║   ██║██║   ██║██║   ██║██╔══██╗
+██████╔╝╚██████╔╝╚██████╔╝╚██████╔╝██║  ██║
+╚═════╝  ╚═════╝  ╚═════╝  ╚═════╝ ╚═╝  ╚═╝
+```
+
+**Official TypeScript/JavaScript SDK for CortexDB**
+
+[![npm version](https://img.shields.io/npm/v/@dooor-ai/cortexdb.svg)](https://www.npmjs.com/package/@dooor-ai/cortexdb)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+</div>
+
+---
 
 ## What is CortexDB?
 
@@ -25,6 +43,7 @@ CortexDB handles the complex infrastructure of vector databases (Qdrant), object
 - **Type-safe**: Full TypeScript support with comprehensive type definitions
 - **Modern API**: Async/await using native fetch (Node.js 18+)
 - **Infra management**: Database (`client.databases`) and embedding provider (`client.embeddingProviders`) APIs built-in
+- **🆕 TypeScript Decorators**: Define schemas using decorators (like TypeORM) with full IDE support - see [Schema Decorators Guide](./SCHEMA_DECORATORS_GUIDE.md)
 
 ## Installation
 
@@ -247,7 +266,7 @@ const created = await client.records.create(
   'articles',
   {
     title: 'Machine Learning Basics',
-    content: 'Machine learning é um subconjunto de IA focado em aprender com dados...',
+    content: 'Machine learning is a subset of AI focused on learning from data...',
     year: 2024,
   },
   {
@@ -277,33 +296,32 @@ const results = await client.records.list('articles', {
 
 ### Schema CLI (YAML)
 
-Instale o CLI (recomendado em devDependencies):
+Install the CLI (recommended in devDependencies):
 
 ```bash
 npm install --save-dev dooor
 ```
 
-Utilize o CLI unificado `dooor` para sincronizar schemas declarativos:
-Instale também a extensão “Dooor Tools” no VS Code/Cursor para validação em tempo real (Open VSX).
-
+Use the unified `dooor` CLI to synchronize declarative schemas.
+Also install the "Dooor Tools" extension in VS Code/Cursor for real-time validation (Open VSX).
 
 ```bash
-# Verificar diferenças entre YAML local e CortexDB
+# Check differences between local YAML and CortexDB
 npx dooor schema diff --dir dooor/schemas
 
-# Criar coleções que ainda não existem
+# Create collections that don't exist yet
 npx dooor schema apply --dir dooor/schemas
 
-# Aplicar sem gerar tipos (por padrão o apply já gera)
+# Apply without generating types (by default apply already generates them)
 npx dooor schema apply --no-generate-types
 
-# Gerar tipos TypeScript para uso nos serviços
+# Generate TypeScript types for use in services
 npx dooor schema generate-types --dir dooor/schemas --out src/generated/cortex-schema.ts
 ```
 
-### Tipagem automática das coleções
+### Automatic Collection Typing
 
-Após sincronizar o schema, o CLI gera `dooor/generated/cortex-schema.ts` com os tipos derivados. Informe esse schema ao SDK para ganhar autocomplete e validação semelhantes ao Prisma:
+After synchronizing the schema, the CLI generates `dooor/generated/cortex-schema.ts` with derived types. Provide this schema to the SDK to get Prisma-like autocomplete and validation:
 
 ```ts
 import { CortexClient } from '@dooor-ai/cortexdb';
@@ -328,12 +346,11 @@ const payload: CollectionCreateInput<'tool_calls'> = {
 await client.records.create('tool_calls', payload);
 ```
 
-Os generics se propagam para `records.update`, `records.list`, `records.get` e `records.search`. Se preferir o modo dinâmico antigo, instancie `new CortexClient()` sem parâmetro genérico.
-
+Generics propagate to `records.update`, `records.list`, `records.get`, and `records.search`. If you prefer the old dynamic mode, instantiate `new CortexClient()` without the generic parameter.
 
-Defina `CORTEXDB_CONNECTION` (ex.: `cortexdb://key@host:8000`) ou as variáveis `CORTEXDB_BASE_URL` + `CORTEXDB_API_KEY` antes de rodar os comandos. Se nenhum diretório for informado, o CLI procura automaticamente em `dooor/schemas`.
+Set `CORTEXDB_CONNECTION` (e.g., `cortexdb://key@host:8000`) or the `CORTEXDB_BASE_URL` + `CORTEXDB_API_KEY` variables before running commands. If no directory is specified, the CLI automatically looks in `dooor/schemas`.
 
-Para evitar repetir flags, configure `dooor/config.yaml` na raiz do projeto:
+To avoid repeating flags, configure `dooor/config.yaml` at the project root:
 
 ```yaml
 cortexdb:
@@ -345,7 +362,7 @@ schema:
   typesOut: dooor/generated/cortex-schema.ts
 ```
 
-Você pode sobrescrever com `dooor/config.local.yaml` ou apontar outro caminho via `DOOOR_CONFIG`.
+You can override with `dooor/config.local.yaml` or point to another path via `DOOOR_CONFIG`.
 
 ### Semantic Search
 

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export * from "./ai-providers/api";
 export * from "./types";
 export * from "./exceptions";
 export * from "./http/client";
+export { Collection, Field, FieldOptions, CollectionOptions, ManyToOne, OneToOne, OneToMany, ManyToMany, ManyToOneOptions, OneToOneOptions, OneToManyOptions, ManyToManyOptions, RelationOptions, loadTypeScriptSchemasSync, LoadedCollection, validateSchema, formatValidationErrors, ValidationError, ValidationResult, } from "./schema-decorators";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAG9B,cAAc,UAAU,CAAC;AAGzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,SAAS,CAAC;AAGxB,cAAc,cAAc,CAAC;AAG7B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAG9B,cAAc,UAAU,CAAC;AAGzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,SAAS,CAAC;AAGxB,cAAc,cAAc,CAAC;AAG7B,cAAc,eAAe,CAAC;AAI9B,OAAO,EACL,UAAU,EACV,KAAK,EACL,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACR,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,yBAAyB,EACzB,gBAAgB,EAEhB,cAAc,EACd,sBAAsB,EACtB,eAAe,EACf,gBAAgB,GACjB,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -15,6 +15,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.formatValidationErrors = exports.validateSchema = exports.loadTypeScriptSchemasSync = exports.ManyToMany = exports.OneToMany = exports.OneToOne = exports.ManyToOne = exports.Field = exports.Collection = void 0;
 // Main client
 __exportStar(require("./client"), exports);
 // API classes
@@ -29,4 +30,17 @@ __exportStar(require("./types"), exports);
 __exportStar(require("./exceptions"), exports);
 // HTTP Client (for advanced usage)
 __exportStar(require("./http/client"), exports);
+// Schema decorators (for TypeScript-based schema definitions)
+// Note: Collection decorator shadows the Collection interface from types
+var schema_decorators_1 = require("./schema-decorators");
+Object.defineProperty(exports, "Collection", { enumerable: true, get: function () { return schema_decorators_1.Collection; } });
+Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return schema_decorators_1.Field; } });
+Object.defineProperty(exports, "ManyToOne", { enumerable: true, get: function () { return schema_decorators_1.ManyToOne; } });
+Object.defineProperty(exports, "OneToOne", { enumerable: true, get: function () { return schema_decorators_1.OneToOne; } });
+Object.defineProperty(exports, "OneToMany", { enumerable: true, get: function () { return schema_decorators_1.OneToMany; } });
+Object.defineProperty(exports, "ManyToMany", { enumerable: true, get: function () { return schema_decorators_1.ManyToMany; } });
+Object.defineProperty(exports, "loadTypeScriptSchemasSync", { enumerable: true, get: function () { return schema_decorators_1.loadTypeScriptSchemasSync; } });
+// Validation
+Object.defineProperty(exports, "validateSchema", { enumerable: true, get: function () { return schema_decorators_1.validateSchema; } });
+Object.defineProperty(exports, "formatValidationErrors", { enumerable: true, get: function () { return schema_decorators_1.formatValidationErrors; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;;;;;;;;;;;;AAE9B,cAAc;AACd,2CAAyB;AAEzB,cAAc;AACd,oDAAkC;AAClC,gDAA8B;AAC9B,kDAAgC;AAChC,kDAAgC;AAChC,qDAAmC;AAEnC,QAAQ;AACR,0CAAwB;AAExB,aAAa;AACb,+CAA6B;AAE7B,mCAAmC;AACnC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;;;;;;;;;;;;;AAE9B,cAAc;AACd,2CAAyB;AAEzB,cAAc;AACd,oDAAkC;AAClC,gDAA8B;AAC9B,kDAAgC;AAChC,kDAAgC;AAChC,qDAAmC;AAEnC,QAAQ;AACR,0CAAwB;AAExB,aAAa;AACb,+CAA6B;AAE7B,mCAAmC;AACnC,gDAA8B;AAE9B,8DAA8D;AAC9D,yEAAyE;AACzE,yDAqB6B;AApB3B,+GAAA,UAAU,OAAA;AACV,0GAAA,KAAK,OAAA;AAGL,8GAAA,SAAS,OAAA;AACT,6GAAA,QAAQ,OAAA;AACR,8GAAA,SAAS,OAAA;AACT,+GAAA,UAAU,OAAA;AAMV,8HAAA,yBAAyB,OAAA;AAEzB,aAAa;AACb,mHAAA,cAAc,OAAA;AACd,2HAAA,sBAAsB,OAAA"}