@auth0/ai 1.0.0

package/dist/esm/authorizers/ciba/asyncLocalStorage.d.ts

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

package/dist/esm/authorizers/ciba/asyncLocalStorage.js

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

package/dist/esm/authorizers/ciba/asyncLocalStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncLocalStorage.js","sourceRoot":"","sources":["../../../../src/authorizers/ciba/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,kBAAkB,GAAG,GAAG,EAAE;IACrC,MAAM,CAAC,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;IACvC,IAAI,OAAO,CAAC,KAAK,WAAW,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,CAAC,CAAC,WAAW,CAAC;AACvB,CAAC,CAAC","sourcesContent":["import { AsyncLocalStorage } from \"async_hooks\";\n\nimport { Credentials } from \"../../credentials\";\n\nexport type AsyncStorageValue<TContext> = {\n  credentials?: Credentials;\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 getCIBACredentials = () => {\n  const t = asyncLocalStorage.getStore();\n  if (typeof t === \"undefined\") {\n    throw new Error(\"The tool must be wrapped with the withCIBA function.\");\n  }\n  return t.credentials;\n};\n"]}

package/dist/esm/authorizers/ciba/index.d.ts

@@ -0,0 +1,4 @@
+export { asyncLocalStorage, getCIBACredentials } from "./asyncLocalStorage";
+export type { CIBAAuthorizationRequest } from "./CIBAAuthorizationRequest";
+export { CIBAAuthorizerBase } from "./CIBAAuthorizerBase";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/authorizers/ciba/index.js

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

package/dist/esm/authorizers/ciba/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/authorizers/ciba/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAI5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC","sourcesContent":["export { asyncLocalStorage, getCIBACredentials } from \"./asyncLocalStorage\";\n\nexport type { CIBAAuthorizationRequest } from \"./CIBAAuthorizationRequest\";\n\nexport { CIBAAuthorizerBase } from \"./CIBAAuthorizerBase\";\n"]}

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

@@ -0,0 +1,15 @@
+import { AuthorizerParams, AuthParams, ToolWithAuthHandler } from "./";
+export type DeviceAuthorizerOptions = {
+    scope: string;
+    audience?: string;
+};
+export declare class DeviceAuthorizer {
+    domain: string;
+    clientId: string;
+    private constructor();
+    private _authorize;
+    static authorize(options: DeviceAuthorizerOptions, params?: AuthorizerParams): Promise<AuthParams>;
+    static create(params?: AuthorizerParams): DeviceFlowInstance;
+}
+export type DeviceFlowInstance = (options: DeviceAuthorizerOptions) => <I, O, C>(handler: ToolWithAuthHandler<I, O, C>, onError?: (error: Error) => Promise<O>) => (input: I, config?: C) => Promise<O>;
+//# sourceMappingURL=device-authorizer.d.ts.map

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

