add support for ESM

index.js

@@ -10,6 +10,7 @@ const { cpus } = require('os');
 const process = require('process');
 const npmResolve = require('resolve');
 const glob = require('glob');
+const moogRequire = require('./lib/moog-require');
 
 let defaults = require('./defaults.js');
 
@@ -293,7 +294,7 @@ async function apostrophe(options, telemetry, rootSpan) {
     self.aliasEvent('modulesReady', 'modulesRegistered');
     self.aliasEvent('afterInit', 'ready');
 
-    defineModules();
+    await defineModules();
 
     await instantiateModules();
     lintModules();
@@ -541,11 +542,11 @@ async function apostrophe(options, telemetry, rootSpan) {
     }
   }
 
-  function defineModules() {
+  async function defineModules() {
     // Set moog-require up to create our module manager objects
 
     self.localModules = self.options.modulesSubdir || self.options.__testLocalModules || (self.rootDir + '/modules');
-    const synth = require('./lib/moog-require')({
+    const synth = await moogRequire({
       root: self.root,
       bundles: [ 'apostrophe' ].concat(self.options.bundles || []),
       localModules: self.localModules,
@@ -572,9 +573,9 @@ async function apostrophe(options, telemetry, rootSpan) {
 
     nestedModuleSubdirs();
 
-    _.each(self.options.modules, function(options, name) {
-      synth.define(name, options);
-    });
+    for (const [ name, options ] of Object.entries(self.options.modules)) {
+      await synth.define(name, options);
+    }
 
     // Apostrophe prefers that any improvements to @apostrophecms/global
     // be applied before any project level version of @apostrophecms/global

lib/moog-require.js

@@ -3,11 +3,10 @@ const fs = require('fs');
 const npmResolve = require('resolve');
 const path = require('path');
 const glob = require('glob');
-const importFresh = require('import-fresh');
 const resolveFrom = require('resolve-from');
 const regExpQuote = require('regexp-quote');
 
-module.exports = function(options) {
+module.exports = async function(options) {
   const self = require('./moog')(options);
 
   if (!self.options.root) {
@@ -21,27 +20,28 @@ module.exports = function(options) {
   self.improvements = {};
 
   if (self.options.bundles) {
-    _.each(self.options.bundles, function(bundleName) {
+    for (const bundleName of Object.values(self.options.bundles)) {
       const bundlePath = getNpmPath(self.root.filename, bundleName);
       if (!bundlePath) {
         throw 'The configured bundle ' + bundleName + ' was not found in npm.';
       }
-      const imported = importFresh(bundlePath);
+      const { default: imported } = await import(bundlePath);
       if (!imported.bundle) {
         throw 'The configured bundle ' + bundleName + ' does not export a bundle property.';
       }
       const modules = imported.bundle.modules;
       if (!modules) {
         throw 'The configured bundle ' + bundleName + ' does not have a "modules" property within its "bundle" property.';
       }
-      _.each(modules, function(name) {
-        self.bundled[name] = path.normalize(path.dirname(bundlePath) + '/' + imported.bundle.directory + '/' + name + '/index.js');
-      });
-    });
+      Object.values(modules)
+        .forEach(name => {
+          self.bundled[name] = path.normalize(path.dirname(bundlePath) + '/' + imported.bundle.directory + '/' + name + '/index.js');
+        });
+    }
   }
 
   const superDefine = self.define;
-  self.define = function(type, definition, extending) {
+  self.define = async function(type, definition, extending) {
 
     let result;
 
@@ -76,7 +76,8 @@ module.exports = function(options) {
       projectLevelPath = matches[0] ? path.normalize(matches[0]) : projectLevelPath;
     }
     if (fs.existsSync(projectLevelPath)) {
-      projectLevelDefinition = importFresh(resolveFrom(path.dirname(self.root.filename), projectLevelPath));
+      const { default: defaultProjectLevelDefinition } = await import(resolveFrom(path.dirname(self.root.filename), projectLevelPath));
+      projectLevelDefinition = defaultProjectLevelDefinition;
       if (Object.keys(projectLevelDefinition).length === 0) {
         /* eslint-disable-next-line no-console */
         console.warn(`⚠️ The file ${projectLevelPath}\ndoes not export anything, did you misspell or forget module.exports?\n`);
@@ -92,7 +93,8 @@ module.exports = function(options) {
 
     const npmPath = getNpmPath(relativeTo, type);
     if (npmPath) {
-      npmDefinition = importFresh(npmPath);
+      const { default: defaultNpmDefinition } = await import(npmPath);
+      npmDefinition = defaultNpmDefinition;
       npmDefinition.__meta = {
         npm: true,
         bundled: _.has(self.bundled, type),
@@ -109,8 +111,8 @@ module.exports = function(options) {
         originalType = type;
         type = npmDefinition.improve;
         // If necessary, start by autoloading the original type
-        if (!self.isDefined(type, { autoload: false })) {
-          self.define(type);
+        if (!(await self.isDefined(type, { autoload: false }))) {
+          await self.define(type);
         }
       } else if (npmDefinition.replace) {
         // Replace an existing type with the one defined by
@@ -153,14 +155,14 @@ module.exports = function(options) {
     // in an implicit base class, allowing local template overrides
     // even if there is no other local code
     if (npmDefinition) {
-      result = superDefine(type, npmDefinition);
+      result = await superDefine(type, npmDefinition);
       if (npmDefinition.improve) {
         // Restore the name of the improving module as otherwise our asset chains have
         // multiple references to my-foo which is ambiguous
         result.__meta.name = originalType;
       }
     }
-    result = superDefine(type, definition);
+    result = await superDefine(type, definition);
     if (npmDefinition && npmDefinition.improve) {
       // Restore the name of the improving module as otherwise our asset chains have
       // multiple references to my-foo which is ambiguous

lib/moog.js

@@ -21,7 +21,7 @@ module.exports = function(options) {
   // moog-require that need to know about relative paths. Must
   // return the new definition for the convenience of moog-require too
 
-  self.define = function(className, definition, extending) {
+  self.define = async function(className, definition, extending) {
 
     if (!definition) {
       // This can happen because we use self.define as an autoloader
@@ -84,12 +84,12 @@ module.exports = function(options) {
     return definition;
   };
 
-  self.redefine = function(className, definition) {
+  self.redefine = async function(className, definition) {
     delete self.definitions[className];
     return self.define(className, definition);
   };
 
-  self.isDefined = function(className, options) {
+  self.isDefined = async function(className, options) {
     options = options || {};
     if (_.has(self.definitions, className)) {
       return true;
@@ -99,7 +99,7 @@ module.exports = function(options) {
     }
     try {
       // Can we autoload it?
-      self.define(className);
+      await self.define(className);
       // Yes, but we don't really want it yet
       delete self.definitions[className];
       return true;
@@ -117,7 +117,7 @@ module.exports = function(options) {
     const {
       that,
       steps
-    } = createPrep(className);
+    } = await createPrep(className);
 
     const options = {};
 
@@ -396,11 +396,11 @@ module.exports = function(options) {
   // about modules without instantiating them fully in a release build
   // environment, where database access is typically forbidden.
 
-  self.getMetadata = function(className) {
+  self.getMetadata = async function(className) {
     const {
       that,
       steps
-    } = createPrep(className);
+    } = await createPrep(className);
 
     // Now we want to start from the base class and go down
     steps.reverse();
@@ -474,7 +474,7 @@ module.exports = function(options) {
 
   return self;
 
-  function createPrep(className) {
+  async function createPrep(className) {
 
     const that = {};
     const steps = [];
@@ -500,7 +500,7 @@ module.exports = function(options) {
         if (!next) {
           // Try to use define as an autoloader. This will fail in
           // the default implementation
-          next = self.define(nextName, undefined, current);
+          next = await self.define(nextName, undefined, current);
         }
       }
     }

modules/@apostrophecms/asset/index.js

@@ -270,7 +270,7 @@ module.exports = {
             // we can access their metadata, which is sufficient
             for (const name of modulesToInstantiate) {
               const ancestorDirectories = [];
-              const metadata = self.apos.synth.getMetadata(name);
+              const metadata = await self.apos.synth.getMetadata(name);
               for (const entry of metadata.__meta.chain) {
                 const effectiveName = entry.name.replace(/^my-/, '');
                 names[effectiveName] = true;
@@ -327,14 +327,14 @@ module.exports = {
 
             let iconImports, componentImports, tiptapExtensionImports, appImports, indexJsImports, indexSassImports;
             if (options.apos) {
-              iconImports = getIcons();
-              componentImports = getImports(`${source}/components`, '*.vue', {
+              iconImports = await getIcons();
+              componentImports = await getImports(`${source}/components`, '*.vue', {
                 registerComponents: true,
                 importLastVersion: true
               });
               /* componentImports = getGlobalVueComponents(self); */
-              tiptapExtensionImports = getImports(`${source}/tiptap-extensions`, '*.js', { registerTiptapExtensions: true });
-              appImports = getImports(`${source}/apps`, '*.js', {
+              tiptapExtensionImports = await getImports(`${source}/tiptap-extensions`, '*.js', { registerTiptapExtensions: true });
+              appImports = await getImports(`${source}/apps`, '*.js', {
                 invokeApps: true,
                 enumerateImports: true,
                 importSuffix: 'App'
@@ -350,15 +350,15 @@ module.exports = {
                   [entry.name]: true
                 }), {});
 
-              indexJsImports = getImports(source, 'index.js', {
+              indexJsImports = await getImports(source, 'index.js', {
                 invokeApps: true,
                 enumerateImports: true,
                 importSuffix: 'App',
                 requireDefaultExport: true,
                 mainModuleBundles: getMainModuleBundleFiles('js'),
                 ignoreModules
               });
-              indexSassImports = getImports(source, 'index.scss', {
+              indexSassImports = await getImports(source, 'index.scss', {
                 importSuffix: 'Stylesheet',
                 enumerateImports: true,
                 mainModuleBundles: getMainModuleBundleFiles('scss'),
@@ -459,7 +459,7 @@ module.exports = {
                 //
                 // Of course, developers can push an "public" asset that is
                 // the output of an ES6 pipeline.
-                const publicImports = getImports(name, '*.js');
+                const publicImports = await getImports(name, '*.js');
                 fs.writeFileSync(`${bundleDir}/${name}-build.js`,
                   (((options.prologue || '') + '\n') || '') +
                   publicImports.paths.map(path => {
@@ -468,7 +468,7 @@ module.exports = {
                 );
               }
               if (options.outputs.includes('css')) {
-                const publicImports = getImports(name, '*.css');
+                const publicImports = await getImports(name, '*.css');
                 fs.writeFileSync(`${bundleDir}/${name}-build.css`,
                   publicImports.paths.map(path => {
                     return self.filterCss(fs.readFileSync(path, 'utf8'), {
@@ -548,9 +548,9 @@ module.exports = {
             );
           }
 
-          function getIcons() {
+          async function getIcons() {
             for (const name of modulesToInstantiate) {
-              const metadata = self.apos.synth.getMetadata(name);
+              const metadata = await self.apos.synth.getMetadata(name);
               // icons is an unparsed section, so getMetadata gives it back
               // to us as an object with a property for each class in the
               // inheritance tree, root first. Just keep merging in
@@ -690,11 +690,11 @@ module.exports = {
             return fs.copyFile(from, to);
           }
 
-          function getImports(folder, pattern, options = {}) {
+          async function getImports(folder, pattern, options = {}) {
             let components = [];
             const seen = {};
             for (const name of modulesToInstantiate) {
-              const metadata = self.apos.synth.getMetadata(name);
+              const metadata = await self.apos.synth.getMetadata(name);
               for (const entry of metadata.__meta.chain) {
                 if (options.ignoreModules?.[entry.name]) {
                   seen[entry.dirname] = true;

modules/@apostrophecms/asset/lib/webpack/utils.js

@@ -56,8 +56,7 @@ module.exports = {
   async getWebpackExtensions ({
     getMetadata, modulesToInstantiate, rebundleModulesConfig = {}
   }) {
-    const modulesMeta = modulesToInstantiate
-      .map((name) => getMetadata(name));
+    const modulesMeta = await Promise.all(modulesToInstantiate.map((name) => getMetadata(name)));
 
     const rebundleModules = formatRebundleConfig(rebundleModulesConfig);