@drodil/backstage-plugin-qeta-node 3.9.3 → 3.10.1

package/dist/extensions.cjs.js

@@ -5,6 +5,10 @@ var backendPluginApi = require('@backstage/backend-plugin-api');
 const qetaAIExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "qeta.ai"
 });
+const qetaTagDatabaseExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "qeta.tags"
+});
 
 exports.qetaAIExtensionPoint = qetaAIExtensionPoint;
+exports.qetaTagDatabaseExtensionPoint = qetaTagDatabaseExtensionPoint;
 //# sourceMappingURL=extensions.cjs.js.map

package/dist/extensions.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["import {\n  BackstageCredentials,\n  BackstageUserPrincipal,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport {\n  AIResponse,\n  Article,\n  Question,\n} from '@drodil/backstage-plugin-qeta-common';\n\nexport interface AIHandler {\n  /**\n   * Answer question that has already been posted in the question page\n   */\n  answerExistingQuestion?(\n    question: Question,\n    options?: { credentials?: BackstageCredentials<BackstageUserPrincipal> },\n  ): Promise<AIResponse>;\n\n  /**\n   * Answer a draft question in the Ask a question page\n   */\n  answerNewQuestion?(\n    title: string,\n    content: string,\n    options?: { credentials?: BackstageCredentials<BackstageUserPrincipal> },\n  ): Promise<AIResponse>;\n\n  /**\n   * Summarize article\n   */\n  summarizeArticle?(\n    article: Article,\n    options?: { credentials?: BackstageCredentials<BackstageUserPrincipal> },\n  ): Promise<AIResponse>;\n}\n\nexport interface QetaAIExtensionPoint {\n  setAIHandler(handler: AIHandler): void;\n}\n\nexport const qetaAIExtensionPoint = createExtensionPoint<QetaAIExtensionPoint>({\n  id: 'qeta.ai',\n});\n"],"names":["createExtensionPoint"],"mappings":";;;;AA0CO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA,SAAA;AACN,CAAC;;;;"}
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["import {\n  BackstageCredentials,\n  BackstageUserPrincipal,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport {\n  AIResponse,\n  Article,\n  Question,\n} from '@drodil/backstage-plugin-qeta-common';\n\nexport interface AIHandler {\n  /**\n   * Answer question that has already been posted in the question page\n   */\n  answerExistingQuestion?(\n    question: Question,\n    options?: { credentials?: BackstageCredentials<BackstageUserPrincipal> },\n  ): Promise<AIResponse>;\n\n  /**\n   * Answer a draft question in the Ask a question page\n   */\n  answerNewQuestion?(\n    title: string,\n    content: string,\n    options?: { credentials?: BackstageCredentials<BackstageUserPrincipal> },\n  ): Promise<AIResponse>;\n\n  /**\n   * Summarize article\n   */\n  summarizeArticle?(\n    article: Article,\n    options?: { credentials?: BackstageCredentials<BackstageUserPrincipal> },\n  ): Promise<AIResponse>;\n\n  /**\n   * Check if answering existing questions is enabled for specific credentials. Defaults to true.\n   * Must also implement the `answerExistingQuestion` method.\n   */\n  isExistingQuestionEnabled?(options?: {\n    credentials?: BackstageCredentials;\n  }): Promise<boolean>;\n\n  /**\n   * Check if answering new questions is enabled for specific credentials. Defaults to true.\n   * Must also implement the `answerNewQuestion` method.\n   */\n  isNewQuestionEnabled?(options?: {\n    credentials?: BackstageCredentials;\n  }): Promise<boolean>;\n\n  /**\n   * Check if article summarization is enabled for specific credentials. Defaults to true.\n   * Must also implement the `summarizeArticle` method.\n   */\n  isArticleSummarizationEnabled?(options?: {\n    credentials?: BackstageCredentials;\n  }): Promise<boolean>;\n}\n\nexport interface QetaAIExtensionPoint {\n  setAIHandler(handler: AIHandler): void;\n}\n\nexport interface TagDatabase {\n  /**\n   * Get custom tag descriptions that are updated to the plugin.\n   * The format is {`tag name`: `tag description`}.\n   */\n  getTags(): Promise<Record<string, string>>;\n}\n\nexport interface QetaTagDatabaseExtensionPoint {\n  setTagDatabase(tagDatabase: TagDatabase): void;\n}\n\nexport const qetaAIExtensionPoint = createExtensionPoint<QetaAIExtensionPoint>({\n  id: 'qeta.ai',\n});\n\nexport const qetaTagDatabaseExtensionPoint =\n  createExtensionPoint<QetaTagDatabaseExtensionPoint>({\n    id: 'qeta.tags',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA8EO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA,SAAA;AACN,CAAC,EAAA;AAEM,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA,WAAA;AACN,CAAC;;;;;"}

package/dist/index.cjs.js

@@ -5,4 +5,5 @@ var extensions = require('./extensions.cjs.js');
 
 
 exports.qetaAIExtensionPoint = extensions.qetaAIExtensionPoint;
+exports.qetaTagDatabaseExtensionPoint = extensions.qetaTagDatabaseExtensionPoint;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

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

package/dist/index.d.ts

@@ -21,10 +21,42 @@ interface AIHandler {
     summarizeArticle?(article: Article, options?: {
         credentials?: BackstageCredentials<BackstageUserPrincipal>;
     }): Promise<AIResponse>;
+    /**
+     * Check if answering existing questions is enabled for specific credentials. Defaults to true.
+     * Must also implement the `answerExistingQuestion` method.
+     */
+    isExistingQuestionEnabled?(options?: {
+        credentials?: BackstageCredentials;
+    }): Promise<boolean>;
+    /**
+     * Check if answering new questions is enabled for specific credentials. Defaults to true.
+     * Must also implement the `answerNewQuestion` method.
+     */
+    isNewQuestionEnabled?(options?: {
+        credentials?: BackstageCredentials;
+    }): Promise<boolean>;
+    /**
+     * Check if article summarization is enabled for specific credentials. Defaults to true.
+     * Must also implement the `summarizeArticle` method.
+     */
+    isArticleSummarizationEnabled?(options?: {
+        credentials?: BackstageCredentials;
+    }): Promise<boolean>;
 }
 interface QetaAIExtensionPoint {
     setAIHandler(handler: AIHandler): void;
 }
+interface TagDatabase {
+    /**
+     * Get custom tag descriptions that are updated to the plugin.
+     * The format is {`tag name`: `tag description`}.
+     */
+    getTags(): Promise<Record<string, string>>;
+}
+interface QetaTagDatabaseExtensionPoint {
+    setTagDatabase(tagDatabase: TagDatabase): void;
+}
 declare const qetaAIExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<QetaAIExtensionPoint>;
+declare const qetaTagDatabaseExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<QetaTagDatabaseExtensionPoint>;
 
-export { type AIHandler, type QetaAIExtensionPoint, qetaAIExtensionPoint };
+export { type AIHandler, type QetaAIExtensionPoint, type QetaTagDatabaseExtensionPoint, type TagDatabase, qetaAIExtensionPoint, qetaTagDatabaseExtensionPoint };

package/package.json

@@ -7,7 +7,7 @@
     "backstage.io",
     "node"
   ],
-  "version": "3.9.3",
+  "version": "3.10.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "prepublishOnly": "yarn tsc && yarn build",
@@ -54,6 +54,6 @@
   ],
   "dependencies": {
     "@backstage/backend-plugin-api": "^1.0.1",
-    "@drodil/backstage-plugin-qeta-common": "^3.9.3"
+    "@drodil/backstage-plugin-qeta-common": "^3.10.1"
   }
 }