@silexlabs/silex 3.0.1-alpha.0 → 3.0.2

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

@@ -0,0 +1,339 @@
+/**
+ * @fileoverview define types for Silex client and server
+ */
+export interface PublicationSettings {
+    connector?: ConnectorData;
+    options?: ConnectorOptions;
+}
+export interface WebsiteFile {
+    html: string;
+    css: string;
+    htmlPath: string;
+    cssPath: string;
+}
+export declare class ApiError extends Error {
+    readonly httpStatusCode: number;
+    constructor(message: string, httpStatusCode: number);
+}
+export type ApiResponseError = {
+    message: string;
+};
+export type ApiPublicationPublishBody = WebsiteData;
+export type ApiPublicationPublishQuery = {
+    websiteId: WebsiteId;
+    hostingId: ConnectorId;
+    storageId: ConnectorId;
+    options: ConnectorOptions;
+};
+export type ApiPublicationPublishResponse = {
+    url: string;
+    job: PublicationJobData;
+};
+export type ApiPublicationStatusQuery = {
+    jobId: JobId;
+};
+export type ApiPublicationStatusResponse = PublicationJobData;
+export type ApiWebsiteReadQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteReadResponse = WebsiteData;
+export type ApiWebsiteListQuery = {
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteListResponse = WebsiteMeta[];
+export type ApiWebsiteWriteQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteWriteBody = WebsiteData;
+export type ApiWebsiteWriteResponse = {
+    message: string;
+};
+export type ApiWebsiteCreateQuery = {
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteCreateBody = WebsiteMetaFileContent;
+export type ApiWebsiteCreateResponse = {
+    message: string;
+};
+export type ApiWebsiteDeleteQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteDuplicateQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteMetaReadQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteMetaReadResponse = WebsiteMeta;
+export type ApiWebsiteMetaWriteQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteMetaWriteBody = WebsiteMetaFileContent;
+export type ApiWebsiteMetaWriteResponse = {
+    message: string;
+};
+export type ApiWebsiteAssetsReadQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteAssetsReadParams = {
+    path: string;
+};
+export type ApiWebsiteAssetsReadResponse = string;
+export type ApiWebsiteAssetsWriteQuery = {
+    websiteId: WebsiteId;
+    connectorId?: ConnectorId;
+};
+export type ApiWebsiteAssetsWriteBody = ClientSideFile[];
+export type ApiWebsiteAssetsWriteResponse = {
+    data: string[];
+};
+export type ApiConnectorListQuery = {
+    type: ConnectorType;
+};
+export type ApiConnectorListResponse = ConnectorData[];
+export type ApiConnectorLoginQuery = {
+    connectorId: ConnectorId;
+    type: ConnectorType;
+};
+export type ApiConnectorLoggedInPostMessage = {
+    type: string;
+    error: boolean;
+    message: string;
+    connectorId: ConnectorId;
+    options: ConnectorOptions;
+};
+export type ApiConnectorLoginCbkQuery = {
+    connectorId?: ConnectorId;
+    type: ConnectorType;
+    error?: string;
+};
+export type ApiConnectorLoginCbkBody = object;
+export type ApiConnectorSettingsQuery = {
+    connectorId?: ConnectorId;
+    type: ConnectorType;
+};
+export type ApiConnectorSettingsResponse = string;
+export type ApiConnectorSettingsPostQuery = {
+    connectorId?: ConnectorId;
+    type: ConnectorType;
+};
+export type ApiConnectorSettingsPostBody = ConnectorUserSettings;
+export type ApiConnectorSettingsPostResponse = {
+    message: string;
+};
+export type ApiConnectorLogoutQuery = {
+    connectorId?: ConnectorId;
+    type: ConnectorType;
+};
+export type ApiConnectorUserQuery = {
+    connectorId?: ConnectorId;
+    type: ConnectorType;
+};
+export type ApiConnectorUserResponse = ConnectorUser;
+export declare const defaultWebsiteData: WebsiteData;
+export interface Component {
+    type: string;
+    content?: string;
+    attributes: {
+        [key: string]: string;
+    };
+    components: Component[];
+}
+export interface Page {
+    id: string;
+    name: string;
+    slug: string;
+    settings: WebsiteSettings;
+    frames: {
+        component: Component;
+    }[];
+}
+export interface WebsiteData {
+    pages: Page[];
+    assets: Asset[];
+    styles: Style[];
+    settings: WebsiteSettings;
+    fonts: Font[];
+    symbols: symbol[];
+    publication: PublicationSettings;
+}
+export interface PublicationData extends WebsiteData {
+    files?: ClientSideFile[];
+}
+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 declare enum Unit {
+    PX = "px"
+}
+export interface Asset {
+    type: string;
+    src: string;
+    unitDim: Unit;
+    height: number;
+    width: number;
+    name: string;
+    path?: string;
+}
+export interface Style {
+    selectors: Selector[];
+    style: {
+        [key: string]: string;
+    };
+}
+export type Selector = string | {
+    name: string;
+    type: number;
+};
+/**
+ * Type for a connector id
+ */
+export type ConnectorId = string;
+export type ConnectorOptions = {
+    websiteUrl?: string;
+    [key: string]: any;
+};
+export declare enum ClientSideFileType {
+    HTML = "html",
+    ASSET = "asset",
+    CSS = "css",
+    OTHER = "other"
+}
+export declare enum Initiator {
+    HTML = "html",
+    CSS = "css"
+}
+/**
+ * Type for a client side file when the content is not available, used to handle file names and paths and urls
+ */
+export interface ClientSideFileWithPermalink {
+    path: string;
+    permalink?: string;
+    type: ClientSideFileType;
+}
+/**
+ * Type for a client side file when the content is available as a string
+ */
+export interface ClientSideFileWithContent extends ClientSideFileWithPermalink {
+    content: string;
+}
+/**
+ * Type for a client side file when the content is in the connector
+ */
+export interface ClientSideFileWithSrc extends ClientSideFileWithPermalink {
+    src: string;
+}
+/**
+ * Type for a client side file
+ * @see connector/File
+ */
+export type ClientSideFile = ClientSideFileWithContent | ClientSideFileWithSrc;
+/**
+ * Type for file listing
+ */
+export interface FileMeta {
+    name: string;
+    isDir: boolean;
+    size: number;
+    createdAt: Date;
+    updatedAt: Date;
+    metadata?: object;
+}
+/**
+ * Enum to express if the connector is a storage or a hosting
+ */
+export declare enum ConnectorType {
+    STORAGE = "STORAGE",
+    HOSTING = "HOSTING"
+}
+/**
+ * Type for a website id
+ */
+export type WebsiteId = string;
+/**
+ * Back end data shared with the front end
+ */
+export interface ConnectorData {
+    connectorId: ConnectorId;
+    type: ConnectorType;
+    displayName: string;
+    icon: string;
+    disableLogout: boolean;
+    isLoggedIn: boolean;
+    oauthUrl: string | null;
+    color: string;
+    background: string;
+}
+/**
+ * User settings for a connector and for a given website
+ */
+export type ConnectorUserSettings = {
+    [websiteId: string]: object;
+};
+/**
+ * Back end data shared with the front end
+ */
+export interface ConnectorUser {
+    name: string;
+    email?: string;
+    picture?: string;
+    storage: ConnectorData;
+}
+export interface WebsiteMetaFileContent {
+    name: string;
+    imageUrl?: string;
+    connectorUserSettings: ConnectorUserSettings;
+}
+/**
+ * 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 extends WebsiteMetaFileContent {
+    websiteId: WebsiteId;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+/**
+ * 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;
+    _timeout?: ReturnType<typeof setTimeout>;
+}
+export interface PublicationJobData extends JobData {
+    logs: string[][];
+    errors: string[][];
+}

package/dist/plugins/server/types.js

@@ -0,0 +1,84 @@
+"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.JobStatus = exports.ConnectorType = exports.Initiator = exports.ClientSideFileType = exports.Unit = exports.defaultWebsiteData = exports.ApiError = void 0;
+class ApiError extends Error {
+    httpStatusCode;
+    constructor(message, httpStatusCode) {
+        super(message);
+        this.httpStatusCode = httpStatusCode;
+        console.info('API error', httpStatusCode, message);
+    }
+}
+exports.ApiError = ApiError;
+// **
+// Website API
+exports.defaultWebsiteData = {
+//pages: [],
+//assets: [],
+//styles: [],
+//settings: {},
+//fonts: [],
+//symbols: [],
+//publication: {},
+};
+//export interface Frame {
+//  component: { type: string, stylable: string[] },
+//  components: Component[],
+//}
+//
+//export interface Component {
+//  type: string,
+//  content?: string,
+//  attributes: { [key: string]: string },
+//  conponents: Component[],
+//}
+var Unit;
+(function (Unit) {
+    Unit["PX"] = "px";
+})(Unit || (exports.Unit = Unit = {}));
+var ClientSideFileType;
+(function (ClientSideFileType) {
+    ClientSideFileType["HTML"] = "html";
+    ClientSideFileType["ASSET"] = "asset";
+    ClientSideFileType["CSS"] = "css";
+    ClientSideFileType["OTHER"] = "other";
+})(ClientSideFileType || (exports.ClientSideFileType = ClientSideFileType = {}));
+var Initiator;
+(function (Initiator) {
+    Initiator["HTML"] = "html";
+    Initiator["CSS"] = "css";
+})(Initiator || (exports.Initiator = Initiator = {}));
+/**
+ * Enum to express if the connector is a storage or a hosting
+ */
+var ConnectorType;
+(function (ConnectorType) {
+    ConnectorType["STORAGE"] = "STORAGE";
+    ConnectorType["HOSTING"] = "HOSTING";
+})(ConnectorType || (exports.ConnectorType = ConnectorType = {}));
+/**
+ * Enum to express if the job is in progress or finished or errored
+ */
+var JobStatus;
+(function (JobStatus) {
+    JobStatus["IN_PROGRESS"] = "IN_PROGRESS";
+    JobStatus["SUCCESS"] = "SUCCESS";
+    JobStatus["ERROR"] = "ERROR";
+})(JobStatus || (exports.JobStatus = JobStatus = {}));
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ts/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAmBH,MAAa,QAAS,SAAQ,KAAK;IACY;IAA7C,YAAY,OAAe,EAAkB,cAAsB;QACjE,KAAK,CAAC,OAAO,CAAC,CAAA;QAD6B,mBAAc,GAAd,cAAc,CAAQ;QAEjE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IACpD,CAAC;CACF;AALD,4BAKC;AAgDD,KAAK;AACL,cAAc;AACD,QAAA,kBAAkB,GAAgB;AAC7C,YAAY;AACZ,aAAa;AACb,aAAa;AACb,eAAe;AACf,YAAY;AACZ,cAAc;AACd,kBAAkB;CACJ,CAAA;AAuDhB,0BAA0B;AAC1B,oDAAoD;AACpD,4BAA4B;AAC5B,GAAG;AACH,EAAE;AACF,8BAA8B;AAC9B,iBAAiB;AACjB,qBAAqB;AACrB,0CAA0C;AAC1C,4BAA4B;AAC5B,GAAG;AAEH,IAAY,IAEX;AAFD,WAAY,IAAI;IACd,iBAAS,CAAA;AACX,CAAC,EAFW,IAAI,oBAAJ,IAAI,QAEf;AAkCD,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,qCAAe,CAAA;IACf,iCAAW,CAAA;IACX,qCAAe,CAAA;AACjB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,0BAAa,CAAA;IACb,wBAAW,CAAA;AACb,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA2CD;;GAEG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;AACrB,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAuDD;;GAEG;AACH,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,wCAA2B,CAAA;IAC3B,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB"}

package/dist/server/constants.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEV_MESSAGE = exports.SILEX_VERSION = exports.API_WEBSITE_META_WRITE = exports.API_WEBSITE_META_READ = exports.API_WEBSITE_ASSETS_WRITE = exports.API_WEBSITE_ASSET_READ = exports.API_WEBSITE_LIST = exports.API_WEBSITE_DUPLICATE = exports.API_WEBSITE_DELETE = exports.API_WEBSITE_CREATE = exports.API_WEBSITE_WRITE = exports.API_WEBSITE_READ = exports.API_WEBSITE_PATH = exports.API_PUBLICATION_STATUS = exports.API_PUBLICATION_PUBLISH = exports.API_PUBLICATION_PATH = exports.API_CONNECTOR_LOGIN_CALLBACK = exports.API_CONNECTOR_SETTINGS = exports.API_CONNECTOR_LOGIN = exports.API_CONNECTOR_LOGOUT = exports.API_CONNECTOR_LIST = exports.API_CONNECTOR_USER = exports.API_CONNECTOR_PATH = exports.API_PATH = exports.CLIENT_CONFIG_FILE_NAME = exports.DEFAULT_LANGUAGE = exports.DEFAULT_WEBSITE_ID = exports.WEBSITE_META_DATA_FILE = exports.WEBSITE_DATA_FILE = void 0;
+exports.WEBSITE_DATA_FILE = 'website.json';
+exports.WEBSITE_META_DATA_FILE = 'meta.json';
+exports.DEFAULT_WEBSITE_ID = 'default';
+exports.DEFAULT_LANGUAGE = 'en';
+exports.CLIENT_CONFIG_FILE_NAME = 'silex.js';
+exports.API_PATH = '/api';
+exports.API_CONNECTOR_PATH = '/connector';
+exports.API_CONNECTOR_USER = '/user';
+exports.API_CONNECTOR_LIST = '/';
+exports.API_CONNECTOR_LOGOUT = '/logout';
+exports.API_CONNECTOR_LOGIN = '/login';
+exports.API_CONNECTOR_SETTINGS = '/settings';
+exports.API_CONNECTOR_LOGIN_CALLBACK = '/login/callback';
+exports.API_PUBLICATION_PATH = '/publication';
+exports.API_PUBLICATION_PUBLISH = '/';
+exports.API_PUBLICATION_STATUS = '/publication/status';
+exports.API_WEBSITE_PATH = '/website';
+exports.API_WEBSITE_READ = '/';
+exports.API_WEBSITE_WRITE = '/';
+exports.API_WEBSITE_CREATE = '/';
+exports.API_WEBSITE_DELETE = '/';
+exports.API_WEBSITE_DUPLICATE = '/duplicate';
+exports.API_WEBSITE_LIST = '/';
+exports.API_WEBSITE_ASSET_READ = '/assets';
+exports.API_WEBSITE_ASSETS_WRITE = '/assets';
+exports.API_WEBSITE_META_READ = '/meta';
+exports.API_WEBSITE_META_WRITE = '/meta';
+try {
+    exports.SILEX_VERSION = SILEX_VERSION_ENV;
+}
+catch (e) {
+    exports.SILEX_VERSION = exports.SILEX_VERSION || '3.0.0';
+}
+exports.DEV_MESSAGE = `
+__________________________________________________________
+
+  Create static websites visually, with dynamic content,
+  in the free spirit of the web.
+
+  ███████ ██ ██      ███████ ██   ██     ██    ██ ██████
+  ██      ██ ██      ██       ██ ██      ██    ██      ██
+  ███████ ██ ██      █████     ███       ██    ██  █████
+       ██ ██ ██      ██       ██ ██       ██  ██       ██
+  ███████ ██ ███████ ███████ ██   ██       ████   ██████ ${exports.SILEX_VERSION.slice(1)}
+
+  Users are expected to contribute:
+
+  * Web designers: https://docs.silex.me/en/user/contribute
+  * Developers: https://docs.silex.me/en/dev/contribute
+
+__________________________________________________________
+`;

package/dist/server/plugins/server/Cache.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noCache = noCache;
+exports.withCache = withCache;
+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();
+}
+function withCache(req, res, next) {
+    if (req.url.endsWith('.html') || req.url.endsWith('/')) {
+        noCache(req, res, next);
+    }
+    else {
+        res.header('Cache-Control', 'public,max-age=86400,immutable');
+        next();
+    }
+}

package/dist/server/server/api/api.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+const express_1 = require("express");
+const Cache_1 = require("../../plugins/server/Cache");
+const connectorApi_1 = __importDefault(require("./connectorApi"));
+const websiteApi_1 = __importDefault(require("./websiteApi"));
+const publicationApi_1 = __importDefault(require("./publicationApi"));
+const constants_1 = require("../../constants");
+function default_1(config) {
+    const router = (0, express_1.Router)();
+    router.use(Cache_1.noCache);
+    router.use(constants_1.API_CONNECTOR_PATH, (0, connectorApi_1.default)(config));
+    router.use(constants_1.API_WEBSITE_PATH, (0, websiteApi_1.default)(config));
+    router.use(constants_1.API_PUBLICATION_PATH, (0, publicationApi_1.default)(config));
+    return router;
+}