@terreno/mcp 57.16.2 → 57.18.0

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/stripeSignature.md

@@ -0,0 +1,13 @@
+> **stripeSignature**(`options`): (`req`) => `boolean`
+
+Verifies Stripe `Stripe-Signature` (`t=` / `v1=`) against HMAC-SHA256 of `${t}.${rawBody}`.
+
+## Parameters
+
+### options
+
+[`StripeSignatureOptions`](../interfaces/StripeSignatureOptions.md)
+
+## Returns
+
+(`req`) => `boolean`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/syncBetterAuthUser.md

@@ -0,0 +1,23 @@
+> **syncBetterAuthUser**(`userModel`, `betterAuthUser`, `oauthProvider?`, `options?`): `Promise`\<`MutableUserDoc`\>
+
+## Parameters
+
+### userModel
+
+[`UserModel`](../interfaces/UserModel.md)
+
+### betterAuthUser
+
+[`BetterAuthUser`](../interfaces/BetterAuthUser.md)
+
+### oauthProvider?
+
+`string`
+
+### options?
+
+[`SyncBetterAuthUserOptions`](../interfaces/SyncBetterAuthUserOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<`MutableUserDoc`\>

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/syncMutationRateLimitWindowCount.md

@@ -0,0 +1,7 @@
+> **syncMutationRateLimitWindowCount**(): `number`
+
+Number of retained per-user windows — lets tests assert eviction actually happens.
+
+## Returns
+
+`number`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/syncPlugin.md

@@ -0,0 +1,11 @@
+> **syncPlugin**(`schema`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/syncRoomForStream.md

@@ -0,0 +1,13 @@
+> **syncRoomForStream**(`stream`): `string`
+
+The Socket.io room a sync stream fans out through.
+
+## Parameters
+
+### stream
+
+`string`
+
+## Returns
+
+`string`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/trackSyncIndexCreation.md

@@ -0,0 +1,13 @@
+> **trackSyncIndexCreation**(`task`): `void`
+
+Queue extra index work (tests and SyncApp bookkeeping models).
+
+## Parameters
+
+### task
+
+`IndexCreationTask`
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/twilioSignature.md

@@ -0,0 +1,13 @@
+> **twilioSignature**(`options`): (`req`) => `boolean`
+
+Verifies Twilio `X-Twilio-Signature` (HMAC-SHA1 of callback URL + sorted POST fields).
+
+## Parameters
+
+### options
+
+[`TwilioSignatureOptions`](../interfaces/TwilioSignatureOptions.md)
+
+## Returns
+
+(`req`) => `boolean`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/unionPermissionSets.md

@@ -0,0 +1,11 @@
+> **unionPermissionSets**(...`sets`): [`PermissionSet`](../type-aliases/PermissionSet.md)
+
+## Parameters
+
+### sets
+
+...[`PermissionSet`](../type-aliases/PermissionSet.md)[]
+
+## Returns
+
+[`PermissionSet`](../type-aliases/PermissionSet.md)

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/updateMCPRegistryOptions.md

@@ -0,0 +1,15 @@
+> **updateMCPRegistryOptions**(`modelName`, `options`): `void`
+
+## Parameters
+
+### modelName
+
+`string`
+
+### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`unknown`\>
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/updateRealtimeRegistryOptions.md

@@ -0,0 +1,15 @@
+> **updateRealtimeRegistryOptions**(`routePath`, `options`): `void`
+
+## Parameters
+
+### routePath
+
+`string`
+
+### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`unknown`\>
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/updateSyncRegistryOptions.md

@@ -0,0 +1,15 @@
+> **updateSyncRegistryOptions**(`routePath`, `options`): `void`
+
+## Parameters
+
+### routePath
+
+`string`
+
+### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`unknown`\>
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/validateActionRequest.md

@@ -0,0 +1,35 @@
+> **validateActionRequest**\<`TBody`, `TQuery`\>(`__namedParameters`): `object`
+
+## Type Parameters
+
+### TBody
+
+`TBody`
+
+### TQuery
+
+`TQuery`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### action
+
+[`BaseActionConfig`](../interfaces/BaseActionConfig.md)\<`TBody`, `TQuery`, `unknown`\>
+
+#### req
+
+`Request`
+
+## Returns
+
+`object`
+
+### body
+
+> **body**: `TBody` \| `undefined`
+
+### query
+
+> **query**: `TQuery` \| `undefined`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/validatePermissionSet.md

@@ -0,0 +1,15 @@
+> **validatePermissionSet**(`permissions`, `statements`): `void`
+
+## Parameters
+
+### permissions
+
+[`PermissionSet`](../type-aliases/PermissionSet.md)
+
+### statements
+
+`Record`\<`string`, readonly `string`[]\>
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/validateSyncMutationBatch.md

@@ -0,0 +1,18 @@
+> **validateSyncMutationBatch**(`mutations`): [`SyncBatchValidationOutcome`](../type-aliases/SyncBatchValidationOutcome.md)
+
+Up-front validation shared by both batch transports (HTTP and socket): reject an
+oversized batch or one with intra-batch duplicate mutationIds before anything is
+applied. On failure, returns a single-element `results` array carrying a
+`validation` nack for the offending mutation (or an empty-batch guard) — mirroring
+the shape callers expect from `applySyncMutationBatch`, but produced without
+touching the idempotency ledger since nothing was attempted.
+
+## Parameters
+
+### mutations
+
+[`SyncMutateRequest`](../interfaces/SyncMutateRequest.md)[]
+
+## Returns
+
+[`SyncBatchValidationOutcome`](../type-aliases/SyncBatchValidationOutcome.md)

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/verifyBetterAuthCredentialPassword.md

@@ -0,0 +1,25 @@
+> **verifyBetterAuthCredentialPassword**(`auth`, `user`, `password`): `Promise`\<[`BetterAuthPasswordCheck`](../type-aliases/BetterAuthPasswordCheck.md)\>
+
+Check `password` against the Better Auth credential account linked to an app user through
+`betterAuthId`. Returns "no-password" when the user has no linked Better Auth user or that user
+has no credential password (for example a social-only account).
+
+## Parameters
+
+### auth
+
+`Auth`
+
+### user
+
+#### betterAuthId?
+
+`string`
+
+### password
+
+`string`
+
+## Returns
+
+`Promise`\<[`BetterAuthPasswordCheck`](../type-aliases/BetterAuthPasswordCheck.md)\>

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/warnOnSyncScopesWithoutUserModel.md

@@ -0,0 +1,13 @@
+> **warnOnSyncScopesWithoutUserModel**(`__namedParameters`): `string`[]
+
+## Parameters
+
+### \_\_namedParameters
+
+#### userModel?
+
+`unknown`
+
+## Returns
+
+`string`[]

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/withAdminWindowMutationRequestContext.md

@@ -0,0 +1,19 @@
+> **withAdminWindowMutationRequestContext**(`__namedParameters`): `Request`
+
+Ensure `req.params.id` is set for AdminApp update/delete hooks (User admin-flag gates).
+
+## Parameters
+
+### \_\_namedParameters
+
+#### mutation
+
+[`SyncMutateRequest`](../interfaces/SyncMutateRequest.md)
+
+#### req
+
+`Request`
+
+## Returns
+
+`Request`

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/withMigrationLock.md

@@ -0,0 +1,17 @@
+> **withMigrationLock**\<`T`\>(`__namedParameters`): `Promise`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+[`WithMigrationLockOptions`](../interfaces/WithMigrationLockOptions.md)\<`T`\>
+
+## Returns
+
+`Promise`\<`T`\>

package/dist/docs/versioned/57.17.0/reference/generated/api/functions/wrapActionResponse.md

@@ -0,0 +1,19 @@
+> **wrapActionResponse**(`handlerResult`, `action`, `res`): `void`
+
+## Parameters
+
+### handlerResult
+
+`unknown`
+
+### action
+
+[`BaseActionConfig`](../interfaces/BaseActionConfig.md)\<`unknown`, `unknown`, `unknown`\>
+
+### res
+
+`Response`
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/AccessCheckArgs.md

@@ -0,0 +1,29 @@
+## Type Parameters
+
+### S
+
+`S` *extends* [`Statements`](../type-aliases/Statements.md)
+
+## Properties
+
+### context?
+
+> `optional` **context?**: `Record`\<`string`, `unknown`\>
+
+***
+
+### doc?
+
+> `optional` **doc?**: `unknown`
+
+***
+
+### permissions
+
+> **permissions**: [`PermissionRequest`](../type-aliases/PermissionRequest.md)\<`S`\>
+
+***
+
+### user?
+
+> `optional` **user?**: [`User`](User.md)

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/AccessOptions.md

@@ -0,0 +1,110 @@
+## Type Parameters
+
+### S
+
+`S` *extends* [`Statements`](../type-aliases/Statements.md)
+
+## Properties
+
+### auditSink?
+
+> `optional` **auditSink?**: [`RbacAuditSink`](../type-aliases/RbacAuditSink.md) \| [`RbacAuditSink`](../type-aliases/RbacAuditSink.md)[]
+
+Extra destinations for RoleManager audit records (e.g. a consuming-app audit log).
+The built-in `RbacAudit` collection is still written unless `persistAudit` is false.
+
+***
+
+### cacheTtlMs?
+
+> `optional` **cacheTtlMs?**: `number`
+
+***
+
+### connection
+
+> **connection**: `Connection`
+
+***
+
+### defaultRoles?
+
+> `optional` **defaultRoles?**: [`RoleDefinition`](RoleDefinition.md)[]
+
+***
+
+### fieldViews?
+
+> `optional` **fieldViews?**: [`ResourceFieldViews`](ResourceFieldViews.md)\<`S`\>
+
+***
+
+### organizations?
+
+> `optional` **organizations?**: `boolean`
+
+Opt in to organization RBAC: membership `org-admin` grants and the locked `operator` seed.
+Default `false` so existing single-tenant apps stay unchanged. New apps from bootstrap pass `true`.
+
+***
+
+### persistAudit?
+
+> `optional` **persistAudit?**: `boolean`
+
+When false, skip the built-in `RbacAudit` collection. At least one `auditSink` is then
+required so role mutations cannot go unaudited.
+
+***
+
+### readActions?
+
+> `optional` **readActions?**: readonly `string`[]
+
+***
+
+### resolvePermissions?
+
+> `optional` **resolvePermissions?**: (`args`) => `Promise`\<[`PermissionSet`](../type-aliases/PermissionSet.md) \| `null`\>
+
+#### Parameters
+
+##### args
+
+###### user
+
+[`User`](User.md)
+
+#### Returns
+
+`Promise`\<[`PermissionSet`](../type-aliases/PermissionSet.md) \| `null`\>
+
+***
+
+### scopes?
+
+> `optional` **scopes?**: [`ResourceScopes`](../type-aliases/ResourceScopes.md)\<`S`\>
+
+***
+
+### sources?
+
+> `optional` **sources?**: [`PermissionSource`](PermissionSource.md)[]
+
+***
+
+### statementDescriptions?
+
+> `optional` **statementDescriptions?**: `Record`\<`string`, `Record`\<`string`, `string`\>\>
+
+***
+
+### statements
+
+> **statements**: `S`
+
+***
+
+### userModel?
+
+> `optional` **userModel?**: [`UserModel`](UserModel.md)

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/AccessResult.md

@@ -0,0 +1,17 @@
+## Properties
+
+### allowed
+
+> **allowed**: `boolean`
+
+***
+
+### deniedBy?
+
+> `optional` **deniedBy?**: `"source"` \| `"role"` \| `"scope"`
+
+***
+
+### reason?
+
+> `optional` **reason?**: `string`

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/ActionMCPConfig.md

@@ -0,0 +1,17 @@
+Exposes an action as an MCP tool on `/mcp`.
+
+## Properties
+
+### description?
+
+> `optional` **description?**: `string`
+
+Tool description shown to the model. Defaults to the action's description or summary.
+
+***
+
+### name
+
+> **name**: `string`
+
+MCP tool name, unique across every tool the app exposes (e.g. `todos_bulk_complete`).

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/AdminAccessConfig.md

@@ -0,0 +1,50 @@
+## Properties
+
+### authorize?
+
+> `optional` **authorize?**: (`args`) => `boolean` \| `Promise`\<`boolean`\>
+
+Completely replaces the standard RBAC decision for this model.
+
+#### Parameters
+
+##### args
+
+[`AdminAccessContext`](AdminAccessContext.md)
+
+#### Returns
+
+`boolean` \| `Promise`\<`boolean`\>
+
+***
+
+### isOwned?
+
+> `optional` **isOwned?**: (`args`) => `boolean` \| `Promise`\<`boolean`\>
+
+Determines whether the current user owns an instance for writeOwned access.
+
+#### Parameters
+
+##### args
+
+###### instance
+
+`unknown`
+
+###### user
+
+[`User`](User.md)
+
+#### Returns
+
+`boolean` \| `Promise`\<`boolean`\>
+
+***
+
+### resource?
+
+> `optional` **resource?**: `string`
+
+RBAC resource for the standard read/write/writeOwned controls. Defaults to
+`admin<ModelName>` when that statement exists, then the legacy camel-cased model name.

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/AdminAccessContext.md

@@ -0,0 +1,17 @@
+## Properties
+
+### action
+
+> **action**: `string`
+
+***
+
+### instance?
+
+> `optional` **instance?**: `unknown`
+
+***
+
+### user?
+
+> `optional` **user?**: [`User`](User.md)

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/AdminAction.md

@@ -0,0 +1,33 @@
+Declarative bulk action (v2 bulk-patch / background-tasks — no imperative run handler).
+
+## Properties
+
+### background?
+
+> `optional` **background?**: `boolean`
+
+***
+
+### confirm?
+
+> `optional` **confirm?**: `string`
+
+***
+
+### id
+
+> **id**: `string`
+
+***
+
+### label
+
+> **label**: `string`
+
+***
+
+### patchKeys?
+
+> `optional` **patchKeys?**: `string`[]
+
+Keys allowed for synchronous bulk-patch actions

package/dist/docs/versioned/57.17.0/reference/generated/api/interfaces/AdminBroadcastScope.md

@@ -0,0 +1,37 @@
+AdminApp row/resource rules for `{collection}|admin` and admin-window
+`GET /sync/entities`. Product `queryFilter` / `IsOwner` stay on app streams;
+this registry is the AdminApp list/read contract (resource actions + tenant
+`queryFilter`) so a panel user cannot fetch or live-stream rows `/admin` REST
+would hide.
+
+## Properties
+
+### listPermissions
+
+> **listPermissions**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]
+
+***
+
+### queryFilter?
+
+> `optional` **queryFilter?**: (`user?`, `query?`) => `Record`\<`string`, `unknown`\> \| `Promise`\<`Record`\<`string`, `unknown`\> \| `null`\> \| `null`
+
+#### Parameters
+
+##### user?
+
+[`User`](User.md)
+
+##### query?
+
+`Record`\<`string`, `unknown`\>
+
+#### Returns
+
+`Record`\<`string`, `unknown`\> \| `Promise`\<`Record`\<`string`, `unknown`\> \| `null`\> \| `null`
+
+***
+
+### readPermissions
+
+> **readPermissions**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]