@opencloud-eu/web-pkg 0.1.1 → 1.0.0

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

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

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

@@ -0,0 +1,60 @@
+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'>;
+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 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/package/src/composables/piniaStores/index.d.ts

@@ -0,0 +1,14 @@
+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';

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

@@ -0,0 +1,125 @@
+import { HttpError } from '@opencloud-eu/web-client';
+type MessageError = Error | HttpError;
+export interface Message {
+    id: string;
+    title: string;
+    desc?: string;
+    errors?: MessageError[];
+    errorLogContent?: string;
+    timeout?: number;
+    status?: string;
+}
+export declare const useMessages: import('pinia').StoreDefinition<"messages", Pick<{
+    messages: import('vue').Ref<{
+        id: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+        timeout?: number;
+        status?: string;
+    }[], Message[] | {
+        id: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+        timeout?: number;
+        status?: string;
+    }[]>;
+    showMessage: (data: Omit<Message, "id">) => {
+        id: string;
+        timeout?: number;
+        status?: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+    };
+    showErrorMessage: (data: Omit<Message, "id">) => {
+        timeout: number;
+        status: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent: string;
+        id: string;
+    };
+    removeMessage: (message: Message) => void;
+}, "messages">, Pick<{
+    messages: import('vue').Ref<{
+        id: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+        timeout?: number;
+        status?: string;
+    }[], Message[] | {
+        id: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+        timeout?: number;
+        status?: string;
+    }[]>;
+    showMessage: (data: Omit<Message, "id">) => {
+        id: string;
+        timeout?: number;
+        status?: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+    };
+    showErrorMessage: (data: Omit<Message, "id">) => {
+        timeout: number;
+        status: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent: string;
+        id: string;
+    };
+    removeMessage: (message: Message) => void;
+}, never>, Pick<{
+    messages: import('vue').Ref<{
+        id: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+        timeout?: number;
+        status?: string;
+    }[], Message[] | {
+        id: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+        timeout?: number;
+        status?: string;
+    }[]>;
+    showMessage: (data: Omit<Message, "id">) => {
+        id: string;
+        timeout?: number;
+        status?: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent?: string;
+    };
+    showErrorMessage: (data: Omit<Message, "id">) => {
+        timeout: number;
+        status: string;
+        title: string;
+        desc?: string;
+        errors?: MessageError[];
+        errorLogContent: string;
+        id: string;
+    };
+    removeMessage: (message: Message) => void;
+}, "showMessage" | "showErrorMessage" | "removeMessage">>;
+export type MessageStore = ReturnType<typeof useMessages>;
+export {};