@vtex/faststore 0.0.3 → 0.0.5

package/CHANGELOG.md

@@ -4,6 +4,47 @@ Every published version of `@vtex/faststore` has a section here. From `0.0.2` on
 written when its release pull request opens, and reviewed alongside the API delta that justifies the
 version.
 
+## 0.0.5
+
+`./components` adds `AccountAccessGate`, the single access decision for the account pages, placed
+once in the account layout. It renders the account only for a signed-in shopper, sends a visitor who
+arrived signed out to sign-in once per visit, and shows a notice with a sign-in link when the session
+ended mid-visit or sign-in did not complete. It comes with `AccountAccessGateLoading`,
+`AccountAccessGateNotice`, the `AccountAccessGateContent` content type,
+`AccountAccessGateDefinition`, and the `AccountAccessGateProps`, `AccountAccessGateLoadingProps`,
+`AccountAccessGateNoticeProps` and `AccountAccessGateNoticeReason` types. `declareSignOutIntent`,
+`withdrawSignOutIntent` and `useSignOutIntent` let a sign-out tell the gate it was deliberate.
+
+`./components` also adds `AccountMenu`, the account navigation: `AccountMenuRoot` and
+`AccountMenuList`, their `*Definition` and `*Props` exports, the `AccountMenuContent` content type,
+`useAccountMenu`, and the `AccountMenuContextValue`, `AccountMenuCurrent`, `AccountMenuSection` and
+`AccountMenuResolvedSection` types.
+
+Nothing is removed. `.`, `./client` and `./graphql` have no signature change.
+
+In the Internal set, `@vtex/sukima` fixes `sukima dev --no-watch` overwriting the `dist/package.json`
+another compiler wrote. The host's `@vtex/preview-bridge` link was dropped, so a store outside the
+host's checkout failed with `Can't resolve '@vtex/preview-bridge'`.
+
+## 0.0.4
+
+`./components` adds `MyAccountProfile`, the signed-in shopper's profile editor. `Root` loads the saved
+profile, renders its `Skeleton` until the data resolves, and renders nothing for an anonymous
+shopper. Save validates every field, sends only the changed ones in one
+`$actions.identity.customerProfileUpdate`, and focuses the first invalid field; Cancel restores the
+saved values. The frame parts are `EditButton`, `SaveButton`, `CancelButton` and `Email`, and the
+field controls are `FirstNameControl`, `LastNameControl`, `PhoneControl`, `BirthDateControl`,
+`GenderControl` and `TaxIdControl`. Each part has its own `*Definition` and `*Props` export, and
+`useMyAccountProfile`, `MyAccountProfileContextValue` and `MyAccountProfileData` come with them.
+Nothing is removed from `./components`.
+
+The peer dependencies are no longer optional: `@apollo/client`, `@apollo/client-integration-nextjs`,
+`next`, `react` and `react-dom` are required. `./client`, `./components` and `./internal/server`
+import them directly, and a store outside this repository that never declared `@apollo/client` itself
+failed with `Can't resolve '@apollo/client/react'` because package managers skip optional peers.
+npm 7+ and pnpm 8+ now install them for you. `.`, `./client` and `./graphql` have no signature change,
+so for them this is the only difference.
+
 ## 0.0.3
 
 `./components` adds `SignInRedirect`, the component a store's `/login` page renders to hand the

package/README.md

@@ -66,7 +66,7 @@ These carry no snapshot. Treat their shape as unstable while the package is pre-
 
 ## Peer dependencies
 
-All five are optional:
+All five are required:
 
 | Peer | Range |
 | --- | --- |
@@ -79,8 +79,12 @@ All five are optional:
 They are peers rather than dependencies so the app resolves one copy of each. Two copies of `@apollo/client`
 mean two caches, and the reactive state behind the hooks would split across them.
 
-They are optional because the entries are audience-split: an API Extension that only imports `./graphql` needs
-none of them. Install whatever your entries require.
+None is marked optional. `./client`, `./components`, and `./internal/server` import `@apollo/client`,
+`@apollo/client-integration-nextjs`, and `next` directly, so a store using any of those entries cannot run
+without them. Package managers that auto-install peers (npm 7+, pnpm 8+) install them for you.
+
+An API Extension that imports only `./graphql` never uses any of them; installing them anyway costs disk,
+not correctness.
 
 ## Styling
 

