@stackcraftmx/calcita 0.32.2 → 0.51.0

package/dist/types/forms/FormMaskedField.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {{name: string} & Omit<Parameters<typeof import('../inputs/MaskedInput.js').default>[0], 'name'|'value'|'onChange'|'onBlur'|'error'>} props
+ *     las de MaskedInput (mask, label, helperText, placeholder…)
+ */
+export default function FormMaskedField({ name, ...inputProps }: {
+    name: string;
+} & Omit<Parameters<typeof import('../inputs/MaskedInput.js').default>[0], 'name' | 'value' | 'onChange' | 'onBlur' | 'error'>): import("react").JSX.Element;

package/dist/types/forms/FormProblemAlert.d.ts

@@ -1,6 +1,7 @@
-/**
- * @param {{sx?: object}} props
- */
-export default function FormProblemAlert({ sx, ...unknownProps }: {
+declare const FormProblemAlert: (props: {
     sx?: object;
-}): import("react").JSX.Element | null;
+} & {
+    slots?: Record<string, import('react').ElementType>;
+    slotProps?: Record<string, object | ((partProps: object) => object)>;
+}) => import("react").JSX.Element | null;
+export default FormProblemAlert;

package/dist/types/forms/FormRepeatingFields.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @param {{
+ *   name: string,
+ *   emptyRow: object,
+ *   renderRow: (row: {index: number, row: any, nameOf: (field: string) => string}) => import('react').ReactNode,
+ *   removeBlockedReason?: (row: any, index: number) => string|null,
+ *   confirmRemove?: (row: any, index: number) => boolean,
+ *   onAdd?: (index: number) => void,
+ *   onRemove?: (row: any, index: number) => void,
+ * } & Omit<Parameters<typeof import('../inputs/RepeatingFields.js').default>[0], 'rowKeys'|'renderRow'|'onAdd'|'onRemove'|'onClear'|'removeBlockedReasonOf'|'confirmRemoveOf'|'rowHasErrorOf'|'error'>} props
+ *     name: la lista del formulario; emptyRow: cómo empieza un renglón nuevo; lo demás, lo de RepeatingFields
+ */
+export default function FormRepeatingFields({ name, emptyRow, renderRow, removeBlockedReason, confirmRemove, onAdd, onRemove, ...viewProps }: {
+    name: string;
+    emptyRow: object;
+    renderRow: (row: {
+        index: number;
+        row: any;
+        nameOf: (field: string) => string;
+    }) => import('react').ReactNode;
+    removeBlockedReason?: (row: any, index: number) => string | null;
+    confirmRemove?: (row: any, index: number) => boolean;
+    onAdd?: (index: number) => void;
+    onRemove?: (row: any, index: number) => void;
+} & Omit<Parameters<typeof import('../inputs/RepeatingFields.js').default>[0], 'rowKeys' | 'renderRow' | 'onAdd' | 'onRemove' | 'onClear' | 'removeBlockedReasonOf' | 'confirmRemoveOf' | 'rowHasErrorOf' | 'error'>): import("react").JSX.Element;

package/dist/types/forms/FormTransferListField.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {{name: string} & Omit<Parameters<typeof import('../inputs/TransferListInput.js').default>[0], 'name'|'value'|'onChange'|'onBlur'|'error'>} props las de
+ *     TransferListInput, sin value / onChange / onBlur / error
+ */
+export default function FormTransferListField({ name, ...inputProps }: {
+    name: string;
+} & Omit<Parameters<typeof import('../inputs/TransferListInput.js').default>[0], 'name' | 'value' | 'onChange' | 'onBlur' | 'error'>): import("react").JSX.Element;

package/dist/types/forms/SubmitButton.d.ts

@@ -1,9 +1,9 @@
-/**
- * @param {{children: import('react').ReactNode, disabled?: boolean, isPending?: boolean} & Omit<import('@mui/material/Button').ButtonProps, 'type'|'children'>} props
- *     lo demás va al Button de MUI (sx, size, fullWidth…)
- */
-export default function SubmitButton({ children, disabled, isPending, ...buttonProps }: {
+declare const SubmitButton: (props: {
     children: import('react').ReactNode;
     disabled?: boolean;
     isPending?: boolean;
-} & Omit<import('@mui/material/Button').ButtonProps, 'type' | 'children'>): import("react").JSX.Element;
+} & Omit<import("@mui/material/Button").ButtonProps<"button", {}>, "children" | "type"> & {
+    slots?: Record<string, import('react').ElementType>;
+    slotProps?: Record<string, object | ((partProps: object) => object)>;
+}) => import("react").JSX.Element;
+export default SubmitButton;

