@sweetoburrito/backstage-plugin-ai-assistant-node 0.0.0-snapshot-20251029150521

package/README.md

@@ -0,0 +1,5 @@
+# @sweetoburrito/backstage-plugin-ai-assistant-node
+
+Welcome to the Node.js library package for the ai-assistant plugin!
+
+This package contains types and interfaces to support the ai-assistant plugin and modules.

package/dist/extensions.cjs.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+const dataIngestorExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "ai-assistant.data-ingestor"
+});
+const embeddingsProviderExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "ai-assistant.embeddings-provider"
+});
+const modelProviderExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "ai-assistant.model-provider"
+});
+const toolExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "ai-assistant.tool"
+});
+
+exports.dataIngestorExtensionPoint = dataIngestorExtensionPoint;
+exports.embeddingsProviderExtensionPoint = embeddingsProviderExtensionPoint;
+exports.modelProviderExtensionPoint = modelProviderExtensionPoint;
+exports.toolExtensionPoint = toolExtensionPoint;
+//# sourceMappingURL=extensions.cjs.js.map

package/dist/extensions.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["import { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { Ingestor } from './types/ingestor';\nimport { Embeddings } from '@langchain/core/embeddings';\nimport { BaseChatModel } from '@langchain/core/language_models/chat_models';\nimport { Tool } from './types';\nimport { ZodType } from 'zod';\n\nexport type DataIngestorExtensionPoint = {\n  registerIngestor: (ingestor: Ingestor) => void;\n};\n\nexport const dataIngestorExtensionPoint =\n  createExtensionPoint<DataIngestorExtensionPoint>({\n    id: 'ai-assistant.data-ingestor',\n  });\n\nexport type EmbeddingsProvider = {\n  getEmbeddings: () => Promise<Omit<Embeddings, 'caller'>>;\n};\n\nexport type EmbeddingsProviderExtensionPoint = {\n  register: (provider: EmbeddingsProvider) => void;\n};\n\nexport const embeddingsProviderExtensionPoint =\n  createExtensionPoint<EmbeddingsProviderExtensionPoint>({\n    id: 'ai-assistant.embeddings-provider',\n  });\n\nexport type Model = {\n  id: string;\n  chatModel: BaseChatModel;\n};\n\nexport type ModelProviderExtensionPoint = {\n  register: (model: Model) => void;\n};\n\nexport const modelProviderExtensionPoint =\n  createExtensionPoint<ModelProviderExtensionPoint>({\n    id: 'ai-assistant.model-provider',\n  });\n\nexport type ToolExtensionPoint = {\n  register: (tool: Tool<ZodType>) => void;\n};\n\nexport const toolExtensionPoint = createExtensionPoint<ToolExtensionPoint>({\n  id: 'ai-assistant.tool',\n});\n"],"names":["createExtensionPoint"],"mappings":";;;;AAWO,MAAM,6BACXA,qCAAA,CAAiD;AAAA,EAC/C,EAAA,EAAI;AACN,CAAC;AAUI,MAAM,mCACXA,qCAAA,CAAuD;AAAA,EACrD,EAAA,EAAI;AACN,CAAC;AAWI,MAAM,8BACXA,qCAAA,CAAkD;AAAA,EAChD,EAAA,EAAI;AACN,CAAC;AAMI,MAAM,qBAAqBA,qCAAA,CAAyC;AAAA,EACzE,EAAA,EAAI;AACN,CAAC;;;;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var extensions = require('./extensions.cjs.js');
+var tool = require('./utils/tool.cjs.js');
+var streamToString = require('./utils/stream-to-string.cjs.js');
+var encrypt = require('./utils/encrypt.cjs.js');
+
+
+
+exports.dataIngestorExtensionPoint = extensions.dataIngestorExtensionPoint;
+exports.embeddingsProviderExtensionPoint = extensions.embeddingsProviderExtensionPoint;
+exports.modelProviderExtensionPoint = extensions.modelProviderExtensionPoint;
+exports.toolExtensionPoint = extensions.toolExtensionPoint;
+exports.createAssistantTool = tool.createAssistantTool;
+exports.streamToString = streamToString.streamToString;
+exports.decrypt = encrypt.decrypt;
+exports.encrypt = encrypt.encrypt;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService, RootConfigService, SchedulerService } from '@backstage/backend-plugin-api';
+import { Embeddings } from '@langchain/core/embeddings';
+import { ZodType, z } from 'zod';
+import { BaseChatModel } from '@langchain/core/language_models/chat_models';
+
+type EmbeddingsSource = string;
+/**
+ * Metadata that is required for each document to be embedded.
+ * - `source`: The source of the document, e.g. 'github', 'azure-devops', etc.
+ * - `id`: A unique identifier for the document within the source. Does not necessarily need to be globally unique or a UUID.
+ * Additional metadata can be added as needed.
+ */
+type EmbeddingDocumentMetadata = {
+    source: EmbeddingsSource;
+    id: string;
+    [key: string]: string;
+};
+type Embedding = {
+    metadata: EmbeddingDocumentMetadata;
+    content: string;
+    vector: number[];
+    id: string;
+};
+type EmbeddingDocument = {
+    metadata: EmbeddingDocumentMetadata;
+    content: string;
+};
+type DeletionParams = {
+    ids?: string[];
+    filter?: Partial<EmbeddingDocumentMetadata>;
+};
+interface VectorStore {
+    connectEmbeddings(embeddings: Embeddings): void;
+    addDocuments(docs: EmbeddingDocument[]): Promise<void>;
+    deleteDocuments(deletionParams: DeletionParams): Promise<void>;
+    similaritySearch(query: string, filter?: Partial<EmbeddingDocumentMetadata>, amount?: number): Promise<EmbeddingDocument[]>;
+}
+type EntityFilterShape = Record<string, string | symbol | (string | symbol)[]>[] | Record<string, string | symbol | (string | symbol)[]> | undefined;
+interface AugmentationIndexer {
+    vectorStore: VectorStore;
+    createEmbeddings(source: EmbeddingsSource, filter?: EntityFilterShape): Promise<number>;
+    deleteEmbeddings(source: EmbeddingsSource, filter: EntityFilterShape): Promise<void>;
+}
+
+type IngestorOptions = {
+    saveDocumentsBatch: (documents: EmbeddingDocument[]) => Promise<void>;
+};
+type Ingestor = {
+    id: string;
+    ingest: (options: IngestorOptions) => Promise<EmbeddingDocument[] | void>;
+};
+type DataIngestionPipelineOptions = {
+    logger: LoggerService;
+    config: RootConfigService;
+    scheduler: SchedulerService;
+    vectorStore: VectorStore;
+    ingestors: Ingestor[];
+};
+type DataIngestionPipeline = {
+    start: () => Promise<void>;
+};
+
+type Tool<T extends ZodType<any, any, any> = ZodType<any, any, any>> = {
+    name: string;
+    description: string;
+    schema: T;
+    func: (params: z.infer<T>) => Promise<string>;
+};
+
+type DataIngestorExtensionPoint = {
+    registerIngestor: (ingestor: Ingestor) => void;
+};
+declare const dataIngestorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<DataIngestorExtensionPoint>;
+type EmbeddingsProvider = {
+    getEmbeddings: () => Promise<Omit<Embeddings, 'caller'>>;
+};
+type EmbeddingsProviderExtensionPoint = {
+    register: (provider: EmbeddingsProvider) => void;
+};
+declare const embeddingsProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<EmbeddingsProviderExtensionPoint>;
+type Model = {
+    id: string;
+    chatModel: BaseChatModel;
+};
+type ModelProviderExtensionPoint = {
+    register: (model: Model) => void;
+};
+declare const modelProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ModelProviderExtensionPoint>;
+type ToolExtensionPoint = {
+    register: (tool: Tool<ZodType>) => void;
+};
+declare const toolExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ToolExtensionPoint>;
+
+type CreateAssistantToolOptions<T extends ZodType<any, any, any>> = {
+    tool: Tool<T>;
+};
+declare const createAssistantTool: <T extends ZodType<any, any, any>>(options: CreateAssistantToolOptions<T>) => Tool<T>;
+
+declare function streamToString(readableStream: NodeJS.ReadableStream | null): Promise<string>;
+
+declare const encrypt: (text: string, key: string) => string;
+declare const decrypt: (encryptedText: string, key: string) => string;
+
+export { createAssistantTool, dataIngestorExtensionPoint, decrypt, embeddingsProviderExtensionPoint, encrypt, modelProviderExtensionPoint, streamToString, toolExtensionPoint };
+export type { AugmentationIndexer, DataIngestionPipeline, DataIngestionPipelineOptions, DataIngestorExtensionPoint, Embedding, EmbeddingDocument, EmbeddingDocumentMetadata, EmbeddingsProvider, EmbeddingsProviderExtensionPoint, EmbeddingsSource, EntityFilterShape, Ingestor, IngestorOptions, Model, ModelProviderExtensionPoint, Tool, ToolExtensionPoint, VectorStore };

