@silexlabs/silex 3.7.0 → 3.9.0-canary.2

package/{src/ts/server → server}/config.ts

@@ -24,16 +24,16 @@
  * @class default config for Silex server
  */
 
-import { Config, Plugin } from '@silexlabs/silex-plugins'
+import { Config, Plugin } from '~/common/silex-plugins/index.js'
 import { join, resolve } from 'path'
-import { CLIENT_CONFIG_FILE_NAME } from '../constants'
+import { CLIENT_CONFIG_FILE_NAME } from '~/common/constants.js'
 import { Application, Request, Response, Router } from 'express'
 import { readFile } from 'fs/promises'
-import { HostingConnector, StorageConnector, toConnectorEnum } from './connectors/connectors'
-import { FsStorage } from './connectors/FsStorage'
-import { Connector } from './connectors/connectors'
-import { ConnectorType } from '../types'
-import { FsHosting } from './connectors/FsHosting'
+import { HostingConnector, StorageConnector, toConnectorEnum } from './connectors/connectors.js'
+import { FsStorage } from './connectors/FsStorage.js'
+import { Connector } from './connectors/connectors.js'
+import { ConnectorType } from '~/common/types.js'
+import { FsHosting } from './connectors/FsHosting.js'
 
 /**
  * Config types definitions
@@ -51,7 +51,7 @@ export class ServerConfig extends Config {
   public debug = process.env.SILEX_DEBUG === 'true'
   public url = process.env.SILEX_URL?.replace(/\/$/, '') ?? `${process.env.SILEX_PROTOCOL}://${process.env.SILEX_HOST}:${process.env.SILEX_PORT}`
   public userConfigPath: Plugin | undefined = process.env.SILEX_SERVER_CONFIG
-  public configFilePath: Plugin = resolve(__dirname, '../../../.silex.js')
+  public configFilePath: Plugin = resolve(__dirname, '../../../server/deploy/.silex.js')
 
   // All connectors or just the storage or hosting connectors
   getConnectors(type: ConnectorType | string | null = null): Connector[] {
@@ -101,7 +101,9 @@ export class ServerConfig extends Config {
    * Add routes to serve the client config file
    */
   async addRoutes(app: Application) {
-    const path = process.env.SILEX_CLIENT_CONFIG
+    // Default to the SaaS client config (onboarding plugin), so `pnpm start` matches
+    // the deployed SaaS without extra env. Override with SILEX_CLIENT_CONFIG.
+    const path = process.env.SILEX_CLIENT_CONFIG || resolve(__dirname, '../../../server/deploy/client-config.js')
     if (path) {
       console.info(`> Serving client side config ${path} at ${CLIENT_CONFIG_FILE_NAME}`)
       try {
@@ -121,7 +123,7 @@ export class ServerConfig extends Config {
         })
       } catch (e) {
         console.error(`Error loading client config file ${path}`, e)
-        throw new Error(`Error loading client config file ${path}: ${e.message}`)
+        throw new Error(`Error loading client config file ${path}: ${e.message}`, { cause: e })
       }
     }
   }
@@ -148,7 +150,7 @@ export class ServerConfig extends Config {
         // Initiate the process with the config file which is just another plugin
         await this.addPlugin(this.userConfigPath, {})
       } catch (e) {
-        throw new Error(`\nUser config file ${this.userConfigPath} error:\n\n\t${e.message}\n\n`)
+        throw new Error(`\nUser config file ${this.userConfigPath} error:\n\n\t${e.message}\n\n`, { cause: e })
       }
     }
   }
@@ -167,7 +169,7 @@ export class ServerConfig extends Config {
       if(e.code === 'MODULE_NOT_FOUND' && (!e.requireStack || !e.requireStack.find(path => path === this.configFilePath))) {
         console.info('> /!\\ Config file not found', this.configFilePath)
       } else {
-        throw new Error(`Error in config file ${this.configFilePath}: ${e.message}`)
+        throw new Error(`Error in config file ${this.configFilePath}: ${e.message}`, { cause: e })
       }
     }
   }

package/{src/ts/server → server}/connectors/FsHosting.ts

@@ -16,11 +16,11 @@
  */
 
 import fs from 'fs/promises'
-import { ConnectorFile, StorageConnector, HostingConnector, StatusCallback, ConnectorSession, contentToString, toConnectorData, ConnectorFileContent} from './connectors'
+import { ConnectorFile, StorageConnector, HostingConnector, StatusCallback, ConnectorSession, contentToString, toConnectorData, ConnectorFileContent} from './connectors.js'
 import { join } from 'path'
