@langchain/google-webauth 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2023 LangChain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# LangChain google-webauth
+
+This package contains resources to access Google AI/ML models
+and other Google services. Authorization to these services use
+either an API Key or service account credentials that are included
+in an environment variable.
+
+If you are running this on the Google Cloud Platform, or in a way
+where service account credentials can be stored on a file system,
+consider using the @langchain/google-gauth
+package *instead*. You do not need to use both packages. See the
+section on **Authorization** below.
+
+
+## Installation
+
+```bash
+$ yarn add @langchain/google-webauth
+```
+
+
+## Authorization
+
+Authorization is either done through the use of an API Key, if it is
+supported for the service you're using, or a Google Cloud Service
+Account.
+
+To handle service accounts, this package uses the `google-auth-library`
+package, and you may wish to consult the documentation for that library
+about how it does so. But in short, classes in this package will use
+credentials from the first of the following that apply:
+
+1. An API Key that is passed to the constructor using the `apiKey` attribute
+2. Credentials that are passed to the constructor using the `authInfo` attribute
+3. An API Key that is set in the environment variable `API_KEY`
+4. The Service Account credentials that are saved directly into the
+   `GOOGLE_WEB_CREDENTIALS`
+5. The Service Account credentials that are saved directly into the
+   `GOOGLE_VERTEX_AI_WEB_CREDENTIALS` (deprecated)
+

