@payloadcms/plugin-search 4.0.0-canary.7 → 4.0.0-canary.9

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import type { Config } from 'payload';
 import type { SearchPluginConfig } from './types.js';
-export declare const searchPlugin: <ConfigTypes = unknown>(incomingPluginConfig: SearchPluginConfig<ConfigTypes>) => (config: Config) => Config;
+export declare const searchPlugin: (options: SearchPluginConfig) => import("payload").Plugin;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA6B,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhE,OAAO,KAAK,EAA+B,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAQjF,eAAO,MAAM,YAAY,GACtB,WAAW,GAAG,OAAO,EAAE,sBAAsB,kBAAkB,CAAC,WAAW,CAAC,MAC5E,QAAQ,MAAM,KAAG,MA2EjB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAA+B,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAQjF,eAAO,MAAM,YAAY,2DA8EvB,CAAA"}

package/dist/index.js

@@ -1,7 +1,10 @@
+import { definePlugin } from 'payload';
 import { deleteFromSearch } from './Search/hooks/deleteFromSearch.js';
 import { syncWithSearch } from './Search/hooks/syncWithSearch.js';
 import { generateSearchCollection } from './Search/index.js';
-export const searchPlugin = (incomingPluginConfig)=>(config)=>{
+export const searchPlugin = definePlugin({
+    slug: '@payloadcms/plugin-search',
+    plugin: ({ config, options: incomingPluginConfig })=>{
         const { collections } = config;
         // If the user defines `localize` to either true or false, use that
         // Otherwise, set it based on if their config has localization enabled or disabled
@@ -62,6 +65,7 @@ export const searchPlugin = (incomingPluginConfig)=>(config)=>{
             };
         }
         return config;
-    };
+    }
+});
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionAfterChangeHook, Config } from 'payload'\n\nimport type { SanitizedSearchPluginConfig, SearchPluginConfig } from './types.js'\n\nimport { deleteFromSearch } from './Search/hooks/deleteFromSearch.js'\nimport { syncWithSearch } from './Search/hooks/syncWithSearch.js'\nimport { generateSearchCollection } from './Search/index.js'\n\ntype CollectionAfterChangeHookArgs = Parameters<CollectionAfterChangeHook>[0]\n\nexport const searchPlugin =\n  <ConfigTypes = unknown>(incomingPluginConfig: SearchPluginConfig<ConfigTypes>) =>\n  (config: Config): Config => {\n    const { collections } = config\n\n    // If the user defines `localize` to either true or false, use that\n    // Otherwise, set it based on if their config has localization enabled or disabled\n    const shouldLocalize =\n      typeof incomingPluginConfig.localize === 'boolean'\n        ? incomingPluginConfig.localize\n        : Boolean(config.localization)\n    incomingPluginConfig.localize = shouldLocalize\n\n    if (collections) {\n      // O(1) slug lookup for enabled-collection checks; replaces an Array.indexOf in the\n      // hook-attachment pass that was O(M) per collection.\n      const enabledSlugSet = new Set(incomingPluginConfig.collections ?? [])\n\n      const labels: Record<string, (typeof collections)[number]['labels']> = {}\n      for (const collection of collections) {\n        if (enabledSlugSet.has(collection.slug)) {\n          labels[collection.slug] = collection.labels\n        }\n      }\n\n      const pluginConfig: SanitizedSearchPluginConfig<ConfigTypes> = {\n        // write any config defaults here\n        deleteDrafts: true,\n        labels,\n        reindexBatchSize: incomingPluginConfig?.reindexBatchSize || 50,\n        syncDrafts: false,\n        ...incomingPluginConfig,\n      }\n\n      // add afterChange and afterDelete hooks to every search-enabled collection\n      const collectionsWithSearchHooks = config?.collections\n        ?.map((collection) => {\n          const { hooks: existingHooks } = collection\n\n          const isEnabled = enabledSlugSet.has(collection.slug)\n          if (isEnabled) {\n            return {\n              ...collection,\n              hooks: {\n                ...collection.hooks,\n                afterChange: [\n                  ...(existingHooks?.afterChange || []),\n                  async (args: CollectionAfterChangeHookArgs) => {\n                    await syncWithSearch({\n                      ...args,\n                      collection: collection.slug,\n                      pluginConfig,\n                    })\n                  },\n                ],\n                beforeDelete: [\n                  ...(existingHooks?.beforeDelete || []),\n                  deleteFromSearch(pluginConfig),\n                ],\n              },\n            }\n          }\n\n          return collection\n        })\n        .filter(Boolean)\n\n      return {\n        ...config,\n        collections: [\n          ...(collectionsWithSearchHooks || []),\n          generateSearchCollection(pluginConfig),\n        ],\n      }\n    }\n\n    return config\n  }\n"],"names":["deleteFromSearch","syncWithSearch","generateSearchCollection","searchPlugin","incomingPluginConfig","config","collections","shouldLocalize","localize","Boolean","localization","enabledSlugSet","Set","labels","collection","has","slug","pluginConfig","deleteDrafts","reindexBatchSize","syncDrafts","collectionsWithSearchHooks","map","hooks","existingHooks","isEnabled","afterChange","args","beforeDelete","filter"],"mappings":"AAIA,SAASA,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,cAAc,QAAQ,mCAAkC;AACjE,SAASC,wBAAwB,QAAQ,oBAAmB;AAI5D,OAAO,MAAMC,eACX,CAAwBC,uBACxB,CAACC;QACC,MAAM,EAAEC,WAAW,EAAE,GAAGD;QAExB,mEAAmE;QACnE,kFAAkF;QAClF,MAAME,iBACJ,OAAOH,qBAAqBI,QAAQ,KAAK,YACrCJ,qBAAqBI,QAAQ,GAC7BC,QAAQJ,OAAOK,YAAY;QACjCN,qBAAqBI,QAAQ,GAAGD;QAEhC,IAAID,aAAa;YACf,mFAAmF;YACnF,qDAAqD;YACrD,MAAMK,iBAAiB,IAAIC,IAAIR,qBAAqBE,WAAW,IAAI,EAAE;YAErE,MAAMO,SAAiE,CAAC;YACxE,KAAK,MAAMC,cAAcR,YAAa;gBACpC,IAAIK,eAAeI,GAAG,CAACD,WAAWE,IAAI,GAAG;oBACvCH,MAAM,CAACC,WAAWE,IAAI,CAAC,GAAGF,WAAWD,MAAM;gBAC7C;YACF;YAEA,MAAMI,eAAyD;gBAC7D,iCAAiC;gBACjCC,cAAc;gBACdL;gBACAM,kBAAkBf,sBAAsBe,oBAAoB;gBAC5DC,YAAY;gBACZ,GAAGhB,oBAAoB;YACzB;YAEA,2EAA2E;YAC3E,MAAMiB,6BAA6BhB,QAAQC,aACvCgB,IAAI,CAACR;gBACL,MAAM,EAAES,OAAOC,aAAa,EAAE,GAAGV;gBAEjC,MAAMW,YAAYd,eAAeI,GAAG,CAACD,WAAWE,IAAI;gBACpD,IAAIS,WAAW;oBACb,OAAO;wBACL,GAAGX,UAAU;wBACbS,OAAO;4BACL,GAAGT,WAAWS,KAAK;4BACnBG,aAAa;mCACPF,eAAeE,eAAe,EAAE;gCACpC,OAAOC;oCACL,MAAM1B,eAAe;wCACnB,GAAG0B,IAAI;wCACPb,YAAYA,WAAWE,IAAI;wCAC3BC;oCACF;gCACF;6BACD;4BACDW,cAAc;mCACRJ,eAAeI,gBAAgB,EAAE;gCACrC5B,iBAAiBiB;6BAClB;wBACH;oBACF;gBACF;gBAEA,OAAOH;YACT,GACCe,OAAOpB;YAEV,OAAO;gBACL,GAAGJ,MAAM;gBACTC,aAAa;uBACPe,8BAA8B,EAAE;oBACpCnB,yBAAyBe;iBAC1B;YACH;QACF;QAEA,OAAOZ;IACT,EAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionAfterChangeHook } from 'payload'\n\nimport { definePlugin } from 'payload'\n\nimport type { SanitizedSearchPluginConfig, SearchPluginConfig } from './types.js'\n\nimport { deleteFromSearch } from './Search/hooks/deleteFromSearch.js'\nimport { syncWithSearch } from './Search/hooks/syncWithSearch.js'\nimport { generateSearchCollection } from './Search/index.js'\n\ntype CollectionAfterChangeHookArgs = Parameters<CollectionAfterChangeHook>[0]\n\nexport const searchPlugin = definePlugin<SearchPluginConfig>({\n  slug: '@payloadcms/plugin-search',\n  plugin: ({ config, options: incomingPluginConfig }) => {\n    const { collections } = config\n\n    // If the user defines `localize` to either true or false, use that\n    // Otherwise, set it based on if their config has localization enabled or disabled\n    const shouldLocalize =\n      typeof incomingPluginConfig.localize === 'boolean'\n        ? incomingPluginConfig.localize\n        : Boolean(config.localization)\n    incomingPluginConfig.localize = shouldLocalize\n\n    if (collections) {\n      // O(1) slug lookup for enabled-collection checks; replaces an Array.indexOf in the\n      // hook-attachment pass that was O(M) per collection.\n      const enabledSlugSet = new Set(incomingPluginConfig.collections ?? [])\n\n      const labels: Record<string, (typeof collections)[number]['labels']> = {}\n      for (const collection of collections) {\n        if (enabledSlugSet.has(collection.slug)) {\n          labels[collection.slug] = collection.labels\n        }\n      }\n\n      const pluginConfig: SanitizedSearchPluginConfig = {\n        // write any config defaults here\n        deleteDrafts: true,\n        labels,\n        reindexBatchSize: incomingPluginConfig?.reindexBatchSize || 50,\n        syncDrafts: false,\n        ...incomingPluginConfig,\n      }\n\n      // add afterChange and afterDelete hooks to every search-enabled collection\n      const collectionsWithSearchHooks = config?.collections\n        ?.map((collection) => {\n          const { hooks: existingHooks } = collection\n\n          const isEnabled = enabledSlugSet.has(collection.slug)\n          if (isEnabled) {\n            return {\n              ...collection,\n              hooks: {\n                ...collection.hooks,\n                afterChange: [\n                  ...(existingHooks?.afterChange || []),\n                  async (args: CollectionAfterChangeHookArgs) => {\n                    await syncWithSearch({\n                      ...args,\n                      collection: collection.slug,\n                      pluginConfig,\n                    })\n                  },\n                ],\n                beforeDelete: [\n                  ...(existingHooks?.beforeDelete || []),\n                  deleteFromSearch(pluginConfig),\n                ],\n              },\n            }\n          }\n\n          return collection\n        })\n        .filter(Boolean)\n\n      return {\n        ...config,\n        collections: [\n          ...(collectionsWithSearchHooks || []),\n          generateSearchCollection(pluginConfig),\n        ],\n      }\n    }\n\n    return config\n  },\n})\n"],"names":["definePlugin","deleteFromSearch","syncWithSearch","generateSearchCollection","searchPlugin","slug","plugin","config","options","incomingPluginConfig","collections","shouldLocalize","localize","Boolean","localization","enabledSlugSet","Set","labels","collection","has","pluginConfig","deleteDrafts","reindexBatchSize","syncDrafts","collectionsWithSearchHooks","map","hooks","existingHooks","isEnabled","afterChange","args","beforeDelete","filter"],"mappings":"AAEA,SAASA,YAAY,QAAQ,UAAS;AAItC,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,cAAc,QAAQ,mCAAkC;AACjE,SAASC,wBAAwB,QAAQ,oBAAmB;AAI5D,OAAO,MAAMC,eAAeJ,aAAiC;IAC3DK,MAAM;IACNC,QAAQ,CAAC,EAAEC,MAAM,EAAEC,SAASC,oBAAoB,EAAE;QAChD,MAAM,EAAEC,WAAW,EAAE,GAAGH;QAExB,mEAAmE;QACnE,kFAAkF;QAClF,MAAMI,iBACJ,OAAOF,qBAAqBG,QAAQ,KAAK,YACrCH,qBAAqBG,QAAQ,GAC7BC,QAAQN,OAAOO,YAAY;QACjCL,qBAAqBG,QAAQ,GAAGD;QAEhC,IAAID,aAAa;YACf,mFAAmF;YACnF,qDAAqD;YACrD,MAAMK,iBAAiB,IAAIC,IAAIP,qBAAqBC,WAAW,IAAI,EAAE;YAErE,MAAMO,SAAiE,CAAC;YACxE,KAAK,MAAMC,cAAcR,YAAa;gBACpC,IAAIK,eAAeI,GAAG,CAACD,WAAWb,IAAI,GAAG;oBACvCY,MAAM,CAACC,WAAWb,IAAI,CAAC,GAAGa,WAAWD,MAAM;gBAC7C;YACF;YAEA,MAAMG,eAA4C;gBAChD,iCAAiC;gBACjCC,cAAc;gBACdJ;gBACAK,kBAAkBb,sBAAsBa,oBAAoB;gBAC5DC,YAAY;gBACZ,GAAGd,oBAAoB;YACzB;YAEA,2EAA2E;YAC3E,MAAMe,6BAA6BjB,QAAQG,aACvCe,IAAI,CAACP;gBACL,MAAM,EAAEQ,OAAOC,aAAa,EAAE,GAAGT;gBAEjC,MAAMU,YAAYb,eAAeI,GAAG,CAACD,WAAWb,IAAI;gBACpD,IAAIuB,WAAW;oBACb,OAAO;wBACL,GAAGV,UAAU;wBACbQ,OAAO;4BACL,GAAGR,WAAWQ,KAAK;4BACnBG,aAAa;mCACPF,eAAeE,eAAe,EAAE;gCACpC,OAAOC;oCACL,MAAM5B,eAAe;wCACnB,GAAG4B,IAAI;wCACPZ,YAAYA,WAAWb,IAAI;wCAC3Be;oCACF;gCACF;6BACD;4BACDW,cAAc;mCACRJ,eAAeI,gBAAgB,EAAE;gCACrC9B,iBAAiBmB;6BAClB;wBACH;oBACF;gBACF;gBAEA,OAAOF;YACT,GACCc,OAAOnB;YAEV,OAAO;gBACL,GAAGN,MAAM;gBACTG,aAAa;uBACPc,8BAA8B,EAAE;oBACpCrB,yBAAyBiB;iBAC1B;YACH;QACF;QAEA,OAAOb;IACT;AACF,GAAE"}

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { CollectionAfterChangeHook, CollectionBeforeDeleteHook, CollectionConfig, Field, Locale, Payload, PayloadRequest, StaticLabel } from 'payload';
+import type { CollectionAfterChangeHook, CollectionBeforeDeleteHook, CollectionConfig, Field, Locale, Payload, PayloadRequest, StaticLabel, TypedLocale } from 'payload';
 export type DocToSync = {
     [key: string]: any;
     doc: {
@@ -19,15 +19,13 @@ export type BeforeSync = (args: {
 export type FieldsOverride = (args: {
     defaultFields: Field[];
 }) => Field[];
-export type SkipSyncFunction<ConfigTypes = unknown> = (args: {
+export type SkipSyncFunction = (args: {
     collectionSlug: string;
     doc: any;
-    locale: ConfigTypes extends {
-        locale: unknown;
-    } ? ConfigTypes['locale'] : string | undefined;
+    locale: TypedLocale | undefined;
     req: PayloadRequest;
 }) => boolean | Promise<boolean>;
-export type SearchPluginConfig<ConfigTypes = unknown> = {
+export type SearchPluginConfig = {
     beforeSync?: BeforeSync;
     collections?: string[];
     defaultPriorities?: {
@@ -69,7 +67,7 @@ export type SearchPluginConfig<ConfigTypes = unknown> = {
      *   return !tenant.allowedLocales.includes(locale)
      * }
      */
-    skipSync?: SkipSyncFunction<ConfigTypes>;
+    skipSync?: SkipSyncFunction;
     /**
      * Controls whether drafts are synced to the search index
      *
@@ -83,13 +81,13 @@ export type CollectionLabels = {
 export type ResolvedCollectionLabels = {
     [collection: string]: StaticLabel;
 };
-export type SearchPluginConfigWithLocales<ConfigTypes = unknown> = {
+export type SearchPluginConfigWithLocales = {
     labels?: CollectionLabels;
-} & SearchPluginConfig<ConfigTypes>;
-export type SanitizedSearchPluginConfig<ConfigTypes = unknown> = {
+} & SearchPluginConfig;
+export type SanitizedSearchPluginConfig = {
     reindexBatchSize: number;
     syncDrafts: boolean;
-} & SearchPluginConfigWithLocales<ConfigTypes>;
+} & SearchPluginConfigWithLocales;
 export type SyncWithSearchArgs = {
     collection: string;
     pluginConfig: SanitizedSearchPluginConfig;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,gBAAgB,EAChB,KAAK,EACL,MAAM,EACN,OAAO,EACP,cAAc,EACd,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;IAClB,GAAG,EAAE;QACH,UAAU,EAAE,MAAM,CAAA;QAClB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE;IAC9B,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,CAAA;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,cAAc,CAAA;IACnB,SAAS,EAAE,SAAS,CAAA;CACrB,KAAK,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;AAEpC,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE;IAAE,aAAa,EAAE,KAAK,EAAE,CAAA;CAAE,KAAK,KAAK,EAAE,CAAA;AAE1E,MAAM,MAAM,gBAAgB,CAAC,WAAW,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE;IAC3D,cAAc,EAAE,MAAM,CAAA;IACtB,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,WAAW,SAAS;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,MAAM,GAAG,SAAS,CAAA;IAC5F,GAAG,EAAE,cAAc,CAAA;CACpB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAEhC,MAAM,MAAM,kBAAkB,CAAC,WAAW,GAAG,OAAO,IAAI;IACtD,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,iBAAiB,CAAC,EAAE;QAClB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAA;KACxE,CAAA;IACD;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,eAAe,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAA;IACzF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAA;IACxC;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAA;CACjD,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,UAAU,EAAE,MAAM,GAAG,WAAW,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,6BAA6B,CAAC,WAAW,GAAG,OAAO,IAAI;IACjE,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAA;AAEnC,MAAM,MAAM,2BAA2B,CAAC,WAAW,GAAG,OAAO,IAAI;IAC/D,gBAAgB,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,OAAO,CAAA;CACpB,GAAG,6BAA6B,CAAC,WAAW,CAAC,CAAA;AAE9C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,2BAA2B,CAAA;CAC1C,GAAG,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAA;AAEhE,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;CACzB,GAAG,IAAI,CAAC,kBAAkB,EAAE,SAAS,GAAG,aAAa,CAAC,CAAA;AAIvD,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,UAAU,CAAC,yBAAyB,CAAC,CAAA;AAEhG,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,0BAA0B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,gBAAgB,EAChB,KAAK,EACL,MAAM,EACN,OAAO,EACP,cAAc,EACd,WAAW,EACX,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;IAClB,GAAG,EAAE;QACH,UAAU,EAAE,MAAM,CAAA;QAClB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE;IAC9B,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,CAAA;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,cAAc,CAAA;IACnB,SAAS,EAAE,SAAS,CAAA;CACrB,KAAK,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;AAEpC,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE;IAAE,aAAa,EAAE,KAAK,EAAE,CAAA;CAAE,KAAK,KAAK,EAAE,CAAA;AAE1E,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE;IACpC,cAAc,EAAE,MAAM,CAAA;IACtB,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,WAAW,GAAG,SAAS,CAAA;IAC/B,GAAG,EAAE,cAAc,CAAA;CACpB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAEhC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,iBAAiB,CAAC,EAAE;QAClB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAA;KACxE,CAAA;IACD;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,eAAe,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAA;IACzF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAA;CACjD,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,UAAU,EAAE,MAAM,GAAG,WAAW,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B,GAAG,kBAAkB,CAAA;AAEtB,MAAM,MAAM,2BAA2B,GAAG;IACxC,gBAAgB,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,OAAO,CAAA;CACpB,GAAG,6BAA6B,CAAA;AAEjC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,2BAA2B,CAAA;CAC1C,GAAG,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAA;AAEhE,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;CACzB,GAAG,IAAI,CAAC,kBAAkB,EAAE,SAAS,GAAG,aAAa,CAAC,CAAA;AAIvD,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,UAAU,CAAC,yBAAyB,CAAC,CAAA;AAEhG,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,0BAA0B,CAAA"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  CollectionAfterChangeHook,\n  CollectionBeforeDeleteHook,\n  CollectionConfig,\n  Field,\n  Locale,\n  Payload,\n  PayloadRequest,\n  StaticLabel,\n} from 'payload'\n\nexport type DocToSync = {\n  [key: string]: any\n  doc: {\n    relationTo: string\n    value: string\n  }\n  title: string\n}\n\nexport type BeforeSync = (args: {\n  collectionSlug: string\n  originalDoc: {\n    [key: string]: any\n  }\n  payload: Payload\n  req: PayloadRequest\n  searchDoc: DocToSync\n}) => DocToSync | Promise<DocToSync>\n\nexport type FieldsOverride = (args: { defaultFields: Field[] }) => Field[]\n\nexport type SkipSyncFunction<ConfigTypes = unknown> = (args: {\n  collectionSlug: string\n  doc: any\n  locale: ConfigTypes extends { locale: unknown } ? ConfigTypes['locale'] : string | undefined\n  req: PayloadRequest\n}) => boolean | Promise<boolean>\n\nexport type SearchPluginConfig<ConfigTypes = unknown> = {\n  beforeSync?: BeforeSync\n  collections?: string[]\n  defaultPriorities?: {\n    [collection: string]: ((doc: any) => number | Promise<number>) | number\n  }\n  /**\n   * Controls whether drafts are deleted from the search index\n   *\n   * @default true\n   */\n  deleteDrafts?: boolean\n  localize?: boolean\n  /**\n   * We use batching when re-indexing large collections. You can control the amount of items per batch, lower numbers should help with memory.\n   *\n   * @default 50\n   */\n  reindexBatchSize?: number\n  searchOverrides?: { fields?: FieldsOverride } & Partial<Omit<CollectionConfig, 'fields'>>\n  /**\n   * Determine whether to skip syncing a document for a specific locale.\n   * Useful for multi-tenant applications, conditional indexing, or any scenario where\n   * sync behavior should vary by locale, document, or other factors.\n   *\n   * @default undefined - All configured locales will be synced\n   *\n   * @example\n   * // Skip syncing based on document's tenant settings\n   * skipSync: async ({ locale, req, doc, collectionSlug }) => {\n   *   // For non-localized collections, locale will be undefined\n   *   if (!locale) return false\n   *\n   *   const tenant = await req.payload.findByID({\n   *     collection: 'tenants',\n   *     id: doc.tenant.id\n   *   })\n   *   return !tenant.allowedLocales.includes(locale)\n   * }\n   */\n  skipSync?: SkipSyncFunction<ConfigTypes>\n  /**\n   * Controls whether drafts are synced to the search index\n   *\n   * @default false\n   */\n  syncDrafts?: boolean\n}\n\nexport type CollectionLabels = {\n  [collection: string]: CollectionConfig['labels']\n}\n\nexport type ResolvedCollectionLabels = {\n  [collection: string]: StaticLabel\n}\n\nexport type SearchPluginConfigWithLocales<ConfigTypes = unknown> = {\n  labels?: CollectionLabels\n} & SearchPluginConfig<ConfigTypes>\n\nexport type SanitizedSearchPluginConfig<ConfigTypes = unknown> = {\n  reindexBatchSize: number\n  syncDrafts: boolean\n} & SearchPluginConfigWithLocales<ConfigTypes>\n\nexport type SyncWithSearchArgs = {\n  collection: string\n  pluginConfig: SanitizedSearchPluginConfig\n} & Omit<Parameters<CollectionAfterChangeHook>[0], 'collection'>\n\nexport type SyncDocArgs = {\n  locale?: Locale['code']\n  onSyncError?: () => void\n} & Omit<SyncWithSearchArgs, 'context' | 'previousDoc'>\n\n// Extend the `CollectionAfterChangeHook` with more function args\n// Convert the `collection` arg from `SanitizedCollectionConfig` to a string\nexport type SyncWithSearch = (Args: SyncWithSearchArgs) => ReturnType<CollectionAfterChangeHook>\n\nexport type DeleteFromSearch = (args: SearchPluginConfig) => CollectionBeforeDeleteHook\n"],"names":[],"mappings":"AAuHA,WAAuF"}
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  CollectionAfterChangeHook,\n  CollectionBeforeDeleteHook,\n  CollectionConfig,\n  Field,\n  Locale,\n  Payload,\n  PayloadRequest,\n  StaticLabel,\n  TypedLocale,\n} from 'payload'\n\nexport type DocToSync = {\n  [key: string]: any\n  doc: {\n    relationTo: string\n    value: string\n  }\n  title: string\n}\n\nexport type BeforeSync = (args: {\n  collectionSlug: string\n  originalDoc: {\n    [key: string]: any\n  }\n  payload: Payload\n  req: PayloadRequest\n  searchDoc: DocToSync\n}) => DocToSync | Promise<DocToSync>\n\nexport type FieldsOverride = (args: { defaultFields: Field[] }) => Field[]\n\nexport type SkipSyncFunction = (args: {\n  collectionSlug: string\n  doc: any\n  locale: TypedLocale | undefined\n  req: PayloadRequest\n}) => boolean | Promise<boolean>\n\nexport type SearchPluginConfig = {\n  beforeSync?: BeforeSync\n  collections?: string[]\n  defaultPriorities?: {\n    [collection: string]: ((doc: any) => number | Promise<number>) | number\n  }\n  /**\n   * Controls whether drafts are deleted from the search index\n   *\n   * @default true\n   */\n  deleteDrafts?: boolean\n  localize?: boolean\n  /**\n   * We use batching when re-indexing large collections. You can control the amount of items per batch, lower numbers should help with memory.\n   *\n   * @default 50\n   */\n  reindexBatchSize?: number\n  searchOverrides?: { fields?: FieldsOverride } & Partial<Omit<CollectionConfig, 'fields'>>\n  /**\n   * Determine whether to skip syncing a document for a specific locale.\n   * Useful for multi-tenant applications, conditional indexing, or any scenario where\n   * sync behavior should vary by locale, document, or other factors.\n   *\n   * @default undefined - All configured locales will be synced\n   *\n   * @example\n   * // Skip syncing based on document's tenant settings\n   * skipSync: async ({ locale, req, doc, collectionSlug }) => {\n   *   // For non-localized collections, locale will be undefined\n   *   if (!locale) return false\n   *\n   *   const tenant = await req.payload.findByID({\n   *     collection: 'tenants',\n   *     id: doc.tenant.id\n   *   })\n   *   return !tenant.allowedLocales.includes(locale)\n   * }\n   */\n  skipSync?: SkipSyncFunction\n  /**\n   * Controls whether drafts are synced to the search index\n   *\n   * @default false\n   */\n  syncDrafts?: boolean\n}\n\nexport type CollectionLabels = {\n  [collection: string]: CollectionConfig['labels']\n}\n\nexport type ResolvedCollectionLabels = {\n  [collection: string]: StaticLabel\n}\n\nexport type SearchPluginConfigWithLocales = {\n  labels?: CollectionLabels\n} & SearchPluginConfig\n\nexport type SanitizedSearchPluginConfig = {\n  reindexBatchSize: number\n  syncDrafts: boolean\n} & SearchPluginConfigWithLocales\n\nexport type SyncWithSearchArgs = {\n  collection: string\n  pluginConfig: SanitizedSearchPluginConfig\n} & Omit<Parameters<CollectionAfterChangeHook>[0], 'collection'>\n\nexport type SyncDocArgs = {\n  locale?: Locale['code']\n  onSyncError?: () => void\n} & Omit<SyncWithSearchArgs, 'context' | 'previousDoc'>\n\n// Extend the `CollectionAfterChangeHook` with more function args\n// Convert the `collection` arg from `SanitizedCollectionConfig` to a string\nexport type SyncWithSearch = (Args: SyncWithSearchArgs) => ReturnType<CollectionAfterChangeHook>\n\nexport type DeleteFromSearch = (args: SearchPluginConfig) => CollectionBeforeDeleteHook\n"],"names":[],"mappings":"AAwHA,WAAuF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/plugin-search",
-  "version": "4.0.0-canary.7",
+  "version": "4.0.0-canary.9",
   "description": "Search plugin for Payload",
   "keywords": [
     "payload",
@@ -50,19 +50,19 @@
     "dist"
   ],
   "dependencies": {
-    "@payloadcms/next": "4.0.0-canary.7",
-    "@payloadcms/ui": "4.0.0-canary.7"
+    "@payloadcms/next": "4.0.0-canary.9",
+    "@payloadcms/ui": "4.0.0-canary.9"
   },
   "devDependencies": {
     "@types/react": "19.2.14",
     "@types/react-dom": "19.2.3",
     "@payloadcms/eslint-config": "3.28.0",
-    "payload": "4.0.0-canary.7"
+    "payload": "4.0.0-canary.9"
   },
   "peerDependencies": {
     "react": "^19.0.1 || ^19.1.2 || ^19.2.1",
     "react-dom": "^19.0.1 || ^19.1.2 || ^19.2.1",
-    "payload": "4.0.0-canary.7"
+    "payload": "4.0.0-canary.9"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"