@breadstone/archipel-mcp 0.0.8 → 0.0.9
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/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +7 -7
- package/data/packages/platform-authentication/api/{Class.AppleStrategy.md → Class.AppleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +6 -6
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +79 -0
- package/data/packages/platform-authentication/api/{Class.GoogleStrategy.md → Class.GoogleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.MfaService.md +11 -11
- package/data/packages/platform-authentication/api/{Class.MicrosoftStrategy.md → Class.MicrosoftConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +145 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +7 -7
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +47 -17
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +12 -12
- 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 +1 -1
- 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 +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +1 -1
- 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 +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.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/Variable.TOTP_MFA_PROVIDERS.md +30 -0
- package/data/packages/platform-authentication/api/index.md +7 -4
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -2
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -1
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +10 -10
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +5 -5
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +8 -8
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +5 -5
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +5 -5
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +8 -8
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +5 -5
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +7 -7
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -3
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +5 -5
- package/data/packages/platform-core/api/Class.HostService.md +8 -8
- package/data/packages/platform-core/api/Class.ResourceManager.md +19 -19
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -4
- package/data/packages/platform-core/api/Variable.APP_NAME.md +15 -0
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -1
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-core/api/index.md +2 -0
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +2 -2
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +2 -2
- package/data/packages/platform-cryptography/api/Class.OtpService.md +4 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +4 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +4 -4
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +4 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +1 -1
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +2 -2
- package/data/packages/platform-mailing/api/Class.MailService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +1 -1
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
- package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
- package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: ResourceManager
|
|
8
8
|
|
|
9
|
-
Defined in: [resources/ResourceManager.ts:
|
|
9
|
+
Defined in: [resources/ResourceManager.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L68)
|
|
10
10
|
|
|
11
11
|
Central manager for loading resources from various sources.
|
|
12
12
|
Supports multiple strategies (file, blob, embedded) with caching.
|
|
@@ -23,7 +23,7 @@ Supports multiple strategies (file, blob, embedded) with caching.
|
|
|
23
23
|
new ResourceManager(config): ResourceManager;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [resources/ResourceManager.ts:
|
|
26
|
+
Defined in: [resources/ResourceManager.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L85)
|
|
27
27
|
|
|
28
28
|
Constructs a new instance of the `ResourceManager` class.
|
|
29
29
|
|
|
@@ -45,7 +45,7 @@ Constructs a new instance of the `ResourceManager` class.
|
|
|
45
45
|
exists(key): boolean;
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Defined in: [resources/ResourceManager.ts:
|
|
48
|
+
Defined in: [resources/ResourceManager.ts:359](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L359)
|
|
49
49
|
|
|
50
50
|
Checks if a resource exists.
|
|
51
51
|
|
|
@@ -75,7 +75,7 @@ IResourceManager.exists;
|
|
|
75
75
|
existsAsync(key): Promise<boolean>;
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Defined in: [resources/ResourceManager.ts:
|
|
78
|
+
Defined in: [resources/ResourceManager.ts:376](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L376)
|
|
79
79
|
|
|
80
80
|
Checks if a resource exists (asynchronous).
|
|
81
81
|
|
|
@@ -105,7 +105,7 @@ IResourceManager.existsAsync;
|
|
|
105
105
|
invalidate(key): void;
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
-
Defined in: [resources/ResourceManager.ts:
|
|
108
|
+
Defined in: [resources/ResourceManager.ts:392](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L392)
|
|
109
109
|
|
|
110
110
|
Invalidates cached resource.
|
|
111
111
|
|
|
@@ -133,7 +133,7 @@ IResourceManager.invalidate;
|
|
|
133
133
|
invalidateAsync(key): Promise<void>;
|
|
134
134
|
```
|
|
135
135
|
|
|
136
|
-
Defined in: [resources/ResourceManager.ts:
|
|
136
|
+
Defined in: [resources/ResourceManager.ts:406](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L406)
|
|
137
137
|
|
|
138
138
|
Invalidates cached resource (asynchronous).
|
|
139
139
|
|
|
@@ -163,7 +163,7 @@ IResourceManager.invalidateAsync;
|
|
|
163
163
|
load(key): IResourceResult;
|
|
164
164
|
```
|
|
165
165
|
|
|
166
|
-
Defined in: [resources/ResourceManager.ts:
|
|
166
|
+
Defined in: [resources/ResourceManager.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L107)
|
|
167
167
|
|
|
168
168
|
Loads a resource by its key.
|
|
169
169
|
|
|
@@ -197,7 +197,7 @@ IResourceManager.load;
|
|
|
197
197
|
loadAsBuffer(key): Buffer;
|
|
198
198
|
```
|
|
199
199
|
|
|
200
|
-
Defined in: [resources/ResourceManager.ts:
|
|
200
|
+
Defined in: [resources/ResourceManager.ts:300](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L300)
|
|
201
201
|
|
|
202
202
|
Loads a resource as a Buffer.
|
|
203
203
|
|
|
@@ -231,7 +231,7 @@ IResourceManager.loadAsBuffer;
|
|
|
231
231
|
loadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike>>;
|
|
232
232
|
```
|
|
233
233
|
|
|
234
|
-
Defined in: [resources/ResourceManager.ts:
|
|
234
|
+
Defined in: [resources/ResourceManager.ts:330](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L330)
|
|
235
235
|
|
|
236
236
|
Loads a resource as a Buffer (asynchronous).
|
|
237
237
|
|
|
@@ -265,7 +265,7 @@ IResourceManager.loadAsBufferAsync;
|
|
|
265
265
|
loadAsString(key, encoding?): string;
|
|
266
266
|
```
|
|
267
267
|
|
|
268
|
-
Defined in: [resources/ResourceManager.ts:
|
|
268
|
+
Defined in: [resources/ResourceManager.ts:224](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L224)
|
|
269
269
|
|
|
270
270
|
Loads a resource as a string.
|
|
271
271
|
|
|
@@ -300,7 +300,7 @@ IResourceManager.loadAsString;
|
|
|
300
300
|
loadAsStringAsync(key, encoding?): Promise<string>;
|
|
301
301
|
```
|
|
302
302
|
|
|
303
|
-
Defined in: [resources/ResourceManager.ts:
|
|
303
|
+
Defined in: [resources/ResourceManager.ts:261](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L261)
|
|
304
304
|
|
|
305
305
|
Loads a resource as a string (asynchronous).
|
|
306
306
|
|
|
@@ -335,7 +335,7 @@ IResourceManager.loadAsStringAsync;
|
|
|
335
335
|
loadAsync(key): Promise<IResourceResult>;
|
|
336
336
|
```
|
|
337
337
|
|
|
338
|
-
Defined in: [resources/ResourceManager.ts:
|
|
338
|
+
Defined in: [resources/ResourceManager.ts:165](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L165)
|
|
339
339
|
|
|
340
340
|
Loads a resource by its key (asynchronous).
|
|
341
341
|
|
|
@@ -369,7 +369,7 @@ IResourceManager.loadAsync;
|
|
|
369
369
|
tryLoad(key): IResourceResult | undefined;
|
|
370
370
|
```
|
|
371
371
|
|
|
372
|
-
Defined in: [resources/ResourceManager.ts:
|
|
372
|
+
Defined in: [resources/ResourceManager.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L124)
|
|
373
373
|
|
|
374
374
|
Tries to load a resource by its key.
|
|
375
375
|
|
|
@@ -399,7 +399,7 @@ IResourceManager.tryLoad;
|
|
|
399
399
|
tryLoadAsBuffer(key): Buffer<ArrayBufferLike> | undefined;
|
|
400
400
|
```
|
|
401
401
|
|
|
402
|
-
Defined in: [resources/ResourceManager.ts:
|
|
402
|
+
Defined in: [resources/ResourceManager.ts:317](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L317)
|
|
403
403
|
|
|
404
404
|
Tries to load a resource as a Buffer.
|
|
405
405
|
|
|
@@ -429,7 +429,7 @@ IResourceManager.tryLoadAsBuffer;
|
|
|
429
429
|
tryLoadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike> | undefined>;
|
|
430
430
|
```
|
|
431
431
|
|
|
432
|
-
Defined in: [resources/ResourceManager.ts:
|
|
432
|
+
Defined in: [resources/ResourceManager.ts:347](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L347)
|
|
433
433
|
|
|
434
434
|
Tries to load a resource as a Buffer (asynchronous).
|
|
435
435
|
|
|
@@ -459,7 +459,7 @@ IResourceManager.tryLoadAsBufferAsync;
|
|
|
459
459
|
tryLoadAsString(key, encoding?): string | undefined;
|
|
460
460
|
```
|
|
461
461
|
|
|
462
|
-
Defined in: [resources/ResourceManager.ts:
|
|
462
|
+
Defined in: [resources/ResourceManager.ts:242](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L242)
|
|
463
463
|
|
|
464
464
|
Tries to load a resource as a string.
|
|
465
465
|
|
|
@@ -490,7 +490,7 @@ IResourceManager.tryLoadAsString;
|
|
|
490
490
|
tryLoadAsStringAsync(key, encoding?): Promise<string | undefined>;
|
|
491
491
|
```
|
|
492
492
|
|
|
493
|
-
Defined in: [resources/ResourceManager.ts:
|
|
493
|
+
Defined in: [resources/ResourceManager.ts:279](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L279)
|
|
494
494
|
|
|
495
495
|
Tries to load a resource as a string (asynchronous).
|
|
496
496
|
|
|
@@ -521,7 +521,7 @@ IResourceManager.tryLoadAsStringAsync;
|
|
|
521
521
|
tryLoadAsync(key): Promise<IResourceResult | undefined>;
|
|
522
522
|
```
|
|
523
523
|
|
|
524
|
-
Defined in: [resources/ResourceManager.ts:
|
|
524
|
+
Defined in: [resources/ResourceManager.ts:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L182)
|
|
525
525
|
|
|
526
526
|
Tries to load a resource by its key (asynchronous).
|
|
527
527
|
|
|
@@ -551,7 +551,7 @@ IResourceManager.tryLoadAsync;
|
|
|
551
551
|
whatDoIHave(): void;
|
|
552
552
|
```
|
|
553
553
|
|
|
554
|
-
Defined in: [resources/ResourceManager.ts:
|
|
554
|
+
Defined in: [resources/ResourceManager.ts:418](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L418)
|
|
555
555
|
|
|
556
556
|
List all files and folders in the base paths for debugging purposes.
|
|
557
557
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IErrorPageParams
|
|
8
8
|
|
|
9
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
9
|
+
Defined in: [services/ErrorTemplateService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L19)
|
|
10
10
|
|
|
11
11
|
Parameters for generating error page content.
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Parameters for generating error page content.
|
|
|
18
18
|
optional actionText?: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
21
|
+
Defined in: [services/ErrorTemplateService.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L50)
|
|
22
22
|
|
|
23
23
|
Optional action button text.
|
|
24
24
|
|
|
@@ -38,7 +38,7 @@ optional footer?: {
|
|
|
38
38
|
};
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
41
|
+
Defined in: [services/ErrorTemplateService.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L69)
|
|
42
42
|
|
|
43
43
|
Optional footer configuration.
|
|
44
44
|
|
|
@@ -56,7 +56,7 @@ copyright: string;
|
|
|
56
56
|
message: string;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
59
|
+
Defined in: [services/ErrorTemplateService.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L34)
|
|
60
60
|
|
|
61
61
|
The error message.
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ The error message.
|
|
|
68
68
|
path: string;
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
71
|
+
Defined in: [services/ErrorTemplateService.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L39)
|
|
72
72
|
|
|
73
73
|
The request path.
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ The request path.
|
|
|
80
80
|
optional showDetails?: boolean;
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
83
|
+
Defined in: [services/ErrorTemplateService.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L56)
|
|
84
84
|
|
|
85
85
|
Whether to show error details (path, timestamp).
|
|
86
86
|
|
|
@@ -98,7 +98,7 @@ false in production;
|
|
|
98
98
|
statusCode: number;
|
|
99
99
|
```
|
|
100
100
|
|
|
101
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
101
|
+
Defined in: [services/ErrorTemplateService.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L24)
|
|
102
102
|
|
|
103
103
|
The HTTP status code.
|
|
104
104
|
|
|
@@ -113,7 +113,7 @@ optional style?: {
|
|
|
113
113
|
};
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
116
|
+
Defined in: [services/ErrorTemplateService.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L61)
|
|
117
117
|
|
|
118
118
|
Optional style configuration.
|
|
119
119
|
|
|
@@ -137,7 +137,7 @@ secondary: string;
|
|
|
137
137
|
optional timestamp?: string;
|
|
138
138
|
```
|
|
139
139
|
|
|
140
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
140
|
+
Defined in: [services/ErrorTemplateService.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L44)
|
|
141
141
|
|
|
142
142
|
Optional timestamp.
|
|
143
143
|
|
|
@@ -149,6 +149,6 @@ Optional timestamp.
|
|
|
149
149
|
title: string;
|
|
150
150
|
```
|
|
151
151
|
|
|
152
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
152
|
+
Defined in: [services/ErrorTemplateService.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L29)
|
|
153
153
|
|
|
154
154
|
The error title.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IHostContentParams
|
|
8
8
|
|
|
9
|
-
Defined in: [services/HostService.ts:
|
|
9
|
+
Defined in: [services/HostService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L19)
|
|
10
10
|
|
|
11
11
|
Parameters for generating host content.
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ optional actions?: {
|
|
|
21
21
|
}[];
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [services/HostService.ts:
|
|
24
|
+
Defined in: [services/HostService.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L39)
|
|
25
25
|
|
|
26
26
|
Optional array of action buttons (CTAs).
|
|
27
27
|
|
|
@@ -49,7 +49,7 @@ The link URL for the action.
|
|
|
49
49
|
optional data?: Record<string, unknown>;
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
Defined in: [services/HostService.ts:
|
|
52
|
+
Defined in: [services/HostService.ts:132](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L132)
|
|
53
53
|
|
|
54
54
|
Optional additional data to be injected into the template.
|
|
55
55
|
|
|
@@ -61,7 +61,7 @@ Optional additional data to be injected into the template.
|
|
|
61
61
|
description: string;
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Defined in: [services/HostService.ts:
|
|
64
|
+
Defined in: [services/HostService.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L29)
|
|
65
65
|
|
|
66
66
|
The subtitle/description of the page.
|
|
67
67
|
|
|
@@ -78,7 +78,7 @@ optional features?: {
|
|
|
78
78
|
}[];
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
Defined in: [services/HostService.ts:
|
|
81
|
+
Defined in: [services/HostService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L55)
|
|
82
82
|
|
|
83
83
|
Optional array of feature cards.
|
|
84
84
|
|
|
@@ -130,7 +130,7 @@ optional footer?: {
|
|
|
130
130
|
};
|
|
131
131
|
```
|
|
132
132
|
|
|
133
|
-
Defined in: [services/HostService.ts:
|
|
133
|
+
Defined in: [services/HostService.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L95)
|
|
134
134
|
|
|
135
135
|
Optional footer configuration.
|
|
136
136
|
|
|
@@ -177,7 +177,7 @@ Optional version string.
|
|
|
177
177
|
optional health?: IHealthCheckResult[];
|
|
178
178
|
```
|
|
179
179
|
|
|
180
|
-
Defined in: [services/HostService.ts:
|
|
180
|
+
Defined in: [services/HostService.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L90)
|
|
181
181
|
|
|
182
182
|
Optional health check result to display.
|
|
183
183
|
|
|
@@ -189,7 +189,7 @@ Optional health check result to display.
|
|
|
189
189
|
logo: string;
|
|
190
190
|
```
|
|
191
191
|
|
|
192
|
-
Defined in: [services/HostService.ts:
|
|
192
|
+
Defined in: [services/HostService.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L34)
|
|
193
193
|
|
|
194
194
|
The logo URL (can be a regular URL or data URL).
|
|
195
195
|
|
|
@@ -204,7 +204,7 @@ optional style?: {
|
|
|
204
204
|
};
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
Defined in: [services/HostService.ts:
|
|
207
|
+
Defined in: [services/HostService.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L82)
|
|
208
208
|
|
|
209
209
|
Optional style configuration.
|
|
210
210
|
|
|
@@ -228,6 +228,6 @@ secondary: string;
|
|
|
228
228
|
title: string;
|
|
229
229
|
```
|
|
230
230
|
|
|
231
|
-
Defined in: [services/HostService.ts:
|
|
231
|
+
Defined in: [services/HostService.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L24)
|
|
232
232
|
|
|
233
233
|
The title of the page.
|
|
@@ -18,7 +18,7 @@ Configuration for the ResourceManager.
|
|
|
18
18
|
optional cache?: ILayeredCache<string, IResourceResult>;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [resources/ResourceManager.ts:
|
|
21
|
+
Defined in: [resources/ResourceManager.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L26)
|
|
22
22
|
|
|
23
23
|
Optional cache for loaded resources.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Optional cache for loaded resources.
|
|
|
30
30
|
optional cacheTtl?: number;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [resources/ResourceManager.ts:
|
|
33
|
+
Defined in: [resources/ResourceManager.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L32)
|
|
34
34
|
|
|
35
35
|
Cache TTL in seconds.
|
|
36
36
|
|
|
@@ -48,7 +48,7 @@ Cache TTL in seconds.
|
|
|
48
48
|
optional debug?: boolean;
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
Defined in: [resources/ResourceManager.ts:
|
|
51
|
+
Defined in: [resources/ResourceManager.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L38)
|
|
52
52
|
|
|
53
53
|
Enable debug logging.
|
|
54
54
|
|
|
@@ -66,7 +66,7 @@ false;
|
|
|
66
66
|
strategies: IResourceStrategy[];
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [resources/ResourceManager.ts:
|
|
69
|
+
Defined in: [resources/ResourceManager.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L21)
|
|
70
70
|
|
|
71
71
|
Resource loading strategies in priority order.
|
|
72
72
|
First strategy that finds the resource wins.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: APP\_NAME'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: APP_NAME
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const APP_NAME: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L22)
|
|
14
|
+
|
|
15
|
+
Human-readable name of the application.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: GIT\_COMMIT'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: GIT_COMMIT
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const GIT_COMMIT: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L28)
|
|
14
|
+
|
|
15
|
+
Git commit SHA of the current build.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const INTELLIGENCE_MAX_OUTPUT_TOKENS: IConfigKey<number>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [env.ts:
|
|
13
|
+
Defined in: [env.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L44)
|
|
14
14
|
|
|
15
15
|
Maximum number of output tokens for the AI model.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const INTELLIGENCE_MODEL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [env.ts:
|
|
13
|
+
Defined in: [env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L35)
|
|
14
14
|
|
|
15
15
|
AI model identifier to use for text generation.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const INTELLIGENCE_TEMPERATURE: IConfigKey<number>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [env.ts:
|
|
13
|
+
Defined in: [env.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L38)
|
|
14
14
|
|
|
15
15
|
Sampling temperature for the AI model.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const INTELLIGENCE_TOP_P: IConfigKey<number>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [env.ts:
|
|
13
|
+
Defined in: [env.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L41)
|
|
14
14
|
|
|
15
15
|
Top-p (nucleus sampling) for the AI model.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const NODE_ENV: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [env.ts:
|
|
13
|
+
Defined in: [env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L25)
|
|
14
14
|
|
|
15
15
|
The current Node.js environment (`development`, `production`, etc.).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const PLATFORM_CORE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [env.ts:
|
|
13
|
+
Defined in: [env.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L51)
|
|
14
14
|
|
|
15
15
|
All configuration entries required by `platform-core`.
|
|
@@ -112,9 +112,11 @@ editUrl: false
|
|
|
112
112
|
|
|
113
113
|
| Variable | Description |
|
|
114
114
|
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
115
|
+
| [APP_NAME](Variable.APP_NAME) | Human-readable name of the application. |
|
|
115
116
|
| [APP_PORT](Variable.APP_PORT) | HTTP port the application listens on. |
|
|
116
117
|
| [APP_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
|
|
117
118
|
| [APP_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
|
|
119
|
+
| [GIT_COMMIT](Variable.GIT_COMMIT) | Git commit SHA of the current build. |
|
|
118
120
|
| [HEALTH_INDICATORS_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
|
|
119
121
|
| [ID_GENERATOR_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
|
|
120
122
|
| [INTELLIGENCE_MAX_OUTPUT_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
|
|
@@ -31,7 +31,7 @@ new BcryptService(): BcryptService;
|
|
|
31
31
|
compare(data, encrypted): Promise<boolean>;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [BcryptService.ts:
|
|
34
|
+
Defined in: [BcryptService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L38)
|
|
35
35
|
|
|
36
36
|
Compares the given data with the encrypted data.
|
|
37
37
|
|
|
@@ -56,7 +56,7 @@ Compares the given data with the encrypted data.
|
|
|
56
56
|
hash(data): Promise<string>;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [BcryptService.ts:
|
|
59
|
+
Defined in: [BcryptService.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/BcryptService.ts#L25)
|
|
60
60
|
|
|
61
61
|
Hashes the given data using bcrypt with a generated salt.
|
|
62
62
|
|
|
@@ -19,7 +19,7 @@ Represents the service that provides cryptographic operations.
|
|
|
19
19
|
new CryptoService(): CryptoService;
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: [CryptoService.ts:
|
|
22
|
+
Defined in: [CryptoService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L21)
|
|
23
23
|
|
|
24
24
|
Initializes a new instance of the `CryptoService` class.
|
|
25
25
|
|
|
@@ -35,7 +35,7 @@ Initializes a new instance of the `CryptoService` class.
|
|
|
35
35
|
getRandomGuid(prefix): string;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [CryptoService.ts:
|
|
38
|
+
Defined in: [CryptoService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/CryptoService.ts#L36)
|
|
39
39
|
|
|
40
40
|
Generates a random GUID prefixed with the given string.
|
|
41
41
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: OtpService
|
|
8
8
|
|
|
9
|
-
Defined in: [OtpService.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L42)
|
|
9
|
+
Defined in: [otp/OtpService.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L42)
|
|
10
10
|
|
|
11
11
|
OTP service implementation backed by otplib v13.
|
|
12
12
|
|
|
@@ -38,7 +38,7 @@ new OtpService(): OtpService;
|
|
|
38
38
|
generateSecret(): string;
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
Defined in: [OtpService.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L46)
|
|
41
|
+
Defined in: [otp/OtpService.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L46)
|
|
42
42
|
|
|
43
43
|
Generates a cryptographically random secret suitable for TOTP.
|
|
44
44
|
|
|
@@ -60,7 +60,7 @@ The generated secret string.
|
|
|
60
60
|
generateUri(options): string;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [OtpService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L51)
|
|
63
|
+
Defined in: [otp/OtpService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L51)
|
|
64
64
|
|
|
65
65
|
Generates an `otpauth://` URI for QR code enrollment.
|
|
66
66
|
|
|
@@ -88,7 +88,7 @@ The formatted `otpauth://` URI.
|
|
|
88
88
|
verify(token, secret): boolean;
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
-
Defined in: [OtpService.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L56)
|
|
91
|
+
Defined in: [otp/OtpService.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L56)
|
|
92
92
|
|
|
93
93
|
Verifies a TOTP token against the given secret.
|
|
94
94
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IOtpService
|
|
8
8
|
|
|
9
|
-
Defined in: [IOtpService.ts:
|
|
9
|
+
Defined in: [otp/IOtpService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L38)
|
|
10
10
|
|
|
11
11
|
Abstraction over OTP (One-Time Password) operations.
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ without changing consumer code.
|
|
|
22
22
|
generateSecret(): string;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [IOtpService.ts:
|
|
25
|
+
Defined in: [otp/IOtpService.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L45)
|
|
26
26
|
|
|
27
27
|
Generates a cryptographically random secret suitable for TOTP.
|
|
28
28
|
|
|
@@ -40,7 +40,7 @@ The generated secret string.
|
|
|
40
40
|
generateUri(options): string;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [IOtpService.ts:
|
|
43
|
+
Defined in: [otp/IOtpService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L54)
|
|
44
44
|
|
|
45
45
|
Generates an `otpauth://` URI for QR code enrollment.
|
|
46
46
|
|
|
@@ -64,7 +64,7 @@ The formatted `otpauth://` URI.
|
|
|
64
64
|
verify(token, secret): boolean;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [IOtpService.ts:
|
|
67
|
+
Defined in: [otp/IOtpService.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L64)
|
|
68
68
|
|
|
69
69
|
Verifies a TOTP token against the given secret.
|
|
70
70
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IOtpUriOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [IOtpService.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/IOtpService.ts#L6)
|
|
9
|
+
Defined in: [otp/IOtpService.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L6)
|
|
10
10
|
|
|
11
11
|
Options for generating an OTP authentication URI (otpauth://).
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Options for generating an OTP authentication URI (otpauth://).
|
|
|
18
18
|
readonly issuer: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [IOtpService.ts:
|
|
21
|
+
Defined in: [otp/IOtpService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L12)
|
|
22
22
|
|
|
23
23
|
The issuer name displayed in the authenticator app.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ The issuer name displayed in the authenticator app.
|
|
|
30
30
|
readonly label: string;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [IOtpService.ts:
|
|
33
|
+
Defined in: [otp/IOtpService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L19)
|
|
34
34
|
|
|
35
35
|
The account label (e.g. email or username) shown in the authenticator app.
|
|
36
36
|
|
|
@@ -42,6 +42,6 @@ The account label (e.g. email or username) shown in the authenticator app.
|
|
|
42
42
|
readonly secret: string;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [IOtpService.ts:
|
|
45
|
+
Defined in: [otp/IOtpService.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/IOtpService.ts#L26)
|
|
46
46
|
|
|
47
47
|
The shared secret used for TOTP generation.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const OTP_SERVICE_TOKEN: typeof OTP_SERVICE_TOKEN;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [OtpService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L14)
|
|
13
|
+
Defined in: [otp/OtpService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L14)
|
|
14
14
|
|
|
15
15
|
Injection token for [IOtpService](Interface.IOtpService).
|