@finsemble/finsemble-ui 6.6.3 → 7.0.0-beta-X

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

@@ -0,0 +1,466 @@
+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;
+};
+/**
+ *
+ * Test Driver Example (can paste into component console)
+ *
+ window.smartDesktopClientDriver = async function makerClientDriver() {
+    {
+        let { err, apps } = await SmartDesktopClient.getApps();
+        Logger.log("getApps", err ? err : "ok" , apps);
+    }
+    {
+        let { err, config } = await SmartDesktopClient.getAppConfig("Rates");
+        Logger.log("getAppConfig", err ? err : "ok" , config);
+    }
+    {
+        let { config } = await SmartDesktopClient.getAppConfigTemplate();
+        let { err } = await SmartDesktopClient.addApp("testApp1", config);
+        Logger.log("addApp", err ? err : "ok" );
+    }
+    {
+        let { err } = await SmartDesktopClient.deleteApp("testApp1");
+        Logger.log("deleteApp", err ? err : "ok" );
+    }
+    {
+        Logger.log("updateTheme", err ? err : "ok" );
+        let { err } = await SmartDesktopClient.updateInstallerDescription({ name: "sample installer name", version: "V0.0.0", authors: "M. Smith", description: "sample installer descriptions" });
+        Logger.log("updateInstallerDescription", err ? err : "ok" );
+    }
+    {
+        let blob = await fetch("http://localhost:3375/assets/img/test.png").then(r => r.blob());
+        var file = new File([blob], "foo.png");
+        let { err } = await SmartDesktopClient.updateToolbarIcon(file);
+        console.log("updateToolbarIcon", err ? err : "ok" );
+    }
+    {
+        let blob = await fetch("http://localhost:3375/assets/img/test.png").then(r => r.blob());
+        var file = new File([blob], "foo.png");
+        let { err } = await SmartDesktopClient.updateTaskbarIcon(file);
+        console.log("updateTaskbarIcon", err ? err : "ok" );
+    }
+    {
+        let blob = await fetch("http://localhost:3375/assets/img/test.png").then(r => r.blob());
+        var file = new File([blob], "foo.png");
+        let { err } = await SmartDesktopClient.updateSystemTrayIcon(file);
+        console.log("updateSystemTrayIcon", err ? err : "ok" );
+    }
+    {
+        let blob = await fetch("http://localhost:3375/assets/img/test.ico").then(r => r.blob());
+        var file = new File([blob], "foo.ico");
+        let { err } = await SmartDesktopClient.updateInstallerIcon(file);
+        console.log("updateInstallerIcon", err ? err : "ok" );
+    }
+    {
+        let blob = await fetch("http://localhost:3375/assets/img/install-spinner.gif").then(r => r.blob());
+        var file = new File([blob], "foo.gif");
+        let { err } = await SmartDesktopClient.updateInstallerGraphic(file);
+        console.log("updateInstallerGraphic", err ? err : "ok" );
+    }
+    {
+        let blob = await fetch("http://localhost:3375/assets/img/test.svg").then(r => r.blob());
+        var file = new File([blob], "foo.svg");
+        let { err } = await SmartDesktopClient.updateSplashScreen(file);
+        console.log("updateSplashScreen", err ? err : "ok" );
+    }
+    {
+        let { err } = await SmartDesktopClient.updateTheme({ cssSampleData: 1 });
+        console.log("updateTheme", err ? err : "ok" );
+    }
+    {
+        let { err } = await SmartDesktopClient.createProjectZip("testApp", "~/Downloads/");
+        Logger.log("createProjectZip", err ? err : "ok" );
+    }
+    {
+        <input type="file" onChange={(e) => {
+            const file = e.target.files?.[0];
+
+            let { err } = await SmartDesktopClient.uploadAssets([
+                {
+                    file,
+                    type: AssetType.Image,
+                    targetPath: 'image.png',
+                }
+            ], (progress) => {
+                // ...
+            });
+
+            Logger.log("uploadAssets", err ? err : "ok" );
+        }} />
+    }
+}
+ */
+export declare const SmartDesktopClient: {
+    getSDServerInfo: () => Promise<FEA.SDServerInfo>;
+    /**
+     * Confirm the Smart Desktop Server is enabled.  This should be true before constructing and using a client.
+     *
+     * @static
+     * @returns {Promise<Boolean>}
+     */
+    isEnabled(): Promise<Boolean>;
+    /**
+     * Get the smart desktop server base URL.
+     *
+     * @static
+     * @returns {Promise<Boolean>}
+     */
+    applicationRoot(): Promise<string | null>;
+    /**
+     *
+     */
+    projectConfig(): Promise<FEA.ProjectConfig | null>;
+    /**
+     * Get list of all AppD applications
+     *
+     * @returns {Promise<{ err:any, data:any}>}
+     *
+     * @example
+     * let { err, apps } = await SmartDesktopClient.getApps();
+     */
+    getApps(): Promise<{
+        err: any;
+        apps: any;
+    }>;
+    /**
+     * Get list of all Menus
+     *
+     * @returns {Promise<{ err:any, data:any}>}
+     *
+     * @example
+     * let { err, menus } = await SmartDesktopClient.getMenus();
+     */
+    getMenus(): Promise<{
+        err: any;
+        menus: MenuType;
+    }>;
+    /**
+     * Get the config.extensions.preloads object (from appd.json), which includes all registered
+     * preloads and their details
+     */
+    getPreloads(): Promise<{
+        err: any;
+        data: PreloadMap;
+    }>;
+    /**
+     * Get config for the specified AppD app.
+     *
+     * @example
+     * let { err, config } = await SmartDesktopClient.getAppConfig("testApp");
+     */
+    getAppConfig(appId: string): Promise<{
+        err: any;
+        config: any;
+    }>;
+    /**
+     * Helper function returning a AppD config template with Finsemble component in manifest property.
+     *
+     * @returns {Promise<{ config: any }>}
+     *
+     * @example
+     * let { config } = await SmartDesktopClient.getAppConfigTemplate();
+     */
+    getAppConfigTemplate(): Promise<{
+        config: AppDefinition;
+    }>;
+    /**
+     * Add AppD application, which will modify Finsemble config and invoke REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.addApp("testApp", config);
+     */
+    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;
+    }>;
+    /**
+     * Add AppD application, which will modify Finsemble config and invoke REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.updateApp("testApp", config);
+     */
+    updateApp(appId: string, appConfig: AppDefinition): Promise<{
+        err: any;
+    }>;
+    /**
+     * Create/updates the preload with the specific preload alias
+     */
+    savePreload(oldAlias: string | null, newAlias: string, detail: PreloadDetail): Promise<{
+        err: any;
+    }>;
+    /**
+     * Remove AppD application, which will modify Finsemble config and invoke REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.deleteApp("testApp");
+     */
+    deleteApp(appId: string): Promise<{
+        err: any;
+    }>;
+    deleteMenu(menuId: string): Promise<{
+        err: any;
+    }>;
+    /**
+     * Remove a given preload from the registry in the config
+     */
+    deletePreload(alias: string): Promise<{
+        err: any;
+    }>;
+    /**
+     * Update the theme of all components and invoke REST API to persist the change in Finsemble's theme.css file
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.updateTheme(cssData);
+     */
+    updateTheme(theme: CSS): Promise<{
+        err: any;
+    }>;
+    /**
+     * Get the theme from the REST API
+     *
+     * @returns {Promise<{ err, theme }>}
+     * @memberOf SmartDesktopClient
+     *
+     * @example
+     * let { err, theme } = await SmartDesktopClient.getTheme(cssData);
+     */
+    getTheme(): Promise<{
+        err: any;
+        theme?: Record<string, string> | undefined;
+    }>;
+    /**
+     * Add handler listening for theme updates
+     *
+     * @returns When called, unsubscribes the handler
+     */
+    onThemeUpdated(themeUpdatedHandler: StandardErrorCallback<any>): Function;
+    /**
+     * Post a file to the smart desktop server
+     *
+     * @example
+     * ...
+     */
+    uploadAssets(assets: Asset[], progress: Function): Promise<{
+        err: string | null;
+        paths: string[];
+    }>;
+    /**
+     * Post images to the smart desktop server
+     *
+     * @example
+     * ...
+     */
+    uploadImages(files: File[], progress: Function): Promise<{
+        err: any;
+        paths: string[];
+    }>;
+    /**
+     * Post an image to the smart desktop server
+     *
+     * @example
+     * ...
+     */
+    uploadImage(file: File, progress: Function): Promise<{
+        err: any;
+        path: string;
+    }>;
+    /**
+     * Update installer description by using REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.updateInstallerDescription(installerDescription);
+     */
+    updateInstallerDescription(installerDescription: InstallerDescription): Promise<{
+        err: any;
+    }>;
+    /**
+     * Update installer description by using REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.updateInstallerDescription(installerDescription);
+     */
+    updateProjectSettings(settings: ProjectSettings): Promise<{
+        err: any;
+    }>;
+    /**
+     * Get project settings
+     *
+     * @example
+     * let { settings, err } = await SmartDesktopClient.getProjectSettings();
+     */
+    getProjectSettings(): Promise<{
+        settings: ProjectSettings;
+        err: any;
+    }>;
+    /**
+     * Helper function -- progress descriptor for updating files
+     *
+     */
+    progressIndicator(progress: any): void;
+    /**
+     * Update Finsemble toolbar icon file and transmit correspond ui-changed message so UI will pick up change
+     *
+     * @returns {Promise<{ err: any }>}
+     */
+    updateToolbarIcon(imageFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    /**
+     * Update Finsemble taskbar icon file and transmit correspond ui-changed message so UI will pick up change
+     *
+     */
+    updateTaskbarIcon(imageFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    /**
+     * Update system tray icon file and refresh config entry to trigger notification
+     *
+     */
+    updateSystemTrayIcon(imageFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    /**
+     * Update the installer Icon file -- the change will not be picked up until the installer is built
+     *
+     */
+    updateInstallerIcon(iconFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    /**
+     * Update the installer graphic file -- the change will not be picked up until the installer is built
+     */
+    updateInstallerGraphic(gifFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    /**
+     * Update the splash screen image file -- the change will not be picked up until Finsemble/FEA is restarted
+     */
+    updateSplashScreen(svgFile: File): Promise<{
+        err: string | null;
+        path: string;
+    }>;
+    /**
+     * Helper function to update a single theme variable within Finsemble's theme
+     */
+    updateThemeVariable(varName: string, varValue: string): Promise<{
+        err: any;
+    }>;
+    /**
+     * Save a .zip file of the project with `appName` to the local filesystem at `targetPath`
+     * @example
+     * let { err } = await SmartDesktopClient.createProjectZip("testApp", "~/Downloads/");
+     */
+    createProjectZip(appName: string, targetPath?: string | undefined): Promise<string>;
+    /**
+     * Copy project assets/config to target dir
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.createProjectZip("testApp", "~/Downloads/");
+     */
+    copyProjectFiles(appName: string, targetPath?: string | undefined): Promise<{
+        source: string;
+        target: string;
+    }[]>;
+    /**
+     * Change the path of the current project in smartDesktops.json
+     *
+     * @param appName name of app to zip
+     * @param [targetPath] output path for zip file
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.createProjectZip("testApp", "~/Downloads/");
+     */
+    selectProjectPath(): Promise<string>;
+    /**
+     * checkValidProjectName
+     */
+    checkValidProjectName(name: string): boolean;
+    /**
+     * Check an arbitrary string to see if it is a valid url
+     * The only checks for validity are:
+     * * if the string begins with "http://" or "https://"
+     *
+     * @param url - the potential URL
+     */
+    checkValidURL(url: string): boolean;
+    isInboundInteropAuthorized(sourceApp: AppDefinition, targetApp: AppDefinition, contextType?: string | undefined): Promise<boolean>;
+    isOutboundInteropAuthorized(sourceApp: AppDefinition, targetApp: AppDefinition, contextType?: string | undefined): Promise<boolean>;
+    /**
+     * Publish `.zip` file to the Cosaic Cloud
+     *
+     * @returns {Promise}
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.publishToCosaicCloud();
+     */
+    publishToCosaicCloud(uuid?: string | undefined): Promise<FEA.DeployInfo>;
+    /**
+     * Get the progress of a publish request
+     *
+     * @returns {Promise}
+     *
+     */
+    getPublishProgress(): Promise<FEA.Progress>;
+    /**
+     * Resets the current project to factory defaults. Once complete, Finsemble is restarted
+     * so that the changes can take effect.
+     */
+    resetProject(): Promise<[Error | null, any]>;
+    /**
+     * Saves the auth providers to config.json
+     */
+    getAuthenticationProviders(): Promise<any[]>;
+    /**
+     * Saves the auth providers to config.json
+     */
+    setAuthenticationProviders(authenticationProviders: any): Promise<Error | null>;
+};
+export {};