@finsemble/finsemble-ui 8.2.0 → 8.2.1-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,7 +11,7 @@
11
11
  *
12
12
  * 3) The client API provides automatic login capabilities for Finsemble components (password auto-fill).
13
13
  *
14
- * See the [Authentication tutorial](/docs/enterprise/authentication/) for an overview of using the Authentication Client.
14
+ * See the [Authentication tutorial](/docs/productivity/API-tutorials-and-refs/authentication/) for an overview of using the Authentication Client.
15
15
  *
16
16
  * @module AuthenticationClient
17
17
  */
@@ -40,7 +40,7 @@ import { SpawnParams } from "../platform/services/window/types";
40
40
  /**
41
41
  * During Finsemble's start-up process, this function must be invoked before Finsemble will start the application.
42
42
  * Once invoked, the authenticated user name and authorization credentials are received by the Authentication Service and published on the "AuthenticationService.authorization" channel.
43
- * Any component can revive the credentials by subscribing to that channel or by calling <a href="/docs/enterprise/authentication/#getCurrentCredentials">getCurrentCredentials</a>.
43
+ * Any component can revive the credentials by subscribing to that channel or by calling <a href="/docs/productivity/API-tutorials-and-refs/authentication/#getCurrentCredentials">getCurrentCredentials</a>.
44
44
  *
45
45
  * Note that all calls to Storage Client are keyed to the authenticated user. See <a href="/docs/reference/typedocs/modules/StorageClient#setUser">StorageClient#setUser</a>.
46
46
  * If authentication is not enabled, then "defaultUser" is used instead.
@@ -53,7 +53,7 @@ import { SpawnParams } from "../platform/services/window/types";
53
53
  */
54
54
  export declare const publishAuthorization: (user: string, credentials: any) => void;
55
55
  /**
56
- * Returns the current global credentials (as published through <a href="/docs/enterprise/authentication/#publishAuthorization">publishAuthorization</a>) or null if no credentials are set yet.
56
+ * Returns the current global credentials (as published through <a href="/docs/productivity/API-tutorials-and-refs/authentication#publishAuthorization">publishAuthorization</a>) or null if no credentials are set yet.
57
57
  * @param cb A function that returns the current credentials. Will return null/undefined if no credentials have yet been established.
58
58
  */
59
59
  export declare const getCurrentCredentials: (cb?: StandardErrorCallback<any>) => StandardPromise<any>;
@@ -106,7 +106,7 @@ export declare const appRejectAndRetrySignOn: (signOnKey: string, params: {
106
106
  userMsg?: string;
107
107
  }, cb: StandardCallback) => void;
108
108
  /**
109
- * Completes an OAuth2 authentication that was begun with <a href="/docs/enterprise/authentication/#beginAuthentication">beginAuthentication</a>.
109
+ * Completes an OAuth2 authentication that was begun with <a href="/docs/productivity/API-tutorials-and-refs/authentication#beginAuthentication">beginAuthentication</a>.
110
110
  * This function is called when an OAuth2 response is completed.
111
111
  * You should call this function from within the page that you specified in "redirect_uri" in your Authentication Profile config.
112
112
  * @param err The error to be returned if the method fails.
@@ -122,7 +122,7 @@ export declare const completeOAUTH: (err?: string | null, params?: any, cb?: Sta
122
122
  * in params.profile.
123
123
  *
124
124
  * @param params Parameters
125
- * @param params.profile The name of the authentication profile from the authentication config section. See [startup](/docs/smart-desktop/configuration/ConfigReference) for instance.
125
+ * @param params.profile The name of the authentication profile from the authentication config section. See [startup](/docs/reference/ConfigReference) for instance.
126
126
  * @param params.spawnParams Optionally specify parameters to send to spawn for spawning an authentication window. These parameters are the same as those found in <a href="/docs/reference/typedocs/modules/LauncherClient#spawn">LauncherClient#spawn</a>.
127
127
  * @param cb Returns an object containing the authentication response, i.e., OAuth credentials, etc
128
128
  */
@@ -11,7 +11,7 @@
11
11
  *
12
12
  * 3) The client API provides automatic login capabilities for Finsemble components (password auto-fill).
13
13
  *
14
- * See the [Authentication tutorial](/docs/enterprise/authentication/) for an overview of using the Authentication Client.
14
+ * See the [Authentication tutorial](/docs/productivity/API-tutorials-and-refs/authentication/) for an overview of using the Authentication Client.
15
15
  *
