@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-reporting/api/Class.ReportingFacade.md

@@ -0,0 +1,85 @@
+---
+title: 'Class: ReportingFacade'
+generated: true
+editUrl: false
+---
+
+# Class: ReportingFacade
+
+Defined in: [core/ReportingFacade.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L19)
+
+Facade orchestrating dataset resolution and query execution for reporting consumers.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ReportingFacade(registry): ReportingFacade;
+```
+
+Defined in: [core/ReportingFacade.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L31)
+
+#### Parameters
+
+| Parameter  | Type                                                                 |
+| ---------- | -------------------------------------------------------------------- |
+| `registry` | [`ReportingContributorRegistry`](Class.ReportingContributorRegistry) |
+
+#### Returns
+
+`ReportingFacade`
+
+## Methods
+
+### executeQuery()
+
+```ts
+executeQuery(request): Promise<IReportingQueryResult>;
+```
+
+Defined in: [core/ReportingFacade.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L52)
+
+#### Parameters
+
+| Parameter | Type                                           |
+| --------- | ---------------------------------------------- |
+| `request` | [`IReportingQuery`](Interface.IReportingQuery) |
+
+#### Returns
+
+`Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
+
+---
+
+### getCatalog()
+
+```ts
+getCatalog(): Promise<readonly IReportingDataset[]>;
+```
+
+Defined in: [core/ReportingFacade.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L39)
+
+#### Returns
+
+`Promise`\<readonly [`IReportingDataset`](Interface.IReportingDataset)[]\>
+
+---
+
+### getDataset()
+
+```ts
+getDataset(datasetId): Promise<IReportingDataset>;
+```
+
+Defined in: [core/ReportingFacade.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L47)
+
+#### Parameters
+
+| Parameter   | Type     |
+| ----------- | -------- |
+| `datasetId` | `string` |
+
+#### Returns
+
+`Promise`\<[`IReportingDataset`](Interface.IReportingDataset)\>

package/data/packages/platform-reporting/api/Class.ReportingModule.md

