npm - @breadstone/archipel-mcp - Versions diffs - 0.0.13 → 0.0.15 - Mend

@breadstone/archipel-mcp 0.0.13 → 0.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (612) hide show

package/data/packages/platform-cryptography/api/Class.BcryptService.md DELETED Viewed

@@ -1,72 +0,0 @@
----
-title: 'Class: BcryptService'
-generated: true
-editUrl: false
----
-# Class: BcryptService
-Defined in: [BcryptService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L15)
-The `BcryptService` class.
-Represents the service that provides bcrypt operations.
-## Constructors
-### Constructor
-```ts
-new BcryptService(): BcryptService;
-```
-#### Returns
-`BcryptService`
-## Methods
-### compare()
-```ts
-compare(data, encrypted): Promise<boolean>;
-```
-Defined in: [BcryptService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L38)
-Compares the given data with the encrypted data.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `data` | `string` | The data to be compared. |
-| `encrypted` | `string` | The encrypted data to be compared. |
-#### Returns
-`Promise`\<`boolean`\>
-`true` if the data matches the encrypted hash; otherwise `false`.
-***
-### hash()
-```ts
-hash(data): Promise<string>;
-```
-Defined in: [BcryptService.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L25)
-Hashes the given data using bcrypt with a generated salt.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `data` | `string` | The data to be hashed. |
-#### Returns
-`Promise`\<`string`\>
-The bcrypt hash string.

package/data/packages/platform-cryptography/api/Class.CryptoService.md DELETED Viewed

@@ -1,51 +0,0 @@
----
-title: 'Class: CryptoService'
-generated: true
-editUrl: false
----
-# Class: CryptoService
-Defined in: [CryptoService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L15)
-The `CryptoService` class.
-Represents the service that provides cryptographic operations.
-## Constructors
-### Constructor
-```ts
-new CryptoService(): CryptoService;
-```
-Defined in: [CryptoService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L21)
-Initializes a new instance of the `CryptoService` class.
-#### Returns
-`CryptoService`
-## Methods
-### getRandomGuid()
-```ts
-getRandomGuid(prefix): string;
-```
-Defined in: [CryptoService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L36)
-Generates a random GUID prefixed with the given string.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `prefix` | `string` | The prefix to prepend to the generated UUID. |
-#### Returns
-`string`
-The prefixed UUID string.

package/data/packages/platform-cryptography/api/Class.OtpService.md DELETED Viewed

