feat: add support for AMD module id in umd bundles (#675)

Author: thelgevold

integration/samples/comments-remove/specs/umd.ts

@@ -15,6 +15,10 @@ describe(`@sample/sample-comments-remove`, () => {
     it(`should not contain all the comments by default`, () => {
       expect(BUNDLE).not.to.contain(`Copyright  Example Software.`);
     });
+
+    it(`should use lib name as amd id`, () => {
+      expect(BUNDLE).to.contain(`define('@sample/comments-remove', ['exports'`);
+    });
   });
 
   describe(`sample-comments-remove.umd.min.js`, () => {

integration/samples/comments/ng-package.json

@@ -1,6 +1,7 @@
 {
   "$schema": "../../../src/ng-package.schema.json",
   "lib": {
-    "entryFile": "public_api.ts"
+    "entryFile": "public_api.ts",
+    "amdId": "@mylib/test"
   }
 }

integration/samples/comments/specs/umd.ts

@@ -12,6 +12,10 @@ describe(`@sample/comments`, () => {
     it(`should contain all the comments by default`, () => {
       expect(BUNDLE).to.contain(`Copyright  Example Software.`);
     });
+
+    it(`should give the umd an amd id`, () => {
+      expect(BUNDLE).to.contain(`define('@mylib/test', ['exports'`);
+    });
   });
 
   describe(`sample-comments.umd.min.js`, () => {

src/lib/flatten/flatten.ts

@@ -17,6 +17,8 @@ export interface FlattenOpts {
   /** List of module ids that should be embedded to the bundle. */
   embedded?: string[];
 
+  amdId?: string;
+
   /** Map of external UMD module ids that  */
   umdModuleIds?: { [key: string]: string };
 }
@@ -79,6 +81,7 @@ export async function flattenToUmd(opts: FlattenOpts): Promise<string> {
     entry: opts.entryFile,
     format: 'umd',
     dest: destFile,
+    amd: { id: opts.amdId },
     umdModuleIds: {
       ...opts.umdModuleIds
     },

src/lib/flatten/rollup.ts

@@ -24,6 +24,7 @@ export interface RollupOptions {
   comments?: string;
   licensePath?: string;
   transform?: TransformHook;
+  amd?: { id: string };
 }
 
 /** Runs rollup over the given entry file, writes a bundle file. */
@@ -76,6 +77,7 @@ export async function rollupBundleFile(opts: RollupOptions): Promise<void> {
     name: `${opts.moduleName}`,
     file: opts.dest,
     format: opts.format,
+    amd: opts.amd,
     banner: '',
     globals: moduleId => umdModuleIdStrategy(moduleId, opts.umdModuleIds || {}),
     sourcemap: true

src/lib/ng-package-format/entry-point.ts

@@ -91,6 +91,10 @@ export class NgEntryPoint {
     return this.$get('lib.jsx');
   }
 
+  public get amdId(): string {
+    return this.$get('lib.amdId') || this.moduleId;
+  }
+
   public get flatModuleFile(): string {
     return this.$get('lib.flatModuleFile') || this.flattenModuleId('-');
   }

src/lib/ng-v5/entry-point/write-bundles.transform.ts

@@ -23,7 +23,8 @@ export const writeBundlesTransform: Transform = pipe(
       umdModuleIds: ngEntryPoint.umdModuleIds,
       embedded: ngEntryPoint.embedded,
       comments: ngEntryPoint.comments,
-      licensePath: ngEntryPoint.licensePath
+      licensePath: ngEntryPoint.licensePath,
+      amdId: ngEntryPoint.amdId
     };
 
     return fromPromise(writeFlatBundleFiles(opts)).pipe(map(() => graph));

src/ng-package.schema.json

@@ -98,6 +98,10 @@
             "type": "string"
           },
           "default": ["dom", "es2015"]
+        },
+        "amdId": {
+          "description": "ID for AMD module",
+          "type": "string"
         }
       }
     }