@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.
Files changed (407) hide show
  1. package/data/packages/index.md +9 -6
  2. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +142 -0
  3. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +48 -0
  4. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +170 -0
  5. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +170 -0
  6. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +162 -0
  7. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +170 -0
  8. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +59 -0
  9. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +48 -0
  10. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +59 -0
  11. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +15 -0
  12. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +15 -0
  13. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +15 -0
  14. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +15 -0
  15. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +15 -0
  16. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +15 -0
  17. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +15 -0
  18. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +15 -0
  19. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +15 -0
  20. package/data/packages/platform-analytics/api/index.md +45 -0
  21. package/data/packages/platform-analytics/index.md +170 -0
  22. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -4
  23. package/data/packages/platform-authentication/api/Class.AppleStrategy.md +81 -0
  24. package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -7
  25. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -4
  26. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -4
  27. package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -4
  28. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -4
  29. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +73 -0
  30. package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +79 -0
  31. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -4
  32. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +25 -4
  33. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -4
  34. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -4
  35. package/data/packages/platform-authentication/api/Class.MfaService.md +0 -4
  36. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -4
  37. package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +79 -0
  38. package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -4
  39. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -4
  40. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -4
  41. package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -4
  42. package/data/packages/platform-authentication/api/Class.SessionService.md +0 -4
  43. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +6 -10
  44. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -4
  45. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -4
  46. package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -4
  47. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -4
  48. package/data/packages/platform-authentication/api/Function.Token.md +19 -0
  49. package/data/packages/platform-authentication/api/Function.UseRoles.md +25 -0
  50. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +23 -0
  51. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +37 -12
  52. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -4
  53. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -4
  54. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -4
  55. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -4
  56. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -4
  57. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -4
  58. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -4
  59. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -4
  60. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -4
  61. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -4
  62. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -4
  63. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -4
  64. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +15 -0
  65. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +15 -0
  66. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +15 -0
  67. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +15 -0
  68. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +15 -0
  69. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +15 -0
  70. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
  71. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +15 -0
  72. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +15 -0
  73. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +15 -0
  74. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +15 -0
  75. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +15 -0
  76. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +15 -0
  77. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +15 -0
  78. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +15 -0
  79. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +15 -0
  80. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +15 -0
  81. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +15 -0
  82. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +15 -0
  83. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +15 -0
  84. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +15 -0
  85. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +15 -0
  86. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +15 -0
  87. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +15 -0
  88. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +15 -0
  89. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +15 -0
  90. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +15 -0
  91. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +15 -0
  92. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +15 -0
  93. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +15 -0
  94. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +15 -0
  95. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +15 -0
  96. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +15 -0
  97. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +15 -0
  98. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +15 -0
  99. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +15 -0
  100. package/data/packages/platform-authentication/api/Variable.User.md +25 -0
  101. package/data/packages/platform-authentication/api/index.md +48 -450
  102. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +197 -0
  103. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +197 -0
  104. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -4
  105. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -6
  106. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -4
  107. package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -4
  108. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -4
  109. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -4
  110. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +29 -0
  111. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +69 -0
  112. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +39 -0
  113. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +29 -0
  114. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +4 -8
  115. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +5 -9
  116. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -10
  117. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -9
  118. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +14 -18
  119. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +7 -11
  120. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +5 -9
  121. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +10 -14
  122. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +3 -7
  123. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -7
  124. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -4
  125. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -7
  126. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -5
  127. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -5
  128. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -6
  129. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +13 -0
  130. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +13 -0
  131. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +13 -0
  132. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +27 -0
  133. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +27 -0
  134. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +13 -0
  135. package/data/packages/platform-blob-storage/api/index.md +14 -65
  136. package/data/packages/platform-blob-storage/index.md +77 -22
  137. package/data/packages/platform-core/api/Class.CasingInterceptor.md +2 -2
  138. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +16 -0
  139. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +2 -2
  140. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +1 -3
  141. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +1 -3
  142. package/data/packages/platform-core/api/Class.IdentifierModule.md +2 -2
  143. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +55 -1
  144. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +10 -0
  145. package/data/packages/platform-core/api/Class.ResponseReturn.md +21 -21
  146. package/data/packages/platform-core/api/Function.Public.md +19 -0
  147. package/data/packages/platform-core/api/Function.createConfigKey.md +60 -0
  148. package/data/packages/platform-core/api/Function.createEventKey.md +34 -0
  149. package/data/packages/platform-core/api/Function.createMappingKey.md +40 -0
  150. package/data/packages/platform-core/api/Function.env.md +29 -0
  151. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +27 -0
  152. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +28 -0
  153. package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -22
  154. package/data/packages/platform-core/api/Variable.APP_PORT.md +15 -0
  155. package/data/packages/platform-core/api/Variable.APP_URL.md +15 -0
  156. package/data/packages/platform-core/api/Variable.APP_VERSION.md +15 -0
  157. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +15 -0
  158. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +15 -0
  159. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +15 -0
  160. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +15 -0
  161. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +15 -0
  162. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +15 -0
  163. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +13 -0
  164. package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +27 -0
  165. package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +29 -0
  166. package/data/packages/platform-core/api/Variable.IpAddress.md +32 -0
  167. package/data/packages/platform-core/api/Variable.Lang.md +30 -0
  168. package/data/packages/platform-core/api/Variable.NODE_ENV.md +15 -0
  169. package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +15 -0
  170. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +15 -0
  171. package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +24 -0
  172. package/data/packages/platform-core/api/Variable.UserAgent.md +25 -0
  173. package/data/packages/platform-core/api/index.md +29 -488
  174. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -4
  175. package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -4
  176. package/data/packages/platform-database/api/Class.DatabaseService.md +0 -4
  177. package/data/packages/platform-database/api/Class.PrismaService.md +0 -4
  178. package/data/packages/platform-database/api/Class.RepositoryBase.md +65 -4
  179. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -4
  180. package/data/packages/platform-database/api/Function.pageable.md +32 -0
  181. package/data/packages/platform-database/api/Function.paginator.md +23 -0
  182. package/data/packages/platform-database/api/Function.query.md +35 -0
  183. package/data/packages/platform-database/api/Function.skip.md +34 -0
  184. package/data/packages/platform-database/api/Function.transactionalQuery.md +32 -0
  185. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -4
  186. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -4
  187. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -4
  188. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -4
  189. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -4
  190. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -4
  191. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -4
  192. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -4
  193. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -4
  194. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -4
  195. package/data/packages/platform-database/api/index.md +7 -142
  196. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +180 -4
  197. package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -4
  198. package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -4
  199. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -4
  200. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -4
  201. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -4
  202. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -4
  203. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -4
  204. package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -4
  205. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -4
  206. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -4
  207. package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -4
  208. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -4
  209. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -4
  210. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -4
  211. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -4
  212. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -4
  213. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +15 -0
  214. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +15 -0
  215. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +15 -0
  216. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +15 -0
  217. package/data/packages/platform-documents/api/index.md +6 -49
  218. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +185 -0
  219. package/data/packages/platform-esigning/api/Class.EsigningError.md +66 -0
  220. package/data/packages/platform-esigning/api/Class.EsigningModule.md +49 -0
  221. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +91 -0
  222. package/data/packages/platform-esigning/api/Class.EsigningService.md +199 -0
  223. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +250 -0
  224. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +102 -0
  225. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +79 -0
  226. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +61 -0
  227. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +95 -0
  228. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +59 -0
  229. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +59 -0
  230. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +47 -0
  231. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +61 -0
  232. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +83 -0
  233. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +83 -0
  234. package/data/packages/platform-esigning/api/Interface.ISigner.md +83 -0
  235. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +83 -0
  236. package/data/packages/platform-esigning/api/Interface.ISigningField.md +143 -0
  237. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +143 -0
  238. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +71 -0
  239. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +15 -0
  240. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +15 -0
  241. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +15 -0
  242. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +15 -0
  243. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +15 -0
  244. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +15 -0
  245. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +15 -0
  246. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +15 -0
  247. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +15 -0
  248. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +15 -0
  249. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +15 -0
  250. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +15 -0
  251. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +15 -0
  252. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +15 -0
  253. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +15 -0
  254. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +15 -0
  255. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +15 -0
  256. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +15 -0
  257. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +15 -0
  258. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +15 -0
  259. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +15 -0
  260. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +15 -0
  261. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +13 -0
  262. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +13 -0
  263. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +15 -0
  264. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +15 -0
  265. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +15 -0
  266. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +15 -0
  267. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +15 -0
  268. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +15 -0
  269. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +15 -0
  270. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +15 -0
  271. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +31 -0
  272. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +33 -0
  273. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +39 -0
  274. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +37 -0
  275. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +39 -0
  276. package/data/packages/platform-esigning/api/index.md +85 -0
  277. package/data/packages/platform-esigning/index.md +691 -0
  278. package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -4
  279. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +15 -0
  280. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +15 -0
  281. package/data/packages/platform-logging/api/index.md +7 -29
  282. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +1 -7
  283. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +19 -7
  284. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +1 -7
  285. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +1 -7
  286. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -4
  287. package/data/packages/platform-mailing/api/Class.MailModule.md +0 -4
  288. package/data/packages/platform-mailing/api/Class.MailService.md +0 -4
  289. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -4
  290. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -4
  291. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +1 -7
  292. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +1 -7
  293. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +1 -7
  294. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +1 -7
  295. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +1 -7
  296. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +16 -4
  297. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -4
  298. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -4
  299. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -4
  300. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +15 -0
  301. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +15 -0
  302. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +15 -0
  303. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +15 -0
  304. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +13 -0
  305. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +15 -0
  306. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +15 -0
  307. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +15 -0
  308. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +15 -0
  309. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +15 -0
  310. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +15 -0
  311. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +15 -0
  312. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +15 -0
  313. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +15 -0
  314. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +15 -0
  315. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +15 -0
  316. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +15 -0
  317. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +15 -0
  318. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +15 -0
  319. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +17 -0
  320. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +15 -0
  321. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +15 -0
  322. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +15 -0
  323. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +15 -0
  324. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +15 -0
  325. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +15 -0
  326. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +15 -0
  327. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +15 -0
  328. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +15 -0
  329. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +15 -0
  330. package/data/packages/platform-mailing/api/index.md +32 -361
  331. package/data/packages/platform-mcp/api/Function.McpPrompt.md +29 -0
  332. package/data/packages/platform-mcp/api/Function.McpResource.md +29 -0
  333. package/data/packages/platform-mcp/api/Function.McpTool.md +29 -0
  334. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +15 -0
  335. package/data/packages/platform-mcp/api/index.md +8 -84
  336. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -4
  337. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -4
  338. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -4
  339. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -4
  340. package/data/packages/platform-openapi/api/Function.Api.md +36 -0
  341. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +43 -0
  342. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +19 -0
  343. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +26 -0
  344. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -4
  345. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -4
  346. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +15 -0
  347. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +15 -0
  348. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +15 -0
  349. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +15 -0
  350. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +15 -0
  351. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +13 -0
  352. package/data/packages/platform-openapi/api/index.md +14 -180
  353. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -4
  354. package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -4
  355. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -4
  356. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -4
  357. package/data/packages/platform-payments/api/Class.MollieClient.md +0 -4
  358. package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -4
  359. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -4
  360. package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -4
  361. package/data/packages/platform-payments/api/Class.StripeClient.md +0 -4
  362. package/data/packages/platform-payments/api/Function.RequiresFeature.md +26 -0
  363. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -4
  364. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -4
  365. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -4
  366. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -4
  367. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -4
  368. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -4
  369. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -4
  370. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +13 -0
  371. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +15 -0
  372. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +15 -0
  373. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +15 -0
  374. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +15 -0
  375. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +15 -0
  376. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +15 -0
  377. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +15 -0
  378. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +15 -0
  379. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +15 -0
  380. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +15 -0
  381. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +15 -0
  382. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +15 -0
  383. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +15 -0
  384. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +15 -0
  385. package/data/packages/platform-payments/api/index.md +20 -199
  386. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +31 -0
  387. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +29 -0
  388. package/data/packages/platform-reporting/api/index.md +4 -51
  389. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -4
  390. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -4
  391. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -4
  392. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -4
  393. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -4
  394. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -4
  395. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -4
  396. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -4
  397. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -4
  398. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -4
  399. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +13 -0
  400. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +13 -0
  401. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +13 -0
  402. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +13 -0
  403. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +13 -0
  404. package/data/packages/platform-telemetry/api/index.md +7 -51
  405. package/package.json +1 -1
  406. package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +0 -151
  407. package/data/packages/platform-logging/api/Class.AnalyticsService.md +0 -113
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_PROVIDER\_OPTIONS'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: AWS_S3_PROVIDER_OPTIONS
8
+
9
+ ```ts
10
+ const AWS_S3_PROVIDER_OPTIONS: typeof AWS_S3_PROVIDER_OPTIONS;
11
+ ```
12
+
13
+ Defined in: [tokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L6)
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: 'Variable: AZURE\_BLOB\_PROVIDER\_OPTIONS'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: AZURE_BLOB_PROVIDER_OPTIONS
8
+
9
+ ```ts
10
+ const AZURE_BLOB_PROVIDER_OPTIONS: typeof AZURE_BLOB_PROVIDER_OPTIONS;
11
+ ```
12
+
13
+ Defined in: [tokens.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L5)
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: 'Variable: BLOB\_PROVIDER'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: BLOB_PROVIDER
8
+
9
+ ```ts
10
+ const BLOB_PROVIDER: typeof BLOB_PROVIDER;
11
+ ```
12
+
13
+ Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L3)
@@ -0,0 +1,27 @@
1
+ ---
2
+ title: 'Variable: BlobDownloadResponseTypes'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: BlobDownloadResponseTypes
8
+
9
+ ```ts
10
+ const BlobDownloadResponseTypes: {
11
+ ArrayBuffer: 'arraybuffer';
12
+ Json: 'json';
13
+ Stream: 'stream';
14
+ Text: 'text';
15
+ };
16
+ ```
17
+
18
+ Defined in: [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18)
19
+
20
+ ## Type Declaration
21
+
22
+ | Name | Type | Default value | Defined in |
23
+ | ----------------------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
24
+ | <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L19) |
25
+ | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [interfaces/IBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L20) |
26
+ | <a id="property-stream"></a> `Stream` | `"stream"` | `'stream'` | [interfaces/IBlobProvider.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L21) |
27
+ | <a id="property-text"></a> `Text` | `"text"` | `'text'` | [interfaces/IBlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L22) |
@@ -0,0 +1,27 @@
1
+ ---
2
+ title: 'Variable: BlobProviderKinds'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: BlobProviderKinds
8
+
9
+ ```ts
10
+ const BlobProviderKinds: {
11
+ AwsS3: 'aws-s3';
12
+ Azure: 'azure';
13
+ Custom: 'custom';
14
+ Vercel: 'vercel';
15
+ };
16
+ ```
17
+
18
+ Defined in: [interfaces/IBlobProvider.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L9)
19
+
20
+ ## Type Declaration
21
+
22
+ | Name | Type | Default value | Defined in |
23
+ | ------------------------------------- | ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
24
+ | <a id="property-awss3"></a> `AwsS3` | `"aws-s3"` | `'aws-s3'` | [interfaces/IBlobProvider.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L13) |
25
+ | <a id="property-azure"></a> `Azure` | `"azure"` | `'azure'` | [interfaces/IBlobProvider.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L12) |
26
+ | <a id="property-custom"></a> `Custom` | `"custom"` | `'custom'` | [interfaces/IBlobProvider.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L10) |
27
+ | <a id="property-vercel"></a> `Vercel` | `"vercel"` | `'vercel'` | [interfaces/IBlobProvider.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L11) |
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_BLOB\_PROVIDER\_OPTIONS'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: VERCEL_BLOB_PROVIDER_OPTIONS
8
+
9
+ ```ts
10
+ const VERCEL_BLOB_PROVIDER_OPTIONS: typeof VERCEL_BLOB_PROVIDER_OPTIONS;
11
+ ```
12
+
13
+ Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L4)
@@ -4,16 +4,14 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-blob-storage**](../)
8
-
9
- ---
10
-
11
7
  # @breadstone/archipel-platform-blob-storage
