zephyr-rsbuild-plugin 0.0.56

package/LICENSE

@@ -0,0 +1,39 @@
+ Apache License
+   Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+   ...
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same line as the copyright notice for each file. The "copyright"
+  word should be left as is (without quotes).
+
+   Copyright [2023] [Zephyr Cloud]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,193 @@
+# Zephyr Rsbuild Plugin
+
+<div align="center">
+
+[Zephyr Cloud](https://zephyr-cloud.io) | [Zephyr Docs](https://docs.zephyr-cloud.io/recipes/rsbuild-react) | [Discord](https://zephyr-cloud.io/discord) | [Twitter](https://x.com/ZephyrCloudIO) | [LinkedIn](https://www.linkedin.com/company/zephyr-cloud/)
+
+<hr/>
+<img src="https://cdn.prod.website-files.com/669061ee3adb95b628c3acda/66981c766e352fe1f57191e2_Opengraph-zephyr.png" alt="Zephyr Logo" />
+</div>
+
+An Rsbuild plugin for deploying applications with Zephyr Cloud. This plugin integrates seamlessly with Rsbuild's fast bundling to enable deployment of your applications with Module Federation support.
+
+## Get Started
+
+The fastest way to get started is to use `create-zephyr-apps` to generate a new Rsbuild application with Zephyr integration:
+
+```bash
+npx create-zephyr-apps@latest
+```
+
+For more information please refer to our [documentation](https://docs.zephyr-cloud.io/recipes).
+
+## Installation
+
+```bash
+# npm
+npm install --save-dev zephyr-rsbuild-plugin
+
+# yarn
+yarn add --dev zephyr-rsbuild-plugin
+
+# pnpm
+pnpm add --save-dev zephyr-rsbuild-plugin
+
+# bun
+bun add --dev zephyr-rsbuild-plugin
+```
+
+## Usage
+
+### Basic Setup
+
+Add the plugin to your Rsbuild configuration:
+
+```javascript
+// rsbuild.config.js
+import { defineConfig } from '@rsbuild/core';
+import { pluginReact } from '@rsbuild/plugin-react';
+import { withZephyr } from 'zephyr-rsbuild-plugin';
+
+export default defineConfig({
+  plugins: [
+    pluginReact(),
+    withZephyr(), // Add Zephyr plugin
+  ],
+});
+```
+
+### With Options
+
+```javascript
+// rsbuild.config.js
+import { defineConfig } from '@rsbuild/core';
+import { pluginReact } from '@rsbuild/plugin-react';
+import { withZephyr } from 'zephyr-rsbuild-plugin';
+
+export default defineConfig({
+  plugins: [
+    pluginReact(),
+    withZephyr({
+      wait_for_index_html: true, // Wait for HTML processing
+    }),
+  ],
+});
+```
+
+### TypeScript Configuration
+
+```typescript
+// rsbuild.config.ts
+import { defineConfig } from '@rsbuild/core';
+import { pluginReact } from '@rsbuild/plugin-react';
+import { withZephyr } from 'zephyr-rsbuild-plugin';
+
+export default defineConfig({
+  plugins: [pluginReact(), withZephyr()],
+});
+```
+
+### With Module Federation
+
+```typescript
+// rsbuild.config.ts
+import { defineConfig } from '@rsbuild/core';
+import { pluginReact } from '@rsbuild/plugin-react';
+import { pluginModuleFederation } from '@module-federation/rsbuild-plugin';
+import { withZephyr } from 'zephyr-rsbuild-plugin';
+
+export default defineConfig({
+  plugins: [
+    pluginReact(),
+    pluginModuleFederation({
+      name: 'my-app',
+      remotes: {
+        'shared-ui': 'shared_ui@http://localhost:3001/remoteEntry.js',
+      },
+      shared: {
+        react: { singleton: true },
+        'react-dom': { singleton: true },
+      },
+    }),
+    withZephyr(), // Add after Module Federation
+  ],
+});
+```
+
+## Features
+
+- 🚀 Fast builds with Rsbuild's Rust-based bundler
+- 🏗️ Full Module Federation support
+- 📦 Automatic asset optimization and caching
+- 🔧 Zero-config setup for simple applications
+- 📊 Build analytics and monitoring
+- 🌐 Global CDN distribution
+- ⚡ Hot module replacement in development
+- 🎯 Simple plugin integration
+
+## Module Federation Support
+
+This plugin provides comprehensive Module Federation support:
+
+- **Host Applications**: Consume remote modules from other applications
+- **Remote Applications**: Expose modules for consumption by host applications
+- **Shared Dependencies**: Efficient sharing of common libraries
+- **Dynamic Imports**: Runtime loading of remote modules
+- **Automatic Vendor Federation**: Smart dependency sharing
+
+## Getting Started
+
+1. Install the plugin in your Rsbuild project
+2. Add it to your Rsbuild configuration plugins array
+3. Configure Module Federation (if needed) for microfrontends
+4. Build your application with `npm run build`
+5. Your app will be automatically deployed to Zephyr Cloud
+
+## Build Scripts
+
+Add these scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "dev": "rsbuild dev",
+    "build": "rsbuild build",
+    "preview": "rsbuild preview"
+  }
+}
+```
+
+## Requirements
+
+- Rsbuild 1.0 or higher
+- Node.js 18 or higher
+- Zephyr Cloud account (sign up at [zephyr-cloud.io](https://zephyr-cloud.io))
+
+## Examples
+
+Check out our [examples directory](../../examples/) for complete working examples:
+
+- [rsbuild-sample-app](../../examples/rsbuild-sample-app/) - Basic Rsbuild setup with Zephyr
+
+## API Reference
+
+### withZephyr(options?)
+
+Creates an Rsbuild plugin for Zephyr integration.
+
+#### Parameters
+
+- `options` (optional): Configuration options
+  - `wait_for_index_html?: boolean` - Wait for HTML processing before deployment
+
+#### Returns
+
+An Rsbuild plugin that can be added to the plugins array.
+
+## Contributing
+
+We welcome contributions! Please read our [contributing guidelines](../../CONTRIBUTING.md) for more information.
+
+## License
+
+Licensed under the Apache-2.0 License. See [LICENSE](LICENSE) for more information.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { withZephyr } from './rsbuild-plugin/with-zephyr';
+export { onDeploymentDone, resolveIndexHtml } from 'zephyr-rspack-plugin';

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveIndexHtml = exports.onDeploymentDone = exports.withZephyr = void 0;
+var with_zephyr_1 = require("./rsbuild-plugin/with-zephyr");
+Object.defineProperty(exports, "withZephyr", { enumerable: true, get: function () { return with_zephyr_1.withZephyr; } });
+var zephyr_rspack_plugin_1 = require("zephyr-rspack-plugin");
+Object.defineProperty(exports, "onDeploymentDone", { enumerable: true, get: function () { return zephyr_rspack_plugin_1.onDeploymentDone; } });
+Object.defineProperty(exports, "resolveIndexHtml", { enumerable: true, get: function () { return zephyr_rspack_plugin_1.resolveIndexHtml; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,4DAA0D;AAAjD,yGAAA,UAAU,OAAA;AAEnB,6DAA0E;AAAjE,wHAAA,gBAAgB,OAAA;AAAE,wHAAA,gBAAgB,OAAA"}

package/dist/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "zephyr-rsbuild-plugin",
+  "version": "0.0.56",
+  "description": "Rsbuild plugin for Zephyr",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ZephyrCloudIO/zephyr-packages.git",
+    "directory": "libs/zephyr-rsbuild-plugin"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "ZephyrCloudIO",
+    "url": "https://github.com/ZephyrCloudIO"
+  },
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "nx run zephyr-rsbuild-plugin:build",
+    "patch-version": "pnpm version"
+  },
+  "dependencies": {
+    "@rsbuild/core": "^1.3.22",
+    "zephyr-rspack-plugin": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/jest": "catalog:typescript",
+    "@typescript-eslint/eslint-plugin": "catalog:eslint",
+    "ts-jest": "catalog:typescript"
+  },
+  "peerDependencies": {
+    "@rsbuild/core": ">=1.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/dist/rsbuild-plugin/with-zephyr.d.ts

@@ -0,0 +1,5 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+export interface ZephyrRsbuildPluginOptions {
+    wait_for_index_html?: boolean;
+}
+export declare function withZephyr(options?: ZephyrRsbuildPluginOptions): RsbuildPlugin;

package/dist/rsbuild-plugin/with-zephyr.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withZephyr = withZephyr;
+const zephyr_rspack_plugin_1 = require("zephyr-rspack-plugin");
+function withZephyr(options) {
+    return {
+        name: 'zephyr-rsbuild-plugin',
+        setup(api) {
+            api.modifyRspackConfig(async (config) => {
+                return await (0, zephyr_rspack_plugin_1.withZephyr)(options)(config);
+            });
+        },
+    };
+}
+//# sourceMappingURL=with-zephyr.js.map

package/dist/rsbuild-plugin/with-zephyr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"with-zephyr.js","sourceRoot":"","sources":["../../src/rsbuild-plugin/with-zephyr.ts"],"names":[],"mappings":";;AAOA,gCASC;AAfD,+DAAsE;AAMtE,SAAgB,UAAU,CAAC,OAAoC;IAC7D,OAAO;QACL,IAAI,EAAE,uBAAuB;QAC7B,KAAK,CAAC,GAAG;YACP,GAAG,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBACtC,OAAO,MAAM,IAAA,iCAAgB,EAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "zephyr-rsbuild-plugin",
+  "version": "0.0.56",
+  "description": "Rsbuild plugin for Zephyr",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ZephyrCloudIO/zephyr-packages.git",
+    "directory": "libs/zephyr-rsbuild-plugin"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "ZephyrCloudIO",
+    "url": "https://github.com/ZephyrCloudIO"
+  },
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@rsbuild/core": "^1.3.22",
+    "zephyr-rspack-plugin": "0.0.57"
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.14",
+    "@typescript-eslint/eslint-plugin": "^8.27.0",
+    "ts-jest": "^29.2.6"
+  },
+  "peerDependencies": {
+    "@rsbuild/core": ">=1.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "nx run zephyr-rsbuild-plugin:build",
+    "patch-version": "pnpm version"
+  }
+}