@integration-app/react 0.2.0 → 0.3.1

package/README.md

@@ -7,23 +7,63 @@ To release a new version of a package (@integration-app/sdk, @integration-app/ui
 * Merge the PR.
 * Run a Github Action to publish a package.
 
-# Rollup config
 
-Check out the [rollup.config.mjs](rollup.config.mjs) file for the full config.
+# Rollup Configuration
 
-It's pretty self-explanatory, but here's some additional info:
+To see the complete configuration, refer to the `rollup.config.mjs` and `rollup.dts.config.mjs` files. Although these files are self-explanatory, here's some additional information:
+
+In `rollup.config.mjs`, we set `{external: [/node_modules/]}` to exclude our dependencies from being bundled.
+
+## Bundle and DTS File Generation
+
+We encountered issues with `rollup-plugin-dts` generating incorrect DTS files when used in the same configuration as `@rollup/plugin-typescript`. To resolve this, we use two Rollup configurations:
+- `rollup.config.mjs` for bundle generation
+- `rollup.dts.config.mjs` for DTS file generation.
 
 ## Externals
 
-We set `{external: [/node_modules/]}` because we don't want to bundle any of our dependencies.
-If we need to bundle some dependencies and some not, we can use [`rollup-plugin-peer-deps-external`](https://www.npmjs.com/package/rollup-plugin-peer-deps-external) plugin instead of this.
+We set external dependencies in `rollup.config.mjs`:
+- `{external: [/node_modules/]}` to exclude all `node_modules`.
+- `@integration-app/sdk` to prevent Rollup from bundling the `@integration-app/sdk` package during local development, when it is used via a symlink to the SDK in the root folder.
+- `react` and `react/jsx-runtime` are excluded to avoid unresolved dependency errors, as React is a peer dependency.
+
+## Bundle and DTS File Generation Workflow
+
+When using `rollup-plugin-dts` and `@rollup/plugin-typescript` in the same configuration, we experienced issues with generating incorrect DTS files. To solve this, we use two Rollup configurations:
+- `rollup.config.mjs` for generating bundles
+- `rollup.dts.config.mjs` for generating DTS files.
+
+### Build 
+
+For local build, the following steps are taken:
+
+- Clean the `/dist` folder.
+- Install local `@integration-app/sdk` pointed to `sdk` folder
+- Remove `react` and `react-dom` packages from `node_modules` folder
+  - We should do it to allow out package work in `console`, `engine` and other local projects
+- Rollup with `rollup.config.mjs` configuration generates bundle files and basic DTS files, which are placed in the `dist/dts` folder.
+- Rollup with `rollup.dts.config.mjs` configuration uses the basic DTS files to generate `*.d.ts` files for each bundle.
+
+### Development
+
+During development, the following steps are taken:
+
+- Run `build` to generate bundle and DTS files.
+  - If not, Rollup with `rollup.dts.config.mjs` in watch mode fails due to missing DTS files (race condition).
+- Concurrently run two Rollup processes **in watch mode**:
+  - Rollup with `rollup.config.mjs` configuration to generate bundle files and basic DTS files.
+  - Rollup with `rollup.dts.config.mjs` configuration to generate DTS files for each bundle.
+
+### Publish via GitHub
 
-To prevent Rollup from bundling the `@integration-app/sdk` package during local development, we specify it as an external dependency since Rollup does not match locally placed packages with the `/node_modules/` rule. 
+During publishing via GitHub, the following steps are taken:
 
-## DTS
+- Clean the `/dist` folder.
+- Install `@integration-app/sdk@latest` package
+- Rollup with `rollup.config.mjs` configuration generates bundle files and basic DTS files, which are placed in the `dist/dts` folder.
+- Rollup with `rollup.dts.config.mjs` configuration uses the basic DTS files to generate `*.d.ts` files for each bundle.
 
-DTS files are generated by `tsc` and placed in `dist/dts` folder.
-After that plugin `rollup-plugin-dts` is used to generate `*.d.ts` files for each bundle.
+The `build:publish` command is used in GitHub Actions to ensure that the package uses the latest `@integration-app/sdk` package.
 
 # Package.json exports
 
@@ -41,28 +81,3 @@ After that plugin `rollup-plugin-dts` is used to generate `*.d.ts` files for eac
 }
 ```
 
-# Local and publish build workflow
-
-For a local development, we use locally placed `@integration-app/sdk` package. 
-
-And for publishing, we use `@integration-app/sdk@latest` package.
-
-To make it work, we use `dev` and `build` commands.
-
-## `dev` workflow
-
-- Delete `dist` folders
-- Install local `@integration-app/sdk` pointed to `sdk` folder
-- Remove `react` and `react-dom` packages from `node_modules` folder
-    - We should do it to allow out package work in `console`, `engine` and other local projects
-- Run `rollup` in watch mode to build a package
-
-## `build` workflow
-
-- Delete `dist` folders
-- Install `@integration-app/sdk@latest` package
-- Run `rollup` to build a package
-
-Because GitHub Actions use `build` command, we could be sure that package uses the latest `@integration-app/sdk` package.
-
-