@@ -0,0 +1,90 @@
+import Enquirer from "enquirer";
+import * as jose from "jose";
+import open from "open";
+import { discovery, initiateDeviceAuthorization, pollDeviceAuthorizationGrant, } from "openid-client";
+import { AccessDeniedError, AuthorizationRequestExpiredError } from "../errors";
+export class DeviceAuthorizer {
+    constructor(params) {
+        this.domain = (params === null || params === void 0 ? void 0 : params.domain) || process.env.AUTH0_DOMAIN;
+        this.clientId = (params === null || params === void 0 ? void 0 : params.clientId) || process.env.AUTH0_CLIENT_ID;
+    }
+    async _authorize(params) {
+        const config = await discovery(new URL(`https://${this.domain}`), this.clientId);
+        const handle = await initiateDeviceAuthorization(config, {
+            ...params,
+        });
+        const { verification_uri_complete, user_code, expires_in } = handle;
+        const enquirer = new Enquirer();
+        await enquirer.prompt({
+            type: "input",
+            name: "confirmation",
+            message: `Press Enter to open the browser to log in or press Ctrl+C to abort. You should see the following code: ${user_code}. It expires in ${expires_in % 60 === 0
+                ? `${expires_in / 60} minutes`
+                : `${expires_in} seconds`}.`,
+        });
+        await open(verification_uri_complete);
+        let tokens = null;
+        try {
+            tokens = await pollDeviceAuthorizationGrant(config, handle);
+        }
+        catch (err) {
+            switch (err.error) {
+                case "access_denied":
+                    throw new AccessDeniedError(err.error_description);
+                case "expired_token":
+                    throw new AuthorizationRequestExpiredError("Authorization request has expired");
+                default:
+                    throw new Error(`Error: ${err.error}; Description: ${err.error_description}`);
+            }
+        }
+        if (!tokens) {
+            throw new Error("Failed to obtain tokens");
+        }
+        const credentials = {
+            accessToken: {
+                type: tokens.token_type || "bearer",
+                value: tokens.access_token,
+            },
+        };
+        if (tokens.id_token) {
+            credentials.idToken = {
+                type: tokens.token_type || "bearer",
+                value: tokens.id_token,
+            };
+        }
+        return credentials;
+    }
+    static async authorize(options, params) {
+        const authorizer = new DeviceAuthorizer(params);
+        const credentials = await authorizer._authorize(options);
+        let claims = {};
+        if (credentials.idToken) {
+            claims = jose.decodeJwt(credentials.idToken.value);
+        }
+        return { accessToken: credentials.accessToken.value, claims };
+    }
+    static create(params) {
+        const authorizer = new DeviceAuthorizer(params);
+        return (options) => {
+            return function deviceFlow(handler, onError) {
+                return async (input, config) => {
+                    try {
+                        const credentials = await authorizer._authorize(options);
+                        let claims = {};
+                        if (credentials.idToken) {
+                            claims = jose.decodeJwt(credentials.idToken.value);
+                        }
+                        return handler({ accessToken: credentials.accessToken.value, claims }, input, config);
+                    }
+                    catch (e) {
+                        if (typeof onError === "function") {
+                            return onError(e);
+                        }
+                        return "Access denied.";
+                    }
+                };
+            };
+        };
+    }
+}
+//# sourceMappingURL=device-authorizer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"device-authorizer.js","sourceRoot":"","sources":["../../../src/authorizers/device-authorizer.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EACL,SAAS,EACT,2BAA2B,EAC3B,4BAA4B,GAG7B,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,iBAAiB,EAAE,gCAAgC,EAAE,MAAM,WAAW,CAAC;AAQhF,MAAM,OAAO,gBAAgB;IAI3B,YAAoB,MAAyB;QAC3C,IAAI,CAAC,MAAM,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,KAAI,OAAO,CAAC,GAAG,CAAC,YAAa,CAAC;QAC1D,IAAI,CAAC,QAAQ,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,KAAI,OAAO,CAAC,GAAG,CAAC,eAAgB,CAAC;IACnE,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,MAA+B;QAE/B,MAAM,MAAM,GAAG,MAAM,SAAS,CAC5B,IAAI,GAAG,CAAC,WAAW,IAAI,CAAC,MAAM,EAAE,CAAC,EACjC,IAAI,CAAC,QAAQ,CACd,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,2BAA2B,CAAC,MAAM,EAAE;YACvD,GAAG,MAAM;SACV,CAAC,CAAC;QAEH,MAAM,EAAE,yBAAyB,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAEpE,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,MAAM,QAAQ,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,0GAA0G,SAAS,mBAC1H,UAAU,GAAG,EAAE,KAAK,CAAC;gBACnB,CAAC,CAAC,GAAG,UAAU,GAAG,EAAE,UAAU;gBAC9B,CAAC,CAAC,GAAG,UAAU,UACnB,GAAG;SACJ,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,yBAA0B,CAAC,CAAC;QAEvC,IAAI,MAAM,GACR,IAAI,CAAC;QAEP,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,QAAQ,GAAG,CAAC,KAAK,EAAE,CAAC;gBAClB,KAAK,eAAe;oBAClB,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBACrD,KAAK,eAAe;oBAClB,MAAM,IAAI,gCAAgC,CACxC,mCAAmC,CACpC,CAAC;gBACJ;oBACE,MAAM,IAAI,KAAK,CACb,UAAU,GAAG,CAAC,KAAK,kBAAkB,GAAG,CAAC,iBAAiB,EAAE,CAC7D,CAAC;YACN,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,WAAW,GAAgB;YAC/B,WAAW,EAAE;gBACX,IAAI,EAAE,MAAM,CAAC,UAAU,IAAI,QAAQ;gBACnC,KAAK,EAAE,MAAM,CAAC,YAAY;aAC3B;SACF,CAAC;QAEF,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,WAAW,CAAC,OAAO,GAAG;gBACpB,IAAI,EAAE,MAAM,CAAC,UAAU,IAAI,QAAQ;gBACnC,KAAK,EAAE,MAAM,CAAC,QAAQ;aACvB,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,SAAS,CACpB,OAAgC,EAChC,MAAyB;QAEzB,MAAM,UAAU,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEzD,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,OAAQ,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAgB,CAAC;IAC9E,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,MAAyB;QACrC,MAAM,UAAU,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEhD,OAAO,CAAC,OAAgC,EAAE,EAAE;YAC1C,OAAO,SAAS,UAAU,CACxB,OAAqC,EACrC,OAAsC;gBAEtC,OAAO,KAAK,EAAE,KAAQ,EAAE,MAAU,EAAc,EAAE;oBAChD,IAAI,CAAC;wBACH,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;wBACzD,IAAI,MAAM,GAAG,EAAE,CAAC;wBAEhB,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;4BACxB,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,OAAQ,CAAC,KAAK,CAAC,CAAC;wBACtD,CAAC;wBAED,OAAO,OAAO,CACZ,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EACtD,KAAK,EACL,MAAM,CACP,CAAC;oBACJ,CAAC;oBAAC,OAAO,CAAM,EAAE,CAAC;wBAChB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;4BAClC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;wBACpB,CAAC;wBAED,OAAO,gBAAqB,CAAC;oBAC/B,CAAC;gBACH,CAAC,CAAC;YACJ,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;CACF","sourcesContent":["import Enquirer from \"enquirer\";\nimport * as jose from \"jose\";\nimport open from \"open\";\nimport {\n  discovery,\n  initiateDeviceAuthorization,\n  pollDeviceAuthorizationGrant,\n  TokenEndpointResponse,\n  TokenEndpointResponseHelpers,\n} from \"openid-client\";\n\nimport { Credentials } from \"../credentials\";\nimport { AccessDeniedError, AuthorizationRequestExpiredError } from \"../errors\";\nimport { AuthorizerParams, AuthParams, ToolWithAuthHandler } from \"./\";\n\nexport type DeviceAuthorizerOptions = {\n  scope: string;\n  audience?: string;\n};\n\nexport class DeviceAuthorizer {\n  domain: string;\n  clientId: string;\n\n  private constructor(params?: AuthorizerParams) {\n    this.domain = params?.domain || process.env.AUTH0_DOMAIN!;\n    this.clientId = params?.clientId || process.env.AUTH0_CLIENT_ID!;\n  }\n\n  private async _authorize(\n    params: DeviceAuthorizerOptions\n  ): Promise<Credentials> {\n    const config = await discovery(\n      new URL(`https://${this.domain}`),\n      this.clientId\n    );\n\n    const handle = await initiateDeviceAuthorization(config, {\n      ...params,\n    });\n\n    const { verification_uri_complete, user_code, expires_in } = handle;\n\n    const enquirer = new Enquirer();\n    await enquirer.prompt({\n      type: \"input\",\n      name: \"confirmation\",\n      message: `Press Enter to open the browser to log in or press Ctrl+C to abort. You should see the following code: ${user_code}. It expires in ${\n        expires_in % 60 === 0\n          ? `${expires_in / 60} minutes`\n          : `${expires_in} seconds`\n      }.`,\n    });\n\n    await open(verification_uri_complete!);\n\n    let tokens: (TokenEndpointResponse & TokenEndpointResponseHelpers) | null =\n      null;\n\n    try {\n      tokens = await pollDeviceAuthorizationGrant(config, handle);\n    } catch (err: any) {\n      switch (err.error) {\n        case \"access_denied\":\n          throw new AccessDeniedError(err.error_description);\n        case \"expired_token\":\n          throw new AuthorizationRequestExpiredError(\n            \"Authorization request has expired\"\n          );\n        default:\n          throw new Error(\n            `Error: ${err.error}; Description: ${err.error_description}`\n          );\n      }\n    }\n\n    if (!tokens) {\n      throw new Error(\"Failed to obtain tokens\");\n    }\n\n    const credentials: Credentials = {\n      accessToken: {\n        type: tokens.token_type || \"bearer\",\n        value: tokens.access_token,\n      },\n    };\n\n    if (tokens.id_token) {\n      credentials.idToken = {\n        type: tokens.token_type || \"bearer\",\n        value: tokens.id_token,\n      };\n    }\n\n    return credentials;\n  }\n\n  static async authorize(\n    options: DeviceAuthorizerOptions,\n    params?: AuthorizerParams\n  ) {\n    const authorizer = new DeviceAuthorizer(params);\n    const credentials = await authorizer._authorize(options);\n\n    let claims = {};\n\n    if (credentials.idToken) {\n      claims = jose.decodeJwt(credentials.idToken!.value);\n    }\n\n    return { accessToken: credentials.accessToken.value, claims } as AuthParams;\n  }\n\n  static create(params?: AuthorizerParams): DeviceFlowInstance {\n    const authorizer = new DeviceAuthorizer(params);\n\n    return (options: DeviceAuthorizerOptions) => {\n      return function deviceFlow<I, O, C>(\n        handler: ToolWithAuthHandler<I, O, C>,\n        onError?: (error: Error) => Promise<O>\n      ) {\n        return async (input: I, config?: C): Promise<O> => {\n          try {\n            const credentials = await authorizer._authorize(options);\n            let claims = {};\n\n            if (credentials.idToken) {\n              claims = jose.decodeJwt(credentials.idToken!.value);\n            }\n\n            return handler(\n              { accessToken: credentials.accessToken.value, claims },\n              input,\n              config\n            );\n          } catch (e: any) {\n            if (typeof onError === \"function\") {\n              return onError(e);\n            }\n\n            return \"Access denied.\" as O;\n          }\n        };\n      };\n    };\n  }\n}\n\nexport type DeviceFlowInstance = (\n  options: DeviceAuthorizerOptions\n) => <I, O, C>(\n  handler: ToolWithAuthHandler<I, O, C>,\n  onError?: (error: Error) => Promise<O>\n) => (input: I, config?: C) => Promise<O>;\n"]}

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

