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

package/.silex.js

@@ -15,23 +15,14 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-const SslPlugin = require('./dist/plugins/SslPlugin').default
-const StaticPlugin = require('./dist/plugins/StaticPlugin').default
-const WebsitePlugin = require('./dist/plugins/WebsitePlugin').default
-const PublicationPlugin = require('./dist/plugins/PublicationPlugin').default
+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 {
-    if(!SslPlugin) throw new Error('SslPlugin not found')
-    if(!StaticPlugin) throw new Error('StaticPlugin not found')
-    if(!WebsitePlugin) throw new Error('WebsitePlugin not found')
-    if(!PublicationPlugin) throw new Error('PublicationPlugin not found')
-
     await config.addPlugin([
       SslPlugin,
       StaticPlugin,
-      WebsitePlugin,
-      PublicationPlugin,
     ])
   } catch(e) {
     console.error(e)

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,9 +29,9 @@ export declare class SilexConfig extends Config {
             autoload: boolean;
             type: string;
             options: {
-                backend: {
+                connector: {
                     id: string;
-                    backendId: string;
+                    connectorId: string;
                 };
             };
         };

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

@@ -1,5 +1,5 @@
 import { Editor } from 'grapesjs';
-import { LoginStatus } from '../services';
+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";
@@ -9,5 +9,6 @@ export declare const eventLoggedOut = "silex:auth:logged-out";
 export interface LoginDialogOptions {
     id: WebsiteId;
 }
-export declare function getCurrentLoginStatus(editor: Editor): Promise<LoginStatus>;
+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

@@ -1,4 +1,4 @@
-import { BackendData, PublicationJobData, PublicationSettings, WebsiteId, WebsiteSettings } from '../../types';
+import { ConnectorData, PublicationJobData, PublicationSettings, WebsiteId, WebsiteSettings } from '../../types';
 import { Editor } from 'grapesjs';
 import { PublicationUi } from './PublicationUi';
 /**
@@ -40,7 +40,9 @@ export declare class PublicationManager {
      * Publication settings
      * This is the data which is stored in the website settings
      */
-    settings: PublicationSettings;
+    _settings: PublicationSettings;
+    get settings(): PublicationSettings;
+    set settings(newSettings: PublicationSettings);
     /**
      * Plugin options
      * This is the data which is passed to the plugin by grapesjs
@@ -56,8 +58,12 @@ export declare class PublicationManager {
      */
     status: PublicationStatus;
     constructor(editor: PublishableEditor, opts: PublicationManagerOptions);
-    goLogin(provider: BackendData): Promise<unknown>;
+    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;

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

@@ -4,10 +4,11 @@ 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 backend and publish the website
+ * 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 = {
@@ -22,7 +23,7 @@ export declare class PublicationUi {
     /**
      * Dialog state
      */
-    private isOpen;
+    isOpen: boolean;
     /**
      * Dialog content
      */
@@ -32,6 +33,7 @@ export declare class PublicationUi {
      * This is the DOM element of the dialog
      */
     private el;
+    settings: PublicationSettings;
     /**
      * Initialize the dialog and the publish button
      */
@@ -40,6 +42,7 @@ export declare class PublicationUi {
     isPending(status: PublicationStatus): boolean;
     isError(status: PublicationStatus): boolean;
     isLoggedOut(status: PublicationStatus): boolean;
+    isReady(status: PublicationStatus): boolean;
     getDialogElements(): {
         el: HTMLElement;
         primary: HTMLElement;
@@ -48,10 +51,10 @@ export declare class PublicationUi {
     createDialogElements(): HTMLElement;
     move(rect: any): void;
     private renderDialog;
-    renderOpenDialog(job: PublicationJobData, status: PublicationStatus, settings: PublicationSettings): Promise<TemplateResult>;
-    renderLoginDialog(status: PublicationStatus, settings: PublicationSettings): Promise<TemplateResult>;
-    displayPending(job: PublicationJobData, status: PublicationStatus, settings: PublicationSettings): void;
-    displayError(message: string, job: PublicationJobData, status: PublicationStatus, settings: PublicationSettings): void;
+    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,8 +1,8 @@
 import { Editor } from 'grapesjs';
 import { LoginDialogOptions } from './LoginDialog';
 import { PublicationManagerOptions } from './PublicationManager';
-import { BackendId, WebsiteId } from '../../types';
-export declare function getEditorConfig(id: WebsiteId, backendId: BackendId, rootUrl: string): {
+import { ConnectorId, WebsiteId } from '../../types';
+export declare function getEditorConfig(id: WebsiteId, connectorId: ConnectorId, rootUrl: string): {
     container: string;
     height: string;
     showOffsets: boolean;
@@ -20,9 +20,9 @@ export declare function getEditorConfig(id: WebsiteId, backendId: BackendId, roo
         autoload: boolean;
         type: string;
         options: {
-            backend: {
+            connector: {
                 id: string;
-                backendId: string;
+                connectorId: string;
             };
         };
     };

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/constants.d.ts

@@ -1,21 +1,30 @@
 /**
  * @fileoverview define constants for Silex client and server
  */
-export declare const WEBSITE_DATA_FILE_NAME = "website.json";
+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_BACKEND_ID = "";
+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_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_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_ASSETS_WRITE = "assets";
+export declare const API_WEBSITE_META_READ = "/meta";
+export declare const API_WEBSITE_META_WRITE = "/meta";

package/dist/client/events.d.ts

@@ -1,2 +1,10 @@
 export declare const EVENT_STARTUP_START = "silex:startup:start";
 export declare const EVENT_STARTUP_END = "silex:startup:end";
+export declare const EVENT_PUBLISH_START = "silex:publish:start";
+export declare const EVENT_PUBLISH_DATA = "silex:publish:data";
+export declare const EVENT_PUBLISH_END = "silex:publish:end";
+export declare const EVENT_PUBLISH_ERROR = "silex:publish:error";
+export declare const EVENT_PUBLISH_LOGIN_START = "silex:publish:login:start";
+export declare const EVENT_PUBLISH_LOGIN_END = "silex:publish:login:end";
+export declare const EVENT_ASSET_WRITE_END = "silex:asset:write:end";
+export declare const EVENT_WRITE_END = "silex:write:end";