@terreno/mcp 57.20.0 → 58.0.0-beta.1

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getMembershipModel.md

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

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getMigrationStatus.md

@@ -0,0 +1,17 @@
+> **getMigrationStatus**(`__namedParameters`): `Promise`\<[`MigrationStatus`](../interfaces/MigrationStatus.md)\>
+
+## Parameters
+
+### \_\_namedParameters
+
+#### connection
+
+`Connection`
+
+#### migrations
+
+[`LoadedMigration`](../interfaces/LoadedMigration.md)[]
+
+## Returns
+
+`Promise`\<[`MigrationStatus`](../interfaces/MigrationStatus.md)\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getMongoClientFromMongoose.md

@@ -0,0 +1,7 @@
+> **getMongoClientFromMongoose**(): [`MongoClientLike`](../interfaces/MongoClientLike.md)
+
+Gets a MongoDB client view whose db() is the mongoose connection's database (its dbName).
+
+## Returns
+
+[`MongoClientLike`](../interfaces/MongoClientLike.md)

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getNotificationService.md

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

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getOpenApiSpecForModel.md

@@ -0,0 +1,35 @@
+> **getOpenApiSpecForModel**\<`T`\>(`model`, `__namedParameters?`): `object`
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### model
+
+`Model`\<`T`\>
+
+### \_\_namedParameters?
+
+#### extraModelProperties?
+
+`Record`\<`string`, `unknown`\>
+
+#### populatePaths?
+
+[`PopulatePath`](../interfaces/PopulatePath.md)[]
+
+## Returns
+
+`object`
+
+### properties
+
+> **properties**: `Record`\<`string`, `unknown`\>
+
+### required
+
+> **required**: `string`[]

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getOrgContext.md

@@ -0,0 +1,5 @@
+> **getOrgContext**(): [`ResolvedOrgContext`](../interfaces/ResolvedOrgContext.md) \| `undefined`
+
+## Returns
+
+[`ResolvedOrgContext`](../interfaces/ResolvedOrgContext.md) \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getOrganizationModel.md

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

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getOrganizationSettingsSchema.md

@@ -0,0 +1,13 @@
+> **getOrganizationSettingsSchema**(): `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`\> \| `undefined`
+
+## Returns
+
+`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`\> \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getProvidedBetterAuth.md

@@ -0,0 +1,13 @@
+> **getProvidedBetterAuth**(`provider`): `Auth`\<`BetterAuthOptions`\> \| `undefined`
+
+The provider's Better Auth instance, creating it when the provider supports that.
+
+## Parameters
+
+### provider
+
+[`BetterAuthProvider`](../interfaces/BetterAuthProvider.md) \| `undefined`
+
+## Returns
+
+`Auth`\<`BetterAuthOptions`\> \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getRealtimeRegistry.md

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

package/src/docs/versioned/57.20.0/reference/generated/api/functions/getSyncRegistry.md

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

package/src/docs/versioned/57.20.0/reference/generated/api/functions/hasMCPActions.md

