@digital-ai/dot-components 3.7.0 → 3.8.1

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

@@ -0,0 +1,51 @@
+import type { Error } from '../models/Error';
+import type { HelpContent } from '../models/HelpContent';
+import type { HelpContentCreateBody } from '../models/HelpContentCreateBody';
+import type { HelpContentPagedResponse } from '../models/HelpContentPagedResponse';
+import type { HelpContentPutBody } from '../models/HelpContentPutBody';
+export declare class HelpContentService {
+    /**
+     * Gets help content definitions.
+     * Return help content definitions.
+     * @returns HelpContentPagedResponse OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getHelpContent(): Promise<HelpContentPagedResponse | Error>;
+    /**
+     * Upload an HTML file to be displayed as help content.
+     * Upload help content.
+     * @param requestBody
+     * @returns HelpContent Content uploaded.
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static createHelpContent(requestBody: HelpContentCreateBody): Promise<HelpContent | Error>;
+    /**
+     * Get a help content definition.
+     * Return a single help content definition, selected by ID.
+     * @param helpContentId
+     * @returns HelpContent OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getHelpContentById(helpContentId: string): Promise<HelpContent | Error>;
+    /**
+     * Update a help content definition.
+     * Update a single help content definition, selected by ID.
+     * @param helpContentId
+     * @param requestBody
+     * @returns HelpContent OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static putHelpContentById(helpContentId: string, requestBody: HelpContentPutBody): Promise<HelpContent | Error>;
+    /**
+     * Delete a help content definition.
+     * Delete a single help content definition, selected by ID.
+     * @param helpContentId
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static deleteHelpContentById(helpContentId: string): Promise<Error>;
+}

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

@@ -0,0 +1,56 @@
+import type { Error } from '../models/Error';
+import type { OriginInstance } from '../models/OriginInstance';
+import type { OriginInstancePagedResponse } from '../models/OriginInstancePagedResponse';
+export declare class OriginInstancesService {
+    /**
+     * Get a list of OriginInstances.
+     * Return a list of OriginInstances, filtered by query parameters.
+     * @param start Offset of the first fetched item.
+     * @param count Maximum number of fetched items.
+     * @param sort Sort ordering to apply to the query.
+     * @param name String match on OriginInstance name.
+     * @param description String match on OriginInstance description.
+     * @param q Case-insensitive search of all text fields.
+     * @param id
+     * @returns OriginInstancePagedResponse OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getOriginInstancesService(start?: number, count?: number, sort?: string, name?: string, description?: string, q?: string, id?: string): Promise<OriginInstancePagedResponse | Error>;
+    /**
+     * Create an OriginInstance.
+     * Creates an OriginInstance, owned by the authenticated API user.
+     * @param requestBody
+     * @returns OriginInstance OriginInstance created.
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static postOriginInstancesService(requestBody: OriginInstance): Promise<OriginInstance | Error>;
+    /**
+     * Get one OriginInstance.
+     * Return a single OriginInstance, selected by ID.
+     * @param id
+     * @returns OriginInstance OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getOriginInstancesService1(id: string): Promise<OriginInstance | Error>;
+    /**
+     * Update a single OriginInstance.
+     * Updates an OriginInstance, selected by ID.
+     * @param id
+     * @param requestBody
+     * @returns OriginInstance OriginInstance updated.
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static putOriginInstancesService(id: string, requestBody: OriginInstance): Promise<OriginInstance | Error>;
+    /**
+     * Delete a OriginInstance.
+     * Deletes a single OriginInstance, selected by ID.
+     * @param id
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static deleteOriginInstancesService(id: string): Promise<Error>;
+}

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

@@ -0,0 +1,56 @@
+import type { Error } from '../models/Error';
+import type { Origin } from '../models/Origin';
+import type { OriginPagedResponse } from '../models/OriginPagedResponse';
+export declare class OriginsService {
+    /**
+     * Get a list of Origins.
+     * Return a list of Origins, filtered by query parameters.
+     * @param start Offset of the first fetched item.
+     * @param count Maximum number of fetched items.
+     * @param sort Sort ordering to apply to the query.
+     * @param name String match on Origin name.
+     * @param description String match on Origin description.
+     * @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>;
+    /**
+     * Create an Origin.
+     * Creates an Origin, owned by the authenticated API user.
+     * @param requestBody
+     * @returns Origin Origin created.
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static postOriginsService(requestBody: Origin): Promise<Origin | Error>;
+    /**
+     * Get one Origin.
+     * Return a single Origin, selected by ID.
+     * @param id
+     * @returns Origin OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getOriginsService1(id: string): Promise<Origin | Error>;
+    /**
+     * Update a single Origin.
+     * Updates an Origin, selected by ID.
+     * @param id
+     * @param requestBody
+     * @returns Origin Origin updated.
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static putOriginsService(id: string, requestBody: Origin): Promise<Origin | Error>;
+    /**
+     * Delete a Origin.
+     * Deletes a single Origin, selected by ID.
+     * @param id
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static deleteOriginsService(id: string): Promise<Error>;
+}

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

@@ -0,0 +1,46 @@
+import type { Error } from '../models/Error';
+import type { HealthCheckResponse } from '../models/HealthCheckResponse';
+import type { TenantInfo } from '../models/TenantInfo';
+import type { VersionResponse } from '../models/VersionResponse';
+export declare class UtilityService {
+    /**
+     * An aliveness check, also verifies database connectivity.
+     * Returns 200 OK if the service is up and running.
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getUtilityService(): Promise<Error>;
+    /**
+     * Version
+     * Returns information about the version of the service.
+     * @returns VersionResponse OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getUtilityService1(): Promise<VersionResponse | Error>;
+    /**
+     * Health check
+     * Return information about the health of the service.
+     * @returns HealthCheckResponse OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getUtilityService2(): Promise<HealthCheckResponse | Error>;
+    /**
+     * Prometheus metrics
+     * Return service metrics in a Prometheus-friendly format.
+     * @returns any OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getUtilityService3(): Promise<any | Error>;
+    /**
+     * [EXPERIMENTAL] Get Tenant information specific to this Service.
+     * Returns information about a single Tenant identified by account/tenant ID.
+     * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID.  <em>Requires elevated permissions.</em>
+     * @returns TenantInfo OK
+     * @returns Error Default error response
+     * @throws ApiError
+     */
+    static getUtilityService4(xDigitalaiAccountId?: string): Promise<TenantInfo | Error>;
+}

