@silexlabs/silex 3.0.0-alpha.40 → 3.0.0-alpha.42

package/.silex.js

@@ -1,11 +1,32 @@
-module.exports = function (silexConfig, options) {
-  silexConfig.addPlugin([
-    __dirname + '/src/plugins/ExpressPlugin.js',
-    __dirname + '/src/plugins/SslPlugin.js',
-    __dirname + '/src/plugins/StaticPlugin.js',
-    __dirname + '/src/plugins/WebsitePlugin.js',
-    __dirname + '/src/plugins/PublishPlugin.js',
-  ])
+/*
+ * 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/>.
+ */
+
+const SslPlugin = require('./dist/plugins/server/plugins/server/SslPlugin').default
+const StaticPlugin = require('./dist/plugins/server/plugins/server/StaticPlugin').default
+
+module.exports = async function(config, options) {
+  try {
+    await config.addPlugin([
+      SslPlugin,
+      StaticPlugin,
+    ])
+  } catch(e) {
+    console.error(e)
+  }
 
   // Return an object to be merged with Silex config
   return {}

package/dist/client/client/api.d.ts

@@ -0,0 +1,83 @@
+import { ConnectorId, JobId, PublicationJobData, WebsiteId, ConnectorData, ConnectorType, WebsiteData, ClientSideFile, PublicationData, ConnectorUser, WebsiteMeta, WebsiteMetaFileContent, ConnectorOptions } from '../types';
+export declare enum ApiRoute {
+    PUBLICATION_PUBLISH = "/api/publication/",
+    PUBLICATION_STATUS = "/api/publication/publication/status",
+    CONNECTOR_USER = "/api/connector/user",
+    CONNECTOR_LOGOUT = "/api/connector/logout",
+    CONNECTOR_LIST = "/api/connector/",
+    WEBSITE_READ = "/api/website/",
+    WEBSITE_WRITE = "/api/website/",
+    WEBSITE_DELETE = "/api/website/",
+    WEBSITE_CREATE = "/api/website/",
+    WEBSITE_LIST = "/api/website/",
+    WEBSITE_ASSETS_READ = "/api/websiteassets/:path",
+    WEBSITE_ASSETS_WRITE = "/api/websiteassets",
+    WEBSITE_META_READ = "/api/website/meta",
+    WEBSITE_META_WRITE = "/api/website/meta"
+}
+export declare class ApiError extends Error {
+    readonly code: number;
+    constructor(message: string, code: number);
+}
+export declare function getUser({ type, connectorId }: {
+    type: ConnectorType;
+    connectorId?: ConnectorId;
+}): Promise<ConnectorUser>;
+export declare function logout({ type, connectorId }: {
+    type: ConnectorType;
+    connectorId?: ConnectorId;
+}): Promise<void>;
+export declare function publish({ websiteId, hostingId, storageId, data, options }: {
+    websiteId: WebsiteId;
+    hostingId: ConnectorId;
+    storageId: ConnectorId;
+    data: PublicationData;
+    options: ConnectorOptions;
+}): Promise<[url: string, job: PublicationJobData]>;
+export declare function publicationStatus({ jobId }: {
+    jobId: JobId;
+}): Promise<PublicationJobData>;
+export declare function connectorList({ type }: {
+    type: ConnectorType;
+}): Promise<ConnectorData[]>;
+export declare function websiteList({ connectorId }: {
+    connectorId?: ConnectorId;
+}): Promise<WebsiteMeta[]>;
+export declare function websiteLoad({ websiteId, connectorId }: {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+}): Promise<WebsiteData>;
+export declare function websiteSave({ websiteId, data, connectorId }: {
+    websiteId: WebsiteId;
+    data: WebsiteData;
+    connectorId?: ConnectorId;
+}): Promise<void>;
+export declare function websiteDelete({ websiteId, connectorId }: {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+}): Promise<void>;
+export declare function websiteCreate({ websiteId, data, connectorId }: {
+    websiteId: WebsiteId;
+    data: WebsiteMetaFileContent;
+    connectorId?: ConnectorId;
+}): Promise<void>;
+export declare function websiteMetaWrite({ websiteId, data, connectorId }: {
+    websiteId: WebsiteId;
+    data: WebsiteMetaFileContent;
+    connectorId?: ConnectorId;
+}): Promise<void>;
+export declare function websiteMetaRead({ websiteId, connectorId }: {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+}): Promise<void>;
+export declare function websiteAssetsLoad({ path, websiteId, connectorId }: {
+    path: string;
+    websiteId: WebsiteId;
+    connectorId: ConnectorId;
+}): Promise<string>;
+export declare function websiteAssetsSave({ websiteId, connectorId, files }: {
+    websiteId: WebsiteId;
+    connectorId: ConnectorId;
+    files: ClientSideFile[];
+}): Promise<string[]>;
+export declare function api<ReqQuery, ReqBody, ResBody>(route: ApiRoute | string, method: string, query?: ReqQuery, payload?: ReqBody): Promise<ResBody>;

package/dist/client/client/config.d.ts

@@ -11,7 +11,7 @@ export declare class SilexConfig extends Config {
     /**
      * Grapesjs config
      */
-    editor: {
+    grapesJsConfig: {
         container: string;
         height: string;
         showOffsets: boolean;
@@ -29,23 +29,22 @@ export declare class SilexConfig extends Config {
             autoload: boolean;
             type: string;
             options: {
-                remote: {
-                    urlStore: string;
-                    urlLoad: string;
+                connector: {
+                    id: string;
+                    connectorId: string;
                 };
             };
         };
+        cssIcons: string;
         plugins: any[];
         pluginsOpts: {
-            [x: number]: {
+            [x: number]: import("./grapesjs/PublicationManager").PublicationManagerOptions | import("./grapesjs/LoginDialog").LoginDialogOptions | {
                 blocks: string[];
                 category: string;
                 panels?: undefined;
-                appendTo?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
                 cmdOpenNewPageDialog?: undefined;
                 cmdOpenSettings?: undefined;
+                appendTo?: undefined;
                 enableCount?: undefined;
                 enablePerformance?: undefined;
                 onError?: undefined;
@@ -125,26 +124,9 @@ export declare class SilexConfig extends Config {
                 })[];
                 blocks?: undefined;
                 category?: undefined;
-                appendTo?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
-                cmdOpenNewPageDialog?: undefined;
-                cmdOpenSettings?: undefined;
-                enableCount?: undefined;
-                enablePerformance?: undefined;
-                onError?: undefined;
-                blockLabel?: undefined;
-                blockCustomCode?: undefined;
-                api_key?: undefined;
-            } | {
-                appendTo: string;
-                rootUrl: string;
-                id: string;
-                blocks?: undefined;
-                category?: undefined;
-                panels?: undefined;
                 cmdOpenNewPageDialog?: undefined;
                 cmdOpenSettings?: undefined;
+                appendTo?: undefined;
                 enableCount?: undefined;
                 enablePerformance?: undefined;
                 onError?: undefined;
@@ -158,8 +140,6 @@ export declare class SilexConfig extends Config {
                 blocks?: undefined;
                 category?: undefined;
                 panels?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
                 enableCount?: undefined;
                 enablePerformance?: undefined;
                 onError?: undefined;
@@ -172,11 +152,9 @@ export declare class SilexConfig extends Config {
                 blocks?: undefined;
                 category?: undefined;
                 panels?: undefined;
-                appendTo?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
                 cmdOpenNewPageDialog?: undefined;
                 cmdOpenSettings?: undefined;
+                appendTo?: undefined;
                 onError?: undefined;
                 blockLabel?: undefined;
                 blockCustomCode?: undefined;
@@ -186,11 +164,9 @@ export declare class SilexConfig extends Config {
                 blocks?: undefined;
                 category?: undefined;
                 panels?: undefined;
-                appendTo?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
                 cmdOpenNewPageDialog?: undefined;
                 cmdOpenSettings?: undefined;
+                appendTo?: undefined;
                 enableCount?: undefined;
                 enablePerformance?: undefined;
                 blockLabel?: undefined;
@@ -204,11 +180,9 @@ export declare class SilexConfig extends Config {
                 blocks?: undefined;
                 category?: undefined;
                 panels?: undefined;
-                appendTo?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
                 cmdOpenNewPageDialog?: undefined;
                 cmdOpenSettings?: undefined;
+                appendTo?: undefined;
                 enableCount?: undefined;
                 enablePerformance?: undefined;
                 onError?: undefined;
@@ -218,8 +192,6 @@ export declare class SilexConfig extends Config {
                 blocks?: undefined;
                 category?: undefined;
                 panels?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
                 cmdOpenNewPageDialog?: undefined;
                 cmdOpenSettings?: undefined;
                 enableCount?: undefined;
@@ -233,11 +205,9 @@ export declare class SilexConfig extends Config {
                 blocks?: undefined;
                 category?: undefined;
                 panels?: undefined;
-                appendTo?: undefined;
-                rootUrl?: undefined;
-                id?: undefined;
                 cmdOpenNewPageDialog?: undefined;
                 cmdOpenSettings?: undefined;
+                appendTo?: undefined;
                 enableCount?: undefined;
                 enablePerformance?: undefined;
                 onError?: undefined;

package/dist/client/client/expose.d.ts

@@ -1,3 +1,9 @@
 export * from './index';
 export * from './grapesjs/index';
 export * from './config';
+export * as constants from '../constants';
+export * as utils from './utils';
+export * as api from './api';
+export * as events from '../events';
+export * as page from '../page';
+export * as types from '../types';

package/dist/client/client/grapesjs/LoginDialog.d.ts

@@ -0,0 +1,14 @@
+import { Editor } from 'grapesjs';
+import { ConnectorId, ConnectorType, ConnectorUser } from '../../types';
+import { WebsiteId } from '../../types';
+export declare const cmdLogin = "silex:auth:login";
+export declare const eventLoggingIn = "silex:auth:logging-in";
+export declare const eventLoggedIn = "silex:auth:logged-in";
+export declare const eventLoginFailed = "silex:auth:login-failed";
+export declare const eventLoggedOut = "silex:auth:logged-out";
+export interface LoginDialogOptions {
+    id: WebsiteId;
+}
+export declare function getCurrentUser(editor: Editor): Promise<ConnectorUser>;
+export declare function updateUser(editor: Editor, type: ConnectorType, connectorId?: ConnectorId): Promise<ConnectorUser>;
+export default function loginDialogPlugin(editor: any, opts: any): void;

package/dist/client/client/grapesjs/PublicationManager.d.ts

@@ -0,0 +1,75 @@
+import { ConnectorData, PublicationJobData, PublicationSettings, WebsiteId, WebsiteSettings } from '../../types';
+import { Editor } from 'grapesjs';
+import { PublicationUi } from './PublicationUi';
+/**
+ * @fileoverview Publication manager for Silex
+ * This plugin adds a publication feature to Silex
+ * It lets the user publish the website to a hosting service
+ * It can optionally display a button and a dialog
+ * Useful commands:
+ * - publish: starts the publication process and optionally open the dialog
+ * - publish-login: open the login dialog
+ * - publish-logout: logout from the hosting service and let the user choose a hosting service again
+ */
+export declare const cmdPublicationStart = "publish";
+export declare const cmdPublicationLogin = "publish-login";
+export declare const cmdPublicationLogout = "publish-logout";
+export type PublishableEditor = Editor & {
+    PublicationManager: PublicationManager;
+};
+export declare enum PublicationStatus {
+    STATUS_NONE = "STATUS_NONE",
+    STATUS_PENDING = "STATUS_PENDING",
+    STATUS_ERROR = "STATUS_ERROR",
+    STATUS_SUCCESS = "STATUS_SUCCESS",
+    STATUS_LOGGED_OUT = "STATUS_AUTH_ERROR"
+}
+export type PublicationManagerOptions = {
+    appendTo?: string;
+    websiteId: WebsiteId;
+};
+export default function publishPlugin(editor: any, opts: any): void;
+export declare class PublicationManager {
+    private editor;
+    /**
+     * Publication dialog
+     * This class is responsible for the  UI
+     */
+    dialog?: PublicationUi;
+    /**
+     * Publication settings
+     * This is the data which is stored in the website settings
+     */
+    _settings: PublicationSettings;
+    get settings(): PublicationSettings;
+    set settings(newSettings: PublicationSettings);
+    /**
+     * Plugin options
+     * This is the data which is passed to the plugin by grapesjs
+     */
+    options: PublicationManagerOptions;
+    /**
+     * Publication job during the publication process
+     */
+    job: PublicationJobData | null;
+    /**
+     * Publication state
+     * This is the state of the publication process
+     */
+    status: PublicationStatus;
+    constructor(editor: PublishableEditor, opts: PublicationManagerOptions);
+    goLogin(connector: ConnectorData): Promise<unknown>;
+    goLogout(): Promise<void>;
+    /**
+     * Start the publication process
+     * This is the command "publish"
+     */
+    startPublication(): Promise<void>;
+    getFiles(siteSettings: WebsiteSettings): Promise<{
+        html: string;
+        css: string;
+        cssPath: string;
+        htmlPath: string;
+    }[]>;
+    trackProgress(): Promise<void>;
+}

package/dist/client/client/grapesjs/PublicationUi.d.ts

@@ -0,0 +1,61 @@
+import { TemplateResult } from 'lit-html';
+import { PublicationStatus, PublishableEditor } from './PublicationManager';
+import { PublicationJobData, PublicationSettings } from '../../types';
+/**
+ * @fileoverview define the publication dialog
+ * This is the UI of the publication feature
+ * It is a dialog which allows the user to login to a connector and publish the website
+ * It also displays the publication status and logs during the publication process
+ * This class is used by the PublicationManager
+ * This is optional, you can use the PublicationManager without this UI
+ * @TODO Use publication events instead of calls from the PublicationManager
+ */
+export declare const cmdPublish = "publish-open-dialog";
+export type PublicationDialogOptions = {
+    appendTo: string;
+};
+/**
+ * Class to manage the publication dialog
+ */
+export declare class PublicationUi {
+    private editor;
+    private options;
+    /**
+     * Dialog state
+     */
+    isOpen: boolean;
+    /**
+     * Dialog content
+     */
+    private errorMessage;
+    /**
+     * Dialog element
+     * This is the DOM element of the dialog
+     */
+    private el;
+    settings: PublicationSettings;
+    /**
+     * Initialize the dialog and the publish button
+     */
+    constructor(editor: PublishableEditor, options: PublicationDialogOptions);
+    isSuccess(status: PublicationStatus): boolean;
+    isPending(status: PublicationStatus): boolean;
+    isError(status: PublicationStatus): boolean;
+    isLoggedOut(status: PublicationStatus): boolean;
+    isReady(status: PublicationStatus): boolean;
+    getDialogElements(): {
+        el: HTMLElement;
+        primary: HTMLElement;
+        secondary: HTMLElement;
+    };
+    createDialogElements(): HTMLElement;
+    move(rect: any): void;
+    private renderDialog;
+    renderOpenDialog(job: PublicationJobData, status: PublicationStatus): Promise<TemplateResult>;
+    renderLoginDialog(status: PublicationStatus): Promise<TemplateResult>;
+    displayPending(job: PublicationJobData, status: PublicationStatus): void;
+    displayError(message: string, job: PublicationJobData, status: PublicationStatus): void;
+    closeDialog(): Promise<void>;
+    toggleDialog(): Promise<void>;
+    openDialog(): Promise<void>;
+}

package/dist/client/client/grapesjs/index.d.ts

@@ -1,4 +1,8 @@
-export declare function getEditorConfig(id: string, rootUrl: string): {
+import { Editor } from 'grapesjs';
+import { LoginDialogOptions } from './LoginDialog';
+import { PublicationManagerOptions } from './PublicationManager';
+import { ConnectorId, WebsiteId } from '../../types';
+export declare function getEditorConfig(id: WebsiteId, connectorId: ConnectorId, rootUrl: string): {
     container: string;
     height: string;
     showOffsets: boolean;
@@ -16,23 +20,22 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
         autoload: boolean;
         type: string;
         options: {
-            remote: {
-                urlStore: string;
-                urlLoad: string;
+            connector: {
+                id: string;
+                connectorId: string;
             };
         };
     };
+    cssIcons: string;
     plugins: any[];
     pluginsOpts: {
-        [x: number]: {
+        [x: number]: PublicationManagerOptions | LoginDialogOptions | {
             blocks: string[];
             category: string;
             panels?: undefined;
-            appendTo?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
             cmdOpenNewPageDialog?: undefined;
             cmdOpenSettings?: undefined;
+            appendTo?: undefined;
             enableCount?: undefined;
             enablePerformance?: undefined;
             onError?: undefined;
@@ -112,26 +115,9 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
             })[];
             blocks?: undefined;
             category?: undefined;
-            appendTo?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
-            cmdOpenNewPageDialog?: undefined;
-            cmdOpenSettings?: undefined;
-            enableCount?: undefined;
-            enablePerformance?: undefined;
-            onError?: undefined;
-            blockLabel?: undefined;
-            blockCustomCode?: undefined;
-            api_key?: undefined;
-        } | {
-            appendTo: string;
-            rootUrl: string;
-            id: string;
-            blocks?: undefined;
-            category?: undefined;
-            panels?: undefined;
             cmdOpenNewPageDialog?: undefined;
             cmdOpenSettings?: undefined;
+            appendTo?: undefined;
             enableCount?: undefined;
             enablePerformance?: undefined;
             onError?: undefined;
@@ -145,8 +131,6 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
             blocks?: undefined;
             category?: undefined;
             panels?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
             enableCount?: undefined;
             enablePerformance?: undefined;
             onError?: undefined;
@@ -159,11 +143,9 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
             blocks?: undefined;
             category?: undefined;
             panels?: undefined;
-            appendTo?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
             cmdOpenNewPageDialog?: undefined;
             cmdOpenSettings?: undefined;
+            appendTo?: undefined;
             onError?: undefined;
             blockLabel?: undefined;
             blockCustomCode?: undefined;
@@ -173,11 +155,9 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
             blocks?: undefined;
             category?: undefined;
             panels?: undefined;
-            appendTo?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
             cmdOpenNewPageDialog?: undefined;
             cmdOpenSettings?: undefined;
+            appendTo?: undefined;
             enableCount?: undefined;
             enablePerformance?: undefined;
             blockLabel?: undefined;
@@ -191,11 +171,9 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
             blocks?: undefined;
             category?: undefined;
             panels?: undefined;
-            appendTo?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
             cmdOpenNewPageDialog?: undefined;
             cmdOpenSettings?: undefined;
+            appendTo?: undefined;
             enableCount?: undefined;
             enablePerformance?: undefined;
             onError?: undefined;
@@ -205,8 +183,6 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
             blocks?: undefined;
             category?: undefined;
             panels?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
             cmdOpenNewPageDialog?: undefined;
             cmdOpenSettings?: undefined;
             enableCount?: undefined;
@@ -220,11 +196,9 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
             blocks?: undefined;
             category?: undefined;
             panels?: undefined;
-            appendTo?: undefined;
-            rootUrl?: undefined;
-            id?: undefined;
             cmdOpenNewPageDialog?: undefined;
             cmdOpenSettings?: undefined;
+            appendTo?: undefined;
             enableCount?: undefined;
             enablePerformance?: undefined;
             onError?: undefined;
@@ -233,5 +207,5 @@ export declare function getEditorConfig(id: string, rootUrl: string): {
         };
     };
 };
-export declare function initEditor(config: any, grapesJsPlugins: any): void;
-export declare function getEditor(): any;
+export declare function initEditor(config: any, grapesJsPlugins: any): Promise<Editor>;
+export declare function getEditor(): Editor;

package/dist/client/client/grapesjs/openImport.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @fileoverview Import feature
+ * Let the user import HTML code when she creates a new page
+ *
+ */
 export default function openImport(editor: any, config: any): {
     run(_: any): void;
     stop(): void;

package/dist/client/client/grapesjs/storage.d.ts

@@ -0,0 +1 @@
+export declare const storagePlugin: (editor: any) => void;

package/dist/client/constants.d.ts

@@ -1,4 +1,30 @@
 /**
  * @fileoverview define constants for Silex client and server
  */
+export declare const WEBSITE_DATA_FILE = "website.json";
+export declare const WEBSITE_META_DATA_FILE = "meta.json";
+export declare const DEFAULT_WEBSITE_ID = "default";
+export declare const DEFAULT_CONNECTOR_ID = "";
+export declare const DEFAULT_LANGUAGE = "en";
 export declare const CLIENT_CONFIG_FILE_NAME = "silex.js";
+export declare const API_PATH = "/api";
+export declare const API_CONNECTOR_PATH = "/connector";
+export declare const API_CONNECTOR_USER = "/user";
+export declare const API_CONNECTOR_LIST = "/";
+export declare const API_CONNECTOR_LOGOUT = "/logout";
+export declare const API_CONNECTOR_LOGIN = "/login";
+export declare const API_CONNECTOR_SETTINGS = "/settings";
+export declare const API_CONNECTOR_LOGIN_CALLBACK = "/login/callback";
+export declare const API_PUBLICATION_PATH = "/publication";
+export declare const API_PUBLICATION_PUBLISH = "/";
+export declare const API_PUBLICATION_STATUS = "/publication/status";
+export declare const API_WEBSITE_PATH = "/website";
+export declare const API_WEBSITE_READ = "/";
+export declare const API_WEBSITE_WRITE = "/";
+export declare const API_WEBSITE_CREATE = "/";
+export declare const API_WEBSITE_DELETE = "/";
+export declare const API_WEBSITE_LIST = "/";
+export declare const API_WEBSITE_ASSETS_READ = "assets/:path";
+export declare const API_WEBSITE_ASSETS_WRITE = "assets";
+export declare const API_WEBSITE_META_READ = "/meta";
+export declare const API_WEBSITE_META_WRITE = "/meta";