fansunited-management-components 1.50.3 → 1.50.4

package/package.json

@@ -1,8 +1,10 @@
 {
-	"name": "fansunited-management-components",
-	"version": "1.50.3",
-	"main": "index.es.js",
-	"author": "Fans United",
-	"description": "",
-	"homepage": "https://fansunitedmedia.com/"
+  "name": "fansunited-management-components",
+  "version": "1.50.4",
+  "main": "index.es.js",
+  "module": "index.es.js",
+  "types": "index.d.ts",
+  "author": "Fans United",
+  "description": "",
+  "homepage": "https://fansunitedmedia.com/"
 }

package/src/components/AdContent/AdContent.d.ts

@@ -1,22 +1,16 @@
 import { default as React } from 'react';
 
-/**
- * Displays advertising content input with Rich Text and Plain Text tabs.
- *
- * @property {object} labels - I18n labels; expects `richText` and `plainText` keys.
- * @property {string} defaultValue - Initial content value.
- * @property {(value: string) => void} onChange - Callback when content changes.
- */
 type AdContentProps = {
     labels: any;
     defaultValue: string;
     onChange: (value: string) => void;
 };
 /**
- * Ad content editor providing both rich-text and textarea modes.
+ * Displays advertising content input with Rich Text and Plain Text tabs.
  *
- * @param {{ labels: any; defaultValue: string; onChange: (value: string) => void }} props
- * @returns {JSX.Element}
+ * @property {object} labels - Custom labels; expects `richText` and `plainText` keys.
+ * @property {string} defaultValue - Initial content value.
+ * @property {(value: string) => void} onChange - Callback when content changes.
  */
 declare const AdContent: React.FC<AdContentProps>;
 export default AdContent;

package/src/components/AuthRequirement/AuthRequirement.d.ts

@@ -6,5 +6,13 @@ type AuthRequirementProps = {
     labels: any;
     onChange: (authRequirement: string | null) => void;
 };
+/**
+ * Select for content access requirement: FREE/LEAD/REGISTERED/PAID.
+ *
+ * @property {string} defaultValue - Selected requirement id.
+ * @property {boolean} [isClearable=true] - Whether the selection can be cleared.
+ * @property {object} labels - I18n labels for the options and description.
+ * @property {(authRequirement: string | null) => void} onChange - Selection handler.
+ */
 declare const AuthRequirement: React.FC<AuthRequirementProps>;
 export default AuthRequirement;

package/src/components/Branding/Branding.d.ts

@@ -5,5 +5,12 @@ type BrandingProps = {
     defaultValue: Record<string, Record<string, string>> | null;
     onChange: (value: any) => void;
 };
+/**
+ * Branding editor with tabs for Images, Colors, and URLs. Designed for management UIs.
+ *
+ * @property {object} labels - Custom labels used throughout the tabs.
+ * @property {Record<string, Record<string, string>> | null} defaultValue - Initial branding structure with `images`, `colors`, `urls`.
+ * @property {(value: any) => void} onChange - Called with the updated branding value.
+ */
 declare const Branding: React.FC<BrandingProps>;
 export default Branding;

package/src/components/Buttons/HeaderButtons.d.ts

@@ -6,5 +6,15 @@ type HeaderButtonsProps = {
     onClickCreate: () => void;
     onClickCreateFromTemplate?: () => void;
 };
+/**
+ * Header action buttons for management pages: create and optional create-from-template, plus sign out.
+ *
+ * @property {string} createLabel - Label for the create button.
+ * @property {string} [createFromTemplateLabel] - Label for the create-from-template button; if omitted the button is hidden.
+ * @property {string} signOutLabel - Label for the sign-out button; if empty, button is hidden.
+ * @property {string} environment - Firebase environment key passed to SignOutButton.
+ * @property {() => void} onClickCreate - Handler for the create button.
+ * @property {() => void} [onClickCreateFromTemplate] - Handler for the create-from-template button.
+ */
 declare const HeaderButtons: React.FC<HeaderButtonsProps>;
 export default HeaderButtons;

package/src/components/Buttons/SignoutButtton.d.ts

@@ -4,5 +4,11 @@ type SignOutButtonProps = {
     signOutLabel: string;
     environment: string;
 };
+/**
+ * Button that signs out the current user from the given Firebase environment.
+ *
+ * @property {string} signOutLabel - Button label.
+ * @property {string} environment - Firebase environment key.
+ */
 declare const SignOutButton: React.FC<SignOutButtonProps>;
 export default SignOutButton;