@@ -0,0 +1,26 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+export type AsyncStorageValue<TContext> = {
+    /**
+     * The Federated Connection access token.
+     */
+    accessToken?: string;
+    /**
+     * The tool execution context.
+     */
+    context: TContext;
+    /**
+     * The federated connection name.
+     */
+    connection: string;
+    /**
+     * The scopes required to access the federated connection.
+     */
+    scopes: string[];
+    /**
+     * The scopes that the current access token has.
+     */
+    currentScopes?: string[];
+};
+export declare const asyncLocalStorage: AsyncLocalStorage<AsyncStorageValue<any>>;
+export declare const getAccessTokenForConnection: () => string | undefined;
+//# sourceMappingURL=asyncLocalStorage.d.ts.map

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

@@ -0,0 +1,10 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+export const asyncLocalStorage = new AsyncLocalStorage();
+export const getAccessTokenForConnection = () => {
+    const store = asyncLocalStorage.getStore();
+    if (typeof store === "undefined") {
+        throw new Error("The tool must be wrapped with the withFederatedConnections function.");
+    }
+    return store === null || store === void 0 ? void 0 : store.accessToken;
+};
+//# sourceMappingURL=asyncLocalStorage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"asyncLocalStorage.js","sourceRoot":"","sources":["../../../../src/authorizers/federated-connections/asyncLocalStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AA6BrD,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,EAEnD,CAAC;AAEJ,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,EAAE;IAC9C,MAAM,KAAK,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;IAC3C,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,CAAC;AAC5B,CAAC,CAAC","sourcesContent":["import { AsyncLocalStorage } from \"node:async_hooks\";\n\nexport type AsyncStorageValue<TContext> = {\n  /**\n   * The Federated Connection access token.\n   */\n  accessToken?: string;\n\n  /**\n   * The tool execution context.\n   */\n  context: TContext;\n\n  /**\n   * The federated connection name.\n   */\n  connection: string;\n\n  /**\n   * The scopes required to access the federated connection.\n   */\n  scopes: string[];\n\n  /**\n   * The scopes that the current access token has.\n   */\n  currentScopes?: string[];\n};\n\nexport const asyncLocalStorage = new AsyncLocalStorage<\n  AsyncStorageValue<any>\n>();\n\nexport const getAccessTokenForConnection = () => {\n  const store = asyncLocalStorage.getStore();\n  if (typeof store === \"undefined\") {\n    throw new Error(\n      \"The tool must be wrapped with the withFederatedConnections function.\"\n    );\n  }\n  return store?.accessToken;\n};\n"]}

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

