edge-functions 2.2.0-stage.4 → 2.2.0

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## [2.2.0](https://github.com/aziontech/vulcan/compare/v2.1.0...v2.2.0) (2023-12-14)
+
+
+### Features
+
+* add routes priority validation in manifest ([662338c](https://github.com/aziontech/vulcan/commit/662338c2f567b6fbd3ae9aa7434170b2dbe86ce8))
+* esbuild bundler improvements and changes ([5e668c4](https://github.com/aziontech/vulcan/commit/5e668c4c8c725de37102b776708a5641980842f4))
+* generate manifest for presets (deliver or compute) ([83ab369](https://github.com/aziontech/vulcan/commit/83ab36941e1f0d38a932f97ef0b6507abc813090))
+* generateManifest for next.js (compute) ([ea97252](https://github.com/aziontech/vulcan/commit/ea97252caf2ee3ceff51635c5136aa3df02cbb0e))
+* generateManifest for next.js (compute) ([38f69a5](https://github.com/aziontech/vulcan/commit/38f69a58b746d8e11b838fda82c661ad12f04253))
+* improvements bundlers ([d546697](https://github.com/aziontech/vulcan/commit/d546697154b61124b947fff347b494dc474b7c36))
+* initial code for organizing polyfill plugins ([2212272](https://github.com/aziontech/vulcan/commit/22122729bbdf0155357142c7fcbebd612d0509e3))
+* preset for emscripten ([8ada412](https://github.com/aziontech/vulcan/commit/8ada4128b2637bcb694c5bc120dc8bc92757b701))
+
+
+### Bug Fixes
+
+* app routes filter in next static build ([bb9cbd3](https://github.com/aziontech/vulcan/commit/bb9cbd3f0789ad6b0ba0fccb549223f4e5647a7b))
+* esbuild plugin initial options ([8c84baa](https://github.com/aziontech/vulcan/commit/8c84baa117ed84a67202284d34abb05857083ec2))
+* generate manifest in wasm presets ([38e996f](https://github.com/aziontech/vulcan/commit/38e996fa07cb9769482e318741671acf4500c5bf))
+* handle error when not using app dir format in next static build ([edae5c1](https://github.com/aziontech/vulcan/commit/edae5c1a13f25efaf61922d602ccfc8b71531b50))
+* loop in fs polyfill when readdirSync and path / ([4c1e2d0](https://github.com/aziontech/vulcan/commit/4c1e2d0195eaf04bf86ce4995ac41c9e2de5c596))
+* loop in fs polyfill when readdirSync and path / ([#197](https://github.com/aziontech/vulcan/issues/197)) ([bd56c75](https://github.com/aziontech/vulcan/commit/bd56c75d8e48dd8af7792710aa51f68d7f737521))
+* prevent reference sharing in config ([98b8caa](https://github.com/aziontech/vulcan/commit/98b8caa526e554401aeec2afed2dd126b29994f0))
+* set correct prebuild to app dir cases in next static ([d43c2d5](https://github.com/aziontech/vulcan/commit/d43c2d561fee9d6b68818fd6cbf66ceb685ab2bc))
+
 ## [2.2.0-stage.4](https://github.com/aziontech/vulcan/compare/v2.2.0-stage.3...v2.2.0-stage.4) (2023-12-13)
 
 

package/README.md

@@ -149,7 +149,7 @@ Allows you to extend the capabilities of the chosen bundler (either `webpack` or
 
 ### Example Configuration
 
-For a Vue-based project:
+For a Next/Faststore-based project:
 
 ```javascript
 module.exports = {
@@ -158,7 +158,7 @@ module.exports = {
   useNodePolyfills: true,
   useOwnWorker: false,
   preset: {
-    name: 'vue',
+    name: 'next',
     mode: 'compute',
   },
   memoryFS: {
@@ -173,17 +173,19 @@ module.exports = {
 
 **Note:** Adapting `vulcan.config.js` to your setup allows a personalized development experience, catering to the specific needs of your JavaScript applications and frameworks.
 
-## Wasm Notes
-
-To use wasm presets you need to install the necessary tools to build your code:
-
-- emscripten: [download](https://emscripten.org/docs/getting_started/downloads.html);
-- rustwasm: [wasm-bindgen-cli](https://crates.io/crates/wasm-bindgen-cli)
-
 ## Docs
 
 - [Overview](docs/overview.md)
 - [Presets](docs/presets.md)
+- [Rust/Wasm example](examples/rust-wasm-yew-ssr/)
+- [Emscripten/Wasm example](examples/emscripten-wasm/)
+
+## Wasm Notes
+
+To use wasm presets you need to install the necessary tools to build your code:
+
+- Emscripten: [emsdk](https://emscripten.org/docs/getting_started/downloads.html);
+- Rust/Wasm: [wasm-bindgen-cli](https://crates.io/crates/wasm-bindgen-cli)
 
 ## Contributing
 

package/docs/presets.md

@@ -59,37 +59,47 @@ https://github.com/aziontech/vulcan/assets/12740219/abb1b2cc-5f74-473d-b731-c0b7
 
 - **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.
 
-2.  ## **Create the following files in your preset's folder:**
+## 2. **Create the following files in your preset's folder:**
 
-    ## handler.js
+## 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.
+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.
 
-    #### For the cases involving static (deliver) frameworks, here's what you can do:
+#### For the cases involving static (deliver) frameworks, here's what you can do:
 
-    - For Single Page Application (SPA) types:
-      Consider copying the preset handler similar to Vue. This utilizes the `mountSPA` hook which sets up the routing for your SPA effectively.
-    - For Static Site Generator (SSG) projects:
-      If you have a project that generates multiple HTML files, take a look at how the Next.js project handles this. They use the `mountSSG` hook, which sets up static routing for all the generated HTML pages.
+- For Single Page Application (SPA) types:
+  Consider copying the preset handler similar to Vue. This utilizes the `mountSPA` hook which sets up the routing for your SPA effectively.
+- For Static Site Generator (SSG) projects:
+  If you have a project that generates multiple HTML files, take a look at how the Next.js project handles this. They use the `mountSSG` hook, which sets up static routing for all the generated HTML pages.
 
-    **Note**: Remember, these are just examples and can serve as a starting point for your own custom preset. Adjust and extend them as necessary to fit your project's specific needs.
+  **Note**: Remember, these are just examples and can serve as a starting point for your own custom preset. Adjust and extend them as necessary to fit your project's specific needs.
 
-    ## config.js
+## config.js
 
-    This file serves as an extension to the edge build. It enables the inclusion of polyfills, plugins, or any other procedures that relate to the build process executed on the edge. Although it is editable, we strongly advise against making changes to this file unless absolutely necessary. It's designed to ensure optimal operation, and modifications should be undertaken with careful consideration.
+This file serves as an extension to the edge build. It enables the inclusion of polyfills, plugins, or any other procedures that relate to the build process executed on the edge. Although it is editable, we strongly advise against making changes to this file unless absolutely necessary. It's designed to ensure optimal operation, and modifications should be undertaken with careful consideration.
 
-    ## prebuild.js
+## prebuild.js
 
-    In this file, you should adapt the native build process of your framework or library. Usually, in the case of _deliver_ presets, this file will be used to ensure that the generated static artifacts are placed in the _.edge/storage/_ directory.
+In this file, you should adapt the native build process of your framework or library. Usually, in the case of _deliver_ presets, this file will be used to ensure that the generated static artifacts are placed in the _.edge/storage/_ directory.
 
-    #### React (deliver) Example:
+- `Manifest class` (singleton): you should use it to ensure that the preset is compatible with the Azion deployment system and other platforms:
 
-![prebuild](https://github.com/aziontech/vulcan/assets/12740219/85adc374-220b-4003-8c3e-6ec5b06a483f)
+  First you must set all the application's routes, if it is all static you just need to follow the other examples; point ‘/’ to the storage folder (where we store the statics). At the end you call the **Manifest.generate()** method and it should create the manifest.json file inside the build folder (.edge).
+
+  Each routing can have 1 type:
+
+  - _‘Deliver’_ means that you must deliver that static file (or entire folder) to that route.
+  - _‘Compute’_ means that it should become an Edge Function and be computed. In other words, when the request receives that path it must execute the determined function.
+
+  #### React (deliver) Example:
+
+![carbon](https://github.com/aziontech/vulcan/assets/12740219/58787d77-8a6d-41f4-83f9-398718203012)
 
 **Note**: The use of `compute` type presets is still under development and does not have many examples available. We currently support build/import resolution for pure JavaScript code (or with polyfills), as shown in the `./examples/simple-js-esm` example.
 
-3.  ## **Test your preset:**
-    After setting up your preset, you can test it using Vulcan's build command. Depending on the mode of your preset, run one of the following commands in your terminal:
+## 3. **Test your preset:**
+
+After setting up your preset, you can test it using Vulcan's build command. Depending on the mode of your preset, run one of the following commands in your terminal:
 
 https://github.com/aziontech/vulcan/assets/12740219/7033d37a-30ee-4098-8fe5-bbfca536591d
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "edge-functions",
   "type": "module",
-  "version": "2.2.0-stage.4",
+  "version": "2.2.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": {