feat: nextjs api

solana-foundation · Jul 18, 2023 · bb5bb74 · bb5bb74
1 parent 52ac699
commit bb5bb74
Show file tree

Hide file tree

Showing 26 changed files with 3,417 additions and 723 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}
diff --git a/.gitignore b/.gitignore
@@ -50,6 +50,9 @@ typings/
 # Optional npm cache directory
 .npm
 
+# Next.js build output
+.next
+
 # Optional eslint cache
 .eslintcache
 

diff --git a/.prettierrc b/.prettierrc
@@ -7,4 +7,4 @@
   "arrowParens": "avoid",
   "endOfLine": "auto",
   "proseWrap": "always"
-}
+}
diff --git a/generic.d.ts b/generic.d.ts
@@ -0,0 +1,9 @@
+type Without<T, K> = Pick<T, Exclude<keyof T, K>>;
+
+type Option<T> = Some<T> | None;
+
+type Entries<T> = {
+  [K in keyof T]: [K, T[K]];
+}[keyof T][];
+
+type SimpleNotFound = { notFound: true };
diff --git a/next-env.d.ts b/next-env.d.ts
@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.
diff --git a/next.config.cjs b/next.config.cjs
@@ -0,0 +1,30 @@
+/** @type {import('next').NextConfig} */
+
+const { withContentlayer } = require("next-contentlayer");
+
+module.exports = withContentlayer({
+  reactStrictMode: true,
+  eslint: {
+    // Warning: This allows production builds to successfully complete even if
+    // your project has ESLint errors.
+    // ignoreDuringBuilds: true,
+  },
+  compiler: {
+    styledComponents: true,
+  },
+  swcMinify: true,
+  // webpack5: true,
+  webpack: config => {
+    config.resolve.fallback = { fs: false, path: false };
+
+    return config;
+  },
+  images: {
+    remotePatterns: [
+      {
+        protocol: "https",
+        hostname: "**",
+      },
+    ],
+  },
+});
diff --git a/package.json b/package.json
@@ -10,14 +10,29 @@
   "scripts": {
     "runner": "npx ts-node -r tsconfig-paths/register",
     "contentlayer:build": "npx contentlayer build --clearCache",
-    "test": "yarn contentlayer:build"
+    "test": "yarn contentlayer:build",
+    "dev": "yarn contentlayer:build && next dev",
+    "build": "yarn contentlayer:build && next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@types/node": "20.4.2",
+    "@types/react": "18.2.15",
+    "@types/react-dom": "18.2.7",
+    "autoprefixer": "10.4.14",
+    "eslint": "8.45.0",
+    "eslint-config-next": "13.4.10",
+    "next": "13.4.10",
+    "next-contentlayer": "^0.3.4",
+    "postcss": "8.4.26",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "tailwindcss": "3.3.3",
+    "typescript": "5.1.6"
   },
   "devDependencies": {
     "contentlayer": "0.3.0",
-    "eslint": "^8.38.0",
-    "gray-matter": "^4.0.3",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.0.4"
+    "prettier": "^3.0.0"
   }
 }
