@eifi1/ui-kit 0.43.0 → 0.44.0

package/README.md

@@ -556,19 +556,19 @@ columns, strings and permissions (see the note at the top of `src/feedback/feedb
 
 <!-- BEGIN GENERATED: exports — node scripts/gen-export-inventory.mjs -->
 
-**2079 names from 341 modules** — 958 values and 1121 types. _Italic_ is a type-only export.
+**2081 names from 341 modules** — 959 values and 1122 types. _Italic_ is a type-only export.
 
 Generated from `dist/index.d.ts` by `node scripts/gen-export-inventory.mjs`; the count
 is pinned by `src/__tests__/public-surface.test.ts`. Do not edit between the markers.
 
 | Entry point | Names |
 |---|---|
-| `@eifi1/ui-kit` | 2079 |
+| `@eifi1/ui-kit` | 2081 |
 | `@eifi1/ui-kit/chart` | 92 |
 | `@eifi1/ui-kit/shell` | 110 |
 | `@eifi1/ui-kit/data-table` | 51 |
 | `@eifi1/ui-kit/wizard` | 24 |
-| `@eifi1/ui-kit/tour` | 31 |
+| `@eifi1/ui-kit/tour` | 33 |
 | `@eifi1/ui-kit/feedback` | 205 |
 | `@eifi1/ui-kit/search` | 23 |
 | `@eifi1/ui-kit/dates` | 22 |
@@ -899,10 +899,10 @@ re-slicing of it, never a second API.
 
 | Module | Exports |
 |---|---|
-| `tour/tour` | `DEFAULT_TOUR_LABELS`, `TourProvider`, `useTour`, `useTourOptional`, _`TourLabels`_, _`TourPlacement`_, _`TourStep`_ |
+| `tour/tour` | `DEFAULT_TOUR_LABELS`, `TourProvider`, `useTour`, `useTourOptional`, _`TourCompletion`_, _`TourLabels`_, _`TourPlacement`_, _`TourStep`_ |
 | `tour/tour-catalogue` | `DEFAULT_TOUR_CATALOGUE_LABELS`, `TourCatalogue`, `TourCatalogueCard`, _`TourCatalogueCardProps`_, _`TourCatalogueLabels`_, _`TourCatalogueProps`_ |
 | `tour/tour-info` | `doneCount`, `earnedPoints`, `isTourDone`, `isTourNew`, `isTourReset`, _`TourCompletions`_, _`TourGroup`_, _`TourInfo`_, _`TourUpdate`_ |
-| `tour/use-tour-progress` | `resetTourProgress`, `useTourProgress`, _`TourProgress`_, _`UseTourProgressOptions`_ |
+| `tour/use-tour-progress` | `completeTour`, `resetTourProgress`, `useTourProgress`, _`TourProgress`_, _`UseTourProgressOptions`_ |
 | `tour/use-tour-url-sync` | `useTourCatalogueUrlState`, `useTourUrlSync`, _`TourCatalogueFilter`_, _`TourStateFilter`_, _`UseTourUrlSyncOptions`_ |
 
 ### search

package/dist/billing/provider-page.d.ts

@@ -36,5 +36,14 @@ export interface OpenProviderPageOptions {
  *     />
  *
  * Resolves with the way it went.
+ *
+ * **The test seam is `options.window`** (docs/tours-harmonization.md §9.5, kk 7): an app's
+ * test passes a stub with `open` (returning a fake tab, or `null` for a blocked pop-up)
+ * and `location.assign`, instead of patching the global `window`:
+ *
+ *     const tab = { opener: {}, closed: false, location: { href: "" }, close: vi.fn() };
+ *     const win = { open: vi.fn(() => tab), location: { assign: vi.fn() } } as unknown as Window;
+ *     await openProviderPage(async () => "https://pay.example/portal", { window: win });
+ *     expect(tab.location.href).toBe("https://pay.example/portal");
  */
 export declare function openProviderPage(fetchUrl: () => Promise<string>, options?: OpenProviderPageOptions): Promise<ProviderPageWay>;

package/dist/billing/provider-page.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/billing/provider-page.ts"],"sourcesContent":["/**\n * The provider's hosted portal in a NEW TAB (0.43, docs/billing-harmonization.md §17):\n * \"Payment and invoices\", the portal's \"Cancel subscription\" and the payment-failed\n * banner's \"Update payment method\" open at the provider while the app stays open where\n * it was. kastlan's `usePortal` (feat/kit-0.42, `72c3177`) is the reference.\n *\n * The checkout is NOT one of them (§17.4): it stays in the same tab, since the page waits\n * for the payer's return (`useCheckoutProcessing`).\n */\n\n/** How the page went: in a tab of its own, or — the browser refused one — in this one. */\nexport type ProviderPageWay = \"new-tab\" | \"same-tab\";\n\nexport interface OpenProviderPageOptions {\n  /** The window to open from and to fall back to. Default the global `window` (a test's\n   *  or an iframe's own). */\n  window?: Window;\n}\n\n/**\n * Opens the provider's page in a new tab, from INSIDE the click: call it in the click\n * handler itself, before any `await` — a `window.open` after one is blocked as a pop-up.\n *\n * 1. opens `about:blank` synchronously and sets its `opener` to `null`, so the provider's\n *    page cannot reach back into the app;\n * 2. awaits `fetchUrl` — the app's `POST /billing/portal` with its target, answering the\n *    `url` (the kit sends no request);\n * 3. points the tab at the URL;\n * 4. on a refusal closes the tab again and rethrows, so the app shows its error;\n * 5. where the browser refused the tab (a pop-up blocker), or it was closed while the\n *    URL was on its way, the app's own page goes there instead.\n *\n *     <SubscriptionActions\n *       onPortal={(target) => {\n *         openProviderPage(() => api.billingPortal({ target }).then((r) => r.url)).catch(showError);\n *       }}\n *       providerName=\"Paddle\"\n *       appName=\"Kastlan\"\n *     />\n *\n * Resolves with the way it went.\n */\nexport async function openProviderPage(\n  fetchUrl: () => Promise<string>,\n  options: OpenProviderPageOptions = {},\n): Promise<ProviderPageWay> {\n  const win = options.window ?? window;\n  let tab: Window | null;\n  try {\n    tab = win.open(\"about:blank\", \"_blank\");\n  } catch {\n    tab = null;\n  }\n  if (tab) {\n    try {\n      // The provider's page must not reach back into the app.\n      tab.opener = null;\n    } catch {\n      /* a browser that guards `opener`: the tab is still ours to point */\n    }\n  }\n  let url: string;\n  try {\n    url = await fetchUrl();\n  } catch (error) {\n    tab?.close();\n    throw error;\n  }\n  if (tab && !tab.closed) {\n    tab.location.href = url;\n    return \"new-tab\";\n  }\n  win.location.assign(url);\n  return \"same-tab\";\n}\n"],"mappings":";AA0CA,eAAsB,iBACpB,UACA,UAAmC,CAAC,GACV;AAC1B,QAAM,MAAM,QAAQ,UAAU;AAC9B,MAAI;AACJ,MAAI;AACF,UAAM,IAAI,KAAK,eAAe,QAAQ;AAAA,EACxC,QAAQ;AACN,UAAM;AAAA,EACR;AACA,MAAI,KAAK;AACP,QAAI;AAEF,UAAI,SAAS;AAAA,IACf,QAAQ;AAAA,IAER;AAAA,EACF;AACA,MAAI;AACJ,MAAI;AACF,UAAM,MAAM,SAAS;AAAA,EACvB,SAAS,OAAO;AACd,SAAK,MAAM;AACX,UAAM;AAAA,EACR;AACA,MAAI,OAAO,CAAC,IAAI,QAAQ;AACtB,QAAI,SAAS,OAAO;AACpB,WAAO;AAAA,EACT;AACA,MAAI,SAAS,OAAO,GAAG;AACvB,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../src/billing/provider-page.ts"],"sourcesContent":["/**\n * The provider's hosted portal in a NEW TAB (0.43, docs/billing-harmonization.md §17):\n * \"Payment and invoices\", the portal's \"Cancel subscription\" and the payment-failed\n * banner's \"Update payment method\" open at the provider while the app stays open where\n * it was. kastlan's `usePortal` (feat/kit-0.42, `72c3177`) is the reference.\n *\n * The checkout is NOT one of them (§17.4): it stays in the same tab, since the page waits\n * for the payer's return (`useCheckoutProcessing`).\n */\n\n/** How the page went: in a tab of its own, or — the browser refused one — in this one. */\nexport type ProviderPageWay = \"new-tab\" | \"same-tab\";\n\nexport interface OpenProviderPageOptions {\n  /** The window to open from and to fall back to. Default the global `window` (a test's\n   *  or an iframe's own). */\n  window?: Window;\n}\n\n/**\n * Opens the provider's page in a new tab, from INSIDE the click: call it in the click\n * handler itself, before any `await` — a `window.open` after one is blocked as a pop-up.\n *\n * 1. opens `about:blank` synchronously and sets its `opener` to `null`, so the provider's\n *    page cannot reach back into the app;\n * 2. awaits `fetchUrl` — the app's `POST /billing/portal` with its target, answering the\n *    `url` (the kit sends no request);\n * 3. points the tab at the URL;\n * 4. on a refusal closes the tab again and rethrows, so the app shows its error;\n * 5. where the browser refused the tab (a pop-up blocker), or it was closed while the\n *    URL was on its way, the app's own page goes there instead.\n *\n *     <SubscriptionActions\n *       onPortal={(target) => {\n *         openProviderPage(() => api.billingPortal({ target }).then((r) => r.url)).catch(showError);\n *       }}\n *       providerName=\"Paddle\"\n *       appName=\"Kastlan\"\n *     />\n *\n * Resolves with the way it went.\n *\n * **The test seam is `options.window`** (docs/tours-harmonization.md §9.5, kk 7): an app's\n * test passes a stub with `open` (returning a fake tab, or `null` for a blocked pop-up)\n * and `location.assign`, instead of patching the global `window`:\n *\n *     const tab = { opener: {}, closed: false, location: { href: \"\" }, close: vi.fn() };\n *     const win = { open: vi.fn(() => tab), location: { assign: vi.fn() } } as unknown as Window;\n *     await openProviderPage(async () => \"https://pay.example/portal\", { window: win });\n *     expect(tab.location.href).toBe(\"https://pay.example/portal\");\n */\nexport async function openProviderPage(\n  fetchUrl: () => Promise<string>,\n  options: OpenProviderPageOptions = {},\n): Promise<ProviderPageWay> {\n  const win = options.window ?? window;\n  let tab: Window | null;\n  try {\n    tab = win.open(\"about:blank\", \"_blank\");\n  } catch {\n    tab = null;\n  }\n  if (tab) {\n    try {\n      // The provider's page must not reach back into the app.\n      tab.opener = null;\n    } catch {\n      /* a browser that guards `opener`: the tab is still ours to point */\n    }\n  }\n  let url: string;\n  try {\n    url = await fetchUrl();\n  } catch (error) {\n    tab?.close();\n    throw error;\n  }\n  if (tab && !tab.closed) {\n    tab.location.href = url;\n    return \"new-tab\";\n  }\n  win.location.assign(url);\n  return \"same-tab\";\n}\n"],"mappings":";AAmDA,eAAsB,iBACpB,UACA,UAAmC,CAAC,GACV;AAC1B,QAAM,MAAM,QAAQ,UAAU;AAC9B,MAAI;AACJ,MAAI;AACF,UAAM,IAAI,KAAK,eAAe,QAAQ;AAAA,EACxC,QAAQ;AACN,UAAM;AAAA,EACR;AACA,MAAI,KAAK;AACP,QAAI;AAEF,UAAI,SAAS;AAAA,IACf,QAAQ;AAAA,IAER;AAAA,EACF;AACA,MAAI;AACJ,MAAI;AACF,UAAM,MAAM,SAAS;AAAA,EACvB,SAAS,OAAO;AACd,SAAK,MAAM;AACX,UAAM;AAAA,EACR;AACA,MAAI,OAAO,CAAC,IAAI,QAAQ;AACtB,QAAI,SAAS,OAAO;AACpB,WAAO;AAAA,EACT;AACA,MAAI,SAAS,OAAO,GAAG;AACvB,SAAO;AACT;","names":[]}

package/dist/eslint/index.js

@@ -47,7 +47,7 @@ const roleUtilities = {
     };
   }
 };
-const VERSION = true ? "0.43.0" : "0.0.0-source";
+const VERSION = true ? "0.44.0" : "0.0.0-source";
 const recommended = {
   name: "@eifi1/ui-kit/recommended",
   // Not the tests, as check:tokens skips the kit's: a test names the old class to assert it

package/dist/i18n/german.js

@@ -594,12 +594,12 @@ function germanLabels(numberLocale) {
       stateDone: (count) => `Abgeschlossen (${n(count)})`,
       showing: (shown, total) => `${n(shown)} von ${n(total)} Touren`,
       noMatches: "Keine Tour passt",
-      noMatchesHint: "Versuchen Sie ein anderes Wort, oder setzen Sie die Filter zur\xFCck.",
+      noMatchesHint: "Anderes Wort versuchen oder Filter zur\xFCcksetzen.",
       clearFilters: "Filter zur\xFCcksetzen",
       badgeNew: "Neu",
       badgeUpdated: "Aktualisiert",
       resetOn: (date, reason) => reason ? `Zur\xFCckgesetzt am ${date}: ${reason}` : `Zur\xFCckgesetzt am ${date}`,
-      points: (count) => `+${n(count)} Pkt.`,
+      points: (count) => `+${n(count)} Pkt`,
       steps: (count) => count === 1 ? `${n(count)} Schritt` : `${n(count)} Schritte`,
       duration: (minutes) => `Etwa ${n(minutes)} Min.`,
       completedOn: (date) => `Abgeschlossen am ${date}`,