@silexlabs/silex 3.0.1-alpha.0 → 3.0.2

package/dist/plugins/server/plugins/server/DownloadConnector.d.ts

@@ -0,0 +1,29 @@
+import { ConnectorOptions, ConnectorType, ConnectorUser, JobData, PublicationJobData, WebsiteId } from '../../types';
+import { ConnectorFile, ConnectorSession, HostingConnector } from '../../server/connectors/connectors';
+import { JobManager } from '../../server/jobs';
+import { ServerConfig } from '../../server/config';
+type DownloadConnectorSession = ConnectorSession;
+type DownloadConnectorOptions = object;
+export default class implements HostingConnector<DownloadConnectorSession> {
+    connectorId: string;
+    displayName: string;
+    icon: string;
+    disableLogout: boolean;
+    options: DownloadConnectorOptions;
+    connectorType: ConnectorType;
+    color: string;
+    background: string;
+    constructor(config: ServerConfig);
+    getOptions(formData: object): ConnectorOptions;
+    getOAuthUrl(session: DownloadConnectorSession): Promise<null>;
+    getLoginForm(session: DownloadConnectorSession, redirectTo: string): Promise<string | null>;
+    getSettingsForm(session: DownloadConnectorSession, redirectTo: string): Promise<string | null>;
+    isLoggedIn(session: DownloadConnectorSession): Promise<boolean>;
+    setToken(session: DownloadConnectorSession, query: object): Promise<void>;
+    logout(session: DownloadConnectorSession): Promise<void>;
+    getUser(session: DownloadConnectorSession): Promise<ConnectorUser | null>;
+    publish(session: DownloadConnectorSession, websiteId: WebsiteId, files: ConnectorFile[], jobManager: JobManager): Promise<JobData>;
+    startPublishingInBackground(session: DownloadConnectorSession, websiteId: WebsiteId, files: ConnectorFile[], job: PublicationJobData): Promise<void>;
+    getUrl(session: DownloadConnectorSession, websiteId: WebsiteId): Promise<string>;
+}
+export {};

