@flipdish/ui-library 0.2.1 → 0.3.0

package/dist/src/components/templates/PageLayout/index.d.ts

@@ -1,43 +0,0 @@
-import type { ErrorInfo, ReactNode } from 'react';
-export interface PageLayoutProps {
-    /**
-     * Stable, human-readable name of the page (e.g. "CollectionSettings"). Tags the
-     * page-level error boundary so a thrown error can be attributed to a specific page
-     * in logs/RUM, and is forwarded to `renderError` and `onError`.
-     */
-    pageName: string;
-    /**
-     * Header region. Compose `<PageHeader.Simple>` (or a feature wrapper around it)
-     * here. Rendered OUTSIDE the error boundary so page chrome (breadcrumbs, back link)
-     * stays usable when the content below throws.
-     */
-    header?: ReactNode;
-    /** Page content, rendered INSIDE the error boundary. */
-    children: ReactNode;
-    /**
-     * Replaces the default fallback shown when a child throws. Receives the thrown
-     * error and `pageName` so consumers can render localised copy.
-     */
-    renderError?: (props: {
-        error: Error;
-        pageName: string;
-    }) => ReactNode;
-    /** Called when a child throws — wire app-level reporting (e.g. Datadog RUM) here. */
-    onError?: (error: Error, info: ErrorInfo) => void;
-    /** Extra classes merged onto the root `<main>`. */
-    className?: string;
-}
-/**
- * Page-shaped template that standardises the MFE's page chrome: the centered `<main>`
- * scroll container, an optional header region, and a page-scoped error boundary keyed
- * by `pageName`. Consumers drop their page content in as children.
- *
- * The boundary wraps `children` only, not the header: content (data-fetching, forms,
- * dynamic logic) is where throws realistically happen, and keeping the header outside
- * means breadcrumbs/back link stay usable so the user can navigate away when content
- * fails — strictly better than blanking the whole page. A header throw (rare, since
- * it's static chrome) isn't caught here, but the app-level ErrorBoundary higher up the
- * tree still catches it; nothing goes unhandled.
- */
-export declare const PageLayout: ({ pageName, header, children, renderError, onError, className }: PageLayoutProps) => ReactNode;
-//# sourceMappingURL=index.d.ts.map

package/dist/src/components/templates/PageLayout/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/templates/PageLayout/index.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElD,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,wDAAwD;IACxD,QAAQ,EAAE,SAAS,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAC;IACvE,qFAAqF;IACrF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IAClD,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAcD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAI,iEAAiE,eAAe,KAAG,SAU7G,CAAC"}

package/dist/src/hooks/useResizeObserver/index.d.ts

@@ -1,25 +0,0 @@
-import { type RefObject } from 'react';
-/**
- * The options for the useResizeObserver hook.
- */
-type useResizeObserverOptionsType<T> = {
-    /**
-     * The ref to the element to observe.
-     */
-    ref: RefObject<T | undefined | null> | undefined;
-    /**
-     * The box to observe.
-     */
-    box?: ResizeObserverBoxOptions;
-    /**
-     * The callback function to call when the size changes.
-     */
-    onResize: () => void;
-};
-/**
- * A hook that observes the size of an element and calls a callback function when the size changes.
- * @param options - The options for the hook.
- */
-export declare function useResizeObserver<T extends Element>(options: useResizeObserverOptionsType<T>): void;
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/src/hooks/useResizeObserver/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useResizeObserver/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAa,MAAM,OAAO,CAAC;AAUlD;;GAEG;AACH,KAAK,4BAA4B,CAAC,CAAC,IAAI;IACrC;;OAEG;IACH,GAAG,EAAE,SAAS,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,GAAG,CAAC,EAAE,wBAAwB,CAAC;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC,QAiC5F"}

package/dist/src/providers/ErrorBoundary/index.d.ts

