@procore/saved-views 5.0.0-alpha.4

package/dist/modern/index.d.mts

@@ -0,0 +1,167 @@
+import { Locale, MapLocalesToTranslations } from '@procore/globalization-toolkit';
+import * as React from 'react';
+import React__default from 'react';
+import { DataTableConfig, TableApi, ColumnDefinition } from '@procore/data-table';
+import { ColumnState, FilterModel, GridApi } from 'ag-grid-community';
+import * as styled_components from 'styled-components';
+import { UseQueryResult, UseMutationResult } from '@tanstack/react-query';
+
+declare function getTranslations(envLocale: Locale): Partial<MapLocalesToTranslations>;
+
+declare const useSavedViewsPanel: (domain: string, tableName: string) => {
+    isOpen: boolean;
+    SavedViewsButton: () => React__default.JSX.Element;
+};
+
+interface IQueryInputProps {
+    domain: string;
+    tableName: string;
+    enableSavedViews: boolean;
+    projectId?: number;
+    companyId?: number;
+}
+
+interface ISmartGridConfig {
+    columnState: ColumnState[];
+    columnGroupState: {
+        groupId: string;
+        open: boolean;
+    }[];
+    rowGroupState: string[];
+    rowHeight: number | undefined;
+    filterState: FilterModel;
+}
+
+declare const VIEW_LEVELS: readonly ["company", "project", "personal"];
+type ViewLevel = (typeof VIEW_LEVELS)[number];
+
+interface ISavedView {
+    id: string;
+    name: string;
+    description?: string;
+    table_config?: DataTableConfig | ISmartGridConfig;
+    view_level: ViewLevel | 'default';
+}
+
+type TableProvider = 'smart-grid' | 'data-table';
+
+interface ISavedViewError {
+    code: string;
+    message: string | Record<string, string[]> | Record<string, string>;
+}
+
+interface IPermissions {
+    can_create_project_saved_views: boolean;
+    can_create_company_saved_views: boolean;
+}
+
+interface ISavedViewsBackend {
+    useSavedViewsQuery: (props: IQueryInputProps) => UseQueryResult<ISavedView[], Error>;
+    useSavedViewsPermissions: (props: IQueryInputProps) => UseQueryResult<IPermissions, Error>;
+    useCreateSavedView: (props: IQueryInputProps) => UseMutationResult<ISavedView, ISavedViewError, ISavedView, unknown>;
+    useUpdateSavedView: (props: IQueryInputProps) => UseMutationResult<ISavedView, ISavedViewError, ISavedView, unknown>;
+    useDeleteSavedView: (props: IQueryInputProps) => UseMutationResult<ISavedView, ISavedViewError, ISavedView, unknown>;
+}
+interface IBaseSavedViewsProps {
+    tableName: string;
+    domain: string;
+    stickyViewsKey: string;
+    enableSavedViews: boolean;
+    userId: string;
+    projectId: number;
+    companyId: number;
+    backend?: ISavedViewsBackend;
+}
+
+interface IDataTableSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
+    tableApi: TableApi;
+    onTableConfigChange: (config: DataTableConfig) => void;
+    defaultViewName?: string;
+    defaultViewConfig?: DataTableConfig;
+    columnDefinitions: ColumnDefinition[];
+}
+
+interface ISmartGridSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
+    gridApi: GridApi;
+    defaultViewName?: string;
+    defaultViewFilters: FilterModel | null;
+    defaultRowHeight: number;
+    transformSettings?: (config: ISmartGridConfig) => ISmartGridConfig;
+}
+
+type SavedViewCollectionMenuItemProps = {
+    item: ISavedView;
+    key?: string;
+    selected: boolean;
+    canUpdate?: boolean;
+    canEditOrDelete?: boolean;
+    onUpdate?: (data: ISavedView) => void;
+    onDelete?: (data: {
+        savedView: ISavedView;
+    }) => void;
+    onEdit?: (data: {
+        savedView: ISavedView;
+    }) => void;
+    isUpdateProcessing?: boolean;
+    permissions?: IPermissions;
+};
+declare const SavedViewCollectionMenuItem: (props: SavedViewCollectionMenuItemProps) => React.JSX.Element;
+
+declare const ExpandedPanel: styled_components.StyledComponent<any, any, any, any>;
+
+declare enum ModalType {
+    CREATE = "create",
+    UPDATE = "update"
+}
+
+type PanelContentProps = {
+    openModal: (type: ModalType) => void;
+    onDelete: () => void;
+    onSelect: (data: {
+        item: ISavedView;
+    }) => void;
+    updateLocalStorage: (data: ISavedView) => void;
+    setSelectedSavedView: (data: ISavedView) => void;
+    queryInput: IQueryInputProps;
+    selectedSavedView: ISavedView | undefined;
+    tableConfig: DataTableConfig | ISmartGridConfig;
+    provider: TableProvider;
+    defaultView: ISavedView;
+    stickyViewsKey: string;
+    userId: string;
+    backend: ISavedViewsBackend;
+};
+declare const PanelContent: (props: PanelContentProps) => React__default.JSX.Element;
+
+declare const SmartGridSavedViews: (props: ISmartGridSavedViewsExternalConsumerProps) => React__default.JSX.Element;
+
+interface IDataTableSavedViewsRef {
+    setTableConfig: (config: DataTableConfig) => void;
+}
+declare const DataTableSavedViews: React__default.ForwardRefExoticComponent<IDataTableSavedViewsExternalConsumerProps & React__default.RefAttributes<IDataTableSavedViewsRef>>;
+
+type Props = {
+    onDelete(): void;
+    onCancel(): void;
+    open: boolean;
+};
+declare const SavedViewsDeleteConfirmationModalShared: React__default.FC<Props>;
+
+type SavedViewsFormModalProps = {
+    open: boolean;
+    mode: ModalType;
+    isLoading?: boolean;
+    onCancel(): void;
+    queryInput: IQueryInputProps;
+    tableConfig: DataTableConfig | ISmartGridConfig;
+    tableName: string;
+    selectedSavedView: ISavedView | undefined;
+    setSelectedSavedView: (data: ISavedView) => void;
+    onSelect: (item: ISavedView) => void;
+    setOpenEditCreateModal: (open: boolean) => void;
+    defaultView: ISavedView;
+    backend: ISavedViewsBackend;
+};
+declare const SavedViewsFormModal: React__default.FC<SavedViewsFormModalProps>;
+
+export { DataTableSavedViews, ExpandedPanel, type IDataTableSavedViewsRef, PanelContent, type PanelContentProps, SavedViewCollectionMenuItem, SavedViewsDeleteConfirmationModalShared, SavedViewsFormModal, SmartGridSavedViews, getTranslations, useSavedViewsPanel };