12
8
 
13
9
  ## Classes
14
10
 
15
11
  | Class | Description |
16
12
  | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | [AwsS3BlobProvider](Class.AwsS3BlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Amazon S3. |
14
+ | [AzureBlobProvider](Class.AzureBlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Microsoft Azure Blob Storage. |
17
15
  | [BlobHealthIndicator](Class.BlobHealthIndicator) | Health indicator for blob service. |
18
16
  | [BlobModule](Class.BlobModule) | NestJS module responsible for providing blob storage services. |
19
17
  | [BlobObjectPersistencePort](Class.BlobObjectPersistencePort) | Abstract port for persisting blob object metadata. Consuming projects must provide a concrete implementation (e.g. backed by Prisma, Mongo, etc.) and register it via `BlobModule.forRoot({ objectPersistence: MyAdapter })`. |
@@ -25,6 +23,10 @@ editUrl: false
25
23
 
26
24
  | Interface | Description |
27
25
  | ---------------------------------------------------------------------------- | ----------- |
26
+ | [IAwsS3BlobProviderRegistration](Interface.IAwsS3BlobProviderRegistration) | - |
27
+ | [IAwsS3ProviderOptions](Interface.IAwsS3ProviderOptions) | - |
28
+ | [IAzureBlobProviderOptions](Interface.IAzureBlobProviderOptions) | - |
29
+ | [IAzureBlobProviderRegistration](Interface.IAzureBlobProviderRegistration) | - |
28
30
  | [IBlobDeleteRequest](Interface.IBlobDeleteRequest) | - |
29
31
  | [IBlobDownloadRequest](Interface.IBlobDownloadRequest) | - |
30
32
  | [IBlobDownloadResult](Interface.IBlobDownloadResult) | - |
@@ -48,64 +50,11 @@ editUrl: false
48
50
 
49
51
  ## Variables
50
52
 
51
- ### BLOB_PROVIDER
52
-
53
- ```ts
54
- const BLOB_PROVIDER: typeof BLOB_PROVIDER;
55
- ```
56
-
57
- Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L3)
58
-
59
- ---
60
-
61
- ### BlobDownloadResponseTypes
62
-
63
- ```ts
64
- const BlobDownloadResponseTypes: {
65
- ArrayBuffer: 'arraybuffer';
66
- Json: 'json';
67
- Stream: 'stream';
68
- Text: 'text';
69
- };
70
- ```
71
-
72
- Defined in: [interfaces/IBlobProvider.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L16)
73
-
74
- #### Type Declaration
75
-
76
- | Name | Type | Default value | Defined in |
77
- | ----------------------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
78
- | <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L17) |
79
- | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18) |
80
- | <a id="property-stream"></a> `Stream` | `"stream"` | `'stream'` | [interfaces/IBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L19) |
81
- | <a id="property-text"></a> `Text` | `"text"` | `'text'` | [interfaces/IBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L20) |
82
-
83
- ---
84
-
85
- ### BlobProviderKinds
86
-
87
- ```ts
88
- const BlobProviderKinds: {
89
- Custom: 'custom';
90
- Vercel: 'vercel';
91
- };
92
- ```
93
-
94
- Defined in: [interfaces/IBlobProvider.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L9)
95
-
96
- #### Type Declaration
97
-
98
- | Name | Type | Default value | Defined in |
99
- | ------------------------------------- | ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
100
- | <a id="property-custom"></a> `Custom` | `"custom"` | `'custom'` | [interfaces/IBlobProvider.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L10) |
101
- | <a id="property-vercel"></a> `Vercel` | `"vercel"` | `'vercel'` | [interfaces/IBlobProvider.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L11) |
102
-
103
- ---
104
-
105
- ### VERCEL_BLOB_PROVIDER_OPTIONS
106
-
107
- ```ts
108
- const VERCEL_BLOB_PROVIDER_OPTIONS: typeof VERCEL_BLOB_PROVIDER_OPTIONS;
109
- ```
110
-
111
- Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L4)
53
+ | Variable | Description |
54
+ | --------------------------------------------------------------------- | ----------- |
55
+ | [AWS_S3_PROVIDER_OPTIONS](Variable.AWS_S3_PROVIDER_OPTIONS) | - |
56
+ | [AZURE_BLOB_PROVIDER_OPTIONS](Variable.AZURE_BLOB_PROVIDER_OPTIONS) | - |
57
+ | [BLOB_PROVIDER](Variable.BLOB_PROVIDER) | - |
58
+ | [BlobDownloadResponseTypes](Variable.BlobDownloadResponseTypes) | - |
59
+ | [BlobProviderKinds](Variable.BlobProviderKinds) | - |
60
+ | [VERCEL_BLOB_PROVIDER_OPTIONS](Variable.VERCEL_BLOB_PROVIDER_OPTIONS) | - |
@@ -2,13 +2,13 @@
2
2
  title: platform-blob-storage
