@terreno/mcp 57.16.2 → 57.18.0

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

@@ -0,0 +1,156 @@
+## Properties
+
+### emailVerification?
+
+> `optional` **emailVerification?**: `boolean`
+
+Register JWT send-verification and verify-email routes. Default true.
+
+***
+
+### generateJWTPayload?
+
+> `optional` **generateJWTPayload?**: (`user`) => `Record`\<`string`, `unknown`\>
+
+#### Parameters
+
+##### user
+
+[`User`](User.md)
+
+#### Returns
+
+`Record`\<`string`, `unknown`\>
+
+***
+
+### generateRefreshTokenExpiration?
+
+> `optional` **generateRefreshTokenExpiration?**: (`user`) => `number` \| `StringValue` \| `undefined`
+
+#### Parameters
+
+##### user
+
+[`User`](User.md)
+
+#### Returns
+
+`number` \| `StringValue` \| `undefined`
+
+***
+
+### generateTokenExpiration?
+
+> `optional` **generateTokenExpiration?**: (`user`) => `number` \| `StringValue` \| `undefined`
+
+#### Parameters
+
+##### user
+
+[`User`](User.md)
+
+#### Returns
+
+`number` \| `StringValue` \| `undefined`
+
+***
+
+### legacyResetPasswordRoute?
+
+> `optional` **legacyResetPasswordRoute?**: `boolean`
+
+Register the deprecated `POST /resetPassword` RTK compatibility alias.
+Default true. Set false when the host owns that path; `/auth/resetPassword`
+remains available when `passwordReset` is enabled.
+
+***
+
+### passwordReset?
+
+> `optional` **passwordReset?**: `boolean`
+
+Register JWT forgot-password and token-reset routes. Default true.
+
+***
+
+### publicAppUrl?
+
+> `optional` **publicAppUrl?**: `string`
+
+Public web/app origin used in password-reset and verification links.
+
+***
+
+### requireEmailVerification?
+
+> `optional` **requireEmailVerification?**: `boolean`
+
+When true, unverified users receive 403 `email-not-verified` on login. Default false.
+
+***
+
+### sendMail?
+
+> `optional` **sendMail?**: (`message`) => `Promise`\<`void`\>
+
+Deliver recovery mail (forgot password / verify email). Wire to
+`getCommsService().sendMail` when `@terreno/comms` is registered.
+
+#### Parameters
+
+##### message
+
+[`AuthRecoveryMail`](AuthRecoveryMail.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### syncPasswordResetToBetterAuth?
+
+> `optional` **syncPasswordResetToBetterAuth?**: (`user`, `password`) => `Promise`\<`void`\>
+
+After a successful JWT password reset, update the Better Auth credential hash
+and delete that user's Better Auth sessions. TerrenoApp wires this when
+BetterAuthApp is registered.
+
+#### Parameters
+
+##### user
+
+[`User`](User.md)
+
+##### password
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### verifyBetterAuthPassword?
+
+> `optional` **verifyBetterAuthPassword?**: (`user`, `password`) => `Promise`\<[`BetterAuthPasswordCheck`](../type-aliases/BetterAuthPasswordCheck.md)\>
+
+Check a password against the user's Better Auth credential account. `PATCH /auth/me` uses it
+to confirm an email change for a user with no passport password. TerrenoApp wires this when
+BetterAuthApp is registered.
+
+#### Parameters
+
+##### user
+
+[`User`](User.md)
+
+##### password
+
+`string`
+
+#### Returns
+
+`Promise`\<[`BetterAuthPasswordCheck`](../type-aliases/BetterAuthPasswordCheck.md)\>

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

@@ -0,0 +1,32 @@
+## Properties
+
+### html?
+
+> `optional` **html?**: `string`
+
+***
+
+### sensitive?
+
+> `optional` **sensitive?**: `boolean`
+
+True on Terreno's recovery mail: it carries a one-time secret link. Mail transports should
+not store its content; `@terreno/comms` keeps no payload for it in the message log.
+
+***
+
+### subject
+
+> **subject**: `string`
+
+***
+
+### text
+
+> **text**: `string`
+
+***
+
+### to
+
+> **to**: `string`

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

@@ -0,0 +1,57 @@
+## Extends
+
+- `Document`
+
+## Properties
+
+### \_id
+
+> **\_id**: `ObjectId`
+
+This documents _id.
+
+#### Overrides
+
+`mongoose.Document._id`
+
+***
+
+### consumedAt?
+
+> `optional` **consumedAt?**: `Date`
+
+***
+
+### created
+
+> **created**: `Date`
+
+***
+
+### expiresAt
+
+> **expiresAt**: `Date`
+
+***
+
+### tokenHash
+
+> **tokenHash**: `string`
+
+***
+
+### type
+
+> **type**: [`AuthTokenType`](../type-aliases/AuthTokenType.md)
+
+***
+
+### updated
+
+> **updated**: `Date`
+
+***
+
+### userId
+
+> **userId**: `ObjectId`

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

@@ -0,0 +1,171 @@
+## Extends
+
+- `Model`\<[`AuthTokenDocument`](AuthTokenDocument.md), `object`, `AuthTokenMethods`\>.`AuthTokenStatics`
+
+## Constructors
+
+### Constructor
+
+> **new AuthTokenModel**\<`DocType`\>(`doc?`, `fields?`, `options?`): `Document`\<`unknown`, `object`, [`AuthTokenDocument`](AuthTokenDocument.md), \{ \}, `DefaultSchemaOptions`\> & [`AuthTokenDocument`](AuthTokenDocument.md) & `Required`\<\{ \}\> & `object` & `object`
+
+#### Parameters
+
+##### doc?
+
+`DocType`
+
+##### fields?
+
+`any`
+
+##### options?
+
+`AnyObject`
+
+#### Returns
+
+`Document`\<`unknown`, `object`, [`AuthTokenDocument`](AuthTokenDocument.md), \{ \}, `DefaultSchemaOptions`\> & [`AuthTokenDocument`](AuthTokenDocument.md) & `Required`\<\{ \}\> & `object` & `object`
+
+#### Inherited from
+
+`mongoose.Model<AuthTokenDocument, object, AuthTokenMethods>.constructor`
+
+## Properties
+
+### consume
+
+> **consume**: (`this`, `token`, `type`) => `Promise`\<[`AuthTokenDocument`](AuthTokenDocument.md) \| `null`\>
+
+#### Parameters
+
+##### this
+
+`AuthTokenModel`
+
+##### token
+
+`string`
+
+##### type
+
+[`AuthTokenType`](../type-aliases/AuthTokenType.md)
+
+#### Returns
+
+`Promise`\<[`AuthTokenDocument`](AuthTokenDocument.md) \| `null`\>
+
+#### Inherited from
+
+`AuthTokenStatics.consume`
+
+***
+
+### invalidateUnusedFor
+
+> **invalidateUnusedFor**: (`this`, `user`, `type`) => `Promise`\<`void`\>
+
+#### Parameters
+
+##### this
+
+`AuthTokenModel`
+
+##### user
+
+###### _id
+
+\{ `toString`: `string`; \}
+
+###### _id.toString
+
+##### type
+
+[`AuthTokenType`](../type-aliases/AuthTokenType.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+`AuthTokenStatics.invalidateUnusedFor`
+
+***
+
+### issueFor
+
+> **issueFor**: (`this`, `user`, `type`) => `Promise`\<\{ `authToken`: [`AuthTokenDocument`](AuthTokenDocument.md); `token`: `string`; \}\>
+
+#### Parameters
+
+##### this
+
+`AuthTokenModel`
+
+##### user
+
+###### _id
+
+\{ `toString`: `string`; \}
+
+###### _id.toString
+
+##### type
+
+[`AuthTokenType`](../type-aliases/AuthTokenType.md)
+
+#### Returns
+
+`Promise`\<\{ `authToken`: [`AuthTokenDocument`](AuthTokenDocument.md); `token`: `string`; \}\>
+
+#### Inherited from
+
+`AuthTokenStatics.issueFor`
+
+## Methods
+
+### findExactlyOne()
+
+> **findExactlyOne**(`query`, `errorArgs?`): `Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`AuthTokenDocument`](AuthTokenDocument.md)\>
+
+#### Parameters
+
+##### query
+
+`Record`\<`string`, `unknown`\>
+
+##### errorArgs?
+
+`Partial`\<[`APIErrorOptions`](APIErrorOptions.md)\>
+
+#### Returns
+
+`Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`AuthTokenDocument`](AuthTokenDocument.md)\>
+
+#### Inherited from
+
+`AuthTokenStatics.findExactlyOne`
+
+***
+
+### findOneOrNone()
+
+> **findOneOrNone**(`query`, `errorArgs?`): `Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`AuthTokenDocument`](AuthTokenDocument.md) \| `null`\>
+
+#### Parameters
+
+##### query
+
+`Record`\<`string`, `unknown`\>
+
+##### errorArgs?
+
+`Partial`\<[`APIErrorOptions`](APIErrorOptions.md)\>
+
+#### Returns
+
+`Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`AuthTokenDocument`](AuthTokenDocument.md) \| `null`\>
+
+#### Inherited from
+
+`AuthTokenStatics.findOneOrNone`

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

