@corva/create-app 0.0.0-210a1a8

package/lib/constants/manifest.js

@@ -0,0 +1,263 @@
+import { APP_RUNTIMES, APP_TYPES, SUPPORTED_NON_UI_APP_RUNTIMES, TEMPLATE_TYPES } from './cli.js';
+
+export const defaultManifest = {
+  format: 1,
+  license: {
+    type: 'MIT',
+    url: 'https://www.oandgexample.com/license/',
+  },
+  developer: {
+    name: 'O&G Company',
+    identifier: 'oandgc',
+    authors: [],
+  },
+  application: {
+    type: APP_TYPES.UI,
+    key: 'app.key-goes-here',
+    visibility: 'private',
+    name: 'Name of My App',
+    description: 'This is the description of my app. You can do great things with it!',
+    summary: 'More information about this app goes here',
+    category: '',
+    website: 'https://www.oandgexample.com/my-app/',
+    segments: ['drilling', 'completion', 'intervention'],
+  },
+  settings: {
+    entrypoint: {
+      file: 'index.js',
+      function: 'handler',
+    },
+    environment: {},
+  },
+  datasets: {},
+};
+
+export const defaultUIAppManifest = {
+  application: {
+    ui: {
+      initial_size: { w: 4, h: 10 },
+      multi_rig: false,
+      full_screen_report: false,
+      use_app_header_v3: true,
+    },
+  },
+  settings: {
+    entrypoint: {
+      file: 'src/index.js',
+      function: 'handler',
+    },
+    environment: {},
+  },
+};
+
+export const defaultDataAppNodeManifest = {
+  settings: {
+    entrypoint: {
+      file: 'index.js',
+      function: 'handler',
+    },
+    timeout: 120,
+    memory: 128,
+    environment: {},
+  },
+};
+
+export const defaultDataAppPythonManifest = {
+  settings: {
+    entrypoint: {
+      file: 'lambda_function',
+      function: 'lambda_handler',
+    },
+    timeout: 120,
+    memory: 128,
+    environment: {},
+  },
+};
+
+export const getManifestMandatoryKeys = (opts) => {
+  const keys = manifestOptions(opts.projectName).reduce((acc, option) => {
+    if (option.required) {
+      acc.push(option.name);
+    }
+
+    return acc;
+  }, []);
+
+  const { appType, schedulerType } = opts;
+
+  if (appType) {
+    if (appType !== APP_TYPES.UI) {
+      keys.push('runtime');
+    }
+
+    if (appType === APP_TYPES.SCHEDULER) {
+      if (!schedulerType) {
+        keys.push('schedulerType');
+      } else if (schedulerType === SCHEDULER_TYPE_DEPTH.value) {
+        keys.push('depthMilestone');
+      } else {
+        keys.push('cronString');
+      }
+    }
+  }
+
+  return keys;
+};
+
+export const SCHEDULER_TYPE_NATURAL_TIME = {
+  name: 'Natural Time',
+  value: 1,
+};
+export const SCHEDULER_TYPE_DATA_TIME = {
+  name: 'Data Time',
+  value: 2,
+};
+export const SCHEDULER_TYPE_DEPTH = {
+  name: 'Depth',
+  value: 4,
+};
+
+export const LOG_TYPES = {
+  TIME: 'time',
+  DEPTH: 'depth',
+};
+
+export const manifestOptions = (projectName = 'Corva Dev Center App') => [
+  {
+    name: 'developerName',
+    message: 'Enter the Developer Name',
+    default: 'O&G Company',
+  },
+  {
+    name: 'developerIdentifier',
+    message: 'Enter the Developer Identifier',
+    default: 'oandgc',
+  },
+  {
+    type: 'rawlist',
+    name: 'appType',
+    message: 'Choose the App Type',
+    default: APP_TYPES.UI,
+    choices: Object.values(APP_TYPES),
+    required: true,
+  },
+  {
+    type: 'rawlist',
+    name: 'schedulerType',
+    message: 'Choose the scheduler type',
+    default: SCHEDULER_TYPE_NATURAL_TIME.value,
+    choices: [SCHEDULER_TYPE_NATURAL_TIME, SCHEDULER_TYPE_DATA_TIME, SCHEDULER_TYPE_DEPTH],
+    when: (answers) => answers.appType === APP_TYPES.SCHEDULER,
+  },
+  {
+    name: 'cronString',
+    message: 'Provide CRON string for the scheduler',
+    default: '*/5 * * * *',
+    when: (answers) => answers.schedulerType && answers.schedulerType !== SCHEDULER_TYPE_DEPTH.value,
+  },
+  {
+    name: 'depthMilestone',
+    message: 'Provide depth milestone for the scheduler',
+    default: 1,
+    when: (answers) => answers.schedulerType === SCHEDULER_TYPE_DEPTH.value,
+    filter: (value) => (isNaN(value) ? value : Number(value)),
+  },
+  {
+    name: 'logType',
+    message: 'Choose the log type',
+    default: LOG_TYPES.TIME,
+    choices: Object.values(LOG_TYPES),
+    when: (answers) => answers.appType === APP_TYPES.STREAM,
+  },
+  {
+    name: 'appKey',
+    message: 'Enter the App Key',
+    default: 'app.key-goes-here',
+    required: true,
+  },
+  {
+    name: 'appName',
+    message: 'Enter the App Name',
+    default: projectName,
+    required: true,
+  },
+  {
+    name: 'description',
+    message: 'Enter description',
+    default: 'This is the description of my app. You can do great things with it!',
+  },
+  {
+    name: 'summary',
+    message: 'Enter summary',
+    default: 'More information about this app goes here',
+  },
+  {
+    name: 'category',
+    message: 'Enter category',
+    default: '',
+    required: true,
+  },
+  {
+    name: 'website',
+    message: 'Enter website',
+    default: 'https://www.oandgexample.com/my-app/',
+  },
+  {
+    type: 'rawlist',
+    name: 'segments',
+    message: 'Choose segments',
+    choices: ['drilling', 'completion', 'intervention'],
+    required: true,
+  },
+  {
+    type: 'rawlist',
+    name: 'runtime',
+    message: 'Choose runtime',
+    choices: (answers) => {
+      if (answers && answers.appType !== APP_TYPES.UI) {
+        return SUPPORTED_NON_UI_APP_RUNTIMES;
+      }
+
+      return [APP_RUNTIMES.UI, ...SUPPORTED_NON_UI_APP_RUNTIMES];
+    },
+    when: (answers) => answers.appType !== APP_TYPES.UI,
+  },
+  {
+    type: 'rawlist',
+    name: 'packageManager',
+    message: 'Please select the desired package manager',
+    alias: 'p',
+    default: 'yarn',
+    choices: ['yarn', 'npm'],
+    when: (answers) => !answers.runtime || !answers.runtime.startsWith(TEMPLATE_TYPES.PYTHON),
+  },
+  {
+    type: 'confirm',
+    name: 'useTypescript',
+    alias: 't',
+    message: 'Would you like to use TypesScript?',
+    default: false,
+    when: (answers) =>
+      (answers.runtime && answers.runtime.startsWith(TEMPLATE_TYPES.NODE)) || answers.appType === APP_TYPES.UI,
+  },
+  {
+    name: 'silent',
+    message: 'Only log result of the operation',
+    default: false,
+  },
+  {
+    name: 'no-dependencies-install',
+    message: 'Skip installing dependencies',
+  },
+  {
+    name: 'no-git-init',
+    message: 'Skip initializing git repository',
+  },
+  {
+    name: 'extensions',
+    message: 'App template extensions',
+    default: [],
+    when: (answers) => answers.appType === APP_TYPES.UI,
+    commaSeparated: true,
+  },
+];

