nestjs-langchain 1.0.2 → 2.0.0

package/package.json

@@ -1,91 +1,112 @@
-{
-  "name": "nestjs-langchain",
-  "version": "1.0.2",
-  "description": "NestJS librairy to build agent with LangChain",
-  "keywords": [
-    "nestjs",
-    "langchain",
-    "agents",
-    "ai"
-  ],
-  "author": "Martin Bruel",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "scripts": {
-    "build": "rimraf -rf dist && tsc -p tsconfig.json",
-    "format": "prettier --write \"{lib,test}/**/*.ts\"",
-    "lint": "eslint \"lib/**/*.ts\" --fix",
-    "prepublish:npm": "npm run build",
-    "publish:npm": "npm publish --access public",
-    "prepublish:next": "npm run build",
-    "publish:next": "npm publish --access public --tag next",
-    "test": "jest",
-    "test:integration": "jest --config ./tests/jest-e2e.json --runInBand",
-    "prerelease": "npm run build",
-    "release": "release-it",
-    "prepare": "husky"
-  },
-  "dependencies": {
-    "zod": "^4.3.6"
-  },
-  "devDependencies": {
-    "@commitlint/cli": "20.3.1",
-    "@commitlint/config-conventional": "^20.4.1",
-    "@eslint/eslintrc": "3.3.3",
-    "@eslint/js": "9.39.2",
-    "@nestjs/cli": "^11.0.16",
-    "@nestjs/common": "^11.1.12",
-    "@nestjs/core": "^11.1.12",
-    "@nestjs/platform-express": "^11.1.12",
-    "@nestjs/schematics": "^11.0.9",
-    "@nestjs/testing": "^11.1.12",
-    "@types/express": "^5.0.6",
-    "@types/jest": "^30.0.0",
-    "@types/lodash": "4.17.23",
-    "@types/node": "^25.1.0",
-    "@types/supertest": "^6.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.54.0",
-    "@typescript-eslint/parser": "^8.54.0",
-    "eslint": "^9.39.2",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.5",
-    "globals": "17.2.0",
-    "husky": "9.1.7",
-    "jest": "^30.2.0",
-    "joi": "18.0.2",
-    "lint-staged": "16.2.7",
-    "prettier": "^3.8.1",
-    "reflect-metadata": "^0.2.2",
-    "release-it": "19.2.4",
-    "rimraf": "6.1.2",
-    "rxjs": "^7.8.2",
-    "source-map-support": "^0.5.21",
-    "supertest": "^7.2.2",
-    "ts-jest": "^29.4.6",
-    "ts-loader": "^9.5.4",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.54.0"
-  },
-  "peerDependencies": {
-    "@nestjs/common": "^11.1.12",
-    "@nestjs/core": "^11.1.12",
-    "langchain": "^1.2.15",
-    "reflect-metadata": "^0.2.2"
-  },
-  "lint-staged": {
-    "*.ts": [
-      "eslint --fix",
-      "prettier --write"
-    ]
-  }
-}
+{
+  "name": "nestjs-langchain",
+  "version": "2.0.0",
+  "type": "module",
+  "description": "NestJS library to build agents with LangChain",
+  "keywords": [
+    "nestjs",
+    "langchain",
+    "agents",
+    "ai"
+  ],
+  "author": "Martin Bruel",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Martin-Bruel/nestjs-langchain.git"
+  },
+  "homepage": "https://github.com/Martin-Bruel/nestjs-langchain#readme",
+  "bugs": {
+    "url": "https://github.com/Martin-Bruel/nestjs-langchain/issues"
+  },
+  "engines": {
+    "node": ">=22.12"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "lib",
+    "!lib/**/*.spec.ts",
+    "README.md"
+  ],
+  "workspaces": [
+    ".",
+    "samples/*"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.build.json",
+    "build:watch": "tsc -p tsconfig.build.json -w",
+    "format": "prettier --write \"{lib,tests,scripts}/**/*.{ts,mjs}\" vitest.config.ts",
+    "lint": "oxlint --type-aware lib/ tests/ scripts/ vitest.config.ts --fix",
+    "lint:check": "oxlint --type-aware lib/ tests/ scripts/ vitest.config.ts",
+    "test": "vitest run --typecheck",
+    "test:watch": "vitest",
+    "release": "release-it",
+    "release:rc": "release-it --preRelease=rc --no-plugins.@release-it/conventional-changelog.infile",
+    "prepublishOnly": "npm run build",
+    "prepare": "husky",
+    "test:cov": "vitest run --coverage",
+    "format:check": "prettier --check \"{lib,tests,scripts}/**/*.{ts,mjs}\" vitest.config.ts",
+    "verify:package": "node scripts/verify-package.mjs",
+    "verify:exports": "publint && attw --pack --ignore-rules cjs-resolves-to-esm"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@commitlint/cli": "21.2.3",
+    "@commitlint/config-conventional": "^21.2.3",
+    "@langchain/core": "^1.2.3",
+    "@langchain/openai": "^1.2.10",
+    "@nestjs/common": "^11.1.18",
+    "@nestjs/core": "^11.1.18",
+    "@nestjs/testing": "^11.1.18",
+    "@release-it/conventional-changelog": "12.0.2",
+    "@types/node": "^25.1.0",
+    "@vitest/coverage-v8": "^4.1.11",
+    "eslint-plugin-jsdoc": "^65.2.0",
+    "husky": "9.1.7",
+    "langchain": "^1.5.4",
+    "lint-staged": "16.4.0",
+    "oxlint": "^1.83.0",
+    "oxlint-tsgolint": "^7.0.2001",
+    "prettier": "^3.8.1",
+    "publint": "^0.3.24",
+    "reflect-metadata": "^0.1.12 || ^0.2.0",
+    "release-it": "21.1.1",
+    "rimraf": "6.1.3",
+    "rxjs": "^7.8.2",
+    "semver": "^7.8.5",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.11",
+    "zod": "^4.0.0"
+  },
+  "peerDependencies": {
+    "@langchain/core": "^1.2.3",
+    "@nestjs/common": "^11.1.18 || ^12.0.1",
+    "@nestjs/core": "^11.1.18 || ^12.0.1",
+    "langchain": "^1.5.4",
+    "reflect-metadata": "^0.1.12 || ^0.2.0",
+    "zod": "^4.0.0"
+  },
+  "lint-staged": {
+    "{lib,tests,scripts}/**/*.{ts,mjs}": [
+      "oxlint --type-aware --fix",
+      "prettier --write"
+    ],
+    "vitest.config.ts": [
+      "oxlint --type-aware --fix",
+      "prettier --write"
+    ]
+  }
+}

