Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-09 15:05:44 +01:00
Code Issues Packages Projects Releases Activity

tidy up suggestions api (#1699)

Browse Source 
Streamlines the suggestions/autocomplete api and removes redundancy. All logic accessing the backend is now in hooks in ui-api.
This commit is contained in:
Konstantin Schaper
2021-06-15 15:36:21 +02:00
committed by GitHub
parent e5e79398d2
commit 17ecec03b2
7 changed files with 129 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
scm-ui/ui-api/src/groupSuggestions.ts Normal file
View File

@@ -0,0 +1,32 @@
/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import { Link } from "@scm-manager/ui-types";
import { useIndexLinks } from "./base";
import { useSuggestions } from "./suggestions";
export const useGroupSuggestions = () => {
const indexLinks = useIndexLinks();
const autocompleteLink = (indexLinks.autocomplete as Link[]).find((i) => i.name === "groups");
return useSuggestions(autocompleteLink?.href);
};

2
scm-ui/ui-api/src/index.ts
View File

@@ -32,7 +32,9 @@ export * from "./base";
export * from "./login";
export * from "./groups";
export * from "./users";
export * from "./suggestions";
export * from "./userSuggestions";
export * from "./groupSuggestions";
export * from "./repositories";
export * from "./namespaces";
export * from "./branches";

47
scm-ui/ui-api/src/suggestions.ts Normal file
View File

@@ -0,0 +1,47 @@
/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import { AutocompleteObject, SelectValue } from "@scm-manager/ui-types";
import { apiClient } from "./apiclient";
export const useSuggestions: (link?: string) => (query: string) => Promise<SelectValue[]> = (link) => {
if (!link) {
return () => Promise.resolve([]);
}
const url = link + "?q=";
return (inputValue) => {
// Prevent violate input condition of api call because parameter length is too short
if (inputValue.length < 2) {
return Promise.resolve([]);
}
return apiClient
.get(url + inputValue)
.then((response) => response.json())
.then((json: AutocompleteObject[]) =>
json.map((element) => ({
value: element,
label: element.displayName ? `${element.displayName} (${element.id})` : element.id,
}))
);
};
};

28
scm-ui/ui-api/src/userSuggestions.ts
View File

@@ -21,32 +21,12 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import {DisplayedUser, Link, SelectValue} from "@scm-manager/ui-types";
import { Link } from "@scm-manager/ui-types";
import { useIndexLinks } from "./base";
import { apiClient } from "./apiclient";
import { useSuggestions } from "./suggestions";
export const useUserSuggestions = () => {
const indexLinks = useIndexLinks();
const autocompleteLink = (indexLinks.autocomplete as Link[]).find(i => i.name === "users");
if (!autocompleteLink) {
return [];
}
const url = autocompleteLink.href + "?q=";
return (inputValue: string): never[] | Promise<SelectValue[]> => {
// Prevent violate input condition of api call because parameter length is too short
if (inputValue.length < 2) {
return [];
}
return apiClient
.get(url + inputValue)
.then(response => response.json())
.then(json => {
return json.map((element: DisplayedUser) => {
return {
value: element,
label: `${element.displayName} (${element.id})`
};
});
});
};
const autocompleteLink = (indexLinks.autocomplete as Link[]).find((i) => i.name === "users");
return useSuggestions(autocompleteLink?.href);
};