Merge pull request #363 from rikoe/1.2-website

Create version 1.2 of docs and set to default version on website

CHANGELOG.md

@@ -6,43 +6,60 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+## [npm v1.2.0] - 2021-04-19
+
 ### Added
-* [API] New raiseIntentForContext method (#268)
-* [API] Add fdc3Ready event to API specification (#269, #327)
-* [API] Add optional appId and version properties to AppMetadata (#273)
-* [API] Define new TargetApp type for use with open and raiseIntent (#279, #315)
-* [API] New getInfo method with method data about implementation (#324)
-* [Package] Build and publish an npm package for FDC3 (#252)
-* [Package] Add enums for intents and context types (#264)
-* [Package] Add ES6 module support to FDC3 API package (#266)
+* ES6 functions for `getInfo()` and `raiseIntentForContext()` ([#268](https://github.com/finos/FDC3/pull/268), [#324](https://github.com/finos/FDC3/pull/324))
+* `fdc3Ready()` utility function that wraps checks for the window.fdc3 global object and new `fdc3Ready` event ([#360](https://github.com/finos/FDC3/pull/360))
+* `compareVersionNumbers()` and `versionIsAtLeast()` utility functions to complement `getInfo()` ([#324](https://github.com/finos/FDC3/pull/324))
 
 ### Changed
-* [API] Allow AppMetadata to be passed in as a target argument (#272)
-* [API] Reject/throw as appropriate in ES6 exported methods if window.fdc3 is not available (#277)
-* [API] API specification clarifications around intents/context and loops when broadcasting (#285, #307, 310)
-* [API] `addContextListener(type, handler)` now accepts null for type, deprecate `addContextListener(handler)` (#329)
-* [API] Deprecate 'global' channel and `IntentResolution.data` (#341)
-* [Website] Add/update participant logos (#209, #225, #320, #335)
-* [Website] Update "Get Involved" with standards governance info (#228, #249, #300, #286)
-* [Docs] Add standard version number to specification files (#331)
+* `addContextListener(contextType, handler)` now supports passing `null` as the context type ([#329](https://github.com/finos/FDC3/pull/329))
+* All other API type changes and additions from the [FDC3 Standard 1.2](https://github.com/finos/FDC3/releases/tag/v1.2) release
+
+### Deprecated
+* `addContextListener(handler)` ([#329](https://github.com/finos/FDC3/pull/329))
+* `IntentResolution.data` ([#341](https://github.com/finos/FDC3/pull/341))
+
+## [FDC3 Standard 1.2] - 2021-04-19
+### Added
+* New `raiseIntentForContext()` method ([#268](https://github.com/finos/FDC3/pull/268))
+* New `fdc3Ready` event ([#269](https://github.com/finos/FDC3/pull/269))
+* New `getInfo()` method that returns implementation metadata ([#324](https://github.com/finos/FDC3/pull/324))
+
+### Changed
+* `fdc3.open()` and `fdc3.raiseIntent()` now takes `TargetApp`, which resolves to `string | AppMetadata` ([#272](https://github.com/finos/FDC3/pull/272))
+* `AppMetadata` return type can now optionally include `appId` and `version` ([#273](https://github.com/finos/FDC3/pull/273))
+* `addContextListener(contextType, handler)` now supports passing `null` as the context type ([#329](https://github.com/finos/FDC3/pull/329))
+* Simplify API reference documentation and add info about supported platforms, including npm package ([#349](https://github.com/finos/FDC3/pull/349))
+
+### Deprecated
+* `addContextListener(handler)` ([#329](https://github.com/finos/FDC3/pull/329))
+* `IntentResolution.data` and `'global'` channel concept ([#341](https://github.com/finos/FDC3/pull/341))
 
 ### Fixed
-* [API] Missing/wrong type signature for getCurrentChannel (#222)
-* [API] Support nullable return type for getCurrentChannel (#282)
-* [API] Implement missing leaveCurrentChannel method (#283)
-* [Schemas] Correct invalid schema references (#224)
-* [Docs] Fix raiseIntent examples (#211)
-* [Docs] Fix Portfolio context data example (#251)
-
-### Technical
-* [Readme] Fix AppDirectory Readme (#274)
-* [Readme] Update main Readme (#275, #318, #338)
-* [GitHub] Remove FINOS SVG from project root (#204)
-* [GitHub] Switch builds from Travis to GitHub workflows (#239, #252, #253, #254)
-* [GitHub] Meeting workflows and templates (#292, #293)
-* [Security] Upgrade dependencies to address security vulnerabilities (#207, #226, #232, #235, #238, #258, #259, #260, #289, #290, #295, #297, #330, #333, #334, #339, #340)
-
-## [1.1] - 2020-04-09
+* Return type of `getCurrentChannel()` should be `Promise<Channel | null>` ([#282](https://github.com/finos/FDC3/pull/282))
+* `leaveCurrentChannel()` is missing from `DesktopAgent` interface ([#283](https://github.com/finos/FDC3/pull/283))
+
+## [npm v1.1.1] - 2021-04-15
+### Fixed
+* `Intents` enum should contain `StartChat` not `StartChart` ([#364](https://github.com/finos/FDC3/pull/364))
+
+### Fixed
+* Return type of `getCurrentChannel()` should be `Promise<Channel | null>` ([#282](https://github.com/finos/FDC3/pull/282))
+* Missing `leaveCurrentChannel()` export ([#283](https://github.com/finos/FDC3/pull/283))
+
+## [npm v1.1.0] - 2021-04-14
+### Added
+* Build an npm package with exported TypeScript typings for API, Context Data and `window.fdc3` global ([#252](https://github.com/finos/FDC3/pull/252))
+* Export helper enums for names of standardised `Intents` and `ContextTypes` ([#264](https://github.com/finos/FDC3/pull/264))
+* Export API operations as ES6 functions that can be directly imported ([#266](https://github.com/finos/FDC3/pull/266))
+* Check for the existence of `window.fdc3` in ES6 functions, and reject or throw if not defined ([#356](https://github.com/finos/FDC3/pull/356))
+
+### Fixed
+* Return type of `getCurrentChannel()` should be `Promise<Channel>` ([#222](https://github.com/finos/FDC3/pull/222))
+
+## [FDC3 Standard 1.1] - 2020-04-09
 ### Added
 * JSON Schema definitions for agreed context types ([#119](https://github.com/finos/FDC3/pull/119)):
     - `fdc3.context`
@@ -67,54 +84,50 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
     - `ChannelError` type
 * Type filtering support for `getCurrentContext` ([#161](https://github.com/finos/FDC3/pull/161))
 * Publish versioned JSON schemas to FDC3 website ([#170](https://github.com/finos/FDC3/pull/170))
+* Intent Reference and Context Data Reference documentation ([#172](https://github.com/finos/FDC3/pull/172))
 
 ### Changed
+* Remove FactSet-specific examples from docs ([#88](https://github.com/finos/FDC3/pull/88))
+* Apply FINOS branding, styles and logos to the website ([#96](https://github.com/finos/FDC3/pull/96))
+* Include ChartIQ in "Who is using FDC3?" section on website ([#100](https://github.com/finos/FDC3/pull/100))
 * Expand `AppMetadata` interface with more application properties ([#157](https://github.com/finos/FDC3/pull/157))
-
-### Fixed
-* Upgrade dependencies to address security vulnerabilities
-
-### Docs
-* Remove FactSet-specific examples ([#88](https://github.com/finos/FDC3/pull/88))
-* Add Intent Reference and Context Data Reference ([#172](https://github.com/finos/FDC3/pull/172))
 * Restructure some docs ([#190](https://github.com/finos/FDC3/pull/190))
-* Fix several typos and broken links
 
-### Website
-* Apply FINOS branding, styles and logos to the website ([#96](https://github.com/finos/FDC3/pull/96))
-* Add ChartIQ to "Who is using FDC3?" section on website ([#100](https://github.com/finos/FDC3/pull/100))
+### Fixed
+* Several typos and broken links in docs
+* Various security vulnerabilities
 
-## [1.0] - 2019-03-28
+## [FDC3 Standard 1.0] - 2019-03-28
 ### Added
+* Documentation website (generated with [Docusaurus]) and content from old separate FDC3 repos:
+  - [FDC3/API](https://github.com/FDC3/API)
+  - [FDC3/ContextData](https://github.com/FDC3/ContextData)
+  - [FDC3/Intents](https://github.com/FDC3/Intents)
+  - [FDC3/appd-api](https://github.com/FDC3/appd-api)
+  - [FDC3/use-cases](https://github.com/FDC3/use-cases)
 * Use Case 15 ([#49](https://github.com/finos/FDC3/pull/49))
 * FDC3 Roadmap ([#55](https://github.com/finos/FDC3/pull/55))
-* User showcase on website ([#67](https://github.com/finos/FDC3/pull/67))
+* FDC3 feature icons on website landing page ([#57](https://github.com/finos/FDC3/pull/57))
+* Participant showcase on website landing page ([#67](https://github.com/finos/FDC3/pull/67))
+
+[Docusaurus]: https://docusaurus.io
 
 ### Changed
-* Use case text on front page of website ([#54](https://github.com/finos/FDC3/pull/54))
-* Feature icons on website ([#57](https://github.com/finos/FDC3/pull/57))
+* General cleanup of spelling, grammar and punctuation ([#34](https://github.com/finos/FDC3/pull/34))
+* Use cases callout on website landing page ([#54](https://github.com/finos/FDC3/pull/54))
+* Proofreading of docs ([#62](https://github.com/finos/FDC3/pull/62))
 
 ### Fixed
-* General cleanup of spelling, grammar and punctuation ([#34](https://github.com/finos/FDC3/pull/34))
 * Remove unnecessary dates from use case file names ([#41](https://github.com/finos/FDC3/pull/41))
-* Fix header colouring on responsive website ([#56](https://github.com/finos/FDC3/pull/56))
-* Fix workflow numbers in Use Case 1 ([#60](https://github.com/finos/FDC3/pull/60))
-* More proofreading changes to existing docs ([62](https://github.com/finos/FDC3/pull/62))
-* Fix examples in Intent Overview doc ([#65](https://github.com/finos/FDC3/pull/65))
-* Fix errors in DesktopAgent API doc ([#66](https://github.com/finos/FDC3/pull/66))
-* Add hyperlink to FDC3 Intro doc ([#69](https://github.com/finos/FDC3/pull/69))
-
-## [1.0.0-beta] - 2019-03-05
-## Added
-* API content from [FDC3/API](https://github.com/FDC3/API).
-* Intent content from [FDC3/Intents](https://github.com/FDC3/Intents).
-* Context Data content from [FDC3/ContextData](https://github.com/FDC3/ContextData).
-* App Directory content from [FDC3/appd-api](https://github.com/FDC3/appd-api).
-* Use Case content from [FDC3/use-cases](https://github.com/FDC3/use-cases).
-* Documentation website generated with [Docusaurus](https://docusaurus.io).
-
-
-[Unreleased]: https://github.com/finos/FDC3/compare/v1.1..HEAD
-[1.1]: https://github.com/finos/FDC3/compare/v1.1..v1.0
-[1.0]: https://github.com/finos/FDC3/compare/v1.0..v1.0.0-beta
-[1.0.0-beta]: https://github.com/finos/FDC3/releases/tag/v1.0.0-beta
+* Header colouring on responsive website ([#56](https://github.com/finos/FDC3/pull/56))
+* Workflow numbers in Use Case 1 ([#60](https://github.com/finos/FDC3/pull/60))
+* Examples in Intent Overview ([#65](https://github.com/finos/FDC3/pull/65))
+* Errors in DesktopAgent API Reference ([#66](https://github.com/finos/FDC3/pull/66))
+
+[Unreleased]: https://github.com/finos/FDC3/compare/v1.2..HEAD
+[npm v1.2.0]: https://github.com/finos/FDC3/compare/v1.1.0..v1.2.0
+[FDC3 Standard 1.2]: https://github.com/finos/FDC3/compare/v1.2..v1.1
+[npm v1.1.1]: https://github.com/finos/FDC3/compare/v1.1.0..v1.1.1
+[npm v1.1.0]: https://github.com/finos/FDC3/compare/v1.1..v1.1.0
+[FDC3 Standard 1.1]: https://github.com/finos/FDC3/compare/v1.1..v1.0
+[FDC3 Standard 1.0]: https://github.com/finos/FDC3/v1.0

README.md

@@ -1,6 +1,6 @@
 # <a href='http://fdc3.finos.org'><img src='./website/static/img/fdc3-logo-2019-color.png' height='150' alt='FDC3 Logo' aria-label='fdc3.finos.org' /></a>
 
-[![Latest Standard](https://img.shields.io/badge/release-1.1-blue)](https://github.com/finos/fdc3/releases/v1.1)
+[![Latest Standard](https://img.shields.io/badge/release-1.2-blue)](https://github.com/finos/fdc3/releases/v1.2)
 [![npm](https://img.shields.io/npm/v/@finos/fdc3)](https://www.npmjs.com/package/@finos/fdc3)
 [![FINOS - Released](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-released.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Released)
 [![GitHub](https://img.shields.io/github/license/finos/fdc3)](https://opensource.org/licenses/Apache-2.0)
@@ -108,8 +108,8 @@ Despite this limitation, implementing support for FDC3 in a native application c
 # Roadmap
 
 - [x] Publish versioned NPM packages to ease adoption and implementation of FDC3 APIs.
+- [x] Release version 1.2 of the standard with expanded API capabilities.
 - [ ] Establish a process to accelerate community-contributed context data definitions.
-- [ ] Release version 1.2 of the standard with expanded API capabilities.
 - [ ] Release version 2.0 of the standard with support for app instances, two-way data flow and joining multiple channels.
 - [ ] Improve the app directory specification, with support for container-agnostic app manifests, and more type metadata around channels and launching apps.
 - [ ] Introduce a hosted app directory example with sample application definitions.

package.json

@@ -1,14 +1,14 @@
 {
   "name": "@finos/fdc3",
-  "version": "1.2.0-beta",
+  "version": "1.2.0",
   "author": "Fintech Open Source Foundation (FINOS)",
   "homepage": "https://fdc3.finos.org",
   "repository": {
     "type": "git",
     "url": "https://github.com/finos/FDC3.git"
   },
   "publishConfig": {
-    "tag": "next"
+    "tag": "latest"
   },
   "license": "Apache-2.0",
   "main": "dist/index.js",

website/core/Footer.js

@@ -33,7 +33,7 @@ class Footer extends React.Component {
   render() {
     return (
       <footer className="nav-footer" id="footer">
-        <section className="sitemap">     
+        <section className="sitemap">
           <a href={this.props.config.baseUrl} className="nav-home">
             {this.props.config.footerIcon && (
               <img
@@ -43,19 +43,16 @@ class Footer extends React.Component {
             )}
           </a>
           <div>
-            <h5>Docs</h5>
+            <h5>Learn</h5>
             <a href={this.docUrl('fdc3-intro')}>
               Getting Started
             </a>
             <a href={this.docUrl('why-fdc3')}>
-              Why FDC3
+              Supported Platforms
             </a>
             <a href={this.docUrl('api/ref/DesktopAgent')}>
               API Reference
             </a>
-            <a href={this.pageUrl('app-directory','',`schemas/${latestVersion}`)}>
-              App Directory Schema
-            </a>
             <a href={this.docUrl('use-cases/overview')}>
               Use Cases
             </a>
@@ -69,34 +66,27 @@ class Footer extends React.Component {
               FINOS
             </a>
             <a
-              href="https://www.finos.org/privacy-policy"
+              href="https://finos-lf.slack.com/messages/fdc3/"
               target="_blank"
               rel="noreferrer noopener">
-              FINOS Privacy Policy
+              Slack
             </a>
             <a
-              href="https://finosfoundation.atlassian.net/wiki/spaces/FDC3"
+              href="https://stackoverflow.com/questions/tagged/fdc3"
               target="_blank"
               rel="noreferrer noopener">
-              FDC3 Wiki
+              Stack Overflow
             </a>
             <a
               href="https://groups.google.com/a/finos.org/forum/#!forum/fdc3"
               target="_blank"
               rel="noreferrer noopener">
               Google Groups
-            </a>            
+            </a>
             {/* <a href={this.pageUrl('users.html', this.props.language)}>
               User Showcase
-            </a>
-            <a
-              href="http://stackoverflow.com/questions/tagged/"
-              target="_blank"
-              rel="noreferrer noopener">
-              Stack Overflow
-            </a>
-            <a href="https://discordapp.com/">Project Chat</a>
-            <a
+            </a> */}
+            {/* <a
               href="https://twitter.com/"
               target="_blank"
               rel="noreferrer noopener">
@@ -121,7 +111,7 @@ class Footer extends React.Component {
                 <a
                   href={`https://twitter.com/${this.props.config.twitterUsername}`}
                   className="twitter-follow-button">
-                  Follow @{this.props.config.twitterUsername}
+                  @{this.props.config.twitterUsername}
                 </a>
               </div>
             )}
@@ -134,7 +124,7 @@ class Footer extends React.Component {
           </a>
 
         </section>
-        
+
         <section className="copyright">{this.props.config.copyright}</section>
 
       </footer>

website/pages/schemas/1.2/app-directory.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>ReDoc</title>
+    <!-- needed for adaptive design -->
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+    <!--
+    ReDoc doesn't change outer page styles
+    -->
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <redoc spec-url='app-directory.yaml'></redoc>
+    <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+  </body>
+</html>