@inventreedb/ui 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+## InvenTree UI Components - Changelog
+
+This file contains historical changelog information for the InvenTree UI components library.
+
+### 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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 - InvenTree Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -0,0 +1,168 @@
+{
+  "/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",
+    "src": "lib/enums/ModelType.tsx"
+  },
+  "lib/functions/Api.tsx": {
+    "file": "functions/Api.js",
+    "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",
+    "src": "lib/functions/Plugins.tsx",
+    "imports": [
+      "lib/types/Plugins.tsx"
+    ]
+  },
+  "lib/index.ts": {
+    "file": "index.js",
+    "name": "index",
+    "src": "lib/index.ts",
+    "isEntry": true,
+    "imports": [
+      "lib/types/Plugins.tsx",
+      "lib/enums/ApiEndpoints.tsx",
+      "lib/enums/ModelType.tsx",
+      "lib/functions/Api.tsx",
+      "lib/functions/Navigation.tsx",
+      "lib/functions/Plugins.tsx"
+    ]
+  },
+  "lib/types/Plugins.tsx": {
+    "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/ApiEndpoints.d.ts

@@ -0,0 +1,179 @@
+export declare enum ApiEndpoints {
+    api_server_info = "",
+    user_list = "user/",
+    user_me = "user/me/",
+    user_profile = "user/profile/",
+    user_roles = "user/roles/",
+    user_token = "user/token/",
+    user_tokens = "user/tokens/",
+    user_simple_login = "email/generate/",
+    user_reset = "auth/v1/auth/password/request",
+    user_reset_set = "auth/v1/auth/password/reset",
+    auth_pwd_change = "auth/v1/account/password/change",
+    auth_login = "auth/v1/auth/login",
+    auth_login_2fa = "auth/v1/auth/2fa/authenticate",
+    auth_session = "auth/v1/auth/session",
+    auth_signup = "auth/v1/auth/signup",
+    auth_authenticators = "auth/v1/account/authenticators",
+    auth_recovery = "auth/v1/account/authenticators/recovery-codes",
+    auth_mfa_reauthenticate = "auth/v1/auth/2fa/reauthenticate",
+    auth_totp = "auth/v1/account/authenticators/totp",
+    auth_reauthenticate = "auth/v1/auth/reauthenticate",
+    auth_email = "auth/v1/account/email",
+    auth_email_verify = "auth/v1/auth/email/verify",
+    auth_providers = "auth/v1/account/providers",
+    auth_provider_redirect = "auth/v1/auth/provider/redirect",
+    auth_config = "auth/v1/config",
+    currency_list = "currency/exchange/",
+    currency_refresh = "currency/refresh/",
+    all_units = "units/all/",
+    task_overview = "background-task/",
+    task_pending_list = "background-task/pending/",
+    task_scheduled_list = "background-task/scheduled/",
+    task_failed_list = "background-task/failed/",
+    api_search = "search/",
+    settings_global_list = "settings/global/",
+    settings_user_list = "settings/user/",
+    news = "news/",
+    global_status = "generic/status/",
+    custom_state_list = "generic/status/custom/",
+    version = "version/",
+    license = "license/",
+    group_list = "user/group/",
+    owner_list = "user/owner/",
+    content_type_list = "contenttype/",
+    icons = "icons/",
+    selectionlist_list = "selection/",
+    selectionlist_detail = "selection/:id/",
+    barcode = "barcode/",
+    barcode_history = "barcode/history/",
+    barcode_link = "barcode/link/",
+    barcode_unlink = "barcode/unlink/",
+    barcode_generate = "barcode/generate/",
+    data_output = "data-output/",
+    import_session_list = "importer/session/",
+    import_session_accept_fields = "importer/session/:id/accept_fields/",
+    import_session_accept_rows = "importer/session/:id/accept_rows/",
+    import_session_column_mapping_list = "importer/column-mapping/",
+    import_session_row_list = "importer/row/",
+    notifications_list = "notifications/",
+    notifications_readall = "notifications/readall/",
+    build_order_list = "build/",
+    build_order_issue = "build/:id/issue/",
+    build_order_cancel = "build/:id/cancel/",
+    build_order_hold = "build/:id/hold/",
+    build_order_complete = "build/:id/finish/",
+    build_output_complete = "build/:id/complete/",
+    build_output_create = "build/:id/create-output/",
+    build_output_scrap = "build/:id/scrap-outputs/",
+    build_output_delete = "build/:id/delete-outputs/",
+    build_order_auto_allocate = "build/:id/auto-allocate/",
+    build_order_allocate = "build/:id/allocate/",
+    build_order_deallocate = "build/:id/unallocate/",
+    build_line_list = "build/line/",
+    build_item_list = "build/item/",
+    bom_list = "bom/",
+    bom_item_validate = "bom/:id/validate/",
+    bom_validate = "part/:id/bom-validate/",
+    part_list = "part/",
+    part_parameter_list = "part/parameter/",
+    part_parameter_template_list = "part/parameter/template/",
+    part_thumbs_list = "part/thumbs/",
+    part_pricing = "part/:id/pricing/",
+    part_serial_numbers = "part/:id/serial-numbers/",
+    part_scheduling = "part/:id/scheduling/",
+    part_pricing_internal = "part/internal-price/",
+    part_pricing_sale = "part/sale-price/",
+    part_stocktake_list = "part/stocktake/",
+    part_stocktake_report_list = "part/stocktake/report/",
+    part_stocktake_report_generate = "part/stocktake/report/generate/",
+    category_list = "part/category/",
+    category_tree = "part/category/tree/",
+    category_parameter_list = "part/category/parameters/",
+    related_part_list = "part/related/",
+    part_test_template_list = "part/test-template/",
+    company_list = "company/",
+    contact_list = "company/contact/",
+    address_list = "company/address/",
+    supplier_part_list = "company/part/",
+    supplier_part_pricing_list = "company/price-break/",
+    manufacturer_part_list = "company/part/manufacturer/",
+    manufacturer_part_parameter_list = "company/part/manufacturer/parameter/",
+    stock_location_list = "stock/location/",
+    stock_location_type_list = "stock/location-type/",
+    stock_location_tree = "stock/location/tree/",
+    stock_item_list = "stock/",
+    stock_tracking_list = "stock/track/",
+    stock_test_result_list = "stock/test/",
+    stock_transfer = "stock/transfer/",
+    stock_remove = "stock/remove/",
+    stock_add = "stock/add/",
+    stock_count = "stock/count/",
+    stock_change_status = "stock/change_status/",
+    stock_merge = "stock/merge/",
+    stock_assign = "stock/assign/",
+    stock_status = "stock/status/",
+    stock_install = "stock/:id/install/",
+    stock_uninstall = "stock/:id/uninstall/",
+    stock_serialize = "stock/:id/serialize/",
+    stock_return = "stock/:id/return/",
+    generate_batch_code = "generate/batch-code/",
+    generate_serial_number = "generate/serial-number/",
+    purchase_order_list = "order/po/",
+    purchase_order_issue = "order/po/:id/issue/",
+    purchase_order_hold = "order/po/:id/hold/",
+    purchase_order_cancel = "order/po/:id/cancel/",
+    purchase_order_complete = "order/po/:id/complete/",
+    purchase_order_line_list = "order/po-line/",
+    purchase_order_extra_line_list = "order/po-extra-line/",
+    purchase_order_receive = "order/po/:id/receive/",
+    sales_order_list = "order/so/",
+    sales_order_issue = "order/so/:id/issue/",
+    sales_order_hold = "order/so/:id/hold/",
+    sales_order_cancel = "order/so/:id/cancel/",
+    sales_order_ship = "order/so/:id/ship/",
+    sales_order_complete = "order/so/:id/complete/",
+    sales_order_allocate = "order/so/:id/allocate/",
+    sales_order_allocate_serials = "order/so/:id/allocate-serials/",
+    sales_order_line_list = "order/so-line/",
+    sales_order_extra_line_list = "order/so-extra-line/",
+    sales_order_allocation_list = "order/so-allocation/",
+    sales_order_shipment_list = "order/so/shipment/",
+    sales_order_shipment_complete = "order/so/shipment/:id/ship/",
+    return_order_list = "order/ro/",
+    return_order_issue = "order/ro/:id/issue/",
+    return_order_hold = "order/ro/:id/hold/",
+    return_order_cancel = "order/ro/:id/cancel/",
+    return_order_complete = "order/ro/:id/complete/",
+    return_order_receive = "order/ro/:id/receive/",
+    return_order_line_list = "order/ro-line/",
+    return_order_extra_line_list = "order/ro-extra-line/",
+    label_list = "label/template/",
+    label_print = "label/print/",
+    report_list = "report/template/",
+    report_print = "report/print/",
+    report_snippet = "report/snippet/",
+    report_asset = "report/asset/",
+    plugin_list = "plugins/",
+    plugin_setting_list = "plugins/:plugin/settings/",
+    plugin_registry_status = "plugins/status/",
+    plugin_install = "plugins/install/",
+    plugin_reload = "plugins/reload/",
+    plugin_activate = "plugins/:key/activate/",
+    plugin_uninstall = "plugins/:key/uninstall/",
+    plugin_admin = "plugins/:key/admin/",
+    plugin_ui_features_list = "plugins/ui/features/:feature_type/",
+    plugin_locate_item = "locate/",
+    machine_types_list = "machine/types/",
+    machine_driver_list = "machine/drivers/",
+    machine_registry_status = "machine/status/",
+    machine_list = "machine/",
+    machine_restart = "machine/:machine/restart/",
+    machine_setting_list = "machine/:machine/settings/",
+    machine_setting_detail = "machine/:machine/settings/:config_type/",
+    attachment_list = "attachment/",
+    error_report_list = "error-report/",
+    project_code_list = "project-code/",
+    custom_unit_list = "units/",
+    notes_image_upload = "notes-image-upload/"
+}