freemium-ui 2.0.133 → 2.0.134

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freemium-ui",
-  "version": "2.0.133",
+  "version": "2.0.134",
   "description": "React Ui Components for Freemium Apps",
   "main": "./index.js",
   "module": "./index.js",

package/mkdocs.yml

@@ -0,0 +1,38 @@
+site_name: 'Freemium UI'
+site_description: 'Functionality and Architecture Documentation for Freemium UI'
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - Architecture:
+      - Code Structure: architecture/code-structure.md
+      - Deep Dive: architecture/deep-dive.md
+  - Operations:
+      - Monitoring:
+          - Overview: operations/monitoring.md
+          - Alerts configuration: operations/alerts-configuration.md
+          - SOP: operations/sop.md
+      - Support:
+          - Overview: operations/support.md
+          - How to Debug: operations/how-to-debug.md
+          - Recent Issues: operations/recent-issues.md
+  - ADRs:
+      - Overview: adrs/index.md
+
+plugins:
+  - techdocs-core
+  - mermaid2
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - toc:
+      permalink: true
+
+extra:
+  version: v1alpha1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freemium-ui",
-  "version": "2.0.133",
+  "version": "2.0.134",
   "description": "React Ui Components for Freemium Apps",
   "main": "lib/index.cjs.js",
   "module": "lib/index.js",
@@ -95,7 +95,9 @@
     "post:build": "node ./scripts/frankBuild.js",
     "rollup": "rm -rf lib && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
     "test": "react-scripts test",
+    "test:coverage": "react-scripts test --watchAll=false --coverage --passWithNoTests",
     "eject": "react-scripts eject",
+    "lint:ci": "eslint . --quiet",
     "check": "prettier --check .",
     "format": "prettier --write .",
     "storybook": "storybook dev -p 6006",

package/sonar-project.properties

@@ -0,0 +1,25 @@
+# SonarQube analysis configuration — https://quality.freshworks.com
+# Project created as part of the FSURVEY-8734 spike. Ask the SonarQube admin to
+# shorten the GUID suffix once other repos' keys have already been cleaned up;
+# update this line if they do.
+sonar.projectKey=freshdesk_freemium-ui_e70667c0-5938-4123-aea0-50f8bb049286
+
+sonar.sources=src
+sonar.sourceEncoding=UTF-8
+
+# Test files are declared as tests rather than excluded, so they are not counted
+# as production code but still contribute coverage attribution.
+sonar.tests=src
+sonar.test.inclusions=**/*.test.ts,**/*.test.tsx
+
+# Do NOT add **/*.ts or **/*.tsx here — that excludes the entire codebase and
+# produces a silent "no lines of code" analysis.
+# lib/ is this library's rollup build output, not source.
+sonar.exclusions=**/node_modules/**,**/lib/**,**/coverage/**,**/*.css,**/*.scss,**/*.stories.tsx,**/.storybook/**,**/storybook-static/**
+sonar.coverage.exclusions=**/*.test.ts,**/*.test.tsx,scripts/**,**/*.stories.tsx
+
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.typescript.file.suffixes=.ts,.tsx
+
+# Styling is handled by prettier; skip CSS analysis to cut noise.
+sonar.css.file.suffixes=-

package/tech-docs/docs/architecture/components.md

