Promote v16.1 to stable

.github/workflows/lint.yml

@@ -2,7 +2,7 @@ name: Check Linting has been applied
 
 on:
   pull_request:
-  push:
+      types: [opened, synchronize, reopened, edited]
 
 jobs:
   lint:

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Workspace Platform Starter - Unit Tests
 
 on:
   pull_request:
-  push:
+    types: [opened, synchronize, reopened, edited]
     paths:
       - 'how-to/workspace-platform-starter/**'
 

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

@@ -1,18 +1,18 @@
 {
 	"name": "automation-testing-register-with-home-js",
-	"version": "16.0.0",
+	"version": "16.1.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/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --reporter ./mocha.reporter.json --testFailCount 1 --workspace 16.0.9",
-		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.0.9",
-		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --reporter ./jasmine.reporter.json --testFailCount 1 --workspace 16.0.9",
-		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.0.9",
-		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jest --reporter ./jest.reporter.json --testFailCount 1 --workspace 16.0.9",
-		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.0.9",
-		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.0.9",
-		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.0.9",
-		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.0.9"
+		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --reporter ./mocha.reporter.json --testFailCount 1 --workspace 16.1.6",
+		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.6",
+		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --reporter ./jasmine.reporter.json --testFailCount 1 --workspace 16.1.6",
+		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.6",
+		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jest --reporter ./jest.reporter.json --testFailCount 1 --workspace 16.1.6",
+		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.6",
+		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.1.6",
+		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.1.6",
+		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.1.6"
 	},
 	"author": "[email protected]",
 	"license": "SEE LICENSE IN LICENSE.MD",
@@ -22,7 +22,7 @@
 		"@openfin/automation-native": "^1.2.0",
 		"chai": "4.3.10",
 		"jasmine-pretty-html-reporter": "0.2.5",
-		"jest-html-reporters": "3.1.5",
+		"jest-html-reporters": "3.1.7",
 		"mochawesome": "7.1.3"
 	}
 }

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

@@ -1,18 +1,18 @@
 {
 	"name": "automation-testing-register-with-home",
-	"version": "16.0.0",
+	"version": "16.1.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/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.0.9 --testFailCount 1",
-		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.0.9 --testFailCount 1",
-		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.0.9 --testFailCount 1",
-		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.0.9 --testFailCount 1",
-		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.0.9 --testFailCount 1",
-		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.0.9 --testFailCount 1",
-		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --offline --storageFolder=./offline-storage --workspace 16.0.9 --testFailCount 1",
-		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.0.9 --testFailCount 1",
-		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.0.9 --testFailCount 1"
+		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.1.6 --testFailCount 1",
+		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.1.6 --testFailCount 1",
+		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.1.6 --testFailCount 1",
+		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.1.6 --testFailCount 1",
+		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.1.6 --testFailCount 1",
+		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.1.6 --testFailCount 1",
+		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --offline --storageFolder=./offline-storage --workspace 16.1.6 --testFailCount 1",
+		"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.1.6 --testFailCount 1",
+		"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.1.6 --testFailCount 1"
 	},
 	"author": "[email protected]",
 	"license": "SEE LICENSE IN LICENSE.MD",

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

@@ -1,16 +1,16 @@
 {
 	"name": "automation-testing-register-with-store-js",
-	"version": "16.0.0",
+	"version": "16.1.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/v16.0.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --workspace 16.0.9",
-		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.0.9",
-		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.0.9",
-		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.0.9",
-		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.0.9",
-		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.0.9",
-		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.0.9"
+		"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.6",
+		"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.6",
+		"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.6",
+		"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.6",
+		"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.6",
+		"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.6",
+		"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.1.6"
 	},
 	"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": "16.0.0",