package/dist/factories/message.factory.d.ts

@@ -1,7 +0,0 @@
-import { AIMessage, Message, ToolMessage } from '../types/message';
-export declare class MessageFactory {
-    static fromLangChain(lcMessage: any): Message | AIMessage | ToolMessage;
-    private static mapBaseMessage;
-    private static mapAIMessage;
-    private static mapToolMessage;
-}

package/dist/factories/message.factory.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageFactory = void 0;
-const message_1 = require("../types/message");
-class MessageFactory {
-    static fromLangChain(lcMessage) {
-        if (lcMessage.name === 'model') {
-            return this.mapAIMessage(lcMessage);
-        }
-        else if (lcMessage.tool_call_id) {
-            return this.mapToolMessage(lcMessage);
-        }
-        return this.mapBaseMessage(lcMessage);
-    }
-    static mapBaseMessage(lcMessage) {
-        const message = new message_1.Message(lcMessage.id, lcMessage.name, lcMessage.content, message_1.MessageType.UNKNOWN);
-        return message;
-    }
-    static mapAIMessage(lcMessage) {
-        return new message_1.AIMessage(lcMessage.id, lcMessage.name, lcMessage.content, lcMessage.response_metadata, lcMessage.usage_metadata, lcMessage.tool_calls.map((tc) => {
-            return new message_1.ToolCall(tc.id, tc.name, tc.args);
-        }), lcMessage.invalid_tool_calls);
-    }
-    static mapToolMessage(lcMessage) {
-        return new message_1.ToolMessage(lcMessage.id, lcMessage.name, lcMessage.content, lcMessage.tool_call_id);
-    }
-}
-exports.MessageFactory = MessageFactory;

package/dist/langchain.service.d.ts

