convert views to typescript

packages/backend-core/src/db/views.ts

@@ -1,12 +1,7 @@
-const {
+import { DocumentType, ViewName, DeprecatedViews, SEPARATOR } from "./utils"
-  DocumentType,
+import { getGlobalDB } from "../tenancy"
-  ViewName,
+import { StaticDatabases } from "./constants"
-  DeprecatedViews,
+import { doWithDB } from "./"
-  SEPARATOR,
-} = require("./utils")
-const { getGlobalDB } = require("../tenancy")
-const { StaticDatabases } = require("./constants")
-const { doWithDB } = require("./")
 
 const DESIGN_DB = "_design/database"
 
@@ -19,12 +14,18 @@ function DesignDoc() {
   }
 }
 
-async function removeDeprecated(db, viewName) {
+interface DesignDocument {
+  views: any
+}
+
+async function removeDeprecated(db: PouchDB.Database, viewName: ViewName) {
+  // @ts-ignore
   if (!DeprecatedViews[viewName]) {
     return
   }
   try {
-    const designDoc = await db.get(DESIGN_DB)
+    const designDoc = await db.get<DesignDocument>(DESIGN_DB)
+    // @ts-ignore
     for (let deprecatedNames of DeprecatedViews[viewName]) {
       delete designDoc.views[deprecatedNames]
     }
@@ -34,7 +35,7 @@ async function removeDeprecated(db, viewName) {
   }
 }
 
-exports.createNewUserEmailView = async () => {
+export const createNewUserEmailView = async () => {
   const db = getGlobalDB()
   let designDoc
   try {
@@ -58,36 +59,39 @@ exports.createNewUserEmailView = async () => {
   await db.put(designDoc)
 }
 
-exports.createAccountEmailView = async () => {
+export const createAccountEmailView = async () => {
-  await doWithDB(StaticDatabases.PLATFORM_INFO.name, async db => {
+  await doWithDB(
-    let designDoc
+    StaticDatabases.PLATFORM_INFO.name,
-    try {
+    async (db: PouchDB.Database) => {
-      designDoc = await db.get(DESIGN_DB)
+      let designDoc
-    } catch (err) {
+      try {
-      // no design doc, make one
+        designDoc = await db.get<DesignDocument>(DESIGN_DB)
-      designDoc = DesignDoc()
+      } catch (err) {
-    }
+        // no design doc, make one
-    const view = {
+        designDoc = DesignDoc()
-      // if using variables in a map function need to inject them before use
+      }
-      map: `function(doc) {
+      const view = {
+        // if using variables in a map function need to inject them before use
+        map: `function(doc) {
       if (doc._id.startsWith("${DocumentType.ACCOUNT_METADATA}${SEPARATOR}")) {
         emit(doc.email.toLowerCase(), doc._id)
       }
     }`,
+      }
+      designDoc.views = {
+        ...designDoc.views,
+        [ViewName.ACCOUNT_BY_EMAIL]: view,
+      }
+      await db.put(designDoc)
     }
-    designDoc.views = {
+  )
-      ...designDoc.views,
-      [ViewName.ACCOUNT_BY_EMAIL]: view,
-    }
-    await db.put(designDoc)
-  })
 }
 
-exports.createUserAppView = async () => {
+export const createUserAppView = async () => {
-  const db = getGlobalDB()
+  const db = getGlobalDB() as PouchDB.Database
   let designDoc
   try {
-    designDoc = await db.get("_design/database")
+    designDoc = await db.get<DesignDocument>("_design/database")
   } catch (err) {
     // no design doc, make one
     designDoc = DesignDoc()
@@ -110,7 +114,7 @@ exports.createUserAppView = async () => {
   await db.put(designDoc)
 }
 
-exports.createApiKeyView = async () => {
+export const createApiKeyView = async () => {
   const db = getGlobalDB()
   let designDoc
   try {
@@ -132,7 +136,7 @@ exports.createApiKeyView = async () => {
   await db.put(designDoc)
 }
 
-exports.createUserBuildersView = async () => {
+export const createUserBuildersView = async () => {
   const db = getGlobalDB()
   let designDoc
   try {
@@ -155,43 +159,58 @@ exports.createUserBuildersView = async () => {
   await db.put(designDoc)
 }
 
-exports.createPlatformUserView = async () => {
+export const createPlatformUserView = async () => {
-  await doWithDB(StaticDatabases.PLATFORM_INFO.name, async db => {
+  await doWithDB(
-    let designDoc
+    StaticDatabases.PLATFORM_INFO.name,
-    try {
+    async (db: PouchDB.Database) => {
-      designDoc = await db.get(DESIGN_DB)
+      let designDoc
-    } catch (err) {
+      try {
-      // no design doc, make one
+        designDoc = await db.get<DesignDocument>(DESIGN_DB)
-      designDoc = DesignDoc()
+      } catch (err) {
-    }
+        // no design doc, make one
-    const view = {
+        designDoc = DesignDoc()
-      // if using variables in a map function need to inject them before use
+      }
-      map: `function(doc) {
+      const view = {
+        // if using variables in a map function need to inject them before use
+        map: `function(doc) {
         if (doc.tenantId) {
           emit(doc._id.toLowerCase(), doc._id)
         }
       }`,
+      }
+      designDoc.views = {
+        ...designDoc.views,
+        [ViewName.PLATFORM_USERS_LOWERCASE]: view,
+      }
+      await db.put(designDoc)
     }
-    designDoc.views = {
+  )
-      ...designDoc.views,
-      [ViewName.PLATFORM_USERS_LOWERCASE]: view,
-    }
-    await db.put(designDoc)
-  })
 }
 
-exports.queryView = async (viewName, params, db, CreateFuncByName) => {
+export interface QueryViewOptions {
+  arrayResponse?: boolean
+}
+
+export const queryView = async <T>(
+  viewName: ViewName,
+  params: PouchDB.Query.Options<T, T>,
+  db: PouchDB.Database,
+  CreateFuncByName: any,
+  opts?: QueryViewOptions
+): Promise<T[] | T | undefined> => {
   try {
-    let response = (await db.query(`database/${viewName}`, params)).rows
+    let response = await db.query<T, T>(`database/${viewName}`, params)
-    response = response.map(resp =>
+    const rows = response.rows
+    const docs = rows.map((resp: any) =>
       params.include_docs ? resp.doc : resp.value
     )
-    if (params.arrayResponse) {
+
-      return response
+    if (opts?.arrayResponse) {
+      return docs
     } else {
-      return response.length <= 1 ? response[0] : response
+      return docs.length <= 1 ? docs[0] : docs
     }
-  } catch (err) {
+  } catch (err: any) {
     if (err != null && err.name === "not_found") {
       const createFunc = CreateFuncByName[viewName]
       await removeDeprecated(db, viewName)
@@ -203,18 +222,30 @@ exports.queryView = async (viewName, params, db, CreateFuncByName) => {
   }
 }
 
-exports.queryPlatformView = async (viewName, params) => {
+export const queryPlatformView = async <T>(
+  viewName: ViewName,
+  params: PouchDB.Query.Options<T, T>,
+  opts?: QueryViewOptions
+): Promise<T[] | T | undefined> => {
   const CreateFuncByName = {
     [ViewName.ACCOUNT_BY_EMAIL]: exports.createAccountEmailView,
     [ViewName.PLATFORM_USERS_LOWERCASE]: exports.createPlatformUserView,
   }
 
-  return doWithDB(StaticDatabases.PLATFORM_INFO.name, async db => {
+  return doWithDB(
-    return exports.queryView(viewName, params, db, CreateFuncByName)
+    StaticDatabases.PLATFORM_INFO.name,
-  })
+    async (db: PouchDB.Database) => {
+      return exports.queryView(viewName, params, db, CreateFuncByName, opts)
+    }
+  )
 }
 
-exports.queryGlobalView = async (viewName, params, db = null) => {
+export const queryGlobalView = async <T>(
+  viewName: ViewName,
+  params: PouchDB.Query.Options<T, T>,
+  db?: PouchDB.Database,
+  opts?: QueryViewOptions
+): Promise<T[] | T | undefined> => {
   const CreateFuncByName = {
     [ViewName.USER_BY_EMAIL]: exports.createNewUserEmailView,
     [ViewName.BY_API_KEY]: exports.createApiKeyView,

packages/backend-core/src/tenancy/utils.ts

@@ -1,7 +1,7 @@
-const { DEFAULT_TENANT_ID } = require("../constants")
+import { DEFAULT_TENANT_ID } from "../constants"
-const { StaticDatabases, SEPARATOR } = require("../db/constants")
+import { StaticDatabases, SEPARATOR } from "../db/constants"
 
-exports.baseGlobalDBName = tenantId => {
+export const baseGlobalDBName = (tenantId: string | undefined | null) => {
   let dbName
   if (!tenantId || tenantId === DEFAULT_TENANT_ID) {
     dbName = StaticDatabases.GLOBAL.name

packages/worker/src/sdk/users/users.ts

@@ -164,7 +164,7 @@ const buildUser = async (
 const validateUniqueUser = async (email: string, tenantId: string) => {
   // check budibase users in other tenants
   if (env.MULTI_TENANCY) {
-    const tenantUser = await tenancy.getTenantUser(email)
+    const tenantUser = (await tenancy.getTenantUser(email)) as User | undefined
     if (tenantUser != null && tenantUser.tenantId !== tenantId) {
       throw `Unavailable`
     }
@@ -279,33 +279,60 @@ export const addTenant = async (
 
 const getExistingTenantUsers = async (emails: string[]): Promise<User[]> => {
   const lcEmails = emails.map(email => email.toLowerCase())
-  return dbUtils.queryGlobalView(ViewName.USER_BY_EMAIL, {
+  const params = {
     keys: lcEmails,
     include_docs: true,
+  }
+
+  const opts = {
     arrayResponse: true,
-  })
+  }
+
+  return dbUtils.queryGlobalView(
+    ViewName.USER_BY_EMAIL,
+    params,
+    undefined,
+    opts
+  ) as Promise<User[]>
 }
 
 const getExistingPlatformUsers = async (
   emails: string[]
 ): Promise<PlatformUserByEmail[]> => {
   const lcEmails = emails.map(email => email.toLowerCase())
-  return dbUtils.queryPlatformView(ViewName.PLATFORM_USERS_LOWERCASE, {
+  const params = {
     keys: lcEmails,
     include_docs: true,
+  }
+
+  const opts = {
     arrayResponse: true,
-  })
+  }
+  return dbUtils.queryPlatformView(
+    ViewName.PLATFORM_USERS_LOWERCASE,
+    params,
+    opts
+  ) as Promise<PlatformUserByEmail[]>
 }
 
 const getExistingAccounts = async (
   emails: string[]
 ): Promise<AccountMetadata[]> => {
   const lcEmails = emails.map(email => email.toLowerCase())
-  return dbUtils.queryPlatformView(ViewName.ACCOUNT_BY_EMAIL, {
+  const params = {
     keys: lcEmails,
     include_docs: true,
+  }
+
+  const opts = {
     arrayResponse: true,
-  })
+  }
+
+  return dbUtils.queryPlatformView(
+    ViewName.ACCOUNT_BY_EMAIL,
+    params,
+    opts
+  ) as Promise<AccountMetadata[]>
 }
 
 /**