@producteca/producteca-ui-kit 0.0.13 → 1.1.0

package/README.md

@@ -14,10 +14,55 @@
 
 ## Main Scripts
 
-- `dev`: Bootstrap the Storybook preview with Hot Reload.
-- `build`: Builds the static storybook project.
-- `build:lib`: Builds the component library into the **dist** folder.
-- `lint:fix`: Applies linting based on the rules defined in **.eslintrc.js**.
-- `format:prettier`: Formats files using the prettier rules defined in **.prettierrc**.
-- `test`: Runs testing using watch mode.
-- `test:cov`: Runs testing displaying a coverage report.
+- `dev`: Starts Storybook in development mode on port 6006.
+- `build`: Builds the static Storybook project.
+- `build:lib`: Removes the `dist` folder, compiles TypeScript, and builds the library using Vite.
+- `deploy`: Deploys the project using the specified Makefile configuration.
+- `lint`: Runs ESLint to lint and fix issues in files with `.js`, `.jsx`, `.ts`, and `.tsx` extensions.
+- `prettier`: Formats files in the `src` folder with extensions `.ts`, `.tsx`, `.js`, and `.mdx` using Prettier.
+- `test`: Runs tests using Vitest.
+- `test:cov`: Executes tests and generates a coverage report using Vitest.
+- `prepare`: Prepares the repository by installing Husky for Git hooks.
+- `pre-commit`: Installs Husky and sets up Git hooks for pre-commit validation.
+- `build-storybook`: Builds the static Storybook project.
+
+### Setting up `@producteca/producteca-ui-kit`
+
+Follow these steps to integrate and configure the `@producteca/producteca-ui-kit` package in your project:
+
+1. **Install the package**  
+   Make sure to install the latest version of the package:
+
+   ```bash
+   bun install @producteca/producteca-ui-kit
+
+   ```
+
+2. **Import the styles**  
+   Add the following line to your `app/css/setup.js` file:
+
+   ```bash
+   import "@producteca/producteca-ui-kit/dist/style.css";
+
+   ```
+
+3. **Remove old SelectField instances**
+
+- Check for any existing version of `selectField`. If found, delete the file:
+
+  ```bash
+  app/components/form/selectField
+
+  ```
+
+- Update any old imports to:
+  ```bash
+  import { SelectField } from "@producteca/producteca-ui-kit";
+  ```
+
+### Auto Publish
+
+- Use the following options for the branch name
+  ```bash
+      (major | minor | patch | premajor | preminor | prepatch | prerelease)/name
+  ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@producteca/producteca-ui-kit",
-  "version": "0.0.13",
+  "version": "1.1.0",
   "main": "./dist/producteca-ui-kit.umd.js",
   "types": "./dist/index.d.ts",
   "repository": {
@@ -19,13 +19,17 @@
   "scripts": {
     "dev": "storybook dev -p 6006",
     "build": "storybook build",
-    "build:lib": "tsc && vite build",
+    "build:lib": "rm -rf dist && tsc && vite build",
+    "version": "git add package.json",
+    "postversion": "npm publish",
+    "deploy": "make deploy",
     "lint": "eslint --ext .js,.jsx,.ts,.tsx --fix",
     "prettier": "prettier --write \"src/**/*.{ts,tsx,js,mdx}\"",
     "test": "vitest",
     "test:cov": "vitest run --coverage",
     "prepare": "husky",
-    "chromatic": "npx chromatic --project-token=chpt_296f9471a29e98c"
+    "pre-commit": "husky && husky install",
+    "build-storybook": "storybook build"
   },
   "files": [
     "dist"
@@ -58,30 +62,33 @@
     "@vitejs/plugin-react-refresh": "^1.3.6",
     "@vitejs/plugin-react-swc": "^3.5.0",
     "@vitest/coverage-v8": "^1.6.0",
+    "jsdom": "^24.1.0",
+    "json": "11.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-select": "^5.8.3",
+    "sass": "^1.77.4",
+    "typescript": "^5.2.2",
+    "vite": "^5.2.0",
+    "vite-plugin-css-modules": "^0.0.1",
+    "vite-plugin-dts": "^3.9.1",
+    "vitest": "^1.6.0"
+  },
+  "devDependencies": {
     "autoprefixer": "^10.4.19",
     "chromatic": "^11.3.0",
+    "clsx": "^2.1.1",
     "eslint": "^8.57.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.6",
     "eslint-plugin-storybook": "^0.8.0",
     "husky": "^9.0.11",
     "i18next": "^23.11.5",
-    "jsdom": "^24.1.0",
-    "json": "11.0.0",
-    "postcss-modules": "^6.0.0",
     "prettier": "3.0.1",
     "prop-types": "15.8.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
     "react-i18next": "^14.1.2",
-    "sass": "^1.77.4",
     "storybook": "^8.0.9",
     "storybook-i18n": "^3.0.1",
-    "storybook-react-i18next": "^3.1.1",
-    "typescript": "^5.2.2",
-    "vite": "^5.2.0",
-    "vite-plugin-css-modules": "^0.0.1",
-    "vite-plugin-dts": "^3.9.1",
-    "vitest": "^1.6.0"
+    "storybook-react-i18next": "^3.1.1"
   }
 }

package/dist/components/button/button.d.ts

@@ -1,11 +0,0 @@
-interface ButtonProps {
-    label: string;
-    variant?: 'primary' | 'secondary' | 'success' | 'error';
-    outline?: boolean;
-    size?: 'sm' | 'lg';
-    type?: 'submit' | 'button' | 'reset';
-    onClick?: () => void;
-}
-export declare const Button: ({ type, variant, size, label, outline, ...props }: ButtonProps) => import("react/jsx-runtime").JSX.Element;
-export type { ButtonProps };
-export default Button;

package/dist/components/emptyState/emptyState.d.ts

@@ -1,11 +0,0 @@
-import { default as React } from 'react';
-
-interface EmptyStateProps {
-    onActionClick?: () => void;
-    actionTex?: string;
-    text?: string;
-    icon?: React.ReactNode;
-}
-export declare const EmptyState: ({ onActionClick, icon, actionTex, text, }: EmptyStateProps) => import("react/jsx-runtime").JSX.Element;
-export type { EmptyStateProps };
-export default EmptyState;

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

@@ -1 +0,0 @@
-export { SearchPublication } from './searchPublication/searchPublication';

package/dist/components/icons/searchPublication/searchPublication.d.ts

@@ -1,8 +0,0 @@
-
-interface SearchPublicationProps {
-    size?: number;
-    color?: string | undefined;
-}
-export declare const SearchPublication: ({ size, color }: SearchPublicationProps) => import("react/jsx-runtime").JSX.Element;
-export type { SearchPublicationProps };
-export default SearchPublication;

package/dist/components/index.d.ts

@@ -1,4 +0,0 @@
-export * from './button/button';
-export * from './emptyState/emptyState';
-export * from './icons';
-export * from './spinner/spinner';

package/dist/components/spinner/spinner.d.ts

@@ -1,6 +0,0 @@
-interface SpinnerProps {
-    size?: number;
-}
-export declare const Spinner: ({ size }: SpinnerProps) => import("react/jsx-runtime").JSX.Element;
-export type { SpinnerProps };
-export default Spinner;

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-
-export * from './components';

package/dist/locales/es.d.ts

@@ -1,5 +0,0 @@
-declare const _default: {
-    noResultsFound: string;
-    reloadPage: string;
-};
-export default _default;

package/dist/locales/index.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import('i18next').TFunction<["translation", ...string[]], undefined>;
-export default _default;

package/dist/locales/translator.d.ts

@@ -1,3 +0,0 @@
-import { default as i18next } from 'i18next';
-
-export default i18next;