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

package/src/lib/openAPI/ApiBuildCollector.ts

@@ -1,47 +1,47 @@
-/**
- * Part 1 of two steps to build openApi docs.
- * This reads values from our "definitions.json" format and creates a single array that step 2 will turn into
- * openApi specifications.
- */
-import fs from 'fs'
-import path from 'path'
-import { recurseDirectory } from '../DirectoryUtils'
-import { resolvePaths } from '../pathResolve'
-
-export function gatherFunctionDefinitions (): any[] {
-  const defs: any = []
-  try {
-    const projectPaths = resolvePaths()
-    if (!projectPaths.verified) return []
-    const funcNames: string[] = []
-    if (!fs.existsSync(projectPaths.functionPath)) return []
-    let firstDepth = 0
-    recurseDirectory(projectPaths.functionPath, (filepath, stats) => {
-      if (stats.isDirectory()) {
-        const depth = filepath.split(path.sep).length
-        if (firstDepth === 0) firstDepth = depth
-        if (firstDepth === depth) {
-          funcNames.push(path.basename(filepath))
-        }
-      }
-      return false
-    })
-    if (projectPaths.functionPath.includes('functions')) {
-      for (const name of funcNames) {
-        const defPath = path.join(projectPaths.functionPath, name, 'src', 'definition.json')
-        if (fs.existsSync(defPath)) {
-          const content = fs.readFileSync(defPath).toString()
-          // const buildPath = path.join(projectPaths.buildPath, 'functions', name, 'src', 'definition.json')
-          // fs.writeFileSync(buildPath, content); // use this opportunity to copy to build folder before we use it.
-          defs.push(JSON.parse(content))
-        } else {
-          console.error(`Definition file not found at ${defPath}`)
-          return []
-        }
-      }
-    }
-  } catch (e: any) {
-    console.error('Exception in ApiBuildCollector', e)
-  }
-  return defs
-}
+/**
+ * Part 1 of two steps to build openApi docs.
+ * This reads values from our "definitions.json" format and creates a single array that step 2 will turn into
+ * openApi specifications.
+ */
+import fs from 'fs'
+import path from 'path'
+import { recurseDirectory } from '../DirectoryUtils'
+import { resolvePaths } from '../pathResolve'
+
+export function gatherFunctionDefinitions (): any[] {
+  const defs: any = []
+  try {
+    const projectPaths = resolvePaths()
+    if (!projectPaths.verified) return []
+    const funcNames: string[] = []
+    if (!fs.existsSync(projectPaths.functionPath)) return []
+    let firstDepth = 0
+    recurseDirectory(projectPaths.functionPath, (filepath, stats) => {
+      if (stats.isDirectory()) {
+        const depth = filepath.split(path.sep).length
+        if (firstDepth === 0) firstDepth = depth
+        if (firstDepth === depth) {
+          funcNames.push(path.basename(filepath))
+        }
+      }
+      return false
+    })
+    if (projectPaths.functionPath.includes('functions')) {
+      for (const name of funcNames) {
+        const defPath = path.join(projectPaths.functionPath, name, 'src', 'definition.json')
+        if (fs.existsSync(defPath)) {
+          const content = fs.readFileSync(defPath).toString()
+          // const buildPath = path.join(projectPaths.buildPath, 'functions', name, 'src', 'definition.json')
+          // fs.writeFileSync(buildPath, content); // use this opportunity to copy to build folder before we use it.
+          defs.push(JSON.parse(content))
+        } else {
+          console.error(`Definition file not found at ${defPath}`)
+          return []
+        }
+      }
+    }
+  } catch (e: any) {
+    console.error('Exception in ApiBuildCollector', e)
+  }
+  return defs
+}

package/src/lib/openAPI/WebrootFileSupport.ts