package/src/components/Calendars/CustomFlatpickrCalendar.d.ts

@@ -7,5 +7,14 @@ type CustomFlatpickrCalendarProps = {
     dateFormat?: string;
     onChange: (date: string) => void;
 };
+/**
+ * Flatpickr-based datetime input with min-date logic and Joy styling.
+ *
+ * @property {string} defaultDate - ISO date used to initialize and control the input.
+ * @property {Date} [minDate] - Minimum selectable date; defaults to now + 15m.
+ * @property {Date} [maxDate] - Maximum selectable date.
+ * @property {string} [dateFormat='DD.MM.YYYY HH:mm'] - Display format.
+ * @property {(date: string) => void} onChange - Emits ISO string when user picks a date.
+ */
 declare const CustomFlatpickrCalendar: React.FC<CustomFlatpickrCalendarProps>;
 export default CustomFlatpickrCalendar;

package/src/components/Calendars/DatePicker.d.ts

@@ -4,5 +4,13 @@ type DatePickerProps = {
     required: boolean;
     onChange: (date: string) => void;
 };
+/**
+ * Simple date input field using native HTML date input styled by Joy UI.
+ *
+ * @property {string} label - Field label.
+ * @property {string} defaultValue - Initial date value in YYYY-MM-DD format.
+ * @property {boolean} required - Whether the field is required.
+ * @property {(date: string) => void} onChange - Called with the ISO date string.
+ */
 declare const DatePickerComponent: React.FC<DatePickerProps>;
 export default DatePickerComponent;

package/src/components/Calendars/Duration.d.ts

@@ -7,5 +7,14 @@ type DurationProps = {
     onChangeFromDate: (date: string) => void;
     onChangeToDate: (date: string) => void;
 };
+/**
+ * A paired date range selector built from two DatePickerComponent instances.
+ *
+ * @property {object} labels - Custom labels.
+ * @property {boolean} required - Whether the fields are required.
+ * @property {string[]} defaultValue - Tuple-like [fromDate, toDate] values in YYYY-MM-DD.
+ * @property {(date: string) => void} onChangeFromDate - Handler for the "from" date.
+ * @property {(date: string) => void} onChangeToDate - Handler for the "to" date.
+ */
 declare const Duration: React.FC<DurationProps>;
 export default Duration;

package/src/components/Calendars/RangeCalendar.d.ts

@@ -7,5 +7,13 @@ type RangeCalendarProps = {
     required: boolean;
     onChange: (date: Sportal365SearchImagesFilters) => void;
 };
+/**
+ * Date range selector based on flatpickr, returning { from, to } in YYYY-MM-DD.
+ *
+ * @property {string} label - Field label.
+ * @property {import('../../models/sportal365/Sportal365SearchImagesFilters').default | null} defaultValue - Initial range.
+ * @property {boolean} required - Whether selection is required.
+ * @property {(date: import('../../models/sportal365/Sportal365SearchImagesFilters').default) => void} onChange - Called with the new range.
+ */
 declare const RangeCalendar: React.FC<RangeCalendarProps>;
 export default RangeCalendar;

package/src/components/Cards/NoPermissionCard.d.ts

@@ -5,5 +5,12 @@ type NoPermissionCardProps = {
     environment: string;
     setNoPermission: Dispatch<SetStateAction<boolean | null>>;
 };
+/**
+ * Information card displayed when the user lacks permission. Offers a sign-out to retry.
+ *
+ * @property {object} labels - Custom labels used for title, message, buttons.
+ * @property {string} environment - Firebase environment key used for auth.
+ * @property {React.Dispatch<React.SetStateAction<boolean | null>>} setNoPermission - Setter to reset the permission state.
+ */
 declare const NoPermissionCard: React.FC<NoPermissionCardProps>;
 export default NoPermissionCard;

package/src/components/Common/Toast.d.ts

@@ -7,5 +7,13 @@ type ToastProps = {
     color: ColorPaletteProp;
     hideToast: () => void;
 };
+/**
+ * Lightweight Snackbar wrapper to show brief messages in the top-right corner.
+ *
+ * @property {boolean} showToast - Controls visibility.
+ * @property {string} message - Message text.
+ * @property {import('@mui/joy').ColorPaletteProp} color - Color variant (e.g., 'primary', 'warning', 'danger').
+ * @property {() => void} hideToast - Called on close.
+ */
 declare const Toast: React.FC<ToastProps>;
 export default Toast;

