Rename routes

paulpopus · paulpopus · commit 6ecc7de142be · 2023-04-12T12:28:58.000+07:00
diff --git a/src/components/Reports/TopPages.tsx b/src/components/Reports/TopPages.tsx
@@ -0,0 +1,16 @@
+import React, {
+  useEffect,
+  useState,
+  lazy,
+  useReducer,
+  useRef,
+  useMemo,
+} from "react";
+
+interface Props {}
+
+const TopPages: React.FC<Props> = () => {
+  return <div>hello</div>;
+};
+
+export default TopPages;
diff --git a/src/index.ts b/src/index.ts
@@ -1,63 +1,30 @@
 import type { Config as PayloadConfig } from "payload/config";
 import type { DashboardAnalyticsConfig } from "./types";
-import type {
-  PageInfoWidget,
-  PageChartWidget,
-  PageWidgets,
-  NavigationWidgets,
-  DashboardWidgets,
-} from "./types/widgets";
-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 getGlobalAggregate from "./routes/getGlobalAggregate";
+import getGlobalChart from "./routes/getGlobalChart";
+import getPageChart from "./routes/getPageChart";
+import getPageAggregate from "./routes/getPageAggregate";
+import getLive from "./routes/getLive";
+import getReport from "./routes/getReport";
 
 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 LiveDataComponent from "./components/Live/LiveDataWidget";
-
-const PageWidgetMap: Record<
-  PageWidgets["type"],
-  (config: any, index: number) => Field
-> = {
-  chart: (config: PageChartWidget, index: number) => ({
-    type: "ui",
-    name: `chart_${index}_${config.timeframe ?? "30d"}`,
-    admin: {
-      position: "sidebar",
-      components: {
-        Field: (props: any) => getPageViewsChart(props, config),
-      },
-    },
-  }),
-  info: (config: PageInfoWidget) => ({
-    type: "ui",
-    name: "dashboardAnalyticsViewsChart",
-    admin: {
-      position: "sidebar",
-      components: {
-        Field: (props: any) => getAggregateDataWidget(props, config),
-      },
-    },
-  }),
-};
 
-const NavigationWidgetMap: Record<NavigationWidgets["type"], React.FC> = {
-  live: LiveDataComponent.LiveDataWidget,
-};
+import {
+  PageWidgetMap,
+  NavigationWidgetMap,
+  DashboardWidgetMap,
+} from "./utilities/widgetMaps";
 
 const payloadDashboardAnalytics =
   (incomingConfig: DashboardAnalyticsConfig) =>
   (config: PayloadConfig): PayloadConfig => {
     const { admin, collections, globals } = config;
-    const { provider, navigation } = incomingConfig;
+    const { provider, navigation, dashboard } = incomingConfig;
     const endpoints = config.endpoints ?? [];
     const apiProvider = getProvider(provider);
 
@@ -83,16 +50,33 @@ const payloadDashboardAnalytics =
               ),
             ],
           }),