-import { FsStorage } from './FsStorage'
-import { ConnectorType, JobData, JobStatus, PublicationJobData, WebsiteId } from '../../types'
-import { JobManager } from '../jobs'
+import { FsStorage } from './FsStorage.js'
+import { ConnectorType, JobData, JobStatus, PublicationJobData, WebsiteId } from '~/common/types.js'
+import { JobManager } from '../jobs.js'
 
 type FsSession = ConnectorSession
 

package/{src/ts/server → server}/connectors/FsStorage.test.ts

@@ -3,8 +3,8 @@ import { ServerConfig } from '../config'
 import { FsStorage } from './FsStorage'
 import { readFileSync, rmdirSync, statSync } from 'fs'
 import { join } from 'path'
-import { WEBSITE_DATA_FILE } from '../../constants'
-import { EMPTY_WEBSITE } from '../../types'
+import { WEBSITE_DATA_FILE } from '~/common/constants'
+import { EMPTY_WEBSITE } from '~/common/types'
 
 const storageRootPath = '/tmp/silex-tests'
 const assetsFolder = 'assets'

package/{src/ts/server → server}/connectors/FsStorage.ts

@@ -17,22 +17,22 @@
 
 import fs from 'fs/promises'
 import { createWriteStream } from 'fs'
-import { ConnectorFile, StorageConnector, StatusCallback, ConnectorSession, toConnectorData, ConnectorFileContent} from './connectors'
+import { ConnectorFile, StorageConnector, StatusCallback, ConnectorSession, toConnectorData, ConnectorFileContent} from './connectors.js'
 import { dirname, join } from 'path'
-import { ConnectorUser, WebsiteMeta, JobStatus, WebsiteId, ConnectorType, WebsiteMetaFileContent, WebsiteData, EMPTY_WEBSITE, ConnectorOptions } from '../../types'
+import { ConnectorUser, WebsiteMeta, JobStatus, WebsiteId, ConnectorType, WebsiteMetaFileContent, WebsiteData, EMPTY_WEBSITE, ConnectorOptions } from '~/common/types.js'
 import { userInfo } from 'os'
-import { requiredParam } from '../utils/validation'
-import { ServerConfig } from '../config'
-import { DEFAULT_WEBSITE_ID, WEBSITE_DATA_FILE, WEBSITE_META_DATA_FILE, LEGACY_WEBSITE_PAGES_FOLDER } from '../../constants'
+import { requiredParam } from '../utils/validation.js'
+import { ServerConfig } from '../config.js'
+import { DEFAULT_WEBSITE_ID, WEBSITE_DATA_FILE, WEBSITE_META_DATA_FILE, LEGACY_WEBSITE_PAGES_FOLDER } from '~/common/constants.js'
 import { Readable } from 'stream'
 import { v4 as uuid } from 'uuid'
 import { fileURLToPath } from 'url'
-import { stringify, split, merge, getPagesFolder } from '../utils/websiteDataSerialization'
+import { stringify, split, merge, getPagesFolder } from '../utils/websiteDataSerialization.js'
 
 // Variables needed for jest tests
 if(!globalThis.__dirname) {
   // @ts-ignore
-  globalThis.__dirname = dirname(process.cwd() + '/src/ts/server/connectors/FsStorage.ts')
+  globalThis.__dirname = dirname(process.cwd() + '/server/connectors/FsStorage.ts')
   console.info('Redefining __dirname', globalThis.__dirname)
 }
 