package/src/lib/components/board/board/Board.context.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { IBoardStatusContext, IBoardStatusProvider } from '../interfaces';
+export declare const BoardStatusContext: import("react").Context<IBoardStatusContext>;
+export declare const useBoardStatus: () => IBoardStatusContext;
+export declare const BoardStatusProvider: ({ children, spacing, }: IBoardStatusProvider) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/board/board/Board.d.ts

@@ -0,0 +1,8 @@
+import { DotBoardProps } from '../interfaces';
+import React from 'react';
+/**
+ * A flexible framework component for creating a  board.
+ * Subcomponents may be used or omitted as desired
+ * `useBoardStatus` can be used to get state information about the board
+ */
+export declare const Board: React.ForwardRefExoticComponent<DotBoardProps & React.RefAttributes<HTMLDivElement>>;

package/src/lib/components/board/board/Board.styles.d.ts

@@ -0,0 +1,8 @@
+export declare const classNames: {
+    root: string;
+    spacingNormal: string;
+    spacingDense: string;
+    loading: string;
+};
+export declare const StyledBoard: import("styled-components").StyledComponent<"div", any, {}, never>;
+export declare const StyledLoadingIndicator: import("styled-components").StyledComponent<"div", any, {}, never>;

package/src/lib/components/board/board/index.d.ts

@@ -0,0 +1,2 @@
+export { Board as DotBoard } from './Board';
+export { useBoardStatus, BoardStatusProvider } from './Board.context';

package/src/lib/components/board/column/Column.context.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { IBoardColumnStatusContext, IColumnStatusProvider } from '../interfaces';
+export declare const BoardColumnStatusContext: import("react").Context<IBoardColumnStatusContext>;
+export declare const useColumnStatus: () => IBoardColumnStatusContext;
+export declare const ColumnStatusProvider: ({ children, onCollapseToggle, }: IColumnStatusProvider) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/board/column/Column.d.ts

@@ -0,0 +1,7 @@
+import { DotBoardColumnProps } from '../interfaces';
+import React from 'react';
+/**
+ * Represents a single column in the board.
+ * useColumnStatus can be used to get state information about the column
+ */
+export declare const BoardColumn: React.ForwardRefExoticComponent<DotBoardColumnProps & React.RefAttributes<HTMLDivElement>>;

package/src/lib/components/board/column/Column.styles.d.ts

@@ -0,0 +1,7 @@
+export declare const classNames: {
+    root: string;
+    spacingNormal: string;
+    spacingDense: string;
+    collapse: string;
+};
+export declare const StyledBoardColumn: import("styled-components").StyledComponent<"div", any, {}, never>;

