@foundrykit/menu-plugin 0.6.2 → 0.6.3

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.
@@ -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 { menuCache } from './cache.js';
2
3
  import { createMenusCollection } from './collections/Menus.js';
3
4
  import { createExportMenusHandler } from './endpoints/exportMenusHandler.js';
@@ -48,7 +49,7 @@ export const menuPlugin = (pluginOptions)=>(config)=>{
48
49
  }
49
50
  ] : []
50
51
  ];
51
- return config;
52
+ return recordActivePlugin(config, '@foundrykit/menu-plugin');
52
53
  };
53
54
 
54
55
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionSlug, Config } from 'payload';\nimport { menuCache } from './cache.js';\nimport { createMenusCollection } from './collections/Menus.js';\nimport { createExportMenusHandler } from './endpoints/exportMenusHandler.js';\nimport { createGetMenuHandler } from './endpoints/getMenuHandler.js';\nimport { createImportMenusHandler } from './endpoints/importMenusHandler.js';\nimport type { DynamicSource } from './types.js';\n\nexport { migrateMegaColumnsToEntries } from './migrations/megaColumnsToEntries.js';\nexport type { DynamicSource } from './types.js';\n\nexport type MenuPluginConfig = {\n baseUrl?: string;\n cacheTTL?: number;\n /** depth used when resolving dynamic mega entry children (default: 1) */\n childrenDepth?: number;\n disabled?: boolean;\n /** sources used to auto-populate dynamic mega entries from related collections */\n dynamicSources?: DynamicSource[];\n enableImportExport?: boolean;\n maxDepth?: number;\n mediaCollection?: CollectionSlug;\n relationTo?: CollectionSlug | CollectionSlug[];\n requireAdminForImportExport?: boolean;\n};\n\nexport const menuPlugin =\n (pluginOptions: MenuPluginConfig) =>\n (config: Config): Config => {\n const cacheTTL = pluginOptions.cacheTTL ?? 60_000;\n const enableImportExport = pluginOptions.enableImportExport ?? true;\n const requireAdminForImportExport =\n pluginOptions.requireAdminForImportExport ?? true;\n\n menuCache.configure(cacheTTL);\n\n config.collections = [\n ...(config.collections || []),\n createMenusCollection({\n baseUrl: pluginOptions.baseUrl,\n childrenDepth: pluginOptions.childrenDepth,\n disabled: pluginOptions.disabled,\n dynamicSources: pluginOptions.dynamicSources,\n maxDepth: pluginOptions.maxDepth,\n mediaCollection: pluginOptions.mediaCollection,\n relationTo: pluginOptions.relationTo,\n }),\n ];\n\n if (pluginOptions.disabled) {\n return config;\n }\n\n config.endpoints = [\n ...(config.endpoints || []),\n {\n handler: createGetMenuHandler(),\n method: 'get',\n path: '/api/menus/:slug',\n },\n ...(enableImportExport\n ? [\n {\n handler: createExportMenusHandler({\n requireAdmin: requireAdminForImportExport,\n }),\n method: 'get' as const,\n path: '/api/menus-export',\n },\n {\n handler: createImportMenusHandler({\n requireAdmin: requireAdminForImportExport,\n }),\n method: 'post' as const,\n path: '/api/menus-import',\n },\n ]\n : []),\n ];\n\n return config;\n };\n"],"names":["menuCache","createMenusCollection","createExportMenusHandler","createGetMenuHandler","createImportMenusHandler","migrateMegaColumnsToEntries","menuPlugin","pluginOptions","config","cacheTTL","enableImportExport","requireAdminForImportExport","configure","collections","baseUrl","childrenDepth","disabled","dynamicSources","maxDepth","mediaCollection","relationTo","endpoints","handler","method","path","requireAdmin"],"mappings":"AACA,SAASA,SAAS,QAAQ,aAAa;AACvC,SAASC,qBAAqB,QAAQ,yBAAyB;AAC/D,SAASC,wBAAwB,QAAQ,oCAAoC;AAC7E,SAASC,oBAAoB,QAAQ,gCAAgC;AACrE,SAASC,wBAAwB,QAAQ,oCAAoC;AAG7E,SAASC,2BAA2B,QAAQ,uCAAuC;AAkBnF,OAAO,MAAMC,aACX,CAACC,gBACD,CAACC;QACC,MAAMC,WAAWF,cAAcE,QAAQ,IAAI;QAC3C,MAAMC,qBAAqBH,cAAcG,kBAAkB,IAAI;QAC/D,MAAMC,8BACJJ,cAAcI,2BAA2B,IAAI;QAE/CX,UAAUY,SAAS,CAACH;QAEpBD,OAAOK,WAAW,GAAG;eACfL,OAAOK,WAAW,IAAI,EAAE;YAC5BZ,sBAAsB;gBACpBa,SAASP,cAAcO,OAAO;gBAC9BC,eAAeR,cAAcQ,aAAa;gBAC1CC,UAAUT,cAAcS,QAAQ;gBAChCC,gBAAgBV,cAAcU,cAAc;gBAC5CC,UAAUX,cAAcW,QAAQ;gBAChCC,iBAAiBZ,cAAcY,eAAe;gBAC9CC,YAAYb,cAAca,UAAU;YACtC;SACD;QAED,IAAIb,cAAcS,QAAQ,EAAE;YAC1B,OAAOR;QACT;QAEAA,OAAOa,SAAS,GAAG;eACbb,OAAOa,SAAS,IAAI,EAAE;YAC1B;gBACEC,SAASnB;gBACToB,QAAQ;gBACRC,MAAM;YACR;eACId,qBACA;gBACE;oBACEY,SAASpB,yBAAyB;wBAChCuB,cAAcd;oBAChB;oBACAY,QAAQ;oBACRC,MAAM;gBACR;gBACA;oBACEF,SAASlB,yBAAyB;wBAChCqB,cAAcd;oBAChB;oBACAY,QAAQ;oBACRC,MAAM;gBACR;aACD,GACD,EAAE;SACP;QAED,OAAOhB;IACT,EAAE"}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionSlug, Config } from 'payload';\nimport { recordActivePlugin } from './activePlugins.js';\nimport { menuCache } from './cache.js';\nimport { createMenusCollection } from './collections/Menus.js';\nimport { createExportMenusHandler } from './endpoints/exportMenusHandler.js';\nimport { createGetMenuHandler } from './endpoints/getMenuHandler.js';\nimport { createImportMenusHandler } from './endpoints/importMenusHandler.js';\nimport type { DynamicSource } from './types.js';\n\nexport { migrateMegaColumnsToEntries } from './migrations/megaColumnsToEntries.js';\nexport type { DynamicSource } from './types.js';\n\nexport type MenuPluginConfig = {\n baseUrl?: string;\n cacheTTL?: number;\n /** depth used when resolving dynamic mega entry children (default: 1) */\n childrenDepth?: number;\n disabled?: boolean;\n /** sources used to auto-populate dynamic mega entries from related collections */\n dynamicSources?: DynamicSource[];\n enableImportExport?: boolean;\n maxDepth?: number;\n mediaCollection?: CollectionSlug;\n relationTo?: CollectionSlug | CollectionSlug[];\n requireAdminForImportExport?: boolean;\n};\n\nexport const menuPlugin =\n (pluginOptions: MenuPluginConfig) =>\n (config: Config): Config => {\n const cacheTTL = pluginOptions.cacheTTL ?? 60_000;\n const enableImportExport = pluginOptions.enableImportExport ?? true;\n const requireAdminForImportExport =\n pluginOptions.requireAdminForImportExport ?? true;\n\n menuCache.configure(cacheTTL);\n\n config.collections = [\n ...(config.collections || []),\n createMenusCollection({\n baseUrl: pluginOptions.baseUrl,\n childrenDepth: pluginOptions.childrenDepth,\n disabled: pluginOptions.disabled,\n dynamicSources: pluginOptions.dynamicSources,\n maxDepth: pluginOptions.maxDepth,\n mediaCollection: pluginOptions.mediaCollection,\n relationTo: pluginOptions.relationTo,\n }),\n ];\n\n if (pluginOptions.disabled) {\n return config;\n }\n\n config.endpoints = [\n ...(config.endpoints || []),\n {\n handler: createGetMenuHandler(),\n method: 'get',\n path: '/api/menus/:slug',\n },\n ...(enableImportExport\n ? [\n {\n handler: createExportMenusHandler({\n requireAdmin: requireAdminForImportExport,\n }),\n method: 'get' as const,\n path: '/api/menus-export',\n },\n {\n handler: createImportMenusHandler({\n requireAdmin: requireAdminForImportExport,\n }),\n method: 'post' as const,\n path: '/api/menus-import',\n },\n ]\n : []),\n ];\n\n return recordActivePlugin(config, '@foundrykit/menu-plugin');\n };\n"],"names":["recordActivePlugin","menuCache","createMenusCollection","createExportMenusHandler","createGetMenuHandler","createImportMenusHandler","migrateMegaColumnsToEntries","menuPlugin","pluginOptions","config","cacheTTL","enableImportExport","requireAdminForImportExport","configure","collections","baseUrl","childrenDepth","disabled","dynamicSources","maxDepth","mediaCollection","relationTo","endpoints","handler","method","path","requireAdmin"],"mappings":"AACA,SAASA,kBAAkB,QAAQ,qBAAqB;AACxD,SAASC,SAAS,QAAQ,aAAa;AACvC,SAASC,qBAAqB,QAAQ,yBAAyB;AAC/D,SAASC,wBAAwB,QAAQ,oCAAoC;AAC7E,SAASC,oBAAoB,QAAQ,gCAAgC;AACrE,SAASC,wBAAwB,QAAQ,oCAAoC;AAG7E,SAASC,2BAA2B,QAAQ,uCAAuC;AAkBnF,OAAO,MAAMC,aACX,CAACC,gBACD,CAACC;QACC,MAAMC,WAAWF,cAAcE,QAAQ,IAAI;QAC3C,MAAMC,qBAAqBH,cAAcG,kBAAkB,IAAI;QAC/D,MAAMC,8BACJJ,cAAcI,2BAA2B,IAAI;QAE/CX,UAAUY,SAAS,CAACH;QAEpBD,OAAOK,WAAW,GAAG;eACfL,OAAOK,WAAW,IAAI,EAAE;YAC5BZ,sBAAsB;gBACpBa,SAASP,cAAcO,OAAO;gBAC9BC,eAAeR,cAAcQ,aAAa;gBAC1CC,UAAUT,cAAcS,QAAQ;gBAChCC,gBAAgBV,cAAcU,cAAc;gBAC5CC,UAAUX,cAAcW,QAAQ;gBAChCC,iBAAiBZ,cAAcY,eAAe;gBAC9CC,YAAYb,cAAca,UAAU;YACtC;SACD;QAED,IAAIb,cAAcS,QAAQ,EAAE;YAC1B,OAAOR;QACT;QAEAA,OAAOa,SAAS,GAAG;eACbb,OAAOa,SAAS,IAAI,EAAE;YAC1B;gBACEC,SAASnB;gBACToB,QAAQ;gBACRC,MAAM;YACR;eACId,qBACA;gBACE;oBACEY,SAASpB,yBAAyB;wBAChCuB,cAAcd;oBAChB;oBACAY,QAAQ;oBACRC,MAAM;gBACR;gBACA;oBACEF,SAASlB,yBAAyB;wBAChCqB,cAAcd;oBAChB;oBACAY,QAAQ;oBACRC,MAAM;gBACR;aACD,GACD,EAAE;SACP;QAED,OAAOzB,mBAAmBS,QAAQ;IACpC,EAAE"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@foundrykit/menu-plugin",
3
- "version": "0.6.2",
3
+ "version": "0.6.3",
4
4
  "description": "A plugin for Payload CMS that provides a flexible and customisable menu system.",
5
5
  "license": "MIT",
6
6
  "type": "module",