edge-functions 1.1.0 → 1.3.0

package/lib/presets/custom/vue/deliver/prebuild.js

@@ -1,7 +1,7 @@
-import { exec, feedback, getPackageManager } from '#utils';
 import {
-  copyFile, mkdir, readdir, lstat, readFile,
-} from 'fs/promises';
+  exec, getPackageManager, copyDirectory,
+} from '#utils';
+import { lstat, readFile, rm } from 'fs/promises';
 import { join } from 'path';
 
 const packageManager = await getPackageManager();
@@ -34,71 +34,42 @@ async function readViteConfig() {
   }
 }
 
-/**
- * Copy files and directories from one directory to another.
- * @param {string} srcDir - Source directory.
- * @param {string} destDir - Destination directory.
- */
-async function copyFiles(srcDir, destDir) {
-  const files = await readdir(srcDir);
-
-  await Promise.all(files.map(async (file) => {
-    const srcPath = join(srcDir, file);
-    const destPath = join(destDir, file);
-    const stats = await lstat(srcPath);
-
-    if (stats.isFile()) {
-      await copyFile(srcPath, destPath);
-    } else if (stats.isDirectory()) {
-      await mkdir(destPath, { recursive: true });
-      await copyFiles(srcPath, destPath);
-    }
-  }));
-}
-
 /**
  * Runs custom prebuild actions.
  */
 async function prebuild() {
-  try {
-    let outDir = defaultViteOutDir;
-    let destPath = edgeStorageDir;
-
-    const isViteProject = await viteConfigExists();
-    if (isViteProject) {
-      const config = await readViteConfig();
+  const npmArgsForward = packageManager === 'npm' ? '--' : '';
 
-      if (config?.build?.outDir) {
-        outDir = config.build.outDir;
-      }
+  let outDir = defaultViteOutDir;
+  let destPath = edgeStorageDir;
 
-      const srcPath = join('.', outDir);
-      destPath = join(edgeStorageDir);
+  const isViteProject = await viteConfigExists();
 
-      await mkdir(destPath, { recursive: true });
-      await copyFiles(srcPath, destPath);
-    }
+  if (isViteProject) {
+    await exec(
+      `${packageManager} run build ${npmArgsForward}`,
+      'Vue/Vite',
+      true,
+    );
 
-    const npmArgsForward = packageManager === 'npm' ? '--' : '';
+    const config = await readViteConfig();
 
-    // support npm, yarn, pnpm
-    if (isViteProject) {
-      await exec(
-        `${packageManager} run build ${npmArgsForward}`,
-        'Vue/Vite',
-        true,
-      );
+    if (config?.build?.outDir) {
+      outDir = config.build.outDir;
     }
 
-    if (!isViteProject) {
-      await exec(
-        `${packageManager} run build ${npmArgsForward} --dest ${destPath}`,
-        'Vue',
-        true,
-      );
-    }
-  } catch (error) {
-    feedback.prebuild.error(error);
+    const srcPath = join('.', outDir);
+    destPath = join(edgeStorageDir);
+    copyDirectory(outDir, srcPath);
+    rm(outDir, { recursive: true, force: true });
+  }
+
+  if (!isViteProject) {
+    await exec(
+      `${packageManager} run build ${npmArgsForward} --dest ${destPath}`,
+      'Vue',
+      true,
+    );
   }
 }
 

package/lib/utils/exec/exec.utils.js

@@ -9,51 +9,61 @@ import signale from 'signale';
  * @param {string} command - The command to be executed.
  * @param {string} [scope='Process'] - Log scope. The default is 'Process'.
  * @param {boolean} [verbose=false] - Whether to display the output in real-time.
+ * @param {boolean} [interactive=false] - Whether to allow user
+ * interaction with the running process.
  * @returns {Promise<void>} A promise that resolves when the command completes successfully.
+ * @throws Will throw an error if the command exits with a non-zero status code.
  * @example
  * // Executing a command without verbose output
  * await exec('npm install');
  *
  * // Executing a command with verbose output
  * await exec('npm run build', 'Build', true);
+ *
+ * // Executing an interactive command
+ * await exec('npx vue create my-project', 'Vue', false, true);
  */
-async function exec(command, scope = 'Process', verbose = false) {
+async function exec(command, scope = 'Process', verbose = false, interactive = false) {
   const stream = new signale.Signale({ interactive: true, scope: ['Process', scope] });
 
   return new Promise((resolve, reject) => {
     const args = command.split(' ');
     const cmd = args.shift();
 
-    const buildProcess = spawn(cmd, args, { shell: true });
+    const execProcess = spawn(cmd, args, {
+      shell: true,
+      stdio: interactive ? 'inherit' : 'pipe',
+    });
+
+    if (!interactive) {
+      if (verbose) {
+        execProcess.stdout.on('data', (data) => {
+          stream.info(data.toString());
+        });
 
-    if (verbose) {
-      buildProcess.stdout.on('data', (data) => {
-        stream.info(data.toString());
+        execProcess.stderr.on('data', (data) => {
+          const dataStr = data.toString();
+          if (dataStr.toLowerCase().includes('error')) {
+            stream.error(dataStr);
+          } else {
+            stream.info(dataStr);
+          }
+        });
+      }
+
+      execProcess.on('error', (error) => {
+        reject(error);
       });
 
-      buildProcess.stderr.on('data', (data) => {
-        // Some tools and libraries choose to use
-        // stderr for process logging or informational messages.
-        const dataStr = data.toString();
-        if (dataStr.toLowerCase().includes('error')) {
-          stream.error(dataStr);
+      execProcess.on('close', (code) => {
+        if (code === 0) {
+          resolve();
         } else {
-          stream.info(dataStr);
+          reject(new Error(`Command '${command}' failed with code ${code}`));
         }
       });
     }
-
-    buildProcess.on('error', (error) => {
-      reject(error);
-    });
-
-    buildProcess.on('close', (code) => {
-      if (code === 0) {
-        resolve();
-      } else {
-        reject(new Error(`Command '${command}' failed with code ${code}`));
-      }
-    });
   });
 }
+
 export default exec;

package/lib/utils/getAbsoluteLibDirPath/getAbsoluteLibDirPath.utils.js

@@ -1,3 +1,4 @@
+const isWindows = process.platform === 'win32';
 /**
  * Get the absolute path of the lib directory based on the current module.
  * @function
@@ -10,9 +11,6 @@
  * const libDirPath = getAbsoluteLibDirPath();
  * console.log(libDirPath); // 'lib/full/path/to/directory'
  */
-
-const isWindows = process.platform === 'win32';
-
 function getAbsoluteLibDirPath() {
   const currentModuleFullPath = import.meta.url;
   let baselibPath = currentModuleFullPath.match(/(.*lib)(.*)/)[1];

package/lib/utils/getVulcanBuildId/getVulcanBuildId.utils.js

@@ -2,7 +2,7 @@ import { readFileSync, existsSync } from 'fs';
 import { join } from 'path';
 
 /**
- * @namespace Utils
+ * @memberof utils
  * @function
  * @name getVulcanBuildId
  * @description Fetches the unique build ID for the current project from the

package/lib/utils/index.js

@@ -6,7 +6,7 @@ import generateTimestamp from './generateTimestamp/index.js';
 import getAbsoluteLibDirPath from './getAbsoluteLibDirPath/index.js';
 import getVulcanBuildId from './getVulcanBuildId/index.js';
 import getPackageManager from './getPackageManager/index.js';
-import getPresetsList from './getPresetsList/index.js';
+import presets from './presets/index.js';
 import readWorkerFile from './readWorkerFile/index.js';
 import overrideStaticOutputPath from './overrideStaticOutputPath/index.js';
 import getProjectJsonFile from './getProjectJsonFile/index.js';
@@ -24,7 +24,7 @@ export {
   getPackageVersion,
   getProjectJsonFile,
   getVulcanBuildId,
-  getPresetsList,
+  presets,
   overrideStaticOutputPath,
   readWorkerFile,
   Spinner,

package/lib/utils/presets/index.js

@@ -0,0 +1,3 @@
+import presets from './presets.utils.js';
+
+export default presets;

package/lib/utils/presets/presets.utils.js

@@ -0,0 +1,169 @@
+import fs from 'fs';
+import path from 'path';
+
+const isWindows = process.platform === 'win32';
+const currentModuleFullPath = import.meta.url;
+let baselibPath = currentModuleFullPath.match(/(.*lib)(.*)/)[1];
+
+if (isWindows) {
+  baselibPath = new URL(baselibPath).pathname;
+  if (baselibPath.startsWith('/')) {
+    baselibPath = baselibPath.slice(1);
+  }
+}
+if (!isWindows) {
+  baselibPath = baselibPath.replace('file://', '');
+}
+
+/**
+ * Retrieves a list of presets from 'default' and 'custom' directories in a beautified format.
+ * Unlike `getKeys`, this method returns preset names formatted
+ * for display and includes modes like '(Static)' or '(Server)'.
+ * @function
+ * @memberof presets
+ * @name getBeautify
+ * @param {string[]} [types=['default', 'custom']] - The types of presets to list.
+ * Each type corresponds to a folder in the 'presets' directory.
+ * @returns {string[]} The list of presets with modes like '(Static)' or '(Server)' if applicable.
+ * @example
+ * const presetsList = getBeautify(['default', 'custom']);
+ * console.log(presetsList);
+ * // Output might be: ['Angular (Static)', 'React (Server)', 'Vue (Static)']
+ */
+function getBeautify(types = ['default', 'custom']) {
+  const presets = [];
+
+  types.forEach((type) => {
+    const presetsDir = path.join(baselibPath, `presets/${type}`);
+    const folders = fs
+      .readdirSync(presetsDir, { withFileTypes: true })
+
+      .filter((dirent) => dirent.isDirectory())
+      .flatMap((dirent) => {
+        const presetName = dirent.name;
+        const subDirs = fs
+          .readdirSync(path.join(presetsDir, presetName), {
+            withFileTypes: true,
+          })
+          .filter((subDirent) => subDirent.isDirectory());
+
+        if (subDirs.length === 0) {
+          return [presetName.charAt(0).toUpperCase() + presetName.slice(1)];
+        }
+
+        return subDirs.map((subDir) => {
+          const subDirName = subDir.name.charAt(0).toUpperCase() + subDir.name.slice(1);
+          return `${
+            presetName.charAt(0).toUpperCase() + presetName.slice(1)
+          } (${subDirName})`;
+        });
+      });
+
+    presets.push(...folders);
+  });
+
+  return presets;
+}
+
+/**
+ * Retrieves an array of valid preset keys by scanning through
+ * the preset directories 'default' and 'custom'.
+ * Each folder name in these directories is considered as a valid preset key.
+ * Unlike `getBeautify`, this method returns raw preset names without any formatting or modes.
+ * @function
+ * @memberof presets
+ * @name getKeys
+ * @returns {string[]} An array of valid build presets.
+ * @example
+ * const validPresetsKeys = getKeys();
+ * console.log(validKeys);
+ * // Output might be: ['angular', 'react', 'vue']
+ * @throws {Error} Throws an error if unable to read the directory.
+ */
+function getKeys() {
+  const types = ['default', 'custom'];
+  const validPresets = [];
+
+  types.forEach((type) => {
+    const presetsPath = path.join(baselibPath, 'presets', type);
+    const directories = fs
+      .readdirSync(presetsPath, { withFileTypes: true })
+      .filter((dirent) => dirent.isDirectory())
+      .map((dirent) => dirent.name);
+
+    validPresets.push(...directories);
+  });
+
+  return validPresets;
+}
+
+/**
+ * Creates a new preset in the lib/presets/custom/${mode} directory.
+ * Also generates three required files: handler.js, prebuild.js, and config.js.
+ * @function
+ * @memberof utils
+ * @name set
+ * @param {string} name - The name of the new preset.
+ * @param {'compute'|'deliver'} mode - The mode for the preset, either 'compute' or 'deliver'.
+ * @throws {Error} Throws an error if a preset with the same name
+ * already exists or if mode is invalid.
+ * @example
+ *
+ * // Create a new preset named 'MyPreset' in 'compute' mode
+ * presets.set('MyPreset', 'compute');
+ */
+function set(name, mode) {
+  const presetPath = path.join(baselibPath, 'presets', 'custom', name, mode);
+  fs.mkdirSync(presetPath, { recursive: true });
+
+  if (mode === 'compute') {
+    const defaultFilesPath = path.join(
+      baselibPath,
+      'presets',
+      'default',
+      'javascript',
+      'compute',
+    );
+    const filesToCopy = ['handler.js', 'config.js', 'prebuild.js'];
+
+    filesToCopy.forEach((file) => {
+      const srcPath = path.join(defaultFilesPath, file);
+      const destPath = path.join(presetPath, file);
+      fs.copyFileSync(srcPath, destPath);
+    });
+  }
+  if (mode === 'deliver') {
+    // TODO: Create template for 'deliver' mode init
+    fs.writeFileSync(path.join(presetPath, 'handler.js'), '');
+    fs.writeFileSync(path.join(presetPath, 'prebuild.js'), '');
+    fs.writeFileSync(path.join(presetPath, 'config.js'), '');
+  }
+}
+
+/**
+ * Presets object containing utility functions for working with build presets.
+ * @memberof utils
+ * @property {Function} getKeys - Function to retrieve an array of valid preset keys.
+ * These keys are raw and do not include any modes or formatting.
+ * @property {Function} getBeautify - Function to retrieve a list of presets in a beautified format.
+ * Unlike `getKeys`, the names are formatted and include modes like '(Static)' or '(Server)'.
+ * @property {Function} set - Function to create a new preset along with its required files.
+ * @example
+ * import { presets } from '#utils';
+ *
+ * // Get raw preset keys
+ * const rawKeys = presets.getKeys();
+ *
+ * // Get beautified preset names
+ * const beautifiedNames = presets.getBeautify();
+ *
+ * // Create a new preset
+ * presets.set('MyNewPreset', 'compute');
+ */
+const presets = {
+  getKeys,
+  getBeautify,
+  set,
+};
+
+export default presets;

package/lib/utils/spinner/index.js

@@ -1,3 +1,3 @@
-import spinner from './spinner.utils.js';
+import Spinner from './spinner.utils.js';
 
-export default spinner;
+export default Spinner;

package/lib/utils/spinner/spinner.utils.js

@@ -9,7 +9,7 @@ class Spinner {
   }
 
   start() {
-    signale.pending(`Starting ${this.action} ...`);
+    signale.pending(`Starting ${this.action}...`);
 
     this.intervalId = setInterval(() => {
       const frame = this.frames[this.currentFrameIndex];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "edge-functions",
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Tool to launch and build JavaScript/Frameworks. This tool automates polyfills for Edge Computing and assists in creating Workers, notably for the Azion platform.",
   "main": "lib/main.js",
   "bin": {
@@ -34,6 +34,7 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "@angular/cli": "^16.2.0",
     "@edge-runtime/node-utils": "^2.1.1",
     "@edge-runtime/primitives": "^3.0.4",
     "@semantic-release/changelog": "^6.0.3",
@@ -41,15 +42,21 @@
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^10.0.4",
     "@semantic-release/release-notes-generator": "^11.0.4",
+    "@vue/cli": "^5.0.8",
     "bottleneck": "^2.19.5",
     "chokidar": "^3.5.3",
     "commander": "^10.0.1",
     "conventional-changelog-conventionalcommits": "^6.1.0",
+    "create-astro": "^3.2.2",
+    "create-next-app": "^13.4.19",
+    "create-react-app": "^5.0.1",
+    "create-vue": "^3.7.3",
     "deepmerge": "^4.3.1",
     "edge-runtime": "^2.4.5",
     "esbuild": "^0.18.11",
     "escape-string-regexp": "^5.0.0",
     "form-data": "^4.0.0",
+    "hexo": "^7.0.0-rc2",
     "inquirer": "^9.2.7",
     "install": "^0.13.0",
     "lodash": "^4.17.21",
@@ -85,7 +92,7 @@
     "#root/*": "./",
     "#lib/*": "./lib",
     "#utils": "./lib/utils/index.js",
-    "#polyfills": "./lib/polyfills/index.js",
+    "#polyfills": "./lib/env/polyfills/index.js",
     "#build": "./lib/build/dispatcher/index.js",
     "#bundlers": "./lib/build/bundlers/index.js",
     "#notations/*": "./lib/notations",
@@ -102,4 +109,4 @@
     "url": "https://github.com/aziontech/vulcan/issues"
   },
   "homepage": "https://github.com/aziontech/vulcan#readme"
-}
+}

package/lib/utils/getPresetsList/getPresetsList.utils.js

@@ -1,68 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-
-/**
- * Get the list of presets.
- * @function
- * @name getPresetsList
- * @memberof utils
- * @param {string[]} [types=['default', 'custom']] - The types of presets to list.
- * Each type corresponds to a folder in the 'presets' directory.
- * @returns {string[]} The list of presets with '(Static)' or '(Server)' suffixes when applicable.
- * @example
- * const presetsList = getPresetsList(['default', 'custom']);
- * console.log(presetsList);
- * // Output: ['Next (Static)', 'Next (Server)', 'Frodo (Nine Fingers)']
- */
-
-const isWindows = process.platform === 'win32';
-
-function getPresetsList(types = ['default', 'custom']) {
-  const currentModuleFullPath = import.meta.url;
-  let baselibPath = currentModuleFullPath.match(/(.*lib)(.*)/)[1];
-  if (isWindows) {
-    baselibPath = new URL(baselibPath).pathname;
-    if (baselibPath.startsWith('/')) {
-      baselibPath = baselibPath.slice(1);
-    }
-  }
-  if (!isWindows) {
-    baselibPath = baselibPath.replace('file://', '');
-  }
-
-  const presets = [];
-
-  types.forEach((type) => {
-    const presetsDir = path.join(baselibPath, `presets/${type}`);
-    const folders = fs
-      .readdirSync(presetsDir, { withFileTypes: true })
-
-      .filter((dirent) => dirent.isDirectory())
-      .flatMap((dirent) => {
-        const presetName = dirent.name;
-        const subDirs = fs
-          .readdirSync(path.join(presetsDir, presetName), {
-            withFileTypes: true,
-          })
-          .filter((subDirent) => subDirent.isDirectory());
-
-        if (subDirs.length === 0) {
-          return [presetName.charAt(0).toUpperCase() + presetName.slice(1)];
-        }
-
-        return subDirs.map((subDir) => {
-          const subDirName =
-            subDir.name.charAt(0).toUpperCase() + subDir.name.slice(1);
-          return `${
-            presetName.charAt(0).toUpperCase() + presetName.slice(1)
-          } (${subDirName})`;
-        });
-      });
-
-    presets.push(...folders);
-  });
-
-  return presets;
-}
-
-export default getPresetsList;

package/lib/utils/getPresetsList/index.js

@@ -1,3 +0,0 @@
-import getPresetsList from './getPresetsList.utils.js';
-
-export default getPresetsList;