@payloadcms/ui 4.0.0-internal.cc18726 → 4.0.0-internal.cd47d20

package/dist/views/Root/getCustomCollectionViewByRoute.spec.js

@@ -1,168 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { getCustomCollectionViewByRoute } from './getCustomCollectionViewByRoute.js';
-const gridView = {
-  grid: {
-    Component: '/components/views/GridView/index.js#GridView',
-    exact: true,
-    path: '/grid'
-  }
-};
-const gridViewPrefixMatch = {
-  grid: {
-    Component: '/components/views/GridView/index.js#GridView',
-    exact: false,
-    path: '/grid'
-  }
-};
-describe('getCustomCollectionViewByRoute', () => {
-  describe('route matching with default /admin prefix', () => {
-    it('should match a custom view at the correct path', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/grid',
-        views: gridView
-      });
-      expect(result.viewKey).toBe('grid');
-      expect(result.view.payloadComponent).toBeDefined();
-    });
-    it('should not match when the path segment does not correspond to any custom view', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/abc123',
-        views: gridView
-      });
-      expect(result.viewKey).toBeNull();
-      expect(result.view.payloadComponent).toBeUndefined();
-    });
-  });
-  describe('route matching with custom adminRoute prefix', () => {
-    it('should match when adminRoute is a non-default prefix', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/cms',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/cms/collections/my-collection/grid',
-        views: gridView
-      });
-      expect(result.viewKey).toBe('grid');
-      expect(result.view.payloadComponent).toBeDefined();
-    });
-    it('should match when adminRoute is /', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/collections/my-collection/grid',
-        views: gridView
-      });
-      expect(result.viewKey).toBe('grid');
-      expect(result.view.payloadComponent).toBeDefined();
-    });
-  });
-  describe('route matching with exact: false (prefix matching)', () => {
-    it('should match a sub-path when exact is false', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/grid/detail',
-        views: gridViewPrefixMatch
-      });
-      expect(result.viewKey).toBe('grid');
-      expect(result.view.payloadComponent).toBeDefined();
-    });
-    it('should match the exact path when exact is false', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/grid',
-        views: gridViewPrefixMatch
-      });
-      expect(result.viewKey).toBe('grid');
-      expect(result.view.payloadComponent).toBeDefined();
-    });
-    it('should not match an unrelated path when exact is false', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/map',
-        views: gridViewPrefixMatch
-      });
-      expect(result.viewKey).toBeNull();
-      expect(result.view.payloadComponent).toBeUndefined();
-    });
-  });
-  describe('edge cases', () => {
-    it('should return no match when views is undefined', () => {
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/grid',
-        views: undefined
-      });
-      expect(result.viewKey).toBeNull();
-      expect(result.view.payloadComponent).toBeUndefined();
-    });
-    it('should not match built-in "edit" or "list" keys', () => {
-      const viewsWithBuiltins = {
-        edit: {
-          default: {
-            Component: '/components/views/Edit/index.js#EditView'
-          }
-        },
-        list: {
-          Component: '/components/views/List/index.js#ListView'
-        }
-      };
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/edit',
-        views: viewsWithBuiltins
-      });
-      expect(result.viewKey).toBeNull();
-    });
-    it('should not match a custom view that has no path defined', () => {
-      const viewsWithNoPath = {
-        grid: {
-          Component: '/components/views/GridView/index.js#GridView'
-        }
-      };
-      const result = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/grid',
-        views: viewsWithNoPath
-      });
-      expect(result.viewKey).toBeNull();
-    });
-    it('should match the correct view when multiple custom views are defined', () => {
-      const multipleViews = {
-        grid: {
-          Component: '/components/views/GridView/index.js#GridView',
-          exact: true,
-          path: '/grid'
-        },
-        map: {
-          Component: '/components/views/MapView/index.js#MapView',
-          exact: true,
-          path: '/map'
-        }
-      };
-      const gridResult = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/grid',
-        views: multipleViews
-      });
-      expect(gridResult.viewKey).toBe('grid');
-      const mapResult = getCustomCollectionViewByRoute({
-        adminRoute: '/admin',
-        baseRoute: '/collections/my-collection',
-        currentRoute: '/admin/collections/my-collection/map',
-        views: multipleViews
-      });
-      expect(mapResult.viewKey).toBe('map');
-    });
-  });
-});
-//# sourceMappingURL=getCustomCollectionViewByRoute.spec.js.map

