@slashfi/agents-sdk 0.39.0 → 0.40.1

package/dist/config-store.d.ts

@@ -0,0 +1,137 @@
+/**
+ * ADK Config Store — programmatic API for managing registries and refs.
+ *
+ * Provides a `createAdk(fs, options?)` factory that returns an object
+ * with `registry.*` and `ref.*` namespaces. Backed by a pluggable
+ * FsStore so it works with local filesystem (CLI) or VCS (atlas).
+ *
+ * @example
+ * ```typescript
+ * import { createAdk, createLocalFsStore } from '@slashfi/agents-sdk';
+ *
+ * const adk = createAdk(createLocalFsStore());
+ * await adk.registry.add({ url: 'https://registry.slash.com', name: 'slash' });
+ * await adk.registry.browse('slash');
+ * await adk.ref.add({ ref: 'notion', registry: 'slash' });
+ * await adk.ref.call('notion', 'notion-search', { query: 'hello' });
+ * ```
+ */
+import type { FsStore } from "./agent-definitions/config.js";
+import type { ConsumerConfig, RefEntry, RegistryEntry, ResolvedRef } from "./define-config.js";
+import type { AgentListing, RegistryConfiguration } from "./registry-consumer.js";
+import type { CallAgentResponse, SecuritySchemeSummary } from "./types.js";
+export interface AdkOptions {
+    /** Passphrase for encrypting/decrypting secret: values */
+    encryptionKey?: string;
+    /** Bearer token for authenticated registries */
+    token?: string;
+    /**
+     * OAuth callback URL. Defaults to http://localhost:8919/callback.
+     * Set this to your server's callback endpoint in non-local environments
+     * (e.g. atlas), then call adk.handleCallback() when it arrives.
+     */
+    oauthCallbackUrl?: string;
+    /** Port for local OAuth callback server (default 8919) */
+    oauthCallbackPort?: number;
+    /** Client name for OAuth dynamic client registration (default: "Claude Code") */
+    oauthClientName?: string;
+}
+export interface RegistryTestResult {
+    name: string;
+    url: string;
+    status: "active" | "error";
+    issuer?: string;
+    error?: string;
+}
+export interface AdkRegistryApi {
+    add(entry: RegistryEntry): Promise<void>;
+    remove(nameOrUrl: string): Promise<boolean>;
+    list(): Promise<RegistryEntry[]>;
+    get(name: string): Promise<RegistryEntry | null>;
+    update(name: string, updates: Partial<RegistryEntry>): Promise<boolean>;
+    browse(name: string, query?: string): Promise<AgentListing[]>;
+    inspect(name: string): Promise<RegistryConfiguration>;
+    test(name?: string): Promise<RegistryTestResult[]>;
+}
+/** Describes what auth a ref needs and what's already provided */
+export interface RefAuthStatus {
+    name: string;
+    security: SecuritySchemeSummary | null;
+    /** All required secret fields are present (may be untested) */
+    complete: boolean;
+    /** Fields that still need to be provided */
+    missing: string[];
+    /** Fields already stored */
+    present: string[];
+}
+export interface OAuthResult {
+    accessToken: string;
+    refreshToken?: string;
+    expiresIn?: number;
+    clientId: string;
+}
+export interface AuthStartResult {
+    type: string;
+    complete: boolean;
+    /** For OAuth: the URL to open in the browser */
+    authorizeUrl?: string;
+}
+export interface AdkRefApi {
+    add(entry: RefEntry): Promise<{
+        security: SecuritySchemeSummary | null;
+    }>;
+    remove(name: string): Promise<boolean>;
+    list(): Promise<ResolvedRef[]>;
+    get(name: string): Promise<RefEntry | null>;
+    update(name: string, updates: Partial<RefEntry>): Promise<boolean>;
+    inspect(name: string, options?: {
+        full?: boolean;
+    }): Promise<AgentListing | null>;
+    call(name: string, tool: string, params?: Record<string, unknown>): Promise<CallAgentResponse>;
+    resources(name: string): Promise<CallAgentResponse>;
+    read(name: string, uris: string[]): Promise<CallAgentResponse>;
+    /** Check auth status — what's needed vs what's stored */
+    authStatus(name: string): Promise<RefAuthStatus>;
+    /**
+     * Start the auth flow for a ref. Returns the authorize URL for OAuth.
+     * Call adk.handleCallback() when the callback arrives, or use
+     * adk.ref.authLocal() to spin up a local server and block.
+     */
+    auth(name: string, opts?: {
+        /** For API key / bearer auth: the key/token value */
+        apiKey?: string;
+    }): Promise<AuthStartResult>;
+    /**
+     * Run the full OAuth flow locally: start auth, spin up a callback
+     * server, open the browser, wait for the redirect, exchange tokens.
+     * Resolves when auth is complete or times out.
+     */
+    authLocal(name: string, opts?: {
+        /** Called with the authorize URL (e.g. to open in browser) */
+        onAuthorizeUrl?: (url: string) => void;
+        /** Timeout in ms (default 300_000 = 5 min) */
+        timeoutMs?: number;
+    }): Promise<{
+        complete: boolean;
+    }>;
+}
+export interface Adk {
+    registry: AdkRegistryApi;
+    ref: AdkRefApi;
+    readConfig(): Promise<ConsumerConfig>;
+    writeConfig(config: ConsumerConfig): Promise<void>;
+    /**
+     * Handle an OAuth callback. Works in any environment.
+     * Parse the callback query params and pass them here.
+     * @returns the ref name and whether auth is complete
+     */
+    handleCallback(params: {
+        code: string;
+        state: string;
+    }): Promise<{
+        refName: string;
+        complete: boolean;
+    }>;
+}
+export declare function createAdk(fs: FsStore, options?: AdkOptions): Adk;
+//# sourceMappingURL=config-store.d.ts.map

package/dist/config-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-store.d.ts","sourceRoot":"","sources":["../src/config-store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,KAAK,EACV,cAAc,EACd,QAAQ,EACR,aAAa,EACb,WAAW,EACZ,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EACV,YAAY,EACZ,qBAAqB,EAEtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAgB3E,MAAM,WAAW,UAAU;IACzB,0DAA0D;IAC1D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iFAAiF;IACjF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IACjC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IACjD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC9D,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;CACpD;AAED,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACvC,+DAA+D;IAC/D,QAAQ,EAAE,OAAO,CAAC;IAClB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,4BAA4B;IAC5B,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,gDAAgD;IAChD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAA;KAAE,CAAC,CAAC;IAC1E,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAC5C,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACnE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAClF,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/F,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACpD,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/D,yDAAyD;IACzD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACjD;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QACxB,qDAAqD;QACrD,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC7B;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAC7B,8DAA8D;QAC9D,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;QACvC,8CAA8C;QAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,GAAG;IAClB,QAAQ,EAAE,cAAc,CAAC;IACzB,GAAG,EAAE,SAAS,CAAC;IACf,UAAU,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IACtC,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CAC1G;AAoDD,wBAAgB,SAAS,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,GAAE,UAAe,GAAG,GAAG,CA6rBpE"}