@onecx/integration-interface 3.2.1

package/README.md

@@ -0,0 +1,11 @@
+# integration-interface
+
+This library contains everything that is needed to communicate with the shell and that is framework independent
+
+## Building
+
+Run `nx build integration-interface` to build the library.
+
+## Running unit tests
+
+Run `nx test integration-interface` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@onecx/integration-interface",
+  "version": "3.2.1",
+  "peerDependencies": {
+    "tslib": "^2.3.0",
+    "rxjs": "7.8.1",
+    "@onecx/accelerator": "^3"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from './lib/topics/current-mfe/v1/current-mfe.topic';
+export * from './lib/topics/current-page/v1/current-page.topic';
+export * from './lib/topics/global-error/v1/global-error.topic';
+export * from './lib/topics/global-loading/v1/global-loading.topic';
+export * from './lib/topics/current-theme/v1/current-theme.topic';

package/src/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/topics/current-mfe/v1/current-mfe.topic"), exports);
+tslib_1.__exportStar(require("./lib/topics/current-page/v1/current-page.topic"), exports);
+tslib_1.__exportStar(require("./lib/topics/global-error/v1/global-error.topic"), exports);
+tslib_1.__exportStar(require("./lib/topics/global-loading/v1/global-loading.topic"), exports);
+tslib_1.__exportStar(require("./lib/topics/current-theme/v1/current-theme.topic"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/integration-interface/src/index.ts"],"names":[],"mappings":";;;AAAA,wFAA6D;AAC7D,0FAA+D;AAC/D,0FAA+D;AAC/D,8FAAmE;AACnE,4FAAiE"}

package/src/lib/topics/current-mfe/v1/current-mfe.topic.d.ts

@@ -0,0 +1,5 @@
+import { Topic } from '@onecx/accelerator';
+import { MfeInfo } from './mfe-info.model';
+export declare class CurrentMfeTopic extends Topic<MfeInfo> {
+    constructor();
+}

package/src/lib/topics/current-mfe/v1/current-mfe.topic.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrentMfeTopic = void 0;
+const accelerator_1 = require("@onecx/accelerator");
+class CurrentMfeTopic extends accelerator_1.Topic {
+    constructor() {
+        super('currentMfe', 1);
+    }
+}
+exports.CurrentMfeTopic = CurrentMfeTopic;
+//# sourceMappingURL=current-mfe.topic.js.map

package/src/lib/topics/current-mfe/v1/current-mfe.topic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"current-mfe.topic.js","sourceRoot":"","sources":["../../../../../../../../libs/integration-interface/src/lib/topics/current-mfe/v1/current-mfe.topic.ts"],"names":[],"mappings":";;;AAAA,oDAA0C;AAG1C,MAAa,eAAgB,SAAQ,mBAAc;IACjD;QACE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;IACxB,CAAC;CACF;AAJD,0CAIC"}

package/src/lib/topics/current-mfe/v1/mfe-info.model.d.ts

@@ -0,0 +1,9 @@
+export interface MfeInfo {
+    mountPath: string;
+    version?: string;
+    remote?: string;
+    remoteBaseUrl: string;
+    baseHref: string;
+    shellName: string;
+    displayName?: string;
+}

package/src/lib/topics/current-mfe/v1/mfe-info.model.js

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

package/src/lib/topics/current-mfe/v1/mfe-info.model.js.map

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

package/src/lib/topics/current-page/v1/current-page.topic.d.ts

@@ -0,0 +1,12 @@
+import { Topic } from '@onecx/accelerator';
+import { PageInfo } from './page-info.model';
+/**
+ * This topic will only fire when pageInfo.path matches document.location.pathname,
+ * if not it will fire undefined.
+ */
+export declare class CurrentPageTopic extends Topic<PageInfo | undefined> {
+    private currentPath$;
+    constructor();
+    asObservable(): import("rxjs").Observable<PageInfo | undefined>;
+    private watchForPathChanges;
+}

package/src/lib/topics/current-page/v1/current-page.topic.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrentPageTopic = void 0;
+const accelerator_1 = require("@onecx/accelerator");
+const rxjs_1 = require("rxjs");
+const BehaviorSubject_1 = require("rxjs/internal/BehaviorSubject");
+/**
+ * This topic will only fire when pageInfo.path matches document.location.pathname,
+ * if not it will fire undefined.
+ */
+class CurrentPageTopic extends accelerator_1.Topic {
+    currentPath$ = new BehaviorSubject_1.BehaviorSubject(document.location.pathname);
+    constructor() {
+        super('currentPage', 1);
+        this.watchForPathChanges();
+    }
+    asObservable() {
+        return (0, rxjs_1.combineLatest)([super.asObservable(), this.currentPath$.pipe((0, rxjs_1.distinctUntilChanged)())]).pipe((0, rxjs_1.map)(([v, path]) => (v.path === path ? v : undefined)));
+    }
+    watchForPathChanges() {
+        const body = document.querySelector('body');
+        if (body === null) {
+            console.error('could not listen to location changes');
+            throw new Error('could not listen to location changes');
+        }
+        const observer = new MutationObserver(() => {
+            this.currentPath$.next(document.location.pathname);
+        });
+        observer.observe(body, { childList: true, subtree: true });
+    }
+}
+exports.CurrentPageTopic = CurrentPageTopic;
+//# sourceMappingURL=current-page.topic.js.map

package/src/lib/topics/current-page/v1/current-page.topic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"current-page.topic.js","sourceRoot":"","sources":["../../../../../../../../libs/integration-interface/src/lib/topics/current-page/v1/current-page.topic.ts"],"names":[],"mappings":";;;AAAA,oDAA0C;AAC1C,+BAA+D;AAC/D,mEAA+D;AAG/D;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,mBAA2B;IACvD,YAAY,GAAG,IAAI,iCAAe,CAAS,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAE9E;QACE,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,CAAC,mBAAmB,EAAE,CAAA;IAC5B,CAAC;IAEe,YAAY;QAC1B,OAAO,IAAA,oBAAa,EAAC,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAA,2BAAoB,GAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAC/F,IAAA,UAAG,EAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAY,CAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAClE,CAAA;IACH,CAAC;IAEO,mBAAmB;QACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,IAAI,KAAK,IAAI,EAAE;YACjB,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;YACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;SACxD;QACD,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,GAAG,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;QACF,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5D,CAAC;CACF;AAzBD,4CAyBC"}

package/src/lib/topics/current-page/v1/page-info.model.d.ts

@@ -0,0 +1,7 @@
+export interface PageInfo {
+    path: string;
+    helpArticleId?: string;
+    pageName?: string;
+    permission?: string;
+    applicationId?: string;
+}

package/src/lib/topics/current-page/v1/page-info.model.js

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

package/src/lib/topics/current-page/v1/page-info.model.js.map

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

package/src/lib/topics/current-theme/v1/current-theme.topic.d.ts

@@ -0,0 +1,5 @@
+import { Topic } from '@onecx/accelerator';
+import { Theme } from './theme.model';
+export declare class CurrentThemeTopic extends Topic<Theme> {
+    constructor();
+}

package/src/lib/topics/current-theme/v1/current-theme.topic.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrentThemeTopic = void 0;
+const accelerator_1 = require("@onecx/accelerator");
+class CurrentThemeTopic extends accelerator_1.Topic {
+    constructor() {
+        super('currentTheme', 1);
+    }
+}
+exports.CurrentThemeTopic = CurrentThemeTopic;
+//# sourceMappingURL=current-theme.topic.js.map

package/src/lib/topics/current-theme/v1/current-theme.topic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"current-theme.topic.js","sourceRoot":"","sources":["../../../../../../../../libs/integration-interface/src/lib/topics/current-theme/v1/current-theme.topic.ts"],"names":[],"mappings":";;;AAAA,oDAA0C;AAG1C,MAAa,iBAAkB,SAAQ,mBAAY;IACjD;QACE,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;IAC1B,CAAC;CACF;AAJD,8CAIC"}

