@corva/create-app 0.0.0-2576df8

package/README.md

@@ -0,0 +1,218 @@
+# @corva/create-app
+
+Apps generator for [corva.ai](https://corva.ai).
+
+## Prerequisites
+
+- NodeJs >= 16.14.0 (https://nodejs.org/en/download/)
+
+## Installation
+
+```sh
+npm i -g @corva/create-app
+```
+
+## Usage
+
+`corva-create-app` provides a user-friendly CLI wizard to create an app.
+
+```sh
+Usage: create-corva-app [options] [command]
+
+Options:
+  -h, --help                                           display help for command
+
+Commands:
+  create [options] [project-directory]                 Create a new app
+  zip [options] <project-directory> [patterns...]      Bundle app
+  release [options] <project-directory> [patterns...]  Release app
+  rerun [options] <project-directory>                  Rerun app
+  attach [options] <project-directory>                 Add app to live assets streams
+  help [command]                                       display help for command
+```
+
+## Create an app
+
+To create a new app use `create` command.
+
+```sh
+Usage: create-corva-app create <project-directory> [options]
+
+Create a new app
+
+Arguments:
+  project-directory               Project directory to work with (default: "Current working dir")
+
+Options:
+  --developerName [string]        Enter the Developer Name (default: "O&G Company")
+  --developerIdentifier [string]  Enter the Developer Identifier (default: "oandgc")
+  --appType                       Choose the App Type (choices: "ui", "scheduler", "stream", "task")
+  --schedulerType                 Choose the scheduler type (choices: "1", "2", "4")
+  --cronString [string]           Provide CRON string for the scheduler (default: "*/5 * * * *")
+  --depthMilestone [number]       Provide depth milestone for the scheduler (default: 1)
+  --logType                       Choose the log type (choices: "time", "depth")
+  --appName [string]              Enter the App Name (default: "Corva Dev Center App")
+  --description [string]          Enter description (default: "This is the description of my app. You can do great things with it!")
+  --summary [string]              Enter summary (default: "More information about this app goes here")
+  --category [string]             Enter category (default: "")
+  --website [string]              Enter website (default: "https://www.oandgexample.com/my-app/")
+  --segments                      Choose segments (choices: "drilling", "completion")
+  --runtime                       Choose runtime (choices: "ui", "nodejs16.x", "python3.8", "python3.9")
+  -p, --packageManager            Please select the desired package manager (choices: "yarn", "npm")
+  -t, --useTypescript [boolean]   Would you like to use TypesScript? (default: false)
+  --silent [boolean]              Only log result of the operation (default: false)
+  --no-dependencies-install       Skip installing dependencies
+  --no-git-init                   Skip initializing git repository
+```
+
+### Examples
+
+#### Create a UI application
+
+```sh
+create-corva-app test --appName "Test" --segments "drilling" --category "wellDesign" --appKey "some-company.test.ui" --appType "ui" --runtime "ui"
+```
+
+#### Create a NodeJs TypeScript application
+
+```sh
+create-corva-app test --appName "Test" --segments "drilling" --category "wellDesign" --appKey "some-company.test.scheduler" --appType "scheduler" --runtime "nodejs12.x" -t
+```
+
+#### Create a Python application
+
+```sh
+create-corva-app test --appName "Test" --segments "drilling" --category "analytics" --appKey "some-company.test.stream" --appType "stream" --runtime "python3.8"
+```
+
+## Zip
+
+To create a zip that contains app ready to be deployed to Corva use `zip` command.
+
+```sh
+Usage: create-corva-app zip [options] <project-directory> [patterns...]
+
+Bundle app
+
+Arguments:
+  project-directory                  Project directory to work with
+  patterns                           Additional patterns to zip (default: [])
+
+Options:
+  --bump-version <string>            Bump version (choices: "major", "minor", "patch", "skip")
+  --ignored-files [ignoredFiles...]  Patterns to skip zip
+  --silent [boolean]                 Only log result of the operation (default: false)
+```
+
+### What is getting zipped?
+
+By default next files will be included.
+
+For `frontend` apps:
+
+- `manifest.json`
+- `package.json`
+- `yarn.lock`
+- `.npmrc`
+- `config-overrides.js`
+- all files under `src`
+- `tsconfig.json`
+
+For apps that written in `node`:
+
+- `manifest.json`
+- `package.json`
+- either `package-lock.json` or `yarn.lock`
+- all files under `config` folder
+- all `*.js` files under `src` and `lib` folders (if `typescript` is not used)
+- `tsconfig.json`, `tsconfig.build.json` (if `typescript` is used)
+- all `*.ts` files under `src` and `lib` folders (if `typescript` is used)
+
+For apps that written in `python`:
+
+- `manifest.json`
+- `requirements.txt`
+- all `*.py` files
+
+If you want to zip some files that are not included pass that as `patterns` arguments.
+To skip some files from zipping please use `--ignored-files` option.
+
+### Examples
+
+#### Create a zip file from the content of `test-app` folder & put zip file in it.
+
+```sh
+create-corva-app zip test-app
+```
+
+#### Create a zip file & automatically bump version
+
+```sh
+create-corva-app zip test-app --bump-version=patch
+```
+
+#### Create a zip file from the content of `test-app` folder with custom content ([globs](<https://en.wikipedia.org/wiki/Glob_(programming)>) are supported)
+
+```sh
+create-corva-app zip test-app some/missing/file1 some/other/missing/file2 all/files/*.glob
+```
+
+## Release
+
+To push app to Corva use `release` command.
+
+```sh
+Usage: create-corva-app release [options] <project-directory> [patterns...]
+
+Release app
+
+Arguments:
+  project-directory            Project directory to work with
+  patterns                     Additional patterns to zip (default: [])
+
+Options:
+  --bump-version <string>      Bump version (choices: "major", "minor", "patch", "skip")
+  --ignored-files [string...]  Patterns to skip zip (default: [])
+  --env [string]               Environment to use (choices: "qa", "staging", "production", default: "qa")
+  --api-key [string]           Pre generated API key for authorization during app upload
+  --app-key [string]           Explicitly set appKey that CLI is going to use. Otherwise it will be taken from manifest.json file. [works only for Front-End apps currently]
+  --notes [string]             Add custom notes to published app
+  --label [string]             Put a label on the release (choices: "DEV", "BETA", "PROD")
+  --remove-on-fail [boolean]   Remove release if it fails during deployment (default: false)
+  --silent [boolean]           Only log result of the operation (default: false)
+  --remove-on-success          App package (.zip) will not be deleted after upload (default: true)
+  --remove-existing [boolean]  If package.json version is already taken - remove the previously published package and upload a new one (default: false)
+  --author [string]            Author name for the audit
+```
+
+### Examples
+
+#### Make a release with ask for version
+
+```sh
+create-corva-app release test-app
+```
+
+#### Make a release without version increase
+
+```sh
+create-corva-app release test-app --bump-version=skip
+```
+
+#### Make a release with increased version
+
+```sh
+create-corva-app release test-app --bump-version=patch
+```
+
+#### Make a release with custom version
+
+```sh
+create-corva-app release test-app --bump-version=4.2.0
+```
+
+#### Make a release with author option(by default it will use your GitHub username)
+
+```sh
+create-corva-app release test-app --author=MyName
+```

package/bin/cca.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { run } from '../lib/main.js';
+
+await run();

package/bin/create-corva-app.cjs

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+const { sync: spawnSync } = require('cross-spawn');
+
+const cmd = 'node';
+const originalCwd = process.cwd();
+
+process.chdir(__dirname);
+
+const args = ['--no-warnings', '--experimental-json-modules', 'cca.js']
+  .concat(process.argv.slice(2))
+  .concat(['--original-cwd', originalCwd]);
+
+const { signal, status, error } = spawnSync(cmd, args, {
+  stdio: 'inherit',
+  shell: false,
+});
+
+if (signal) {
+  process.exit(signal);
+}
+
+if (status || error) {
+  process.exit(1);
+}

package/common/node/.env

@@ -0,0 +1,15 @@
+API_KEY=
+APP_KEY=${APP_KEY}
+APP_NAME=${APP_NAME}
+PROVIDER=${PROVIDER}
+
+API_ROOT_URL=https://api.corva.ai
+DATA_API_ROOT_URL=https://data.corva.ai
+CACHE_URL=redis://localhost:6379
+
+LOG_LEVEL=debug
+LOG_THRESHOLD_MESSAGE_SIZE=99999
+LOG_THRESHOLD_MESSAGE_COUNT=99999
+
+ENVIRONMENT=development
+NODE_ENV=development

package/common/node/.env.sample

@@ -0,0 +1,26 @@
+# Corva API key to perform actions with the API
+API_KEY=
+# Unique ID of the app
+APP_KEY=
+# Human readable name of the app
+APP_NAME=
+# Company identifier
+PROVIDER=
+
+# Root URL for Corva API
+API_ROOT_URL=
+# Root URL for Corva Data API
+DATA_API_ROOT_URL=
+# Redis cache url for caching data in Stream/Scheduler apps
+CACHE_URL=
+
+# Logging configuration, see https://corva-ai.github.io/node-sdk/docs/v7.2.0/classes/CorvaLogger
+LOG_LEVEL=debug
+LOG_THRESHOLD_MESSAGE_SIZE=99999
+LOG_THRESHOLD_MESSAGE_COUNT=99999
+
+# Working environment
+ENVIRONMENT=development
+
+# nodejs-specific settings
+NODE_ENV=development

package/common/node/gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

package/common/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/common/python/.env

@@ -0,0 +1,5 @@
+LOG_LEVEL=DEBUG
+LOG_THRESHOLD_MESSAGE_SIZE=99999
+LOG_THRESHOLD_MESSAGE_COUNT=99999
+
+ENVIRONMENT=development

package/common/python/.env.sample

@@ -0,0 +1,7 @@
+# Logging configuration, see https://corva-ai.github.io/python-sdk/corva-sdk/1.8.1/index.html#_logging
+LOG_LEVEL=DEBUG
+LOG_THRESHOLD_MESSAGE_SIZE=99999
+LOG_THRESHOLD_MESSAGE_COUNT=99999
+
+# Working environment
+ENVIRONMENT=development

package/common/python/Makefile

@@ -0,0 +1,15 @@
+.PHONY: default install bundle release test
+.DEFAULT_GOAL := default
+
+default: install
+install: prepare-venv
+	@. venv/bin/activate && pip install -r requirements.txt
+prepare-venv:
+	@which python3 > /dev/null || (echo "python3 not found, please install it first" && exit 1;)
+	@test -d venv || python3 -m venv venv
+bundle:
+	@create-corva-app zip . --bump-version=skip
+release:
+	@create-corva-app release . --bump-version=skip
+test: prepare-venv
+	@. venv/bin/activate && pytest

package/common/python/gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+venv

package/common/python/requirements.txt

@@ -0,0 +1,2 @@
+corva-sdk==1.14.0
+pytest==7.1.1

package/lib/commands/attach.js

@@ -0,0 +1,28 @@
+import chalk from 'chalk';
+import { Command } from 'commander';
+import { ERROR_ICON } from '../constants/messages.js';
+import { runFlow } from '../flow.js';
+import { ATTACH_FLOW } from '../flows/attach.js';
+import { getRealWorkingDir } from '../helpers/commands.js';
+import { apiKeyOption } from '../options/api-key.js';
+import { appVersion } from '../options/app-version.js';
+import { envOption } from '../options/env.js';
+import { originalCwdOption } from '../options/original-cwd.js';
+import { silentOption } from '../options/silent.js';
+
+export const attachCommand = new Command('attach')
+  .description('Add app to live assets streams')
+  .argument('<project-directory>', 'Project directory to work with')
+  .addOption(apiKeyOption)
+  .addOption(envOption)
+  .addOption(silentOption)
+  .addOption(appVersion)
+  .addOption(originalCwdOption)
+  .action(async (dirName, options) => {
+    await runFlow(ATTACH_FLOW, { dirName: getRealWorkingDir(dirName, options), options });
+  })
+  .showHelpAfterError()
+  .showSuggestionAfterError(true)
+  .configureOutput({
+    outputError: (str, write) => write(chalk.red(`${ERROR_ICON} ${str}`)),
+  });