@auth0/ai 1.0.2 → 2.0.0

package/dist/esm/authorizers/device-authorizer/DeviceAuthorizerBase.js

@@ -0,0 +1,224 @@
+import crypto from "node:crypto";
+import { discovery, initiateDeviceAuthorization } from "openid-client";
+import { stableHash } from "stable-hash";
+import { tokenSetFromTokenResponse } from "../../credentials";
+import { AccessDeniedInterrupt, AuthorizationPendingInterrupt, AuthorizationPollingInterrupt, AuthorizationRequestExpiredInterrupt, } from "../../interrupts/DeviceInterrupts";
+import { SubStore } from "../../stores";
+import { omit } from "../../util";
+import { nsFromContext } from "../context";
+import { Auth0PublicClientSchema } from "../types";
+import { asyncLocalStorage } from "./asyncLocalStorage";
+import { parseDeviceAuthResponse, } from "./DeviceAuthResponse";
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+/**
+ * The DeviceAuthorizerBase class acts as a guard and wrapper around tools or agent
+ * capabilities that require authenticated access. It encapsulates the
+ * OpenID Connect Device Authorization Flow, allowing tools to interrupt execution
+ * to request user authorization and resume seamlessly once authorization is granted.
+ *
+ * Enable agentic tools to be wrapped with secure, lazy-triggered device authorization,
+ * with a clean interrupt/resume model for user-in-the-loop authentication.
+ *
+ * Core Concepts
+ *
+ * - Interrupt-driven flow: If no valid token is present, the tool throws a DeviceAuthInterrupt,
+ * which contains the verification_uri, user_code, and other relevant metadata.
+ *
+ * - Polling/resumption: The Agent client can poll the agent to resume execution.
+ *
+ * - Token management: Tokens (and refresh tokens, if applicable) are stored and reused
+ * transparently.
+ *
+ */
+export class DeviceAuthorizerBase {
+    constructor(auth0, params) {
+        this.auth0 = Auth0PublicClientSchema.parse(auth0);
+        if (!this.auth0.domain) {
+            throw new Error("Domain is required.");
+        }
+        if (!this.auth0.clientId) {
+            throw new Error("Client ID is required.");
+        }
+        if (!params.store) {
+            throw new Error("Store is required.");
+        }
+        this.params = {
+            credentialsContext: "thread",
+            ...params,
+        };
+        const instanceID = this.getInstanceID();
+        this.credentialsStore = new SubStore(params.store, {
+            baseNamespace: [instanceID, "Credentials"],
+            getTTL: (credentials) => credentials.expiresIn ? credentials.expiresIn * 1000 : undefined,
+        });
+        this.authResponseStore = new SubStore(params.store, {
+            baseNamespace: [instanceID, "AuthResponses"],
+            getTTL: (authResponse) => authResponse.expiresIn ? authResponse.expiresIn * 1000 : undefined,
+        });
+    }
+    async start() {
+        var _a;
+        const requestedAt = Date.now() / 1000;
+        const config = await discovery(new URL(`https://${this.auth0.domain}`), this.auth0.clientId);
+        const handle = await initiateDeviceAuthorization(config, {
+            scope: ((_a = this.params.scopes) !== null && _a !== void 0 ? _a : []).join(" "),
+            audience: this.params.audience,
+        });
+        return parseDeviceAuthResponse(handle, requestedAt);
+    }
+    /**
+     *
+     * Wraps the execute method of a AI tool to handle CIBA authorization.
+     *
+     * @param getContext - A function that returns the context of the tool execution.
+     * @param execute - The tool execute method.
+     * @returns The wrapped execute method.
+     */
+    protect(getContext, execute) {
+        return async (...args) => {
+            let authResponse;
+            if (asyncLocalStorage.getStore()) {
+                throw new Error("Cannot nest tool calls that require CIBA authorization.");
+            }
+            const context = getContext(...args);
+            const storeValue = {
+                args,
+                context: context,
+            };
+            return asyncLocalStorage.run(storeValue, async () => {
+                let credentials;
+                let credentialsObtained = false;
+                const authResponseNS = nsFromContext("tool-call", context);
+                const credentialsNS = nsFromContext(this.params.credentialsContext, context);
+                try {
+                    credentials = await this.credentialsStore.get(credentialsNS, "credential");
+                    if (!credentials) {
+                        if (!this.params.onAuthorizationRequest ||
+                            this.params.onAuthorizationRequest === "interrupt") {
+                            authResponse = await this.authResponseStore.get(authResponseNS, "authResponse");
+                            if (!authResponse) {
+                                //Initial request
+                                authResponse = await this.start();
+                                await this.authResponseStore.put(authResponseNS, "authResponse", authResponse);
+                            }
+                            credentials = await this.getCredentials(authResponse);
+                        }
+                        else {
+                            // Block mode
+                            authResponse = await this.start();
+                            const credentialsPromise = this.getCredentialsPolling(authResponse);
+                            if (typeof this.params.onAuthorizationRequest === "function") {
+                                await this.params.onAuthorizationRequest(authResponse, credentialsPromise);
+                            }
+                            credentials = await credentialsPromise;
+                        }
+                        if (typeof credentials !== "undefined") {
+                            this.credentialsStore.put(credentialsNS, "credential", credentials);
+                        }
+                        credentialsObtained = true;
+                    }
+                }
+                catch (err) {
+                    const shouldInterrupt = err instanceof AuthorizationPendingInterrupt ||
+                        err instanceof AuthorizationPollingInterrupt;
+                    if (shouldInterrupt) {
+                        return this.handleAuthorizationInterrupts(err);
+                    }
+                    else {
+                        await this.deleteAuthRequest();
+                        if (typeof this.params.onUnauthorized === "function") {
+                            return this.params.onUnauthorized(err, ...args);
+                        }
+                        else {
+                            return err;
+                        }
+                    }
+                }
+                if (credentialsObtained) {
+                    await this.deleteAuthRequest();
+                }
+                storeValue.credentials = credentials;
+                return execute(...args);
+            });
+        };
+    }
+    async getCredentials(authResponse) {
+        var _a;
+        //TODO: this is not supported neither by the OIDC client library
+        //      or the auth0 client.
+        const url = `https://${this.auth0.domain}/oauth/token`;
+        const response = await fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/x-www-form-urlencoded",
+            },
+            body: new URLSearchParams({
+                grant_type: "urn:ietf:params:oauth:grant-type:device_code",
+                device_code: authResponse.deviceCode,
+                client_id: this.auth0.clientId,
+            }),
+        });
+        if (!response.ok) {
+            if ((_a = response.headers.get("content-type")) === null || _a === void 0 ? void 0 : _a.includes("application/json")) {
+                const { error, error_description } = await response.json();
+                if (error === "authorization_pending") {
+                    throw new AuthorizationPendingInterrupt(error_description, authResponse);
+                }
+                if (error === "slow_down") {
+                    throw new AuthorizationPollingInterrupt(error_description, authResponse);
+                }
+                if (error === "expired_token") {
+                    throw new AuthorizationRequestExpiredInterrupt(error_description, authResponse);
+                }
+                if (error === "access_denied") {
+                    throw new AccessDeniedInterrupt(error_description, authResponse);
+                }
+                throw new Error(error_description);
+            }
+            const errText = await response.text();
+            throw new Error(`Failed to obtain tokens: ${errText}`);
+        }
+        const tr = await response.json();
+        const credentials = tokenSetFromTokenResponse(tr);
+        return credentials;
+    }
+    async getCredentialsPolling(authResponse) {
+        var _a;
+        let credentials = undefined;
+        do {
+            try {
+                credentials = await this.getCredentials(authResponse);
+            }
+            catch (err) {
+                if (err instanceof AuthorizationPendingInterrupt ||
+                    err instanceof AuthorizationPollingInterrupt) {
+                    await sleep(((_a = err.response.interval) !== null && _a !== void 0 ? _a : 10) * 1000);
+                }
+                else {
+                    throw err;
+                }
+            }
+        } while (!credentials);
+        return credentials;
+    }
+    getInstanceID() {
+        const props = {
+            auth0: this.auth0,
+            params: omit(this.params, ["store", "onUnauthorized"]),
+        };
+        const sh = stableHash(props);
+        return crypto.createHash("MD5").update(sh).digest("hex");
+    }
+    deleteAuthRequest() {
+        const store = asyncLocalStorage.getStore();
+        if (!store) {
+            throw new Error("This method should be called from within a tool.");
+        }
+        const authResponseNS = nsFromContext("tool-call", store.context);
+        return this.authResponseStore.delete(authResponseNS, "authResponse");
+    }
+    handleAuthorizationInterrupts(err) {
+        throw err;
+    }
+}
+//# sourceMappingURL=DeviceAuthorizerBase.js.map

