Browse Source

Device Name dialog validation (#676)

* fix: style on config page

* feat: added device name validation

* Update src/i18n/locales/en/dialog.json

Co-authored-by: Copilot <[email protected]>

* Update src/components/Dialog/DeviceNameDialog.tsx

Co-authored-by: Copilot <[email protected]>

* Update src/components/Dialog/DeviceNameDialog.tsx

Co-authored-by: Copilot <[email protected]>

* fixed typo

---------

Co-authored-by: Copilot <[email protected]>
pull/678/head
Dan Ditomaso 12 months ago
committed by GitHub
parent
commit
43143bfdf6
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 1369
      deno.lock
  2. 3
      package.json
  3. 6
      public/site.webmanifest
  4. 58
      src/components/Dialog/DeviceNameDialog.tsx
  5. 4
      src/components/Dialog/UnsafeRolesDialog/UnsafeRolesDialog.tsx
  6. 39
      src/components/Form/FormInput.tsx
  7. 1
      src/components/PageComponents/Connect/BLE.tsx
  8. 21
      src/i18n/locales/en/dialog.json

1369
deno.lock

File diff suppressed because it is too large

3
package.json

@ -36,6 +36,7 @@
"homepage": "https://meshtastic.org", "homepage": "https://meshtastic.org",
"dependencies": { "dependencies": {
"@bufbuild/protobuf": "^2.2.5", "@bufbuild/protobuf": "^2.2.5",
"@hookform/resolvers": "^5.1.1",
"@meshtastic/core": "npm:@jsr/[email protected]", "@meshtastic/core": "npm:@jsr/[email protected]",
"@meshtastic/js": "npm:@jsr/[email protected]", "@meshtastic/js": "npm:@jsr/[email protected]",
"@meshtastic/transport-http": "npm:@jsr/meshtastic__transport-http", "@meshtastic/transport-http": "npm:@jsr/meshtastic__transport-http",
@ -84,7 +85,7 @@
"react-map-gl": "8.0.4", "react-map-gl": "8.0.4",
"react-qrcode-logo": "^3.0.0", "react-qrcode-logo": "^3.0.0",
"rfc4648": "^1.5.4", "rfc4648": "^1.5.4",
"zod": "^3.25.62", "zod": "^3.25.67",
"zustand": "5.0.5" "zustand": "5.0.5"
}, },
"devDependencies": { "devDependencies": {

6
public/site.webmanifest

@ -1,11 +1,11 @@
{ {
"name": "Meshtastic", "name": "Meshtastic",
"short_name": "Meshtastic", "short_name": "Web Client",
"start_url": ".", "start_url": ".",
"description": "Meshtastic web app", "description": "Meshtastic Web App",
"icons": [ "icons": [
{ {
"src": "/icon.svg", "src": "/Logo.svg",
"sizes": "any", "sizes": "any",
"type": "image/svg+xml" "type": "image/svg+xml"
} }

58
src/components/Dialog/DeviceNameDialog.tsx

@ -14,8 +14,9 @@ import { Protobuf } from "@meshtastic/core";
import { useForm } from "react-hook-form"; import { useForm } from "react-hook-form";
import { GenericInput } from "@components/Form/FormInput.tsx"; import { GenericInput } from "@components/Form/FormInput.tsx";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";
import { validateMaxByteLength } from "@core/utils/string.ts";
import { Label } from "../UI/Label.tsx"; import { Label } from "../UI/Label.tsx";
import z from "zod";
import { zodResolver } from "@hookform/resolvers/zod";
export interface User { export interface User {
longName: string; longName: string;
@ -26,8 +27,6 @@ export interface DeviceNameDialogProps {
open: boolean; open: boolean;
onOpenChange: (open: boolean) => void; onOpenChange: (open: boolean) => void;
} }
const MAX_LONG_NAME_BYTE_LENGTH = 40;
const MAX_SHORT_NAME_BYTE_LENGTH = 4;
export const DeviceNameDialog = ({ export const DeviceNameDialog = ({
open, open,
@ -38,27 +37,25 @@ export const DeviceNameDialog = ({
const myNode = getNode(hardware.myNodeNum); const myNode = getNode(hardware.myNodeNum);
const defaultValues = { const defaultValues = {
longName: myNode?.user?.longName ?? t("unknown.longName"), shortName: myNode?.user?.shortName ?? "",
shortName: myNode?.user?.shortName ?? t("unknown.shortName"), longName: myNode?.user?.longName ?? "",
}; };
const { getValues, setValue, reset, control, handleSubmit } = useForm<User>({ const deviceNameSchema = z.object({
values: defaultValues, longName: z
.string()
.min(1, t("deviceName.validation.longNameMin"))
.max(40, t("deviceName.validation.longNameMax")),
shortName: z
.string()
.min(2, t("deviceName.validation.shortNameMin"))
.max(4, t("deviceName.validation.shortNameMax")),
}); });
const { currentLength: currentLongNameLength } = validateMaxByteLength( const { getValues, reset, control, handleSubmit } = useForm<User>({
getValues("longName"), values: defaultValues,
MAX_LONG_NAME_BYTE_LENGTH, resolver: zodResolver(deviceNameSchema),
); });
const { currentLength: currentShortNameLength } = validateMaxByteLength(
getValues("shortName"),
MAX_SHORT_NAME_BYTE_LENGTH,
);
if (!myNode?.user) {
console.warn("DeviceNameDialog: No user data available");
return null;
}
const onSubmit = handleSubmit((data) => { const onSubmit = handleSubmit((data) => {
connection?.setOwner( connection?.setOwner(
@ -70,9 +67,7 @@ export const DeviceNameDialog = ({
}); });
const handleReset = () => { const handleReset = () => {
reset({ longName: "", shortName: "" }); reset(defaultValues);
setValue("longName", "");
setValue("shortName", "");
}; };
return ( return (
@ -99,8 +94,9 @@ export const DeviceNameDialog = ({
properties: { properties: {
className: "text-slate-900 dark:text-slate-200", className: "text-slate-900 dark:text-slate-200",
fieldLength: { fieldLength: {
currentValueLength: currentLongNameLength ?? 0, currentValueLength: getValues("longName").length,
max: MAX_LONG_NAME_BYTE_LENGTH, max: 40,
min: 1,
showCharacterCount: true, showCharacterCount: true,
}, },
}, },
@ -119,8 +115,9 @@ export const DeviceNameDialog = ({
type: "text", type: "text",
properties: { properties: {
fieldLength: { fieldLength: {
currentValueLength: currentShortNameLength ?? 0, currentValueLength: getValues("shortName").length,
max: MAX_SHORT_NAME_BYTE_LENGTH, max: 4,
min: 1,
showCharacterCount: true, showCharacterCount: true,
}, },
}, },
@ -137,7 +134,12 @@ export const DeviceNameDialog = ({
> >
{t("button.reset")} {t("button.reset")}
</Button> </Button>
<Button type="submit" name="save">{t("button.save")}</Button> <Button
type="submit"
name="save"
>
{t("button.save")}
</Button>
</DialogFooter> </DialogFooter>
</form> </form>
</DialogContent> </DialogContent>

4
src/components/Dialog/UnsafeRolesDialog/UnsafeRolesDialog.tsx

@ -63,7 +63,9 @@ export const UnsafeRolesDialog = (
onChange={() => setConfirmState(!confirmState)} onChange={() => setConfirmState(!confirmState)}
name="confirmUnderstanding" name="confirmUnderstanding"
> >
{t("unsafeRoles.confirmUnderstanding")} <span className="dark:text-white">
{t("unsafeRoles.confirmUnderstanding")}
</span>
</Checkbox> </Checkbox>
</div> </div>
<DialogFooter className="mt-6"> <DialogFooter className="mt-6">

39
src/components/Form/FormInput.tsx

@ -4,15 +4,14 @@ import type {
} from "@components/Form/DynamicForm.tsx"; } from "@components/Form/DynamicForm.tsx";
import { Input } from "@components/UI/Input.tsx"; import { Input } from "@components/UI/Input.tsx";
import type { ChangeEventHandler } from "react"; import type { ChangeEventHandler } from "react";
import { useState } from "react";
import { type FieldValues, useController } from "react-hook-form"; import { type FieldValues, useController } from "react-hook-form";
export interface InputFieldProps<T> extends BaseFormBuilderProps<T> { export interface InputFieldProps<T> extends BaseFormBuilderProps<T> {
type: "text" | "number" | "password"; type: "text" | "number" | "password";
inputChange?: ChangeEventHandler; inputChange?: ChangeEventHandler;
prefix?: string;
properties?: { properties?: {
value?: string; id?: string;
prefix?: string;
suffix?: string; suffix?: string;
step?: number; step?: number;
className?: string; className?: string;
@ -31,29 +30,33 @@ export function GenericInput<T extends FieldValues>({
control, control,
disabled, disabled,
field, field,
isDirty,
invalid, invalid,
}: GenericFormElementProps<T, InputFieldProps<T>>) { }: GenericFormElementProps<T, InputFieldProps<T>>) {
const { fieldLength, ...restProperties } = field.properties || {}; const { fieldLength, ...restProperties } = field.properties || {};
const [currentLength, setCurrentLength] = useState<number>(
fieldLength?.currentValueLength || 0,
);
const { field: controllerField } = useController({ const {
field: controllerField,
fieldState: { error, isDirty },
} = useController({
name: field.name, name: field.name,
control, control,
rules: {
minLength: field.properties?.fieldLength?.min,
maxLength: field.properties?.fieldLength?.max,
},
}); });
const isInvalid = invalid || Boolean(error?.message);
const handleInputChange = (e: React.ChangeEvent<HTMLInputElement>) => { const handleInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
const newValue = e.target.value; const newValue = e.target.value;
if ( if (
field.properties?.fieldLength?.max && field.properties?.fieldLength?.max &&
newValue.length > field.properties?.fieldLength?.max newValue.length > field.properties.fieldLength.max
) { ) {
return; return;
} }
setCurrentLength(newValue.length);
if (field.inputChange) field.inputChange(e); if (field.inputChange) field.inputChange(e);
@ -64,6 +67,10 @@ export function GenericInput<T extends FieldValues>({
); );
}; };
const currentLength = controllerField.value
? String(controllerField.value).length
: 0;
return ( return (
<div className="relative w-full"> <div className="relative w-full">
<Input <Input
@ -80,12 +87,18 @@ export function GenericInput<T extends FieldValues>({
className={field.properties?.className} className={field.properties?.className}
{...restProperties} {...restProperties}
disabled={disabled} disabled={disabled}
variant={invalid ? "invalid" : isDirty ? "dirty" : "default"} variant={error ? "invalid" : isDirty ? "dirty" : "default"}
/> />
{fieldLength?.showCharacterCount && fieldLength?.max && ( {fieldLength?.showCharacterCount && fieldLength.max && (
<div className="absolute inset-y-0 right-0 flex items-center pr-3 text-sm text-slate-900 dark:text-slate-200"> <div className="absolute inset-y-0 right-0 flex items-center pr-3 text-sm text-slate-900 dark:text-slate-200">
{currentLength ?? fieldLength?.currentValueLength}/{fieldLength?.max} {currentLength}/{fieldLength.max}
</div>
)}
{isInvalid && (
<div className="absolute inset-y-12 bottom-0 flex items-center pr-3">
<p className="text-sm text-red-500">{error?.message ?? ""}</p>
</div> </div>
)} )}
</div> </div>

1
src/components/PageComponents/Connect/BLE.tsx

@ -7,7 +7,6 @@ import { subscribeAll } from "@core/subscriptions.ts";
import { randId } from "@core/utils/randId.ts"; import { randId } from "@core/utils/randId.ts";
import { TransportWebBluetooth } from "@meshtastic/transport-web-bluetooth"; import { TransportWebBluetooth } from "@meshtastic/transport-web-bluetooth";
import { MeshDevice } from "@meshtastic/core"; import { MeshDevice } from "@meshtastic/core";
import type { BluetoothDevice } from "web-bluetooth";
import { useCallback, useEffect, useState } from "react"; import { useCallback, useEffect, useState } from "react";
import { useMessageStore } from "@core/stores/messageStore/index.ts"; import { useMessageStore } from "@core/stores/messageStore/index.ts";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";

21
src/i18n/locales/en/dialog.json

@ -7,7 +7,13 @@
"description": "The Device will restart once the config is saved.", "description": "The Device will restart once the config is saved.",
"longName": "Long Name", "longName": "Long Name",
"shortName": "Short Name", "shortName": "Short Name",
"title": "Change Device Name" "title": "Change Device Name",
"validation": {
"longNameMax": "Long name must not be more than 40 characters",
"shortNameMax": "Short name must not be more than 4 characters",
"longNameMin": "Long name must have at least 1 character",
"shortNameMin": "Short name must have at least 1 character"
}
}, },
"import": { "import": {
"description": "The current LoRa configuration will be overridden.", "description": "The current LoRa configuration will be overridden.",
@ -21,9 +27,10 @@
"title": "Import Channel Set" "title": "Import Channel Set"
}, },
"locationResponse": { "locationResponse": {
"title": "Location: {{identifier}}",
"altitude": "Altitude: ", "altitude": "Altitude: ",
"coordinates": "Coordinates: ", "coordinates": "Coordinates: ",
"title": "Location: {{identifier}}" "noCoordinates": "No Coordinates"
}, },
"pkiRegenerateDialog": { "pkiRegenerateDialog": {
"title": "Regenerate Pre-Shared Key?", "title": "Regenerate Pre-Shared Key?",
@ -61,11 +68,15 @@
}, },
"bluetoothConnection": { "bluetoothConnection": {
"noDevicesPaired": "No devices paired yet.", "noDevicesPaired": "No devices paired yet.",
"newDeviceButton": "New device" "newDeviceButton": "New device",
"connectionFailed": "Connection failed",
"deviceDisconnected": "Device disconnected",
"unknownDevice": "Unknown Device",
"errorLoadingDevices": "Error loading devices",
"unknownErrorLoadingDevices": "Unknown error loading devices"
}, },
"validation": { "validation": {
"requiresWebBluetooth": "This connection type requires <0>Web Bluetooth</0>. Please use a supported browser, like Chrome or Edge.", "requiresFeatures": "This connection type requires <0></0>. Please use a supported browser, like Chrome or Edge.",
"requiresWebSerial": "This connection type requires <0>Web Serial</0>. Please use a supported browser, like Chrome or Edge.",
"requiresSecureContext": "This application requires a <0>secure context</0>. Please connect using HTTPS or localhost.", "requiresSecureContext": "This application requires a <0>secure context</0>. Please connect using HTTPS or localhost.",
"additionallyRequiresSecureContext": "Additionally, it requires a <0>secure context</0>. Please connect using HTTPS or localhost." "additionallyRequiresSecureContext": "Additionally, it requires a <0>secure context</0>. Please connect using HTTPS or localhost."
} }

Loading…
Cancel
Save