ai-database 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,195 +1,54 @@
-import { ListResponse } from 'apis.do/types';
-export { ClientOptions, ErrorResponse, ListResponse, QueryParams } from 'apis.do/types';
-
 /**
- * Types for ai-database package
- */
-
-/**
- * Options for embedding generation
- */
-interface EmbeddingOptions {
-    /** Embedding model to use (defaults to openai:text-embedding-3-small) */
-    model?: string;
-    /** Additional options for the embedding model */
-    [key: string]: any;
-}
-/**
- * Result of embedding generation
- */
-interface EmbeddingResult {
-    /** Generated embedding vectors */
-    embedding: number[][] | null;
-    /** Model used for embedding generation */
-    model: string;
-    /** Whether the embedding generation was successful */
-    success: boolean;
-    /** Error message if embedding generation failed */
-    error?: string;
-}
-/**
- * Generic collection data type
- */
-type CollectionData = Record<string, any>;
-/**
- * Query options for database operations
- */
-interface QueryOptions {
-    /** Filter criteria */
-    where?: Record<string, any>;
-    /** Sorting options (field:direction) */
-    sort?: string | string[];
-    /** Number of results per page */
-    limit?: number;
-    /** Page number for pagination */
-    page?: number;
-    /** Fields to include in the result */
-    select?: string | string[];
-    /** Relations to populate */
-    populate?: string | string[];
-}
-/**
- * Methods available for each collection
- * @template T Document type for the collection
- */
-interface CollectionMethods<T = CollectionData> {
-    /** Find documents in the collection */
-    find: (options?: QueryOptions) => Promise<ListResponse<T>>;
-    /** Find a single document by ID */
-    findOne: (id: string) => Promise<T>;
-    /** Create a new document */
-    create: (data: Partial<T>) => Promise<T>;
-    /** Update an existing document */
-    update: (id: string, data: Partial<T>) => Promise<T>;
-    /** Delete a document */
-    delete: (id: string) => Promise<T>;
-    /** Search for documents */
-    search: (query: string, options?: QueryOptions) => Promise<ListResponse<T>>;
-}
-/**
- * Database client interface
- */
-interface DatabaseClientType {
-    /** Dynamic access to any collection */
-    [collection: string]: CollectionMethods;
-}
-/**
- * Payload instance interface defining the minimum required methods
- */
-interface PayloadInstance {
-    find?: (options: any) => Promise<any>;
-    findByID?: (options: any) => Promise<any>;
-    create?: (options: any) => Promise<any>;
-    update?: (options: any) => Promise<any>;
-    delete?: (options: any) => Promise<any>;
-    db?: any;
-    [key: string]: any;
-}
-/**
- * Configuration for REST API-based Payload client
- */
-interface RestClientConfig {
-    apiUrl: string;
-    apiKey?: string;
-    headers?: Record<string, string>;
-    fetchOptions?: RequestInit;
-}
-/**
- * Options for DB initialization
- */
-interface DBOptions {
-    baseUrl?: string;
-    apiKey?: string;
-    payload?: PayloadInstance;
-    apiUrl?: string;
-    headers?: Record<string, string>;
-    fetchOptions?: RequestInit;
-    [collection: string]: any;
-}
-/**
- * Collection handler options
- */
-interface CollectionHandlerOptions {
-    payload: PayloadInstance;
-    collectionName: string;
-}
-
-/**
- * Node.js adapter for ai-database
- */
-
-/**
- * Creates a database client for Node.js environments
- * @param options Configuration options
- * @returns Database client instance
- * @example
- * import { getPayload } from 'payload'
- * import config from '@payload-config'
- * import { createNodeClient } from 'ai-database/adapters'
+ * ai-database - Schema-first database with promise pipelining
  *
- * const payload = await getPayload({ config })
- * const db = createNodeClient({ payload })
- */
-declare const createNodeClient: (options?: DBOptions) => DatabaseClientType;
-
-/**
- * Edge runtime adapter for ai-database
- */
-
-/**
- * Creates a database client for Edge runtime environments
- * @param options Configuration options (must include apiUrl)
- * @returns Database client instance
- * @example
- * import { createEdgeClient } from 'ai-database/adapters'
+ * Supports both direct and destructured usage:
  *
- * const db = createEdgeClient({
- *   apiUrl: 'https://your-payload-api.com/api',
- *   apiKey: 'your-api-key'
+ * @example Direct usage - everything on one object
+ * ```ts
+ * const { db } = DB({
+ *   Lead: {
+ *     name: 'string',
+ *     company: 'Company.leads',
+ *   },
+ *   Company: {
+ *     name: 'string',
+ *   }
  * })
- */
-declare const createEdgeClient: (options?: DBOptions) => DatabaseClientType;
-
-/**
- * Embedding functionality for ai-database
- * Uses OpenAI API directly for generating embeddings
- */
-
-/**
- * Generate embeddings for text using OpenAI API
- * @param text Text to generate embeddings for
- * @param options Embedding options
- * @returns Promise resolving to embedding result
- */
-declare function generateEmbedding(text: string | string[], options?: EmbeddingOptions): Promise<EmbeddingResult>;
-/**
- * Calculate cosine similarity between two embeddings
- * @param embedding1 First embedding vector
- * @param embedding2 Second embedding vector
- * @returns Cosine similarity score (0-1)
- */
-declare function calculateSimilarity(embedding1: number[], embedding2: number[]): number;
-
-/**
- * ai-database
- * Direct interface to Payload CMS with database.do compatibility
- */
-
-/**
- * Creates a database client with the provided options
- * @param options Configuration options for the database client
- * @returns A proxy-based database client that provides collection-based access
- * @example
- * const db = DB({ payload }) // Node.js with Payload instance
- * const db = DB({ apiUrl: 'https://api.example.com' }) // Edge with REST API
- */
-declare const DB: (options?: DBOptions) => DatabaseClientType;
-/**
- * Default database client instance
- * Note: This will attempt to use a global Payload instance if available,
- * otherwise it will throw an error. In most cases, you should use the DB
- * function directly with explicit options.
- */
-declare const db: DatabaseClientType;
-
-export { type CollectionData, type CollectionHandlerOptions, type CollectionMethods, DB, type DBOptions, type DatabaseClientType, type EmbeddingOptions, type EmbeddingResult, type PayloadInstance, type QueryOptions, type RestClientConfig, calculateSimilarity, createEdgeClient, createNodeClient, db, DB as default, generateEmbedding };
+ *
+ * // Chain without await
+ * const leads = db.Lead.list()
+ * const qualified = await leads.filter(l => l.score > 80)
+ *
+ * // Batch relationship loading
+ * const withCompanies = await leads.map(l => ({
+ *   name: l.name,
+ *   company: l.company,  // Batch loaded!
+ * }))
+ *
+ * // Natural language queries
+ * const results = await db.Lead`who closed deals this month?`
+ * ```
+ *
+ * Provider is resolved transparently from environment (DATABASE_URL).
+ *
+ * @packageDocumentation
+ */
+export { DB } from './schema.js';
+export type { ThingFlat, ThingExpanded, DatabaseSchema, EntitySchema, FieldDefinition, PrimitiveType, ParsedSchema, ParsedEntity, ParsedField, TypedDB, EntityOperations, PipelineEntityOperations, DBProvider, ListOptions, SearchOptions, InferEntity, GenerateOptions, DBResult, Noun, NounProperty, NounRelationship, Verb, TypeMeta, EventsAPI, ActionsAPI, ArtifactsAPI, NounsAPI, VerbsAPI, DBEvent, ActorData, CreateEventOptions as DBCreateEventOptions, DBAction, CreateActionOptions as DBCreateActionOptions, DBArtifact, NLQueryResult, NLQueryFn, NLQueryGenerator, NLQueryContext, NLQueryPlan, EntityId, Thing, Relationship, QueryOptions, ThingSearchOptions, CreateOptions, UpdateOptions, RelateOptions, StoreArtifactOptions, EventQueryOptions, ActionQueryOptions, ActionStatus, ArtifactType, DBClient, DBClientExtended, } from './schema.js';
+export type { CreateEventOptions, CreateActionOptions, } from './types.js';
+export { toExpanded, toFlat, setProvider, setNLQueryGenerator, parseSchema, defineNoun, defineVerb, nounToSchema, Verbs, conjugate, pluralize, singularize, inferNoun, Type, resolveUrl, resolveShortUrl, parseUrl, } from './schema.js';
+export { MemoryProvider, createMemoryProvider, Semaphore, } from './memory-provider.js';
+export type { Event as MemoryEvent, Action as MemoryAction, Artifact as MemoryArtifact, MemoryProviderOptions, } from './memory-provider.js';
+export type { Event, Action, Artifact } from './schema.js';
+export { DBPromise, isDBPromise, getRawDBPromise, createListPromise, createEntityPromise, createSearchPromise, wrapEntityOperations, DB_PROMISE_SYMBOL, RAW_DB_PROMISE_SYMBOL, } from './ai-promise-db.js';
+export type { DBPromiseOptions, ForEachOptions, ForEachResult, ForEachProgress, ForEachErrorAction, } from './ai-promise-db.js';
+export type { Subject, SubjectType, Resource, ResourceRef, ResourceType, Permission, Role, RoleLevel, Assignment, AssignmentInput, AuthzCheckRequest, AuthzCheckResult, AuthzBatchCheckRequest, AuthzBatchCheckResult, ResourceHierarchy, AuthorizedNoun, BusinessRole, AuthorizationEngine, } from './authorization.js';
+export { StandardHierarchies, StandardPermissions, CRUDPermissions, createStandardRoles, verbPermission, nounPermissions, matchesPermission, parseSubject, formatSubject, parseResource, formatResource, subjectMatches, resourceMatches, authorizeNoun, linkBusinessRole, InMemoryAuthorizationEngine, RoleNoun, AssignmentNoun, PermissionNoun, AuthorizationNouns, } from './authorization.js';
+export type { Document, DocWithScore, DocListOptions, DocListResult, DocSearchOptions, DocSearchResult, DocGetOptions, DocSetOptions, DocSetResult, DocDeleteOptions, DocDeleteResult, DocumentDatabase, DocumentDatabaseConfig, CreateDocumentDatabase, DocumentDatabaseWithViews, ViewEntityItem, ViewComponent, ViewDocument, ViewContext, ViewRenderResult, ViewRelationshipMutation, ViewSyncResult, ViewManager, } from './types.js';
+export { DurablePromise, isDurablePromise, durable, DURABLE_PROMISE_SYMBOL, getCurrentContext, withContext, setDefaultContext, getBatchScheduler, setBatchScheduler, } from './durable-promise.js';
+export type { ExecutionPriority, DurablePromiseOptions, DurablePromiseResult, BatchScheduler, } from './durable-promise.js';
+export { ExecutionQueue, createExecutionQueue, getDefaultQueue, setDefaultQueue, } from './execution-queue.js';
+export type { ExecutionQueueOptions, QueueStats, BatchSubmission, BatchProvider, BatchRequest, BatchStatus, BatchResult, } from './execution-queue.js';
+export { ClickHouseDurableProvider, createClickHouseDurableProvider, } from './durable-clickhouse.js';
+export type { ClickHouseExecutor, ClickHouseDurableConfig, } from './durable-clickhouse.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAA;AAChC,YAAY,EAEV,SAAS,EACT,aAAa,EAEb,cAAc,EACd,YAAY,EACZ,eAAe,EACf,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,OAAO,EACP,gBAAgB,EAChB,wBAAwB,EACxB,UAAU,EACV,WAAW,EACX,aAAa,EACb,WAAW,EACX,eAAe,EAEf,QAAQ,EAER,IAAI,EACJ,YAAY,EACZ,gBAAgB,EAChB,IAAI,EACJ,QAAQ,EAER,SAAS,EACT,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,QAAQ,EAER,OAAO,EACP,SAAS,EACT,kBAAkB,IAAI,oBAAoB,EAE1C,QAAQ,EACR,mBAAmB,IAAI,qBAAqB,EAE5C,UAAU,EAEV,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,WAAW,EAEX,QAAQ,EACR,KAAK,EACL,YAAY,EAEZ,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,aAAa,EAEb,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,YAAY,EAEZ,QAAQ,EACR,gBAAgB,GACjB,MAAM,aAAa,CAAA;AAIpB,YAAY,EACV,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AAEnB,OAAO,EAEL,UAAU,EACV,MAAM,EAEN,WAAW,EACX,mBAAmB,EAEnB,WAAW,EAEX,UAAU,EACV,UAAU,EACV,YAAY,EACZ,KAAK,EAEL,SAAS,EACT,SAAS,EACT,WAAW,EACX,SAAS,EACT,IAAI,EAEJ,UAAU,EACV,eAAe,EACf,QAAQ,GACT,MAAM,aAAa,CAAA;AAEpB,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,sBAAsB,CAAA;AAE7B,YAAY,EAGV,KAAK,IAAI,WAAW,EACpB,MAAM,IAAI,YAAY,EACtB,QAAQ,IAAI,cAAc,EAC1B,qBAAqB,GACtB,MAAM,sBAAsB,CAAA;AAG7B,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAG1D,OAAO,EACL,SAAS,EACT,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,oBAAoB,CAAA;AAE3B,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,eAAe,EACf,kBAAkB,GACnB,MAAM,oBAAoB,CAAA;AAG3B,YAAY,EAEV,OAAO,EACP,WAAW,EACX,QAAQ,EACR,WAAW,EACX,YAAY,EAGZ,UAAU,EACV,IAAI,EACJ,SAAS,EAGT,UAAU,EACV,eAAe,EAGf,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EAGrB,iBAAiB,EAGjB,cAAc,EAGd,YAAY,EAGZ,mBAAmB,GACpB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAEL,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EAGnB,cAAc,EACd,eAAe,EACf,iBAAiB,EAGjB,YAAY,EACZ,aAAa,EACb,aAAa,EACb,cAAc,EACd,cAAc,EACd,eAAe,EAGf,aAAa,EACb,gBAAgB,EAGhB,2BAA2B,EAG3B,QAAQ,EACR,cAAc,EACd,cAAc,EACd,kBAAkB,GACnB,MAAM,oBAAoB,CAAA;AAI3B,YAAY,EAEV,QAAQ,EACR,YAAY,EAEZ,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,eAAe,EAEf,aAAa,EACb,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,eAAe,EAEf,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,yBAAyB,EAEzB,cAAc,EACd,aAAa,EACb,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,wBAAwB,EACxB,cAAc,EACd,WAAW,GACZ,MAAM,YAAY,CAAA;AAOnB,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,sBAAsB,EAEtB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EAEjB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,sBAAsB,CAAA;AAE7B,YAAY,EACV,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,GACf,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,eAAe,GAChB,MAAM,sBAAsB,CAAA;AAE7B,YAAY,EACV,qBAAqB,EACrB,UAAU,EACV,eAAe,EACf,aAAa,EACb,YAAY,EACZ,WAAW,EACX,WAAW,GACZ,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EACL,yBAAyB,EACzB,+BAA+B,GAChC,MAAM,yBAAyB,CAAA;AAEhC,YAAY,EACV,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,yBAAyB,CAAA"}