@native-knowledge/knowledge-sdk 0.0.0-stage → 0.1.0-rc.2

package/dist/internal/serving-contracts/body-search.d.ts

@@ -0,0 +1,231 @@
+/** Explicit raw-material body search; existing descriptive search contracts stay frozen. */
+import { z } from 'zod';
+export declare const agentBodySearchHeader = "x-knowledge-agent-capabilities";
+export declare const agentBodySearchFeature = "body-search-v1";
+export declare const bodyCitationSchema: z.ZodObject<{
+    ref: z.ZodString;
+    contentHash: z.ZodString;
+    jsonPointer: z.ZodNullable<z.ZodString>;
+    startUtf16: z.ZodNumber;
+    endUtf16: z.ZodNumber;
+    quote: z.ZodString;
+}, z.core.$strict>;
+export declare const bodySearchToolSchemas: {
+    readonly knowledge_resource_search_body: z.ZodObject<{
+        query: z.ZodString;
+        after: z.ZodOptional<z.ZodString>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        resourceType: z.ZodOptional<z.ZodString>;
+        projectRef: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly knowledge_resource_read_passage: z.ZodObject<{
+        citation: z.ZodObject<{
+            ref: z.ZodString;
+            contentHash: z.ZodString;
+            jsonPointer: z.ZodNullable<z.ZodString>;
+            startUtf16: z.ZodNumber;
+            endUtf16: z.ZodNumber;
+            quote: z.ZodString;
+        }, z.core.$strict>;
+        projectRef: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+};
+export declare const bodySearchDataSchemas: {
+    readonly knowledge_resource_search_body: z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            item: z.ZodObject<{
+                ref: z.ZodString;
+                ownerTenantId: z.ZodString;
+                resourceType: z.ZodString;
+                origin: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    type: z.ZodLiteral<"TENANT_AUTHOR">;
+                    actor: z.ZodObject<{
+                        tenantId: z.ZodString;
+                        userId: z.ZodString;
+                        agentId: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+                    }, z.core.$strict>;
+                    submittedAt: z.ZodISODateTime;
+                }, z.core.$strict>, z.ZodObject<{
+                    type: z.ZodLiteral<"TENANT_SOURCE">;
+                    sourceId: z.ZodString;
+                    sourceRef: z.ZodString;
+                    sourceRevisionRef: z.ZodString;
+                    collector: z.ZodObject<{
+                        collectorId: z.ZodString;
+                        version: z.ZodString;
+                    }, z.core.$strict>;
+                    runtimeNodeId: z.ZodString;
+                    observedAt: z.ZodISODateTime;
+                }, z.core.$strict>], "type">, z.ZodObject<{
+                    type: z.ZodLiteral<"LEGACY_PROJECT">;
+                    projectKey: z.ZodString;
+                    projectRef: z.ZodString;
+                }, z.core.$strict>]>;
+                identityHash: z.ZodString;
+                identityKind: z.ZodEnum<{
+                    CAS_BYTES: "CAS_BYTES";
+                    REFERENCE_RECORD_DIGEST: "REFERENCE_RECORD_DIGEST";
+                }>;
+                kind: z.ZodString;
+                classification: z.ZodEnum<{
+                    PUBLIC: "PUBLIC";
+                    PUBLIC_METADATA: "PUBLIC_METADATA";
+                    TENANT: "TENANT";
+                    INTERNAL: "INTERNAL";
+                    FDE_INTERNAL: "FDE_INTERNAL";
+                    ACCESS_CONTROLLED: "ACCESS_CONTROLLED";
+                    UNKNOWN: "UNKNOWN";
+                }>;
+                mediaType: z.ZodString;
+                title: z.ZodString;
+                summary: z.ZodString;
+                decision: z.ZodObject<{
+                    schemaVersion: z.ZodLiteral<1>;
+                    action: z.ZodEnum<{
+                        ALLOW: "ALLOW";
+                        DENY: "DENY";
+                    }>;
+                    reasonCodes: z.ZodArray<z.ZodEnum<{
+                        UNAVAILABLE: "UNAVAILABLE";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONTENT_ACCESS_DENIED: "CONTENT_ACCESS_DENIED";
+                        INTEGRITY_MISMATCH: "INTEGRITY_MISMATCH";
+                        UNSUPPORTED_RESOURCE: "UNSUPPORTED_RESOURCE";
+                    }>>;
+                    assessedAt: z.ZodISODateTime;
+                }, z.core.$strict>;
+            }, z.core.$strict>;
+            citation: z.ZodObject<{
+                ref: z.ZodString;
+                contentHash: z.ZodString;
+                jsonPointer: z.ZodNullable<z.ZodString>;
+                startUtf16: z.ZodNumber;
+                endUtf16: z.ZodNumber;
+                quote: z.ZodString;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+        nextAfter: z.ZodNullable<z.ZodString>;
+        coverage: z.ZodLiteral<"INDEXED_NATIVE_TEXT_PASSAGES_ONLY">;
+        completeness: z.ZodLiteral<"NOT_ASSESSED">;
+        semantics: z.ZodLiteral<"RAW_MATERIAL_NOT_GOVERNANCE_APPROVAL">;
+    }, z.core.$strict>;
+    readonly knowledge_resource_read_passage: z.ZodObject<{
+        citation: z.ZodObject<{
+            ref: z.ZodString;
+            contentHash: z.ZodString;
+            jsonPointer: z.ZodNullable<z.ZodString>;
+            startUtf16: z.ZodNumber;
+            endUtf16: z.ZodNumber;
+            quote: z.ZodString;
+        }, z.core.$strict>;
+        verified: z.ZodLiteral<true>;
+    }, z.core.$strict>;
+};
+export type BodySearchToolName = keyof typeof bodySearchToolSchemas;
+export type BodyCitation = z.infer<typeof bodyCitationSchema>;
+export declare function bodySearchEnvelopeSchema(name: BodySearchToolName): z.ZodObject<{
+    schemaVersion: z.ZodLiteral<2>;
+    context: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"TENANT">;
+        tenantId: z.ZodString;
+        tenantRef: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"PROJECT">;
+        tenantId: z.ZodString;
+        projectKey: z.ZodString;
+        projectRef: z.ZodString;
+    }, z.core.$strict>], "type">;
+    policy: z.ZodEnum<{
+        LEGACY_PROJECT: "LEGACY_PROJECT";
+        TENANT_NATIVE: "TENANT_NATIVE";
+        TENANT_PROJECT_SCOPE: "TENANT_PROJECT_SCOPE";
+    }>;
+    data: z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            item: z.ZodObject<{
+                ref: z.ZodString;
+                ownerTenantId: z.ZodString;
+                resourceType: z.ZodString;
+                origin: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    type: z.ZodLiteral<"TENANT_AUTHOR">;
+                    actor: z.ZodObject<{
+                        tenantId: z.ZodString;
+                        userId: z.ZodString;
+                        agentId: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+                    }, z.core.$strict>;
+                    submittedAt: z.ZodISODateTime;
+                }, z.core.$strict>, z.ZodObject<{
+                    type: z.ZodLiteral<"TENANT_SOURCE">;
+                    sourceId: z.ZodString;
+                    sourceRef: z.ZodString;
+                    sourceRevisionRef: z.ZodString;
+                    collector: z.ZodObject<{
+                        collectorId: z.ZodString;
+                        version: z.ZodString;
+                    }, z.core.$strict>;
+                    runtimeNodeId: z.ZodString;
+                    observedAt: z.ZodISODateTime;
+                }, z.core.$strict>], "type">, z.ZodObject<{
+                    type: z.ZodLiteral<"LEGACY_PROJECT">;
+                    projectKey: z.ZodString;
+                    projectRef: z.ZodString;
+                }, z.core.$strict>]>;
+                identityHash: z.ZodString;
+                identityKind: z.ZodEnum<{
+                    CAS_BYTES: "CAS_BYTES";
+                    REFERENCE_RECORD_DIGEST: "REFERENCE_RECORD_DIGEST";
+                }>;
+                kind: z.ZodString;
+                classification: z.ZodEnum<{
+                    PUBLIC: "PUBLIC";
+                    PUBLIC_METADATA: "PUBLIC_METADATA";
+                    TENANT: "TENANT";
+                    INTERNAL: "INTERNAL";
+                    FDE_INTERNAL: "FDE_INTERNAL";
+                    ACCESS_CONTROLLED: "ACCESS_CONTROLLED";
+                    UNKNOWN: "UNKNOWN";
+                }>;
+                mediaType: z.ZodString;
+                title: z.ZodString;
+                summary: z.ZodString;
+                decision: z.ZodObject<{
+                    schemaVersion: z.ZodLiteral<1>;
+                    action: z.ZodEnum<{
+                        ALLOW: "ALLOW";
+                        DENY: "DENY";
+                    }>;
+                    reasonCodes: z.ZodArray<z.ZodEnum<{
+                        UNAVAILABLE: "UNAVAILABLE";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONTENT_ACCESS_DENIED: "CONTENT_ACCESS_DENIED";
+                        INTEGRITY_MISMATCH: "INTEGRITY_MISMATCH";
+                        UNSUPPORTED_RESOURCE: "UNSUPPORTED_RESOURCE";
+                    }>>;
+                    assessedAt: z.ZodISODateTime;
+                }, z.core.$strict>;
+            }, z.core.$strict>;
+            citation: z.ZodObject<{
+                ref: z.ZodString;
+                contentHash: z.ZodString;
+                jsonPointer: z.ZodNullable<z.ZodString>;
+                startUtf16: z.ZodNumber;
+                endUtf16: z.ZodNumber;
+                quote: z.ZodString;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+        nextAfter: z.ZodNullable<z.ZodString>;
+        coverage: z.ZodLiteral<"INDEXED_NATIVE_TEXT_PASSAGES_ONLY">;
+        completeness: z.ZodLiteral<"NOT_ASSESSED">;
+        semantics: z.ZodLiteral<"RAW_MATERIAL_NOT_GOVERNANCE_APPROVAL">;
+    }, z.core.$strict> | z.ZodObject<{
+        citation: z.ZodObject<{
+            ref: z.ZodString;
+            contentHash: z.ZodString;
+            jsonPointer: z.ZodNullable<z.ZodString>;
+            startUtf16: z.ZodNumber;
+            endUtf16: z.ZodNumber;
+            quote: z.ZodString;
+        }, z.core.$strict>;
+        verified: z.ZodLiteral<true>;
+    }, z.core.$strict>;
+}, z.core.$strict>;

