Align intent and application definition between schemas

Fixes #19 and #156

Author: rikoe

src/api/interface.ts

@@ -21,24 +21,50 @@ enum ResolveError {
 /**
 * Intent descriptor
 */
-interface IntentMetadata {
+interface Intent {
+  
+  // The name of the intent, default naming convention is UpperCamelCase
   name: string;
-  displayName: string;
+
+  // An optional display name for the intent, "name" will be used if left empty
+  displayName?: string;
+  
+  // A list of the contexts the intent accepts. This will typically be a set of namespaced context types, e.g. "fdc3.contact"
+  contexts?: string[]
+ 
+  // Custom configuration for the intent that may be required for a particular desktop agent.
+  customConfig?: object; 
 }
 
 /**
 * An interface that relates an intent to apps
 */
 interface AppIntent {
-  intent: IntentMetadata;
-  apps: Array<AppMetadata>;
+  intent: Intent;
+  apps: Array<Application>;
 }
 
 /**
- * App metadata is Desktop Agent specific - but should support a name property.
+ * App definition as provided by the application directory
  */
-interface AppMetadata {
+interface Application {
+  appId: string;
   name: string;
+  title?: string;
+  tooltip?: string;
+  description?: string;
+  images?: Array<AppImage>;
+  icons?: Array<Icon>;
+  intents?: Array<Intent>;
+  customConfig?: Array<{name: string, value: string}>;
+}
+
+interface AppImage {
+  url: string;
+}
+
+interface Icon {
+  icon: string;
 }
 
 /**

src/intents/Intent.yaml

@@ -22,7 +22,7 @@ Intent:
         type: string
       description: The contexts the intent accepts. This will
         typically be a set of namespaced context types, e.g. 
-        "org.symphony.contact"
+        "fdc3.contact"
     customConfig:
         type: object
         description: Custom configuration for the intent