package/dist/plugins/server/plugins/server/DownloadConnector.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const archiver_1 = __importDefault(require("archiver"));
+const types_1 = require("../../types");
+const os_1 = require("os");
+const events_1 = require("../../server/events");
+const ZIP_ICON = '/assets/download.png';
+class default_1 {
+    connectorId = 'download-connector';
+    displayName = 'Download zip file';
+    icon = ZIP_ICON;
+    disableLogout = false;
+    options;
+    connectorType = types_1.ConnectorType.HOSTING;
+    color = '#ffffff';
+    background = '#006400';
+    constructor(config) {
+        // Add a route to serve the zip file
+        config.on(events_1.ServerEvent.STARTUP_END, ({ app }) => {
+            app.get('/download/:tmpZipFile', async (req, res) => {
+                const path = `${(0, os_1.tmpdir)()}/${req.params.tmpZipFile}`;
+                res.sendFile(path, {}, (err) => {
+                    if (err) {
+                        console.error('[DownloadConnector] Error while sending file', err);
+                        res.status(500).send(`
+              <h1>Error</h1>
+              <p>There was an error while getting the zip file of your website</p>
+              <p>${err.message}</p>
+            `);
+                    }
+                });
+            });
+        });
+    }
+    getOptions(formData) {
+        return {};
+    }
+    async getOAuthUrl(session) { return null; }
+    async getLoginForm(session, redirectTo) {
+        return null;
+    }
+    async getSettingsForm(session, redirectTo) {
+        return null;
+    }
+    async isLoggedIn(session) {
+        return true;
+    }
+    async setToken(session, query) { }
+    async logout(session) { }
+    async getUser(session) {
+        return null;
+    }
+    async publish(session, websiteId, files, jobManager) {
+        const job = jobManager.startJob(`Publishing to ${this.displayName}`);
+        this.startPublishingInBackground(session, websiteId, files, job);
+        return job;
+    }
+    async startPublishingInBackground(session, websiteId, files, job) {
+        const fileName = `${websiteId}-${Date.now()}-${Math.random().toString(36).substring(7)}.zip`;
+        return new Promise((resolve, reject) => {
+            let resolved = false;
+            try {
+                // Generate a temporary path for the zip file, in the OS tmp folder, with the website id, the date and random string
+                const path = `${(0, os_1.tmpdir)()}/${fileName}`;
+                // create a file to stream archive data to.
+                const output = (0, fs_1.createWriteStream)(path);
+                const archive = (0, archiver_1.default)('zip', {
+                    zlib: { level: 9 } // Sets the compression level.
+                });
+                // Listen to archive events
+                // listen for all archive data to be written
+                // 'close' event is fired only when a file descriptor is involved
+                output.on('close', function () {
+                    !resolved && resolve(path);
+                    resolved = true;
+                });
+                // good practice to catch warnings (ie stat failures and other non-blocking errors)
+                archive.on('warning', function (err) {
+                    if (err.code === 'ENOENT') {
+                        // log warning
+                    }
+                    else {
+                        !resolved && reject(err);
+                        resolved = true;
+                    }
+                });
+                // good practice to catch this error explicitly
+                archive.on('error', function (err) {
+                    !resolved && reject(err);
+                    resolved = true;
+                });
+                // pipe archive data to the filey
+                archive.pipe(output);
+                // append files
+                for (const file of files) {
+                    job.message = `Adding ${file.path} to the zip file`;
+                    // Handle content as string, buffer or readable
+                    archive.append(file.content, { name: file.path });
+                }
+                // finalize the archive (ie we are done appending files but streams have to finish yet)
+                job.message = 'Finalizing the zip file';
+                return archive.finalize()
+                    .then(() => path);
+            }
+            catch (err) {
+                console.error('Error while creating the zip file', err);
+                job.message = `Error while creating the zip file: ${err.message}`;
+                job.status = types_1.JobStatus.ERROR;
+                !resolved && reject(err);
+                resolved = true;
+            }
+        })
+            .then(path => {
+            job.message = `Zip file created, <a href="/download/${fileName}" target="_blank">download it now</a>`;
+            job.status = types_1.JobStatus.SUCCESS;
+        });
+    }
+    async getUrl(session, websiteId) {
+        return '';
+    }
+}
+exports.default = default_1;
+//# sourceMappingURL=DownloadConnector.js.map

