@tremho/mist-lift 1.1.2 → 1.1.3-pre-release.1

package/src/commands/settings.ts

@@ -1,73 +1,73 @@
-import path from 'path'
-import fs from 'fs'
-import { LiftConfig, RuntimeType } from '../lib/LiftConfig'
-import { homedir } from 'os'
-import { ask } from '../lib/askQuestion'
-import * as ac from 'ansi-colors'
-
-export async function doSettings (): Promise<number> {
-  try {
-    const mistLiftPath = path.join(homedir(), '.mistlift')
-    let settings: LiftConfig = { cloudHost: 'AWS' }
-    if (fs.existsSync(mistLiftPath)) {
-      settings = JSON.parse(fs.readFileSync(mistLiftPath).toString())
-    }
-
-    let ok = false
-    while (!ok) {
-      settings.cloudHost = ask('Type of cloud host (AWS)',
-        'cloud host',
-        settings.cloudHost
-      )
-      ok = settings.cloudHost === 'AWS' // all we support now
-    }
-    ok = false
-
-    if (settings.cloudHost === 'AWS') {
-      ok = false
-      console.log('Choose from a configured AWS profile, or leave empty to use a custom credentials config file')
-      while (!ok) {
-        settings.awsIniProfile = ask('Name of AWS profile to use',
-          'AWS Profile',
-          settings.awsIniProfile ?? 'default'
-        )
-        ok = settings.awsIniProfile !== ''
-      }
-      ok = false
-      let runtime: string = settings.awsNodeRuntime as string
-      while (!ok) {
-        runtime = ask('AWS Node Runtime Version',
-          'NodeJS Runtime',
-          'Nodejs20.x'
-        )
-        ok = runtime !== ''
-      }
-      settings.awsNodeRuntime = runtime.toLowerCase() as RuntimeType
-
-      ok = false
-      while (!ok) {
-        settings.awsPreferredRegion = ask('Preferred AWS region',
-          'preferred AWS region',
-          settings.awsPreferredRegion ?? 'us-east-1'
-        )
-        ok = (settings.awsPreferredRegion ?? '') !== ''
-      }
-      ok = false
-      console.log('Supply the ARN for the service role you have created in your AWS IAM account for Lambda and Cloudwatch access')
-      while (!ok) {
-        settings.awsServiceRoleARN = ask('AWS service role ARN',
-          'serviceRole ARN',
-          settings.awsServiceRoleARN ?? 'arn:aws.iam::xxxxxxxxxxxx:role/service-role-name'
-        )
-        ok = settings.awsServiceRoleARN !== 'arn:aws.iam::xxxxxxxxxxxx:role/service-role-name' &&
-                  settings.awsServiceRoleARN !== ''
-      }
-    }
-    fs.writeFileSync(mistLiftPath, JSON.stringify(settings))
-
-    return 0
-  } catch (e: any) {
-    console.error(ac.bold.red('Error with settings:'), e)
-    return -1
-  }
-}
+import path from 'path'
+import fs from 'fs'
+import { LiftConfig, RuntimeType } from '../lib/LiftConfig'
+import { homedir } from 'os'
+import { ask } from '../lib/askQuestion'
+import * as ac from 'ansi-colors'
+
+export async function doSettings (): Promise<number> {
+  try {
+    const mistLiftPath = path.join(homedir(), '.mistlift')
+    let settings: LiftConfig = { cloudHost: 'AWS' }
+    if (fs.existsSync(mistLiftPath)) {
+      settings = JSON.parse(fs.readFileSync(mistLiftPath).toString())
+    }
+
+    let ok = false
+    while (!ok) {
+      settings.cloudHost = ask('Type of cloud host (AWS)',
+        'cloud host',
+        settings.cloudHost
+      )
+      ok = settings.cloudHost === 'AWS' // all we support now
+    }
+    ok = false
+
+    if (settings.cloudHost === 'AWS') {
+      ok = false
+      console.log('Choose from a configured AWS profile, or leave empty to use a custom credentials config file')
+      while (!ok) {
+        settings.awsIniProfile = ask('Name of AWS profile to use',
+          'AWS Profile',
+          settings.awsIniProfile ?? 'default'
+        )
+        ok = settings.awsIniProfile !== ''
+      }
+      ok = false
+      let runtime: string = settings.awsNodeRuntime as string
+      while (!ok) {
+        runtime = ask('AWS Node Runtime Version',
+          'NodeJS Runtime',
+          'Nodejs20.x'
+        )
+        ok = runtime !== ''
+      }
+      settings.awsNodeRuntime = runtime.toLowerCase() as RuntimeType
+
+      ok = false
+      while (!ok) {
+        settings.awsPreferredRegion = ask('Preferred AWS region',
+          'preferred AWS region',
+          settings.awsPreferredRegion ?? 'us-east-1'
+        )
+        ok = (settings.awsPreferredRegion ?? '') !== ''
+      }
+      ok = false
+      console.log('Supply the ARN for the service role you have created in your AWS IAM account for Lambda and Cloudwatch access')
+      while (!ok) {
+        settings.awsServiceRoleARN = ask('AWS service role ARN',
+          'serviceRole ARN',
+          settings.awsServiceRoleARN ?? 'arn:aws.iam::xxxxxxxxxxxx:role/service-role-name'
+        )
+        ok = settings.awsServiceRoleARN !== 'arn:aws.iam::xxxxxxxxxxxx:role/service-role-name' &&
+                  settings.awsServiceRoleARN !== ''
+      }
+    }
+    fs.writeFileSync(mistLiftPath, JSON.stringify(settings))
+
+    return 0
+  } catch (e: any) {
+    console.error(ac.bold.red('Error with settings:'), e)
+    return -1
+  }
+}

