@silexlabs/silex 3.0.0-alpha.39 → 3.0.0-alpha.41

package/dist/server/backends/index.d.ts

@@ -0,0 +1,95 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Application } from 'express';
+import { Readable } from 'stream';
+import { ServerConfig } from '../config';
+import { JobStatus, JobData, BackendData, BackendId, WebsiteId, BackendType, BackendUser, WebsiteMeta, FileMeta } from '../../types';
+/**
+ * @fileoverview define types for Silex backends
+ * Bakends can provide storage for website data and assets, and/or hosting to publish the website online
+ */
+/**
+ * Files are stored in backend as a File object
+ * @see types/ClientSideFile
+ */
+export interface File {
+    path: string;
+    content: Buffer | string | Readable;
+}
+/**
+ * Callback to update the publication status
+ */
+export type StatusCallback = ({ message, status }: {
+    message: string;
+    status: JobStatus;
+}) => Promise<void>;
+export type BackendSession = any;
+/**
+ * Backends are the base interface for Storage and Hosting providers
+ */
+export interface Backend<Session extends BackendSession = BackendSession> {
+    id: BackendId;
+    displayName: string;
+    icon: string;
+    disableLogout?: boolean;
+    type: BackendType;
+    getAdminUrl(session: Session, id: WebsiteId): Promise<string | null>;
+    getAuthorizeURL(session: Session): Promise<string | null>;
+    isLoggedIn(session: Session): Promise<boolean>;
+    logout(session: Session): Promise<void>;
+    getUserData(session: Session): Promise<BackendUser>;
+    init(session: Session, id: WebsiteId): Promise<void>;
+}
+/**
+ * Storage are used to store the website data and assets
+ * And possibly rename files and directories, and get the URL of a file
+ *
+ */
+export interface StorageProvider<Session = BackendSession> extends Backend<Session> {
+    listWebsites(session: Session): Promise<WebsiteMeta[]>;
+    readFile(session: Session, id: WebsiteId, path: string): Promise<File>;
+    writeFiles(session: Session, id: WebsiteId, files: File[], status?: StatusCallback): Promise<string[]>;
+    deleteFiles(session: Session, id: WebsiteId, paths: string[]): Promise<void>;
+    listDir(session: Session, id: WebsiteId, path: string): Promise<FileMeta[]>;
+    createDir(session: Session, id: WebsiteId, path: string): Promise<void>;
+    deleteDir(session: Session, id: WebsiteId, path: string): Promise<void>;
+    getSiteMeta(session: Session, id: WebsiteId): Promise<WebsiteMeta>;
+}
+/**
+ * Hosting providers are used to publish the website
+ */
+export interface HostingProvider<Session = BackendSession> extends Backend<Session> {
+    publish(session: Session, id: WebsiteId, backendData: BackendData, files: File[]): Promise<JobData>;
+    getWebsiteUrl(session: Session, id: WebsiteId): Promise<string>;
+}
+export declare function toBackendEnum(type: string): BackendType;
+/**
+ * Get a backend by id or by type
+ */
+export declare function getBackend<T extends Backend>(config: ServerConfig, session: any, type: BackendType, backendId?: BackendId): Promise<T | undefined>;
+/**
+ * Convert a backend to a BackendData object to be sent to the frontend
+ */
+export declare function toBackendData(session: any, backend: Backend): Promise<BackendData>;
+/**
+ * Add routes to the express app
+ */
+export declare function addRoutes(config: ServerConfig, app: Application): void;
+/**
+ * Express route to check if the user is logged in
+ * Returns user data and backend data
+ */
+export declare function routeLoginStatus(req: any, res: any): Promise<void>;
+/**
+ * Express route to list the backends
+ */
+export declare function routeListBackends(req: any, res: any): Promise<void>;
+/**
+ * Express route to serve as redirect after a successful login
+ * The returned HTML will postMessage data and close the popup window
+ */
+export declare function routeLoginSuccess(req: any, res: any): Promise<void>;
+/**
+ * Express route to logout from a backend
+ */
+export declare function routeLogout(req: any, res: any): Promise<void>;

package/dist/server/backends/index.js