3
3
  description: Cloud file storage abstraction with pluggable providers and optional metadata persistence.
4
4
  order: 3
5
- tags: [blob-storage, files, upload, download, vercel, providers, ports-and-adapters]
5
+ tags: [blob-storage, files, upload, download, vercel, azure, aws, s3, providers, ports-and-adapters]
6
6
  package: '@breadstone/archipel-platform-blob-storage'
7
7
  ---
8
8
 
9
9
  # platform-blob-storage
10
10
 
11
- Cloud file storage abstraction supporting pluggable providers and optional metadata persistence via ports. Ships with a Vercel Blob provider out of the box.
11
+ Cloud file storage abstraction supporting pluggable providers and optional metadata persistence via ports. Ships with Vercel Blob, Azure Blob Storage, and AWS S3 providers out of the box.
12
12
 
13
13
  **Package:** `@breadstone/archipel-platform-blob-storage`
14
14
 
@@ -54,8 +54,14 @@ export class AppModule {}
54
54
  // Vercel Blob (default)
55
55
  { kind: 'vercel', options?: { token?: string } }
56
56
 
57
+ // Azure Blob Storage
58
+ { kind: 'azure', options?: { connectionString?: string; containerName?: string } }
59
+
60
+ // AWS S3
61
+ { kind: 'aws-s3', options?: { region?: string; accessKeyId?: string; secretAccessKey?: string; bucket?: string; endpoint?: string } }
62
+
57
63
  // Custom provider