@@ -1,19 +1,19 @@
-
-import * as path from 'path'
-import { resolvePaths } from '../pathResolve'
-import { recurseDirectory } from '../DirectoryUtils'
-
-export function GetWebrootServePaths (): string[] {
-  const projectPaths = resolvePaths()
-  const webroot = path.join(projectPaths.basePath, 'webroot')
-
-  const list: string[] = ['']
-  recurseDirectory(webroot, (filepath, stats) => {
-    if (stats.isDirectory()) {
-      const relpath = filepath.substring(webroot.length)
-      if (!list.includes(relpath)) list.push(relpath)
-    }
-    return false
-  })
-  return list
-}
+
+import * as path from 'path'
+import { resolvePaths } from '../pathResolve'
+import { recurseDirectory } from '../DirectoryUtils'
+
+export function GetWebrootServePaths (): string[] {
+  const projectPaths = resolvePaths()
+  const webroot = path.join(projectPaths.basePath, 'webroot')
+
+  const list: string[] = ['']
+  recurseDirectory(webroot, (filepath, stats) => {
+    if (stats.isDirectory()) {
+      const relpath = filepath.substring(webroot.length)
+      if (!list.includes(relpath)) list.push(relpath)
+    }
+    return false
+  })
+  return list
+}

package/src/lib/openAPI/openApiConstruction.ts