@@ -0,0 +1,38 @@
+import { Auth0Interrupt } from "../../interrupts";
+import { AuthorizerToolParameter } from "../../parameters";
+import { TokenResponse } from "../../TokenResponse";
+export type { AsyncStorageValue } from "./asyncLocalStorage";
+export { asyncLocalStorage, getAccessTokenForConnection, } from "./asyncLocalStorage";
+export type FederatedConnectionAuthorizerParams<ToolExecuteArgs extends any[]> = {
+    refreshToken?: AuthorizerToolParameter<ToolExecuteArgs, string | undefined>;
+    accessToken?: AuthorizerToolParameter<ToolExecuteArgs, TokenResponse | undefined>;
+    scopes: AuthorizerToolParameter<ToolExecuteArgs, string[]>;
+    connection: AuthorizerToolParameter<ToolExecuteArgs, string>;
+};
+/**
+ * Requests authorization to a third party service via Federated Connection.
+ */
+export declare class FederatedConnectionAuthorizerBase<ToolExecuteArgs extends any[]> {
+    private readonly auth0;
+    private params;
+    constructor(auth0: {
+        domain: string;
+        clientId: string;
+        clientSecret: string | undefined;
+    }, params: FederatedConnectionAuthorizerParams<ToolExecuteArgs>);
+    protected handleAuthorizationInterrupts(err: Auth0Interrupt): void;
+    protected validateToken(tokenResponse?: TokenResponse): void;
+    private getAccessTokenImpl;
+    protected getAccessToken(...toolContext: ToolExecuteArgs): Promise<TokenResponse | undefined>;
+    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: (...args: ToolExecuteArgs) => any, execute: (...args: ToolExecuteArgs) => any): (...args: ToolExecuteArgs) => any;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,123 @@
+import { Auth0Interrupt, FederatedConnectionError, FederatedConnectionInterrupt, } from "../../interrupts";
+import { resolveParameter } from "../../parameters";
+import { asyncLocalStorage } from "./asyncLocalStorage";
+export { asyncLocalStorage, getAccessTokenForConnection, } from "./asyncLocalStorage";
+/**
+ * Requests authorization to a third party service via Federated Connection.
+ */
+export class FederatedConnectionAuthorizerBase {
+    constructor(auth0, params) {
+        this.auth0 = auth0;
+        this.params = params;
+        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.");
+        }
+    }
+    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 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 asyncStore = {
+                context: await getContext(...args),
+                scopes: await resolveParameter(this.params.scopes, args),
+                connection: await resolveParameter(this.params.connection, args),
+            };
+            if (asyncLocalStorage.getStore()) {
+                throw new Error("Cannot nest tool calls that require federated connection authorization.");
+            }
+            return asyncLocalStorage.run(asyncStore, async () => {
+                try {
+                    const tokenResponse = await this.getAccessToken(...args);
+                    asyncStore.accessToken = tokenResponse.access_token;
+                    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=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/authorizers/federated-connections/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAA2B,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE7E,OAAO,EAAE,iBAAiB,EAAqB,MAAM,qBAAqB,CAAC;AAI3E,OAAO,EACL,iBAAiB,EACjB,2BAA2B,GAC5B,MAAM,qBAAqB,CAAC;AAa7B;;GAEG;AACH,MAAM,OAAO,iCAAiC;IAC5C,YACmB,KAIhB,EACO,MAA4D;QALnD,UAAK,GAAL,KAAK,CAIrB;QACO,WAAM,GAAN,MAAM,CAAsD;QAEpE,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;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,8DACE,IAAI,CAAC,MAAM,CAAC,UACd,qBAAqB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAC/C,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,aAAa,CAAC;IACvB,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,UAA6C,EAC7C,OAA0C;QAE1C,OAAO,KAAK,EAAE,GAAG,IAAqB,EAAE,EAAE;YACxC,MAAM,UAAU,GAA2B;gBACzC,OAAO,EAAE,MAAM,UAAU,CAAC,GAAG,IAAI,CAAC;gBAClC,MAAM,EAAE,MAAM,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;gBACxD,UAAU,EAAE,MAAM,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC;aACjE,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,IAAI,CAAC;oBACH,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;oBACzD,UAAU,CAAC,WAAW,GAAG,aAAc,CAAC,YAAY,CAAC;oBACrD,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 {\n  Auth0Interrupt,\n  FederatedConnectionError,\n  FederatedConnectionInterrupt,\n} from \"../../interrupts\";\nimport { AuthorizerToolParameter, resolveParameter } from \"../../parameters\";\nimport { TokenResponse } from \"../../TokenResponse\";\nimport { asyncLocalStorage, AsyncStorageValue } from \"./asyncLocalStorage\";\n\nexport type { AsyncStorageValue } from \"./asyncLocalStorage\";\n\nexport {\n  asyncLocalStorage,\n  getAccessTokenForConnection,\n} from \"./asyncLocalStorage\";\n\nexport type FederatedConnectionAuthorizerParams<ToolExecuteArgs extends any[]> =\n  {\n    refreshToken?: AuthorizerToolParameter<ToolExecuteArgs, string | undefined>;\n    accessToken?: AuthorizerToolParameter<\n      ToolExecuteArgs,\n      TokenResponse | undefined\n    >;\n    scopes: AuthorizerToolParameter<ToolExecuteArgs, string[]>;\n    connection: AuthorizerToolParameter<ToolExecuteArgs, string>;\n  };\n\n/**\n * Requests authorization to a third party service via Federated Connection.\n */\nexport class FederatedConnectionAuthorizerBase<ToolExecuteArgs extends any[]> {\n  constructor(\n    private readonly auth0: {\n      domain: string;\n      clientId: string;\n      clientSecret: string | undefined;\n    },\n    private params: FederatedConnectionAuthorizerParams<ToolExecuteArgs>\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  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: ${\n          this.params.connection\n        }. 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<TokenResponse | undefined> {\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 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: (...args: ToolExecuteArgs) => any,\n    execute: (...args: ToolExecuteArgs) => any\n  ): (...args: ToolExecuteArgs) => any {\n    return async (...args: ToolExecuteArgs) => {\n      const asyncStore: AsyncStorageValue<any> = {\n        context: await getContext(...args),\n        scopes: await resolveParameter(this.params.scopes, args),\n        connection: await resolveParameter(this.params.connection, args),\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        try {\n          const tokenResponse = await this.getAccessToken(...args);\n          asyncStore.accessToken = tokenResponse!.access_token;\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/fga/fga-client.d.ts

@@ -0,0 +1,16 @@
+import { OpenFgaClient } from "@openfga/sdk";
+export type FGAClientParams = {
+    apiUrl?: string;
+    storeId?: string;
+    credentials?: {
+        method: any;
+        config: {
+            apiTokenIssuer: string;
+            apiAudience: string;
+            clientId: string;
+            clientSecret: string;
+        };
+    };
+};
+export declare function buildOpenFgaClient(fgaClientParams?: FGAClientParams | null): OpenFgaClient;
+//# sourceMappingURL=fga-client.d.ts.map

package/dist/esm/authorizers/fga/fga-client.js

@@ -0,0 +1,27 @@
+import { CredentialsMethod, OpenFgaClient } from "@openfga/sdk";
+export function buildOpenFgaClient(fgaClientParams) {
+    var _a, _b, _c, _d, _e;
+    return new OpenFgaClient({
+        apiUrl: (fgaClientParams === null || fgaClientParams === void 0 ? void 0 : fgaClientParams.apiUrl) ||
+            process.env.FGA_API_URL ||
+            "https://api.us1.fga.dev",
+        storeId: (fgaClientParams === null || fgaClientParams === void 0 ? void 0 : fgaClientParams.storeId) || process.env.FGA_STORE_ID,
+        credentials: {
+            method: ((_a = fgaClientParams === null || fgaClientParams === void 0 ? void 0 : fgaClientParams.credentials) === null || _a === void 0 ? void 0 : _a.method) ||
+                CredentialsMethod.ClientCredentials,
+            config: {
+                apiTokenIssuer: ((_b = fgaClientParams === null || fgaClientParams === void 0 ? void 0 : fgaClientParams.credentials) === null || _b === void 0 ? void 0 : _b.config.apiTokenIssuer) ||
+                    process.env.FGA_API_TOKEN_ISSUER ||
+                    "auth.fga.dev",
+                apiAudience: ((_c = fgaClientParams === null || fgaClientParams === void 0 ? void 0 : fgaClientParams.credentials) === null || _c === void 0 ? void 0 : _c.config.apiAudience) ||
+                    process.env.FGA_API_AUDIENCE ||
+                    "https://api.us1.fga.dev/",
+                clientId: ((_d = fgaClientParams === null || fgaClientParams === void 0 ? void 0 : fgaClientParams.credentials) === null || _d === void 0 ? void 0 : _d.config.clientId) ||
+                    process.env.FGA_CLIENT_ID,
+                clientSecret: ((_e = fgaClientParams === null || fgaClientParams === void 0 ? void 0 : fgaClientParams.credentials) === null || _e === void 0 ? void 0 : _e.config.clientSecret) ||
+                    process.env.FGA_CLIENT_SECRET,
+            },
+        },
+    });
+}
+//# sourceMappingURL=fga-client.js.map

package/dist/esm/authorizers/fga/fga-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fga-client.js","sourceRoot":"","sources":["../../../../src/authorizers/fga/fga-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAgBhE,MAAM,UAAU,kBAAkB,CAChC,eAAwC;;IAExC,OAAO,IAAI,aAAa,CAAC;QACvB,MAAM,EACJ,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM;YACvB,OAAO,CAAC,GAAG,CAAC,WAAW;YACvB,yBAAyB;QAC3B,OAAO,EAAE,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,KAAI,OAAO,CAAC,GAAG,CAAC,YAAa;QAC9D,WAAW,EAAE;YACX,MAAM,EACJ,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM;gBACpC,iBAAiB,CAAC,iBAAiB;YACrC,MAAM,EAAE;gBACN,cAAc,EACZ,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAC,cAAc;oBACnD,OAAO,CAAC,GAAG,CAAC,oBAAoB;oBAChC,cAAc;gBAChB,WAAW,EACT,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAC,WAAW;oBAChD,OAAO,CAAC,GAAG,CAAC,gBAAgB;oBAC5B,0BAA0B;gBAC5B,QAAQ,EACN,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAC,QAAQ;oBAC7C,OAAO,CAAC,GAAG,CAAC,aAAc;gBAC5B,YAAY,EACV,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAC,YAAY;oBACjD,OAAO,CAAC,GAAG,CAAC,iBAAkB;aACjC;SACF;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { CredentialsMethod, OpenFgaClient } from \"@openfga/sdk\";\n\nexport type FGAClientParams = {\n  apiUrl?: string;\n  storeId?: string;\n  credentials?: {\n    method: any;\n    config: {\n      apiTokenIssuer: string;\n      apiAudience: string;\n      clientId: string;\n      clientSecret: string;\n    };\n  };\n};\n\nexport function buildOpenFgaClient(\n  fgaClientParams?: FGAClientParams | null\n): OpenFgaClient {\n  return new OpenFgaClient({\n    apiUrl:\n      fgaClientParams?.apiUrl ||\n      process.env.FGA_API_URL ||\n      \"https://api.us1.fga.dev\",\n    storeId: fgaClientParams?.storeId || process.env.FGA_STORE_ID!,\n    credentials: {\n      method:\n        fgaClientParams?.credentials?.method ||\n        CredentialsMethod.ClientCredentials,\n      config: {\n        apiTokenIssuer:\n          fgaClientParams?.credentials?.config.apiTokenIssuer ||\n          process.env.FGA_API_TOKEN_ISSUER ||\n          \"auth.fga.dev\",\n        apiAudience:\n          fgaClientParams?.credentials?.config.apiAudience ||\n          process.env.FGA_API_AUDIENCE ||\n          \"https://api.us1.fga.dev/\",\n        clientId:\n          fgaClientParams?.credentials?.config.clientId ||\n          process.env.FGA_CLIENT_ID!,\n        clientSecret:\n          fgaClientParams?.credentials?.config.clientSecret ||\n          process.env.FGA_CLIENT_SECRET!,\n      },\n    },\n  });\n}\n"]}

package/dist/esm/authorizers/fga/fga-filter.d.ts

@@ -0,0 +1,63 @@
+import { ClientBatchCheckItem, ConsistencyPreference } from "@openfga/sdk";
+import { FGAClientParams } from "./fga-client";
+export type FGAFilterCheckerFn<T extends Record<string, any>> = (doc: T) => ClientBatchCheckItem;
+export type FGAFilterArgs<T extends Record<string, any>> = {
+    buildQuery: FGAFilterCheckerFn<T>;
+    consistency?: ConsistencyPreference;
+};
+/**
+ * A filter that allows filtering documents based on access control checks
+ * using OpenFGA. This class performs batch checks on passed documents,
+ * returning only the ones that pass the specified access criteria.
+ *
+ * @remarks
+ * The FGAFilter requires a buildQuery function to specify how access checks
+ * are formed for each document, the checks are executed via an OpenFGA client
+ * or equivalent mechanism. The checks are then mapped back to their corresponding
+ * documents to filter out those for which access is denied.
+ *
+ * @example
+ * ```ts
+ * const filter = FGAFilter.create({
+ *   buildQuery: (doc) => ({
+ *     user: `user:${user}`,
+ *     object: `doc:${doc.metadata.id}`,
+ *     relation: "viewer",
+ *   }),
+ * });
+ * ```
+ */
+export declare class FGAFilter<T extends Record<string, any>> {
+    private buildQuery;
+    private consistency;
+    private fgaClient;
+    private constructor();
+    /**
+     * Creates a new FGAFilter instance using the given arguments and optional OpenFgaClient.
+     *
+     * @param args - @FGAFilterArgs
+     * @param args.buildQuery - A function to generate access check requests for each document.
+     * @param args.consistency - Optional - The consistency preference for the OpenFGA client.
+     * @param fgaClientParams - Optional - OpenFgaClient configuration to execute checks against.
+     * @returns A newly created FGAFilter instance configured with the provided arguments.
+     */
+    static create<T extends Record<string, any>>(args: FGAFilterArgs<T>, fgaClientParams?: FGAClientParams): FGAFilter<T>;
+    /**
+     * Filters documents based on the provided query parameters, processes
+     * them through a checker function,
+     * and filters the documents based on permissions.
+     *
+     * @param params - The query parameters used to retrieve nodes.
+     * @returns A promise that resolves to an array of documents that have passed the permission checks.
+     */
+    filter(documents: T[]): Promise<T[]>;
+    /**
+     * Checks permissions for a list of client requests.
+     *
+     * @param checks - An array of `ClientBatchCheckItem` objects representing the permissions to be checked.
+     * @returns A promise that resolves to a `Map` where the keys are object identifiers and the values are booleans indicating whether the permission is allowed.
+     */
+    private checkPermissions;
+    private getCheckKey;
+}
+//# sourceMappingURL=fga-filter.d.ts.map

package/dist/esm/authorizers/fga/fga-filter.js

@@ -0,0 +1,90 @@
+import { ConsistencyPreference, } from "@openfga/sdk";
+import { buildOpenFgaClient } from "./fga-client";
+/**
+ * A filter that allows filtering documents based on access control checks
+ * using OpenFGA. This class performs batch checks on passed documents,
+ * returning only the ones that pass the specified access criteria.
+ *
+ * @remarks
+ * The FGAFilter requires a buildQuery function to specify how access checks
+ * are formed for each document, the checks are executed via an OpenFGA client
+ * or equivalent mechanism. The checks are then mapped back to their corresponding
+ * documents to filter out those for which access is denied.
+ *
+ * @example
+ * ```ts
+ * const filter = FGAFilter.create({
+ *   buildQuery: (doc) => ({
+ *     user: `user:${user}`,
+ *     object: `doc:${doc.metadata.id}`,
+ *     relation: "viewer",
+ *   }),
+ * });
+ * ```
+ */
+export class FGAFilter {
+    constructor({ buildQuery, consistency }, fgaClientParams) {
+        this.buildQuery = buildQuery;
+        this.consistency = consistency || ConsistencyPreference.HigherConsistency;
+        this.fgaClient = buildOpenFgaClient(fgaClientParams);
+    }
+    /**
+     * Creates a new FGAFilter instance using the given arguments and optional OpenFgaClient.
+     *
+     * @param args - @FGAFilterArgs
+     * @param args.buildQuery - A function to generate access check requests for each document.
+     * @param args.consistency - Optional - The consistency preference for the OpenFGA client.
+     * @param fgaClientParams - Optional - OpenFgaClient configuration to execute checks against.
+     * @returns A newly created FGAFilter instance configured with the provided arguments.
+     */
+    static create(args, fgaClientParams) {
+        return new FGAFilter(args, fgaClientParams);
+    }
+    /**
+     * Filters documents based on the provided query parameters, processes
+     * them through a checker function,
+     * and filters the documents based on permissions.
+     *
+     * @param params - The query parameters used to retrieve nodes.
+     * @returns A promise that resolves to an array of documents that have passed the permission checks.
+     */
+    async filter(documents) {
+        const { checks, documentToObject } = documents.reduce((acc, doc) => {
+            const check = this.buildQuery(doc);
+            const checkKey = this.getCheckKey(check);
+            acc.documentToObject.set(doc, checkKey);
+            // Skip duplicate checks for same user, object, and relation
+            if (!acc.seenChecks.has(checkKey)) {
+                acc.seenChecks.add(checkKey);
+                acc.checks.push(check);
+            }
+            return acc;
+        }, {
+            checks: [],
+            documentToObject: new Map(),
+            seenChecks: new Set(),
+        });
+        const permissionsMap = await this.checkPermissions(checks);
+        return documents.filter((d) => permissionsMap.get(documentToObject.get(d) || "") === true);
+    }
+    /**
+     * Checks permissions for a list of client requests.
+     *
+     * @param checks - An array of `ClientBatchCheckItem` objects representing the permissions to be checked.
+     * @returns A promise that resolves to a `Map` where the keys are object identifiers and the values are booleans indicating whether the permission is allowed.
+     */
+    async checkPermissions(checks) {
+        const response = await this.fgaClient.batchCheck({ checks }, {
+            consistency: this.consistency,
+        });
+        return response.result.reduce((permissionMap, result) => {
+            const checkKey = this.getCheckKey(result.request);
+            permissionMap.set(checkKey, result.allowed || false);
+            return permissionMap;
+        }, new Map());
+    }
+    getCheckKey(check) {
+        return `${check.user}|${check.object}|${check.relation}`;
+    }
+}
+//# sourceMappingURL=fga-filter.js.map

package/dist/esm/authorizers/fga/fga-filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fga-filter.js","sourceRoot":"","sources":["../../../../src/authorizers/fga/fga-filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,qBAAqB,GAEtB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,kBAAkB,EAAmB,MAAM,cAAc,CAAC;AAWnE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,SAAS;IAKpB,YACE,EAAE,UAAU,EAAE,WAAW,EAAoB,EAC7C,eAAiC;QAEjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,qBAAqB,CAAC,iBAAiB,CAAC;QAC1E,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,CACX,IAAsB,EACtB,eAAiC;QAEjC,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,SAAc;QACzB,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAC,MAAM,CACnD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACX,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACzC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACxC,4DAA4D;YAC5D,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC7B,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EACD;YACE,MAAM,EAAE,EAA4B;YACpC,gBAAgB,EAAE,IAAI,GAAG,EAAa;YACtC,UAAU,EAAE,IAAI,GAAG,EAAU;SAC9B,CACF,CAAC;QAEF,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAE3D,OAAO,SAAS,CAAC,MAAM,CACrB,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAClE,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,gBAAgB,CAC5B,MAA8B;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAC9C,EAAE,MAAM,EAAE,EACV;YACE,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,CAC3B,CAAC,aAAmC,EAAE,MAAM,EAAE,EAAE;YAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAClD,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;YACrD,OAAO,aAAa,CAAC;QACvB,CAAC,EACD,IAAI,GAAG,EAAmB,CAC3B,CAAC;IACJ,CAAC;IAEO,WAAW,CAAC,KAA2B;QAC7C,OAAO,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC3D,CAAC;CACF","sourcesContent":["import {\n  ClientBatchCheckItem,\n  ConsistencyPreference,\n  OpenFgaClient,\n} from \"@openfga/sdk\";\n\nimport { buildOpenFgaClient, FGAClientParams } from \"./fga-client\";\n\nexport type FGAFilterCheckerFn<T extends Record<string, any>> = (\n  doc: T\n) => ClientBatchCheckItem;\n\nexport type FGAFilterArgs<T extends Record<string, any>> = {\n  buildQuery: FGAFilterCheckerFn<T>;\n  consistency?: ConsistencyPreference;\n};\n\n/**\n * A filter that allows filtering documents based on access control checks\n * using OpenFGA. This class performs batch checks on passed documents,\n * returning only the ones that pass the specified access criteria.\n *\n * @remarks\n * The FGAFilter requires a buildQuery function to specify how access checks\n * are formed for each document, the checks are executed via an OpenFGA client\n * or equivalent mechanism. The checks are then mapped back to their corresponding\n * documents to filter out those for which access is denied.\n *\n * @example\n * ```ts\n * const filter = FGAFilter.create({\n *   buildQuery: (doc) => ({\n *     user: `user:${user}`,\n *     object: `doc:${doc.metadata.id}`,\n *     relation: \"viewer\",\n *   }),\n * });\n * ```\n */\nexport class FGAFilter<T extends Record<string, any>> {\n  private buildQuery: FGAFilterCheckerFn<T>;\n  private consistency: ConsistencyPreference;\n  private fgaClient: OpenFgaClient;\n\n  private constructor(\n    { buildQuery, consistency }: FGAFilterArgs<T>,\n    fgaClientParams?: FGAClientParams\n  ) {\n    this.buildQuery = buildQuery;\n    this.consistency = consistency || ConsistencyPreference.HigherConsistency;\n    this.fgaClient = buildOpenFgaClient(fgaClientParams);\n  }\n\n  /**\n   * Creates a new FGAFilter instance using the given arguments and optional OpenFgaClient.\n   *\n   * @param args - @FGAFilterArgs\n   * @param args.buildQuery - A function to generate access check requests for each document.\n   * @param args.consistency - Optional - The consistency preference for the OpenFGA client.\n   * @param fgaClientParams - Optional - OpenFgaClient configuration to execute checks against.\n   * @returns A newly created FGAFilter instance configured with the provided arguments.\n   */\n  static create<T extends Record<string, any>>(\n    args: FGAFilterArgs<T>,\n    fgaClientParams?: FGAClientParams\n  ): FGAFilter<T> {\n    return new FGAFilter(args, fgaClientParams);\n  }\n\n  /**\n   * Filters documents based on the provided query parameters, processes\n   * them through a checker function,\n   * and filters the documents based on permissions.\n   *\n   * @param params - The query parameters used to retrieve nodes.\n   * @returns A promise that resolves to an array of documents that have passed the permission checks.\n   */\n  async filter(documents: T[]): Promise<T[]> {\n    const { checks, documentToObject } = documents.reduce(\n      (acc, doc) => {\n        const check = this.buildQuery(doc);\n        const checkKey = this.getCheckKey(check);\n        acc.documentToObject.set(doc, checkKey);\n        // Skip duplicate checks for same user, object, and relation\n        if (!acc.seenChecks.has(checkKey)) {\n          acc.seenChecks.add(checkKey);\n          acc.checks.push(check);\n        }\n        return acc;\n      },\n      {\n        checks: [] as ClientBatchCheckItem[],\n        documentToObject: new Map<T, string>(),\n        seenChecks: new Set<string>(),\n      }\n    );\n\n    const permissionsMap = await this.checkPermissions(checks);\n\n    return documents.filter(\n      (d) => permissionsMap.get(documentToObject.get(d) || \"\") === true\n    );\n  }\n\n  /**\n   * Checks permissions for a list of client requests.\n   *\n   * @param checks - An array of `ClientBatchCheckItem` objects representing the permissions to be checked.\n   * @returns A promise that resolves to a `Map` where the keys are object identifiers and the values are booleans indicating whether the permission is allowed.\n   */\n  private async checkPermissions(\n    checks: ClientBatchCheckItem[]\n  ): Promise<Map<string, boolean>> {\n    const response = await this.fgaClient.batchCheck(\n      { checks },\n      {\n        consistency: this.consistency,\n      }\n    );\n\n    return response.result.reduce(\n      (permissionMap: Map<string, boolean>, result) => {\n        const checkKey = this.getCheckKey(result.request);\n        permissionMap.set(checkKey, result.allowed || false);\n        return permissionMap;\n      },\n      new Map<string, boolean>()\n    );\n  }\n\n  private getCheckKey(check: ClientBatchCheckItem): string {\n    return `${check.user}|${check.object}|${check.relation}`;\n  }\n}\n"]}