@architect/inventory 3.4.0-RC.0 → 3.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@architect/inventory",
-  "version": "3.4.0-RC.0",
+  "version": "3.4.1",
   "description": "Architect project resource enumeration utility",
   "main": "src/index.js",
   "scripts": {
@@ -24,7 +24,6 @@
     "@architect/asap": "~5.1.1",
     "@architect/parser": "~6.0.2",
     "@architect/utils": "~3.1.2",
-    "esm": "~3.2.25",
     "lambda-runtimes": "~1.1.3"
   },
   "devDependencies": {
@@ -35,7 +34,6 @@
     "dotenv": "~16.0.3",
     "eslint": "~8.32.0",
     "mock-fs": "~5.2.0",
-    "mock-require": "~3.0.3",
     "nyc": "~15.1.0",
     "tap-spec": "^5.0.0",
     "tape": "^5.6.3"

package/src/config/pragmas/plugins.js

@@ -1,14 +1,13 @@
-let { join } = require('path')
+let { join, sep } = require('path')
 let { existsSync } = require('fs')
-let { is, normalizeSrc, pragmas, tidyError, validationPatterns } = require('../../lib')
+let { is, pragmas, tidyError, validationPatterns } = require('../../lib')
 let { lambdas } = pragmas
 let nonLambdaSetters = [ 'customLambdas', 'env', 'proxy', 'runtimes', 'shared', 'static', 'views', 'tables', 'tables-indexes' ]
 let setters = [ ...lambdas, ...nonLambdaSetters ]
 let pluginMethods = [ 'deploy', 'hydrate', 'sandbox' ]
 let reservedNames = [ '_methods' ]
-let requireEsm
 
-module.exports = function getPluginModules ({ arc, inventory, errors }) {
+module.exports = async function getPluginModules ({ arc, inventory, errors }) {
   if (!arc?.plugins?.length && !arc?.macros?.length) return null
   let plugins = {}
   let methods = {}
@@ -31,7 +30,7 @@ module.exports = function getPluginModules ({ arc, inventory, errors }) {
     else if (is.object(plugin)) {
       name = Object.keys(plugin)[0]
       pluginPath = plugin[name].src
-        ? normalizeSrc(cwd, plugin[name].src)
+        ? resolve('.' + sep + plugin[name].src, cwd)
         : join(cwd, 'src', type + 's', name)
     }
 
@@ -43,6 +42,7 @@ module.exports = function getPluginModules ({ arc, inventory, errors }) {
       errors.push('Plugin names can only contain [a-zA-Z0-9/\\-._]')
       continue
     }
+
     if (pluginPath) {
       try {
         /* istanbul ignore next: idk why but for some reason nyc isn't picking up the catches; all cases are covered in tests, though! */
@@ -52,22 +52,15 @@ module.exports = function getPluginModules ({ arc, inventory, errors }) {
             plugins[name] = require(pluginPath)
           }
           catch (err) {
-            // TODO: if we refactor all pragma visitors to async we can use Node's built in support for dynamic import within CJS
             if (hasEsmError(err)) {
-              try {
-                if (!requireEsm) {
-                  // eslint-disable-next-line
-                  requireEsm = require('esm')(module)
-                }
-                let plugin = requireEsm(pluginPath)
-                plugins[name] = plugin.default ? plugin.default : plugin
-              }
-              catch (err) {
-                errors.push(err)
-              }
+              let path =  process.platform.startsWith('win')
+                ? 'file://' + pluginPath
+                : pluginPath
+              let plugin = await import(path)
+              plugins[name] = plugin.default ? plugin.default : plugin
             }
             else {
-              errors.push(err)
+              throw err
             }
           }
         }
@@ -123,24 +116,23 @@ module.exports = function getPluginModules ({ arc, inventory, errors }) {
   return plugins
 }
 
-/* istanbul ignore next: per above, nyc isn't picking this up, but it is covered! */
 function getPath (cwd, srcDir, name) {
   let path1 = join(cwd, 'src', srcDir, `${name}.js`)
   let path2 = join(cwd, 'src', srcDir, `${name}.mjs`)
   let path3 = join(cwd, 'src', srcDir, name)
-  let path4 = join(cwd, 'node_modules', name)
-  let path5 = join(cwd, 'node_modules', `@${name}`)
   /**/ if (existsSync(path1)) return path1
   else if (existsSync(path2)) return path2
-  else if (existsSync(path3)) return path3
-  else if (existsSync(path4)) return path4
-  else if (existsSync(path5)) return path5
+  else if (existsSync(path3)) return resolve(path3, cwd)
+  return resolve(name, cwd)
+}
+
+function resolve (path, cwd) {
   try {
-    return require.resolve(name)
+    return require.resolve(path, { paths: [ cwd ] })
   }
   catch {
     try {
-      return require.resolve(`@${name}`)
+      return require.resolve(`@${path}`, { paths: [ cwd ] })
     }
     catch {
       return
@@ -154,5 +146,4 @@ let esmErrors = [
   'require() of ES Module',
   'Must use import to load ES Module',
 ]
-/* istanbul ignore next: per above, nyc isn't picking this up, but it is covered! */
 let hasEsmError = err => esmErrors.some(msg => err.message.includes(msg))

package/src/config/pragmas/tables-indexes.js

@@ -20,6 +20,8 @@ module.exports = function configureTablesIndexes ({ arc, inventory, errors }) {
     sortKey: null,
     sortKeyType: null,
     indexName: null,
+    projectionType: 'ALL',
+    projectionAttributes: null,
   })
 
   let indexes = []
@@ -38,6 +40,7 @@ module.exports = function configureTablesIndexes ({ arc, inventory, errors }) {
       let i = indexTemplate()
       i.name = Object.keys(index)[0]
       Object.entries(index[i.name]).forEach(([ key, value ]) => {
+        let setting = key?.toLowerCase()
         if (is.sortKey(value)) {
           i.sortKey = key
           i.sortKeyType = value.replace('**', '').toLowerCase()
@@ -48,9 +51,27 @@ module.exports = function configureTablesIndexes ({ arc, inventory, errors }) {
           i.partitionKeyType = value.replace('*', '').toLowerCase()
           if (!i.partitionKeyType) i.partitionKeyType = 'string'
         }
-        else if (key?.toLowerCase() === 'name') {
+        else if (setting === 'name') {
           i.indexName = value
         }
+        else if (setting === 'projection') {
+          let val = (is.string(value) && value.toLowerCase()) || value
+          if (val === 'all') {
+            i.projectionType = 'ALL'
+          }
+          else if (val === 'keys') {
+            i.projectionType = 'KEYS_ONLY'
+          }
+          else {
+            i.projectionType = 'INCLUDE'
+            if (Array.isArray(value)) {
+              i.projectionAttributes = value
+            }
+            else {
+              i.projectionAttributes = [ value ]
+            }
+          }
+        }
       })
       return i
     }

package/src/index.js

@@ -1,3 +1,4 @@
+let { callbackify } = require('util')
 let parse = require('@architect/parser')
 let read = require('./read')
 let inventoryDefaults = require('./defaults')
@@ -6,6 +7,7 @@ let getEnv = require('./env')
 let validate = require('./validate')
 let get = require('./get')
 let { errorFmt } = require('./lib')
+let plugins = callbackify(config.pragmas.plugins)
 
 /**
  * Architect Inventory
@@ -64,46 +66,53 @@ module.exports = function architectInventory (params = {}, callback) {
   inventory._arc = config._arc(project)
 
   // @plugins come first, as they register hooks all around the project
-  inventory.plugins = config.pragmas.plugins(project)
+  plugins(project, (err, result) => {
+    /* istanbul ignore next: yeah we know what happens here */
+    if (err) callback(err)
+    else {
+      inventory.plugins = result
 
-  // Establish default function config from project + Arc defaults
-  inventory._project = config._project(project)
+      // Establish default function config from project + Arc defaults
+      inventory._project = config._project(project)
 
-  // End here if plugins failed
-  if (errors.length) {
-    callback(errorFmt({ type: 'plugin', errors }))
-    return promise
-  }
+      // End here if plugins failed
+      if (errors.length) {
+        callback(errorFmt({ type: 'plugin', errors }))
+        return promise
+      }
 
-  // Userland: fill out the pragmas, starting with @plugins
-  inventory = {
-    ...inventory,
-    ...config.pragmas(project)
-  }
+      // Userland: fill out the pragmas, starting with @plugins
+      inventory = {
+        ...inventory,
+        ...config.pragmas(project)
+      }
 
-  // End here if first-pass validation failed
-  if (errors.length) {
-    callback(errorFmt({ type: 'validation', errors }))
-    return promise
-  }
+      // End here if first-pass validation failed
+      if (errors.length) {
+        callback(errorFmt({ type: 'validation', errors }))
+        return promise
+      }
 
-  // Final validation pass
-  let err = validate(params, inventory)
-  if (err) {
-    callback(err)
-    return promise
-  }
+      // Final validation pass
+      let err = validate(params, inventory)
+      if (err) {
+        callback(err)
+        return promise
+      }
 
-  // Maybe get env vars
-  getEnv(params, inventory, function done (err) {
-    /* istanbul ignore next: yeah we know what happens here */
-    if (err) callback(err)
-    else {
-      callback(null, {
-        inv: inventory,
-        get: get(inventory)
+      // Maybe get env vars
+      getEnv(params, inventory, function done (err) {
+        /* istanbul ignore next: yeah we know what happens here */
+        if (err) callback(err)
+        else {
+          callback(null, {
+            inv: inventory,
+            get: get(inventory)
+          })
+        }
       })
     }
   })
+
   return promise
 }