@eifi1/ui-kit 0.54.0 → 0.55.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 +90 -76
- package/dist/admin/plan-change.js +2 -2
- package/dist/admin/plan-change.js.map +1 -1
- package/dist/admin/user-roster.d.ts +6 -0
- package/dist/admin/user-roster.js +4 -0
- package/dist/admin/user-roster.js.map +1 -1
- package/dist/billing/billing-labels.d.ts +26 -0
- package/dist/billing/billing-labels.js +9 -0
- package/dist/billing/billing-labels.js.map +1 -1
- package/dist/billing/subscription-standing.d.ts +61 -0
- package/dist/billing/subscription-standing.js +51 -0
- package/dist/billing/subscription-standing.js.map +1 -0
- package/dist/billing/usage-meter.d.ts +52 -0
- package/dist/billing/usage-meter.js +52 -0
- package/dist/billing/usage-meter.js.map +1 -0
- package/dist/chart.d.ts +1 -0
- package/dist/chart.js +4 -0
- package/dist/chart.js.map +1 -1
- package/dist/components/alert-banner.js +2 -3
- package/dist/components/alert-banner.js.map +1 -1
- package/dist/components/amount-input.js +3 -15
- package/dist/components/amount-input.js.map +1 -1
- package/dist/components/autocomplete.js +2 -2
- package/dist/components/autocomplete.js.map +1 -1
- package/dist/components/bulk-action-bar.js +2 -1
- package/dist/components/bulk-action-bar.js.map +1 -1
- package/dist/components/button.d.ts +35 -1
- package/dist/components/button.js +5 -9
- package/dist/components/button.js.map +1 -1
- package/dist/components/calendar-heatmap.js +2 -2
- package/dist/components/calendar-heatmap.js.map +1 -1
- package/dist/components/camera-button.d.ts +89 -0
- package/dist/components/camera-button.js +122 -0
- package/dist/components/camera-button.js.map +1 -0
- package/dist/components/camera-capture.d.ts +66 -0
- package/dist/components/camera-capture.js +190 -0
- package/dist/components/camera-capture.js.map +1 -0
- package/dist/components/camera-labels.d.ts +20 -0
- package/dist/components/camera-labels.js +15 -0
- package/dist/components/camera-labels.js.map +1 -0
- package/dist/components/chart-edge.d.ts +9 -0
- package/dist/components/chart-edge.js +14 -3
- package/dist/components/chart-edge.js.map +1 -1
- package/dist/components/chart-zoom-core.js +34 -29
- package/dist/components/chart-zoom-core.js.map +1 -1
- package/dist/components/checkbox-group.js +1 -1
- package/dist/components/checkbox-group.js.map +1 -1
- package/dist/components/combobox-core.js +3 -2
- package/dist/components/combobox-core.js.map +1 -1
- package/dist/components/combobox.js +2 -2
- package/dist/components/combobox.js.map +1 -1
- package/dist/components/consent-again-notice-labels.d.ts +25 -0
- package/dist/components/consent-again-notice-labels.js +15 -0
- package/dist/components/consent-again-notice-labels.js.map +1 -0
- package/dist/components/consent-again-notice.d.ts +85 -0
- package/dist/components/consent-again-notice.js +94 -0
- package/dist/components/consent-again-notice.js.map +1 -0
- package/dist/components/country-select.js +2 -7
- package/dist/components/country-select.js.map +1 -1
- package/dist/components/currency-select.js +2 -2
- package/dist/components/currency-select.js.map +1 -1
- package/dist/components/danger-confirm.js +2 -2
- package/dist/components/danger-confirm.js.map +1 -1
- package/dist/components/data-table-column-settings.js +2 -2
- package/dist/components/data-table-column-settings.js.map +1 -1
- package/dist/components/data-table-fit.js.map +1 -1
- package/dist/components/data-table-virtual.js +13 -3
- package/dist/components/data-table-virtual.js.map +1 -1
- package/dist/components/date-field.js +2 -2
- package/dist/components/date-field.js.map +1 -1
- package/dist/components/date-picker.js +2 -2
- package/dist/components/date-picker.js.map +1 -1
- package/dist/components/date-range-picker.js +2 -6
- package/dist/components/date-range-picker.js.map +1 -1
- package/dist/components/dialog-frame.d.ts +3 -1
- package/dist/components/dialog-frame.js.map +1 -1
- package/dist/components/dropdown.js +7 -3
- package/dist/components/dropdown.js.map +1 -1
- package/dist/components/entity-combobox.js +2 -2
- package/dist/components/entity-combobox.js.map +1 -1
- package/dist/components/field-parts.d.ts +108 -6
- package/dist/components/field-parts.js +59 -6
- package/dist/components/field-parts.js.map +1 -1
- package/dist/components/field-suggestion-labels.d.ts +2 -0
- package/dist/components/field-suggestion-labels.js +10 -0
- package/dist/components/field-suggestion-labels.js.map +1 -0
- package/dist/components/field.js +1 -1
- package/dist/components/field.js.map +1 -1
- package/dist/components/file-button.d.ts +1 -1
- package/dist/components/file-button.js.map +1 -1
- package/dist/components/floating-panel.d.ts +7 -6
- package/dist/components/floating-panel.js +3 -17
- package/dist/components/floating-panel.js.map +1 -1
- package/dist/components/form-actions.d.ts +3 -2
- package/dist/components/form-actions.js.map +1 -1
- package/dist/components/hover-menu.js +3 -2
- package/dist/components/hover-menu.js.map +1 -1
- package/dist/components/icon-button.d.ts +23 -5
- package/dist/components/icon-button.js +6 -8
- package/dist/components/icon-button.js.map +1 -1
- package/dist/components/inline-confirm.js +2 -1
- package/dist/components/inline-confirm.js.map +1 -1
- package/dist/components/inline-entity-combobox.js +2 -2
- package/dist/components/inline-entity-combobox.js.map +1 -1
- package/dist/components/input.js +2 -2
- package/dist/components/input.js.map +1 -1
- package/dist/components/jump-calendar.js +3 -3
- package/dist/components/jump-calendar.js.map +1 -1
- package/dist/components/legal.d.ts +13 -1
- package/dist/components/legal.js +12 -0
- package/dist/components/legal.js.map +1 -1
- package/dist/components/legended-series-chart.d.ts +80 -0
- package/dist/components/legended-series-chart.js +70 -0
- package/dist/components/legended-series-chart.js.map +1 -0
- package/dist/components/lightbox.js +2 -1
- package/dist/components/lightbox.js.map +1 -1
- package/dist/components/mini-calendar.js +13 -5
- package/dist/components/mini-calendar.js.map +1 -1
- package/dist/components/modal.d.ts +23 -2
- package/dist/components/modal.js +24 -6
- package/dist/components/modal.js.map +1 -1
- package/dist/components/month-picker.d.ts +1 -1
- package/dist/components/month-picker.js +6 -6
- package/dist/components/month-picker.js.map +1 -1
- package/dist/components/multi-entity-combobox.js +2 -2
- package/dist/components/multi-entity-combobox.js.map +1 -1
- package/dist/components/multi-select.js +2 -6
- package/dist/components/multi-select.js.map +1 -1
- package/dist/components/number-input.js +2 -2
- package/dist/components/number-input.js.map +1 -1
- package/dist/components/page-header-layout.d.ts +18 -0
- package/dist/components/page-header-layout.js +23 -0
- package/dist/components/page-header-layout.js.map +1 -0
- package/dist/components/page-header-skeleton.d.ts +41 -0
- package/dist/components/page-header-skeleton.js +52 -0
- package/dist/components/page-header-skeleton.js.map +1 -0
- package/dist/components/page-header.js +4 -17
- package/dist/components/page-header.js.map +1 -1
- package/dist/components/popover.js +7 -2
- package/dist/components/popover.js.map +1 -1
- package/dist/components/release-notes-labels.d.ts +16 -0
- package/dist/components/release-notes-labels.js +18 -0
- package/dist/components/release-notes-labels.js.map +1 -0
- package/dist/components/release-notes.d.ts +65 -0
- package/dist/components/release-notes.js +65 -0
- package/dist/components/release-notes.js.map +1 -0
- package/dist/components/select.js +2 -2
- package/dist/components/select.js.map +1 -1
- package/dist/components/series-chart-labels.d.ts +9 -0
- package/dist/components/series-chart-labels.js +3 -1
- package/dist/components/series-chart-labels.js.map +1 -1
- package/dist/components/series-chart.d.ts +5 -0
- package/dist/components/series-chart.js +89 -36
- package/dist/components/series-chart.js.map +1 -1
- package/dist/components/toggle-group.js +3 -2
- package/dist/components/toggle-group.js.map +1 -1
- package/dist/components/treemap-layout.js.map +1 -1
- package/dist/components/treemap.d.ts +17 -15
- package/dist/components/treemap.js +167 -85
- package/dist/components/treemap.js.map +1 -1
- package/dist/eslint/index.js +1 -1
- package/dist/eslint/role-utilities.d.ts +2 -2
- package/dist/eslint/role-utilities.js.map +1 -1
- package/dist/feedback/feedback-inbox-page.d.ts +260 -0
- package/dist/feedback/feedback-inbox-page.js +207 -0
- package/dist/feedback/feedback-inbox-page.js.map +1 -0
- package/dist/feedback/feedback-vocabulary.js +2 -2
- package/dist/feedback/feedback-vocabulary.js.map +1 -1
- package/dist/feedback.d.ts +1 -0
- package/dist/feedback.js +6 -0
- package/dist/feedback.js.map +1 -1
- package/dist/hooks/use-debounce.d.ts +32 -5
- package/dist/hooks/use-debounce.js +6 -5
- package/dist/hooks/use-debounce.js.map +1 -1
- package/dist/hooks/use-file-picker.d.ts +3 -1
- package/dist/hooks/use-file-picker.js.map +1 -1
- package/dist/hooks/use-focus-trap.d.ts +19 -3
- package/dist/hooks/use-focus-trap.js +15 -5
- package/dist/hooks/use-focus-trap.js.map +1 -1
- package/dist/hooks/use-has-camera.d.ts +36 -0
- package/dist/hooks/use-has-camera.js +53 -0
- package/dist/hooks/use-has-camera.js.map +1 -0
- package/dist/hooks/use-hotkey.js +1 -10
- package/dist/hooks/use-hotkey.js.map +1 -1
- package/dist/hooks/use-overlay-history.d.ts +6 -1
- package/dist/hooks/use-overlay-history.js +10 -2
- package/dist/hooks/use-overlay-history.js.map +1 -1
- package/dist/i18n/defaults.js +11 -1
- package/dist/i18n/defaults.js.map +1 -1
- package/dist/i18n/german.js +75 -3
- package/dist/i18n/german.js.map +1 -1
- package/dist/i18n/kit-labels.d.ts +20 -0
- package/dist/i18n/kit-labels.js.map +1 -1
- package/dist/i18n/locales/en.js +92 -4
- package/dist/i18n/locales/en.js.map +3 -3
- package/dist/i18n/locales/es.js +71 -3
- package/dist/i18n/locales/es.js.map +1 -1
- package/dist/i18n/locales/fr.js +72 -2
- package/dist/i18n/locales/fr.js.map +1 -1
- package/dist/i18n/locales/hu.js +74 -3
- package/dist/i18n/locales/hu.js.map +1 -1
- package/dist/i18n/locales/it.js +74 -3
- package/dist/i18n/locales/it.js.map +1 -1
- package/dist/i18n/locales/zh.js +71 -3
- package/dist/i18n/locales/zh.js.map +1 -1
- package/dist/i18n/review.js +22 -1
- package/dist/i18n/review.js.map +1 -1
- package/dist/index.d.ts +24 -5
- package/dist/index.js +35 -1
- package/dist/index.js.map +1 -1
- package/dist/landing/landing-labels.d.ts +8 -0
- package/dist/landing/landing-labels.js +2 -1
- package/dist/landing/landing-labels.js.map +1 -1
- package/dist/lib/changelog.d.ts +130 -0
- package/dist/lib/changelog.js +137 -0
- package/dist/lib/changelog.js.map +1 -0
- package/dist/lib/clipboard-minus.js +2 -2
- package/dist/lib/clipboard-minus.js.map +1 -1
- package/dist/lib/dates.d.ts +29 -3
- package/dist/lib/dates.js +41 -12
- package/dist/lib/dates.js.map +1 -1
- package/dist/lib/editable-content.d.ts +33 -0
- package/dist/lib/editable-content.js +15 -0
- package/dist/lib/editable-content.js.map +1 -0
- package/dist/lib/focus-left.d.ts +47 -1
- package/dist/lib/focus-left.js +11 -2
- package/dist/lib/focus-left.js.map +1 -1
- package/dist/lib/server-wake.d.ts +49 -9
- package/dist/lib/server-wake.js +25 -14
- package/dist/lib/server-wake.js.map +1 -1
- package/dist/lib/session-refresh.d.ts +53 -0
- package/dist/lib/session-refresh.js +27 -1
- package/dist/lib/session-refresh.js.map +1 -1
- package/dist/rhf/fields.js +3 -3
- package/dist/rhf/fields.js.map +1 -1
- package/dist/shell/app-shell.d.ts +25 -1
- package/dist/shell/app-shell.js +3 -1
- package/dist/shell/app-shell.js.map +1 -1
- package/dist/shell/dev-menu.d.ts +3 -0
- package/dist/shell/dev-menu.js +4 -2
- package/dist/shell/dev-menu.js.map +1 -1
- package/dist/shell/held-changes-banner-labels.d.ts +23 -0
- package/dist/shell/held-changes-banner-labels.js +14 -0
- package/dist/shell/held-changes-banner-labels.js.map +1 -0
- package/dist/shell/held-changes-banner.d.ts +75 -0
- package/dist/shell/held-changes-banner.js +106 -0
- package/dist/shell/held-changes-banner.js.map +1 -0
- package/dist/shell/sync-status-indicator.d.ts +27 -12
- package/dist/shell/sync-status-indicator.js +13 -4
- package/dist/shell/sync-status-indicator.js.map +1 -1
- package/dist/shell/top-bar-parts-labels.d.ts +5 -0
- package/dist/shell/top-bar-parts-labels.js +3 -1
- package/dist/shell/top-bar-parts-labels.js.map +1 -1
- package/dist/shell.d.ts +2 -0
- package/dist/shell.js +3 -0
- package/dist/shell.js.map +1 -1
- package/dist/sync/engine.d.ts +11 -2
- package/dist/sync/engine.js +13 -5
- package/dist/sync/engine.js.map +1 -1
- package/dist/sync/hooks.d.ts +3 -2
- package/dist/sync/hooks.js +4 -2
- package/dist/sync/hooks.js.map +1 -1
- package/dist/testing/css-variables.generated.d.ts +2 -2
- package/dist/testing/css-variables.generated.js +1 -1
- package/dist/testing/css-variables.generated.js.map +1 -1
- package/dist/theme/chart-palette.d.ts +18 -0
- package/dist/theme/chart-palette.js +17 -1
- package/dist/theme/chart-palette.js.map +1 -1
- package/dist/theme/contrast-tokens.d.ts +3 -3
- package/dist/theme/contrast-tokens.js.map +1 -1
- package/dist/theme/contrast.d.ts +4 -4
- package/dist/theme/contrast.js.map +1 -1
- package/dist/tour/tour-overlay.js +2 -1
- package/dist/tour/tour-overlay.js.map +1 -1
- package/package.json +5 -9
- package/tokens.css +19 -54
- package/src/account/account-parts.ts +0 -47
- package/src/account/account-settings-labels.ts +0 -240
- package/src/account/account-settings.tsx +0 -698
- package/src/account/data-export-setting-labels.ts +0 -20
- package/src/account/data-export-setting.tsx +0 -200
- package/src/account/delete-account-setting-labels.ts +0 -33
- package/src/account/delete-account-setting.tsx +0 -342
- package/src/account/email-change-setting-labels.ts +0 -31
- package/src/account/email-change-setting.tsx +0 -443
- package/src/account/passkeys-setting.tsx +0 -445
- package/src/account/sessions-setting-labels.ts +0 -24
- package/src/account/sessions-setting.tsx +0 -283
- package/src/admin/admin-action-confirm-labels.ts +0 -19
- package/src/admin/admin-action-confirm.tsx +0 -509
- package/src/admin/admin-action-log-labels.ts +0 -83
- package/src/admin/admin-action-log.tsx +0 -464
- package/src/admin/admin-area-labels.ts +0 -114
- package/src/admin/admin-forbidden.tsx +0 -75
- package/src/admin/admin-overview.tsx +0 -258
- package/src/admin/admin-parts.ts +0 -68
- package/src/admin/admin-sections.tsx +0 -208
- package/src/admin/admin-tool-links.tsx +0 -90
- package/src/admin/invitations-panel-labels.ts +0 -31
- package/src/admin/invitations-panel.tsx +0 -516
- package/src/admin/mail-test-card-labels.ts +0 -19
- package/src/admin/mail-test-card.tsx +0 -189
- package/src/admin/plan-change-labels.ts +0 -5
- package/src/admin/plan-change.tsx +0 -474
- package/src/admin/reviewer-scope-editor-labels.ts +0 -16
- package/src/admin/reviewer-scope-editor.tsx +0 -224
- package/src/admin/role-select-labels.ts +0 -16
- package/src/admin/role-select.tsx +0 -282
- package/src/admin/transfer-ownership-dialog-labels.ts +0 -20
- package/src/admin/transfer-ownership-dialog.tsx +0 -162
- package/src/admin/user-roster-labels.ts +0 -17
- package/src/admin/user-roster.tsx +0 -559
- package/src/auth/accept-invitation-labels.ts +0 -21
- package/src/auth/accept-invitation.tsx +0 -210
- package/src/auth/auth-errors-labels.ts +0 -23
- package/src/auth/auth-errors.ts +0 -439
- package/src/auth/complete-name-dialog-labels.ts +0 -16
- package/src/auth/complete-name-dialog.tsx +0 -253
- package/src/auth/email-tag.ts +0 -75
- package/src/auth/forgot-password-form-labels.ts +0 -20
- package/src/auth/forgot-password-form.tsx +0 -221
- package/src/auth/form-rules.ts +0 -40
- package/src/auth/new-password-fields.tsx +0 -85
- package/src/auth/not-found-page-labels.ts +0 -12
- package/src/auth/not-found-page.tsx +0 -95
- package/src/auth/register-form-labels.ts +0 -31
- package/src/auth/register-form.tsx +0 -456
- package/src/auth/reset-password-form-labels.ts +0 -27
- package/src/auth/reset-password-form.tsx +0 -341
- package/src/auth/sign-in-form-labels.ts +0 -44
- package/src/auth/sign-in-form.tsx +0 -858
- package/src/auth/status-parts.tsx +0 -132
- package/src/auth/verify-email-labels.ts +0 -26
- package/src/auth/verify-email.tsx +0 -445
- package/src/billing/billing-banner.tsx +0 -258
- package/src/billing/billing-labels.ts +0 -381
- package/src/billing/billing-lock.ts +0 -108
- package/src/billing/billing-overview.ts +0 -157
- package/src/billing/billing-standing.ts +0 -80
- package/src/billing/cancel-request.ts +0 -97
- package/src/billing/cancel-subscription.tsx +0 -98
- package/src/billing/checkout-processing.ts +0 -394
- package/src/billing/checkout-return.ts +0 -90
- package/src/billing/pay-page.ts +0 -330
- package/src/billing/plan-card.tsx +0 -562
- package/src/billing/plan-change-labels.ts +0 -66
- package/src/billing/plan-limit-notice.tsx +0 -148
- package/src/billing/plan-limit-toast.tsx +0 -90
- package/src/billing/plan-limit.ts +0 -52
- package/src/billing/plan-price.ts +0 -98
- package/src/billing/plan-switch.tsx +0 -216
- package/src/billing/provider-page.ts +0 -84
- package/src/billing/subscription-actions.tsx +0 -247
- package/src/billing/subscription-status-chip.tsx +0 -95
- package/src/chart.ts +0 -103
- package/src/components/account-chips-labels.ts +0 -16
- package/src/components/account-chips.tsx +0 -474
- package/src/components/alert-banner.tsx +0 -670
- package/src/components/amount-input.tsx +0 -816
- package/src/components/appearance-labels.ts +0 -63
- package/src/components/authed-image-labels.ts +0 -11
- package/src/components/authed-image.tsx +0 -209
- package/src/components/autocomplete.tsx +0 -645
- package/src/components/breadcrumbs-labels.ts +0 -10
- package/src/components/breadcrumbs.tsx +0 -205
- package/src/components/bulk-action-bar-labels.ts +0 -11
- package/src/components/bulk-action-bar.tsx +0 -443
- package/src/components/button-group.tsx +0 -223
- package/src/components/button-look.ts +0 -256
- package/src/components/button.tsx +0 -339
- package/src/components/calculator.tsx +0 -341
- package/src/components/calendar-heatmap-labels.ts +0 -15
- package/src/components/calendar-heatmap.tsx +0 -600
- package/src/components/card.tsx +0 -377
- package/src/components/chart-edge.ts +0 -106
- package/src/components/chart-figure.tsx +0 -35
- package/src/components/chart-height.ts +0 -30
- package/src/components/chart-zoom-core.tsx +0 -627
- package/src/components/chart-zoom.tsx +0 -22
- package/src/components/chart.tsx +0 -554
- package/src/components/checkbox-group.tsx +0 -247
- package/src/components/checkbox.tsx +0 -346
- package/src/components/chip-input.tsx +0 -370
- package/src/components/chip-labels.ts +0 -13
- package/src/components/chip.tsx +0 -843
- package/src/components/choice-card.tsx +0 -544
- package/src/components/column-mapper-labels.ts +0 -38
- package/src/components/column-mapper.tsx +0 -655
- package/src/components/combobox-core.tsx +0 -1321
- package/src/components/combobox-suggestions.tsx +0 -131
- package/src/components/combobox.tsx +0 -716
- package/src/components/confirm-context.ts +0 -7
- package/src/components/confirm-dialog-labels.ts +0 -13
- package/src/components/confirm-dialog.tsx +0 -341
- package/src/components/copy-button-labels.ts +0 -13
- package/src/components/copy-button.tsx +0 -192
- package/src/components/country-select-labels.ts +0 -11
- package/src/components/country-select.tsx +0 -539
- package/src/components/currency-option-list.tsx +0 -188
- package/src/components/currency-select.tsx +0 -343
- package/src/components/danger-confirm-labels.ts +0 -20
- package/src/components/danger-confirm.tsx +0 -987
- package/src/components/data-table-cells.tsx +0 -118
- package/src/components/data-table-column-settings.tsx +0 -198
- package/src/components/data-table-filter-popover.tsx +0 -289
- package/src/components/data-table-filters.ts +0 -315
- package/src/components/data-table-fit.ts +0 -301
- package/src/components/data-table-groups.tsx +0 -288
- package/src/components/data-table-head.tsx +0 -280
- package/src/components/data-table-labels.ts +0 -198
- package/src/components/data-table-leading-row.tsx +0 -58
- package/src/components/data-table-mobile.tsx +0 -1117
- package/src/components/data-table-pagination.tsx +0 -202
- package/src/components/data-table-resize.ts +0 -188
- package/src/components/data-table-row-actions.tsx +0 -302
- package/src/components/data-table-row.tsx +0 -496
- package/src/components/data-table-selection.ts +0 -71
- package/src/components/data-table-shared.tsx +0 -287
- package/src/components/data-table-sort.ts +0 -163
- package/src/components/data-table-virtual.ts +0 -576
- package/src/components/data-table.tsx +0 -2598
- package/src/components/date-field.tsx +0 -684
- package/src/components/date-format-setting.tsx +0 -64
- package/src/components/date-picker.tsx +0 -404
- package/src/components/date-range-picker.tsx +0 -518
- package/src/components/description-list-labels.ts +0 -9
- package/src/components/description-list.tsx +0 -386
- package/src/components/dialog-frame-labels.ts +0 -7
- package/src/components/dialog-frame.tsx +0 -284
- package/src/components/disclosure.tsx +0 -476
- package/src/components/dropdown.tsx +0 -461
- package/src/components/empty-state.tsx +0 -136
- package/src/components/entity-combobox.tsx +0 -422
- package/src/components/error-boundary-labels.ts +0 -20
- package/src/components/error-boundary.tsx +0 -675
- package/src/components/facing-pair.ts +0 -93
- package/src/components/field-base-labels.ts +0 -20
- package/src/components/field-base.tsx +0 -656
- package/src/components/field-parts.tsx +0 -825
- package/src/components/field-strip.tsx +0 -129
- package/src/components/field.tsx +0 -206
- package/src/components/file-button.tsx +0 -295
- package/src/components/file-dropzone.tsx +0 -559
- package/src/components/floating-panel-labels.ts +0 -10
- package/src/components/floating-panel.tsx +0 -828
- package/src/components/focus-ring.ts +0 -16
- package/src/components/form-actions-labels.ts +0 -11
- package/src/components/form-actions.tsx +0 -578
- package/src/components/full-bleed-dialog.tsx +0 -294
- package/src/components/grouped-picker.tsx +0 -184
- package/src/components/help-popover.tsx +0 -117
- package/src/components/hover-menu.tsx +0 -343
- package/src/components/iban-input-labels.ts +0 -14
- package/src/components/iban-input.tsx +0 -236
- package/src/components/icon-button.tsx +0 -959
- package/src/components/icon-picker-labels.ts +0 -13
- package/src/components/icon-picker.tsx +0 -232
- package/src/components/image-grid-labels.ts +0 -11
- package/src/components/image-grid.tsx +0 -202
- package/src/components/inline-confirm.tsx +0 -116
- package/src/components/inline-edit-field-labels.ts +0 -11
- package/src/components/inline-edit-field.tsx +0 -552
- package/src/components/inline-entity-combobox.tsx +0 -849
- package/src/components/input.tsx +0 -394
- package/src/components/jump-calendar.tsx +0 -265
- package/src/components/language-select.tsx +0 -93
- package/src/components/legal-labels.ts +0 -105
- package/src/components/legal-page.tsx +0 -711
- package/src/components/legal.tsx +0 -668
- package/src/components/lightbox-labels.ts +0 -18
- package/src/components/lightbox.tsx +0 -399
- package/src/components/line-items-labels.ts +0 -14
- package/src/components/line-items.tsx +0 -602
- package/src/components/list-labels.ts +0 -12
- package/src/components/list.tsx +0 -870
- package/src/components/loading-state.tsx +0 -78
- package/src/components/measured-grid-labels.ts +0 -25
- package/src/components/measured-grid.tsx +0 -837
- package/src/components/menu-item.tsx +0 -241
- package/src/components/mini-calendar-labels.ts +0 -17
- package/src/components/mini-calendar.tsx +0 -792
- package/src/components/modal.tsx +0 -534
- package/src/components/money-draft.ts +0 -83
- package/src/components/money-field.tsx +0 -76
- package/src/components/month-grid.tsx +0 -229
- package/src/components/month-picker-labels.ts +0 -22
- package/src/components/month-picker.tsx +0 -1087
- package/src/components/multi-entity-combobox.tsx +0 -369
- package/src/components/multi-select.tsx +0 -376
- package/src/components/nav-pills.tsx +0 -198
- package/src/components/number-field.tsx +0 -327
- package/src/components/number-input.tsx +0 -559
- package/src/components/numeric-field.ts +0 -169
- package/src/components/numpad-sheet.tsx +0 -285
- package/src/components/one-time-code-input.tsx +0 -270
- package/src/components/page-contents-labels.ts +0 -9
- package/src/components/page-contents.tsx +0 -282
- package/src/components/page-header-context.ts +0 -8
- package/src/components/page-header.tsx +0 -298
- package/src/components/password-strength-labels.ts +0 -22
- package/src/components/password-strength.tsx +0 -241
- package/src/components/phone-input-labels.ts +0 -10
- package/src/components/phone-input.tsx +0 -282
- package/src/components/picker-sheet.tsx +0 -330
- package/src/components/pie-chart-labels.ts +0 -40
- package/src/components/pie-chart.tsx +0 -480
- package/src/components/popover-labels.ts +0 -14
- package/src/components/popover.tsx +0 -268
- package/src/components/progress-bar-labels.ts +0 -10
- package/src/components/progress-bar.tsx +0 -479
- package/src/components/qr-code.tsx +0 -76
- package/src/components/reauth-dialog-labels.ts +0 -13
- package/src/components/reauth-dialog.tsx +0 -265
- package/src/components/row-actions-labels.ts +0 -12
- package/src/components/row-actions.tsx +0 -795
- package/src/components/scroll-area.tsx +0 -123
- package/src/components/search-field.tsx +0 -192
- package/src/components/select.tsx +0 -294
- package/src/components/separator.tsx +0 -33
- package/src/components/series-chart-axes.ts +0 -342
- package/src/components/series-chart-budget.ts +0 -150
- package/src/components/series-chart-labels.ts +0 -33
- package/src/components/series-chart-thin.ts +0 -180
- package/src/components/series-chart-ticks.ts +0 -194
- package/src/components/series-chart.tsx +0 -1906
- package/src/components/server-wake-labels.ts +0 -11
- package/src/components/server-wake.tsx +0 -129
- package/src/components/settings-fields.tsx +0 -237
- package/src/components/share-card-labels.ts +0 -30
- package/src/components/share-card.tsx +0 -675
- package/src/components/signature-pad-labels.ts +0 -24
- package/src/components/signature-pad.tsx +0 -747
- package/src/components/signed-amount-labels.ts +0 -10
- package/src/components/signed-amount.tsx +0 -336
- package/src/components/skeleton.tsx +0 -80
- package/src/components/slider.tsx +0 -338
- package/src/components/sparkline-labels.ts +0 -14
- package/src/components/sparkline.tsx +0 -322
- package/src/components/spinner.tsx +0 -81
- package/src/components/stat-tile-labels.ts +0 -15
- package/src/components/stat-tile.tsx +0 -754
- package/src/components/status-dot.tsx +0 -170
- package/src/components/swatch-picker-labels.ts +0 -10
- package/src/components/swatch-picker.tsx +0 -283
- package/src/components/swipeable-row.tsx +0 -386
- package/src/components/switch.tsx +0 -273
- package/src/components/table-skeleton.tsx +0 -136
- package/src/components/table.tsx +0 -647
- package/src/components/tabs-labels.ts +0 -13
- package/src/components/tabs.tsx +0 -693
- package/src/components/text-link.tsx +0 -359
- package/src/components/text.tsx +0 -150
- package/src/components/textarea.tsx +0 -330
- package/src/components/tile-radio.tsx +0 -332
- package/src/components/time-input.tsx +0 -121
- package/src/components/toast-labels.ts +0 -12
- package/src/components/toast.tsx +0 -519
- package/src/components/toggle-group.tsx +0 -752
- package/src/components/toggle-legend.tsx +0 -394
- package/src/components/tooltip.tsx +0 -1149
- package/src/components/translation-review-editor.tsx +0 -290
- package/src/components/translation-review-labels.ts +0 -181
- package/src/components/translation-review-parts.tsx +0 -272
- package/src/components/translation-review.tsx +0 -1240
- package/src/components/tree-view.tsx +0 -589
- package/src/components/treemap-labels.ts +0 -47
- package/src/components/treemap-layout.ts +0 -210
- package/src/components/treemap.tsx +0 -1184
- package/src/components/trigger-aria.ts +0 -44
- package/src/components/use-anchor-dir.ts +0 -20
- package/src/components/use-mobile-reveal.ts +0 -62
- package/src/components/use-table-state.ts +0 -753
- package/src/components/user-avatar.tsx +0 -116
- package/src/components/wizard-stepper.tsx +0 -42
- package/src/components/write-lock-labels.ts +0 -10
- package/src/components/write-lock.tsx +0 -253
- package/src/currencies.ts +0 -90
- package/src/data-table.ts +0 -42
- package/src/demo/demo-banner.tsx +0 -153
- package/src/demo/demo-countdown.ts +0 -136
- package/src/demo/demo-ended.tsx +0 -90
- package/src/demo/demo-labels.ts +0 -78
- package/src/demo/demo-session.ts +0 -32
- package/src/demo/demo-start.tsx +0 -156
- package/src/eslint/index.ts +0 -161
- package/src/eslint/role-utilities.generated.ts +0 -146
- package/src/eslint/role-utilities.ts +0 -233
- package/src/feedback/feedback-attachment-download.tsx +0 -77
- package/src/feedback/feedback-attachment-labels.ts +0 -37
- package/src/feedback/feedback-attachment.tsx +0 -1239
- package/src/feedback/feedback-capture.ts +0 -287
- package/src/feedback/feedback-comment-thread.tsx +0 -353
- package/src/feedback/feedback-context-labels.ts +0 -11
- package/src/feedback/feedback-context.tsx +0 -245
- package/src/feedback/feedback-crash.ts +0 -547
- package/src/feedback/feedback-diagnostics.tsx +0 -41
- package/src/feedback/feedback-dialog-labels.ts +0 -29
- package/src/feedback/feedback-dialog.tsx +0 -452
- package/src/feedback/feedback-entry-file.tsx +0 -150
- package/src/feedback/feedback-inbox.tsx +0 -552
- package/src/feedback/feedback-labels.ts +0 -144
- package/src/feedback/feedback-menu-labels.ts +0 -12
- package/src/feedback/feedback-menu.tsx +0 -177
- package/src/feedback/feedback-mutation.ts +0 -20
- package/src/feedback/feedback-page-link.ts +0 -90
- package/src/feedback/feedback-public-labels.ts +0 -81
- package/src/feedback/feedback-public-list.tsx +0 -524
- package/src/feedback/feedback-public-switch.tsx +0 -102
- package/src/feedback/feedback-public-types.ts +0 -101
- package/src/feedback/feedback-record.ts +0 -428
- package/src/feedback/feedback-replies-context.ts +0 -9
- package/src/feedback/feedback-replies.tsx +0 -343
- package/src/feedback/feedback-rework-entry-chip.tsx +0 -18
- package/src/feedback/feedback-row-detail-labels.ts +0 -31
- package/src/feedback/feedback-row-detail.tsx +0 -871
- package/src/feedback/feedback-status-undo.ts +0 -109
- package/src/feedback/feedback-submit-dialog.tsx +0 -131
- package/src/feedback/feedback-submit.tsx +0 -270
- package/src/feedback/feedback-swipe.tsx +0 -192
- package/src/feedback/feedback-table-labels.ts +0 -27
- package/src/feedback/feedback-table.tsx +0 -912
- package/src/feedback/feedback-thread-labels.ts +0 -22
- package/src/feedback/feedback-thread-parts-labels.ts +0 -41
- package/src/feedback/feedback-thread.tsx +0 -905
- package/src/feedback/feedback-vocabulary.ts +0 -263
- package/src/feedback/feedback-vote-button.tsx +0 -124
- package/src/feedback.ts +0 -116
- package/src/hooks/use-anchored-panel.ts +0 -396
- package/src/hooks/use-anchored-rect.ts +0 -77
- package/src/hooks/use-announce.ts +0 -85
- package/src/hooks/use-authed-src.ts +0 -167
- package/src/hooks/use-body-scroll-lock.ts +0 -119
- package/src/hooks/use-breakpoint.ts +0 -133
- package/src/hooks/use-close-transition.ts +0 -107
- package/src/hooks/use-copy-to-clipboard.ts +0 -122
- package/src/hooks/use-debounce.ts +0 -114
- package/src/hooks/use-dismiss.ts +0 -371
- package/src/hooks/use-document-title.ts +0 -33
- package/src/hooks/use-file-drop.ts +0 -121
- package/src/hooks/use-file-picker-labels.ts +0 -28
- package/src/hooks/use-file-picker.tsx +0 -359
- package/src/hooks/use-focus-trap.ts +0 -199
- package/src/hooks/use-hotkey.ts +0 -212
- package/src/hooks/use-large-text.ts +0 -41
- package/src/hooks/use-long-press.ts +0 -140
- package/src/hooks/use-media-query.ts +0 -39
- package/src/hooks/use-mounted.ts +0 -39
- package/src/hooks/use-noindex.ts +0 -37
- package/src/hooks/use-overlay-history.ts +0 -714
- package/src/hooks/use-row-swipe.ts +0 -207
- package/src/hooks/use-search-param-state.ts +0 -434
- package/src/hooks/use-windowed-rows.ts +0 -225
- package/src/i18n/defaults.ts +0 -267
- package/src/i18n/german.ts +0 -2059
- package/src/i18n/kit-labels.tsx +0 -1003
- package/src/i18n/languages.ts +0 -349
- package/src/i18n/locales/de-CH.ts +0 -24
- package/src/i18n/locales/en.ts +0 -267
- package/src/i18n/locales/es.ts +0 -1999
- package/src/i18n/locales/fr.ts +0 -2037
- package/src/i18n/locales/hu.ts +0 -2004
- package/src/i18n/locales/it.ts +0 -2014
- package/src/i18n/locales/zh.ts +0 -1912
- package/src/i18n/plurals.ts +0 -86
- package/src/i18n/review.ts +0 -475
- package/src/i18n/shared-labels.ts +0 -138
- package/src/i18n/swiss.ts +0 -29
- package/src/index.ts +0 -1191
- package/src/landing/access.ts +0 -93
- package/src/landing/landing-actions.tsx +0 -97
- package/src/landing/landing-labels.ts +0 -59
- package/src/landing/landing-sections.tsx +0 -341
- package/src/landing/page-seo.ts +0 -261
- package/src/landing/public-header.tsx +0 -121
- package/src/landing/public-page.tsx +0 -106
- package/src/landing/routing.tsx +0 -225
- package/src/lib/broadcast.ts +0 -52
- package/src/lib/calc.ts +0 -323
- package/src/lib/chip-edge-snap.ts +0 -212
- package/src/lib/clipboard-minus.ts +0 -107
- package/src/lib/clipping.ts +0 -34
- package/src/lib/cn.ts +0 -28
- package/src/lib/column-mapping.ts +0 -234
- package/src/lib/countries.ts +0 -91
- package/src/lib/data-attributes.ts +0 -14
- package/src/lib/date-format.ts +0 -227
- package/src/lib/dates.ts +0 -288
- package/src/lib/day-format.ts +0 -96
- package/src/lib/decimal-marks.ts +0 -108
- package/src/lib/describe-failure.ts +0 -18
- package/src/lib/device-settings.ts +0 -147
- package/src/lib/direction.ts +0 -74
- package/src/lib/document-navigation.ts +0 -17
- package/src/lib/document-title.ts +0 -41
- package/src/lib/download.ts +0 -172
- package/src/lib/float-clearance.ts +0 -70
- package/src/lib/floating-stack.ts +0 -70
- package/src/lib/focus-left.ts +0 -156
- package/src/lib/format.ts +0 -585
- package/src/lib/http-status.ts +0 -38
- package/src/lib/iban.ts +0 -251
- package/src/lib/ime.ts +0 -24
- package/src/lib/intl-cache.ts +0 -27
- package/src/lib/iso-day.ts +0 -13
- package/src/lib/lazy-with-fallback.ts +0 -82
- package/src/lib/logger.ts +0 -69
- package/src/lib/minus.ts +0 -50
- package/src/lib/path-pattern.ts +0 -55
- package/src/lib/person-name.ts +0 -155
- package/src/lib/phone.ts +0 -208
- package/src/lib/plain-text.ts +0 -22
- package/src/lib/presence.ts +0 -18
- package/src/lib/qr-encode.ts +0 -444
- package/src/lib/quiet-focus.ts +0 -32
- package/src/lib/reduced-motion.ts +0 -22
- package/src/lib/refs.ts +0 -22
- package/src/lib/round.ts +0 -43
- package/src/lib/safe-storage.ts +0 -119
- package/src/lib/server-wake.ts +0 -315
- package/src/lib/session-refresh.ts +0 -472
- package/src/lib/share-format.ts +0 -18
- package/src/lib/status-tone.ts +0 -43
- package/src/lib/strip-fade.ts +0 -287
- package/src/lib/table-text.ts +0 -554
- package/src/lib/text-case.ts +0 -19
- package/src/lib/text-match.ts +0 -169
- package/src/lib/thenable.ts +0 -19
- package/src/lib/translation-review.ts +0 -769
- package/src/notifications/device-zone-report.ts +0 -67
- package/src/notifications/feedback-notification-types-labels.ts +0 -33
- package/src/notifications/feedback-notification-types.ts +0 -71
- package/src/notifications/notification-bell.tsx +0 -119
- package/src/notifications/notification-inbox.tsx +0 -309
- package/src/notifications/notification-parts.tsx +0 -81
- package/src/notifications/notification-types-setting.tsx +0 -406
- package/src/notifications/notification-types.ts +0 -89
- package/src/notifications/notifications-labels.ts +0 -287
- package/src/notifications/push-device-setting.tsx +0 -230
- package/src/notifications/push-devices-setting.tsx +0 -374
- package/src/notifications/push-worker.ts +0 -168
- package/src/notifications/quiet-hours-setting.tsx +0 -238
- package/src/notifications/unsubscribe-panel.tsx +0 -200
- package/src/notifications/use-push-device.ts +0 -448
- package/src/offline/local-first.ts +0 -100
- package/src/offline/pwa-update-prompt-labels.ts +0 -9
- package/src/offline/pwa-update-prompt.tsx +0 -78
- package/src/offline/query-persistence.ts +0 -391
- package/src/offline/service-worker-updates.ts +0 -81
- package/src/offline/shared-computer-labels.ts +0 -8
- package/src/offline/shared-computer.tsx +0 -87
- package/src/offline/sign-out-pending-dialog-labels.ts +0 -21
- package/src/offline/sign-out-pending-dialog.tsx +0 -135
- package/src/offline.ts +0 -37
- package/src/push-worker.ts +0 -25
- package/src/rhf/fields.tsx +0 -2187
- package/src/rhf/form-core.tsx +0 -324
- package/src/rhf/form.tsx +0 -12
- package/src/rhf/line-items.tsx +0 -135
- package/src/rhf/use-rhf-wizard-step.ts +0 -104
- package/src/rhf.ts +0 -21
- package/src/search/command-palette-labels.ts +0 -16
- package/src/search/command-palette.tsx +0 -624
- package/src/search/global-search-labels.ts +0 -13
- package/src/search/global-search.tsx +0 -660
- package/src/search/search-index.ts +0 -283
- package/src/search/use-command-key.ts +0 -23
- package/src/search.ts +0 -14
- package/src/settings/device-reset-setting-labels.ts +0 -20
- package/src/settings/device-reset-setting.tsx +0 -116
- package/src/settings/settings-card-classes.ts +0 -11
- package/src/settings/settings-catalogue.ts +0 -150
- package/src/settings/settings-context.ts +0 -33
- package/src/settings/settings-heading.tsx +0 -67
- package/src/settings/settings-labels.ts +0 -87
- package/src/settings/settings-layout.tsx +0 -471
- package/src/settings/settings-section.tsx +0 -108
- package/src/settings/use-account-appearance.ts +0 -148
- package/src/settings/use-account-language.ts +0 -146
- package/src/settings/use-settings-focus.ts +0 -128
- package/src/settings/use-settings-route.ts +0 -258
- package/src/shell/account-menu-language.tsx +0 -130
- package/src/shell/account-menu-text-size.tsx +0 -80
- package/src/shell/admin-menu.tsx +0 -183
- package/src/shell/app-shell-labels.ts +0 -11
- package/src/shell/app-shell.tsx +0 -1560
- package/src/shell/auth-layout.tsx +0 -186
- package/src/shell/company-switcher-labels.ts +0 -13
- package/src/shell/company-switcher.tsx +0 -136
- package/src/shell/dev-menu.tsx +0 -257
- package/src/shell/fill-height.tsx +0 -45
- package/src/shell/language-code.ts +0 -5
- package/src/shell/option-switcher-menu.tsx +0 -84
- package/src/shell/sync-status-indicator.tsx +0 -303
- package/src/shell/top-bar-actions.tsx +0 -87
- package/src/shell/top-bar-brand.tsx +0 -78
- package/src/shell/top-bar-parts-labels.ts +0 -148
- package/src/shell/top-bar.tsx +0 -40
- package/src/shell/topbar-action-menu.tsx +0 -567
- package/src/shell/topbar-controls.tsx +0 -269
- package/src/shell/tour-menu.tsx +0 -187
- package/src/shell.ts +0 -108
- package/src/sync/db.ts +0 -129
- package/src/sync/engine.ts +0 -1011
- package/src/sync/hooks.ts +0 -98
- package/src/sync/testing.ts +0 -73
- package/src/sync/wire.ts +0 -61
- package/src/sync.ts +0 -37
- package/src/table-text.ts +0 -8
- package/src/testing/css-variables.generated.ts +0 -112
- package/src/testing/css-variables.ts +0 -189
- package/src/testing/index.ts +0 -29
- package/src/testing/react.ts +0 -58
- package/src/testing/tour.ts +0 -41
- package/src/testing/viewport.ts +0 -357
- package/src/theme/chart-palette.ts +0 -232
- package/src/theme/color.ts +0 -272
- package/src/theme/contrast-tokens.ts +0 -268
- package/src/theme/contrast.ts +0 -250
- package/src/theme/palette-derive.ts +0 -825
- package/src/theme/palette-presets.ts +0 -544
- package/src/theme/palette-store.ts +0 -108
- package/src/theme/text-size.ts +0 -289
- package/src/theme/theme-store.ts +0 -157
- package/src/tour/tour-catalogue-labels.ts +0 -75
- package/src/tour/tour-catalogue.tsx +0 -335
- package/src/tour/tour-dock.ts +0 -134
- package/src/tour/tour-engine.ts +0 -37
- package/src/tour/tour-gates.ts +0 -218
- package/src/tour/tour-guide-button.tsx +0 -64
- package/src/tour/tour-guide-labels.ts +0 -15
- package/src/tour/tour-info.ts +0 -144
- package/src/tour/tour-labels.ts +0 -23
- package/src/tour/tour-overlay.tsx +0 -1170
- package/src/tour/tour.tsx +0 -750
- package/src/tour/use-tour-progress.ts +0 -671
- package/src/tour/use-tour-url-sync.ts +0 -266
- package/src/tour.ts +0 -21
- package/src/vite-env.d.ts +0 -23
- package/src/wizard/stepper-nav.tsx +0 -360
- package/src/wizard/types.ts +0 -275
- package/src/wizard/use-wizard.ts +0 -560
- package/src/wizard/validation.ts +0 -39
- package/src/wizard/wizard-context.tsx +0 -74
- package/src/wizard/wizard-labels.ts +0 -29
- package/src/wizard/wizard-step.tsx +0 -76
- package/src/wizard/wizard-summary.tsx +0 -84
- package/src/wizard.ts +0 -15
package/dist/lib/focus-left.d.ts
CHANGED
|
@@ -52,9 +52,55 @@ export declare function tabStopsAround(frame: Element, limit?: number): {
|
|
|
52
52
|
/**
|
|
53
53
|
* Focus the first of `candidates` that is still in the page and takes the focus; true
|
|
54
54
|
* when one did. Each is tried and checked, since `focus()` on a node that cannot hold it
|
|
55
|
-
* (detached, `display: none`, disabled since) fails without a word.
|
|
55
|
+
* (detached, `display: none`, disabled since) fails without a word. An SVG element counts
|
|
56
|
+
* (a chart's tile, a slice); `<body>` and `<html>` never do — "focused" there is the
|
|
57
|
+
* focus lost, not given (0.52 code review 2026-10-31, held to 0.55).
|
|
56
58
|
*/
|
|
57
59
|
export declare function focusFirst(candidates: Iterable<Element | null | undefined>): boolean;
|
|
60
|
+
/** {@link returnFocus}'s three answers to "where was this opened from". */
|
|
61
|
+
export interface FocusReturn {
|
|
62
|
+
/** The control it was opened from: the overlay's trigger when it names one, else what
|
|
63
|
+
* held the focus as it opened. */
|
|
64
|
+
opener?: Element | null;
|
|
65
|
+
/** Where the focus goes when the opener cannot take it, nearest first — the overlay's
|
|
66
|
+
* stated fallback. */
|
|
67
|
+
fallback?: Iterable<Element | null | undefined>;
|
|
68
|
+
/** What is closing, while it is still in the page (a panel on its way out, a list
|
|
69
|
+
* about to unmount): a focus inside it is one to give back. */
|
|
70
|
+
closing?: Element | null;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Where the focus goes when an overlay closes, or a control holding it leaves the page —
|
|
74
|
+
* the kit's ONE rule for it (0.52 code review 2026-10-31, held to 0.55). The dialogs, the
|
|
75
|
+
* popovers and menus, the drawers, the phone sheets, the tour, AlertBanner's × and the
|
|
76
|
+
* Treemap's tiles each decided it themselves, and they drifted: the trap gave the focus
|
|
77
|
+
* back whenever its opener was still connected — over a focus the app had just placed —
|
|
78
|
+
* and left it on `<body>` when it was not; the date and month pickers and the floating
|
|
79
|
+
* panel moved it only when it was lost; the dropdown, the combobox and the column drawer
|
|
80
|
+
* moved it to their trigger every time, unchecked; and a Treemap tile's note of where to
|
|
81
|
+
* go once outlived the commit it was for and took the focus back, from wherever the
|
|
82
|
+
* reader was, when the map was shown again.
|
|
83
|
+
*
|
|
84
|
+
* 1. **Only a lost focus is moved** — on `<body>`, on nothing or on a removed node
|
|
85
|
+
* ({@link focusIsLost}) — or one still inside what is `closing`. A focus that went
|
|
86
|
+
* somewhere real is the user's (an outside press landed on a field) or the app's (its
|
|
87
|
+
* own `focus()` in `onClose`), and stays.
|
|
88
|
+
* 2. **To the opener**, if it is still in the page and takes the focus: `focus()` is
|
|
89
|
+
* checked, as a disabled, hidden or inert opener refuses it without a word.
|
|
90
|
+
* 3. **Else to the stated fallback**, the first of it that does — each caller names its
|
|
91
|
+
* own: the trap the stops that stood around its opener, a banner the stops around its
|
|
92
|
+
* ×, the map the tile that holds its tab stop.
|
|
93
|
+
* 4. **Never to `<body>`**: no `focus()` on a node that has left, none on `<body>`, no
|
|
94
|
+
* `blur()`. When nothing can take the focus — the page under the overlay was replaced
|
|
95
|
+
* — it is left for the page's own handling of a new page, not guessed at.
|
|
96
|
+
* 5. **Only in the closing commit**: called from the commit that closes or removes (a
|
|
97
|
+
* handler that closes, a ref callback, a layout effect, an effect's cleanup), and
|
|
98
|
+
* nothing handed to it is kept. A note gathered earlier, where a removed node can no
|
|
99
|
+
* longer be measured from, is spent or dropped in that commit.
|
|
100
|
+
*
|
|
101
|
+
* True when it moved the focus.
|
|
102
|
+
*/
|
|
103
|
+
export declare function returnFocus({ opener, fallback, closing }: FocusReturn): boolean;
|
|
58
104
|
/**
|
|
59
105
|
* Focus a container that is not a tab stop of its own — a table, a list — as the place
|
|
60
106
|
* the user is in, without making it one: `tabindex="-1"` for as long as it holds the
|
package/dist/lib/focus-left.js
CHANGED
|
@@ -42,12 +42,20 @@ function tabStopsAround(frame, limit = 5) {
|
|
|
42
42
|
}
|
|
43
43
|
function focusFirst(candidates) {
|
|
44
44
|
for (const el of candidates) {
|
|
45
|
-
if (!(el instanceof HTMLElement) || !el.isConnected) continue;
|
|
45
|
+
if (!(el instanceof HTMLElement || el instanceof SVGElement) || !el.isConnected) continue;
|
|
46
|
+
if (el === el.ownerDocument.body || el === el.ownerDocument.documentElement) continue;
|
|
46
47
|
el.focus();
|
|
47
|
-
if (
|
|
48
|
+
if (el.ownerDocument.activeElement === el) return true;
|
|
48
49
|
}
|
|
49
50
|
return false;
|
|
50
51
|
}
|
|
52
|
+
function returnFocus({ opener, fallback = [], closing }) {
|
|
53
|
+
if (typeof document === "undefined") return false;
|
|
54
|
+
const active = document.activeElement;
|
|
55
|
+
const inside = Boolean(closing?.isConnected && active && closing.contains(active));
|
|
56
|
+
if (!inside && !focusIsLost()) return false;
|
|
57
|
+
return focusFirst([opener, ...fallback]);
|
|
58
|
+
}
|
|
51
59
|
function focusContainer(el) {
|
|
52
60
|
if (!el.hasAttribute("tabindex")) {
|
|
53
61
|
el.setAttribute("tabindex", "-1");
|
|
@@ -60,6 +68,7 @@ export {
|
|
|
60
68
|
focusContainer,
|
|
61
69
|
focusFirst,
|
|
62
70
|
focusIsLost,
|
|
71
|
+
returnFocus,
|
|
63
72
|
tabStops,
|
|
64
73
|
tabStopsAround,
|
|
65
74
|
whenFocusLeftForNothing
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/focus-left.ts"],"sourcesContent":["// \"The focused node left\" (refactor audit 2026-10-30, Wave 1: DSP-4, DSP-15). When the\n// element holding the keyboard's focus is removed — a table row deleted, filtered out or\n// approved; a bulk bar gone with its Clear; a banner its × took away — the browser puts\n// focus on <body> and says nothing: no blur in Chromium, none in jsdom. A keyboard or\n// screen-reader user then starts again from the top of the page. The overlays give focus\n// back to their opener (use-focus-trap); these helpers are for the controls that leave\n// the page while the focus is IN them, and decide where it goes instead.\n\n/**\n * Candidate tab stops, in DOM order — narrowed by {@link isTabStop} to the ones a Tab\n * really reaches. The kit's one copy of the rule (0.52 code review, lib/focus-left.ts):\n * this file and use-focus-trap each had it, with an exported `firstTabStop` apiece that\n * disagreed about the element itself, and a combobox panel's toolbar had a third\n * selector. The trap, the focus a removed node drops (below), the tour's field ring and\n * the toolbar all read it here, so \"the next stop\" is the same stop everywhere.\n *\n * The selector is the one `Modal` used. On its own it was not enough (round 0.34\n * BUG-4): only the bare `[tabindex]` clause excluded `-1`, so a `button`, an `input` or\n * a link taken out of the tab order still counted. A panel that ends in a roving grid —\n * the calendar's days, the month grid, the picker sheet's rows, every one of them `-1`\n * but the active cell — then had a \"last\" stop no Tab ever reaches: Tab from the real\n * last stop was not wrapped and walked out of the open panel, and Shift+Tab from the\n * first landed on a cell that is not a stop at all.\n */\n// `input[type=hidden]` is no stop: a Tab never lands on it and focus() on it does nothing,\n// but its tabIndex reads 0, so a trap could take a form's hidden field for its first or last\n// stop and Shift+Tab left the dialog (0.52 code review).\nconst TAB_STOP =\n 'a[href],button:not([disabled]),textarea:not([disabled]),input:not([disabled]):not([type=\"hidden\"]),select:not([disabled]),[tabindex]:not([tabindex=\"-1\"])';\n\n/**\n * A stop the browser's own Tab would land on: in the tab order (`tabIndex` ≥ 0) and not\n * inside something `hidden` or `inert`. Removes only elements a native Tab never\n * reaches, so no correct order changes. `visibility: hidden` and closed `<details>` are\n * still not walked — they need layout, which this rule has never read.\n */\nfunction isTabStop(el: HTMLElement): boolean {\n return el.tabIndex >= 0 && !el.closest(\"[hidden],[inert]\");\n}\n\nexport interface TabStopOptions {\n /** Whether `el` itself counts, first, when it is a stop. Default true: the tour's\n * target may BE the field (refactor audit 2026-10-30, DUP-9). False for \"a control\n * inside it\" — a row, a drawer, a trap's container, a toolbar. */\n includeSelf?: boolean;\n}\n\n/** The tab stops in `el`, in DOM order — `el` itself first when it is one, unless\n * `includeSelf: false`. */\nexport function tabStops(el: Element, { includeSelf = true }: TabStopOptions = {}): HTMLElement[] {\n const inside = Array.from(el.querySelectorAll<HTMLElement>(TAB_STOP)).filter(isTabStop);\n const own = includeSelf && el instanceof HTMLElement && el.matches(TAB_STOP) && isTabStop(el);\n return own ? [el, ...inside] : inside;\n}\n\n/** The first of {@link tabStops} — the control a person types into or presses — or null. */\nexport function firstTabStop(el: Element, options?: TabStopOptions): HTMLElement | null {\n return tabStops(el, options)[0] ?? null;\n}\n\n/**\n * Whether the focus has fallen out of the page: onto `<body>`, onto nothing, or onto a\n * node no longer in the document. False on the server, where nothing has focus to lose.\n * A recovery asks this first: focus that went somewhere real (a dialog, the next field,\n * an app's own `focus()`) is the user's or the app's, and is left where it is.\n */\nexport function focusIsLost(): boolean {\n if (typeof document === \"undefined\") return false;\n const el = document.activeElement;\n return !el || el === document.body || !el.isConnected;\n}\n\n/**\n * Calls `then` when a `blur`/`focusout` was the user's own move to nothing — a click on\n * the page's background, or a click Safari answers by focusing nothing (it focuses no\n * button or link on a click, and blurs what had the focus) — after which a note of where\n * the focus was is stale (0.52 code review: DataTable's row, BulkActionBar's and\n * AlertBanner's notes outlived it, and a removal much later pulled the focus, and the\n * scroll, back to them).\n *\n * No element took the focus, the document holds none, and the node that lost it could\n * still hold it. Not when it was removed, hidden, made inert or disabled: that is the page\n * taking the focus away — the very case those notes are kept for. Not a window losing the\n * focus either, which leaves the node the document's active element. Decided a microtask\n * later, once the event's own work is done: a browser that blurs a node it is removing\n * (or hiding) may do it while the node is still in place, and only after it is gone is\n * that told apart from a click.\n */\nexport function whenFocusLeftForNothing(\n e: { target: EventTarget | null; relatedTarget: EventTarget | null },\n then: () => void,\n): void {\n const el = e.target;\n if (e.relatedTarget !== null || !(el instanceof Element)) return;\n queueMicrotask(() => {\n if (!el.isConnected || el.matches(\":disabled\") || el.closest(\"[hidden],[inert]\")) return;\n // `display: none`, where the browser can say (jsdom cannot).\n if (typeof el.checkVisibility === \"function\" && !el.checkVisibility()) return;\n if (focusIsLost()) then();\n });\n}\n\n/**\n * The tab stops around `frame`, outside it, nearest first on each side — where focus\n * goes once `frame` is gone. Read BEFORE it goes: a removed node has no place in the\n * document to measure from. `limit` per side keeps a long page's stops out of memory.\n *\n * Walked outwards from the frame, `limit` stops each way (0.52 code review,\n * lib/focus-left.ts): read from every stop in the page, a banner under a 2000-row table\n * read all 2000 to keep the nearest five before it.\n */\nexport function tabStopsAround(frame: Element, limit = 5): { after: HTMLElement[]; before: HTMLElement[] } {\n const doc = frame.ownerDocument;\n const walker = doc.createTreeWalker(doc.documentElement, NodeFilter.SHOW_ELEMENT);\n const isStop = (node: Node): node is HTMLElement =>\n node instanceof HTMLElement && node.matches(TAB_STOP) && isTabStop(node);\n // After: from the first element past the frame's own subtree, in document order.\n const after: HTMLElement[] = [];\n walker.currentNode = frame;\n let node: Node | null = walker.nextSibling();\n while (!node && walker.parentNode()) node = walker.nextSibling();\n for (; node && after.length < limit; node = walker.nextNode()) if (isStop(node)) after.push(node);\n // Before: back from the frame, nearest first (its ancestors among them, as before).\n const before: HTMLElement[] = [];\n walker.currentNode = frame;\n for (node = walker.previousNode(); node && before.length < limit; node = walker.previousNode())\n if (isStop(node)) before.push(node);\n return { after, before };\n}\n\n/**\n * Focus the first of `candidates` that is still in the page and takes the focus; true\n * when one did. Each is tried and checked, since `focus()` on a node that cannot hold it\n * (detached, `display: none`, disabled since) fails without a word.\n */\nexport function focusFirst(candidates: Iterable<Element | null | undefined>): boolean {\n for (const el of candidates) {\n if (!(el instanceof HTMLElement) || !el.isConnected) continue;\n el.focus();\n if (document.activeElement === el) return true;\n }\n return false;\n}\n\n/**\n * Focus a container that is not a tab stop of its own — a table, a list — as the place\n * the user is in, without making it one: `tabindex=\"-1\"` for as long as it holds the\n * focus, unless it already carries a `tabindex` of its own.\n */\nexport function focusContainer(el: HTMLElement): void {\n if (!el.hasAttribute(\"tabindex\")) {\n el.setAttribute(\"tabindex\", \"-1\");\n el.addEventListener(\"blur\", () => el.removeAttribute(\"tabindex\"), { once: true });\n }\n el.focus();\n}\n"],"mappings":";AA2BA,MAAM,WACJ;AAQF,SAAS,UAAU,IAA0B;AAC3C,SAAO,GAAG,YAAY,KAAK,CAAC,GAAG,QAAQ,kBAAkB;AAC3D;AAWO,SAAS,SAAS,IAAa,EAAE,cAAc,KAAK,IAAoB,CAAC,GAAkB;AAChG,QAAM,SAAS,MAAM,KAAK,GAAG,iBAA8B,QAAQ,CAAC,EAAE,OAAO,SAAS;AACtF,QAAM,MAAM,eAAe,cAAc,eAAe,GAAG,QAAQ,QAAQ,KAAK,UAAU,EAAE;AAC5F,SAAO,MAAM,CAAC,IAAI,GAAG,MAAM,IAAI;AACjC;AAGO,SAAS,aAAa,IAAa,SAA8C;AACtF,SAAO,SAAS,IAAI,OAAO,EAAE,CAAC,KAAK;AACrC;AAQO,SAAS,cAAuB;AACrC,MAAI,OAAO,aAAa,YAAa,QAAO;AAC5C,QAAM,KAAK,SAAS;AACpB,SAAO,CAAC,MAAM,OAAO,SAAS,QAAQ,CAAC,GAAG;AAC5C;AAkBO,SAAS,wBACd,GACA,MACM;AACN,QAAM,KAAK,EAAE;AACb,MAAI,EAAE,kBAAkB,QAAQ,EAAE,cAAc,SAAU;AAC1D,iBAAe,MAAM;AACnB,QAAI,CAAC,GAAG,eAAe,GAAG,QAAQ,WAAW,KAAK,GAAG,QAAQ,kBAAkB,EAAG;AAElF,QAAI,OAAO,GAAG,oBAAoB,cAAc,CAAC,GAAG,gBAAgB,EAAG;AACvE,QAAI,YAAY,EAAG,MAAK;AAAA,EAC1B,CAAC;AACH;AAWO,SAAS,eAAe,OAAgB,QAAQ,GAAoD;AACzG,QAAM,MAAM,MAAM;AAClB,QAAM,SAAS,IAAI,iBAAiB,IAAI,iBAAiB,WAAW,YAAY;AAChF,QAAM,SAAS,CAACA,UACdA,iBAAgB,eAAeA,MAAK,QAAQ,QAAQ,KAAK,UAAUA,KAAI;AAEzE,QAAM,QAAuB,CAAC;AAC9B,SAAO,cAAc;AACrB,MAAI,OAAoB,OAAO,YAAY;AAC3C,SAAO,CAAC,QAAQ,OAAO,WAAW,EAAG,QAAO,OAAO,YAAY;AAC/D,SAAO,QAAQ,MAAM,SAAS,OAAO,OAAO,OAAO,SAAS,EAAG,KAAI,OAAO,IAAI,EAAG,OAAM,KAAK,IAAI;AAEhG,QAAM,SAAwB,CAAC;AAC/B,SAAO,cAAc;AACrB,OAAK,OAAO,OAAO,aAAa,GAAG,QAAQ,OAAO,SAAS,OAAO,OAAO,OAAO,aAAa;AAC3F,QAAI,OAAO,IAAI,EAAG,QAAO,KAAK,IAAI;AACpC,SAAO,EAAE,OAAO,OAAO;AACzB;AAOO,SAAS,WAAW,YAA2D;AACpF,aAAW,MAAM,YAAY;AAC3B,QAAI,EAAE,cAAc,gBAAgB,CAAC,GAAG,YAAa;AACrD,OAAG,MAAM;AACT,QAAI,SAAS,kBAAkB,GAAI,QAAO;AAAA,EAC5C;AACA,SAAO;AACT;AAOO,SAAS,eAAe,IAAuB;AACpD,MAAI,CAAC,GAAG,aAAa,UAAU,GAAG;AAChC,OAAG,aAAa,YAAY,IAAI;AAChC,OAAG,iBAAiB,QAAQ,MAAM,GAAG,gBAAgB,UAAU,GAAG,EAAE,MAAM,KAAK,CAAC;AAAA,EAClF;AACA,KAAG,MAAM;AACX;","names":["node"]}
|
|
1
|
+
{"version":3,"sources":["../../src/lib/focus-left.ts"],"sourcesContent":["// \"The focused node left\" (refactor audit 2026-10-30, Wave 1: DSP-4, DSP-15). When the\n// element holding the keyboard's focus is removed — a table row deleted, filtered out or\n// approved; a bulk bar gone with its Clear; a banner its × took away — the browser puts\n// focus on <body> and says nothing: no blur in Chromium, none in jsdom. A keyboard or\n// screen-reader user then starts again from the top of the page. These helpers are for\n// the controls that leave the page while the focus is IN them, and decide where it goes\n// instead; `returnFocus` is the one rule for that and for an overlay giving the focus\n// back as it closes (0.52 code review 2026-10-31, held to 0.55; use-focus-trap reads it).\n\n/**\n * Candidate tab stops, in DOM order — narrowed by {@link isTabStop} to the ones a Tab\n * really reaches. The kit's one copy of the rule (0.52 code review, lib/focus-left.ts):\n * this file and use-focus-trap each had it, with an exported `firstTabStop` apiece that\n * disagreed about the element itself, and a combobox panel's toolbar had a third\n * selector. The trap, the focus a removed node drops (below), the tour's field ring and\n * the toolbar all read it here, so \"the next stop\" is the same stop everywhere.\n *\n * The selector is the one `Modal` used. On its own it was not enough (round 0.34\n * BUG-4): only the bare `[tabindex]` clause excluded `-1`, so a `button`, an `input` or\n * a link taken out of the tab order still counted. A panel that ends in a roving grid —\n * the calendar's days, the month grid, the picker sheet's rows, every one of them `-1`\n * but the active cell — then had a \"last\" stop no Tab ever reaches: Tab from the real\n * last stop was not wrapped and walked out of the open panel, and Shift+Tab from the\n * first landed on a cell that is not a stop at all.\n */\n// `input[type=hidden]` is no stop: a Tab never lands on it and focus() on it does nothing,\n// but its tabIndex reads 0, so a trap could take a form's hidden field for its first or last\n// stop and Shift+Tab left the dialog (0.52 code review).\nconst TAB_STOP =\n 'a[href],button:not([disabled]),textarea:not([disabled]),input:not([disabled]):not([type=\"hidden\"]),select:not([disabled]),[tabindex]:not([tabindex=\"-1\"])';\n\n/**\n * A stop the browser's own Tab would land on: in the tab order (`tabIndex` ≥ 0) and not\n * inside something `hidden` or `inert`. Removes only elements a native Tab never\n * reaches, so no correct order changes. `visibility: hidden` and closed `<details>` are\n * still not walked — they need layout, which this rule has never read.\n */\nfunction isTabStop(el: HTMLElement): boolean {\n return el.tabIndex >= 0 && !el.closest(\"[hidden],[inert]\");\n}\n\nexport interface TabStopOptions {\n /** Whether `el` itself counts, first, when it is a stop. Default true: the tour's\n * target may BE the field (refactor audit 2026-10-30, DUP-9). False for \"a control\n * inside it\" — a row, a drawer, a trap's container, a toolbar. */\n includeSelf?: boolean;\n}\n\n/** The tab stops in `el`, in DOM order — `el` itself first when it is one, unless\n * `includeSelf: false`. */\nexport function tabStops(el: Element, { includeSelf = true }: TabStopOptions = {}): HTMLElement[] {\n const inside = Array.from(el.querySelectorAll<HTMLElement>(TAB_STOP)).filter(isTabStop);\n const own = includeSelf && el instanceof HTMLElement && el.matches(TAB_STOP) && isTabStop(el);\n return own ? [el, ...inside] : inside;\n}\n\n/** The first of {@link tabStops} — the control a person types into or presses — or null. */\nexport function firstTabStop(el: Element, options?: TabStopOptions): HTMLElement | null {\n return tabStops(el, options)[0] ?? null;\n}\n\n/**\n * Whether the focus has fallen out of the page: onto `<body>`, onto nothing, or onto a\n * node no longer in the document. False on the server, where nothing has focus to lose.\n * A recovery asks this first: focus that went somewhere real (a dialog, the next field,\n * an app's own `focus()`) is the user's or the app's, and is left where it is.\n */\nexport function focusIsLost(): boolean {\n if (typeof document === \"undefined\") return false;\n const el = document.activeElement;\n return !el || el === document.body || !el.isConnected;\n}\n\n/**\n * Calls `then` when a `blur`/`focusout` was the user's own move to nothing — a click on\n * the page's background, or a click Safari answers by focusing nothing (it focuses no\n * button or link on a click, and blurs what had the focus) — after which a note of where\n * the focus was is stale (0.52 code review: DataTable's row, BulkActionBar's and\n * AlertBanner's notes outlived it, and a removal much later pulled the focus, and the\n * scroll, back to them).\n *\n * No element took the focus, the document holds none, and the node that lost it could\n * still hold it. Not when it was removed, hidden, made inert or disabled: that is the page\n * taking the focus away — the very case those notes are kept for. Not a window losing the\n * focus either, which leaves the node the document's active element. Decided a microtask\n * later, once the event's own work is done: a browser that blurs a node it is removing\n * (or hiding) may do it while the node is still in place, and only after it is gone is\n * that told apart from a click.\n */\nexport function whenFocusLeftForNothing(\n e: { target: EventTarget | null; relatedTarget: EventTarget | null },\n then: () => void,\n): void {\n const el = e.target;\n if (e.relatedTarget !== null || !(el instanceof Element)) return;\n queueMicrotask(() => {\n if (!el.isConnected || el.matches(\":disabled\") || el.closest(\"[hidden],[inert]\")) return;\n // `display: none`, where the browser can say (jsdom cannot).\n if (typeof el.checkVisibility === \"function\" && !el.checkVisibility()) return;\n if (focusIsLost()) then();\n });\n}\n\n/**\n * The tab stops around `frame`, outside it, nearest first on each side — where focus\n * goes once `frame` is gone. Read BEFORE it goes: a removed node has no place in the\n * document to measure from. `limit` per side keeps a long page's stops out of memory.\n *\n * Walked outwards from the frame, `limit` stops each way (0.52 code review,\n * lib/focus-left.ts): read from every stop in the page, a banner under a 2000-row table\n * read all 2000 to keep the nearest five before it.\n */\nexport function tabStopsAround(frame: Element, limit = 5): { after: HTMLElement[]; before: HTMLElement[] } {\n const doc = frame.ownerDocument;\n const walker = doc.createTreeWalker(doc.documentElement, NodeFilter.SHOW_ELEMENT);\n const isStop = (node: Node): node is HTMLElement =>\n node instanceof HTMLElement && node.matches(TAB_STOP) && isTabStop(node);\n // After: from the first element past the frame's own subtree, in document order.\n const after: HTMLElement[] = [];\n walker.currentNode = frame;\n let node: Node | null = walker.nextSibling();\n while (!node && walker.parentNode()) node = walker.nextSibling();\n for (; node && after.length < limit; node = walker.nextNode()) if (isStop(node)) after.push(node);\n // Before: back from the frame, nearest first (its ancestors among them, as before).\n const before: HTMLElement[] = [];\n walker.currentNode = frame;\n for (node = walker.previousNode(); node && before.length < limit; node = walker.previousNode())\n if (isStop(node)) before.push(node);\n return { after, before };\n}\n\n/**\n * Focus the first of `candidates` that is still in the page and takes the focus; true\n * when one did. Each is tried and checked, since `focus()` on a node that cannot hold it\n * (detached, `display: none`, disabled since) fails without a word. An SVG element counts\n * (a chart's tile, a slice); `<body>` and `<html>` never do — \"focused\" there is the\n * focus lost, not given (0.52 code review 2026-10-31, held to 0.55).\n */\nexport function focusFirst(candidates: Iterable<Element | null | undefined>): boolean {\n for (const el of candidates) {\n if (!(el instanceof HTMLElement || el instanceof SVGElement) || !el.isConnected) continue;\n if (el === el.ownerDocument.body || el === el.ownerDocument.documentElement) continue;\n el.focus();\n if (el.ownerDocument.activeElement === el) return true;\n }\n return false;\n}\n\n/** {@link returnFocus}'s three answers to \"where was this opened from\". */\nexport interface FocusReturn {\n /** The control it was opened from: the overlay's trigger when it names one, else what\n * held the focus as it opened. */\n opener?: Element | null;\n /** Where the focus goes when the opener cannot take it, nearest first — the overlay's\n * stated fallback. */\n fallback?: Iterable<Element | null | undefined>;\n /** What is closing, while it is still in the page (a panel on its way out, a list\n * about to unmount): a focus inside it is one to give back. */\n closing?: Element | null;\n}\n\n/**\n * Where the focus goes when an overlay closes, or a control holding it leaves the page —\n * the kit's ONE rule for it (0.52 code review 2026-10-31, held to 0.55). The dialogs, the\n * popovers and menus, the drawers, the phone sheets, the tour, AlertBanner's × and the\n * Treemap's tiles each decided it themselves, and they drifted: the trap gave the focus\n * back whenever its opener was still connected — over a focus the app had just placed —\n * and left it on `<body>` when it was not; the date and month pickers and the floating\n * panel moved it only when it was lost; the dropdown, the combobox and the column drawer\n * moved it to their trigger every time, unchecked; and a Treemap tile's note of where to\n * go once outlived the commit it was for and took the focus back, from wherever the\n * reader was, when the map was shown again.\n *\n * 1. **Only a lost focus is moved** — on `<body>`, on nothing or on a removed node\n * ({@link focusIsLost}) — or one still inside what is `closing`. A focus that went\n * somewhere real is the user's (an outside press landed on a field) or the app's (its\n * own `focus()` in `onClose`), and stays.\n * 2. **To the opener**, if it is still in the page and takes the focus: `focus()` is\n * checked, as a disabled, hidden or inert opener refuses it without a word.\n * 3. **Else to the stated fallback**, the first of it that does — each caller names its\n * own: the trap the stops that stood around its opener, a banner the stops around its\n * ×, the map the tile that holds its tab stop.\n * 4. **Never to `<body>`**: no `focus()` on a node that has left, none on `<body>`, no\n * `blur()`. When nothing can take the focus — the page under the overlay was replaced\n * — it is left for the page's own handling of a new page, not guessed at.\n * 5. **Only in the closing commit**: called from the commit that closes or removes (a\n * handler that closes, a ref callback, a layout effect, an effect's cleanup), and\n * nothing handed to it is kept. A note gathered earlier, where a removed node can no\n * longer be measured from, is spent or dropped in that commit.\n *\n * True when it moved the focus.\n */\nexport function returnFocus({ opener, fallback = [], closing }: FocusReturn): boolean {\n if (typeof document === \"undefined\") return false;\n const active = document.activeElement;\n const inside = Boolean(closing?.isConnected && active && closing.contains(active));\n if (!inside && !focusIsLost()) return false;\n return focusFirst([opener, ...fallback]);\n}\n\n/**\n * Focus a container that is not a tab stop of its own — a table, a list — as the place\n * the user is in, without making it one: `tabindex=\"-1\"` for as long as it holds the\n * focus, unless it already carries a `tabindex` of its own.\n */\nexport function focusContainer(el: HTMLElement): void {\n if (!el.hasAttribute(\"tabindex\")) {\n el.setAttribute(\"tabindex\", \"-1\");\n el.addEventListener(\"blur\", () => el.removeAttribute(\"tabindex\"), { once: true });\n }\n el.focus();\n}\n"],"mappings":";AA4BA,MAAM,WACJ;AAQF,SAAS,UAAU,IAA0B;AAC3C,SAAO,GAAG,YAAY,KAAK,CAAC,GAAG,QAAQ,kBAAkB;AAC3D;AAWO,SAAS,SAAS,IAAa,EAAE,cAAc,KAAK,IAAoB,CAAC,GAAkB;AAChG,QAAM,SAAS,MAAM,KAAK,GAAG,iBAA8B,QAAQ,CAAC,EAAE,OAAO,SAAS;AACtF,QAAM,MAAM,eAAe,cAAc,eAAe,GAAG,QAAQ,QAAQ,KAAK,UAAU,EAAE;AAC5F,SAAO,MAAM,CAAC,IAAI,GAAG,MAAM,IAAI;AACjC;AAGO,SAAS,aAAa,IAAa,SAA8C;AACtF,SAAO,SAAS,IAAI,OAAO,EAAE,CAAC,KAAK;AACrC;AAQO,SAAS,cAAuB;AACrC,MAAI,OAAO,aAAa,YAAa,QAAO;AAC5C,QAAM,KAAK,SAAS;AACpB,SAAO,CAAC,MAAM,OAAO,SAAS,QAAQ,CAAC,GAAG;AAC5C;AAkBO,SAAS,wBACd,GACA,MACM;AACN,QAAM,KAAK,EAAE;AACb,MAAI,EAAE,kBAAkB,QAAQ,EAAE,cAAc,SAAU;AAC1D,iBAAe,MAAM;AACnB,QAAI,CAAC,GAAG,eAAe,GAAG,QAAQ,WAAW,KAAK,GAAG,QAAQ,kBAAkB,EAAG;AAElF,QAAI,OAAO,GAAG,oBAAoB,cAAc,CAAC,GAAG,gBAAgB,EAAG;AACvE,QAAI,YAAY,EAAG,MAAK;AAAA,EAC1B,CAAC;AACH;AAWO,SAAS,eAAe,OAAgB,QAAQ,GAAoD;AACzG,QAAM,MAAM,MAAM;AAClB,QAAM,SAAS,IAAI,iBAAiB,IAAI,iBAAiB,WAAW,YAAY;AAChF,QAAM,SAAS,CAACA,UACdA,iBAAgB,eAAeA,MAAK,QAAQ,QAAQ,KAAK,UAAUA,KAAI;AAEzE,QAAM,QAAuB,CAAC;AAC9B,SAAO,cAAc;AACrB,MAAI,OAAoB,OAAO,YAAY;AAC3C,SAAO,CAAC,QAAQ,OAAO,WAAW,EAAG,QAAO,OAAO,YAAY;AAC/D,SAAO,QAAQ,MAAM,SAAS,OAAO,OAAO,OAAO,SAAS,EAAG,KAAI,OAAO,IAAI,EAAG,OAAM,KAAK,IAAI;AAEhG,QAAM,SAAwB,CAAC;AAC/B,SAAO,cAAc;AACrB,OAAK,OAAO,OAAO,aAAa,GAAG,QAAQ,OAAO,SAAS,OAAO,OAAO,OAAO,aAAa;AAC3F,QAAI,OAAO,IAAI,EAAG,QAAO,KAAK,IAAI;AACpC,SAAO,EAAE,OAAO,OAAO;AACzB;AASO,SAAS,WAAW,YAA2D;AACpF,aAAW,MAAM,YAAY;AAC3B,QAAI,EAAE,cAAc,eAAe,cAAc,eAAe,CAAC,GAAG,YAAa;AACjF,QAAI,OAAO,GAAG,cAAc,QAAQ,OAAO,GAAG,cAAc,gBAAiB;AAC7E,OAAG,MAAM;AACT,QAAI,GAAG,cAAc,kBAAkB,GAAI,QAAO;AAAA,EACpD;AACA,SAAO;AACT;AA8CO,SAAS,YAAY,EAAE,QAAQ,WAAW,CAAC,GAAG,QAAQ,GAAyB;AACpF,MAAI,OAAO,aAAa,YAAa,QAAO;AAC5C,QAAM,SAAS,SAAS;AACxB,QAAM,SAAS,QAAQ,SAAS,eAAe,UAAU,QAAQ,SAAS,MAAM,CAAC;AACjF,MAAI,CAAC,UAAU,CAAC,YAAY,EAAG,QAAO;AACtC,SAAO,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzC;AAOO,SAAS,eAAe,IAAuB;AACpD,MAAI,CAAC,GAAG,aAAa,UAAU,GAAG;AAChC,OAAG,aAAa,YAAY,IAAI;AAChC,OAAG,iBAAiB,QAAQ,MAAM,GAAG,gBAAgB,UAAU,GAAG,EAAE,MAAM,KAAK,CAAC;AAAA,EAClF;AACA,KAAG,MAAM;AACX;","names":["node"]}
|
|
@@ -35,6 +35,12 @@
|
|
|
35
35
|
* It never arms while the browser is offline, whatever `shouldWatch` says: that state
|
|
36
36
|
* has its own, truthful indicator, and a request that never left the device is not
|
|
37
37
|
* evidence of anything about the server.
|
|
38
|
+
*
|
|
39
|
+
* A READ THAT IS HEAVY ON PURPOSE (0.55) — a report the server computes for a few
|
|
40
|
+
* seconds — says so with `slowOk` on its request (the axios config, or `track`'s
|
|
41
|
+
* request): it is counted, but never called slow, so it shows nothing while it is under
|
|
42
|
+
* `wakingMs`. Past `wakingMs` it is the server waking like any other read. A read that
|
|
43
|
+
* can take longer than that on a warm server stays out of the watch (`shouldWatch`).
|
|
38
44
|
*/
|
|
39
45
|
/** `slow` = longer than a warm server ever takes; `waking` = long enough that a cold
|
|
40
46
|
* start is the only sensible explanation. */
|
|
@@ -61,21 +67,53 @@ export interface ServerWakeRequest {
|
|
|
61
67
|
/** axios's `responseType`. `"blob"`, `"arraybuffer"` and `"stream"` mark a download,
|
|
62
68
|
* which the default filter does not count. */
|
|
63
69
|
responseType?: string;
|
|
70
|
+
/**
|
|
71
|
+
* This read is slow on purpose (0.55; the per-request opt-out adopt-0.51 left open): it
|
|
72
|
+
* still counts, but its own age never shows "taking longer than usual" — only past
|
|
73
|
+
* `wakingMs`, when a cold start is the likelier story, does it show the server waking.
|
|
74
|
+
* The stage then follows the other requests out beside it, as ever.
|
|
75
|
+
*
|
|
76
|
+
* ONLY for a read that is heavy but answers under `wakingMs` (7 s) on a warm server: a
|
|
77
|
+
* report computed on request, a large page of rows. A read that can take longer — an
|
|
78
|
+
* export rendered on the server, a slow third party behind the route — would say "the
|
|
79
|
+
* server is waking up" on a warm server; keep it out of the watch through `shouldWatch`
|
|
80
|
+
* instead (kastlan's advice), as a download and an upload are.
|
|
81
|
+
*
|
|
82
|
+
* On axios it rides the request config: `api.get(url, { slowOk: true })` (declare it on
|
|
83
|
+
* `AxiosRequestConfig` once, by module augmentation); through `track`, on its request.
|
|
84
|
+
*/
|
|
85
|
+
slowOk?: boolean;
|
|
64
86
|
}
|
|
87
|
+
/**
|
|
88
|
+
* One counted request, as {@link ServerWakeWatcher.start} names it (0.55, keksdose's 0.51
|
|
89
|
+
* review N4): a positive whole number, unique for the watcher's lifetime, which
|
|
90
|
+
* {@link ServerWakeWatcher.end} takes back to end exactly that request. `start` returns
|
|
91
|
+
* `false` where it counts nothing, as before: the token is truthy where `start` returned
|
|
92
|
+
* `true` until 0.55, so code that only tests it reads as it did.
|
|
93
|
+
*/
|
|
94
|
+
export type ServerWakeToken = number;
|
|
65
95
|
export interface ServerWakeWatcher {
|
|
66
96
|
/**
|
|
67
97
|
* Count a request that is going out, and arm the escalation if it is the first.
|
|
68
|
-
* Returns
|
|
69
|
-
*
|
|
70
|
-
*
|
|
98
|
+
* Returns its {@link ServerWakeToken}, or `false` when it was not counted (until 0.55
|
|
99
|
+
* `true` / `false`; the token is truthy where `true` was). The caller MUST end every
|
|
100
|
+
* counted request exactly once, or the counter never returns to zero and the notice
|
|
101
|
+
* sticks: `end(token)`, which ends that request, or a bare `end()`, as before. (The
|
|
102
|
+
* axios adapter stashes the token on the request config for that reason.)
|
|
71
103
|
* `request` reaches the filter as its third argument; default `{ method, url }`.
|
|
72
104
|
*/
|
|
73
|
-
start(method?: string, url?: string, request?: ServerWakeRequest):
|
|
74
|
-
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
|
|
105
|
+
start(method?: string, url?: string, request?: ServerWakeRequest): ServerWakeToken | false;
|
|
106
|
+
/**
|
|
107
|
+
* A counted request settled — either way: an error still proves the server answered or
|
|
108
|
+
* gave up. The stage then follows the oldest request still out (0.51), so the notice
|
|
109
|
+
* goes away when the last one does, or sooner when the rest are recent.
|
|
110
|
+
*
|
|
111
|
+
* With `token` (0.55), exactly that request is retired, so the age the stage is read
|
|
112
|
+
* from is the real one; a token that was ended already (or reset away), or `false`, is
|
|
113
|
+
* a no-op. A bare `end()` — the call before 0.55 — retires the OLDEST start, which can
|
|
114
|
+
* make a notice come late, never falsely. Never takes the counter below zero.
|
|
115
|
+
*/
|
|
116
|
+
end(token?: ServerWakeToken | false): void;
|
|
79
117
|
/** `start` + `end` around a promise (or a function returning one), for a request
|
|
80
118
|
* that does not go through an adapter. Resolves and rejects as the work does. */
|
|
81
119
|
track<T>(work: PromiseLike<T> | (() => PromiseLike<T>), request?: ServerWakeRequest): Promise<T>;
|
|
@@ -108,6 +146,8 @@ export interface ServerWakeAxiosConfig {
|
|
|
108
146
|
method?: string;
|
|
109
147
|
url?: string;
|
|
110
148
|
responseType?: string;
|
|
149
|
+
/** A read slow on purpose — see {@link ServerWakeRequest.slowOk} (0.55). */
|
|
150
|
+
slowOk?: boolean;
|
|
111
151
|
}
|
|
112
152
|
/** The slice of an interceptor manager the adapter uses. A method (not a function
|
|
113
153
|
* property) so axios's wider `use(onFulfilled?, onRejected?, options?)` fits it. */
|
package/dist/lib/server-wake.js
CHANGED
|
@@ -12,6 +12,7 @@ function createServerWake({
|
|
|
12
12
|
shouldWatch = watchReadsAnd()
|
|
13
13
|
} = {}) {
|
|
14
14
|
const starts = [];
|
|
15
|
+
let lastToken = 0;
|
|
15
16
|
let stage = "idle";
|
|
16
17
|
let slowTimer = null;
|
|
17
18
|
let wakingTimer = null;
|
|
@@ -27,41 +28,50 @@ function createServerWake({
|
|
|
27
28
|
slowTimer = null;
|
|
28
29
|
wakingTimer = null;
|
|
29
30
|
};
|
|
31
|
+
const raise = (next) => {
|
|
32
|
+
if (stage !== "waking" && next !== stage) setStage(next);
|
|
33
|
+
};
|
|
30
34
|
const arm = () => {
|
|
31
35
|
clearTimers();
|
|
32
36
|
if (starts.length === 0) {
|
|
33
37
|
setStage("idle");
|
|
34
38
|
return;
|
|
35
39
|
}
|
|
36
|
-
const
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
+
const now = Date.now();
|
|
41
|
+
const age = now - starts[0].at;
|
|
42
|
+
const slowFrom = starts.find((s) => !s.slowOk);
|
|
43
|
+
const slowAge = slowFrom && now - slowFrom.at;
|
|
44
|
+
setStage(age >= wakingMs ? "waking" : slowAge !== void 0 && slowAge >= slowMs ? "slow" : "idle");
|
|
45
|
+
if (slowAge !== void 0 && slowAge < slowMs) slowTimer = setTimeout(() => raise("slow"), slowMs - slowAge);
|
|
46
|
+
if (age < wakingMs) wakingTimer = setTimeout(() => raise("waking"), wakingMs - age);
|
|
40
47
|
};
|
|
41
48
|
const start = (method, url, request = { method, url }) => {
|
|
42
49
|
if (isOffline()) return false;
|
|
43
50
|
if (!shouldWatch((method ?? "get").toLowerCase(), url ?? "", request)) return false;
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
51
|
+
lastToken += 1;
|
|
52
|
+
const slowOk = request.slowOk === true;
|
|
53
|
+
starts.push({ token: lastToken, at: Date.now(), slowOk });
|
|
54
|
+
if (starts.length === 1 || !slowOk && starts.every((s, i) => s.slowOk || i === starts.length - 1)) arm();
|
|
55
|
+
return lastToken;
|
|
47
56
|
};
|
|
48
|
-
const end = () => {
|
|
49
|
-
|
|
50
|
-
starts.
|
|
57
|
+
const end = (token) => {
|
|
58
|
+
const index = token === void 0 ? 0 : starts.findIndex((s) => s.token === token);
|
|
59
|
+
if (index < 0 || index >= starts.length) return;
|
|
60
|
+
starts.splice(index, 1);
|
|
51
61
|
arm();
|
|
52
62
|
};
|
|
53
63
|
return {
|
|
54
64
|
start,
|
|
55
65
|
end,
|
|
56
66
|
track(work, request = {}) {
|
|
57
|
-
const
|
|
67
|
+
const token = start(request.method, request.url, request);
|
|
58
68
|
let promise;
|
|
59
69
|
try {
|
|
60
70
|
promise = Promise.resolve(typeof work === "function" ? work() : work);
|
|
61
71
|
} catch (error) {
|
|
62
72
|
promise = Promise.reject(error);
|
|
63
73
|
}
|
|
64
|
-
return
|
|
74
|
+
return token ? promise.finally(() => end(token)) : promise;
|
|
65
75
|
},
|
|
66
76
|
reset() {
|
|
67
77
|
starts.length = 0;
|
|
@@ -83,9 +93,10 @@ const COUNTED = "_serverWake";
|
|
|
83
93
|
function attachServerWake(instance, watcher = serverWake) {
|
|
84
94
|
const settle = (config) => {
|
|
85
95
|
const marked = config;
|
|
86
|
-
|
|
96
|
+
const token = marked?.[COUNTED];
|
|
97
|
+
if (marked && token) {
|
|
87
98
|
marked[COUNTED] = false;
|
|
88
|
-
watcher.end();
|
|
99
|
+
watcher.end(token);
|
|
89
100
|
}
|
|
90
101
|
};
|
|
91
102
|
const request = instance.interceptors.request.use(
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/server-wake.ts"],"sourcesContent":["/**\n * \"Is the server asleep, or is the app broken?\" — the cold-start watchdog, lifted\n * from keksdose (feedback #199) so kastlan and Kurvenschmiede get it too.\n *\n * All three backends run on Cloud Run with `--min-instances=0`: after an idle\n * period the container is gone and the first request has to start it, which takes\n * several seconds and occasionally more. Nothing in the UI said so, and none of the\n * axios instances has a timeout, so the honest experience was a spinner that looked\n * stuck. This counts the in-flight requests a cold start would actually delay and\n * escalates in two steps, so a merely slow response says \"still loading\" and only a\n * genuinely long wait blames the sleeping server.\n *\n * Framework-free on purpose (no zustand, no axios, no React): a counter, two timers\n * and a listener set, read by `useServerWakeStage` through `useSyncExternalStore`.\n * The adapters below take the app's axios instance / fetch as an ARGUMENT, so the\n * kit never imports either.\n *\n * WHAT ARMS IT, and why the default is narrow:\n * - reads (GET) — what every page does on open — always;\n * - writes only when the app says so (`watchReadsAnd(/\\/auth\\/login\\b/)`): the\n * auth POSTs that gate the app are the only writes a user waits on before the\n * app exists at all, so a cold start there looks exactly like a broken login.\n * An UPLOAD must never be watched — a statement PDF or a photo takes seconds on a\n * perfectly warm server, and \"the server is waking up\" during a 4 s upload would\n * simply be false. With the default that holds by itself (an upload is a POST);\n * an app widening `shouldWatch` keeps its upload routes out of it.\n *\n * Nor a DOWNLOAD, for the same reason (kastlan 0.18): axios answers only once the\n * whole body is in, so a generated PDF or a large photo — a GET — ran past both\n * thresholds on a warm server, and held the count for every read beside it. The\n * default filter skips a request whose `responseType` is `\"blob\"`, `\"arraybuffer\"` or\n * `\"stream\"`; a custom filter gets the request as its third argument to do the same.\n * (`wrapFetch` ends the wait at the headers, so a download through it is harmless.)\n *\n * It never arms while the browser is offline, whatever `shouldWatch` says: that state\n * has its own, truthful indicator, and a request that never left the device is not\n * evidence of anything about the server.\n */\n\n/** `slow` = longer than a warm server ever takes; `waking` = long enough that a cold\n * start is the only sensible explanation. */\nexport type ServerWakeStage = \"idle\" | \"slow\" | \"waking\";\n\n/** Decides which requests count. `method` arrives lower-cased (`\"get\"` when the\n * request named none — axios's and fetch's default); `url` as the client had it;\n * `request` is what the adapter saw — for axios the request config itself, so\n * `responseType` or the app's own fields can decide. */\nexport type ServerWakeFilter = (method: string, url: string, request: ServerWakeRequest) => boolean;\n\nexport interface ServerWakeOptions {\n /** Past this, a warm round trip is out of the question (a cold database query on a\n * free tier can still take a second, so it is not tighter). Default 2000 ms. */\n slowMs?: number;\n /** Past this, the container was almost certainly scaled to zero. Default 7000 ms. */\n wakingMs?: number;\n /** Which requests count. Default {@link watchReadsAnd}`()` — GETs only, downloads\n * excluded. The offline guard runs before it and cannot be overridden. */\n shouldWatch?: ServerWakeFilter;\n}\n\n/** What a request is, for {@link ServerWakeWatcher.track} and a {@link ServerWakeFilter}. */\nexport interface ServerWakeRequest {\n method?: string;\n url?: string;\n /** axios's `responseType`. `\"blob\"`, `\"arraybuffer\"` and `\"stream\"` mark a download,\n * which the default filter does not count. */\n responseType?: string;\n}\n\nexport interface ServerWakeWatcher {\n /**\n * Count a request that is going out, and arm the escalation if it is the first.\n * Returns whether it was counted — the caller MUST call {@link end} exactly once\n * for every `true`, or the counter never returns to zero and the notice sticks.\n * (The axios adapter stashes it on the request config for that reason.)\n * `request` reaches the filter as its third argument; default `{ method, url }`.\n */\n start(method?: string, url?: string, request?: ServerWakeRequest): boolean;\n /** A counted request settled — either way: an error still proves the server\n * answered or gave up. The stage then follows the oldest request still out (0.51), so\n * the notice goes away when the last one does, or sooner when the rest are recent.\n * Never takes the counter below zero. */\n end(): void;\n /** `start` + `end` around a promise (or a function returning one), for a request\n * that does not go through an adapter. Resolves and rejects as the work does. */\n track<T>(work: PromiseLike<T> | (() => PromiseLike<T>), request?: ServerWakeRequest): Promise<T>;\n /** Back to a pristine watchdog — for tests, which share an instance across cases. */\n reset(): void;\n /** `useSyncExternalStore`'s pair. Listeners hear stage changes only. */\n subscribe(listener: () => void): () => void;\n getStage(): ServerWakeStage;\n /** Counted requests currently outstanding. */\n getInFlight(): number;\n}\n\n/** Response types that make a request a download — see the module comment. */\nconst DOWNLOAD_RESPONSE_TYPES = new Set([\"blob\", \"arraybuffer\", \"stream\"]);\n\n/**\n * The usual filter: every GET, plus any other request whose URL matches `writes` —\n * keksdose's `/\\/auth\\/(login|register|demo-session)\\b/` — but never a download\n * (`responseType` `\"blob\"`, `\"arraybuffer\"` or `\"stream\"`). Keep upload routes out of\n * the pattern (see the module comment).\n */\nexport function watchReadsAnd(writes?: RegExp): ServerWakeFilter {\n return (method, url, request) =>\n !DOWNLOAD_RESPONSE_TYPES.has(request?.responseType ?? \"\") &&\n (method === \"get\" || (writes !== undefined && writes.test(url)));\n}\n\nfunction isOffline(): boolean {\n return typeof navigator !== \"undefined\" && navigator.onLine === false;\n}\n\nexport function createServerWake({\n slowMs = 2000,\n wakingMs = 7000,\n shouldWatch = watchReadsAnd(),\n}: ServerWakeOptions = {}): ServerWakeWatcher {\n // When each counted request went out, oldest first; its length is the count.\n //\n // The stage is the age of the OLDEST outstanding request (0.51). It used to be the age of\n // the first request since the count was last zero, so overlapping reads that were each\n // fast — one going out before the last came back, on a busy page — chained past 2 s and\n // showed \"taking longer than usual\" with nothing slow at all (keksdose live #454, found\n // there while chasing a read that really was slow).\n //\n // `end()` names no request, so it retires the OLDEST start. When a newer request comes\n // back first, the start left standing for the older one is later than its own, so the\n // age read is never MORE than the oldest request's real age: a notice can come late,\n // never falsely.\n const starts: number[] = [];\n let stage: ServerWakeStage = \"idle\";\n let slowTimer: ReturnType<typeof setTimeout> | null = null;\n let wakingTimer: ReturnType<typeof setTimeout> | null = null;\n const listeners = new Set<() => void>();\n\n const setStage = (next: ServerWakeStage) => {\n if (next === stage) return;\n stage = next;\n for (const listener of listeners) listener();\n };\n\n const clearTimers = () => {\n if (slowTimer !== null) clearTimeout(slowTimer);\n if (wakingTimer !== null) clearTimeout(wakingTimer);\n slowTimer = null;\n wakingTimer = null;\n };\n\n // The stage for the oldest outstanding request's age, and timers for what is still to\n // come. With none outstanding: idle.\n const arm = () => {\n clearTimers();\n if (starts.length === 0) {\n setStage(\"idle\");\n return;\n }\n const age = Date.now() - starts[0];\n setStage(age >= wakingMs ? \"waking\" : age >= slowMs ? \"slow\" : \"idle\");\n if (age < slowMs) slowTimer = setTimeout(() => setStage(\"slow\"), slowMs - age);\n if (age < wakingMs) wakingTimer = setTimeout(() => setStage(\"waking\"), wakingMs - age);\n };\n\n const start = (method?: string, url?: string, request: ServerWakeRequest = { method, url }): boolean => {\n if (isOffline()) return false;\n if (!shouldWatch((method ?? \"get\").toLowerCase(), url ?? \"\", request)) return false;\n starts.push(Date.now());\n // A request joining others does not move the clock: a page firing a second read at\n // 1.9 s is still waiting on the same sleeping server, not starting afresh.\n if (starts.length === 1) arm();\n return true;\n };\n\n const end = () => {\n if (starts.length === 0) return;\n // The server answered (or gave up on) one of them, so the oldest's clock is over; the\n // next oldest's age decides, which may well put the notice away again.\n starts.shift();\n arm();\n };\n\n return {\n start,\n end,\n track<T>(work: PromiseLike<T> | (() => PromiseLike<T>), request: ServerWakeRequest = {}) {\n const counted = start(request.method, request.url, request);\n let promise: Promise<T>;\n try {\n promise = Promise.resolve(typeof work === \"function\" ? work() : work);\n } catch (error) {\n // A thunk that throws before it returns a promise settled too.\n promise = Promise.reject(error);\n }\n return counted ? promise.finally(end) : promise;\n },\n reset() {\n starts.length = 0;\n clearTimers();\n setStage(\"idle\");\n },\n subscribe(listener) {\n listeners.add(listener);\n return () => {\n listeners.delete(listener);\n };\n },\n getStage: () => stage,\n getInFlight: () => starts.length,\n };\n}\n\n/**\n * The shared instance: what `<ServerWakeNotice />`, `useServerWakeStage()`,\n * {@link attachServerWake} and {@link wrapFetch} use when no watcher is passed. GETs\n * only, default timings — an app that also watches its login POST creates its own\n * with {@link createServerWake} and passes it to both ends.\n */\nexport const serverWake: ServerWakeWatcher = createServerWake();\n\n// ── axios ─────────────────────────────────────────────────────────────────────\n\n/** The config fields the watchdog reads — what axios's request config has. The whole\n * config reaches the filter, so an app's filter can read the rest of it. */\nexport interface ServerWakeAxiosConfig {\n method?: string;\n url?: string;\n responseType?: string;\n}\n\n/** The slice of an interceptor manager the adapter uses. A method (not a function\n * property) so axios's wider `use(onFulfilled?, onRejected?, options?)` fits it. */\ninterface InterceptorManagerLike<V> {\n use(onFulfilled: (value: V) => V | Promise<V>, onRejected: (error: unknown) => unknown): number;\n eject(id: number): void;\n}\n\n/** An axios instance, structurally — so the kit types the adapter without importing\n * axios. `axios.create()`'s result fits it as is. */\nexport interface AxiosLikeInstance<C extends ServerWakeAxiosConfig, R extends { config: C }> {\n interceptors: {\n request: InterceptorManagerLike<C>;\n response: InterceptorManagerLike<R>;\n };\n}\n\n/** Whether the watchdog counted this request — the response side owes a matching\n * `end()` only then. On the config, as keksdose's `_wake` was: it travels with the\n * request onto the response and onto an error. Cleared once settled, so a 401 replay\n * of the same config re-enters the request interceptor and is counted afresh — the\n * pairing stays balanced. */\nconst COUNTED = \"_serverWake\";\ntype Marked = { [COUNTED]?: boolean };\n\n/**\n * Drive a watcher from an axios instance's interceptors: `attachServerWake(api)`.\n * Returns a function that ejects both interceptors again.\n *\n * Attach it BEFORE the app's own response interceptors: axios runs those in the order\n * they were added, so the wake one ends the wait before a 401 handler awaits a token\n * refresh — otherwise the notice would keep counting a request that has already been\n * answered. (Request-side order does not matter.)\n */\nexport function attachServerWake<C extends ServerWakeAxiosConfig, R extends { config: C }>(\n instance: AxiosLikeInstance<C, R>,\n watcher: ServerWakeWatcher = serverWake,\n): () => void {\n const settle = (config: unknown) => {\n const marked = config as Marked | undefined;\n if (marked?.[COUNTED]) {\n marked[COUNTED] = false;\n watcher.end();\n }\n };\n const request = instance.interceptors.request.use(\n (config) => {\n (config as C & Marked)[COUNTED] = watcher.start(config.method, config.url, config);\n return config;\n },\n (error) => Promise.reject(error),\n );\n const response = instance.interceptors.response.use(\n (res) => {\n settle(res.config);\n return res;\n },\n (error) => {\n settle((error as { config?: unknown } | null)?.config);\n return Promise.reject(error);\n },\n );\n return () => {\n instance.interceptors.request.eject(request);\n instance.interceptors.response.eject(response);\n };\n}\n\n// ── fetch ─────────────────────────────────────────────────────────────────────\n\n/**\n * A `fetch` that drives a watcher: `const apiFetch = wrapFetch(fetch)`. The wait ends\n * when the response's HEADERS arrive (or the call fails) — the server is awake by then,\n * however long the body takes.\n */\nexport function wrapFetch(\n fetchImpl: typeof fetch = globalThis.fetch,\n watcher: ServerWakeWatcher = serverWake,\n): typeof fetch {\n return (input, init) => {\n const request = typeof Request !== \"undefined\" && input instanceof Request ? input : undefined;\n const method = init?.method ?? request?.method;\n const url = typeof input === \"string\" ? input : input instanceof URL ? input.href : (request?.url ?? \"\");\n return watcher.track(() => fetchImpl(input, init), { method, url });\n };\n}\n"],"mappings":";AAgGA,MAAM,0BAA0B,oBAAI,IAAI,CAAC,QAAQ,eAAe,QAAQ,CAAC;AAQlE,SAAS,cAAc,QAAmC;AAC/D,SAAO,CAAC,QAAQ,KAAK,YACnB,CAAC,wBAAwB,IAAI,SAAS,gBAAgB,EAAE,MACvD,WAAW,SAAU,WAAW,UAAa,OAAO,KAAK,GAAG;AACjE;AAEA,SAAS,YAAqB;AAC5B,SAAO,OAAO,cAAc,eAAe,UAAU,WAAW;AAClE;AAEO,SAAS,iBAAiB;AAAA,EAC/B,SAAS;AAAA,EACT,WAAW;AAAA,EACX,cAAc,cAAc;AAC9B,IAAuB,CAAC,GAAsB;AAa5C,QAAM,SAAmB,CAAC;AAC1B,MAAI,QAAyB;AAC7B,MAAI,YAAkD;AACtD,MAAI,cAAoD;AACxD,QAAM,YAAY,oBAAI,IAAgB;AAEtC,QAAM,WAAW,CAAC,SAA0B;AAC1C,QAAI,SAAS,MAAO;AACpB,YAAQ;AACR,eAAW,YAAY,UAAW,UAAS;AAAA,EAC7C;AAEA,QAAM,cAAc,MAAM;AACxB,QAAI,cAAc,KAAM,cAAa,SAAS;AAC9C,QAAI,gBAAgB,KAAM,cAAa,WAAW;AAClD,gBAAY;AACZ,kBAAc;AAAA,EAChB;AAIA,QAAM,MAAM,MAAM;AAChB,gBAAY;AACZ,QAAI,OAAO,WAAW,GAAG;AACvB,eAAS,MAAM;AACf;AAAA,IACF;AACA,UAAM,MAAM,KAAK,IAAI,IAAI,OAAO,CAAC;AACjC,aAAS,OAAO,WAAW,WAAW,OAAO,SAAS,SAAS,MAAM;AACrE,QAAI,MAAM,OAAQ,aAAY,WAAW,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG;AAC7E,QAAI,MAAM,SAAU,eAAc,WAAW,MAAM,SAAS,QAAQ,GAAG,WAAW,GAAG;AAAA,EACvF;AAEA,QAAM,QAAQ,CAAC,QAAiB,KAAc,UAA6B,EAAE,QAAQ,IAAI,MAAe;AACtG,QAAI,UAAU,EAAG,QAAO;AACxB,QAAI,CAAC,aAAa,UAAU,OAAO,YAAY,GAAG,OAAO,IAAI,OAAO,EAAG,QAAO;AAC9E,WAAO,KAAK,KAAK,IAAI,CAAC;AAGtB,QAAI,OAAO,WAAW,EAAG,KAAI;AAC7B,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,MAAM;AAChB,QAAI,OAAO,WAAW,EAAG;AAGzB,WAAO,MAAM;AACb,QAAI;AAAA,EACN;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,MAAS,MAA+C,UAA6B,CAAC,GAAG;AACvF,YAAM,UAAU,MAAM,QAAQ,QAAQ,QAAQ,KAAK,OAAO;AAC1D,UAAI;AACJ,UAAI;AACF,kBAAU,QAAQ,QAAQ,OAAO,SAAS,aAAa,KAAK,IAAI,IAAI;AAAA,MACtE,SAAS,OAAO;AAEd,kBAAU,QAAQ,OAAO,KAAK;AAAA,MAChC;AACA,aAAO,UAAU,QAAQ,QAAQ,GAAG,IAAI;AAAA,IAC1C;AAAA,IACA,QAAQ;AACN,aAAO,SAAS;AAChB,kBAAY;AACZ,eAAS,MAAM;AAAA,IACjB;AAAA,IACA,UAAU,UAAU;AAClB,gBAAU,IAAI,QAAQ;AACtB,aAAO,MAAM;AACX,kBAAU,OAAO,QAAQ;AAAA,MAC3B;AAAA,IACF;AAAA,IACA,UAAU,MAAM;AAAA,IAChB,aAAa,MAAM,OAAO;AAAA,EAC5B;AACF;AAQO,MAAM,aAAgC,iBAAiB;AAiC9D,MAAM,UAAU;AAYT,SAAS,iBACd,UACA,UAA6B,YACjB;AACZ,QAAM,SAAS,CAAC,WAAoB;AAClC,UAAM,SAAS;AACf,QAAI,SAAS,OAAO,GAAG;AACrB,aAAO,OAAO,IAAI;AAClB,cAAQ,IAAI;AAAA,IACd;AAAA,EACF;AACA,QAAM,UAAU,SAAS,aAAa,QAAQ;AAAA,IAC5C,CAAC,WAAW;AACV,MAAC,OAAsB,OAAO,IAAI,QAAQ,MAAM,OAAO,QAAQ,OAAO,KAAK,MAAM;AACjF,aAAO;AAAA,IACT;AAAA,IACA,CAAC,UAAU,QAAQ,OAAO,KAAK;AAAA,EACjC;AACA,QAAM,WAAW,SAAS,aAAa,SAAS;AAAA,IAC9C,CAAC,QAAQ;AACP,aAAO,IAAI,MAAM;AACjB,aAAO;AAAA,IACT;AAAA,IACA,CAAC,UAAU;AACT,aAAQ,OAAuC,MAAM;AACrD,aAAO,QAAQ,OAAO,KAAK;AAAA,IAC7B;AAAA,EACF;AACA,SAAO,MAAM;AACX,aAAS,aAAa,QAAQ,MAAM,OAAO;AAC3C,aAAS,aAAa,SAAS,MAAM,QAAQ;AAAA,EAC/C;AACF;AASO,SAAS,UACd,YAA0B,WAAW,OACrC,UAA6B,YACf;AACd,SAAO,CAAC,OAAO,SAAS;AACtB,UAAM,UAAU,OAAO,YAAY,eAAe,iBAAiB,UAAU,QAAQ;AACrF,UAAM,SAAS,MAAM,UAAU,SAAS;AACxC,UAAM,MAAM,OAAO,UAAU,WAAW,QAAQ,iBAAiB,MAAM,MAAM,OAAQ,SAAS,OAAO;AACrG,WAAO,QAAQ,MAAM,MAAM,UAAU,OAAO,IAAI,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,EACpE;AACF;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/lib/server-wake.ts"],"sourcesContent":["/**\n * \"Is the server asleep, or is the app broken?\" — the cold-start watchdog, lifted\n * from keksdose (feedback #199) so kastlan and Kurvenschmiede get it too.\n *\n * All three backends run on Cloud Run with `--min-instances=0`: after an idle\n * period the container is gone and the first request has to start it, which takes\n * several seconds and occasionally more. Nothing in the UI said so, and none of the\n * axios instances has a timeout, so the honest experience was a spinner that looked\n * stuck. This counts the in-flight requests a cold start would actually delay and\n * escalates in two steps, so a merely slow response says \"still loading\" and only a\n * genuinely long wait blames the sleeping server.\n *\n * Framework-free on purpose (no zustand, no axios, no React): a counter, two timers\n * and a listener set, read by `useServerWakeStage` through `useSyncExternalStore`.\n * The adapters below take the app's axios instance / fetch as an ARGUMENT, so the\n * kit never imports either.\n *\n * WHAT ARMS IT, and why the default is narrow:\n * - reads (GET) — what every page does on open — always;\n * - writes only when the app says so (`watchReadsAnd(/\\/auth\\/login\\b/)`): the\n * auth POSTs that gate the app are the only writes a user waits on before the\n * app exists at all, so a cold start there looks exactly like a broken login.\n * An UPLOAD must never be watched — a statement PDF or a photo takes seconds on a\n * perfectly warm server, and \"the server is waking up\" during a 4 s upload would\n * simply be false. With the default that holds by itself (an upload is a POST);\n * an app widening `shouldWatch` keeps its upload routes out of it.\n *\n * Nor a DOWNLOAD, for the same reason (kastlan 0.18): axios answers only once the\n * whole body is in, so a generated PDF or a large photo — a GET — ran past both\n * thresholds on a warm server, and held the count for every read beside it. The\n * default filter skips a request whose `responseType` is `\"blob\"`, `\"arraybuffer\"` or\n * `\"stream\"`; a custom filter gets the request as its third argument to do the same.\n * (`wrapFetch` ends the wait at the headers, so a download through it is harmless.)\n *\n * It never arms while the browser is offline, whatever `shouldWatch` says: that state\n * has its own, truthful indicator, and a request that never left the device is not\n * evidence of anything about the server.\n *\n * A READ THAT IS HEAVY ON PURPOSE (0.55) — a report the server computes for a few\n * seconds — says so with `slowOk` on its request (the axios config, or `track`'s\n * request): it is counted, but never called slow, so it shows nothing while it is under\n * `wakingMs`. Past `wakingMs` it is the server waking like any other read. A read that\n * can take longer than that on a warm server stays out of the watch (`shouldWatch`).\n */\n\n/** `slow` = longer than a warm server ever takes; `waking` = long enough that a cold\n * start is the only sensible explanation. */\nexport type ServerWakeStage = \"idle\" | \"slow\" | \"waking\";\n\n/** Decides which requests count. `method` arrives lower-cased (`\"get\"` when the\n * request named none — axios's and fetch's default); `url` as the client had it;\n * `request` is what the adapter saw — for axios the request config itself, so\n * `responseType` or the app's own fields can decide. */\nexport type ServerWakeFilter = (method: string, url: string, request: ServerWakeRequest) => boolean;\n\nexport interface ServerWakeOptions {\n /** Past this, a warm round trip is out of the question (a cold database query on a\n * free tier can still take a second, so it is not tighter). Default 2000 ms. */\n slowMs?: number;\n /** Past this, the container was almost certainly scaled to zero. Default 7000 ms. */\n wakingMs?: number;\n /** Which requests count. Default {@link watchReadsAnd}`()` — GETs only, downloads\n * excluded. The offline guard runs before it and cannot be overridden. */\n shouldWatch?: ServerWakeFilter;\n}\n\n/** What a request is, for {@link ServerWakeWatcher.track} and a {@link ServerWakeFilter}. */\nexport interface ServerWakeRequest {\n method?: string;\n url?: string;\n /** axios's `responseType`. `\"blob\"`, `\"arraybuffer\"` and `\"stream\"` mark a download,\n * which the default filter does not count. */\n responseType?: string;\n /**\n * This read is slow on purpose (0.55; the per-request opt-out adopt-0.51 left open): it\n * still counts, but its own age never shows \"taking longer than usual\" — only past\n * `wakingMs`, when a cold start is the likelier story, does it show the server waking.\n * The stage then follows the other requests out beside it, as ever.\n *\n * ONLY for a read that is heavy but answers under `wakingMs` (7 s) on a warm server: a\n * report computed on request, a large page of rows. A read that can take longer — an\n * export rendered on the server, a slow third party behind the route — would say \"the\n * server is waking up\" on a warm server; keep it out of the watch through `shouldWatch`\n * instead (kastlan's advice), as a download and an upload are.\n *\n * On axios it rides the request config: `api.get(url, { slowOk: true })` (declare it on\n * `AxiosRequestConfig` once, by module augmentation); through `track`, on its request.\n */\n slowOk?: boolean;\n}\n\n/**\n * One counted request, as {@link ServerWakeWatcher.start} names it (0.55, keksdose's 0.51\n * review N4): a positive whole number, unique for the watcher's lifetime, which\n * {@link ServerWakeWatcher.end} takes back to end exactly that request. `start` returns\n * `false` where it counts nothing, as before: the token is truthy where `start` returned\n * `true` until 0.55, so code that only tests it reads as it did.\n */\nexport type ServerWakeToken = number;\n\nexport interface ServerWakeWatcher {\n /**\n * Count a request that is going out, and arm the escalation if it is the first.\n * Returns its {@link ServerWakeToken}, or `false` when it was not counted (until 0.55\n * `true` / `false`; the token is truthy where `true` was). The caller MUST end every\n * counted request exactly once, or the counter never returns to zero and the notice\n * sticks: `end(token)`, which ends that request, or a bare `end()`, as before. (The\n * axios adapter stashes the token on the request config for that reason.)\n * `request` reaches the filter as its third argument; default `{ method, url }`.\n */\n start(method?: string, url?: string, request?: ServerWakeRequest): ServerWakeToken | false;\n /**\n * A counted request settled — either way: an error still proves the server answered or\n * gave up. The stage then follows the oldest request still out (0.51), so the notice\n * goes away when the last one does, or sooner when the rest are recent.\n *\n * With `token` (0.55), exactly that request is retired, so the age the stage is read\n * from is the real one; a token that was ended already (or reset away), or `false`, is\n * a no-op. A bare `end()` — the call before 0.55 — retires the OLDEST start, which can\n * make a notice come late, never falsely. Never takes the counter below zero.\n */\n end(token?: ServerWakeToken | false): void;\n /** `start` + `end` around a promise (or a function returning one), for a request\n * that does not go through an adapter. Resolves and rejects as the work does. */\n track<T>(work: PromiseLike<T> | (() => PromiseLike<T>), request?: ServerWakeRequest): Promise<T>;\n /** Back to a pristine watchdog — for tests, which share an instance across cases. */\n reset(): void;\n /** `useSyncExternalStore`'s pair. Listeners hear stage changes only. */\n subscribe(listener: () => void): () => void;\n getStage(): ServerWakeStage;\n /** Counted requests currently outstanding. */\n getInFlight(): number;\n}\n\n/** Response types that make a request a download — see the module comment. */\nconst DOWNLOAD_RESPONSE_TYPES = new Set([\"blob\", \"arraybuffer\", \"stream\"]);\n\n/**\n * The usual filter: every GET, plus any other request whose URL matches `writes` —\n * keksdose's `/\\/auth\\/(login|register|demo-session)\\b/` — but never a download\n * (`responseType` `\"blob\"`, `\"arraybuffer\"` or `\"stream\"`). Keep upload routes out of\n * the pattern (see the module comment).\n */\nexport function watchReadsAnd(writes?: RegExp): ServerWakeFilter {\n return (method, url, request) =>\n !DOWNLOAD_RESPONSE_TYPES.has(request?.responseType ?? \"\") &&\n (method === \"get\" || (writes !== undefined && writes.test(url)));\n}\n\nfunction isOffline(): boolean {\n return typeof navigator !== \"undefined\" && navigator.onLine === false;\n}\n\nexport function createServerWake({\n slowMs = 2000,\n wakingMs = 7000,\n shouldWatch = watchReadsAnd(),\n}: ServerWakeOptions = {}): ServerWakeWatcher {\n // Each counted request still out — its token and when it went out — oldest first; its\n // length is the count.\n //\n // The stage is the age of the OLDEST outstanding request (0.51). It used to be the age of\n // the first request since the count was last zero, so overlapping reads that were each\n // fast — one going out before the last came back, on a busy page — chained past 2 s and\n // showed \"taking longer than usual\" with nothing slow at all (keksdose live #454, found\n // there while chasing a read that really was slow).\n //\n // `end(token)` (0.55, keksdose's 0.51 review N4) retires exactly the request that\n // settled. A bare `end()` names none, so it retires the OLDEST start: when a newer\n // request came back first, the start left standing for the older one is later than its\n // own, so the age read is never MORE than the oldest request's real age — a notice can\n // come late, never falsely. The token makes it exact.\n //\n // A `slowOk` request (0.55) is timed for \"waking\" like the rest, never for \"slow\": the\n // slow stage reads the oldest request out that is NOT slowOk.\n const starts: Array<{ token: ServerWakeToken; at: number; slowOk: boolean }> = [];\n // The last token handed out. Never reset, not even by `reset()`: a token from before a\n // reset must not name a request after it.\n let lastToken = 0;\n let stage: ServerWakeStage = \"idle\";\n let slowTimer: ReturnType<typeof setTimeout> | null = null;\n let wakingTimer: ReturnType<typeof setTimeout> | null = null;\n const listeners = new Set<() => void>();\n\n const setStage = (next: ServerWakeStage) => {\n if (next === stage) return;\n stage = next;\n for (const listener of listeners) listener();\n };\n\n const clearTimers = () => {\n if (slowTimer !== null) clearTimeout(slowTimer);\n if (wakingTimer !== null) clearTimeout(wakingTimer);\n slowTimer = null;\n wakingTimer = null;\n };\n\n // A timer only ever raises the stage: with a slowOk request oldest, the waking timer\n // (its) can fire before the slow one (a newer read's), which must not take it back.\n const raise = (next: \"slow\" | \"waking\") => {\n if (stage !== \"waking\" && next !== stage) setStage(next);\n };\n\n // The stage for the outstanding requests' ages — \"waking\" from the oldest of all,\n // \"slow\" from the oldest that is not slowOk — and timers for what is still to come.\n // With none outstanding: idle.\n const arm = () => {\n clearTimers();\n if (starts.length === 0) {\n setStage(\"idle\");\n return;\n }\n const now = Date.now();\n const age = now - starts[0].at;\n const slowFrom = starts.find((s) => !s.slowOk);\n // `undefined` while every request out is slowOk: nothing to call slow.\n const slowAge = slowFrom && now - slowFrom.at;\n setStage(age >= wakingMs ? \"waking\" : slowAge !== undefined && slowAge >= slowMs ? \"slow\" : \"idle\");\n if (slowAge !== undefined && slowAge < slowMs) slowTimer = setTimeout(() => raise(\"slow\"), slowMs - slowAge);\n if (age < wakingMs) wakingTimer = setTimeout(() => raise(\"waking\"), wakingMs - age);\n };\n\n const start = (\n method?: string,\n url?: string,\n request: ServerWakeRequest = { method, url },\n ): ServerWakeToken | false => {\n if (isOffline()) return false;\n if (!shouldWatch((method ?? \"get\").toLowerCase(), url ?? \"\", request)) return false;\n lastToken += 1;\n const slowOk = request.slowOk === true;\n starts.push({ token: lastToken, at: Date.now(), slowOk });\n // A request joining others does not move the clock: a page firing a second read at\n // 1.9 s is still waiting on the same sleeping server, not starting afresh. Only the\n // first request out, or the first that may be called slow, starts one.\n if (starts.length === 1 || (!slowOk && starts.every((s, i) => s.slowOk || i === starts.length - 1))) arm();\n return lastToken;\n };\n\n const end = (token?: ServerWakeToken | false) => {\n // Bare: the oldest. Named: that one, or nothing when it is not out (ended already, from\n // before a reset, or `false`, never counted) — never another request in its place.\n const index = token === undefined ? 0 : starts.findIndex((s) => s.token === token);\n if (index < 0 || index >= starts.length) return;\n // The server answered (or gave up on) it, so its clock is over; the oldest still out\n // decides, which may well put the notice away again.\n starts.splice(index, 1);\n arm();\n };\n\n return {\n start,\n end,\n track<T>(work: PromiseLike<T> | (() => PromiseLike<T>), request: ServerWakeRequest = {}) {\n const token = start(request.method, request.url, request);\n let promise: Promise<T>;\n try {\n promise = Promise.resolve(typeof work === \"function\" ? work() : work);\n } catch (error) {\n // A thunk that throws before it returns a promise settled too.\n promise = Promise.reject(error);\n }\n // Its own token, so a tracked request ends exactly itself (0.55).\n return token ? promise.finally(() => end(token)) : promise;\n },\n reset() {\n starts.length = 0;\n clearTimers();\n setStage(\"idle\");\n },\n subscribe(listener) {\n listeners.add(listener);\n return () => {\n listeners.delete(listener);\n };\n },\n getStage: () => stage,\n getInFlight: () => starts.length,\n };\n}\n\n/**\n * The shared instance: what `<ServerWakeNotice />`, `useServerWakeStage()`,\n * {@link attachServerWake} and {@link wrapFetch} use when no watcher is passed. GETs\n * only, default timings — an app that also watches its login POST creates its own\n * with {@link createServerWake} and passes it to both ends.\n */\nexport const serverWake: ServerWakeWatcher = createServerWake();\n\n// ── axios ─────────────────────────────────────────────────────────────────────\n\n/** The config fields the watchdog reads — what axios's request config has. The whole\n * config reaches the filter, so an app's filter can read the rest of it. */\nexport interface ServerWakeAxiosConfig {\n method?: string;\n url?: string;\n responseType?: string;\n /** A read slow on purpose — see {@link ServerWakeRequest.slowOk} (0.55). */\n slowOk?: boolean;\n}\n\n/** The slice of an interceptor manager the adapter uses. A method (not a function\n * property) so axios's wider `use(onFulfilled?, onRejected?, options?)` fits it. */\ninterface InterceptorManagerLike<V> {\n use(onFulfilled: (value: V) => V | Promise<V>, onRejected: (error: unknown) => unknown): number;\n eject(id: number): void;\n}\n\n/** An axios instance, structurally — so the kit types the adapter without importing\n * axios. `axios.create()`'s result fits it as is. */\nexport interface AxiosLikeInstance<C extends ServerWakeAxiosConfig, R extends { config: C }> {\n interceptors: {\n request: InterceptorManagerLike<C>;\n response: InterceptorManagerLike<R>;\n };\n}\n\n/** The token the watchdog gave this request, when it counted it — the response side owes\n * a matching `end(token)` only then, and ends exactly this request (0.55; a `true` and\n * a bare `end()` until then). On the config, as keksdose's `_wake` was: it travels with\n * the request onto the response and onto an error. Cleared once settled, so a 401 replay\n * of the same config re-enters the request interceptor and is counted afresh — the\n * pairing stays balanced. */\nconst COUNTED = \"_serverWake\";\ntype Marked = { [COUNTED]?: ServerWakeToken | false };\n\n/**\n * Drive a watcher from an axios instance's interceptors: `attachServerWake(api)`.\n * Returns a function that ejects both interceptors again.\n *\n * Attach it BEFORE the app's own response interceptors: axios runs those in the order\n * they were added, so the wake one ends the wait before a 401 handler awaits a token\n * refresh — otherwise the notice would keep counting a request that has already been\n * answered. (Request-side order does not matter.)\n */\nexport function attachServerWake<C extends ServerWakeAxiosConfig, R extends { config: C }>(\n instance: AxiosLikeInstance<C, R>,\n watcher: ServerWakeWatcher = serverWake,\n): () => void {\n const settle = (config: unknown) => {\n const marked = config as Marked | undefined;\n const token = marked?.[COUNTED];\n if (marked && token) {\n marked[COUNTED] = false;\n watcher.end(token);\n }\n };\n const request = instance.interceptors.request.use(\n (config) => {\n (config as C & Marked)[COUNTED] = watcher.start(config.method, config.url, config);\n return config;\n },\n (error) => Promise.reject(error),\n );\n const response = instance.interceptors.response.use(\n (res) => {\n settle(res.config);\n return res;\n },\n (error) => {\n settle((error as { config?: unknown } | null)?.config);\n return Promise.reject(error);\n },\n );\n return () => {\n instance.interceptors.request.eject(request);\n instance.interceptors.response.eject(response);\n };\n}\n\n// ── fetch ─────────────────────────────────────────────────────────────────────\n\n/**\n * A `fetch` that drives a watcher: `const apiFetch = wrapFetch(fetch)`. The wait ends\n * when the response's HEADERS arrive (or the call fails) — the server is awake by then,\n * however long the body takes.\n */\nexport function wrapFetch(\n fetchImpl: typeof fetch = globalThis.fetch,\n watcher: ServerWakeWatcher = serverWake,\n): typeof fetch {\n return (input, init) => {\n const request = typeof Request !== \"undefined\" && input instanceof Request ? input : undefined;\n const method = init?.method ?? request?.method;\n const url = typeof input === \"string\" ? input : input instanceof URL ? input.href : (request?.url ?? \"\");\n return watcher.track(() => fetchImpl(input, init), { method, url });\n };\n}\n"],"mappings":";AAuIA,MAAM,0BAA0B,oBAAI,IAAI,CAAC,QAAQ,eAAe,QAAQ,CAAC;AAQlE,SAAS,cAAc,QAAmC;AAC/D,SAAO,CAAC,QAAQ,KAAK,YACnB,CAAC,wBAAwB,IAAI,SAAS,gBAAgB,EAAE,MACvD,WAAW,SAAU,WAAW,UAAa,OAAO,KAAK,GAAG;AACjE;AAEA,SAAS,YAAqB;AAC5B,SAAO,OAAO,cAAc,eAAe,UAAU,WAAW;AAClE;AAEO,SAAS,iBAAiB;AAAA,EAC/B,SAAS;AAAA,EACT,WAAW;AAAA,EACX,cAAc,cAAc;AAC9B,IAAuB,CAAC,GAAsB;AAkB5C,QAAM,SAAyE,CAAC;AAGhF,MAAI,YAAY;AAChB,MAAI,QAAyB;AAC7B,MAAI,YAAkD;AACtD,MAAI,cAAoD;AACxD,QAAM,YAAY,oBAAI,IAAgB;AAEtC,QAAM,WAAW,CAAC,SAA0B;AAC1C,QAAI,SAAS,MAAO;AACpB,YAAQ;AACR,eAAW,YAAY,UAAW,UAAS;AAAA,EAC7C;AAEA,QAAM,cAAc,MAAM;AACxB,QAAI,cAAc,KAAM,cAAa,SAAS;AAC9C,QAAI,gBAAgB,KAAM,cAAa,WAAW;AAClD,gBAAY;AACZ,kBAAc;AAAA,EAChB;AAIA,QAAM,QAAQ,CAAC,SAA4B;AACzC,QAAI,UAAU,YAAY,SAAS,MAAO,UAAS,IAAI;AAAA,EACzD;AAKA,QAAM,MAAM,MAAM;AAChB,gBAAY;AACZ,QAAI,OAAO,WAAW,GAAG;AACvB,eAAS,MAAM;AACf;AAAA,IACF;AACA,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,MAAM,MAAM,OAAO,CAAC,EAAE;AAC5B,UAAM,WAAW,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM;AAE7C,UAAM,UAAU,YAAY,MAAM,SAAS;AAC3C,aAAS,OAAO,WAAW,WAAW,YAAY,UAAa,WAAW,SAAS,SAAS,MAAM;AAClG,QAAI,YAAY,UAAa,UAAU,OAAQ,aAAY,WAAW,MAAM,MAAM,MAAM,GAAG,SAAS,OAAO;AAC3G,QAAI,MAAM,SAAU,eAAc,WAAW,MAAM,MAAM,QAAQ,GAAG,WAAW,GAAG;AAAA,EACpF;AAEA,QAAM,QAAQ,CACZ,QACA,KACA,UAA6B,EAAE,QAAQ,IAAI,MACf;AAC5B,QAAI,UAAU,EAAG,QAAO;AACxB,QAAI,CAAC,aAAa,UAAU,OAAO,YAAY,GAAG,OAAO,IAAI,OAAO,EAAG,QAAO;AAC9E,iBAAa;AACb,UAAM,SAAS,QAAQ,WAAW;AAClC,WAAO,KAAK,EAAE,OAAO,WAAW,IAAI,KAAK,IAAI,GAAG,OAAO,CAAC;AAIxD,QAAI,OAAO,WAAW,KAAM,CAAC,UAAU,OAAO,MAAM,CAAC,GAAG,MAAM,EAAE,UAAU,MAAM,OAAO,SAAS,CAAC,EAAI,KAAI;AACzG,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,CAAC,UAAoC;AAG/C,UAAM,QAAQ,UAAU,SAAY,IAAI,OAAO,UAAU,CAAC,MAAM,EAAE,UAAU,KAAK;AACjF,QAAI,QAAQ,KAAK,SAAS,OAAO,OAAQ;AAGzC,WAAO,OAAO,OAAO,CAAC;AACtB,QAAI;AAAA,EACN;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,MAAS,MAA+C,UAA6B,CAAC,GAAG;AACvF,YAAM,QAAQ,MAAM,QAAQ,QAAQ,QAAQ,KAAK,OAAO;AACxD,UAAI;AACJ,UAAI;AACF,kBAAU,QAAQ,QAAQ,OAAO,SAAS,aAAa,KAAK,IAAI,IAAI;AAAA,MACtE,SAAS,OAAO;AAEd,kBAAU,QAAQ,OAAO,KAAK;AAAA,MAChC;AAEA,aAAO,QAAQ,QAAQ,QAAQ,MAAM,IAAI,KAAK,CAAC,IAAI;AAAA,IACrD;AAAA,IACA,QAAQ;AACN,aAAO,SAAS;AAChB,kBAAY;AACZ,eAAS,MAAM;AAAA,IACjB;AAAA,IACA,UAAU,UAAU;AAClB,gBAAU,IAAI,QAAQ;AACtB,aAAO,MAAM;AACX,kBAAU,OAAO,QAAQ;AAAA,MAC3B;AAAA,IACF;AAAA,IACA,UAAU,MAAM;AAAA,IAChB,aAAa,MAAM,OAAO;AAAA,EAC5B;AACF;AAQO,MAAM,aAAgC,iBAAiB;AAoC9D,MAAM,UAAU;AAYT,SAAS,iBACd,UACA,UAA6B,YACjB;AACZ,QAAM,SAAS,CAAC,WAAoB;AAClC,UAAM,SAAS;AACf,UAAM,QAAQ,SAAS,OAAO;AAC9B,QAAI,UAAU,OAAO;AACnB,aAAO,OAAO,IAAI;AAClB,cAAQ,IAAI,KAAK;AAAA,IACnB;AAAA,EACF;AACA,QAAM,UAAU,SAAS,aAAa,QAAQ;AAAA,IAC5C,CAAC,WAAW;AACV,MAAC,OAAsB,OAAO,IAAI,QAAQ,MAAM,OAAO,QAAQ,OAAO,KAAK,MAAM;AACjF,aAAO;AAAA,IACT;AAAA,IACA,CAAC,UAAU,QAAQ,OAAO,KAAK;AAAA,EACjC;AACA,QAAM,WAAW,SAAS,aAAa,SAAS;AAAA,IAC9C,CAAC,QAAQ;AACP,aAAO,IAAI,MAAM;AACjB,aAAO;AAAA,IACT;AAAA,IACA,CAAC,UAAU;AACT,aAAQ,OAAuC,MAAM;AACrD,aAAO,QAAQ,OAAO,KAAK;AAAA,IAC7B;AAAA,EACF;AACA,SAAO,MAAM;AACX,aAAS,aAAa,QAAQ,MAAM,OAAO;AAC3C,aAAS,aAAa,SAAS,MAAM,QAAQ;AAAA,EAC/C;AACF;AASO,SAAS,UACd,YAA0B,WAAW,OACrC,UAA6B,YACf;AACd,SAAO,CAAC,OAAO,SAAS;AACtB,UAAM,UAAU,OAAO,YAAY,eAAe,iBAAiB,UAAU,QAAQ;AACrF,UAAM,SAAS,MAAM,UAAU,SAAS;AACxC,UAAM,MAAM,OAAO,UAAU,WAAW,QAAQ,iBAAiB,MAAM,MAAM,OAAQ,SAAS,OAAO;AACrG,WAAO,QAAQ,MAAM,MAAM,UAAU,OAAO,IAAI,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,EACpE;AACF;","names":[]}
|
|
@@ -33,6 +33,10 @@
|
|
|
33
33
|
*
|
|
34
34
|
* Framework-free like `server-wake.ts`: {@link attachSessionRefresh} takes the app's
|
|
35
35
|
* axios instance as an ARGUMENT, typed structurally, so the kit never imports axios.
|
|
36
|
+
*
|
|
37
|
+
* Since 0.55, {@link watchSessionElsewhere} beside it: the session ending in ANOTHER tab,
|
|
38
|
+
* or while this page sat in the back/forward cache (kastlan reuse audit 2026-11-02,
|
|
39
|
+
* proposal 6).
|
|
36
40
|
*/
|
|
37
41
|
import type { AxiosLikeInstance, ServerWakeAxiosConfig } from "./server-wake.js";
|
|
38
42
|
/** What the app's `refresh` resolves: the new access token, plus whatever its `store`
|
|
@@ -197,4 +201,53 @@ interface SessionRefreshInstance<C extends SessionRefreshAxiosConfig, R extends
|
|
|
197
201
|
export declare function attachSessionRefresh<C extends SessionRefreshAxiosConfig, R extends {
|
|
198
202
|
config: C;
|
|
199
203
|
}>(instance: SessionRefreshInstance<C, R>, session: SessionRefresh<SessionRenewal>): () => void;
|
|
204
|
+
/** What the app hands {@link watchSessionElsewhere}. */
|
|
205
|
+
export interface SessionElsewhereOptions {
|
|
206
|
+
/**
|
|
207
|
+
* Whether this tab's session is over: this tab holds one, and the storage every tab
|
|
208
|
+
* shares no longer does — its token removed by a sign-out elsewhere, the storage
|
|
209
|
+
* cleared — or holds another account's. Read where the app's request interceptor reads
|
|
210
|
+
* the token (`readStored`), against what this tab keeps in memory. A renewal elsewhere
|
|
211
|
+
* rewrites the token and is no end; a tab with no session has nothing to end.
|
|
212
|
+
*/
|
|
213
|
+
ended: () => boolean;
|
|
214
|
+
/**
|
|
215
|
+
* The session is over in this tab: drop what this tab holds of it (the user, the query
|
|
216
|
+
* cache, the unlocked keys), then leave with a full load, of the sign-in or the demo's
|
|
217
|
+
* end. Not the app's whole sign-out: the other tab has already removed what the device
|
|
218
|
+
* kept, and may since have stored a session that is not this tab's to delete.
|
|
219
|
+
*
|
|
220
|
+
* Called once per session: further `storage` events while `ended` still reads `true`
|
|
221
|
+
* call nothing, until it has read `false` again. A restored page is asked afresh.
|
|
222
|
+
*/
|
|
223
|
+
onEnded: () => void;
|
|
224
|
+
/** Also check a page the browser brings back from its back/forward cache (`pageshow`
|
|
225
|
+
* with `persisted`). Default `true`. */
|
|
226
|
+
checkRestored?: boolean;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Watch for this tab's session ending in another tab (kastlan reuse audit 2026-11-02,
|
|
230
|
+
* proposal 6): `const stop = watchSessionElsewhere({ ended, onEnded })`, once per tab,
|
|
231
|
+
* beside the app's session store. Returns the function that stops watching.
|
|
232
|
+
*
|
|
233
|
+
* The session belongs to the device — its tokens sit in localStorage, which every tab
|
|
234
|
+
* shares — and the account on screen to the tab: the user, the query cache and the
|
|
235
|
+
* unlocked keys sit in this tab's memory. A sign-out in another tab changed the first and
|
|
236
|
+
* left the second, so this tab kept the previous account on screen and wrote its data
|
|
237
|
+
* back into the offline copy the other tab had just wiped (refactor audit 2026-10-30:
|
|
238
|
+
* keksdose FS-2, kastlan FLW-1). Two moments tell it:
|
|
239
|
+
*
|
|
240
|
+
* - a `storage` event: another tab wrote or removed a key. `ended` is read after every
|
|
241
|
+
* one, whatever its key — it reads the state, so it needs no list of keys, and a
|
|
242
|
+
* cleared storage (`key` null) counts like any removal;
|
|
243
|
+
* - a page restored from the back/forward cache (`pageshow` with `persisted`). Frozen
|
|
244
|
+
* there, it heard no `storage` event and came back on the previous account, where it
|
|
245
|
+
* could renew the old session and store its tokens again over the sign-out (keksdose
|
|
246
|
+
* F-31; kastlan listened to `storage` alone). A fresh load reads the storage anyway,
|
|
247
|
+
* so nothing is checked when the watch starts, nor on a `pageshow` that is no restore.
|
|
248
|
+
*
|
|
249
|
+
* Framework-free and storage-free: `ended` is the app's read, guarded where it reads
|
|
250
|
+
* (the kit's `readStored` never throws). Nothing is watched where there is no `window`.
|
|
251
|
+
*/
|
|
252
|
+
export declare function watchSessionElsewhere(options: SessionElsewhereOptions): () => void;
|
|
200
253
|
export {};
|
|
@@ -178,10 +178,36 @@ function attachSessionRefresh(instance, session) {
|
|
|
178
178
|
instance.interceptors.response.eject(response);
|
|
179
179
|
};
|
|
180
180
|
}
|
|
181
|
+
function watchSessionElsewhere(options) {
|
|
182
|
+
if (typeof window === "undefined") return () => void 0;
|
|
183
|
+
let told = false;
|
|
184
|
+
const check = () => {
|
|
185
|
+
if (!options.ended()) {
|
|
186
|
+
told = false;
|
|
187
|
+
return;
|
|
188
|
+
}
|
|
189
|
+
if (told) return;
|
|
190
|
+
told = true;
|
|
191
|
+
options.onEnded();
|
|
192
|
+
};
|
|
193
|
+
const onStorage = () => check();
|
|
194
|
+
const onPageShow = (event) => {
|
|
195
|
+
if (!event.persisted) return;
|
|
196
|
+
told = false;
|
|
197
|
+
check();
|
|
198
|
+
};
|
|
199
|
+
window.addEventListener("storage", onStorage);
|
|
200
|
+
if (options.checkRestored !== false) window.addEventListener("pageshow", onPageShow);
|
|
201
|
+
return () => {
|
|
202
|
+
window.removeEventListener("storage", onStorage);
|
|
203
|
+
window.removeEventListener("pageshow", onPageShow);
|
|
204
|
+
};
|
|
205
|
+
}
|
|
181
206
|
export {
|
|
182
207
|
attachSessionRefresh,
|
|
183
208
|
createSessionRefresh,
|
|
184
209
|
isSignedOutStep,
|
|
185
|
-
isTransientRefreshFailure
|
|
210
|
+
isTransientRefreshFailure,
|
|
211
|
+
watchSessionElsewhere
|
|
186
212
|
};
|
|
187
213
|
//# sourceMappingURL=session-refresh.js.map
|