payload 3.0.0-beta.5 → 3.0.0-beta.51

package/dist/fields/hooks/afterChange/traverseFields.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/fields/hooks/afterChange/traverseFields.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../../../collections/config/types.js'\nimport type { SanitizedGlobalConfig } from '../../../globals/config/types.js'\nimport type { PayloadRequest, RequestContext } from '../../../types/index.js'\nimport type { Field, TabAsField } from '../../config/types.js'\n\nimport { promise } from './promise.js'\n\ntype Args = {\n  collection: SanitizedCollectionConfig | null\n  context: RequestContext\n  data: Record<string, unknown>\n  doc: Record<string, unknown>\n  fields: (Field | TabAsField)[]\n  global: SanitizedGlobalConfig | null\n  operation: 'create' | 'update'\n  previousDoc: Record<string, unknown>\n  previousSiblingDoc: Record<string, unknown>\n  req: PayloadRequest\n  siblingData: Record<string, unknown>\n  siblingDoc: Record<string, unknown>\n}\n\nexport const traverseFields = async ({\n  collection,\n  context,\n  data,\n  doc,\n  fields,\n  global,\n  operation,\n  previousDoc,\n  previousSiblingDoc,\n  req,\n  siblingData,\n  siblingDoc,\n}: Args): Promise<void> => {\n  const promises = []\n\n  fields.forEach((field) => {\n    promises.push(\n      promise({\n        collection,\n        context,\n        data,\n        doc,\n        field,\n        global,\n        operation,\n        previousDoc,\n        previousSiblingDoc,\n        req,\n        siblingData,\n        siblingDoc,\n      }),\n    )\n  })\n\n  await Promise.all(promises)\n}\n"],"names":["promise","traverseFields","collection","context","data","doc","fields","global","operation","previousDoc","previousSiblingDoc","req","siblingData","siblingDoc","promises","forEach","field","push","Promise","all"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;","mappings":"AAKA,SAASA,OAAO,QAAQ,eAAc;AAiBtC,OAAO,MAAMC,iBAAiB,OAAO,EACnCC,UAAU,EACVC,OAAO,EACPC,IAAI,EACJC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,SAAS,EACTC,WAAW,EACXC,kBAAkB,EAClBC,GAAG,EACHC,WAAW,EACXC,UAAU,EACL;IACL,MAAMC,WAAW,EAAE;IAEnBR,OAAOS,OAAO,CAAC,CAACC;QACdF,SAASG,IAAI,CACXjB,QAAQ;YACNE;YACAC;YACAC;YACAC;YACAW;YACAT;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;QACF;IAEJ;IAEA,MAAMK,QAAQC,GAAG,CAACL;AACpB,EAAC"}
+{"version":3,"sources":["../../../../src/fields/hooks/afterChange/traverseFields.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../../../collections/config/types.js'\nimport type { SanitizedGlobalConfig } from '../../../globals/config/types.js'\nimport type { PayloadRequestWithData, RequestContext } from '../../../types/index.js'\nimport type { Field, TabAsField } from '../../config/types.js'\n\nimport { promise } from './promise.js'\n\ntype Args = {\n  collection: SanitizedCollectionConfig | null\n  context: RequestContext\n  data: Record<string, unknown>\n  doc: Record<string, unknown>\n  fields: (Field | TabAsField)[]\n  global: SanitizedGlobalConfig | null\n  operation: 'create' | 'update'\n  path: (number | string)[]\n  previousDoc: Record<string, unknown>\n  previousSiblingDoc: Record<string, unknown>\n  req: PayloadRequestWithData\n  schemaPath: string[]\n  siblingData: Record<string, unknown>\n  siblingDoc: Record<string, unknown>\n}\n\nexport const traverseFields = async ({\n  collection,\n  context,\n  data,\n  doc,\n  fields,\n  global,\n  operation,\n  path,\n  previousDoc,\n  previousSiblingDoc,\n  req,\n  schemaPath,\n  siblingData,\n  siblingDoc,\n}: Args): Promise<void> => {\n  const promises = []\n\n  fields.forEach((field) => {\n    promises.push(\n      promise({\n        collection,\n        context,\n        data,\n        doc,\n        field,\n        global,\n        operation,\n        parentPath: path,\n        parentSchemaPath: schemaPath,\n        previousDoc,\n        previousSiblingDoc,\n        req,\n        siblingData,\n        siblingDoc,\n      }),\n    )\n  })\n\n  await Promise.all(promises)\n}\n"],"names":["promise","traverseFields","collection","context","data","doc","fields","global","operation","path","previousDoc","previousSiblingDoc","req","schemaPath","siblingData","siblingDoc","promises","forEach","field","push","parentPath","parentSchemaPath","Promise","all"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;","mappings":"AAKA,SAASA,OAAO,QAAQ,eAAc;AAmBtC,OAAO,MAAMC,iBAAiB,OAAO,EACnCC,UAAU,EACVC,OAAO,EACPC,IAAI,EACJC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,SAAS,EACTC,IAAI,EACJC,WAAW,EACXC,kBAAkB,EAClBC,GAAG,EACHC,UAAU,EACVC,WAAW,EACXC,UAAU,EACL;IACL,MAAMC,WAAW,EAAE;IAEnBV,OAAOW,OAAO,CAAC,CAACC;QACdF,SAASG,IAAI,CACXnB,QAAQ;YACNE;YACAC;YACAC;YACAC;YACAa;YACAX;YACAC;YACAY,YAAYX;YACZY,kBAAkBR;YAClBH;YACAC;YACAC;YACAE;YACAC;QACF;IAEJ;IAEA,MAAMO,QAAQC,GAAG,CAACP;AACpB,EAAC"}

package/dist/fields/hooks/afterRead/index.d.ts

@@ -1,25 +1,26 @@
 import type { SanitizedCollectionConfig } from '../../../collections/config/types.js';
 import type { SanitizedGlobalConfig } from '../../../globals/config/types.js';
-import type { PayloadRequest, RequestContext } from '../../../types/index.js';
+import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js';
 type Args = {
     collection: SanitizedCollectionConfig | null;
     context: RequestContext;
     currentDepth?: number;
     depth: number;
     doc: Record<string, unknown>;
+    draft: boolean;
     fallbackLocale: null | string;
     findMany?: boolean;
     flattenLocales?: boolean;
     global: SanitizedGlobalConfig | null;
     locale: string;
     overrideAccess: boolean;
-    req: PayloadRequest;
+    req: PayloadRequestWithData;
     showHiddenFields: boolean;
 };
 /**
  * This function is responsible for the following actions, in order:
  * - Remove hidden fields from response
- * - Flatten locales into requested locale
+ * - Flatten locales into requested locale. If the input doc contains all locales, the output doc after this function will only contain the requested locale.
  * - Sanitize outgoing data (point field, etc.)
  * - Execute field hooks
  * - Execute read access control

package/dist/fields/hooks/afterRead/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/fields/hooks/afterRead/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAK7E,KAAK,IAAI,GAAG;IACV,UAAU,EAAE,yBAAyB,GAAG,IAAI,CAAA;IAC5C,OAAO,EAAE,cAAc,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5B,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,OAAO,CAAA;IACvB,GAAG,EAAE,cAAc,CAAA;IACnB,gBAAgB,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED;;;;;;;;GAQG;AAEH,wBAAsB,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAqD/D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/fields/hooks/afterRead/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AAC7E,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAKrF,KAAK,IAAI,GAAG;IACV,UAAU,EAAE,yBAAyB,GAAG,IAAI,CAAA;IAC5C,OAAO,EAAE,cAAc,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5B,KAAK,EAAE,OAAO,CAAA;IACd,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,OAAO,CAAA;IACvB,GAAG,EAAE,sBAAsB,CAAA;IAC3B,gBAAgB,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED;;;;;;;;GAQG;AAEH,wBAAsB,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAyD/D"}

package/dist/fields/hooks/afterRead/index.js

@@ -3,13 +3,13 @@ import { traverseFields } from './traverseFields.js';
 /**
  * This function is responsible for the following actions, in order:
  * - Remove hidden fields from response
- * - Flatten locales into requested locale
+ * - Flatten locales into requested locale. If the input doc contains all locales, the output doc after this function will only contain the requested locale.
  * - Sanitize outgoing data (point field, etc.)
  * - Execute field hooks
  * - Execute read access control
  * - Populate relationships
  */ export async function afterRead(args) {
-    const { collection, context, currentDepth: incomingCurrentDepth, depth: incomingDepth, doc: incomingDoc, fallbackLocale, findMany, flattenLocales = true, global, locale, overrideAccess, req, showHiddenFields } = args;
+    const { collection, context, currentDepth: incomingCurrentDepth, depth: incomingDepth, doc: incomingDoc, draft, fallbackLocale, findMany, flattenLocales = true, global, locale, overrideAccess, req, showHiddenFields } = args;
     const doc = deepCopyObject(incomingDoc);
     const fieldPromises = [];
     const populationPromises = [];
@@ -22,6 +22,7 @@ import { traverseFields } from './traverseFields.js';
         currentDepth,
         depth,
         doc,
+        draft,
         fallbackLocale,
         fieldPromises,
         fields: collection?.fields || global?.fields,
@@ -30,8 +31,10 @@ import { traverseFields } from './traverseFields.js';
         global,
         locale,
         overrideAccess,
+        path: [],
         populationPromises,
         req,
+        schemaPath: [],
         showHiddenFields,
         siblingDoc: doc
     });

package/dist/fields/hooks/afterRead/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/fields/hooks/afterRead/index.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../../../collections/config/types.js'\nimport type { SanitizedGlobalConfig } from '../../../globals/config/types.js'\nimport type { PayloadRequest, RequestContext } from '../../../types/index.js'\n\nimport { deepCopyObject } from '../../../utilities/deepCopyObject.js'\nimport { traverseFields } from './traverseFields.js'\n\ntype Args = {\n  collection: SanitizedCollectionConfig | null\n  context: RequestContext\n  currentDepth?: number\n  depth: number\n  doc: Record<string, unknown>\n  fallbackLocale: null | string\n  findMany?: boolean\n  flattenLocales?: boolean\n  global: SanitizedGlobalConfig | null\n  locale: string\n  overrideAccess: boolean\n  req: PayloadRequest\n  showHiddenFields: boolean\n}\n\n/**\n * This function is responsible for the following actions, in order:\n * - Remove hidden fields from response\n * - Flatten locales into requested locale\n * - Sanitize outgoing data (point field, etc.)\n * - Execute field hooks\n * - Execute read access control\n * - Populate relationships\n */\n\nexport async function afterRead<T = any>(args: Args): Promise<T> {\n  const {\n    collection,\n    context,\n    currentDepth: incomingCurrentDepth,\n    depth: incomingDepth,\n    doc: incomingDoc,\n    fallbackLocale,\n    findMany,\n    flattenLocales = true,\n    global,\n    locale,\n    overrideAccess,\n    req,\n    showHiddenFields,\n  } = args\n\n  const doc = deepCopyObject(incomingDoc)\n  const fieldPromises = []\n  const populationPromises = []\n\n  let depth =\n    incomingDepth || incomingDepth === 0\n      ? parseInt(String(incomingDepth), 10)\n      : req.payload.config.defaultDepth\n  if (depth > req.payload.config.maxDepth) depth = req.payload.config.maxDepth\n\n  const currentDepth = incomingCurrentDepth || 1\n\n  traverseFields({\n    collection,\n    context,\n    currentDepth,\n    depth,\n    doc,\n    fallbackLocale,\n    fieldPromises,\n    fields: collection?.fields || global?.fields,\n    findMany,\n    flattenLocales,\n    global,\n    locale,\n    overrideAccess,\n    populationPromises,\n    req,\n    showHiddenFields,\n    siblingDoc: doc,\n  })\n\n  await Promise.all(fieldPromises)\n  await Promise.all(populationPromises)\n\n  return doc\n}\n"],"names":["deepCopyObject","traverseFields","afterRead","args","collection","context","currentDepth","incomingCurrentDepth","depth","incomingDepth","doc","incomingDoc","fallbackLocale","findMany","flattenLocales","global","locale","overrideAccess","req","showHiddenFields","fieldPromises","populationPromises","parseInt","String","payload","config","defaultDepth","maxDepth","fields","siblingDoc","Promise","all"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAIA,SAASA,cAAc,QAAQ,uCAAsC;AACrE,SAASC,cAAc,QAAQ,sBAAqB;AAkBpD;;;;;;;;CAQC,GAED,OAAO,eAAeC,UAAmBC,IAAU;IACjD,MAAM,EACJC,UAAU,EACVC,OAAO,EACPC,cAAcC,oBAAoB,EAClCC,OAAOC,aAAa,EACpBC,KAAKC,WAAW,EAChBC,cAAc,EACdC,QAAQ,EACRC,iBAAiB,IAAI,EACrBC,MAAM,EACNC,MAAM,EACNC,cAAc,EACdC,GAAG,EACHC,gBAAgB,EACjB,GAAGhB;IAEJ,MAAMO,MAAMV,eAAeW;IAC3B,MAAMS,gBAAgB,EAAE;IACxB,MAAMC,qBAAqB,EAAE;IAE7B,IAAIb,QACFC,iBAAiBA,kBAAkB,IAC/Ba,SAASC,OAAOd,gBAAgB,MAChCS,IAAIM,OAAO,CAACC,MAAM,CAACC,YAAY;IACrC,IAAIlB,QAAQU,IAAIM,OAAO,CAACC,MAAM,CAACE,QAAQ,EAAEnB,QAAQU,IAAIM,OAAO,CAACC,MAAM,CAACE,QAAQ;IAE5E,MAAMrB,eAAeC,wBAAwB;IAE7CN,eAAe;QACbG;QACAC;QACAC;QACAE;QACAE;QACAE;QACAQ;QACAQ,QAAQxB,YAAYwB,UAAUb,QAAQa;QACtCf;QACAC;QACAC;QACAC;QACAC;QACAI;QACAH;QACAC;QACAU,YAAYnB;IACd;IAEA,MAAMoB,QAAQC,GAAG,CAACX;IAClB,MAAMU,QAAQC,GAAG,CAACV;IAElB,OAAOX;AACT"}
+{"version":3,"sources":["../../../../src/fields/hooks/afterRead/index.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../../../collections/config/types.js'\nimport type { SanitizedGlobalConfig } from '../../../globals/config/types.js'\nimport type { PayloadRequestWithData, RequestContext } from '../../../types/index.js'\n\nimport { deepCopyObject } from '../../../utilities/deepCopyObject.js'\nimport { traverseFields } from './traverseFields.js'\n\ntype Args = {\n  collection: SanitizedCollectionConfig | null\n  context: RequestContext\n  currentDepth?: number\n  depth: number\n  doc: Record<string, unknown>\n  draft: boolean\n  fallbackLocale: null | string\n  findMany?: boolean\n  flattenLocales?: boolean\n  global: SanitizedGlobalConfig | null\n  locale: string\n  overrideAccess: boolean\n  req: PayloadRequestWithData\n  showHiddenFields: boolean\n}\n\n/**\n * This function is responsible for the following actions, in order:\n * - Remove hidden fields from response\n * - Flatten locales into requested locale. If the input doc contains all locales, the output doc after this function will only contain the requested locale.\n * - Sanitize outgoing data (point field, etc.)\n * - Execute field hooks\n * - Execute read access control\n * - Populate relationships\n */\n\nexport async function afterRead<T = any>(args: Args): Promise<T> {\n  const {\n    collection,\n    context,\n    currentDepth: incomingCurrentDepth,\n    depth: incomingDepth,\n    doc: incomingDoc,\n    draft,\n    fallbackLocale,\n    findMany,\n    flattenLocales = true,\n    global,\n    locale,\n    overrideAccess,\n    req,\n    showHiddenFields,\n  } = args\n\n  const doc = deepCopyObject(incomingDoc)\n  const fieldPromises = []\n  const populationPromises = []\n\n  let depth =\n    incomingDepth || incomingDepth === 0\n      ? parseInt(String(incomingDepth), 10)\n      : req.payload.config.defaultDepth\n  if (depth > req.payload.config.maxDepth) depth = req.payload.config.maxDepth\n\n  const currentDepth = incomingCurrentDepth || 1\n\n  traverseFields({\n    collection,\n    context,\n    currentDepth,\n    depth,\n    doc,\n    draft,\n    fallbackLocale,\n    fieldPromises,\n    fields: collection?.fields || global?.fields,\n    findMany,\n    flattenLocales,\n    global,\n    locale,\n    overrideAccess,\n    path: [],\n    populationPromises,\n    req,\n    schemaPath: [],\n    showHiddenFields,\n    siblingDoc: doc,\n  })\n\n  await Promise.all(fieldPromises)\n  await Promise.all(populationPromises)\n\n  return doc\n}\n"],"names":["deepCopyObject","traverseFields","afterRead","args","collection","context","currentDepth","incomingCurrentDepth","depth","incomingDepth","doc","incomingDoc","draft","fallbackLocale","findMany","flattenLocales","global","locale","overrideAccess","req","showHiddenFields","fieldPromises","populationPromises","parseInt","String","payload","config","defaultDepth","maxDepth","fields","path","schemaPath","siblingDoc","Promise","all"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAIA,SAASA,cAAc,QAAQ,uCAAsC;AACrE,SAASC,cAAc,QAAQ,sBAAqB;AAmBpD;;;;;;;;CAQC,GAED,OAAO,eAAeC,UAAmBC,IAAU;IACjD,MAAM,EACJC,UAAU,EACVC,OAAO,EACPC,cAAcC,oBAAoB,EAClCC,OAAOC,aAAa,EACpBC,KAAKC,WAAW,EAChBC,KAAK,EACLC,cAAc,EACdC,QAAQ,EACRC,iBAAiB,IAAI,EACrBC,MAAM,EACNC,MAAM,EACNC,cAAc,EACdC,GAAG,EACHC,gBAAgB,EACjB,GAAGjB;IAEJ,MAAMO,MAAMV,eAAeW;IAC3B,MAAMU,gBAAgB,EAAE;IACxB,MAAMC,qBAAqB,EAAE;IAE7B,IAAId,QACFC,iBAAiBA,kBAAkB,IAC/Bc,SAASC,OAAOf,gBAAgB,MAChCU,IAAIM,OAAO,CAACC,MAAM,CAACC,YAAY;IACrC,IAAInB,QAAQW,IAAIM,OAAO,CAACC,MAAM,CAACE,QAAQ,EAAEpB,QAAQW,IAAIM,OAAO,CAACC,MAAM,CAACE,QAAQ;IAE5E,MAAMtB,eAAeC,wBAAwB;IAE7CN,eAAe;QACbG;QACAC;QACAC;QACAE;QACAE;QACAE;QACAC;QACAQ;QACAQ,QAAQzB,YAAYyB,UAAUb,QAAQa;QACtCf;QACAC;QACAC;QACAC;QACAC;QACAY,MAAM,EAAE;QACRR;QACAH;QACAY,YAAY,EAAE;QACdX;QACAY,YAAYtB;IACd;IAEA,MAAMuB,QAAQC,GAAG,CAACb;IAClB,MAAMY,QAAQC,GAAG,CAACZ;IAElB,OAAOZ;AACT"}

package/dist/fields/hooks/afterRead/promise.d.ts

@@ -1,6 +1,6 @@
 import type { SanitizedCollectionConfig } from '../../../collections/config/types.js';
 import type { SanitizedGlobalConfig } from '../../../globals/config/types.js';
-import type { PayloadRequest, RequestContext } from '../../../types/index.js';
+import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js';
 import type { Field, TabAsField } from '../../config/types.js';
 type Args = {
     collection: SanitizedCollectionConfig | null;
@@ -8,21 +8,33 @@ type Args = {
     currentDepth: number;
     depth: number;
     doc: Record<string, unknown>;
+    draft: boolean;
     fallbackLocale: null | string;
     field: Field | TabAsField;
+    /**
+     * fieldPromises are used for things like field hooks. They should be awaited before awaiting populationPromises
+     */
     fieldPromises: Promise<void>[];
     findMany: boolean;
     flattenLocales: boolean;
     global: SanitizedGlobalConfig | null;
     locale: null | string;
     overrideAccess: boolean;
+    /**
+     * The parent's path.
+     */
+    parentPath: (number | string)[];
+    /**
+     * The parent's schemaPath (path without indexes).
+     */
+    parentSchemaPath: string[];
     populationPromises: Promise<void>[];
-    req: PayloadRequest;
+    req: PayloadRequestWithData;
     showHiddenFields: boolean;
     siblingDoc: Record<string, unknown>;
     triggerAccessControl?: boolean;
     triggerHooks?: boolean;
 };
-export declare const promise: ({ collection, context, currentDepth, depth, doc, fallbackLocale, field, fieldPromises, findMany, flattenLocales, global, locale, overrideAccess, populationPromises, req, showHiddenFields, siblingDoc, triggerAccessControl, triggerHooks, }: Args) => Promise<void>;
+export declare const promise: ({ collection, context, currentDepth, depth, doc, draft, fallbackLocale, field, fieldPromises, findMany, flattenLocales, global, locale, overrideAccess, parentPath, parentSchemaPath, populationPromises, req, showHiddenFields, siblingDoc, triggerAccessControl, triggerHooks, }: Args) => Promise<void>;
 export {};
 //# sourceMappingURL=promise.d.ts.map

package/dist/fields/hooks/afterRead/promise.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"promise.d.ts","sourceRoot":"","sources":["../../../../src/fields/hooks/afterRead/promise.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAC7E,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAO9D,KAAK,IAAI,GAAG;IACV,UAAU,EAAE,yBAAyB,GAAG,IAAI,CAAA;IAC5C,OAAO,EAAE,cAAc,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5B,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,KAAK,EAAE,KAAK,GAAG,UAAU,CAAA;IACzB,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IAC9B,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpC,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,cAAc,EAAE,OAAO,CAAA;IACvB,kBAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IACnC,GAAG,EAAE,cAAc,CAAA;IACnB,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAUD,eAAO,MAAM,OAAO,kPAoBjB,IAAI,KAAG,QAAQ,IAAI,CAwerB,CAAA"}
+{"version":3,"file":"promise.d.ts","sourceRoot":"","sources":["../../../../src/fields/hooks/afterRead/promise.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AAC7E,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACrF,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAS9D,KAAK,IAAI,GAAG;IACV,UAAU,EAAE,yBAAyB,GAAG,IAAI,CAAA;IAC5C,OAAO,EAAE,cAAc,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5B,KAAK,EAAE,OAAO,CAAA;IACd,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,KAAK,EAAE,KAAK,GAAG,UAAU,CAAA;IACzB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IAC9B,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpC,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,cAAc,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,UAAU,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAC/B;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kBAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IACnC,GAAG,EAAE,sBAAsB,CAAA;IAC3B,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAUD,eAAO,MAAM,OAAO,uRAuBjB,IAAI,KAAG,QAAQ,IAAI,CAklBrB,CAAA"}

package/dist/fields/hooks/afterRead/promise.js

@@ -1,5 +1,7 @@
-/* eslint-disable no-param-reassign */ import { fieldAffectsData, tabHasName } from '../../config/types.js';
+/* eslint-disable no-param-reassign */ import { MissingEditorProp } from '../../../errors/index.js';
+import { fieldAffectsData, tabHasName } from '../../config/types.js';
 import getValueWithDefault from '../../getDefaultValue.js';
+import { getFieldPaths } from '../../getFieldPaths.js';
 import { relationshipPopulationPromise } from './relationshipPopulationPromise.js';
 import { traverseFields } from './traverseFields.js';
 // This function is responsible for the following actions, in order:
@@ -9,7 +11,12 @@ import { traverseFields } from './traverseFields.js';
 // - Execute field hooks
 // - Execute read access control
 // - Populate relationships
-export const promise = async ({ collection, context, currentDepth, depth, doc, fallbackLocale, field, fieldPromises, findMany, flattenLocales, global, locale, overrideAccess, populationPromises, req, showHiddenFields, siblingDoc, triggerAccessControl = true, triggerHooks = true })=>{
+export const promise = async ({ collection, context, currentDepth, depth, doc, draft, fallbackLocale, field, fieldPromises, findMany, flattenLocales, global, locale, overrideAccess, parentPath, parentSchemaPath, populationPromises, req, showHiddenFields, siblingDoc, triggerAccessControl = true, triggerHooks = true })=>{
+    const { path: fieldPath, schemaPath: fieldSchemaPath } = getFieldPaths({
+        field,
+        parentPath,
+        parentSchemaPath
+    });
     if (fieldAffectsData(field) && field.hidden && typeof siblingDoc[field.name] !== 'undefined' && !showHiddenFields) {
         delete siblingDoc[field.name];
     }
@@ -66,36 +73,12 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
             }
         case 'richText':
             {
-                const editor = field?.editor;
-                // This is run here AND in the GraphQL Resolver
-                if (editor?.populationPromise) {
-                    const populationPromise = editor.populationPromise({
-                        context,
-                        currentDepth,
-                        depth,
-                        field,
-                        findMany,
-                        flattenLocales,
-                        overrideAccess,
-                        populationPromises,
-                        req,
-                        showHiddenFields,
-                        siblingDoc
-                    });
-                    if (populationPromise) {
-                        populationPromises.push(populationPromise);
-                    }
+                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
+                    ;
                 }
-                // This is only run here, independent of depth
-                if (editor?.afterReadPromise) {
-                    const afterReadPromise = editor?.afterReadPromise({
-                        field,
-                        incomingEditorState: siblingDoc[field.name],
-                        siblingDoc
-                    });
-                    if (afterReadPromise) {
-                        populationPromises.push(afterReadPromise);
-                    }
+                if (typeof field?.editor === 'function') {
+                    throw new Error('Attempted to access unsanitized rich text editor.');
                 }
                 break;
             }
@@ -127,10 +110,14 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                                 context,
                                 data: doc,
                                 field,
+                                findMany,
                                 global,
                                 operation: 'read',
                                 originalDoc: doc,
+                                overrideAccess,
+                                path: fieldPath,
                                 req,
+                                schemaPath: fieldSchemaPath,
                                 siblingData: siblingDoc,
                                 value
                             });
@@ -149,7 +136,10 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                         global,
                         operation: 'read',
                         originalDoc: doc,
+                        overrideAccess,
+                        path: fieldPath,
                         req,
+                        schemaPath: fieldSchemaPath,
                         siblingData: siblingDoc,
                         value: siblingDoc[field.name]
                     });
@@ -188,6 +178,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
             populationPromises.push(relationshipPopulationPromise({
                 currentDepth,
                 depth,
+                draft,
                 fallbackLocale,
                 field,
                 locale,
@@ -209,6 +200,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     currentDepth,
                     depth,
                     doc,
+                    draft,
                     fallbackLocale,
                     fieldPromises,
                     fields: field.fields,
@@ -217,8 +209,10 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     global,
                     locale,
                     overrideAccess,
+                    path: fieldPath,
                     populationPromises,
                     req,
+                    schemaPath: fieldSchemaPath,
                     showHiddenFields,
                     siblingDoc: groupDoc,
                     triggerAccessControl,
@@ -230,13 +224,14 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
             {
                 const rows = siblingDoc[field.name];
                 if (Array.isArray(rows)) {
-                    rows.forEach((row)=>{
+                    rows.forEach((row, i)=>{
                         traverseFields({
                             collection,
                             context,
                             currentDepth,
                             depth,
                             doc,
+                            draft,
                             fallbackLocale,
                             fieldPromises,
                             fields: field.fields,
@@ -245,8 +240,13 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                             global,
                             locale,
                             overrideAccess,
+                            path: [
+                                ...fieldPath,
+                                i
+                            ],
                             populationPromises,
                             req,
+                            schemaPath: fieldSchemaPath,
                             showHiddenFields,
                             siblingDoc: row || {},
                             triggerAccessControl,
@@ -256,13 +256,14 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                 } else if (!shouldHoistLocalizedValue && typeof rows === 'object' && rows !== null) {
                     Object.values(rows).forEach((localeRows)=>{
                         if (Array.isArray(localeRows)) {
-                            localeRows.forEach((row)=>{
+                            localeRows.forEach((row, i)=>{
                                 traverseFields({
                                     collection,
                                     context,
                                     currentDepth,
                                     depth,
                                     doc,
+                                    draft,
                                     fallbackLocale,
                                     fieldPromises,
                                     fields: field.fields,
@@ -271,8 +272,13 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                                     global,
                                     locale,
                                     overrideAccess,
+                                    path: [
+                                        ...fieldPath,
+                                        i
+                                    ],
                                     populationPromises,
                                     req,
+                                    schemaPath: fieldSchemaPath,
                                     showHiddenFields,
                                     siblingDoc: row || {},
                                     triggerAccessControl,
@@ -290,7 +296,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
             {
                 const rows = siblingDoc[field.name];
                 if (Array.isArray(rows)) {
-                    rows.forEach((row)=>{
+                    rows.forEach((row, i)=>{
                         const block = field.blocks.find((blockType)=>blockType.slug === row.blockType);
                         if (block) {
                             traverseFields({
@@ -299,6 +305,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                                 currentDepth,
                                 depth,
                                 doc,
+                                draft,
                                 fallbackLocale,
                                 fieldPromises,
                                 fields: block.fields,
@@ -307,8 +314,13 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                                 global,
                                 locale,
                                 overrideAccess,
+                                path: [
+                                    ...fieldPath,
+                                    i
+                                ],
                                 populationPromises,
                                 req,
+                                schemaPath: fieldSchemaPath,
                                 showHiddenFields,
                                 siblingDoc: row || {},
                                 triggerAccessControl,
@@ -319,7 +331,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                 } else if (!shouldHoistLocalizedValue && typeof rows === 'object' && rows !== null) {
                     Object.values(rows).forEach((localeRows)=>{
                         if (Array.isArray(localeRows)) {
-                            localeRows.forEach((row)=>{
+                            localeRows.forEach((row, i)=>{
                                 const block = field.blocks.find((blockType)=>blockType.slug === row.blockType);
                                 if (block) {
                                     traverseFields({
@@ -328,6 +340,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                                         currentDepth,
                                         depth,
                                         doc,
+                                        draft,
                                         fallbackLocale,
                                         fieldPromises,
                                         fields: block.fields,
@@ -336,8 +349,13 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                                         global,
                                         locale,
                                         overrideAccess,
+                                        path: [
+                                            ...fieldPath,
+                                            i
+                                        ],
                                         populationPromises,
                                         req,
+                                        schemaPath: fieldSchemaPath,
                                         showHiddenFields,
                                         siblingDoc: row || {},
                                         triggerAccessControl,
@@ -361,6 +379,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     currentDepth,
                     depth,
                     doc,
+                    draft,
                     fallbackLocale,
                     fieldPromises,
                     fields: field.fields,
@@ -369,8 +388,10 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     global,
                     locale,
                     overrideAccess,
+                    path: fieldPath,
                     populationPromises,
                     req,
+                    schemaPath: fieldSchemaPath,
                     showHiddenFields,
                     siblingDoc,
                     triggerAccessControl,
@@ -391,6 +412,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     currentDepth,
                     depth,
                     doc,
+                    draft,
                     fallbackLocale,
                     fieldPromises,
                     fields: field.fields,
@@ -399,8 +421,10 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     global,
                     locale,
                     overrideAccess,
+                    path: fieldPath,
                     populationPromises,
                     req,
+                    schemaPath: fieldSchemaPath,
                     showHiddenFields,
                     siblingDoc: tabDoc,
                     triggerAccessControl,
@@ -416,6 +440,7 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     currentDepth,
                     depth,
                     doc,
+                    draft,
                     fallbackLocale,
                     fieldPromises,
                     fields: field.tabs.map((tab)=>({
@@ -427,8 +452,10 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                     global,
                     locale,
                     overrideAccess,
+                    path: fieldPath,
                     populationPromises,
                     req,
+                    schemaPath: fieldSchemaPath,
                     showHiddenFields,
                     siblingDoc,
                     triggerAccessControl,
@@ -436,6 +463,90 @@ export const promise = async ({ collection, context, currentDepth, depth, doc, f
                 });
                 break;
             }
+        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.');
+                }
+                const editor = field?.editor;
+                if (editor?.hooks?.afterRead?.length) {
+                    await editor.hooks.afterRead.reduce(async (priorHook, currentHook)=>{
+                        await priorHook;
+                        const shouldRunHookOnAllLocales = field.localized && (locale === 'all' || !flattenLocales) && typeof siblingDoc[field.name] === 'object';
+                        if (shouldRunHookOnAllLocales) {
+                            const hookPromises = Object.entries(siblingDoc[field.name]).map(([locale, value])=>(async ()=>{
+                                    const hookedValue = await currentHook({
+                                        collection,
+                                        context,
+                                        currentDepth,
+                                        data: doc,
+                                        depth,
+                                        draft,
+                                        fallbackLocale,
+                                        field,
+                                        fieldPromises,
+                                        findMany,
+                                        flattenLocales,
+                                        global,
+                                        locale,
+                                        operation: 'read',
+                                        originalDoc: doc,
+                                        overrideAccess,
+                                        path: fieldPath,
+                                        populationPromises,
+                                        req,
+                                        schemaPath: fieldSchemaPath,
+                                        showHiddenFields,
+                                        siblingData: siblingDoc,
+                                        triggerAccessControl,
+                                        triggerHooks,
+                                        value
+                                    });
+                                    if (hookedValue !== undefined) {
+                                        siblingDoc[field.name][locale] = hookedValue;
+                                    }
+                                })());
+                            await Promise.all(hookPromises);
+                        } else {
+                            const hookedValue = await currentHook({
+                                collection,
+                                context,
+                                currentDepth,
+                                data: doc,
+                                depth,
+                                draft,
+                                fallbackLocale,
+                                field,
+                                fieldPromises,
+                                findMany,
+                                flattenLocales,
+                                global,
+                                locale,
+                                operation: 'read',
+                                originalDoc: doc,
+                                overrideAccess,
+                                path: fieldPath,
+                                populationPromises,
+                                req,
+                                schemaPath: fieldSchemaPath,
+                                showHiddenFields,
+                                siblingData: siblingDoc,
+                                triggerAccessControl,
+                                triggerHooks,
+                                value: siblingDoc[field.name]
+                            });
+                            if (hookedValue !== undefined) {
+                                siblingDoc[field.name] = hookedValue;
+                            }
+                        }
+                    }, Promise.resolve());
+                }
+                break;
+            }
         default:
             {
                 break;