package/dist/internal/serving-contracts/body-search.js

@@ -0,0 +1,16 @@
+/** Explicit raw-material body search; existing descriptive search contracts stay frozen. */
+import { z } from 'zod';
+import { resourceDirectoryItemSchema, resourceEnvelopeSchema, tenantResourceRefSchema, sha256Schema, stableUriSchema } from '../contracts/index.js';
+export const agentBodySearchHeader = 'x-knowledge-agent-capabilities';
+export const agentBodySearchFeature = 'body-search-v1';
+const context = { projectRef: stableUriSchema.optional() };
+export const bodyCitationSchema = z.object({ ref: tenantResourceRefSchema, contentHash: sha256Schema, jsonPointer: z.string().max(2048).nullable(), startUtf16: z.number().int().nonnegative().safe(), endUtf16: z.number().int().positive().safe(), quote: z.string().min(1).max(1200) }).strict().refine(v => v.endUtf16 - v.startUtf16 === v.quote.length);
+export const bodySearchToolSchemas = {
+    knowledge_resource_search_body: z.object({ ...context, query: z.string().trim().min(2).max(200), after: z.string().min(1).max(4096).optional(), limit: z.number().int().min(1).max(20).default(5), resourceType: z.string().regex(/^[a-z][a-z0-9._-]{0,63}$/).max(64).optional() }).strict(),
+    knowledge_resource_read_passage: z.object({ ...context, citation: bodyCitationSchema }).strict(),
+};
+export const bodySearchDataSchemas = {
+    knowledge_resource_search_body: z.object({ items: z.array(z.object({ item: resourceDirectoryItemSchema, citation: bodyCitationSchema }).strict()).max(20), nextAfter: z.string().max(4096).nullable(), coverage: z.literal('INDEXED_NATIVE_TEXT_PASSAGES_ONLY'), completeness: z.literal('NOT_ASSESSED'), semantics: z.literal('RAW_MATERIAL_NOT_GOVERNANCE_APPROVAL') }).strict(),
+    knowledge_resource_read_passage: z.object({ citation: bodyCitationSchema, verified: z.literal(true) }).strict(),
+};
+export function bodySearchEnvelopeSchema(name) { return resourceEnvelopeSchema.safeExtend({ data: bodySearchDataSchemas[name] }); }