@sweetoburrito/backstage-plugin-ai-assistant-node 0.0.0-snapshot-20251113134620 → 0.0.0-snapshot-20251114125112

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,11 +14,11 @@ const modelProviderExtensionPoint = backendPluginApi.createExtensionPoint({
14
14
  const toolExtensionPoint = backendPluginApi.createExtensionPoint({
15
15
  id: "ai-assistant.tool"
16
16
  });
17
- const callbackFactoryExtensionPoint = backendPluginApi.createExtensionPoint({
17
+ const callbackProviderExtensionPoint = backendPluginApi.createExtensionPoint({
18
18
  id: "ai-assistant.callback"
19
19
  });
20
20
 
21
- exports.callbackFactoryExtensionPoint = callbackFactoryExtensionPoint;
21
+ exports.callbackProviderExtensionPoint = callbackProviderExtensionPoint;
22
22
  exports.dataIngestorExtensionPoint = dataIngestorExtensionPoint;
23
23
  exports.embeddingsProviderExtensionPoint = embeddingsProviderExtensionPoint;
24
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 { CallbackFactory, 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: CallbackFactory) => void;\n};\n\nexport const callbackFactoryExtensionPoint =\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,gCACXA,qCAAA,CAA6C;AAAA,EAC3C,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
@@ -4,10 +4,11 @@ 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
6
  var encrypt = require('./utils/encrypt.cjs.js');
7
+ var getUser = require('./utils/get-user.cjs.js');
7
8
 
8
9
 
9
10
 
10
- exports.callbackFactoryExtensionPoint = extensions.callbackFactoryExtensionPoint;
11
+ exports.callbackProviderExtensionPoint = extensions.callbackProviderExtensionPoint;
11
12
  exports.dataIngestorExtensionPoint = extensions.dataIngestorExtensionPoint;
12
13
  exports.embeddingsProviderExtensionPoint = extensions.embeddingsProviderExtensionPoint;
13
14
  exports.modelProviderExtensionPoint = extensions.modelProviderExtensionPoint;
@@ -16,4 +17,5 @@ exports.createAssistantTool = tool.createAssistantTool;
16
17
  exports.streamToString = streamToString.streamToString;
17
18
  exports.decrypt = encrypt.decrypt;
18
19
  exports.encrypt = encrypt.encrypt;
20
+ exports.getUser = getUser.getUser;
19
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,10 +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
5
  import { BaseCallbackHandler } from '@langchain/core/callbacks/base';
6
- import { JsonValue } from '@sweetoburrito/backstage-plugin-ai-assistant-common';
6
+ import { JsonValue, Message } from '@sweetoburrito/backstage-plugin-ai-assistant-common';
7
7
  import { BaseChatModel } from '@langchain/core/language_models/chat_models';
8
+ import { CatalogService } from '@backstage/plugin-catalog-node';
8
9
 
9
10
  type EmbeddingsSource = string;
10
11
  /**
@@ -70,16 +71,24 @@ type Tool<T extends ZodType<any, any, any> = ZodType<any, any, any>> = {
70
71
  func: (params: z.infer<T>) => Promise<string>;
71
72
  };
72
73
 
73
- type CallbackOptions = Record<string, JsonValue> & {
74
+ type ChainCallbackOptions = Record<string, JsonValue> & {
74
75
  modelId: string;
75
76
  userId: string;
76
77
  conversationId: string;
77
78
  };
78
- type Callback = {
79
- metadata: Record<string, JsonValue>;
80
- callback: BaseCallbackHandler;
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;
81
91
  };
82
- type CallbackFactory = (options: CallbackOptions) => Promise<Callback>;
83
92
 
84
93
  type DataIngestorExtensionPoint = {
85
94
  registerIngestor: (ingestor: Ingestor) => void;
@@ -105,9 +114,9 @@ type ToolExtensionPoint = {
105
114
  };
106
115
  declare const toolExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ToolExtensionPoint>;
107
116
  type CallbackExtensionPoint = {
108
- register: (callback: CallbackFactory) => void;
117
+ register: (callback: CallbackProvider) => void;
109
118
  };
110
- declare const callbackFactoryExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CallbackExtensionPoint>;
119
+ declare const callbackProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CallbackExtensionPoint>;
111
120
 
112
121
  type CreateAssistantToolOptions<T extends ZodType<any, any, any>> = {
113
122
  tool: Tool<T>;
@@ -119,5 +128,7 @@ declare function streamToString(readableStream: NodeJS.ReadableStream | null): P
119
128
  declare const encrypt: (text: string, key: string) => string;
120
129
  declare const decrypt: (encryptedText: string, key: string) => string;
121
130
 
122
- export { callbackFactoryExtensionPoint, createAssistantTool, dataIngestorExtensionPoint, decrypt, embeddingsProviderExtensionPoint, encrypt, modelProviderExtensionPoint, streamToString, toolExtensionPoint };
123
- export type { AugmentationIndexer, Callback, CallbackExtensionPoint, CallbackFactory, CallbackOptions, DataIngestionPipeline, DataIngestionPipelineOptions, DataIngestorExtensionPoint, Embedding, EmbeddingDocument, EmbeddingDocumentMetadata, EmbeddingsProvider, EmbeddingsProviderExtensionPoint, EmbeddingsSource, EntityFilterShape, Ingestor, IngestorOptions, Model, ModelProviderExtensionPoint, Tool, ToolExtensionPoint, VectorStore };
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,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.0.0-snapshot-20251113134620",
3
+ "version": "0.0.0-snapshot-20251114125112",
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,6 +36,8 @@
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",
40
42
  "@sweetoburrito/backstage-plugin-ai-assistant-common": "workspace:^",
41
43
  "zod": "^4.1.11"