@epistola.app/epistola-client 1.2.1-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/README.md +179 -0
- package/dist/auth/jwtSigner.d.ts +62 -0
- package/dist/auth/jwtSigner.d.ts.map +1 -0
- package/dist/auth/jwtSigner.js +144 -0
- package/dist/auth/jwtSigner.js.map +1 -0
- package/dist/collect/resultCollector.d.ts +161 -0
- package/dist/collect/resultCollector.d.ts.map +1 -0
- package/dist/collect/resultCollector.js +383 -0
- package/dist/collect/resultCollector.js.map +1 -0
- package/dist/error/problemDetailException.d.ts +82 -0
- package/dist/error/problemDetailException.d.ts.map +1 -0
- package/dist/error/problemDetailException.js +100 -0
- package/dist/error/problemDetailException.js.map +1 -0
- package/dist/error/problemDetailParser.d.ts +14 -0
- package/dist/error/problemDetailParser.d.ts.map +1 -0
- package/dist/error/problemDetailParser.js +78 -0
- package/dist/error/problemDetailParser.js.map +1 -0
- package/dist/error/problemTypes.d.ts +27 -0
- package/dist/error/problemTypes.d.ts.map +1 -0
- package/dist/error/problemTypes.js +38 -0
- package/dist/error/problemTypes.js.map +1 -0
- package/dist/generated/api/apis/AssetsApi.d.ts +95 -0
- package/dist/generated/api/apis/AssetsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/AssetsApi.js +262 -0
- package/dist/generated/api/apis/AssetsApi.js.map +1 -0
- package/dist/generated/api/apis/AttributesApi.d.ts +106 -0
- package/dist/generated/api/apis/AttributesApi.d.ts.map +1 -0
- package/dist/generated/api/apis/AttributesApi.js +286 -0
- package/dist/generated/api/apis/AttributesApi.js.map +1 -0
- package/dist/generated/api/apis/CatalogsApi.d.ts +120 -0
- package/dist/generated/api/apis/CatalogsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/CatalogsApi.js +306 -0
- package/dist/generated/api/apis/CatalogsApi.js.map +1 -0
- package/dist/generated/api/apis/CodeListsApi.d.ts +152 -0
- package/dist/generated/api/apis/CodeListsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/CodeListsApi.js +443 -0
- package/dist/generated/api/apis/CodeListsApi.js.map +1 -0
- package/dist/generated/api/apis/ConsumersApi.d.ts +149 -0
- package/dist/generated/api/apis/ConsumersApi.d.ts.map +1 -0
- package/dist/generated/api/apis/ConsumersApi.js +403 -0
- package/dist/generated/api/apis/ConsumersApi.js.map +1 -0
- package/dist/generated/api/apis/ContractsApi.d.ts +81 -0
- package/dist/generated/api/apis/ContractsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/ContractsApi.js +224 -0
- package/dist/generated/api/apis/ContractsApi.js.map +1 -0
- package/dist/generated/api/apis/EnvironmentsApi.d.ts +101 -0
- package/dist/generated/api/apis/EnvironmentsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/EnvironmentsApi.js +266 -0
- package/dist/generated/api/apis/EnvironmentsApi.js.map +1 -0
- package/dist/generated/api/apis/FontsApi.d.ts +58 -0
- package/dist/generated/api/apis/FontsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/FontsApi.js +132 -0
- package/dist/generated/api/apis/FontsApi.js.map +1 -0
- package/dist/generated/api/apis/GenerationApi.d.ts +176 -0
- package/dist/generated/api/apis/GenerationApi.d.ts.map +1 -0
- package/dist/generated/api/apis/GenerationApi.js +501 -0
- package/dist/generated/api/apis/GenerationApi.js.map +1 -0
- package/dist/generated/api/apis/StencilsApi.d.ts +286 -0
- package/dist/generated/api/apis/StencilsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/StencilsApi.js +818 -0
- package/dist/generated/api/apis/StencilsApi.js.map +1 -0
- package/dist/generated/api/apis/SystemApi.d.ts +32 -0
- package/dist/generated/api/apis/SystemApi.d.ts.map +1 -0
- package/dist/generated/api/apis/SystemApi.js +47 -0
- package/dist/generated/api/apis/SystemApi.js.map +1 -0
- package/dist/generated/api/apis/TemplatesApi.d.ts +123 -0
- package/dist/generated/api/apis/TemplatesApi.d.ts.map +1 -0
- package/dist/generated/api/apis/TemplatesApi.js +343 -0
- package/dist/generated/api/apis/TemplatesApi.js.map +1 -0
- package/dist/generated/api/apis/TenantsApi.d.ts +97 -0
- package/dist/generated/api/apis/TenantsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/TenantsApi.js +249 -0
- package/dist/generated/api/apis/TenantsApi.js.map +1 -0
- package/dist/generated/api/apis/ThemesApi.d.ts +107 -0
- package/dist/generated/api/apis/ThemesApi.d.ts.map +1 -0
- package/dist/generated/api/apis/ThemesApi.js +289 -0
- package/dist/generated/api/apis/ThemesApi.js.map +1 -0
- package/dist/generated/api/apis/VariantsApi.d.ts +258 -0
- package/dist/generated/api/apis/VariantsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/VariantsApi.js +796 -0
- package/dist/generated/api/apis/VariantsApi.js.map +1 -0
- package/dist/generated/api/apis/VersionsApi.d.ts +127 -0
- package/dist/generated/api/apis/VersionsApi.d.ts.map +1 -0
- package/dist/generated/api/apis/VersionsApi.js +342 -0
- package/dist/generated/api/apis/VersionsApi.js.map +1 -0
- package/dist/generated/api/apis/index.d.ts +17 -0
- package/dist/generated/api/apis/index.d.ts.map +1 -0
- package/dist/generated/api/apis/index.js +19 -0
- package/dist/generated/api/apis/index.js.map +1 -0
- package/dist/generated/api/index.d.ts +4 -0
- package/dist/generated/api/index.d.ts.map +1 -0
- package/dist/generated/api/index.js +6 -0
- package/dist/generated/api/index.js.map +1 -0
- package/dist/generated/api/models/ActivationDto.d.ts +51 -0
- package/dist/generated/api/models/ActivationDto.d.ts.map +1 -0
- package/dist/generated/api/models/ActivationDto.js +57 -0
- package/dist/generated/api/models/ActivationDto.js.map +1 -0
- package/dist/generated/api/models/ActivationListResponse.d.ts +34 -0
- package/dist/generated/api/models/ActivationListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ActivationListResponse.js +46 -0
- package/dist/generated/api/models/ActivationListResponse.js.map +1 -0
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts +51 -0
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts.map +1 -0
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js +57 -0
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js.map +1 -0
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts +58 -0
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js +54 -0
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js.map +1 -0
- package/dist/generated/api/models/ApproveConsumerRequest.d.ts +43 -0
- package/dist/generated/api/models/ApproveConsumerRequest.d.ts.map +1 -0
- package/dist/generated/api/models/ApproveConsumerRequest.js +48 -0
- package/dist/generated/api/models/ApproveConsumerRequest.js.map +1 -0
- package/dist/generated/api/models/AssetDto.d.ts +116 -0
- package/dist/generated/api/models/AssetDto.d.ts.map +1 -0
- package/dist/generated/api/models/AssetDto.js +100 -0
- package/dist/generated/api/models/AssetDto.js.map +1 -0
- package/dist/generated/api/models/AssetListResponse.d.ts +41 -0
- package/dist/generated/api/models/AssetListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/AssetListResponse.js +51 -0
- package/dist/generated/api/models/AssetListResponse.js.map +1 -0
- package/dist/generated/api/models/AttributeDto.d.ts +117 -0
- package/dist/generated/api/models/AttributeDto.d.ts.map +1 -0
- package/dist/generated/api/models/AttributeDto.js +89 -0
- package/dist/generated/api/models/AttributeDto.js.map +1 -0
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts +42 -0
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts.map +1 -0
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js +49 -0
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js.map +1 -0
- package/dist/generated/api/models/AttributeListResponse.d.ts +41 -0
- package/dist/generated/api/models/AttributeListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/AttributeListResponse.js +51 -0
- package/dist/generated/api/models/AttributeListResponse.js.map +1 -0
- package/dist/generated/api/models/BatchGenerationItem.d.ts +92 -0
- package/dist/generated/api/models/BatchGenerationItem.d.ts.map +1 -0
- package/dist/generated/api/models/BatchGenerationItem.js +68 -0
- package/dist/generated/api/models/BatchGenerationItem.js.map +1 -0
- package/dist/generated/api/models/BlockStylePreset.d.ts +45 -0
- package/dist/generated/api/models/BlockStylePreset.d.ts.map +1 -0
- package/dist/generated/api/models/BlockStylePreset.js +51 -0
- package/dist/generated/api/models/BlockStylePreset.js.map +1 -0
- package/dist/generated/api/models/CatalogDto.d.ts +71 -0
- package/dist/generated/api/models/CatalogDto.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDto.js +66 -0
- package/dist/generated/api/models/CatalogDto.js.map +1 -0
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts +61 -0
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogInstallResultDto.js +64 -0
- package/dist/generated/api/models/CatalogInstallResultDto.js.map +1 -0
- package/dist/generated/api/models/CatalogListResponse.d.ts +41 -0
- package/dist/generated/api/models/CatalogListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogListResponse.js +51 -0
- package/dist/generated/api/models/CatalogListResponse.js.map +1 -0
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts +87 -0
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogUpgradeDiff.js +79 -0
- package/dist/generated/api/models/CatalogUpgradeDiff.js.map +1 -0
- package/dist/generated/api/models/CodeListDto.d.ts +146 -0
- package/dist/generated/api/models/CodeListDto.d.ts.map +1 -0
- package/dist/generated/api/models/CodeListDto.js +111 -0
- package/dist/generated/api/models/CodeListDto.js.map +1 -0
- package/dist/generated/api/models/CodeListEntriesResponse.d.ts +34 -0
- package/dist/generated/api/models/CodeListEntriesResponse.d.ts.map +1 -0
- package/dist/generated/api/models/CodeListEntriesResponse.js +46 -0
- package/dist/generated/api/models/CodeListEntriesResponse.js.map +1 -0
- package/dist/generated/api/models/CodeListEntryDto.d.ts +57 -0
- package/dist/generated/api/models/CodeListEntryDto.d.ts.map +1 -0
- package/dist/generated/api/models/CodeListEntryDto.js +53 -0
- package/dist/generated/api/models/CodeListEntryDto.js.map +1 -0
- package/dist/generated/api/models/CodeListListResponse.d.ts +41 -0
- package/dist/generated/api/models/CodeListListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/CodeListListResponse.js +51 -0
- package/dist/generated/api/models/CodeListListResponse.js.map +1 -0
- package/dist/generated/api/models/CollectMeta.d.ts +68 -0
- package/dist/generated/api/models/CollectMeta.d.ts.map +1 -0
- package/dist/generated/api/models/CollectMeta.js +62 -0
- package/dist/generated/api/models/CollectMeta.js.map +1 -0
- package/dist/generated/api/models/CollectRequest.d.ts +58 -0
- package/dist/generated/api/models/CollectRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CollectRequest.js +45 -0
- package/dist/generated/api/models/CollectRequest.js.map +1 -0
- package/dist/generated/api/models/ConsumerDto.d.ts +189 -0
- package/dist/generated/api/models/ConsumerDto.d.ts.map +1 -0
- package/dist/generated/api/models/ConsumerDto.js +113 -0
- package/dist/generated/api/models/ConsumerDto.js.map +1 -0
- package/dist/generated/api/models/ConsumerListResponse.d.ts +41 -0
- package/dist/generated/api/models/ConsumerListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ConsumerListResponse.js +51 -0
- package/dist/generated/api/models/ConsumerListResponse.js.map +1 -0
- package/dist/generated/api/models/ConsumerNodeDto.d.ts +54 -0
- package/dist/generated/api/models/ConsumerNodeDto.d.ts.map +1 -0
- package/dist/generated/api/models/ConsumerNodeDto.js +53 -0
- package/dist/generated/api/models/ConsumerNodeDto.js.map +1 -0
- package/dist/generated/api/models/ConsumerPermissions.d.ts +183 -0
- package/dist/generated/api/models/ConsumerPermissions.d.ts.map +1 -0
- package/dist/generated/api/models/ConsumerPermissions.js +132 -0
- package/dist/generated/api/models/ConsumerPermissions.js.map +1 -0
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts +56 -0
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts.map +1 -0
- package/dist/generated/api/models/ContractBreakingChangeDto.js +63 -0
- package/dist/generated/api/models/ContractBreakingChangeDto.js.map +1 -0
- package/dist/generated/api/models/ContractVersionListResponse.d.ts +34 -0
- package/dist/generated/api/models/ContractVersionListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ContractVersionListResponse.js +46 -0
- package/dist/generated/api/models/ContractVersionListResponse.js.map +1 -0
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts +59 -0
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts.map +1 -0
- package/dist/generated/api/models/ContractVersionSummaryDto.js +62 -0
- package/dist/generated/api/models/ContractVersionSummaryDto.js.map +1 -0
- package/dist/generated/api/models/CreateAttributeRequest.d.ts +65 -0
- package/dist/generated/api/models/CreateAttributeRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateAttributeRequest.js +56 -0
- package/dist/generated/api/models/CreateAttributeRequest.js.map +1 -0
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts +39 -0
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts.map +1 -0
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js +49 -0
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js.map +1 -0
- package/dist/generated/api/models/CreateCodeListRequest.d.ts +103 -0
- package/dist/generated/api/models/CreateCodeListRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateCodeListRequest.js +79 -0
- package/dist/generated/api/models/CreateCodeListRequest.js.map +1 -0
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts +46 -0
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts.map +1 -0
- package/dist/generated/api/models/CreateContractDraftResponse.js +55 -0
- package/dist/generated/api/models/CreateContractDraftResponse.js.map +1 -0
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts +39 -0
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateEnvironmentRequest.js +49 -0
- package/dist/generated/api/models/CreateEnvironmentRequest.js.map +1 -0
- package/dist/generated/api/models/CreateStencilRequest.d.ts +69 -0
- package/dist/generated/api/models/CreateStencilRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateStencilRequest.js +58 -0
- package/dist/generated/api/models/CreateStencilRequest.js.map +1 -0
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts +45 -0
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateStencilVersionRequest.js +46 -0
- package/dist/generated/api/models/CreateStencilVersionRequest.js.map +1 -0
- package/dist/generated/api/models/CreateTemplateRequest.d.ts +45 -0
- package/dist/generated/api/models/CreateTemplateRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateTemplateRequest.js +51 -0
- package/dist/generated/api/models/CreateTemplateRequest.js.map +1 -0
- package/dist/generated/api/models/CreateTenantRequest.d.ts +43 -0
- package/dist/generated/api/models/CreateTenantRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateTenantRequest.js +49 -0
- package/dist/generated/api/models/CreateTenantRequest.js.map +1 -0
- package/dist/generated/api/models/CreateThemeRequest.d.ts +73 -0
- package/dist/generated/api/models/CreateThemeRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateThemeRequest.js +61 -0
- package/dist/generated/api/models/CreateThemeRequest.js.map +1 -0
- package/dist/generated/api/models/CreateVariantRequest.d.ts +53 -0
- package/dist/generated/api/models/CreateVariantRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateVariantRequest.js +53 -0
- package/dist/generated/api/models/CreateVariantRequest.js.map +1 -0
- package/dist/generated/api/models/DataExampleDto.d.ts +45 -0
- package/dist/generated/api/models/DataExampleDto.d.ts.map +1 -0
- package/dist/generated/api/models/DataExampleDto.js +53 -0
- package/dist/generated/api/models/DataExampleDto.js.map +1 -0
- package/dist/generated/api/models/DataModelValidationError.d.ts +39 -0
- package/dist/generated/api/models/DataModelValidationError.d.ts.map +1 -0
- package/dist/generated/api/models/DataModelValidationError.js +49 -0
- package/dist/generated/api/models/DataModelValidationError.js.map +1 -0
- package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts +70 -0
- package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/DataModelValidationProblemDetail.js +60 -0
- package/dist/generated/api/models/DataModelValidationProblemDetail.js.map +1 -0
- package/dist/generated/api/models/DocumentDto.d.ts +93 -0
- package/dist/generated/api/models/DocumentDto.d.ts.map +1 -0
- package/dist/generated/api/models/DocumentDto.js +81 -0
- package/dist/generated/api/models/DocumentDto.js.map +1 -0
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts +121 -0
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts.map +1 -0
- package/dist/generated/api/models/DocumentGenerationItemDto.js +90 -0
- package/dist/generated/api/models/DocumentGenerationItemDto.js.map +1 -0
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts +112 -0
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts.map +1 -0
- package/dist/generated/api/models/DocumentGenerationJobDto.js +94 -0
- package/dist/generated/api/models/DocumentGenerationJobDto.js.map +1 -0
- package/dist/generated/api/models/DocumentListResponse.d.ts +41 -0
- package/dist/generated/api/models/DocumentListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/DocumentListResponse.js +51 -0
- package/dist/generated/api/models/DocumentListResponse.js.map +1 -0
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts +39 -0
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts.map +1 -0
- package/dist/generated/api/models/DroppedStencilFillDto.js +49 -0
- package/dist/generated/api/models/DroppedStencilFillDto.js.map +1 -0
- package/dist/generated/api/models/EnvironmentDto.d.ts +51 -0
- package/dist/generated/api/models/EnvironmentDto.d.ts.map +1 -0
- package/dist/generated/api/models/EnvironmentDto.js +57 -0
- package/dist/generated/api/models/EnvironmentDto.js.map +1 -0
- package/dist/generated/api/models/EnvironmentListResponse.d.ts +41 -0
- package/dist/generated/api/models/EnvironmentListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/EnvironmentListResponse.js +51 -0
- package/dist/generated/api/models/EnvironmentListResponse.js.map +1 -0
- package/dist/generated/api/models/FontDto.d.ts +112 -0
- package/dist/generated/api/models/FontDto.d.ts.map +1 -0
- package/dist/generated/api/models/FontDto.js +95 -0
- package/dist/generated/api/models/FontDto.js.map +1 -0
- package/dist/generated/api/models/FontListResponse.d.ts +41 -0
- package/dist/generated/api/models/FontListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/FontListResponse.js +51 -0
- package/dist/generated/api/models/FontListResponse.js.map +1 -0
- package/dist/generated/api/models/FontVariantDto.d.ts +39 -0
- package/dist/generated/api/models/FontVariantDto.d.ts.map +1 -0
- package/dist/generated/api/models/FontVariantDto.js +49 -0
- package/dist/generated/api/models/FontVariantDto.js.map +1 -0
- package/dist/generated/api/models/GenerateBatchRequest.d.ts +49 -0
- package/dist/generated/api/models/GenerateBatchRequest.d.ts.map +1 -0
- package/dist/generated/api/models/GenerateBatchRequest.js +48 -0
- package/dist/generated/api/models/GenerateBatchRequest.js.map +1 -0
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts +100 -0
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts.map +1 -0
- package/dist/generated/api/models/GenerateDocumentRequest.js +68 -0
- package/dist/generated/api/models/GenerateDocumentRequest.js.map +1 -0
- package/dist/generated/api/models/GenerationJobDetail.d.ts +41 -0
- package/dist/generated/api/models/GenerationJobDetail.d.ts.map +1 -0
- package/dist/generated/api/models/GenerationJobDetail.js +51 -0
- package/dist/generated/api/models/GenerationJobDetail.js.map +1 -0
- package/dist/generated/api/models/GenerationJobListResponse.d.ts +41 -0
- package/dist/generated/api/models/GenerationJobListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/GenerationJobListResponse.js +51 -0
- package/dist/generated/api/models/GenerationJobListResponse.js.map +1 -0
- package/dist/generated/api/models/GenerationJobResponse.d.ts +76 -0
- package/dist/generated/api/models/GenerationJobResponse.d.ts.map +1 -0
- package/dist/generated/api/models/GenerationJobResponse.js +78 -0
- package/dist/generated/api/models/GenerationJobResponse.js.map +1 -0
- package/dist/generated/api/models/GenerationResult.d.ts +131 -0
- package/dist/generated/api/models/GenerationResult.d.ts.map +1 -0
- package/dist/generated/api/models/GenerationResult.js +88 -0
- package/dist/generated/api/models/GenerationResult.js.map +1 -0
- package/dist/generated/api/models/ImportCatalogResponse.d.ts +76 -0
- package/dist/generated/api/models/ImportCatalogResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ImportCatalogResponse.js +69 -0
- package/dist/generated/api/models/ImportCatalogResponse.js.map +1 -0
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts +72 -0
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts.map +1 -0
- package/dist/generated/api/models/ImportTemplateResultDto.js +66 -0
- package/dist/generated/api/models/ImportTemplateResultDto.js.map +1 -0
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts +45 -0
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts.map +1 -0
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js +53 -0
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js.map +1 -0
- package/dist/generated/api/models/Margins.d.ts +51 -0
- package/dist/generated/api/models/Margins.d.ts.map +1 -0
- package/dist/generated/api/models/Margins.js +49 -0
- package/dist/generated/api/models/Margins.js.map +1 -0
- package/dist/generated/api/models/Node.d.ts +63 -0
- package/dist/generated/api/models/Node.d.ts.map +1 -0
- package/dist/generated/api/models/Node.js +59 -0
- package/dist/generated/api/models/Node.js.map +1 -0
- package/dist/generated/api/models/Orientation.d.ts +26 -0
- package/dist/generated/api/models/Orientation.d.ts.map +1 -0
- package/dist/generated/api/models/Orientation.js +44 -0
- package/dist/generated/api/models/Orientation.js.map +1 -0
- package/dist/generated/api/models/PageFormat.d.ts +27 -0
- package/dist/generated/api/models/PageFormat.d.ts.map +1 -0
- package/dist/generated/api/models/PageFormat.js +45 -0
- package/dist/generated/api/models/PageFormat.js.map +1 -0
- package/dist/generated/api/models/PageMeta.d.ts +51 -0
- package/dist/generated/api/models/PageMeta.d.ts.map +1 -0
- package/dist/generated/api/models/PageMeta.js +57 -0
- package/dist/generated/api/models/PageMeta.js.map +1 -0
- package/dist/generated/api/models/PageSettings.d.ts +54 -0
- package/dist/generated/api/models/PageSettings.d.ts.map +1 -0
- package/dist/generated/api/models/PageSettings.js +52 -0
- package/dist/generated/api/models/PageSettings.js.map +1 -0
- package/dist/generated/api/models/PartitionAssignment.d.ts +90 -0
- package/dist/generated/api/models/PartitionAssignment.d.ts.map +1 -0
- package/dist/generated/api/models/PartitionAssignment.js +59 -0
- package/dist/generated/api/models/PartitionAssignment.js.map +1 -0
- package/dist/generated/api/models/PingRequest.d.ts +58 -0
- package/dist/generated/api/models/PingRequest.d.ts.map +1 -0
- package/dist/generated/api/models/PingRequest.js +47 -0
- package/dist/generated/api/models/PingRequest.js.map +1 -0
- package/dist/generated/api/models/PongDetailsDto.d.ts +60 -0
- package/dist/generated/api/models/PongDetailsDto.d.ts.map +1 -0
- package/dist/generated/api/models/PongDetailsDto.js +54 -0
- package/dist/generated/api/models/PongDetailsDto.js.map +1 -0
- package/dist/generated/api/models/PongResponse.d.ts +63 -0
- package/dist/generated/api/models/PongResponse.d.ts.map +1 -0
- package/dist/generated/api/models/PongResponse.js +59 -0
- package/dist/generated/api/models/PongResponse.js.map +1 -0
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts +79 -0
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts.map +1 -0
- package/dist/generated/api/models/PreviewDocumentRequest.js +62 -0
- package/dist/generated/api/models/PreviewDocumentRequest.js.map +1 -0
- package/dist/generated/api/models/ProblemDetail.d.ts +61 -0
- package/dist/generated/api/models/ProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/ProblemDetail.js +57 -0
- package/dist/generated/api/models/ProblemDetail.js.map +1 -0
- package/dist/generated/api/models/PublishContractRequest.d.ts +33 -0
- package/dist/generated/api/models/PublishContractRequest.d.ts.map +1 -0
- package/dist/generated/api/models/PublishContractRequest.js +43 -0
- package/dist/generated/api/models/PublishContractRequest.js.map +1 -0
- package/dist/generated/api/models/PublishContractResponse.d.ts +53 -0
- package/dist/generated/api/models/PublishContractResponse.d.ts.map +1 -0
- package/dist/generated/api/models/PublishContractResponse.js +55 -0
- package/dist/generated/api/models/PublishContractResponse.js.map +1 -0
- package/dist/generated/api/models/PublishVersionRequest.d.ts +33 -0
- package/dist/generated/api/models/PublishVersionRequest.d.ts.map +1 -0
- package/dist/generated/api/models/PublishVersionRequest.js +45 -0
- package/dist/generated/api/models/PublishVersionRequest.js.map +1 -0
- package/dist/generated/api/models/RegisterConsumerRequest.d.ts +71 -0
- package/dist/generated/api/models/RegisterConsumerRequest.d.ts.map +1 -0
- package/dist/generated/api/models/RegisterConsumerRequest.js +62 -0
- package/dist/generated/api/models/RegisterConsumerRequest.js.map +1 -0
- package/dist/generated/api/models/RejectConsumerRequest.d.ts +33 -0
- package/dist/generated/api/models/RejectConsumerRequest.d.ts.map +1 -0
- package/dist/generated/api/models/RejectConsumerRequest.js +43 -0
- package/dist/generated/api/models/RejectConsumerRequest.js.map +1 -0
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts +39 -0
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseCatalogRequest.js +47 -0
- package/dist/generated/api/models/ReleaseCatalogRequest.js.map +1 -0
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts +57 -0
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseCatalogResponse.js +59 -0
- package/dist/generated/api/models/ReleaseCatalogResponse.js.map +1 -0
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts +39 -0
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts.map +1 -0
- package/dist/generated/api/models/RemovedCatalogResourceDto.js +49 -0
- package/dist/generated/api/models/RemovedCatalogResourceDto.js.map +1 -0
- package/dist/generated/api/models/RotatePublicKeyRequest.d.ts +35 -0
- package/dist/generated/api/models/RotatePublicKeyRequest.d.ts.map +1 -0
- package/dist/generated/api/models/RotatePublicKeyRequest.js +45 -0
- package/dist/generated/api/models/RotatePublicKeyRequest.js.map +1 -0
- package/dist/generated/api/models/Slot.d.ts +51 -0
- package/dist/generated/api/models/Slot.d.ts.map +1 -0
- package/dist/generated/api/models/Slot.js +57 -0
- package/dist/generated/api/models/Slot.js.map +1 -0
- package/dist/generated/api/models/StencilDto.d.ts +79 -0
- package/dist/generated/api/models/StencilDto.d.ts.map +1 -0
- package/dist/generated/api/models/StencilDto.js +70 -0
- package/dist/generated/api/models/StencilDto.js.map +1 -0
- package/dist/generated/api/models/StencilListResponse.d.ts +41 -0
- package/dist/generated/api/models/StencilListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/StencilListResponse.js +51 -0
- package/dist/generated/api/models/StencilListResponse.js.map +1 -0
- package/dist/generated/api/models/StencilSummaryDto.d.ts +75 -0
- package/dist/generated/api/models/StencilSummaryDto.d.ts.map +1 -0
- package/dist/generated/api/models/StencilSummaryDto.js +69 -0
- package/dist/generated/api/models/StencilSummaryDto.js.map +1 -0
- package/dist/generated/api/models/StencilUsageDto.d.ts +57 -0
- package/dist/generated/api/models/StencilUsageDto.d.ts.map +1 -0
- package/dist/generated/api/models/StencilUsageDto.js +61 -0
- package/dist/generated/api/models/StencilUsageDto.js.map +1 -0
- package/dist/generated/api/models/StencilUsageListResponse.d.ts +41 -0
- package/dist/generated/api/models/StencilUsageListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/StencilUsageListResponse.js +51 -0
- package/dist/generated/api/models/StencilUsageListResponse.js.map +1 -0
- package/dist/generated/api/models/StencilVersionDto.d.ts +95 -0
- package/dist/generated/api/models/StencilVersionDto.d.ts.map +1 -0
- package/dist/generated/api/models/StencilVersionDto.js +74 -0
- package/dist/generated/api/models/StencilVersionDto.js.map +1 -0
- package/dist/generated/api/models/StencilVersionListResponse.d.ts +41 -0
- package/dist/generated/api/models/StencilVersionListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/StencilVersionListResponse.js +51 -0
- package/dist/generated/api/models/StencilVersionListResponse.js.map +1 -0
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts +66 -0
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts.map +1 -0
- package/dist/generated/api/models/StencilVersionSummaryDto.js +65 -0
- package/dist/generated/api/models/StencilVersionSummaryDto.js.map +1 -0
- package/dist/generated/api/models/TemplateDataValidationError.d.ts +45 -0
- package/dist/generated/api/models/TemplateDataValidationError.d.ts.map +1 -0
- package/dist/generated/api/models/TemplateDataValidationError.js +51 -0
- package/dist/generated/api/models/TemplateDataValidationError.js.map +1 -0
- package/dist/generated/api/models/TemplateDataValidationResult.d.ts +40 -0
- package/dist/generated/api/models/TemplateDataValidationResult.d.ts.map +1 -0
- package/dist/generated/api/models/TemplateDataValidationResult.js +48 -0
- package/dist/generated/api/models/TemplateDataValidationResult.js.map +1 -0
- package/dist/generated/api/models/TemplateDocument.d.ts +84 -0
- package/dist/generated/api/models/TemplateDocument.d.ts.map +1 -0
- package/dist/generated/api/models/TemplateDocument.js +75 -0
- package/dist/generated/api/models/TemplateDocument.js.map +1 -0
- package/dist/generated/api/models/TemplateDto.d.ts +83 -0
- package/dist/generated/api/models/TemplateDto.d.ts.map +1 -0
- package/dist/generated/api/models/TemplateDto.js +73 -0
- package/dist/generated/api/models/TemplateDto.js.map +1 -0
- package/dist/generated/api/models/TemplateListResponse.d.ts +41 -0
- package/dist/generated/api/models/TemplateListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/TemplateListResponse.js +51 -0
- package/dist/generated/api/models/TemplateListResponse.js.map +1 -0
- package/dist/generated/api/models/TemplateSummaryDto.d.ts +57 -0
- package/dist/generated/api/models/TemplateSummaryDto.d.ts.map +1 -0
- package/dist/generated/api/models/TemplateSummaryDto.js +61 -0
- package/dist/generated/api/models/TemplateSummaryDto.js.map +1 -0
- package/dist/generated/api/models/TenantDto.d.ts +45 -0
- package/dist/generated/api/models/TenantDto.d.ts.map +1 -0
- package/dist/generated/api/models/TenantDto.js +53 -0
- package/dist/generated/api/models/TenantDto.js.map +1 -0
- package/dist/generated/api/models/TenantListResponse.d.ts +41 -0
- package/dist/generated/api/models/TenantListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/TenantListResponse.js +51 -0
- package/dist/generated/api/models/TenantListResponse.js.map +1 -0
- package/dist/generated/api/models/ThemeDto.d.ts +94 -0
- package/dist/generated/api/models/ThemeDto.d.ts.map +1 -0
- package/dist/generated/api/models/ThemeDto.js +75 -0
- package/dist/generated/api/models/ThemeDto.js.map +1 -0
- package/dist/generated/api/models/ThemeListResponse.d.ts +41 -0
- package/dist/generated/api/models/ThemeListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ThemeListResponse.js +51 -0
- package/dist/generated/api/models/ThemeListResponse.js.map +1 -0
- package/dist/generated/api/models/ThemeRef.d.ts +53 -0
- package/dist/generated/api/models/ThemeRef.d.ts.map +1 -0
- package/dist/generated/api/models/ThemeRef.js +56 -0
- package/dist/generated/api/models/ThemeRef.js.map +1 -0
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts +56 -0
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateAttributeRequest.js +50 -0
- package/dist/generated/api/models/UpdateAttributeRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts +39 -0
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js +49 -0
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js.map +1 -0
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts +33 -0
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js +45 -0
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts +76 -0
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateCodeListRequest.js +62 -0
- package/dist/generated/api/models/UpdateCodeListRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts +76 -0
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateConsumerRequest.js +61 -0
- package/dist/generated/api/models/UpdateConsumerRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts +48 -0
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateContractDraftRequest.js +48 -0
- package/dist/generated/api/models/UpdateContractDraftRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts +58 -0
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateContractDraftResponse.js +61 -0
- package/dist/generated/api/models/UpdateContractDraftResponse.js.map +1 -0
- package/dist/generated/api/models/UpdateDraftRequest.d.ts +34 -0
- package/dist/generated/api/models/UpdateDraftRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateDraftRequest.js +44 -0
- package/dist/generated/api/models/UpdateDraftRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts +33 -0
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateEnvironmentRequest.js +43 -0
- package/dist/generated/api/models/UpdateEnvironmentRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts +48 -0
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateStencilDraftRequest.js +46 -0
- package/dist/generated/api/models/UpdateStencilDraftRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateStencilRequest.d.ts +45 -0
- package/dist/generated/api/models/UpdateStencilRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateStencilRequest.js +47 -0
- package/dist/generated/api/models/UpdateStencilRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts +60 -0
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateTemplateRequest.js +52 -0
- package/dist/generated/api/models/UpdateTemplateRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateTenantRequest.d.ts +33 -0
- package/dist/generated/api/models/UpdateTenantRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateTenantRequest.js +43 -0
- package/dist/generated/api/models/UpdateTenantRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateThemeRequest.d.ts +67 -0
- package/dist/generated/api/models/UpdateThemeRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateThemeRequest.js +55 -0
- package/dist/generated/api/models/UpdateThemeRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateVariantRequest.d.ts +47 -0
- package/dist/generated/api/models/UpdateVariantRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateVariantRequest.js +49 -0
- package/dist/generated/api/models/UpdateVariantRequest.js.map +1 -0
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts +33 -0
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpgradeCatalogRequest.js +43 -0
- package/dist/generated/api/models/UpgradeCatalogRequest.js.map +1 -0
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts +59 -0
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts.map +1 -0
- package/dist/generated/api/models/UpgradeCatalogResponse.js +61 -0
- package/dist/generated/api/models/UpgradeCatalogResponse.js.map +1 -0
- package/dist/generated/api/models/UpgradePreviewDto.d.ts +70 -0
- package/dist/generated/api/models/UpgradePreviewDto.d.ts.map +1 -0
- package/dist/generated/api/models/UpgradePreviewDto.js +70 -0
- package/dist/generated/api/models/UpgradePreviewDto.js.map +1 -0
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts +34 -0
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/UpgradePreviewListResponse.js +46 -0
- package/dist/generated/api/models/UpgradePreviewListResponse.js.map +1 -0
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts +33 -0
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts.map +1 -0
- package/dist/generated/api/models/ValidateTemplateDataRequest.js +45 -0
- package/dist/generated/api/models/ValidateTemplateDataRequest.js.map +1 -0
- package/dist/generated/api/models/ValidationError.d.ts +45 -0
- package/dist/generated/api/models/ValidationError.d.ts.map +1 -0
- package/dist/generated/api/models/ValidationError.js +51 -0
- package/dist/generated/api/models/ValidationError.js.map +1 -0
- package/dist/generated/api/models/ValidationProblemDetail.d.ts +68 -0
- package/dist/generated/api/models/ValidationProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/ValidationProblemDetail.js +60 -0
- package/dist/generated/api/models/ValidationProblemDetail.js.map +1 -0
- package/dist/generated/api/models/VariantDto.d.ts +89 -0
- package/dist/generated/api/models/VariantDto.d.ts.map +1 -0
- package/dist/generated/api/models/VariantDto.js +79 -0
- package/dist/generated/api/models/VariantDto.js.map +1 -0
- package/dist/generated/api/models/VariantListResponse.d.ts +41 -0
- package/dist/generated/api/models/VariantListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/VariantListResponse.js +51 -0
- package/dist/generated/api/models/VariantListResponse.js.map +1 -0
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts +64 -0
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts.map +1 -0
- package/dist/generated/api/models/VariantSelectionAttribute.js +53 -0
- package/dist/generated/api/models/VariantSelectionAttribute.js.map +1 -0
- package/dist/generated/api/models/VariantSummaryDto.d.ts +65 -0
- package/dist/generated/api/models/VariantSummaryDto.d.ts.map +1 -0
- package/dist/generated/api/models/VariantSummaryDto.js +65 -0
- package/dist/generated/api/models/VariantSummaryDto.js.map +1 -0
- package/dist/generated/api/models/VersionDto.d.ts +79 -0
- package/dist/generated/api/models/VersionDto.d.ts.map +1 -0
- package/dist/generated/api/models/VersionDto.js +72 -0
- package/dist/generated/api/models/VersionDto.js.map +1 -0
- package/dist/generated/api/models/VersionListResponse.d.ts +41 -0
- package/dist/generated/api/models/VersionListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/VersionListResponse.js +51 -0
- package/dist/generated/api/models/VersionListResponse.js.map +1 -0
- package/dist/generated/api/models/VersionSummaryDto.d.ts +72 -0
- package/dist/generated/api/models/VersionSummaryDto.d.ts.map +1 -0
- package/dist/generated/api/models/VersionSummaryDto.js +69 -0
- package/dist/generated/api/models/VersionSummaryDto.js.map +1 -0
- package/dist/generated/api/models/index.d.ts +133 -0
- package/dist/generated/api/models/index.d.ts.map +1 -0
- package/dist/generated/api/models/index.js +135 -0
- package/dist/generated/api/models/index.js.map +1 -0
- package/dist/generated/api/runtime.d.ts +185 -0
- package/dist/generated/api/runtime.d.ts.map +1 -0
- package/dist/generated/api/runtime.js +334 -0
- package/dist/generated/api/runtime.js.map +1 -0
- package/dist/generated/contractIdentity.d.ts +17 -0
- package/dist/generated/contractIdentity.d.ts.map +1 -0
- package/dist/generated/contractIdentity.js +18 -0
- package/dist/generated/contractIdentity.js.map +1 -0
- package/dist/generated/contractMediaTypes.d.ts +14 -0
- package/dist/generated/contractMediaTypes.d.ts.map +1 -0
- package/dist/generated/contractMediaTypes.js +15 -0
- package/dist/generated/contractMediaTypes.js.map +1 -0
- package/dist/generated/contractOperations.d.ts +26 -0
- package/dist/generated/contractOperations.d.ts.map +1 -0
- package/dist/generated/contractOperations.js +111 -0
- package/dist/generated/contractOperations.js.map +1 -0
- package/dist/generated/contractVersion.d.ts +3 -0
- package/dist/generated/contractVersion.d.ts.map +1 -0
- package/dist/generated/contractVersion.js +4 -0
- package/dist/generated/contractVersion.js.map +1 -0
- package/dist/generated/index.d.ts +7 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/index.js +8 -0
- package/dist/generated/index.js.map +1 -0
- package/dist/generated/knownProblemSlugs.d.ts +47 -0
- package/dist/generated/knownProblemSlugs.d.ts.map +1 -0
- package/dist/generated/knownProblemSlugs.js +46 -0
- package/dist/generated/knownProblemSlugs.js.map +1 -0
- package/dist/generated/modelValidation.d.ts +166 -0
- package/dist/generated/modelValidation.d.ts.map +1 -0
- package/dist/generated/modelValidation.js +634 -0
- package/dist/generated/modelValidation.js.map +1 -0
- package/dist/http/epistolaClient.d.ts +97 -0
- package/dist/http/epistolaClient.d.ts.map +1 -0
- package/dist/http/epistolaClient.js +196 -0
- package/dist/http/epistolaClient.js.map +1 -0
- package/dist/http/middleware.d.ts +36 -0
- package/dist/http/middleware.d.ts.map +1 -0
- package/dist/http/middleware.js +72 -0
- package/dist/http/middleware.js.map +1 -0
- package/dist/http/operations.d.ts +15 -0
- package/dist/http/operations.d.ts.map +1 -0
- package/dist/http/operations.js +46 -0
- package/dist/http/operations.js.map +1 -0
- package/dist/identity/clientIdentity.d.ts +55 -0
- package/dist/identity/clientIdentity.d.ts.map +1 -0
- package/dist/identity/clientIdentity.js +105 -0
- package/dist/identity/clientIdentity.js.map +1 -0
- package/dist/index.d.ts +38 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +44 -0
- package/dist/index.js.map +1 -0
- package/dist/protocol/compression.d.ts +28 -0
- package/dist/protocol/compression.d.ts.map +1 -0
- package/dist/protocol/compression.js +113 -0
- package/dist/protocol/compression.js.map +1 -0
- package/dist/protocol/murmur3.d.ts +17 -0
- package/dist/protocol/murmur3.d.ts.map +1 -0
- package/dist/protocol/murmur3.js +61 -0
- package/dist/protocol/murmur3.js.map +1 -0
- package/dist/protocol/ndjson.d.ts +7 -0
- package/dist/protocol/ndjson.d.ts.map +1 -0
- package/dist/protocol/ndjson.js +29 -0
- package/dist/protocol/ndjson.js.map +1 -0
- package/dist/protocol/partitionRouting.d.ts +51 -0
- package/dist/protocol/partitionRouting.d.ts.map +1 -0
- package/dist/protocol/partitionRouting.js +80 -0
- package/dist/protocol/partitionRouting.js.map +1 -0
- package/dist/protocol/pollBackoff.d.ts +48 -0
- package/dist/protocol/pollBackoff.d.ts.map +1 -0
- package/dist/protocol/pollBackoff.js +77 -0
- package/dist/protocol/pollBackoff.js.map +1 -0
- package/dist/validation/modelValidationException.d.ts +25 -0
- package/dist/validation/modelValidationException.d.ts.map +1 -0
- package/dist/validation/modelValidationException.js +23 -0
- package/dist/validation/modelValidationException.js.map +1 -0
- package/dist/validation/templateSchemaValidator.d.ts +108 -0
- package/dist/validation/templateSchemaValidator.d.ts.map +1 -0
- package/dist/validation/templateSchemaValidator.js +173 -0
- package/dist/validation/templateSchemaValidator.js.map +1 -0
- package/package.json +59 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Changelog — Epistola Node.js Client
|
|
2
|
+
|
|
3
|
+
All notable changes to the `@epistola.app/epistola-client` npm package are documented here.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). This package's
|
|
6
|
+
version tracks the Epistola contract version (`info.version` in the OpenAPI spec), so it releases in
|
|
7
|
+
lockstep with the other generated artifacts; the repository-level [CHANGELOG](../../../../CHANGELOG.md)
|
|
8
|
+
records contract/spec changes. This file records changes specific to the Node.js client library.
|
|
9
|
+
|
|
10
|
+
## [Unreleased]
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- **Initial release** — a Node.js client for the Epistola API, generated from the OpenAPI contract
|
|
15
|
+
with OpenAPI Generator (`typescript-fetch`, on the platform's own `fetch`), at feature parity with
|
|
16
|
+
the Kotlin, Jakarta EE, .NET and Python clients.
|
|
17
|
+
- `EpistolaClient` — one entry point that assembles identity, API-key or self-signed-JWT
|
|
18
|
+
authentication, the `Accept` header each operation is declared with, and RFC 9457 problem
|
|
19
|
+
parsing into the `Configuration` every generated API class takes. Problem parsing is not opt-in:
|
|
20
|
+
forgetting it fails silently, so it is always installed.
|
|
21
|
+
- `ClientIdentity` — mandatory `User-Agent` / `X-EP-Node-Id` headers, built via a fluent builder.
|
|
22
|
+
The header name and the `User-Agent` grammar are generated from the spec's `x-client-identity`
|
|
23
|
+
extension, as the JVM modules do.
|
|
24
|
+
- `JwtSigner` — self-signed RS256 / ES256 JWT bearer authentication on `node:crypto` alone, minting
|
|
25
|
+
a fresh short-lived token per request. ES256 signatures are emitted in the raw `R || S` form JOSE
|
|
26
|
+
requires rather than Node's default DER sequence.
|
|
27
|
+
- `ProblemDetailException` — RFC 9457 problem-detail error handling, extending the generated
|
|
28
|
+
`ResponseError`, with `typeSlug`, the `errors` / `validationErrors` extension members, and a
|
|
29
|
+
catch-all `extensions` map for members the contract adds later. `KnownProblemSlugs` and the
|
|
30
|
+
extension-member names are generated from the spec's `x-problem-types` registry.
|
|
31
|
+
- `ResultCollector` — NDJSON result streaming with constant memory, gzip and (where Node's zlib has
|
|
32
|
+
it) zstd decompression chosen by sniffing the stream rather than trusting `Content-Encoding`,
|
|
33
|
+
adaptive polling floored at the minimum interval, sequence-based acknowledgement that leaves a
|
|
34
|
+
batch unacknowledged when the handler throws, and murmur3 partition-routing helpers.
|
|
35
|
+
- Client-side JSON Schema validation of template data (`TemplateSchemaValidator`,
|
|
36
|
+
`ValidatingGenerationApi`, on Ajv) and generated `validateModel` / `validate<Model>` helpers
|
|
37
|
+
covering every model that carries schema constraints.
|
|
38
|
+
- `CONTRACT_OPERATIONS` — the method, path template and declared response media types of every
|
|
39
|
+
operation, generated from the spec. The generated API classes set `Content-Type` but never
|
|
40
|
+
`Accept`, and Node's `fetch` sends `*/*` by default, so the client asks for exactly what each
|
|
41
|
+
operation is declared to return — the problem document included.
|
|
42
|
+
- A problem-registry guard test keeping the hand-written problem-type base in sync with the value
|
|
43
|
+
the build-time generator derives from the spec, and a driver for the cross-client conformance
|
|
44
|
+
suite, which holds this client to the same wire behaviour as the other four.
|
package/README.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# Epistola Node.js Client
|
|
2
|
+
|
|
3
|
+
Node.js client library for the [Epistola](https://github.com/epistola-app/epistola-contract)
|
|
4
|
+
document generation API, generated from the Epistola OpenAPI contract with
|
|
5
|
+
[OpenAPI Generator](https://openapi-generator.tech) (`typescript-fetch`, on the platform's own
|
|
6
|
+
`fetch`) and hand-written glue for identity, authentication, error handling, result collection, and
|
|
7
|
+
client-side validation. TypeScript declarations are included.
|
|
8
|
+
|
|
9
|
+
It adds, on top of the stock generated client:
|
|
10
|
+
|
|
11
|
+
- **Client identity** headers (`User-Agent` + `X-EP-Node-Id`) required on every request.
|
|
12
|
+
- **RFC 9457 problem-detail** error handling — a typed `ProblemDetailException` with a `typeSlug`
|
|
13
|
+
discriminator and generated `KnownProblemSlugs` constants.
|
|
14
|
+
- **Self-signed JWT** authentication (`JwtSigner`), minting a fresh short-lived token per request on
|
|
15
|
+
`node:crypto` alone.
|
|
16
|
+
- **Static API-key** authentication via `Authorization: ApiKey <key>`.
|
|
17
|
+
- **The `Accept` header each operation is declared with.** The generated classes never set one, and
|
|
18
|
+
Node's `fetch` sends `*/*` by default — so without this a request never says it accepts
|
|
19
|
+
`application/problem+json`, the document every error handler here is built to parse.
|
|
20
|
+
- **NDJSON result collection** (`ResultCollector`) with adaptive polling, compression, and
|
|
21
|
+
partition-aware routing helpers.
|
|
22
|
+
- **Client-side JSON Schema validation** of template data (`TemplateSchemaValidator`) and
|
|
23
|
+
generated `validate<Model>` helpers for the contract's own constraints.
|
|
24
|
+
|
|
25
|
+
The package version tracks the Epistola contract version (`info.version`) and releases in lockstep
|
|
26
|
+
with the Kotlin, Jakarta EE, .NET and Python clients. It needs Node.js 22.12 or later and ships as
|
|
27
|
+
an ES module (which Node's `require()` can load as well).
|
|
28
|
+
|
|
29
|
+
Release history: [CHANGELOG.md](CHANGELOG.md).
|
|
30
|
+
|
|
31
|
+
## Install
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm install @epistola.app/epistola-client
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Quick start
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
import { ClientIdentity, EpistolaClient, JwtSigner, TemplatesApi } from '@epistola.app/epistola-client'
|
|
41
|
+
|
|
42
|
+
const identity = ClientIdentity.builder()
|
|
43
|
+
.nodeId('my-pod-123') // defaults to the hostname
|
|
44
|
+
.product('my-app', '1.0.0') // appended to User-Agent
|
|
45
|
+
.build()
|
|
46
|
+
|
|
47
|
+
const signer = JwtSigner.builder()
|
|
48
|
+
.consumerId('invoice-service')
|
|
49
|
+
.privateKey(JwtSigner.loadPrivateKey('private.pem'))
|
|
50
|
+
.build()
|
|
51
|
+
|
|
52
|
+
const client = EpistolaClient.builder('https://epistola.example.com/api')
|
|
53
|
+
.identity(identity) // User-Agent + X-EP-Node-Id
|
|
54
|
+
.jwtSigner(signer) // Authorization: Bearer <jwt>, fresh per request
|
|
55
|
+
.build()
|
|
56
|
+
|
|
57
|
+
const templates = new TemplatesApi(client)
|
|
58
|
+
const template = await templates.getTemplate({ tenantId: 'acme', catalogId: 'invoices', templateId: 'invoice' })
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
For static tenant API keys, use `.apiKey('epk_...')` instead of `.jwtSigner(...)`, or the shorthand
|
|
62
|
+
`EpistolaClient.builder(baseUrl, apiKey)`. The legacy `X-API-Key` header is not sent: it remains
|
|
63
|
+
supported server-side but is deprecated. Some Epistola Suite deployments disable API-key
|
|
64
|
+
authentication entirely; switch on `e.typeSlug === KnownProblemSlugs.API_KEY_AUTH_DISABLED` and
|
|
65
|
+
guide the caller to JWT auth.
|
|
66
|
+
|
|
67
|
+
`EpistolaClient` *is* a generated `Configuration`, so every generated API class takes it directly.
|
|
68
|
+
One builder can produce more than one client: call `build()` again after changing
|
|
69
|
+
`requestTimeoutMs(...)` for the two profiles a long-running consumer typically needs against the
|
|
70
|
+
same backend — no timeout (the default) for polling, rendering and large transfers, a bounded one
|
|
71
|
+
for everything else.
|
|
72
|
+
|
|
73
|
+
### Partial updates
|
|
74
|
+
|
|
75
|
+
The generated models are plain TypeScript interfaces, and the generated serializers drop a property
|
|
76
|
+
you never set while sending one you set to `null` as `null`. On the API's `PATCH` operations, where
|
|
77
|
+
the contract documents `null` as "clear this", that is exactly the distinction that matters:
|
|
78
|
+
`updateConsumer({ ..., updateConsumerRequest: { name: 'Billing' } })` renames the consumer and
|
|
79
|
+
touches nothing else; `{ name: 'Billing', description: null }` also clears the description.
|
|
80
|
+
|
|
81
|
+
### Binary downloads
|
|
82
|
+
|
|
83
|
+
Every operation the contract declares as `format: binary` — `downloadDocument`, `previewDocument`,
|
|
84
|
+
asset content — resolves to a `Blob`; `Buffer.from(await blob.arrayBuffer())` gives you the bytes.
|
|
85
|
+
|
|
86
|
+
## Error handling
|
|
87
|
+
|
|
88
|
+
Catch `ProblemDetailException` and switch on `typeSlug` against `KnownProblemSlugs`. The slug list is
|
|
89
|
+
**open** — the API can introduce new problem types without a client release — so always keep a
|
|
90
|
+
`default` branch and fall back to the HTTP status for unrecognized types.
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
import { KnownProblemSlugs, ProblemDetailException, ResponseError, TenantsApi } from '@epistola.app/epistola-client'
|
|
94
|
+
|
|
95
|
+
try {
|
|
96
|
+
await new TenantsApi(client).getTenant({ tenantId: 'acme' })
|
|
97
|
+
} catch (e) {
|
|
98
|
+
if (e instanceof ProblemDetailException) {
|
|
99
|
+
switch (e.typeSlug) {
|
|
100
|
+
case KnownProblemSlugs.NOT_FOUND:
|
|
101
|
+
log.warn(`tenant not found: ${e.detail}`)
|
|
102
|
+
break
|
|
103
|
+
case KnownProblemSlugs.FORBIDDEN:
|
|
104
|
+
throw new PermissionError(e.detail)
|
|
105
|
+
case KnownProblemSlugs.VALIDATION_ERROR:
|
|
106
|
+
for (const err of e.errors) log.warn(`${err.field}: ${err.message}`) // field-level ValidationProblemDetail
|
|
107
|
+
break
|
|
108
|
+
case KnownProblemSlugs.DATA_MODEL_VALIDATION_ERROR:
|
|
109
|
+
for (const [example, failures] of Object.entries(e.validationErrors)) { // 422 data-model failures
|
|
110
|
+
for (const f of failures) log.warn(`${example} ${f.path}: ${f.message}`)
|
|
111
|
+
}
|
|
112
|
+
break
|
|
113
|
+
default:
|
|
114
|
+
throw e // unknown / framework error — fall back to e.statusCode
|
|
115
|
+
}
|
|
116
|
+
} else if (e instanceof ResponseError) {
|
|
117
|
+
// an error response without a problem document
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
`ProblemDetailException` extends the generated `ResponseError`, so existing `instanceof
|
|
123
|
+
ResponseError` sites keep working. It exposes `type`, `typeSlug`, `title`, `problemStatus`,
|
|
124
|
+
`detail`, `instance`, `errors`, `validationErrors`, `extensions` (every member outside the RFC 9457
|
|
125
|
+
base five), `statusCode`, `rawBody`, `isValidationProblem`, and `isDataModelValidationProblem`.
|
|
126
|
+
|
|
127
|
+
## Result collection
|
|
128
|
+
|
|
129
|
+
```ts
|
|
130
|
+
import { ResultCollector } from '@epistola.app/epistola-client'
|
|
131
|
+
|
|
132
|
+
const collector = ResultCollector.builder()
|
|
133
|
+
.client(client)
|
|
134
|
+
.tenantId('acme')
|
|
135
|
+
.handler(async (result) => console.log(result.requestId, result.status))
|
|
136
|
+
.build()
|
|
137
|
+
|
|
138
|
+
await collector.start() // adaptive polling; resolves after collector.stop()
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Results stream in one at a time and the batch is acknowledged only after every result in it was
|
|
142
|
+
handled: a handler that throws leaves the batch unacknowledged, so it is redelivered. gzip is always
|
|
143
|
+
decoded; zstd is offered and decoded where Node's zlib has it (22.15+). `partitionFor`,
|
|
144
|
+
`isMyPartition` and `routingKeyToMe` compute, from the assignment the server reports, a routing key
|
|
145
|
+
whose result comes back to this node.
|
|
146
|
+
|
|
147
|
+
## Client-side validation
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import { TemplateSchemaValidator, ValidatingGenerationApi, validateCreateTenantRequest } from '@epistola.app/epistola-client'
|
|
151
|
+
|
|
152
|
+
// Data against the template's JSON Schema, fetched once and cached (TtlSchemaCache, 5 minutes).
|
|
153
|
+
const validator = new TemplateSchemaValidator(templatesApi)
|
|
154
|
+
await validator.validate('acme', 'invoices', 'invoice', data) // throws TemplateDataValidationException
|
|
155
|
+
|
|
156
|
+
// Or transparently, before every generation call:
|
|
157
|
+
const generation = new ValidatingGenerationApi(new GenerationApi(client), templatesApi)
|
|
158
|
+
|
|
159
|
+
// A request model against the constraints the contract declares on it (slug patterns, lengths, ranges):
|
|
160
|
+
validateCreateTenantRequest({ id: 'Acme Corp', name: 'Acme' }) // throws ModelValidationException
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## Development
|
|
164
|
+
|
|
165
|
+
The client is generated from the bundled spec. From the repository root:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
make bundle # produce openapi.yaml
|
|
169
|
+
cd contracts/api/clients/nodejs-fetch
|
|
170
|
+
pnpm install --frozen-lockfile
|
|
171
|
+
./generate.sh # stock client + derived sources into src/generated/
|
|
172
|
+
pnpm build # dist/
|
|
173
|
+
pnpm test # node:test, against the compiled tree
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
`src/generated/` (the stock client under `api/`, and the derived `contractVersion`,
|
|
177
|
+
`contractIdentity`, `contractMediaTypes`, `contractOperations`, `knownProblemSlugs` and
|
|
178
|
+
`modelValidation`) is gitignored and rebuilt from the spec each time. The cross-client conformance
|
|
179
|
+
suite drives this client with `make conformance-node`.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { type KeyObject } from 'node:crypto';
|
|
2
|
+
/** The JOSE algorithms the signer supports, decided by the key type. */
|
|
3
|
+
export type JwtAlgorithm = 'RS256' | 'ES256';
|
|
4
|
+
/**
|
|
5
|
+
* Mints the short-lived self-signed JWTs Epistola accepts for consumer authentication.
|
|
6
|
+
*
|
|
7
|
+
* Each token carries:
|
|
8
|
+
* - `iss` — the consumer ID
|
|
9
|
+
* - `iat` — issued-at
|
|
10
|
+
* - `exp` — `iat` plus the token lifetime
|
|
11
|
+
* - `jti` — a fresh UUID per token, for replay protection
|
|
12
|
+
*
|
|
13
|
+
* Signed with `node:crypto` alone — RS256 for RSA keys, ES256 for EC P-256 — so this needs no JOSE
|
|
14
|
+
* dependency. ES256 signatures are emitted as the raw `R || S` pair JOSE requires (`ieee-p1363`),
|
|
15
|
+
* not the DER sequence Node produces by default, which every compliant verifier rejects.
|
|
16
|
+
*
|
|
17
|
+
* The client calls {@link createToken} per request so an expired token is never sent.
|
|
18
|
+
*
|
|
19
|
+
* ```ts
|
|
20
|
+
* const signer = JwtSigner.builder()
|
|
21
|
+
* .consumerId('invoice-service')
|
|
22
|
+
* .privateKey(JwtSigner.loadPrivateKey('private.pem'))
|
|
23
|
+
* .build()
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
export declare class JwtSigner {
|
|
27
|
+
private readonly consumerId;
|
|
28
|
+
private readonly privateKey;
|
|
29
|
+
/** The JOSE algorithm this signer uses, decided by the key type. */
|
|
30
|
+
readonly algorithm: JwtAlgorithm;
|
|
31
|
+
private readonly tokenLifetimeSeconds;
|
|
32
|
+
private constructor();
|
|
33
|
+
/** Creates a new {@link JwtSignerBuilder}. */
|
|
34
|
+
static builder(): JwtSignerBuilder;
|
|
35
|
+
/** Loads a private key from a PEM file (RSA or EC P-256, PKCS#8 `BEGIN PRIVATE KEY`). */
|
|
36
|
+
static loadPrivateKey(path: string): KeyObject;
|
|
37
|
+
/** Parses a PEM-encoded private key (RSA or EC P-256, PKCS#8 `BEGIN PRIVATE KEY`). */
|
|
38
|
+
static parsePrivateKeyPem(pem: string | Buffer): KeyObject;
|
|
39
|
+
/** Creates a freshly signed JWT with a new `iat`, `exp` and `jti`. */
|
|
40
|
+
createToken(): string;
|
|
41
|
+
private sign;
|
|
42
|
+
/** @internal */
|
|
43
|
+
static assemble(consumerId: string, privateKey: KeyObject, tokenLifetimeSeconds: number): JwtSigner;
|
|
44
|
+
}
|
|
45
|
+
/** Fluent builder for {@link JwtSigner}. */
|
|
46
|
+
export declare class JwtSignerBuilder {
|
|
47
|
+
private consumerIdValue;
|
|
48
|
+
private privateKeyValue;
|
|
49
|
+
private tokenLifetimeSecondsValue;
|
|
50
|
+
/** The consumer ID used as the JWT `iss` claim. */
|
|
51
|
+
consumerId(consumerId: string): this;
|
|
52
|
+
/**
|
|
53
|
+
* The private key used to sign tokens, from {@link JwtSigner.loadPrivateKey} or
|
|
54
|
+
* {@link JwtSigner.parsePrivateKeyPem}.
|
|
55
|
+
*/
|
|
56
|
+
privateKey(privateKey: KeyObject): this;
|
|
57
|
+
/** Token lifetime in seconds (default: 60). */
|
|
58
|
+
tokenLifetimeSeconds(seconds: number): this;
|
|
59
|
+
/** Builds the immutable {@link JwtSigner}. */
|
|
60
|
+
build(): JwtSigner;
|
|
61
|
+
}
|
|
62
|
+
//# sourceMappingURL=jwtSigner.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jwtSigner.d.ts","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAIA,OAAO,EAAsC,KAAK,SAAS,EAAE,MAAM,aAAa,CAAA;AAGhF,wEAAwE;AACxE,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,CAAA;AAI5C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IAElB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,oEAAoE;IACpE,QAAQ,CAAC,SAAS,EAAE,YAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IALvC,OAAO,eAMH;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO,IAAI,gBAAgB,CAEjC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAE7C;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMzD;IAED,sEAAsE;IACtE,WAAW,IAAI,MAAM,CAWpB;IAED,OAAO,CAAC,IAAI;IAOZ,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAElG;CACF;AAED,4CAA4C;AAC5C,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,yBAAyB,CAAiC;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAMnC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI,CAGtC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAM1C;IAED,8CAA8C;IAC9C,KAAK,IAAI,SAAS,CAQjB;CACF"}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
// SPDX-FileCopyrightText: Epistola Nederland B.V.
|
|
2
|
+
//
|
|
3
|
+
// SPDX-License-Identifier: EUPL-1.2
|
|
4
|
+
import { createPrivateKey, randomUUID, sign } from 'node:crypto';
|
|
5
|
+
import { readFileSync } from 'node:fs';
|
|
6
|
+
const DEFAULT_TOKEN_LIFETIME_SECONDS = 60;
|
|
7
|
+
/**
|
|
8
|
+
* Mints the short-lived self-signed JWTs Epistola accepts for consumer authentication.
|
|
9
|
+
*
|
|
10
|
+
* Each token carries:
|
|
11
|
+
* - `iss` — the consumer ID
|
|
12
|
+
* - `iat` — issued-at
|
|
13
|
+
* - `exp` — `iat` plus the token lifetime
|
|
14
|
+
* - `jti` — a fresh UUID per token, for replay protection
|
|
15
|
+
*
|
|
16
|
+
* Signed with `node:crypto` alone — RS256 for RSA keys, ES256 for EC P-256 — so this needs no JOSE
|
|
17
|
+
* dependency. ES256 signatures are emitted as the raw `R || S` pair JOSE requires (`ieee-p1363`),
|
|
18
|
+
* not the DER sequence Node produces by default, which every compliant verifier rejects.
|
|
19
|
+
*
|
|
20
|
+
* The client calls {@link createToken} per request so an expired token is never sent.
|
|
21
|
+
*
|
|
22
|
+
* ```ts
|
|
23
|
+
* const signer = JwtSigner.builder()
|
|
24
|
+
* .consumerId('invoice-service')
|
|
25
|
+
* .privateKey(JwtSigner.loadPrivateKey('private.pem'))
|
|
26
|
+
* .build()
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
export class JwtSigner {
|
|
30
|
+
consumerId;
|
|
31
|
+
privateKey;
|
|
32
|
+
algorithm;
|
|
33
|
+
tokenLifetimeSeconds;
|
|
34
|
+
constructor(consumerId, privateKey,
|
|
35
|
+
/** The JOSE algorithm this signer uses, decided by the key type. */
|
|
36
|
+
algorithm, tokenLifetimeSeconds) {
|
|
37
|
+
this.consumerId = consumerId;
|
|
38
|
+
this.privateKey = privateKey;
|
|
39
|
+
this.algorithm = algorithm;
|
|
40
|
+
this.tokenLifetimeSeconds = tokenLifetimeSeconds;
|
|
41
|
+
}
|
|
42
|
+
/** Creates a new {@link JwtSignerBuilder}. */
|
|
43
|
+
static builder() {
|
|
44
|
+
return new JwtSignerBuilder();
|
|
45
|
+
}
|
|
46
|
+
/** Loads a private key from a PEM file (RSA or EC P-256, PKCS#8 `BEGIN PRIVATE KEY`). */
|
|
47
|
+
static loadPrivateKey(path) {
|
|
48
|
+
return JwtSigner.parsePrivateKeyPem(readFileSync(path));
|
|
49
|
+
}
|
|
50
|
+
/** Parses a PEM-encoded private key (RSA or EC P-256, PKCS#8 `BEGIN PRIVATE KEY`). */
|
|
51
|
+
static parsePrivateKeyPem(pem) {
|
|
52
|
+
try {
|
|
53
|
+
return createPrivateKey(pem);
|
|
54
|
+
}
|
|
55
|
+
catch (cause) {
|
|
56
|
+
throw new TypeError('Failed to parse private key. Supported formats: RSA, EC (P-256) in PKCS#8 PEM format.', { cause });
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
/** Creates a freshly signed JWT with a new `iat`, `exp` and `jti`. */
|
|
60
|
+
createToken() {
|
|
61
|
+
const nowSeconds = Math.floor(Date.now() / 1000);
|
|
62
|
+
const header = { alg: this.algorithm, typ: 'JWT' };
|
|
63
|
+
const claims = {
|
|
64
|
+
iss: this.consumerId,
|
|
65
|
+
iat: nowSeconds,
|
|
66
|
+
exp: nowSeconds + this.tokenLifetimeSeconds,
|
|
67
|
+
jti: randomUUID(),
|
|
68
|
+
};
|
|
69
|
+
const signingInput = `${base64url(JSON.stringify(header))}.${base64url(JSON.stringify(claims))}`;
|
|
70
|
+
return `${signingInput}.${this.sign(signingInput).toString('base64url')}`;
|
|
71
|
+
}
|
|
72
|
+
sign(signingInput) {
|
|
73
|
+
const data = Buffer.from(signingInput, 'ascii');
|
|
74
|
+
return this.algorithm === 'ES256'
|
|
75
|
+
? sign('sha256', data, { key: this.privateKey, dsaEncoding: 'ieee-p1363' })
|
|
76
|
+
: sign('sha256', data, this.privateKey);
|
|
77
|
+
}
|
|
78
|
+
/** @internal */
|
|
79
|
+
static assemble(consumerId, privateKey, tokenLifetimeSeconds) {
|
|
80
|
+
return new JwtSigner(consumerId, privateKey, detectAlgorithm(privateKey), tokenLifetimeSeconds);
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
/** Fluent builder for {@link JwtSigner}. */
|
|
84
|
+
export class JwtSignerBuilder {
|
|
85
|
+
consumerIdValue;
|
|
86
|
+
privateKeyValue;
|
|
87
|
+
tokenLifetimeSecondsValue = DEFAULT_TOKEN_LIFETIME_SECONDS;
|
|
88
|
+
/** The consumer ID used as the JWT `iss` claim. */
|
|
89
|
+
consumerId(consumerId) {
|
|
90
|
+
if (consumerId.trim() === '') {
|
|
91
|
+
throw new RangeError('consumerId must not be blank');
|
|
92
|
+
}
|
|
93
|
+
this.consumerIdValue = consumerId;
|
|
94
|
+
return this;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* The private key used to sign tokens, from {@link JwtSigner.loadPrivateKey} or
|
|
98
|
+
* {@link JwtSigner.parsePrivateKeyPem}.
|
|
99
|
+
*/
|
|
100
|
+
privateKey(privateKey) {
|
|
101
|
+
this.privateKeyValue = privateKey;
|
|
102
|
+
return this;
|
|
103
|
+
}
|
|
104
|
+
/** Token lifetime in seconds (default: 60). */
|
|
105
|
+
tokenLifetimeSeconds(seconds) {
|
|
106
|
+
if (!(seconds > 0)) {
|
|
107
|
+
throw new RangeError('tokenLifetimeSeconds must be positive');
|
|
108
|
+
}
|
|
109
|
+
this.tokenLifetimeSecondsValue = seconds;
|
|
110
|
+
return this;
|
|
111
|
+
}
|
|
112
|
+
/** Builds the immutable {@link JwtSigner}. */
|
|
113
|
+
build() {
|
|
114
|
+
if (this.consumerIdValue === undefined) {
|
|
115
|
+
throw new RangeError('consumerId is required');
|
|
116
|
+
}
|
|
117
|
+
if (this.privateKeyValue === undefined) {
|
|
118
|
+
throw new RangeError('privateKey is required');
|
|
119
|
+
}
|
|
120
|
+
return JwtSigner.assemble(this.consumerIdValue, this.privateKeyValue, this.tokenLifetimeSecondsValue);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
function detectAlgorithm(key) {
|
|
124
|
+
if (key.type !== 'private') {
|
|
125
|
+
throw new TypeError(`A private key is required, got a ${key.type} key`);
|
|
126
|
+
}
|
|
127
|
+
switch (key.asymmetricKeyType) {
|
|
128
|
+
case 'rsa':
|
|
129
|
+
return 'RS256';
|
|
130
|
+
case 'ec': {
|
|
131
|
+
const curve = key.asymmetricKeyDetails?.namedCurve;
|
|
132
|
+
if (curve !== 'prime256v1') {
|
|
133
|
+
throw new TypeError(`Unsupported EC curve: ${curve ?? 'unknown'}. Supported: P-256 (prime256v1)`);
|
|
134
|
+
}
|
|
135
|
+
return 'ES256';
|
|
136
|
+
}
|
|
137
|
+
default:
|
|
138
|
+
throw new TypeError(`Unsupported key type: ${key.asymmetricKeyType ?? 'unknown'}. Supported: RSA (2048+), EC (P-256)`);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
function base64url(value) {
|
|
142
|
+
return Buffer.from(value, 'utf8').toString('base64url');
|
|
143
|
+
}
|
|
144
|
+
//# sourceMappingURL=jwtSigner.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jwtSigner.js","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,oCAAoC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAkB,MAAM,aAAa,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAKtC,MAAM,8BAA8B,GAAG,EAAE,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,SAAS;IAED,UAAU;IACV,UAAU;IAElB,SAAS;IACD,oBAAoB;IALvC,YACmB,UAAkB,EAClB,UAAqB;IACtC,oEAAoE;IAC3D,SAAuB,EACf,oBAA4B;0BAJ5B,UAAU;0BACV,UAAU;yBAElB,SAAS;oCACD,oBAAoB;IACpC,CAAC;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,gBAAgB,EAAE,CAAA;IAC/B,CAAC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAY;QAChC,OAAO,SAAS,CAAC,kBAAkB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAoB;QAC5C,IAAI,CAAC;YACH,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,SAAS,CAAC,uFAAuF,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QACzH,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,WAAW;QACT,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;QAClD,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,IAAI,CAAC,UAAU;YACpB,GAAG,EAAE,UAAU;YACf,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC,oBAAoB;YAC3C,GAAG,EAAE,UAAU,EAAE;SAClB,CAAA;QACD,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;QAChG,OAAO,GAAG,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAA;IAC3E,CAAC;IAEO,IAAI,CAAC,YAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAC/C,OAAO,IAAI,CAAC,SAAS,KAAK,OAAO;YAC/B,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IAC3C,CAAC;IAED,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAkB,EAAE,UAAqB,EAAE,oBAA4B;QACrF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,CAAC,UAAU,CAAC,EAAE,oBAAoB,CAAC,CAAA;IACjG,CAAC;CACF;AAED,4CAA4C;AAC5C,MAAM,OAAO,gBAAgB;IACnB,eAAe,CAAoB;IACnC,eAAe,CAAuB;IACtC,yBAAyB,GAAG,8BAA8B,CAAA;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAkB;QAC3B,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAA;QACtD,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAqB;QAC9B,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAe;QAClC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,UAAU,CAAC,uCAAuC,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAA;QACxC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,8CAA8C;IAC9C,KAAK;QACH,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACvG,CAAC;CACF;AAED,SAAS,eAAe,CAAC,GAAc;IACrC,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,SAAS,CAAC,oCAAoC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAA;IACzE,CAAC;IACD,QAAQ,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAC9B,KAAK,KAAK;YACR,OAAO,OAAO,CAAA;QAChB,KAAK,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,GAAG,GAAG,CAAC,oBAAoB,EAAE,UAAU,CAAA;YAClD,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;gBAC3B,MAAM,IAAI,SAAS,CAAC,yBAAyB,KAAK,IAAI,SAAS,iCAAiC,CAAC,CAAA;YACnG,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;QACD;YACE,MAAM,IAAI,SAAS,CAAC,yBAAyB,GAAG,CAAC,iBAAiB,IAAI,SAAS,sCAAsC,CAAC,CAAA;IAC1H,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;AACzD,CAAC"}
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
import { type GenerationResult, type PartitionAssignment } from '../generated/api/models/index.js';
|
|
2
|
+
import type { EpistolaClient } from '../http/epistolaClient.js';
|
|
3
|
+
import { PollBackoff } from '../protocol/pollBackoff.js';
|
|
4
|
+
/** The outcome of one collection call. */
|
|
5
|
+
export interface CollectResult {
|
|
6
|
+
/** How many results the handler was given. */
|
|
7
|
+
readonly count: number;
|
|
8
|
+
/** Whether the server reported more results waiting, in which case the loop polls again at once. */
|
|
9
|
+
readonly hasMore: boolean;
|
|
10
|
+
}
|
|
11
|
+
/** Handles one result as it streams in. A rejected promise or a throw leaves the batch unacknowledged. */
|
|
12
|
+
export type ResultHandler = (result: GenerationResult) => void | Promise<void>;
|
|
13
|
+
/** Told about collection failures (a failed request, a handler that threw). */
|
|
14
|
+
export type CollectErrorHandler = (error: unknown) => void;
|
|
15
|
+
/** Callbacks for observability. */
|
|
16
|
+
export interface MetricsListener {
|
|
17
|
+
/** Called after each poll completes, with the error when it failed. */
|
|
18
|
+
onPoll?(count: number, hasMore: boolean, durationMs: number, error: unknown): void;
|
|
19
|
+
/** Called when the partition assignment changes. */
|
|
20
|
+
onPartitionChange?(previous: PartitionAssignment | undefined, current: PartitionAssignment): void;
|
|
21
|
+
}
|
|
22
|
+
interface CollectorSettings {
|
|
23
|
+
readonly client: EpistolaClient;
|
|
24
|
+
readonly tenantId: string;
|
|
25
|
+
readonly batchSize: number;
|
|
26
|
+
readonly backoff: PollBackoff;
|
|
27
|
+
readonly kickIntervalMs: number;
|
|
28
|
+
readonly handler: ResultHandler;
|
|
29
|
+
readonly errorHandler: CollectErrorHandler | undefined;
|
|
30
|
+
readonly metricsListener: MetricsListener | undefined;
|
|
31
|
+
readonly registerShutdownHook: boolean;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Collects generation results via the `/generation/collect` endpoint with NDJSON streaming,
|
|
35
|
+
* compression, and adaptive polling.
|
|
36
|
+
*
|
|
37
|
+
* Results are processed one at a time — the response is never loaded into memory. Results from
|
|
38
|
+
* your node are returned first; orphaned results from dead nodes follow.
|
|
39
|
+
*
|
|
40
|
+
* Features: NDJSON streaming (constant memory); compression (gzip always, zstd when this Node
|
|
41
|
+
* runtime can decode it, chosen by sniffing the stream rather than trusting `Content-Encoding`);
|
|
42
|
+
* adaptive polling (immediate on `hasMore`, exponential backoff when idle, floored at the minimum
|
|
43
|
+
* interval); sequence-based acknowledgement; partition-aware routing-key helpers; metrics via
|
|
44
|
+
* {@link MetricsListener}; serialized {@link collectOnce}; and an optional SIGTERM/SIGINT hook.
|
|
45
|
+
*
|
|
46
|
+
* The collector is driven by an {@link EpistolaClient} so base URL, identity and authentication
|
|
47
|
+
* are reused from the same client passed to the generated API classes.
|
|
48
|
+
*
|
|
49
|
+
* ```ts
|
|
50
|
+
* const collector = ResultCollector.builder()
|
|
51
|
+
* .client(client)
|
|
52
|
+
* .tenantId('acme')
|
|
53
|
+
* .handler(async (result) => console.log(result.requestId, result.status))
|
|
54
|
+
* .build()
|
|
55
|
+
*
|
|
56
|
+
* await collector.start() // resolves after stop()
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
export declare class ResultCollector {
|
|
60
|
+
private readonly settings;
|
|
61
|
+
private running;
|
|
62
|
+
private currentIntervalMs;
|
|
63
|
+
private lastAcknowledged;
|
|
64
|
+
private assignment;
|
|
65
|
+
private routing;
|
|
66
|
+
private pollChain;
|
|
67
|
+
private wake;
|
|
68
|
+
private shutdownHook;
|
|
69
|
+
private constructor();
|
|
70
|
+
/** Creates a new {@link ResultCollectorBuilder}. */
|
|
71
|
+
static builder(): ResultCollectorBuilder;
|
|
72
|
+
/** @internal */
|
|
73
|
+
static assemble(settings: CollectorSettings): ResultCollector;
|
|
74
|
+
/** Current partition assignment, updated on each poll from the `_meta` line. */
|
|
75
|
+
get currentPartitionAssignment(): PartitionAssignment | undefined;
|
|
76
|
+
/** The highest sequence acknowledged so far — what the next poll sends as `acknowledgeUpTo`. */
|
|
77
|
+
get lastAcknowledgedSequence(): number | undefined;
|
|
78
|
+
/**
|
|
79
|
+
* The partition a routing key lands on, using the server's hash (murmur3 x86 32-bit, seed 0), or
|
|
80
|
+
* undefined while the assignment is not yet known.
|
|
81
|
+
*/
|
|
82
|
+
partitionFor(routingKey: string): number | undefined;
|
|
83
|
+
/** Whether a routing key would land on one of this node's partitions. */
|
|
84
|
+
isMyPartition(routingKey: string): boolean;
|
|
85
|
+
/**
|
|
86
|
+
* A routing key that targets one of this node's partitions: `key` unchanged when it already
|
|
87
|
+
* routes here, otherwise a numbered prefix (`"0:key"`, `"1:key"`, …) that does. Undefined while
|
|
88
|
+
* the assignment is not yet known. See {@link PartitionRouting.routingKeyToMe}.
|
|
89
|
+
*/
|
|
90
|
+
routingKeyToMe(key: string): string | undefined;
|
|
91
|
+
/**
|
|
92
|
+
* Runs the adaptive poll loop until {@link stop} is called; the returned promise resolves once
|
|
93
|
+
* the loop has ended. A poll that fails is reported to the error handler and backed off from
|
|
94
|
+
* (with jitter); the loop itself does not stop on failure.
|
|
95
|
+
*/
|
|
96
|
+
start(): Promise<void>;
|
|
97
|
+
/** Signals the poll loop to stop after the current collection completes. Safe to call from anywhere. */
|
|
98
|
+
stop(): void;
|
|
99
|
+
/**
|
|
100
|
+
* Hints that a result is expected soon: shortens the current backoff to the kick interval and
|
|
101
|
+
* wakes the poll loop. Does nothing when the loop is already polling at least that often.
|
|
102
|
+
*/
|
|
103
|
+
kick(): void;
|
|
104
|
+
/**
|
|
105
|
+
* Performs a single collection call. Concurrent calls are serialized to prevent duplicate
|
|
106
|
+
* delivery. Streams the NDJSON response line by line, awaiting the handler per result. If the
|
|
107
|
+
* handler throws, the sequence is not advanced and the batch is redelivered next call.
|
|
108
|
+
*/
|
|
109
|
+
collectOnce(): Promise<CollectResult>;
|
|
110
|
+
private timedCollect;
|
|
111
|
+
private doCollect;
|
|
112
|
+
private updatePartitionAssignment;
|
|
113
|
+
private sleep;
|
|
114
|
+
private installShutdownHook;
|
|
115
|
+
private removeShutdownHook;
|
|
116
|
+
}
|
|
117
|
+
/** Fluent builder for {@link ResultCollector}. */
|
|
118
|
+
export declare class ResultCollectorBuilder {
|
|
119
|
+
private clientValue;
|
|
120
|
+
private tenantIdValue;
|
|
121
|
+
private batchSizeValue;
|
|
122
|
+
private minIntervalMsValue;
|
|
123
|
+
private maxIntervalMsValue;
|
|
124
|
+
private kickIntervalMsValue;
|
|
125
|
+
private backoffMultiplierValue;
|
|
126
|
+
private handlerValue;
|
|
127
|
+
private errorHandlerValue;
|
|
128
|
+
private metricsListenerValue;
|
|
129
|
+
private registerShutdownHookValue;
|
|
130
|
+
/** The {@link EpistolaClient} to poll with (reuses its base URL, identity and authentication). */
|
|
131
|
+
client(client: EpistolaClient): this;
|
|
132
|
+
/** The tenant whose results to collect. */
|
|
133
|
+
tenantId(tenantId: string): this;
|
|
134
|
+
/** Maximum results per collection (default: 100). */
|
|
135
|
+
batchSize(size: number): this;
|
|
136
|
+
/** Minimum poll interval when results are flowing, in milliseconds (default: 1000). */
|
|
137
|
+
minIntervalMs(ms: number): this;
|
|
138
|
+
/** Maximum poll interval when idle, in milliseconds (default: 30000). */
|
|
139
|
+
maxIntervalMs(ms: number): this;
|
|
140
|
+
/** Wait used by {@link ResultCollector.kick} to override the backoff, in milliseconds (default: 3000). */
|
|
141
|
+
kickIntervalMs(ms: number): this;
|
|
142
|
+
/** Exponential backoff multiplier applied on each empty poll (default: 3.0). */
|
|
143
|
+
backoffMultiplier(multiplier: number): this;
|
|
144
|
+
/** Handler awaited for each result as it streams in. */
|
|
145
|
+
handler(handler: ResultHandler): this;
|
|
146
|
+
/** Optional handler for collection failures; without one they are backed off from silently. */
|
|
147
|
+
errorHandler(handler: CollectErrorHandler): this;
|
|
148
|
+
/** Optional metrics listener for observability. */
|
|
149
|
+
metricsListener(listener: MetricsListener): this;
|
|
150
|
+
/**
|
|
151
|
+
* Whether {@link ResultCollector.start} listens for SIGTERM and SIGINT and stops the loop on
|
|
152
|
+
* either (default: false). Off by default because a library that installs signal handlers changes
|
|
153
|
+
* what those signals do to the host process: with a listener present, Node no longer exits on
|
|
154
|
+
* SIGINT by itself. Turn it on when the collector is the process's reason to be running.
|
|
155
|
+
*/
|
|
156
|
+
registerShutdownHook(register: boolean): this;
|
|
157
|
+
/** Builds the {@link ResultCollector}. */
|
|
158
|
+
build(): ResultCollector;
|
|
159
|
+
}
|
|
160
|
+
export {};
|
|
161
|
+
//# sourceMappingURL=resultCollector.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resultCollector.d.ts","sourceRoot":"","sources":["../../src/collect/resultCollector.ts"],"names":[],"mappings":"AAKA,OAAO,EAA4B,KAAK,gBAAgB,EAAE,KAAK,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAE5H,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAI/D,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAExD,0CAA0C;AAC1C,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,oGAAoG;IACpG,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AAED,0GAA0G;AAC1G,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAE9E,+EAA+E;AAC/E,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;AAE1D,mCAAmC;AACnC,MAAM,WAAW,eAAe;IAC9B,uEAAuE;IACvE,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IAClF,oDAAoD;IACpD,iBAAiB,CAAC,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,EAAE,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAA;CAClG;AAED,UAAU,iBAAiB;IACzB,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAA;IAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;IAC7B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,YAAY,EAAE,mBAAmB,GAAG,SAAS,CAAA;IACtD,QAAQ,CAAC,eAAe,EAAE,eAAe,GAAG,SAAS,CAAA;IACrD,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAA;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAe;IAUN,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAT7C,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,iBAAiB,CAAQ;IACjC,OAAO,CAAC,gBAAgB,CAAoB;IAC5C,OAAO,CAAC,UAAU,CAAiC;IACnD,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,SAAS,CAAsC;IACvD,OAAO,CAAC,IAAI,CAA0B;IACtC,OAAO,CAAC,YAAY,CAA0B;IAE9C,OAAO,eAEN;IAED,oDAAoD;IACpD,MAAM,CAAC,OAAO,IAAI,sBAAsB,CAEvC;IAED,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,GAAG,eAAe,CAE5D;IAED,gFAAgF;IAChF,IAAI,0BAA0B,IAAI,mBAAmB,GAAG,SAAS,CAEhE;IAED,gGAAgG;IAChG,IAAI,wBAAwB,IAAI,MAAM,GAAG,SAAS,CAEjD;IAED;;;OAGG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEnD;IAED,yEAAyE;IACzE,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAEzC;IAED;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE9C;IAED;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAmC3B;IAED,wGAAwG;IACxG,IAAI,IAAI,IAAI,CAGX;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,CAMX;IAED;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC,CAIpC;YAEa,YAAY;YAaZ,SAAS;IAwDvB,OAAO,CAAC,yBAAyB;IAmBjC,OAAO,CAAC,KAAK;IAeb,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,kBAAkB;CAM3B;AAED,kDAAkD;AAClD,qBAAa,sBAAsB;IACjC,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,aAAa,CAAoB;IACzC,OAAO,CAAC,cAAc,CAAM;IAC5B,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,mBAAmB,CAAQ;IACnC,OAAO,CAAC,sBAAsB,CAAM;IACpC,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,oBAAoB,CAA6B;IACzD,OAAO,CAAC,yBAAyB,CAAQ;IAEzC,kGAAkG;IAClG,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAGnC;IAED,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAG/B;IAED,qDAAqD;IACrD,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAM5B;IAED,uFAAuF;IACvF,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAI9B;IAED,yEAAyE;IACzE,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAI9B;IAED,0GAA0G;IAC1G,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAI/B;IAED,gFAAgF;IAChF,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAM1C;IAED,wDAAwD;IACxD,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAGpC;IAED,+FAA+F;IAC/F,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAG/C;IAED,mDAAmD;IACnD,eAAe,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CAG/C;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAG5C;IAED,0CAA0C;IAC1C,KAAK,IAAI,eAAe,CAqBvB;CACF"}
|