Add configuration for globals

Author: paulpopus

demo/src/globals/Homepage.ts

@@ -0,0 +1,8 @@
+import { GlobalConfig } from "payload/types";
+
+const Homepage: GlobalConfig = {
+  slug: "homepage",
+  fields: [],
+};
+
+export default Homepage;

demo/src/payload.config.ts

@@ -5,6 +5,7 @@ import Posts from "./collections/Posts";
 import Tags from "./collections/Tags";
 import Users from "./collections/Users";
 import Media from "./collections/Media";
+import Homepage from "./globals/Homepage";
 import payloadDashboardAnalytics from "../../src/index";
 import { PlausibleProvider } from "../../src/types/providers";
 
@@ -42,6 +43,7 @@ export default buildConfig({
     },
   },
   collections: [Categories, Posts, Tags, Users, Media],
+  globals: [Homepage],
   typescript: {
     outputFile: path.resolve(__dirname, "payload-types.ts"),
   },
@@ -63,6 +65,27 @@ export default buildConfig({
           },
         ],
       },
+      globals: [
+        {
+          slug: "homepage",
+          widgets: [
+            {
+              type: "chart",
+              label: "Views and visitors",
+              metrics: ["views", "visitors", "sessions"],
+              timeframe: "30d",
+              idMatcher: () => `/`,
+            },
+            {
+              type: "info",
+              label: "Page data",
+              metrics: ["views", "sessions", "sessionDuration"],
+              timeframe: "currentMonth",
+              idMatcher: () => `/`,
+            },
+          ],
+        },
+      ],
       collections: [
         {
           slug: Posts.slug,

src/index.ts

@@ -16,6 +16,7 @@ import getPageAggregateData from "./routes/getPageAggregateData";
 import getLiveData from "./routes/getLiveData";
 
 import type { CollectionConfig } from "payload/dist/collections/config/types";
+import type { GlobalConfig } from "payload/dist/globals/config/types";
 import { getPageViewsChart } from "./components/Charts/PageViewsChart";
 import { getAggregateDataWidget } from "./components/Aggregates/AggregateDataWidget";
 import LiveDataWidget from "./components/Live/LiveDataWidget";
@@ -49,7 +50,7 @@ const PageWidgetMap: Record<
 const payloadDashboardAnalytics =
   (incomingConfig: DashboardAnalyticsConfig) =>
   (config: PayloadConfig): PayloadConfig => {
-    const { admin, collections } = config;
+    const { admin, collections, globals } = config;
     const { provider, navigation } = incomingConfig;
     const endpoints = config.endpoints ?? [];
     const apiProvider = getProvider(provider);
@@ -85,10 +86,12 @@ const payloadDashboardAnalytics =
       ],
       ...(collections && {
         collections: collections.map((collection) => {
-          const targetCollection = incomingConfig.collections?.find((col) => {
-            if (col.slug === collection.slug) return true;
-            return false;
-          });
+          const targetCollection = incomingConfig.collections?.find(
+            (pluginCollection) => {
+              if (pluginCollection.slug === collection.slug) return true;
+              return false;
+            }
+          );
 
           if (targetCollection) {
             const collectionConfigWithHooks: CollectionConfig = {
@@ -109,6 +112,32 @@ const payloadDashboardAnalytics =
           return collection;
         }),
       }),
+      ...(globals && {
+        globals: globals.map((global) => {
+          const targetGlobal = incomingConfig.globals?.find((pluginGlobal) => {
+            if (pluginGlobal.slug === global.slug) return true;
+            return false;
+          });
+
+          if (targetGlobal) {
+            const globalConfigWithHooks: GlobalConfig = {
+              ...global,
+              fields: [
+                ...global.fields,
+                ...targetGlobal.widgets.map((widget, index) => {
+                  const field = PageWidgetMap[widget.type];
+
+                  return field(widget, index);
+                }),
+              ],
+            };
+
+            return globalConfigWithHooks;
+          }
+
+          return global;
+        }),
+      }),
     };
 
     return processedConfig;

src/types/index.ts

@@ -17,13 +17,16 @@ export interface Collection extends PageItemConfig {
   slug: string;
 }
 
-export interface Global extends PageItemConfig {}
+export interface Global extends PageItemConfig {
+  slug: string;
+}
 
 export type Provider = PlausibleProvider;
 
 export type DashboardAnalyticsConfig = {
   provider: Provider;
   collections?: Collection[];
+  globals?: Global[];
   navigation?: {
     BeforeNavLinks?: NavigationWidgets[];
     AfterNavLinks?: NavigationWidgets[];