+          ...(dashboard?.beforeDashboard && {
+            beforeDashboard: [
+              ...(admin?.components?.beforeDashboard ?? []),
+              ...dashboard.beforeDashboard.map(
+                (widget) => DashboardWidgetMap[widget]
+              ),
+            ],
+          }),
+          ...(dashboard?.afterDashboard && {
+            afterDashboard: [
+              ...(admin?.components?.afterDashboard ?? []),
+              ...dashboard.afterDashboard.map(
+                (widget) => DashboardWidgetMap[widget]
+              ),
+            ],
+          }),
         },
         webpack: extendWebpackConfig(config),
       },
       endpoints: [
         ...endpoints,
-        getGlobalAggregateData(apiProvider),
-        getGlobalChartData(apiProvider),
-        getPageChartData(apiProvider),
-        getPageAggregateData(apiProvider),
-        getLiveData(apiProvider),
+        getGlobalAggregate(apiProvider),
+        getGlobalChart(apiProvider),
+        getPageChart(apiProvider),
+        getPageAggregate(apiProvider),
+        getLive(apiProvider),
+        getReport(apiProvider),
       ],
       ...(collections && {
         collections: collections.map((collection) => {
diff --git a/src/providers/index.ts b/src/providers/index.ts
@@ -1,14 +1,24 @@
 import plausible from "./plausible";
 import type { Provider } from "../types";
-import type { ChartWidget, InfoWidget } from "../types/widgets";
-import type { ChartData, AggregateData, LiveData } from "../types/data";
+import type { ChartWidget, InfoWidget, ReportWidget } from "../types/widgets";
+import type {
+  ChartData,
+  AggregateData,
+  LiveData,
+  ReportData,
+} from "../types/data";
 
 type BaseOptions = {
   timeframe?: string;
 };
 
 export interface LiveDataOptions {}
 
+export interface ReportDataOptions extends BaseOptions {
+  metrics: ReportWidget["metrics"];
+  property: ReportWidget["property"];
+}
+
 export interface GlobalAggregateOptions extends BaseOptions {
   metrics: InfoWidget["metrics"];
 }
@@ -35,6 +45,7 @@ export type ApiProvider = {
   ) => Promise<AggregateData>;
   getPageChartData: (options: PageChartOptions) => Promise<ChartData>;
   getLiveData: (options: LiveDataOptions) => Promise<LiveData>;
+  getReportData: (options: ReportDataOptions) => Promise<ReportData>;
 };
 
 const getProvider = (provider: Provider) => {
diff --git a/src/providers/plausible/getReportData.ts b/src/providers/plausible/getReportData.ts
@@ -0,0 +1,25 @@
+import type { PlausibleProvider } from "../../types/providers";
+import type { ReportDataOptions } from "..";
+import type { ReportData } from "../../types/data";
+import client from "./client";
+
+async function getReportData(
+  provider: PlausibleProvider,
+  options: ReportDataOptions
+) {
+  const plausibleClient = client(provider, {
+    endpoint: "/stats/breakdown",
+  });
+
+  const data = await plausibleClient.fetch().then((response) => {
+    return response.json();
+  });
+
+  const processedData: ReportData = data.results.map((item: any) => {
+    return item;
+  });
+
+  return processedData;
+}
+
+export default getReportData;
diff --git a/src/providers/plausible/index.ts b/src/providers/plausible/index.ts
@@ -4,13 +4,15 @@ import getGlobalChartData from "./getGlobalChartData";
 import getPageAggregateData from "./getPageAggregateData";
 import getPageChartData from "./getPageChartData";
 import getLiveData from "./getLiveData";
+import getReportData from "./getReportData";
 import type {
   ApiProvider,
   GlobalAggregateOptions,
   GlobalChartOptions,
   PageChartOptions,
   PageAggregateOptions,
   LiveDataOptions,
+  ReportDataOptions,
 } from "..";
 
 const plausible = (provider: PlausibleProvider): ApiProvider => {
@@ -25,6 +27,8 @@ const plausible = (provider: PlausibleProvider): ApiProvider => {
       await getPageAggregateData(provider, options),
     getLiveData: async (options: LiveDataOptions) =>
       await getLiveData(provider, options),
+    getReportData: async (options: ReportDataOptions) =>
+      await getReportData(provider, options),
   };
 };
 
diff --git a/src/routes/getGlobalAggregate/handler.ts b/src/routes/getGlobalAggregate/handler.ts
diff --git a/src/routes/getGlobalAggregate/index.ts b/src/routes/getGlobalAggregate/index.ts
@@ -2,12 +2,12 @@ import { Endpoint } from "payload/config";
 import handler from "./handler";
 import { ApiProvider } from "../../providers";
 
-const getGlobalChartData = (provider: ApiProvider): Endpoint => {
+const getGlobalAggregate = (provider: ApiProvider): Endpoint => {
   return {
-    path: "/analytics/globalChartData",
+    path: "/analytics/globalAggregate",
     method: "post",
     handler: handler(provider),
   };
 };
 
-export default getGlobalChartData;
+export default getGlobalAggregate;
diff --git a/src/routes/getGlobalAggregateData/index.ts b/src/routes/getGlobalAggregateData/index.ts
diff --git a/src/routes/getGlobalChart/handler.ts b/src/routes/getGlobalChart/handler.ts
diff --git a/src/routes/getGlobalChart/index.ts b/src/routes/getGlobalChart/index.ts
@@ -2,12 +2,12 @@ import { Endpoint } from "payload/config";
 import handler from "./handler";
 import { ApiProvider } from "../../providers";
 
-const getPageChartData = (provider: ApiProvider): Endpoint => {
+const getGlobalChart = (provider: ApiProvider): Endpoint => {
   return {
-    path: "/analytics/pageChartData",
+    path: "/analytics/globalChart",
     method: "post",
     handler: handler(provider),
   };
 };
 
-export default getPageChartData;
+export default getGlobalChart;
diff --git a/src/routes/getLive/handler.ts b/src/routes/getLive/handler.ts
diff --git a/src/routes/getLive/index.ts b/src/routes/getLive/index.ts
@@ -2,12 +2,12 @@ import { Endpoint } from "payload/config";
 import handler from "./handler";
 import { ApiProvider } from "../../providers";
 
-const getLiveData = (provider: ApiProvider): Endpoint => {
+const getLive = (provider: ApiProvider): Endpoint => {
   return {
-    path: "/analytics/liveData",
+    path: "/analytics/live",
     method: "post",
     handler: handler(provider),
   };
 };
 
-export default getLiveData;
+export default getLive;
diff --git a/src/routes/getPageAggregate/handler.ts b/src/routes/getPageAggregate/handler.ts
diff --git a/src/routes/getPageAggregate/index.ts b/src/routes/getPageAggregate/index.ts
@@ -2,12 +2,12 @@ import { Endpoint } from "payload/config";
 import handler from "./handler";
 import { ApiProvider } from "../../providers";
 
-const getPageAggregateData = (provider: ApiProvider): Endpoint => {
+const getPageAggregate = (provider: ApiProvider): Endpoint => {
   return {
-    path: "/analytics/pageAggregateData",
+    path: "/analytics/pageAggregate",
     method: "post",
     handler: handler(provider),
   };
 };
 
-export default getPageAggregateData;
+export default getPageAggregate;
diff --git a/src/routes/getPageChart/handler.ts b/src/routes/getPageChart/handler.ts
diff --git a/src/routes/getPageChart/index.ts b/src/routes/getPageChart/index.ts
@@ -0,0 +1,13 @@
+import { Endpoint } from "payload/config";
+import handler from "./handler";
+import { ApiProvider } from "../../providers";
+
+const getPageChart = (provider: ApiProvider): Endpoint => {
+  return {
+    path: "/analytics/pageChart",
+    method: "post",
+    handler: handler(provider),
+  };
+};
+
+export default getPageChart;
diff --git a/src/routes/getReport/handler.ts b/src/routes/getReport/handler.ts
@@ -0,0 +1,26 @@
+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 { property, metrics, timeframe } = req.body;
+
+      const data = await provider.getReportData({
+        property,
+        metrics,
+        timeframe,
+      });
+
+      res.status(200).send(data);
+    } catch (error) {
+      payload.logger.error(error);
+      res.sendStatus(500);
+    }
+  };
+
+  return handler;
+};
+
+export default handler;
diff --git a/src/routes/getReport/index.ts b/src/routes/getReport/index.ts
@@ -0,0 +1,13 @@
+import { Endpoint } from "payload/config";
+import handler from "./handler";
+import { ApiProvider } from "../../providers";
+
+const getReport = (provider: ApiProvider): Endpoint => {
+  return {
+    path: "/analytics/report",
+    method: "post",
+    handler: handler(provider),
+  };
+};
+
+export default getReport;
diff --git a/src/types/data.d.ts b/src/types/data.d.ts
@@ -21,6 +21,8 @@ export type LiveData = {
   visitors: number;
 };
 
+export type ReportData = {}[];
+
 export type MetricsMap = Record<
   AllAvailableMetrics,
   { label: string; value: string }
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -33,7 +33,6 @@ export type DashboardAnalyticsConfig = {
   };
   dashboard?: {
     beforeDashboard?: DashboardWidgets[];
-    dashboard?: DashboardWidgets[];
     afterDashboard?: DashboardWidgets[];
   };
 };
diff --git a/src/types/widgets.d.ts b/src/types/widgets.d.ts
@@ -9,6 +9,13 @@ export type Metrics =
   | "bounceRate"
   | "sessionDuration";
 
+export type Properties =
+  | "page"
+  | "entryPoint"
+  | "exitPoint"
+  | "source"
+  | "country";
+
 export type AllAvailableMetrics = Metrics;
 
 /* Keeping this for later */
@@ -39,6 +46,8 @@ export interface LiveWidget {
 export interface ReportWidget {
   type: "report";
   report: Reports;
+  property: Properties;
+  metrics: Metrics[];
   timeframe?: Timeframes;
 }
 
diff --git a/src/utilities/widgetMaps.ts b/src/utilities/widgetMaps.ts
