@viasoftbr/shared-ui 0.0.2 → 0.0.4

package/README.md

@@ -2,149 +2,132 @@
 
 Biblioteca de componentes, hooks e serviços compartilhados para plugins XCOS.
 
+Este repositório empacota um conjunto de componentes React, hooks, serviços e recursos de i18n em `dist/` para consumo por outros pacotes (monorepo) ou via npm.
+
+**Versão do pacote:** `@viasoftbr/shared-ui` (veja `package.json` para a versão atual).
+
 ## 📦 Instalação
 
-Este pacote está disponível localmente no monorepo:
+Instalação via npm (registro público):
+
+```bash
+# npm
+npm install @viasoftbr/shared-ui
+
+# pnpm
+pnpm add @viasoftbr/shared-ui
+
+# yarn
+yarn add @viasoftbr/shared-ui
+```
+
+Instalação no monorepo (workspace pnpm):
 
 ```bash
-# No diretório do seu plugin
+# a partir do diretório do seu pacote consumidor
 pnpm add @viasoftbr/shared-ui --workspace
 ```
 
-Ou adicione diretamente no `package.json`:
+Instalação local (desenvolvimento):
+
+```bash
+# criar pacote .tgz e instalar no projeto consumidor
+npm run build
+npm pack
+# no projeto consumidor
+npm install ../path/to/viasoftbr-shared-ui-0.0.2.tgz
+
+# ou usar link para desenvolvimento iterativo
+# no shared-ui
+npm run build
+npm link
+# no projeto consumidor
+npm link @viasoftbr/shared-ui
+```
+
+Instalação direta do GitHub (não recomendado sem `dist/` commitado):
 
 ```json
 {
   "dependencies": {
-    "@viasoftbr/shared-utils": "workspace:*"
+    "@viasoftbr/shared-ui": "git+https://github.com/viasoftbr/shared-ui.git"
   }
 }
 ```
 
-## 🚀 Uso
+> Observação: se instalar diretamente do Git, prefira ter a pasta `dist/` com os artefatos comitados OU adicionar um script `prepare` que execute o build na instalação.
 
-### 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';
-  ```
+## 🚀 Uso
 
-  Exemplos rápidos (React):
+Importação principal:
 
-  ```tsx
-  <InputField label="Nome" value={name} onChange={setName} />
+```ts
+import { InputField, SelectField, useSettings } from '@viasoftbr/shared-ui';
+```
 
-  <SelectField
-    label="Opção"
-    value={selected}
-    onChange={setSelected}
-    options={[{ value: 'a', label: 'A' }, { value: 'b', label: 'B' }]}
-  />
-  ```
+Deep imports (subpaths) disponíveis conforme `exports` no `package.json`:
 
-  Consulte os tipos emitidos (`dist/index.d.ts`) para a lista completa de símbolos exportados.
+```ts
+import i18n from '@viasoftbr/shared-ui/i18n';
+import jsmpegBundle from '@viasoftbr/shared-ui/jsmpeg';
+import localePt from '@viasoftbr/shared-ui/locales/pt/translation.json';
+```
 
-  ## 🛠 Scripts de desenvolvimento
+Exemplo (React):
 
-  Scripts disponíveis (conforme `package.json`):
+```tsx
+import React from 'react';
+import { InputField } from '@viasoftbr/shared-ui';
 
-  - `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.
+export function Example() {
+  const [value, setValue] = React.useState('');
+  return <InputField label="Nome" value={value} onChange={setValue} />;
+}
+```
 
-  Use `pnpm run dev` enquanto desenvolve para regenerar `dist/` automaticamente.
+## 📦 Publicação no npm
 
-  ## 💡 i18n e assets
+Passos básicos para publicar (usuário com permissão no escopo `@viasoftbr`):
 
-  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.
+```bash
+# instalar dependências
+pnpm install
 
-  Há também um bundle mínimo do player `jsmpeg.vu.min.js` exportado em `@viasoftbr/shared-ui/jsmpeg`.
+# gerar build e declarações
+pnpm run build
 
-  ## ⚠️ Peer dependencies
+# atualizar versão (opcional)
+npm version patch
 
-  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.
+# publicar
+npm publish --access public
+```
 
-  ## 📚 Desenvolvimento
+Recomendações:
+- Garanta que `dist/` e os `.d.ts` foram gerados antes de publicar.
+- Atualize a versão no `package.json` antes do `npm publish`.
 
-  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`.
+## ⚠️ Peer dependencies
 
-  O empacotador é implementado em `scripts/build.js` e usa `esbuild`.
+Este pacote declara `react` como peer dependency (`^19.0.0`). O projeto consumidor deve fornecer uma versão compatível do React.
 
-  ## Contribuição
+## 🛠 Scripts de desenvolvimento
 
-  - 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.
+- `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.
 
-  ## Licença
+## 💡 i18n e assets
 
-  Este projeto é licenciado sob a licença MIT — veja o campo `license` em `package.json`.
+O pacote inclui traduções em `locales/` e expõe um helper `i18n` em `@viasoftbr/shared-ui/i18n`. O bundle do player `jsmpeg.vu.min.js` é exposto em `@viasoftbr/shared-ui/jsmpeg`.
 
-  ## Troubleshooting
+## Desenvolvimento
 
-  - 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.
+1. Instale dependências: `pnpm install`
+2. Rode o build em modo watch: `pnpm run dev`
+3. Edite arquivos em `src/` e verifique o output em `dist/`.
+4. Para checar tipos: `pnpm run typecheck`.
 
-  ---
+---
 
-  Se quiser, adapto este README com exemplos reais retirados dos componentes presentes em `src/components/`.
+Se quiser, adapto este README com exemplos reais retirados dos componentes presentes em `src/components/` ou adiciono um `prepare` script para facilitar instalação direta do Git.

package/dist/components/main/Header.d.ts

@@ -2,6 +2,7 @@ import React from "react";
 interface HeaderProps {
     isSidebarOpen: boolean;
     setSidebarOpen: (state: boolean) => void;
+    onNavigate?: (path: string) => void;
 }
 declare const Header: React.FC<HeaderProps>;
 export default Header;