@@ -1,32 +0,0 @@
-import type { ErrorInfo, ReactNode } from 'react';
-export interface ErrorBoundaryProps {
-    /** Identifies this boundary in error logs/RUM (e.g. a page or feature name). */
-    identifier: string;
-    children: ReactNode;
-    /** Static fallback node. Takes precedence over `somethingWentWrongText`. */
-    fallback?: ReactNode;
-    /** Error-aware fallback. Takes precedence over `fallback` and `somethingWentWrongText`. */
-    renderFallback?: (error: Error) => ReactNode;
-    /**
-     * Text for the default centered fallback.
-     * TODO(i18n): source from ui-library's own translation layer once it exists; until
-     * then the consumer passes localised copy (defaults to English).
-     */
-    somethingWentWrongText?: string;
-    /** Forwarded after the built-in log — wire app reporting (fdlogger/Datadog) here. */
-    onError?: (error: Error, info: ErrorInfo) => void;
-    /** Classes merged onto the default fallback container. */
-    className?: string;
-}
-/**
- * Thin wrapper around `react-error-boundary` so consuming apps depend on a single
- * ui-library seam instead of importing `react-error-boundary` directly. Inspired by
- * FlipdishUI's `FDErrorBoundary`, minus the MUI styling and the hardcoded web logger
- * (reporting is injected via `onError` to keep the library cross-platform).
- *
- * Lives under `providers/` (not the visual atomic ladder) because it's a cross-cutting
- * behavioural wrapper, not a UI primitive. The boundary logic is RN-safe; the default
- * fallback renders a `<div>`, so an `index.native.tsx` sibling is needed before RN use.
- */
-export declare const ErrorBoundary: ({ identifier, children, fallback, renderFallback, somethingWentWrongText, onError, className, }: ErrorBoundaryProps) => ReactNode;
-//# sourceMappingURL=index.d.ts.map

package/dist/src/providers/ErrorBoundary/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/providers/ErrorBoundary/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlD,MAAM,WAAW,kBAAkB;IACjC,gFAAgF;IAChF,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,SAAS,CAAC;IACpB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,2FAA2F;IAC3F,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,SAAS,CAAC;IAC7C;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,qFAAqF;IACrF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IAClD,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GAAI,iGAQ3B,kBAAkB,KAAG,SAoBvB,CAAC"}

package/dist/src/utilities/cx/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * Merge Tailwind class strings, resolving conflicts (last value wins). Accepts the
- * same inputs as tailwind-merge — strings, arrays, and falsy values for
- * conditionals — so it composes cleanly:
- *
- *   cx('px-2', isActive && 'bg-primary', ['text-sm', null]);
- *
- * Pure JS with no DOM dependency, so the same helper works on web (PostCSS) and
- * React Native (NativeWind). Imported by components as
- * `@flipdish/ui-library/utilities/cx`.
- */
-export declare const cx: (...classLists: import("tailwind-merge").ClassNameValue[]) => string;
-type ClassValue = string | number;
-type ClassDefinition = Record<string, ClassValue | Record<string, ClassValue | Record<string, ClassValue>>>;
-/**
- * Identity helper that exists only so Tailwind IntelliSense recognises and sorts
- * the class strings held inside style-config objects (e.g. `tailwind-variants`
- * slot maps). Returns its argument unchanged.
- */
-export declare const sortCx: <T extends ClassDefinition>(classes: T) => T;
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/src/utilities/cx/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utilities/cx/index.ts"],"names":[],"mappings":"AAkBA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,EAAE,sEAAU,CAAC;AAE1B,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAClC,KAAK,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;AAE5G;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,eAAe,EAAE,SAAS,CAAC,KAAG,CAAY,CAAC"}

package/dist/src/utilities/isReactComponent/index.d.ts

@@ -1,24 +0,0 @@
-import type React from 'react';
-type ReactComponent = React.FC<any> | React.ComponentClass<any, any>;
-/**
- * Backs Untitled UI's `@/utils/is-react-component` import.
- *
- * Distinguishes a component passed as a prop (an icon `FC`, class component, or
- * `forwardRef` object you instantiate) from an already-rendered element
- * (handled via React's `isValidElement`). Untitled UI icon props accept either
- * form; these guards select the "render it yourself" branch.
- *
- * Pure JS with no DOM dependency — works on web (PostCSS) and React Native
- * (NativeWind). Imported by components as
- * `@flipdish/ui-library/utilities/isReactComponent`.
- */
-/** Checks if a given value is a function component. */
-export declare const isFunctionComponent: (component: any) => component is React.FC<any>;
-/** Checks if a given value is a class component. */
-export declare const isClassComponent: (component: any) => component is React.ComponentClass<any, any>;
-/** Checks if a given value is a forward ref component. */
-export declare const isForwardRefComponent: (component: any) => component is React.ForwardRefExoticComponent<any>;
-/** Checks if a given value is a valid React component (FC, class, or forwardRef). */
-export declare const isReactComponent: (component: any) => component is ReactComponent;
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/src/utilities/isReactComponent/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utilities/isReactComponent/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,KAAK,cAAc,GAAG,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAErE;;;;;;;;;;;GAWG;AAEH,uDAAuD;AAEvD,eAAO,MAAM,mBAAmB,GAAI,WAAW,GAAG,KAAG,SAAS,IAAI,KAAK,CAAC,EAAE,CAAC,GAAG,CAE7E,CAAC;AAEF,oDAAoD;AAEpD,eAAO,MAAM,gBAAgB,GAAI,WAAW,GAAG,KAAG,SAAS,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAE3F,CAAC;AAEF,0DAA0D;AAE1D,eAAO,MAAM,qBAAqB,GAAI,WAAW,GAAG,KAAG,SAAS,IAAI,KAAK,CAAC,yBAAyB,CAAC,GAAG,CAEtG,CAAC;AAEF,qFAAqF;AAErF,eAAO,MAAM,gBAAgB,GAAI,WAAW,GAAG,KAAG,SAAS,IAAI,cAE9D,CAAC"}

