@vtex/faststore 0.0.6 → 0.0.8

package/dist/matter/account-entry-point/account-entry-point.js.map

@@ -1 +1 @@
-{"version":3,"file":"account-entry-point.js","names":[],"sources":["../../../src/matter/account-entry-point/account-entry-point.tsx"],"sourcesContent":["'use client';\n\nimport { type ContentValue, defineComponent, defineContentType } from '@vtex/fs-core';\nimport { usePathname } from 'next/navigation';\nimport { type ComponentPropsWithRef, useEffect, useState } from 'react';\nimport { Icon } from '../../particles/icon/icon.js';\nimport { NavigationLink } from '../../particles/navigation-link/navigation-link.js';\nimport { resolveSignInHref } from '../../utils/safe-href.js';\nimport { useSession } from '../session/session.js';\n\n/** The account's root. A fixed convention, never an authored value: an authored destination could\n *  misroute the entry into the account. */\nconst ACCOUNT_ROUTE = '/account';\n\n// Nothing is required: an entry may author any subset, and a slice missing a required property is\n// shape-invalid, which drops the whole element rather than the one field.\nexport const AccountEntryPointContent = defineContentType({\n  id: 'account-entry-point',\n  title: 'Account Entry Point',\n  description: 'Labels and icon for the header sign-in / account control.',\n  schema: {\n    type: 'object',\n    additionalProperties: false,\n    properties: {\n      signedOutLabel: { type: 'string', minLength: 1, title: 'Signed-out label' },\n      signedInLabel: { type: 'string', minLength: 1, title: 'Signed-in label' },\n      icon: { type: 'string', minLength: 1, title: 'Icon' },\n      loadingLabel: { type: 'string', minLength: 1, title: 'Loading announcement' },\n    },\n  },\n});\n\n/** Props for {@link AccountEntryPoint}. Extends native `<a>` attributes (the rendered root). */\nexport type AccountEntryPointProps = Omit<ComponentPropsWithRef<'a'>, 'href' | 'children'> & {\n  /** Label for anonymous and identified shoppers. Optional: the render gate, not the type,\n   *  requires a resolved value. */\n  signedOutLabel?: string;\n  /** Label for logged-in shoppers. Same gate. */\n  signedInLabel?: string;\n  /** Icon reference for the glyph. Never gated: a control with no glyph is a valid configuration. */\n  icon?: string;\n  /** Text the live region announces while the session resolves. */\n  loadingLabel?: string;\n  /** Merchant-authored fields, sliced from the page/layout content entry; win over the props field\n   *  by field when present. Absent in a non-CMS store — the props are the fallback. */\n  $content?: ContentValue<typeof AccountEntryPointContent>;\n};\n\n/** Props for {@link AccountEntryPointLoading}. Extends native `<span>` attributes. */\nexport type AccountEntryPointLoadingProps = Omit<ComponentPropsWithRef<'span'>, 'children'>;\n\nexport const AccountEntryPointDefinition = defineComponent<AccountEntryPointProps>({\n  name: 'AccountEntryPoint',\n  importPath: '@vtex/faststore/components',\n  component: AccountEntryPoint,\n  content: AccountEntryPointContent,\n  editor: { label: 'Account Entry Point', category: 'identity' },\n  requiresContext: 'session',\n  schema: {\n    signedOutLabel: { type: 'string', label: 'Signed-out Label' },\n    signedInLabel: { type: 'string', label: 'Signed-in Label' },\n    icon: { type: 'icon', label: 'Icon' },\n    loadingLabel: { type: 'string', label: 'Loading Announcement' },\n  },\n  guideline:\n    '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.',\n});\n\nexport function AccountEntryPoint({\n  signedOutLabel,\n  signedInLabel,\n  icon,\n  loadingLabel,\n  $content,\n  className,\n  ref,\n  ...props\n}: AccountEntryPointProps) {\n  const { state, loading } = useSession();\n  const pathname = usePathname();\n\n  // Blank entry fields fall through, so clearing one in the Admin reads as unauthored.\n  const entrySignedOutLabel = $content?.signedOutLabel?.trim() ? $content.signedOutLabel : signedOutLabel;\n  const entrySignedInLabel = $content?.signedInLabel?.trim() ? $content.signedInLabel : signedInLabel;\n  const entryIcon = $content?.icon?.trim() ? $content.icon : icon;\n  const entryLoadingLabel = $content?.loadingLabel?.trim() ? $content.loadingLabel : loadingLabel;\n\n  // Assistive technology only reports a change inside a region that was already in the tree, so a\n  // region mounted together with its text announces nothing. The region therefore holds the same\n  // position in both branches — React keeps it mounted across the swap — and starts empty, with the\n  // label written on the pass after mount and cleared again once the session resolves.\n  //\n  // It trails the branch content rather than leading it so the authored swatch, which lands on\n  // whichever element leads, can still reach the region through a following-sibling selector.\n  const [announcement, setAnnouncement] = useState('');\n  const resolvingLabel = loading ? entryLoadingLabel : undefined;\n  useEffect(() => {\n    setAnnouncement(resolvingLabel ?? '');\n  }, [resolvingLabel]);\n\n  // Gate on `loading` before `state`: an unresolved session reports `anonymous`, so reading the\n  // tri-state first would flash \"Sign In\" at a shopper who is already signed in.\n  if (loading) {\n    return (\n      <>\n        <AccountEntryPointLoading {...props} className={className} />\n        <AccountEntryPointAnnouncement>{announcement}</AccountEntryPointAnnouncement>\n      </>\n    );\n  }\n\n  // `identified` stays on the signed-out link: an identified but unauthenticated shopper cannot\n  // reach their account yet.\n  const signedIn = state === 'loggedIn';\n  const label = signedIn ? entrySignedInLabel : entrySignedOutLabel;\n\n  // A focusable link a screen reader announces as its bare URL is worse than no control at all.\n  if (!label?.trim()) {\n    return null;\n  }\n\n  return (\n    <>\n      <NavigationLink\n        {...props}\n        ref={ref}\n        href={signedIn ? ACCOUNT_ROUTE : resolveSignInHref(pathname)}\n        // The signed-out destination is a deferred auth proxy that may set a cookie or redirect, and\n        // a header control is always in the viewport — the default prefetch would fire that GET on\n        // every page view. The account route is an ordinary page, so it keeps the default.\n        prefetch={signedIn ? undefined : false}\n        className={className}\n        data-fs-account-entry-point=\"\"\n        data-fs-account-entry-point-state={signedIn ? 'signed-in' : 'signed-out'}\n      >\n        {entryIcon ? <Icon name={entryIcon} /> : null}\n        <span data-fs-account-entry-point-label=\"\">{label}</span>\n      </NavigationLink>\n      <AccountEntryPointAnnouncement>{announcement}</AccountEntryPointAnnouncement>\n    </>\n  );\n}\n\n/**\n * The live region that carries the control across the wait. Separate from the visual placeholder\n * because it has to outlive it: the placeholder is only in the tree while the session resolves,\n * while the region has to be there before the text lands for the text to be announced at all.\n */\nfunction AccountEntryPointAnnouncement({ children }: { children: string }) {\n  return (\n    <output aria-live=\"polite\" data-fs-account-entry-point-announcement=\"\">\n      {children}\n    </output>\n  );\n}\n\n/**\n * The visual stand-in occupying the control's slot while the session resolves. Purely visual: the\n * wait is spoken by the sibling live region, so this is hidden from assistive technology rather\n * than announced twice. Named for the state it represents, as `ShippingSimulatorLoading` is, not\n * for the bar it draws.\n */\nexport function AccountEntryPointLoading({ className, ...props }: AccountEntryPointLoadingProps) {\n  return <span {...props} aria-hidden=\"true\" className={className} data-fs-account-entry-point-loading=\"\" />;\n}\n"],"mappings":";;;;;;;;;;;;;;AAYA,MAAM,gBAAgB;AAItB,MAAa,2BAA2B,kBAAkB;CACxD,IAAI;CACJ,OAAO;CACP,aAAa;CACb,QAAQ;EACN,MAAM;EACN,sBAAsB;EACtB,YAAY;GACV,gBAAgB;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAmB;GAC1E,eAAe;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAkB;GACxE,MAAM;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAO;GACpD,cAAc;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAuB;EAC9E;CACF;AACF,CAAC;AAqBD,MAAa,8BAA8B,gBAAwC;CACjF,MAAM;CACN,YAAY;CACZ,WAAW;CACX,SAAS;CACT,QAAQ;EAAE,OAAO;EAAuB,UAAU;CAAW;CAC7D,iBAAiB;CACjB,QAAQ;EACN,gBAAgB;GAAE,MAAM;GAAU,OAAO;EAAmB;EAC5D,eAAe;GAAE,MAAM;GAAU,OAAO;EAAkB;EAC1D,MAAM;GAAE,MAAM;GAAQ,OAAO;EAAO;EACpC,cAAc;GAAE,MAAM;GAAU,OAAO;EAAuB;CAChE;CACA,WACE;AACJ,CAAC;AAED,SAAgB,kBAAkB,EAChC,gBACA,eACA,MACA,cACA,UACA,WACA,KACA,GAAG,SACsB;CACzB,MAAM,EAAE,OAAO,YAAY,WAAW;CACtC,MAAM,WAAW,YAAY;CAG7B,MAAM,sBAAsB,UAAU,gBAAgB,KAAK,IAAI,SAAS,iBAAiB;CACzF,MAAM,qBAAqB,UAAU,eAAe,KAAK,IAAI,SAAS,gBAAgB;CACtF,MAAM,YAAY,UAAU,MAAM,KAAK,IAAI,SAAS,OAAO;CAC3D,MAAM,oBAAoB,UAAU,cAAc,KAAK,IAAI,SAAS,eAAe;CASnF,MAAM,CAAC,cAAc,mBAAmB,SAAS,EAAE;CACnD,MAAM,iBAAiB,UAAU,oBAAoB,KAAA;CACrD,gBAAgB;EACd,gBAAgB,kBAAkB,EAAE;CACtC,GAAG,CAAC,cAAc,CAAC;CAInB,IAAI,SACF,OACE,qBAAA,UAAA,EAAA,UAAA,CACE,oBAAC,0BAAD;EAA0B,GAAI;EAAkB;CAAY,CAAA,GAC5D,oBAAC,+BAAD,EAAA,UAAgC,aAA4C,CAAA,CAC5E,EAAA,CAAA;CAMN,MAAM,WAAW,UAAU;CAC3B,MAAM,QAAQ,WAAW,qBAAqB;CAG9C,IAAI,CAAC,OAAO,KAAK,GACf,OAAO;CAGT,OACE,qBAAA,UAAA,EAAA,UAAA,CACE,qBAAC,gBAAD;EACE,GAAI;EACC;EACL,MAAM,WAAW,gBAAgB,kBAAkB,QAAQ;EAI3D,UAAU,WAAW,KAAA,IAAY;EACtB;EACX,+BAA4B;EAC5B,qCAAmC,WAAW,cAAc;EAV9D,UAAA,CAYG,YAAY,oBAAC,MAAD,EAAM,MAAM,UAAY,CAAA,IAAI,MACzC,oBAAC,QAAD;GAAM,qCAAkC;GAAI,UAAA;EAAY,CAAA,CAC1C;CAChB,CAAA,GAAA,oBAAC,+BAAD,EAAA,UAAgC,aAA4C,CAAA,CAC5E,EAAA,CAAA;AAEN;;;;;;AAOA,SAAS,8BAA8B,EAAE,YAAkC;CACzE,OACE,oBAAC,UAAD;EAAQ,aAAU;EAAS,4CAAyC;EACjE;CACK,CAAA;AAEZ;;;;;;;AAQA,SAAgB,yBAAyB,EAAE,WAAW,GAAG,SAAwC;CAC/F,OAAO,oBAAC,QAAD;EAAM,GAAI;EAAO,eAAY;EAAkB;EAAW,uCAAoC;CAAI,CAAA;AAC3G"}
+{"version":3,"file":"account-entry-point.js","names":[],"sources":["../../../src/matter/account-entry-point/account-entry-point.tsx"],"sourcesContent":["'use client';\n\nimport { type ContentValue, defineComponent, defineContentType } from '@vtex/fs-core';\nimport { type ComponentPropsWithRef, useEffect, useState } from 'react';\nimport { Icon } from '../../particles/icon/icon.js';\nimport { NavigationLink } from '../../particles/navigation-link/navigation-link.js';\nimport type { PageRef } from '../../sdk/navigation/types.js';\nimport { useStorefrontRoute } from '../../sdk/navigation/use-storefront-route.js';\nimport { signInTarget } from '../../utils/safe-href.js';\nimport { useSession } from '../session/session.js';\n\n/** The account's root page. Never an authored value: an authored destination could misroute the entry\n *  into the account. */\nconst ACCOUNT_ROUTE: PageRef = { standard: 'account' };\n\n// Nothing is required: an entry may author any subset, and a slice missing a required property is\n// shape-invalid, which drops the whole element rather than the one field.\nexport const AccountEntryPointContent = defineContentType({\n  id: 'account-entry-point',\n  title: 'Account Entry Point',\n  description: 'Labels and icon for the header sign-in / account control.',\n  schema: {\n    type: 'object',\n    additionalProperties: false,\n    properties: {\n      signedOutLabel: { type: 'string', minLength: 1, title: 'Signed-out label' },\n      signedInLabel: { type: 'string', minLength: 1, title: 'Signed-in label' },\n      icon: { type: 'string', minLength: 1, title: 'Icon' },\n      loadingLabel: { type: 'string', minLength: 1, title: 'Loading announcement' },\n    },\n  },\n});\n\n/** Props for {@link AccountEntryPoint}. Extends native `<a>` attributes (the rendered root). */\nexport type AccountEntryPointProps = Omit<ComponentPropsWithRef<'a'>, 'href' | 'children'> & {\n  /** Label for anonymous and identified shoppers. Optional: the render gate, not the type,\n   *  requires a resolved value. */\n  signedOutLabel?: string;\n  /** Label for logged-in shoppers. Same gate. */\n  signedInLabel?: string;\n  /** Icon reference for the glyph. Never gated: a control with no glyph is a valid configuration. */\n  icon?: string;\n  /** Text the live region announces while the session resolves. */\n  loadingLabel?: string;\n  /** Merchant-authored fields, sliced from the page/layout content entry; win over the props field\n   *  by field when present. Absent in a non-CMS store — the props are the fallback. */\n  $content?: ContentValue<typeof AccountEntryPointContent>;\n};\n\n/** Props for {@link AccountEntryPointLoading}. Extends native `<span>` attributes. */\nexport type AccountEntryPointLoadingProps = Omit<ComponentPropsWithRef<'span'>, 'children'>;\n\nexport const AccountEntryPointDefinition = defineComponent<AccountEntryPointProps>({\n  name: 'AccountEntryPoint',\n  importPath: '@vtex/faststore/components',\n  component: AccountEntryPoint,\n  content: AccountEntryPointContent,\n  editor: { label: 'Account Entry Point', category: 'identity' },\n  requiresContext: 'session',\n  schema: {\n    signedOutLabel: { type: 'string', label: 'Signed-out Label' },\n    signedInLabel: { type: 'string', label: 'Signed-in Label' },\n    icon: { type: 'icon', label: 'Icon' },\n    loadingLabel: { type: 'string', label: 'Loading Announcement' },\n  },\n  guideline:\n    'Session-aware header control rendering one link: the signed-out label toward the sign-in page for anonymous and identified shoppers, the signed-in label toward the account page 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.',\n});\n\nexport function AccountEntryPoint({\n  signedOutLabel,\n  signedInLabel,\n  icon,\n  loadingLabel,\n  $content,\n  className,\n  ref,\n  ...props\n}: AccountEntryPointProps) {\n  const { state, loading } = useSession();\n  const { path } = useStorefrontRoute();\n\n  // Blank entry fields fall through, so clearing one in the Admin reads as unauthored.\n  const entrySignedOutLabel = $content?.signedOutLabel?.trim() ? $content.signedOutLabel : signedOutLabel;\n  const entrySignedInLabel = $content?.signedInLabel?.trim() ? $content.signedInLabel : signedInLabel;\n  const entryIcon = $content?.icon?.trim() ? $content.icon : icon;\n  const entryLoadingLabel = $content?.loadingLabel?.trim() ? $content.loadingLabel : loadingLabel;\n\n  // Assistive technology only reports a change inside a region that was already in the tree, so a\n  // region mounted together with its text announces nothing. The region therefore holds the same\n  // position in both branches — React keeps it mounted across the swap — and starts empty, with the\n  // label written on the pass after mount and cleared again once the session resolves.\n  //\n  // It trails the branch content rather than leading it so the authored swatch, which lands on\n  // whichever element leads, can still reach the region through a following-sibling selector.\n  const [announcement, setAnnouncement] = useState('');\n  const resolvingLabel = loading ? entryLoadingLabel : undefined;\n  useEffect(() => {\n    setAnnouncement(resolvingLabel ?? '');\n  }, [resolvingLabel]);\n\n  // Gate on `loading` before `state`: an unresolved session reports `anonymous`, so reading the\n  // tri-state first would flash \"Sign In\" at a shopper who is already signed in.\n  if (loading) {\n    return (\n      <>\n        <AccountEntryPointLoading {...props} className={className} />\n        <AccountEntryPointAnnouncement>{announcement}</AccountEntryPointAnnouncement>\n      </>\n    );\n  }\n\n  // `identified` stays on the signed-out link: an identified but unauthenticated shopper cannot\n  // reach their account yet.\n  const signedIn = state === 'loggedIn';\n  const label = signedIn ? entrySignedInLabel : entrySignedOutLabel;\n\n  // A focusable link a screen reader announces as its bare URL is worse than no control at all.\n  if (!label?.trim()) {\n    return null;\n  }\n\n  return (\n    <>\n      <NavigationLink\n        {...props}\n        ref={ref}\n        href={signedIn ? ACCOUNT_ROUTE : signInTarget(path)}\n        // The signed-out destination is a deferred auth proxy that may set a cookie or redirect, and\n        // a header control is always in the viewport — the default prefetch would fire that GET on\n        // every page view. The account page is an ordinary page, so it keeps the default.\n        prefetch={signedIn ? undefined : false}\n        className={className}\n        data-fs-account-entry-point=\"\"\n        data-fs-account-entry-point-state={signedIn ? 'signed-in' : 'signed-out'}\n      >\n        {entryIcon ? <Icon name={entryIcon} /> : null}\n        <span data-fs-account-entry-point-label=\"\">{label}</span>\n      </NavigationLink>\n      <AccountEntryPointAnnouncement>{announcement}</AccountEntryPointAnnouncement>\n    </>\n  );\n}\n\n/**\n * The live region that carries the control across the wait. Separate from the visual placeholder\n * because it has to outlive it: the placeholder is only in the tree while the session resolves,\n * while the region has to be there before the text lands for the text to be announced at all.\n */\nfunction AccountEntryPointAnnouncement({ children }: { children: string }) {\n  return (\n    <output aria-live=\"polite\" data-fs-account-entry-point-announcement=\"\">\n      {children}\n    </output>\n  );\n}\n\n/**\n * The visual stand-in occupying the control's slot while the session resolves. Purely visual: the\n * wait is spoken by the sibling live region, so this is hidden from assistive technology rather\n * than announced twice. Named for the state it represents, as `ShippingSimulatorLoading` is, not\n * for the bar it draws.\n */\nexport function AccountEntryPointLoading({ className, ...props }: AccountEntryPointLoadingProps) {\n  return <span {...props} aria-hidden=\"true\" className={className} data-fs-account-entry-point-loading=\"\" />;\n}\n"],"mappings":";;;;;;;;;;;;;;AAaA,MAAM,gBAAyB,EAAE,UAAU,UAAU;AAIrD,MAAa,2BAA2B,kBAAkB;CACxD,IAAI;CACJ,OAAO;CACP,aAAa;CACb,QAAQ;EACN,MAAM;EACN,sBAAsB;EACtB,YAAY;GACV,gBAAgB;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAmB;GAC1E,eAAe;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAkB;GACxE,MAAM;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAO;GACpD,cAAc;IAAE,MAAM;IAAU,WAAW;IAAG,OAAO;GAAuB;EAC9E;CACF;AACF,CAAC;AAqBD,MAAa,8BAA8B,gBAAwC;CACjF,MAAM;CACN,YAAY;CACZ,WAAW;CACX,SAAS;CACT,QAAQ;EAAE,OAAO;EAAuB,UAAU;CAAW;CAC7D,iBAAiB;CACjB,QAAQ;EACN,gBAAgB;GAAE,MAAM;GAAU,OAAO;EAAmB;EAC5D,eAAe;GAAE,MAAM;GAAU,OAAO;EAAkB;EAC1D,MAAM;GAAE,MAAM;GAAQ,OAAO;EAAO;EACpC,cAAc;GAAE,MAAM;GAAU,OAAO;EAAuB;CAChE;CACA,WACE;AACJ,CAAC;AAED,SAAgB,kBAAkB,EAChC,gBACA,eACA,MACA,cACA,UACA,WACA,KACA,GAAG,SACsB;CACzB,MAAM,EAAE,OAAO,YAAY,WAAW;CACtC,MAAM,EAAE,SAAS,mBAAmB;CAGpC,MAAM,sBAAsB,UAAU,gBAAgB,KAAK,IAAI,SAAS,iBAAiB;CACzF,MAAM,qBAAqB,UAAU,eAAe,KAAK,IAAI,SAAS,gBAAgB;CACtF,MAAM,YAAY,UAAU,MAAM,KAAK,IAAI,SAAS,OAAO;CAC3D,MAAM,oBAAoB,UAAU,cAAc,KAAK,IAAI,SAAS,eAAe;CASnF,MAAM,CAAC,cAAc,mBAAmB,SAAS,EAAE;CACnD,MAAM,iBAAiB,UAAU,oBAAoB,KAAA;CACrD,gBAAgB;EACd,gBAAgB,kBAAkB,EAAE;CACtC,GAAG,CAAC,cAAc,CAAC;CAInB,IAAI,SACF,OACE,qBAAA,YAAA,EAAA,UAAA,CACE,oBAAC,0BAAD;EAA0B,GAAI;EAAkB;CAAY,CAAA,GAC5D,oBAAC,+BAAD,EAAA,UAAgC,aAA4C,CAAA,CAC5E,EAAA,CAAA;CAMN,MAAM,WAAW,UAAU;CAC3B,MAAM,QAAQ,WAAW,qBAAqB;CAG9C,IAAI,CAAC,OAAO,KAAK,GACf,OAAO;CAGT,OACE,qBAAA,YAAA,EAAA,UAAA,CACE,qBAAC,gBAAD;EACE,GAAI;EACC;EACL,MAAM,WAAW,gBAAgB,aAAa,IAAI;EAIlD,UAAU,WAAW,KAAA,IAAY;EACtB;EACX,+BAA4B;EAC5B,qCAAmC,WAAW,cAAc;EAV9D,UAAA,CAYG,YAAY,oBAAC,MAAD,EAAM,MAAM,UAAY,CAAA,IAAI,MACzC,oBAAC,QAAD;GAAM,qCAAkC;GAAI,UAAA;EAAY,CAAA,CAC1C;CAChB,CAAA,GAAA,oBAAC,+BAAD,EAAA,UAAgC,aAA4C,CAAA,CAC5E,EAAA,CAAA;AAEN;;;;;;AAOA,SAAS,8BAA8B,EAAE,YAAkC;CACzE,OACE,oBAAC,UAAD;EAAQ,aAAU;EAAS,4CAAyC;EACjE;CACK,CAAA;AAEZ;;;;;;;AAQA,SAAgB,yBAAyB,EAAE,WAAW,GAAG,SAAwC;CAC/F,OAAO,oBAAC,QAAD;EAAM,GAAI;EAAO,eAAY;EAAkB;EAAW,uCAAoC;CAAI,CAAA;AAC3G"}