package/dist/esm/authorizers/device-authorizer/DeviceAuthorizerBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceAuthorizerBase.js","sourceRoot":"","sources":["../../../../src/authorizers/device-authorizer/DeviceAuthorizerBase.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAY,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,6BAA6B,EAC7B,oCAAoC,GACrC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAS,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAA8B,aAAa,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAA2B,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAqB,MAAM,qBAAqB,CAAC;AAE3E,OAAO,EAEL,uBAAuB,GACxB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,oBAAoB;IAQ/B,YACE,KAAuC,EACvC,MAA+C;QAE/C,IAAI,CAAC,KAAK,GAAG,uBAAuB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,kBAAkB,EAAE,QAAQ;YAC5B,GAAG,MAAM;SACV,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAExC,IAAI,CAAC,gBAAgB,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE;YACjD,aAAa,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC;YAC1C,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CACtB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;SACnE,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE;YAClD,aAAa,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC;YAC5C,MAAM,EAAE,CAAC,YAAY,EAAE,EAAE,CACvB,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;SACrE,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,KAAK;;QACjB,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,MAAM,GAAG,MAAM,SAAS,CAC5B,IAAI,GAAG,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,MAAO,EAAE,CAAC,EACxC,IAAI,CAAC,KAAK,CAAC,QAAS,CACrB,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,2BAA2B,CAAC,MAAM,EAAE;YACvD,KAAK,EAAE,CAAC,MAAA,IAAI,CAAC,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YAC3C,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAS;SAChC,CAAC,CAAC;QAEH,OAAO,uBAAuB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,UAA0C,EAC1C,OAA0C;QAE1C,OAAO,KAAK,EAAE,GAAG,IAAqB,EAAE,EAAE;YACxC,IAAI,YAAqD,CAAC;YAC1D,IAAI,iBAAiB,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;YACJ,CAAC;YAED,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;YACpC,MAAM,UAAU,GAA2B;gBACzC,IAAI;gBACJ,OAAO,EAAE,OAAO;aACjB,CAAC;YAEF,OAAO,iBAAiB,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE;gBAClD,IAAI,WAAiC,CAAC;gBACtC,IAAI,mBAAmB,GAAG,KAAK,CAAC;gBAChC,MAAM,cAAc,GAAG,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;gBAC3D,MAAM,aAAa,GAAG,aAAa,CACjC,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAC9B,OAAO,CACR,CAAC;gBACF,IAAI,CAAC;oBACH,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC3C,aAAa,EACb,YAAY,CACb,CAAC;oBAEF,IAAI,CAAC,WAAW,EAAE,CAAC;wBACjB,IACE,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB;4BACnC,IAAI,CAAC,MAAM,CAAC,sBAAsB,KAAK,WAAW,EAClD,CAAC;4BACD,YAAY,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAC7C,cAAc,EACd,cAAc,CACf,CAAC;4BAEF,IAAI,CAAC,YAAY,EAAE,CAAC;gCAClB,iBAAiB;gCACjB,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gCAClC,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAC9B,cAAc,EACd,cAAc,EACd,YAAY,CACb,CAAC;4BACJ,CAAC;4BACD,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;wBACxD,CAAC;6BAAM,CAAC;4BACN,aAAa;4BACb,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;4BAClC,MAAM,kBAAkB,GACtB,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;4BAC3C,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,KAAK,UAAU,EAAE,CAAC;gCAC7D,MAAM,IAAI,CAAC,MAAM,CAAC,sBAAsB,CACtC,YAAY,EACZ,kBAAkB,CACnB,CAAC;4BACJ,CAAC;4BACD,WAAW,GAAG,MAAM,kBAAkB,CAAC;wBACzC,CAAC;wBAED,IAAI,OAAO,WAAW,KAAK,WAAW,EAAE,CAAC;4BACvC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CACvB,aAAa,EACb,YAAY,EACZ,WAAW,CACZ,CAAC;wBACJ,CAAC;wBAED,mBAAmB,GAAG,IAAI,CAAC;oBAC7B,CAAC;gBACH,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,MAAM,eAAe,GACnB,GAAG,YAAY,6BAA6B;wBAC5C,GAAG,YAAY,6BAA6B,CAAC;oBAC/C,IAAI,eAAe,EAAE,CAAC;wBACpB,OAAO,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC;oBACjD,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBAC/B,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,KAAK,UAAU,EAAE,CAAC;4BACrD,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAY,EAAE,GAAG,IAAI,CAAC,CAAC;wBAC3D,CAAC;6BAAM,CAAC;4BACN,OAAO,GAAG,CAAC;wBACb,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,IAAI,mBAAmB,EAAE,CAAC;oBACxB,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACjC,CAAC;gBACD,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC;gBACrC,OAAO,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,YAAyC;;QAEzC,gEAAgE;QAChE,4BAA4B;QAC5B,MAAM,GAAG,GAAG,WAAW,IAAI,CAAC,KAAK,CAAC,MAAO,cAAc,CAAC;QACxD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,mCAAmC;aACpD;YACD,IAAI,EAAE,IAAI,eAAe,CAAC;gBACxB,UAAU,EAAE,8CAA8C;gBAC1D,WAAW,EAAE,YAAY,CAAC,UAAU;gBACpC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAS;aAChC,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,0CAAE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBACvE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC3D,IAAI,KAAK,KAAK,uBAAuB,EAAE,CAAC;oBACtC,MAAM,IAAI,6BAA6B,CACrC,iBAAiB,EACjB,YAAY,CACb,CAAC;gBACJ,CAAC;gBACD,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;oBAC1B,MAAM,IAAI,6BAA6B,CACrC,iBAAiB,EACjB,YAAY,CACb,CAAC;gBACJ,CAAC;gBACD,IAAI,KAAK,KAAK,eAAe,EAAE,CAAC;oBAC9B,MAAM,IAAI,oCAAoC,CAC5C,iBAAiB,EACjB,YAAY,CACb,CAAC;gBACJ,CAAC;gBACD,IAAI,KAAK,KAAK,eAAe,EAAE,CAAC;oBAC9B,MAAM,IAAI,qBAAqB,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;gBACnE,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,yBAAyB,CAAC,EAAE,CAAC,CAAC;QAElD,OAAO,WAAW,CAAC;IACrB,CAAC;IAES,KAAK,CAAC,qBAAqB,CACnC,YAAyC;;QAEzC,IAAI,WAAW,GAAyB,SAAS,CAAC;QAElD,GAAG,CAAC;YACF,IAAI,CAAC;gBACH,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;YACxD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IACE,GAAG,YAAY,6BAA6B;oBAC5C,GAAG,YAAY,6BAA6B,EAC5C,CAAC;oBACD,MAAM,KAAK,CAAC,CAAC,MAAA,GAAG,CAAC,QAAQ,CAAC,QAAQ,mCAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;gBACpD,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC,QAAQ,CAAC,WAAW,EAAE;QAEvB,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,aAAa;QACnB,MAAM,KAAK,GAAG;YACZ,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;SACvD,CAAC;QACF,MAAM,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;IAES,iBAAiB;QACzB,MAAM,KAAK,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAC3C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,cAAc,GAAG,aAAa,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACvE,CAAC;IAES,6BAA6B,CACrC,GAAkE;QAElE,MAAM,GAAG,CAAC;IACZ,CAAC;CACF","sourcesContent":["import crypto from \"node:crypto\";\nimport { discovery, initiateDeviceAuthorization } from \"openid-client\";\nimport { stableHash } from \"stable-hash\";\n\nimport { TokenSet, tokenSetFromTokenResponse } from \"../../credentials\";\nimport {\n  AccessDeniedInterrupt,\n  AuthorizationPendingInterrupt,\n  AuthorizationPollingInterrupt,\n  AuthorizationRequestExpiredInterrupt,\n} from \"../../interrupts/DeviceInterrupts\";\nimport { Store, SubStore } from \"../../stores\";\nimport { omit } from \"../../util\";\nimport { AuthContext, ContextGetter, nsFromContext } from \"../context\";\nimport { Auth0PublicClientParams, Auth0PublicClientSchema } from \"../types\";\nimport { asyncLocalStorage, AsyncStorageValue } from \"./asyncLocalStorage\";\nimport { DeviceAuthorizerParams } from \"./DeviceAuthorizerParams\";\nimport {\n  DeviceAuthorizationResponse,\n  parseDeviceAuthResponse,\n} from \"./DeviceAuthResponse\";\n\nconst sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));\n\n/**\n * The DeviceAuthorizerBase class acts as a guard and wrapper around tools or agent\n * capabilities that require authenticated access. It encapsulates the\n * OpenID Connect Device Authorization Flow, allowing tools to interrupt execution\n * to request user authorization and resume seamlessly once authorization is granted.\n *\n * Enable agentic tools to be wrapped with secure, lazy-triggered device authorization,\n * with a clean interrupt/resume model for user-in-the-loop authentication.\n *\n * Core Concepts\n *\n * - Interrupt-driven flow: If no valid token is present, the tool throws a DeviceAuthInterrupt,\n * which contains the verification_uri, user_code, and other relevant metadata.\n *\n * - Polling/resumption: The Agent client can poll the agent to resume execution.\n *\n * - Token management: Tokens (and refresh tokens, if applicable) are stored and reused\n * transparently.\n *\n */\nexport class DeviceAuthorizerBase<ToolExecuteArgs extends any[]> {\n  private auth0: Auth0PublicClientParams;\n  private params: DeviceAuthorizerParams<ToolExecuteArgs> & {\n    credentialsContext: AuthContext;\n  };\n  private credentialsStore: Store<TokenSet>;\n  private authResponseStore: Store<DeviceAuthorizationResponse>;\n\n  constructor(\n    auth0: Partial<Auth0PublicClientParams>,\n    params: DeviceAuthorizerParams<ToolExecuteArgs>\n  ) {\n    this.auth0 = Auth0PublicClientSchema.parse(auth0);\n    if (!this.auth0.domain) {\n      throw new Error(\"Domain is required.\");\n    }\n    if (!this.auth0.clientId) {\n      throw new Error(\"Client ID is required.\");\n    }\n    if (!params.store) {\n      throw new Error(\"Store is required.\");\n    }\n\n    this.params = {\n      credentialsContext: \"thread\",\n      ...params,\n    };\n\n    const instanceID = this.getInstanceID();\n\n    this.credentialsStore = new SubStore(params.store, {\n      baseNamespace: [instanceID, \"Credentials\"],\n      getTTL: (credentials) =>\n        credentials.expiresIn ? credentials.expiresIn * 1000 : undefined,\n    });\n\n    this.authResponseStore = new SubStore(params.store, {\n      baseNamespace: [instanceID, \"AuthResponses\"],\n      getTTL: (authResponse) =>\n        authResponse.expiresIn ? authResponse.expiresIn * 1000 : undefined,\n    });\n  }\n\n  private async start(): Promise<DeviceAuthorizationResponse> {\n    const requestedAt = Date.now() / 1000;\n    const config = await discovery(\n      new URL(`https://${this.auth0.domain!}`),\n      this.auth0.clientId!\n    );\n\n    const handle = await initiateDeviceAuthorization(config, {\n      scope: (this.params.scopes ?? []).join(\" \"),\n      audience: this.params.audience!,\n    });\n\n    return parseDeviceAuthResponse(handle, requestedAt);\n  }\n\n  /**\n   *\n   * Wraps the execute method of a AI tool to handle CIBA authorization.\n   *\n   * @param getContext - A function that returns the context of the tool execution.\n   * @param execute - The tool execute method.\n   * @returns The wrapped execute method.\n   */\n  protect(\n    getContext: ContextGetter<ToolExecuteArgs>,\n    execute: (...args: ToolExecuteArgs) => any\n  ): (...args: ToolExecuteArgs) => any {\n    return async (...args: ToolExecuteArgs) => {\n      let authResponse: DeviceAuthorizationResponse | undefined;\n      if (asyncLocalStorage.getStore()) {\n        throw new Error(\n          \"Cannot nest tool calls that require CIBA authorization.\"\n        );\n      }\n\n      const context = getContext(...args);\n      const storeValue: AsyncStorageValue<any> = {\n        args,\n        context: context,\n      };\n\n      return asyncLocalStorage.run(storeValue, async () => {\n        let credentials: TokenSet | undefined;\n        let credentialsObtained = false;\n        const authResponseNS = nsFromContext(\"tool-call\", context);\n        const credentialsNS = nsFromContext(\n          this.params.credentialsContext,\n          context\n        );\n        try {\n          credentials = await this.credentialsStore.get(\n            credentialsNS,\n            \"credential\"\n          );\n\n          if (!credentials) {\n            if (\n              !this.params.onAuthorizationRequest ||\n              this.params.onAuthorizationRequest === \"interrupt\"\n            ) {\n              authResponse = await this.authResponseStore.get(\n                authResponseNS,\n                \"authResponse\"\n              );\n\n              if (!authResponse) {\n                //Initial request\n                authResponse = await this.start();\n                await this.authResponseStore.put(\n                  authResponseNS,\n                  \"authResponse\",\n                  authResponse\n                );\n              }\n              credentials = await this.getCredentials(authResponse);\n            } else {\n              // Block mode\n              authResponse = await this.start();\n              const credentialsPromise =\n                this.getCredentialsPolling(authResponse);\n              if (typeof this.params.onAuthorizationRequest === \"function\") {\n                await this.params.onAuthorizationRequest(\n                  authResponse,\n                  credentialsPromise\n                );\n              }\n              credentials = await credentialsPromise;\n            }\n\n            if (typeof credentials !== \"undefined\") {\n              this.credentialsStore.put(\n                credentialsNS,\n                \"credential\",\n                credentials\n              );\n            }\n\n            credentialsObtained = true;\n          }\n        } catch (err) {\n          const shouldInterrupt =\n            err instanceof AuthorizationPendingInterrupt ||\n            err instanceof AuthorizationPollingInterrupt;\n          if (shouldInterrupt) {\n            return this.handleAuthorizationInterrupts(err);\n          } else {\n            await this.deleteAuthRequest();\n            if (typeof this.params.onUnauthorized === \"function\") {\n              return this.params.onUnauthorized(err as Error, ...args);\n            } else {\n              return err;\n            }\n          }\n        }\n        if (credentialsObtained) {\n          await this.deleteAuthRequest();\n        }\n        storeValue.credentials = credentials;\n        return execute(...args);\n      });\n    };\n  }\n\n  private async getCredentials(\n    authResponse: DeviceAuthorizationResponse\n  ): Promise<TokenSet | undefined> {\n    //TODO: this is not supported neither by the OIDC client library\n    //      or the auth0 client.\n    const url = `https://${this.auth0.domain!}/oauth/token`;\n    const response = await fetch(url, {\n      method: \"POST\",\n      headers: {\n        \"Content-Type\": \"application/x-www-form-urlencoded\",\n      },\n      body: new URLSearchParams({\n        grant_type: \"urn:ietf:params:oauth:grant-type:device_code\",\n        device_code: authResponse.deviceCode,\n        client_id: this.auth0.clientId!,\n      }),\n    });\n\n    if (!response.ok) {\n      if (response.headers.get(\"content-type\")?.includes(\"application/json\")) {\n        const { error, error_description } = await response.json();\n        if (error === \"authorization_pending\") {\n          throw new AuthorizationPendingInterrupt(\n            error_description,\n            authResponse\n          );\n        }\n        if (error === \"slow_down\") {\n          throw new AuthorizationPollingInterrupt(\n            error_description,\n            authResponse\n          );\n        }\n        if (error === \"expired_token\") {\n          throw new AuthorizationRequestExpiredInterrupt(\n            error_description,\n            authResponse\n          );\n        }\n        if (error === \"access_denied\") {\n          throw new AccessDeniedInterrupt(error_description, authResponse);\n        }\n        throw new Error(error_description);\n      }\n      const errText = await response.text();\n      throw new Error(`Failed to obtain tokens: ${errText}`);\n    }\n\n    const tr = await response.json();\n    const credentials = tokenSetFromTokenResponse(tr);\n\n    return credentials;\n  }\n\n  protected async getCredentialsPolling(\n    authResponse: DeviceAuthorizationResponse\n  ): Promise<TokenSet | undefined> {\n    let credentials: TokenSet | undefined = undefined;\n\n    do {\n      try {\n        credentials = await this.getCredentials(authResponse);\n      } catch (err) {\n        if (\n          err instanceof AuthorizationPendingInterrupt ||\n          err instanceof AuthorizationPollingInterrupt\n        ) {\n          await sleep((err.response.interval ?? 10) * 1000);\n        } else {\n          throw err;\n        }\n      }\n    } while (!credentials);\n\n    return credentials;\n  }\n\n  private getInstanceID(): string {\n    const props = {\n      auth0: this.auth0,\n      params: omit(this.params, [\"store\", \"onUnauthorized\"]),\n    };\n    const sh = stableHash(props);\n    return crypto.createHash(\"MD5\").update(sh).digest(\"hex\");\n  }\n\n  protected deleteAuthRequest() {\n    const store = asyncLocalStorage.getStore();\n    if (!store) {\n      throw new Error(\"This method should be called from within a tool.\");\n    }\n    const authResponseNS = nsFromContext(\"tool-call\", store.context);\n    return this.authResponseStore.delete(authResponseNS, \"authResponse\");\n  }\n\n  protected handleAuthorizationInterrupts(\n    err: AuthorizationPendingInterrupt | AuthorizationPollingInterrupt\n  ) {\n    throw err;\n  }\n}\n"]}