@@ -0,0 +1,49 @@
+# Component Catalog
+
+Exported from `src/components/index.ts` (see Storybook for live examples).
+
+## Form & Input
+
+| Component                         | Purpose                           |
+| --------------------------------- | --------------------------------- |
+| `Input`                           | Text input with validation states |
+| `Checkbox`, `Radio`, `BoxedRadio` | Selection controls                |
+| `Toggle`                          | On/off switch                     |
+| `Dropdown`, `MultiSelectDropdown` | Single/multi select               |
+| `AutoComplete`                    | Search with optional remote `url` |
+| `Pickers.*`                       | Date, date range, date-time, time |
+
+## Actions & Navigation
+
+| Component                   | Purpose             |
+| --------------------------- | ------------------- |
+| `Button`, `ButtonDropdown`  | Primary actions     |
+| `Menu`, `Tabs`, `Accordion` | Navigation patterns |
+
+## Feedback & Overlay
+
+| Component                         | Purpose         |
+| --------------------------------- | --------------- |
+| `Alert`, `Toast`                  | Notifications   |
+| `Modal`, `Drawer`, `Confirmation` | Dialogs         |
+| `Popover`, `Tooltip`              | Contextual help |
+| `Loader`                          | Loading states  |
+
+## Data Display
+
+| Component                  | Purpose       |
+| -------------------------- | ------------- |
+| `Table`, `WorkspaceTable`  | Data grids    |
+| `Typography`               | Text styles   |
+| `Tag`, `Icons`, `Calendar` | Supporting UI |
+
+## Layout
+
+| Component       | Purpose                        |
+| --------------- | ------------------------------ |
+| `ThemeProvider` | Theme context                  |
+| `Reorder`       | Drag-and-drop lists (@dnd-kit) |
+
+## Internal (not in barrel)
+
+`QuillEditor` exists under `components/` but is not re-exported from `src/index.ts`.

package/tech-docs/docs/architecture/index.md

@@ -0,0 +1,54 @@
+# Architecture Overview
+
+Single-package npm library — no Module Federation, no runtime server.
+
+## Source Layout
+
+```text
+src/
+├── components/     # ~31 UI components (Button, Table, Modal, …)
+├── themes/         # light, dark, DewTheme, palette tokens
+├── styles/         # globalStyles, shared styled primitives
+├── types/          # FreshworksPalette, context types
+├── utils/          # request helper, portal, SSR helpers
+├── hooks/          # usePortalContainer, Shadow DOM scroll fix
+├── stories/        # Storybook stories + MDX (Colors, Typography)
+└── index.ts        # Public exports
+```
+
+## Build Pipeline
+
+```text
+src/index.ts
+    → Rollup (typescript plugin, peer-deps external)
+    → lib/index.js (ESM), lib/index.cjs.js (CJS), lib/index.d.ts
+    → scripts/frankBuild.js (package.json for lib/, README copy)
+```
+
+Only `react` and `react-dom` are external; Radix, styled-components, axios, etc. are bundled.
+
+## Theming
+
+- **ThemeProvider** wraps styled-components theme context
+- Supports **classic** and **dew** design variants
+- `@freshworks/dew-styles` for Dew 2.0 fonts/CSS
+- **StyleSheetManager** exported for shadow DOM / iframe embedding
+
+## Design Stack
+
+| Layer      | Technology                                              |
+| ---------- | ------------------------------------------------------- |
+| Primitives | Radix UI (accordion, dialog, select, toast, …)          |
+| Styling    | styled-components 6                                     |
+| Tables     | @tanstack/react-table                                   |
+| DnD        | @dnd-kit (Reorder component)                            |
+| Rich text  | react-quill (QuillEditor — not in public barrel export) |
+| Dates      | @blueprintjs/datetime2, moment                          |
+
+## Boundaries
+
+| In scope                          | Out of scope              |
+| --------------------------------- | ------------------------- |
+| Admin UI widgets                  | Survey question rendering |
+| Optional axios `request()` helper | SurveyServ JWT / claims   |
+| Storybook design docs             | Public respondent pages   |

package/tech-docs/docs/development/build-publish.md

@@ -0,0 +1,42 @@
+# Build & Publish
+
+## Build Library
+
+```bash
+npm run build
+# rollup → lib/ + frankBuild post-step
+```
+
+Outputs:
+
+| File               | Format                  |
+| ------------------ | ----------------------- |
+| `lib/index.js`     | ESM (`module` field)    |
+| `lib/index.cjs.js` | CommonJS (`main` field) |
+| `lib/index.d.ts`   | TypeScript declarations |
+
+## Pre-publish
+
+`prepublishOnly` runs `npm run build` automatically.
+
+## Beta Releases
+
+```bash
+npm run version:beta
+npm run publish:beta
+```
+
+## Quality Scripts
+
+| Script                     | Purpose                |
+| -------------------------- | ---------------------- |
+| `npm run lint` / `lint:ci` | ESLint                 |
+| `npm run check` / `format` | Prettier               |
+| `npm run typescript`       | `tsc` typecheck        |
+| `npm test`                 | Jest via react-scripts |
+
+## Registry
+
+Published to **npm** (`registry.npmjs.org`) as `freemium-ui`.
+
+Consumers pin major/minor versions in host app `package.json` — coordinate upgrades with `survey-admin-microfrontend` and `freshsurvey-web-admin-app`.