@@ -1,196 +1,196 @@
-/**
- * This is part 2 of 2 -- we take our pre-built json array of definitions and apply them to openApi in this phase.
- */
-import { OpenApiBuilder } from 'openapi3-ts/oas30'
-import fs from 'fs'
-import path from 'path'
-import { resolvePaths } from '../pathResolve'
-
-export async function buildOpenApi (
-  defs: any[],
-  includePrivate: boolean = false,
-  yamlFile?: string
-): Promise<Uint8Array> {
-  const builder = new OpenApiBuilder()
-
-  const projectPaths = await resolvePaths()
-  if (!projectPaths.verified) return new Uint8Array(0) // don't continue if not valid
-
-  // Read our package.json and construct info from that
-  const pkgFile = projectPaths.packagePath
-  let pkg: any = {}
-  try { pkg = JSON.parse(fs.readFileSync(pkgFile).toString()) } catch {}
-  const title: string = pkg.name ?? ''
-  // let summary = pkg.description;
-  // let spdx: string = pkg.license ?? ''
-  // const contactName: string = pkg.author ?? ''
-  const version: string = pkg.version ?? ''
-
-  // license and version definitely come from package.json
-  // description and title might get overridden by service.info file
-  const infoFile = path.join(projectPaths.functionPath, 'apiService.info.json')
-  let svcInfo: any = {}
-  if (fs.existsSync(infoFile)) {
-    svcInfo = JSON.parse(fs.readFileSync(infoFile).toString())
-  }
-  // spdx = svcInfo.contact?.spdx ?? spdx
-
-  const info = {
-    title: svcInfo.name ?? title,
-    // summary: summary,
-    description: svcInfo.description,
-    version: svcInfo.version ?? version ?? new Date().toUTCString()
-  }
-  builder.addInfo(info)
-
-  // map our defs into openApi values
-  for (const def of defs) {
-    const pathDef = {}
-    if (def.private === true && !includePrivate) continue // skip private
-
-    const parameters = def.parameters ?? []
-    const methods = def.allowedMethods.split(',')
-    const schemas = def.schemas ?? {}
-    for (const schemaName of Object.getOwnPropertyNames(schemas)) {
-      const schema = schemas[schemaName]
-      addTypeSchema(builder, schemaName, schema)
-    }
-    for (let method of methods) {
-      method = method.trim().toLowerCase()
-      addFunctionMethod(pathDef, method, def)
-      for (const param of parameters) {
-        addParameter(pathDef, param)
-      }
-    }
-    addCORSOptionMethod(pathDef)
-    builder.addPath((def.pathMap ?? '/' + (def.name as string)), pathDef)
-
-    builder.addSchema('Empty', {
-      title: 'Empty Schema',
-      type: 'object'
-    })
-  }
-
-  const outFile = yamlFile ?? path.join(projectPaths.basePath, 'webroot', 'docs', 'apidoc.yaml')
-
-  const str2ab = (str: string): Uint8Array => {
-    const buf = new ArrayBuffer(str.length * 2) // 2 bytes for each char
-    const bufView = new Uint8Array(buf)
-    for (let i = 0, strLen = str.length; i < strLen; i++) {
-      bufView[i] = str.charCodeAt(i)
-    }
-    return bufView
-  }
-
-  const yaml = builder.getSpecAsYaml()
-  const bytes = str2ab(yaml)
-  if (!includePrivate) {
-    fs.writeFileSync(outFile, yaml)
-  }
-  return bytes
-}
-
-function addTypeSchema (builder: any, schemaName: string, schema: any): void {
-  const ref: any = { title: schemaName, type: 'object', properties: {} }
-  for (const prop of Object.getOwnPropertyNames(schema)) {
-    const scType: any = schemaType('', schema[prop], false)
-
-    ref.properties[prop] = scType
-  }
-
-  builder.addSchema(schemaName, ref)
-}
-
-function addFunctionMethod (pathDef: any, method: string, def: any): void {
-  // TODO: Define a return schema and put that here
-  const retDef: any = (def.returns)['200']
-  const content: any = {}
-  const mime = retDef?.content ?? retDef?.mime ?? 'text/plain'
-  content[mime] = {}
-
-  const methData = {
-    summary: def.name,
-    description: def.description,
-    responses: {
-      200: {
-        description: retDef?.description ?? 'Success Response',
-        content
-      }
-    }
-  }
-  pathDef[method] = methData
-}
-function addCORSOptionMethod (pathDef: any): void {
-  if (pathDef.options === undefined) return // already assinged by definition
-  // add options for CORS
-  pathDef.options = {
-    responses: {
-      200: {
-        description: '200 response',
-        content: {
-          'application/json': {
-            schema: {
-              $ref: '#/components/schemas/Empty'
-            }
-          }
-        }
-      }
-    },
-    'x-amazon-apigateway-integration': {
-      responses: {
-        default: {
-          statusCode: '200'
-        }
-      },
-      requestTemplates: {
-        'application/json': '{"statusCode": 200}'
-      },
-      passthroughBehavior: 'when_no_match',
-      type: 'mock'
-    }
-  }
-}
-
-function addParameter (pathDef: any, param: any): void {
-  if (pathDef.parameters === undefined) pathDef.parameters = []
-  const parameters = pathDef.parameters
-  const example = param.example ?? param.default ?? ''
-  const type = param.type ?? typeof example
-  const deflt = param.default ?? example
-
-  parameters.push({
-    in: param.in,
-    name: param.name,
-    description: param.description,
-    example,
-    required: param.required,
-    schema: schemaType(deflt, type, true)
-  })
-}
-
-function schemaType (deflt: string, namedType: string, innerOnly: boolean): any {
-  if (typeof namedType === 'object') return namedType
-  const typeFormat = namedType.split(':')
-  let type = typeFormat[0]
-  const format = typeFormat.length > 1 ? typeFormat[1] : undefined
-  if (!(type === 'string' ||
-        type === 'number' ||
-        type === 'integer' ||
-        type === 'boolean' ||
-        type === 'int' ||
-        type === 'bool'
-  )) {
-    return innerOnly
-      ? {
-          $ref: `#/components/schemas/${type}`
-        }
-      : {
-          schema: {
-            $ref: `#/components/schemas/${type}`
-          }
-        }
-  }
-  if (type === 'int') type = 'integer'
-  if (type === 'bool') type = 'boolean'
-  return innerOnly ? { type, format, example: deflt } : { schema: { type, format, example: deflt } }
-}
+/**
+ * This is part 2 of 2 -- we take our pre-built json array of definitions and apply them to openApi in this phase.
+ */
+import { OpenApiBuilder } from 'openapi3-ts/oas30'
+import fs from 'fs'
+import path from 'path'
+import { resolvePaths } from '../pathResolve'
+
+export async function buildOpenApi (
+  defs: any[],
+  includePrivate: boolean = false,
+  yamlFile?: string
+): Promise<Uint8Array> {
+  const builder = new OpenApiBuilder()
+
+  const projectPaths = await resolvePaths()
+  if (!projectPaths.verified) return new Uint8Array(0) // don't continue if not valid
+
+  // Read our package.json and construct info from that
+  const pkgFile = projectPaths.packagePath
+  let pkg: any = {}
+  try { pkg = JSON.parse(fs.readFileSync(pkgFile).toString()) } catch {}
+  const title: string = pkg.name ?? ''
+  // let summary = pkg.description;
+  // let spdx: string = pkg.license ?? ''
+  // const contactName: string = pkg.author ?? ''
+  const version: string = pkg.version ?? ''
+
+  // license and version definitely come from package.json
+  // description and title might get overridden by service.info file
+  const infoFile = path.join(projectPaths.functionPath, 'apiService.info.json')
+  let svcInfo: any = {}
+  if (fs.existsSync(infoFile)) {
+    svcInfo = JSON.parse(fs.readFileSync(infoFile).toString())
+  }
+  // spdx = svcInfo.contact?.spdx ?? spdx
+
+  const info = {
+    title: svcInfo.name ?? title,
+    // summary: summary,
+    description: svcInfo.description,
+    version: svcInfo.version ?? version ?? new Date().toUTCString()
+  }
+  builder.addInfo(info)
+
+  // map our defs into openApi values
+  for (const def of defs) {
+    const pathDef = {}
+    if (def.private === true && !includePrivate) continue // skip private
+
+    const parameters = def.parameters ?? []
+    const methods = def.allowedMethods.split(',')
+    const schemas = def.schemas ?? {}
+    for (const schemaName of Object.getOwnPropertyNames(schemas)) {
+      const schema = schemas[schemaName]
+      addTypeSchema(builder, schemaName, schema)
+    }
+    for (let method of methods) {
+      method = method.trim().toLowerCase()
+      addFunctionMethod(pathDef, method, def)
+      for (const param of parameters) {
+        addParameter(pathDef, param)
+      }
+    }
+    addCORSOptionMethod(pathDef)
+    builder.addPath((def.pathMap ?? '/' + (def.name as string)), pathDef)
+
+    builder.addSchema('Empty', {
+      title: 'Empty Schema',
+      type: 'object'
+    })
+  }
+
+  const outFile = yamlFile ?? path.join(projectPaths.basePath, 'webroot', 'docs', 'apidoc.yaml')
+
+  const str2ab = (str: string): Uint8Array => {
+    const buf = new ArrayBuffer(str.length * 2) // 2 bytes for each char
+    const bufView = new Uint8Array(buf)
+    for (let i = 0, strLen = str.length; i < strLen; i++) {
+      bufView[i] = str.charCodeAt(i)
+    }
+    return bufView
+  }
+
+  const yaml = builder.getSpecAsYaml()
+  const bytes = str2ab(yaml)
+  if (!includePrivate) {
+    fs.writeFileSync(outFile, yaml)
+  }
+  return bytes
+}
+
+function addTypeSchema (builder: any, schemaName: string, schema: any): void {
+  const ref: any = { title: schemaName, type: 'object', properties: {} }
+  for (const prop of Object.getOwnPropertyNames(schema)) {
+    const scType: any = schemaType('', schema[prop], false)
+
+    ref.properties[prop] = scType
+  }
+
+  builder.addSchema(schemaName, ref)
+}
+
+function addFunctionMethod (pathDef: any, method: string, def: any): void {
+  // TODO: Define a return schema and put that here
+  const retDef: any = (def.returns)['200']
+  const content: any = {}
+  const mime = retDef?.content ?? retDef?.mime ?? 'text/plain'
+  content[mime] = {}
+
+  const methData = {
+    summary: def.name,
+    description: def.description,
+    responses: {
+      200: {
+        description: retDef?.description ?? 'Success Response',
+        content
+      }
+    }
+  }
+  pathDef[method] = methData
+}
+function addCORSOptionMethod (pathDef: any): void {
+  if (pathDef.options === undefined) return // already assinged by definition
+  // add options for CORS
+  pathDef.options = {
+    responses: {
+      200: {
+        description: '200 response',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Empty'
+            }
+          }
+        }
+      }
+    },
+    'x-amazon-apigateway-integration': {
+      responses: {
+        default: {
+          statusCode: '200'
+        }
+      },
+      requestTemplates: {
+        'application/json': '{"statusCode": 200}'
+      },
+      passthroughBehavior: 'when_no_match',
+      type: 'mock'
+    }
+  }
+}
+
+function addParameter (pathDef: any, param: any): void {
+  if (pathDef.parameters === undefined) pathDef.parameters = []
+  const parameters = pathDef.parameters
+  const example = param.example ?? param.default ?? ''
+  const type = param.type ?? typeof example
+  const deflt = param.default ?? example
+
+  parameters.push({
+    in: param.in,
+    name: param.name,
+    description: param.description,
+    example,
+    required: param.required,
+    schema: schemaType(deflt, type, true)
+  })
+}
+
+function schemaType (deflt: string, namedType: string, innerOnly: boolean): any {
+  if (typeof namedType === 'object') return namedType
+  const typeFormat = namedType.split(':')
+  let type = typeFormat[0]
+  const format = typeFormat.length > 1 ? typeFormat[1] : undefined
+  if (!(type === 'string' ||
+        type === 'number' ||
+        type === 'integer' ||
+        type === 'boolean' ||
+        type === 'int' ||
+        type === 'bool'
+  )) {
+    return innerOnly
+      ? {
+          $ref: `#/components/schemas/${type}`
+        }
+      : {
+          schema: {
+            $ref: `#/components/schemas/${type}`
+          }
+        }
+  }
+  if (type === 'int') type = 'integer'
+  if (type === 'bool') type = 'boolean'
+  return innerOnly ? { type, format, example: deflt } : { schema: { type, format, example: deflt } }
+}

