@sweetoburrito/backstage-plugin-ai-assistant-node 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,7 +14,11 @@ const modelProviderExtensionPoint = backendPluginApi.createExtensionPoint({
14
14
  const toolExtensionPoint = backendPluginApi.createExtensionPoint({
15
15
  id: "ai-assistant.tool"
16
16
  });
17
+ const callbackProviderExtensionPoint = backendPluginApi.createExtensionPoint({
18
+ id: "ai-assistant.callback"
19
+ });
17
20
 
21
+ exports.callbackProviderExtensionPoint = callbackProviderExtensionPoint;
18
22
  exports.dataIngestorExtensionPoint = dataIngestorExtensionPoint;
19
23
  exports.embeddingsProviderExtensionPoint = embeddingsProviderExtensionPoint;
20
24
  exports.modelProviderExtensionPoint = modelProviderExtensionPoint;
@@ -1 +1 @@
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;;;;;;;"}
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 { CallbackProvider, 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\nexport type CallbackExtensionPoint = {\n register: (callback: CallbackProvider) => void;\n};\n\nexport const callbackProviderExtensionPoint =\n createExtensionPoint<CallbackExtensionPoint>({\n id: 'ai-assistant.callback',\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;AAMM,MAAM,iCACXA,qCAAA,CAA6C;AAAA,EAC3C,EAAA,EAAI;AACN,CAAC;;;;;;;;"}
package/dist/index.cjs.js CHANGED
@@ -3,13 +3,19 @@
3
3
  var extensions = require('./extensions.cjs.js');
4
4
  var tool = require('./utils/tool.cjs.js');
5
5
  var streamToString = require('./utils/stream-to-string.cjs.js');
6
+ var encrypt = require('./utils/encrypt.cjs.js');
7
+ var getUser = require('./utils/get-user.cjs.js');
6
8
 
7
9
 
8
10
 
11
+ exports.callbackProviderExtensionPoint = extensions.callbackProviderExtensionPoint;
9
12
  exports.dataIngestorExtensionPoint = extensions.dataIngestorExtensionPoint;
10
13
  exports.embeddingsProviderExtensionPoint = extensions.embeddingsProviderExtensionPoint;
11
14
  exports.modelProviderExtensionPoint = extensions.modelProviderExtensionPoint;
12
15
  exports.toolExtensionPoint = extensions.toolExtensionPoint;
13
16
  exports.createAssistantTool = tool.createAssistantTool;
14
17
  exports.streamToString = streamToString.streamToString;
18
+ exports.decrypt = encrypt.decrypt;
19
+ exports.encrypt = encrypt.encrypt;
20
+ exports.getUser = getUser.getUser;
15
21
  //# sourceMappingURL=index.cjs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;"}
package/dist/index.d.ts CHANGED
@@ -1,8 +1,11 @@
1
1
  import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
2
- import { LoggerService, RootConfigService, SchedulerService } from '@backstage/backend-plugin-api';
2
+ import { LoggerService, RootConfigService, SchedulerService, CacheService, BackstageCredentials } from '@backstage/backend-plugin-api';
3
3
  import { Embeddings } from '@langchain/core/embeddings';
4
4
  import { ZodType, z } from 'zod';
5
+ import { BaseCallbackHandler } from '@langchain/core/callbacks/base';
6
+ import { JsonValue, Message } from '@sweetoburrito/backstage-plugin-ai-assistant-common';
5
7
  import { BaseChatModel } from '@langchain/core/language_models/chat_models';
8
+ import { CatalogService } from '@backstage/plugin-catalog-node';
6
9
 
7
10
  type EmbeddingsSource = string;
8
11
  /**
@@ -68,6 +71,25 @@ type Tool<T extends ZodType<any, any, any> = ZodType<any, any, any>> = {
68
71
  func: (params: z.infer<T>) => Promise<string>;
69
72
  };
70
73
 
74
+ type ChainCallbackOptions = Record<string, JsonValue> & {
75
+ modelId: string;
76
+ userId: string;
77
+ conversationId: string;
78
+ };
79
+ type ChainCallback = (options: ChainCallbackOptions) => BaseCallbackHandler;
80
+ type ScoreCallback = (options: {
81
+ name: string;
82
+ message: Message;
83
+ }) => Promise<void>;
84
+ type ChainMetadata = Record<string, JsonValue>;
85
+ type ChainMetadataCallback = (options: ChainCallbackOptions) => Promise<ChainMetadata>;
86
+ type CallbackProvider = {
87
+ id: string;
88
+ chainCallback?: ChainCallback;
89
+ scoreCallback?: ScoreCallback;
90
+ chainMetadataCallback?: ChainMetadataCallback;
91
+ };
92
+
71
93
  type DataIngestorExtensionPoint = {
72
94
  registerIngestor: (ingestor: Ingestor) => void;
73
95
  };
@@ -91,6 +113,10 @@ type ToolExtensionPoint = {
91
113
  register: (tool: Tool<ZodType>) => void;
92
114
  };
93
115
  declare const toolExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ToolExtensionPoint>;
116
+ type CallbackExtensionPoint = {
117
+ register: (callback: CallbackProvider) => void;
118
+ };
119
+ declare const callbackProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CallbackExtensionPoint>;
94
120
 
95
121
  type CreateAssistantToolOptions<T extends ZodType<any, any, any>> = {
96
122
  tool: Tool<T>;
@@ -99,5 +125,10 @@ declare const createAssistantTool: <T extends ZodType<any, any, any>>(options: C
99
125
 
100
126
  declare function streamToString(readableStream: NodeJS.ReadableStream | null): Promise<string>;
101
127
 
102
- export { createAssistantTool, dataIngestorExtensionPoint, embeddingsProviderExtensionPoint, modelProviderExtensionPoint, streamToString, toolExtensionPoint };
103
- export type { AugmentationIndexer, DataIngestionPipeline, DataIngestionPipelineOptions, DataIngestorExtensionPoint, Embedding, EmbeddingDocument, EmbeddingDocumentMetadata, EmbeddingsProvider, EmbeddingsProviderExtensionPoint, EmbeddingsSource, EntityFilterShape, Ingestor, IngestorOptions, Model, ModelProviderExtensionPoint, Tool, ToolExtensionPoint, VectorStore };
128
+ declare const encrypt: (text: string, key: string) => string;
129
+ declare const decrypt: (encryptedText: string, key: string) => string;
130
+
131
+ declare const getUser: (cache: CacheService, userEntityRef: string, credentials: BackstageCredentials, catalog: CatalogService) => Promise<any>;
132
+
133
+ export { callbackProviderExtensionPoint, createAssistantTool, dataIngestorExtensionPoint, decrypt, embeddingsProviderExtensionPoint, encrypt, getUser, modelProviderExtensionPoint, streamToString, toolExtensionPoint };
134
+ export type { AugmentationIndexer, CallbackExtensionPoint, CallbackProvider, ChainCallback, ChainCallbackOptions, ChainMetadata, ChainMetadataCallback, DataIngestionPipeline, DataIngestionPipelineOptions, DataIngestorExtensionPoint, Embedding, EmbeddingDocument, EmbeddingDocumentMetadata, EmbeddingsProvider, EmbeddingsProviderExtensionPoint, EmbeddingsSource, EntityFilterShape, Ingestor, IngestorOptions, Model, ModelProviderExtensionPoint, ScoreCallback, Tool, ToolExtensionPoint, VectorStore };
@@ -0,0 +1,32 @@
1
+ 'use strict';
2
+
3
+ var crypto = require('crypto');
4
+
5
+ const normalizeKey = (key) => {
6
+ return crypto.createHash("sha256").update(key).digest();
7
+ };
8
+ const encrypt = (text, key) => {
9
+ const iv = crypto.randomBytes(16);
10
+ const normalizedKey = normalizeKey(key);
11
+ const cipher = crypto.createCipheriv("aes-256-gcm", normalizedKey, iv);
12
+ let encrypted = cipher.update(text, "utf8", "hex");
13
+ encrypted += cipher.final("hex");
14
+ const authTag = cipher.getAuthTag();
15
+ return `${iv.toString("hex")}:${encrypted}:${authTag.toString("hex")}`;
16
+ };
17
+ const decrypt = (encryptedText, key) => {
18
+ const parts = encryptedText.split(":");
19
+ const iv = Buffer.from(parts[0], "hex");
20
+ const encrypted = parts[1];
21
+ const authTag = Buffer.from(parts[2], "hex");
22
+ const normalizedKey = normalizeKey(key);
23
+ const decipher = crypto.createDecipheriv("aes-256-gcm", normalizedKey, iv);
24
+ decipher.setAuthTag(authTag);
25
+ let decrypted = decipher.update(encrypted, "hex", "utf8");
26
+ decrypted += decipher.final("utf8");
27
+ return decrypted;
28
+ };
29
+
30
+ exports.decrypt = decrypt;
31
+ exports.encrypt = encrypt;
32
+ //# sourceMappingURL=encrypt.cjs.js.map
@@ -0,0 +1 @@
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;;;;;"}
@@ -0,0 +1,16 @@
1
+ 'use strict';
2
+
3
+ const getUser = async (cache, userEntityRef, credentials, catalog) => {
4
+ const cached = await cache.get(userEntityRef);
5
+ if (cached) {
6
+ return JSON.parse(String(cached));
7
+ }
8
+ const user = await catalog.getEntityByRef(userEntityRef, {
9
+ credentials
10
+ });
11
+ await cache.set(userEntityRef, JSON.stringify(user));
12
+ return user;
13
+ };
14
+
15
+ exports.getUser = getUser;
16
+ //# sourceMappingURL=get-user.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-user.cjs.js","sources":["../../src/utils/get-user.ts"],"sourcesContent":["import {\n BackstageCredentials,\n CacheService,\n} from '@backstage/backend-plugin-api';\nimport { UserEntity } from '@backstage/catalog-model';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\n\nexport const getUser = async (\n cache: CacheService,\n userEntityRef: string,\n credentials: BackstageCredentials,\n catalog: CatalogService,\n) => {\n const cached = await cache.get(userEntityRef);\n\n if (cached) {\n return JSON.parse(String(cached));\n }\n\n const user = (await catalog.getEntityByRef(userEntityRef, {\n credentials,\n })) as UserEntity | undefined;\n await cache.set(userEntityRef, JSON.stringify(user));\n\n return user;\n};\n"],"names":[],"mappings":";;AAOO,MAAM,OAAA,GAAU,OACrB,KAAA,EACA,aAAA,EACA,aACA,OAAA,KACG;AACH,EAAA,MAAM,MAAA,GAAS,MAAM,KAAA,CAAM,GAAA,CAAI,aAAa,CAAA;AAE5C,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,MAAA,CAAO,MAAM,CAAC,CAAA;AAAA,EAClC;AAEA,EAAA,MAAM,IAAA,GAAQ,MAAM,OAAA,CAAQ,cAAA,CAAe,aAAA,EAAe;AAAA,IACxD;AAAA,GACD,CAAA;AACD,EAAA,MAAM,MAAM,GAAA,CAAI,aAAA,EAAe,IAAA,CAAK,SAAA,CAAU,IAAI,CAAC,CAAA;AAEnD,EAAA,OAAO,IAAA;AACT;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sweetoburrito/backstage-plugin-ai-assistant-node",
3
- "version": "0.5.1",
3
+ "version": "0.6.0",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Node.js library for the ai-assistant plugin",
6
6
  "main": "dist/index.cjs.js",
@@ -36,7 +36,10 @@
36
36
  ],
37
37
  "dependencies": {
38
38
  "@backstage/backend-plugin-api": "backstage:^",
39
+ "@backstage/catalog-model": "backstage:^",
40
+ "@backstage/plugin-catalog-node": "backstage:^",
39
41
  "@langchain/core": "^0.3.72",
42
+ "@sweetoburrito/backstage-plugin-ai-assistant-common": "workspace:^",
40
43
  "zod": "^4.1.11"
41
44
  },
42
45
  "typesVersions": {