@@ -249,7 +249,7 @@ export class FsStorage implements StorageConnector<FsSession> {
   async deleteWebsite(session: FsSession, websiteId: WebsiteId): Promise<void> {
     const id = requiredParam<WebsiteId>(websiteId, 'website id')
     const path = join(this.options.path, id)
-    return fs.rmdir(path, { recursive: true })
+    return fs.rm(path, { recursive: true, force: true })
   }
 
   async duplicateWebsite(session: FsSession, websiteId: WebsiteId): Promise<void> {

package/{src/ts/server → server}/connectors/connectors.ts

@@ -16,9 +16,9 @@
  */
 
 import { Readable } from 'stream'
-import { ServerConfig } from '../config'
-import { JobStatus, JobData, ConnectorData, ConnectorId, WebsiteId, ConnectorType, ConnectorUser, WebsiteMeta, WebsiteMetaFileContent, WebsiteData, ConnectorOptions } from '../../types'
-import { JobManager } from '../jobs'
+import { ServerConfig } from '../config.js'
+import { JobStatus, JobData, ConnectorData, ConnectorId, WebsiteId, ConnectorType, ConnectorUser, WebsiteMeta, WebsiteMetaFileContent, WebsiteData, ConnectorOptions } from '~/common/types.js'
+import { JobManager } from '../jobs.js'
 
 /**
  * @fileoverview define types for Silex connectors

package/server/deploy/.nvmrc

@@ -0,0 +1 @@
+20

package/server/deploy/.silex.js

@@ -0,0 +1,220 @@
+/*
+ * Silex website builder, free/libre no-code tool for makers.
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @fileoverview Default Silex server config = the full SaaS (the v3.silex.me / canary setup).
+ * Serves the editor (StaticPlugin), the multi-site dashboard, the onboarding email backend,
+ * and the storage/hosting connectors selected by env vars. Loaded by default at startup
+ * (see server/config.ts: configFilePath). Runtime paths target the monorepo dist.
+ */
+const { join } = require('path')
+const nodeModules = require('node_modules-path')
+
+const SslPlugin = require('../../dist/server/server/plugins/SslPlugin').default
+const StaticPlugin = require('../../dist/server/server/plugins/StaticPlugin').default
+const { ConnectorType } = require('../../dist/server/common/types')
+const FtpConnector = require('../../dist/server/server/plugins/FtpConnector').default
+const DownloadConnector = require('../../dist/server/server/plugins/DownloadConnector').default
+const GitlabConnector = require('../../dist/server/server/plugins/GitlabConnector').default
+const GitlabHostingConnector = require('../../dist/server/server/plugins/GitlabHostingConnector').default
+const { FsStorage } = require('../../dist/server/server/connectors/FsStorage')
+const { FsHosting } = require('../../dist/server/server/connectors/FsHosting')
+const dashboard = require('./server-plugins/dashboard.js')
+const onboarding = require('./server-plugins/onboarding.js')
+
+// Load .env file
+require('dotenv').config()
+
+const env = {
+  STORAGE_CONNECTORS: process.env.STORAGE_CONNECTORS || 'ftp',
+  HOSTING_CONNECTORS: process.env.HOSTING_CONNECTORS || 'ftp,download',
+  SILEX_FS_ROOT: process.env.SILEX_FS_ROOT || join(process.cwd(), '/silex/storage'),
+  SILEX_FS_HOSTING_ROOT: process.env.SILEX_FS_HOSTING_ROOT || join(process.cwd(), '/silex/hosting'),
+  GITLAB_DISPLAY_NAME: process.env.GITLAB_DISPLAY_NAME || 'Gitlab',
+  GITLAB_CLIENT_ID: process.env.GITLAB_CLIENT_ID,
+  GITLAB_CLIENT_SECRET: process.env.GITLAB_CLIENT_SECRET,
+  GITLAB_DOMAIN: process.env.GITLAB_DOMAIN,
+  GITLAB2_DISPLAY_NAME: process.env.GITLAB2_DISPLAY_NAME || 'Gitlab',
+  GITLAB2_CLIENT_ID: process.env.GITLAB2_CLIENT_ID,
+  GITLAB2_CLIENT_SECRET: process.env.GITLAB2_CLIENT_SECRET,
+  GITLAB2_DOMAIN: process.env.GITLAB2_DOMAIN,
+  FTP_STORAGE_PATH: process.env.FTP_STORAGE_PATH || '',
+  FTP_HOSTING_PATH: process.env.FTP_HOSTING_PATH || '',
+}
+
+// Create alternate versions of the the Gitlab connector
+class GitlabConnector1 extends GitlabConnector {
+  displayName = env.GITLAB_DISPLAY_NAME
+  constructor(config, options) {
+    super(config, options)
+  }
+}
+
+class GitlabConnector2 extends GitlabConnector {
+  connectorId = 'gitlab2'
+  displayName = env.GITLAB2_DISPLAY_NAME
+  constructor(config, options) {
+    super(config, options)
+  }
+}
+
+class GitlabHostingConnector1 extends GitlabHostingConnector {
+  displayName = env.GITLAB_DISPLAY_NAME
+  constructor(config, options) {
+    super(config, options)
+  }
+}
+
+class GitlabHostingConnector2 extends GitlabHostingConnector {
+  connectorId = 'gitlab2'
+  displayName = env.GITLAB2_DISPLAY_NAME
+  constructor(config, options) {
+    super(config, options)
+  }
+}
+
+function initConnectors(config) {
+  // Add storage and hosting connectors from env vars
+  if (env.STORAGE_CONNECTORS) {
+    config.setStorageConnectors([])
+    const connectors = env.STORAGE_CONNECTORS.split(',')
+    connectors.forEach((connector) => {
+      console.info('> Add storage connector from env var:', connector)
+      switch (connector) {
+        case 'fs':
+          config.addStorageConnector(new FsStorage(config, {
+            path: env.SILEX_FS_ROOT,
+          }))
+          break
+        case 'gitlab':
+          config.addStorageConnector(new GitlabConnector1(config, {
+            clientId: env.GITLAB_CLIENT_ID,
+            clientSecret: env.GITLAB_CLIENT_SECRET,
+            domain: env.GITLAB_DOMAIN,
+          }))
+          break
+        case 'gitlab2':
+          config.addStorageConnector(new GitlabConnector2(config, {
+            clientId: env.GITLAB2_CLIENT_ID,
+            clientSecret: env.GITLAB2_CLIENT_SECRET,
+            domain: env.GITLAB2_DOMAIN,
+          }))
+          break
+        case 'ftp':
+          config.addStorageConnector(new FtpConnector(config, {
+            type: ConnectorType.STORAGE,
+            path: env.FTP_STORAGE_PATH,
+          }))
+          break
+        default:
+          console.error('Unknown storage connector', connector)
+          throw new Error(`Unknown storage connector ${connector}`)
+      }
+    })
+  }
+
+  if (env.HOSTING_CONNECTORS) {
+    config.setHostingConnectors([])
+    const connectors = env.HOSTING_CONNECTORS.split(',')
+    connectors.forEach((connector) => {
+      console.info('> Add hosting connector from env var:', connector)
+      switch (connector) {
+        case 'fs':
+          config.addHostingConnector(new FsHosting(config, {
+            path: env.SILEX_FS_HOSTING_ROOT,
+          }))
+          break
+        case 'gitlab':
+          config.addHostingConnector(new GitlabHostingConnector1(config, {
+            clientId: env.GITLAB_CLIENT_ID,
+            clientSecret: env.GITLAB_CLIENT_SECRET,
+            domain: env.GITLAB_DOMAIN,
+          }))
+          break
+        case 'gitlab2':
+          config.addHostingConnector(new GitlabHostingConnector2(config, {
+            clientId: env.GITLAB2_CLIENT_ID,
+            clientSecret: env.GITLAB2_CLIENT_SECRET,
+            domain: env.GITLAB2_DOMAIN,
+          }))
+          break
+        case 'ftp':
+          config.addHostingConnector(new FtpConnector(config, {
+            type: ConnectorType.HOSTING,
+            path: env.FTP_HOSTING_PATH,
+          }))
+          break
+        case 'download':
+          config.addHostingConnector(new DownloadConnector(config))
+          break
+        default:
+          console.error('Unknown hosting connector', connector)
+          throw new Error(`Unknown hosting connector ${connector}`)
+      }
+    })
+  }
+}
+
+module.exports = async function(config) {
+  // SaaS multi-site dashboard FIRST: its "/" handler redirects to the localized
+  // dashboard before StaticPlugin can serve the editor's index.html at "/".
+  // (STARTUP_START handlers run in addPlugin order → dashboard routes mount first.)
+  await config.addPlugin(dashboard, {})
+
+  try {
+    // Core: serve the editor client, fonts and public assets
+    await config.addPlugin([
+      SslPlugin,
+      StaticPlugin,
+    ], {
+      [StaticPlugin]: {
+        routes: [
+          {
+            route: '/',
+            path: join(__dirname, '../../public'),
+          }, {
+            route: '/css/',
+            path: nodeModules('@fortawesome/fontawesome-free') + '/@fortawesome/fontawesome-free/css/',
+          }, {
+            route: '/webfonts/',
+            path: nodeModules('@fortawesome/fontawesome-free') + '/@fortawesome/fontawesome-free/webfonts/',
+          }, {
+            route: '/css/files/',
+            path: nodeModules('@fontsource/ubuntu') + '/@fontsource/ubuntu/files/',
+          }, {
+            route: '/',
+            path: join(__dirname, '../../dist/client'),
+          }, {
+            // SaaS client plugins (e.g. onboarding) imported by ./client-config.js
+            route: '/js/client-plugins/',
+            path: join(__dirname, 'client-plugins'),
+          },
+        ],
+      },
+    })
+  } catch (e) {
+    console.error(e)
+  }
+
+  // SaaS: onboarding email backend
+  await config.addPlugin(onboarding, {})
+
+  // Storage and hosting connectors selected by env vars
+  initConnectors(config)
+
+  return {}
+}

package/server/deploy/client-config.js

@@ -0,0 +1,17 @@
+// This file is loaded by Silex when the user opens the editor (SaaS only).
+// Its path is set in the environment variable SILEX_CLIENT_CONFIG.
+import onboarding from './js/client-plugins/onboarding.js'
+
+export default async function (config) {
+    config.addPlugin(onboarding, {})
+    config.addPublicationTransformers({
+        transformPermalink: (path, type) => {
+            // Replace /index.html with /
+            return type === 'html' && path.endsWith('/index.html') ? path.replace(/index\.html$/, '') : path
+        },
+    })
+    // CMS is now built into silex-lib and enabled by default
+    // To configure CMS options, use: config.cmsConfig = { ... }
+    // To disable CMS, use: config.cmsConfig = { enabled: false }
+    return {}
+}

package/server/deploy/client-plugins/onboarding.js

@@ -0,0 +1,67 @@
+const apiUrl = '/api/onboarding'
+
+async function hook(type, lang, rgpdAllowFeedback, rgpdAllowNewsletter) {
+  const response = await fetch(apiUrl, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      'Accept-Language': lang,
+    },
+    body: JSON.stringify({
+      type,
+      lang,
+      rgpdAllowFeedback,
+      rgpdAllowNewsletter,
+    })
+  })
+  if(response.status < 400) {
+    const responseData = await response.json()
+    return responseData.onboarding
+  } else {
+    console.error('Error while fetching user from brevo', response.statusText, response.status)
+    return null
+  }
+}
+
+function notify(editor, onboarding) {
+  if(!onboarding) return
+  const { title, content } = onboarding
+  editor.runCommand("notifications:add", {
+    type: 'info',
+    message: `
+      <marquee
+        style="width: calc(100% - 25px);"
+      >${title}</marquee>
+      <p>${content}</p>
+    `,
+  })
+}
+
+export default async (config) => {
+  // After init
+  const { rgpdAllowFeedback, rgpdAllowNewsletter } = getRgpdValues()
+  config.on('silex:grapesjs:end', async ({ editor }) => {
+    notify(editor, await hook('STORAGE', config.lang, rgpdAllowFeedback, rgpdAllowNewsletter))
+    editor.on('silex:publish:end', async ({success}) => {
+      if(success) {
+        notify(editor, await hook('HOSTING', config.lang, rgpdAllowFeedback, rgpdAllowNewsletter))
+      }
+    })
+  })
+}
+
+function getRgpdValues() {
+  try {
+    const rgpdAllowFeedback = localStorage.getItem('feedback') ?? 'false'
+    const rgpdAllowNewsletter = localStorage.getItem('nl') ?? 'false'
+    return {
+      rgpdAllowFeedback: rgpdAllowFeedback === 'true',
+      rgpdAllowNewsletter: rgpdAllowNewsletter === 'true',
+    }
+  } catch(e) {
+    return {
+      rgpdAllowFeedback: false,
+      rgpdAllowNewsletter: false,
+    }
+  }
+}

