@lumiastream/ui 0.4.4 → 0.5.0

package/dist/se-import.d.ts

@@ -163,7 +163,32 @@ interface ReviewItem {
     flaggedOff?: boolean;
 }
 
-/** Distinct SE CDN URLs referenced anywhere inside the overlay's settings. */
+type ProxyFetchFn = (url: string, init?: {
+    headers?: Record<string, string>;
+}) => Promise<unknown>;
+interface FetchWithProxyOptions {
+    headers?: Record<string, string>;
+    proxyFetch?: ProxyFetchFn;
+    method?: string;
+}
+declare function looksLikeCorsError(err: unknown): boolean;
+interface FetchOrProxyResult {
+    ok: boolean;
+    status: number;
+    viaProxy: boolean;
+    json: () => Promise<unknown>;
+    errorBody: () => Promise<string>;
+}
+declare function fetchWithProxyFallback(url: string, options?: FetchWithProxyOptions): Promise<FetchOrProxyResult>;
+
+/**
+ * Distinct importable CDN URLs referenced anywhere inside the overlay's
+ * settings. Covers both StreamElements and Streamlabs source hosts — see
+ * IMPORTABLE_CDN_REGEX above for the full host list.
+ *
+ * Name kept as `findSEAssetURLs` for back-compat with existing callers; the
+ * SL import path uses the exact same function.
+ */
 declare function findSEAssetURLs(overlay: OverlayState): string[];
 /** Return a new overlay with every `oldUrl → newUrl` replacement applied. */
 declare function rewriteAssetURLs(overlay: OverlayState, mapping: Record<string, string>): OverlayState;
@@ -174,18 +199,27 @@ interface AssetMirrorProgress {
     error?: string;
 }
 /**
- * Mirror a single SE asset to Lumia storage via the existing `/overlays/assets`
- * upload endpoint. Returns the new Lumia URL on success.
+ * Mirror a single source CDN asset to Lumia storage via the host's upload
+ * endpoint. Returns the new Lumia URL on success.
  *
- * The host call site is responsible for retries and progress reporting; this
- * function is intentionally single-shot. Pass `signal` (AbortSignal) to abort
- * the source-side `fetch` when the modal closes mid-mirror — the upload itself
- * is consumer-defined and the caller decides whether/how to short-circuit it.
+ * Tries a direct `fetch(url, { mode: 'cors' })` first. On a CORS-shaped
+ * TypeError, falls back to `proxyAssetFetch` if the host provided one —
+ * needed for `cdn.twitchalerts.com` and any other source CDN that doesn't
+ * serve `Access-Control-Allow-Origin`. Without the fallback, those assets
+ * surface as `failed` in the mirror UI and stay on the source CDN in the
+ * imported overlay.
  *
- * Bails out with a typed error if the SE server advertises a Content-Length
- * over MAX_MIRROR_ASSET_BYTES (cheap pre-check) or if the downloaded blob
- * exceeds the same cap (covers chunked responses where Content-Length is
- * absent or lying).
+ * The host call site is responsible for retries and progress reporting;
+ * this function is intentionally single-shot. Pass `signal` (AbortSignal)
+ * to abort the source-side `fetch` when the modal closes mid-mirror — the
+ * upload itself is consumer-defined and the caller decides whether/how to
+ * short-circuit it. The proxy path doesn't take a signal because the
+ * host-provided fetch shape varies.
+ *
+ * Bails out with a typed error if the source server advertises a
+ * Content-Length over MAX_MIRROR_ASSET_BYTES (cheap pre-check) or if the
+ * downloaded blob exceeds the same cap (covers chunked responses where
+ * Content-Length is absent or lying).
  */
 declare function mirrorOneAsset(url: string, upload: (file: File) => Promise<{
     asset: {
@@ -193,7 +227,7 @@ declare function mirrorOneAsset(url: string, upload: (file: File) => Promise<{
     };
 } | {
     url: string;
-} | unknown>, signal?: AbortSignal): Promise<string>;
+} | unknown>, signal?: AbortSignal, proxyAssetFetch?: (url: string) => Promise<Blob>): Promise<string>;
 declare function filenameFromURL(url: string): string;
 
 interface TransplantedUnit {
@@ -296,6 +330,16 @@ interface SEOverlaySummary {
     };
 }
 declare function fetchSEOverlays(client: SEClient, count?: number): Promise<SEOverlaySummary[]>;