package/dist/src/utilities/renderUtils/index.d.ts

@@ -1,56 +0,0 @@
-/**
- * Retrieves an environment variable.
- *
- * @param key The key of the environment variable to retrieve.
- * @returns The value of the environment variable.
- */
-export declare const getEnvironmentVariable: (key: string) => string;
-/**
- * Retrieves a micro-frontend attribute.
- *
- * @param key The key of the attribute to retrieve.
- * @returns The value of the attribute.
- */
-export declare const getMicroFrontendAttribute: (key: string) => string;
-/**
- * Retrieves the AppId.
- *
- * Attempts to get the value from the environment variable `VITE_APPID_OVERRIDE`.
- * If the environment variable is not set, it falls back to retrieving from a micro frontend attribute `data-app-id`.
- * Fallbacks to `data-appid` for backwards compatibility @flipdish/portal-library@5.1.0 and below
- *
- * @warning Your component will not re-render if the value changes. Use 'useMicroFrontendAttributes' custom hook instead if you care about reactivity.
- */
-export declare const getAppId: () => string;
-/**
- * Retrieves the OrgId.
- *
- * Attempts to get the value from the environment variable `VITE_ORGID_OVERRIDE`.
- * If the environment variable is not set, it falls back to retrieving from a micro frontend attribute `data-org-id`.
- * Fallbacks to `data-orgid` for backwards compatibility @flipdish/portal-library@5.1.0 and below
- *
- * @warning Your component will not re-render if the value changes. Use 'useMicroFrontendAttributes' custom hook instead if you care about reactivity.
- */
-export declare const getOrgId: () => string;
-/**
- * Retrieves the BrandId.
- *
- * Attempts to get the value from the environment variable `VITE_BRANDID_OVERRIDE`.
- * If the environment variable is not set, it falls back to retrieving from a micro frontend attribute `data-brand-id`.
- * Fallbacks to `data-brandid` for backwards compatibility @flipdish/portal-library@5.1.0 and below
- *
- * @warning Your component will not re-render if the value changes. Use 'useMicroFrontendAttributes' custom hook instead if you care about reactivity.
- */
-export declare const getBrandId: () => string;
-/**
- * Retrieves the isFlipdishStaff attribute.
- *
- * Attempts to get the value from the environment variable `VITE_ISFLIPDISHSTAFFOVERRIDE`.
- * If the environment variable is not set, it falls back to retrieving from a micro frontend attribute `data-is-flipdish-staff`.
- * Fallbacks to `data-isflipdishstaff` for backwards compatibility @flipdish/portal-library@5.1.0 and below
- *
- * @warning Your component will not re-render if the value changes. Use 'useMicroFrontendAttributes' custom hook instead if you care about reactivity.
- */
-export declare const getIsFlipdishStaff: () => boolean;
-export declare const lazyWithRetry: (componentImport: () => any) => import("react").LazyExoticComponent<import("react").ComponentType<any>>;
-//# sourceMappingURL=index.d.ts.map

package/dist/src/utilities/renderUtils/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utilities/renderUtils/index.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,MAAM,KAAG,MAgBpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAAI,KAAK,MAAM,KAAG,MAMvD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,QAAO,MAE3B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,QAAO,MAE3B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,QAAO,MAE7B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,QAAO,OAMrC,CAAC;AAGF,eAAO,MAAM,aAAa,GAAI,iBAAiB,MAAM,GAAG,4EAsBpD,CAAC"}