From 008749a5a788b71606d88df210ae87a04f8121e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Filho?= Date: Thu, 23 Apr 2026 20:12:20 -0300 Subject: [PATCH 1/3] docs(builder): add README documentation --- packages/builder/README.md | 163 ++++++++++++++++++++++++++++++++++ packages/builder/package.json | 3 +- packages/client/package.json | 1 + 3 files changed, 166 insertions(+), 1 deletion(-) create mode 100644 packages/builder/README.md diff --git a/packages/builder/README.md b/packages/builder/README.md new file mode 100644 index 00000000..facfc0be --- /dev/null +++ b/packages/builder/README.md @@ -0,0 +1,163 @@ +# Azion Builder + +A builder utility for Azion's platform, designed to streamline the development process and enhance productivity by providing build configurations and polyfills for Edge Runtime environments. + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Features](#features) + - [Bundlers](#bundlers) + - [Polyfills](#polyfills) +- [API Reference](#api-reference) +- [Contributing](#contributing) + +## Installation + +Install the package using npm or yarn: + +```bash +npm install @aziontech/builder +``` + +or + +```bash +yarn add @aziontech/builder +``` + +## Usage + +The builder provides utilities to create build configurations for esbuild and webpack, optimized for Azion Edge Runtime. + +### Using with esbuild + +```javascript +import { createAzionESBuildConfig, executeESBuildBuild } from '@aziontech/builder'; + +// Create configuration +const config = createAzionESBuildConfig({ + entryPoints: ['./src/index.ts'], + outfile: './dist/bundle.js', +}); + +// Execute build +await executeESBuildBuild(config); +``` + +### Using with webpack + +```javascript +import { createAzionWebpackConfig, executeWebpackBuild } from '@aziontech/builder'; + +// Create configuration +const config = createAzionWebpackConfig({ + entry: './src/index.ts', + output: { + path: path.resolve(__dirname, 'dist'), + filename: 'bundle.js', + }, +}); + +// Execute build +await executeWebpackBuild(config); +``` + +## Features + +### Bundlers + +The builder supports two bundlers: + +- **esbuild** - Fast JavaScript bundler with optimized configuration for Edge Runtime +- **webpack** - Powerful module bundler with extensive plugin ecosystem + +Both bundlers come pre-configured with: + +- Node.js polyfills for Edge Runtime compatibility +- Azion-specific polyfills for platform features +- Custom Babel loader support +- Production and development optimizations + +### Polyfills + +The package includes polyfills for various Node.js modules and Azion-specific features: + +- `async-hooks` - Async hooks functionality +- `crypto` - Cryptographic functions +- `fs` - File system operations +- `stream` - Stream handling +- `promises` - Promise utilities +- Azion-specific polyfills: + - `env-vars` - Environment variables + - `fetch` - Fetch API + - `fetch-event` - Fetch event handling + - `firewall-event` - Firewall event handling + - `kv` - Key-value storage + - `network-list` - Network list operations + - `storage` - Storage API + +#### Using Polyfills + +```javascript +// Import polyfills directly +import '@aziontech/builder/polyfills'; +``` + +## API Reference + +### createAzionESBuildConfig + +Creates an esbuild configuration optimized for Azion Edge Runtime. + +**Parameters:** + +- `options` - esbuild build options + +**Returns:** + +- `ESBuildConfiguration` - The configured esbuild options + +### executeESBuildBuild + +Executes the esbuild build process. + +**Parameters:** + +- `config` - The esbuild configuration + +**Returns:** + +- `Promise` + +### createAzionWebpackConfig + +Creates a webpack configuration optimized for Azion Edge Runtime. + +**Parameters:** + +- `options` - webpack configuration options + +**Returns:** + +- `WebpackConfiguration` - The configured webpack options + +### executeWebpackBuild + +Executes the webpack build process. + +**Parameters:** + +- `config` - The webpack configuration + +**Returns:** + +- `Promise` + +## Contributing + +Contributions are welcome! Please read our contributing guidelines for details on our code of conduct and the process for submitting pull requests. + +## License + +MIT diff --git a/packages/builder/package.json b/packages/builder/package.json index 9326d5a5..c30343e5 100644 --- a/packages/builder/package.json +++ b/packages/builder/package.json @@ -31,7 +31,8 @@ "files": [ "dist", "package.json", - "src/polyfills/*" + "src/polyfills/*", + "README.md" ], "dependencies": { "@aziontech/config": "workspace:*", diff --git a/packages/client/package.json b/packages/client/package.json index ce2733a9..d17d1271 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -2,6 +2,7 @@ "name": "@aziontech/client", "version": "0.0.0", "description": "", + "private": true, "main": "./dist/index.cjs", "module": "./dist/index.mjs", "types": "./dist/index.d.ts", From e8f50725d9b93e7f273c45d148b83b2c067bfc85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Filho?= Date: Thu, 23 Apr 2026 20:13:58 -0300 Subject: [PATCH 2/3] ci(release): comment out NODE_AUTH_TOKEN --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 313fd011..bb0ebbce 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -33,4 +33,4 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.CUSTOM_GITHUB_TOKEN }} NODE_ENV: 'production' - NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + # NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} // active when publish a new package From 63662c53ba3bc12afc717d0c73452cbd4f20d350 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Filho?= Date: Thu, 23 Apr 2026 20:14:20 -0300 Subject: [PATCH 3/3] chore: add changeset --- .changeset/huge-sheep-flash.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/huge-sheep-flash.md diff --git a/.changeset/huge-sheep-flash.md b/.changeset/huge-sheep-flash.md new file mode 100644 index 00000000..94085fd9 --- /dev/null +++ b/.changeset/huge-sheep-flash.md @@ -0,0 +1,5 @@ +--- +'@aziontech/builder': patch +--- + +feat: add readme