fansunited-management-components 1.50.3 → 1.50.5

package/src/components/Utils/FormatNumber.d.ts

@@ -6,5 +6,15 @@ interface FormatNumberProps {
     sx?: SxProps;
     tooltipPlacement?: 'bottom-end' | 'bottom-start' | 'bottom' | 'left-end' | 'left-start' | 'left' | 'right-end' | 'right-start' | 'right' | 'top-end' | 'top-start' | 'top';
 }
+/**
+ * Display a large number in a compact abbreviated form, with a tooltip showing the full value.
+ *
+ * @property {number} value - The number to display in compact format (e.g., 1.2k, 3.4m).
+ * @property {import('@mui/material').SxProps} [sx] - Style overrides passed to Typography.
+ * @property {('bottom-end'|'bottom-start'|'bottom'|'left-end'|'left-start'|'left'|'right-end'|'right-start'|'right'|'top-end'|'top-start'|'top')} [tooltipPlacement]
+ * The placement of the tooltip for full value when shown.
+ * @example
+ * <FormatNumber value={15320} /> // renders 15.3k with tooltip "15,320"
+ */
 declare const FormatNumber: React.FC<FormatNumberProps>;
 export default FormatNumber;

package/src/components/WidgetEmbedCode/WidgetEmbedCode.d.ts

@@ -6,5 +6,13 @@ type WidgetEmbedCodeProps = {
     authRequirement: string | null;
     labels: any;
 };
+/**
+ * Generates embed div code for a single widget with optional leads and campaign data attributes.
+ *
+ * @property {'classic-quiz'|'either-or'|'poll'} entityType - Widget type.
+ * @property {string} entityId - Target entity id.
+ * @property {string|null} authRequirement - Used to enable/disable leads configuration.
+ * @property {object} labels - Custom labels for UI and tooltips.
+ */
 declare const WidgetEmbedCode: React.FC<WidgetEmbedCodeProps>;
 export default WidgetEmbedCode;

package/src/components/WidgetListEmbedCode/WidgetListEmbedCode.d.ts

@@ -4,5 +4,11 @@ type WidgetListEmbedCodeProps = {
     entityId: string;
     labels: any;
 };
+/**
+ * Generates embed div code for a list widget with layout and URL configuration.
+ *
+ * @property {string} entityId - Target list id.
+ * @property {object} labels - Custom labels for UI and tooltips.
+ */
 declare const WidgetListEmbedCode: React.FC<WidgetListEmbedCodeProps>;
 export default WidgetListEmbedCode;

package/src/components/Winners/Tags/Tags.d.ts

@@ -5,5 +5,12 @@ type TagsProps = {
     tags: string[];
     onChange: (tags: string[]) => void;
 };
+/**
+ * Tags input for winners — creatable multi-select with duplicate prevention.
+ *
+ * @property {object} labels - Custom labels (expects tagsPlaceholder, repeatedValueMessage).
+ * @property {string[]} tags - Current tags.
+ * @property {(tags: string[]) => void} onChange - Handler when tags change.
+ */
 declare const Tags: React.FC<TagsProps>;
 export default Tags;

package/src/components/Winners/Winners.d.ts

@@ -7,5 +7,14 @@ type WinnersProps = {
     labels: any;
     onClickBack: () => void;
 };
+/**
+ * Winners management screen: loads winners by entity and provides actions via WinnersLayout.
+ *
+ * @property {string} entityId - ID of the entity whose winners are managed.
+ * @property {string} entityType - Type of the entity (e.g., game type).
+ * @property {string} entityName - Display name for the header.
+ * @property {object} labels - I18n labels.
+ * @property {() => void} onClickBack - Navigate back handler.
+ */
 declare const Winners: React.FC<WinnersProps>;
 export default Winners;

package/src/constants/components.d.ts

@@ -1 +1,2 @@
 export declare const components: Record<string, React.FunctionComponent<any>>;
+export type ComponentsMap = typeof components;

package/src/context/ApiContext.d.ts

@@ -10,5 +10,9 @@ type APIContextValueType = {
     https: HttpsService;
 };
 declare const APIContext: import('react').Context<APIContextValueType | null>;
+/**
+ * React context that exposes the Fans United SDK instance and HTTPS service.
+ * Use via `useAPIContext()`.
+ */
 declare const APIProvider: React.FC<APIProviderProps & PropsWithChildren>;
 export { APIContext, APIProvider };

