Add live data endpoint

Author: paulpopus

src/index.ts

@@ -8,10 +8,13 @@ import type {
 import type { Field } from "payload/dist/fields/config/types";
 import { extendWebpackConfig } from "./extendWebpackConfig";
 import getProvider from "./providers";
+
 import getGlobalAggregateData from "./routes/getGlobalAggregateData";
 import getGlobalChartData from "./routes/getGlobalChartData";
 import getPageChartData from "./routes/getPageChartData";
 import getPageAggregateData from "./routes/getPageAggregateData";
+import getLiveData from "./routes/getLiveData";
+
 import type { CollectionConfig } from "payload/dist/collections/config/types";
 import { getPageViewsChart } from "./components/Charts/PageViewsChart";
 import { getAggregateDataWidget } from "./components/Aggregates/AggregateDataWidget";
@@ -65,6 +68,7 @@ const payloadDashboardAnalytics =
         getGlobalChartData(apiProvider),
         getPageChartData(apiProvider),
         getPageAggregateData(apiProvider),
+        getLiveData(apiProvider),
       ],
       ...(collections && {
         collections: collections.map((collection) => {

src/providers/index.ts

@@ -1,12 +1,14 @@
 import plausible from "./plausible";
 import type { Provider } from "../types";
 import type { ChartWidget, InfoWidget } from "../types/widgets";
-import type { ChartData, AggregateData } from "../types/data";
+import type { ChartData, AggregateData, LiveData } from "../types/data";
 
 type BaseOptions = {
   timeframe?: string;
 };
 
+export interface LiveDataOptions {}
+
 export interface GlobalAggregateOptions extends BaseOptions {
   metrics: InfoWidget["metrics"];
 }
@@ -32,6 +34,7 @@ export type ApiProvider = {
     options: PageAggregateOptions
   ) => Promise<AggregateData>;
   getPageChartData: (options: PageChartOptions) => Promise<ChartData>;
+  getLiveData: (options: LiveDataOptions) => Promise<LiveData>;
 };
 
 const getProvider = (provider: Provider) => {

src/providers/plausible/getLiveData.ts

@@ -0,0 +1,25 @@
+import type { PlausibleProvider } from "../../types/providers";
+import type { LiveDataOptions } from "..";
+import type { LiveData } from "../../types/data";
+import client from "./client";
+
+async function getLiveData(
+  provider: PlausibleProvider,
+  options: LiveDataOptions
+) {
+  const plausibleClient = client(provider, {
+    endpoint: "/stats/realtime/visitors",
+  });
+
+  const data = await plausibleClient.fetch().then((response) => {
+    return response.json();
+  });
+
+  const processedData: LiveData = {
+    visitors: data,
+  };
+
+  return processedData;
+}
+
+export default getLiveData;

src/providers/plausible/index.ts

@@ -3,12 +3,14 @@ import getGlobalAggregateData from "./getGlobalAggregateData";
 import getGlobalChartData from "./getGlobalChartData";
 import getPageAggregateData from "./getPageAggregateData";
 import getPageChartData from "./getPageChartData";
+import getLiveData from "./getLiveData";
 import type {
   ApiProvider,
   GlobalAggregateOptions,
   GlobalChartOptions,
   PageChartOptions,
   PageAggregateOptions,
+  LiveDataOptions,
 } from "..";
 
 const plausible = (provider: PlausibleProvider): ApiProvider => {
@@ -21,6 +23,8 @@ const plausible = (provider: PlausibleProvider): ApiProvider => {
       await getPageChartData(provider, options),
     getPageAggregateData: async (options: PageAggregateOptions) =>
       await getPageAggregateData(provider, options),
+    getLiveData: async (options: LiveDataOptions) =>
+      await getLiveData(provider, options),
   };
 };
 

src/routes/getGlobalAggregateData/handler.ts

@@ -13,7 +13,7 @@ const handler = (provider: ApiProvider) => {
       res.status(200).send(data);
     } catch (error) {
       payload.logger.error(payload);
-      res.status(500);
+      res.sendStatus(500);
     }
   };
 

src/routes/getGlobalChartData/handler.ts

@@ -14,7 +14,7 @@ const handler = (provider: ApiProvider) => {
       res.status(200).send(data);
     } catch (error) {
       payload.logger.error(error);
-      res.status(500);
+      res.sendStatus(500);
     }
   };
 

src/routes/getLiveData/handler.ts

@@ -0,0 +1,20 @@
+import { Endpoint } from "payload/config";
+import { ApiProvider } from "../../providers";
+import payload from "payload";
+
+const handler = (provider: ApiProvider) => {
+  const handler: Endpoint["handler"] = async (req, res, next) => {
+    try {
+      const data = await provider.getLiveData({});
+
+      res.status(200).send(data);
+    } catch (error) {
+      payload.logger.error(error);
+      res.sendStatus(500);
+    }
+  };
+
+  return handler;
+};
+
+export default handler;

src/routes/getLiveData/index.ts

@@ -0,0 +1,13 @@
+import { Endpoint } from "payload/config";
+import handler from "./handler";
+import { ApiProvider } from "../../providers";
+
+const getLiveData = (provider: ApiProvider): Endpoint => {
+  return {
+    path: "/analytics/liveData",
+    method: "post",
+    handler: handler(provider),
+  };
+};
+
+export default getLiveData;

src/routes/getPageAggregateData/handler.ts

@@ -17,7 +17,7 @@ const handler = (provider: ApiProvider) => {
       res.status(200).send(data);
     } catch (error) {
       payload.logger.error(error);
-      res.status(500);
+      res.sendStatus(500);
     }
   };
 

src/routes/getPageChartData/handler.ts

@@ -17,7 +17,7 @@ const handler = (provider: ApiProvider) => {
       res.status(200).send(data);
     } catch (error) {
       payload.logger.error(error);
-      res.status(500);
+      res.sendStatus(500);
     }
   };