@sweetoburrito/backstage-plugin-ai-assistant-node 0.2.1

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,18 @@
+'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"
+});
+
+exports.dataIngestorExtensionPoint = dataIngestorExtensionPoint;
+exports.embeddingsProviderExtensionPoint = embeddingsProviderExtensionPoint;
+exports.modelProviderExtensionPoint = modelProviderExtensionPoint;
+//# 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';\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<Embeddings>;\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"],"names":["createExtensionPoint"],"mappings":";;;;AASO,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;;;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var extensions = require('./extensions.cjs.js');
+
+
+
+exports.dataIngestorExtensionPoint = extensions.dataIngestorExtensionPoint;
+exports.embeddingsProviderExtensionPoint = extensions.embeddingsProviderExtensionPoint;
+exports.modelProviderExtensionPoint = extensions.modelProviderExtensionPoint;
+//# 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,84 @@
+import { Embeddings } from '@langchain/core/embeddings';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService, RootConfigService, SchedulerService } from '@backstage/backend-plugin-api';
+import { BaseChatModel } from '@langchain/core/language_models/chat_models';
+
+type EmbeddingsSource = string;
+type EmbeddingDocumentMetadata = Partial<{
+    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?: EmbeddingDocumentMetadata;
+};
+interface VectorStore {
+    connectEmbeddings(embeddings: Embeddings): void;
+    addDocuments(docs: EmbeddingDocument[]): Promise<void>;
+    deleteDocuments(deletionParams: DeletionParams): Promise<void>;
+    similaritySearch(query: string, filter?: 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 Message = {
+    id?: string;
+    role: string;
+    content: string;
+};
+
+type DataIngestorExtensionPoint = {
+    registerIngestor: (ingestor: Ingestor) => void;
+};
+declare const dataIngestorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<DataIngestorExtensionPoint>;
+type EmbeddingsProvider = {
+    getEmbeddings: () => Promise<Embeddings>;
+};
+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>;
+
+export { dataIngestorExtensionPoint, embeddingsProviderExtensionPoint, modelProviderExtensionPoint };
+export type { AugmentationIndexer, DataIngestionPipeline, DataIngestionPipelineOptions, DataIngestorExtensionPoint, Embedding, EmbeddingDocument, EmbeddingDocumentMetadata, EmbeddingsProvider, EmbeddingsProviderExtensionPoint, EmbeddingsSource, EntityFilterShape, Ingestor, IngestorOptions, Message, Model, ModelProviderExtensionPoint, VectorStore };

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@sweetoburrito/backstage-plugin-ai-assistant-node",
+  "version": "0.2.1",
+  "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-backend",
+      "@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"
+  },
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}