@terreno/mcp 57.1.0 → 57.3.0

package/src/docs/versioned/57.2.0/reference/generated/api/functions/emitPayloadToAuthorizedRoom.md

@@ -0,0 +1,46 @@
+> **emitPayloadToAuthorizedRoom**(`__namedParameters`): `Promise`\<`void`\>
+
+Generalized authorized-room emitter: iterates the sockets in `room`, runs the per-socket
+read-permission check against `fullDocument`, builds the payload per socket (so
+responseHandlers can tailor output to the receiving user), and emits `eventName`.
+
+`emitToAuthorizedRoom` (legacy "sync" events) and the sync layer's `sync:delta`
+emission both delegate here.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### buildPayload
+
+(`user`) => `unknown`
+
+Build the per-socket payload; a throw drops the emission for that socket only.
+
+#### entry
+
+[`AuthorizedEmitEntry`](../interfaces/AuthorizedEmitEntry.md)
+
+#### eventName
+
+`string`
+
+#### fullDocument
+
+`Record`\<`string`, `unknown`\> \| `undefined`
+
+#### io
+
+`Server`
+
+#### logDebug
+
+(`msg`) => `void`
+
+#### room
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/emitSyncDeltaForChange.md

@@ -0,0 +1,57 @@
+> **emitSyncDeltaForChange**(`__namedParameters`): `Promise`\<`void`\>
+
+Emit `sync:delta` events for a change on a sync-registered collection.
+
+Deltas fan out to the dedicated `sync:{stream}` rooms joined via `sync:subscribe`
+(independent of the legacy realtime rooms), with the same per-socket read-permission
+checks as legacy events. `seq` and `stream` come from the post-image: the `syncPlugin`
+stamps `_syncSeq` on every synced write and the watcher runs `updateLookup`.
+
+Soft deletes (an update setting `deleted: true`, reclassified by `mapOperationType`)
+produce a `method: "delete"` delta with `deleted: true` and the tombstone data intact.
+
+Scope moves (C4): the old-stream tombstone is derived from durable `SyncScopeMove`
+markers (written by `syncPlugin` in the same op-scope as the move), NOT from the racy
+`_syncPrevStream` post-image — a second write racing this event's processing can reset
+`_syncPrevStream`, but it cannot erase the durable marker. For each marker on this
+document, a data-less tombstone is emitted to the marker's `fromStream` (carrying the
+marker's old-stream seq), and the new-stream delta is reported as `method: "create"`.
+Client tombstone application is idempotent by seq, so re-emitting a marker on a later
+change of the same doc is harmless.
+
+Every emitted delta carries `frontierSeq` (the emitting stream's stable frontier at
+emit time, C1); the client advances its cursor to `min(delta.seq, delta.frontierSeq)`
+so a delta observed out of commit order never advances a cursor past an uncommitted hole.
+
+A model with both `realtime` and `sync` configs emits both the legacy "sync" event and
+"sync:delta" — distinct event names, no interference (documented as transitional).
+
+Exported for testing.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### change
+
+`WatchedChange`
+
+#### docId
+
+`string`
+
+#### entry
+
+[`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md)
+
+#### io
+
+`Server`
+
+#### logDebug
+
+(`msg`) => `void`
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/ensureSyncIndexes.md

@@ -0,0 +1,11 @@
+> **ensureSyncIndexes**(): `Promise`\<`void`\>
+
+C8: await every enqueued sync index creation — per-model snapshot indexes from
+`registerSync` plus the bookkeeping-model indexes from `SyncApp.register` — throwing on
+the first failure. Called at server startup by `TerrenoApp.start()` (after all models
+and plugins register) so a missing index fails the boot loudly rather than silently
+degrading the snapshot query to a table scan or breaking mutation idempotency.
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/ensureSyncModelIndexes.md

@@ -0,0 +1,9 @@
+> **ensureSyncModelIndexes**(): `Promise`\<`void`\>
+
+Build the indexes for every sync bookkeeping model, throwing on the first failure so
+server startup fails loudly. Kicked off by `SyncApp.register` and awaited through
+`ensureSyncIndexes()`; idempotent, so calling it repeatedly is safe.
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/envConfigurationPlugin.md

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

package/src/docs/versioned/57.2.0/reference/generated/api/functions/errorDetail.md

@@ -0,0 +1,15 @@
+> **errorDetail**(`error`): `string`
+
+Extract the fullest human-readable text from an unknown error, for use as the `detail` of a
+wrapper error. An `APIError`'s `message` is exactly its `title`, so `errorMessage` alone would
+drop the per-occurrence text the caller put in `detail`.
+
+## Parameters
+
+### error
+
+`unknown`
+
+## Returns
+
+`string`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/evictExpiredSyncMutationWindows.md

@@ -0,0 +1,18 @@
+> **evictExpiredSyncMutationWindows**(`__namedParameters?`): `number`
+
+Drop windows that have expired, so the map does not grow with every user ever seen.
+Runs automatically (throttled to WINDOW\_EVICTION\_INTERVAL\_MS) whenever budget is
+charged; `now` is injectable so the sweep can be exercised without waiting a minute.
+Returns the number of windows still retained.
+
+## Parameters
+
+### \_\_namedParameters?
+
+#### now?
+
+`number` = `...`
+
+## Returns
+
+`number`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/excludeArchivedPlugin.md

@@ -0,0 +1,24 @@
+> **excludeArchivedPlugin**(`schema`, `defaultValue?`): `void`
+
+Adds an `archived` boolean field and excludes archived documents from `find()` / `findOne()`
+queries by default. Pass `{archived: true}` explicitly to include them. This is a soft-archive
+analog to [isDeletedPlugin](isDeletedPlugin.md): use it when documents should be hidden from normal listings
+but kept (and still directly queryable) rather than treated as deleted.
+
+## Parameters
+
+### schema
+
+`Schema`\<`any`, `any`, `any`, `any`\>
+
+Mongoose Schema
+
+### defaultValue?
+
+`boolean` = `false`
+
+Default value for the `archived` field (defaults to `false`)
+
+## Returns
+
+`void`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/executeCreate.md

@@ -0,0 +1,50 @@
+> **executeCreate**\<`T`\>(`__namedParameters`): `Promise`\<[`ExecutorResult`](../interfaces/ExecutorResult.md)\<`T`\>\>
+
+Create a document through the same pipeline as `POST /`: method-level permissions,
+`transformer.transform`, `preCreate`, `Model.create` (Mongoose validation), population,
+and `postCreate`. Throws APIErrors with the same statuses/titles as the REST handler.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### body
+
+`unknown`
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+#### req?
+
+`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
+
+The real Express request when called over HTTP; hooks receive a `{user}` stub otherwise.
+
+#### skipPostHooks?
+
+`boolean`
+
+C5 (FIX 6): when true, skip the built-in `postCreate` call — the caller
+(the sync mutation handler) runs it manually AFTER finalizing the
+idempotency ledger `applied`, so a post-hook throw can never make a
+committed write look like a failure. REST handlers never set this.
+
+#### user?
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+`Promise`\<[`ExecutorResult`](../interfaces/ExecutorResult.md)\<`T`\>\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/executeDelete.md

@@ -0,0 +1,55 @@
+> **executeDelete**\<`T`\>(`__namedParameters`): `Promise`\<[`ExecutorResult`](../interfaces/ExecutorResult.md)\<`T`\>\>
+
+Delete a document through the same pipeline as `DELETE /:id`: method-level and object-level
+permissions, doc loading (404), `preDelete`, soft delete (`deleted = true` + save when the
+schema has a Boolean `deleted` path, else `doc.deleteOne()`), and `postDelete`. Throws
+APIErrors with the same statuses/titles as the REST handler.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### existingDoc?
+
+`Document`\<`unknown`, `unknown`, `unknown`, `Record`\<`string`, `any`\>, \{ \}\> & `T` & `object`
+
+Pre-loaded document, used by the REST handler where permissionMiddleware already loaded
+and authorized it (avoids a second fetch). Permission checks still run either way.
+
+#### id
+
+`string`
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+#### req?
+
+`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
+
+The real Express request when called over HTTP; hooks receive a `{user}` stub otherwise.
+
+#### skipPostHooks?
+
+`boolean`
+
+C5 (FIX 6): see `executeCreate`'s `skipPostHooks` doc comment.
+
+#### user?
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+`Promise`\<[`ExecutorResult`](../interfaces/ExecutorResult.md)\<`T`\>\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/executeUpdate.md

@@ -0,0 +1,64 @@
+> **executeUpdate**\<`T`\>(`__namedParameters`): `Promise`\<[`ExecutorResult`](../interfaces/ExecutorResult.md)\<`T`\>\>
+
+Update a document through the same pipeline as `PATCH /:id`: method-level and object-level
+permissions, doc loading (404), `transformer.transform`, `_updatedAt` stripping,
+`preUpdate`, the optional concurrency check, `doc.set` + `doc.save` (Mongoose validation),
+population, and `postUpdate`. Throws APIErrors with the same statuses/titles as the REST
+handler; concurrency conflicts throw `ExecutorConflictError` (409) carrying the server doc.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### body
+
+`unknown`
+
+#### concurrencyCheck?
+
+[`ExecutorConcurrencyCheck`](../type-aliases/ExecutorConcurrencyCheck.md)
+
+#### existingDoc?
+
+[`ExecutorDoc`](../type-aliases/ExecutorDoc.md)\<`T`\>
+
+Pre-loaded document, used by the REST handler where permissionMiddleware already loaded
+and authorized it (avoids a second fetch). Permission checks still run either way.
+
+#### id
+
+`string`
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+#### req?
+
+`Request`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>
+
+The real Express request when called over HTTP; hooks receive a `{user}` stub otherwise.
+
+#### skipPostHooks?
+
+`boolean`
+
+C5 (FIX 6): see `executeCreate`'s `skipPostHooks` doc comment.
+
+#### user?
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+`Promise`\<[`ExecutorResult`](../interfaces/ExecutorResult.md)\<`T`\>\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/expandRolePermissions.md

@@ -0,0 +1,19 @@
+> **expandRolePermissions**(`spec`, `statements`, `readActions?`): [`PermissionSet`](../type-aliases/PermissionSet.md)
+
+## Parameters
+
+### spec
+
+[`RolePermissionSpec`](../type-aliases/RolePermissionSpec.md)
+
+### statements
+
+[`Statements`](../type-aliases/Statements.md)
+
+### readActions?
+
+readonly `string`[] = `READ_ACTIONS`
+
+## Returns
+
+[`PermissionSet`](../type-aliases/PermissionSet.md)

package/src/docs/versioned/57.2.0/reference/generated/api/functions/extractUserFromHeaders.md

@@ -0,0 +1,18 @@
+> **extractUserFromHeaders**(`headers`, `context`): `Promise`\<[`User`](../interfaces/User.md) \| `undefined`\>
+
+Extract user from raw headers using whichever auth provider is configured.
+Works with both JWT and Better Auth, mirroring authenticateMiddleware behavior.
+
+## Parameters
+
+### headers
+
+`Record`\<`string`, `string` \| `string`[] \| `undefined`\>
+
+### context
+
+[`MCPAuthContext`](../interfaces/MCPAuthContext.md)
+
+## Returns
+
+`Promise`\<[`User`](../interfaces/User.md) \| `undefined`\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/findOneOrNoneFor.md

@@ -0,0 +1,37 @@
+> **findOneOrNoneFor**\<`T`\>(`model`, `query`, `errorArgs?`): `Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `null`\>
+
+Helper that performs a `findOneOrNone` lookup against any Mongoose model. Returns the matching
+document, `null` if none match, or throws if more than one matches. If the model's schema has
+the [findOneOrNone](findOneOrNone.md) plugin applied, the plugin static is used; otherwise the lookup is
+performed directly via `model.find(...)`. Prefer this helper from framework code where the
+consumer's model may or may not have the plugin installed.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### model
+
+`Model`\<`T`\>
+
+Mongoose Model
+
+### query
+
+[`ModelQuery`](../type-aliases/ModelQuery.md)\<`T`\>
+
+Mongoose query object
+
+### errorArgs?
+
+`Partial`\<[`APIErrorOptions`](../interfaces/APIErrorOptions.md)\>
+
+Optional overrides for the thrown [APIError](../classes/APIError.md) when multiple match
+
+## Returns
+
+`Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `null`\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/findSyncEntryByCollectionName.md

@@ -0,0 +1,13 @@
+> **findSyncEntryByCollectionName**(`collectionName`): [`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md) \| `undefined`
+
+Find a sync registry entry by MongoDB collection name.
+
+## Parameters
+
+### collectionName
+
+`string`
+
+## Returns
+
+[`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md) \| `undefined`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/findSyncEntryByCollectionTag.md

@@ -0,0 +1,13 @@
+> **findSyncEntryByCollectionTag**(`collectionTag`): [`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md) \| `undefined`
+
+Find a sync registry entry by collection tag (e.g. "todos").
+
+## Parameters
+
+### collectionTag
+
+`string`
+
+## Returns
+
+[`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md) \| `undefined`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/findSyncEntryByModelName.md

@@ -0,0 +1,13 @@
+> **findSyncEntryByModelName**(`modelName`): [`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md) \| `undefined`
+
+Find a sync registry entry by Mongoose model name.
+
+## Parameters
+
+### modelName
+
+`string`
+
+## Returns
+
+[`SyncRegistryEntry`](../interfaces/SyncRegistryEntry.md) \| `undefined`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/fixMixedFields.md

