@breadstone/archipel-mcp 0.0.20 → 0.0.22

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 (196) hide show
  1. package/data/guides/ai-text-generation.md +10 -0
  2. package/data/guides/analytics-and-error-tracking.md +6 -0
  3. package/data/guides/cryptography-and-otp.md +20 -2
  4. package/data/guides/database-setup.md +4 -3
  5. package/data/guides/document-generation.md +26 -0
  6. package/data/guides/email-delivery.md +23 -0
  7. package/data/guides/email-templates.md +298 -0
  8. package/data/guides/esigning-integration.md +1 -1
  9. package/data/guides/getting-started.md +6 -6
  10. package/data/guides/index.md +1 -0
  11. package/data/guides/mcp-server.md +9 -0
  12. package/data/guides/payments-and-feature-gating.md +18 -0
  13. package/data/guides/resource-management.md +9 -9
  14. package/data/guides/telemetry-and-observability.md +7 -1
  15. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +55 -6
  16. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +32 -6
  17. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +55 -6
  18. package/data/packages/platform-analytics/index.md +13 -0
  19. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -1
  20. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -1
  21. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -1
  22. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -1
  23. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +1 -1
  24. package/data/packages/platform-core/api/Class.EventHub.md +7 -7
  25. package/data/packages/platform-core/api/Class.HostService.md +1 -1
  26. package/data/packages/platform-core/api/Class.SseHub.md +29 -6
  27. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -1
  28. package/data/packages/platform-core/api/index.md +0 -27
  29. package/data/packages/platform-core/index.md +8 -4
  30. package/data/packages/platform-cryptography/api/Class.BcryptService.md +4 -4
  31. package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -3
  32. package/data/packages/platform-cryptography/api/Class.OtpService.md +6 -6
  33. package/data/packages/platform-cryptography/api/Variable.BCRYPT_OPTIONS.md +2 -2
  34. package/data/packages/platform-cryptography/api/Variable.MAX_BCRYPT_PASSWORD_BYTES.md +1 -1
  35. package/data/packages/platform-cryptography/api/Variable.MIN_BCRYPT_ROUNDS.md +1 -1
  36. package/data/packages/platform-cryptography/api/Variable.OTP_OPTIONS.md +2 -2
  37. package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +2 -2
  38. package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
  39. package/data/packages/platform-cryptography/api/index.md +3 -3
  40. package/data/packages/platform-cryptography/index.md +10 -0
  41. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +32 -1
  42. package/data/packages/platform-documents/api/Class.DocumentEngine.md +4 -4
  43. package/data/packages/platform-documents/api/Class.DocumentError.md +61 -0
  44. package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -2
  45. package/data/packages/platform-documents/api/Class.DocumentRenderError.md +53 -0
  46. package/data/packages/platform-documents/api/Class.DocumentValidationError.md +52 -0
  47. package/data/packages/platform-documents/api/Class.DocxDocumentRenderer2.md +333 -0
  48. package/data/packages/platform-documents/api/Class.ImageProcessingError.md +53 -0
  49. package/data/packages/platform-documents/api/Class.PdfDocumentRenderer.md +355 -0
  50. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +5 -5
  51. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +31 -5
  52. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -1
  53. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -1
  54. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -1
  55. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -1
  56. package/data/packages/platform-documents/api/index.md +6 -0
  57. package/data/packages/platform-documents/index.md +27 -0
  58. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +2 -2
  59. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +8 -8
  60. package/data/packages/platform-esigning/index.md +2 -0
  61. package/data/packages/platform-health/index.md +128 -0
  62. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +3 -3
  63. package/data/packages/platform-intelligence/api/Class.IntelligenceConfigurationError.md +50 -0
  64. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +27 -4
  65. package/data/packages/platform-intelligence/api/Class.IntelligenceValidationError.md +50 -0
  66. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +1 -1
  67. package/data/packages/platform-intelligence/api/index.md +2 -0
  68. package/data/packages/platform-intelligence/index.md +32 -0
  69. package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -1
  70. package/data/packages/platform-logging/index.md +2 -0
  71. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +0 -1
  72. package/data/packages/platform-mailing/api/Class.MailDeliveryError.md +65 -0
  73. package/data/packages/platform-mailing/api/Class.MailModule.md +1 -1
  74. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
  75. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
  76. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
  77. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
  78. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
  79. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +0 -5
  80. package/data/packages/platform-mailing/api/Variable.SMTP_CONFIG_ENTRIES.md +14 -0
  81. package/data/packages/platform-mailing/api/Variable.SMTP_HOST.md +14 -0
  82. package/data/packages/platform-mailing/api/Variable.SMTP_PASSWORD.md +14 -0
  83. package/data/packages/platform-mailing/api/Variable.SMTP_PORT.md +14 -0
  84. package/data/packages/platform-mailing/api/Variable.SMTP_SECURE.md +14 -0
  85. package/data/packages/platform-mailing/api/Variable.SMTP_USER.md +14 -0
  86. package/data/packages/platform-mailing/api/index.md +7 -3
  87. package/data/packages/platform-mailing/index.md +29 -0
  88. package/data/packages/platform-mapping/index.md +121 -0
  89. package/data/packages/platform-mcp/api/Class.McpServerService.md +8 -8
  90. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -1
  91. package/data/packages/platform-mcp/index.md +11 -0
  92. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +4 -4
  93. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -2
  94. package/data/packages/platform-openapi/index.md +1 -1
  95. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
  96. package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
  97. package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
  98. package/data/packages/platform-payments/api/Class.PaymentError.md +65 -0
  99. package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
  100. package/data/packages/platform-payments/api/index.md +1 -0
  101. package/data/packages/platform-payments/index.md +29 -0
  102. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +1 -1
  103. package/data/packages/platform-reporting/index.md +3 -1
  104. package/data/packages/platform-resources/index.md +135 -0
  105. package/data/packages/platform-telemetry/api/Class.MetricsService.md +29 -3
  106. package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md +3 -2
  107. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +6 -6
  108. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +3 -3
  109. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -1
  110. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -1
  111. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -1
  112. package/data/packages/platform-telemetry/api/index.md +1 -1
  113. package/data/packages/platform-telemetry/index.md +3 -1
  114. package/{src/knowledge/configPattern.js → data/patterns/config-pattern.md} +44 -47
  115. package/{src/knowledge/dtoPattern.js → data/patterns/dto-pattern.md} +58 -61
  116. package/{src/knowledge/errorHandlingPattern.js → data/patterns/error-handling-pattern.md} +35 -38
  117. package/{src/knowledge/guardPattern.js → data/patterns/guard-pattern.md} +35 -38
  118. package/{src/knowledge/mappingPattern.js → data/patterns/mapping-pattern.md} +43 -144
  119. package/data/patterns/module-pattern.md +182 -0
  120. package/data/patterns/query-pattern.md +137 -0
  121. package/data/patterns/repository-pattern.md +208 -0
  122. package/{src/knowledge/testingPattern.js → data/patterns/testing-pattern.md} +37 -40
  123. package/package.json +1 -1
  124. package/src/PatternsLoader.d.ts +12 -0
  125. package/src/PatternsLoader.js +65 -0
  126. package/src/generators/mappingPatternGenerator.d.ts +5 -0
  127. package/src/generators/mappingPatternGenerator.js +107 -0
  128. package/src/generators/modulePatternGenerator.d.ts +5 -0
  129. package/src/generators/modulePatternGenerator.js +107 -0
  130. package/src/generators/queryPatternGenerator.d.ts +4 -0
  131. package/src/generators/queryPatternGenerator.js +83 -0
  132. package/src/generators/repositoryPatternGenerator.d.ts +5 -0
  133. package/src/generators/repositoryPatternGenerator.js +165 -0
  134. package/src/main.js +15 -9
  135. package/src/models/IPatternDoc.d.ts +15 -0
  136. package/src/models/IPatternDoc.js +3 -0
  137. package/src/tools/registerGetConfigPatternTool.d.ts +2 -1
  138. package/src/tools/registerGetConfigPatternTool.js +4 -3
  139. package/src/tools/registerGetDtoPatternTool.d.ts +2 -1
  140. package/src/tools/registerGetDtoPatternTool.js +4 -3
  141. package/src/tools/registerGetErrorHandlingPatternTool.d.ts +2 -1
  142. package/src/tools/registerGetErrorHandlingPatternTool.js +4 -3
  143. package/src/tools/registerGetGuardPatternTool.d.ts +2 -1
  144. package/src/tools/registerGetGuardPatternTool.js +4 -3
  145. package/src/tools/registerGetMappingPatternTool.d.ts +2 -1
  146. package/src/tools/registerGetMappingPatternTool.js +5 -4
  147. package/src/tools/registerGetModulePatternTool.d.ts +2 -1
  148. package/src/tools/registerGetModulePatternTool.js +5 -4
  149. package/src/tools/registerGetQueryPatternTool.d.ts +2 -1
  150. package/src/tools/registerGetQueryPatternTool.js +5 -4
  151. package/src/tools/registerGetRepositoryPatternTool.d.ts +2 -1
  152. package/src/tools/registerGetRepositoryPatternTool.js +5 -4
  153. package/src/tools/registerGetTestingPatternTool.d.ts +2 -1
  154. package/src/tools/registerGetTestingPatternTool.js +4 -3
  155. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +0 -195
  156. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +0 -215
  157. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +0 -192
  158. package/data/packages/platform-core/api/Class.HealthModule.md +0 -42
  159. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +0 -64
  160. package/data/packages/platform-core/api/Class.MappingBuilder.md +0 -110
  161. package/data/packages/platform-core/api/Class.MappingModule.md +0 -46
  162. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +0 -56
  163. package/data/packages/platform-core/api/Class.MappingProfileBase.md +0 -52
  164. package/data/packages/platform-core/api/Class.MappingService.md +0 -284
  165. package/data/packages/platform-core/api/Class.ResourceManager.md +0 -565
  166. package/data/packages/platform-core/api/Class.ResourceModule.md +0 -46
  167. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +0 -57
  168. package/data/packages/platform-core/api/Function.createMappingKey.md +0 -39
  169. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +0 -28
  170. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +0 -40
  171. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +0 -72
  172. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +0 -46
  173. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +0 -41
  174. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +0 -76
  175. package/data/packages/platform-core/api/Interface.IMappingKey.md +0 -58
  176. package/data/packages/platform-core/api/Interface.IMappingProfile.md +0 -32
  177. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +0 -89
  178. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +0 -94
  179. package/data/packages/platform-core/api/Interface.IResourceResult.md +0 -34
  180. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +0 -134
  181. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +0 -14
  182. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +0 -60
  183. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +0 -58
  184. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +0 -71
  185. package/src/knowledge/configPattern.d.ts +0 -5
  186. package/src/knowledge/dtoPattern.d.ts +0 -5
  187. package/src/knowledge/errorHandlingPattern.d.ts +0 -5
  188. package/src/knowledge/guardPattern.d.ts +0 -5
  189. package/src/knowledge/mappingPattern.d.ts +0 -6
  190. package/src/knowledge/modulePattern.d.ts +0 -6
  191. package/src/knowledge/modulePattern.js +0 -283
  192. package/src/knowledge/queryPattern.d.ts +0 -6
  193. package/src/knowledge/queryPattern.js +0 -215
  194. package/src/knowledge/repositoryPattern.d.ts +0 -6
  195. package/src/knowledge/repositoryPattern.js +0 -367
  196. package/src/knowledge/testingPattern.d.ts +0 -5
