@corva/create-app 0.28.0-0 → 0.28.0-3

package/templates/python/scheduler/README.md

@@ -0,0 +1,31 @@
+# Dev Center Python Polling Scheduler Data App
+
+## Getting started
+
+[Python SDK Documentation](https://corva-ai.github.io/python-sdk)
+
+### 1. Install
+
+You need to have `make` installed:
+    
+- Windows: [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install)
+- OS X: [Command Line Tools for Xcode](https://developer.apple.com/download/more/)
+- Linux: refer to your distro-specific docs
+
+To install dependencies run:
+
+```sh
+make
+```
+
+### 2. Run Tests
+
+```sh
+make test
+```
+
+### 3. Create app zip
+
+```sh
+make bundle
+```

package/templates/python/stream/README.md

@@ -0,0 +1,31 @@
+# Dev Center Python Real-Time Stream Data App
+
+## Getting started
+
+[Python SDK Documentation](https://corva-ai.github.io/python-sdk)
+
+### 1. Install
+
+You need to have `make` installed:
+    
+- Windows: [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install)
+- OS X: [Command Line Tools for Xcode](https://developer.apple.com/download/more/)
+- Linux: refer to your distro-specific docs
+
+To install dependencies run:
+
+```sh
+make
+```
+
+### 2. Run Tests
+
+```sh
+make test
+```
+
+### 3. Create app zip
+
+```sh
+make bundle
+```

package/templates/python/task/README.md

@@ -0,0 +1,31 @@
+# Dev Center Python Task Data App
+
+## Getting started
+
+[Python SDK Documentation](https://corva-ai.github.io/python-sdk)
+
+### 1. Install
+
+You need to have `make` installed:
+    
+- Windows: [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install)
+- OS X: [Command Line Tools for Xcode](https://developer.apple.com/download/more/)
+- Linux: refer to your distro-specific docs
+
+To install dependencies run:
+
+```sh
+make
+```
+
+### 2. Run Tests
+
+```sh
+make test
+```
+
+### 3. Create app zip
+
+```sh
+make bundle
+```

package/constants/package.js

@@ -1,50 +0,0 @@
-const dependencies = {
-  devDependencies: {
-    'postcss-loader': '4.1.0',
-  },
-  dependencies: {
-    '@corva/ui': 'latest',
-    '@material-ui/core': '4.11.2',
-    '@material-ui/icons': '4.9.1',
-    '@material-ui/lab': '4.0.0-alpha.57',
-    '@material-ui/pickers': '3.2.10',
-    'classnames': '2.2.6',
-    'corva-convert-units': '1.10.17',
-    'highcharts': '8.1.2',
-    'highcharts-react-official': '2.2.2',
-    'lodash': '^4.17.4',
-    'mapbox.js': '3.2.1',
-    'moment': '2.23.0',
-    'moment-timezone': '0.5.23',
-    'prop-types': '^15.6.1',
-    'react': '17.0.1',
-    'react-dom': '17.0.1',
-  },
-};
-
-const tsDependencies = {
-  devDependencies: {
-    '@tsconfig/create-react-app': '1.0.2',
-    '@types/material-ui': '0.21.9',
-    '@types/react': '^17.0.22',
-    '@types/react-dom': '^17.0.9',
-    '@typescript-eslint/eslint-plugin': '^4.31.2',
-    '@typescript-eslint/parser': '^4.31.2',
-    'ts-loader': '8.2.0',
-    'typescript': '^4.4.3',
-  },
-};
-
-const scripts = {
-  build: 'webpack --config=./config-overrides.js --mode production',
-  start: 'webpack-dev-server --config=./config-overrides.js --open --mode development',
-  zip: 'create-corva-app --zip ui',
-  lint: 'eslint --cache ./src/',
-  release: 'create-corva-app --release',
-};
-
-module.exports = {
-  tsDependencies,
-  dependencies,
-  scripts,
-};

package/index.js

@@ -1,386 +0,0 @@
-#!/usr/bin/env node
-
-'use strict';
-
-const chalk = require('chalk');
-const figlet = require('figlet');
-const commander = require('commander');
-const fs = require('fs-extra');
-const inquirer = require('inquirer');
-const os = require('os');
-const path = require('path');
-const semver = require('semver');
-
-const uiScripts = require('./scripts/ui');
-const { ensureLatestVersion } = require('./scripts/utils/version');
-const utils = require('./helpers/utils.js');
-const manifestHelpers = require('./helpers/manifest.js');
-const versioning = require('./helpers/versioning.js');
-
-const packageConstants = require('./constants/package.js');
-const manifestConstants = require('./constants/manifest.js');
-
-const packageJson = require('./package.json');
-const { clear } = require('console');
-const spawn = require('cross-spawn');
-const { APP_RUNTIMES, TEMPLATE_TYPES, APP_TYPES } = require('./constants/cli');
-
-const YARN_EXECUTABLE = 'yarn';
-
-let packageManager = YARN_EXECUTABLE;
-let useTypescript = false;
-
-const shouldUseYarn = () => packageManager === YARN_EXECUTABLE;
-const getLockFileName = (manager) =>
-  manager === YARN_EXECUTABLE ? 'yarn.lock' : 'package-lock.json';
-
-let projectName;
-let program;
-
-function startingMessage() {
-  clear();
-  console.log(chalk.green('   Welcome to apps generator for:'));
-  console.log(chalk.cyan(figlet.textSync('CORVA.AI', { horizontalLayout: 'full' })));
-}
-
-function checkNodeVersion() {
-  process.stdout.write('Checking node version...');
-
-  const unsupportedNodeVersion = !semver.satisfies(process.version, '>=10');
-  if (unsupportedNodeVersion) {
-    console.log(
-      chalk.red(
-        `\nYou are using Node ${process.version}.\n\n` +
-          `Please update to Node 10 or higher for a better, fully supported experience.\n`
-      )
-    );
-    // Fall back to latest supported react-scripts on Node 4
-    return process.exit(1);
-  }
-  process.stdout.write('  ✅  \n');
-}
-
-function checkOptions(opts) {
-  let isValid = true;
-  const values = {};
-
-  manifestConstants.getManifestMandatoryKeys(opts).forEach((key) => {
-    if (!opts[key]) {
-      isValid = false;
-    }
-
-    values[key] = opts[key];
-  });
-
-  return {
-    isValid,
-    values,
-  };
-}
-
-async function initialChecks() {
-  program = new commander.Command('corva-create-app')
-    .version(packageJson.version)
-    .argument('[project-directory]', 'project directory to work with')
-    .usage(`${chalk.green('<project-directory>')} [options]`)
-    .action((name) => {
-      projectName = name;
-    })
-    .option('-z, --zip <type>', 'zip app source')
-    .option('--bump-version [string]', 'bump version')
-    .option('--release', 'release app')
-    .addOption(
-      new commander.Option(`-p, --packageManager [string]`, 'package manager to use')
-        .default(YARN_EXECUTABLE)
-        .choices(['npm', YARN_EXECUTABLE])
-    );
-
-  manifestConstants.manifestOptions(projectName).forEach((value) => {
-    const type = typeof value.default;
-    const option = new commander.Option(
-      `${value.alias ? `-${value.alias}, ` : ''}--${value.name} [${
-        (type !== 'undefined' && type) || 'string'
-      }]`,
-      value.message
-    );
-
-    if (value.choices) {
-      if (typeof value.choices === 'function') {
-        option.choices(value.choices());
-      } else {
-        option.choices(
-          value.choices.map((choice) => `${typeof choice === 'object' ? choice.value : choice}`)
-        );
-      }
-    }
-
-    if (type === 'number') {
-      option.argParser(Number);
-    }
-
-    program.addOption(option);
-  });
-
-  program.parse(process.argv);
-
-  checkNodeVersion();
-
-  const opts = program.opts();
-
-  packageManager = opts.packageManager || packageManager;
-  useTypescript = opts.useTypescript || useTypescript;
-
-  if (opts.zip) {
-    if (opts.zip === APP_RUNTIMES.UI)
-      return uiScripts.zipAppSource({
-        bumpVersion: opts.bumpVersion,
-      });
-    process.exit(0);
-  }
-  if (opts.release) {
-    return uiScripts.releaseAppZip({ bumpVersion: opts.bumpVersion });
-    process.exit(0);
-  }
-
-  startingMessage();
-
-  if (!projectName) {
-    console.error('Please specify the project directory:');
-    console.log(`  ${chalk.cyan(program.name())} ${chalk.green('<project-directory>')}`);
-    console.log();
-    console.log('For example:');
-    console.log(`  ${chalk.cyan(program.name())} ${chalk.green('my-react-app')}`);
-    console.log();
-    console.log(`Run ${chalk.cyan(`${program.name()} --help`)} to see all options.`);
-    process.exit(1);
-  }
-
-  // NOTE: Default action
-  await createApp(opts);
-}
-
-async function initPackage(manifest) {
-  const appType = manifest.application.type;
-  if (appType === APP_TYPES.UI) {
-    await ensureLatestVersion();
-  }
-
-  const root = path.resolve(projectName);
-
-  console.log(`Creating a new Corva app in ${chalk.green(root)}.`);
-
-  fs.mkdirSync(root);
-
-  fs.writeFileSync(path.join(root, 'manifest.json'), JSON.stringify(manifest, null, 2) + os.EOL);
-
-  let runtime = manifest.settings.runtime;
-
-  // Runtimes normally include a version number, like python3.8 or nodejs12.x. We don't want to have a directory or
-  // config for every possible version at this point, so just consolidate all versions of a runtime into a single
-  // template directory.
-  if (appType !== APP_TYPES.UI) {
-    if (runtime.startsWith(TEMPLATE_TYPES.PYTHON)) {
-      runtime = TEMPLATE_TYPES.PYTHON;
-    } else {
-      runtime = useTypescript ? TEMPLATE_TYPES.NODE_TYPESCRIPT : TEMPLATE_TYPES.NODE;
-    }
-  } else {
-    runtime = useTypescript ? TEMPLATE_TYPES.UI_TS : TEMPLATE_TYPES.UI;
-  }
-
-  addTemplate(root, appType, runtime);
-  configureApp(root, appType, runtime, manifest);
-  installApp(root, appType, runtime);
-}
-
-async function createApp(opts) {
-  const { isValid, values } = checkOptions(opts);
-
-  if (isValid) {
-    Object.keys(values).forEach((key) => {
-      console.log(`${key} : ${values[key]}`);
-    });
-
-    const manifest = manifestHelpers.fillManifest(values);
-
-    await initPackage(manifest);
-  } else {
-    console.log('Please fill your app Metadata');
-
-    inquirer.prompt(manifestConstants.manifestOptions(projectName), opts).then((answers) => {
-      packageManager = answers.packageManager || packageManager;
-      useTypescript = answers.useTypescript || useTypescript;
-
-      const manifest = manifestHelpers.fillManifest(answers);
-
-      initPackage(manifest);
-    });
-  }
-
-  console.log();
-}
-
-function addTemplate(root, appType, runtime) {
-  console.log(chalk.green('Copying app template...'));
-  console.log();
-
-  const templateFolder = path.resolve(__dirname, 'template', appType, runtime);
-
-  utils.copyFolderRecursiveSync(templateFolder, root, runtime);
-
-  const gitignore = path.join(root, 'gitignore');
-
-  if (fs.pathExistsSync(gitignore)) {
-    // We can't have .gitignore file in our templates.
-    // It's missing when @corva/create-app is installed.
-    // That's why we manually rename gitignore to .gitignore after copying template
-
-    fs.renameSync(gitignore, path.join(root, '.gitignore'));
-  }
-
-  console.log(chalk.green('Done: copying app template!'));
-}
-
-function configureApp(root, appType, runtime, manifest) {
-  if (appType === APP_TYPES.UI) {
-    addPackageJSON(root, manifest.application.name);
-  } else if (runtime.startsWith(TEMPLATE_TYPES.NODE)) {
-    updatePackageJSON(root, manifest.application.description, appType, runtime);
-  }
-
-  if (runtime.startsWith(TEMPLATE_TYPES.PYTHON) && appType === APP_TYPES.SCHEDULER) {
-    patchSchedulerForPython(root, appType, runtime, manifest);
-  }
-}
-
-function patchSchedulerForPython(root, appType, runtime, manifest) {
-  const schedulerType = manifest.settings.app.scheduler_type;
-
-  if (schedulerType === manifestConstants.SCHEDULER_TYPE_DATA_TIME.value) {
-    return;
-  }
-
-  const templateFolder = path.resolve(__dirname, 'template', appType, runtime);
-  const originalType = 'ScheduledDataTimeEvent';
-  const replacementType =
-    schedulerType === manifestConstants.SCHEDULER_TYPE_DEPTH.value
-      ? 'ScheduledDepthEvent'
-      : 'ScheduledNaturalTimeEvent';
-  const patchedCode = fs
-    .readFileSync(path.join(templateFolder, 'lambda_function.py'), 'utf-8')
-    .replace(new RegExp(originalType, 'g'), replacementType);
-
-  fs.writeFileSync(path.join(root, 'lambda_function.py'), patchedCode);
-}
-
-function addPackageJSON(root, appName) {
-  const devDependencies = {
-    ...packageConstants.dependencies.devDependencies,
-    ...(useTypescript && packageConstants.tsDependencies.devDependencies),
-  };
-  const packageJson = {
-    name: appName.replace(/\W/g, ''),
-    version: '0.0.1',
-    main: 'src/index.js',
-    scripts: packageConstants.scripts,
-    ...packageConstants.dependencies,
-    devDependencies,
-  };
-
-  fs.writeFileSync(path.join(root, 'package.json'), JSON.stringify(packageJson, null, 2) + os.EOL);
-}
-
-function updatePackageJSON(root, description, appType, runtime) {
-  const templateFolder = path.resolve(__dirname, 'template', appType, runtime);
-
-  let packageJson = JSON.parse(fs.readFileSync(path.join(templateFolder, 'package.json'), 'utf-8'));
-
-  packageJson.name = projectName.replace(/\W/g, '-').toLowerCase();
-  packageJson.description = description;
-
-  packageJson.scripts.bundle = packageJson.scripts.bundle.replace(
-    '$LOCKFILE',
-    getLockFileName(packageManager)
-  );
-
-  fs.writeFileSync(path.join(root, 'package.json'), JSON.stringify(packageJson, null, 2) + os.EOL);
-}
-
-function installApp(appPath, appType, runtime) {
-  switch (runtime) {
-    case TEMPLATE_TYPES.PYTHON: {
-      break;
-    }
-    default: {
-      installJsApp(appPath, appType);
-
-      break;
-    }
-  }
-}
-
-function installJsApp(appPath, appType) {
-  const command = packageManager;
-  const args = ['install'];
-
-  console.log(chalk.yellow(`Installing template dependencies using ${command}...`));
-  const proc = spawn.sync(command, args, { stdio: ['inherit', 'inherit', 'pipe'], cwd: appPath });
-
-  if (proc.stderr) {
-    const error = proc.stderr
-      .toString('utf8')
-      .split('\n')
-      // NOTE: filter out warnings caused by @corva/ui peer dependencies
-      .filter(line => !line.includes('@corva/ui'))
-      .join('\n');
-    console.log(error);
-  }
-
-  if (proc.status !== 0) {
-    console.error(`\`${command} ${args.join(' ')}\` failed`);
-    return;
-  }
-
-  console.log(chalk.green('Successfull project install'));
-
-  let initializedGit = false;
-  if (versioning.tryGitInit(appPath)) {
-    initializedGit = true;
-    console.log();
-    console.log('Initialized a git repository.');
-  }
-
-  if (initializedGit && versioning.tryGitCommit(appPath)) {
-    console.log();
-    console.log('Created git commit.');
-  }
-
-  console.log();
-  console.log(`Success! Created ${projectName} at ${appPath}`);
-
-  if (appType === APP_RUNTIMES.UI) {
-    console.log('Inside that directory, you can run several commands:');
-    helpCommands();
-  }
-}
-
-async function helpCommands() {
-  const displayedCommand = packageManager;
-  const useYarn = shouldUseYarn();
-
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} start`));
-  console.log('    Starts the development server.');
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}build`));
-  console.log('    Bundles the app into static files for production.');
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}zip`));
-  console.log('    Bundles the app into ZIP file in app root directory');
-  console.log();
-  console.log(chalk.cyan(`  ${displayedCommand} ${useYarn ? '' : 'run '}release`));
-  console.log('    Uploads the app ZIP to Corva');
-  console.log();
-}
-
-initialChecks();

package/scripts/ui/index.js

@@ -1,7 +0,0 @@
-const zipAppSource = require('./zipAppSource');
-const releaseAppZip = require('./releaseAppZip');
-
-module.exports = {
-  zipAppSource,
-  releaseAppZip,
-};