@@ -0,0 +1,255 @@
+"use strict";
+/*
+ * 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/>.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeLogout = exports.routeLoginSuccess = exports.routeListBackends = exports.routeLoginStatus = exports.addRoutes = exports.toBackendData = exports.getBackend = exports.toBackendEnum = void 0;
+const express_1 = require("express");
+const types_1 = require("../../types");
+const constants_1 = require("../../constants");
+const validation_1 = require("../utils/validation");
+function toBackendEnum(type) {
+    return types_1.BackendType[type.toUpperCase()];
+}
+exports.toBackendEnum = toBackendEnum;
+/**
+ * Get a backend by id or by type
+ */
+async function getBackend(config, session, type, backendId) {
+    const backends = config.getBackends(type);
+    // Find the backend by id
+    if (backendId)
+        return backends.find(s => s.id === backendId && s.type === type);
+    // Find the first logged in backend
+    for (const backend of backends) {
+        if (await backend.isLoggedIn(session)) {
+            return backend;
+        }
+    }
+    // Defaults to the first backend
+    return backends[0];
+}
+exports.getBackend = getBackend;
+/**
+ * Convert a backend to a BackendData object to be sent to the frontend
+ */
+async function toBackendData(session, backend) {
+    return {
+        backendId: backend.id,
+        type: backend.type,
+        displayName: backend.displayName,
+        icon: backend.icon,
+        disableLogout: !!backend.disableLogout,
+        isLoggedIn: await backend.isLoggedIn(session),
+        authUrl: await backend.getAuthorizeURL(session),
+    };
+}
+exports.toBackendData = toBackendData;
+/**
+ * Add routes to the express app
+ */
+function addRoutes(config, app) {
+    // Create the router
+    const router = (0, express_1.Router)();
+    app.use(router);
+    // Backend routes
+    router.get(`/${constants_1.API_BACKEND_LOGIN_STATUS}`, routeLoginStatus);
+    router.get(`/${constants_1.API_BACKEND_LIST}`, routeListBackends);
+    router.post(`/${constants_1.API_BACKEND_LOGOUT}`, routeLogout);
+    router.get(`/${constants_1.API_BACKEND_LOGIN_CALLBACK}`, routeLoginSuccess);
+}
+exports.addRoutes = addRoutes;
+/**
+ * Express route to check if the user is logged in
+ * Returns user data and backend data
+ */
+async function routeLoginStatus(req, res) {
+    try {
+        const config = (0, validation_1.requiredParam)(req.app.get('config'), 'Config object on express js APP');
+        const query = (0, validation_1.requiredParam)(req.query, 'Query object');
+        const session = (0, validation_1.requiredParam)(req['session'], 'Session object');
+        const websiteId = query.id;
+        const backendId = query.backendId;
+        const type = query.type;
+        const backend = await getBackend(config, session, type, backendId);
+        if (!backend) {
+            res
+                .status(500)
+                .json({
+                error: true,
+                message: 'No backend found',
+            });
+            return;
+        }
+        if (!await backend.isLoggedIn(session)) {
+            res
+                .status(401)
+                .json({
+                error: true,
+                message: 'Not logged in',
+            });
+            return;
+        }
+        const backendData = await toBackendData(session, backend);
+        const user = await backend.getUserData(session);
+        const websiteMeta = websiteId && backend.type === types_1.BackendType.STORAGE && await backend.getSiteMeta(session, websiteId);
+        res.json({
+            backend: backendData,
+            user,
+            websiteMeta,
+        });
+    }
+    catch (error) {
+        console.error('Error in the login status request', error);
+        res.status(error?.code ?? 500).json({
+            error: true,
+            message: error.message,
+        });
+    }
+}
+exports.routeLoginStatus = routeLoginStatus;
+/**
+ * Express route to list the backends
+ */
+async function routeListBackends(req, res) {
+    try {
+        const config = (0, validation_1.requiredParam)(req.app.get('config'), 'Config object on express js APP');
+        const query = req.query;
+        const type = toBackendEnum((0, validation_1.requiredParam)(query.type, 'Backend type'));
+        const backends = config.getBackends(type);
+        try {
+            const list = await Promise.all(backends.map(async (backend) => toBackendData(req['session'], backend)));
+            res.json(list);
+        }
+        catch (error) {
+            console.error('Error while listing backends', error);
+            res.status(error?.code ?? 500).json({
+                error: true,
+                message: 'Error while listing backends: ' + error.message,
+            });
+        }
+    }
+    catch (error) {
+        console.error('Error in the list backends request', error);
+        res.status(error?.code ?? 400).json({
+            error: true,
+            message: 'Error in the list backends request: ' + error.message,
+        });
+    }
+}
+exports.routeListBackends = routeListBackends;
+/**
+ * Utility function to send an HTML page to the browser
+ * This page will send a postMessage to the parent window and close itself
+ */
+function sendHtml(res, message, backendId, error, defaultErrorCode) {
+    error && console.error('Error while logging in', error);
+    // Data for postMessage
+    const data = {
+        type: 'login',
+        error: error ? true : false,
+        message,
+        backendId,
+    };
+    // HTTP status code
+    const status = error ? error['code'] ?? defaultErrorCode ?? 500 : 200;
+    // Send the HTML
+    res
+        .status(status)
+        .send(`
+        <html>
+          <head>
+            <script>
+              window.opener.postMessage(${JSON.stringify(data)}, '*')
+              window.close()
+            </script>
+          </head>
+          <body>
+            <p>${message}</p>
+            <p>Close this window</p>
+          </body>
+        </html>
+      `);
+}
+/**
+ * Express route to serve as redirect after a successful login
+ * The returned HTML will postMessage data and close the popup window
+ */
+async function routeLoginSuccess(req, res) {
+    try {
+        const query = req.query;
+        if (query.error)
+            throw new Error(query.error);
+        const backendId = (0, validation_1.requiredParam)(query.backendId, 'Backend id');
+        const config = (0, validation_1.requiredParam)(req.app.get('config'), 'Config object on express js APP');
+        const type = toBackendEnum((0, validation_1.requiredParam)(query.type, 'Backend type'));
+        const backend = await getBackend(config, req['session'], type, backendId);
+        if (!backend)
+            throw new Error('Backend not found ' + backendId);
+        try {
+            sendHtml(res, 'Logged in', backendId);
+        }
+        catch (error) {
+            sendHtml(res, 'Error while logging in', undefined, error, 500);
+        }
+    }
+    catch (error) {
+        sendHtml(res, 'Error in the request ' + error.message, undefined, error, 400);
+    }
+}
+exports.routeLoginSuccess = routeLoginSuccess;
+/**
+ * Express route to logout from a backend
+ */
+async function routeLogout(req, res) {
+    try {
+        const query = req.query;
+        // Get the backend
+        const backendId = (0, validation_1.requiredParam)(query.backendId, 'Backend id');
+        const config = (0, validation_1.requiredParam)(req.app.get('config'), 'Config object on express js APP');
+        const type = toBackendEnum((0, validation_1.requiredParam)(query.type, 'Backend type'));
+        const backend = await getBackend(config, req['session'], type, backendId);
+        if (!backend)
+            throw new Error(`Backend not found ${backendId} ${type}`);
+        try {
+            // Logout
+            await backend.logout(req['session']);
+            // Return success
+            res.json({
+                error: false,
+                message: 'OK',
+            });
+        }
+        catch (error) {
+            console.error('Error while logging out', error);
+            res.status(error?.code ?? 500).json({
+                error: true,
+                message: 'Error while logging out: ' + error.message,
+            });
+            return;
+        }
+    }
+    catch (error) {
+        console.error('Error in the logout request', error);
+        res.status(error?.code ?? 400).json({
+            error: true,
+            message: 'Error in the logout request: ' + error.message,
+        });
+        return;
+    }
+}
+exports.routeLogout = routeLogout;
+//# sourceMappingURL=index.js.map

