@stackfactor/agent-utils 1.0.0

package/dist/esm/logger.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Writes a structured log entry via Winston using the GCP-compatible format. The
+ * current OpenTelemetry span context is read to enrich the entry with `trace` and
+ * `spanId` fields when an active span is present. The user's email (if available on the
+ * request) is prepended to the message string along with an icon derived from the log
+ * level. Any additional fields supplied in `options` are merged into the log record.
+ * @param request - The HTTP request object; used to extract `request.user.email` for
+ *   the log message prefix; may be `null`
+ * @param level - The Winston log level string (e.g. `"info"`, `"error"`, `"warn"`);
+ *   must be one of the keys in the `levels` constant
+ * @param message - The primary log message string
+ * @param options - Additional key-value pairs merged into the log record for structured
+ *   logging (e.g. `{ service: "auth", requestId: "..." }`); defaults to `{}`
+ */
+type LogLevel = "error" | "warn" | "info" | "http" | "verbose" | "debug" | "silly";
+declare const _default: {
+    log: (request: any, level: LogLevel, message: string, options?: any) => void;
+    levels: {
+        readonly error: "error";
+        readonly warn: "warn";
+        readonly info: "info";
+        readonly http: "http";
+        readonly verbose: "verbose";
+        readonly debug: "debug";
+        readonly silly: "silly";
+    };
+};
+export default _default;
+//# sourceMappingURL=logger.d.ts.map

package/dist/esm/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAiEA;;;;;;;;;;;;;GAaG;AACH,KAAK,QAAQ,GACT,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,SAAS,GACT,OAAO,GACP,OAAO,CAAC;;mBAGD,GAAG,SACL,QAAQ,WACN,MAAM,YACN,GAAG,KACX,IAAI;;;;;;;;;;;AA0BP,wBAGE"}

package/dist/esm/logger.js

@@ -0,0 +1,72 @@
+import winston from "winston";
+import { trace, context } from "@opentelemetry/api";
+const { combine, timestamp, printf } = winston.format;
+const levels = {
+    error: "error",
+    warn: "warn",
+    info: "info",
+    http: "http",
+    verbose: "verbose",
+    debug: "debug",
+    silly: "silly",
+};
+const levelIcons = {
+    error: "❌",
+    warn: "⚠️",
+    info: "📝",
+    http: "🌐",
+    verbose: "📝",
+    debug: "🔍",
+    silly: "🎭",
+};
+/**
+ * Custom Winston printf formatter that serialises log records to a single-line JSON
+ * string compatible with Google Cloud Platform (GCP) structured logging. The `level`
+ * field is mapped to GCP's `severity` key (uppercased) and all standard fields plus any
+ * additional metadata are included in the output.
+ */
+const gcpFormat = printf((info) => {
+    const { level, message, timestamp: ts, service, environment, requestId, userId, trace, spanId, sourceLocation, ...rest } = info;
+    return JSON.stringify({
+        severity: level ? level.toUpperCase() : undefined,
+        message,
+        timestamp: ts,
+        service,
+        environment,
+        requestId,
+        userId,
+        trace,
+        spanId,
+        sourceLocation,
+        ...rest,
+    });
+});
+const logger = winston.createLogger({
+    format: combine(timestamp(), gcpFormat),
+    transports: [new winston.transports.Console()],
+});
+const log = (request, level, message, options = {}) => {
+    // Get current OpenTelemetry span context
+    const span = trace.getSpan(context.active());
+    let traceId, spanId;
+    if (span) {
+        const spanContext = span.spanContext();
+        traceId = spanContext.traceId;
+        spanId = spanContext.spanId;
+    }
+    // eslint-disable-next-line security/detect-object-injection
+    const icon = levelIcons[level] || "ℹ️";
+    logger.log({
+        level: level,
+        message: `${icon} ${request && request.user ? request.user.email + " - " : ""}${message}`,
+        trace: traceId
+            ? `projects/${process.env.GOOGLE_CLOUD_PROJECT}/traces/${traceId}`
+            : undefined,
+        spanId: spanId,
+        ...options,
+    });
+};
+export default {
+    log,
+    levels,
+};

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@stackfactor/agent-utils",
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json && echo '{\"type\":\"module\"}' > dist/esm/package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/StackFactor/stackfactor-agent-utils.git"
+  },
+  "keywords": [],
+  "author": "StackFactor Inc",
+  "license": "Not licensed",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    }
+  },
+  "bugs": {
+    "url": "https://github.com/StackFactor/stackfactor-agent-utils/issues"
+  },
+  "homepage": "https://github.com/StackFactor/stackfactor-agent-utils#readme",
+  "dependencies": {
+    "@google/genai": "^1.46.0",
+    "@langchain/anthropic": "^1.3.25",
+    "@langchain/google-genai": "^2.1.26",
+    "@langchain/openai": "^1.3.0",
+    "@opentelemetry/api": "^1.9.0",
+    "langchain": "^1.2.35",
+    "mongoose": "^9.3.1",
+    "openai": "^6.32.0",
+    "winston": "^3.19.0",
+    "zod": "^4.3.6",
+    "zod-to-json-schema": "^3.25.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}