@terreno/mcp 0.21.0 → 0.22.0

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConfigurationAppOptions.md

@@ -0,0 +1,51 @@
+Options for ConfigurationApp.
+
+## Properties
+
+### basePath?
+
+> `optional` **basePath?**: `string`
+
+Base path for configuration routes. Defaults to "/configuration".
+
+***
+
+### fieldOverrides?
+
+> `optional` **fieldOverrides?**: `Record`\<`string`, \{ `widget?`: `string`; \}\>
+
+Per-field widget overrides (e.g., {"ai.systemPrompt": "markdown"}).
+
+***
+
+### model
+
+> **model**: `Model`\<`any`\>
+
+The Mongoose model with configurationPlugin applied.
+
+***
+
+### permissions?
+
+> `optional` **permissions?**: [`ConfigurationPermissions`](ConfigurationPermissions.md)
+
+Per-route permission overrides. Defaults to admin-only for every route when
+omitted. Supply terreno permission functions (e.g. `[IsStaff]`) to expose
+configuration to a consumer's own permission system.
+
+***
+
+### postUpdate?
+
+> `optional` **postUpdate?**: [`ConfigurationPostUpdateHook`](../type-aliases/ConfigurationPostUpdateHook.md)
+
+Hook run after an update is applied (audit logging).
+
+***
+
+### preUpdate?
+
+> `optional` **preUpdate?**: [`ConfigurationPreUpdateHook`](../type-aliases/ConfigurationPreUpdateHook.md)
+
+Hook run before an update is applied (validation/normalization).

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConfigurationMetaResponse.md

@@ -0,0 +1,7 @@
+The config metadata response shape sent to the frontend.
+
+## Properties
+
+### sections
+
+> **sections**: `ConfigSectionMeta`[]

package/dist/docs/versioned/0.21.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`, \{ \}, \{ \}\> & `Require_id`\<`T`\> *extends* `object` ? `object` & `Require_id`\<`T`\> : `Require_id`\<`T`\> & `object`
+
+#### Parameters
+
+##### doc?
+
+`DocType`
+
+##### fields?
+
+`any`
+
+##### options?
+
+`boolean` \| `AnyObject`
+
+#### Returns
+
+`Document`\<`unknown`, \{ \}, `T`, \{ \}, \{ \}\> & `Require_id`\<`T`\> *extends* `object` ? `object` & `Require_id`\<`T`\> : `Require_id`\<`T`\> & `object`
+
+#### 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/0.21.0/reference/generated/api/interfaces/ConfigurationPermissions.md

@@ -0,0 +1,45 @@
+Per-route permission overrides for ConfigurationApp. Each value is an array of
+terreno permission functions ([PermissionMethod](../type-aliases/PermissionMethod.md)), AND-combined like
+`modelRouter` permissions. When a route is omitted, the default admin-only
+guard applies.
+
+## Example
+
+```typescript
+permissions: {
+  read: [IsStaff],
+  update: [IsSuperUser],
+}
+```
+
+## Properties
+
+### listSecrets?
+
+> `optional` **listSecrets?**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]
+
+Guards `POST {basePath}/list-secrets` and `/validate-secrets`.
+
+***
+
+### meta?
+
+> `optional` **meta?**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]
+
+Guards `GET {basePath}/meta` (schema metadata).
+
+***
+
+### read?
+
+> `optional` **read?**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]
+
+Guards `GET {basePath}` (current values).
+
+***
+
+### update?
+
+> `optional` **update?**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`unknown`\>[]
+
+Guards `PATCH {basePath}` (update values).

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConfigurationPluginOptions.md

@@ -0,0 +1,30 @@
+Options passed to configurationPlugin.
+
+## Properties
+
+### enforceSingletonIndex?
+
+> `optional` **enforceSingletonIndex?**: `boolean`
+
+When `true`, adds a `_singleton` sentinel field with a unique index to
+enforce the singleton constraint at the database level.
+
+Defaults to `false`. Leave this off when the consuming app already enforces
+a single non-deleted document via the pre-save guard (the default behavior)
+or via its own indexes/soft-delete plugin, to avoid double-enforcement and
+conflicting indexes.
+
+#### Default Value
+
+```ts
+false
+```
+
+***
+
+### secretProvider?
+
+> `optional` **secretProvider?**: [`SecretProvider`](SecretProvider.md)
+
+Secret provider used when resolveSecrets() is called without an explicit provider.
+Typically set during app startup so the model can resolve secrets on demand.

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConfigurationStatics.md

@@ -0,0 +1,107 @@
+Static methods added by configurationPlugin to the Mongoose model.
+
+## Extended by
+
+- [`ConfigurationModel`](ConfigurationModel.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## 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`\>, \{ \}\>\>
+
+#### 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`\>\>
+
+***
+
+### getSecretFields()
+
+> **getSecretFields**(): [`SecretFieldMeta`](SecretFieldMeta.md)[]
+
+Get secret field metadata discovered from the schema.
+
+#### Returns
+
+[`SecretFieldMeta`](SecretFieldMeta.md)[]
+
+***
+
+### 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`\>\>
+
+***
+
+### 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`\>, \{ \}\>\>

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConsentAppOptions.md

