feat: add max items for scalar arrays

premieroctet · Feb 5, 2025 · 295c0e1 · 295c0e1
1 parent 4cf5935
commit 295c0e1
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 13 deletions.
diff --git a/.changeset/modern-kids-wonder.md b/.changeset/modern-kids-wonder.md
@@ -0,0 +1,5 @@
+---
+"@premieroctet/next-admin": patch
+---
+
+feat: add max items for scalar arrays
diff --git a/apps/example/options.tsx b/apps/example/options.tsx
@@ -110,8 +110,7 @@ export const options: NextAdminOptions = {
             input: <DatePicker />,
           },
           posts: {
-            display: "list",
-            orderField: "order",
+            display: "table",
           },
           avatar: {
             format: "file",
@@ -301,6 +300,7 @@ export const options: NextAdminOptions = {
                 return faker.image.url({ width: 200, height: 200 });
               },
             },
+            maxLength: 5,
           },
         },
         display: [

diff --git a/packages/next-admin/src/components/inputs/FileWidget/FileWidget.tsx b/packages/next-admin/src/components/inputs/FileWidget/FileWidget.tsx
@@ -44,7 +44,13 @@ const FileWidget = (props: Props) => {
           return [selectedFiles[0]];
         }
 
-        return [...old, ...Array.from(selectedFiles)];
+        const newArray = [...old, ...Array.from(selectedFiles)];
+
+        if (props.schema?.maxItems) {
+          return newArray.slice(0, props.schema.maxItems);
+        }
+
+        return newArray;
       });
     }
   };
@@ -82,7 +88,13 @@ const FileWidget = (props: Props) => {
       setFieldDirty(props.name);
       setFiles((old) => {
         if (acceptsMultipleFiles) {
-          return [...old, ...Array.from(event.dataTransfer.files)];
+          const newArray = [...old, ...Array.from(event.dataTransfer.files)];
+
+          if (props.schema?.maxItems) {
+            return newArray.slice(0, props.schema.maxItems);
+          }
+
+          return newArray;
         }
 
         return [event.dataTransfer.files[0]];

diff --git a/packages/next-admin/src/components/inputs/ScalarArray/ScalarArrayField.tsx b/packages/next-admin/src/components/inputs/ScalarArray/ScalarArrayField.tsx
@@ -86,13 +86,19 @@ const ScalarArrayField = ({
   };
 
   const onAddNewItem = () => {
-    setFormDataList((prev) => [
-      ...prev,
-      {
-        id: crypto.randomUUID(),
-        value: "",
-      },
-    ]);
+    setFormDataList((prev) => {
+      if (schema.maxItems && prev.length >= schema.maxItems) {
+        return prev;
+      }
+
+      return [
+        ...prev,
+        {
+          id: crypto.randomUUID(),
+          value: "",
+        },
+      ];
+    });
     setFieldDirty(name);
   };
 
@@ -115,7 +121,10 @@ const ScalarArrayField = ({
       <Button
         type="button"
         className="w-fit"
-        disabled={disabled}
+        disabled={
+          disabled ||
+          (schema.maxItems ? formDataList.length >= schema.maxItems : false)
+        }
         onClick={onAddNewItem}
       >
         {t("form.widgets.scalar_array.add")}

diff --git a/packages/next-admin/src/types.ts b/packages/next-admin/src/types.ts
@@ -244,6 +244,8 @@ type OptionFormatterFromRelationshipSearch<
       };
 }[RelationshipSearch<ModelFromProperty<T, P>>["field"]];
 
+export type ScalarArray = string[] | number[] | boolean[];
+
 export type EditFieldsOptions<T extends ModelName> = {
   [P in Field<T>]?: {
     /**
@@ -284,6 +286,7 @@ export type EditFieldsOptions<T extends ModelName> = {
      * a function that takes the field value as parameter and returns a boolean to determine if the field is displayed in the form.
      */
     visible?: (value: ModelWithoutRelationships<T>) => boolean;
+    maxLength?: Model<T>[P] extends ScalarArray ? number : never;
   } & (P extends keyof ObjectField<T>
     ? OptionFormatterFromRelationshipSearch<T, P> &
         (

diff --git a/packages/next-admin/src/utils/server.ts b/packages/next-admin/src/utils/server.ts
@@ -1165,7 +1165,8 @@ export const transformSchema = <M extends ModelName>(
     fillRelationInSchema(resource, options),
     fillDescriptionInSchema(resource, edit),
     addCustomProperties(resource, edit),
-    orderSchema(resource, options)
+    orderSchema(resource, options),
+    applyArrayMaxLength(resource, edit)
   );
 
 export const applyVisiblePropertiesInSchema = <M extends ModelName>(
@@ -1294,6 +1295,24 @@ export const addCustomProperties =
     return schema;
   };
 
+export const applyArrayMaxLength =
+  <M extends ModelName>(resource: M, editOptions: EditOptions<M>) =>
+  (schema: Schema) => {
+    const modelName = resource;
+    const modelSchema = schema.definitions[
+      modelName
+    ] as SchemaDefinitions[ModelName];
+    if (!modelSchema) return schema;
+    Object.entries(modelSchema.properties).forEach(([name]) => {
+      const propertyName = name as Field<typeof modelName>;
+      const fieldValue = schema.definitions[modelName].properties[propertyName];
+      if (fieldValue && editOptions?.fields?.[propertyName]?.maxLength) {
+        fieldValue.maxItems = editOptions?.fields?.[propertyName]?.maxLength;
+      }
+    });
+    return schema;
+  };
+
 export const getResourceFromParams = (
   params: string[],
   resources: Prisma.ModelName[]