Added Outlook integration toolkit

docs/api_refs/typedoc.json

@@ -45,6 +45,7 @@
     "./langchain/src/tools/webbrowser.ts",
     "./langchain/src/tools/gmail/index.ts",
     "./langchain/src/tools/google_calendar/index.ts",
+    "./langchain/src/tools/outlook/index.ts",
     "./langchain/src/tools/google_places.ts",
     "./langchain/src/chains/index.ts",
     "./langchain/src/chains/combine_documents/reduce.ts",

langchain/.env.example

@@ -91,6 +91,11 @@ NEO4J_USERNAME=ADD_YOURS_HERE
 NEO4J_PASSWORD=ADD_YOURS_HERE
 CLOSEVECTOR_API_KEY=ADD_YOURS_HERE
 CLOSEVECTOR_API_SECRET=ADD_YOURS_HERE
+OUTLOOK_CLIENT_ID=ADD_YOURS_HERE
+OUTLOOK_CLIENT_SECRET=ADD_YOURS_HERE
+OUTLOOK_REDIRECT_URI=ADD_YOURS_HERE
+OUTLOOK_REFRESH_TOKEN=ADD_YOURS_HERE
+OUTLOOK_ACCESS_TOKEN=ADD_YOURS_HERE
 GPLACES_API_KEY=ADD_YOURS_HERE
 CONFLUENCE_USERNAME=ADD_YOURS_HERE
 CONFLUENCE_PASSWORD=ADD_YOURS_HERE

langchain/.gitignore

@@ -79,6 +79,9 @@ tools/gmail.d.ts
 tools/google_calendar.cjs
 tools/google_calendar.js
 tools/google_calendar.d.ts
+tools/outlook.cjs
+tools/outlook.js
+tools/outlook.d.ts
 tools/google_places.cjs
 tools/google_places.js
 tools/google_places.d.ts

langchain/package.json

@@ -91,6 +91,9 @@
     "tools/google_calendar.cjs",
     "tools/google_calendar.js",
     "tools/google_calendar.d.ts",
+    "tools/outlook.cjs",
+    "tools/outlook.js",
+    "tools/outlook.d.ts",
     "tools/google_places.cjs",
     "tools/google_places.js",
     "tools/google_places.d.ts",
@@ -1603,6 +1606,11 @@
       "import": "./tools/google_calendar.js",
       "require": "./tools/google_calendar.cjs"
     },
