@payloadcms/plugin-search 1.0.1 → 3.0.0-alpha.42

package/README.md

@@ -1,122 +1,7 @@
 # Payload Search Plugin
 
-[![NPM](https://img.shields.io/npm/v/@payloadcms/plugin-search)](https://www.npmjs.com/package/@payloadcms/plugin-search)
+A plugin for [Payload](https://github.com/payloadcms/payload) to generate records of your documents that are extremely fast to search on.
 
-A plugin for [Payload](https://github.com/payloadcms/payload) to create extremely fast search results from your existing documents.
-
-Core features:
-
-- Creates a `search` collection that:
-  - Automatically creates, syncs, and deletes search results related to your documents
-  - Serves search results extremely quickly by saving only search-critical data that you define
-  - Allows you to sort search results by priority
-
-## Installation
-
-```bash
-  yarn add @payloadcms/plugin-search
-  # OR
-  npm i @payloadcms/plugin-search
-```
-
-## Basic Usage
-
-In the `plugins` array of your [Payload config](https://payloadcms.com/docs/configuration/overview), call the plugin with [options](#options):
-
-```js
-import { buildConfig } from "payload/config";
-import search from "@payloadcms/plugin-search";
-
-const config = buildConfig({
-  collections: [
-    {
-      slug: "pages",
-      fields: [],
-    },
-    {
-      slug: "posts",
-      fields: [],
-    },
-  ],
-  plugins: [
-    search({
-      collections: ["pages", "posts"],
-      defaultPriorities: {
-        pages: 10,
-        posts: 20,
-      },
-    }),
-  ],
-});
-
-export default config;
-```
-
-### Options
-
-#### `collections`
-
-An array of collections slugs to enable sync-to-search. Enabled collections receive a `beforeChange` and `afterDelete` hook that creates, syncs, and deleted the document to its related search document as it changes over time, and also an `afterDelete` hook that deletes.
-
-#### `defaultPriorities`
-
-The default priorities first set on `create` operations. Send an object of collection slugs, and set them to either a number or a function.
-
-```js
-plugins: [
-  searchPlugin({
-    defaultPriorities: {
-      pages: ({ doc }) => (doc.title.startsWith("Hello, world!") ? 1 : 10),
-      posts: 20,
-    },
-  }),
-];
-```
-
-#### `searchOverrides`
-
-Override anything on the search collection by sending a [Payload Collection Config](https://payloadcms.com/docs/configuration/collections).
-
-```js
-plugins: [
-  searchPlugin({
-    searchOverrides: {
-      slug: "search-results",
-    },
-  }),
-];
-```
-
-#### `beforeSync`
-
-An [afterChange](<[afterChange](https://payloadcms.com/docs/hooks/globals#afterchange)>) hook that is called before creating or syncing the document to search. This allows you to modify the data in any way before doing so.
-
-```js
-plugins: [
-  searchPlugin({
-    beforeSync: ({ originalDoc, searchDoc }) => ({
-      ...searchDoc,
-      // Modify your docs in any way here, this can be async
-      excerpt: originalDoc?.excerpt || "This is a fallback excerpt",
-    }),
-  }),
-];
-```
-
-#### `syncDrafts`
-
-If true, will sync draft documents to search. By default, this plugin will only sync published documents. False by default. You must have [Payload Drafts](https://payloadcms.com/docs/versions/drafts) enabled for this to apply.
-
-#### `deleteDrafts`
-
-If true, will delete documents from search that change to draft status. True by default. You must have [Payload Drafts](https://payloadcms.com/docs/versions/drafts) enabled for this to apply.
-
-## TypeScript
-
-All types can be directly imported:
-
-```js
-import { SearchConfig, BeforeSync } from "@payloadcms/plugin-search/dist/types";
-```
-
-## Screenshots
+- [Source code](https://github.com/payloadcms/payload/tree/main/packages/plugin-search)
+- [Documentation](https://payloadcms.com/docs/plugins/search)
+- [Documentation source](https://github.com/payloadcms/payload/tree/main/docs/plugins/search.mdx)

package/dist/Search/hooks/deleteFromSearch.d.ts

@@ -1,3 +1,4 @@
 import type { CollectionAfterDeleteHook } from 'payload/types';
 declare const deleteFromSearch: CollectionAfterDeleteHook;
 export default deleteFromSearch;
+//# sourceMappingURL=deleteFromSearch.d.ts.map

package/dist/Search/hooks/deleteFromSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteFromSearch.d.ts","sourceRoot":"","sources":["../../../src/Search/hooks/deleteFromSearch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAA;AAE9D,QAAA,MAAM,gBAAgB,EAAE,yBA2BvB,CAAA;AAED,eAAe,gBAAgB,CAAA"}

package/dist/Search/hooks/deleteFromSearch.js

@@ -1,78 +1,29 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var deleteFromSearch = function (_a) {
-    var payload = _a.req.payload, doc = _a.doc;
+const deleteFromSearch = async ({ doc, req: { payload }, req })=>{
     try {
-        var deleteSearchDoc = function () { return __awaiter(void 0, void 0, void 0, function () {
-            var searchDocQuery;
-            var _a, _b, _c;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
-                    case 0: return [4 /*yield*/, payload.find({
-                            collection: 'search',
-                            where: {
-                                'doc.value': {
-                                    equals: doc.id,
-                                },
-                            },
-                            depth: 0,
-                        })];
-                    case 1:
-                        searchDocQuery = _d.sent();
-                        if ((_a = searchDocQuery === null || searchDocQuery === void 0 ? void 0 : searchDocQuery.docs) === null || _a === void 0 ? void 0 : _a[0]) {
-                            payload.delete({
-                                collection: 'search',
-                                id: (_c = (_b = searchDocQuery === null || searchDocQuery === void 0 ? void 0 : searchDocQuery.docs) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.id,
-                            });
-                        }
-                        return [2 /*return*/];
+        const searchDocQuery = await payload.find({
+            collection: 'search',
+            depth: 0,
+            req,
+            where: {
+                'doc.value': {
+                    equals: doc.id
                 }
+            }
+        });
+        if (searchDocQuery?.docs?.[0]) {
+            await payload.delete({
+                id: searchDocQuery?.docs?.[0]?.id,
+                collection: 'search',
+                req
             });
-        }); };
-        deleteSearchDoc();
-    }
-    catch (err) {
+        }
+    } catch (err) {
         payload.logger.error({
-            err: "Error deleting search doc: ".concat(err),
+            err: `Error deleting search doc: ${err}`
         });
     }
     return doc;
 };
-exports.default = deleteFromSearch;
+export default deleteFromSearch;
+
 //# sourceMappingURL=deleteFromSearch.js.map

package/dist/Search/hooks/deleteFromSearch.js.map

@@ -1 +1 @@
-{"version":3,"file":"deleteFromSearch.js","sourceRoot":"","sources":["../../../src/Search/hooks/deleteFromSearch.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,IAAM,gBAAgB,GAA8B,UAAC,EAAyB;QAAhB,OAAO,iBAAA,EAAI,GAAG,SAAA;IAC1E,IAAI;QACF,IAAM,eAAe,GAAG;;;;;4BACC,qBAAM,OAAO,CAAC,IAAI,CAAC;4BACxC,UAAU,EAAE,QAAQ;4BACpB,KAAK,EAAE;gCACL,WAAW,EAAE;oCACX,MAAM,EAAE,GAAG,CAAC,EAAE;iCACf;6BACF;4BACD,KAAK,EAAE,CAAC;yBACT,CAAC,EAAA;;wBARI,cAAc,GAAG,SAQrB;wBAEF,IAAI,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,IAAI,0CAAG,CAAC,CAAC,EAAE;4BAC7B,OAAO,CAAC,MAAM,CAAC;gCACb,UAAU,EAAE,QAAQ;gCACpB,EAAE,EAAE,MAAA,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,IAAI,0CAAG,CAAC,CAAC,0CAAE,EAAE;6BAClC,CAAC,CAAA;yBACH;;;;aACF,CAAA;QAED,eAAe,EAAE,CAAA;KAClB;IAAC,OAAO,GAAY,EAAE;QACrB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;YACnB,GAAG,EAAE,qCAA8B,GAAG,CAAE;SACzC,CAAC,CAAA;KACH;IAED,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,kBAAe,gBAAgB,CAAA"}
+{"version":3,"sources":["../../../src/Search/hooks/deleteFromSearch.ts"],"sourcesContent":["import type { CollectionAfterDeleteHook } from 'payload/types'\n\nconst deleteFromSearch: CollectionAfterDeleteHook = async ({ doc, req: { payload }, req }) => {\n  try {\n    const searchDocQuery = await payload.find({\n      collection: 'search',\n      depth: 0,\n      req,\n      where: {\n        'doc.value': {\n          equals: doc.id,\n        },\n      },\n    })\n\n    if (searchDocQuery?.docs?.[0]) {\n      await payload.delete({\n        id: searchDocQuery?.docs?.[0]?.id,\n        collection: 'search',\n        req,\n      })\n    }\n  } catch (err: unknown) {\n    payload.logger.error({\n      err: `Error deleting search doc: ${err}`,\n    })\n  }\n\n  return doc\n}\n\nexport default deleteFromSearch\n"],"names":["deleteFromSearch","doc","req","payload","searchDocQuery","find","collection","depth","where","equals","id","docs","delete","err","logger","error"],"mappings":"AAEA,MAAMA,mBAA8C,OAAO,EAAEC,GAAG,EAAEC,KAAK,EAAEC,OAAO,EAAE,EAAED,GAAG,EAAE;IACvF,IAAI;QACF,MAAME,iBAAiB,MAAMD,QAAQE,IAAI,CAAC;YACxCC,YAAY;YACZC,OAAO;YACPL;YACAM,OAAO;gBACL,aAAa;oBACXC,QAAQR,IAAIS,EAAE;gBAChB;YACF;QACF;QAEA,IAAIN,gBAAgBO,MAAM,CAAC,EAAE,EAAE;YAC7B,MAAMR,QAAQS,MAAM,CAAC;gBACnBF,IAAIN,gBAAgBO,MAAM,CAAC,EAAE,EAAED;gBAC/BJ,YAAY;gBACZJ;YACF;QACF;IACF,EAAE,OAAOW,KAAc;QACrBV,QAAQW,MAAM,CAACC,KAAK,CAAC;YACnBF,KAAK,CAAC,2BAA2B,EAAEA,IAAI,CAAC;QAC1C;IACF;IAEA,OAAOZ;AACT;AAEA,eAAeD,iBAAgB"}

package/dist/Search/hooks/syncWithSearch.d.ts

@@ -1,3 +1,4 @@
-import type { SyncWithSearch } from '../../types';
+import type { SyncWithSearch } from '../../types.js';
 declare const syncWithSearch: SyncWithSearch;
 export default syncWithSearch;
+//# sourceMappingURL=syncWithSearch.d.ts.map

package/dist/Search/hooks/syncWithSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"syncWithSearch.d.ts","sourceRoot":"","sources":["../../../src/Search/hooks/syncWithSearch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA2B,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE7E,QAAA,MAAM,cAAc,EAAE,cA8JrB,CAAA;AAED,eAAe,cAAc,CAAA"}

package/dist/Search/hooks/syncWithSearch.js

@@ -1,200 +1,138 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
+const syncWithSearch = async (args)=>{
+    const { collection, doc, operation, req: { payload }, req, // @ts-expect-error
+    searchConfig } = args;
+    const { id, _status: status, title } = doc || {};
+    const { beforeSync, defaultPriorities, deleteDrafts, syncDrafts } = searchConfig// todo fix SyncWithSearch type, see note in ./types.ts
+    ;
+    let dataToSave = {
+        doc: {
+            relationTo: collection,
+            value: id
+        },
+        title
     };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
+    if (typeof beforeSync === 'function') {
+        dataToSave = await beforeSync({
+            originalDoc: doc,
+            payload,
+            req,
+            searchDoc: dataToSave
+        });
+    }
+    let defaultPriority = 0;
+    if (defaultPriorities) {
+        const { [collection]: priority } = defaultPriorities;
+        if (typeof priority === 'function') {
+            try {
+                defaultPriority = await priority(doc);
+            } catch (err) {
+                payload.logger.error(err);
+                payload.logger.error(`Error gathering default priority for search documents related to ${collection}`);
             }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+        } else {
+            defaultPriority = priority;
+        }
     }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var syncWithSearch = function (args) { return __awaiter(void 0, void 0, void 0, function () {
-    var payload, doc, operation, 
-    // @ts-expect-error
-    collection, 
-    // @ts-expect-error
-    searchConfig, _a, title, id, status, _b, beforeSync, syncDrafts, deleteDrafts, defaultPriorities, dataToSave, defaultPriority, _c, _d, priority, err_1, doSync, searchDocQuery, docs, foundDoc, duplicativeDocs, searchDocID, err_2, err_3;
-    return __generator(this, function (_e) {
-        switch (_e.label) {
-            case 0:
-                payload = args.req.payload, doc = args.doc, operation = args.operation, collection = args.collection, searchConfig = args.searchConfig;
-                _a = doc || {}, title = _a.title, id = _a.id, status = _a._status;
-                _b = searchConfig // todo fix SyncWithSearch type, see note in ./types.ts
-                , beforeSync = _b.beforeSync, syncDrafts = _b.syncDrafts, deleteDrafts = _b.deleteDrafts, defaultPriorities = _b.defaultPriorities;
-                dataToSave = {
-                    title: title,
-                    doc: {
-                        relationTo: collection,
-                        value: id,
+    const doSync = syncDrafts || !syncDrafts && status !== 'draft';
+    try {
+        if (operation === 'create') {
+            if (doSync) {
+                await payload.create({
+                    collection: 'search',
+                    data: {
+                        ...dataToSave,
+                        priority: defaultPriority
                     },
-                };
-                if (!(typeof beforeSync === 'function')) return [3 /*break*/, 2];
-                return [4 /*yield*/, beforeSync({
-                        originalDoc: doc,
-                        searchDoc: dataToSave,
-                        payload: payload,
-                    })];
-            case 1:
-                dataToSave = _e.sent();
-                _e.label = 2;
-            case 2:
-                defaultPriority = 0;
-                if (!defaultPriorities) return [3 /*break*/, 8];
-                _c = defaultPriorities, _d = collection, priority = _c[_d];
-                if (!(typeof priority === 'function')) return [3 /*break*/, 7];
-                _e.label = 3;
-            case 3:
-                _e.trys.push([3, 5, , 6]);
-                return [4 /*yield*/, priority(doc)];
-            case 4:
-                defaultPriority = _e.sent();
-                return [3 /*break*/, 6];
-            case 5:
-                err_1 = _e.sent();
-                payload.logger.error(err_1);
-                payload.logger.error("Error gathering default priority for search documents related to ".concat(collection));
-                return [3 /*break*/, 6];
-            case 6: return [3 /*break*/, 8];
-            case 7:
-                defaultPriority = priority;
-                _e.label = 8;
-            case 8:
-                doSync = syncDrafts || (!syncDrafts && status !== 'draft');
-                _e.label = 9;
-            case 9:
-                _e.trys.push([9, 14, , 15]);
-                if (operation === 'create') {
-                    if (doSync) {
-                        payload.create({
-                            collection: 'search',
-                            data: __assign(__assign({}, dataToSave), { priority: defaultPriority }),
-                        });
+                    req
+                });
+            }
+        }
+        if (operation === 'update') {
+            try {
+                // find the correct doc to sync with
+                const searchDocQuery = await payload.find({
+                    collection: 'search',
+                    depth: 0,
+                    req,
+                    where: {
+                        'doc.value': {
+                            equals: id
+                        }
                     }
-                }
-                if (!(operation === 'update')) return [3 /*break*/, 13];
-                _e.label = 10;
-            case 10:
-                _e.trys.push([10, 12, , 13]);
-                return [4 /*yield*/, payload.find({
-                        collection: 'search',
-                        where: {
-                            'doc.value': {
-                                equals: id,
-                            },
-                        },
-                        depth: 0,
-                    })];
-            case 11:
-                searchDocQuery = _e.sent();
-                docs = (searchDocQuery === null || searchDocQuery === void 0 ? void 0 : searchDocQuery.docs) || [];
-                foundDoc = docs[0], duplicativeDocs = docs.slice(1);
+                });
+                const docs = searchDocQuery?.docs || [];
+                const [foundDoc, ...duplicativeDocs] = docs;
                 // delete all duplicative search docs (docs that reference the same page)
                 // to ensure the same, out-of-date result does not appear twice (where only syncing the first found doc)
                 if (duplicativeDocs.length > 0) {
                     try {
-                        Promise.all(duplicativeDocs.map(function (_a) {
-                            var duplicativeDocID = _a.id;
-                            return payload.delete({
-                                collection: 'search',
-                                id: duplicativeDocID,
-                            });
-                        }));
-                    }
-                    catch (err) {
-                        payload.logger.error("Error deleting duplicative search documents.");
+                        const duplicativeDocIDs = duplicativeDocs.map(({ id })=>id);
+                        await payload.delete({
+                            collection: 'search',
+                            req,
+                            where: {
+                                id: {
+                                    in: duplicativeDocIDs
+                                }
+                            }
+                        });
+                    } catch (err) {
+                        payload.logger.error(`Error deleting duplicative search documents.`);
                     }
                 }
                 if (foundDoc) {
-                    searchDocID = foundDoc.id;
+                    const { id: searchDocID } = foundDoc;
                     if (doSync) {
                         // update the doc normally
                         try {
-                            payload.update({
-                                collection: 'search',
+                            await payload.update({
                                 id: searchDocID,
-                                data: __assign(__assign({}, dataToSave), { priority: foundDoc.priority || defaultPriority }),
+                                collection: 'search',
+                                data: {
+                                    ...dataToSave,
+                                    priority: foundDoc.priority || defaultPriority
+                                },
+                                req
                             });
-                        }
-                        catch (err) {
-                            payload.logger.error("Error updating search document.");
+                        } catch (err) {
+                            payload.logger.error(`Error updating search document.`);
                         }
                     }
                     if (deleteDrafts && status === 'draft') {
                         // do not include draft docs in search results, so delete the record
                         try {
-                            payload.delete({
-                                collection: 'search',
+                            await payload.delete({
                                 id: searchDocID,
+                                collection: 'search',
+                                req
                             });
-                        }
-                        catch (err) {
-                            payload.logger.error("Error deleting search document: ".concat(err));
+                        } catch (err) {
+                            payload.logger.error(`Error deleting search document: ${err}`);
                         }
                     }
-                }
-                else if (doSync) {
+                } else if (doSync) {
                     try {
-                        payload.create({
+                        await payload.create({
                             collection: 'search',
-                            data: __assign(__assign({}, dataToSave), { priority: defaultPriority }),
+                            data: {
+                                ...dataToSave,
+                                priority: defaultPriority
+                            },
+                            req
                         });
-                    }
-                    catch (err) {
-                        payload.logger.error("Error creating search document: ".concat(err));
+                    } catch (err) {
+                        payload.logger.error(`Error creating search document: ${err}`);
                     }
                 }
-                return [3 /*break*/, 13];
-            case 12:
-                err_2 = _e.sent();
-                payload.logger.error("Error finding search document: ".concat(err_2));
-                return [3 /*break*/, 13];
-            case 13: return [3 /*break*/, 15];
-            case 14:
-                err_3 = _e.sent();
-                payload.logger.error("Error syncing search document related to ".concat(collection, " with id: '").concat(id, "': ").concat(err_3));
-                return [3 /*break*/, 15];
-            case 15: return [2 /*return*/, doc];
+            } catch (err) {
+                payload.logger.error(`Error finding search document: ${err}`);
+            }
         }
-    });
-}); };
-exports.default = syncWithSearch;
+    } catch (err) {
+        payload.logger.error(`Error syncing search document related to ${collection} with id: '${id}': ${err}`);
+    }
+    return doc;
+};
+export default syncWithSearch;
+
 //# sourceMappingURL=syncWithSearch.js.map

package/dist/Search/hooks/syncWithSearch.js.map

@@ -1 +1 @@
-{"version":3,"file":"syncWithSearch.js","sourceRoot":"","sources":["../../../src/Search/hooks/syncWithSearch.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,IAAM,cAAc,GAAmB,UAAM,IAAI;;;;;;;;;gBAEtC,OAAO,GAOZ,IAAI,YAPQ,EACd,GAAG,GAMD,IAAI,IANH,EACH,SAAS,GAKP,IAAI,UALG,EAET,UAAU,GAGR,IAAI,WAHI,EAEV,YAAY,GACV,IAAI,aADM,CACN;gBAEF,KAAiC,GAAG,IAAI,EAAE,EAAxC,KAAK,WAAA,EAAE,EAAE,QAAA,EAAW,MAAM,aAAA,CAAc;gBAE1C,KAA8D,YAA4B,CAAC,uDAAuD;gBAAxD,EAAxF,UAAU,gBAAA,EAAE,UAAU,gBAAA,EAAE,YAAY,kBAAA,EAAE,iBAAiB,uBAAA,CAAiC;gBAE5F,UAAU,GAAG;oBACf,KAAK,OAAA;oBACL,GAAG,EAAE;wBACH,UAAU,EAAE,UAAU;wBACtB,KAAK,EAAE,EAAE;qBACV;iBACF,CAAA;qBAEG,CAAA,OAAO,UAAU,KAAK,UAAU,CAAA,EAAhC,wBAAgC;gBACrB,qBAAM,UAAU,CAAC;wBAC5B,WAAW,EAAE,GAAG;wBAChB,SAAS,EAAE,UAAU;wBACrB,OAAO,SAAA;qBACR,CAAC,EAAA;;gBAJF,UAAU,GAAG,SAIX,CAAA;;;gBAGA,eAAe,GAAG,CAAC,CAAA;qBACnB,iBAAiB,EAAjB,wBAAiB;gBACgB,KAAA,iBAAiB,EAA5C,KAAC,UAAW,EAAE,QAAQ,SAAA,CAAsB;qBAEhD,CAAA,OAAO,QAAQ,KAAK,UAAU,CAAA,EAA9B,wBAA8B;;;;gBAEZ,qBAAM,QAAQ,CAAC,GAAG,CAAC,EAAA;;gBAArC,eAAe,GAAG,SAAmB,CAAA;;;;gBAErC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAG,CAAC,CAAA;gBACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,2EAAoE,UAAU,CAAE,CACjF,CAAA;;;;gBAGH,eAAe,GAAG,QAAQ,CAAA;;;gBAIxB,MAAM,GAAG,UAAU,IAAI,CAAC,CAAC,UAAU,IAAI,MAAM,KAAK,OAAO,CAAC,CAAA;;;;gBAG9D,IAAI,SAAS,KAAK,QAAQ,EAAE;oBAC1B,IAAI,MAAM,EAAE;wBACV,OAAO,CAAC,MAAM,CAAC;4BACb,UAAU,EAAE,QAAQ;4BACpB,IAAI,wBACC,UAAU,KACb,QAAQ,EAAE,eAAe,GAC1B;yBACF,CAAC,CAAA;qBACH;iBACF;qBAEG,CAAA,SAAS,KAAK,QAAQ,CAAA,EAAtB,yBAAsB;;;;gBAGC,qBAAM,OAAO,CAAC,IAAI,CAAC;wBACxC,UAAU,EAAE,QAAQ;wBACpB,KAAK,EAAE;4BACL,WAAW,EAAE;gCACX,MAAM,EAAE,EAAE;6BACX;yBACF;wBACD,KAAK,EAAE,CAAC;qBACT,CAAC,EAAA;;gBARI,cAAc,GAAG,SAQrB;gBAEI,IAAI,GAGL,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,IAAI,KAAI,EAAE,CAAA;gBAExB,QAAQ,GAAwB,IAAI,GAA5B,EAAK,eAAe,GAAI,IAAI,SAAR,CAAQ;gBAE3C,yEAAyE;gBACzE,wGAAwG;gBACxG,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC9B,IAAI;wBACF,OAAO,CAAC,GAAG,CACT,eAAe,CAAC,GAAG,CAAC,UAAC,EAAwB;gCAAlB,gBAAgB,QAAA;4BACzC,OAAA,OAAO,CAAC,MAAM,CAAC;gCACb,UAAU,EAAE,QAAQ;gCACpB,EAAE,EAAE,gBAAgB;6BACrB,CAAC;wBAHF,CAGE,CACH,CACF,CAAA;qBACF;oBAAC,OAAO,GAAY,EAAE;wBACrB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;qBACrE;iBACF;gBAED,IAAI,QAAQ,EAAE;oBACA,WAAW,GAAK,QAAQ,GAAb,CAAa;oBAEpC,IAAI,MAAM,EAAE;wBACV,0BAA0B;wBAC1B,IAAI;4BACF,OAAO,CAAC,MAAM,CAAC;gCACb,UAAU,EAAE,QAAQ;gCACpB,EAAE,EAAE,WAAW;gCACf,IAAI,wBACC,UAAU,KACb,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,eAAe,GAC/C;6BACF,CAAC,CAAA;yBACH;wBAAC,OAAO,GAAY,EAAE;4BACrB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAA;yBACxD;qBACF;oBACD,IAAI,YAAY,IAAI,MAAM,KAAK,OAAO,EAAE;wBACtC,oEAAoE;wBACpE,IAAI;4BACF,OAAO,CAAC,MAAM,CAAC;gCACb,UAAU,EAAE,QAAQ;gCACpB,EAAE,EAAE,WAAW;6BAChB,CAAC,CAAA;yBACH;wBAAC,OAAO,GAAY,EAAE;4BACrB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,0CAAmC,GAAG,CAAE,CAAC,CAAA;yBAC/D;qBACF;iBACF;qBAAM,IAAI,MAAM,EAAE;oBACjB,IAAI;wBACF,OAAO,CAAC,MAAM,CAAC;4BACb,UAAU,EAAE,QAAQ;4BACpB,IAAI,wBACC,UAAU,KACb,QAAQ,EAAE,eAAe,GAC1B;yBACF,CAAC,CAAA;qBACH;oBAAC,OAAO,GAAY,EAAE;wBACrB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,0CAAmC,GAAG,CAAE,CAAC,CAAA;qBAC/D;iBACF;;;;gBAED,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAkC,KAAG,CAAE,CAAC,CAAA;;;;;gBAIjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,mDAA4C,UAAU,wBAAc,EAAE,gBAAM,KAAG,CAAE,CAClF,CAAA;;qBAGH,sBAAO,GAAG,EAAA;;;KACX,CAAA;AAED,kBAAe,cAAc,CAAA"}
+{"version":3,"sources":["../../../src/Search/hooks/syncWithSearch.ts"],"sourcesContent":["import type { DocToSync, SearchConfig, SyncWithSearch } from '../../types.js'\n\nconst syncWithSearch: SyncWithSearch = async (args) => {\n  const {\n    collection,\n    doc,\n    operation,\n    req: { payload },\n    req,\n    // @ts-expect-error\n    searchConfig,\n  } = args\n\n  const { id, _status: status, title } = doc || {}\n\n  const { beforeSync, defaultPriorities, deleteDrafts, syncDrafts } = searchConfig as SearchConfig // todo fix SyncWithSearch type, see note in ./types.ts\n\n  let dataToSave: DocToSync = {\n    doc: {\n      relationTo: collection,\n      value: id,\n    },\n    title,\n  }\n\n  if (typeof beforeSync === 'function') {\n    dataToSave = await beforeSync({\n      originalDoc: doc,\n      payload,\n      req,\n      searchDoc: dataToSave,\n    })\n  }\n\n  let defaultPriority = 0\n  if (defaultPriorities) {\n    const { [collection]: priority } = defaultPriorities\n\n    if (typeof priority === 'function') {\n      try {\n        defaultPriority = await priority(doc)\n      } catch (err: unknown) {\n        payload.logger.error(err)\n        payload.logger.error(\n          `Error gathering default priority for search documents related to ${collection}`,\n        )\n      }\n    } else {\n      defaultPriority = priority\n    }\n  }\n\n  const doSync = syncDrafts || (!syncDrafts && status !== 'draft')\n\n  try {\n    if (operation === 'create') {\n      if (doSync) {\n        await payload.create({\n          collection: 'search',\n          data: {\n            ...dataToSave,\n            priority: defaultPriority,\n          },\n          req,\n        })\n      }\n    }\n\n    if (operation === 'update') {\n      try {\n        // find the correct doc to sync with\n        const searchDocQuery = await payload.find({\n          collection: 'search',\n          depth: 0,\n          req,\n          where: {\n            'doc.value': {\n              equals: id,\n            },\n          },\n        })\n\n        const docs: Array<{\n          id: number | string\n          priority?: number\n        }> = searchDocQuery?.docs || []\n\n        const [foundDoc, ...duplicativeDocs] = docs\n\n        // delete all duplicative search docs (docs that reference the same page)\n        // to ensure the same, out-of-date result does not appear twice (where only syncing the first found doc)\n        if (duplicativeDocs.length > 0) {\n          try {\n            const duplicativeDocIDs = duplicativeDocs.map(({ id }) => id)\n            await payload.delete({\n              collection: 'search',\n              req,\n              where: { id: { in: duplicativeDocIDs } },\n            })\n          } catch (err: unknown) {\n            payload.logger.error(`Error deleting duplicative search documents.`)\n          }\n        }\n\n        if (foundDoc) {\n          const { id: searchDocID } = foundDoc\n\n          if (doSync) {\n            // update the doc normally\n            try {\n              await payload.update({\n                id: searchDocID,\n                collection: 'search',\n                data: {\n                  ...dataToSave,\n                  priority: foundDoc.priority || defaultPriority,\n                },\n                req,\n              })\n            } catch (err: unknown) {\n              payload.logger.error(`Error updating search document.`)\n            }\n          }\n          if (deleteDrafts && status === 'draft') {\n            // do not include draft docs in search results, so delete the record\n            try {\n              await payload.delete({\n                id: searchDocID,\n                collection: 'search',\n                req,\n              })\n            } catch (err: unknown) {\n              payload.logger.error(`Error deleting search document: ${err}`)\n            }\n          }\n        } else if (doSync) {\n          try {\n            await payload.create({\n              collection: 'search',\n              data: {\n                ...dataToSave,\n                priority: defaultPriority,\n              },\n              req,\n            })\n          } catch (err: unknown) {\n            payload.logger.error(`Error creating search document: ${err}`)\n          }\n        }\n      } catch (err: unknown) {\n        payload.logger.error(`Error finding search document: ${err}`)\n      }\n    }\n  } catch (err: unknown) {\n    payload.logger.error(\n      `Error syncing search document related to ${collection} with id: '${id}': ${err}`,\n    )\n  }\n\n  return doc\n}\n\nexport default syncWithSearch\n"],"names":["syncWithSearch","args","collection","doc","operation","req","payload","searchConfig","id","_status","status","title","beforeSync","defaultPriorities","deleteDrafts","syncDrafts","dataToSave","relationTo","value","originalDoc","searchDoc","defaultPriority","priority","err","logger","error","doSync","create","data","searchDocQuery","find","depth","where","equals","docs","foundDoc","duplicativeDocs","length","duplicativeDocIDs","map","delete","in","searchDocID","update"],"mappings":"AAEA,MAAMA,iBAAiC,OAAOC;IAC5C,MAAM,EACJC,UAAU,EACVC,GAAG,EACHC,SAAS,EACTC,KAAK,EAAEC,OAAO,EAAE,EAChBD,GAAG,EACH,mBAAmB;IACnBE,YAAY,EACb,GAAGN;IAEJ,MAAM,EAAEO,EAAE,EAAEC,SAASC,MAAM,EAAEC,KAAK,EAAE,GAAGR,OAAO,CAAC;IAE/C,MAAM,EAAES,UAAU,EAAEC,iBAAiB,EAAEC,YAAY,EAAEC,UAAU,EAAE,GAAGR,YAA6B,uDAAuD;;IAExJ,IAAIS,aAAwB;QAC1Bb,KAAK;YACHc,YAAYf;YACZgB,OAAOV;QACT;QACAG;IACF;IAEA,IAAI,OAAOC,eAAe,YAAY;QACpCI,aAAa,MAAMJ,WAAW;YAC5BO,aAAahB;YACbG;YACAD;YACAe,WAAWJ;QACb;IACF;IAEA,IAAIK,kBAAkB;IACtB,IAAIR,mBAAmB;QACrB,MAAM,EAAE,CAACX,WAAW,EAAEoB,QAAQ,EAAE,GAAGT;QAEnC,IAAI,OAAOS,aAAa,YAAY;YAClC,IAAI;gBACFD,kBAAkB,MAAMC,SAASnB;YACnC,EAAE,OAAOoB,KAAc;gBACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAACF;gBACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAClB,CAAC,iEAAiE,EAAEvB,WAAW,CAAC;YAEpF;QACF,OAAO;YACLmB,kBAAkBC;QACpB;IACF;IAEA,MAAMI,SAASX,cAAe,CAACA,cAAcL,WAAW;IAExD,IAAI;QACF,IAAIN,cAAc,UAAU;YAC1B,IAAIsB,QAAQ;gBACV,MAAMpB,QAAQqB,MAAM,CAAC;oBACnBzB,YAAY;oBACZ0B,MAAM;wBACJ,GAAGZ,UAAU;wBACbM,UAAUD;oBACZ;oBACAhB;gBACF;YACF;QACF;QAEA,IAAID,cAAc,UAAU;YAC1B,IAAI;gBACF,oCAAoC;gBACpC,MAAMyB,iBAAiB,MAAMvB,QAAQwB,IAAI,CAAC;oBACxC5B,YAAY;oBACZ6B,OAAO;oBACP1B;oBACA2B,OAAO;wBACL,aAAa;4BACXC,QAAQzB;wBACV;oBACF;gBACF;gBAEA,MAAM0B,OAGDL,gBAAgBK,QAAQ,EAAE;gBAE/B,MAAM,CAACC,UAAU,GAAGC,gBAAgB,GAAGF;gBAEvC,yEAAyE;gBACzE,wGAAwG;gBACxG,IAAIE,gBAAgBC,MAAM,GAAG,GAAG;oBAC9B,IAAI;wBACF,MAAMC,oBAAoBF,gBAAgBG,GAAG,CAAC,CAAC,EAAE/B,EAAE,EAAE,GAAKA;wBAC1D,MAAMF,QAAQkC,MAAM,CAAC;4BACnBtC,YAAY;4BACZG;4BACA2B,OAAO;gCAAExB,IAAI;oCAAEiC,IAAIH;gCAAkB;4BAAE;wBACzC;oBACF,EAAE,OAAOf,KAAc;wBACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAAC,CAAC,4CAA4C,CAAC;oBACrE;gBACF;gBAEA,IAAIU,UAAU;oBACZ,MAAM,EAAE3B,IAAIkC,WAAW,EAAE,GAAGP;oBAE5B,IAAIT,QAAQ;wBACV,0BAA0B;wBAC1B,IAAI;4BACF,MAAMpB,QAAQqC,MAAM,CAAC;gCACnBnC,IAAIkC;gCACJxC,YAAY;gCACZ0B,MAAM;oCACJ,GAAGZ,UAAU;oCACbM,UAAUa,SAASb,QAAQ,IAAID;gCACjC;gCACAhB;4BACF;wBACF,EAAE,OAAOkB,KAAc;4BACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAAC,CAAC,+BAA+B,CAAC;wBACxD;oBACF;oBACA,IAAIX,gBAAgBJ,WAAW,SAAS;wBACtC,oEAAoE;wBACpE,IAAI;4BACF,MAAMJ,QAAQkC,MAAM,CAAC;gCACnBhC,IAAIkC;gCACJxC,YAAY;gCACZG;4BACF;wBACF,EAAE,OAAOkB,KAAc;4BACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAAC,CAAC,gCAAgC,EAAEF,IAAI,CAAC;wBAC/D;oBACF;gBACF,OAAO,IAAIG,QAAQ;oBACjB,IAAI;wBACF,MAAMpB,QAAQqB,MAAM,CAAC;4BACnBzB,YAAY;4BACZ0B,MAAM;gCACJ,GAAGZ,UAAU;gCACbM,UAAUD;4BACZ;4BACAhB;wBACF;oBACF,EAAE,OAAOkB,KAAc;wBACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAAC,CAAC,gCAAgC,EAAEF,IAAI,CAAC;oBAC/D;gBACF;YACF,EAAE,OAAOA,KAAc;gBACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAAC,CAAC,+BAA+B,EAAEF,IAAI,CAAC;YAC9D;QACF;IACF,EAAE,OAAOA,KAAc;QACrBjB,QAAQkB,MAAM,CAACC,KAAK,CAClB,CAAC,yCAAyC,EAAEvB,WAAW,WAAW,EAAEM,GAAG,GAAG,EAAEe,IAAI,CAAC;IAErF;IAEA,OAAOpB;AACT;AAEA,eAAeH,eAAc"}

package/dist/Search/index.d.ts

@@ -1,3 +1,4 @@
 import type { CollectionConfig } from 'payload/types';
-import type { SearchConfig } from '../types';
+import type { SearchConfig } from '../types.js';
 export declare const generateSearchCollection: (searchConfig: SearchConfig) => CollectionConfig;
+//# sourceMappingURL=index.d.ts.map

package/dist/Search/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Search/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAIrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAK/C,eAAO,MAAM,wBAAwB,iBAAkB,YAAY,KAAG,gBA2DnE,CAAA"}