+	"version": "16.1.0",
 	"description": "OpenFin Workspace Starter Selenium Example",
 	"scripts": {
 		"build": "echo Nothing to build",

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

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

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 33.116.77.11 then the chromedriver version should be "116.0.0"
 const testManifestUrl =
-	'https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json';
+	'https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.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": "16.0.0",
+	"version": "16.1.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.24.16",
-		"@wdio/local-runner": "8.24.12",
-		"@wdio/mocha-framework": "8.24.12",
-		"@wdio/shared-store-service": "8.24.12",
-		"@wdio/spec-reporter": "8.24.12",
+		"@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",
 		"chai": "4.3.10",
 		"chromedriver": "116.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: '16.0.9'
+				version: '16.1.6'
 			}
 		}
 	}

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 33.116.77.11 then the chromedriver version should be '116.0.0'
 const manifestUrl =
-	'https://built-on-openfin.github.io/workspace-starter/workspace/v16.0.0/register-with-home/manifest.fin.json';
+	'https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.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%2Fv16.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%2Fv16.1.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 16.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 16.1.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.
 
@@ -77,6 +77,7 @@ The commands implemented are:
 
 ```shell
 ? - which displays a list of all the commands with help
+/templates
 /quote <symbol>
 /emoji <code>
 /contacts <contact name>
@@ -88,6 +89,8 @@ The commands implemented are:
 /error
 ```
 
+The **/templates** command demonstrates a template containing all the different kinds of fragments that can be display in a home template.
+
 The **/quote** command demonstrates a template that is built dynamically with a graph image.
 
 The **/emoji** command demonstrates performing a search and returning multiple results with custom actions.
@@ -109,23 +112,19 @@ The contacts commands demonstrate different approaches to retrieving data.
 e.g.
 
 ```shell
-/emoji man
+/templates
+```
+
+![Customize Home Template Fragments](./assets/customize-home-templates-fragments.png)
+
+e.g.
+
+```shell
 /quote MSFT
 /quote APPL
-/contacts john
-/contacts emma
-/contacts-sync john
-/contacts-partial john
-acme
-bee
-chad
-dock
-/loading
-/error
-desserts
 ```
 
-![Customize Home Template Quote](customize-home-templates-quote.gif)
+![Customize Home Template Quote](./assets/customize-home-templates-quote.gif)
 
 e.g.
 
@@ -134,7 +133,7 @@ e.g.
 /emoji coffee
 ```
 
-![Customize Home Template Emoji](customize-home-templates-emoji.gif)
+![Customize Home Template Emoji](./assets/customize-home-templates-emoji.gif)
 
 e.g.
 
@@ -145,23 +144,31 @@ Chad
 Dock
 ```
 
-![Customize Home Template Tree](customize-home-templates-tree.gif)
+![Customize Home Template Tree](./assets/customize-home-templates-tree.gif)
 
 e.g.
 
 ```shell
 /loading
 ```
 
-![Customize Home Template Loading](customize-home-templates-loading.gif)
+![Customize Home Template Loading](./assets/customize-home-templates-loading.gif)
 
 e.g.
 
 ```shell
 /error
 ```
 
-![Customize Home Template error](customize-home-templates-error.gif)
+![Customize Home Template error](./assets/customize-home-templates-error.gif)
+
+e.g.
+
+```shell
+desserts
+```
+
+![Customize Home Template Suggestion](./assets/customize-home-templates-suggestion.png)
 
 ### Contact data
 

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

@@ -11,6 +11,7 @@ import { AsyncContactsSource } from "./sources/async-contacts/async-contacts-sou
 import { EmojiSource } from "./sources/emoji/emoji-source";
 import { QuoteSource } from "./sources/quote/quote-source";
 import { SuggestionSource } from "./sources/suggestions/suggestion-source";
+import { TemplateTypesSource } from "./sources/template-types/template-types-source";
 import { TreeInlineSource } from "./sources/tree-inline/tree-inline-source";
 import { TreeQuerySource } from "./sources/tree-query/tree-query-source";
 
@@ -69,6 +70,12 @@ const SOURCES: {
 			id: "suggestions"
 		},
 		instance: new SuggestionSource()
+	},
+	{
+		definition: {
+			id: "template-types"
+		},
+		instance: new TemplateTypesSource()
 	}
 ];