package/src/components/Context/EntityContext.d.ts

@@ -6,5 +6,12 @@ type EntityContextProps = {
     context: ContextModel;
     onChange: (context: ContextModel) => void;
 };
+/**
+ * Tabs to manage entity context: tags, content, and campaign metadata.
+ *
+ * @property {object} labels - Custom labels for tabs and field labels (id, type, label etc.).
+ * @property {ContextModel} context - Current entity context value.
+ * @property {(context: ContextModel) => void} onChange - Emits updated context.
+ */
 declare const EntityContext: React.FC<EntityContextProps>;
 export default EntityContext;

package/src/components/DragAndDrop/BasicSortableList/BasicSortableList.d.ts

@@ -16,6 +16,13 @@ type SortableListProps = {
     };
     setItems: Dispatch<SetStateAction<any[]>>;
 };
+/**
+ * Sortable list with rich item cards; uses dnd-kit under the hood.
+ *
+ * @property {ISortableItem[]} items - Items to render and reorder.
+ * @property {{noItemsToDisplay:string, dragToReorder:string}} labels - Custom labels.
+ * @property {Dispatch<SetStateAction<any[]>>} setItems - Setter after reordering.
+ */
 /**
  * Enhanced sortable list using the `dnd-kit` library with improved UI/UX.
  * Features rich item cards with support for images, descriptions and types.

package/src/components/DragAndDrop/SortableList/SortableList.d.ts

@@ -8,11 +8,19 @@ type SortableListProps = {
     disabled?: boolean;
 };
 /**
+ * Draggable sortable list using dnd-kit. Renders items with optional type chips.
+ *
  * This component provides a sortable list using the `dnd-kit` library for drag-and-drop functionality.
  * Each item in the list can be dragged and dropped to reorder the list. The component is designed to be
  * adaptable for use in various projects and integrates with Joy UI for styling.
  * dnd-kit documentation: https://docs.dndkit.com/
  * Original implementation: https://codesandbox.io/p/sandbox/dnd-kit-sortable-starter-template-22x1ix
+ *
+ * @property {any[]} entities - Items to render (must contain id, title/name, optional type).
+ * @property {object} labels - Custom labels (expects removeEntity for tooltip).
+ * @property {Dispatch<SetStateAction<any[]>>} setEntities - Setter after reordering.
+ * @property {(id: string) => void} removeItem - Remove handler for an item.
+ * @property {boolean} [disabled] - Disable drag interactions.
  */
 declare const SortableList: React.FC<SortableListProps>;
 export default SortableList;

package/src/components/DynamicFields/DynamicFields.d.ts

@@ -6,5 +6,13 @@ type DynamicFieldsProps = {
     defaultValue: Record<string, string> | null;
     onChange: (value: Record<string, string>) => void;
 };
+/**
+ * Editable key/value list for custom attributes with add, edit, and delete actions.
+ *
+ * @property {object} labels - Custom labels for UI actions and field names.
+ * @property {string} type - Unique key to namespace items in the list.
+ * @property {Record<string,string>|null} defaultValue - Initial attributes object.
+ * @property {(value: Record<string,string>) => void} onChange - Emits remapped attributes object.
+ */
 declare const DynamicFields: React.FC<DynamicFieldsProps>;
 export default DynamicFields;

package/src/components/Exports/ExportUsersLeads.d.ts

@@ -14,5 +14,14 @@ type ExportUsersLeadsProps = {
         usersLeadsExportErrorMessage: string;
     };
 };
+/**
+ * Exports leads for a given entity to CSV via backend endpoint.
+ *
+ * @property {string} entityId - Target entity id.
+ * @property {string} entityType - Target entity type.
+ * @property {string} entityName - Used in filename for the export.
+ * @property {{exportUsersLeads:string, category:string, action:string, exportAllUsersLeads:string, exportAllUsersLeadsDescription:string, usersLeadsExportMessage:string, usersLeadsExportErrorMessage:string}} labels
+ * - I18n labels for UI and messages.
+ */
 declare const ExportUsersLeads: React.FC<ExportUsersLeadsProps>;
 export default ExportUsersLeads;

package/src/components/Flags/Flags.d.ts

