@corva/create-app 0.0.0-73c49372

package/templates/ui/typescript/src/__mocks__/mockAppSettingsProps.ts

@@ -0,0 +1,290 @@
+/**
+ * This is a real example of the props that'll come
+ * to the AppSettings component. You'll need to manually update it
+ * if in the future some new properties are added
+ */
+
+export const mockAppSettingsProps = {
+  onSettingChange: jest.fn(),
+  onSettingsChange: jest.fn(),
+  app: {
+    id: -1,
+    app: {
+      app_key: 'company.app_key.ui',
+      platform: 'dev_center',
+    },
+    settings: {
+      package: '0.1.0',
+      rigId: 1,
+      wellId: 2,
+      isExampleCheckboxChecked: true,
+    },
+    package: {
+      manifest: {
+        format: 1,
+        license: {
+          type: 'MIT',
+          url: 'https://www.oandgexample.com/license/',
+        },
+        developer: {
+          name: 'Company Name',
+          identifier: 'companyIdentifier',
+          authors: [],
+        },
+        application: {
+          type: 'ui',
+          key: 'company.app_key.ui',
+          visibility: 'private',
+          name: 'dev center app name',
+          description: 'This is the description of my app. You can do great things with it!',
+          summary: 'More information about this app goes here',
+          category: 'analytics',
+          website: 'https://www.oandgexample.com/my-app/',
+          segments: ['drilling', 'completion'],
+          ui: {
+            initial_size: {
+              w: 4,
+              h: 10,
+            },
+          },
+        },
+        settings: {
+          entrypoint: {
+            file: 'src/index.js',
+            function: 'handler',
+          },
+          environment: {},
+          runtime: 'ui',
+          app: {
+            scheduler_type: 1,
+            cron_string: '*/5 * * * *',
+          },
+        },
+        datasets: {},
+      },
+      build: 'company.app_key.ui-0.1.0',
+      version: '0.1.0',
+    },
+  },
+  appData: {
+    id: -1,
+    rig: {
+      name: 'Test Rig Name',
+      id: '1',
+      asset_id: 3,
+    },
+    well: {
+      name: 'Test Well Name',
+      settings: {
+        basin: 'Test Basin Name',
+        county: 'Pecos',
+        timezone: 'America/Chicago',
+        top_hole: {
+          raw: '50.123456,-102.865431',
+          coordinates: [50.123456, -102.865431],
+        },
+        api_number: '12-345-67689',
+        bottom_hole: {},
+        mud_company: 'Mud Company Name',
+        spud_release: [
+          {
+            id: '1111111111-2222-3a3a-4b4b-afc5c7c8f245',
+            spud: '01/08/2023 00:46',
+            rig_up: '01/08/2023 00:10',
+            release: '',
+          },
+        ],
+        string_design: '5',
+        contractor_name: 'Test Contractor Name',
+        target_formation: 'Test Traget Formation',
+        last_mongo_refresh: '2023-02-24T16:16:06.383Z',
+        rig_classification: 'land',
+        directional_driller: 'Test Directional Driller',
+        drilling_afe_number: 'AB12356',
+        day_shift_start_time: '06:00',
+        off_bottom_tolerance: 1,
+        target_formation_standard: 'Test Traget Formation',
+        completion_day_shift_start_time: '06:00',
+        associations_last_active_at_updated_at: '2023-02-24T16:15:40.000Z',
+      },
+      asset_id: 4,
+      last_active_at: '2023-02-24T16:20:29.000Z',
+      id: '2',
+      companyId: '6',
+    },
+    fracFleet: null,
+    wells: null,
+    isLoading: false,
+    appHash: '-1-2-1-NaN-NaN-NaN',
+  },
+  settings: {
+    package: '0.1.0',
+    rigId: 1,
+    wellId: 2,
+    isExampleCheckboxChecked: true,
+  },
+  layoutEnvironment: {
+    type: 'general',
+    pdfReportMode: false,
+  },
+  currentUser: {
+    id: 1,
+    company_id: 3,
+    first_name: 'John',
+    last_name: 'Doe',
+    email: 'john.doe@company.ai',
+    mobile: '',
+    created_at: '2020-11-03T08:42:53.161Z',
+    terms_acceptance_at: '2021-10-20T13:28:6.385Z',
+    profile_photo: null,
+    recently_viewed_asset_ids: [64],
+    unit_system: null,
+    role: 'user',
+    title: null,
+    group: null,
+    favorite_asset_id: null,
+    current_segment: null,
+    theme: 'dark',
+    messaging_id: '1',
+    restricted_assets: [],
+    restricted_programs: [],
+    settings: {
+      favorites: {},
+      sms_blacklisted: false,
+      restricted_assets: [],
+      restricted_programs: [],
+      participates_in_beta_apps: false,
+      last_new_dashboard_shares_check: '2021-11-24T18:57:13.679Z',
+    },
+    last_sign_in_at: '2023-02-23T10:19:06.349Z',
+    locked_access: false,
+    unit_ids: [],
+    intercom_admin_id: null,
+    resource: [],
+    intercom_user_hash: 'intercom_user_hash',
+    profile_groups: [],
+    preference: {
+      id: 6,
+      user: {
+        id: 1,
+        company_id: 3,
+        first_name: 'John',
+        last_name: 'Doe',
+        email: 'john.doe@company.ai',
+        role: 'user',
+        created_at: '2020-11-03T08:42:53.161Z',
+        updated_at: '2023-02-23T12:26:46.835Z',
+        recently_viewed_asset_ids: [64],
+        unit_system: null,
+        mobile: '',
+        terms_acceptance_at: '2021-10-20T13:28:6.385Z',
+        messaging_id: '1',
+        settings: {
+          favorites: {},
+          sms_blacklisted: false,
+          restricted_assets: [],
+          restricted_programs: [],
+          participates_in_beta_apps: false,
+          last_new_dashboard_shares_check: '2021-11-24T18:57:13.679Z',
+        },
+        theme: 'dark',
+        title: null,
+        group: null,
+        profile_photo: null,
+        favorite_asset_id: null,
+        current_segment: null,
+        state: 'active',
+        created_by: null,
+        provisioner: 'internal',
+        intercom_admin_id: null,
+        resource: [],
+      },
+      push_notifications_enabled: true,
+      emails_enabled: true,
+      sms_enabled: true,
+      alert_levels: ['info', 'warning', 'critical'],
+      play_alerts_sound: true,
+      show_intercom_icon: true,
+      segment: ['drilling', 'completion'],
+      disable_create_dashboard: false,
+      disable_costs: false,
+      disable_documents: false,
+      realtime_operation_mode: false,
+      disable_file_upload: false,
+      stay_on_app_store: false,
+    },
+    company: {
+      id: 3,
+      name: 'Test Company Name',
+      time_zone: 'America/Chicago',
+      language: 'en',
+      provider: 'company',
+      unit_system: {
+        yp: 'hsf',
+        oil: 'bbl',
+        area: 'ft2',
+        mass: 'lb',
+        time: 'min',
+        angle: 'deg',
+        force: 'klbf',
+        power: 'hp',
+        speed: 'ft/min',
+        length: 'm',
+        system: 'imperial',
+        torque: 'ft-klbf',
+        volume: 'gal',
+        current: 'mA',
+        density: 'ppg',
+        gravity: 'g',
+        voltage: 'mV',
+        porosity: 'pu',
+        pressure: 'psi',
+        velocity: 'ft/min',
+        gasVolume: 'Mscf',
+        gravityRMS: 'gRMS',
+        msePressure: 'ksi',
+        oilFlowRate: 'bbl/min',
+        resistivity: 'ohmm',
+        shortLength: 'in',
+        temperature: 'F',
+        massFlowRate: 'lb/min',
+        permiability: 'md',
+        concentration: 'ppm',
+        fluidVelocity: 'ft/min',
+        massPerLength: 'lb-ft',
+        anglePerLength: 'dp100f',
+        lengthPerAngle: 'in/rev',
+        volumeFlowRate: 'gal/min',
+        angularVelocity: 'rpm',
+        inversePressure: 'i-psi',
+        acousticSlowness: 'us/ft',
+        formationDensity: 'g/l',
+        gasConcentration: 'Units (0-5000u)',
+        pressureGradient: 'psi/ft',
+        massConcentration: 'lb/gal',
+        revolutionPerVolume: 'rpg',
+        spontaneousPotential: 'mV',
+        chemMassConcentration: 'lb/Mgal',
+        chemVolumeConcentration: 'gal/Mgal',
+      },
+      dev_center_enabled: true,
+      workflows_enabled: true,
+      with_subscription: false,
+      competitor_analysis_enabled: true,
+    },
+    groups: [
+      {
+        id: 5,
+        name: 'user',
+        company_id: 3,
+      },
+      {
+        id: 9,
+        name: 'customGroup',
+        company_id: 3,
+      },
+    ],
+  },
+  user: {},
+  company: {},
+};

