fix(core): require modules and files.. fixes #1258 fixes #1252

modules/builtin/src/actions/README.js

@@ -0,0 +1,66 @@
+/**
+ * This is just an example of how tu create custom actions.
+ * If you're reading this from the Flow Editor and wonder how you can create an new action,
+ * See the `{botpressDir}/data/global/actions/README.js` file.
+ *
+ * @title Custom Action Example
+ * @category tutorial
+ * @param {string} [pageToFetch=https://google.com] - The page to fetch
+ */
+
+/** @ignore
+ * @var temp
+ * @var user
+ *
+ * ----------------------------
+ * ---- Creating an Action ----
+ * ----------------------------
+ *
+ * -- STORAGE --
+ * In the global scope you have access to the following storage objects:
+ * @var temp     Temporary flow-level storage.  Unique to every flow execution.  Ideal for logic implementation such as data returned from APIs.
+ * @var user     Permanent user-level storage.  Unique to every users.  Ideal for remembering things specific to a user such as email, name, customerId, etc.
+ * @var session  Temporary session-level storage.  Unique to every dialog sessions, which is time-bound (defaults to 15 minutes).  Ideal for remembering things specific to a conversation.
+ *
+ * -- CONTEXT --
+ * In the global scope you have access to the @var event variable.
+ *
+ * -- PARAMETERS --
+ * In the global scope you have access to the @var args object.
+ * The @var args object is a key-value-pair of parameters defined when calling the action from the Flow Editor.
+ *
+ * -- ASYNC --
+ * Actions can run asynchronously by returning a Promise.  If you want to use the `await` keyword, you need to declare an async function
+ * and return a call to that function. @file `./builtin/getGlobalVariable.js` for a concrete example.
+ *
+ * -- REQUIRE MODULES --
+ * You can require external modules by using `require('module-name')`.  A `node_modules` directory needs to be present next to the action
+ * and the dependency needs to be present in this directory.  You can use npm/yarn inside the actions directory to manage dependencies.
+ * Some modules are available by default such as axios and lodash
+ *
+ * -- REQUIRE FILES --
+ * You can require adjacent .js and .json files, simply use `require('./path_to_file.js')`.  If the adjacent file is a .js file and is not intended to be an action in itself,
+ * consider prefixing the file with a dot (.) so Botpress ignores it when looking for actions.
+ *
+ * -- METADATA --
+ * You can change how the action will be presented in the Flow Editor by using JSDoc comments.  See example at the top of the file.
+ */
+
+const util = require('util')
+const axios = require('axios')
+
+console.log('Arguments =', util.inspect(args, false, 2, true))
+
+if ('pageSource' in temp) {
+  // Mutate the `temp` object
+  delete temp.pageSource
+}
+
+async function makeHttpRequest() {
+  // args.pageToFetch is an optional parameter that can be overwritten by the user in the Flow Editor
+  const { data } = await axios.get(args.pageToFetch || 'https://google.com')
+  temp.pageSource = data
+}
+
+// Making an async HTTP request
+return makeHttpRequest()

src/bp/core/modules/require.ts

@@ -41,7 +41,7 @@ export const requireAtPaths = (module: string, locations: string[]) => {
 
   for (const loc of lookups) {
     try {
-      if (loc.endsWith('.js')) {
+      if (['.js', '.json'].includes(path.extname(loc))) {
         if (!fs.existsSync(loc)) {
           continue
         }
@@ -62,5 +62,9 @@ export const requireAtPaths = (module: string, locations: string[]) => {
     } catch (err) {}
   }
 
-  throw new Error(`Module "${module}" not found. Tried these locations: "${locations.join(', ')}"`)
+  try {
+    return require(module)
+  } catch (err) {
+    throw new Error(`Module "${module}" not found. Tried these locations: "${locations.join(', ')}"`)
+  }
 }