@veiag/payload-cmdk 1.0.0

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/index.ts"],"sourcesContent":["import type { ClientConfig, LabelFunction, TextFieldClient } from 'payload'\nimport type {\n  CommandMenuGroup,\n  CommandMenuItem,\n  CustomMenuGroup,\n  CustomMenuItem,\n  LocalizedString,\n  PluginCommandMenuConfig,\n} from 'src/types'\n\nimport { Files, Globe } from 'lucide-react'\n\nexport const convertSlugToTitle = (slug: string): string => {\n  return slug.replace(/-/g, ' ').replace(/\\b\\w/g, (char) => char.toUpperCase())\n}\n\nexport const extractLocalizedValue = (\n  value: LocalizedString,\n  locale: string,\n  slug?: string,\n): string => {\n  if (typeof value === 'string') {\n    return value\n  }\n  return value[locale] || convertSlugToTitle(slug || '')\n}\n\nexport const extractLocalizedCollectionName = (\n  collection: {\n    labels?: { plural?: LocalizedString; singular?: LocalizedString }\n    slug: string\n  },\n  locale: string,\n): string => {\n  //Get plural name if exists, otherwise singular, otherwise slug\n  if (collection.labels?.plural) {\n    return extractLocalizedValue(collection.labels.plural, locale, collection.slug)\n  }\n  if (collection.labels?.singular) {\n    return extractLocalizedValue(collection.labels.singular, locale, collection.slug)\n  }\n  return '' //Generally should not happen\n}\n\nexport const extractLocalizedGlobalName = (\n  global: {\n    label?: LabelFunction | LocalizedString\n    slug: string\n  },\n  locale: string,\n): string => {\n  if (global.label) {\n    return extractLocalizedValue(\n      //Ignore label functions, they are not serializable\n      typeof global.label === 'function' ? {} : global.label,\n      locale,\n      global.slug,\n    )\n  }\n  return '' //Generally should not happen\n}\n\nexport const extractLocalizedGroupName = (\n  object: {\n    admin?: { group?: false | LocalizedString }\n  },\n  locale: string,\n): null | string => {\n  if (object.admin?.group) {\n    //Try to extract group name, with fallback to null (no group)\n    return extractLocalizedValue(object.admin.group, locale)?.trim() || null\n  }\n  return null\n}\n\nexport const convertConfigItem = (item: CustomMenuItem, currentLang: string): CommandMenuItem => {\n  return {\n    slug: item.slug,\n    type: 'custom',\n    action: item.action,\n    icon: item.icon,\n    label: extractLocalizedValue(item.label, currentLang, item.slug),\n  }\n}\n\nexport const convertConfigGroup = (\n  group: CustomMenuGroup,\n  currentLang: string,\n): CommandMenuGroup => {\n  return {\n    items: group.items.map((item) => convertConfigItem(item, currentLang)), // Will be merged with existing items if group exists\n    title: extractLocalizedValue(group.title, currentLang),\n  }\n}\n/**\n * Set of collection/globals slugs to ignore in the command menu.\n * This is useful to avoid showing certain collections/globals in the command menu.\n */\nconst DEFAULT_SLUGS_TO_IGNORE: string[] = [\n  'payload-migrations',\n  'payload-preferences',\n  'payload-locked-documents',\n]\nexport const createDefaultGroups = (\n  config: ClientConfig,\n  currentLang: string,\n  pluginConfig: PluginCommandMenuConfig,\n): {\n  groups: CommandMenuGroup[]\n  /**\n   * Stray items that don't belong to any group.\n   * Only with custom items.\n   */\n  items: CommandMenuItem[]\n} => {\n  const groups: CommandMenuGroup[] = []\n  const items: CommandMenuItem[] = []\n  const avaibleGroups = new Set<string>() //To avoid duplicates\n  let slugsToIgnore = [...DEFAULT_SLUGS_TO_IGNORE]\n\n  //Handle slugs to ignore from plugin config\n  if (pluginConfig?.slugsToIgnore) {\n    if (Array.isArray(pluginConfig.slugsToIgnore)) {\n      slugsToIgnore.push(...pluginConfig.slugsToIgnore)\n    } else {\n      //Object with ignoreList and replaceDefaults\n      if (pluginConfig.slugsToIgnore.replaceDefaults) {\n        //Replace defaults\n        slugsToIgnore = [] //Reset\n      }\n      slugsToIgnore.push(...pluginConfig.slugsToIgnore.ignoreList)\n    }\n  }\n\n  if (config.collections) {\n    config.collections.forEach((collection) => {\n      if (slugsToIgnore.includes(collection.slug)) {\n        return\n      }\n\n      const groupName = extractLocalizedGroupName(collection, currentLang) || 'Collections'\n      //   console.log(collection.slug, 'groupName:', groupName, 'Object', collection.admin)\n      if (!avaibleGroups.has(groupName)) {\n        avaibleGroups.add(groupName)\n        groups.push({\n          items: [],\n          title: groupName,\n        })\n      }\n      const group = groups.find((g) => g.title === groupName)\n      if (group) {\n        const useAsTitleField = collection.admin?.useAsTitle || 'id'\n        let useAsTitleFieldLabel: TextFieldClient['label'] | undefined = undefined\n        let useAsTitleLabel: string | undefined = undefined\n        //Only extract useAsTitle label if submenu is enabled\n        if (pluginConfig?.submenu?.enabled !== false) {\n          useAsTitleFieldLabel = (\n            collection?.fields?.find((field) => {\n              if ('name' in field === false) {\n                return null\n              }\n              return field.name === useAsTitleField\n            }) as null | TextFieldClient\n          )?.label\n          //Extract label for useAsTitle field\n          useAsTitleLabel = extractLocalizedValue(\n            typeof useAsTitleFieldLabel === 'function' ? {} : useAsTitleFieldLabel || {},\n            currentLang,\n            useAsTitleField,\n          )\n        }\n        group.items.push({\n          slug: collection.slug,\n          type: 'collection',\n          action: {\n            type: 'link',\n            href: `/admin/collections/${collection.slug}`,\n          },\n          //Either custom icon from plugin config, or default Files icon\n          icon: pluginConfig?.icons?.collections?.[collection.slug] || Files,\n          label: extractLocalizedCollectionName(collection, currentLang),\n          useAsTitle: useAsTitleField,\n          useAsTitleLabel: useAsTitleLabel || useAsTitleField,\n        })\n      }\n    })\n  }\n  //Globals\n  if (config.globals) {\n    config.globals.forEach((global) => {\n      if (slugsToIgnore.includes(global.slug)) {\n        return\n      }\n      //Same logic as collections\n      const groupName = extractLocalizedGroupName(global, currentLang) || 'Globals'\n      if (!avaibleGroups.has(groupName)) {\n        avaibleGroups.add(groupName)\n        groups.push({\n          items: [],\n          title: groupName,\n        })\n      }\n      const group = groups.find((g) => g.title === groupName)\n      if (group) {\n        group.items.push({\n          slug: global.slug,\n          type: 'global',\n          action: {\n            type: 'link',\n            href: `/admin/globals/${global.slug}`,\n          },\n          //Either custom icon from plugin config, or default Globe icon\n          icon: pluginConfig?.icons?.globals?.[global.slug] || Globe,\n          label: extractLocalizedGlobalName(global, currentLang),\n        })\n      }\n    })\n  }\n  //Now custom items/groups from plugin config\n  if (pluginConfig?.customItems) {\n    //We are not using slugsToIgnore for custom items, as they are user-defined\n    pluginConfig.customItems.forEach((value) => {\n      if (value.type === 'group') {\n        const convertedGroup = convertConfigGroup(value, currentLang)\n        //Check if group already exists using our set\n        if (!avaibleGroups.has(convertedGroup.title)) {\n          avaibleGroups.add(convertedGroup.title)\n          groups.push({\n            items: [], //Don't add items yet, will do below\n            title: convertedGroup.title,\n          })\n        }\n        const group = groups.find((g) => g.title === convertedGroup.title)\n        if (group) {\n          //Append items to existing group, or if it was empty - add items\n          group.items.push(...convertedGroup.items)\n        }\n      }\n      if (value.type === 'item') {\n        //Stray item, add to items array\n        const convertedItem = convertConfigItem(value, currentLang)\n        items.push(convertedItem)\n      }\n    })\n  }\n  return { groups, items }\n}\n"],"names":["Files","Globe","convertSlugToTitle","slug","replace","char","toUpperCase","extractLocalizedValue","value","locale","extractLocalizedCollectionName","collection","labels","plural","singular","extractLocalizedGlobalName","global","label","extractLocalizedGroupName","object","admin","group","trim","convertConfigItem","item","currentLang","type","action","icon","convertConfigGroup","items","map","title","DEFAULT_SLUGS_TO_IGNORE","createDefaultGroups","config","pluginConfig","groups","avaibleGroups","Set","slugsToIgnore","Array","isArray","push","replaceDefaults","ignoreList","collections","forEach","includes","groupName","has","add","find","g","useAsTitleField","useAsTitle","useAsTitleFieldLabel","undefined","useAsTitleLabel","submenu","enabled","fields","field","name","href","icons","globals","customItems","convertedGroup","convertedItem"],"mappings":"AAUA,SAASA,KAAK,EAAEC,KAAK,QAAQ,eAAc;AAE3C,OAAO,MAAMC,qBAAqB,CAACC;IACjC,OAAOA,KAAKC,OAAO,CAAC,MAAM,KAAKA,OAAO,CAAC,SAAS,CAACC,OAASA,KAAKC,WAAW;AAC5E,EAAC;AAED,OAAO,MAAMC,wBAAwB,CACnCC,OACAC,QACAN;IAEA,IAAI,OAAOK,UAAU,UAAU;QAC7B,OAAOA;IACT;IACA,OAAOA,KAAK,CAACC,OAAO,IAAIP,mBAAmBC,QAAQ;AACrD,EAAC;AAED,OAAO,MAAMO,iCAAiC,CAC5CC,YAIAF;IAEA,+DAA+D;IAC/D,IAAIE,WAAWC,MAAM,EAAEC,QAAQ;QAC7B,OAAON,sBAAsBI,WAAWC,MAAM,CAACC,MAAM,EAAEJ,QAAQE,WAAWR,IAAI;IAChF;IACA,IAAIQ,WAAWC,MAAM,EAAEE,UAAU;QAC/B,OAAOP,sBAAsBI,WAAWC,MAAM,CAACE,QAAQ,EAAEL,QAAQE,WAAWR,IAAI;IAClF;IACA,OAAO,GAAG,6BAA6B;;AACzC,EAAC;AAED,OAAO,MAAMY,6BAA6B,CACxCC,QAIAP;IAEA,IAAIO,OAAOC,KAAK,EAAE;QAChB,OAAOV,sBACL,mDAAmD;QACnD,OAAOS,OAAOC,KAAK,KAAK,aAAa,CAAC,IAAID,OAAOC,KAAK,EACtDR,QACAO,OAAOb,IAAI;IAEf;IACA,OAAO,GAAG,6BAA6B;;AACzC,EAAC;AAED,OAAO,MAAMe,4BAA4B,CACvCC,QAGAV;IAEA,IAAIU,OAAOC,KAAK,EAAEC,OAAO;QACvB,6DAA6D;QAC7D,OAAOd,sBAAsBY,OAAOC,KAAK,CAACC,KAAK,EAAEZ,SAASa,UAAU;IACtE;IACA,OAAO;AACT,EAAC;AAED,OAAO,MAAMC,oBAAoB,CAACC,MAAsBC;IACtD,OAAO;QACLtB,MAAMqB,KAAKrB,IAAI;QACfuB,MAAM;QACNC,QAAQH,KAAKG,MAAM;QACnBC,MAAMJ,KAAKI,IAAI;QACfX,OAAOV,sBAAsBiB,KAAKP,KAAK,EAAEQ,aAAaD,KAAKrB,IAAI;IACjE;AACF,EAAC;AAED,OAAO,MAAM0B,qBAAqB,CAChCR,OACAI;IAEA,OAAO;QACLK,OAAOT,MAAMS,KAAK,CAACC,GAAG,CAAC,CAACP,OAASD,kBAAkBC,MAAMC;QACzDO,OAAOzB,sBAAsBc,MAAMW,KAAK,EAAEP;IAC5C;AACF,EAAC;AACD;;;CAGC,GACD,MAAMQ,0BAAoC;IACxC;IACA;IACA;CACD;AACD,OAAO,MAAMC,sBAAsB,CACjCC,QACAV,aACAW;IASA,MAAMC,SAA6B,EAAE;IACrC,MAAMP,QAA2B,EAAE;IACnC,MAAMQ,gBAAgB,IAAIC,MAAc,qBAAqB;;IAC7D,IAAIC,gBAAgB;WAAIP;KAAwB;IAEhD,2CAA2C;IAC3C,IAAIG,cAAcI,eAAe;QAC/B,IAAIC,MAAMC,OAAO,CAACN,aAAaI,aAAa,GAAG;YAC7CA,cAAcG,IAAI,IAAIP,aAAaI,aAAa;QAClD,OAAO;YACL,4CAA4C;YAC5C,IAAIJ,aAAaI,aAAa,CAACI,eAAe,EAAE;gBAC9C,kBAAkB;gBAClBJ,gBAAgB,EAAE,EAAC,OAAO;YAC5B;YACAA,cAAcG,IAAI,IAAIP,aAAaI,aAAa,CAACK,UAAU;QAC7D;IACF;IAEA,IAAIV,OAAOW,WAAW,EAAE;QACtBX,OAAOW,WAAW,CAACC,OAAO,CAAC,CAACpC;YAC1B,IAAI6B,cAAcQ,QAAQ,CAACrC,WAAWR,IAAI,GAAG;gBAC3C;YACF;YAEA,MAAM8C,YAAY/B,0BAA0BP,YAAYc,gBAAgB;YACxE,sFAAsF;YACtF,IAAI,CAACa,cAAcY,GAAG,CAACD,YAAY;gBACjCX,cAAca,GAAG,CAACF;gBAClBZ,OAAOM,IAAI,CAAC;oBACVb,OAAO,EAAE;oBACTE,OAAOiB;gBACT;YACF;YACA,MAAM5B,QAAQgB,OAAOe,IAAI,CAAC,CAACC,IAAMA,EAAErB,KAAK,KAAKiB;YAC7C,IAAI5B,OAAO;gBACT,MAAMiC,kBAAkB3C,WAAWS,KAAK,EAAEmC,cAAc;gBACxD,IAAIC,uBAA6DC;gBACjE,IAAIC,kBAAsCD;gBAC1C,qDAAqD;gBACrD,IAAIrB,cAAcuB,SAASC,YAAY,OAAO;oBAC5CJ,uBACE7C,YAAYkD,QAAQT,KAAK,CAACU;wBACxB,IAAI,UAAUA,UAAU,OAAO;4BAC7B,OAAO;wBACT;wBACA,OAAOA,MAAMC,IAAI,KAAKT;oBACxB,IACCrC;oBACH,oCAAoC;oBACpCyC,kBAAkBnD,sBAChB,OAAOiD,yBAAyB,aAAa,CAAC,IAAIA,wBAAwB,CAAC,GAC3E/B,aACA6B;gBAEJ;gBACAjC,MAAMS,KAAK,CAACa,IAAI,CAAC;oBACfxC,MAAMQ,WAAWR,IAAI;oBACrBuB,MAAM;oBACNC,QAAQ;wBACND,MAAM;wBACNsC,MAAM,CAAC,mBAAmB,EAAErD,WAAWR,IAAI,EAAE;oBAC/C;oBACA,8DAA8D;oBAC9DyB,MAAMQ,cAAc6B,OAAOnB,aAAa,CAACnC,WAAWR,IAAI,CAAC,IAAIH;oBAC7DiB,OAAOP,+BAA+BC,YAAYc;oBAClD8B,YAAYD;oBACZI,iBAAiBA,mBAAmBJ;gBACtC;YACF;QACF;IACF;IACA,SAAS;IACT,IAAInB,OAAO+B,OAAO,EAAE;QAClB/B,OAAO+B,OAAO,CAACnB,OAAO,CAAC,CAAC/B;YACtB,IAAIwB,cAAcQ,QAAQ,CAAChC,OAAOb,IAAI,GAAG;gBACvC;YACF;YACA,2BAA2B;YAC3B,MAAM8C,YAAY/B,0BAA0BF,QAAQS,gBAAgB;YACpE,IAAI,CAACa,cAAcY,GAAG,CAACD,YAAY;gBACjCX,cAAca,GAAG,CAACF;gBAClBZ,OAAOM,IAAI,CAAC;oBACVb,OAAO,EAAE;oBACTE,OAAOiB;gBACT;YACF;YACA,MAAM5B,QAAQgB,OAAOe,IAAI,CAAC,CAACC,IAAMA,EAAErB,KAAK,KAAKiB;YAC7C,IAAI5B,OAAO;gBACTA,MAAMS,KAAK,CAACa,IAAI,CAAC;oBACfxC,MAAMa,OAAOb,IAAI;oBACjBuB,MAAM;oBACNC,QAAQ;wBACND,MAAM;wBACNsC,MAAM,CAAC,eAAe,EAAEhD,OAAOb,IAAI,EAAE;oBACvC;oBACA,8DAA8D;oBAC9DyB,MAAMQ,cAAc6B,OAAOC,SAAS,CAAClD,OAAOb,IAAI,CAAC,IAAIF;oBACrDgB,OAAOF,2BAA2BC,QAAQS;gBAC5C;YACF;QACF;IACF;IACA,4CAA4C;IAC5C,IAAIW,cAAc+B,aAAa;QAC7B,2EAA2E;QAC3E/B,aAAa+B,WAAW,CAACpB,OAAO,CAAC,CAACvC;YAChC,IAAIA,MAAMkB,IAAI,KAAK,SAAS;gBAC1B,MAAM0C,iBAAiBvC,mBAAmBrB,OAAOiB;gBACjD,6CAA6C;gBAC7C,IAAI,CAACa,cAAcY,GAAG,CAACkB,eAAepC,KAAK,GAAG;oBAC5CM,cAAca,GAAG,CAACiB,eAAepC,KAAK;oBACtCK,OAAOM,IAAI,CAAC;wBACVb,OAAO,EAAE;wBACTE,OAAOoC,eAAepC,KAAK;oBAC7B;gBACF;gBACA,MAAMX,QAAQgB,OAAOe,IAAI,CAAC,CAACC,IAAMA,EAAErB,KAAK,KAAKoC,eAAepC,KAAK;gBACjE,IAAIX,OAAO;oBACT,gEAAgE;oBAChEA,MAAMS,KAAK,CAACa,IAAI,IAAIyB,eAAetC,KAAK;gBAC1C;YACF;YACA,IAAItB,MAAMkB,IAAI,KAAK,QAAQ;gBACzB,gCAAgC;gBAChC,MAAM2C,gBAAgB9C,kBAAkBf,OAAOiB;gBAC/CK,MAAMa,IAAI,CAAC0B;YACb;QACF;IACF;IACA,OAAO;QAAEhC;QAAQP;IAAM;AACzB,EAAC"}

package/package.json

@@ -0,0 +1,126 @@
+{
+  "name": "@veiag/payload-cmdk",
+  "version": "1.0.0",
+  "description": "A command menu plugin for Payload CMS to enhance navigation and accessibility within the admin panel.",
+  "author": "VeiaG",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./src/index.ts",
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    },
+    "./client": {
+      "import": "./src/exports/client.ts",
+      "types": "./src/exports/client.ts",
+      "default": "./src/exports/client.ts"
+    },
+    "./rsc": {
+      "import": "./src/exports/rsc.ts",
+      "types": "./src/exports/rsc.ts",
+      "default": "./src/exports/rsc.ts"
+    }
+  },
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
+    "build:types": "tsc --outDir dist --rootDir ./src",
+    "clean": "rimraf {dist,*.tsbuildinfo}",
+    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
+    "dev": "next dev dev --turbo",
+    "dev:generate-importmap": "pnpm dev:payload generate:importmap",
+    "dev:generate-types": "pnpm dev:payload generate:types",
+    "dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
+    "generate:importmap": "pnpm dev:generate-importmap",
+    "generate:types": "pnpm dev:generate-types",
+    "lint": "eslint",
+    "lint:fix": "eslint ./src --fix",
+    "prepublishOnly": "pnpm clean && pnpm build",
+    "test": "pnpm test:int && pnpm test:e2e",
+    "test:e2e": "playwright test",
+    "test:int": "vitest"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@payloadcms/db-mongodb": "3.37.0",
+    "@payloadcms/db-postgres": "3.37.0",
+    "@payloadcms/db-sqlite": "3.37.0",
+    "@payloadcms/eslint-config": "3.9.0",
+    "@payloadcms/next": "3.37.0",
+    "@payloadcms/richtext-lexical": "3.37.0",
+    "@payloadcms/ui": "3.37.0",
+    "@playwright/test": "1.56.1",
+    "@swc-node/register": "1.10.9",
+    "@swc/cli": "0.6.0",
+    "@types/node": "^22.5.4",
+    "@types/react": "19.2.1",
+    "@types/react-dom": "19.2.1",
+    "copyfiles": "2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.23.0",
+    "eslint-config-next": "15.4.7",
+    "graphql": "^16.8.1",
+    "mongodb-memory-server": "10.1.4",
+    "next": "15.4.8",
+    "open": "^10.1.0",
+    "payload": "3.37.0",
+    "prettier": "^3.4.2",
+    "qs-esm": "7.0.2",
+    "react": "19.2.1",
+    "react-dom": "19.2.1",
+    "rimraf": "3.0.2",
+    "sharp": "0.34.2",
+    "sort-package-json": "^2.10.0",
+    "typescript": "5.7.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.1.2"
+  },
+  "peerDependencies": {
+    "payload": "^3.37.0"
+  },
+  "engines": {
+    "node": "^18.20.2 || >=20.9.0",
+    "pnpm": "^9 || ^10"
+  },
+  "publishConfig": {
+    "exports": {
+      ".": {
+        "import": "./dist/index.js",
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "./client": {
+        "import": "./dist/exports/client.js",
+        "types": "./dist/exports/client.d.ts",
+        "default": "./dist/exports/client.js"
+      },
+      "./rsc": {
+        "import": "./dist/exports/rsc.js",
+        "types": "./dist/exports/rsc.d.ts",
+        "default": "./dist/exports/rsc.js"
+      }
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "sharp",
+      "esbuild",
+      "unrs-resolver"
+    ]
+  },
+  "registry": "https://registry.npmjs.org/",
+  "dependencies": {
+    "@payloadcms/translations": "^3.37.0",
+    "cmdk": "^1.1.1",
+    "lucide-react": "^0.556.0",
+    "react-hotkeys-hook": "^5.2.1"
+  }
+}