package/tech-docs/docs/development/storybook.md

@@ -0,0 +1,37 @@
+# Storybook
+
+Component documentation and visual testing UI.
+
+## Run
+
+```bash
+npm run storybook
+# http://localhost:6006
+```
+
+## Configuration
+
+| File                     | Role                                    |
+| ------------------------ | --------------------------------------- |
+| `.storybook/main.ts`     | Webpack 5 + CRA preset, story globs     |
+| `.storybook/preview.tsx` | Global ThemeProvider decorator, toolbar |
+
+## Story Locations
+
+- `src/**/*.stories.@(js|jsx|mjs|ts|tsx)` — per-component stories
+- `src/**/*.mdx` — Colors, Palette, Typography docs
+
+## Toolbar Controls
+
+- Theme variant: classic / dew
+- Color mode: light / dark
+- Direction: LTR / RTL
+- Locale selector
+
+## Build Static Site
+
+```bash
+npm run build-storybook
+```
+
+Output suitable for hosting as design-system reference (not deployed by this repo by default).

package/tech-docs/docs/getting-started.md

@@ -0,0 +1,67 @@
+# Getting Started
+
+## Install
+
+```bash
+npm install freemium-ui@2.0.133
+```
+
+Runtime requirements: the host app must provide `react@^17` and
+`react-dom@^17` — Rollup marks both as external, so they resolve from the host.
+`styled-components@^6` is bundled. All three are declared as regular
+`dependencies` in `package.json`, not `peerDependencies`.
+
+## Wrap App with Theme
+
+```tsx
+import { FreemiumUIGlobalStyles, ThemeProvider, Themes } from 'freemium-ui';
+
+function App() {
+  return (
+    <ThemeProvider theme={Themes.light}>
+      <FreemiumUIGlobalStyles />
+      {/* your routes */}
+    </ThemeProvider>
+  );
+}
+```
+
+Theme toolbar options in Storybook: **classic/dew**, **light/dark**, **LTR/RTL**.
+
+## Use a Component
+
+```tsx
+import { Button, Input, Modal } from 'freemium-ui';
+
+<Button variant="primary" onClick={handleSave}>
+  Save
+</Button>;
+```
+
+## Local Development
+
+```bash
+git clone git@github.com:freshdesk/freemium-ui.git
+cd freemium-ui
+npm install
+npm run storybook    # http://localhost:6006
+npm run build        # outputs lib/
+```
+
+## Build CRA Demo (optional)
+
+```bash
+npm start              # react-scripts dev app
+npm run build-react-app
+```
+
+## Consumers
+
+| App                          | npm range  | Usage                                      |
+| ---------------------------- | ---------- | ------------------------------------------ |
+| `freshsurvey-web-admin-app`  | `^1.0.335` | Admin shell, settings, tables              |
+| `survey-admin-microfrontend` | `^1.0.219` | Builder chrome alongside survey components |
+
+## No SurveyServ API
+
+`freemium-ui` has no baked-in SurveyServ endpoints. `AutoComplete` accepts an optional `url` prop — the **host app** supplies the API URL.

package/tech-docs/docs/index.md

