@finsemble/finsemble-ui 6.6.0 → 7.0.0-beta.2

package/react/components/sdd/smartDesktopClient.d.ts

@@ -0,0 +1,163 @@
+import { AppDefinition, FEA, StandardErrorCallback } from "@finsemble/finsemble-api";
+declare type InstallerDescription = {
+    name: string;
+    version?: string;
+    authors?: string;
+    description?: string;
+};
+export declare type CSS = {
+    [key: string]: string;
+};
+declare type AssetType = "JS" | "CSS" | "JSON" | "Text" | "Image" | "GIF" | "Icon";
+declare type Asset = {
+    type: AssetType[];
+    file: File;
+    targetPath: string;
+};
+declare type MenuObjType = {
+    displayName: string;
+    applications: string[];
+    position: number;
+};
+declare type MenuType = {
+    [key: string]: MenuObjType;
+};
+declare type ProjectSettings = {
+    name: string;
+    path?: string;
+    version?: string;
+    authors?: string;
+    description?: string;
+};
+declare type preloadUsageType = "launchable" | "all" | "none";
+declare type PreloadDetail = {
+    url: string;
+    autoload: preloadUsageType;
+};
+declare type PreloadMap = {
+    [alias: string]: PreloadDetail;
+};
+export declare const SmartDesktopClient: {
+    getSDServerInfo: () => Promise<FEA.SDServerInfo>;
+    isEnabled(): Promise<Boolean>;
+    applicationRoot(): Promise<string | null>;
+    projectConfig(): Promise<FEA.ProjectConfig | null>;
+    getApps(): Promise<{
+        err: any;
+        apps: any;
+    }>;
+    getMenus(): Promise<{
+        err: any;
+        menus: MenuType;
+    }>;
+    getPreloads(): Promise<{
+        err: any;
+        data: PreloadMap;
+    }>;
+    getAppConfig(appId: string): Promise<{
+        err: any;
+        config: any;
+    }>;
+    getAppConfigTemplate(): Promise<{
+        config: AppDefinition;
+    }>;
+    addApp(appId: string, appConfig: AppDefinition): Promise<{
+        err: any;
+    }>;
+    addMenu(menuConfig: MenuObjType): Promise<{
+        err: any;
+    }>;
+    syncMenuConfig(): Promise<void>;
+    updateMenu(menuId: string, menuConfig: MenuObjType): Promise<{
+        err: any;
+    }>;
+    updateApp(appId: string, appConfig: AppDefinition): Promise<{
+        err: any;
+    }>;
+    savePreload(oldAlias: string | null, newAlias: string, detail: PreloadDetail): Promise<{
+        err: any;
+    }>;
+    deleteApp(appId: string): Promise<{
+        err: any;
+    }>;
+    deleteMenu(menuId: string): Promise<{
+        err: any;
+    }>;
+    deletePreload(alias: string): Promise<{
+        err: any;
+    }>;
+    updateTheme(theme: CSS): Promise<{
+        err: any;
+    }>;
+    getTheme(): Promise<{
+        err: any;
+        theme?: Record<string, string> | undefined;
+    }>;
+    onThemeUpdated(themeUpdatedHandler: StandardErrorCallback<any>): Function;
+    uploadAssets(assets: Asset[], progress: Function): Promise<{
+        err: string | null;
+        paths: string[];
+    }>;
+    uploadImages(files: File[], progress: Function): Promise<{
+        err: any;
+        paths: string[];
+    }>;
+    uploadImage(file: File, progress: Function): Promise<{
+        err: any;
+        path: string;
+    }>;
+    updateInstallerDescription(installerDescription: InstallerDescription): Promise<{
+        err: any;
+    }>;
+    updateProjectSettings(settings: ProjectSettings): Promise<{
+        err: any;
+    }>;
+    getProjectSettings(): Promise<{
+        settings: ProjectSettings;
+        err: any;
+    }>;
+    progressIndicator(progress: any): void;
+    updateToolbarIcon(imageFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    updateTaskbarIcon(imageFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    updateSystemTrayIcon(imageFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    updateInstallerIcon(iconFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    updateInstallerGraphic(gifFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    updateSplashScreen(svgFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    updateThemeVariable(varName: string, varValue: string): Promise<{
+        err: any;
+    }>;
+    createProjectZip(appName: string, targetPath?: string | undefined): Promise<string>;
+    copyProjectFiles(appName: string, targetPath?: string | undefined): Promise<{
+        source: string;
+        target: string;
+    }[]>;
+    selectProjectPath(): Promise<string>;
+    checkValidProjectName(name: string): boolean;
+    checkValidURL(url: string): boolean;
+    isInboundInteropAuthorized(sourceApp: AppDefinition, targetApp: AppDefinition, contextType?: string | undefined): Promise<boolean>;
+    isOutboundInteropAuthorized(sourceApp: AppDefinition, targetApp: AppDefinition, contextType?: string | undefined): Promise<boolean>;
+    publishToCosaicCloud(uuid?: string | undefined): Promise<FEA.DeployInfo>;
+    getPublishProgress(): Promise<FEA.Progress>;
+    resetProject(): Promise<[Error | null, any]>;
+    getAuthenticationProviders(): Promise<any[]>;
+    setAuthenticationProviders(authenticationProviders: any): Promise<Error | null>;
+};
+export {};