npm - @budibase/server - Versions diffs - 1.2.44-alpha.0 → 1.2.44-alpha.3 - Mend

@budibase/server 1.2.44-alpha.0 → 1.2.44-alpha.3

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 (165) hide show

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "1.2.44-alpha.0",
+  "version": "1.2.44-alpha.3",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -77,11 +77,11 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@budibase/backend-core": "1.2.44-alpha.0",
-    "@budibase/client": "1.2.44-alpha.0",
-    "@budibase/pro": "1.2.43",
-    "@budibase/string-templates": "1.2.44-alpha.0",
-    "@budibase/types": "1.2.44-alpha.0",
+    "@budibase/backend-core": "1.2.44-alpha.3",
+    "@budibase/client": "1.2.44-alpha.3",
+    "@budibase/pro": "1.2.44-alpha.2",
+    "@budibase/string-templates": "1.2.44-alpha.3",
+    "@budibase/types": "1.2.44-alpha.3",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -195,5 +195,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "a9aebf552f8f7e69aa0afa1d88c6f090a609f470"
+  "gitHead": "739d9af7cb0976a7a928abe94b722f436b6ede6e"
 }

package/src/api/controllers/static/index.ts CHANGED Viewed

@@ -128,6 +128,22 @@ export const serveApp = async function (ctx: any) {
   }
 }
