@terreno/mcp 57.2.0 → 57.4.0

package/dist/docs/versioned/57.2.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)

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/BackgroundTaskModel.md

@@ -0,0 +1,51 @@
+## Extends
+
+- `Model`\<[`BackgroundTaskDocument`](BackgroundTaskDocument.md), `Record`\<`string`, `never`\>, [`BackgroundTaskMethods`](BackgroundTaskMethods.md)\>.[`BackgroundTaskStatics`](BackgroundTaskStatics.md)
+
+## Constructors
+
+### Constructor
+
+> **new BackgroundTaskModel**\<`DocType`\>(`doc?`, `fields?`, `options?`): `Document`\<`unknown`, `Record`\<`string`, `never`\>, [`BackgroundTaskDocument`](BackgroundTaskDocument.md), \{ \}, `DefaultSchemaOptions`\> & `Omit`\<[`BackgroundTaskDocument`](BackgroundTaskDocument.md) & `Required`\<\{ \}\> & `object`, `"id"` \| keyof BackgroundTaskMethods\> & `HydratedDocumentOverrides`\<[`BackgroundTaskMethods`](BackgroundTaskMethods.md) & `object`\>
+
+#### Parameters
+
+##### doc?
+
+`DocType`
+
+##### fields?
+
+`any`
+
+##### options?
+
+`AnyObject`
+
+#### Returns
+
+`Document`\<`unknown`, `Record`\<`string`, `never`\>, [`BackgroundTaskDocument`](BackgroundTaskDocument.md), \{ \}, `DefaultSchemaOptions`\> & `Omit`\<[`BackgroundTaskDocument`](BackgroundTaskDocument.md) & `Required`\<\{ \}\> & `object`, `"id"` \| keyof BackgroundTaskMethods\> & `HydratedDocumentOverrides`\<[`BackgroundTaskMethods`](BackgroundTaskMethods.md) & `object`\>
+
+#### Inherited from
+
+`Model<BackgroundTaskDocument, Record<string, never>, BackgroundTaskMethods>.constructor`
+
+## Properties
+
+### checkCancellation
+
+> **checkCancellation**: (`taskId`) => `Promise`\<`void`\>
+
+#### Parameters
+
+##### taskId
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`BackgroundTaskStatics`](BackgroundTaskStatics.md).[`checkCancellation`](BackgroundTaskStatics.md#checkcancellation)

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/BetterAuthConfig.md

@@ -0,0 +1,83 @@
+Configuration options for Better Auth integration.
+
+## Properties
+
+### appleOAuth?
+
+> `optional` **appleOAuth?**: [`BetterAuthOAuthProvider`](BetterAuthOAuthProvider.md)
+
+Apple OAuth provider configuration.
+
+***
+
+### basePath?
+
+> `optional` **basePath?**: `string`
+
+Base path for Better Auth routes.
+
+#### Default
+
+```ts
+"/api/auth"
+```
+
+***
+
+### baseURL?
+
+> `optional` **baseURL?**: `string`
+
+Base URL for the auth server.
+If not provided, falls back to BETTER_AUTH_URL environment variable.
+
+***
+
+### crossDomainCookies?
+
+> `optional` **crossDomainCookies?**: `boolean`
+
+Allow credential cookies when the frontend and API are hosted on different sites.
+Enables `SameSite=None; Secure` cookie attributes. Keep disabled for local HTTP.
+
+***
+
+### enabled
+
+> **enabled**: `boolean`
+
+Whether Better Auth is enabled for this server.
+
+***
+
+### githubOAuth?
+
+> `optional` **githubOAuth?**: [`BetterAuthOAuthProvider`](BetterAuthOAuthProvider.md)
+
+GitHub OAuth provider configuration.
+
+***
+
+### googleOAuth?
+
+> `optional` **googleOAuth?**: [`BetterAuthOAuthProvider`](BetterAuthOAuthProvider.md)
+
+Google OAuth provider configuration.
+
+***
+
+### secret?
+
+> `optional` **secret?**: `string`
+
+Secret key for Better Auth session encryption.
+If not provided, falls back to BETTER_AUTH_SECRET environment variable.
+
+***
+
+### trustedOrigins?
+
+> `optional` **trustedOrigins?**: `string`[]
+
+Trusted origins for CORS and redirect validation.
+Include your app's deep link schemes (e.g., "terreno://", "exp://").

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/BetterAuthSocketOptions.md

@@ -0,0 +1,19 @@
+Options for the Better Auth session validator.
+
+## Properties
+
+### auth
+
+> **auth**: `Auth`
+
+The instance returned by `createBetterAuth`.
+
+***
+
+### userModel?
+
+> `optional` **userModel?**: [`UserModel`](UserModel.md)
+
+Optional application user model. When provided, the Better Auth user is resolved to
+the app user (via `betterAuthId`) so `decodedToken.id`/`admin` match the identity the
+REST layer uses. Without it, the Better Auth user id is used and `admin` is false.

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/CollectionActionConfig.md

@@ -0,0 +1,141 @@
+## Extends
+
+- `BaseActionConfig`\<`TBody`, `TQuery`, `TResponse`\>
+
+## Type Parameters
+
+### TBody
+
+`TBody`
+
+### TQuery
+
+`TQuery`
+
+### TResponse
+
+`TResponse`
+
+## Properties
+
+### access?
+
+> `optional` **access?**: `object`
+
+#### action
+
+> **action**: `string`
+
+#### resource
+
+> **resource**: `string`
+
+#### Inherited from
+
+`BaseActionConfig.access`
+
+***
+
+### body?
+
+> `optional` **body?**: `ZodType`\<`TBody`, `unknown`, `$ZodTypeInternals`\<`TBody`, `unknown`\>\>
+
+#### Inherited from
+
+`BaseActionConfig.body`
+
+***
+
+### description?
+
+> `optional` **description?**: `string`
+
+#### Inherited from
+
+`BaseActionConfig.description`
+
+***
+
+### handler
+
+> **handler**: (`ctx`) => `TResponse` \| `Promise`\<`TResponse`\>
+
+#### Parameters
+
+##### ctx
+
+`Omit`\<[`ActionContext`](ActionContext.md)\<`never`, `TBody`, `TQuery`\>, `"doc"`\>
+
+#### Returns
+
+`TResponse` \| `Promise`\<`TResponse`\>
+
+***
+
+### method
+
+> **method**: `"GET"` \| `"POST"`
+
+#### Inherited from
+
+`BaseActionConfig.method`
+
+***
+
+### permissions?
+
+> `optional` **permissions?**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]
+
+#### Inherited from
+
+`BaseActionConfig.permissions`
+
+***
+
+### query?
+
+> `optional` **query?**: `ZodType`\<`TQuery`, `unknown`, `$ZodTypeInternals`\<`TQuery`, `unknown`\>\>
+
+#### Inherited from
+
+`BaseActionConfig.query`
+
+***
+
+### response?
+
+> `optional` **response?**: `ZodType`\<`TResponse`, `unknown`, `$ZodTypeInternals`\<`TResponse`, `unknown`\>\>
+
+#### Inherited from
+
+`BaseActionConfig.response`
+
+***
+
+### status?
+
+> `optional` **status?**: `number`
+
+#### Inherited from
+
+`BaseActionConfig.status`
+
+***
+
+### summary?
+
+> `optional` **summary?**: `string`
+
+#### Inherited from
+
+`BaseActionConfig.summary`
+
+***
+
+### tag?
+
+> `optional` **tag?**: `string`
+
+#### Inherited from
+
+`BaseActionConfig.tag`

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/CompactTombstonesResult.md