@@ -0,0 +1,23 @@
+---
+title: 'Class: ReportingModule'
+generated: true
+editUrl: false
+---
+
+# Class: ReportingModule
+
+Defined in: [ReportingModule.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/ReportingModule.ts#L25)
+
+Global module providing the reporting facade and contributor registry.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ReportingModule(): ReportingModule;
+```
+
+#### Returns
+
+`ReportingModule`

package/data/packages/platform-reporting/api/Interface.IReportingContributor.md

@@ -0,0 +1,62 @@
+---
+title: 'Interface: IReportingContributor'
+generated: true
+editUrl: false
+---
+
+# Interface: IReportingContributor
+
+Defined in: [core/ReportingContributor.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributor.ts#L12)
+
+Describes a feature-level contributor that exposes reporting datasets.
+
+## Properties
+
+### featureKey
+
+```ts
+readonly featureKey: string;
+```
+
+Defined in: [core/ReportingContributor.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributor.ts#L17)
+
+Feature namespace associated with the contributor.
+
+## Methods
+
+### executeQuery()
+
+```ts
+executeQuery(_dataset, _request): Promise<IReportingQueryResult>;
+```
+
+Defined in: [core/ReportingContributor.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributor.ts#L27)
+
+Executes the dataset query defined by the given request.
+
+#### Parameters
+
+| Parameter  | Type                                               |
+| ---------- | -------------------------------------------------- |
+| `_dataset` | [`IReportingDataset`](Interface.IReportingDataset) |
+| `_request` | [`IReportingQuery`](Interface.IReportingQuery)     |
+
+#### Returns
+
+`Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
+
+---
+
+### listDatasets()
+
+```ts
+listDatasets(): Promise<readonly IReportingDataset[]>;
+```
+
+Defined in: [core/ReportingContributor.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributor.ts#L22)
+
+Returns the datasets exposed by the contributor.
+
+#### Returns
+
+`Promise`\<readonly [`IReportingDataset`](Interface.IReportingDataset)[]\>

package/data/packages/platform-reporting/api/Interface.IReportingDataset.md

@@ -0,0 +1,83 @@
+---
+title: 'Interface: IReportingDataset'
+generated: true
+editUrl: false
+---
+
+# Interface: IReportingDataset
+
+Defined in: [models/ReportingDataset.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L12)
+
+Represents a dataset definition that can be consumed through the reporting API.
+
+## Properties
+
+### datasetId
+
+```ts
+readonly datasetId: string;
+```
+
+Defined in: [models/ReportingDataset.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L17)
+
+Fully qualified dataset identifier (`<feature>.<dataset>`).
+
+---
+
+### datasetKey
+
+```ts
+readonly datasetKey: string;
+```
+
+Defined in: [models/ReportingDataset.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L27)
+
+Dataset key within the feature namespace.
+
+---
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: [models/ReportingDataset.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L37)
+
+Optional dataset description presented to consumers.
+
+---
+
+### featureKey
+
+```ts
+readonly featureKey: string;
+```
+
+Defined in: [models/ReportingDataset.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L22)
+
+Feature namespace owning the dataset.
+
+---
+
+### fields
+
+```ts
+readonly fields: readonly IReportingDatasetField[];
+```
+
+Defined in: [models/ReportingDataset.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L42)
+
+Fields exposed by the dataset.
+
+---
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [models/ReportingDataset.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L32)
+
+Human readable dataset name.

package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md

@@ -0,0 +1,71 @@
+---
+title: 'Interface: IReportingDatasetField'
+generated: true
+editUrl: false
+---
+
+# Interface: IReportingDatasetField
+
+Defined in: [models/ReportingDatasetField.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L25)
+
+Describes a single field inside a reporting dataset.
+
+## Properties
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: [models/ReportingDatasetField.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L50)
+
+Optional documentation describing the semantic meaning of the field.
+
+---
+
+### fieldId
+
+```ts
+readonly fieldId: string;
+```
+
+Defined in: [models/ReportingDatasetField.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L30)
+
+Unique identifier of the field within the dataset.
+
+---
+
+### isNullable
+
+```ts
+readonly isNullable: boolean;
+```
+
+Defined in: [models/ReportingDatasetField.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L45)
+
+Indicates whether the field can contain null values.
+
+---
+
+### label
+
+```ts
+readonly label: string;
+```
+
+Defined in: [models/ReportingDatasetField.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L35)
+
+Human readable name of the field.
+
+---
+
+### type
+
+```ts
+readonly type: ReportingFieldType;
+```
+
+Defined in: [models/ReportingDatasetField.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L40)
+
+Field type exposed to consumers.

package/data/packages/platform-reporting/api/Interface.IReportingQuery.md

@@ -0,0 +1,61 @@
+---
+title: 'Interface: IReportingQuery'
+generated: true
+editUrl: false
+---
+
+# Interface: IReportingQuery
+
+Defined in: [models/ReportingQuery.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L45)
+
+Represents an execution request for a dataset query.
+
+## Properties
+
+### datasetId
+
+```ts
+readonly datasetId: string;
+```
+
+Defined in: [models/ReportingQuery.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L46)
+
+---
+
+### filters?
+
+```ts
+readonly optional filters?: readonly IReportingQueryFilter[];
+```
+
+Defined in: [models/ReportingQuery.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L47)
+
+---
+
+### limit?
+
+```ts
+readonly optional limit?: number;
+```
+
+Defined in: [models/ReportingQuery.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L49)
+
+---
+
+### offset?
+
+```ts
+readonly optional offset?: number;
+```
+
+Defined in: [models/ReportingQuery.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L50)
+
+---
+
+### sorts?
+
+```ts
+readonly optional sorts?: readonly IReportingQuerySort[];
+```
+
+Defined in: [models/ReportingQuery.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L48)

package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md

@@ -0,0 +1,41 @@
+---
+title: 'Interface: IReportingQueryFilter'
+generated: true
+editUrl: false
+---
+
+# Interface: IReportingQueryFilter
+
+Defined in: [models/ReportingQuery.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L24)
+
+Describes a single filter applied to a dataset query execution.
+
+## Properties
+
+### fieldId
+
+```ts
+readonly fieldId: string;
+```
+
+Defined in: [models/ReportingQuery.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L25)
+
+---
+
+### operator
+
+```ts
+readonly operator: ReportingFilterOperator;
+```
+
+Defined in: [models/ReportingQuery.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L26)
+
+---
+
+### value
+
+```ts
+readonly value: unknown;
+```
+
+Defined in: [models/ReportingQuery.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L27)

package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md

@@ -0,0 +1,61 @@
+---
+title: 'Interface: IReportingQueryResult'
+generated: true
+editUrl: false
+---
+
+# Interface: IReportingQueryResult
+
+Defined in: [models/ReportingQueryResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L19)
+
+Represents the result of a dataset query execution.
+
+## Properties
+
+### datasetId
+
+```ts
+readonly datasetId: string;
+```
+
+Defined in: [models/ReportingQueryResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L20)
+
+---
+
+### fields
+
+```ts
+readonly fields: readonly IReportingDatasetField[];
+```
+
+Defined in: [models/ReportingQueryResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L21)
+
+---
+
+### generatedAt
+
+```ts
+readonly generatedAt: Date;
+```
+
+Defined in: [models/ReportingQueryResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L24)
+
+---
+
+### rows
+
+```ts
+readonly rows: readonly ReportingQueryResultRow[];
+```
+
+Defined in: [models/ReportingQueryResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L22)
+
+---
+
+### totalCount
+
+```ts
+readonly totalCount: number;
+```
+
+Defined in: [models/ReportingQueryResult.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L23)

package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md

@@ -0,0 +1,31 @@
+---
+title: 'Interface: IReportingQuerySort'
+generated: true
+editUrl: false
+---
+
+# Interface: IReportingQuerySort
+
+Defined in: [models/ReportingQuery.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L35)
+
+Represents a sorting instruction for a dataset query.
+
+## Properties
+
+### direction
+
+```ts
+readonly direction: "asc" | "desc";
+```
+
+Defined in: [models/ReportingQuery.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L37)
+
+---
+
+### fieldId
+
+```ts
+readonly fieldId: string;
+```
+
+Defined in: [models/ReportingQuery.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L36)

package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md

@@ -0,0 +1,13 @@
+---
+title: 'Type Alias: ReportingFieldType'
+generated: true
+editUrl: false
+---
+
+# Type Alias: ReportingFieldType
+
+```ts
+type ReportingFieldType = (typeof ReportingFieldTypes)[keyof typeof ReportingFieldTypes];
+```
+
+Defined in: [models/ReportingDatasetField.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L18)

package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md

@@ -0,0 +1,13 @@
+---
+title: 'Type Alias: ReportingFilterOperator'
+generated: true
+editUrl: false
+---
+
+# Type Alias: ReportingFilterOperator
+
+```ts
+type ReportingFilterOperator = (typeof ReportingFilterOperators)[keyof typeof ReportingFilterOperators];
+```
+
+Defined in: [models/ReportingQuery.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L17)

package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md

@@ -0,0 +1,15 @@
+---
+title: 'Type Alias: ReportingQueryResultRow'
+generated: true
+editUrl: false
+---
+
+# Type Alias: ReportingQueryResultRow
+
+```ts
+type ReportingQueryResultRow = Record<string, unknown>;
+```
+
+Defined in: [models/ReportingQueryResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L12)
+
+Represents a single row returned by a reporting dataset.

package/data/packages/platform-reporting/api/index.md

@@ -0,0 +1,90 @@
+---
+title: '@breadstone/archipel-platform-reporting'
+generated: true
+editUrl: false
+---
+
+# @breadstone/archipel-platform-reporting
+
+## Classes
+
+| Class                                                                | Description                                                                          |
+| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
+| [ReportingContributorRegistry](Class.ReportingContributorRegistry)   | Registry responsible for tracking feature-provided reporting contributors.           |
+| [ReportingDatasetNotFoundError](Class.ReportingDatasetNotFoundError) | Error thrown when a dataset definition could not be resolved.                        |
+| [ReportingFacade](Class.ReportingFacade)                             | Facade orchestrating dataset resolution and query execution for reporting consumers. |
+| [ReportingModule](Class.ReportingModule)                             | Global module providing the reporting facade and contributor registry.               |
+
+## Interfaces
+
+| Interface                                                  | Description                                                                     |
+| ---------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| [IReportingContributor](Interface.IReportingContributor)   | Describes a feature-level contributor that exposes reporting datasets.          |
+| [IReportingDataset](Interface.IReportingDataset)           | Represents a dataset definition that can be consumed through the reporting API. |
+| [IReportingDatasetField](Interface.IReportingDatasetField) | Describes a single field inside a reporting dataset.                            |
+| [IReportingQuery](Interface.IReportingQuery)               | Represents an execution request for a dataset query.                            |
+| [IReportingQueryFilter](Interface.IReportingQueryFilter)   | Describes a single filter applied to a dataset query execution.                 |
+| [IReportingQueryResult](Interface.IReportingQueryResult)   | Represents the result of a dataset query execution.                             |
+| [IReportingQuerySort](Interface.IReportingQuerySort)       | Represents a sorting instruction for a dataset query.                           |
+
+## Type Aliases
+
+| Type Alias                                                   | Description                                              |
+| ------------------------------------------------------------ | -------------------------------------------------------- |
+| [ReportingFieldType](TypeAlias.ReportingFieldType)           | -                                                        |
+| [ReportingFilterOperator](TypeAlias.ReportingFilterOperator) | -                                                        |
+| [ReportingQueryResultRow](TypeAlias.ReportingQueryResultRow) | Represents a single row returned by a reporting dataset. |
+
+## Variables
+
+### ReportingFieldTypes
+
+```ts
+const ReportingFieldTypes: {
+  Boolean: 'boolean';
+  DateTime: 'datetime';
+  Json: 'json';
+  Number: 'number';
+  String: 'string';
+};
+```
+
+Defined in: [models/ReportingDatasetField.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L10)
+
+Enumerates the supported field data types for reporting datasets.
+
+#### Type Declaration
+
+| Name                                      | Type         | Default value | Defined in                                                                                                                                              |
+| ----------------------------------------- | ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-boolean"></a> `Boolean`   | `"boolean"`  | `'boolean'`   | [models/ReportingDatasetField.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L11) |
+| <a id="property-datetime"></a> `DateTime` | `"datetime"` | `'datetime'`  | [models/ReportingDatasetField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L12) |
+| <a id="property-json"></a> `Json`         | `"json"`     | `'json'`      | [models/ReportingDatasetField.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L13) |
+| <a id="property-number"></a> `Number`     | `"number"`   | `'number'`    | [models/ReportingDatasetField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L14) |
+| <a id="property-string"></a> `String`     | `"string"`   | `'string'`    | [models/ReportingDatasetField.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L15) |
+
+---
+
+### ReportingFilterOperators
+
+```ts
+const ReportingFilterOperators: {
+  Equals: 'equals';
+  GreaterThanOrEqual: 'gte';
+  In: 'in';
+  LessThanOrEqual: 'lte';
+};
+```
+
+Defined in: [models/ReportingQuery.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L10)
+
+Enumerates supported filter operators for dataset queries.
+
+#### Type Declaration
+
+| Name                                                          | Type       | Default value | Defined in                                                                                                                                |
+| ------------------------------------------------------------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-equals"></a> `Equals`                         | `"equals"` | `'equals'`    | [models/ReportingQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L11) |
+| <a id="property-greaterthanorequal"></a> `GreaterThanOrEqual` | `"gte"`    | `'gte'`       | [models/ReportingQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L12) |
+| <a id="property-in"></a> `In`                                 | `"in"`     | `'in'`        | [models/ReportingQuery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L13) |
+| <a id="property-lessthanorequal"></a> `LessThanOrEqual`       | `"lte"`    | `'lte'`       | [models/ReportingQuery.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L14) |