@terreno/mcp 57.1.0 → 57.3.0

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/omitUserRolesFromWriteBody.md

@@ -0,0 +1,27 @@
+> **omitUserRolesFromWriteBody**(`modelName`, `accessControl`, `body`, `allowAdminWrite?`): `unknown`
+
+When RBAC is enabled, authority-bearing User fields must not flow through ordinary mongoose
+writes on `/users`, sync, or MCP. AdminApp captures role assignments before this runs and
+explicitly marks authorized legacy-admin writes after its additional checks.
+
+## Parameters
+
+### modelName
+
+`string`
+
+### accessControl
+
+`unknown`
+
+### body
+
+`unknown`
+
+### allowAdminWrite?
+
+`boolean` = `false`
+
+## Returns
+
+`unknown`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/parseStreamKey.md

@@ -0,0 +1,16 @@
+> **parseStreamKey**(`stream`): \{ `collectionTag`: `string`; `scopeKind`: `string`; `scopeValue`: `string` \| `null`; \} \| `null`
+
+Parse a stream key into its collection tag and scope value. The value is everything
+after the first `:` following the `|`-delimited collection tag, so custom values
+containing `:` survive intact. Broadcast streams (`{tag}|all`) yield `scopeValue: null`.
+Returns null when the key is not a valid stream key.
+
+## Parameters
+
+### stream
+
+`string`
+
+## Returns
+
+\{ `collectionTag`: `string`; `scopeKind`: `string`; `scopeValue`: `string` \| `null`; \} \| `null`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/passthroughOrWrap.md

@@ -0,0 +1,20 @@
+> **passthroughOrWrap**(`error`, `wrapper`): [`APIError`](../classes/APIError.md)
+
+Picks the error to throw for something caught in a hook, transformer, or Mongoose middleware.
+An `APIError` is passed through untouched so its status, code, detail, and meta reach the client;
+anything else is wrapped in the given framework error. `wrapper` may override any field,
+including `detail`, which defaults to the caught error's text.
+
+## Parameters
+
+### error
+
+`unknown`
+
+### wrapper
+
+[`APIErrorOptions`](../interfaces/APIErrorOptions.md)
+
+## Returns
+
+[`APIError`](../classes/APIError.md)

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/passthroughOrWrapWrite.md

@@ -0,0 +1,19 @@
+> **passthroughOrWrapWrite**(`error`, `wrapper`): [`APIError`](../classes/APIError.md)
+
+`passthroughOrWrap` for write paths (`model.create`, `doc.save`). Mongoose validation and cast
+errors are converted first so their per-field messages survive as `meta.fields` instead of being
+flattened into the wrapper's `detail`.
+
+## Parameters
+
+### error
+
+`unknown`
+
+### wrapper
+
+[`APIErrorOptions`](../interfaces/APIErrorOptions.md)
+
+## Returns
+
+[`APIError`](../classes/APIError.md)

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/patchExpressRouterUse.md

@@ -0,0 +1,12 @@
+> **patchExpressRouterUse**(): `void`
+
+Patches `express.Router().use` so nested mounts (e.g. `router.use("/gpt/histories", ...)`)
+record `__openApiMountPath` the same way `app.use` does. Without this, nested
+modelRouter OpenAPI paths are omitted from `/openapi.json`.
+
+Express 5's Router puts `use` a few prototypes up from the instance, so we walk
+the chain until we find the own `use` descriptor.
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/rbacRouter.md

@@ -0,0 +1,11 @@
+> **rbacRouter**(`__namedParameters`): [`TerrenoPlugin`](../interfaces/TerrenoPlugin.md)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`RbacRouterOptions`](../interfaces/RbacRouterOptions.md)
+
+## Returns
+
+[`TerrenoPlugin`](../interfaces/TerrenoPlugin.md)

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/rbacUserPlugin.md

