@foundrykit/search-plugin 0.2.3 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/activePlugins.d.ts +10 -0
- package/dist/activePlugins.js +27 -0
- package/dist/activePlugins.js.map +1 -0
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Config } from 'payload';
|
|
2
|
+
/**
|
|
3
|
+
* Records this plugin as active in `config.custom.foundrykit.activePlugins`, the list
|
|
4
|
+
* `@foundrykit/guides-plugin` sends to the guides hub so the site gets this plugin's guides.
|
|
5
|
+
* Only call it on the enabled path: installed-but-disabled doesn't count.
|
|
6
|
+
*
|
|
7
|
+
* Every FoundryKit Payload plugin carries its own copy of this file (it's too small for a package);
|
|
8
|
+
* keep them identical.
|
|
9
|
+
*/
|
|
10
|
+
export declare const recordActivePlugin: (config: Config, name: string) => Config;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Records this plugin as active in `config.custom.foundrykit.activePlugins`, the list
|
|
3
|
+
* `@foundrykit/guides-plugin` sends to the guides hub so the site gets this plugin's guides.
|
|
4
|
+
* Only call it on the enabled path: installed-but-disabled doesn't count.
|
|
5
|
+
*
|
|
6
|
+
* Every FoundryKit Payload plugin carries its own copy of this file (it's too small for a package);
|
|
7
|
+
* keep them identical.
|
|
8
|
+
*/ export const recordActivePlugin = (config, name)=>{
|
|
9
|
+
const foundrykit = config.custom?.foundrykit ?? {};
|
|
10
|
+
return {
|
|
11
|
+
...config,
|
|
12
|
+
custom: {
|
|
13
|
+
...config.custom,
|
|
14
|
+
foundrykit: {
|
|
15
|
+
...foundrykit,
|
|
16
|
+
activePlugins: [
|
|
17
|
+
...new Set([
|
|
18
|
+
...foundrykit.activePlugins ?? [],
|
|
19
|
+
name
|
|
20
|
+
])
|
|
21
|
+
]
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
//# sourceMappingURL=activePlugins.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/activePlugins.ts"],"sourcesContent":["import type { Config } from 'payload';\n\n/**\n * Records this plugin as active in `config.custom.foundrykit.activePlugins`, the list\n * `@foundrykit/guides-plugin` sends to the guides hub so the site gets this plugin's guides.\n * Only call it on the enabled path: installed-but-disabled doesn't count.\n *\n * Every FoundryKit Payload plugin carries its own copy of this file (it's too small for a package);\n * keep them identical.\n */\nexport const recordActivePlugin = (config: Config, name: string): Config => {\n const foundrykit = (config.custom?.foundrykit ?? {}) as {\n activePlugins?: string[];\n };\n return {\n ...config,\n custom: {\n ...config.custom,\n foundrykit: {\n ...foundrykit,\n activePlugins: [\n ...new Set([...(foundrykit.activePlugins ?? []), name]),\n ],\n },\n },\n };\n};\n"],"names":["recordActivePlugin","config","name","foundrykit","custom","activePlugins","Set"],"mappings":"AAEA;;;;;;;CAOC,GACD,OAAO,MAAMA,qBAAqB,CAACC,QAAgBC;IACjD,MAAMC,aAAcF,OAAOG,MAAM,EAAED,cAAc,CAAC;IAGlD,OAAO;QACL,GAAGF,MAAM;QACTG,QAAQ;YACN,GAAGH,OAAOG,MAAM;YAChBD,YAAY;gBACV,GAAGA,UAAU;gBACbE,eAAe;uBACV,IAAIC,IAAI;2BAAKH,WAAWE,aAAa,IAAI,EAAE;wBAAGH;qBAAK;iBACvD;YACH;QACF;IACF;AACF,EAAE"}
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { recordActivePlugin } from './activePlugins.js';
|
|
1
2
|
import { searchIndexCache } from './cache.js';
|
|
2
3
|
import { createSearchEventsCollection } from './collections/SearchEvents.js';
|
|
3
4
|
import { createInspectHandler, createReindexHandler, createSearchHandler, createTrackHandler } from './endpoints/handlers.js';
|
|
@@ -74,7 +75,7 @@ export { deviceOf, isBot, parseTrackPayload, recordSearchEvent } from './track.j
|
|
|
74
75
|
}
|
|
75
76
|
] : []
|
|
76
77
|
];
|
|
77
|
-
return config;
|
|
78
|
+
return recordActivePlugin(config, '@foundrykit/search-plugin');
|
|
78
79
|
};
|
|
79
80
|
|
|
80
81
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Config } from 'payload';\nimport { searchIndexCache } from './cache.js';\nimport { createSearchEventsCollection } from './collections/SearchEvents.js';\nimport {\n createInspectHandler,\n createReindexHandler,\n createSearchHandler,\n createTrackHandler,\n} from './endpoints/handlers.js';\nimport { assertConfig, resolveAnalytics } from './options.js';\nimport type { SearchPluginConfig } from './types.js';\n\nexport { aggregateEvents, cleanSearchTerm } from './analytics.js';\nexport { SearchIndexCache, searchIndexCache } from './cache.js';\nexport { decodeEntities } from './decodeEntities.js';\nexport { hrefFor, projectDocs } from './project.js';\nexport {\n DEFAULT_FIELDS,\n DEFAULT_FUZZY,\n groupResults,\n presetResults,\n rankDocs,\n} from './rank.js';\nexport { createSearchService } from './resolve.js';\nexport type { ShownResult, TrackPayload } from './track.js';\nexport {\n deviceOf,\n isBot,\n parseTrackPayload,\n recordSearchEvent,\n} from './track.js';\nexport type * from './types.js';\n\n/**\n * Cached, grouped and ranked site search over the `@payloadcms/plugin-search` index.\n *\n * Layered on top of plugin-search rather than replacing it: that plugin already keeps a `search`\n * collection in sync through afterChange/afterDelete hooks, and sync is the part of an index\n * implementation that rots. This owns the read side — projection, caching, fuzzy ranking,\n * grouping — plus the operational surface an editor needs.\n *\n * Install it AFTER searchPlugin in the plugins array, since it reads the collection that one\n * creates.\n */\nexport const searchPlugin =\n (pluginOptions: SearchPluginConfig) =>\n (config: Config): Config => {\n if (pluginOptions.disabled) {\n return config;\n }\n\n assertConfig(pluginOptions);\n\n const analytics = resolveAnalytics(pluginOptions.analytics);\n const prefix = pluginOptions.routePrefix ?? '/site-search';\n const requireAdmin = pluginOptions.requireAdminForOperations ?? true;\n\n searchIndexCache.configure(pluginOptions.cacheTTL ?? 60_000);\n\n if (analytics.enabled) {\n config.collections = [\n ...(config.collections || []),\n createSearchEventsCollection({ slug: analytics.collectionSlug }),\n ];\n }\n\n config.endpoints = [\n ...(config.endpoints || []),\n {\n handler: createSearchHandler({\n cache: searchIndexCache,\n config: pluginOptions,\n }),\n method: 'get',\n path: prefix,\n },\n {\n handler: createReindexHandler({\n cache: searchIndexCache,\n config: pluginOptions,\n requireAdmin,\n }),\n method: 'post',\n path: `${prefix}/reindex`,\n },\n {\n handler: createInspectHandler({\n cache: searchIndexCache,\n config: pluginOptions,\n requireAdmin,\n }),\n method: 'get',\n path: `${prefix}/inspect`,\n },\n ...(analytics.enabled\n ? [\n {\n handler: createTrackHandler({ config: pluginOptions }),\n method: 'post' as const,\n path: `${prefix}/track`,\n },\n ]\n : []),\n ];\n\n return config;\n };\n"],"names":["searchIndexCache","createSearchEventsCollection","createInspectHandler","createReindexHandler","createSearchHandler","createTrackHandler","assertConfig","resolveAnalytics","aggregateEvents","cleanSearchTerm","SearchIndexCache","decodeEntities","hrefFor","projectDocs","DEFAULT_FIELDS","DEFAULT_FUZZY","groupResults","presetResults","rankDocs","createSearchService","deviceOf","isBot","parseTrackPayload","recordSearchEvent","searchPlugin","pluginOptions","config","disabled","analytics","prefix","routePrefix","requireAdmin","requireAdminForOperations","configure","cacheTTL","enabled","collections","slug","collectionSlug","endpoints","handler","cache","method","path"],"mappings":"AACA,SAASA,gBAAgB,QAAQ,aAAa;AAC9C,SAASC,4BAA4B,QAAQ,gCAAgC;AAC7E,SACEC,oBAAoB,EACpBC,oBAAoB,EACpBC,mBAAmB,EACnBC,kBAAkB,QACb,0BAA0B;AACjC,SAASC,YAAY,EAAEC,gBAAgB,QAAQ,eAAe;AAG9D,SAASC,eAAe,EAAEC,eAAe,QAAQ,iBAAiB;AAClE,SAASC,gBAAgB,EAAEV,gBAAgB,QAAQ,aAAa;AAChE,SAASW,cAAc,QAAQ,sBAAsB;AACrD,SAASC,OAAO,EAAEC,WAAW,QAAQ,eAAe;AACpD,SACEC,cAAc,EACdC,aAAa,EACbC,YAAY,EACZC,aAAa,EACbC,QAAQ,QACH,YAAY;AACnB,SAASC,mBAAmB,QAAQ,eAAe;AAEnD,SACEC,QAAQ,EACRC,KAAK,EACLC,iBAAiB,EACjBC,iBAAiB,QACZ,aAAa;AAGpB;;;;;;;;;;CAUC,GACD,OAAO,MAAMC,eACX,CAACC,gBACD,CAACC;QACC,IAAID,cAAcE,QAAQ,EAAE;YAC1B,OAAOD;QACT;QAEApB,aAAamB;QAEb,MAAMG,YAAYrB,iBAAiBkB,cAAcG,SAAS;QAC1D,MAAMC,SAASJ,cAAcK,WAAW,IAAI;QAC5C,MAAMC,eAAeN,cAAcO,yBAAyB,IAAI;QAEhEhC,iBAAiBiC,SAAS,CAACR,cAAcS,QAAQ,IAAI;QAErD,IAAIN,UAAUO,OAAO,EAAE;YACrBT,OAAOU,WAAW,GAAG;mBACfV,OAAOU,WAAW,IAAI,EAAE;gBAC5BnC,6BAA6B;oBAAEoC,MAAMT,UAAUU,cAAc;gBAAC;aAC/D;QACH;QAEAZ,OAAOa,SAAS,GAAG;eACbb,OAAOa,SAAS,IAAI,EAAE;YAC1B;gBACEC,SAASpC,oBAAoB;oBAC3BqC,OAAOzC;oBACP0B,QAAQD;gBACV;gBACAiB,QAAQ;gBACRC,MAAMd;YACR;YACA;gBACEW,SAASrC,qBAAqB;oBAC5BsC,OAAOzC;oBACP0B,QAAQD;oBACRM;gBACF;gBACAW,QAAQ;gBACRC,MAAM,GAAGd,OAAO,QAAQ,CAAC;YAC3B;YACA;gBACEW,SAAStC,qBAAqB;oBAC5BuC,OAAOzC;oBACP0B,QAAQD;oBACRM;gBACF;gBACAW,QAAQ;gBACRC,MAAM,GAAGd,OAAO,QAAQ,CAAC;YAC3B;eACID,UAAUO,OAAO,GACjB;gBACE;oBACEK,SAASnC,mBAAmB;wBAAEqB,QAAQD;oBAAc;oBACpDiB,QAAQ;oBACRC,MAAM,GAAGd,OAAO,MAAM,CAAC;gBACzB;aACD,GACD,EAAE;SACP;QAED,
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Config } from 'payload';\nimport { recordActivePlugin } from './activePlugins.js';\nimport { searchIndexCache } from './cache.js';\nimport { createSearchEventsCollection } from './collections/SearchEvents.js';\nimport {\n createInspectHandler,\n createReindexHandler,\n createSearchHandler,\n createTrackHandler,\n} from './endpoints/handlers.js';\nimport { assertConfig, resolveAnalytics } from './options.js';\nimport type { SearchPluginConfig } from './types.js';\n\nexport { aggregateEvents, cleanSearchTerm } from './analytics.js';\nexport { SearchIndexCache, searchIndexCache } from './cache.js';\nexport { decodeEntities } from './decodeEntities.js';\nexport { hrefFor, projectDocs } from './project.js';\nexport {\n DEFAULT_FIELDS,\n DEFAULT_FUZZY,\n groupResults,\n presetResults,\n rankDocs,\n} from './rank.js';\nexport { createSearchService } from './resolve.js';\nexport type { ShownResult, TrackPayload } from './track.js';\nexport {\n deviceOf,\n isBot,\n parseTrackPayload,\n recordSearchEvent,\n} from './track.js';\nexport type * from './types.js';\n\n/**\n * Cached, grouped and ranked site search over the `@payloadcms/plugin-search` index.\n *\n * Layered on top of plugin-search rather than replacing it: that plugin already keeps a `search`\n * collection in sync through afterChange/afterDelete hooks, and sync is the part of an index\n * implementation that rots. This owns the read side — projection, caching, fuzzy ranking,\n * grouping — plus the operational surface an editor needs.\n *\n * Install it AFTER searchPlugin in the plugins array, since it reads the collection that one\n * creates.\n */\nexport const searchPlugin =\n (pluginOptions: SearchPluginConfig) =>\n (config: Config): Config => {\n if (pluginOptions.disabled) {\n return config;\n }\n\n assertConfig(pluginOptions);\n\n const analytics = resolveAnalytics(pluginOptions.analytics);\n const prefix = pluginOptions.routePrefix ?? '/site-search';\n const requireAdmin = pluginOptions.requireAdminForOperations ?? true;\n\n searchIndexCache.configure(pluginOptions.cacheTTL ?? 60_000);\n\n if (analytics.enabled) {\n config.collections = [\n ...(config.collections || []),\n createSearchEventsCollection({ slug: analytics.collectionSlug }),\n ];\n }\n\n config.endpoints = [\n ...(config.endpoints || []),\n {\n handler: createSearchHandler({\n cache: searchIndexCache,\n config: pluginOptions,\n }),\n method: 'get',\n path: prefix,\n },\n {\n handler: createReindexHandler({\n cache: searchIndexCache,\n config: pluginOptions,\n requireAdmin,\n }),\n method: 'post',\n path: `${prefix}/reindex`,\n },\n {\n handler: createInspectHandler({\n cache: searchIndexCache,\n config: pluginOptions,\n requireAdmin,\n }),\n method: 'get',\n path: `${prefix}/inspect`,\n },\n ...(analytics.enabled\n ? [\n {\n handler: createTrackHandler({ config: pluginOptions }),\n method: 'post' as const,\n path: `${prefix}/track`,\n },\n ]\n : []),\n ];\n\n return recordActivePlugin(config, '@foundrykit/search-plugin');\n };\n"],"names":["recordActivePlugin","searchIndexCache","createSearchEventsCollection","createInspectHandler","createReindexHandler","createSearchHandler","createTrackHandler","assertConfig","resolveAnalytics","aggregateEvents","cleanSearchTerm","SearchIndexCache","decodeEntities","hrefFor","projectDocs","DEFAULT_FIELDS","DEFAULT_FUZZY","groupResults","presetResults","rankDocs","createSearchService","deviceOf","isBot","parseTrackPayload","recordSearchEvent","searchPlugin","pluginOptions","config","disabled","analytics","prefix","routePrefix","requireAdmin","requireAdminForOperations","configure","cacheTTL","enabled","collections","slug","collectionSlug","endpoints","handler","cache","method","path"],"mappings":"AACA,SAASA,kBAAkB,QAAQ,qBAAqB;AACxD,SAASC,gBAAgB,QAAQ,aAAa;AAC9C,SAASC,4BAA4B,QAAQ,gCAAgC;AAC7E,SACEC,oBAAoB,EACpBC,oBAAoB,EACpBC,mBAAmB,EACnBC,kBAAkB,QACb,0BAA0B;AACjC,SAASC,YAAY,EAAEC,gBAAgB,QAAQ,eAAe;AAG9D,SAASC,eAAe,EAAEC,eAAe,QAAQ,iBAAiB;AAClE,SAASC,gBAAgB,EAAEV,gBAAgB,QAAQ,aAAa;AAChE,SAASW,cAAc,QAAQ,sBAAsB;AACrD,SAASC,OAAO,EAAEC,WAAW,QAAQ,eAAe;AACpD,SACEC,cAAc,EACdC,aAAa,EACbC,YAAY,EACZC,aAAa,EACbC,QAAQ,QACH,YAAY;AACnB,SAASC,mBAAmB,QAAQ,eAAe;AAEnD,SACEC,QAAQ,EACRC,KAAK,EACLC,iBAAiB,EACjBC,iBAAiB,QACZ,aAAa;AAGpB;;;;;;;;;;CAUC,GACD,OAAO,MAAMC,eACX,CAACC,gBACD,CAACC;QACC,IAAID,cAAcE,QAAQ,EAAE;YAC1B,OAAOD;QACT;QAEApB,aAAamB;QAEb,MAAMG,YAAYrB,iBAAiBkB,cAAcG,SAAS;QAC1D,MAAMC,SAASJ,cAAcK,WAAW,IAAI;QAC5C,MAAMC,eAAeN,cAAcO,yBAAyB,IAAI;QAEhEhC,iBAAiBiC,SAAS,CAACR,cAAcS,QAAQ,IAAI;QAErD,IAAIN,UAAUO,OAAO,EAAE;YACrBT,OAAOU,WAAW,GAAG;mBACfV,OAAOU,WAAW,IAAI,EAAE;gBAC5BnC,6BAA6B;oBAAEoC,MAAMT,UAAUU,cAAc;gBAAC;aAC/D;QACH;QAEAZ,OAAOa,SAAS,GAAG;eACbb,OAAOa,SAAS,IAAI,EAAE;YAC1B;gBACEC,SAASpC,oBAAoB;oBAC3BqC,OAAOzC;oBACP0B,QAAQD;gBACV;gBACAiB,QAAQ;gBACRC,MAAMd;YACR;YACA;gBACEW,SAASrC,qBAAqB;oBAC5BsC,OAAOzC;oBACP0B,QAAQD;oBACRM;gBACF;gBACAW,QAAQ;gBACRC,MAAM,GAAGd,OAAO,QAAQ,CAAC;YAC3B;YACA;gBACEW,SAAStC,qBAAqB;oBAC5BuC,OAAOzC;oBACP0B,QAAQD;oBACRM;gBACF;gBACAW,QAAQ;gBACRC,MAAM,GAAGd,OAAO,QAAQ,CAAC;YAC3B;eACID,UAAUO,OAAO,GACjB;gBACE;oBACEK,SAASnC,mBAAmB;wBAAEqB,QAAQD;oBAAc;oBACpDiB,QAAQ;oBACRC,MAAM,GAAGd,OAAO,MAAM,CAAC;gBACzB;aACD,GACD,EAAE;SACP;QAED,OAAO9B,mBAAmB2B,QAAQ;IACpC,EAAE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@foundrykit/search-plugin",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "A plugin for Payload CMS that provides a cached, grouped and ranked site search over the plugin-search index, with fuzzy matching, editor-controlled relevance and search analytics.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|