@vtex/faststore 0.0.3 → 0.0.5

package/dist/matter/my-account-profile/my-account-profile.d.ts

@@ -0,0 +1,291 @@
+import { ComponentDefinition } from "../../core/dist/define-component.js";
+import "../../core/dist/index.js";
+import { ComponentActions } from "../../sdk/actions/types.js";
+import { PhoneCountry } from "../../particles/phone-field/phone-field.js";
+import { ComponentPropsWithRef, ReactNode } from "react";
+//#region src/matter/my-account-profile/my-account-profile.d.ts
+/**
+ * The `$data` slice forwarded by the reactive runtime — the `customerProfile` entity itself, not the
+ * `Query` shape the fragment above is authored against. The compiler derives an entity fragment `on
+ * CustomerProfile` from the root-field selection for the reactive path (rfc-data-layer.md §"Entity
+ * fragments and schema introspection"), and `ReactiveDataProvider` publishes that entity data
+ * directly — the same convention `SessionRoot` reads `$data.loggedIn` under, not `$data.session`.
+ */
+export type MyAccountProfileData = {
+  id?: string | null;
+  firstName?: string | null;
+  lastName?: string | null;
+  email?: string | null;
+  homePhone?: string | null;
+  mobilePhone?: string | null;
+  document?: string | null;
+  documentType?: string | null;
+  birthDate?: string | null;
+  gender?: string | null;
+} | null;
+/**
+ * The shopper-editable keys. `email` is absent (login identifier) and `documentType` is absent
+ * (read for the tax-ID control's active type; not writable in V0).
+ */
+export type MyAccountProfileFieldKey = 'firstName' | 'lastName' | 'homePhone' | 'mobilePhone' | 'document' | 'birthDate' | 'gender';
+export type MyAccountProfileMode = 'view' | 'edit';
+/** Every editable key, always a string — a `null` upstream value is seeded as `''`. */
+export type MyAccountProfileValues = Readonly<Record<MyAccountProfileFieldKey, string>>;
+/**
+ * What a Control hands the Root. `validate` returns a message when the value is unacceptable and
+ * `null` when it is fine — requiredness is expressed as a validator that rejects `''`. `normalize`
+ * is applied on Save, to dirty values only.
+ */
+export type MyAccountProfileFieldRegistration = Readonly<{
+  key: MyAccountProfileFieldKey;
+  validate?: (value: string) => string | null;
+  normalize?: (value: string) => string;
+}>;
+export type MyAccountProfileFieldErrors = Readonly<Partial<Record<MyAccountProfileFieldKey, string>>>;
+export type MyAccountProfileContextValue = Readonly<{
+  mode: MyAccountProfileMode;
+  savedValues: MyAccountProfileValues;
+  draft: MyAccountProfileValues;
+  fieldErrors: MyAccountProfileFieldErrors;
+  email: string;
+  activeDocumentType: string | undefined;
+  pending: boolean;
+  registerField: (registration: MyAccountProfileFieldRegistration) => () => void;
+  setField: (key: MyAccountProfileFieldKey, value: string) => void;
+  edit: () => void;
+  cancel: () => void;
+}>;
+export type MyAccountProfileRootProps = Readonly<{
+  /** Store-configured tax-ID type fallback, used when the saved `documentType` is not registered. */
+  documentType?: string;
+  saveFailedMessage?: string;
+  savedMessage?: string;
+  className?: string;
+  children?: ReactNode;
+  $data?: MyAccountProfileData;
+  /** Compiler-injected action surface; carries `identity.customerProfileUpdate`. */
+  $actions?: ComponentActions;
+}>;
+export type MyAccountProfileEditButtonProps = Readonly<{
+  label?: string;
+  className?: string;
+  children?: ReactNode;
+}>;
+export type MyAccountProfileSaveButtonProps = Readonly<{
+  label?: string;
+  className?: string;
+  children?: ReactNode;
+}>;
+export type MyAccountProfileCancelButtonProps = Readonly<{
+  label?: string;
+  className?: string;
+  children?: ReactNode;
+}>;
+export type MyAccountProfileEmailProps = Readonly<{
+  className?: string;
+}>;
+/** Throws when used outside `MyAccountProfileRoot`, per ADR-0009. */
+export declare function useMyAccountProfile(): MyAccountProfileContextValue;
+export declare const MyAccountProfileRootDefinition: ComponentDefinition<Readonly<{
+  /** Store-configured tax-ID type fallback, used when the saved `documentType` is not registered. */
+  documentType?: string;
+  saveFailedMessage?: string;
+  savedMessage?: string;
+  className?: string;
+  children?: ReactNode;
+  $data?: MyAccountProfileData;
+  /** Compiler-injected action surface; carries `identity.customerProfileUpdate`. */
+  $actions?: ComponentActions;
+}>>;
+export declare function MyAccountProfileRoot({ $data: $dataProp, $actions: $actionsProp, documentType: documentTypeProp, saveFailedMessage, savedMessage, className, children }: MyAccountProfileRootProps): import("react/jsx-runtime").JSX.Element | null;
+export declare namespace MyAccountProfileRoot {
+  var Skeleton: typeof MyAccountProfileSkeleton;
+}
+export declare const MyAccountProfileEditButtonDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  className?: string;
+  children?: ReactNode;
+}>>;
+export declare function MyAccountProfileEditButton({ label, className, children }: MyAccountProfileEditButtonProps): import("react/jsx-runtime").JSX.Element | null;
+export declare const MyAccountProfileSaveButtonDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  className?: string;
+  children?: ReactNode;
+}>>;
+export declare function MyAccountProfileSaveButton({ label, className, children }: MyAccountProfileSaveButtonProps): import("react/jsx-runtime").JSX.Element | null;
+export declare const MyAccountProfileCancelButtonDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  className?: string;
+  children?: ReactNode;
+}>>;
+export declare function MyAccountProfileCancelButton({ label, className, children }: MyAccountProfileCancelButtonProps): import("react/jsx-runtime").JSX.Element | null;
+export declare const MyAccountProfileEmailDefinition: ComponentDefinition<Readonly<{
+  className?: string;
+}>>;
+export declare function MyAccountProfileEmail({ className }: MyAccountProfileEmailProps): import("react/jsx-runtime").JSX.Element | null;
+export declare const MyAccountProfileSkeletonDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
+export declare function MyAccountProfileSkeleton({ className, ...props }: ComponentPropsWithRef<'div'>): import("react/jsx-runtime").JSX.Element;
+export type MyAccountProfileFirstNameControlProps = Readonly<{
+  label?: string;
+  requiredMessage?: string;
+  className?: string;
+}>;
+export declare const MyAccountProfileFirstNameControlDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  requiredMessage?: string;
+  className?: string;
+}>>;
+export declare function MyAccountProfileFirstNameControl({ label, requiredMessage, className }: MyAccountProfileFirstNameControlProps): import("react/jsx-runtime").JSX.Element;
+export type MyAccountProfileLastNameControlProps = Readonly<{
+  label?: string;
+  requiredMessage?: string;
+  className?: string;
+}>;
+export declare const MyAccountProfileLastNameControlDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  requiredMessage?: string;
+  className?: string;
+}>>;
+export declare function MyAccountProfileLastNameControl({ label, requiredMessage, className }: MyAccountProfileLastNameControlProps): import("react/jsx-runtime").JSX.Element;
+export type MyAccountProfilePhoneControlProps = Readonly<{
+  label?: string;
+  /** Which draft key this instance binds. Compose the Control twice to expose both numbers. */
+  field?: 'homePhone' | 'mobilePhone';
+  country?: PhoneCountry;
+  invalidMessage?: string;
+  className?: string;
+}>;
+export declare const MyAccountProfilePhoneControlDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  /** Which draft key this instance binds. Compose the Control twice to expose both numbers. */
+  field?: "homePhone" | "mobilePhone";
+  country?: PhoneCountry;
+  invalidMessage?: string;
+  className?: string;
+}>>;
+export declare function MyAccountProfilePhoneControl({ label, field, country, invalidMessage, className }: MyAccountProfilePhoneControlProps): import("react/jsx-runtime").JSX.Element;
+export type MyAccountProfileTaxIdControlProps = Readonly<{
+  label?: string;
+  invalidMessage?: string;
+  /** Inline reason shown beside the locked saved CPF. */
+  lockedReason?: string;
+  className?: string;
+}>;
+export declare const MyAccountProfileTaxIdControlDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  invalidMessage?: string;
+  /** Inline reason shown beside the locked saved CPF. */
+  lockedReason?: string;
+  className?: string;
+}>>;
+export declare function MyAccountProfileTaxIdControl({ label, invalidMessage, lockedReason, className }: MyAccountProfileTaxIdControlProps): import("react/jsx-runtime").JSX.Element | null;
+export type MyAccountProfileBirthDateControlProps = Readonly<{
+  label?: string;
+  className?: string;
+}>;
+export declare const MyAccountProfileBirthDateControlDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  className?: string;
+}>>;
+export declare function MyAccountProfileBirthDateControl({ label, className }: MyAccountProfileBirthDateControlProps): import("react/jsx-runtime").JSX.Element;
+export type MyAccountProfileGenderOption = Readonly<{
+  value: string;
+  label: string;
+}>;
+export type MyAccountProfileGenderControlProps = Readonly<{
+  label?: string;
+  placeholder?: string;
+  clearLabel?: string;
+  options?: readonly MyAccountProfileGenderOption[];
+  className?: string;
+}>;
+export declare const MyAccountProfileGenderControlDefinition: ComponentDefinition<Readonly<{
+  label?: string;
+  placeholder?: string;
+  clearLabel?: string;
+  options?: readonly MyAccountProfileGenderOption[];
+  className?: string;
+}>>;
+export declare function MyAccountProfileGenderControl({ label, placeholder, clearLabel, options, className }: MyAccountProfileGenderControlProps): import("react/jsx-runtime").JSX.Element;
+export declare const MyAccountProfile: {
+  Root: typeof MyAccountProfileRoot;
+  RootDefinition: ComponentDefinition<Readonly<{
+    /** Store-configured tax-ID type fallback, used when the saved `documentType` is not registered. */
+    documentType?: string;
+    saveFailedMessage?: string;
+    savedMessage?: string;
+    className?: string;
+    children?: ReactNode;
+    $data?: MyAccountProfileData;
+    /** Compiler-injected action surface; carries `identity.customerProfileUpdate`. */
+    $actions?: ComponentActions;
+  }>>;
+  EditButton: typeof MyAccountProfileEditButton;
+  EditButtonDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    className?: string;
+    children?: ReactNode;
+  }>>;
+  SaveButton: typeof MyAccountProfileSaveButton;
+  SaveButtonDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    className?: string;
+    children?: ReactNode;
+  }>>;
+  CancelButton: typeof MyAccountProfileCancelButton;
+  CancelButtonDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    className?: string;
+    children?: ReactNode;
+  }>>;
+  Email: typeof MyAccountProfileEmail;
+  EmailDefinition: ComponentDefinition<Readonly<{
+    className?: string;
+  }>>;
+  Skeleton: typeof MyAccountProfileSkeleton;
+  SkeletonDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
+  FirstNameControl: typeof MyAccountProfileFirstNameControl;
+  FirstNameControlDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    requiredMessage?: string;
+    className?: string;
+  }>>;
+  LastNameControl: typeof MyAccountProfileLastNameControl;
+  LastNameControlDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    requiredMessage?: string;
+    className?: string;
+  }>>;
+  PhoneControl: typeof MyAccountProfilePhoneControl;
+  PhoneControlDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    /** Which draft key this instance binds. Compose the Control twice to expose both numbers. */
+    field?: "homePhone" | "mobilePhone";
+    country?: PhoneCountry;
+    invalidMessage?: string;
+    className?: string;
+  }>>;
+  TaxIdControl: typeof MyAccountProfileTaxIdControl;
+  TaxIdControlDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    invalidMessage?: string;
+    /** Inline reason shown beside the locked saved CPF. */
+    lockedReason?: string;
+    className?: string;
+  }>>;
+  BirthDateControl: typeof MyAccountProfileBirthDateControl;
+  BirthDateControlDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    className?: string;
+  }>>;
+  GenderControl: typeof MyAccountProfileGenderControl;
+  GenderControlDefinition: ComponentDefinition<Readonly<{
+    label?: string;
+    placeholder?: string;
+    clearLabel?: string;
+    options?: readonly MyAccountProfileGenderOption[];
+    className?: string;
+  }>>;
+};
+//#endregion
+//# sourceMappingURL=my-account-profile.d.ts.map