@gala-chain/launchpad-sdk 5.0.3 → 5.0.4-beta.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/EXAMPLES.md +141 -7
- package/README.md +68 -36
- package/dist/ai-docs.json +7357 -0
- package/dist/index.cjs.js +1 -1
- package/dist/index.d.ts +70 -11
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/src/LaunchpadSDK.d.ts +3288 -214
- package/dist/src/LaunchpadSDK.d.ts.map +1 -1
- package/dist/src/api/LaunchpadAPI.d.ts +21 -41
- package/dist/src/api/LaunchpadAPI.d.ts.map +1 -1
- package/dist/src/api/dto/BurnTokensDto.d.ts.map +1 -1
- package/dist/src/api/dto/LockTokenDto.d.ts.map +1 -1
- package/dist/src/api/dto/TransferTokenDto.d.ts.map +1 -1
- package/dist/src/api/dto/UnlockTokenDto.d.ts.map +1 -1
- package/dist/src/auth/JwtAuth.d.ts +145 -0
- package/dist/src/auth/JwtAuth.d.ts.map +1 -0
- package/dist/src/auth/SessionAuthService.d.ts +146 -0
- package/dist/src/auth/SessionAuthService.d.ts.map +1 -0
- package/dist/src/auth/SignatureAuth.d.ts.map +1 -1
- package/dist/src/bridge/BridgeService.d.ts.map +1 -1
- package/dist/src/bridge/GalaConnectClient.d.ts.map +1 -1
- package/dist/src/bridge/constants/tokens.d.ts +4 -3
- package/dist/src/bridge/constants/tokens.d.ts.map +1 -1
- package/dist/src/bridge/index.d.ts +1 -0
- package/dist/src/bridge/index.d.ts.map +1 -1
- package/dist/src/bridge/strategies/BridgeStrategy.d.ts.map +1 -1
- package/dist/src/bridge/strategies/EthereumBridgeStrategy.d.ts +1 -38
- package/dist/src/bridge/strategies/EthereumBridgeStrategy.d.ts.map +1 -1
- package/dist/src/bridge/strategies/SolanaBridgeStrategy.d.ts +1 -21
- package/dist/src/bridge/strategies/SolanaBridgeStrategy.d.ts.map +1 -1
- package/dist/src/bridge/types/bridge.dto.d.ts +15 -2
- package/dist/src/bridge/types/bridge.dto.d.ts.map +1 -1
- package/dist/src/bridge/utils/RateLimiter.d.ts +1 -1
- package/dist/src/bridge/utils/RateLimiter.d.ts.map +1 -1
- package/dist/src/bridge/utils/address-formatter.d.ts +25 -0
- package/dist/src/bridge/utils/address-formatter.d.ts.map +1 -0
- package/dist/src/bridge/utils/addressValidation.d.ts +200 -0
- package/dist/src/bridge/utils/addressValidation.d.ts.map +1 -0
- package/dist/src/bridge/utils/balanceHelpers.d.ts +215 -0
- package/dist/src/bridge/utils/balanceHelpers.d.ts.map +1 -0
- package/dist/src/bridge/utils/bridgeErrors.d.ts +98 -0
- package/dist/src/bridge/utils/bridgeErrors.d.ts.map +1 -0
- package/dist/src/bridge/utils/bridgeOutHelpers.d.ts +68 -0
- package/dist/src/bridge/utils/bridgeOutHelpers.d.ts.map +1 -0
- package/dist/src/bridge/utils/bridgePayload.d.ts +107 -0
- package/dist/src/bridge/utils/bridgePayload.d.ts.map +1 -0
- package/dist/src/bridge/utils/bridgeStatusParser.d.ts +75 -0
- package/dist/src/bridge/utils/bridgeStatusParser.d.ts.map +1 -0
- package/dist/src/bridge/utils/eip712Helpers.d.ts +66 -0
- package/dist/src/bridge/utils/eip712Helpers.d.ts.map +1 -0
- package/dist/src/bridge/utils/index.d.ts +9 -0
- package/dist/src/bridge/utils/index.d.ts.map +1 -1
- package/dist/src/bridge/utils/retry.d.ts +16 -0
- package/dist/src/bridge/utils/retry.d.ts.map +1 -1
- package/dist/src/bridge/utils/strategyDelegation.d.ts +69 -0
- package/dist/src/bridge/utils/strategyDelegation.d.ts.map +1 -0
- package/dist/src/bridge/utils/tokenIdUtils.d.ts +7 -0
- package/dist/src/bridge/utils/tokenIdUtils.d.ts.map +1 -1
- package/dist/src/bridge/utils/tokenMath.d.ts.map +1 -1
- package/dist/src/bridge/utils/tokenMetadataResolver.d.ts +97 -0
- package/dist/src/bridge/utils/tokenMetadataResolver.d.ts.map +1 -0
- package/dist/src/constants/endpoints.d.ts +453 -0
- package/dist/src/constants/endpoints.d.ts.map +1 -1
- package/dist/src/constants/error-messages.d.ts +1 -1
- package/dist/src/constants/error-messages.d.ts.map +1 -1
- package/dist/src/constants/jwt.d.ts +41 -0
- package/dist/src/constants/jwt.d.ts.map +1 -0
- package/dist/src/constants/sdk-defaults.d.ts +37 -0
- package/dist/src/constants/sdk-defaults.d.ts.map +1 -0
- package/dist/src/constants/version.generated.d.ts +1 -1
- package/dist/src/constants/version.generated.d.ts.map +1 -1
- package/dist/src/helpers/sdk.d.ts.map +1 -1
- package/dist/src/helpers/wallet.d.ts +4 -3
- package/dist/src/helpers/wallet.d.ts.map +1 -1
- package/dist/src/index.d.ts +70 -11
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/schemas/files.d.ts +2 -2
- package/dist/src/schemas/launchpad.d.ts +40 -8
- package/dist/src/schemas/launchpad.d.ts.map +1 -1
- package/dist/src/schemas/pagination.d.ts +7 -7
- package/dist/src/schemas/primitives.d.ts.map +1 -1
- package/dist/src/schemas/trade.d.ts +6 -6
- package/dist/src/schemas/user.d.ts +4 -4
- package/dist/src/schemas/validators.d.ts +15 -7
- package/dist/src/schemas/validators.d.ts.map +1 -1
- package/dist/src/services/AbstractCacheService.d.ts +227 -0
- package/dist/src/services/AbstractCacheService.d.ts.map +1 -0
- package/dist/src/services/AbstractTokenFetchService.d.ts +150 -0
- package/dist/src/services/AbstractTokenFetchService.d.ts.map +1 -0
- package/dist/src/services/ApiKeyService.d.ts +205 -0
- package/dist/src/services/ApiKeyService.d.ts.map +1 -0
- package/dist/src/services/BanService.d.ts +195 -0
- package/dist/src/services/BanService.d.ts.map +1 -0
- package/dist/src/services/BaseService.d.ts +50 -3
- package/dist/src/services/BaseService.d.ts.map +1 -1
- package/dist/src/services/BatchedCacheService.d.ts +132 -0
- package/dist/src/services/BatchedCacheService.d.ts.map +1 -0
- package/dist/src/services/BridgeableTokenCache.d.ts +32 -98
- package/dist/src/services/BridgeableTokenCache.d.ts.map +1 -1
- package/dist/src/services/BridgeableTokenService.d.ts +18 -13
- package/dist/src/services/BridgeableTokenService.d.ts.map +1 -1
- package/dist/src/services/BundleService.d.ts.map +1 -1
- package/dist/src/services/BundlerClientFactory.d.ts +32 -0
- package/dist/src/services/BundlerClientFactory.d.ts.map +1 -0
- package/dist/src/services/ChatMessagesService.d.ts +152 -0
- package/dist/src/services/ChatMessagesService.d.ts.map +1 -0
- package/dist/src/services/CommentService.d.ts +119 -0
- package/dist/src/services/CommentService.d.ts.map +1 -0
- package/dist/src/services/CommentsService.d.ts +155 -0
- package/dist/src/services/CommentsService.d.ts.map +1 -0
- package/dist/src/services/ContentFlagService.d.ts +212 -0
- package/dist/src/services/ContentFlagService.d.ts.map +1 -0
- package/dist/src/services/ContentReactionService.d.ts +175 -0
- package/dist/src/services/ContentReactionService.d.ts.map +1 -0
- package/dist/src/services/DexBackendClient.d.ts.map +1 -1
- package/dist/src/services/DexPoolService.d.ts +3 -3
- package/dist/src/services/DexPoolService.d.ts.map +1 -1
- package/dist/src/services/DexQuoteService.d.ts.map +1 -1
- package/dist/src/services/DexService.d.ts +2 -5
- package/dist/src/services/DexService.d.ts.map +1 -1
- package/dist/src/services/GSwapAssetService.d.ts +80 -0
- package/dist/src/services/GSwapAssetService.d.ts.map +1 -0
- package/dist/src/services/GSwapLiquidityMutationService.d.ts +140 -0
- package/dist/src/services/GSwapLiquidityMutationService.d.ts.map +1 -0
- package/dist/src/services/GSwapLiquidityQueryService.d.ts +87 -0
- package/dist/src/services/GSwapLiquidityQueryService.d.ts.map +1 -0
- package/dist/src/services/GSwapPoolCalculationService.d.ts +200 -0
- package/dist/src/services/GSwapPoolCalculationService.d.ts.map +1 -0
- package/dist/src/services/GSwapPoolQueryService.d.ts +116 -0
- package/dist/src/services/GSwapPoolQueryService.d.ts.map +1 -0
- package/dist/src/services/GSwapService.d.ts +14 -0
- package/dist/src/services/GSwapService.d.ts.map +1 -1
- package/dist/src/services/GSwapSwapService.d.ts +68 -0
- package/dist/src/services/GSwapSwapService.d.ts.map +1 -0
- package/dist/src/services/GalaChainBalanceService.d.ts +155 -0
- package/dist/src/services/GalaChainBalanceService.d.ts.map +1 -0
- package/dist/src/services/GalaChainGatewayClient.d.ts +32 -1
- package/dist/src/services/GalaChainGatewayClient.d.ts.map +1 -1
- package/dist/src/services/GalaChainLockService.d.ts +144 -0
- package/dist/src/services/GalaChainLockService.d.ts.map +1 -0
- package/dist/src/services/GalaChainService.d.ts +23 -106
- package/dist/src/services/GalaChainService.d.ts.map +1 -1
- package/dist/src/services/GalaChainTokenService.d.ts +108 -0
- package/dist/src/services/GalaChainTokenService.d.ts.map +1 -0
- package/dist/src/services/GalaChainTransferService.d.ts +205 -0
- package/dist/src/services/GalaChainTransferService.d.ts.map +1 -0
- package/dist/src/services/ImageService.d.ts +24 -8
- package/dist/src/services/ImageService.d.ts.map +1 -1
- package/dist/src/services/LaunchpadService.d.ts +77 -5
- package/dist/src/services/LaunchpadService.d.ts.map +1 -1
- package/dist/src/services/ModeratorService.d.ts +269 -0
- package/dist/src/services/ModeratorService.d.ts.map +1 -0
- package/dist/src/services/MultiPoolStateManager.d.ts +4 -6
- package/dist/src/services/MultiPoolStateManager.d.ts.map +1 -1
- package/dist/src/services/NetworkKeyedCacheService.d.ts +185 -0
- package/dist/src/services/NetworkKeyedCacheService.d.ts.map +1 -0
- package/dist/src/services/OverseerService.d.ts +322 -0
- package/dist/src/services/OverseerService.d.ts.map +1 -0
- package/dist/src/services/PoolCacheManager.d.ts +2 -2
- package/dist/src/services/PoolCacheManager.d.ts.map +1 -1
- package/dist/src/services/PoolService.d.ts +61 -7
- package/dist/src/services/PoolService.d.ts.map +1 -1
- package/dist/src/services/PoolStateManager.d.ts +2 -2
- package/dist/src/services/PoolStateManager.d.ts.map +1 -1
- package/dist/src/services/PriceHistoryService.d.ts.map +1 -1
- package/dist/src/services/SignatureService.d.ts.map +1 -1
- package/dist/src/services/StreamChatService.d.ts +378 -0
- package/dist/src/services/StreamChatService.d.ts.map +1 -0
- package/dist/src/services/StreamTokenServiceBase.d.ts +371 -0
- package/dist/src/services/StreamTokenServiceBase.d.ts.map +1 -0
- package/dist/src/services/StreamWebSocketService.d.ts +268 -0
- package/dist/src/services/StreamWebSocketService.d.ts.map +1 -0
- package/dist/src/services/StreamingEventService.d.ts +431 -0
- package/dist/src/services/StreamingEventService.d.ts.map +1 -0
- package/dist/src/services/StreamingService.d.ts +547 -0
- package/dist/src/services/StreamingService.d.ts.map +1 -0
- package/dist/src/services/SwapEventQueue.d.ts +2 -2
- package/dist/src/services/SwapEventQueue.d.ts.map +1 -1
- package/dist/src/services/TokenBanService.d.ts +214 -0
- package/dist/src/services/TokenBanService.d.ts.map +1 -0
- package/dist/src/services/TokenClassKeyService.d.ts.map +1 -1
- package/dist/src/services/TokenMetadataCache.d.ts +36 -27
- package/dist/src/services/TokenMetadataCache.d.ts.map +1 -1
- package/dist/src/services/TokenMetadataService.d.ts +24 -4
- package/dist/src/services/TokenMetadataService.d.ts.map +1 -1
- package/dist/src/services/TokenResolverService.d.ts.map +1 -1
- package/dist/src/services/TradeService.d.ts +73 -0
- package/dist/src/services/TradeService.d.ts.map +1 -1
- package/dist/src/services/UserService.d.ts +56 -3
- package/dist/src/services/UserService.d.ts.map +1 -1
- package/dist/src/services/WebSocketService.d.ts +3 -3
- package/dist/src/services/WebSocketService.d.ts.map +1 -1
- package/dist/src/services/WrapService.d.ts +18 -5
- package/dist/src/services/WrapService.d.ts.map +1 -1
- package/dist/src/services/WrappableTokenCache.d.ts +8 -36
- package/dist/src/services/WrappableTokenCache.d.ts.map +1 -1
- package/dist/src/services/WrappableTokenService.d.ts +18 -12
- package/dist/src/services/WrappableTokenService.d.ts.map +1 -1
- package/dist/src/services/shared/cache-helpers.d.ts +188 -0
- package/dist/src/services/shared/cache-helpers.d.ts.map +1 -0
- package/dist/src/services/shared/http-helpers.d.ts +146 -0
- package/dist/src/services/shared/http-helpers.d.ts.map +1 -0
- package/dist/src/services/shared/pagination-helpers.d.ts +157 -0
- package/dist/src/services/shared/pagination-helpers.d.ts.map +1 -0
- package/dist/src/services/shared/service-validators.d.ts +137 -0
- package/dist/src/services/shared/service-validators.d.ts.map +1 -0
- package/dist/src/services/shared/websocket-helpers.d.ts +158 -0
- package/dist/src/services/shared/websocket-helpers.d.ts.map +1 -0
- package/dist/src/test-constants.d.ts +29 -0
- package/dist/src/test-constants.d.ts.map +1 -0
- package/dist/src/types/api-key.dto.d.ts +300 -0
- package/dist/src/types/api-key.dto.d.ts.map +1 -0
- package/dist/src/types/backend-responses.d.ts +12 -0
- package/dist/src/types/backend-responses.d.ts.map +1 -1
- package/dist/src/types/ban.dto.d.ts +413 -0
- package/dist/src/types/ban.dto.d.ts.map +1 -0
- package/dist/src/types/burn.dto.d.ts +21 -0
- package/dist/src/types/burn.dto.d.ts.map +1 -1
- package/dist/src/types/chat-messages.dto.d.ts +193 -0
- package/dist/src/types/chat-messages.dto.d.ts.map +1 -0
- package/dist/src/types/comment.dto.d.ts +180 -0
- package/dist/src/types/comment.dto.d.ts.map +1 -0
- package/dist/src/types/comments.dto.d.ts +210 -0
- package/dist/src/types/comments.dto.d.ts.map +1 -0
- package/dist/src/types/common.d.ts +369 -0
- package/dist/src/types/common.d.ts.map +1 -1
- package/dist/src/types/constraints.d.ts +374 -0
- package/dist/src/types/constraints.d.ts.map +1 -0
- package/dist/src/types/content-flag.dto.d.ts +310 -0
- package/dist/src/types/content-flag.dto.d.ts.map +1 -0
- package/dist/src/types/content-reactions.dto.d.ts +132 -0
- package/dist/src/types/content-reactions.dto.d.ts.map +1 -0
- package/dist/src/types/dex-pool.dto.d.ts +13 -37
- package/dist/src/types/dex-pool.dto.d.ts.map +1 -1
- package/dist/src/types/dto.d.ts +8 -0
- package/dist/src/types/dto.d.ts.map +1 -1
- package/dist/src/types/galachain-api.types.d.ts +30 -0
- package/dist/src/types/galachain-api.types.d.ts.map +1 -1
- package/dist/src/types/gswap-responses.types.d.ts.map +1 -1
- package/dist/src/types/launchpad.dto.d.ts +234 -131
- package/dist/src/types/launchpad.dto.d.ts.map +1 -1
- package/dist/src/types/launchpad.validation.d.ts.map +1 -1
- package/dist/src/types/lock.dto.d.ts +20 -35
- package/dist/src/types/lock.dto.d.ts.map +1 -1
- package/dist/src/types/moderator.dto.d.ts +581 -0
- package/dist/src/types/moderator.dto.d.ts.map +1 -0
- package/dist/src/types/options.dto.d.ts +25 -115
- package/dist/src/types/options.dto.d.ts.map +1 -1
- package/dist/src/types/overseer.dto.d.ts +420 -0
- package/dist/src/types/overseer.dto.d.ts.map +1 -0
- package/dist/src/types/pool.dto.d.ts +106 -0
- package/dist/src/types/pool.dto.d.ts.map +1 -0
- package/dist/src/types/result.types.d.ts +3 -2
- package/dist/src/types/result.types.d.ts.map +1 -1
- package/dist/src/types/session-auth.dto.d.ts +91 -0
- package/dist/src/types/session-auth.dto.d.ts.map +1 -0
- package/dist/src/types/stream-chat.dto.d.ts +815 -0
- package/dist/src/types/stream-chat.dto.d.ts.map +1 -0
- package/dist/src/types/streaming-events.dto.d.ts +586 -0
- package/dist/src/types/streaming-events.dto.d.ts.map +1 -0
- package/dist/src/types/streaming.dto.d.ts +1141 -0
- package/dist/src/types/streaming.dto.d.ts.map +1 -0
- package/dist/src/types/token-ban.dto.d.ts +195 -0
- package/dist/src/types/token-ban.dto.d.ts.map +1 -0
- package/dist/src/types/trade.dto.d.ts +21 -61
- package/dist/src/types/trade.dto.d.ts.map +1 -1
- package/dist/src/types/trades-query.dto.d.ts +127 -0
- package/dist/src/types/trades-query.dto.d.ts.map +1 -0
- package/dist/src/types/transfer.dto.d.ts +20 -15
- package/dist/src/types/transfer.dto.d.ts.map +1 -1
- package/dist/src/types/user.dto.d.ts +185 -73
- package/dist/src/types/user.dto.d.ts.map +1 -1
- package/dist/src/types/wrappable-token.dto.d.ts +6 -2
- package/dist/src/types/wrappable-token.dto.d.ts.map +1 -1
- package/dist/src/utils/LiquidityEventExtractor.d.ts.map +1 -1
- package/dist/src/utils/Logger.d.ts.map +1 -1
- package/dist/src/utils/MonitoringMetrics.d.ts.map +1 -1
- package/dist/src/utils/PoolKeyNormalizer.d.ts.map +1 -1
- package/dist/src/utils/ReconnectionManager.d.ts +142 -0
- package/dist/src/utils/ReconnectionManager.d.ts.map +1 -0
- package/dist/src/utils/SignatureHelper.d.ts +9 -0
- package/dist/src/utils/SignatureHelper.d.ts.map +1 -1
- package/dist/src/utils/SwapEventExtractor.d.ts.map +1 -1
- package/dist/src/utils/adapters.d.ts.map +1 -1
- package/dist/src/utils/address-formatter.d.ts +317 -0
- package/dist/src/utils/address-formatter.d.ts.map +1 -0
- package/dist/src/utils/agent-config.d.ts.map +1 -1
- package/dist/src/utils/amount-validator.d.ts +268 -0
- package/dist/src/utils/amount-validator.d.ts.map +1 -0
- package/dist/src/utils/api-patterns.d.ts +347 -0
- package/dist/src/utils/api-patterns.d.ts.map +1 -0
- package/dist/src/utils/array-helpers.d.ts +115 -0
- package/dist/src/utils/array-helpers.d.ts.map +1 -0
- package/dist/src/utils/async-patterns.d.ts +272 -0
- package/dist/src/utils/async-patterns.d.ts.map +1 -0
- package/dist/src/utils/auto-pagination.d.ts +195 -2
- package/dist/src/utils/auto-pagination.d.ts.map +1 -1
- package/dist/src/utils/bignumber-helpers.d.ts +119 -13
- package/dist/src/utils/bignumber-helpers.d.ts.map +1 -1
- package/dist/src/utils/bignumber-pool-cache.d.ts.map +1 -1
- package/dist/src/utils/bondingCurveCalculations.d.ts.map +1 -1
- package/dist/src/utils/cacheWarmingHelpers.d.ts +2 -2
- package/dist/src/utils/cacheWarmingHelpers.d.ts.map +1 -1
- package/dist/src/utils/data-transform-patterns.d.ts +393 -0
- package/dist/src/utils/data-transform-patterns.d.ts.map +1 -0
- package/dist/src/utils/date-utils.d.ts +166 -0
- package/dist/src/utils/date-utils.d.ts.map +1 -1
- package/dist/src/utils/delimiter-parser.d.ts +139 -0
- package/dist/src/utils/delimiter-parser.d.ts.map +1 -0
- package/dist/src/utils/error-factories.d.ts +346 -1
- package/dist/src/utils/error-factories.d.ts.map +1 -1
- package/dist/src/utils/error-handling-patterns.d.ts +390 -0
- package/dist/src/utils/error-handling-patterns.d.ts.map +1 -0
- package/dist/src/utils/error-patterns.d.ts +360 -0
- package/dist/src/utils/error-patterns.d.ts.map +1 -0
- package/dist/src/utils/error-utils.d.ts +250 -0
- package/dist/src/utils/error-utils.d.ts.map +1 -1
- package/dist/src/utils/error-wrapper.d.ts +208 -0
- package/dist/src/utils/error-wrapper.d.ts.map +1 -0
- package/dist/src/utils/errors.d.ts +70 -0
- package/dist/src/utils/errors.d.ts.map +1 -1
- package/dist/src/utils/http-factory.d.ts +36 -0
- package/dist/src/utils/http-factory.d.ts.map +1 -0
- package/dist/src/utils/http.d.ts.map +1 -1
- package/dist/src/utils/load-env.d.ts.map +1 -1
- package/dist/src/utils/multipart.d.ts.map +1 -1
- package/dist/src/utils/numeric-patterns.d.ts +289 -0
- package/dist/src/utils/numeric-patterns.d.ts.map +1 -0
- package/dist/src/utils/numeric-wrappers.d.ts +146 -0
- package/dist/src/utils/numeric-wrappers.d.ts.map +1 -0
- package/dist/src/utils/object-extractors.d.ts +115 -0
- package/dist/src/utils/object-extractors.d.ts.map +1 -0
- package/dist/src/utils/object-patterns.d.ts +81 -0
- package/dist/src/utils/object-patterns.d.ts.map +1 -0
- package/dist/src/utils/pagination-helpers.d.ts +230 -0
- package/dist/src/utils/pagination-helpers.d.ts.map +1 -0
- package/dist/src/utils/pool-pair-parser.d.ts +3 -1
- package/dist/src/utils/pool-pair-parser.d.ts.map +1 -1
- package/dist/src/utils/pool-state-validator.d.ts.map +1 -1
- package/dist/src/utils/position-filters.d.ts +1 -2
- package/dist/src/utils/position-filters.d.ts.map +1 -1
- package/dist/src/utils/query-params.d.ts +0 -16
- package/dist/src/utils/query-params.d.ts.map +1 -1
- package/dist/src/utils/response-handlers.d.ts +149 -20
- package/dist/src/utils/response-handlers.d.ts.map +1 -1
- package/dist/src/utils/response-helpers.d.ts +28 -0
- package/dist/src/utils/response-helpers.d.ts.map +1 -0
- package/dist/src/utils/response-normalizers.d.ts +27 -49
- package/dist/src/utils/response-normalizers.d.ts.map +1 -1
- package/dist/src/utils/safe-parsers.d.ts +487 -0
- package/dist/src/utils/safe-parsers.d.ts.map +1 -0
- package/dist/src/utils/service-validators.d.ts +268 -0
- package/dist/src/utils/service-validators.d.ts.map +1 -0
- package/dist/src/utils/slippage-utils.d.ts.map +1 -1
- package/dist/src/utils/string-patterns.d.ts +404 -0
- package/dist/src/utils/string-patterns.d.ts.map +1 -0
- package/dist/src/utils/string-transforms.d.ts +89 -0
- package/dist/src/utils/string-transforms.d.ts.map +1 -0
- package/dist/src/utils/string-utils.d.ts +108 -0
- package/dist/src/utils/string-utils.d.ts.map +1 -0
- package/dist/src/utils/swap-delta-calculator.d.ts.map +1 -1
- package/dist/src/utils/tick-crossing-handler.d.ts.map +1 -1
- package/dist/src/utils/token-format-converter.d.ts +22 -8
- package/dist/src/utils/token-format-converter.d.ts.map +1 -1
- package/dist/src/utils/token-parser.d.ts +2 -2
- package/dist/src/utils/token-parser.d.ts.map +1 -1
- package/dist/src/utils/token-stringification.d.ts +168 -0
- package/dist/src/utils/token-stringification.d.ts.map +1 -0
- package/dist/src/utils/tokenNameNormalizer.d.ts +96 -0
- package/dist/src/utils/tokenNameNormalizer.d.ts.map +1 -0
- package/dist/src/utils/tokenNormalizer.d.ts +8 -45
- package/dist/src/utils/tokenNormalizer.d.ts.map +1 -1
- package/dist/src/utils/transfer-validation.d.ts +1 -1
- package/dist/src/utils/transfer-validation.d.ts.map +1 -1
- package/dist/src/utils/type-guard-factory.d.ts +260 -0
- package/dist/src/utils/type-guard-factory.d.ts.map +1 -0
- package/dist/src/utils/unique-key-generator.d.ts +148 -0
- package/dist/src/utils/unique-key-generator.d.ts.map +1 -0
- package/dist/src/utils/validation-helpers.d.ts +906 -183
- package/dist/src/utils/validation-helpers.d.ts.map +1 -1
- package/dist/src/utils/validation-patterns.d.ts +745 -0
- package/dist/src/utils/validation-patterns.d.ts.map +1 -0
- package/dist/src/utils/validation.d.ts +2 -30
- package/dist/src/utils/validation.d.ts.map +1 -1
- package/dist/src/utils/wallet.d.ts +12 -1
- package/dist/src/utils/wallet.d.ts.map +1 -1
- package/dist/src/utils/websocket-patterns.d.ts +681 -0
- package/dist/src/utils/websocket-patterns.d.ts.map +1 -0
- package/dist/src/utils/websocket-validators.d.ts.map +1 -1
- package/package.json +86 -19
- package/dist/src/bridge/strategies/index.d.ts +0 -9
- package/dist/src/bridge/strategies/index.d.ts.map +0 -1
- package/dist/src/constants/counts.d.ts +0 -66
- package/dist/src/constants/counts.d.ts.map +0 -1
- package/dist/src/services/WebSocketManager.d.ts +0 -99
- package/dist/src/services/WebSocketManager.d.ts.map +0 -1
- package/dist/src/types/eip712-types.d.ts +0 -140
- package/dist/src/types/eip712-types.d.ts.map +0 -1
- package/dist/src/types/pool-state-manager-config.dto.d.ts +0 -103
- package/dist/src/types/pool-state-manager-config.dto.d.ts.map +0 -1
- package/dist/src/utils/number-utils.d.ts +0 -94
- package/dist/src/utils/number-utils.d.ts.map +0 -1
- package/dist/src/utils/precision-math.d.ts +0 -37
- package/dist/src/utils/precision-math.d.ts.map +0 -1
|
@@ -0,0 +1,581 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Moderator Invite Types and DTOs
|
|
3
|
+
*
|
|
4
|
+
* Type definitions for moderator invite management. Token owners can create
|
|
5
|
+
* invite links to delegate stream management access to other users (moderators,
|
|
6
|
+
* technical producers, managers) without needing their wallet address upfront.
|
|
7
|
+
*
|
|
8
|
+
* Flow:
|
|
9
|
+
* 1. Owner creates invite → gets magic link
|
|
10
|
+
* 2. Owner shares link (email, Slack, etc.)
|
|
11
|
+
* 3. Moderator clicks link, logs in, claims invite
|
|
12
|
+
* 4. Moderator now appears in their /studio dashboard
|
|
13
|
+
*
|
|
14
|
+
* @since 5.7.0
|
|
15
|
+
* @category Types
|
|
16
|
+
* @module moderator
|
|
17
|
+
*/
|
|
18
|
+
import { InternalApiResponse, PaginationMeta, ListResult, BasePaginationOptions } from './common';
|
|
19
|
+
/**
|
|
20
|
+
* Moderator Role Values
|
|
21
|
+
*
|
|
22
|
+
* These roles determine what permissions a moderator has:
|
|
23
|
+
* - MODERATOR: Manage comments, chat messages, ban/unban users
|
|
24
|
+
* - TECHNICAL_PRODUCER: Simulcast targets, stream key, stop/start stream
|
|
25
|
+
* - MANAGER: All of the above + recordings + stream settings
|
|
26
|
+
*
|
|
27
|
+
* Note: OWNER is not available for invites - you can't invite someone to be owner.
|
|
28
|
+
*/
|
|
29
|
+
export declare const MODERATOR_ROLE: {
|
|
30
|
+
/** Manage comments, chat messages, ban/unban users */
|
|
31
|
+
readonly MODERATOR: "MODERATOR";
|
|
32
|
+
/** Setup simulcast targets, get stream key, stop/start stream, prep work */
|
|
33
|
+
readonly TECHNICAL_PRODUCER: "TECHNICAL_PRODUCER";
|
|
34
|
+
/** Overseer: Moderator + Technical Producer + recordings + stream settings */
|
|
35
|
+
readonly MANAGER: "MANAGER";
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Moderator Role Type
|
|
39
|
+
*/
|
|
40
|
+
export type ModeratorRole = (typeof MODERATOR_ROLE)[keyof typeof MODERATOR_ROLE];
|
|
41
|
+
/**
|
|
42
|
+
* All available moderator roles as an array (for validation)
|
|
43
|
+
*/
|
|
44
|
+
export declare const MODERATOR_ROLES: ModeratorRole[];
|
|
45
|
+
/**
|
|
46
|
+
* Invite Scope Values
|
|
47
|
+
*
|
|
48
|
+
* Determines what tokens an invite grants access to:
|
|
49
|
+
* - TOKEN: Access to a specific token only (tokenName required)
|
|
50
|
+
* - ALL_OWNER_TOKENS: Blanket access to all tokens owned by the inviter
|
|
51
|
+
*
|
|
52
|
+
* @since 5.8.0
|
|
53
|
+
*/
|
|
54
|
+
export declare const INVITE_SCOPE: {
|
|
55
|
+
/** Access to specific token only (tokenName required) */
|
|
56
|
+
readonly TOKEN: "TOKEN";
|
|
57
|
+
/** Blanket access to all tokens by this owner (tokenName should be null) */
|
|
58
|
+
readonly ALL_OWNER_TOKENS: "ALL_OWNER_TOKENS";
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* Invite Scope Type
|
|
62
|
+
*/
|
|
63
|
+
export type InviteScope = (typeof INVITE_SCOPE)[keyof typeof INVITE_SCOPE];
|
|
64
|
+
/**
|
|
65
|
+
* All invite scopes as an array (for validation)
|
|
66
|
+
*/
|
|
67
|
+
export declare const INVITE_SCOPES: InviteScope[];
|
|
68
|
+
/**
|
|
69
|
+
* Invite Status Values
|
|
70
|
+
*/
|
|
71
|
+
export declare const INVITE_STATUS: {
|
|
72
|
+
/** Invite created, not yet claimed */
|
|
73
|
+
readonly PENDING: "PENDING";
|
|
74
|
+
/** Invite has been claimed by a moderator */
|
|
75
|
+
readonly CLAIMED: "CLAIMED";
|
|
76
|
+
/** Invite has been revoked by the owner */
|
|
77
|
+
readonly REVOKED: "REVOKED";
|
|
78
|
+
/** Invite has expired */
|
|
79
|
+
readonly EXPIRED: "EXPIRED";
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* Invite Status Type
|
|
83
|
+
*/
|
|
84
|
+
export type InviteStatus = (typeof INVITE_STATUS)[keyof typeof INVITE_STATUS];
|
|
85
|
+
/**
|
|
86
|
+
* All invite statuses as an array (for validation)
|
|
87
|
+
*/
|
|
88
|
+
export declare const INVITE_STATUSES: InviteStatus[];
|
|
89
|
+
/**
|
|
90
|
+
* Options for creating a new moderator invite.
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* ```typescript
|
|
94
|
+
* // Create TOKEN scope invite (access to specific token)
|
|
95
|
+
* const tokenInvite: CreateModeratorInviteOptions = {
|
|
96
|
+
* tokenName: 'mytoken',
|
|
97
|
+
* role: 'MODERATOR',
|
|
98
|
+
* description: 'John - Friday evening shows',
|
|
99
|
+
* expiresAt: '2025-12-31T23:59:59Z'
|
|
100
|
+
* };
|
|
101
|
+
*
|
|
102
|
+
* // Create ALL_OWNER_TOKENS scope invite (blanket access)
|
|
103
|
+
* const blanketInvite: CreateModeratorInviteOptions = {
|
|
104
|
+
* inviteScope: 'ALL_OWNER_TOKENS',
|
|
105
|
+
* role: 'MANAGER',
|
|
106
|
+
* description: 'Studio team - all tokens'
|
|
107
|
+
* };
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
110
|
+
export interface CreateModeratorInviteOptions {
|
|
111
|
+
/**
|
|
112
|
+
* Scope of the invite.
|
|
113
|
+
* - TOKEN: Access to specific token only (tokenName required)
|
|
114
|
+
* - ALL_OWNER_TOKENS: Blanket access to all owner's tokens (tokenName should be omitted)
|
|
115
|
+
* @default 'TOKEN'
|
|
116
|
+
* @since 5.8.0
|
|
117
|
+
*/
|
|
118
|
+
inviteScope?: InviteScope;
|
|
119
|
+
/**
|
|
120
|
+
* Token name to grant moderator access to.
|
|
121
|
+
* Required when inviteScope is 'TOKEN' (default).
|
|
122
|
+
* Should be omitted when inviteScope is 'ALL_OWNER_TOKENS'.
|
|
123
|
+
* Must be a token owned by the authenticated user.
|
|
124
|
+
*/
|
|
125
|
+
tokenName?: string;
|
|
126
|
+
/**
|
|
127
|
+
* Role to grant to the moderator.
|
|
128
|
+
* Required.
|
|
129
|
+
*/
|
|
130
|
+
role: ModeratorRole;
|
|
131
|
+
/**
|
|
132
|
+
* Optional description/label for the invite.
|
|
133
|
+
* Max 255 characters. Useful for tracking: "John - Friday shows"
|
|
134
|
+
*/
|
|
135
|
+
description?: string;
|
|
136
|
+
/**
|
|
137
|
+
* Optional expiration date in ISO 8601 format.
|
|
138
|
+
* If not provided, invite never expires.
|
|
139
|
+
* @example "2025-12-31T23:59:59Z"
|
|
140
|
+
*/
|
|
141
|
+
expiresAt?: string;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Options for claiming a moderator invite.
|
|
145
|
+
*/
|
|
146
|
+
export interface ClaimModeratorInviteOptions {
|
|
147
|
+
/**
|
|
148
|
+
* The invite code from the magic link URL.
|
|
149
|
+
* Format: 64-character hex string
|
|
150
|
+
*/
|
|
151
|
+
inviteCode: string;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* Options for listing moderator invites for a token.
|
|
155
|
+
*
|
|
156
|
+
* @since 6.11.0 - Now extends BasePaginationOptions for DRY compliance
|
|
157
|
+
*/
|
|
158
|
+
export interface ListModeratorInvitesOptions extends BasePaginationOptions {
|
|
159
|
+
/**
|
|
160
|
+
* Token name to filter invites by.
|
|
161
|
+
* Optional - if omitted, returns ALL invites created by the authenticated user across all tokens.
|
|
162
|
+
* If provided, must be a token owned by the authenticated user.
|
|
163
|
+
*/
|
|
164
|
+
tokenName?: string;
|
|
165
|
+
/**
|
|
166
|
+
* Optional filter by invite status.
|
|
167
|
+
*/
|
|
168
|
+
status?: InviteStatus;
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Options for listing tokens the current user moderates.
|
|
172
|
+
*
|
|
173
|
+
* @since 6.11.0 - Now extends BasePaginationOptions for DRY compliance
|
|
174
|
+
*/
|
|
175
|
+
export type GetModeratedTokensOptions = BasePaginationOptions;
|
|
176
|
+
/**
|
|
177
|
+
* Options for updating an invite's role.
|
|
178
|
+
*
|
|
179
|
+
* @example
|
|
180
|
+
* ```typescript
|
|
181
|
+
* await moderatorService.updateInviteRole({
|
|
182
|
+
* inviteId: 123,
|
|
183
|
+
* role: 'MANAGER'
|
|
184
|
+
* });
|
|
185
|
+
* ```
|
|
186
|
+
* @since 5.8.0
|
|
187
|
+
*/
|
|
188
|
+
export interface UpdateInviteRoleOptions {
|
|
189
|
+
/**
|
|
190
|
+
* The ID of the invite to update.
|
|
191
|
+
* Required.
|
|
192
|
+
*/
|
|
193
|
+
inviteId: number;
|
|
194
|
+
/**
|
|
195
|
+
* The new role to assign.
|
|
196
|
+
* Required.
|
|
197
|
+
*/
|
|
198
|
+
role: ModeratorRole;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Inviter information included in public invite info.
|
|
202
|
+
*/
|
|
203
|
+
export interface InviterInfo {
|
|
204
|
+
/** Wallet address of the inviter (token owner) */
|
|
205
|
+
address: string;
|
|
206
|
+
/** Display name (if set) */
|
|
207
|
+
fullName: string | null;
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Moderator invite data returned from API.
|
|
211
|
+
*/
|
|
212
|
+
export interface ModeratorInvite {
|
|
213
|
+
/** Unique identifier */
|
|
214
|
+
id: number;
|
|
215
|
+
/**
|
|
216
|
+
* Scope of the invite.
|
|
217
|
+
* - TOKEN: Access to specific token only
|
|
218
|
+
* - ALL_OWNER_TOKENS: Blanket access to all owner's tokens
|
|
219
|
+
* @since 5.8.0
|
|
220
|
+
*/
|
|
221
|
+
inviteScope: InviteScope;
|
|
222
|
+
/**
|
|
223
|
+
* Token name this invite grants access to.
|
|
224
|
+
* Present for TOKEN scope invites, null for ALL_OWNER_TOKENS scope.
|
|
225
|
+
*/
|
|
226
|
+
tokenName: string | null;
|
|
227
|
+
/** Role to be granted */
|
|
228
|
+
role: ModeratorRole;
|
|
229
|
+
/** Invite code (64-char hex string) */
|
|
230
|
+
inviteCode: string;
|
|
231
|
+
/** Full invite URL for sharing */
|
|
232
|
+
inviteUrl: string;
|
|
233
|
+
/** Optional description/label */
|
|
234
|
+
description: string | null;
|
|
235
|
+
/** Current status */
|
|
236
|
+
status: InviteStatus;
|
|
237
|
+
/** Wallet address that claimed this invite (null if not claimed) */
|
|
238
|
+
claimedBy: string | null;
|
|
239
|
+
/** Expiration timestamp (ISO 8601) or null if never expires */
|
|
240
|
+
expiresAt: string | null;
|
|
241
|
+
/** Creation timestamp (ISO 8601) */
|
|
242
|
+
createdAt: string;
|
|
243
|
+
/** Claim timestamp (ISO 8601) or null if not claimed */
|
|
244
|
+
claimedAt: string | null;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Public invite information for the claim page.
|
|
248
|
+
* This is returned by getInviteByCode (public endpoint).
|
|
249
|
+
*/
|
|
250
|
+
export interface PublicInviteInfo {
|
|
251
|
+
/**
|
|
252
|
+
* Scope of the invite.
|
|
253
|
+
* - TOKEN: Access to specific token only
|
|
254
|
+
* - ALL_OWNER_TOKENS: Blanket access to all owner's tokens
|
|
255
|
+
* @since 5.8.0
|
|
256
|
+
*/
|
|
257
|
+
inviteScope: InviteScope;
|
|
258
|
+
/**
|
|
259
|
+
* Token name this invite grants access to.
|
|
260
|
+
* Present for TOKEN scope invites, null for ALL_OWNER_TOKENS scope.
|
|
261
|
+
*/
|
|
262
|
+
tokenName: string | null;
|
|
263
|
+
/**
|
|
264
|
+
* Token symbol.
|
|
265
|
+
* Present for TOKEN scope invites, null for ALL_OWNER_TOKENS scope.
|
|
266
|
+
*/
|
|
267
|
+
tokenSymbol: string | null;
|
|
268
|
+
/**
|
|
269
|
+
* Token image URL.
|
|
270
|
+
* Present for TOKEN scope invites, null for ALL_OWNER_TOKENS scope.
|
|
271
|
+
*/
|
|
272
|
+
tokenImage: string | null;
|
|
273
|
+
/** Role to be granted */
|
|
274
|
+
role: ModeratorRole;
|
|
275
|
+
/** Optional description/label */
|
|
276
|
+
description: string | null;
|
|
277
|
+
/** Current status */
|
|
278
|
+
status: InviteStatus;
|
|
279
|
+
/** Expiration timestamp (ISO 8601) or null if never expires */
|
|
280
|
+
expiresAt: string | null;
|
|
281
|
+
/** Information about who created the invite */
|
|
282
|
+
invitedBy: InviterInfo;
|
|
283
|
+
}
|
|
284
|
+
/**
|
|
285
|
+
* Token data for moderators (returned after claiming or in moderated tokens list).
|
|
286
|
+
*/
|
|
287
|
+
export interface ModeratedToken {
|
|
288
|
+
/** Token name */
|
|
289
|
+
tokenName: string;
|
|
290
|
+
/** Token symbol */
|
|
291
|
+
tokenSymbol: string;
|
|
292
|
+
/** Token image URL */
|
|
293
|
+
tokenImage: string | null;
|
|
294
|
+
/** Role the user has for this token */
|
|
295
|
+
role: ModeratorRole;
|
|
296
|
+
/**
|
|
297
|
+
* Scope of the invite that granted this access.
|
|
298
|
+
* - TOKEN: Access from specific token invite
|
|
299
|
+
* - ALL_OWNER_TOKENS: Access from blanket owner invite
|
|
300
|
+
* @since 5.8.0
|
|
301
|
+
*/
|
|
302
|
+
inviteScope: InviteScope;
|
|
303
|
+
/** Current stream status */
|
|
304
|
+
muxStreamStatus: string | null;
|
|
305
|
+
/** Token owner's address */
|
|
306
|
+
creatorAddress: string;
|
|
307
|
+
/** When the user claimed the invite (ISO 8601) */
|
|
308
|
+
claimedAt: string;
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Response for claiming an ALL_OWNER_TOKENS scope invite.
|
|
312
|
+
* Unlike TOKEN scope, this doesn't return specific token info since
|
|
313
|
+
* the invite grants access to all owner's tokens (current and future).
|
|
314
|
+
*
|
|
315
|
+
* @since 5.8.0
|
|
316
|
+
*/
|
|
317
|
+
export interface BlanketInviteClaimResult {
|
|
318
|
+
/** Scope of the invite (always ALL_OWNER_TOKENS) */
|
|
319
|
+
inviteScope: InviteScope;
|
|
320
|
+
/** Role granted by the invite */
|
|
321
|
+
role: ModeratorRole;
|
|
322
|
+
/** When the invite was claimed (ISO 8601) */
|
|
323
|
+
claimedAt: string;
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Response from creating a moderator invite.
|
|
327
|
+
*/
|
|
328
|
+
export interface CreateModeratorInviteResult {
|
|
329
|
+
/** The created invite data */
|
|
330
|
+
invite: ModeratorInvite;
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* Response from claiming an invite.
|
|
334
|
+
* The result type depends on the invite scope:
|
|
335
|
+
* - TOKEN scope: Returns `token` with full token details
|
|
336
|
+
* - ALL_OWNER_TOKENS scope: Returns `blanketAccess` with minimal info
|
|
337
|
+
*
|
|
338
|
+
* @since 5.8.0 - Updated to support both TOKEN and ALL_OWNER_TOKENS scope
|
|
339
|
+
*/
|
|
340
|
+
export interface ClaimModeratorInviteResult {
|
|
341
|
+
/**
|
|
342
|
+
* Token details for TOKEN scope invites.
|
|
343
|
+
* Present when claiming a specific token invite.
|
|
344
|
+
*/
|
|
345
|
+
token?: ModeratedToken;
|
|
346
|
+
/**
|
|
347
|
+
* Blanket access info for ALL_OWNER_TOKENS scope invites.
|
|
348
|
+
* Present when claiming a blanket owner invite.
|
|
349
|
+
* @since 5.8.0
|
|
350
|
+
*/
|
|
351
|
+
blanketAccess?: BlanketInviteClaimResult;
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* Response from updating an invite's role.
|
|
355
|
+
* @since 5.8.0
|
|
356
|
+
*/
|
|
357
|
+
export interface UpdateInviteRoleResult {
|
|
358
|
+
/** The updated invite data */
|
|
359
|
+
invite: ModeratorInvite;
|
|
360
|
+
}
|
|
361
|
+
/**
|
|
362
|
+
* Paginated list of moderator invites.
|
|
363
|
+
*
|
|
364
|
+
* @since 6.6.0 - Refactored to use generic ListResult<T> pattern
|
|
365
|
+
*/
|
|
366
|
+
export type ModeratorInviteListResult = ListResult<ModeratorInvite>;
|
|
367
|
+
/**
|
|
368
|
+
* Paginated list of moderated tokens.
|
|
369
|
+
*
|
|
370
|
+
* @since 6.6.0 - Refactored to use generic ListResult<T> pattern
|
|
371
|
+
*/
|
|
372
|
+
export type ModeratedTokensResult = ListResult<ModeratedToken>;
|
|
373
|
+
/**
|
|
374
|
+
* Moderator permissions response
|
|
375
|
+
*
|
|
376
|
+
* Detailed breakdown of what actions a moderator can perform in their assigned role.
|
|
377
|
+
*
|
|
378
|
+
* @since 6.x.0
|
|
379
|
+
*/
|
|
380
|
+
export interface ModeratorPermissionsResponse {
|
|
381
|
+
/** Token name being moderated */
|
|
382
|
+
tokenName: string;
|
|
383
|
+
/** Moderator's role for this token */
|
|
384
|
+
role: ModeratorRole;
|
|
385
|
+
/** Can manage comments (create/delete) */
|
|
386
|
+
canManageComments: boolean;
|
|
387
|
+
/** Can manage chat messages (send/delete) */
|
|
388
|
+
canManageChat: boolean;
|
|
389
|
+
/** Can ban users */
|
|
390
|
+
canBanUsers: boolean;
|
|
391
|
+
/** Can unban users */
|
|
392
|
+
canUnbanUsers: boolean;
|
|
393
|
+
/** Can manage simulcast targets */
|
|
394
|
+
canManageSimulcast: boolean;
|
|
395
|
+
/** Can view and reset stream key */
|
|
396
|
+
canManageStreamKey: boolean;
|
|
397
|
+
/** Can start/stop streams */
|
|
398
|
+
canManageStream: boolean;
|
|
399
|
+
/** Can view and delete recordings */
|
|
400
|
+
canManageRecordings: boolean;
|
|
401
|
+
/** Can manage stream settings (countdown, language) */
|
|
402
|
+
canManageStreamSettings: boolean;
|
|
403
|
+
/** When these permissions were granted */
|
|
404
|
+
grantedAt: string;
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* Standard backend response wrapper for moderator endpoints
|
|
408
|
+
* @internal
|
|
409
|
+
* @see InternalApiResponse in common.ts for the shared type
|
|
410
|
+
* @deprecated Use InternalApiResponse from common.ts directly
|
|
411
|
+
*/
|
|
412
|
+
export type InternalModeratorResponse<T = unknown> = InternalApiResponse<T>;
|
|
413
|
+
/**
|
|
414
|
+
* Internal response from create invite endpoint
|
|
415
|
+
* @internal
|
|
416
|
+
*/
|
|
417
|
+
export interface InternalCreateInviteResponse extends InternalModeratorResponse<ModeratorInvite> {
|
|
418
|
+
}
|
|
419
|
+
/**
|
|
420
|
+
* Internal response from claim invite endpoint
|
|
421
|
+
* @internal
|
|
422
|
+
*/
|
|
423
|
+
export interface InternalClaimInviteResponse extends InternalModeratorResponse<ModeratedToken> {
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* Internal response from get invite by code endpoint
|
|
427
|
+
* @internal
|
|
428
|
+
*/
|
|
429
|
+
export interface InternalGetInviteByCodeResponse extends InternalModeratorResponse<PublicInviteInfo> {
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* Internal response from list invites endpoint
|
|
433
|
+
* @internal
|
|
434
|
+
*/
|
|
435
|
+
export interface InternalListInvitesResponse extends InternalModeratorResponse<{
|
|
436
|
+
invites: ModeratorInvite[];
|
|
437
|
+
meta: PaginationMeta;
|
|
438
|
+
}> {
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* Internal response from get moderated tokens endpoint
|
|
442
|
+
* @internal
|
|
443
|
+
*/
|
|
444
|
+
export interface InternalModeratedTokensResponse extends InternalModeratorResponse<{
|
|
445
|
+
tokens: ModeratedToken[];
|
|
446
|
+
meta: PaginationMeta;
|
|
447
|
+
}> {
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Internal response from revoke invite endpoint
|
|
451
|
+
* @internal
|
|
452
|
+
*/
|
|
453
|
+
export interface InternalRevokeInviteResponse extends InternalModeratorResponse<void> {
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* Internal response from update invite role endpoint
|
|
457
|
+
* @internal
|
|
458
|
+
* @since 5.8.0
|
|
459
|
+
*/
|
|
460
|
+
export interface InternalUpdateInviteRoleResponse extends InternalModeratorResponse<ModeratorInvite> {
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* Check if a string is a valid moderator role.
|
|
464
|
+
*
|
|
465
|
+
* @param role - The role string to validate
|
|
466
|
+
* @returns True if the role is valid
|
|
467
|
+
*
|
|
468
|
+
* @example
|
|
469
|
+
* ```typescript
|
|
470
|
+
* isValidModeratorRole('MODERATOR') // true
|
|
471
|
+
* isValidModeratorRole('OWNER') // false (OWNER not allowed)
|
|
472
|
+
* isValidModeratorRole('TECHNICAL_PRODUCER') // true
|
|
473
|
+
* ```
|
|
474
|
+
*/
|
|
475
|
+
export declare function isValidModeratorRole(role: string): role is ModeratorRole;
|
|
476
|
+
/**
|
|
477
|
+
* Check if a string is a valid invite status.
|
|
478
|
+
*
|
|
479
|
+
* @param status - The status string to validate
|
|
480
|
+
* @returns True if the status is valid
|
|
481
|
+
*/
|
|
482
|
+
export declare function isValidInviteStatus(status: string): status is InviteStatus;
|
|
483
|
+
/**
|
|
484
|
+
* Validate an invite code format.
|
|
485
|
+
*
|
|
486
|
+
* @param code - The invite code to validate
|
|
487
|
+
* @returns True if the code is valid (64 hex characters)
|
|
488
|
+
*/
|
|
489
|
+
export declare function isValidInviteCode(code: string): boolean;
|
|
490
|
+
/**
|
|
491
|
+
* Type guard for ModeratorInvite
|
|
492
|
+
*
|
|
493
|
+
* @since 6.12.0 - Refactored to use factory pattern
|
|
494
|
+
*/
|
|
495
|
+
export declare const isModeratorInvite: (obj: unknown) => obj is ModeratorInvite;
|
|
496
|
+
/**
|
|
497
|
+
* Type guard for ModeratedToken
|
|
498
|
+
*
|
|
499
|
+
* @since 6.12.0 - Refactored to use factory pattern
|
|
500
|
+
*/
|
|
501
|
+
export declare const isModeratedToken: (obj: unknown) => obj is ModeratedToken;
|
|
502
|
+
/**
|
|
503
|
+
* Type guard for PublicInviteInfo
|
|
504
|
+
*
|
|
505
|
+
* @since 6.12.0 - Refactored to use factory pattern
|
|
506
|
+
*/
|
|
507
|
+
export declare const isPublicInviteInfo: (obj: unknown) => obj is PublicInviteInfo;
|
|
508
|
+
/**
|
|
509
|
+
* Type guard for BlanketInviteClaimResult
|
|
510
|
+
*
|
|
511
|
+
* @since 5.8.0
|
|
512
|
+
* @since 6.12.0 - Refactored to use factory pattern
|
|
513
|
+
*/
|
|
514
|
+
export declare const isBlanketInviteClaimResult: (obj: unknown) => obj is BlanketInviteClaimResult;
|
|
515
|
+
/**
|
|
516
|
+
* Check if a string is a valid invite scope.
|
|
517
|
+
*
|
|
518
|
+
* @param scope - The scope string to validate
|
|
519
|
+
* @returns True if the scope is valid
|
|
520
|
+
* @since 5.8.0
|
|
521
|
+
*
|
|
522
|
+
* @example
|
|
523
|
+
* ```typescript
|
|
524
|
+
* isValidInviteScope('TOKEN') // true
|
|
525
|
+
* isValidInviteScope('ALL_OWNER_TOKENS') // true
|
|
526
|
+
* isValidInviteScope('INVALID') // false
|
|
527
|
+
* ```
|
|
528
|
+
*/
|
|
529
|
+
export declare function isValidInviteScope(scope: string): scope is InviteScope;
|
|
530
|
+
/**
|
|
531
|
+
* Validate CreateModeratorInviteOptions.
|
|
532
|
+
*
|
|
533
|
+
* @param options - The options to validate
|
|
534
|
+
* @returns Array of validation error messages (empty if valid)
|
|
535
|
+
*
|
|
536
|
+
* @example
|
|
537
|
+
* ```typescript
|
|
538
|
+
* const errors = validateCreateModeratorInviteOptions({ tokenName: '', role: 'INVALID' });
|
|
539
|
+
* if (errors.length > 0) {
|
|
540
|
+
* console.error('Validation failed:', errors);
|
|
541
|
+
* }
|
|
542
|
+
* ```
|
|
543
|
+
*/
|
|
544
|
+
export declare function validateCreateModeratorInviteOptions(options: CreateModeratorInviteOptions): string[];
|
|
545
|
+
/**
|
|
546
|
+
* Validate invite code format.
|
|
547
|
+
*
|
|
548
|
+
* @param inviteCode - The invite code to validate
|
|
549
|
+
* @returns Array of validation error messages (empty if valid)
|
|
550
|
+
*/
|
|
551
|
+
export declare function validateInviteCode(inviteCode: string): string[];
|
|
552
|
+
/**
|
|
553
|
+
* Validate ListModeratorInvitesOptions.
|
|
554
|
+
*
|
|
555
|
+
* @param options - The options to validate
|
|
556
|
+
* @returns Array of validation error messages (empty if valid)
|
|
557
|
+
*/
|
|
558
|
+
export declare function validateListModeratorInvitesOptions(options: ListModeratorInvitesOptions): string[];
|
|
559
|
+
/**
|
|
560
|
+
* Check if a moderator role has a specific permission/capability.
|
|
561
|
+
*
|
|
562
|
+
* Maps moderator roles to their capabilities:
|
|
563
|
+
* - MODERATOR: manage comments, manage chat, manage bans
|
|
564
|
+
* - TECHNICAL_PRODUCER: manage simulcast, stream key, start/stop stream
|
|
565
|
+
* - MANAGER: all of the above + recordings + stream settings
|
|
566
|
+
*
|
|
567
|
+
* @param role - The moderator role to check
|
|
568
|
+
* @param capability - The capability to check for
|
|
569
|
+
* @returns true if the role has the capability
|
|
570
|
+
*
|
|
571
|
+
* @example
|
|
572
|
+
* ```typescript
|
|
573
|
+
* hasPermission('MODERATOR', 'canManageChat') // true
|
|
574
|
+
* hasPermission('MODERATOR', 'canManageRecordings') // false
|
|
575
|
+
* hasPermission('MANAGER', 'canManageRecordings') // true
|
|
576
|
+
* ```
|
|
577
|
+
*
|
|
578
|
+
* @since 6.x.0
|
|
579
|
+
*/
|
|
580
|
+
export declare function hasPermission(role: ModeratorRole, capability: keyof ModeratorPermissionsResponse): boolean;
|
|
581
|
+
//# sourceMappingURL=moderator.dto.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"moderator.dto.d.ts","sourceRoot":"","sources":["../../../src/types/moderator.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAqBlG;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc;IACzB,sDAAsD;;IAEtD,4EAA4E;;IAE5E,8EAA8E;;CAEtE,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEjF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,aAAa,EAA+B,CAAC;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;IACvB,yDAAyD;;IAEzD,4EAA4E;;CAEpE,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,WAAW,EAA6B,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB,sCAAsC;;IAEtC,6CAA6C;;IAE7C,2CAA2C;;IAE3C,yBAAyB;;CAEjB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,YAAY,EAA8B,CAAC;AAMzE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,qBAAqB,CAAC;AAE9D;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,yBAAyB;IACzB,IAAI,EAAE,aAAa,CAAC;IAEpB,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;IAEnB,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;IAElB,iCAAiC;IACjC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,qBAAqB;IACrB,MAAM,EAAE,YAAY,CAAC;IAErB,oEAAoE;IACpE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,+DAA+D;IAC/D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAElB,wDAAwD;IACxD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,yBAAyB;IACzB,IAAI,EAAE,aAAa,CAAC;IAEpB,iCAAiC;IACjC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,qBAAqB;IACrB,MAAM,EAAE,YAAY,CAAC;IAErB,+DAA+D;IAC/D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,+CAA+C;IAC/C,SAAS,EAAE,WAAW,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAElB,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IAEpB,sBAAsB;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,uCAAuC;IACvC,IAAI,EAAE,aAAa,CAAC;IAEpB;;;;;OAKG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB,4BAA4B;IAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,4BAA4B;IAC5B,cAAc,EAAE,MAAM,CAAC;IAEvB,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC,oDAAoD;IACpD,WAAW,EAAE,WAAW,CAAC;IAEzB,iCAAiC;IACjC,IAAI,EAAE,aAAa,CAAC;IAEpB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,8BAA8B;IAC9B,MAAM,EAAE,eAAe,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IAEvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,8BAA8B;IAC9B,MAAM,EAAE,eAAe,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IAC3C,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAElB,sCAAsC;IACtC,IAAI,EAAE,aAAa,CAAC;IAEpB,0CAA0C;IAC1C,iBAAiB,EAAE,OAAO,CAAC;IAE3B,6CAA6C;IAC7C,aAAa,EAAE,OAAO,CAAC;IAEvB,oBAAoB;IACpB,WAAW,EAAE,OAAO,CAAC;IAErB,sBAAsB;IACtB,aAAa,EAAE,OAAO,CAAC;IAEvB,mCAAmC;IACnC,kBAAkB,EAAE,OAAO,CAAC;IAE5B,oCAAoC;IACpC,kBAAkB,EAAE,OAAO,CAAC;IAE5B,6BAA6B;IAC7B,eAAe,EAAE,OAAO,CAAC;IAEzB,qCAAqC;IACrC,mBAAmB,EAAE,OAAO,CAAC;IAE7B,uDAAuD;IACvD,uBAAuB,EAAE,OAAO,CAAC;IAEjC,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,GAAG,OAAO,IAAI,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,yBAAyB,CAAC,eAAe,CAAC;CAAG;AAEnG;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,yBAAyB,CAAC,cAAc,CAAC;CAAG;AAEjG;;;GAGG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB,CAAC,gBAAgB,CAAC;CAAG;AAEvG;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,yBAAyB,CAAC;IAC7E,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;CAAG;AAEL;;;GAGG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB,CAAC;IACjF,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;CAAG;AAEL;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,yBAAyB,CAAC,IAAI,CAAC;CAAG;AAExF;;;;GAIG;AACH,MAAM,WAAW,gCAAiC,SAAQ,yBAAyB,CAAC,eAAe,CAAC;CAAG;AAMvG;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,aAAa,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,YAAY,CAE1E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,0CAS5B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,yCAO3B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,2CAO7B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,mDAIrC,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,WAAW,CAEtE;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oCAAoC,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,EAAE,CA8CpG;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAU/D;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAAC,OAAO,EAAE,2BAA2B,GAAG,MAAM,EAAE,CAqBlG;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,aAAa,EACnB,UAAU,EAAE,MAAM,4BAA4B,GAC7C,OAAO,CA4BT"}
|