@opencloud-eu/web-pkg 4.0.0 → 4.1.0

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

@@ -0,0 +1,2 @@
+export * from './config';
+export * from './types';

package/dist/src/composables/piniaStores/config/types.d.ts

@@ -0,0 +1,194 @@
+import { z } from 'zod';
+declare const CustomTranslationSchema: z.ZodObject<{
+    url: z.ZodString;
+}, z.core.$strip>;
+export type CustomTranslation = z.infer<typeof CustomTranslationSchema>;
+declare const OAuth2ConfigSchema: z.ZodObject<{
+    apiUrl: z.ZodOptional<z.ZodString>;
+    authUrl: z.ZodOptional<z.ZodString>;
+    clientId: z.ZodOptional<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
+    logoutUrl: z.ZodOptional<z.ZodString>;
+    metaDataUrl: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type OAuth2Config = z.infer<typeof OAuth2ConfigSchema>;
+declare const OpenIdConnectConfigSchema: z.ZodObject<{
+    authority: z.ZodOptional<z.ZodString>;
+    client_id: z.ZodOptional<z.ZodString>;
+    client_secret: z.ZodOptional<z.ZodString>;
+    dynamic: z.ZodOptional<z.ZodString>;
+    metadata_url: z.ZodOptional<z.ZodString>;
+    post_logout_redirect_uri: z.ZodOptional<z.ZodString>;
+    response_type: z.ZodOptional<z.ZodString>;
+    scope: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+export type OpenIdConnectConfig = z.infer<typeof OpenIdConnectConfigSchema>;
+declare const SentryConfigSchema: z.ZodRecord<z.ZodAny, z.ZodAny>;
+export type SentryConfig = z.infer<typeof SentryConfigSchema>;
+declare const StyleConfigSchema: z.ZodObject<{
+    href: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type StyleConfig = z.infer<typeof StyleConfigSchema>;
+declare const ScriptConfigSchema: z.ZodObject<{
+    async: z.ZodOptional<z.ZodBoolean>;
+    src: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ScriptConfig = z.infer<typeof ScriptConfigSchema>;
+declare const OptionsConfigSchema: z.ZodObject<{
+    cernFeatures: z.ZodOptional<z.ZodBoolean>;
+    concurrentRequests: z.ZodOptional<z.ZodObject<{
+        resourceBatchActions: z.ZodOptional<z.ZodNumber>;
+        sse: z.ZodOptional<z.ZodNumber>;
+        shares: z.ZodOptional<z.ZodObject<{
+            create: z.ZodOptional<z.ZodNumber>;
+            list: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        avatars: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    contextHelpers: z.ZodOptional<z.ZodBoolean>;
+    contextHelpersReadMore: z.ZodOptional<z.ZodBoolean>;
+    defaultAppId: z.ZodOptional<z.ZodString>;
+    disabledExtensions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    disableFeedbackLink: z.ZodOptional<z.ZodBoolean>;
+    accountEditLink: z.ZodOptional<z.ZodObject<{
+        href: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    editor: z.ZodOptional<z.ZodObject<{
+        autosaveEnabled: z.ZodOptional<z.ZodBoolean>;
+        autosaveInterval: z.ZodOptional<z.ZodNumber>;
+        openAsPreview: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    }, z.core.$strip>>;
+    embed: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodOptional<z.ZodBoolean>;
+        target: z.ZodOptional<z.ZodString>;
+        messagesOrigin: z.ZodOptional<z.ZodString>;
+        delegateAuthentication: z.ZodOptional<z.ZodBoolean>;
+        delegateAuthenticationOrigin: z.ZodOptional<z.ZodString>;
+        fileTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        chooseFileName: z.ZodOptional<z.ZodBoolean>;
+        chooseFileNameSuggestion: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    feedbackLink: z.ZodOptional<z.ZodObject<{
+        ariaLabel: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        href: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    isRunningOnEos: z.ZodOptional<z.ZodBoolean>;
+    loginUrl: z.ZodOptional<z.ZodString>;
+    logoutUrl: z.ZodOptional<z.ZodString>;
+    ocm: z.ZodOptional<z.ZodObject<{
+        openRemotely: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    routing: z.ZodOptional<z.ZodObject<{
+        fullShareOwnerPaths: z.ZodOptional<z.ZodBoolean>;
+        idBased: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    runningOnEos: z.ZodOptional<z.ZodBoolean>;
+    tokenStorageLocal: z.ZodOptional<z.ZodBoolean>;
+    upload: z.ZodOptional<z.ZodObject<{
+        companionUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    userListRequiresFilter: z.ZodOptional<z.ZodBoolean>;
+    hideLogo: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type OptionsConfig = z.infer<typeof OptionsConfigSchema>;
+export declare const RawConfigSchema: z.ZodObject<{
+    server: z.ZodString;
+    theme: z.ZodString;
+    options: z.ZodObject<{
+        cernFeatures: z.ZodOptional<z.ZodBoolean>;
+        concurrentRequests: z.ZodOptional<z.ZodObject<{
+            resourceBatchActions: z.ZodOptional<z.ZodNumber>;
+            sse: z.ZodOptional<z.ZodNumber>;
+            shares: z.ZodOptional<z.ZodObject<{
+                create: z.ZodOptional<z.ZodNumber>;
+                list: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strip>>;
+            avatars: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        contextHelpers: z.ZodOptional<z.ZodBoolean>;
+        contextHelpersReadMore: z.ZodOptional<z.ZodBoolean>;
+        defaultAppId: z.ZodOptional<z.ZodString>;
+        disabledExtensions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        disableFeedbackLink: z.ZodOptional<z.ZodBoolean>;
+        accountEditLink: z.ZodOptional<z.ZodObject<{
+            href: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        editor: z.ZodOptional<z.ZodObject<{
+            autosaveEnabled: z.ZodOptional<z.ZodBoolean>;
+            autosaveInterval: z.ZodOptional<z.ZodNumber>;
+            openAsPreview: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+        }, z.core.$strip>>;
+        embed: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodOptional<z.ZodBoolean>;
+            target: z.ZodOptional<z.ZodString>;
+            messagesOrigin: z.ZodOptional<z.ZodString>;
+            delegateAuthentication: z.ZodOptional<z.ZodBoolean>;
+            delegateAuthenticationOrigin: z.ZodOptional<z.ZodString>;
+            fileTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            chooseFileName: z.ZodOptional<z.ZodBoolean>;
+            chooseFileNameSuggestion: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        feedbackLink: z.ZodOptional<z.ZodObject<{
+            ariaLabel: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            href: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        isRunningOnEos: z.ZodOptional<z.ZodBoolean>;
+        loginUrl: z.ZodOptional<z.ZodString>;
+        logoutUrl: z.ZodOptional<z.ZodString>;
+        ocm: z.ZodOptional<z.ZodObject<{
+            openRemotely: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        routing: z.ZodOptional<z.ZodObject<{
+            fullShareOwnerPaths: z.ZodOptional<z.ZodBoolean>;
+            idBased: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        runningOnEos: z.ZodOptional<z.ZodBoolean>;
+        tokenStorageLocal: z.ZodOptional<z.ZodBoolean>;
+        upload: z.ZodOptional<z.ZodObject<{
+            companionUrl: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        userListRequiresFilter: z.ZodOptional<z.ZodBoolean>;
+        hideLogo: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    apps: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    external_apps: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        path: z.ZodString;
+        config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>>;
+    customTranslations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        url: z.ZodString;
+    }, z.core.$strip>>>;
+    auth: z.ZodOptional<z.ZodObject<{
+        apiUrl: z.ZodOptional<z.ZodString>;
+        authUrl: z.ZodOptional<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodString>;
+        clientSecret: z.ZodOptional<z.ZodString>;
+        logoutUrl: z.ZodOptional<z.ZodString>;
+        metaDataUrl: z.ZodOptional<z.ZodString>;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    openIdConnect: z.ZodOptional<z.ZodObject<{
+        authority: z.ZodOptional<z.ZodString>;
+        client_id: z.ZodOptional<z.ZodString>;
+        client_secret: z.ZodOptional<z.ZodString>;
+        dynamic: z.ZodOptional<z.ZodString>;
+        metadata_url: z.ZodOptional<z.ZodString>;
+        post_logout_redirect_uri: z.ZodOptional<z.ZodString>;
+        response_type: z.ZodOptional<z.ZodString>;
+        scope: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+    sentry: z.ZodOptional<z.ZodRecord<z.ZodAny, z.ZodAny>>;
+    scripts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        async: z.ZodOptional<z.ZodBoolean>;
+        src: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    styles: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        href: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type RawConfig = z.infer<typeof RawConfigSchema>;
+export {};

package/dist/src/composables/piniaStores/extensionRegistry/extensionPreferences.d.ts

@@ -0,0 +1,22 @@
+import { Extension, ExtensionPoint } from './types';
+export interface ExtensionPreferenceItem {
+    extensionPointId: string;
+    selectedExtensionIds: string[];
+}
+export declare const useExtensionPreferencesStore: import('pinia').StoreDefinition<"extensionPreferences", Pick<{
+    extensionPreferences: import('@vueuse/core').RemovableRef<Record<string, ExtensionPreferenceItem>>;
+    extractDefaultExtensionIds: (extensionPoint: ExtensionPoint<Extension>, extensions: Extension[]) => string[];
+    getExtensionPreference: (extensionPointId: string, defaultExtensionIds: string[]) => ExtensionPreferenceItem;
+    setSelectedExtensionIds: (extensionPointId: string, extensionIds: string[]) => void;
+}, "extensionPreferences">, Pick<{
+    extensionPreferences: import('@vueuse/core').RemovableRef<Record<string, ExtensionPreferenceItem>>;
+    extractDefaultExtensionIds: (extensionPoint: ExtensionPoint<Extension>, extensions: Extension[]) => string[];
+    getExtensionPreference: (extensionPointId: string, defaultExtensionIds: string[]) => ExtensionPreferenceItem;
+    setSelectedExtensionIds: (extensionPointId: string, extensionIds: string[]) => void;
+}, never>, Pick<{
+    extensionPreferences: import('@vueuse/core').RemovableRef<Record<string, ExtensionPreferenceItem>>;
+    extractDefaultExtensionIds: (extensionPoint: ExtensionPoint<Extension>, extensions: Extension[]) => string[];
+    getExtensionPreference: (extensionPointId: string, defaultExtensionIds: string[]) => ExtensionPreferenceItem;
+    setSelectedExtensionIds: (extensionPointId: string, extensionIds: string[]) => void;
+}, "extractDefaultExtensionIds" | "getExtensionPreference" | "setSelectedExtensionIds">>;
+export type ExtensionPreferencesStore = ReturnType<typeof useExtensionPreferencesStore>;

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

@@ -0,0 +1,37 @@
+import { Ref } from 'vue';
+import { Extension, ExtensionPoint, ExtensionType } from './types';
+export declare const useExtensionRegistry: import('pinia').StoreDefinition<"extensionRegistry", Pick<{
+    extensions: Ref<Ref<Extension[], Extension[]>[], Ref<Extension[], Extension[]>[]>;
+    registerExtensions: (e: Ref<Extension[]>) => void;
+    unregisterExtensions: (ids: string[]) => void;
+    requestExtensions: <T extends Extension>(extensionPoint: ExtensionPoint<T>) => T[];
+    extensionPoints: Ref<Ref<ExtensionPoint<Extension>[], ExtensionPoint<Extension>[]>[], Ref<ExtensionPoint<Extension>[], ExtensionPoint<Extension>[]>[]>;
+    registerExtensionPoints: <T extends Extension>(e: Ref<ExtensionPoint<T>[]>) => void;
+    unregisterExtensionPoints: (ids: string[]) => void;
+    getExtensionPoints: <T extends ExtensionPoint<Extension>>(options?: {
+        extensionType?: ExtensionType;
+    }) => T[];
+}, "extensions" | "extensionPoints">, Pick<{
+    extensions: Ref<Ref<Extension[], Extension[]>[], Ref<Extension[], Extension[]>[]>;
+    registerExtensions: (e: Ref<Extension[]>) => void;
+    unregisterExtensions: (ids: string[]) => void;
+    requestExtensions: <T extends Extension>(extensionPoint: ExtensionPoint<T>) => T[];
+    extensionPoints: Ref<Ref<ExtensionPoint<Extension>[], ExtensionPoint<Extension>[]>[], Ref<ExtensionPoint<Extension>[], ExtensionPoint<Extension>[]>[]>;
+    registerExtensionPoints: <T extends Extension>(e: Ref<ExtensionPoint<T>[]>) => void;
+    unregisterExtensionPoints: (ids: string[]) => void;
+    getExtensionPoints: <T extends ExtensionPoint<Extension>>(options?: {
+        extensionType?: ExtensionType;
+    }) => T[];
+}, never>, Pick<{
+    extensions: Ref<Ref<Extension[], Extension[]>[], Ref<Extension[], Extension[]>[]>;
+    registerExtensions: (e: Ref<Extension[]>) => void;
+    unregisterExtensions: (ids: string[]) => void;
+    requestExtensions: <T extends Extension>(extensionPoint: ExtensionPoint<T>) => T[];
+    extensionPoints: Ref<Ref<ExtensionPoint<Extension>[], ExtensionPoint<Extension>[]>[], Ref<ExtensionPoint<Extension>[], ExtensionPoint<Extension>[]>[]>;
+    registerExtensionPoints: <T extends Extension>(e: Ref<ExtensionPoint<T>[]>) => void;
+    unregisterExtensionPoints: (ids: string[]) => void;
+    getExtensionPoints: <T extends ExtensionPoint<Extension>>(options?: {
+        extensionType?: ExtensionType;
+    }) => T[];
+}, "registerExtensions" | "unregisterExtensions" | "requestExtensions" | "registerExtensionPoints" | "unregisterExtensionPoints" | "getExtensionPoints">>;
+export type ExtensionRegistry = ReturnType<typeof useExtensionRegistry>;

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

@@ -0,0 +1,3 @@
+export * from './extensionPreferences';
+export * from './extensionRegistry';
+export * from './types';

package/dist/src/composables/piniaStores/extensionRegistry/types.d.ts

@@ -0,0 +1,66 @@
+import { Action } from '../../actions';
+import { SearchProvider, SideBarPanel } from '../../../components';
+import { AppNavigationItem } from '../../../apps';
+import { Item } from '@opencloud-eu/web-client';
+import { FolderView } from '../../../ui';
+import { Component, Slot } from 'vue';
+import { StringUnionOrAnyString } from '../../../utils';
+export type ExtensionType = StringUnionOrAnyString<'action' | 'appMenuItem' | 'customComponent' | 'folderView' | 'search' | 'sidebarNav' | 'sidebarPanel' | 'accountExtension'>;
+export type Extension = {
+    id: string;
+    type: ExtensionType;
+    extensionPointIds?: string[];
+    userPreference?: {
+        optionLabel?: string;
+    };
+};
+export interface ActionExtension extends Extension {
+    type: 'action';
+    action: Action;
+}
+export interface SearchExtension extends Extension {
+    type: 'search';
+    searchProvider: SearchProvider;
+}
+export interface SidebarNavExtension extends Extension {
+    type: 'sidebarNav';
+    navItem: AppNavigationItem;
+}
+export interface SidebarPanelExtension<R extends Item, P extends Item, T extends Item> extends Extension {
+    type: 'sidebarPanel';
+    panel: SideBarPanel<R, P, T>;
+}
+export interface FolderViewExtension extends Extension {
+    type: 'folderView';
+    folderView: FolderView;
+}
+export interface CustomComponentExtension extends Extension {
+    type: 'customComponent';
+    content: Slot | Component;
+}
+export interface AccountExtension extends Extension {
+    type: 'accountExtension';
+    content: Slot | Component;
+    label: () => string;
+    icon: string;
+}
+export interface AppMenuItemExtension extends Extension {
+    type: 'appMenuItem';
+    label: () => string;
+    color?: string;
+    handler?: () => Promise<void> | void;
+    icon?: string;
+    path?: string;
+    priority?: number;
+    url?: string;
+}
+export type ExtensionPoint<T extends Extension> = {
+    id: string;
+    extensionType: ExtensionType;
+    multiple?: boolean;
+    defaultExtensionId?: string;
+    userPreference?: {
+        label: string;
+        description?: string;
+    };
+};

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

@@ -0,0 +1,16 @@
+export * from './apps';
+export * from './auth';
+export * from './capabilities';
+export * from './clipboard';
+export * from './config';
+export * from './extensionRegistry';
+export * from './messages';
+export * from './modals';
+export * from './resources';
+export * from './shares';
+export * from './spaces';
+export * from './theme';
+export * from './user';
+export * from './webWorkers';
+export * from './avatars';
+export * from './updates';