Icons spec

docs/api/ref/AppMetadata.md

@@ -14,7 +14,7 @@ interface AppMetadata {
   title?: string;
   tooltip?: string;
   description?: string;
-  icons?: Array<string>;
+  icons?: Array<Icon>;
   images?: Array<string>;
 }
 ```
@@ -24,9 +24,10 @@ App metadata is provided by the FDC3 App Directory that the desktop agent connec
 It always includes at least a `name` property, which can be used with [`open`](DesktopAgent#open) and [`raiseIntent`](DesktopAgent#raiseIntent).
 
 Optionally, extra information from the app directory can be returned, to aid in rendering UI elements, e.g. a context menu.
-This includes a title, description, tooltip and icon and image URLs.
+This includes a title, description, tooltip, icons and image URLs.
 
 In situations where a desktop agent connects to multiple app directories or multiple versions of the same app exists in a single app directory, it may be neccessary to specify appId and version to target applications that share the same name. 
 
 #### See also
-* [`AppIntent.apps`](AppIntent)
+* [`AppIntent.apps`](AppIntent)
+* [`Icon`](Icon)

docs/api/ref/Icon.md

@@ -0,0 +1,55 @@
+---
+id: Icon
+sidebar_label: Icon
+title: Icon
+hide_title: true
+---
+# `Icon`
+
+```typescript
+interface Icon {
+  src: string;
+  size: string;
+  type: string;
+}
+```
+
+App Metadata icon's description. 
+
+Various properties may be used by the Desktop Agent to decide which icon is the most suitable to be used considering the application chooser UI, device DPI and formats supported by the system.
+
+#### Example
+
+```js
+"icons": [
+  {
+    "src": "https://app.foo.icon/app_icons/lowres.webp",
+    "size": "48x48",
+    "type": "image/webp"
+  },
+  {
+    "src": "https://app.foo.icon/app_icons/hd_hi.svg",
+    "size": "72x72"
+  }
+]
+```
+
+## Properties
+
+### `src`
+
+The fully qualified url to the icon.
+
+### `size`
+
+The dimension of the icon using formatted as "<height>x<width>"
+
+### `type`
+
+The media type of the icon. If not provided the Desktop agent may refer to the src file extension.
+
+
+
+#### See also
+* [`AppMetadata`](AppMetadata)
+

src/api/AppMetadata.ts

@@ -3,6 +3,8 @@
  * Copyright 2019 FINOS FDC3 contributors - see NOTICE file
  */
 
+import { Icon } from './Icon';
+
 /**
  * App definition as provided by the application directory
  */
@@ -26,7 +28,7 @@ export interface AppMetadata {
   readonly description?: string;
 
   /** A list of icon URLs for the application that can be used to render UI elements */
-  readonly icons?: Array<string>;
+  readonly icons?: Array<Icon>;
 
   /** A list of image URLs for the application that can be used to render UI elements */
   readonly images?: Array<string>;

src/api/Icon.ts

@@ -0,0 +1,15 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright 2019 FINOS FDC3 contributors - see NOTICE file
+ */
+
+export interface Icon {
+  /** The icon url */
+  readonly src: string;
+
+  /** The icon dimension */
+  readonly size?: string;
+
+  /** The icon media type */
+  readonly type?: string;
+}

src/app-directory/specification/appd.yaml

@@ -347,9 +347,15 @@ components:
     Icon:
       description: Icon holder
       properties:
-        icon:
+        src:
           type: string
           description: Icon URL
+        size:
+          type: string
+          description: Icon dimension formatted as "<height>x<width>"
+        type:
+          type: string
+          description: Image media type. If not present the Desktop Agent may use the src file extension
     AppImage:
       description: App Image holder
       properties: