@terreno/mcp 0.23.0 → 0.23.1

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConfigurationPreUpdateHook.md

@@ -0,0 +1,20 @@
+> **ConfigurationPreUpdateHook** = (`body`, `req`) => `Record`\<`string`, `unknown`\> \| `Promise`\<`Record`\<`string`, `unknown`\>\>
+
+Hook invoked before a configuration update is applied. Receives the incoming
+(already system-field- and secret-field-stripped) body and the request, and
+returns the body to apply. Use it to validate or normalize input. Throw an
+[APIError](../classes/APIError.md) to reject the update.
+
+## Parameters
+
+### body
+
+`Record`\<`string`, `unknown`\>
+
+### req
+
+`express.Request`
+
+## Returns
+
+`Record`\<`string`, `unknown`\> \| `Promise`\<`Record`\<`string`, `unknown`\>\>

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConsentFormMethods.md

@@ -0,0 +1 @@
+> **ConsentFormMethods** = `object`

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConsentFormType.md

@@ -0,0 +1 @@
+> **ConsentFormType** = `"agreement"` \| `"privacy"` \| `"hipaa"` \| `"research"` \| `"terms"` \| `"custom"`

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/DeepPartial.md

@@ -0,0 +1,9 @@
+> **DeepPartial**\<`T`\> = `{ [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K] }`
+
+Deeply partial version of T, for use in updateConfig.
+
+## Type Parameters
+
+### T
+
+`T`

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/GooseRESTOptions.md

