@basictech/react 0.11.0-beta.3 → 0.12.0-beta.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 +14 -15
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ runtime validation live in `@basictech/schema`.
|
|
|
13
13
|
| `@basictech/core` | Framework-neutral client, data model, sync, files, shares, and public types |
|
|
14
14
|
| `@basictech/schema/define` | Dependency-light schema definition and TypeScript inference |
|
|
15
15
|
|
|
16
|
-
This
|
|
16
|
+
This SDK requires React 18 or newer (`useSyncExternalStore`) and declares Node.js 24 or newer in
|
|
17
17
|
its package metadata.
|
|
18
18
|
|
|
19
19
|
## Install
|
|
@@ -26,17 +26,17 @@ npm install @basictech/react @basictech/schema
|
|
|
26
26
|
|
|
27
27
|
React is a peer dependency and must already be installed by your application.
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Auth update guide
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Upgrade the packages you use together from npm's default `latest` channel:
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
|
-
npm install @basictech/react@
|
|
34
|
+
npm install @basictech/react@latest @basictech/schema@latest
|
|
35
35
|
# If you import core directly, update that dependency too:
|
|
36
|
-
npm install @basictech/core@
|
|
36
|
+
npm install @basictech/core@latest
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Keep the public packages on matching
|
|
39
|
+
Keep the public packages on matching versions. No browser storage reset or persisted-profile
|
|
40
40
|
migration is required. Check your lockfile for the resolved version; this guide does not imply
|
|
41
41
|
that an older installed beta contains the update.
|
|
42
42
|
|
|
@@ -237,7 +237,7 @@ client.
|
|
|
237
237
|
| `fetch` | `typeof globalThis.fetch` | `globalThis.fetch` | Inject a fetch implementation, test transport, or instrumented wrapper. |
|
|
238
238
|
| `WebSocketImpl` | `new (url: string \| URL) => WebSocket` | `globalThis.WebSocket` | Inject WebSocket support in a non-browser runtime or tests. |
|
|
239
239
|
| `kv` | `KeyValueStorage` | `localStorage`, then memory | Replace profile registry, cached identity/repo state, and other durable key/value state. |
|
|
240
|
-
| `tokenStore` | `TokenStore` | `BrowserTokenStore` over the default local store | Supply a secure credential facility. See [Token storage](#token-storage
|
|
240
|
+
| `tokenStore` | `TokenStore` | `BrowserTokenStore` over the default local store | Supply a secure credential facility. See [Token storage](#token-storage). |
|
|
241
241
|
| `sessionStorage` | `KeyValueStorage` | `sessionStorage`, then memory | Replace per-tab active-profile selection and one-time PKCE state storage. |
|
|
242
242
|
| `replicaStore` | `ReplicaStoreFactory` | Dexie/IndexedDB, then memory | Provide another durable replica store or an explicit memory store for tests. |
|
|
243
243
|
| `navigate` | `(url: string) => void \| Promise<void>` | `location.assign(url)` | Integrate OAuth navigation with a browser shell or test harness. |
|
|
@@ -280,12 +280,12 @@ The package also exports the adapters for explicit composition: `BrowserKeyValue
|
|
|
280
280
|
`browserCurrentUrl`, and `browserReplaceUrl`. Most applications only need `createBasic`, which
|
|
281
281
|
installs them.
|
|
282
282
|
|
|
283
|
-
### Token storage
|
|
283
|
+
### Token storage
|
|
284
284
|
|
|
285
285
|
The default `BrowserTokenStore` stores each profile's refresh token in `localStorage` and keeps its
|
|
286
|
-
access token only in memory. This
|
|
286
|
+
access token only in memory. This retains the documented **CS-CLIENT-002 beta conformance exception**:
|
|
287
287
|
`localStorage` is not a secure credential facility. Inject `tokenStore` when the host provides a
|
|
288
|
-
secure store.
|
|
288
|
+
secure store. Publication on `latest` does not change this storage policy or add revocation cleanup.
|
|
289
289
|
|
|
290
290
|
## Provider
|
|
291
291
|
|
|
@@ -1179,13 +1179,12 @@ for the lower-level model.
|
|
|
1179
1179
|
|
|
1180
1180
|
## Next.js, migration, and status
|
|
1181
1181
|
|
|
1182
|
-
- `@basictech/nextjs`
|
|
1183
|
-
Its
|
|
1184
|
-
Client Components should import `@basictech/react` directly.
|
|
1182
|
+
- `@basictech/nextjs/client` provides this React API behind a Next.js Client Component boundary.
|
|
1183
|
+
Its root exports types only. It does not provide middleware or server authentication.
|
|
1185
1184
|
- Migrating from 0.10 requires deliberate call-site changes; there is no compatibility layer. Read
|
|
1186
1185
|
[Migrating to Basic SDK 0.11](https://github.com/basicdb/basic-server/blob/dev/docs/MIGRATING_TO_0.11.md).
|
|
1187
|
-
- 0.11
|
|
1188
|
-
rather than assuming it matches the repository workspace.
|
|
1186
|
+
- The coordinated non-prerelease 0.11 SDK uses npm's `latest` channel. Check the installed
|
|
1187
|
+
version rather than assuming it matches the repository workspace or an older `beta` tag.
|
|
1189
1188
|
|
|
1190
1189
|
## License
|
|
1191
1190
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@basictech/react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.12.0-beta.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "React integration for the Basic repo-era SDK",
|
|
6
6
|
"license": "MIT",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"sideEffects": false,
|
|
39
39
|
"author": "",
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@basictech/core": "0.
|
|
41
|
+
"@basictech/core": "0.12.0-beta.0",
|
|
42
42
|
"dexie": "^4.2.1"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|