package/src/commands/start.ts

@@ -1,43 +1,43 @@
-/** Run Express Server */
-import express from 'express'
-
-import functionRouter, { functionBinder } from '../expressRoutes/functionBinder'
-
-import apiRouter from '../expressRoutes/api'
-import allRouter, { allBinder } from '../expressRoutes/all'
-import { resolvePaths } from '../lib/pathResolve'
-import { doBuildAsync } from './build'
-
-import * as ac from 'ansi-colors'
-
-export async function startLocalServer (): Promise<void> {
-  const projectPaths = resolvePaths()
-  if (!projectPaths.verified) {
-    console.log(ac.bold.red('Cannot start local server'))
-    console.log(ac.blue.italic('Not in a valid MistLift project directory'))
-    console.log('')
-    return
-  }
-  await doBuildAsync([])
-  const port = 8081
-  allBinder()
-  functionBinder()
-  const app = express()
-  // for JSON posts
-  // app.use(bodyParser.json({limit: '50mb'}))
-  app.use(express.json())
-  // for form posts
-  app.use(express.urlencoded({ extended: true }))
-
-  app.use('/', functionRouter)
-  app.use('/api', apiRouter)
-  app.use('*', allRouter)
-
-  // =========================================
-  // Start server
-  // http only
-  app.listen(port, function () {
-    console.log(`http listening on port ${port}`)
-  })
-// ================================================
-}
+/** Run Express Server */
+import express from 'express'
+
+import functionRouter, { functionBinder } from '../expressRoutes/functionBinder'
+
+import apiRouter from '../expressRoutes/api'
+import allRouter, { allBinder } from '../expressRoutes/all'
+import { resolvePaths } from '../lib/pathResolve'
+import { doBuildAsync } from './build'
+
+import * as ac from 'ansi-colors'
+
+export async function startLocalServer (): Promise<void> {
+  const projectPaths = resolvePaths()
+  if (!projectPaths.verified) {
+    console.log(ac.bold.red('Cannot start local server'))
+    console.log(ac.blue.italic('Not in a valid MistLift project directory'))
+    console.log('')
+    return
+  }
+  await doBuildAsync([])
+  const port = 8081
+  allBinder()
+  functionBinder()
+  const app = express()
+  // for JSON posts
+  // app.use(bodyParser.json({limit: '50mb'}))
+  app.use(express.json())
+  // for form posts
+  app.use(express.urlencoded({ extended: true }))
+
+  app.use('/', functionRouter)
+  app.use('/api', apiRouter)
+  app.use('*', allRouter)
+
+  // =========================================
+  // Start server
+  // http only
+  app.listen(port, function () {
+    console.log(`http listening on port ${port}`)
+  })
+// ================================================
+}

