Self API in worker conversion to typescript.

packages/backend-core/src/index.ts

@@ -18,6 +18,7 @@ import * as logging from "./logging"
 import pino from "./pino"
 import * as middleware from "./middleware"
 import plugins from "./plugin"
+import encryption from "./security/encryption"
 
 // mimic the outer package exports
 import * as db from "./pkg/db"
@@ -60,6 +61,7 @@ const core = {
   ...pino,
   ...errorClasses,
   middleware,
+  encryption,
 }
 
 export = core

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

@@ -121,7 +121,7 @@ export const getTenantUser = async (
   return response
 }
 
-export const isUserInAppTenant = (appId: string, user: any) => {
+export const isUserInAppTenant = (appId: string, user?: any) => {
   let userTenantId
   if (user) {
     userTenantId = user.tenantId || DEFAULT_TENANT_ID

packages/worker/src/api/controllers/global/self.ts

@@ -1,39 +1,36 @@
-const {
+import { users } from "../../../sdk"
-  getGlobalDB,
+import {
-  getTenantId,
+  events,
-  isUserInAppTenant,
+  featureFlags,
-} = require("@budibase/backend-core/tenancy")
+  tenancy,
-const { generateDevInfoID, SEPARATOR } = require("@budibase/backend-core/db")
+  constants,
-const { user: userCache } = require("@budibase/backend-core/cache")
+  db as dbCore,
-const {
+  utils,
-  hash,
+  cache,
-  platformLogout,
+  encryption,
-  getCookie,
+} from "@budibase/backend-core"
-  clearCookie,
+import env from "../../../environment"
-} = require("@budibase/backend-core/utils")
+const { hash, platformLogout, getCookie, clearCookie, newid } = utils
-const { encrypt } = require("@budibase/backend-core/encryption")
+const { user: userCache } = cache
-const { newid } = require("@budibase/backend-core/utils")
-const { users } = require("../../../sdk")
-const { Cookies } = require("@budibase/backend-core/constants")
-const { events, featureFlags } = require("@budibase/backend-core")
-const env = require("../../../environment")
 
 function newTestApiKey() {
   return env.ENCRYPTED_TEST_PUBLIC_API_KEY
 }
 
 function newApiKey() {
-  return encrypt(`${getTenantId()}${SEPARATOR}${newid()}`)
+  return encryption.encrypt(
+    `${tenancy.getTenantId()}${dbCore.SEPARATOR}${newid()}`
+  )
 }
 
-function cleanupDevInfo(info) {
+function cleanupDevInfo(info: any) {
   // user doesn't need to aware of dev doc info
   delete info._id
   delete info._rev
   return info
 }
 
-exports.generateAPIKey = async ctx => {
+exports.generateAPIKey = async (ctx: any) => {
   let userId
   let apiKey
   if (env.isTest() && ctx.request.body.userId) {
@@ -44,8 +41,8 @@ exports.generateAPIKey = async ctx => {
     apiKey = newApiKey()
   }
 
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
-  const id = generateDevInfoID(userId)
+  const id = dbCore.generateDevInfoID(userId)
   let devInfo
   try {
     devInfo = await db.get(id)
@@ -57,9 +54,9 @@ exports.generateAPIKey = async ctx => {
   ctx.body = cleanupDevInfo(devInfo)
 }
 
-exports.fetchAPIKey = async ctx => {
+exports.fetchAPIKey = async (ctx: any) => {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
-  const id = generateDevInfoID(ctx.user._id)
+  const id = dbCore.generateDevInfoID(ctx.user._id)
   let devInfo
   try {
     devInfo = await db.get(id)
@@ -74,20 +71,20 @@ exports.fetchAPIKey = async ctx => {
   ctx.body = cleanupDevInfo(devInfo)
 }
 
-const checkCurrentApp = ctx => {
+const checkCurrentApp = (ctx: any) => {
-  const appCookie = getCookie(ctx, Cookies.CurrentApp)
+  const appCookie = getCookie(ctx, constants.Cookies.CurrentApp)
-  if (appCookie && !isUserInAppTenant(appCookie.appId)) {
+  if (appCookie && !tenancy.isUserInAppTenant(appCookie.appId)) {
     // there is a currentapp cookie from another tenant
     // remove the cookie as this is incompatible with the builder
     // due to builder and admin permissions being removed
-    clearCookie(ctx, Cookies.CurrentApp)
+    clearCookie(ctx, constants.Cookies.CurrentApp)
   }
 }
 
 /**
  * Add the attributes that are session based to the current user.
  */
-const addSessionAttributesToUser = ctx => {
+const addSessionAttributesToUser = (ctx: any) => {
   ctx.body.account = ctx.user.account
   ctx.body.license = ctx.user.license
   ctx.body.budibaseAccess = !!ctx.user.budibaseAccess
@@ -95,9 +92,9 @@ const addSessionAttributesToUser = ctx => {
   ctx.body.csrfToken = ctx.user.csrfToken
 }
 
-const sanitiseUserUpdate = ctx => {
+const sanitiseUserUpdate = (ctx: any) => {
   const allowed = ["firstName", "lastName", "password", "forceResetPassword"]
-  const resp = {}
+  const resp: { [key: string]: any } = {}
   for (let [key, value] of Object.entries(ctx.request.body)) {
     if (allowed.includes(key)) {
       resp[key] = value
@@ -106,7 +103,7 @@ const sanitiseUserUpdate = ctx => {
   return resp
 }
 
-exports.getSelf = async ctx => {
+exports.getSelf = async (ctx: any) => {
   if (!ctx.user) {
     ctx.throw(403, "User not logged in")
   }
@@ -121,14 +118,14 @@ exports.getSelf = async ctx => {
   ctx.body = await users.getUser(userId)
 
   // add the feature flags for this tenant
-  const tenantId = getTenantId()
+  const tenantId = tenancy.getTenantId()
   ctx.body.featureFlags = featureFlags.getTenantFeatureFlags(tenantId)
 
   addSessionAttributesToUser(ctx)
 }
 
-exports.updateSelf = async ctx => {
+exports.updateSelf = async (ctx: any) => {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   const user = await db.get(ctx.user._id)
   let passwordChange = false
 

packages/worker/src/api/routes/global/templates.js

@@ -1,9 +1,9 @@
-const Router = require("@koa/router")
+import Router from "@koa/router"
-const controller = require("../../controllers/global/templates")
+import controller from "../../controllers/global/templates"
-const { joiValidator } = require("@budibase/backend-core/auth")
+import { TemplatePurpose, TemplateTypes } from "../../../constants"
-const Joi = require("joi")
+import { auth as authCore } from "@budibase/backend-core"
-const { TemplatePurpose, TemplateTypes } = require("../../../constants")
+import Joi from "joi"
-const { adminOnly } = require("@budibase/backend-core/auth")
+const { adminOnly, joiValidator } = authCore
 
 const router = Router()