16
16
  * @module AuthenticationClient
17
17
  */
@@ -42,7 +42,7 @@ import { Startup } from "./Startup/Startup";
42
42
  /**
43
43
  * During Finsemble's start-up process, this function must be invoked before Finsemble will start the application.
44
44
  * Once invoked, the authenticated user name and authorization credentials are received by the Authentication Service and published on the "AuthenticationService.authorization" channel.
45
- * Any component can revive the credentials by subscribing to that channel or by calling <a href="/docs/enterprise/authentication/#getCurrentCredentials">getCurrentCredentials</a>.
45
+ * Any component can revive the credentials by subscribing to that channel or by calling <a href="/docs/productivity/API-tutorials-and-refs/authentication/#getCurrentCredentials">getCurrentCredentials</a>.
46
46
  *
47
47
  * Note that all calls to Storage Client are keyed to the authenticated user. See <a href="/docs/reference/typedocs/modules/StorageClient#setUser">StorageClient#setUser</a>.
48
48
  * If authentication is not enabled, then "defaultUser" is used instead.
@@ -60,7 +60,7 @@ export const publishAuthorization = (user, credentials) => {
60
60
  });
61
61
  };
62
62
  /**
63
- * Returns the current global credentials (as published through <a href="/docs/enterprise/authentication/#publishAuthorization">publishAuthorization</a>) or null if no credentials are set yet.
63
+ * Returns the current global credentials (as published through <a href="/docs/productivity/API-tutorials-and-refs/authentication#publishAuthorization">publishAuthorization</a>) or null if no credentials are set yet.
64
64
  * @param cb A function that returns the current credentials. Will return null/undefined if no credentials have yet been established.
65
65
  */
