@silexlabs/silex 3.1.0 → 3.2.0

package/dist/client/silex-lib/src/ts/client/grapesjs/settings.d.ts

@@ -0,0 +1,4 @@
+export declare const cmdOpenSettings = "open-settings";
+export declare const settingsDialog: (editor: any, opts: any) => void;
+export declare function addSection(section: any, siteOrPage: 'site' | 'page', position: 'first' | 'last' | number): void;
+export declare function removeSection(id: any, siteOrPage: 'site' | 'page'): void;

package/dist/client/silex-lib/src/ts/client/grapesjs/storage.d.ts

@@ -0,0 +1,3 @@
+import { PublishableEditor } from './PublicationManager';
+export declare const cmdPauseAutoSave = "pause-auto-save";
+export declare const storagePlugin: (editor: PublishableEditor) => void;

package/dist/client/silex-lib/src/ts/client/grapesjs/symbolDialogs.d.ts

@@ -0,0 +1,3 @@
+export declare const cmdPromptAddSymbol = "symbol-prompt-add";
+declare const _default: (editor: any, opts: any) => void;
+export default _default;

package/dist/client/silex-lib/src/ts/client/grapesjs/upload-progress.d.ts

@@ -0,0 +1,2 @@
+import { Editor } from 'grapesjs';
+export default function pluginUploadProgress(editor: Editor): void;

package/dist/client/silex-lib/src/ts/client/grapesjs/view-buttons.d.ts

@@ -0,0 +1 @@
+export default function (editor: any): void;

package/dist/client/silex-lib/src/ts/client/index.d.ts

@@ -0,0 +1,10 @@
+import { ClientConfig } from './config';
+export * from './expose';
+/**
+ * Expose the config object
+ */
+export declare let config: ClientConfig;
+/**
+ * Start Silex, called from host HTML page with window.silex.start()
+ */
+export declare function start(options?: {}): Promise<void>;

package/dist/client/silex-lib/src/ts/client/publication-transformers.d.ts

@@ -0,0 +1,42 @@
+import { Component, CssRule, StyleProps, Editor } from 'grapesjs';
+import { ClientSideFile, ClientSideFileType, Initiator, PublicationData } from '../types';
+/**
+ * Interface for publication transformers
+ * They are added to the config object with config.addPublicationTransformer()
+ */
+export interface PublicationTransformer {
+    renderComponent?(component: Component, toHtml: () => string): string | undefined;
+    renderCssRule?(rule: CssRule, initialRule: () => StyleProps): StyleProps | undefined;
+    transformFile?(file: ClientSideFile): ClientSideFile;
+    transformPermalink?(link: string, type: ClientSideFileType, initiator: Initiator): string;
+    transformPath?(path: string, type: ClientSideFileType): string;
+}
+export declare const publicationTransformerDefault: PublicationTransformer;
+export declare function validatePublicationTransformer(transformer: PublicationTransformer): void;
+/**
+ * Alter the components rendering
+ * Exported for unit tests
+ */
+export declare function renderComponents(editor: Editor): void;
+/**
+ * Alter the styles rendering
+ * Exported for unit tests
+ */
+export declare function renderCssRules(editor: Editor): void;
+/**
+ * Transform background image url according to the transformed path of assets
+ */
+export declare function transformBgImage(editor: Editor, style: StyleProps): StyleProps;
+/**
+ * Transform files
+ * Exported for unit tests
+ */
+export declare function transformFiles(editor: Editor, data: PublicationData): void;
+/**
+ * Transform files paths
+ * Exported for unit tests
+ */
+export declare function transformPermalink(editor: Editor, path: string, type: ClientSideFileType, initiator: Initiator): string;
+export declare function transformPath(editor: Editor, path: string, type: ClientSideFileType): string;
+export declare function resetRenderComponents(editor: Editor): void;
+export declare function resetRenderCssRules(editor: Editor): void;

package/dist/client/silex-lib/src/ts/client/publish-custom-code-block.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @fileoverview Make sure custom script blocks include script tags when published
+ */
+export default function (config: any): Promise<void>;

package/dist/client/silex-lib/src/ts/client/publish-fonts.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @fileoverview Make sure custom script blocks include script tags when published
+ */
+export default function (config: any): Promise<void>;

package/dist/client/silex-lib/src/ts/client/utils.d.ts

@@ -0,0 +1,22 @@
+import { Component, Editor } from 'grapesjs';
+export declare function onAll(editor: Editor, cbk: (c: Component) => void): void;
+/**
+ * SHA256 hash a string
+ */
+export declare function hashString(str: string): Promise<string>;
+/**
+ * Select the <body> element in the editor.
+ * @param editor The GrapesJS editor.
+ */
+export declare function selectBody(editor: Editor): void;
+/**
+ * Checks if an element is a text or input field.
+ * @param element The element to check.
+ */
+export declare function isTextOrInputField(element: HTMLElement): boolean;
+/**
+ * Makes every word in a string start with an uppercase letter.
+ * @param str The string to title-case.
+ * @param sep The separator between words.
+ */
+export declare function titleCase(str: string, sep?: string): string;

package/dist/client/silex-lib/src/ts/constants.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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 WEBSITE_PAGES_FOLDER = "src";
+export declare const DEFAULT_WEBSITE_ID = "default";
+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_DUPLICATE = "/duplicate";
+export declare const API_WEBSITE_LIST = "/";
+export declare const API_WEBSITE_ASSET_READ = "/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";
+export declare let SILEX_VERSION: any;
+export declare const DEV_MESSAGE: string;

package/dist/client/silex-lib/src/ts/page.d.ts

@@ -0,0 +1,2 @@
+export declare function getPageSlug(pageName: any): any;
+export declare function getPageLink(pageName: any): string;

package/dist/client/silex-lib/src/ts/types.d.ts

@@ -0,0 +1,341 @@
+/**
+ * @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[][];
+    startTime?: number;
+    endTime?: number;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@silexlabs/silex",
   "description": "Free and easy website builder for everyone.",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "version:backwardcompat": "3.0.0",
   "author": {
     "name": "Alex Hoyau",