ding-react-admin 1.0.4 → 2.0.4

package/src/crud/utils/prepareFormSubmitBody.ts

@@ -0,0 +1,22 @@
+import { hasUploadValues } from "./hasUploadValues";
+import { toFormData, type ToFormDataOptions } from "./toFormData";
+import { stripExistingUploadReferencesFromPayload } from "./uploadReferenceUtils";
+
+export type PrepareFormSubmitBodyOptions = ToFormDataOptions;
+
+/**
+ * When the payload contains any `File`/`Blob`, return `FormData`; otherwise the plain object.
+ * Unchanged upload URL references are omitted so edit saves do not re-post existing files.
+ */
+export function prepareFormSubmitBody(
+  payload: Record<string, unknown>,
+  options?: PrepareFormSubmitBodyOptions,
+): Record<string, unknown> | FormData {
+  const skipExistingUploadUrls = options?.skipExistingUploadUrls ?? true;
+
+  if (hasUploadValues(payload)) {
+    return toFormData(payload, options);
+  }
+
+  return stripExistingUploadReferencesFromPayload(payload, skipExistingUploadUrls);
+}

package/src/crud/utils/referenceSelectNotFoundContent.tsx

@@ -0,0 +1,7 @@
+import { Spin } from "antd";
+import type { ReactNode } from "react";
+
+/** Hide Ant Design Select "No data" while options are loading. */
+export function referenceSelectNotFoundContent(loading: boolean): ReactNode {
+  return loading ? <Spin size="small" /> : undefined;
+}

package/src/crud/utils/{setByPath.ts → setFormValue.ts}

@@ -1,18 +1,18 @@
-/** Write a value into a record using dot notation, e.g. `invoiceLine.product`. */
-export function setByPath(
-  record: Record<string, unknown>,
-  path: string,
-  value: unknown,
-): void {
-  const parts = path.split(".");
-  let cur: Record<string, unknown> = record;
-  for (let i = 0; i < parts.length - 1; i++) {
-    const part = parts[i];
-    const next = cur[part];
-    if (next == null || typeof next !== "object" || Array.isArray(next)) {
-      cur[part] = {};
-    }
-    cur = cur[part] as Record<string, unknown>;
-  }
-  cur[parts[parts.length - 1]!] = value;
-}
+/** Write a value into an object using dot notation, e.g. `invoiceLine.product`. */
+export function setFormValue(
+  record: Record<string, unknown>,
+  path: string,
+  value: unknown,
+): void {
+  const parts = path.split(".");
+  let cur: Record<string, unknown> = record;
+  for (let i = 0; i < parts.length - 1; i++) {
+    const part = parts[i];
+    const next = cur[part];
+    if (next == null || typeof next !== "object" || Array.isArray(next)) {
+      cur[part] = {};
+    }
+    cur = cur[part] as Record<string, unknown>;
+  }
+  cur[parts[parts.length - 1]!] = value;
+}

package/src/crud/utils/sortQueryParam.ts

@@ -1,37 +1,37 @@
-import type { SortOrder, SortSpec } from "../../data/dataProviderTypes";
-
-/** Parse `sort` query (Django-style: `sku,-price`; legacy: `sku:asc,price:desc`). */
-export function parseSortParam(raw: string | null): SortSpec[] {
-  if (!raw) return [];
-  const specs: SortSpec[] = [];
-  for (const part of raw.split(",").map((p) => p.trim()).filter(Boolean)) {
-    if (part.includes(":")) {
-      const [field, orderRaw] = part.split(":");
-      if (!field) continue;
-      const order: SortOrder =
-        orderRaw?.toLowerCase() === "desc" ? "DESC" : "ASC";
-      specs.push({ field, order });
-      continue;
-    }
-    if (part.startsWith("-") && part.length > 1) {
-      specs.push({ field: part.slice(1), order: "DESC" });
-    } else {
-      specs.push({ field: part, order: "ASC" });
-    }
-  }
-  return specs;
-}
-
-/** Serialize sort specs to Django-style `sku,-price`. */
-export function serializeSort(specs: SortSpec[]): string | null {
-  if (specs.length === 0) return null;
-  return specs
-    .map((s) => (s.order === "DESC" ? `-${s.field}` : s.field))
-    .join(",");
-}
-
-export function sortPrioritiesFromSpecs(
-  specs: SortSpec[],
-): Map<string, number> {
-  return new Map(specs.map((s, i) => [s.field, i + 1]));
-}
+import type { SortOrder, SortSpec } from "../../data/dataProviderTypes";
+
+/** Parse `sort` query (Django-style: `sku,-price`; legacy: `sku:asc,price:desc`). */
+export function parseSortParam(raw: string | null): SortSpec[] {
+  if (!raw) return [];
+  const specs: SortSpec[] = [];
+  for (const part of raw.split(",").map((p) => p.trim()).filter(Boolean)) {
+    if (part.includes(":")) {
+      const [field, orderRaw] = part.split(":");
+      if (!field) continue;
+      const order: SortOrder =
+        orderRaw?.toLowerCase() === "desc" ? "DESC" : "ASC";
+      specs.push({ field, order });
+      continue;
+    }
+    if (part.startsWith("-") && part.length > 1) {
+      specs.push({ field: part.slice(1), order: "DESC" });
+    } else {
+      specs.push({ field: part, order: "ASC" });
+    }
+  }
+  return specs;
+}
+
+/** Serialize sort specs to Django-style `sku,-price`. */
+export function serializeSort(specs: SortSpec[]): string | null {
+  if (specs.length === 0) return null;
+  return specs
+    .map((s) => (s.order === "DESC" ? `-${s.field}` : s.field))
+    .join(",");
+}
+
+export function sortPrioritiesFromSpecs(
+  specs: SortSpec[],
+): Map<string, number> {
+  return new Map(specs.map((s, i) => [s.field, i + 1]));
+}