@@ -7,5 +7,13 @@ type FlagsProps = {
     onChange: (flags: string[]) => void;
     sx?: SxProps;
 };
+/**
+ * Creatable multi-select for tags/flags with duplicates prevention and inline add via Enter/Tab.
+ *
+ * @property {object} labels - Custom labels (expects flagsPlaceholder, repeatedValueMessage).
+ * @property {string[]} flags - Current selected flags.
+ * @property {(flags: string[]) => void} onChange - Handler when flags change.
+ * @property {import('@mui/material').SxProps} [sx] - Container styles.
+ */
 declare const Flags: React.FC<FlagsProps>;
 export default Flags;

package/src/components/Images/ImageCard.d.ts

@@ -7,5 +7,14 @@ type ImageCardProps = {
     onChangeImages: (url: string) => void;
     clearImage: () => void;
 };
+/**
+ * Image picker card with upload, preview, crop, copy URL, and Sportal365 search integration.
+ *
+ * @property {object} labels - Custom labels for buttons and messages.
+ * @property {string} title - Card title.
+ * @property {string} image - Current image URL.
+ * @property {(url: string) => void} onChangeImages - Called with new image URL after upload/selection.
+ * @property {() => void} clearImage - Clear current image.
+ */
 declare const ImageCard: React.FC<ImageCardProps>;
 export default ImageCard;

package/src/components/Images/Images.d.ts

@@ -6,5 +6,12 @@ type ImagesProps = {
     defaultValue: ImagesModel | null;
     onChange: (value: any) => void;
 };
+/**
+ * Wrapper for selecting/uploading images (main + optional cover/mobile) using ImageCard.
+ *
+ * @property {object} labels - Custom labels used by the image cards.
+ * @property {import('../../models/images/Images').default | null} defaultValue - Initial images object.
+ * @property {(value: any) => void} onChange - Called when images object changes.
+ */
 declare const Images: React.FC<ImagesProps>;
 export default Images;

package/src/components/Images/MiniGamesImages.d.ts

@@ -6,5 +6,12 @@ type MiniGamesImagesProps = {
     defaultValue: ImagesModel | null;
     onChange: (value: any) => void;
 };
+/**
+ * Image pickers for mini-games (main + optional mobile), with collapsible section.
+ *
+ * @property {object} labels - Custom labels used in the cards.
+ * @property {ImagesModel | null} defaultValue - Initial images object.
+ * @property {(value: any) => void} onChange - Emits updated images object.
+ */
 declare const MiniGamesImages: React.FC<MiniGamesImagesProps>;
 export default MiniGamesImages;

package/src/components/Inputs/InformationInput/InformationInput.d.ts

@@ -11,5 +11,18 @@ type InformationInputProps = {
     endDecorator?: React.ReactNode;
     onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
 };
+/**
+ * Labeled single-line text input using Joy UI.
+ *
+ * @property {string} label - Field label.
+ * @property {string} placeholder - Placeholder text.
+ * @property {string} [value] - Controlled value.
+ * @property {string} defaultValue - Fallback/uncontrolled default value.
+ * @property {boolean} required - Whether the field is required.
+ * @property {'sm'|'md'|'lg'} size - Control size.
+ * @property {boolean} [readOnly=false] - Read-only mode.
+ * @property {React.ReactNode} [endDecorator] - Optional element inside the input at the end.
+ * @property {(e: React.ChangeEvent<HTMLInputElement>) => void} onChange - Change handler.
+ */
 declare const InformationInput: React.FC<InformationInputProps>;
 export default InformationInput;

package/src/components/Inputs/NumberInput/NumberInput.d.ts

@@ -10,5 +10,18 @@ type NumberInputProps = {
     sx?: SxProps;
     size?: 'sm' | 'md' | 'lg';
 };
+/**
+ * Numeric input with thousand separator formatting.
+ *
+ * Note: Free-typing is allowed to avoid blocking edits; values are clamped/validated by consumer logic.
+ *
+ * @property {string} label - Field label.
+ * @property {string} [description] - Helper text.
+ * @property {number} defaultValue - Initial numeric value.
+ * @property {(value: number) => void} onChange - Called with numeric value on change.
+ * @property {(values: NumberFormatValues) => boolean} [isAllowed] - Optional additional constraints.
+ * @property {import('@mui/material').SxProps} [sx] - Styles applied to Input.
+ * @property {'sm'|'md'|'lg'} [size='sm'] - Control size.
+ */
 declare const NumberInput: React.FC<NumberInputProps>;
 export default NumberInput;