package/src/lib/components/board/column/index.d.ts

@@ -0,0 +1,2 @@
+export { BoardColumn as DotBoardColumn } from './Column';
+export { ColumnStatusProvider, useColumnStatus } from './Column.context';

package/src/lib/components/board/column-actionbar/ColumnActionBar.d.ts

@@ -0,0 +1,2 @@
+import { DotBoardColumnActionBarProps } from '../interfaces';
+export declare const BoardColumnActionBar: ({ ariaLabel, "data-testid": dataTestId, children, className, }: DotBoardColumnActionBarProps) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/board/column-actionbar/ColumnActionBar.styles.d.ts

@@ -0,0 +1,6 @@
+export declare const classNames: {
+    root: string;
+    spacingNormal: string;
+    spacingDense: string;
+};
+export declare const StyledBoardColumnActionBar: import("styled-components").StyledComponent<({ ariaLabel, children, className, "data-testid": dataTestId, variant, }: import("../../action-toolbar/ActionToolbar").DotActionBarProps) => import("react/jsx-runtime").JSX.Element, any, {}, never>;

package/src/lib/components/board/column-actionbar/index.d.ts

@@ -0,0 +1 @@
+export { BoardColumnActionBar as DotBoardColumnActionBar } from './ColumnActionBar';

package/src/lib/components/board/column-collapse/ColumnCollapse.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { DotBoardColumnProps } from '../interfaces';
+/**
+ * Optional component. Displays any children when the column is collapsed.
+ */
+export declare const BoardColumnCollapse: ({ children }: DotBoardColumnProps) => React.ReactNode;

package/src/lib/components/board/column-collapse/index.d.ts

@@ -0,0 +1 @@
+export { BoardColumnCollapse as DotBoardColumnCollapse } from './ColumnCollapse';

package/src/lib/components/board/column-expand/ColumnExpand.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { DotBoardColumnProps } from '../interfaces';
+/**
+ * Optional component. Displays any children when the column is expanded.
+ */
+export declare const BoardColumnExpand: ({ children }: DotBoardColumnProps) => React.ReactNode;

package/src/lib/components/board/column-expand/index.d.ts

@@ -0,0 +1 @@
+export { BoardColumnExpand as DotBoardColumnExpand } from './ColumnExpand';

package/src/lib/components/board/column-header/ColumnHeader.d.ts

@@ -0,0 +1,5 @@
+import { DotBoardColumnHeaderProps } from '../interfaces';
+/**
+ * Header for the column. Expects lineBarHexColor to have the form: "#XXXXXX"
+ */
+export declare const BoardColumnHeader: ({ ariaLabel, "data-testid": dataTestId, children, className, lineBarHexColor, style, }: DotBoardColumnHeaderProps) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/board/column-header/ColumnHeader.styles.d.ts

@@ -0,0 +1,8 @@
+export declare const classNames: {
+    root: string;
+    spacingNormal: string;
+    spacingDense: string;
+    colorBar: string;
+    title: string;
+};
+export declare const StyledBoardColumnHeader: import("styled-components").StyledComponent<"div", any, {}, never>;

package/src/lib/components/board/column-header/index.d.ts

@@ -0,0 +1 @@
+export { BoardColumnHeader as DotBoardColumnHeader } from './ColumnHeader';

package/src/lib/components/board/column-items/ColumnItems.d.ts

@@ -0,0 +1,5 @@
+import { DotBoardColumnItemsProps } from '../interfaces';
+/**
+ * Container for items within a column
+ */
+export declare const BoardColumnItems: ({ ariaLabel, "data-testid": dataTestId, children, className, style, }: DotBoardColumnItemsProps) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/board/column-items/ColumnItems.styles.d.ts

@@ -0,0 +1,6 @@
+export declare const classNames: {
+    root: string;
+    spacingNormal: string;
+    spacingDense: string;
+};
+export declare const StyledBoardColumnItems: import("styled-components").StyledComponent<"div", any, {}, never>;

package/src/lib/components/board/column-items/index.d.ts

@@ -0,0 +1 @@
+export { BoardColumnItems as DotBoardColumnItems } from './ColumnItems';

package/src/lib/components/board/column-summary/ColumnSummary.d.ts

@@ -0,0 +1,5 @@
+import { DotBoardColumnSummaryProps } from '../interfaces';
+/**
+ * A summary component for a a column. Displays test verticially instead of horizonally.
+ */
+export declare const BoardColumnSummary: ({ ariaLabel, "data-testid": dataTestId, className, style, text, title, }: DotBoardColumnSummaryProps) => import("react/jsx-runtime").JSX.Element;