package/dist/matter/account-menu/account-menu.d.ts

@@ -1,6 +1,8 @@
 import { ContentValue } from "../../core/dist/define-content-type.js";
 import { ComponentDefinition } from "../../core/dist/define-component.js";
 import "../../core/dist/index.js";
+import { PageRef } from "../../sdk/navigation/types.js";
+import { ComponentActions } from "../../sdk/actions/types.js";
 import { ComponentPropsWithRef } from "react";
 //#region src/matter/account-menu/account-menu.d.ts
 export declare const AccountMenuContent: {
@@ -42,13 +44,58 @@ export declare const AccountMenuContent: {
     };
   };
 };
+export declare const AccountMenuIndexRedirectContent: {
+  readonly id: "account-menu-index-redirect";
+  readonly title: "Account Menu Index Redirect";
+  readonly description: "What the account's root shows while it opens the first section, and when there is none to open.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly loadingLabel: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Loading announcement";
+      };
+      readonly emptyMessage: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "No section message";
+      };
+    };
+  };
+};
+export declare const AccountMenuSignOutContent: {
+  readonly id: "account-menu-sign-out";
+  readonly title: "Account Menu Sign Out";
+  readonly description: "The sign-out control in the account sidebar, and what it says when signing out fails.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly label: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Sign-out label";
+      };
+      readonly errorMessage: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Sign-out failed message";
+      };
+    };
+  };
+};
 type AccountMenuContentValue = ContentValue<typeof AccountMenuContent>;
