From 3aed735ceae4d6b5de153a4f92bece08987a8cf3 Mon Sep 17 00:00:00 2001
From: Matt Gerega <gerega@gmail.com>
Date: Tue, 26 Mar 2024 21:26:41 -0400
Subject: [PATCH] Updated vendor API to correct issues - Implement new UI

---
 client/public/locales/en/common.json |  4 ++++
 client/src/pages/vendors/create.tsx  | 18 +++++++++++++++++-
 client/src/pages/vendors/edit.tsx    | 18 +++++++++++++++++-
 client/src/pages/vendors/list.tsx    | 13 +++++++++++--
 client/src/pages/vendors/model.tsx   |  1 +
 client/src/pages/vendors/show.tsx    |  2 ++
 spoolman/api/v1/models.py            |  2 ++
 spoolman/api/v1/vendor.py            | 11 ++++++-----
 spoolman/database/vendor.py          |  2 ++
 9 files changed, 62 insertions(+), 9 deletions(-)

diff --git a/client/public/locales/en/common.json b/client/public/locales/en/common.json
index 53160f8..16d7800 100644
--- a/client/public/locales/en/common.json
+++ b/client/public/locales/en/common.json
@@ -227,9 +227,13 @@
         "fields": {
             "id": "ID",
             "name": "Name",
+            "empty_spool_weight": "Empty Spool Weight",
             "registered": "Registered",
             "comment": "Comment"
         },
