@skein-js/core 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -7,6 +7,66 @@ type Run = Omit<Run$1, "status"> & {
 };
 type MultitaskStrategy = NonNullable<Run$1["multitask_strategy"]>;
 
+/**
+ * The authenticated caller, normalized to the shape LangGraph's `Auth` produces: a required
+ * `identity`, `display_name`, `is_authenticated`, and `permissions` scopes, plus open extra keys a
+ * handler may attach (e.g. `email`, `org_id`). Structurally identical to the SDK's internal
+ * `BaseUser`, so a graph written for LangGraph Platform reads the same `langgraph_auth_user`.
+ */
+interface AuthUser {
+    identity: string;
+    display_name: string;
+    is_authenticated: boolean;
+    permissions: string[];
+    [key: string]: unknown;
+}
+/** The result of authenticating a request: the caller plus their permission scopes. */
+interface AuthContext {
+    user: AuthUser;
+    scopes: string[];
+}
+/** A protocol resource an `@auth.on.*` handler can guard. Runs authorize through their thread. */
+type AuthResource = "threads" | "assistants" | "store";
+/** An action on a resource, mirroring LangGraph's `resource:action` event names. */
+type AuthAction = "create" | "read" | "update" | "delete" | "search" | "create_run" | "put" | "get" | "list_namespaces";
+/** A single metadata filter clause — an exact value or an `$eq`/`$contains` operator object. */
+type AuthFilterValue = string | {
+    $eq?: string;
+    $contains?: string | string[];
+};
+/**
+ * Ownership filters returned by an `@auth.on.*` handler. Keys are metadata fields; a returned filter
+ * both scopes reads (a resource is visible only if its metadata satisfies every clause) and stamps
+ * writes (the clause values are merged into new resources' metadata). Shape-compatible with
+ * `@langchain/langgraph-api`'s `isAuthMatching`.
+ */
+type AuthFilters = Record<string, AuthFilterValue>;
+/**
+ * The injectable auth engine — one per runtime, no module-global state (unlike langgraph-api's
+ * `registerAuth`). Absent from `ProtocolDeps` means no auth is configured and every request is
+ * allowed (the default, so `skein dev` stays frictionless).
+ */
+interface AuthEngine {
+    /** True when a `langgraph.json` `auth.path` was loaded; false disables the whole gate. */
+    readonly enabled: boolean;
+    /** When true, studio traffic must present real credentials like any other client. */
+    readonly studioAuthDisabled: boolean;
+    /** Run the user's authenticate handler over a request; throws 401 on rejection/missing identity. */
+    authenticate(request: Request): Promise<AuthContext | undefined>;
+    /** Consult the `@auth.on.*` handlers for a resource+action; throws 403 on deny, else returns filters. */
+    authorize(input: {
+        resource: AuthResource;
+        action: AuthAction;
+        value: unknown;
+        context: AuthContext | undefined;
+    }): Promise<{
+        filters?: AuthFilters;
+        value: unknown;
+    }>;
+    /** Whether a resource's metadata satisfies the ownership filters (`$eq`/`$contains` semantics). */
+    matchesFilters(metadata: Record<string, unknown> | undefined, filters?: AuthFilters): boolean;
+}
+
 /** Fields accepted when registering an assistant (from a langgraph.json graph or the API). */
 interface AssistantCreate {
     graph_id: string;
@@ -96,6 +156,18 @@ interface RunKwargs {
     stream_mode?: StreamMode | StreamMode[];
     interrupt_before?: string[] | "*";
     interrupt_after?: string[] | "*";
+    /**
+     * The authenticated caller, stamped by the server (never accepted from the client). Persisted
+     * opaquely with the run so a background/crash-recovered run on another instance reconstructs the
+     * principal via `getKwargs` and injects it into the graph's `configurable.langgraph_auth_user`.
+     */
+    auth_user?: AuthUser;
+    /**
+     * The caller's authenticated permission scopes (the `AuthContext.scopes`), stamped alongside
+     * {@link auth_user}. Injected as `configurable.langgraph_auth_permissions`, matching LangGraph
+     * (which sources permissions from the auth scopes, not from the user object's `permissions`).
+     */
+    auth_scopes?: string[];
 }
 interface RunCreate {
     thread_id: string;
@@ -293,62 +365,4 @@ declare class SkeinHttpError extends Error {
 /** Narrow an unknown thrown value to a {@link SkeinHttpError}. */
 declare function isSkeinHttpError(value: unknown): value is SkeinHttpError;
 
-/**
- * The authenticated caller, normalized to the shape LangGraph produces: a required `identity`,
- * `permissions` scopes, and open extra keys a handler may attach (e.g. `email`, `org_id`).
- */
-interface AuthUser {
-    identity: string;
-    display_name: string;
-    is_authenticated: boolean;
-    permissions: string[];
-    [key: string]: unknown;
-}
-/** The result of authenticating a request: the caller plus their permission scopes. */
-interface AuthContext {
-    user: AuthUser;
-    scopes: string[];
-}
-/** A protocol resource an `@auth.on.*` handler can guard. Runs authorize through their thread. */
-type AuthResource = "threads" | "assistants" | "store";
-/** An action on a resource, mirroring LangGraph's `resource:action` event names. */
-type AuthAction = "create" | "read" | "update" | "delete" | "search" | "create_run" | "put" | "get" | "list_namespaces";
-/** A single metadata filter clause — an exact value or an `$eq`/`$contains` operator object. */
-type AuthFilterValue = string | {
-    $eq?: string;
-    $contains?: string | string[];
-};
-/**
- * Ownership filters returned by an `@auth.on.*` handler. Keys are metadata fields; a returned filter
- * both scopes reads (a resource is visible only if its metadata satisfies every clause) and stamps
- * writes (the clause values are merged into new resources' metadata). Shape-compatible with
- * `@langchain/langgraph-api`'s `isAuthMatching`.
- */
-type AuthFilters = Record<string, AuthFilterValue>;
-/**
- * The injectable auth engine — one per runtime, no module-global state (unlike langgraph-api's
- * `registerAuth`). Absent from `ProtocolDeps` means no auth is configured and every request is
- * allowed (the default, so `skein dev` stays frictionless).
- */
-interface AuthEngine {
-    /** True when a `langgraph.json` `auth.path` was loaded; false disables the whole gate. */
-    readonly enabled: boolean;
-    /** When true, studio traffic must present real credentials like any other client. */
-    readonly studioAuthDisabled: boolean;
-    /** Run the user's authenticate handler over a request; throws 401 on rejection/missing identity. */
-    authenticate(request: Request): Promise<AuthContext | undefined>;
-    /** Consult the `@auth.on.*` handlers for a resource+action; throws 403 on deny, else returns filters. */
-    authorize(input: {
-        resource: AuthResource;
-        action: AuthAction;
-        value: unknown;
-        context: AuthContext | undefined;
-    }): Promise<{
-        filters?: AuthFilters;
-        value: unknown;
-    }>;
-    /** Whether a resource's metadata satisfies the ownership filters (`$eq`/`$contains` semantics). */
-    matchesFilters(metadata: Record<string, unknown> | undefined, filters?: AuthFilters): boolean;
-}
-
 export { type AssistantCreate, type AssistantRepo, type AuthAction, type AuthContext, type AuthEngine, type AuthFilterValue, type AuthFilters, type AuthResource, type AuthUser, type MultitaskStrategy, type QueuedRun, type Run, type RunConsumer, type RunConsumerOptions, type RunCreate, type RunEventBus, type RunFrame, type RunKwargs, type RunProcessor, type RunQueue, type RunRepo, type RunStatus, SkeinHttpError, type SkeinHttpErrorOptions, type SkeinStore, type SkeinStoreSnapshot, type StorePutOptions, type StoreRepo, type StoreSearchQuery, type StoreTtlConfig, TERMINAL_RUN_STATUSES, type ThreadCreate, type ThreadRepo, type ThreadSearchQuery, type ThreadUpdate, isMetadataSubset, isSkeinHttpError, isTerminalRunStatus, serializeWireJson };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skein-js/core",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Framework-agnostic Agent Protocol engine for LangGraph.js — the heart of skein-js.",
   "license": "Apache-2.0",
   "author": "Maina Wycliffe <wmmaina7@gmail.com>",