Updates for 1.0.0 SDK

Regenerate reference docs TOC Updated CHANGELOG Bump package version Bug: 152578039 Signed-off-by: Dave Smith <smithdave@google.com> Change-Id: Iee32582be818f6a2193c1452a0f1ffd3ec9d6e01
google-home · Apr 6, 2020 · 9840f62 · 9840f62
1 parent 8272bec
commit 9840f62
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
 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).
 
+## [1.0.0] - 2020-04-06
+
+### Added
+
+- New error types to replace use of `ErrorCode`:
+  - `DeviceNotSupportedError` - Identified device should not use local fulfillment
+  - `DeviceNotIdentifiedError` - Unable to identify provided device
+  - `InvalidRequestError` - Unable to process incoming intent
+
+### Changed
+
+- Error types are now reporting in cloud logging.
+  See [error logging](https://developers.google.com/assistant/smarthome/develop/error-logging)
+  for more details.
+
+### Removed
+
+- `ErrorCode` enum is no longer visible. Use discrete error types, such as
+  `InvalidRequestError` to throw errors from your app. `HandlerError` is
+  still available for throwing generic fulfillment errors.
+
 ## [0.2.1] - 2019-12-09
 
 ### Changed
@@ -32,6 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Initial developer preview release.
 
+[1.0.0]: https://github.com/actions-on-google/local-home-sdk/compare/v0.2.1...v1.0.0
 [0.2.1]: https://github.com/actions-on-google/local-home-sdk/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/actions-on-google/local-home-sdk/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/actions-on-google/local-home-sdk/releases/tag/v0.1.0
diff --git a/docgen/HOME.md b/docgen/HOME.md
@@ -1,6 +1,6 @@
 # Local Home SDK Reference
 The Local Home SDK provides the TypeScript typings for building applications
-that support local execution for smart home integrations with the Google Assistant.
+that support local fulfillment for smart home integrations with the Google Assistant.
 
 These typings are distributed as an
 [npm package](https://www.npmjs.com/package/@google/local-home-sdk).
@@ -17,4 +17,4 @@ add the following lines:
 ```
 
 To get started using the Local Home SDK for smart home Actions, see the
-[local execution guide](/assistant/smarthome/concepts/local).
+[local fulfillment guide](/assistant/smarthome/concepts/local).
diff --git a/docgen/_toc.yaml b/docgen/_toc.yaml
@@ -2,18 +2,22 @@ toc:
 - title: "smarthome"
   path: /assistant/smarthome/reference/local/modules/smarthome
   section:
+  - heading: "Enums"
+  - title: "Intents"
+    path: /assistant/smarthome/reference/local/enums/smarthome.intents
+  - heading: "Classes"
   - title: "App"
     path: /assistant/smarthome/reference/local/classes/smarthome.app
+  - heading: "Interfaces"
   - title: "DeviceManager"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.devicemanager
-  - title: "Intents"
-    path: /assistant/smarthome/reference/local/enums/smarthome.intents
   - title: "ProxyInfo"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.proxyinfo
 
 - title: "smarthome.Constants"
   path: /assistant/smarthome/reference/local/modules/smarthome.constants
   section:
+  - heading: "Enums"
   - title: "HttpOperation"
     path: /assistant/smarthome/reference/local/enums/smarthome.constants.httpoperation
   - title: "Protocol"
@@ -26,12 +30,14 @@ toc:
 - title: "smarthome.DataFlow"
   path: /assistant/smarthome/reference/local/modules/smarthome.dataflow
   section:
+  - heading: "Classes"
   - title: "HttpRequestData"
     path: /assistant/smarthome/reference/local/classes/smarthome.dataflow.httprequestdata
   - title: "TcpRequestData"
     path: /assistant/smarthome/reference/local/classes/smarthome.dataflow.tcprequestdata
   - title: "UdpRequestData"
     path: /assistant/smarthome/reference/local/classes/smarthome.dataflow.udprequestdata
+  - heading: "Interfaces"
   - title: "CommandFailure"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.dataflow.commandfailure
   - title: "CommandSuccess"
@@ -49,26 +55,40 @@ toc:
   - title: "smarthome.Execute.Response"
     path: /assistant/smarthome/reference/local/modules/smarthome.execute.response
     section:
+    - heading: "Classes"
     - title: "Builder"
       path: /assistant/smarthome/reference/local/classes/smarthome.execute.response.builder
 
 - title: "smarthome.IntentFlow"
   path: /assistant/smarthome/reference/local/modules/smarthome.intentflow
   section:
-  - title: "ErrorCode"
-    path: /assistant/smarthome/reference/local/enums/smarthome.intentflow.errorcode
+  - heading: "Enums"
   - title: "IndicationMode"
     path: /assistant/smarthome/reference/local/enums/smarthome.intentflow.indicationmode
+  - heading: "Classes"
+  - title: "DeviceNotIdentifiedError"
+    path: /assistant/smarthome/reference/local/classes/smarthome.intentflow.devicenotidentifiederror
+  - title: "DeviceNotSupportedError"
+    path: /assistant/smarthome/reference/local/classes/smarthome.intentflow.devicenotsupportederror
   - title: "HandlerError"
     path: /assistant/smarthome/reference/local/classes/smarthome.intentflow.handlererror
+  - title: "InvalidRequestError"
+    path: /assistant/smarthome/reference/local/classes/smarthome.intentflow.invalidrequesterror
+  - heading: "Interfaces"
   - title: "DeviceInfo"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.deviceinfo
+  - title: "ExecuteHandler"
+    path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.executehandler
+  - title: "IdentifyHandler"
+    path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.identifyhandler
   - title: "IdentifyResponsePayload"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.identifyresponsepayload
   - title: "LocalIdentifiedDevice"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.localidentifieddevice
   - title: "MdnsScanData"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.mdnsscandata
+  - title: "ReachableDevicesHandler"
+    path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.reachabledeviceshandler
   - title: "ReachableDevicesPayload"
     path: /assistant/smarthome/reference/local/interfaces/smarthome.intentflow.reachabledevicespayload
   - title: "UdpScanData"

diff --git a/package.json b/package.json
@@ -1,15 +1,15 @@
 {
   "name": "@google/local-home-sdk",
-  "version": "0.2.1",
+  "version": "1.0.0",
   "description": "TypeScript type definitions for the Local Home SDK",
   "license": "Apache-2.0",
+  "author": "Google",
+  "repository": "actions-on-google/local-home-sdk",
   "scripts": {
     "build": "tsc",
     "lint": "dtslint",
     "docgen": "docgen/generate.sh"
   },
-  "author": "Google",
-  "repository": "actions-on-google/local-home-sdk",
   "types": "index.d.ts",
   "files": [
     "execute-builder.d.ts",