Merge pull request #24 from bericp1/chore/rename-now-to-vercel

[Chore] Rename now to vercel

README.md

@@ -5,15 +5,15 @@ for `netlify-cms`.
 
 This package exposes an API that makes it easy to use in a traditional long-running Node server (i.e. using `express`)
 or in stateless serverless functions (i.e.
-[Zeit Now Serverless Functions](https://zeit.co/docs/v2/serverless-functions/introduction)).
+[Vercel Serverless Functions](https://vercel.com/docs/serverless-functions/introduction)).
 
 ## Usage
 
-**Note:** More detailed documentation and inline code samples are in the works. For now it's best to check out the
+**Note:** More detailed documentation and inline code samples are in the works. For now, it's best to check out the
 examples:
 
 -   [Generic Node HTTP server](./examples/generic)
--   [Zeit Now functions](./examples/now)
+-   [Vercel functions](./examples/vercel)
 
 ### Overview
 
@@ -22,9 +22,9 @@ This library exports handler-creating functions:
 -   `createBeginHandler(config: object, options: CreateConfigOptions): function(state: string=): Promise<string>`
 -   `createCompleteHandler(config: object, options: CreateConfigOptions): function(code: string=, params: object=): Promise<string>`
 -   `createHandlers(config: object, options: CreateConfigOptions): ({ begin: (function(state: string=): Promise<string>), complete: (function(code: string=, params: object=): Promise<string>) })`
--   `createNowBeginHandler(config: object, options: CreateConfigOptions): AsyncNowServerlessFunction`
--   `createNowCompleteHandler(config: object, options: CreateConfigOptions): AsyncNowServerlessFunction`
--   `createNowHandlers(config: object, options: CreateConfigOptions): ({ begin: AsyncNowServerlessFunction, complete: AsyncNowServerlessFunction })`
+-   `createVercelBeginHandler(config: object, options: CreateConfigOptions): AsyncVercelServerlessFunction`
+-   `createVercelCompleteHandler(config: object, options: CreateConfigOptions): AsyncVercelServerlessFunction`
+-   `createVercelHandlers(config: object, options: CreateConfigOptions): ({ begin: AsyncVercelServerlessFunction, complete: AsyncVercelServerlessFunction })`
 
 They do the following:
 
@@ -38,12 +38,12 @@ They do the following:
         the authorization code with the provider to netlify-cms.
     -   `createHandlers`: Creates both of the above handlers and returns an object containing them on the `begin` and
         `complete` keys.
--   Zeit Now Handlers
-    -   `createNowBeginHandler`: Creates an async Zeit Now serverless function that handles everything for you and
+-   Vercel Handlers
+    -   `createVercelBeginHandler`: Creates an async Vercel serverless function that handles everything for you and
         delegates to the generic begin handler described above.
-    -   `createCompleteHandler`: Creates an async Zeit Now serverless function that handles everything for you and
+    -   `createVercelCompleteHandler`: Creates an async Vercel serverless function that handles everything for you and
         delegates to the generic complete handler described above.
-    -   `createNowHandlers`: Creates both of the above async Zeit Now serverless functions and returns an object containing
+    -   `createVercelHandlers`: Creates both of the above async Vercel serverless functions and returns an object containing
         them on the `begin` and `complete` keys.
 
 That's a lot to digest but essentially:

examples/common/render.js

@@ -0,0 +1,53 @@
+const fs = require('fs');
+const path = require('path');
+const frontmatter = require('front-matter');
+const marked = require('marked');
+
+async function render(name) {
+    // Resolve the path to the possible markdown file
+    const fullPathToPossibleMarkdownFile = path.resolve(
+        __dirname,
+        `./pages/${name}${name.endsWith('.md') ? '' : '.md'}`,
+    );
+    // Attempt to read the file, returning false ("no I did not handle this request") if any error occurs reading the file.
+    let markdownFileContents = null;
+    try {
+        markdownFileContents = await fs.promises.readFile(fullPathToPossibleMarkdownFile, { encoding: 'utf8' });
+    } catch (ignored) {
+        return false;
+    }
+    // Parse the file first using `front-matter` and `marked`
+    const fileFrontmatter = frontmatter(markdownFileContents);
+    const htmlFileContents = marked(fileFrontmatter.body);
+    // Generate the HTML, using the frontmatter to generate the title.
+    return `<html lang="en"><head><title>${fileFrontmatter.attributes.title || ''}</title>`
+        + `</head><body>\n${htmlFileContents}</body></html>`;
+}
+
+/**
+ * @returns {Promise<[string, string][]>}
+ */
+async function renderAllPages() {
+    const fullPathToPages = path.resolve(
+        __dirname,
+        `./pages`,
+    );
+    const filesInPagesDir = await fs.promises.readdir(fullPathToPages, { encoding: 'utf8', withFileTypes: true });
+    return Promise.all(
+        filesInPagesDir
+            .reduce((entries, dirEnt) => {
+                if (dirEnt.isFile() && dirEnt.name.endsWith('.md')) {
+                    entries.push(
+                        render(dirEnt.name)
+                            .then((html) => [
+                                dirEnt.name.replace(/\.md$/i, '.html'),
+                                html,
+                            ])
+                    );
+                }
+                return entries;
+            }, []),
+    );
+}
+
+module.exports = { render, renderAllPages };

examples/generic/.gitignore

@@ -4,4 +4,5 @@ public/
 # Note that we want this example to always use the latest version of the main package so we don't lock
 yarn.lock
 
-.now
+.now
+.vercel

examples/generic/admin.html

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Netlify CMS + netlify-cms-oauth-provider-node Now Test</title>
+    <title>Netlify CMS + netlify-cms-oauth-provider-node Test</title>
 </head>
 <body>
 <!-- Include the script that builds the page and powers Netlify CMS -->

examples/generic/index.js

@@ -1,8 +1,7 @@
 const http = require('http');
 const fs = require('fs');
 const path = require('path');
-const frontmatter = require('front-matter');
-const marked = require('marked');
+const { render } = require('../common/render'); // eslint-disable-line node/no-unpublished-require
 const netlifyCmsOAuth = require('netlify-cms-oauth-provider-node');
 
 const port = process.env.PORT || 3000;
@@ -134,25 +133,8 @@ const handleAdmin = createStaticFileHandler('admin.html', 'text/html; charset=ut
  *      otherwise.
  */
 async function handlePage(req, res, { route }) {
-    // Resolve the path to the possible markdown file
-    const fullPathToPossibleMarkdownFile = path.resolve(
-        __dirname,
-        '../common/pages',
-        `${route.replace(/^\//, '')}.md`,
-    );
-    // Attempt to read the file, returning false ("no I did not handle this request") if any error occurs reading the file.
-    let markdownFileContents = null;
-    try {
-        markdownFileContents = await fs.promises.readFile(fullPathToPossibleMarkdownFile, { encoding: 'utf8' });
-    } catch (ignored) {
-        return false;
-    }
-    // Parse the file first using `front-matter` and `marked`
-    const fileFrontmatter = frontmatter(markdownFileContents);
-    const htmlFileContents = marked(fileFrontmatter.body);
-    // Generate the HTML, using the frontmatter to generate the title.
-    const finalHtml = `<html lang="en"><head><title>${fileFrontmatter.attributes.title || ''}</title>`
-        + `</head><body>\n${htmlFileContents}</body></html>`;
+    const pageName = route.replace(/^\//, '');
+    const finalHtml = await render(pageName);
     // Serve the HTML to the user.
     res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
     res.end(finalHtml);

examples/generic/package.json

@@ -1,5 +1,5 @@
 {
-    "name": "netlify-cms-oauth-provider-node-now-example",
+    "name": "netlify-cms-oauth-provider-node-generic-example",
     "private": true,
     "main": "index.js",
     "scripts": {

examples/now/.gitignore → examples/vercel/.gitignore

@@ -4,4 +4,5 @@ public/
 # Note that we want this example to always use the latest version of the main package so we don't lock
 yarn.lock
 
-.now
+.now
+.vercel

examples/now/README.md → examples/vercel/README.md

@@ -1,13 +1,14 @@
-# Zeit Now Serverless Functions Examples
+# Zeit Vercel Serverless Functions Examples
 
 ## Prerequisites
 
--   [The `now` CLI](https://zeit.co/download): `npm i -g now@latest`
+-   [The `vercel` CLI](https://zeit.co/download): `npm i -g vercel@latest`
 
 ## Instructions
 
 **Note:** Right now this example _does not_ use the local source files in the serverless functions inside
-[`api/`](./api) since, at the time of this writing, `now dev` does not support symlinked packages or local dependencies.
+[`api/`](./api) since, at the time of this writing, `vercel dev` does not support symlinked packages or
+local dependencies.
 
 1.  Install the latest version of the main package as a dep to this example:
     ```shell script

examples/now/index.html → examples/vercel/admin.html

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Netlify CMS + netlify-cms-oauth-provider-node Now Test</title>
+    <title>Netlify CMS + netlify-cms-oauth-provider-node Vercel Test</title>
 </head>
 <body>
 <!-- Include the script that builds the page and powers Netlify CMS -->

examples/vercel/api/begin.js

@@ -0,0 +1,3 @@
+const { createVercelBeginHandler } = require('netlify-cms-oauth-provider-node');
+
+module.exports = createVercelBeginHandler({}, { useEnv: true });

examples/vercel/api/complete.js

@@ -0,0 +1,3 @@
+const { createVercelCompleteHandler } = require('netlify-cms-oauth-provider-node');
+
+module.exports = createVercelCompleteHandler({}, { useEnv: true });

examples/vercel/build.js

@@ -0,0 +1,11 @@
+const fs = require('fs');
+const path = require('path');
+const { renderAllPages } = require('../common/render'); // eslint-disable-line node/no-unpublished-require
+
+renderAllPages()
+    .then((pages) => Promise.all(pages.map(async ([fileName, html]) => {
+        const finalFileName = fileName === 'home.html' ? 'index.html' : fileName;
+        const publicPathForFile = path.resolve(__dirname, './public', finalFileName);
+        console.log(`Writing ${finalFileName} to ${publicPathForFile}`);
+        await fs.promises.writeFile(publicPathForFile, html);
+    })));

examples/vercel/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "netlify-cms-oauth-provider-node-vercel-example",
+    "private": true,
+    "scripts": {
+        "start": "vercel dev",
+        "clean": "rm -rf public/",
+        "build": "yarn run clean && mkdir public && cp admin.html config.yml public/ && node ./build.js"
+    },
+    "engines": {
+        "node": "14.x"
+    },
+    "dependencies": {
+        "front-matter": "^4.0.2",
+        "marked": "^2.0.1",
+        "netlify-cms-oauth-provider-node": "latest"
+    }
+}

examples/vercel/vercel.json

@@ -0,0 +1,3 @@
+{
+    "cleanUrls": true
+}

lib/handlers/index.js

@@ -1,7 +1,7 @@
 const generic = require('./generic');
-const now = require('./now');
+const vercel = require('./vercel');
 
 module.exports = {
     generic,
-    now,
+    vercel,
 };

lib/handlers/now.js → lib/handlers/vercel.js

@@ -10,24 +10,24 @@ const {
     createCompleteHandler: createGenericCompleteHandler,
 } = require('./generic');
 
-const DEBUG_KEY = 'handlers:now';
+const DEBUG_KEY = 'handlers:vercel';
 
 /**
- * @typedef {function(Request, Response): *} NowServerlessFunction
+ * @typedef {function(Request, Response): *} VercelServerlessFunction
  */
 
 /**
- * @typedef {function(Request, Response): Promise<*>} AsyncNowServerlessFunction
+ * @typedef {function(Request, Response): Promise<*>} AsyncVercelServerlessFunction
  */
 
 /**
- * A decorator function intended to wrap a Zeit Now Serverless Function to properly respond in error scenarios. Unless it is truly
+ * A decorator function intended to wrap a Vercel Serverless Function to properly respond in error scenarios. Unless it is truly
  * impossible to send an error response (i.e. bug in error coercion logic OR response stream has already ended) than this will properly
  * respond (with HTML) with the error (detailed info in dev mode).
  *
- * @param {AsyncNowServerlessFunction} handler
+ * @param {AsyncVercelServerlessFunction} handler
  * @param {object=} extraCoerceErrorToMessageOptions
- * @return {AsyncNowServerlessFunction}
+ * @return {AsyncVercelServerlessFunction}
  */
 function handlesErrors(handler, extraCoerceErrorToMessageOptions = {}) {
     const debug = createDebug(DEBUG_KEY, 'handlesErrors');
@@ -74,9 +74,9 @@ function handlesErrors(handler, extraCoerceErrorToMessageOptions = {}) {
 }
 
 /**
- * Given config, create an async Now Serverless Function that redirects to an OAuth authorization URI to begin the provider OAuth flow.
+ * Given config, create an async Vercel Serverless Function that redirects to an OAuth authorization URI to begin the provider OAuth flow.
  *
- * @type {function(object=, CreateConfigOptions): AsyncNowServerlessFunction}
+ * @type {function(object=, CreateConfigOptions): AsyncVercelServerlessFunction}
  */
 const createBeginHandler = receivesUserConfig((config) => {
     return handlesErrors(
@@ -101,12 +101,12 @@ const createBeginHandler = receivesUserConfig((config) => {
 });
 
 /**
- * Given config, create an async Now Serverless Function that attempts to extract an OAuth authorization code from the query string
+ * Given config, create an async Vercel Serverless Function that attempts to extract an OAuth authorization code from the query string
  * under the `code` param, and runs that through the provider to exchange it for an access token. It will respond with HTML that
  * is then rendered in the user's browser to communicate with the netlify-cms instance that opened the window in order to send it the
  * access token we received from the provider (or the error if it occurred).
  *
- * @type {function(object=, CreateConfigOptions): AsyncNowServerlessFunction}
+ * @type {function(object=, CreateConfigOptions): AsyncVercelServerlessFunction}
  */
 const createCompleteHandler = receivesUserConfig((config) => {
     return handlesErrors(
@@ -138,7 +138,7 @@ const createCompleteHandler = receivesUserConfig((config) => {
  * @see createBeginHandler
  * @see createCompleteHandler
  *
- * @type {function(object=, CreateConfigOptions): { begin: AsyncNowServerlessFunction, complete: AsyncNowServerlessFunction }}
+ * @type {function(object=, CreateConfigOptions): { begin: AsyncVercelServerlessFunction, complete: AsyncVercelServerlessFunction }}
  */
 const createHandlers = receivesUserConfig((config) => {
     return {

lib/index.js

@@ -2,10 +2,11 @@ const handlers = require('./handlers');
 
 const {
     generic: { createBeginHandler, createCompleteHandler, createHandlers },
-    now: {
-        createBeginHandler: createNowBeginHandler,
-        createCompleteHandler: createNowCompleteHandler,
-        createHandlers: createNowHandlers,
+
+    vercel: {
+        createBeginHandler: createVercelBeginHandler,
+        createCompleteHandler: createVercelCompleteHandler,
+        createHandlers: createVercelHandlers,
     },
 } = handlers;
 
@@ -16,7 +17,12 @@ module.exports = {
     createCompleteHandler,
     createHandlers,
 
-    createNowBeginHandler,
-    createNowCompleteHandler,
-    createNowHandlers,
+    createVercelBeginHandler,
+    createVercelCompleteHandler,
+    createVercelHandlers,
+
+    // Deprecated, kept for backwards compatibility
+    createNowBeginHandler: createVercelBeginHandler,
+    createNowCompleteHandler: createVercelCompleteHandler,
+    createNowHandlers: createVercelHandlers,
 };

package.json

@@ -46,14 +46,16 @@
         "eslint-plugin-node": "^11.1.0",
         "eslint-plugin-promise": "^4.3.1",
         "eslint-plugin-standard": "^5.0.0",
+        "front-matter": "^4.0.2",
         "husky": "^5.1.3",
         "jest": "^26.6.3",
         "lint-staged": "^10.5.4",
+        "marked": "^2.0.1",
         "prettier": "^2.2.1",
         "semantic-release": "^17.4.2"
     },
     "engines": {
-        "node": ">=10.0.0"
+        "node": ">=11.15.0"
     },
     "lint-staged": {
         "{*,{lib,docs}/**/*,__{tests,mocks}__/**/*}.js": [