58
- { kind: 'custom', useClass: MyS3Provider }
64
+ { kind: 'custom', useClass: MyBlobProvider }
59
65
  ```
60
66
 
61
67
  ---
@@ -211,35 +217,69 @@ BlobModule.forRoot({
211
217
  });
212
218
  ```
213
219
 
220
+ **Environment variables:** `BLOB_READ_WRITE_TOKEN`, `BLOB_API_URL`, `BLOB_PUBLIC_URL`
221
+
222
+ ### AzureBlobProvider
223
+
224
+ Microsoft Azure Blob Storage integration using `@azure/storage-blob`.
225
+
226
+ ```typescript
227
+ import { AzureBlobProvider } from '@breadstone/archipel-platform-blob-storage/azure';
228
+
229
+ BlobModule.forRoot({
230
+ provider: { kind: 'azure' },
231
+ });
232
+ ```
233
+
234
+ **Environment variables:** `AZURE_BLOB_CONNECTION_STRING`, `AZURE_BLOB_CONTAINER_NAME`
235
+
236
+ The provider supports SAS token generation for signed URLs and lazy-loads the Azure SDK for tree-shaking.
237
+
238
+ ### AwsS3BlobProvider
239
+
240
+ Amazon S3 integration using `@aws-sdk/client-s3` and `@aws-sdk/s3-request-presigner`.
241
+
242
+ ```typescript
243
+ import { AwsS3BlobProvider } from '@breadstone/archipel-platform-blob-storage/aws-s3';
244
+
245
+ BlobModule.forRoot({
246
+ provider: { kind: 'aws-s3' },
247
+ });
248
+ ```
249
+
250
+ **Environment variables:** `AWS_S3_REGION`, `AWS_S3_ACCESS_KEY_ID`, `AWS_S3_SECRET_ACCESS_KEY`, `AWS_S3_BUCKET`, `AWS_S3_ENDPOINT` (optional, for S3-compatible services like MinIO)
251
+
252
+ The provider supports pre-signed URLs and lazy-loads the AWS SDK for tree-shaking.
253
+
214
254
  ### Custom Provider
