@scm-manager/ui-api 2.36.1 → 2.36.2-20220522-120507

package/build/index.d.ts

@@ -0,0 +1,735 @@
+import * as _scm_manager_ui_types from '@scm-manager/ui-types';
+import { IndexResources, HalRepresentation, Me, GroupCollection, Group, GroupCreation, UserCollection, User, 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';
+export { ContentType } from '@scm-manager/ui-types';
+import * as react_query from 'react-query';
+import { FC } from 'react';
+
+declare const contextPath: any;
+declare function withContextPath(path: string): string;
+declare function withEndingSlash(url: string): string;
+declare function withStartingSlash(url: string): string;
+declare function concat(base: string, ...parts: string[]): string;
+declare function getNamespaceAndPageFromMatch(match: any): {
+    namespace: undefined;
+    page: number;
+} | {
+    namespace: string;
+    page: number;
+};
+declare function getPageFromMatch(match: any): number;
+declare function getQueryStringFromLocation(location: {
+    search?: string;
+}): string | undefined;
+declare function stripEndingSlash(url: string): string;
+declare function matchedUrlFromMatch(match: any): string;
+declare function matchedUrl(props: any): string;
+declare function escapeUrlForRoute(url: string): string;
+declare function unescapeUrlForRoute(url: string): string;
+
+declare const urls_contextPath: typeof contextPath;
+declare const urls_withContextPath: typeof withContextPath;
+declare const urls_withEndingSlash: typeof withEndingSlash;
+declare const urls_withStartingSlash: typeof withStartingSlash;
+declare const urls_concat: typeof concat;
+declare const urls_getNamespaceAndPageFromMatch: typeof getNamespaceAndPageFromMatch;
+declare const urls_getPageFromMatch: typeof getPageFromMatch;
+declare const urls_getQueryStringFromLocation: typeof getQueryStringFromLocation;
+declare const urls_stripEndingSlash: typeof stripEndingSlash;
+declare const urls_matchedUrlFromMatch: typeof matchedUrlFromMatch;
+declare const urls_matchedUrl: typeof matchedUrl;
+declare const urls_escapeUrlForRoute: typeof escapeUrlForRoute;
+declare const urls_unescapeUrlForRoute: typeof unescapeUrlForRoute;
+declare namespace urls {
+  export {
+    urls_contextPath as contextPath,
+    urls_withContextPath as withContextPath,
+    urls_withEndingSlash as withEndingSlash,
+    urls_withStartingSlash as withStartingSlash,
+    urls_concat as concat,
+    urls_getNamespaceAndPageFromMatch as getNamespaceAndPageFromMatch,
+    urls_getPageFromMatch as getPageFromMatch,
+    urls_getQueryStringFromLocation as getQueryStringFromLocation,
+    urls_stripEndingSlash as stripEndingSlash,
+    urls_matchedUrlFromMatch as matchedUrlFromMatch,
+    urls_matchedUrl as matchedUrl,
+    urls_escapeUrlForRoute as escapeUrlForRoute,
+    urls_unescapeUrlForRoute as unescapeUrlForRoute,
+  };
+}
+
+declare type Context = {
+    type: string;
+    id: string;
+}[];
+declare type Violation = {
+    path?: string;
+    message: string;
+    key?: string;
+};
+declare type AdditionalMessage = {
+    key?: string;
+    message?: string;
+};
+declare type BackendErrorContent = {
+    transactionId: string;
+    errorCode: string;
+    message: string;
+    url?: string;
+    context: Context;
+    violations: Violation[];
+    additionalMessages?: AdditionalMessage[];
+};
+declare class BackendError extends Error {
+    transactionId: string;
+    errorCode: string;
+    url: string | null | undefined;
+    context: Context;
+    statusCode: number;
+    violations: Violation[];
+    additionalMessages?: AdditionalMessage[];
+    constructor(content: BackendErrorContent, name: string, statusCode: number);
+}
+declare class UnauthorizedError extends Error {
+    statusCode: number;
+    constructor(message: string, statusCode: number);
+}
+declare class BadGatewayError extends Error {
+    statusCode: number;
+    constructor(message: string, statusCode: number);
+}
+declare class TokenExpiredError extends UnauthorizedError {
+}
+declare class ForbiddenError extends Error {
+    statusCode: number;
+    constructor(message: string, statusCode: number);
+}
+declare class NotFoundError extends BackendError {
+    constructor(content: BackendErrorContent, statusCode: number);
+}
+declare class ConflictError extends BackendError {
+    constructor(content: BackendErrorContent, statusCode: number);
+}
+declare class MissingLinkError extends Error {
+    name: string;
+}
+declare function createBackendError(content: BackendErrorContent, statusCode: number): BackendError;
+declare function isBackendError(response: Response): boolean;
+declare const TOKEN_EXPIRED_ERROR_CODE = "DDS8D8unr1";
+
+declare type SubscriptionEvent = {
+    type: string;
+};
+declare type OpenEvent = SubscriptionEvent;
+declare type ErrorEvent = SubscriptionEvent & {
+    error: Error;
+};
+declare type MessageEvent = SubscriptionEvent & {
+    data: string;
+    lastEventId?: string;
+};
+declare type MessageListeners = {
+    [eventType: string]: (event: MessageEvent) => void;
+};
+declare type SubscriptionContext = {
+    onOpen?: OpenEvent;
+    onMessage: MessageListeners;
+    onError?: ErrorEvent;
+};
+declare type SubscriptionArgument = MessageListeners | SubscriptionContext;
+declare type Cancel = () => void;
+declare const extractXsrfTokenFromCookie: (cookieString?: string | undefined) => any;
+declare function createUrl(url: string): string;
+declare function createUrlWithIdentifiers(url: string): string;
+declare type ErrorListener = (error: Error) => void;
+declare type RequestListener = (url: string, options?: RequestInit) => void;
+declare class ApiClient {
+    errorListeners: ErrorListener[];
+    requestListeners: RequestListener[];
+    get: (url: string) => Promise<Response>;
+    post: (url: string, payload?: any, contentType?: string, additionalHeaders?: Record<string, string>) => Promise<Response>;
+    postText: (url: string, payload: string, additionalHeaders?: Record<string, string>) => Promise<Response>;
+    putText: (url: string, payload: string, additionalHeaders?: Record<string, string>) => Promise<Response>;
+    postBinary: (url: string, fileAppender: (p: FormData) => void, additionalHeaders?: Record<string, string>) => Promise<Response>;
+    put(url: string, payload: any, contentType?: string, additionalHeaders?: Record<string, string>): Promise<Response>;
+    head: (url: string) => Promise<Response>;
+    delete: (url: string) => Promise<Response>;
+    httpRequestWithJSONBody: (method: string, url: string, contentType: string, additionalHeaders: Record<string, string>, payload?: any) => Promise<Response>;
+    httpRequestWithTextBody: (method: string, url: string, additionalHeaders: Record<string, string> | undefined, payload: string) => Promise<Response>;
+    httpRequestWithBinaryBody: (options: RequestInit, url: string, contentType?: string | undefined) => Promise<Response>;
+    subscribe(url: string, argument: SubscriptionArgument): Cancel;
+    onRequest: (requestListener: RequestListener) => void;
+    onError: (errorListener: ErrorListener) => void;
+    private request;
+    private notifyRequestListeners;
+    private notifyAndRethrow;
+}
+declare const apiClient: ApiClient;
+
+declare type ApiResult<T> = {
+    isLoading: boolean;
+    error: Error | null;
+    data?: T;
+};
+declare type ApiResultWithFetching<T> = ApiResult<T> & {
+    isFetching: boolean;
+};
+declare type DeleteFunction<T> = (entity: T) => void;
+declare const useIndex: () => ApiResult<IndexResources>;
+declare const useIndexLink: (name: string) => string | undefined;
+declare const useIndexLinks: () => _scm_manager_ui_types.Links;
+declare const useRequiredIndexLink: (name: string) => string;
+declare const useVersion: () => string;
+declare const useIndexJsonResource: <T>(name: string) => ApiResult<T>;
+declare const useJsonResource: <T>(entity: HalRepresentation, name: string, key: string[]) => ApiResult<T>;
+declare function fetchResourceFromLocationHeader(response: Response): Promise<Response>;
+declare const getResponseJson: (response: Response) => Promise<any>;
+
+declare const useMe: () => ApiResult<Me>;
+declare const useRequiredMe: () => Me;
+declare const useSubject: () => {
+    isAuthenticated: boolean;
+    isAnonymous: boolean;
+    isLoading: boolean;
+    error: Error | null;
+    me: Me | undefined;
+};
+declare const useLogin: () => {
+    login: ((username: string, password: string) => void) | undefined;
+    isLoading: boolean;
+    error: Error | null;
+};
+declare const useLogout: () => {
+    logout: (() => void) | undefined;
+    isLoading: boolean;
+    error: Error | null;
+};
+
+declare type UseGroupsRequest = {
+    page?: number | string;
+    search?: string;
+};
+declare const useGroups: (request?: UseGroupsRequest | undefined) => ApiResult<GroupCollection>;
+declare const useGroup: (name: string) => ApiResult<Group>;
+declare const useCreateGroup: () => {
+    create: (group: GroupCreation) => void;
+    isLoading: boolean;
+    error: Error | null;
+    group: Group | undefined;
+};
+declare const useUpdateGroup: () => {
+    update: (group: Group) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUpdated: boolean;
+};
+declare const useDeleteGroup: () => {
+    remove: (group: Group) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+
+declare type UseUsersRequest = {
+    page?: number | string;
+    search?: string;
+};
+declare const useUsers: (request?: UseUsersRequest | undefined) => ApiResult<UserCollection>;
+declare const useUser: (name: string) => ApiResult<User>;
+declare const useCreateUser: () => {
+    create: (user: UserCreation) => void;
+    isLoading: boolean;
+    error: Error | null;
+    user: User | undefined;
+};
+declare const useUpdateUser: () => {
+    update: (user: User) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUpdated: boolean;
+};
+declare const useDeleteUser: () => {
+    remove: (user: User) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+declare type ConvertToInternalRequest = {
+    user: User;
+    password: string;
+};
+declare const useConvertToInternal: () => {
+    convertToInternal: (user: User, password: string) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isConverted: boolean;
+};
+declare const useConvertToExternal: () => {
+    convertToExternal: (user: User) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isConverted: boolean;
+};
+declare const useSetUserPassword: (user: User) => {
+    setPassword: (newPassword: string) => void;
+    passwordOverwritten: boolean;
+    isLoading: boolean;
+    error: Error | null;
+    reset: () => void;
+};
+declare const useChangeUserPassword: (user: User | Me) => {
+    changePassword: (oldPassword: string, newPassword: string) => void;
+    passwordChanged: boolean;
+    isLoading: boolean;
+    error: Error | null;
+    reset: () => void;
+};
+
+declare const useSuggestions: (link?: string) => (query: string) => Promise<SelectValue[]>;
+
+declare const useUserSuggestions: () => (query: string) => Promise<_scm_manager_ui_types.SelectValue[]>;
+
+declare const useGroupSuggestions: () => (query: string) => Promise<_scm_manager_ui_types.SelectValue[]>;
+
+declare const useNamespaceSuggestions: () => (query: string) => Promise<_scm_manager_ui_types.SelectValue[]>;
+
+declare type UseRepositoriesRequest = {
+    namespace?: Namespace;
+    search?: string;
+    page?: number | string;
+    disabled?: boolean;
+};
+declare const useRepositories: (request?: UseRepositoriesRequest | undefined) => ApiResult<RepositoryCollection>;
+declare const useCreateRepository: () => {
+    create: (repository: RepositoryCreation, initialize: boolean) => void;
+    isLoading: boolean;
+    error: Error | null;
+    repository: Repository | undefined;
+};
+declare const useRepositoryTypes: () => ApiResult<RepositoryTypeCollection>;
+declare const useRepository: (namespace: string, name: string) => ApiResult<Repository>;
+declare type UseDeleteRepositoryOptions = {
+    onSuccess: (repository: Repository) => void;
+};
+declare const useDeleteRepository: (options?: UseDeleteRepositoryOptions | undefined) => {
+    remove: (repository: Repository) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+declare const useUpdateRepository: () => {
+    update: (repository: Repository) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUpdated: boolean;
+};
+declare const useArchiveRepository: () => {
+    archive: (repository: Repository) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isArchived: boolean;
+};
+declare const useUnarchiveRepository: () => {
+    unarchive: (repository: Repository) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUnarchived: boolean;
+};
+declare const useRunHealthCheck: () => {
+    runHealthCheck: (repository: Repository) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isRunning: boolean;
+};
+declare const useExportInfo: (repository: Repository) => ApiResultWithFetching<ExportInfo>;
+declare type ExportOptions = {
+    compressed: boolean;
+    withMetadata: boolean;
+    password?: string;
+};
+declare const useExportRepository: () => {
+    exportRepository: (repository: Repository, options: ExportOptions) => void;
+    isLoading: boolean;
+    error: Error | null;
+    data: ExportInfo | undefined;
+};
+declare const usePaths: (repository: Repository, revision: string) => ApiResult<Paths>;
+declare const useRenameRepository: (repository: Repository) => {
+    renameRepository: (namespace: string, name: string) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isRenamed: boolean;
+};
+
+declare const useNamespaces: () => ApiResult<NamespaceCollection>;
+declare const useNamespace: (name: string) => ApiResult<Namespace>;
+declare const useNamespaceStrategies: () => ApiResult<NamespaceStrategies>;
+
+declare const useBranches: (repository: Repository) => ApiResult<BranchCollection>;
+declare const useBranch: (repository: Repository, name: string) => ApiResultWithFetching<Branch>;
+declare const useBranchDetailsCollection: (repository: Repository, branches: Branch[]) => {
+    data: (BranchDetails | undefined)[] | undefined;
+    isLoading: boolean;
+    error: Error | null;
+};
+declare const useBranchDetails: (repository: Repository, branch: Branch) => react_query.UseQueryResult<BranchDetails, Error>;
+declare const useCreateBranch: (repository: Repository) => {
+    create: (branch: BranchCreation) => void;
+    isLoading: boolean;
+    error: Error | null;
+    branch: Branch | undefined;
+};
+declare const useDeleteBranch: (repository: Repository) => {
+    remove: (branch: Branch) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+declare type DefaultBranch = {
+    defaultBranch: string;
+};
+declare const useDefaultBranch: (repository: Repository) => ApiResult<DefaultBranch>;
+
+declare type UseChangesetsRequest = {
+    branch?: Branch;
+    page?: string | number;
+    limit?: number;
+};
+declare const changesetQueryKey: (repository: NamespaceAndName, id: string) => unknown[];
+declare const useChangesets: (repository: Repository, request?: UseChangesetsRequest | undefined) => ApiResultWithFetching<ChangesetCollection>;
+declare const useChangeset: (repository: Repository, id: string) => ApiResult<Changeset>;
+
+declare const useTags: (repository: Repository) => ApiResult<TagCollection>;
+declare const useTag: (repository: Repository, name: string) => ApiResult<Tag>;
+declare const useCreateTag: (repository: Repository, changeset: Changeset) => {
+    isLoading: boolean;
+    error: Error | null;
+    create: (name: string) => void;
+    tag: Tag | undefined;
+};
+declare const useDeleteTag: (repository: Repository) => {
+    remove: (tag: Tag) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+
+declare const useConfig: () => ApiResult<Config>;
+declare const useUpdateConfig: () => {
+    update: (config: Config) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUpdated: boolean;
+    reset: () => void;
+};
+
+declare const useUpdateInfo: () => ApiResult<UpdateInfo | null>;
+
+declare type WaitForRestartOptions = {
+    initialDelay?: number;
+    timeout?: number;
+};
+declare const waitForRestartAfter: (promise: Promise<any>, { initialDelay, timeout }?: WaitForRestartOptions) => Promise<void>;
+declare type UseAvailablePluginsOptions = {
+    enabled?: boolean;
+};
+declare const useAvailablePlugins: ({ enabled }?: UseAvailablePluginsOptions) => ApiResult<PluginCollection>;
+declare type UseInstalledPluginsOptions = {
+    enabled?: boolean;
+};
+declare const useInstalledPlugins: ({ enabled }?: UseInstalledPluginsOptions) => ApiResult<PluginCollection>;
+declare const usePendingPlugins: () => ApiResult<PendingPlugins>;
+declare type RestartOptions = WaitForRestartOptions & {
+    restart?: boolean;
+};
+declare const useInstallPlugin: () => {
+    install: (plugin: Plugin, restartOptions?: RestartOptions) => void;
+    isLoading: boolean;
+    error: Error | null;
+    data: unknown;
+    isInstalled: boolean;
+};
+declare const useUninstallPlugin: () => {
+    uninstall: (plugin: Plugin, restartOptions?: RestartOptions) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUninstalled: boolean;
+};
+declare const useUpdatePlugins: () => {
+    update: (plugin: Plugin | PluginCollection, restartOptions?: RestartOptions) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUpdated: boolean;
+};
+declare const useExecutePendingPlugins: () => {
+    update: (pending: PendingPlugins, restartOptions?: WaitForRestartOptions) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isExecuted: boolean;
+};
+declare const useCancelPendingPlugins: () => {
+    update: (pending: PendingPlugins) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isCancelled: boolean;
+};
+
+declare type UseRepositoryRolesRequest = {
+    page?: number | string;
+};
+declare const useRepositoryRoles: (request?: UseRepositoryRolesRequest | undefined) => ApiResult<RepositoryRoleCollection>;
+declare const useRepositoryRole: (name: string) => ApiResult<RepositoryRole>;
+declare const useCreateRepositoryRole: () => {
+    create: (repositoryRole: RepositoryRoleCreation) => void;
+    isLoading: boolean;
+    error: Error | null;
+    repositoryRole: RepositoryRole | undefined;
+};
+declare const useUpdateRepositoryRole: () => {
+    update: (repositoryRole: RepositoryRole) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isUpdated: boolean;
+};
+declare const useDeleteRepositoryRole: () => {
+    remove: (repositoryRole: RepositoryRole) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+
+declare const useRepositoryVerbs: () => ApiResult<RepositoryVerbs>;
+/**
+ * *IMPORTANT NOTE:* These are actually *REPOSITORY* permissions.
+ */
+declare const useAvailablePermissions: () => {
+    isLoading: boolean;
+    error: Error | null;
+    data: {
+        repositoryVerbs: string[];
+        repositoryRoles: _scm_manager_ui_types.RepositoryRole[];
+    } | undefined;
+};
+declare const usePermissions: (namespaceOrRepository: Namespace | Repository) => ApiResult<PermissionCollection>;
+declare const useCreatePermission: (namespaceOrRepository: Namespace | Repository) => {
+    isLoading: boolean;
+    error: Error | null;
+    create: (permission: PermissionCreateEntry) => void;
+    permission: Permission | undefined;
+};
+declare const useUpdatePermission: (namespaceOrRepository: Namespace | Repository) => {
+    isLoading: boolean;
+    error: Error | null;
+    update: (permission: Permission) => void;
+    isUpdated: boolean;
+};
+declare const useDeletePermission: (namespaceOrRepository: Namespace | Repository) => {
+    isLoading: boolean;
+    error: Error | null;
+    remove: (permission: Permission) => void;
+    isDeleted: boolean;
+};
+declare const useGroupPermissions: (group: Group) => ApiResult<GlobalPermissionsCollection>;
+declare const useUserPermissions: (user: User) => ApiResult<GlobalPermissionsCollection>;
+declare const useAvailableGlobalPermissions: () => ApiResult<Omit<GlobalPermissionsCollection, "_links">>;
+declare const useSetUserPermissions: (user: User, permissions?: GlobalPermissionsCollection | undefined) => {
+    isLoading: boolean;
+    error: Error | null;
+    setPermissions: ((permissions: string[]) => void) | undefined;
+    isUpdated: boolean;
+};
+declare const useSetGroupPermissions: (group: Group, permissions?: GlobalPermissionsCollection | undefined) => {
+    isLoading: boolean;
+    error: Error | null;
+    setPermissions: ((permissions: string[]) => void) | undefined;
+    isUpdated: boolean;
+};
+
+declare type UseSourcesOptions = {
+    revision?: string;
+    path?: string;
+    refetchPartialInterval?: number;
+    enabled?: boolean;
+    collapse?: boolean;
+};
+declare const useSources: (repository: Repository, opts?: UseSourcesOptions) => {
+    isLoading: boolean;
+    error: Error | null;
+    data: File$1 | undefined;
+    isFetchingNextPage: boolean;
+    fetchNextPage: () => void;
+};
+
+declare const useImportLog: (logId: string) => ApiResult<string>;
+declare const useImportRepositoryFromUrl: (repositoryType: RepositoryType) => {
+    isLoading: boolean;
+    error: Error | null;
+    importRepositoryFromUrl: (repository: RepositoryUrlImport) => void;
+    importedRepository: Repository | undefined;
+};
+declare const useImportRepositoryFromBundle: (repositoryType: RepositoryType) => {
+    isLoading: boolean;
+    error: Error | null;
+    importRepositoryFromBundle: (repository: RepositoryCreation, file: File, compressed?: boolean | undefined, password?: string | undefined) => void;
+    importedRepository: Repository | undefined;
+};
+declare const useImportFullRepository: (repositoryType: RepositoryType) => {
+    isLoading: boolean;
+    error: Error | null;
+    importFullRepository: (repository: RepositoryCreation, file: File, password?: string | undefined) => void;
+    importedRepository: Repository | undefined;
+};
+
+declare type UseDiffOptions = {
+    limit?: number;
+    refetchOnWindowFocus?: boolean;
+};
+declare const useDiff: (link: string, options?: UseDiffOptions) => {
+    isLoading: boolean;
+    error: Error | null;
+    isFetchingNextPage: boolean;
+    fetchNextPage: () => void;
+    data: Diff | undefined;
+};
+
+declare const useNotifications: () => {
+    data: NotificationCollection | undefined;
+    error: Error | null;
+    isLoading: boolean;
+    refetch: () => Promise<NotificationCollection | undefined>;
+};
+declare const useDismissNotification: (notification: Notification) => {
+    isLoading: boolean;
+    error: Error | null;
+    dismiss: () => void;
+    isCleared: boolean;
+};
+declare const useClearNotifications: (notificationCollection: NotificationCollection) => {
+    isLoading: boolean;
+    error: Error | null;
+    clear: () => void;
+    isCleared: boolean;
+};
+declare const useNotificationSubscription: (refetch: () => Promise<NotificationCollection | undefined>, notificationCollection?: NotificationCollection | undefined) => {
+    notifications: Notification[];
+    remove: (notification: Notification) => void;
+    clear: () => void;
+};
+
+declare const useAlerts: () => ApiResult<AlertsResponse>;
+
+declare const useConfigLink: <C extends HalRepresentation>(link: string) => {
+    isLoading: boolean;
+    isUpdating: boolean;
+    isReadOnly: boolean;
+    error: Error | null;
+    initialConfiguration: C | undefined;
+    update: (configuration: C) => void;
+    isUpdated: boolean;
+};
+
+declare const useApiKeys: (user: User | Me) => ApiResult<ApiKeysCollection>;
+declare const useCreateApiKey: (user: User | Me, apiKeys: ApiKeysCollection) => {
+    create: (key: ApiKeyCreation) => void;
+    isLoading: boolean;
+    error: Error | null;
+    apiKey: ApiKeyWithToken | undefined;
+    reset: () => void;
+};
+declare const useDeleteApiKey: (user: User | Me) => {
+    remove: (apiKey: ApiKey) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+
+declare const CONTENT_TYPE_PUBLIC_KEY = "application/vnd.scmm-publicKey+json;v=2";
+declare const usePublicKeys: (user: User | Me) => ApiResult<PublicKeysCollection>;
+declare const useCreatePublicKey: (user: User | Me, publicKeys: PublicKeysCollection) => {
+    create: (key: PublicKeyCreation) => void;
+    isLoading: boolean;
+    error: Error | null;
+    apiKey: PublicKey | undefined;
+    reset: () => void;
+};
+declare const useDeletePublicKey: (user: User | Me) => {
+    remove: (publicKey: PublicKey) => void;
+    isLoading: boolean;
+    error: Error | null;
+    isDeleted: boolean;
+};
+
+declare const useFileContent: (file: File$1) => ApiResult<string>;
+
+declare type UseHistoryRequest = {
+    page?: number | string;
+};
+declare const useHistory: (repository: Repository, revision: string, file: File$1, request?: UseHistoryRequest | undefined) => ApiResult<ChangesetCollection>;
+
+declare const useContentType: (url: string) => ApiResultWithFetching<ContentType>;
+
+declare const useAnnotations: (repository: Repository, revision: string, file: File$1) => ApiResultWithFetching<AnnotatedSource>;
+
+declare type SearchOptions = {
+    type: string;
+    page?: number;
+    pageSize?: number;
+};
+declare const useSearchTypes: () => string[];
+declare const useSearchableTypes: () => ApiResult<SearchableType[]>;
+declare const useSearchCounts: (types: string[], query: string) => {
+    [type: string]: ApiResultWithFetching<number>;
+};
+declare const useSearch: (query: string, optionParam?: SearchOptions) => ApiResult<QueryResult>;
+declare const useSearchHelpContent: (language: string) => {
+    data: "Our search uses Lucene and you may use the [full syntax](http://lucene.apache.org/core/8_9_0/index.html).\n\nTo learn about advanced search read our [Expert Search Site](/help/search-syntax).\n\n### Basic Search\n\n- The most relevant repositories are shown in the quick results.\n- Press \"enter\" or click the \"Show all results\" button to find more results for all entities like users or groups.\n- A multi-character wildcard (*) is added to your search by default.\n- Do not enter Wildcards in front of the search!" | "Unsere Suche basiert auf Lucene. Sie können die [vollständige Syntax](http://lucene.apache.org/core/8_9_0/index.html) nutzen.\n\nUm mehr über die fortgeschrittene Suche zu erfahren, lesen sie unsere [Expertenseite](/help/search-syntax).\n\n### Einfache Suche\n\n- Die relevantesten Repositories werden in den Quick Results angezeigt.\n- Über die Eingabe-Taste oder den Button \"Alle Ergebnisse anzeigen\" bekommen Sie Ergebnisse aller durchsuchten Entitäten wie Nutzern oder Gruppen.\n- Eine Wildcard für eine beliebige Anzahl an beliebigen Zeichen wird Ihrer Suche standardmäßig angehängt.\n- Geben Sie keine Wildcards vor dem Suchbegriff ein!" | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+};
+declare const useSearchSyntaxContent: (language: string) => {
+    data: "### Modifiers\n\nNote: You can not use wildcards as the first character of a search.\n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Example</th>\n  </tr>\n  <tr>\n    <td>? - single character Wildcard</td>\n    <td>Ultimate?Repo – finds e.g. Ultimate-Repo, Ultimate Repo, Ultimate+Repo</td>\n  </tr>\n  <tr>\n    <td>* - multiple character Wildcard</td>\n    <td>Ultimat*y - finds e.g. Ultimate Repository, Ultimate-Special-Repository, Ultimately</td>\n  </tr>\n</table>\n\n\n### Ranges\n\nRange Queries allow one to match documents whose field(s) values are between the lower and upper bound specified by the Range Query. Range Queries can be inclusive or exclusive of the upper and lower bounds. Sorting is done lexicographically.\n\nRanges are not reserved to numerical fields. \n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Example</th>\n  </tr>\n  <tr>\n    <td>[ … TO … ] - inclusive range</td>\n    <td>creationDate:[1609459200000 TO 1612137600000] – finds e.G. repositories created between 2021-01-01 and 2021-02-01 </td>\n  </tr>\n  <tr>\n    <td>{… TO …} - exclusive range</td>\n    <td>name:{Aida TO Carmen} – finds e.G. repositories with names between Aida and Carmen, excluding these to values.</td>\n  </tr>\n</table>\n\n\n### Boosting\n\nBoosting allows you to control the relevance of a document by boosting its term. \n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Example</th>\n  </tr>\n  <tr>\n    <td>term^number</td>\n    <td>ultimate^2 repository – makes the term \"ultimate\" more relevant. </td>\n  </tr>\n</table>\n\n\nBy default, the boost factor is 1. Although the boost factor must be positive, it can be less than 1 (e.g. 0.2)\n\nBy default Repository names are boosted by 1.5, namespace by 1.25.\n\n## Boolean Operators\n\nNote: Logical Operators must be entered in upper case (e.g. \"AND\").\n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Example</th>\n  </tr>\n  <tr>\n    <td>AND – both terms must be included</td>\n    <td>Ultimate AND Repository – finds e.g. Ultimate Repository, Ultimate Special Repository</td>\n  </tr>\n  <tr>\n    <td>OR – at least one of the terms must be included</td>\n    <td>Ultimate OR Repository – finds e.g. Ultimate Repository, Ultimate User, Special Repository</td>\n  </tr>\n  <tr>\n    <td>NOT – following term may not be included, \"!\" may be used alternatively</td>\n    <td>Ultimate NOT Repository – finds e.g. Ultimate user, excludes e.g. Ultimate Repository</td>\n  </tr>\n  <tr>\n    <td>– excludes following term from search</td>\n    <td>Ultimate Repository -Special – finds e.g. Ultimate Repository, excludes e.g. Ultimate Special Repository</td>\n  </tr>\n  <tr>\n    <td>– following term must be included</td>\n    <td>Ultimate +Repository – finds e.g. my Repository, Ultimate Repository</td>\n  </tr>\n</table>\n\n\n## Grouping\n\nSearch supports using parentheses to group clauses to form sub queries. This can be very useful if you want to control the boolean logic for a query.\n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Example</th>\n  </tr>\n  <tr>\n    <td>() – terms inside parentheses are grouped together</td>\n    <td>(Ultimate OR my) AND Repository – finds e.g. Ultimate Repository, my Repository, excludes e.g. Super Repository. Either \"Ultimate\" or “My” must exist, “Repository” must always exist.\n </td>\n  </tr>\n</table>\n\n\n## Escaping Special Characters\n\nThe search supports escaping special characters that are part of the query syntax. The current list special characters are\n\n&plus; &minus; && || ! ( ) { } [ ] ^ \" ~ * ? : &bsol; /\n\nTo escape these characters use the \"&bsol;\" before the character. For example to search for (1+1):2 use the query:\n\n&bsol;(1&bsol;+1&bsol;)&bsol;:2\n\nSource: [https://javadoc.io/static/org.apache.lucene/lucene-queryparser/8.9.0/org/apache/lucene/queryparser/classic/package-summary.html#package.description](https://javadoc.io/static/org.apache.lucene/lucene-queryparser/8.9.0/org/apache/lucene/queryparser/classic/package-summary.html#package.description)" | "## Modifikatoren\n\nHinweis: Sie können keine Wildcards als erstes Zeichen einer Suche verwenden.\n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Beispiel</th>\n  </tr>\n  <tr>\n    <td>? - Einzelzeichen-Wildcard</td>\n    <td>Ultimate?Repo - findet z.B. Ultimate-Repo, Ultimate Repo, Ultimate+Repo</td>\n  </tr>\n  <tr>\n    <td>* - mehrstelliger Platzhalter</td>\n    <td>Ultimat*y - findet z.B. Ultimate Repository, Ultimates-Spezial-Repository, Ultimate</td>\n  </tr>\n</table>\n\n\n### Bereiche\n\nBereichsabfragen ermöglichen den Abgleich von Dokumenten, deren Feldwerte zwischen der unteren und der oberen Grenze liegen, die in der Bereichsabfrage angegeben sind. Bereichsabfragen können die obere und untere Grenze einschließen oder ausschließen. Die Sortierung erfolgt lexikografisch.\n\nBereiche sind nicht auf numerische Felder beschränkt. \n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Beispiel</th>\n  </tr>\n  <tr>\n    <td>[ … TO … ] - inklusiver Bereich</td>\n    <td>creationDate:[1609459200000 TO 1612137600000] – findet z.B. Repositories, die zwischen dem 01.01.2021 und dem 01.02.2021 angelegt wurden.</td>\n  </tr>\n  <tr>\n    <td>{… TO …} - ausschließender Bereich</td>\n    <td>name:{Aida TO Carmen} – findet Namen zwischen Aida und Carmen, jedoch ohne die beiden Namen einzuschließen.</td>\n  </tr>\n</table>\n\n\n## Boosten\n\nMit dem Boosting können Sie die Relevanz eines Dokuments steuern, indem Sie seinen Term verstärken.\n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Beispiel</th>\n  </tr>\n  <tr>\n    <td>term^Zahl</td>\n    <td>ultimate^2 repository – erhöht die Relevanz von „ultimate\"</td>\n  </tr>\n</table>\n\n\nStandardmäßig ist der Boost-Faktor 1. Obwohl der Boost-Faktor positiv sein muss, kann er kleiner als 1 sein (z. B. 0,2)\n\nStandardmäßig werden Repository-Namen um 1,5 und Namespace-Namen um 1,25 geboostet.\n\n## Boolesche Operatoren\n\nHinweis: Logische Operatoren müssen in Großbuchstaben eingegeben werden (z. B. „AND\").\n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Beispiel</th>\n  </tr>\n  <tr>\n    <td>AND – beide Terme müssen enthalten sein</td>\n    <td>Ultimate AND Repository – findet z.B. Ultimate Repository, Ultimate Special Repository\n </td>\n  </tr>\n  <tr>\n    <td>OR – mindestens einer der Terme muss enthalten sein</td>\n    <td>Ultimate OR Repository – findet z.B.. Ultimate Repository, Ultimate User, Special Repository</td>\n  </tr>\n  <tr>\n    <td>NOT – der nachfolgende Term darf nicht enthalten sein. „!\" kann alternativ verwendet werden.</td>\n    <td>Ultimate NOT Repository – findet z.B.. Ultimate user, nicht jedoch z.B. Ultimate Repository</td>\n  </tr>\n  <tr>\n    <td>– schließt den folgenden Term von der Suche aus</td>\n    <td>Ultimate Repository -Special – findet z.B. Ultimate Repository, schließt z.B. Ultimate Special Repository aus</td>\n  </tr>\n  <tr>\n    <td>– der folgende Term muss enthalten sein</td>\n    <td>Ultimate +Repository – findet z.B. my Repository, Ultimate Repository</td>\n  </tr>\n</table>\n\n\n## Gruppieren\n\nDie Suche unterstützt die Verwendung von Klammern zur Gruppierung von Begriffen, um Teilabfragen zu bilden. Dies kann sehr nützlich sein, wenn Sie die boolesche Logik für eine Abfrage steuern möchten.\n\n<table>\n  <tr>\n    <th>Definition</th>\n    <th>Beispiel</th>\n  </tr>\n  <tr>\n    <td>() – Terme zwischen den Klammern werden gruppiert</td>\n    <td>(Ultimate OR my) AND Repository – findet z.B.. Ultimate Repository, my Repository, schließt z.B. Super Repository. Entweder \"Ultimate\" oder “My” müssen im Ergebnis existieren, “Repository” muss immer enthalten sein.\n </td>\n  </tr>\n</table>\n\n\n## Umgang mit Sonderzeichen\n\nDie Suche unterstützt Sonderzeichen, die Teil der Abfragesyntax sind. Die aktuellen Sonderzeichen der Liste sind\n\n&plus; &minus; && || ! ( ) { } [ ] ^ \" ~ * ? : &bsol; /\n\nUm diese Zeichen zu nutzen, verwenden Sie „&bsol;\" vor dem jeweiligen Zeichen. Um zum Beispiel nach (1+1):2 zu suchen, verwenden Sie diese Abfrage:\n\n&bsol;(1&bsol;+1&bsol;)&bsol;:2\n\nPartiell übersetzt mit www.DeepL.com/Translator (kostenlose Version)\n\nQuelle [https://javadoc.io/static/org.apache.lucene/lucene-queryparser/8.9.0/org/apache/lucene/queryparser/classic/package-summary.html#package.description](https://javadoc.io/static/org.apache.lucene/lucene-queryparser/8.9.0/org/apache/lucene/queryparser/classic/package-summary.html#package.description)" | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+};
+
+declare const useLoginInfo: (disabled?: boolean) => ApiResult<LoginInfo>;
+
+declare const usePluginCenterAuthInfo: () => ApiResult<PluginCenterAuthenticationInfo>;
+declare const usePluginCenterLogout: (authenticationInfo: PluginCenterAuthenticationInfo) => {
+    logout: () => void;
+    isLoading: boolean;
+    error: Error | null;
+};
+
+declare function createChangesetUrl(repository: Repository, source: string, target: string): string;
+declare function createDiffUrl(repository: Repository, source: string, target: string): string;
+declare type UseIncomingChangesetsRequest = {
+    page?: string | number;
+    limit?: number;
+};
+declare const useIncomingChangesets: (repository: Repository, source: string, target: string, request?: UseIncomingChangesetsRequest | undefined) => ApiResultWithFetching<ChangesetCollection>;
+
+declare const createQueryString: (params: Record<string, string>) => string;
+
+declare const requiredLink: (object: HalRepresentation, name: string, subName?: string | undefined) => string;
+declare const objectLink: (object: HalRepresentation, name: string) => string | null;
+
+declare type BaseContext = {
+    onIndexFetched?: (index: IndexResources) => void;
+    onMeFetched?: (me: Me) => void;
+};
+declare type LegacyContext = BaseContext & {
+    initialize: () => void;
+};
+declare const useLegacyContext: () => LegacyContext;
+declare const LegacyContextProvider: FC<BaseContext>;
+
+declare type Props = LegacyContext & {
+    index?: IndexResources;
+    me?: Me;
+    devtools?: boolean;
+};
+declare const ApiProvider: FC<Props>;
+
+declare const clearCache: () => Promise<void>;
+
+export { AdditionalMessage, ApiProvider, Props as ApiProviderProps, ApiResult, ApiResultWithFetching, BackendError, BackendErrorContent, BadGatewayError, BaseContext, CONTENT_TYPE_PUBLIC_KEY, ConflictError, ConvertToInternalRequest, DeleteFunction, ForbiddenError, LegacyContext, LegacyContextProvider, MissingLinkError, NotFoundError, 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, objectLink, requiredLink, urls, useAlerts, useAnnotations, useApiKeys, useArchiveRepository, useAvailableGlobalPermissions, useAvailablePermissions, useAvailablePlugins, useBranch, useBranchDetails, useBranchDetailsCollection, useBranches, useCancelPendingPlugins, 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, useNamespaceStrategies, useNamespaceSuggestions, useNamespaces, useNotificationSubscription, useNotifications, usePaths, usePendingPlugins, usePermissions, usePluginCenterAuthInfo, usePluginCenterLogout, usePublicKeys, useRenameRepository, useRepositories, useRepository, 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, useUserPermissions, useUserSuggestions, useUsers, useVersion, waitForRestartAfter };