@silexlabs/silex 3.3.1-3 → 3.3.1-5

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

@@ -1,341 +0,0 @@
-/**
- * @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/src/ts/client/grapesjs/dynamic-plugins.ts

@@ -1,63 +0,0 @@
-/**
- * Dynamic plugin loader for external GrapesJS plugins
- * These plugins are loaded at runtime to reduce initial bundle size
- */
-
-export interface PluginDefinition {
-  name: string
-  value: any
-}
-
-/**
- * Load all external plugins dynamically
- */
-export async function loadDynamicPlugins(): Promise<PluginDefinition[]> {
-  const [
-    blocksBasicPlugin,
-    styleFilterPlugin,
-    formPlugin,
-    codePlugin,
-    filterStyles,
-    symbolsPlugin,
-    loadingPlugin,
-    fontsDialogPlugin,
-    selectorPlugin,
-    rateLimitPlugin,
-    borderPlugin,
-    backgroundPlugin,
-    notificationsPlugin,
-    keymapsDialogPlugin,
-  ] = await Promise.all([
-    import('grapesjs-blocks-basic').then(m => m.default),
-    import('grapesjs-style-filter').then(m => m.default),
-    import('grapesjs-plugin-forms').then(m => m.default),
-    import('grapesjs-custom-code').then(m => m.default),
-    import('@silexlabs/grapesjs-filter-styles').then(m => m.default),
-    import('@silexlabs/grapesjs-symbols').then(m => m.default),
-    import('@silexlabs/grapesjs-loading').then(m => m.default),
-    import('@silexlabs/grapesjs-fonts').then(m => m.default),
-    import('@silexlabs/grapesjs-advanced-selector').then(m => m.default),
-    import('@silexlabs/grapesjs-storage-rate-limit').then(m => m.default),
-    import('grapesjs-style-border').then(m => m.default),
-    import('grapesjs-style-bg').then(m => m.default),
-    import('@silexlabs/grapesjs-notifications').then(m => m.default),
-    import('@silexlabs/grapesjs-keymaps-dialog').then(m => m.default),
-  ])
-
-  return [
-    { name: 'grapesjs-blocks-basic', value: blocksBasicPlugin },
-    { name: 'grapesjs-style-filter', value: styleFilterPlugin },
-    { name: 'grapesjs-plugin-forms', value: formPlugin },
-    { name: 'grapesjs-custom-code', value: codePlugin },
-    { name: '@silexlabs/grapesjs-filter-styles', value: filterStyles },
-    { name: '@silexlabs/grapesjs-symbols', value: symbolsPlugin },
-    { name: '@silexlabs/grapesjs-loading', value: loadingPlugin },
-    { name: '@silexlabs/grapesjs-fonts', value: fontsDialogPlugin },
-    { name: '@silexlabs/grapesjs-advanced-selector', value: selectorPlugin },
-    { name: '@silexlabs/grapesjs-storage-rate-limit', value: rateLimitPlugin },
-    { name: 'grapesjs-style-border', value: borderPlugin },
-    { name: 'grapesjs-style-bg', value: backgroundPlugin },
-    { name: '@silexlabs/grapesjs-notifications', value: notificationsPlugin },
-    { name: '@silexlabs/grapesjs-keymaps-dialog', value: keymapsDialogPlugin },
-  ]
-}

package/src/ts/client/grapesjs/plugin-options.ts