package/src/lib/topics/current-theme/v1/theme.model.d.ts

@@ -0,0 +1,16 @@
+export interface Theme {
+    id?: string;
+    assetsUpdateDate?: string;
+    assetsUrl?: string;
+    logoUrl?: string;
+    faviconUrl?: string;
+    cssFile?: string;
+    description?: string;
+    name?: string;
+    previewImageUrl?: string;
+    properties?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    };
+}

package/src/lib/topics/current-theme/v1/theme.model.js

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

package/src/lib/topics/current-theme/v1/theme.model.js.map

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

package/src/lib/topics/global-error/v1/global-error.topic.d.ts

@@ -0,0 +1,4 @@
+import { Topic } from '@onecx/accelerator';
+export declare class GlobalErrorTopic extends Topic<string> {
+    constructor();
+}

package/src/lib/topics/global-error/v1/global-error.topic.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalErrorTopic = void 0;
+const accelerator_1 = require("@onecx/accelerator");
+class GlobalErrorTopic extends accelerator_1.Topic {
+    constructor() {
+        super('globalError', 1);
+    }
+}
+exports.GlobalErrorTopic = GlobalErrorTopic;
+//# sourceMappingURL=global-error.topic.js.map

package/src/lib/topics/global-error/v1/global-error.topic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-error.topic.js","sourceRoot":"","sources":["../../../../../../../../libs/integration-interface/src/lib/topics/global-error/v1/global-error.topic.ts"],"names":[],"mappings":";;;AAAA,oDAA0C;AAE1C,MAAa,gBAAiB,SAAQ,mBAAa;IACjD;QACE,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,CAAA;IACzB,CAAC;CACF;AAJD,4CAIC"}

package/src/lib/topics/global-loading/v1/global-loading.topic.d.ts

@@ -0,0 +1,4 @@
+import { Topic } from '@onecx/accelerator';
+export declare class GlobalLoadingTopic extends Topic<boolean> {
+    constructor();
+}

package/src/lib/topics/global-loading/v1/global-loading.topic.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalLoadingTopic = void 0;
+const accelerator_1 = require("@onecx/accelerator");
+class GlobalLoadingTopic extends accelerator_1.Topic {
+    constructor() {
+        super('globalLoading', 1);
+    }
+}
+exports.GlobalLoadingTopic = GlobalLoadingTopic;
+//# sourceMappingURL=global-loading.topic.js.map

package/src/lib/topics/global-loading/v1/global-loading.topic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-loading.topic.js","sourceRoot":"","sources":["../../../../../../../../libs/integration-interface/src/lib/topics/global-loading/v1/global-loading.topic.ts"],"names":[],"mappings":";;;AAAA,oDAA0C;AAE1C,MAAa,kBAAmB,SAAQ,mBAAc;IACpD;QACE,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAA;IAC3B,CAAC;CACF;AAJD,gDAIC"}