package/dist/esm/authorizers/device-authorizer/DeviceAuthorizerParams.d.ts

@@ -0,0 +1,58 @@
+import { TokenSet } from "../../credentials";
+import { DeviceInterrupt } from "../../interrupts/DeviceInterrupts";
+import { Store } from "../../stores";
+import { AuthContext } from "../context";
+import { OnAuthorizationRequest } from "../types";
+import { DeviceAuthorizationResponse } from "./DeviceAuthResponse";
+/**
+ * The parameters for the DeviceAuthorizer.
+ */
+export type DeviceAuthorizerParams<ToolExecuteArgs extends any[]> = {
+    /**
+     * The scopes to request.
+     */
+    scopes: string[];
+    /**
+     * The audience to request.
+     */
+    audience?: string;
+    /**
+     * The authorization response store.
+     * Allows to store the authorization response for resuming the tool execution
+     * after the interrupt.
+     */
+    store: Store;
+    /**
+     * AuthContext defines the scope of credential sharing:
+     * - "tool-call": Credentials are valid only for a single invocation of the tool.
+     * - "tool": Credentials are shared across multiple calls to the same tool within the same thread.
+     * - "thread": Credentials are shared across all tools using the same authorizer within the current thread.
+     * - "agent": Credentials are shared globally across all threads and tools in the agent.
+     *
+     * @default "thread"
+     */
+    credentialsContext?: AuthContext;
+    /**
+     * The behavior when the authorization request is made.
+     *
+     * - `block`: The tool execution is blocked until the user completes the authorization.
+     * - `interrupt`: The tool execution is interrupted until the user completes the authorization.
+     * - a callback: Same as "block" but give access to the auth request this allow you
+     *               to show the link/code and open the browser
+     *
+     * Defaults to `interrupt`.
+     * Note: The block mode is only useful for development purposes and should not be used in production.
+     */
+    onAuthorizationRequest?: OnAuthorizationRequest | ((authReq: DeviceAuthorizationResponse, poll: Promise<TokenSet | undefined>) => Promise<void>);
+    /**
+     *
+     * A callback that is called when the authorization request is unsuccessful.
+     *
+     * @param err - The error that occurred.
+     * @param args - The tool execution arguments.
+     * @returns - The final response the tool will return.
+     */
+    onUnauthorized?: (err: Error | DeviceInterrupt, ...args: ToolExecuteArgs) => any;
+};
+export type { DeviceAuthorizationResponse };
+//# sourceMappingURL=DeviceAuthorizerParams.d.ts.map

