@terreno/mcp 0.21.0

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/Config.md

@@ -0,0 +1,244 @@
+> `const` **Config**: `object`
+
+## Type Declaration
+
+### clearOverrides
+
+> **clearOverrides**: () => `void`
+
+Clears every override. Call from afterEach in tests.
+
+#### Returns
+
+`void`
+
+### clearRegistryForTesting
+
+> **clearRegistryForTesting**: () => `void`
+
+Removes every registered key. Intended for tests.
+
+#### Returns
+
+`void`
+
+### get
+
+> **get**: (`key`) => `string` \| `undefined` = `getString`
+
+Returns the configured string value for `key`, applying the resolution
+order documented at the top of this file. Returns `undefined` if no
+source supplies a value and no default was registered.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+### getBoolean
+
+> **getBoolean**: (`key`) => `boolean`
+
+Returns true iff the string value equals "true" (case-insensitive). Mirrors
+the existing `process.env.X === "true"` idiom.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`boolean`
+
+### getDefault
+
+> **getDefault**: (`key`) => `string` \| `undefined`
+
+Returns the registered default (if any) for `key`.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+### getJSON
+
+> **getJSON**: \<`T`\>(`key`) => `T` \| `undefined`
+
+Parses a JSON-encoded config value. Returns undefined if unset; throws on
+malformed JSON so misconfiguration fails loud at the call site rather than
+producing silent runtime errors later.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`T` \| `undefined`
+
+### getNumber
+
+> **getNumber**: (`key`) => `number` \| `undefined`
+
+Returns the configured value as a number. Throws if a value is present but
+not finite — silent NaN propagation has bitten apps before.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`number` \| `undefined`
+
+### getRegisteredKeys
+
+> **getRegisteredKeys**: () => `string`[]
+
+Returns the registered keys, sorted. Used by the admin UI.
+
+#### Returns
+
+`string`[]
+
+### getRegistration
+
+> **getRegistration**: (`key`) => [`ConfigRegistration`](../interfaces/ConfigRegistration.md) \| `undefined`
+
+Returns the registration metadata for `key`, including secret/description.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+[`ConfigRegistration`](../interfaces/ConfigRegistration.md) \| `undefined`
+
+### isRegistered
+
+> **isRegistered**: (`key`) => `boolean`
+
+Returns true if `key` was registered.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`boolean`
+
+### refresh
+
+> **refresh**: () => `Promise`\<`void`\>
+
+Reloads the in-memory cache by invoking the registered env loader. No-op
+(clears cache) if no loader has been registered.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+### register
+
+> **register**: (`key`, `registration`) => `void`
+
+Registers a configuration key, its default, and metadata. Re-registration
+of the same key throws so duplicates surface at boot.
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### registration?
+
+[`ConfigRegistration`](../interfaces/ConfigRegistration.md) = `{}`
+
+#### Returns
+
+`void`
+
+### setCachedEnv
+
+> **setCachedEnv**: (`env`) => `void`
+
+Replaces the cache directly. Intended for the envConfigurationPlugin and tests.
+
+#### Parameters
+
+##### env
+
+`Record`\<`string`, `string`\> \| `null`
+
+#### Returns
+
+`void`
+
+### setEnvLoader
+
+> **setEnvLoader**: (`loader`) => `void`
+
+Registers a loader that returns the env map (typically backed by an
+admin-editable Mongoose document). Called once at app startup before
+the first `Config.refresh()`.
+
+#### Parameters
+
+##### loader
+
+(() => `Promise`\<`Record`\<`string`, `string`\>\>) \| `null`
+
+#### Returns
+
+`void`
+
+### setOverride
+
+> **setOverride**: (`key`, `value`) => `void`
+
+Sets an in-process override for `key`. Highest precedence — wins over
+the cached env map. Intended for tests and bootstrap helpers.
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### value
+
+`string` \| `undefined`
+
+#### Returns
+
+`void`

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/ConsentForm.md

@@ -0,0 +1 @@
+> `const` **ConsentForm**: [`ConsentFormModel`](../interfaces/ConsentFormModel.md)

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/ConsentResponse.md

@@ -0,0 +1 @@
+> `const` **ConsentResponse**: [`ConsentResponseModel`](../interfaces/ConsentResponseModel.md)

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/MAX_DOCUMENT_SUBSCRIPTIONS.md

@@ -0,0 +1 @@
+> `const` **MAX\_DOCUMENT\_SUBSCRIPTIONS**: `500` = `500`

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/MAX_MODEL_SUBSCRIPTIONS.md

