@corva/create-app 0.0.0-2576df8

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,30 @@
+/* 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';
+
+// Mock ResizeObserver & MutationObserver
+class FakeObserver {
+  observe() {}
+  unobserve() {}
+  disconnect() {}
+}
+
+global.ResizeObserver = FakeObserver;
+global.MutationObserver = FakeObserver;
+
+// Suppressing "Could not parse CSS stylesheet" from JSDOM
+const originalConsoleError = global.console.error;
+global.console.error = (message, ...optionalParams) => {
+  if (message.includes('Could not parse CSS stylesheet')) {
+    return;
+  }
+  originalConsoleError(message, ...optionalParams);
+};

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,52 @@
+import { AppContainer, AppHeader } from '@corva/ui/componentsV2';
+import { useAppCommons } from '@corva/ui/effects';
+
+import { DEFAULT_SETTINGS } from './constants';
+import logo from './assets/logo.svg';
+
+import styles from './App.scss';
+
+const App = () => {
+  const { appKey, fracFleet, well, wells, appSettings } = useAppCommons();
+  const { isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChecked } =
+    appSettings || {};
+  // NOTE: On general type dashboard app receives wells array
+  // on asset type dashboard app receives well object
+  const wellsList = wells || [well];
+
+  return (
+    <AppContainer header={<AppHeader />} testId={appKey}>
+      <div className={styles.container}>
+        <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: <span data-testid="fracFleet">{fracFleet?.name || 'No Frac Fleet'}</span>
+          <br />
+          Wells: <span data-testid="wellsList">{wellsList.map(well => well?.name).join(', ')}</span>
+        </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{' '}
+        <span data-testid="exampleCheckboxChecked">
+          {isExampleCheckboxChecked ? 'checked' : 'unchecked'}
+        </span>
+      </div>
+    </AppContainer>
+  );
+};
+
+// 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.drilling.js

@@ -0,0 +1,49 @@
+import { AppContainer, AppHeader } from '@corva/ui/componentsV2';
+import { useAppCommons } from '@corva/ui/effects';
+
+import { DEFAULT_SETTINGS } from './constants';
+import logo from './assets/logo.svg';
+
+import styles from './App.scss';
+
+const App = () => {
+  const { appKey, rig, well, appSettings } = useAppCommons();
+  const { isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChecked } =
+    appSettings || {};
+
+  return (
+    <AppContainer header={<AppHeader />} testId={appKey}>
+      <div className={styles.container}>
+        <img src={logo} alt="logo" className={styles.logo} />
+        <p>
+          Edit <code>src/App.js</code> and save to reload.
+          <br />
+          <br />
+        </p>
+        <p>
+          Rig: <span data-testid="rig">{rig?.name}</span>
+          <br />
+          Well: <span data-testid="well">{well?.name}</span>
+        </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{' '}
+        <span data-testid="exampleCheckboxState">
+          {isExampleCheckboxChecked ? 'checked' : 'unchecked'}
+        </span>
+      </div>
+    </AppContainer>
+  );
+};
+
+// 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.scss

@@ -0,0 +1,17 @@
+.container {
+  text-align: center;
+}
+
+@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/AppSettings.js

@@ -0,0 +1,28 @@
+import { Checkbox, FormControlLabel } from '@material-ui/core';
+import { useAppCommons } from '@corva/ui/effects';
+
+import { DEFAULT_SETTINGS } from './constants';
+
+const AppSettings = () => {
+  const { appSettings, onSettingChange } = useAppCommons();
+  const settings = { ...DEFAULT_SETTINGS, ...appSettings };
+
+  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;

package/templates/ui/javascript/src/__tests__/App.test.js

@@ -0,0 +1,26 @@
+import { render, screen } from '@testing-library/react';
+import { AppTestWrapper } from '@corva/ui/testing';
+
+import App from '../App';
+
+describe('<App />', () => {
+  it('should show correct layout', () => {
+    render(
+      <AppTestWrapper appSettings={{ isExampleCheckboxChecked: true }}>
+        <App />
+      </AppTestWrapper>
+    );
+
+    screen.getByText(/checked/i);
+  });
+
+  it('should show correct layout when settings are not provided', () => {
+    render(
+      <AppTestWrapper appSettings={{}}>
+        <App />
+      </AppTestWrapper>
+    );
+
+    screen.getByText(/unchecked/i);
+  });
+});

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

@@ -0,0 +1,28 @@
+import { render, screen, act } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { AppTestWrapper } from '@corva/ui/testing';
+
+import AppSettings from '../AppSettings';
+
+describe('<AppSettings />', () => {
+  it('should call onChange with a changed setting on settings change', async () => {
+    const handleSettingChange = jest.fn();
+
+    render(
+      <AppTestWrapper
+        appSettings={{ isExampleCheckboxChecked: true }}
+        onSettingChange={handleSettingChange}
+      >
+        <AppSettings />
+      </AppTestWrapper>
+    );
+
+    const exampleCheckbox = screen.getByRole('checkbox', { name: /example/i });
+
+    await act(async () => {
+      await userEvent.click(exampleCheckbox);
+    });
+
+    expect(handleSettingChange).toBeCalledWith('isExampleCheckboxChecked', false);
+  });
+});

package/templates/ui/javascript/src/__tests__/TestsExample.test.js

@@ -0,0 +1,37 @@
+import { useState } from 'react';
+import { render, screen, waitFor } from '@testing-library/react';
+import { Button } from '@corva/ui/componentsV2';
+import userEvent from '@testing-library/user-event';
+
+const Toggle = () => {
+  const [isOn, setIsOn] = useState(false);
+
+  return (
+    <>
+      {isOn ? 'ON' : 'OFF'}
+      <Button onClick={() => setIsOn(value => !value)}>toggle</Button>
+    </>
+  );
+};
+
+describe('Tests examples', () => {
+  it('should use UTC timezone by default to not depend on the environment timezone', () => {
+    expect(Intl.DateTimeFormat().resolvedOptions().timeZone).toBe('UTC');
+  });
+
+  describe('<Toggle />', () => {
+    it('should be OFF by default', () => {
+      render(<Toggle />);
+
+      expect(screen.getByText('OFF')).toBeInTheDocument();
+    });
+
+    it('should switch to ON after a single press', async () => {
+      render(<Toggle />);
+
+      userEvent.click(screen.getByText('toggle'));
+
+      await waitFor(() => screen.getByText('ON'));
+    });
+  });
+});

package/templates/ui/javascript/src/assets/logo.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
+    <g fill="#61DAFB">
+        <path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/>
+        <circle cx="420.9" cy="296.5" r="45.7"/>
+        <path d="M520.5 78.1z"/>
+    </g>
+</svg>

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

@@ -0,0 +1,3 @@
+export const DEFAULT_SETTINGS = {
+  isExampleCheckboxChecked: false,
+};

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

@@ -0,0 +1,8 @@
+// DO NOT modify this structure
+import App from './App';
+import AppSettings from './AppSettings';
+
+export default {
+  component: App,
+  settings: AppSettings,
+};

package/templates/ui/typescript/.codex/config.toml

@@ -0,0 +1,3 @@
+[mcp_servers.corva-ui]
+command = "npx"
+args = ["-p", "@corva/ui", "corva-ui-mcp"]

package/templates/ui/typescript/.cursor/mcp.json

@@ -0,0 +1,8 @@
+{
+  "mcpServers": {
+    "corva-ui": {
+      "command": "npx",
+      "args": ["-p", "@corva/ui", "corva-ui-mcp"]
+    }
+  }
+}

package/templates/ui/typescript/.eslintrc

@@ -0,0 +1,28 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "ecmaFeature": {
+      "jsx": true
+    }
+  },
+  "extends": ["@corva/eslint-config-browser"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "extends": ["@corva/eslint-config-browser", "plugin:@typescript-eslint/recommended"],
+      "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx", ".ts", ".tsx"] }],
+        /* Turned off until adopted by @corva/eslint-config-browser */
+        "react/prop-types": 0,
+        "react/default-props-match-prop-types": 0,
+        "react/no-unused-prop-types": 0,
+        "react/require-default-props": 0
+        /* Turned off until adopted by @corva/eslint-config-browser */
+      }
+    }
+  ]
+}

package/templates/ui/typescript/.mcp.json

@@ -0,0 +1,8 @@
+{
+  "mcpServers": {
+    "corva-ui": {
+      "command": "npx",
+      "args": ["-p", "@corva/ui", "corva-ui-mcp"]
+    }
+  }
+}

package/templates/ui/typescript/.prettierrc

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