tempest-react-sdk 0.48.0 → 0.49.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/dist/audio/sfx-pool.cjs +1 -1
- package/dist/audio/sfx-pool.cjs.map +1 -1
- package/dist/audio/sfx-pool.js +16 -7
- package/dist/audio/sfx-pool.js.map +1 -1
- package/dist/audio/use-sfx-pool.cjs +1 -1
- package/dist/audio/use-sfx-pool.cjs.map +1 -1
- package/dist/audio/use-sfx-pool.js +3 -8
- package/dist/audio/use-sfx-pool.js.map +1 -1
- package/dist/auth/passkey.cjs +1 -1
- package/dist/auth/passkey.cjs.map +1 -1
- package/dist/auth/passkey.js +79 -81
- package/dist/auth/passkey.js.map +1 -1
- package/dist/charts.cjs +1 -1
- package/dist/charts.js +4 -4
- package/dist/components/BarList/BarList.cjs +1 -1
- package/dist/components/BarList/BarList.cjs.map +1 -1
- package/dist/components/BarList/BarList.js +31 -24
- package/dist/components/BarList/BarList.js.map +1 -1
- package/dist/components/BarList/bar-list-model.cjs +1 -1
- package/dist/components/BarList/bar-list-model.cjs.map +1 -1
- package/dist/components/BarList/bar-list-model.js +5 -5
- package/dist/components/BarList/bar-list-model.js.map +1 -1
- package/dist/components/ClickOutside/ClickOutside.cjs +1 -1
- package/dist/components/ClickOutside/ClickOutside.cjs.map +1 -1
- package/dist/components/ClickOutside/ClickOutside.js +13 -14
- package/dist/components/ClickOutside/ClickOutside.js.map +1 -1
- package/dist/components/DataTable/DataTable.cjs +1 -1
- package/dist/components/DataTable/DataTable.cjs.map +1 -1
- package/dist/components/DataTable/DataTable.js +124 -122
- package/dist/components/DataTable/DataTable.js.map +1 -1
- package/dist/components/FilterBar/filter-apply.cjs +1 -1
- package/dist/components/FilterBar/filter-apply.cjs.map +1 -1
- package/dist/components/FilterBar/filter-apply.js +35 -38
- package/dist/components/FilterBar/filter-apply.js.map +1 -1
- package/dist/components/FilterBar/filter-query.cjs +1 -1
- package/dist/components/FilterBar/filter-query.cjs.map +1 -1
- package/dist/components/FilterBar/filter-query.js +16 -13
- package/dist/components/FilterBar/filter-query.js.map +1 -1
- package/dist/geo/use-position-tracker.cjs +1 -1
- package/dist/geo/use-position-tracker.cjs.map +1 -1
- package/dist/geo/use-position-tracker.js +25 -26
- package/dist/geo/use-position-tracker.js.map +1 -1
- package/dist/hooks/use-async.cjs +1 -1
- package/dist/hooks/use-async.cjs.map +1 -1
- package/dist/hooks/use-async.js +27 -30
- package/dist/hooks/use-async.js.map +1 -1
- package/dist/hooks/use-click-outside.cjs +1 -1
- package/dist/hooks/use-click-outside.cjs.map +1 -1
- package/dist/hooks/use-click-outside.js +8 -9
- package/dist/hooks/use-click-outside.js.map +1 -1
- package/dist/hooks/use-countdown.cjs +1 -1
- package/dist/hooks/use-countdown.cjs.map +1 -1
- package/dist/hooks/use-countdown.js +8 -13
- package/dist/hooks/use-countdown.js.map +1 -1
- package/dist/hooks/use-event-listener.cjs +1 -1
- package/dist/hooks/use-event-listener.cjs.map +1 -1
- package/dist/hooks/use-event-listener.js +6 -6
- package/dist/hooks/use-event-listener.js.map +1 -1
- package/dist/hooks/use-interval.cjs +1 -1
- package/dist/hooks/use-interval.cjs.map +1 -1
- package/dist/hooks/use-interval.js +5 -6
- package/dist/hooks/use-interval.js.map +1 -1
- package/dist/hooks/use-latest-ref.cjs.map +1 -1
- package/dist/hooks/use-latest-ref.js.map +1 -1
- package/dist/hooks/use-long-press-handlers.cjs +1 -1
- package/dist/hooks/use-long-press-handlers.cjs.map +1 -1
- package/dist/hooks/use-long-press-handlers.js +8 -10
- package/dist/hooks/use-long-press-handlers.js.map +1 -1
- package/dist/hooks/use-long-press.cjs +1 -1
- package/dist/hooks/use-long-press.cjs.map +1 -1
- package/dist/hooks/use-long-press.js +6 -6
- package/dist/hooks/use-long-press.js.map +1 -1
- package/dist/hooks/use-online.cjs +1 -1
- package/dist/hooks/use-online.cjs.map +1 -1
- package/dist/hooks/use-online.js +10 -10
- package/dist/hooks/use-online.js.map +1 -1
- package/dist/hooks/use-service-worker-update.cjs +1 -1
- package/dist/hooks/use-service-worker-update.cjs.map +1 -1
- package/dist/hooks/use-service-worker-update.js +24 -25
- package/dist/hooks/use-service-worker-update.js.map +1 -1
- package/dist/hooks/use-stable-callback.cjs +1 -1
- package/dist/hooks/use-stable-callback.cjs.map +1 -1
- package/dist/hooks/use-stable-callback.js +4 -3
- package/dist/hooks/use-stable-callback.js.map +1 -1
- package/dist/hooks/use-timeout.cjs +1 -1
- package/dist/hooks/use-timeout.cjs.map +1 -1
- package/dist/hooks/use-timeout.js +5 -6
- package/dist/hooks/use-timeout.js.map +1 -1
- package/dist/hooks/use-typewriter.cjs +1 -1
- package/dist/hooks/use-typewriter.cjs.map +1 -1
- package/dist/hooks/use-typewriter.js +9 -18
- package/dist/hooks/use-typewriter.js.map +1 -1
- package/dist/http/api-client.cjs +1 -1
- package/dist/http/api-client.cjs.map +1 -1
- package/dist/http/api-client.js +11 -16
- package/dist/http/api-client.js.map +1 -1
- package/dist/http/describe-api-error.cjs +1 -1
- package/dist/http/describe-api-error.cjs.map +1 -1
- package/dist/http/describe-api-error.js +12 -15
- package/dist/http/describe-api-error.js.map +1 -1
- package/dist/http/errors.cjs +1 -1
- package/dist/http/errors.cjs.map +1 -1
- package/dist/http/errors.js +18 -6
- package/dist/http/errors.js.map +1 -1
- package/dist/http/resumable-upload.cjs +1 -1
- package/dist/http/resumable-upload.cjs.map +1 -1
- package/dist/http/resumable-upload.js +60 -61
- package/dist/http/resumable-upload.js.map +1 -1
- package/dist/http/retry.cjs +1 -1
- package/dist/http/retry.cjs.map +1 -1
- package/dist/http/retry.js +20 -16
- package/dist/http/retry.js.map +1 -1
- package/dist/http/use-describe-api-error.cjs +1 -1
- package/dist/http/use-describe-api-error.cjs.map +1 -1
- package/dist/http/use-describe-api-error.js +2 -2
- package/dist/http/use-describe-api-error.js.map +1 -1
- package/dist/i18n/create-i18n.cjs +1 -1
- package/dist/i18n/create-i18n.cjs.map +1 -1
- package/dist/i18n/create-i18n.js +6 -6
- package/dist/i18n/create-i18n.js.map +1 -1
- package/dist/icons/material-symbols.cjs +1 -1
- package/dist/icons/material-symbols.cjs.map +1 -1
- package/dist/icons/material-symbols.js +136 -5
- package/dist/icons/material-symbols.js.map +1 -1
- package/dist/icons.d.ts +17 -5
- package/dist/offline/create-offline-sync.cjs +1 -1
- package/dist/offline/create-offline-sync.cjs.map +1 -1
- package/dist/offline/create-offline-sync.js +17 -9
- package/dist/offline/create-offline-sync.js.map +1 -1
- package/dist/offline/use-offline-sync.cjs +1 -1
- package/dist/offline/use-offline-sync.cjs.map +1 -1
- package/dist/offline/use-offline-sync.js +7 -8
- package/dist/offline/use-offline-sync.js.map +1 -1
- package/dist/push/use-push-subscription.cjs +1 -1
- package/dist/push/use-push-subscription.cjs.map +1 -1
- package/dist/push/use-push-subscription.js +13 -12
- package/dist/push/use-push-subscription.js.map +1 -1
- package/dist/query/retry-policy.cjs +1 -1
- package/dist/query/retry-policy.cjs.map +1 -1
- package/dist/query/retry-policy.js +3 -3
- package/dist/query/retry-policy.js.map +1 -1
- package/dist/sse/use-event-stream.cjs +1 -1
- package/dist/sse/use-event-stream.cjs.map +1 -1
- package/dist/sse/use-event-stream.js +19 -20
- package/dist/sse/use-event-stream.js.map +1 -1
- package/dist/tabular/use-tabular-predictor.cjs +1 -1
- package/dist/tabular/use-tabular-predictor.cjs.map +1 -1
- package/dist/tabular/use-tabular-predictor.js +20 -17
- package/dist/tabular/use-tabular-predictor.js.map +1 -1
- package/dist/tempest-react-sdk.cjs +1 -1
- package/dist/tempest-react-sdk.d.ts +363 -149
- package/dist/tempest-react-sdk.js +143 -143
- package/dist/theme/ThemeProvider.cjs +1 -1
- package/dist/theme/ThemeProvider.cjs.map +1 -1
- package/dist/theme/ThemeProvider.js +12 -17
- package/dist/theme/ThemeProvider.js.map +1 -1
- package/dist/utils/base64.cjs +2 -0
- package/dist/utils/base64.cjs.map +1 -0
- package/dist/utils/base64.js +16 -0
- package/dist/utils/base64.js.map +1 -0
- package/dist/utils/compare-values.cjs +1 -1
- package/dist/utils/compare-values.cjs.map +1 -1
- package/dist/utils/compare-values.js +4 -3
- package/dist/utils/compare-values.js.map +1 -1
- package/dist/utils/compressed-storage.cjs +1 -1
- package/dist/utils/compressed-storage.cjs.map +1 -1
- package/dist/utils/compressed-storage.js +16 -46
- package/dist/utils/compressed-storage.js.map +1 -1
- package/dist/utils/storage.cjs +1 -1
- package/dist/utils/storage.cjs.map +1 -1
- package/dist/utils/storage.js +37 -17
- package/dist/utils/storage.js.map +1 -1
- package/dist/vision/use-camera-stream.cjs +1 -1
- package/dist/vision/use-camera-stream.cjs.map +1 -1
- package/dist/vision/use-camera-stream.js +34 -33
- package/dist/vision/use-camera-stream.js.map +1 -1
- package/dist/vite/base-url.cjs +2 -0
- package/dist/vite/base-url.cjs.map +1 -0
- package/dist/vite/base-url.js +8 -0
- package/dist/vite/base-url.js.map +1 -0
- package/dist/vite/tempest-pwa-dev-sw.cjs +1 -1
- package/dist/vite/tempest-pwa-dev-sw.cjs.map +1 -1
- package/dist/vite/tempest-pwa-dev-sw.js +54 -29
- package/dist/vite/tempest-pwa-dev-sw.js.map +1 -1
- package/dist/vite/tempest-pwa-manifest.cjs +2 -2
- package/dist/vite/tempest-pwa-manifest.cjs.map +1 -1
- package/dist/vite/tempest-pwa-manifest.js +15 -14
- package/dist/vite/tempest-pwa-manifest.js.map +1 -1
- package/dist/vite.d.ts +2 -2
- package/dist/ws/use-web-socket.cjs +1 -1
- package/dist/ws/use-web-socket.cjs.map +1 -1
- package/dist/ws/use-web-socket.js +40 -42
- package/dist/ws/use-web-socket.js.map +1 -1
- package/package.json +1 -1
|
@@ -806,6 +806,12 @@ export declare type AppBarTone = "surface" | "primary" | "transparent";
|
|
|
806
806
|
* @example
|
|
807
807
|
* const visible = applyFilters(orders, filters);
|
|
808
808
|
*
|
|
809
|
+
* Each filter's values are normalised once, before the scan, rather than inside
|
|
810
|
+
* the per-row predicate: the arity, the `between` ordering and the value array
|
|
811
|
+
* depend only on the filter, so deriving them per row multiplied that work by
|
|
812
|
+
* the row count. `empty`/`notEmpty` ignore their values entirely, which is why
|
|
813
|
+
* the prepared shape does not need to distinguish them.
|
|
814
|
+
*
|
|
809
815
|
* @param items - The full list.
|
|
810
816
|
* @param filters - Applied filters; incomplete ones are ignored.
|
|
811
817
|
* @returns A new array with the rows that satisfy every complete filter.
|
|
@@ -1504,6 +1510,15 @@ export declare interface BarcodeScanResult {
|
|
|
1504
1510
|
* numbers on purpose: a width scaled by the total leaves every bar short in a
|
|
1505
1511
|
* long list, which is when the chart is needed most.
|
|
1506
1512
|
*
|
|
1513
|
+
* Colors come from {@link useChartColors}, the same resolver every chart in the
|
|
1514
|
+
* SDK uses, so a theme that declares fewer series than the eight
|
|
1515
|
+
* `--tempest-chart-*` slots cycles within its own palette. Reading the tokens
|
|
1516
|
+
* through CSS `var()` could not do that: the count lives in
|
|
1517
|
+
* `--tempest-chart-count`, which CSS cannot use as a modulus, so a six-color
|
|
1518
|
+
* brand palette got the SDK's leftover defaults in rows seven and eight — the
|
|
1519
|
+
* exact regression that token exists to prevent. `palette.ts` imports nothing,
|
|
1520
|
+
* so this pulls no chart library into the slice.
|
|
1521
|
+
*
|
|
1507
1522
|
* @example
|
|
1508
1523
|
* <BarList
|
|
1509
1524
|
* items={[{ label: "Free", value: 128 }, { label: "Pro", value: 32 }]}
|
|
@@ -1571,6 +1586,9 @@ export declare type BarListSort = "desc" | "asc" | "none";
|
|
|
1571
1586
|
* `atob` and losing the last byte — is the classic broken-WebAuthn bug, which is
|
|
1572
1587
|
* why the SDK owns it instead of leaving it to each app.
|
|
1573
1588
|
*
|
|
1589
|
+
* This is the WebAuthn-facing name for {@link base64ToBytes}; the codec itself is
|
|
1590
|
+
* shared, so the padding rule has one implementation rather than three.
|
|
1591
|
+
*
|
|
1574
1592
|
* @param value - Base64url text, with or without `=` padding.
|
|
1575
1593
|
* @returns The decoded bytes.
|
|
1576
1594
|
*/
|
|
@@ -1870,6 +1888,9 @@ export declare type ButtonVariant = "primary" | "secondary" | "danger" | "succes
|
|
|
1870
1888
|
/**
|
|
1871
1889
|
* Encode bytes as an unpadded base64url string.
|
|
1872
1890
|
*
|
|
1891
|
+
* Normalises `ArrayBuffer` to a view — which is what the WebAuthn response
|
|
1892
|
+
* fields hand over — and delegates the encoding to {@link bytesToBase64}.
|
|
1893
|
+
*
|
|
1873
1894
|
* @param value - Bytes to encode, as a view or a raw buffer.
|
|
1874
1895
|
* @returns Base64url text, safe to put in JSON and in a URL.
|
|
1875
1896
|
*/
|
|
@@ -2607,33 +2628,17 @@ export declare function compareValues(a: unknown, b: unknown): number;
|
|
|
2607
2628
|
/**
|
|
2608
2629
|
* Typed `localStorage` wrapper that gzips what it writes.
|
|
2609
2630
|
*
|
|
2610
|
-
*
|
|
2611
|
-
*
|
|
2631
|
+
* {@link createJsonStorage} with {@link compressedStorageCodec}, so it is the
|
|
2632
|
+
* same implementation as {@link storage} and genuinely interchangeable with it —
|
|
2633
|
+
* `get`, `set` and `remove`, differing only in how the value is encoded. It used
|
|
2634
|
+
* to be a hand-written copy that had no `remove`, which made that promise false
|
|
2635
|
+
* for anybody who took the docstring at its word.
|
|
2636
|
+
*
|
|
2637
|
+
* When compression itself fails the value is written as plain JSON rather than
|
|
2638
|
+
* dropped: a slightly larger record still loads, an absent one does not. Only a
|
|
2639
|
+
* storage-level failure — quota, blocked storage — loses the write.
|
|
2612
2640
|
*/
|
|
2613
|
-
export declare const compressedStorage:
|
|
2614
|
-
/**
|
|
2615
|
-
* Read and decompress a key.
|
|
2616
|
-
*
|
|
2617
|
-
* @typeParam T - The expected value shape.
|
|
2618
|
-
* @param key - Storage key.
|
|
2619
|
-
* @param fallback - Returned when the key is absent, unreadable, or corrupt.
|
|
2620
|
-
* @returns The stored value, or `fallback`.
|
|
2621
|
-
*/
|
|
2622
|
-
get<T>(key: string, fallback: T): T;
|
|
2623
|
-
/**
|
|
2624
|
-
* Compress and write a key.
|
|
2625
|
-
*
|
|
2626
|
-
* When compression itself fails the value is written as plain JSON rather
|
|
2627
|
-
* than dropped: a slightly larger record still loads, an absent one does
|
|
2628
|
-
* not. Only a storage-level failure — quota, blocked storage — loses the
|
|
2629
|
-
* write.
|
|
2630
|
-
*
|
|
2631
|
-
* @typeParam T - The value being stored.
|
|
2632
|
-
* @param key - Storage key.
|
|
2633
|
-
* @param value - Any JSON-serializable value.
|
|
2634
|
-
*/
|
|
2635
|
-
set<T>(key: string, value: T): void;
|
|
2636
|
-
};
|
|
2641
|
+
export declare const compressedStorage: JsonStorage;
|
|
2637
2642
|
|
|
2638
2643
|
/**
|
|
2639
2644
|
* Codec pair for {@link useLocalStorage}, so a compressed key gets the hook's
|
|
@@ -2642,10 +2647,7 @@ export declare const compressedStorage: {
|
|
|
2642
2647
|
* @example
|
|
2643
2648
|
* const [save, setSave] = useLocalStorage("save", EMPTY_SAVE, compressedStorageCodec);
|
|
2644
2649
|
*/
|
|
2645
|
-
export declare const compressedStorageCodec:
|
|
2646
|
-
serialize: typeof compressToString;
|
|
2647
|
-
deserialize: typeof decompressFromString;
|
|
2648
|
-
};
|
|
2650
|
+
export declare const compressedStorageCodec: StorageCodec;
|
|
2649
2651
|
|
|
2650
2652
|
/**
|
|
2651
2653
|
* Serialize a value to a gzipped, base64 string carrying the format marker.
|
|
@@ -3060,6 +3062,10 @@ export declare interface CreateGrowthBookFeatureFlagsAdapterOptions {
|
|
|
3060
3062
|
* });
|
|
3061
3063
|
* i18n.t("greet", { name: "Mau" }); // "Olá, Mau"
|
|
3062
3064
|
* i18n.plural("alos", 3); // "3 Alôs"
|
|
3065
|
+
*
|
|
3066
|
+
* @example
|
|
3067
|
+
* // A key the catalog does not define, with text to show instead of the key.
|
|
3068
|
+
* i18n.t("cart.empty", undefined, { default: "Seu carrinho está vazio" });
|
|
3063
3069
|
*/
|
|
3064
3070
|
export declare function createI18n(options: CreateI18nOptions): I18n;
|
|
3065
3071
|
|
|
@@ -3120,6 +3126,34 @@ export declare function createInMemoryFlags(options?: InMemoryFlagsOptions): Fea
|
|
|
3120
3126
|
set: (key: string, value: FlagValue) => void;
|
|
3121
3127
|
};
|
|
3122
3128
|
|
|
3129
|
+
/**
|
|
3130
|
+
* Build a typed `localStorage` wrapper around a codec.
|
|
3131
|
+
*
|
|
3132
|
+
* One implementation behind every store the SDK ships, so they cannot drift in
|
|
3133
|
+
* surface. {@link storage} and {@link compressedStorage} are both this function —
|
|
3134
|
+
* before it, the compressed one was a hand-written copy of the same guards and
|
|
3135
|
+
* had no `remove`, while its own docstring promised the two were interchangeable
|
|
3136
|
+
* at the call site. They were not, and the promise failed exactly where somebody
|
|
3137
|
+
* followed it.
|
|
3138
|
+
*
|
|
3139
|
+
* @example
|
|
3140
|
+
* const session = createJsonStorage();
|
|
3141
|
+
* session.set("draft", { title: "Sem título" });
|
|
3142
|
+
*
|
|
3143
|
+
* @example
|
|
3144
|
+
* const packed = createJsonStorage(compressedStorageCodec);
|
|
3145
|
+
*
|
|
3146
|
+
* @param codec - Encoder pair. Defaults to plain JSON.
|
|
3147
|
+
* @returns A store with `get` / `set` / `remove`.
|
|
3148
|
+
*
|
|
3149
|
+
* @tempest-limits empty-catch — every method is best-effort by contract:
|
|
3150
|
+
* `localStorage` throws on quota exhaustion, in Safari private mode, and when a
|
|
3151
|
+
* cross-origin frame has storage blocked. A caller persisting a preference has no
|
|
3152
|
+
* recovery to run and no user-facing message to show, so the write is dropped and
|
|
3153
|
+
* the app keeps the value in memory for the session.
|
|
3154
|
+
*/
|
|
3155
|
+
export declare function createJsonStorage(codec?: StorageCodec): JsonStorage;
|
|
3156
|
+
|
|
3123
3157
|
/**
|
|
3124
3158
|
* Build a [[FeatureFlagsAdapter]] backed by a LaunchDarkly JS client. Apps
|
|
3125
3159
|
* initialise the client themselves (`LDClient.initialize(envKey, ctx)`) and
|
|
@@ -3630,34 +3664,6 @@ export declare interface CreateSentryTelemetryAdapterOptions {
|
|
|
3630
3664
|
breadcrumbCategory?: string;
|
|
3631
3665
|
}
|
|
3632
3666
|
|
|
3633
|
-
/**
|
|
3634
|
-
* A pool of preallocated `<audio>` elements for short sound effects.
|
|
3635
|
-
*
|
|
3636
|
-
* `new Audio(src)` on every play allocates an element and re-enters the network
|
|
3637
|
-
* stack for a file the browser already has, which is the wrong shape for a
|
|
3638
|
-
* sound that fires dozens of times a minute — a UI blip, a hit, a pickup. The
|
|
3639
|
-
* pool allocates once per source and replays.
|
|
3640
|
-
*
|
|
3641
|
-
* This is deliberately not {@link createAudioPlayer}: that handle tracks a
|
|
3642
|
-
* single "current" clip with loop, sink routing and lifecycle callbacks, which
|
|
3643
|
-
* is what background music needs. Effects are the opposite case — many
|
|
3644
|
-
* sources, all short, fire-and-forget, and the only thing that matters is that
|
|
3645
|
-
* firing one is cheap.
|
|
3646
|
-
*
|
|
3647
|
-
* A blocked `play()` is swallowed. Browsers reject playback until the user has
|
|
3648
|
-
* interacted with the page, and a sound effect is by definition not worth
|
|
3649
|
-
* interrupting anything over; call {@link SfxPool.preload} after the first
|
|
3650
|
-
* interaction if you want the pool warm.
|
|
3651
|
-
*
|
|
3652
|
-
* @param options - Master volume, base URL, voices per source and pool size.
|
|
3653
|
-
* @returns The pool handle.
|
|
3654
|
-
*
|
|
3655
|
-
* @example
|
|
3656
|
-
* const sfx = createSfxPool({ volume: 0.6, baseUrl: import.meta.env.BASE_URL });
|
|
3657
|
-
* sfx.preload(["sfx/select.mp3", "sfx/back.mp3"]);
|
|
3658
|
-
*
|
|
3659
|
-
* <button onClick={() => sfx.play("sfx/select.mp3")}>Confirmar</button>
|
|
3660
|
-
*/
|
|
3661
3667
|
export declare function createSfxPool(options?: SfxPoolOptions): SfxPool;
|
|
3662
3668
|
|
|
3663
3669
|
/**
|
|
@@ -4159,6 +4165,64 @@ export declare interface DataProviderOptions {
|
|
|
4159
4165
|
*/
|
|
4160
4166
|
export declare function DataTable<T>({ data, columns, pageSize, searchable, searchKeys, initialSort, rowKey, emptyMessage, onCellChange, editLabels, totalItems, page: controlledPage, onPageChange, manualSort, onSortChange, manualSearch, onSearchChange, loading, className, ...rest }: DataTableProps<T>): JSX.Element;
|
|
4161
4167
|
|
|
4168
|
+
/** Everything a table needs regardless of who owns paging, sorting and searching. */
|
|
4169
|
+
export declare interface DataTableBaseProps<T> extends HTMLAttributes<HTMLDivElement> {
|
|
4170
|
+
/**
|
|
4171
|
+
* The rows to work with.
|
|
4172
|
+
*
|
|
4173
|
+
* By default this is the **full** dataset and sorting, searching and paging
|
|
4174
|
+
* all happen in memory. Pass `totalItems` and it becomes the current page as
|
|
4175
|
+
* the server returned it, with those three delegated to the caller.
|
|
4176
|
+
*/
|
|
4177
|
+
data: T[];
|
|
4178
|
+
/** Column definitions. */
|
|
4179
|
+
columns: DataTableColumn<T>[];
|
|
4180
|
+
/** Rows per page. Default 10. */
|
|
4181
|
+
pageSize?: number;
|
|
4182
|
+
/** Render a search input above the table. Default false. */
|
|
4183
|
+
searchable?: boolean;
|
|
4184
|
+
/**
|
|
4185
|
+
* Keys to match the search term against. When omitted, every column whose
|
|
4186
|
+
* value is a string or number is searched.
|
|
4187
|
+
*/
|
|
4188
|
+
searchKeys?: (keyof T)[];
|
|
4189
|
+
/** Initial sort applied before any header interaction. */
|
|
4190
|
+
initialSort?: DataTableSort<T>;
|
|
4191
|
+
/** Stable key extractor for rows. Defaults to the row index. */
|
|
4192
|
+
rowKey?: (row: T, index: number) => string | number;
|
|
4193
|
+
/** Content shown when no rows match. */
|
|
4194
|
+
emptyMessage?: ReactNode;
|
|
4195
|
+
/**
|
|
4196
|
+
* Persist an accepted cell edit. Return a promise: while it is pending the cell
|
|
4197
|
+
* already shows the new value, and a rejection rolls that back and surfaces the
|
|
4198
|
+
* error in the cell. Without this prop no column is editable.
|
|
4199
|
+
*/
|
|
4200
|
+
onCellChange?: (change: DataTableCellChange<T>) => void | Promise<void>;
|
|
4201
|
+
/** Override the PT-BR copy of the editing affordances. */
|
|
4202
|
+
editLabels?: Partial<DataTableEditLabels>;
|
|
4203
|
+
/**
|
|
4204
|
+
* Searching is the caller's job: typing reports through `onSearchChange` and
|
|
4205
|
+
* the rows are left as they arrived.
|
|
4206
|
+
*
|
|
4207
|
+
* Implied by `totalItems`. Filtering the current page would hide the rows
|
|
4208
|
+
* that do not match *on this page* and show nothing for a term that only
|
|
4209
|
+
* matches on page three — an empty table that looks like "no results".
|
|
4210
|
+
*/
|
|
4211
|
+
manualSearch?: boolean;
|
|
4212
|
+
/** Called with the current search term (debouncing, if any, is the caller's). */
|
|
4213
|
+
onSearchChange?: (term: string) => void;
|
|
4214
|
+
/**
|
|
4215
|
+
* A fetch is in flight.
|
|
4216
|
+
*
|
|
4217
|
+
* With rows already on screen they stay put, dimmed and `aria-busy`, so the
|
|
4218
|
+
* page does not jump under the cursor between pages. With no rows yet it
|
|
4219
|
+
* renders placeholder lines at full height, which is a different statement
|
|
4220
|
+
* from `emptyMessage`: "loading" and "there is nothing" are not the same
|
|
4221
|
+
* screen.
|
|
4222
|
+
*/
|
|
4223
|
+
loading?: boolean;
|
|
4224
|
+
}
|
|
4225
|
+
|
|
4162
4226
|
/** One accepted cell edit, handed to `onCellChange`. */
|
|
4163
4227
|
export declare interface DataTableCellChange<T> {
|
|
4164
4228
|
/** The row as it was before the edit. */
|
|
@@ -4236,40 +4300,24 @@ export declare interface DataTableEditLabels {
|
|
|
4236
4300
|
/** Input types an editable column can use. */
|
|
4237
4301
|
export declare type DataTableEditorType = "text" | "number" | "date" | "email" | "tel" | "url";
|
|
4238
4302
|
|
|
4239
|
-
|
|
4240
|
-
|
|
4241
|
-
|
|
4242
|
-
|
|
4243
|
-
|
|
4244
|
-
|
|
4245
|
-
|
|
4246
|
-
|
|
4247
|
-
|
|
4248
|
-
|
|
4249
|
-
|
|
4250
|
-
/**
|
|
4251
|
-
|
|
4252
|
-
/**
|
|
4253
|
-
|
|
4254
|
-
/**
|
|
4255
|
-
|
|
4256
|
-
|
|
4257
|
-
*/
|
|
4258
|
-
searchKeys?: (keyof T)[];
|
|
4259
|
-
/** Initial sort applied before any header interaction. */
|
|
4260
|
-
initialSort?: DataTableSort<T>;
|
|
4261
|
-
/** Stable key extractor for rows. Defaults to the row index. */
|
|
4262
|
-
rowKey?: (row: T, index: number) => string | number;
|
|
4263
|
-
/** Content shown when no rows match. */
|
|
4264
|
-
emptyMessage?: ReactNode;
|
|
4265
|
-
/**
|
|
4266
|
-
* Persist an accepted cell edit. Return a promise: while it is pending the cell
|
|
4267
|
-
* already shows the new value, and a rejection rolls that back and surfaces the
|
|
4268
|
-
* error in the cell. Without this prop no column is editable.
|
|
4269
|
-
*/
|
|
4270
|
-
onCellChange?: (change: DataTableCellChange<T>) => void | Promise<void>;
|
|
4271
|
-
/** Override the PT-BR copy of the editing affordances. */
|
|
4272
|
-
editLabels?: Partial<DataTableEditLabels>;
|
|
4303
|
+
/**
|
|
4304
|
+
* Paging, as one of the three shapes that actually work.
|
|
4305
|
+
*
|
|
4306
|
+
* These used to be three optional props, so the compiler accepted
|
|
4307
|
+
* `totalItems` with no `page` — a table whose pager moves an internal page while
|
|
4308
|
+
* `data` keeps showing page one. Every prop was optional on its own, so the only
|
|
4309
|
+
* place left to catch it was a `console.warn` in dev, in the browser, with the
|
|
4310
|
+
* component mounted. As a union the same mistake is a build error at the call
|
|
4311
|
+
* site, for free, everywhere.
|
|
4312
|
+
*/
|
|
4313
|
+
export declare type DataTablePagingProps = {
|
|
4314
|
+
/** Not server mode. */
|
|
4315
|
+
totalItems?: never;
|
|
4316
|
+
/** The table owns the page. */
|
|
4317
|
+
page?: never;
|
|
4318
|
+
/** Nothing to report to. */
|
|
4319
|
+
onPageChange?: never;
|
|
4320
|
+
} | {
|
|
4273
4321
|
/**
|
|
4274
4322
|
* Total row count across every page — the `total` of a paginated envelope.
|
|
4275
4323
|
*
|
|
@@ -4279,49 +4327,64 @@ export declare interface DataTableProps<T> extends HTMLAttributes<HTMLDivElement
|
|
|
4279
4327
|
* (see `manualSort` / `manualSearch`, which are implied here). Pair it with
|
|
4280
4328
|
* `page` and `onPageChange`.
|
|
4281
4329
|
*/
|
|
4282
|
-
totalItems?:
|
|
4330
|
+
totalItems?: never;
|
|
4283
4331
|
/** Current page, 1-based. Controlled — required in server mode. */
|
|
4284
|
-
page
|
|
4332
|
+
page: number;
|
|
4285
4333
|
/** Called with the next page. Required whenever `page` is controlled. */
|
|
4286
|
-
onPageChange
|
|
4287
|
-
|
|
4288
|
-
* Sorting is the caller's job: clicking a header reports through
|
|
4289
|
-
* `onSortChange` and the rows are left in the order they arrived.
|
|
4290
|
-
*
|
|
4291
|
-
* Implied by `totalItems`, because sorting the page in memory would sort
|
|
4292
|
-
* *that page only* while the header claims the whole table is ordered.
|
|
4293
|
-
*/
|
|
4294
|
-
manualSort?: boolean;
|
|
4295
|
-
/** Called with the next sort state — `null` when the header cycles back to unsorted. */
|
|
4296
|
-
onSortChange?: (sort: DataTableSort<T> | null) => void;
|
|
4297
|
-
/**
|
|
4298
|
-
* Searching is the caller's job: typing reports through `onSearchChange` and
|
|
4299
|
-
* the rows are left as they arrived.
|
|
4300
|
-
*
|
|
4301
|
-
* Implied by `totalItems`. Filtering the current page would hide the rows
|
|
4302
|
-
* that do not match *on this page* and show nothing for a term that only
|
|
4303
|
-
* matches on page three — an empty table that looks like "no results".
|
|
4304
|
-
*/
|
|
4305
|
-
manualSearch?: boolean;
|
|
4306
|
-
/** Called with the current search term (debouncing, if any, is the caller's). */
|
|
4307
|
-
onSearchChange?: (term: string) => void;
|
|
4334
|
+
onPageChange: (page: number) => void;
|
|
4335
|
+
} | {
|
|
4308
4336
|
/**
|
|
4309
|
-
*
|
|
4337
|
+
* Total row count across every page — the `total` of a paginated envelope.
|
|
4310
4338
|
*
|
|
4311
|
-
*
|
|
4312
|
-
* page
|
|
4313
|
-
*
|
|
4314
|
-
*
|
|
4315
|
-
*
|
|
4339
|
+
* Passing it switches the table to **server mode**: `data` is read as the
|
|
4340
|
+
* current page, the page count comes from this number instead of
|
|
4341
|
+
* `data.length`, and sorting and searching are delegated to the caller
|
|
4342
|
+
* (see `manualSort` / `manualSearch`, which are implied here). `page` and
|
|
4343
|
+
* `onPageChange` come with it — the type says so, because a server-mode
|
|
4344
|
+
* table without them silently shows page one forever.
|
|
4316
4345
|
*/
|
|
4317
|
-
|
|
4318
|
-
|
|
4346
|
+
totalItems: number;
|
|
4347
|
+
/** Current page, 1-based. Controlled, and required in server mode. */
|
|
4348
|
+
page: number;
|
|
4349
|
+
/** Called with the next page. */
|
|
4350
|
+
onPageChange: (page: number) => void;
|
|
4351
|
+
};
|
|
4352
|
+
|
|
4353
|
+
/**
|
|
4354
|
+
* The table's props: the shared half, plus one valid paging shape and one valid
|
|
4355
|
+
* sorting shape.
|
|
4356
|
+
*/
|
|
4357
|
+
export declare type DataTableProps<T> = DataTableBaseProps<T> & DataTablePagingProps & DataTableSortProps<T>;
|
|
4319
4358
|
|
|
4320
4359
|
export declare interface DataTableSort<T> {
|
|
4321
4360
|
key: keyof T;
|
|
4322
4361
|
direction: SortDirection;
|
|
4323
4362
|
}
|
|
4324
4363
|
|
|
4364
|
+
/**
|
|
4365
|
+
* Sorting: delegated, and therefore reported, or neither.
|
|
4366
|
+
*
|
|
4367
|
+
* `manualSort` without `onSortChange` renders a header that moves its arrow and
|
|
4368
|
+
* changes nothing else — the arrow is a lie the compiler can now catch.
|
|
4369
|
+
*/
|
|
4370
|
+
export declare type DataTableSortProps<T> = {
|
|
4371
|
+
/** The table sorts the rows it has. */
|
|
4372
|
+
manualSort?: false;
|
|
4373
|
+
/** Called with the next sort state — `null` when the header cycles back to unsorted. */
|
|
4374
|
+
onSortChange?: (sort: DataTableSort<T> | null) => void;
|
|
4375
|
+
} | {
|
|
4376
|
+
/**
|
|
4377
|
+
* Sorting is the caller's job: clicking a header reports through
|
|
4378
|
+
* `onSortChange` and the rows are left in the order they arrived.
|
|
4379
|
+
*
|
|
4380
|
+
* Implied by `totalItems`, because sorting the page in memory would sort
|
|
4381
|
+
* *that page only* while the header claims the whole table is ordered.
|
|
4382
|
+
*/
|
|
4383
|
+
manualSort: true;
|
|
4384
|
+
/** Where the click goes. Required, since nothing else acts on it. */
|
|
4385
|
+
onSortChange: (sort: DataTableSort<T> | null) => void;
|
|
4386
|
+
};
|
|
4387
|
+
|
|
4325
4388
|
/**
|
|
4326
4389
|
* Thin wrapper around the native `<input type="date">` (or `datetime-local`,
|
|
4327
4390
|
* `time`, `month`). For richer pickers, pair with `react-datepicker` directly
|
|
@@ -5215,15 +5278,55 @@ export declare function filtersFromSearchParams(params: URLSearchParams, fields:
|
|
|
5215
5278
|
* will not answer an `empty` filter, while {@link applyFilters} treats blank
|
|
5216
5279
|
* text as empty.
|
|
5217
5280
|
*
|
|
5281
|
+
* The defaults are that dialect, not a universal truth. A backend that names its
|
|
5282
|
+
* substring column something other than `name`, or that spells its operators
|
|
5283
|
+
* differently, passes `options` — the alternative was an encoder whose special
|
|
5284
|
+
* cases were a wall for anyone not on the Tempest stack.
|
|
5285
|
+
*
|
|
5218
5286
|
* @example
|
|
5219
5287
|
* const params = filtersToQueryParams(filters);
|
|
5220
5288
|
* params.set("page", String(page));
|
|
5221
5289
|
* const data = await api.get(`/orders?${params}`);
|
|
5222
5290
|
*
|
|
5291
|
+
* @example
|
|
5292
|
+
* // A backend whose searchable column is `razao_social` and that spells `ne`
|
|
5293
|
+
* // the Django way.
|
|
5294
|
+
* const params = filtersToQueryParams(filters, {
|
|
5295
|
+
* substringColumns: ["razao_social"],
|
|
5296
|
+
* operatorSuffix: { ne: "__exclude" },
|
|
5297
|
+
* });
|
|
5298
|
+
*
|
|
5223
5299
|
* @param filters - Applied filters; incomplete ones are ignored.
|
|
5300
|
+
* @param options - Dialect overrides. Defaults to the `tempest-fastapi-sdk` one.
|
|
5224
5301
|
* @returns Params ready to append to a request URL.
|
|
5225
5302
|
*/
|
|
5226
|
-
export declare function filtersToQueryParams(filters: readonly Filter[]): URLSearchParams;
|
|
5303
|
+
export declare function filtersToQueryParams(filters: readonly Filter[], options?: FiltersToQueryParamsOptions): URLSearchParams;
|
|
5304
|
+
|
|
5305
|
+
/** Overrides for the backend dialect {@link filtersToQueryParams} encodes into. */
|
|
5306
|
+
export declare interface FiltersToQueryParamsOptions {
|
|
5307
|
+
/**
|
|
5308
|
+
* Columns whose `eq` is emitted as `<column>__iexact` rather than as the bare
|
|
5309
|
+
* column name. Default `["name"]`, which is what `build_filter_condition`
|
|
5310
|
+
* special-cases.
|
|
5311
|
+
*
|
|
5312
|
+
* Pass the columns **your** backend treats that way — `nome`, `titulo`,
|
|
5313
|
+
* `razao_social` — or `[]` when it treats none of them specially and a bare
|
|
5314
|
+
* `eq` should stay bare.
|
|
5315
|
+
*/
|
|
5316
|
+
substringColumns?: readonly string[];
|
|
5317
|
+
/**
|
|
5318
|
+
* Operator suffixes, merged over the `tempest-fastapi-sdk` dialect, so an
|
|
5319
|
+
* override names only the operators that differ.
|
|
5320
|
+
*
|
|
5321
|
+
* @example
|
|
5322
|
+
* // A DRF-style backend
|
|
5323
|
+
* filtersToQueryParams(filters, {
|
|
5324
|
+
* substringColumns: [],
|
|
5325
|
+
* operatorSuffix: { contains: "__icontains", ne: "__exclude" },
|
|
5326
|
+
* });
|
|
5327
|
+
*/
|
|
5328
|
+
operatorSuffix?: Partial<Record<FilterOperator, string>>;
|
|
5329
|
+
}
|
|
5227
5330
|
|
|
5228
5331
|
/**
|
|
5229
5332
|
* Serialize filters into URL search params.
|
|
@@ -5914,14 +6017,16 @@ export declare interface I18n {
|
|
|
5914
6017
|
fallbackLocale: string | null;
|
|
5915
6018
|
/**
|
|
5916
6019
|
* Translate `key`, interpolating `{name}` placeholders from `params`.
|
|
5917
|
-
* Falls back to the configured fallback locale, then to
|
|
6020
|
+
* Falls back to the configured fallback locale, then to `options.default`,
|
|
6021
|
+
* then to the key itself.
|
|
5918
6022
|
*/
|
|
5919
|
-
t: (key: string, params?: InterpolationValues) => string;
|
|
6023
|
+
t: (key: string, params?: InterpolationValues, options?: TranslateOptions) => string;
|
|
5920
6024
|
/**
|
|
5921
6025
|
* Plural-aware translation. Tries `${key}_one` for `count === 1` and
|
|
5922
6026
|
* `${key}_other` otherwise, with `{count}` available for interpolation.
|
|
6027
|
+
* Falls back to `options.default`, then to the key itself.
|
|
5923
6028
|
*/
|
|
5924
|
-
plural: (key: string, count: number, params?: InterpolationValues) => string;
|
|
6029
|
+
plural: (key: string, count: number, params?: InterpolationValues, options?: TranslateOptions) => string;
|
|
5925
6030
|
/** Format a number using `Intl.NumberFormat` on the active locale. */
|
|
5926
6031
|
formatNumber: (value: number, options?: Intl.NumberFormatOptions) => string;
|
|
5927
6032
|
/** Format a Date using `Intl.DateTimeFormat` on the active locale. */
|
|
@@ -6563,6 +6668,31 @@ export declare function isPlatformAuthenticatorAvailable(): Promise<boolean>;
|
|
|
6563
6668
|
*/
|
|
6564
6669
|
export declare function isPushSupported(): boolean;
|
|
6565
6670
|
|
|
6671
|
+
/**
|
|
6672
|
+
* Whether an HTTP status describes a condition a replay can plausibly fix.
|
|
6673
|
+
*
|
|
6674
|
+
* The single owner of that decision. It used to be spelled out in three places —
|
|
6675
|
+
* the client's own policy, the react-query default and the bare `retry()` helper
|
|
6676
|
+
* — and they had already drifted: the query default was missing `425`, so the
|
|
6677
|
+
* same `425 Too Early` was replayed through `createApiClient({ retry: true })`
|
|
6678
|
+
* and not replayed through `useQuery`. Same app, same error, two behaviours, and
|
|
6679
|
+
* no test caught it because each file asserted against its own copy.
|
|
6680
|
+
*
|
|
6681
|
+
* Deliberately about the status and nothing else. Whether a *non*-API error is
|
|
6682
|
+
* worth replaying, and whether the request's method may be replayed at all, are
|
|
6683
|
+
* the caller's calls: {@link createApiClient} refuses a non-idempotent method,
|
|
6684
|
+
* while a bare `retry()` has no method to inspect.
|
|
6685
|
+
*
|
|
6686
|
+
* @example
|
|
6687
|
+
* await api.get("/report", {
|
|
6688
|
+
* retry: { shouldRetry: (error) => isApiError(error) && isRetriableStatus(error.status) },
|
|
6689
|
+
* });
|
|
6690
|
+
*
|
|
6691
|
+
* @param status - The HTTP status, where `0` means the request never landed.
|
|
6692
|
+
* @returns Whether a retry is worth attempting.
|
|
6693
|
+
*/
|
|
6694
|
+
export declare function isRetriableStatus(status: number): boolean;
|
|
6695
|
+
|
|
6566
6696
|
/** Whether `getDisplayMedia` is reachable at all. */
|
|
6567
6697
|
export declare function isScreenCaptureSupported(): boolean;
|
|
6568
6698
|
|
|
@@ -6599,6 +6729,33 @@ export declare function isValidLongitude(value: number): boolean;
|
|
|
6599
6729
|
/** Whether `MediaRecorder` exists and can produce at least one video container. */
|
|
6600
6730
|
export declare function isVideoRecordingSupported(): boolean;
|
|
6601
6731
|
|
|
6732
|
+
/** The surface every store built by {@link createJsonStorage} exposes. */
|
|
6733
|
+
export declare interface JsonStorage {
|
|
6734
|
+
/**
|
|
6735
|
+
* Read and decode a key.
|
|
6736
|
+
*
|
|
6737
|
+
* @typeParam T - The expected value shape.
|
|
6738
|
+
* @param key - Storage key.
|
|
6739
|
+
* @param fallback - Returned when the key is absent, unreadable, or corrupt.
|
|
6740
|
+
* @returns The stored value, or `fallback`.
|
|
6741
|
+
*/
|
|
6742
|
+
get<T>(key: string, fallback: T): T;
|
|
6743
|
+
/**
|
|
6744
|
+
* Encode and write a key.
|
|
6745
|
+
*
|
|
6746
|
+
* @typeParam T - The value being stored.
|
|
6747
|
+
* @param key - Storage key.
|
|
6748
|
+
* @param value - Any value the codec can represent.
|
|
6749
|
+
*/
|
|
6750
|
+
set<T>(key: string, value: T): void;
|
|
6751
|
+
/**
|
|
6752
|
+
* Delete a key.
|
|
6753
|
+
*
|
|
6754
|
+
* @param key - Storage key.
|
|
6755
|
+
*/
|
|
6756
|
+
remove(key: string): void;
|
|
6757
|
+
}
|
|
6758
|
+
|
|
6602
6759
|
/**
|
|
6603
6760
|
* Kanban board: columns of cards, reorderable within a column and movable across
|
|
6604
6761
|
* columns, by pointer **or** keyboard.
|
|
@@ -9703,7 +9860,12 @@ export declare interface RetryOptions {
|
|
|
9703
9860
|
respectRetryAfter?: boolean;
|
|
9704
9861
|
/**
|
|
9705
9862
|
* Return false to stop retrying for a specific error.
|
|
9706
|
-
*
|
|
9863
|
+
*
|
|
9864
|
+
* Default: replay anything that is not a recognisable API error — a
|
|
9865
|
+
* transport failure has no status to judge — and, for one that is, only the
|
|
9866
|
+
* statuses {@link isRetriableStatus} accepts. A `403` on an admin-only
|
|
9867
|
+
* endpoint and a `404` for a deleted record are the server's final answer;
|
|
9868
|
+
* repeating them spends the caller's time to show the same error twice.
|
|
9707
9869
|
*/
|
|
9708
9870
|
shouldRetry?: (error: unknown, attempt: number) => boolean;
|
|
9709
9871
|
/** Called before each retry with the upcoming delay. */
|
|
@@ -10221,6 +10383,11 @@ export declare interface ShareResult {
|
|
|
10221
10383
|
* of another round trip. A network failure or a 5xx is a different thing: it may
|
|
10222
10384
|
* well succeed on the next try, so those keep the previous behaviour.
|
|
10223
10385
|
*
|
|
10386
|
+
* The status list is {@link isRetriableStatus}, shared with the client's own
|
|
10387
|
+
* policy. It used to be a second copy here, and the copy was missing `425` — so
|
|
10388
|
+
* a `425 Too Early` was replayed by `createApiClient({ retry: true })` and not
|
|
10389
|
+
* by a query, for the same error in the same app.
|
|
10390
|
+
*
|
|
10224
10391
|
* @example
|
|
10225
10392
|
* new QueryClient({ defaultOptions: { queries: { retry: shouldRetryQuery } } });
|
|
10226
10393
|
*
|
|
@@ -10810,20 +10977,18 @@ export declare interface StepperProps {
|
|
|
10810
10977
|
export declare function stopAudio(): void;
|
|
10811
10978
|
|
|
10812
10979
|
/**
|
|
10813
|
-
* Typed wrapper around `localStorage` that JSON-encodes values and
|
|
10814
|
-
*
|
|
10815
|
-
*
|
|
10816
|
-
* @tempest-limits empty-catch — every method here is best-effort by contract:
|
|
10817
|
-
* `localStorage` throws on quota exhaustion, in Safari private mode, and when a
|
|
10818
|
-
* cross-origin frame has storage blocked. A caller persisting a preference has no
|
|
10819
|
-
* recovery to run and no user-facing message to show, so the write is dropped and
|
|
10820
|
-
* the app keeps the value in memory for the session.
|
|
10980
|
+
* Typed wrapper around `localStorage` that JSON-encodes values and silently
|
|
10981
|
+
* handles environments where storage is unavailable (SSR, private mode).
|
|
10821
10982
|
*/
|
|
10822
|
-
export declare const storage:
|
|
10823
|
-
|
|
10824
|
-
|
|
10825
|
-
|
|
10826
|
-
|
|
10983
|
+
export declare const storage: JsonStorage;
|
|
10984
|
+
|
|
10985
|
+
/** How a {@link createJsonStorage} store turns values into text and back. */
|
|
10986
|
+
export declare interface StorageCodec {
|
|
10987
|
+
/** Encode a value for storage. */
|
|
10988
|
+
serialize: <T>(value: T) => string;
|
|
10989
|
+
/** Decode a stored string. */
|
|
10990
|
+
deserialize: <T>(raw: string) => T;
|
|
10991
|
+
}
|
|
10827
10992
|
|
|
10828
10993
|
/** Raw usage/quota reading from the Storage API, in bytes. */
|
|
10829
10994
|
declare interface StorageEstimate_2 {
|
|
@@ -10863,6 +11028,16 @@ export declare interface SyncRunSummary {
|
|
|
10863
11028
|
succeeded: number;
|
|
10864
11029
|
/** Entries that failed and stay queued for the next run. */
|
|
10865
11030
|
failed: number;
|
|
11031
|
+
/**
|
|
11032
|
+
* Entries left untried because an earlier entry for the **same record**
|
|
11033
|
+
* failed this run.
|
|
11034
|
+
*
|
|
11035
|
+
* They stay queued and are attempted next run, in order. Counted apart from
|
|
11036
|
+
* `failed` because they were never sent: reporting them as failures would
|
|
11037
|
+
* blame the server for a decision this engine made, and folding them in would
|
|
11038
|
+
* make `succeeded + failed` stop accounting for the queue.
|
|
11039
|
+
*/
|
|
11040
|
+
deferred: number;
|
|
10866
11041
|
/** Total wall-clock milliseconds the run took. */
|
|
10867
11042
|
durationMs: number;
|
|
10868
11043
|
/** `true` when the run was skipped because the device was offline. */
|
|
@@ -11768,6 +11943,23 @@ export declare interface TransferProps extends Omit<HTMLAttributes<HTMLDivElemen
|
|
|
11768
11943
|
/** Which pane an operation is about. */
|
|
11769
11944
|
export declare type TransferSide = "source" | "target";
|
|
11770
11945
|
|
|
11946
|
+
/** Per-call options for {@link I18n.t} and {@link I18n.plural}. */
|
|
11947
|
+
export declare interface TranslateOptions {
|
|
11948
|
+
/**
|
|
11949
|
+
* Text to use when the catalog defines neither the key nor its fallback.
|
|
11950
|
+
*
|
|
11951
|
+
* Without this, a miss returns the key, and a caller that wants its own text
|
|
11952
|
+
* instead has to *detect* the miss — which from the outside means comparing
|
|
11953
|
+
* the result against the key it just passed in. That heuristic is wrong for a
|
|
11954
|
+
* catalog that legitimately maps a key to itself, and it is what every
|
|
11955
|
+
* translatable string the SDK ships would otherwise have to copy.
|
|
11956
|
+
*
|
|
11957
|
+
* Interpolated like any other message, so a default carries `{placeholders}`
|
|
11958
|
+
* too and is not second-class.
|
|
11959
|
+
*/
|
|
11960
|
+
default?: string;
|
|
11961
|
+
}
|
|
11962
|
+
|
|
11771
11963
|
/**
|
|
11772
11964
|
* Estimated travel between two coordinates. Mirrors the `TravelEstimate`
|
|
11773
11965
|
* schema from `tempest-fastapi-sdk` (`geo/schemas.py`), snake_case preserved so
|
|
@@ -12426,7 +12618,8 @@ export declare interface UseClipboardResult {
|
|
|
12426
12618
|
* which a counter held in state cannot do.
|
|
12427
12619
|
*
|
|
12428
12620
|
* The interval stops once it reaches zero instead of ticking forever behind a
|
|
12429
|
-
* clamp
|
|
12621
|
+
* clamp — `useInterval` pauses on a `null` delay, so reaching zero is what tears
|
|
12622
|
+
* the timer down.
|
|
12430
12623
|
*
|
|
12431
12624
|
* @param durationMs - Length of the window.
|
|
12432
12625
|
* @param startedAt - Epoch ms the window opened (`Date.now()` when it started).
|
|
@@ -12886,6 +13079,17 @@ export declare interface UseKeyboardShortcutOptions {
|
|
|
12886
13079
|
* want to *call* — it hands back a callable with a stable identity, rather than
|
|
12887
13080
|
* making every call site reach through `.current`.
|
|
12888
13081
|
*
|
|
13082
|
+
* **List the returned ref in your effect's dependencies.** It is a stable object,
|
|
13083
|
+
* so the effect never re-runs because of it, but `react-hooks/exhaustive-deps`
|
|
13084
|
+
* cannot prove that for a custom hook the way it does for a bare `useRef`.
|
|
13085
|
+
* Listing it lets the rule verify the array instead of taking an omission on
|
|
13086
|
+
* trust.
|
|
13087
|
+
*
|
|
13088
|
+
* **Not for holding the previous value.** The write happens during render, so
|
|
13089
|
+
* `.current` is already the current value by the time any effect reads it. A hook
|
|
13090
|
+
* that wants the value from the *previous* commit — `usePrevious` — needs the
|
|
13091
|
+
* effect-based write, and swapping it for this would make it return the present.
|
|
13092
|
+
*
|
|
12889
13093
|
* @typeParam T - The tracked value.
|
|
12890
13094
|
* @param value - The value to track. Written on every render.
|
|
12891
13095
|
* @returns A stable ref whose `current` holds the latest `value`.
|
|
@@ -14098,7 +14302,9 @@ export declare interface UseSetResult<T> {
|
|
|
14098
14302
|
* `volume` is tracked separately: changing it calls `setVolume` on the existing
|
|
14099
14303
|
* pool rather than rebuilding it, which would throw away every clip the user
|
|
14100
14304
|
* has already downloaded — exactly the cost the pool exists to avoid.
|
|
14101
|
-
* `baseUrl`, `voices` and `maxSources` are read once, at creation.
|
|
14305
|
+
* `baseUrl`, `voices` and `maxSources` are read once, at creation. The options
|
|
14306
|
+
* object is forwarded whole rather than rebuilt field by field, so a field added
|
|
14307
|
+
* to {@link SfxPoolOptions} does not silently stop reaching the pool.
|
|
14102
14308
|
*
|
|
14103
14309
|
* @param options - Passed through to {@link createSfxPool}.
|
|
14104
14310
|
* @returns A stable pool handle.
|
|
@@ -14316,12 +14522,15 @@ export declare interface UseSpeechRecognitionResult {
|
|
|
14316
14522
|
* `callback` argument. Use to break dependency cycles in effects without
|
|
14317
14523
|
* triggering re-runs when the callback identity changes.
|
|
14318
14524
|
*
|
|
14319
|
-
*
|
|
14320
|
-
* would satisfy the React Compiler rules
|
|
14321
|
-
*
|
|
14322
|
-
*
|
|
14323
|
-
* subtle staleness here is worse than the rule violation. Prefer React's
|
|
14525
|
+
* Built on {@link useLatestRef}, which owns the render-time assignment and the
|
|
14526
|
+
* reason it is not an effect: an effect would satisfy the React Compiler rules
|
|
14527
|
+
* but open a one-commit staleness window. What this adds is the callable with a
|
|
14528
|
+
* stable identity, so callers do not reach through `.current`. Prefer React's
|
|
14324
14529
|
* `useEffectEvent` once it ships as stable.
|
|
14530
|
+
*
|
|
14531
|
+
* The ref is listed as a dependency because it is one — a stable object across
|
|
14532
|
+
* renders, so the returned identity never changes. Listing it is what lets the
|
|
14533
|
+
* exhaustive-deps rule verify that instead of taking an empty array on trust.
|
|
14325
14534
|
*/
|
|
14326
14535
|
export declare function useStableCallback<TArgs extends unknown[], TReturn>(callback: (...args: TArgs) => TReturn): (...args: TArgs) => TReturn;
|
|
14327
14536
|
|
|
@@ -14472,6 +14681,11 @@ export declare function useTranslate(): I18nContextValue["t"];
|
|
|
14472
14681
|
* Always give the reader a way out: an animation that cannot be skipped is a
|
|
14473
14682
|
* tax on anyone re-reading or moving fast, which is what `skip` is for.
|
|
14474
14683
|
*
|
|
14684
|
+
* How far the reveal got is derived rather than stored: a `speedMs` of `0` reads
|
|
14685
|
+
* as "all of it" without a state write, and `useInterval` pausing on a `null`
|
|
14686
|
+
* delay is what stops the timer at the end. Both used to need an effect that
|
|
14687
|
+
* cleared its own interval from inside a state updater.
|
|
14688
|
+
*
|
|
14475
14689
|
* @param text - The full string to reveal. Nullish is treated as empty.
|
|
14476
14690
|
* @param speedMs - Delay between characters. `0` or less renders instantly,
|
|
14477
14691
|
* which is the hook-safe way to honour `prefers-reduced-motion`.
|