package/src/components/ItemsPerPageFilter/ItemsPerPageFilter.d.ts

@@ -10,5 +10,16 @@ type ItemsPerPageFilterProps = {
     sx?: SxProps;
     onChange: (_: any, value: number | null) => void;
 };
+/**
+ * Small select for “items per page” pagination control.
+ *
+ * @property {object} labels - Custom labels (expects itemsPerPage).
+ * @property {number} value - Current selected items per page.
+ * @property {number[]} options - Available values.
+ * @property {'sm'|'md'|'lg'} [size='sm'] - Control size.
+ * @property {boolean} [disabled=false] - Disable control.
+ * @property {import('@mui/material').SxProps} [sx] - Style overrides.
+ * @property {(_: any, value: number | null) => void} onChange - Joy Select onChange signature.
+ */
 declare const ItemsPerPageFilter: React.FC<ItemsPerPageFilterProps>;
 export default ItemsPerPageFilter;

package/src/components/MarketSelection/MarketSelection.d.ts

@@ -6,5 +6,13 @@ type MarketSelectionProps = {
     valuesMap: Record<string, string>;
     onChange: (values: string[]) => void;
 };
+/**
+ * Market selection control with grouped checkboxes and “show all” behavior.
+ *
+ * @property {object} labels - Custom labels (expects marketSelection, marketSelectionDescription, showAll, etc.).
+ * @property {string[]} values - Currently selected market keys.
+ * @property {Record<string,string>} valuesMap - Map from market key to readable label.
+ * @property {(values: string[]) => void} onChange - Called when the selected markets change.
+ */
 declare const MarketSelection: React.FC<MarketSelectionProps>;
 export default MarketSelection;

package/src/components/Match/Match.d.ts

@@ -5,5 +5,11 @@ type MatchProps = {
     match: MatchBasicModel;
     timeFormat: string;
 };
+/**
+ * Compact match item with time and team logos.
+ *
+ * @property {MatchBasicModel} match - Match model containing teams and kickoff time.
+ * @property {string} timeFormat - Dayjs format string for kickoff display.
+ */
 declare const Match: React.FC<MatchProps>;
 export default Match;

package/src/components/Related/Related.d.ts

@@ -6,5 +6,12 @@ type RelatedProps = {
     related: RelatedEntity[];
     onChange: (related: RelatedEntity[]) => void;
 };
+/**
+ * Related entities control combining games and templates pickers.
+ *
+ * @property {object} labels - Custom labels with games/templates keys.
+ * @property {RelatedEntity[]} related - Current related entities.
+ * @property {(related: RelatedEntity[]) => void} onChange - Emits merged related list.
+ */
 declare const Related: React.FC<RelatedProps>;
 export default Related;

package/src/components/Related/RelatedRelationship/RelatedRelationship.d.ts

@@ -13,5 +13,12 @@ type RelatedRelationshipProps = {
         relatedEntitiesErrorMessage: string;
     };
 };
+/**
+ * Manage related entities with typed relationships and entity-type aware search.
+ *
+ * @property {RelatedRelationshipRequest[]} defaultValue - Initial related relationships list.
+ * @property {(entities: RelatedRelationshipRequest[]) => void} onChange - Emits updated related list.
+ * @property {{type:string, delete:string, relationship:string, entity:string, add:string, relatedEntitiesErrorMessage:string}} labels - I18n labels.
+ */
 declare const RelatedRelationship: React.FC<RelatedRelationshipProps>;
 export default RelatedRelationship;

package/src/components/RichText/RichText.d.ts

@@ -9,5 +9,16 @@ type RichTextProps = {
     description?: string;
     onChange: (value: string) => void;
 };
+/**
+ * Rich text editor built on ReactQuill with optional label and helper text.
+ *
+ * @property {string} label - Field label (used for specific properties like description/explanation).
+ * @property {string} placeholder - Placeholder for the editor.
+ * @property {string} [value] - Controlled value (falls back to defaultValue if not provided).
+ * @property {string} defaultValue - Initial HTML value.
+ * @property {'description'|'rules'|'ad_content'|'mini_games_explanation'} property - Target field behavior.
+ * @property {string} [description] - Helper text shown for specific properties.
+ * @property {(value: string) => void} onChange - Called with HTML string on user edits.
+ */
 declare const RichText: React.FC<RichTextProps>;
 export default RichText;