package/lib/constants/messages.js

@@ -0,0 +1,15 @@
+import chalk from 'chalk';
+
+export const SUCCESS_ICON = '✅';
+export const ERROR_ICON = '❌';
+
+export const RELEASE = {
+  createZip: 'Creating zip archive...\n',
+  createZipError: 'Could not create zip archive.',
+  createZipSuccess: `Zip archive has been created ${SUCCESS_ICON}\n`,
+  getAuthToken: 'Reading auth token...',
+  getAuthTokenError: `Could not find auth token or API_KEY in .env file.\nFor UI app please run ${chalk.cyan`yarn start`} and login to Corva to fetch it or set API_KEY in your .env file`,
+  getAppKey: 'Reading app key...',
+  getAppKeyError: "Could not find app key. Please make sure it's defined in manifest.json",
+  uploadApp: 'Uploading app...',
+};

package/lib/constants/package.js

@@ -0,0 +1,300 @@
+import _ from 'lodash';
+import { APP_EXTENSIONS } from './cli.js';
+
+const uiDependencies = {
+  '@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',
+  '@icon-park/react': '1.4.2',
+  'classnames': '2.2.6',
+  'corva-convert-units': '1.10.33',
+  'highcharts': '10.3.3',
+  'highcharts-react-official': '2.2.2',
+  'lodash': '^4.18.1',
+  'mapbox-gl': '3.16.0',
+  'moment': '2.29.4',
+  'moment-timezone': '0.5.43',
+  'react': '18.3.1',
+  'react-dom': '18.3.1',
+};
+
+const jsUiDevDependencies = {
+  '@corva/dc-platform-shared': 'latest',
+  '@corva/eslint-config-browser': '0.2.2',
+  // @testing-library/react 16 moved this from a dependency to a peer
+  '@testing-library/dom': '10.4.1',
+  '@testing-library/jest-dom': '7.0.1',
+  '@testing-library/react': '16.3.2',
+  '@testing-library/user-event': '14.6.6',
+  '@vitejs/plugin-react': '6.1.1',
+  '@vitest/coverage-v8': '4.1.11',
+  'dotenv': '16.4.7',
+  'dotenv-expand': '11.0.7',
+  'eslint': '7.32.0',
+  'jsdom': '22.1.0',
+  'postcss-preset-env': '11.3.0',
+  'rollup-plugin-license': '3.6.0',
+  'sass-embedded': '1.100.0',
+  'terser': '5.47.1',
+  'vite': '8.3.0',
+  'vite-plugin-static-copy': '4.1.0',
+  'vitest': '4.1.11',
+};
+
+const tsUiDevDependencies = {
+  ...jsUiDevDependencies,
+  '@types/lodash': '^4.17.25',
+  '@types/material-ui': '0.21.9',
+  '@types/minimatch': '3.0.5',
+  '@types/mime': '3.0.1',
+  '@types/node': '24.12.2',
+  '@types/react': '18.2.42',
+  '@types/react-dom': '^18.2',
+  '@typescript-eslint/eslint-plugin': '^4.31.2',
+  '@typescript-eslint/parser': '^4.31.2',
+  'typescript': '^5.9.3',
+};
+
+const corvaUiExtension = {
+  scripts: {
+    prepare: 'husky install',
+  },
+  dependencies: {
+    '@tanstack/react-query': '4.35.3',
+  },
+  devDependencies: {
+    '@commitlint/cli': '^17.0.0',
+    '@commitlint/config-conventional': '^17.0.0',
+    'husky': '^8.0.0',
+    'lint-staged': '^13.0.0',
+    '@tanstack/eslint-plugin-query': '4.34.1',
+  },
+};
+
+function applyUiExtension(packageJson, extensionNames) {
+  if (!Array.isArray(extensionNames) || extensionNames.length === 0) {
+    return packageJson;
+  }
+
+  const extensions = extensionNames
+    .map((extensionName) => {
+      if (extensionName === APP_EXTENSIONS.CORVA) {
+        return corvaUiExtension;
+      }
+
+      return null;
+    })
+    .filter(Boolean);
+
+  return _.merge({}, packageJson, ...extensions);
+}
+
+const uiScripts = {
+  build: 'vite build',
+  start: 'vite --open',
+  zip: 'create-corva-app zip .',
+  lint: 'eslint --cache --ext .js,.jsx,.ts,.tsx ./src/',
+  release: 'create-corva-app release .',
+  test: 'vitest run',
+  coverage: 'vitest run --coverage',
+};
+
+const uiPackage = {
+  'version': '0.0.1',
+  'main': 'src/index.js',
+  'scripts': uiScripts,
+  'dependencies': uiDependencies,
+  'devDependencies': jsUiDevDependencies,
+  'lint-staged': {
+    'src/**/*.{js,jsx,ts,tsx}': 'eslint --fix',
+  },
+  'resolutions': {
+    '@noble/hashes': '1.8.0',
+    'lodash': '4.18.1',
+  },
+};
+
+const tsUiPackage = {
+  ...uiPackage,
+  scripts: { ...uiScripts, typecheck: 'tsc --noEmit' },
+  devDependencies: tsUiDevDependencies,
+  // todo: temporary solution, ref https://github.com/oppia/oppia/issues/22283#issuecomment-2756641371
+  resolutions: {
+    ...uiPackage.resolutions,
+    '@types/babel__traverse': '7.20.6',
+  },
+};
+
+const nodeNpmScripts = {
+  'bundle': 'create-corva-app zip .',
+  'test': 'npm run unit',
+  'unit': 'jest',
+  'lint': 'eslint --ext .js,.ts .',
+  'lint:fix': 'eslint --ext .js,.ts --fix .',
+};
+
+const nodeDependencies = {
+  '@corva/node-sdk': '^8.5.0',
+};
+
+const nodeDevDependencies = {
+  '@corva/eslint-config-node': '^6.0.0',
+  '@typescript-eslint/eslint-plugin': '^8.58.1',
+  '@typescript-eslint/parser': '^8.58.1',
+  'jest': '^29.7.0',
+  'dotenv': '^16.0.3',
+  'eslint': '^8.2.0',
+  'eslint-plugin-jest': '^27.1.5',
+  'prettier': '^2.0.0',
+  'typescript': '^5.9.3',
+};
+
+const nodeTsDevDependencies = {
+  ...nodeDevDependencies,
+  '@types/jest': '^29.5.12',
+  'ts-jest': '^29.2.4',
+};
+
+const nodeYarnScripts = {
+  ...nodeNpmScripts,
+  test: 'yarn unit',
+};
+
+const commonTsScripts = {
+  'build': 'tsc -p tsconfig.build.json',
+  'postbuild': 'cp manifest.json dist/manifest.json',
+  'lint': 'eslint --ext .ts .',
+  'lint:fix': 'eslint --ext .ts --fix .',
+};
+
+const nodeTsScripts = {
+  ...nodeNpmScripts,
+  ...commonTsScripts,
+};
+
+const nodeTsYarnScripts = {
+  ...nodeYarnScripts,
+  ...commonTsScripts,
+};
+
+const nodeNpmPackage = {
+  version: '0.0.1',
+  main: 'index.js',
+  private: true,
+  dependencies: nodeDependencies,
+  devDependencies: nodeDevDependencies,
+  scripts: nodeNpmScripts,
+  jest: {
+    setupFiles: ['dotenv/config'],
+  },
+  prettier: '@corva/eslint-config-node/prettier',
+  eslintConfig: {
+    root: true,
+    extends: '@corva/eslint-config-node',
+    overrides: [
+      {
+        files: ['**/*.ts'],
+        parser: '@typescript-eslint/parser',
+        parserOptions: {
+          project: 'tsconfig.json',
+          sourceType: 'module',
+        },
+        plugins: ['@typescript-eslint/eslint-plugin'],
+        rules: {
+          '@typescript-eslint/padding-line-between-statements': 'off',
+        },
+      },
+      {
+        files: [
+          '**/*.spec.js',
+          '**/*.spec.ts',
+          '**/*.spec.mjs',
+          '**/*.spec.cjs',
+          '**/__mocks__/**/*.js',
+          '**/__mocks__/**/*.ts',
+          '**/__mocks__/**/*.cjs',
+          '**/__mocks__/**/*.mjs',
+        ],
+        plugins: ['jest'],
+        env: {
+          jest: true,
+        },
+      },
+    ],
+  },
+  overrides: {
+    lodash: '4.18.1',
+  },
+};
+
+const nodeYarnPackage = {
+  ...nodeNpmPackage,
+  scripts: nodeYarnScripts,
+  overrides: undefined,
+  resolutions: nodeNpmPackage.overrides,
+};
+
+const nodeTsNpmPackage = {
+  ...nodeNpmPackage,
+  devDependencies: nodeTsDevDependencies,
+  scripts: nodeTsScripts,
+  jest: {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    ...nodeNpmPackage.jest,
+  },
+};
+
+const nodeTsYarnPackage = {
+  ...nodeTsNpmPackage,
+  scripts: nodeTsYarnScripts,
+  overrides: undefined,
+  resolutions: nodeNpmPackage.overrides,
+};
+
+const extendWithTsConfig = (packageJson, version) => {
+  packageJson.devDependencies = {
+    // New @tsconfig/nodeX package versioning: it starts with X major version
+    [`@tsconfig/node${version}`]: `^${version}`,
+    ...packageJson.devDependencies,
+  };
+
+  return packageJson;
+};
+
+const defaults = {
+  javascript: {
+    yarn: {
+      ui: (runtime, opts) => applyUiExtension(uiPackage, opts?.extensions),
+      task: () => nodeYarnPackage,
+      scheduler: () => nodeYarnPackage,
+      stream: () => nodeYarnPackage,
+    },
+    npm: {
+      ui: (runtime, opts) => applyUiExtension(uiPackage, opts?.extensions),
+      task: () => nodeNpmPackage,
+      scheduler: () => nodeNpmPackage,
+      stream: () => nodeNpmPackage,
+    },
+  },
+  typescript: {
+    yarn: {
+      ui: (runtime, opts) => applyUiExtension(tsUiPackage, opts?.extensions),
+      task: ({ version }) => extendWithTsConfig(nodeTsYarnPackage, version),
+      scheduler: ({ version }) => extendWithTsConfig(nodeTsYarnPackage, version),
+      stream: ({ version }) => extendWithTsConfig(nodeTsYarnPackage, version),
+    },
+    npm: {
+      ui: (runtime, opts) => applyUiExtension(tsUiPackage, opts?.extensions),
+      task: ({ version }) => extendWithTsConfig(nodeTsNpmPackage, version),
+      scheduler: ({ version }) => extendWithTsConfig(nodeTsNpmPackage, version),
+      stream: ({ version }) => extendWithTsConfig(nodeTsNpmPackage, version),
+    },
+  },
+};
+
+export const getDefaultsForPackageJson = (manifest, runtime, opts) => {
+  return defaults[runtime.language][runtime.packageManager][manifest.type](runtime, opts);
+};