package/src/lib/pathResolve.ts

@@ -1,26 +1,26 @@
-import path from 'path'
-import fs from 'fs'
-
-// Find the path roots in the project directory
-export function resolvePaths (
-): {
-  basePath: string // project base
-  buildPath: string // build folder
-  functionPath: string // functions folder
-  packagePath: string // package.json
-  verified: boolean // all of these exist if true, else, may be incomplete project
-} {
-  const cwd = process.cwd()
-  let funcPath = path.join(cwd, 'functions')
-  while (true) {
-    if (!fs.existsSync(funcPath)) {
-      funcPath = path.normalize(path.join(funcPath, '..'))
-    } else {
-      const basePath = path.normalize(path.join(funcPath, '..'))
-      const buildPath = path.join(basePath, 'build')
-      const packagePath = path.join(basePath, 'package.json')
-      const verified = fs.existsSync(basePath) && fs.existsSync(funcPath) && fs.existsSync(packagePath)
-      return { basePath, buildPath, functionPath: funcPath, packagePath, verified }
-    }
-  }
-}
+import path from 'path'
+import fs from 'fs'
+
+// Find the path roots in the project directory
+export function resolvePaths (
+): {
+  basePath: string // project base
+  buildPath: string // build folder
+  functionPath: string // functions folder
+  packagePath: string // package.json
+  verified: boolean // all of these exist if true, else, may be incomplete project
+} {
+  const cwd = process.cwd()
+  let funcPath = path.join(cwd, 'functions')
+  while (true) {
+    if (!fs.existsSync(funcPath)) {
+      funcPath = path.normalize(path.join(funcPath, '..'))
+    } else {
+      const basePath = path.normalize(path.join(funcPath, '..'))
+      const buildPath = path.join(basePath, 'build')
+      const packagePath = path.join(basePath, 'package.json')
+      const verified = fs.existsSync(basePath) && fs.existsSync(funcPath) && fs.existsSync(packagePath)
+      return { basePath, buildPath, functionPath: funcPath, packagePath, verified }
+    }
+  }
+}

