@inventreedb/ui 0.0.2 → 0.0.4

package/lib/enums/ModelInformation.tsx

@@ -0,0 +1,279 @@
+import { t } from '@lingui/core/macro';
+import type { InvenTreeIconType } from '../types/Icons';
+import { ApiEndpoints } from './ApiEndpoints';
+import type { ModelType } from './ModelType';
+
+export interface ModelInformationInterface {
+  label: string;
+  label_multiple: string;
+  url_overview?: string;
+  url_detail?: string;
+  api_endpoint: ApiEndpoints;
+  admin_url?: string;
+  icon: keyof InvenTreeIconType;
+}
+
+export interface TranslatableModelInformationInterface
+  extends Omit<ModelInformationInterface, 'label' | 'label_multiple'> {
+  label: () => string;
+  label_multiple: () => string;
+}
+
+export type ModelDict = {
+  [key in keyof typeof ModelType]: TranslatableModelInformationInterface;
+};
+
+export const ModelInformationDict: ModelDict = {
+  part: {
+    label: () => t`Part`,
+    label_multiple: () => t`Parts`,
+    url_overview: '/part/category/index/parts',
+    url_detail: '/part/:pk/',
+    api_endpoint: ApiEndpoints.part_list,
+    admin_url: '/part/part/',
+    icon: 'part'
+  },
+  partparametertemplate: {
+    label: () => t`Part Parameter Template`,
+    label_multiple: () => t`Part Parameter Templates`,
+    url_detail: '/partparametertemplate/:pk/',
+    api_endpoint: ApiEndpoints.part_parameter_template_list,
+    icon: 'test_templates'
+  },
+  parttesttemplate: {
+    label: () => t`Part Test Template`,
+    label_multiple: () => t`Part Test Templates`,
+    url_detail: '/parttesttemplate/:pk/',
+    api_endpoint: ApiEndpoints.part_test_template_list,
+    icon: 'test'
+  },
+  supplierpart: {
+    label: () => t`Supplier Part`,
+    label_multiple: () => t`Supplier Parts`,
+    url_overview: '/purchasing/index/supplier-parts',
+    url_detail: '/purchasing/supplier-part/:pk/',
+    api_endpoint: ApiEndpoints.supplier_part_list,
+    admin_url: '/company/supplierpart/',
+    icon: 'supplier_part'
+  },
+  manufacturerpart: {
+    label: () => t`Manufacturer Part`,
+    label_multiple: () => t`Manufacturer Parts`,
+    url_overview: '/purchasing/index/manufacturer-parts',
+    url_detail: '/purchasing/manufacturer-part/:pk/',
+    api_endpoint: ApiEndpoints.manufacturer_part_list,
+    admin_url: '/company/manufacturerpart/',
+    icon: 'manufacturers'
+  },
+  partcategory: {
+    label: () => t`Part Category`,
+    label_multiple: () => t`Part Categories`,
+    url_overview: '/part/category/parts/subcategories',
+    url_detail: '/part/category/:pk/',
+    api_endpoint: ApiEndpoints.category_list,
+    admin_url: '/part/partcategory/',
+    icon: 'category'
+  },
+  stockitem: {
+    label: () => t`Stock Item`,
+    label_multiple: () => t`Stock Items`,
+    url_overview: '/stock/location/index/stock-items',
+    url_detail: '/stock/item/:pk/',
+    api_endpoint: ApiEndpoints.stock_item_list,
+    admin_url: '/stock/stockitem/',
+    icon: 'stock'
+  },
+  stocklocation: {
+    label: () => t`Stock Location`,
+    label_multiple: () => t`Stock Locations`,
+    url_overview: '/stock/location',
+    url_detail: '/stock/location/:pk/',
+    api_endpoint: ApiEndpoints.stock_location_list,
+    admin_url: '/stock/stocklocation/',
+    icon: 'location'
+  },
+  stocklocationtype: {
+    label: () => t`Stock Location Type`,
+    label_multiple: () => t`Stock Location Types`,
+    api_endpoint: ApiEndpoints.stock_location_type_list,
+    icon: 'location'
+  },
+  stockhistory: {
+    label: () => t`Stock History`,
+    label_multiple: () => t`Stock Histories`,
+    api_endpoint: ApiEndpoints.stock_tracking_list,
+    icon: 'history'
+  },
+  build: {
+    label: () => t`Build`,
+    label_multiple: () => t`Builds`,
+    url_overview: '/manufacturing/index/buildorders/',
+    url_detail: '/manufacturing/build-order/:pk/',
+    api_endpoint: ApiEndpoints.build_order_list,
+    admin_url: '/build/build/',
+    icon: 'build_order'
+  },
+  buildline: {
+    label: () => t`Build Line`,
+    label_multiple: () => t`Build Lines`,
+    url_overview: '/build/line',
+    url_detail: '/build/line/:pk/',
+    api_endpoint: ApiEndpoints.build_line_list,
+    icon: 'build_order'
+  },
+  builditem: {
+    label: () => t`Build Item`,
+    label_multiple: () => t`Build Items`,
+    api_endpoint: ApiEndpoints.build_item_list,
+    icon: 'build_order'
+  },
+  company: {
+    label: () => t`Company`,
+    label_multiple: () => t`Companies`,
+    url_detail: '/company/:pk/',
+    api_endpoint: ApiEndpoints.company_list,
+    admin_url: '/company/company/',
+    icon: 'building'
+  },
+  projectcode: {
+    label: () => t`Project Code`,
+    label_multiple: () => t`Project Codes`,
+    url_detail: '/project-code/:pk/',
+    api_endpoint: ApiEndpoints.project_code_list,
+    icon: 'list_details'
+  },
+  purchaseorder: {
+    label: () => t`Purchase Order`,
+    label_multiple: () => t`Purchase Orders`,
+    url_overview: '/purchasing/index/purchaseorders',
+    url_detail: '/purchasing/purchase-order/:pk/',
+    api_endpoint: ApiEndpoints.purchase_order_list,
+    admin_url: '/order/purchaseorder/',
+    icon: 'purchase_orders'
+  },
+  purchaseorderlineitem: {
+    label: () => t`Purchase Order Line`,
+    label_multiple: () => t`Purchase Order Lines`,
+    api_endpoint: ApiEndpoints.purchase_order_line_list,
+    icon: 'purchase_orders'
+  },
+  salesorder: {
+    label: () => t`Sales Order`,
+    label_multiple: () => t`Sales Orders`,
+    url_overview: '/sales/index/salesorders',
+    url_detail: '/sales/sales-order/:pk/',
+    api_endpoint: ApiEndpoints.sales_order_list,
+    admin_url: '/order/salesorder/',
+    icon: 'sales_orders'
+  },
+  salesordershipment: {
+    label: () => t`Sales Order Shipment`,
+    label_multiple: () => t`Sales Order Shipments`,
+    url_detail: '/sales/shipment/:pk/',
+    api_endpoint: ApiEndpoints.sales_order_shipment_list,
+    icon: 'sales_orders'
+  },
+  returnorder: {
+    label: () => t`Return Order`,
+    label_multiple: () => t`Return Orders`,
+    url_overview: '/sales/index/returnorders',
+    url_detail: '/sales/return-order/:pk/',
+    api_endpoint: ApiEndpoints.return_order_list,
+    admin_url: '/order/returnorder/',
+    icon: 'return_orders'
+  },
+  returnorderlineitem: {
+    label: () => t`Return Order Line Item`,
+    label_multiple: () => t`Return Order Line Items`,
+    api_endpoint: ApiEndpoints.return_order_line_list,
+    icon: 'return_orders'
+  },
+  address: {
+    label: () => t`Address`,
+    label_multiple: () => t`Addresses`,
+    url_detail: '/address/:pk/',
+    api_endpoint: ApiEndpoints.address_list,
+    icon: 'address'
+  },
+  contact: {
+    label: () => t`Contact`,
+    label_multiple: () => t`Contacts`,
+    url_detail: '/contact/:pk/',
+    api_endpoint: ApiEndpoints.contact_list,
+    icon: 'group'
+  },
+  owner: {
+    label: () => t`Owner`,
+    label_multiple: () => t`Owners`,
+    url_detail: '/owner/:pk/',
+    api_endpoint: ApiEndpoints.owner_list,
+    icon: 'group'
+  },
+  user: {
+    label: () => t`User`,
+    label_multiple: () => t`Users`,
+    url_detail: '/core/user/:pk/',
+    api_endpoint: ApiEndpoints.user_list,
+    icon: 'user'
+  },
+  group: {
+    label: () => t`Group`,
+    label_multiple: () => t`Groups`,
+    url_detail: '/core/group/:pk/',
+    api_endpoint: ApiEndpoints.group_list,
+    admin_url: '/auth/group/',
+    icon: 'group'
+  },
+  importsession: {
+    label: () => t`Import Session`,
+    label_multiple: () => t`Import Sessions`,
+    url_overview: '/settings/admin/import',
+    url_detail: '/import/:pk/',
+    api_endpoint: ApiEndpoints.import_session_list,
+    icon: 'import'
+  },
+  labeltemplate: {
+    label: () => t`Label Template`,
+    label_multiple: () => t`Label Templates`,
+    url_overview: '/settings/admin/labels',
+    url_detail: '/settings/admin/labels/:pk/',
+    api_endpoint: ApiEndpoints.label_list,
+    icon: 'labels'
+  },
+  reporttemplate: {
+    label: () => t`Report Template`,
+    label_multiple: () => t`Report Templates`,
+    url_overview: '/settings/admin/reports',
+    url_detail: '/settings/admin/reports/:pk/',
+    api_endpoint: ApiEndpoints.report_list,
+    icon: 'reports'
+  },
+  pluginconfig: {
+    label: () => t`Plugin Configuration`,
+    label_multiple: () => t`Plugin Configurations`,
+    url_overview: '/settings/admin/plugin',
+    url_detail: '/settings/admin/plugin/:pk/',
+    api_endpoint: ApiEndpoints.plugin_list,
+    icon: 'plugin'
+  },
+  contenttype: {
+    label: () => t`Content Type`,
+    label_multiple: () => t`Content Types`,
+    api_endpoint: ApiEndpoints.content_type_list,
+    icon: 'list_details'
+  },
+  selectionlist: {
+    label: () => t`Selection List`,
+    label_multiple: () => t`Selection Lists`,
+    api_endpoint: ApiEndpoints.selectionlist_list,
+    icon: 'list_details'
+  },
+  error: {
+    label: () => t`Error`,
+    label_multiple: () => t`Errors`,
+    api_endpoint: ApiEndpoints.error_report_list,
+    url_overview: '/settings/admin/errors',
+    url_detail: '/settings/admin/errors/:pk/',
+    icon: 'exclamation'
+  }
+};

