@gala-chain/launchpad-sdk 6.0.0 → 7.0.0-beta.1

package/dist/src/utils/assetUrls.d.ts

@@ -1,450 +0,0 @@
-/**
- * Asset URL Generation Utilities
- *
- * Provides type-safe helpers for generating redirect URLs to token and recording assets.
- * These URLs point to backend redirect endpoints that resolve to S3 or Mux asset locations.
- *
- * Asset Types:
- * - Token images: logo, thumbnail, animated, storyboard, poster, live stream
- * - Recording assets: thumbnail, animated, storyboard, poster, HLS stream
- *
- * @category Utilities
- * @since 7.3.0
- *
- * @example
- * ```typescript
- * import {
- *   getTokenImageUrl,
- *   getTokenLiveStreamUrl,
- *   getRecordingAssetUrl,
- * } from '@gala-chain/launchpad-sdk';
- *
- * const baseUrl = 'https://api.example.com';
- *
- * // Token image
- * const imageUrl = getTokenImageUrl('anime', baseUrl);
- * // → "https://api.example.com/v1/tokens/anime/assets/image"
- *
- * // Token live HLS stream
- * const liveUrl = getTokenLiveStreamUrl('anime', baseUrl);
- * // → "https://api.example.com/v1/tokens/anime/assets/live.m3u8"
- *
- * // Recording thumbnail
- * const thumbUrl = getRecordingAssetUrl('anime', 'asset123', 'thumbnail', baseUrl, 'jpg');
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset123/assets/thumbnail.jpg"
- * ```
- */
-/**
- * Token asset type variants
- *
- * Used for generating token-scoped asset URLs.
- *
- * @since 7.3.0
- */
-export type TokenAssetType = 'image' | 'thumbnail' | 'animated' | 'poster' | 'storyboard' | 'live';
-/**
- * Recording asset type variants
- *
- * Used for generating recording-scoped asset URLs.
- *
- * @since 7.3.0
- */
-export type RecordingAssetType = 'thumbnail' | 'animated' | 'poster' | 'storyboard' | 'stream';
-/**
- * Common asset file extension types
- *
- * @since 7.3.0
- */
-export type AssetExtension = 'jpg' | 'jpeg' | 'png' | 'gif' | 'webp' | 'vtt' | 'json' | 'm3u8';
-/**
- * Asset redirect endpoint structure
- *
- * Describes a redirect endpoint that resolves to an asset location.
- *
- * @since 7.3.0
- */
-export interface AssetRedirectEndpoint {
-    /** Redirect endpoint path (without baseUrl) */
-    path: string;
-    /** Asset type (used for context) */
-    assetType: string;
-    /** Whether an extension is required */
-    requiresExtension: boolean;
-    /** Whether this is for token assets or recording assets */
-    scope: 'token' | 'recording';
-}
-/**
- * Get redirect URL for a token image
- *
- * Retrieves the main token image/logo. This is the primary visual representation
- * of the token shown throughout the UI.
- *
- * **Backend:** Redirects to S3 if available, otherwise returns placeholder.
- *
- * @param tokenName Token name (lowercase, e.g., 'anime', 'GUSDC')
- * @param baseUrl API base URL (e.g., 'https://api.example.com')
- * @returns Full redirect URL to token image
- * @throws Error if token name is invalid or empty
- *
- * @example
- * ```typescript
- * const imageUrl = getTokenImageUrl('anime', 'https://api.example.com');
- * // → "https://api.example.com/v1/tokens/anime/assets/image"
- *
- * // Fetch the image (will redirect to S3)
- * const response = await fetch(imageUrl);
- * const blob = await response.blob();
- * const imageElement = document.querySelector('img');
- * if (imageElement) {
- *   imageElement.src = URL.createObjectURL(blob);
- * }
- * ```
- *
- * @since 7.3.0
- */
-export declare function getTokenImageUrl(tokenName: string, baseUrl: string): string;
-/**
- * Get redirect URL for a token thumbnail
- *
- * Smaller version of the token image optimized for list views and thumbnails.
- * Typically a smaller file size than the full image.
- *
- * **Backend:** Redirects to S3 if available, otherwise returns placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param baseUrl API base URL
- * @param extension File extension (optional, default: 'jpg')
- * @returns Full redirect URL to token thumbnail
- * @throws Error if token name is invalid or extension format is incorrect
- *
- * @example
- * ```typescript
- * const thumbUrl = getTokenThumbnailUrl('anime', 'https://api.example.com', 'png');
- * // → "https://api.example.com/v1/tokens/anime/assets/thumbnail.png"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getTokenThumbnailUrl(tokenName: string, baseUrl: string, extension?: string): string;
-/**
- * Get redirect URL for a token animated asset
- *
- * Animated version of the token image (e.g., GIF or WebP with animation).
- * Used in UI where motion attracts attention.
- *
- * **Backend:** Redirects to S3 if available, otherwise returns static placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param baseUrl API base URL
- * @param extension File extension (optional, default: 'gif')
- * @returns Full redirect URL to animated token image
- * @throws Error if token name is invalid or extension format is incorrect
- *
- * @example
- * ```typescript
- * const animUrl = getTokenAnimatedUrl('anime', 'https://api.example.com', 'webp');
- * // → "https://api.example.com/v1/tokens/anime/assets/animated.webp"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getTokenAnimatedUrl(tokenName: string, baseUrl: string, extension?: string): string;
-/**
- * Get redirect URL for a token poster image
- *
- * High-quality still frame used for previewing video/stream content.
- * Typically the first frame or a key frame from the stream.
- *
- * **Backend:** Redirects to Mux poster image if stream is recorded, otherwise placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param baseUrl API base URL
- * @returns Full redirect URL to token poster
- * @throws Error if token name is invalid or empty
- *
- * @example
- * ```typescript
- * const posterUrl = getTokenPosterUrl('anime', 'https://api.example.com');
- * // → "https://api.example.com/v1/tokens/anime/assets/poster.jpg"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getTokenPosterUrl(tokenName: string, baseUrl: string): string;
-/**
- * Get redirect URL for a token storyboard
- *
- * Contact sheet of thumbnails extracted from a stream, used for scrubbing/seeking
- * through video timelines. Can be in VTT, JSON, or image format.
- *
- * **Backend:** Redirects to Mux storyboard if available, otherwise placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param baseUrl API base URL
- * @param extension File extension (optional, default: 'vtt')
- * @returns Full redirect URL to storyboard
- * @throws Error if token name is invalid or extension format is incorrect
- *
- * @example
- * ```typescript
- * // VTT format (for video.js/HLS.js integration)
- * const storyboardVtt = getTokenStoryboardUrl('anime', 'https://api.example.com', 'vtt');
- * // → "https://api.example.com/v1/tokens/anime/assets/storyboard.vtt"
- *
- * // JSON format (for custom scrapers)
- * const storyboardJson = getTokenStoryboardUrl('anime', 'https://api.example.com', 'json');
- * // → "https://api.example.com/v1/tokens/anime/assets/storyboard.json"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getTokenStoryboardUrl(tokenName: string, baseUrl: string, extension?: string): string;
-/**
- * Get redirect URL for a token live stream (HLS)
- *
- * HTTP Live Streaming (HLS) playlist for live token streams.
- * Returns the master playlist (.m3u8) that references variant streams.
- *
- * **Backend:** Redirects to Mux HLS master playlist when stream is active.
- *
- * @param tokenName Token name (lowercase)
- * @param baseUrl API base URL
- * @returns Full redirect URL to HLS playlist
- * @throws Error if token name is invalid or empty
- *
- * @example
- * ```typescript
- * const liveUrl = getTokenLiveStreamUrl('anime', 'https://api.example.com');
- * // → "https://api.example.com/v1/tokens/anime/assets/live.m3u8"
- *
- * // Use with HLS.js
- * import Hls from 'hls.js';
- * const video = document.querySelector('video');
- * if (video && Hls.isSupported()) {
- *   const hls = new Hls();
- *   hls.loadSource(liveUrl);
- *   hls.attachMedia(video);
- * }
- * ```
- *
- * @since 7.3.0
- */
-export declare function getTokenLiveStreamUrl(tokenName: string, baseUrl: string): string;
-/**
- * Get redirect URL for a generic token asset
- *
- * Low-level utility for generating asset URLs when the specific helper
- * functions don't meet your needs. Combines token name, asset type, and extension.
- *
- * @param tokenName Token name (lowercase)
- * @param assetType Asset type name (e.g., 'image', 'thumbnail', 'animated')
- * @param baseUrl API base URL
- * @param extension Optional file extension (no default, must be provided if needed)
- * @returns Full redirect URL to asset
- * @throws Error if token name is invalid, asset type is empty, or extension format is incorrect
- *
- * @example
- * ```typescript
- * // Without extension
- * const imageUrl = getTokenAssetUrl('anime', 'image', 'https://api.example.com');
- * // → "https://api.example.com/v1/tokens/anime/assets/image"
- *
- * // With extension
- * const thumbUrl = getTokenAssetUrl('anime', 'thumbnail', 'https://api.example.com', 'png');
- * // → "https://api.example.com/v1/tokens/anime/assets/thumbnail.png"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getTokenAssetUrl(tokenName: string, assetType: string, baseUrl: string, extension?: string): string;
-/**
- * Get redirect URL for a recording thumbnail
- *
- * Static thumbnail image extracted from a recording's first frame or keyframe.
- *
- * **Backend:** Redirects to Mux thumbnail if available, otherwise placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param recordingId Recording asset ID (from Mux)
- * @param baseUrl API base URL
- * @param extension File extension (optional, default: 'jpg')
- * @returns Full redirect URL to recording thumbnail
- * @throws Error if token name or recording ID is invalid
- *
- * @example
- * ```typescript
- * const thumbUrl = getRecordingThumbnailUrl(
- *   'anime',
- *   'asset_abc123',
- *   'https://api.example.com',
- *   'png'
- * );
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/thumbnail.png"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getRecordingThumbnailUrl(tokenName: string, recordingId: string, baseUrl: string, extension?: string): string;
-/**
- * Get redirect URL for a recording animated asset
- *
- * Animated version of a recording (e.g., GIF preview of recording).
- *
- * **Backend:** Redirects to Mux animated asset if available, otherwise placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param recordingId Recording asset ID (from Mux)
- * @param baseUrl API base URL
- * @param extension File extension (optional, default: 'gif')
- * @returns Full redirect URL to animated recording
- * @throws Error if token name or recording ID is invalid
- *
- * @example
- * ```typescript
- * const animUrl = getRecordingAnimatedUrl(
- *   'anime',
- *   'asset_abc123',
- *   'https://api.example.com',
- *   'webp'
- * );
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/animated.webp"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getRecordingAnimatedUrl(tokenName: string, recordingId: string, baseUrl: string, extension?: string): string;
-/**
- * Get redirect URL for a recording poster image
- *
- * High-quality still frame from the recording, typically used as a placeholder
- * before playback or in list views.
- *
- * **Backend:** Redirects to Mux poster image if available, otherwise placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param recordingId Recording asset ID (from Mux)
- * @param baseUrl API base URL
- * @returns Full redirect URL to recording poster
- * @throws Error if token name or recording ID is invalid
- *
- * @example
- * ```typescript
- * const posterUrl = getRecordingPosterUrl(
- *   'anime',
- *   'asset_abc123',
- *   'https://api.example.com'
- * );
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/poster.jpg"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getRecordingPosterUrl(tokenName: string, recordingId: string, baseUrl: string): string;
-/**
- * Get redirect URL for a recording storyboard
- *
- * Contact sheet of thumbnails extracted from the entire recording, useful for
- * scrubbing/seeking through video playback. Can be in VTT, JSON, or image format.
- *
- * **Backend:** Redirects to Mux storyboard if available, otherwise placeholder.
- *
- * @param tokenName Token name (lowercase)
- * @param recordingId Recording asset ID (from Mux)
- * @param baseUrl API base URL
- * @param extension File extension (optional, default: 'vtt')
- * @returns Full redirect URL to recording storyboard
- * @throws Error if token name or recording ID is invalid, or extension format is incorrect
- *
- * @example
- * ```typescript
- * // VTT format
- * const storyboardVtt = getRecordingStoryboardUrl(
- *   'anime',
- *   'asset_abc123',
- *   'https://api.example.com',
- *   'vtt'
- * );
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/storyboard.vtt"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getRecordingStoryboardUrl(tokenName: string, recordingId: string, baseUrl: string, extension?: string): string;
-/**
- * Get redirect URL for a recording HLS stream
- *
- * HTTP Live Streaming (HLS) playlist for recorded video playback.
- * Returns the master playlist (.m3u8) that references variant streams at different bitrates.
- *
- * **Backend:** Redirects to Mux HLS master playlist for the recording.
- *
- * @param tokenName Token name (lowercase)
- * @param recordingId Recording asset ID (from Mux)
- * @param baseUrl API base URL
- * @returns Full redirect URL to HLS playlist
- * @throws Error if token name or recording ID is invalid
- *
- * @example
- * ```typescript
- * const streamUrl = getRecordingStreamUrl(
- *   'anime',
- *   'asset_abc123',
- *   'https://api.example.com'
- * );
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/stream.m3u8"
- *
- * // Use with video player
- * const videoElement = document.querySelector('video');
- * if (videoElement) {
- *   // HLS.js or native HLS support
- *   if (videoElement.canPlayType('application/vnd.apple.mpegurl')) {
- *     videoElement.src = streamUrl;
- *   } else {
- *     // Fallback to HLS.js
- *   }
- * }
- * ```
- *
- * @since 7.3.0
- */
-export declare function getRecordingStreamUrl(tokenName: string, recordingId: string, baseUrl: string): string;
-/**
- * Get redirect URL for a generic recording asset
- *
- * Low-level utility for generating recording asset URLs when the specific helper
- * functions don't meet your needs. Combines token name, recording ID, asset type, and extension.
- *
- * @param tokenName Token name (lowercase)
- * @param recordingId Recording asset ID (from Mux)
- * @param assetType Asset type name (e.g., 'thumbnail', 'stream', 'storyboard')
- * @param baseUrl API base URL
- * @param extension Optional file extension (no default, must be provided if needed)
- * @returns Full redirect URL to recording asset
- * @throws Error if token name or recording ID is invalid, asset type is empty, or extension format is incorrect
- *
- * @example
- * ```typescript
- * // Without extension (for stream)
- * const streamUrl = getRecordingAssetUrl(
- *   'anime',
- *   'asset_abc123',
- *   'stream',
- *   'https://api.example.com'
- * );
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/stream.m3u8"
- *
- * // With extension (for custom formats)
- * const customUrl = getRecordingAssetUrl(
- *   'anime',
- *   'asset_abc123',
- *   'metadata',
- *   'https://api.example.com',
- *   'json'
- * );
- * // → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/metadata.json"
- * ```
- *
- * @since 7.3.0
- */
-export declare function getRecordingAssetUrl(tokenName: string, recordingId: string, assetType: string, baseUrl: string, extension?: string): string;
-//# sourceMappingURL=assetUrls.d.ts.map

package/dist/src/utils/assetUrls.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"assetUrls.d.ts","sourceRoot":"","sources":["../../../src/utils/assetUrls.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,MAAM,CAAC;AAEnG;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE/F;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/F;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,2DAA2D;IAC3D,KAAK,EAAE,OAAO,GAAG,WAAW,CAAC;CAC9B;AA+CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAI3E;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAc,GACxB,MAAM,CAKR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAc,GACxB,MAAM,CAKR;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAI5E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAc,GACxB,MAAM,CAKR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAIhF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAaR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAc,GACxB,MAAM,CAWR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAc,GACxB,MAAM,CAWR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,GACd,MAAM,CAUR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAc,GACxB,MAAM,CAWR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,GACd,MAAM,CAUR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAkBR"}