package/server/deploy/example.env

@@ -0,0 +1,25 @@
+SILEX_SESSION_NAME=change_me
+SILEX_SESSION_SECRET=change_me
+SILEX_URL=https://v3.silex.me
+SILEX_EXPRESS_JSON_LIMIT=1mb
+SILEX_EXPRESS_TEXT_LIMIT=10mb
+SILEX_EXPRESS_URLENCODED_LIMIT=1mb
+
+STORAGE_CONNECTORS=ftp,gitlab,gitlab2
+HOSTING_CONNECTORS=ftp,gitlab,gitlab2,download
+SILEX_FS_ROOT=
+SILEX_FS_HOSTING_ROOT=
+FTP_STORAGE_PATH=
+FTP_HOSTING_PATH=
+GITLAB_DISPLAY_NAME=
+GITLAB_DOMAIN=
+GITLAB_CLIENT_ID=
+GITLAB_CLIENT_SECRET=
+GITLAB2_DISPLAY_NAME=
+GITLAB2_DOMAIN=
+GITLAB2_CLIENT_ID=
+GITLAB2_CLIENT_SECRET=
+
+NOCO_URL=
+NOCO_API_KEY=
+NOCO_TABLE=

package/server/deploy/onboarding.json

@@ -0,0 +1,22 @@
+{
+  "en": {
+    "STORAGE": {
+      "title": "Welcome to Silex",
+      "content": "The first step is to play with the interface, and maybe check <a href='https://docs.silex.me'>the documetation</a>, <a href='https://video.silex.me/'>the video tutorials</a> and in particular <a href='https://video.silex.me/w/p/17h3h3PyjdT9XBKhR5ijNb?playlistPosition=4&resume=true'>this video to learn how to publish your website live</a>."
+    },
+    "HOSTING": {
+      "title": "Your website is live? What's next?",
+      "content": "Please take a moment to <a href='mailto:contact@silex.me'>email me and share your website</a>, <a href='https://www.g2.com/products/silex-website-builder/reviews'>give Silex a 5 stars review</a>. And if you want to <a href='https://opencollective.com/silex'>support the project on Open Collective.</a>."
+    }
+  },
+  "fr": {
+    "STORAGE": {
+      "title": "Bienvenue sur Silex",
+      "content": "Le premier pas est de jouer avec l'interface, et peut-être de consulter <a href='https://docs.silex.me'>la documentation</a>, <a href='https://video.silex.me/'>les tutoriels vidéo</a> et en particulier <a href='https://video.silex.me/w/p/17h3h3PyjdT9XBKhR5ijNb?playlistPosition=4&resume=true'>cette vidéo pour apprendre à publier votre site web en ligne</a>."
+    },
+    "HOSTING": {
+      "title": "Votre site web est en ligne? Et après?",
+      "content": "Prenez un moment pour <a href='mailto:contact@silex.me'>m'envoyer un email et partager votre site web</a>, <a href='https://www.g2.com/products/silex-website-builder/reviews'>donnez 5 étoiles à Silex</a>. Et si vous voulez <a href='https://opencollective.com/silex'>soutenir le projet sur Open Collective.</a>."
+    }
+  }
+}

