@scm-manager/ui-api 2.44.2 → 2.44.3-20230527-064447

package/build/index.d.ts

@@ -1,5 +1,5 @@
 import * as _scm_manager_ui_types from '@scm-manager/ui-types';
-import { IndexResources, HalRepresentation, Me, GroupCollection, Group, GroupCreation, UserCollection, User, PermissionOverview, UserCreation, SelectValue, Namespace, RepositoryCollection, RepositoryCreation, Repository, RepositoryTypeCollection, ExportInfo, Paths, NamespaceCollection, NamespaceStrategies, BranchCollection, Branch, BranchDetails, BranchCreation, NamespaceAndName, ChangesetCollection, Changeset, TagCollection, Tag, Config, UpdateInfo, PluginCollection, PendingPlugins, Plugin, RepositoryRoleCollection, RepositoryRole, RepositoryRoleCreation, RepositoryVerbs, PermissionCollection, PermissionCreateEntry, Permission, GlobalPermissionsCollection, File as File$1, RepositoryType, RepositoryUrlImport, Diff, NotificationCollection, Notification, AlertsResponse, ApiKeysCollection, ApiKeyCreation, ApiKeyWithToken, ApiKey, PublicKeysCollection, PublicKeyCreation, PublicKey, ContentType, AnnotatedSource, SearchableType, QueryResult, LoginInfo, PluginCenterAuthenticationInfo } from '@scm-manager/ui-types';
+import { IndexResources, HalRepresentation, Me, GroupCollection, Group, GroupCreation, UserCollection, User, PermissionOverview, UserCreation, SelectValue, Namespace, RepositoryCollection, RepositoryCreation, Repository, RepositoryTypeCollection, ExportInfo, Paths, NamespaceCollection, NamespaceStrategies, BranchCollection, Branch, BranchDetails, BranchCreation, NamespaceAndName, ChangesetCollection, Changeset, TagCollection, Tag, Config, UpdateInfo, PluginCollection, PendingPlugins, Plugin, RepositoryRoleCollection, RepositoryRole, RepositoryRoleCreation, RepositoryVerbs, PermissionCollection, PermissionCreateEntry, Permission, GlobalPermissionsCollection, File as File$1, RepositoryType, RepositoryUrlImport, Diff, NotificationCollection, Notification, AlertsResponse, ApiKeysCollection, ApiKeyCreation, ApiKeyWithToken, ApiKey, PublicKeysCollection, PublicKeyCreation, PublicKey, ContentType, AnnotatedSource, SearchableType, QueryResult, LoginInfo, PluginCenterAuthenticationInfo, Option, AutocompleteObject } from '@scm-manager/ui-types';
 export { ContentType } from '@scm-manager/ui-types';
 import * as react_query from 'react-query';
 import { UseQueryOptions } from 'react-query/types/react/types';
@@ -736,6 +736,10 @@ declare function useCancellablePromise(): <T>(p: Promise<T>) => CancelablePromis
 declare const requiredLink: (object: HalRepresentation, name: string, subName?: string) => string;
 declare const objectLink: (object: HalRepresentation, name: string) => string | null;
 