66
66
  export const getCurrentCredentials = async (cb) => {
@@ -152,7 +152,7 @@ const appRejectSignOn = (signOnKey) => {
152
152
  RouterClient.transmit("authentication.appRejectSignOn", { signOnKey });
153
153
  };
154
154
  /**
155
- * Completes an OAuth2 authentication that was begun with <a href="/docs/enterprise/authentication/#beginAuthentication">beginAuthentication</a>.
155
+ * Completes an OAuth2 authentication that was begun with <a href="/docs/productivity/API-tutorials-and-refs/authentication#beginAuthentication">beginAuthentication</a>.
156
156
  * This function is called when an OAuth2 response is completed.
157
157
  * You should call this function from within the page that you specified in "redirect_uri" in your Authentication Profile config.
158
158
  * @param err The error to be returned if the method fails.
@@ -195,7 +195,7 @@ export const completeOAUTH = async (err, params, cb) => {
195
195
  * in params.profile.
196
196
  *
197
197
  * @param params Parameters
198
- * @param params.profile The name of the authentication profile from the authentication config section. See [startup](/docs/smart-desktop/configuration/ConfigReference) for instance.
198
+ * @param params.profile The name of the authentication profile from the authentication config section. See [startup](/docs/reference/ConfigReference) for instance.
199
199
  * @param params.spawnParams Optionally specify parameters to send to spawn for spawning an authentication window. These parameters are the same as those found in <a href="/docs/reference/typedocs/modules/LauncherClient#spawn">LauncherClient#spawn</a>.
200
200
  * @param cb Returns an object containing the authentication response, i.e., OAuth credentials, etc
201
201
  */
@@ -8,7 +8,7 @@
8
8
  * Values modified at runtime are not persisted.
9
9
  *
10
10
  *
11
- * See the [Configuration tutorial](/docs/smart-desktop/configuration/) for a configuration overview.
11
+ * See the [Configuration tutorial](/docs/customize/customize-with-SDK/configuration) for a configuration overview.
12
12
  *
13
13
  * @module ConfigClient
14
14
  */
@@ -262,7 +262,7 @@ export declare const removeListeners: (params: RemoveListenersType, fn?: Listene
262
262
  * ```
263
263
  *
264
264
  * @param {object} params
265
- * @param {object} params.newConfig Provides the configuration properties to add into the existing configuration under manifest.finsemble. This config must match the Finsemble config requirements as described in the [Configuration tutorial](/docs/smart-desktop/configuration/). It can include importConfig references to dynamically fetch additional configuration files.
265
+ * @param {object} params.newConfig Provides the configuration properties to add into the existing configuration under manifest.finsemble. This config must match the Finsemble config requirements as described in the [Configuration tutorial](/docs/customize/customize-with-SDK/configuration). It can include importConfig references to dynamically fetch additional configuration files.
266
266
  * @param {boolean} params.overwrite If true then overwrite any preexisting config with new config (can only set to true when running from same origin, not cross-domain); if false then newConfig must not match properties of existing config, including service and component configuration.
267
267
  * @param {boolean} params.replace True specifies any component, app, or service definitions in the new config will place all existing non-system component and service configuration
268
268
  * @param {StandardErrorCallback} callback Callback to be invoked upon task completion.
@@ -8,7 +8,7 @@
8
8
  * Values modified at runtime are not persisted.
9
9
  *
10
10
  *
11
- * See the [Configuration tutorial](/docs/smart-desktop/configuration/) for a configuration overview.
11
+ * See the [Configuration tutorial](/docs/customize/customize-with-SDK/configuration) for a configuration overview.
12
12
  *
13
13
  * @module ConfigClient
14
14
  */
@@ -460,7 +460,7 @@ export const removeListeners = (params, fn, cb) => {
460
460
  * ```
461
461
  *
462
462
  * @param {object} params
463
- * @param {object} params.newConfig Provides the configuration properties to add into the existing configuration under manifest.finsemble. This config must match the Finsemble config requirements as described in the [Configuration tutorial](/docs/smart-desktop/configuration/). It can include importConfig references to dynamically fetch additional configuration files.
463
+ * @param {object} params.newConfig Provides the configuration properties to add into the existing configuration under manifest.finsemble. This config must match the Finsemble config requirements as described in the [Configuration tutorial](/docs/customize/customize-with-SDK/configuration). It can include importConfig references to dynamically fetch additional configuration files.
464
464
  * @param {boolean} params.overwrite If true then overwrite any preexisting config with new config (can only set to true when running from same origin, not cross-domain); if false then newConfig must not match properties of existing config, including service and component configuration.
465
465
  * @param {boolean} params.replace True specifies any component, app, or service definitions in the new config will place all existing non-system component and service configuration
466
466
  * @param {StandardErrorCallback} callback Callback to be invoked upon task completion.
@@ -149,7 +149,7 @@ export declare const spawnDialog: (params: SpawnParams, inputParams: any, dialog
149
149
  * @param {string} type Component type to open. The <code>type</code> must be a key in the finsemble.components configuration object.
150
150
  * If "yesNo" or "singleInput" are provided (legacy component names) then these will be converted to "YesNoDialog" and "SingleInputDialog"
151
151
  * (current component names).
152
- * @param {object} options Options to pass into the opened window. See the [Dialogs tutorial](/docs/smart-desktop/user-experience/component-catalog/dialogs) for more info about the options that you can pass to the "YesNoDialog" and the "SingleInputDialog".
152
+ * @param {object} options Options to pass into the opened window. See the [Dialogs tutorial](/docs/customize/customize-with-SDK/user-experience/component-catalog/dialogs) for more info about the options that you can pass to the "YesNoDialog" and the "SingleInputDialog".
153
153
  * @param {function} onUserInput Callback to be invoked when the user interacts with the dialog.
154
154
  */
155
155
  export declare const open: (type: string, options: any, onUserInput: StandardErrorCallback<any>) => Promise<string | null>;
@@ -458,7 +458,7 @@ export const spawnDialog = async (params, inputParams, dialogResponseCallback, c
458
458
  * @param {string} type Component type to open. The <code>type</code> must be a key in the finsemble.components configuration object.
459
459
  * If "yesNo" or "singleInput" are provided (legacy component names) then these will be converted to "YesNoDialog" and "SingleInputDialog"
460
460
  * (current component names).
461
- * @param {object} options Options to pass into the opened window. See the [Dialogs tutorial](/docs/smart-desktop/user-experience/component-catalog/dialogs) for more info about the options that you can pass to the "YesNoDialog" and the "SingleInputDialog".
461
+ * @param {object} options Options to pass into the opened window. See the [Dialogs tutorial](/docs/customize/customize-with-SDK/user-experience/component-catalog/dialogs) for more info about the options that you can pass to the "YesNoDialog" and the "SingleInputDialog".
462
462
  * @param {function} onUserInput Callback to be invoked when the user interacts with the dialog.
463
463
  */
464
464
  export const open = async (type, options, onUserInput) => {
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * The Distributed Store Client handles creating, retrieving, and destroying stores. Stores are used to save and retrieve data either locally or globally.
7
7
  * This data is not persisted. You can add listeners at multiple levels (store or field), and get the updated data as it's updated in the store.
8
- * Fields are stored within the store as key/value pair. For more information, see the <a href="/docs/enterprise/storage/DistributedStore">Distributed Store tutorial</a>.
8
+ * Fields are stored within the store as key/value pair. For more information, see the <a href="/docs/productivity/API-tutorials-and-refs/storage/DistributedStore">Distributed Store tutorial</a>.
9
9
  * @module DistributedStoreClient
10
10
  */
11
11
  /**
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * The Distributed Store Client handles creating, retrieving, and destroying stores. Stores are used to save and retrieve data either locally or globally.
7
7
  * This data is not persisted. You can add listeners at multiple levels (store or field), and get the updated data as it's updated in the store.
8
- * Fields are stored within the store as key/value pair. For more information, see the <a href="/docs/enterprise/storage/DistributedStore">Distributed Store tutorial</a>.
8
+ * Fields are stored within the store as key/value pair. For more information, see the <a href="/docs/productivity/API-tutorials-and-refs/storage/DistributedStore">Distributed Store tutorial</a>.
9
9
  * @module DistributedStoreClient
10
10
  */
11
11
  /**
@@ -10,7 +10,7 @@
10
10
  *
11
11
  * Two types of hotkeys are supported: **local hotkeys**, which will only be triggered when the window which defined the hotkey is in focus, and **global hotkeys**, which will are triggered anytime, regardless of whether the window is in focus or not.
12
12
  *
13
- * For more information, see the [Hotkey tutorial](/docs/smart-desktop/user-experience/Hotkeys).
13
+ * For more information, see the [Hotkey tutorial](/docs/customize/customize-with-SDK/user-experience/Hotkeys).
14
14
  * @module HotkeyClient
15
15
  */
16
16
  /**
@@ -78,7 +78,7 @@ export declare const getMonitorInfo: (params?: {
78
78
  * FSBL.Clients.LauncherClient.showWindow({windowName: "Welcome Component-86-3416-Finsemble", componentType: "Welcome Component"}, {spawnIfNotFound: true}, (err, data)=> {});
79
79
  * ```
80
80
  * @param windowIdentifier A windowIdentifier. This is an object containing windowName and componentType. If windowName is not given, Finsemble will try to find it by componentType.
81
- * @param params Configuration settings from the <i><a href="/docs/smart-desktop/configuration/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
81
+ * @param params Configuration settings from the <i><a href="/docs/reference/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
82
82
  * These are the same as <a href="/docs/reference/typedocs/modules/LauncherClient#spawn">LauncherClient.spawn()</a> with the following exceptions:
83
83
  * <ul>
84
84
  * <li><b>monitor</b> - Same as spawn() except that null or undefined means don't move the window to a different monitor.</li>
@@ -94,8 +94,8 @@ export declare const getMonitorInfo: (params?: {
94
94
  * <li><b>error</b>: an object containing details related to the reason the call failed and where the exception occurred. This object will be null if the call has succeeded.</li>
95
95
  * <li><b>data</b>: an object with the following information:
96
96
  * <ul>
97
- * <li><b>windowIdentifier</b> - The <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames">WindowIdentifier</a> for the new window.</li>
98
- * <li><b>windowDescriptor</b> - The <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames">WindowDescriptor</a> of the new window.</li>
97
+ * <li><b>windowIdentifier</b> - The <a href="/docs/productivity/componentTypesAndWindowNames">WindowIdentifier</a> for the new window.</li>
98
+ * <li><b>windowDescriptor</b> - The <a href="/docs/productivity/componentTypesAndWindowNames">WindowDescriptor</a> of the new window.</li>
99
99
  * <li><b>finWindow</b> - A <code>finWindow</code> object referencing the new window.</li>
100
100
  * </ul>
101
101
  * </li>
@@ -126,7 +126,7 @@ export declare const toggleWindowOnClick: (element: HTMLElement, windowLocator:
126
126
  * FSBL.Clients.LauncherClient.spawn("Welcome Component", {left: 0, top: 0, position: "relative"}, (err, data)=> {});
127
127
  * ```
128
128
  * @param component The application or component to spawn.
129
- * @param params Configuration settings from the <i><a href="/docs/smart-desktop/configuration/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
129
+ * @param params Configuration settings from the <i><a href="/docs/reference/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
130
130
  * @param cb Function invoked after the window is created
131
131
  */
132
132
  export declare const spawn: (component: string, params: SpawnParams, cb?: StandardErrorCallback<SpawnResponse>) => Promise<{
@@ -16,7 +16,7 @@
16
16
  * This CSS-style positioning allows windows to be positioned on the `left`, `right`, `top`, or `bottom` of the end user’s screen for instance; we also developed new positions, such as `adjacent`, which allows a child window to spawn adjacent to their parent.
17
17
  * Components can be positioned and sized by percentage, relative to the monitor or to each other (nested windows).
18
18
  *
19
- * The Launcher Client frequently uses the parameters <code>windowName</code> and <code>componentType</code>. [Learn more about them here](/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames).
19
+ * The Launcher Client frequently uses the parameters <code>windowName</code> and <code>componentType</code>. [Learn more about them here](/docs/productivity/componentTypesAndWindowNames).
20
20
  * @module LauncherClient
21
21
  */
22
22
  import { getMyWindowIdentifier as getMyWindowIdentifierUtil, clone } from "../common/util";
@@ -134,7 +134,7 @@ export const getMonitorInfo = async (params = {}, cb) => {
134
134
  * FSBL.Clients.LauncherClient.showWindow({windowName: "Welcome Component-86-3416-Finsemble", componentType: "Welcome Component"}, {spawnIfNotFound: true}, (err, data)=> {});
135
135
  * ```
136
136
  * @param windowIdentifier A windowIdentifier. This is an object containing windowName and componentType. If windowName is not given, Finsemble will try to find it by componentType.
137
- * @param params Configuration settings from the <i><a href="/docs/smart-desktop/configuration/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
137
+ * @param params Configuration settings from the <i><a href="/docs/reference/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
138
138
  * These are the same as <a href="/docs/reference/typedocs/modules/LauncherClient#spawn">LauncherClient.spawn()</a> with the following exceptions:
139
139
  * <ul>
140
140
  * <li><b>monitor</b> - Same as spawn() except that null or undefined means don't move the window to a different monitor.</li>
@@ -150,8 +150,8 @@ export const getMonitorInfo = async (params = {}, cb) => {
150
150
  * <li><b>error</b>: an object containing details related to the reason the call failed and where the exception occurred. This object will be null if the call has succeeded.</li>
151
151
  * <li><b>data</b>: an object with the following information:
152
152
  * <ul>
153
- * <li><b>windowIdentifier</b> - The <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames">WindowIdentifier</a> for the new window.</li>
154
- * <li><b>windowDescriptor</b> - The <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames">WindowDescriptor</a> of the new window.</li>
153
+ * <li><b>windowIdentifier</b> - The <a href="/docs/productivity/componentTypesAndWindowNames">WindowIdentifier</a> for the new window.</li>
154
+ * <li><b>windowDescriptor</b> - The <a href="/docs/productivity/componentTypesAndWindowNames">WindowDescriptor</a> of the new window.</li>
155
155
  * <li><b>finWindow</b> - A <code>finWindow</code> object referencing the new window.</li>
156
156
  * </ul>
157
157
  * </li>
@@ -296,7 +296,7 @@ const callSpawn = async (params) => {
296
296
  * FSBL.Clients.LauncherClient.spawn("Welcome Component", {left: 0, top: 0, position: "relative"}, (err, data)=> {});
297
297
  * ```
298
298
  * @param component The application or component to spawn.
299
- * @param params Configuration settings from the <i><a href="/docs/smart-desktop/configuration/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
299
+ * @param params Configuration settings from the <i><a href="/docs/reference/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i> section of the application manifest may be used as parameters to this function, except for the `options` element.
300
300
  * @param cb Function invoked after the window is created
301
301
  */
302
302
  export const spawn = async (component, params, cb) => {
package/clients/logger.js CHANGED
@@ -8,7 +8,7 @@
8
8
  * By default, only error and warning messages are captured by the Logger, with the other message types (e.g., log, info, debug) disabled.
9
9
  * Which message types are enabled or disabled is fully controlled from the <a href="/docs/troubleshooting/CentralLogger">Central Logger</a> - this means developers can fully instrument their code once and dynamically enable and disable logging later, as needed, for debugging or field support.
10
10
  *
11
- * The Finsemble team uses the Central Logger to <a href="/docs/troubleshooting/">capture log message for field support</a>.
11
+ * The Finsemble team uses the Central Logger to <a href="/docs/troubleshooting/troubleshooting">capture log message for field support</a>.
12
12
  * Finsemble customers, building their own Finsemble applications, have the option to do the same.
13
13
  *
14
14
  * **Note:** The Logger Client **wraps** all console logging (e.g., `console.error`, `console.log`) so these message can also be captured and viewed in the Central Logger, but console logging is never disabled locally. For better performance, we recommend most of your code's instrumentation be based on the Logger Client (e.g., `FSBL.Clients.Logger.debug(...)` instead of the `console.debug(...)`).
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * The Search Client allows for any window launched by Finsemble to act as a search provider or query against the registered providers.
7
7
  *
8
- * See the <a href="/docs/enterprise/search/">Search tutorial</a> for an overview of using the Search Client.
8
+ * See the <a href="/docs/productivity/API-tutorials-and-refs/search">Search tutorial</a> for an overview of using the Search Client.
9
9
  * @module SearchClient
10
10
  */
11
11
  /**
@@ -6,7 +6,7 @@
6
6
  * The Storage Client handles saving and retrieving data for your smart desktop.
7
7
  *
8
8
  *
9
- * See the <a href="/docs/enterprise/storage/storingData">Storing Data tutorial</a> for an overview of using the Storage Client.
9
+ * See the <a href="/docs/productivity/API-tutorials-and-refs/storage/storingData">Storing Data tutorial</a> for an overview of using the Storage Client.
10
10
  * @module StorageClient
11
11
  */
12
12
  import { ComponentMutateParams } from "../platform/services/window/types";
@@ -6,7 +6,7 @@
6
6
  * The Storage Client handles saving and retrieving data for your smart desktop.
7
7
  *
8
8
  *
9
- * See the <a href="/docs/enterprise/storage/storingData">Storing Data tutorial</a> for an overview of using the Storage Client.
9
+ * See the <a href="/docs/productivity/API-tutorials-and-refs/storage/storingData">Storing Data tutorial</a> for an overview of using the Storage Client.
10
10
  * @module StorageClient
11
11
  */
12
12
  import { Logger } from "./logger";
@@ -5,9 +5,9 @@
5
5
  /**
6
6
  * The Workspace Client manages all calls to load, save, rename, and delete workspaces.
7
7
  *
8
- * The Workspace Client uses the `windowIdentifier` parameter. <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames">Learn more about them here</a>.
8
+ * The Workspace Client uses the `windowIdentifier` parameter. <a href="/docs/productivity/componentTypesAndWindowNames">Learn more about them here</a>.
9
9
  *
10
- * See the <a href="/docs/smart-desktop/windows-and-workspaces/Workspaces">Workspace tutorial</a> for an overview of using the Workspace Client.
10
+ * See the <a href="/docs/productivity/Workspaces">Workspace tutorial</a> for an overview of using the Workspace Client.
11
11
  * @module WorkspaceClient
12
12
  */
13
13
  import { RouterResponse } from "./routerClient";
@@ -5,9 +5,9 @@
5
5
  /**
6
6
  * The Workspace Client manages all calls to load, save, rename, and delete workspaces.
7
7
  *
8
- * The Workspace Client uses the `windowIdentifier` parameter. <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames">Learn more about them here</a>.
8
+ * The Workspace Client uses the `windowIdentifier` parameter. <a href="/docs/productivity/componentTypesAndWindowNames">Learn more about them here</a>.
9
9
  *
10
- * See the <a href="/docs/smart-desktop/windows-and-workspaces/Workspaces">Workspace tutorial</a> for an overview of using the Workspace Client.
10
+ * See the <a href="/docs/productivity/Workspaces">Workspace tutorial</a> for an overview of using the Workspace Client.
11
11
  * @module WorkspaceClient
12
12
  */
13
13
  /**
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * <h2>Deprecated: Linker Client (Finsemble Workspaces)</h2>
7
7
  *
8
- * The Linker API has been DEPRECATED. Please use <a href="/docs/smart-desktop/interop/">FDC3 interop</a> which provides an industry standard API for exchanging
8
+ * The Linker API has been DEPRECATED. Please use <a href="/docs/connect-apps/interop/">FDC3 interop</a> which provides an industry standard API for exchanging
9
9
  * context between apps, including channel linking.
10
10
  *
11
11
  * The Linker API allows components to synchronize on a piece of data. For instance, an end user can use the Linker to link multiple components by stock symbol.
@@ -17,9 +17,9 @@
17
17
  * The Linker API doesn't proscribe any specific format for context or set of labels.
18
18
  *
19
19
  * Behind the scenes, the Linker Service coordinates Linker activity between components. It keeps track of the available channels and channel assignments.
20
- * It uses a dedicated store (<a href="/docs/enterprise/storage/DistributedStore">the Distributed Store</a>) to maintain this information and also persists the information to workspaces (<a href="/docs/reference/typedocs/modules/WorkspaceClient">Workspace Client</a>).
20
+ * It uses a dedicated store (<a href="/docs/productivity/API-tutorials-and-refs/storage/DistributedStore">the Distributed Store</a>) to maintain this information and also persists the information to workspaces (<a href="/docs/reference/typedocs/modules/WorkspaceClient">Workspace Client</a>).
21
21
  *
22
- * The Linker Client frequently uses the parameters <code>windowIdentifier</code> and <code>componentType</code>. <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames">Learn more about them here</a>.
22
+ * The Linker Client frequently uses the parameters <code>windowIdentifier</code> and <code>componentType</code>. <a href="/docs/productivity/componentTypesAndWindowNames">Learn more about them here</a>.
23
23
  *
24
24
  * For more information, see the <a href="/docs/deprecated/Linking">Linking tutorial</a>.
25
25
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@finsemble/finsemble-ui",
3
- "version": "8.2.0",
3
+ "version": "8.2.1-beta.1",
4
4
  "description": "This library has been deprecated and is being maintained for long term support. Finsemble's UI components can now be imported directly from @finsemble/finsemble-core. See https://documentation.finsemble.com/tutorial-UIComponents.html",
5
5
  "files": [
6
6
  "*.ts",
@@ -32,7 +32,7 @@ export interface IAction {
32
32
  component?: string;
33
33
  /**
34
34
  * The spawnParams passed to the spawn function. These are the configuration settings from the
35
- * <i><a href="/docs/smart-desktop/configuration/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i>
35
+ * <i><a href="/docs/reference/ConfigReference#finsemble-appd---manifest-window">finsemble.appd[].manifest.window</a></i>
36
36
  * section of the application manifest, except for the `options` element.
37
37
  */
38
38
  spawnParams?: any;
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../../../src/platform/services/storage/adapters/base.ts"],"names":[],"mappings":"AACA,WAAW;AACX,gCAAgC;AAChC,+BAA+B;AAE/B,MAAM,WAAW,GAAG,UAA8B,IAAY;IAC7D,IAAI,IAAI,EAAE;QACT,IAAI;YACH,oGAAoG;YACpG,IAAK,MAAc,CAAC,eAAe,EAAE;gBACnC,MAAc,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;aACtD;iBAAM;gBACN,OAAO,CAAC,KAAK,CAAC,sEAAsE,CAAC,CAAC;aACtF;SACD;QAAC,OAAO,CAAC,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC;SAC5C;KACD;IACD,IAAI,CAAC,WAAW,GAAG,UAAU,QAAgB;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1B,CAAC,CAAC;IAEF,IAAI,CAAC,OAAO,GAAG,UAAU,IAAY;QACpC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACtB,CAAC,CAAC;IAEF,IAAI,CAAC,IAAI,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAChE,MAAM,GAAG,GAAG,wDAAwD,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,GAAG,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAC/D,MAAM,GAAG,GAAG,uDAAuD,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,IAAI,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAChE,MAAM,GAAG,GAAG,wDAAwD,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,MAAM,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAClE,MAAM,GAAG,GAAG,0DAA0D,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,UAAU,GAAG,UAAU,MAAyB,EAAE,QAAkB;QACxE,MAAM,GAAG,GAAG,+DAA+D,CAAC;QAC5E,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,KAAK,GAAG,UAAU,QAAkB;QACxC,MAAM,GAAG,GAAG,yDAAyD,CAAC;QACtE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,WAAW,GAAG,cAAa,CAAC,CAAC;IAElC,uEAAuE;IACvE,IAAI,CAAC,cAAc,GAAG,UAAU,IAAkB,EAAE,MAAuB;QAC1E,OAAO,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;IAC1E,CAAC,CAAC;IAEF,oCAAoC;IACpC,IAAI,CAAC,aAAa,GAAG,UAAU,IAAkB,EAAE,MAAuB;QACzE,IAAI,OAAO,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC;QACnE,IAAI,WAAW,IAAI,MAAM,EAAE;YAC1B,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;SACrC;QACD,OAAO,OAAO,CAAC;IAChB,CAAC,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,WAAW,CAAC"}
1
+ {"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../../../src/platform/services/storage/adapters/base.ts"],"names":[],"mappings":"AACA,WAAW;AACX,gCAAgC;AAChC,+BAA+B;AAE/B,MAAM,WAAW,GAAG,UAA8B,IAAY;IAC7D,IAAI,IAAI,EAAE;QACT,IAAI;YACH,oGAAoG;YACpG,IAAK,MAAc,CAAC,eAAe,EAAE;gBACnC,MAAc,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;aACtD;iBAAM;gBACN,OAAO,CAAC,KAAK,CAAC,sEAAsE,CAAC,CAAC;aACtF;SACD;QAAC,OAAO,CAAC,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC;SAC5C;KACD;IACD,IAAI,CAAC,WAAW,GAAG,UAAU,QAAgB;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1B,CAAC,CAAC;IAEF,IAAI,CAAC,OAAO,GAAG,UAAU,IAAY;QACpC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACtB,CAAC,CAAC;IAEF,IAAI,CAAC,IAAI,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAChE,MAAM,GAAG,GAAG,wDAAwD,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,GAAG,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAC/D,MAAM,GAAG,GAAG,uDAAuD,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,IAAI,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAChE,MAAM,GAAG,GAAG,wDAAwD,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,MAAM,GAAG,UAAU,MAAuB,EAAE,QAAkB;QAClE,MAAM,GAAG,GAAG,0DAA0D,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,UAAU,GAAG,UAAU,MAAuB,EAAE,QAAkB;QACtE,MAAM,GAAG,GAAG,+DAA+D,CAAC;QAC5E,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,KAAK,GAAG,UAAU,QAAkB;QACxC,MAAM,GAAG,GAAG,yDAAyD,CAAC;QACtE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,WAAW,GAAG,cAAa,CAAC,CAAC;IAElC,uEAAuE;IACvE,IAAI,CAAC,cAAc,GAAG,UAAU,IAAkB,EAAE,MAAuB;QAC1E,OAAO,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;IAC1E,CAAC,CAAC;IAEF,oCAAoC;IACpC,IAAI,CAAC,aAAa,GAAG,UAAU,IAAkB,EAAE,MAAuB;QACzE,IAAI,OAAO,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC;QACnE,IAAI,WAAW,IAAI,MAAM,EAAE;YAC1B,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;SACrC;QACD,OAAO,OAAO,CAAC;IAChB,CAAC,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,WAAW,CAAC"}
@@ -7,9 +7,7 @@ export declare type StorageKeyTopic = {
7
7
  export interface IBaseStorage {
8
8
  baseName: string;
9
9
  userName: string;
10
- clearCache: (params: {
11
- topic: string;
12
- }, callback: Function) => void;
10
+ clearCache: (params: StorageKeyTopic, callback: Function) => void;
13
11
  get: (params: StorageKeyTopic, callback: Function) => void;
14
12
  save: (params: StorageKeyTopic, callback: Function) => void;
15
13
  delete: (params: StorageKeyTopic, callback: Function) => void;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/platform/services/storage/adapters/types.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,YAAY;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IACpE,GAAG,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC3D,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC5D,MAAM,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC9D,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC5D,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IACpC,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,cAAc,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,KAAK,MAAM,CAAC;IACxE,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,KAAK,MAAM,CAAC;CACvE"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/platform/services/storage/adapters/types.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,YAAY;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAClE,GAAG,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC3D,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC5D,MAAM,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC9D,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC5D,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IACpC,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,cAAc,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,KAAK,MAAM,CAAC;IACxE,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,KAAK,MAAM,CAAC;CACvE"}
@@ -687,7 +687,7 @@ export declare type SpawnParams = {
687
687
  */
688
688
  windowType?: WindowTypes;
689
689
  /**
690
- * Component instances are often referred to in Finsemble API calls via a <a href="/docs/smart-desktop/windows-and-workspaces/ComponentTypesAndWindowNames#windowidentifier">windowIdentifier</a>. A windowIdentifier is an object with both windowName and componentType properties.
690
+ * Component instances are often referred to in Finsemble API calls via a <a href="/docs/productivity/componentTypesAndWindowNames#windowidentifier">windowIdentifier</a>. A windowIdentifier is an object with both windowName and componentType properties.
691
691
  * @private
692
692
  */
693
693
  windowIdentifier?: WindowIdentifier;