package/src/lib/utils.ts

@@ -1,43 +1,43 @@
-/* eslint @typescript-eslint/no-var-requires: "off" */
-import { executeCommand } from './executeCommand'
-import * as ac from 'ansi-colors'
-import * as fs from 'fs'
-
-/** General utilities */
-
-const zipDir = require('zip-dir')
-
-// pause the given number of milliseconds
-export async function delay (
-  ms: number // milliseconds to delay
-): Promise<void> {
-  return await new Promise(resolve => { setTimeout(resolve, ms) })
-}
-
-export async function FolderToZip (
-  folderPath: string,
-  zipPath: string
-): Promise<Uint8Array> {
-  return await new Promise(resolve => {
-    zipDir(folderPath, { saveTo: zipPath }, function (err: any, buffer: Uint8Array) {
-      if (err !== '' && err !== undefined && err !== null) throw err
-      // `buffer` is the buffer of the zipped file
-      // And the buffer was saved to `~/myzip.zip`
-      resolve(buffer)
-    })
-  })
-}
-export async function UnzipToFolder (
-  zipPath: string,
-  folderPath: string,
-  replace: boolean = true
-): Promise<void> {
-  // TODO: using CLI -- find a good package. "unzip" has vulnerabilities. Try others.
-
-  if (replace) fs.rmSync(folderPath, { recursive: true, force: true })
-  const result: { retcode: number, errStr: string } = await executeCommand('unzip', [zipPath, '-d', folderPath])
-  if (result.retcode !== 0) {
-    console.error(ac.red.bold(`failed to stage webroot (${result.retcode}): ${result.errStr}`))
-    throw Error()
-  }
-}
+/* eslint @typescript-eslint/no-var-requires: "off" */
+import { executeCommand } from './executeCommand'
+import * as ac from 'ansi-colors'
+import * as fs from 'fs'
+
+/** General utilities */
+
+const zipDir = require('zip-dir')
+
+// pause the given number of milliseconds
+export async function delay (
+  ms: number // milliseconds to delay
+): Promise<void> {
+  return await new Promise(resolve => { setTimeout(resolve, ms) })
+}
+
+export async function FolderToZip (
+  folderPath: string,
+  zipPath: string
+): Promise<Uint8Array> {
+  return await new Promise(resolve => {
+    zipDir(folderPath, { saveTo: zipPath }, function (err: any, buffer: Uint8Array) {
+      if (err !== '' && err !== undefined && err !== null) throw err
+      // `buffer` is the buffer of the zipped file
+      // And the buffer was saved to `~/myzip.zip`
+      resolve(buffer)
+    })
+  })
+}
+export async function UnzipToFolder (
+  zipPath: string,
+  folderPath: string,
+  replace: boolean = true
+): Promise<void> {
+  // TODO: using CLI -- find a good package. "unzip" has vulnerabilities. Try others.
+
+  if (replace) fs.rmSync(folderPath, { recursive: true, force: true })
+  const result: { retcode: number, errStr: string } = await executeCommand('unzip', [zipPath, '-d', folderPath])
+  if (result.retcode !== 0) {
+    console.error(ac.red.bold(`failed to stage webroot (${result.retcode}): ${result.errStr}`))
+    throw Error()
+  }
+}