@opencloud-eu/web-pkg 0.1.1 → 1.0.0

package/dist/package/src/composables/appDefaults/useAppMeta.d.ts

@@ -0,0 +1,9 @@
+import { AppsStore } from '../piniaStores';
+interface AppMetaOptions {
+    appsStore: AppsStore;
+    applicationId: string;
+}
+export declare function useAppMeta({ appsStore, applicationId }: AppMetaOptions): {
+    applicationMeta: import('vue').ComputedRef<import('../..').ApplicationInformation>;
+};
+export {};

package/dist/package/src/composables/appDefaults/useAppNavigation.d.ts

@@ -0,0 +1,27 @@
+import { Ref } from 'vue';
+import { RouteLocation, Router, RouteParams } from 'vue-router';
+import { MaybeRef } from '../../utils';
+import { FileContext } from './types';
+import { LocationQuery } from '../router';
+import { Resource } from '@opencloud-eu/web-client';
+interface AppNavigationOptions {
+    router: Router;
+    currentFileContext: MaybeRef<FileContext>;
+}
+export interface AppNavigationResult {
+    closeApp(): void;
+    replaceInvalidFileRoute(context: MaybeRef<FileContext>, resource: Resource): boolean;
+    closed: Ref<boolean>;
+}
+export declare const contextRouteNameKey = "contextRouteName";
+export declare const contextRouteParamsKey = "contextRouteParams";
+export declare const contextRouteQueryKey = "contextRouteQuery";
+export declare const routeToContextQuery: (location: RouteLocation) => LocationQuery;
+export declare const contextQueryToFileContextProps: (query: LocationQuery) => {
+    routeName: string;
+    routeParams: RouteParams;
+    routeQuery: LocationQuery;
+};
+export declare const queryItemAsString: (queryItem: string | number | Exclude<string | number, null | undefined>[]) => string;
+export declare function useAppNavigation({ router, currentFileContext }: AppNavigationOptions): AppNavigationResult;
+export {};

package/dist/package/src/composables/appDefaults/useDocumentTitle.d.ts

@@ -0,0 +1,8 @@
+import { Ref } from 'vue';
+import { EventBus } from '../../services';
+interface DocumentTitleOptions {
+    titleSegments: Ref<string[]>;
+    eventBus?: EventBus;
+}
+export declare function useDocumentTitle({ titleSegments, eventBus }: DocumentTitleOptions): void;
+export {};

package/dist/package/src/composables/appProviderService/index.d.ts

@@ -0,0 +1 @@
+export * from './useAppProviderService';

package/dist/package/src/composables/appProviderService/useAppProviderService.d.ts

@@ -0,0 +1,2 @@
+import { AppProviderService } from '../../services';
+export declare const useAppProviderService: () => AppProviderService;

package/dist/package/src/composables/archiverService/index.d.ts

@@ -0,0 +1 @@
+export * from './useArchiverService';

package/dist/package/src/composables/archiverService/useArchiverService.d.ts

@@ -0,0 +1,2 @@
+import { ArchiverService } from '../../services';
+export declare const useArchiverService: () => ArchiverService;

package/dist/package/src/composables/authContext/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useAuthService';
+export * from './useRequest';

package/dist/package/src/composables/authContext/useAuthService.d.ts

@@ -0,0 +1,10 @@
+import { NavigationFailure } from 'vue-router';
+export interface AuthServiceInterface {
+    handleAuthError(route: any, options?: {
+        forceLogout?: boolean;
+    }): any;
+    signinSilent(): Promise<unknown>;
+    logoutUser(): Promise<void | NavigationFailure>;
+    getRefreshToken(): Promise<string>;
+}
+export declare const useAuthService: () => AuthServiceInterface;

package/dist/package/src/composables/authContext/useRequest.d.ts

@@ -0,0 +1,15 @@
+import { Router, RouteLocationNormalizedLoaded } from 'vue-router';
+import { Method, AxiosRequestConfig, AxiosResponse } from 'axios';
+import { ClientService } from '../../services';
+import { AuthStore } from '../piniaStores';
+interface RequestOptions {
+    router?: Router;
+    authStore?: AuthStore;
+    clientService?: ClientService;
+    currentRoute?: RouteLocationNormalizedLoaded;
+}
+export interface RequestResult {
+    makeRequest(method: Method, url: string, config?: AxiosRequestConfig): Promise<AxiosResponse>;
+}
+export declare function useRequest(options?: RequestOptions): RequestResult;
+export {};