package/src/commands/test.ts

@@ -1,37 +1,37 @@
-import { executeCommand } from '../lib/executeCommand'
-import { doBuildAsync } from './build'
-
-export async function doTestAsync (args: string[]): Promise<number> {
-  if (await doBuildAsync(args) !== 0) return 1 // don't test if build fails
-  if (args.length === 0) args = ['*']
-  let ret = 0
-  for (const funcName of args) {
-    const result = await executeCommand('tap', [
-            `build/functions/${funcName}/*-tests/*.js`,
-            /*
-                             - base -- looks a lot like terse
-                             - terse -- pass/fail counts
-                             - min -- errors only
-                             - dot -- like min, but a dot per assert
-                             - silent
-                             - json
-                             - jsonstream
-                             - markdown
-                             - junit
-                             - tap
-             */
-            '--reporter=base',
-            '--color',
-            '--passes',
-            '--allow-empty-coverage',
-            '--allow-incomplete-coverage'
-
-    ], '', true)
-
-    if (result.retcode !== 0) {
-      ret = result.retcode
-      break
-    }
-  }
-  return ret
-}
+import { executeCommand } from '../lib/executeCommand'
+import { doBuildAsync } from './build'
+
+export async function doTestAsync (args: string[]): Promise<number> {
+  if (await doBuildAsync(args) !== 0) return 1 // don't test if build fails
+  if (args.length === 0) args = ['*']
+  let ret = 0
+  for (const funcName of args) {
+    const result = await executeCommand('tap', [
+            `build/functions/${funcName}/*-tests/*.js`,
+            /*
+                             - base -- looks a lot like terse
+                             - terse -- pass/fail counts
+                             - min -- errors only
+                             - dot -- like min, but a dot per assert
+                             - silent
+                             - json
+                             - jsonstream
+                             - markdown
+                             - junit
+                             - tap
+             */
+            '--reporter=base',
+            '--color',
+            '--passes',
+            '--allow-empty-coverage',
+            '--allow-incomplete-coverage'
+
+    ], '', true)
+
+    if (result.retcode !== 0) {
+      ret = result.retcode
+      break
+    }
+  }
+  return ret
+}

package/src/commands/user.ts

@@ -1,20 +1,20 @@
-/** Handles the set of user management commands
- *
- * Default and prime user is the default of the AWS profile set
- * In configuration, this can be changed to a different profile
- * The user command module is meant to
- */
-
-// TODO:
-
-/*
-- lift user create <name>
-- lift user destroy <name>
-- lift user grant <name> <privilege>
-- lift user revoke <name> <privilege>
-- lift user show <name>
-- lift user list
-
- */
-//    }
-// }
+/** Handles the set of user management commands
+ *
+ * Default and prime user is the default of the AWS profile set
+ * In configuration, this can be changed to a different profile
+ * The user command module is meant to
+ */
+
+// TODO:
+
+/*
+- lift user create <name>
+- lift user destroy <name>
+- lift user grant <name> <privilege>
+- lift user revoke <name> <privilege>
+- lift user show <name>
+- lift user list
+
+ */
+//    }
+// }

package/src/expressRoutes/all.ts

