@easy-cms/core 0.22.2 → 0.23.0

package/dist/index.d.ts

@@ -415,7 +415,9 @@ type FieldValue<F extends Field, C extends Config = Config> = F extends {
     readonly type: 'richText';
 } ? RichTextDocument : F extends {
     readonly type: 'upload';
-} ? ID | MediaDocument : F extends {
+} ? F extends {
+    readonly hasMany: true;
+} ? (ID | MediaDocument)[] : ID | MediaDocument : F extends {
     readonly type: 'relationship';
     readonly to: infer S;
 } ? F extends {
@@ -504,7 +506,9 @@ type InputValue<F extends Field> = F extends {
     readonly hasMany: true;
 } ? Readonly<SelectValue<F>> : F extends {
     readonly type: 'upload';
-} ? ID : F extends {
+} ? F extends {
+    readonly hasMany: true;
+} ? readonly ID[] : ID : F extends {
     readonly type: 'date';
 } ? string | Date : F extends {
     readonly type: 'array';
@@ -1037,8 +1041,19 @@ interface RichTextDocument {
 }
 interface RichTextField extends BaseField<'richText', RichTextDocument> {
 }
-/** References a document in the built-in `media` collection. */
+/** References a document in the built-in `media` collection: a file or an image. */
 interface UploadField extends BaseField<'upload', never> {
+    /** Several files, e.g. a gallery: the value is a list, in the order editors arrange. */
+    readonly hasMany?: boolean;
+    /** With `hasMany`: the fewest files. */
+    readonly minRows?: number;
+    /** With `hasMany`: the most files. */
+    readonly maxRows?: number;
+    /**
+     * The file types allowed, e.g. `['image/*']` or `['image/*', 'application/pdf']`. The admin
+     * offers only these, and saving refuses others.
+     */
+    readonly mimeTypes?: readonly string[];
 }
 interface FilterOptionsArgs {
     /** The document being edited; `undefined` while it is being created. */
@@ -1055,6 +1070,10 @@ interface RelationshipField extends BaseField<'relationship', never> {
     /** Slug of the target collection. */
     readonly to: string;
     readonly hasMany?: boolean;
+    /** With `hasMany`: the fewest documents. */
+    readonly minRows?: number;
+    /** With `hasMany`: the most documents. */
+    readonly maxRows?: number;
     readonly filterOptions?: FilterOptions;
 }
 interface ArrayField extends BaseField<'array', never> {
@@ -1084,6 +1103,10 @@ interface BlocksField extends BaseField<'blocks', never> {
     readonly minRows?: number;
     readonly maxRows?: number;
 }
+/** Fields with `hasMany`: their value is a list of options, documents or files. */
+declare const isHasMany: (field: Field) => boolean;
+/** Whether a MIME type is one of `patterns` (`image/*` matches every image). */
+declare function mimeAllowedBy(mimeType: string, patterns: readonly string[]): boolean;
 /** Fields whose value is a list of rows: `array` and `blocks`. */
 declare const hasRows: (field: Field) => field is ArrayField | BlocksField;
 /** The fields of one row of an `array` or `blocks` field (`undefined` for an unknown block). */
@@ -1623,6 +1646,8 @@ interface Reference {
     readonly id: ID;
     /** The relationship's `filterOptions`, checked when saving. */
     readonly filterOptions?: FilterOptions;
+    /** The upload's `mimeTypes`, checked when saving. */
+    readonly mimeTypes?: readonly string[];
 }
 interface ValidateOptions {
     readonly operation: 'create' | 'update';
@@ -1732,6 +1757,8 @@ interface AdminField {
     }[];
     hasMany?: boolean;
     to?: string;
+    /** An upload's allowed file types, e.g. `image/*`. */
+    mimeTypes?: string[];
     /** A relationship with `filterOptions`: the picker asks the server which documents fit. */
     filtered?: boolean;
     from?: string;
@@ -1859,4 +1886,4 @@ declare const BUILTIN_COLLECTIONS: readonly ["users", "media"];
 /** Checks a config and returns every problem found. An empty array means it is valid. */
 declare function validateConfig(config: Config): ConfigIssue[];
 
-export { ADMIN_ICONS, API_KEYS, API_KEY_GLOBAL_OPERATIONS, API_KEY_OPERATIONS, type Access, type AccessArgs, type AccessOptions, type AdminBrand, type AdminCollection, type AdminComponent, type AdminComponentRef, type AdminConfig, type AdminField, type AdminGlobal, type AdminIcon, type AdminLocale, type AdminSchema, type AfterChangeHook, type AfterDeleteHook, type AfterReadHook, type ApiKeyContext, type ApiKeyGlobalOperation, type ApiKeyOperation, type ApiKeyPermissions, type ArrayField, Auth, type AuthConfig, type AuthUser, BUILTIN_COLLECTIONS, type BeforeChangeHook, type BeforeDeleteHook, type BeforeValidateHook, type Block, type BlocksField, type BooleanField, type BuiltinApiKeysCollection, type BuiltinMediaCollection, type BuiltinUsersCollection, type BundleHints, CONFIG_FILE_NAMES, CSRF_COOKIE, CSRF_HEADER, type CliCommand, type CollectionAccess, type CollectionAdmin, type CollectionConfig, type CollectionDocument, type CollectionHooks, type CollectionListAdmin, type CollectionSlug, type Config, ConfigError, type ConfigIssue, type ContainerAdmin, type CopyProgress, type CopyResult, type CreateEasyCMSOptions, type CreateInput, type CreateMigrationResult, DEFAULT_ADMIN_PATH, DEFAULT_API_PATH, DEFAULT_DEPTH, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_VERSIONS, DEFAULT_TOKEN_EXPIRATION, type Database, type DatabaseAdapter, type DatabaseInitArgs, type DatabaseTransfer, type DateField, type DepthOptions, EXTENSIONS, EasyCMS, EasyCMSError, type EmailAdapter, type EmailField, type EmailMessage, type Endpoint, type EndpointRequest, FIELD_TYPES, type Field, type FieldAccess, type FieldAccessFn, type FieldAdmin, type FieldError, type FieldType, type FieldValidate, type FieldValidateContext, type FieldValue, type FieldsInput, type FieldsValue, type FilterOptions, type FilterOptionsArgs, type FindArgs, type FindOptions, ForbiddenError, type GlobalAccess, type GlobalConfig, type GlobalDocument, type GlobalHooks, type GlobalInput, type GlobalSlug, type GroupField, type ID, INTERNAL_COLLECTIONS, type ImageSize, type InferCollection, type InferGlobal, type JsonField, type Label, type LivePreview, type LoadConfigOptions, type LocalStorageOptions, type LocalizationConfig, type Logger, type LoginArgs, MAX_DEPTH, MEDIA, MIN_PASSWORD_LENGTH, MIN_SECRET_LENGTH, type MediaDocument, type MediaSize, type MigrationInfo, NotFoundError, type NumberField, type Operation, type PaginatedDocs, PayloadTooLargeError, type Plugin, type PreviewTarget, type PreviewURL, QueryError, type RawDocument, type ReadOptions, type RelationshipField, type ResolvedConfig, type RestHandler, type RestHandlerOptions, type RichTextDocument, type RichTextField, type Role, type RoutesConfig, SESSION_COOKIE, type ScheduledJob, SchemaError, type SchemaMode, type SelectField, type SelectOption, type Session, type SlugField, type StorageAdapter, type StoredFile, type TextField, type TextareaField, TooManyRequestsError, UnauthorizedError, type UpdateInput, type UpdateOptions, type UploadConfig, type UploadField, ValidationError, type Version, type VersionSummary, type VersionsConfig, WEBHOOK_EVENTS, type WebhookConfig, type WebhookEvent, type WebhookPayload, type Where, type WhereOperators, anyone, applyDefaults, applyPlugins, configSignature, consoleEmail, consoleLogger, copyDatabase, createEasyCMS, createRestHandler, createRootEndpointHandler, defineConfig, fillMissing, findConfigFile, generateSlugs, generateTypes, hasRows, hashPassword, imageDimensions, importConfig, isAdmin, isLoggedIn, keyAllows, loadConfig, localStorage, mergeForUpdate, mimeAllowed, parseId, populate, readCookie, resolveAdminModule, resolveConfig, rowFields, silentLogger, singularize, slugify, sniffMimeType, validateConfig, validateFields, verifyPassword };
+export { ADMIN_ICONS, API_KEYS, API_KEY_GLOBAL_OPERATIONS, API_KEY_OPERATIONS, type Access, type AccessArgs, type AccessOptions, type AdminBrand, type AdminCollection, type AdminComponent, type AdminComponentRef, type AdminConfig, type AdminField, type AdminGlobal, type AdminIcon, type AdminLocale, type AdminSchema, type AfterChangeHook, type AfterDeleteHook, type AfterReadHook, type ApiKeyContext, type ApiKeyGlobalOperation, type ApiKeyOperation, type ApiKeyPermissions, type ArrayField, Auth, type AuthConfig, type AuthUser, BUILTIN_COLLECTIONS, type BeforeChangeHook, type BeforeDeleteHook, type BeforeValidateHook, type Block, type BlocksField, type BooleanField, type BuiltinApiKeysCollection, type BuiltinMediaCollection, type BuiltinUsersCollection, type BundleHints, CONFIG_FILE_NAMES, CSRF_COOKIE, CSRF_HEADER, type CliCommand, type CollectionAccess, type CollectionAdmin, type CollectionConfig, type CollectionDocument, type CollectionHooks, type CollectionListAdmin, type CollectionSlug, type Config, ConfigError, type ConfigIssue, type ContainerAdmin, type CopyProgress, type CopyResult, type CreateEasyCMSOptions, type CreateInput, type CreateMigrationResult, DEFAULT_ADMIN_PATH, DEFAULT_API_PATH, DEFAULT_DEPTH, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_VERSIONS, DEFAULT_TOKEN_EXPIRATION, type Database, type DatabaseAdapter, type DatabaseInitArgs, type DatabaseTransfer, type DateField, type DepthOptions, EXTENSIONS, EasyCMS, EasyCMSError, type EmailAdapter, type EmailField, type EmailMessage, type Endpoint, type EndpointRequest, FIELD_TYPES, type Field, type FieldAccess, type FieldAccessFn, type FieldAdmin, type FieldError, type FieldType, type FieldValidate, type FieldValidateContext, type FieldValue, type FieldsInput, type FieldsValue, type FilterOptions, type FilterOptionsArgs, type FindArgs, type FindOptions, ForbiddenError, type GlobalAccess, type GlobalConfig, type GlobalDocument, type GlobalHooks, type GlobalInput, type GlobalSlug, type GroupField, type ID, INTERNAL_COLLECTIONS, type ImageSize, type InferCollection, type InferGlobal, type JsonField, type Label, type LivePreview, type LoadConfigOptions, type LocalStorageOptions, type LocalizationConfig, type Logger, type LoginArgs, MAX_DEPTH, MEDIA, MIN_PASSWORD_LENGTH, MIN_SECRET_LENGTH, type MediaDocument, type MediaSize, type MigrationInfo, NotFoundError, type NumberField, type Operation, type PaginatedDocs, PayloadTooLargeError, type Plugin, type PreviewTarget, type PreviewURL, QueryError, type RawDocument, type ReadOptions, type RelationshipField, type ResolvedConfig, type RestHandler, type RestHandlerOptions, type RichTextDocument, type RichTextField, type Role, type RoutesConfig, SESSION_COOKIE, type ScheduledJob, SchemaError, type SchemaMode, type SelectField, type SelectOption, type Session, type SlugField, type StorageAdapter, type StoredFile, type TextField, type TextareaField, TooManyRequestsError, UnauthorizedError, type UpdateInput, type UpdateOptions, type UploadConfig, type UploadField, ValidationError, type Version, type VersionSummary, type VersionsConfig, WEBHOOK_EVENTS, type WebhookConfig, type WebhookEvent, type WebhookPayload, type Where, type WhereOperators, anyone, applyDefaults, applyPlugins, configSignature, consoleEmail, consoleLogger, copyDatabase, createEasyCMS, createRestHandler, createRootEndpointHandler, defineConfig, fillMissing, findConfigFile, generateSlugs, generateTypes, hasRows, hashPassword, imageDimensions, importConfig, isAdmin, isHasMany, isLoggedIn, keyAllows, loadConfig, localStorage, mergeForUpdate, mimeAllowed, mimeAllowedBy, parseId, populate, readCookie, resolveAdminModule, resolveConfig, rowFields, silentLogger, singularize, slugify, sniffMimeType, validateConfig, validateFields, verifyPassword };

package/dist/index.js

@@ -209,6 +209,14 @@ var PayloadTooLargeError = class extends EasyCMSError {
 };
 
 // src/fields.ts
+var isHasMany = (field) => (field.type === "select" || field.type === "relationship" || field.type === "upload") && field.hasMany === true;
+function mimeAllowedBy(mimeType, patterns) {
+  const type = mimeType.toLowerCase();
+  return patterns.some((pattern) => {
+    const p = pattern.toLowerCase();
+    return p.endsWith("/*") ? type.startsWith(p.slice(0, -1)) : type === p;
+  });
+}
 var hasRows = (field) => field.type === "array" || field.type === "blocks";
 function rowFields(field, row) {
   if (field.type === "array") return field.fields;
@@ -997,6 +1005,10 @@ async function copyDatabase(source, target, options = {}) {
 import { randomUUID } from "crypto";
 var EMAIL_PATTERN = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
 var isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+function itemsOf(field, n) {
+  const unit = field.type === "upload" ? "file" : field.type === "relationship" ? "document" : "row";
+  return `${n} ${unit}${n === 1 ? "" : "s"}`;
+}
 var isEmpty = (value) => value === void 0 || value === null || value === "";
 function slugify(text) {
   return text.normalize("NFKC").toLowerCase().replace(/[^\p{L}\p{M}\p{N}]+/gu, "-").replace(/^-+|-+$/g, "");
@@ -1162,6 +1174,8 @@ async function validateFields(fields, input, options, prefix = "") {
     }
     if (isEmpty(raw) || Array.isArray(raw) && raw.length === 0) {
       if (field.required && !options.skipRequired) fail("is required");
+      else if (!options.skipRequired && "minRows" in field && field.minRows)
+        fail(`must have at least ${itemsOf(field, field.minRows)}`);
       data[field.name] = hasRows(field) || isHasMany(field) ? [] : null;
       if (!field.required) await runCustom(field, null, options, fail);
       continue;
@@ -1173,9 +1187,6 @@ async function validateFields(fields, input, options, prefix = "") {
   }
   return { data, errors, references };
 }
-function isHasMany(field) {
-  return (field.type === "select" || field.type === "relationship") && field.hasMany === true;
-}
 async function runCustom(field, value, options, fail) {
   if (!field.validate) return;
   const validate = field.validate;
@@ -1231,9 +1242,13 @@ async function normalizeValue(field, raw, path, options, fail, errors, reference
     case "upload":
     case "relationship": {
       const target = field.type === "upload" ? "media" : field.to;
-      const many = field.type === "relationship" && field.hasMany === true;
+      const many = field.hasMany === true;
       const values = many ? raw : [raw];
       if (!Array.isArray(values)) return fail("must be an array of ids");
+      if (many && field.minRows !== void 0 && values.length < field.minRows)
+        return fail(`must have at least ${itemsOf(field, field.minRows)}`);
+      if (many && field.maxRows !== void 0 && values.length > field.maxRows)
+        return fail(`must have at most ${itemsOf(field, field.maxRows)}`);
       const ids = [];
       for (const item of values) {
         const id = parseId(isPlainObject(item) ? item.id : item);
@@ -1244,7 +1259,8 @@ async function normalizeValue(field, raw, path, options, fail, errors, reference
           field: path,
           collection: target,
           id,
-          ...field.type === "relationship" && field.filterOptions ? { filterOptions: field.filterOptions } : {}
+          ...field.type === "relationship" && field.filterOptions ? { filterOptions: field.filterOptions } : {},
+          ...field.type === "upload" && field.mimeTypes ? { mimeTypes: field.mimeTypes } : {}
         });
       }
       return many ? ids : ids[0];
@@ -2060,6 +2076,13 @@ function validateList(list, container, path, add) {
     );
   }
 }
+function validateManyRange(field, path, add) {
+  if ((field.minRows !== void 0 || field.maxRows !== void 0) && !field.hasMany) {
+    add(path, "minRows and maxRows need hasMany: true");
+    return;
+  }
+  checkRange(field.minRows, field.maxRows, "minRows", "maxRows", path, add);
+}
 function validateField(field, path, siblings, collectionSlugs, add) {
   const position = field.position;
   if (position !== void 0 && position !== "sidebar") {
@@ -2115,6 +2138,16 @@ function validateField(field, path, siblings, collectionSlugs, add) {
           `use one of: ${[...collectionSlugs].join(", ")}`
         );
       }
+      validateManyRange(field, path, add);
+      break;
+    case "upload":
+      validateManyRange(field, path, add);
+      if (field.mimeTypes !== void 0) {
+        const types = field.mimeTypes;
+        if (!Array.isArray(types) || types.length === 0 || !types.every((t) => typeof t === "string" && /^[\w.+-]+\/(\*|[\w.+-]+)$/.test(t))) {
+          add(`${path}.mimeTypes`, "must be a list of MIME types", "e.g. mimeTypes: ['image/*']");
+        }
+      }
       break;
     case "array":
     case "group":
@@ -4343,10 +4376,20 @@ var EasyCMS = class {
         collection: collection2,
         ids: [...new Set(refs.map((r) => r.id))]
       });
-      const ids = new Set(found.map((d) => d.id));
+      const byId = new Map(found.map((d) => [d.id, d]));
       for (const ref of refs) {
-        if (!ids.has(ref.id)) {
+        const doc = byId.get(ref.id);
+        if (!doc) {
           errors.push({ field: ref.field, message: `${collection2} ${ref.id} does not exist` });
+          continue;
+        }
+        const type = typeof doc.mimeType === "string" ? doc.mimeType : "";
+        if (ref.mimeTypes && !mimeAllowedBy(type, ref.mimeTypes)) {
+          const images = ref.mimeTypes.every((t) => t.toLowerCase() === "image/*");
+          errors.push({
+            field: ref.field,
+            message: images ? `must be an image (${doc.filename ?? ref.id} is ${type || "not one"})` : `must be ${ref.mimeTypes.join(", ")} (${doc.filename ?? ref.id} is ${type || "unknown"})`
+          });
         }
       }
     }
@@ -4492,10 +4535,16 @@ async function serializeFields(fields, update, localized) {
       case "relationship":
         f.to = field.to;
         if (field.hasMany) f.hasMany = true;
+        if (field.minRows !== void 0) f.minRows = field.minRows;
+        if (field.maxRows !== void 0) f.maxRows = field.maxRows;
         if (field.filterOptions) f.filtered = true;
         break;
       case "upload":
         f.to = "media";
+        if (field.hasMany) f.hasMany = true;
+        if (field.minRows !== void 0) f.minRows = field.minRows;
+        if (field.maxRows !== void 0) f.maxRows = field.maxRows;
+        if (field.mimeTypes) f.mimeTypes = [...field.mimeTypes];
         break;
       case "array":
         if (field.minRows !== void 0) f.minRows = field.minRows;
@@ -5370,8 +5419,10 @@ function fieldType(field, n, indent) {
       const union = field.options.map((o) => quote(typeof o === "string" ? o : o.value)).join(" | ") || "string";
       return field.hasMany ? `(${union})[]` : union;
     }
-    case "upload":
-      return `ID | ${n.collections.get(MEDIA) ?? "Record<string, unknown>"}`;
+    case "upload": {
+      const one = `ID | ${n.collections.get(MEDIA) ?? "Record<string, unknown>"}`;
+      return field.hasMany ? `(${one})[]` : one;
+    }
     case "relationship": {
       const target = n.collections.get(field.to);
       const one = target ? `ID | ${target}` : "ID";
@@ -5403,7 +5454,7 @@ function fieldLines(fields, n, indent) {
   for (const field of fields) {
     if (field.hidden) continue;
     const type = fieldType(field, n, indent);
-    const alwaysPresent = field.type === "array" || field.type === "blocks" || field.type === "group" || (field.type === "select" || field.type === "relationship") && field.hasMany;
+    const alwaysPresent = field.type === "array" || field.type === "blocks" || field.type === "group" || isHasMany(field);
     if (field.required || alwaysPresent) lines.push(`${indent}${key(field.name)}: ${type}`);
     else lines.push(`${indent}${key(field.name)}?: ${type} | null`);
   }
@@ -5536,12 +5587,14 @@ export {
   imageDimensions,
   importConfig,
   isAdmin,
+  isHasMany,
   isLoggedIn,
   keyAllows,
   loadConfig,
   localStorage,
   mergeForUpdate,
   mimeAllowed,
+  mimeAllowedBy,
   parseId,
   populate,
   readCookie,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/core",
-  "version": "0.22.2",
+  "version": "0.23.0",
   "description": "Embedded, code-first headless CMS for Nuxt and Next.js",
   "license": "MIT",
   "type": "module",