+        "fields_help": {
+            "empty_spool_weight": "The weight of an empty spool from this vendor."
+        },
         "titles": {
             "create": "Create Vendor",
             "clone": "Clone Vendor",
diff --git a/client/src/pages/vendors/create.tsx b/client/src/pages/vendors/create.tsx
index 9649ccd..69ac0ae 100644
--- a/client/src/pages/vendors/create.tsx
+++ b/client/src/pages/vendors/create.tsx
@@ -1,7 +1,7 @@
 import React from "react";
 import { HttpError, IResourceComponentsProps, useTranslate } from "@refinedev/core";
 import { Create, useForm } from "@refinedev/antd";
-import { Button, Form, Input, Typography } from "antd";
+import { Button, Form, Input, Typography, InputNumber } from "antd";
 import TextArea from "antd/es/input/TextArea";
 import { IVendor, IVendorParsedExtras } from "./model";
 import { EntityType, useGetFields } from "../../utils/queryFields";
@@ -85,6 +85,22 @@ export const VendorCreate: React.FC<IResourceComponentsProps & CreateOrCloneProp
         >
           <TextArea maxLength={1024} />
         </Form.Item>
+        <Form.Item
+          label={t("vendor.fields.empty_spool_weight")}
+          help={t("vendor.fields_help.empty_spool_weight")}
+          name={["empty_spool_weight"]}
+          rules={[
+            {
+              required: false,
+              type: "number",
+              min: 0,
+            },
+          ]}
+        >
+          <InputNumber 
+            addonAfter="g"
+            precision={1}/>
+        </Form.Item>
         <Typography.Title level={5}>{t("settings.extra_fields.tab")}</Typography.Title>
         {extraFields.data?.map((field, index) => (
           <ExtraFieldFormItem key={index} field={field} />
diff --git a/client/src/pages/vendors/edit.tsx b/client/src/pages/vendors/edit.tsx
index 330a251..d8fd665 100644
--- a/client/src/pages/vendors/edit.tsx
+++ b/client/src/pages/vendors/edit.tsx
@@ -1,7 +1,7 @@
 import React, { useState } from "react";
 import { HttpError, IResourceComponentsProps, useTranslate } from "@refinedev/core";
 import { Edit, useForm } from "@refinedev/antd";
-import { Form, Input, DatePicker, message, Alert, Typography } from "antd";
+import { Form, Input, DatePicker, message, Alert, Typography, InputNumber } from "antd";
 import dayjs from "dayjs";
 import TextArea from "antd/es/input/TextArea";
 import { IVendor, IVendorParsedExtras } from "./model";
@@ -100,6 +100,22 @@ export const VendorEdit: React.FC<IResourceComponentsProps> = () => {
         >
           <TextArea maxLength={1024} />
         </Form.Item>
+        <Form.Item
+          label={t("vendor.fields.empty_spool_weight")}
+          help={t("vendor.fields_help.empty_spool_weight")}
+          name={["empty_spool_weight"]}
+          rules={[
+            {
+              required: false,
+              type: "number",
+              min: 0,
+            },
+          ]}
+        >
+          <InputNumber 
+            addonAfter="g"
+            precision={1}/>
+        </Form.Item>
         <Typography.Title level={5}>{t("settings.extra_fields.tab")}</Typography.Title>
         {extraFields.data?.map((field, index) => (
           <ExtraFieldFormItem key={index} field={field} />
diff --git a/client/src/pages/vendors/list.tsx b/client/src/pages/vendors/list.tsx
index a79e16d..dba62ec 100644
--- a/client/src/pages/vendors/list.tsx
+++ b/client/src/pages/vendors/list.tsx
@@ -7,7 +7,7 @@ import utc from "dayjs/plugin/utc";
 import { IVendor } from "./model";
 import { TableState, useInitialTableState, useStoreInitialState } from "../../utils/saveload";
 import { EditOutlined, EyeOutlined, FilterOutlined, PlusSquareOutlined } from "@ant-design/icons";
-import { DateColumn, RichColumn, SortedColumn, ActionsColumn, CustomFieldColumn } from "../../components/column";
+import { DateColumn, RichColumn, SortedColumn, ActionsColumn, CustomFieldColumn, NumberColumn } from "../../components/column";
 import { useLiveify } from "../../components/liveify";
 import { removeUndefined } from "../../utils/filtering";
 import { EntityType, useGetFields } from "../../utils/queryFields";
@@ -17,7 +17,7 @@ dayjs.extend(utc);
 
 const namespace = "vendorList-v2";
 
-const allColumns: (keyof IVendor & string)[] = ["id", "name", "registered", "comment"];
+const allColumns: (keyof IVendor & string)[] = ["id", "name", "registered", "comment", "empty_spool_weight"];
 
 export const VendorList: React.FC<IResourceComponentsProps> = () => {
   const t = useTranslate();
@@ -171,6 +171,15 @@ export const VendorList: React.FC<IResourceComponentsProps> = () => {
             ...commonProps,
             id: "registered",
             i18ncat: "vendor",
+            width: 200,
+          }),
+          NumberColumn({
+            ...commonProps,
+            id: "empty_spool_weight",
+            i18ncat: "vendor",
+            unit: "g",
+            maxDecimals: 0,
+            width: 200,
           }),
           ...(extraFields.data?.map((field) => {
             return CustomFieldColumn({
diff --git a/client/src/pages/vendors/model.tsx b/client/src/pages/vendors/model.tsx
index ac1bf83..85d33ad 100644
--- a/client/src/pages/vendors/model.tsx
+++ b/client/src/pages/vendors/model.tsx
@@ -3,6 +3,7 @@ export interface IVendor {
   registered: string;
   name: string;
   comment?: string;
+  empty_spool_weight?: number;
   extra: { [key: string]: string };
 }
 
diff --git a/client/src/pages/vendors/show.tsx b/client/src/pages/vendors/show.tsx
index c161218..760eae3 100644
--- a/client/src/pages/vendors/show.tsx
+++ b/client/src/pages/vendors/show.tsx
@@ -42,6 +42,8 @@ export const VendorShow: React.FC<IResourceComponentsProps> = () => {
       <TextField value={record?.name} />
       <Title level={5}>{t("vendor.fields.comment")}</Title>
       <TextField value={enrichText(record?.comment)} />
+      <Title level={5}>{t("vendor.fields.empty_spool_weight")}</Title>
+      <TextField value={record?.empty_spool_weight} />
       <Title level={4}>{t("settings.extra_fields.tab")}</Title>
       {extraFields?.data?.map((field, index) => (
         <ExtraFieldDisplay key={index} field={field} value={record?.extra[field.key]} />
diff --git a/spoolman/api/v1/models.py b/spoolman/api/v1/models.py
index 3d36e9b..3b7f267 100644
--- a/spoolman/api/v1/models.py
+++ b/spoolman/api/v1/models.py
@@ -60,6 +60,7 @@ class Vendor(BaseModel):
     registered: datetime = Field(description="When the vendor was registered in the database. UTC Timezone.")
     name: str = Field(max_length=64, description="Vendor name.", example="Polymaker")
     comment: Optional[str] = Field(max_length=1024, description="Free text comment about this vendor.", example="")
+    empty_spool_weight: Optional[float] = Field(gt=0, description="The empty spool weight, in grams.", example=140)
     extra: dict[str, str] = Field(
         description=(
             "Extra fields for this vendor. All values are JSON-encoded data. "
@@ -75,6 +76,7 @@ class Vendor(BaseModel):
             registered=item.registered,
             name=item.name,
             comment=item.comment,
+            empty_spool_weight=item.empty_spool_weight,
             extra={field.key: field.value for field in item.extra},
         )
 
diff --git a/spoolman/api/v1/vendor.py b/spoolman/api/v1/vendor.py
index 260e609..a7fad79 100644
--- a/spoolman/api/v1/vendor.py
+++ b/spoolman/api/v1/vendor.py
@@ -33,6 +33,11 @@ class VendorParameters(BaseModel):
         description="Free text comment about this vendor.",
         example="",
     )
+    empty_spool_weight: Optional[float] = Field(
+        ge=0,
+        description="The weight of an empty spool.",
+        example=200,
+    )
     extra: Optional[dict[str, str]] = Field(
         None,
         description="Extra fields for this vendor.",
@@ -41,11 +46,6 @@ class VendorParameters(BaseModel):
 
 class VendorUpdateParameters(VendorParameters):
     name: Optional[str] = Field(max_length=64, description="Vendor name.", example="Polymaker")
-    comment: Optional[str] = Field(
-        max_length=1024,
-        description="Free text comment about this vendor.",
-        example="",
-    )
 
 
 @router.get(
@@ -190,6 +190,7 @@ async def create(  # noqa: ANN201
         db=db,
         name=body.name,
         comment=body.comment,
+        empty_spool_weight=body.empty_spool_weight,
         extra=body.extra,
     )
 
diff --git a/spoolman/database/vendor.py b/spoolman/database/vendor.py
index 67ba082..85ae081 100644
--- a/spoolman/database/vendor.py
+++ b/spoolman/database/vendor.py
@@ -19,6 +19,7 @@ async def create(
     db: AsyncSession,
     name: Optional[str] = None,
     comment: Optional[str] = None,
+    empty_spool_weight: Optional[float] = None,
     extra: Optional[dict[str, str]] = None,
 ) -> models.Vendor:
     """Add a new vendor to the database."""
@@ -26,6 +27,7 @@ async def create(
         name=name,
         registered=datetime.utcnow().replace(microsecond=0),
         comment=comment,
+        empty_spool_weight=empty_spool_weight,
         extra=[models.VendorField(key=k, value=v) for k, v in (extra or {}).items()],
     )
     db.add(vendor)