+declare const useGroupOptions: (query?: string) => react_query.UseQueryResult<Option<AutocompleteObject>[], Error>;
+declare const useNamespaceOptions: (query?: string) => react_query.UseQueryResult<Option<AutocompleteObject>[], Error>;
+declare const useUserOptions: (query?: string) => react_query.UseQueryResult<Option<AutocompleteObject>[], Error>;
+
 declare type BaseContext = {
     onIndexFetched?: (index: IndexResources) => void;
     onMeFetched?: (me: Me) => void;
@@ -774,4 +778,4 @@ declare const RepositoryRevisionContextProvider: FC<{
     revision?: string;
 }>;
 
-export { AdditionalMessage, ApiProvider, Props as ApiProviderProps, ApiResult, ApiResultWithFetching, BackendError, BackendErrorContent, BadGatewayError, BaseContext, CONTENT_TYPE_PUBLIC_KEY, CancelablePromise, ConflictError, ConvertToInternalRequest, DeleteFunction, ForbiddenError, LegacyContext, LegacyContextProvider, MissingLinkError, NamespaceAndNameContext, NamespaceAndNameContextProvider, NotFoundError, RepositoryContextProvider, RepositoryRevisionContextProvider, SearchOptions, TOKEN_EXPIRED_ERROR_CODE, TokenExpiredError, UnauthorizedError, UseAvailablePluginsOptions, UseDeleteRepositoryOptions, UseGroupsRequest, UseHistoryRequest, UseInstalledPluginsOptions, UseRepositoriesRequest, UseRepositoryRolesRequest, UseSourcesOptions, UseUsersRequest, Violation, apiClient, changesetQueryKey, clearCache, createBackendError, createChangesetUrl, createDiffUrl, createQueryString, createUrl, createUrlWithIdentifiers, extractXsrfTokenFromCookie, fetchResourceFromLocationHeader, getResponseJson, isBackendError, makeCancelable, objectLink, requiredLink, urls, useAlerts, useAnnotations, useApiKeys, useArchiveRepository, useAvailableGlobalPermissions, useAvailablePermissions, useAvailablePlugins, useBranch, useBranchDetails, useBranchDetailsCollection, useBranches, useCancelPendingPlugins, useCancellablePromise, useChangeUserPassword, useChangeset, useChangesets, useClearNotifications, useConfig, useConfigLink, useContentType, useConvertToExternal, useConvertToInternal, useCreateApiKey, useCreateBranch, useCreateGroup, useCreatePermission, useCreatePublicKey, useCreateRepository, useCreateRepositoryRole, useCreateTag, useCreateUser, useDefaultBranch, useDeleteApiKey, useDeleteBranch, useDeleteGroup, useDeletePermission, useDeletePublicKey, useDeleteRepository, useDeleteRepositoryRole, useDeleteTag, useDeleteUser, useDiff, useDismissNotification, useExecutePendingPlugins, useExportInfo, useExportRepository, useFileContent, useGroup, useGroupPermissions, useGroupSuggestions, useGroups, useHistory, useImportFullRepository, useImportLog, useImportRepositoryFromBundle, useImportRepositoryFromUrl, useIncomingChangesets, useIndex, useIndexJsonResource, useIndexLink, useIndexLinks, useInstallPlugin, useInstalledPlugins, useJsonResource, useLegacyContext, useLogin, useLoginInfo, useLogout, useMe, useNamespace, useNamespaceAndNameContext, useNamespaceStrategies, useNamespaceSuggestions, useNamespaces, useNotificationSubscription, useNotifications, useOmniSearch, usePaths, usePendingPlugins, usePermissions, usePluginCenterAuthInfo, usePluginCenterLogout, usePublicKeys, useReindexRepository, useRenameRepository, useRepositories, useRepository, useRepositoryContext, useRepositoryRevisionContext, useRepositoryRole, useRepositoryRoles, useRepositoryTypes, useRepositoryVerbs, useRequiredIndexLink, useRequiredMe, useRunHealthCheck, useSearch, useSearchCounts, useSearchHelpContent, useSearchSyntaxContent, useSearchTypes, useSearchableTypes, useSetGroupPermissions, useSetUserPassword, useSetUserPermissions, useSources, useSubject, useSuggestions, useTag, useTags, useUnarchiveRepository, useUninstallPlugin, useUpdateConfig, useUpdateGroup, useUpdateInfo, useUpdatePermission, useUpdatePlugins, useUpdateRepository, useUpdateRepositoryRole, useUpdateUser, useUser, useUserPermissionOverview, useUserPermissions, useUserSuggestions, useUsers, useVersion, waitForRestartAfter };
+export { AdditionalMessage, ApiProvider, Props as ApiProviderProps, ApiResult, ApiResultWithFetching, BackendError, BackendErrorContent, BadGatewayError, BaseContext, CONTENT_TYPE_PUBLIC_KEY, CancelablePromise, ConflictError, ConvertToInternalRequest, DeleteFunction, ForbiddenError, LegacyContext, LegacyContextProvider, MissingLinkError, NamespaceAndNameContext, NamespaceAndNameContextProvider, NotFoundError, RepositoryContextProvider, RepositoryRevisionContextProvider, SearchOptions, TOKEN_EXPIRED_ERROR_CODE, TokenExpiredError, UnauthorizedError, UseAvailablePluginsOptions, UseDeleteRepositoryOptions, UseGroupsRequest, UseHistoryRequest, UseInstalledPluginsOptions, UseRepositoriesRequest, UseRepositoryRolesRequest, UseSourcesOptions, UseUsersRequest, Violation, apiClient, changesetQueryKey, clearCache, createBackendError, createChangesetUrl, createDiffUrl, createQueryString, createUrl, createUrlWithIdentifiers, extractXsrfTokenFromCookie, fetchResourceFromLocationHeader, getResponseJson, isBackendError, makeCancelable, objectLink, requiredLink, urls, useAlerts, useAnnotations, useApiKeys, useArchiveRepository, useAvailableGlobalPermissions, useAvailablePermissions, useAvailablePlugins, useBranch, useBranchDetails, useBranchDetailsCollection, useBranches, useCancelPendingPlugins, useCancellablePromise, useChangeUserPassword, useChangeset, useChangesets, useClearNotifications, useConfig, useConfigLink, useContentType, useConvertToExternal, useConvertToInternal, useCreateApiKey, useCreateBranch, useCreateGroup, useCreatePermission, useCreatePublicKey, useCreateRepository, useCreateRepositoryRole, useCreateTag, useCreateUser, useDefaultBranch, useDeleteApiKey, useDeleteBranch, useDeleteGroup, useDeletePermission, useDeletePublicKey, useDeleteRepository, useDeleteRepositoryRole, useDeleteTag, useDeleteUser, useDiff, useDismissNotification, useExecutePendingPlugins, useExportInfo, useExportRepository, useFileContent, useGroup, useGroupOptions, useGroupPermissions, useGroupSuggestions, useGroups, useHistory, useImportFullRepository, useImportLog, useImportRepositoryFromBundle, useImportRepositoryFromUrl, useIncomingChangesets, useIndex, useIndexJsonResource, useIndexLink, useIndexLinks, useInstallPlugin, useInstalledPlugins, useJsonResource, useLegacyContext, useLogin, useLoginInfo, useLogout, useMe, useNamespace, useNamespaceAndNameContext, useNamespaceOptions, useNamespaceStrategies, useNamespaceSuggestions, useNamespaces, useNotificationSubscription, useNotifications, useOmniSearch, usePaths, usePendingPlugins, usePermissions, usePluginCenterAuthInfo, usePluginCenterLogout, usePublicKeys, useReindexRepository, useRenameRepository, useRepositories, useRepository, useRepositoryContext, useRepositoryRevisionContext, useRepositoryRole, useRepositoryRoles, useRepositoryTypes, useRepositoryVerbs, useRequiredIndexLink, useRequiredMe, useRunHealthCheck, useSearch, useSearchCounts, useSearchHelpContent, useSearchSyntaxContent, useSearchTypes, useSearchableTypes, useSetGroupPermissions, useSetUserPassword, useSetUserPermissions, useSources, useSubject, useSuggestions, useTag, useTags, useUnarchiveRepository, useUninstallPlugin, useUpdateConfig, useUpdateGroup, useUpdateInfo, useUpdatePermission, useUpdatePlugins, useUpdateRepository, useUpdateRepositoryRole, useUpdateUser, useUser, useUserOptions, useUserPermissionOverview, useUserPermissions, useUserSuggestions, useUsers, useVersion, waitForRestartAfter };

package/build/index.js

@@ -106,6 +106,7 @@ __export(src_exports, {
   useExportRepository: () => useExportRepository,
   useFileContent: () => useFileContent,
   useGroup: () => useGroup,
+  useGroupOptions: () => useGroupOptions,
   useGroupPermissions: () => useGroupPermissions,
   useGroupSuggestions: () => useGroupSuggestions,
   useGroups: () => useGroups,
@@ -129,6 +130,7 @@ __export(src_exports, {
   useMe: () => useMe,
   useNamespace: () => useNamespace,
   useNamespaceAndNameContext: () => useNamespaceAndNameContext,
+  useNamespaceOptions: () => useNamespaceOptions,
   useNamespaceStrategies: () => useNamespaceStrategies,
   useNamespaceSuggestions: () => useNamespaceSuggestions,
   useNamespaces: () => useNamespaces,
@@ -179,6 +181,7 @@ __export(src_exports, {
   useUpdateRepositoryRole: () => useUpdateRepositoryRole,
   useUpdateUser: () => useUpdateUser,
   useUser: () => useUser,
+  useUserOptions: () => useUserOptions,
   useUserPermissionOverview: () => useUserPermissionOverview,
   useUserPermissions: () => useUserPermissions,
   useUserSuggestions: () => useUserSuggestions,
@@ -3361,11 +3364,65 @@ var useIncomingChangesets = (repository, source, target, request) => {
   );
 };
 
+// src/useAutocompleteOptions.ts
+var import_react_query33 = require("react-query");
+var import_react_i18next = require("react-i18next");
+var defaultLabelFactory = (element) => element.displayName ? `${element.displayName} (${element.id})` : element.id;
+function useAutocompleteOptions(query = "", link, options = {}) {
+  const [t] = (0, import_react_i18next.useTranslation)("commons");
+  return (0, import_react_query33.useQuery)(
+    ["options", link, query],
+    () => apiClient.get(link + "?q=" + query).then((r) => r.json()).then((json) => {
+      const result = json.map((element) => ({
+        value: element,
+        label: options.labelFactory ? options.labelFactory(element) : defaultLabelFactory(element)
+      }));
+      if (options.allowArbitraryValues && !result.some(
+        (opt) => {
+          var _a;
+          return opt.value.id === query || ((_a = opt.value.displayName) == null ? void 0 : _a.toLowerCase()) === query.toLowerCase();
+        }
+      )) {
+        result.unshift({
+          value: options.allowArbitraryValues(query),
+          label: query,
+          displayValue: t("form.combobox.arbitraryDisplayValue", { query })
+        });
+      }
+      return result;
+    }),
+    {
+      enabled: query.length > 1 && !!link
+    }
+  );
+}
+var useGroupOptions = (query) => {
+  const indexLinks = useIndexLinks();
+  const autocompleteLink = indexLinks.autocomplete.find((i) => i.name === "groups");
+  return useAutocompleteOptions(query, autocompleteLink == null ? void 0 : autocompleteLink.href, {
+    allowArbitraryValues: (query2) => ({ id: query2, displayName: query2 })
+  });
+};
+var useNamespaceOptions = (query) => {
+  const indexLinks = useIndexLinks();
+  const autocompleteLink = indexLinks.autocomplete.find((i) => i.name === "namespaces");
+  return useAutocompleteOptions(query, autocompleteLink == null ? void 0 : autocompleteLink.href, {
+    allowArbitraryValues: (query2) => ({ id: query2, displayName: query2 })
+  });
+};
+var useUserOptions = (query) => {
+  const indexLinks = useIndexLinks();
+  const autocompleteLink = indexLinks.autocomplete.find((i) => i.name === "users");
+  return useAutocompleteOptions(query, autocompleteLink == null ? void 0 : autocompleteLink.href, {
+    allowArbitraryValues: (query2) => ({ id: query2, displayName: query2 })
+  });
+};
+
 // src/ApiProvider.tsx
 var import_react10 = __toESM(require("react"));
-var import_react_query33 = require("react-query");
+var import_react_query34 = require("react-query");
 var import_devtools = require("react-query/devtools");
-var queryClient = new import_react_query33.QueryClient({
+var queryClient = new import_react_query34.QueryClient({
   defaultOptions: {
     queries: {
       retry: false
@@ -3389,7 +3446,7 @@ var ApiProvider = ({ children, index, me, onMeFetched, onIndexFetched, devtools
       }
     }
   }, [me, onMeFetched]);
-  return /* @__PURE__ */ import_react10.default.createElement(import_react_query33.QueryClientProvider, {
+  return /* @__PURE__ */ import_react10.default.createElement(import_react_query34.QueryClientProvider, {
     client: queryClient
   }, /* @__PURE__ */ import_react10.default.createElement(LegacyContextProvider, {
     onIndexFetched,
@@ -3518,6 +3575,7 @@ var RepositoryRevisionContextProvider = ({ revision, children }) => /* @__PURE__
   useExportRepository,
   useFileContent,
   useGroup,
+  useGroupOptions,
   useGroupPermissions,
   useGroupSuggestions,
   useGroups,
@@ -3541,6 +3599,7 @@ var RepositoryRevisionContextProvider = ({ revision, children }) => /* @__PURE__
   useMe,
   useNamespace,
   useNamespaceAndNameContext,
+  useNamespaceOptions,
   useNamespaceStrategies,
   useNamespaceSuggestions,
   useNamespaces,
@@ -3591,6 +3650,7 @@ var RepositoryRevisionContextProvider = ({ revision, children }) => /* @__PURE__
   useUpdateRepositoryRole,
   useUpdateUser,
   useUser,
+  useUserOptions,
   useUserPermissionOverview,
   useUserPermissions,
   useUserSuggestions,

package/build/index.mjs

@@ -3177,6 +3177,60 @@ var useIncomingChangesets = (repository, source, target, request) => {
   );
 };
 
+// src/useAutocompleteOptions.ts
+import { useQuery as useQuery29 } from "react-query";
+import { useTranslation } from "react-i18next";
+var defaultLabelFactory = (element) => element.displayName ? `${element.displayName} (${element.id})` : element.id;
+function useAutocompleteOptions(query = "", link, options = {}) {
+  const [t] = useTranslation("commons");
+  return useQuery29(
+    ["options", link, query],
+    () => apiClient.get(link + "?q=" + query).then((r) => r.json()).then((json) => {
+      const result = json.map((element) => ({
+        value: element,
+        label: options.labelFactory ? options.labelFactory(element) : defaultLabelFactory(element)
+      }));
+      if (options.allowArbitraryValues && !result.some(
+        (opt) => {
+          var _a;
+          return opt.value.id === query || ((_a = opt.value.displayName) == null ? void 0 : _a.toLowerCase()) === query.toLowerCase();
+        }
+      )) {
+        result.unshift({
+          value: options.allowArbitraryValues(query),
+          label: query,
+          displayValue: t("form.combobox.arbitraryDisplayValue", { query })
+        });
+      }
+      return result;
+    }),
+    {
+      enabled: query.length > 1 && !!link
+    }
+  );
+}
+var useGroupOptions = (query) => {
+  const indexLinks = useIndexLinks();
+  const autocompleteLink = indexLinks.autocomplete.find((i) => i.name === "groups");
+  return useAutocompleteOptions(query, autocompleteLink == null ? void 0 : autocompleteLink.href, {
+    allowArbitraryValues: (query2) => ({ id: query2, displayName: query2 })
+  });
+};
+var useNamespaceOptions = (query) => {
+  const indexLinks = useIndexLinks();
+  const autocompleteLink = indexLinks.autocomplete.find((i) => i.name === "namespaces");
+  return useAutocompleteOptions(query, autocompleteLink == null ? void 0 : autocompleteLink.href, {
+    allowArbitraryValues: (query2) => ({ id: query2, displayName: query2 })
+  });
+};
+var useUserOptions = (query) => {
+  const indexLinks = useIndexLinks();
+  const autocompleteLink = indexLinks.autocomplete.find((i) => i.name === "users");
+  return useAutocompleteOptions(query, autocompleteLink == null ? void 0 : autocompleteLink.href, {
+    allowArbitraryValues: (query2) => ({ id: query2, displayName: query2 })
+  });
+};
+
 // src/ApiProvider.tsx
 import React2, { useEffect as useEffect7 } from "react";
 import { QueryClient as QueryClient4, QueryClientProvider } from "react-query";
@@ -3333,6 +3387,7 @@ export {
   useExportRepository,
   useFileContent,
   useGroup,
+  useGroupOptions,
   useGroupPermissions,
   useGroupSuggestions,
   useGroups,
@@ -3356,6 +3411,7 @@ export {
   useMe,
   useNamespace,
   useNamespaceAndNameContext,
+  useNamespaceOptions,
   useNamespaceStrategies,
   useNamespaceSuggestions,
   useNamespaces,
@@ -3406,6 +3462,7 @@ export {
   useUpdateRepositoryRole,
   useUpdateUser,
   useUser,
+  useUserOptions,
   useUserPermissionOverview,
   useUserPermissions,
   useUserSuggestions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scm-manager/ui-api",
-  "version": "2.44.2",
+  "version": "2.44.3-20230527-064447",
   "description": "React hook api for the SCM-Manager backend",
   "main": "build/index.js",
   "module": "build/index.mjs",
@@ -29,13 +29,14 @@
     "tsup": "^5.12.6"
   },
   "dependencies": {
-    "@scm-manager/ui-types": "2.44.2",
+    "@scm-manager/ui-types": "2.44.3-20230527-064447",
     "fetch-mock-jest": "^1.5.1",
     "gitdiff-parser": "^0.2.2",
     "query-string": "6.14.1",
     "react": "^17.0.1",
     "react-query": "^3.25.1",
-    "react-router-dom": "^5.3.1"
+    "react-router-dom": "^5.3.1",
+    "react-i18next": "11"
   },
   "babel": {
     "presets": [