package/dist/utils/encrypt.cjs.js

@@ -0,0 +1,32 @@
+'use strict';
+
+var crypto = require('crypto');
+
+const normalizeKey = (key) => {
+  return crypto.createHash("sha256").update(key).digest();
+};
+const encrypt = (text, key) => {
+  const iv = crypto.randomBytes(16);
+  const normalizedKey = normalizeKey(key);
+  const cipher = crypto.createCipheriv("aes-256-gcm", normalizedKey, iv);
+  let encrypted = cipher.update(text, "utf8", "hex");
+  encrypted += cipher.final("hex");
+  const authTag = cipher.getAuthTag();
+  return `${iv.toString("hex")}:${encrypted}:${authTag.toString("hex")}`;
+};
+const decrypt = (encryptedText, key) => {
+  const parts = encryptedText.split(":");
+  const iv = Buffer.from(parts[0], "hex");
+  const encrypted = parts[1];
+  const authTag = Buffer.from(parts[2], "hex");
+  const normalizedKey = normalizeKey(key);
+  const decipher = crypto.createDecipheriv("aes-256-gcm", normalizedKey, iv);
+  decipher.setAuthTag(authTag);
+  let decrypted = decipher.update(encrypted, "hex", "utf8");
+  decrypted += decipher.final("utf8");
+  return decrypted;
+};
+
+exports.decrypt = decrypt;
+exports.encrypt = encrypt;
+//# sourceMappingURL=encrypt.cjs.js.map

