@terreno/mcp 0.30.0 → 56.0.0-beta.0

package/dist/docs/versioned/0.30.0/reference/generated/api/classes/UnauthorizedError.md

@@ -0,0 +1,165 @@
+401 Unauthorized.
+
+## Extends
+
+- [`APIError`](APIError.md)
+
+## Constructors
+
+### Constructor
+
+> **new UnauthorizedError**(`options`): `UnauthorizedError`
+
+#### Parameters
+
+##### options
+
+[`APIErrorSubclassOptions`](../type-aliases/APIErrorSubclassOptions.md)
+
+#### Returns
+
+`UnauthorizedError`
+
+#### Overrides
+
+[`APIError`](APIError.md).[`constructor`](APIError.md#constructor)
+
+## Properties
+
+### code
+
+> **code**: `string` \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`code`](APIError.md#code)
+
+***
+
+### detail
+
+> **detail**: `string` \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`detail`](APIError.md#detail)
+
+***
+
+### disableExternalErrorTracking?
+
+> `optional` **disableExternalErrorTracking?**: `boolean`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`disableExternalErrorTracking`](APIError.md#disableexternalerrortracking)
+
+***
+
+### id
+
+> **id**: `string` \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`id`](APIError.md#id)
+
+***
+
+### isTerrenoAPIError
+
+> `readonly` **isTerrenoAPIError**: `true` = `true`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`isTerrenoAPIError`](APIError.md#isterrenoapierror)
+
+***
+
+### links
+
+> **links**: \{ `about?`: `string`; `type?`: `string`; \} \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`links`](APIError.md#links)
+
+***
+
+### meta
+
+> **meta**: \{\[`id`: `string`\]: `unknown`; \} \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`meta`](APIError.md#meta)
+
+***
+
+### source
+
+> **source**: \{ `header?`: `string`; `parameter?`: `string`; `pointer?`: `string`; \} \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`source`](APIError.md#source)
+
+***
+
+### status
+
+> **status**: `number`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`status`](APIError.md#status)
+
+## Accessors
+
+### error
+
+#### Get Signature
+
+> **get** **error**(): `unknown`
+
+##### Deprecated
+
+Use the standard `cause` field instead.
+
+##### Returns
+
+`unknown`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`error`](APIError.md#error)
+
+***
+
+### title
+
+#### Get Signature
+
+> **get** **title**(): `string`
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`title`](APIError.md#title)
+
+## Methods
+
+### toJSON()
+
+> **toJSON**(): [`APIErrorBody`](../interfaces/APIErrorBody.md)
+
+#### Returns
+
+[`APIErrorBody`](../interfaces/APIErrorBody.md)
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`toJSON`](APIError.md#tojson)

package/dist/docs/versioned/0.30.0/reference/generated/api/classes/ValidationError.md

@@ -0,0 +1,165 @@
+400 Bad Request with a "ValidationError" type, for request/schema validation failures.
+
+## Extends
+
+- [`APIError`](APIError.md)
+
+## Constructors
+
+### Constructor
+
+> **new ValidationError**(`options`): `ValidationError`
+
+#### Parameters
+
+##### options
+
+[`APIErrorSubclassOptions`](../type-aliases/APIErrorSubclassOptions.md)
+
+#### Returns
+
+`ValidationError`
+
+#### Overrides
+
+[`APIError`](APIError.md).[`constructor`](APIError.md#constructor)
+
+## Properties
+
+### code
+
+> **code**: `string` \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`code`](APIError.md#code)
+
+***
+
+### detail
+
+> **detail**: `string` \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`detail`](APIError.md#detail)
+
+***
+
+### disableExternalErrorTracking?
+
+> `optional` **disableExternalErrorTracking?**: `boolean`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`disableExternalErrorTracking`](APIError.md#disableexternalerrortracking)
+
+***
+
+### id
+
+> **id**: `string` \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`id`](APIError.md#id)
+
+***
+
+### isTerrenoAPIError
+
+> `readonly` **isTerrenoAPIError**: `true` = `true`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`isTerrenoAPIError`](APIError.md#isterrenoapierror)
+
+***
+
+### links
+
+> **links**: \{ `about?`: `string`; `type?`: `string`; \} \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`links`](APIError.md#links)
+
+***
+
+### meta
+
+> **meta**: \{\[`id`: `string`\]: `unknown`; \} \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`meta`](APIError.md#meta)
+
+***
+
+### source
+
+> **source**: \{ `header?`: `string`; `parameter?`: `string`; `pointer?`: `string`; \} \| `undefined`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`source`](APIError.md#source)
+
+***
+
+### status
+
+> **status**: `number`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`status`](APIError.md#status)
+
+## Accessors
+
+### error
+
+#### Get Signature
+
+> **get** **error**(): `unknown`
+
+##### Deprecated
+
+Use the standard `cause` field instead.
+
+##### Returns
+
+`unknown`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`error`](APIError.md#error)
+
+***
+
+### title
+
+#### Get Signature
+
+> **get** **title**(): `string`
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`title`](APIError.md#title)
+
+## Methods
+
+### toJSON()
+
+> **toJSON**(): [`APIErrorBody`](../interfaces/APIErrorBody.md)
+
+#### Returns
+
+[`APIErrorBody`](../interfaces/APIErrorBody.md)
+
+#### Inherited from
+
+[`APIError`](APIError.md).[`toJSON`](APIError.md#tojson)

package/dist/docs/versioned/0.30.0/reference/generated/api/functions/apiUnauthorizedMiddleware.md

@@ -0,0 +1,30 @@
+> **apiUnauthorizedMiddleware**(`err`, `_req`, `res`, `next`): `void`
+
+Converts the bare `Error("Unauthorized")` that Passport throws into a quiet 401.
+
+Only the plain `Error` prototype is matched. An `APIError` carries its own status, code,
+detail, and meta, so one whose title happens to be "Unauthorized" falls through to
+`apiErrorMiddleware`. A domain-specific `Error` subclass with the same message also falls
+through so its own handler can respond.
+
+## Parameters
+
+### err
+
+`Error`
+
+### \_req
+
+`Request`
+
+### res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/dist/docs/versioned/0.30.0/reference/generated/api/functions/envConfigurationPlugin.md

@@ -0,0 +1,11 @@
+> **envConfigurationPlugin**(`schema`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`
+
+## Returns
+
+`void`

package/dist/docs/versioned/0.30.0/reference/generated/api/functions/errorDetail.md

@@ -0,0 +1,15 @@
+> **errorDetail**(`error`): `string`
+
+Extract the fullest human-readable text from an unknown error, for use as the `detail` of a
+wrapper error. An `APIError`'s `message` is exactly its `title`, so `errorMessage` alone would
+drop the per-occurrence text the caller put in `detail`.
+
+## Parameters
+
+### error
+
+`unknown`
+
+## Returns
+
+`string`

package/dist/docs/versioned/0.30.0/reference/generated/api/functions/findOneOrNoneFor.md

@@ -0,0 +1,37 @@
+> **findOneOrNoneFor**\<`T`\>(`model`, `query`, `errorArgs?`): `Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `null`\>
+
+Helper that performs a `findOneOrNone` lookup against any Mongoose model. Returns the matching
+document, `null` if none match, or throws if more than one matches. If the model's schema has
+the [findOneOrNone](findOneOrNone.md) plugin applied, the plugin static is used; otherwise the lookup is
+performed directly via `model.find(...)`. Prefer this helper from framework code where the
+consumer's model may or may not have the plugin installed.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### model
+
+`Model`\<`T`\>
+
+Mongoose Model
+
+### query
+
+`FilterQuery`\<`T`\>
+
+Mongoose query object
+
+### errorArgs?
+
+`Partial`\<[`APIErrorOptions`](../interfaces/APIErrorOptions.md)\>
+
+Optional overrides for the thrown [APIError](../classes/APIError.md) when multiple match
+
+## Returns
+
+`Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `null`\>

package/dist/docs/versioned/0.30.0/reference/generated/api/functions/getAPIErrorBody.md

@@ -0,0 +1,17 @@
+> **getAPIErrorBody**(`error`): `Record`\<`string`, `unknown`\>
+
+Creates an APIError body to send to clients as JSON.
+
+## Parameters
+
+### error
+
+[`APIError`](../classes/APIError.md)
+
+## Returns
+
+`Record`\<`string`, `unknown`\>
+
+## Deprecated
+
+Use `error.toJSON()` instead.

package/dist/docs/versioned/0.30.0/reference/generated/api/functions/withApiErrorHandling.md

@@ -0,0 +1,30 @@
+> **withApiErrorHandling**\<`T`\>(`fn`, `options`): `Promise`\<`T`\>
+
+Wraps an external API call with standardized error handling: failures are normalized
+via normalizeApiError, passed through the optional redactError hook, logged exactly
+once, and rethrown.
+
+In "raw" mode (default) the wrapper logs the normalized shape via the injected logger
+and rethrows the original error. In "apiError" mode the wrapper throws a terreno
+APIError with a stable title (per-occurrence text goes in `detail`) and stays silent
+itself — apiErrorMiddleware logs APIErrors, so logging here too would double-log.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### fn
+
+() => `Promise`\<`T`\>
+
+### options
+
+[`WithApiErrorHandlingOptions`](../interfaces/WithApiErrorHandlingOptions.md)
+
+## Returns
+
+`Promise`\<`T`\>

package/dist/docs/versioned/0.30.0/reference/generated/api/interfaces/APIErrorBody.md

@@ -0,0 +1,77 @@
+## Properties
+
+### code?
+
+> `optional` **code?**: `string`
+
+***
+
+### detail?
+
+> `optional` **detail?**: `string`
+
+***
+
+### disableExternalErrorTracking?
+
+> `optional` **disableExternalErrorTracking?**: `boolean`
+
+***
+
+### id?
+
+> `optional` **id?**: `string`
+
+***
+
+### links?
+
+> `optional` **links?**: `object`
+
+#### about?
+
+> `optional` **about?**: `string`
+
+#### type?
+
+> `optional` **type?**: `string`
+
+***
+
+### meta?
+
+> `optional` **meta?**: `object`
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+***
+
+### source?
+
+> `optional` **source?**: `object`
+
+#### header?
+
+> `optional` **header?**: `string`
+
+#### parameter?
+
+> `optional` **parameter?**: `string`
+
+#### pointer?
+
+> `optional` **pointer?**: `string`
+
+***
+
+### status
+
+> **status**: `number`
+
+***
+
+### title
+
+> **title**: `string`

package/dist/docs/versioned/0.30.0/reference/generated/api/interfaces/APIErrorOptions.md

@@ -0,0 +1,103 @@
+## Properties
+
+### cause?
+
+> `optional` **cause?**: `unknown`
+
+***
+
+### code?
+
+> `optional` **code?**: `string`
+
+***
+
+### detail?
+
+> `optional` **detail?**: `string`
+
+***
+
+### disableExternalErrorTracking?
+
+> `optional` **disableExternalErrorTracking?**: `boolean`
+
+***
+
+### ~~error?~~
+
+> `optional` **error?**: `unknown`
+
+#### Deprecated
+
+Use `cause` instead. Kept as an alias for backwards compatibility.
+
+***
+
+### fields?
+
+> `optional` **fields?**: `object`
+
+#### Index Signature
+
+\[`id`: `string`\]: `string`
+
+***
+
+### id?
+
+> `optional` **id?**: `string`
+
+***
+
+### links?
+
+> `optional` **links?**: `object`
+
+#### about?
+
+> `optional` **about?**: `string`
+
+#### type?
+
+> `optional` **type?**: `string`
+
+***
+
+### meta?
+
+> `optional` **meta?**: `object`
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+***
+
+### source?
+
+> `optional` **source?**: `object`
+
+#### header?
+
+> `optional` **header?**: `string`
+
+#### parameter?
+
+> `optional` **parameter?**: `string`
+
+#### pointer?
+
+> `optional` **pointer?**: `string`
+
+***
+
+### status?
+
+> `optional` **status?**: `number`
+
+***
+
+### title
+
+> **title**: `string`