@@ -1,18 +0,0 @@
-import { OnModuleInit } from '@nestjs/common';
-import { LangChainModuleOptions } from './interfaces/langchain-module-options.interface';
-import { ToolDiscoveryService } from './tool-discovery.service';
-export declare class LangChainService implements OnModuleInit {
-    private readonly options;
-    private readonly toolDiscovery;
-    private agent;
-    private readonly logger;
-    constructor(options: LangChainModuleOptions, toolDiscovery: ToolDiscoveryService);
-    /**
-     * Discover tools and initialize the agent
-     */
-    onModuleInit(): Promise<void>;
-    /**
-     * Run the agent with the given input and stream the response
-     */
-    run(input: string): Promise<string>;
-}

package/dist/langchain.service.js

@@ -1,69 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-var LangChainService_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LangChainService = void 0;
-const common_1 = require("@nestjs/common");
-const langchain_1 = require("langchain");
-const message_1 = require("./types/message");
-const message_factory_1 = require("./factories/message.factory");
-const langchain_module_definition_1 = require("./langchain.module-definition");
-const tool_discovery_service_1 = require("./tool-discovery.service");
-let LangChainService = LangChainService_1 = class LangChainService {
-    constructor(options, toolDiscovery) {
-        this.options = options;
-        this.toolDiscovery = toolDiscovery;
-        this.logger = new common_1.Logger(LangChainService_1.name);
-    }
-    /**
-     * Discover tools and initialize the agent
-     */
-    async onModuleInit() {
-        const tools = this.toolDiscovery.getToolsFromModules(this.options.tools || []);
-        const modelName = this.options.model.model;
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { model: _, ...modelFields } = this.options.model;
-        const model = await (0, langchain_1.initChatModel)(modelName, modelFields);
-        this.agent = (0, langchain_1.createAgent)({
-            model,
-            tools,
-            systemPrompt: this.options.systemPrompt,
-        });
-        this.logger.log(`Agent initialized with ${tools.length} tools.`);
-    }
-    /**
-     * Run the agent with the given input and stream the response
-     */
-    async run(input) {
-        const humanMessage = new message_1.HumanMessage('no_id', 'user', input);
-        humanMessage.content = input;
-        common_1.Logger.verbose(humanMessage.getLogString());
-        for await (const chunk of await this.agent.stream({
-            messages: [{ role: 'user', content: input }],
-        }, { streamMode: 'updates' })) {
-            const message = message_factory_1.MessageFactory.fromLangChain(Object.values(chunk)[0].messages[0]);
-            common_1.Logger.verbose(message.getLogString());
-            if (message.isFinished()) {
-                return message.content;
-            }
-        }
-        throw new Error('No response from agent.');
-    }
-};
-exports.LangChainService = LangChainService;
-exports.LangChainService = LangChainService = LangChainService_1 = __decorate([
-    (0, common_1.Injectable)(),
-    __param(0, (0, common_1.Inject)(langchain_module_definition_1.MODULE_OPTIONS_TOKEN)),
-    __metadata("design:paramtypes", [Object, tool_discovery_service_1.ToolDiscoveryService])
-], LangChainService);

package/dist/tool-discovery.service.d.ts

@@ -1,11 +0,0 @@
-import { Type } from '@nestjs/common';
-import { DynamicStructuredTool } from '@langchain/core/tools';
-import { DiscoveryService } from '@nestjs/core/discovery/discovery-service';
-import { MetadataScanner } from '@nestjs/core';
-export declare class ToolDiscoveryService {
-    private readonly discoveryService;
-    private readonly metadataScanner;
-    constructor(discoveryService: DiscoveryService, metadataScanner: MetadataScanner);
-    private generateZodSchema;
-    getToolsFromModules(allowedModules: Type<any>[]): DynamicStructuredTool[];
-}

package/dist/tool-discovery.service.js