package/dist/esm/authorizers/device-authorizer/DeviceAuthorizerParams.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DeviceAuthorizerParams.js.map

package/dist/esm/authorizers/device-authorizer/DeviceAuthorizerParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceAuthorizerParams.js","sourceRoot":"","sources":["../../../../src/authorizers/device-authorizer/DeviceAuthorizerParams.ts"],"names":[],"mappings":"","sourcesContent":["import { TokenSet } from \"../../credentials\";\nimport { DeviceInterrupt } from \"../../interrupts/DeviceInterrupts\";\nimport { Store } from \"../../stores\";\nimport { AuthContext } from \"../context\";\nimport { OnAuthorizationRequest } from \"../types\";\nimport { DeviceAuthorizationResponse } from \"./DeviceAuthResponse\";\n\n/**\n * The parameters for the DeviceAuthorizer.\n */\nexport type DeviceAuthorizerParams<ToolExecuteArgs extends any[]> = {\n  /**\n   * The scopes to request.\n   */\n  scopes: string[];\n\n  /**\n   * The audience to request.\n   */\n  audience?: string;\n\n  /**\n   * The authorization response store.\n   * Allows to store the authorization response for resuming the tool execution\n   * after the interrupt.\n   */\n  store: Store;\n\n  /**\n   * AuthContext defines the scope of credential sharing:\n   * - \"tool-call\": Credentials are valid only for a single invocation of the tool.\n   * - \"tool\": Credentials are shared across multiple calls to the same tool within the same thread.\n   * - \"thread\": Credentials are shared across all tools using the same authorizer within the current thread.\n   * - \"agent\": Credentials are shared globally across all threads and tools in the agent.\n   *\n   * @default \"thread\"\n   */\n  credentialsContext?: AuthContext;\n\n  /**\n   * The behavior when the authorization request is made.\n   *\n   * - `block`: The tool execution is blocked until the user completes the authorization.\n   * - `interrupt`: The tool execution is interrupted until the user completes the authorization.\n   * - a callback: Same as \"block\" but give access to the auth request this allow you\n   *               to show the link/code and open the browser\n   *\n   * Defaults to `interrupt`.\n   * Note: The block mode is only useful for development purposes and should not be used in production.\n   */\n  onAuthorizationRequest?:\n    | OnAuthorizationRequest\n    | ((\n        authReq: DeviceAuthorizationResponse,\n        poll: Promise<TokenSet | undefined>\n      ) => Promise<void>);\n\n  /**\n   *\n   * A callback that is called when the authorization request is unsuccessful.\n   *\n   * @param err - The error that occurred.\n   * @param args - The tool execution arguments.\n   * @returns - The final response the tool will return.\n   */\n  onUnauthorized?: (\n    err: Error | DeviceInterrupt,\n    ...args: ToolExecuteArgs\n  ) => any;\n};\n\nexport type { DeviceAuthorizationResponse };\n"]}