-/** One authored section. Derived from the model so the prop and content channels cannot drift. */
-export type AccountMenuSection = NonNullable<AccountMenuContentValue['items']>[number];
+/** One authored section. Derived from the model so the prop and content channels cannot drift; the prop
+ *  channel also takes a page reference. */
+export type AccountMenuSection = Omit<NonNullable<AccountMenuContentValue['items']>[number], 'href'> & {
+  href: PageRef | string;
+};
 /** A section resolved for render. A null `href` is a destination the allowlist refused. */
 export type AccountMenuResolvedSection = {
   label: string;
-  href: string | null;
+  href: PageRef | string | null;
   external: boolean;
 };
 export type AccountMenuCurrent = {
@@ -74,15 +121,42 @@ export type AccountMenuListProps = Omit<ComponentPropsWithRef<'nav'>, 'children'
   /** Accessible name of the navigation landmark. */
   label?: string;
 };
+/** It renders the gate's loading look or a message, so it forwards no element props beyond a class. */
+export type AccountMenuIndexRedirectProps = {
+  /** Text announced while the first section opens. */
+  loadingLabel?: string;
+  /** What the root says when the list holds no section to open. */
+  emptyMessage?: string;
+  /** Merchant-authored copy, sliced from the page content entry; wins over the props field by field. */
+  $content?: ContentValue<typeof AccountMenuIndexRedirectContent>;
+  className?: string;
+};
+export type AccountMenuSignOutProps = {
+  /** The control's text. */
+  label?: string;
+  /** What the shopper is told when the sign-out did not happen. */
+  errorMessage?: string;
+  /** Merchant-authored copy, sliced from the layout content entry; wins over the props field by field. */
+  $content?: ContentValue<typeof AccountMenuSignOutContent>;
+  /** Injected by the compiler from the definition's `actions`. */
+  $actions?: ComponentActions;
+  className?: string;
+};
 export declare const AccountMenuRootDefinition: ComponentDefinition<AccountMenuRootProps>;
 export declare const AccountMenuListDefinition: ComponentDefinition<AccountMenuListProps>;
