techsbcn-storybook 2.0.2 → 2.0.3

package/README.md

@@ -1,140 +1,140 @@
-# techsbcn-storybook
-
-A React component library built by [TechsBCN](https://techsbcn.com) on top of Material UI. It provides a set of ready-to-use components — form fields, tables, layouts, navigation, modals and wrappers — designed to be consumed across internal projects with a consistent look and feel.
-
-Components are developed and documented in [Storybook](https://storybook.js.org/) and shipped as an npm package.
-
-## Requirements
-
-- **Node.js** `>= 18`
-- **React** `>= 18` (declared as a peer dependency)
-- **Yarn** (the repository is pinned to Yarn 4 via `packageManager`)
-
-## Installation
-
-```bash
-yarn add techsbcn-storybook
-```
-
-or
-
-```bash
-npm install techsbcn-storybook
-```
-
-Because MUI, Emotion, React Hook Form, Yup, i18next, dayjs and Font Awesome are runtime dependencies of this library, they are installed automatically.
-
-## Usage
-
-Import components directly from the package root:
-
-```tsx
-import { TextFieldComponent, ButtonComponent, TableComponent } from 'techsbcn-storybook';
-
-export const Example = () => (
-  <>
-    <TextFieldComponent name="email" label="Email" />
-    <ButtonComponent onClick={() => console.log('clicked')}>Send</ButtonComponent>
-  </>
-);
-```
-
-### Available component groups
-
-| Group | Components |
-| --- | --- |
-| **Fields** | `ButtonComponent`, `TextFieldComponent`, `TextSimpleComponent`, `SelectField`, `SelectAsyncField`, `DatePickerComponent` |
-| **Forms** | `LoginForm`, `ChangePasswordForm`, `ResetPasswordForm` |
-| **Tables** | `TableComponent`, `SimpleTableComponent`, `SearchComponent` |
-| **Layouts** | `MainLayoutSimple`, `AppHeader`, `AppSidebar`, `DrawerSidebar` |
-| **Navigation** | `VerticalNav`, `UserInfo` |
-| **Modals** | `ModalComponent` |
-| **Wrappers** | `MainWrapperComponent`, `PublicFormWrapper`, `TabsComponent`, `LinearProgressComponent`, `CardComponent` |
-
-See the Storybook documentation for the full API of each component.
-
-## Development
-
-### Getting started
-
-```bash
-yarn install
-yarn storybook
-```
-
-Storybook runs on [http://localhost:6006](http://localhost:6006) and hot-reloads on changes inside `src/`.
-
-### Project structure
-
-```txt
-src/
-  components/       # Library source — grouped by category
-    fields/
-    forms/
-    layouts/
-    modals/
-    navigation/
-    tables/
-    wrappers/
-  content/          # Static assets (images, icons) used by stories
-  data/             # Mock data and enums used only by stories
-  helpers/          # Shared utilities and hooks
-  interfaces/       # Shared TypeScript interfaces
-  stories/          # Storybook stories
-  i18n.tsx          # Storybook-only i18n bootstrap
-  index.tsx         # Public entry point (barrel of every exported component)
-.storybook/         # Storybook configuration
-tsup.config.ts      # Build configuration (JS bundles)
-tsconfig.build.json # Build configuration (type declarations)
-```
-
-Only files under `src/components/` are shipped in the published package. Stories, mock data and the Storybook i18n bootstrap are excluded from the build.
-
-### Scripts
-
-| Script | Description |
-| --- | --- |
-| `yarn start` | Runs `tsup` in watch mode (rebuilds `dist/` on every change) |
-| `yarn build` | Produces the distributable output in `dist/`: CJS + ESM bundles, sourcemaps and type declarations |
-| `yarn storybook` | Starts Storybook in development mode |
-| `yarn build-storybook` | Builds the static Storybook site |
-| `yarn lint` | Runs ESLint with autofix over the codebase |
-| `yarn test` | Runs the Jest test suite |
-| `yarn size` | Reports the bundle size using [size-limit](https://github.com/ai/size-limit) |
-| `yarn analyze` | Opens the size-limit visual report |
-
-## Build pipeline
-
-The library is built in three steps, wired together in the `build` script:
-
-1. **`tsup`** bundles `src/index.tsx` into CommonJS (`dist/index.js`) and ES Modules (`dist/index.mjs`) using esbuild, with SCSS compiled through `esbuild-sass-plugin` and static assets (SVG/PNG) emitted as separate files.
-2. **`tsc -p tsconfig.build.json`** emits `.d.ts` declarations for the public API, excluding stories, tests, mock data and the Storybook i18n bootstrap.
-3. **`node strip-asset-imports-dts.mjs`** post-processes the emitted declarations to remove side-effect imports of `.scss`, `.css`, `.svg` and `.png` files, so consumers do not need loaders for those assets.
-
-## Tech stack
-
-- **UI**: React 19, Material UI 9, Emotion, Font Awesome 7
-- **Forms & validation**: React Hook Form 7, Yup 1, `@hookform/resolvers`
-- **Dates**: `@mui/x-date-pickers`, `dayjs`
-- **i18n**: `i18next`, `react-i18next`, `i18next-browser-languagedetector`
-- **Routing (form components)**: `react-router` 8
-- **Language & tooling**: TypeScript 6, ESLint 9 (flat config), Prettier 3, Jest 30, Storybook 10, tsup 8
-
-## Publishing
-
-The package is published to npm with only the `dist/` folder included (whitelisted through the `files` field in `package.json`). Before publishing, you can preview the tarball contents with:
-
-```bash
-npm pack --dry-run
-```
-
-To publish a new version:
-
-```bash
-yarn build
-yarn npm publish
-```
-
-## License
-
-[MIT](./LICENSE) © TechsBCN
+# techsbcn-storybook
+
+A React component library built by [TechsBCN](https://techsbcn.com) on top of Material UI. It provides a set of ready-to-use components — form fields, tables, layouts, navigation, modals and wrappers — designed to be consumed across internal projects with a consistent look and feel.
+
+Components are developed and documented in [Storybook](https://storybook.js.org/) and shipped as an npm package.
+
+## Requirements
+
+- **Node.js** `>= 18`
+- **React** `>= 18` (declared as a peer dependency)
+- **Yarn** (the repository is pinned to Yarn 4 via `packageManager`)
+
+## Installation
+
+```bash
+yarn add techsbcn-storybook
+```
+
+or
+
+```bash
+npm install techsbcn-storybook
+```
+
+Because MUI, Emotion, React Hook Form, Yup, i18next, dayjs and Font Awesome are runtime dependencies of this library, they are installed automatically.
+
+## Usage
+
+Import components directly from the package root:
+
+```tsx
+import { TextFieldComponent, ButtonComponent, TableComponent } from 'techsbcn-storybook';
+
+export const Example = () => (
+  <>
+    <TextFieldComponent name="email" label="Email" />
+    <ButtonComponent onClick={() => console.log('clicked')}>Send</ButtonComponent>
+  </>
+);
+```
+
+### Available component groups
+
+| Group | Components |
+| --- | --- |
+| **Fields** | `ButtonComponent`, `TextFieldComponent`, `TextSimpleComponent`, `SelectField`, `SelectAsyncField`, `DatePickerComponent` |
+| **Forms** | `LoginForm`, `ChangePasswordForm`, `ResetPasswordForm` |
+| **Tables** | `TableComponent`, `SimpleTableComponent`, `SearchComponent` |
+| **Layouts** | `MainLayoutSimple`, `AppHeader`, `AppSidebar`, `DrawerSidebar` |
+| **Navigation** | `VerticalNav`, `UserInfo` |
+| **Modals** | `ModalComponent` |
+| **Wrappers** | `MainWrapperComponent`, `PublicFormWrapper`, `TabsComponent`, `LinearProgressComponent`, `CardComponent` |
+
+See the Storybook documentation for the full API of each component.
+
+## Development
+
+### Getting started
+
+```bash
+yarn install
+yarn storybook
+```
+
+Storybook runs on [http://localhost:6006](http://localhost:6006) and hot-reloads on changes inside `src/`.
+
+### Project structure
+
+```txt
+src/
+  components/       # Library source — grouped by category
+    fields/
+    forms/
+    layouts/
+    modals/
+    navigation/
+    tables/
+    wrappers/
+  content/          # Static assets (images, icons) used by stories
+  data/             # Mock data and enums used only by stories
+  helpers/          # Shared utilities and hooks
+  interfaces/       # Shared TypeScript interfaces
+  stories/          # Storybook stories
+  i18n.tsx          # Storybook-only i18n bootstrap
+  index.tsx         # Public entry point (barrel of every exported component)
+.storybook/         # Storybook configuration
+tsup.config.ts      # Build configuration (JS bundles)
+tsconfig.build.json # Build configuration (type declarations)
+```
+
+Only files under `src/components/` are shipped in the published package. Stories, mock data and the Storybook i18n bootstrap are excluded from the build.
+
+### Scripts
+
+| Script | Description |
+| --- | --- |
+| `yarn start` | Runs `tsup` in watch mode (rebuilds `dist/` on every change) |
+| `yarn build` | Produces the distributable output in `dist/`: CJS + ESM bundles, sourcemaps and type declarations |
+| `yarn storybook` | Starts Storybook in development mode |
+| `yarn build-storybook` | Builds the static Storybook site |
+| `yarn lint` | Runs ESLint with autofix over the codebase |
+| `yarn test` | Runs the Jest test suite |
+| `yarn size` | Reports the bundle size using [size-limit](https://github.com/ai/size-limit) |
+| `yarn analyze` | Opens the size-limit visual report |
+
+## Build pipeline
+
+The library is built in three steps, wired together in the `build` script:
+
+1. **`tsup`** bundles `src/index.tsx` into CommonJS (`dist/index.js`) and ES Modules (`dist/index.mjs`) using esbuild, with SCSS compiled through `esbuild-sass-plugin` and static assets (SVG/PNG) emitted as separate files.
+2. **`tsc -p tsconfig.build.json`** emits `.d.ts` declarations for the public API, excluding stories, tests, mock data and the Storybook i18n bootstrap.
+3. **`node strip-asset-imports-dts.mjs`** post-processes the emitted declarations to remove side-effect imports of `.scss`, `.css`, `.svg` and `.png` files, so consumers do not need loaders for those assets.
+
+## Tech stack
+
+- **UI**: React 19, Material UI 9, Emotion, Font Awesome 7
+- **Forms & validation**: React Hook Form 7, Yup 1, `@hookform/resolvers`
+- **Dates**: `@mui/x-date-pickers`, `dayjs`
+- **i18n**: `i18next`, `react-i18next`, `i18next-browser-languagedetector`
+- **Routing (form components)**: `react-router` 8
+- **Language & tooling**: TypeScript 6, ESLint 9 (flat config), Prettier 3, Jest 30, Storybook 10, tsup 8
+
+## Publishing
+
+The package is published to npm with only the `dist/` folder included (whitelisted through the `files` field in `package.json`). Before publishing, you can preview the tarball contents with:
+
+```bash
+npm pack --dry-run
+```
+
+To publish a new version:
+
+```bash
+yarn build
+yarn npm publish
+```
+
+## License
+
+[MIT](./LICENSE) © TechsBCN

package/dist/helpers/AuthHelper.d.ts

@@ -0,0 +1,7 @@
+export interface Session {
+    nameidentifier: string;
+    role: string[];
+}
+export declare const GetSession: () => Session | null;
+export declare const SaveSession: (jwt: string) => void;
+export declare const ClearSession: () => void;

package/dist/helpers/index.d.ts

@@ -1,3 +1,4 @@
+export * from './AuthHelper';
 export * from './CheckPermission';
 export * from './GroupBy';
 export * from './FileDownloader';