package/dist/esm/authorizers/device-authorizer/asyncLocalStorage.d.ts

@@ -0,0 +1,16 @@
+import { AsyncLocalStorage } from "async_hooks";
+import { TokenSet } from "../../credentials";
+export type AsyncStorageValue<TContext> = {
+    credentials?: TokenSet;
+    /**
+     * The tool execution context.
+     */
+    context: TContext;
+    /**
+     * The tool execution arguments.
+     */
+    args: any[];
+};
+export declare const asyncLocalStorage: AsyncLocalStorage<AsyncStorageValue<any>>;
+export declare const getDeviceAuthorizerCredentials: () => TokenSet | undefined;
+//# sourceMappingURL=asyncLocalStorage.d.ts.map

package/dist/esm/authorizers/device-authorizer/asyncLocalStorage.js

@@ -0,0 +1,10 @@
+import { AsyncLocalStorage } from "async_hooks";
+export const asyncLocalStorage = new AsyncLocalStorage();
+export const getDeviceAuthorizerCredentials = () => {
+    const t = asyncLocalStorage.getStore();
+    if (typeof t === "undefined") {
+        throw new Error("The tool must be wrapped with the withAsyncUserConfirmation function.");
+    }
+    return t.credentials;
+};
+//# sourceMappingURL=asyncLocalStorage.js.map

package/dist/esm/authorizers/device-authorizer/asyncLocalStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncLocalStorage.js","sourceRoot":"","sources":["../../../../src/authorizers/device-authorizer/asyncLocalStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAkBhD,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,EAEnD,CAAC;AAEJ,MAAM,CAAC,MAAM,8BAA8B,GAAG,GAAG,EAAE;IACjD,MAAM,CAAC,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;IACvC,IAAI,OAAO,CAAC,KAAK,WAAW,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,uEAAuE,CACxE,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC,WAAW,CAAC;AACvB,CAAC,CAAC","sourcesContent":["import { AsyncLocalStorage } from \"async_hooks\";\n\nimport { TokenSet } from \"../../credentials\";\n\nexport type AsyncStorageValue<TContext> = {\n  credentials?: TokenSet;\n\n  /**\n   * The tool execution context.\n   */\n  context: TContext;\n\n  /**\n   * The tool execution arguments.\n   */\n  args: any[];\n};\n\nexport const asyncLocalStorage = new AsyncLocalStorage<\n  AsyncStorageValue<any>\n>();\n\nexport const getDeviceAuthorizerCredentials = () => {\n  const t = asyncLocalStorage.getStore();\n  if (typeof t === \"undefined\") {\n    throw new Error(\n      \"The tool must be wrapped with the withAsyncUserConfirmation function.\"\n    );\n  }\n  return t.credentials;\n};\n"]}

package/dist/esm/authorizers/device-authorizer/index.d.ts

@@ -0,0 +1,4 @@
+export { getDeviceAuthorizerCredentials, asyncLocalStorage, } from "./asyncLocalStorage";
+export { DeviceAuthorizerBase } from "./DeviceAuthorizerBase";
+export type { DeviceAuthorizerParams, DeviceAuthorizationResponse, } from "./DeviceAuthorizerParams";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/authorizers/device-authorizer/index.js

@@ -0,0 +1,3 @@
+export { getDeviceAuthorizerCredentials, asyncLocalStorage, } from "./asyncLocalStorage";
+export { DeviceAuthorizerBase } from "./DeviceAuthorizerBase";
+//# sourceMappingURL=index.js.map

package/dist/esm/authorizers/device-authorizer/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/authorizers/device-authorizer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAC9B,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC","sourcesContent":["export {\n  getDeviceAuthorizerCredentials,\n  asyncLocalStorage,\n} from \"./asyncLocalStorage\";\n\nexport { DeviceAuthorizerBase } from \"./DeviceAuthorizerBase\";\n\nexport type {\n  DeviceAuthorizerParams,\n  DeviceAuthorizationResponse,\n} from \"./DeviceAuthorizerParams\";\n"]}

package/dist/esm/authorizers/federated-connections/FederatedConnectionAuthorizerBase.d.ts

@@ -0,0 +1,30 @@
+import { TokenResponse, TokenSet } from "../../credentials";
+import { Auth0Interrupt } from "../../interrupts";
+import { ContextGetter } from "../context";
+import { Auth0ClientParams } from "../types";
+import { FederatedConnectionAuthorizerParams } from "./FederatedConnectionAuthorizerParams";
+/**
+ * Requests authorization to a third party service via Federated Connection.
+ */
+export declare class FederatedConnectionAuthorizerBase<ToolExecuteArgs extends any[]> {
+    private readonly auth0;
+    private readonly params;
+    private readonly credentialsStore;
+    constructor(auth0: Partial<Auth0ClientParams>, params: FederatedConnectionAuthorizerParams<ToolExecuteArgs>);
+    private getInstanceID;
+    protected handleAuthorizationInterrupts(err: Auth0Interrupt): void;
+    protected validateToken(tokenResponse?: TokenResponse): void;
+    private getAccessTokenImpl;
+    protected getAccessToken(...toolContext: ToolExecuteArgs): Promise<TokenSet>;
+    protected getRefreshToken(...toolContext: ToolExecuteArgs): Promise<string | undefined>;
+    /**
+     *
+     * Wraps the execute method of an AI tool to handle Federated Connections authorization.
+     *
+     * @param getContext - A function that returns the context of the tool execution.
+     * @param execute - The tool execute method.
+     * @returns The wrapped execute method.
+     */
+    protect(getContext: ContextGetter<ToolExecuteArgs>, execute: (...args: ToolExecuteArgs) => any): (...args: ToolExecuteArgs) => any;
+}
+//# sourceMappingURL=FederatedConnectionAuthorizerBase.d.ts.map

