@finsemble/finsemble-ui 7.3.10 → 7.3.11

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

@@ -1,8 +1,4 @@
-import { AppDefinition, StandardPromise } from "../../../types";
-import { SDServerInfo, ProjectConfig, Progress, DeployInfo } from "../../../FEA";
-import { StandardErrorCallback } from "../../../types";
-import { ProjectsType } from "./types";
-import { FDC3AppDefinition, InternalAppDServerMetadata } from "../../../platform/services/types";
+import { AppDefinition, FEA, StandardErrorCallback } from "@finsemble/finsemble-api";
 declare type InstallerDescription = {
     name: string;
     version?: string;
@@ -33,11 +29,6 @@ declare type ProjectSettings = {
     authors?: string;
     description?: string;
 };
-declare type ProjectDetails = {
-    oldName: string;
-    newName: string;
-    cloneCurrent: boolean;
-};
 declare type preloadUsageType = "launchable" | "all" | "none";
 declare type PreloadDetail = {
     url: string;
@@ -60,7 +51,7 @@ declare type PreloadMap = {
         Logger.log("getAppConfig", err ? err : "ok" , config);
     }
     {
-        let { config } = SmartDesktopClient.getAppConfigTemplate();
+        let { config } = await SmartDesktopClient.getAppConfigTemplate();
         let { err } = await SmartDesktopClient.addApp("testApp1", config);
         Logger.log("addApp", err ? err : "ok" );
     }
@@ -137,7 +128,7 @@ declare type PreloadMap = {
 }
  */
 export declare const SmartDesktopClient: {
-    getSDServerInfo: () => Promise<SDServerInfo>;
+    getSDServerInfo: () => Promise<FEA.SDServerInfo>;
     /**
      * Confirm the Smart Desktop Server is enabled.  This should be true before constructing and using a client.
      *
@@ -155,41 +146,18 @@ export declare const SmartDesktopClient: {
     /**
      *
      */
-    projectConfig(): Promise<ProjectConfig | null>;
+    projectConfig(): Promise<FEA.ProjectConfig | null>;
     /**
      * Get list of all AppD applications
      *
-     * @returns {Promise<{ err:any, apps:FDC3AppDefinition[]}>}
+     * @returns {Promise<{ err:any, data:any}>}
      *
      * @example
      * let { err, apps } = await SmartDesktopClient.getApps();
      */
     getApps(): Promise<{
         err: any;
-        apps: FDC3AppDefinition[];
-    }>;
-    /**
-     * Get list of all AppD applications
-     *
-     * @returns {Promise<{ err:any, apps:FDC3AppDefinition[]}>}
-     *
-     * @example
-     * let { err, apps } = await SmartDesktopClient.getApps();
-     */
-    removeAllEntriesFromAppDJson(): Promise<{
-        err: string | null;
-    }>;
-    /**
-     * Get list of all AppD applications
-     *
-     * @returns {Promise<{ err:any, apps:FDC3AppDefinition[]}>}
-     *
-     * @example
-     * let { err, apps } = await SmartDesktopClient.getDeprecatedEntriesFromAppDJsonFile();
-     */
-    getDeprecatedEntriesFromAppDJsonFile(): Promise<{
-        err: any;
-        apps: FDC3AppDefinition[];
+        apps: any;
     }>;
     /**
      * Get list of all Menus
@@ -227,11 +195,11 @@ export declare const SmartDesktopClient: {
      * @returns {Promise<{ config: any }>}
      *
      * @example
-     * let { config } = SmartDesktopClient.getAppConfigTemplate();
+     * let { config } = await SmartDesktopClient.getAppConfigTemplate();
      */
-    getAppConfigTemplate(): {
+    getAppConfigTemplate(): Promise<{
         config: AppDefinition;
-    };
+    }>;
     /**
      * Add AppD application, which will modify Finsemble config and invoke REST API to persist the change
      *
@@ -357,15 +325,6 @@ export declare const SmartDesktopClient: {
     updateProjectSettings(settings: ProjectSettings): Promise<{
         err: any;
     }>;
-    /**
-     * Update installer description by using REST API to persist the change
-     *
-     * @example
-     * let { err } = await SmartDesktopClient.updateInstallerDescription(installerDescription);
-     */
-    deleteProject(name: string): Promise<{
-        err: any;
-    }>;
     /**
      * Get project settings
      *
@@ -376,47 +335,6 @@ export declare const SmartDesktopClient: {
         settings: ProjectSettings;
         err: any;
     }>;
-    /**
-     * Get all available projects and the current project name
-     *
-     * @example
-     * let { settings, err } = await SmartDesktopClient.getProjectSettings();
-     */
-    getProjects(): Promise<{
-        details: ProjectsType;
-        err: any;
-    }>;
-    /**
-     * Updates the @finsemble/finsemble-core dependency version in the package.json file for the given project
-     * @param projectName - The project to update
-     * @param finsembleCoreVersion - The version to set (obtained from getFSBLInfo() )
-     * @returns
-     */
-    updateFinsembleCoreVersion(projectName: string, finsembleCoreVersion: string): Promise<{
-        err: any;
-    }>;
-    /**
-     * Update project details
-     *
-     * @example
-     * let { err } = await SmartDesktopClient.updateProjectDetails({
-     *   oldName: string;
-     *   newName: string;
-     *   cloneCurrent: boolean;
-     * });
-     */
-    updateProjectDetails(obj: ProjectDetails): Promise<{
-        err: any;
-    }>;
-    /**
-     * Set the active project
-     *
-     * @example
-     * let { err } = await SmartDesktopClient.setActiveProject("projectName");
-     */
-    setActiveProject(projectName: string): Promise<{
-        err: any;
-    }>;
     /**
      * Helper function -- progress descriptor for updating files
      *
@@ -485,24 +403,12 @@ export declare const SmartDesktopClient: {
      * Copy project assets/config to target dir
      *
      * @example
-     * await SmartDesktopClient.copyProjectFiles("testApp");
-     * await SmartDesktopClient.copyProjectFiles("testApp", "/specific/path");
-     */
-    copyProjectFiles(appName: string, targetPath?: string | undefined): Promise<void>;
-    /**
-     * Copy project assets/config to target dir
-     *
-     * @example
-     * let {err, data: newFolderLocation} = await SmartDesktopClient.moveProjectFiles("testApp");
-     */
-    moveProjectFiles(appName: string): StandardPromise<string>;
-    /**
-     * Import project from a directory
-     *
-     * @example
-     * let {err} = await SmartDesktopClient.importProjectFolder();
+     * let { err } = await SmartDesktopClient.createProjectZip("testApp", "~/Downloads/");
      */
-    importProjectFolder(): StandardPromise<string>;
+    copyProjectFiles(appName: string, targetPath?: string | undefined): Promise<{
+        source: string;
+        target: string;
+    }[]>;
     /**
      * Change the path of the current project in smartDesktops.json
      *
@@ -525,28 +431,6 @@ export declare const SmartDesktopClient: {
      * @param url - the potential URL
      */
     checkValidURL(url: string): boolean;
-    /**
-     * Check an arbitrary string to see if it is a valid path
-     * that begins with a macro.
-     * Note that macros must:
-     *  * Come at the beginning of the path
-     *  * Begin with "$"
-     *  * Otherwise only contain letters.
-     *
-     * Examples of macros: "$applicationRoot", "$moduleRoot"
-     * While all macros used by Finsemble end in "Root", clients can
-     * specify custom macros, which are not required to follow that practice.
-     *
-     * @param macroPath - path that potentially begins with a macro
-     */
-    checkValidMacroPath(macroPath: string): boolean;
-    /**
-     * Check an arbitrary string to see if it is a valid macro-beginning path
-     * OR a valid URL
-     *
-     * @param urlOrMacroPath - potential macro-beginning path or URL
-     */
-    checkValidLocation(urlOrMacroPath: string): boolean;
     isInboundInteropAuthorized(sourceApp: AppDefinition, targetApp: AppDefinition, contextType?: string): Promise<boolean>;
     isOutboundInteropAuthorized(sourceApp: AppDefinition, targetApp: AppDefinition, contextType?: string): Promise<boolean>;
     /**
@@ -557,20 +441,19 @@ export declare const SmartDesktopClient: {
      * @example
      * let { err } = await SmartDesktopClient.publishToCosaicCloud();
      */
-    publishToCosaicCloud(uuid?: string): Promise<DeployInfo>;
+    publishToCosaicCloud(uuid?: string): Promise<FEA.DeployInfo>;
     /**
      * Get the progress of a publish request
      *
      * @returns {Promise}
      *
      */
-    getPublishProgress(): Promise<Progress>;
+    getPublishProgress(): Promise<FEA.Progress>;
     /**
-     * Resets the a project to factory defaults. If no project name is provided then the current working
-     * project is assumed. In the case of the current working project, Finsemble is restarted after the reset
+     * Resets the current project to factory defaults. Once complete, Finsemble is restarted
      * so that the changes can take effect.
      */
-    resetProject(projectName?: string): Promise<[Error | null, any]>;
+    resetProject(): Promise<[Error | null, any]>;
     /**
      * Saves the auth providers to config.json
      */
@@ -579,49 +462,5 @@ export declare const SmartDesktopClient: {
      * Saves the auth providers to config.json
      */
     setAuthenticationProviders(authenticationProviders: any): Promise<Error | null>;
-    /**
-     * Gett all AppD server listings
-     *
-     * @example
-     * let { err, servers } = await SmartDesktopClient.getAppDServers();
-     */
-    getAppDServers(): Promise<{
-        err: any;
-        servers: InternalAppDServerMetadata[];
-    }>;
-    /**
-     * Add a new AppD server (and its config items)
-     *
-     * @example
-     * let { err } = await SmartDesktopClient.addAppDServer({
-     * 	displayName: "MyServer",
-     * 	url: "/path/to/server"
-     * });
-     */
-    addAppDServer(config: InternalAppDServerMetadata): Promise<{
-        err: any;
-    }>;
-    /**
-     * Update an AppD server's metadata
-     *
-     * @example
-     * let { err } = await SmartDesktopClient.updateAppDServer(1, {
-     * 	displayName: "MyServer Updated",
-     * });
-     */
-    updateAppDServer(index: number, config: Partial<InternalAppDServerMetadata>): Promise<{
-        err: any;
-    }>;
-    /**
-     * Remove an AppD server's listing/metadata
-     *
-     * @example
-     * let { err } = await SmartDesktopClient.deleteAppDServer(1);
-     */
-    deleteAppDServer(index: number): Promise<{
-        err: any;
-    }>;
-    getManifestRoots(): Promise<Record<string, string>>;
 };
 export {};
-//# sourceMappingURL=smartDesktopClient.d.ts.map