@@ -1,79 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolDiscoveryService = void 0;
-const common_1 = require("@nestjs/common");
-const tools_1 = require("@langchain/core/tools");
-const tool_decorator_1 = require("./decorators/tool.decorator");
-const zod_1 = __importDefault(require("zod"));
-const discovery_service_1 = require("@nestjs/core/discovery/discovery-service");
-const core_1 = require("@nestjs/core");
-let ToolDiscoveryService = class ToolDiscoveryService {
-    constructor(discoveryService, metadataScanner) {
-        this.discoveryService = discoveryService;
-        this.metadataScanner = metadataScanner;
-    }
-    generateZodSchema(params) {
-        const schemaObject = {};
-        params.forEach((param) => {
-            switch (param.type) {
-                case 'number':
-                    schemaObject[param.name] = zod_1.default.number().describe(param.description);
-                    break;
-                case 'boolean':
-                    schemaObject[param.name] = zod_1.default.boolean().describe(param.description);
-                    break;
-                default:
-                    schemaObject[param.name] = zod_1.default.string().describe(param.description);
-            }
-        });
-        return zod_1.default.object(schemaObject);
-    }
-    getToolsFromModules(allowedModules) {
-        const providers = this.discoveryService.getProviders();
-        const allowedModuleNames = allowedModules.map((m) => m.name);
-        const tools = [];
-        providers.forEach((wrapper) => {
-            const { instance, host } = wrapper;
-            if (!instance || !host || !allowedModuleNames.includes(host.name)) {
-                return;
-            }
-            const methodNames = this.metadataScanner.getAllMethodNames(Object.getPrototypeOf(instance));
-            methodNames.forEach((name) => {
-                const metadata = Reflect.getMetadata(tool_decorator_1.TOOL_METADATA, instance[name]);
-                const paramsMeta = Reflect.getMetadata(tool_decorator_1.TOOL_PARAMS_METADATA, instance, name) || [];
-                const zodSchema = this.generateZodSchema(paramsMeta);
-                if (metadata) {
-                    tools.push(new tools_1.DynamicStructuredTool({
-                        name: name,
-                        description: metadata.description,
-                        schema: zodSchema,
-                        func: (args) => {
-                            const sortedParams = paramsMeta.sort((a, b) => a.index - b.index);
-                            const orderedArgs = sortedParams.map((p) => args[p.name]);
-                            return instance[name](...orderedArgs);
-                        },
-                    }));
-                }
-            });
-        });
-        return tools;
-    }
-};
-exports.ToolDiscoveryService = ToolDiscoveryService;
-exports.ToolDiscoveryService = ToolDiscoveryService = __decorate([
-    (0, common_1.Injectable)(),
-    __metadata("design:paramtypes", [discovery_service_1.DiscoveryService,
-        core_1.MetadataScanner])
-], ToolDiscoveryService);

package/dist/types/message.d.ts

@@ -1,69 +0,0 @@
-export declare class Message {
-    id: string;
-    name: string;
-    content: string;
-    type: MessageType;
-    constructor(id: string, name: string, content: string, type: MessageType);
-    getLogString(): string;
-    isFinished(): boolean;
-}
-export declare class HumanMessage extends Message {
-    constructor(id: string, name: string, content: string);
-    getLogString(): string;
-    isFinished(): boolean;
-}
-export declare class AIMessage extends Message {
-    response_metadata: ResponseMetadata;
-    usage_metadata: UsageMetadata;
-    tool_calls: ToolCall[];
-    invalid_tool_calls: any[];
-    constructor(id: string, name: string, content: string, response_metadata: ResponseMetadata, usage_metadata: UsageMetadata, tool_calls: ToolCall[], invalid_tool_calls: any[]);
-    getLogString(): string;
-    isFinished(): boolean;
-}
-export declare class ToolMessage extends Message {
-    constructor(id: string, name: string, content: string, tool_call_id: string);
-    tool_call_id: string;
-    getLogString(): string;
-}
-export declare class ToolCall {
-    name: string;
-    args: any;
-    id: string;
-    constructor(id: string, name: string, args: any);
-    toString(): string;
-}
-export declare class ResponseMetadata {
-    tokenUsage: {
-        promptTokens: number;
-        completionTokens: number;
-        totalTokens: number;
-    };
-    finish_reason: string;
-    model_provider: string;
-    model_name: string;
-    constructor(tokenUsage: {
-        promptTokens: number;
-        completionTokens: number;
-        totalTokens: number;
-    }, finish_reason: string, model_provider: string, model_name: string);
-}
-export declare enum FinishReason {
-    STOP = "stop",
-    TOOL_CALLS = "tool_calls",
-    UNKNOWN = "unknown"
-}
-export declare class UsageMetadata {
-    constructor(output_tokens: number, input_tokens: number, total_tokens: number, input_token_details: any, output_token_details: any);
-    output_tokens: number;
-    input_tokens: number;
-    total_tokens: number;
-    input_token_details: any;
-    output_token_details: any;
-}
-export declare enum MessageType {
-    AI = "ai",
-    HUMAN = "human",
-    TOOL = "tool",
-    UNKNOWN = "unknown"
-}

