@breadstone/archipel-mcp 0.0.1 → 0.0.3
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 +9 -6
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +142 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +48 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +162 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +59 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +48 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +59 -0
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +15 -0
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +15 -0
- package/data/packages/platform-analytics/api/index.md +45 -0
- package/data/packages/platform-analytics/index.md +170 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +81 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -7
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -4
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -4
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +73 -0
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +79 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +25 -4
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -4
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.MfaService.md +0 -4
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +79 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionService.md +0 -4
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +6 -10
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -4
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Function.Token.md +19 -0
- package/data/packages/platform-authentication/api/Function.UseRoles.md +25 -0
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +23 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +37 -12
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -4
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.User.md +25 -0
- package/data/packages/platform-authentication/api/index.md +48 -450
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -6
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -4
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +29 -0
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +69 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +39 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +29 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +4 -8
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -10
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +14 -18
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +7 -11
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +10 -14
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +3 -7
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -7
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -4
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -7
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -5
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -5
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -6
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +27 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +27 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/index.md +14 -65
- package/data/packages/platform-blob-storage/index.md +77 -22
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +2 -2
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +16 -0
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +2 -2
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +1 -3
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +1 -3
- package/data/packages/platform-core/api/Class.IdentifierModule.md +2 -2
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +55 -1
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +10 -0
- package/data/packages/platform-core/api/Class.ResponseReturn.md +21 -21
- package/data/packages/platform-core/api/Function.Public.md +19 -0
- package/data/packages/platform-core/api/Function.createConfigKey.md +60 -0
- package/data/packages/platform-core/api/Function.createEventKey.md +34 -0
- package/data/packages/platform-core/api/Function.createMappingKey.md +40 -0
- package/data/packages/platform-core/api/Function.env.md +29 -0
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +27 -0
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +28 -0
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -22
- package/data/packages/platform-core/api/Variable.APP_PORT.md +15 -0
- package/data/packages/platform-core/api/Variable.APP_URL.md +15 -0
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +15 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +15 -0
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +13 -0
- package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +27 -0
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +29 -0
- package/data/packages/platform-core/api/Variable.IpAddress.md +32 -0
- package/data/packages/platform-core/api/Variable.Lang.md +30 -0
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +15 -0
- package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +24 -0
- package/data/packages/platform-core/api/Variable.UserAgent.md +25 -0
- package/data/packages/platform-core/api/index.md +29 -488
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -4
- package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -4
- package/data/packages/platform-database/api/Class.DatabaseService.md +0 -4
- package/data/packages/platform-database/api/Class.PrismaService.md +0 -4
- package/data/packages/platform-database/api/Class.RepositoryBase.md +65 -4
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -4
- package/data/packages/platform-database/api/Function.pageable.md +32 -0
- package/data/packages/platform-database/api/Function.paginator.md +23 -0
- package/data/packages/platform-database/api/Function.query.md +35 -0
- package/data/packages/platform-database/api/Function.skip.md +34 -0
- package/data/packages/platform-database/api/Function.transactionalQuery.md +32 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -4
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -4
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -4
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -4
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -4
- package/data/packages/platform-database/api/index.md +7 -142
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +180 -4
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -4
- package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -4
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -4
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -4
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -4
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +15 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/index.md +6 -49
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +185 -0
- package/data/packages/platform-esigning/api/Class.EsigningError.md +66 -0
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +49 -0
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +91 -0
- package/data/packages/platform-esigning/api/Class.EsigningService.md +199 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +250 -0
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +102 -0
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +79 -0
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +61 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +95 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +59 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +59 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +47 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +61 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigner.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +143 -0
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +143 -0
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +71 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +13 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +31 -0
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +33 -0
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +39 -0
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +37 -0
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +39 -0
- package/data/packages/platform-esigning/api/index.md +85 -0
- package/data/packages/platform-esigning/index.md +691 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -4
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +15 -0
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-logging/api/index.md +7 -29
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +19 -7
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailService.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +16 -4
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -4
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -4
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -4
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +13 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +17 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +15 -0
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +15 -0
- package/data/packages/platform-mailing/api/index.md +32 -361
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +29 -0
- package/data/packages/platform-mcp/api/Function.McpResource.md +29 -0
- package/data/packages/platform-mcp/api/Function.McpTool.md +29 -0
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +15 -0
- package/data/packages/platform-mcp/api/index.md +8 -84
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -4
- package/data/packages/platform-openapi/api/Function.Api.md +36 -0
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +43 -0
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +19 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +26 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -4
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -4
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +15 -0
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +13 -0
- package/data/packages/platform-openapi/api/index.md +14 -180
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -4
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -4
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -4
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -4
- package/data/packages/platform-payments/api/Class.MollieClient.md +0 -4
- package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -4
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -4
- package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -4
- package/data/packages/platform-payments/api/Class.StripeClient.md +0 -4
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +26 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -4
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -4
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +13 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/index.md +20 -199
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +31 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +29 -0
- package/data/packages/platform-reporting/api/index.md +4 -51
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +13 -0
- package/data/packages/platform-telemetry/api/index.md +7 -51
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +0 -151
- package/data/packages/platform-logging/api/Class.AnalyticsService.md +0 -113
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GITHUB\_CALLBACK\_URL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GITHUB_CALLBACK_URL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GITHUB_CALLBACK_URL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L122)
|
|
14
|
+
|
|
15
|
+
GitHub OAuth callback URL.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GITHUB\_CLIENT\_ID'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GITHUB_CLIENT_ID
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GITHUB_CLIENT_ID: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L116)
|
|
14
|
+
|
|
15
|
+
GitHub OAuth client ID.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GITHUB\_CLIENT\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GITHUB_CLIENT_SECRET
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GITHUB_CLIENT_SECRET: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L119)
|
|
14
|
+
|
|
15
|
+
GitHub OAuth client secret.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GOOGLE\_CALLBACK\_URL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GOOGLE_CALLBACK_URL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GOOGLE_CALLBACK_URL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L74)
|
|
14
|
+
|
|
15
|
+
Google OAuth2 callback URL.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GOOGLE\_CLIENT\_ID'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GOOGLE_CLIENT_ID
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GOOGLE_CLIENT_ID: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L68)
|
|
14
|
+
|
|
15
|
+
Google OAuth2 client ID.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GOOGLE\_CLIENT\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GOOGLE_CLIENT_SECRET
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GOOGLE_CLIENT_SECRET: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L71)
|
|
14
|
+
|
|
15
|
+
Google OAuth2 client secret.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_JWT\_EXPIRES\_IN'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_JWT_EXPIRES_IN
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_JWT_EXPIRES_IN: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L15)
|
|
14
|
+
|
|
15
|
+
Lifetime of access tokens (e.g. `'15m'`, `'1h'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_JWT\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_JWT_SECRET
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_JWT_SECRET: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L12)
|
|
14
|
+
|
|
15
|
+
Secret used to sign JWTs.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_CHALLENGE\_EXPIRES\_IN'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_CHALLENGE_EXPIRES_IN
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_CHALLENGE_EXPIRES_IN: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L28)
|
|
14
|
+
|
|
15
|
+
How long an MFA challenge stays valid (e.g. `'5m'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_EMAIL\_CODE\_TTL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_EMAIL_CODE_TTL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_EMAIL_CODE_TTL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L48)
|
|
14
|
+
|
|
15
|
+
Time-to-live for email OTP codes (e.g. `'10m'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_EMAIL\_MIN\_RESEND'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_EMAIL_MIN_RESEND
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_EMAIL_MIN_RESEND: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L51)
|
|
14
|
+
|
|
15
|
+
Minimum interval between email OTP resend requests (e.g. `'30s'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_ENCRYPTION\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_ENCRYPTION_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_ENCRYPTION_KEY: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L25)
|
|
14
|
+
|
|
15
|
+
AES encryption key used to encrypt MFA secrets at rest.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_MAX\_ATTEMPTS'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_MAX_ATTEMPTS
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_MAX_ATTEMPTS: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L31)
|
|
14
|
+
|
|
15
|
+
Maximum number of failed MFA attempts before lockout.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_PUSH\_CODE\_TTL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_PUSH_CODE_TTL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_PUSH_CODE_TTL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L58)
|
|
14
|
+
|
|
15
|
+
Time-to-live for push OTP codes (e.g. `'10m'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_PUSH\_MIN\_RESEND'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_PUSH_MIN_RESEND
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_PUSH_MIN_RESEND: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L61)
|
|
14
|
+
|
|
15
|
+
Minimum interval between push OTP resend requests (e.g. `'30s'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_SMS\_CODE\_TTL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_SMS_CODE_TTL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_SMS_CODE_TTL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L38)
|
|
14
|
+
|
|
15
|
+
Time-to-live for SMS OTP codes (e.g. `'10m'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_SMS\_MIN\_RESEND'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_SMS_MIN_RESEND
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_SMS_MIN_RESEND: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L41)
|
|
14
|
+
|
|
15
|
+
Minimum interval between SMS resend requests (e.g. `'30s'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MICROSOFT\_CALLBACK\_URL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MICROSOFT_CALLBACK_URL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MICROSOFT_CALLBACK_URL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L87)
|
|
14
|
+
|
|
15
|
+
Microsoft OAuth2 callback URL.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MICROSOFT\_CLIENT\_ID'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MICROSOFT_CLIENT_ID
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MICROSOFT_CLIENT_ID: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L81)
|
|
14
|
+
|
|
15
|
+
Microsoft OAuth2 client ID.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MICROSOFT\_CLIENT\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MICROSOFT_CLIENT_SECRET
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MICROSOFT_CLIENT_SECRET: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L84)
|
|
14
|
+
|
|
15
|
+
Microsoft OAuth2 client secret.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MICROSOFT\_TENANT'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MICROSOFT_TENANT
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MICROSOFT_TENANT: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L90)
|
|
14
|
+
|
|
15
|
+
Microsoft tenant ID or `'common'` for multi-tenant.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_VERIFY\_JWT\_EXPIRES\_IN'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_VERIFY_JWT_EXPIRES_IN
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_VERIFY_JWT_EXPIRES_IN: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L18)
|
|
14
|
+
|
|
15
|
+
Lifetime of email-verification JWTs.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: GITHUB\_AUTH\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: GITHUB_AUTH_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const GITHUB_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/github/env.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/github/env.ts#L9)
|
|
14
|
+
|
|
15
|
+
Configuration entries required by GitHub OAuth authentication.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: GOOGLE\_AUTH\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: GOOGLE_AUTH_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const GOOGLE_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/google/env.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/google/env.ts#L9)
|
|
14
|
+
|
|
15
|
+
Configuration entries required by Google OAuth authentication.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MICROSOFT\_AUTH\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MICROSOFT_AUTH_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MICROSOFT_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/microsoft/env.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/microsoft/env.ts#L14)
|
|
14
|
+
|
|
15
|
+
Configuration entries required by Microsoft OAuth authentication.
|
package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: PLATFORM\_AUTHENTICATION\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: PLATFORM_AUTHENTICATION_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const PLATFORM_AUTHENTICATION_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:136](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L136)
|
|
14
|
+
|
|
15
|
+
Core configuration entries required by `platform-authentication`.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: ROLES\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: ROLES_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const ROLES_KEY: 'use_roles' = 'use_roles';
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/decorators/RolesDecorator.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/decorators/RolesDecorator.ts#L12)
|
|
14
|
+
|
|
15
|
+
Represents the key for the `UseRoles` decorator.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: SEED\_ANONYMOUS\_USERNAME'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: SEED_ANONYMOUS_USERNAME
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const SEED_ANONYMOUS_USERNAME: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L129)
|
|
14
|
+
|
|
15
|
+
Username used for the anonymous seed user.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: SESSION\_LIST\_MAPPING\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: SESSION_LIST_MAPPING_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const SESSION_LIST_MAPPING_KEY: IMappingKey<ISessionMappingInput[], SessionResponse[]>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/mappers/SessionMappingProfile.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mappers/SessionMappingProfile.ts#L29)
|
|
14
|
+
|
|
15
|
+
Type-safe mapping key for Session entity list to response list transformation.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: SESSION\_MAPPING\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: SESSION_MAPPING_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const SESSION_MAPPING_KEY: IMappingKey<ISessionMappingInput, SessionResponse>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/mappers/SessionMappingProfile.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mappers/SessionMappingProfile.ts#L20)
|
|
14
|
+
|
|
15
|
+
Type-safe mapping key for Session entity to response transformation.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: User'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: User
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const User: (...dataOrPipes) => ParameterDecorator;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/decorators/UserDecorator.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/decorators/UserDecorator.ts#L13)
|
|
14
|
+
|
|
15
|
+
Represents the `User` decorator.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type |
|
|
20
|
+
| ---------------- | ----------- |
|
|
21
|
+
| ...`dataOrPipes` | `unknown`[] |
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
`ParameterDecorator`
|