@yaagoub/federation-tools 0.0.1

package/README.md

@@ -0,0 +1,63 @@
+# FederationTools
+
+This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
+
+## Code scaffolding
+
+Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+
+```bash
+ng generate component component-name
+```
+
+For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+
+```bash
+ng generate --help
+```
+
+## Building
+
+To build the library, run:
+
+```bash
+ng build federation-tools
+```
+
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+
+### Publishing the Library
+
+Once the project is built, you can publish your library by following these steps:
+
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/federation-tools
+   ```
+
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
+
+## Running unit tests
+
+To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+
+```bash
+ng test
+```
+
+## Running end-to-end tests
+
+For end-to-end (e2e) testing, run:
+
+```bash
+ng e2e
+```
+
+Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+
+## Additional Resources
+
+For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.

package/fesm2022/yaagoub-federation-tools.mjs

@@ -0,0 +1,84 @@
+import * as i0 from '@angular/core';
+import { Injectable, InjectionToken, inject, makeEnvironmentProviders, provideAppInitializer } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+import { firstValueFrom } from 'rxjs';
+
+class Federation {
+    getShellOrigin() {
+        return window.location.origin;
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.15", ngImport: i0, type: Federation, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.15", ngImport: i0, type: Federation, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.15", ngImport: i0, type: Federation, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root'
+                }]
+        }] });
+
+/**
+ * Holds all loaded env objects:
+ * - key: remoteName (from env-manifest.json) + 'shell'
+ * - value: parsed env.json for that remote
+ */
+const APP_CONFIG_ENV = new InjectionToken('env-settings');
+class Env {
+    http = inject(HttpClient);
+    federation = inject(Federation);
+    envMap = inject(APP_CONFIG_ENV);
+    getManifestUrl() {
+        return this.federation.getShellOrigin() + '/env-manifest.json';
+    }
+    getShellEnvUrl() {
+        return this.federation.getShellOrigin() + '/env.json';
+    }
+    getRemoteEnvUrl(origin) {
+        return origin.replace(/\/+$/, '') + '/env.json';
+    }
+    async load() {
+        try {
+            const envManifest = await firstValueFrom(this.http.get(this.getManifestUrl()));
+            const remoteNames = Object.keys(envManifest);
+            const remoteLoads = remoteNames.map(async (remoteName) => {
+                const remoteOrigin = envManifest[remoteName];
+                const env = await firstValueFrom(this.http.get(this.getRemoteEnvUrl(remoteOrigin)));
+                this.envMap.set(remoteName, env);
+            });
+            await Promise.all(remoteLoads);
+            const shellEnv = await firstValueFrom(this.http.get(this.getShellEnvUrl()));
+            this.envMap.set('shell', shellEnv);
+        }
+        catch (e) {
+            throw new Error(`Failed to load environment configuration; cannot continue. ${e?.message ?? e}`);
+        }
+    }
+    get(remoteName = 'shell') {
+        const v = this.envMap.get(remoteName);
+        if (!v) {
+            throw new Error(`Env for "${remoteName}" not loaded. Did you register provideAppInitializer(() => env.load()) ?`);
+        }
+        return v;
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.15", ngImport: i0, type: Env, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.15", ngImport: i0, type: Env, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.15", ngImport: i0, type: Env, decorators: [{
+            type: Injectable,
+            args: [{ providedIn: 'root' }]
+        }] });
+
+function provideFederationEnv() {
+    return makeEnvironmentProviders([
+        Env, Federation,
+        { provide: APP_CONFIG_ENV, useValue: new Map() },
+        provideAppInitializer(() => inject(Env).load()),
+    ]);
+}
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { provideFederationEnv };
+//# sourceMappingURL=yaagoub-federation-tools.mjs.map

package/fesm2022/yaagoub-federation-tools.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaagoub-federation-tools.mjs","sources":["../../../projects/federation-tools/src/federation/federation.service.ts","../../../projects/federation-tools/src/env/env.service.ts","../../../projects/federation-tools/src/providers/provide.ts","../../../projects/federation-tools/src/yaagoub-federation-tools.ts"],"sourcesContent":["import { Injectable } from \"@angular/core\";\r\n\r\n@Injectable({\r\n  providedIn: 'root'\r\n})\r\nexport class Federation {\r\n  getShellOrigin(): string {\r\n    return window.location.origin;\r\n  }\r\n}\r\n","import { inject, Injectable } from '@angular/core';\r\nimport { HttpClient } from '@angular/common/http';\r\nimport { firstValueFrom } from 'rxjs';\r\nimport { InjectionToken } from '@angular/core';\r\nimport { Federation } from '../federation/federation.service';\r\n\r\nexport type EnvMap = Map<string, Record<string, any>>;\r\n\r\n/**\r\n * Holds all loaded env objects:\r\n * - key: remoteName (from env-manifest.json) + 'shell'\r\n * - value: parsed env.json for that remote\r\n */\r\nexport const APP_CONFIG_ENV = new InjectionToken<EnvMap>('env-settings');\r\n\r\n@Injectable({ providedIn: 'root' })\r\nexport class Env {\r\n  private http = inject(HttpClient);\r\n  private federation = inject(Federation);\r\n  private envMap: EnvMap = inject(APP_CONFIG_ENV);\r\n\r\n  private getManifestUrl(): string {\r\n    return this.federation.getShellOrigin() + '/env-manifest.json';\r\n  }\r\n\r\n  private getShellEnvUrl(): string {\r\n    return this.federation.getShellOrigin() + '/env.json';\r\n  }\r\n\r\n  private getRemoteEnvUrl(origin: string): string {\r\n    return origin.replace(/\\/+$/, '') + '/env.json';\r\n  }\r\n\r\n  async load(): Promise<void> {\r\n    try {\r\n      const envManifest = await firstValueFrom(\r\n        this.http.get<Record<string, string>>(this.getManifestUrl())\r\n      );\r\n\r\n      const remoteNames = Object.keys(envManifest);\r\n\r\n      const remoteLoads = remoteNames.map(async (remoteName) => {\r\n        const remoteOrigin = envManifest[remoteName];\r\n        const env = await firstValueFrom(\r\n          this.http.get<Record<string, any>>(this.getRemoteEnvUrl(remoteOrigin))\r\n        );\r\n        this.envMap.set(remoteName, env);\r\n      });\r\n\r\n      await Promise.all(remoteLoads);\r\n\r\n      const shellEnv = await firstValueFrom(\r\n        this.http.get<Record<string, any>>(this.getShellEnvUrl())\r\n      );\r\n      this.envMap.set('shell', shellEnv);\r\n\r\n    } catch (e: any) {\r\n      throw new Error(\r\n        `Failed to load environment configuration; cannot continue. ${e?.message ?? e}`\r\n      );\r\n    }\r\n  }\r\n\r\n  get(remoteName = 'shell'): Record<string, any> {\r\n    const v = this.envMap.get(remoteName);\r\n    if (!v) {\r\n      throw new Error(\r\n        `Env for \"${remoteName}\" not loaded. Did you register provideAppInitializer(() => env.load()) ?`\r\n      );\r\n    }\r\n    return v;\r\n  }\r\n}\r\n","import { EnvironmentProviders, inject, makeEnvironmentProviders, provideAppInitializer } from '@angular/core';\nimport { APP_CONFIG_ENV, Env, EnvMap } from '../env/env.service';\nimport { Federation } from '../federation/federation.service';\n\nexport function provideFederationEnv(): EnvironmentProviders {\n  return makeEnvironmentProviders([\n    Env, Federation,\n    { provide: APP_CONFIG_ENV, useValue: new Map() as EnvMap },\n    provideAppInitializer(() => inject(Env).load()),\n  ]);\n}","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;;;;MAKa,UAAU,CAAA;IACrB,cAAc,GAAA;AACZ,QAAA,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM;IAC/B;wGAHW,UAAU,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAV,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,UAAU,cAFT,MAAM,EAAA,CAAA;;4FAEP,UAAU,EAAA,UAAA,EAAA,CAAA;kBAHtB,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE;AACb,iBAAA;;;ACID;;;;AAIG;AACI,MAAM,cAAc,GAAG,IAAI,cAAc,CAAS,cAAc,CAAC;MAG3D,GAAG,CAAA;AACN,IAAA,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC;AACzB,IAAA,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;AAC/B,IAAA,MAAM,GAAW,MAAM,CAAC,cAAc,CAAC;IAEvC,cAAc,GAAA;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,oBAAoB;IAChE;IAEQ,cAAc,GAAA;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,WAAW;IACvD;AAEQ,IAAA,eAAe,CAAC,MAAc,EAAA;QACpC,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,WAAW;IACjD;AAEA,IAAA,MAAM,IAAI,GAAA;AACR,QAAA,IAAI;AACF,YAAA,MAAM,WAAW,GAAG,MAAM,cAAc,CACtC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAyB,IAAI,CAAC,cAAc,EAAE,CAAC,CAC7D;YAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;YAE5C,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,UAAU,KAAI;AACvD,gBAAA,MAAM,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC;AAC5C,gBAAA,MAAM,GAAG,GAAG,MAAM,cAAc,CAC9B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAsB,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CACvE;gBACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC;AAClC,YAAA,CAAC,CAAC;AAEF,YAAA,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;AAE9B,YAAA,MAAM,QAAQ,GAAG,MAAM,cAAc,CACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAsB,IAAI,CAAC,cAAc,EAAE,CAAC,CAC1D;YACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC;QAEpC;QAAE,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CACb,CAAA,2DAAA,EAA8D,CAAC,EAAE,OAAO,IAAI,CAAC,CAAA,CAAE,CAChF;QACH;IACF;IAEA,GAAG,CAAC,UAAU,GAAG,OAAO,EAAA;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,CAAC,EAAE;AACN,YAAA,MAAM,IAAI,KAAK,CACb,YAAY,UAAU,CAAA,wEAAA,CAA0E,CACjG;QACH;AACA,QAAA,OAAO,CAAC;IACV;wGAvDW,GAAG,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAH,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,GAAG,cADU,MAAM,EAAA,CAAA;;4FACnB,GAAG,EAAA,UAAA,EAAA,CAAA;kBADf,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE;;;SCXlB,oBAAoB,GAAA;AAClC,IAAA,OAAO,wBAAwB,CAAC;AAC9B,QAAA,GAAG,EAAE,UAAU;QACf,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAY,EAAE;QAC1D,qBAAqB,CAAC,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAChD,KAAA,CAAC;AACJ;;ACVA;;AAEG;;;;"}

package/index.d.ts

@@ -0,0 +1,5 @@
+import { EnvironmentProviders } from '@angular/core';
+
+declare function provideFederationEnv(): EnvironmentProviders;
+
+export { provideFederationEnv };

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@yaagoub/federation-tools",
+  "version": "0.0.1",
+  "peerDependencies": {
+    "@angular/common": ">=15.0.0",
+    "@angular/core": ">=15.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/yaagoub-federation-tools.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./fesm2022/yaagoub-federation-tools.mjs"
+    }
+  }
+}