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

package/dist/client/js/main.js.LICENSE.txt

@@ -11,6 +11,12 @@
 
 /*! @silexlabs/grapesjs-loading - 1.0.8 */
 
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
 /**
  * @license
  * Copyright 2018 Google LLC

package/dist/client/types.d.ts

@@ -1,35 +1,9 @@
+/// <reference types="node" />
 /**
  * @fileoverview define types for Silex client and server
  */
-export declare const defaultPublicationSettings: PublicationSettings;
-export declare const defaultSite: WebsiteData;
-export interface WebsiteSettings {
-    description: string;
-    title: string;
-    lang: string;
-    head: string;
-    favicon: string;
-    'og:title': string;
-    'og:description': string;
-    'og:image': string;
-}
-export interface WebsiteData {
-    pages: Page[];
-    assets: Asset[];
-    styles: Style[];
-    name: string;
-    settings: WebsiteSettings;
-    fonts: Font[];
-    symbols: symbol[];
-    publication: PublicationSettings;
-}
-export interface Font {
-    name: string;
-    value: string;
-    variants: string[];
-}
 export interface PublicationSettings {
-    path?: string;
+    backend?: BackendData;
     url?: string;
     autoHomePage?: boolean;
     assets?: {
@@ -46,12 +20,118 @@ export interface PublicationSettings {
         ext?: string;
     };
 }
-export interface File {
+export interface WebsiteFile {
     html: string;
     css: string;
     htmlPath: string;
     cssPath: string;
 }
+export type ApiResponseError = {
+    message: string;
+};
+export type ApiPublicationPublishRequestBody = WebsiteData;
+export type ApiPublicationPublishRequestQuery = {
+    id: WebsiteId;
+};
+export type ApiPublicationPublishResponse = {
+    url: string;
+    job: PublicationJobData;
+};
+export type ApiPublicationStatusRequestQuery = {
+    jobId: JobId;
+};
+export type ApiPublicationStatusResponse = PublicationJobData;
+export type ApiWebsiteReadRequestQuery = {
+    id?: WebsiteId;
+    backendId?: BackendId;
+};
+export type ApiWebsiteReadResponse = WebsiteMeta[] | WebsiteData;
+export type ApiWebsiteWriteRequestQuery = {
+    id: WebsiteId;
+    backendId?: BackendId;
+};
+export type ApiWebsiteWriteRequestBody = WebsiteData;
+export type ApiWebsiteWriteResponse = {
+    message: string;
+};
+export type ApiWebsiteDeleteRequestQuery = {
+    id: WebsiteId;
+    backendId?: BackendId;
+};
+export type ApiWebsiteAssetsReadRequestQuery = {
+    id: WebsiteId;
+    backendId?: BackendId;
+};
+export type ApiWebsiteAssetsReadRequestParams = {
+    path: string;
+};
+export type ApiWebsiteAssetsReadResponse = string;
+export type ApiWebsiteAssetsWriteRequestQuery = {
+    id: WebsiteId;
+    backendId?: BackendId;
+};
+export type ApiWebsiteAssetsWriteRequestBody = ClientSideFile[];
+export type ApiWebsiteAssetsWriteResponse = {
+    data: string[];
+};
+export type ApiBackendListRequestQuery = {
+    type: BackendType;
+};
+export type ApiBackendListResponse = BackendData[];
+export type ApiBackendLoginRequestQuery = {
+    backendId: BackendId;
+    type: BackendType;
+    options?: string;
+    error?: string;
+};
+export type ApiBackendLoggedInPostMessage = {
+    type: string;
+    error: boolean;
+    message: string;
+    backendId: BackendId;
+};
+export type ApiBackendLogoutRequestQuery = {
+    backendId: BackendId;
+    type: BackendType;
+};
+export type ApiBackendLoginStatusRequestQuery = {
+    id?: WebsiteId;
+    backendId?: BackendId;
+    type: BackendType;
+};
+export type ApiBackendLoginStatusResponse = {
+    user: BackendUser;
+    backend: BackendData;
+    websiteMeta?: WebsiteMeta;
+};
+export interface WebsiteData {
+    pages: Page[];
+    assets: Asset[];
+    styles: Style[];
+    name: string;
+    settings: WebsiteSettings;
+    fonts: Font[];
+    symbols: symbol[];
+    publication: PublicationSettings;
+}
+export interface PublicationData extends WebsiteData {
+    files?: WebsiteFile[];
+}
+export interface WebsiteSettings {
+    description: string;
+    title: string;
+    lang: string;
+    head: string;
+    favicon: string;
+    'og:title': string;
+    'og:description': string;
+    'og:image': string;
+}
+export interface Font {
+    name: string;
+    value: string;
+    variants: string[];
+}
 export interface Page {
     name?: string;
     id: string;
@@ -97,3 +177,94 @@ export type Selector = string | {
     name: string;
     type: number;
 };
+/**
+ * Type for a backend id
+ */
+export type BackendId = string;
+/**
+ * Type for a client side file
+ * @see backend/File
+ */
+export interface ClientSideFile {
+    path: string;
+    content: Buffer | string;
+}
+/**
+ * Type for file listing
+ */
+export interface FileMeta {
+    name: string;
+    isDir: boolean;
+    size: number;
+    createdAt: Date;
+    updatedAt: Date;
+    metadata?: object;
+}
+/**
+ * Enum to express if the backend is a storage or a hosting
+ */
+export declare enum BackendType {
+    STORAGE = "STORAGE",
+    HOSTING = "HOSTING"
+}
+/**
+ * Type for a website id
+ */
+export type WebsiteId = string;
+/**
+ * Back end data sent to the front end
+ */
+export interface BackendData {
+    backendId: BackendId;
+    type: BackendType;
+    displayName: string;
+    icon: string;
+    disableLogout: boolean;
+    isLoggedIn: boolean;
+    authUrl: string | null;
+}
+/**
+ * Back end data sent to the front end
+ */
+export interface BackendUser {
+    name: string;
+    email?: string;
+    picture?: string;
+    metadata?: object;
+}
+/**
+ * Back end data sent to the front end
+ * Meta data can be the root path of the websites, or the bucket name, etc.
+ */
+export interface WebsiteMeta {
+    websiteId: WebsiteId;
+    createdAt: Date;
+    updatedAt: Date;
+    metadata?: object;
+}
+/**
+ * Enum to express if the job is in progress or finished or errored
+ */
+export declare enum JobStatus {
+    IN_PROGRESS = "IN_PROGRESS",
+    SUCCESS = "SUCCESS",
+    ERROR = "ERROR"
+}
+/**
+ * Id used to track the progress of a publication
+ */
+export type JobId = string;
+/**
+ * Data structure which is sent to the client to display the progress of a job
+ */
+export interface JobData {
+    jobId: JobId;
+    status: JobStatus;
+    message: string;
+    url?: string;
+    _timeout?: ReturnType<typeof setTimeout>;
+}
+export interface PublicationJobData extends JobData {
+    logs: string[][];
+    errors: string[][];
+}

package/dist/constants.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @fileoverview define constants for Silex client and server
+ */
+export declare const WEBSITE_DATA_FILE_NAME = "website.json";
+export declare const DEFAULT_WEBSITE_ID = "default";
+export declare const DEFAULT_BACKEND_ID = "";
+export declare const DEFAULT_LANGUAGE = "en";
+export declare const CLIENT_CONFIG_FILE_NAME = "silex.js";
+export declare const API_BACKEND_LOGIN_STATUS = "api/backend/login/status/";
+export declare const API_BACKEND_LIST = "api/backend/";
+export declare const API_BACKEND_LOGOUT = "api/backend/logout/";
+export declare const API_BACKEND_LOGIN = "api/backend/login/";
+export declare const API_BACKEND_LOGIN_CALLBACK = "api/backend/login/";
+export declare const API_PUBLICATION_PUBLISH = "api/publication/";
+export declare const API_PUBLICATION_STATUS = "/api/publication/status/";
+export declare const API_WEBSITE_READ = "api/website/";
+export declare const API_WEBSITE_WRITE = "api/website/";
+export declare const API_WEBSITE_DELETE = "api/website/";
+export declare const API_WEBSITE_LIST = "api/website/";
+export declare const API_WEBSITE_ASSETS_READ = "assets/:path";
+export declare const API_WEBSITE_ASSETS_WRITE = "assets/";

package/dist/constants.js

@@ -1,4 +1,41 @@
 "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.CLIENT_CONFIG_FILE_NAME = void 0;
+exports.API_WEBSITE_ASSETS_WRITE = exports.API_WEBSITE_ASSETS_READ = exports.API_WEBSITE_LIST = exports.API_WEBSITE_DELETE = exports.API_WEBSITE_WRITE = exports.API_WEBSITE_READ = exports.API_PUBLICATION_STATUS = exports.API_PUBLICATION_PUBLISH = exports.API_BACKEND_LOGIN_CALLBACK = exports.API_BACKEND_LOGIN = exports.API_BACKEND_LOGOUT = exports.API_BACKEND_LIST = exports.API_BACKEND_LOGIN_STATUS = exports.CLIENT_CONFIG_FILE_NAME = exports.DEFAULT_LANGUAGE = exports.DEFAULT_BACKEND_ID = exports.DEFAULT_WEBSITE_ID = exports.WEBSITE_DATA_FILE_NAME = void 0;
+/**
+ * @fileoverview define constants for Silex client and server
+ */
+exports.WEBSITE_DATA_FILE_NAME = 'website.json';
+exports.DEFAULT_WEBSITE_ID = 'default';
+exports.DEFAULT_BACKEND_ID = '';
+exports.DEFAULT_LANGUAGE = 'en';
 exports.CLIENT_CONFIG_FILE_NAME = 'silex.js';
+exports.API_BACKEND_LOGIN_STATUS = 'api/backend/login/status/';
+exports.API_BACKEND_LIST = 'api/backend/';
+exports.API_BACKEND_LOGOUT = 'api/backend/logout/';
+exports.API_BACKEND_LOGIN = 'api/backend/login/';
+exports.API_BACKEND_LOGIN_CALLBACK = 'api/backend/login/';
+exports.API_PUBLICATION_PUBLISH = 'api/publication/';
+exports.API_PUBLICATION_STATUS = '/api/publication/status/';
+exports.API_WEBSITE_READ = 'api/website/';
+exports.API_WEBSITE_WRITE = 'api/website/';
+exports.API_WEBSITE_DELETE = 'api/website/';
+exports.API_WEBSITE_LIST = 'api/website/';
+exports.API_WEBSITE_ASSETS_READ = 'assets/:path';
+exports.API_WEBSITE_ASSETS_WRITE = 'assets/';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/ts/constants.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH;;GAEG;AAEU,QAAA,sBAAsB,GAAG,cAAc,CAAA;AAEvC,QAAA,kBAAkB,GAAG,SAAS,CAAA;AAC9B,QAAA,kBAAkB,GAAG,EAAE,CAAA;AACvB,QAAA,gBAAgB,GAAG,IAAI,CAAA;AACvB,QAAA,uBAAuB,GAAG,UAAU,CAAA;AAEpC,QAAA,wBAAwB,GAAG,2BAA2B,CAAA;AACtD,QAAA,gBAAgB,GAAG,cAAc,CAAA;AACjC,QAAA,kBAAkB,GAAG,qBAAqB,CAAA;AAC1C,QAAA,iBAAiB,GAAG,oBAAoB,CAAA;AACxC,QAAA,0BAA0B,GAAG,oBAAoB,CAAA;AAEjD,QAAA,uBAAuB,GAAG,kBAAkB,CAAA;AAC5C,QAAA,sBAAsB,GAAG,0BAA0B,CAAA;AAEnD,QAAA,gBAAgB,GAAG,cAAc,CAAA;AACjC,QAAA,iBAAiB,GAAG,cAAc,CAAA;AAClC,QAAA,kBAAkB,GAAG,cAAc,CAAA;AACnC,QAAA,gBAAgB,GAAG,cAAc,CAAA;AACjC,QAAA,uBAAuB,GAAG,cAAc,CAAA;AACxC,QAAA,wBAAwB,GAAG,SAAS,CAAA"}

package/dist/events.d.ts

@@ -0,0 +1,2 @@
+export declare const EVENT_STARTUP_START = "silex:startup:start";
+export declare const EVENT_STARTUP_END = "silex:startup:end";

package/dist/events.js

@@ -1,5 +1,22 @@
 "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.EVENT_STARTUP_END = exports.EVENT_STARTUP_START = void 0;
 exports.EVENT_STARTUP_START = 'silex:startup:start';
 exports.EVENT_STARTUP_END = 'silex:startup:end';
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/ts/events.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEU,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AAC3C,QAAA,iBAAiB,GAAG,mBAAmB,CAAA"}

package/dist/plugins/AuthPlugin.d.ts

@@ -0,0 +1 @@
+export default function (config: any, opts?: {}): Promise<void>;

package/dist/plugins/AuthPlugin.js

@@ -0,0 +1,38 @@
+"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 });
+async function default_1(config, opts = {}) {
+    //  config.on('silex:startup:start', ({app}) => {
+    //    const router = express.Router()
+    //    router.post(['/publish', '/website', '/assets'], async function(req, res, next) {
+    //      try {
+    //        const token = req.body.token || opts.directusToken
+    //        const directus = new Directus(opts.directusUrl)
+    //        directus.storage.auth_token = token
+    //        const me = await directus.users.me.read()
+    //        next()
+    //      } catch(err) {
+    //        console.error('Publish failed in auth module. Did you provide a directus token?', err.message)
+    //        res.status(403).json({ message: err.message })
+    //      }
+    //    })
+    //    app.use(router)
+    //  })
+}
+exports.default = default_1;
+//# sourceMappingURL=AuthPlugin.js.map

package/dist/plugins/AuthPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthPlugin.js","sourceRoot":"","sources":["../../src/ts/plugins/AuthPlugin.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAKY,KAAK,oBAAU,MAAM,EAAE,IAAI,GAAG,EAAE;IAC/C,iDAAiD;IACjD,qCAAqC;IACrC,uFAAuF;IACvF,aAAa;IACb,4DAA4D;IAC5D,yDAAyD;IACzD,6CAA6C;IAC7C,mDAAmD;IACnD,gBAAgB;IAChB,sBAAsB;IACtB,wGAAwG;IACxG,wDAAwD;IACxD,SAAS;IACT,QAAQ;IACR,qBAAqB;IACrB,MAAM;AACN,CAAC;AAjBD,4BAiBC"}

package/dist/plugins/Cache.d.ts

@@ -0,0 +1,2 @@
+export declare function noCache(req: any, res: any, next: any): void;
+export declare function withCache(req: any, res: any, next: any): void;

package/dist/plugins/Cache.js

@@ -0,0 +1,32 @@
+"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.withCache = exports.noCache = void 0;
+function noCache(req, res, next) {
+    res.header('Cache-Control', 'private,no-cache,no-store,must-revalidate,proxy-revalidate');
+    res.header('Expires', '-1');
+    res.header('Pragma', 'no-cache');
+    next();
+}
+exports.noCache = noCache;
+function withCache(req, res, next) {
+    res.header('Cache-Control', 'public,max-age=86400,immutable'); // 24h
+    next();
+}
+exports.withCache = withCache;
+//# sourceMappingURL=Cache.js.map

package/dist/plugins/Cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cache.js","sourceRoot":"","sources":["../../src/ts/plugins/Cache.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,SAAgB,OAAO,CAAE,GAAG,EAAE,GAAG,EAAE,IAAI;IACrC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,4DAA4D,CAAC,CAAA;IACzF,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;IAC3B,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;IAChC,IAAI,EAAE,CAAA;AACR,CAAC;AALD,0BAKC;AAED,SAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI;IACtC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,gCAAgC,CAAC,CAAA,CAAC,MAAM;IACpE,IAAI,EAAE,CAAA;AACR,CAAC;AAHD,8BAGC"}

package/dist/plugins/FtpBackend.d.ts

@@ -0,0 +1,92 @@
+import { File, HostingProvider, StatusCallback, StorageProvider } from '../server/backends';
+import { BackendData, BackendType, BackendUser, WebsiteMeta, FileMeta, JobData, WebsiteId } from '../types';
+import { ServerConfig } from '../server/config';
+/**
+ * @fileoverview FTP backend for Silex
+ * This is a backend for Silex, which allows to store the website on a FTP server
+ *   and to publish the website on a FTP server
+ * FIXME: As a hosting provider, this backend should only store the password in the session and the rest in the website data
+ *   to prevent publishing a site on the wrong server + multiple sites on 1 server
+ * FIXME: Allow reuse of FTP session between calls
+ */
+export interface FtpSessionData {
+    host: string;
+    user: string;
+    pass: string;
+    port: number;
+    secure: boolean;
+    storageRootPath?: string;
+    publicationPath?: string;
+    websiteUrl?: string;
+}
+export interface FtpSession {
+    [BackendType.STORAGE]?: FtpSessionData;
+    [BackendType.HOSTING]?: FtpSessionData;
+}
+interface FtpOptions {
+    type: BackendType;
+    rootPath?: string;
+    authorizeUrl?: string;
+    authorizePath?: string;
+}
+interface FtpOptionsWithDefaults {
+    type: BackendType;
+    rootPath: string;
+    authorizeUrl: string;
+    authorizePath: string;
+}
+/**
+ * @class FtpBackend
+ * @implements {HostingProvider}
+ * @implements {StorageProvider}
+ */
+export default class FtpBackend implements HostingProvider<FtpSession>, StorageProvider<FtpSession> {
+    id: string;
+    displayName: string;
+    icon: string;
+    options: FtpOptionsWithDefaults;
+    type: BackendType;
+    constructor(config: ServerConfig, opts: FtpOptions);
+    sessionData(session: FtpSession): FtpSessionData;
+    storageRootPath(session: FtpSession): string;
+    checkAuth({ host, user, pass, port, secure }: {
+        host: any;
+        user: any;
+        pass: any;
+        port: any;
+        secure: any;
+    }): Promise<void>;
+    authorizeForm(session: FtpSession, query: {
+        error: string;
+        type: string;
+    }): Promise<string>;
+    getClient({ host, user, pass, port, secure }: {
+        host: any;
+        user: any;
+        pass: any;
+        port: any;
+        secure: any;
+    }): Promise<any>;
+    authorize(session: FtpSession, body: any): Promise<FtpSession>;
+    getUserData(session: FtpSession): Promise<BackendUser>;
+    getSiteMeta(session: FtpSession, id: WebsiteId): Promise<WebsiteMeta>;
+    isLoggedIn(session: FtpSession): Promise<boolean>;
+    getAuthorizeURL(session: FtpSession): Promise<string>;
+    logout(session: FtpSession): Promise<void>;
+    getAdminUrl(session: FtpSession, id: WebsiteId): Promise<any>;
+    /**
+     * Create necessary folders
+     * Assets and root folders
+     */
+    init(session: FtpSession, id: WebsiteId): Promise<void>;
+    readFile(session: FtpSession, id: string, path: string): Promise<File>;
+    writeFiles(session: any, id: WebsiteId, files: File[], statusCbk?: StatusCallback): Promise<string[]>;
+    deleteFiles(session: FtpSession, id: any, paths: any): Promise<void>;
+    listWebsites(session: FtpSession): Promise<WebsiteMeta[]>;
+    listDir(session: FtpSession, id: WebsiteId, path: string): Promise<FileMeta[]>;
+    createDir(session: FtpSession, id: WebsiteId, path: string): Promise<void>;
+    deleteDir(session: FtpSession, id: WebsiteId, path: string): Promise<void>;
+    getWebsiteUrl(session: FtpSession, id: WebsiteId): Promise<string>;
+    publish(session: FtpSession, id: string, backendData: BackendData, files: File[]): Promise<JobData>;
+}
+export {};