@@ -1,109 +0,0 @@
----
-title: 'Class: OtpService'
-generated: true
-editUrl: false
----
-# Class: OtpService
-Defined in: [otp/OtpService.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L42)
-OTP service implementation backed by otplib v13.
-Wraps the otplib standalone functions behind the generic
-[IOtpService](Interface.IOtpService) interface so consumers are decoupled from
-the library version.
-## Implements
-- [`IOtpService`](Interface.IOtpService)
-## Constructors
-### Constructor
-```ts
-new OtpService(): OtpService;
-```
-#### Returns
-`OtpService`
-## Methods
-### generateSecret()
-```ts
-generateSecret(): string;
-```
-Defined in: [otp/OtpService.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L46)
-Generates a cryptographically random secret suitable for TOTP.
-#### Returns
-`string`
-The generated secret string.
-#### Implementation of
-[`IOtpService`](Interface.IOtpService).[`generateSecret`](Interface.IOtpService#generatesecret)
-***
-### generateUri()
-```ts
-generateUri(options): string;
-```
-Defined in: [otp/OtpService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L51)
-Generates an `otpauth://` URI for QR code enrollment.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
-#### Returns
-`string`
-The formatted `otpauth://` URI.
-#### Implementation of
-[`IOtpService`](Interface.IOtpService).[`generateUri`](Interface.IOtpService#generateuri)
-***
-### verify()
-```ts
-verify(token, secret): boolean;
-```
-Defined in: [otp/OtpService.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L56)
-Verifies a TOTP token against the given secret.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The one-time password to verify. |
-| `secret` | `string` | The shared secret. |
-#### Returns
-`boolean`
-`true` if the token is valid within the configured tolerance window.
-#### Implementation of
-[`IOtpService`](Interface.IOtpService).[`verify`](Interface.IOtpService#verify)

package/data/packages/platform-cryptography/api/Interface.IOtpService.md DELETED Viewed

@@ -1,81 +0,0 @@
----
-title: 'Interface: IOtpService'
-generated: true
-editUrl: false
----
-# Interface: IOtpService
-Defined in: [otp/IOtpService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L38)
-Abstraction over OTP (One-Time Password) operations.
-Decouples consumers from any specific OTP library, making it easy
-to swap implementations (e.g. upgrading from otplib v12 to v13)
-without changing consumer code.
-## Methods
-### generateSecret()
-```ts
-generateSecret(): string;
-```
-Defined in: [otp/IOtpService.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L45)
-Generates a cryptographically random secret suitable for TOTP.
-#### Returns
-`string`
-The generated secret string.
-***
-### generateUri()
-```ts
-generateUri(options): string;
-```
-Defined in: [otp/IOtpService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L54)
-Generates an `otpauth://` URI for QR code enrollment.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
-#### Returns
-`string`
-The formatted `otpauth://` URI.
-***
-### verify()
-```ts
-verify(token, secret): boolean;
-```
-Defined in: [otp/IOtpService.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L64)
-Verifies a TOTP token against the given secret.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The one-time password to verify. |
-| `secret` | `string` | The shared secret. |
-#### Returns
-`boolean`
-`true` if the token is valid within the configured tolerance window.

package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md DELETED Viewed

@@ -1,46 +0,0 @@
----
-title: 'Interface: IOtpUriOptions'
-generated: true
-editUrl: false
----
-# Interface: IOtpUriOptions
-Defined in: [otp/IOtpService.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L6)
-Options for generating an OTP authentication URI (otpauth://).
-## Properties
-### issuer
-```ts
-readonly issuer: string;
-```
-Defined in: [otp/IOtpService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L12)
-The issuer name displayed in the authenticator app.
-***
-### label
-```ts
-readonly label: string;
-```
-Defined in: [otp/IOtpService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L19)
-The account label (e.g. email or username) shown in the authenticator app.
-***
-### secret
-```ts
-readonly secret: string;
-```
-Defined in: [otp/IOtpService.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L26)
-The shared secret used for TOTP generation.

package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md DELETED Viewed

@@ -1,14 +0,0 @@
----
-title: 'Variable: OTP\_SERVICE\_TOKEN'
-generated: true
-editUrl: false
----
-# Variable: OTP\_SERVICE\_TOKEN
-```ts
-const OTP_SERVICE_TOKEN: typeof OTP_SERVICE_TOKEN;
-```
-Defined in: [otp/OtpService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L14)
-Injection token for [IOtpService](Interface.IOtpService).

package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md DELETED Viewed

@@ -1,23 +0,0 @@
----
-title: 'Variable: TOTP\_EPOCH\_TOLERANCE'
-generated: true
-editUrl: false
----
-# Variable: TOTP\_EPOCH\_TOLERANCE
-```ts
-const TOTP_EPOCH_TOLERANCE: 30 = 30;
-```
-Defined in: [otp/OtpService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L30)
-TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`).
-Each time step equals 30 seconds by default (RFC 6238).
-| `epochTolerance` | Accepted range          |
-|------------------|-------------------------|
-| 0                | current step only       |
-| 30               | ±1 step (±30 s)         |
-| 60               | ±2 steps (±60 s)        |
-| 90               | ±3 steps (±90 s)        |

package/data/packages/platform-cryptography/api/index.md DELETED Viewed

@@ -1,28 +0,0 @@
----
-title: '@breadstone/archipel-platform-cryptography'
-generated: true
-editUrl: false
----
-# @breadstone/archipel-platform-cryptography
-## Classes
-| Class | Description |
-| ------ | ------ |
-| [BcryptService](Class.BcryptService) | The `BcryptService` class. Represents the service that provides bcrypt operations. |
-| [CryptoService](Class.CryptoService) | The `CryptoService` class. Represents the service that provides cryptographic operations. |
-| [OtpService](Class.OtpService) | OTP service implementation backed by otplib v13. |
-## Interfaces
-| Interface | Description |
-| ------ | ------ |
-| [IOtpService](Interface.IOtpService) | Abstraction over OTP (One-Time Password) operations. |
-| [IOtpUriOptions](Interface.IOtpUriOptions) | Options for generating an OTP authentication URI (otpauth://). |
-## Variables
-| Variable | Description |
-| ------ | ------ |
-| [OTP\_SERVICE\_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for [IOtpService](Interface.IOtpService). |
-| [TOTP\_EPOCH\_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |

package/data/packages/platform-cryptography/index.md DELETED Viewed

@@ -1,132 +0,0 @@
----
-title: platform-cryptography
-description: Bcrypt password hashing, prefixed UUID generation, and TOTP multi-factor authentication.
-order: 17
-tags: [cryptography, bcrypt, uuid, totp, otp, mfa, hashing]
-package: '@breadstone/archipel-platform-cryptography'
----
-# platform-cryptography
-Cryptographic building blocks for NestJS applications: bcrypt password hashing, prefixed UUID generation, and TOTP-based multi-factor authentication. All services are `@Injectable()` and ready for constructor injection.
-**Package:** `@breadstone/archipel-platform-cryptography`
-## Quick Start
-```typescript
-import {
-  BcryptService,
-  CryptoService,
-  OtpService,
-  OTP_SERVICE_TOKEN,
-} from '@breadstone/archipel-platform-cryptography';
-```
----
-## Password Hashing (BcryptService)
-Secure password hashing with auto-generated salts.
-```typescript
-import { Injectable } from '@nestjs/common';
-import { BcryptService } from '@breadstone/archipel-platform-cryptography';
-@Injectable()
-export class AccountService {
-  constructor(private readonly _bcrypt: BcryptService) {}
-  async createAccount(password: string): Promise<void> {
-    const hashed = await this._bcrypt.hash(password);
-    // store hashed password
-  }
-  async verifyPassword(password: string, hash: string): Promise<boolean> {
-    return this._bcrypt.compare(password, hash);
-  }
-}
-```
-| Method                     | Description                                   |
-| -------------------------- | --------------------------------------------- |
-| `hash(data)`               | Hashes a string with a generated bcrypt salt. |
-| `compare(data, encrypted)` | Compares plain text against a bcrypt hash.    |
----
-## Prefixed UUIDs (CryptoService)
-Generates random UUIDs prefixed with a domain identifier for readable, collision-free identifiers.
-```typescript
-import { CryptoService } from '@breadstone/archipel-platform-cryptography';
-const crypto = new CryptoService();
-crypto.getRandomGuid('usr'); // → 'usr-a1b2c3d4-...'
-crypto.getRandomGuid('ord'); // → 'ord-e5f6a7b8-...'
-crypto.getRandomGuid('inv'); // → 'inv-c9d0e1f2-...'
-```
-| Method                  | Description                                           |
-| ----------------------- | ----------------------------------------------------- |
-| `getRandomGuid(prefix)` | Returns `{prefix}-{uuid}`. Throws if prefix is empty. |
----
-## TOTP Multi-Factor Authentication (OtpService)
-TOTP enrollment and verification backed by otplib v13, injected via the `OTP_SERVICE_TOKEN` symbol.
-### Injection Setup
-```typescript
-import { Module } from '@nestjs/common';
-import { OtpService, OTP_SERVICE_TOKEN } from '@breadstone/archipel-platform-cryptography';
-@Module({
-  providers: [{ provide: OTP_SERVICE_TOKEN, useClass: OtpService }],
-  exports: [OTP_SERVICE_TOKEN],
-})
-export class SecurityModule {}
-```
-### Usage
-```typescript
-import { Inject, Injectable } from '@nestjs/common';
-import { OTP_SERVICE_TOKEN, IOtpService } from '@breadstone/archipel-platform-cryptography';
-@Injectable()
-export class MfaService {
-  constructor(@Inject(OTP_SERVICE_TOKEN) private readonly _otp: IOtpService) {}
-  enroll(issuer: string, label: string) {
-    const secret = this._otp.generateSecret();
-    const uri = this._otp.generateUri({ issuer, label, secret });
-    return { secret, uri }; // uri → QR code
-  }
-  verify(token: string, secret: string): boolean {
-    return this._otp.verify(token, secret);
-  }
-}
-```
-### Tolerance
-The default `TOTP_EPOCH_TOLERANCE` is 30 seconds (±1 time step):
-| `epochTolerance` | Accepted range    |
-| ---------------- | ----------------- |
-| 0                | Current step only |
-| 30               | ±1 step (±30 s)   |
-| 60               | ±2 steps (±60 s)  |
-| 90               | ±3 steps (±90 s)  |
----
-## API Reference
-See the full [API documentation](./api/) for all exported types and classes.

package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md DELETED Viewed

@@ -1,75 +0,0 @@
----
-title: 'Class: DatabaseHealthIndicator'
-generated: true
-editUrl: false
----
-# Class: DatabaseHealthIndicator
-Defined in: [terminus/DatabaseHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L16)
-Health indicator for database connectivity.
-## Implements
-- `IHealthIndicator`
-## Constructors
-### Constructor
-```ts
-new DatabaseHealthIndicator(prismaHealthIndicator, databaseService): DatabaseHealthIndicator;
-```
-Defined in: [terminus/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L26)
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `prismaHealthIndicator` | `PrismaHealthIndicator` |
-| `databaseService` | [`DatabaseService`](Class.DatabaseService) |
-#### Returns
-`DatabaseHealthIndicator`
-## Properties
-### key
-```ts
-readonly key: "database" = 'database';
-```
-Defined in: [terminus/DatabaseHealthIndicator.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L35)
-Unique key identifying the indicator
-#### Implementation of
-```ts
-IHealthIndicator.key
-```
-## Methods
-### check()
-```ts
-check(): Promise<HealthIndicatorResult<"database">>;
-```
-Defined in: [terminus/DatabaseHealthIndicator.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L41)
-Performs the health check and returns a result keyed by the indicator key
-#### Returns
-`Promise`\<`HealthIndicatorResult`\<`"database"`\>\>
-#### Implementation of
-```ts
-IHealthIndicator.check
-```

package/data/packages/platform-database/api/Class.DatabaseModule.md DELETED Viewed

@@ -1,68 +0,0 @@
----
-title: 'Class: DatabaseModule'
-generated: true
-editUrl: false
----
-# Class: DatabaseModule
-Defined in: [DatabaseModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L62)
-## Constructors
-### Constructor
-```ts
-new DatabaseModule(): DatabaseModule;
-```
-#### Returns
-`DatabaseModule`
-## Methods
-### forRoot()
-```ts
-static forRoot(config?): DynamicModule;
-```
-Defined in: [DatabaseModule.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L71)
-Registers the `DatabaseModule` with global middlewares.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
-#### Returns
-`DynamicModule`
-A `DynamicModule` that can be imported globally
-***
-### register()
-```ts
-static register(config?): DynamicModule;
-```
-Defined in: [DatabaseModule.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L91)
-Registers the `DatabaseModule` with dynamic middlewares.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
-#### Returns
-`DynamicModule`
-A `DynamicModule` that can be imported with middlewares