@@ -0,0 +1,15 @@
+> **rbacUserPlugin**(`schema`, `options?`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`
+
+### options?
+
+[`RbacUserPluginOptions`](../interfaces/RbacUserPluginOptions.md)
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/recordCompactedThroughSeq.md

@@ -0,0 +1,22 @@
+> **recordCompactedThroughSeq**(`__namedParameters`): `Promise`\<`void`\>
+
+C7: raise a stream's retention watermark to `seq` (never lowers it — `$max`), called by
+`compactTombstones` after it hard-deletes rows. Served to clients as the snapshot's
+`oldestRetainedSeq`, which is the only signal that a stale cursor must re-bootstrap.
+Does not create the counter: a stream with compacted rows always already has one.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### seq
+
+`number`
+
+#### stream
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/recordRbacAudit.md

@@ -0,0 +1,15 @@
+> **recordRbacAudit**(`model`, `args`): `Promise`\<`void`\>
+
+## Parameters
+
+### model
+
+`RbacAuditModel`
+
+### args
+
+[`RbacAuditWrite`](../interfaces/RbacAuditWrite.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/registerMCPModel.md

@@ -0,0 +1,19 @@
+> **registerMCPModel**(`model`, `config`, `options`): `void`
+
+## Parameters
+
+### model
+
+`Model`\<`any`\>
+
+### config
+
+[`MCPConfig`](../interfaces/MCPConfig.md)
+
+### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`any`\>
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/registerMCPTool.md

@@ -0,0 +1,11 @@
+> **registerMCPTool**(`tool`): `void`
+
+## Parameters
+
+### tool
+
+[`MCPCustomTool`](../interfaces/MCPCustomTool.md)
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/registerSync.md

@@ -0,0 +1,38 @@
+> **registerSync**\<`T`\>(`__namedParameters`): `void`
+
+Register a model for local-first sync. Called automatically by modelRouter when the
+`sync` option is provided. Validates the schema contract at startup and throws with
+an actionable message when it is not met:
+- soft delete (`isDeletedPlugin`) is required so deletes remain queryable tombstones;
+- `syncPlugin` is required so every write stamps a per-stream `_syncSeq`;
+- owner/tenant scope fields must exist on the schema.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### config
+
+[`SyncConfig`](../interfaces/SyncConfig.md)
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+#### routePath
+
+`string`
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/releaseSyncSeqs.md

@@ -0,0 +1,27 @@
+> **releaseSyncSeqs**(`__namedParameters`): `Promise`\<`void`\>
+
+Cancel claimed-but-never-used seqs (Task 9.13): the owning write failed, so the seqs
+will never be stamped on any document and holding the frontier below them for the
+full lease would stall every catch-up cursor on the stream for no reason. Unlike
+`confirmSyncSeqs` this is only safe when the write is known NOT to have committed
+(e.g. a Mongoose `VersionError`, where the conditional update matched no document).
+
+## Parameters
+
+### \_\_namedParameters
+
+#### seqs
+
+`number`[]
+
+#### session?
+
+`ClientSession` \| `null`
+
+#### stream
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/requireAdminMiddleware.md

@@ -0,0 +1,24 @@
+> **requireAdminMiddleware**(`req`, `_res`, `next`): `void`
+
+Express middleware that rejects the request with a 403 unless the authenticated user is an admin
+(`req.user.admin === true`). Run it after [authenticateMiddleware](authenticateMiddleware.md) so `req.user` is
+populated, e.g. `[authenticateMiddleware(), requireAdminMiddleware]`. Use this for admin-only
+custom routes instead of hand-rolling an inline admin guard.
+
+## Parameters
+
+### req
+
+`Request`
+
+### \_res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/reresolveSyncRoomsForSocket.md

@@ -0,0 +1,21 @@
+> **reresolveSyncRoomsForSocket**(`socket`, `options`): `Promise`\<`void`\>
+
+D4: re-resolve the streams the socket's user currently belongs to for every
+subscribed collection, and `socket.leave()` any previously-joined sync room the
+user no longer holds (e.g. a revoked organization membership). Joins any newly
+granted rooms too, mirroring what a fresh `sync:subscribe` would do, so a
+membership grant also takes effect without a reconnect.
+
+## Parameters
+
+### socket
+
+[`RevalidatableSocket`](../interfaces/RevalidatableSocket.md)
+
+### options
+
+[`SessionRevalidationOptions`](../interfaces/SessionRevalidationOptions.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/resetSyncMutationRateLimits.md

@@ -0,0 +1,7 @@
+> **resetSyncMutationRateLimits**(): `void`
+
+Clear every per-user window. Test-only: windows are module state shared across suites.
+
+## Returns
+
+`void`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/resolveStreamForDoc.md

@@ -0,0 +1,28 @@
+> **resolveStreamForDoc**(`__namedParameters`): `string`
+
+Resolve the stream a document belongs to under the given scope.
+
+Deliberately total: readers (the change-stream watcher, the tombstone compactor) must
+be able to name a stream for any document already in the database, including legacy
+rows written before a scope field existed. Rejecting an unroutable document is the
+write path's job — see [assertWritableStream](assertWritableStream.md).
+
+## Parameters
+
+### \_\_namedParameters
+
+#### collectionTag
+
+`string`
+
+#### doc
+
+`Record`\<`string`, `unknown`\>
+
+#### scope
+
+[`SyncScope`](../type-aliases/SyncScope.md)
+
+## Returns
+
+`string`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/resolveUserStreamsForEntry.md

@@ -0,0 +1,21 @@
+> **resolveUserStreamsForEntry**(`__namedParameters`): `Promise`\<`string`[]\>
+
+## Parameters
+
+### \_\_namedParameters
+
+#### entry
+
+[`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md)
+
+#### getUserScopes?
+
+(`user`, `entry`) => `string`[] \| `Promise`\<`string`[]\>
+
+#### user
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+`Promise`\<`string`[]\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/revalidateSocketSession.md