@@ -0,0 +1,19 @@
+> **fixMixedFields**(`schema`, `properties`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`\<`any`, `Model`\<`any`, `any`, `any`, `any`, `any`, `any`, `any`\>, \{ \}, \{ \}, \{ \}, \{ \}, `DefaultSchemaOptions`, \{\[`key`: `number`\]: `unknown`;
+\[`key`: `symbol`\]: `unknown`;
+\[`key`: `string`\]: `unknown`; \}, `Document`\<`unknown`, \{ \}, \{\[`key`: `number`\]: `unknown`;
+\[`key`: `symbol`\]: `unknown`;
+\[`key`: `string`\]: `unknown`; \}, \{ \}, `DefaultSchemaOptions`\> & `Omit`\<`object` & `Required`\<\{ \}\> & `object`, `"id"`\> & `HydratedDocumentOverrides`\<\{ \}\>, `unknown`, `object` & `Required`\<\{ \}\> & `object`\> \| `null`
+
+### properties
+
+`Record`\<`string`, `unknown`\> \| `Record`\<`string`, `OpenApiSchemaNode`\> \| `null`
+
+## Returns
+
+`void`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/generateAllTools.md

@@ -0,0 +1,11 @@
+> **generateAllTools**(`entries`): [`MCPToolDefinition`](../interfaces/MCPToolDefinition.md)[]
+
+## Parameters
+
+### entries
+
+[`MCPRegistryEntry`](../interfaces/MCPRegistryEntry.md)[]
+
+## Returns
+
+[`MCPToolDefinition`](../interfaces/MCPToolDefinition.md)[]

package/src/docs/versioned/57.2.0/reference/generated/api/functions/generateInputSchema.md

@@ -0,0 +1,31 @@
+> **generateInputSchema**(`model`, `method`, `config`, `queryFields?`, `populatePaths?`, `restExcludeFields?`): `ZodType`
+
+## Parameters
+
+### model
+
+`Model`\<`any`\>
+
+### method
+
+[`MCPMethod`](../type-aliases/MCPMethod.md)
+
+### config
+
+[`MCPConfig`](../interfaces/MCPConfig.md)
+
+### queryFields?
+
+`string`[]
+
+### populatePaths?
+
+[`PopulatePath`](../interfaces/PopulatePath.md)[]
+
+### restExcludeFields?
+
+`string`[] = `[]`
+
+## Returns
+
+`ZodType`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/generateToolDescription.md

@@ -0,0 +1,31 @@
+> **generateToolDescription**(`model`, `method`, `config`, `queryFields?`, `populatePaths?`, `restExcludeFields?`): `string`
+
+## Parameters
+
+### model
+
+`Model`\<`any`\>
+
+### method
+
+[`MCPMethod`](../type-aliases/MCPMethod.md)
+
+### config
+
+[`MCPConfig`](../interfaces/MCPConfig.md)
+
+### queryFields?
+
+`string`[]
+
+### populatePaths?
+
+[`PopulatePath`](../interfaces/PopulatePath.md)[]
+
+### restExcludeFields?
+
+`string`[] = `[]`
+
+## Returns
+
+`string`

package/src/docs/versioned/57.2.0/reference/generated/api/functions/generateToolsForEntry.md

@@ -0,0 +1,11 @@
+> **generateToolsForEntry**(`entry`): [`MCPToolDefinition`](../interfaces/MCPToolDefinition.md)[]
+
+## Parameters
+
+### entry
+
+[`MCPRegistryEntry`](../interfaces/MCPRegistryEntry.md)
+
+## Returns
+
+[`MCPToolDefinition`](../interfaces/MCPToolDefinition.md)[]

package/src/docs/versioned/57.2.0/reference/generated/api/functions/getAPIErrorBody.md

@@ -0,0 +1,17 @@
+> **getAPIErrorBody**(`error`): `Record`\<`string`, `unknown`\>
+
+Creates an APIError body to send to clients as JSON.
+
+## Parameters
+
+### error
+
+[`APIError`](../classes/APIError.md)
+
+## Returns
+
+`Record`\<`string`, `unknown`\>
+
+## Deprecated
+
+Use `error.toJSON()` instead.

package/src/docs/versioned/57.2.0/reference/generated/api/functions/getAllMCPTools.md

@@ -0,0 +1,7 @@
+> **getAllMCPTools**(): [`MCPToolDefinition`](../interfaces/MCPToolDefinition.md)[]
+
+Model-router tools plus any custom tools registered with `registerMCPTool`.
+
+## Returns
+
+[`MCPToolDefinition`](../interfaces/MCPToolDefinition.md)[]

package/src/docs/versioned/57.2.0/reference/generated/api/functions/getCompactedThroughSeq.md

@@ -0,0 +1,16 @@
+> **getCompactedThroughSeq**(`__namedParameters`): `Promise`\<`number`\>
+
+C7: the stream's retention watermark — the highest seq whose tombstone/marker has been
+compacted away. 0 when nothing has been compacted (no retention gap to enforce).
+
+## Parameters
+
+### \_\_namedParameters
+
+#### stream
+
+`string`
+
+## Returns
+
+`Promise`\<`number`\>

package/src/docs/versioned/57.2.0/reference/generated/api/functions/getDisallowedWriteKeys.md

@@ -0,0 +1,15 @@
+> **getDisallowedWriteKeys**(`body`, `mask`): `string`[]
+
+## Parameters
+
+### body
+
+`Record`\<`string`, `unknown`\>
+
+### mask
+
+[`FieldMask`](../interfaces/FieldMask.md)
+
+## Returns
+
+`string`[]

package/src/docs/versioned/57.2.0/reference/generated/api/functions/getMCPRegistry.md

@@ -0,0 +1,5 @@
+> **getMCPRegistry**(): [`MCPRegistryEntry`](../interfaces/MCPRegistryEntry.md)[]
+
+## Returns
+
+[`MCPRegistryEntry`](../interfaces/MCPRegistryEntry.md)[]