package/dist/server/backends/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ts/server/backends/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,qCAAuD;AAGvD,uCAAsW;AACtW,+CAA4H;AAC5H,oDAAmD;AAiEnD,SAAgB,aAAa,CAAC,IAAY;IACxC,OAAO,mBAAW,CAAC,IAAI,CAAC,WAAW,EAA8B,CAAC,CAAA;AACpE,CAAC;AAFD,sCAEC;AAED;;GAEG;AACI,KAAK,UAAU,UAAU,CAAoB,MAAoB,EAAE,OAAY,EAAE,IAAiB,EAAE,SAAqB;IAC9H,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAI,IAAI,CAAC,CAAA;IAC5C,yBAAyB;IACzB,IAAI,SAAS;QAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;IAC/E,mCAAmC;IACnC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;QAC9B,IAAI,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YACrC,OAAO,OAAO,CAAA;SACf;KACF;IACD,gCAAgC;IAChC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAA;AACpB,CAAC;AAZD,gCAYC;AAED;;GAEG;AACI,KAAK,UAAU,aAAa,CAAC,OAAY,EAAE,OAAgB;IAChE,OAAO;QACL,SAAS,EAAE,OAAO,CAAC,EAAE;QACrB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa;QACtC,UAAU,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;QAC7C,OAAO,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC;KAChD,CAAA;AACH,CAAC;AAVD,sCAUC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,MAAoB,EAAE,GAAgB;IAC9D,oBAAoB;IACpB,MAAM,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAA;IACvB,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAEf,iBAAiB;IACjB,MAAM,CAAC,GAAG,CAAC,IAAI,oCAAwB,EAAE,EAAE,gBAAgB,CAAC,CAAA;IAC5D,MAAM,CAAC,GAAG,CAAC,IAAI,4BAAgB,EAAE,EAAE,iBAAiB,CAAC,CAAA;IACrD,MAAM,CAAC,IAAI,CAAC,IAAI,8BAAkB,EAAE,EAAE,WAAW,CAAC,CAAA;IAClD,MAAM,CAAC,GAAG,CAAC,IAAI,sCAA0B,EAAE,EAAE,iBAAiB,CAAC,CAAA;AACjE,CAAC;AAVD,8BAUC;AAED;;;GAGG;AACI,KAAK,UAAU,gBAAgB,CAAC,GAAG,EAAE,GAAG;IAC7C,IAAI;QACF,MAAM,MAAM,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAiB,EAAE,iCAAiC,CAAC,CAAA;QACtG,MAAM,KAAK,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,KAA0C,EAAE,cAAc,CAAC,CAAA;QAC3F,MAAM,OAAO,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC,CAAA;QAC/D,MAAM,SAAS,GAAG,KAAK,CAAC,EAAE,CAAA;QAC1B,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QACjC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACvB,MAAM,OAAO,GAAG,MAAM,UAAU,CAAU,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;QAC3E,IAAI,CAAC,OAAO,EAAE;YACZ,GAAG;iBACA,MAAM,CAAC,GAAG,CAAC;iBACX,IAAI,CAAC;gBACJ,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,kBAAkB;aACR,CAAC,CAAA;YACxB,OAAM;SACP;QACD,IAAG,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YACrC,GAAG;iBACA,MAAM,CAAC,GAAG,CAAC;iBACX,IAAI,CAAC;gBACJ,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,eAAe;aACL,CAAC,CAAA;YACxB,OAAM;SACP;QACD,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACzD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC/C,MAAM,WAAW,GAAG,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,mBAAW,CAAC,OAAO,IAAI,MAAO,OAA2B,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QAC3I,GAAG,CAAC,IAAI,CAAC;YACP,OAAO,EAAE,WAAW;YACpB,IAAI;YACJ,WAAW;SACqB,CAAC,CAAA;KACpC;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAA;QACzD,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;YAClC,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,KAAK,CAAC,OAAO;SACH,CAAC,CAAA;KACvB;AACH,CAAC;AA1CD,4CA0CC;AAED;;GAEG;AACI,KAAK,UAAU,iBAAiB,CAAC,GAAG,EAAE,GAAG;IAC9C,IAAI;QACF,MAAM,MAAM,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAiB,EAAE,iCAAiC,CAAC,CAAA;QACtG,MAAM,KAAK,GAAG,GAAG,CAAC,KAAmC,CAAA;QACrD,MAAM,IAAI,GAAG,aAAa,CAAC,IAAA,0BAAa,EAAC,KAAK,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAA;QACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAU,IAAI,CAAC,CAAA;QAClD,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;YACrG,GAAG,CAAC,IAAI,CAAC,IAA8B,CAAC,CAAA;SACzC;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAA;YACpD,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;gBAClC,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,gCAAgC,GAAG,KAAK,CAAC,OAAO;aACtC,CAAC,CAAA;SACvB;KACF;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAA;QAC1D,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;YAClC,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,sCAAsC,GAAG,KAAK,CAAC,OAAO;SAC5C,CAAC,CAAA;KACvB;AACH,CAAC;AAvBD,8CAuBC;AAED;;;GAGG;AACH,SAAS,QAAQ,CAAC,GAAa,EAAE,OAAe,EAAE,SAAqB,EAAE,KAAa,EAAE,gBAAyB;IAC/G,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAA;IACvD,uBAAuB;IACvB,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;QAC3B,OAAO;QACP,SAAS;KACuB,CAAA;IAClC,mBAAmB;IACnB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,gBAAgB,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAA;IACrE,gBAAgB;IAChB,GAAG;SACA,MAAM,CAAC,MAAM,CAAC;SACd,IAAI,CAAC;;;;0CAIgC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;;;;;iBAK7C,OAAO;;;;OAIjB,CAAC,CAAA;AACR,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,iBAAiB,CAAC,GAAG,EAAE,GAAG;IAC9C,IAAI;QACF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAoC,CAAA;QACtD,IAAG,KAAK,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAE5C,MAAM,SAAS,GAAG,IAAA,0BAAa,EAAC,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;QAC9D,MAAM,MAAM,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAiB,EAAE,iCAAiC,CAAC,CAAA;QACtG,MAAM,IAAI,GAAG,aAAa,CAAC,IAAA,0BAAa,EAAC,KAAK,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAA;QACrE,MAAM,OAAO,GAAG,MAAM,UAAU,CAAU,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;QAClF,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAA;QAC/D,IAAI;YACF,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,SAAS,CAAC,CAAA;SACtC;QAAC,OAAO,KAAK,EAAE;YACd,QAAQ,CAAC,GAAG,EAAE,wBAAwB,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;SAC/D;KACF;IAAC,OAAO,KAAK,EAAE;QACd,QAAQ,CAAC,GAAG,EAAE,uBAAuB,GAAG,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;KAC9E;AACH,CAAC;AAlBD,8CAkBC;AAED;;GAEG;AACI,KAAK,UAAU,WAAW,CAAC,GAAG,EAAE,GAAG;IACxC,IAAI;QACF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAqC,CAAA;QACvD,kBAAkB;QAClB,MAAM,SAAS,GAAG,IAAA,0BAAa,EAAC,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;QAC9D,MAAM,MAAM,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAiB,EAAE,iCAAiC,CAAC,CAAA;QACtG,MAAM,IAAI,GAAG,aAAa,CAAC,IAAA,0BAAa,EAAC,KAAK,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAA;QACrE,MAAM,OAAO,GAAG,MAAM,UAAU,CAAU,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;QAClF,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,SAAS,IAAI,IAAI,EAAE,CAAC,CAAA;QACvE,IAAI;YACF,SAAS;YACT,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAA;YACpC,iBAAiB;YACjB,GAAG,CAAC,IAAI,CAAC;gBACP,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,IAAI;aACM,CAAC,CAAA;SACvB;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAA;YAC/C,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;gBAClC,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,2BAA2B,GAAG,KAAK,CAAC,OAAO;aACjC,CAAC,CAAA;YACtB,OAAM;SACP;KACF;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAA;QACnD,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;YAClC,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,+BAA+B,GAAG,KAAK,CAAC,OAAO;SACrC,CAAC,CAAA;QACtB,OAAM;KACP;AACH,CAAC;AAjCD,kCAiCC"}