@@ -1,28 +0,0 @@
1
- ---
2
- title: 'Interface: IBlobResourceStrategyConfig'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IBlobResourceStrategyConfig
7
-
8
- Defined in: [resources/strategies/BlobResourceStrategy.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L36)
9
-
10
- Configuration for the blob resource strategy.
11
-
12
- ## Properties
13
-
14
- ### keyPrefix?
15
-
16
- ```ts
17
- optional keyPrefix?: string;
18
- ```
19
-
20
- Defined in: [resources/strategies/BlobResourceStrategy.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L42)
21
-
22
- Optional key prefix for blob storage.
23
-
24
- #### Example
25
-
26
- ```ts
27
- 'resources/', 'templates/'
28
- ```
@@ -1,40 +0,0 @@
1
- ---
2
- title: 'Interface: IBlobServiceAdapter'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IBlobServiceAdapter
7
-
8
- Defined in: [resources/strategies/BlobResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L14)
9
-
10
- Minimal blob service interface to avoid circular dependencies.
11
-
12
- ## Methods
13
-
14
- ### downloadFile()
15
-
16
- ```ts
17
- downloadFile(key): Promise<{
18
- contentType?: string;
19
- data: unknown;
20
- }>;
21
- ```
22
-
23
- Defined in: [resources/strategies/BlobResourceStrategy.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L22)
24
-
25
- Downloads a file from blob storage.
26
-
27
- #### Parameters
28
-
29
- | Parameter | Type | Description |
30
- | ------ | ------ | ------ |
31
- | `key` | `string` | The blob key |
32
-
33
- #### Returns
34
-
35
- `Promise`\<\{
36
- `contentType?`: `string`;
37
- `data`: `unknown`;
38
- \}\>
39
-
40
- The download result
@@ -1,72 +0,0 @@
1
- ---
2
- title: 'Interface: IFileResourceStrategyConfig'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IFileResourceStrategyConfig
7
-
8
- Defined in: [resources/strategies/FileResourceStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L18)
9
-
10
- Configuration for the file resource strategy.
11
-
12
- ## Properties
13
-
14
- ### basePaths
15
-
16
- ```ts
17
- basePaths: string[];
18
- ```
19
-
20
- Defined in: [resources/strategies/FileResourceStrategy.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L24)
21
-
22
- Base paths to search for resources.
23
- Paths are tried in order until the resource is found.
24
-
25
- ***
26
-
27
- ### defaultEncoding?
28
-
29
- ```ts
30
- optional defaultEncoding?:
31
- | "ascii"
32
- | "utf8"
33
- | "utf-8"
34
- | "utf16le"
35
- | "ucs2"
36
- | "ucs-2"
37
- | "base64"
38
- | "base64url"
39
- | "latin1"
40
- | "binary"
41
- | "hex";
42
- ```
43
-
44
- Defined in: [resources/strategies/FileResourceStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L30)
45
-
46
- Optional default encoding for text files.
47
-
48
- #### Default
49
-
50
- ```ts
51
- 'utf-8'
52
- ```
53
-
54
- ***
55
-
56
- ### includeSubfolders?
57
-
58
- ```ts
59
- optional includeSubfolders?: boolean;
60
- ```
61
-
62
- Defined in: [resources/strategies/FileResourceStrategy.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L38)
63
-
64
- Enable recursive search in subdirectories.
65
- When enabled, the strategy will search for files in all subdirectories
66
- of the base paths using glob patterns.
67
-
68
- #### Default
69
-
70
- ```ts
71
- false
72
- ```
@@ -1,46 +0,0 @@
1
- ---
2
- title: 'Interface: IHealthCheckResult'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IHealthCheckResult
7
-
8
- Defined in: [health/IHealthCheckResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L6)
9
-
10
- Represents the result of a health check indicator.
11
-
12
- ## Properties
13
-
14
- ### details?
15
-
16
- ```ts
17
- optional details?: Record<string, unknown>;
18
- ```
19
-
20
- Defined in: [health/IHealthCheckResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L21)
21
-
22
- Optional additional details about the health check.
23
-
24
- ***
25
-
26
- ### name
27
-
28
- ```ts
29
- name: string;
30
- ```
31
-
32
- Defined in: [health/IHealthCheckResult.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L11)
33
-
34
- The name of the health indicator (e.g., 'database', 'app').
35
-
36
- ***
37
-
38
- ### status
39
-
40
- ```ts
41
- status: "up" | "down";
42
- ```
43
-
44
- Defined in: [health/IHealthCheckResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthCheckResult.ts#L16)
45
-
46
- The status of the health indicator ('up', 'down').
@@ -1,41 +0,0 @@
1
- ---
2
- title: 'Interface: IHealthIndicator'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IHealthIndicator
7
-
8
- Defined in: [health/IHealthIndicator.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthIndicator.ts#L12)
9
-
10
- Defines the contract for a health indicator that can be orchestrated.
11
-
12
- ## Properties
13
-
14
- ### key
15
-
16
- ```ts
17
- readonly key: string;
18
- ```
19
-
20
- Defined in: [health/IHealthIndicator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthIndicator.ts#L15)
21
-
22
- Unique key identifying the indicator
23
-
24
- ## Methods
25
-
26
- ### check()
27
-
28
- ```ts
29
- check():
30
- | HealthIndicatorResult<string>
31
- | Promise<HealthIndicatorResult<string>>;
32
- ```
33
-
34
- Defined in: [health/IHealthIndicator.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/IHealthIndicator.ts#L18)
35
-
36
- Performs the health check and returns a result keyed by the indicator key
37
-
38
- #### Returns
39
-
40
- \| `HealthIndicatorResult`\<`string`\>
41
- \| `Promise`\<`HealthIndicatorResult`\<`string`\>\>
@@ -1,76 +0,0 @@
1
- ---
2
- title: 'Interface: IMappingBuilder'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IMappingBuilder
7
-
8
- Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L18)
9
-
10
- Defines the interface for a mapping builder.
11
-
12
- ## Methods
13
-
14
- ### createKeyedMap()
15
-
16
- ```ts
17
- createKeyedMap<TInput, TOutput>(key, fn): this;
18
- ```
19
-
20
- Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L45)
21
-
22
- Creates a keyed mapping between two types with full type safety.
23
- The mapping key encodes both input and output types at compile time.
24
-
25
- #### Type Parameters
26
-
27
- | Type Parameter |
28
- | ------ |
29
- | `TInput` |
30
- | `TOutput` |
31
-
32
- #### Parameters
33
-
34
- | Parameter | Type | Description |
35
- | ------ | ------ | ------ |
36
- | `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
37
- | `fn` | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
38
-
39
- #### Returns
40
-
41
- `this`
42
-
43
- ***
44
-
45
- ### createMap()
46
-
47
- ```ts
48
- createMap<TSource, TDestination>(
49
- source,
50
- destination,
51
- fn): this;
52
- ```
53
-
54
- Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L31)
55
-
56
- Creates a mapping between two types.
57
- Ensures compile-time type compatibility between source and destination.
58
-
59
- #### Type Parameters
60
-
61
- | Type Parameter |
62
- | ------ |
63
- | `TSource` |
64
- | `TDestination` |
65
-
66
- #### Parameters
67
-
68
- | Parameter | Type | Description |
69
- | ------ | ------ | ------ |
70
- | `source` | `Constructor`\<`TSource`\> | The source type. |
71
- | `destination` | `Constructor`\<`TDestination`\> | The destination type. |
72
- | `fn` | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
73
-
74
- #### Returns
75
-
76
- `this`
@@ -1,58 +0,0 @@
1
- ---
2
- title: 'Interface: IMappingKey\<TInput, TOutput\>'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IMappingKey\<TInput, TOutput\>
7
-
8
- Defined in: [mapping/types/MappingKey.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L9)
9
-
10
- Type-safe mapping key that encodes both input and output types.
11
- This ensures compile-time type safety when using the mapping service.
12
-
13
- ## Type Parameters
14
-
15
- | Type Parameter | Description |
16
- | ------ | ------ |
17
- | `TInput` | The input type for the mapping. |
18
- | `TOutput` | The output type for the mapping. |
19
-
20
- ## Properties
21
-
22
- ### \_brand
23
-
24
- ```ts
25
- readonly _brand: "MappingKey";
26
- ```
27
-
28
- Defined in: [mapping/types/MappingKey.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L10)
29
-
30
- ***
31
-
32
- ### \_input
33
-
34
- ```ts
35
- readonly _input: TInput;
36
- ```
37
-
38
- Defined in: [mapping/types/MappingKey.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L11)
39
-
40
- ***
41
-
42
- ### \_output
43
-
44
- ```ts
45
- readonly _output: TOutput;
46
- ```
47
-
48
- Defined in: [mapping/types/MappingKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L12)
49
-
50
- ***
51
-
52
- ### key
53
-
54
- ```ts
55
- readonly key: string;
56
- ```
57
-
58
- Defined in: [mapping/types/MappingKey.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L13)
@@ -1,32 +0,0 @@
1
- ---
2
- title: 'Interface: IMappingProfile'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IMappingProfile
7
-
8
- Defined in: [mapping/profile/interfaces/IMappingProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L12)
9
-
10
- Defines the interface for a mapping profile.
11
-
12
- ## Methods
13
-
14
- ### configure()
15
-
16
- ```ts
17
- configure(builder): void;
18
- ```
19
-
20
- Defined in: [mapping/profile/interfaces/IMappingProfile.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L22)
21
-
22
- Configures the mapping profile.
23
-
24
- #### Parameters
25
-
26
- | Parameter | Type | Description |
27
- | ------ | ------ | ------ |
28
- | `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
29
-
30
- #### Returns
31
-
32
- `void`
@@ -1,89 +0,0 @@
1
- ---
2
- title: 'Interface: IResourceManagerConfig'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IResourceManagerConfig
7
-
8
- Defined in: [resources/ResourceManager.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L16)
9
-
10
- Configuration for the ResourceManager.
11
-
12
- ## Properties
13
-
14
- ### cache?
15
-
16
- ```ts
17
- optional cache?: ILayeredCache<string, IResourceResult>;
18
- ```
19
-
20
- Defined in: [resources/ResourceManager.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L26)
21
-
22
- Optional cache for loaded resources.
23
-
24
- ***
25
-
26
- ### cacheTtl?
27
-
28
- ```ts
29
- optional cacheTtl?: number;
30
- ```
31
-
32
- Defined in: [resources/ResourceManager.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L32)
33
-
34
- Cache TTL in seconds.
35
-
36
- #### Default
37
-
38
- ```ts
39
- 3600 (1 hour)
40
- ```
41
-
42
- ***
43
-
44
- ### debug?
45
-
46
- ```ts
47
- optional debug?: boolean;
48
- ```
49
-
50
- Defined in: [resources/ResourceManager.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L38)
51
-
52
- Enable debug logging.
53
-
54
- #### Default
55
-
56
- ```ts
57
- false
58
- ```
59
-
60
- ***
61
-
62
- ### strategies
63
-
64
- ```ts
65
- strategies: IResourceStrategy[];
66
- ```
67
-
68
- Defined in: [resources/ResourceManager.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L21)
69
-
70
- Resource loading strategies in priority order.
71
- First strategy that finds the resource wins.
72
-
73
- ***
74
-
75
- ### strategyTimeoutMs?
76
-
77
- ```ts
78
- optional strategyTimeoutMs?: number;
79
- ```
80
-
81
- Defined in: [resources/ResourceManager.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L44)
82
-
83
- Timeout in milliseconds for a single async strategy load.
84
-
85
- #### Default
86
-
87
- ```ts
88
- 30000 (30 seconds)
89
- ```
@@ -1,94 +0,0 @@
1
- ---
2
- title: 'Interface: IResourceMetadata'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IResourceMetadata
7
-
8
- Defined in: [resources/types/IResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L6)
9
-
10
- Metadata about a resource.
11
-
12
- ## Properties
13
-
14
- ### cachedAt?
15
-
16
- ```ts
17
- optional cachedAt?: Date;
18
- ```
19
-
20
- Defined in: [resources/types/IResourceMetadata.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L41)
21
-
22
- When this resource was cached (if applicable).
23
-
24
- ***
25
-
26
- ### encoding?
27
-
28
- ```ts
29
- optional encoding?: BufferEncoding;
30
- ```
31
-
32
- Defined in: [resources/types/IResourceMetadata.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L31)
33
-
34
- The encoding of the resource (if applicable).
35
-
36
- ***
37
-
38
- ### key
39
-
40
- ```ts
41
- key: string;
42
- ```
43
-
44
- Defined in: [resources/types/IResourceMetadata.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L11)
45
-
46
- The resource key/identifier.
47
-
48
- ***
49
-
50
- ### mimeType
51
-
52
- ```ts
53
- mimeType: string;
54
- ```
55
-
56
- Defined in: [resources/types/IResourceMetadata.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L21)
57
-
58
- The MIME type of the resource.
59
-
60
- ***
61
-
62
- ### path
63
-
64
- ```ts
65
- path: string;
66
- ```
67
-
68
- Defined in: [resources/types/IResourceMetadata.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L16)
69
-
70
- The full path of the resource.
71
-
72
- ***
73
-
74
- ### size
75
-
76
- ```ts
77
- size: number;
78
- ```
79
-
80
- Defined in: [resources/types/IResourceMetadata.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L26)
81
-
82
- The size of the resource in bytes.
83
-
84
- ***
85
-
86
- ### source
87
-
88
- ```ts
89
- source: string;
90
- ```
91
-
92
- Defined in: [resources/types/IResourceMetadata.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L36)
93
-
94
- The source strategy that resolved this resource.
@@ -1,34 +0,0 @@
1
- ---
2
- title: 'Interface: IResourceResult'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IResourceResult
7
-
8
- Defined in: [resources/types/IResourceResult.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L8)
9
-
10
- Result of loading a resource.
11
-
12
- ## Properties
13
-
14
- ### content
15
-
16
- ```ts
17
- content: Buffer;
18
- ```
19
-
20
- Defined in: [resources/types/IResourceResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L13)
21
-
22
- The resource content as a Buffer.
23
-
24
- ***
25
-
26
- ### metadata
27
-
28
- ```ts
29
- metadata: IResourceMetadata;
30
- ```
31
-
32
- Defined in: [resources/types/IResourceResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L18)
33
-
34
- Metadata about the resource.