Add timezone to Device

Bug: 178737106

Change-Id: I8ddf7d1671effb1a6cf1dceb13b844ba1ada98b5

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Add timezone field to Device
 
 ## [3.5.0]
 ### Added

src/api/schema.ts

@@ -123,6 +123,11 @@ export interface Device {
    * which fields are set depending on coarse vs. fine grained permission.
    */
   currentLocation?: Location
+  /**
+   * Optional. Timezone associated with the request used to resolve datetime values. If not
+   * set, "UTC" is used.
+   */
+  timeZone?: TimeZone
 }
 
 export enum Capability {
@@ -155,6 +160,24 @@ export interface Location {
   postalAddress?: PostalAddress
 }
 
+/**
+ * Optional. Timezone associated with the request used to resolve datetime values. If not
+ * set, "UTC" is used.
+ *
+ * Represents a time zone from the [IANA Time Zone
+ * Database](https://www.iana.org/time-zones).
+ */
+export interface TimeZone {
+  /**
+   * IANA Time Zone Database time zone, e.g. "America/New_York".
+   */
+  id?: string
+  /**
+   * Optional. IANA Time Zone Database version number, e.g. "2019a".
+   */
+  version?: string
+}
+
 /**
  * Required. Information to fulfillment on how to handle the request. For example a request
  * intending to get a fact might have a handler with a name of "getFact".

src/conversation/_test/conversation.test.ts

@@ -110,6 +110,10 @@ function requestBuilder(handlerName: string, slots: Record<string, Schema.Slot>)
           organization: '',
         },
       },
+      timeZone: {
+        id: 'America/New_York',
+        version: '2019a',
+      }
     },
   }
 }
@@ -187,7 +191,7 @@ test('device passed to conv', async t => {
   const webhookRequest = requestBuilder(handlerName, {})
   const app = conversation()
   app.handle(handlerName, conv => {
-    t.deepEqual(JSON.stringify(clone(conv.device)), JSON.stringify(clone(webhookRequest.device)))
+    t.deepEqual(clone(conv.device), clone(webhookRequest.device as Schema.Device))
   })
   await app.handler(webhookRequest as Schema.HandlerRequest, {})
 })

src/conversation/handler/device.ts

@@ -31,6 +31,11 @@ export class Device {
    * @public
    */
   capabilities: Schema.Capability[]
+  /**
+   * Optional. Timezone associated with the request used to resolve datetime values. If not
+   * set, "UTC" is used.
+   */
+  timeZone?: Schema.TimeZone
 
   /**
    * Optional. The device location of the user. Note, this is only populated after location
@@ -41,9 +46,10 @@ export class Device {
 
   /** @hidden */
   constructor(input: Schema.Device = {}) {
-    const { capabilities = [], currentLocation = {} } = input
+    const { capabilities = [], currentLocation = {}, timeZone = {} } = input
     this.capabilities = capabilities
     this.currentLocation = currentLocation
+    this.timeZone = timeZone
   }
 
 }