@terreno/mcp 57.20.0 → 57.21.0

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/getLoginFeedback.md

@@ -0,0 +1,52 @@
+> **getLoginFeedback**(`__namedParameters`): [`LoginFeedback`](../interfaces/LoginFeedback.md)
+
+Maps a failure to a notice or an error line.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### attemptedMethod?
+
+`string`
+
+Display name of the method that just failed, such as "Google".
+
+#### failure
+
+[`LoginFailure`](../interfaces/LoginFailure.md) \| `undefined`
+
+#### hasAccounts?
+
+`boolean` = `false`
+
+Whether the screen is offering continue-as accounts. Changes the cancelled copy.
+
+#### mode?
+
+[`BetterAuthAccountLinkingMode`](../type-aliases/BetterAuthAccountLinkingMode.md)
+
+#### originalMethod?
+
+`string`
+
+Display name of the method this device used last, such as "GitHub".
+
+#### originalMethodId?
+
+`string`
+
+Id of that method (`"email"`, `"github"`), so the notice action can focus it.
+
+## Returns
+
+[`LoginFeedback`](../interfaces/LoginFeedback.md)
+
+## Example
+
+```typescript
+const {notice, error} = getLoginFeedback({
+  failure: {code: "account_not_linked", source: "url"},
+  mode: methods?.accountLinking.mode,
+});
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/getRealtimeSocket.md

@@ -0,0 +1,11 @@
+> **getRealtimeSocket**(): `Socket`\<`DefaultEventsMap`, `DefaultEventsMap`\> \| `null`
+
+Get the current socket instance (may be null).
+
+## Returns
+
+`Socket`\<`DefaultEventsMap`, `DefaultEventsMap`\> \| `null`
+
+## Deprecated
+
+Removed in Terreno 58 with `setRealtimeSocket`.

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/getTokenSource.md

@@ -0,0 +1,7 @@
+> **getTokenSource**(): `AuthProvider` \| `undefined`
+
+Returns the registered token source, or `undefined` when the app has not registered one.
+
+## Returns
+
+`AuthProvider` \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/installTerrenoDevConsoleLogger.md

@@ -0,0 +1,22 @@
+> **installTerrenoDevConsoleLogger**(`args?`): `void`
+
+Batches dev console errors to the backend's `POST /__terreno/browser-logs` route,
+defaulting the target to this package's resolved `baseUrl`.
+
+## Parameters
+
+### args?
+
+#### baseUrl?
+
+`string`
+
+## Returns
+
+`void`
+
+## Deprecated
+
+Moved to `@terreno/syncdb`. Use
+`import {installTerrenoDevConsoleLogger} from "@terreno/syncdb"` and call it with
+`{baseUrl}`. This re-export stays for the `@terreno/rtk` deprecation window only.

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/isJwtTokenSource.md

@@ -0,0 +1,13 @@
+> **isJwtTokenSource**(`source`): `boolean`
+
+True when rtk should run the legacy JWT path: no source registered, or the JWT one.
+
+## Parameters
+
+### source
+
+`AuthProvider` \| `undefined`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/isNetworkFetchError.md

@@ -0,0 +1,14 @@
+> **isNetworkFetchError**(`source`): `boolean`
+
+True when a rejected RTK Query action failed due to a network/transport error,
+not an auth or application-level FETCH_ERROR from emptyApi.
+
+## Parameters
+
+### source
+
+`unknown`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/linkSocialWithHandoff.md

@@ -0,0 +1,58 @@
+> **linkSocialWithHandoff**(`__namedParameters`): `Promise`\<[`LinkSocialWithHandoffResult`](../interfaces/LinkSocialWithHandoffResult.md)\>
+
+Links a social or generic OAuth provider to the signed-in user.
+
+On web in bearer mode (`createBetterAuthClient({webAuth: "bearer"})`), a `POST /link-social`
+fetch from another site cannot set Better Auth's OAuth state cookie on the API's origin. So
+this posts `{provider, callbackURL, errorCallbackURL}` to the server's
+`POST {basePath}/oauth-handoff/link-intent` with the bearer, then submits the single-use token
+it returns in a hidden form (method POST) to `startURL`, which redirects the page to the
+provider. The provider sends the page back to `callbackURL`, with no token: linking creates no
+session. A failure after the form comes back to `errorCallbackURL` with `?error=`.
+
+Both URLs are resolved against the current page and may be any page on one of the server's
+`oauthHandoff.webOrigins` that its `trustedOrigins` allows. `oauthHandoff.callbackPaths` do not
+apply, since no token travels on a link's return. `errorCallbackURL` defaults to
+`callbackURL`. The page must not be served with `Referrer-Policy: no-referrer` or
+`same-origin`: the form's `Origin` header is then `null`, and the server refuses the start.
+
+In cookie mode and on native it calls `client.linkSocial` as before.
+
+Resolves `{error: null}` once the browser is on its way (or `linkSocial` succeeded), and
+`{error}` when the server refused, such as 403 `LINKING_DISABLED` when linking is off. It never
+submits the form after a refusal.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### callbackURL
+
+`string`
+
+#### client
+
+[`BetterAuthLinkClient`](../type-aliases/BetterAuthLinkClient.md)
+
+#### errorCallbackURL?
+
+`string`
+
+#### provider
+
+`string`
+
+## Returns
+
+`Promise`\<[`LinkSocialWithHandoffResult`](../interfaces/LinkSocialWithHandoffResult.md)\>
+
+## Example
+
+```typescript
+const {error} = await linkSocialWithHandoff({
+  callbackURL: "/settings/security",
+  client: authClient,
+  errorCallbackURL: "/settings/security",
+  provider: "google",
+});
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/maskEmail.md

