@breadstone/archipel-mcp 0.0.11 → 0.0.14

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 (604) hide show
  1. package/package.json +1 -1
  2. package/src/DocsLoader.js +2 -5
  3. package/src/GuidesLoader.js +2 -5
  4. package/data/guides/ai-text-generation.md +0 -361
  5. package/data/guides/analytics-and-error-tracking.md +0 -189
  6. package/data/guides/authentication-and-authorization.md +0 -657
  7. package/data/guides/blob-storage.md +0 -242
  8. package/data/guides/caching.md +0 -255
  9. package/data/guides/cryptography-and-otp.md +0 -240
  10. package/data/guides/document-generation.md +0 -174
  11. package/data/guides/email-delivery.md +0 -196
  12. package/data/guides/esigning-integration.md +0 -231
  13. package/data/guides/getting-started.md +0 -351
  14. package/data/guides/implementing-ports.md +0 -317
  15. package/data/guides/index.md +0 -61
  16. package/data/guides/mcp-server.md +0 -222
  17. package/data/guides/openapi-and-feature-discovery.md +0 -266
  18. package/data/guides/payments-and-feature-gating.md +0 -244
  19. package/data/guides/resource-management.md +0 -352
  20. package/data/guides/telemetry-and-observability.md +0 -190
  21. package/data/guides/testing.md +0 -319
  22. package/data/guides/tsdoc-guidelines.md +0 -45
  23. package/data/packages/index.md +0 -52
  24. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +0 -141
  25. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +0 -47
  26. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +0 -169
  27. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +0 -169
  28. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +0 -161
  29. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +0 -169
  30. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +0 -58
  31. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +0 -47
  32. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +0 -58
  33. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +0 -14
  34. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +0 -14
  35. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +0 -14
  36. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +0 -14
  37. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +0 -14
  38. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +0 -14
  39. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +0 -14
  40. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +0 -14
  41. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +0 -14
  42. package/data/packages/platform-analytics/api/index.md +0 -44
  43. package/data/packages/platform-analytics/index.md +0 -170
  44. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -40
  45. package/data/packages/platform-authentication/api/Class.AppleConnector.md +0 -86
  46. package/data/packages/platform-authentication/api/Class.AuthModule.md +0 -67
  47. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -95
  48. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -59
  49. package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -131
  50. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -40
  51. package/data/packages/platform-authentication/api/Class.GithubConnector.md +0 -78
  52. package/data/packages/platform-authentication/api/Class.GoogleConnector.md +0 -84
  53. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -40
  54. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +0 -136
  55. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -71
  56. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -40
  57. package/data/packages/platform-authentication/api/Class.MfaService.md +0 -252
  58. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -70
  59. package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +0 -84
  60. package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -60
  61. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -60
  62. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -165
  63. package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -152
  64. package/data/packages/platform-authentication/api/Class.SessionService.md +0 -162
  65. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +0 -61
  66. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -48
  67. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -47
  68. package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +0 -144
  69. package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -154
  70. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -116
  71. package/data/packages/platform-authentication/api/Function.Token.md +0 -18
  72. package/data/packages/platform-authentication/api/Function.UseRoles.md +0 -24
  73. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +0 -22
  74. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +0 -143
  75. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -107
  76. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -82
  77. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -118
  78. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -22
  79. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -58
  80. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -131
  81. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -91
  82. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -160
  83. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -82
  84. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -58
  85. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -70
  86. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -71
  87. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +0 -14
  88. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +0 -14
  89. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +0 -14
  90. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +0 -14
  91. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +0 -14
  92. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +0 -14
  93. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +0 -14
  94. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +0 -14
  95. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +0 -14
  96. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +0 -14
  97. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +0 -14
  98. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +0 -14
  99. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +0 -14
  100. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +0 -14
  101. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +0 -14
  102. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +0 -14
  103. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +0 -14
  104. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +0 -14
  105. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +0 -14
  106. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +0 -14
  107. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +0 -14
  108. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +0 -14
  109. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +0 -14
  110. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +0 -14
  111. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +0 -14
  112. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +0 -14
  113. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +0 -14
  114. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +0 -14
  115. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +0 -14
  116. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +0 -14
  117. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +0 -14
  118. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +0 -14
  119. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +0 -14
  120. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +0 -14
  121. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +0 -14
  122. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +0 -14
  123. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +0 -14
  124. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +0 -14
  125. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +0 -14
  126. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +0 -14
  127. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +0 -14
  128. package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +0 -29
  129. package/data/packages/platform-authentication/api/Variable.User.md +0 -24
  130. package/data/packages/platform-authentication/api/index.md +0 -112
  131. package/data/packages/platform-authentication/index.md +0 -635
  132. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +0 -196
  133. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +0 -196
  134. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -79
  135. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +0 -49
  136. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -75
  137. package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -248
  138. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -51
  139. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -197
  140. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +0 -28
  141. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +0 -68
  142. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +0 -38
  143. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +0 -28
  144. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +0 -38
  145. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +0 -48
  146. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +0 -64
  147. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +0 -48
  148. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +0 -138
  149. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +0 -114
  150. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +0 -48
  151. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +0 -98
  152. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +0 -28
  153. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +0 -28
  154. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -68
  155. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +0 -28
  156. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +0 -12
  157. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -12
  158. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +0 -16
  159. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +0 -12
  160. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +0 -12
  161. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +0 -12
  162. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +0 -26
  163. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +0 -26
  164. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +0 -12
  165. package/data/packages/platform-blob-storage/api/index.md +0 -59
  166. package/data/packages/platform-blob-storage/index.md +0 -335
  167. package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +0 -258
  168. package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +0 -157
  169. package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +0 -295
  170. package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +0 -121
  171. package/data/packages/platform-caching/api/Interface.ICacheStats.md +0 -70
  172. package/data/packages/platform-caching/api/Interface.ILayeredCache.md +0 -198
  173. package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +0 -75
  174. package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +0 -121
  175. package/data/packages/platform-caching/api/index.md +0 -24
  176. package/data/packages/platform-caching/index.md +0 -116
  177. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +0 -50
  178. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +0 -195
  179. package/data/packages/platform-core/api/Class.BooleanUtils.md +0 -82
  180. package/data/packages/platform-core/api/Class.CUIDGenerator.md +0 -120
  181. package/data/packages/platform-core/api/Class.CasingInterceptor.md +0 -83
  182. package/data/packages/platform-core/api/Class.CatchUtils.md +0 -93
  183. package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +0 -89
  184. package/data/packages/platform-core/api/Class.ConfigModule.md +0 -69
  185. package/data/packages/platform-core/api/Class.ConfigRegistry.md +0 -115
  186. package/data/packages/platform-core/api/Class.ConfigService.md +0 -137
  187. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +0 -125
  188. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +0 -63
  189. package/data/packages/platform-core/api/Class.DateTimeUtils.md +0 -101
  190. package/data/packages/platform-core/api/Class.DeviceParserService.md +0 -52
  191. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +0 -215
  192. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +0 -141
  193. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +0 -109
  194. package/data/packages/platform-core/api/Class.EventHub.md +0 -163
  195. package/data/packages/platform-core/api/Class.EventModule.md +0 -22
  196. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +0 -147
  197. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +0 -192
  198. package/data/packages/platform-core/api/Class.GUIDGenerator.md +0 -85
  199. package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +0 -66
  200. package/data/packages/platform-core/api/Class.HealthModule.md +0 -42
  201. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +0 -64
  202. package/data/packages/platform-core/api/Class.HostModule.md +0 -31
  203. package/data/packages/platform-core/api/Class.HostService.md +0 -149
  204. package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +0 -59
  205. package/data/packages/platform-core/api/Class.IdGeneratorBase.md +0 -87
  206. package/data/packages/platform-core/api/Class.IdentifierModule.md +0 -40
  207. package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +0 -59
  208. package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +0 -42
  209. package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +0 -42
  210. package/data/packages/platform-core/api/Class.MappingBuilder.md +0 -110
  211. package/data/packages/platform-core/api/Class.MappingModule.md +0 -46
  212. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +0 -56
  213. package/data/packages/platform-core/api/Class.MappingProfileBase.md +0 -52
  214. package/data/packages/platform-core/api/Class.MappingService.md +0 -284
  215. package/data/packages/platform-core/api/Class.NormalizedUtils.md +0 -148
  216. package/data/packages/platform-core/api/Class.PageableRequest.md +0 -42
  217. package/data/packages/platform-core/api/Class.PageableResponse.md +0 -62
  218. package/data/packages/platform-core/api/Class.ProblemDetailException.md +0 -61
  219. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +0 -94
  220. package/data/packages/platform-core/api/Class.QuantityResponse.md +0 -42
  221. package/data/packages/platform-core/api/Class.ResourceManager.md +0 -565
  222. package/data/packages/platform-core/api/Class.ResourceModule.md +0 -46
  223. package/data/packages/platform-core/api/Class.ResponseReturn.md +0 -502
  224. package/data/packages/platform-core/api/Class.SseHub.md +0 -183
  225. package/data/packages/platform-core/api/Class.SseModule.md +0 -42
  226. package/data/packages/platform-core/api/Class.TimeStampResponse.md +0 -42
  227. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +0 -57
  228. package/data/packages/platform-core/api/Class.UUIDGenerator.md +0 -85
  229. package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +0 -47
  230. package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +0 -64
  231. package/data/packages/platform-core/api/Function.Public.md +0 -18
  232. package/data/packages/platform-core/api/Function.createConfigKey.md +0 -58
  233. package/data/packages/platform-core/api/Function.createEventKey.md +0 -33
  234. package/data/packages/platform-core/api/Function.createMappingKey.md +0 -39
  235. package/data/packages/platform-core/api/Function.env.md +0 -28
  236. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +0 -26
  237. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +0 -27
  238. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +0 -28
  239. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +0 -40
  240. package/data/packages/platform-core/api/Interface.IConfigKey.md +0 -63
  241. package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +0 -40
  242. package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +0 -79
  243. package/data/packages/platform-core/api/Interface.IDeviceInfo.md +0 -80
  244. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +0 -153
  245. package/data/packages/platform-core/api/Interface.IEventKey.md +0 -57
  246. package/data/packages/platform-core/api/Interface.IEventMap.md +0 -16
  247. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +0 -72
  248. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +0 -46
  249. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +0 -41
  250. package/data/packages/platform-core/api/Interface.IHostContentParams.md +0 -232
  251. package/data/packages/platform-core/api/Interface.IIdGenerator.md +0 -57
  252. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +0 -76
  253. package/data/packages/platform-core/api/Interface.IMappingKey.md +0 -58
  254. package/data/packages/platform-core/api/Interface.IMappingProfile.md +0 -32
  255. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +0 -71
  256. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +0 -94
  257. package/data/packages/platform-core/api/Interface.IResourceResult.md +0 -34
  258. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +0 -134
  259. package/data/packages/platform-core/api/Interface.ISseEventData.md +0 -36
  260. package/data/packages/platform-core/api/Interface.ISseHub.md +0 -91
  261. package/data/packages/platform-core/api/Namespace.ISseEventData.md +0 -14
  262. package/data/packages/platform-core/api/TypeAlias.CamelCase.md +0 -18
  263. package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +0 -28
  264. package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +0 -25
  265. package/data/packages/platform-core/api/TypeAlias.SetOptional.md +0 -21
  266. package/data/packages/platform-core/api/TypeAlias.StringValue.md +0 -15
  267. package/data/packages/platform-core/api/Variable.APP_NAME.md +0 -14
  268. package/data/packages/platform-core/api/Variable.APP_PORT.md +0 -14
  269. package/data/packages/platform-core/api/Variable.APP_URL.md +0 -14
  270. package/data/packages/platform-core/api/Variable.APP_VERSION.md +0 -14
  271. package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +0 -14
  272. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +0 -14
  273. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +0 -14
  274. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +0 -14
  275. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +0 -14
  276. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +0 -14
  277. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +0 -14
  278. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +0 -12
  279. package/data/packages/platform-core/api/Variable.IpAddress.md +0 -31
  280. package/data/packages/platform-core/api/Variable.Lang.md +0 -29
  281. package/data/packages/platform-core/api/Variable.NODE_ENV.md +0 -14
  282. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +0 -14
  283. package/data/packages/platform-core/api/Variable.UserAgent.md +0 -24
  284. package/data/packages/platform-core/api/index.md +0 -142
  285. package/data/packages/platform-core/index.md +0 -485
  286. package/data/packages/platform-cryptography/api/Class.BcryptService.md +0 -72
  287. package/data/packages/platform-cryptography/api/Class.CryptoService.md +0 -51
  288. package/data/packages/platform-cryptography/api/Class.OtpService.md +0 -109
  289. package/data/packages/platform-cryptography/api/Interface.IOtpService.md +0 -81
  290. package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +0 -46
  291. package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +0 -14
  292. package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +0 -23
  293. package/data/packages/platform-cryptography/api/index.md +0 -28
  294. package/data/packages/platform-cryptography/index.md +0 -132
  295. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -75
  296. package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -70
  297. package/data/packages/platform-database/api/Class.DatabaseService.md +0 -160
  298. package/data/packages/platform-database/api/Class.PrismaService.md +0 -111
  299. package/data/packages/platform-database/api/Class.RepositoryBase.md +0 -586
  300. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -55
  301. package/data/packages/platform-database/api/Function.pageable.md +0 -35
  302. package/data/packages/platform-database/api/Function.paginator.md +0 -22
  303. package/data/packages/platform-database/api/Function.query.md +0 -34
  304. package/data/packages/platform-database/api/Function.skip.md +0 -33
  305. package/data/packages/platform-database/api/Function.transactionalQuery.md +0 -31
  306. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -22
  307. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -28
  308. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -77
  309. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -51
  310. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -50
  311. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -18
  312. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -18
  313. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -31
  314. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -27
  315. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -26
  316. package/data/packages/platform-database/api/index.md +0 -47
  317. package/data/packages/platform-database/index.md +0 -300
  318. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +0 -277
  319. package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -80
  320. package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -47
  321. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -131
  322. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -94
  323. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -70
  324. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -118
  325. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -47
  326. package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -58
  327. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -95
  328. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -64
  329. package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -58
  330. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -14
  331. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -14
  332. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -14
  333. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -14
  334. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -14
  335. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +0 -14
  336. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +0 -14
  337. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +0 -14
  338. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +0 -14
  339. package/data/packages/platform-documents/api/index.md +0 -47
  340. package/data/packages/platform-documents/index.md +0 -219
  341. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +0 -184
  342. package/data/packages/platform-esigning/api/Class.EsigningError.md +0 -65
  343. package/data/packages/platform-esigning/api/Class.EsigningModule.md +0 -48
  344. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +0 -90
  345. package/data/packages/platform-esigning/api/Class.EsigningService.md +0 -198
  346. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +0 -249
  347. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +0 -101
  348. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +0 -78
  349. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +0 -60
  350. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +0 -94
  351. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +0 -58
  352. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +0 -58
  353. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +0 -46
  354. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +0 -60
  355. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +0 -82
  356. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +0 -82
  357. package/data/packages/platform-esigning/api/Interface.ISigner.md +0 -82
  358. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +0 -82
  359. package/data/packages/platform-esigning/api/Interface.ISigningField.md +0 -142
  360. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +0 -142
  361. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +0 -70
  362. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +0 -14
  363. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +0 -14
  364. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +0 -14
  365. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +0 -14
  366. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +0 -14
  367. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +0 -14
  368. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +0 -14
  369. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +0 -14
  370. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +0 -14
  371. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +0 -14
  372. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +0 -14
  373. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +0 -14
  374. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +0 -14
  375. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +0 -14
  376. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +0 -14
  377. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +0 -14
  378. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +0 -14
  379. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +0 -14
  380. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +0 -14
  381. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +0 -14
  382. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +0 -14
  383. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +0 -14
  384. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +0 -12
  385. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +0 -12
  386. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +0 -14
  387. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +0 -14
  388. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +0 -14
  389. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +0 -14
  390. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +0 -14
  391. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +0 -14
  392. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +0 -14
  393. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +0 -14
  394. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +0 -30
  395. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +0 -32
  396. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +0 -38
  397. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +0 -36
  398. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +0 -38
  399. package/data/packages/platform-esigning/api/index.md +0 -84
  400. package/data/packages/platform-esigning/index.md +0 -691
  401. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
  402. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
  403. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -22
  404. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -81
  405. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -26
  406. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
  407. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
  408. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
  409. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
  410. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
  411. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
  412. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
  413. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
  414. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
  415. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
  416. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
  417. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
  418. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
  419. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
  420. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
  421. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
  422. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
  423. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
  424. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
  425. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
  426. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
  427. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
  428. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
  429. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +0 -94
  430. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
  431. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -60
  432. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -46
  433. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -53
  434. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
  435. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
  436. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +0 -14
  437. package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
  438. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +0 -28
  439. package/data/packages/platform-intelligence/api/index.md +0 -69
  440. package/data/packages/platform-intelligence/index.md +0 -131
  441. package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -20
  442. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +0 -14
  443. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +0 -14
  444. package/data/packages/platform-logging/api/index.md +0 -19
  445. package/data/packages/platform-logging/index.md +0 -92
  446. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +0 -60
  447. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +0 -66
  448. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +0 -58
  449. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +0 -75
  450. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -78
  451. package/data/packages/platform-mailing/api/Class.MailModule.md +0 -22
  452. package/data/packages/platform-mailing/api/Class.MailService.md +0 -96
  453. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -93
  454. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -85
  455. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +0 -75
  456. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +0 -75
  457. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +0 -75
  458. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +0 -75
  459. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +0 -75
  460. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +0 -53
  461. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -66
  462. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -30
  463. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -14
  464. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +0 -14
  465. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +0 -14
  466. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +0 -14
  467. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +0 -14
  468. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +0 -12
  469. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +0 -14
  470. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +0 -14
  471. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +0 -14
  472. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +0 -14
  473. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +0 -14
  474. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +0 -14
  475. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +0 -14
  476. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +0 -14
  477. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +0 -14
  478. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +0 -14
  479. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +0 -14
  480. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +0 -14
  481. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +0 -14
  482. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +0 -14
  483. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +0 -16
  484. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +0 -14
  485. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +0 -14
  486. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +0 -14
  487. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +0 -14
  488. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +0 -14
  489. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +0 -14
  490. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +0 -14
  491. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +0 -14
  492. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +0 -14
  493. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +0 -14
  494. package/data/packages/platform-mailing/api/index.md +0 -74
  495. package/data/packages/platform-mailing/index.md +0 -335
  496. package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +0 -64
  497. package/data/packages/platform-mcp/api/Class.McpModule.md +0 -82
  498. package/data/packages/platform-mcp/api/Class.McpRegistryService.md +0 -146
  499. package/data/packages/platform-mcp/api/Class.McpServerService.md +0 -196
  500. package/data/packages/platform-mcp/api/Function.McpPrompt.md +0 -28
  501. package/data/packages/platform-mcp/api/Function.McpResource.md +0 -28
  502. package/data/packages/platform-mcp/api/Function.McpTool.md +0 -28
  503. package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +0 -46
  504. package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +0 -75
  505. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +0 -125
  506. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +0 -27
  507. package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +0 -58
  508. package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +0 -72
  509. package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +0 -82
  510. package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +0 -40
  511. package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +0 -40
  512. package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +0 -40
  513. package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -22
  514. package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +0 -38
  515. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +0 -14
  516. package/data/packages/platform-mcp/api/index.md +0 -46
  517. package/data/packages/platform-mcp/index.md +0 -299
  518. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -70
  519. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -99
  520. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -77
  521. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -46
  522. package/data/packages/platform-openapi/api/Function.Api.md +0 -35
  523. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +0 -42
  524. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -18
  525. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +0 -27
  526. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -68
  527. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -68
  528. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +0 -14
  529. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +0 -14
  530. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +0 -14
  531. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +0 -14
  532. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +0 -14
  533. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +0 -12
  534. package/data/packages/platform-openapi/api/index.md +0 -42
  535. package/data/packages/platform-openapi/index.md +0 -170
  536. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -74
  537. package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -68
  538. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -69
  539. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -163
  540. package/data/packages/platform-payments/api/Class.MollieClient.md +0 -163
  541. package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -163
  542. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -142
  543. package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -48
  544. package/data/packages/platform-payments/api/Class.StripeClient.md +0 -163
  545. package/data/packages/platform-payments/api/Function.RequiresFeature.md +0 -25
  546. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -70
  547. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -70
  548. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -80
  549. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -100
  550. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -84
  551. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -60
  552. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -22
  553. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +0 -12
  554. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +0 -14
  555. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +0 -14
  556. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +0 -14
  557. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +0 -14
  558. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +0 -14
  559. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +0 -14
  560. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +0 -14
  561. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +0 -14
  562. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +0 -14
  563. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +0 -14
  564. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +0 -14
  565. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +0 -14
  566. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +0 -14
  567. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +0 -14
  568. package/data/packages/platform-payments/api/index.md +0 -63
  569. package/data/packages/platform-payments/index.md +0 -532
  570. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +0 -56
  571. package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +0 -40
  572. package/data/packages/platform-reporting/api/Class.ReportingFacade.md +0 -84
  573. package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -22
  574. package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +0 -61
  575. package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +0 -82
  576. package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +0 -70
  577. package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +0 -60
  578. package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +0 -40
  579. package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +0 -60
  580. package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +0 -30
  581. package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +0 -12
  582. package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +0 -12
  583. package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -14
  584. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +0 -30
  585. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +0 -28
  586. package/data/packages/platform-reporting/api/index.md +0 -42
  587. package/data/packages/platform-reporting/index.md +0 -229
  588. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -113
  589. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -175
  590. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -127
  591. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -226
  592. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -40
  593. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -48
  594. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -85
  595. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -38
  596. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -136
  597. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -38
  598. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +0 -12
  599. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +0 -12
  600. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +0 -12
  601. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +0 -12
  602. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -12
  603. package/data/packages/platform-telemetry/api/index.md +0 -36
  604. package/data/packages/platform-telemetry/index.md +0 -234
