@hellocoop/quickstart 2.5.3 → 2.6.0

package/express.mjs

@@ -0,0 +1,89 @@
+// express quickstart
+
+import  { statSync, appendFileSync } from 'fs'
+import chalk from 'chalk';
+import fs from 'fs-extra'
+import quickstart from './index.js';
+import { randomBytes } from 'crypto'
+
+const HELLO_CONFIG_FILE = 'hello.config.js'
+const ENV_FILE = '.env'
+
+import dotenv from 'dotenv'
+
+// TODO  check if @hellocoop/express is installed
+
+const writeConfig = async (options,name) => {
+    const client_id = await quickstart(options)    
+
+    const filePath = process.cwd()+'/'+HELLO_CONFIG_FILE
+    try {
+        statSync(filePath)
+        const append = `
+// 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)}`)
+        return
+    } catch (err) {
+        if (err.code !== 'ENOENT') { // error other than file does not exist
+            throw(err)
+        }
+    }
+    const config =`// ${HELLO_CONFIG_FILE}
+// see https://hello.dev/docs/sdks/${name}/#configuration for details
+
+const config = {
+    client_id: '${client_id}',
+}
+modules.export = config
+`
+    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`)
+        return
+    } 
+
+    const secret = randomBytes(16).toString('hex')
+    const env = `
+# 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 defaultOptions = {
+    integration: 'quickstart-express',
+    suffix: 'Express App',
+    wildcard_domain: true,
+    provider_hint: 'google github gitlab apple-- email--'
+}
+const express = async (options, name = 'express') => {
+    dotenv.config()
+    options = { ...defaultOptions, ...options }
+    try {
+        await writeConfig(options,name)
+        await writeEnvLocal(name)
+    } catch (e) {
+        console.error(e)
+        process.exit(1)
+    }
+}
+
+export default express
+
+
+
+
+
+

package/fastify.mjs

@@ -0,0 +1,14 @@
+// fastify.mjs
+
+import express from './express.mjs'
+
+const defaultOptions = {
+    integration: 'quickstart-fastify',
+    suffix: ' Fastify App',
+}
+
+const fastify = async ( options ) => {
+    await express({ ...defaultOptions, ...options }, 'fastify')
+}
+
+export default fastify

package/index.js

@@ -33,6 +33,8 @@ const quickstart = async function (params) {
             paramKeys.forEach( param => {
                 if (!validQuickstartParams.includes(param))
                     throw(new Error(`Invalid param:${param}`))            
+                if (!params[param])
+                    delete params[param]
             })
         }
         