package/dist/views/Root/getCustomCollectionViewByRoute.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getCustomCollectionViewByRoute.spec.js","names":["describe","expect","it","getCustomCollectionViewByRoute","gridView","grid","Component","exact","path","gridViewPrefixMatch","result","adminRoute","baseRoute","currentRoute","views","viewKey","toBe","view","payloadComponent","toBeDefined","toBeNull","toBeUndefined","undefined","viewsWithBuiltins","edit","default","list","viewsWithNoPath","multipleViews","map","gridResult","mapResult"],"sources":["../../../src/views/Root/getCustomCollectionViewByRoute.spec.ts"],"sourcesContent":["import type { AdminViewConfig, SanitizedCollectionConfig } from 'payload'\n\nimport { describe, expect, it } from 'vitest'\n\nimport { getCustomCollectionViewByRoute } from './getCustomCollectionViewByRoute.js'\n\ntype Views = SanitizedCollectionConfig['admin']['components']['views']\n\nconst gridView: Views = {\n  grid: {\n    Component: '/components/views/GridView/index.js#GridView',\n    exact: true,\n    path: '/grid',\n  },\n}\n\nconst gridViewPrefixMatch: Views = {\n  grid: {\n    Component: '/components/views/GridView/index.js#GridView',\n    exact: false,\n    path: '/grid',\n  },\n}\n\ndescribe('getCustomCollectionViewByRoute', () => {\n  describe('route matching with default /admin prefix', () => {\n    it('should match a custom view at the correct path', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/grid',\n        views: gridView,\n      })\n\n      expect(result.viewKey).toBe('grid')\n      expect(result.view.payloadComponent).toBeDefined()\n    })\n\n    it('should not match when the path segment does not correspond to any custom view', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/abc123',\n        views: gridView,\n      })\n\n      expect(result.viewKey).toBeNull()\n      expect(result.view.payloadComponent).toBeUndefined()\n    })\n  })\n\n  describe('route matching with custom adminRoute prefix', () => {\n    it('should match when adminRoute is a non-default prefix', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/cms',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/cms/collections/my-collection/grid',\n        views: gridView,\n      })\n\n      expect(result.viewKey).toBe('grid')\n      expect(result.view.payloadComponent).toBeDefined()\n    })\n\n    it('should match when adminRoute is /', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/collections/my-collection/grid',\n        views: gridView,\n      })\n\n      expect(result.viewKey).toBe('grid')\n      expect(result.view.payloadComponent).toBeDefined()\n    })\n  })\n\n  describe('route matching with exact: false (prefix matching)', () => {\n    it('should match a sub-path when exact is false', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/grid/detail',\n        views: gridViewPrefixMatch,\n      })\n\n      expect(result.viewKey).toBe('grid')\n      expect(result.view.payloadComponent).toBeDefined()\n    })\n\n    it('should match the exact path when exact is false', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/grid',\n        views: gridViewPrefixMatch,\n      })\n\n      expect(result.viewKey).toBe('grid')\n      expect(result.view.payloadComponent).toBeDefined()\n    })\n\n    it('should not match an unrelated path when exact is false', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/map',\n        views: gridViewPrefixMatch,\n      })\n\n      expect(result.viewKey).toBeNull()\n      expect(result.view.payloadComponent).toBeUndefined()\n    })\n  })\n\n  describe('edge cases', () => {\n    it('should return no match when views is undefined', () => {\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/grid',\n        views: undefined,\n      })\n\n      expect(result.viewKey).toBeNull()\n      expect(result.view.payloadComponent).toBeUndefined()\n    })\n\n    it('should not match built-in \"edit\" or \"list\" keys', () => {\n      const viewsWithBuiltins: Views = {\n        edit: {\n          default: { Component: '/components/views/Edit/index.js#EditView' },\n        },\n        list: {\n          Component: '/components/views/List/index.js#ListView',\n        },\n      }\n\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/edit',\n        views: viewsWithBuiltins,\n      })\n\n      expect(result.viewKey).toBeNull()\n    })\n\n    it('should not match a custom view that has no path defined', () => {\n      const viewsWithNoPath: Views = {\n        grid: {\n          Component: '/components/views/GridView/index.js#GridView',\n        } as unknown as AdminViewConfig,\n      }\n\n      const result = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/grid',\n        views: viewsWithNoPath,\n      })\n\n      expect(result.viewKey).toBeNull()\n    })\n\n    it('should match the correct view when multiple custom views are defined', () => {\n      const multipleViews: Views = {\n        grid: {\n          Component: '/components/views/GridView/index.js#GridView',\n          exact: true,\n          path: '/grid',\n        },\n        map: {\n          Component: '/components/views/MapView/index.js#MapView',\n          exact: true,\n          path: '/map',\n        },\n      }\n\n      const gridResult = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/grid',\n        views: multipleViews,\n      })\n\n      expect(gridResult.viewKey).toBe('grid')\n\n      const mapResult = getCustomCollectionViewByRoute({\n        adminRoute: '/admin',\n        baseRoute: '/collections/my-collection',\n        currentRoute: '/admin/collections/my-collection/map',\n        views: multipleViews,\n      })\n\n      expect(mapResult.viewKey).toBe('map')\n    })\n  })\n})\n"],"mappings":"AAEA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ;AAErC,SAASC,8BAA8B,QAAQ;AAI/C,MAAMC,QAAA,GAAkB;EACtBC,IAAA,EAAM;IACJC,SAAA,EAAW;IACXC,KAAA,EAAO;IACPC,IAAA,EAAM;EACR;AACF;AAEA,MAAMC,mBAAA,GAA6B;EACjCJ,IAAA,EAAM;IACJC,SAAA,EAAW;IACXC,KAAA,EAAO;IACPC,IAAA,EAAM;EACR;AACF;AAEAR,QAAA,CAAS,kCAAkC;EACzCA,QAAA,CAAS,6CAA6C;IACpDE,EAAA,CAAG,kDAAkD;MACnD,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOV;MACT;MAEAH,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEC,IAAI,CAAC;MAC5Bf,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEC,WAAW;IAClD;IAEAjB,EAAA,CAAG,iFAAiF;MAClF,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOV;MACT;MAEAH,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEK,QAAQ;MAC/BnB,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEG,aAAa;IACpD;EACF;EAEArB,QAAA,CAAS,gDAAgD;IACvDE,EAAA,CAAG,wDAAwD;MACzD,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOV;MACT;MAEAH,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEC,IAAI,CAAC;MAC5Bf,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEC,WAAW;IAClD;IAEAjB,EAAA,CAAG,qCAAqC;MACtC,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOV;MACT;MAEAH,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEC,IAAI,CAAC;MAC5Bf,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEC,WAAW;IAClD;EACF;EAEAnB,QAAA,CAAS,sDAAsD;IAC7DE,EAAA,CAAG,+CAA+C;MAChD,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOL;MACT;MAEAR,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEC,IAAI,CAAC;MAC5Bf,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEC,WAAW;IAClD;IAEAjB,EAAA,CAAG,mDAAmD;MACpD,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOL;MACT;MAEAR,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEC,IAAI,CAAC;MAC5Bf,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEC,WAAW;IAClD;IAEAjB,EAAA,CAAG,0DAA0D;MAC3D,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOL;MACT;MAEAR,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEK,QAAQ;MAC/BnB,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEG,aAAa;IACpD;EACF;EAEArB,QAAA,CAAS,cAAc;IACrBE,EAAA,CAAG,kDAAkD;MACnD,MAAMQ,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOQ;MACT;MAEArB,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEK,QAAQ;MAC/BnB,MAAA,CAAOS,MAAA,CAAOO,IAAI,CAACC,gBAAgB,EAAEG,aAAa;IACpD;IAEAnB,EAAA,CAAG,mDAAmD;MACpD,MAAMqB,iBAAA,GAA2B;QAC/BC,IAAA,EAAM;UACJC,OAAA,EAAS;YAAEnB,SAAA,EAAW;UAA2C;QACnE;QACAoB,IAAA,EAAM;UACJpB,SAAA,EAAW;QACb;MACF;MAEA,MAAMI,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOS;MACT;MAEAtB,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEK,QAAQ;IACjC;IAEAlB,EAAA,CAAG,2DAA2D;MAC5D,MAAMyB,eAAA,GAAyB;QAC7BtB,IAAA,EAAM;UACJC,SAAA,EAAW;QACb;MACF;MAEA,MAAMI,MAAA,GAASP,8BAAA,CAA+B;QAC5CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOa;MACT;MAEA1B,MAAA,CAAOS,MAAA,CAAOK,OAAO,EAAEK,QAAQ;IACjC;IAEAlB,EAAA,CAAG,wEAAwE;MACzE,MAAM0B,aAAA,GAAuB;QAC3BvB,IAAA,EAAM;UACJC,SAAA,EAAW;UACXC,KAAA,EAAO;UACPC,IAAA,EAAM;QACR;QACAqB,GAAA,EAAK;UACHvB,SAAA,EAAW;UACXC,KAAA,EAAO;UACPC,IAAA,EAAM;QACR;MACF;MAEA,MAAMsB,UAAA,GAAa3B,8BAAA,CAA+B;QAChDQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOc;MACT;MAEA3B,MAAA,CAAO6B,UAAA,CAAWf,OAAO,EAAEC,IAAI,CAAC;MAEhC,MAAMe,SAAA,GAAY5B,8BAAA,CAA+B;QAC/CQ,UAAA,EAAY;QACZC,SAAA,EAAW;QACXC,YAAA,EAAc;QACdC,KAAA,EAAOc;MACT;MAEA3B,MAAA,CAAO8B,SAAA,CAAUhB,OAAO,EAAEC,IAAI,CAAC;IACjC;EACF;AACF","ignoreList":[]}