feat: adds 'Common Pages' functionality

re micheleriva#31

Author: TheLeePriest

packages/express-krabs/index.ts

@@ -2,7 +2,7 @@ import { Request, Response } from 'express';
 import { parse } from 'url';
 import * as path from 'path';
 import { getTenantConfig } from '../utils/config';
-import { Config } from '../utils/config/config';
+import { Config, Options } from '../utils/config/config';
 import findTenant from '../utils/tenants/findTenant';
 import resolveRoutes from '../utils/routes/resolve';
 import { currentEnv, environmentWarningMessage } from '../utils/env';
@@ -12,11 +12,12 @@ if (!currentEnv) {
 }
 
 async function krabs(
-  req: Request,
-  res: Response,
-  handle: any,
-  app: any,
-  config?: Config,
+    req: Request,
+    res: Response,
+    handle: any,
+    app: any,
+    config?: Config,
+    options?: Options
 ): Promise<void> {
   const { tenants, enableVhostHeader } = config ?? (await getTenantConfig());
 
@@ -44,8 +45,8 @@ async function krabs(
     try {
       const APIPath = pathname.replace(/^\/api\//, '');
       const { default: APIhandler } = require(path.join(
-        process.cwd(),
-        `pages/${tenant.name}/api/${APIPath}`,
+          process.cwd(),
+          `pages/${tenant.name}/api/${APIPath}`,
       ));
       APIhandler(req, res);
     } catch (_) {
@@ -54,7 +55,7 @@ async function krabs(
     return;
   }
 
-  const route = resolveRoutes(tenant.name, String(pathname));
+  const route = resolveRoutes(tenant.name, String(pathname), options?.commonPages);
 
   if (route) {
     // @ts-ignore

packages/fastify-krabs/index.ts

@@ -1,6 +1,6 @@
 import type { FastifyRequest, FastifyReply } from 'fastify';
 import { getTenantConfig } from '../utils/config';
-import { Config } from '../utils/config/config';
+import { Config, Options } from '../utils/config/config';
 import findTenant from '../utils/tenants/findTenant';
 import resolveRoutes from '../utils/routes/resolve';
 import { currentEnv, environmentWarningMessage } from '../utils/env';
@@ -10,14 +10,16 @@ if (!currentEnv) {
 }
 
 export default async function krabs(
-  request: FastifyRequest,
-  reply: FastifyReply,
-  handle: any,
-  app: any,
-  config?: Config): Promise<void> {
+    request: FastifyRequest,
+    reply: FastifyReply,
+    handle: any,
+    app: any,
+    config?: Config,
+    options?: Options
+): Promise<void> {
 
   const { tenants, enableVhostHeader } = config ?? (await getTenantConfig());
-    
+
   const vhostHeader = enableVhostHeader && request.headers['x-vhost'] as string;
   const rawHostname = request.hostname;
   const pathName = request.url;
@@ -33,7 +35,7 @@ export default async function krabs(
     });
   }
 
-  const route = resolveRoutes(tenant?.name as string, pathName);
+  const route = resolveRoutes(tenant?.name as string, pathName, options?.commonPages);
 
   if (route) {
     // @ts-ignore
@@ -44,4 +46,4 @@ export default async function krabs(
 
   handle(request, reply);
   return;
-};
+};

packages/utils/config/config.d.ts

@@ -16,6 +16,10 @@ export type Config = {
   enableVhostHeader: boolean;
 };
 
+export type Options = {
+  commonPages: boolean;
+};
+
 export type ConfigEntry = (() => Config) | (() => Promise<Config>) | Config;
 
 export default Config;

packages/utils/routes/resolve.ts

@@ -1,4 +1,19 @@
-export function resolveRoutes(tenantName: string, pathname: string): string {
+const fs = require('fs');
+const path = require('path');
+
+export function resolveRoutes(
+  tenantName: string,
+  pathname: string,
+  commonPages: boolean | undefined,
+): string {
+  const pageExistsInTenant = fs.existsSync(
+    path.join(process.cwd(), 'pages', tenantName, `${pathname}.js`),
+  );
+
+  if (commonPages && !pageExistsInTenant && pathname !== '/') {
+    return `${pathname}`;
+  }
+
   return pathname === '/' ? `/${tenantName}` : `/${tenantName}${pathname}`;
 }