package/dist/utils/encrypt.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encrypt.cjs.js","sources":["../../src/utils/encrypt.ts"],"sourcesContent":["import {\n  createCipheriv,\n  createDecipheriv,\n  randomBytes,\n  createHash,\n} from 'crypto';\n\nconst normalizeKey = (key: string): Buffer => {\n  // Hash the key to ensure it's always 32 bytes for AES-256\n  return createHash('sha256').update(key).digest();\n};\n\nexport const encrypt = (text: string, key: string): string => {\n  const iv = randomBytes(16);\n  const normalizedKey = normalizeKey(key);\n  const cipher = createCipheriv('aes-256-gcm', normalizedKey, iv);\n  let encrypted = cipher.update(text, 'utf8', 'hex');\n  encrypted += cipher.final('hex');\n  const authTag = cipher.getAuthTag();\n  return `${iv.toString('hex')}:${encrypted}:${authTag.toString('hex')}`;\n};\n\nexport const decrypt = (encryptedText: string, key: string): string => {\n  const parts = encryptedText.split(':');\n  const iv = Buffer.from(parts[0], 'hex');\n  const encrypted = parts[1];\n  const authTag = Buffer.from(parts[2], 'hex');\n  const normalizedKey = normalizeKey(key);\n  const decipher = createDecipheriv('aes-256-gcm', normalizedKey, iv);\n  decipher.setAuthTag(authTag);\n  let decrypted = decipher.update(encrypted, 'hex', 'utf8');\n  decrypted += decipher.final('utf8');\n  return decrypted;\n};\n"],"names":["createHash","randomBytes","createCipheriv","createDecipheriv"],"mappings":";;;;AAOA,MAAM,YAAA,GAAe,CAAC,GAAA,KAAwB;AAE5C,EAAA,OAAOA,kBAAW,QAAQ,CAAA,CAAE,MAAA,CAAO,GAAG,EAAE,MAAA,EAAO;AACjD,CAAA;AAEO,MAAM,OAAA,GAAU,CAAC,IAAA,EAAc,GAAA,KAAwB;AAC5D,EAAA,MAAM,EAAA,GAAKC,mBAAY,EAAE,CAAA;AACzB,EAAA,MAAM,aAAA,GAAgB,aAAa,GAAG,CAAA;AACtC,EAAA,MAAM,MAAA,GAASC,qBAAA,CAAe,aAAA,EAAe,aAAA,EAAe,EAAE,CAAA;AAC9D,EAAA,IAAI,SAAA,GAAY,MAAA,CAAO,MAAA,CAAO,IAAA,EAAM,QAAQ,KAAK,CAAA;AACjD,EAAA,SAAA,IAAa,MAAA,CAAO,MAAM,KAAK,CAAA;AAC/B,EAAA,MAAM,OAAA,GAAU,OAAO,UAAA,EAAW;AAClC,EAAA,OAAO,CAAA,EAAG,EAAA,CAAG,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA,EAAI,OAAA,CAAQ,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AACtE;AAEO,MAAM,OAAA,GAAU,CAAC,aAAA,EAAuB,GAAA,KAAwB;AACrE,EAAA,MAAM,KAAA,GAAQ,aAAA,CAAc,KAAA,CAAM,GAAG,CAAA;AACrC,EAAA,MAAM,KAAK,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,CAAC,GAAG,KAAK,CAAA;AACtC,EAAA,MAAM,SAAA,GAAY,MAAM,CAAC,CAAA;AACzB,EAAA,MAAM,UAAU,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,CAAC,GAAG,KAAK,CAAA;AAC3C,EAAA,MAAM,aAAA,GAAgB,aAAa,GAAG,CAAA;AACtC,EAAA,MAAM,QAAA,GAAWC,uBAAA,CAAiB,aAAA,EAAe,aAAA,EAAe,EAAE,CAAA;AAClE,EAAA,QAAA,CAAS,WAAW,OAAO,CAAA;AAC3B,EAAA,IAAI,SAAA,GAAY,QAAA,CAAS,MAAA,CAAO,SAAA,EAAW,OAAO,MAAM,CAAA;AACxD,EAAA,SAAA,IAAa,QAAA,CAAS,MAAM,MAAM,CAAA;AAClC,EAAA,OAAO,SAAA;AACT;;;;;"}

package/dist/utils/stream-to-string.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+async function streamToString(readableStream) {
+  if (!readableStream) {
+    return "";
+  }
+  return new Promise((resolve, reject) => {
+    const chunks = [];
+    readableStream.on("data", (chunk) => {
+      if (typeof chunk === "string") {
+        chunks.push(Buffer.from(chunk, "utf-8"));
+      } else {
+        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+      }
+    });
+    readableStream.on("end", () => {
+      resolve(Buffer.concat(chunks).toString("utf-8"));
+    });
+    readableStream.on("error", reject);
+  });
+}
+
+exports.streamToString = streamToString;
+//# sourceMappingURL=stream-to-string.cjs.js.map

package/dist/utils/stream-to-string.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-to-string.cjs.js","sources":["../../src/utils/stream-to-string.ts"],"sourcesContent":["export async function streamToString(\n  readableStream: NodeJS.ReadableStream | null,\n): Promise<string> {\n  if (!readableStream) {\n    return '';\n  }\n  return new Promise((resolve, reject) => {\n    const chunks: Buffer[] = [];\n    readableStream.on('data', chunk => {\n      if (typeof chunk === 'string') {\n        chunks.push(Buffer.from(chunk, 'utf-8'));\n      } else {\n        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));\n      }\n    });\n    readableStream.on('end', () => {\n      resolve(Buffer.concat(chunks).toString('utf-8'));\n    });\n    readableStream.on('error', reject);\n  });\n}\n"],"names":[],"mappings":";;AAAA,eAAsB,eACpB,cAAA,EACiB;AACjB,EAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,IAAA,OAAO,EAAA;AAAA,EACT;AACA,EAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAA,KAAW;AACtC,IAAA,MAAM,SAAmB,EAAC;AAC1B,IAAA,cAAA,CAAe,EAAA,CAAG,QAAQ,CAAA,KAAA,KAAS;AACjC,MAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,QAAA,MAAA,CAAO,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,KAAA,EAAO,OAAO,CAAC,CAAA;AAAA,MACzC,CAAA,MAAO;AACL,QAAA,MAAA,CAAO,IAAA,CAAK,OAAO,QAAA,CAAS,KAAK,IAAI,KAAA,GAAQ,MAAA,CAAO,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA,MACjE;AAAA,IACF,CAAC,CAAA;AACD,IAAA,cAAA,CAAe,EAAA,CAAG,OAAO,MAAM;AAC7B,MAAA,OAAA,CAAQ,OAAO,MAAA,CAAO,MAAM,CAAA,CAAE,QAAA,CAAS,OAAO,CAAC,CAAA;AAAA,IACjD,CAAC,CAAA;AACD,IAAA,cAAA,CAAe,EAAA,CAAG,SAAS,MAAM,CAAA;AAAA,EACnC,CAAC,CAAA;AACH;;;;"}