package/lib/functions/Events.tsx

@@ -0,0 +1,6 @@
+// Helper function to cancel event propagation
+export function cancelEvent(event: any) {
+  event?.preventDefault();
+  event?.stopPropagation();
+  event?.nativeEvent?.stopImmediatePropagation();
+}

package/lib/functions/Navigation.tsx

@@ -0,0 +1,70 @@
+import type { NavigateFunction } from 'react-router-dom';
+import { ModelInformationDict } from '../enums/ModelInformation';
+import type { ModelType } from '../enums/ModelType';
+import { cancelEvent } from './Events';
+
+export const getBaseUrl = (): string =>
+  (window as any).INVENTREE_SETTINGS?.base_url || 'web';
+
+/**
+ * Returns the detail view URL for a given model type
+ */
+export function getDetailUrl(
+  model: ModelType,
+  pk: number | string,
+  absolute?: boolean
+): string {
+  const modelInfo = ModelInformationDict[model];
+
+  if (pk === undefined || pk === null) {
+    return '';
+  }
+
+  if (!!pk && modelInfo && modelInfo.url_detail) {
+    const url = modelInfo.url_detail.replace(':pk', pk.toString());
+    const base = getBaseUrl();
+
+    if (absolute && base) {
+      return `/${base}${url}`;
+    } else {
+      return url;
+    }
+  }
+
+  console.error(`No detail URL found for model ${model} <${pk}>`);
+  return '';
+}
+
+/*
+ * Navigate to a provided link.
+ * - If the link is to be opened externally, open it in a new tab.
+ * - Otherwise, navigate using the provided navigate function.
+ */
+export const navigateToLink = (
+  link: string,
+  navigate: NavigateFunction,
+  event: any
+) => {
+  cancelEvent(event);
+
+  const base = `/${getBaseUrl()}`;
+
+  if (event?.ctrlKey || event?.shiftKey) {
+    // Open the link in a new tab
+    let url = link;
+    if (link.startsWith('/') && !link.startsWith(base)) {
+      url = `${base}${link}`;
+    }
+    window.open(url, '_blank');
+  } else {
+    // Navigate internally
+    let url = link;
+
+    if (link.startsWith(base)) {
+      // Strip the base URL from the link
+      url = link.replace(base, '');
+    }
+
+    navigate(url);
+  }
+};

