@silexlabs/silex 3.0.1-alpha.0 → 3.0.1

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

@@ -0,0 +1,123 @@
+import { Editor, PluginOptions } from 'grapesjs';
+/**
+ * Opens the Publish dialog and publishes the website.
+ * @param editor The editor.
+ */
+declare function publish(editor: Editor): void;
+/**
+ * Escapes the current context in this order : modal, Publish dialog, left panel.
+ * If none of these are open, it selects the body.
+ * @param editor The editor.
+ */
+declare function escapeContext(editor: Editor): void;
+export declare const cmdSelectBody = "select-body";
+export declare let prefixKey: string;
+export declare const defaultKms: {
+    kmOpenSettings: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmOpenPublish: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmOpenFonts: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmPreviewMode: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmLayers: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmBlocks: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmNotifications: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmPages: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmSymbols: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmStyleManager: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmTraitsManager: {
+        id: string;
+        keys: string;
+        handler: (editor: any) => void;
+    };
+    kmClosePanel: {
+        id: string;
+        keys: string;
+        handler: typeof escapeContext;
+    };
+    kmSelectBody: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+    kmDuplicateSelection: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+    kmPublish: {
+        id: string;
+        keys: string;
+        handler: typeof publish;
+    };
+    kmAddPage: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+    kmRemovePage: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+    kmClonePage: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+    kmSelectNextPage: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+    kmSelectPrevPage: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+    kmSelectFirstPage: {
+        id: string;
+        keys: string;
+        handler: string;
+    };
+};
+export declare function keymapsPlugin(editor: Editor, opts: PluginOptions): void;
+export {};

package/dist/client/client/grapesjs/new-page-dialog.d.ts

@@ -0,0 +1,2 @@
+export declare const cmdOpenNewPageDialog = "new-page-dialog";
+export declare const newPageDialog: (editor: any, opts: any) => void;

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

@@ -0,0 +1,9 @@
+/**
+ * @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/page-panel.d.ts

@@ -0,0 +1,9 @@
+import { Editor } from 'grapesjs';
+export declare const cmdTogglePages = "pages:open-panel";
+export declare const cmdAddPage = "pages:add";
+export declare const cmdRemovePage = "pages:remove";
+export declare const cmdClonePage = "pages:clone";
+export declare const cmdSelectNextPage = "pages:select-next";
+export declare const cmdSelectPrevPage = "pages:select-prev";
+export declare const cmdSelectFirstPage = "pages:select-first";
+export declare const pagePanelPlugin: (editor: Editor, opts: any) => void;

package/dist/client/client/grapesjs/project-bar.d.ts

@@ -0,0 +1,21 @@
+import { Editor } from 'grapesjs';
+export declare const PROJECT_BAR_PANEL_ID = "project-bar-panel";
+export declare const containerPanelId = "project-bar-container";
+export interface PanelObject {
+    command: string | ((editor: Editor) => void);
+    text: string;
+    className: string;
+    name?: string;
+    attributes: {
+        title?: string;
+        containerClassName?: string;
+    };
+    buttons?: {
+        command: string;
+        text: string;
+        className: string;
+    }[];
+    onClick?: (editor: Editor) => void;
+}
+export declare const projectBarPlugin: (editor: any, opts: any) => void;
+export declare function addButton(editor: Editor, panel: PanelObject): void;

package/dist/client/client/grapesjs/resize-panel.d.ts

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

package/dist/client/client/grapesjs/rich-text.d.ts

@@ -0,0 +1,4 @@
+import { RichTextEditorAction } from 'grapesjs';
+export declare const orderedList: RichTextEditorAction;
+export declare const unorderedList: RichTextEditorAction;
+export declare const richTextPlugin: (editor: any, opts: any) => void;

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

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

package/dist/client/client/grapesjs/settings-sections.d.ts

@@ -0,0 +1,16 @@
+import { TemplateResult } from 'lit-html';
+import { WebsiteSettings } from '../../types';
+export declare const idCodeWrapper = "settings-head-wrapper";
+export declare function isSite(model: any): boolean;
+export interface SettingsSection {
+    id: string;
+    label: string;
+    render: (settings: WebsiteSettings, model: Backbone.Model) => TemplateResult;
+}
+/**
+ * This is the settings dialog default sections
+ * Each section has an entry in the sidebar
+ * Each section render as part of the settings form
+ * The form is submitted to save the settings with all FormData
+ */
+export declare const defaultSections: SettingsSection[];

package/dist/client/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/client/grapesjs/storage.d.ts

@@ -0,0 +1,2 @@
+export declare const cmdPauseAutoSave = "pause-auto-save";
+export declare const storagePlugin: (editor: any) => void;

package/dist/client/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/client/grapesjs/view-buttons.d.ts

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

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

@@ -0,0 +1,32 @@
+/**
+ * @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_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;