@appshell/loader 0.1.0-alpha.1 → 0.1.0

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.1.0](https://github.com/navaris/appshell/compare/@appshell/loader@0.1.0-alpha.1...@appshell/loader@0.1.0) (2023-07-11)
+
+
+### Bug Fixes
+
+* registry projection, enable env overwrite, refactor docker workflow, consolidate env names ([33a28fe](https://github.com/navaris/appshell/commit/33a28fe76b58e05c5b6b6b33d4b402e52bb29e70))
+* rename @appshell/react-federated-component package to @appshell/react ([0b74498](https://github.com/navaris/appshell/commit/0b74498bf17ba73db4d936c8a012af1d3b111a28))
+* replace config intermediate file with template ([9b79e65](https://github.com/navaris/appshell/commit/9b79e65b355686a0cca273c89c7164bb031e8437))
+
+
+
+
+
 # [0.1.0-alpha.1](https://github.com/navaris/appshell/compare/@appshell/loader@0.0.3...@appshell/loader@0.1.0-alpha.1) (2023-07-05)
 
 

package/README.md

@@ -11,7 +11,7 @@
 
 # @appshell/loader
 
-Dynamically load federated components for Webpack Module federation micro-frontends.
+Dynamically load federated components for micro-frontends built with Appshell and Webpack Module federation.
 
 Working examples can be found [here](https://github.com/navaris/appshell/tree/main/examples).
 
@@ -40,21 +40,21 @@ The default export from this package is the loader function. It is given a manif
 ```ts
 import componentLoader from '@appshell/loader';
 
-const load = componentLoader(manifest);
+const load = componentLoader(index);
 
 const Component = load<MyComponent>('MyModule/MyComponent');
 
 render(<Component />);
 ```
 
-**Where does the manifest come from?**
+**Where does the index come from?**
 
 > See [@appshell/cli](https://www.npmjs.com/package/@appshell/cli)
 
 ```bash
-appshell generate manifest --configsDir appshell_configs
+appshell generate index --manifest dist/appshell.manifest.json
 ```
 
 **Do you have any framework specific loaders?**
 
-> See [@appshell/react-federated-component](https://www.npmjs.com/package/@appshell/react-federated-component) for a `React` loader.
+> See [@appshell/react](https://www.npmjs.com/package/@appshell/react) for a `React` loader.

package/__tests__/remoteLoader.spec.ts

@@ -1,9 +1,12 @@
 /** @jest-environment jsdom */
-import { AppshellManifest } from '@appshell/config';
+import { AppshellIndex, AppshellManifest } from '@appshell/config';
+import fetch, { enableFetchMocks } from 'jest-fetch-mock';
 import * as fetchDynamicScript from '../src/fetchDynamicScript';
 import * as loadFederatedComponent from '../src/loadFederatedComponent';
 import remoteLoader from '../src/remoteLoader';
 
+enableFetchMocks();
+
 jest.mock('../src/fetchDynamicScript');
 jest.mock('../src/loadFederatedComponent');
 
@@ -14,25 +17,36 @@ describe('remoteLoader', () => {
         id: 'test-component',
         scope: 'TestModule',
         module: './TestComponent',
-        url: 'http://test.com/remoteEntry.js',
+        manifestUrl: 'http://test.com/appshell.manifest.json',
+        remoteEntryUrl: 'http://test.com/remoteEntry.js',
         metadata: {},
       },
     },
     modules: {},
     environment: {},
   };
+  const index: AppshellIndex = {
+    'TestModule/TestComponent': 'http://test.com/appshell.manifest.json',
+  };
+
+  beforeEach(() => {
+    fetch.mockIf('http://test.com/appshell.manifest.json', () =>
+      Promise.resolve({ ok: true, body: JSON.stringify(manifest) }),
+    );
+  });
 
-  it('should return the federated component if it is found in the manifest', async () => {
+  it('should return the federated component if it is found in the registry', async () => {
     const ExpectedComponent = () => 'test component';
     jest.spyOn(fetchDynamicScript, 'default').mockReturnValueOnce(Promise.resolve(true));
     jest
       .spyOn(loadFederatedComponent, 'default')
       .mockResolvedValue(Promise.resolve(ExpectedComponent));
 
-    const loadRemote = remoteLoader(manifest);
-    const ActualComponent = await loadRemote('TestModule/TestComponent');
+    const loadRemote = remoteLoader(index);
+    const [ActualComponent, actualManifest] = await loadRemote('TestModule/TestComponent');
 
     expect(ActualComponent).toEqual(ExpectedComponent);
+    expect(actualManifest).toEqual(manifest);
   });
 
   it('should not fetch remote entry more than once', async () => {
@@ -44,7 +58,7 @@ describe('remoteLoader', () => {
       .spyOn(loadFederatedComponent, 'default')
       .mockResolvedValue(Promise.resolve(ExpectedComponent));
 
-    const loadRemote = remoteLoader(manifest);
+    const loadRemote = remoteLoader(index);
 
     await loadRemote('TestModule/TestComponent');
     await loadRemote('TestModule/TestComponent');
@@ -53,21 +67,22 @@ describe('remoteLoader', () => {
     expect(fetchDynamicScriptSpy).toHaveBeenCalledTimes(1);
   });
 
-  it('should throw if remote key is not found in the manifest', async () => {
+  it('should throw if remote key is not found in the registry', async () => {
     const ExpectedComponent = () => 'test component';
     jest.spyOn(loadFederatedComponent, 'default').mockResolvedValue(ExpectedComponent);
 
-    const loadRemote = remoteLoader(manifest);
+    const loadRemote = remoteLoader(index);
 
     await expect(loadRemote('TestModule/DoesNotExist')).rejects.toThrow(
-      /Remote resource not found in manifest/i,
+      /Remote resource not found in registry/i,
     );
   });
 
   it('should throw if load federated component fails', async () => {
+    jest.spyOn(fetchDynamicScript, 'default').mockReturnValueOnce(Promise.resolve(true));
     jest.spyOn(loadFederatedComponent, 'default').mockRejectedValue(new Error('failed'));
 
-    const loadRemote = remoteLoader(manifest);
+    const loadRemote = remoteLoader(index);
 
     await expect(loadRemote('TestModule/TestComponent')).rejects.toThrow(
       /Failed to load component/i,

package/dist/types/config/src/generate.env.d.ts

@@ -1,3 +1,3 @@
-declare const _default: (env: string, prefix?: string) => Promise<Map<string, string | number | undefined>>;
+declare const _default: (env: string, prefix?: string, overwrite?: boolean) => Promise<Map<string, string>>;
 export default _default;
 //# sourceMappingURL=generate.env.d.ts.map

package/dist/types/config/src/generate.env.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.env.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.env.ts"],"names":[],"mappings":"8BAO2B,MAAM;AAAjC,wBA6BK"}
+{"version":3,"file":"generate.env.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.env.ts"],"names":[],"mappings":"8BAO2B,MAAM;AAAjC,wBA8BK"}

package/dist/types/config/src/generate.index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.index.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAoB,MAAM,SAAS,CAAC;qCAGxB,MAAM,EAAE,KAAG,QAAQ,aAAa,CAAC;AAAnE,wBAgCE"}
+{"version":3,"file":"generate.index.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;qCAKN,MAAM,EAAE,KAAG,QAAQ,aAAa,CAAC;AAAnE,wBAyBE"}

package/dist/types/config/src/generate.manifest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates an appshell manifest
+ * @param templatePath path of the appshell manifest template to compile into an appshell manifest
+ * @returns an appshell manifest
+ */
+declare const _default: <TMetadata extends Record<string, unknown>>(templatePath: string) => Promise<import("./types").AppshellManifest<TMetadata> | null>;
+export default _default;
+//# sourceMappingURL=generate.manifest.d.ts.map

package/dist/types/config/src/generate.manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.manifest.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.manifest.ts"],"names":[],"mappings":"AAOA;;;;GAIG;kFAC4E,MAAM;AAArF,wBAaE"}

package/dist/types/config/src/generate.metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.metadata.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.metadata.ts"],"names":[],"mappings":"AACA,OAAO,EAAoB,QAAQ,EAAE,MAAM,SAAS,CAAC;mEAGW,MAAM,EAAE;AAAxE,wBAgCE"}
+{"version":3,"file":"generate.metadata.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.metadata.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;mEAK6B,MAAM,EAAE;AAAxE,wBAyBE"}

package/dist/types/config/src/index.d.ts

@@ -2,12 +2,12 @@
  * @appshell/config package API
  */
 export { default as configmap } from './configmap';
-export { default as generateManifest } from './generate';
 export { default as generateEnv } from './generate.env';
 export { default as generateIndex } from './generate.index';
+export { default as generateManifest } from './generate.manifest';
 export { default as generateMetadata } from './generate.metadata';
 export { default as register } from './register';
-export type { AppshellConfig, AppshellConfigRemote, AppshellIndex, AppshellManifest, AppshellRemote, Schema, } from './types';
+export type { AppshellConfig, AppshellConfigRemote, AppshellIndex, AppshellManifest, AppshellRemote, Metadata, Schema, } from './types';
 export * as utils from './utils';
 export * as validators from './validators';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/config/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../config/src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,MAAM,GACP,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../config/src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,QAAQ,EACR,MAAM,GACP,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC"}

package/dist/types/config/src/register.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../../../../config/src/register.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;mCAGX,gBAAgB,YAAY,MAAM;AAAlE,wBAgBE"}
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../../../../config/src/register.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAmB,MAAM,SAAS,CAAC;mCAc5B,gBAAgB,YAAY,MAAM;AAAlE,wBA4BE"}

package/dist/types/config/src/utils/loadJson.d.ts

@@ -1,3 +1,3 @@
-declare const loadJson: <T extends object>(jsonPathOrUrl: string) => Promise<T[]>;
-export default loadJson;
+declare const _default: <T = Record<string, unknown>>(jsonPathOrUrl: string, target?: string | RegExp) => Promise<T[]>;
+export default _default;
 //# sourceMappingURL=loadJson.d.ts.map

package/dist/types/config/src/utils/loadJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadJson.d.ts","sourceRoot":"","sources":["../../../../../../config/src/utils/loadJson.ts"],"names":[],"mappings":"AAMA,QAAA,MAAM,QAAQ,oCAA2C,MAAM,iBAkB9D,CAAC;AAEF,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"loadJson.d.ts","sourceRoot":"","sources":["../../../../../../config/src/utils/loadJson.ts"],"names":[],"mappings":"qEAkCiB,MAAM,WACb,MAAM,GAAG,MAAM;AAFzB,wBAOE"}

package/dist/types/config/src/validators/appshell.index.d.ts

@@ -0,0 +1,4 @@
+import { ConfigValidator } from '../types';
+declare const _default: ConfigValidator;
+export default _default;
+//# sourceMappingURL=appshell.index.d.ts.map

package/dist/types/config/src/validators/appshell.index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appshell.index.d.ts","sourceRoot":"","sources":["../../../../../../config/src/validators/appshell.index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,eAAe,EAAE,MAAM,UAAU,CAAC;;AAE1D,wBAKqB"}

package/dist/types/config/src/validators/appshell.metadata.d.ts

@@ -0,0 +1,4 @@
+import { ConfigValidator } from '../types';
+declare const _default: ConfigValidator;
+export default _default;
+//# sourceMappingURL=appshell.metadata.d.ts.map

package/dist/types/config/src/validators/appshell.metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appshell.metadata.d.ts","sourceRoot":"","sources":["../../../../../../config/src/validators/appshell.metadata.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,eAAe,EAAE,MAAM,UAAU,CAAC;;AAE1D,wBAKqB"}

package/dist/types/config/src/validators/index.d.ts

@@ -1,4 +1,6 @@
 export { default as appshell_config } from './appshell.config';
+export { default as appshell_index } from './appshell.index';
 export { default as appshell_manifest } from './appshell.manifest';
+export { default as appshell_metadata } from './appshell.metadata';
 export { default as merge_manifests } from './merge.manifests';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/config/src/validators/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../config/src/validators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../config/src/validators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/types/loader/src/remoteLoader.d.ts

@@ -1,4 +1,4 @@
 import { type AppshellIndex, type AppshellManifest } from '@appshell/config';
-declare const _default: (index: AppshellIndex) => <TComponent>(key: string) => Promise<readonly [TComponent, AppshellManifest<import("packages/config/src/types").Metadata>] | readonly [null, null]>;
+declare const _default: (index: AppshellIndex) => <TComponent>(key: string) => Promise<readonly [TComponent, AppshellManifest<import("@appshell/config").Metadata>] | readonly [null, null]>;
 export default _default;
 //# sourceMappingURL=remoteLoader.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appshell/loader",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0",
   "description": "Utility for loading federated components",
   "main": "dist/main.js",
   "types": "dist/loader/src/index.d.ts",
@@ -25,5 +25,5 @@
     "appshell"
   ],
   "license": "MIT",
-  "gitHead": "b7cdb4671193d0938106fa5bbb154c10949e55c3"
+  "gitHead": "a20c074472f1f55b0479b07e95d63aa0ccdd4be9"
 }

package/dist/types/config/src/generate.d.ts

@@ -1,9 +0,0 @@
-/**
- * Generates an appshell manifest
- * @param configPath path of the appshell config to compile into an appshell manifest
- * @param webpackConfig path of the webpack config
- * @returns an appshell manifest
- */
-declare const _default: <TMetadata extends Record<string, unknown>>(configPath: string, webpackConfig?: string, webpackEnv?: {}, webpackArgs?: {}) => Promise<import("./types").AppshellManifest<TMetadata> | null>;
-export default _default;
-//# sourceMappingURL=generate.d.ts.map

package/dist/types/config/src/generate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../../../../config/src/generate.ts"],"names":[],"mappings":"AAyHA;;;;;GAKG;gFAEW,MAAM;AADpB,wBAsBE"}