package/dist/package/src/composables/breadcrumbs/index.d.ts

@@ -0,0 +1 @@
+export * from './useBreadcrumbsFromPath';

package/dist/package/src/composables/breadcrumbs/useBreadcrumbsFromPath.d.ts

@@ -0,0 +1,14 @@
+import { RouteLocation } from 'vue-router';
+import { BreadcrumbItem } from '@opencloud-eu/design-system/helpers';
+import { SpaceResource } from '@opencloud-eu/web-client';
+import { Ref } from 'vue';
+import { AncestorMetaData } from '../../types';
+export declare const useBreadcrumbsFromPath: () => {
+    breadcrumbsFromPath: ({ route, space, resourcePath, ancestorMetaData }: {
+        route: RouteLocation;
+        space: Ref<SpaceResource>;
+        resourcePath: string;
+        ancestorMetaData?: Ref<AncestorMetaData>;
+    }) => BreadcrumbItem[];
+    concatBreadcrumbs: (...items: BreadcrumbItem[]) => BreadcrumbItem[];
+};

package/dist/package/src/composables/clientService/index.d.ts

@@ -0,0 +1 @@
+export * from './useClientService';

package/dist/package/src/composables/clientService/useClientService.d.ts

@@ -0,0 +1,2 @@
+import { ClientService } from '../../services';
+export declare const useClientService: () => ClientService;

package/dist/package/src/composables/clipboard/index.d.ts

@@ -0,0 +1 @@
+export * from './useClipboard';

package/dist/package/src/composables/clipboard/useClipboard.d.ts

@@ -0,0 +1,3 @@
+export declare const useClipboard: () => {
+    copyToClipboard: (quickLinkUrl: string) => Promise<void>;
+};

package/dist/package/src/composables/download/index.d.ts

@@ -0,0 +1 @@
+export * from './useDownloadFile';

package/dist/package/src/composables/download/useDownloadFile.d.ts

@@ -0,0 +1,8 @@
+import { ClientService } from '../../services';
+import { Resource, SpaceResource } from '@opencloud-eu/web-client';
+export interface DownloadFileOptions {
+    clientService?: ClientService;
+}
+export declare const useDownloadFile: (options?: DownloadFileOptions) => {
+    downloadFile: (space: SpaceResource, file: Resource, version?: string) => Promise<void>;
+};

package/dist/package/src/composables/driveResolver/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useDriveResolver';
+export * from './useSpacesLoading';

package/dist/package/src/composables/driveResolver/useDriveResolver.d.ts

@@ -0,0 +1,13 @@
+import { Ref } from 'vue';
+import { SpaceResource } from '@opencloud-eu/web-client';
+interface DriveResolverOptions {
+    driveAliasAndItem?: Ref<string>;
+}
+interface DriveResolverResult {
+    space: Ref<SpaceResource>;
+    item: Ref<string>;
+    itemId: Ref<string>;
+    loading: Ref<boolean>;
+}
+export declare const useDriveResolver: (options?: DriveResolverOptions) => DriveResolverResult;
+export {};

package/dist/package/src/composables/driveResolver/useSpacesLoading.d.ts

@@ -0,0 +1,3 @@
+export declare const useSpacesLoading: () => {
+    areSpacesLoading: import('vue').ComputedRef<boolean>;
+};

package/dist/package/src/composables/embedMode/index.d.ts

@@ -0,0 +1 @@
+export * from './useEmbedMode';

package/dist/package/src/composables/embedMode/useEmbedMode.d.ts

