Encapsulate all nango logic into oauthIntegration

useVenice · Oct 13, 2023 · 3674bc8 · 3674bc8
1 parent e19d462
commit 3674bc8
Show file tree

Hide file tree

Showing 11 changed files with 296 additions and 224 deletions.
diff --git a/integrations/integration-qbo/QBOClient.ts b/integrations/integration-qbo/QBOClient.ts
@@ -1,3 +1,4 @@
+import {oauthBaseSchema} from '@usevenice/cdk-core'
 import {
   createHTTPClient,
   DateTime,
@@ -7,197 +8,210 @@ import {
   zFunction,
 } from '@usevenice/util'
 
-export const zConfig = z.object({
-  clientId: z.string(),
-  clientSecret: z.string(),
-  scope: z.string(),
+export const zConfig = oauthBaseSchema.integrationConfig.extend({
   envName: z.enum(['sandbox', 'production']),
   url: z.string().nullish().describe('For proxies, not typically needed'),
   verifierToken: z.string().nullish().describe('For webhooks'),
 })
 
-export const zCreds = z.object({
-  sandbox: z.boolean().nullish(),
-  realmId: z.string(),
-  refreshToken: z.string(),
-  accessToken: z.string().nullish(),
-  accessTokenExpiresAt: z.string().nullish(), // ISODateTime
-  /** Informational for nwo.  */
-  refreshTokenExpiresAt: z.string().nullish(), // ISODateTime
+const oReso = oauthBaseSchema.resourceSettings
+/** Very verbose definition... Do we want it a bit simpler maybe? */
+export const zSettings = oReso.extend({
+  oauth: oReso.shape.oauth.extend({
+    connection_config: z.object({
+      realmId: z.string(),
+    }),
+    credentials: oReso.shape.oauth.shape.credentials.extend({
+      raw: oReso.shape.oauth.shape.credentials.shape.raw.extend({
+        refresh_token: z.string(),
+      }),
+    }),
+  }),
 })
 
-export const makeQBOClient = zFunction([zConfig, zCreds], (config, creds) => {
-  const apiHost =
-    config.url ??
-    (creds.sandbox
-      ? 'https://sandbox-quickbooks.api.intuit.com'
-      : 'https://quickbooks.api.intuit.com')
+export const makeQBOClient = zFunction(
+  [zConfig, zSettings],
+  (config, settings) => {
+    const apiHost =
+      config.url ??
+      (config.envName === 'sandbox'
+        ? 'https://sandbox-quickbooks.api.intuit.com'
+        : 'https://quickbooks.api.intuit.com')
 
-  function oauth2(config: {clientId: string; clientSecret: string}) {
-    return new OAuth2Client<QBOOAuthTypes['error'], QBOOAuthTypes['tokens']>({
-      clientId: config.clientId,
-      clientSecret: config.clientSecret,
-      authorizeURL: 'https://appcenter.intuit.com/connect/oauth2',
-      tokenURL: 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer',
-      revokeUrl: 'https://developer.api.intuit.com/v2/oauth2/tokens/revoke',
-      clientAuthLocation: 'header',
-      errorToString: (err) =>
-        err.error_description
-          ? `${err.error}: ${err.error_description}`
-          : err.error,
-    })
-  }
+    const creds = {
+      realmId: settings.oauth.connection_config.realmId,
+      accessToken: settings.oauth.credentials.access_token,
+      accessTokenExpiresAt: settings.oauth.credentials.expires_at,
+      refreshToken: settings.oauth.credentials.raw.refresh_token,
+    }
 
-  function parseTokens(tokens: QBOOAuthTypes['tokens']) {
-    // TODO: Use intuit returned Date in header if we could. Looks like
-    // Date: Wed, 12 Aug 2020 14:25:39 GMT
-    // Need access to header also here
-    const now = DateTime.utc()
-    return {
-      accessToken: tokens.access_token,
-      refreshToken: tokens.refresh_token,
-      accessTokenExpiresAt: now.plus({seconds: tokens.expires_in}).toISO(),
-      refreshTokenExpiresAt: now
-        .plus({seconds: tokens.x_refresh_token_expires_in})
-        .toISO(),
+    function oauth2() {
+      return new OAuth2Client<QBOOAuthTypes['error'], QBOOAuthTypes['tokens']>({
+        clientId: config.oauth.client_id,
+        clientSecret: config.oauth.client_secret,
+        authorizeURL: 'https://appcenter.intuit.com/connect/oauth2',
+        tokenURL: 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer',
+        revokeUrl: 'https://developer.api.intuit.com/v2/oauth2/tokens/revoke',
+        clientAuthLocation: 'header',
+        errorToString: (err) =>
+          err.error_description
+            ? `${err.error}: ${err.error_description}`
+            : err.error,
+      })
     }
-  }
 
-  const http = createHTTPClient({
-    baseURL: `${apiHost}/v3/company/${creds.realmId}/`,
-    headers: {'Content-Type': 'application/json'},
-    requestTransformer: (req) => {
-      req.headers = {
-        ...(req.headers as Record<string, unknown>),
-        Authorization: `Bearer ${creds.accessToken}`,
+    function parseTokens(tokens: QBOOAuthTypes['tokens']) {
+      // TODO: Use intuit returned Date in header if we could. Looks like
+      // Date: Wed, 12 Aug 2020 14:25:39 GMT
+      // Need access to header also here
+      const now = DateTime.utc()
+      return {
+        accessToken: tokens.access_token,
+        refreshToken: tokens.refresh_token,
+        accessTokenExpiresAt: now.plus({seconds: tokens.expires_in}).toISO(),
+        refreshTokenExpiresAt: now
+          .plus({seconds: tokens.x_refresh_token_expires_in})
+          .toISO(),
       }
-      return req
-    },
-    errorTransformer: (err) =>
-      // if (err.response && err.response.data) {
-      //   return new YodleeError(err.response.data, err)
-      // }
-      err,
-    refreshAuth: {
-      shouldProactiveRefresh: () =>
-        creds.accessTokenExpiresAt
-          ? // Proactive refresh within 30 mins.
-            DateTime.fromISO(creds.accessTokenExpiresAt) >=
-            DateTime.utc().minus({minutes: 30})
-          : false,
-      refresh: () =>
-        oauth2(config)
-          .refreshToken(creds.refreshToken)
-          .then((res) => {
-            Object.assign(creds, parseTokens(res))
-          }),
-    },
-  })
+    }
 
-  /** Prefix id with realmId to get id global within QBO provider */
-  function globalId(id: string) {
-    return `${creds.realmId}_${id}`
-  }
+    const http = createHTTPClient({
+      baseURL: `${apiHost}/v3/company/${creds.realmId}/`,
+      headers: {'Content-Type': 'application/json'},
+      requestTransformer: (req) => {
+        req.headers = {
+          ...(req.headers as Record<string, unknown>),
+          Authorization: `Bearer ${creds.accessToken}`,
+        }
+        return req
+      },
+      errorTransformer: (err) =>
+        // if (err.response && err.response.data) {
+        //   return new YodleeError(err.response.data, err)
+        // }
+        err,
+      refreshAuth: {
+        shouldProactiveRefresh: () =>
+          creds.accessTokenExpiresAt
+            ? // Proactive refresh within 30 mins.
+              DateTime.fromISO(creds.accessTokenExpiresAt) >=
+              DateTime.utc().minus({minutes: 30})
+            : false,
+        refresh: () =>
+          oauth2()
+            .refreshToken(creds.refreshToken)
+            .then((res) => {
+              Object.assign(creds, parseTokens(res))
+            }),
+      },
+    })
+
+    /** Prefix id with realmId to get id global within QBO provider */
+    function globalId(id: string) {
+      return `${creds.realmId}_${id}`
+    }
 
-  const query = zFunction(z.string(), async (query) =>
-    http.get<QBO.QueryPayload>('query', {params: {query}}).then((r) => r.data),
-  )
+    const query = zFunction(z.string(), async (query) =>
+      http
+        .get<QBO.QueryPayload>('query', {params: {query}})
+        .then((r) => r.data),
+    )
 
-  async function* getAll<T extends QBO.EntityName>(
-    entityName: T,
-    /** Range is inclusive */
-    params: {updatedSince?: ISODateTime} = {},
-  ) {
-    let startPosition = 1 // QBO is 1 index based
-    // Fetch 100 transactions only on the first request to optimize for incremental
-    // sync scenarios
-    let maxResults = 100
-    while (true) {
-      const res = await query(
-        `SELECT * FROM ${entityName} ${
-          params.updatedSince
-            ? `WHERE MetaData.LastUpdatedTime >='${params.updatedSince}'`
-            : ''
-        } ORDERBY MetaData.LastUpdatedTime DESC
+    async function* getAll<T extends QBO.EntityName>(
+      entityName: T,
+      /** Range is inclusive */
+      params: {updatedSince?: ISODateTime} = {},
+    ) {
+      let startPosition = 1 // QBO is 1 index based
+      // Fetch 100 transactions only on the first request to optimize for incremental
+      // sync scenarios
+      let maxResults = 100
+      while (true) {
+        const res = await query(
+          `SELECT * FROM ${entityName} ${
+            params.updatedSince
+              ? `WHERE MetaData.LastUpdatedTime >='${params.updatedSince}'`
+              : ''
+          } ORDERBY MetaData.LastUpdatedTime DESC
          STARTPOSITION ${startPosition} MAXRESULTS ${maxResults}`,
-      )
+        )
 
-      const entities = res.QueryResponse[entityName] ?? []
-      yield {
-        // Hack needed for some reason
-        entities: entities as Exclude<typeof entities, never[]>,
-        startPosition,
-        maxResults,
+        const entities = res.QueryResponse[entityName] ?? []
+        yield {
+          // Hack needed for some reason
+          entities: entities as Exclude<typeof entities, never[]>,
+          startPosition,
+          maxResults,
+        }
+        if (entities.length === 0) {
+          break
+        }
+        startPosition += entities.length
+        maxResults = 500 // Then fetch 500 fo efficiency
       }
-      if (entities.length === 0) {
-        break
-      }
-      startPosition += entities.length
-      maxResults = 500 // Then fetch 500 fo efficiency
     }
-  }
 
-  return {
-    globalId,
-    query,
-    read: zFunction(
-      [zCast<QBO.EntityName>(), z.union([z.string(), z.number()])],
-      async (entityName, id) =>
-        http.get<unknown>(`${entityName}/${id}`).then((r) => r.data),
-    ),
-    count: zFunction(zCast<QBO.EntityName>(), async (entity) =>
-      query(`SELECT count(*) FROM ${entity}`).then(
-        (r) => r.QueryResponse.totalCount ?? -1,
+    return {
+      globalId,
+      query,
+      read: zFunction(
+        [zCast<QBO.EntityName>(), z.union([z.string(), z.number()])],
+        async (entityName, id) =>
+          http.get<unknown>(`${entityName}/${id}`).then((r) => r.data),
       ),
-    ),
-    getAll,
-    getChangeDataCapture: zFunction(
-      z.object({
-        entities: zCast<QBO.EntityName[]>(),
-        changedSince: z.string(),
-      }),
-      async (params) =>
+      count: zFunction(zCast<QBO.EntityName>(), async (entity) =>
+        query(`SELECT count(*) FROM ${entity}`).then(
+          (r) => r.QueryResponse.totalCount ?? -1,
+        ),
+      ),
+      getAll,
+      getChangeDataCapture: zFunction(
+        z.object({
+          entities: zCast<QBO.EntityName[]>(),
+          changedSince: z.string(),
+        }),
+        async (params) =>
+          http
+            .get<QBO.CDCPayload>('cdc', {
+              params: {...params, entities: params.entities.join(',')},
+            })
+            .then((r) => r.data),
+      ),
+      getCompanyInfo: zFunction(async () =>
         http
-          .get<QBO.CDCPayload>('cdc', {
-            params: {...params, entities: params.entities.join(',')},
-          })
+          .get<QBO.GetCompanyInfoPayload>(`companyinfo/${creds.realmId}`)
           .then((r) => r.data),
-    ),
-    getCompanyInfo: zFunction(async () =>
-      http
-        .get<QBO.GetCompanyInfoPayload>(`companyinfo/${creds.realmId}`)
-        .then((r) => r.data),
-    ),
-    getPreferences: zFunction(async () =>
-      http.get<unknown>('preferences').then((r) => r.data),
-    ),
-    reportTransactionsList: zFunction(async () =>
-      http
-        .get<QBO.ReportPayload>('reports/TransactionList')
-        .then((r) => r.data),
-    ),
-    revokeAccessToken: zFunction(async () => {
-      const oauth = oauth2(config)
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      const res = await oauth.revokeToken(creds.accessToken!)
-      return res
-    }),
+      ),
+      getPreferences: zFunction(async () =>
+        http.get<unknown>('preferences').then((r) => r.data),
+      ),
+      reportTransactionsList: zFunction(async () =>
+        http
+          .get<QBO.ReportPayload>('reports/TransactionList')
+          .then((r) => r.data),
+      ),
+      revokeAccessToken: zFunction(async () => {
+        const oauth = oauth2()
+        const res = await oauth.revokeToken(creds.accessToken)
+        return res
+      }),
 
-    refreshAccessToken: zFunction(async () => {
-      const oauth = oauth2(config)
-      const res = await oauth.refreshToken(creds.refreshToken)
-      creds.accessToken = res.access_token
-      return res
-    }),
-    SCOPES: {
-      accounting: 'com.intuit.quickbooks.accounting',
-      payment: 'com.intuit.quickbooks.payment',
-      payroll: 'com.intuit.quickbooks.payroll',
-      timetracking: 'com.intuit.quickbooks.payroll.timetracking',
-      benefits: 'com.intuit.quickbooks.payroll.benefits',
-    },
-  }
-})
+      refreshAccessToken: zFunction(async () => {
+        const oauth = oauth2()
+        const res = await oauth.refreshToken(creds.refreshToken)
+        creds.accessToken = res.access_token
+        return res
+      }),
+      SCOPES: {
+        accounting: 'com.intuit.quickbooks.accounting',
+        payment: 'com.intuit.quickbooks.payment',
+        payroll: 'com.intuit.quickbooks.payroll',
+        timetracking: 'com.intuit.quickbooks.payroll.timetracking',
+        benefits: 'com.intuit.quickbooks.payroll.benefits',
+      },
+    }
+  },
+)
 
 interface QBOOAuthTypes {
   error: {error: string; error_description?: string}

diff --git a/integrations/integration-qbo/def.ts b/integrations/integration-qbo/def.ts
@@ -5,12 +5,12 @@ import type {Standard} from '@usevenice/standard'
 import type {EnumOf} from '@usevenice/util'
 import {A, DateTime, z, zCast} from '@usevenice/util'
 
-import {zConfig, zCreds} from './QBOClient'
+import {zConfig, zSettings} from './QBOClient'
 
 export const qboSchemas = {
   name: z.literal('qbo'),
   integrationConfig: zConfig,
-  resourceSettings: zCreds,
+  resourceSettings: zSettings,
   sourceOutputEntity: z.discriminatedUnion('entityName', [
     z.object({
       id: z.string(),