npm - @budibase/server - Versions diffs - 2.1.38 → 2.1.40-alpha.0 - Mend

@budibase/server 2.1.38 → 2.1.40-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (788) hide show

package/coverage/lcov-report/{api/controllers/permission.js.html → src/api/controllers/permission.ts.html} RENAMED Viewed

@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
-    <title>Code coverage report for api/controllers/permission.js</title>
+    <title>Code coverage report for src/api/controllers/permission.ts</title>
     <meta charset="utf-8" />
-    <link rel="stylesheet" href="../../prettify.css" />
-    <link rel="stylesheet" href="../../base.css" />
-    <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
+    <link rel="stylesheet" href="../../../prettify.css" />
+    <link rel="stylesheet" href="../../../base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="../../../favicon.png" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <style type='text/css'>
         .coverage-summary .sorter {
-            background-image: url(../../sort-arrow-sprite.png);
+            background-image: url(../../../sort-arrow-sprite.png);
         }
     </style>
 </head>
@@ -19,20 +19,20 @@
 <body>
 <div class='wrapper'>
     <div class='pad1'>
-        <h1><a href="../../index.html">All files</a> / <a href="index.html">api/controllers</a> permission.js</h1>
+        <h1><a href="../../../index.html">All files</a> / <a href="index.html">src/api/controllers</a> permission.ts</h1>
         <div class='clearfix'>
             <div class='fl pad1y space-right2'>
-                <span class="strong">98.78% </span>
+                <span class="strong">97.56% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>81/82</span>
+                <span class='fraction'>80/82</span>
             </div>
             <div class='fl pad1y space-right2'>
-                <span class="strong">90.62% </span>
+                <span class="strong">80.76% </span>
                 <span class="quiet">Branches</span>
-                <span class='fraction'>29/32</span>
+                <span class='fraction'>21/26</span>
             </div>
@@ -44,9 +44,9 @@
             <div class='fl pad1y space-right2'>
-                <span class="strong">98.71% </span>
+                <span class="strong">97.43% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>77/78</span>
+                <span class='fraction'>76/78</span>
             </div>
@@ -238,28 +238,29 @@
 <a name='L173'></a><a href='#L173'>173</a>
 <a name='L174'></a><a href='#L174'>174</a>
 <a name='L175'></a><a href='#L175'>175</a>
-<a name='L176'></a><a href='#L176'>176</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">44x</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L176'></a><a href='#L176'>176</a>
+<a name='L177'></a><a href='#L177'>177</a>
+<a name='L178'></a><a href='#L178'>178</a>
+<a name='L179'></a><a href='#L179'>179</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">44x</span>
+<span class="cline-any cline-yes">44x</span>
+<span class="cline-any cline-yes">44x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">44x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">44x</span>
-<span class="cline-any cline-yes">44x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">44x</span>
-<span class="cline-any cline-yes">44x</span>
-<span class="cline-any cline-yes">44x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">44x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">12x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">44x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -268,7 +269,6 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">12x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -357,6 +357,9 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-yes">2x</span>
@@ -386,6 +389,9 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">9x</span>
 <span class="cline-any cline-yes">12x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">12x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -413,21 +419,14 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">const { getBuiltinPermissions } = require("@budibase/backend-core/permissions")
