@opencloud-eu/web-pkg 4.0.0 → 4.1.0

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

@@ -0,0 +1,514 @@
+import { z } from 'zod';
+import { ShareRole } from '@opencloud-eu/web-client';
+declare const WebTheme: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    slogan: z.ZodOptional<z.ZodString>;
+    logo: z.ZodOptional<z.ZodString>;
+    logoMobile: z.ZodOptional<z.ZodString>;
+    urls: z.ZodOptional<z.ZodObject<{
+        accessDeniedHelp: z.ZodOptional<z.ZodString>;
+        imprint: z.ZodOptional<z.ZodString>;
+        privacy: z.ZodOptional<z.ZodString>;
+        accessibility: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    shareRoles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        iconName: z.ZodString;
+    }, z.core.$strip>>>;
+    designTokens: z.ZodOptional<z.ZodObject<{
+        roles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        colorPalette: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        fontFamily: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    favicon: z.ZodOptional<z.ZodString>;
+    background: z.ZodOptional<z.ZodString>;
+    isDark: z.ZodBoolean;
+    label: z.ZodString;
+}, z.core.$strip>;
+export declare const WebThemeConfig: z.ZodObject<{
+    defaults: z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        slogan: z.ZodOptional<z.ZodString>;
+        logo: z.ZodOptional<z.ZodString>;
+        logoMobile: z.ZodOptional<z.ZodString>;
+        urls: z.ZodOptional<z.ZodObject<{
+            accessDeniedHelp: z.ZodOptional<z.ZodString>;
+            imprint: z.ZodOptional<z.ZodString>;
+            privacy: z.ZodOptional<z.ZodString>;
+            accessibility: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        shareRoles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            iconName: z.ZodString;
+        }, z.core.$strip>>>;
+        designTokens: z.ZodOptional<z.ZodObject<{
+            roles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            colorPalette: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            fontFamily: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        favicon: z.ZodOptional<z.ZodString>;
+        background: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    themes: z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        slogan: z.ZodOptional<z.ZodString>;
+        logo: z.ZodOptional<z.ZodString>;
+        logoMobile: z.ZodOptional<z.ZodString>;
+        urls: z.ZodOptional<z.ZodObject<{
+            accessDeniedHelp: z.ZodOptional<z.ZodString>;
+            imprint: z.ZodOptional<z.ZodString>;
+            privacy: z.ZodOptional<z.ZodString>;
+            accessibility: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        shareRoles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            iconName: z.ZodString;
+        }, z.core.$strip>>>;
+        designTokens: z.ZodOptional<z.ZodObject<{
+            roles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            colorPalette: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            fontFamily: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        favicon: z.ZodOptional<z.ZodString>;
+        background: z.ZodOptional<z.ZodString>;
+        isDark: z.ZodBoolean;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const ThemeConfig: z.ZodObject<{
+    common: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        slogan: z.ZodOptional<z.ZodString>;
+        logo: z.ZodOptional<z.ZodString>;
+        logoMobile: z.ZodOptional<z.ZodString>;
+        urls: z.ZodOptional<z.ZodObject<{
+            accessDeniedHelp: z.ZodOptional<z.ZodString>;
+            imprint: z.ZodOptional<z.ZodString>;
+            privacy: z.ZodOptional<z.ZodString>;
+            accessibility: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        shareRoles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            iconName: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    clients: z.ZodObject<{
+        web: z.ZodObject<{
+            defaults: z.ZodObject<{
+                name: z.ZodOptional<z.ZodString>;
+                slogan: z.ZodOptional<z.ZodString>;
+                logo: z.ZodOptional<z.ZodString>;
+                logoMobile: z.ZodOptional<z.ZodString>;
+                urls: z.ZodOptional<z.ZodObject<{
+                    accessDeniedHelp: z.ZodOptional<z.ZodString>;
+                    imprint: z.ZodOptional<z.ZodString>;
+                    privacy: z.ZodOptional<z.ZodString>;
+                    accessibility: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                shareRoles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+                    iconName: z.ZodString;
+                }, z.core.$strip>>>;
+                designTokens: z.ZodOptional<z.ZodObject<{
+                    roles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+                    colorPalette: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+                    fontFamily: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                favicon: z.ZodOptional<z.ZodString>;
+                background: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            themes: z.ZodArray<z.ZodObject<{
+                name: z.ZodOptional<z.ZodString>;
+                slogan: z.ZodOptional<z.ZodString>;
+                logo: z.ZodOptional<z.ZodString>;
+                logoMobile: z.ZodOptional<z.ZodString>;
+                urls: z.ZodOptional<z.ZodObject<{
+                    accessDeniedHelp: z.ZodOptional<z.ZodString>;
+                    imprint: z.ZodOptional<z.ZodString>;
+                    privacy: z.ZodOptional<z.ZodString>;
+                    accessibility: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                shareRoles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+                    iconName: z.ZodString;
+                }, z.core.$strip>>>;
+                designTokens: z.ZodOptional<z.ZodObject<{
+                    roles: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+                    colorPalette: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+                    fontFamily: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                favicon: z.ZodOptional<z.ZodString>;
+                background: z.ZodOptional<z.ZodString>;
+                isDark: z.ZodBoolean;
+                label: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type WebThemeType = z.infer<typeof WebTheme>;
+export type ThemeConfigType = z.infer<typeof ThemeConfig>;
+export declare const useThemeStore: import('pinia').StoreDefinition<"theme", Pick<{
+    availableThemes: import('vue').Ref<{
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[], {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[] | {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[]>;
+    currentTheme: import('vue').Ref<{
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }, {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }>;
+    initializeThemes: (themeConfig: ThemeConfigType) => void;
+    setAndApplyTheme: (theme: WebThemeType, updateStorage?: boolean) => void;
+    setAutoSystemTheme: () => void;
+    isCurrentThemeAutoSystem: import('vue').ComputedRef<boolean>;
+    getRoleIcon: (role: ShareRole) => string;
+}, "availableThemes" | "currentTheme">, Pick<{
+    availableThemes: import('vue').Ref<{
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[], {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[] | {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[]>;
+    currentTheme: import('vue').Ref<{
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }, {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }>;
+    initializeThemes: (themeConfig: ThemeConfigType) => void;
+    setAndApplyTheme: (theme: WebThemeType, updateStorage?: boolean) => void;
+    setAutoSystemTheme: () => void;
+    isCurrentThemeAutoSystem: import('vue').ComputedRef<boolean>;
+    getRoleIcon: (role: ShareRole) => string;
+}, "isCurrentThemeAutoSystem">, Pick<{
+    availableThemes: import('vue').Ref<{
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[], {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[] | {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }[]>;
+    currentTheme: import('vue').Ref<{
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }, {
+        isDark: boolean;
+        label: string;
+        name?: string;
+        slogan?: string;
+        logo?: string;
+        logoMobile?: string;
+        urls?: {
+            accessDeniedHelp?: string;
+            imprint?: string;
+            privacy?: string;
+            accessibility?: string;
+        };
+        shareRoles?: Record<string, {
+            iconName: string;
+        }>;
+        designTokens?: {
+            roles?: Record<string, string>;
+            colorPalette?: Record<string, string>;
+            fontFamily?: string;
+        };
+        favicon?: string;
+        background?: string;
+    }>;
+    initializeThemes: (themeConfig: ThemeConfigType) => void;
+    setAndApplyTheme: (theme: WebThemeType, updateStorage?: boolean) => void;
+    setAutoSystemTheme: () => void;
+    isCurrentThemeAutoSystem: import('vue').ComputedRef<boolean>;
+    getRoleIcon: (role: ShareRole) => string;
+}, "initializeThemes" | "setAndApplyTheme" | "setAutoSystemTheme" | "getRoleIcon">>;
+export {};

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

@@ -0,0 +1,24 @@
+import { Updates } from '../../types';
+export declare const useUpdatesStore: import('pinia').StoreDefinition<"updates", Pick<{
+    updates: import('vue').Ref<Updates, Updates>;
+    isLoading: import('vue').Ref<boolean, boolean>;
+    hasError: import('vue').Ref<boolean, boolean>;
+    setUpdates: (data: Updates) => void;
+    setHasError: (value: boolean) => void;
+    setIsLoading: (value: boolean) => void;
+}, "hasError" | "isLoading" | "updates">, Pick<{
+    updates: import('vue').Ref<Updates, Updates>;
+    isLoading: import('vue').Ref<boolean, boolean>;
+    hasError: import('vue').Ref<boolean, boolean>;
+    setUpdates: (data: Updates) => void;
+    setHasError: (value: boolean) => void;
+    setIsLoading: (value: boolean) => void;
+}, never>, Pick<{
+    updates: import('vue').Ref<Updates, Updates>;
+    isLoading: import('vue').Ref<boolean, boolean>;
+    hasError: import('vue').Ref<boolean, boolean>;
+    setUpdates: (data: Updates) => void;
+    setHasError: (value: boolean) => void;
+    setIsLoading: (value: boolean) => void;
+}, "setUpdates" | "setHasError" | "setIsLoading">>;
+export type UpdatesStore = ReturnType<typeof useUpdatesStore>;

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

@@ -0,0 +1,15 @@
+import { User } from '@opencloud-eu/web-client/graph/generated';
+export declare const useUserStore: import('pinia').StoreDefinition<"user", Pick<{
+    user: import('vue').Ref<User, User>;
+    setUser: (data: User) => void;
+    reset: () => void;
+}, "user">, Pick<{
+    user: import('vue').Ref<User, User>;
+    setUser: (data: User) => void;
+    reset: () => void;
+}, never>, Pick<{
+    user: import('vue').Ref<User, User>;
+    setUser: (data: User) => void;
+    reset: () => void;
+}, "setUser" | "reset">>;
+export type UserStore = ReturnType<typeof useUserStore>;

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

@@ -0,0 +1,29 @@
+import { UseWebWorkerReturn } from '@vueuse/core';
+export interface WebWorker<T = any> extends UseWebWorkerReturn<T> {
+    id: string;
+    needsTokenRenewal: boolean;
+}
+export type WorkerTopic = 'startProcess' | 'tokenUpdate';
+export declare const useWebWorkersStore: import('pinia').StoreDefinition<"webWorkers", Pick<{
+    createWorker: <T = any>(workerUrl: string, { needsTokenRenewal }?: {
+        needsTokenRenewal?: boolean;
+    }) => WebWorker<T>;
+    terminateWorker: (id: string) => void;
+    terminateAllWorkers: () => void;
+    updateAccessTokens: (accessToken: string) => void;
+}, never>, Pick<{
+    createWorker: <T = any>(workerUrl: string, { needsTokenRenewal }?: {
+        needsTokenRenewal?: boolean;
+    }) => WebWorker<T>;
+    terminateWorker: (id: string) => void;
+    terminateAllWorkers: () => void;
+    updateAccessTokens: (accessToken: string) => void;
+}, never>, Pick<{
+    createWorker: <T = any>(workerUrl: string, { needsTokenRenewal }?: {
+        needsTokenRenewal?: boolean;
+    }) => WebWorker<T>;
+    terminateWorker: (id: string) => void;
+    terminateAllWorkers: () => void;
+    updateAccessTokens: (accessToken: string) => void;
+}, "createWorker" | "terminateWorker" | "terminateAllWorkers" | "updateAccessTokens">>;
+export type WebWorkersStore = ReturnType<typeof useWebWorkersStore>;

package/dist/src/composables/portalTarget/eventTopics.d.ts

@@ -0,0 +1,3 @@
+export declare enum PortalTargetEventTopics {
+    mounted = "portal-target.mounted"
+}

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

@@ -0,0 +1,2 @@
+export * from './eventTopics';
+export * from './usePortalTarget';

package/dist/src/composables/portalTarget/usePortalTarget.d.ts

@@ -0,0 +1,4 @@
+import { TransportInput } from 'portal-vue/types';
+export declare const usePortalTarget: () => {
+    registerPortal: (transportInput: TransportInput) => void;
+};

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

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

package/dist/src/composables/previewService/usePreviewService.d.ts

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

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

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

package/dist/src/composables/requestHeaders/useRequestHeaders.d.ts

@@ -0,0 +1,3 @@
+export declare const useRequestHeaders: () => {
+    headers: import('vue').ComputedRef<Record<string, string>>;
+};

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

@@ -0,0 +1,5 @@
+export * from './useCanBeOpenedWithSecureView';
+export * from './useCanListVersions';
+export * from './useGetResourceContext';
+export * from './useLoadPreview';
+export * from './useResourceContents';

package/dist/src/composables/resources/useCanBeOpenedWithSecureView.d.ts

@@ -0,0 +1,4 @@
+import { Resource } from '@opencloud-eu/web-client';
+export declare const useCanBeOpenedWithSecureView: () => {
+    canBeOpenedWithSecureView: (resource: Resource) => boolean;
+};

package/dist/src/composables/resources/useCanListVersions.d.ts

@@ -0,0 +1,7 @@
+import { Resource, SpaceResource } from '@opencloud-eu/web-client';
+export declare const useCanListVersions: () => {
+    canListVersions: ({ space, resource }: {
+        space: SpaceResource;
+        resource: Resource;
+    }) => boolean;
+};