@lumiastream/ui 0.2.7 → 0.2.8-alpha.10

package/README.md

@@ -72,6 +72,15 @@ Artifacts land in `dist/` and are what gets published to npm.
 1. Run `pnpm storybook` for hot‑reloading Storybook and `pnpm watch` for the library bundle.
 2. Commit with Conventional Commits (`feat:`, `fix:` …) so the release pipeline can auto‑generate changelogs.
 
+### Running live inside other repos
+
+To iterate on this library against a real consumer (Overlay-UI or LumiaStream)
+without publishing a new npm version each time, see **[LOCAL_DEV.md](./LOCAL_DEV.md)**.
+It covers the symlink workflow for both pnpm (Overlay-UI) and npm (LumiaStream),
+the Vite config requirements that have to stay in place for the symlinked
+workflow to work, and a troubleshooting table for the symptoms we've hit in
+practice.
+
 ---
 
 ## 🪪 License

package/dist/index.d.ts

@@ -485,7 +485,7 @@ declare const resolvePlatformChatterProfileUrl: ({ platform, username, displayna
 declare const normalizeHttpUrl: (value: unknown) => string | null;
 declare const resolveChatterProfileUrlWithResolvers: ({ platform, username, displayname, userId, extraSettings, resolvers, }: ResolveChatterProfileUrlWithResolversInput) => Promise<string | null>;
 
-type ModuleType = 'alert' | 'emotebox' | 'emotealert' | 'text' | 'image' | 'audio' | 'video' | 'camera' | 'slideshow' | 'shape' | 'svg' | 'colorbox' | 'goal' | 'timer' | 'gradientlight' | 'browsersource' | 'chatbox' | 'credits' | 'eventlist' | 'eventrotate' | 'hfx' | 'hfxalert' | 'clip' | 'youtube' | 'spinwheel' | 'raffle' | 'viewerqueue' | 'loyaltyleaderboard' | 'viewerprofiles' | 'achievements' | 'poll' | 'tournaments' | 'spotify' | 'nowplaying' | 'youtubemusic' | 'brbscreen' | 'vlc' | 'tts' | 'livecaption' | 'custom' | 'group';
+type ModuleType = 'alert' | 'emotebox' | 'emotealert' | 'text' | 'image' | 'audio' | 'video' | 'camera' | 'slideshow' | 'shape' | 'svg' | 'colorbox' | 'goal' | 'timer' | 'gradientlight' | 'browsersource' | 'chatbox' | 'credits' | 'eventlist' | 'eventrotate' | 'hfx' | 'hfxalert' | 'clip' | 'youtube' | 'spinwheel' | 'raffle' | 'viewerqueue' | 'loyaltyleaderboard' | 'viewerprofiles' | 'achievements' | 'poll' | 'tournaments' | 'spotify' | 'nowplaying' | 'youtubemusic' | 'brbscreen' | 'vlc' | 'tts' | 'livecaption' | 'custom' | 'tipjar' | 'hypetrain' | 'streamboss' | 'songrequest' | 'group';
 type OverlayLayerType = 'layer' | 'group';
 type OverlayLayerBounds = {
     height: number;
@@ -498,6 +498,8 @@ type OverlayLayerBounds = {
     zIndex?: number;
     matrix?: string;
     clipPath?: string;
+    autoWidth?: boolean;
+    autoHeight?: boolean;
 };
 type OverlayLayerState = {
     id: string;
@@ -606,6 +608,7 @@ interface SEText {
     scrolling?: {
         direction?: string;
         speed?: number;
+        enabled?: boolean;
     };
     css?: Record<string, unknown>;
 }
@@ -689,13 +692,67 @@ declare const SE_WIDGET_TO_MARKETPLACE_CANDIDATES: Record<string, number[]>;
 declare function getMarketplaceCandidates(seWidgetType: string): number[];
 declare function hasMarketplaceCandidates(seWidgetType: string): boolean;
 
-declare const SE_IMPORT_FLAGS: {
-    readonly IMPORT_MERCH_PRODUCTS: false;
-    readonly IMPORT_SEASONAL: false;
-};
-declare function isWidgetFlaggedOff(seType: string): boolean;
+declare const SE_IMPORT_FLAGS: {};
+declare function isWidgetFlaggedOff(_seType: string): boolean;
 declare const FLAG_OFF_REASONS: Record<string, string>;
 
+interface SEAccountClaims {
+    channel: string;
+    user: string;
+    authToken: string;
+    provider: string;
+    provider_id: string;
+    role: string;
+    exp: number;
+    jti: string;
+    channel_id?: string;
+    user_id?: string;
+}
+type SEAuthErrorCode = 'invalid-jwt' | 'expired' | 'unauthorized' | 'forbidden';
+declare class SEAuthError extends Error {
+    code: SEAuthErrorCode;
+    constructor(code: SEAuthErrorCode, message: string);
+}
+declare function decodeJwtPayload(jwt: string): SEAccountClaims;
+declare class SEClient {
+    private readonly claims;
+    constructor(claims: SEAccountClaims);
+    static fromJwt(jwt: string): SEClient;
+    get channelId(): string;
+    get provider(): string;
+    get providerId(): string;
+    get userId(): string;
+    get jti(): string;
+    get expiresAt(): Date;
+    provenance(): {
+        jti: string;
+        channelId: string;
+        provider: string;
+        importedAt: string;
+    };
+    get<T>(path: string): Promise<T>;
+}
+interface SEChannelSummary {
+    _id: string;
+    provider: string;
+    providerId: string;
+    username: string;
+    alias?: string;
+    displayName?: string;
+    avatar?: string;
+    role?: string;
+    authorized?: boolean;
+    inactive?: boolean;
+    isPartner?: boolean;
+    broadcasterType?: string;
+}
+interface SEUsersCurrentResponse {
+    _id: string;
+    suspended?: boolean;
+    channels: SEChannelSummary[];
+}
+declare function fetchUsableChannels(client: SEClient): Promise<SEChannelSummary[]>;
+
 interface SEExistingAsset {
     file_name?: string;
     name?: string;
@@ -737,12 +794,14 @@ interface SEImportBindings {
     };
     CustomEmbed?: ComponentType<SECustomEmbedProps>;
     t?: (key: string) => string | undefined;
+    onAuthError?: (err: SEAuthError) => void;
 }
 
 interface SEImportWizardProps {
     bindings: SEImportBindings;
+    initialUrl?: string;
 }
-declare function SEImportWizard({ bindings }: SEImportWizardProps): react_jsx_runtime.JSX.Element;
+declare function SEImportWizard({ bindings, initialUrl, }: SEImportWizardProps): react_jsx_runtime.JSX.Element;
 
 interface MarketplacePickerProps {
     seWidgetType: string;
@@ -801,4 +860,4 @@ declare function buildAIPromptForSEWidget(widget: SEWidget, canvas?: {
     height: number;
 }): string;
 
-export { type AIGeneratedCustomOverlay, type AssetMirrorProgress, type BuildChatMessageContentOptions, type ChatMessageContentItem, type ChatMessageEmoteStore, type ChatMessageToken, type ChatMessageTokenizationOptions, type ChatboxMediaPreview, type ChatboxMediaPreviewKind, type ChatterProfileResolver, type ChatterProfileResolverPayload, type ChatterProfileUrlInput, FLAG_OFF_REASONS, type IVariables, type ImportCoverage, type ImportResult, LSButton, type LSButtonProps, LSCheckbox, LSCheckboxField, LSColorPicker, type LSColorPickerProps, LSFontPicker, LSInput, type LSInputProps$1 as LSInputProps, LSMultiSelect, LSRadio, LSRadioGroup, LSSelect, LSSliderInput, type LSInputProps as LSSliderInputProps, LSTextField, type LSTextFieldProps, type LSVariableInputContextValue, LSVariableInputField, type LSVariableInputFieldProps, LSVariableInputProvider, MEDIA_PREVIEW_USER_LEVEL_VALUES, MarketplacePicker, type MarketplacePickerProps, type MediaPreviewRoleSettings, type MediaPreviewRoleSettingsInput, type MediaPreviewUserLevel, type MessageLinkPart, type ModuleType, type OverlayLayerBounds, type OverlayLayerState, type OverlayLayerType, type OverlayModuleAlertState, type OverlayModuleState, type OverlaySettings, type OverlayState, type ResolveChatterProfileUrlWithResolversInput, type ReviewItem, type SEBootstrapResponse, type SECustomEmbedProps, type SEExistingAsset, type SEImportBindings, SEImportWizard, type SEImportWizardProps, type SESaveOverlayBody, type SEUploadAssetResult, type SEWidget, SE_IMPORT_FLAGS, SE_WIDGET_TO_MARKETPLACE_CANDIDATES, type TransplantedUnit, applyReviewAction, buildAIPromptForSEWidget, buildBootstrapUrl, buildChatMessageContent, codeMirrorlinterOptions, extractSEOverlayId, extractSEPreviewParts, fetchSEBootstrap, filenameFromURL, findSEAssetURLs, getAILandingBounds, getMarketplaceCandidates, getMediaPreviewFromUrl, getNormalizedUserLevels, hasMarketplaceCandidates, importSEBootstrap, isMediaPreviewAllowedForUser, isSEBootstrap, isWidgetFlaggedOff, listTransplantableLayers, mirrorOneAsset, normalizeHttpUrl, normalizeMediaPreviewUserLevels, parseMessageLinks, resolveChatterProfileUrlWithResolvers, resolveMediaPreviewRoleSettings, resolveMediaPreviewSetting, resolvePlatformChatterProfileUrl, rewriteAssetURLs, tokenizeChatMessage, transplantLayer, variableCompletionOptions };
+export { type AIGeneratedCustomOverlay, type AssetMirrorProgress, type BuildChatMessageContentOptions, type ChatMessageContentItem, type ChatMessageEmoteStore, type ChatMessageToken, type ChatMessageTokenizationOptions, type ChatboxMediaPreview, type ChatboxMediaPreviewKind, type ChatterProfileResolver, type ChatterProfileResolverPayload, type ChatterProfileUrlInput, FLAG_OFF_REASONS, type IVariables, type ImportCoverage, type ImportResult, LSButton, type LSButtonProps, LSCheckbox, LSCheckboxField, LSColorPicker, type LSColorPickerProps, LSFontPicker, LSInput, type LSInputProps$1 as LSInputProps, LSMultiSelect, LSRadio, LSRadioGroup, LSSelect, LSSliderInput, type LSInputProps as LSSliderInputProps, LSTextField, type LSTextFieldProps, type LSVariableInputContextValue, LSVariableInputField, type LSVariableInputFieldProps, LSVariableInputProvider, MEDIA_PREVIEW_USER_LEVEL_VALUES, MarketplacePicker, type MarketplacePickerProps, type MediaPreviewRoleSettings, type MediaPreviewRoleSettingsInput, type MediaPreviewUserLevel, type MessageLinkPart, type ModuleType, type OverlayLayerBounds, type OverlayLayerState, type OverlayLayerType, type OverlayModuleAlertState, type OverlayModuleState, type OverlaySettings, type OverlayState, type ResolveChatterProfileUrlWithResolversInput, type ReviewItem, type SEAccountClaims, SEAuthError, type SEAuthErrorCode, type SEBootstrapResponse, type SEChannelSummary, SEClient, type SECustomEmbedProps, type SEExistingAsset, type SEImportBindings, SEImportWizard, type SEImportWizardProps, type SESaveOverlayBody, type SEUploadAssetResult, type SEUsersCurrentResponse, type SEWidget, SE_IMPORT_FLAGS, SE_WIDGET_TO_MARKETPLACE_CANDIDATES, type TransplantedUnit, applyReviewAction, buildAIPromptForSEWidget, buildBootstrapUrl, buildChatMessageContent, codeMirrorlinterOptions, decodeJwtPayload, extractSEOverlayId, extractSEPreviewParts, fetchSEBootstrap, fetchUsableChannels, filenameFromURL, findSEAssetURLs, getAILandingBounds, getMarketplaceCandidates, getMediaPreviewFromUrl, getNormalizedUserLevels, hasMarketplaceCandidates, importSEBootstrap, isMediaPreviewAllowedForUser, isSEBootstrap, isWidgetFlaggedOff, listTransplantableLayers, mirrorOneAsset, normalizeHttpUrl, normalizeMediaPreviewUserLevels, parseMessageLinks, resolveChatterProfileUrlWithResolvers, resolveMediaPreviewRoleSettings, resolveMediaPreviewSetting, resolvePlatformChatterProfileUrl, rewriteAssetURLs, tokenizeChatMessage, transplantLayer, variableCompletionOptions };