package/server/deploy/server-plugins/dashboard.js

@@ -0,0 +1,74 @@
+/*
+ * Silex website builder, free/libre no-code tool for makers.
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @fileoverview SaaS multi-site dashboard plugin (monorepo glue).
+ * Serves the pre-built dashboard SPA (the `silex-dashboard` submodule `_site`) at "/",
+ * detects the browser language, and redirects "/" to the localized dashboard unless an
+ * editor `?id` is present (in which case it falls through to the editor served by
+ * StaticPlugin). Re-implemented against the monorepo dist so the silex-dashboard
+ * submodule stays pure content (no stale `@silexlabs/silex/dist/...` requires).
+ */
+const fs = require('node:fs/promises')
+const { join } = require('node:path')
+const express = require('express')
+const serveStatic = require('serve-static')
+const locale = require('locale')
+const { withCache } = require('../../../dist/server/server/plugins/Cache')
+const { ServerEvent } = require('../../../dist/server/server/events')
+
+const DASHBOARD_ROOT = join(__dirname, '../../../silex-dashboard')
+
+module.exports = async function(config, options) {
+  console.log('> Silex dashboard plugin starting', { options })
+
+  const opts = {
+    defaultLanguage: 'en',
+    rootPath: join(DASHBOARD_ROOT, '_site'),
+    ...options,
+  }
+
+  // List of languages from silex-dashboard/collections/languages/*.json
+  const languages = []
+  const langDir = join(DASHBOARD_ROOT, 'collections/languages')
+  for (const file of await fs.readdir(langDir)) {
+    languages.push(JSON.parse(await fs.readFile(join(langDir, file))))
+  }
+
+  // Serve the dashboard and let the editor through when a website ?id is present
+  config.on(ServerEvent.STARTUP_START, ({ app }) => {
+    const router = express.Router()
+    app.use(router)
+
+    // Use cache
+    router.use(withCache)
+
+    // Localization: populate req.locale
+    router.use(locale(languages.map(l => l.code), opts.defaultLanguage))
+
+    // Serve the dashboard SPA
+    router.use('/', serveStatic(opts.rootPath))
+
+    // Redirect "/" to the localized dashboard unless the editor is requested (?id=...)
+    const editorRouter = express.Router()
+    editorRouter.use('/', (req, res, next) => {
+      if (req.path === '/' && !req.query.id) res.redirect(`/${req.locale}/`)
+      else next()
+    })
+    app.use(editorRouter)
+  })
+}