+    "./tools/outlook": {
+      "types": "./tools/outlook.d.ts",
+      "import": "./tools/outlook.js",
+      "require": "./tools/outlook.cjs"
+    },
     "./tools/google_places": {
       "types": "./tools/google_places.d.ts",
       "import": "./tools/google_places.js",

langchain/scripts/create-entrypoints.js

@@ -40,6 +40,7 @@ const entrypoints = {
   "tools/webbrowser": "tools/webbrowser",
   "tools/gmail": "tools/gmail/index",
   "tools/google_calendar": "tools/google_calendar/index",
+  "tools/outlook": "tools/outlook/index",
   "tools/google_places": "tools/google_places",
   // chains
   chains: "chains/index",
@@ -358,6 +359,7 @@ const requiresOptionalDependency = [
   "tools/webbrowser",
   "tools/google_calendar",
   "tools/gmail",
+  "tools/outlook",
   "callbacks/handlers/llmonitor",
   "chains/load",
   "chains/sql_db",

langchain/src/load/import_constants.ts

@@ -11,6 +11,7 @@ export const optionalImportEntrypoints = [
   "langchain/tools/webbrowser",
   "langchain/tools/gmail",
   "langchain/tools/google_calendar",
+  "langchain/tools/outlook",
   "langchain/chains/load",
   "langchain/chains/query_constructor",
   "langchain/chains/query_constructor/ir",

langchain/src/load/import_type.d.ts

@@ -31,6 +31,9 @@ export interface OptionalImportMap {
   "langchain/tools/google_calendar"?:
     | typeof import("../tools/google_calendar/index.js")
     | Promise<typeof import("../tools/google_calendar/index.js")>;
+  "langchain/tools/outlook"?:
+    | typeof import("../tools/outlook/index.js")
+    | Promise<typeof import("../tools/outlook/index.js")>;
   "langchain/chains/load"?:
     | typeof import("../chains/load.js")
     | Promise<typeof import("../chains/load.js")>;

langchain/src/tools/outlook/authFlowBase.ts

@@ -0,0 +1,13 @@
+export abstract class AuthFlowBase {
+  protected clientId: string;
+
+  protected accessToken = "";
+
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  public abstract getAccessToken(): Promise<string>;
+
+  public abstract refreshAccessToken(): Promise<string>;
+}

langchain/src/tools/outlook/authFlowREST.ts

@@ -0,0 +1,205 @@
+import * as http from "http";
+import * as url from "url";
+import { AuthFlowBase } from "./authFlowBase.js";
+import { getEnvironmentVariable } from "../../util/env.js";
+
+interface AccessTokenResponse {
+  access_token: string;
+  refresh_token: string;
+}
+
+// this class uses your clientId, clientSecret and redirectUri
+// to get access token and refresh token, if you already have them,
+// you can use AuthFlowToken or AuthFlowRefresh instead
+export class AuthFlowREST extends AuthFlowBase {
+  private clientSecret: string;
+
+  private redirectUri: string;
+
+  private port: number;
+
+  private pathname: string;
+
+  private refreshToken = "";
+
+  constructor({
+    clientId,
+    clientSecret,
+    redirectUri,
+  }: { clientId?: string; clientSecret?: string; redirectUri?: string } = {}) {
+    let id = clientId;
+    let secret = clientSecret;
+    let uri = redirectUri;
+    if (!id || !secret || !uri) {
+      id = id ?? getEnvironmentVariable("OUTLOOK_CLIENT_ID");
+      secret = secret ??  getEnvironmentVariable("OUTLOOK_CLIENT_SECRET");
+      uri = uri ?? getEnvironmentVariable("OUTLOOK_REDIRECT_URI");
+    }
+    if (!id || !secret || !uri) {
+      throw new Error("Missing clientId, clientSecret or redirectUri.");
+    }
+    super(id);
+    this.clientSecret = secret;
+    this.redirectUri = uri;
+    const parsedUrl = new URL(this.redirectUri);
+    this.port = parsedUrl.port ? parseInt(parsedUrl.port, 10) : 3000;
+    this.pathname = parsedUrl.pathname || "";
+  }
+
+  // Function to open or print the login url for user to login
+  private openAuthUrl(): string {
+    const loginEndpoint =
+      "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
+    const { clientId } = this; // client ID regestered in Azure
+    const response_type = "code";
+    const response_mode = "query";
+    const redirectUri = encodeURIComponent(this.redirectUri); // redirect URI regestered in Azure
+    const scope = encodeURIComponent(
+      "openid offline_access https://graph.microsoft.com/.default"
+    );
+    const state = "12345";
+
+    const url = [
+      `${loginEndpoint}?client_id=${clientId}`,
+      `&response_type=${response_type}`,
+      `&response_mode=${response_mode}`,
+      `&redirect_uri=${redirectUri}`,
+      `&scope=${scope}`,
+      `&state=${state}`,
+    ].join("");
+
+    console.log("Please open the following url to login:");
+    console.log(url);
+    return url;
+  }
+
+  // Function to start the server
+  private startServer(): Promise<http.Server> {
+    return new Promise((resolve, reject) => {
+      const server = http.createServer();
+
+      server.listen(this.port, () => {
+        console.log(`Server listening at http://localhost:${this.port}`);
+        resolve(server);
+      });
+
+      server.on("error", (err) => {
+        reject(err);
+      });
+    });
+  }
+
+  // Function to listen for the authorization code
+  private async listenForCode(server: http.Server): Promise<string> {
+    return new Promise((resolve, reject) => {
+      // Set timeout in case the user fails to login
+      const timeout = setTimeout(() => {
+        server.close();
+        reject(new Error("Timeout"));
+      }, 180000);
+
+      server.on("request", (req, res) => {
+        try {
+          const reqUrl = url.parse(req.url || "", true);
+
+          if (reqUrl.pathname === this.pathname) {
+            const authCode = reqUrl.query.code as string;
+
+            res.writeHead(200, { "Content-Type": "text/html" });
+            res.end("Authorization code received. You can close this window.");
+
+            clearTimeout(timeout);
+            server.close();
+            console.log("Server closed");
+            resolve(authCode); // Resolve the Promise with the authorization code
+          } else {
+            res.writeHead(404);
+            res.end("404 Not Found");
+          }
+        } catch (err) {
+          clearTimeout(timeout);
+          res.writeHead(500);
+          res.end("Server error");
+          reject(err);
+        }
+      });
+    });
+  }
+
+  // get authentication code from user login
+  private async getCode(): Promise<string> {
+    // check credentials
+    if (!this.clientId || !this.redirectUri) {
+      throw new Error("Missing clientId or redirectUri.");
+    }
+
+    const server = await this.startServer();
+    this.openAuthUrl();
+    const code = await this.listenForCode(server);
+    return code;
+  }
+
+  // Function to get the token using the code and client credentials
+  public async getAccessToken(): Promise<string> {
+    // fetch auth code from user login
+    const code = await this.getCode();
+    // fetch access token using auth code
+    const req_body =
+      `client_id=${encodeURIComponent(this.clientId)}&` +
+      `client_secret=${encodeURIComponent(this.clientSecret)}&` +
+      `scope=${encodeURIComponent("https://graph.microsoft.com/.default")}&` +
+      `redirect_uri=${encodeURIComponent(this.redirectUri)}&` +
+      `grant_type=authorization_code&` +
+      `code=${encodeURIComponent(code)}`;
+
+    const response = await fetch(
+      "https://login.microsoftonline.com/common/oauth2/v2.0/token",
+      {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
+        body: req_body,
+      }
+    );
+
+    if (!response.ok) {
+      throw new Error(`fetch token error! response: ${response.status}`);
+    }
+    // save access token and refresh token
+    const json = (await response.json()) as AccessTokenResponse;
+    this.accessToken = json.access_token;
+    this.refreshToken = json.refresh_token;
+    return this.accessToken;
+  }
+
+  public async refreshAccessToken(): Promise<string> {
+    // fetch new access token using refresh token
+    const req_body =
+      `client_id=${encodeURIComponent(this.clientId)}&` +
+      `client_secret=${encodeURIComponent(this.clientSecret)}&` +
+      `scope=${encodeURIComponent("https://graph.microsoft.com/.default")}&` +
+      `redirect_uri=${encodeURIComponent(this.redirectUri)}&` +
+      `grant_type=refresh_token&` +
+      `refresh_token=${encodeURIComponent(this.refreshToken)}`;
+
+    const response = await fetch(
+      "https://login.microsoftonline.com/common/oauth2/v2.0/token",
+      {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
+        body: req_body,
+      }
+    );
+
+    if (!response.ok) {
+      throw new Error(`fetch token error! response: ${response.status}`);
+    }
+    // save new access token
+    const json = (await response.json()) as AccessTokenResponse;
+    this.accessToken = json.access_token;
+    return this.accessToken;
+  }
+}