@digital-ai/dot-components 3.11.2 → 3.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital-ai/dot-components",
-  "version": "3.11.2",
+  "version": "3.13.0",
   "private": false,
   "license": "SEE LICENSE IN <LICENSE.md>",
   "contributors": [

package/src/lib/components/analytics/dashboard-actions/DashboardActions.d.ts

@@ -1,12 +1,10 @@
 import { ApplicationModel } from '../../core-api/openapi';
-import { AllCategories } from '../metadata-api/MetadataApiProvider';
 import { DashboardView } from '../metadata-api/openapi/';
 interface DashboardActionsCommonProps {
     canEdit?: boolean;
     dashboard: DashboardView;
     isEdit?: boolean;
     onClose?: (dashboard: DashboardView) => void;
-    onDetails?: (dashboard: DashboardView) => void;
     onDuplicated?: (dashboard: DashboardView, isDone?: boolean) => void;
     onFavorite?: (id: string, value: boolean) => void;
     onStatusChanged?: (dashboard: DashboardView) => void;
@@ -14,7 +12,6 @@ interface DashboardActionsCommonProps {
 }
 interface DashboardActionsProps extends DashboardActionsCommonProps {
     applications: ApplicationModel[];
-    categories: AllCategories;
 }
-declare function DotDashboardActions({ applications, categories, dashboard, isEdit, canEdit, onClose, onFavorite, onStatusChanged, onDuplicated, onViewMode, onDetails, }: DashboardActionsProps): import("react/jsx-runtime").JSX.Element;
+declare function DotDashboardActions({ applications, dashboard, isEdit, canEdit, onClose, onFavorite, onStatusChanged, onDuplicated, onViewMode, }: DashboardActionsProps): import("react/jsx-runtime").JSX.Element;
 export { DashboardActionsCommonProps, DotDashboardActions };

package/src/lib/components/analytics/dashboard-actions/DashboardPublishConfirm.d.ts

@@ -1,10 +1,8 @@
 import { ApplicationModel } from '../../core-api/openapi';
-import { AllCategoriesResponse, DashboardView } from '../metadata-api/openapi';
+import { DashboardView } from '../metadata-api/openapi';
 interface DashboardPublishConfirmProps {
     /** List of applications the dashboard can be published to **/
     applicationList: ApplicationModel[];
-    /** Categories for dashboard publishing **/
-    categories: AllCategoriesResponse;
     /** Dashboard to confirm publishing for **/
     dashboardToPublish: DashboardView;
     /** Dashboard to confirm unpublishing for **/
@@ -14,5 +12,5 @@ interface DashboardPublishConfirmProps {
     /** When a dashboard is updated, this function is called with the updated dashboard **/
     onStatusChanged: (updatedDashboard: DashboardView) => void;
 }
-export declare function DotDashboardPublishConfirm({ applicationList, categories, dashboardToPublish, dashboardToUnpublish, onClose, onStatusChanged, }: Readonly<DashboardPublishConfirmProps>): import("react/jsx-runtime").JSX.Element;
+export declare function DotDashboardPublishConfirm({ applicationList, dashboardToPublish, dashboardToUnpublish, onClose, onStatusChanged, }: Readonly<DashboardPublishConfirmProps>): import("react/jsx-runtime").JSX.Element;
 export {};

package/src/lib/components/analytics/dashboard-actions/DashboardPublishConfirm.styles.d.ts

@@ -2,5 +2,5 @@ export declare const dashboardCategoriesContainerClassName = "dashboard-categori
 export declare const InlineMessage: import("styled-components").StyledComponent<({ ariaLabel, ariaLevel, ariaRole, className, "data-testid": dataTestId, children, component, noMarginBottom, noWrap, variant, }: import("../../typography/Typography").TypographyProps) => import("react/jsx-runtime").JSX.Element, any, {}, never>;
 export declare const StyledPublishConfirmDiv: import("styled-components").StyledComponent<"div", any, {}, never>;
 export declare const StyledAppSelectDiv: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const StyledAppSelectDotAutoComplete: import("styled-components").StyledComponent<(<T extends import("../..").AutoCompleteOption>({ ListboxComponent, actionItem, ariaLabel, autoFocus, autoHighlight, className, "data-pendoid": dataPendoId, "data-testid": dataTestId, defaultValue, dense, disabled, disablePortal, endAdornmentTooltip, error, filterOptions, filterSelectedOptions, freesolo, checkIfOptionDisabled, group, helperText, inputId, inputRef, inputValue, isOptionEqualToValue, label, loading, maxHeight, multiple, onBlur, onChange, onClose, onInputChange, onOpen, open, options, persistentLabel, placeholder, popperClassName, readOnly, renderGroup, renderOption, renderTags, required, size, value, warning, }: import("../../auto-complete/AutoComplete").AutoCompleteProps<T>) => import("react/jsx-runtime").JSX.Element), any, {}, never>;
+export declare const StyledAppSelectDotAutoComplete: import("styled-components").StyledComponent<(<T extends import("../..").AutoCompleteOption>({ ListboxComponent, actionItem, ariaLabel, autoFocus, autoHighlight, className, "data-pendoid": dataPendoId, "data-testid": dataTestId, defaultValue, dense, disabled, disablePortal, endAdornmentTooltip, error, filterOptions, filterSelectedOptions, freesolo, checkIfOptionDisabled, group, helperText, inputId, inputRef, inputValue, isOptionEqualToValue, label, loading, maxHeight, multiple, onBlur, onChange, onClose, onInputChange, onOpen, open, options, persistentLabel, placeholder, popperClassName, preserveGroupOrder, readOnly, renderGroup, renderOption, renderTags, required, size, value, warning, }: import("../../auto-complete/AutoComplete").AutoCompleteProps<T>) => import("react/jsx-runtime").JSX.Element), any, {}, never>;
 export declare const StyledAppSelectAutoCompleteOption: import("styled-components").StyledComponent<"li", any, {}, never>;

package/src/lib/components/analytics/dashboard-categories-autocomplete/DashboardCategoriesAutoComplete.d.ts

@@ -0,0 +1,5 @@
+import { AutoCompleteProps } from '../../auto-complete';
+export interface DashboardCategoriesAutoCompleteProps extends AutoCompleteProps {
+    onNewCategory: (newCategory: string) => void;
+}
+export declare function DashboardCategoriesAutoComplete({ freesolo, actionItem, onInputChange, onNewCategory, ...args }: Readonly<DashboardCategoriesAutoCompleteProps>): import("react/jsx-runtime").JSX.Element;

package/src/lib/components/analytics/metadata-api/MetadataApiProvider.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { ApiError, AllCategoriesResponse, DashboardView, DashboardCopyBody, DashboardPatchBody } from './openapi';
+import { ApiError, AllCategoriesResponse, Author, DashboardView, DashboardCopyBody, DashboardPatchBody } from './openapi';
 export interface MetadataApiProviderProps {
     accountOverrideId?: string;
     apiUrl: string;
@@ -7,14 +7,14 @@ export interface MetadataApiProviderProps {
     token?: string;
 }
 interface DotMetadataApiContextProps {
-    categories: AllCategoriesResponse;
-    categoriesLoading: boolean;
     dashboardsError: ApiError;
     dashboardsLoading: boolean;
     duplicateDashboard: (dashboardId: string, dashboard: DashboardCopyBody) => Promise<DashboardView>;
     favoriteDashboard: (dashboardId: string, favoriteValue: boolean) => Promise<DashboardView>;
-    getCategories: () => Promise<AllCategoriesResponse>;
+    getAuthors: (appType: string, publishedOnly?: boolean) => Promise<Author[]>;
+    getCategories: (appType: string, publishedOnly?: boolean) => Promise<string[]>;
     getDashboardHelpContent: (helpContentId: string) => Promise<string>;
+    metadataLoading: boolean;
     openedDashboardDetails: DashboardView;
     platformConsoleUrl: string;
     searchDashboards: (search: DashboardFilters) => Promise<DashboardView[]>;

package/src/lib/components/analytics/metadata-api/openapi/models/DashboardView.d.ts

@@ -88,17 +88,17 @@ export type DashboardView = {
      */
     favorite: boolean;
     /**
-     * The date and time that the dashboard was last modified.
-     */
-    updated_dt?: string | null;
-    /**
-     * The full name of the dashboard modifier.
+     * The full name of the dashboard updated_by.
      */
     updated_by_fullname?: string | null;
     /**
-     * The platform id of the dashboard modifier.
+     * The platform id of the dashboard updated_by.
      */
     updated_by_id?: string | null;
+    /**
+     * Timestamp of the latest modification
+     */
+    updated_dt?: string | null;
 };
 export declare namespace DashboardView {
     /**

package/src/lib/components/analytics/metadata-api/openapi/models/Origin.d.ts

@@ -2,6 +2,6 @@ export type Origin = {
     name: string;
     description: string;
     created_dt?: string | null;
+    is_platform_origin?: boolean;
     id?: string | null;
-    origin_family?: Array<string> | null;
 };

package/src/lib/components/analytics/metadata-api/openapi/services/DashboardsService.d.ts

@@ -15,8 +15,8 @@ export declare class DashboardsService {
      * @param sort Sort ordering to apply to the query.
      * @param filter List of filters (each filter is a separate query param, and they are OR'ed).
      *
-     * * **Filterable field names**: author_fullname, author_id, bi_type, categories, created_dt, description, external_embedding_id, external_id, id, is_ootb_dashboard, lifecycle_state, name, target_apps, updated_dt
-     * * **Searchable field names**: author_fullname, categories, description, name
+     * * **Filterable field names**: author_fullname, author_id, bi_type, categories, created_dt, description, external_embedding_id, external_id, id, is_ootb_dashboard, lifecycle_state, name, target_apps, updated_by_fullname, updated_by_id, updated_dt
+     * * **Searchable field names**: author_fullname, categories, description, name, updated_by_fullname
      *
      * @param favorite Boolean flag to only return dashboards marked as favorites.
      * @param q Case-insensitive search of all text fields.
@@ -112,14 +112,19 @@ export declare class DashboardsService {
     static deleteDashboardsService1(dashboardId: string): Promise<DashboardView | Error>;
     /**
      * Get Metadata (categories and authors)
-     * Return all Metadata for the given query parameters: bi_type, lifecycle_state, target_app, and/or is_ootb_dashboard
+     * Return all Metadata for dashboards optionally filtered by the given parameters
+     * @param filter List of filters (each filter is a separate query param, and they are OR'ed).
+     *
+     * * **Filterable field names**: author_fullname, bi_type, categories, created_dt, description, is_ootb_dashboard, lifecycle_state, name, updated_by_fullname, updated_dt
+     * * **Searchable field names**: author_fullname, categories, description, name
+     *
+     * @param targetApp String match on the Dashboard target application - 'AGILITY', 'CONTINUOUSTEST', 'DEPLOY', 'RELEASE' or 'TEAMFORGE'.
      * @param biType String match on Dashboard bi type - 'MICROSTRATEGY'.
      * @param isOotbDashboard Boolean match on Dashboard OOTB status.
      * @param lifecycleState String match on Dashboard lifecycle state - 'DRAFT' or 'PUBLISHED'.
-     * @param targetApp String match on the Dashboard target application - 'AGILITY', 'CONTINUOUSTEST', 'DEPLOY' or 'RELEASE'.
      * @returns MetadataResponse OK
      * @returns Error Default error response
      * @throws ApiError
      */
-    static getDashboardsService2(biType?: string, isOotbDashboard?: boolean, lifecycleState?: string, targetApp?: string): Promise<MetadataResponse | Error>;
+    static getDashboardsMetadata(filter?: Array<string>, targetApp?: string, biType?: string, isOotbDashboard?: boolean, lifecycleState?: string): Promise<MetadataResponse | Error>;
 }

package/src/lib/components/analytics/metadata-api/openapi/services/OriginsService.d.ts

@@ -10,13 +10,14 @@ export declare class OriginsService {
      * @param sort Sort ordering to apply to the query.
      * @param name String match on Origin name.
      * @param description String match on Origin description.
+     * @param isPlatformOrigin Select from platform or tenant (non-platform) Origin.
      * @param q Case-insensitive search of all text fields.
      * @param id
      * @returns OriginPagedResponse OK
      * @returns Error Default error response
      * @throws ApiError
      */
-    static getOriginsService(start?: number, count?: number, sort?: string, name?: string, description?: string, q?: string, id?: string): Promise<OriginPagedResponse | Error>;
+    static getOriginsService(start?: number, count?: number, sort?: string, name?: string, description?: string, isPlatformOrigin?: boolean, q?: string, id?: string): Promise<OriginPagedResponse | Error>;
     /**
      * Create an Origin.
      * Creates an Origin, owned by the authenticated API user.

package/src/lib/components/auto-complete/AutoComplete.d.ts

@@ -75,6 +75,8 @@ export interface AutoCompleteProps<T extends AutoCompleteOption = AutoCompleteOp
     placeholder?: string;
     /** Classname to be included in the autocomplete popper **/
     popperClassName?: string;
+    /** If true, group order (as specified by the consumer) will be preserved. Default group sorting is used when not specified. */
+    preserveGroupOrder?: boolean;
     /** If true: popper cannot be opened, TextField is in read only mode, change is not allowed  */
     readOnly?: boolean;
     /** Render group function, group prop must be true for the function to be used **/
@@ -92,4 +94,4 @@ export interface AutoCompleteProps<T extends AutoCompleteOption = AutoCompleteOp
     /** If true, the label will be displayed in a warning state. */
     warning?: boolean;
 }
-export declare const DotAutoComplete: <T extends AutoCompleteOption>({ ListboxComponent, actionItem, ariaLabel, autoFocus, autoHighlight, className, "data-pendoid": dataPendoId, "data-testid": dataTestId, defaultValue, dense, disabled, disablePortal, endAdornmentTooltip, error, filterOptions, filterSelectedOptions, freesolo, checkIfOptionDisabled, group, helperText, inputId, inputRef, inputValue, isOptionEqualToValue, label, loading, maxHeight, multiple, onBlur, onChange, onClose, onInputChange, onOpen, open, options, persistentLabel, placeholder, popperClassName, readOnly, renderGroup, renderOption, renderTags, required, size, value, warning, }: AutoCompleteProps<T>) => import("react/jsx-runtime").JSX.Element;
+export declare const DotAutoComplete: <T extends AutoCompleteOption>({ ListboxComponent, actionItem, ariaLabel, autoFocus, autoHighlight, className, "data-pendoid": dataPendoId, "data-testid": dataTestId, defaultValue, dense, disabled, disablePortal, endAdornmentTooltip, error, filterOptions, filterSelectedOptions, freesolo, checkIfOptionDisabled, group, helperText, inputId, inputRef, inputValue, isOptionEqualToValue, label, loading, maxHeight, multiple, onBlur, onChange, onClose, onInputChange, onOpen, open, options, persistentLabel, placeholder, popperClassName, preserveGroupOrder, readOnly, renderGroup, renderOption, renderTags, required, size, value, warning, }: AutoCompleteProps<T>) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/card/CardHeader.styles.d.ts

@@ -0,0 +1,2 @@
+export declare const rootClassName = "dot-card-header";
+export declare const StyledCardHeader: import("styled-components").StyledComponent<import("@mui/material").OverridableCardHeader, any, {}, never>;

package/src/lib/components/list/List.d.ts

@@ -1,2 +1,2 @@
 import { ListProps } from './utils/models';
-export declare const DotList: ({ ariaLabel, ariaRole, children, className, component, "data-testid": dataTestId, dense, disablePadding, items, menuPlacement, nestedDrawerLeftSpacing, nestedListType, width, }: ListProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DotList: ({ ariaLabel, ariaRole, children, className, component, "data-testid": dataTestId, dense, disablePadding, items, menuPlacement, nestedDrawerLeftSpacing, nestedListCloseOnClickAway, nestedListType, width, }: ListProps) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/list/utils/models.d.ts

@@ -20,6 +20,8 @@ export interface ListProps extends CommonProps {
     menuPlacement?: PopperPlacement;
     /** If nested type is 'drawer', determines the width of the left spacing */
     nestedDrawerLeftSpacing?: number;
+    /** Determines if expandable nested items will be closed on click away, by default is true */
+    nestedListCloseOnClickAway?: boolean;
     /** If 'menu' the nested list will be displayed as a flyout nav, else it will be an expand/collapse toggle list */
     nestedListType?: NestedListType;
     /** Width of list, defaults to 240px */

package/src/lib/components/popper/Popper.d.ts

@@ -20,6 +20,8 @@ export interface PopperProps extends CommonProps {
     children: ReactNode;
     /** Disable the portal behavior. If `true`, children stay within parent DOM hierarchy. */
     disablePortal?: boolean;
+    /** If true, the popper will have an arrow */
+    hasArrow?: boolean;
     /** Used to specify the position more indepth, https://popper.js.org/docs/v2/modifiers/ */
     modifiers?: ModifersProps[];
     /** Event callback when leaving popper by clicking away */
@@ -29,5 +31,5 @@ export interface PopperProps extends CommonProps {
     /** Popper placement. */
     placement?: PopperPlacementType;
 }
-export declare const DotPopper: ({ ariaLabel, anchorEl, children, className, "data-testid": dataTestId, disablePortal, modifiers, onClickAway, open, placement, }: PopperProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DotPopper: ({ ariaLabel, anchorEl, children, className, "data-testid": dataTestId, disablePortal, hasArrow, modifiers, onClickAway, open, placement, }: PopperProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/src/lib/components/popper/Popper.data.d.ts

@@ -1,7 +1,9 @@
 import { KeyboardEvent, MouseEvent } from 'react';
+import { PopperPlacementType } from '@mui/material';
 export interface PopperTestWrapperProps {
     dataTestId?: string;
     disablePortal?: boolean;
     onClickAway?: (event: KeyboardEvent | MouseEvent<Document>) => void;
 }
 export declare const PopperTestWrapper: (props: PopperTestWrapperProps) => import("react/jsx-runtime").JSX.Element;
+export declare const POPPER_PLACEMENT_OPTIONS: PopperPlacementType[];

package/src/lib/components/popper/Popper.styles.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 export declare const rootClassName = "dot-popper";
+export declare const arrowClassName = "MuiPopper-arrow";
 export declare const StyledPopper: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<Omit<import("@mui/base").PopperProps, "direction"> & {
     component?: import("react").ElementType<any>;
     components?: {
@@ -10,3 +11,4 @@ export declare const StyledPopper: import("styled-components").StyledComponent<i
     };
     sx?: import("@mui/material").SxProps<import("@mui/material").Theme>;
 } & import("react").RefAttributes<HTMLDivElement>>, any, {}, never>;
+export declare const StyledArrow: import("styled-components").StyledComponent<"span", any, {}, never>;