package/lib/index.ts

@@ -4,8 +4,17 @@ export { INVENTREE_PLUGIN_VERSION } from './types/Plugins';
 // Common type definitions
 export { ApiEndpoints } from './enums/ApiEndpoints';
 export { ModelType } from './enums/ModelType';
+
 export type { InvenTreePluginContext } from './types/Plugins';
 
 // Common utility functions
 export { apiUrl } from './functions/Api';
+export {
+  getBaseUrl,
+  getDetailUrl,
+  navigateToLink
+} from './functions/Navigation';
 export { checkPluginVersion } from './functions/Plugins';
+
+// UI components
+export { StylishText } from './components/StylishText';

package/lib/types/Icons.tsx

@@ -0,0 +1,9 @@
+import type { Icon, IconProps } from '@tabler/icons-react';
+
+export type TablerIconType = React.ForwardRefExoticComponent<
+  Omit<IconProps, 'ref'> & React.RefAttributes<Icon>
+>;
+
+export type InvenTreeIconType = {
+  [key: string]: TablerIconType;
+};

package/package.json

@@ -1,10 +1,13 @@
 {
     "name": "@inventreedb/ui",
     "description": "UI components for the InvenTree project",
-    "version": "0.0.2",
+    "version": "0.0.4",
     "private": false,
     "type": "module",
     "license": "MIT",
+    "keywords": [
+        "inventree"
+    ],
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
     "exports": {