package/dist/esm/authorizers/federated-connections/FederatedConnectionAuthorizerBase.js

@@ -0,0 +1,151 @@
+import crypto from "crypto";
+import stableHash from "stable-hash";
+import { tokenSetFromTokenResponse, } from "../../credentials";
+import { Auth0Interrupt, FederatedConnectionError, FederatedConnectionInterrupt, } from "../../interrupts";
+import { resolveParameter } from "../../parameters";
+import { SubStore } from "../../stores";
+import { omit } from "../../util";
+import { nsFromContext } from "../context";
+import { Auth0ClientSchema } from "../types";
+import { asyncLocalStorage } from "./asyncLocalStorage";
+/**
+ * Requests authorization to a third party service via Federated Connection.
+ */
+export class FederatedConnectionAuthorizerBase {
+    constructor(auth0, params) {
+        this.auth0 = Auth0ClientSchema.parse(auth0);
+        this.params = {
+            credentialsContext: "thread",
+            ...params,
+        };
+        const instanceID = this.getInstanceID();
+        this.credentialsStore = new SubStore(params.store, {
+            baseNamespace: [instanceID, "Credentials"],
+            getTTL: (credentials) => credentials.expiresIn ? credentials.expiresIn * 1000 : undefined,
+        });
+        if (typeof params.refreshToken === "undefined" &&
+            typeof params.accessToken === "undefined") {
+            throw new Error("Either refreshToken or accessToken must be provided to initialize the Authorizer.");
+        }
+        if (typeof params.accessToken !== "undefined" &&
+            typeof params.refreshToken !== "undefined") {
+            throw new Error("Only one of refreshToken or accessToken can be provided to initialize the Authorizer.");
+        }
+    }
+    getInstanceID() {
+        const props = {
+            auth0: this.auth0,
+            params: omit(this.params, ["store", "refreshToken", "accessToken"]),
+        };
+        const sh = stableHash(props);
+        return crypto.createHash("MD5").update(sh).digest("hex");
+    }
+    handleAuthorizationInterrupts(err) {
+        throw err;
+    }
+    validateToken(tokenResponse) {
+        var _a;
+        const store = asyncLocalStorage.getStore();
+        if (!store) {
+            throw new Error("The tool must be wrapped with the FederationConnectionAuthorizer.");
+        }
+        const { scopes, connection } = store;
+        if (!tokenResponse) {
+            throw new FederatedConnectionInterrupt(`Authorization required to access the Federated Connection: ${this.params.connection}`, connection, scopes, scopes);
+        }
+        const currentScopes = ((_a = tokenResponse.scope) !== null && _a !== void 0 ? _a : "").split(" ");
+        const missingScopes = scopes.filter((s) => !currentScopes.includes(s));
+        store.currentScopes = currentScopes;
+        if (missingScopes.length > 0) {
+            throw new FederatedConnectionInterrupt(`Authorization required to access the Federated Connection: ${this.params.connection}. Missing scopes: ${missingScopes.join(", ")}`, connection, scopes, [...currentScopes, ...scopes]);
+        }
+    }
+    async getAccessTokenImpl(...toolContext) {
+        const store = asyncLocalStorage.getStore();
+        if (!store) {
+            throw new Error("The tool must be wrapped with the FederationConnectionAuthorizer.");
+        }
+        const { connection } = store;
+        const subjectToken = await this.getRefreshToken(...toolContext);
+        if (!subjectToken) {
+            return;
+        }
+        const exchangeParams = {
+            grant_type: "urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token",
+            client_id: this.auth0.clientId,
+            client_secret: this.auth0.clientSecret,
+            subject_token_type: "urn:ietf:params:oauth:token-type:refresh_token",
+            subject_token: subjectToken,
+            connection: connection,
+            requested_token_type: "http://auth0.com/oauth/token-type/federated-connection-access-token",
+        };
+        const res = await fetch(`https://${this.auth0.domain}/oauth/token`, {
+            method: "POST",
+            headers: { "Content-Type": "application/json" },
+            body: JSON.stringify(exchangeParams),
+        });
+        if (!res.ok) {
+            return;
+        }
+        const tokenResponse = await res.json();
+        return tokenResponse;
+    }
+    async getAccessToken(...toolContext) {
+        let tokenResponse;
+        if (typeof this.params.refreshToken === "function") {
+            tokenResponse = await this.getAccessTokenImpl(...toolContext);
+        }
+        else {
+            tokenResponse = await resolveParameter(this.params.accessToken, toolContext);
+        }
+        this.validateToken(tokenResponse);
+        return tokenSetFromTokenResponse(tokenResponse);
+    }
+    async getRefreshToken(...toolContext) {
+        return await resolveParameter(this.params.refreshToken, toolContext);
+    }
+    /**
+     *
+     * Wraps the execute method of an AI tool to handle Federated Connections authorization.
+     *
+     * @param getContext - A function that returns the context of the tool execution.
+     * @param execute - The tool execute method.
+     * @returns The wrapped execute method.
+     */
+    protect(getContext, execute) {
+        return async (...args) => {
+            const context = getContext(...args);
+            const asyncStore = {
+                context: context,
+                scopes: this.params.scopes,
+                connection: this.params.connection,
+            };
+            if (asyncLocalStorage.getStore()) {
+                throw new Error("Cannot nest tool calls that require federated connection authorization.");
+            }
+            return asyncLocalStorage.run(asyncStore, async () => {
+                const credentialsNS = nsFromContext(this.params.credentialsContext, context);
+                try {
+                    let credentials = await this.credentialsStore.get(credentialsNS, "credential");
+                    if (!credentials) {
+                        credentials = await this.getAccessToken(...args);
+                        await this.credentialsStore.put(credentialsNS, "credential", credentials);
+                    }
+                    asyncStore.credentials = credentials;
+                    return await execute(...args);
+                }
+                catch (err) {
+                    if (err instanceof FederatedConnectionError) {
+                        const interrupt = new FederatedConnectionInterrupt(err.message, asyncStore.connection, asyncStore.scopes, asyncStore.scopes);
+                        return this.handleAuthorizationInterrupts(interrupt);
+                    }
+                    if (err instanceof Auth0Interrupt) {
+                        return this.handleAuthorizationInterrupts(err);
+                    }
+                    throw err;
+                }
+            });
+        };
+    }
+}
+//# sourceMappingURL=FederatedConnectionAuthorizerBase.js.map

