@onecx/integration-interface 6.25.0 → 6.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onecx/integration-interface",
-  "version": "6.25.0",
+  "version": "6.27.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -9,8 +9,8 @@
   "peerDependencies": {
     "tslib": "^2.6.3",
     "rxjs": "^7.8.1",
-    "@onecx/accelerator": "^6.25.0",
-    "@onecx/nx-migration-utils": "^6.25.0",
+    "@onecx/accelerator": "^6.27.0",
+    "@onecx/nx-migration-utils": "^6.27.0",
     "@nx/devkit": "^20.3.0",
     "@phenomnomnominal/tsquery": "^6",
     "typescript": "^5.5.4"

package/src/index.d.ts

@@ -41,3 +41,5 @@ export * from './lib/services/icon.service';
 export * from './lib/topics/notification/v1/notification.model';
 export * from './lib/topics/notification/v1/notification.topic';
 export * from './lib/services/notification.service';
+export * from './lib/gatherers/ai-context/v1/ai-context.model';
+export * from './lib/gatherers/ai-context/v1/ai-context.gatherer';

package/src/index.js

@@ -44,4 +44,6 @@ tslib_1.__exportStar(require("./lib/services/icon.service"), exports);
 tslib_1.__exportStar(require("./lib/topics/notification/v1/notification.model"), exports);
 tslib_1.__exportStar(require("./lib/topics/notification/v1/notification.topic"), exports);
 tslib_1.__exportStar(require("./lib/services/notification.service"), exports);
+tslib_1.__exportStar(require("./lib/gatherers/ai-context/v1/ai-context.model"), exports);
+tslib_1.__exportStar(require("./lib/gatherers/ai-context/v1/ai-context.gatherer"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/integration-interface/src/index.ts"],"names":[],"mappings":";;;AAAA,wFAA6D;AAC7D,qFAA0D;AAC1D,0FAA+D;AAC/D,uFAA4D;AAE5D,0FAA+D;AAE/D,8FAAmE;AAEnE,4FAAiE;AACjE,oFAAyD;AACzD,6FAAkE;AAElE,0FAA+D;AAC/D,0FAA+D;AAE/D,4FAAiE;AAEjE,oGAAyE;AACzE,0GAA+E;AAC/E,4FAAiE;AACjE,wFAA6D;AAC7D,2FAAgE;AAEhE,iGAAsE;AAEtE,gFAAqD;AACrD,gFAAqD;AAErD,mGAAwE;AACxE,yGAA8E;AAC9E,uFAA4D;AAC5D,oGAAyE;AAEzE,wFAA6D;AAE7D,gGAAqE;AACrE,gGAAqE;AAErE,8EAAmD;AACnD,kFAAuD;AACvD,sFAA2D;AAC3D,yFAA8D;AAE9D,kGAAuE;AACvE,kGAAuE;AAEvE,sFAA2D;AAE3D,+FAAoE;AACpE,+FAAoE;AACpE,kFAAuD;AAEvD,2EAAgD;AAChD,2EAAgD;AAChD,sEAA2C;AAE3C,0FAA+D;AAC/D,0FAA+D;AAC/D,8EAAmD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/integration-interface/src/index.ts"],"names":[],"mappings":";;;AAAA,wFAA6D;AAC7D,qFAA0D;AAC1D,0FAA+D;AAC/D,uFAA4D;AAE5D,0FAA+D;AAE/D,8FAAmE;AAEnE,4FAAiE;AACjE,oFAAyD;AACzD,6FAAkE;AAElE,0FAA+D;AAC/D,0FAA+D;AAE/D,4FAAiE;AAEjE,oGAAyE;AACzE,0GAA+E;AAC/E,4FAAiE;AACjE,wFAA6D;AAC7D,2FAAgE;AAEhE,iGAAsE;AAEtE,gFAAqD;AACrD,gFAAqD;AAErD,mGAAwE;AACxE,yGAA8E;AAC9E,uFAA4D;AAC5D,oGAAyE;AAEzE,wFAA6D;AAE7D,gGAAqE;AACrE,gGAAqE;AAErE,8EAAmD;AACnD,kFAAuD;AACvD,sFAA2D;AAC3D,yFAA8D;AAE9D,kGAAuE;AACvE,kGAAuE;AAEvE,sFAA2D;AAE3D,+FAAoE;AACpE,+FAAoE;AACpE,kFAAuD;AAEvD,2EAAgD;AAChD,2EAAgD;AAChD,sEAA2C;AAE3C,0FAA+D;AAC/D,0FAA+D;AAC/D,8EAAmD;AACnD,yFAA8D;AAC9D,4FAAiE"}

package/src/lib/gatherers/ai-context/v1/ai-context.gatherer.d.ts

@@ -0,0 +1,22 @@
+import { Gatherer } from "@onecx/accelerator";
+import type { AiContextRequest, AiContextResponse } from "./ai-context.model";
+/**
+ * This class can be used to provide a context for AI-specific features.
+ * It allows gathering information about all applications, products, and contexts in which the AI is being used.
+ *
+ * @example
+ * ```ts
+ *
+ * // add a gatherer to the constructor of the page component that should provide AI context information
+ * // in ngOnDestroy, call the gatherer.destroy() method to clean up resources
+ *
+ * const aiContextGatherer = new AiContextGatherer(async (request) => {
+ *     // decide if your app whats to contribute to the AI context or not
+ *     // if you do not want to contribute, return null
+ *     // if you want to contribute, return an AiContextResponse object
+ * });
+ * ```
+ */
+export declare class AiContextGatherer extends Gatherer<AiContextRequest, AiContextResponse | null> {
+    constructor(callback: (request: AiContextRequest) => Promise<AiContextResponse | null>);
+}

package/src/lib/gatherers/ai-context/v1/ai-context.gatherer.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiContextGatherer = void 0;
+const accelerator_1 = require("@onecx/accelerator");
+/**
+ * This class can be used to provide a context for AI-specific features.
+ * It allows gathering information about all applications, products, and contexts in which the AI is being used.
+ *
+ * @example
+ * ```ts
+ *
+ * // add a gatherer to the constructor of the page component that should provide AI context information
+ * // in ngOnDestroy, call the gatherer.destroy() method to clean up resources
+ *
+ * const aiContextGatherer = new AiContextGatherer(async (request) => {
+ *     // decide if your app whats to contribute to the AI context or not
+ *     // if you do not want to contribute, return null
+ *     // if you want to contribute, return an AiContextResponse object
+ * });
+ * ```
+ */
+class AiContextGatherer extends accelerator_1.Gatherer {
+    constructor(callback) {
+        super("aiContext", 1, callback);
+    }
+}
+exports.AiContextGatherer = AiContextGatherer;
+//# sourceMappingURL=ai-context.gatherer.js.map

package/src/lib/gatherers/ai-context/v1/ai-context.gatherer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-context.gatherer.js","sourceRoot":"","sources":["../../../../../../../../libs/integration-interface/src/lib/gatherers/ai-context/v1/ai-context.gatherer.ts"],"names":[],"mappings":";;;AAAA,oDAA6C;AAI7C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,iBAAkB,SAAQ,sBAAoD;IAEvF,YAAY,QAA0E;QAClF,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAA;IACnC,CAAC;CACJ;AALD,8CAKC"}

package/src/lib/gatherers/ai-context/v1/ai-context.model.d.ts

@@ -0,0 +1,11 @@
+export interface AiContextRequest {
+    agent: {
+        name: string;
+    };
+}
+export interface AiContextResponse {
+    productName: string;
+    appId: string;
+    appPath: string;
+    context: string;
+}

package/src/lib/gatherers/ai-context/v1/ai-context.model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ai-context.model.js.map

package/src/lib/gatherers/ai-context/v1/ai-context.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-context.model.js","sourceRoot":"","sources":["../../../../../../../../libs/integration-interface/src/lib/gatherers/ai-context/v1/ai-context.model.ts"],"names":[],"mappings":""}