edge-functions 1.7.1 → 2.0.0-stage.2

package/.prettierignore

@@ -0,0 +1,4 @@
+examples/*
+jsdoc/*
+yarn.lock
+CHANGELOG.md

package/CHANGELOG.md

@@ -1,3 +1,56 @@
+## [2.0.0-stage.2](https://github.com/aziontech/vulcan/compare/v2.0.0-stage.1...v2.0.0-stage.2) (2023-10-26)
+
+
+### Bug Fixes
+
+* local env hot reload ([#161](https://github.com/aziontech/vulcan/issues/161)) ([e2edb9c](https://github.com/aziontech/vulcan/commit/e2edb9cad2222395850a09f9476eb206b64568f3))
+* localenv hot reload ([85f606c](https://github.com/aziontech/vulcan/commit/85f606c7025d1d8474e37bbeecaf46ee9bd7ef3b))
+
+## [2.0.0-stage.1](https://github.com/aziontech/vulcan/compare/v1.7.1...v2.0.0-stage.1) (2023-10-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* Introduced vulcan.config.js and changing the way to read the entry point of the preset files and the application entrypoint. No longer use the "main()" function as input, but the function that is exported as default "export default foo()".
+
+### Features
+
+* add jsx loader (esbuild) ([93ccf13](https://github.com/aziontech/vulcan/commit/93ccf134159e053814e315ce0e0e4a71ca086b7d))
+* Create injectFilesInMem util ([1555c98](https://github.com/aziontech/vulcan/commit/1555c98e1cf0ce40e3c9aca2d14a75af03e89fa3))
+* Create node fs polyfill ([cab1095](https://github.com/aziontech/vulcan/commit/cab1095e056e4720c8762a7b27fc6c92e3b4dd03))
+* Create node module polyfill ([976a6c3](https://github.com/aziontech/vulcan/commit/976a6c382119c55e3c9f92cd02d0fd74aee863d3))
+* Create node process polyfill ([1e61ba2](https://github.com/aziontech/vulcan/commit/1e61ba2d1fb30259b47c72e825dab5a72478d532))
+* enable useOwnWorker for custom provider ([8a88ff7](https://github.com/aziontech/vulcan/commit/8a88ff7efd0bc5afc43f0fe6666da3831ae702c0))
+* esbuild windows support ([d10e467](https://github.com/aziontech/vulcan/commit/d10e4678154e87ad33b5de9f76680f1a6815edcc))
+* Handle content to inject in worker ([3356743](https://github.com/aziontech/vulcan/commit/33567432832ebb60e07bd4a1098ff62ef1e2f09c))
+* Handle mem fs injection in dispatcher ([3e89438](https://github.com/aziontech/vulcan/commit/3e89438528b8ebbbecc8366af5776c282d8a764e))
+* In Memory File System ([#154](https://github.com/aziontech/vulcan/issues/154)) ([5a1a4fc](https://github.com/aziontech/vulcan/commit/5a1a4fc2f8c971fe57cb96888310910eef350102))
+* new vulcan.config and entry reading pattern ([62dbcae](https://github.com/aziontech/vulcan/commit/62dbcae283df8440daa91238ec577060662be3bf))
+* read vulcan.env for build preconfig ([b6a7b7c](https://github.com/aziontech/vulcan/commit/b6a7b7c8733a59513f624ba8dd68d424c7a66616))
+* Use fs, module and process polyfills in next compute build ([7de9a56](https://github.com/aziontech/vulcan/commit/7de9a56e7cdda8cf584697ec02457f602e2dad68))
+* vulcan.config.js ([ee7b0c0](https://github.com/aziontech/vulcan/commit/ee7b0c038a9623adec6b44e528ff3c8269e07cc9))
+* vulcan.config.js ([#153](https://github.com/aziontech/vulcan/issues/153)) ([f7d0118](https://github.com/aziontech/vulcan/commit/f7d01183d961aac5a50f4739db2504e1dd3c452d))
+
+
+### Bug Fixes
+
+* Create vulcan global object ([04e2c4e](https://github.com/aziontech/vulcan/commit/04e2c4eaf0ddae261069c04212f9aef333516cbf))
+* fetch in local environment ([86ec3f5](https://github.com/aziontech/vulcan/commit/86ec3f536c30be13591074a97ca33058004c4c35))
+* fix some tests ([ed603a9](https://github.com/aziontech/vulcan/commit/ed603a9be4931d2e7b10fc3c2dab036a84113097))
+* getPackageManager command ([391d565](https://github.com/aziontech/vulcan/commit/391d565c289527e911bc47c8f9a45b33d2a2c88f))
+* rebuild yarn.lock ([7d60749](https://github.com/aziontech/vulcan/commit/7d60749627d931e31528ab903588a5c88b058a20))
+* relative package manager (npm) ([605d6e6](https://github.com/aziontech/vulcan/commit/605d6e6280496707d32df5df08745076e490b4cb))
+* remove dependency cycle in vercel util ([a0cc528](https://github.com/aziontech/vulcan/commit/a0cc5286665258b87fd9125ef3a082c9cd25d7ff))
+* Remove duplicated imports of typedefs (jsdocs) ([58054d0](https://github.com/aziontech/vulcan/commit/58054d011203d2c54a0961a25d1fbfe1621d5597))
+* Remove duplicated imports of typedefs (jsdocs) ([#138](https://github.com/aziontech/vulcan/issues/138)) ([03d6be9](https://github.com/aziontech/vulcan/commit/03d6be99835657032844f74dd95c435b58ce9468))
+* Remove duplicated to string in injectFilesInMem util ([1a9bc0f](https://github.com/aziontech/vulcan/commit/1a9bc0fff99fa9ecdaa1a1f69be871674a9e49d6))
+* Set correct command in hexo prebuild ([fd62874](https://github.com/aziontech/vulcan/commit/fd628748c0432056f166075a607db588ed748125))
+* Set correct command in hexo prebuild ([#158](https://github.com/aziontech/vulcan/issues/158)) ([5cb729c](https://github.com/aziontech/vulcan/commit/5cb729ca477a53018b23a4bfb40766099a126240))
+* Set correct log in get asset from storage method ([1e9c63a](https://github.com/aziontech/vulcan/commit/1e9c63ae6a2f4af3359ed9b610d9c692891577a6))
+* validate installed dependencies only if they exists ([c2789e5](https://github.com/aziontech/vulcan/commit/c2789e5e7b2be855a328d4a24d02da22d7874a2c))
+* validate installed dependencies only if they exists ([850dbd1](https://github.com/aziontech/vulcan/commit/850dbd1512efb4658eac5ccab42fdd0b1f96b73f))
+* validate installed dependencies only if they exists ([#134](https://github.com/aziontech/vulcan/issues/134)) ([51474ab](https://github.com/aziontech/vulcan/commit/51474aba9f97a3beaef58d7a9bc7e26a9d19ca69))
+
 ### [1.7.1](https://github.com/aziontech/vulcan/compare/v1.7.0...v1.7.1) (2023-10-10)
 
 
@@ -45,49 +98,45 @@
 
 ## [1.7.0-stage.2](https://github.com/aziontech/vulcan/compare/v1.7.0-stage.1...v1.7.0-stage.2) (2023-09-14)
 
-
 ### Bug Fixes
 
-* Add unused files in npm ignore ([ea3acf8](https://github.com/aziontech/vulcan/commit/ea3acf8a536fbe26f0e3e5b359385607930e79ec))
-* Create .npmignore ([#131](https://github.com/aziontech/vulcan/issues/131)) ([90383b0](https://github.com/aziontech/vulcan/commit/90383b01cd0dea848840d3348bf30cdcfdd79388))
+- Add unused files in npm ignore ([ea3acf8](https://github.com/aziontech/vulcan/commit/ea3acf8a536fbe26f0e3e5b359385607930e79ec))
+- Create .npmignore ([#131](https://github.com/aziontech/vulcan/issues/131)) ([90383b0](https://github.com/aziontech/vulcan/commit/90383b01cd0dea848840d3348bf30cdcfdd79388))
 
 ## [1.7.0-stage.1](https://github.com/aziontech/vulcan/compare/v1.6.4-stage.2...v1.7.0-stage.1) (2023-09-14)
 
-
 ### Features
 
-* add custom server with js files ([#97](https://github.com/aziontech/vulcan/issues/97)) ([f73a31e](https://github.com/aziontech/vulcan/commit/f73a31e19e23c773e379f3cd193262468cf1ba52))
-* Add list preset modes ([4d1b924](https://github.com/aziontech/vulcan/commit/4d1b924f1c3d403683dcd1d0a2245cf9d68cd3a3))
-* Add next webpack polyfills ([#98](https://github.com/aziontech/vulcan/issues/98)) ([5451fa5](https://github.com/aziontech/vulcan/commit/5451fa59c69f4bc148649e2f0b67e7b15012f678))
-* Add Next.js support ([#125](https://github.com/aziontech/vulcan/issues/125)) ([a53c807](https://github.com/aziontech/vulcan/commit/a53c80727673ff209842372eb467d01595f3d15d))
-* added handler and code compile ([#100](https://github.com/aziontech/vulcan/issues/100)) ([2e245fd](https://github.com/aziontech/vulcan/commit/2e245fdf67f5fdb746072950b6e64b14d9273d19))
-* check if dependencies are installed and log vercel cli ([144bc7a](https://github.com/aziontech/vulcan/commit/144bc7ac02b626fa9c1693ebd9a2f39a17244473))
-* Improve vercel build logs ([67ad3bd](https://github.com/aziontech/vulcan/commit/67ad3bd8f918c23d09514ce7acac77a5ac519db5))
-* list presets modes ([df1d71e](https://github.com/aziontech/vulcan/commit/df1d71e43041224a47653e0c9853e18205f92c51))
-* pre build configuration and custom static file server Next ([#96](https://github.com/aziontech/vulcan/issues/96)) ([1d2ab58](https://github.com/aziontech/vulcan/commit/1d2ab58370432b81cfa625a0d9a1c32eaa27cb93))
+- add custom server with js files ([#97](https://github.com/aziontech/vulcan/issues/97)) ([f73a31e](https://github.com/aziontech/vulcan/commit/f73a31e19e23c773e379f3cd193262468cf1ba52))
+- Add list preset modes ([4d1b924](https://github.com/aziontech/vulcan/commit/4d1b924f1c3d403683dcd1d0a2245cf9d68cd3a3))
+- Add next webpack polyfills ([#98](https://github.com/aziontech/vulcan/issues/98)) ([5451fa5](https://github.com/aziontech/vulcan/commit/5451fa59c69f4bc148649e2f0b67e7b15012f678))
+- Add Next.js support ([#125](https://github.com/aziontech/vulcan/issues/125)) ([a53c807](https://github.com/aziontech/vulcan/commit/a53c80727673ff209842372eb467d01595f3d15d))
+- added handler and code compile ([#100](https://github.com/aziontech/vulcan/issues/100)) ([2e245fd](https://github.com/aziontech/vulcan/commit/2e245fdf67f5fdb746072950b6e64b14d9273d19))
+- check if dependencies are installed and log vercel cli ([144bc7a](https://github.com/aziontech/vulcan/commit/144bc7ac02b626fa9c1693ebd9a2f39a17244473))
+- Improve vercel build logs ([67ad3bd](https://github.com/aziontech/vulcan/commit/67ad3bd8f918c23d09514ce7acac77a5ac519db5))
+- list presets modes ([df1d71e](https://github.com/aziontech/vulcan/commit/df1d71e43041224a47653e0c9853e18205f92c51))
+- pre build configuration and custom static file server Next ([#96](https://github.com/aziontech/vulcan/issues/96)) ([1d2ab58](https://github.com/aziontech/vulcan/commit/1d2ab58370432b81cfa625a0d9a1c32eaa27cb93))
 
 ### [1.6.5](https://github.com/aziontech/vulcan/compare/v1.6.4...v1.6.5) (2023-09-14)
 
-
 ### Bug Fixes
 
-* Add npm semantic release plugin in plugins list ([703a8ea](https://github.com/aziontech/vulcan/commit/703a8ea0f04f8d1de4489a8dd9f3523566334a4a))
-* Add write permissions in release workflow ([39c1cae](https://github.com/aziontech/vulcan/commit/39c1cae20cc5371a1a7ba49d4754474ee61735d0))
-* permissions in release workflow ([#126](https://github.com/aziontech/vulcan/issues/126)) ([37ebee6](https://github.com/aziontech/vulcan/commit/37ebee608564de0d8903f9b09788c3aaffcd2315))
-* Remove skip ci option in git plugin ([d954fdc](https://github.com/aziontech/vulcan/commit/d954fdc76944c954662e3828054f5b06c854e865))
-* semantic release plugins config ([f7c30a2](https://github.com/aziontech/vulcan/commit/f7c30a26dd7eb0051bf9306be66cbcb78253286a))
-* semantic release plugins config ([#124](https://github.com/aziontech/vulcan/issues/124)) ([89289e0](https://github.com/aziontech/vulcan/commit/89289e066b01880f566d396a2214c528e6db93a3))
-* set correct options in plugins section ([3a0c8f2](https://github.com/aziontech/vulcan/commit/3a0c8f2cf4c70fc70da0c19e6c5172a4bb8aef0a))
+- Add npm semantic release plugin in plugins list ([703a8ea](https://github.com/aziontech/vulcan/commit/703a8ea0f04f8d1de4489a8dd9f3523566334a4a))
+- Add write permissions in release workflow ([39c1cae](https://github.com/aziontech/vulcan/commit/39c1cae20cc5371a1a7ba49d4754474ee61735d0))
+- permissions in release workflow ([#126](https://github.com/aziontech/vulcan/issues/126)) ([37ebee6](https://github.com/aziontech/vulcan/commit/37ebee608564de0d8903f9b09788c3aaffcd2315))
+- Remove skip ci option in git plugin ([d954fdc](https://github.com/aziontech/vulcan/commit/d954fdc76944c954662e3828054f5b06c854e865))
+- semantic release plugins config ([f7c30a2](https://github.com/aziontech/vulcan/commit/f7c30a26dd7eb0051bf9306be66cbcb78253286a))
+- semantic release plugins config ([#124](https://github.com/aziontech/vulcan/issues/124)) ([89289e0](https://github.com/aziontech/vulcan/commit/89289e066b01880f566d396a2214c528e6db93a3))
+- set correct options in plugins section ([3a0c8f2](https://github.com/aziontech/vulcan/commit/3a0c8f2cf4c70fc70da0c19e6c5172a4bb8aef0a))
 
 ### [1.6.4-stage.2](https://github.com/aziontech/vulcan/compare/v1.6.4-stage.1...v1.6.4-stage.2) (2023-09-14)
 
-
 ### Bug Fixes
 
-* Add npm semantic release plugin in plugins list ([703a8ea](https://github.com/aziontech/vulcan/commit/703a8ea0f04f8d1de4489a8dd9f3523566334a4a))
-* Add write permissions in release workflow ([39c1cae](https://github.com/aziontech/vulcan/commit/39c1cae20cc5371a1a7ba49d4754474ee61735d0))
-* permissions in release workflow ([#126](https://github.com/aziontech/vulcan/issues/126)) ([37ebee6](https://github.com/aziontech/vulcan/commit/37ebee608564de0d8903f9b09788c3aaffcd2315))
-* Remove skip ci option in git plugin ([d954fdc](https://github.com/aziontech/vulcan/commit/d954fdc76944c954662e3828054f5b06c854e865))
-* semantic release plugins config ([f7c30a2](https://github.com/aziontech/vulcan/commit/f7c30a26dd7eb0051bf9306be66cbcb78253286a))
-* semantic release plugins config ([#124](https://github.com/aziontech/vulcan/issues/124)) ([89289e0](https://github.com/aziontech/vulcan/commit/89289e066b01880f566d396a2214c528e6db93a3))
-* set correct options in plugins section ([3a0c8f2](https://github.com/aziontech/vulcan/commit/3a0c8f2cf4c70fc70da0c19e6c5172a4bb8aef0a))
+- Add npm semantic release plugin in plugins list ([703a8ea](https://github.com/aziontech/vulcan/commit/703a8ea0f04f8d1de4489a8dd9f3523566334a4a))
+- Add write permissions in release workflow ([39c1cae](https://github.com/aziontech/vulcan/commit/39c1cae20cc5371a1a7ba49d4754474ee61735d0))
+- permissions in release workflow ([#126](https://github.com/aziontech/vulcan/issues/126)) ([37ebee6](https://github.com/aziontech/vulcan/commit/37ebee608564de0d8903f9b09788c3aaffcd2315))
+- Remove skip ci option in git plugin ([d954fdc](https://github.com/aziontech/vulcan/commit/d954fdc76944c954662e3828054f5b06c854e865))
+- semantic release plugins config ([f7c30a2](https://github.com/aziontech/vulcan/commit/f7c30a26dd7eb0051bf9306be66cbcb78253286a))
+- semantic release plugins config ([#124](https://github.com/aziontech/vulcan/issues/124)) ([89289e0](https://github.com/aziontech/vulcan/commit/89289e066b01880f566d396a2214c528e6db93a3))
+- set correct options in plugins section ([3a0c8f2](https://github.com/aziontech/vulcan/commit/3a0c8f2cf4c70fc70da0c19e6c5172a4bb8aef0a))

package/CODE_OF_CONDUCT.md

@@ -14,21 +14,21 @@ religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -70,4 +70,4 @@ members of the project's leadership.
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: https://www.contributor-covenant.org
+[homepage]: https://www.contributor-covenant.org

package/CONTRIBUTING.md

@@ -5,6 +5,7 @@ First off, thanks for taking the time to contribute!
 All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. 🎉
 
 ## Table of Contents
+
 - [Code of Conduct](#code-of-conduct)
 - [I Have a Question](#i-have-a-question)
 - [I Want To Contribute](#i-want-to-contribute)
@@ -12,7 +13,6 @@ All types of contributions are encouraged and valued. See the Table of Contents
   - [Suggesting Enhancements](#suggesting-enhancements)
   - [Your First Code Contribution](#your-first-code-contribution)
 
-
 ## Code of Conduct
 
 This project and everyone participating in it is governed by the
@@ -35,6 +35,7 @@ We will then take care of the issue as soon as possible.
 ## I Want To Contribute
 
 > ### Legal Notice
+>
 > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and that the content you contribute may be provided under the project license.
 
 ### Reporting Bugs
@@ -57,7 +58,7 @@ We use GitHub issues to track bugs and errors. If you run into an issue with the
 
 - Open an [Issue](https://github.com/aziontech/vulcan/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
 - Explain the behavior you would expect and the actual behavior.
-- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
 - Provide the information you collected in the previous section.
 
 ### Suggesting Enhancements
@@ -69,8 +70,8 @@ This section guides you through submitting an enhancement suggestion for Cells S
 - Make sure that you are using the latest version.
 - Perform a [search](https://github.com/aziontech/vulcan/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 - If your enhancement is nontrivial,
-please open an [Issue](https://github.com/aziontech/vulcan/issues/new) to discuss the
-idea and implementation strategy before submitting a PR.
+  please open an [Issue](https://github.com/aziontech/vulcan/issues/new) to discuss the
+  idea and implementation strategy before submitting a PR.
 
 #### How Do I Submit a Good Enhancement Suggestion?
 
@@ -87,4 +88,4 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/aziont
 1. Fork the repo
 2. Clone your forked repo
 3. Commit the changes you’ve developed on your fork
-4. If everything looks good, create a pull request on the base repo with your changes.
+4. If everything looks good, create a pull request on the base repo with your changes.

package/LICENSE.md

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,7 +1,6 @@
-
 # Vulcan - Forging The Edge
-![vulcan](https://github.com/aziontech/vulcan/assets/12740219/a5043e6f-11cb-4498-a300-5bdb617a9989)
 
+![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.
 
@@ -37,6 +36,7 @@ Follow these steps to start using Vulcan:
    cd vulcan
    npm install
    ```
+
 3. Install the Vulcan CLI globally, which allows you to use it as a command-line tool from anywhere in your system.
 
    ```shell
@@ -45,52 +45,147 @@ Follow these steps to start using Vulcan:
 
    This command sets up the necessary project structure and configuration files for 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.
+4. 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)
+- Build a JavaScript/Node project (back-end)
 
-   ```shell
-   vulcan build
-   ```
-   
-* Build a TypeScript/Node (back-end)
+  ```shell
+  vulcan build
+  ```
 
-   ```shell
-   vulcan build --preset typescript
-   ```
-   
-* Build a Static Next.js project
+- Build a TypeScript/Node (back-end)
 
-   ```shell
-   vulcan build --preset next --mode deliver
-   ```
-   
- * Build a Static Astro.js project
+  ```shell
+  vulcan build --preset typescript
+  ```
 
-   ```shell
-   vulcan build --preset astro --mode deliver
-   ```
-   
-* Test your project locally (after build)
+- Build a Static Next.js project
 
-   ```shell
-   vulcan dev
-   ```
+  ```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
+  ```
+
+## Vulcan.config.js
+
+The `vulcan.config.js` file offers a robust configuration system for Vulcan. This file is not mandatory but acts as an override mechanism. If you define properties in this file, they will supersede the preset configurations. Properties not defined will rely on the preset.
+
+Here's a detailed breakdown of the configuration properties available in `vulcan.config.js`:
+
+### Entry
+
+**Type:** String
+
+**Description:**  
+This represents the primary entry point for your application, where the building process begins.
+
+**Note:** `Entry` will be ignored for jamstack solutions.
+
+### Builder
+
+**Type:** String ('esbuild' or 'webpack')
+
+**Description:**  
+Defines which build tool to use. The available options are `esbuild` and `webpack`.
 
+### UseNodePolyfills
+
+**Type:** Boolean
+
+**Description:**  
+Determines if Node.js polyfills should be applied. This is useful for projects that leverage Node.js specific functionalities but are targeting environments without such built-in capabilities.
+
+### UseOwnWorker
+
+**Type:** Boolean
+
+**Description:**  
+This flag indicates that the constructed code inserts its own worker expression, such as `addEventListener("fetch")` or similar, without the need to inject a provider.
+
+### Preset
+
+**Type:** Object
+
+**Description:**  
+Provides preset-specific configurations.
+
+- **Name (Type: String):** Refers to the preset name, e.g., "vue" or "next".
+- **Mode (Type: String):** Specifies the mode for the preset, e.g., "compute" or "deliver".
+
+### MemoryFS
+
+**Type:** Object
+
+**Description:**  
+Configurations related to the in-memory filesystem.
+
+- **InjectionDirs (Type: Array of Strings):** Directories to be injected into memory for runtime access via the fs API.
+
+- **RemovePathPrefix (Type: String):** A prefix path to be removed from files before injecting into memory.
+
+### Custom
+
+**Type:** Object
+
+**Description:**  
+Allows you to extend the capabilities of the chosen bundler (either `webpack` or `esbuild`) with custom plugins or configurations.
+
+- **Plugins (Type: Object):** Add your custom plugins for your chosen bundler here.
+
+### Example Configuration
+
+For a Vue-based project:
+
+```javascript
+module.exports = {
+  entry: 'src/index.js',
+  builder: 'webpack',
+  useNodePolyfills: true,
+  useOwnWorker: false,
+  preset: {
+    name: 'vue',
+    mode: 'compute',
+  },
+  memoryFS: {
+    injectionDirs: ['.faststore/@generated/graphql'],
+    removePathPrefix: '.faststore/',
+  },
+  custom: {
+    plugins: {},
+  },
+};
+```
+
+**Note:** Adapting `vulcan.config.js` to your setup allows a personalized development experience, catering to the specific needs of your JavaScript applications and frameworks.
 
 ## Docs
-* [Overview](docs/overview.md)
-* [Presets](docs/presets.md)
+
+- [Overview](docs/overview.md)
+- [Presets](docs/presets.md)
 
 ## Contributing
+
 Check the [Contributing doc](CONTRIBUTING.md).
 
 ## Code of Conduct
-Check the [Code of Conduct ](CODE_OF_CONDUCT.md).
+
+Check the [Code of Conduct](CODE_OF_CONDUCT.md).
 
 ## License
+
 [MIT](LICENSE.md)

package/aliases.js

@@ -6,6 +6,8 @@ export default [
   ['#build', './lib/build/dispatcher/index.js'],
   ['#bundlers', './lib/build/bundlers/index.js'],
   ['#notations/*', './lib/notations'],
+  ['#namespaces', './lib/notations/namespaces.js'],
+  ['#typedef', './lib/notations/typedef.js'],
   ['#env', './lib/env/index.js'],
   ['#platform', './lib/platform/index.js'],
   ['#constants', './lib/constants/index.js'],

package/docs/overview.md

@@ -1,6 +1,7 @@
 # Overview
 
 ## Build Pipeline
+
 ```mermaid
 flowchart LR
 
@@ -11,19 +12,23 @@ D --> E[Artifacts]
 ```
 
 ### Trigger
+
 An external call to run a build.
 
 ### Dispatcher
-* Receive build options(args);
-* Select which build process to run;
-* Load necessary template files and import correct modules (prebuild and configs);
+
+- Receive build options(args);
+- Select which build process to run;
+- Load necessary template files and import correct modules (prebuild and configs);
 
 ### Prebuild
+
 Custom prebuild module that runs actions to generate entrypoint and necessary files.
 
-The user is free to run any action in this step. All actions must be called in a exported `main` function.
+The user is free to run any action in this step. All actions must be called in a `exported default` function.
 
 ### Common Build
+
 Module that runs azion common build.
 
 Polyfills can be used to generate the worker(s) file(s).
@@ -31,7 +36,9 @@ 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
+
 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'.
+
+- JS worker(s) => '.edge/workers.js';
+- Assets => '.edge/storage/\*';
+- Environment variables => '.edge/.env'.