@memobit/libs 3.4.3 → 3.6.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Component } from 'react';
+import { ComponentType } from 'react';
 import { Context } from 'react';
 import { CSSProperties } from 'react';
 import { default as default_2 } from 'react';
@@ -8,13 +9,14 @@ import { FocusEvent as FocusEvent_2 } from 'react';
 import { ForwardRefExoticComponent } from 'react';
 import { getThemeConfig } from '@memobit/themes';
 import { IconName } from '@memobit/icons';
-import { JSX } from 'react/jsx-runtime';
+import { JSX } from 'react';
 import { KeyboardEvent as KeyboardEvent_2 } from 'react';
 import { MouseEvent as MouseEvent_2 } from 'react';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
 import { ReactPortal } from 'react';
 import { RefAttributes } from 'react';
+import { SyntheticEvent } from 'react';
 import { THEME_CONFIGS } from '@memobit/themes';
 import { ThemeConfig } from '@memobit/themes';
 import { TouchEvent as TouchEvent_2 } from 'react';
@@ -37,6 +39,11 @@ export declare interface AccordionProps {
     className?: string;
 }
 
+declare interface AccountMenuModalProps {
+    isOpen: boolean;
+    onClose: () => void;
+}
+
 /**
  * Adds days to a date
  */
@@ -104,6 +111,25 @@ export declare interface AngleSliderProps {
 
 export declare type AngleSliderVariant = 'accent' | 'info' | 'success' | 'warning' | 'danger';
 
+export declare interface ApiClient {
+    get: <T>(path: string) => Promise<T>;
+    post: <T, P = unknown>(path: string, payload?: P) => Promise<T>;
+    put: <T, P = unknown>(path: string, payload?: P) => Promise<T>;
+    patch: <T, P = unknown>(path: string, payload?: P) => Promise<T>;
+    delete: <T>(path: string) => Promise<T>;
+    upload: <T>(path: string, formData: FormData) => Promise<T>;
+}
+
+export declare interface ApiClientConfig {
+    baseUrl: string;
+    loginPath?: string;
+}
+
+export declare class ApiError extends Error {
+    readonly status: number;
+    constructor(message: string, status: number);
+}
+
 export declare const APP_DATE_FORMAT = "DD MMM YYYY";
 
 export declare const APP_DATE_TIME_FORMAT = "DD MMM YYYY HH:mm";
@@ -126,6 +152,8 @@ export declare interface AppHeaderProps {
     showSeparator?: boolean;
 }
 
+export declare const applyImageFallback: (event: SyntheticEvent<HTMLImageElement>, categoryKey?: string) => void;
+
 export declare interface AppPersistenceDefaults<TPages, TTheme> {
     pages?: TPages;
     theme: TTheme;
@@ -164,7 +192,7 @@ export declare interface AuthContextValue {
 
 export declare function AuthLogin({ redirectPath }: LoginProps): ReactElement;
 
-export declare function AuthProvider({ children, config }: AuthProviderProps): JSX.Element;
+export declare function AuthProvider({ children, config }: AuthProviderProps): default_2.JSX.Element;
 
 declare interface AuthProviderProps {
     children: default_2.ReactNode;
@@ -303,6 +331,8 @@ export declare const breakpoints: {
     };
 };
 
+export declare const buildRequestHeaders: (method: HttpMethod, json?: boolean) => Record<string, string>;
+
 export declare interface BulkAction {
     key: string;
     label: string;
@@ -479,6 +509,20 @@ declare interface ChangePasswordModalProps {
     onClose: () => void;
 }
 
+export declare const chartColors: {
+    readonly axis: "var(--body-color-muted)";
+    readonly grid: "var(--border-color)";
+    readonly text: "var(--body-color)";
+};
+
+declare interface ChartTooltipStyle {
+    contentStyle: CSSProperties;
+    itemStyle: CSSProperties;
+    labelStyle: CSSProperties;
+}
+
+export declare const chartTooltipStyle: ChartTooltipStyle;
+
 export declare const Checkbox: FC<CheckboxProps>;
 
 declare interface CheckboxProps {
@@ -512,6 +556,8 @@ export declare type ChipSize = 'xsmall' | 'small' | 'medium' | 'large';
 
 export declare type ChipVariant = 'plain' | 'default' | 'success' | 'info' | 'warning' | 'danger';
 
+export declare const clamp: (value: number, min: number, max: number) => number;
+
 export declare const Col: FC<ColProps>;
 
 export declare const CollapsibleSection: default_2.FC<CollapsibleSectionProps>;
@@ -977,7 +1023,17 @@ declare interface CountryWithFlagProps {
     className?: string;
 }
 
-declare function DataView_2<T>({ columns, data, rowKey, pinnedIds, selectable, onSelectionChange, selectedIds: controlledSelectedIds, pageSizeOptions, initialPageSize, showPageSize, card, actions, actionsWidth, timeline, onRowClick, rowHref, rowClassName, rowDetail, empty, initialSortKey, initialSortDirection, sortKey: controlledSortKey, sortDirection: controlledSortDirection, onSortChange, miniSort, showCardSortControls, desktopView, cardMaxWidth, className, onPageChange, onPageSizeChange, currentPage: controlledCurrentPage, totalItems: controlledTotalItems, group, showResultsCount, totalCount, itemNoun, columnSelector, }: DataViewProps<T>): JSX.Element;
+/**
+ * Cookie-session API client shared by the memobit apps: sends credentials, adds the CSRF
+ * header on mutating requests, surfaces the server's `error` message, and on 401 navigates
+ * to the login page. The 401 path returns a promise that never settles so callers don't
+ * flash an error toast while the browser is already leaving the page.
+ */
+export declare const createApiClient: ({ baseUrl, loginPath }: ApiClientConfig) => ApiClient;
+
+export declare const CSRF_HEADER = "X-CSRF-Token";
+
+declare function DataView_2<T>({ columns, data, rowKey, pinnedIds, selectable, onSelectionChange, selectedIds: controlledSelectedIds, pageSizeOptions, initialPageSize, showPageSize, card, actions, actionsWidth, timeline, onRowClick, rowHref, rowClassName, rowDetail, empty, initialSortKey, initialSortDirection, sortKey: controlledSortKey, sortDirection: controlledSortDirection, onSortChange, miniSort, showCardSortControls, desktopView, cardMaxWidth, className, onPageChange, onPageSizeChange, currentPage: controlledCurrentPage, totalItems: controlledTotalItems, group, showResultsCount, totalCount, itemNoun, columnSelector, }: DataViewProps<T>): default_2.JSX.Element;
 export { DataView_2 as DataView }
 
 export declare interface DataViewCardConfig<T> {
@@ -1646,11 +1702,26 @@ export declare const formatSecondsToMediaTime: (seconds: number | undefined) =>
 
 export declare const fuzzyMatch: (text: string, query: string) => boolean;
 
+export declare const getCategoryImageUrl: (categoryKey: string) => string;
+
+export declare const getCsrfToken: () => string | null;
+
 /**
  * Gets the number of days in a specific month
  */
 export declare const getDaysInMonth: (year: number, month: number) => number;
 
+export declare const getDefaultImageUrl: () => string;
+
+/**
+ * Resolves what an <img> should show for a stored image value:
+ * - a File (new, unsaved upload) → a blob URL
+ * - a full URL, blob URL or already-prefixed path → unchanged
+ * - empty → the category fallback, else the app default
+ * - a bare filename → its path under specific/
+ */
+export declare const getImageUrl: (filename: string | File, categoryKey?: string) => string;
+
 export declare const getIndicatorColor: (bmi: number, ranges: BMIRange[]) => string;
 
 export declare const getIndicatorPosition: (bmi: number, ranges: BMIRange[]) => number;
@@ -1668,6 +1739,8 @@ export declare const getIsoWeek: (date: Date) => number;
  */
 export declare const getMonthMatrix: (year: number, month: number, firstDayOfWeek?: 0 | 1) => Date[][];
 
+export declare const getNextImageFallback: (currentSrc: string, categoryKey?: string) => string | null;
+
 export declare const getPediatricRanges: (p5: number, p85: number, p95: number) => BMIRange[];
 
 export declare const getPercent: (value: number, total: number) => number;
@@ -1735,6 +1808,54 @@ export declare const htmlToMarkdown: (html: string) => string;
  */
 export declare const htmlToPlainText: (html: string | undefined | null) => string;
 
+export declare const HttpMethod: {
+    readonly Get: "GET";
+    readonly Post: "POST";
+    readonly Put: "PUT";
+    readonly Patch: "PATCH";
+    readonly Delete: "DELETE";
+};
+
+export declare type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];
+
+export declare const HttpStatus: {
+    readonly Continue: 100;
+    readonly SwitchingProtocols: 101;
+    readonly Ok: 200;
+    readonly Created: 201;
+    readonly Accepted: 202;
+    readonly NoContent: 204;
+    readonly PartialContent: 206;
+    readonly MovedPermanently: 301;
+    readonly Found: 302;
+    readonly SeeOther: 303;
+    readonly NotModified: 304;
+    readonly TemporaryRedirect: 307;
+    readonly PermanentRedirect: 308;
+    readonly BadRequest: 400;
+    readonly Unauthorized: 401;
+    readonly PaymentRequired: 402;
+    readonly Forbidden: 403;
+    readonly NotFound: 404;
+    readonly MethodNotAllowed: 405;
+    readonly NotAcceptable: 406;
+    readonly RequestTimeout: 408;
+    readonly Conflict: 409;
+    readonly Gone: 410;
+    readonly PayloadTooLarge: 413;
+    readonly UnsupportedMediaType: 415;
+    readonly UnprocessableEntity: 422;
+    readonly Locked: 423;
+    readonly TooManyRequests: 429;
+    readonly InternalServerError: 500;
+    readonly NotImplemented: 501;
+    readonly BadGateway: 502;
+    readonly ServiceUnavailable: 503;
+    readonly GatewayTimeout: 504;
+};
+
+export declare type HttpStatus = (typeof HttpStatus)[keyof typeof HttpStatus];
+
 export declare const Icon: default_2.FC<IconProps>;
 
 /**
@@ -1785,6 +1906,8 @@ export declare type IconSize = 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl';
 
 export declare type IconVariant = 'default' | 'muted' | 'accent' | 'info' | 'success' | 'warning' | 'danger';
 
+export declare const IMAGES_BASE_PATH = "/data-files/images";
+
 export declare const InfiniteScroll: ({ children, onLoadMore, hasMore, isLoading, threshold, rootMargin, height, onScrollChange, endMessage, className, }: InfiniteScrollProps) => JSX.Element;
 
 declare interface InfiniteScrollProps {
@@ -2153,6 +2276,8 @@ export declare const isAfter: (date: Date, compareDate: Date) => boolean;
  */
 export declare const isBefore: (date: Date, compareDate: Date) => boolean;
 
+export declare const isClientErrorStatus: (status: number) => boolean;
+
 /**
  * Checks if a date is within a range (inclusive)
  */
@@ -2163,6 +2288,10 @@ export declare const isDateInRange: (date: Date, start: Date, end: Date) => bool
  */
 export declare const isSameDay: (date1: Date, date2: Date) => boolean;
 
+export declare const isServerErrorStatus: (status: number) => boolean;
+
+export declare const isSuccessStatus: (status: number) => boolean;
+
 /**
  * Checks if a date is today
  */
@@ -2676,7 +2805,9 @@ declare interface RatingProps {
 
 export declare type RatingVariant = 'success' | 'info' | 'warning' | 'danger';
 
-export declare const RichTextEditor: ({ advanced, error, format, id, label, onBlur, onChange, placeholder, required, value, }: RichTextEditorProps) => JSX.Element;
+export declare const readErrorMessage: (response: Response) => Promise<string>;
+
+export declare const RichTextEditor: ({ advanced, error, format, id, label, onBlur, onChange, placeholder, required, value, }: RichTextEditorProps) => default_2.JSX.Element;
 
 declare interface RichTextEditorProps {
     advanced?: boolean;
@@ -3178,7 +3309,7 @@ export declare interface ToastAction {
     onClick: () => void;
 }
 
-export declare const ToastContainer: ({ position, showDismissButton }: ToastContainerProps) => JSX.Element;
+export declare const ToastContainer: ({ position, showDismissButton }: ToastContainerProps) => default_2.JSX.Element;
 
 export declare type ToastContainerPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'top' | 'bottom' | 'left' | 'right';
 
@@ -3435,6 +3566,22 @@ declare type TreeVariant = 'default' | 'info' | 'success' | 'warning' | 'danger'
 
 export declare const truncateText: (text: string, maxLength?: number, separator?: string) => string;
 
+export declare const useAccountMenu: ({ appName, mfaModal: MfaModal, themeLabel, loginPath }: UseAccountMenuOptions) => UseAccountMenuReturn;
+
+export declare interface UseAccountMenuOptions {
+    appName: string;
+    mfaModal?: ComponentType<AccountMenuModalProps>;
+    themeLabel?: string;
+    loginPath?: string;
+}
+
+export declare interface UseAccountMenuReturn {
+    themeItem: MenuHamburgerItem;
+    accountItems: MenuHamburgerItem[];
+    items: MenuHamburgerItem[];
+    modals: ReactElement;
+}
+
 export declare function useAppPersistence<TPages, TTheme>(appId: string, defaults: AppPersistenceDefaults<TPages, TTheme>): UseAppPersistenceReturn<TPages, TTheme>;
 
 export declare interface UseAppPersistenceReturn<TPages, TTheme> {