+export declare const AccountMenuIndexRedirectDefinition: ComponentDefinition<AccountMenuIndexRedirectProps>;
+export declare const AccountMenuSignOutDefinition: ComponentDefinition<AccountMenuSignOutProps>;
 /** The resolved section list and the current section. */
 export declare function useAccountMenu(): AccountMenuContextValue;
 export declare function AccountMenuRoot({ items, $content, className, children, ...props }: AccountMenuRootProps): import("react/jsx-runtime").JSX.Element;
 export declare function AccountMenuList({ label, className, ...props }: AccountMenuListProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function AccountMenuIndexRedirect({ loadingLabel, emptyMessage, $content, className }: Readonly<AccountMenuIndexRedirectProps>): import("react/jsx-runtime").JSX.Element;
+export declare function AccountMenuSignOut({ label, errorMessage, $content, $actions: $actionsProp, className }: Readonly<AccountMenuSignOutProps>): import("react/jsx-runtime").JSX.Element;
 export declare const AccountMenu: {
   Root: typeof AccountMenuRoot;
   List: typeof AccountMenuList;
+  IndexRedirect: typeof AccountMenuIndexRedirect;
+  SignOut: typeof AccountMenuSignOut;
 };
 //#endregion
 //# sourceMappingURL=account-menu.d.ts.map

package/dist/matter/account-menu/account-menu.js

@@ -3,10 +3,18 @@ import { defineComponent } from "../../core/dist/define-component.js";
 import { defineContentType } from "../../core/dist/define-content-type.js";
 import "../../core/dist/index.js";
 import { resolveSafeHref, resolveSiteRelativeHref } from "../../utils/safe-href.js";
+import { resolveStorefrontHref } from "../../sdk/navigation/resolve-storefront-href.js";
+import { useStorefrontContext } from "../../sdk/context/storefront-context.js";
+import { useRouteMap } from "../../sdk/navigation/route-map-provider.js";
+import { useStorefrontNavigation } from "../../sdk/navigation/use-storefront-navigation.js";
+import { useStorefrontRoute } from "../../sdk/navigation/use-storefront-route.js";
+import { useActionsOverride } from "../../sdk/actions/actions-override-context.js";
 import { NavigationLink } from "../../particles/navigation-link/navigation-link.js";
+import { declareSignOutIntent, useSignOutIntent, withdrawSignOutIntent } from "../account-access-gate/sign-out-intent.js";
+import { AccountAccessGateLoading } from "../account-access-gate/account-access-gate.js";
+import { clearSignOutFailure, reportSignOutFailure, useSignOutFailure } from "./sign-out-failure.js";
 import { createContext, useContext, useEffect, useLayoutEffect, useMemo, useRef } from "react";
-import { jsx } from "react/jsx-runtime";
-import { usePathname } from "next/navigation";
+import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/matter/account-menu/account-menu.tsx
 const useIsomorphicLayoutEffect = typeof window === "undefined" ? useEffect : useLayoutEffect;
 const AccountMenuContent = defineContentType({
@@ -46,6 +54,48 @@ const AccountMenuContent = defineContentType({
 		} }
 	}
 });