package/dist/catalog.json

@@ -3202,6 +3202,36 @@
     "guideline": "Code-entry step: composes AccessCodeField and dispatches $actions.session.validateAccessCode with the Root-owned email and authenticationToken; a successful validate flips the session reactively and hides the Root. Must be inside AccessCodeSignInRoot. See access-code-sign-in.md.",
     "docPath": "src/matter/access-code-sign-in/access-code-sign-in.md"
   },
+  "AccountAccessGate": {
+    "name": "AccountAccessGate",
+    "importPath": "@vtex/faststore/components",
+    "contentTypeId": "account-access-gate",
+    "editor": {
+      "label": "Account Access Gate",
+      "category": "identity"
+    },
+    "requiresContext": "session",
+    "schema": {
+      "loadingLabel": {
+        "type": "string",
+        "label": "Loading Announcement"
+      },
+      "expiredMessage": {
+        "type": "string",
+        "label": "Session Ended Message"
+      },
+      "signInIncompleteMessage": {
+        "type": "string",
+        "label": "Sign-in Did Not Complete Message"
+      },
+      "signInLabel": {
+        "type": "string",
+        "label": "Sign-in Link Label"
+      }
+    },
+    "guideline": "The account's single access decision: place it once in the account layout, wrapping the body, and every page that declares that layout inherits it — never restate it per section. It renders its children only for a logged-in shopper; it shows a composed loading look while the session resolves, replaces the current history entry with the sign-in destination for a visitor who arrived signed out (identified counts as signed out), tells a shopper whose session ended mid-visit rather than bouncing them, and stands down while AccountMenuSignOut navigates. It redirects at most once per visit: a shopper who comes back from sign-in still signed out gets a message and a link rather than a second hop. Must be inside SessionRoot, which the same layout hosts. Never place the /login route under it — the gate redirects there, and a gated /login would redirect to itself.",
+    "docPath": "src/matter/account-access-gate/account-access-gate.md"
+  },
   "AccountEntryPoint": {
     "name": "AccountEntryPoint",
     "importPath": "@vtex/faststore/components",
@@ -3229,9 +3259,45 @@
         "label": "Loading Announcement"
       }
     },
-    "guideline": "Session-aware header control rendering one link: the signed-out label toward /login for anonymous and identified shoppers, the signed-in label toward the account route for logged-in ones, and a politely announced placeholder while the session resolves. Both destinations are fixed conventions, not props, so no authored value can misroute the auth flow. Must be inside a SessionRoot, normally the one hosted by the shared layout — a page-hosted provider resolves the session server-side without the shopper cookie and sticks on the signed-out label. Author the label for a state or that state renders nothing; the labels are optional in the type only because a CMS entry may supply them, and an entry overrides all four fields at runtime. Style it through data-fs-account-entry-point and switch on data-fs-account-entry-point-state.",
+    "guideline": "Session-aware header control rendering one link: the signed-out label toward /login for anonymous and identified shoppers, the signed-in label toward the account route for logged-in ones, and a politely announced placeholder while the session resolves. Both destinations are fixed conventions, not props, so no authored value can misroute the auth flow. Must be inside a SessionRoot, normally the one hosted by the shared layout; a page-hosted provider also works, since the server-side session fetch forwards the shopper cookie. Author the label for a state or that state renders nothing; the labels are optional in the type only because a CMS entry may supply them, and an entry overrides all four fields at runtime. Style it through data-fs-account-entry-point and switch on data-fs-account-entry-point-state.",
     "docPath": "src/matter/account-entry-point/account-entry-point.md"
   },