215
255
 
216
- Implement `IBlobProvider` for any storage backend (S3, Azure Blob, GCS, MinIO):
256
+ Implement `IBlobProvider` for any other storage backend (GCS, MinIO, etc.):
217
257
 
218
258
  ```typescript
219
259
  @Injectable()
220
- export class S3BlobProvider implements IBlobProvider {
221
- public readonly providerId = 's3';
260
+ export class GcsBlobProvider implements IBlobProvider {
261
+ public readonly providerId = 'gcs';
222
262
 
223
263
  public async uploadObject(request: IBlobUploadRequest): Promise<IBlobUploadResult> {
224
- // S3 PutObject implementation
264
+ // GCS upload implementation
225
265
  }
226
266
 
227
267
  public async downloadObject<TData>(request: IBlobDownloadRequest): Promise<IBlobDownloadResult<TData>> {
228
- // S3 GetObject implementation
268
+ // GCS download implementation
229
269
  }
230
270
 
231
271
  public async deleteObject(request: IBlobDeleteRequest): Promise<void> {
232
- // S3 DeleteObject implementation
272
+ // GCS delete implementation
233
273
  }
234
274
 
235
275
  public async createSignedUrl(request: IBlobSignedUrlRequest): Promise<string> {
236
- // S3 presigned URL
276
+ // GCS signed URL
237
277
  }
238
278
  }
239
279
 
240
280
  // Register
241
281
  BlobModule.forRoot({
242
- provider: { kind: 'custom', useClass: S3BlobProvider },
282
+ provider: { kind: 'custom', useClass: GcsBlobProvider },
243
283
  });
244
284
  ```