package/dist/auth.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebGoogleAuth = void 0;
+const env_1 = require("@langchain/core/utils/env");
+const google_common_1 = require("@langchain/google-common");
+const google_1 = require("web-auth-library/google");
+class WebGoogleAuth extends google_common_1.GoogleAbstractedFetchClient {
+    constructor(fields) {
+        super();
+        Object.defineProperty(this, "options", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const options = fields?.authOptions;
+        const accessToken = options?.accessToken;
+        const credentials = options?.credentials ??
+            (0, env_1.getEnvironmentVariable)("GOOGLE_WEB_CREDENTIALS") ??
+            (0, env_1.getEnvironmentVariable)("GOOGLE_VERTEX_AI_WEB_CREDENTIALS");
+        if (credentials === undefined)
+            throw new Error(`Credentials not found. Please set the GOOGLE_WEB_CREDENTIALS environment variable or pass credentials into "authOptions.credentials".`);
+        this.options = (0, google_common_1.ensureAuthOptionScopes)({ ...options, accessToken, credentials }, "scope", fields?.platformType);
+    }
+    get clientType() {
+        return "webauth";
+    }
+    async getProjectId() {
+        const credentials = (0, google_1.getCredentials)(this.options.credentials);
+        return credentials.project_id;
+    }
+    async request(opts) {
+        let { accessToken } = this.options;
+        if (accessToken === undefined) {
+            accessToken = await (0, google_1.getAccessToken)(this.options);
+        }
+        const authHeader = {
+            Authorization: `Bearer ${accessToken}`,
+        };
+        return this._request(opts?.url, opts, authHeader);
+    }
+}
+exports.WebGoogleAuth = WebGoogleAuth;

package/dist/auth.d.ts

@@ -0,0 +1,14 @@
+import { GoogleAbstractedClientOps, GoogleAbstractedFetchClient, GoogleBaseLLMInput } from "@langchain/google-common";
+import { Credentials } from "web-auth-library/google";
+export type WebGoogleAuthOptions = {
+    credentials: string | Credentials;
+    scope?: string | string[];
+    accessToken?: string;
+};
+export declare class WebGoogleAuth extends GoogleAbstractedFetchClient {
+    options: WebGoogleAuthOptions;
+    constructor(fields: GoogleBaseLLMInput<WebGoogleAuthOptions> | undefined);
+    get clientType(): string;
+    getProjectId(): Promise<string>;
+    request(opts: GoogleAbstractedClientOps): Promise<unknown>;
+}

package/dist/auth.js

@@ -0,0 +1,39 @@
+import { getEnvironmentVariable } from "@langchain/core/utils/env";
+import { ensureAuthOptionScopes, GoogleAbstractedFetchClient, } from "@langchain/google-common";
+import { getAccessToken, getCredentials, } from "web-auth-library/google";
+export class WebGoogleAuth extends GoogleAbstractedFetchClient {
+    constructor(fields) {
+        super();
+        Object.defineProperty(this, "options", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const options = fields?.authOptions;
+        const accessToken = options?.accessToken;
+        const credentials = options?.credentials ??
+            getEnvironmentVariable("GOOGLE_WEB_CREDENTIALS") ??
+            getEnvironmentVariable("GOOGLE_VERTEX_AI_WEB_CREDENTIALS");
+        if (credentials === undefined)
+            throw new Error(`Credentials not found. Please set the GOOGLE_WEB_CREDENTIALS environment variable or pass credentials into "authOptions.credentials".`);
+        this.options = ensureAuthOptionScopes({ ...options, accessToken, credentials }, "scope", fields?.platformType);
+    }
+    get clientType() {
+        return "webauth";
+    }
+    async getProjectId() {
+        const credentials = getCredentials(this.options.credentials);
+        return credentials.project_id;
+    }
+    async request(opts) {
+        let { accessToken } = this.options;
+        if (accessToken === undefined) {
+            accessToken = await getAccessToken(this.options);
+        }
+        const authHeader = {
+            Authorization: `Bearer ${accessToken}`,
+        };
+        return this._request(opts?.url, opts, authHeader);
+    }
+}

package/dist/chat_models.cjs

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatGoogle = void 0;
+const google_common_1 = require("@langchain/google-common");
+const auth_js_1 = require("./auth.cjs");
+/**
+ * Integration with a chat model.
+ */
+class ChatGoogle extends google_common_1.ChatGoogleBase {
+    // Used for tracing, replace with the same name as your class
+    static lc_name() {
+        return "ChatGoogle";
+    }
+    constructor(fields) {
+        super(fields);
+    }
+    buildAbstractedClient(fields) {
+        return new auth_js_1.WebGoogleAuth(fields);
+    }
+}
+exports.ChatGoogle = ChatGoogle;

package/dist/chat_models.d.ts

@@ -0,0 +1,15 @@
+import { ChatGoogleBase, ChatGoogleBaseInput, GoogleAbstractedClient, GoogleBaseLLMInput } from "@langchain/google-common";
+import { WebGoogleAuthOptions } from "./auth.js";
+/**
+ * Input to chat model class.
+ */
+export interface ChatGoogleInput extends ChatGoogleBaseInput<WebGoogleAuthOptions> {
+}
+/**
+ * Integration with a chat model.
+ */
+export declare class ChatGoogle extends ChatGoogleBase<WebGoogleAuthOptions> implements ChatGoogleInput {
+    static lc_name(): string;
+    constructor(fields?: ChatGoogleInput);
+    buildAbstractedClient(fields: GoogleBaseLLMInput<WebGoogleAuthOptions> | undefined): GoogleAbstractedClient;
+}

package/dist/chat_models.js

@@ -0,0 +1,17 @@
+import { ChatGoogleBase, } from "@langchain/google-common";
+import { WebGoogleAuth } from "./auth.js";
+/**
+ * Integration with a chat model.
+ */
+export class ChatGoogle extends ChatGoogleBase {
+    // Used for tracing, replace with the same name as your class
+    static lc_name() {
+        return "ChatGoogle";
+    }
+    constructor(fields) {
+        super(fields);
+    }
+    buildAbstractedClient(fields) {
+        return new WebGoogleAuth(fields);
+    }
+}

package/dist/index.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./chat_models.cjs"), exports);
+__exportStar(require("./llms.cjs"), exports);

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./chat_models.js";
+export * from "./llms.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./chat_models.js";
+export * from "./llms.js";

package/dist/llms.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoogleLLM = void 0;
+const google_common_1 = require("@langchain/google-common");
+const auth_js_1 = require("./auth.cjs");
+/**
+ * Integration with an LLM.
+ */
+class GoogleLLM extends google_common_1.GoogleBaseLLM {
+    // Used for tracing, replace with the same name as your class
+    static lc_name() {
+        return "GoogleLLM";
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+    }
+    buildAbstractedClient(fields) {
+        return new auth_js_1.WebGoogleAuth(fields);
+    }
+}
+exports.GoogleLLM = GoogleLLM;

package/dist/llms.d.ts

@@ -0,0 +1,16 @@
+import { GoogleAbstractedClient, GoogleBaseLLM, GoogleBaseLLMInput } from "@langchain/google-common";
+import { WebGoogleAuthOptions } from "./auth.js";
+/**
+ * Input to LLM class.
+ */
+export interface GoogleLLMInput extends GoogleBaseLLMInput<WebGoogleAuthOptions> {
+}
+/**
+ * Integration with an LLM.
+ */
+export declare class GoogleLLM extends GoogleBaseLLM<WebGoogleAuthOptions> implements GoogleLLMInput {
+    static lc_name(): string;
+    lc_serializable: boolean;
+    constructor(fields?: GoogleLLMInput);
+    buildAbstractedClient(fields: GoogleBaseLLMInput<WebGoogleAuthOptions> | undefined): GoogleAbstractedClient;
+}

package/dist/llms.js

@@ -0,0 +1,23 @@
+import { GoogleBaseLLM, } from "@langchain/google-common";
+import { WebGoogleAuth } from "./auth.js";
+/**
+ * Integration with an LLM.
+ */
+export class GoogleLLM extends GoogleBaseLLM {
+    // Used for tracing, replace with the same name as your class
+    static lc_name() {
+        return "GoogleLLM";
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+    }
+    buildAbstractedClient(fields) {
+        return new WebGoogleAuth(fields);
+    }
+}

package/index.cjs

@@ -0,0 +1 @@
+module.exports = require('./dist/index.cjs');

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist/index.js'

package/index.js

@@ -0,0 +1 @@
+export * from './dist/index.js'

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@langchain/google-webauth",
+  "version": "0.0.0",
+  "description": "Web-based authentication support for Google services",
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:langchain-ai/langchainjs.git"
+  },
+  "scripts": {
+    "build": "yarn run build:deps && yarn clean && yarn build:esm && yarn build:cjs && yarn build:scripts",
+    "build:deps": "yarn run turbo:command build --filter=@langchain/core --filter=@langchain/google-common",
+    "build:esm": "NODE_OPTIONS=--max-old-space-size=4096 tsc --outDir dist/ && rm -rf dist/tests dist/**/tests",
+    "build:cjs": "NODE_OPTIONS=--max-old-space-size=4096 tsc --outDir dist-cjs/ -p tsconfig.cjs.json && yarn move-cjs-to-dist && rm -rf dist-cjs",
+    "build:watch": "yarn create-entrypoints && tsc --outDir dist/ --watch",
+    "build:scripts": "yarn create-entrypoints && yarn check-tree-shaking",
+    "lint:eslint": "NODE_OPTIONS=--max-old-space-size=4096 eslint --cache --ext .ts,.js src/",
+    "lint:dpdm": "dpdm --exit-code circular:1 --no-warning --no-tree src/*.ts src/**/*.ts",
+    "lint": "yarn lint:eslint && yarn lint:dpdm",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:dpdm",
+    "clean": "rm -rf dist/ && NODE_OPTIONS=--max-old-space-size=4096 yarn create-entrypoints -- --pre",
+    "prepack": "yarn build",
+    "test": "yarn run build:deps && NODE_OPTIONS=--experimental-vm-modules jest --testPathIgnorePatterns=\\.int\\.test.ts --testTimeout 30000 --maxWorkers=50%",
+    "test:watch": "yarn run build:deps && NODE_OPTIONS=--experimental-vm-modules jest --watch --testPathIgnorePatterns=\\.int\\.test.ts",
+    "test:single": "yarn run build:deps && NODE_OPTIONS=--experimental-vm-modules yarn run jest --config jest.config.cjs --testTimeout 100000",
+    "test:integration": "NODE_OPTIONS=--experimental-vm-modules jest --testPathPattern=\\.int\\.test.ts --testTimeout 100000 --maxWorkers=50%",
+    "format": "prettier --config .prettierrc --write \"src\"",
+    "format:check": "prettier --config .prettierrc --check \"src\"",
+    "move-cjs-to-dist": "yarn lc-build --config ./langchain.config.js --move-cjs-dist",
+    "create-entrypoints": "yarn lc-build --config ./langchain.config.js --create-entrypoints",
+    "check-tree-shaking": "yarn lc-build --config ./langchain.config.js --tree-shaking"
+  },
+  "author": "LangChain",
+  "license": "MIT",
+  "dependencies": {
+    "@langchain/core": "~0.1.1",
+    "@langchain/google-common": "~0.0.0",
+    "web-auth-library": "^1.0.3"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@langchain/scripts": "^0.0.2",
+    "@swc/core": "^1.3.90",
+    "@swc/jest": "^0.2.29",
+    "@tsconfig/recommended": "^1.0.3",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "dotenv": "^16.3.1",
+    "dpdm": "^3.12.0",
+    "eslint": "^8.33.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-no-instanceof": "^1.0.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "jest-environment-node": "^29.6.4",
+    "prettier": "^2.8.3",
+    "rollup": "^4.5.2",
+    "ts-jest": "^29.1.0",
+    "typescript": "<5.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "index.cjs",
+    "index.js",
+    "index.d.ts"
+  ]
+}