@@ -0,0 +1,23 @@
+import { Resource } from '@opencloud-eu/web-client';
+import { LocationQuery } from '../router';
+export interface embedModeFilePickMessageData {
+    resource: Resource;
+    locationQuery: LocationQuery;
+}
+export interface embedModeLocationPickMessageData {
+    resources: Resource[];
+    fileName?: string;
+    locationQuery?: LocationQuery;
+}
+export declare const useEmbedMode: () => {
+    isEnabled: import('vue').ComputedRef<boolean>;
+    isLocationPicker: import('vue').ComputedRef<boolean>;
+    chooseFileName: import('vue').ComputedRef<boolean>;
+    chooseFileNameSuggestion: import('vue').ComputedRef<string>;
+    isFilePicker: import('vue').ComputedRef<boolean>;
+    messagesTargetOrigin: import('vue').ComputedRef<string>;
+    isDelegatingAuthentication: import('vue').ComputedRef<boolean>;
+    fileTypes: import('vue').ComputedRef<string[]>;
+    postMessage: <Payload>(name: string, data?: Payload) => void;
+    verifyDelegatedAuthenticationOrigin: (eventOrigin: string) => boolean;
+};

package/dist/package/src/composables/eventBus/index.d.ts

@@ -0,0 +1 @@
+export * from './useEventBus';

package/dist/package/src/composables/eventBus/useEventBus.d.ts

@@ -0,0 +1 @@
+export declare const useEventBus: () => import('../..').EventBus;

package/dist/package/src/composables/fileListHeaderPosition/index.d.ts

@@ -0,0 +1 @@
+export * from './useFileListHeaderPosition';

package/dist/package/src/composables/fileListHeaderPosition/useFileListHeaderPosition.d.ts

@@ -0,0 +1,5 @@
+import { Ref } from 'vue';
+export declare const useFileListHeaderPosition: (selector?: string) => {
+    y: Ref;
+    refresh: () => void;
+};

package/dist/package/src/composables/filesList/index.d.ts

@@ -0,0 +1 @@
+export * from './useResourceRouteResolver';

package/dist/package/src/composables/filesList/useResourceRouteResolver.d.ts

@@ -0,0 +1,13 @@
+import { Ref } from 'vue';
+import { CreateTargetRouteOptions } from '../../helpers/folderLink/types';
+import { Resource, SpaceResource } from '@opencloud-eu/web-client';
+import { ConfigStore } from '../piniaStores';
+export type ResourceRouteResolverOptions = {
+    configStore?: ConfigStore;
+    targetRouteCallback?: Ref<(arg: CreateTargetRouteOptions) => unknown>;
+    space?: Ref<SpaceResource>;
+};
+export declare const useResourceRouteResolver: (options?: ResourceRouteResolverOptions, context?: any) => {
+    createFileAction: (resource: Resource) => void;
+    createFolderLink: (createTargetRouteOptions: CreateTargetRouteOptions) => unknown;
+};

package/dist/package/src/composables/folderLink/index.d.ts

@@ -0,0 +1 @@
+export * from './useFolderLink';

package/dist/package/src/composables/folderLink/useFolderLink.d.ts

@@ -0,0 +1,15 @@
+import { Resource } from '@opencloud-eu/web-client';
+import { ResourceRouteResolverOptions } from '../filesList';
+export declare const useFolderLink: (options?: ResourceRouteResolverOptions) => {
+    getPathPrefix: (resource: Resource) => string;
+    getFolderLink: (resource: Resource) => unknown;
+    getParentFolderLink: (resource: Resource) => unknown;
+    getParentFolderName: (resource: Resource) => string;
+    getParentFolderLinkIconAdditionalAttributes: (resource: Resource) => {
+        name: string;
+        'fill-type': string;
+    } | {
+        name?: undefined;
+        'fill-type'?: undefined;
+    };
+};

package/dist/package/src/composables/index.d.ts

@@ -0,0 +1,40 @@
+export * from './ability';
+export * from './actions';
+export * from './appDefaults';
+export * from './appProviderService';
+export * from './archiverService';
+export * from './authContext';
+export * from './breadcrumbs';
+export * from './clientService';
+export * from './clipboard';
+export * from './download';
+export * from './driveResolver';
+export * from './embedMode';
+export * from './eventBus';
+export * from './fileListHeaderPosition';
+export * from './filesList';
+export * from './folderLink';
+export * from './isTopBarSticky';
+export * from './keyboardActions';
+export * from './links';
+export * from './loadingService';
+export * from './localStorage';
+export * from './pagination';
+export * from './passwordPolicyService';
+export * from './piniaStores';
+export * from './portalTarget';
+export * from './previewService';
+export * from './requestHeaders';
+export * from './resources';
+export * from './router';
+export * from './scrollTo';
+export * from './search';
+export * from './selection';
+export * from './service';
+export * from './shares';
+export * from './sideBar';
+export * from './sort';
+export * from './spaces';
+export * from './upload';
+export * from './viewMode';
+export * from './webWorkers';