package/src/lib/components/board/column-summary/ColumnSummary.styles.d.ts

@@ -0,0 +1,8 @@
+export declare const classNames: {
+    root: string;
+    spacingNormal: string;
+    spacingDense: string;
+    title: string;
+    text: string;
+};
+export declare const StyledBoardColumnSummary: import("styled-components").StyledComponent<"div", any, {}, never>;

package/src/lib/components/board/column-summary/index.d.ts

@@ -0,0 +1 @@
+export { BoardColumnSummary as DotBoardColumnSummary } from './ColumnSummary';

package/src/lib/components/board/index.d.ts

@@ -0,0 +1,9 @@
+export { DotBoard, useBoardStatus, BoardStatusProvider } from './board';
+export { DotBoardColumn, useColumnStatus, ColumnStatusProvider } from './column';
+export { DotBoardColumnHeader } from './column-header';
+export { DotBoardColumnItems } from './column-items';
+export { DotBoardColumnActionBar } from './column-actionbar';
+export { DotBoardColumnExpand } from "./column-expand";
+export { DotBoardColumnCollapse } from "./column-collapse";
+export { DotBoardColumnSummary } from "./column-summary";
+export { DotBoardProps, DotBoardColumnProps, DotBoardColumnHeaderProps, DotBoardColumnItemsProps, DotBoardColumnActionBarProps, DotBoardColumnSummaryProps, BoardSpacing, IBoardStatusProvider, IBoardColumnStatusContext, IColumnStatusProvider } from './interfaces';

package/src/lib/components/board/interfaces.d.ts

@@ -0,0 +1,43 @@
+import React from 'react';
+import { CommonProps } from '../CommonProps';
+interface IStyles {
+    style?: React.CSSProperties;
+}
+export type BoardSpacing = 'dense' | 'normal';
+export interface IBoardStatusContext {
+    spacing: BoardSpacing;
+}
+export interface IBoardStatusProvider extends IBoardStatusContext {
+    children: React.ReactNode;
+}
+export interface IBoardColumnStatusContext {
+    collapsed: boolean;
+    setCollapsed: React.Dispatch<React.SetStateAction<boolean>>;
+}
+export interface IColumnStatusProvider {
+    children: React.ReactNode;
+    onCollapseToggle?: (newVal: boolean) => void;
+}
+export interface DotBoardProps extends CommonProps, IStyles {
+    children: React.ReactNode;
+    loading?: boolean;
+    spacing?: BoardSpacing;
+}
+export interface DotBoardColumnProps extends CommonProps, IStyles {
+    children: React.ReactNode;
+}
+export interface DotBoardColumnHeaderProps extends CommonProps, IStyles {
+    children: React.ReactNode;
+    lineBarHexColor?: string;
+}
+export interface DotBoardColumnItemsProps extends CommonProps, IStyles {
+    children: React.ReactNode;
+}
+export interface DotBoardColumnActionBarProps extends CommonProps, IStyles {
+    children: React.ReactNode;
+}
+export interface DotBoardColumnSummaryProps extends CommonProps, IStyles {
+    text: string;
+    title: string;
+}
+export {};

package/src/lib/components/core-api/openapi/models/ApplicationModel.d.ts

