@felspar/sdk 0.1.1 → 0.2.1

package/dist/types/draft-hosted-client.d.ts

@@ -1,9 +1,143 @@
 import { z } from "zod";
+declare const FelsparCaseSchema: z.ZodObject<{
+    id: z.ZodString;
+    mode: z.ZodEnum<{
+        provided: "provided";
+        fields: "fields";
+        content: "content";
+        issued: "issued";
+    }>;
+}, z.core.$strip>;
+declare const FelsparRelatedSchema: z.ZodObject<{
+    relationship: z.ZodString;
+    subject: z.ZodString;
+    id: z.ZodString;
+    questions: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+declare const FelsparResultSubjectSchema: z.ZodObject<{
+    type: z.ZodString;
+    id: z.ZodString;
+    related: z.ZodArray<z.ZodObject<{
+        relationship: z.ZodString;
+        subject: z.ZodString;
+        id: z.ZodString;
+        questions: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const FelsparEscalationSchema: z.ZodObject<{
+    id: z.ZodString;
+    trigger: z.ZodEnum<{
+        outcome: "outcome";
+        unresolved: "unresolved";
+        attempt_limit: "attempt_limit";
+    }>;
+    why: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$strip>;
+declare const FelsparJobResultSchema: z.ZodObject<{
+    status: z.ZodString;
+    reason: z.ZodNullable<z.ZodString>;
+    result: z.ZodNullable<z.ZodObject<{
+        executionId: z.ZodString;
+        releaseId: z.ZodString;
+        releaseDigest: z.ZodString;
+        outcome: z.ZodNullable<z.ZodString>;
+        scoring: z.ZodUnknown;
+        context: z.ZodUnknown;
+        receipt: z.ZodUnknown;
+        case: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            mode: z.ZodEnum<{
+                provided: "provided";
+                fields: "fields";
+                content: "content";
+                issued: "issued";
+            }>;
+        }, z.core.$strip>>;
+        subject: z.ZodOptional<z.ZodObject<{
+            type: z.ZodString;
+            id: z.ZodString;
+            related: z.ZodArray<z.ZodObject<{
+                relationship: z.ZodString;
+                subject: z.ZodString;
+                id: z.ZodString;
+                questions: z.ZodArray<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        escalation: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            trigger: z.ZodEnum<{
+                outcome: "outcome";
+                unresolved: "unresolved";
+                attempt_limit: "attempt_limit";
+            }>;
+            why: z.ZodObject<{
+                text: z.ZodString;
+            }, z.core.$loose>;
+        }, z.core.$strip>>;
+        missing: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$loose>>;
+}, z.core.$strip>;
+export type FelsparJobResult = z.infer<typeof FelsparJobResultSchema>;
+export type FelsparJobCase = z.infer<typeof FelsparCaseSchema>;
+export type FelsparRelatedRecord = z.infer<typeof FelsparRelatedSchema>;
+export type FelsparResultSubject = z.infer<typeof FelsparResultSubjectSchema>;
+export type FelsparJobEscalation = z.infer<typeof FelsparEscalationSchema>;
+interface QuotedWords {
+    text: string;
+}
+export interface FelsparJobSubject {
+    type: string;
+    definition: QuotedWords;
+    identifier?: string | undefined;
+    example?: string | undefined;
+    match: "exact" | "case-insensitive";
+    related: readonly {
+        relationship: string;
+        meaning: QuotedWords;
+        cardinality: "one" | "many";
+        required: boolean;
+        subject: string;
+        definition: QuotedWords;
+        identifier: string;
+        example: string;
+        match: "exact" | "case-insensitive";
+    }[];
+    send: string;
+}
+export interface FelsparJobIdentity {
+    mode: FelsparJobCase["mode"];
+    send: string;
+    fields?: readonly {
+        name: string;
+        identifier: string;
+        example: string;
+        match: string;
+    }[];
+    question?: string | undefined;
+}
+export interface FelsparFactsRequest {
+    jobId: string;
+    executionId: string;
+    expectedReleaseDigest?: string;
+    entityId?: string;
+    identity?: Record<string, string>;
+    related?: Record<string, string | string[]>;
+    facts: Record<string, unknown>;
+}
+declare const FelsparJobListSchema: z.ZodObject<{
+    jobs: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type FelsparJobList = z.infer<typeof FelsparJobListSchema>;
 declare const refusalSchema: z.ZodPipe<z.ZodObject<{
     error: z.ZodString;
     path: z.ZodOptional<z.ZodArray<z.ZodString>>;
     currentReleaseDigest: z.ZodOptional<z.ZodString>;
     retryAfterSeconds: z.ZodOptional<z.ZodNumber>;
+    escalation: z.ZodOptional<z.ZodUnknown>;
     issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
         code: z.ZodString;
         path: z.ZodArray<z.ZodString>;
@@ -14,6 +148,13 @@ declare const refusalSchema: z.ZodPipe<z.ZodObject<{
         path: string[];
     }[] | undefined;
     fix?: string;
+    escalation?: {
+        id: string;
+        trigger: "outcome" | "unresolved" | "attempt_limit";
+        why: {
+            text: string;
+        };
+    };
     error: string;
     path?: string[] | undefined;
     currentReleaseDigest?: string | undefined;
@@ -23,6 +164,7 @@ declare const refusalSchema: z.ZodPipe<z.ZodObject<{
     path?: string[] | undefined;
     currentReleaseDigest?: string | undefined;
     retryAfterSeconds?: number | undefined;
+    escalation?: unknown;
     issues?: {
         code: string;
         path: string[];
@@ -43,35 +185,14 @@ export declare function createHostedFelsparClient(configuration: {
     agentKey?: string;
     fetcher?: typeof fetch;
 }): {
-    executeJob: (id: string, value: unknown) => Promise<{
-        status: string;
-        reason: string | null;
-        result: {
-            [x: string]: unknown;
-            executionId: string;
-            releaseId: string;
-            releaseDigest: string;
-            outcome: string | null;
-            scoring: unknown;
-            context: unknown;
-            receipt: unknown;
-        } | null;
-    }>;
-    resolveFacts: (id: string, value: Record<string, unknown>) => Promise<{
-        status: string;
-        reason: string | null;
-        result: {
-            [x: string]: unknown;
-            executionId: string;
-            releaseId: string;
-            releaseDigest: string;
-            outcome: string | null;
-            scoring: unknown;
-            context: unknown;
-            receipt: unknown;
-        } | null;
+    resolveFacts: (id: string, value: FelsparFactsRequest | Record<string, unknown>) => Promise<FelsparJobResult>;
+    listJobs: () => Promise<{
+        jobs: {
+            id: string;
+        }[];
     }>;
-    resolveJob: (id: string, value: unknown) => Promise<{
+    resolveJob: (id: string, value: unknown) => Promise<FelsparJobResult>;
+    executeJob: (id: string, value: unknown) => Promise<{
         status: string;
         reason: string | null;
         result: {
@@ -1539,7 +1660,7 @@ export declare function createHostedFelsparClient(configuration: {
                         outputSurface: string;
                         entries: {
                             id: string;
-                            primitive: "gaps" | "actors" | "decision_criteria" | "source_signals" | "needs_and_requirements" | "evidence_and_proof" | "boundaries" | "output_contracts" | "routing_jobs" | "evaluations";
+                            primitive: "gaps" | "actors" | "decision_criteria" | "source_signals" | "needs_and_requirements" | "evidence_and_proof" | "boundaries" | "output_contracts" | "routing_jobs" | "evaluations" | "subjects";
                             body: string;
                             source: {
                                 sourceId: string;
@@ -1588,6 +1709,61 @@ export declare function createHostedFelsparClient(configuration: {
                             max: number;
                             withProgress: number;
                         } | undefined;
+                        subjects?: {
+                            job: string;
+                            types: {
+                                id: string;
+                                entryId: string;
+                                match: "exact" | "case-insensitive";
+                                relationships: {
+                                    name: string;
+                                    subject: string;
+                                    cardinality: "one" | "many";
+                                    required: boolean;
+                                    entryId: string;
+                                }[];
+                                identifier?: string | undefined;
+                                example?: string | undefined;
+                            }[];
+                            about: {
+                                key: string;
+                                relationship: string;
+                            }[];
+                        } | undefined;
+                        escalations?: {
+                            routes: {
+                                id: string;
+                                entryId: string;
+                            }[];
+                            outcomes: {
+                                outcome: string;
+                                escalation: string;
+                            }[];
+                            unresolved: string | null;
+                            attemptLimit: string | null;
+                        } | undefined;
+                        guide?: {
+                            purpose: string | null;
+                            useWhen: string[];
+                            notFor: string[];
+                            owner: string | null;
+                        } | undefined;
+                        caseIdentity?: {
+                            mode: "provided";
+                        } | {
+                            mode: "fields";
+                            fields: {
+                                name: string;
+                                identifier: string;
+                                example: string;
+                                match: "exact" | "case-insensitive";
+                            }[];
+                        } | {
+                            mode: "content";
+                            question: string;
+                        } | {
+                            mode: "issued";
+                        } | undefined;
                     };
                     expectedPlanDigest: string;
                     requestedSurface: string;
@@ -2517,7 +2693,7 @@ export declare function createHostedFelsparClient(configuration: {
                         outputSurface: string;
                         entries: {
                             id: string;
-                            primitive: "gaps" | "actors" | "decision_criteria" | "source_signals" | "needs_and_requirements" | "evidence_and_proof" | "boundaries" | "output_contracts" | "routing_jobs" | "evaluations";
+                            primitive: "gaps" | "actors" | "decision_criteria" | "source_signals" | "needs_and_requirements" | "evidence_and_proof" | "boundaries" | "output_contracts" | "routing_jobs" | "evaluations" | "subjects";
                             body: string;
                             source: {
                                 sourceId: string;
@@ -2566,6 +2742,61 @@ export declare function createHostedFelsparClient(configuration: {
                             max: number;
                             withProgress: number;
                         } | undefined;
+                        subjects?: {
+                            job: string;
+                            types: {
+                                id: string;
+                                entryId: string;
+                                match: "exact" | "case-insensitive";
+                                relationships: {
+                                    name: string;
+                                    subject: string;
+                                    cardinality: "one" | "many";
+                                    required: boolean;
+                                    entryId: string;
+                                }[];
+                                identifier?: string | undefined;
+                                example?: string | undefined;
+                            }[];
+                            about: {
+                                key: string;
+                                relationship: string;
+                            }[];
+                        } | undefined;
+                        escalations?: {
+                            routes: {
+                                id: string;
+                                entryId: string;
+                            }[];
+                            outcomes: {
+                                outcome: string;
+                                escalation: string;
+                            }[];
+                            unresolved: string | null;
+                            attemptLimit: string | null;
+                        } | undefined;
+                        guide?: {
+                            purpose: string | null;
+                            useWhen: string[];
+                            notFor: string[];
+                            owner: string | null;
+                        } | undefined;
+                        caseIdentity?: {
+                            mode: "provided";
+                        } | {
+                            mode: "fields";
+                            fields: {
+                                name: string;
+                                identifier: string;
+                                example: string;
+                                match: "exact" | "case-insensitive";
+                            }[];
+                        } | {
+                            mode: "content";
+                            question: string;
+                        } | {
+                            mode: "issued";
+                        } | undefined;
                     };
                     expectedPlanDigest: string;
                     requestedSurface: string;
@@ -3171,6 +3402,10 @@ export declare function createHostedFelsparClient(configuration: {
                     text: string;
                 }[];
             }[] | undefined;
+            about?: {
+                relationship: string;
+                subject: string;
+            } | undefined;
         }[];
         rules: {
             id: string;
@@ -3293,6 +3528,7 @@ export declare function createHostedFelsparClient(configuration: {
                     id: string;
                 }[] | undefined;
             }[] | undefined;
+            escalate?: string | undefined;
         }[];
         guidance: {
             gather: string;
@@ -3315,6 +3551,7 @@ export declare function createHostedFelsparClient(configuration: {
                         locator?: string | undefined;
                         sensitivity?: string | undefined;
                     };
+                    about?: string | undefined;
                 } | {
                     text: string;
                     source: {
@@ -3325,6 +3562,7 @@ export declare function createHostedFelsparClient(configuration: {
                         locator?: string | undefined;
                         sensitivity?: string | undefined;
                     };
+                    about?: string | undefined;
                 }[] | {
                     value: string | number | boolean;
                     source: {
@@ -3336,7 +3574,10 @@ export declare function createHostedFelsparClient(configuration: {
                         sensitivity?: string | undefined;
                         excerpt?: string | undefined;
                     };
+                    about?: string | undefined;
                 }>;
+                related?: Record<string, string | string[]> | undefined;
+                identity?: Record<string, string> | undefined;
             } | null;
             exampleNote: string;
         };
@@ -3350,6 +3591,145 @@ export declare function createHostedFelsparClient(configuration: {
                 maxQuestions: 64;
             };
         };
+        purpose?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        } | undefined;
+        useWhen?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        }[] | undefined;
+        notFor?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        }[] | undefined;
+        owner?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        } | undefined;
+        subject?: {
+            type: string;
+            definition: {
+                text: string;
+                source: {
+                    sourceId: string;
+                    revision: string;
+                    locator: string;
+                    contentDigest: string;
+                };
+                parts: {
+                    locator: string;
+                    text: string;
+                }[];
+            };
+            match: "exact" | "case-insensitive";
+            related: {
+                identifier: string;
+                example: string;
+                match: "exact" | "case-insensitive";
+                relationship: string;
+                meaning: {
+                    text: string;
+                    source: {
+                        sourceId: string;
+                        revision: string;
+                        locator: string;
+                        contentDigest: string;
+                    };
+                    parts: {
+                        locator: string;
+                        text: string;
+                    }[];
+                };
+                cardinality: "one" | "many";
+                required: boolean;
+                subject: string;
+                definition: {
+                    text: string;
+                    source: {
+                        sourceId: string;
+                        revision: string;
+                        locator: string;
+                        contentDigest: string;
+                    };
+                    parts: {
+                        locator: string;
+                        text: string;
+                    }[];
+                };
+            }[];
+            send: string;
+            identifier?: string | undefined;
+            example?: string | undefined;
+        } | undefined;
+        identity?: {
+            mode: "provided" | "fields" | "content" | "issued";
+            send: string;
+            fields?: {
+                identifier: string;
+                example: string;
+                match: "exact" | "case-insensitive";
+                name: string;
+            }[] | undefined;
+            question?: string | undefined;
+        } | undefined;
+        escalations?: {
+            routes: {
+                id: string;
+                quote: {
+                    text: string;
+                    source: {
+                        sourceId: string;
+                        revision: string;
+                        locator: string;
+                        contentDigest: string;
+                    };
+                    parts: {
+                        locator: string;
+                        text: string;
+                    }[];
+                };
+            }[];
+            unresolved: string | null;
+            attemptLimit: string | null;
+            rule: string;
+        } | undefined;
         whenUnresolved?: {
             text: string;
             source: {
@@ -3378,6 +3758,23 @@ export declare function createHostedFelsparClient(configuration: {
             entityId: string;
             releaseId: string;
             outcome: string | null;
+            case?: {
+                id: string;
+                mode: "provided" | "fields" | "content" | "issued";
+            } | undefined;
+            subject?: {
+                type: string;
+                related: {
+                    relationship: string;
+                    subject: string;
+                    id: string;
+                    questions: string[];
+                }[];
+            } | undefined;
+            escalation?: {
+                id: string;
+                trigger: "outcome" | "unresolved" | "attempt_limit";
+            } | undefined;
         } | undefined;
     }>;
 };

package/dist/types/eve.d.ts

@@ -0,0 +1,22 @@
+export { felsparDecisionEvents, felsparGate } from "./draft-action-gate-eve.js";
+export type { EveApprovalStatus } from "./draft-action-gate-eve.js";
+export declare const felsparMcpUrl = "https://mcp.felspar.ai/mcp";
+export interface FelsparConnectionOptions {
+    url?: string;
+    agentKey?: string;
+    description?: string;
+}
+export interface FelsparConnection {
+    url: string;
+    description: string;
+    auth: {
+        getToken: () => Promise<{
+            token: string;
+        }>;
+    };
+    protocolVersionDiscovery: false;
+    tools: {
+        allow: readonly string[];
+    };
+}
+export declare function felsparConnection(options?: FelsparConnectionOptions): FelsparConnection;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@felspar/sdk",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Client and action gate for Felspar, the shared decision system for enterprise agents.",
   "license": "Apache-2.0",
   "homepage": "https://docs.felspar.ai",
@@ -24,6 +24,10 @@
   ],
   "type": "module",
   "exports": {
+    "./eve": {
+      "types": "./dist/types/eve.d.ts",
+      "default": "./dist/eve.js"
+    },
     "./draft/hosted-client": {
       "types": "./dist/types/draft-hosted-client.d.ts",
       "default": "./dist/draft-hosted-client.js"
@@ -46,8 +50,13 @@
     },
     "./package.json": "./package.json"
   },
+  "bin": {
+    "felspar-sdk": "bin/felspar-sdk.mjs"
+  },
   "files": [
     "dist",
+    "bin",
+    "skills/felspar/SKILL.md",
     "README.md",
     "LICENSE"
   ],