@eifi1/ui-kit 0.43.0 → 0.44.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/dist/billing/provider-page.d.ts +9 -0
- package/dist/billing/provider-page.js.map +1 -1
- package/dist/eslint/index.js +1 -1
- package/dist/i18n/german.js +2 -2
- package/dist/i18n/german.js.map +1 -1
- package/dist/i18n/locales/en.js +3 -3
- package/dist/i18n/locales/en.js.map +2 -2
- package/dist/i18n/locales/fr.js +2 -2
- package/dist/i18n/locales/fr.js.map +1 -1
- package/dist/i18n/locales/it.js +1 -1
- package/dist/i18n/locales/it.js.map +1 -1
- package/dist/tour/tour-catalogue-labels.js +2 -2
- package/dist/tour/tour-catalogue-labels.js.map +1 -1
- package/dist/tour/tour-info.d.ts +2 -2
- package/dist/tour/tour-info.js.map +1 -1
- package/dist/tour/tour.d.ts +38 -2
- package/dist/tour/tour.js +40 -3
- package/dist/tour/tour.js.map +1 -1
- package/dist/tour/use-tour-progress.d.ts +66 -11
- package/dist/tour/use-tour-progress.js +44 -14
- package/dist/tour/use-tour-progress.js.map +1 -1
- package/dist/tour.d.ts +1 -1
- package/dist/tour.js +2 -1
- package/dist/tour.js.map +1 -1
- package/package.json +1 -1
- package/src/billing/provider-page.ts +9 -0
- package/src/i18n/german.ts +2 -2
- package/src/i18n/locales/en.ts +1 -1
- package/src/i18n/locales/fr.ts +2 -2
- package/src/i18n/locales/it.ts +1 -1
- package/src/tour/tour-catalogue-labels.ts +2 -2
- package/src/tour/tour-info.ts +2 -2
- package/src/tour/tour.tsx +84 -3
- package/src/tour/use-tour-progress.ts +124 -23
- package/src/tour.ts +2 -1
|
@@ -7,11 +7,11 @@ const DEFAULT_TOUR_CATALOGUE_LABELS = {
|
|
|
7
7
|
groupOption: (group, count) => `${group} (${count})`,
|
|
8
8
|
stateLabel: "Filter tours",
|
|
9
9
|
stateAll: (count) => `All (${count})`,
|
|
10
|
-
stateTodo: (count) => `
|
|
10
|
+
stateTodo: (count) => `Not taken (${count})`,
|
|
11
11
|
stateDone: (count) => `Completed (${count})`,
|
|
12
12
|
showing: (shown, total) => `Showing ${shown} of ${total} tours`,
|
|
13
13
|
noMatches: "No tour matches",
|
|
14
|
-
noMatchesHint: "Try another word, or clear the
|
|
14
|
+
noMatchesHint: "Try another word, or clear the filter.",
|
|
15
15
|
clearFilters: "Clear filters",
|
|
16
16
|
badgeNew: "New",
|
|
17
17
|
badgeUpdated: "Updated",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/tour/tour-catalogue-labels.ts"],"sourcesContent":["// The English words of `TourCatalogue` and `TourCatalogueCard` (docs/tours-harmonization.md\n// §3), in a module with no component code, like every `*-labels.ts` (0.34, KS U8).\n// keksdose's reviewed words (tour.* in its en.json) where it had them.\n\n/** The `tourCatalogue` namespace. Counts arrive as numbers, dates already formatted. */\nexport interface TourCatalogueLabels {\n /** The search box's name. */\n searchLabel: string;\n searchPlaceholder: string;\n /** The group select's name (keksdose: \"Topic\"). */\n groupLabel: string;\n /** The select's first option, with the count the other filters leave. */\n groupAll: (count: number) => string;\n /** A group's option: its title and its count. */\n groupOption: (group: string, count: number) => string;\n /** The all / to do / done toggle's name. */\n stateLabel: string;\n stateAll: (count: number) => string;\n stateTodo: (count: number) => string;\n stateDone: (count: number) => string;\n /** Under the filter bar while a filter is on. */\n showing: (shown: number, total: number) => string;\n noMatches: string;\n noMatchesHint: string;\n clearFilters: string;\n /** The NEW pill. */\n badgeNew: string;\n /** The pill on a tour reset by an update (§8). */\n badgeUpdated: string;\n /** A reset tour's line: the update's day (formatted) and its reason (§8); `reason` is\n * left out when the tour's update carries none. */\n resetOn: (date: string, reason?: string) => string;\n /** The points chip. */\n points: (count: number) => string;\n steps: (count: number) => string;\n /** The duration, in minutes. */\n duration: (minutes: number) => string;\n /** Completed, with the day (formatted). */\n completedOn: (date: string) => string;\n /** Completed without a date (kastlan's old id list, §6.2). */\n completed: string;\n /** Not taken yet — the state icon, for a reader. */\n notCompleted: string;\n markUndone: string;\n start: string;\n replay: string;\n}\n\nexport const DEFAULT_TOUR_CATALOGUE_LABELS: TourCatalogueLabels = {\n searchLabel: \"Search tours\",\n searchPlaceholder: \"Search tours…\",\n groupLabel: \"Topic\",\n groupAll: (count) => `All topics (${count})`,\n groupOption: (group, count) => `${group} (${count})`,\n stateLabel: \"Filter tours\",\n stateAll: (count) => `All (${count})`,\n stateTodo: (count) => `
|
|
1
|
+
{"version":3,"sources":["../../src/tour/tour-catalogue-labels.ts"],"sourcesContent":["// The English words of `TourCatalogue` and `TourCatalogueCard` (docs/tours-harmonization.md\n// §3), in a module with no component code, like every `*-labels.ts` (0.34, KS U8).\n// keksdose's reviewed words (tour.* in its en.json) where it had them.\n\n/** The `tourCatalogue` namespace. Counts arrive as numbers, dates already formatted. */\nexport interface TourCatalogueLabels {\n /** The search box's name. */\n searchLabel: string;\n searchPlaceholder: string;\n /** The group select's name (keksdose: \"Topic\"). */\n groupLabel: string;\n /** The select's first option, with the count the other filters leave. */\n groupAll: (count: number) => string;\n /** A group's option: its title and its count. */\n groupOption: (group: string, count: number) => string;\n /** The all / to do / done toggle's name. */\n stateLabel: string;\n stateAll: (count: number) => string;\n stateTodo: (count: number) => string;\n stateDone: (count: number) => string;\n /** Under the filter bar while a filter is on. */\n showing: (shown: number, total: number) => string;\n noMatches: string;\n noMatchesHint: string;\n clearFilters: string;\n /** The NEW pill. */\n badgeNew: string;\n /** The pill on a tour reset by an update (§8). */\n badgeUpdated: string;\n /** A reset tour's line: the update's day (formatted) and its reason (§8); `reason` is\n * left out when the tour's update carries none. */\n resetOn: (date: string, reason?: string) => string;\n /** The points chip. */\n points: (count: number) => string;\n steps: (count: number) => string;\n /** The duration, in minutes. */\n duration: (minutes: number) => string;\n /** Completed, with the day (formatted). */\n completedOn: (date: string) => string;\n /** Completed without a date (kastlan's old id list, §6.2). */\n completed: string;\n /** Not taken yet — the state icon, for a reader. */\n notCompleted: string;\n markUndone: string;\n start: string;\n replay: string;\n}\n\nexport const DEFAULT_TOUR_CATALOGUE_LABELS: TourCatalogueLabels = {\n searchLabel: \"Search tours\",\n searchPlaceholder: \"Search tours…\",\n groupLabel: \"Topic\",\n groupAll: (count) => `All topics (${count})`,\n groupOption: (group, count) => `${group} (${count})`,\n stateLabel: \"Filter tours\",\n stateAll: (count) => `All (${count})`,\n stateTodo: (count) => `Not taken (${count})`,\n stateDone: (count) => `Completed (${count})`,\n showing: (shown, total) => `Showing ${shown} of ${total} tours`,\n noMatches: \"No tour matches\",\n noMatchesHint: \"Try another word, or clear the filter.\",\n clearFilters: \"Clear filters\",\n badgeNew: \"New\",\n badgeUpdated: \"Updated\",\n resetOn: (date, reason) => (reason ? `Reset on ${date}: ${reason}` : `Reset on ${date}`),\n points: (count) => `+${count} pts`,\n steps: (count) => (count === 1 ? \"1 step\" : `${count} steps`),\n duration: (minutes) => `About ${minutes} min`,\n completedOn: (date) => `Completed on ${date}`,\n completed: \"Completed\",\n notCompleted: \"Not completed\",\n markUndone: \"Mark as not done\",\n start: \"Start\",\n replay: \"Replay\",\n};\n"],"mappings":";AAgDO,MAAM,gCAAqD;AAAA,EAChE,aAAa;AAAA,EACb,mBAAmB;AAAA,EACnB,YAAY;AAAA,EACZ,UAAU,CAAC,UAAU,eAAe,KAAK;AAAA,EACzC,aAAa,CAAC,OAAO,UAAU,GAAG,KAAK,KAAK,KAAK;AAAA,EACjD,YAAY;AAAA,EACZ,UAAU,CAAC,UAAU,QAAQ,KAAK;AAAA,EAClC,WAAW,CAAC,UAAU,cAAc,KAAK;AAAA,EACzC,WAAW,CAAC,UAAU,cAAc,KAAK;AAAA,EACzC,SAAS,CAAC,OAAO,UAAU,WAAW,KAAK,OAAO,KAAK;AAAA,EACvD,WAAW;AAAA,EACX,eAAe;AAAA,EACf,cAAc;AAAA,EACd,UAAU;AAAA,EACV,cAAc;AAAA,EACd,SAAS,CAAC,MAAM,WAAY,SAAS,YAAY,IAAI,KAAK,MAAM,KAAK,YAAY,IAAI;AAAA,EACrF,QAAQ,CAAC,UAAU,IAAI,KAAK;AAAA,EAC5B,OAAO,CAAC,UAAW,UAAU,IAAI,WAAW,GAAG,KAAK;AAAA,EACpD,UAAU,CAAC,YAAY,SAAS,OAAO;AAAA,EACvC,aAAa,CAAC,SAAS,gBAAgB,IAAI;AAAA,EAC3C,WAAW;AAAA,EACX,cAAc;AAAA,EACd,YAAY;AAAA,EACZ,OAAO;AAAA,EACP,QAAQ;AACV;","names":[]}
|
package/dist/tour/tour-info.d.ts
CHANGED
|
@@ -55,8 +55,8 @@ export interface TourGroup {
|
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
57
|
* Which tours are completed and when: tour id → the ISO timestamp of the completion, or
|
|
58
|
-
* `null` for one recorded without a date (kastlan's old id list, §6.2
|
|
59
|
-
* not a key is untaken.
|
|
58
|
+
* `null` for one recorded without a date (kastlan's old id list, §6.2; stored as `""`,
|
|
59
|
+
* §9.6.6). A tour that is not a key is untaken.
|
|
60
60
|
*/
|
|
61
61
|
export type TourCompletions = Readonly<Record<string, string | null>>;
|
|
62
62
|
/** What a reset reads of a tour (§8): the update's day, nothing else. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/tour/tour-info.ts"],"sourcesContent":["import type { ReactNode } from \"react\";\n\n/**\n * The tours an app offers, as data (docs/tours-harmonization.md §2.2, §6) — one list for\n * the tours page (`TourCatalogue`) and the top bar's `TourMenu`. The step lists stay the\n * app's own: the kit's engine runs them (`useTour().start`), and this describes them.\n *\n * The kit takes finished strings, never i18n keys (§6.3, kk K-1). Role- and data-gated\n * tours are filtered by the app before they come in; every count counts what it is given\n * (§6.3, kk K-2, ka F6).\n */\nexport interface TourInfo {\n /** Stable id: what `onLaunch` gets, the progress key, `?tour=`. */\n id: string;\n title: string;\n /** The one-liner under the title (and what the menu could carry). */\n description?: string;\n /** The longer account: which screens it visits, what it explains. Shown from `sm`. */\n about?: string;\n /** The tour's icon, drawn at 16px in the brand colour. */\n icon?: ReactNode;\n /** The id of its `TourGroup`: the section it is listed under. */\n group: string;\n /** The page the tour starts on — `TourMenu`'s \"On this page\". */\n route?: string;\n /** The day it shipped (ISO `YYYY-MM-DD`): what makes it NEW (§6.4). Without it, never NEW. */\n since?: string;\n /** The last update or fix (§8): a completion from before `updated.date` no longer counts. */\n updated?: TourUpdate;\n /** How many steps it has. Left out, the card shows no step count. */\n steps?: number;\n /** The points it awards (§6.1). Left out, the card draws no chip (never \"0 points\"). */\n points?: number;\n /** About how long it takes, in minutes — worded by the kit (\"About 3 min\", §6.5). */\n duration?: number;\n /** A chip beside NEW in the app's words — kastlan's practice mode (§6.5, ka F1). */\n badge?: ReactNode;\n}\n\n/** A tour's last update or fix (§8). One at a time: a later update replaces it. */\nexport interface TourUpdate {\n /** The day it shipped (ISO `YYYY-MM-DD`). */\n date: string;\n /** Why, in a short sentence in the app's words: \"The import screen moved; the tour follows it now.\"\n * Only shown (the card's reset line); the reset itself reads `date` alone, so an app that\n * keeps a reason KEY on its tour definitions passes those to `complete(tour)` as they are. */\n reason?: string;\n}\n\n/** A section of the tours page, in the app's words and order (§2.3). An empty one is hidden. */\nexport interface TourGroup {\n id: string;\n title: string;\n /** The help line under the heading. */\n help?: string;\n /** The heading's icon, drawn at 16px. */\n icon?: ReactNode;\n}\n\n/**\n * Which tours are completed and when: tour id → the ISO timestamp of the completion, or\n * `null` for one recorded without a date (kastlan's old id list, §6.2). A tour that is
|
|
1
|
+
{"version":3,"sources":["../../src/tour/tour-info.ts"],"sourcesContent":["import type { ReactNode } from \"react\";\n\n/**\n * The tours an app offers, as data (docs/tours-harmonization.md §2.2, §6) — one list for\n * the tours page (`TourCatalogue`) and the top bar's `TourMenu`. The step lists stay the\n * app's own: the kit's engine runs them (`useTour().start`), and this describes them.\n *\n * The kit takes finished strings, never i18n keys (§6.3, kk K-1). Role- and data-gated\n * tours are filtered by the app before they come in; every count counts what it is given\n * (§6.3, kk K-2, ka F6).\n */\nexport interface TourInfo {\n /** Stable id: what `onLaunch` gets, the progress key, `?tour=`. */\n id: string;\n title: string;\n /** The one-liner under the title (and what the menu could carry). */\n description?: string;\n /** The longer account: which screens it visits, what it explains. Shown from `sm`. */\n about?: string;\n /** The tour's icon, drawn at 16px in the brand colour. */\n icon?: ReactNode;\n /** The id of its `TourGroup`: the section it is listed under. */\n group: string;\n /** The page the tour starts on — `TourMenu`'s \"On this page\". */\n route?: string;\n /** The day it shipped (ISO `YYYY-MM-DD`): what makes it NEW (§6.4). Without it, never NEW. */\n since?: string;\n /** The last update or fix (§8): a completion from before `updated.date` no longer counts. */\n updated?: TourUpdate;\n /** How many steps it has. Left out, the card shows no step count. */\n steps?: number;\n /** The points it awards (§6.1). Left out, the card draws no chip (never \"0 points\"). */\n points?: number;\n /** About how long it takes, in minutes — worded by the kit (\"About 3 min\", §6.5). */\n duration?: number;\n /** A chip beside NEW in the app's words — kastlan's practice mode (§6.5, ka F1). */\n badge?: ReactNode;\n}\n\n/** A tour's last update or fix (§8). One at a time: a later update replaces it. */\nexport interface TourUpdate {\n /** The day it shipped (ISO `YYYY-MM-DD`). */\n date: string;\n /** Why, in a short sentence in the app's words: \"The import screen moved; the tour follows it now.\"\n * Only shown (the card's reset line); the reset itself reads `date` alone, so an app that\n * keeps a reason KEY on its tour definitions passes those to `complete(tour)` as they are. */\n reason?: string;\n}\n\n/** A section of the tours page, in the app's words and order (§2.3). An empty one is hidden. */\nexport interface TourGroup {\n id: string;\n title: string;\n /** The help line under the heading. */\n help?: string;\n /** The heading's icon, drawn at 16px. */\n icon?: ReactNode;\n}\n\n/**\n * Which tours are completed and when: tour id → the ISO timestamp of the completion, or\n * `null` for one recorded without a date (kastlan's old id list, §6.2; stored as `\"\"`,\n * §9.6.6). A tour that is not a key is untaken.\n */\nexport type TourCompletions = Readonly<Record<string, string | null>>;\n\n/** The calendar day of an ISO date or timestamp — `\"2026-10-17T08:00:00Z\"` → `\"2026-10-17\"`. */\nconst dayOf = (iso: string) => iso.slice(0, 10);\n\n/** What a reset reads of a tour (§8): the update's day, nothing else. */\ntype TourUpdated = { updated?: { date: string } | null };\n\nconst BARE_DAY = /^\\d{4}-\\d{2}-\\d{2}$/;\n\n/** The start of an ISO day (`YYYY-MM-DD`) in THIS device's time zone, as an instant. */\nfunction startOfLocalDay(day: string): number {\n const [y, m, d] = dayOf(day).split(\"-\").map(Number);\n return new Date(y, m - 1, d).getTime();\n}\n\n/** A completion as an instant: a timestamp as written, a bare day from its local start. */\nconst instantOf = (iso: string) => (BARE_DAY.test(iso) ? startOfLocalDay(iso) : Date.parse(iso));\n\n/**\n * Is this tour NEW for the person looking at it (§2.4, §6.4)? It shipped AFTER the\n * account was opened — compared by calendar day, so a tour shipped on the joining day was\n * already there to be found — and it is not taken yet. No `since`, or no `joined` date,\n * is never NEW: a pill that appears late is better than one that flickers, and a first\n * tour shipped with a feature should not flash NEW at every older account (KS, ka F7).\n *\n * `completed` is whether the tour was EVER completed — a tour reset by an update (§8) is\n * not NEW again; it carries the \"Updated\" pill instead, and `since` stays its first ship\n * date.\n */\nexport function isTourNew({\n since,\n joined,\n completed,\n}: {\n since?: string | null;\n /** The account's `created_at` (a date or a timestamp); unknown → never NEW. */\n joined?: string | null;\n completed?: boolean;\n}): boolean {\n return !!since && !!joined && dayOf(since) > dayOf(joined) && !completed;\n}\n\n/**\n * Was this completion reset by an update (§8)? True when the tour carries `updated` and\n * the completion happened BEFORE the update day began on this device — instants compared:\n * the completion's timestamp against the start of `updated.date` in local time, so one\n * taken at 00:30 in Zurich on the update day counts (its UTC day is the day before) — or\n * has no date at all, which predates any update. A tour never completed (`completedAt`\n * undefined) is never reset: for that person there is nothing to reset. The check itself\n * deletes nothing; a new `complete(tour)` replaces the old date.\n */\nexport function isTourReset(tour: TourUpdated, completedAt: string | null | undefined): boolean {\n if (completedAt === undefined || !tour.updated) return false;\n return completedAt === null || instantOf(completedAt) < startOfLocalDay(tour.updated.date);\n}\n\n/** Does this completion count — completed, and not reset by a later update (§8)? */\nexport function isTourDone(tour: TourUpdated, completedAt: string | null | undefined): boolean {\n return completedAt !== undefined && !isTourReset(tour, completedAt);\n}\n\n/**\n * How many of `tours` count as done (§8): the header's \"x of y\". A tour reset by an update\n * does not count until it is taken again, as on its card.\n */\nexport function doneCount(tours: readonly ({ id: string } & TourUpdated)[], completed: TourCompletions): number {\n return tours.filter((tour) => isTourDone(tour, completed[tour.id])).length;\n}\n\n/**\n * The points earned on `tours` (§6.1, §8): the sum of each done tour's `points`. A reset\n * tour's points are not earned until it is taken again; a tour without points adds none.\n */\nexport function earnedPoints(\n tours: readonly ({ id: string; points?: number | null } & TourUpdated)[],\n completed: TourCompletions,\n): number {\n return tours.reduce((sum, tour) => sum + (isTourDone(tour, completed[tour.id]) ? (tour.points ?? 0) : 0), 0);\n}\n"],"mappings":";AAmEA,MAAM,QAAQ,CAAC,QAAgB,IAAI,MAAM,GAAG,EAAE;AAK9C,MAAM,WAAW;AAGjB,SAAS,gBAAgB,KAAqB;AAC5C,QAAM,CAAC,GAAG,GAAG,CAAC,IAAI,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,IAAI,MAAM;AAClD,SAAO,IAAI,KAAK,GAAG,IAAI,GAAG,CAAC,EAAE,QAAQ;AACvC;AAGA,MAAM,YAAY,CAAC,QAAiB,SAAS,KAAK,GAAG,IAAI,gBAAgB,GAAG,IAAI,KAAK,MAAM,GAAG;AAavF,SAAS,UAAU;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AACF,GAKY;AACV,SAAO,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,MAAM,KAAK,IAAI,MAAM,MAAM,KAAK,CAAC;AACjE;AAWO,SAAS,YAAY,MAAmB,aAAiD;AAC9F,MAAI,gBAAgB,UAAa,CAAC,KAAK,QAAS,QAAO;AACvD,SAAO,gBAAgB,QAAQ,UAAU,WAAW,IAAI,gBAAgB,KAAK,QAAQ,IAAI;AAC3F;AAGO,SAAS,WAAW,MAAmB,aAAiD;AAC7F,SAAO,gBAAgB,UAAa,CAAC,YAAY,MAAM,WAAW;AACpE;AAMO,SAAS,UAAU,OAAkD,WAAoC;AAC9G,SAAO,MAAM,OAAO,CAAC,SAAS,WAAW,MAAM,UAAU,KAAK,EAAE,CAAC,CAAC,EAAE;AACtE;AAMO,SAAS,aACd,OACA,WACQ;AACR,SAAO,MAAM,OAAO,CAAC,KAAK,SAAS,OAAO,WAAW,MAAM,UAAU,KAAK,EAAE,CAAC,IAAK,KAAK,UAAU,IAAK,IAAI,CAAC;AAC7G;","names":[]}
|
package/dist/tour/tour.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { ReactNode } from "react";
|
|
2
2
|
import { type LabelOverride } from "../i18n/kit-labels.js";
|
|
3
3
|
import { DEFAULT_TOUR_LABELS } from "./tour-labels.js";
|
|
4
|
+
import type { TourInfo } from "./tour-info.js";
|
|
5
|
+
import { type UseTourProgressOptions } from "./use-tour-progress.js";
|
|
4
6
|
/**
|
|
5
7
|
* `start`/`end` follow the reading direction (`end` is the right side in LTR and the
|
|
6
8
|
* left side in RTL) and are what a translated app wants. `left`/`right` stay physical
|
|
@@ -45,15 +47,32 @@ export interface TourLabels {
|
|
|
45
47
|
export { DEFAULT_TOUR_LABELS };
|
|
46
48
|
interface StartOptions {
|
|
47
49
|
/** Stable id of the tour, surfaced as `activeId` so the app can mirror it to
|
|
48
|
-
* the URL (deep-link / evaluation tracking) and record completion.
|
|
50
|
+
* the URL (deep-link / evaluation tracking) and record completion. Defaults to
|
|
51
|
+
* `tour.id`. */
|
|
49
52
|
id?: string;
|
|
53
|
+
/** The tour being started, as the app lists it (docs/tours-harmonization.md §9.6.1).
|
|
54
|
+
* When its last step is finished, the provider records the completion in its
|
|
55
|
+
* `progress` and hands this to `onComplete`. */
|
|
56
|
+
tour?: TourInfo;
|
|
50
57
|
/** Start at this step index instead of 0 (clamped) — for URL/deep-link resume. */
|
|
51
58
|
startIndex?: number;
|
|
52
59
|
/** Fires synchronously when the tour starts (e.g. enable a mock interceptor). */
|
|
53
60
|
onStart?: () => void;
|
|
61
|
+
/** After the last step: runs after the provider's progress write and `onComplete`. */
|
|
54
62
|
onFinish?: () => void;
|
|
55
63
|
onSkip?: () => void;
|
|
56
64
|
}
|
|
65
|
+
/** What `TourProvider`'s `onComplete` learns besides the tour (§9.1, §9.6). */
|
|
66
|
+
export interface TourCompletion {
|
|
67
|
+
/**
|
|
68
|
+
* `true` when the completion counts anew (the first time, or the first time after the
|
|
69
|
+
* tour's update, §8): the moment for the app's points toast. `false` for a replay, and
|
|
70
|
+
* when the stored text is in an old shape no `migrate` reads: nothing is overwritten
|
|
71
|
+
* then, and the error goes to `console.error` (keksdose B-1). `undefined` when the provider has no `progress` or the start carried no `tour`, so
|
|
72
|
+
* nothing was recorded.
|
|
73
|
+
*/
|
|
74
|
+
awarded: boolean | undefined;
|
|
75
|
+
}
|
|
57
76
|
interface TourContextValue {
|
|
58
77
|
active: boolean;
|
|
59
78
|
/** Id of the running tour (from {@link StartOptions.id}), else null. */
|
|
@@ -102,8 +121,25 @@ export declare function useTourOptional(): TourContextValue | null;
|
|
|
102
121
|
* Mount once inside the router; start a tour from anywhere via {@link useTour},
|
|
103
122
|
* which also exposes step control (`next`/`prev`/`goToStep`) and the current
|
|
104
123
|
* `index`/`total` for URL mirroring, `awaitClick` and deep-link resume.
|
|
124
|
+
*
|
|
125
|
+
* **Completion in one place** (docs/tours-harmonization.md §9.6): give the provider the
|
|
126
|
+
* app's `progress` (the same `{storageKey, migrate}` as `useTourProgress`) and start each
|
|
127
|
+
* tour with `start(steps, {tour})`. When the last step is finished the provider writes the
|
|
128
|
+
* completion ONCE, through the store every `useTourProgress` reader of the key shares
|
|
129
|
+
* (never a second copy), then calls `onComplete(tour, {awarded})`, then the start's own
|
|
130
|
+
* `onFinish`. A skip or `stop()` records nothing and calls neither. The app removes its
|
|
131
|
+
* own `complete()` from `onFinish`, or that second write answers `false`.
|
|
132
|
+
*
|
|
133
|
+
* Both props are optional: without `progress` or a `tour` on the start, `onComplete`
|
|
134
|
+
* still fires, with `awarded: undefined` (and `tour` as given, possibly `undefined`). A
|
|
135
|
+
* new `storageKey` (an account switch on a shared PC) is followed on the next
|
|
136
|
+
* completion, without a remount.
|
|
105
137
|
*/
|
|
106
|
-
export declare function TourProvider({ children, labels, }: {
|
|
138
|
+
export declare function TourProvider({ children, labels, progress, onComplete, }: {
|
|
107
139
|
children: ReactNode;
|
|
108
140
|
labels?: LabelOverride<TourLabels>;
|
|
141
|
+
/** The app's tour progress: the same options its `useTourProgress` readers use. */
|
|
142
|
+
progress?: UseTourProgressOptions;
|
|
143
|
+
/** A tour's last step was finished; see {@link TourCompletion}. */
|
|
144
|
+
onComplete?: (tour: TourInfo | undefined, completion: TourCompletion) => void;
|
|
109
145
|
}): import("react").JSX.Element;
|
package/dist/tour/tour.js
CHANGED
|
@@ -17,6 +17,7 @@ import { useFocusTrap } from "../hooks/use-focus-trap.js";
|
|
|
17
17
|
import { sameRect } from "../hooks/use-anchored-rect.js";
|
|
18
18
|
import { dirOf, horizontalStep } from "../lib/direction.js";
|
|
19
19
|
import { DEFAULT_TOUR_LABELS } from "./tour-labels.js";
|
|
20
|
+
import { completeStored, rememberMigrate } from "./use-tour-progress.js";
|
|
20
21
|
const TourContext = createContext(null);
|
|
21
22
|
function useTour() {
|
|
22
23
|
const ctx = useContext(TourContext);
|
|
@@ -26,15 +27,32 @@ function useTour() {
|
|
|
26
27
|
function useTourOptional() {
|
|
27
28
|
return useContext(TourContext);
|
|
28
29
|
}
|
|
30
|
+
function devWarnings() {
|
|
31
|
+
return Boolean(import.meta.env?.DEV) && !import.meta.env?.VITEST;
|
|
32
|
+
}
|
|
29
33
|
function TourProvider({
|
|
30
34
|
children,
|
|
31
|
-
labels
|
|
35
|
+
labels,
|
|
36
|
+
progress,
|
|
37
|
+
onComplete
|
|
32
38
|
}) {
|
|
33
39
|
const merged = useKitLabels("tour", DEFAULT_TOUR_LABELS, labels);
|
|
34
40
|
const [steps, setSteps] = useState(null);
|
|
35
41
|
const [index, setIndex] = useState(0);
|
|
36
42
|
const [activeId, setActiveId] = useState(null);
|
|
37
43
|
const optsRef = useRef({});
|
|
44
|
+
const progressRef = useRef(progress);
|
|
45
|
+
const onCompleteRef = useRef(onComplete);
|
|
46
|
+
useLayoutEffect(() => {
|
|
47
|
+
progressRef.current = progress;
|
|
48
|
+
onCompleteRef.current = onComplete;
|
|
49
|
+
});
|
|
50
|
+
const storageKey = progress?.storageKey;
|
|
51
|
+
const migrate = progress?.migrate;
|
|
52
|
+
useLayoutEffect(() => {
|
|
53
|
+
if (storageKey !== void 0) rememberMigrate(storageKey, migrate);
|
|
54
|
+
}, [storageKey, migrate]);
|
|
55
|
+
const warnedNoTourRef = useRef(false);
|
|
38
56
|
const stepsRef = useRef(null);
|
|
39
57
|
const indexRef = useRef(0);
|
|
40
58
|
useLayoutEffect(() => {
|
|
@@ -47,7 +65,7 @@ function TourProvider({
|
|
|
47
65
|
optsRef.current = opts ?? {};
|
|
48
66
|
optsRef.current.onStart?.();
|
|
49
67
|
setIndex(Math.min(Math.max(0, opts?.startIndex ?? 0), Math.max(0, s.length - 1)));
|
|
50
|
-
setActiveId(opts?.id ?? null);
|
|
68
|
+
setActiveId(opts?.id ?? opts?.tour?.id ?? null);
|
|
51
69
|
setSteps(s);
|
|
52
70
|
}, []);
|
|
53
71
|
const stop = useCallback(() => {
|
|
@@ -55,7 +73,26 @@ function TourProvider({
|
|
|
55
73
|
setActiveId(null);
|
|
56
74
|
}, []);
|
|
57
75
|
const finish = useCallback(() => {
|
|
58
|
-
|
|
76
|
+
if (!stepsRef.current) return;
|
|
77
|
+
stepsRef.current = null;
|
|
78
|
+
const { tour, onFinish } = optsRef.current;
|
|
79
|
+
const store = progressRef.current;
|
|
80
|
+
let awarded;
|
|
81
|
+
if (store && tour) {
|
|
82
|
+
try {
|
|
83
|
+
awarded = completeStored(store.storageKey, store.migrate, tour);
|
|
84
|
+
} catch (error) {
|
|
85
|
+
console.error(error);
|
|
86
|
+
awarded = false;
|
|
87
|
+
}
|
|
88
|
+
} else if (store && !tour && devWarnings() && !warnedNoTourRef.current) {
|
|
89
|
+
warnedNoTourRef.current = true;
|
|
90
|
+
console.warn(
|
|
91
|
+
"[ui-kit] TourProvider has `progress`, but a finished tour's start carried no `tour`: nothing was recorded and `awarded` is undefined. Start it with `start(steps, { tour })`."
|
|
92
|
+
);
|
|
93
|
+
}
|
|
94
|
+
onCompleteRef.current?.(tour, { awarded });
|
|
95
|
+
onFinish?.();
|
|
59
96
|
setSteps(null);
|
|
60
97
|
setActiveId(null);
|
|
61
98
|
}, []);
|
package/dist/tour/tour.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/tour/tour.tsx"],"sourcesContent":["import {\n createContext,\n useCallback,\n useContext,\n useEffect,\n useLayoutEffect,\n useRef,\n useState,\n} from \"react\";\nimport type { CSSProperties, ReactNode } from \"react\";\nimport { createPortal } from \"react-dom\";\nimport { cn } from \"../lib/cn\";\nimport { useKitLabels, type LabelOverride } from \"../i18n/kit-labels\";\nimport { Button } from \"../components/button\";\nimport { useFocusTrap } from \"../hooks/use-focus-trap\";\nimport { sameRect } from \"../hooks/use-anchored-rect\";\nimport { dirOf, horizontalStep } from \"../lib/direction\";\nimport type { Direction } from \"../lib/direction\";\nimport { DEFAULT_TOUR_LABELS } from \"./tour-labels\";\n\n/**\n * `start`/`end` follow the reading direction (`end` is the right side in LTR and the\n * left side in RTL) and are what a translated app wants. `left`/`right` stay physical\n * for the steps that genuinely mean a screen side.\n */\nexport type TourPlacement = \"top\" | \"right\" | \"bottom\" | \"left\" | \"start\" | \"end\" | \"center\";\n\nexport interface TourStep {\n /** CSS selector for the element to spotlight. Omit for a centered step\n * (welcome/finish). If the target isn't found/visible, the step centers. */\n target?: string;\n title: string;\n body: ReactNode;\n /** Extra footer content, e.g. a \"load sample data\" shortcut. */\n action?: ReactNode;\n /** Spotlight padding around the target, px (default 8). */\n padding?: number;\n /** Where the card sits relative to the target. Omit for auto placement\n * (below → above → centered). \"center\" ignores the target and centers on\n * screen. \"start\"/\"end\" are the logical sides and flip in RTL; \"left\"/\"right\"\n * are physical. An explicit side flips to the opposite side if it would\n * overflow, then clamps into the viewport. */\n placement?: TourPlacement;\n /** Advance only when the user clicks the spotlighted target itself (not the\n * card's Next button). Requires `target`: the real control's own handler runs\n * first, then the tour steps forward on a microtask. The spotlight hole stays\n * click-through to the target; the rest of the page does not. */\n awaitClick?: boolean;\n /** Runs before the step is shown — e.g. navigate to a route, open a panel.\n * May be async; the step waits for it, then locates the target. */\n beforeStep?: () => void | Promise<void>;\n}\n\nexport interface TourLabels {\n next: string;\n back: string;\n skip: string;\n done: string;\n /** Shown in place of the Next button on an `awaitClick` step. */\n awaitClickHint: string;\n /** Step counter, e.g. (2, 7) => \"2 / 7\". */\n step: (current: number, total: number) => string;\n}\n\n// Defined in ./tour-labels, which holds no component code (0.34, KS U8).\nexport { DEFAULT_TOUR_LABELS };\n\ninterface StartOptions {\n /** Stable id of the tour, surfaced as `activeId` so the app can mirror it to\n * the URL (deep-link / evaluation tracking) and record completion. */\n id?: string;\n /** Start at this step index instead of 0 (clamped) — for URL/deep-link resume. */\n startIndex?: number;\n /** Fires synchronously when the tour starts (e.g. enable a mock interceptor). */\n onStart?: () => void;\n onFinish?: () => void;\n onSkip?: () => void;\n}\n\ninterface TourContextValue {\n active: boolean;\n /** Id of the running tour (from {@link StartOptions.id}), else null. */\n activeId: string | null;\n /** Start a tour with the given steps. */\n start: (steps: TourStep[], opts?: StartOptions) => void;\n /** End the current tour (no callbacks fire). */\n stop: () => void;\n /** Advance one step; past the last step it finishes the tour (fires onFinish). */\n next: () => void;\n /** Go back one step (no-op on the first). */\n prev: () => void;\n /** Jump to a step by index, clamped to range — e.g. for URL/deep-link resume. */\n goToStep: (index: number) => void;\n /** Current step (0-based; 0 while inactive). */\n index: number;\n /** Total steps (0 while inactive). */\n total: number;\n}\n\nconst TourContext = createContext<TourContextValue | null>(null);\n\nexport function useTour(): TourContextValue {\n const ctx = useContext(TourContext);\n if (!ctx) throw new Error(\"useTour must be used within <TourProvider>\");\n return ctx;\n}\n\n/**\n * The tour engine if it is there, `null` if it is not — for a control that is a\n * DECORATION rather than a participant.\n *\n * {@link useTour}'s throw is correct and stays: a component that runs a tour cannot do\n * its job without the provider, and failing loudly is how that gets fixed. But the\n * throw's blast radius is whatever error boundary is above it, and for a launcher in\n * the app shell that is the whole app.\n *\n * Keksdose feedback dev#524 is what that costs: an `@hb/ui` module was edited while a\n * dev server was running, vite re-evaluated it, and the module's freshly created\n * context object was no longer the one the mounted provider was providing. React's\n * `useContext` then answers `null` for a provider that is, structurally, right there —\n * and the top bar's tour menu took the entire shell down with it. **Build-time module\n * graphs cannot produce that**, so it is a development-only failure; a menu that\n * disappears for a second is the proportionate response to it either way.\n *\n * Only for controls that can honestly render nothing. If a component would show a\n * broken half of itself without the tour, it wants {@link useTour}.\n */\nexport function useTourOptional(): TourContextValue | null {\n return useContext(TourContext);\n}\n\n/**\n * Provides the guided-tour engine: a dimmed spotlight overlay + step card driven\n * by a list of {@link TourStep}s. Domain-free — the app supplies the steps (copy,\n * selectors, per-step navigation, placement) and the translated {@link TourLabels}.\n * Mount once inside the router; start a tour from anywhere via {@link useTour},\n * which also exposes step control (`next`/`prev`/`goToStep`) and the current\n * `index`/`total` for URL mirroring, `awaitClick` and deep-link resume.\n */\nexport function TourProvider({\n children,\n labels,\n}: {\n children: ReactNode;\n labels?: LabelOverride<TourLabels>;\n}) {\n // `labels` over the provider's `tour` over English. Resolved once here and handed\n // down: the step card is portalled, but context crosses portals anyway — this is\n // simply the one place that already owned the merge.\n const merged = useKitLabels(\"tour\", DEFAULT_TOUR_LABELS, labels);\n const [steps, setSteps] = useState<TourStep[] | null>(null);\n const [index, setIndex] = useState(0);\n const [activeId, setActiveId] = useState<string | null>(null);\n const optsRef = useRef<StartOptions>({});\n // Live mirrors so the step-control callbacks can stay stable (identity-safe for\n // consumers) while still reading the current steps/index. Synced in a layout\n // effect — after the commit, before paint and before any passive effect or event\n // can call them — rather than written during render.\n const stepsRef = useRef<TourStep[] | null>(null);\n const indexRef = useRef(0);\n useLayoutEffect(() => {\n stepsRef.current = steps;\n indexRef.current = index;\n }, [steps, index]);\n const active = !!steps && steps.length > 0;\n const total = steps?.length ?? 0;\n\n const start = useCallback((s: TourStep[], opts?: StartOptions) => {\n optsRef.current = opts ?? {};\n optsRef.current.onStart?.();\n setIndex(Math.min(Math.max(0, opts?.startIndex ?? 0), Math.max(0, s.length - 1)));\n setActiveId(opts?.id ?? null);\n setSteps(s);\n }, []);\n const stop = useCallback(() => {\n setSteps(null);\n setActiveId(null);\n }, []);\n const finish = useCallback(() => {\n optsRef.current.onFinish?.();\n setSteps(null);\n setActiveId(null);\n }, []);\n const skip = useCallback(() => {\n optsRef.current.onSkip?.();\n setSteps(null);\n setActiveId(null);\n }, []);\n\n const goToStep = useCallback((i: number) => {\n const len = stepsRef.current?.length ?? 0;\n if (len === 0) return;\n setIndex(Math.min(Math.max(0, i), len - 1));\n }, []);\n const next = useCallback(() => {\n const len = stepsRef.current?.length ?? 0;\n if (len === 0) return;\n if (indexRef.current >= len - 1) finish();\n else setIndex(indexRef.current + 1);\n }, [finish]);\n const prev = useCallback(() => {\n if (indexRef.current > 0) setIndex(indexRef.current - 1);\n }, []);\n\n return (\n <TourContext.Provider value={{ active, activeId, start, stop, next, prev, goToStep, index, total }}>\n {children}\n {active && (\n <TourOverlay\n steps={steps!}\n index={index}\n labels={merged}\n onNext={next}\n onPrev={prev}\n onSkip={skip}\n />\n )}\n </TourContext.Provider>\n );\n}\n\ninterface Rect {\n top: number;\n left: number;\n width: number;\n height: number;\n}\n\nfunction isVisible(el: Element): boolean {\n // A non-zero box already rules out display:none on the element or any ancestor\n // (an unrendered element measures 0x0). We deliberately do NOT test\n // offsetParent: it is null for position:fixed elements even when fully visible,\n // which made the mobile bottom-nav bar (fixed) un-highlightable on mobile\n // (feedback #313). visibility:hidden keeps a box, so check it explicitly.\n const r = el.getBoundingClientRect();\n if (r.width <= 0 || r.height <= 0) return false;\n const style = getComputedStyle(el);\n return style.visibility !== \"hidden\" && style.display !== \"none\";\n}\n\n// The first VISIBLE element matching the selector, not merely the first in DOM\n// order. This lets a step target the same control across layouts with one\n// combined selector — e.g. the desktop sidebar link AND the mobile bottom-bar\n// link — where the off-layout copy is present but `display:none` (feedback\n// #313). Returns null while none is visible so the finder keeps retrying.\nfunction queryVisibleTarget(selector: string): Element | null {\n const els = document.querySelectorAll(selector);\n for (const el of els) {\n if (isVisible(el)) return el;\n }\n return null;\n}\n\nfunction rectOf(el: Element): Rect {\n const r = el.getBoundingClientRect();\n return { top: r.top, left: r.left, width: r.width, height: r.height };\n}\n\n/**\n * What the finder established for ONE step: where its target is (`null` = no target,\n * or not on the page), and the reading direction the card takes from it.\n *\n * It carries the step it was found for, and the overlay only believes it for that\n * step — which is the whole fix for keksdose's tours audit 2026-10-02, §1.0 A (\"stale\n * spotlight on the step after a spotlighted one\", 15 steps in 16 tours, desktop and\n * phone, mouse and keyboard). When step N spotlit a target and step N+1 had none (or\n * its anchor was missing), N+1 kept N's hole and parked its card beside it, so a\n * centred \"You're all set\" read as pointing at the Import & Export link; Back→Next kept\n * it for as long as anyone watched.\n *\n * The overlay used to hold `rect` and `ready` as separate states and reset them\n * DURING RENDER when the step changed. React 19 does not keep a render-phase update\n * while an earlier, lower-priority update to the same hook is still queued — it only\n * writes the result to the base state \"unless the queue is empty\" — and the follow\n * interval below queues exactly such an update every 250 ms (eagerly bailed out because\n * the rect had not moved, but left in the queue for rebasing). So the click's render\n * showed the reset, and the very next render (the finder saying \"ready\") re-based on\n * the old rect. A deep link was fine because nothing had queued anything yet.\n *\n * Keying the result to its step does not depend on any of that ordering: a rect found\n * for another step is not this step's rect, whatever the queue does with it, and a\n * missing anchor reads as \"no target\" instead of as the last thing that was lit.\n */\ninterface Located {\n index: number;\n step: TourStep;\n rect: Rect | null;\n dir: Direction;\n}\n\nfunction TourOverlay({\n steps,\n index,\n labels,\n onNext,\n onPrev,\n onSkip,\n}: {\n steps: TourStep[];\n index: number;\n labels: TourLabels;\n onNext: () => void;\n onPrev: () => void;\n onSkip: () => void;\n}) {\n const step = steps[index];\n const isFirst = index === 0;\n const isLast = index === steps.length - 1;\n // A new step starts unlocated: whatever was found for another step (see `Located`)\n // is ignored, so the overlay renders nothing until the effect below has located THIS\n // step, and never the previous step's spotlight.\n const [located, setLocated] = useState<Located | null>(null);\n const current = located !== null && located.index === index && located.step === step ? located : null;\n const ready = current !== null;\n const rect = current?.rect ?? null;\n // The overlay is portalled to <body>, out of whatever `dir` subtree the app set, so it\n // takes the direction of the element it spotlights (the document's for a centered\n // step). Arrow keys and start/end placement read it.\n const dir: Direction = current?.dir ?? \"ltr\";\n const rootRef = useRef<HTMLDivElement>(null);\n\n // Run beforeStep, then locate the target (retrying across route/render lag).\n useEffect(() => {\n let cancelled = false;\n let raf = 0;\n // `null` = untargeted, or the finder gave up → the card centres, with no hole.\n const settle = (el: Element | null) =>\n setLocated({ index, step, rect: el ? rectOf(el) : null, dir: dirOf(el) });\n void (async () => {\n await step.beforeStep?.();\n if (cancelled) return;\n if (!step.target) {\n settle(null);\n return;\n }\n let tries = 0;\n const find = () => {\n if (cancelled) return;\n const el = queryVisibleTarget(step.target!);\n if (el) {\n el.scrollIntoView({ block: \"center\", behavior: \"smooth\" });\n settle(el);\n return;\n }\n if (tries++ < 45) raf = requestAnimationFrame(find);\n else settle(null); // give up → render centered\n };\n find();\n })();\n return () => {\n cancelled = true;\n cancelAnimationFrame(raf);\n };\n }, [index, step]);\n\n // Follow the target as the page scrolls / reflows — only once THIS step is located,\n // and only into this step's result.\n useEffect(() => {\n if (!step.target) return;\n const update = () => {\n const el = queryVisibleTarget(step.target!);\n if (el) {\n const next = rectOf(el);\n setLocated((prev) =>\n prev && prev.index === index && prev.step === step && !sameRect(prev.rect, next)\n ? { ...prev, rect: next }\n : prev,\n );\n }\n };\n window.addEventListener(\"scroll\", update, true);\n window.addEventListener(\"resize\", update);\n const id = window.setInterval(update, 250);\n return () => {\n window.removeEventListener(\"scroll\", update, true);\n window.removeEventListener(\"resize\", update);\n clearInterval(id);\n };\n }, [index, step]);\n\n // awaitClick: advance when the *real* target is clicked. The spotlight hole is\n // click-through (see the shields in the render below) so the element's own\n // handler runs first; we step forward on the next macrotask.\n //\n // Re-armed when the target turns up after the finder gave up (the follow effect\n // lights it late): the card swaps Next for the \"click the highlighted element\" hint\n // as soon as there is a rect, so the click must work from that moment too.\n const spotted = rect !== null;\n useEffect(() => {\n if (!ready || !spotted || !step.awaitClick || !step.target) return;\n const el = queryVisibleTarget(step.target);\n if (!el) return;\n const onClick = () => window.setTimeout(() => onNext(), 0);\n el.addEventListener(\"click\", onClick, { once: true });\n return () => el.removeEventListener(\"click\", onClick);\n }, [ready, spotted, index, step, onNext]);\n\n // Keyboard: Esc skips, Enter and the reading-direction arrow advance (→ in LTR,\n // ← in RTL), the other arrow goes back. On awaitClick steps Enter is ignored (it\n // would fire the target's click AND advance) — the forward arrow stays as an escape\n // hatch.\n //\n // Enter on a focused control belongs to that control. This used to advance from\n // anywhere, so Enter on a focused Skip or Back ran the button's own click AND stepped\n // forward: Back moved nowhere, Skip skipped and then called `next` on a dead tour.\n // The same goes for arrows in a text field a step's `action` might contain.\n useEffect(() => {\n const onKey = (e: KeyboardEvent) => {\n if (e.key === \"Escape\") {\n onSkip();\n return;\n }\n if (e.key === \"Enter\") {\n if (step.awaitClick || ownsKey(e.target, \"Enter\")) return;\n e.preventDefault();\n onNext();\n return;\n }\n if (ownsKey(e.target, e.key)) return;\n // The overlay root carries `dir`; before it paints, the document's answers.\n const delta = horizontalStep(e.key, rootRef.current);\n if (delta === 1) {\n e.preventDefault();\n onNext();\n } else if (delta === -1) {\n if (!isFirst) onPrev();\n }\n };\n document.addEventListener(\"keydown\", onKey);\n return () => document.removeEventListener(\"keydown\", onKey);\n }, [isFirst, step, onNext, onPrev, onSkip]);\n\n if (!ready) return null;\n\n const pad = step.padding ?? 8;\n const spot: Rect | null = rect\n ? { top: rect.top - pad, left: rect.left - pad, width: rect.width + pad * 2, height: rect.height + pad * 2 }\n : null;\n\n // `aria-modal` promises the page behind is out of reach, and the card's focus trap\n // keeps that promise for the keyboard. The pointer used to get no such treatment: the\n // root is `pointer-events-none` so that the spotlight hole can stay live for\n // `awaitClick`, and the scrim is a box-shadow, which takes no clicks — so every\n // control on the dimmed page stayed clickable. Four shields now tile the viewport\n // around the hole: the page is blocked, the card and the spotlighted target are not.\n // Keeping `aria-modal` (rather than dropping it) is the coherent half: the tour\n // really is modal — focus is trapped and Esc/Skip is the way out.\n return createPortal(\n <div\n ref={rootRef}\n className=\"pointer-events-none fixed inset-0 z-[60]\"\n role=\"dialog\"\n aria-modal=\"true\"\n aria-label={step.title}\n dir={dir}\n >\n {spot && <SpotlightShields spot={spot} />}\n {spot ? (\n <div\n className=\"pointer-events-none fixed rounded-lg transition-all duration-200 ease-out\"\n style={{\n top: spot.top,\n left: spot.left,\n width: spot.width,\n height: spot.height,\n // A two-tone frame, not a single translucent ring.\n //\n // The old treatment was `ring-2 ring-white/80` over a 55% scrim, and it\n // \"was barely visible\" on the app's blue-tinted surfaces. Two reasons,\n // and a single ring can't fix either: at 55% the surround stays bright\n // enough that the un-dimmed hole barely reads AS a hole, and a 80%-white\n // ring sitting on the edge of a light card is white-on-near-white.\n //\n // So: an opaque white band immediately around the target, a dark keyline\n // outside it, then the scrim. Whatever the target's own colour is, one of\n // the two bands is always in contrast with it and the other is always in\n // contrast with the dimmed surround — there is no background that can\n // swallow both. The blurred layer between them softens the step so the\n // frame reads as lighting rather than as a pasted-on rectangle.\n boxShadow: [\n \"0 0 0 3px rgba(255,255,255,0.98)\",\n \"0 0 0 5px rgba(15,23,42,0.92)\",\n \"0 0 18px 6px rgba(15,23,42,0.45)\",\n \"0 0 0 9999px rgba(15,23,42,0.70)\",\n ].join(\", \"),\n }}\n />\n ) : (\n <div className=\"pointer-events-auto fixed inset-0 bg-black/70\" />\n )}\n <TourCard\n step={step}\n index={index}\n total={steps.length}\n labels={labels}\n isFirst={isFirst}\n isLast={isLast}\n rect={spot}\n dir={dir}\n onBack={onPrev}\n onNext={onNext}\n onSkip={onSkip}\n />\n </div>,\n document.body,\n );\n}\n\n/** Does the focused element handle `key` itself? Enter on a button or link, and any\n * editing key in a text field or select, is the control's — not the tour's. */\nfunction ownsKey(target: EventTarget | null, key: string): boolean {\n if (!(target instanceof HTMLElement)) return false;\n if (target.isContentEditable) return true;\n const tag = target.tagName;\n if (tag === \"TEXTAREA\" || tag === \"SELECT\") return true;\n if (tag === \"INPUT\") {\n const type = (target as HTMLInputElement).type;\n // Enter on a checkbox does nothing natively, but ←/→ on a radio moves it.\n return key !== \"Enter\" || type !== \"checkbox\";\n }\n if (key !== \"Enter\") return false;\n return (\n tag === \"BUTTON\" ||\n (tag === \"A\" && target.hasAttribute(\"href\")) ||\n target.getAttribute(\"role\") === \"button\" ||\n target.getAttribute(\"role\") === \"link\"\n );\n}\n\n/**\n * Transparent pointer blockers tiling the viewport around the spotlight hole: one\n * full-width band above and below, one on each side at the hole's own height. The hole\n * itself stays uncovered, so the target keeps its clicks.\n */\nfunction SpotlightShields({ spot }: { spot: Rect }) {\n const shield = \"pointer-events-auto fixed\";\n const bottom = spot.top + spot.height;\n return (\n <>\n <div data-tour-shield=\"\" className={shield} style={{ top: 0, left: 0, right: 0, height: Math.max(0, spot.top) }} />\n <div data-tour-shield=\"\" className={shield} style={{ top: bottom, left: 0, right: 0, bottom: 0 }} />\n <div\n data-tour-shield=\"\"\n className={shield}\n style={{ top: spot.top, left: 0, width: Math.max(0, spot.left), height: spot.height }}\n />\n <div\n data-tour-shield=\"\"\n className={shield}\n style={{ top: spot.top, left: spot.left + spot.width, right: 0, height: spot.height }}\n />\n </>\n );\n}\n\n/**\n * Card position (viewport px) for the given placement relative to the padded\n * spotlight `rect`. Omitted placement keeps the original auto behavior\n * (below → above → vertically centered); an explicit side flips to its opposite\n * if it would overflow, then clamps into the viewport. \"center\" (or no rect)\n * centers on screen.\n */\nfunction placeCard(\n rect: Rect | null,\n cw: number,\n ch: number,\n vw: number,\n vh: number,\n m: number,\n placement?: TourPlacement,\n dir: Direction = \"ltr\",\n): { top: number; left: number } {\n // The logical sides resolve to a physical one here, and only here.\n if (placement === \"start\") placement = dir === \"rtl\" ? \"right\" : \"left\";\n else if (placement === \"end\") placement = dir === \"rtl\" ? \"left\" : \"right\";\n if (!rect || placement === \"center\") {\n return { top: Math.max(m, (vh - ch) / 2), left: Math.max(m, (vw - cw) / 2) };\n }\n const clampX = (x: number) => Math.min(Math.max(m, x), Math.max(m, vw - cw - m));\n const clampY = (y: number) => Math.min(Math.max(m, y), Math.max(m, vh - ch - m));\n const centerX = clampX(rect.left + rect.width / 2 - cw / 2);\n const centerY = clampY(rect.top + rect.height / 2 - ch / 2);\n const belowTop = rect.top + rect.height + m;\n const aboveTop = rect.top - ch - m;\n const rightLeft = rect.left + rect.width + m;\n const leftLeft = rect.left - cw - m;\n const fitsBelow = belowTop + ch <= vh;\n const fitsAbove = aboveTop >= 0;\n const fitsRight = rightLeft + cw <= vw;\n const fitsLeft = leftLeft >= 0;\n\n switch (placement) {\n case \"top\":\n return { top: fitsAbove ? aboveTop : fitsBelow ? belowTop : clampY(aboveTop), left: centerX };\n case \"bottom\":\n return { top: fitsBelow ? belowTop : fitsAbove ? aboveTop : clampY(belowTop), left: centerX };\n case \"right\":\n return { top: centerY, left: fitsRight ? rightLeft : fitsLeft ? leftLeft : clampX(rightLeft) };\n case \"left\":\n return { top: centerY, left: fitsLeft ? leftLeft : fitsRight ? rightLeft : clampX(leftLeft) };\n default:\n if (fitsBelow) return { top: belowTop, left: centerX };\n if (fitsAbove) return { top: aboveTop, left: centerX };\n return { top: Math.max(m, (vh - ch) / 2), left: centerX };\n }\n}\n\nfunction TourCard({\n step,\n index,\n total,\n labels,\n isFirst,\n isLast,\n rect,\n dir,\n onBack,\n onNext,\n onSkip,\n}: {\n step: TourStep;\n index: number;\n total: number;\n labels: TourLabels;\n isFirst: boolean;\n isLast: boolean;\n rect: Rect | null;\n dir: Direction;\n onBack: () => void;\n onNext: () => void;\n onSkip: () => void;\n}) {\n const ref = useRef<HTMLDivElement>(null);\n const [style, setStyle] = useState<CSSProperties>({ opacity: 0 });\n\n /**\n * The card holds the focus, because the card is what the tour IS.\n *\n * The overlay above declares `role=\"dialog\" aria-modal=\"true\"` — it always has — and\n * then left focus wherever the page had put it. For a tour that is the most pointed\n * version of the audit's *\"Only Modal manages focus\"*: the whole component exists to\n * say \"look here\", and for a keyboard user \"here\" is the focus ring. They were told\n * the page was hidden, given no way to reach the Next button without Tabbing through\n * it, and left on a control the screen reader would no longer describe.\n *\n * It re-engages on every step, without any bookkeeping here, because `TourOverlay`\n * returns null while it re-locates the next target: the card genuinely unmounts and\n * remounts between steps. That is what keeps focus honest when the BUTTONS change —\n * \"Back\" does not exist on the first step, so stepping back onto it destroys the\n * control the press came from, and focus would otherwise fall to `<body>`, outside\n * this trap's own listener, where Tab walks straight into the page the overlay claims\n * to have hidden.\n *\n * **The cost, written down:** on an `awaitClick` step the user is asked to click the\n * spotlighted element, and they can no longer Tab to it. ArrowRight still advances\n * (the key handler in `TourOverlay` is on the document and does not care where focus\n * is), which is the escape hatch that step already documents for the case where the\n * target cannot be found. Containment is worth that: an `awaitClick` step is a\n * minority of steps, while focus stranded behind `aria-modal` is every step.\n */\n useFocusTrap(ref, { active: true });\n\n useLayoutEffect(() => {\n const card = ref.current;\n if (!card) return;\n setStyle(\n placeCard(rect, card.offsetWidth, card.offsetHeight, window.innerWidth, window.innerHeight, 12, step.placement, dir),\n );\n }, [rect, index, step.placement, dir]);\n\n return (\n <div\n ref={ref}\n // Focusable but not tabbable: the trap above focuses the card itself rather than\n // its first button, so a screen reader reads the step's title and body before it\n // reads \"Next\" — and without this the container cannot take focus at all and the\n // trap silently does nothing.\n tabIndex={-1}\n style={style}\n className=\"pointer-events-auto fixed z-[61] w-80 max-w-[calc(100vw-1.5rem)] rounded-lg border border-subtle bg-surface p-4 shadow-xl outline-none transition-all duration-200 ease-out\"\n >\n <div className=\"text-sm font-semibold text-primary\">{step.title}</div>\n <div className=\"mt-1 text-sm leading-relaxed text-secondary\">{step.body}</div>\n {step.action && <div className=\"mt-3\">{step.action}</div>}\n <div className=\"mt-4 space-y-2\">\n <div className=\"flex items-center justify-between gap-2\">\n <button\n type=\"button\"\n onClick={onSkip}\n className=\"text-xs text-placeholder hover:text-secondary\"\n >\n {labels.skip}\n </button>\n <div className=\"flex items-center gap-2\">\n <span className=\"whitespace-nowrap text-xs tabular-nums text-placeholder\">\n {labels.step(index + 1, total)}\n </span>\n {!isFirst && (\n <Button variant=\"secondary\" onClick={onBack} className=\"px-2.5 py-1 text-xs\">\n {labels.back}\n </Button>\n )}\n {/* On an awaitClick step the Next button is replaced by a hint on its\n own row below, so it doesn't cram the counter + buttons and wrap.\n Only when the target was actually FOUND, though — `rect` is null\n when the finder gave up, and the click listener early-returns on\n the same absence. Keyed on `step.target` alone this hid the only\n way forward on any step whose anchor happens not to be rendered\n for this user (a guest sees no \"add account\" button), leaving the\n undocumented ArrowRight key as the sole escape. */}\n {!(step.awaitClick && step.target && rect) && (\n <Button variant=\"brand\" onClick={onNext} className={cn(\"px-2.5 py-1 text-xs\")}>\n {isLast ? labels.done : labels.next}\n </Button>\n )}\n </div>\n </div>\n {step.awaitClick && step.target && rect && (\n <div className=\"text-center text-xs italic text-placeholder\">\n {labels.awaitClickHint}\n </div>\n )}\n </div>\n </div>\n );\n}\n"],"mappings":";AA6MI,SA6UA,UA1UI,KAHJ;AA7MJ;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,oBAAoB;AAC7B,SAAS,UAAU;AACnB,SAAS,oBAAwC;AACjD,SAAS,cAAc;AACvB,SAAS,oBAAoB;AAC7B,SAAS,gBAAgB;AACzB,SAAS,OAAO,sBAAsB;AAEtC,SAAS,2BAA2B;AAiFpC,MAAM,cAAc,cAAuC,IAAI;AAExD,SAAS,UAA4B;AAC1C,QAAM,MAAM,WAAW,WAAW;AAClC,MAAI,CAAC,IAAK,OAAM,IAAI,MAAM,4CAA4C;AACtE,SAAO;AACT;AAsBO,SAAS,kBAA2C;AACzD,SAAO,WAAW,WAAW;AAC/B;AAUO,SAAS,aAAa;AAAA,EAC3B;AAAA,EACA;AACF,GAGG;AAID,QAAM,SAAS,aAAa,QAAQ,qBAAqB,MAAM;AAC/D,QAAM,CAAC,OAAO,QAAQ,IAAI,SAA4B,IAAI;AAC1D,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAS,CAAC;AACpC,QAAM,CAAC,UAAU,WAAW,IAAI,SAAwB,IAAI;AAC5D,QAAM,UAAU,OAAqB,CAAC,CAAC;AAKvC,QAAM,WAAW,OAA0B,IAAI;AAC/C,QAAM,WAAW,OAAO,CAAC;AACzB,kBAAgB,MAAM;AACpB,aAAS,UAAU;AACnB,aAAS,UAAU;AAAA,EACrB,GAAG,CAAC,OAAO,KAAK,CAAC;AACjB,QAAM,SAAS,CAAC,CAAC,SAAS,MAAM,SAAS;AACzC,QAAM,QAAQ,OAAO,UAAU;AAE/B,QAAM,QAAQ,YAAY,CAAC,GAAe,SAAwB;AAChE,YAAQ,UAAU,QAAQ,CAAC;AAC3B,YAAQ,QAAQ,UAAU;AAC1B,aAAS,KAAK,IAAI,KAAK,IAAI,GAAG,MAAM,cAAc,CAAC,GAAG,KAAK,IAAI,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;AAChF,gBAAY,MAAM,MAAM,IAAI;AAC5B,aAAS,CAAC;AAAA,EACZ,GAAG,CAAC,CAAC;AACL,QAAM,OAAO,YAAY,MAAM;AAC7B,aAAS,IAAI;AACb,gBAAY,IAAI;AAAA,EAClB,GAAG,CAAC,CAAC;AACL,QAAM,SAAS,YAAY,MAAM;AAC/B,YAAQ,QAAQ,WAAW;AAC3B,aAAS,IAAI;AACb,gBAAY,IAAI;AAAA,EAClB,GAAG,CAAC,CAAC;AACL,QAAM,OAAO,YAAY,MAAM;AAC7B,YAAQ,QAAQ,SAAS;AACzB,aAAS,IAAI;AACb,gBAAY,IAAI;AAAA,EAClB,GAAG,CAAC,CAAC;AAEL,QAAM,WAAW,YAAY,CAAC,MAAc;AAC1C,UAAM,MAAM,SAAS,SAAS,UAAU;AACxC,QAAI,QAAQ,EAAG;AACf,aAAS,KAAK,IAAI,KAAK,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;AAAA,EAC5C,GAAG,CAAC,CAAC;AACL,QAAM,OAAO,YAAY,MAAM;AAC7B,UAAM,MAAM,SAAS,SAAS,UAAU;AACxC,QAAI,QAAQ,EAAG;AACf,QAAI,SAAS,WAAW,MAAM,EAAG,QAAO;AAAA,QACnC,UAAS,SAAS,UAAU,CAAC;AAAA,EACpC,GAAG,CAAC,MAAM,CAAC;AACX,QAAM,OAAO,YAAY,MAAM;AAC7B,QAAI,SAAS,UAAU,EAAG,UAAS,SAAS,UAAU,CAAC;AAAA,EACzD,GAAG,CAAC,CAAC;AAEL,SACE,qBAAC,YAAY,UAAZ,EAAqB,OAAO,EAAE,QAAQ,UAAU,OAAO,MAAM,MAAM,MAAM,UAAU,OAAO,MAAM,GAC9F;AAAA;AAAA,IACA,UACC;AAAA,MAAC;AAAA;AAAA,QACC;AAAA,QACA;AAAA,QACA,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,QAAQ;AAAA;AAAA,IACV;AAAA,KAEJ;AAEJ;AASA,SAAS,UAAU,IAAsB;AAMvC,QAAM,IAAI,GAAG,sBAAsB;AACnC,MAAI,EAAE,SAAS,KAAK,EAAE,UAAU,EAAG,QAAO;AAC1C,QAAM,QAAQ,iBAAiB,EAAE;AACjC,SAAO,MAAM,eAAe,YAAY,MAAM,YAAY;AAC5D;AAOA,SAAS,mBAAmB,UAAkC;AAC5D,QAAM,MAAM,SAAS,iBAAiB,QAAQ;AAC9C,aAAW,MAAM,KAAK;AACpB,QAAI,UAAU,EAAE,EAAG,QAAO;AAAA,EAC5B;AACA,SAAO;AACT;AAEA,SAAS,OAAO,IAAmB;AACjC,QAAM,IAAI,GAAG,sBAAsB;AACnC,SAAO,EAAE,KAAK,EAAE,KAAK,MAAM,EAAE,MAAM,OAAO,EAAE,OAAO,QAAQ,EAAE,OAAO;AACtE;AAkCA,SAAS,YAAY;AAAA,EACnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAOG;AACD,QAAM,OAAO,MAAM,KAAK;AACxB,QAAM,UAAU,UAAU;AAC1B,QAAM,SAAS,UAAU,MAAM,SAAS;AAIxC,QAAM,CAAC,SAAS,UAAU,IAAI,SAAyB,IAAI;AAC3D,QAAM,UAAU,YAAY,QAAQ,QAAQ,UAAU,SAAS,QAAQ,SAAS,OAAO,UAAU;AACjG,QAAM,QAAQ,YAAY;AAC1B,QAAM,OAAO,SAAS,QAAQ;AAI9B,QAAM,MAAiB,SAAS,OAAO;AACvC,QAAM,UAAU,OAAuB,IAAI;AAG3C,YAAU,MAAM;AACd,QAAI,YAAY;AAChB,QAAI,MAAM;AAEV,UAAM,SAAS,CAAC,OACd,WAAW,EAAE,OAAO,MAAM,MAAM,KAAK,OAAO,EAAE,IAAI,MAAM,KAAK,MAAM,EAAE,EAAE,CAAC;AAC1E,UAAM,YAAY;AAChB,YAAM,KAAK,aAAa;AACxB,UAAI,UAAW;AACf,UAAI,CAAC,KAAK,QAAQ;AAChB,eAAO,IAAI;AACX;AAAA,MACF;AACA,UAAI,QAAQ;AACZ,YAAM,OAAO,MAAM;AACjB,YAAI,UAAW;AACf,cAAM,KAAK,mBAAmB,KAAK,MAAO;AAC1C,YAAI,IAAI;AACN,aAAG,eAAe,EAAE,OAAO,UAAU,UAAU,SAAS,CAAC;AACzD,iBAAO,EAAE;AACT;AAAA,QACF;AACA,YAAI,UAAU,GAAI,OAAM,sBAAsB,IAAI;AAAA,YAC7C,QAAO,IAAI;AAAA,MAClB;AACA,WAAK;AAAA,IACP,GAAG;AACH,WAAO,MAAM;AACX,kBAAY;AACZ,2BAAqB,GAAG;AAAA,IAC1B;AAAA,EACF,GAAG,CAAC,OAAO,IAAI,CAAC;AAIhB,YAAU,MAAM;AACd,QAAI,CAAC,KAAK,OAAQ;AAClB,UAAM,SAAS,MAAM;AACnB,YAAM,KAAK,mBAAmB,KAAK,MAAO;AAC1C,UAAI,IAAI;AACN,cAAM,OAAO,OAAO,EAAE;AACtB;AAAA,UAAW,CAAC,SACV,QAAQ,KAAK,UAAU,SAAS,KAAK,SAAS,QAAQ,CAAC,SAAS,KAAK,MAAM,IAAI,IAC3E,EAAE,GAAG,MAAM,MAAM,KAAK,IACtB;AAAA,QACN;AAAA,MACF;AAAA,IACF;AACA,WAAO,iBAAiB,UAAU,QAAQ,IAAI;AAC9C,WAAO,iBAAiB,UAAU,MAAM;AACxC,UAAM,KAAK,OAAO,YAAY,QAAQ,GAAG;AACzC,WAAO,MAAM;AACX,aAAO,oBAAoB,UAAU,QAAQ,IAAI;AACjD,aAAO,oBAAoB,UAAU,MAAM;AAC3C,oBAAc,EAAE;AAAA,IAClB;AAAA,EACF,GAAG,CAAC,OAAO,IAAI,CAAC;AAShB,QAAM,UAAU,SAAS;AACzB,YAAU,MAAM;AACd,QAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,cAAc,CAAC,KAAK,OAAQ;AAC5D,UAAM,KAAK,mBAAmB,KAAK,MAAM;AACzC,QAAI,CAAC,GAAI;AACT,UAAM,UAAU,MAAM,OAAO,WAAW,MAAM,OAAO,GAAG,CAAC;AACzD,OAAG,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;AACpD,WAAO,MAAM,GAAG,oBAAoB,SAAS,OAAO;AAAA,EACtD,GAAG,CAAC,OAAO,SAAS,OAAO,MAAM,MAAM,CAAC;AAWxC,YAAU,MAAM;AACd,UAAM,QAAQ,CAAC,MAAqB;AAClC,UAAI,EAAE,QAAQ,UAAU;AACtB,eAAO;AACP;AAAA,MACF;AACA,UAAI,EAAE,QAAQ,SAAS;AACrB,YAAI,KAAK,cAAc,QAAQ,EAAE,QAAQ,OAAO,EAAG;AACnD,UAAE,eAAe;AACjB,eAAO;AACP;AAAA,MACF;AACA,UAAI,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAG;AAE9B,YAAM,QAAQ,eAAe,EAAE,KAAK,QAAQ,OAAO;AACnD,UAAI,UAAU,GAAG;AACf,UAAE,eAAe;AACjB,eAAO;AAAA,MACT,WAAW,UAAU,IAAI;AACvB,YAAI,CAAC,QAAS,QAAO;AAAA,MACvB;AAAA,IACF;AACA,aAAS,iBAAiB,WAAW,KAAK;AAC1C,WAAO,MAAM,SAAS,oBAAoB,WAAW,KAAK;AAAA,EAC5D,GAAG,CAAC,SAAS,MAAM,QAAQ,QAAQ,MAAM,CAAC;AAE1C,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,MAAM,KAAK,WAAW;AAC5B,QAAM,OAAoB,OACtB,EAAE,KAAK,KAAK,MAAM,KAAK,MAAM,KAAK,OAAO,KAAK,OAAO,KAAK,QAAQ,MAAM,GAAG,QAAQ,KAAK,SAAS,MAAM,EAAE,IACzG;AAUJ,SAAO;AAAA,IACL;AAAA,MAAC;AAAA;AAAA,QACC,KAAK;AAAA,QACL,WAAU;AAAA,QACV,MAAK;AAAA,QACL,cAAW;AAAA,QACX,cAAY,KAAK;AAAA,QACjB;AAAA,QAEC;AAAA,kBAAQ,oBAAC,oBAAiB,MAAY;AAAA,UACtC,OACC;AAAA,YAAC;AAAA;AAAA,cACC,WAAU;AAAA,cACV,OAAO;AAAA,gBACL,KAAK,KAAK;AAAA,gBACV,MAAM,KAAK;AAAA,gBACX,OAAO,KAAK;AAAA,gBACZ,QAAQ,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAeb,WAAW;AAAA,kBACT;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,gBACF,EAAE,KAAK,IAAI;AAAA,cACb;AAAA;AAAA,UACF,IAEA,oBAAC,SAAI,WAAU,iDAAgD;AAAA,UAEjE;AAAA,YAAC;AAAA;AAAA,cACC;AAAA,cACA;AAAA,cACA,OAAO,MAAM;AAAA,cACb;AAAA,cACA;AAAA,cACA;AAAA,cACA,MAAM;AAAA,cACN;AAAA,cACA,QAAQ;AAAA,cACR;AAAA,cACA;AAAA;AAAA,UACF;AAAA;AAAA;AAAA,IACF;AAAA,IACA,SAAS;AAAA,EACX;AACF;AAIA,SAAS,QAAQ,QAA4B,KAAsB;AACjE,MAAI,EAAE,kBAAkB,aAAc,QAAO;AAC7C,MAAI,OAAO,kBAAmB,QAAO;AACrC,QAAM,MAAM,OAAO;AACnB,MAAI,QAAQ,cAAc,QAAQ,SAAU,QAAO;AACnD,MAAI,QAAQ,SAAS;AACnB,UAAM,OAAQ,OAA4B;AAE1C,WAAO,QAAQ,WAAW,SAAS;AAAA,EACrC;AACA,MAAI,QAAQ,QAAS,QAAO;AAC5B,SACE,QAAQ,YACP,QAAQ,OAAO,OAAO,aAAa,MAAM,KAC1C,OAAO,aAAa,MAAM,MAAM,YAChC,OAAO,aAAa,MAAM,MAAM;AAEpC;AAOA,SAAS,iBAAiB,EAAE,KAAK,GAAmB;AAClD,QAAM,SAAS;AACf,QAAM,SAAS,KAAK,MAAM,KAAK;AAC/B,SACE,iCACE;AAAA,wBAAC,SAAI,oBAAiB,IAAG,WAAW,QAAQ,OAAO,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,KAAK,IAAI,GAAG,KAAK,GAAG,EAAE,GAAG;AAAA,IACjH,oBAAC,SAAI,oBAAiB,IAAG,WAAW,QAAQ,OAAO,EAAE,KAAK,QAAQ,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,GAAG;AAAA,IAClG;AAAA,MAAC;AAAA;AAAA,QACC,oBAAiB;AAAA,QACjB,WAAW;AAAA,QACX,OAAO,EAAE,KAAK,KAAK,KAAK,MAAM,GAAG,OAAO,KAAK,IAAI,GAAG,KAAK,IAAI,GAAG,QAAQ,KAAK,OAAO;AAAA;AAAA,IACtF;AAAA,IACA;AAAA,MAAC;AAAA;AAAA,QACC,oBAAiB;AAAA,QACjB,WAAW;AAAA,QACX,OAAO,EAAE,KAAK,KAAK,KAAK,MAAM,KAAK,OAAO,KAAK,OAAO,OAAO,GAAG,QAAQ,KAAK,OAAO;AAAA;AAAA,IACtF;AAAA,KACF;AAEJ;AASA,SAAS,UACP,MACA,IACA,IACA,IACA,IACA,GACA,WACA,MAAiB,OACc;AAE/B,MAAI,cAAc,QAAS,aAAY,QAAQ,QAAQ,UAAU;AAAA,WACxD,cAAc,MAAO,aAAY,QAAQ,QAAQ,SAAS;AACnE,MAAI,CAAC,QAAQ,cAAc,UAAU;AACnC,WAAO,EAAE,KAAK,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,GAAG,MAAM,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,EAAE;AAAA,EAC7E;AACA,QAAM,SAAS,CAAC,MAAc,KAAK,IAAI,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC;AAC/E,QAAM,SAAS,CAAC,MAAc,KAAK,IAAI,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC;AAC/E,QAAM,UAAU,OAAO,KAAK,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC;AAC1D,QAAM,UAAU,OAAO,KAAK,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC;AAC1D,QAAM,WAAW,KAAK,MAAM,KAAK,SAAS;AAC1C,QAAM,WAAW,KAAK,MAAM,KAAK;AACjC,QAAM,YAAY,KAAK,OAAO,KAAK,QAAQ;AAC3C,QAAM,WAAW,KAAK,OAAO,KAAK;AAClC,QAAM,YAAY,WAAW,MAAM;AACnC,QAAM,YAAY,YAAY;AAC9B,QAAM,YAAY,YAAY,MAAM;AACpC,QAAM,WAAW,YAAY;AAE7B,UAAQ,WAAW;AAAA,IACjB,KAAK;AACH,aAAO,EAAE,KAAK,YAAY,WAAW,YAAY,WAAW,OAAO,QAAQ,GAAG,MAAM,QAAQ;AAAA,IAC9F,KAAK;AACH,aAAO,EAAE,KAAK,YAAY,WAAW,YAAY,WAAW,OAAO,QAAQ,GAAG,MAAM,QAAQ;AAAA,IAC9F,KAAK;AACH,aAAO,EAAE,KAAK,SAAS,MAAM,YAAY,YAAY,WAAW,WAAW,OAAO,SAAS,EAAE;AAAA,IAC/F,KAAK;AACH,aAAO,EAAE,KAAK,SAAS,MAAM,WAAW,WAAW,YAAY,YAAY,OAAO,QAAQ,EAAE;AAAA,IAC9F;AACE,UAAI,UAAW,QAAO,EAAE,KAAK,UAAU,MAAM,QAAQ;AACrD,UAAI,UAAW,QAAO,EAAE,KAAK,UAAU,MAAM,QAAQ;AACrD,aAAO,EAAE,KAAK,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,GAAG,MAAM,QAAQ;AAAA,EAC5D;AACF;AAEA,SAAS,SAAS;AAAA,EAChB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAYG;AACD,QAAM,MAAM,OAAuB,IAAI;AACvC,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAwB,EAAE,SAAS,EAAE,CAAC;AA2BhE,eAAa,KAAK,EAAE,QAAQ,KAAK,CAAC;AAElC,kBAAgB,MAAM;AACpB,UAAM,OAAO,IAAI;AACjB,QAAI,CAAC,KAAM;AACX;AAAA,MACE,UAAU,MAAM,KAAK,aAAa,KAAK,cAAc,OAAO,YAAY,OAAO,aAAa,IAAI,KAAK,WAAW,GAAG;AAAA,IACrH;AAAA,EACF,GAAG,CAAC,MAAM,OAAO,KAAK,WAAW,GAAG,CAAC;AAErC,SACE;AAAA,IAAC;AAAA;AAAA,MACC;AAAA,MAKA,UAAU;AAAA,MACV;AAAA,MACA,WAAU;AAAA,MAEV;AAAA,4BAAC,SAAI,WAAU,sCAAsC,eAAK,OAAM;AAAA,QAChE,oBAAC,SAAI,WAAU,+CAA+C,eAAK,MAAK;AAAA,QACvE,KAAK,UAAU,oBAAC,SAAI,WAAU,QAAQ,eAAK,QAAO;AAAA,QACnD,qBAAC,SAAI,WAAU,kBACb;AAAA,+BAAC,SAAI,WAAU,2CACb;AAAA;AAAA,cAAC;AAAA;AAAA,gBACC,MAAK;AAAA,gBACL,SAAS;AAAA,gBACT,WAAU;AAAA,gBAET,iBAAO;AAAA;AAAA,YACV;AAAA,YACA,qBAAC,SAAI,WAAU,2BACb;AAAA,kCAAC,UAAK,WAAU,2DACb,iBAAO,KAAK,QAAQ,GAAG,KAAK,GAC/B;AAAA,cACC,CAAC,WACA,oBAAC,UAAO,SAAQ,aAAY,SAAS,QAAQ,WAAU,uBACpD,iBAAO,MACV;AAAA,cAUD,EAAE,KAAK,cAAc,KAAK,UAAU,SACnC,oBAAC,UAAO,SAAQ,SAAQ,SAAS,QAAQ,WAAW,GAAG,qBAAqB,GACzE,mBAAS,OAAO,OAAO,OAAO,MACjC;AAAA,eAEJ;AAAA,aACF;AAAA,UACC,KAAK,cAAc,KAAK,UAAU,QACjC,oBAAC,SAAI,WAAU,+CACZ,iBAAO,gBACV;AAAA,WAEJ;AAAA;AAAA;AAAA,EACF;AAEJ;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/tour/tour.tsx"],"sourcesContent":["import {\n createContext,\n useCallback,\n useContext,\n useEffect,\n useLayoutEffect,\n useRef,\n useState,\n} from \"react\";\nimport type { CSSProperties, ReactNode } from \"react\";\nimport { createPortal } from \"react-dom\";\nimport { cn } from \"../lib/cn\";\nimport { useKitLabels, type LabelOverride } from \"../i18n/kit-labels\";\nimport { Button } from \"../components/button\";\nimport { useFocusTrap } from \"../hooks/use-focus-trap\";\nimport { sameRect } from \"../hooks/use-anchored-rect\";\nimport { dirOf, horizontalStep } from \"../lib/direction\";\nimport type { Direction } from \"../lib/direction\";\nimport { DEFAULT_TOUR_LABELS } from \"./tour-labels\";\nimport type { TourInfo } from \"./tour-info\";\nimport { completeStored, rememberMigrate, type UseTourProgressOptions } from \"./use-tour-progress\";\n\n/**\n * `start`/`end` follow the reading direction (`end` is the right side in LTR and the\n * left side in RTL) and are what a translated app wants. `left`/`right` stay physical\n * for the steps that genuinely mean a screen side.\n */\nexport type TourPlacement = \"top\" | \"right\" | \"bottom\" | \"left\" | \"start\" | \"end\" | \"center\";\n\nexport interface TourStep {\n /** CSS selector for the element to spotlight. Omit for a centered step\n * (welcome/finish). If the target isn't found/visible, the step centers. */\n target?: string;\n title: string;\n body: ReactNode;\n /** Extra footer content, e.g. a \"load sample data\" shortcut. */\n action?: ReactNode;\n /** Spotlight padding around the target, px (default 8). */\n padding?: number;\n /** Where the card sits relative to the target. Omit for auto placement\n * (below → above → centered). \"center\" ignores the target and centers on\n * screen. \"start\"/\"end\" are the logical sides and flip in RTL; \"left\"/\"right\"\n * are physical. An explicit side flips to the opposite side if it would\n * overflow, then clamps into the viewport. */\n placement?: TourPlacement;\n /** Advance only when the user clicks the spotlighted target itself (not the\n * card's Next button). Requires `target`: the real control's own handler runs\n * first, then the tour steps forward on a microtask. The spotlight hole stays\n * click-through to the target; the rest of the page does not. */\n awaitClick?: boolean;\n /** Runs before the step is shown — e.g. navigate to a route, open a panel.\n * May be async; the step waits for it, then locates the target. */\n beforeStep?: () => void | Promise<void>;\n}\n\nexport interface TourLabels {\n next: string;\n back: string;\n skip: string;\n done: string;\n /** Shown in place of the Next button on an `awaitClick` step. */\n awaitClickHint: string;\n /** Step counter, e.g. (2, 7) => \"2 / 7\". */\n step: (current: number, total: number) => string;\n}\n\n// Defined in ./tour-labels, which holds no component code (0.34, KS U8).\nexport { DEFAULT_TOUR_LABELS };\n\ninterface StartOptions {\n /** Stable id of the tour, surfaced as `activeId` so the app can mirror it to\n * the URL (deep-link / evaluation tracking) and record completion. Defaults to\n * `tour.id`. */\n id?: string;\n /** The tour being started, as the app lists it (docs/tours-harmonization.md §9.6.1).\n * When its last step is finished, the provider records the completion in its\n * `progress` and hands this to `onComplete`. */\n tour?: TourInfo;\n /** Start at this step index instead of 0 (clamped) — for URL/deep-link resume. */\n startIndex?: number;\n /** Fires synchronously when the tour starts (e.g. enable a mock interceptor). */\n onStart?: () => void;\n /** After the last step: runs after the provider's progress write and `onComplete`. */\n onFinish?: () => void;\n onSkip?: () => void;\n}\n\n/** What `TourProvider`'s `onComplete` learns besides the tour (§9.1, §9.6). */\nexport interface TourCompletion {\n /**\n * `true` when the completion counts anew (the first time, or the first time after the\n * tour's update, §8): the moment for the app's points toast. `false` for a replay, and\n * when the stored text is in an old shape no `migrate` reads: nothing is overwritten\n * then, and the error goes to `console.error` (keksdose B-1). `undefined` when the provider has no `progress` or the start carried no `tour`, so\n * nothing was recorded.\n */\n awarded: boolean | undefined;\n}\n\ninterface TourContextValue {\n active: boolean;\n /** Id of the running tour (from {@link StartOptions.id}), else null. */\n activeId: string | null;\n /** Start a tour with the given steps. */\n start: (steps: TourStep[], opts?: StartOptions) => void;\n /** End the current tour (no callbacks fire). */\n stop: () => void;\n /** Advance one step; past the last step it finishes the tour (fires onFinish). */\n next: () => void;\n /** Go back one step (no-op on the first). */\n prev: () => void;\n /** Jump to a step by index, clamped to range — e.g. for URL/deep-link resume. */\n goToStep: (index: number) => void;\n /** Current step (0-based; 0 while inactive). */\n index: number;\n /** Total steps (0 while inactive). */\n total: number;\n}\n\nconst TourContext = createContext<TourContextValue | null>(null);\n\nexport function useTour(): TourContextValue {\n const ctx = useContext(TourContext);\n if (!ctx) throw new Error(\"useTour must be used within <TourProvider>\");\n return ctx;\n}\n\n/**\n * The tour engine if it is there, `null` if it is not — for a control that is a\n * DECORATION rather than a participant.\n *\n * {@link useTour}'s throw is correct and stays: a component that runs a tour cannot do\n * its job without the provider, and failing loudly is how that gets fixed. But the\n * throw's blast radius is whatever error boundary is above it, and for a launcher in\n * the app shell that is the whole app.\n *\n * Keksdose feedback dev#524 is what that costs: an `@hb/ui` module was edited while a\n * dev server was running, vite re-evaluated it, and the module's freshly created\n * context object was no longer the one the mounted provider was providing. React's\n * `useContext` then answers `null` for a provider that is, structurally, right there —\n * and the top bar's tour menu took the entire shell down with it. **Build-time module\n * graphs cannot produce that**, so it is a development-only failure; a menu that\n * disappears for a second is the proportionate response to it either way.\n *\n * Only for controls that can honestly render nothing. If a component would show a\n * broken half of itself without the tour, it wants {@link useTour}.\n */\nexport function useTourOptional(): TourContextValue | null {\n return useContext(TourContext);\n}\n\n/** The kit's dev switch (as number-input's): a development build, never under vitest. */\nfunction devWarnings(): boolean {\n return Boolean(import.meta.env?.DEV) && !import.meta.env?.VITEST;\n}\n\n/**\n * Provides the guided-tour engine: a dimmed spotlight overlay + step card driven\n * by a list of {@link TourStep}s. Domain-free — the app supplies the steps (copy,\n * selectors, per-step navigation, placement) and the translated {@link TourLabels}.\n * Mount once inside the router; start a tour from anywhere via {@link useTour},\n * which also exposes step control (`next`/`prev`/`goToStep`) and the current\n * `index`/`total` for URL mirroring, `awaitClick` and deep-link resume.\n *\n * **Completion in one place** (docs/tours-harmonization.md §9.6): give the provider the\n * app's `progress` (the same `{storageKey, migrate}` as `useTourProgress`) and start each\n * tour with `start(steps, {tour})`. When the last step is finished the provider writes the\n * completion ONCE, through the store every `useTourProgress` reader of the key shares\n * (never a second copy), then calls `onComplete(tour, {awarded})`, then the start's own\n * `onFinish`. A skip or `stop()` records nothing and calls neither. The app removes its\n * own `complete()` from `onFinish`, or that second write answers `false`.\n *\n * Both props are optional: without `progress` or a `tour` on the start, `onComplete`\n * still fires, with `awarded: undefined` (and `tour` as given, possibly `undefined`). A\n * new `storageKey` (an account switch on a shared PC) is followed on the next\n * completion, without a remount.\n */\nexport function TourProvider({\n children,\n labels,\n progress,\n onComplete,\n}: {\n children: ReactNode;\n labels?: LabelOverride<TourLabels>;\n /** The app's tour progress: the same options its `useTourProgress` readers use. */\n progress?: UseTourProgressOptions;\n /** A tour's last step was finished; see {@link TourCompletion}. */\n onComplete?: (tour: TourInfo | undefined, completion: TourCompletion) => void;\n}) {\n // `labels` over the provider's `tour` over English. Resolved once here and handed\n // down: the step card is portalled, but context crosses portals anyway — this is\n // simply the one place that already owned the merge.\n const merged = useKitLabels(\"tour\", DEFAULT_TOUR_LABELS, labels);\n const [steps, setSteps] = useState<TourStep[] | null>(null);\n const [index, setIndex] = useState(0);\n const [activeId, setActiveId] = useState<string | null>(null);\n const optsRef = useRef<StartOptions>({});\n // The latest props, read at the finish: a new `storageKey` or callback needs no remount.\n const progressRef = useRef(progress);\n const onCompleteRef = useRef(onComplete);\n useLayoutEffect(() => {\n progressRef.current = progress;\n onCompleteRef.current = onComplete;\n });\n // The provider's migrate becomes the key's, for readers that pass none (keksdose B-2).\n const storageKey = progress?.storageKey;\n const migrate = progress?.migrate;\n useLayoutEffect(() => {\n if (storageKey !== undefined) rememberMigrate(storageKey, migrate);\n }, [storageKey, migrate]);\n const warnedNoTourRef = useRef(false);\n // Live mirrors so the step-control callbacks can stay stable (identity-safe for\n // consumers) while still reading the current steps/index. Synced in a layout\n // effect — after the commit, before paint and before any passive effect or event\n // can call them — rather than written during render.\n const stepsRef = useRef<TourStep[] | null>(null);\n const indexRef = useRef(0);\n useLayoutEffect(() => {\n stepsRef.current = steps;\n indexRef.current = index;\n }, [steps, index]);\n const active = !!steps && steps.length > 0;\n const total = steps?.length ?? 0;\n\n const start = useCallback((s: TourStep[], opts?: StartOptions) => {\n optsRef.current = opts ?? {};\n optsRef.current.onStart?.();\n setIndex(Math.min(Math.max(0, opts?.startIndex ?? 0), Math.max(0, s.length - 1)));\n setActiveId(opts?.id ?? opts?.tour?.id ?? null);\n setSteps(s);\n }, []);\n const stop = useCallback(() => {\n setSteps(null);\n setActiveId(null);\n }, []);\n const finish = useCallback(() => {\n // Once per tour: a second \"Done\" before the overlay unmounts records nothing more.\n if (!stepsRef.current) return;\n stepsRef.current = null;\n const { tour, onFinish } = optsRef.current;\n const store = progressRef.current;\n // Exactly one write per completion (§9.6.2), so `awarded` is what `complete(tour)` answered.\n let awarded: boolean | undefined;\n if (store && tour) {\n try {\n awarded = completeStored(store.storageKey, store.migrate, tour);\n } catch (error) {\n // A stored text no migrate reads is left as it is (keksdose B-1); the tour still ends.\n console.error(error);\n awarded = false;\n }\n } else if (store && !tour && devWarnings() && !warnedNoTourRef.current) {\n warnedNoTourRef.current = true;\n console.warn(\n \"[ui-kit] TourProvider has `progress`, but a finished tour's start carried no `tour`: \" +\n \"nothing was recorded and `awarded` is undefined. Start it with `start(steps, { tour })`.\",\n );\n }\n onCompleteRef.current?.(tour, { awarded });\n onFinish?.();\n setSteps(null);\n setActiveId(null);\n }, []);\n const skip = useCallback(() => {\n optsRef.current.onSkip?.();\n setSteps(null);\n setActiveId(null);\n }, []);\n\n const goToStep = useCallback((i: number) => {\n const len = stepsRef.current?.length ?? 0;\n if (len === 0) return;\n setIndex(Math.min(Math.max(0, i), len - 1));\n }, []);\n const next = useCallback(() => {\n const len = stepsRef.current?.length ?? 0;\n if (len === 0) return;\n if (indexRef.current >= len - 1) finish();\n else setIndex(indexRef.current + 1);\n }, [finish]);\n const prev = useCallback(() => {\n if (indexRef.current > 0) setIndex(indexRef.current - 1);\n }, []);\n\n return (\n <TourContext.Provider value={{ active, activeId, start, stop, next, prev, goToStep, index, total }}>\n {children}\n {active && (\n <TourOverlay\n steps={steps!}\n index={index}\n labels={merged}\n onNext={next}\n onPrev={prev}\n onSkip={skip}\n />\n )}\n </TourContext.Provider>\n );\n}\n\ninterface Rect {\n top: number;\n left: number;\n width: number;\n height: number;\n}\n\nfunction isVisible(el: Element): boolean {\n // A non-zero box already rules out display:none on the element or any ancestor\n // (an unrendered element measures 0x0). We deliberately do NOT test\n // offsetParent: it is null for position:fixed elements even when fully visible,\n // which made the mobile bottom-nav bar (fixed) un-highlightable on mobile\n // (feedback #313). visibility:hidden keeps a box, so check it explicitly.\n const r = el.getBoundingClientRect();\n if (r.width <= 0 || r.height <= 0) return false;\n const style = getComputedStyle(el);\n return style.visibility !== \"hidden\" && style.display !== \"none\";\n}\n\n// The first VISIBLE element matching the selector, not merely the first in DOM\n// order. This lets a step target the same control across layouts with one\n// combined selector — e.g. the desktop sidebar link AND the mobile bottom-bar\n// link — where the off-layout copy is present but `display:none` (feedback\n// #313). Returns null while none is visible so the finder keeps retrying.\nfunction queryVisibleTarget(selector: string): Element | null {\n const els = document.querySelectorAll(selector);\n for (const el of els) {\n if (isVisible(el)) return el;\n }\n return null;\n}\n\nfunction rectOf(el: Element): Rect {\n const r = el.getBoundingClientRect();\n return { top: r.top, left: r.left, width: r.width, height: r.height };\n}\n\n/**\n * What the finder established for ONE step: where its target is (`null` = no target,\n * or not on the page), and the reading direction the card takes from it.\n *\n * It carries the step it was found for, and the overlay only believes it for that\n * step — which is the whole fix for keksdose's tours audit 2026-10-02, §1.0 A (\"stale\n * spotlight on the step after a spotlighted one\", 15 steps in 16 tours, desktop and\n * phone, mouse and keyboard). When step N spotlit a target and step N+1 had none (or\n * its anchor was missing), N+1 kept N's hole and parked its card beside it, so a\n * centred \"You're all set\" read as pointing at the Import & Export link; Back→Next kept\n * it for as long as anyone watched.\n *\n * The overlay used to hold `rect` and `ready` as separate states and reset them\n * DURING RENDER when the step changed. React 19 does not keep a render-phase update\n * while an earlier, lower-priority update to the same hook is still queued — it only\n * writes the result to the base state \"unless the queue is empty\" — and the follow\n * interval below queues exactly such an update every 250 ms (eagerly bailed out because\n * the rect had not moved, but left in the queue for rebasing). So the click's render\n * showed the reset, and the very next render (the finder saying \"ready\") re-based on\n * the old rect. A deep link was fine because nothing had queued anything yet.\n *\n * Keying the result to its step does not depend on any of that ordering: a rect found\n * for another step is not this step's rect, whatever the queue does with it, and a\n * missing anchor reads as \"no target\" instead of as the last thing that was lit.\n */\ninterface Located {\n index: number;\n step: TourStep;\n rect: Rect | null;\n dir: Direction;\n}\n\nfunction TourOverlay({\n steps,\n index,\n labels,\n onNext,\n onPrev,\n onSkip,\n}: {\n steps: TourStep[];\n index: number;\n labels: TourLabels;\n onNext: () => void;\n onPrev: () => void;\n onSkip: () => void;\n}) {\n const step = steps[index];\n const isFirst = index === 0;\n const isLast = index === steps.length - 1;\n // A new step starts unlocated: whatever was found for another step (see `Located`)\n // is ignored, so the overlay renders nothing until the effect below has located THIS\n // step, and never the previous step's spotlight.\n const [located, setLocated] = useState<Located | null>(null);\n const current = located !== null && located.index === index && located.step === step ? located : null;\n const ready = current !== null;\n const rect = current?.rect ?? null;\n // The overlay is portalled to <body>, out of whatever `dir` subtree the app set, so it\n // takes the direction of the element it spotlights (the document's for a centered\n // step). Arrow keys and start/end placement read it.\n const dir: Direction = current?.dir ?? \"ltr\";\n const rootRef = useRef<HTMLDivElement>(null);\n\n // Run beforeStep, then locate the target (retrying across route/render lag).\n useEffect(() => {\n let cancelled = false;\n let raf = 0;\n // `null` = untargeted, or the finder gave up → the card centres, with no hole.\n const settle = (el: Element | null) =>\n setLocated({ index, step, rect: el ? rectOf(el) : null, dir: dirOf(el) });\n void (async () => {\n await step.beforeStep?.();\n if (cancelled) return;\n if (!step.target) {\n settle(null);\n return;\n }\n let tries = 0;\n const find = () => {\n if (cancelled) return;\n const el = queryVisibleTarget(step.target!);\n if (el) {\n el.scrollIntoView({ block: \"center\", behavior: \"smooth\" });\n settle(el);\n return;\n }\n if (tries++ < 45) raf = requestAnimationFrame(find);\n else settle(null); // give up → render centered\n };\n find();\n })();\n return () => {\n cancelled = true;\n cancelAnimationFrame(raf);\n };\n }, [index, step]);\n\n // Follow the target as the page scrolls / reflows — only once THIS step is located,\n // and only into this step's result.\n useEffect(() => {\n if (!step.target) return;\n const update = () => {\n const el = queryVisibleTarget(step.target!);\n if (el) {\n const next = rectOf(el);\n setLocated((prev) =>\n prev && prev.index === index && prev.step === step && !sameRect(prev.rect, next)\n ? { ...prev, rect: next }\n : prev,\n );\n }\n };\n window.addEventListener(\"scroll\", update, true);\n window.addEventListener(\"resize\", update);\n const id = window.setInterval(update, 250);\n return () => {\n window.removeEventListener(\"scroll\", update, true);\n window.removeEventListener(\"resize\", update);\n clearInterval(id);\n };\n }, [index, step]);\n\n // awaitClick: advance when the *real* target is clicked. The spotlight hole is\n // click-through (see the shields in the render below) so the element's own\n // handler runs first; we step forward on the next macrotask.\n //\n // Re-armed when the target turns up after the finder gave up (the follow effect\n // lights it late): the card swaps Next for the \"click the highlighted element\" hint\n // as soon as there is a rect, so the click must work from that moment too.\n const spotted = rect !== null;\n useEffect(() => {\n if (!ready || !spotted || !step.awaitClick || !step.target) return;\n const el = queryVisibleTarget(step.target);\n if (!el) return;\n const onClick = () => window.setTimeout(() => onNext(), 0);\n el.addEventListener(\"click\", onClick, { once: true });\n return () => el.removeEventListener(\"click\", onClick);\n }, [ready, spotted, index, step, onNext]);\n\n // Keyboard: Esc skips, Enter and the reading-direction arrow advance (→ in LTR,\n // ← in RTL), the other arrow goes back. On awaitClick steps Enter is ignored (it\n // would fire the target's click AND advance) — the forward arrow stays as an escape\n // hatch.\n //\n // Enter on a focused control belongs to that control. This used to advance from\n // anywhere, so Enter on a focused Skip or Back ran the button's own click AND stepped\n // forward: Back moved nowhere, Skip skipped and then called `next` on a dead tour.\n // The same goes for arrows in a text field a step's `action` might contain.\n useEffect(() => {\n const onKey = (e: KeyboardEvent) => {\n if (e.key === \"Escape\") {\n onSkip();\n return;\n }\n if (e.key === \"Enter\") {\n if (step.awaitClick || ownsKey(e.target, \"Enter\")) return;\n e.preventDefault();\n onNext();\n return;\n }\n if (ownsKey(e.target, e.key)) return;\n // The overlay root carries `dir`; before it paints, the document's answers.\n const delta = horizontalStep(e.key, rootRef.current);\n if (delta === 1) {\n e.preventDefault();\n onNext();\n } else if (delta === -1) {\n if (!isFirst) onPrev();\n }\n };\n document.addEventListener(\"keydown\", onKey);\n return () => document.removeEventListener(\"keydown\", onKey);\n }, [isFirst, step, onNext, onPrev, onSkip]);\n\n if (!ready) return null;\n\n const pad = step.padding ?? 8;\n const spot: Rect | null = rect\n ? { top: rect.top - pad, left: rect.left - pad, width: rect.width + pad * 2, height: rect.height + pad * 2 }\n : null;\n\n // `aria-modal` promises the page behind is out of reach, and the card's focus trap\n // keeps that promise for the keyboard. The pointer used to get no such treatment: the\n // root is `pointer-events-none` so that the spotlight hole can stay live for\n // `awaitClick`, and the scrim is a box-shadow, which takes no clicks — so every\n // control on the dimmed page stayed clickable. Four shields now tile the viewport\n // around the hole: the page is blocked, the card and the spotlighted target are not.\n // Keeping `aria-modal` (rather than dropping it) is the coherent half: the tour\n // really is modal — focus is trapped and Esc/Skip is the way out.\n return createPortal(\n <div\n ref={rootRef}\n className=\"pointer-events-none fixed inset-0 z-[60]\"\n role=\"dialog\"\n aria-modal=\"true\"\n aria-label={step.title}\n dir={dir}\n >\n {spot && <SpotlightShields spot={spot} />}\n {spot ? (\n <div\n className=\"pointer-events-none fixed rounded-lg transition-all duration-200 ease-out\"\n style={{\n top: spot.top,\n left: spot.left,\n width: spot.width,\n height: spot.height,\n // A two-tone frame, not a single translucent ring.\n //\n // The old treatment was `ring-2 ring-white/80` over a 55% scrim, and it\n // \"was barely visible\" on the app's blue-tinted surfaces. Two reasons,\n // and a single ring can't fix either: at 55% the surround stays bright\n // enough that the un-dimmed hole barely reads AS a hole, and a 80%-white\n // ring sitting on the edge of a light card is white-on-near-white.\n //\n // So: an opaque white band immediately around the target, a dark keyline\n // outside it, then the scrim. Whatever the target's own colour is, one of\n // the two bands is always in contrast with it and the other is always in\n // contrast with the dimmed surround — there is no background that can\n // swallow both. The blurred layer between them softens the step so the\n // frame reads as lighting rather than as a pasted-on rectangle.\n boxShadow: [\n \"0 0 0 3px rgba(255,255,255,0.98)\",\n \"0 0 0 5px rgba(15,23,42,0.92)\",\n \"0 0 18px 6px rgba(15,23,42,0.45)\",\n \"0 0 0 9999px rgba(15,23,42,0.70)\",\n ].join(\", \"),\n }}\n />\n ) : (\n <div className=\"pointer-events-auto fixed inset-0 bg-black/70\" />\n )}\n <TourCard\n step={step}\n index={index}\n total={steps.length}\n labels={labels}\n isFirst={isFirst}\n isLast={isLast}\n rect={spot}\n dir={dir}\n onBack={onPrev}\n onNext={onNext}\n onSkip={onSkip}\n />\n </div>,\n document.body,\n );\n}\n\n/** Does the focused element handle `key` itself? Enter on a button or link, and any\n * editing key in a text field or select, is the control's — not the tour's. */\nfunction ownsKey(target: EventTarget | null, key: string): boolean {\n if (!(target instanceof HTMLElement)) return false;\n if (target.isContentEditable) return true;\n const tag = target.tagName;\n if (tag === \"TEXTAREA\" || tag === \"SELECT\") return true;\n if (tag === \"INPUT\") {\n const type = (target as HTMLInputElement).type;\n // Enter on a checkbox does nothing natively, but ←/→ on a radio moves it.\n return key !== \"Enter\" || type !== \"checkbox\";\n }\n if (key !== \"Enter\") return false;\n return (\n tag === \"BUTTON\" ||\n (tag === \"A\" && target.hasAttribute(\"href\")) ||\n target.getAttribute(\"role\") === \"button\" ||\n target.getAttribute(\"role\") === \"link\"\n );\n}\n\n/**\n * Transparent pointer blockers tiling the viewport around the spotlight hole: one\n * full-width band above and below, one on each side at the hole's own height. The hole\n * itself stays uncovered, so the target keeps its clicks.\n */\nfunction SpotlightShields({ spot }: { spot: Rect }) {\n const shield = \"pointer-events-auto fixed\";\n const bottom = spot.top + spot.height;\n return (\n <>\n <div data-tour-shield=\"\" className={shield} style={{ top: 0, left: 0, right: 0, height: Math.max(0, spot.top) }} />\n <div data-tour-shield=\"\" className={shield} style={{ top: bottom, left: 0, right: 0, bottom: 0 }} />\n <div\n data-tour-shield=\"\"\n className={shield}\n style={{ top: spot.top, left: 0, width: Math.max(0, spot.left), height: spot.height }}\n />\n <div\n data-tour-shield=\"\"\n className={shield}\n style={{ top: spot.top, left: spot.left + spot.width, right: 0, height: spot.height }}\n />\n </>\n );\n}\n\n/**\n * Card position (viewport px) for the given placement relative to the padded\n * spotlight `rect`. Omitted placement keeps the original auto behavior\n * (below → above → vertically centered); an explicit side flips to its opposite\n * if it would overflow, then clamps into the viewport. \"center\" (or no rect)\n * centers on screen.\n */\nfunction placeCard(\n rect: Rect | null,\n cw: number,\n ch: number,\n vw: number,\n vh: number,\n m: number,\n placement?: TourPlacement,\n dir: Direction = \"ltr\",\n): { top: number; left: number } {\n // The logical sides resolve to a physical one here, and only here.\n if (placement === \"start\") placement = dir === \"rtl\" ? \"right\" : \"left\";\n else if (placement === \"end\") placement = dir === \"rtl\" ? \"left\" : \"right\";\n if (!rect || placement === \"center\") {\n return { top: Math.max(m, (vh - ch) / 2), left: Math.max(m, (vw - cw) / 2) };\n }\n const clampX = (x: number) => Math.min(Math.max(m, x), Math.max(m, vw - cw - m));\n const clampY = (y: number) => Math.min(Math.max(m, y), Math.max(m, vh - ch - m));\n const centerX = clampX(rect.left + rect.width / 2 - cw / 2);\n const centerY = clampY(rect.top + rect.height / 2 - ch / 2);\n const belowTop = rect.top + rect.height + m;\n const aboveTop = rect.top - ch - m;\n const rightLeft = rect.left + rect.width + m;\n const leftLeft = rect.left - cw - m;\n const fitsBelow = belowTop + ch <= vh;\n const fitsAbove = aboveTop >= 0;\n const fitsRight = rightLeft + cw <= vw;\n const fitsLeft = leftLeft >= 0;\n\n switch (placement) {\n case \"top\":\n return { top: fitsAbove ? aboveTop : fitsBelow ? belowTop : clampY(aboveTop), left: centerX };\n case \"bottom\":\n return { top: fitsBelow ? belowTop : fitsAbove ? aboveTop : clampY(belowTop), left: centerX };\n case \"right\":\n return { top: centerY, left: fitsRight ? rightLeft : fitsLeft ? leftLeft : clampX(rightLeft) };\n case \"left\":\n return { top: centerY, left: fitsLeft ? leftLeft : fitsRight ? rightLeft : clampX(leftLeft) };\n default:\n if (fitsBelow) return { top: belowTop, left: centerX };\n if (fitsAbove) return { top: aboveTop, left: centerX };\n return { top: Math.max(m, (vh - ch) / 2), left: centerX };\n }\n}\n\nfunction TourCard({\n step,\n index,\n total,\n labels,\n isFirst,\n isLast,\n rect,\n dir,\n onBack,\n onNext,\n onSkip,\n}: {\n step: TourStep;\n index: number;\n total: number;\n labels: TourLabels;\n isFirst: boolean;\n isLast: boolean;\n rect: Rect | null;\n dir: Direction;\n onBack: () => void;\n onNext: () => void;\n onSkip: () => void;\n}) {\n const ref = useRef<HTMLDivElement>(null);\n const [style, setStyle] = useState<CSSProperties>({ opacity: 0 });\n\n /**\n * The card holds the focus, because the card is what the tour IS.\n *\n * The overlay above declares `role=\"dialog\" aria-modal=\"true\"` — it always has — and\n * then left focus wherever the page had put it. For a tour that is the most pointed\n * version of the audit's *\"Only Modal manages focus\"*: the whole component exists to\n * say \"look here\", and for a keyboard user \"here\" is the focus ring. They were told\n * the page was hidden, given no way to reach the Next button without Tabbing through\n * it, and left on a control the screen reader would no longer describe.\n *\n * It re-engages on every step, without any bookkeeping here, because `TourOverlay`\n * returns null while it re-locates the next target: the card genuinely unmounts and\n * remounts between steps. That is what keeps focus honest when the BUTTONS change —\n * \"Back\" does not exist on the first step, so stepping back onto it destroys the\n * control the press came from, and focus would otherwise fall to `<body>`, outside\n * this trap's own listener, where Tab walks straight into the page the overlay claims\n * to have hidden.\n *\n * **The cost, written down:** on an `awaitClick` step the user is asked to click the\n * spotlighted element, and they can no longer Tab to it. ArrowRight still advances\n * (the key handler in `TourOverlay` is on the document and does not care where focus\n * is), which is the escape hatch that step already documents for the case where the\n * target cannot be found. Containment is worth that: an `awaitClick` step is a\n * minority of steps, while focus stranded behind `aria-modal` is every step.\n */\n useFocusTrap(ref, { active: true });\n\n useLayoutEffect(() => {\n const card = ref.current;\n if (!card) return;\n setStyle(\n placeCard(rect, card.offsetWidth, card.offsetHeight, window.innerWidth, window.innerHeight, 12, step.placement, dir),\n );\n }, [rect, index, step.placement, dir]);\n\n return (\n <div\n ref={ref}\n // Focusable but not tabbable: the trap above focuses the card itself rather than\n // its first button, so a screen reader reads the step's title and body before it\n // reads \"Next\" — and without this the container cannot take focus at all and the\n // trap silently does nothing.\n tabIndex={-1}\n style={style}\n className=\"pointer-events-auto fixed z-[61] w-80 max-w-[calc(100vw-1.5rem)] rounded-lg border border-subtle bg-surface p-4 shadow-xl outline-none transition-all duration-200 ease-out\"\n >\n <div className=\"text-sm font-semibold text-primary\">{step.title}</div>\n <div className=\"mt-1 text-sm leading-relaxed text-secondary\">{step.body}</div>\n {step.action && <div className=\"mt-3\">{step.action}</div>}\n <div className=\"mt-4 space-y-2\">\n <div className=\"flex items-center justify-between gap-2\">\n <button\n type=\"button\"\n onClick={onSkip}\n className=\"text-xs text-placeholder hover:text-secondary\"\n >\n {labels.skip}\n </button>\n <div className=\"flex items-center gap-2\">\n <span className=\"whitespace-nowrap text-xs tabular-nums text-placeholder\">\n {labels.step(index + 1, total)}\n </span>\n {!isFirst && (\n <Button variant=\"secondary\" onClick={onBack} className=\"px-2.5 py-1 text-xs\">\n {labels.back}\n </Button>\n )}\n {/* On an awaitClick step the Next button is replaced by a hint on its\n own row below, so it doesn't cram the counter + buttons and wrap.\n Only when the target was actually FOUND, though — `rect` is null\n when the finder gave up, and the click listener early-returns on\n the same absence. Keyed on `step.target` alone this hid the only\n way forward on any step whose anchor happens not to be rendered\n for this user (a guest sees no \"add account\" button), leaving the\n undocumented ArrowRight key as the sole escape. */}\n {!(step.awaitClick && step.target && rect) && (\n <Button variant=\"brand\" onClick={onNext} className={cn(\"px-2.5 py-1 text-xs\")}>\n {isLast ? labels.done : labels.next}\n </Button>\n )}\n </div>\n </div>\n {step.awaitClick && step.target && rect && (\n <div className=\"text-center text-xs italic text-placeholder\">\n {labels.awaitClickHint}\n </div>\n )}\n </div>\n </div>\n );\n}\n"],"mappings":";AA8RI,SA6UA,UA1UI,KAHJ;AA9RJ;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,oBAAoB;AAC7B,SAAS,UAAU;AACnB,SAAS,oBAAwC;AACjD,SAAS,cAAc;AACvB,SAAS,oBAAoB;AAC7B,SAAS,gBAAgB;AACzB,SAAS,OAAO,sBAAsB;AAEtC,SAAS,2BAA2B;AAEpC,SAAS,gBAAgB,uBAAoD;AAmG7E,MAAM,cAAc,cAAuC,IAAI;AAExD,SAAS,UAA4B;AAC1C,QAAM,MAAM,WAAW,WAAW;AAClC,MAAI,CAAC,IAAK,OAAM,IAAI,MAAM,4CAA4C;AACtE,SAAO;AACT;AAsBO,SAAS,kBAA2C;AACzD,SAAO,WAAW,WAAW;AAC/B;AAGA,SAAS,cAAuB;AAC9B,SAAO,QAAQ,YAAY,KAAK,GAAG,KAAK,CAAC,YAAY,KAAK;AAC5D;AAuBO,SAAS,aAAa;AAAA,EAC3B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAOG;AAID,QAAM,SAAS,aAAa,QAAQ,qBAAqB,MAAM;AAC/D,QAAM,CAAC,OAAO,QAAQ,IAAI,SAA4B,IAAI;AAC1D,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAS,CAAC;AACpC,QAAM,CAAC,UAAU,WAAW,IAAI,SAAwB,IAAI;AAC5D,QAAM,UAAU,OAAqB,CAAC,CAAC;AAEvC,QAAM,cAAc,OAAO,QAAQ;AACnC,QAAM,gBAAgB,OAAO,UAAU;AACvC,kBAAgB,MAAM;AACpB,gBAAY,UAAU;AACtB,kBAAc,UAAU;AAAA,EAC1B,CAAC;AAED,QAAM,aAAa,UAAU;AAC7B,QAAM,UAAU,UAAU;AAC1B,kBAAgB,MAAM;AACpB,QAAI,eAAe,OAAW,iBAAgB,YAAY,OAAO;AAAA,EACnE,GAAG,CAAC,YAAY,OAAO,CAAC;AACxB,QAAM,kBAAkB,OAAO,KAAK;AAKpC,QAAM,WAAW,OAA0B,IAAI;AAC/C,QAAM,WAAW,OAAO,CAAC;AACzB,kBAAgB,MAAM;AACpB,aAAS,UAAU;AACnB,aAAS,UAAU;AAAA,EACrB,GAAG,CAAC,OAAO,KAAK,CAAC;AACjB,QAAM,SAAS,CAAC,CAAC,SAAS,MAAM,SAAS;AACzC,QAAM,QAAQ,OAAO,UAAU;AAE/B,QAAM,QAAQ,YAAY,CAAC,GAAe,SAAwB;AAChE,YAAQ,UAAU,QAAQ,CAAC;AAC3B,YAAQ,QAAQ,UAAU;AAC1B,aAAS,KAAK,IAAI,KAAK,IAAI,GAAG,MAAM,cAAc,CAAC,GAAG,KAAK,IAAI,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;AAChF,gBAAY,MAAM,MAAM,MAAM,MAAM,MAAM,IAAI;AAC9C,aAAS,CAAC;AAAA,EACZ,GAAG,CAAC,CAAC;AACL,QAAM,OAAO,YAAY,MAAM;AAC7B,aAAS,IAAI;AACb,gBAAY,IAAI;AAAA,EAClB,GAAG,CAAC,CAAC;AACL,QAAM,SAAS,YAAY,MAAM;AAE/B,QAAI,CAAC,SAAS,QAAS;AACvB,aAAS,UAAU;AACnB,UAAM,EAAE,MAAM,SAAS,IAAI,QAAQ;AACnC,UAAM,QAAQ,YAAY;AAE1B,QAAI;AACJ,QAAI,SAAS,MAAM;AACjB,UAAI;AACF,kBAAU,eAAe,MAAM,YAAY,MAAM,SAAS,IAAI;AAAA,MAChE,SAAS,OAAO;AAEd,gBAAQ,MAAM,KAAK;AACnB,kBAAU;AAAA,MACZ;AAAA,IACF,WAAW,SAAS,CAAC,QAAQ,YAAY,KAAK,CAAC,gBAAgB,SAAS;AACtE,sBAAgB,UAAU;AAC1B,cAAQ;AAAA,QACN;AAAA,MAEF;AAAA,IACF;AACA,kBAAc,UAAU,MAAM,EAAE,QAAQ,CAAC;AACzC,eAAW;AACX,aAAS,IAAI;AACb,gBAAY,IAAI;AAAA,EAClB,GAAG,CAAC,CAAC;AACL,QAAM,OAAO,YAAY,MAAM;AAC7B,YAAQ,QAAQ,SAAS;AACzB,aAAS,IAAI;AACb,gBAAY,IAAI;AAAA,EAClB,GAAG,CAAC,CAAC;AAEL,QAAM,WAAW,YAAY,CAAC,MAAc;AAC1C,UAAM,MAAM,SAAS,SAAS,UAAU;AACxC,QAAI,QAAQ,EAAG;AACf,aAAS,KAAK,IAAI,KAAK,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;AAAA,EAC5C,GAAG,CAAC,CAAC;AACL,QAAM,OAAO,YAAY,MAAM;AAC7B,UAAM,MAAM,SAAS,SAAS,UAAU;AACxC,QAAI,QAAQ,EAAG;AACf,QAAI,SAAS,WAAW,MAAM,EAAG,QAAO;AAAA,QACnC,UAAS,SAAS,UAAU,CAAC;AAAA,EACpC,GAAG,CAAC,MAAM,CAAC;AACX,QAAM,OAAO,YAAY,MAAM;AAC7B,QAAI,SAAS,UAAU,EAAG,UAAS,SAAS,UAAU,CAAC;AAAA,EACzD,GAAG,CAAC,CAAC;AAEL,SACE,qBAAC,YAAY,UAAZ,EAAqB,OAAO,EAAE,QAAQ,UAAU,OAAO,MAAM,MAAM,MAAM,UAAU,OAAO,MAAM,GAC9F;AAAA;AAAA,IACA,UACC;AAAA,MAAC;AAAA;AAAA,QACC;AAAA,QACA;AAAA,QACA,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,QAAQ;AAAA;AAAA,IACV;AAAA,KAEJ;AAEJ;AASA,SAAS,UAAU,IAAsB;AAMvC,QAAM,IAAI,GAAG,sBAAsB;AACnC,MAAI,EAAE,SAAS,KAAK,EAAE,UAAU,EAAG,QAAO;AAC1C,QAAM,QAAQ,iBAAiB,EAAE;AACjC,SAAO,MAAM,eAAe,YAAY,MAAM,YAAY;AAC5D;AAOA,SAAS,mBAAmB,UAAkC;AAC5D,QAAM,MAAM,SAAS,iBAAiB,QAAQ;AAC9C,aAAW,MAAM,KAAK;AACpB,QAAI,UAAU,EAAE,EAAG,QAAO;AAAA,EAC5B;AACA,SAAO;AACT;AAEA,SAAS,OAAO,IAAmB;AACjC,QAAM,IAAI,GAAG,sBAAsB;AACnC,SAAO,EAAE,KAAK,EAAE,KAAK,MAAM,EAAE,MAAM,OAAO,EAAE,OAAO,QAAQ,EAAE,OAAO;AACtE;AAkCA,SAAS,YAAY;AAAA,EACnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAOG;AACD,QAAM,OAAO,MAAM,KAAK;AACxB,QAAM,UAAU,UAAU;AAC1B,QAAM,SAAS,UAAU,MAAM,SAAS;AAIxC,QAAM,CAAC,SAAS,UAAU,IAAI,SAAyB,IAAI;AAC3D,QAAM,UAAU,YAAY,QAAQ,QAAQ,UAAU,SAAS,QAAQ,SAAS,OAAO,UAAU;AACjG,QAAM,QAAQ,YAAY;AAC1B,QAAM,OAAO,SAAS,QAAQ;AAI9B,QAAM,MAAiB,SAAS,OAAO;AACvC,QAAM,UAAU,OAAuB,IAAI;AAG3C,YAAU,MAAM;AACd,QAAI,YAAY;AAChB,QAAI,MAAM;AAEV,UAAM,SAAS,CAAC,OACd,WAAW,EAAE,OAAO,MAAM,MAAM,KAAK,OAAO,EAAE,IAAI,MAAM,KAAK,MAAM,EAAE,EAAE,CAAC;AAC1E,UAAM,YAAY;AAChB,YAAM,KAAK,aAAa;AACxB,UAAI,UAAW;AACf,UAAI,CAAC,KAAK,QAAQ;AAChB,eAAO,IAAI;AACX;AAAA,MACF;AACA,UAAI,QAAQ;AACZ,YAAM,OAAO,MAAM;AACjB,YAAI,UAAW;AACf,cAAM,KAAK,mBAAmB,KAAK,MAAO;AAC1C,YAAI,IAAI;AACN,aAAG,eAAe,EAAE,OAAO,UAAU,UAAU,SAAS,CAAC;AACzD,iBAAO,EAAE;AACT;AAAA,QACF;AACA,YAAI,UAAU,GAAI,OAAM,sBAAsB,IAAI;AAAA,YAC7C,QAAO,IAAI;AAAA,MAClB;AACA,WAAK;AAAA,IACP,GAAG;AACH,WAAO,MAAM;AACX,kBAAY;AACZ,2BAAqB,GAAG;AAAA,IAC1B;AAAA,EACF,GAAG,CAAC,OAAO,IAAI,CAAC;AAIhB,YAAU,MAAM;AACd,QAAI,CAAC,KAAK,OAAQ;AAClB,UAAM,SAAS,MAAM;AACnB,YAAM,KAAK,mBAAmB,KAAK,MAAO;AAC1C,UAAI,IAAI;AACN,cAAM,OAAO,OAAO,EAAE;AACtB;AAAA,UAAW,CAAC,SACV,QAAQ,KAAK,UAAU,SAAS,KAAK,SAAS,QAAQ,CAAC,SAAS,KAAK,MAAM,IAAI,IAC3E,EAAE,GAAG,MAAM,MAAM,KAAK,IACtB;AAAA,QACN;AAAA,MACF;AAAA,IACF;AACA,WAAO,iBAAiB,UAAU,QAAQ,IAAI;AAC9C,WAAO,iBAAiB,UAAU,MAAM;AACxC,UAAM,KAAK,OAAO,YAAY,QAAQ,GAAG;AACzC,WAAO,MAAM;AACX,aAAO,oBAAoB,UAAU,QAAQ,IAAI;AACjD,aAAO,oBAAoB,UAAU,MAAM;AAC3C,oBAAc,EAAE;AAAA,IAClB;AAAA,EACF,GAAG,CAAC,OAAO,IAAI,CAAC;AAShB,QAAM,UAAU,SAAS;AACzB,YAAU,MAAM;AACd,QAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,cAAc,CAAC,KAAK,OAAQ;AAC5D,UAAM,KAAK,mBAAmB,KAAK,MAAM;AACzC,QAAI,CAAC,GAAI;AACT,UAAM,UAAU,MAAM,OAAO,WAAW,MAAM,OAAO,GAAG,CAAC;AACzD,OAAG,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;AACpD,WAAO,MAAM,GAAG,oBAAoB,SAAS,OAAO;AAAA,EACtD,GAAG,CAAC,OAAO,SAAS,OAAO,MAAM,MAAM,CAAC;AAWxC,YAAU,MAAM;AACd,UAAM,QAAQ,CAAC,MAAqB;AAClC,UAAI,EAAE,QAAQ,UAAU;AACtB,eAAO;AACP;AAAA,MACF;AACA,UAAI,EAAE,QAAQ,SAAS;AACrB,YAAI,KAAK,cAAc,QAAQ,EAAE,QAAQ,OAAO,EAAG;AACnD,UAAE,eAAe;AACjB,eAAO;AACP;AAAA,MACF;AACA,UAAI,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAG;AAE9B,YAAM,QAAQ,eAAe,EAAE,KAAK,QAAQ,OAAO;AACnD,UAAI,UAAU,GAAG;AACf,UAAE,eAAe;AACjB,eAAO;AAAA,MACT,WAAW,UAAU,IAAI;AACvB,YAAI,CAAC,QAAS,QAAO;AAAA,MACvB;AAAA,IACF;AACA,aAAS,iBAAiB,WAAW,KAAK;AAC1C,WAAO,MAAM,SAAS,oBAAoB,WAAW,KAAK;AAAA,EAC5D,GAAG,CAAC,SAAS,MAAM,QAAQ,QAAQ,MAAM,CAAC;AAE1C,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,MAAM,KAAK,WAAW;AAC5B,QAAM,OAAoB,OACtB,EAAE,KAAK,KAAK,MAAM,KAAK,MAAM,KAAK,OAAO,KAAK,OAAO,KAAK,QAAQ,MAAM,GAAG,QAAQ,KAAK,SAAS,MAAM,EAAE,IACzG;AAUJ,SAAO;AAAA,IACL;AAAA,MAAC;AAAA;AAAA,QACC,KAAK;AAAA,QACL,WAAU;AAAA,QACV,MAAK;AAAA,QACL,cAAW;AAAA,QACX,cAAY,KAAK;AAAA,QACjB;AAAA,QAEC;AAAA,kBAAQ,oBAAC,oBAAiB,MAAY;AAAA,UACtC,OACC;AAAA,YAAC;AAAA;AAAA,cACC,WAAU;AAAA,cACV,OAAO;AAAA,gBACL,KAAK,KAAK;AAAA,gBACV,MAAM,KAAK;AAAA,gBACX,OAAO,KAAK;AAAA,gBACZ,QAAQ,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAeb,WAAW;AAAA,kBACT;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,gBACF,EAAE,KAAK,IAAI;AAAA,cACb;AAAA;AAAA,UACF,IAEA,oBAAC,SAAI,WAAU,iDAAgD;AAAA,UAEjE;AAAA,YAAC;AAAA;AAAA,cACC;AAAA,cACA;AAAA,cACA,OAAO,MAAM;AAAA,cACb;AAAA,cACA;AAAA,cACA;AAAA,cACA,MAAM;AAAA,cACN;AAAA,cACA,QAAQ;AAAA,cACR;AAAA,cACA;AAAA;AAAA,UACF;AAAA;AAAA;AAAA,IACF;AAAA,IACA,SAAS;AAAA,EACX;AACF;AAIA,SAAS,QAAQ,QAA4B,KAAsB;AACjE,MAAI,EAAE,kBAAkB,aAAc,QAAO;AAC7C,MAAI,OAAO,kBAAmB,QAAO;AACrC,QAAM,MAAM,OAAO;AACnB,MAAI,QAAQ,cAAc,QAAQ,SAAU,QAAO;AACnD,MAAI,QAAQ,SAAS;AACnB,UAAM,OAAQ,OAA4B;AAE1C,WAAO,QAAQ,WAAW,SAAS;AAAA,EACrC;AACA,MAAI,QAAQ,QAAS,QAAO;AAC5B,SACE,QAAQ,YACP,QAAQ,OAAO,OAAO,aAAa,MAAM,KAC1C,OAAO,aAAa,MAAM,MAAM,YAChC,OAAO,aAAa,MAAM,MAAM;AAEpC;AAOA,SAAS,iBAAiB,EAAE,KAAK,GAAmB;AAClD,QAAM,SAAS;AACf,QAAM,SAAS,KAAK,MAAM,KAAK;AAC/B,SACE,iCACE;AAAA,wBAAC,SAAI,oBAAiB,IAAG,WAAW,QAAQ,OAAO,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,KAAK,IAAI,GAAG,KAAK,GAAG,EAAE,GAAG;AAAA,IACjH,oBAAC,SAAI,oBAAiB,IAAG,WAAW,QAAQ,OAAO,EAAE,KAAK,QAAQ,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,GAAG;AAAA,IAClG;AAAA,MAAC;AAAA;AAAA,QACC,oBAAiB;AAAA,QACjB,WAAW;AAAA,QACX,OAAO,EAAE,KAAK,KAAK,KAAK,MAAM,GAAG,OAAO,KAAK,IAAI,GAAG,KAAK,IAAI,GAAG,QAAQ,KAAK,OAAO;AAAA;AAAA,IACtF;AAAA,IACA;AAAA,MAAC;AAAA;AAAA,QACC,oBAAiB;AAAA,QACjB,WAAW;AAAA,QACX,OAAO,EAAE,KAAK,KAAK,KAAK,MAAM,KAAK,OAAO,KAAK,OAAO,OAAO,GAAG,QAAQ,KAAK,OAAO;AAAA;AAAA,IACtF;AAAA,KACF;AAEJ;AASA,SAAS,UACP,MACA,IACA,IACA,IACA,IACA,GACA,WACA,MAAiB,OACc;AAE/B,MAAI,cAAc,QAAS,aAAY,QAAQ,QAAQ,UAAU;AAAA,WACxD,cAAc,MAAO,aAAY,QAAQ,QAAQ,SAAS;AACnE,MAAI,CAAC,QAAQ,cAAc,UAAU;AACnC,WAAO,EAAE,KAAK,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,GAAG,MAAM,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,EAAE;AAAA,EAC7E;AACA,QAAM,SAAS,CAAC,MAAc,KAAK,IAAI,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC;AAC/E,QAAM,SAAS,CAAC,MAAc,KAAK,IAAI,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC;AAC/E,QAAM,UAAU,OAAO,KAAK,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC;AAC1D,QAAM,UAAU,OAAO,KAAK,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC;AAC1D,QAAM,WAAW,KAAK,MAAM,KAAK,SAAS;AAC1C,QAAM,WAAW,KAAK,MAAM,KAAK;AACjC,QAAM,YAAY,KAAK,OAAO,KAAK,QAAQ;AAC3C,QAAM,WAAW,KAAK,OAAO,KAAK;AAClC,QAAM,YAAY,WAAW,MAAM;AACnC,QAAM,YAAY,YAAY;AAC9B,QAAM,YAAY,YAAY,MAAM;AACpC,QAAM,WAAW,YAAY;AAE7B,UAAQ,WAAW;AAAA,IACjB,KAAK;AACH,aAAO,EAAE,KAAK,YAAY,WAAW,YAAY,WAAW,OAAO,QAAQ,GAAG,MAAM,QAAQ;AAAA,IAC9F,KAAK;AACH,aAAO,EAAE,KAAK,YAAY,WAAW,YAAY,WAAW,OAAO,QAAQ,GAAG,MAAM,QAAQ;AAAA,IAC9F,KAAK;AACH,aAAO,EAAE,KAAK,SAAS,MAAM,YAAY,YAAY,WAAW,WAAW,OAAO,SAAS,EAAE;AAAA,IAC/F,KAAK;AACH,aAAO,EAAE,KAAK,SAAS,MAAM,WAAW,WAAW,YAAY,YAAY,OAAO,QAAQ,EAAE;AAAA,IAC9F;AACE,UAAI,UAAW,QAAO,EAAE,KAAK,UAAU,MAAM,QAAQ;AACrD,UAAI,UAAW,QAAO,EAAE,KAAK,UAAU,MAAM,QAAQ;AACrD,aAAO,EAAE,KAAK,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,GAAG,MAAM,QAAQ;AAAA,EAC5D;AACF;AAEA,SAAS,SAAS;AAAA,EAChB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAYG;AACD,QAAM,MAAM,OAAuB,IAAI;AACvC,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAwB,EAAE,SAAS,EAAE,CAAC;AA2BhE,eAAa,KAAK,EAAE,QAAQ,KAAK,CAAC;AAElC,kBAAgB,MAAM;AACpB,UAAM,OAAO,IAAI;AACjB,QAAI,CAAC,KAAM;AACX;AAAA,MACE,UAAU,MAAM,KAAK,aAAa,KAAK,cAAc,OAAO,YAAY,OAAO,aAAa,IAAI,KAAK,WAAW,GAAG;AAAA,IACrH;AAAA,EACF,GAAG,CAAC,MAAM,OAAO,KAAK,WAAW,GAAG,CAAC;AAErC,SACE;AAAA,IAAC;AAAA;AAAA,MACC;AAAA,MAKA,UAAU;AAAA,MACV;AAAA,MACA,WAAU;AAAA,MAEV;AAAA,4BAAC,SAAI,WAAU,sCAAsC,eAAK,OAAM;AAAA,QAChE,oBAAC,SAAI,WAAU,+CAA+C,eAAK,MAAK;AAAA,QACvE,KAAK,UAAU,oBAAC,SAAI,WAAU,QAAQ,eAAK,QAAO;AAAA,QACnD,qBAAC,SAAI,WAAU,kBACb;AAAA,+BAAC,SAAI,WAAU,2CACb;AAAA;AAAA,cAAC;AAAA;AAAA,gBACC,MAAK;AAAA,gBACL,SAAS;AAAA,gBACT,WAAU;AAAA,gBAET,iBAAO;AAAA;AAAA,YACV;AAAA,YACA,qBAAC,SAAI,WAAU,2BACb;AAAA,kCAAC,UAAK,WAAU,2DACb,iBAAO,KAAK,QAAQ,GAAG,KAAK,GAC/B;AAAA,cACC,CAAC,WACA,oBAAC,UAAO,SAAQ,aAAY,SAAS,QAAQ,WAAU,uBACpD,iBAAO,MACV;AAAA,cAUD,EAAE,KAAK,cAAc,KAAK,UAAU,SACnC,oBAAC,UAAO,SAAQ,SAAQ,SAAS,QAAQ,WAAW,GAAG,qBAAqB,GACzE,mBAAS,OAAO,OAAO,OAAO,MACjC;AAAA,eAEJ;AAAA,aACF;AAAA,UACC,KAAK,cAAc,KAAK,UAAU,QACjC,oBAAC,SAAI,WAAU,+CACZ,iBAAO,gBACV;AAAA,WAEJ;AAAA;AAAA;AAAA,EACF;AAEJ;","names":[]}
|
|
@@ -15,20 +15,36 @@ import { type TourCompletions } from "./tour-info.js";
|
|
|
15
15
|
* a shape it recognises, `undefined` for any other — the kit's own shape included,
|
|
16
16
|
* which it then reads itself. keksdose: zustand's `{state: {completed}, version: 1}`;
|
|
17
17
|
* kastlan: an array of ids, completed without a date (`null`). It runs only on a stored
|
|
18
|
-
* text that is not the kit's shape already, once per text and key
|
|
19
|
-
*
|
|
20
|
-
*
|
|
18
|
+
* text that is not the kit's shape already, once per text and key. The FIRST `migrate`
|
|
19
|
+
* any reader, `TourProvider` or {@link completeTour} passes for a key is remembered for
|
|
20
|
+
* that key (later identities are ignored), so a reader without one, mounted first, no
|
|
21
|
+
* longer hides the old marks from the rest (keksdose B-2). **Still, define the options
|
|
22
|
+
* once, at module level, and hand the provider and every reader the same object.**
|
|
23
|
+
* - **Never overwritten unread** (keksdose B-1): a write (`complete`, the provider's,
|
|
24
|
+
* `completeTour`) on a stored text that is neither empty nor the kit's shape, and that no
|
|
25
|
+
* known `migrate` reads, THROWS instead of replacing the old marks.
|
|
21
26
|
* - **Resetting the device** (settings §11): register the key with `reset: () =>
|
|
22
27
|
* resetTourProgress(storageKey)`, which clears storage and the page's memory and tells
|
|
23
28
|
* every reader in this tab.
|
|
24
29
|
*
|
|
25
|
-
* The
|
|
26
|
-
*
|
|
30
|
+
* **The stored shape** (§9.3, §9.6.6), for an app's tests and seeds: the JSON record
|
|
31
|
+
* `{ [id]: ISO instant | "" }` under `storageKey`, where `""` is a completion without a
|
|
32
|
+
* date (a migrated record: kastlan's id list). That is the one written form; the hooks
|
|
33
|
+
* and callbacks (`completed`, `TourCompletions`) give `null` for `""`. A `null` read from
|
|
34
|
+
* storage (or returned by `migrate`) is accepted as the same thing and written back as
|
|
35
|
+
* `""`. To write a completion from outside a page, use {@link completeTour}.
|
|
27
36
|
*/
|
|
28
37
|
export interface UseTourProgressOptions {
|
|
29
38
|
storageKey: string;
|
|
30
39
|
migrate?: (raw: unknown) => Record<string, string | null> | undefined;
|
|
31
40
|
}
|
|
41
|
+
/** What `complete` takes: a tour id, or the tour (`{id, updated}`, a `TourInfo` fits). */
|
|
42
|
+
type CompletedTour = string | {
|
|
43
|
+
id: string;
|
|
44
|
+
updated?: {
|
|
45
|
+
date: string;
|
|
46
|
+
} | null;
|
|
47
|
+
};
|
|
32
48
|
export interface TourProgress {
|
|
33
49
|
/** Tour id → the completion's ISO timestamp, or `null` when recorded without a date. */
|
|
34
50
|
completed: TourCompletions;
|
|
@@ -39,16 +55,23 @@ export interface TourProgress {
|
|
|
39
55
|
*
|
|
40
56
|
* Returns `true` when this counts as a new completion — the moment to award the tour's
|
|
41
57
|
* points and show the app's toast (§6.1) — and `false` for a replay.
|
|
58
|
+
*
|
|
59
|
+
* A tour started with `start(steps, {tour})` under a `TourProvider` that has `progress`
|
|
60
|
+
* is recorded by the provider (§9.6.2): do not call this from that start's `onFinish`
|
|
61
|
+
* too, or the second write answers `false`.
|
|
42
62
|
*/
|
|
43
|
-
complete: (tour:
|
|
44
|
-
id: string;
|
|
45
|
-
updated?: {
|
|
46
|
-
date: string;
|
|
47
|
-
} | null;
|
|
48
|
-
}) => boolean;
|
|
63
|
+
complete: (tour: CompletedTour) => boolean;
|
|
49
64
|
/** "Mark as not done": forget the completion. */
|
|
50
65
|
reset: (id: string) => void;
|
|
51
66
|
}
|
|
67
|
+
type Migrate = NonNullable<UseTourProgressOptions["migrate"]>;
|
|
68
|
+
/**
|
|
69
|
+
* Remember `migrate` for `key` if it is the first one, and return the key's migrate. A
|
|
70
|
+
* snapshot parsed before the key had one is dropped and re-parsed, and the key's readers
|
|
71
|
+
* hear of it after this render (never from inside one).
|
|
72
|
+
* @internal Not part of the barrel; `TourProvider` registers its `progress` with it.
|
|
73
|
+
*/
|
|
74
|
+
export declare function rememberMigrate(key: string, migrate: UseTourProgressOptions["migrate"]): Migrate | undefined;
|
|
52
75
|
/**
|
|
53
76
|
* Forget every tour completion under `storageKey` on this device: the stored key, what the
|
|
54
77
|
* page kept in memory where storage refused it, and every reader in this tab moves at
|
|
@@ -57,5 +80,37 @@ export interface TourProgress {
|
|
|
57
80
|
* registerDeviceSetting({ key: TOUR_KEY, kind: "view", reset: () => resetTourProgress(TOUR_KEY) });
|
|
58
81
|
*/
|
|
59
82
|
export declare function resetTourProgress(storageKey: string): void;
|
|
83
|
+
/**
|
|
84
|
+
* Record a completion under `storageKey`, as {@link TourProgress.complete} does: through
|
|
85
|
+
* the one shared store and snapshot (never a copy), so every reader of the key moves.
|
|
86
|
+
* Returns `true` when it counts anew. `TourProvider` calls this on a tour's last step.
|
|
87
|
+
* @internal Not part of the barrel.
|
|
88
|
+
*/
|
|
89
|
+
export declare function completeStored(storageKey: string, migrate: UseTourProgressOptions["migrate"], tour: CompletedTour): boolean;
|
|
90
|
+
/**
|
|
91
|
+
* Write a completion from outside a page (§9.2): for an app's tests, seeds and scripts,
|
|
92
|
+
* beside {@link resetTourProgress}. It writes the kit's stored shape (`{[id]: ISO | ""}`)
|
|
93
|
+
* under `storageKey`, keeps the other tours' marks, and notifies every reader of the key
|
|
94
|
+
* in this tab directly (the `storage` event reaches only OTHER tabs), so a mounted
|
|
95
|
+
* `useTourProgress` or `TourCatalogue` moves at once.
|
|
96
|
+
*
|
|
97
|
+
* Unlike `complete`, it always writes (over a readable text; see below): `at` is the
|
|
98
|
+
* completion's instant (an ISO string or a `Date`, default now), `null` a completion
|
|
99
|
+
* without a date (stored as `""`, read back as `null`).
|
|
100
|
+
*
|
|
101
|
+
* completeTour(TOUR_KEY, "budget", "2026-09-01T10:00:00Z");
|
|
102
|
+
*
|
|
103
|
+
* A stored text in an app's older shape is read through `opts.migrate`, or else the
|
|
104
|
+
* migrate a reader or the provider registered for the key. If the text is neither empty
|
|
105
|
+
* nor the kit's shape and no migrate reads it, this THROWS and writes nothing (B-1):
|
|
106
|
+
*
|
|
107
|
+
* completeTour(TOUR_KEY, "budget", undefined, { migrate: fromZustand });
|
|
108
|
+
*/
|
|
109
|
+
export declare function completeTour(storageKey: string, tour: string | {
|
|
110
|
+
id: string;
|
|
111
|
+
}, at?: string | Date | null, opts?: {
|
|
112
|
+
migrate?: UseTourProgressOptions["migrate"];
|
|
113
|
+
}): void;
|
|
60
114
|
/** The device's tour completions under `storageKey`; see {@link UseTourProgressOptions}. */
|
|
61
115
|
export declare function useTourProgress({ storageKey, migrate }: UseTourProgressOptions): TourProgress;
|
|
116
|
+
export {};
|