@@ -0,0 +1,47 @@
+# Freemium UI — Technical Documentation
+
+**Freemium UI** is a shared **React 17 + TypeScript** component library for SurveyServ and Freemium admin experiences. It provides form controls, tables, modals, pickers, and theming — published to npm as `freemium-ui`.
+
+| Attribute | Value                                                             |
+| --------- | ----------------------------------------------------------------- |
+| GitHub    | [freshdesk/freemium-ui](https://github.com/freshdesk/freemium-ui) |
+| npm       | `freemium-ui@2.0.133`                                             |
+| Build     | Rollup → `lib/index.js` (ESM), `lib/index.cjs.js` (CJS)           |
+| Styling   | styled-components 6 + Radix UI primitives                         |
+| Storybook | Port 6006 — component catalog and theme playground                |
+
+## Role in SurveyServ
+
+```text
+freemium-ui (this repo)
+    ↑ consumed by
+survey-admin-microfrontend, freshsurvey-web-admin-app
+    ↑ admin chrome only — NOT survey question rendering
+freemium-survey-components (sibling npm package)
+```
+
+This library does **not** render survey questions or call SurveyServ APIs. Survey collection UI lives in **freemium-survey-components**.
+
+## Key Exports
+
+- `ThemeProvider`, `FreemiumUIGlobalStyles`, `Themes`
+- Form: `Input`, `Checkbox`, `Radio`, `Dropdown`, `AutoComplete`, `Toggle`
+- Actions: `Button`, `ButtonDropdown`, `Menu`, `Tabs`
+- Overlay: `Modal`, `Drawer`, `Toast`, `Popover`, `Tooltip`
+- Data: `Table`, `WorkspaceTable`, `Typography`, `Calendar`, date/time pickers
+
+## Documentation Map
+
+| Section                                         | Contents                                  |
+| ----------------------------------------------- | ----------------------------------------- |
+| [Getting Started](getting-started.md)           | Install, ThemeProvider, first component   |
+| [Architecture](architecture/index.md)           | Package layout, themes, styled-components |
+| [Components](architecture/components.md)        | Component categories                      |
+| [Storybook](development/storybook.md)           | Local docs UI                             |
+| [Build & Publish](development/build-publish.md) | Rollup, npm release                       |
+
+## Ownership
+
+- **Team:** `platforms/plat-maise-surveyserv`
+- **System:** `platforms/surveyserv`
+- **Backstage:** `component:platforms/freemium-ui`

package/tech-docs/docs/repositories/index.md

@@ -0,0 +1,22 @@
+# Repository Context
+
+## This Repo
+
+| Attribute | Value                                                             |
+| --------- | ----------------------------------------------------------------- |
+| GitHub    | [freshdesk/freemium-ui](https://github.com/freshdesk/freemium-ui) |
+| Type      | npm UI library                                                    |
+| System    | `platforms/surveyserv`                                            |
+
+## Related Frontend Repos
+
+| Repo                                                                                  | Relationship                                              |
+| ------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| [freemium-survey-components](https://github.com/freshdesk/freemium-survey-components) | Survey **rendering** (sibling, no npm dep on freemium-ui) |
+| [survey-admin-microfrontend](https://github.com/freshdesk/survey-admin-microfrontend) | **Consumer** — admin MFE                                  |
+| [freshsurvey-web-admin-app](https://github.com/freshdesk/freshsurvey-web-admin-app)   | **Consumer** — standalone admin                           |
+| [surveyserv](https://github.com/freshdesk/surveyserv)                                 | Backend APIs (not called from this library)               |
+
+## Ownership
+
+Team: `platforms/plat-maise-surveyserv`

package/tech-docs/mkdocs.yml

@@ -0,0 +1,28 @@
+site_name: 'Freemium UI'
+site_description: 'Shared React UI component library for SurveyServ and Freemium admin frontends'
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - Repositories: repositories/index.md
+  - Architecture:
+      - Overview: architecture/index.md
+      - Components: architecture/components.md
+  - Development:
+      - Storybook: development/storybook.md
+      - Build & Publish: development/build-publish.md
+
+plugins:
+  - techdocs-core
+
+markdown_extensions:
+  - admonition
+  - toc:
+      permalink: true
+  - tables
+  - fenced_code
+
+extra:
+  version: 2.0.133
+  team: platforms/plat-maise-surveyserv
+  system: platforms/surveyserv