+export const serveBuilderPreview = async function (ctx: any) {
+  const db = getAppDB({ skip_setup: true })
+  const appInfo = await db.get(DocumentType.APP_METADATA)
+  if (!env.isJest()) {
+    let appId = getAppId()
+    const previewHbs = loadHandlebarsFile(`${__dirname}/templates/preview.hbs`)
+    ctx.body = await processString(previewHbs, {
+      clientLibPath: clientLibraryPath(appId, appInfo.version, ctx),
+    })
+  } else {
+    // just return the app info for jest to assert on
+    ctx.body = { ...appInfo, builderPreview: true }
+  }
+}
 export const serveClientLibrary = async function (ctx: any) {
   return send(ctx, "budibase-client.js", {
     root: join(NODE_MODULES_PATH, "@budibase", "client", "dist"),

package/src/api/controllers/static/templates/preview.hbs ADDED Viewed

@@ -0,0 +1,103 @@
+<html lang="en">
+<head>
+  <title>Budibase Builder Preview</title>
+  <link rel="stylesheet" href="https://rsms.me/inter/inter.css" />
+  <link rel="preconnect" href="https://fonts.gstatic.com" />
+  <link
+    href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap"
+    rel="stylesheet"
+  />
+  <link
+    href="https://cdn.jsdelivr.net/npm/remixicon@2.5.0/fonts/remixicon.css"
+    rel="stylesheet"
+  />
+  <style>
+    html, body {
+      padding: 0;
+      margin: 0;
+    }
+    html {
+      height: 100%;
+      width: 100%;
+      overflow: hidden;
+      display: flex;
+      flex-direction: column;
+      justify-content: flex-start;
+      align-items: stretch;
+    }
+    body {
+      flex: 1 1 auto;
+      overflow: hidden;
+    }
+    *,
+    *:before,
+    *:after {
+      box-sizing: border-box;
+    }
+  </style>
+  <script src='{{ clientLibPath }}'></script>
+  <script>
+    function receiveMessage(event) {
+      if (!event.data) {
+        return
+      }
+      // Parse received message
+      // If parsing fails, just ignore and wait for the next message
+      let parsed
+      try {
+        parsed = JSON.parse(event.data)
+      } catch (error) {
+        console.error("Client received invalid JSON")
+        // Ignore
+      }
+      if (!parsed || !parsed.isBudibaseEvent) {
+        return
+      }
+      // Extract data from message
+      const {
+        selectedComponentId,
+        layout,
+        screen,
+        appId,
+        theme,
+        customTheme,
+        previewDevice,
+        navigation,
+        hiddenComponentIds
+      } = parsed
+      // Set some flags so the app knows we're in the builder
+      window["##BUDIBASE_IN_BUILDER##"] = true
+      window["##BUDIBASE_APP_ID##"] = appId
+      window["##BUDIBASE_PREVIEW_LAYOUT##"] = layout
+      window["##BUDIBASE_PREVIEW_SCREEN##"] = screen
+      window["##BUDIBASE_SELECTED_COMPONENT_ID##"] = selectedComponentId
+      window["##BUDIBASE_PREVIEW_ID##"] = Math.random()
+      window["##BUDIBASE_PREVIEW_THEME##"] = theme
+      window["##BUDIBASE_PREVIEW_CUSTOM_THEME##"] = customTheme
+      window["##BUDIBASE_PREVIEW_DEVICE##"] = previewDevice
+      window["##BUDIBASE_PREVIEW_NAVIGATION##"] = navigation
+      window["##BUDIBASE_HIDDEN_COMPONENT_IDS##"] = hiddenComponentIds
+      // Initialise app
+      try {
+        if (window.loadBudibase) {
+          window.loadBudibase()
+          document.documentElement.classList.add("loaded")
+        } else {
+          throw "The client library couldn't be loaded"
+        }
+      } catch (error) {
+        window.parent.postMessage({ type: "error", error })
+      }
+    }
+    window.addEventListener("message", receiveMessage)
+    window.parent.postMessage({ type: "ready" })
+  </script>
+</head>
+<body></body>
+</html>

package/src/api/routes/static.ts CHANGED Viewed

@@ -56,6 +56,7 @@ router
     authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     controller.deleteObjects
   )
+  .get("/preview", authorized(BUILDER), controller.serveBuilderPreview)
   .get("/:appId/:path*", controller.serveApp)
   .get("/app/:appUrl/:path*", controller.serveApp)
   .post(

package/src/api/routes/tests/static.spec.js CHANGED Viewed

@@ -40,7 +40,6 @@ describe("/static", () => {
   })
   describe("/app", () => {
     beforeEach(() => {
       jest.clearAllMocks()
     })
@@ -60,7 +59,7 @@ describe("/static", () => {
     it("should serve the app by url", async () => {
       const headers = config.defaultHeaders()
       delete headers[constants.Headers.APP_ID]
       const res = await request
         .get(`/app${config.prodApp.url}`)
         .set(headers)
@@ -82,7 +81,7 @@ describe("/static", () => {
   describe("/attachments", () => {
     describe("generateSignedUrls", () => {
       let datasource
       beforeEach(async () => {
         datasource = await config.createDatasource({
           datasource: {
@@ -93,7 +92,7 @@ describe("/static", () => {
           },
         })
       })
       it("should be able to generate a signed upload URL", async () => {
         const bucket = "foo"
         const key = "bar"
@@ -108,7 +107,7 @@ describe("/static", () => {
           `https://${bucket}.s3.eu-west-1.amazonaws.com/${key}`
         )
       })
       it("should handle an invalid datasource ID", async () => {
         const res = await request
           .post(`/api/attachments/foo/url`)
@@ -123,7 +122,7 @@ describe("/static", () => {
           "The specified datasource could not be found"
         )
       })
       it("should require a bucket parameter", async () => {
         const res = await request
           .post(`/api/attachments/${datasource._id}/url`)
@@ -136,7 +135,7 @@ describe("/static", () => {
           .expect(400)
         expect(res.body.message).toEqual("bucket and key values are required")
       })
       it("should require a key parameter", async () => {
         const res = await request
           .post(`/api/attachments/${datasource._id}/url`)
@@ -151,4 +150,17 @@ describe("/static", () => {
     })
   })
+  describe("/preview", () => {
+    beforeEach(() => {
+      jest.clearAllMocks()
+    })
+    it("should serve the builder preview", async () => {
+      const headers = config.defaultHeaders()
+      const res = await request.get(`/preview`).set(headers).expect(200)
+      expect(res.body.appId).toBe(config.appId)
+      expect(res.body.builderPreview).toBe(true)
+    })
+  })
 })