Add profile member to Thing Descriptions - closes #2909

WebThingsIO · Apr 24, 2023 · e30d64f · e30d64f
1 parent 7b5282e
commit e30d64f
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/src/constants.ts b/src/constants.ts
@@ -100,13 +100,19 @@ export enum ActionStatusValues {
   COMPLETED = 'completed',
   FAILED = 'failed',
 }
+
+// Contexts
 export const MOZ_IOT_CONTEXT = 'https://iot.mozilla.org/schemas';
 export const WEBTHINGS_CONTEXT = 'https://webthings.io/schemas';
 export const WOT_TD_NS_CONTEXT = 'http://www.w3.org/ns/td';
 export const WOT_TD_1_CONTEXT = 'https://www.w3.org/2019/wot/td/v1';
 export const WOT_TD_1_1_CONTEXT = 'https://www.w3.org/2022/wot/td/v1.1';
 export const DEFAULT_CONTEXT = [WOT_TD_1_1_CONTEXT, WEBTHINGS_CONTEXT];
 
+// Profiles
+export const WOT_HTTP_BASIC_PROFILE = 'https://www.w3.org/2022/wot/profile/http-basic/v1';
+export const WOT_HTTP_SSE_PROFILE = 'https://www.w3.org/2022/wot/profile/http-sse/v1';
+
 export interface LogMessage {
   severity: LogSeverity;
   message: string;

diff --git a/src/models/thing.ts b/src/models/thing.ts
@@ -36,6 +36,7 @@ export interface ThingDescription {
   title: string;
   '@context': string | string[];
   '@type': string[];
+  profile: string | string[];
   description: string;
   base: string;
   baseHref: string;
@@ -83,6 +84,8 @@ export default class Thing extends EventEmitter {
 
   private '@type': string[];
 
+  private profile: string | string[];
+
   private description: string;
 
   private href: string;
@@ -133,12 +136,32 @@ export default class Thing extends EventEmitter {
     // Parse the Thing Description
     this.id = id;
     this.title = description.title || (<Record<string, string>>(<unknown>description)).name || '';
+
+    // Set @context
     if (description['@context']) {
       this['@context'] = Utils.standardizeContext(description['@context']);
     } else {
       this['@context'] = Constants.DEFAULT_CONTEXT;
     }
+
+    // Set @type
     this['@type'] = description['@type'] || [];
+
+    // Set profile (based on which interaction affordances are exposed)
+    this.profile = [];
+    if (
+      Object.keys(description.properties ?? {}).length > 0 ||
+      Object.keys(description.actions ?? {}).length > 0
+    ) {
+      this.profile.push(Constants.WOT_HTTP_BASIC_PROFILE);
+    }
+    if (
+      Object.keys(description.properties ?? {}).length > 0 ||
+      Object.keys(description.events ?? {}).length > 0
+    ) {
+      this.profile.push(Constants.WOT_HTTP_SSE_PROFILE);
+    }
+
     this.description = description.description || '';
     this.href = `${Constants.THINGS_PATH}/${encodeURIComponent(this.id)}`;
     this.properties = {};
@@ -190,8 +213,8 @@ export default class Thing extends EventEmitter {
         this.properties[propertyName] = property;
       }
 
-      // If there are properties, add top level forms for them
-      if (Object.keys(description.properties).length > 0) {
+      // If there are properties, add a top level form for them
+      if (Object.keys(description.properties ?? {}).length > 0) {
         let ops;
         // If there are writable properties then add readallproperties and
         // writemultipleproperties operations as an array
@@ -627,6 +650,7 @@ export default class Thing extends EventEmitter {
       title: this.title,
       '@context': this['@context'],
       '@type': this['@type'],
+      profile: this.profile,
       description: this.description,
       href: this.href,
       properties: this.properties,

diff --git a/src/test/integration/things-test.ts b/src/test/integration/things-test.ts
@@ -31,6 +31,10 @@ const piDescr = {
   title: 'pi-1',
   '@context': ['https://www.w3.org/2022/wot/td/v1.1', 'https://webthings.io/schemas'],
   '@type': ['OnOffSwitch'],
+  profile: [
+    'https://www.w3.org/2022/wot/profile/http-basic/v1',
+    'https://www.w3.org/2022/wot/profile/http-sse/v1',
+  ],
   properties: {
     power: {
       '@type': 'OnOffProperty',