Workspace/v17.2.0 (#695)

Updating to 17.2.

Additional examples demonstrating new workspace features in register-with-browser (language support in browser), use-notifications (ability to silence notification center if you have your own sound) and workspace-platform-starter (ability to experiment with language support, ability to test self hosted notification center and the option to easily add office apps to your app directory through a new app json file).

how-to/automation-testing/register-with-home-js/package.json

@@ -1,18 +1,18 @@
 {
 	"name": "automation-testing-register-with-home-js",
-	"version": "17.0.0",
+	"version": "17.2.0",
 	"description": "OpenFin Workspace Starter Automation Tests",
 	"scripts": {
 		"build": "echo Nothing to build",
-		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --reporter ./mocha.reporter.json --testFailCount 1 --workspace 17.0.15",
-		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 17.0.15",
-		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --reporter ./jasmine.reporter.json --testFailCount 1 --workspace 17.0.15",
-		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 17.0.15",
-		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jest --reporter ./jest.reporter.json --testFailCount 1 --workspace 17.0.15",
-		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 17.0.15",
-		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 17.0.15",
-		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 17.0.15",
-		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 17.0.15"
+		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --reporter ./mocha.reporter.json --testFailCount 1 --workspace 17.2.14",
+		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 17.2.14",
+		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --reporter ./jasmine.reporter.json --testFailCount 1 --workspace 17.2.14",
+		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 17.2.14",
+		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jest --reporter ./jest.reporter.json --testFailCount 1 --workspace 17.2.14",
+		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 17.2.14",
+		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 17.2.14",
+		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 17.2.14",
+		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 17.2.14"
 	},
 	"author": "[email protected]",
 	"license": "SEE LICENSE IN LICENSE.MD",

how-to/automation-testing/register-with-home-ts/package.json

@@ -1,26 +1,26 @@
 {
 	"name": "automation-testing-register-with-home",
-	"version": "17.0.0",
+	"version": "17.2.0",
 	"description": "OpenFin Workspace Starter Automation Tests",
 	"scripts": {
 		"build": "echo Nothing to build",
-		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --workspace 17.0.15 --testFailCount 1",
-		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --workspace 17.0.15 --testFailCount 1",
-		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 17.0.15 --testFailCount 1",
-		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 17.0.15 --testFailCount 1",
-		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 17.0.15 --testFailCount 1",
-		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 17.0.15 --testFailCount 1",
-		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --offline --storageFolder=./offline-storage --workspace 17.0.15 --testFailCount 1",
-		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 17.0.15 --testFailCount 1",
-		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 17.0.15 --testFailCount 1"
+		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --workspace 17.2.14 --testFailCount 1",
+		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --workspace 17.2.14 --testFailCount 1",
+		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 17.2.14 --testFailCount 1",
+		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 17.2.14 --testFailCount 1",
+		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 17.2.14 --testFailCount 1",
+		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 17.2.14 --testFailCount 1",
+		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --offline --storageFolder=./offline-storage --workspace 17.2.14 --testFailCount 1",
+		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 17.2.14 --testFailCount 1",
+		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 17.2.14 --testFailCount 1"
 	},
 	"author": "[email protected]",
 	"license": "SEE LICENSE IN LICENSE.MD",
 	"devDependencies": {
 		"@openfin/automation-cli": "^1.2.0",
 		"@openfin/automation-helpers": "^1.2.0",
 		"@openfin/automation-native": "^1.2.0",
-		"@types/chai": "4.3.11",
+		"@types/chai": "4.3.12",
 		"chai": "4.3.10"
 	}
 }

how-to/automation-testing/register-with-store-js/package.json

@@ -1,16 +1,16 @@
 {
 	"name": "automation-testing-register-with-store-js",
-	"version": "17.0.0",
+	"version": "17.2.0",
 	"description": "OpenFin Workspace Starter Automation Tests",
 	"scripts": {
 		"build": "echo Nothing to build",
-		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --workspace 17.0.15",
-		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 17.0.15",
-		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 17.0.15",
-		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 17.0.15",
-		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 17.0.15",
-		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 17.0.15",
-		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 17.0.15"
+		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --workspace 17.2.14",
+		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 17.2.14",
+		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 17.2.14",
+		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 17.2.14",
+		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 17.2.14",
+		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 17.2.14",
+		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 17.2.14"
 	},
 	"author": "[email protected]",
 	"license": "SEE LICENSE IN LICENSE.MD",

how-to/automation-testing/selenium/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "automation-testing-selenium",
-	"version": "17.0.0",
+	"version": "17.2.0",
 	"description": "OpenFin Workspace Starter Selenium Example",
 	"scripts": {
 		"build": "echo Nothing to build",
@@ -17,7 +17,7 @@
 		"chromedriver": "118.0.0",
 		"fkill": "7.2.1",
 		"fkill-cli": "7.1.0",
-		"mocha": "10.2.0",
-		"selenium-webdriver": "4.16.0"
+		"mocha": "10.3.0",
+		"selenium-webdriver": "4.18.1"
 	}
 }

how-to/automation-testing/selenium/scripts/dos.mjs

@@ -11,7 +11,7 @@ const DOS = {
 		securedAPIDefaultPermission: 'allow',
 		systemApps: {
 			workspace: {
-				version: '17.0.15'
+				version: '17.2.14'
 			}
 		}
 	}

how-to/automation-testing/selenium/selenium.js

@@ -108,7 +108,7 @@ async function runMochaTests() {
 // The version of the chromedriver in the package.json should match the runtime version from the app manifest.
 // e.g. if the manifest runtime version is 34.118.78.80 then the chromedriver version should be "118.0.0"
 const testManifestUrl =
-	'https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json';
+	'https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json';
 const chromeDriverPort = 5678;
 const devToolsPort = 9122;
 

how-to/automation-testing/wdio/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "automation-testing-wdio",
-	"version": "17.0.0",
+	"version": "17.2.0",
 	"scripts": {
 		"build": "echo Nothing to build",
 		"test": "wdio run wdio.conf.js",
@@ -10,11 +10,11 @@
 	"devDependencies": {
 		"@openfin/automation-helpers": "^1.2.0",
 		"@openfin/automation-native": "^1.2.0",
-		"@wdio/cli": "8.27.1",
-		"@wdio/local-runner": "8.27.0",
-		"@wdio/mocha-framework": "8.27.0",
-		"@wdio/shared-store-service": "8.27.0",
-		"@wdio/spec-reporter": "8.27.0",
+		"@wdio/cli": "8.33.1",
+		"@wdio/local-runner": "8.33.1",
+		"@wdio/mocha-framework": "8.33.1",
+		"@wdio/shared-store-service": "8.33.1",
+		"@wdio/spec-reporter": "8.32.4",
 		"chai": "4.3.10",
 		"chromedriver": "118.0.0",
 		"fkill": "7.2.1",

how-to/automation-testing/wdio/scripts/dos.mjs

@@ -11,7 +11,7 @@ const DOS = {
 		securedAPIDefaultPermission: 'allow',
 		systemApps: {
 			workspace: {
-				version: '17.0.15'
+				version: '17.2.14'
 			}
 		}
 	}

how-to/automation-testing/wdio/wdio.conf.js

@@ -9,7 +9,7 @@ const path = require('path');
 // The version of the chromedriver in the package.json should match the runtime version from the app manifest.
 // e.g. if the manifest runtime version is 34.118.78.80 then the chromedriver version should be '118.0.0'
 const manifestUrl =
-	'https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/register-with-home/manifest.fin.json';
+	'https://built-on-openfin.github.io/workspace-starter/workspace/v17.2.0/register-with-home/manifest.fin.json';
 const chromeDriverPort = 5843;
 const devToolsPort = 9123;
 

how-to/customize-home-templates/README.md

@@ -15,7 +15,7 @@ To run this sample you can:
 - Clone this repo and follow the instructions below. This will let you customize the sample to learn more about our APIs.
 - Launch the Github hosted version of this sample to interact with it by going to the following link:
 
-[Github Workspace Starter Customize Home Templates](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fcustomize-home-templates%2Fmanifest.fin.json)
+[Github Workspace Starter Customize Home Templates](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.2.0%2Fcustomize-home-templates%2Fmanifest.fin.json)
 
 ## Getting Started
 
@@ -25,7 +25,7 @@ To run this sample you can:
 npm run setup
 ```
 
-2. Optional (if you wish to pin the version of OpenFin Workspace to version 17.0.0 and you are on Windows) - Set Windows registry key for [Desktop Owner Settings](https://developers.openfin.co/docs/desktop-owner-settings).
+2. Optional (if you wish to pin the version of OpenFin Workspace to version 17.2.0 and you are on Windows) - Set Windows registry key for [Desktop Owner Settings](https://developers.openfin.co/docs/desktop-owner-settings).
    This example runs a utility [dos.mjs](./scripts/dos.mjs) that adds the Windows registry key for you, pointing to a local desktop owner
    settings file so you can test these settings. If you already have a desktop owner settings file, this script prompts to overwrite the location. Be sure to capture the existing location so you can update the key when you are done using this example.
 

how-to/customize-home-templates/client/src/sources/template-types/template-types-source.ts

@@ -214,7 +214,7 @@ export class TemplateTypesSource {
 					},
 					data: {
 						textContent: "This is text content",
-						imageContent: "https://cdn.openfin.co/workspace/17.0.0/icons/defaultFavicon.svg",
+						imageContent: "https://cdn.openfin.co/workspace/17.2.0/icons/defaultFavicon.svg",
 						listContent: [
 							["Label 1", "Value 1"],
 							["Label 2", "Value 2"]

how-to/customize-home-templates/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "openfin-workspace--customize-home-templates",
-	"version": "17.0.0",
+	"version": "17.2.0",
 	"description": "OpenFin Workspace -- Register with Home",
 	"main": "index.js",
 	"scripts": {
@@ -23,34 +23,34 @@
 	],
 	"license": "SEE LICENSE IN LICENSE.MD",
 	"dependencies": {
-		"@openfin/workspace": "17.0.15",
-		"@openfin/workspace-platform": "17.0.15",
-		"chart.js": "^4.4.1",
+		"@openfin/workspace": "17.2.14",
+		"@openfin/workspace-platform": "17.2.14",
+		"chart.js": "^4.4.2",
 		"csstype": "^3.1.3",
 		"luxon": "^3.4.4",
 		"node-emoji": "1.11.0"
 	},
 	"devDependencies": {
 		"@openfin/core": "34.78.80",
 		"@openfin/node-adapter": "34.78.80",
-		"@types/luxon": "^3.3.8",
+		"@types/luxon": "^3.4.2",
 		"@types/node-emoji": "^1.8.2",
-		"eslint": "8.56.0",
+		"eslint": "8.57.0",
 		"eslint-config-airbnb": "19.0.4",
-		"eslint-config-airbnb-typescript": "17.1.0",
+		"eslint-config-airbnb-typescript": "18.0.0",
 		"eslint-config-prettier": "9.1.0",
 		"eslint-plugin-import": "2.26.0",
-		"eslint-plugin-jsdoc": "48.0.2",
-		"eslint-plugin-prettier": "5.1.2",
+		"eslint-plugin-jsdoc": "48.2.1",
+		"eslint-plugin-prettier": "5.1.3",
 		"eslint-plugin-promise": "6.1.1",
-		"eslint-plugin-simple-import-sort": "10.0.0",
-		"eslint-plugin-unicorn": "50.0.1",
-		"eslint-plugin-unused-imports": "3.0.0",
-		"markdownlint-cli": "0.38.0",
-		"prettier": "3.1.1",
+		"eslint-plugin-simple-import-sort": "12.0.0",
+		"eslint-plugin-unicorn": "51.0.1",
+		"eslint-plugin-unused-imports": "3.1.0",
+		"markdownlint-cli": "0.39.0",
+		"prettier": "3.2.5",
 		"ts-loader": "^9.5.1",
-		"typescript": "^5.3.3",
-		"webpack": "^5.89.0",
+		"typescript": "^5.4.2",
+		"webpack": "^5.90.3",
 		"webpack-cli": "^5.1.4"
 	}
 }

how-to/customize-home-templates/public/common/dos.json

@@ -2,7 +2,7 @@
 	"desktopSettings": {
 		"systemApps": {
 			"workspace": {
-				"version": "17.0.15",
+				"version": "17.2.14",
 				"customConfig": {
 					"hotkeys": {
 						"toggleHomeVisibility": "CommandOrControl+Space"

how-to/customize-home-templates/public/manifest.fin.json

@@ -34,7 +34,7 @@
 		"company": "OpenFin",
 		"description": "A way of showing examples of what OpenFin can do.",
 		"icon": "http://localhost:8080/favicon.ico",
-		"name": "Customize Home Templates - v17.0.0",
+		"name": "Customize Home Templates - v17.2.0",
 		"target": ["desktop", "start-menu"]
 	},
 	"supportInformation": {

how-to/hints-and-tips/docs/create-workspace-mobile-app.md

@@ -54,65 +54,9 @@ npm install -g @openfin/create-workspace-mobile-app
 npx @openfin/create-workspace-mobile-app my-app
 cd my-app
 npm run build
-npm start
+npm run start
 ```
 
-### If you encounter an error while running npm run build
-
-> :warning: **Warning:** On Windows you may see the following error depending on the version being used when running **npm run build**.
->
-> [Error: EPERM: operation not permitted, symlink 'C:\Code\my-directory\pwa\my-app\node_modules\@openfin\web-interop\out\shared-worker.js' -> 'C:\Code\my-directory\pwa\my-app\public\worker.js']
->
-> This is a copy step that copies a dependency from node_modules to the public directory of the sample application using symlinks.
->
-
-If you encounter the error you can navigate to scripts/symlink-worker.js and:
-
-Replace:
-
-```javascript
-const fs = require('fs/promises');
-const path = require('path');
-
-const worker = require.resolve('@openfin/web-interop/shared-worker');
-const symlinkPath = path.resolve(__dirname, '../public/worker.js');
-async function main() {
-    const shouldUnlink = await fs.stat(symlinkPath).catch(() => false);
-    if ((shouldUnlink && shouldUnlink.isFile) || shouldUnlink.isSymbolicLink) {
-        await fs.unlink(symlinkPath);
-    }
-    await fs.symlink(worker, symlinkPath);
-}
-
-main()
-    .then(() => {
-        console.log(`Linked ${worker} to ${symlinkPath}`);
-    })
-    .catch(console.error);
-```
-
-With this:
-
-```javascript
-const fs = require('fs/promises');
-const path = require('path');
-
-const worker = require.resolve('@openfin/web-interop/shared-worker');
-const targetPath = path.resolve(__dirname, '../public/worker.js');
-async function main() {
-    await fs.copyFile(worker, targetPath);
-}
-
-main()
-    .then(() => {
-        console.log(`Copied ${worker} to ${targetPath}`);
-    })
-    .catch(console.error);
-
-```
-
-After you have saved this change then the file should copy from node_modules to the target location when you run **npm run build** without reporting errors.
-
 ### After running build and start
 
 This will build and start a web server on port 3000. You should be able to open the following link:

how-to/integrate-server-authentication/README.md

@@ -22,7 +22,7 @@ To run this sample you can:
 npm run setup
 ```
 
-2. Optional (if you wish to pin the version of OpenFin Workspace to version 17.0.0 and you are on Windows) - Set Windows registry key for [Desktop Owner Settings](https://developers.openfin.co/docs/desktop-owner-settings).
+2. Optional (if you wish to pin the version of OpenFin Workspace to version 17.2.0 and you are on Windows) - Set Windows registry key for [Desktop Owner Settings](https://developers.openfin.co/docs/desktop-owner-settings).
    This example runs a utility [dos.mjs](./scripts/dos.mjs) that adds the Windows registry key for you, pointing to a local desktop owner
    settings file so you can test these settings. If you already have a desktop owner settings file, this script prompts to overwrite the location. Be sure to capture the existing location so you can update the key when you are done using this example.