@@ -0,0 +1,19 @@
+> **hasMCPActions**\<`T`\>(`options`): `boolean`
+
+True when any instance or collection action opts into MCP with `mcp`.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### options
+
+`Pick`\<[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>, `"instanceActions"` \| `"collectionActions"`\>
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/hmacSignature.md

@@ -0,0 +1,15 @@
+> **hmacSignature**(`options`): (`req`) => `boolean`
+
+Verifies `header` against HMAC of `req.rawBody`.
+When `timestampHeader` is set, the MAC is HMAC(`${timestamp}.${rawBody}`) and
+timestamps outside `toleranceSec` (default 300) are rejected.
+
+## Parameters
+
+### options
+
+[`HmacSignatureOptions`](../interfaces/HmacSignatureOptions.md)
+
+## Returns
+
+(`req`) => `boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/inviteSlackUsersToChannel.md

@@ -0,0 +1,18 @@
+> **inviteSlackUsersToChannel**(`__namedParameters`): `Promise`\<[`SlackInviteResult`](../interfaces/SlackInviteResult.md)\>
+
+Invite staff to a channel the bot already belongs to. Private channels do
+not allow a bot to join itself; invite the app once, then call this.
+
+`groups:write.invites` covers private channels. `channels:write.invites`
+covers public channels. Member IDs that are already in the channel are
+reported on `alreadyMemberUserIds` and do not fail the call.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`InviteSlackUsersOptions`](../interfaces/InviteSlackUsersOptions.md)
+
+## Returns
+
+`Promise`\<[`SlackInviteResult`](../interfaces/SlackInviteResult.md)\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isAdminBroadcastSocketRoom.md

@@ -0,0 +1,17 @@
+> **isAdminBroadcastSocketRoom**(`room`, `collectionTag`): `boolean`
+
+Socket.io room for `{collection}|admin` (`sync:{tag}|admin`).
+
+## Parameters
+
+### room
+
+`string`
+
+### collectionTag
+
+`string`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isAuditRecorderInstalled.md

@@ -0,0 +1,5 @@
+> **isAuditRecorderInstalled**(): `boolean`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isBetterAuthProvider.md

@@ -0,0 +1,13 @@
+> **isBetterAuthProvider**(`plugin`): `plugin is BetterAuthProvider`
+
+Whether a registered plugin provides the app's Better Auth instance.
+
+## Parameters
+
+### plugin
+
+`unknown`
+
+## Returns
+
+`plugin is BetterAuthProvider`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isEscapedRegexLiteral.md

@@ -0,0 +1,13 @@
+> **isEscapedRegexLiteral**(`value`): `boolean`
+
+Accepts literal text and escaped metacharacters (e.g. `\\.`), rejects executable patterns.
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isPlatformOrgActor.md

@@ -0,0 +1,11 @@
+> **isPlatformOrgActor**(`user?`): `boolean`
+
+## Parameters
+
+### user?
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isRbacUserModelName.md

@@ -0,0 +1,18 @@
+> **isRbacUserModelName**(`modelName`, `accessControl`): `boolean`
+
+True when RBAC is enabled and `modelName` names the user model: `"User"`, or the compiled
+name of the `userModel` passed to `createAccess`.
+
+## Parameters
+
+### modelName
+
+`string`
+
+### accessControl
+
+`unknown`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isSignUpClosed.md

@@ -0,0 +1,13 @@
+> **isSignUpClosed**(`config`): `boolean`
+
+Whether `signUp.mode` is `closed`.
+
+## Parameters
+
+### config
+
+[`BetterAuthConfig`](../interfaces/BetterAuthConfig.md)
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/isWriteKeyForField.md

@@ -0,0 +1,19 @@
+> **isWriteKeyForField**(`key`, `field`): `boolean`
+
+True when a write-body key addresses `field` itself or a path inside it. Mongoose `set`,
+`create`, and the document constructor treat a dotted key such as `roles.0` as a path into
+`roles`, so field filters must match the first path segment, not only the exact key.
+
+## Parameters
+
+### key
+
+`string`
+
+### field
+
+`string`
+
+## Returns
+
+`boolean`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/lastSchemaAfter.md

@@ -0,0 +1,11 @@
+> **lastSchemaAfter**(`catalogs`): [`SchemaCatalog`](../interfaces/SchemaCatalog.md) \| `undefined`
+
+## Parameters
+
+### catalogs
+
+`object`[]
+
+## Returns
+
+[`SchemaCatalog`](../interfaces/SchemaCatalog.md) \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/loadMigrations.md

@@ -0,0 +1,15 @@
+> **loadMigrations**(`__namedParameters`): `Promise`\<[`LoadedMigration`](../interfaces/LoadedMigration.md)[]\>
+
+Public alias for `checkMigrationFiles`; kept as a wrapper so Knip does not treat it as a duplicate export.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### dir
+
+`string`
+
+## Returns
+
+`Promise`\<[`LoadedMigration`](../interfaces/LoadedMigration.md)[]\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/lookupSlackUserIdByEmail.md

@@ -0,0 +1,17 @@
+> **lookupSlackUserIdByEmail**(`__namedParameters`): `Promise`\<`string` \| `undefined`\>
+
+Resolve a workspace member's Slack user id from their email.
+
+Incoming webhooks cannot look users up. This calls `users.lookupByEmail` and
+needs a bot token with the `users:read.email` scope. Store the returned id on
+the staff/user record and pass it to `sendToSlack({mentionUserIds})`.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`LookupSlackUserIdByEmailOptions`](../interfaces/LookupSlackUserIdByEmailOptions.md)
+
+## Returns
+
+`Promise`\<`string` \| `undefined`\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/maskEmailAddress.md

@@ -0,0 +1,14 @@
+> **maskEmailAddress**(`email`): `string`
+
+Partially mask an email for a notice: `renamed@example.com` becomes `r***@e***.com`. Keeps the
+first character of the local part and of the domain, plus the top-level domain.
+
+## Parameters
+
+### email
+
+`string`
+
+## Returns
+
+`string`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/matchesQuery.md

@@ -0,0 +1,26 @@
+> **matchesQuery**(`doc`, `query`): `boolean`
+
+Check if a document matches a MongoDB-style query in memory.
+
+Fails closed: malformed clauses, and operands that cannot be compared (for example an
+object whose `toString` is not a function), count as a non-match instead of throwing.
+
+## Parameters
+
+### doc
+
+`Record`\<`string`, `unknown`\>
+
+The document to test (plain object or Mongoose document)
+
+### query
+
+`Record`\<`string`, `unknown`\>
+
+MongoDB-style query object
+
+## Returns
+
+`boolean`
+
+true if the document matches all query conditions

package/src/docs/versioned/57.20.0/reference/generated/api/functions/maybeRecordAdminAudit.md

@@ -0,0 +1,37 @@
+> **maybeRecordAdminAudit**(`__namedParameters`): `Promise`\<`void`\>
+
+## Parameters
+
+### \_\_namedParameters
+
+#### after?
+
+`unknown`
+
+#### before?
+
+`unknown`
+
+#### extraRedact?
+
+`string`[] = `[]`
+
+#### modelName
+
+`string`
+
+#### recordLabel?
+
+`string`
+
+#### req
+
+`Request`
+
+#### verb
+
+[`AuditEventVerb`](../type-aliases/AuditEventVerb.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/membershipOrgAdminPermissionSource.md

@@ -0,0 +1,8 @@
+> **membershipOrgAdminPermissionSource**(): [`PermissionSource`](../interfaces/PermissionSource.md)
+
+Additive-only: it never returns `deny`, so an outage drops only its org-admin grants and does
+not fail resolution closed.
+
+## Returns
+
+[`PermissionSource`](../interfaces/PermissionSource.md)

package/src/docs/versioned/57.20.0/reference/generated/api/functions/mergeMissingResourcePermissions.md

@@ -0,0 +1,21 @@
+> **mergeMissingResourcePermissions**(`existing`, `defaults`, `resources`): [`PermissionSet`](../type-aliases/PermissionSet.md)
+
+Add missing actions for selected resources without removing consumer-defined grants.
+
+## Parameters
+
+### existing
+
+[`PermissionSet`](../type-aliases/PermissionSet.md)
+
+### defaults
+
+[`PermissionSet`](../type-aliases/PermissionSet.md)
+
+### resources
+
+readonly `string`[]
+
+## Returns
+
+[`PermissionSet`](../type-aliases/PermissionSet.md)

package/src/docs/versioned/57.20.0/reference/generated/api/functions/modelDescriptionToAdminFields.md

@@ -0,0 +1,11 @@
+> **modelDescriptionToAdminFields**(`description`): `Record`\<`string`, `ReturnType`\<*typeof* [`fieldDescriptionToAdminMeta`](../variables/fieldDescriptionToAdminMeta.md)\>\>
+
+## Parameters
+
+### description
+
+[`ModelDescription`](../interfaces/ModelDescription.md)
+
+## Returns
+
+`Record`\<`string`, `ReturnType`\<*typeof* [`fieldDescriptionToAdminMeta`](../variables/fieldDescriptionToAdminMeta.md)\>\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/modelDescriptionToOpenApiSpec.md

@@ -0,0 +1,19 @@
+> **modelDescriptionToOpenApiSpec**(`description`): `object`
+
+## Parameters
+
+### description
+
+[`ModelDescription`](../interfaces/ModelDescription.md)
+
+## Returns
+
+`object`
+
+### properties
+
+> **properties**: `Record`\<`string`, `unknown`\>
+
+### required
+
+> **required**: `string`[]

package/src/docs/versioned/57.20.0/reference/generated/api/functions/mountOrgSecurityRoutes.md

@@ -0,0 +1,33 @@
+> **mountOrgSecurityRoutes**(`__namedParameters`): `void`
+
+Mounts the AccountSecurityApp routes on an OrgsApp router at
+`/:orgId/members/:userId/security/*`. Platform-only actions (`disable`, `enable`,
+`issue-sign-in-link`) are left out; org-only ones (`suspend-membership`) are added.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### access
+
+[`AnyTerrenoAccess`](../type-aliases/AnyTerrenoAccess.md)
+
+#### accountSecurity
+
+[`AccountSecurityApp`](../classes/AccountSecurityApp.md)
+
+#### orgRecovery?
+
+[`OrgRecoveryOptions`](../interfaces/OrgRecoveryOptions.md)
+
+#### router
+
+`Router`
+
+#### userModel
+
+[`UserModel`](../interfaces/UserModel.md)
+
+## Returns
+
+`void`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/nestDottedFieldDescriptions.md

@@ -0,0 +1,11 @@
+> **nestDottedFieldDescriptions**(`fields`): `Record`\<`string`, [`FieldDescription`](../interfaces/FieldDescription.md)\>
+
+## Parameters
+
+### fields
+
+`Record`\<`string`, [`FieldDescription`](../interfaces/FieldDescription.md)\>
+
+## Returns
+
+`Record`\<`string`, [`FieldDescription`](../interfaces/FieldDescription.md)\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/normalizeSlackChannelName.md

@@ -0,0 +1,15 @@
+> **normalizeSlackChannelName**(`name`): `string`
+
+Slack channel names are lowercase letters, numbers, hyphens, and underscores,
+at most 80 characters. Leading and trailing whitespace is removed and the
+value is lowercased. Any other character is rejected.
+
+## Parameters
+
+### name
+
+`string`
+
+## Returns
+
+`string`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/normalizeSlackUserId.md

@@ -0,0 +1,15 @@
+> **normalizeSlackUserId**(`value`): `string` \| `undefined`
+
+Normalize a Slack member ID. Accepts a bare id (`U012ABCDEF`) or a mention
+token (`<@U012ABCDEF>`). Returns undefined when the value is not a Slack
+member ID — names and emails cannot be used for mentions.
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`string` \| `undefined`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/notificationsBeforeSend.md

@@ -0,0 +1,15 @@
+> **notificationsBeforeSend**(`__namedParameters`): `Promise`\<[`NotificationsBeforeSendResult`](../interfaces/NotificationsBeforeSendResult.md) \| `undefined`\>
+
+Duck-typed CommsApp `beforeSend` hook that cancels outbound delivery when the user
+disabled that channel in NotificationPreference. Missing preference rows default to
+all channels on. The `verification` channel is never cancelled here.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`NotificationsBeforeSendContext`](../interfaces/NotificationsBeforeSendContext.md)
+
+## Returns
+
+`Promise`\<[`NotificationsBeforeSendResult`](../interfaces/NotificationsBeforeSendResult.md) \| `undefined`\>

package/src/docs/versioned/57.20.0/reference/generated/api/functions/omitUserRolesFromWriteBody.md

@@ -0,0 +1,28 @@
+> **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. The user model is
+recognized by [isRbacUserModelName](isRbacUserModelName.md).
+
+## Parameters
+
+### modelName
+
+`string`
+
+### accessControl
+
+`unknown`
+
+### body
+
+`unknown`
+
+### allowAdminWrite?
+
+`boolean` = `false`
+
+## Returns
+
+`unknown`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/onSecurityAction.md

@@ -0,0 +1,14 @@
+> **onSecurityAction**(`listener`): () => `void`
+
+Subscribes to every recorded security action (for example, to email the affected user).
+Returns the unsubscribe function. A throwing listener is logged and never fails the action.
+
+## Parameters
+
+### listener
+
+[`SecurityActionListener`](../type-aliases/SecurityActionListener.md)
+
+## Returns
+
+() => `void`

package/src/docs/versioned/57.20.0/reference/generated/api/functions/orgContextMiddleware.md

@@ -0,0 +1,13 @@
+> **orgContextMiddleware**(`options?`): `RequestHandler`
+
+## Parameters
+
+### options?
+
+#### required?
+
+`boolean`
+
+## Returns
+
+`RequestHandler`