@@ -1,243 +0,0 @@
-/**
- * Plugin options configuration for all GrapesJS plugins
- */
-
-import { EditorConfig } from 'grapesjs'
-import { PluginDefinition } from './dynamic-plugins'
-import { staticPlugins, cmdPromptAddSymbol, cmdTogglePages, cmdAddPage, cmdOpenSettings, PROJECT_BAR_PANEL_ID, cmdOpenNewPageDialog } from './static-plugins'
-import { NotificationEditor } from '@silexlabs/grapesjs-notifications'
-import { cmdKeymapsDialog } from '@silexlabs/grapesjs-keymaps-dialog'
-// Commands will be imported from the main index file
-export const cmdToggleLayers = 'open-layers'
-export const cmdToggleBlocks = 'open-blocks'
-export const cmdToggleSymbols = 'open-symbols'
-export const cmdToggleNotifications = 'open-notifications'
-import { ClientConfig } from '../config'
-import { titleCase } from '../utils'
-import { defaultKms } from './keymaps'
-
-// Constants
-const PRIMARY_COLOR = '#333333'
-const SECONDARY_COLOR = '#ddd'
-const TERTIARY_COLOR = '#8873FE'
-const QUATERNARY_COLOR = '#A291FF'
-const catBasic = 'Containers'
-const catComponents = 'Components'
-
-// Create notification container
-const notificationContainer = document.createElement('div')
-
-/**
- * Get plugin options for static plugins
- */
-export function getStaticPluginOptions(config: ClientConfig) {
-  const { websiteId, storageId } = config
-  
-  const projectBarPluginValue = staticPlugins.find(p => p.name === './project-bar')?.value
-  const imgPluginValue = staticPlugins.find(p => p.name === './img')?.value
-  const pagePanelPluginValue = staticPlugins.find(p => p.name === './page-panel')?.value
-  const internalLinksPluginValue = staticPlugins.find(p => p.name === './internal-links')?.value
-  const keymapsPluginValue = staticPlugins.find(p => p.name === './keymaps')?.value
-  const loginDialogPluginValue = staticPlugins.find(p => p.name === './LoginDialog')?.value
-
-  return {
-    [projectBarPluginValue?.toString()]: {
-      panels: [
-        {
-          id: 'dash',
-          className: 'logo',
-          attributes: { title: 'Dashboard' },
-          command: () => {
-            window.location.href = '/'
-          },
-        }, {
-          id: 'block-manager-btn',
-          className: 'block-manager-btn fa fa-fw fa-plus',
-          name: 'Blocks',
-          attributes: { title: `Blocks (${titleCase(defaultKms.kmBlocks.keys, '+')})`, containerClassName: 'block-manager-container', },
-          command: cmdToggleBlocks,
-        }, {
-          id: 'symbols-btn',
-          className: 'symbols-btn fa-regular fa-gem',
-          name: 'Symbols',
-          attributes: { title: `Symbols (${titleCase(defaultKms.kmSymbols.keys, '+')})`, containerClassName: 'symbols-list-container', },
-          command: cmdToggleSymbols,
-          buttons: [
-            {
-              id: 'symbol-create-button',
-              className: 'gjs-pn-btn',
-              command: cmdPromptAddSymbol,
-              text: '\u271A',
-            },
-          ],
-        }, {
-          id: 'page-panel-btn',
-          className: 'page-panel-btn fa fa-fw fa-file',
-          name: 'Pages',
-          attributes: { title: `Pages (${titleCase(defaultKms.kmPages.keys, '+')})`, containerClassName: 'page-panel-container', },
-          command: cmdTogglePages,
-          buttons: [{
-            className: 'gjs-pn-btn',
-            command: cmdAddPage,
-            text: '\u271A',
-          }],
-        }, {
-          id: 'layer-manager-btn',
-          className: 'layer-manager-btn fa-solid fa-layer-group',
-          name: 'Layers',
-          attributes: { title: `Layers (${titleCase(defaultKms.kmLayers.keys, '+')})`, containerClassName: 'layer-manager-container', },
-          command: cmdToggleLayers,
-        }, {
-          id: 'font-dialog-btn',
-          className: 'font-manager-btn fa-solid fa-font',
-          name: 'Fonts',
-          attributes: { title: `Fonts (${titleCase(defaultKms.kmOpenFonts.keys, '+')})` },
-          command: () => {
-            // @ts-ignore - editor will be available at runtime
-            editor.runCommand('open-fonts')
-          },
-        }, {
-          id: 'settings-dialog-btn',
-          className: 'page-panel-btn fa-solid fa-gears',
-          name: 'Settings',
-          attributes: { title: `Settings (${titleCase(defaultKms.kmOpenSettings.keys, '+')})` },
-          command: cmdOpenSettings,
-        }, {
-          id: 'spacer',
-          attributes: {},
-          className: 'project-bar-spacer',
-        }, {
-          id: 'keymaps-btn',
-          className: 'keymaps-btn fa-solid fa-keyboard',
-          name: 'Shortcuts',
-          attributes: { title: 'Keyboard Shortcuts (Shift+H)' },
-          command: cmdKeymapsDialog,
-        }, {
-          id: 'notifications-btn',
-          className: 'notifications-btn fa-regular fa-bell',
-          name: 'Notifications',
-          attributes: { title: `Notifications (${titleCase(defaultKms.kmNotifications.keys, '+')})`, containerClassName: 'notifications-container', },
-          command: cmdToggleNotifications,
-        }, {
-          id: 'logout-btn',
-          className: 'logout-btn fa fa-fw fa-power-off',
-          name: 'Logout',
-          attributes: { title: 'Logout' },
-          command: () => {
-            // @ts-ignore - editor will be available at runtime
-            editor.runCommand('logout')
-          },
-        }],
-    },
-    ...(pagePanelPluginValue && {
-      [pagePanelPluginValue.toString()]: {
-        cmdOpenNewPageDialog,
-        cmdOpenSettings,
-        appendTo: '.page-panel-container',
-      }
-    }),
-    ...(internalLinksPluginValue && {
-      [internalLinksPluginValue.toString()]: {
-        // FIXME: warn the user about links in error
-        onError: (errors: any) => console.warn('Links errors:', errors),
-      }
-    }),
-    ...(keymapsPluginValue && {
-      [keymapsPluginValue.toString()]: {
-        disableKeymaps: false,
-      }
-    }),
-    ...(loginDialogPluginValue && {
-      [loginDialogPluginValue.toString()]: {
-        id: websiteId,
-      }
-    }),
-    ...(imgPluginValue && {
-      [imgPluginValue.toString()]: {
-        replacedElements: config.replacedElements,
-        websiteId,
-        storageId,
-      }
-    }),
-  }
-}
-
-/**
- * Get plugin options for dynamic plugins
- */
-export function getDynamicPluginOptions(dynamicPlugins: PluginDefinition[], config: ClientConfig) {
-  const options: any = {}
-
-  dynamicPlugins.forEach(plugin => {
-    const pluginKey = plugin.value.toString()
-    
-    switch (plugin.name) {
-    case 'grapesjs-blocks-basic':
-      options[pluginKey] = {
-        blocks: ['text', 'image', 'video', 'map'],
-        category: catBasic,
-      }
-      break
-        
-    case '@silexlabs/grapesjs-fonts':
-      options[pluginKey] = {
-        api_key: (config as any).fontsApiKey || 'dummy-key-for-development',
-        server_url: (config as any).fontsServerUrl,
-        api_url: (config as any).fontsApiUrl,
-      }
-      break
-        
-    case '@silexlabs/grapesjs-filter-styles':
-      options[pluginKey] = {
-        appendBefore: '.gjs-sm-sectors',
-      }
-      break
-        
-    case 'grapesjs-custom-code':
-      options[pluginKey] = {
-        blockLabel: 'HTML',
-        blockCustomCode: {
-          category: catComponents,
-        },
-        codeViewOptions: {
-          autoFormat: false,
-        },
-      }
-      break
-        
-    case '@silexlabs/grapesjs-symbols':
-      options[pluginKey] = {
-        appendTo: '.symbols-list-container',
-        emptyText: 'No symbol yet.',
-        primaryColor: PRIMARY_COLOR,
-        secondaryColor: SECONDARY_COLOR,
-        highlightColor: TERTIARY_COLOR,
-      }
-      break
-        
-    case '@silexlabs/grapesjs-storage-rate-limit':
-      options[pluginKey] = {
-        time: 5000,
-      }
-      break
-        
-    case '@silexlabs/grapesjs-notifications':
-      options[pluginKey] = {
-        container: notificationContainer,
-        reverse: true,
-      }
-      break
-        
-    case '@silexlabs/grapesjs-keymaps-dialog':
-      options[pluginKey] = {
-        longPressDuration: null,
-        shortcut: 'shift+h',
-      }
-      break
-    }
-  })
-
-  return options
-}
-
-export { notificationContainer }