-const {
-  isBuiltin,
-  getDBRoleID,
-  getExternalRoleID,
-  getBuiltinRoles,
-  checkForRoleResourceArray,
-} = require("@budibase/backend-core/roles")
-const { getRoleParams } = require("../../db/utils")
-const {
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { permissions, roles, context } from "@budibase/backend-core"
+import { getRoleParams } from "../../db/utils"
+import {
   CURRENTLY_SUPPORTED_LEVELS,
   getBasePermissions,
-} = require("../../utilities/security")
-const { removeFromArray } = require("../../utilities")
-const { getAppDB } = require("@budibase/backend-core/context")
+} from "../../utilities/security"
+import { removeFromArray } from "../../utilities"
+import { BBContext, Database, Role } from "@budibase/types"
 &nbsp;
 const PermissionUpdateType = {
   REMOVE: "remove",
@@ -437,7 +436,7 @@ const PermissionUpdateType = {
 const SUPPORTED_LEVELS = CURRENTLY_SUPPORTED_LEVELS
 &nbsp;
 // utility function to stop this repetition - permissions always stored under roles
-async function getAllDBRoles(db) {
+async function getAllDBRoles(db: Database) {
   const body = await db.allDocs(
     getRoleParams(null, {
       include_docs: true,
@@ -447,21 +446,25 @@ async function getAllDBRoles(db) {
 }
 &nbsp;
 async function updatePermissionOnRole(
-  appId,
-  { roleId, resourceId, level },
-  updateType
+  appId: string,
+  {
+    roleId,
+    resourceId,
+    level,
+  }: { roleId: string; resourceId: string; level: string },
+  updateType: string
 ) {
-  const db = getAppDB()
+  const db = context.getAppDB()
   const remove = updateType === PermissionUpdateType.REMOVE
-  const isABuiltin = isBuiltin(roleId)
-  const dbRoleId = getDBRoleID(roleId)
+  const isABuiltin = roles.isBuiltin(roleId)
+  const dbRoleId = roles.getDBRoleID(roleId)
   const dbRoles = await getAllDBRoles(db)
   const docUpdates = []
 &nbsp;
   // the permission is for a built in, make sure it exists
   if (isABuiltin &amp;&amp; !dbRoles.some(role =&gt; role._id === dbRoleId)) {
-    const builtin = getBuiltinRoles()[roleId]
-    builtin._id = getDBRoleID(builtin._id)
+    const builtin = roles.getBuiltinRoles()[roleId]
+    builtin._id = roles.getDBRoleID(builtin._id)
     dbRoles.push(builtin)
   }
 &nbsp;
@@ -469,7 +472,7 @@ async function updatePermissionOnRole(
   // resource from another role and then adding to the new role
   for (let role of dbRoles) {
     let updated = false
-    const rolePermissions = role.permissions ? role.permissions : {}
+    const rolePermissions = role.permissions ? role.permissions : <span class="branch-1 cbranch-no" title="branch not covered" >{}</span>
     // make sure its an array, also handle migrating
     if (
       !rolePermissions[resourceId] ||
@@ -505,41 +508,44 @@ async function updatePermissionOnRole(
   }
 &nbsp;
   const response = await db.bulkDocs(docUpdates)
-  return response.map(resp =&gt; {
-    resp._id = getExternalRoleID(resp.id)
+  return response.map((resp: any) =&gt; {
+    resp._id = roles.getExternalRoleID(resp.id)
     delete resp.id
     return resp
   })
 }
 &nbsp;
-exports.fetchBuiltin = function (ctx) {
-  ctx.body = Object.values(getBuiltinPermissions())
+export function fetchBuiltin(ctx: BBContext) {
+  ctx.body = Object.values(permissions.getBuiltinPermissions())
 }
 &nbsp;
-exports.fetchLevels = function (ctx) {
+export function fetchLevels(ctx: BBContext) {
   // for now only provide the read/write perms externally
   ctx.body = SUPPORTED_LEVELS
 }
 &nbsp;
-exports.fetch = async function (ctx) {
-  const db = getAppDB()
-  const roles = await getAllDBRoles(db)
-  let permissions = {}
+export async function fetch(ctx: BBContext) {
+  const db = context.getAppDB()
+  const dbRoles: Role[] = await getAllDBRoles(db)
+  let permissions: any = {}
   // create an object with structure role ID -&gt; resource ID -&gt; level
-  for (let role of roles) {
+  for (let role of dbRoles) {
     <span class="missing-if-branch" title="if path not taken" >I</span>if (!role.permissions) {
 <span class="cstat-no" title="statement not covered" >      continue</span>
     }
-    const roleId = getExternalRoleID(role._id)
+    const roleId = roles.getExternalRoleID(role._id)
+    <span class="missing-if-branch" title="if path not taken" >I</span>if (!roleId) {
+<span class="cstat-no" title="statement not covered" >      ctx.throw(400, "Unable to retrieve role")</span>
+    }
     for (let [resource, levelArr] of Object.entries(role.permissions)) {
-      const levels = Array.isArray(levelArr) ? [levelArr] : <span class="branch-1 cbranch-no" title="branch not covered" >levelArr</span>
-      const perms = {}
-      levels.forEach(level =&gt; (perms[level] = roleId))
+      const levels: string[] = Array.isArray(levelArr) ? levelArr : <span class="branch-1 cbranch-no" title="branch not covered" >[levelArr]</span>
+      const perms: Record&lt;string, string&gt; = {}
+      levels.forEach(level =&gt; (perms[level] = roleId!))
       permissions[resource] = perms
     }
   }
   // apply the base permissions
-  const finalPermissions = {}
+  const finalPermissions: Record&lt;string, Record&lt;string, string&gt;&gt; = {}
   for (let [resource, permission] of Object.entries(permissions)) {
     const basePerms = getBasePermissions(resource)
     finalPermissions[resource] = Object.assign(basePerms, permission)
@@ -547,33 +553,36 @@ exports.fetch = async function (ctx) {
   ctx.body = finalPermissions
 }
 &nbsp;
-exports.getResourcePerms = async function (ctx) {
+export async function getResourcePerms(ctx: BBContext) {
   const resourceId = ctx.params.resourceId
-  const db = getAppDB()
+  const db = context.getAppDB()
   const body = await db.allDocs(
     getRoleParams(null, {
       include_docs: true,
     })
   )
-  const roles = body.rows.map(row =&gt; row.doc)
-  let permissions = {}
+  const rolesList = body.rows.map(row =&gt; row.doc)
+  let permissions: Record&lt;string, string&gt; = {}
   for (let level of SUPPORTED_LEVELS) {
     // update the various roleIds in the resource permissions
-    for (let role of roles) {
-      const rolePerms = checkForRoleResourceArray(role.permissions, resourceId)
+    for (let role of rolesList) {
+      const rolePerms = roles.checkForRoleResourceArray(
+        role.permissions,
+        resourceId
+      )
       if (
         rolePerms &amp;&amp;
         rolePerms[resourceId] &amp;&amp;
         rolePerms[resourceId].indexOf(level) !== -1
       ) {
-        permissions[level] = getExternalRoleID(role._id)
+        permissions[level] = roles.getExternalRoleID(role._id)!
       }
     }
   }
   ctx.body = Object.assign(getBasePermissions(resourceId), permissions)
 }
 &nbsp;
-exports.addPermission = async function (ctx) {
+export async function addPermission(ctx: BBContext) {
   ctx.body = await updatePermissionOnRole(
     ctx.appId,
     ctx.params,
@@ -581,7 +590,7 @@ exports.addPermission = async function (ctx) {
   )
 }
 &nbsp;
-exports.removePermission = async function (ctx) {
+export async function removePermission(ctx: BBContext) {
   ctx.body = await updatePermissionOnRole(
     ctx.appId,
     ctx.params,
@@ -595,16 +604,16 @@ exports.removePermission = async function (ctx) {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at Mon Nov 28 2022 09:35:14 GMT+0000 (Coordinated Universal Time)
+                at Tue Nov 29 2022 11:32:32 GMT+0000 (Coordinated Universal Time)
             </div>
-        <script src="../../prettify.js"></script>
+        <script src="../../../prettify.js"></script>
         <script>
             window.onload = function () {
                 prettyPrint();
             };
         </script>
-        <script src="../../sorter.js"></script>
-        <script src="../../block-navigation.js"></script>
+        <script src="../../../sorter.js"></script>
+        <script src="../../../block-navigation.js"></script>
     </body>
 </html>

package/coverage/lcov-report/src/api/controllers/plugin/file.ts.html ADDED Viewed

@@ -0,0 +1,130 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <title>Code coverage report for src/api/controllers/plugin/file.ts</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="../../../../prettify.css" />
+    <link rel="stylesheet" href="../../../../base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="../../../../favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(../../../../sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1><a href="../../../../index.html">All files</a> / <a href="index.html">src/api/controllers/plugin</a> file.ts</h1>
+        <div class='clearfix'>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">28.57% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>2/7</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">0% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>0/1</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">0% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>0/1</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">28.57% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>2/7</span>
+            </div>
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input oninput="onInput()" type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line low'></div>
+    <pre><table class="coverage">
+<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
+<a name='L2'></a><a href='#L2'>2</a>
+<a name='L3'></a><a href='#L3'>3</a>
+<a name='L4'></a><a href='#L4'>4</a>
+<a name='L5'></a><a href='#L5'>5</a>
+<a name='L6'></a><a href='#L6'>6</a>
+<a name='L7'></a><a href='#L7'>7</a>
+<a name='L8'></a><a href='#L8'>8</a>
+<a name='L9'></a><a href='#L9'>9</a>
+<a name='L10'></a><a href='#L10'>10</a>
+<a name='L11'></a><a href='#L11'>11</a>
+<a name='L12'></a><a href='#L12'>12</a>
+<a name='L13'></a><a href='#L13'>13</a>
+<a name='L14'></a><a href='#L14'>14</a>
+<a name='L15'></a><a href='#L15'>15</a>
+<a name='L16'></a><a href='#L16'>16</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">46x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">46x</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import {
+  createTempFolder,
+  getPluginMetadata,
+  extractTarball,
+} from "../../../utilities/fileSystem"
+&nbsp;
+export async function <span class="fstat-no" title="function not covered" >fileUpload(</span>file: { name: string; path: string }) {
+<span class="cstat-no" title="statement not covered" >  <span class="missing-if-branch" title="if path not taken" >I</span>if (!file.name.endsWith(".tar.gz")) {</span>
+<span class="cstat-no" title="statement not covered" >    throw new Error("Plugin must be compressed into a gzipped tarball.")</span>
+  }
+  const path = <span class="cstat-no" title="statement not covered" >createTempFolder(file.name.split(".tar.gz")[0])</span>
+<span class="cstat-no" title="statement not covered" >  await extractTarball(file.path, path)</span>
+&nbsp;
+<span class="cstat-no" title="statement not covered" >  return await getPluginMetadata(path)</span>
+}
+&nbsp;</pre></td></tr></table></pre>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <div class='footer quiet pad2 space-top1 center small'>
+                Code coverage generated by
+                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
+                at Tue Nov 29 2022 11:32:32 GMT+0000 (Coordinated Universal Time)
+            </div>
+        <script src="../../../../prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="../../../../sorter.js"></script>
+        <script src="../../../../block-navigation.js"></script>
+    </body>
+</html>