@kya-os/contracts 1.3.4 → 1.4.0

package/dist/registry.d.ts

@@ -0,0 +1,342 @@
+import { z } from "zod";
+/**
+ * Registry integration schemas (Know-That-AI and MCP Registry)
+ */
+export declare const RegistrationInputSchema: z.ZodObject<{
+    agentDID: z.ZodString;
+    agentURL: z.ZodString;
+    verificationEndpoint: z.ZodString;
+    conformanceCapabilities: z.ZodArray<z.ZodEnum<["handshake", "signing", "verification"]>, "many">;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    agentDID: string;
+    agentURL: string;
+    verificationEndpoint: string;
+    conformanceCapabilities: ("handshake" | "signing" | "verification")[];
+    metadata?: Record<string, any> | undefined;
+}, {
+    agentDID: string;
+    agentURL: string;
+    verificationEndpoint: string;
+    conformanceCapabilities: ("handshake" | "signing" | "verification")[];
+    metadata?: Record<string, any> | undefined;
+}>;
+export declare const RegistrationResultSchema: z.ZodObject<{
+    agentDID: z.ZodString;
+    agentURL: z.ZodString;
+    agentId: z.ZodString;
+    agentSlug: z.ZodString;
+    claimURL: z.ZodOptional<z.ZodString>;
+    verificationEndpoint: z.ZodString;
+    conformanceCapabilities: z.ZodTuple<[z.ZodLiteral<"handshake">, z.ZodLiteral<"signing">, z.ZodLiteral<"verification">], null>;
+    mirrorStatus: z.ZodEnum<["pending", "success", "error"]>;
+    mirrorLink: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    mirrorStatus: "success" | "pending" | "error";
+    agentDID: string;
+    agentURL: string;
+    verificationEndpoint: string;
+    conformanceCapabilities: ["handshake", "signing", "verification"];
+    agentId: string;
+    agentSlug: string;
+    claimURL?: string | undefined;
+    mirrorLink?: string | undefined;
+}, {
+    mirrorStatus: "success" | "pending" | "error";
+    agentDID: string;
+    agentURL: string;
+    verificationEndpoint: string;
+    conformanceCapabilities: ["handshake", "signing", "verification"];
+    agentId: string;
+    agentSlug: string;
+    claimURL?: string | undefined;
+    mirrorLink?: string | undefined;
+}>;
+export declare const ClaimTokenSchema: z.ZodObject<{
+    token: z.ZodString;
+    expiresAt: z.ZodNumber;
+    ttlHours: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    expiresAt: number;
+    token: string;
+    ttlHours: number;
+}, {
+    expiresAt: number;
+    token: string;
+    ttlHours?: number | undefined;
+}>;
+export declare const MirrorStatusSchema: z.ZodObject<{
+    status: z.ZodEnum<["pending", "success", "error"]>;
+    lastUpdated: z.ZodNumber;
+    errorMessage: z.ZodOptional<z.ZodString>;
+    registryURL: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    status: "success" | "pending" | "error";
+    lastUpdated: number;
+    errorMessage?: string | undefined;
+    registryURL?: string | undefined;
+}, {
+    status: "success" | "pending" | "error";
+    lastUpdated: number;
+    errorMessage?: string | undefined;
+    registryURL?: string | undefined;
+}>;
+export declare const AgentStatusSchema: z.ZodObject<{
+    did: z.ZodString;
+    kid: z.ZodString;
+    ktaURL: z.ZodString;
+    mirrorStatus: z.ZodObject<{
+        status: z.ZodEnum<["pending", "success", "error"]>;
+        lastUpdated: z.ZodNumber;
+        errorMessage: z.ZodOptional<z.ZodString>;
+        registryURL: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        status: "success" | "pending" | "error";
+        lastUpdated: number;
+        errorMessage?: string | undefined;
+        registryURL?: string | undefined;
+    }, {
+        status: "success" | "pending" | "error";
+        lastUpdated: number;
+        errorMessage?: string | undefined;
+        registryURL?: string | undefined;
+    }>;
+    lastHandshake: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    did: string;
+    kid: string;
+    ktaURL: string;
+    mirrorStatus: {
+        status: "success" | "pending" | "error";
+        lastUpdated: number;
+        errorMessage?: string | undefined;
+        registryURL?: string | undefined;
+    };
+    lastHandshake?: number | undefined;
+}, {
+    did: string;
+    kid: string;
+    ktaURL: string;
+    mirrorStatus: {
+        status: "success" | "pending" | "error";
+        lastUpdated: number;
+        errorMessage?: string | undefined;
+        registryURL?: string | undefined;
+    };
+    lastHandshake?: number | undefined;
+}>;
+/**
+ * Delegation schemas for verifiable credentials
+ */
+export declare const DelegationSchema: z.ZodObject<{
+    issuer: z.ZodString;
+    subject: z.ZodString;
+    scopes: z.ZodArray<z.ZodString, "many">;
+    nbf: z.ZodNumber;
+    exp: z.ZodNumber;
+    aud: z.ZodOptional<z.ZodString>;
+    delegationRef: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    subject: string;
+    scopes: string[];
+    issuer: string;
+    nbf: number;
+    exp: number;
+    delegationRef?: string | undefined;
+    aud?: string | undefined;
+}, {
+    subject: string;
+    scopes: string[];
+    issuer: string;
+    nbf: number;
+    exp: number;
+    delegationRef?: string | undefined;
+    aud?: string | undefined;
+}>;
+export declare const DelegationRequestSchema: z.ZodObject<{
+    subject: z.ZodString;
+    scopes: z.ZodArray<z.ZodString, "many">;
+    duration: z.ZodOptional<z.ZodNumber>;
+    audience: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    subject: string;
+    scopes: string[];
+    audience?: string | undefined;
+    duration?: number | undefined;
+}, {
+    subject: string;
+    scopes: string[];
+    audience?: string | undefined;
+    duration?: number | undefined;
+}>;
+/**
+ * Storage mode configuration for verifiable credentials and delegations
+ */
+export declare const StorageModeSchema: z.ZodEnum<["ktaEncrypted", "hybridReceiptsOnly", "selfHostedAuthoritative"]>;
+/**
+ * Receipt object returned by KTA for verifiable operations
+ * Schema ID: https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json
+ */
+export declare const ReceiptSchema: z.ZodObject<{
+    $schema: z.ZodOptional<z.ZodLiteral<"https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json">>;
+    ref: z.ZodString;
+    contentHash: z.ZodString;
+    action: z.ZodEnum<["issue", "revoke"]>;
+    ts: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    logIndex: z.ZodNumber;
+    logRoot: z.ZodString;
+    inclusionProof: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    ts: string | number;
+    ref: string;
+    contentHash: string;
+    action: "issue" | "revoke";
+    logIndex: number;
+    logRoot: string;
+    inclusionProof: string[];
+    $schema?: "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json" | undefined;
+}, {
+    ts: string | number;
+    ref: string;
+    contentHash: string;
+    action: "issue" | "revoke";
+    logIndex: number;
+    logRoot: string;
+    inclusionProof: string[];
+    $schema?: "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json" | undefined;
+}>;
+export declare const DelegationResponseSchema: z.ZodObject<{
+    delegation: z.ZodObject<{
+        issuer: z.ZodString;
+        subject: z.ZodString;
+        scopes: z.ZodArray<z.ZodString, "many">;
+        nbf: z.ZodNumber;
+        exp: z.ZodNumber;
+        aud: z.ZodOptional<z.ZodString>;
+        delegationRef: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        subject: string;
+        scopes: string[];
+        issuer: string;
+        nbf: number;
+        exp: number;
+        delegationRef?: string | undefined;
+        aud?: string | undefined;
+    }, {
+        subject: string;
+        scopes: string[];
+        issuer: string;
+        nbf: number;
+        exp: number;
+        delegationRef?: string | undefined;
+        aud?: string | undefined;
+    }>;
+    receipt: z.ZodObject<{
+        $schema: z.ZodOptional<z.ZodLiteral<"https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json">>;
+        ref: z.ZodString;
+        contentHash: z.ZodString;
+        action: z.ZodEnum<["issue", "revoke"]>;
+        ts: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        logIndex: z.ZodNumber;
+        logRoot: z.ZodString;
+        inclusionProof: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        ts: string | number;
+        ref: string;
+        contentHash: string;
+        action: "issue" | "revoke";
+        logIndex: number;
+        logRoot: string;
+        inclusionProof: string[];
+        $schema?: "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json" | undefined;
+    }, {
+        ts: string | number;
+        ref: string;
+        contentHash: string;
+        action: "issue" | "revoke";
+        logIndex: number;
+        logRoot: string;
+        inclusionProof: string[];
+        $schema?: "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json" | undefined;
+    }>;
+    encryptedPayload: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    delegation: {
+        subject: string;
+        scopes: string[];
+        issuer: string;
+        nbf: number;
+        exp: number;
+        delegationRef?: string | undefined;
+        aud?: string | undefined;
+    };
+    receipt: {
+        ts: string | number;
+        ref: string;
+        contentHash: string;
+        action: "issue" | "revoke";
+        logIndex: number;
+        logRoot: string;
+        inclusionProof: string[];
+        $schema?: "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json" | undefined;
+    };
+    encryptedPayload?: string | undefined;
+}, {
+    delegation: {
+        subject: string;
+        scopes: string[];
+        issuer: string;
+        nbf: number;
+        exp: number;
+        delegationRef?: string | undefined;
+        aud?: string | undefined;
+    };
+    receipt: {
+        ts: string | number;
+        ref: string;
+        contentHash: string;
+        action: "issue" | "revoke";
+        logIndex: number;
+        logRoot: string;
+        inclusionProof: string[];
+        $schema?: "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json" | undefined;
+    };
+    encryptedPayload?: string | undefined;
+}>;
+/**
+ * Storage configuration for different deployment modes
+ */
+export declare const StorageConfigSchema: z.ZodObject<{
+    mode: z.ZodEnum<["ktaEncrypted", "hybridReceiptsOnly", "selfHostedAuthoritative"]>;
+    encryptionEnabled: z.ZodDefault<z.ZodBoolean>;
+    receiptVerificationEnabled: z.ZodDefault<z.ZodBoolean>;
+    ktaBaseURL: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    mode: "ktaEncrypted" | "hybridReceiptsOnly" | "selfHostedAuthoritative";
+    encryptionEnabled: boolean;
+    receiptVerificationEnabled: boolean;
+    ktaBaseURL: string;
+}, {
+    mode: "ktaEncrypted" | "hybridReceiptsOnly" | "selfHostedAuthoritative";
+    encryptionEnabled?: boolean | undefined;
+    receiptVerificationEnabled?: boolean | undefined;
+    ktaBaseURL?: string | undefined;
+}>;
+export type RegistrationInput = z.infer<typeof RegistrationInputSchema>;
+export type RegistrationResult = z.infer<typeof RegistrationResultSchema>;
+export type ClaimToken = z.infer<typeof ClaimTokenSchema>;
+export type MirrorStatus = z.infer<typeof MirrorStatusSchema>;
+export type AgentStatus = z.infer<typeof AgentStatusSchema>;
+export type StorageMode = z.infer<typeof StorageModeSchema>;
+export type Receipt = z.infer<typeof ReceiptSchema>;
+export type StorageConfig = z.infer<typeof StorageConfigSchema>;
+export type Delegation = z.infer<typeof DelegationSchema>;
+export type DelegationRequest = z.infer<typeof DelegationRequestSchema>;
+export type DelegationResponse = z.infer<typeof DelegationResponseSchema>;
+export declare const MCP_I_CAPABILITIES: readonly ["handshake", "signing", "verification"];
+export declare const CLAIM_TOKEN_TTL_HOURS = 24;
+export declare const KTA_BASE_URL = "https://knowthat.ai";
+export declare const DEFAULT_STORAGE_MODE: StorageMode;
+export declare const STORAGE_MODE_ENV_VAR = "MCPI_STORAGE_MODE";
+export declare const RECEIPT_SCHEMA_ID = "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json";
+export declare const CONTENT_HASH_REGEX: RegExp;

