@availity/mui-spaces 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## 0.1.0 (2024-05-17)
+
+### Dependency Updates
+
+* `mui-button` updated to version `0.1.0`
+* `mui-modal` updated to version `0.1.0`
+* `mui-typography` updated to version `0.1.0`
+* `mui-paper` updated to version `0.1.0`
+* `mui-divider` updated to version `0.1.0`
+* `mui-layout` updated to version `0.1.0`
+* `@availity/mock` updated to version `0.1.0`
+
+### Features
+
+* **mui-spaces:** initial commit ([b0f84a1](https://github.com/Availity/element/commit/b0f84a1b53fe1fe47feba8a2784741dae9445ea9))

package/README.md

@@ -0,0 +1,61 @@
+# @availity/mui-spaces
+
+> Availity MUI Spaces component to be used with @availity/element design system.
+
+[![Version](https://img.shields.io/npm/v/@availity/mui-spaces.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-spaces)
+[![NPM Downloads](https://img.shields.io/npm/dt/@availity/mui-spaces.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-spaces)
+[![Dependency Status](https://img.shields.io/librariesio/release/npm/@availity/mui-spaces?style=for-the-badge)](https://github.com/Availity/element/blob/main/packages/mui-spaces/package.json)
+
+## Documentation
+
+This package extends the MUI Spaces component: [MUI Spaces Docs](https://mui.com/components/spaces/)
+
+Live demo and documentation in our [Storybook](https://availity.github.io/element/?path=/docs/components-spaces-introduction--docs)
+
+Availity standards for design and usage can be found in the [Availity Design Guide](https://zeroheight.com/2e36e50c7)
+
+## Installation
+
+### Import Through @availity/element (Recommended)
+
+#### NPM
+
+```bash
+npm install @availity/element
+```
+
+#### Yarn
+
+```bash
+yarn add @availity/element
+```
+
+### Direct Import
+
+#### NPM
+
+_This package has a few peer dependencies. Add `@mui/material` & `@emotion/react` to your project if not already installed._
+
+```bash
+npm install @availity/mui-spaces
+```
+
+#### Yarn
+
+```bash
+yarn add @availity/mui-spaces
+```
+
+### Usage
+
+#### Import through @availity/element
+
+```tsx
+import { Spaces } from '@availity/element';
+```
+
+#### Direct import
+
+```tsx
+import { Spaces } from '@availity/mui-spaces';
+```

package/dist/index.d.mts

@@ -0,0 +1,104 @@
+import * as react from 'react';
+
+type NameValuePair = {
+    /** The key of the of the data. */
+    name: string;
+    /** The value of the data. */
+    value: string;
+};
+type Space = {
+    /** The name of the content or configuration. */
+    name: string;
+    /** The configuration type. */
+    type: string;
+    /** Globally unique ID associated with the configuration object. */
+    id: string;
+    /** The ID used to identify the configuration. */
+    configurationId: string;
+    /** A list of payerIds for the configuration or content. */
+    payerIDs?: string[];
+    /** The images associated with the configuration. */
+    images?: NameValuePair[];
+    /** Key-value data for a configuration. */
+    metadata?: NameValuePair[];
+    /** The feature box colors associated with the Payer Space. */
+    colors?: NameValuePair[];
+    /** Contains URL fragments that point to icons. */
+    icons?: NameValuePair[];
+    /** The key-value mapping pairs. */
+    mapping?: NameValuePair[];
+};
+type NormalizedPairField = {
+    [key: string]: string;
+};
+interface NormalizedSpace extends Omit<Space, 'images' | 'metadata' | 'colors' | 'icons' | 'mapping'> {
+    /** The images associated with the configuration. */
+    images?: NormalizedPairField;
+    /** The feature box colors associated with the Payer Space. */
+    colors?: NormalizedPairField;
+    /** Contains URL fragments that point to icons. */
+    icons?: NormalizedPairField;
+    /** Key-value data for a configuration. */
+    metadata?: NormalizedPairField;
+    /** The key-value mapping pairs. */
+    mapping?: NormalizedPairField;
+    /** URL metadata for the configuration. */
+    link?: {
+        /** Contains a URL or URL Fragment that the hyperlink points to. */
+        url: string;
+        /** Specifies where to open the linked URL. */
+        target: string;
+    };
+}
+type SpacesContextType = {
+    /** Array of spaces to be passed into the Spaces provider. */
+    spaces?: Map<string, Space>;
+    /** Array of spaces from previous page load. */
+    previousSpacesMap?: Map<string, Space>;
+    /** Array of spaces organized by configurationId. */
+    spacesByConfig?: Map<string, Space>;
+    /** Array of spaces organized by configurationId from previous page load. */
+    previousSpacesByConfigMap?: Map<string, Space>;
+    /** Array of spaces organized by payerId. */
+    spacesByPayer?: Map<string, Space[]>;
+    /** Array of spaces organized by payerId from previous page load. */
+    previousSpacesByPayerMap?: Map<string, Space[]>;
+    /** Whether or not spaces are loading. */
+    loading: boolean;
+    /** Errors associated with fetching spaces. */
+    error?: string;
+    /** Items that live within the spaces component and can access SpacesContext. */
+    children?: React.ReactNode;
+};
+type SpacesProps = {
+    /** Override the default thanos query. */
+    query?: string;
+    /** Override the default variables used in the thanos query. Default: { types: [PAYERSPACE] }.
+     * If the spaces provider should contain configurations of a type other than PAYERSPACE, you must override this prop */
+    variables?: object;
+    /** 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;
+    /** 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.
+     * If a specific payer space is required, you'll need to filter the list that is returned. */
+    payerIds?: string[];
+    /** Array of spaceIds the Spaces provider should fetch the spaces for.
+     * Any spaceIds already included in spaces will not be fetched again. */
+    spaceIds?: string[];
+    /** Array of spaces to be passed into the Spaces provider.
+     * 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[];
+};
+
+declare const INITIAL_STATE: {
+    loading: boolean;
+};
+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[]) => NormalizedSpace[] | undefined;
+
+export { INITIAL_STATE, Spaces, SpacesContext, useSpaces, useSpacesContext };

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+import * as react from 'react';
+
+type NameValuePair = {
+    /** The key of the of the data. */
+    name: string;
+    /** The value of the data. */
+    value: string;
+};
+type Space = {
+    /** The name of the content or configuration. */
+    name: string;
+    /** The configuration type. */
+    type: string;
+    /** Globally unique ID associated with the configuration object. */
+    id: string;
+    /** The ID used to identify the configuration. */
+    configurationId: string;
+    /** A list of payerIds for the configuration or content. */
+    payerIDs?: string[];
+    /** The images associated with the configuration. */
+    images?: NameValuePair[];
+    /** Key-value data for a configuration. */
+    metadata?: NameValuePair[];
+    /** The feature box colors associated with the Payer Space. */
+    colors?: NameValuePair[];
+    /** Contains URL fragments that point to icons. */
+    icons?: NameValuePair[];
+    /** The key-value mapping pairs. */
+    mapping?: NameValuePair[];
+};
+type NormalizedPairField = {
+    [key: string]: string;
+};
+interface NormalizedSpace extends Omit<Space, 'images' | 'metadata' | 'colors' | 'icons' | 'mapping'> {
+    /** The images associated with the configuration. */
+    images?: NormalizedPairField;
+    /** The feature box colors associated with the Payer Space. */
+    colors?: NormalizedPairField;
+    /** Contains URL fragments that point to icons. */
+    icons?: NormalizedPairField;
+    /** Key-value data for a configuration. */
+    metadata?: NormalizedPairField;
+    /** The key-value mapping pairs. */
+    mapping?: NormalizedPairField;
+    /** URL metadata for the configuration. */
+    link?: {
+        /** Contains a URL or URL Fragment that the hyperlink points to. */
+        url: string;
+        /** Specifies where to open the linked URL. */
+        target: string;
+    };
+}
+type SpacesContextType = {
+    /** Array of spaces to be passed into the Spaces provider. */
+    spaces?: Map<string, Space>;
+    /** Array of spaces from previous page load. */
+    previousSpacesMap?: Map<string, Space>;
+    /** Array of spaces organized by configurationId. */
+    spacesByConfig?: Map<string, Space>;
+    /** Array of spaces organized by configurationId from previous page load. */
+    previousSpacesByConfigMap?: Map<string, Space>;
+    /** Array of spaces organized by payerId. */
+    spacesByPayer?: Map<string, Space[]>;
+    /** Array of spaces organized by payerId from previous page load. */
+    previousSpacesByPayerMap?: Map<string, Space[]>;
+    /** Whether or not spaces are loading. */
+    loading: boolean;
+    /** Errors associated with fetching spaces. */
+    error?: string;
+    /** Items that live within the spaces component and can access SpacesContext. */
+    children?: React.ReactNode;
+};
+type SpacesProps = {
+    /** Override the default thanos query. */
+    query?: string;
+    /** Override the default variables used in the thanos query. Default: { types: [PAYERSPACE] }.
+     * If the spaces provider should contain configurations of a type other than PAYERSPACE, you must override this prop */
+    variables?: object;
+    /** 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;
+    /** 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.
+     * If a specific payer space is required, you'll need to filter the list that is returned. */
+    payerIds?: string[];
+    /** Array of spaceIds the Spaces provider should fetch the spaces for.
+     * Any spaceIds already included in spaces will not be fetched again. */
+    spaceIds?: string[];
+    /** Array of spaces to be passed into the Spaces provider.
+     * 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[];
+};
+
+declare const INITIAL_STATE: {
+    loading: boolean;
+};
+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[]) => NormalizedSpace[] | undefined;
+
+export { INITIAL_STATE, Spaces, SpacesContext, useSpaces, useSpacesContext };