package/src/crud/utils/toFormData.ts

@@ -0,0 +1,79 @@
+import { isExistingUploadReference } from "./uploadReferenceUtils";
+
+export type ToFormDataOptions = {
+  /**
+   * Omit unchanged upload URL strings (`http://` / `https://` / `/media/`) from the body.
+   * Default `true` — edit forms keep existing files without re-sending the URL.
+   */
+  skipExistingUploadUrls?: boolean;
+};
+
+function appendFormDataValue(
+  formData: FormData,
+  key: string,
+  value: unknown,
+  options: Required<ToFormDataOptions>,
+): void {
+  if (value === undefined) return;
+
+  if (value === null) {
+    formData.append(key, "");
+    return;
+  }
+
+  if (value instanceof Blob) {
+    formData.append(key, value);
+    return;
+  }
+
+  if (typeof value === "boolean" || typeof value === "number") {
+    formData.append(key, String(value));
+    return;
+  }
+
+  if (typeof value === "string") {
+    if (options.skipExistingUploadUrls && isExistingUploadReference(value)) {
+      return;
+    }
+    formData.append(key, value);
+    return;
+  }
+
+  if (Array.isArray(value)) {
+    value.forEach((item, index) => {
+      appendFormDataValue(formData, `${key}[${index}]`, item, options);
+    });
+    return;
+  }
+
+  if (typeof value === "object") {
+    for (const [childKey, childValue] of Object.entries(
+      value as Record<string, unknown>,
+    )) {
+      appendFormDataValue(formData, `${key}[${childKey}]`, childValue, options);
+    }
+    return;
+  }
+
+  formData.append(key, String(value));
+}
+
+/**
+ * Flatten a save payload into `FormData` using bracket notation for nested fields
+ * and arrays (e.g. `lines[0][label]`, `address[city]`).
+ */
+export function toFormData(
+  data: Record<string, unknown>,
+  options?: ToFormDataOptions,
+): FormData {
+  const resolved: Required<ToFormDataOptions> = {
+    skipExistingUploadUrls: options?.skipExistingUploadUrls ?? true,
+  };
+  const formData = new FormData();
+
+  for (const [key, value] of Object.entries(data)) {
+    appendFormDataValue(formData, key, value, resolved);
+  }
+
+  return formData;
+}

package/src/crud/utils/uploadReferenceUtils.ts

@@ -0,0 +1,44 @@
+/** Existing server-side upload reference — omit on save unless replaced with a new File. */
+export function isExistingUploadReference(value: string): boolean {
+  return /^https?:\/\//i.test(value) || value.startsWith("/media/");
+}
+
+export function stripExistingUploadReferences(
+  value: unknown,
+  skipExistingUploadUrls: boolean,
+): unknown {
+  if (!skipExistingUploadUrls) return value;
+
+  if (typeof value === "string") {
+    return isExistingUploadReference(value) ? undefined : value;
+  }
+
+  if (Array.isArray(value)) {
+    return value
+      .map((item) => stripExistingUploadReferences(item, skipExistingUploadUrls))
+      .filter((item) => item !== undefined);
+  }
+
+  if (value && typeof value === "object" && !(value instanceof Blob)) {
+    const result: Record<string, unknown> = {};
+    for (const [key, child] of Object.entries(value as Record<string, unknown>)) {
+      const stripped = stripExistingUploadReferences(child, skipExistingUploadUrls);
+      if (stripped !== undefined) {
+        result[key] = stripped;
+      }
+    }
+    return result;
+  }
+
+  return value;
+}
+
+export function stripExistingUploadReferencesFromPayload(
+  payload: Record<string, unknown>,
+  skipExistingUploadUrls = true,
+): Record<string, unknown> {
+  return stripExistingUploadReferences(payload, skipExistingUploadUrls) as Record<
+    string,
+    unknown
+  >;
+}

package/src/crud/utils/useAbortableEffect.ts

@@ -1,17 +1,17 @@
-import { useEffect, type DependencyList } from "react";
-
-/**
- * Runs an async effect with an `AbortSignal` that aborts on cleanup.
- * Use with `params.signal` on DataProvider reads and `isAbortError` in catch blocks.
- */
-export function useAbortableEffect(
-  effect: (signal: AbortSignal) => void | Promise<void>,
-  deps: DependencyList,
-): void {
-  useEffect(() => {
-    const controller = new AbortController();
-    void effect(controller.signal);
-    return () => controller.abort();
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, deps);
-}
+import { useEffect, type DependencyList } from "react";
+
+/**
+ * Runs an async effect with an `AbortSignal` that aborts on cleanup.
+ * Use with `params.signal` on DataProvider reads and `isAbortError` in catch blocks.
+ */
+export function useAbortableEffect(
+  effect: (signal: AbortSignal) => void | Promise<void>,
+  deps: DependencyList,
+): void {
+  useEffect(() => {
+    const controller = new AbortController();
+    void effect(controller.signal);
+    return () => controller.abort();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, deps);
+}