package/lib/flow.js

@@ -0,0 +1,59 @@
+import chalk from 'chalk';
+import { resolve, sep } from 'node:path';
+import { SUCCESS_ICON } from './constants/messages.js';
+import { logger } from './helpers/logger.js';
+
+import debugFn from 'debug';
+
+const debug = debugFn('cca:flow');
+
+export const runFlow = async (flow, context, indent = '') => {
+  logger.write(
+    `${indent}Running ${chalk.cyan(flow.name)} in ${chalk.cyan(resolve(context.dirName).split(sep).pop())}\n`,
+  );
+
+  context.progress = () => logger.write('.');
+
+  try {
+    const result = await runSteps(flow.steps, context, indent + '  ');
+
+    logger.write(`${indent}Done!` + SUCCESS_ICON + '\n');
+
+    return result;
+  } catch (error) {
+    logger.write(`\n`);
+
+    throw error;
+  }
+};
+
+const runSteps = async (steps = [], context = {}, indent = '') => {
+  for (const step of steps) {
+    if (typeof step.skip === 'function' && step.skip(context)) {
+      debug('Skipping %s', step.name || step.message);
+
+      continue;
+    }
+
+    if (step.name) {
+      const result = await runFlow(step, context, indent);
+
+      Object.assign(context, result);
+
+      continue;
+    }
+
+    const message = indent + step.message;
+
+    logger.write(message);
+    debug('Context: %o', context);
+
+    const result = await step.fn(context);
+
+    Object.assign(context, result);
+
+    logger.write(SUCCESS_ICON + '\n');
+  }
+
+  return context;
+};

package/lib/flows/attach.js

@@ -0,0 +1,8 @@
+import { PREPARE_FLOW } from './prepare.js';
+import { SETUP_API_CLIENT_STEP } from './steps/release/get-config.js';
+import { ATTACH_STEPS } from './steps/attach/index.js';
+
+export const ATTACH_FLOW = {
+  name: 'attach',
+  steps: [PREPARE_FLOW, SETUP_API_CLIENT_STEP, ...ATTACH_STEPS],
+};