+  "AccountMenuRoot": {
+    "name": "AccountMenuRoot",
+    "importPath": "@vtex/faststore/components",
+    "contentTypeId": "account-menu",
+    "providesContext": "account-menu",
+    "editor": {
+      "label": "Account Menu Root",
+      "category": "navigation"
+    },
+    "schema": {
+      "items": {
+        "type": "array",
+        "label": "Sections"
+      }
+    },
+    "guideline": "The account menu's provider, and deliberately not its landmark: it resolves the section list, derives which section the shopper is reading, publishes both, and renders its children. Compose it in the my-account layout around both AccountMenuList and the Slot holding the section's own page — its context has to reach the consumers inside the slot, and a nav stretched that far would announce every section's content as navigation. The list comes from a published entry, else the authored items prop, else the library's five defaults; a channel supplying an empty list resolves to empty rather than falling through, because a merchant who cleared the list cleared it. Style it through data-fs-account-menu.",
+    "docPath": "src/matter/account-menu/account-menu.md"
+  },
+  "AccountMenuList": {
+    "name": "AccountMenuList",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "account-menu",
+    "editor": {
+      "label": "Account Menu List",
+      "category": "navigation"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Account",
+        "label": "Aria Label"
+      }
+    },
+    "guideline": "The account menu's navigation landmark and its items, and nothing else — it surrounds the items alone so the section's own content stays outside the navigation region. Author the label: a landmark with no accessible name is one a screen-reader user cannot tell from any other. The current section carries aria-current, page for the section itself and true for a page inside it, with data-fs-account-menu-item-current beside it as a style target and never as the only signal. When the list scrolls, the current item is brought into view on mount and on every route change. Must be a descendant of AccountMenuRoot.",
+    "docPath": "src/matter/account-menu/account-menu.md"
+  },
   "BreadcrumbRoot": {
     "name": "BreadcrumbRoot",
     "importPath": "@vtex/faststore/components",
@@ -4911,6 +4977,276 @@
     "guideline": "Renders the inline sign-out error (role=\"alert\") when the logout mutation returns a user error, else nothing. Must be a descendant of IdentitySummaryRoot.",
     "docPath": "src/matter/identity-summary/identity-summary.md"
   },