@@ -67,14 +69,14 @@ const quickstart = async function (params) {
         const hellooDomain = process.env.HELLO_DOMAIN || 'hello.coop'
         const quickstartURL = `https://quickstart.${hellooDomain}/?${queryString}`
         server.listen(port, host, () => {
-            console.log('\nObtaining a client_id with Hellō Quickstart\n')
+            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('\nPress ENTER to open in the browser...', (answer) => {
+              rl.question('Press ENTER to open in the browser...', (answer) => {
                 open(quickstartURL)
                 rl.close();
               });

package/next.mjs

@@ -4,7 +4,6 @@ import semver from 'semver';
 import  { statSync, appendFileSync } from 'fs'
 import chalk from 'chalk';
 import fs from 'fs-extra'
-import 'dotenv/config'
 import quickstart from './index.js';
 import { randomBytes } from 'crypto'
 
@@ -12,6 +11,8 @@ const HELLO_CONFIG_FILE = 'hello.config.ts'
 const HELLO_COOP_FILE = 'pages/api/hellocoop.ts'
 const ENV_FILE = '.env.local'
 
+import dotenv from 'dotenv'
+
 // check if @hellocoop/nextjs is installed
 
 
@@ -26,64 +27,55 @@ const writeConfig = async (options) => {
 config.client_id = '${client_id}'
 `
         appendFileSync( filePath, append)
-        console.log(`\nUpdated ${filePath} with:`)
-        console.log(chalk.blueBright(append))   
+        console.log(`${chalk.greenBright('✓')} Updated ${HELLO_CONFIG_FILE} with client_id ${chalk.blueBright(client_id)}`)
         return
     } catch (err) {
-        if (err.code !== 'ENOENT') { // file does not exist
+        if (err.code !== 'ENOENT') { // error other than file does not exist
             throw(err)
         }
     }
     const config =`// ${HELLO_CONFIG_FILE}
-import { Config } from '@hellocoop/nextjs'
+// see https://hello.dev/docs/sdks/nextjs/#configuration for details
+import type { Config } from '@hellocoop/nextjs'
 
 const config = {
     client_id: '${client_id}',
-// see https://hello.dev/docs/sdks/nextjs/#configuration for details
-//    scope:[]          
-//    provider_hint:[]
 }
 export default config
 `
     fs.outputFileSync( filePath, config)
-    console.log(`created ${filePath} with\nclient_id:${chalk.blueBright(client_id)}`)
-//     console.log(
-// `You can update the:
-//     - Application Logo
-//     - Application Name
-//     - Terms of Service URL
-//     - Privacy Policy URL
-//     - Redirect URIs
-// at the Hellō Developer Console https://console.hello.coop`)
+    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
     try {
         statSync(filePath);
-        console.error(`${HELLO_COOP_FILE} already exists at:\n${filePath}\nSkipping creating file`)
+        console.log(`${chalk.yellowBright('⚠')} Skipping - ${HELLO_COOP_FILE} already exists`)
         return
     } catch (err) {
-        if (err.code !== 'ENOENT') { // file does not exist
+        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()}
-// this file should not need to be edited
+// 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 )
+    console.log(`${chalk.greenBright('✓')} Created ${HELLO_COOP_FILE}`)
+
 }
 
 
 const writeEnvLocal = async () => {
     const existingSecret = process.env.HELLO_COOKIE_SECRET
     if (existingSecret) {
-        console.error(`HELLO_COOKIE_SECRET already set to ${existingSecret}`)
+        console.log(`${chalk.yellowBright('⚠')} Skipping - HELLO_COOKIE_SECRET already exists`)
         return
     } 
 
@@ -94,15 +86,23 @@ HELLO_COOKIE_SECRET='${secret}'
 `
     const outputFile = process.cwd()+'/'+ENV_FILE
     appendFileSync(outputFile,env)
-    console.log(`\nUpdated ${outputFile} with:`)
-    console.log(chalk.blueBright(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--'
 }
 
 const next = async (options) => {
+    dotenv.config({ path: './.env.local' })
+    options = { ...defaultOptions, ...options }
     try {
+        await writeConfig(options)
         await writeHelloCoop()
         await writeEnvLocal()
-        await writeConfig(options)
     } catch (e) {
         console.error(e)
         process.exit(1)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hellocoop/quickstart",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "description": "A CLI and module to start the Hello Quickstart web app and return a client_id",
   "main": "index.js",
   "bin": {

package/quickstart.mjs

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 
 import semver from 'semver';
-import next from './next.mjs'
+import nextConfig from './next.mjs'
+import expressConfig from './express.mjs'
+import fastifyConfig from './fastify.mjs'
 
 const requiredVersion = '>=18.3.0';
 
@@ -20,53 +22,70 @@ if (!process.stdout.isTTY) {
 }
 
 let {
-  values: { nextjs, provider_hint, suffix, file, secret, wildcard, integration, debug },
+  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",
-        default: '',
     },  
     suffix: {
         type: "string",
         short: "x",
-        default: '',
     },
     integration: {
         type: "string",
         short: "i",
-        default: ''
     },
-    wildcard: {
+    wildcard_domain: {
         type: "boolean",
         short: "w",
     }
   },
 });
 
-import 'dotenv/config'
 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
 
-(async () => {
+;(async () => {
 
     if (nextjs) {
-        await next({ provider_hint, suffix, integration })
+        await nextConfig(options)
+        process.exit(0)
+    }
+
+    if (express) {
+        await expressConfig(options)
+        process.exit(0)
+    }
+
+    if (fastify) {
+        await fastifyConfig(options)
         process.exit(0)
     }
 
-    const options = {}
-    if (provider_hint) 
-        options.provider_hint = provider_hint
-    if (suffix) 
-        options.suffix = suffix
-    if (integration) 
-        options.integration = integration
-    if (wildcard) 
-        options.wildcard_domain = wildcard
+    // direct invocation
+
+    dotenv.config() // .env
 
     const client_id = await quickstart(options)
     console.log(`client_id=${client_id}`)