@@ -1,691 +0,0 @@
1
- ---
2
- title: platform-esigning
3
- description: Provider-agnostic e-signing infrastructure with support for DocuSign, Adobe Sign, Dropbox Sign, signNow, and a built-in internal provider.
4
- order: 5
5
- tags: [esigning, docusign, adobe-sign, dropbox-sign, signnow, digital-signatures, ports-and-adapters, webhooks]
6
- package: '@breadstone/archipel-platform-esigning'
7
- ---
8
-
9
- # platform-esigning
10
-
11
- Provider-agnostic e-signing infrastructure for NestJS. Exposes a unified `EsigningClientPort` abstraction with an internal provider out of the box and prepared entry points for DocuSign, Adobe Sign, Dropbox Sign, and signNow. Optionally tracks signing request state via the `EsigningPersistencePort`.
12
-
13
- **Package:** `@breadstone/archipel-platform-esigning`
14
-
15
- ## Architecture
16
-
17
- ```mermaid
18
- graph TD
19
- Core["@breadstone/archipel-platform-esigning<br/><i>Port, models, errors, module, service</i>"]
20
- Internal["InternalEsigningProvider<br/><i>Built-in in-memory provider</i>"]
21
- DocuSign["@breadstone/archipel-platform-esigning/docusign<br/><i>DocuSign config</i>"]
22
- AdobeSign["@breadstone/archipel-platform-esigning/adobe-sign<br/><i>Adobe Sign config</i>"]
23
- DropboxSign["@breadstone/archipel-platform-esigning/dropbox-sign<br/><i>Dropbox Sign config</i>"]
24
- SignNow["@breadstone/archipel-platform-esigning/signnow<br/><i>signNow config</i>"]
25
-
26
- Internal -->|implements| Core
27
- DocuSign -.->|implements| Core
28
- AdobeSign -.->|implements| Core
29
- DropboxSign -.->|implements| Core
30
- SignNow -.->|implements| Core
31
-
32
- DocuSign -.-|requires| DS["docusign-esign"]
33
- AdobeSign -.-|requires| AS["adobe-sign SDK"]
34
- DropboxSign -.-|requires| DBS["@dropbox/sign"]
35
- SignNow -.-|requires| SN["@signnow/api-client"]
36
- ```
37
-
38
- Solid lines indicate shipped implementations. Dashed lines indicate provider entry points prepared for implementation. Each provider SDK is an **optional peer dependency** — install only the one you need.
39
-
40
- ---
41
-
42
- ## Quick Start
43
-
44
- ### 1. Register with the internal provider
45
-
46
- ```typescript
47
- import { Module } from '@nestjs/common';
48
- import { EsigningModule, InternalEsigningProvider } from '@breadstone/archipel-platform-esigning';
49
-
50
- @Module({
51
- imports: [
52
- EsigningModule.register({
53
- provider: InternalEsigningProvider,
54
- }),
55
- ],
56
- })
57
- export class AppModule {}
58
- ```
59
-
60
- ### 2. Register with an external provider
61
-
62
- ```typescript
63
- import { Module } from '@nestjs/common';
64
- import { EsigningModule } from '@breadstone/archipel-platform-esigning';
65
- import { DOCUSIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/docusign';
66
-
67
- @Module({
68
- imports: [
69
- EsigningModule.register({
70
- provider: DocuSignClient, // your EsigningClientPort implementation
71
- configEntries: DOCUSIGN_CONFIG_ENTRIES,
72
- persistence: PrismaEsigningAdapter, // optional
73
- isGlobal: false,
74
- }),
75
- ],
76
- })
77
- export class AppModule {}
78
- ```
79
-
80
- ### Switching providers
81
-
82
- Replace the imports — no other code change needed:
83
-
84
- ```typescript
85
- import { ADOBE_SIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/adobe-sign';
86
-
87
- EsigningModule.register({
88
- provider: AdobeSignClient,
89
- configEntries: ADOBE_SIGN_CONFIG_ENTRIES,
90
- });
91
- ```
92
-
93
- ---
94
-
95
- ## Module Configuration
96
-
97
- ### IEsigningModuleOptions
98
-
99
- | Property | Type | Required | Default | Description |
100
- | --------------- | ----------------------------------------------------- | -------- | ------- | --------------------------------------------------------- |
101
- | `provider` | `Type<EsigningClientPort>` | **Yes** | — | Provider implementation (e.g. `InternalEsigningProvider`) |
102
- | `configEntries` | `ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>` | No | `[]` | Provider-specific config entries |
103
- | `persistence` | `Type<EsigningPersistencePort>` | No | — | Signing request state tracking (e.g. Prisma adapter) |
104
- | `isGlobal` | `boolean` | No | `false` | Register as a global module |
105
-
106
- ---
107
-
108
- ## E-Signing Providers
109
-
110
- ### Internal (built-in)
111
-
112
- The `InternalEsigningProvider` manages signing requests in-memory. Suitable for development, testing, or simple self-managed signing workflows.
113
-
114
- ```typescript
115
- import { InternalEsigningProvider } from '@breadstone/archipel-platform-esigning';
116
-
117
- EsigningModule.register({
118
- provider: InternalEsigningProvider,
119
- });
120
- ```
121
-
122
- ::: tip Internal Provider
123
- The internal provider also exposes a `completeSigner()` method that allows the consuming application to programmatically complete a signer's step — useful for self-hosted signing UIs.
124
- :::
125
-
126
- ### DocuSign
127
-
128
- **Subpath:** `@breadstone/archipel-platform-esigning/docusign`
129
-
130
- | Variable | Description | Required |
131
- | --------------------------- | ---------------------------------------------------- | -------- |
132
- | `DOCUSIGN_INTEGRATION_KEY` | DocuSign integration key (client ID) | Yes |
133
- | `DOCUSIGN_SECRET_KEY` | DocuSign secret key (client secret) | Yes |
134
- | `DOCUSIGN_ACCOUNT_ID` | DocuSign account ID | Yes |
135
- | `DOCUSIGN_BASE_URL` | DocuSign base URL (e.g. `https://demo.docusign.net`) | Yes |
136
- | `DOCUSIGN_WEBHOOK_HMAC_KEY` | DocuSign webhook HMAC key | No |
137
-
138
- ```typescript
139
- import { DOCUSIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/docusign';
140
- ```
141
-
142
- ### Adobe Sign
143
-
144
- **Subpath:** `@breadstone/archipel-platform-esigning/adobe-sign`
145
-
146
- | Variable | Description | Required |
147
- | ------------------------------ | --------------------------------------------- | -------- |
148
- | `ADOBE_SIGN_INTEGRATION_KEY` | Adobe Sign integration key | Yes |
149
- | `ADOBE_SIGN_CLIENT_SECRET` | Adobe Sign client secret | Yes |
150
- | `ADOBE_SIGN_BASE_URL` | Adobe Sign base URL | Yes |
151
- | `ADOBE_SIGN_WEBHOOK_CLIENT_ID` | Adobe Sign webhook client ID for verification | No |
152
-
153
- ```typescript
154
- import { ADOBE_SIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/adobe-sign';
155
- ```
156
-
157
- ### Dropbox Sign
158
-
159
- **Subpath:** `@breadstone/archipel-platform-esigning/dropbox-sign`
160
-
161
- | Variable | Description | Required |
162
- | ----------------------------- | --------------------------- | -------- |
163
- | `DROPBOX_SIGN_API_KEY` | Dropbox Sign API key | Yes |
164
- | `DROPBOX_SIGN_CLIENT_ID` | Dropbox Sign client ID | Yes |
165
- | `DROPBOX_SIGN_WEBHOOK_SECRET` | Dropbox Sign webhook secret | No |
166
-
167
- ```typescript
168
- import { DROPBOX_SIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/dropbox-sign';
169
- ```
170
-
171
- ### signNow
172
-
173
- **Subpath:** `@breadstone/archipel-platform-esigning/signnow`
174
-
175
- | Variable | Description | Required |
176
- | ------------------------ | ------------------------------- | -------- |
177
- | `SIGNNOW_API_KEY` | signNow API key (basic token) | Yes |
178
- | `SIGNNOW_CLIENT_ID` | signNow client ID | Yes |
179
- | `SIGNNOW_CLIENT_SECRET` | signNow client secret | Yes |
180
- | `SIGNNOW_BASE_URL` | signNow base URL | Yes |
181
- | `SIGNNOW_WEBHOOK_SECRET` | signNow webhook callback secret | No |
182
-
183
- ```typescript
184
- import { SIGNNOW_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/signnow';
185
- ```
186
-
187
- ---
188
-
189
- ## EsigningClientPort
190
-
191
- All providers implement this abstract contract. Inject `EsigningClientPort` in services to stay provider-agnostic:
192
-
193
- ```typescript
194
- abstract class EsigningClientPort {
195
- abstract readonly providerId: string;
196
- abstract createSigningRequest(request: ICreateSigningRequest): Promise<ISigningRequest>;
197
- abstract createSigningSession(request: ICreateSigningSessionRequest): Promise<ISigningSession>;
198
- abstract getSigningRequest(signingRequestId: string): Promise<ISigningRequest>;
199
- abstract getSignedDocuments(signingRequestId: string): Promise<Array<ISignedDocument>>;
200
- abstract cancelSigningRequest(signingRequestId: string, reason?: string): Promise<void>;
201
- abstract verifyWebhook(payload: string | Buffer, signature: string): Promise<IEsigningWebhookEvent>;
202
- }
203
- ```
204
-
205
- ### Usage in services
206
-
207
- ```typescript
208
- import { EsigningClientPort } from '@breadstone/archipel-platform-esigning';
209
-
210
- @Injectable()
211
- export class ContractService {
212
- constructor(private readonly _esigning: EsigningClientPort) {}
213
-
214
- public async sendForSigning(contract: Contract): Promise<string> {
215
- const signingRequest = await this._esigning.createSigningRequest({
216
- subject: `Contract: ${contract.title}`,
217
- documents: [
218
- {
219
- name: 'contract.pdf',
220
- contentType: 'application/pdf',
221
- content: contract.pdfBuffer,
222
- order: 1,
223
- },
224
- ],
225
- signers: [
226
- {
227
- email: contract.signerEmail,
228
- name: contract.signerName,
229
- role: 'signer',
230
- order: 1,
231
- },
232
- ],
233
- });
234
- return signingRequest.signingRequestId;
235
- }
236
- }
237
- ```
238
-
239
- ### Create Signing Request
240
-
241
- ```typescript
242
- const signingRequest = await this._esigning.createSigningRequest({
243
- subject: 'NDA Agreement',
244
- message: 'Please sign this NDA at your earliest convenience.',
245
- documents: [{ name: 'nda.pdf', contentType: 'application/pdf', content: pdfBuffer, order: 1 }],
246
- signers: [{ email: 'alice@example.com', name: 'Alice', role: 'signer', order: 1 }],
247
- fields: [
248
- {
249
- type: 'signature',
250
- signerId: '...', // resolved after creation
251
- documentId: '...',
252
- pageNumber: 1,
253
- positionX: 100,
254
- positionY: 500,
255
- width: 200,
256
- height: 50,
257
- required: true,
258
- },
259
- ],
260
- expiresInHours: 72,
261
- });
262
- // → ISigningRequest
263
- ```
264
-
265
- ### Create Signing Session
266
-
267
- ```typescript
268
- const session = await this._esigning.createSigningSession({
269
- signingRequestId: 'sr_abc123',
270
- signerId: 'sgn_xyz789',
271
- returnUrl: 'https://app.example.com/signing/complete',
272
- });
273
- // → ISigningSession { signingUrl, expiresAt, ... }
274
- ```
275
-
276
- ### Get Signing Request Status
277
-
278
- ```typescript
279
- const request = await this._esigning.getSigningRequest('sr_abc123');
280
- // → ISigningRequest { status, signers, documents, ... }
281
- ```
282
-
283
- ### Get Signed Documents
284
-
285
- ```typescript
286
- const documents = await this._esigning.getSignedDocuments('sr_abc123');
287
- // → ISignedDocument[] { documentId, content, contentType, sizeInBytes, ... }
288
- ```
289
-
290
- ### Cancel Signing Request
291
-
292
- ```typescript
293
- await this._esigning.cancelSigningRequest('sr_abc123', 'Contract terms changed.');
294
- ```
295
-
296
- ### Verify Webhook
297
-
298
- ```typescript
299
- const event = await this._esigning.verifyWebhook(rawBody, signatureHeader);
300
- // → IEsigningWebhookEvent { eventType, signingRequestId, ... }
301
- ```
302
-
303
- ---
304
-
305
- ## EsigningService
306
-
307
- The `EsigningService` wraps `EsigningClientPort` and adds optional persistence tracking via `EsigningPersistencePort`:
308
-
309
- ```typescript
310
- import { EsigningService } from '@breadstone/archipel-platform-esigning';
311
-
312
- @Injectable()
313
- export class ContractWorkflowService {
314
- constructor(private readonly _esigning: EsigningService) {}
315
-
316
- public async initiateSigningFlow(contractId: string): Promise<ISigningRequest> {
317
- // Automatically persists via EsigningPersistencePort (if registered)
318
- return this._esigning.createSigningRequest({ ... });
319
- }
320
- }
321
- ```
322
-
323
- All methods on `EsigningService` mirror `EsigningClientPort` and additionally invoke the persistence port when registered:
324
-
325
- | Method | Persistence Hook |
326
- | ---------------------- | --------------------------------- |
327
- | `createSigningRequest` | `onSigningRequestCreated()` |
328
- | `cancelSigningRequest` | `onSigningRequestCancelled()` |
329
- | `verifyWebhook` | `onSigningRequestStatusChanged()` |
330
- | `createSigningSession` | — |
331
- | `getSigningRequest` | — |
332
- | `getSignedDocuments` | — |
333
-
334
- ---
335
-
336
- ## Ports (Contracts)
337
-
338
- ### EsigningPersistencePort
339
-
340
- Tracks signing request state changes. Optional — when not provided, signing still works but state is not persisted.
341
-
342
- ```typescript
343
- abstract class EsigningPersistencePort {
344
- abstract onSigningRequestCreated(signingRequest: ISigningRequest): Promise<void>;
345
- abstract onSigningRequestStatusChanged(signingRequestId: string, status: string): Promise<void>;
346
- abstract onSigningRequestCancelled(signingRequestId: string): Promise<void>;
347
- }
348
- ```
349
-
350
- ### Real-World Adapter: Prisma
351
-
352
- ```typescript
353
- @Injectable()
354
- export class PrismaEsigningAdapter extends EsigningPersistencePort {
355
- private readonly _prisma: PrismaService;
356
-
357
- constructor(prisma: PrismaService) {
358
- super();
359
- this._prisma = prisma;
360
- }
361
-
362
- public async onSigningRequestCreated(signingRequest: ISigningRequest): Promise<void> {
363
- await this._prisma.signingRequest.create({
364
- data: {
365
- externalId: signingRequest.signingRequestId,
366
- provider: 'docusign',
367
- subject: signingRequest.subject,
368
- status: signingRequest.status,
369
- createdAt: signingRequest.createdAt,
370
- },
371
- });
372
- }
373
-
374
- public async onSigningRequestStatusChanged(signingRequestId: string, status: string): Promise<void> {
375
- await this._prisma.signingRequest.update({
376
- where: { externalId: signingRequestId },
377
- data: { status, updatedAt: new Date() },
378
- });
379
- }
380
-
381
- public async onSigningRequestCancelled(signingRequestId: string): Promise<void> {
382
- await this._prisma.signingRequest.update({
383
- where: { externalId: signingRequestId },
384
- data: { status: 'cancelled', cancelledAt: new Date() },
385
- });
386
- }
387
- }
388
- ```
389
-
390
- ---
391
-
392
- ## Normalized Types
393
-
394
- All providers map their native API responses into these shared interfaces.
395
-
396
- ### ISigningRequest
397
-
398
- | Field | Type | Description |
399
- | ------------------ | --------------------------------- | -------------------------------------------- |
400
- | `signingRequestId` | `string` | Provider-specific signing request identifier |
401
- | `status` | `SigningRequestStatus` | Current lifecycle status |
402
- | `subject` | `string` | Subject or title |
403
- | `message` | `string?` | Optional message for signers |
404
- | `signers` | `ReadonlyArray<ISigner>` | Participating signers |
405
- | `documents` | `ReadonlyArray<ISigningDocument>` | Included documents |
406
- | `fields` | `ReadonlyArray<ISigningField>` | Fields across documents |
407
- | `createdAt` | `Date` | Creation timestamp |
408
- | `updatedAt` | `Date` | Last update timestamp |
409
- | `expiresAt` | `Date?` | Expiration timestamp |
410
- | `providerMetadata` | `Record<string, unknown>?` | Provider-specific raw metadata |
411
-
412
- ### ISigner
413
-
414
- | Field | Type | Description |
415
- | ---------- | -------------- | ----------------------------------- |
416
- | `signerId` | `string` | Provider-specific signer identifier |
417
- | `email` | `string` | Email address |
418
- | `name` | `string` | Display name |
419
- | `role` | `SignerRole` | Role in the signing process |
420
- | `status` | `SignerStatus` | Current status |
421
- | `order` | `number` | Routing order (signing sequence) |
422
-
423
- ### ISigningDocument
424
-
425
- | Field | Type | Description |
426
- | ------------- | --------- | ------------------------------------- |
427
- | `documentId` | `string` | Provider-specific document identifier |
428
- | `name` | `string` | Display name |
429
- | `contentType` | `string` | MIME type |
430
- | `sizeInBytes` | `number?` | File size in bytes |
431
- | `pageCount` | `number?` | Number of pages |
432
- | `order` | `number` | Order within the signing request |
433
-
434
- ### ISigningField
435
-
436
- | Field | Type | Description |
437
- | ------------ | ------------------ | -------------------------------------- |
438
- | `fieldId` | `string` | Provider-specific field identifier |
439
- | `type` | `SigningFieldType` | Field type (signature, initials, etc.) |
440
- | `signerId` | `string` | Associated signer identifier |
441
- | `documentId` | `string` | Document this field is placed on |
442
- | `pageNumber` | `number` | Page number (1-based) |
443
- | `positionX` | `number` | X-coordinate in points |
444
- | `positionY` | `number` | Y-coordinate in points |
445
- | `width` | `number` | Width in points |
446
- | `height` | `number` | Height in points |
447
- | `required` | `boolean` | Whether the field is required |
448
- | `value` | `string?` | Current value, if filled |
449
-
450
- ### ISignedDocument
451
-
452
- | Field | Type | Description |
453
- | ------------------ | -------- | ----------------------------- |
454
- | `documentId` | `string` | Provider-specific document ID |
455
- | `signingRequestId` | `string` | Parent signing request ID |
456
- | `name` | `string` | Display name |
457
- | `contentType` | `string` | MIME type |
458
- | `content` | `Buffer` | Signed document content |
459
- | `sizeInBytes` | `number` | File size in bytes |
460
-
461
- ### ISigningSession
462
-
463
- | Field | Type | Description |
464
- | ------------------ | -------- | ------------------------------ |
465
- | `sessionId` | `string` | Session identifier |
466
- | `signingRequestId` | `string` | Parent signing request ID |
467
- | `signerId` | `string` | Signer this session belongs to |
468
- | `signingUrl` | `string` | URL to redirect signer to |
469
- | `expiresAt` | `Date` | Session expiration timestamp |
470
-
471
- ### IEsigningWebhookEvent
472
-
473
- | Field | Type | Description |
474
- | ------------------ | ------------------ | --------------------------------- |
475
- | `eventId` | `string` | Provider-specific event ID |
476
- | `eventType` | `WebhookEventType` | Normalized event type |
477
- | `signingRequestId` | `string` | Related signing request ID |
478
- | `signerId` | `string?` | Related signer ID (if applicable) |
479
- | `occurredAt` | `Date` | Event timestamp |
480
- | `rawPayload` | `unknown` | Provider-specific raw payload |
481
-
482
- ---
483
-
484
- ## Status & Role Enums
485
-
486
- ### SigningRequestStatus
487
-
488
- ```typescript
489
- const SigningRequestStatuses = {
490
- Draft: 'draft',
491
- Sent: 'sent',
492
- InProgress: 'in-progress',
493
- Completed: 'completed',
494
- Declined: 'declined',
495
- Cancelled: 'cancelled',
496
- Expired: 'expired',
497
- Voided: 'voided',
498
- } as const;
499
-
500
- type SigningRequestStatus =
501
- | 'draft'
502
- | 'sent'
503
- | 'in-progress'
504
- | 'completed'
505
- | 'declined'
506
- | 'cancelled'
507
- | 'expired'
508
- | 'voided';
509
- ```
510
-
511
- ### SignerStatus
512
-
513
- ```typescript
514
- const SignerStatuses = {
515
- Pending: 'pending',
516
- Sent: 'sent',
517
- Delivered: 'delivered',
518
- Signed: 'signed',
519
- Declined: 'declined',
520
- Expired: 'expired',
521
- } as const;
522
-
523
- type SignerStatus = 'pending' | 'sent' | 'delivered' | 'signed' | 'declined' | 'expired';
524
- ```
525
-
526
- ### SignerRole
527
-
528
- ```typescript
529
- const SignerRoles = {
530
- Signer: 'signer',
531
- CarbonCopy: 'carbon-copy',
532
- InPersonSigner: 'in-person-signer',
533
- Approver: 'approver',
534
- Witness: 'witness',
535
- } as const;
536
-
537
- type SignerRole = 'signer' | 'carbon-copy' | 'in-person-signer' | 'approver' | 'witness';
538
- ```
539
-
540
- ### SigningFieldType
541
-
542
- ```typescript
543
- const SigningFieldTypes = {
544
- Signature: 'signature',
545
- Initials: 'initials',
546
- DateSigned: 'date-signed',
547
- Text: 'text',
548
- Checkbox: 'checkbox',
549
- Name: 'name',
550
- Email: 'email',
551
- Company: 'company',
552
- Title: 'title',
553
- } as const;
554
-
555
- type SigningFieldType =
556
- | 'signature'
557
- | 'initials'
558
- | 'date-signed'
559
- | 'text'
560
- | 'checkbox'
561
- | 'name'
562
- | 'email'
563
- | 'company'
564
- | 'title';
565
- ```
566
-
567
- ### WebhookEventType
568
-
569
- ```typescript
570
- const WebhookEventTypes = {
571
- SigningRequestCompleted: 'signing-request.completed',
572
- SigningRequestDeclined: 'signing-request.declined',
573
- SigningRequestVoided: 'signing-request.voided',
574
- SigningRequestExpired: 'signing-request.expired',
575
- SigningRequestSent: 'signing-request.sent',
576
- SignerCompleted: 'signer.completed',
577
- SignerDeclined: 'signer.declined',
578
- SignerSent: 'signer.sent',
579
- SignerDelivered: 'signer.delivered',
580
- } as const;
581
- ```
582
-
583
- ---
584
-
585
- ## Error Classes
586
-
587
- | Error | Code | Description |
588
- | ----------------------------- | ----------------------------- | ------------------------------------- |
589
- | `EsigningError` | Custom `code` property | Base error for all e-signing failures |
590
- | `SigningProviderError` | `SIGNING_PROVIDER_ERROR` | Provider-level operation failed |
591
- | `SigningRequestNotFoundError` | `SIGNING_REQUEST_NOT_FOUND` | Signing request not found |
592
- | `WebhookVerificationError` | `WEBHOOK_VERIFICATION_FAILED` | Webhook signature verification failed |
593
-
594
- ```typescript
595
- import {
596
- EsigningError,
597
- SigningProviderError,
598
- SigningRequestNotFoundError,
599
- WebhookVerificationError,
600
- } from '@breadstone/archipel-platform-esigning';
601
- ```
602
-
603
- ---
604
-
605
- ## Implementing a Custom Provider
606
-
607
- To implement a new e-signing provider, extend `EsigningClientPort`:
608
-
609
- ```typescript
610
- import { Injectable } from '@nestjs/common';
611
- import { EsigningClientPort } from '@breadstone/archipel-platform-esigning';
612
- import type {
613
- ICreateSigningRequest,
614
- ICreateSigningSessionRequest,
615
- IEsigningWebhookEvent,
616
- ISignedDocument,
617
- ISigningRequest,
618
- ISigningSession,
619
- } from '@breadstone/archipel-platform-esigning';
620
-
621
- @Injectable()
622
- export class DocuSignClient extends EsigningClientPort {
623
- public readonly providerId = 'docusign';
624
-
625
- public async createSigningRequest(request: ICreateSigningRequest): Promise<ISigningRequest> {
626
- // DocuSign eSignature REST API implementation
627
- }
628
-
629
- public async createSigningSession(request: ICreateSigningSessionRequest): Promise<ISigningSession> {
630
- // Create recipient view URL
631
- }
632
-
633
- public async getSigningRequest(signingRequestId: string): Promise<ISigningRequest> {
634
- // Get envelope status
635
- }
636
-
637
- public async getSignedDocuments(signingRequestId: string): Promise<Array<ISignedDocument>> {
638
- // Download completed documents
639
- }
640
-
641
- public async cancelSigningRequest(signingRequestId: string, reason?: string): Promise<void> {
642
- // Void envelope
643
- }
644
-
645
- public async verifyWebhook(payload: string | Buffer, signature: string): Promise<IEsigningWebhookEvent> {
646
- // Verify HMAC and normalize Connect event
647
- }
648
- }
649
-
650
- // Register
651
- EsigningModule.register({
652
- provider: DocuSignClient,
653
- configEntries: DOCUSIGN_CONFIG_ENTRIES,
654
- });
655
- ```
656
-
657
- ---
658
-
659
- ## Exports Summary
660
-
661
- | Export | Type | Description |
662
- | ------------------------------ | ------------- | --------------------------------------------------- |
663
- | `EsigningModule` | NestJS Module | Main module with `register()` |
664
- | `EsigningService` | Service | Application service wrapping provider + persistence |
665
- | `EsigningClientPort` | Port | Abstract provider contract |
666
- | `EsigningPersistencePort` | Port | Optional state tracking contract |
667
- | `InternalEsigningProvider` | Provider | Built-in in-memory implementation |
668
- | `IEsigningModuleOptions` | Interface | Module configuration options |
669
- | `ISigningRequest` | Interface | Signing request model |
670
- | `ISigningSession` | Interface | Signing session/link model |
671
- | `ISignedDocument` | Interface | Signed document model |
672
- | `ISigner` | Interface | Signer model |
673
- | `ISigningDocument` | Interface | Document model |
674
- | `ISigningField` | Interface | Field definition model |
675
- | `IEsigningWebhookEvent` | Interface | Normalized webhook event |
676
- | `ICreateSigningRequest` | Interface | Signing request creation input |
677
- | `ICreateSigningSessionRequest` | Interface | Session creation input |
678
- | `SigningRequestStatuses` | Constant | Signing request status values |
679
- | `SignerStatuses` | Constant | Signer status values |
680
- | `SignerRoles` | Constant | Signer role values |
681
- | `SigningFieldTypes` | Constant | Signing field type values |
682
- | `WebhookEventTypes` | Constant | Webhook event type values |
683
- | `EsigningError` | Error | Base error class |
684
- | `SigningProviderError` | Error | Provider-level error |
685
- | `SigningRequestNotFoundError` | Error | Not found error |
686
- | `WebhookVerificationError` | Error | Webhook verification error |
687
- | `ESIGNING_PROVIDER` | Token | DI token for provider |
688
- | `ESIGNING_PROVIDER_OPTIONS` | Token | DI token for provider options |
689
- | `ESIGNING_API_KEY` | Config Key | Generic API key config |
690
- | `ESIGNING_WEBHOOK_SECRET` | Config Key | Generic webhook secret config |
691
- | `ESIGNING_API_BASE_URL` | Config Key | Generic base URL config |