@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-core/api/Class.BlobResourceStrategy.md

@@ -0,0 +1,196 @@
+---
+title: 'Class: BlobResourceStrategy'
+generated: true
+editUrl: false
+---
+
+# Class: BlobResourceStrategy
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L51)
+
+Strategy for loading resources from blob storage.
+
+## Implements
+
+- [`IResourceStrategy`](Interface.IResourceStrategy)
+
+## Constructors
+
+### Constructor
+
+```ts
+new BlobResourceStrategy(blobService, config?): BlobResourceStrategy;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L68)
+
+Constructs a new instance of the `BlobResourceStrategy` class.
+
+#### Parameters
+
+| Parameter     | Type                                                                   |
+| ------------- | ---------------------------------------------------------------------- |
+| `blobService` | [`IBlobServiceAdapter`](Interface.IBlobServiceAdapter)                 |
+| `config`      | [`IBlobResourceStrategyConfig`](Interface.IBlobResourceStrategyConfig) |
+
+#### Returns
+
+`BlobResourceStrategy`
+
+## Accessors
+
+### name
+
+#### Get Signature
+
+```ts
+get name(): string;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L77)
+
+The unique name of this strategy.
+
+##### Returns
+
+`string`
+
+The unique name of this strategy.
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`name`](Interface.IResourceStrategy#name)
+
+## Methods
+
+### exists()
+
+```ts
+exists(key): boolean;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:143](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L143)
+
+Checks if a resource exists without loading it.
+Note: Blob storage is inherently async, so this delegates to existsAsync internally.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`boolean`
+
+True if the resource exists
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
+
+---
+
+### existsAsync()
+
+```ts
+existsAsync(key): Promise<boolean>;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:154](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L154)
+
+Checks if a resource exists without loading it (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise resolving to true if the resource exists
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
+
+---
+
+### load()
+
+```ts
+load(key): IResourceResult | undefined;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L93)
+
+Loads a resource by its key.
+Note: Blob storage is inherently async, so this delegates to loadAsync internally.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+[`IResourceResult`](Interface.IResourceResult) \| `undefined`
+
+The resource result or undefined if not found
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
+
+---
+
+### loadAsync()
+
+```ts
+loadAsync(key): Promise<IResourceResult | undefined>;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:104](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L104)
+
+Loads a resource by its key (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<[`IResourceResult`](Interface.IResourceResult) \| `undefined`\>
+
+Promise resolving to the resource result or undefined if not found
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
+
+---
+
+### whatDoIHave()
+
+```ts
+whatDoIHave(): void;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:170](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L170)
+
+List all files and folders in the base paths for debugging purposes.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`whatDoIHave`](Interface.IResourceStrategy#whatdoihave)

package/data/packages/platform-core/api/Class.BooleanUtils.md

@@ -0,0 +1,83 @@
+---
+title: 'Class: BooleanUtils'
+generated: true
+editUrl: false
+---
+
+# Class: BooleanUtils
+
+Defined in: [utils/BooleanUtils.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/BooleanUtils.ts#L22)
+
+Boolean Utility Class.
+This class provides static methods to parse and format boolean values.
+
+## Constructors
+
+### Constructor
+
+```ts
+new BooleanUtils(): BooleanUtils;
+```
+
+#### Returns
+
+`BooleanUtils`
+
+## Methods
+
+### formatBoolean()
+
+```ts
+static formatBoolean(
+   bool,
+   trueFormat?,
+   falseFormat?): string;
+```
+
+Defined in: [utils/BooleanUtils.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/BooleanUtils.ts#L69)
+
+Formats a boolean into a specific string representation.
+
+#### Parameters
+
+| Parameter     | Type      | Default value | Description                                                   |
+| ------------- | --------- | ------------- | ------------------------------------------------------------- |
+| `bool`        | `boolean` | `undefined`   | The boolean to format                                         |
+| `trueFormat`  | `string`  | `'true'`      | The string to return for `true` values (defaults to "true")   |
+| `falseFormat` | `string`  | `'false'`     | The string to return for `false` values (defaults to "false") |
+
+#### Returns
+
+`string`
+
+The formatted string representation of the boolean
+
+---
+
+### parseBoolean()
+
+```ts
+static parseBoolean(value, options?): boolean;
+```
+
+Defined in: [utils/BooleanUtils.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/BooleanUtils.ts#L33)
+
+Parses a given value into a boolean.
+Accepts flexible strings like "yes", "no", "y", "n", "1", "0", "true", "false".
+
+#### Parameters
+
+| Parameter  | Type                  | Description                       |
+| ---------- | --------------------- | --------------------------------- |
+| `value`    | `string` \| `boolean` | The value to parse into a boolean |
+| `options?` | `BooleanOptions`      | Options for strict parsing mode   |
+
+#### Returns
+
+`boolean`
+
+The parsed boolean value
+
+#### Throws
+
+Error if the value is not a valid boolean representation

package/data/packages/platform-core/api/Class.CUIDGenerator.md

@@ -0,0 +1,121 @@
+---
+title: 'Class: CUIDGenerator'
+generated: true
+editUrl: false
+---
+
+# Class: CUIDGenerator
+
+Defined in: [identifiers/generators/CUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L14)
+
+CUID Generator class
+
+## Extends
+
+- [`IdGeneratorBase`](Class.IdGeneratorBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new CUIDGenerator(): CUIDGenerator;
+```
+
+#### Returns
+
+`CUIDGenerator`
+
+#### Inherited from
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`constructor`](Class.IdGeneratorBase#constructor)
+
+## Methods
+
+### generate()
+
+```ts
+generate(prefix?, postfix?): string;
+```
+
+Defined in: [identifiers/generators/CUIDGenerator.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L29)
+
+Generates a CUID (Collision-Resistant Unique Identifier).
+
+#### Parameters
+
+| Parameter  | Type     | Description                          |
+| ---------- | -------- | ------------------------------------ |
+| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| `postfix?` | `string` | Optional postfix to append to the ID |
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
+
+---
+
+### isValid()
+
+```ts
+isValid(id): boolean;
+```
+
+Defined in: [identifiers/generators/CUIDGenerator.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L45)
+
+Validates if the provided string is a valid CUID
+
+#### Parameters
+
+| Parameter | Type     | Description        |
+| --------- | -------- | ------------------ |
+| `id`      | `string` | The ID to validate |
+
+#### Returns
+
+`boolean`
+
+True if the ID is valid, otherwise false
+
+#### Overrides
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`isValid`](Class.IdGeneratorBase#isvalid)
+
+---
+
+### parse()
+
+```ts
+parse(cuid):
+  | {
+  counter: string;
+  random: string;
+  timestamp: string;
+}
+  | null;
+```
+
+Defined in: [identifiers/generators/CUIDGenerator.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L56)
+
+Parses a CUID into its segments
+
+#### Parameters
+
+| Parameter | Type     | Description              |
+| --------- | -------- | ------------------------ |
+| `cuid`    | `string` | The CUID string to parse |
+
+#### Returns
+
+\| \{
+`counter`: `string`;
+`random`: `string`;
+`timestamp`: `string`;
+\}
+\| `null`
+
+An object containing the parsed segments

package/data/packages/platform-core/api/Class.CasingInterceptor.md

@@ -0,0 +1,84 @@
+---
+title: 'Class: CasingInterceptor'
+generated: true
+editUrl: false
+---
+
+# Class: CasingInterceptor
+
+Defined in: [interceptors/CasingInterceptor.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L18)
+
+This interceptor is responsible for converting snake_case or other
+casing styles in the request body to camelCase before passing them to controllers.
+It also handles the transformation of the response if needed.
+
+## Implements
+
+- `NestInterceptor`
+
+## Constructors
+
+### Constructor
+
+```ts
+new CasingInterceptor(): CasingInterceptor;
+```
+
+#### Returns
+
+`CasingInterceptor`
+
+## Methods
+
+### intercept()
+
+```ts
+intercept(context, next): Observable<any>;
+```
+
+Defined in: [interceptors/CasingInterceptor.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L20)
+
+Method to implement a custom interceptor.
+
+#### Parameters
+
+| Parameter | Type               | Description                                                                                                                         |
+| --------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `context` | `ExecutionContext` | an `ExecutionContext` object providing methods to access the route handler and class about to be invoked.                           |
+| `next`    | `CallHandler`      | a reference to the `CallHandler`, which provides access to an `Observable` representing the response stream from the route handler. |
+
+#### Returns
+
+`Observable`\<`any`\>
+
+#### Implementation of
+
+```ts
+NestInterceptor.intercept;
+```
+
+---
+
+### process()
+
+```ts
+process<T>(value): T;
+```
+
+Defined in: [interceptors/CasingInterceptor.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L37)
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type |
+| --------- | ---- |
+| `value`   | `T`  |
+
+#### Returns
+
+`T`

package/data/packages/platform-core/api/Class.CatchUtils.md

@@ -0,0 +1,94 @@
+---
+title: 'Class: CatchUtils'
+generated: true
+editUrl: false
+---
+
+# Class: CatchUtils
+
+Defined in: [utils/CatchUtils.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L2)
+
+## Constructors
+
+### Constructor
+
+```ts
+new CatchUtils(): CatchUtils;
+```
+
+#### Returns
+
+`CatchUtils`
+
+## Methods
+
+### catch()
+
+```ts
+static catch<T>(input, handler): void;
+```
+
+Defined in: [utils/CatchUtils.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L6)
+
+#### Type Parameters
+
+| Type Parameter        |
+| --------------------- |
+| `T` _extends_ `Error` |
+
+#### Parameters
+
+| Parameter | Type                 |
+| --------- | -------------------- |
+| `input`   | `unknown`            |
+| `handler` | (`error`) => `Error` |
+
+#### Returns
+
+`void`
+
+---
+
+### catchError()
+
+```ts
+static catchError<T>(promise): Promise<[undefined, T] | [Error]>;
+```
+
+Defined in: [utils/CatchUtils.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L12)
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type             |
+| --------- | ---------------- |
+| `promise` | `Promise`\<`T`\> |
+
+#### Returns
+
+`Promise`\<\[`undefined`, `T`\] \| \[`Error`\]\>
+
+---
+
+### isError()
+
+```ts
+static isError(value): value is Error;
+```
+
+Defined in: [utils/CatchUtils.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L18)
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `value`   | `unknown` |
+
+#### Returns
+
+`value is Error`

package/data/packages/platform-core/api/Class.ConfigModule.md

@@ -0,0 +1,70 @@
+---
+title: 'Class: ConfigModule'
+generated: true
+editUrl: false
+---
+
+# Class: ConfigModule
+
+Defined in: [config/ConfigModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L30)
+
+The `ConfigModule` class.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ConfigModule(): ConfigModule;
+```
+
+#### Returns
+
+`ConfigModule`
+
+## Methods
+
+### forRoot()
+
+```ts
+static forRoot(options): DynamicModule;
+```
+
+Defined in: [config/ConfigModule.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L50)
+
+#### Parameters
+
+| Parameter | Type                                                                  |
+| --------- | --------------------------------------------------------------------- |
+| `options` | `Partial`\<[`IConfigModuleOptions`](Interface.IConfigModuleOptions)\> |
+
+#### Returns
+
+`DynamicModule`
+
+---
+
+### register()
+
+```ts
+static register(module, entries): DynamicModule;
+```
+
+Defined in: [config/ConfigModule.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L42)
+
+Registers environment variable keys from a library module into the
+central [ConfigRegistry](Class.ConfigRegistry). Call this in each library's module
+to declare the configuration it depends upon.
+
+#### Parameters
+
+| Parameter | Type                                                                                                   | Description                                                 |
+| --------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
+| `module`  | `string`                                                                                               | The logical module name (e.g. `'platform-authentication'`). |
+| `entries` | readonly `Omit`\<[`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>, `"module"`\>[] | The configuration entries the module depends on.            |
+
+#### Returns
+
+`DynamicModule`
+
+A `DynamicModule` that can be added to the module's `imports` array.