@openbkn/bkn-sdk 0.1.0 → 0.1.1-alpha.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as zod from 'zod';
 import { z } from 'zod';
 
 /** Shared types for the SDK surface. No runtime, no side effects. */
@@ -328,6 +329,9 @@ interface CreateFromCatalogOptions {
     tables?: string[];
     pkMap?: Record<string, string>;
     build?: boolean;
+    /** Per-table resource columns to vectorize (sets the build task's embedding_fields). */
+    embeddingFields?: Record<string, string[]>;
+    embeddingModel?: string;
     noRollback?: boolean;
     /** Pre-fetched row samples per table (e.g. from a CSV import) for PK detection. */
     sampleRows?: Record<string, Array<Record<string, string | null>>>;
@@ -342,6 +346,8 @@ interface CreateFromCsvOptions {
     tables?: string[];
     pkMap?: Record<string, string>;
     build?: boolean;
+    embeddingFields?: Record<string, string[]>;
+    embeddingModel?: string;
     noRollback?: boolean;
     onProgress?: (msg: string) => void;
 }
@@ -407,9 +413,15 @@ declare function kn(ctx: RequestContext): {
     bknResources: () => Promise<unknown>;
     createFromCatalog: (opts: CreateFromCatalogOptions) => Promise<unknown>;
     createFromCsv: (opts: CreateFromCsvOptions) => Promise<unknown>;
-    /** Pack a local BKN directory and upload it as a knowledge network. */
+    /**
+     * Pack a local BKN directory and upload it as a knowledge network. With
+     * `build`, also submit one Vega BuildTask per object type that declares a
+     * `vector` index — the platform does not auto-build these on import.
+     */
     push: (dir: string, opts?: {
         branch?: string;
+        build?: boolean;
+        embeddingModel?: string;
     }) => Promise<unknown>;
     /** Download a knowledge network and extract it into a local directory. */
     pull: (knId: string, dir: string, opts?: {
@@ -739,35 +751,65 @@ declare const CreateBuildTaskRequest: z.ZodObject<{
 type CreateBuildTaskRequest = z.infer<typeof CreateBuildTaskRequest>;
 declare const BuildTask: z.ZodObject<{
     id: z.ZodString;
-    resource_id: z.ZodString;
-    mode: z.ZodEnum<["batch", "streaming"]>;
+    resource_id: z.ZodOptional<z.ZodString>;
+    mode: z.ZodOptional<z.ZodEnum<["batch", "streaming"]>>;
+    status: z.ZodOptional<z.ZodString>;
     state: z.ZodOptional<z.ZodString>;
+    total_count: z.ZodOptional<z.ZodNumber>;
     synced_count: z.ZodOptional<z.ZodNumber>;
     vectorized_count: z.ZodOptional<z.ZodNumber>;
-}, "strip", z.ZodTypeAny, {
-    mode: "batch" | "streaming";
-    id: string;
-    resource_id: string;
-    state?: string | undefined;
-    synced_count?: number | undefined;
-    vectorized_count?: number | undefined;
-}, {
-    mode: "batch" | "streaming";
-    id: string;
-    resource_id: string;
-    state?: string | undefined;
-    synced_count?: number | undefined;
-    vectorized_count?: number | undefined;
-}>;
+    embedding_fields: z.ZodOptional<z.ZodString>;
+    build_key_fields: z.ZodOptional<z.ZodString>;
+    embedding_model: z.ZodOptional<z.ZodString>;
+    model_dimensions: z.ZodOptional<z.ZodNumber>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    id: z.ZodString;
+    resource_id: z.ZodOptional<z.ZodString>;
+    mode: z.ZodOptional<z.ZodEnum<["batch", "streaming"]>>;
+    status: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+    total_count: z.ZodOptional<z.ZodNumber>;
+    synced_count: z.ZodOptional<z.ZodNumber>;
+    vectorized_count: z.ZodOptional<z.ZodNumber>;
+    embedding_fields: z.ZodOptional<z.ZodString>;
+    build_key_fields: z.ZodOptional<z.ZodString>;
+    embedding_model: z.ZodOptional<z.ZodString>;
+    model_dimensions: z.ZodOptional<z.ZodNumber>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    id: z.ZodString;
+    resource_id: z.ZodOptional<z.ZodString>;
+    mode: z.ZodOptional<z.ZodEnum<["batch", "streaming"]>>;
+    status: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+    total_count: z.ZodOptional<z.ZodNumber>;
+    synced_count: z.ZodOptional<z.ZodNumber>;
+    vectorized_count: z.ZodOptional<z.ZodNumber>;
+    embedding_fields: z.ZodOptional<z.ZodString>;
+    build_key_fields: z.ZodOptional<z.ZodString>;
+    embedding_model: z.ZodOptional<z.ZodString>;
+    model_dimensions: z.ZodOptional<z.ZodNumber>;
+}, z.ZodTypeAny, "passthrough">>;
 type BuildTask = z.infer<typeof BuildTask>;
 interface ListCatalogsOptions {
     limit?: number;
     offset?: number;
 }
+/** POST /catalogs body. `connector_config` shape varies by connector (raw passthrough). */
+interface CreateCatalogRequest {
+    name: string;
+    connectorType: string;
+    connectorConfig: unknown;
+    tags?: string[];
+    description?: string;
+    enabled?: boolean;
+}
 
 declare function vega(ctx: RequestContext): {
     catalogs: (opts?: ListCatalogsOptions) => Promise<unknown>;
     getCatalog: (id: string) => Promise<unknown>;
+    createCatalog: (req: CreateCatalogRequest) => Promise<unknown>;
+    enableCatalog: (id: string) => Promise<unknown>;
+    discoverCatalog: (id: string, wait?: boolean) => Promise<unknown>;
     catalogResources: (id: string, category?: string) => Promise<unknown>;
     catalogHealth: (ids: string[]) => Promise<unknown>;
     connectorTypes: () => Promise<unknown>;
@@ -778,14 +820,20 @@ declare function vega(ctx: RequestContext): {
         timeoutMs?: number;
         intervalMs?: number;
     }) => Promise<BuildTask>;
-    buildStatus: (taskId: string) => Promise<{
-        mode: "batch" | "streaming";
-        id: string;
-        resource_id: string;
-        state?: string | undefined;
-        synced_count?: number | undefined;
-        vectorized_count?: number | undefined;
-    }>;
+    buildStatus: (taskId: string) => Promise<zod.objectOutputType<{
+        id: zod.ZodString;
+        resource_id: zod.ZodOptional<zod.ZodString>;
+        mode: zod.ZodOptional<zod.ZodEnum<["batch", "streaming"]>>;
+        status: zod.ZodOptional<zod.ZodString>;
+        state: zod.ZodOptional<zod.ZodString>;
+        total_count: zod.ZodOptional<zod.ZodNumber>;
+        synced_count: zod.ZodOptional<zod.ZodNumber>;
+        vectorized_count: zod.ZodOptional<zod.ZodNumber>;
+        embedding_fields: zod.ZodOptional<zod.ZodString>;
+        build_key_fields: zod.ZodOptional<zod.ZodString>;
+        embedding_model: zod.ZodOptional<zod.ZodString>;
+        model_dimensions: zod.ZodOptional<zod.ZodNumber>;
+    }, zod.ZodTypeAny, "passthrough">>;
 };
 
 interface BknClient {

package/dist/index.js

@@ -19,7 +19,7 @@ import {
   toolboxes,
   trace,
   vega
-} from "./chunk-4NXAIG4G.js";
+} from "./chunk-DXA44XWY.js";
 export {
   DEFAULT_BUSINESS_DOMAIN,
   DEFAULT_LIST_LIMIT,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openbkn/bkn-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1-alpha.0",
   "description": "Unified TypeScript SDK + CLI for the BKN (Business Knowledge Network) platform.",
   "type": "module",
   "license": "Apache-2.0",