@@ -0,0 +1,4 @@
+> `const` **MAX\_MODEL\_SUBSCRIPTIONS**: `50` = `50`
+
+Caps on per-socket subscriptions. Prevents a malicious or buggy client from
+exhausting server memory by opening unbounded subscriptions.

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/MAX_QUERY_SUBSCRIPTIONS.md

@@ -0,0 +1 @@
+> `const` **MAX\_QUERY\_SUBSCRIPTIONS**: `100` = `100`

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/Permissions.md

@@ -0,0 +1,109 @@
+> `const` **Permissions**: `object`
+
+## Type Declaration
+
+### IsAdmin
+
+> **IsAdmin**: (`_method`, `user?`) => `boolean`
+
+#### Parameters
+
+##### \_method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+#### Returns
+
+`boolean`
+
+### IsAny
+
+> **IsAny**: () => `boolean`
+
+#### Returns
+
+`boolean`
+
+### IsAuthenticated
+
+> **IsAuthenticated**: (`_method`, `user?`) => `boolean`
+
+#### Parameters
+
+##### \_method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+#### Returns
+
+`boolean`
+
+### IsAuthenticatedOrReadOnly
+
+> **IsAuthenticatedOrReadOnly**: (`method`, `user?`) => `boolean`
+
+#### Parameters
+
+##### method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+#### Returns
+
+`boolean`
+
+### IsOwner
+
+> **IsOwner**: (`_method`, `user?`, `obj?`) => `boolean`
+
+#### Parameters
+
+##### \_method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+##### obj?
+
+`unknown`
+
+#### Returns
+
+`boolean`
+
+### IsOwnerOrReadOnly
+
+> **IsOwnerOrReadOnly**: (`method`, `user?`, `obj?`) => `boolean`
+
+#### Parameters
+
+##### method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+##### obj?
+
+`unknown`
+
+#### Returns
+
+`boolean`

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/REQUEST_CONTEXT_ATTRIBUTE_NAMES.md

@@ -0,0 +1,35 @@
+> `const` **REQUEST\_CONTEXT\_ATTRIBUTE\_NAMES**: `object`
+
+## Type Declaration
+
+### jobId
+
+> `readonly` **jobId**: `"x-job-id"` = `JOB_ID_HEADER`
+
+### requestId
+
+> `readonly` **requestId**: `"x-request-id"` = `"x-request-id"`
+
+### sessionId
+
+> `readonly` **sessionId**: `"x-session-id"` = `SESSION_ID_HEADER`
+
+### spanId
+
+> `readonly` **spanId**: `"x-span-id"` = `SPAN_ID_HEADER`
+
+### traceId
+
+> `readonly` **traceId**: `"x-trace-id"` = `TRACE_ID_HEADER`
+
+### traceParent
+
+> `readonly` **traceParent**: `"traceparent"` = `TRACE_PARENT_HEADER`
+
+### traceSampled
+
+> `readonly` **traceSampled**: `"x-trace-sampled"` = `TRACE_SAMPLED_HEADER`
+
+### userId
+
+> `readonly` **userId**: `"x-user-id"` = `USER_ID_HEADER`

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/VersionConfig.md

@@ -0,0 +1 @@
+> `const` **VersionConfig**: [`VersionConfigModel`](../interfaces/VersionConfigModel.md)

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/gooseRestRouter.md