package/dist/plugins/server/plugins/server/DownloadConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DownloadConnector.js","sourceRoot":"","sources":["../../../../../src/ts/plugins/server/DownloadConnector.ts"],"names":[],"mappings":";;;;;AAAA,2BAAsC;AACtC,wDAA+B;AAC/B,uCAA+H;AAE/H,2BAA2B;AAG3B,gDAAiD;AAQjD,MAAM,QAAQ,GAAG,sBAAsB,CAAA;AAEvC;IACE,WAAW,GAAG,oBAAoB,CAAA;IAClC,WAAW,GAAG,mBAAmB,CAAA;IACjC,IAAI,GAAG,QAAQ,CAAA;IACf,aAAa,GAAG,KAAK,CAAA;IACrB,OAAO,CAA0B;IACjC,aAAa,GAAG,qBAAa,CAAC,OAAO,CAAA;IACrC,KAAK,GAAG,SAAS,CAAA;IACjB,UAAU,GAAG,SAAS,CAAA;IAEtB,YAAY,MAAoB;QAC9B,oCAAoC;QACpC,MAAM,CAAC,EAAE,CAAC,oBAAW,CAAC,WAAW,EAAE,CAAC,EAAC,GAAG,EAAC,EAAE,EAAE;YAC3C,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;gBACrE,MAAM,IAAI,GAAG,GAAG,IAAA,WAAM,GAAE,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;gBACnD,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;oBAC7B,IAAI,GAAG,EAAE,CAAC;wBACR,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,GAAG,CAAC,CAAA;wBAClE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;;;mBAGd,GAAG,CAAC,OAAO;aACjB,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,UAAU,CAAC,QAAgB;QACzB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAiC,IAAmB,OAAO,IAAI,CAAA,CAAC,CAAC;IAEnF,KAAK,CAAC,YAAY,CAAC,OAAiC,EAAE,UAAkB;QACtE,OAAO,IAAI,CAAA;IACb,CAAC;IACD,KAAK,CAAC,eAAe,CAAC,OAAiC,EAAE,UAAkB;QACzE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAiC;QAChD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAiC,EAAE,KAAa,IAAkB,CAAC;IAElF,KAAK,CAAC,MAAM,CAAC,OAAiC,IAAkB,CAAC;IAEjE,KAAK,CAAC,OAAO,CAAC,OAAiC;QAC7C,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAiC,EAAE,SAAoB,EAAE,KAAsB,EAAE,UAAsB;QACnH,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,iBAAiB,IAAI,CAAC,WAAW,EAAE,CAAuB,CAAA;QAC1F,IAAI,CAAC,2BAA2B,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;QAChE,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,OAAiC,EAAE,SAAoB,EAAE,KAAsB,EAAE,GAAuB;QACxI,MAAM,QAAQ,GAAG,GAAG,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAA;QAC5F,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,IAAI,QAAQ,GAAG,KAAK,CAAA;YACpB,IAAI,CAAC;gBACH,oHAAoH;gBACpH,MAAM,IAAI,GAAG,GAAG,IAAA,WAAM,GAAE,IAAI,QAAQ,EAAE,CAAA;gBACtC,2CAA2C;gBAC3C,MAAM,MAAM,GAAG,IAAA,sBAAiB,EAAC,IAAI,CAAC,CAAA;gBACtC,MAAM,OAAO,GAAG,IAAA,kBAAQ,EAAC,KAAK,EAAE;oBAC9B,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,8BAA8B;iBAClD,CAAC,CAAA;gBAEF,2BAA2B;gBAC3B,4CAA4C;gBAC5C,iEAAiE;gBACjE,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;oBACjB,CAAC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;oBAC1B,QAAQ,GAAG,IAAI,CAAA;gBACjB,CAAC,CAAC,CAAA;gBAEF,mFAAmF;gBACnF,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,GAAG;oBACjC,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC1B,cAAc;oBAChB,CAAC;yBAAM,CAAC;wBACN,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;wBACxB,QAAQ,GAAG,IAAI,CAAA;oBACjB,CAAC;gBACH,CAAC,CAAC,CAAA;gBAEF,+CAA+C;gBAC/C,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,GAAG;oBAC/B,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;oBACxB,QAAQ,GAAG,IAAI,CAAA;gBACjB,CAAC,CAAC,CAAA;gBAEF,iCAAiC;gBACjC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAEpB,eAAe;gBACf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,GAAG,CAAC,OAAO,GAAG,UAAU,IAAI,CAAC,IAAI,kBAAkB,CAAA;oBACnD,+CAA+C;oBAC/C,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;gBACnD,CAAC;gBAED,uFAAuF;gBACvF,GAAG,CAAC,OAAO,GAAG,yBAAyB,CAAA;gBACvC,OAAO,OAAO,CAAC,QAAQ,EAAE;qBACtB,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;YACrB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAA;gBACvD,GAAG,CAAC,OAAO,GAAG,sCAAsC,GAAG,CAAC,OAAO,EAAE,CAAA;gBACjE,GAAG,CAAC,MAAM,GAAG,iBAAS,CAAC,KAAK,CAAA;gBAC5B,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;gBACxB,QAAQ,GAAG,IAAI,CAAA;YACjB,CAAC;QACH,CAAC,CAAC;aACC,IAAI,CAAC,IAAI,CAAC,EAAE;YACX,GAAG,CAAC,OAAO,GAAG,wCAAwC,QAAQ,uCAAuC,CAAA;YACrG,GAAG,CAAC,MAAM,GAAG,iBAAS,CAAC,OAAO,CAAA;QAChC,CAAC,CAAC,CAAA;IACN,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAiC,EAAE,SAAoB;QAClE,OAAO,EAAE,CAAA;IACX,CAAC;CACF;AAhID,4BAgIC"}

