feat: enhance public notes functionality with flexible options (#141)

* feat: enhance public notes functionality with flexible options - Make public notes optional to prevent default values causing frontend issues - Add dual editing modes: raw text editing and custom fields (avoid hardcoded schema) - Set raw text mode as default, populate input on edit, submit raw text content always - Add toggle switch: submit raw text when enabled, submit empty & hide controls when disabled - New records default to disabled public notes; auto-expand on edit based on content * chore: auto-fix linting and formatting issues * feat: Add public annotation data structure and utility functions Implemented Zod validation patterns, default values, parsing functions, and utility functions for public notes, and updated related internationalization text. * chore: auto-fix linting and formatting issues * refactor(server): Replace i18n implementation Replace direct use of i18n.t with react-i18next's useTranslation hook to improve internationalization support. * refactor(public-note): Optimize data model and validation logic Removed the pruneEmpty function and simplified the date processing logic, making billingDataMod and planDataMod optional fields. Also optimized the validation logic to handle optional fields. * chore: auto-fix linting and formatting issues * fix zod validation & don't write empty values when parsing * use raw mode if object contains unknown fields * rename some features * chore: Update dependency package versions Upgrade multiple npm dependencies to their latest versions, including react, tailwindcss, and eslint. Ignore lock files. * fix(server): Fix default value when bill amount is undefined Changed undefined values for bill amount to the default value "0" to avoid potential null value errors. --------- Co-authored-by: Guccen <171530509+Chillln@users.noreply.github.com> Co-authored-by: uubulb <uub@suwako.de>
2026-09-20 02:00:14 +00:00 · 2025-10-09 09:35:13 +08:00
parent ec6511bcb8
commit e783692ac9
36 changed files with 1087 additions and 851 deletions
@@ -0,0 +1,182 @@
+import { z } from "zod"
+
+import i18n from "./i18n"
+
+/**
+ * Zod schema for PublicNote
+ * Conventions:
+ * - All fields are strings and may be empty
+ * - IPv4/IPv6/autoRenewal must be "0" or "1"
+ * - cycle is one of Day/Week/Month/Year
+ * - Date fields can be empty, ISO-like, or the special value "0000-00-00T23:59:59+08:00"
+ */
+export const PublicNoteSchema = z.object({
+    billingDataMod: z
+        .object({
+            startDate: z.string().optional(),
+            endDate: z.string().optional(),
+            autoRenewal: z.string().optional(),
+            cycle: z.string().optional(),
+            amount: z.string().optional(),
+        })
+        .optional(),
+    planDataMod: z
+        .object({
+            bandwidth: z.string().optional(),
+            trafficVol: z.string().optional(),
+            trafficType: z.string().optional(),
+            IPv4: z.string().optional(),
+            IPv6: z.string().optional(),
+            networkRoute: z.string().optional(),
+            extra: z.string().optional(),
+        })
+        .optional(),
+})
+
+export type PublicNote = z.infer<typeof PublicNoteSchema>
+
+export const defaultPublicNote: PublicNote = {}
+
+export const isValidISOLike = (v: string) => {
+    if (!v) return true
+    if (v === "0000-00-00T23:59:59+08:00") return true
+    const d = new Date(v)
+    return !isNaN(d.getTime())
+}
+
+export const normalizeISO = (v?: string) => {
+    if (!v) return undefined
+    if (v === "0000-00-00T23:59:59+08:00") return v
+    const date = new Date(v)
+    return isNaN(date.getTime()) ? v : date.toISOString()
+}
+
+/**
+ * Parse a string into PublicNote; return the default object if not valid JSON or validation fails.
+ */
+export const parsePublicNote = (s?: string): PublicNote => {
+    if (!s) return defaultPublicNote
+    try {
+        const obj = JSON.parse(s)
+        const parsed = PublicNoteSchema.safeParse(obj)
+        if (parsed.success) {
+            return parsed.data
+        }
+        return defaultPublicNote
+    } catch {
+        return defaultPublicNote
+    }
+}
+
+export const validatePublicNote = (pn: PublicNote) => {
+    const errors: Partial<Record<string, string>> = {}
+
+    // Structural and enum validations
+    if (pn.billingDataMod?.autoRenewal && !/^(0|1)$/.test(pn.billingDataMod.autoRenewal)) {
+        errors["billing.autoRenewal"] = i18n.t("Validation.MustBe0Or1")
+    }
+    if (pn.billingDataMod?.cycle && !/^(Day|Week|Month|Year)$/i.test(pn.billingDataMod.cycle)) {
+        errors["billing.cycle"] = i18n.t("Validation.MustBeDayWeekMonthYear")
+    }
+    if (pn.planDataMod?.trafficType && !/^(1|2)$/.test(pn.planDataMod.trafficType)) {
+        errors["plan.trafficType"] = i18n.t("Validation.MustBe1Or2")
+    }
+    if (pn.planDataMod?.IPv4 !== undefined && !/^(0|1)$/.test(pn.planDataMod.IPv4)) {
+        errors["plan.IPv4"] = i18n.t("Validation.MustBe0Or1")
+    }
+    if (pn.planDataMod?.IPv6 !== undefined && !/^(0|1)$/.test(pn.planDataMod.IPv6)) {
+        errors["plan.IPv6"] = i18n.t("Validation.MustBe0Or1")
+    }
+
+    // Date validity checks
+    if (pn.billingDataMod?.startDate && !isValidISOLike(pn.billingDataMod.startDate)) {
+        errors["billing.startDate"] = i18n.t("Validation.InvalidDate")
+    }
+    if (pn.billingDataMod?.endDate && !isValidISOLike(pn.billingDataMod.endDate)) {
+        errors["billing.endDate"] = i18n.t("Validation.InvalidDate")
+    }
+
+    return { errors, valid: Object.keys(errors).length === 0 }
+}
+
+/**
+ * Detect default mode from string: JSON matching schema -> "structured"; otherwise "raw".
+ */
+export const detectPublicNoteMode = (s?: string): "structured" | "raw" => {
+    if (!s) return "raw"
+    try {
+        const obj = JSON.parse(s)
+        const parsed = PublicNoteSchema.strict().safeParse(obj)
+        return parsed.success ? "structured" : "raw"
+    } catch {
+        return "raw"
+    }
+}
+
+/**
+ * Immutable patch by path, for use in component wrappers around setPublicNoteObj.
+ * Example path: "billingDataMod.startDate"
+ */
+export const applyPublicNotePatch = (
+    obj: PublicNote,
+    path: string,
+    value: string | undefined,
+): PublicNote => {
+    const keys = path.split(".")
+    const draft: any = structuredClone ? structuredClone(obj) : JSON.parse(JSON.stringify(obj))
+    let cur: any = draft
+    for (let i = 0; i < keys.length - 1; i++) {
+        const k = keys[i]
+        cur[k] = { ...(cur[k] ?? {}) }
+        cur = cur[k]
+    }
+    cur[keys[keys.length - 1]] = value
+    return draft
+}
+
+/**
+ * Update a date field while preserving time parts: if the previous value is a valid date,
+ * keep hours/minutes/seconds. Path example: "billingDataMod.startDate" | "billingDataMod.endDate"
+ */
+export const applyPublicNoteDate = (obj: PublicNote, path: string, date: Date): PublicNote => {
+    const keys = path.split(".")
+    const draft: any = structuredClone ? structuredClone(obj) : JSON.parse(JSON.stringify(obj))
+
+    // Read previous value to preserve time components
+    let curRead: any = draft
+    for (let i = 0; i < keys.length - 1; i++) {
+        const k = keys[i]
+        curRead = (curRead as any)[k]
+        if (!curRead) break
+    }
+    const leafKey = keys[keys.length - 1]
+    const prevVal: string | undefined = curRead ? curRead[leafKey] : undefined
+
+    const d = new Date(date)
+    if (prevVal) {
+        const pd = new Date(prevVal)
+        if (!isNaN(pd.getTime())) {
+            d.setHours(pd.getHours(), pd.getMinutes(), pd.getSeconds(), 0)
+        }
+    }
+
+    // Write back
+    let curWrite: any = draft
+    for (let i = 0; i < keys.length - 1; i++) {
+        const k = keys[i]
+        curWrite[k] = { ...(curWrite[k] ?? {}) }
+        curWrite = curWrite[k]
+    }
+    curWrite[leafKey] = d.toISOString()
+    return draft
+}
+
+/**
+ * Toggle the special "no expiry" value for endDate.
+ */
+export const toggleEndNoExpiry = (obj: PublicNote): PublicNote => {
+    const NO_EXPIRY = "0000-00-00T23:59:59+08:00"
+    const current = obj.billingDataMod?.endDate
+    const next = current === NO_EXPIRY ? "" : NO_EXPIRY
+    return applyPublicNotePatch(obj, "billingDataMod.endDate", next)
+}