edge-functions 1.1.0 → 1.4.0

package/.eslintrc.json

@@ -36,7 +36,7 @@
           ],
           [
             "#polyfills",
-            "./lib/polyfills/index.js"
+            "./lib/env/polyfills/index.js"
           ],
           [
             "#build",

package/README.md

@@ -1,5 +1,7 @@
 
 # Vulcan - Forging The Edge
+![vulcan](https://github.com/aziontech/vulcan/assets/12740219/a5043e6f-11cb-4498-a300-5bdb617a9989)
+
 
 Vulcan is a powerful tool designed to streamline the development and deployment of JavaScript applications and frameworks. This powerful utility automates polyfills for Edge Computing, significantly simplifying the process of creating Workers, particularly for the Azion platform.
 
@@ -45,6 +47,40 @@ Follow these steps to start using Vulcan:
 
 5. Start developing: Once the project is set up, you can start developing your JavaScript applications or frameworks using the power of Vulcan. Leverage the automated polyfills, Worker creation assistance, and other features provided by Vulcan to enhance your development workflow.
 
+## Using Vulcan
+
+See some examples below:
+
+* Build a JavaScript/Node project (back-end)
+
+   ```shell
+   vulcan build
+   ```
+   
+* Build a TypeScript/Node (back-end)
+
+   ```shell
+   vulcan build --preset typescript
+   ```
+   
+* Build a Static Next.js project
+
+   ```shell
+   vulcan build --preset next --mode deliver
+   ```
+   
+ * Build a Static Astro.js project
+
+   ```shell
+   vulcan build --preset astro --mode deliver
+   ```
+   
+* Test your project locally (after build)
+
+   ```shell
+   vulcan dev
+   ```
+
 
 ## Docs
 * [Overview](docs/overview.md)

package/aliases.js

@@ -2,7 +2,7 @@ export default [
   ['#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'],

package/docs/overview.md

@@ -31,6 +31,7 @@ Polyfills can be used to generate the worker(s) file(s).
 Some configs can be passed to the builder but if user tries to override `azion worker configs` this passed configs will be ignored.
 
 ### Artifacts
-Files generated to run in azion structure:
-* js worker(s);
-* Storage assets files;
+The **'.edge'** folder will be generated representing the edge locally. Files generated to run on the infrastructure:
+* JS worker(s) => '.edge/workers.js';
+* Assets => '.edge/storage/*';
+* Environment variables => '.edge/.env'.

package/docs/presets.md

@@ -9,8 +9,9 @@ Vulcan is an extensible platform that allows you to easily create new presets fo
 To add a new preset, you need to create appropriate folders in two directories: `presets/default` or `presets/custom`. The folder representing your framework or library will automatically be included in the preset listings. Each preset has two modes, represented by folders of the same name: `compute` and `deliver`.
 
 
+https://github.com/aziontech/vulcan/assets/12740219/84c7d7a1-4167-4e7e-993f-41a6eb653758
+
 
-https://github.com/aziontech/vulcan/assets/12740219/06edb9a0-26cd-4055-bd2e-d400b6a06f3c
 
 
 
@@ -54,7 +55,18 @@ Each preset is made up of three primary files: `config.js`, `prebuild.js`, and `
 
 Here's a step-by-step guide on how to add a new preset in Vulcan:
 
-1.  ## **Create a folder inside `./lib/presets/custom`:**
+## **Use the command to automatic creation:**
+
+    vulcan presets create
+
+https://github.com/aziontech/vulcan/assets/12740219/9ca7371e-713a-4b29-a99b-c1a18d28bc67
+
+
+
+### Or do it manually:
+
+
+## 1. **Create a folder inside `./lib/presets/custom`:**
    https://github.com/aziontech/vulcan/assets/12740219/abb1b2cc-5f74-473d-b731-c0b7157cb95e
 
   -   The name of this folder should represent the name of your framework or library.
@@ -65,7 +77,7 @@ Here's a step-by-step guide on how to add a new preset in Vulcan:
 
 -   **Deliver**: This mode should be used when you intend to use the worker only for routing requests and delivering static files that will be computed on the client side.
         
-3.  ## **Create the following files in your preset's folder:**
+2.  ## **Create the following files in your preset's folder:**
     
     ##  handler.js
     This file contains the code that is executed within the worker in the edge function. Essentially, it is the code that runs directly on the edge. In the context of the `deliver` mode, this may simply act as a router. However, in cases where computation is needed, it can be designed to perform more complex tasks. Remember, the capabilities of your handler.js are dependent on your use case and the mode of operation you've chosen for your preset.
@@ -112,4 +124,4 @@ For `deliver` mode:
 
     vulcan build --preset <name> --mode deliver
 
-Replace `<name>` with the name of your preset. This will initiate Vulcan's build process for your preset, allowing you to verify its functionality.
+Replace `<name>` with the name of your preset. This will initiate Vulcan's build process for your preset, allowing you to verify its functionality.