@availity/mui-spaces 0.2.6 → 0.3.0

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.3.0](https://github.com/Availity/element/compare/@availity/mui-spaces@0.2.6...@availity/mui-spaces@0.3.0) (2024-07-19)
+
+### Dependency Updates
+
+* `@availity/mock` updated to version `0.2.6`
+* `mui-list` updated to version `0.2.6`
+
+### Features
+
+* **mui-spaces:** init commit for SpacesLink ([0c225ff](https://github.com/Availity/element/commit/0c225ff1e51061b63bc0237b1ecdb9e868d31d8c))
+
+
+### Bug Fixes
+
+* **mui-spaces:** updateUrl additionalParams ([8043679](https://github.com/Availity/element/commit/8043679cdf33e0970765c1ae1587c2981bab76bb))
+
 ## [0.2.6](https://github.com/Availity/element/compare/@availity/mui-spaces@0.2.5...@availity/mui-spaces@0.2.6) (2024-07-01)
 
 ### Dependency Updates

package/dist/index.d.mts

@@ -1,5 +1,122 @@
 import * as react from 'react';
+import { ChipProps } from '@mui/material/Chip';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
+type StatusChipProps = {
+    /** The color of the component.
+     * @default default */
+    color?: 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning';
+} & Omit<ChipProps, 'avatar' | 'children' | 'color' | 'variant' | 'skipFocusWhenDisabled' | 'disabled' | 'size' | 'icon' | 'clickable' | 'deleteIcon' | 'onDelete'>;
+
+type SpacesLinkVariants = 'card' | 'list' | 'default' | undefined;
+type SpacesLinkWithSpace = {
+    /** If no spaceId is provided, the first space in the spaces array is used.
+     * Note: This is only to be used when the Spaces provider should only ever contain a single space.
+     */
+    spaceId?: string;
+    /** Use to directly pass a space to the component rather than have it fetched from the spaces API.
+     * This component does not have to be a child of SpacesProvider.
+     * Note: If you are wanting to take advantage of the sso links you will additionally need to pass the clientId in.
+     */
+    space: Space | SsoTypeSpace;
+} & SpacesLinkProps;
+type SpacesLinkWithSpaceId = {
+    /** If no spaceId is provided, the first space in the spaces array is used.
+     * Note: This is only to be used when the Spaces provider should only ever contain a single space.
+     */
+    spaceId: string;
+    /** Use to directly pass a space to the component rather than have it fetched from the spaces API.
+     * This component does not have to be a child of SpacesProvider.
+     * Note: If you are wanting to take advantage of the sso links you will additionally need to pass the clientId in.
+     */
+    space?: Space | SsoTypeSpace;
+} & SpacesLinkProps;
+type SpacesLinkProps = {
+    /** Children can be a react child or render prop. */
+    children?: JSX.Element | ((props: any | undefined) => JSX.Element);
+    /** Tag to overwrite the root component rendered. */
+    tag?: string;
+    /** Tag to overwrite the body component that renders the title, description and data values.
+     * It defaults to CardBody or div depending on the value of the variant prop.
+     */
+    bodyTag?: string;
+    /** Tag to overwrite the title component. If variant prop is set to "card", defaults to CardTitle.
+     * If variant is set to "list", defaults to ListItemHeading. Overwise, defaults to div.
+     */
+    titleTag?: string;
+    /** Tag to overwrite the text component. If variant prop is set to "card", defaults to Card Text.
+     * If variant is set to "list", defaults to ListItemText. Otherwise, defaults to div.
+     */
+    textTag?: string;
+    titleClassName?: string;
+    /** When true, utilizes the Card component for styling. */
+    card?: boolean;
+    /** When true, renders an @availity/mui-icon next to the title if present on the Space. */
+    icon?: boolean;
+    /** When true, renders the Spaces description beneath the title. */
+    description?: boolean;
+    /** When passed in, provides predefined styles for the component.
+     * @default 'default'
+     */
+    variant?: SpacesLinkVariants;
+    /** When true, renders the FavoriteHeart component to the left of the Component.
+     * Note, this does require you to have wrapped your component somewhere in the Favorites Provider.
+     * This also requires the peerDependency @tanstack/react-query.
+     */
+    favorite?: boolean;
+    /** When true, renders the tyitle, and allow for the description and date info to be added on.
+     * @default true
+     */
+    body?: boolean;
+    /** When true, renders the activeDate of the space. */
+    showDate?: boolean;
+    /** When true, renders the name of the space.
+     * @default true
+     */
+    showName?: boolean;
+    /** When true, renders a "New!" badge if the activeDate is less than 30 days old. */
+    showNew?: boolean;
+    /** When true, renders the component vertically. */
+    stacked?: boolean;
+    /** Optionally pass in your own landing state for the component if you are managing the state yourself. */
+    loading?: boolean;
+    /** Required when space is not provided, or space is provided and space contains an sso link. */
+    clientId?: string;
+    style?: object;
+    className?: string;
+    /** Allows the description length to be truncated. */
+    maxDescriptionWidth?: string;
+    /** Additional attributes you may want to tack onto the native-form when submitting a SAML sso.
+     * i.e. spaceId or sourceApplicationId
+     */
+    linkAttributes?: object;
+    /** Allows the role of the root component to be overwritten.
+     * If variant prop is set to "list", defaults to "listitem".
+     */
+    role?: string;
+    /** When Analytics props are passed inside the analytics props, they will be passed down to the click item.
+     * For more information on Analytics props see: Autotrack Logged Events
+     */
+    analytics?: object;
+    customBadgeText?: string;
+    customBadgeColor?: StatusChipProps['color'];
+    /** prefix for ids to prevent duplicates when the same config link is displayed on the page more than once
+     * @default ''
+     */
+    idPrefix?: string;
+    [key: string]: any;
+};
+interface SsoTypeSpace extends Space {
+    type: 'saml' | 'openid';
+}
+
+type Link = {
+    /** Contains a URL or URL Fragment that the hyperlink points to. */
+    url?: string;
+    /** Specifies where to open the linked URL. */
+    target?: string;
+    text?: string;
+};
 type NameValuePair = {
     /** The key of the of the data. */
     name: string;
@@ -38,20 +155,19 @@ type Space = {
     mapping?: Record<string, string>;
     mappingPairs?: NameValuePair[];
     /** Whether or not the space is ghosted */
-    isGhost?: boolean;
-    link?: {
-        /** Contains a URL or URL Fragment that the hyperlink points to. */
-        url: string;
-        /** Specifies where to open the linked URL. */
-        target: string;
-    };
+    isGhosted?: boolean;
+    link?: Link;
     /** The description of the configuration. */
     description?: string;
     url?: string;
+    parents?: Space[];
+    shortName?: string;
+    activeDate?: string;
+    isNew?: boolean;
 };
 type SpacesContextType = {
     /** Array of spaces to be passed into the Spaces provider. */
-    spaces?: Map<string, Space>;
+    spaces?: Map<string, Space | SsoTypeSpace>;
     /** Array of spaces from previous page load. */
     previousSpacesMap?: Map<string, Space>;
     /** Array of spaces organized by configurationId. */
@@ -78,7 +194,7 @@ type SpacesProps = {
     /** The Client ID obtained from APIConnect. Must be subscribed to the thanos API. */
     clientId: string;
     /** Children can be a react child or render prop. */
-    children?: React.ReactNode;
+    children?: React.ReactNode | ((props: any | undefined) => React.ReactNode);
     /** Array of payerIds the Spaces provider should fetch the spaces for.
      * Any payerIds already included in spaces will not be fetched again.
      * Note: If a payerId is associated with more than one payer space, the order in which they are returned should not be relied upon.
@@ -91,6 +207,7 @@ type SpacesProps = {
      * Useful for if you already have the spaces in your app and don't want the spaces provider to have to fetch them again. */
     spaces?: Space[];
 };
+type UseSpaces = (...ids: string[]) => (Space | SsoTypeSpace)[] | undefined;
 
 declare const INITIAL_STATE: {
     loading: boolean;
@@ -98,6 +215,45 @@ declare const INITIAL_STATE: {
 declare const SpacesContext: react.Context<SpacesContextType>;
 declare const useSpacesContext: () => SpacesContextType;
 declare const Spaces: ({ query, variables, clientId, children, payerIds, spaceIds, spaces: spacesFromProps, }: SpacesProps) => JSX.Element;
-declare const useSpaces: (...ids: string[]) => Space[] | undefined;
+declare const useSpaces: UseSpaces;
+
+declare const SpacesLink: ({ spaceId, space: propSpace, className, children, favorite, icon, showName, showNew, showDate, stacked, body, description: showDescription, tag, bodyTag, titleTag, textTag, titleClassName, variant, loading: propsLoading, clientId: propsClientId, maxDescriptionWidth, style, linkAttributes, role, analytics, customBadgeText, customBadgeColor, idPrefix, ...rest }: SpacesLinkWithSpace | SpacesLinkWithSpaceId) => react_jsx_runtime.JSX.Element;
+
+type SpacesAgreementProps = {
+    spaceId: string;
+    markdown?: boolean;
+    id?: string;
+};
+declare const SpacesAgreement: ({ spaceId, markdown, id: elementId }: SpacesAgreementProps) => react_jsx_runtime.JSX.Element | null;
+
+type SpacesDisclaimerProps = {
+    accent?: boolean;
+    spaceId: string;
+    markdown?: boolean;
+    id?: string;
+};
+declare const SpacesDisclaimer: ({ accent, spaceId, markdown, id: elementId, ...props }: SpacesDisclaimerProps) => react_jsx_runtime.JSX.Element | null;
+
+type SpacesGhostTextProps = {
+    spaceId: string;
+    id?: string;
+} & React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
+declare const SpacesGhostText: ({ spaceId, id, ...props }: SpacesGhostTextProps) => react_jsx_runtime.JSX.Element | null;
+
+type BaseSpacesImageProps = {
+    imageType?: 'url' | 'images.logo' | 'images.tile' | 'images.billboard' | 'images.promotional' | 'images.promotionalHover';
+    fallback?: string;
+    id?: string;
+};
+type SpacesImageSpaceId = {
+    spaceId: string;
+    payerId?: string;
+} & BaseSpacesImageProps;
+type SpacesImagePayerId = {
+    spaceId?: string;
+    payerId: string;
+} & BaseSpacesImageProps;
+type SpacesImageProps = SpacesImageSpaceId | SpacesImagePayerId;
+declare const SpacesImage: ({ spaceId, payerId, imageType, fallback, ...props }: SpacesImageProps) => react_jsx_runtime.JSX.Element | null;
 
-export { INITIAL_STATE, Spaces, SpacesContext, useSpaces, useSpacesContext };
+export { INITIAL_STATE, type Space, Spaces, SpacesAgreement, type SpacesAgreementProps, SpacesContext, SpacesDisclaimer, type SpacesDisclaimerProps, SpacesGhostText, type SpacesGhostTextProps, SpacesImage, type SpacesImageProps, SpacesLink, useSpaces, useSpacesContext };

package/dist/index.d.ts

@@ -1,5 +1,122 @@
 import * as react from 'react';
+import { ChipProps } from '@mui/material/Chip';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
+type StatusChipProps = {
+    /** The color of the component.
+     * @default default */
+    color?: 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning';
+} & Omit<ChipProps, 'avatar' | 'children' | 'color' | 'variant' | 'skipFocusWhenDisabled' | 'disabled' | 'size' | 'icon' | 'clickable' | 'deleteIcon' | 'onDelete'>;
+
+type SpacesLinkVariants = 'card' | 'list' | 'default' | undefined;
+type SpacesLinkWithSpace = {
+    /** If no spaceId is provided, the first space in the spaces array is used.
+     * Note: This is only to be used when the Spaces provider should only ever contain a single space.
+     */
+    spaceId?: string;
+    /** Use to directly pass a space to the component rather than have it fetched from the spaces API.
+     * This component does not have to be a child of SpacesProvider.
+     * Note: If you are wanting to take advantage of the sso links you will additionally need to pass the clientId in.
+     */
+    space: Space | SsoTypeSpace;
+} & SpacesLinkProps;
+type SpacesLinkWithSpaceId = {
+    /** If no spaceId is provided, the first space in the spaces array is used.
+     * Note: This is only to be used when the Spaces provider should only ever contain a single space.
+     */
+    spaceId: string;
+    /** Use to directly pass a space to the component rather than have it fetched from the spaces API.
+     * This component does not have to be a child of SpacesProvider.
+     * Note: If you are wanting to take advantage of the sso links you will additionally need to pass the clientId in.
+     */
+    space?: Space | SsoTypeSpace;
+} & SpacesLinkProps;
+type SpacesLinkProps = {
+    /** Children can be a react child or render prop. */
+    children?: JSX.Element | ((props: any | undefined) => JSX.Element);
+    /** Tag to overwrite the root component rendered. */
+    tag?: string;
+    /** Tag to overwrite the body component that renders the title, description and data values.
+     * It defaults to CardBody or div depending on the value of the variant prop.
+     */
+    bodyTag?: string;
+    /** Tag to overwrite the title component. If variant prop is set to "card", defaults to CardTitle.
+     * If variant is set to "list", defaults to ListItemHeading. Overwise, defaults to div.
+     */
+    titleTag?: string;
+    /** Tag to overwrite the text component. If variant prop is set to "card", defaults to Card Text.
+     * If variant is set to "list", defaults to ListItemText. Otherwise, defaults to div.
+     */
+    textTag?: string;
+    titleClassName?: string;
+    /** When true, utilizes the Card component for styling. */
+    card?: boolean;
+    /** When true, renders an @availity/mui-icon next to the title if present on the Space. */
+    icon?: boolean;
+    /** When true, renders the Spaces description beneath the title. */
+    description?: boolean;
+    /** When passed in, provides predefined styles for the component.
+     * @default 'default'
+     */
+    variant?: SpacesLinkVariants;
+    /** When true, renders the FavoriteHeart component to the left of the Component.
+     * Note, this does require you to have wrapped your component somewhere in the Favorites Provider.
+     * This also requires the peerDependency @tanstack/react-query.
+     */
+    favorite?: boolean;
+    /** When true, renders the tyitle, and allow for the description and date info to be added on.
+     * @default true
+     */
+    body?: boolean;
+    /** When true, renders the activeDate of the space. */
+    showDate?: boolean;
+    /** When true, renders the name of the space.
+     * @default true
+     */
+    showName?: boolean;
+    /** When true, renders a "New!" badge if the activeDate is less than 30 days old. */
+    showNew?: boolean;
+    /** When true, renders the component vertically. */
+    stacked?: boolean;
+    /** Optionally pass in your own landing state for the component if you are managing the state yourself. */
+    loading?: boolean;
+    /** Required when space is not provided, or space is provided and space contains an sso link. */
+    clientId?: string;
+    style?: object;
+    className?: string;
+    /** Allows the description length to be truncated. */
+    maxDescriptionWidth?: string;
+    /** Additional attributes you may want to tack onto the native-form when submitting a SAML sso.
+     * i.e. spaceId or sourceApplicationId
+     */
+    linkAttributes?: object;
+    /** Allows the role of the root component to be overwritten.
+     * If variant prop is set to "list", defaults to "listitem".
+     */
+    role?: string;
+    /** When Analytics props are passed inside the analytics props, they will be passed down to the click item.
+     * For more information on Analytics props see: Autotrack Logged Events
+     */
+    analytics?: object;
+    customBadgeText?: string;
+    customBadgeColor?: StatusChipProps['color'];
+    /** prefix for ids to prevent duplicates when the same config link is displayed on the page more than once
+     * @default ''
+     */
+    idPrefix?: string;
+    [key: string]: any;
+};
+interface SsoTypeSpace extends Space {
+    type: 'saml' | 'openid';
+}
+
+type Link = {
+    /** Contains a URL or URL Fragment that the hyperlink points to. */
+    url?: string;
+    /** Specifies where to open the linked URL. */
+    target?: string;
+    text?: string;
+};
 type NameValuePair = {
     /** The key of the of the data. */
     name: string;
@@ -38,20 +155,19 @@ type Space = {
     mapping?: Record<string, string>;
     mappingPairs?: NameValuePair[];
     /** Whether or not the space is ghosted */
-    isGhost?: boolean;
-    link?: {
-        /** Contains a URL or URL Fragment that the hyperlink points to. */
-        url: string;
-        /** Specifies where to open the linked URL. */
-        target: string;
-    };
+    isGhosted?: boolean;
+    link?: Link;
     /** The description of the configuration. */
     description?: string;
     url?: string;
+    parents?: Space[];
+    shortName?: string;
+    activeDate?: string;
+    isNew?: boolean;
 };
 type SpacesContextType = {
     /** Array of spaces to be passed into the Spaces provider. */
-    spaces?: Map<string, Space>;
+    spaces?: Map<string, Space | SsoTypeSpace>;
     /** Array of spaces from previous page load. */
     previousSpacesMap?: Map<string, Space>;
     /** Array of spaces organized by configurationId. */
@@ -78,7 +194,7 @@ type SpacesProps = {
     /** The Client ID obtained from APIConnect. Must be subscribed to the thanos API. */
     clientId: string;
     /** Children can be a react child or render prop. */
-    children?: React.ReactNode;
+    children?: React.ReactNode | ((props: any | undefined) => React.ReactNode);
     /** Array of payerIds the Spaces provider should fetch the spaces for.
      * Any payerIds already included in spaces will not be fetched again.
      * Note: If a payerId is associated with more than one payer space, the order in which they are returned should not be relied upon.
@@ -91,6 +207,7 @@ type SpacesProps = {
      * Useful for if you already have the spaces in your app and don't want the spaces provider to have to fetch them again. */
     spaces?: Space[];
 };
+type UseSpaces = (...ids: string[]) => (Space | SsoTypeSpace)[] | undefined;
 
 declare const INITIAL_STATE: {
     loading: boolean;
@@ -98,6 +215,45 @@ declare const INITIAL_STATE: {
 declare const SpacesContext: react.Context<SpacesContextType>;
 declare const useSpacesContext: () => SpacesContextType;
 declare const Spaces: ({ query, variables, clientId, children, payerIds, spaceIds, spaces: spacesFromProps, }: SpacesProps) => JSX.Element;
-declare const useSpaces: (...ids: string[]) => Space[] | undefined;
+declare const useSpaces: UseSpaces;
+
+declare const SpacesLink: ({ spaceId, space: propSpace, className, children, favorite, icon, showName, showNew, showDate, stacked, body, description: showDescription, tag, bodyTag, titleTag, textTag, titleClassName, variant, loading: propsLoading, clientId: propsClientId, maxDescriptionWidth, style, linkAttributes, role, analytics, customBadgeText, customBadgeColor, idPrefix, ...rest }: SpacesLinkWithSpace | SpacesLinkWithSpaceId) => react_jsx_runtime.JSX.Element;
+
+type SpacesAgreementProps = {
+    spaceId: string;
+    markdown?: boolean;
+    id?: string;
+};
+declare const SpacesAgreement: ({ spaceId, markdown, id: elementId }: SpacesAgreementProps) => react_jsx_runtime.JSX.Element | null;
+
+type SpacesDisclaimerProps = {
+    accent?: boolean;
+    spaceId: string;
+    markdown?: boolean;
+    id?: string;
+};
+declare const SpacesDisclaimer: ({ accent, spaceId, markdown, id: elementId, ...props }: SpacesDisclaimerProps) => react_jsx_runtime.JSX.Element | null;
+
+type SpacesGhostTextProps = {
+    spaceId: string;
+    id?: string;
+} & React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
+declare const SpacesGhostText: ({ spaceId, id, ...props }: SpacesGhostTextProps) => react_jsx_runtime.JSX.Element | null;
+
+type BaseSpacesImageProps = {
+    imageType?: 'url' | 'images.logo' | 'images.tile' | 'images.billboard' | 'images.promotional' | 'images.promotionalHover';
+    fallback?: string;
+    id?: string;
+};
+type SpacesImageSpaceId = {
+    spaceId: string;
+    payerId?: string;
+} & BaseSpacesImageProps;
+type SpacesImagePayerId = {
+    spaceId?: string;
+    payerId: string;
+} & BaseSpacesImageProps;
+type SpacesImageProps = SpacesImageSpaceId | SpacesImagePayerId;
+declare const SpacesImage: ({ spaceId, payerId, imageType, fallback, ...props }: SpacesImageProps) => react_jsx_runtime.JSX.Element | null;
 
-export { INITIAL_STATE, Spaces, SpacesContext, useSpaces, useSpacesContext };
+export { INITIAL_STATE, type Space, Spaces, SpacesAgreement, type SpacesAgreementProps, SpacesContext, SpacesDisclaimer, type SpacesDisclaimerProps, SpacesGhostText, type SpacesGhostTextProps, SpacesImage, type SpacesImageProps, SpacesLink, useSpaces, useSpacesContext };