refactor: organise API around resources (#798)

2026-08-15 12:23:51 +00:00 · 2024-03-02 23:08:08 +01:00
parent d87ba12b2e
commit 088927bbbb
104 changed files with 1741 additions and 1718 deletions
@@ -1,7 +1,7 @@
 import { useState } from 'react';
 import { Button } from '@chakra-ui/react';

-import { getLatestVersion, HasUpdate } from '../../../../common/api/ontimeApi';
+import { getLatestVersion, HasUpdate } from '../../../../common/api/external';
 import ExternalLink from '../../../../common/components/external-link/ExternalLink';

 import style from '../Panel.module.scss';
@@ -52,7 +52,13 @@ export default function CheckUpdatesButton(props: CheckUpdatesButtonProps) {

  return (
    <>
-      <Button onClick={versionCheck} variant='ontime-filled' isLoading={isFetching} isDisabled={disableButton} size='sm'>
+      <Button
+        onClick={versionCheck}
+        variant='ontime-filled'
+        isLoading={isFetching}
+        isDisabled={disableButton}
+        size='sm'
+      >
        Check for updates
      </Button>
      <ResolveUpdateMessage updateMessage={updateMessage} />
@@ -5,7 +5,7 @@ import { IoTrash } from '@react-icons/all-files/io5/IoTrash';
 import { HttpSettings } from 'ontime-types';
 import { generateId } from 'ontime-utils';

-import { maybeAxiosError } from '../../../../common/api/apiUtils';
+import { maybeAxiosError } from '../../../../common/api/utils';
 import { useHttpSettings, usePostHttpSettings } from '../../../../common/hooks-query/useHttpSettings';
 import { isKeyEscape } from '../../../../common/utils/keyEvent';
 import { startsWithHttp } from '../../../../common/utils/regex';
@@ -5,7 +5,7 @@ import { IoTrash } from '@react-icons/all-files/io5/IoTrash';
 import { OSCSettings } from 'ontime-types';
 import { generateId } from 'ontime-utils';

-import { maybeAxiosError } from '../../../../common/api/apiUtils';
+import { maybeAxiosError } from '../../../../common/api/utils';
 import useOscSettings, { useOscSettingsMutation } from '../../../../common/hooks-query/useOscSettings';
 import { isKeyEscape } from '../../../../common/utils/keyEvent';
 import { isIPAddress, isOnlyNumbers, startsWithSlash } from '../../../../common/utils/regex';
@@ -1,4 +1,4 @@
-import { serverPort } from '../../../../common/api/apiConstants';
+import { serverPort } from '../../../../common/api/constants';
 import AppLink from '../../../../common/components/app-link/AppLink';
 import useInfo from '../../../../common/hooks-query/useInfo';

@@ -1,9 +1,11 @@
 import { useEffect, useState } from 'react';
 import { useForm } from 'react-hook-form';
 import { Button, Input, Textarea } from '@chakra-ui/react';
+import { useQueryClient } from '@tanstack/react-query';

-import { maybeAxiosError } from '../../../../common/api/apiUtils';
-import { createProject } from '../../../../common/api/ontimeApi';
+import { PROJECT_LIST } from '../../../../common/api/constants';
+import { createProject } from '../../../../common/api/db';
+import { maybeAxiosError } from '../../../../common/api/utils';
 import * as Panel from '../PanelUtils';

 import style from './ProjectPanel.module.scss';
@@ -25,6 +27,7 @@ export default function ProjectCreateForm(props: ProjectCreateFromProps) {
  const { onClose } = props;

  const [error, setError] = useState<string | null>(null);
+  const queryClient = useQueryClient();

  const {
    handleSubmit,
@@ -53,6 +56,7 @@ export default function ProjectCreateForm(props: ProjectCreateFromProps) {
        ...values,
        filename,
      });
+      await queryClient.invalidateQueries({ queryKey: PROJECT_LIST });
      onClose();
    } catch (error) {
      setError(maybeAxiosError(error));
@@ -2,7 +2,6 @@ import { useState } from 'react';
 import { IconButton, Menu, MenuButton, MenuItem, MenuList } from '@chakra-ui/react';
 import { IoEllipsisHorizontal } from '@react-icons/all-files/io5/IoEllipsisHorizontal';

-import { invalidateAllCaches, maybeAxiosError } from '../../../../common/api/apiUtils';
 import {
  deleteProject,
  downloadCSV,
@@ -10,7 +9,8 @@ import {
  duplicateProject,
  loadProject,
  renameProject,
-} from '../../../../common/api/ontimeApi';
+} from '../../../../common/api/db';
+import { invalidateAllCaches, maybeAxiosError } from '../../../../common/api/utils';

 import ProjectForm, { ProjectFormValues } from './ProjectForm';

@@ -2,8 +2,8 @@ import { ChangeEvent, useRef, useState } from 'react';
 import { Button, Input } from '@chakra-ui/react';
 import { IoAdd } from '@react-icons/all-files/io5/IoAdd';

-import { invalidateAllCaches, maybeAxiosError } from '../../../../common/api/apiUtils';
-import { importProjectFile } from '../../../../common/api/ontimeApi';
+import { uploadProjectFile } from '../../../../common/api/db';
+import { invalidateAllCaches, maybeAxiosError } from '../../../../common/api/utils';
 import { validateProjectFile } from '../../../../common/utils/uploadUtils';
 import * as Panel from '../PanelUtils';

@@ -37,7 +37,7 @@ export default function ProjectPanel() {

    try {
      validateProjectFile(selectedFile);
-      await importProjectFile(selectedFile);
+      await uploadProjectFile(selectedFile);
    } catch (error) {
      const errorMessage = maybeAxiosError(error);
      setError(`Error uploading file: ${errorMessage}`);
@@ -48,6 +48,10 @@ export default function ProjectPanel() {
    setLoading(null);
  };

+  const handleCloseForm = () => {
+    setIsCreatingProject(false);
+  };
+
  return (
    <>
      <Panel.Header>Project</Panel.Header>
@@ -85,7 +89,7 @@ export default function ProjectPanel() {
            </div>
          </Panel.SubHeader>
          {error && <Panel.Error>{error}</Panel.Error>}
-          {isCreatingProject && <ProjectCreateForm onClose={() => setIsCreatingProject(false)} />}
+          {isCreatingProject && <ProjectCreateForm onClose={handleCloseForm} />}
          <ProjectList />
        </Panel.Card>
      </Panel.Section>
@@ -4,7 +4,7 @@ import { Button, Input } from '@chakra-ui/react';
 import { CustomField } from 'ontime-types';
 import { isAlphanumeric } from 'ontime-utils';

-import { maybeAxiosError } from '../../../../common/api/apiUtils';
+import { maybeAxiosError } from '../../../../common/api/utils';
 import SwatchSelect from '../../../../common/components/input/colour-input/SwatchSelect';
 import * as Panel from '../PanelUtils';

@@ -3,7 +3,7 @@ import { Alert, AlertDescription, AlertIcon, Button } from '@chakra-ui/react';
 import { IoAdd } from '@react-icons/all-files/io5/IoAdd';
 import { CustomField, CustomFieldLabel } from 'ontime-types';

-import { deleteCustomField, editCustomField, postCustomField } from '../../../../common/api/ontimeApi';
+import { deleteCustomField, editCustomField, postCustomField } from '../../../../common/api/customFields';
 import ExternalLink from '../../../../common/components/external-link/ExternalLink';
 import useCustomFields from '../../../../common/hooks-query/useCustomFields';
 import * as Panel from '../PanelUtils';
@@ -4,8 +4,8 @@ import { IoCloudOutline } from '@react-icons/all-files/io5/IoCloudOutline';
 import { IoDownloadOutline } from '@react-icons/all-files/io5/IoDownloadOutline';
 import { ImportMap, unpackError } from 'ontime-utils';

-import { maybeAxiosError } from '../../../../common/api/apiUtils';
-import { importSpreadsheetPreview } from '../../../../common/api/ontimeApi';
+import { importSpreadsheetPreview } from '../../../../common/api/db';
+import { maybeAxiosError } from '../../../../common/api/utils';
 import { validateSpreadsheetImport } from '../../../../common/utils/uploadUtils';
 import * as Panel from '../PanelUtils';

@@ -2,16 +2,16 @@ import { useQueryClient } from '@tanstack/react-query';
 import { AuthenticationStatus, CustomFields, OntimeRundown } from 'ontime-types';
 import { ImportMap } from 'ontime-utils';

-import { CUSTOM_FIELDS, RUNDOWN } from '../../../../common/api/apiConstants';
-import { maybeAxiosError } from '../../../../common/api/apiUtils';
+import { CUSTOM_FIELDS, RUNDOWN } from '../../../../common/api/constants';
+import { patchData } from '../../../../common/api/db';
 import {
-  patchData,
  previewRundown,
  requestConnection,
  revokeAuthentication,
  uploadRundown,
  verifyAuthenticationStatus,
-} from '../../../../common/api/ontimeApi';
+} from '../../../../common/api/sheets';
+import { maybeAxiosError } from '../../../../common/api/utils';

 import { useSheetStore } from './useSheetStore';