package/dist/esm/authorizers/federated-connections/FederatedConnectionAuthorizerBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FederatedConnectionAuthorizerBase.js","sourceRoot":"","sources":["../../../../src/authorizers/federated-connections/FederatedConnectionAuthorizerBase.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,UAAU,MAAM,aAAa,CAAC;AAErC,OAAO,EAGL,yBAAyB,GAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,IAAI,EAAiB,MAAM,YAAY,CAAC;AACjD,OAAO,EAAiB,aAAa,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAqB,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAqB,MAAM,qBAAqB,CAAC;AAG3E;;GAEG;AAEH,MAAM,OAAO,iCAAiC;IAQ5C,YACE,KAAiC,EACjC,MAA4D;QAE5D,IAAI,CAAC,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG;YACZ,kBAAkB,EAAE,QAAQ;YAC5B,GAAG,MAAM;SACV,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAExC,IAAI,CAAC,gBAAgB,GAAG,IAAI,QAAQ,CAAW,MAAM,CAAC,KAAK,EAAE;YAC3D,aAAa,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC;YAC1C,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CACtB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;SACnE,CAAC,CAAC;QAEH,IACE,OAAO,MAAM,CAAC,YAAY,KAAK,WAAW;YAC1C,OAAO,MAAM,CAAC,WAAW,KAAK,WAAW,EACzC,CAAC;YACD,MAAM,IAAI,KAAK,CACb,mFAAmF,CACpF,CAAC;QACJ,CAAC;QAED,IACE,OAAO,MAAM,CAAC,WAAW,KAAK,WAAW;YACzC,OAAO,MAAM,CAAC,YAAY,KAAK,WAAW,EAC1C,CAAC;YACD,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,aAAa;QACnB,MAAM,KAAK,GAAG;YACZ,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;SACpE,CAAC;QACF,MAAM,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;IAES,6BAA6B,CAAC,GAAmB;QACzD,MAAM,GAAG,CAAC;IACZ,CAAC;IAES,aAAa,CAAC,aAA6B;;QACnD,MAAM,KAAK,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAC3C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAErC,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,4BAA4B,CACpC,8DAA8D,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EACtF,UAAU,EACV,MAAM,EACN,MAAM,CACP,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,CAAC,MAAA,aAAa,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7D,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,KAAK,CAAC,aAAa,GAAG,aAAa,CAAC;QAEpC,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,4BAA4B,CACpC,8DAA8D,IAAI,CAAC,MAAM,CAAC,UAAU,qBAAqB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EACnI,UAAU,EACV,MAAM,EACN,CAAC,GAAG,aAAa,EAAE,GAAG,MAAM,CAAC,CAC9B,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,GAAG,WAA4B;QAE/B,MAAM,KAAK,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAC3C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAE7B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC,CAAC;QAEhE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,cAAc,GAAG;YACrB,UAAU,EACR,oFAAoF;YACtF,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;YAC9B,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;YACtC,kBAAkB,EAAE,gDAAgD;YACpE,aAAa,EAAE,YAAY;YAC3B,UAAU,EAAE,UAAU;YACtB,oBAAoB,EAClB,qEAAqE;SACxE,CAAC;QAEF,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,MAAM,cAAc,EAAE;YAClE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;SACrC,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAkB,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QACtD,OAAO,aAAa,CAAC;IACvB,CAAC;IAES,KAAK,CAAC,cAAc,CAC5B,GAAG,WAA4B;QAE/B,IAAI,aAAwC,CAAC;QAC7C,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;YACnD,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,aAAa,GAAG,MAAM,gBAAgB,CACpC,IAAI,CAAC,MAAM,CAAC,WAAY,EACxB,WAAW,CACZ,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAClC,OAAO,yBAAyB,CAAC,aAAc,CAAC,CAAC;IACnD,CAAC;IAES,KAAK,CAAC,eAAe,CAAC,GAAG,WAA4B;QAC7D,OAAO,MAAM,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,UAA0C,EAC1C,OAA0C;QAE1C,OAAO,KAAK,EAAE,GAAG,IAAqB,EAAE,EAAE;YACxC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;YACpC,MAAM,UAAU,GAAsB;gBACpC,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;gBAC1B,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;aACnC,CAAC;YAEF,IAAI,iBAAiB,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,yEAAyE,CAC1E,CAAC;YACJ,CAAC;YAED,OAAO,iBAAiB,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE;gBAClD,MAAM,aAAa,GAAG,aAAa,CACjC,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAC9B,OAAO,CACR,CAAC;gBACF,IAAI,CAAC;oBACH,IAAI,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC/C,aAAa,EACb,YAAY,CACb,CAAC;oBACF,IAAI,CAAC,WAAW,EAAE,CAAC;wBACjB,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;wBACjD,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC7B,aAAa,EACb,YAAY,EACZ,WAAW,CACZ,CAAC;oBACJ,CAAC;oBACD,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC;oBACrC,OAAO,MAAM,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;gBAChC,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,GAAG,YAAY,wBAAwB,EAAE,CAAC;wBAC5C,MAAM,SAAS,GAAG,IAAI,4BAA4B,CAChD,GAAG,CAAC,OAAO,EACX,UAAU,CAAC,UAAU,EACrB,UAAU,CAAC,MAAM,EACjB,UAAU,CAAC,MAAM,CAClB,CAAC;wBACF,OAAO,IAAI,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;oBACvD,CAAC;oBACD,IAAI,GAAG,YAAY,cAAc,EAAE,CAAC;wBAClC,OAAO,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC;oBACjD,CAAC;oBACD,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;IACJ,CAAC;CACF","sourcesContent":["import crypto from \"crypto\";\nimport stableHash from \"stable-hash\";\n\nimport {\n  TokenResponse,\n  TokenSet,\n  tokenSetFromTokenResponse,\n} from \"../../credentials\";\nimport {\n  Auth0Interrupt,\n  FederatedConnectionError,\n  FederatedConnectionInterrupt,\n} from \"../../interrupts\";\nimport { resolveParameter } from \"../../parameters\";\nimport { SubStore } from \"../../stores\";\nimport { omit, RequireFields } from \"../../util\";\nimport { ContextGetter, nsFromContext } from \"../context\";\nimport { Auth0ClientParams, Auth0ClientSchema } from \"../types\";\nimport { asyncLocalStorage, AsyncStorageValue } from \"./asyncLocalStorage\";\nimport { FederatedConnectionAuthorizerParams } from \"./FederatedConnectionAuthorizerParams\";\n\n/**\n * Requests authorization to a third party service via Federated Connection.\n */\n\nexport class FederatedConnectionAuthorizerBase<ToolExecuteArgs extends any[]> {\n  private readonly auth0: Auth0ClientParams;\n  private readonly params: RequireFields<\n    FederatedConnectionAuthorizerParams<ToolExecuteArgs>,\n    \"credentialsContext\"\n  >;\n  private readonly credentialsStore: SubStore<TokenSet>;\n\n  constructor(\n    auth0: Partial<Auth0ClientParams>,\n    params: FederatedConnectionAuthorizerParams<ToolExecuteArgs>\n  ) {\n    this.auth0 = Auth0ClientSchema.parse(auth0);\n    this.params = {\n      credentialsContext: \"thread\",\n      ...params,\n    };\n\n    const instanceID = this.getInstanceID();\n\n    this.credentialsStore = new SubStore<TokenSet>(params.store, {\n      baseNamespace: [instanceID, \"Credentials\"],\n      getTTL: (credentials) =>\n        credentials.expiresIn ? credentials.expiresIn * 1000 : undefined,\n    });\n\n    if (\n      typeof params.refreshToken === \"undefined\" &&\n      typeof params.accessToken === \"undefined\"\n    ) {\n      throw new Error(\n        \"Either refreshToken or accessToken must be provided to initialize the Authorizer.\"\n      );\n    }\n\n    if (\n      typeof params.accessToken !== \"undefined\" &&\n      typeof params.refreshToken !== \"undefined\"\n    ) {\n      throw new Error(\n        \"Only one of refreshToken or accessToken can be provided to initialize the Authorizer.\"\n      );\n    }\n  }\n\n  private getInstanceID(): string {\n    const props = {\n      auth0: this.auth0,\n      params: omit(this.params, [\"store\", \"refreshToken\", \"accessToken\"]),\n    };\n    const sh = stableHash(props);\n    return crypto.createHash(\"MD5\").update(sh).digest(\"hex\");\n  }\n\n  protected handleAuthorizationInterrupts(err: Auth0Interrupt) {\n    throw err;\n  }\n\n  protected validateToken(tokenResponse?: TokenResponse) {\n    const store = asyncLocalStorage.getStore();\n    if (!store) {\n      throw new Error(\n        \"The tool must be wrapped with the FederationConnectionAuthorizer.\"\n      );\n    }\n\n    const { scopes, connection } = store;\n\n    if (!tokenResponse) {\n      throw new FederatedConnectionInterrupt(\n        `Authorization required to access the Federated Connection: ${this.params.connection}`,\n        connection,\n        scopes,\n        scopes\n      );\n    }\n\n    const currentScopes = (tokenResponse.scope ?? \"\").split(\" \");\n    const missingScopes = scopes.filter((s) => !currentScopes.includes(s));\n    store.currentScopes = currentScopes;\n\n    if (missingScopes.length > 0) {\n      throw new FederatedConnectionInterrupt(\n        `Authorization required to access the Federated Connection: ${this.params.connection}. Missing scopes: ${missingScopes.join(\", \")}`,\n        connection,\n        scopes,\n        [...currentScopes, ...scopes]\n      );\n    }\n  }\n\n  private async getAccessTokenImpl(\n    ...toolContext: ToolExecuteArgs\n  ): Promise<TokenResponse | undefined> {\n    const store = asyncLocalStorage.getStore();\n    if (!store) {\n      throw new Error(\n        \"The tool must be wrapped with the FederationConnectionAuthorizer.\"\n      );\n    }\n\n    const { connection } = store;\n\n    const subjectToken = await this.getRefreshToken(...toolContext);\n\n    if (!subjectToken) {\n      return;\n    }\n\n    const exchangeParams = {\n      grant_type:\n        \"urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token\",\n      client_id: this.auth0.clientId,\n      client_secret: this.auth0.clientSecret,\n      subject_token_type: \"urn:ietf:params:oauth:token-type:refresh_token\",\n      subject_token: subjectToken,\n      connection: connection,\n      requested_token_type:\n        \"http://auth0.com/oauth/token-type/federated-connection-access-token\",\n    };\n\n    const res = await fetch(`https://${this.auth0.domain}/oauth/token`, {\n      method: \"POST\",\n      headers: { \"Content-Type\": \"application/json\" },\n      body: JSON.stringify(exchangeParams),\n    });\n\n    if (!res.ok) {\n      return;\n    }\n\n    const tokenResponse: TokenResponse = await res.json();\n    return tokenResponse;\n  }\n\n  protected async getAccessToken(\n    ...toolContext: ToolExecuteArgs\n  ): Promise<TokenSet> {\n    let tokenResponse: TokenResponse | undefined;\n    if (typeof this.params.refreshToken === \"function\") {\n      tokenResponse = await this.getAccessTokenImpl(...toolContext);\n    } else {\n      tokenResponse = await resolveParameter(\n        this.params.accessToken!,\n        toolContext\n      );\n    }\n    this.validateToken(tokenResponse);\n    return tokenSetFromTokenResponse(tokenResponse!);\n  }\n\n  protected async getRefreshToken(...toolContext: ToolExecuteArgs) {\n    return await resolveParameter(this.params.refreshToken, toolContext);\n  }\n\n  /**\n   *\n   * Wraps the execute method of an AI tool to handle Federated Connections authorization.\n   *\n   * @param getContext - A function that returns the context of the tool execution.\n   * @param execute - The tool execute method.\n   * @returns The wrapped execute method.\n   */\n  protect(\n    getContext: ContextGetter<ToolExecuteArgs>,\n    execute: (...args: ToolExecuteArgs) => any\n  ): (...args: ToolExecuteArgs) => any {\n    return async (...args: ToolExecuteArgs) => {\n      const context = getContext(...args);\n      const asyncStore: AsyncStorageValue = {\n        context: context,\n        scopes: this.params.scopes,\n        connection: this.params.connection,\n      };\n\n      if (asyncLocalStorage.getStore()) {\n        throw new Error(\n          \"Cannot nest tool calls that require federated connection authorization.\"\n        );\n      }\n\n      return asyncLocalStorage.run(asyncStore, async () => {\n        const credentialsNS = nsFromContext(\n          this.params.credentialsContext,\n          context\n        );\n        try {\n          let credentials = await this.credentialsStore.get(\n            credentialsNS,\n            \"credential\"\n          );\n          if (!credentials) {\n            credentials = await this.getAccessToken(...args);\n            await this.credentialsStore.put(\n              credentialsNS,\n              \"credential\",\n              credentials\n            );\n          }\n          asyncStore.credentials = credentials;\n          return await execute(...args);\n        } catch (err) {\n          if (err instanceof FederatedConnectionError) {\n            const interrupt = new FederatedConnectionInterrupt(\n              err.message,\n              asyncStore.connection,\n              asyncStore.scopes,\n              asyncStore.scopes\n            );\n            return this.handleAuthorizationInterrupts(interrupt);\n          }\n          if (err instanceof Auth0Interrupt) {\n            return this.handleAuthorizationInterrupts(err);\n          }\n          throw err;\n        }\n      });\n    };\n  }\n}\n"]}

