@inventreedb/ui 0.0.2 → 0.0.3

package/CHANGELOG.md

@@ -4,4 +4,12 @@ This file contains historical changelog information for the InvenTree UI compone
 
 ### 1.0.0 - April 2025
 
-...
+Published the first version of the UI components API. This allows external plugins to hook into the InvenTree user interface, and provides global access to the following objects:
+
+- `window.React`: The core `react` library running on the UI
+- `window.ReactDOM`: The `react-dom` library
+- `window.ReactDOMClient`: The `react-dom/client` library
+- `window.MantineCore`: The `@mantine/core` library
+- `window.MantineNotifications`: The `@mantine/notifications` library
+
+All of these components can be "externalized" in the plugin build step.

package/README.md

@@ -2,16 +2,27 @@
 
 User Interface (UI) elements for the [InvenTree](https://inventree.org) web interface.
 
-This package provides a public interface allowing plugins to hook into core UI functionality.
 
-### Installation
-
-...
+### Description
 
-### Versioning
+This package provides a public interface allowing plugins to hook into core UI functionality. In particular, it defines a set of interface types provided by the InvenTree user interface, to be used by a custom plugin to implement some custom UI feature.
 
-...
+This library is intended to be used for creating plugins - any other use is outside of its scope and is not supported.
 
 ### Plugin Creator
 
-...
+This library is intended to be used with the [InvenTree Plugin Creator](https://github.com/inventree/plugin-creator). Read the documentation for the plugin creation tool for more information.
+
+The plugin creation tool uses the types provided in this package at build time, but it is intended that most of the major packages are *externalized* - as these are provided as global objects by the core InvenTree UI code.
+
+### Installation
+
+This should be installed as a part of the plugin creator tool. If you need to install it manually, e.g. using `npm`:
+
+```
+npm i @inventreedb/ui
+```
+
+### Versioning
+
+Each change to the plugin API will be described in the [CHANGELOG file](./CHANGELOG.md).

package/dist/.vite/manifest.json

@@ -1,9 +1,59 @@
 {
+  "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/lexer.js?commonjs-exports": {
+    "file": "_virtual/lexer.js",
+    "name": "_virtual/lexer",
+    "src": "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/lexer.js?commonjs-exports"
+  },
+  "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/parser.js?commonjs-es-import": {
+    "file": "_virtual/parser.js",
+    "name": "_virtual/parser",
+    "src": "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/parser.js?commonjs-es-import",
+    "imports": [
+      "node_modules/@messageformat/parser/lib/parser.js"
+    ]
+  },
+  "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/parser.js?commonjs-exports": {
+    "file": "_virtual/parser2.js",
+    "name": "_virtual/parser",
+    "src": "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/parser.js?commonjs-exports"
+  },
+  "/home/inventree/src/frontend/node_modules/moo/moo.js?commonjs-module": {
+    "file": "_virtual/moo.js",
+    "name": "_virtual/moo",
+    "src": "/home/inventree/src/frontend/node_modules/moo/moo.js?commonjs-module"
+  },
+  "/home/inventree/src/frontend/node_modules/unraw/dist/errors.js?commonjs-exports": {
+    "file": "_virtual/errors.js",
+    "name": "_virtual/errors",
+    "src": "/home/inventree/src/frontend/node_modules/unraw/dist/errors.js?commonjs-exports"
+  },
+  "/home/inventree/src/frontend/node_modules/unraw/dist/index.js?commonjs-es-import": {
+    "file": "_virtual/index.js",
+    "name": "_virtual/index",
+    "src": "/home/inventree/src/frontend/node_modules/unraw/dist/index.js?commonjs-es-import",
+    "imports": [
+      "node_modules/unraw/dist/index.js"
+    ]
+  },
+  "/home/inventree/src/frontend/node_modules/unraw/dist/index.js?commonjs-exports": {
+    "file": "_virtual/index2.js",
+    "name": "_virtual/index",
+    "src": "/home/inventree/src/frontend/node_modules/unraw/dist/index.js?commonjs-exports"
+  },
   "lib/enums/ApiEndpoints.tsx": {
     "file": "enums/ApiEndpoints.js",
     "name": "enums/ApiEndpoints",
     "src": "lib/enums/ApiEndpoints.tsx"
   },
+  "lib/enums/ModelInformation.tsx": {
+    "file": "enums/ModelInformation.js",
+    "name": "enums/ModelInformation",
+    "src": "lib/enums/ModelInformation.tsx",
+    "imports": [
+      "node_modules/@lingui/core/dist/index.mjs",
+      "lib/enums/ApiEndpoints.tsx"
+    ]
+  },
   "lib/enums/ModelType.tsx": {
     "file": "enums/ModelType.js",
     "name": "enums/ModelType",
@@ -14,6 +64,20 @@
     "name": "functions/Api",
     "src": "lib/functions/Api.tsx"
   },
+  "lib/functions/Events.tsx": {
+    "file": "functions/Events.js",
+    "name": "functions/Events",
+    "src": "lib/functions/Events.tsx"
+  },
+  "lib/functions/Navigation.tsx": {
+    "file": "functions/Navigation.js",
+    "name": "functions/Navigation",
+    "src": "lib/functions/Navigation.tsx",
+    "imports": [
+      "lib/enums/ModelInformation.tsx",
+      "lib/functions/Events.tsx"
+    ]
+  },
   "lib/functions/Plugins.tsx": {
     "file": "functions/Plugins.js",
     "name": "functions/Plugins",
@@ -32,6 +96,7 @@
       "lib/enums/ApiEndpoints.tsx",
       "lib/enums/ModelType.tsx",
       "lib/functions/Api.tsx",
+      "lib/functions/Navigation.tsx",
       "lib/functions/Plugins.tsx"
     ]
   },
@@ -39,5 +104,65 @@
     "file": "types/Plugins.js",
     "name": "types/Plugins",
     "src": "lib/types/Plugins.tsx"
+  },
+  "node_modules/@lingui/core/dist/index.mjs": {
+    "file": "node_modules/@lingui/core/dist/index.js",
+    "name": "node_modules/@lingui/core/dist/index",
+    "src": "node_modules/@lingui/core/dist/index.mjs",
+    "imports": [
+      "/home/inventree/src/frontend/node_modules/unraw/dist/index.js?commonjs-es-import",
+      "node_modules/@lingui/message-utils/dist/compileMessage.mjs"
+    ]
+  },
+  "node_modules/@lingui/message-utils/dist/compileMessage.mjs": {
+    "file": "node_modules/@lingui/message-utils/dist/compileMessage.js",
+    "name": "node_modules/@lingui/message-utils/dist/compileMessage",
+    "src": "node_modules/@lingui/message-utils/dist/compileMessage.mjs",
+    "imports": [
+      "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/parser.js?commonjs-es-import"
+    ]
+  },
+  "node_modules/@messageformat/parser/lib/lexer.js": {
+    "file": "node_modules/@messageformat/parser/lib/lexer.js",
+    "name": "node_modules/@messageformat/parser/lib/lexer",
+    "src": "node_modules/@messageformat/parser/lib/lexer.js",
+    "imports": [
+      "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/lexer.js?commonjs-exports",
+      "node_modules/moo/moo.js"
+    ]
+  },
+  "node_modules/@messageformat/parser/lib/parser.js": {
+    "file": "node_modules/@messageformat/parser/lib/parser.js",
+    "name": "node_modules/@messageformat/parser/lib/parser",
+    "src": "node_modules/@messageformat/parser/lib/parser.js",
+    "imports": [
+      "/home/inventree/src/frontend/node_modules/@messageformat/parser/lib/parser.js?commonjs-exports",
+      "node_modules/@messageformat/parser/lib/lexer.js"
+    ]
+  },
+  "node_modules/moo/moo.js": {
+    "file": "node_modules/moo/moo.js",
+    "name": "node_modules/moo/moo",
+    "src": "node_modules/moo/moo.js",
+    "imports": [
+      "/home/inventree/src/frontend/node_modules/moo/moo.js?commonjs-module"
+    ]
+  },
+  "node_modules/unraw/dist/errors.js": {
+    "file": "node_modules/unraw/dist/errors.js",
+    "name": "node_modules/unraw/dist/errors",
+    "src": "node_modules/unraw/dist/errors.js",
+    "imports": [
+      "/home/inventree/src/frontend/node_modules/unraw/dist/errors.js?commonjs-exports"
+    ]
+  },
+  "node_modules/unraw/dist/index.js": {
+    "file": "node_modules/unraw/dist/index.js",
+    "name": "node_modules/unraw/dist/index",
+    "src": "node_modules/unraw/dist/index.js",
+    "imports": [
+      "/home/inventree/src/frontend/node_modules/unraw/dist/index.js?commonjs-exports",
+      "node_modules/unraw/dist/errors.js"
+    ]
   }
 }