@@ -0,0 +1,17 @@
+> **maskEmail**(`email`): `string` \| `undefined`
+
+Masks an email for display on a shared device: the first character of the local part and of
+the domain stay, the rest is hidden, and only the top-level domain is shown in full. Any
+subdomains fold into the hidden part, and a one-letter local part looks like a long one.
+`josh@mail.flourish.health` becomes `j***@m***.health`. Idempotent. Returns undefined for
+anything that is not an email.
+
+## Parameters
+
+### email
+
+`string`
+
+## Returns
+
+`string` \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/realtimeDocument.md

@@ -0,0 +1,41 @@
+> **realtimeDocument**(`collection`, `options?`): (`arg`, `api`) => `Promise`\<`void`\>
+
+Factory that returns an `onCacheEntryAdded` callback for real-time
+updates on a **single document**.
+
+Subscribes to `document:{collection}:{id}` room on the server. When a sync
+event arrives for this document, patches the RTK Query cache in-place.
+
+## Parameters
+
+### collection
+
+`string`
+
+The collection tag (e.g. "todos")
+
+### options?
+
+`RealtimeDocumentOptions`
+
+Optional configuration
+
+## Returns
+
+(`arg`, `api`) => `Promise`\<`void`\>
+
+## Deprecated
+
+Removed in Terreno 58. Use `@terreno/syncdb` (`useEntity`) instead.
+
+## Example
+
+```typescript
+const api = generatedApi.enhanceEndpoints({
+  endpoints: {
+    getTodosIdRead: {
+      onCacheEntryAdded: realtimeDocument("todos"),
+    },
+  },
+});
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/realtimeList.md

@@ -0,0 +1,47 @@
+> **realtimeList**(`collection`, `options?`): (`arg`, `api`) => `Promise`\<`void`\>
+
+Factory that returns an `onCacheEntryAdded` callback for real-time
+updates on a **list of documents**, optionally filtered by query.
+
+If the query argument contains filter fields (after stripping pagination params),
+subscribes to `query:{queryId}` so the server only sends matching events.
+Otherwise subscribes to `model:{collection}` for all events.
+
+Handles:
+- **create** → prepends new document to the list
+- **update** → patches existing document in-place, or adds it if newly matching
+- **delete** → removes document from the list
+
+## Parameters
+
+### collection
+
+`string`
+
+The collection tag (e.g. "todos")
+
+### options?
+
+`RealtimeListOptions`
+
+Optional configuration
+
+## Returns
+
+(`arg`, `api`) => `Promise`\<`void`\>
+
+## Deprecated
+
+Removed in Terreno 58. Use `@terreno/syncdb` (`useQuery` / `useEntityIds`) instead.
+
+## Example
+
+```typescript
+const api = generatedApi.enhanceEndpoints({
+  endpoints: {
+    getTodosList: {
+      onCacheEntryAdded: realtimeList("todos"),
+    },
+  },
+});
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/recordRememberedSignIn.md

