@breadstone/archipel-mcp 0.0.6 → 0.0.8
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.
- package/data/packages/index.md +13 -6
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +9 -9
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +1 -1
- package/data/packages/platform-authentication/api/index.md +4 -0
- package/data/packages/{platform-core → platform-caching}/api/Class.MemoryLayeredCache.md +41 -33
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +158 -0
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +296 -0
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +122 -0
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +71 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +199 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +76 -0
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +122 -0
- package/data/packages/platform-caching/api/index.md +25 -0
- package/data/packages/platform-caching/index.md +116 -0
- package/data/packages/platform-core/api/index.md +104 -150
- package/data/packages/platform-core/index.md +5 -3
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +73 -0
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +52 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Class.OtpService.md +8 -4
- package/data/packages/{platform-core → platform-cryptography}/api/Interface.IOtpService.md +8 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +47 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-cryptography/api/index.md +29 -0
- package/data/packages/platform-cryptography/index.md +132 -0
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistrarBase.md +7 -5
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistry.md +19 -15
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceModule.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceTextGenerator.md +7 -7
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +32 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +72 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +79 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +73 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +36 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +59 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +95 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +61 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +54 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +25 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Variable.IntelligenceConversationMessageRoles.md +6 -6
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +29 -0
- package/data/packages/platform-intelligence/api/index.md +70 -0
- package/data/packages/platform-intelligence/index.md +131 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +15 -15
- package/package.json +1 -1
- package/data/packages/platform-core/api/Class.BcryptService.md +0 -69
- package/data/packages/platform-core/api/Class.CryptoService.md +0 -50
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +0 -157
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +0 -275
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +0 -121
- package/data/packages/platform-core/api/Interface.ICacheStats.md +0 -71
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +0 -62
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +0 -69
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +0 -63
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +0 -32
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +0 -51
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +0 -81
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +0 -53
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +0 -46
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +0 -194
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +0 -71
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +0 -47
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +0 -108
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +0 -29
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceProviderConfiguration'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceProviderConfiguration
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L12)
|
|
10
|
-
|
|
11
|
-
Describes the resolved configuration for the intelligence provider.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### apiKey
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly apiKey: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L17)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### baseUrl
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly baseUrl: string | null;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L18)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### maxOutputTokens
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly maxOutputTokens: number;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L21)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
### model
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
readonly model: string;
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L16)
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
### provider
|
|
56
|
-
|
|
57
|
-
```ts
|
|
58
|
-
readonly provider: IntelligenceProviderName;
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L15)
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
### temperature
|
|
66
|
-
|
|
67
|
-
```ts
|
|
68
|
-
readonly temperature: number;
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L19)
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
### topP
|
|
76
|
-
|
|
77
|
-
```ts
|
|
78
|
-
readonly topP: number;
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L20)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceResponseMessage'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceResponseMessage
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceResponseMessage.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceResponseMessage.ts#L10)
|
|
10
|
-
|
|
11
|
-
Represents a single assistant message returned by a capability.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### content
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly content: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceResponseMessage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceResponseMessage.ts#L13)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### metadata?
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly optional metadata?: Record<string, unknown>;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceResponseMessage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceResponseMessage.ts#L14)
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceTextCompletion'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceTextCompletion
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L13)
|
|
10
|
-
|
|
11
|
-
Represents the normalized completion result produced by the intelligence provider.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### model
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly model: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L18)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### provider
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly provider: IntelligenceProviderName;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L17)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### text
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly text: string;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L16)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
### usage
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
readonly usage:
|
|
49
|
-
| IIntelligenceCompletionUsage
|
|
50
|
-
| null;
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L19)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceTextGenerationOptions'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceTextGenerationOptions
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L10)
|
|
10
|
-
|
|
11
|
-
Options that can be supplied when generating text with the intelligence provider.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### maxOutputTokens?
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly optional maxOutputTokens?: number;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L15)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### temperature?
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly optional temperature?: number;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L13)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### topP?
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly optional topP?: number;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L14)
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceTextGenerator'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceTextGenerator
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/IIntelligenceTextGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceTextGenerator.ts#L15)
|
|
10
|
-
|
|
11
|
-
Abstraction responsible for executing text completions using the configured provider.
|
|
12
|
-
|
|
13
|
-
## Methods
|
|
14
|
-
|
|
15
|
-
### generateText()
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/IIntelligenceTextGenerator.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceTextGenerator.ts#L19)
|
|
22
|
-
|
|
23
|
-
#### Parameters
|
|
24
|
-
|
|
25
|
-
| Parameter | Type |
|
|
26
|
-
| ---------- | ------------------------------------------------------------------------------------ |
|
|
27
|
-
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
|
|
28
|
-
| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) |
|
|
29
|
-
|
|
30
|
-
#### Returns
|
|
31
|
-
|
|
32
|
-
`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
### getConfiguration()
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
Defined in: [intelligence/IIntelligenceTextGenerator.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceTextGenerator.ts#L21)
|
|
43
|
-
|
|
44
|
-
#### Returns
|
|
45
|
-
|
|
46
|
-
[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
|
|
@@ -1,194 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: ILayeredCache\<TKey, TValue\>'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: ILayeredCache\<TKey, TValue\>
|
|
8
|
-
|
|
9
|
-
Defined in: [cache/ILayeredCache.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L14)
|
|
10
|
-
|
|
11
|
-
Generic layered cache contract (DB first, then memory, then external fetcher).
|
|
12
|
-
|
|
13
|
-
## Type Parameters
|
|
14
|
-
|
|
15
|
-
| Type Parameter | Description |
|
|
16
|
-
| -------------- | ----------------------------- |
|
|
17
|
-
| `TKey` | The type of the cache keys. |
|
|
18
|
-
| `TValue` | The type of the cache values. |
|
|
19
|
-
|
|
20
|
-
## Methods
|
|
21
|
-
|
|
22
|
-
### get()
|
|
23
|
-
|
|
24
|
-
```ts
|
|
25
|
-
get(key): TValue | undefined;
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
Defined in: [cache/ILayeredCache.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L24)
|
|
29
|
-
|
|
30
|
-
Retrieves a value from the cache.
|
|
31
|
-
|
|
32
|
-
#### Parameters
|
|
33
|
-
|
|
34
|
-
| Parameter | Type | Description |
|
|
35
|
-
| --------- | ------ | -------------------- |
|
|
36
|
-
| `key` | `TKey` | The key to retrieve. |
|
|
37
|
-
|
|
38
|
-
#### Returns
|
|
39
|
-
|
|
40
|
-
`TValue` \| `undefined`
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
|
|
44
|
-
### getAsync()
|
|
45
|
-
|
|
46
|
-
```ts
|
|
47
|
-
getAsync(key): Promise<TValue | undefined>;
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
Defined in: [cache/ILayeredCache.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L32)
|
|
51
|
-
|
|
52
|
-
Retrieves a value from the cache (asynchronous).
|
|
53
|
-
|
|
54
|
-
#### Parameters
|
|
55
|
-
|
|
56
|
-
| Parameter | Type | Description |
|
|
57
|
-
| --------- | ------ | -------------------- |
|
|
58
|
-
| `key` | `TKey` | The key to retrieve. |
|
|
59
|
-
|
|
60
|
-
#### Returns
|
|
61
|
-
|
|
62
|
-
`Promise`\<`TValue` \| `undefined`\>
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
### invalidate()
|
|
67
|
-
|
|
68
|
-
```ts
|
|
69
|
-
invalidate(key): void;
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
Defined in: [cache/ILayeredCache.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L67)
|
|
73
|
-
|
|
74
|
-
Invalidates a key in the cache.
|
|
75
|
-
|
|
76
|
-
#### Parameters
|
|
77
|
-
|
|
78
|
-
| Parameter | Type | Description |
|
|
79
|
-
| --------- | ------ | ---------------------- |
|
|
80
|
-
| `key` | `TKey` | The key to invalidate. |
|
|
81
|
-
|
|
82
|
-
#### Returns
|
|
83
|
-
|
|
84
|
-
`void`
|
|
85
|
-
|
|
86
|
-
---
|
|
87
|
-
|
|
88
|
-
### invalidateAsync()
|
|
89
|
-
|
|
90
|
-
```ts
|
|
91
|
-
invalidateAsync(key): Promise<void>;
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
Defined in: [cache/ILayeredCache.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L75)
|
|
95
|
-
|
|
96
|
-
Invalidates a key in the cache (asynchronous).
|
|
97
|
-
|
|
98
|
-
#### Parameters
|
|
99
|
-
|
|
100
|
-
| Parameter | Type | Description |
|
|
101
|
-
| --------- | ------ | ---------------------- |
|
|
102
|
-
| `key` | `TKey` | The key to invalidate. |
|
|
103
|
-
|
|
104
|
-
#### Returns
|
|
105
|
-
|
|
106
|
-
`Promise`\<`void`\>
|
|
107
|
-
|
|
108
|
-
---
|
|
109
|
-
|
|
110
|
-
### set()
|
|
111
|
-
|
|
112
|
-
```ts
|
|
113
|
-
set(key, value): void;
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
Defined in: [cache/ILayeredCache.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L41)
|
|
117
|
-
|
|
118
|
-
Sets a value in the cache.
|
|
119
|
-
|
|
120
|
-
#### Parameters
|
|
121
|
-
|
|
122
|
-
| Parameter | Type | Description |
|
|
123
|
-
| --------- | -------- | ----------------- |
|
|
124
|
-
| `key` | `TKey` | The key to set. |
|
|
125
|
-
| `value` | `TValue` | The value to set. |
|
|
126
|
-
|
|
127
|
-
#### Returns
|
|
128
|
-
|
|
129
|
-
`void`
|
|
130
|
-
|
|
131
|
-
---
|
|
132
|
-
|
|
133
|
-
### setAsync()
|
|
134
|
-
|
|
135
|
-
```ts
|
|
136
|
-
setAsync(key, value): Promise<void>;
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
Defined in: [cache/ILayeredCache.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L50)
|
|
140
|
-
|
|
141
|
-
Sets a value in the cache (asynchronous).
|
|
142
|
-
|
|
143
|
-
#### Parameters
|
|
144
|
-
|
|
145
|
-
| Parameter | Type | Description |
|
|
146
|
-
| --------- | -------- | ----------------- |
|
|
147
|
-
| `key` | `TKey` | The key to set. |
|
|
148
|
-
| `value` | `TValue` | The value to set. |
|
|
149
|
-
|
|
150
|
-
#### Returns
|
|
151
|
-
|
|
152
|
-
`Promise`\<`void`\>
|
|
153
|
-
|
|
154
|
-
---
|
|
155
|
-
|
|
156
|
-
### stats()?
|
|
157
|
-
|
|
158
|
-
```ts
|
|
159
|
-
optional stats(): ICacheStats;
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
Defined in: [cache/ILayeredCache.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L83)
|
|
163
|
-
|
|
164
|
-
Retrieves cache statistics.
|
|
165
|
-
|
|
166
|
-
#### Returns
|
|
167
|
-
|
|
168
|
-
[`ICacheStats`](Interface.ICacheStats)
|
|
169
|
-
|
|
170
|
-
The cache statistics.
|
|
171
|
-
|
|
172
|
-
---
|
|
173
|
-
|
|
174
|
-
### warm()?
|
|
175
|
-
|
|
176
|
-
```ts
|
|
177
|
-
optional warm(key): Promise<TValue | undefined>;
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
Defined in: [cache/ILayeredCache.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L59)
|
|
181
|
-
|
|
182
|
-
Proactively warms the cache for a given key (optional).
|
|
183
|
-
|
|
184
|
-
#### Parameters
|
|
185
|
-
|
|
186
|
-
| Parameter | Type | Description |
|
|
187
|
-
| --------- | ------ | ---------------- |
|
|
188
|
-
| `key` | `TKey` | The key to warm. |
|
|
189
|
-
|
|
190
|
-
#### Returns
|
|
191
|
-
|
|
192
|
-
`Promise`\<`TValue` \| `undefined`\>
|
|
193
|
-
|
|
194
|
-
The value that was loaded and cached, or undefined if not found.
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: ILayeredCacheOptions'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: ILayeredCacheOptions
|
|
8
|
-
|
|
9
|
-
Defined in: [cache/MemoryLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L16)
|
|
10
|
-
|
|
11
|
-
In-memory layered cache: memory (LRU+TTL+SWR) + async loader fallback.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### cacheName?
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
optional cacheName?: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [cache/MemoryLayeredCache.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L53)
|
|
22
|
-
|
|
23
|
-
An optional name/label for the cache, used in metrics (default: 'memory').
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
### maxEntries?
|
|
28
|
-
|
|
29
|
-
```ts
|
|
30
|
-
optional maxEntries?: number;
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Defined in: [cache/MemoryLayeredCache.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L39)
|
|
34
|
-
|
|
35
|
-
Maximum number of entries in the cache (optional, default: infinite).
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
### metricsRecorder?
|
|
40
|
-
|
|
41
|
-
```ts
|
|
42
|
-
optional metricsRecorder?: ICacheMetricsRecorder;
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Defined in: [cache/MemoryLayeredCache.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L46)
|
|
46
|
-
|
|
47
|
-
Metrics recorder for cache statistics (optional, default: NoopCacheMetricsRecorder).
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
### staleWhileRevalidate?
|
|
52
|
-
|
|
53
|
-
```ts
|
|
54
|
-
optional staleWhileRevalidate?: boolean;
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Defined in: [cache/MemoryLayeredCache.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L32)
|
|
58
|
-
|
|
59
|
-
Whether to serve stale content while revalidating (optional, default: false).
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
### ttlMs?
|
|
64
|
-
|
|
65
|
-
```ts
|
|
66
|
-
optional ttlMs?: number;
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
Defined in: [cache/MemoryLayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L25)
|
|
70
|
-
|
|
71
|
-
Time to live in milliseconds (optional, default: infinite).
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IOtpUriOptions'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IOtpUriOptions
|
|
8
|
-
|
|
9
|
-
Defined in: [services/IOtpService.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L6)
|
|
10
|
-
|
|
11
|
-
Options for generating an OTP authentication URI (otpauth://).
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### issuer
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly issuer: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [services/IOtpService.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L11)
|
|
22
|
-
|
|
23
|
-
The issuer name displayed in the authenticator app.
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
### label
|
|
28
|
-
|
|
29
|
-
```ts
|
|
30
|
-
readonly label: string;
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Defined in: [services/IOtpService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L16)
|
|
34
|
-
|
|
35
|
-
The account label (e.g. email or username) shown in the authenticator app.
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
### secret
|
|
40
|
-
|
|
41
|
-
```ts
|
|
42
|
-
readonly secret: string;
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Defined in: [services/IOtpService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L21)
|
|
46
|
-
|
|
47
|
-
The shared secret used for TOTP generation.
|
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IRedisLayeredCacheOptions\<TValue\>'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IRedisLayeredCacheOptions\<TValue\>
|
|
8
|
-
|
|
9
|
-
Defined in: [cache/RedisLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L16)
|
|
10
|
-
|
|
11
|
-
Skeleton Redis-backed cache (placeholder; implement ioredis logic later).
|
|
12
|
-
Provides same contract as in-memory layered cache; currently delegates to provided loader only.
|
|
13
|
-
|
|
14
|
-
## Type Parameters
|
|
15
|
-
|
|
16
|
-
| Type Parameter |
|
|
17
|
-
| -------------- |
|
|
18
|
-
| `TValue` |
|
|
19
|
-
|
|
20
|
-
## Properties
|
|
21
|
-
|
|
22
|
-
### cacheName?
|
|
23
|
-
|
|
24
|
-
```ts
|
|
25
|
-
optional cacheName?: string;
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
Defined in: [cache/RedisLayeredCache.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L23)
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
### deserialize?
|
|
33
|
-
|
|
34
|
-
```ts
|
|
35
|
-
optional deserialize?: (raw) => TValue;
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Defined in: [cache/RedisLayeredCache.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L21)
|
|
39
|
-
|
|
40
|
-
#### Parameters
|
|
41
|
-
|
|
42
|
-
| Parameter | Type |
|
|
43
|
-
| --------- | -------- |
|
|
44
|
-
| `raw` | `string` |
|
|
45
|
-
|
|
46
|
-
#### Returns
|
|
47
|
-
|
|
48
|
-
`TValue`
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
### keyPrefix
|
|
53
|
-
|
|
54
|
-
```ts
|
|
55
|
-
keyPrefix: string;
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
Defined in: [cache/RedisLayeredCache.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L18)
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
### metricsRecorder?
|
|
63
|
-
|
|
64
|
-
```ts
|
|
65
|
-
optional metricsRecorder?: ICacheMetricsRecorder;
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Defined in: [cache/RedisLayeredCache.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L22)
|
|
69
|
-
|
|
70
|
-
---
|
|
71
|
-
|
|
72
|
-
### serialize?
|
|
73
|
-
|
|
74
|
-
```ts
|
|
75
|
-
optional serialize?: (value) => string;
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
Defined in: [cache/RedisLayeredCache.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L20)
|
|
79
|
-
|
|
80
|
-
#### Parameters
|
|
81
|
-
|
|
82
|
-
| Parameter | Type |
|
|
83
|
-
| --------- | -------- |
|
|
84
|
-
| `value` | `TValue` |
|
|
85
|
-
|
|
86
|
-
#### Returns
|
|
87
|
-
|
|
88
|
-
`string`
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
### ttlSeconds?
|
|
93
|
-
|
|
94
|
-
```ts
|
|
95
|
-
optional ttlSeconds?: number;
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
Defined in: [cache/RedisLayeredCache.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L19)
|
|
99
|
-
|
|
100
|
-
---
|
|
101
|
-
|
|
102
|
-
### url
|
|
103
|
-
|
|
104
|
-
```ts
|
|
105
|
-
url: string;
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
Defined in: [cache/RedisLayeredCache.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L17)
|