package/src/components/Schedule/Schedule.d.ts

@@ -6,5 +6,13 @@ type ScheduleProps = {
     entityType: string;
     readOnly?: boolean;
 };
+/**
+ * Scheduler list with create/update actions for entity status changes.
+ *
+ * @property {object} labels - Custom labels used for fields, buttons and messages.
+ * @property {string} entityId - Target entity id.
+ * @property {string} entityType - Target entity type.
+ * @property {boolean} [readOnly] - Disable edit controls.
+ */
 declare const Schedule: React.FC<ScheduleProps>;
 export default Schedule;

package/src/components/Select/BasicSelect/BasicSelect.d.ts

@@ -1,5 +1,14 @@
 import { default as React } from 'react';
 
+/**
+ * Simple select component for choosing one string value.
+ *
+ * @property {string} label - Field label.
+ * @property {string} defaultValue - Initial selected value.
+ * @property {string[]} values - List of options to pick from.
+ * @property {string} description - Helper text shown below the field.
+ * @property {(value: string) => void} onChange - Called with the selected value.
+ */
 type BasicSelectProps = {
     label: string;
     defaultValue: string;
@@ -7,5 +16,9 @@ type BasicSelectProps = {
     description: string;
     onChange: (value: string) => void;
 };
+/**
+ * Render a labeled select with provided options.
+ * @param {{ label: string; defaultValue: string; values: string[]; description: string; onChange: (value: string) => void }} props
+ */
 declare const BasicSelect: React.FC<BasicSelectProps>;
 export default BasicSelect;

package/src/components/Select/CustomSelect.d.ts

@@ -7,5 +7,14 @@ type CustomSelectProps = {
     required: boolean;
     onChange: (value: string) => void;
 };
+/**
+ * Select with avatar/icon and clear button, suitable for selecting an entity (competition, etc.).
+ *
+ * @property {string} label - Field label.
+ * @property {string} defaultValue - Currently selected id.
+ * @property {any[]} options - Options array; each option should have `id`, `name`, and optional `assets.logo`.
+ * @property {boolean} required - Whether the field is required.
+ * @property {(value: string) => void} onChange - Handler when selection changes.
+ */
 declare const CustomSelect: React.FC<CustomSelectProps>;
 export default CustomSelect;

package/src/components/Select/SearchSelect/AdvancedProfileSearchSelect.d.ts

@@ -5,5 +5,12 @@ type AdvancedProfileSearchSelectProps = {
     ids: string[];
     onChange: (ids: string[] | null) => void;
 };
+/**
+ * Multi-select profile search with toggleable search by name or id, with avatars.
+ *
+ * @property {object} labels - Custom labels (excludedProfilesPlaceholder, searchProfilesErrorMessage, searchByName, searchById).
+ * @property {string[]} ids - Initial selected profile ids.
+ * @property {(ids: string[] | null) => void} onChange - Emits selected ids or null when empty.
+ */
 declare const AdvancedProfileSearchSelect: React.FC<AdvancedProfileSearchSelectProps>;
 export default AdvancedProfileSearchSelect;

package/src/components/Select/SearchSelect/CompetitionSearchSelect.d.ts

@@ -7,5 +7,14 @@ type CompetitionSearchSelectProps = {
     required: boolean;
     onChange: (ids: string[]) => void;
 };
+/**
+ * Single-select competition search with debounce and Joy Autocomplete.
+ *
+ * @property {object} labels - Custom labels (competitionsSelectionPlaceholder, searchCompetitionsErrorMessage).
+ * @property {string} label - Field label displayed above the control.
+ * @property {string[]} ids - Initial selected competition id array (first taken).
+ * @property {boolean} required - Whether selection is required.
+ * @property {(ids: string[]) => void} onChange - Emits a single selected id array or empty array.
+ */
 declare const CompetitionSearchSelect: React.FC<CompetitionSearchSelectProps>;
 export default CompetitionSearchSelect;

package/src/components/Select/SearchSelect/CompetitionsSearchSelect.d.ts

@@ -6,5 +6,13 @@ type CompetitionsSearchSelectProps = {
     scope?: string[];
     onChange: (ids: string[] | null) => void;
 };
+/**
+ * Multi-select competitions search with optional scope filter.
+ *
+ * @property {object} labels - Custom labels (competitionsSelectionPlaceholder, searchCompetitionsErrorMessage).
+ * @property {string[]} ids - Initial selected competition ids.
+ * @property {string[]} [scope] - Optional competitions scope to limit results.
+ * @property {(ids: string[] | null) => void} onChange - Emits selected ids or null when empty.
+ */
 declare const CompetitionsSearchSelect: React.FC<CompetitionsSearchSelectProps>;
 export default CompetitionsSearchSelect;

package/src/components/Select/SearchSelect/ContextSelectFilter.d.ts

@@ -9,5 +9,14 @@ type ContextSelectFilterProps = {
     setFilters: Dispatch<SetStateAction<any>>;
     handleResetData: () => void;
 };
+/**
+ * Search filter for football context entities (competitions, teams, players) with grouping.
+ *
+ * @property {object} labels - Custom labels (contextEntityTag, typeContextTagNamePlaceholder).
+ * @property {GroupSelectOption[]} options - Currently selected options.
+ * @property {Dispatch<SetStateAction<MultiValue<GroupSelectOption>>>} setOptions - Setter for selected options.
+ * @property {Dispatch<SetStateAction<any>>} setFilters - Updates upstream filters with selected entityIds.
+ * @property {() => void} handleResetData - Callback to reset data when selection changes.
+ */
 declare const ContextSelectFilter: React.FC<ContextSelectFilterProps>;
 export default ContextSelectFilter;

package/src/components/Select/SearchSelect/ProfileSearchSelect.d.ts

@@ -5,5 +5,12 @@ type ProfileSearchSelectProps = {
     ids: string[];
     onChange: (ids: string[] | null) => void;
 };
+/**
+ * Multi-select profiles search with debounce and avatar chip tags.
+ *
+ * @property {object} labels - Custom labels (expects excludedProfilesPlaceholder, searchProfilesErrorMessage).
+ * @property {string[]} ids - Initial selected profile ids.
+ * @property {(ids: string[] | null) => void} onChange - Emits selected ids or null when empty.
+ */
 declare const ProfileSearchSelect: React.FC<ProfileSearchSelectProps>;
 export default ProfileSearchSelect;

package/src/components/Select/SearchSelect/TeamsSearchSelect.d.ts

@@ -6,5 +6,13 @@ type TeamsSearchSelectProps = {
     scope: string[] | undefined;
     onChange: (ids: string[] | null) => void;
 };
+/**
+ * Multi-select teams search with optional competitions scope.
+ *
+ * @property {object} labels - Custom labels (teamsSelectionPlaceholder, searchTeamsErrorMessage).
+ * @property {string[]} ids - Initial selected team ids.
+ * @property {string[]} [scope] - Optional competitions scope.
+ * @property {(ids: string[] | null) => void} onChange - Emits selected ids or null when empty.
+ */
 declare const TeamsSearchSelect: React.FC<TeamsSearchSelectProps>;
 export default TeamsSearchSelect;

package/src/components/Spinner/Spinner.d.ts

@@ -3,5 +3,10 @@ import { default as React } from 'react';
 type SpinnerProps = {
     my: number;
 };
+/**
+ * Centered loading spinner that fills its container.
+ *
+ * @property {number} my - Vertical margin (theme spacing units) applied to the container.
+ */
 declare const Spinner: React.FC<SpinnerProps>;
 export default Spinner;

package/src/components/Switch/BooleanSwitch.d.ts

@@ -15,5 +15,17 @@ type BooleanSwitchProps = {
     };
     onChange: (checked: boolean) => void;
 };
+/**
+ * Labeled boolean toggle with optional description.
+ *
+ * @property {string} label - Label displayed next to the switch.
+ * @property {'start'|'end'} [labelPosition='start'] - Where to place the switch relative to the label.
+ * @property {boolean} defaultValue - Initial checked state.
+ * @property {string} description - Optional helper text shown under the label.
+ * @property {import('@mui/joy').ColorPaletteProp} descriptionColor - Color of the helper text.
+ * @property {boolean} disabled - Disables interaction.
+ * @property {{ switch?: import('@mui/material').SxProps; container?: import('@mui/material').SxProps }} [sx] - Style overrides.
+ * @property {(checked: boolean) => void} onChange - Called when the switch is toggled.
+ */
 declare const BooleanSwitch: React.FC<BooleanSwitchProps>;
 export default BooleanSwitch;

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

@@ -16,7 +16,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;