package/dist/server/cli.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/server/config.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @fileoverview This is where the default config is defined. Also use this object as an event emitter to listen to Silex events
+ * The values can be overriden with env vars or before passing the config to Silex
+ */
+/**
+ * @class default config for Silex server
+ */
+import { Config } from '@silexlabs/silex-plugins';
+import { Application } from 'express';
+import { HostingProvider, StorageProvider } from './backends';
+import { Backend } from './backends';
+import { BackendType } from '../types';
+/**
+ * Config types definitions
+ */
+export declare class ServerConfig extends Config {
+    url: string;
+    debug: boolean;
+    port: string;
+    apiPath: string;
+    expressOptions: {
+        jsonLimit: string;
+        textLimit: string;
+        sessionName: string;
+        sessionSecret: string;
+        cors: string;
+    };
+    constructor(url: string, debug: boolean, port: string, apiPath: string);
+    getBackends<T extends Backend>(type?: BackendType | string | null): T[];
+    private storageProviders;
+    addStorageProvider(storage: StorageProvider | StorageProvider[]): void;
+    setStorageProviders(storageProviders: StorageProvider[]): void;
+    getStorageProviders(): StorageProvider[];
+    private hostingProviders;
+    addHostingProvider(hosting: HostingProvider | HostingProvider[]): void;
+    setHostingProviders(hostings: HostingProvider[]): void;
+    getHostingProviders(): HostingProvider[];
+    /**
+     * Add routes to serve the client config file
+     */
+    addRoutes(app: Application): Promise<void>;
+    /**
+     * Load config files
+     * This is the main config file and the user config file
+     */
+    loadConfigFiles(): Promise<void>;
+}
+export declare function createConfig(): ServerConfig;
+/**
+ * Load user config file
+ * This is the config file passed as env var CONFIG
+ */
+export declare function loadUserConfig(config: ServerConfig): Promise<void>;
+/**
+ * Load .silex.js in the root folder
+ * This is the main config file
+ */
+export declare function loadSilexConfig(config: ServerConfig): Promise<void>;