@@ -1,99 +1,99 @@
-import path from 'path'
-import fs from 'fs'
-
-import * as ac from 'ansi-colors'
-import { resolvePaths } from '../lib/pathResolve'
-import { gatherFunctionDefinitions } from '../lib/openAPI/ApiBuildCollector'
-
-import express from 'express'
-const router = express.Router()
-
-export function allBinder (): void {
-  const projectPaths = resolvePaths()
-  const defs = gatherFunctionDefinitions()
-
-  /**
-     * @name /all
-     * @description
-     * Catch-all handler for URLs
-     * Provides some simple spam blocking and checks for file pass through at file root.
-     *
-     * ##### Filtering:
-     * - all .php extension references
-     *
-     * ##### File root:
-     * - file root is at service root + 'Public'
-     * - no path or path ending in / is appended with '/index.html' for folder root default behavior
-     * - File contents passed through using `sendFile` (will handle its own 404 if not found)
-     *
-     */
-  router.all('*', (req, res, next) => {
-    // any PHP requests should be ignored
-    // ClogTrace('incoming: '+req.originalUrl)
-    if (req.originalUrl.includes('.php')) {
-      return res.send('')
-    }
-    if (req.originalUrl.includes('.env')) {
-      return res.send('')
-    }
-
-    let filepath = req.originalUrl ?? '/'
-    // match cloud behavior for docs because /api doesn't change cwd there
-    if (filepath.substring(0, 10) === '/api/docs/') {
-      filepath = filepath.replace('/api', '')
-    }
-    let funcFound = filepath === '/api' // reserved "function"
-    if (!funcFound) {
-      if (filepath.charAt(0) === '/') {
-        let n = filepath.indexOf('/', 1)
-        if (n === -1) n = filepath.length
-        let rootEntity = filepath.substring(0, n)
-        n = rootEntity.indexOf('?')
-        if (n === -1) n = rootEntity.length
-        rootEntity = rootEntity.substring(0, n)
-        for (const entry of defs) {
-          let entryRoot = entry.pathMap
-          const n = entryRoot.indexOf('/{')
-          if (n !== -1) entryRoot = entryRoot.substring(0, n)
-          if (rootEntity === entryRoot) {
-            funcFound = true
-            break
-          }
-        }
-      }
-    }
-
-    if (!funcFound) {
-      // check for '/' in path beyond the first one
-      if (filepath.includes('/', 1)) {
-        // console.log(ac.magenta.italic("Warning: / path delimiters will not be honored in a cloud deployment, use + instead ")+filepath)
-      }
-      // convert any incoming + to / to match cloud behavior
-      while (filepath.includes('+')) filepath = filepath.replace('+', '/')
-
-      // Put any other filtering here
-      if (filepath.includes('?')) {
-        filepath = filepath.substring(0, filepath.indexOf('?'))
-      }
-      if (filepath.substring(filepath.length - 1) === '/') filepath += 'index.html'
-      if (filepath.substring(0, 10) === '/api/docs/') {
-        filepath = filepath.replace('/api', '')
-      }
-      if (filepath.includes('/docs')) {
-        if (filepath.includes('.map')) {
-          return res.sendStatus(200)
-        }
-      }
-      filepath = path.resolve(path.join(projectPaths.basePath, 'webroot', filepath)) // .. out of build
-      if (fs.existsSync(filepath)) {
-        return res.sendFile(filepath)
-      } else {
-        console.log(ac.red.bold("can't find " + filepath))
-        return res.sendStatus(404)
-      }
-    }
-    // if none of the above, tickle enumerator so we can process other paths
-    next()
-  })
-}
-export default router
+import path from 'path'
+import fs from 'fs'
+
+import * as ac from 'ansi-colors'
+import { resolvePaths } from '../lib/pathResolve'
+import { gatherFunctionDefinitions } from '../lib/openAPI/ApiBuildCollector'
+
+import express from 'express'
+const router = express.Router()
+
+export function allBinder (): void {
+  const projectPaths = resolvePaths()
+  const defs = gatherFunctionDefinitions()
+
+  /**
+     * @name /all
+     * @description
+     * Catch-all handler for URLs
+     * Provides some simple spam blocking and checks for file pass through at file root.
+     *
+     * ##### Filtering:
+     * - all .php extension references
+     *
+     * ##### File root:
+     * - file root is at service root + 'Public'
+     * - no path or path ending in / is appended with '/index.html' for folder root default behavior
+     * - File contents passed through using `sendFile` (will handle its own 404 if not found)
+     *
+     */
+  router.all('*', (req, res, next) => {
+    // any PHP requests should be ignored
+    // ClogTrace('incoming: '+req.originalUrl)
+    if (req.originalUrl.includes('.php')) {
+      return res.send('')
+    }
+    if (req.originalUrl.includes('.env')) {
+      return res.send('')
+    }
+
+    let filepath = req.originalUrl ?? '/'
+    // match cloud behavior for docs because /api doesn't change cwd there
+    if (filepath.substring(0, 10) === '/api/docs/') {
+      filepath = filepath.replace('/api', '')
+    }
+    let funcFound = filepath === '/api' // reserved "function"
+    if (!funcFound) {
+      if (filepath.charAt(0) === '/') {
+        let n = filepath.indexOf('/', 1)
+        if (n === -1) n = filepath.length
+        let rootEntity = filepath.substring(0, n)
+        n = rootEntity.indexOf('?')
+        if (n === -1) n = rootEntity.length
+        rootEntity = rootEntity.substring(0, n)
+        for (const entry of defs) {
+          let entryRoot = entry.pathMap
+          const n = entryRoot.indexOf('/{')
+          if (n !== -1) entryRoot = entryRoot.substring(0, n)
+          if (rootEntity === entryRoot) {
+            funcFound = true
+            break
+          }
+        }
+      }
+    }
+
+    if (!funcFound) {
+      // check for '/' in path beyond the first one
+      if (filepath.includes('/', 1)) {
+        // console.log(ac.magenta.italic("Warning: / path delimiters will not be honored in a cloud deployment, use + instead ")+filepath)
+      }
+      // convert any incoming + to / to match cloud behavior
+      while (filepath.includes('+')) filepath = filepath.replace('+', '/')
+
+      // Put any other filtering here
+      if (filepath.includes('?')) {
+        filepath = filepath.substring(0, filepath.indexOf('?'))
+      }
+      if (filepath.substring(filepath.length - 1) === '/') filepath += 'index.html'
+      if (filepath.substring(0, 10) === '/api/docs/') {
+        filepath = filepath.replace('/api', '')
+      }
+      if (filepath.includes('/docs')) {
+        if (filepath.includes('.map')) {
+          return res.sendStatus(200)
+        }
+      }
+      filepath = path.resolve(path.join(projectPaths.basePath, 'webroot', filepath)) // .. out of build
+      if (fs.existsSync(filepath)) {
+        return res.sendFile(filepath)
+      } else {
+        console.log(ac.red.bold("can't find " + filepath))
+        return res.sendStatus(404)
+      }
+    }
+    // if none of the above, tickle enumerator so we can process other paths
+    next()
+  })
+}
+export default router