+const AccountMenuIndexRedirectContent = defineContentType({
+	id: "account-menu-index-redirect",
+	title: "Account Menu Index Redirect",
+	description: "What the account's root shows while it opens the first section, and when there is none to open.",
+	schema: {
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			loadingLabel: {
+				type: "string",
+				minLength: 1,
+				title: "Loading announcement"
+			},
+			emptyMessage: {
+				type: "string",
+				minLength: 1,
+				title: "No section message"
+			}
+		}
+	}
+});
+const AccountMenuSignOutContent = defineContentType({
+	id: "account-menu-sign-out",
+	title: "Account Menu Sign Out",
+	description: "The sign-out control in the account sidebar, and what it says when signing out fails.",
+	schema: {
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			label: {
+				type: "string",
+				minLength: 1,
+				title: "Sign-out label"
+			},
+			errorMessage: {
+				type: "string",
+				minLength: 1,
+				title: "Sign-out failed message"
+			}
+		}
+	}
+});
 const AccountMenuRootDefinition = defineComponent({
 	name: "AccountMenuRoot",
 	importPath: "@vtex/faststore/components",
@@ -78,37 +128,94 @@ const AccountMenuListDefinition = defineComponent({
 	} },
 	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."
 });
+const AccountMenuIndexRedirectDefinition = defineComponent({
+	name: "AccountMenuIndexRedirect",
+	importPath: "@vtex/faststore/components",
+	component: AccountMenuIndexRedirect,
+	content: AccountMenuIndexRedirectContent,
+	requiresContext: "account-menu",
+	editor: {
+		label: "Account Menu Index Redirect",
+		category: "navigation"
+	},
+	schema: {
+		loadingLabel: {
+			type: "string",
+			label: "Loading Announcement"
+		},
+		emptyMessage: {
+			type: "string",
+			default: "No account section is configured.",
+			label: "No Section Message"
+		}
+	},
+	guideline: "The whole of the account's root page: it replaces the current history entry with the first section of the merchant's list that stays in the account, skipping one marked external, one whose destination was refused or is not site-relative, and the root itself. It shows the access gate's loading look until the section opens. A list with no such section leaves the root terminal — no navigation, and the no-section message in its place — rather than falling back to the library's defaults. Place it alone on the account page, inside AccountMenuRoot and under AccountAccessGate, which the my-account layout provides; never on a section's own page, which it would navigate away from."
+});
+const AccountMenuSignOutDefinition = defineComponent({
+	name: "AccountMenuSignOut",
+	importPath: "@vtex/faststore/components",
+	component: AccountMenuSignOut,
+	content: AccountMenuSignOutContent,
+	actions: { session: ["logout"] },
+	editor: {
+		label: "Account Menu Sign Out",
+		category: "navigation"
+	},
+	schema: {
+		label: {
+			type: "string",
+			default: "Sign out",
+			label: "Label"
+		},
+		errorMessage: {
+			type: "string",
+			default: "We couldn't sign you out. Please try again.",
+			label: "Sign-out Failed Message"
+		}
+	},
+	guideline: "The account sidebar's way out: it dispatches $actions.session.logout, tells AccountAccessGate the departure is deliberate so the gate stands down instead of sending the shopper to sign in, and then loads the storefront home as a new document, which is what keeps the account out of the client router's cache. A logout that reports an error keeps the shopper on the account page with the failure message rather than landing a still-signed-in shopper on the home page. Compose it inside AccountMenuRoot beside AccountMenuList, under the gate the my-account layout provides — the back-forward cache is the gate's to revalidate, not this control's."
+});
 /**
 * The library's default set, the five sections the PRD names. Labels are English as an interim, until
 * the Localization cluster's catalog resolves them per locale. Their destinations only resolve in a
-* store that authored the account's route family.
+* store that declares the five standard pages.
 */
 const DEFAULT_SECTIONS = [
 	{
 		label: "Profile",
-		href: "/account/profile"
+		href: { standard: "profile" }
 	},
 	{
 		label: "Orders",
-		href: "/account/orders"
+		href: { standard: "orders" }
 	},
 	{
 		label: "Address",
-		href: "/account/address"
+		href: { standard: "address" }
 	},
 	{
 		label: "Payments",
-		href: "/account/payments"
+		href: { standard: "payments" }
 	},
 	{
 		label: "Security",
-		href: "/account/security"
+		href: { standard: "security" }
 	}
 ];
