Move client schema package into api/schema

.github/labeler.yml

@@ -63,7 +63,7 @@ area/toolshed:
   - lib/toolshed/**/*
   - templates/webapps/tool_shed/**/*
 area/UI-UX:
-  - all: ["client/src/**/*", "!client/src/schema/schema.ts"]
+  - all: ["client/src/**/*", "!client/src/api/schema/schema.ts"]
     any: ["templates/**/*"]
 area/util:
   - lib/galaxy/util/**/*

.github/workflows/lint_openapi_schema.yml

@@ -57,7 +57,7 @@ jobs:
       - name: Check for changes
         run: |
           if [[ `git status --porcelain` ]]; then
-            echo "Rebuilding client/src/schema/schema.ts resulted in changes, run 'make update-client-api-schema' and commit results"
+            echo "Rebuilding client/src/api/schema/schema.ts resulted in changes, run 'make update-client-api-schema' and commit results"
             exit 1
           fi
         working-directory: 'galaxy root'

Makefile

@@ -189,7 +189,7 @@ remove-api-schema:
 	rm _shed_schema.yaml
 
 update-client-api-schema: client-node-deps build-api-schema
-	$(IN_VENV) cd client && node openapi_to_schema.mjs ../_schema.yaml > src/schema/schema.ts && npx prettier --write src/schema/schema.ts
+	$(IN_VENV) cd client && node openapi_to_schema.mjs ../_schema.yaml > src/api/schema/schema.ts && npx prettier --write src/api/schema/schema.ts
 	$(IN_VENV) cd client && node openapi_to_schema.mjs ../_shed_schema.yaml > ../lib/tool_shed/webapp/frontend/src/schema/schema.ts && npx prettier --write ../lib/tool_shed/webapp/frontend/src/schema/schema.ts
 	$(MAKE) remove-api-schema
 

client/src/schema/__mocks__/fetcher.ts → client/src/api/schema/__mocks__/fetcher.ts

@@ -1,10 +1,10 @@
-import type { paths } from "@/schema";
+import type { paths } from "@/api/schema";
 
