refactor: use generic model insights for frontend features (#13072)

* feat:generic model insights

inspired by https://github.com/inventree/InvenTree/pull/13069 this adds a more general approach to generic features like attachments, notes

some tests and functions written with assistance of AI

* lazy load panels

* add pr version

* fix snapshot issue

* move history panel to new generic mechanism

* Update api_version.py

* move to generic

* remove duplicate

* clean up import

* fix test

* add ignore for broken contract in test
This commit is contained in:
Matthias Mair authored and GitHub committed 2026-11-16 09:45:17 +11:00
1 parent 016f965ac8
commit a87489ca44
32 files changed
+533 -477

No files matched your search

+13
View File
@@ -0,0 +1,13 @@
/*
* Enumeration of builtin model features (as reported by the server)
*/
export enum ModelFeature {
attachments = 'org.inventree.i.modelfeatures.attachments',
notes = 'org.inventree.i.modelfeatures.notes',
parameters = 'org.inventree.i.modelfeatures.parameters',
barcode = 'org.inventree.i.modelfeatures.barcode',
tags = 'org.inventree.i.modelfeatures.tags',
image = 'org.inventree.i.modelfeatures.image',
report = 'org.inventree.i.modelfeatures.report',
history = 'org.inventree.i.modelfeatures.history'
}
+23
View File
@@ -1,4 +1,5 @@
import type { ReactNode } from 'react';
import type { SettingsStateProps } from './Settings';
// The type of indicator dot to be shown against a panel
export type PanelIndicatorType = 'info' | 'warning' | 'danger' | null;
@@ -20,6 +21,28 @@ export type PanelType = {
hotkey?: string;
};
/**
* Properties passed to a factory function which builds a panel for a generic model feature
*
* @param model - The model type (e.g. 'part', or a plugin defined model)
* @param id - The primary key of the model instance
* @param instanceInfo - Aggregated counts for the instance (e.g. attachment_count)
*/
export type ModelFeaturePanelProps = {
model: string;
id: number;
instanceInfo: Record<string, number | undefined>;
userSettings: SettingsStateProps;
globalSettings: SettingsStateProps;
};
/**
* Factory function which builds a panel for a generic model feature (e.g. 'attachments')
*/
export type ModelFeaturePanelFactory = (
props: Readonly<ModelFeaturePanelProps>
) => PanelType | Promise<PanelType>;
/**
* Type used to specify a group of panels
*/
@@ -1,39 +1,13 @@
import { t } from '@lingui/core/macro';
import { Skeleton } from '@mantine/core';
import { IconHistory } from '@tabler/icons-react';
import { useMemo } from 'react';
import type { ModelType } from '@lib/enums/ModelType';
import type { PanelType } from '@lib/types/Panel';
import {
useGlobalSettingsState,
useUserSettingsState
} from '../../states/SettingsStates';
import { AuditLogTable } from '../../tables/general/AuditLogTable';
/**
* Determine whether the history panel should be displayed on detail pages:
* - The audit log must be enabled
* - Must be enabled via the 'DISPLAY_HISTORY_TAB' user setting
*
* Note: The displayed entries are filtered by the permissions of the user
*/
export function useShowHistoryPanel(): boolean {
const userSettings = useUserSettingsState();
const globalSettings = useGlobalSettingsState();
return useMemo(
() =>
globalSettings.isSet('AUDIT_LOG_ENABLED') &&
userSettings.isSet('DISPLAY_HISTORY_TAB', false),
[userSettings, globalSettings]
);
}
/**
* Panel displaying the audit log (change history) for a model instance.
* Only add this panel to detail pages for models which are audited,
* and pass the result of useShowHistoryPanel() as 'visible'.
*/
export default function HistoryPanel({
model_type,
@@ -0,0 +1,52 @@
import { ModelFeature } from '@lib/enums/ModelFeature';
import type { ModelType } from '@lib/enums/ModelType';
import type { ModelFeaturePanelFactory } from '@lib/types/Panel';
/**
* Lookup of panels for generic model features (as reported by the server).
*
* The order of entries defines the order in which the panels are displayed.
*/
export const ModelFeaturePanelLookup: Record<string, ModelFeaturePanelFactory> =
{
[ModelFeature.parameters]: async ({ model, id, instanceInfo }) => {
const { default: ParametersPanel } = await import('./ParametersPanel');
return ParametersPanel({
model_type: model as ModelType,
model_id: id,
parameter_count: instanceInfo.parameter_count
});
},
[ModelFeature.attachments]: async ({ model, id, instanceInfo }) => {
const { default: AttachmentPanel } = await import('./AttachmentPanel');
return AttachmentPanel({
model_type: model as ModelType,
model_id: id,
attachment_count: instanceInfo.attachment_count
});
},
[ModelFeature.notes]: async ({ model, id, instanceInfo }) => {
const { default: NotesPanel } = await import('./NotesPanel');
return NotesPanel({
model_type: model as ModelType,
model_id: id,
note_count: instanceInfo.note_count
});
},
[ModelFeature.history]: async ({
model,
id,
userSettings,
globalSettings
}) => {
const { default: HistoryPanel } = await import('./HistoryPanel');
const visible =
globalSettings.isSet('AUDIT_LOG_ENABLED') &&
userSettings.isSet('DISPLAY_HISTORY_TAB', false);
return HistoryPanel({
model_type: model as ModelType,
model_id: id,
visible
});
}
};
@@ -57,6 +57,7 @@ import { useDocumentVisibility, useWindowEvent } from '@mantine/hooks';
import { modals } from '@mantine/modals';
import { useQuery } from '@tanstack/react-query';
import { useShallow } from 'zustand/react/shallow';
import { useModelPanels } from '../../hooks/UseModelPanels';
import { usePluginPanels } from '../../hooks/UsePluginPanels';
import { useLocalState } from '../../states/LocalState';
import { vars } from '../../theme';
@@ -559,10 +560,22 @@ function IndexPanelComponent({
* @param collapsible - If true, the panel group can be collapsed (defaults to true)
*/
export function PanelGroup(props: Readonly<PanelProps>) {
const panels = useModelPanels({
model: props.model,
id: props.id,
panels: props.panels
});
return (
<Routes>
<Route index element={<IndexPanelComponent {...props} />} />
<Route path='/:panel/*' element={<BasePanelGroup {...props} />} />
<Route
index
element={<IndexPanelComponent {...props} panels={panels} />}
/>
<Route
path='/:panel/*'
element={<BasePanelGroup {...props} panels={panels} />}
/>
</Routes>
);
}
@@ -40,6 +40,8 @@ export function useInstanceInfo({
// dots themselves - a stale value for a few minutes is an acceptable
// trade-off against refetching on every page navigation/remount.
staleTime: 5 * 60 * 1000,
placeholderData: (previousData, previousQuery) =>
previousQuery?.queryKey[1] === modelType ? previousData : undefined,
queryFn: async () => {
return api
.get(apiUrl(ApiEndpoints.instance_info), {
+98
View File
@@ -0,0 +1,98 @@
import type { ModelType } from '@lib/enums/ModelType';
import type { PanelType } from '@lib/types/Panel';
import { useEffect, useMemo, useState } from 'react';
import { ModelFeaturePanelLookup } from '../components/panels/ModelFeaturePanels';
import { useModelFeatures } from '../states/ModelFeatureState';
import {
useGlobalSettingsState,
useUserSettingsState
} from '../states/SettingsStates';
import { useInstanceInfo } from './UseInstanceInfo';
/**
* Append panels for generic model features (e.g. parameters, attachments, notes)
* to a set of panels, based on the features which the target model supports on the server.
*
* Works for any model type known to the server, including plugin defined models.
* Panels which are already defined (by name) in the provided list are not replaced.
*/
export function useModelPanels({
model,
id,
panels
}: {
model?: ModelType | string;
id?: number | null;
panels: PanelType[];
}): PanelType[] {
const features = useModelFeatures(model);
const featureFactories = useMemo(
() =>
Object.entries(ModelFeaturePanelLookup)
.filter(([feature]) => features.includes(feature))
.map(([, factory]) => factory),
[features]
);
const [loadedPanels, setLoadedPanels] = useState<{
model: string;
id: number;
panels: PanelType[];
}>();
const { instanceInfo } = useInstanceInfo({
modelType: featureFactories.length > 0 ? (model as ModelType) : undefined,
modelId: id ?? undefined
});
const userSettings = useUserSettingsState();
const globalSettings = useGlobalSettingsState();
// lazy load feature panels
useEffect(() => {
if (!model || !id || featureFactories.length === 0) {
return;
}
let cancelled = false;
Promise.all(
featureFactories.map((factory) =>
factory({
model,
id,
instanceInfo: { ...instanceInfo },
userSettings,
globalSettings
})
)
)
.then((panels) => {
if (!cancelled) {
setLoadedPanels({ model, id, panels });
}
})
.catch((error: unknown) => {
console.error('ERR: Error loading model feature panels', error);
});
return () => {
cancelled = true;
};
}, [model, id, featureFactories, instanceInfo, userSettings, globalSettings]);
return useMemo(() => {
if (
!model ||
!id ||
loadedPanels?.model !== model ||
loadedPanels.id !== id
) {
return panels;
}
const existing = new Set(panels.map((panel) => panel.name));
const featurePanels = loadedPanels.panels.filter(
(panel) => !existing.has(panel.name)
);
return [...panels, ...featurePanels];
}, [model, id, panels, loadedPanels]);
}
+2 -39
View File
@@ -37,13 +37,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { StatusRenderer } from '../../components/render/StatusRenderer';
import { RenderStockLocation } from '../../components/render/Stock';
import { useBuildOrderFields } from '../../forms/BuildForms';
@@ -52,7 +46,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import useStatusCodes from '../../hooks/UseStatusCodes';
import { useGlobalSettingsState } from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
@@ -235,13 +228,6 @@ export default function BuildDetail() {
refetchOnMount: true
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.build,
modelId: build?.pk
});
const showHistory = useShowHistoryPanel();
const buildPanels: PanelType[] = useMemo(() => {
return [
{
@@ -365,41 +351,18 @@ export default function BuildDetail() {
) : (
<Skeleton />
)
},
ParametersPanel({
model_type: ModelType.build,
model_id: build.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.build,
model_id: build.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.build,
model_id: build.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.build,
model_id: build.pk,
visible: showHistory
})
}
];
}, [
build,
id,
user,
instanceInfo,
buildStatus,
globalSettings,
showChildBuilds,
buildLineQuery.isFetching,
buildLineQuery.isLoading,
buildLineData,
showHistory
buildLineData
]);
const editBuildOrderFields = useBuildOrderFields({
@@ -30,13 +30,7 @@ import {
import type { Breadcrumb } from '../../components/nav/BreadcrumbList';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { companyFields } from '../../forms/CompanyForms';
import {
useCreateApiFormModal,
@@ -44,7 +38,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import { useUserState } from '../../states/UserState';
import { AddressTable } from '../../tables/company/AddressTable';
import { ContactTable } from '../../tables/company/ContactTable';
@@ -84,11 +77,6 @@ export default function CompanyDetail(props: Readonly<CompanyDetailProps>) {
refetchOnMount: true
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.company,
modelId: company?.pk
});
const detailsPanel = instanceQuery.isFetching ? (
<Skeleton />
) : (
@@ -99,8 +87,6 @@ export default function CompanyDetail(props: Readonly<CompanyDetailProps>) {
/>
);
const showHistory = useShowHistoryPanel();
const companyPanels: PanelType[] = useMemo(() => {
return [
{
@@ -201,29 +187,9 @@ export default function CompanyDetail(props: Readonly<CompanyDetailProps>) {
label: t`Addresses`,
icon: <IconMap2 />,
content: company?.pk && <AddressTable companyId={company.pk} />
},
ParametersPanel({
model_type: ModelType.company,
model_id: company?.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.company,
model_id: company.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.company,
model_id: company.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.company,
model_id: company.pk,
visible: showHistory
})
}
];
}, [id, company, user, instanceInfo, showHistory]);
}, [id, company, user]);
const editCompany = useEditApiFormModal({
url: ApiEndpoints.company_list,
@@ -22,13 +22,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { useManufacturerPartFields } from '../../forms/CompanyForms';
import {
useCreateApiFormModal,
@@ -36,7 +30,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import { useUserState } from '../../states/UserState';
import { SupplierPartTable } from '../../tables/purchasing/SupplierPartTable';
import { StockItemTable } from '../../tables/stock/StockItemTable';
@@ -62,13 +55,6 @@ export default function ManufacturerPartDetail() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.manufacturerpart,
modelId: manufacturerPart?.pk
});
const showHistory = useShowHistoryPanel();
const panels: PanelType[] = useMemo(() => {
return [
{
@@ -110,29 +96,9 @@ export default function ManufacturerPartDetail() {
) : (
<Skeleton />
)
},
ParametersPanel({
model_type: ModelType.manufacturerpart,
model_id: manufacturerPart?.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.manufacturerpart,
model_id: manufacturerPart?.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.manufacturerpart,
model_id: manufacturerPart?.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.manufacturerpart,
model_id: manufacturerPart?.pk,
visible: showHistory
})
}
];
}, [user, manufacturerPart, instanceInfo, showHistory]);
}, [user, manufacturerPart]);
const editManufacturerPartFields = useManufacturerPartFields();
@@ -26,13 +26,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { useSupplierPartFields } from '../../forms/CompanyForms';
import {
useCreateApiFormModal,
@@ -40,7 +34,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import { useUserState } from '../../states/UserState';
import { PurchaseOrderTable } from '../../tables/purchasing/PurchaseOrderTable';
import SupplierPriceBreakTable from '../../tables/purchasing/SupplierPriceBreakTable';
@@ -70,13 +63,6 @@ export default function SupplierPartDetail() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.supplierpart,
modelId: supplierPart?.pk
});
const showHistory = useShowHistoryPanel();
const panels: PanelType[] = useMemo(() => {
return [
{
@@ -127,29 +113,9 @@ export default function SupplierPartDetail() {
) : (
<Skeleton />
)
},
ParametersPanel({
model_type: ModelType.supplierpart,
model_id: supplierPart?.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.supplierpart,
model_id: supplierPart?.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.supplierpart,
model_id: supplierPart?.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.supplierpart,
model_id: supplierPart?.pk,
visible: showHistory
})
}
];
}, [supplierPart, instanceInfo, showHistory]);
}, [supplierPart]);
const supplierPartActions = useMemo(() => {
return [
+2 -26
View File
@@ -30,11 +30,7 @@ import { ApiIcon } from '../../components/items/ApiIcon';
import InstanceDetail from '../../components/nav/InstanceDetail';
import NavigationTree from '../../components/nav/NavigationTree';
import { PageDetail } from '../../components/nav/PageDetail';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import SegmentedControlPanel from '../../components/panels/SegmentedControlPanel';
import { partCategoryFields } from '../../forms/PartForms';
import {
@@ -42,7 +38,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import { useStockAdjustActions } from '../../hooks/UseStockAdjustActions';
import { useUserSettingsState } from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
@@ -84,11 +79,6 @@ export default function CategoryDetail() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.partcategory,
modelId: category?.pk
});
const stockOperationProps: StockOperationProps = useMemo(() => {
return {
refresh: refreshInstance,
@@ -201,8 +191,6 @@ export default function CategoryDetail() {
defaultValue: 'table'
});
const showHistory = useShowHistoryPanel();
const panels: PanelType[] = useMemo(
() => [
{
@@ -262,27 +250,15 @@ export default function CategoryDetail() {
/>
)
},
ParametersPanel({
model_type: ModelType.partcategory,
model_id: category?.pk,
hidden: !id || !category.pk,
parameter_count: instanceInfo.parameter_count
}),
{
name: 'category_parameters',
label: t`Parameter Templates`,
icon: <IconListCheck />,
hidden: !id || !category.pk,
content: <PartCategoryTemplateTable categoryId={category?.pk} />
},
HistoryPanel({
model_type: ModelType.partcategory,
model_id: category?.pk,
// Not shown for the top-level (root) category view
visible: showHistory && !!id && !!category?.pk
})
}
],
[category, id, partsView, instanceInfo, showHistory]
[category, id, partsView]
);
const breadcrumbs = useMemo(
+3 -25
View File
@@ -63,11 +63,6 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import NavigationTree from '../../components/nav/NavigationTree';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import { RenderPart } from '../../components/render/Part';
import OrderPartsWizard from '../../components/wizards/OrderPartsWizard';
@@ -287,8 +282,6 @@ export default function PartDetail() {
}, [enableRevisionSelection, part, partRevisionOptions]);
// Part data panels (recalculate when part data changes)
const showHistory = useShowHistoryPanel();
const partPanels: PanelType[] = useMemo(() => {
return [
{
@@ -489,6 +482,7 @@ export default function PartDetail() {
icon: <IconLayersLinked />,
content: <RelatedPartTable partId={part.pk} />
},
// TODO: remove this panel once generic model locking is available
{
name: 'parameters',
label: t`Parameters`,
@@ -513,22 +507,7 @@ export default function PartDetail() {
/>
</>
)
},
AttachmentPanel({
model_type: ModelType.part,
model_id: part?.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.part,
model_id: part?.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.part,
model_id: part?.pk,
visible: showHistory
})
}
];
}, [
id,
@@ -539,8 +518,7 @@ export default function PartDetail() {
bomInformation,
revisionSelector,
refreshInstance,
instanceInfo,
showHistory
instanceInfo
]);
const breadcrumbs = useMemo(() => {
@@ -23,13 +23,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { StatusRenderer } from '../../components/render/StatusRenderer';
import { usePurchaseOrderFields } from '../../forms/PurchaseOrderForms';
import {
@@ -37,7 +31,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import useStatusCodes from '../../hooks/UseStatusCodes';
import { useGlobalSettingsState } from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
@@ -69,11 +62,6 @@ export default function PurchaseOrderDetail() {
refetchOnMount: true
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.purchaseorder,
modelId: order?.pk
});
const orderCurrency = useMemo(
() =>
order.order_currency ||
@@ -135,8 +123,6 @@ export default function PurchaseOrderDetail() {
modelType: ModelType.purchaseorder
});
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -206,35 +192,9 @@ export default function PurchaseOrderDetail() {
}}
/>
)
},
ParametersPanel({
model_type: ModelType.purchaseorder,
model_id: order.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.purchaseorder,
model_id: order.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.purchaseorder,
model_id: order.pk,
note_count: instanceInfo.note_count,
// TODO @matmair - change API to include a "locked" attribute that we can check here
editable:
order.status == poStatus.COMPLETE &&
!globalSettings.isSet('PURCHASEORDER_EDIT_COMPLETED_ORDERS')
? false
: undefined
}),
HistoryPanel({
model_type: ModelType.purchaseorder,
model_id: order.pk,
visible: showHistory
})
}
];
}, [order, id, user, instanceInfo, showHistory]);
}, [order, id, user]);
const issueOrder = useCreateApiFormModal({
url: apiUrl(ApiEndpoints.purchase_order_issue, order.pk),
@@ -23,13 +23,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { StatusRenderer } from '../../components/render/StatusRenderer';
import { useReturnOrderFields } from '../../forms/ReturnOrderForms';
import {
@@ -37,7 +31,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import useStatusCodes from '../../hooks/UseStatusCodes';
import { useGlobalSettingsState } from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
@@ -68,11 +61,6 @@ export default function ReturnOrderDetail() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.returnorder,
modelId: order?.pk
});
const roStatus = useStatusCodes({ modelType: ModelType.returnorder });
const orderOpen = useMemo(() => {
@@ -100,8 +88,6 @@ export default function ReturnOrderDetail() {
);
}, [order, globalSettings]);
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -158,29 +144,9 @@ export default function ReturnOrderDetail() {
</Accordion.Item>
</Accordion>
)
},
ParametersPanel({
model_type: ModelType.returnorder,
model_id: order.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.returnorder,
model_id: order.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.returnorder,
model_id: order.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.returnorder,
model_id: order.pk,
visible: showHistory
})
}
];
}, [order, id, user, instanceInfo, showHistory]);
}, [order, id, user]);
const orderBadges: ReactNode[] = useMemo(() => {
return instanceQuery.isLoading
@@ -29,13 +29,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { StatusRenderer } from '../../components/render/StatusRenderer';
import { useSalesOrderFields } from '../../forms/SalesOrderForms';
import {
@@ -43,7 +37,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import useStatusCodes from '../../hooks/UseStatusCodes';
import { useGlobalSettingsState } from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
@@ -77,11 +70,6 @@ export default function SalesOrderDetail() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.salesorder,
modelId: order?.pk
});
const orderCurrency = useMemo(() => {
return (
order.order_currency ||
@@ -137,8 +125,6 @@ export default function SalesOrderDetail() {
modelType: ModelType.salesorder
});
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -230,35 +216,9 @@ export default function SalesOrderDetail() {
) : (
<Skeleton />
)
},
ParametersPanel({
model_type: ModelType.salesorder,
model_id: order.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.salesorder,
model_id: order.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.salesorder,
model_id: order.pk,
note_count: instanceInfo.note_count,
// TODO @matmair - change API to include a "locked" attribute that we can check here
editable:
order.status == soStatus.COMPLETE &&
!globalSettings.isSet('SALESORDER_EDIT_COMPLETED_ORDERS')
? false
: undefined
}),
HistoryPanel({
model_type: ModelType.salesorder,
model_id: order.pk,
visible: showHistory
})
}
];
}, [order, id, user, soStatus, instanceInfo, showHistory]);
}, [order, id, user, soStatus]);
const issueOrder = useCreateApiFormModal({
url: apiUrl(ApiEndpoints.sales_order_issue, order.pk),
@@ -26,13 +26,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import {
useCheckShipmentForm,
useCompleteShipmentForm,
@@ -44,7 +38,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import { useUserState } from '../../states/UserState';
import SalesOrderAllocationTable from '../../tables/sales/SalesOrderAllocationTable';
import { SalesOrderShipmentDetailsPanel } from './SalesOrderShipmentDetailsPanel';
@@ -69,16 +62,9 @@ export default function SalesOrderShipmentDetail() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.salesordershipment,
modelId: shipment?.pk
});
const isPending = useMemo(() => !shipment.shipment_date, [shipment]);
const isChecked = useMemo(() => !!shipment.checked_by, [shipment]);
const showHistory = useShowHistoryPanel();
const shipmentPanels: PanelType[] = useMemo(() => {
return [
{
@@ -106,29 +92,9 @@ export default function SalesOrderShipmentDetail() {
modelTarget={ModelType.stockitem}
/>
)
},
ParametersPanel({
model_type: ModelType.salesordershipment,
model_id: shipment.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.salesordershipment,
model_id: shipment.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.salesordershipment,
model_id: shipment.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.salesordershipment,
model_id: shipment.pk,
visible: showHistory
})
}
];
}, [isPending, shipment, instanceInfo, showHistory]);
}, [isPending, shipment]);
const editShipmentFields = useSalesOrderShipmentFields({
pending: isPending,
@@ -35,7 +35,6 @@ import InstanceDetail from '../../components/nav/InstanceDetail';
import NavigationTree from '../../components/nav/NavigationTree';
import { PageDetail } from '../../components/nav/PageDetail';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import SegmentedControlPanel from '../../components/panels/SegmentedControlPanel';
import LocateItemButton from '../../components/plugins/LocateItemButton';
import { useStockLocationFields } from '../../forms/StockForms';
@@ -45,7 +44,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import { useStockAdjustActions } from '../../hooks/UseStockAdjustActions';
import { useUserSettingsState } from '../../states/SettingsStates';
import { useGlobalSettingsState } from '../../states/SettingsStates';
@@ -102,11 +100,6 @@ export default function Stock() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.stocklocation,
modelId: location?.pk
});
const detailsPanel =
id && instanceQuery.isFetching ? (
<Skeleton />
@@ -208,15 +201,9 @@ export default function Stock() {
}}
/>
)
},
ParametersPanel({
model_type: ModelType.stocklocation,
model_id: location.pk,
hidden: !location.pk,
parameter_count: instanceInfo.parameter_count
})
}
];
}, [sublocationView, transferOrderView, location, id, instanceInfo]);
}, [sublocationView, transferOrderView, location, id]);
const editLocation = useEditApiFormModal({
url: ApiEndpoints.stock_location_list,
+2 -32
View File
@@ -39,11 +39,6 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import NavigationTree from '../../components/nav/NavigationTree';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import LocateItemButton from '../../components/plugins/LocateItemButton';
import { StatusRenderer } from '../../components/render/StatusRenderer';
@@ -62,7 +57,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import { useStockAdjustActions } from '../../hooks/UseStockAdjustActions';
import { useGlobalSettingsState } from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
@@ -114,11 +108,6 @@ export default function StockDetail() {
defaultValue: {}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.stockitem,
modelId: stockitem?.pk
});
const showBuildAllocations: boolean = useMemo(() => {
// Determine if "build allocations" should be shown for this stock item
return (
@@ -183,8 +172,6 @@ export default function StockDetail() {
return stockitem?.part_detail?.assembly;
}, [trackedBomItemQuery, stockitem]);
const showHistory = useShowHistoryPanel();
const stockPanels: PanelType[] = useMemo(() => {
return [
{
@@ -305,32 +292,15 @@ export default function StockDetail() {
) : (
<Skeleton />
)
},
AttachmentPanel({
model_type: ModelType.stockitem,
model_id: stockitem.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.stockitem,
model_id: stockitem.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.stockitem,
model_id: stockitem.pk,
visible: showHistory
})
}
];
}, [
showHistory,
showSalesAllocations,
showBuildAllocations,
showInstalledItems,
stockitem,
id,
user,
instanceInfo
user
]);
const breadcrumbs = useMemo(
@@ -26,13 +26,7 @@ import {
} from '../../components/items/ActionDropdown';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import { StatusRenderer } from '../../components/render/StatusRenderer';
import { useTransferOrderFields } from '../../forms/TransferOrderForms';
import {
@@ -40,7 +34,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useInstance } from '../../hooks/UseInstance';
import { useInstanceInfo } from '../../hooks/UseInstanceInfo';
import useStatusCodes from '../../hooks/UseStatusCodes';
import { useGlobalSettingsState } from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
@@ -67,11 +60,6 @@ export default function TransferOrderDetail() {
}
});
const { instanceInfo } = useInstanceInfo({
modelType: ModelType.transferorder,
modelId: order?.pk
});
const toStatus = useStatusCodes({ modelType: ModelType.transferorder });
const lineItemsEditable: boolean = useMemo(() => {
@@ -102,8 +90,6 @@ export default function TransferOrderDetail() {
<TransferOrderDetailsPanel instance={order} />
);
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -182,29 +168,9 @@ export default function TransferOrderDetail() {
modelTarget={ModelType.stockitem}
/>
)
},
ParametersPanel({
model_type: ModelType.transferorder,
model_id: order.pk,
parameter_count: instanceInfo.parameter_count
}),
AttachmentPanel({
model_type: ModelType.transferorder,
model_id: order.pk,
attachment_count: instanceInfo.attachment_count
}),
NotesPanel({
model_type: ModelType.transferorder,
model_id: order.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.transferorder,
model_id: order.pk,
visible: showHistory
})
}
];
}, [order, id, user, instanceInfo, showHistory]);
}, [order, id, user]);
const orderBadges: ReactNode[] = useMemo(() => {
return instanceQuery.isLoading
@@ -0,0 +1,78 @@
import { create } from 'zustand';
import { createJSONStorage, persist } from 'zustand/middleware';
import { ApiEndpoints } from '@lib/enums/ApiEndpoints';
import type { ModelFeature } from '@lib/enums/ModelFeature';
import type { ModelType } from '@lib/enums/ModelType';
import { apiUrl } from '@lib/functions/Api';
import { api } from '../App';
import { useUserState } from './UserState';
export type ModelFeatureLookup = Record<ModelType | string, ModelFeatureRef[]>;
export type ModelFeatureRef = ModelFeature | (string & {});
interface ModelFeatureStateProps {
features?: ModelFeatureLookup;
fetchFeatures: () => Promise<void>;
hasFeature: (model: ModelType | string, feature: ModelFeatureRef) => boolean;
}
/**
* State for tracking which generic features each model type supports.
* This is static per server instance, so is fetched once with the global states.
*/
export const useModelFeatureState = create<ModelFeatureStateProps>()(
persist(
(set, get) => ({
features: undefined,
fetchFeatures: async () => {
const { isLoggedIn } = useUserState.getState();
if (!isLoggedIn()) {
return;
}
// Feature information is provided by the content type API
await api
.get(apiUrl(ApiEndpoints.content_type_list), {
params: { features: true }
})
.then((response) => {
const lookup: ModelFeatureLookup = {};
for (const contentType of response.data ?? []) {
lookup[contentType.model] = contentType.features ?? [];
}
set({ features: lookup });
})
.catch(() => {
console.error('ERR: Error fetching model feature information');
});
},
hasFeature: (model: ModelType | string, feature: ModelFeatureRef) => {
return get().features?.[model]?.includes(feature) ?? false;
}
}),
{
name: 'model-feature-state',
version: 1,
storage: createJSONStorage(() => sessionStorage),
partialize: (state) => ({ features: state.features })
}
)
);
const EMPTY_FEATURES: ModelFeatureRef[] = [];
/**
* Hook to get list of features for given model type.
* Returns an empty list if the model is unknown, or the information is not (yet) loaded.
*/
export function useModelFeatures(
model: ModelType | string | undefined
): ModelFeatureRef[] {
return useModelFeatureState(
(state) => (model ? state.features?.[model] : undefined) ?? EMPTY_FEATURES
);
}
+3 -1
View File
@@ -2,6 +2,7 @@ import type { PluginProps } from '@lib/types/Plugins';
import { removeTraceId, setApiDefaults, setTraceId } from '../App';
import { useGlobalStatusState } from './GlobalStatusState';
import { useIconState } from './IconState';
import { useModelFeatureState } from './ModelFeatureState';
import { useServerApiState } from './ServerApiState';
import { useGlobalSettingsState, useUserSettingsState } from './SettingsStates';
import { useUserState } from './UserState';
@@ -84,7 +85,8 @@ export async function fetchGlobalStates(force = false) {
useUserSettingsState.getState().fetchSettings(),
useGlobalSettingsState.getState().fetchSettings(),
useGlobalStatusState.getState().fetchStatus(),
useIconState.getState().fetchIcons()
useIconState.getState().fetchIcons(),
useModelFeatureState.getState().fetchFeatures()
]);
removeTraceId(traceId);
globalStatesFetched = true;