Update types for page aggregate data too

Author: paulpopus

demo/src/payload.config.ts

@@ -67,7 +67,7 @@ export default buildConfig({
             {
               type: "chart",
               metrics: ["uniqueVisitors"],
-              timeframe: "month",
+              timeframe: "currentMonth",
               idMatcher: (document: any) => `/articles/${document.slug}`,
             },
             /* {

src/extendWebpackConfig.ts

@@ -21,6 +21,8 @@ export const extendWebpackConfig =
             ? existingWebpackConfig.resolve.alias
             : {}),
           express: mockModulePath,
+          [path.resolve(__dirname, "./providers/plausible/client")]:
+            mockModulePath,
         },
       },
     };

src/providers/index.ts

@@ -15,6 +15,7 @@ export interface GlobalChartOptions extends BaseOptions {
 
 export interface PageAggregateOptions extends BaseOptions {
   metrics: InfoWidget["metrics"];
+  pageId: string;
 }
 export interface PageChartOptions extends BaseOptions {
   metrics: ChartWidget["metrics"];
@@ -24,7 +25,7 @@ export interface PageChartOptions extends BaseOptions {
 export type ApiProvider = {
   getGlobalAggregateData: (options: GlobalAggregateOptions) => Promise<any>;
   getGlobalChartData: (options: GlobalChartOptions) => Promise<any>;
-  /* getPageAggregateData: (options?: PageAggregateOptions) => Promise<any>; */
+  getPageAggregateData: (options: PageAggregateOptions) => Promise<any>;
   getPageChartData: (options: PageChartOptions) => Promise<any>;
 };
 

src/providers/plausible/client.ts

@@ -27,7 +27,17 @@ function client(provider: PlausibleProvider, options: ClientOptions) {
   const host = provider.host ?? `https://plausible.io`;
   const apiVersion = `v1`; // for future use
 
-  const period = timeframe ?? "30d";
+  const period = () => {
+    switch (timeframe) {
+      case "currentMonth":
+        return "month";
+      case null:
+      case undefined:
+        return "30d";
+      default:
+        return timeframe;
+    }
+  };
 
   const url = new URL(`${host}/api/${apiVersion}${endpoint}`);
   url.searchParams.append("site_id", provider.siteId);
@@ -50,7 +60,7 @@ function client(provider: PlausibleProvider, options: ClientOptions) {
   const plausibleMetrics = metrics?.length ? getMetrics() : "pageviews";
 
   const baseUrl = String(url.href);
-  url.searchParams.append("period", period);
+  url.searchParams.append("period", period());
   url.searchParams.append("metrics", String(plausibleMetrics));
 
   return {
@@ -61,8 +71,6 @@ function client(provider: PlausibleProvider, options: ClientOptions) {
     fetch: async (customUrl?: string) => {
       const fetchUrl = customUrl ?? url.toString();
 
-      console.log("fetching data with ", fetchUrl);
-
       return await fetch(fetchUrl, {
         method: "get",
         headers: new Headers({

src/providers/plausible/getGlobalAggregateData.ts

@@ -4,11 +4,12 @@ import client from "./client";
 
 async function getGlobalAggregateData(
   provider: PlausibleProvider,
-  options?: GlobalAggregateOptions
+  options: GlobalAggregateOptions
 ) {
   const plausibleClient = client(provider, {
     endpoint: "/stats/aggregate",
-    timeframe: options?.timeframe,
+    timeframe: options.timeframe,
+    metrics: options.metrics,
   });
 
   const data = await plausibleClient.fetch().then((response) => {

src/providers/plausible/getGlobalChartData.ts

@@ -12,7 +12,7 @@ async function getGlobalChartData(
   const plausibleClient = client(provider, {
     endpoint: "/stats/timeseries",
     timeframe: options?.timeframe,
-    metrics: options?.metrics,
+    metrics: options.metrics,
   });
 
   const { results } = await plausibleClient

src/providers/plausible/getPageAggregateData.ts

@@ -1,17 +1,24 @@
 import type { PlausibleProvider } from "../../types/providers";
-import type { GlobalAggregateOptions } from "..";
+import type { PageAggregateOptions } from "..";
 import client from "./client";
 
 async function getPageAggregateData(
   provider: PlausibleProvider,
-  options?: GlobalAggregateOptions
+  options: PageAggregateOptions
 ) {
   const plausibleClient = client(provider, {
     endpoint: "/stats/aggregate",
     timeframe: options?.timeframe,
+    metrics: options.metrics,
   });
 
-  const data = await plausibleClient.fetch().then((response) => {
+  const url = plausibleClient.url;
+
+  const pageFilter = `event:page==${options.pageId}`;
+
+  url.searchParams.append("filters", pageFilter);
+
+  const data = await plausibleClient.fetch(url.toString()).then((response) => {
     return response.json();
   });
 

src/providers/plausible/index.ts

@@ -19,6 +19,8 @@ const plausible = (provider: PlausibleProvider): ApiProvider => {
       await getGlobalChartData(provider, options),
     getPageChartData: async (options: PageChartOptions) =>
       await getPageChartData(provider, options),
+    getPageAggregateData: async (options: PageAggregateOptions) =>
+      await getPageAggregateData(provider, options),
   };
 };
 

src/routes/getPageAggregateData/handler.ts

@@ -0,0 +1,27 @@
+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 { timeframe, metrics, pageId } = req.body;
+
+      console.log("reached handler with", timeframe, metrics, pageId);
+
+      const data = await provider.getPageAggregateData({
+        timeframe: timeframe,
+        metrics: metrics,
+        pageId,
+      });
+      res.status(200).send(data);
+    } catch (error) {
+      payload.logger.error(error);
+      res.status(500);
+    }
+  };
+
+  return handler;
+};
+
+export default handler;

src/routes/getPageAggregateData/index.ts

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