@producteca/producteca-ui-kit 1.12.0 → 1.13.0

package/README.md

@@ -29,43 +29,6 @@
 - `pre-commit`: Installs Husky and sets up Git hooks for pre-commit validation.
 - `build-storybook`: Builds the static Storybook project.
 
-### ✅ Commit Linting con Husky
-
-Este proyecto utiliza commitlint junto con husky para asegurar que todos los mensajes de commit sigan el [formato convencional](https://www.conventionalcommits.org/en/v1.0.0/).
-
-#### ¿Por qué?
-
-El formato convencional de commits permite:
-
-- Generar changelogs automáticamente.
-- Clasificar los cambios en versiones (patch, minor, major).
-- Tener un historial de commits más claro y estructurado.
-
-#### 🛠️ Instalación y configuración
-
-Ya está todo configurado en el proyecto. Si estás trabajando localmente, asegurate de ejecutar lo siguiente luego de clonar e instalar dependencias:
-
-```bash
-bun install
-npx husky install
-```
-
-Esto se asegura de que los hooks de Git estén correctamente instalados.
-
-#### ⚙️ Archivos relevantes
-
-- `.husky/commit-msg`: hook que ejecuta commitlint antes de hacer un commit.
-- `commitlint.config.js`: define las reglas que deben cumplir los mensajes de commit.
-- `.husky/pre-commit`: (opcional) puede correr linters u otros chequeos automáticos.
-
-📝 Ejemplo de mensaje de commit válido
-
-```sh
-feat: agrega componente de botón primario
-fix(ci): corrige configuración de release en rama test
-chore(deps): actualiza dependencias de desarrollo
-```
-
 ### Setting up `@producteca/producteca-ui-kit`
 
 Follow these steps to integrate and configure the `@producteca/producteca-ui-kit` package in your project:
@@ -118,9 +81,102 @@ Follow these steps to integrate and configure the `@producteca/producteca-ui-kit
      ```
    - For a complete example of how to implement these changes, refer to this pull request: [Shopify Babel Update Example](https://github.com/Parsimotion/shopify/pull/290)
 
-### Auto Publish
+## 📦 Publishing a New Version
+
+Package publishing is now handled automatically via a GitHub Action triggered on `push` to the `main` or `master` branches.
+
+You can also trigger it manually from the **Actions** tab using the `Release` workflow.
+
+The workflow supports prerelease versions (e.g., `alpha`, `beta`) through the `prereleaseTag` input.
+
+### 🚀 Manual Run (ONLY for prereleases)
+
+1. Go to [Actions](https://github.com/Parsimotion/courierteca/actions).
+2. Select the `Release` workflow.
+3. Click `Run workflow`.
+4. Enter the desired tag (e.g., `beta`) or leave as `alpha` (default).
+
+> 🔐 The release process uses the contents of the `lib/` directory generated during build.
+
+### ✅ Commit Linting with Husky
+
+This project uses Commitlint along with Husky to ensure that all commit messages follow the [Conventional Commit format](https://www.conventionalcommits.org/en/v1.0.0/).
+
+#### Why?
+
+The conventional commit format allows you to:
+
+- Automatically generate changelogs.
+- Classify changes into versions (patch, minor, major).
+- Maintain a clearer and more structured commit history.
+
+#### 🛠️ Installation and Setup
+
+Everything is already configured in the project. If you're working locally, make sure to run the following after cloning and installing dependencies:
+
+```bash
+npm install
+npx husky install
+```
+
+This ensures that Git hooks are properly installed.
+
+#### ⚙️ Relevant Files
+
+- `.husky/commit-msg`: hook that runs commitlint before making a commit.
+- `commitlint.config.js`: defines the rules that commit messages must follow.
+- `.husky/pre-commit`: (optional) can run linters or other automated checks.
+
+📝 Example of a valid commit message
+
+```sh
+feat: add primary button component
+fix(ci): fix release configuration on test branch
+chore(deps): update development dependencies
+```
+
+## 🧹 Branch Name Linter
+
+This project uses [`linterteca`](https://www.npmjs.com/package/linterteca) to enforce consistent branch naming conventions across all development work.
+
+The linter is automatically run as a `pre-push` Git hook using [Husky](https://typicode.github.io/husky/#/). To ensure the linter works properly:
+
+#### ✅ Setup Instructions
+
+1. Install all dependencies:
+
+```bash
+npm install
+```
+
+2. That's it! The linter will now run **automatically before each push** and will block invalid branch names.
+
+#### 📛 Branch name rules
+
+Allowed prefixes:
+
+- `feature/`
+- `fix/`
+- `hotfix/`
+- `release/`
+- `docs/`
+- `fix/`
+- `refactor/`
+- `chore/`
+- `ci/`
+- `test/`
+- `perf`
+- `style`
+- `build/`.
+
+If your branch name does not follow the required format, the push will be blocked with a helpful error message.
+
+#### 🛠️ Bypass (not recommended)
+
+To bypass the linter in exceptional cases:
+
+```bash
+git push --no-verify
+```
 
-- Use the following options for the branch name
-  ```bash
-      (major | minor | patch | premajor | preminor | prepatch | prerelease)/name
-  ```
+> Only use `--no-verify` if absolutely necessary and with team consensus.

package/dist/components/patterns/index.d.ts

@@ -1,3 +1,4 @@
 export * from './emptyState/emptyState';
 export * from './actionBar/actionBar';
 export * from './copyButton/copyButton';
+export * from './tooltip';

package/dist/components/patterns/tooltip/index.d.ts

@@ -0,0 +1,3 @@
+export { OverflowChecker } from './overflowChecker';
+export { WithTooltip, WithOverflowTooltip } from './tooltip';
+export type { WithTooltipProps, CombinedTooltipProps, TooltipPlacement, BaseTooltipProps } from './tooltip';

package/dist/components/patterns/tooltip/overflowChecker.d.ts

@@ -0,0 +1,5 @@
+import { default as React } from 'react';
+
+export declare const OverflowChecker: ({ children, }: {
+    children: (ref: React.RefObject<HTMLElement | HTMLDivElement | HTMLSpanElement | HTMLLabelElement>, showTooltip: boolean) => React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/patterns/tooltip/tooltip.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+
+export type TooltipPlacement = 'top' | 'bottom' | 'left' | 'right' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end' | 'right-start' | 'right-end';
+export interface BaseTooltipProps {
+    content?: string;
+    placement?: TooltipPlacement;
+    arrow?: boolean;
+    maxWidth?: number | string;
+}
+export interface WithTooltipProps extends BaseTooltipProps {
+    children: React.ReactElement;
+}
+export declare const WithTooltip: ({ children, content, placement, arrow, maxWidth, }: WithTooltipProps) => import("react/jsx-runtime").JSX.Element;
+export interface CombinedTooltipProps extends BaseTooltipProps {
+    children: React.ReactElement;
+}
+export declare const WithOverflowTooltip: ({ content, children, ...tooltipProps }: CombinedTooltipProps) => import("react/jsx-runtime").JSX.Element;

package/dist/locales/es.d.ts

@@ -25,6 +25,14 @@ declare const _default: {
         medium: string;
         small: string;
     };
+    tooltip: {
+        hoverToSee: string;
+        basicContent: string;
+        basicDescription: string;
+        overflowDescription: string;
+        componentDescription: string;
+        maxWidthDescription: string;
+    };
     description: {
         checkboxInputReduxFormExample: string;
         onChangeSelectField: string;