package/dist/package/src/composables/isTopBarSticky/index.d.ts

@@ -0,0 +1 @@
+export * from './useIsTopBarSticky';

package/dist/package/src/composables/isTopBarSticky/useIsTopBarSticky.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Determines if the topbar (including table headers) should be sticky or not.
+ * With a vertical height less than 500px, the topbar should not be sticky because
+ * it takes up too much space and overflows content.
+ */
+export declare const useIsTopBarSticky: () => {
+    isSticky: import('vue').Ref<boolean, boolean>;
+};

package/dist/package/src/composables/keyboardActions/index.d.ts

@@ -0,0 +1 @@
+export * from './useKeyboardActions';

package/dist/package/src/composables/keyboardActions/useKeyboardActions.d.ts

@@ -0,0 +1,39 @@
+import { Ref } from 'vue';
+interface KeyboardActionsOptions {
+    skipDisabledKeyBindingsCheck?: boolean;
+}
+export declare enum Key {
+    C = "c",
+    V = "v",
+    X = "x",
+    A = "a",
+    S = "s",
+    Space = " ",
+    ArrowUp = "ArrowUp",
+    ArrowDown = "ArrowDown",
+    ArrowLeft = "ArrowLeft",
+    ArrowRight = "ArrowRight",
+    Esc = "Escape"
+}
+export declare enum Modifier {
+    Ctrl = "Control",
+    Shift = "Shift"
+}
+export interface KeyboardActions {
+    actions: Ref<Array<KeyboardAction>>;
+    selectionCursor: Ref<number>;
+    removeKeyAction: (id: string) => void;
+    resetSelectionCursor: () => void;
+    bindKeyAction: (keys: {
+        primary: Key;
+        modifier?: Modifier;
+    }, callback: () => void) => string;
+}
+export interface KeyboardAction {
+    id: string;
+    primary: Key;
+    modifier: Modifier | null;
+    callback: (event: KeyboardEvent) => void;
+}
+export declare const useKeyboardActions: (options?: KeyboardActionsOptions) => KeyboardActions;
+export {};

package/dist/package/src/composables/links/index.d.ts

@@ -0,0 +1 @@
+export * from './useLinkTypes';

package/dist/package/src/composables/links/useLinkTypes.d.ts

@@ -0,0 +1,36 @@
+import { SharingLinkType } from '@opencloud-eu/web-client/graph/generated';
+import { ShareRole } from '@opencloud-eu/web-client';
+export declare const useLinkTypes: () => {
+    defaultLinkType: import('vue').ComputedRef<SharingLinkType>;
+    isPasswordEnforcedForLinkType: (type: SharingLinkType) => boolean;
+    getAvailableLinkTypes: ({ isFolder }: {
+        isFolder: boolean;
+    }) => SharingLinkType[];
+    linkShareRoles: ({
+        id: "internal";
+        displayName: string;
+        description: string;
+        icon: string;
+    } | {
+        id: "view";
+        displayName: string;
+        description: string;
+        icon: string;
+    } | {
+        id: "upload";
+        displayName: string;
+        description: string;
+        icon: string;
+    } | {
+        id: "edit";
+        displayName: string;
+        description: string;
+        icon: string;
+    } | {
+        id: "createOnly";
+        displayName: string;
+        description: string;
+        icon: string;
+    })[];
+    getLinkRoleByType: (type: SharingLinkType) => ShareRole;
+};

package/dist/package/src/composables/loadingService/index.d.ts

@@ -0,0 +1 @@
+export * from './useLoadingService';

package/dist/package/src/composables/loadingService/useLoadingService.d.ts

@@ -0,0 +1,2 @@
+import { LoadingService } from '../../services';
+export declare const useLoadingService: () => LoadingService;

package/dist/package/src/composables/localStorage/index.d.ts

@@ -0,0 +1 @@
+export * from './useLocalStorage';

package/dist/package/src/composables/localStorage/useLocalStorage.d.ts