-jest.mock("@/schema", () => ({
+jest.mock("@/api/schema", () => ({
     fetcher: mockFetcher,
 }));
 
-jest.mock("@/schema/fetcher", () => ({
+jest.mock("@/api/schema/fetcher", () => ({
     fetcher: mockFetcher,
 }));
 
@@ -60,9 +60,9 @@ function setMockReturn(path: Path | RegExp, method: Method, value: any) {
 }
 
 /**
- * Mock implementation for the fetcher found in `@/schema/fetcher`
+ * Mock implementation for the fetcher found in `@/api/schema/fetcher`
  *
- * You need to call `jest.mock("@/schema")` and/or `jest.mock("@/schema/fetcher")`
+ * You need to call `jest.mock("@/api/schema")` and/or `jest.mock("@/api/schema/fetcher")`
  * (depending on what module the file you are testing imported)
  * in order for this mock to take effect.
  *

client/src/schema/mockFetcher.test.ts → client/src/api/schema/mockFetcher.test.ts

@@ -1,8 +1,8 @@
-import { fetcher } from "@/schema";
+import { fetcher } from "@/api/schema";
 
 import { mockFetcher } from "./__mocks__/fetcher";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 mockFetcher.path("/api/configuration").method("get").mock("CONFIGURATION");
 

client/src/components/Common/ExportRDMForm.test.ts

@@ -2,14 +2,14 @@ import { getLocalVue } from "@tests/jest/helpers";
 import { mount, Wrapper } from "@vue/test-utils";
 import flushPromises from "flush-promises";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 
 import { CreatedEntry } from "../FilesDialog/services";
 
 import ExportRDMForm from "./ExportRDMForm.vue";
 import FilesInput from "@/components/FilesDialog/FilesInput.vue";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 const localVue = getLocalVue(true);
 

client/src/components/Common/models/exportRecordModel.ts

@@ -1,6 +1,6 @@
 import { formatDistanceToNow, parseISO } from "date-fns";
 
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 
 type ExportObjectRequestMetadata = components["schemas"]["ExportObjectRequestMetadata"];
 

client/src/components/Common/models/testData/exportData.ts

@@ -1,5 +1,5 @@
 import { ExportRecordModel } from "@/components/Common/models/exportRecordModel";
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 
 type ObjectExportTaskResponse = components["schemas"]["ObjectExportTaskResponse"];
 type ExportObjectRequestMetadata = components["schemas"]["ExportObjectRequestMetadata"];

client/src/components/Dataset/services.ts

@@ -1,6 +1,6 @@
 import type { FetchArgType } from "openapi-typescript-fetch";
 
-import { fetcher } from "@/schema";
+import { fetcher } from "@/api/schema";
 import { withPrefix } from "@/utils/redirect";
 
 const _getDatasets = fetcher.path("/api/datasets").method("get").create();

client/src/components/Datatypes/model.ts

@@ -1,4 +1,4 @@
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 
 export type DatatypesCombinedMap = components["schemas"]["DatatypesCombinedMap"];
 

client/src/components/Datatypes/services.ts

@@ -1,4 +1,4 @@
-import { fetcher } from "@/schema/fetcher";
+import { fetcher } from "@/api/schema/fetcher";
 
 const getTypesAndMappings = fetcher.path("/api/datatypes/types_and_mapping").method("get").create();
 

client/src/components/FilesDialog/FilesDialog.test.ts

@@ -1,8 +1,8 @@
 import { createLocalVue, shallowMount, Wrapper } from "@vue/test-utils";
 import flushPromises from "flush-promises";
 
+import { mockFetcher } from "@/api/schema/__mocks__";
 import { selectionStates } from "@/components/SelectionDialog/selectionStates";
-import { mockFetcher } from "@/schema/__mocks__";
 
 import { BaseRecordItem } from "./model";
 import {
@@ -26,7 +26,7 @@ import DataDialogTable from "@/components/SelectionDialog/DataDialogTable.vue";
 import SelectionDialog from "@/components/SelectionDialog/SelectionDialog.vue";
 
 jest.mock("app");
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 jest.mock("@/composables/config", () => ({
     useConfig: jest.fn(() => ({

client/src/components/FilesDialog/services.ts

@@ -1,5 +1,5 @@
-import type { components } from "@/schema";
-import { fetcher } from "@/schema/fetcher";
+import type { components } from "@/api/schema";
+import { fetcher } from "@/api/schema/fetcher";
 
 /** The browsing mode:
  * - `file` - allows to select files or directories contained in a source (default)

client/src/components/Form/Elements/FormDirectory.test.js

@@ -5,13 +5,13 @@ import flushPromises from "flush-promises";
 import { createPinia } from "pinia";
 import { getLocalVue } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 
 import FormDirectory from "./FormDirectory";
 
 const localVue = getLocalVue();
 jest.mock("app");
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 describe("DirectoryPathEditableBreadcrumb", () => {
     let wrapper;

client/src/components/History/Archiving/HistoryArchiveExportSelector.test.ts

@@ -5,19 +5,19 @@ import { BFormCheckbox } from "bootstrap-vue";
 import flushPromises from "flush-promises";
 import { getLocalVue } from "tests/jest/helpers";
 
+import { mockFetcher } from "@/api/schema/__mocks__";
 import {
     FAILED_FILE_SOURCE_STORE_RESPONSE,
     FILE_SOURCE_STORE_RESPONSE,
     IN_PROGRESS_FILE_SOURCE_STORE_RESPONSE,
     RECENT_FILE_SOURCE_STORE_RESPONSE,
     RECENT_STS_DOWNLOAD_RESPONSE,
 } from "@/components/Common/models/testData/exportData";
-import { mockFetcher } from "@/schema/__mocks__";
 import type { HistorySummary } from "@/stores/historyStore";
 
 import HistoryArchiveExportSelector from "./HistoryArchiveExportSelector.vue";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 const localVue = getLocalVue(true);
 

client/src/components/History/Archiving/HistoryArchiveWizard.test.ts

@@ -4,12 +4,12 @@ import flushPromises from "flush-promises";
 import { setActivePinia } from "pinia";
 import { getLocalVue } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 import { type HistorySummary, useHistoryStore } from "@/stores/historyStore";
 
 import HistoryArchiveWizard from "./HistoryArchiveWizard.vue";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 jest.mock("@/composables/config", () => ({
     useConfig: jest.fn(() => ({

client/src/components/History/Content/GenericElement.vue

@@ -2,7 +2,7 @@
 import type { PropType } from "vue";
 import Vue, { ref } from "vue";
 
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 
 import ContentItem from "./ContentItem.vue";
 

client/src/components/History/Content/model/states.ts

@@ -1,4 +1,4 @@
-import { components } from "@/schema";
+import { components } from "@/api/schema";
 
 type DatasetState = components["schemas"]["DatasetState"];
 // The 'failed' state is for the collection job state summary, not a dataset state.

client/src/components/History/CurrentHistory/HistoryOperations/SelectionOperations.test.js

@@ -5,11 +5,11 @@ import flushPromises from "flush-promises";
 import { createPinia } from "pinia";
 import { getLocalVue } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 
 import SelectionOperations from "./SelectionOperations.vue";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 const localVue = getLocalVue();
 

client/src/components/History/Export/HistoryExport.test.ts

@@ -4,13 +4,13 @@ import { shallowMount } from "@vue/test-utils";
 import flushPromises from "flush-promises";
 import { setActivePinia } from "pinia";
 
+import type { components } from "@/api/schema";
+import { mockFetcher } from "@/api/schema/__mocks__";
 import {
     EXPIRED_STS_DOWNLOAD_RECORD,
     FILE_SOURCE_STORE_RECORD,
     RECENT_STS_DOWNLOAD_RECORD,
 } from "@/components/Common/models/testData/exportData";
-import type { components } from "@/schema";
-import { mockFetcher } from "@/schema/__mocks__";
 import { type HistorySummary, useHistoryStore } from "@/stores/historyStore";
 
 import { getExportRecords } from "./services";
@@ -19,7 +19,7 @@ import HistoryExport from "./HistoryExport.vue";
 
 const localVue = getLocalVue(true);
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 jest.mock("./services");
 const mockGetExportRecords = getExportRecords as jest.MockedFunction<typeof getExportRecords>;
 mockGetExportRecords.mockResolvedValue([]);

client/src/components/History/Export/services.ts

@@ -1,8 +1,8 @@
 import type { ObjectExportTaskResponse } from "@/components/Common/models/exportRecordModel";
 import { ExportRecordModel } from "@/components/Common/models/exportRecordModel";
 import { DEFAULT_EXPORT_PARAMS } from "@/composables/shortTermStorage";
-import type { components } from "@/schema";
-import { fetcher } from "@/schema";
+import type { components } from "@/api/schema";
+import { fetcher } from "@/api/schema";
 
 type ModelStoreFormat = components["schemas"]["ModelStoreFormat"];
 

client/src/components/History/Modals/SelectorModal.vue

@@ -19,7 +19,7 @@ import { storeToRefs } from "pinia";
 import { computed, onMounted, onUnmounted, type PropType, type Ref, ref, watch } from "vue";
 import { useRouter } from "vue-router/composables";
 
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 import { useHistoryStore } from "@/stores/historyStore";
 import { useUserStore } from "@/stores/userStore";
 import Filtering, { contains, expandNameTag } from "@/utils/filtering";

client/src/components/HistoryExport/Index.test.js

@@ -1,11 +1,11 @@
 import { shallowMount } from "@vue/test-utils";
 import { getLocalVue } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 
 import Index from "./Index.vue";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 const localVue = getLocalVue();
 

client/src/components/HistoryImport.test.js

@@ -5,7 +5,7 @@ import { waitOnJob } from "components/JobStates/wait";
 import flushPromises from "flush-promises";
 import { getLocalVue, wait } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 
 import HistoryImport from "./HistoryImport.vue";
 
@@ -15,7 +15,7 @@ const TEST_HISTORY_URI = "/api/histories";
 const TEST_SOURCE_URL = "http://galaxy.example/import";
 const TEST_PLUGINS_URL = "/api/remote_files/plugins";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 jest.mock("components/JobStates/wait");
 
 describe("HistoryImport.vue", () => {

client/src/components/Masthead/Masthead.test.js

@@ -5,7 +5,7 @@ import { PiniaVuePlugin, setActivePinia } from "pinia";
 import { useEntryPointStore } from "stores/entryPointStore";
 import { getLocalVue } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 
 import { loadWebhookMenuItems } from "./_webhooks";
 import { getActiveTab } from "./utilities";
@@ -17,7 +17,7 @@ jest.mock("./_webhooks");
 jest.mock("vue-router/composables", () => ({
     useRoute: jest.fn(() => ({ name: "Home" })),
 }));
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 describe("Masthead.vue", () => {
     let wrapper;

client/src/components/Masthead/QuotaMeter.test.ts

@@ -3,12 +3,12 @@ import { mount } from "@vue/test-utils";
 import flushPromises from "flush-promises";
 import { getLocalVue } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 import { useUserStore } from "@/stores/userStore";
 
 import QuotaMeter from "./QuotaMeter.vue";
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 
 const localVue = getLocalVue();
 

client/src/components/NewUserWelcome/NewUserWelcome.test.js

@@ -2,7 +2,7 @@ import { mount } from "@vue/test-utils";
 import { createPinia } from "pinia";
 import { getLocalVue } from "tests/jest/helpers";
 
-import { mockFetcher } from "@/schema/__mocks__";
+import { mockFetcher } from "@/api/schema/__mocks__";
 
 import { getResource } from "./getResource";
 import testData from "./testData.json";
@@ -11,7 +11,7 @@ import NewUserWelcome from "./NewUserWelcome.vue";
 
 const localVue = getLocalVue();
 
-jest.mock("@/schema");
+jest.mock("@/api/schema");
 jest.mock("./getResource");
 
 // mock resource connector

client/src/components/Notifications/Broadcasts/BroadcastContainer.vue

@@ -7,8 +7,8 @@ import { storeToRefs } from "pinia";
 import { computed } from "vue";
 import { useRouter } from "vue-router/composables";
 
+import { type components } from "@/api/schema";
 import { useMarkdown } from "@/composables/markdown";
-import { type components } from "@/schema";
 import { type BroadcastNotification, useBroadcastsStore } from "@/stores/broadcastsStore";
 
 import Heading from "@/components/Common/Heading.vue";

client/src/components/Notifications/index.ts

@@ -1,4 +1,4 @@
-import { type components } from "@/schema";
+import { type components } from "@/api/schema";
 
 export type BaseUserNotification = components["schemas"]["UserNotificationResponse"];
 

client/src/components/Notifications/test-utils.ts

@@ -1,5 +1,5 @@
 import type { MessageNotification, SharedItemNotification, UserNotification } from "@/components/Notifications/index";
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 
 type NotificationVariants = components["schemas"]["NotificationVariant"];
 type NewSharedItemNotificationContentItemType = components["schemas"]["NewSharedItemNotificationContent"]["item_type"];

client/src/components/ObjectStore/ObjectStoreBadge.vue

@@ -4,7 +4,7 @@ import "./badgeIcons";
 import { FontAwesomeIcon, FontAwesomeLayers } from "@fortawesome/vue-fontawesome";
 import { computed } from "vue";
 
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 
 import ConfigurationMarkdown from "./ConfigurationMarkdown.vue";
 

client/src/components/ObjectStore/ObjectStoreBadges.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import type { components } from "@/schema";
+import type { components } from "@/api/schema";
 
 import ObjectStoreBadge from "./ObjectStoreBadge.vue";