+  "MyAccountProfileRoot": {
+    "name": "MyAccountProfileRoot",
+    "importPath": "@vtex/faststore/components",
+    "fragment": "\n  fragment MyAccountProfileData on Query {\n    customerProfile {\n      __typename\n      id\n      firstName\n      lastName\n      email\n      homePhone\n      mobilePhone\n      document\n      documentType\n      birthDate\n      gender\n    }\n  }\n",
+    "fetchStrategy": "reactive",
+    "requiresContext": "session",
+    "providesContext": "my-account-profile",
+    "actions": {
+      "identity": [
+        "customerProfileUpdate"
+      ]
+    },
+    "skeleton": "MyAccountProfileSkeleton",
+    "editor": {
+      "label": "My Account Profile Root",
+      "category": "identity"
+    },
+    "schema": {
+      "documentType": {
+        "type": "string",
+        "label": "Default document type (e.g. CPF)"
+      },
+      "saveFailedMessage": {
+        "type": "string",
+        "label": "Save failure message"
+      },
+      "savedMessage": {
+        "type": "string",
+        "label": "Save success message"
+      }
+    },
+    "guideline": "Data root + form mechanics for the persistent My Account profile: owns the saved profile, the draft, the view/edit toggle, and the single batched Save (dispatches only dirty, registered fields; an empty string erases, an omitted field is untouched). Self-gates on the authenticated (loggedIn) session; requires a SessionRoot ancestor and a mounted ToastProvider ancestor — Save success/failure surface as a toast, not an inline part. Field Controls register their key plus an optional validator and normalizer through useMyAccountProfile() — the field set is a merchant composition decision, never enumerated here. Compose EditButton (view state), SaveButton/CancelButton (edit state), and Email as children in any order. See my-account-profile.md.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileEditButton": {
+    "name": "MyAccountProfileEditButton",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Edit Button",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Edit",
+        "label": "Button label"
+      }
+    },
+    "guideline": "Switches MyAccountProfileRoot from the view state to the edit state. Renders only in the view state. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileSaveButton": {
+    "name": "MyAccountProfileSaveButton",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Save Button",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Save",
+        "label": "Button label"
+      }
+    },
+    "guideline": "Submits MyAccountProfileRoot's batched Save. Renders only in the edit state; disabled while the write is pending. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileCancelButton": {
+    "name": "MyAccountProfileCancelButton",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Cancel Button",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Cancel",
+        "label": "Button label"
+      }
+    },
+    "guideline": "Reverts every field to its last saved value and returns MyAccountProfileRoot to the view state, without persisting. Renders only in the edit state; disabled while the write is pending. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileEmail": {
+    "name": "MyAccountProfileEmail",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Email",
+      "category": "identity"
+    },
+    "schema": {},
+    "guideline": "The shopper's read-only login identifier, or nothing when absent. Never editable — no edit-state rendering exists for it. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileSkeleton": {
+    "name": "MyAccountProfileSkeleton",
+    "importPath": "@vtex/faststore/components",
+    "editor": {
+      "label": "My Account Profile Skeleton",
+      "category": "identity"
+    },
+    "schema": {},
+    "guideline": "Loading placeholder rendered by MyAccountProfileRoot while $data is unresolved. Declares no context requirement — it renders before the Root has anything to provide.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileFirstNameControl": {
+    "name": "MyAccountProfileFirstNameControl",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile First Name Control",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "First name",
+        "label": "Label"
+      },
+      "requiredMessage": {
+        "type": "string",
+        "default": "First name is required.",
+        "label": "Required message"
+      }
+    },
+    "guideline": "Draft-bound, required first-name field. Blocks Save with an inline message and focus when left empty. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileLastNameControl": {
+    "name": "MyAccountProfileLastNameControl",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Last Name Control",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Last name",
+        "label": "Label"
+      },
+      "requiredMessage": {
+        "type": "string",
+        "default": "Last name is required.",
+        "label": "Required message"
+      }
+    },
+    "guideline": "Draft-bound, required last-name field. Blocks Save with an inline message and focus when left empty. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfilePhoneControl": {
+    "name": "MyAccountProfilePhoneControl",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Phone Control",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Phone",
+        "label": "Label"
+      },
+      "field": {
+        "type": [
+          "homePhone",
+          "mobilePhone"
+        ],
+        "default": "mobilePhone",
+        "label": "Bound field"
+      },
+      "country": {
+        "type": [
+          "US",
+          "BR"
+        ],
+        "default": "US",
+        "label": "Country"
+      },
+      "invalidMessage": {
+        "type": "string",
+        "default": "Invalid phone number",
+        "label": "Invalid message"
+      }
+    },
+    "guideline": "Draft-bound, optional phone field bound to either homePhone or mobilePhone via the field prop (Decision 1) — compose it twice to expose both numbers. Normalizes to E.164 on the Root's Save. Absent from the composition means absent from the payload. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileTaxIdControl": {
+    "name": "MyAccountProfileTaxIdControl",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Tax ID Control",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "National tax ID",
+        "label": "Label"
+      },
+      "invalidMessage": {
+        "type": "string",
+        "default": "Invalid document number.",
+        "label": "Invalid message"
+      },
+      "lockedReason": {
+        "type": "string",
+        "default": "Your document ID can't be edited.",
+        "label": "Locked reason"
+      }
+    },
+    "guideline": "Draft-bound, optional national tax-ID field (CPF in V0). Self-gates on the Root's active document type. A saved value renders as a disabled, locked input in the edit state rather than disappearing (Decision 4); an unsaved value renders as an editable field. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileBirthDateControl": {
+    "name": "MyAccountProfileBirthDateControl",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Birth Date Control",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Birth date",
+        "label": "Label"
+      }
+    },
+    "guideline": "Draft-bound, optional birth-date field over a native date input. Maps the native yyyy-mm-dd value to the stored profile format on read and write. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
+  "MyAccountProfileGenderControl": {
+    "name": "MyAccountProfileGenderControl",
+    "importPath": "@vtex/faststore/components",
+    "requiresContext": "my-account-profile",
+    "editor": {
+      "label": "My Account Profile Gender Control",
+      "category": "identity"
+    },
+    "schema": {
+      "label": {
+        "type": "string",
+        "default": "Gender",
+        "label": "Label"
+      },
+      "placeholder": {
+        "type": "string",
+        "default": "Select",
+        "label": "Placeholder"
+      },
+      "clearLabel": {
+        "type": "string",
+        "default": "Clear",
+        "label": "Clear button label"
+      }
+    },
+    "guideline": "Draft-bound, optional gender field over a store-configurable set of options (the options prop). Free-string storage — no server-side enum. A Clear button erases a selected value back to empty, since the Select itself offers no such option. Must be a descendant of MyAccountProfileRoot.",
+    "docPath": "src/matter/my-account-profile/my-account-profile.md"
+  },
   "PricingRoot": {
     "name": "PricingRoot",
     "importPath": "@vtex/faststore/components",