package/dist/server/config.js

@@ -1,17 +1,51 @@
 "use strict";
+/*
+ * 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/>.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServerConfig = void 0;
+exports.loadSilexConfig = exports.loadUserConfig = exports.createConfig = exports.ServerConfig = void 0;
+/**
+ * @fileoverview This is where the default config is defined. Also use this object as an event emitter to listen to Silex events
+ * The values can be overriden with env vars or before passing the config to Silex
+ */
+/**
+ * @class default config for Silex server
+ */
 const silex_plugins_1 = require("@silexlabs/silex-plugins");
 const path_1 = require("path");
 const constants_1 = require("../constants");
-const express_1 = require("express");
 const promises_1 = require("fs/promises");
-const events_1 = require("../events");
+const backends_1 = require("./backends");
+const FsBackend_1 = require("./backends/FsBackend");
+const types_1 = require("../types");
+/**
+ * Config types definitions
+ */
 class ServerConfig extends silex_plugins_1.Config {
     url;
     debug;
     port;
     apiPath;
+    expressOptions = {
+        jsonLimit: process.env.SILEX_EXPRESS_JSON_LIMIT || '1mb',
+        textLimit: process.env.SILEX_EXPRESS_TEXT_LIMIT || '10mb',
+        sessionName: process.env.SILEX_SESSION_NAME || 'silex-session',
+        sessionSecret: process.env.SILEX_SESSION_SECRET || 'replace this session secret in env vars',
+        cors: process.env.SILEX_CORS_URL,
+    };
     constructor(url, debug, port, apiPath) {
         super();
         this.url = url;
@@ -19,42 +53,112 @@ class ServerConfig extends silex_plugins_1.Config {
         this.port = port;
         this.apiPath = apiPath;
     }
+    // All backends or just the storage or hosting providers
+    getBackends(type = null) {
+        // All backends including storage and hosting providers
+        if (!type) {
+            // Concat storage and hosting providers
+            const allBackends = this.getStorageProviders().concat(this.getHostingProviders());
+            // Remove duplicates (if a backend is both a storage and a hosting provider)
+            return Array.from(new Set(allBackends));
+        }
+        // Convert to enum in case it is a string
+        const backendType = (0, backends_1.toBackendEnum)(type.toString());
+        // Only one type of backend
+        switch (backendType) {
+            case types_1.BackendType.HOSTING: return this.getHostingProviders();
+            case types_1.BackendType.STORAGE: return this.getStorageProviders();
+            default: throw new Error(`Unknown backend type ${type}`);
+        }
+    }
+    // Storage providers to store the website data and assets
+    storageProviders = [new FsBackend_1.FsBackend(null, { type: types_1.BackendType.STORAGE })];
+    addStorageProvider(storage) {
+        this.setStorageProviders(this.storageProviders.concat(storage));
+    }
+    setStorageProviders(storageProviders) {
+        this.storageProviders = storageProviders;
+    }
+    getStorageProviders() {
+        return this.storageProviders;
+    }
+    // Hosting providers to publish the website online
+    hostingProviders = [new FsBackend_1.FsBackend(null, { type: types_1.BackendType.HOSTING })];
+    addHostingProvider(hosting) {
+        this.setHostingProviders(this.hostingProviders.concat(hosting));
+    }
+    setHostingProviders(hostings) {
+        this.hostingProviders = hostings;
+    }
+    getHostingProviders() { return this.hostingProviders; }
+    /**
+     * Add routes to serve the client config file
+     */
+    async addRoutes(app) {
+        const path = process.env.SILEX_CLIENT_CONFIG;
+        if (path) {
+            console.log(`> Serving client side config ${path} at ${constants_1.CLIENT_CONFIG_FILE_NAME}`);
+            // Load the client config file
+            let clientConfig = (await (0, promises_1.readFile)(path)).toString();
+            // Serve the config file
+            app.get(`/${constants_1.CLIENT_CONFIG_FILE_NAME}`, async (req, res) => {
+                // Reload each time in debug mode
+                if (this.debug) {
+                    console.log('[Debug mode] Reloading config file', path);
+                    clientConfig = (await (0, promises_1.readFile)(path)).toString();
+                }
+                // Send the config file
+                res.json(clientConfig);
+            });
+        }
+    }
+    /**
+     * Load config files
+     * This is the main config file and the user config file
+     */
+    async loadConfigFiles() {
+        // Load the user config file
+        await loadUserConfig(this);
+        // Load the main config file
+        await loadSilexConfig(this);
+    }
 }
 exports.ServerConfig = ServerConfig;
-async function default_1() {
-    const port = process.env.PORT || '6805';
+// Get config async function
+function createConfig() {
+    const port = process.env.PORT || '6805'; // 6805 is the date of sexual revolution started in paris france 8-)
     const debug = process.env.SILEX_DEBUG === 'true';
-    const clientConfigPath = process.env.SILEX_CLIENT_CONFIG;
     const url = process.env.SERVER_URL || `http://localhost:${port}`;
-    const config = new ServerConfig(url, debug, port, '/api');
-    if (clientConfigPath) {
-        config.on(events_1.EVENT_STARTUP_START, async ({ app }) => {
-            console.log(`> Serving client side config ${clientConfigPath} at ${constants_1.CLIENT_CONFIG_FILE_NAME}`);
-            const router = (0, express_1.Router)();
-            app.use(router);
-            let clientConfig = (await (0, promises_1.readFile)(clientConfigPath)).toString();
-            router.get(`/${constants_1.CLIENT_CONFIG_FILE_NAME}`, async (res, req, next) => {
-                if (config.debug) {
-                    console.log('[Debug mode] Reloading config file', clientConfigPath);
-                    clientConfig = (await (0, promises_1.readFile)(clientConfigPath)).toString();
-                }
-                req.header('Content-Type', 'application/javascript').send(clientConfig);
-            });
-        });
-    }
+    return new ServerConfig(url, debug, port, '/api');
+}
+exports.createConfig = createConfig;
+/**
+ * Load user config file
+ * This is the config file passed as env var CONFIG
+ */
+async function loadUserConfig(config) {
     if (process.env.CONFIG) {
         const userConfigPath = process.env.CONFIG;
         console.log('> Loading user config', userConfigPath);
         try {
+            // Initiate the process with the config file which is just another plugin
             await config.addPlugin(userConfigPath, {});
         }
         catch (e) {
             throw new Error(`User config file ${userConfigPath} error: ${e.message}`);
         }
     }
+}
+exports.loadUserConfig = loadUserConfig;
+/**
+ * Load .silex.js in the root folder
+ * This is the main config file
+ */
+async function loadSilexConfig(config) {
     const configFilePath = (0, path_1.resolve)(__dirname, '../../.silex.js');
     console.log('> Loading config', configFilePath);
     try {
+        // Initiate the process with the config file which is just another plugin
         await config.addPlugin(configFilePath, {});
     }
     catch (e) {
@@ -65,6 +169,6 @@ async function default_1() {
             throw new Error(`Error in config file ${configFilePath}: ${e.message}`);
         }
     }
-    return config;
 }
-exports.default = default_1;
+exports.loadSilexConfig = loadSilexConfig;
+//# sourceMappingURL=config.js.map

package/dist/server/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/ts/server/config.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH;;;GAGG;AAEH;;GAEG;AAEH,4DAAyD;AACzD,+BAA8B;AAC9B,4CAAsD;AAEtD,0CAAsC;AACtC,yCAA4E;AAC5E,oDAAgD;AAEhD,oCAAsC;AAEtC;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAM;IAS7B;IACA;IACA;IACA;IAXF,cAAc,GAAG;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,IAAI,KAAK;QACxD,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,IAAI,MAAM;QACzD,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,eAAe;QAC9D,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,yCAAyC;QAC5F,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;KACjC,CAAA;IACD,YACS,GAAW,EACX,KAAc,EACd,IAAY,EACZ,OAAe;QAEtB,KAAK,EAAE,CAAA;QALA,QAAG,GAAH,GAAG,CAAQ;QACX,UAAK,GAAL,KAAK,CAAS;QACd,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAQ;IAGxB,CAAC;IAED,wDAAwD;IACxD,WAAW,CAAoB,OAAoC,IAAI;QACrE,uDAAuD;QACvD,IAAI,CAAC,IAAI,EAAE;YACT,uCAAuC;YACvC,MAAM,WAAW,GAAe,IAAI,CAAC,mBAAmB,EAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAe,CAAC,CAAA;YAExH,4EAA4E;YAC5E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,CAAmB,CAAA;SAC1D;QAED,yCAAyC;QACzC,MAAM,WAAW,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAElD,2BAA2B;QAC3B,QAAO,WAAW,EAAE;YACpB,KAAK,mBAAW,CAAC,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,mBAAmB,EAAoB,CAAA;YAC7E,KAAK,mBAAW,CAAC,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,mBAAmB,EAAoB,CAAA;YAC7E,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAA;SACvD;IACH,CAAC;IAED,yDAAyD;IACjD,gBAAgB,GAAsB,CAAC,IAAI,qBAAS,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,mBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;IAClG,kBAAkB,CAAC,OAA4C;QAC7D,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;IACjE,CAAC;IACD,mBAAmB,CAAC,gBAAmC;QACrD,IAAI,CAAC,gBAAgB,GAAE,gBAAgB,CAAA;IACzC,CAAC;IACD,mBAAmB;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAED,kDAAkD;IAC1C,gBAAgB,GAAsB,CAAC,IAAI,qBAAS,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,mBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;IAClG,kBAAkB,CAAC,OAA4C;QAC7D,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;IACjE,CAAC;IACD,mBAAmB,CAAC,QAA2B;QAC7C,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAA;IAClC,CAAC;IACD,mBAAmB,KAAwB,OAAO,IAAI,CAAC,gBAAgB,CAAA,CAAC,CAAC;IAEzE;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAgB;QAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAA;QAC5C,IAAI,IAAI,EAAE;YACR,OAAO,CAAC,GAAG,CAAC,gCAAgC,IAAI,OAAO,mCAAuB,EAAE,CAAC,CAAA;YACjF,8BAA8B;YAC9B,IAAI,YAAY,GAAG,CAAC,MAAM,IAAA,mBAAQ,EAAC,IAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YAC9D,wBAAwB;YACxB,GAAG,CAAC,GAAG,CAAC,IAAI,mCAAuB,EAAE,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;gBAC3E,iCAAiC;gBACjC,IAAI,IAAI,CAAC,KAAK,EAAE;oBACd,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,IAAI,CAAC,CAAA;oBACvD,YAAY,GAAG,CAAC,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;iBACjD;gBACD,uBAAuB;gBACvB,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YACxB,CAAC,CAAC,CAAA;SACH;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe;QACnB,4BAA4B;QAC5B,MAAM,cAAc,CAAC,IAAI,CAAC,CAAA;QAC1B,4BAA4B;QAC5B,MAAM,eAAe,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;CACF;AA7FD,oCA6FC;AAED,4BAA4B;AAC5B,SAAgB,YAAY;IAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,CAAA,CAAC,oEAAoE;IAC5G,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,CAAA;IAEhD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,oBAAoB,IAAI,EAAE,CAAA;IAChE,OAAO,IAAI,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;AACnD,CAAC;AAND,oCAMC;AAED;;;GAGG;AACI,KAAK,UAAU,cAAc,CAAC,MAAoB;IACvD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE;QACtB,MAAM,cAAc,GAAW,OAAO,CAAC,GAAG,CAAC,MAAM,CAAA;QACjD,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,cAAc,CAAC,CAAA;QACpD,IAAI;YACF,yEAAyE;YACzE,MAAM,MAAM,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;SAC3C;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,oBAAoB,cAAc,WAAW,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;SAC1E;KACF;AACH,CAAC;AAXD,wCAWC;AAED;;;GAGG;AACI,KAAK,UAAU,eAAe,CAAC,MAAoB;IACxD,MAAM,cAAc,GAAW,IAAA,cAAO,EAAC,SAAS,EAAE,iBAAiB,CAAC,CAAA;IACpE,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAA;IAC/C,IAAI;QACF,yEAAyE;QACzE,MAAM,MAAM,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;KAC3C;IAAC,OAAM,CAAC,EAAE;QACT,IAAG,CAAC,CAAC,IAAI,KAAK,kBAAkB,EAAE;YAChC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAA;SAChD;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,wBAAwB,cAAc,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;SACxE;KACF;AACH,CAAC;AAbD,0CAaC"}