@budibase/server 1.3.15-alpha.1 → 1.3.15-alpha.2

package/dist/websocket.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientAppSocket = exports.initialise = void 0;
+const socket_io_1 = require("socket.io");
+class Websocket {
+    constructor(server, path) {
+        this.socketServer = new socket_io_1.Server(server, {
+            path,
+        });
+    }
+    // Emit an event to all sockets
+    emit(event, payload) {
+        this.socketServer.sockets.emit(event, payload);
+    }
+}
+// Likely to be more socket instances in future
+let ClientAppSocket;
+exports.ClientAppSocket = ClientAppSocket;
+const initialise = (server) => {
+    exports.ClientAppSocket = ClientAppSocket = new Websocket(server, "/socket/client");
+};
+exports.initialise = initialise;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "1.3.15-alpha.1",
+  "version": "1.3.15-alpha.2",
   "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.3.15-alpha.1",
-    "@budibase/client": "1.3.15-alpha.1",
-    "@budibase/pro": "1.3.15-alpha.0",
-    "@budibase/string-templates": "1.3.15-alpha.1",
-    "@budibase/types": "1.3.15-alpha.1",
+    "@budibase/backend-core": "1.3.15-alpha.2",
+    "@budibase/client": "1.3.15-alpha.2",
+    "@budibase/pro": "1.3.15-alpha.1",
+    "@budibase/string-templates": "1.3.15-alpha.2",
+    "@budibase/types": "1.3.15-alpha.2",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -139,6 +139,7 @@
     "redis": "4",
     "server-destroy": "1.0.1",
     "snowflake-promise": "^4.5.0",
+    "socket.io": "^4.5.1",
     "svelte": "3.49.0",
     "swagger-parser": "10.0.3",
     "tar": "6.1.11",
@@ -198,5 +199,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "a92a8ed882cde62db5903d495112e202173defc7"
+  "gitHead": "223362f2e2ec572aaed18507ebfeceefdc9efaf6"
 }

package/src/api/controllers/plugin/index.ts

@@ -10,6 +10,7 @@ import {
 } from "@budibase/backend-core/objectStore"
 import { PluginType, FileType, PluginSource } from "@budibase/types"
 import env from "../../../environment"
+import { ClientAppSocket } from "../../../websocket"
 
 export async function getPlugins(type?: PluginType) {
   const db = getGlobalDB()
@@ -132,7 +133,8 @@ export async function storePlugin(
   const db = getGlobalDB()
   const version = metadata.package.version,
     name = metadata.package.name,
-    description = metadata.package.description
+    description = metadata.package.description,
+    hash = metadata.schema.hash
 
   // first open the tarball into tmp directory
   const bucketPath = `${name}/`
@@ -174,6 +176,7 @@ export async function storePlugin(
     ...metadata,
     name,
     version,
+    hash,
     description,
     jsUrl: `${bucketPath}${jsFileName}`,
   }
@@ -186,6 +189,7 @@ export async function storePlugin(
   }
 
   const response = await db.put(doc)
+  ClientAppSocket.emit("plugin-update", { name, hash })
   return {
     ...doc,
     _rev: response.rev,

package/src/api/controllers/screen.js

@@ -71,6 +71,7 @@ exports.save = async ctx => {
           name: plugin.name,
           version: plugin.version,
           jsUrl: plugin.jsUrl,
+          hash: plugin.hash,
         })
       }
     })

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

@@ -67,7 +67,8 @@
         previewDevice,
         navigation,
         hiddenComponentIds,
-        usedPlugins
+        usedPlugins,
+        location
       } = parsed
 
       // Set some flags so the app knows we're in the builder
@@ -83,6 +84,7 @@
       window["##BUDIBASE_PREVIEW_NAVIGATION##"] = navigation
       window["##BUDIBASE_HIDDEN_COMPONENT_IDS##"] = hiddenComponentIds
       window["##BUDIBASE_USED_PLUGINS##"] = usedPlugins
+      window["##BUDIBASE_LOCATION##"] = location
 
       // Initialise app
       try {

package/src/app.ts

@@ -32,6 +32,7 @@ import * as migrations from "./migrations"
 import { events, installation, tenancy } from "@budibase/backend-core"
 import { createAdminUser, getChecklist } from "./utilities/workerRequests"
 import { watch } from "./watch"
+import { initialise as initialiseWebsockets } from "./websocket"
 
 const app = new Koa()
 
@@ -76,6 +77,7 @@ if (env.isProd()) {
 
 const server = http.createServer(app.callback())
 destroyable(server)
+initialiseWebsockets(server)
 
 let shuttingDown = false,
   errCode = 0

package/src/websocket.ts

@@ -0,0 +1,26 @@
+import { Server } from "socket.io"
+import http from "http"
+
+class Websocket {
+  socketServer: Server
+
+  constructor(server: http.Server, path: string) {
+    this.socketServer = new Server(server, {
+      path,
+    })
+  }
+
+  // Emit an event to all sockets
+  emit(event: string, payload: any) {
+    this.socketServer.sockets.emit(event, payload)
+  }
+}
+
+// Likely to be more socket instances in future
+let ClientAppSocket: Websocket
+
+export const initialise = (server: http.Server) => {
+  ClientAppSocket = new Websocket(server, "/socket/client")
+}
+
+export { ClientAppSocket }