feat: add functions for gdoc oauth and update config page to trigger the oauth flow in gdocs (#10247)

Author: sam-is-content

apps/google-docs/contentful-app-manifest.json

@@ -1,4 +1,15 @@
 {
+  "name": "Google Docs",
+  "description": "Sync your Contentful content with Google Docs",
+  "id": "google-docs",
+  "category": "Productivity",
+  "version": "0.1.0",
+  "locations": [
+    {
+      "location": "app-config",
+      "component": "ConfigScreen"
+    }
+  ],
   "parameters": {
     "installation": [
       {
@@ -20,6 +31,58 @@
       "accepts": [
         "appaction.call"
       ]
+    },
+    {
+      "id": "initiateOauth",
+      "name": "Initiate OAuth",
+      "description": "Initiates the OAuth flow for Google Docs",
+      "path": "functions/initiateOauth.js",
+      "entryFile": "functions/initiateOauth.ts",
+      "allowNetworks": [
+        "www.google.com"
+      ],
+      "accepts": [
+        "appaction.call"
+      ]
+    },
+    {
+      "id": "completeOauth",
+      "name": "Complete OAuth",
+      "description": "Completes the OAuth flow for Google Docs",
+      "path": "functions/completeOauth.js",
+      "entryFile": "functions/completeOauth.ts",
+      "allowNetworks": [
+        "a.google.com"
+      ],
+      "accepts": [
+        "appaction.call"
+      ]
+    },
+    {
+      "id": "disconnect",
+      "name": "Disconnect",
+      "description": "Disconnects the Google Docs app",
+      "path": "functions/disconnect.js",
+      "entryFile": "functions/disconnect.ts",
+      "allowNetworks": [
+        "a.google.com"
+      ],
+      "accepts": [
+        "appaction.call"
+      ]
+    },
+    {
+      "id": "checkStatus",
+      "name": "Check Status",
+      "description": "Checks the status of the Google Docs app",
+      "path": "functions/checkStatus.js",
+      "entryFile": "functions/checkStatus.ts",
+      "allowNetworks": [
+        "a.google.com"
+      ],
+      "accepts": [
+        "appaction.call"
+      ]
     }
   ],
   "actions": [

apps/google-docs/functions/checkStatus.ts

@@ -0,0 +1,47 @@
+import { OAuthSDK } from './initiateOauth';
+import {
+  FunctionEventHandler,
+  AppActionRequest,
+  FunctionTypeEnum,
+  AppActionResponse,
+  FunctionEventContext,
+} from '@contentful/node-apps-toolkit';
+interface CompleteOAuthParams {
+  code: string;
+  state: string;
+}
+
+export async function checkStatus(sdk: OAuthSDK): Promise<boolean> {
+  try {
+    const token = await sdk.token();
+    if (!token) {
+      return false;
+    }
+    return true;
+  } catch (error) {
+    console.error('Failed to complete OAuth flow:', error);
+    return false;
+  }
+}
+
+export const handler: FunctionEventHandler<FunctionTypeEnum.AppActionCall> = async (
+  event: AppActionRequest<'Custom', CompleteOAuthParams>,
+  context: FunctionEventContext
+): Promise<AppActionResponse> => {
+  const sdk = (context as any).oauthSdk;
+
+  if (!sdk) {
+    console.error('No SDK available in context');
+    return {
+      statusCode: 500,
+      body: JSON.stringify({ error: 'No SDK available in context' }),
+    };
+  }
+
+  const connected = await checkStatus(sdk);
+
+  return {
+    statusCode: 200,
+    connected,
+  };
+};

apps/google-docs/functions/disconnect.ts

@@ -0,0 +1,26 @@
+import {
+  AppEventHandlerRequest,
+  AppEventHandlerResponse,
+  AppEventContext,
+} from './types/oauth.types';
+
+export const handler = async (
+  event: AppEventHandlerRequest,
+  context: AppEventContext
+): Promise<AppEventHandlerResponse> => {
+  const sdk = (context as any).oauthSdk;
+
+  try {
+    await sdk.revoke();
+
+    return {
+      statusCode: 200,
+    };
+  } catch (error) {
+    console.error('Error during disconnect:', error);
+    return {
+      statusCode: 500,
+      body: JSON.stringify({ error: 'Failed to disconnect' }),
+    };
+  }
+};

apps/google-docs/functions/initiateOauth.ts

@@ -1,5 +1,3 @@
-import { AppEventHandlerResponse } from '@contentful/node-apps-toolkit';
-
 /*
  * INTEG-3271: Double check the imported types and make sure they work for Google Docs (use Klaviyo as a reference)
  */
@@ -11,6 +9,7 @@ import {
   AppEventHandlerRequest,
   OAuthResponseUrl,
   AppEventContext,
+  AppEventHandlerResponse,
 } from './types/oauth.types';
 
 export type OAuthSDK = {
@@ -40,4 +39,14 @@ export const handler = async (
 ): Promise<AppEventHandlerResponse> => {
   // Use the oauth sdk to initiate the oauth flow, use initiateOauth.ts from Klaviyo as a reference
   const sdk = (context as any).oauthSdk;
+  if (!sdk) {
+    console.error('No SDK available in context');
+    return {
+      statusCode: 500,
+      body: JSON.stringify({ error: 'No SDK available in context' }),
+    };
+  }
+
+  const oauthResponse = await initiateOauth(sdk);
+  return oauthResponse;
 };

apps/google-docs/functions/tsconfig.json

@@ -16,6 +16,10 @@ export interface AppEventHandlerRequest {
   state?: string;
 }
 
+export interface AppEventHandlerResponse {
+  // Empty response for event handlers
+}
+
 export interface OAuthResponseUrl {
   authorizationUrl: string;
 }

apps/google-docs/functions/types/oauth.types.ts

@@ -9,6 +9,7 @@
     "@contentful/f36-tokens": "^5.1.0",
     "@contentful/field-editor-json": "^3.3.38",
     "@contentful/react-apps-toolkit": "^1.2.16",
+    "@contentful/node-apps-toolkit": "^3.13.0",
     "@emotion/css": "^11.13.4",
     "ai": "^5.0.81",
     "contentful-management": "^11.61.0",