diff --git a/postcss.config.js b/postcss.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}
diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/robots.txt b/public/robots.txt
@@ -0,0 +1,5 @@
+# *
+User-agent: *
+Disallow: /api/
+Disallow: /auth/
+Disallow: *
diff --git a/src/pages/_app.tsx b/src/pages/_app.tsx
@@ -0,0 +1,6 @@
+import '@/styles/globals.css'
+import type { AppProps } from 'next/app'
+
+export default function App({ Component, pageProps }: AppProps) {
+  return <Component {...pageProps} />
+}
diff --git a/src/pages/_document.tsx b/src/pages/_document.tsx
@@ -0,0 +1,13 @@
+import { Html, Head, Main, NextScript } from "next/document";
+
+export default function Document() {
+  return (
+    <Html lang="en">
+      <Head />
+      <body>
+        <Main />
+        <NextScript />
+      </body>
+    </Html>
+  );
+}
diff --git a/src/pages/api/[[...index]].ts b/src/pages/api/[[...index]].ts
@@ -0,0 +1,5 @@
+import type { NextApiRequest, NextApiResponse } from "next";
+
+export default function handler(req: NextApiRequest, res: NextApiResponse) {
+  return res.status(403).send("Unauthorized");
+}
diff --git a/src/pages/api/content/[[...slug]].ts b/src/pages/api/content/[[...slug]].ts
@@ -0,0 +1,79 @@
+/**
+ * api route to retrieve a single piece of content,
+ * based on the provided url `slug`
+ */
+
+import { SimpleRecordGroupName } from "@/types";
+import { computeNavItem } from "@/utils/navItem";
+import {
+  allDeveloperGuides,
+  allDeveloperResources,
+  allSolanaDocs,
+} from "contentlayer/generated";
+import type { NextApiRequest, NextApiResponse } from "next";
+
+export default function handler(
+  req: NextApiRequest,
+  res: NextApiResponse<SimpleNotFound | any>,
+) {
+  // get the content record group
+  const slug = req.query?.slug || [];
+
+  if (!slug || !Array.isArray(slug) || slug.length <= 0)
+    return res.status(404).json({ notFound: true });
+
+  const group = slug[0] as SimpleRecordGroupName;
+
+  // retrieve the correct group's records by its simple group name
+  const records = ((group: SimpleRecordGroupName) => {
+    switch (group) {
+      case "docs":
+        return allSolanaDocs;
+      case "guides":
+        return allDeveloperGuides;
+      case "resources":
+        return allDeveloperResources;
+    }
+  })(group);
+
+  if (!records) return res.status(404).json({ notFound: true });
+
+  // define the formatted href value to search for
+  const href = `/${slug.join("/")}`;
+
+  // init the record to be returned
+  let record;
+
+  // locate the correct record requested (via the url param)
+  for (let i = 0; i < records.length; i++) {
+    // @ts-ignore
+    const navItem = computeNavItem(records[i]);
+
+    // only care about the requested record
+    if (navItem.href != href) continue;
+
+    // set the requested record's data (weaving in the computed nav item data)
+    record = Object.assign(navItem, records[i]);
+
+    /**
+     * todo: support next/prev type records
+     * note: this will likely require processing the nav records?
+     */
+
+    // break out of the loop and stop processing
+    break;
+  }
+
+  if (!record) return res.status(404).json({ notFound: true });
+
+  // remove the html formatted content (since it is undesired data to send over the wire)
+  // @ts-ignore
+  record.body = record.body.raw.trim();
+
+  // todo: preprocess the body content? (if desired in the future)
+
+  // todo: support sending related content records back to the client
+
+  // finally, return the json formatted listing of NavItems
+  return res.status(200).json(record);
+}
diff --git a/src/pages/api/nav/[group].ts b/src/pages/api/nav/[group].ts
@@ -0,0 +1,41 @@
+/**
+ * api route to generate the nav item listing for
+ * each supported content record `group`
+ */
+
+import type { NextApiRequest, NextApiResponse } from "next";
+import { NavItem, SimpleRecordGroupName } from "@/types";
+import { generateNavItemListing } from "@/utils/navItem";
+import {
+  allDeveloperGuides,
+  allDeveloperResources,
+  allSolanaDocs,
+} from "contentlayer/generated";
+
+export default function handler(
+  req: NextApiRequest,
+  res: NextApiResponse<SimpleNotFound | NavItem[]>,
+) {
+  // get the content record group
+  const group = req.query?.group?.toString() as SimpleRecordGroupName;
+  if (!group) return res.status(404).json({ notFound: true });
+
+  // retrieve the correct group's records by its simple group name
+  const records = ((group: SimpleRecordGroupName) => {
+    switch (group) {
+      case "docs":
+        return allSolanaDocs;
+      case "guides":
+        return allDeveloperGuides;
+      // case "resources":
+      //   return allDeveloperResources;
+    }
+  })(group);
+
+  if (!records) return res.status(404).json({ notFound: true });
+
+  const navItems = generateNavItemListing(records);
+
+  // finally, return the json formatted listing of NavItems
+  return res.status(200).json(navItems);
+}
diff --git a/src/pages/api/paths/[group].ts b/src/pages/api/paths/[group].ts
@@ -0,0 +1,59 @@
+/**
+ * api route to generate a path listing for
+ * each supported content record `group`
+ */
+
+import type { NextApiRequest, NextApiResponse } from "next";
+import { NavItem, SimpleRecordGroupName } from "@/types";
+import { computeNavItem, shouldIgnoreRecord } from "@/utils/navItem";
+import {
+  allDeveloperGuides,
+  allDeveloperResources,
+  allSolanaDocs,
+} from "contentlayer/generated";
+
+export default function handler(
+  req: NextApiRequest,
+  res: NextApiResponse<SimpleNotFound | NavItem[]>,
+) {
+  // get the content record group
+  const group = req.query?.group?.toString() as SimpleRecordGroupName;
+  if (!group) return res.status(404).json({ notFound: true });
+
+  // retrieve the correct group's records by its simple group name
+  const records = ((group: SimpleRecordGroupName) => {
+    switch (group) {
+      case "docs":
+        return allSolanaDocs;
+      case "guides":
+        return allDeveloperGuides;
+      case "resources":
+        return allDeveloperResources;
+    }
+  })(group);
+
+  if (!records) return res.status(404).json({ notFound: true });
+
+  // init the listing response
+  const listing: Array<NavItem> = [];
+
+  /**
+   * todo: assorted things
+   * - better support for external links
+   */
+
+  // compute the path data to return
+  records.map(record => {
+    if (shouldIgnoreRecord({ fileName: record._raw.sourceFileName })) return;
+
+    // @ts-ignore
+    const navItem = computeNavItem(record);
+
+    if (!navItem.href || !!record.isExternal) return;
+
+    listing.push(navItem);
+  });
+
+  // finally, return the json formatted listing
+  return res.status(200).json(listing);
+}
diff --git a/src/pages/api/records/[group].ts b/src/pages/api/records/[group].ts
@@ -0,0 +1,66 @@
+/**
+ * api route to generate a listing of records for a given `group`
+ */
+
+import type { NextApiRequest, NextApiResponse } from "next";
+import { NavItem, SimpleRecordGroupName } from "@/types";
+import { computeNavItem, shouldIgnoreRecord } from "@/utils/navItem";
+import {
+  allDeveloperGuides,
+  allDeveloperResources,
+  allSolanaDocs,
+} from "contentlayer/generated";
+
+export default function handler(
+  req: NextApiRequest,
+  res: NextApiResponse<SimpleNotFound | NavItem[]>,
+) {
+  // get the content record group
+  const group = req.query?.group?.toString() as SimpleRecordGroupName;
+  if (!group) return res.status(404).json({ notFound: true });
+
+  // retrieve the correct group's records by its simple group name
+  const records = ((group: SimpleRecordGroupName) => {
+    switch (group) {
+      case "docs":
+        return allSolanaDocs;
+      case "guides":
+        return allDeveloperGuides;
+      case "resources":
+        return allDeveloperResources;
+    }
+  })(group);
+
+  if (!records) return res.status(404).json({ notFound: true });
+
+  const listing: Array<any> = [];
+
+  // compute the listing data to return
+  records.map(record => {
+    if (shouldIgnoreRecord({ fileName: record._raw.sourceFileName })) return;
+
+    // @ts-ignore
+    const navItem = computeNavItem(record);
+
+    if (!navItem.href) return;
+
+    // @ts-ignore
+    record = Object.assign(navItem, record);
+
+    const attributesToDelete = ["_id", "_raw", "body", "type"];
+
+    if (!record.featured)
+      attributesToDelete.push("featured", "featuredPriority");
+
+    // remove any undesired content from the response
+    // @ts-ignore
+    attributesToDelete.forEach(e => delete record[e]);
+
+    listing.push(record);
+  });
+
+  // todo: add pagination support?
+
+  // finally, return the json formatted listing
+  return res.status(200).json(listing);
+}