@@ -0,0 +1,24 @@
+> **revalidateSocketSession**(`socket`, `options`): `Promise`\<[`RevalidationOutcome`](../type-aliases/RevalidationOutcome.md)\>
+
+Re-run the cheap parts of the auth validator for an already-connected socket:
+- JWT sockets (`decodedToken.authKind === "jwt"`): verify `exp` locally (no
+  signature re-check — a stolen-but-still-valid token is not this sweep's job;
+  revocation-by-expiry and disablement are).
+- Better Auth sockets (`decodedToken.authKind === "better-auth"`): re-run
+  `auth.api.getSession` for the retained session token.
+Also reloads the user's `disabled` flag (and the full user document, refreshing
+`socket.data.fullUser` for D2) when a `userModel` is configured.
+
+## Parameters
+
+### socket
+
+[`RevalidatableSocket`](../interfaces/RevalidatableSocket.md)
+
+### options
+
+[`SessionRevalidationOptions`](../interfaces/SessionRevalidationOptions.md)
+
+## Returns
+
+`Promise`\<[`RevalidationOutcome`](../type-aliases/RevalidationOutcome.md)\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/runActionPermissions.md

@@ -0,0 +1,41 @@
+> **runActionPermissions**\<`T`\>(`action`, `scope`, `model`, `req`, `doc?`, `accessControl?`, `routerAccess?`): `Promise`\<`void`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### action
+
+`BaseActionConfig`\<`unknown`, `unknown`, `unknown`\>
+
+### scope
+
+`ActionScope`
+
+### model
+
+`Model`\<`T`\>
+
+### req
+
+`Request`
+
+### doc?
+
+`T`
+
+### accessControl?
+
+[`AnyTerrenoAccess`](../type-aliases/AnyTerrenoAccess.md)
+
+### routerAccess?
+
+[`ModelRouterAccessOptions`](../interfaces/ModelRouterAccessOptions.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/runPostCreate.md

@@ -0,0 +1,33 @@
+> **runPostCreate**\<`T`\>(`__namedParameters`): `Promise`\<`void`\>
+
+C5 (FIX 6): run `postCreate` outside the write transaction/ledger-finalize
+window. Errors are the caller's responsibility to catch — the sync mutation
+handler logs them and reports a warning, never converting them into a nack
+(the document write already committed and the ledger already finalized
+`applied`).
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### doc
+
+[`ExecutorDoc`](../type-aliases/ExecutorDoc.md)\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+#### request
+
+`Request`
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/runPostDelete.md

@@ -0,0 +1,29 @@
+> **runPostDelete**\<`T`\>(`__namedParameters`): `Promise`\<`void`\>
+
+C5 (FIX 6): run `postDelete` outside the write/ledger-finalize window — see `runPostCreate`.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### doc
+
+[`ExecutorDoc`](../type-aliases/ExecutorDoc.md)\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+#### request
+
+`Request`
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/runPostUpdate.md

@@ -0,0 +1,37 @@
+> **runPostUpdate**\<`T`\>(`__namedParameters`): `Promise`\<`void`\>
+
+C5 (FIX 6): run `postUpdate` outside the write/ledger-finalize window — see `runPostCreate`.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### cleanedBody
+
+`Partial`\<`T`\>
+
+#### doc
+
+[`ExecutorDoc`](../type-aliases/ExecutorDoc.md)\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+#### prevDoc
+
+`T`
+
+#### request
+
+`Request`
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/runSessionRevalidationSweep.md

@@ -0,0 +1,19 @@
+> **runSessionRevalidationSweep**(`io`, `options?`): `Promise`\<`void`\>
+
+Run one sweep pass over every connected socket: re-validate the session (D1),
+disconnecting (`sync:auth-expired` then `disconnect(true)`) any socket that fails,
+and re-resolve sync room membership (D4) for sockets that remain valid.
+
+## Parameters
+
+### io
+
+`Server`
+
+### options?
+
+[`SessionRevalidationOptions`](../interfaces/SessionRevalidationOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/runSyncBatch.md

@@ -0,0 +1,33 @@
+> **runSyncBatch**(`__namedParameters`): `Promise`\<[`SyncBatchRunResult`](../interfaces/SyncBatchRunResult.md)\>
+
+Shared orchestration for a BATCH: validate (size cap + intra-batch duplicate ids),
+then rate limit, then apply.
+
+Validation runs FIRST so a malformed batch consumes no budget — it was never going to
+be applied, and charging for it let a buggy client rate-limit itself out of the
+mutations that would have succeeded. The budget is then charged per MUTATION (not per
+batch), so batching cannot buy extra throughput over single sends.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### mutations
+
+[`SyncMutateRequest`](../interfaces/SyncMutateRequest.md)[]
+
+#### req?
+
+`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
+
+#### scopeResolver?
+
+[`SyncMutationScopeResolver`](../type-aliases/SyncMutationScopeResolver.md)
+
+#### user
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+`Promise`\<[`SyncBatchRunResult`](../interfaces/SyncBatchRunResult.md)\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/runSyncMutation.md

@@ -0,0 +1,29 @@
+> **runSyncMutation**(`__namedParameters`): `Promise`\<[`SyncMutationRunResult`](../interfaces/SyncMutationRunResult.md)\>
+
+Shared orchestration for a SINGLE mutation: rate limit, then apply.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### mutation
+
+[`SyncMutateRequest`](../interfaces/SyncMutateRequest.md)
+
+#### req?
+
+`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
+
+The real Express request when called over HTTP; hooks receive a `{user}` stub otherwise.
+
+#### scopeResolver?
+
+[`SyncMutationScopeResolver`](../type-aliases/SyncMutationScopeResolver.md)
+
+#### user
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+`Promise`\<[`SyncMutationRunResult`](../interfaces/SyncMutationRunResult.md)\>

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/scrubAdminFields.md

@@ -0,0 +1,19 @@
+> **scrubAdminFields**(`value`, `params`): `unknown`
+
+Removes `excludeFields` and `hiddenFields` from a document (or nested value).
+Populated refs are scrubbed using the referenced model's admin config when present
+in `allModelAdmins` (keyed by Mongoose model name).
+
+## Parameters
+
+### value
+
+`unknown`
+
+### params
+
+`ScrubAdminFieldsParams`
+
+## Returns
+
+`unknown`

package/dist/docs/versioned/57.1.0/reference/generated/api/functions/serializeSyncDoc.md

@@ -0,0 +1,25 @@
+> **serializeSyncDoc**(`__namedParameters`): `Promise`\<`unknown`\>
+
+Serialize a document for a sync payload through the fallback chain:
+sync responseHandler > modelRouter responseHandler > toJSON.
+Delegates to the shared `serializeSyncPayload` (also used for `sync:delta` emission).
+
+## Parameters
+
+### \_\_namedParameters
+
+#### doc
+
+`Document`
+
+#### entry
+
+[`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md)
+
+#### req
+
+`Request`
+
+## Returns
+
+`Promise`\<`unknown`\>