@opencloud-eu/web-pkg 4.0.0 → 4.1.0

package/dist/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/src/composables/keyboardActions/index.d.ts

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

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

@@ -0,0 +1,4 @@
+import { Ref } from 'vue';
+export declare const useCropperKeyboardActions: () => {
+    setCropperInstance: (cropper: Ref<Cropper>) => void;
+};

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

@@ -0,0 +1,4 @@
+import { Resource } from '@opencloud-eu/web-client';
+export declare function useInterceptModifierClick(): {
+    interceptModifierClick: (event: MouseEvent | undefined, resource: Resource) => boolean;
+};

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

@@ -0,0 +1,47 @@
+import { Ref } from 'vue';
+interface KeyboardActionsOptions {
+    skipDisabledKeyBindingsCheck?: boolean;
+}
+export declare enum Key {
+    C = "c",
+    V = "v",
+    X = "x",
+    A = "a",
+    S = "s",
+    Z = "z",
+    Plus = "+",
+    Minus = "-",
+    Space = " ",
+    ArrowUp = "ArrowUp",
+    ArrowDown = "ArrowDown",
+    ArrowLeft = "ArrowLeft",
+    ArrowRight = "ArrowRight",
+    Esc = "Escape",
+    Backspace = "Backspace",
+    Delete = "Delete"
+}
+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: (event: KeyboardEvent) => void, options?: {
+        preventDefault?: boolean;
+    }) => string;
+}
+export interface KeyboardAction {
+    id: string;
+    primary: Key;
+    modifier: Modifier | null;
+    preventDefault: boolean;
+    callback: (event: KeyboardEvent) => void;
+}
+export declare const useKeyboardActions: (options?: KeyboardActionsOptions) => KeyboardActions;
+export {};

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

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

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

@@ -0,0 +1,31 @@
+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: "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/src/composables/loadingService/index.d.ts

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

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

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

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

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

package/dist/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/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/src/composables/pagination/index.d.ts

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

package/dist/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/src/composables/passwordPolicyService/index.d.ts

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

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

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

package/dist/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>;

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

@@ -0,0 +1,60 @@
+import { PublicLinkType } from '@opencloud-eu/web-client';
+export declare const useAuthStore: import('pinia').StoreDefinition<"auth", Pick<{
+    accessToken: import('vue').Ref<string, string>;
+    idpContextReady: import('vue').Ref<boolean, boolean>;
+    userContextReady: import('vue').Ref<boolean, boolean>;
+    publicLinkToken: import('vue').Ref<string, string>;
+    publicLinkPassword: import('vue').Ref<string, string>;
+    publicLinkType: import('vue').Ref<PublicLinkType, PublicLinkType>;
+    publicLinkContextReady: import('vue').Ref<boolean, boolean>;
+    setAccessToken: (value: string) => void;
+    setIdpContextReady: (value: boolean) => void;
+    setUserContextReady: (value: boolean) => void;
+    setPublicLinkContext: (context: {
+        publicLinkToken: string;
+        publicLinkPassword: string;
+        publicLinkType: PublicLinkType;
+        publicLinkContextReady: boolean;
+    }) => void;
+    clearUserContext: () => void;
+    clearPublicLinkContext: () => void;
+}, "publicLinkPassword" | "publicLinkType" | "accessToken" | "idpContextReady" | "userContextReady" | "publicLinkToken" | "publicLinkContextReady">, Pick<{
+    accessToken: import('vue').Ref<string, string>;
+    idpContextReady: import('vue').Ref<boolean, boolean>;
+    userContextReady: import('vue').Ref<boolean, boolean>;
+    publicLinkToken: import('vue').Ref<string, string>;
+    publicLinkPassword: import('vue').Ref<string, string>;
+    publicLinkType: import('vue').Ref<PublicLinkType, PublicLinkType>;
+    publicLinkContextReady: import('vue').Ref<boolean, boolean>;
+    setAccessToken: (value: string) => void;
+    setIdpContextReady: (value: boolean) => void;
+    setUserContextReady: (value: boolean) => void;
+    setPublicLinkContext: (context: {
+        publicLinkToken: string;
+        publicLinkPassword: string;
+        publicLinkType: PublicLinkType;
+        publicLinkContextReady: boolean;
+    }) => void;
+    clearUserContext: () => void;
+    clearPublicLinkContext: () => void;
+}, never>, Pick<{
+    accessToken: import('vue').Ref<string, string>;
+    idpContextReady: import('vue').Ref<boolean, boolean>;
+    userContextReady: import('vue').Ref<boolean, boolean>;
+    publicLinkToken: import('vue').Ref<string, string>;
+    publicLinkPassword: import('vue').Ref<string, string>;
+    publicLinkType: import('vue').Ref<PublicLinkType, PublicLinkType>;
+    publicLinkContextReady: import('vue').Ref<boolean, boolean>;
+    setAccessToken: (value: string) => void;
+    setIdpContextReady: (value: boolean) => void;
+    setUserContextReady: (value: boolean) => void;
+    setPublicLinkContext: (context: {
+        publicLinkToken: string;
+        publicLinkPassword: string;
+        publicLinkType: PublicLinkType;
+        publicLinkContextReady: boolean;
+    }) => void;
+    clearUserContext: () => void;
+    clearPublicLinkContext: () => void;
+}, "setAccessToken" | "setIdpContextReady" | "setUserContextReady" | "setPublicLinkContext" | "clearUserContext" | "clearPublicLinkContext">>;
+export type AuthStore = ReturnType<typeof useAuthStore>;

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

@@ -0,0 +1,27 @@
+import { default as PQueue } from 'p-queue';
+export declare const useAvatarsStore: import('pinia').StoreDefinition<"avatars", Pick<{
+    avatarMap: import('vue').Ref<Record<string, string>, Record<string, string>>;
+    getAvatar: (userId: string) => string;
+    addAvatar: (userId: string, avatar: string) => void;
+    removeAvatar: (userId: string) => void;
+    reset: () => void;
+    avatarsQueue: import('vue').Raw<PQueue<import('node_modules/p-queue/dist/priority-queue').default, import('p-queue').QueueAddOptions>>;
+    pendingAvatarsRequests: Map<string, Promise<any>>;
+}, "avatarMap" | "avatarsQueue" | "pendingAvatarsRequests">, Pick<{
+    avatarMap: import('vue').Ref<Record<string, string>, Record<string, string>>;
+    getAvatar: (userId: string) => string;
+    addAvatar: (userId: string, avatar: string) => void;
+    removeAvatar: (userId: string) => void;
+    reset: () => void;
+    avatarsQueue: import('vue').Raw<PQueue<import('node_modules/p-queue/dist/priority-queue').default, import('p-queue').QueueAddOptions>>;
+    pendingAvatarsRequests: Map<string, Promise<any>>;
+}, never>, Pick<{
+    avatarMap: import('vue').Ref<Record<string, string>, Record<string, string>>;
+    getAvatar: (userId: string) => string;
+    addAvatar: (userId: string, avatar: string) => void;
+    removeAvatar: (userId: string) => void;
+    reset: () => void;
+    avatarsQueue: import('vue').Raw<PQueue<import('node_modules/p-queue/dist/priority-queue').default, import('p-queue').QueueAddOptions>>;
+    pendingAvatarsRequests: Map<string, Promise<any>>;
+}, "reset" | "getAvatar" | "addAvatar" | "removeAvatar">>;
+export type AvatarsStore = ReturnType<typeof useAvatarsStore>;