@@ -54,7 +54,7 @@ export type ApplicationModel = {
     /**
      * application URL
      */
-    url: string;
+    url?: string;
 };
 export declare namespace ApplicationModel {
     /**

package/src/lib/components/index.d.ts

@@ -44,6 +44,7 @@ export type { StepProps } from './stepper/Stepper';
 export type { CarouselAnimationVariant, CarouselNavigationButtonDisplayOption, CarouselProps, } from './carousel/Carousel';
 export type { StickyWithBorderProps } from './sticky-with-border';
 export type { TooltipProps, TooltipHoverVisibility, TooltipPlacement, } from './tooltip';
+export type { DashboardHeaderProps } from './analytics/dashboard-header/DashboardHeader';
 export { DotAccordion } from './accordion/Accordion';
 export { DotActionToolbar } from './action-toolbar/ActionToolbar';
 export { DotAlertBanner } from './alert-banner/AlertBanner';
@@ -69,6 +70,11 @@ export { DotCoreApiProvider, useDotCoreApiContext, } from './core-api/CoreApiPro
 export { Cell, CssCell } from './css-grid/CssCell';
 export { CssGrid } from './css-grid/CssGrid';
 export { CssGridDebug } from './css-grid/CssGridDebug';
+export { DashboardAppTypeOptions, DashboardData, DotDashboardDialog, } from './analytics/dashboard-dialog/DashboardDialog';
+export { DotDashboardActions } from './analytics/dashboard-actions/DashboardActions';
+export { DotDashboardHeader } from './analytics/dashboard-header/DashboardHeader';
+export { DotDashboardOptionsMenu } from './analytics/dashboard-actions/DashboardOptionsMenu';
+export { DotDashboardPublishConfirm } from './analytics/dashboard-actions/DashboardPublishConfirm';
 export { DotDialog } from './dialog/Dialog';
 export { DotDrawer } from './drawer/Drawer';
 export { DotEmptyState } from './empty-state/EmptyState';
@@ -84,6 +90,7 @@ export { DotInputSelect } from './input-form-fields/InputSelect';
 export { DotLink } from './link/Link';
 export { DotList } from './list';
 export { DotMenu } from './menu/Menu';
+export { DotMetadataApiProvider, useDotMetadataApiContext, } from './analytics/metadata-api/MetadataApiProvider';
 export { DotNavigationRail } from './navigation-rail';
 export { DotPill } from './pill/Pill';
 export { DotProgress } from './progress';
@@ -91,7 +98,7 @@ export { DotRadioButton } from './radio/RadioButton';
 export { DotRadioGroup } from './radio/RadioGroup';
 export { DotSidebar } from './sidebar/Sidebar';
 export { DotSkeleton } from './skeleton/Skeleton';
-export { DotSnackbar, DotSnackbarContainer, DotSnackbarProvider, useDotSnackbarContext, } from './snackbar';
+export { DotSnackbar, DotSnackbarContainer, DotSnackbarProvider, useDotSnackbarContext, useEnqueueErrorMessage, } from './snackbar';
 export { DotSplitButton } from './split-button/SplitButton';
 export { DotStepper } from './stepper/Stepper';
 export { DotProgressButton } from './progress-button/ProgressButton';

package/src/lib/components/snackbar/SnackbarProvider.d.ts

@@ -1,4 +1,5 @@
 import { ReactNode } from 'react';
+import { GenericApiError } from './utils/helpers';
 import { SnackbarPrimaryAction, SnackbarSecondaryAction, SnackbarSeverity } from './Snackbar';
 declare const initialState: {
     message: string;
@@ -26,4 +27,5 @@ export declare const DotSnackbarContext: import("react").Context<DotSnackbarProp
 export declare const DotSnackbarContainer: ({ hideOnClickAway, }: SnackbarContainerProps) => import("react/jsx-runtime").JSX.Element;
 export declare const DotSnackbarProvider: ({ children, hideOnClickAway, }: SnackbarProviderProps) => import("react/jsx-runtime").JSX.Element;
 export declare const useDotSnackbarContext: () => DotSnackbarProps;
+export declare const useEnqueueErrorMessage: (error: GenericApiError | Error) => void;
 export {};

package/src/lib/components/snackbar/index.d.ts

@@ -1,4 +1,4 @@
 export type { SnackbarOrigin } from '@mui/material';
 export type { SnackbarProps, SnackbarSeverity, SnackbarPrimaryAction, SnackbarSecondaryAction, } from './Snackbar';
 export { DotSnackbar } from './Snackbar';
-export { DotSnackbarContainer, DotSnackbarProvider, useDotSnackbarContext, } from './SnackbarProvider';
+export { DotSnackbarContainer, DotSnackbarProvider, useDotSnackbarContext, useEnqueueErrorMessage, } from './SnackbarProvider';

package/src/lib/components/snackbar/utils/helpers.d.ts

@@ -1,2 +1,11 @@
 import { SnackbarSeverity } from '../Snackbar';
 export declare const getSnackbarTitleFromSeverity: (severity: SnackbarSeverity) => "Success" | "Warning" | "Error" | "Info";
+export type GenericApiError = {
+    body: {
+        error: {
+            message: string;
+        };
+    };
+    status: number;
+};
+export declare function getErrorText(error: GenericApiError | Error): string;

package/src/lib/utils/index.d.ts

@@ -0,0 +1,10 @@
+export * from './cancelable-promise/CancelablePromise';
+export declare const getPlatformConsoleUrlFromToken: (encodedToken: string) => string;
+/**
+ * Detects the MIME type of an image based on the first few bytes of the image data
+ * @param b64 Base64 encoded image data
+ * @param defaultMimeType mime type to return if it can't be determined from the given b64 string
+ *
+ * @returns mime type string
+ */
+export declare function detectImageMimeType(b64?: string, defaultMimeType?: string): string;