Release version 23

Author: Eric Koleda

dist/OAuth2.gs

@@ -27,19 +27,26 @@
 
 /**
  * The supported formats for the returned OAuth2 token.
- * @type {Object.<string, string>}
+ * @enum {string}
  */
 var TOKEN_FORMAT = {
+  /** JSON format, for example <code>{"access_token": "..."}</code> **/
   JSON: 'application/json',
+  /** Form URL-encoded, for example <code>access_token=...</code> **/
   FORM_URL_ENCODED: 'application/x-www-form-urlencoded'
 };
 
 /**
  * The supported locations for passing the state parameter.
- * @type {Object.<string, string>}
+ * @enum {string}
  */
 var STATE_PARAMETER_LOCATION = {
+  /**
+   * Pass the state parameter in the authorization URL.
+   * @default
+   */
   AUTHORIZATION_URL: 'authorization-url',
+  /** Pass the state token in the redirect URL, as a workaround for APIs that don't support the state parameter. */
   REDIRECT_URL: 'redirect-url'
 };
 
@@ -153,17 +160,28 @@ Service_.prototype.setTokenFormat = function(tokenFormat) {
 /**
  * Sets the additional HTTP headers that should be sent when retrieving or
  * refreshing the access token.
- * @param Object.<string,string> tokenHeaders A map of header names to values.
+ * @param {Object.<string,string>} tokenHeaders A map of header names to values.
  * @return {Service_} This service, for chaining.
  */
 Service_.prototype.setTokenHeaders = function(tokenHeaders) {
   this.tokenHeaders_ = tokenHeaders;
   return this;
 };
 
+/**
+ * @callback tokenHandler
+ * @param tokenPayload {Object} A hash of parameters to be sent to the token URL.
+ * @param tokenPayload.code {string} The authorization code.
+ * @param tokenPayload.client_id {string} The client ID.
+ * @param tokenPayload.client_secret {string} The client secret.
+ * @param tokenPayload.redirect_uri {string} The redirect URI.
+ * @param tokenPayload.grant_type {string} The type of grant requested.
+ * @returns {Object} A modified hash of parameters to be sent to the token URL.
+ */
+
 /**
  * Sets an additional function to invoke on the payload of the access token request.
- * @param Object tokenHandler A function to invoke on the payload of the request for an access token.
+ * @param tokenHandler {tokenHandler} tokenHandler A function to invoke on the payload of the request for an access token.
  * @return {Service_} This service, for chaining.
  */
 Service_.prototype.setTokenPayloadHandler = function(tokenHandler) {
@@ -436,7 +454,11 @@ Service_.prototype.reset = function() {
   validate_({
     'Property store': this.propertyStore_
   });
-  this.propertyStore_.deleteProperty(this.getPropertyKey_(this.serviceName_));
+  var key = this.getPropertyKey_(this.serviceName_);
+  this.propertyStore_.deleteProperty(key);
+  if (this.cache_) {
+    this.cache_.remove(key);
+  }
 };
 
 /**
@@ -449,9 +471,9 @@ Service_.prototype.getLastError = function() {
 };
 
 /**
- * Gets the last error that occurred this execution when trying to automatically refresh
- * or generate an access token.
- * @return {Exception} An error, if any.
+ * Returns the redirect URI that will be used for this service. Often this URI
+ * needs to be entered into a configuration screen of your OAuth provider.
+ * @return {string} The redirect URI.
  */
 Service_.prototype.getRedirectUri = function() {
   return getRedirectUri(this.scriptId_);
@@ -627,6 +649,7 @@ Service_.prototype.isExpired_ = function(token) {
 /**
  * Uses the service account flow to exchange a signed JSON Web Token (JWT) for an
  * access token.
+ * @private
  */
 Service_.prototype.exchangeJwt_ = function() {
   validate_({

package.json

@@ -1,6 +1,6 @@
 {
   "name": "apps-script-oauth2",
-  "version": "1.22.0",
+  "version": "1.23.0",
   "description": "OAuth2 for Apps Script is a library for Google Apps Script that provides the ability to create and authorize OAuth2 tokens as well as refresh them when they expire.",
   "repository": {
     "type": "git",