package/dist/utils/tool.cjs.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const createAssistantTool = (options) => {
+  return options.tool;
+};
+
+exports.createAssistantTool = createAssistantTool;
+//# sourceMappingURL=tool.cjs.js.map

package/dist/utils/tool.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool.cjs.js","sources":["../../src/utils/tool.ts"],"sourcesContent":["import { ZodType } from 'zod';\nimport { Tool } from '../types';\n\ntype CreateAssistantToolOptions<T extends ZodType<any, any, any>> = {\n  tool: Tool<T>;\n};\n\nexport const createAssistantTool = <T extends ZodType<any, any, any>>(\n  options: CreateAssistantToolOptions<T>,\n) => {\n  return options.tool;\n};\n"],"names":[],"mappings":";;AAOO,MAAM,mBAAA,GAAsB,CACjC,OAAA,KACG;AACH,EAAA,OAAO,OAAA,CAAQ,IAAA;AACjB;;;;"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@sweetoburrito/backstage-plugin-ai-assistant-node",
+  "version": "0.0.0-snapshot-20251029150521",
+  "license": "Apache-2.0",
+  "description": "Node.js library for the ai-assistant plugin",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "node-library",
+    "pluginId": "ai-assistant",
+    "pluginPackages": [
+      "@sweetoburrito/backstage-plugin-ai-assistant",
+      "@sweetoburrito/backstage-plugin-ai-assistant-backend",
+      "@sweetoburrito/backstage-plugin-ai-assistant-common",
+      "@sweetoburrito/backstage-plugin-ai-assistant-node"
+    ]
+  },
+  "scripts": {
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "devDependencies": {
+    "@backstage/cli": "backstage:^"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@backstage/backend-plugin-api": "backstage:^",
+    "@langchain/core": "^0.3.72",
+    "zod": "^4.1.11"
+  },
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}