245
285
 
@@ -265,16 +305,31 @@ export class HealthController {
265
305
 
266
306
  ---
267
307
 
308
+ ## Sub-path Imports
309
+
310
+ Each provider is tree-shakeable via sub-path imports:
311
+
312
+ | Import Path | Contents |
313
+ | --------------------------------------------------- | ----------------------------------------------------- |
314
+ | `@breadstone/archipel-platform-blob-storage` | Core module, service, ports, health check, interfaces |
315
+ | `@breadstone/archipel-platform-blob-storage/vercel` | VercelBlobProvider, VERCEL_BLOB_PROVIDER_OPTIONS |
316
+ | `@breadstone/archipel-platform-blob-storage/azure` | AzureBlobProvider, AZURE_BLOB_PROVIDER_OPTIONS |
317
+ | `@breadstone/archipel-platform-blob-storage/aws-s3` | AwsS3BlobProvider, AWS_S3_PROVIDER_OPTIONS |
318
+
319
+ ---
320
+
268
321
  ## Exports Summary
269
322
 
270
- | Export | Type | Description |
271
- | ---------------------------- | ------------- | -------------------------------------------------- |
272
- | `BlobModule` | NestJS Module | Main module with `forRoot()` |
273
- | `BlobService` | Service | Upload, download, delete, signed URLs |
274
- | `BlobObjectPersistencePort` | Port | Object metadata tracking |
275
- | `BlobVariantPersistencePort` | Port | Variant metadata tracking |
276
- | `VercelBlobProvider` | Provider | Vercel Blob implementation |
277
- | `BlobHealthIndicator` | Health | Terminus health check |
278
- | `IBlobProvider` | Interface | Custom provider contract |
279
- | `BlobProviderKinds` | Constant | `'vercel'` / `'custom'` |
280
- | `BlobDownloadResponseTypes` | Constant | `'arraybuffer'` / `'json'` / `'stream'` / `'text'` |
323
+ | Export | Type | Description |
324
+ | ---------------------------- | ------------- | ----------------------------------------------------- |
325
+ | `BlobModule` | NestJS Module | Main module with `forRoot()` |
326
+ | `BlobService` | Service | Upload, download, delete, signed URLs |
327
+ | `BlobObjectPersistencePort` | Port | Object metadata tracking |
328
+ | `BlobVariantPersistencePort` | Port | Variant metadata tracking |
329
+ | `VercelBlobProvider` | Provider | Vercel Blob implementation (sub-path) |
330
+ | `AzureBlobProvider` | Provider | Azure Blob Storage implementation (sub-path) |
331
+ | `AwsS3BlobProvider` | Provider | AWS S3 implementation (sub-path) |
332
+ | `BlobHealthIndicator` | Health | Terminus health check |
333
+ | `IBlobProvider` | Interface | Custom provider contract |
334
+ | `BlobProviderKinds` | Constant | `'vercel'` \| `'azure'` \| `'aws-s3'` \| `'custom'` |
335
+ | `BlobDownloadResponseTypes` | Constant | `'arraybuffer'` \| `'json'` \| `'stream'` \| `'text'` |
@@ -36,7 +36,7 @@ new CasingInterceptor(): CasingInterceptor;
36
36
  intercept(context, next): Observable<any>;
37
37
  ```
38
38
 
39
- Defined in: [interceptors/CasingInterceptor.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L20)
39
+ Defined in: [interceptors/CasingInterceptor.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L19)
40
40
 
41
41
  Method to implement a custom interceptor.
42
42
 
@@ -65,7 +65,7 @@ NestInterceptor.intercept;
65
65
  process<T>(value): T;
66
66
  ```
67
67
 
68
- Defined in: [interceptors/CasingInterceptor.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L37)
68
+ Defined in: [interceptors/CasingInterceptor.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L38)
69
69
 
70
70
  #### Type Parameters
71
71
 
@@ -16,6 +16,22 @@ Represents the base class for configuration strategies.
16
16
  - [`EnvironmentConfigStrategy`](Class.EnvironmentConfigStrategy)
17
17
  - [`FileConfigStrategy`](Class.FileConfigStrategy)
18
18
 
19
+ ## Constructors
20
+
21
+ ### Constructor
22
+
23
+ ```ts
24
+ protected new ConfigStrategyBase(): ConfigStrategyBase;
25
+ ```
26
+
27
+ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L15)
28
+
29
+ Initializes a new instance of the `ConfigStrategyBase` class.
30
+
31
+ #### Returns
32
+
33
+ `ConfigStrategyBase`
34
+
19
35
  ## Methods
