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

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Steven Ohmert
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Steven Ohmert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,65 +1,65 @@
-
-# MistLift
-
-_CLI tools and structured project support for easy-access cloud development_
-
-MistLift, aka [@tremho/mist-lift at npm](https://www.npmjs.com/package/@tremho/mist-lift) is an OpenSource project aimed at providing an easy and seamless platform for developers
-to quickly develop cloud services locally and then migrating to cloud with a simple and
-lightweight Command Line API that avoids some of the more intimidating aspects of 
-using larger frameworks for such purposes.
-
-This provides a much lower barrier to entry to would-be cloud developers
-and encourages a more open, distributed set of architectural choices from the 
-very beginnings of a new project.
-
-The initial version of MistLift is complete with minimal viability 
-to represent its future potential.  It focuses on a Typescript (JavaScript) oriented
-NodeJS stack hosted on the Amazon Web Services (AWS) Cloud infrastructure.
-
-In the future, other stacks will be supported, including DotNet and Python, and
-other stacks supported by AWS.
-Other cloud hosts, such as Azure, are also planned to be supported in future versions.
-
-## Contributions Needed
-
-MistLift is fully functional now, but there is much more planned in the
-vision roadmap, and your help is needed!
-
-[GitHub Repository](https://github.com/tremho/MistLift)
-
-Any level of involvement or contribution is appreciated.  Please see
-the [Contribution Guidelines](https://github.com/tremho/MistLift/blob/main/CONTRIBUTING.md).
-
-Also review the [Future States Plan](https://github.com/tremho/MistLift/blob/main/doc/Future%20State%20Planning.md)
-and the [issues page](https://github.com/tremho/MistLift/issues) for future state plans and status. 
-
-## Getting Started
-
-To get started using MistLift, please see the [QuickStart Guide](https://github.com/tremho/MistLift/blob/main/doc/MistLift%20Quick%20Start.md)
-
-
-## Changelog
-
-### 1.1.1, 1.1.2 -- 7/1/24
-
-- documentation updates
-- insure commands issued at project root
-- build if necessary before starting local server
-- fix local request handling treatment of body
-- fix package definition cross-over bug
-- add lint and test targets
-
-### 1.1.0 -- 6/28/24
-- add `info` command
-
-### 1.0.3 -- Initial Release 6/27/24
-- Include missing template files in npm publish
-
-### 1.0.0 - 1.0.2 -- Pre Release 6/26/24
-- Basic functionality
-- minor bug fixes
-- documentation
-- ts-standard linter adopted
-
-
-
+
+# MistLift
+
+_CLI tools and structured project support for easy-access cloud development_
+
+MistLift, aka [@tremho/mist-lift at npm](https://www.npmjs.com/package/@tremho/mist-lift) is an OpenSource project aimed at providing an easy and seamless platform for developers
+to quickly develop cloud services locally and then migrating to cloud with a simple and
+lightweight Command Line API that avoids some of the more intimidating aspects of 
+using larger frameworks for such purposes.
+
+This provides a much lower barrier to entry to would-be cloud developers
+and encourages a more open, distributed set of architectural choices from the 
+very beginnings of a new project.
+
+The initial version of MistLift is complete with minimal viability 
+to represent its future potential.  It focuses on a Typescript (JavaScript) oriented
+NodeJS stack hosted on the Amazon Web Services (AWS) Cloud infrastructure.
+
+In the future, other stacks will be supported, including DotNet and Python, and
+other stacks supported by AWS.
+Other cloud hosts, such as Azure, are also planned to be supported in future versions.
+
+## Contributions Needed
+
+MistLift is fully functional now, but there is much more planned in the
+vision roadmap, and your help is needed!
+
+[GitHub Repository](https://github.com/tremho/MistLift)
+
+Any level of involvement or contribution is appreciated.  Please see
+the [Contribution Guidelines](https://github.com/tremho/MistLift/blob/main/CONTRIBUTING.md).
+
+Also review the [Future States Plan](https://github.com/tremho/MistLift/blob/main/doc/Future%20State%20Planning.md)
+and the [issues page](https://github.com/tremho/MistLift/issues) for future state plans and status. 
+
+## Getting Started
+
+To get started using MistLift, please see the [QuickStart Guide](https://github.com/tremho/MistLift/blob/main/doc/MistLift%20Quick%20Start.md)
+
+
+## Changelog
+
+### 1.1.1, 1.1.2 -- 7/1/24
+
+- documentation updates
+- insure commands issued at project root
+- build if necessary before starting local server
+- fix local request handling treatment of body
+- fix package definition cross-over bug
+- add lint and test targets
+
+### 1.1.0 -- 6/28/24
+- add `info` command
+
+### 1.0.3 -- Initial Release 6/27/24
+- Include missing template files in npm publish
+
+### 1.0.0 - 1.0.2 -- Pre Release 6/26/24
+- Basic functionality
+- minor bug fixes
+- documentation
+- ts-standard linter adopted
+
+
+

package/package.json

@@ -1,75 +1,79 @@
-{
-  "name": "@tremho/mist-lift",
-  "version": "1.1.2",
-  "description": "lift command line utility for MistLift development",
-  "main": "build/index.js",
-  "bin": {
-    "lift": "build/lift.js"
-  },
-  "scripts": {
-    "prepublish": "rimraf build && npm run build && npm run indev",
-    "clean": "rimraf build && rimraf node_modules && npm install",
-    "build": "run-script-os",
-    "build:windows": "tsc && npm run postbuild",
-    "build:nix": "tsc && chmod +x build/lift.js && npm run postbuild",
-    "lint": "ts-standard --fix src",
-    "test": "npm run build && npm run unitTest && npm run integrationTest",
-    "unitTest": "tap --reporter=base --color --passes --disable-coverage src/lib/**/*.test.ts",
-    "integrationTest": "tap -t 150000 --reporter=base --color --passes --disable-coverage src/**/*.test.ts",
-    "indev": "run-script-os",
-    "indev:nix": "echo nix",
-    "indev:windows": "echo windows",
-    "postbuild": "cp -r src/commands/builtin/prebuilt-zips build/commands/builtin",
-    "installCli": "npm run build && cp build/lift.js ~/.nvm/versions/node/`node --version`/bin/lift"
-  },
-  "files": [
-    "build/**/*",
-    "src/**/*",
-    "templateData/*",
-    "index.d.ts",
-    "README.md",
-    "LICENSE",
-    "tsconfig.json"
-  ],
-  "keywords": [
-    "MistLift",
-    "Cloud",
-    "Lift",
-    "development",
-    "framework",
-    "cli",
-    "aws",
-    "express",
-    "node"
-  ],
-  "author": "tremho",
-  "license": "MIT",
-  "dependencies": {
-    "@aws-sdk/client-api-gateway": "^3.598.0",
-    "@aws-sdk/client-lambda": "^3.598.0",
-    "@aws-sdk/credential-providers": "^3.598.0",
-    "@tremho/inverse-y": "^1.1.0",
-    "ansi-colors": "^4.1.3",
-    "body-parser": "^1.20.2",
-    "clear-module": "^4.1.2",
-    "express": "^4.19.2",
-    "md5": "^2.3.0",
-    "openapi-ui": "^1.0.4",
-    "openapi3-ts": "^4.3.3",
-    "readline-sync": "^1.4.10",
-    "zip-dir": "^2.0.0"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.21",
-    "@types/md5": "^2.3.5",
-    "@types/node": "^20.14.2",
-    "@types/tap": "^15.0.11",
-    "@types/ws": "^8.5.10",
-    "axios": "^1.7.2",
-    "rimraf": "^5.0.7",
-    "run-script-os": "^1.1.6",
-    "tap": "^19.2.5",
-    "ts-standard": "^12.0.2",
-    "typescript": "^5.4.5"
-  }
-}
+{
+  "name": "@tremho/mist-lift",
+  "version": "1.1.3-pre-release.1",
+  "description": "lift command line utility for MistLift development",
+  "main": "build/index.js",
+  "bin": {
+    "lift": "build/lift.js"
+  },
+  "scripts": {
+    "prepublish": "run-script-os",
+    "prepublish:nix": "npx rimraf build && npm run build && npm run indev",
+    "prepublish:windows": "npx rimraf build & npm run build & npm run indev",
+    "clean": "npx rimraf build ; npx rimraf node_modules ; npm install",
+    "build": "run-script-os",
+    "build:windows": "tsc & npm run postbuild",
+    "build:nix": "tsc && chmod +x build/lift.js && npm run postbuild",
+    "lint": "ts-standard --fix src",
+    "test": "npm run build && npm run unitTest && npm run integrationTest",
+    "unitTest": "tap --reporter=base --color --passes --disable-coverage src/lib/**/*.test.ts",
+    "integrationTest": "tap -t 150000 --reporter=base --color --passes --disable-coverage src/**/*.test.ts",
+    "indev": "run-script-os",
+    "indev:nix": "echo nix",
+    "indev:windows": "echo windows",
+    "postbuild" : "run-script-os",
+    "postbuild:nix": "cp -r src/commands/builtin/prebuilt-zips build/commands/builtin",
+    "postbuild:windows": "robocopy src/commands/builtin/prebuilt-zips build/commands/builtin/prebult-zips /e > NUL 2>&1",
+    "installCli": "npm run build && cp build/lift.js ~/.nvm/versions/node/`node --version`/bin/lift"
+  },
+  "files": [
+    "build/**/*",
+    "src/**/*",
+    "templateData/*",
+    "index.d.ts",
+    "README.md",
+    "LICENSE",
+    "tsconfig.json"
+  ],
+  "keywords": [
+    "MistLift",
+    "Cloud",
+    "Lift",
+    "development",
+    "framework",
+    "cli",
+    "aws",
+    "express",
+    "node"
+  ],
+  "author": "tremho",
+  "license": "MIT",
+  "dependencies": {
+    "@aws-sdk/client-api-gateway": "^3.598.0",
+    "@aws-sdk/client-lambda": "^3.598.0",
+    "@aws-sdk/credential-providers": "^3.598.0",
+    "@tremho/inverse-y": "^1.1.0",
+    "ansi-colors": "^4.1.3",
+    "body-parser": "^1.20.2",
+    "clear-module": "^4.1.2",
+    "express": "^4.19.2",
+    "md5": "^2.3.0",
+    "openapi-ui": "^1.0.4",
+    "openapi3-ts": "^4.3.3",
+    "readline-sync": "^1.4.10",
+    "zip-dir": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/md5": "^2.3.5",
+    "@types/node": "^20.14.2",
+    "@types/tap": "^15.0.11",
+    "@types/ws": "^8.5.10",
+    "axios": "^1.7.2",
+    "rimraf": "^5.0.7",
+    "run-script-os": "^1.1.6",
+    "tap": "^19.2.5",
+    "ts-standard": "^12.0.2",
+    "typescript": "^5.4.5"
+  }
+}

package/src/commands/actions/initQuestions.ts

@@ -1,133 +1,133 @@
-/** Handles the input the user must supply upon init
- */
-
-import * as path from 'path'
-import * as fs from 'fs'
-import { executeCommand } from '../../lib/executeCommand'
-import { ask } from '../../lib/askQuestion'
-
-export async function interrogateUserForPackageJsonSettings (
-  projectPath: string,
-  defaults?: boolean
-): Promise<void> {
-  // get existing package.json or {}
-  // name of project - module name, display name, short name
-  // description
-  // set version
-  // gitAuthor ?? Author
-  // create a repository under gitAuthor?
-  // copyright
-  // spdx licence
-
-  const gitAuthor = await findGitAuthor()
-  const pkgJson = existingPackageJson(projectPath)
-  let name = pkgJson.name ?? nameFromProjectPath(projectPath)
-  let version = pkgJson.version ?? '1.0.0-prerelease.1'
-  let description = pkgJson.description ?? ''
-  let author = pkgJson.author ?? gitAuthor
-  let copyright = pkgJson.copyright ?? defaultCopyright(author)
-  let spdx = pkgJson.license ?? 'MIT'
-
-  if (defaults !== true) {
-    let ok = false
-    while (!ok) {
-      name = ask('Module name of this project',
-        'module name',
-        name
-      )
-      ok = name !== undefined && name.indexOf(' ') === -1
-    }
-    ok = false
-    while (!ok) {
-      version = ask('Project version. Use prerelease suffix for development versions. Use Semantic Versioning (https://semver.org).',
-        'version',
-        version ?? '0.1.0-prerelease.1'
-      )
-      ok = version !== undefined && version.indexOf('.') !== -1
-    }
-    ok = false
-    while (!ok) {
-      description = ask('Give a brief description of what this project does / what it is for',
-        'description',
-        description ?? ''
-      )
-      ok = description !== ''
-    }
-    ok = false
-    while (!ok) {
-      author = ask('Identify yourself as the author of this project',
-        'name',
-        author
-      )
-      ok = author !== ''
-    }
-    ok = false
-    while (!ok) {
-      copyright = ask('Specify a displayable copyright notice',
-        'Copyright',
-        copyright
-      )
-      ok = copyright !== ''
-    }
-    ok = false
-    while (!ok) {
-      spdx = ask('Specify the appropriate SPDX license identifier for this project. See https://spdx.org/licenses/ for more info.',
-        'spdx identifier',
-        spdx
-      )
-      ok = spdx !== ''
-    }
-  }
-  pkgJson.name = name
-  pkgJson.version = version
-  pkgJson.description = description
-  pkgJson.author = author
-  pkgJson.copyright = copyright
-  pkgJson.license = spdx
-
-  const pkgPath = path.join(projectPath, 'package.json')
-  fs.writeFileSync(pkgPath,
-    JSON.stringify(pkgJson, null, 2))
-}
-
-async function findGitAuthor (
-): Promise<string> {
-  return await executeCommand('git', ['config', '--get', 'user.name']).then((rt: any) => {
-    const rrt: { retcode: number | undefined, stdStr: string | undefined, errStr: string | undefined } = rt
-    let name: string | undefined = ''
-    if (rrt?.retcode !== 0) {
-      console.error(`Error ${rrt?.retcode ?? ''}`, rrt?.errStr)
-    } else {
-      name = rrt?.stdStr?.trim().toLowerCase()
-    }
-    return name ?? ''
-  })
-}
-
-function defaultCopyright (
-  name: string
-): string {
-  return `(C) ${new Date(Date.now()).getFullYear()} ${name}. All rights reserved.`
-}
-
-function nameFromProjectPath (
-  refPath: string
-): string {
-  const n = refPath.lastIndexOf('/') + 1
-  return refPath.substring(n)
-}
-
-function existingPackageJson (
-  refPath: string
-): any {
-  let packageJson: any = {}
-  const pkgPath = path.join(refPath, 'package.json')
-  if (fs.existsSync((pkgPath))) {
-    try {
-      packageJson = JSON.parse(fs.readFileSync(pkgPath).toString())
-    } catch (e: any) {
-      // error in existing package.json.  Please fix or remove and try again.
-    }
-  }
-  return packageJson
-}
+/** Handles the input the user must supply upon init
+ */
+
+import * as path from 'path'
+import * as fs from 'fs'
+import { executeCommand } from '../../lib/executeCommand'
+import { ask } from '../../lib/askQuestion'
+
+export async function interrogateUserForPackageJsonSettings (
+  projectPath: string,
+  defaults?: boolean
+): Promise<void> {
+  // get existing package.json or {}
+  // name of project - module name, display name, short name
+  // description
+  // set version
+  // gitAuthor ?? Author
+  // create a repository under gitAuthor?
+  // copyright
+  // spdx licence
+
+  const gitAuthor = await findGitAuthor()
+  const pkgJson = existingPackageJson(projectPath)
+  let name = pkgJson.name ?? nameFromProjectPath(projectPath)
+  let version = pkgJson.version ?? '1.0.0-prerelease.1'
+  let description = pkgJson.description ?? ''
+  let author = pkgJson.author ?? gitAuthor
+  let copyright = pkgJson.copyright ?? defaultCopyright(author)
+  let spdx = pkgJson.license ?? 'MIT'
+
+  if (defaults !== true) {
+    let ok = false
+    while (!ok) {
+      name = ask('Module name of this project',
+        'module name',
+        name
+      )
+      ok = name !== undefined && name.indexOf(' ') === -1
+    }
+    ok = false
+    while (!ok) {
+      version = ask('Project version. Use prerelease suffix for development versions. Use Semantic Versioning (https://semver.org).',
+        'version',
+        version ?? '0.1.0-prerelease.1'
+      )
+      ok = version !== undefined && version.indexOf('.') !== -1
+    }
+    ok = false
+    while (!ok) {
+      description = ask('Give a brief description of what this project does / what it is for',
+        'description',
+        description ?? ''
+      )
+      ok = description !== ''
+    }
+    ok = false
+    while (!ok) {
+      author = ask('Identify yourself as the author of this project',
+        'name',
+        author
+      )
+      ok = author !== ''
+    }
+    ok = false
+    while (!ok) {
+      copyright = ask('Specify a displayable copyright notice',
+        'Copyright',
+        copyright
+      )
+      ok = copyright !== ''
+    }
+    ok = false
+    while (!ok) {
+      spdx = ask('Specify the appropriate SPDX license identifier for this project. See https://spdx.org/licenses/ for more info.',
+        'spdx identifier',
+        spdx
+      )
+      ok = spdx !== ''
+    }
+  }
+  pkgJson.name = name
+  pkgJson.version = version
+  pkgJson.description = description
+  pkgJson.author = author
+  pkgJson.copyright = copyright
+  pkgJson.license = spdx
+
+  const pkgPath = path.join(projectPath, 'package.json')
+  fs.writeFileSync(pkgPath,
+    JSON.stringify(pkgJson, null, 2))
+}
+
+async function findGitAuthor (
+): Promise<string> {
+  return await executeCommand('git', ['config', '--get', 'user.name']).then((rt: any) => {
+    const rrt: { retcode: number | undefined, stdStr: string | undefined, errStr: string | undefined } = rt
+    let name: string | undefined = ''
+    if (rrt?.retcode !== 0) {
+      console.error(`Error ${rrt?.retcode ?? ''}`, rrt?.errStr)
+    } else {
+      name = rrt?.stdStr?.trim().toLowerCase()
+    }
+    return name ?? ''
+  })
+}
+
+function defaultCopyright (
+  name: string
+): string {
+  return `(C) ${new Date(Date.now()).getFullYear()} ${name}. All rights reserved.`
+}
+
+function nameFromProjectPath (
+  refPath: string
+): string {
+  const n = refPath.lastIndexOf('/') + 1
+  return refPath.substring(n)
+}
+
+function existingPackageJson (
+  refPath: string
+): any {
+  let packageJson: any = {}
+  const pkgPath = path.join(refPath, 'package.json')
+  if (fs.existsSync((pkgPath))) {
+    try {
+      packageJson = JSON.parse(fs.readFileSync(pkgPath).toString())
+    } catch (e: any) {
+      // error in existing package.json.  Please fix or remove and try again.
+    }
+  }
+  return packageJson
+}