robobyte-front-builder 1.0.26 → 1.0.27

package/LICENSE

@@ -0,0 +1,65 @@
+MIT License
+
+Copyright (c) 2024-2026 RoboByte / Hossny37
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.
+
+---
+
+## Third-party components and commercial dependencies
+
+The MIT license above applies to the source code of `robobyte-front-builder`
+itself. This package depends on third-party libraries with their own licenses
+that consumers must comply with separately. The notable ones:
+
+### AG Grid Enterprise (peer dependency)
+
+This package's report and grid components rely on AG Grid Enterprise features
+(server-side row model, side tool panel, integrated charts, etc.) via the
+`ag-grid-enterprise` peer dependency. AG Grid Enterprise is a **commercial,
+proprietary product owned by AG Grid Ltd**. Consumers deploying this package
+in production must obtain a valid AG Grid Enterprise license from AG Grid
+Ltd and comply with their license terms:
+
+  https://www.ag-grid.com/license-pricing/
+
+AG Grid Community (the base library, MIT-licensed) is sufficient for
+development with a watermark; production use requires a paid license.
+
+### MUI X (peer dependency)
+
+`@mui/x-data-grid`, `@mui/x-date-pickers`, and related packages have free
+(MIT) and paid (Pro / Premium) tiers. This package uses only the free
+tiers by default. If a consumer opts to install Pro / Premium variants,
+they must comply with MUI's commercial license:
+
+  https://mui.com/pricing/
+
+### Other dependencies
+
+All other runtime and peer dependencies are open-source under permissive
+licenses (MIT, Apache 2.0, ISC, BSD). Run `npm ls --omit dev` to inspect
+the full graph and `npm-license-checker` (or similar) to enumerate licenses.
+
+---
+
+The license above does not waive or modify the terms of any third-party
+license referenced in this document. Consumers are responsible for
+obtaining and complying with licenses required by their use of those
+third-party components.

package/README.md

@@ -3,6 +3,27 @@
 A low-code **UI Builder**, **Report Builder**, **Print Layout Designer**, and **Navigation Extension API** for Next.js applications.
 
 [![npm version](https://img.shields.io/npm/v/robobyte-front-builder)](https://www.npmjs.com/package/robobyte-front-builder)
+[![license](https://img.shields.io/npm/l/robobyte-front-builder)](./LICENSE)
+[![github](https://img.shields.io/badge/github-Hossny37%2FRoboByteFrontBuilder-181717?logo=github)](https://github.com/Hossny37/RoboByteFrontBuilder)
+
+---
+
+## 📚 Documentation
+
+| Document | Audience | What it covers |
+|---|---|---|
+| **[README.md](./README.md)** *(this file)* | Everyone | Public surface, provider props, every component's inspector schema, action-scope tables, troubleshooting, changelog. The exhaustive reference. |
+| **[INTEGRATION.md](./INTEGRATION.md)** | Host-app developers | `next.config.js` setup, peer deps, page wrapper pattern, provider bridge, print layout integration steps. |
+| **[docs/ReportViewer.md](./docs/ReportViewer.md)** | Host-app developers | Embedding `<ReportViewer>` in regular React (cancellation, memo'd filters, `viewerActions`, master/detail patterns). |
+| **[docs/fetchReportData.md](./docs/fetchReportData.md)** | Host-app developers | Calling `fetchReportDataByPageId` directly from host code (hooks, KPI counters, XLSX export, paginated cursors). |
+| **[docs/printLayout.md](./docs/printLayout.md)** | Host-app developers | Triggering print layouts via `PrintDialog` ref API, recommended `PrintProvider` + `usePrintLayout()` pattern. |
+| **[training/00-index.md](./training/00-index.md)** | AI sessions / schema authors | Component catalog index — categories and one-page refs for every component the builder ships. |
+| **[training/35-reportViewer.md](./training/35-reportViewer.md)** | AI sessions / schema authors | Full AI manual for the `reportViewer` component (Calculation scope, action arrays, filter shape, recipes). |
+| **[training/48-fetchReportData.md](./training/48-fetchReportData.md)** | AI sessions / schema authors | In-builder Calculation reference for the auto-injected `fetchReportData` helper. |
+| **[training/49-printLayout.md](./training/49-printLayout.md)** | AI sessions / schema authors | In-builder Calculation reference for `openPrintLayout` / `closePrintLayout`. |
+| **[RoboByteBuilder_User_Manual.docx](./RoboByteBuilder_User_Manual.docx)** | End users | Visual user manual for the builder UI. Ships inside the package. |
+
+> **Pair convention.** Most features have **two** manuals: a `docs/` one for host-app React code (consumer of the package) and a `training/` one for AI sessions emitting builder schemas / Calculation code. They cross-link each other; pick the audience that matches your task.
 
 ---
 
@@ -996,4 +1017,40 @@ npm publish --dry-run
 
 ---
 
+## License & third-party components
+
+`robobyte-front-builder` itself is released under the **[MIT License](./LICENSE)** — the source code in this repository is free to use, modify, and distribute, including in commercial products.
+
+> **Important:** this package depends on third-party libraries with their own licenses. The MIT license applies only to *this* package's source code; it does not relicense or waive obligations under those third-party licenses.
+
+### AG Grid Enterprise — commercial license required for production
+
+The report and grid components use AG Grid Enterprise features (server-side row model, side tool panel, status bar, integrated charts, master/detail). The `ag-grid-enterprise` package is a **commercial product** owned by AG Grid Ltd:
+
+- **Development:** AG Grid Enterprise works without a license key, but renders a watermark and prints a console warning. Fine for local dev and evaluation.
+- **Production deployment:** requires a paid AG Grid Enterprise license. See [ag-grid.com/license-pricing](https://www.ag-grid.com/license-pricing/) for the current terms.
+
+Pass your license key via the provider — the package calls `LicenseManager.setLicenseKey()` and registers `AllEnterpriseModule` + `IntegratedChartsModule.with(AgChartsEnterpriseModule)` internally:
+
+```jsx
+<RoboByteFrontBuilderProvider
+  agGridLicenseKey={process.env.NEXT_PUBLIC_AG_GRID_LICENSE_KEY}
+  // …other props…
+>
+  …
+</RoboByteFrontBuilderProvider>
+```
+
+### MUI X — free vs. Pro / Premium tiers
+
+`@mui/x-data-grid`, `@mui/x-date-pickers`, and related packages have a free MIT tier and paid Pro / Premium tiers. This package uses only the free tier. If you swap in `@mui/x-data-grid-pro` or `@mui/x-date-pickers-pro` in your host app, comply with MUI's commercial license: [mui.com/pricing](https://mui.com/pricing/).
+
+### Everything else
+
+All other runtime and peer dependencies are open-source under permissive licenses (MIT, Apache 2.0, ISC, BSD). Run `npm ls --omit dev` for the full dependency graph and a tool like `license-checker` for a license enumeration.
+
+A condensed version of this notice lives in the [`LICENSE`](./LICENSE) file shipped with the package.
+
+---
+
 *Full user manual: [RoboByteBuilder_User_Manual.docx](./RoboByteBuilder_User_Manual.docx) (included in the package)*