@corva/create-app 0.0.0-ce43383 → 0.0.0-e3730ad

package/templates/ui/javascript/AGENTS.md

@@ -0,0 +1,304 @@
+# AGENTS.md
+
+Corva.AI platform UI app — a React dashboard widget scaffolded by `create-corva-app`.
+Deployed to the Corva platform via `yarn release`.
+
+## Critical Rules
+
+These constraints are enforced by the platform. Violating them breaks the build or runtime.
+
+1. **Root export** — `src/index.js` MUST default-export `{ component: App, settings: AppSettings }`. The component may also be a `ParentApp` wrapper (e.g., `{ component: ParentApp, settings: AppSettings }`) that wraps `App` with Context.Providers and prop initialization. This is the platform loader contract.
+2. **UI components** — Use only `@corva/ui` components. Import from `@corva/ui/componentsV2`; fall back to `@corva/ui/components` only when a V2 version doesn't exist yet. `@material-ui/core` v4 is available as the underlying library.
+3. **HTTP clients** — Use `corvaDataAPI` / `corvaAPI` from `@corva/ui/clients` for all network requests.
+4. **Do not rename or delete** `App.js`, `AppSettings.js`, or `index.js` — they are platform entry points.
+
+## Project Structure
+
+```
+src/
+  App.js               — Main app component (default export required)
+  AppSettings.js       — Settings panel component (default export required)
+  index.js             — Root export: { component, settings }
+  constants.js         — Default settings values
+  App.scss              — Component styles
+  __tests__/           — Jest test files
+  __mocks__/           — Mock data (mockAppProps.js, mockAppSettingsProps.js)
+  assets/              — Static assets (SVGs, images)
+config/jest/           — Jest setup (setupTests, transforms)
+config-overrides.js    — Webpack 5 customization
+manifest.json          — Corva platform app metadata (generated at scaffold time)
+```
+
+## Key Patterns
+
+### Component Structure
+
+- Use JSDoc `@param` / `@returns` annotations for prop documentation.
+- Use `useAppCommons()` from `@corva/ui/effects` for app context (`appKey`).
+
+### Styling
+
+The preferred way to write styles is SCSS (`.scss` files).
+
+Every `.scss` file must import the shared utilities:
+
+```scss
+@import '@corva/ui/styles/common';
+```
+
+This provides all functions, variables, and mixins below.
+
+For custom shared variables or mixins specific to the project, create a `src/styles/` directory (e.g. `_variables.scss`, `_common.scss`) and import them alongside the `@corva/ui` import.
+
+**`spacing($top, $right?, $bottom?, $left?)`** — 8px base unit:
+
+```scss
+padding: spacing(2); // 16px
+margin: spacing(1, 0); // 8px 0
+gap: spacing(0.5); // 4px
+padding: spacing(2, 1, 2, 1); // 16px 8px 16px 8px
+```
+
+**`colorAlpha($color, $opacity)`** — transparency:
+
+```scss
+background: colorAlpha($palette_t1, 0.08); // white at 8% opacity
+border: 1px solid colorAlpha($palette_t1, 0.12);
+```
+
+**`transition($properties...)`** — standard `cubic-bezier(0.4, 0, 0.2, 1) 0.15s`:
+
+```scss
+transition: transition(opacity);
+transition: transition(color, background-color);
+```
+
+**Full example:**
+
+```scss
+@import '@corva/ui/styles/common';
+
+.container {
+  padding: spacing(2);
+  background: $palette_b5;
+  color: $palette_t1;
+  transition: transition(opacity, background-color);
+
+  &:hover {
+    background: colorAlpha($palette_t1, 0.08);
+  }
+}
+
+.label {
+  color: $palette_t7;
+  font-size: 12px;
+}
+```
+
+**Import in component:**
+
+```javascript
+import styles from './App.scss';
+// Use: <div className={styles.container}>
+```
+
+**Colors & Theming:**
+
+NEVER hardcode color values (hex, rgb, hsl). Always use `@corva/ui` theme colors:
+
+- In SCSS: use SCSS variables from `@corva/ui/styles/common` like `$palette_t1`, `$palette_b5`, `$palette_t7`
+- Use `colorAlpha($color, $opacity)` for transparency instead of raw `rgba()`
+- Run MCP tool `get_theme_docs` (section: "variables") to see all available theme variables
+- Run MCP tool `get_theme_docs` (section: "palette") to see available palette colors with hex values
+
+**Rules:**
+
+- No inline `style={{...}}` unless absolutely necessary for dynamic values
+- Use `classnames` for conditional/composed classes, never manual string joins
+- No global selectors (tag selectors like `div`, `span`) — use `:global()` only when absolutely necessary
+- No `!important`
+- Use a descriptive camelCase class as the root selector (e.g. `.toolbar`, `.chartPanel`) instead of generic `.root`
+
+### State Management (Zustand)
+
+The Corva platform can render multiple instances of the same app simultaneously. If a Zustand store is created at module level (singleton), all instances share the same state. To avoid this, always create store instances inside a React Context provider.
+
+**Store factory + context** — create a factory function and a context to hold the store instance:
+
+```javascript
+// store/createAppStore.js
+import { createContext } from 'react';
+import { create } from 'zustand';
+
+export const createAppStore = (initProps = {}) => {
+  return create((set, get) => ({
+    // Compose sub-stores
+    ...createSettingsStore(initProps.settings)(set, get),
+    ...createDataStore()(set, get),
+  }));
+};
+
+export const StoreContext = createContext(null);
+```
+
+**Provider** — create the store once per app mount and pass it via context:
+
+```javascript
+// StoreProvider.js
+import { useState } from 'react';
+
+import { StoreContext, createAppStore } from './store/createAppStore';
+
+export const StoreProvider = ({ children, savedSettings }) => {
+  const [appStore] = useState(() => createAppStore(savedSettings));
+
+  return <StoreContext.Provider value={appStore}>{children}</StoreContext.Provider>;
+};
+```
+
+**Consumer hooks** — read from context, never from a global store:
+
+```javascript
+// hooks/useAppStore.js
+import { useContext } from 'react';
+import { useStore } from 'zustand';
+import { useStoreWithEqualityFn } from 'zustand/traditional';
+
+import { StoreContext } from '../store/createAppStore';
+
+/** Read a single top-level key from the store. */
+export const useAppStore = key => {
+  const store = useContext(StoreContext);
+  if (!store) throw new Error('useAppStore must be used within StoreProvider');
+  return useStore(store, state => state[key]);
+};
+
+/** Subscribe to a derived value with optional custom equality. */
+export const useAppStoreSelector = (selector, equalityFn) => {
+  const store = useContext(StoreContext);
+  if (!store) throw new Error('useAppStoreSelector must be used within StoreProvider');
+  return useStoreWithEqualityFn(store, selector, equalityFn);
+};
+```
+
+**Usage in components:**
+
+```javascript
+const isLegendVisible = useAppStore('isLegendVisible');
+const selectedChannels = useAppStoreSelector(state => state.selectedChannels);
+```
+
+**Wire it up in `ParentApp`** (see full example with `QueryClientProvider` in the Data Fetching section below).
+
+General rules:
+
+- Name stores `use[Name]Store` (e.g., `useWellDataStore`)
+- Use selectors: `const value = useAppStore('value')`
+- Keep business logic in store actions
+
+### Data Fetching (React Query v4)
+
+Same as Zustand: the platform runs multiple app instances, so each must have its own `QueryClient`. Never create a `QueryClient` at module level — use a hook with `useState` to create it once per mount.
+
+**`useQueryClient` hook** — creates an isolated `QueryClient` per app instance:
+
+```javascript
+// hooks/useQueryClient.js
+import { useState } from 'react';
+import { QueryCache, QueryClient } from '@tanstack/react-query';
+import { showErrorNotification } from '@corva/ui/utils';
+
+export const useQueryClient = () => {
+  const [queryClient] = useState(
+    new QueryClient({
+      queryCache: new QueryCache({
+        onError: error => {
+          if (error?.message) {
+            showErrorNotification(`Something went wrong: ${error.message}`);
+          }
+        },
+      }),
+      defaultOptions: {
+        queries: {
+          refetchOnWindowFocus: false,
+          refetchOnReconnect: false,
+        },
+      },
+    })
+  );
+
+  return queryClient;
+};
+```
+
+**Wire it up in `ParentApp`** — wrap the app tree with `QueryClientProvider`:
+
+```javascript
+import { QueryClientProvider } from '@tanstack/react-query';
+
+const ParentApp = () => {
+  const { appSettings, onSettingsChange } = useAppCommons();
+  const queryClient = useQueryClient();
+
+  return (
+    <QueryClientProvider client={queryClient}>
+      <StoreProvider savedSettings={appSettings?.savedSettings}>
+        <App />
+      </StoreProvider>
+    </QueryClientProvider>
+  );
+};
+
+export default { component: ParentApp, settings: AppSettings };
+```
+
+General rules:
+
+- Encapsulate queries in custom hooks (e.g., `useWellData`)
+- Use typed query keys (array format)
+- Always handle `isLoading` and `isError` states
+
+## Naming Conventions
+
+- Boolean variables: prefix with `is`, `has`, or `should`
+- Non-empty array checks: `!!array.length` (not `array.length > 0`)
+
+## Testing
+
+- **Framework:** Jest + React Testing Library
+- **Wrapper:** Use `AppTestWrapper` from `@corva/ui/testing` to wrap components
+- **Mocking:** Mock network requests (jest mocks or msw), never call real APIs
+- **Timezone:** UTC is enforced (`process.env.TZ = 'UTC'`)
+- **Mocked globals:** `ResizeObserver`, `MutationObserver` (in `setupTests.js`)
+
+## Commands
+
+```
+yarn start     Dev server at http://app.local.corva.ai:8080/
+yarn build     Production bundle
+yarn test      Run tests
+yarn lint      ESLint check
+yarn zip       Create deployment ZIP
+yarn release   Release to Corva platform
+```
+
+## @corva/ui Documentation
+
+Local documentation for `@corva/ui` is bundled at `node_modules/@corva/ui/docs/`.
+Before implementing any UI component, data fetch, or API call, read the relevant doc file:
+
+- **V2 Components:** `node_modules/@corva/ui/docs/01-components-v2/` — Props, examples, usage
+- **V1 Components:** `node_modules/@corva/ui/docs/02-components-v1/` — Legacy components reference
+- **Hooks:** `node_modules/@corva/ui/docs/03-hooks/` — Parameters, return types, examples
+- **API Clients:** `node_modules/@corva/ui/docs/04-clients/` — corvaAPI, corvaDataAPI endpoints
+- **Theme:** `node_modules/@corva/ui/docs/05-theme/` — Color palette, CSS variables
+- **Utilities:** `node_modules/@corva/ui/docs/06-utilities/` — Helper functions
+- **Constants:** `node_modules/@corva/ui/docs/07-constants/` — Platform constants
+
+Start with `node_modules/@corva/ui/docs/README.md` for the full index.
+Do NOT guess `@corva/ui` APIs — read the local docs first.
+
+## MCP Server (Interactive Fallback)
+
+The `corva-ui` MCP server is pre-configured (`.mcp.json`, `.cursor/mcp.json`, `.codex/config.toml`).
+Use it for interactive queries when the local docs are insufficient or you need to search across components.

