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

package/react/components/sdd/smartDesktopClient.js

@@ -10,9 +10,19 @@ const assetTests = {
     CSS: { acceptedTypes: ["CSS"], regex: /\.(css)$/i },
     Text: { acceptedTypes: ["TXT"], regex: /\.(txt)$/i },
 };
+/**
+ * Determines if a SelectConnect `authorize` rule exists on a foreign app
+ * for this app.
+ *
+ * @param sourceApp FDC3 AppD definition for the app we're working on
+ * @param targetApp FDC3 AppD definition for the app we want to connect to
+ * @param contextType Optional context type to defined the rule
+ * @returns true if there is a matching rule
+ */
 const isInteropAuthorized = (sourceApp, targetApp, contextType) => {
     var _a, _b;
     const rules = ((_b = (_a = targetApp.manifest) === null || _a === void 0 ? void 0 : _a.interop) === null || _b === void 0 ? void 0 : _b.selectConnect) || [];
+    // Find all authorized apps for any rules that match this context type
     const allowedApps = rules.flatMap((rule) => {
         var _a;
         if (!contextType || (rule.contextType && rule.contextType !== contextType))
@@ -21,6 +31,12 @@ const isInteropAuthorized = (sourceApp, targetApp, contextType) => {
     });
     return allowedApps.some((rule) => rule.name === sourceApp.name);
 };
+/**
+ * Arranges an array of words for display to end user
+ * "apples"
+ * "apples or oranges"
+ * "apples, oranges, or bananas"
+ */
 const prettyList = (words) => {
     const { length } = words;
     if (length === 0)
@@ -31,20 +47,133 @@ const prettyList = (words) => {
         return `${words[0]} or ${words[1]}`;
     return `${words.slice(0, length - 2).join(", ")} or ${words[length - 1]}`;
 };
+/**
+ *
+ * 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 const SmartDesktopClient = {
     getSDServerInfo: async () => await System.getSDServerInfo(),
+    /**
+     * Confirm the Smart Desktop Server is enabled.  This should be true before constructing and using a client.
+     *
+     * @static
+     * @returns {Promise<Boolean>}
+     */
     async isEnabled() {
         const { enabled } = await System.getSDServerInfo();
         return enabled;
     },
+    /**
+     * Get the smart desktop server base URL.
+     *
+     * @static
+     * @returns {Promise<Boolean>}
+     */
     async applicationRoot() {
         const { applicationRoot } = await System.getSDServerInfo();
         return applicationRoot ? applicationRoot : null;
     },
+    /**
+     *
+     */
     async projectConfig() {
         const { projectConfig } = await System.getSDServerInfo();
         return projectConfig ? projectConfig : null;
     },
+    /**
+     * Get list of all AppD applications
+     *
+     * @returns {Promise<{ err:any, data:any}>}
+     *
+     * @example
+     * let { err, apps } = await SmartDesktopClient.getApps();
+     */
     async getApps() {
         var _a;
         Logger.system.log("SmartDesktopClient.getApps");
@@ -52,12 +181,24 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.getApps result", err ? err : "successful", response);
         return { err, apps: (_a = response === null || response === void 0 ? void 0 : response.data.applications) !== null && _a !== void 0 ? _a : [] };
     },
+    /**
+     * Get list of all Menus
+     *
+     * @returns {Promise<{ err:any, data:any}>}
+     *
+     * @example
+     * let { err, menus } = await SmartDesktopClient.getMenus();
+     */
     async getMenus() {
         Logger.system.log("ConfigClient getValue 'finsemble.toolbarMenus'");
         const { err, data } = await ConfigClient.getValue({ field: "finsemble.toolbarMenus" });
         Logger.system.log("finsemble.toolbarMenus result", err ? err : "successful", data);
         return { err, menus: data };
     },
+    /**
+     * Get the config.extensions.preloads object (from appd.json), which includes all registered
+     * preloads and their details
+     */
     async getPreloads() {
         var _a;
         Logger.system.log("SmartDesktopClient.getPreloads");
@@ -65,6 +206,12 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.getPreloads result", err ? err : "successful", response);
         return { err, data: (_a = response === null || response === void 0 ? void 0 : response.data.preloads) !== null && _a !== void 0 ? _a : {} };
     },
+    /**
+     * Get config for the specified AppD app.
+     *
+     * @example
+     * let { err, config } = await SmartDesktopClient.getAppConfig("testApp");
+     */
     async getAppConfig(appId) {
         var _a;
         Logger.system.log("SmartDesktopClient.getAppConfig", appId);
@@ -72,10 +219,19 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.getAppConfig result", err ? err : "successful", response);
         return { err, config: (_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : {} };
     },
+    /**
+     * Helper function returning a AppD config template with Finsemble component in manifest property.
+     *
+     * @returns {Promise<{ config: any }>}
+     *
+     * @example
+     * let { config } = await SmartDesktopClient.getAppConfigTemplate();
+     */
     async getAppConfigTemplate() {
         Logger.system.log("SmartDesktopClient.getAppConfigTemplate");
         const manifestJson = {
             window: {
+                // url: "$applicationRoot/components/welcome/welcome.html",
                 url: "",
                 width: 1280,
                 height: 600,
@@ -102,6 +258,12 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.getAppConfigTemplate result", appdConfigTemplate);
         return { config: appdConfigTemplate };
     },
+    /**
+     * Add AppD application, which will modify Finsemble config and invoke REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.addApp("testApp", config);
+     */
     async addApp(appId, appConfig) {
         Logger.system.log("SmartDesktopClient.addApp", appId, appConfig);
         const { err } = await RouterClient.query(`${MAKER_TOPIC}.addApp`, { appId, appConfig });
@@ -132,12 +294,21 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.updateMenu result", err ? err : "successful");
         return { err };
     },
+    /**
+     * Add AppD application, which will modify Finsemble config and invoke REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.updateApp("testApp", config);
+     */
     async updateApp(appId, appConfig) {
         Logger.system.log("SmartDesktopClient.updateApp", appId, appConfig);
         const { err } = await RouterClient.query(`${MAKER_TOPIC}.updateApp`, { appId, appConfig });
         Logger.system.log("SmartDesktopClient.updateApp result", err ? err : "successful");
         return { err };
     },
+    /**
+     * Create/updates the preload with the specific preload alias
+     */
     async savePreload(oldAlias, newAlias, detail) {
         Logger.system.log("SmartDesktopClient.savePreload");
         const { err } = await RouterClient.query(`${MAKER_TOPIC}.savePreload`, { oldAlias, newAlias, detail });
@@ -151,6 +322,12 @@ export const SmartDesktopClient = {
         }
         return { err };
     },
+    /**
+     * Remove AppD application, which will modify Finsemble config and invoke REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.deleteApp("testApp");
+     */
     async deleteApp(appId) {
         Logger.system.log("SmartDesktopClient.deleteApp", appId);
         const { err } = await RouterClient.query(`${MAKER_TOPIC}.deleteApp`, { appId });
@@ -164,6 +341,9 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.deleteMenu result", err ? err : "successful");
         return { err };
     },
+    /**
+     * Remove a given preload from the registry in the config
+     */
     async deletePreload(alias) {
         Logger.system.log("SmartDesktopClient.deletePreload");
         const { err } = await RouterClient.query(`${MAKER_TOPIC}.deletePreload`, { alias });
@@ -177,26 +357,53 @@ export const SmartDesktopClient = {
         }
         return { err };
     },
+    /**
+     * 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);
+     */
     async updateTheme(theme) {
         Logger.system.log("SmartDesktopClient.updateTheme", theme);
         const { err } = await RouterClient.query(`${MAKER_TOPIC}.updateTheme`, { theme });
         Logger.system.log("SmartDesktopClient.updateTheme result", err ? err : "successful");
         return { err };
     },
+    /**
+     * Get the theme from the REST API
+     *
+     * @returns {Promise<{ err, theme }>}
+     * @memberOf SmartDesktopClient
+     *
+     * @example
+     * let { err, theme } = await SmartDesktopClient.getTheme(cssData);
+     */
     async getTheme() {
         Logger.system.log("SmartDesktopClient.getTheme");
         const { err, response } = await RouterClient.query(`${MAKER_TOPIC}.getTheme`, {});
         Logger.system.log("SmartDesktopClient.getTheme result", err ? err : "successful");
         return { err, theme: response === null || response === void 0 ? void 0 : response.data };
     },
+    /**
+     * Add handler listening for theme updates
+     *
+     * @returns When called, unsubscribes the handler
+     */
     onThemeUpdated(themeUpdatedHandler) {
         RouterClient.addListener(`${UI_CHANGE_TOPIC}.themeUpdate`, themeUpdatedHandler);
         Logger.system.log("SmartDesktopClient.onThemeUpdated", themeUpdatedHandler);
         return () => RouterClient.removeListener(`${UI_CHANGE_TOPIC}.themeUpdate`, themeUpdatedHandler);
     },
+    /**
+     * Post a file to the smart desktop server
+     *
+     * @example
+     * ...
+     */
     async uploadAssets(assets, progress) {
         Logger.system.log("SmartDesktopClient.uploadAssets", assets);
         const applicationRoot = await this.applicationRoot();
+        // Returns a string of accepted file types if the asset does not match a known type
         const getAcceptedTypes = (asset) => {
             let acceptedTypes = [];
             let valid = false;
@@ -241,7 +448,9 @@ export const SmartDesktopClient = {
             xhr.addEventListener("progress", (e) => {
                 progress(Math.round((e.loaded / e.total) * 100));
             });
+            // xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
             xhr.onreadystatechange = () => {
+                // Call a function when the state changes.
                 if (xhr.readyState === XMLHttpRequest.DONE) {
                     progress(100);
                     if (xhr.status !== 200) {
@@ -264,12 +473,24 @@ export const SmartDesktopClient = {
             xhr.send(data);
         });
     },
+    /**
+     * Post images to the smart desktop server
+     *
+     * @example
+     * ...
+     */
     async uploadImages(files, progress) {
         return this.uploadAssets(files.map((file) => ({
             file,
             type: ["Image", "GIF"],
         })), progress);
     },
+    /**
+     * Post an image to the smart desktop server
+     *
+     * @example
+     * ...
+     */
     async uploadImage(file, progress) {
         return new Promise((resolve, reject) => {
             this.uploadImages([file], progress)
@@ -279,24 +500,51 @@ export const SmartDesktopClient = {
                 .catch(reject);
         });
     },
+    /**
+     * Update installer description by using REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.updateInstallerDescription(installerDescription);
+     */
     async updateInstallerDescription(installerDescription) {
         Logger.system.log("SmartDesktopClient updateInstallerDescription", installerDescription);
         const { err } = await REST.httpPatch(`/project/installer`, installerDescription);
         Logger.system.log("SmartDesktopClient.updateInstallerDescription Response", err ? err : "successful");
         return { err };
     },
+    /**
+     * Update installer description by using REST API to persist the change
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.updateInstallerDescription(installerDescription);
+     */
     async updateProjectSettings(settings) {
         const { err } = await REST.httpPatch(`/project/settings`, settings);
         return { err };
     },
+    /**
+     * Get project settings
+     *
+     * @example
+     * let { settings, err } = await SmartDesktopClient.getProjectSettings();
+     */
     async getProjectSettings() {
         const response = await REST.httpGet(`/project/settings`);
         return response.getData;
     },
+    /**
+     * Helper function -- progress descriptor for updating files
+     *
+     */
     progressIndicator(progress) {
         Logger.system.log("SmartDesktopClient.progressIndicator Console-Only", progress);
         console.log("Console-Only Progress Indicator:", progress);
     },
+    /**
+     * Update Finsemble toolbar icon file and transmit correspond ui-changed message so UI will pick up change
+     *
+     * @returns {Promise<{ err: any }>}
+     */
     async updateToolbarIcon(imageFile) {
         const TARGET_FILE = "assets/img/Finsemble_Toolbar_Icon.png";
         Logger.system.log("SmartDesktopClient.updateToolbarIcon", TARGET_FILE, imageFile);
@@ -308,11 +556,16 @@ export const SmartDesktopClient = {
             },
         ], this.progressIndicator);
         if (!err) {
+            // transmit change notification so Finsemble can dynamically update (see toolbar)
             RouterClient.transmit("Finsemble-ui-change.toolbarIconUpdate", {});
         }
         Logger.system.log("SmartDesktopClient.updateToolbarIcon result", err ? err : "successful");
         return { err, path: paths[0] };
     },
+    /**
+     * Update Finsemble taskbar icon file and transmit correspond ui-changed message so UI will pick up change
+     *
+     */
     async updateTaskbarIcon(imageFile) {
         const TARGET_FILE = "assets/img/Finsemble_Taskbar_Icon.png";
         Logger.system.log("SmartDesktopClient.updateTaskbarIcon", imageFile);
@@ -324,11 +577,16 @@ export const SmartDesktopClient = {
             },
         ], this.progressIndicator);
         if (!err) {
+            // transmit notification so Finsemble can dynamically update (e.g. toolbar, taskbar)
             RouterClient.transmit("Finsemble-ui-change.taskbarIconUpdate", {});
         }
         Logger.system.log("SmartDesktopClient.updateTaskbarIcon result", err ? err : "successful");
         return { err, path: paths[0] };
     },
+    /**
+     * Update system tray icon file and refresh config entry to trigger notification
+     *
+     */
     async updateSystemTrayIcon(imageFile) {
         const TARGET_FILE = "assets/img/Finsemble_SystemTray_Icon.png";
         Logger.system.log("SmartDesktopClient.updateSystemTrayIcon", imageFile);
@@ -339,11 +597,17 @@ export const SmartDesktopClient = {
                 targetPath: TARGET_FILE,
             },
         ], this.progressIndicator);
+        // since the icon URL is kept in config, refresh the config entry using the current value to trigger a notification
         const { err: error2 } = await RouterClient.query(`${MAKER_TOPIC}.refreshSystemTrayIconConfig`, {});
         Logger.system.log("SmartDesktopClient.updateSystemTrayIcon result", error1 || error2 ? { error1, error2 } : "successful");
+        // Jumping through typescript hoops due to CallbackError type
         const error = error1 || error2 || null;
         return { err: error ? error.toString() : null, path: paths[0] };
     },
+    /**
+     * Update the installer Icon file -- the change will not be picked up until the installer is built
+     *
+     */
     async updateInstallerIcon(iconFile) {
         const TARGET_FILE = "assets/img/installer_icon.ico";
         Logger.system.log("SmartDesktopClient.updateInstallerIcon", iconFile);
@@ -357,6 +621,9 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.updateSystemTrayIcon result", err ? err : "successful");
         return { err, path: paths[0] };
     },
+    /**
+     * Update the installer graphic file -- the change will not be picked up until the installer is built
+     */
     async updateInstallerGraphic(gifFile) {
         const TARGET_FILE = "assets/img/installer_spinner.gif";
         Logger.system.log("SmartDesktopClient.updateInstallerGraphic", gifFile);
@@ -370,6 +637,9 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.updateInstallerGraphic result", err ? err : "successful");
         return { err, path: paths[0] };
     },
+    /**
+     * Update the splash screen image file -- the change will not be picked up until Finsemble/FEA is restarted
+     */
     async updateSplashScreen(svgFile) {
         const TARGET_FILE = "assets/img/FinsembleSplash.png";
         Logger.system.log("SmartDesktopClient.updateSplashScreen", svgFile);
@@ -383,12 +653,20 @@ export const SmartDesktopClient = {
         Logger.system.log("SmartDesktopClient.updateSplashScreen result", err ? err : "successful");
         return { err, path: paths[0] };
     },
+    /**
+     * Helper function to update a single theme variable within Finsemble's theme
+     */
     async updateThemeVariable(varName, varValue) {
         const theme = {};
         theme[varName] = varValue;
         Logger.system.log("SmartDesktopClient.updateThemeVariable", theme);
         return this.updateTheme(theme);
     },
+    /**
+     * Save a .zip file of the project with `appName` to the local filesystem at `targetPath`
+     * @example
+     * let { err } = await SmartDesktopClient.createProjectZip("testApp", "~/Downloads/");
+     */
     async createProjectZip(appName, targetPath = undefined) {
         const applicationRoot = await this.applicationRoot();
         Logger.system.log("SmartDesktopClient.createProjectZip", applicationRoot);
@@ -423,10 +701,19 @@ export const SmartDesktopClient = {
             }
         });
     },
-    async copyProjectFiles(appName, targetPath = undefined) {
+    /**
+     * Copy project assets/config to target dir
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.createProjectZip("testApp", "~/Downloads/");
+     */
+    async copyProjectFiles(appName, targetPath = undefined // allow passing manually specified targetPath
+    ) {
         const applicationRoot = await this.applicationRoot();
         Logger.system.log("SmartDesktopClient.createProjectZip", applicationRoot);
         return new Promise((resolve, reject) => {
+            // callback to forward targetPath to the server REST API endpoint
+            // regardless of whether targetPath is manually specified or retrieved via showNativeOpenDialog
             const onTargetPath = (selectedTargetPath) => {
                 const endpointURL = `${applicationRoot}/project/${appName}/copy?targetPath=${encodeURIComponent(selectedTargetPath)}`;
                 Logger.system.debug(`copyProjectFiles: copying ${selectedTargetPath}, ${endpointURL}`);
@@ -443,9 +730,11 @@ export const SmartDesktopClient = {
                     .catch(reject);
             };
             if (targetPath) {
+                // we've manually specified a targetPath
                 onTargetPath(targetPath);
             }
             else {
+                // Open a native file selection dialog and relay the selected file to our callback
                 FEAGlobals.finsembleWindow.showNativeOpenDialog({
                     title: "Select Seed Project",
                     buttonLabel: "Copy to Seed Project",
@@ -462,6 +751,15 @@ export const SmartDesktopClient = {
             }
         });
     },
+    /**
+     * 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/");
+     */
     async selectProjectPath() {
         return new Promise((resolve, reject) => {
             FEAGlobals.finsembleWindow.showNativeOpenDialog({
@@ -481,9 +779,19 @@ export const SmartDesktopClient = {
             });
         });
     },
+    /**
+     * checkValidProjectName
+     */
     checkValidProjectName(name) {
         return /^[a-zA-Z0-9 \-_.]{1,}$/.test(name) && /[a-zA-Z0-9]{1,}/.test(name);
     },
+    /**
+     * 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) {
         if (url.length === 0) {
             return true;
@@ -496,6 +804,14 @@ export const SmartDesktopClient = {
     async isOutboundInteropAuthorized(sourceApp, targetApp, contextType) {
         return isInteropAuthorized(targetApp, sourceApp, contextType);
     },
+    /**
+     * Publish `.zip` file to the Cosaic Cloud
+     *
+     * @returns {Promise}
+     *
+     * @example
+     * let { err } = await SmartDesktopClient.publishToCosaicCloud();
+     */
     async publishToCosaicCloud(uuid) {
         const applicationRoot = await this.applicationRoot();
         Logger.system.log("SmartDesktopClient.publishToCosaicCloud", applicationRoot);
@@ -504,6 +820,7 @@ export const SmartDesktopClient = {
             const response = await fetch(endpointURL, {
                 method: "PUT",
             });
+            // We get json data back whether it's a 200 or 500 response
             const data = await response.json();
             if (response.ok) {
                 resolve(data);
@@ -513,6 +830,12 @@ export const SmartDesktopClient = {
             }
         });
     },
+    /**
+     * Get the progress of a publish request
+     *
+     * @returns {Promise}
+     *
+     */
     async getPublishProgress() {
         const applicationRoot = await this.applicationRoot();
         Logger.system.log("SmartDesktopClient.getPublishProgress", applicationRoot);
@@ -526,6 +849,10 @@ export const SmartDesktopClient = {
                 .catch(reject);
         });
     },
+    /**
+     * Resets the current project to factory defaults. Once complete, Finsemble is restarted
+     * so that the changes can take effect.
+     */
     async resetProject() {
         const applicationRoot = await this.applicationRoot();
         Logger.system.log("SmartDesktopClient.resetProject", applicationRoot);
@@ -538,6 +865,9 @@ export const SmartDesktopClient = {
         response.ok && Desktop.restartApplication();
         return [error, data];
     },
+    /**
+     * Saves the auth providers to config.json
+     */
     async getAuthenticationProviders() {
         const applicationRoot = await this.applicationRoot();
         Logger.system.log("SmartDesktopClient.getAuthenticationProviders", applicationRoot);
@@ -554,6 +884,9 @@ export const SmartDesktopClient = {
         }
         return data.providers;
     },
+    /**
+     * Saves the auth providers to config.json
+     */
     async setAuthenticationProviders(authenticationProviders) {
         const applicationRoot = await this.applicationRoot();
         Logger.system.log("SmartDesktopClient.setAuthenticationProviders", applicationRoot);