20
36
 
21
37
  ### has()
@@ -18,7 +18,7 @@ The `ContentTemplateEngine` class.
18
18
  new ContentTemplateEngine(): ContentTemplateEngine;
19
19
  ```
20
20
 
21
- Defined in: [templates/ContentTemplateEngine.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L26)
21
+ Defined in: [templates/ContentTemplateEngine.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L25)
22
22
 
23
23
  Constructs a new instance of the `ContentTemplateEngine` class.
24
24
 
@@ -34,7 +34,7 @@ Constructs a new instance of the `ContentTemplateEngine` class.
34
34
  compileTemplate(content, params): string;
35
35
  ```
36
36
 
37
- Defined in: [templates/ContentTemplateEngine.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L45)
37
+ Defined in: [templates/ContentTemplateEngine.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L44)
38
38
 
39
39
  Compiles a template by replacing placeholders with the provided parameters.
40
40
 
@@ -30,9 +30,7 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:24](https://github.c
30
30
 
31
31
  #### Overrides
32
32
 
33
- ```ts
34
- ConfigStrategyBase.constructor;
35
- ```
33
+ [`ConfigStrategyBase`](Class.ConfigStrategyBase).[`constructor`](Class.ConfigStrategyBase#constructor)
36
34
 
37
35
  ## Methods
38
36
 
@@ -36,9 +36,7 @@ Defined in: [config/strategies/FileConfigStrategy.ts:27](https://github.com/RueD
36
36
 
37
37
  #### Overrides
38
38
 
39
- ```ts
40
- ConfigStrategyBase.constructor;
41
- ```
39
+ [`ConfigStrategyBase`](Class.ConfigStrategyBase).[`constructor`](Class.ConfigStrategyBase#constructor)
42
40
 
43
41
  ## Methods
44
42
 
@@ -6,7 +6,7 @@ editUrl: false
6
6
 
7
7
  # Class: IdentifierModule
8
8
 
9
- Defined in: [identifiers/IdentifierModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierModule.ts#L28)
9
+ Defined in: [identifiers/IdentifierModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierModule.ts#L23)
10
10
 
11
11
  ## Constructors
12
12
 
@@ -28,7 +28,7 @@ new IdentifierModule(): IdentifierModule;
28
28
  static register(type): DynamicModule;
29
29
  ```
30
30
 
31
- Defined in: [identifiers/IdentifierModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierModule.ts#L30)
31
+ Defined in: [identifiers/IdentifierModule.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierModule.ts#L24)
32
32
 
33
33
  #### Parameters
34
34
 
@@ -15,8 +15,62 @@ capabilities to the global intelligence registry while keeping their implementat
15
15
 
16
16
  - `OnModuleInit`
17
17
 
18
+ ## Constructors
19
+
20
+ ### Constructor
21
+
22
+ ```ts
23
+ protected new IntelligenceCapabilityRegistrarBase(registry): IntelligenceCapabilityRegistrarBase;
24
+ ```
25
+
26
+ Defined in: [intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts#L30)
27
+
28
+ Initializes a new instance of the IntelligenceCapabilityRegistrarBase class.
29
+
30
+ #### Parameters
31
+
32
+ | Parameter | Type | Description |
33
+ | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------- |
34
+ | `registry` | [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry) | Registry instance that receives contributed capabilities. |
35
+
36
+ #### Returns
37
+
38
+ `IntelligenceCapabilityRegistrarBase`
39
+
40
+ ## Accessors
41
+
42
+ ### registry
43
+
44
+ #### Get Signature
45
+
46
+ ```ts
47
+ get protected registry(): IntelligenceCapabilityRegistry;
48
+ ```
49
+
50
+ Defined in: [intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts#L38)
51
+
52
+ ##### Returns
53
+
54
+ [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry)
55
+
18
56
  ## Methods
19
57
 
58
+ ### getCapabilities()
59
+
60
+ ```ts
61
+ abstract protected getCapabilities(): readonly IIntelligenceCapability[];
62
+ ```
63
+
64
+ Defined in: [intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts#L63)
65
+
66
+ Returns the capabilities that should be registered for the module.
67
+
68
+ #### Returns
69
+
70
+ readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
71
+
72
+ ---
73
+
20
74
  ### onModuleInit()
21
75
 
22
76
  ```ts
@@ -26,7 +80,7 @@ onModuleInit(): void;
26
80
  Defined in: [intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts#L50)
27
81
 
28
82
  Template method invoked by NestJS once the provider has been instantiated.
29
- Registers all capabilities returned by getCapabilities.
83
+ Registers all capabilities returned by [getCapabilities](#getcapabilities).
30
84
 
31
85
  #### Returns
32
86
 
@@ -35,6 +35,16 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:54](https://github.com/RueD
35
35
 
36
36
  `ProblemDetailExceptionFilter`
37
37
 
38
+ ## Properties
39
+
40
+ ### urlResolver?
41
+
42
+ ```ts
43
+ protected optional urlResolver?: ProblemDetailTypeUrlResolver;
44
+ ```
45
+
46
+ Defined in: [filters/ProblemDetailExceptionFilter.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L55)
47
+
38
48
  ## Methods
39
49
 
40
50
  ### catch()