package/src/context/AuthContext.d.ts

@@ -1,9 +1,24 @@
 import { default as React, PropsWithChildren } from 'react';
 import { default as firebase } from 'firebase/compat/app';
 
+/**
+ * Provides the authenticated Firebase user to the component tree and suppresses initial flash while loading.
+ * Use `AuthContext` to read user or `useContext(AuthContext)` in custom hooks.
+ *
+ * @property {string} environment - Firebase environment key used to initialize the auth instance.
+ */
 type AuthProviderProps = {
     environment: string;
 };
+/**
+ * React context exposing the current Firebase user or null.
+ */
 declare const AuthContext: React.Context<firebase.User | null>;
+/**
+ * Auth provider that subscribes to Firebase auth state and provides the user once loaded.
+ *
+ * @param {{ environment: string; children?: React.ReactNode }} props
+ * @returns {JSX.Element}
+ */
 declare const AuthProvider: React.FC<AuthProviderProps & PropsWithChildren>;
 export { AuthContext, AuthProvider };

package/src/context/ComponentContext.d.ts

@@ -1,9 +1,24 @@
 import { default as React, PropsWithChildren, ReactNode } from 'react';
 
+/**
+ * Provides a registry of public Fans United components by name.
+ * Use `useComponentContext()` to resolve components dynamically.
+ *
+ * @property {object} [config] - Reserved for future component registry configuration.
+ */
 type ComponentProviderProps = {
     config?: any;
     children?: ReactNode;
 };
+/**
+ * React context mapping component names to their React function components.
+ */
 declare const ComponentContext: React.Context<Record<string, React.FunctionComponent<any>> | null>;
+/**
+ * Provider that exposes the components registry to descendants.
+ *
+ * @param {{ config?: any; children?: React.ReactNode }} props
+ * @returns {JSX.Element}
+ */
 declare const ComponentProvider: React.FC<ComponentProviderProps & PropsWithChildren>;
 export { ComponentContext, ComponentProvider };

package/src/hooks/useAPIContext.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Hook to access the API services provided by APIProvider.
+ *
+ * @returns {{ sdk: import('fansunited-sdk-esm').FansUnitedSDKModel; https: import('../services/https/HttpsService').default }}
+ * @throws {Error} If used outside of an APIProvider.
+ */
 export declare const useAPIContext: () => {
     sdk: import('fansunited-sdk-esm').FansUnitedSDKModel;
     https: import('../services/https/HttpsService').default;

package/src/hooks/useComponentContext.d.ts

@@ -1 +1,7 @@
-export declare const useComponentContext: () => Record<string, import('react').FunctionComponent<any>>;
+/**
+ * Hook to access the registry of public components provided by ComponentProvider.
+ *
+ * @returns {Record<string, React.FunctionComponent<any>>}
+ * @throws {Error} If used outside of a ComponentProvider.
+ */
+export declare const useComponentContext: () => import('../constants/components').ComponentsMap;

package/src/hooks/useIsMobile.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Determine if the viewport width is mobile or phone sized and updates on resize.
+ *
+ * @returns {{ isMobile: boolean; isPhone: boolean }}
+ */
 export declare const useIsMobile: () => {
     isMobile: boolean;
     isPhone: boolean;

package/src/index.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Centered loading spinner that fills its container.
+ *
+ * Recommended import:
+ * `import { Spinner } from 'fansunited-management-components'`
+ */
+export { default as Spinner } from './components/Spinner/Spinner';
+/**
+ * Props for the Spinner component.
+ * Provides typed access in consumer projects without importing from deep paths.
+ */
+export type SpinnerProps = import('react').ComponentProps<typeof import('./components/Spinner/Spinner').default>;
 declare const _default: {
     APIProvider: import('react').FC<{
         config: any;
@@ -16,7 +28,7 @@ declare const _default: {
     } & {
         children?: import('react').ReactNode | undefined;
     }>;
-    useComponentContext: () => Record<string, import('react').FunctionComponent<any>>;
+    useComponentContext: () => import('./constants/components').ComponentsMap;
     useAPIContext: () => {
         sdk: import('fansunited-sdk-esm').FansUnitedSDKModel;
         https: import('./services/https/HttpsService').default;