@@ -0,0 +1,7 @@
+> **GooseRESTOptions**\<`T`\> = [`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T`

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/JSONPrimitive.md

@@ -0,0 +1 @@
+> **JSONPrimitive** = `string` \| `number` \| `boolean` \| `null`

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/JSONValue.md

@@ -0,0 +1 @@
+> **JSONValue** = [`JSONPrimitive`](JSONPrimitive.md) \| [`JSONObject`](../interfaces/JSONObject.md) \| [`JSONArray`](../interfaces/JSONArray.md)

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/PathValue.md

@@ -0,0 +1,19 @@
+> **PathValue**\<`T`, `P`\> = `P` *extends* `` `${infer K}.${infer Rest}` `` ? `K` *extends* keyof `T` ? `PathValue`\<`NonNullable`\<`T`\[`K`\]\>, `Rest`\> : `never` : `P` *extends* keyof `T` ? `T`\[`P`\] : `never`
+
+The value type at a dot-notation path P within type T.
+
+## Type Parameters
+
+### T
+
+`T`
+
+### P
+
+`P` *extends* `string`
+
+## Example
+
+```ts
+PathValue<{a: {b: string}}, "a.b"> = string
+```

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/Paths.md

@@ -0,0 +1,15 @@
+> **Paths**\<`T`\> = \{ \[K in keyof T & string\]: T\[K\] extends object ? K \| \`$\{K\}.$\{Paths\<T\[K\]\>\}\` : K \}\[keyof `T` & `string`\]
+
+All dot-notation paths for a type T.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Example
+
+```ts
+Paths<{a: {b: string}; c: number}> = "a" | "a.b" | "c"
+```

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/PermissionMethod.md

@@ -0,0 +1,25 @@
+> **PermissionMethod**\<`T`\> = (`method`, `user?`, `obj?`) => `boolean` \| `Promise`\<`boolean`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### method
+
+[`RESTMethod`](RESTMethod.md)
+
+### user?
+
+[`User`](../interfaces/User.md)
+
+### obj?
+
+`T`
+
+## Returns
+
+`boolean` \| `Promise`\<`boolean`\>

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/RESTMethod.md

@@ -0,0 +1,17 @@
+> **RESTMethod** = `"list"` \| `"create"` \| `"read"` \| `"update"` \| `"delete"`
+
+## Param
+
+**a**
+
+the first number
+
+## Param
+
+**b**
+
+the second number
+
+## Returns
+
+The sum of `a` and `b`

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/RequestContextAttributes.md

@@ -0,0 +1 @@
+> **RequestContextAttributes** = `Record`\<`string`, `string`\>

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ScriptArgValue.md

@@ -0,0 +1,3 @@
+> **ScriptArgValue** = `string` \| `number` \| `boolean` \| `string`[]
+
+A single parsed argument value. Repeated flags collapse into a string array.

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ScriptRunner.md

@@ -0,0 +1,15 @@
+> **ScriptRunner** = (`wetRun`, `ctx?`) => `Promise`\<[`ScriptResult`](../interfaces/ScriptResult.md)\>
+
+## Parameters
+
+### wetRun
+
+`boolean`
+
+### ctx?
+
+[`ScriptContext`](../interfaces/ScriptContext.md)
+
+## Returns
+
+`Promise`\<[`ScriptResult`](../interfaces/ScriptResult.md)\>

package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/VersionCheckStatus.md

@@ -0,0 +1 @@
+> **VersionCheckStatus** = `"ok"` \| `"warning"` \| `"required"`

package/src/docs/versioned/0.23.0/reference/generated/api/variables/ACTION_NAME_PATTERN.md

@@ -0,0 +1 @@
+> `const` **ACTION\_NAME\_PATTERN**: `RegExp`

package/src/docs/versioned/0.23.0/reference/generated/api/variables/BackgroundTask.md

@@ -0,0 +1 @@
+> `const` **BackgroundTask**: [`BackgroundTaskModel`](../interfaces/BackgroundTaskModel.md)

package/src/docs/versioned/0.23.0/reference/generated/api/variables/Config.md

@@ -0,0 +1,244 @@
+> `const` **Config**: `object`
+
+## Type Declaration
+
+### clearOverrides
+
+> **clearOverrides**: () => `void`
+
+Clears every override. Call from afterEach in tests.
+
+#### Returns
+
+`void`
+
+### clearRegistryForTesting
+
+> **clearRegistryForTesting**: () => `void`
+
+Removes every registered key. Intended for tests.
+
+#### Returns
+
+`void`
+
+### get
+
+> **get**: (`key`) => `string` \| `undefined` = `getString`
+
+Returns the configured string value for `key`, applying the resolution
+order documented at the top of this file. Returns `undefined` if no
+source supplies a value and no default was registered.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+### getBoolean
+
+> **getBoolean**: (`key`) => `boolean`
+
+Returns true iff the string value equals "true" (case-insensitive). Mirrors
+the existing `process.env.X === "true"` idiom.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`boolean`
+
+### getDefault
+
+> **getDefault**: (`key`) => `string` \| `undefined`
+
+Returns the registered default (if any) for `key`.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+### getJSON
+
+> **getJSON**: \<`T`\>(`key`) => `T` \| `undefined`
+
+Parses a JSON-encoded config value. Returns undefined if unset; throws on
+malformed JSON so misconfiguration fails loud at the call site rather than
+producing silent runtime errors later.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`T` \| `undefined`
+
+### getNumber
+
+> **getNumber**: (`key`) => `number` \| `undefined`
+
+Returns the configured value as a number. Throws if a value is present but
+not finite — silent NaN propagation has bitten apps before.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`number` \| `undefined`
+
+### getRegisteredKeys
+
+> **getRegisteredKeys**: () => `string`[]
+
+Returns the registered keys, sorted. Used by the admin UI.
+
+#### Returns
+
+`string`[]
+
+### getRegistration
+
+> **getRegistration**: (`key`) => [`ConfigRegistration`](../interfaces/ConfigRegistration.md) \| `undefined`
+
+Returns the registration metadata for `key`, including secret/description.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+[`ConfigRegistration`](../interfaces/ConfigRegistration.md) \| `undefined`
+
+### isRegistered
+
+> **isRegistered**: (`key`) => `boolean`
+
+Returns true if `key` was registered.
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`boolean`
+
+### refresh
+
+> **refresh**: () => `Promise`\<`void`\>
+
+Reloads the in-memory cache by invoking the registered env loader. No-op
+(clears cache) if no loader has been registered.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+### register
+
+> **register**: (`key`, `registration`) => `void`
+
+Registers a configuration key, its default, and metadata. Re-registration
+of the same key throws so duplicates surface at boot.
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### registration?
+
+[`ConfigRegistration`](../interfaces/ConfigRegistration.md) = `{}`
+
+#### Returns
+
+`void`
+
+### setCachedEnv
+
+> **setCachedEnv**: (`env`) => `void`
+
+Replaces the cache directly. Intended for the envConfigurationPlugin and tests.
+
+#### Parameters
+
+##### env
+
+`Record`\<`string`, `string`\> \| `null`
+
+#### Returns
+
+`void`
+
+### setEnvLoader
+
+> **setEnvLoader**: (`loader`) => `void`
+
+Registers a loader that returns the env map (typically backed by an
+admin-editable Mongoose document). Called once at app startup before
+the first `Config.refresh()`.
+
+#### Parameters
+
+##### loader
+
+(() => `Promise`\<`Record`\<`string`, `string`\>\>) \| `null`
+
+#### Returns
+
+`void`
+
+### setOverride
+
+> **setOverride**: (`key`, `value`) => `void`
+
+Sets an in-process override for `key`. Highest precedence — wins over
+the cached env map. Intended for tests and bootstrap helpers.
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### value
+
+`string` \| `undefined`
+
+#### Returns
+
+`void`

package/src/docs/versioned/0.23.0/reference/generated/api/variables/ConsentForm.md

@@ -0,0 +1 @@
+> `const` **ConsentForm**: [`ConsentFormModel`](../interfaces/ConsentFormModel.md)

package/src/docs/versioned/0.23.0/reference/generated/api/variables/ConsentResponse.md

@@ -0,0 +1 @@
+> `const` **ConsentResponse**: [`ConsentResponseModel`](../interfaces/ConsentResponseModel.md)

package/src/docs/versioned/0.23.0/reference/generated/api/variables/MAX_DOCUMENT_SUBSCRIPTIONS.md

@@ -0,0 +1 @@
+> `const` **MAX\_DOCUMENT\_SUBSCRIPTIONS**: `500` = `500`

package/src/docs/versioned/0.23.0/reference/generated/api/variables/MAX_MODEL_SUBSCRIPTIONS.md

@@ -0,0 +1,4 @@
+> `const` **MAX\_MODEL\_SUBSCRIPTIONS**: `50` = `50`
+
+Caps on per-socket subscriptions. Prevents a malicious or buggy client from
+exhausting server memory by opening unbounded subscriptions.

package/src/docs/versioned/0.23.0/reference/generated/api/variables/MAX_QUERY_SUBSCRIPTIONS.md

@@ -0,0 +1 @@
+> `const` **MAX\_QUERY\_SUBSCRIPTIONS**: `100` = `100`

package/src/docs/versioned/0.23.0/reference/generated/api/variables/Permissions.md

@@ -0,0 +1,109 @@
+> `const` **Permissions**: `object`
+
+## Type Declaration
+
+### IsAdmin
+
+> **IsAdmin**: (`_method`, `user?`) => `boolean`
+
+#### Parameters
+
+##### \_method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+#### Returns
+
+`boolean`
+
+### IsAny
+
+> **IsAny**: () => `boolean`
+
+#### Returns
+
+`boolean`
+
+### IsAuthenticated
+
+> **IsAuthenticated**: (`_method`, `user?`) => `boolean`
+
+#### Parameters
+
+##### \_method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+#### Returns
+
+`boolean`
+
+### IsAuthenticatedOrReadOnly
+
+> **IsAuthenticatedOrReadOnly**: (`method`, `user?`) => `boolean`
+
+#### Parameters
+
+##### method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+#### Returns
+
+`boolean`
+
+### IsOwner
+
+> **IsOwner**: (`_method`, `user?`, `obj?`) => `boolean`
+
+#### Parameters
+
+##### \_method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+##### obj?
+
+`unknown`
+
+#### Returns
+
+`boolean`
+
+### IsOwnerOrReadOnly
+
+> **IsOwnerOrReadOnly**: (`method`, `user?`, `obj?`) => `boolean`
+
+#### Parameters
+
+##### method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+##### user?
+
+[`User`](../interfaces/User.md)
+
+##### obj?
+
+`unknown`
+
+#### Returns
+
+`boolean`

package/src/docs/versioned/0.23.0/reference/generated/api/variables/REQUEST_CONTEXT_ATTRIBUTE_NAMES.md

@@ -0,0 +1,39 @@
+> `const` **REQUEST\_CONTEXT\_ATTRIBUTE\_NAMES**: `object`
+
+Canonical HTTP header names for each correlation field. Use these to propagate context to
+downstream services (pair with [getCurrentRequestContextAttributes](../functions/getCurrentRequestContextAttributes.md)) or to read it from an
+incoming request (pair with [getRequestContextFromAttributes](../functions/getRequestContextFromAttributes.md)).
+
+## Type Declaration
+
+### jobId
+
+> `readonly` **jobId**: `"x-job-id"` = `JOB_ID_HEADER`
+
+### requestId
+
+> `readonly` **requestId**: `"x-request-id"` = `"x-request-id"`
+
+### sessionId
+
+> `readonly` **sessionId**: `"x-session-id"` = `SESSION_ID_HEADER`
+
+### spanId
+
+> `readonly` **spanId**: `"x-span-id"` = `SPAN_ID_HEADER`
+
+### traceId
+
+> `readonly` **traceId**: `"x-trace-id"` = `TRACE_ID_HEADER`
+
+### traceParent
+
+> `readonly` **traceParent**: `"traceparent"` = `TRACE_PARENT_HEADER`
+
+### traceSampled
+
+> `readonly` **traceSampled**: `"x-trace-sampled"` = `TRACE_SAMPLED_HEADER`
+
+### userId
+
+> `readonly` **userId**: `"x-user-id"` = `USER_ID_HEADER`

package/src/docs/versioned/0.23.0/reference/generated/api/variables/VersionConfig.md

@@ -0,0 +1 @@
+> `const` **VersionConfig**: [`VersionConfigModel`](../interfaces/VersionConfigModel.md)

package/src/docs/versioned/0.23.0/reference/generated/api/variables/consentResponsePopulatePaths.md

@@ -0,0 +1,3 @@
+> `const` **consentResponsePopulatePaths**: [`PopulatePath`](../interfaces/PopulatePath.md)[]
+
+Shared populate config for consent response list/read endpoints.

package/src/docs/versioned/0.23.0/reference/generated/api/variables/gooseRestRouter.md

@@ -0,0 +1,85 @@
+> `const` **gooseRestRouter**: \{\<`T`\>(`path`, `model`, `options`): [`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md); \<`T`\>(`model`, `options`): `Router`; \} = `modelRouter`
+
+## Call Signature
+
+> \<`T`\>(`path`, `model`, `options`): [`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md)
+
+Create a set of CRUD routes given a Mongoose model and configuration options.
+
+When called with a path as the first argument, returns a `ModelRouterRegistration` that can be
+passed to `TerrenoApp.register()`.
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### path
+
+`string`
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+### Returns
+
+[`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md)
+
+### Example
+
+```ts
+// Traditional usage (returns express.Router):
+router.use("/todos", modelRouter(Todo, options));
+
+// Registration usage (returns ModelRouterRegistration):
+const todoRouter = modelRouter("/todos", Todo, options);
+app.register(todoRouter);
+```
+
+## Call Signature
+
+> \<`T`\>(`model`, `options`): `Router`
+
+Create a set of CRUD routes given a Mongoose model and configuration options.
+
+When called with a path as the first argument, returns a `ModelRouterRegistration` that can be
+passed to `TerrenoApp.register()`.
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+### Returns
+
+`Router`
+
+### Example
+
+```ts
+// Traditional usage (returns express.Router):
+router.use("/todos", modelRouter(Todo, options));
+
+// Registration usage (returns ModelRouterRegistration):
+const todoRouter = modelRouter("/todos", Todo, options);
+app.register(todoRouter);
+```