@hellocoop/quickstart 2.8.9 → 2.8.10-canary.0

package/README.md

@@ -4,7 +4,8 @@ This package starts a local web server and launches the Hellō Quickstart Web Ap
 
 ## CLI
 
-If you have Node.js >= v18, you can run Quickstart with: 
+If you have Node.js >= v18, you can run Quickstart with:
+
 ```sh
 npx @hellocoop/quickstart@latest
 ```
@@ -12,4 +13,3 @@ npx @hellocoop/quickstart@latest
 This will prompt you to install the package if not already installed. It will then open up a browser window, where you will login with Hellō, and then choose to create a new app, or select an existing one, and then it will return the app's `client_id` to the console.
 
 [Quickstart CLI and SDK Documentation](https://www.hello.dev/docs/sdks/quickstart)
-

package/express.mjs

@@ -1,9 +1,9 @@
 // express quickstart
 
-import  { statSync, appendFileSync } from 'fs'
-import chalk from 'chalk';
+import { statSync, appendFileSync } from 'fs'
+import chalk from 'chalk'
 import fs from 'fs-extra'
-import quickstart from './index.js';
+import quickstart from './index.js'
 import { randomBytes } from 'crypto'
 
 const HELLO_CONFIG_FILE = 'hello.config.js'
@@ -13,25 +13,28 @@ import dotenv from 'dotenv'
 
 // TODO  check if @hellocoop/express is installed
 
-const writeConfig = async (options,name) => {
-    const client_id = await quickstart(options)    
+const writeConfig = async (options, name) => {
+    const client_id = await quickstart(options)
 
-    const filePath = process.cwd()+'/'+HELLO_CONFIG_FILE
+    const filePath = process.cwd() + '/' + HELLO_CONFIG_FILE
     try {
         statSync(filePath)
         const append = `
-// added by @hellocoop/quickstart --${name} on ${(new Date()).toISOString()}
+// added by @hellocoop/quickstart --${name} on ${new Date().toISOString()}
 config.client_id = '${client_id}'
 `
-        appendFileSync( filePath, append)
-        console.log(`${chalk.greenBright('✓')} Updated ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`)
+        appendFileSync(filePath, append)
+        console.log(
+            `${chalk.greenBright('✓')} Updated ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`,
+        )
         return
     } catch (err) {
-        if (err.code !== 'ENOENT') { // error other than file does not exist
-            throw(err)
+        if (err.code !== 'ENOENT') {
+            // error other than file does not exist
+            throw err
         }
     }
-    const config =`// ${HELLO_CONFIG_FILE}
+    const config = `// ${HELLO_CONFIG_FILE}
 // see https://hello.dev/docs/sdks/${name}/#configuration for details
 
 const config = {
@@ -39,40 +42,44 @@ const config = {
 }
 module.exports = config
 `
-    fs.outputFileSync( filePath, config)
-    console.log(`${chalk.greenBright('✓')} Created ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`)
+    fs.outputFileSync(filePath, config)
+    console.log(
+        `${chalk.greenBright('✓')} Created ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`,
+    )
 }
 
-
 const writeEnvLocal = async (name) => {
-
     const existingSecret = process.env.HELLO_COOKIE_SECRET
     if (existingSecret) {
-        console.log(`${chalk.yellowBright('⚠')} Skipping - HELLO_COOKIE_SECRET already exists`)
+        console.log(
+            `${chalk.yellowBright('⚠')} Skipping - HELLO_COOKIE_SECRET already exists`,
+        )
         return
-    } 
+    }
 
     const secret = randomBytes(32).toString('hex')
     const env = `
-# added by @hellocoop/quickstart --${name} on ${(new Date()).toISOString()}
+# added by @hellocoop/quickstart --${name} on ${new Date().toISOString()}
 HELLO_COOKIE_SECRET='${secret}'
 `
-    const outputFile = process.cwd()+'/'+ENV_FILE
-    appendFileSync(outputFile,env)
-    console.log(`${chalk.greenBright('✓')} Updated ${ENV_FILE} with HELLO_COOKIE_SECRET ${chalk.blueBright(secret)}`)
+    const outputFile = process.cwd() + '/' + ENV_FILE
+    appendFileSync(outputFile, env)
+    console.log(
+        `${chalk.greenBright('✓')} Updated ${ENV_FILE} with HELLO_COOKIE_SECRET ${chalk.blueBright(secret)}`,
+    )
 }
 
 const defaultOptions = {
     integration: 'quickstart-express',
     suffix: 'Express App',
     wildcard_domain: true,
-    provider_hint: 'google github gitlab apple-- email--'
+    provider_hint: 'google github gitlab apple-- email--',
 }
 const express = async (options, name = 'express') => {
     dotenv.config()
     options = { ...defaultOptions, ...options }
     try {
-        await writeConfig(options,name)
+        await writeConfig(options, name)
         await writeEnvLocal(name)
     } catch (e) {
         console.error(e)
@@ -81,9 +88,3 @@ const express = async (options, name = 'express') => {
 }
 
 export default express
-
-
-
-
-
-

package/fastify.mjs

@@ -7,7 +7,7 @@ const defaultOptions = {
     suffix: ' Fastify App',
 }
 
-const fastify = async ( options ) => {
+const fastify = async (options) => {
     await express({ ...defaultOptions, ...options }, 'fastify')
 }
 

package/index.js

@@ -1,11 +1,10 @@
-
 import open from 'open'
 import getPort from 'get-port'
 import readline from 'readline'
 import * as http from 'http'
-import { URLSearchParams, parse } from 'url';
+import { URLSearchParams, parse } from 'url'
 import page from './page.js'
-import chalk from 'chalk';
+import chalk from 'chalk'
 
 export const validQuickstartParams = [
     'suffix',
@@ -21,70 +20,73 @@ export const validQuickstartParams = [
 ]
 
 const quickstart = async function (params) {
-    return new Promise(async (resolve) => {
+    return new Promise((resolve, reject) => {
+        async function startServer() {
+            if (!process.stdout.isTTY) {
+                const error = new Error(
+                    'Not running on interactive terminal. Exiting Quickstart CLI',
+                )
+                console.error(error)
+                return reject(error)
+            }
 
-        if (!process.stdout.isTTY) {
-            const error = new Error('Not running on interactive terminal. Exiting Quickstart CLI')
-            console.error(error)
-            return error
-        }
-        const paramKeys = Object.keys(params || {})
-        if (paramKeys) {
-            paramKeys.forEach( param => {
-                if (!validQuickstartParams.includes(param))
-                    throw(new Error(`Invalid param:${param}`))            
-                if (!params[param])
-                    delete params[param]
+            const paramKeys = Object.keys(params || {})
+            if (paramKeys) {
+                paramKeys.forEach((param) => {
+                    if (!validQuickstartParams.includes(param)) {
+                        reject(new Error(`Invalid param:${param}`))
+                        return
+                    }
+                    if (!params[param]) delete params[param]
+                })
+            }
+
+            const port = await getPort()
+            const host = 'localhost'
+
+            const server = http.createServer((req, res) => {
+                const u = parse(req.url, true)
+                if (u.pathname !== '/') {
+                    res.writeHead(200)
+                    return res.end('ok')
+                }
+                res.writeHead(200)
+
+                const clientHTML = page(u.query.client_id)
+                res.end(clientHTML, () => {
+                    server.closeAllConnections()
+                    server.close(() => {
+                        resolve(u.query.client_id)
+                    })
+                })
             })
-        }
-        
-        const port = await getPort()
-        const host = 'localhost'
 
-        const server = http.createServer((req, res) => {
-            const u = parse(req.url,true)
-            if (u.pathname != '/') {
-                res.writeHead(200);
-                return res.end('ok')
+            const response_uri = `http://${host}:${port}/`
+            const queryParams = {
+                ...params,
+                response_uri,
             }
-            res.writeHead(200);
+            const queryString = new URLSearchParams(queryParams).toString()
+            const helloDomain = process.env.HELLO_DOMAIN || 'hello.coop'
+            const quickstartURL = `https://quickstart.${helloDomain}/?${queryString}`
+            server.listen(port, host, () => {
+                console.log('Obtaining a Hellō client_id with:')
+                console.log(chalk.blueBright(quickstartURL))
 
-            // TBD - check for error response from quickstart.hello.coop
-            
-            const clientHTML = page(u.query.client_id)
-            res.end(clientHTML, () => {
-                server.closeAllConnections()
-                server.close(() => {
-                    resolve(u.query.client_id)
-                })    
-            })
-        })
+                const rl = readline.createInterface({
+                    input: process.stdin,
+                    output: process.stdout,
+                })
 
-        const response_uri = `http://${host}:${port}/`
-        const queryParams = {
-            ... params,
-            response_uri,
+                rl.question('Press ENTER to open in the browser...', () => {
+                    open(quickstartURL)
+                    rl.close()
+                })
+            })
         }
-        const queryString = new URLSearchParams(queryParams).toString();
-        const hellooDomain = process.env.HELLO_DOMAIN || 'hello.coop'
-        const quickstartURL = `https://quickstart.${hellooDomain}/?${queryString}`
-        server.listen(port, host, () => {
-            console.log('Obtaining a Hellō client_id with:')
-            console.log(chalk.blueBright(quickstartURL))
-            const rl = readline.createInterface({
-                input: process.stdin,
-                output: process.stdout
-              });
-              
-              rl.question('Press ENTER to open in the browser...', (answer) => {
-                open(quickstartURL)
-                rl.close();
-              });
 
-        })
+        startServer().catch(reject)
     })
 }
 
