🤖 Merge PR DefinitelyTyped#74815 [google-apps-script-oauth2] Update types for version 43 by @sznorbert07

Author: sznorbert07

types/google-apps-script-oauth2/google-apps-script-oauth2-tests.ts

@@ -1,4 +1,4 @@
-// Examples from https://github.com/googlesamples/apps-script-oauth2
+// Examples from https://github.com/googleworkspace/apps-script-oauth2
 
 /**
  * Create the OAuth2 service.
@@ -17,6 +17,73 @@ function getDriveService() {
         .setParam("approval_prompt", "force");
 }
 
+/**
+ * Create sample service for Twitter.
+ */
+function getTwitterService() {
+    const userProps = PropertiesService.getUserProperties();
+    const clientId = "sampleClientId";
+    const clientSecret = "sampleClientSecret";
+
+    return OAuth2.createService("Twitter")
+        .setAuthorizationBaseUrl("https://twitter.com/i/oauth2/authorize")
+        .setTokenUrl("https://api.twitter.com/2/oauth2/token")
+        .setClientId(clientId)
+        .setClientSecret(clientSecret)
+        .setCallbackFunction("authCallback")
+        .setPropertyStore(userProps)
+        .setScope("users.read tweet.read offline.access")
+        .generateCodeVerifier()
+        .setTokenHeaders({
+            "Authorization": "Basic " + Utilities.base64Encode(clientId + ":" + clientSecret),
+            "Content-Type": "application/x-www-form-urlencoded",
+        });
+}
+
+/**
+ * Create sample service with custom token method.
+ */
+function getTestClientWithCustomTokenMethod() {
+    return OAuth2.createService("TestService")
+        .setAuthorizationBaseUrl("https://example.com/auth")
+        .setTokenUrl("https://example.com/token")
+        .setClientId("sampleClientId")
+        .setClientSecret("sampleClientSecret")
+        .setCallbackFunction("authCallback")
+        .setPropertyStore(PropertiesService.getUserProperties())
+        .setTokenMethod("PUT");
+}
+
+/**
+ * Create sample service with code verifier and S256 code challenge method.
+ */
+function getTestClientWithAutoCodeVerifierAndS256ChallengeMethod() {
+    return OAuth2.createService("TestService")
+        .setAuthorizationBaseUrl("https://example.com/auth")
+        .setTokenUrl("https://example.com/token")
+        .setClientId("sampleClientId")
+        .setClientSecret("sampleClientSecret")
+        .setCallbackFunction("authCallback")
+        .setPropertyStore(PropertiesService.getUserProperties())
+        .generateCodeVerifier()
+        .setCodeChallengeMethod(GoogleAppsScriptOAuth2.CodeChallengeMethod.S256);
+}
+
+/**
+ * Create sample service with code verifier and S256 code challenge method.
+ */
+function getTestClientWithManualCodeVerifierAndPlainChallengeMethod() {
+    return OAuth2.createService("TestService")
+        .setAuthorizationBaseUrl("https://example.com/auth")
+        .setTokenUrl("https://example.com/token")
+        .setClientId("sampleClientId")
+        .setClientSecret("sampleClientSecret")
+        .setCallbackFunction("authCallback")
+        .setPropertyStore(PropertiesService.getUserProperties())
+        .setCodeVerififer("sampleCodeVerifier")
+        .setCodeChallengeMethod(GoogleAppsScriptOAuth2.CodeChallengeMethod.PLAIN);
+}
+
 /**
  * Handle the callback.
  */

types/google-apps-script-oauth2/index.d.ts

@@ -17,6 +17,13 @@ declare namespace GoogleAppsScriptOAuth2 {
          * Often this URI needs to be entered into a configuration screen of your OAuth provider.
          */
         getRedirectUri(scriptId?: string): string;
+        /**
+         * Gets the list of services with tokens stored in the given property store.
+         * This is useful if you connect to the same API with multiple accounts and
+         * need to keep track of them. If no stored tokens are found this will return
+         * an empty array.
+         */
+        getServiceNames(propertyStore: GoogleAppsScript.Properties.PropertiesService): string[];
     }
 
     interface Storage {
@@ -217,6 +224,26 @@ declare namespace GoogleAppsScriptOAuth2 {
          * For Google services this URL should be `https://accounts.google.com/o/oauth2/token`.
          */
         setTokenUrl(tokenUrl: string): OAuth2Service;
+        /**
+         * Sets the HTTP method to use when retrieving or refreshing the access token.
+         * Default: `post`.
+         */
+        setTokenMethod(tokenMethod: string): OAuth2Service;
+        /**
+         * Set the code verifier used for PKCE. For most use cases,
+         * prefer `generateCodeVerifier` to automatically initialize the
+         * value with a generated challenge string.
+         */
+        setCodeVerififer(codeVerifier: string): OAuth2Service;
+        /**
+         * Sets the code verifier to a randomly generated challenge string.
+         */
+        generateCodeVerifier(): OAuth2Service;
+        /**
+         * Set the code challenge method for PKCE. The default value method
+         * when a code verifier is set is `S256`.
+         */
+        setCodeChallengeMethod(method: CodeChallengeMethod): OAuth2Service;
     }
 
     enum TokenFormat {
@@ -230,6 +257,11 @@ declare namespace GoogleAppsScriptOAuth2 {
         FORM_URL_ENCODED = "application/x-www-form-urlencoded",
     }
 
+    enum CodeChallengeMethod {
+        S256 = "S256",
+        PLAIN = "plain",
+    }
+
     interface TokenPayload {
         code: string;
         client_id: string;

types/google-apps-script-oauth2/package.json

@@ -1,11 +1,11 @@
 {
     "private": true,
     "name": "@types/google-apps-script-oauth2",
-    "version": "38.0.9999",
+    "version": "43.0.9999",
     "nonNpm": true,
     "nonNpmDescription": "google-apps-script-oauth2",
     "projects": [
-        "https://github.com/googlesamples/apps-script-oauth2"
+        "https://github.com/googleworkspace/apps-script-oauth2"
     ],
     "dependencies": {
         "@types/google-apps-script": "*"