@viasoftbr/shared-ui 0.0.1

package/README.md

@@ -0,0 +1,150 @@
+# Shared UI
+
+Biblioteca de componentes, hooks e serviços compartilhados para plugins XCOS.
+
+## 📦 Instalação
+
+Este pacote está disponível localmente no monorepo:
+
+```bash
+# No diretório do seu plugin
+pnpm add @viasoftbr/shared-ui --workspace
+```
+
+Ou adicione diretamente no `package.json`:
+
+```json
+{
+  "dependencies": {
+    "@viasoftbr/shared-utils": "workspace:*"
+  }
+}
+```
+
+## 🚀 Uso
+
+### Importação Completa
+
+```typescript
+import {
+  // Components
+  InputField,
+  SelectField,
+  SwitchField,
+  Section,
+  Alert,
+  Button,
+  PageHeader,
+  ActionBar,
+  Loading,
+  
+  // Hooks
+  useSettings,
+  useExpandedSections,
+  useDebounce,
+  
+  # @viasoftbr/shared-ui
+
+  Biblioteca compartilhada de componentes React, hooks, utilitários e i18n usada por plugins e micro-frontends Viasoft.
+
+  Este repositório fornece um pacote ESM (TypeScript) empacotado em `dist/` e pensado para consumo por outros pacotes dentro do monorepo ou publicamente.
+
+  ## 📦 Instalação
+
+  Recomendado (monorepo pnpm):
+
+  ```bash
+  # do diretório do seu plugin ou pacote que consome esta lib
+  pnpm add @viasoftbr/shared-ui --workspace
+  ```
+
+  Ou, em um `package.json` local dentro do monorepo:
+
+  ```json
+  {
+    "dependencies": {
+      "@viasoftbr/shared-ui": "workspace:*"
+    }
+  }
+  ```
+
+  > Observação: o pacote é publicado como `@viasoftbr/shared-ui` (veja `package.json`).
+
+  ## 🚀 Uso
+
+  Importação direta de componentes / hooks / utilitários:
+
+  ```ts
+  import { InputField, SelectField, useSettings } from '@viasoftbr/shared-ui';
+  ```
+
+  Exportações adicionais (deep imports) estão disponíveis conforme declarado em `package.json`:
+
+  ```ts
+  import i18n from '@viasoftbr/shared-ui/i18n';
+  import jsmpegBundle from '@viasoftbr/shared-ui/jsmpeg';
+  import locale from '@viasoftbr/shared-ui/locales/pt/translation.json';
+  ```
+
+  Exemplos rápidos (React):
+
+  ```tsx
+  <InputField label="Nome" value={name} onChange={setName} />
+
+  <SelectField
+    label="Opção"
+    value={selected}
+    onChange={setSelected}
+    options={[{ value: 'a', label: 'A' }, { value: 'b', label: 'B' }]}
+  />
+  ```
+
+  Consulte os tipos emitidos (`dist/index.d.ts`) para a lista completa de símbolos exportados.
+
+  ## 🛠 Scripts de desenvolvimento
+
+  Scripts disponíveis (conforme `package.json`):
+
+  - `pnpm run build` — Empacota a lib em `dist/` (usa `scripts/build.js`).
+  - `pnpm run dev` — Mesma build em modo watch.
+  - `pnpm run typecheck` — Roda `tsc --noEmit` para validação de tipos.
+
+  Use `pnpm run dev` enquanto desenvolve para regenerar `dist/` automaticamente.
+
+  ## 💡 i18n e assets
+
+  O pacote expõe suporte a i18n e inclui traduções em `locales/`. Importe via `@viasoftbr/shared-ui/i18n` ou carregue arquivos de `@viasoftbr/shared-ui/locales/*` conforme necessário.
+
+  Há também um bundle mínimo do player `jsmpeg.vu.min.js` exportado em `@viasoftbr/shared-ui/jsmpeg`.
+
+  ## ⚠️ Peer dependencies
+
+  Este pacote declara `react` como peer dependency (`^19.0.0`). Garanta que o projeto que consome a lib tenha uma versão compatível do React instalada.
+
+  ## 📚 Desenvolvimento
+
+  1. Instale dependências: `pnpm install`
+  2. Rode o build em modo watch: `pnpm run dev`
+  3. Edite os arquivos em `src/` e verifique o output em `dist/`.
+  4. Para checar tipos: `pnpm run typecheck`.
+
+  O empacotador é implementado em `scripts/build.js` e usa `esbuild`.
+
+  ## Contribuição
+
+  - Abra issues para bugs ou melhorias.
+  - Para contribuições, faça um fork, crie uma branch e abra um pull request.
+  - Siga o estilo TypeScript/ESM do projeto e mantenha mudanças pequenas e focadas.
+
+  ## Licença
+
+  Este projeto é licenciado sob a licença MIT — veja o campo `license` em `package.json`.
+
+  ## Troubleshooting
+
+  - Erro de tipos ao consumir a lib: rode `pnpm run typecheck` no pacote consumidor e verifique versões de `@types/react` / `react`.
+  - Problemas com import/exports em bundlers: verifique se o bundler do consumidor suporta ESM ou use o campo `exports` do `package.json` adequadamente.
+
+  ---
+
+  Se quiser, adapto este README com exemplos reais retirados dos componentes presentes em `src/components/`.