@corva/create-app 0.0.0-73c49372

package/templates/stream_time/python/test/app_test.py

@@ -0,0 +1,16 @@
+from corva import StreamTimeEvent, StreamTimeRecord
+from lambda_function import lambda_handler
+
+
+def test_app(app_runner):
+    event = StreamTimeEvent(
+        company_id=1,
+        asset_id=1234,
+        records=[
+            StreamTimeRecord(
+                data={'bit_depth': 4980, 'hole_depth': 5000}, timestamp=1620905165
+            )
+        ],
+    )
+
+    app_runner(lambda_handler, event=event)

package/templates/stream_time/typescript/README.md

@@ -0,0 +1,25 @@
+# Dev Center Node.js TypeScript Real-Time Stream Data App
+
+## Getting started
+
+### 1. Install Dependencies
+
+```
+npm install
+```
+
+### 2. Run Tests
+
+```
+npm test
+```
+
+### 3. Build
+
+```
+npm run build
+```
+
+### 4. Deploy
+
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/templates/stream_time/typescript/__tests__/processor.spec.ts

@@ -0,0 +1,14 @@
+import { app_runner } from '@corva/node-sdk/lib/testing';
+import { StreamTimeEvent, StreamTimeRecord } from '@corva/node-sdk';
+
+import { processor } from '..';
+
+test('processes event', async () => {
+  const event = new StreamTimeEvent({
+    company_id: 1,
+    asset_id: 1234,
+    records: [new StreamTimeRecord({ data: { bit_depth: 4980, hole_depth: 5000 }, timestamp: 1620905165 })],
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});

package/templates/stream_time/typescript/index.ts

@@ -0,0 +1,8 @@
+import { Corva, StatefulContext, StreamTimeEvent } from '@corva/node-sdk';
+
+export const processor = async (event: StreamTimeEvent, context: StatefulContext) => {
+  // Insert your logic here
+  context.logger.info('Hello, World!');
+};
+
+export const handler = new Corva().stream(processor);

package/templates/task/javascript/README.md

@@ -0,0 +1,19 @@
+# Dev Center Node.js Task Data App
+
+## Getting started
+
+### 1. Install Dependencies
+
+```
+npm install
+```
+
+### 2. Run Tests
+
+```
+npm test
+```
+
+### 3. Deploy
+
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/templates/task/javascript/__tests__/processor.spec.js

@@ -0,0 +1,16 @@
+const { TaskEvent } = require('@corva/node-sdk');
+const { app_runner } = require('@corva/node-sdk/lib/testing');
+
+const { processor } = require('..');
+
+test('processes event', async () => {
+  const event = new TaskEvent({
+    company_id: 1,
+    asset_id: 1234,
+    properties: {
+      foo: 'bar',
+    },
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});

package/templates/task/javascript/index.js

@@ -0,0 +1,15 @@
+const { Corva } = require('@corva/node-sdk');
+
+/**
+ *
+ * @param {import('@corva/node-sdk').TaskEvent} event
+ * @param {import('@corva/node-sdk').StatelessContext} context
+ */
+const processor = async (event, context) => {
+  // Insert your logic here
+  context.logger.info('Hello, World!');
+};
+
+exports.processor = processor;
+
+exports.handler = new Corva().task(processor);

package/templates/task/python/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/templates/task/python/lambda_function.py

@@ -0,0 +1,7 @@
+from corva import Api, Logger, TaskEvent, task
+
+
+@task
+def lambda_handler(event: TaskEvent, api: Api):
+    """Insert your logic here"""
+    Logger.info('Hello, World!')

package/templates/task/python/test/app_test.py

@@ -0,0 +1,8 @@
+from corva import TaskEvent
+from lambda_function import lambda_handler
+
+
+def test_app(app_runner):
+    event = TaskEvent(company_id=1, asset_id=1234, properties={'foo': "bar"})
+
+    app_runner(lambda_handler, event=event)

package/templates/task/typescript/README.md

@@ -0,0 +1,25 @@
+# Dev Center Node.js Task Data App
+
+## Getting started
+
+### 1. Install Dependencies
+
+```
+npm install
+```
+
+### 2. Run Tests
+
+```
+npm test
+```
+
+### 3. Build
+
+```
+npm run build
+```
+
+### 4. Deploy
+
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/templates/task/typescript/__tests__/processor.spec.ts

@@ -0,0 +1,16 @@
+import { app_runner } from '@corva/node-sdk/lib/testing';
+import { TaskEvent } from '@corva/node-sdk';
+
+import { processor } from '..';
+
+test('processes event', async () => {
+  const event = new TaskEvent({
+    company_id: 1,
+    asset_id: 1234,
+    properties: {
+      foo: 'bar',
+    },
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});

package/templates/task/typescript/index.ts

@@ -0,0 +1,8 @@
+import { Corva, StatelessContext, TaskEvent } from '@corva/node-sdk';
+
+export const processor = async (event: TaskEvent, context: StatelessContext) => {
+  // Insert your logic here
+  context.logger.info('Hello, World!');
+};
+
+export const handler = new Corva().task(processor);

package/templates/ui/javascript/.eslintrc

@@ -0,0 +1,11 @@
+{
+  "root": true,
+  "extends": "@corva/eslint-config-browser",
+  "parserOptions": {
+    "requireConfigFile": false,
+    "babelOptions": {
+      "presets": ["@babel/preset-react"],
+      "plugins": ["@babel/plugin-proposal-class-properties"]
+    }
+  }
+}

package/templates/ui/javascript/.prettierrc

@@ -0,0 +1 @@
+"@corva/eslint-config-browser/prettier"

package/templates/ui/javascript/README.md

@@ -0,0 +1,31 @@
+# Getting Started with Create Corva App
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.\
+Open [http://app.local.corva.ai:8080](http://app.local.corva.ai:8080/) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `yarn build`
+
+Bundles the app into static files for production.
+
+### `yarn zip`
+
+Bundles the app into ZIP file in app root directory
+
+### `yarn release`
+
+Releases the app into Corva
+
+## Documentation
+
+- [Dev Center documentation](https://dc-docs.corva.ai/) – information about development process
+- [Component Library](https://dc-docs.corva.ai/docs/Frontend/Data%20visualization/Components%20library)
+- [Datasets documentation](https://dc-docs.corva.ai/docs/Datasets/Link%20App%20to%20Dataset)

package/templates/ui/javascript/config/jest/babelTransform.js

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+const babelJest = require('babel-jest').default;
+
+module.exports = babelJest.createTransformer({
+  presets: [
+    [
+      require.resolve('babel-preset-react-app'),
+      {
+        runtime: 'automatic',
+      },
+    ],
+  ],
+  babelrc: false,
+  configFile: false,
+});

package/templates/ui/javascript/config/jest/cssTransform.js

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+// This is a custom Jest transformer turning style imports into empty objects.
+// http://facebook.github.io/jest/docs/en/webpack.html
+
+module.exports = {
+  process() {
+    return {
+      code: 'module.exports = {};',
+    };
+  },
+  getCacheKey() {
+    // The output is always the same.
+    return 'cssTransform';
+  },
+};

package/templates/ui/javascript/config/jest/fileTransform.js

@@ -0,0 +1,48 @@
+/* eslint-disable */
+
+const path = require('path');
+
+// This is a custom Jest transformer turning file imports into filenames.
+// http://facebook.github.io/jest/docs/en/webpack.html
+
+const toPascalCase = str => {
+  const allWordsIterator = str.matchAll(/\w+/g);
+
+  return Array.from(allWordsIterator).reduce((acc, matchResult) => {
+    const word = matchResult[0];
+    return acc + word[0].toUpperCase() + word.slice(1).toLowerCase();
+  }, '');
+};
+
+module.exports = {
+  process(src, filename) {
+    const assetFilename = JSON.stringify(path.basename(filename));
+
+    if (filename.match(/\.svg$/)) {
+      // Based on how SVGR generates a component name:
+      // https://github.com/smooth-code/svgr/blob/01b194cf967347d43d4cbe6b434404731b87cf27/packages/core/src/state.js#L6
+      const pascalCaseFilename = toPascalCase(path.parse(filename).name);
+      const componentName = `Svg${pascalCaseFilename}`;
+      return {
+        code: `const React = require('react');
+        module.exports = {
+          __esModule: true,
+          default: ${assetFilename},
+          ReactComponent: React.forwardRef(function ${componentName}(props, ref) {
+            return {
+              $$typeof: Symbol.for('react.element'),
+              type: 'svg',
+              ref: ref,
+              key: null,
+              props: Object.assign({}, props, {
+                children: ${assetFilename}
+              })
+            };
+          }),
+        };`,
+      };
+    }
+
+    return { code: `module.exports = ${assetFilename};` };
+  },
+};

package/templates/ui/javascript/config/jest/globalSetup.js

@@ -0,0 +1,5 @@
+module.exports = async () => {
+  // use UTC timezone to not break tests when you run them on
+  // an environemnt with a different timezone
+  process.env.TZ = 'UTC';
+};

package/templates/ui/javascript/config/jest/setupTests.js

@@ -0,0 +1,11 @@
+/* eslint-disable */
+
+// jest-dom adds custom jest matchers for asserting on DOM nodes.
+// allows you to do things like:
+// expect(element).toHaveTextContent(/react/i)
+// learn more: https://github.com/testing-library/jest-dom
+// eslint-disable-next-line
+import '@testing-library/jest-dom/extend-expect';
+
+// Set UTC timezone for tests to not use the environment timezone
+process.env.TZ = 'UTC';

package/templates/ui/javascript/config-overrides.js

@@ -0,0 +1,10 @@
+const { getWebpackConfig } = require('@corva/dc-platform-shared/cjs');
+const { merge } = require('webpack-merge');
+
+module.exports = (env, argv) => {
+  return merge(
+    getWebpackConfig(env, argv),
+    // NOTE: Custom webpack 5 plugins and module rules can be provided here
+    {}
+  );
+};

package/templates/ui/javascript/gitignore

@@ -0,0 +1,27 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+/dist
+
+# misc
+.env
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+.idea
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.eslintcache

package/templates/ui/javascript/src/App.completion.js

@@ -0,0 +1,64 @@
+import { AppHeader } from '@corva/ui/components';
+
+import { DEFAULT_SETTINGS } from './constants';
+import logo from './assets/logo.svg';
+
+import styles from './App.css';
+
+/**
+ * @param {Object} props
+ * @param {boolean} props.isExampleCheckboxChecked
+ * @param {Object} props.appHeaderProps
+ * @param {Object} props.fracFleet
+ * @param {Object} props.well
+ * @param {Object[]} props.wells
+ * @returns
+ */
+function App({
+  appHeaderProps,
+  isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChecked,
+  fracFleet,
+  well,
+  wells,
+}) {
+  // NOTE: On general type dashboard app receives wells array
+  // on asset type dashboard app receives well object
+  const wellsList = wells || [well];
+
+  return (
+    <div className={styles.container}>
+      <AppHeader {...appHeaderProps} />
+      <div className={styles.content}>
+        <div>
+          <img src={logo} alt="logo" className={styles.logo} />
+          <p>
+            Edit <code>src/App.js</code> and save to reload.
+            <br />
+            <br />
+          </p>
+          <p>
+            Frac Fleet: {fracFleet?.name || 'No Frac Fleet'}
+            <br />
+            Wells: {wellsList.map(well => well.name).join(', ')}
+          </p>
+          <a
+            className="App-link"
+            href="https://reactjs.org"
+            target="_blank"
+            rel="noopener noreferrer"
+          >
+            Learn React
+          </a>
+        </div>
+        <div>
+          Settings &quot;Example&quot; checkbox is{' '}
+          {isExampleCheckboxChecked ? 'checked' : 'unchecked'}
+        </div>
+      </div>
+    </div>
+  );
+}
+
+// Important: Do not change root component default export (App.js). Use it as container
+//  for your App. It's required to make build and zip scripts work as expected;
+export default App;

package/templates/ui/javascript/src/App.css

@@ -0,0 +1,30 @@
+.container {
+  display: flex;
+  flex-direction: column;
+  height: 100%;
+  padding: 12px 12px 30px 12px;
+}
+
+.content {
+  display: flex;
+  flex-direction: column;
+  text-align: center;
+  align-items: center;
+  justify-content: center;
+  flex-grow: 1;
+  overflow: auto;
+}
+
+@keyframes App-logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(-360deg);
+  }
+}
+
+.logo {
+  animation: App-logo-spin infinite 20s linear;
+  height: 50px;
+}

package/templates/ui/javascript/src/App.drilling.js

@@ -0,0 +1,58 @@
+import { AppHeader } from '@corva/ui/components';
+
+import { DEFAULT_SETTINGS } from './constants';
+import logo from './assets/logo.svg';
+
+import styles from './App.css';
+
+/**
+ * @param {Object} props
+ * @param {Object} props.appHeaderProps
+ * @param {boolean} props.isExampleCheckboxChecked
+ * @param {Object} props.rig
+ * @param {Object} props.well
+ * @returns
+ */
+function App({
+  appHeaderProps,
+  isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChecked,
+  rig,
+  well,
+}) {
+  return (
+    <div className={styles.container}>
+      <AppHeader {...appHeaderProps} />
+      <div className={styles.content}>
+        <div>
+          <img src={logo} alt="logo" className={styles.logo} />
+          <p>
+            Edit <code>src/App.js</code> and save to reload.
+            <br />
+            <br />
+          </p>
+          <p>
+            Rig: {rig.name}
+            <br />
+            Well: {well.name}
+          </p>
+          <a
+            className="App-link"
+            href="https://reactjs.org"
+            target="_blank"
+            rel="noopener noreferrer"
+          >
+            Learn React
+          </a>
+        </div>
+        <div>
+          Settings &quot;Example&quot; checkbox is{' '}
+          {isExampleCheckboxChecked ? 'checked' : 'unchecked'}
+        </div>
+      </div>
+    </div>
+  );
+}
+
+// Important: Do not change root component default export (App.js). Use it as container
+//  for your App. It's required to make build and zip scripts work as expected;
+export default App;

package/templates/ui/javascript/src/AppSettings.js

@@ -0,0 +1,42 @@
+import { Checkbox, FormControlLabel } from '@material-ui/core';
+
+import { DEFAULT_SETTINGS } from './constants';
+
+/**
+ * @param {Object} props
+ * @param {Object} props.app
+ * @param {Object} props.appData
+ * @param {Object} props.company
+ * @param {(key: string, value: any) => void} props.onSettingChange
+ * @param {{isExampleCheckboxChecked: boolean}} props.settings
+ * @param {Object} props.user
+ * @returns
+ */
+function AppSettings({
+  settings: apiSettings,
+  onSettingChange,
+  // appData,
+  // app,
+  // user = {},
+  // company = {},
+}) {
+  const settings = { ...DEFAULT_SETTINGS, ...apiSettings };
+  return (
+    <div>
+      <FormControlLabel
+        label="Example checkbox"
+        control={
+          <Checkbox
+            data-testid="exampleCheckbox"
+            checked={settings.isExampleCheckboxChecked}
+            onChange={e => onSettingChange('isExampleCheckboxChecked', e.target.checked)}
+          />
+        }
+      />
+    </div>
+  );
+}
+
+// Important: Do not change root component default export (AppSettings.js). Use it as container
+//  for your App Settings. It's required to make build and zip scripts work as expected;
+export default AppSettings;