@@ -0,0 +1,2 @@
+import { Ref } from 'vue';
+export declare const useLocalStorage: <T>(key: string, defaultValue?: T) => [T] extends [Ref<any, any>] ? import('../../../../node_modules/@vue/shared').IfAny<T, Ref<T, T>, T> : Ref<import('vue').UnwrapRef<T>, T | import('vue').UnwrapRef<T>>;

package/dist/package/src/composables/pagination/constants.d.ts

@@ -0,0 +1,5 @@
+export declare abstract class PaginationConstants {
+    static readonly perPageDefault: string;
+    static readonly perPageQueryName: string;
+    static readonly options: string[];
+}

package/dist/package/src/composables/pagination/index.d.ts

@@ -0,0 +1,2 @@
+export * from './usePagination';
+export * from './constants';

package/dist/package/src/composables/pagination/usePagination.d.ts

@@ -0,0 +1,17 @@
+import { ComputedRef, MaybeRef } from 'vue';
+interface PaginationOptions<T> {
+    items: MaybeRef<Array<T>>;
+    page?: MaybeRef<number>;
+    perPage?: MaybeRef<number>;
+    perPageDefault?: string;
+    perPageQueryName?: string;
+    perPageStoragePrefix: string;
+}
+interface PaginationResult<T> {
+    items: ComputedRef<Array<T>>;
+    total: ComputedRef<number>;
+    page: ComputedRef<number>;
+    perPage: ComputedRef<number>;
+}
+export declare function usePagination<T>(options: PaginationOptions<T>): PaginationResult<T>;
+export {};

package/dist/package/src/composables/passwordPolicyService/index.d.ts

@@ -0,0 +1 @@
+export * from './usePasswordPolicyService';

package/dist/package/src/composables/passwordPolicyService/usePasswordPolicyService.d.ts

@@ -0,0 +1,2 @@
+import { PasswordPolicyService } from '../../services/passwordPolicy';
+export declare const usePasswordPolicyService: () => PasswordPolicyService;

package/dist/package/src/composables/piniaStores/apps.d.ts

