@joelbarron/react-web-dev-kit 0.1.7 → 0.1.9

package/README.md

@@ -1,24 +1,23 @@
 # @joelbarron/react-web-dev-kit
 
-Core reusable para apps web React.
+[![npm version](https://img.shields.io/npm/v/%40joelbarron%2Freact-web-dev-kit?label=npm&color=cb3837)](https://www.npmjs.com/package/@joelbarron/react-web-dev-kit)
+[![npm downloads](https://img.shields.io/npm/dm/%40joelbarron%2Freact-web-dev-kit?label=downloads)](https://www.npmjs.com/package/@joelbarron/react-web-dev-kit)
+[![CI](https://img.shields.io/github/actions/workflow/status/joelbarron/jb-react-web-dev-kit/ci.yml?branch=main&label=CI)](https://github.com/joelbarron/jb-react-web-dev-kit/actions/workflows/ci.yml)
+[![Release](https://img.shields.io/github/actions/workflow/status/joelbarron/jb-react-web-dev-kit/release.yml?branch=main&label=release)](https://github.com/joelbarron/jb-react-web-dev-kit/actions/workflows/release.yml)
 
-Incluye:
-- `auth` (`createAuthClient` para `jb-drf-auth`)
-- `config` (`createJBWebConfig`, overrides por stage/env)
-- `forms` (`JBTextField`, `JBSelectField`, `JBCheckboxField`, `JBSwitchField`, `JBRadioGroupField`, `JBDatePickerField`, `JBTimePickerField`)
-- `grid` (`JBGrid`, `JBGridHeader`, providers)
-- `hooks` y `utils`
+Libreria reusable para apps web React con piezas listas para autenticacion, formularios, grillas, config por ambiente y utilidades comunes.
 
-## Documentacion por secciones
+## Que incluye
 
-- [Indice docs](./docs/README.md)
-- [Auth](./docs/auth.md)
-- [Config](./docs/config.md)
-- [Forms](./docs/forms.md)
-- [Grid](./docs/grid.md)
-- [Query](./docs/query.md)
-- [Hooks](./docs/hooks.md)
-- [Utils](./docs/utils.md)
+| Modulo | Que aporta | Docs |
+| --- | --- | --- |
+| `auth` | Cliente para `jb-drf-auth`, provider, hooks y rutas de auth | [docs/auth.md](./docs/auth.md) |
+| `config` | Config global por stage y helpers de URL/API | [docs/config.md](./docs/config.md) |
+| `forms` | Campos base sobre React Hook Form + MUI | [docs/forms.md](./docs/forms.md) |
+| `grid` | `JBGrid`, header y providers para tablas | [docs/grid.md](./docs/grid.md) |
+| `query` | QueryClient preconfigurado para React Query | [docs/query.md](./docs/query.md) |
+| `hooks` | Hooks compartidos para casos de app | [docs/hooks.md](./docs/hooks.md) |
+| `utils` | Helpers generales reutilizables | [docs/utils.md](./docs/utils.md) |
 
 ## Instalacion
 
@@ -26,37 +25,35 @@ Incluye:
 npm i @joelbarron/react-web-dev-kit
 ```
 
-## Auth
+Peer deps principales (segun `package.json`):
+- `react >= 19`
+- `react-dom >= 19`
+- `@tanstack/react-query >= 5`
+- `react-hook-form >= 7`
+- `@mui/material >= 5`
+
+## Inicio rapido
+
+### Auth client
 
 ```ts
-import { createAuthClient } from '@joelbarron/react-web-dev-kit';
+import { createAuthClient } from '@joelbarron/react-web-dev-kit/auth';
 
 export const authClient = createAuthClient({
   apiBaseUrl: import.meta.env.VITE_API_URL,
   onUnauthorized: () => {
-    // ejemplo: limpiar estado y redirigir
+    window.location.href = '/sign-in';
   }
 });
-
-await authClient.loginBasic({
-  login: 'demo@mail.com',
-  password: 'secret',
-  client: 'web'
-});
-
-const me = await authClient.getMe();
 ```
 
-### Auth Provider + Hook
+### Auth Provider
 
 ```tsx
-import { JBAuthProvider, useJBAuth, createAuthClient } from '@joelbarron/react-web-dev-kit/auth';
-
-const authClient = createAuthClient({
-  apiBaseUrl: import.meta.env.VITE_API_URL
-});
+import { JBAuthProvider } from '@joelbarron/react-web-dev-kit/auth';
+import { authClient } from './authClient';
 
-function Root() {
+export function Root() {
   return (
     <JBAuthProvider authClient={authClient}>
       <App />
@@ -65,63 +62,19 @@ function Root() {
 }
 ```
 
-### Auth Routes Factory
-
-```tsx
-import { createAuthRoutes } from '@joelbarron/react-web-dev-kit/auth';
-
-const authRoutes = createAuthRoutes({
-  pages: {
-    signIn: SignInPage,
-    signUp: SignUpPage,
-    forgotPassword: ForgotPasswordPage,
-    resetPassword: ResetPasswordPage,
-    signOut: SignOutPage
-  },
-  pageComponent: ({ children }) => <AuthLayout>{children}</AuthLayout>,
-  routeMeta: {
-    signIn: { auth: ['guest'] },
-    signUp: { auth: ['guest'] }
-  }
-});
-```
-
-### Auth Query Hooks (TanStack Query)
-
-```ts
-import { createAuthClient, createAuthQueryHooks } from '@joelbarron/react-web-dev-kit/auth';
-
-const authClient = createAuthClient({
-  apiBaseUrl: import.meta.env.VITE_API_URL
-});
-
-export const authQueryHooks = createAuthQueryHooks(authClient);
-```
-
-## Query Client
+### Query client
 
 ```ts
 import { createReactWebQueryClient } from '@joelbarron/react-web-dev-kit/query';
 
-const queryClient = createReactWebQueryClient({
+export const queryClient = createReactWebQueryClient({
   onUnauthorized: () => {
     window.location.href = '/sign-in';
   }
 });
 ```
 
-### Auth Forms Base
-
-Tambien incluye formularios base para auth:
-- `AuthPasswordSignInForm`
-- `AuthForgotPasswordForm`
-- `AuthResetPasswordForm`
-
-```tsx
-import { AuthPasswordSignInForm } from '@joelbarron/react-web-dev-kit/auth';
-```
-
-## Config Global (overrideable)
+### Config por ambiente
 
 ```ts
 import { createJBWebConfigFromEnv, getApiBaseUrl } from '@joelbarron/react-web-dev-kit/config';
@@ -142,95 +95,47 @@ const appConfig = createJBWebConfigFromEnv(
   import.meta.env as Record<string, string | undefined>
 );
 
-const apiBaseUrl = getApiBaseUrl(appConfig);
+export const apiBaseUrl = getApiBaseUrl(appConfig);
 ```
 
-## Forms (React Hook Form + MUI)
+### Forms y Grid
 
 ```tsx
-import { Controller, useForm } from 'react-hook-form';
-import { JBDatePickerField, JBSelectField, JBTextField } from '@joelbarron/react-web-dev-kit';
+import { JBTextField, JBSelectField, JBDatePickerField, JBGrid, JBGridHeader } from '@joelbarron/react-web-dev-kit';
+```
 
-type FormValues = {
-  name: string;
-  status: string;
-  birthday: Date | null;
-};
+Tambien incluye formularios listos de auth:
+- `AuthPasswordSignInForm`
+- `AuthForgotPasswordForm`
+- `AuthResetPasswordForm`
 
-const options = [
-  { label: 'Active', value: 'ACTIVE' },
-  { label: 'Inactive', value: 'INACTIVE' }
-];
+## Versionado y release
 
-function ExampleForm() {
-  const { control } = useForm<FormValues>({
-    defaultValues: { name: '', status: '', birthday: null }
-  });
+Canales publicados en npm:
+- `latest`: versiones estables desde `main`
+- `next`: prereleases (`-rc.x`) desde `next`
 
-  return (
-    <>
-      <JBTextField
-        control={control}
-        name="name"
-        label="Name"
-        fullWidth
-      />
-      <JBSelectField
-        control={control}
-        name="status"
-        label="Status"
-        options={options}
-        fullWidth
-      />
-      <JBDatePickerField
-        control={control}
-        name="birthday"
-        label="Birthday"
-      />
-    </>
-  );
-}
+Consulta rapida de version y dist-tags:
+
+```bash
+npm view @joelbarron/react-web-dev-kit version dist-tags --json
 ```
 
-## Grid
+Guia completa de release automation:
+- [docs/release.md](./docs/release.md)
 
-```tsx
-import { JBGrid, JBGridHeader, JBGridConfig } from '@joelbarron/react-web-dev-kit';
-import { useState } from 'react';
-
-const gridConfig: JBGridConfig = {
-  columns: [
-    { name: 'id', title: 'ID' },
-    { name: 'name', title: 'Name' }
-  ],
-  columnsWidths: [
-    { columnName: 'id', width: 120 },
-    { columnName: 'name', width: 320 }
-  ],
-  defaults: {
-    pageSize: 10,
-    allowSelection: true
-  }
-};
+## Documentacion
 
-function ExampleGrid({ service }: { service: { list: Function } }) {
-  const [searchText, setSearchText] = useState('');
+- [Indice docs](./docs/README.md)
+- [Auth](./docs/auth.md)
+- [Config](./docs/config.md)
+- [Forms](./docs/forms.md)
+- [Grid](./docs/grid.md)
+- [Query](./docs/query.md)
+- [Hooks](./docs/hooks.md)
+- [Utils](./docs/utils.md)
+- [Release](./docs/release.md)
 
-  return (
-    <>
-      <JBGridHeader
-        title="Users"
-        searchText={searchText}
-        onSearchTextChange={setSearchText}
-      />
-      <JBGrid
-        gridConfig={gridConfig}
-        service={service as any}
-        searchText={searchText}
-        onSearchTextChange={setSearchText}
-        onRowSelected={(row) => console.log(row)}
-      />
-    </>
-  );
-}
-```
+## Changelog
+
+- [CHANGELOG.md](./CHANGELOG.md)

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@joelbarron/react-web-dev-kit",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "private": false,
   "sideEffects": false,
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joelbarron/jb-react-web-dev-kit.git"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -63,8 +67,11 @@
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "check:release": "npm run typecheck && npm run clean && npm run build",
     "changeset": "changeset",
+    "release:stable": "bash ./scripts/release-stable.sh",
+    "release:rc": "bash ./scripts/release-rc.sh",
     "release:version": "changeset version",
-    "release:publish": "changeset publish"
+    "release:publish": "changeset publish",
+    "release:publish:next": "changeset publish --tag next"
   },
   "peerDependencies": {
     "react": ">=19",

package/dist/auth/client.d.ts

@@ -1,45 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { JBAppConfig } from '../config';
-import { AccountUpdatePayload, AccountConfirmationPayload, AccountConfirmationResendPayload, ApiDetailResponse, CreateAdminUserPayload, CreateProfilePayload, CreateAuthenticatedAxiosOptions, DeleteAccountPayload, JbDrfAuthConfig, JbDrfAuthEndpoints, JbDrfWebAuthResponse, LinkSocialPayload, LoginBasicPayload, LoginSocialPrecheckResponse, LoginSocialPayload, PasswordChangePayload, PasswordResetConfirmPayload, PasswordResetRequestPayload, ProfilePicturePayload, ProfilesResponse, RegisterPayload, RefreshPayload, RequestOtpPayload, SwitchProfilePayload, TokenPair, TokenStorage, UnlinkSocialPayload, UpdateProfilePayload, VerifyOtpPayload } from './types';
-export declare const createAuthEndpoints: (basePath?: string) => JbDrfAuthEndpoints;
-export declare const defaultAuthEndpoints: JbDrfAuthEndpoints;
-export type AuthClient = {
-    endpoints: JbDrfAuthEndpoints;
-    tokenStorage: TokenStorage;
-    getAccessToken: () => string | null;
-    setAccessToken: (token: string) => void;
-    clearSession: () => void;
-    createPublicAxios: () => AxiosInstance;
-    createAuthenticatedAxios: (options?: CreateAuthenticatedAxiosOptions) => AxiosInstance;
-    createAuthenticatedAxiosWithRefresh: (options?: CreateAuthenticatedAxiosOptions) => AxiosInstance;
-    loginBasic: (payload: LoginBasicPayload) => Promise<JbDrfWebAuthResponse>;
-    loginSocial: (payload: LoginSocialPayload) => Promise<JbDrfWebAuthResponse>;
-    loginSocialPrecheck: (payload: LoginSocialPayload) => Promise<LoginSocialPrecheckResponse>;
-    linkSocial: (payload: LinkSocialPayload) => Promise<Record<string, unknown>>;
-    unlinkSocial: (payload: UnlinkSocialPayload) => Promise<Record<string, unknown>>;
-    requestOtp: (payload: RequestOtpPayload) => Promise<Record<string, unknown>>;
-    verifyOtp: (payload: VerifyOtpPayload) => Promise<JbDrfWebAuthResponse>;
-    register: (payload: RegisterPayload) => Promise<ApiDetailResponse>;
-    confirmAccountEmail: (payload: AccountConfirmationPayload) => Promise<ApiDetailResponse>;
-    resendAccountConfirmation: (payload: AccountConfirmationResendPayload) => Promise<ApiDetailResponse>;
-    getMe: () => Promise<JbDrfWebAuthResponse>;
-    updateProfilePicture: (payload: ProfilePicturePayload) => Promise<Record<string, unknown>>;
-    updateAccount: (payload: AccountUpdatePayload, method?: 'PATCH' | 'PUT') => Promise<Record<string, unknown>>;
-    deleteAccount: (payload: DeleteAccountPayload) => Promise<unknown>;
-    getProfiles: () => Promise<ProfilesResponse>;
-    getProfileById: (profileId: number | string) => Promise<Record<string, unknown>>;
-    createProfile: (payload: CreateProfilePayload) => Promise<Record<string, unknown>>;
-    updateProfile: (profileId: number | string, payload: UpdateProfilePayload) => Promise<Record<string, unknown>>;
-    deleteProfile: (profileId: number | string) => Promise<Record<string, unknown>>;
-    requestPasswordReset: (payload: PasswordResetRequestPayload) => Promise<Record<string, unknown>>;
-    confirmPasswordReset: (payload: PasswordResetConfirmPayload) => Promise<Record<string, unknown>>;
-    changePassword: (payload: PasswordChangePayload) => Promise<Record<string, unknown>>;
-    refreshToken: (payload?: RefreshPayload) => Promise<TokenPair>;
-    switchProfile: (payload: SwitchProfilePayload) => Promise<JbDrfWebAuthResponse>;
-    createSuperuser: (payload: CreateAdminUserPayload, bootstrapToken?: string) => Promise<Record<string, unknown>>;
-    createStaffUser: (payload: CreateAdminUserPayload, bootstrapToken?: string) => Promise<Record<string, unknown>>;
-    logout: () => void;
-};
-export declare const createAuthClient: (config: JbDrfAuthConfig) => AuthClient;
-export declare const createAuthClientFromJBWebConfig: (appConfig: JBAppConfig, overrides?: Omit<JbDrfAuthConfig, "apiBaseUrl" | "apiBasePath">) => AuthClient;
-//# sourceMappingURL=client.d.ts.map

package/dist/auth/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/auth/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAkC,MAAM,WAAW,CAAC;AAExE,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,gCAAgC,EAChC,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,+BAA+B,EAC/B,oBAAoB,EACpB,eAAe,EACf,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,2BAA2B,EAC3B,kBAAkB,EAClB,qBAAqB,EACrB,2BAA2B,EAC3B,2BAA2B,EAC3B,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,SAAS,CAAC;AAWjB,eAAO,MAAM,mBAAmB,GAAI,WAAW,MAAM,KAAG,kBA0BvD,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,kBAA2D,CAAC;AAE/F,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACpC,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,iBAAiB,EAAE,MAAM,aAAa,CAAC;IACvC,wBAAwB,EAAE,CAAC,OAAO,CAAC,EAAE,+BAA+B,KAAK,aAAa,CAAC;IACvF,mCAAmC,EAAE,CAAC,OAAO,CAAC,EAAE,+BAA+B,KAAK,aAAa,CAAC;IAClG,UAAU,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC1E,WAAW,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC5E,mBAAmB,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC3F,UAAU,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7E,YAAY,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjF,UAAU,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7E,SAAS,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACxE,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACnE,mBAAmB,EAAE,CAAC,OAAO,EAAE,0BAA0B,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACzF,yBAAyB,EAAE,CAAC,OAAO,EAAE,gCAAgC,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrG,KAAK,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC3C,oBAAoB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3F,aAAa,EAAE,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,KAAK,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7G,aAAa,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACnE,WAAW,EAAE,MAAM,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7C,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjF,aAAa,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnF,aAAa,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/G,aAAa,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAChF,oBAAoB,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjG,oBAAoB,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjG,cAAc,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACrF,YAAY,EAAE,CAAC,OAAO,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/D,aAAa,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAChF,eAAe,EAAE,CAAC,OAAO,EAAE,sBAAsB,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAChH,eAAe,EAAE,CAAC,OAAO,EAAE,sBAAsB,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAChH,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB,CAAC;AAmCF,eAAO,MAAM,gBAAgB,GAAI,QAAQ,eAAe,KAAG,UA2c1D,CAAC;AAEF,eAAO,MAAM,+BAA+B,GAC1C,WAAW,WAAW,EACtB,YAAY,IAAI,CAAC,eAAe,EAAE,YAAY,GAAG,aAAa,CAAC,KAC9D,UAMF,CAAC"}