package/dist/registry.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONTENT_HASH_REGEX = exports.RECEIPT_SCHEMA_ID = exports.STORAGE_MODE_ENV_VAR = exports.DEFAULT_STORAGE_MODE = exports.KTA_BASE_URL = exports.CLAIM_TOKEN_TTL_HOURS = exports.MCP_I_CAPABILITIES = exports.StorageConfigSchema = exports.DelegationResponseSchema = exports.ReceiptSchema = exports.StorageModeSchema = exports.DelegationRequestSchema = exports.DelegationSchema = exports.AgentStatusSchema = exports.MirrorStatusSchema = exports.ClaimTokenSchema = exports.RegistrationResultSchema = exports.RegistrationInputSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Registry integration schemas (Know-That-AI and MCP Registry)
+ */
+exports.RegistrationInputSchema = zod_1.z.object({
+    agentDID: zod_1.z.string().min(1),
+    agentURL: zod_1.z.string().url(),
+    verificationEndpoint: zod_1.z.string().url(),
+    conformanceCapabilities: zod_1.z.array(zod_1.z.enum(["handshake", "signing", "verification"])),
+    metadata: zod_1.z.record(zod_1.z.any()).optional(),
+});
+exports.RegistrationResultSchema = zod_1.z.object({
+    agentDID: zod_1.z.string().min(1),
+    agentURL: zod_1.z.string().url(),
+    agentId: zod_1.z.string().min(1),
+    agentSlug: zod_1.z.string().min(1),
+    claimURL: zod_1.z.string().url().optional(),
+    verificationEndpoint: zod_1.z.string().url(),
+    conformanceCapabilities: zod_1.z.tuple([
+        zod_1.z.literal("handshake"),
+        zod_1.z.literal("signing"),
+        zod_1.z.literal("verification"),
+    ]),
+    mirrorStatus: zod_1.z.enum(["pending", "success", "error"]),
+    mirrorLink: zod_1.z.string().url().optional(),
+});
+exports.ClaimTokenSchema = zod_1.z.object({
+    token: zod_1.z.string().min(1),
+    expiresAt: zod_1.z.number().int().positive(),
+    ttlHours: zod_1.z.number().int().positive().default(24),
+});
+exports.MirrorStatusSchema = zod_1.z.object({
+    status: zod_1.z.enum(["pending", "success", "error"]),
+    lastUpdated: zod_1.z.number().int().positive(),
+    errorMessage: zod_1.z.string().optional(),
+    registryURL: zod_1.z.string().url().optional(),
+});
+exports.AgentStatusSchema = zod_1.z.object({
+    did: zod_1.z.string().min(1),
+    kid: zod_1.z.string().min(1),
+    ktaURL: zod_1.z.string().url(),
+    mirrorStatus: exports.MirrorStatusSchema,
+    lastHandshake: zod_1.z.number().int().positive().optional(),
+});
+/**
+ * Delegation schemas for verifiable credentials
+ */
+exports.DelegationSchema = zod_1.z.object({
+    issuer: zod_1.z.string().min(1), // DID of the issuer
+    subject: zod_1.z.string().min(1), // DID of the subject
+    scopes: zod_1.z.array(zod_1.z.string()),
+    nbf: zod_1.z.number().int().positive(), // Not before (unix timestamp)
+    exp: zod_1.z.number().int().positive(), // Expires (unix timestamp)
+    aud: zod_1.z.string().optional(), // Audience (optional)
+    delegationRef: zod_1.z.string().optional(), // Reference to parent delegation
+});
+exports.DelegationRequestSchema = zod_1.z.object({
+    subject: zod_1.z.string().min(1),
+    scopes: zod_1.z.array(zod_1.z.string()),
+    duration: zod_1.z.number().int().positive().optional(), // Duration in seconds
+    audience: zod_1.z.string().optional(),
+});
+/**
+ * Storage mode configuration for verifiable credentials and delegations
+ */
+exports.StorageModeSchema = zod_1.z.enum([
+    "ktaEncrypted",
+    "hybridReceiptsOnly",
+    "selfHostedAuthoritative",
+]);
+/**
+ * Receipt object returned by KTA for verifiable operations
+ * Schema ID: https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json
+ */
+exports.ReceiptSchema = zod_1.z.object({
+    $schema: zod_1.z
+        .literal("https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json")
+        .optional(),
+    ref: zod_1.z.string().min(1),
+    contentHash: zod_1.z.string().regex(/^sha256:[a-f0-9]{64}$/),
+    action: zod_1.z.enum(["issue", "revoke"]),
+    // Back-compat: accept ISO string (preferred) or legacy epoch number
+    ts: zod_1.z.union([zod_1.z.string().datetime(), zod_1.z.number().int().positive()]),
+    logIndex: zod_1.z.number().int().nonnegative(),
+    logRoot: zod_1.z.string().min(1),
+    inclusionProof: zod_1.z.array(zod_1.z.string()),
+});
+exports.DelegationResponseSchema = zod_1.z.object({
+    delegation: exports.DelegationSchema,
+    receipt: exports.ReceiptSchema,
+    encryptedPayload: zod_1.z.string().optional(), // For ktaEncrypted mode
+});
+/**
+ * Storage configuration for different deployment modes
+ */
+exports.StorageConfigSchema = zod_1.z.object({
+    mode: exports.StorageModeSchema,
+    encryptionEnabled: zod_1.z.boolean().default(false),
+    receiptVerificationEnabled: zod_1.z.boolean().default(true),
+    ktaBaseURL: zod_1.z.string().url().default("https://knowthat.ai"),
+});
+// Constants
+exports.MCP_I_CAPABILITIES = [
+    "handshake",
+    "signing",
+    "verification",
+];
+exports.CLAIM_TOKEN_TTL_HOURS = 24;
+exports.KTA_BASE_URL = "https://knowthat.ai"; // Placeholder for docs/tests
+// Storage mode constants
+exports.DEFAULT_STORAGE_MODE = "ktaEncrypted";
+exports.STORAGE_MODE_ENV_VAR = "MCPI_STORAGE_MODE";
+// Receipt schema constants
+exports.RECEIPT_SCHEMA_ID = "https://schemas.kya-os.ai/mcpi/receipt/v1.0.0.json";
+exports.CONTENT_HASH_REGEX = /^sha256:[a-f0-9]{64}$/;