@@ -0,0 +1,157 @@
+import { AppConfigObject, ApplicationInformation, ApplicationFileExtension } from '../../apps';
+import { Translations } from 'vue3-gettext';
+export declare const useAppsStore: import('pinia').StoreDefinition<"apps", Pick<{
+    apps: import('vue').Ref<Record<string, ApplicationInformation>, Record<string, ApplicationInformation>>;
+    externalAppConfig: import('vue').Ref<Record<string, AppConfigObject>, Record<string, AppConfigObject>>;
+    appIds: import('vue').ComputedRef<string[]>;
+    fileExtensions: import('vue').Ref<{
+        app?: string;
+        extension?: string;
+        createFileHandler?: (arg: {
+            fileName: string;
+            space: import('@opencloud-eu/web-client').SpaceResource;
+            currentFolder: import('@opencloud-eu/web-client').Resource;
+        }) => Promise<import('@opencloud-eu/web-client').Resource>;
+        hasPriority?: boolean;
+        label?: string | (() => string);
+        name?: string;
+        icon?: string;
+        mimeType?: string;
+        newFileMenu?: {
+            menuTitle: () => string;
+        };
+        routeName?: string;
+        secureView?: boolean;
+    }[], ApplicationFileExtension[] | {
+        app?: string;
+        extension?: string;
+        createFileHandler?: (arg: {
+            fileName: string;
+            space: import('@opencloud-eu/web-client').SpaceResource;
+            currentFolder: import('@opencloud-eu/web-client').Resource;
+        }) => Promise<import('@opencloud-eu/web-client').Resource>;
+        hasPriority?: boolean;
+        label?: string | (() => string);
+        name?: string;
+        icon?: string;
+        mimeType?: string;
+        newFileMenu?: {
+            menuTitle: () => string;
+        };
+        routeName?: string;
+        secureView?: boolean;
+    }[]>;
+    registerApp: (appInfo: ApplicationInformation, translations?: Translations) => void;
+    registerFileExtension: ({ appId, data }: {
+        appId: string;
+        data: ApplicationFileExtension;
+    }) => void;
+    loadExternalAppConfig: ({ appId, config }: {
+        appId: string;
+        config: AppConfigObject;
+    }) => void;
+    isAppEnabled: (appId: string) => boolean;
+}, "apps" | "externalAppConfig" | "fileExtensions">, Pick<{
+    apps: import('vue').Ref<Record<string, ApplicationInformation>, Record<string, ApplicationInformation>>;
+    externalAppConfig: import('vue').Ref<Record<string, AppConfigObject>, Record<string, AppConfigObject>>;
+    appIds: import('vue').ComputedRef<string[]>;
+    fileExtensions: import('vue').Ref<{
+        app?: string;
+        extension?: string;
+        createFileHandler?: (arg: {
+            fileName: string;
+            space: import('@opencloud-eu/web-client').SpaceResource;
+            currentFolder: import('@opencloud-eu/web-client').Resource;
+        }) => Promise<import('@opencloud-eu/web-client').Resource>;
+        hasPriority?: boolean;
+        label?: string | (() => string);
+        name?: string;
+        icon?: string;
+        mimeType?: string;
+        newFileMenu?: {
+            menuTitle: () => string;
+        };
+        routeName?: string;
+        secureView?: boolean;
+    }[], ApplicationFileExtension[] | {
+        app?: string;
+        extension?: string;
+        createFileHandler?: (arg: {
+            fileName: string;
+            space: import('@opencloud-eu/web-client').SpaceResource;
+            currentFolder: import('@opencloud-eu/web-client').Resource;
+        }) => Promise<import('@opencloud-eu/web-client').Resource>;
+        hasPriority?: boolean;
+        label?: string | (() => string);
+        name?: string;
+        icon?: string;
+        mimeType?: string;
+        newFileMenu?: {
+            menuTitle: () => string;
+        };
+        routeName?: string;
+        secureView?: boolean;
+    }[]>;
+    registerApp: (appInfo: ApplicationInformation, translations?: Translations) => void;
+    registerFileExtension: ({ appId, data }: {
+        appId: string;
+        data: ApplicationFileExtension;
+    }) => void;
+    loadExternalAppConfig: ({ appId, config }: {
+        appId: string;
+        config: AppConfigObject;
+    }) => void;
+    isAppEnabled: (appId: string) => boolean;
+}, "appIds">, Pick<{
+    apps: import('vue').Ref<Record<string, ApplicationInformation>, Record<string, ApplicationInformation>>;
+    externalAppConfig: import('vue').Ref<Record<string, AppConfigObject>, Record<string, AppConfigObject>>;
+    appIds: import('vue').ComputedRef<string[]>;
+    fileExtensions: import('vue').Ref<{
+        app?: string;
+        extension?: string;
+        createFileHandler?: (arg: {
+            fileName: string;
+            space: import('@opencloud-eu/web-client').SpaceResource;
+            currentFolder: import('@opencloud-eu/web-client').Resource;
+        }) => Promise<import('@opencloud-eu/web-client').Resource>;
+        hasPriority?: boolean;
+        label?: string | (() => string);
+        name?: string;
+        icon?: string;
+        mimeType?: string;
+        newFileMenu?: {
+            menuTitle: () => string;
+        };
+        routeName?: string;
+        secureView?: boolean;
+    }[], ApplicationFileExtension[] | {
+        app?: string;
+        extension?: string;
+        createFileHandler?: (arg: {
+            fileName: string;
+            space: import('@opencloud-eu/web-client').SpaceResource;
+            currentFolder: import('@opencloud-eu/web-client').Resource;
+        }) => Promise<import('@opencloud-eu/web-client').Resource>;
+        hasPriority?: boolean;
+        label?: string | (() => string);
+        name?: string;
+        icon?: string;
+        mimeType?: string;
+        newFileMenu?: {
+            menuTitle: () => string;
+        };
+        routeName?: string;
+        secureView?: boolean;
+    }[]>;
+    registerApp: (appInfo: ApplicationInformation, translations?: Translations) => void;
+    registerFileExtension: ({ appId, data }: {
+        appId: string;
+        data: ApplicationFileExtension;
+    }) => void;
+    loadExternalAppConfig: ({ appId, config }: {
+        appId: string;
+        config: AppConfigObject;
+    }) => void;
+    isAppEnabled: (appId: string) => boolean;
+}, "registerApp" | "registerFileExtension" | "loadExternalAppConfig" | "isAppEnabled">>;
+export type AppsStore = ReturnType<typeof useAppsStore>;