package/dist/types/forms/auth/SignInForm.d.ts

@@ -1,13 +1,4 @@
-/**
- * @param {object} props
- * @param {(values: {email: string, password: string, remember: boolean}) => Promise<unknown>} props.onSubmit entra; si
- *     el servidor dice que no, truena con su problema
- * @param {string} [props.forgotPasswordPath] sin ella no sale la liga de «¿Olvidó su contraseña?»
- * @param {boolean} [props.showRememberMe] por omisión sí
- * @param {string} [props.initialEmail]
- * @param {object} [props.texts] los textos que cambian, con la forma de `auth` en los textos del paquete
- */
-export default function SignInForm(props: {
+declare const SignInForm: (props: {
     onSubmit: (values: {
         email: string;
         password: string;
@@ -17,4 +8,8 @@ export default function SignInForm(props: {
     showRememberMe?: boolean;
     initialEmail?: string;
     texts?: object;
-}): import("react").JSX.Element;
+} & {
+    slots?: Record<string, import('react').ElementType>;
+    slotProps?: Record<string, object | ((partProps: object) => object)>;
+}) => import("react").JSX.Element;
+export default SignInForm;

package/dist/types/forms/fieldRules.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Igual a otro campo del mismo formulario (o del mismo renglón de una lista): la confirmación de una contraseña, de una CLABE
+ * o de un correo.
+ *
+ * @param {string} otherField el campo con el que se compara, en el mismo objeto ('password')
+ * @param {object} [options]
+ * @param {string} [options.otherLabel] cómo se llama ese campo en el mensaje («Debe ser igual a la contraseña»); sin él,
+ *     «No coincide»
+ * @returns {{name: string, message: {key: string, values: object, rule: string}, test: (value: unknown, context: {parent?: object}) => boolean}}
+ */
+export declare function sameAsFieldRule(otherField: string, { otherLabel }?: {
+    otherLabel?: string;
+}): {
+    name: string;
+    message: {
+        key: string;
+        values: object;
+        rule: string;
+    };
+    test: (value: unknown, context: {
+        parent?: object;
+    }) => boolean;
+};
+/**
+ * Un porcentaje: un número entre min y max (por omisión 0 y 100), con decimales. Acepta el texto que deja NumberInput
+ * ('12.5') o un número.
+ *
+ * @param {object} [options]
+ * @param {number} [options.min] por omisión 0
+ * @param {number} [options.max] por omisión 100
+ * @returns {{name: string, message: {key: string, values: object, rule: string}, test: (value: unknown) => boolean}}
+ */
+export declare function percentRule({ min, max }?: {
+    min?: number;
+    max?: number;
+}): {
+    name: string;
+    message: {
+        key: string;
+        values: object;
+        rule: string;
+    };
+    test: (value: unknown) => boolean;
+};

package/dist/types/forms/index.d.ts

@@ -1,7 +1,17 @@
+export { default as FormAttachmentsField } from './FormAttachmentsField.js';
 export { default as FormCatalogField } from './FormCatalogField.js';
+export { default as FormCheckboxGroupField } from './FormCheckboxGroupField.js';
 export { default as FormColorField } from './FormColorField.js';
+export { default as FormFileField } from './FormFileField.js';
+export { default as FormFileUploadField } from './FormFileUploadField.js';
+export { default as FormImageField } from './FormImageField.js';
+export { default as FormMaskedField } from './FormMaskedField.js';
 export { default as FormNumberField } from './FormNumberField.js';
 export { default as FormProblemAlert } from './FormProblemAlert.js';
+export { default as FormRepeatingFields } from './FormRepeatingFields.js';
+export { default as FormTransferListField } from './FormTransferListField.js';
+export { listTotalAtMostRule, listTotalOf, orderedInListRule, uniqueInListRule } from './listRules.js';
+export { percentRule, sameAsFieldRule } from './fieldRules.js';
 export { default as FormSelectField } from './FormSelectField.js';
 export { default as FormServerProblem } from './FormServerProblem.js';
 export { default as FormTextField } from './FormTextField.js';
@@ -14,6 +24,6 @@ export { default as TwoStepVerificationCard } from './security/TwoStepVerificati
 export { RECOVERY_CODE_PATTERN, TOTP_CODE_PATTERN, normalizeRecoveryCode, normalizeTotpCode, } from './security/securityRules.js';
 export { default as SubmitButton } from './SubmitButton.js';
 export { applyServerProblem } from './applyServerProblem.js';
-export { formLevelMessageOf, splitServerFieldErrors } from './serverProblemFields.js';
+export { formLevelMessageOf, splitRowFieldErrors, splitServerFieldErrors } from './serverProblemFields.js';
 export { useFormikField } from './useFormikField.js';
 export { Yup, buildYupLocale, translateValidationMessage } from './validation.js';

package/dist/types/forms/listRules.d.ts

@@ -0,0 +1,48 @@
+import { Money } from '../money/money.js';
+/**
+ * Sin repetidos en una columna: el renglón que repite dice con cuál choca.
+ *
+ * @param {string} listName la lista en el formulario ('tiers')
+ * @param {string} field la columna ('min_quantity')
+ * @returns {import('yup').TestConfig<any, any>} para .test() de yup
+ */
+export declare function uniqueInListRule(listName: string, field: string): import('yup').TestConfig<any, any>;
+/**
+ * En orden por una columna, comparado con el renglón de arriba y el de abajo que tengan valor.
+ *
+ * @param {string} listName
+ * @param {string} field
+ * @param {{ascending?: boolean, allowEqual?: boolean, displayOf?: (text: string) => string}} [options] ascending: de menor
+ *     a mayor (por omisión); displayOf: cómo se dice el valor del vecino en el mensaje (p. ej. con %)
+ * @returns {import('yup').TestConfig<any, any>} para .test() de yup
+ */
+export declare function orderedInListRule(listName: string, field: string, { ascending, allowEqual, displayOf }?: {
+    ascending?: boolean;
+    allowEqual?: boolean;
+    displayOf?: (text: string) => string;
+}): import('yup').TestConfig<any, any>;
+/**
+ * Lo que suma una columna, con Money (sin errores de decimales). Los vacíos cuentan como cero y los que no son número no
+ * cuentan (su propio campo ya lo dice).
+ *
+ * @param {object[]} rows
+ * @param {string} field
+ * @param {{currency?: string}} [options]
+ * @returns {Money}
+ */
+export declare function listTotalOf(rows: object[], field: string, { currency }?: {
+    currency?: string;
+}): Money;
+/**
+ * Lo que suman entre todos no pasa de un tope (el reparto de un presupuesto, de un límite de crédito). Va en la lista:
+ * Yup.array().test(listTotalAtMostRule(…)); el mensaje sale abajo de la lista.
+ *
+ * @param {string} field la columna que se suma
+ * @param {number|string|((parent: object) => number|string|null)} max el tope, o cómo sacarlo de los demás valores del
+ *     formulario (el límite que se escribió arriba)
+ * @param {{currency?: string}} [options]
+ * @returns {import('yup').TestConfig<any, any>} para .test() de yup
+ */
+export declare function listTotalAtMostRule(field: string, max: number | string | ((parent: object) => number | string | null), { currency }?: {
+    currency?: string;
+}): import('yup').TestConfig<any, any>;

package/dist/types/forms/security/SecondStepForm.d.ts

@@ -4,19 +4,7 @@ export declare const SECOND_STEP_METHOD: Readonly<{
     totp: "totp";
     recoveryCode: "recoveryCode";
 }>;
-/**
- * @param {object} props
- * @param {string[]} props.methods los que tiene la cuenta (SECOND_STEP_METHOD), como los mandó el servidor
- * @param {boolean} [props.canUsePasskeys] passkeysSupported() de /passkeys
- * @param {() => Promise<unknown>} [props.onUsePasskey] firma con la llave y termina de entrar; truena si no se pudo
- * @param {(input: {method: string, code: string}) => Promise<unknown>} props.onSubmitCode manda el código ya limpio y
- *     termina de entrar; truena con el ApiError si no
- * @param {(message: string|null) => void} props.onCancel regresa a escribir la contraseña (con el motivo, si lo hay)
- * @param {import('react').ReactNode} [props.footer] abajo del botón, dentro del formulario: puede llenar el código con
- *     useFormikContext (p. ej. el atajo de los ejemplos)
- * @param {object} [props.texts] los textos que cambian, con la forma de `security` en los textos del paquete
- */
-export default function SecondStepForm(props: {
+declare const SecondStepForm: (props: {
     methods: string[];
     canUsePasskeys?: boolean;
     onUsePasskey?: () => Promise<unknown>;
@@ -27,4 +15,8 @@ export default function SecondStepForm(props: {
     onCancel: (message: string | null) => void;
     footer?: import('react').ReactNode;
     texts?: object;
-}): import("react").JSX.Element;
+} & {
+    slots?: Record<string, import('react').ElementType>;
+    slotProps?: Record<string, object | ((partProps: object) => object)>;
+}) => import("react").JSX.Element;
+export default SecondStepForm;

package/dist/types/forms/security/TwoStepVerificationCard.d.ts

@@ -1,23 +1,4 @@
-/**
- * @param {object} props
- * @param {{isEnabled: boolean, enabledAt?: string|null, passkeys: Array<{id: string, name: string, createdAt: string, lastUsedAt?: string|null}>, totp: {isEnabled: boolean, enabledAt?: string|null}, recoveryCodesRemaining: number}} props.security
- * @param {(security: {isEnabled: boolean, enabledAt?: string|null, passkeys: Array<{id: string, name: string, createdAt: string, lastUsedAt?: string|null}>, totp: {isEnabled: boolean, enabledAt?: string|null}, recoveryCodesRemaining: number}) => void} props.onSecurityChange
- * @param {object} props.actions lo que hace el proyecto en cada caso; cada una regresa {security, recoveryCodes?}
- * @param {(name: string) => Promise<{security: object, recoveryCodes?: string[]}>} props.actions.addPasskey crea la llave
- *     (createPasskey) y la guarda en el servidor
- * @param {(passkey: {id: string, name: string}, password: string) => Promise<{security: object}>} props.actions.removePasskey
- * @param {() => Promise<{secret: string, qrImageUrl: string, extra?: import('react').ReactNode}>} props.actions.startTotp
- *     la clave y su QR; extra va abajo del campo (p. ej. un atajo de los ejemplos)
- * @param {(code: string) => Promise<{security: object, recoveryCodes?: string[]}>} props.actions.confirmTotp
- * @param {(password: string) => Promise<{security: object}>} props.actions.disableTotp
- * @param {(password: string) => Promise<{security: object, recoveryCodes: string[]}>} props.actions.regenerateRecoveryCodes
- * @param {boolean} [props.canUsePasskeys] passkeysSupported() de /passkeys; sin él no se ofrece agregar llaves
- * @param {string} [props.account] la cuenta (el correo), para el archivo de los códigos
- * @param {import('react').ReactNode} [props.passkeyNotice] un aviso en el diálogo de crear la llave, antes de que el
- *     navegador la guarde (p. ej. el de la demostración: la llave queda de verdad en el llavero de la persona)
- * @param {object} [props.texts] los textos que cambian, con la forma de `security` en los textos del paquete
- */
-export default function TwoStepVerificationCard(props: {
+declare const TwoStepVerificationCard: (props: {
     security: {
         isEnabled: boolean;
         enabledAt?: string | null;
@@ -80,4 +61,8 @@ export default function TwoStepVerificationCard(props: {
     account?: string;
     passkeyNotice?: import('react').ReactNode;
     texts?: object;
-}): import("react").JSX.Element;
+} & {
+    slots?: Record<string, import('react').ElementType>;
+    slotProps?: Record<string, object | ((partProps: object) => object)>;
+}) => import("react").JSX.Element;
+export default TwoStepVerificationCard;

package/dist/types/forms/serverProblemFields.d.ts

@@ -17,3 +17,16 @@ export declare function splitServerFieldErrors(errorsByField: Record<string, str
  * @returns {string|null}
  */
 export declare function formLevelMessageOf(errorsByField: Record<string, string[]>, formFieldNames: string[], generalMessage: string | null | undefined): string | null;
+/**
+ * Separa los errores de un 422 que son de un campo DENTRO de un renglón que el formulario sí tiene ('contacts.2.email'
+ * con contacts[2] en los valores): esos van a su renglón con la ruta completa. Los demás siguen el camino de siempre
+ * (fieldErrorsOf los reduce a su último nombre: 'rows.3.email' → 'email').
+ *
+ * @param {object|null|undefined} rawErrors problem.errors tal cual ({ruta: [mensajes]})
+ * @param {(path: string) => boolean} existsInForm si esa ruta existe en los valores del formulario
+ * @returns {{rowFieldErrors: Record<string, string>, otherErrors: Record<string, unknown>}}
+ */
+export declare function splitRowFieldErrors(rawErrors: object | null | undefined, existsInForm: (path: string) => boolean): {
+    rowFieldErrors: Record<string, string>;
+    otherErrors: Record<string, unknown>;
+};

package/dist/types/forms/useValidationText.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @param {object} [options]
+ * @param {string} [options.name] el name del campo: para su texto propio (validation:fields.<campo>.<regla>)
+ * @param {string} [options.label] el nombre del campo, para los textos que lo dicen ({{label}})
+ * @param {Record<string, string|object>} [options.messages] los textos de la pantalla para este campo, por regla
+ * @returns {(error: unknown) => string|undefined}
+ */
+export declare function useValidationText({ name, label, messages }?: {
+    name?: string;
+    label?: string;
+    messages?: Record<string, string | object>;
+}): (error: unknown) => string | undefined;