@z3rno/sdk 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,396 @@
+import { z } from 'zod';
+
+/**
+ * Zod schemas and inferred TypeScript types for the Z3rno API.
+ */
+
+declare const MemoryType: z.ZodEnum<["working", "episodic", "semantic", "procedural"]>;
+type MemoryType = z.infer<typeof MemoryType>;
+declare const RelationshipType: z.ZodEnum<["derived_from", "contradicts", "supports", "supersedes", "related_to", "caused_by"]>;
+type RelationshipType = z.infer<typeof RelationshipType>;
+declare const StoreMemoryRequest: z.ZodObject<{
+    agentId: z.ZodString;
+    content: z.ZodString;
+    memoryType: z.ZodDefault<z.ZodEnum<["working", "episodic", "semantic", "procedural"]>>;
+    userId: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    relationships: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        targetMemoryId: z.ZodString;
+        relationshipType: z.ZodEnum<["derived_from", "contradicts", "supports", "supersedes", "related_to", "caused_by"]>;
+        weight: z.ZodDefault<z.ZodNumber>;
+        metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        metadata: Record<string, unknown>;
+        targetMemoryId: string;
+        relationshipType: "derived_from" | "contradicts" | "supports" | "supersedes" | "related_to" | "caused_by";
+        weight: number;
+    }, {
+        targetMemoryId: string;
+        relationshipType: "derived_from" | "contradicts" | "supports" | "supersedes" | "related_to" | "caused_by";
+        metadata?: Record<string, unknown> | undefined;
+        weight?: number | undefined;
+    }>, "many">>;
+    ttlSeconds: z.ZodOptional<z.ZodNumber>;
+    importance: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    agentId: string;
+    content: string;
+    memoryType: "working" | "episodic" | "semantic" | "procedural";
+    metadata: Record<string, unknown>;
+    relationships: {
+        metadata: Record<string, unknown>;
+        targetMemoryId: string;
+        relationshipType: "derived_from" | "contradicts" | "supports" | "supersedes" | "related_to" | "caused_by";
+        weight: number;
+    }[];
+    userId?: string | undefined;
+    ttlSeconds?: number | undefined;
+    importance?: number | undefined;
+}, {
+    agentId: string;
+    content: string;
+    memoryType?: "working" | "episodic" | "semantic" | "procedural" | undefined;
+    userId?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    relationships?: {
+        targetMemoryId: string;
+        relationshipType: "derived_from" | "contradicts" | "supports" | "supersedes" | "related_to" | "caused_by";
+        metadata?: Record<string, unknown> | undefined;
+        weight?: number | undefined;
+    }[] | undefined;
+    ttlSeconds?: number | undefined;
+    importance?: number | undefined;
+}>;
+type StoreMemoryRequest = z.infer<typeof StoreMemoryRequest>;
+declare const MemoryResponse: z.ZodObject<{
+    id: z.ZodString;
+    agent_id: z.ZodString;
+    content: z.ZodString;
+    memory_type: z.ZodString;
+    importance_score: z.ZodNumber;
+    recall_count: z.ZodNumber;
+    embedding_model: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    created_at: z.ZodString;
+    metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    content: string;
+    metadata: Record<string, unknown>;
+    id: string;
+    agent_id: string;
+    memory_type: string;
+    importance_score: number;
+    recall_count: number;
+    created_at: string;
+    embedding_model?: string | null | undefined;
+}, {
+    content: string;
+    id: string;
+    agent_id: string;
+    memory_type: string;
+    importance_score: number;
+    recall_count: number;
+    created_at: string;
+    metadata?: Record<string, unknown> | undefined;
+    embedding_model?: string | null | undefined;
+}>;
+type MemoryResponse = z.infer<typeof MemoryResponse>;
+declare const RecallResultItem: z.ZodObject<{
+    memory_id: z.ZodString;
+    content: z.ZodString;
+    summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    memory_type: z.ZodString;
+    similarity_score: z.ZodNumber;
+    importance_score: z.ZodNumber;
+    relevance_score: z.ZodNumber;
+    recall_count: z.ZodNumber;
+    created_at: z.ZodString;
+    metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    content: string;
+    metadata: Record<string, unknown>;
+    memory_type: string;
+    importance_score: number;
+    recall_count: number;
+    created_at: string;
+    memory_id: string;
+    similarity_score: number;
+    relevance_score: number;
+    summary?: string | null | undefined;
+}, {
+    content: string;
+    memory_type: string;
+    importance_score: number;
+    recall_count: number;
+    created_at: string;
+    memory_id: string;
+    similarity_score: number;
+    relevance_score: number;
+    metadata?: Record<string, unknown> | undefined;
+    summary?: string | null | undefined;
+}>;
+type RecallResultItem = z.infer<typeof RecallResultItem>;
+declare const RecallResponse: z.ZodObject<{
+    results: z.ZodArray<z.ZodObject<{
+        memory_id: z.ZodString;
+        content: z.ZodString;
+        summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        memory_type: z.ZodString;
+        similarity_score: z.ZodNumber;
+        importance_score: z.ZodNumber;
+        relevance_score: z.ZodNumber;
+        recall_count: z.ZodNumber;
+        created_at: z.ZodString;
+        metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        content: string;
+        metadata: Record<string, unknown>;
+        memory_type: string;
+        importance_score: number;
+        recall_count: number;
+        created_at: string;
+        memory_id: string;
+        similarity_score: number;
+        relevance_score: number;
+        summary?: string | null | undefined;
+    }, {
+        content: string;
+        memory_type: string;
+        importance_score: number;
+        recall_count: number;
+        created_at: string;
+        memory_id: string;
+        similarity_score: number;
+        relevance_score: number;
+        metadata?: Record<string, unknown> | undefined;
+        summary?: string | null | undefined;
+    }>, "many">;
+    total: z.ZodNumber;
+    query: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    results: {
+        content: string;
+        metadata: Record<string, unknown>;
+        memory_type: string;
+        importance_score: number;
+        recall_count: number;
+        created_at: string;
+        memory_id: string;
+        similarity_score: number;
+        relevance_score: number;
+        summary?: string | null | undefined;
+    }[];
+    total: number;
+    query?: string | null | undefined;
+}, {
+    results: {
+        content: string;
+        memory_type: string;
+        importance_score: number;
+        recall_count: number;
+        created_at: string;
+        memory_id: string;
+        similarity_score: number;
+        relevance_score: number;
+        metadata?: Record<string, unknown> | undefined;
+        summary?: string | null | undefined;
+    }[];
+    total: number;
+    query?: string | null | undefined;
+}>;
+type RecallResponse = z.infer<typeof RecallResponse>;
+declare const ForgetResponse: z.ZodObject<{
+    deleted_count: z.ZodNumber;
+    hard_deleted: z.ZodBoolean;
+    cascade_count: z.ZodNumber;
+    memory_ids: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    deleted_count: number;
+    hard_deleted: boolean;
+    cascade_count: number;
+    memory_ids: string[];
+}, {
+    deleted_count: number;
+    hard_deleted: boolean;
+    cascade_count: number;
+    memory_ids: string[];
+}>;
+type ForgetResponse = z.infer<typeof ForgetResponse>;
+declare const AuditEntry: z.ZodObject<{
+    id: z.ZodNumber;
+    agent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    operation: z.ZodString;
+    memory_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    memory_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    details: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    ip_address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    created_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    created_at: string;
+    operation: string;
+    details: Record<string, unknown>;
+    agent_id?: string | null | undefined;
+    memory_type?: string | null | undefined;
+    memory_id?: string | null | undefined;
+    user_id?: string | null | undefined;
+    ip_address?: string | null | undefined;
+}, {
+    id: number;
+    created_at: string;
+    operation: string;
+    agent_id?: string | null | undefined;
+    memory_type?: string | null | undefined;
+    memory_id?: string | null | undefined;
+    user_id?: string | null | undefined;
+    details?: Record<string, unknown> | undefined;
+    ip_address?: string | null | undefined;
+}>;
+type AuditEntry = z.infer<typeof AuditEntry>;
+declare const AuditPageResponse: z.ZodObject<{
+    entries: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        agent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        operation: z.ZodString;
+        memory_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        memory_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        details: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        ip_address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        created_at: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+        created_at: string;
+        operation: string;
+        details: Record<string, unknown>;
+        agent_id?: string | null | undefined;
+        memory_type?: string | null | undefined;
+        memory_id?: string | null | undefined;
+        user_id?: string | null | undefined;
+        ip_address?: string | null | undefined;
+    }, {
+        id: number;
+        created_at: string;
+        operation: string;
+        agent_id?: string | null | undefined;
+        memory_type?: string | null | undefined;
+        memory_id?: string | null | undefined;
+        user_id?: string | null | undefined;
+        details?: Record<string, unknown> | undefined;
+        ip_address?: string | null | undefined;
+    }>, "many">;
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    page_size: z.ZodNumber;
+    has_next: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    entries: {
+        id: number;
+        created_at: string;
+        operation: string;
+        details: Record<string, unknown>;
+        agent_id?: string | null | undefined;
+        memory_type?: string | null | undefined;
+        memory_id?: string | null | undefined;
+        user_id?: string | null | undefined;
+        ip_address?: string | null | undefined;
+    }[];
+    total: number;
+    page: number;
+    page_size: number;
+    has_next: boolean;
+}, {
+    entries: {
+        id: number;
+        created_at: string;
+        operation: string;
+        agent_id?: string | null | undefined;
+        memory_type?: string | null | undefined;
+        memory_id?: string | null | undefined;
+        user_id?: string | null | undefined;
+        details?: Record<string, unknown> | undefined;
+        ip_address?: string | null | undefined;
+    }[];
+    total: number;
+    page: number;
+    page_size: number;
+    has_next: boolean;
+}>;
+type AuditPageResponse = z.infer<typeof AuditPageResponse>;
+
+/**
+ * Z3rno TypeScript SDK client.
+ *
+ * Thin fetch wrapper — no database drivers, no embedding providers.
+ *
+ * @example
+ * ```ts
+ * const client = new Z3rnoClient({ baseUrl: "http://localhost:8000", apiKey: "z3rno_sk_..." });
+ * const memory = await client.store({ agentId: "agent-1", content: "User prefers dark mode" });
+ * const results = await client.recall({ agentId: "agent-1", query: "user preferences" });
+ * await client.forget({ agentId: "agent-1", memoryId: memory.id });
+ * ```
+ */
+
+interface Z3rnoClientConfig {
+    baseUrl: string;
+    apiKey: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+declare class Z3rnoClient {
+    private baseUrl;
+    private apiKey;
+    private timeout;
+    constructor(config: Z3rnoClientConfig);
+    store(request: StoreMemoryRequest): Promise<MemoryResponse>;
+    recall(params: {
+        agentId: string;
+        query?: string;
+        memoryType?: string;
+        filters?: Record<string, unknown>;
+        topK?: number;
+        similarityThreshold?: number;
+    }): Promise<RecallResponse>;
+    forget(params: {
+        agentId: string;
+        memoryId?: string;
+        memoryIds?: string[];
+        hardDelete?: boolean;
+        cascade?: boolean;
+        reason?: string;
+    }): Promise<ForgetResponse>;
+    audit(params?: {
+        agentId?: string;
+        page?: number;
+        pageSize?: number;
+    }): Promise<AuditPageResponse>;
+    private request;
+    private handleResponse;
+}
+
+/**
+ * Z3rno SDK error hierarchy.
+ */
+declare class Z3rnoError extends Error {
+    statusCode?: number;
+    constructor(message: string, statusCode?: number);
+}
+declare class AuthenticationError extends Z3rnoError {
+    constructor(message: string);
+}
+declare class RateLimitError extends Z3rnoError {
+    retryAfter: number;
+    constructor(message: string, retryAfter?: number);
+}
+declare class ValidationError extends Z3rnoError {
+    constructor(message: string, statusCode?: number);
+}
+declare class NotFoundError extends Z3rnoError {
+    constructor(message: string);
+}
+declare class ServerError extends Z3rnoError {
+    constructor(message: string, statusCode?: number);
+}
+
+export { AuditEntry, AuditPageResponse, AuthenticationError, ForgetResponse, MemoryResponse, MemoryType, NotFoundError, RateLimitError, RecallResponse, RecallResultItem, RelationshipType, ServerError, StoreMemoryRequest, ValidationError, Z3rnoClient, type Z3rnoClientConfig, Z3rnoError };