package/dist/esm/authorizers/federated-connections/FederatedConnectionAuthorizerParams.d.ts

@@ -0,0 +1,38 @@
+import { TokenResponse } from "../../credentials";
+import { AuthorizerToolParameter } from "../../parameters";
+import { Store } from "../../stores";
+import { AuthContext } from "../context";
+export type FederatedConnectionAuthorizerParams<ToolExecuteArgs extends any[]> = {
+    /**
+     * The Auth0 refresh token to exchange for an Federated Connection access token.
+     */
+    refreshToken?: AuthorizerToolParameter<ToolExecuteArgs, string | undefined>;
+    /**
+     * The Federated connection access token if available in the tool context.
+     */
+    accessToken?: AuthorizerToolParameter<ToolExecuteArgs, TokenResponse | undefined>;
+    /**
+     * The scopes required in the access token of the federated connection provider.
+     */
+    scopes: string[];
+    /**
+     * The connection name of the federated connection provider.
+     */
+    connection: string;
+    /**
+     * AuthContext defines the scope of credential sharing:
+     * - "tool-call": Credentials are valid only for a single invocation of the tool.
+     * - "tool": Credentials are shared across multiple calls to the same tool within the same thread.
+     * - "thread": Credentials are shared across all tools using the same authorizer within the current thread.
+     * - "agent": Credentials are shared globally across all threads and tools in the agent.
+     *
+     * @default "thread"
+     */
+    credentialsContext?: AuthContext;
+    /**
+     * An store used to store the authorization credentials according
+     * to the `credentialsContext` scope.
+     */
+    store: Store;
+};
+//# sourceMappingURL=FederatedConnectionAuthorizerParams.d.ts.map

package/dist/esm/authorizers/federated-connections/FederatedConnectionAuthorizerParams.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=FederatedConnectionAuthorizerParams.js.map