package/dist/_virtual/errors.js

@@ -0,0 +1,5 @@
+var errors = {};
+export {
+  errors as __exports
+};
+//# sourceMappingURL=errors.js.map

package/dist/_virtual/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/index.js

@@ -0,0 +1,6 @@
+import { __require as requireDist } from "../node_modules/unraw/dist/index.js";
+var distExports = requireDist();
+export {
+  distExports as d
+};
+//# sourceMappingURL=index.js.map

package/dist/_virtual/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/_virtual/index2.js

@@ -0,0 +1,5 @@
+var dist = {};
+export {
+  dist as __exports
+};
+//# sourceMappingURL=index2.js.map

package/dist/_virtual/index2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index2.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/lexer.js

@@ -0,0 +1,5 @@
+var lexer = {};
+export {
+  lexer as __exports
+};
+//# sourceMappingURL=lexer.js.map

package/dist/_virtual/lexer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexer.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/moo.js

@@ -0,0 +1,5 @@
+var moo = { exports: {} };
+export {
+  moo as __module
+};
+//# sourceMappingURL=moo.js.map

package/dist/_virtual/moo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moo.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/parser.js

@@ -0,0 +1,6 @@
+import { __require as requireParser } from "../node_modules/@messageformat/parser/lib/parser.js";
+var parserExports = requireParser();
+export {
+  parserExports as p
+};
+//# sourceMappingURL=parser.js.map

package/dist/_virtual/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/_virtual/parser2.js

@@ -0,0 +1,5 @@
+var parser = {};
+export {
+  parser as __exports
+};
+//# sourceMappingURL=parser2.js.map

package/dist/_virtual/parser2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser2.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/enums/ModelInformation.d.ts

@@ -0,0 +1,20 @@
+import { InvenTreeIconType } from '../types/Icons';
+import { ApiEndpoints } from './ApiEndpoints';
+import { 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 declare const ModelInformationDict: ModelDict;