package/templates/ui/javascript/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

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

@@ -4,23 +4,12 @@ import { useAppCommons } from '@corva/ui/effects';
 import { DEFAULT_SETTINGS } from './constants';
 import logo from './assets/logo.svg';
 
-import styles from './App.css';
+import styles from './App.scss';
 
-/**
- * @param {Object} props
- * @param {boolean} props.isExampleCheckboxChecked
- * @param {Object} props.fracFleet
- * @param {Object} props.well
- * @param {Object[]} props.wells
- * @returns
- */
-function App({
-  isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChecked,
-  fracFleet,
-  well,
-  wells,
-}) {
-  const { appKey } = useAppCommons();
+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];
@@ -56,7 +45,7 @@ function App({
       </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;

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

@@ -4,17 +4,13 @@ import { useAppCommons } from '@corva/ui/effects';
 import { DEFAULT_SETTINGS } from './constants';
 import logo from './assets/logo.svg';
 
-import styles from './App.css';
+import styles from './App.scss';
+
+const App = () => {
+  const { appKey, rig, well, appSettings } = useAppCommons();
+  const { isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChecked } =
+    appSettings || {};
 
-/**
- * @param {Object} props
- * @param {boolean} props.isExampleCheckboxChecked
- * @param {Object} props.rig
- * @param {Object} props.well
- * @returns
- */
-function App({ isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChecked, rig, well }) {
-  const { appKey } = useAppCommons();
   return (
     <AppContainer header={<AppHeader />} testId={appKey}>
       <div className={styles.container}>
@@ -46,7 +42,7 @@ function App({ isExampleCheckboxChecked = DEFAULT_SETTINGS.isExampleCheckboxChec
       </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;

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

@@ -1,26 +1,12 @@
 import { Checkbox, FormControlLabel } from '@material-ui/core';
+import { useAppCommons } from '@corva/ui/effects';
 
 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 };
+const AppSettings = () => {
+  const { appSettings, onSettingChange } = useAppCommons();
+  const settings = { ...DEFAULT_SETTINGS, ...appSettings };
+
   return (
     <div>
       <FormControlLabel
@@ -35,7 +21,7 @@ function AppSettings({
       />
     </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;

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

@@ -2,21 +2,12 @@ import { render, screen } from '@testing-library/react';
 import { AppTestWrapper } from '@corva/ui/testing';
 
 import App from '../App';
-import { mockAppProps } from '../__mocks__/mockAppProps';
 
 describe('<App />', () => {
   it('should show correct layout', () => {
     render(
-      <AppTestWrapper
-        app={mockAppProps.app}
-        appId={123}
-        maximized={false}
-        appSettings={mockAppProps.app.settings}
-        onSettingChange={() => {
-          /* noop */
-        }}
-      >
-        <App {...mockAppProps} />
+      <AppTestWrapper appSettings={{ isExampleCheckboxChecked: true }}>
+        <App />
       </AppTestWrapper>
     );
 
@@ -24,20 +15,9 @@ describe('<App />', () => {
   });
 
   it('should show correct layout when settings are not provided', () => {
-    const propsWithoutSettings = mockAppProps;
-    delete propsWithoutSettings.isExampleCheckboxChecked;
-
     render(
-      <AppTestWrapper
-        app={mockAppProps.app}
-        appId={123}
-        maximized={false}
-        appSettings={mockAppProps.app.settings}
-        onSettingChange={() => {
-          /* noop */
-        }}
-      >
-        <App {...propsWithoutSettings} />
+      <AppTestWrapper appSettings={{}}>
+        <App />
       </AppTestWrapper>
     );
 

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

@@ -1,21 +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';
-import { mockAppSettingsProps } from '../__mocks__/mockAppSettingsProps';
 
 describe('<AppSettings />', () => {
   it('should call onChange with a changed setting on settings change', async () => {
-    const handleSettingsChange = jest.fn();
+    const handleSettingChange = jest.fn();
 
-    render(<AppSettings {...mockAppSettingsProps} onSettingChange={handleSettingsChange} />);
+    render(
+      <AppTestWrapper
+        appSettings={{ isExampleCheckboxChecked: true }}
+        onSettingChange={handleSettingChange}
+      >
+        <AppSettings />
+      </AppTestWrapper>
+    );
 
-    const exampleCheckbox = screen.getByTestId('exampleCheckbox').querySelector('input');
+    const exampleCheckbox = screen.getByRole('checkbox', { name: /example/i });
 
     await act(async () => {
       await userEvent.click(exampleCheckbox);
     });
 
-    expect(handleSettingsChange).toBeCalledWith('isExampleCheckboxChecked', false);
+    expect(handleSettingChange).toBeCalledWith('isExampleCheckboxChecked', false);
   });
 });

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

@@ -1,6 +1,6 @@
 import { useState } from 'react';
 import { render, screen, waitFor } from '@testing-library/react';
-import { components } from '@corva/ui';
+import { Button } from '@corva/ui/componentsV2';
 import userEvent from '@testing-library/user-event';
 
 const Toggle = () => {
@@ -9,7 +9,7 @@ const Toggle = () => {
   return (
     <>
       {isOn ? 'ON' : 'OFF'}
-      <components.Button onClick={() => setIsOn(value => !value)}>toggle</components.Button>
+      <Button onClick={() => setIsOn(value => !value)}>toggle</Button>
     </>
   );
 };

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

@@ -1,3 +1,4 @@
+// DO NOT modify this structure
 import App from './App';
 import AppSettings from './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/.mcp.json

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