@@ -0,0 +1,85 @@
+## Properties
+
+### aiConfig?
+
+> `optional` **aiConfig?**: `object`
+
+#### generateContent
+
+> **generateContent**: (`params`) => `Promise`\<`string`\>
+
+##### Parameters
+
+###### params
+
+###### description
+
+`string`
+
+###### locale
+
+`string`
+
+###### type
+
+`string`
+
+##### Returns
+
+`Promise`\<`string`\>
+
+#### translateContent
+
+> **translateContent**: (`params`) => `Promise`\<`string`\>
+
+##### Parameters
+
+###### params
+
+###### content
+
+`string`
+
+###### fromLocale
+
+`string`
+
+###### toLocale
+
+`string`
+
+##### Returns
+
+`Promise`\<`string`\>
+
+***
+
+### auditTrail?
+
+> `optional` **auditTrail?**: `boolean`
+
+***
+
+### resolveConsentForms?
+
+> `optional` **resolveConsentForms?**: (`user`, `forms`) => [`ConsentFormDocument`](ConsentFormDocument.md)[] \| `Promise`\<[`ConsentFormDocument`](ConsentFormDocument.md)[]\>
+
+#### Parameters
+
+##### user
+
+[`User`](User.md)
+
+##### forms
+
+[`ConsentFormDocument`](ConsentFormDocument.md)[]
+
+#### Returns
+
+[`ConsentFormDocument`](ConsentFormDocument.md)[] \| `Promise`\<[`ConsentFormDocument`](ConsentFormDocument.md)[]\>
+
+***
+
+### supportedLocales?
+
+> `optional` **supportedLocales?**: `string`[]

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConsentFormCheckbox.md

@@ -0,0 +1,17 @@
+## Properties
+
+### confirmationPrompt?
+
+> `optional` **confirmationPrompt?**: `string`
+
+***
+
+### label
+
+> **label**: `string`
+
+***
+
+### required
+
+> **required**: `boolean`

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConsentFormDefinition.md

@@ -0,0 +1,83 @@
+## Properties
+
+### agreeButtonText?
+
+> `optional` **agreeButtonText?**: `string`
+
+***
+
+### allowDecline?
+
+> `optional` **allowDecline?**: `boolean`
+
+***
+
+### captureSignature?
+
+> `optional` **captureSignature?**: `boolean`
+
+***
+
+### checkboxes?
+
+> `optional` **checkboxes?**: `object`[]
+
+#### confirmationPrompt?
+
+> `optional` **confirmationPrompt?**: `string`
+
+#### label
+
+> **label**: `string`
+
+#### required?
+
+> `optional` **required?**: `boolean`
+
+***
+
+### content
+
+> **content**: `Record`\<`string`, `string`\>
+
+***
+
+### declineButtonText?
+
+> `optional` **declineButtonText?**: `string`
+
+***
+
+### defaultLocale?
+
+> `optional` **defaultLocale?**: `string`
+
+***
+
+### order?
+
+> `optional` **order?**: `number`
+
+***
+
+### required?
+
+> `optional` **required?**: `boolean`
+
+***
+
+### requireScrollToBottom?
+
+> `optional` **requireScrollToBottom?**: `boolean`
+
+***
+
+### title
+
+> **title**: `string`
+
+***
+
+### type
+
+> **type**: [`ConsentFormType`](../type-aliases/ConsentFormType.md)

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ConsentFormDocument.md

@@ -0,0 +1,123 @@
+## Extends
+
+- `Document`
+
+## Properties
+
+### \_id
+
+> **\_id**: `ObjectId`
+
+This documents _id.
+
+#### Overrides
+
+`mongoose.Document._id`
+
+***
+
+### active
+
+> **active**: `boolean`
+
+***
+
+### agreeButtonText
+
+> **agreeButtonText**: `string`
+
+***
+
+### allowDecline
+
+> **allowDecline**: `boolean`
+
+***
+
+### captureSignature
+
+> **captureSignature**: `boolean`
+
+***
+
+### checkboxes
+
+> **checkboxes**: [`ConsentFormCheckbox`](ConsentFormCheckbox.md)[]
+
+***
+
+### content
+
+> **content**: `Map`\<`string`, `string`\>
+
+***
+
+### created
+
+> **created**: `Date`
+
+***
+
+### declineButtonText
+
+> **declineButtonText**: `string`
+
+***
+
+### defaultLocale
+
+> **defaultLocale**: `string`
+
+***
+
+### deleted
+
+> **deleted**: `boolean`
+
+***
+
+### order
+
+> **order**: `number`
+
+***
+
+### required
+
+> **required**: `boolean`
+
+***
+
+### requireScrollToBottom
+
+> **requireScrollToBottom**: `boolean`
+
+***
+
+### slug
+
+> **slug**: `string`
+
+***
+
+### title
+
+> **title**: `string`
+
+***
+
+### type
+
+> **type**: [`ConsentFormType`](../type-aliases/ConsentFormType.md)
+
+***
+
+### updated
+
+> **updated**: `Date`
+
+***
+
+### version
+
+> **version**: `number`