+interface SEElementShareParts {
+    channelId: string;
+    widgetInstanceId: string;
+    publicToken: string | null;
+}
+declare function parseElementShareUrl(input: string): SEElementShareParts | null;
+declare function fetchElementWidgetInstancePublic(channelId: string, widgetInstanceId: string, publicToken: string | null, options?: {
+    proxyFetch?: ProxyFetchFn;
+}): Promise<unknown>;
+declare function fetchElementWidgetInstanceForClient(client: SEClient, widgetInstanceId: string): Promise<unknown>;
 declare function fetchSEFiltersRaw(client: SEClient): Promise<unknown>;
 interface SEAuthProbeResult {
     endpoint: string;
@@ -362,6 +406,10 @@ interface SEImportBindings {
     CustomEmbed?: ComponentType<SECustomEmbedProps>;
     t?: (key: string) => string | undefined;
     onAuthError?: (err: SEAuthError) => void;
+    proxyFetch?: (url: string, init?: {
+        headers?: Record<string, string>;
+    }) => Promise<unknown>;
+    proxyAssetFetch?: (url: string) => Promise<Blob>;
     onOpenFullImport?: () => void;
 }
 
@@ -398,6 +446,150 @@ declare function getJwtInstructionSteps({ pasteHint }?: {
     pasteHint?: string;
 }): JwtInstructionStep[];
 
+interface SEElementResponse {
+    widgetInstancePublicUrl?: string;
+    widgetInstance: SEElementWidgetInstance;
+    widgetEnvironment?: SEElementWidgetEnvironment;
+    widgetInstanceConfigVersion: SEElementConfigVersion;
+    widgetInstanceManagedData?: unknown;
+    widgetInstancePersistentData?: unknown;
+}
+interface SEElementWidgetInstance {
+    widgetInstanceId: string;
+    channelId: string;
+    displayName?: string;
+    languageCode?: string;
+    widgetManifestUrl?: string;
+    originalWidgetManifestUrl?: string;
+    widgetCatalogReferenceId?: string;
+    widgetPreviewImageUrl?: string;
+    widgetInstancePublishedConfigVersionId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface SEElementWidgetEnvironment {
+    languageCode?: string;
+    connectedPlatforms?: SEElementConnectedPlatform[];
+}
+interface SEElementConnectedPlatform {
+    referenceId?: string;
+    provider: string;
+    displayName?: string;
+    channelId?: string;
+    sessionData?: Record<string, unknown>;
+}
+interface SEElementConfigVersion {
+    widgetInstanceConfigVersionId: string;
+    widgetInstanceId: string;
+    displayName?: string;
+    configData: string;
+    connectedPlatforms?: string[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface SEElementConfigData {
+    boundingBox: {
+        width: number;
+        height: number;
+    };
+    configStates: SEElementConfigState[];
+}
+interface SEElementConfigState {
+    referenceId: string;
+    categoryId: string | null;
+    displayName?: string;
+    triggers?: SEElementTrigger[];
+    settings?: {
+        compositeFields?: Record<string, SEElementCompositeField>;
+    };
+}
+interface SEElementTrigger {
+    systemCondition?: unknown;
+    userCondition?: unknown;
+}
+interface SEElementCompositeField {
+    type: 'video' | 'image' | 'text' | 'audio' | string;
+    mimeType?: string;
+    media?: SEElementMediaItem[];
+    text?: SEElementTextItem[];
+    style?: SEElementStyle;
+    highlightedStyle?: SEElementStyle;
+    animation?: {
+        enter?: SEElementAnimation;
+        static?: SEElementAnimation;
+        exit?: SEElementAnimation;
+    };
+    volume?: number;
+    playbackRate?: number;
+    delaySeconds?: number;
+}
+interface SEElementMediaItem {
+    href: string;
+    mimeType?: string;
+    role?: string;
+}
+interface SEElementTextItem {
+    content: string;
+}
+interface SEElementStyle {
+    left?: string | number;
+    top?: string | number;
+    width?: string | number;
+    height?: string | number;
+    maxWidth?: string | number;
+    maxHeight?: string | number;
+    color?: string;
+    fontFamily?: string;
+    fontSize?: string | number;
+    fontWeight?: string;
+    textAlign?: string;
+    textShadow?: string;
+    'letter-spacing'?: string | number;
+    [key: string]: unknown;
+}
+interface SEElementAnimation {
+    animationName?: string;
+    animationDuration?: string;
+    animationDelay?: string;
+    opacity?: string | number;
+    [key: string]: unknown;
+}
+declare function isSEElementResponse(value: unknown): value is SEElementResponse;
+declare function parseElementConfigData(raw: string): SEElementConfigData | null;
+declare function readElementProvider(response: SEElementResponse): 'twitch' | 'kick' | 'youtube';
+
+interface ElementImportResult {
+    overlay: OverlayState;
+    coverage: ImportCoverage;
+    reviewItems: ReviewItem[];
+}
+declare function importElementOverlay(response: SEElementResponse): ElementImportResult;
+
+type ElementAlertKind = 'subscriber' | 'subscriberGift' | 'communityGiftPurchase' | 'follower' | 'tip' | 'cheer' | 'raid' | 'merch' | 'charity';
+type ElementSceneKind = 'background' | 'foreground' | 'static';
+type ElementStateClass = {
+    kind: 'alert';
+    alertKind: ElementAlertKind;
+} | {
+    kind: 'scene';
+    sceneKind: ElementSceneKind;
+} | {
+    kind: 'unknown';
+};
+interface TriggerExtractedVars {
+    [varPath: string]: string | boolean | undefined;
+}
+declare function extractTriggerVars(node: unknown, out?: TriggerExtractedVars): TriggerExtractedVars;
+declare function classifyConfigState(state: SEElementConfigState): ElementStateClass;
+
+type SEImportProvider = 'twitch' | 'kick' | 'youtube';
+
+interface ElementSubstituteOptions {
+    listener?: string | null;
+    provider?: SEImportProvider;
+}
+declare function substituteElementTokens(input: string | null | undefined, options?: ElementSubstituteOptions): string;
+
 interface ImportResult {
     overlay: OverlayState;
     coverage: ImportCoverage;
@@ -409,9 +601,10 @@ declare function extractSEPreviewParts(input: string): {
     apikey: string | null;
 } | null;
 declare function buildBootstrapUrl(overlayId: string): string;
-declare function fetchSEBootstrap({ overlayId, apikey, }: {
+declare function fetchSEBootstrap({ overlayId, apikey, proxyFetch, }: {
     overlayId: string;
     apikey: string | null;
+    proxyFetch?: ProxyFetchFn;
 }): Promise<SEBootstrapResponse>;
 declare function isSEBootstrap(value: unknown): value is SEBootstrapResponse;
 declare function importSEBootstrap(bootstrap: SEBootstrapResponse): ImportResult;
@@ -443,4 +636,4 @@ declare function buildAIPromptForSEWidget(widget: SEWidget, canvas?: {
     height: number;
 }): string;
 
-export { type AIGeneratedCustomOverlay, type AssetMirrorProgress, FLAG_OFF_REASONS, type ImportCoverage, type ImportResult, JWT_DASHBOARD_URL, type JwtInstructionStep, MarketplacePicker, type MarketplacePickerProps, type ModuleType, type OverlayLayerBounds, type OverlayLayerState, type OverlayLayerType, type OverlayModuleAlertState, type OverlayModuleState, type OverlaySettings, type OverlayState, type ReviewItem, type SEAccountClaims, type SEAuthDiagnostic, SEAuthError, type SEAuthErrorCode, type SEAuthMode, type SEAuthProbeResult, type SEBootstrapResponse, type SEChannelSummary, SEClient, type SECustomEmbedProps, type SEExistingAsset, type SEImportBindings, SEImportWizard, type SEImportWizardProps, type SEOverlaySummary, type SESaveOverlayBody, type SEUploadAssetResult, type SEUsersCurrentResponse, type SEWidget, SE_WIDGET_TO_MARKETPLACE_CANDIDATES, type TransplantedUnit, applyReviewAction, buildAIPromptForSEWidget, buildBootstrapUrl, decodeJwtPayload, diagnoseSEAuth, extractSEOverlayId, extractSEPreviewParts, fetchSEBootstrap, fetchSEFiltersRaw, fetchSEOverlays, fetchUsableChannels, filenameFromURL, findSEAssetURLs, getAILandingBounds, getJwtInstructionSteps, getMarketplaceCandidates, hasMarketplaceCandidates, importSEBootstrap, isSEBootstrap, isWidgetFlaggedOff, listTransplantableLayers, mirrorOneAsset, rewriteAssetURLs, streamElementsCopyJwt, substituteSeTokens, transplantLayer };
+export { type AIGeneratedCustomOverlay, type AssetMirrorProgress, type ElementAlertKind, type ElementImportResult, type ElementSceneKind, type ElementStateClass, FLAG_OFF_REASONS, type FetchOrProxyResult, type FetchWithProxyOptions, type ImportCoverage, type ImportResult, JWT_DASHBOARD_URL, type JwtInstructionStep, MarketplacePicker, type MarketplacePickerProps, type ModuleType, type OverlayLayerBounds, type OverlayLayerState, type OverlayLayerType, type OverlayModuleAlertState, type OverlayModuleState, type OverlaySettings, type OverlayState, type ProxyFetchFn, type ReviewItem, type SEAccountClaims, type SEAuthDiagnostic, SEAuthError, type SEAuthErrorCode, type SEAuthMode, type SEAuthProbeResult, type SEBootstrapResponse, type SEChannelSummary, SEClient, type SECustomEmbedProps, type SEElementAnimation, type SEElementCompositeField, type SEElementConfigData, type SEElementConfigState, type SEElementConfigVersion, type SEElementMediaItem, type SEElementResponse, type SEElementShareParts, type SEElementStyle, type SEElementTextItem, type SEElementTrigger, type SEElementWidgetInstance, type SEExistingAsset, type SEImportBindings, SEImportWizard, type SEImportWizardProps, type SEOverlaySummary, type SESaveOverlayBody, type SEUploadAssetResult, type SEUsersCurrentResponse, type SEWidget, SE_WIDGET_TO_MARKETPLACE_CANDIDATES, type TransplantedUnit, applyReviewAction, buildAIPromptForSEWidget, buildBootstrapUrl, classifyConfigState, decodeJwtPayload, diagnoseSEAuth, extractSEOverlayId, extractSEPreviewParts, extractTriggerVars, fetchElementWidgetInstanceForClient, fetchElementWidgetInstancePublic, fetchSEBootstrap, fetchSEFiltersRaw, fetchSEOverlays, fetchUsableChannels, fetchWithProxyFallback, filenameFromURL, findSEAssetURLs, getAILandingBounds, getJwtInstructionSteps, getMarketplaceCandidates, hasMarketplaceCandidates, importElementOverlay, importSEBootstrap, isSEBootstrap, isSEElementResponse, isWidgetFlaggedOff, listTransplantableLayers, looksLikeCorsError, mirrorOneAsset, parseElementConfigData, parseElementShareUrl, readElementProvider, rewriteAssetURLs, streamElementsCopyJwt, substituteElementTokens, substituteSeTokens, transplantLayer };