package/src/expressRoutes/api.ts

@@ -1,22 +1,22 @@
-/* eslint @typescript-eslint/no-var-requires: "off" */
-import express from 'express'
-
-import { getProjectName, getProjectVersion } from '../lib/LiftVersion'
-
-const openApiUi = require('openapi-ui')
-const router = express.Router()
-
-router.get('/', function (req, res, next) {
-  res.send(generateApiDoc())
-})
-
-export default router
-
-function generateApiDoc (): void {
-  console.log('---- Serving up api')
-  return openApiUi.generateIndex({
-    baseUrl: 'docs',
-    title: `${getProjectName() ?? ''} ${getProjectVersion()?.toString() ?? ''}`,
-    url: 'docs/apidoc.yaml'
-  })
-}
+/* eslint @typescript-eslint/no-var-requires: "off" */
+import express from 'express'
+
+import { getProjectName, getProjectVersion } from '../lib/LiftVersion'
+
+const openApiUi = require('openapi-ui')
+const router = express.Router()
+
+router.get('/', function (req, res, next) {
+  res.send(generateApiDoc())
+})
+
+export default router
+
+function generateApiDoc (): void {
+  console.log('---- Serving up api')
+  return openApiUi.generateIndex({
+    baseUrl: 'docs',
+    title: `${getProjectName() ?? ''} ${getProjectVersion()?.toString() ?? ''}`,
+    url: 'docs/apidoc.yaml'
+  })
+}