@@ -0,0 +1,49 @@
+The subset of a Socket.io socket the validators need. Lets tests pass a stub.
+
+## Extends
+
+- [`SocketWithDecodedToken`](SocketWithDecodedToken.md)
+
+## Properties
+
+### data?
+
+> `optional` **data?**: [`SocketDataBag`](SocketDataBag.md)
+
+#### Inherited from
+
+[`SocketWithDecodedToken`](SocketWithDecodedToken.md).[`data`](SocketWithDecodedToken.md#data)
+
+***
+
+### decodedToken?
+
+> `optional` **decodedToken?**: [`DecodedRealtimeToken`](DecodedRealtimeToken.md)
+
+#### Inherited from
+
+[`SocketWithDecodedToken`](SocketWithDecodedToken.md).[`decodedToken`](SocketWithDecodedToken.md#decodedtoken)
+
+***
+
+### encodedToken?
+
+> `optional` **encodedToken?**: `string`
+
+***
+
+### handshake
+
+> **handshake**: `object`
+
+#### auth
+
+> **auth**: `object`
+
+##### Index Signature
+
+\[`key`: `string`\]: `unknown`
+
+##### auth.token?
+
+> `optional` **token?**: `string`

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

@@ -0,0 +1,34 @@
+The minimal registry-entry shape the authorized-room emitters need. Both
+`RealtimeRegistryEntry` and `SyncRegistryEntry` satisfy it structurally.
+
+## Properties
+
+### collectionTag?
+
+> `optional` **collectionTag?**: `string`
+
+***
+
+### modelName
+
+> **modelName**: `string`
+
+***
+
+### options
+
+> **options**: `object`
+
+#### permissions
+
+> **permissions**: `object`
+
+##### permissions.read
+
+> **read**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]
+
+***
+
+### routePath?
+
+> `optional` **routePath?**: `string`

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

@@ -0,0 +1,23 @@
+## Properties
+
+### access
+
+> **access**: [`AnyTerrenoAccess`](../type-aliases/AnyTerrenoAccess.md)
+
+***
+
+### roleName?
+
+> `optional` **roleName?**: `string`
+
+***
+
+### userModel
+
+> **userModel**: [`UserModel`](UserModel.md)
+
+***
+
+### wetRun?
+
+> `optional` **wetRun?**: `boolean`

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

@@ -0,0 +1,17 @@
+## Properties
+
+### dryRun
+
+> **dryRun**: `boolean`
+
+***
+
+### matched
+
+> **matched**: `number`
+
+***
+
+### updated
+
+> **updated**: `number`

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

@@ -0,0 +1,141 @@
+## Extends
+
+- `Document`.[`BackgroundTaskMethods`](BackgroundTaskMethods.md)
+
+## Properties
+
+### addLog
+
+> **addLog**: (`this`, `level`, `message`) => `Promise`\<`void`\>
+
+#### Parameters
+
+##### this
+
+`BackgroundTaskDocument`
+
+##### level
+
+`"error"` \| `"info"` \| `"warn"`
+
+##### message
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`BackgroundTaskMethods`](BackgroundTaskMethods.md).[`addLog`](BackgroundTaskMethods.md#addlog)
+
+***
+
+### completedAt?
+
+> `optional` **completedAt?**: `Date`
+
+***
+
+### created
+
+> **created**: `Date`
+
+***
+
+### createdBy?
+
+> `optional` **createdBy?**: `ObjectId`
+
+***
+
+### deleted
+
+> **deleted**: `boolean`
+
+***
+
+### error?
+
+> `optional` **error?**: `string`
+
+***
+
+### isDryRun
+
+> **isDryRun**: `boolean`
+
+***
+
+### logs
+
+> **logs**: `BackgroundTaskLog`[]
+
+***
+
+### progress?
+
+> `optional` **progress?**: `BackgroundTaskProgress`
+
+***
+
+### result?
+
+> `optional` **result?**: `string`[]
+
+***
+
+### startedAt?
+
+> `optional` **startedAt?**: `Date`
+
+***
+
+### status
+
+> **status**: `"pending"` \| `"running"` \| `"completed"` \| `"failed"` \| `"cancelled"`
+
+***
+
+### taskType
+
+> **taskType**: `string`
+
+***
+
+### updated
+
+> **updated**: `Date`
+
+***
+
+### updateProgress
+
+> **updateProgress**: (`this`, `percentage`, `stage?`, `message?`) => `Promise`\<`void`\>
+
+#### Parameters
+
+##### this
+
+`BackgroundTaskDocument`
+
+##### percentage
+
+`number`
+
+##### stage?
+
+`string`
+
+##### message?
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`BackgroundTaskMethods`](BackgroundTaskMethods.md).[`updateProgress`](BackgroundTaskMethods.md#updateprogress)