package/dist/modern/index.d.ts

@@ -0,0 +1,167 @@
+import { Locale, MapLocalesToTranslations } from '@procore/globalization-toolkit';
+import * as React from 'react';
+import React__default from 'react';
+import { DataTableConfig, TableApi, ColumnDefinition } from '@procore/data-table';
+import { ColumnState, FilterModel, GridApi } from 'ag-grid-community';
+import * as styled_components from 'styled-components';
+import { UseQueryResult, UseMutationResult } from '@tanstack/react-query';
+
+declare function getTranslations(envLocale: Locale): Partial<MapLocalesToTranslations>;
+
+declare const useSavedViewsPanel: (domain: string, tableName: string) => {
+    isOpen: boolean;
+    SavedViewsButton: () => React__default.JSX.Element;
+};
+
+interface IQueryInputProps {
+    domain: string;
+    tableName: string;
+    enableSavedViews: boolean;
+    projectId?: number;
+    companyId?: number;
+}
+
+interface ISmartGridConfig {
+    columnState: ColumnState[];
+    columnGroupState: {
+        groupId: string;
+        open: boolean;
+    }[];
+    rowGroupState: string[];
+    rowHeight: number | undefined;
+    filterState: FilterModel;
+}
+
+declare const VIEW_LEVELS: readonly ["company", "project", "personal"];
+type ViewLevel = (typeof VIEW_LEVELS)[number];
+
+interface ISavedView {
+    id: string;
+    name: string;
+    description?: string;
+    table_config?: DataTableConfig | ISmartGridConfig;
+    view_level: ViewLevel | 'default';
+}
+
+type TableProvider = 'smart-grid' | 'data-table';
+
+interface ISavedViewError {
+    code: string;
+    message: string | Record<string, string[]> | Record<string, string>;
+}
+
+interface IPermissions {
+    can_create_project_saved_views: boolean;
+    can_create_company_saved_views: boolean;
+}
+
+interface ISavedViewsBackend {
+    useSavedViewsQuery: (props: IQueryInputProps) => UseQueryResult<ISavedView[], Error>;
+    useSavedViewsPermissions: (props: IQueryInputProps) => UseQueryResult<IPermissions, Error>;
+    useCreateSavedView: (props: IQueryInputProps) => UseMutationResult<ISavedView, ISavedViewError, ISavedView, unknown>;
+    useUpdateSavedView: (props: IQueryInputProps) => UseMutationResult<ISavedView, ISavedViewError, ISavedView, unknown>;
+    useDeleteSavedView: (props: IQueryInputProps) => UseMutationResult<ISavedView, ISavedViewError, ISavedView, unknown>;
+}
+interface IBaseSavedViewsProps {
+    tableName: string;
+    domain: string;
+    stickyViewsKey: string;
+    enableSavedViews: boolean;
+    userId: string;
+    projectId: number;
+    companyId: number;
+    backend?: ISavedViewsBackend;
+}
+
+interface IDataTableSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
+    tableApi: TableApi;
+    onTableConfigChange: (config: DataTableConfig) => void;
+    defaultViewName?: string;
+    defaultViewConfig?: DataTableConfig;
+    columnDefinitions: ColumnDefinition[];
+}
+
+interface ISmartGridSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
+    gridApi: GridApi;
+    defaultViewName?: string;
+    defaultViewFilters: FilterModel | null;
+    defaultRowHeight: number;
+    transformSettings?: (config: ISmartGridConfig) => ISmartGridConfig;
+}
+
+type SavedViewCollectionMenuItemProps = {
+    item: ISavedView;
+    key?: string;
+    selected: boolean;
+    canUpdate?: boolean;
+    canEditOrDelete?: boolean;
+    onUpdate?: (data: ISavedView) => void;
+    onDelete?: (data: {
+        savedView: ISavedView;
+    }) => void;
+    onEdit?: (data: {
+        savedView: ISavedView;
+    }) => void;
+    isUpdateProcessing?: boolean;
+    permissions?: IPermissions;
+};
+declare const SavedViewCollectionMenuItem: (props: SavedViewCollectionMenuItemProps) => React.JSX.Element;
+
+declare const ExpandedPanel: styled_components.StyledComponent<any, any, any, any>;
+
+declare enum ModalType {
+    CREATE = "create",
+    UPDATE = "update"
+}
+
+type PanelContentProps = {
+    openModal: (type: ModalType) => void;
+    onDelete: () => void;
+    onSelect: (data: {
+        item: ISavedView;
+    }) => void;
+    updateLocalStorage: (data: ISavedView) => void;
+    setSelectedSavedView: (data: ISavedView) => void;
+    queryInput: IQueryInputProps;
+    selectedSavedView: ISavedView | undefined;
+    tableConfig: DataTableConfig | ISmartGridConfig;
+    provider: TableProvider;
+    defaultView: ISavedView;
+    stickyViewsKey: string;
+    userId: string;
+    backend: ISavedViewsBackend;
+};
+declare const PanelContent: (props: PanelContentProps) => React__default.JSX.Element;
+
+declare const SmartGridSavedViews: (props: ISmartGridSavedViewsExternalConsumerProps) => React__default.JSX.Element;
+
+interface IDataTableSavedViewsRef {
+    setTableConfig: (config: DataTableConfig) => void;
+}
+declare const DataTableSavedViews: React__default.ForwardRefExoticComponent<IDataTableSavedViewsExternalConsumerProps & React__default.RefAttributes<IDataTableSavedViewsRef>>;
+
+type Props = {
+    onDelete(): void;
+    onCancel(): void;
+    open: boolean;
+};
+declare const SavedViewsDeleteConfirmationModalShared: React__default.FC<Props>;
+
+type SavedViewsFormModalProps = {
+    open: boolean;
+    mode: ModalType;
+    isLoading?: boolean;
+    onCancel(): void;
+    queryInput: IQueryInputProps;
+    tableConfig: DataTableConfig | ISmartGridConfig;
+    tableName: string;
+    selectedSavedView: ISavedView | undefined;
+    setSelectedSavedView: (data: ISavedView) => void;
+    onSelect: (item: ISavedView) => void;
+    setOpenEditCreateModal: (open: boolean) => void;
+    defaultView: ISavedView;
+    backend: ISavedViewsBackend;
+};
+declare const SavedViewsFormModal: React__default.FC<SavedViewsFormModalProps>;
+
+export { DataTableSavedViews, ExpandedPanel, type IDataTableSavedViewsRef, PanelContent, type PanelContentProps, SavedViewCollectionMenuItem, SavedViewsDeleteConfirmationModalShared, SavedViewsFormModal, SmartGridSavedViews, getTranslations, useSavedViewsPanel };