package/dist/plugins/server/plugins/server/FtpConnector.d.ts

@@ -0,0 +1,86 @@
+import { Readable } from 'stream';
+import { ConnectorFile, ConnectorFileContent, StatusCallback, StorageConnector } from '../../server/connectors/connectors';
+import { ConnectorType, ConnectorUser, WebsiteMeta, JobData, WebsiteId, WebsiteMetaFileContent, WebsiteData, ConnectorOptions } from '../../types';
+import { ServerConfig } from '../../server/config';
+import { JobManager } from '../../server/jobs';
+/**
+ * @fileoverview FTP connector for Silex
+ * This is a connector 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 connector, this connector 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 {
+    [ConnectorType.STORAGE]?: FtpSessionData;
+    [ConnectorType.HOSTING]?: FtpSessionData;
+}
+export interface FtpOptions {
+    type: ConnectorType;
+    path: string;
+    assetsFolder: string;
+    cssFolder: string;
+    authorizeUrl: string;
+    authorizePath: string;
+}
+/**
+ * @class FtpConnector
+ * @implements {HostingConnector}
+ * @implements {StorageConnector}
+ */
+export default class FtpConnector implements StorageConnector<FtpSession> {
+    connectorId: string;
+    displayName: string;
+    icon: string;
+    options: FtpOptions;
+    connectorType: ConnectorType;
+    color: string;
+    background: string;
+    constructor(config: ServerConfig, opts: Partial<FtpOptions>);
+    sessionData(session: FtpSession): FtpSessionData;
+    rootPath(session: FtpSession): string;
+    private write;
+    private read;
+    private readdir;
+    private mkdir;
+    private rmdir;
+    private unlink;
+    private getClient;
+    private closeClient;
+    getOptions(formData: object): ConnectorOptions;
+    getOAuthUrl(session: FtpSession): Promise<null>;
+    getLoginForm(session: FtpSession, redirectTo: string): Promise<string | null>;
+    getSettingsForm(session: FtpSession, redirectTo: string): Promise<string | null>;
+    setToken(session: FtpSession, token: object): Promise<void>;
+    logout(session: FtpSession): Promise<void>;
+    getUser(session: FtpSession): Promise<ConnectorUser>;
+    isLoggedIn(session: FtpSession): Promise<boolean>;
+    setWebsiteMeta(session: FtpSession, id: string, data: WebsiteMetaFileContent): Promise<void>;
+    getWebsiteMeta(session: FtpSession, id: WebsiteId): Promise<WebsiteMeta>;
+    /**
+     * Create necessary folders
+     * Assets and root folders
+     */
+    createWebsite(session: FtpSession): Promise<WebsiteId>;
+    listWebsites(session: FtpSession): Promise<WebsiteMeta[]>;
+    readWebsite(session: FtpSession, websiteId: string): Promise<WebsiteData | Readable>;
+    updateWebsite(session: FtpSession, websiteId: string, data: WebsiteData): Promise<void>;
+    deleteWebsite(session: FtpSession, websiteId: string): Promise<void>;
+    duplicateWebsite(session: FtpSession, websiteId: string): Promise<void>;
+    writeAssets(session: any, id: WebsiteId, files: ConnectorFile[], statusCbk?: StatusCallback): Promise<void>;
+    writeFile(session: any, id: WebsiteId, files: ConnectorFile[], relativePath: string, statusCbk?: StatusCallback): Promise<void>;
+    readAsset(session: FtpSession, id: string, path: string): Promise<ConnectorFileContent>;
+    deleteAssets(session: FtpSession, id: WebsiteId, paths: string[]): Promise<void>;
+    getUrl(session: FtpSession, id: WebsiteId): Promise<string>;
+    publish(session: FtpSession, id: WebsiteId, files: ConnectorFile[], { startJob, jobSuccess, jobError }: JobManager): Promise<JobData>;
+}