-export default quickstart;
-
-
+export default quickstart

package/next.mjs

@@ -1,40 +1,41 @@
 // next.js quickstart
 
-import semver from 'semver';
-import  { statSync, appendFileSync } from 'fs'
-import chalk from 'chalk';
+import { statSync, appendFileSync } from 'fs'
+import chalk from 'chalk'
 import fs from 'fs-extra'
-import quickstart from './index.js';
+import quickstart from './index.js'
 import { randomBytes } from 'crypto'
 
+let HELLO_COOP_FILE
 const HELLO_CONFIG_FILE = 'hello.config.js'
-const HELLO_COOP_FILE = 'pages/api/hellocoop.js'
 const ENV_FILE = '.env.local'
 
 import dotenv from 'dotenv'
 
 // check if @hellocoop/nextjs is installed
 
-
 const writeConfig = async (options) => {
-    options.wildcard_domain=true
-    const client_id = await quickstart(options)    
-    const filePath = process.cwd()+'/'+HELLO_CONFIG_FILE
+    options.wildcard_domain = true
+    const client_id = await quickstart(options)
+    const filePath = process.cwd() + '/' + HELLO_CONFIG_FILE
     try {
         statSync(filePath)
         const append = `
-// added by @hellocoop/quickstart --nextjs on ${(new Date()).toISOString()}
+// added by @hellocoop/quickstart --nextjs on ${new Date().toISOString()}
 config.client_id = '${client_id}'
 `
-        appendFileSync( filePath, append)
-        console.log(`${chalk.greenBright('✓')} Updated ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`)
+        appendFileSync(filePath, append)
+        console.log(
+            `${chalk.greenBright('✓')} Updated ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`,
+        )
         return
     } catch (err) {
-        if (err.code !== 'ENOENT') { // error other than file does not exist
-            throw(err)
+        if (err.code !== 'ENOENT') {
+            // error other than file does not exist
+            throw err
         }
     }
-    const config =`// ${HELLO_CONFIG_FILE}
+    const config = `// ${HELLO_CONFIG_FILE}
 // see https://hello.dev/docs/sdks/nextjs/#configuration for details
 
 const config = {
@@ -42,65 +43,83 @@ const config = {
 }
 module.exports = config
 `
-    fs.outputFileSync( filePath, config)
-    console.log(`${chalk.greenBright('✓')} Created ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`)
+    fs.outputFileSync(filePath, config)
+    console.log(
+        `${chalk.greenBright('✓')} Created ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`,
+    )
 }
 
-const writeHelloCoop = async () => {
-    const filePath = process.cwd()+'/'+HELLO_COOP_FILE
+const writeHelloCoop = async (pagesRouter) => {
+    HELLO_COOP_FILE = pagesRouter
+        ? 'pages/api/hellocoop.js'
+        : 'app/api/hellocoop/router.js'
+    const filePath = process.cwd() + '/' + HELLO_COOP_FILE
     try {
-        statSync(filePath);
-        console.log(`${chalk.yellowBright('⚠')} Skipping - ${HELLO_COOP_FILE} already exists`)
+        statSync(filePath)
+        console.log(
+            `${chalk.yellowBright('⚠')} Skipping - ${HELLO_COOP_FILE} already exists`,
+        )
         return
     } catch (err) {
-        if (err.code !== 'ENOENT') { // error other than file does not exist
-            throw(err)
+        if (err.code !== 'ENOENT') {
+            // error other than file does not exist
+            throw err
         }
     }
 
-    const content = `// ${HELLO_COOP_FILE}
-// generated by @hellocoop/quickstart --nextjs on ${(new Date()).toISOString()}
+    const content = pagesRouter
+        ? `// ${HELLO_COOP_FILE}
+// generated by @hellocoop/quickstart --nextjs on ${new Date().toISOString()}
 // NOTE: this file should not need to be edited
 import config from '../../hello.config'
 import { pageAuth } from '@hellocoop/nextjs'
 export default pageAuth(config)
 `
-    fs.outputFileSync( filePath, content )
+        : `// ${HELLO_COOP_FILE}
+// generated by @hellocoop/quickstart --nextjs on ${new Date().toISOString()}
+// NOTE: this file should not need to be edited
+import config from '../../../hello.config'
+import { appAuth } from '@hellocoop/nextjs'
+export const { GET } = appAuth(config)
+`
+    fs.outputFileSync(filePath, content)
     console.log(`${chalk.greenBright('✓')} Created ${HELLO_COOP_FILE}`)
-
 }
 
-
 const writeEnvLocal = async () => {
     const existingSecret = process.env.HELLO_COOKIE_SECRET
     if (existingSecret) {
-        console.log(`${chalk.yellowBright('⚠')} Skipping - HELLO_COOKIE_SECRET already exists`)
+        console.log(
+            `${chalk.yellowBright('⚠')} Skipping - HELLO_COOKIE_SECRET already exists`,
+        )
         return
-    } 
+    }
 
     const secret = randomBytes(32).toString('hex')
     const env = `
-# added by @hellocoop/quickstart --nextjs on ${(new Date()).toISOString()}
+# added by @hellocoop/quickstart --nextjs on ${new Date().toISOString()}
 HELLO_COOKIE_SECRET='${secret}'
 `
-    const outputFile = process.cwd()+'/'+ENV_FILE
-    appendFileSync(outputFile,env)
-    console.log(`${chalk.greenBright('✓')} Updated ${ENV_FILE} with HELLO_COOKIE_SECRET ${chalk.blueBright(secret)}`)
+    const outputFile = process.cwd() + '/' + ENV_FILE
+    appendFileSync(outputFile, env)
+    console.log(
+        `${chalk.greenBright('✓')} Updated ${ENV_FILE} with HELLO_COOKIE_SECRET ${chalk.blueBright(secret)}`,
+    )
 }
 
 const defaultOptions = {
     integration: 'quickstart-nextjs',
     suffix: 'Next.js App',
     wildcard_domain: true,
-    provider_hint: 'google github gitlab apple-- email--'
+    provider_hint: 'google github gitlab apple-- email--',
 }
 
-const next = async (options) => {
+const next = async (options, pagesRouter) => {
     dotenv.config({ path: './.env.local' })
     options = { ...defaultOptions, ...options }
     try {
         await writeConfig(options)
-        await writeHelloCoop()
+        await writeHelloCoop(pagesRouter)
         await writeEnvLocal()
     } catch (e) {
         console.error(e)
@@ -109,9 +128,3 @@ const next = async (options) => {
 }
 
 export default next
-
-
-
-
-
-

package/package.json

@@ -1,49 +1,49 @@
 {
-  "name": "@hellocoop/quickstart",
-  "version": "2.8.9",
-  "description": "A CLI and module to start the Hello Quickstart web app and return a client_id",
-  "main": "index.js",
-  "bin": {
-    "quickstart": "quickstart.mjs"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "prebuild": "rimraf dist node_modules",
-    "build": "echo \"No build specified\" && exit 0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/hellocoop/packages.git"
-  },
-  "keywords": [
-    "hello",
-    "oauth",
-    "oauth2",
-    "OIDC",
-    "auth",
-    "sso",
-    "quickstart"
-  ],
-  "author": {
-    "name": "Hello Identity Co-op",
-    "email": "contact@hello.coop",
-    "url": "https://hello.coop"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/hellocoop/packages/issues"
-  },
-  "homepage": "https://www.hello.dev/docs/sdk/quickstart",
-  "dependencies": {
-    "chalk": "^5.3.0",
-    "dotenv": "^16.3.1",
-    "fs-extra": "^11.1.1",
-    "get-port": "^7.0.0",
-    "open": "^9.1.0",
-    "semver": "^7.6.3"
-  },
-  "type": "module",
-  "engines": {
-    "node": ">=18.3"
-  }
+    "name": "@hellocoop/quickstart",
+    "version": "2.8.10-canary.0",
+    "description": "A CLI and module to start the Hello Quickstart web app and return a client_id",
+    "main": "index.js",
+    "bin": {
+        "quickstart": "quickstart.mjs"
+    },
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "prebuild": "rimraf dist node_modules",
+        "build": "echo \"No build specified\" && exit 0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/hellocoop/packages.git"
+    },
+    "keywords": [
+        "hello",
+        "oauth",
+        "oauth2",
+        "OIDC",
+        "auth",
+        "sso",
+        "quickstart"
+    ],
+    "author": {
+        "name": "Hello Identity Co-op",
+        "email": "contact@hello.coop",
+        "url": "https://hello.coop"
+    },
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/hellocoop/packages/issues"
+    },
+    "homepage": "https://www.hello.dev/docs/sdk/quickstart",
+    "dependencies": {
+        "chalk": "^5.3.0",
+        "dotenv": "^16.3.1",
+        "fs-extra": "^11.1.1",
+        "get-port": "^7.0.0",
+        "open": "^9.1.0",
+        "semver": "^7.6.3"
+    },
+    "type": "module",
+    "engines": {
+        "node": ">=18.3"
+    }
 }

package/page.js

@@ -1,4 +1,4 @@
-export default function (client_id) {
+export default function () {
     return `
     <!DOCTYPE html>
     <html lang="en">
@@ -22,4 +22,4 @@ export default function (client_id) {
         </main>
       </body>
     </html>`
-}
+}

package/quickstart.mjs

@@ -1,75 +1,87 @@
 #!/usr/bin/env node
 
-import semver from 'semver';
+import semver from 'semver'
 import nextConfig from './next.mjs'
 import expressConfig from './express.mjs'
 import fastifyConfig from './fastify.mjs'
 
-const requiredVersion = '>=18.3.0';
+const requiredVersion = '>=18.3.0'
 
 if (!semver.satisfies(process.versions.node, requiredVersion)) {
-  console.error(`This script requires Node.js version ${requiredVersion}`);
-  process.exit(1);
+    console.error(`This script requires Node.js version ${requiredVersion}`)
+    process.exit(1)
 }
 
 // following are in Nodejs 18+
-import { parseArgs } from "node:util";
+import { parseArgs } from 'node:util'
 
 if (!process.stdout.isTTY) {
-    const error = new Error('Not running on interactive terminal. Exiting Hellō Quickstart.')
+    const error = new Error(
+        'Not running on interactive terminal. Exiting Hellō Quickstart.',
+    )
     console.error(error)
-    process.exit(1);
+    process.exit(1)
 }
 
 let {
-  values: { nextjs, express, fastify, provider_hint, suffix, wildcard_domain, integration },
-} = parseArgs({
-  options: {
-    nextjs: {
-        type: "boolean"
-    },
-    express: {
-        type: "boolean"
-    },
-    fastify: {
-        type: "boolean"
-    },
-    provider_hint: {
-        type: "string",
-        short: "p",
-    },  
-    suffix: {
-        type: "string",
-        short: "x",
+    values: {
+        nextjs,
+        nextjs_app_router,
+        nextjs_pages_router,
+        express,
+        fastify,
+        provider_hint,
+        suffix,
+        wildcard_domain,
+        integration,
     },
-    integration: {
-        type: "string",
-        short: "i",
+} = parseArgs({
+    options: {
+        nextjs: {
+            type: 'boolean',
+        },
+        nextjs_app_router: {
+            type: 'boolean',
+        },
+        nextjs_pages_router: {
+            type: 'boolean',
+        },
+        express: {
+            type: 'boolean',
+        },
+        fastify: {
+            type: 'boolean',
+        },
+        provider_hint: {
+            type: 'string',
+            short: 'p',
+        },
+        suffix: {
+            type: 'string',
+            short: 'x',
+        },
+        integration: {
+            type: 'string',
+            short: 'i',
+        },
+        wildcard_domain: {
+            type: 'boolean',
+            short: 'w',
+        },
     },
-    wildcard_domain: {
-        type: "boolean",
-        short: "w",
-    }
-  },
-});
+})
 
-import quickstart from './index.js';
+import quickstart from './index.js'
 import dotenv from 'dotenv'
 
 const options = {}
-if (provider_hint) 
-    options.provider_hint = provider_hint
-if (suffix) 
-    options.suffix = suffix
-if (integration) 
-    options.integration = integration
-if (wildcard_domain) 
-    options.wildcard_domain = wildcard
-
+if (provider_hint) options.provider_hint = provider_hint
+if (suffix) options.suffix = suffix
+if (integration) options.integration = integration
+if (wildcard_domain) options.wildcard_domain = wildcard_domain
 ;(async () => {
-
-    if (nextjs) {
-        await nextConfig(options)
+    if (nextjs || nextjs_app_router || nextjs_pages_router) {
+        await nextConfig(options, nextjs_pages_router) // defaults to app router
         process.exit(0)
     }
 
@@ -89,4 +101,4 @@ if (wildcard_domain)
 
     const client_id = await quickstart(options)
     console.log(`client_id=${client_id}`)
-})();
+})()