+const HOME_PAGE = { standard: "home" };
 function resolveSections(sections) {
 	const resolved = [];
 	sections.forEach((section, index) => {
 		if (section.label.trim().length === 0) return;
+		const external = section.external ?? false;
+		if (typeof section.href !== "string") {
+			resolved.push({
+				label: section.label,
+				href: section.href,
+				external
+			});
+			return;
+		}
 		const destination = resolveSafeHref(section.href);
 		if (!destination.safe) console.warn("[AccountMenu] section destination rejected", {
 			index,
@@ -117,7 +224,7 @@ function resolveSections(sections) {
 		resolved.push({
 			label: section.label,
 			href: destination.safe ? destination.href : null,
-			external: section.external ?? false
+			external
 		});
 	});
 	return resolved;
@@ -129,18 +236,33 @@ function normalizePath(value) {
 	return trimmed.length === 0 ? "/" : trimmed;
 }
 /**
+* The section's path inside the current binding, compared against the route's logical path: a
+* reference resolved without the base path, or an authored site-relative string as written. The menu
+* renders in a layout, outside the page's route marker, so the path is all it can compare. `null` for
+* an external section, a refused or absolute destination, and a reference that does not resolve: none
+* of them is a path of the account.
+*/
+function logicalPathOf(section, bindingId, routeMap) {
+	if (section.external || section.href === null) return null;
+	if (typeof section.href === "string") return resolveSiteRelativeHref(section.href).safe ? section.href : null;
+	return resolveStorefrontHref({
+		bindingId,
+		basePath: "/"
+	}, routeMap, section.href).href;
+}
+/**
 * The current section, matched on segment boundaries. Legacy matched by prefix and marked every
 * section whose path was a prefix of the current one; the longest match wins here, which keeps
 * exactly one section current and makes an exact match beat every ancestor without a second rule.
 */
-function findCurrent(sections, pathname) {
-	if (pathname === null) return null;
-	const path = normalizePath(pathname);
+function findCurrent(sections, logicalPath, bindingId, routeMap) {
+	const path = normalizePath(logicalPath);
 	let current = null;
 	let matchedLength = -1;
 	for (const [index, section] of sections.entries()) {
-		if (section.external || section.href === null || !resolveSiteRelativeHref(section.href).safe) continue;
-		const href = normalizePath(section.href);
+		const sectionPath = logicalPathOf(section, bindingId, routeMap);
+		if (sectionPath === null) continue;
+		const href = normalizePath(sectionPath);
 		if (href.length <= matchedLength) continue;
 		const exact = path === href;
 		const ancestor = href !== "/" && path.startsWith(`${href}/`);
@@ -154,6 +276,23 @@ function findCurrent(sections, pathname) {
 	return current;
 }
 /**
+* Where the account's root opens: the first section that stays in the account. An external entry would
+* eject the shopper from the account they just opened, and so would an absolute one the merchant did not
+* flag — the same site-relative reading `findCurrent` applies. The page itself is skipped too, in every
+* spelling that matches it, since replacing it with itself would leave the loading look up for good.
+*/
+function findIndexDestination(sections, current, bindingId, routeMap) {
+	const here = current?.match === "exact" ? sections[current.index] : void 0;
+	const herePath = here ? logicalPathOf(here, bindingId, routeMap) : null;
+	const hereNormalized = herePath === null ? null : normalizePath(herePath);
+	for (const section of sections) {
+		const sectionPath = logicalPathOf(section, bindingId, routeMap);
+		if (section.href === null || sectionPath === null || normalizePath(sectionPath) === hereNormalized) continue;
+		return section.href;
+	}
+	return null;
+}
+/**
 * `page` for the section itself, `true` for a page inside it. The distinction is kept rather than
 * collapsed because the sibling breadcrumb names the deep page as the current one, and two surfaces
 * announcing "current page" for two different things is worse than the menu claiming only its set.
@@ -173,15 +312,22 @@ function useAccountMenu() {
 	return value;
 }
 function AccountMenuRoot({ items, $content, className, children, ...props }) {
-	const pathname = usePathname();
+	const { path } = useStorefrontRoute();
+	const { bindingId } = useStorefrontContext();
+	const { routeMap } = useRouteMap();
 	const sections = $content?.items ?? items ?? DEFAULT_SECTIONS;
 	const value = useMemo(() => {
 		const resolved = resolveSections(sections);
 		return {
 			items: resolved,
-			current: findCurrent(resolved, pathname)
+			current: findCurrent(resolved, path, bindingId, routeMap)
 		};
-	}, [sections, pathname]);
+	}, [
+		sections,
+		path,
+		bindingId,
+		routeMap
+	]);
 	return /* @__PURE__ */ jsx(AccountMenuContext, {
 		value,
 		children: /* @__PURE__ */ jsx("div", {
@@ -236,11 +382,98 @@ function AccountMenuList({ label = "Account", className, ...props }) {
 		})
 	});
 }
+function AccountMenuIndexRedirect({ loadingLabel, emptyMessage = "No account section is configured.", $content, className }) {
+	const { items, current } = useAccountMenu();
+	const { bindingId } = useStorefrontContext();
+	const { routeMap } = useRouteMap();
+	const { replace } = useStorefrontNavigation();
+	const replacedRef = useRef(false);
+	const destination = findIndexDestination(items, current, bindingId, routeMap);
+	useEffect(() => {
+		if (destination === null || replacedRef.current) return;
+		replacedRef.current = true;
+		replace(destination);
+	}, [destination, replace]);
+	const entryLoadingLabel = $content?.loadingLabel?.trim() ? $content.loadingLabel : loadingLabel;
+	const entryEmptyMessage = $content?.emptyMessage?.trim() ? $content.emptyMessage : emptyMessage;
+	if (destination === null) return /* @__PURE__ */ jsx("p", {
+		className,
+		"data-fs-account-menu-index-redirect": "",
+		"data-fs-account-menu-index-redirect-empty": "",
+		children: entryEmptyMessage
+	});
+	return /* @__PURE__ */ jsx(AccountAccessGateLoading, {
+		className,
+		"data-fs-account-menu-index-redirect": "",
+		children: entryLoadingLabel
+	});
+}
+const DEFAULT_SIGN_OUT_LABEL = "Sign out";
+const DEFAULT_SIGN_OUT_ERROR = "We couldn't sign you out. Please try again.";
+/**
+* The first non-blank of the given values. The models' `minLength` is enforced by neither the runtime
+* slice nor the preflight, and a blank here is a nameless button or a silent failure.
+*/
+function firstAuthored(...values) {
+	return values.find((value) => value?.trim());
+}
+/** An absent handler or a rejection is a sign-out that did not happen, never one that did. */
+async function logOut(logout) {
+	if (!logout) return false;
+	try {
+		return (await logout()).length === 0;
+	} catch (error) {
+		console.error("[AccountMenuSignOut] logout rejected", error);
+		return false;
+	}
+}
+function AccountMenuSignOut({ label, errorMessage, $content, $actions: $actionsProp, className }) {
+	const $actions = useActionsOverride($actionsProp);
+	const { hrefFor } = useStorefrontNavigation();
+	const { basePath } = useStorefrontContext();
+	const signingOut = useSignOutIntent();
+	const failed = useSignOutFailure();
+	const attemptingRef = useRef(false);
+	async function handleClick() {
+		if (attemptingRef.current) return;
+		attemptingRef.current = true;
+		clearSignOutFailure();
+		declareSignOutIntent();
+		if (await logOut($actions?.session?.logout)) {
+			globalThis.location.assign(hrefFor(HOME_PAGE) ?? basePath);
+			return;
+		}
+		attemptingRef.current = false;
+		reportSignOutFailure();
+		withdrawSignOutIntent();
+	}
+	const entryLabel = firstAuthored($content?.label, label) ?? DEFAULT_SIGN_OUT_LABEL;
+	const entryErrorMessage = firstAuthored($content?.errorMessage, errorMessage) ?? DEFAULT_SIGN_OUT_ERROR;
+	return /* @__PURE__ */ jsxs("div", {
+		className,
+		"data-fs-account-menu-sign-out": "",
+		"data-fs-account-menu-sign-out-pending": signingOut ? "" : void 0,
+		children: [/* @__PURE__ */ jsx("button", {
+			type: "button",
+			onClick: handleClick,
+			disabled: signingOut,
+			"aria-busy": signingOut || void 0,
+			"data-fs-account-menu-sign-out-button": "",
+			children: entryLabel
+		}), failed ? /* @__PURE__ */ jsx("p", {
+			role: "alert",
+			"data-fs-account-menu-sign-out-error": "",
+			children: entryErrorMessage
+		}) : null]
+	});
+}
 const AccountMenu = {
 	Root: AccountMenuRoot,
-	List: AccountMenuList
+	List: AccountMenuList,
+	IndexRedirect: AccountMenuIndexRedirect,
+	SignOut: AccountMenuSignOut
 };
 //#endregion
-export { AccountMenu, AccountMenuContent, AccountMenuList, AccountMenuListDefinition, AccountMenuRoot, AccountMenuRootDefinition, useAccountMenu };
+export { AccountMenu, AccountMenuContent, AccountMenuIndexRedirect, AccountMenuIndexRedirectContent, AccountMenuIndexRedirectDefinition, AccountMenuList, AccountMenuListDefinition, AccountMenuRoot, AccountMenuRootDefinition, AccountMenuSignOut, AccountMenuSignOutContent, AccountMenuSignOutDefinition, useAccountMenu };
 
 //# sourceMappingURL=account-menu.js.map