@@ -0,0 +1,85 @@
+> `const` **gooseRestRouter**: \{\<`T`\>(`path`, `model`, `options`): [`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md); \<`T`\>(`model`, `options`): `Router`; \} = `modelRouter`
+
+## Call Signature
+
+> \<`T`\>(`path`, `model`, `options`): [`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md)
+
+Create a set of CRUD routes given a Mongoose model and configuration options.
+
+When called with a path as the first argument, returns a `ModelRouterRegistration` that can be
+passed to `TerrenoApp.register()`.
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### path
+
+`string`
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+### Returns
+
+[`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md)
+
+### Example
+
+```ts
+// Traditional usage (returns express.Router):
+router.use("/todos", modelRouter(Todo, options));
+
+// Registration usage (returns ModelRouterRegistration):
+const todoRouter = modelRouter("/todos", Todo, options);
+app.register(todoRouter);
+```
+
+## Call Signature
+
+> \<`T`\>(`model`, `options`): `Router`
+
+Create a set of CRUD routes given a Mongoose model and configuration options.
+
+When called with a path as the first argument, returns a `ModelRouterRegistration` that can be
+passed to `TerrenoApp.register()`.
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+### Returns
+
+`Router`
+
+### Example
+
+```ts
+// Traditional usage (returns express.Router):
+router.use("/todos", modelRouter(Todo, options));
+
+// Registration usage (returns ModelRouterRegistration):
+const todoRouter = modelRouter("/todos", Todo, options);
+app.register(todoRouter);
+```

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/logger.md

@@ -0,0 +1,89 @@
+> `const` **logger**: `object`
+
+## Type Declaration
+
+### catch
+
+> **catch**: (`e`) => `void`
+
+#### Parameters
+
+##### e
+
+`unknown`
+
+#### Returns
+
+`void`
+
+### debug
+
+> **debug**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+### error
+
+> **error**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+### info
+
+> **info**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+### warn
+
+> **warn**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`

package/dist/docs/versioned/0.19.0/reference/generated/api/variables/winstonLogger.md

@@ -0,0 +1 @@
+> `const` **winstonLogger**: `Logger`

package/dist/docs/versioned/0.19.0/reference/generated/rtk/README.md

@@ -0,0 +1,120 @@
+## Interfaces
+
+- [BaseUrls](interfaces/BaseUrls.md)
+- [BetterAuthClientConfig](interfaces/BetterAuthClientConfig.md)
+- [BetterAuthClientInterface](interfaces/BetterAuthClientInterface.md)
+- [BetterAuthSession](interfaces/BetterAuthSession.md)
+- [BetterAuthSessionData](interfaces/BetterAuthSessionData.md)
+- [BetterAuthState](interfaces/BetterAuthState.md)
+- [BetterAuthUser](interfaces/BetterAuthUser.md)
+- [ConflictRecord](interfaces/ConflictRecord.md)
+- [EmailSignupRequest](interfaces/EmailSignupRequest.md)
+- [ExpoConstantsShape](interfaces/ExpoConstantsShape.md)
+- [GenerateBetterAuthSliceConfig](interfaces/GenerateBetterAuthSliceConfig.md)
+- [GoogleLoginRequest](interfaces/GoogleLoginRequest.md)
+- [ListResponse](interfaces/ListResponse.md)
+- [OfflineMiddlewareConfig](interfaces/OfflineMiddlewareConfig.md)
+- [OfflineState](interfaces/OfflineState.md)
+- [OfflineStatus](interfaces/OfflineStatus.md)
+- [QueuedMutation](interfaces/QueuedMutation.md)
+- [RealtimeEvent](interfaces/RealtimeEvent.md)
+- [ResetPasswordRequest](interfaces/ResetPasswordRequest.md)
+- [ServerStatusOptions](interfaces/ServerStatusOptions.md)
+- [SocketConnection](interfaces/SocketConnection.md)
+- [StorageAdapter](interfaces/StorageAdapter.md)
+- [UseFeatureFlagsOptions](interfaces/UseFeatureFlagsOptions.md)
+- [UserResponse](interfaces/UserResponse.md)
+- [UseSocketConnectionOptions](interfaces/UseSocketConnectionOptions.md)
+- [VersionCheckResponse](interfaces/VersionCheckResponse.md)
+
+## Type Aliases
+
+- [BetterAuthClient](type-aliases/BetterAuthClient.md)
+- [BetterAuthOAuthProvider](type-aliases/BetterAuthOAuthProvider.md)
+- [BetterAuthSlice](type-aliases/BetterAuthSlice.md)
+- [EmailLoginRequest](type-aliases/EmailLoginRequest.md)
+- [RootState](type-aliases/RootState.md)
+- [ServerStatus](type-aliases/ServerStatus.md)
+
+## Variables
+
+- [addConflict](variables/addConflict.md)
+- [AUTH\_DEBUG](variables/AUTH_DEBUG.md)
+- [baseTasksUrl](variables/baseTasksUrl.md)
+- [baseUrl](variables/baseUrl.md)
+- [baseWebsocketsUrl](variables/baseWebsocketsUrl.md)
+- [clearConflicts](variables/clearConflicts.md)
+- [clearQueue](variables/clearQueue.md)
+- [dequeue](variables/dequeue.md)
+- [dismissConflict](variables/dismissConflict.md)
+- [emptySplitApi](variables/emptySplitApi.md)
+- [enqueue](variables/enqueue.md)
+- [IsWeb](variables/IsWeb.md)
+- [LOGOUT\_ACTION\_TYPE](variables/LOGOUT_ACTION_TYPE.md)
+- [offlineReducer](variables/offlineReducer.md)
+- [offlineSlice](variables/offlineSlice.md)
+- [SAME\_ORIGIN\_SENTINEL](variables/SAME_ORIGIN_SENTINEL.md)
+- [selectUndismissedConflicts](variables/selectUndismissedConflicts.md)
+- [setOnlineStatus](variables/setOnlineStatus.md)
+- [setSyncing](variables/setSyncing.md)
+- [staggeredBaseQuery](variables/staggeredBaseQuery.md)
+- [TOKEN\_REFRESHED\_SUCCESS](variables/TOKEN_REFRESHED_SUCCESS.md)
+- [useGetVersionCheckQuery](variables/useGetVersionCheckQuery.md)
+- [useLazyGetVersionCheckQuery](variables/useLazyGetVersionCheckQuery.md)
+
+## Functions
+
+- [buildOptimisticCreateItem](functions/buildOptimisticCreateItem.md)
+- [configureOfflineMutationEndpoints](functions/configureOfflineMutationEndpoints.md)
+- [createBetterAuthClient](functions/createBetterAuthClient.md)
+- [createOfflineMiddleware](functions/createOfflineMiddleware.md)
+- [createSessionApi](functions/createSessionApi.md)
+- [createStorageAdapter](functions/createStorageAdapter.md)
+- [generateAuthSlice](functions/generateAuthSlice.md)
+- [generateBetterAuthSlice](functions/generateBetterAuthSlice.md)
+- [generateProfileEndpoints](functions/generateProfileEndpoints.md)
+- [generateTags](functions/generateTags.md)
+- [getAuthToken](functions/getAuthToken.md)
+- [getBaseQuery](functions/getBaseQuery.md)
+- [getFriendlyExpirationInfo](functions/getFriendlyExpirationInfo.md)
+- [getRealtimeSocket](functions/getRealtimeSocket.md)
+- [getTokenExpirationTimes](functions/getTokenExpirationTimes.md)
+- [isNetworkFetchError](functions/isNetworkFetchError.md)
+- [isWebsocketsDebugEnabled](functions/isWebsocketsDebugEnabled.md)
+- [logAuth](functions/logAuth.md)
+- [logSocket](functions/logSocket.md)
+- [populateId](functions/populateId.md)
+- [realtimeDocument](functions/realtimeDocument.md)
+- [realtimeList](functions/realtimeList.md)
+- [refreshAuthToken](functions/refreshAuthToken.md)
+- [resolveBaseUrls](functions/resolveBaseUrls.md)
+- [resolveFeatureFlagsOptions](functions/resolveFeatureFlagsOptions.md)
+- [selectBetterAuthError](functions/selectBetterAuthError.md)
+- [selectBetterAuthIsAuthenticated](functions/selectBetterAuthIsAuthenticated.md)
+- [selectBetterAuthIsLoading](functions/selectBetterAuthIsLoading.md)
+- [selectBetterAuthState](functions/selectBetterAuthState.md)
+- [selectBetterAuthUser](functions/selectBetterAuthUser.md)
+- [selectBetterAuthUserId](functions/selectBetterAuthUserId.md)
+- [selectConflicts](functions/selectConflicts.md)
+- [selectCurrentUserId](functions/selectCurrentUserId.md)
+- [selectIsAuthenticating](functions/selectIsAuthenticating.md)
+- [selectIsOnline](functions/selectIsOnline.md)
+- [selectIsOnlineSafe](functions/selectIsOnlineSafe.md)
+- [selectIsSyncing](functions/selectIsSyncing.md)
+- [selectLastTokenRefreshTimestamp](functions/selectLastTokenRefreshTimestamp.md)
+- [selectOfflineQueue](functions/selectOfflineQueue.md)
+- [selectQueueLength](functions/selectQueueLength.md)
+- [setRealtimeDebug](functions/setRealtimeDebug.md)
+- [setRealtimeSocket](functions/setRealtimeSocket.md)
+- [shouldDeferOfflineMutation](functions/shouldDeferOfflineMutation.md)
+- [shouldReplayQueuedMutation](functions/shouldReplayQueuedMutation.md)
+- [shouldShowStillThereModal](functions/shouldShowStillThereModal.md)
+- [useFeatureFlags](functions/useFeatureFlags.md)
+- [useOfflineStatus](functions/useOfflineStatus.md)
+- [useRealtimeDebug](functions/useRealtimeDebug.md)
+- [useSelectCurrentUserId](functions/useSelectCurrentUserId.md)
+- [useSelectIsAuthenticating](functions/useSelectIsAuthenticating.md)
+- [useServerStatus](functions/useServerStatus.md)
+- [useSocketConnection](functions/useSocketConnection.md)
+- [useSyncConnection](functions/useSyncConnection.md)
+- [useUpgradeCheck](functions/useUpgradeCheck.md)