payload 3.0.0-beta.6 → 3.0.0-beta.61

package/dist/uploads/types.d.ts

@@ -1,7 +1,5 @@
-/// <reference types="node" resolution-mode="require"/>
-import type express from 'express';
-import type serveStatic from 'serve-static';
 import type { ResizeOptions, Sharp } from 'sharp';
+import type { TypeWithID } from '../collections/config/types.js';
 import type { PayloadRequest } from '../types/index.js';
 export type FileSize = {
     filename: null | string;
@@ -16,6 +14,8 @@ export type FileSizes = {
 export type FileData = {
     filename: string;
     filesize: number;
+    focalX?: number;
+    focalY?: number;
     height: number;
     mimeType: string;
     sizes: FileSizes;
@@ -28,7 +28,7 @@ export type ProbedImageSize = {
     width: number;
 };
 /**
- * Params sent to the sharp toFormat() function
+ * Params sent to the sharp `toFormat()` function
  * @link https://sharp.pixelplumbing.com/api-output#toformat
  */
 export type ImageUploadFormatOptions = {
@@ -40,7 +40,7 @@ export type ImageUploadFormatOptions = {
  * @link https://sharp.pixelplumbing.com/api-resize#trim
  */
 export type ImageUploadTrimOptions = Parameters<Sharp['trim']>[0];
-export type ImageSize = Omit<ResizeOptions, 'withoutEnlargement'> & {
+export type ImageSize = {
     /**
      * @deprecated prefer position
      */
@@ -58,47 +58,137 @@ export type ImageSize = Omit<ResizeOptions, 'withoutEnlargement'> & {
      * 3. `true`: if the image is smaller than the image size, return the original image
      */
     withoutEnlargement?: ResizeOptions['withoutEnlargement'];
-};
+} & Omit<ResizeOptions, 'withoutEnlargement'>;
 export type GetAdminThumbnail = (args: {
     doc: Record<string, unknown>;
 }) => false | null | string;
 export type UploadConfig = {
+    /**
+     * The adapter name to use for uploads. Used for storage adapter telemetry.
+     * @default undefined
+     */
+    adapter?: string;
     /**
      * Represents an admin thumbnail, which can be either a React component or a string.
      * - If a string, it should be one of the image size names.
-     * - If a React component, register a function that generates the thumbnail URL using the `useAdminThumbnail` hook.
+     * - A function that generates a fully qualified URL for the thumbnail, receives the doc as the only argument.
      **/
     adminThumbnail?: GetAdminThumbnail | string;
+    /**
+     * Enables cropping of images.
+     * @default true
+     */
     crop?: boolean;
+    /**
+     * Disable the ability to save files to disk.
+     * @default false
+     */
     disableLocalStorage?: boolean;
+    /**
+     * Ability to filter/modify Request Headers when fetching a file.
+     *
+     * Useful for adding custom headers to fetch from external providers.
+     * @default undefined
+     */
+    externalFileHeaderFilter?: (headers: Record<string, string>) => Record<string, string>;
+    /**
+     * Require files to be uploaded when creating a document.
+     * @default true
+     */
     filesRequiredOnCreate?: boolean;
+    /**
+     * Enables focal point positioning for image manipulation.
+     * @default false
+     */
     focalPoint?: boolean;
-    /** Options for original upload file only. For sizes, set each formatOptions individually. */
+    /**
+     * Format options for the uploaded file. Formatting image sizes needs to be done within each formatOptions individually.
+     */
     formatOptions?: ImageUploadFormatOptions;
+    /**
+     * Custom handlers to run when a file is fetched.
+     *
+     * - If a handler returns a Response, the response will be sent to the client and no further handlers will be run.
+     * - If a handler returns null, the next handler will be run.
+     * - If no handlers return a response the file will be returned by default.
+     *
+     * @default undefined
+     */
     handlers?: ((req: PayloadRequest, args: {
+        doc: TypeWithID;
         params: {
             collection: string;
             filename: string;
         };
-    }) => Promise<Response> | Response)[];
+    }) => Promise<Response> | Promise<void> | Response | void)[];
     imageSizes?: ImageSize[];
+    /**
+     * Restrict mimeTypes in the file picker. Array of valid mime types or mimetype wildcards
+     * @example ['image/*', 'application/pdf']
+     * @default undefined
+     */
     mimeTypes?: string[];
+    /**
+     * Ability to modify the response headers fetching a file.
+     * @default undefined
+     */
+    modifyResponseHeaders?: ({ headers }: {
+        headers: Headers;
+    }) => Headers;
+    /**
+     * Sharp resize options for the original image.
+     * @link https://sharp.pixelplumbing.com/api-resize#resize
+     * @default undefined
+     */
     resizeOptions?: ResizeOptions;
+    /**
+     * The directory to serve static files from. Defaults to collection slug.
+     * @default undefined
+     */
     staticDir?: string;
-    staticOptions?: serveStatic.ServeStaticOptions<express.Response<any, Record<string, any>>>;
     trimOptions?: ImageUploadTrimOptions;
 };
-export type SanitizedUploadConfig = UploadConfig & {
+export type SanitizedUploadConfig = {
     staticDir: UploadConfig['staticDir'];
-};
+} & UploadConfig;
 export type File = {
+    /**
+     * The buffer of the file.
+     */
     data: Buffer;
+    /**
+     * The mimetype of the file.
+     */
     mimetype: string;
+    /**
+     * The name of the file.
+     */
     name: string;
+    /**
+     * The size of the file in bytes.
+     */
     size: number;
 };
 export type FileToSave = {
+    /**
+     * The buffer of the file.
+     */
     buffer: Buffer;
+    /**
+     * The path to save the file.
+     */
     path: string;
 };
+export type UploadEdits = {
+    crop?: {
+        height?: number;
+        width?: number;
+        x?: number;
+        y?: number;
+    };
+    focalPoint?: {
+        x?: number;
+        y?: number;
+    };
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/uploads/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/uploads/types.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,WAAW,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAEjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,KAAK,EAAE,IAAI,GAAG,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,SAAS,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,OAAO,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEjE,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,GAAG;IAClE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;CACzD,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,KAAK,KAAK,GAAG,IAAI,GAAG,MAAM,CAAA;AAEjG,MAAM,MAAM,YAAY,GAAG;IACzB;;;;QAII;IACJ,cAAc,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAA;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,6FAA6F;IAC7F,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,QAAQ,CAAC,EAAE,CAAC,CACV,GAAG,EAAE,cAAc,EACnB,IAAI,EAAE;QAAE,MAAM,EAAE;YAAE,UAAU,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,KACvD,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAA;IACpC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAA;IAC1F,WAAW,CAAC,EAAE,sBAAsB,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG;IACjD,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/uploads/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAEjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,KAAK,EAAE,IAAI,GAAG,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,SAAS,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,OAAO,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEjE,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;CACzD,GAAG,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAA;AAE7C,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,KAAK,KAAK,GAAG,IAAI,GAAG,MAAM,CAAA;AAEjG,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;QAII;IACJ,cAAc,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAA;IAC3C;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtF;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,CAAC,CACV,GAAG,EAAE,cAAc,EACnB,IAAI,EAAE;QACJ,GAAG,EAAE,UAAU,CAAA;QACf,MAAM,EAAE;YAAE,UAAU,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;KACjD,KACE,OAAO,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAA;IAC3D,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,CAAA;IACtE;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,sBAAsB,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;CACrC,GAAG,YAAY,CAAA;AAEhB,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,CAAC,CAAC,EAAE,MAAM,CAAA;QACV,CAAC,CAAC,EAAE,MAAM,CAAA;KACX,CAAA;IACD,UAAU,CAAC,EAAE;QACX,CAAC,CAAC,EAAE,MAAM,CAAA;QACV,CAAC,CAAC,EAAE,MAAM,CAAA;KACX,CAAA;CACF,CAAA"}

package/dist/uploads/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/uploads/types.ts"],"sourcesContent":["import type express from 'express'\nimport type serveStatic from 'serve-static'\nimport type { ResizeOptions, Sharp } from 'sharp'\n\nimport type { PayloadRequest } from '../types/index.js'\n\nexport type FileSize = {\n  filename: null | string\n  filesize: null | number\n  height: null | number\n  mimeType: null | string\n  width: null | number\n}\n\nexport type FileSizes = {\n  [size: string]: FileSize\n}\n\nexport type FileData = {\n  filename: string\n  filesize: number\n  height: number\n  mimeType: string\n  sizes: FileSizes\n  tempFilePath?: string\n  url?: string\n  width: number\n}\n\nexport type ProbedImageSize = {\n  height: number\n  width: number\n}\n\n/**\n * Params sent to the sharp toFormat() function\n * @link https://sharp.pixelplumbing.com/api-output#toformat\n */\nexport type ImageUploadFormatOptions = {\n  format: Parameters<Sharp['toFormat']>[0]\n  options?: Parameters<Sharp['toFormat']>[1]\n}\n\n/**\n * Params sent to the sharp trim() function\n * @link https://sharp.pixelplumbing.com/api-resize#trim\n */\nexport type ImageUploadTrimOptions = Parameters<Sharp['trim']>[0]\n\nexport type ImageSize = Omit<ResizeOptions, 'withoutEnlargement'> & {\n  /**\n   * @deprecated prefer position\n   */\n  crop?: string // comes from sharp package\n  formatOptions?: ImageUploadFormatOptions\n  name: string\n  trimOptions?: ImageUploadTrimOptions\n  /**\n   * When an uploaded image is smaller than the defined image size, we have 3 options:\n   *\n   * `undefined | false | true`\n   *\n   * 1. `undefined` [default]: uploading images with smaller width AND height than the image size will return null\n   * 2. `false`: always enlarge images to the image size\n   * 3. `true`: if the image is smaller than the image size, return the original image\n   */\n  withoutEnlargement?: ResizeOptions['withoutEnlargement']\n}\n\nexport type GetAdminThumbnail = (args: { doc: Record<string, unknown> }) => false | null | string\n\nexport type UploadConfig = {\n  /**\n   * Represents an admin thumbnail, which can be either a React component or a string.\n   * - If a string, it should be one of the image size names.\n   * - If a React component, register a function that generates the thumbnail URL using the `useAdminThumbnail` hook.\n   **/\n  adminThumbnail?: GetAdminThumbnail | string\n  crop?: boolean\n  disableLocalStorage?: boolean\n  filesRequiredOnCreate?: boolean\n  focalPoint?: boolean\n  /** Options for original upload file only. For sizes, set each formatOptions individually. */\n  formatOptions?: ImageUploadFormatOptions\n  handlers?: ((\n    req: PayloadRequest,\n    args: { params: { collection: string; filename: string } },\n  ) => Promise<Response> | Response)[]\n  imageSizes?: ImageSize[]\n  mimeTypes?: string[]\n  resizeOptions?: ResizeOptions\n  staticDir?: string\n  staticOptions?: serveStatic.ServeStaticOptions<express.Response<any, Record<string, any>>>\n  trimOptions?: ImageUploadTrimOptions\n}\n\nexport type SanitizedUploadConfig = UploadConfig & {\n  staticDir: UploadConfig['staticDir']\n}\n\nexport type File = {\n  data: Buffer\n  mimetype: string\n  name: string\n  size: number\n}\n\nexport type FileToSave = {\n  buffer: Buffer\n  path: string\n}\n"],"names":[],"rangeMappings":"","mappings":"AA2GA,WAGC"}
+{"version":3,"sources":["../../src/uploads/types.ts"],"sourcesContent":["import type { ResizeOptions, Sharp } from 'sharp'\n\nimport type { TypeWithID } from '../collections/config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nexport type FileSize = {\n  filename: null | string\n  filesize: null | number\n  height: null | number\n  mimeType: null | string\n  width: null | number\n}\n\nexport type FileSizes = {\n  [size: string]: FileSize\n}\n\nexport type FileData = {\n  filename: string\n  filesize: number\n  focalX?: number\n  focalY?: number\n  height: number\n  mimeType: string\n  sizes: FileSizes\n  tempFilePath?: string\n  url?: string\n  width: number\n}\n\nexport type ProbedImageSize = {\n  height: number\n  width: number\n}\n\n/**\n * Params sent to the sharp `toFormat()` function\n * @link https://sharp.pixelplumbing.com/api-output#toformat\n */\nexport type ImageUploadFormatOptions = {\n  format: Parameters<Sharp['toFormat']>[0]\n  options?: Parameters<Sharp['toFormat']>[1]\n}\n\n/**\n * Params sent to the sharp trim() function\n * @link https://sharp.pixelplumbing.com/api-resize#trim\n */\nexport type ImageUploadTrimOptions = Parameters<Sharp['trim']>[0]\n\nexport type ImageSize = {\n  /**\n   * @deprecated prefer position\n   */\n  crop?: string // comes from sharp package\n  formatOptions?: ImageUploadFormatOptions\n  name: string\n  trimOptions?: ImageUploadTrimOptions\n  /**\n   * When an uploaded image is smaller than the defined image size, we have 3 options:\n   *\n   * `undefined | false | true`\n   *\n   * 1. `undefined` [default]: uploading images with smaller width AND height than the image size will return null\n   * 2. `false`: always enlarge images to the image size\n   * 3. `true`: if the image is smaller than the image size, return the original image\n   */\n  withoutEnlargement?: ResizeOptions['withoutEnlargement']\n} & Omit<ResizeOptions, 'withoutEnlargement'>\n\nexport type GetAdminThumbnail = (args: { doc: Record<string, unknown> }) => false | null | string\n\nexport type UploadConfig = {\n  /**\n   * The adapter name to use for uploads. Used for storage adapter telemetry.\n   * @default undefined\n   */\n  adapter?: string\n  /**\n   * Represents an admin thumbnail, which can be either a React component or a string.\n   * - If a string, it should be one of the image size names.\n   * - A function that generates a fully qualified URL for the thumbnail, receives the doc as the only argument.\n   **/\n  adminThumbnail?: GetAdminThumbnail | string\n  /**\n   * Enables cropping of images.\n   * @default true\n   */\n  crop?: boolean\n  /**\n   * Disable the ability to save files to disk.\n   * @default false\n   */\n  disableLocalStorage?: boolean\n  /**\n   * Ability to filter/modify Request Headers when fetching a file.\n   *\n   * Useful for adding custom headers to fetch from external providers.\n   * @default undefined\n   */\n  externalFileHeaderFilter?: (headers: Record<string, string>) => Record<string, string>\n  /**\n   * Require files to be uploaded when creating a document.\n   * @default true\n   */\n  filesRequiredOnCreate?: boolean\n  /**\n   * Enables focal point positioning for image manipulation.\n   * @default false\n   */\n  focalPoint?: boolean\n  /**\n   * Format options for the uploaded file. Formatting image sizes needs to be done within each formatOptions individually.\n   */\n  formatOptions?: ImageUploadFormatOptions\n  /**\n   * Custom handlers to run when a file is fetched.\n   *\n   * - If a handler returns a Response, the response will be sent to the client and no further handlers will be run.\n   * - If a handler returns null, the next handler will be run.\n   * - If no handlers return a response the file will be returned by default.\n   *\n   * @default undefined\n   */\n  handlers?: ((\n    req: PayloadRequest,\n    args: {\n      doc: TypeWithID\n      params: { collection: string; filename: string }\n    },\n  ) => Promise<Response> | Promise<void> | Response | void)[]\n  imageSizes?: ImageSize[]\n  /**\n   * Restrict mimeTypes in the file picker. Array of valid mime types or mimetype wildcards\n   * @example ['image/*', 'application/pdf']\n   * @default undefined\n   */\n  mimeTypes?: string[]\n  /**\n   * Ability to modify the response headers fetching a file.\n   * @default undefined\n   */\n  modifyResponseHeaders?: ({ headers }: { headers: Headers }) => Headers\n  /**\n   * Sharp resize options for the original image.\n   * @link https://sharp.pixelplumbing.com/api-resize#resize\n   * @default undefined\n   */\n  resizeOptions?: ResizeOptions\n  /**\n   * The directory to serve static files from. Defaults to collection slug.\n   * @default undefined\n   */\n  staticDir?: string\n  trimOptions?: ImageUploadTrimOptions\n}\n\nexport type SanitizedUploadConfig = {\n  staticDir: UploadConfig['staticDir']\n} & UploadConfig\n\nexport type File = {\n  /**\n   * The buffer of the file.\n   */\n  data: Buffer\n  /**\n   * The mimetype of the file.\n   */\n  mimetype: string\n  /**\n   * The name of the file.\n   */\n  name: string\n  /**\n   * The size of the file in bytes.\n   */\n  size: number\n}\n\nexport type FileToSave = {\n  /**\n   * The buffer of the file.\n   */\n  buffer: Buffer\n  /**\n   * The path to save the file.\n   */\n  path: string\n}\n\nexport type UploadEdits = {\n  crop?: {\n    height?: number\n    width?: number\n    x?: number\n    y?: number\n  }\n  focalPoint?: {\n    x?: number\n    y?: number\n  }\n}\n"],"names":[],"mappings":"AA+LA,WAWC"}

package/dist/uploads/unlinkTempFiles.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/uploads/unlinkTempFiles.ts"],"sourcesContent":["import fs from 'fs'\nimport { promisify } from 'util'\n\nimport type { SanitizedCollectionConfig } from '../collections/config/types.js'\nimport type { SanitizedConfig } from '../config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nimport { mapAsync } from '../utilities/mapAsync.js'\n\nconst unlinkFile = promisify(fs.unlink)\n\ntype Args = {\n  collectionConfig: SanitizedCollectionConfig\n  config: SanitizedConfig\n  req: PayloadRequest\n}\n/**\n * Cleanup temp files after operation lifecycle\n */\nexport const unlinkTempFiles: (args: Args) => Promise<void> = async ({\n  collectionConfig,\n  config,\n  req,\n}) => {\n  if (config.upload?.useTempFiles && collectionConfig.upload) {\n    const { file } = req\n    const fileArray = [{ file }]\n    await mapAsync(fileArray, async ({ file }) => {\n      // Still need this check because this will not be populated if using local API\n      if (file?.tempFilePath) {\n        await unlinkFile(file.tempFilePath)\n      }\n    })\n  }\n}\n"],"names":["fs","promisify","mapAsync","unlinkFile","unlink","unlinkTempFiles","collectionConfig","config","req","upload","useTempFiles","file","fileArray","tempFilePath"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,OAAOA,QAAQ,KAAI;AACnB,SAASC,SAAS,QAAQ,OAAM;AAMhC,SAASC,QAAQ,QAAQ,2BAA0B;AAEnD,MAAMC,aAAaF,UAAUD,GAAGI,MAAM;AAOtC;;CAEC,GACD,OAAO,MAAMC,kBAAiD,OAAO,EACnEC,gBAAgB,EAChBC,MAAM,EACNC,GAAG,EACJ;IACC,IAAID,OAAOE,MAAM,EAAEC,gBAAgBJ,iBAAiBG,MAAM,EAAE;QAC1D,MAAM,EAAEE,IAAI,EAAE,GAAGH;QACjB,MAAMI,YAAY;YAAC;gBAAED;YAAK;SAAE;QAC5B,MAAMT,SAASU,WAAW,OAAO,EAAED,IAAI,EAAE;YACvC,8EAA8E;YAC9E,IAAIA,MAAME,cAAc;gBACtB,MAAMV,WAAWQ,KAAKE,YAAY;YACpC;QACF;IACF;AACF,EAAC"}
+{"version":3,"sources":["../../src/uploads/unlinkTempFiles.ts"],"sourcesContent":["import fs from 'fs'\nimport { promisify } from 'util'\n\nimport type { SanitizedCollectionConfig } from '../collections/config/types.js'\nimport type { SanitizedConfig } from '../config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nimport { mapAsync } from '../utilities/mapAsync.js'\n\nconst unlinkFile = promisify(fs.unlink)\n\ntype Args = {\n  collectionConfig: SanitizedCollectionConfig\n  config: SanitizedConfig\n  req: PayloadRequest\n}\n/**\n * Cleanup temp files after operation lifecycle\n */\nexport const unlinkTempFiles: (args: Args) => Promise<void> = async ({\n  collectionConfig,\n  config,\n  req,\n}) => {\n  if (config.upload?.useTempFiles && collectionConfig.upload) {\n    const { file } = req\n    const fileArray = [{ file }]\n    await mapAsync(fileArray, async ({ file }) => {\n      // Still need this check because this will not be populated if using local API\n      if (file?.tempFilePath) {\n        await unlinkFile(file.tempFilePath)\n      }\n    })\n  }\n}\n"],"names":["fs","promisify","mapAsync","unlinkFile","unlink","unlinkTempFiles","collectionConfig","config","req","upload","useTempFiles","file","fileArray","tempFilePath"],"mappings":"AAAA,OAAOA,QAAQ,KAAI;AACnB,SAASC,SAAS,QAAQ,OAAM;AAMhC,SAASC,QAAQ,QAAQ,2BAA0B;AAEnD,MAAMC,aAAaF,UAAUD,GAAGI,MAAM;AAOtC;;CAEC,GACD,OAAO,MAAMC,kBAAiD,OAAO,EACnEC,gBAAgB,EAChBC,MAAM,EACNC,GAAG,EACJ;IACC,IAAID,OAAOE,MAAM,EAAEC,gBAAgBJ,iBAAiBG,MAAM,EAAE;QAC1D,MAAM,EAAEE,IAAI,EAAE,GAAGH;QACjB,MAAMI,YAAY;YAAC;gBAAED;YAAK;SAAE;QAC5B,MAAMT,SAASU,WAAW,OAAO,EAAED,IAAI,EAAE;YACvC,8EAA8E;YAC9E,IAAIA,MAAME,cAAc;gBACtB,MAAMV,WAAWQ,KAAKE,YAAY;YACpC;QACF;IACF;AACF,EAAC"}

package/dist/uploads/uploadFiles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploadFiles.d.ts","sourceRoot":"","sources":["../../src/uploads/uploadFiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAK5C,eAAO,MAAM,WAAW,4BAEf,UAAU,EAAE,OACd,cAAc,KAClB,QAAQ,IAAI,CAWd,CAAA"}
+{"version":3,"file":"uploadFiles.d.ts","sourceRoot":"","sources":["../../src/uploads/uploadFiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAK5C,eAAO,MAAM,WAAW,YACb,OAAO,SACT,UAAU,EAAE,OACd,cAAc,KAClB,OAAO,CAAC,IAAI,CAWd,CAAA"}

package/dist/uploads/uploadFiles.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/uploads/uploadFiles.ts"],"sourcesContent":["import type { Payload } from '../index.js'\nimport type { PayloadRequest } from '../types/index.js'\nimport type { FileToSave } from './types.js'\n\nimport { FileUploadError } from '../errors/index.js'\nimport saveBufferToFile from './saveBufferToFile.js'\n\nexport const uploadFiles = async (\n  payload: Payload,\n  files: FileToSave[],\n  req: PayloadRequest,\n): Promise<void> => {\n  try {\n    await Promise.all(\n      files.map(async ({ buffer, path }) => {\n        await saveBufferToFile(buffer, path)\n      }),\n    )\n  } catch (err) {\n    payload.logger.error(err)\n    throw new FileUploadError(req.t)\n  }\n}\n"],"names":["FileUploadError","saveBufferToFile","uploadFiles","payload","files","req","Promise","all","map","buffer","path","err","logger","error","t"],"rangeMappings":";;;;;;;;;;;","mappings":"AAIA,SAASA,eAAe,QAAQ,qBAAoB;AACpD,OAAOC,sBAAsB,wBAAuB;AAEpD,OAAO,MAAMC,cAAc,OACzBC,SACAC,OACAC;IAEA,IAAI;QACF,MAAMC,QAAQC,GAAG,CACfH,MAAMI,GAAG,CAAC,OAAO,EAAEC,MAAM,EAAEC,IAAI,EAAE;YAC/B,MAAMT,iBAAiBQ,QAAQC;QACjC;IAEJ,EAAE,OAAOC,KAAK;QACZR,QAAQS,MAAM,CAACC,KAAK,CAACF;QACrB,MAAM,IAAIX,gBAAgBK,IAAIS,CAAC;IACjC;AACF,EAAC"}
+{"version":3,"sources":["../../src/uploads/uploadFiles.ts"],"sourcesContent":["import type { Payload } from '../index.js'\nimport type { PayloadRequest } from '../types/index.js'\nimport type { FileToSave } from './types.js'\n\nimport { FileUploadError } from '../errors/index.js'\nimport saveBufferToFile from './saveBufferToFile.js'\n\nexport const uploadFiles = async (\n  payload: Payload,\n  files: FileToSave[],\n  req: PayloadRequest,\n): Promise<void> => {\n  try {\n    await Promise.all(\n      files.map(async ({ buffer, path }) => {\n        await saveBufferToFile(buffer, path)\n      }),\n    )\n  } catch (err) {\n    payload.logger.error(err)\n    throw new FileUploadError(req.t)\n  }\n}\n"],"names":["FileUploadError","saveBufferToFile","uploadFiles","payload","files","req","Promise","all","map","buffer","path","err","logger","error","t"],"mappings":"AAIA,SAASA,eAAe,QAAQ,qBAAoB;AACpD,OAAOC,sBAAsB,wBAAuB;AAEpD,OAAO,MAAMC,cAAc,OACzBC,SACAC,OACAC;IAEA,IAAI;QACF,MAAMC,QAAQC,GAAG,CACfH,MAAMI,GAAG,CAAC,OAAO,EAAEC,MAAM,EAAEC,IAAI,EAAE;YAC/B,MAAMT,iBAAiBQ,QAAQC;QACjC;IAEJ,EAAE,OAAOC,KAAK;QACZR,QAAQS,MAAM,CAACC,KAAK,CAACF;QACrB,MAAM,IAAIX,gBAAgBK,IAAIS,CAAC;IACjC;AACF,EAAC"}

package/dist/utilities/checkDuplicateCollections.js

@@ -1,4 +1,4 @@
-import DuplicateCollection from '../errors/DuplicateCollection.js';
+import { DuplicateCollection } from '../errors/DuplicateCollection.js';
 const getDuplicates = (arr)=>arr.filter((item, index)=>arr.indexOf(item) !== index);
 const checkDuplicateCollections = (collections)=>{
     const duplicateSlugs = getDuplicates(collections.map((c)=>c.slug));

package/dist/utilities/checkDuplicateCollections.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/checkDuplicateCollections.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../collections/config/types.js'\n\nimport DuplicateCollection from '../errors/DuplicateCollection.js'\n\nconst getDuplicates = (arr: string[]) => arr.filter((item, index) => arr.indexOf(item) !== index)\n\nconst checkDuplicateCollections = (collections: SanitizedCollectionConfig[]): void => {\n  const duplicateSlugs = getDuplicates(collections.map((c) => c.slug))\n  if (duplicateSlugs.length > 0) {\n    throw new DuplicateCollection('slug', duplicateSlugs)\n  }\n}\n\nexport default checkDuplicateCollections\n"],"names":["DuplicateCollection","getDuplicates","arr","filter","item","index","indexOf","checkDuplicateCollections","collections","duplicateSlugs","map","c","slug","length"],"rangeMappings":";;;;;;;;","mappings":"AAEA,OAAOA,yBAAyB,mCAAkC;AAElE,MAAMC,gBAAgB,CAACC,MAAkBA,IAAIC,MAAM,CAAC,CAACC,MAAMC,QAAUH,IAAII,OAAO,CAACF,UAAUC;AAE3F,MAAME,4BAA4B,CAACC;IACjC,MAAMC,iBAAiBR,cAAcO,YAAYE,GAAG,CAAC,CAACC,IAAMA,EAAEC,IAAI;IAClE,IAAIH,eAAeI,MAAM,GAAG,GAAG;QAC7B,MAAM,IAAIb,oBAAoB,QAAQS;IACxC;AACF;AAEA,eAAeF,0BAAyB"}
+{"version":3,"sources":["../../src/utilities/checkDuplicateCollections.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../collections/config/types.js'\n\nimport { DuplicateCollection } from '../errors/DuplicateCollection.js'\n\nconst getDuplicates = (arr: string[]) => arr.filter((item, index) => arr.indexOf(item) !== index)\n\nconst checkDuplicateCollections = (collections: SanitizedCollectionConfig[]): void => {\n  const duplicateSlugs = getDuplicates(collections.map((c) => c.slug))\n  if (duplicateSlugs.length > 0) {\n    throw new DuplicateCollection('slug', duplicateSlugs)\n  }\n}\n\nexport default checkDuplicateCollections\n"],"names":["DuplicateCollection","getDuplicates","arr","filter","item","index","indexOf","checkDuplicateCollections","collections","duplicateSlugs","map","c","slug","length"],"mappings":"AAEA,SAASA,mBAAmB,QAAQ,mCAAkC;AAEtE,MAAMC,gBAAgB,CAACC,MAAkBA,IAAIC,MAAM,CAAC,CAACC,MAAMC,QAAUH,IAAII,OAAO,CAACF,UAAUC;AAE3F,MAAME,4BAA4B,CAACC;IACjC,MAAMC,iBAAiBR,cAAcO,YAAYE,GAAG,CAAC,CAACC,IAAMA,EAAEC,IAAI;IAClE,IAAIH,eAAeI,MAAM,GAAG,GAAG;QAC7B,MAAM,IAAIb,oBAAoB,QAAQS;IACxC;AACF;AAEA,eAAeF,0BAAyB"}

package/dist/utilities/combineMerge.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/combineMerge.ts"],"sourcesContent":["import merge from 'deepmerge'\n\nexport const combineMerge = (target, source, options) => {\n  const destination = target.slice()\n\n  source.forEach((item, index) => {\n    if (typeof destination[index] === 'undefined') {\n      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options)\n    } else if (options.isMergeableObject(item)) {\n      destination[index] = merge(target[index], item, options)\n    } else if (target.indexOf(item) === -1) {\n      destination.push(item)\n    }\n  })\n  return destination\n}\n"],"names":["merge","combineMerge","target","source","options","destination","slice","forEach","item","index","cloneUnlessOtherwiseSpecified","isMergeableObject","indexOf","push"],"rangeMappings":";;;;;;;;;;;;;","mappings":"AAAA,OAAOA,WAAW,YAAW;AAE7B,OAAO,MAAMC,eAAe,CAACC,QAAQC,QAAQC;IAC3C,MAAMC,cAAcH,OAAOI,KAAK;IAEhCH,OAAOI,OAAO,CAAC,CAACC,MAAMC;QACpB,IAAI,OAAOJ,WAAW,CAACI,MAAM,KAAK,aAAa;YAC7CJ,WAAW,CAACI,MAAM,GAAGL,QAAQM,6BAA6B,CAACF,MAAMJ;QACnE,OAAO,IAAIA,QAAQO,iBAAiB,CAACH,OAAO;YAC1CH,WAAW,CAACI,MAAM,GAAGT,MAAME,MAAM,CAACO,MAAM,EAAED,MAAMJ;QAClD,OAAO,IAAIF,OAAOU,OAAO,CAACJ,UAAU,CAAC,GAAG;YACtCH,YAAYQ,IAAI,CAACL;QACnB;IACF;IACA,OAAOH;AACT,EAAC"}
+{"version":3,"sources":["../../src/utilities/combineMerge.ts"],"sourcesContent":["import merge from 'deepmerge'\n\nexport const combineMerge = (target, source, options) => {\n  const destination = target.slice()\n\n  source.forEach((item, index) => {\n    if (typeof destination[index] === 'undefined') {\n      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options)\n    } else if (options.isMergeableObject(item)) {\n      destination[index] = merge(target[index], item, options)\n    } else if (target.indexOf(item) === -1) {\n      destination.push(item)\n    }\n  })\n  return destination\n}\n"],"names":["merge","combineMerge","target","source","options","destination","slice","forEach","item","index","cloneUnlessOtherwiseSpecified","isMergeableObject","indexOf","push"],"mappings":"AAAA,OAAOA,WAAW,YAAW;AAE7B,OAAO,MAAMC,eAAe,CAACC,QAAQC,QAAQC;IAC3C,MAAMC,cAAcH,OAAOI,KAAK;IAEhCH,OAAOI,OAAO,CAAC,CAACC,MAAMC;QACpB,IAAI,OAAOJ,WAAW,CAACI,MAAM,KAAK,aAAa;YAC7CJ,WAAW,CAACI,MAAM,GAAGL,QAAQM,6BAA6B,CAACF,MAAMJ;QACnE,OAAO,IAAIA,QAAQO,iBAAiB,CAACH,OAAO;YAC1CH,WAAW,CAACI,MAAM,GAAGT,MAAME,MAAM,CAACO,MAAM,EAAED,MAAMJ;QAClD,OAAO,IAAIF,OAAOU,OAAO,CAACJ,UAAU,CAAC,GAAG;YACtCH,YAAYQ,IAAI,CAACL;QACnB;IACF;IACA,OAAOH;AACT,EAAC"}

package/dist/utilities/commitTransaction.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/commitTransaction.ts"],"sourcesContent":["import type { PayloadRequest } from '../types/index.js'\n\n/**\n * complete a transaction calling adapter db.commitTransaction and delete the transactionID from req\n */\nexport async function commitTransaction(req: PayloadRequest): Promise<void> {\n  const { payload, transactionID } = req\n\n  await payload.db.commitTransaction(transactionID)\n  delete req.transactionID\n}\n"],"names":["commitTransaction","req","payload","transactionID","db"],"rangeMappings":";;;;;;","mappings":"AAEA;;CAEC,GACD,OAAO,eAAeA,kBAAkBC,GAAmB;IACzD,MAAM,EAAEC,OAAO,EAAEC,aAAa,EAAE,GAAGF;IAEnC,MAAMC,QAAQE,EAAE,CAACJ,iBAAiB,CAACG;IACnC,OAAOF,IAAIE,aAAa;AAC1B"}
+{"version":3,"sources":["../../src/utilities/commitTransaction.ts"],"sourcesContent":["import type { PayloadRequest } from '../types/index.js'\n\n/**\n * complete a transaction calling adapter db.commitTransaction and delete the transactionID from req\n */\nexport async function commitTransaction(req: PayloadRequest): Promise<void> {\n  const { payload, transactionID } = req\n\n  await payload.db.commitTransaction(transactionID)\n  delete req.transactionID\n}\n"],"names":["commitTransaction","req","payload","transactionID","db"],"mappings":"AAEA;;CAEC,GACD,OAAO,eAAeA,kBAAkBC,GAAmB;IACzD,MAAM,EAAEC,OAAO,EAAEC,aAAa,EAAE,GAAGF;IAEnC,MAAMC,QAAQE,EAAE,CAACJ,iBAAiB,CAACG;IACnC,OAAOF,IAAIE,aAAa;AAC1B"}

package/dist/utilities/configToJSONSchema.d.ts

@@ -26,6 +26,7 @@ interfaceNameDefinitions: Map<string, JSONSchema4>, config?: SanitizedConfig): {
     required: string[];
 };
 export declare function entityToJSONSchema(config: SanitizedConfig, incomingEntity: SanitizedCollectionConfig | SanitizedGlobalConfig, interfaceNameDefinitions: Map<string, JSONSchema4>, defaultIDType: 'number' | 'text'): JSONSchema4;
+export declare function authCollectionToOperationsJSONSchema(config: SanitizedCollectionConfig): JSONSchema4;
 /**
  * This is used for generating the TypeScript types (payload-types.ts) with the payload generate:types command.
  */

package/dist/utilities/configToJSONSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"configToJSONSchema.d.ts","sourceRoot":"","sources":["../../src/utilities/configToJSONSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAKnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,KAAK,EAAE,KAAK,EAA8B,MAAM,2BAA2B,CAAA;AAClF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAqFvE;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,mBAAmB,EAC9B,UAAU,EAAE,OAAO,GAClB,mBAAmB,GAAG,mBAAmB,EAAE,CAK7C;AAED,wBAAgB,kBAAkB;AAChC;;;;GAIG;AACH,sBAAsB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAAE,EAC9D,MAAM,EAAE,KAAK,EAAE;AACf;;GAEG;AACH,wBAAwB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAClD,MAAM,CAAC,EAAE,eAAe,GACvB;IACD,UAAU,EAAE;QACV,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KACzB,CAAA;IACD,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB,CAmXA;AAGD,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,eAAe,EACvB,cAAc,EAAE,yBAAyB,GAAG,qBAAqB,EACjE,wBAAwB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAClD,aAAa,EAAE,QAAQ,GAAG,MAAM,GAC/B,WAAW,CA8Cb;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,eAAe,EACvB,aAAa,CAAC,EAAE,QAAQ,GAAG,MAAM,GAChC,WAAW,CA2Bb"}
+{"version":3,"file":"configToJSONSchema.d.ts","sourceRoot":"","sources":["../../src/utilities/configToJSONSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAKnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,KAAK,EAAE,KAAK,EAA8B,MAAM,2BAA2B,CAAA;AAClF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAyGvE;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,mBAAmB,EAC9B,UAAU,EAAE,OAAO,GAClB,mBAAmB,GAAG,mBAAmB,EAAE,CAK7C;AAED,wBAAgB,kBAAkB;AAChC;;;;GAIG;AACH,sBAAsB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAAE,EAC9D,MAAM,EAAE,KAAK,EAAE;AACf;;GAEG;AACH,wBAAwB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAClD,MAAM,CAAC,EAAE,eAAe,GACvB;IACD,UAAU,EAAE;QACV,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KACzB,CAAA;IACD,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB,CAsYA;AAGD,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,eAAe,EACvB,cAAc,EAAE,yBAAyB,GAAG,qBAAqB,EACjE,wBAAwB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAClD,aAAa,EAAE,QAAQ,GAAG,MAAM,GAC/B,WAAW,CA8Cb;AA2CD,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,yBAAyB,GAChC,WAAW,CAoBb;AAoBD;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,eAAe,EACvB,aAAa,CAAC,EAAE,QAAQ,GAAG,MAAM,GAChC,WAAW,CAmDb"}

package/dist/utilities/configToJSONSchema.js

@@ -1,5 +1,6 @@
 import pluralize from 'pluralize';
 const { singular } = pluralize;
+import { MissingEditorProp } from '../errors/MissingEditorProp.js';
 import { fieldAffectsData, tabHasName } from '../fields/config/types.js';
 import { deepCopyObject } from './deepCopyObject.js';
 import { toWords } from './formatLabels.js';
@@ -48,6 +49,23 @@ function generateEntitySchemas(entities) {
         required: Object.keys(properties)
     };
 }
+function generateLocaleEntitySchemas(localization) {
+    if (localization && 'locales' in localization && localization?.locales) {
+        const localesFromConfig = localization?.locales;
+        const locales = [
+            ...localesFromConfig
+        ].map((locale)=>{
+            return locale.code;
+        }, []);
+        return {
+            type: 'string',
+            enum: locales
+        };
+    }
+    return {
+        type: 'null'
+    };
+}
 function generateAuthEntitySchemas(entities) {
     const properties = [
         ...entities
@@ -152,7 +170,7 @@ export function fieldsToJSONSchema(/**
                     }
                 case 'json':
                     {
-                        fieldSchema = {
+                        fieldSchema = field.jsonSchema?.schema || {
                             type: [
                                 'object',
                                 'array',
@@ -166,6 +184,13 @@ export function fieldsToJSONSchema(/**
                     }
                 case 'richText':
                     {
+                        if (!field?.editor) {
+                            throw new MissingEditorProp(field) // while we allow disabling editor functionality, you should not have any richText fields defined if you do not have an editor
+                            ;
+                        }
+                        if (typeof field.editor === 'function') {
+                            throw new Error('Attempted to access unsanitized rich text editor.');
+                        }
                         if (field.editor.outputSchema) {
                             fieldSchema = field.editor.outputSchema({
                                 collectionIDFieldTypes,
@@ -411,7 +436,11 @@ export function fieldsToJSONSchema(/**
                                     additionalProperties: false,
                                     ...childSchema
                                 });
-                                requiredFieldNames.add(tab.name);
+                                // If the named tab has any required fields then we mark this as required otherwise it should be optional
+                                const hasRequiredFields = tab.fields.some((subField)=>fieldIsRequired(subField));
+                                if (hasRequiredFields) {
+                                    requiredFieldNames.add(tab.name);
+                                }
                             } else {
                                 Object.entries(childSchema.properties).forEach(([propName, propSchema])=>{
                                     fieldSchemas.set(propName, propSchema);
@@ -443,6 +472,13 @@ export function fieldsToJSONSchema(/**
                         break;
                     }
             }
+            if ('typescriptSchema' in field && field?.typescriptSchema?.length) {
+                for (const schema of field.typescriptSchema){
+                    fieldSchema = schema({
+                        jsonSchema: fieldSchema
+                    });
+                }
+            }
             if (fieldSchema && fieldAffectsData(field)) {
                 fieldSchemas.set(field.name, fieldSchema);
             }
@@ -496,6 +532,80 @@ export function entityToJSONSchema(config, incomingEntity, interfaceNameDefiniti
         ...fieldsToJSONSchema(collectionIDFieldTypes, entity.fields, interfaceNameDefinitions, config)
     };
 }
+function generateOperationJSONSchema(config, operation) {
+    const usernameLogin = config.auth?.loginWithUsername;
+    const fieldType = {
+        type: 'string'
+    };
+    let properties = {};
+    switch(operation){
+        case 'login':
+            {
+                properties = {
+                    password: fieldType,
+                    [usernameLogin ? 'username' : 'email']: fieldType
+                };
+                break;
+            }
+        case 'forgotPassword':
+            {
+                properties = {
+                    [usernameLogin ? 'username' : 'email']: fieldType
+                };
+                break;
+            }
+        case 'registerFirstUser':
+            {
+                properties = {
+                    email: fieldType,
+                    password: fieldType
+                };
+                if (usernameLogin) properties.username = fieldType;
+                break;
+            }
+    }
+    return {
+        additionalProperties: false,
+        properties,
+        required: Object.keys(properties)
+    };
+}
+export function authCollectionToOperationsJSONSchema(config) {
+    const properties = {
+        forgotPassword: {
+            ...generateOperationJSONSchema(config, 'forgotPassword')
+        },
+        login: {
+            ...generateOperationJSONSchema(config, 'login')
+        },
+        registerFirstUser: {
+            ...generateOperationJSONSchema(config, 'registerFirstUser')
+        }
+    };
+    return {
+        type: 'object',
+        additionalProperties: false,
+        properties,
+        required: Object.keys(properties),
+        title: `${singular(toWords(`${config.slug}`, true))}AuthOperations`
+    };
+}
+function generateAuthOperationSchemas(collections) {
+    const properties = collections.reduce((acc, collection)=>{
+        if (collection.auth) {
+            acc[collection.slug] = {
+                $ref: `#/definitions/auth/${collection.slug}`
+            };
+        }
+        return acc;
+    }, {});
+    return {
+        type: 'object',
+        additionalProperties: false,
+        properties,
+        required: Object.keys(properties)
+    };
+}
 /**
  * This is used for generating the TypeScript types (payload-types.ts) with the payload generate:types command.
  */ export function configToJSONSchema(config, defaultIDType) {
@@ -510,26 +620,47 @@ export function entityToJSONSchema(config, incomingEntity, interfaceNameDefiniti
         acc[entity.slug] = entityToJSONSchema(config, entity, interfaceNameDefinitions, defaultIDType);
         return acc;
     }, {});
-    return {
+    const authOperationDefinitions = [
+        ...config.collections
+    ].filter(({ auth })=>Boolean(auth)).reduce((acc, authCollection)=>{
+        acc.auth[authCollection.slug] = authCollectionToOperationsJSONSchema(authCollection);
+        return acc;
+    }, {
+        auth: {}
+    });
+    let jsonSchema = {
         additionalProperties: false,
         definitions: {
             ...entityDefinitions,
-            ...Object.fromEntries(interfaceNameDefinitions)
+            ...Object.fromEntries(interfaceNameDefinitions),
+            ...authOperationDefinitions
         },
         // These properties here will be very simple, as all the complexity is in the definitions. These are just the properties for the top-level `Config` type
         type: 'object',
         properties: {
+            auth: generateAuthOperationSchemas(config.collections),
             collections: generateEntitySchemas(config.collections || []),
             globals: generateEntitySchemas(config.globals || []),
+            locale: generateLocaleEntitySchemas(config.localization),
             user: generateAuthEntitySchemas(config.collections)
         },
         required: [
             'user',
+            'locale',
             'collections',
-            'globals'
+            'globals',
+            'auth'
         ],
         title: 'Config'
     };
+    if (config?.typescript?.schema?.length) {
+        for (const schema of config.typescript.schema){
+            jsonSchema = schema({
+                jsonSchema
+            });
+        }
+    }
+    return jsonSchema;
 }
 
 //# sourceMappingURL=configToJSONSchema.js.map