@@ -0,0 +1,23 @@
+## Properties
+
+### byCollection
+
+> **byCollection**: `Record`\<`string`, \{ `markers`: `number`; `tombstones`: `number`; \}\>
+
+Per-collection counts of hard-deleted tombstones and scope-move markers.
+
+***
+
+### totalMarkers
+
+> **totalMarkers**: `number`
+
+Total scope-move markers hard-deleted.
+
+***
+
+### totalTombstones
+
+> **totalTombstones**: `number`
+
+Total tombstones hard-deleted.

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/ConfigurationModel.md

@@ -0,0 +1,166 @@
+Convenience type for a Mongoose model with configurationPlugin applied.
+
+Use this when declaring your configuration model to get full type safety:
+```typescript
+export const AppConfig = mongoose.model<AppConfigDocument, ConfigurationModel<AppConfigDocument>>(
+  "AppConfig",
+  appConfigSchema,
+);
+// Then call:
+const name = await AppConfig.getConfig("general.appName"); // typed as string
+const full = await AppConfig.getConfig(); // typed as AppConfigDocument
+```
+
+## Extends
+
+- `Model`\<`T`\>.[`ConfigurationStatics`](ConfigurationStatics.md)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Constructors
+
+### Constructor
+
+> **new ConfigurationModel**\<`DocType`\>(`doc?`, `fields?`, `options?`): `Document`\<`unknown`, \{ \}, `T`, \{ \}, `DefaultSchemaOptions`\> & `Require_id`\<`T`\> & `object` & `AddDefaultId`\<`T`, \{ \}, `DefaultSchemaOptions`\>
+
+#### Parameters
+
+##### doc?
+
+`DocType`
+
+##### fields?
+
+`any`
+
+##### options?
+
+`AnyObject`
+
+#### Returns
+
+`Document`\<`unknown`, \{ \}, `T`, \{ \}, `DefaultSchemaOptions`\> & `Require_id`\<`T`\> & `object` & `AddDefaultId`\<`T`, \{ \}, `DefaultSchemaOptions`\>
+
+#### Inherited from
+
+`Model<T>.constructor`
+
+## Methods
+
+### getConfig()
+
+#### Call Signature
+
+> **getConfig**(): `Promise`\<`T` & `Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\>\>
+
+Get the full singleton configuration document.
+
+##### Returns
+
+`Promise`\<`T` & `Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\>\>
+
+##### Inherited from
+
+[`ConfigurationStatics`](ConfigurationStatics.md).[`getConfig`](ConfigurationStatics.md#getconfig)
+
+#### Call Signature
+
+> **getConfig**\<`P`\>(`key`): `Promise`\<[`PathValue`](../type-aliases/PathValue.md)\<`T`, `P`\>\>
+
+Get a specific value by dot-notation key.
+
+##### Type Parameters
+
+###### P
+
+`P` *extends* `string`
+
+##### Parameters
+
+###### key
+
+`P`
+
+##### Returns
+
+`Promise`\<[`PathValue`](../type-aliases/PathValue.md)\<`T`, `P`\>\>
+
+##### Inherited from
+
+[`ConfigurationStatics`](ConfigurationStatics.md).[`getConfig`](ConfigurationStatics.md#getconfig)
+
+***
+
+### getSecretFields()
+
+> **getSecretFields**(): [`SecretFieldMeta`](SecretFieldMeta.md)[]
+
+Get secret field metadata discovered from the schema.
+
+#### Returns
+
+[`SecretFieldMeta`](SecretFieldMeta.md)[]
+
+#### Inherited from
+
+[`ConfigurationStatics`](ConfigurationStatics.md).[`getSecretFields`](ConfigurationStatics.md#getsecretfields)
+
+***
+
+### resolveSecrets()
+
+> **resolveSecrets**(`provider?`): `Promise`\<`Map`\<`string`, `string`\>\>
+
+Resolve all secret field values from a provider.
+Uses the provider passed here, or falls back to the one configured in the plugin options.
+Returns an **in-memory** map of path -> value for programmatic use (startup
+self-checks, request-time resolution).
+
+This method never persists resolved values. Secret material must never be
+written to the configuration document.
+
+#### Parameters
+
+##### provider?
+
+[`SecretProvider`](SecretProvider.md)
+
+#### Returns
+
+`Promise`\<`Map`\<`string`, `string`\>\>
+
+#### Inherited from
+
+[`ConfigurationStatics`](ConfigurationStatics.md).[`resolveSecrets`](ConfigurationStatics.md#resolvesecrets)
+
+***
+
+### updateConfig()
+
+> **updateConfig**(`updates`): `Promise`\<`T` & `Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\>\>
+
+Update the singleton configuration document.
+
+The patch is flattened into MongoDB dotted paths and applied with
+`findOneAndUpdate({$set})`. This preserves sibling fields inside nested
+subdocuments when a partial nested patch is supplied, and tolerates legacy /
+out-of-schema fields already persisted on the document (unlike a full
+`doc.save()`, which throws under `strict: "throw"`).
+
+#### Parameters
+
+##### updates
+
+[`DeepPartial`](../type-aliases/DeepPartial.md)\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` & `Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\>\>
+
+#### Inherited from
+
+[`ConfigurationStatics`](ConfigurationStatics.md).[`updateConfig`](ConfigurationStatics.md#updateconfig)

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/ConsentFormModel.md

@@ -0,0 +1,79 @@
+## Extends
+
+- `Model`\<[`ConsentFormDocument`](ConsentFormDocument.md), `object`, [`ConsentFormMethods`](../type-aliases/ConsentFormMethods.md)\>.[`ConsentFormStatics`](ConsentFormStatics.md)
+
+## Constructors
+
+### Constructor
+
+> **new ConsentFormModel**\<`DocType`\>(`doc?`, `fields?`, `options?`): `Document`\<`unknown`, `object`, [`ConsentFormDocument`](ConsentFormDocument.md), \{ \}, `DefaultSchemaOptions`\> & [`ConsentFormDocument`](ConsentFormDocument.md) & `Required`\<\{ \}\> & `object` & `object`
+
+#### Parameters
+
+##### doc?
+
+`DocType`
+
+##### fields?
+
+`any`
+
+##### options?
+
+`AnyObject`
+
+#### Returns
+
+`Document`\<`unknown`, `object`, [`ConsentFormDocument`](ConsentFormDocument.md), \{ \}, `DefaultSchemaOptions`\> & [`ConsentFormDocument`](ConsentFormDocument.md) & `Required`\<\{ \}\> & `object` & `object`
+
+#### Inherited from
+
+`mongoose.Model<ConsentFormDocument, object, ConsentFormMethods>.constructor`
+
+## Methods
+
+### findExactlyOne()
+
+> **findExactlyOne**(`query`, `errorArgs?`): `Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`ConsentFormDocument`](ConsentFormDocument.md)\>
+
+#### Parameters
+
+##### query
+
+`Record`\<`string`, `unknown`\>
+
+##### errorArgs?
+
+`Partial`\<[`APIErrorOptions`](APIErrorOptions.md)\>
+
+#### Returns
+
+`Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`ConsentFormDocument`](ConsentFormDocument.md)\>
+
+#### Inherited from
+
+[`ConsentFormStatics`](ConsentFormStatics.md).[`findExactlyOne`](ConsentFormStatics.md#findexactlyone)
+
+***
+
+### findOneOrNone()
+
+> **findOneOrNone**(`query`, `errorArgs?`): `Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`ConsentFormDocument`](ConsentFormDocument.md) \| `null`\>
+
+#### Parameters
+
+##### query
+
+`Record`\<`string`, `unknown`\>
+
+##### errorArgs?
+
+`Partial`\<[`APIErrorOptions`](APIErrorOptions.md)\>
+
+#### Returns
+
+`Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & [`ConsentFormDocument`](ConsentFormDocument.md) \| `null`\>
+
+#### Inherited from
+
+[`ConsentFormStatics`](ConsentFormStatics.md).[`findOneOrNone`](ConsentFormStatics.md#findoneornone)