package/templates/ui/typescript/src/__tests__/App.test.tsx

@@ -0,0 +1,21 @@
+import { render, screen } from '@testing-library/react';
+
+import App from '../App';
+import { mockAppProps } from '../__mocks__/mockAppProps';
+
+describe('<App />', () => {
+  it('should show correct layout', () => {
+    render(<App {...mockAppProps} />);
+
+    screen.getByText(/checked/i);
+  });
+
+  it('should show correct layout when settings are not provided', () => {
+    const propsWithoutSettings = mockAppProps;
+    delete propsWithoutSettings.isExampleCheckboxChecked;
+
+    render(<App {...propsWithoutSettings} />);
+
+    screen.getByText(/unchecked/i);
+  });
+});

package/templates/ui/typescript/src/__tests__/AppSettings.test.tsx

@@ -0,0 +1,21 @@
+import { render, screen, act } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+
+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();
+
+    render(<AppSettings {...mockAppSettingsProps} onSettingChange={handleSettingsChange} />);
+
+    const exampleCheckbox = screen.getByTestId('exampleCheckbox').querySelector('input');
+
+    await act(async () => {
+      await userEvent.click(exampleCheckbox);
+    });
+
+    expect(handleSettingsChange).toBeCalledWith('isExampleCheckboxChecked', false);
+  });
+});

package/templates/ui/typescript/src/__tests__/TestsExample.test.tsx

@@ -0,0 +1,37 @@
+import { useState } from 'react';
+import { render, screen, waitFor } from '@testing-library/react';
+import { components } from '@corva/ui';
+import userEvent from '@testing-library/user-event';
+
+const Toggle = () => {
+  const [isOn, setIsOn] = useState<boolean>(false);
+
+  return (
+    <>
+      {isOn ? 'ON' : 'OFF'}
+      <components.Button onClick={() => setIsOn(value => !value)}>toggle</components.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/typescript/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/typescript/src/constants.ts

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

package/templates/ui/typescript/src/custom.d.ts

@@ -0,0 +1,9 @@
+declare module '*.svg' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.css' {
+  const content: Record<string, string>;
+  export default content;
+}

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

@@ -0,0 +1,7 @@
+import App from './App';
+import AppSettings from './AppSettings';
+
+export default {
+  component: App,
+  settings: AppSettings,
+};

package/templates/ui/typescript/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@tsconfig/create-react-app/tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "strict": false,
+    "sourceMap": true
+  }
+}