package/dist/types/message.js

@@ -1,104 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageType = exports.UsageMetadata = exports.FinishReason = exports.ResponseMetadata = exports.ToolCall = exports.ToolMessage = exports.AIMessage = exports.HumanMessage = exports.Message = void 0;
-class Message {
-    constructor(id, name, content, type) {
-        this.id = id;
-        this.name = name;
-        this.content = content;
-        this.type = type;
-    }
-    getLogString() {
-        return `Message [ID: ${this.id}, Name: ${this.name}, Type: ${this.type}, Content: ${this.content}]`;
-    }
-    isFinished() {
-        return false;
-    }
-}
-exports.Message = Message;
-class HumanMessage extends Message {
-    constructor(id, name, content) {
-        super(id, name, content, MessageType.HUMAN);
-    }
-    getLogString() {
-        return `HumanMessage: ${this.content}`;
-    }
-    isFinished() {
-        return false;
-    }
-}
-exports.HumanMessage = HumanMessage;
-class AIMessage extends Message {
-    constructor(id, name, content, response_metadata, usage_metadata, tool_calls, invalid_tool_calls) {
-        super(id, name, content, MessageType.AI);
-        this.response_metadata = response_metadata;
-        this.usage_metadata = usage_metadata;
-        this.tool_calls = tool_calls;
-        this.invalid_tool_calls = invalid_tool_calls;
-    }
-    getLogString() {
-        if (this.response_metadata?.finish_reason === FinishReason.TOOL_CALLS) {
-            return `AIMessage: Call tools: ${this.tool_calls
-                .map((tc) => tc.toString())
-                .join(', ')}`;
-        }
-        return `AIMessage: ${this.content}`;
-    }
-    isFinished() {
-        return this.response_metadata?.finish_reason === FinishReason.STOP;
-    }
-}
-exports.AIMessage = AIMessage;
-class ToolMessage extends Message {
-    constructor(id, name, content, tool_call_id) {
-        super(id, name, content, MessageType.TOOL);
-        this.tool_call_id = tool_call_id;
-    }
-    getLogString() {
-        return `ToolMessage call tool ${this.name} with args: ${this.content}`;
-    }
-}
-exports.ToolMessage = ToolMessage;
-class ToolCall {
-    constructor(id, name, args) {
-        this.name = name;
-        this.args = args;
-        this.id = id;
-    }
-    toString() {
-        return `${this.name} with args ${JSON.stringify(this.args)}`;
-    }
-}
-exports.ToolCall = ToolCall;
-class ResponseMetadata {
-    constructor(tokenUsage, finish_reason, model_provider, model_name) {
-        this.tokenUsage = tokenUsage;
-        this.finish_reason = finish_reason;
-        this.model_provider = model_provider;
-        this.model_name = model_name;
-    }
-}
-exports.ResponseMetadata = ResponseMetadata;
-var FinishReason;
-(function (FinishReason) {
-    FinishReason["STOP"] = "stop";
-    FinishReason["TOOL_CALLS"] = "tool_calls";
-    FinishReason["UNKNOWN"] = "unknown";
-})(FinishReason || (exports.FinishReason = FinishReason = {}));
-class UsageMetadata {
-    constructor(output_tokens, input_tokens, total_tokens, input_token_details, output_token_details) {
-        this.output_tokens = output_tokens;
-        this.input_tokens = input_tokens;
-        this.total_tokens = total_tokens;
-        this.input_token_details = input_token_details;
-        this.output_token_details = output_token_details;
-    }
-}
-exports.UsageMetadata = UsageMetadata;
-var MessageType;
-(function (MessageType) {
-    MessageType["AI"] = "ai";
-    MessageType["HUMAN"] = "human";
-    MessageType["TOOL"] = "tool";
-    MessageType["UNKNOWN"] = "unknown";
-})(MessageType || (exports.MessageType = MessageType = {}));