@@ -0,0 +1,29 @@
+> **recordRememberedSignIn**(`__namedParameters`): `Promise`\<`void`\>
+
+Records a sign-in in the remembered-accounts store. The controller calls it after every
+sign-in it finishes; call it yourself after a sign-in finished elsewhere, such as an app's own
+two-factor screen (`method: "email"`).
+
+## Parameters
+
+### \_\_namedParameters
+
+#### method
+
+`string`
+
+#### rememberIdentity?
+
+`boolean` = `true`
+
+#### store
+
+[`RememberedAccountsStore`](../interfaces/RememberedAccountsStore.md)
+
+#### user
+
+[`LoginUser`](../interfaces/LoginUser.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/registerTerrenoDevStore.md

@@ -0,0 +1,14 @@
+> **registerTerrenoDevStore**(`store`): `void`
+
+Exposes the Redux store on `globalThis.__TERRENO_STORE__` in development so
+`terreno-mcp-local` can run `get_client_state` against the real app state.
+
+## Parameters
+
+### store
+
+`Store`\<`Record`\<`string`, `unknown`\>\>
+
+## Returns
+
+`void`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/selectBetterAuthIsSigningOut.md

@@ -0,0 +1,13 @@
+> **selectBetterAuthIsSigningOut**(`state`): `boolean`
+
+Selects whether a `logout()` is waiting for the server (the session is still in the state).
+
+## Parameters
+
+### state
+
+`RootState`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/selectLastUserId.md

@@ -0,0 +1,15 @@
+> **selectLastUserId**(`state`): `string` \| `undefined`
+
+Last user id a non-JWT token source confirmed; undefined when unknown or signed out.
+
+## Parameters
+
+### state
+
+#### offline
+
+[`OfflineState`](../interfaces/OfflineState.md)
+
+## Returns
+
+`string` \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/setRealtimeSocket.md

@@ -0,0 +1,32 @@
+> **setRealtimeSocket**(`socket`): `void`
+
+Provide the Socket.io client instance used by `realtimeDocument` and `realtimeList`.
+
+Call this once after your socket connects (e.g. inside `useSocketConnection`'s `onConnect`
+callback, or in a `useEffect` that watches the socket ref).
+
+## Parameters
+
+### socket
+
+`Socket`\<`DefaultEventsMap`, `DefaultEventsMap`\> \| `null`
+
+## Returns
+
+`void`
+
+## Deprecated
+
+Removed in Terreno 58. Use `@terreno/syncdb` for collection sync.
+`useSocketConnection` remains for feature flags and other sockets.
+
+## Example
+
+```typescript
+const { socket } = useSocketConnection({ ... });
+
+useEffect(() => {
+  setRealtimeSocket(socket);
+  return () => setRealtimeSocket(null);
+}, [socket]);
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/setTokenSource.md

@@ -0,0 +1,16 @@
+> **setTokenSource**(`source`): `void`
+
+Registers the token source every `@terreno/rtk` consumer reads by default. Pass the same
+`AuthProvider` the app builds for syncdb (for example
+`betterAuthAdapter(betterAuthClient)`), once at startup. Until an app registers one, rtk uses
+the legacy JWT tokens in storage. Pass `undefined` to go back to that default.
+
+## Parameters
+
+### source
+
+`AuthProvider` \| `undefined`
+
+## Returns
+
+`void`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/signInSocialWithHandoff.md

@@ -0,0 +1,51 @@
+> **signInSocialWithHandoff**(`__namedParameters`): `void`
+
+Starts a social or generic OAuth sign-in for a web client in bearer mode. It stores a random
+nonce in sessionStorage and navigates the whole page to the server's
+`GET {basePath}/oauth-handoff/start`, with `handoff=<nonce>` added to `callbackURL` (and to
+`errorCallbackURL`). A top-level navigation keeps Better Auth's OAuth state cookie
+first-party on the API's origin. After the provider, the page comes back to `callbackURL`
+with `#ott=<token>`, and `completeBetterAuthOAuthHandoff` exchanges it for the bearer.
+
+`callbackURL` defaults to `/` on the current origin (pass the full path for an app served
+under a sub-path). It is resolved against the current page, and its path must be one of the
+server's `oauthHandoff.callbackPaths` (default `["/"]`) on one of its
+`oauthHandoff.webOrigins`, or the server answers 400. `errorCallbackURL` defaults to
+`callbackURL`; a failed start or callback comes back there with `?error=`. It is always sent,
+because without one Better Auth sends callback errors to its own error page on the API.
+
+Throws on native, in cookie mode, for a client `createBetterAuthClient` did not make, and
+when sessionStorage cannot hold the nonce. Use `authClient.signIn.social` in those cases.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### callbackURL?
+
+`string` = `"/"`
+
+#### client
+
+[`BetterAuthHandoffClient`](../type-aliases/BetterAuthHandoffClient.md)
+
+#### errorCallbackURL?
+
+`string`
+
+#### provider
+
+`string`
+
+## Returns
+
+`void`
+
+## Example
+
+```typescript
+<SocialLoginButton
+  provider="google"
+  onPress={() => signInSocialWithHandoff({client: authClient, provider: "google"})}
+/>
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/toLoginAccountOptions.md

@@ -0,0 +1,13 @@
+> **toLoginAccountOptions**(`accounts`): `LoginAccountOption`[]
+
+Maps remembered accounts to `@terreno/ui` LoginScreen `rememberedAccounts`, keyed by userId.
+
+## Parameters
+
+### accounts
+
+[`RememberedAccount`](../interfaces/RememberedAccount.md)[]
+
+## Returns
+
+`LoginAccountOption`[]

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/useAccountSecurity.md

@@ -0,0 +1,21 @@
+> **useAccountSecurity**(`__namedParameters`): [`AccountSecurity`](../interfaces/AccountSecurity.md)
+
+Drives an account security screen from a Better Auth client. See "Drop-in security screen" in
+docs/how-to/configure-better-auth.md.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`UseAccountSecurityOptions`](../interfaces/UseAccountSecurityOptions.md)
+
+## Returns
+
+[`AccountSecurity`](../interfaces/AccountSecurity.md)
+
+## Example
+
+```tsx
+const security = useAccountSecurity({client: authClient, callbackURL: "/security"});
+return <AccountSecurityScreen {...security.screenProps} />;
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/useAuthMethods.md

@@ -0,0 +1,24 @@
+> **useAuthMethods**(`authClient`, `__namedParameters?`): [`UseAuthMethodsResult`](../interfaces/UseAuthMethodsResult.md)
+
+Loads the server's enabled sign-in methods once per client.
+
+## Parameters
+
+### authClient
+
+[`AuthMethodsClient`](../interfaces/AuthMethodsClient.md)
+
+### \_\_namedParameters?
+
+[`UseAuthMethodsOptions`](../interfaces/UseAuthMethodsOptions.md) = `{}`
+
+## Returns
+
+[`UseAuthMethodsResult`](../interfaces/UseAuthMethodsResult.md)
+
+## Example
+
+```tsx
+const {methods, isLoading} = useAuthMethods(authClient);
+const providers = isLoading ? [] : (methods?.providers ?? []);
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/useFeatureFlags.md

@@ -0,0 +1,15 @@
+> **useFeatureFlags**(`api`, `basePathOrOptions?`): `UseFeatureFlagsResult`
+
+## Parameters
+
+### api
+
+[`FlagsApi`](../type-aliases/FlagsApi.md)
+
+### basePathOrOptions?
+
+`string` \| [`UseFeatureFlagsOptions`](../interfaces/UseFeatureFlagsOptions.md)
+
+## Returns
+
+`UseFeatureFlagsResult`

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/useLoginController.md

@@ -0,0 +1,28 @@
+> **useLoginController**(`__namedParameters`): [`LoginController`](../interfaces/LoginController.md)
+
+Drives a login screen from a Better Auth client. See "Drop-in login screen" in
+docs/how-to/configure-better-auth.md.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`UseLoginControllerOptions`](../interfaces/UseLoginControllerOptions.md)
+
+## Returns
+
+[`LoginController`](../interfaces/LoginController.md)
+
+## Example
+
+```tsx
+const login = useLoginController({
+  client: authClient,
+  onSignedIn: async () => {
+    await betterAuth.syncSession(dispatch);
+    router.replace("/");
+  },
+  rememberedAccounts,
+});
+return <LoginScreen fields={fields} {...login.screenProps} />;
+```

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/useRememberedAccounts.md

@@ -0,0 +1,13 @@
+> **useRememberedAccounts**(`store`): [`UseRememberedAccountsResult`](../interfaces/UseRememberedAccountsResult.md)
+
+Subscribes a component to a remembered-accounts store.
+
+## Parameters
+
+### store
+
+[`RememberedAccountsStore`](../interfaces/RememberedAccountsStore.md)
+
+## Returns
+
+[`UseRememberedAccountsResult`](../interfaces/UseRememberedAccountsResult.md)

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/useTerrenoChat.md

@@ -0,0 +1,18 @@
+> **useTerrenoChat**(`options?`): `UseChatHelpers`\<`UIMessage`\<`unknown`, `UIDataTypes`, `UITools`\>\>
+
+Hook that wraps @ai-sdk/react's useChat() pre-configured for a Terreno MCP backend.
+Automatically injects the Bearer token from the token source (see `tokenSource`).
+
+The backend needs a chat endpoint (e.g. POST /api/chat) that accepts messages
+and returns a streaming response. The MCP tools are available server-side via
+`getMCPTools()` from `@terreno/ai`.
+
+## Parameters
+
+### options?
+
+[`UseTerrenoChatOptions`](../interfaces/UseTerrenoChatOptions.md) = `{}`
+
+## Returns
+
+`UseChatHelpers`\<`UIMessage`\<`unknown`, `UIDataTypes`, `UITools`\>\>

package/src/docs/versioned/57.20.0/reference/generated/rtk/functions/useTerrenoFeatureFlags.md

@@ -0,0 +1,19 @@
+> **useTerrenoFeatureFlags**(`api`, `options?`): [`UseTerrenoFeatureFlagsResult`](../interfaces/UseTerrenoFeatureFlagsResult.md)
+
+Wires Terreno's bulk `/flagConfiguration` fetch into OpenFeature's
+TypedInMemoryProvider for the given domain. Prefer OpenFeature React
+hooks (`useBooleanFlagValue`, etc.) as children of `<OpenFeatureProvider>`.
+
+## Parameters
+
+### api
+
+[`FlagsApi`](../type-aliases/FlagsApi.md)
+
+### options?
+
+[`UseTerrenoFeatureFlagsOptions`](../interfaces/UseTerrenoFeatureFlagsOptions.md)
+
+## Returns
+
+[`UseTerrenoFeatureFlagsResult`](../interfaces/UseTerrenoFeatureFlagsResult.md)

package/src/docs/versioned/57.20.0/reference/generated/rtk/interfaces/AccountSecurity.md

@@ -0,0 +1,35 @@
+## Properties
+
+### methods
+
+> **methods**: [`BetterAuthMethods`](BetterAuthMethods.md) \| `undefined`
+
+The server's methods; undefined while they load or after an error.
+
+***
+
+### refetch
+
+> **refetch**: () => `Promise`\<`void`\>
+
+Reloads every section.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### screenProps
+
+> **screenProps**: [`AccountSecurityControllerScreenProps`](../type-aliases/AccountSecurityControllerScreenProps.md)
+
+Spread into `AccountSecurityScreen`. A card's props are undefined when it is hidden.
+
+***
+
+### user
+
+> **user**: [`AccountSecurityUser`](AccountSecurityUser.md) \| `undefined`
+
+The signed-in user, once the session loads.