@silexlabs/silex 3.0.0-alpha.21

package/src/ts/client/grapesjs/publish.ts

@@ -0,0 +1,386 @@
+import {html, render} from 'lit-html'
+import {map} from 'lit-html/directives/map.js'
+import grapesjs from 'grapesjs/dist/grapes.min.js'
+import { getPageSlug } from '../../page'
+import { onAll } from '../utils'
+
+// constants
+const pluginName = 'publish'
+export const cmdPublish = 'publish-open-dialog'
+let _token = null
+let projectId
+let rootUrl
+
+// plugin code
+export const publishPlugin = grapesjs.plugins.add(pluginName, (editor, opts) => {
+  opts = {
+    appendTo: 'options',
+    ...opts,
+  }
+  // Global config
+  rootUrl = opts.rootUrl
+  projectId = opts.projectId
+  // Keep track of the token
+  editor.on('login:success', async ({ getUser, getToken }) => {
+    _token = await getToken()
+  })
+  // add publication settings to the website
+  editor.on('storage:start:store', (data) => {
+    data.publication = editor.getModel().get('publication')
+  })
+  editor.on('storage:end:load', (data) => {
+    const model = editor.getModel()
+    model.set('publication', data.publication || {})
+  })
+  editor.Panels.addButton(opts.appendTo, {
+    id: 'publish-button',
+    className: 'silex-button--size publish-button',
+    command: cmdPublish,
+    attributes: { title: 'Publish' },
+    label: '<span class="fa fa-rocket"></span><span class="silex-button--small">Publish</span>',
+  })
+  editor.Commands.add(cmdPublish, {
+    run(editor) { openDialog(editor) },
+    stop(editor) { closeDialog(editor) },
+  })
+})
+
+export function getDialogElements() {
+  const el = document.querySelector('#publish-dialog')
+  return el ? {
+    dialog: el,
+    primary: el.querySelector('#publish-button--primary'),
+    secondary: el.querySelector('#publish-button--secondary'),
+  } : null
+}
+function createDialogElements() {
+  const el = document.createElement('div')
+  el.id = 'publish-dialog'
+  el.className = 'silex-dialog-inline silex-dialog gjs-two-color'
+  document.body.append(el)
+  return getDialogElements()
+}
+function move(rect) {
+  Object.keys(rect).forEach(key => dialog.style[key] = rect[key] + 'px')
+}
+function update(editor) {
+  render(html`
+    ${ open ? html`
+      <main>
+        ${ status === STATUS_PENDING ? html`
+          <p>Publication in progress</p>
+        ` : ''}
+        ${ status === STATUS_SUCCESS ? html`
+          <p>Publication success</p>
+          ${ url ? html`<a href="${url}" target="_blank">Click here to view the published website</a>` : ''}
+        ` : ''}
+        ${ status === STATUS_ERROR ? html`
+          <p>Publication error</p>
+          <div>${ errorMessage }</div>
+        ` : ''}
+        ${ state?.running ? html`
+          <progress
+            value=""
+            style="width: 100%;"
+          ></progress>
+        ` : ''}
+        ${ state.logs?.length ? html`
+          <details>
+            <summary>Logs</summary>
+            <pre style="
+              max-width: 100%;
+              max-height: 50vh;
+              overflow: auto;
+              font-size: x-small;
+              "
+            >${ cleanup(state.logs) }
+            </pre>
+          </details>
+        ` : '' }
+        ${ state.errors?.length ? html`
+          <details>
+            <summary>Errors</summary>
+            <pre style="
+              max-width: 100%;
+              max-height: 50vh;
+              overflow: auto;
+              font-size: x-small;
+              "
+            >${ cleanup(state.errors) }
+            </pre>
+          </details>
+        ` : '' }
+      </main>
+      <footer>
+        ${ status === STATUS_PENDING ? '' : html`
+          <button
+            class="silex-button silex-button--primary"
+            id="publish-button--primary"
+            @click=${() => startPublication(editor)}
+          >Publish</button>
+        `}
+        <button
+          class="silex-button silex-button--secondary"
+          id="publish-button--secondary"
+          @click=${() => editor.Commands.stop(cmdPublish)}
+        >Close</button>
+      </footer>
+    ` : ''}
+  `, dialog)
+  if(open) {
+    dialog.classList.remove('silex-dialog-hide')
+  } else {
+    dialog.classList.add('silex-dialog-hide')
+  }
+}
+export const STATUS_NONE='STATUS_NONE'
+export const STATUS_PENDING='STATUS_PENDING'
+export const STATUS_ERROR='STATUS_ERROR'
+export const STATUS_SUCCESS='STATUS_SUCCESS'
+export let status = STATUS_NONE
+export let open = false
+let errorMessage = ''
+let dialog
+let url // from the result of the first fetch when publishing
+let state = {
+  queued: false,
+  error: false,
+  running: false,
+  logs: [],
+  errors: [],
+}
+
+function cleanup(arr: string[][]): string {
+  return arr[arr.length-1]
+    ?.map(str => str.replace(/\[.*\]/g, '').trim())
+    ?.filter(str => !!str)
+    ?.join('\n')
+}
+
+function displayError(editor, message) {
+  console.error(message)
+  errorMessage = message
+  status = STATUS_ERROR
+  update(editor)
+}
+export async function closeDialog(editor) {
+  open = false
+  update(editor)
+}
+export async function toggleDialog(editor) {
+  if(open) closeDialog(editor)
+  else openDialog(editor)
+}
+export async function openDialog(editor) {
+  open = true
+
+  // Position
+  const buttonEl = editor.Panels.getPanel('options').view.el
+    .querySelector('.publish-button')
+  const rect = buttonEl.getBoundingClientRect()
+
+  const width = 450
+  const padding = 10 * 2
+  const minHeight = 50
+  if(!dialog) dialog = createDialogElements().dialog
+  move({
+    left: rect.right - width - padding,
+    top: rect.bottom + 10,
+    width,
+    minHeight,
+  })
+
+  // Publication
+  if(status === STATUS_NONE) {
+    startPublication(editor)
+  } else {
+    update(editor)
+  }
+}
+export async function startPublication(editor) {
+  if(status === STATUS_PENDING) throw new Error('Publication is already in progress')
+  status = STATUS_PENDING
+  update(editor)
+  editor.trigger('publish:before')
+  const projectData = editor.getProjectData()
+  const siteSettings = editor.getModel().get('settings')
+  const publicationSettings = editor.getModel().get('publication')
+  // Update assets URL to display outside the editor
+  const assetsFolderUrl = publicationSettings?.assets?.url
+  if(assetsFolderUrl) {
+    const publishedUrl = path => `${assetsFolderUrl}/${path.split('/').pop()}`
+    // New URLs for assets, according to site config
+    onAll(editor, c => {
+      // Attributes
+      if(c.get('type') === 'image') {
+        const path = c.get('src')
+        c.set('tmp-src', path)
+        c.set('src', publishedUrl(path))
+      }
+      //// Inline styles
+      //// This is handled by the editor.Css.getAll loop
+      //const bgUrl = c.getStyle()['background-image']?.match(/url\('(.*)'\)/)?.pop()
+      //if(bgUrl) {
+      //  c.set('tmp-bg-url', bgUrl)
+      //  c.setStyle({
+      //    ...c.getStyle(),
+      //    'background-image': `url('${publishedUrl(bgUrl)}')`,
+      //  })
+      //}
+    })
+    editor.Css.getAll()
+      .forEach(c => {
+        const bgUrl = c.getStyle()['background-image']?.match(/url\('(.*)'\)/)?.pop()
+        if(bgUrl) {
+          c.setStyle({
+            ...c.getStyle(),
+            'background-image': `url('${publishedUrl(bgUrl)}')`,
+          })
+          c.set('tmp-bg-url-css', bgUrl)
+        }
+      })
+  }
+  // Build the files structure
+  const files = await getFiles(editor, {siteSettings, publicationSettings})
+
+  // Create the data to send to the server
+  const data = {
+    ...projectData,
+    settings: siteSettings,
+    publication: publicationSettings,
+    projectId,
+    files,
+  }
+  // Reset asset URLs
+  if(assetsFolderUrl) {
+    onAll(editor, c => {
+      if(c.get('type') === 'image' && c.has('tmp-src')) {
+        c.set('src', c.get('tmp-src'))
+        c.set('tmp-src')
+      }
+      //// This is handled by the editor.Css.getAll loop
+      //if(c.getStyle()['background-image'] && c.has('tmp-bg-url')) {
+      //  c.setStyle({
+      //    ...c.getStyle(),
+      //    'background-image': `url('${c.get('tmp-bg-url')}')`,
+      //  })
+      //  c.set('tmp-bg-url')
+      //}
+    })
+    editor.Css.getAll()
+      .forEach(c => {
+        if(c.has('tmp-bg-url-css')) {
+          c.setStyle({
+            ...c.getStyle(),
+            'background-image': `url('${c.get('tmp-bg-url-css')}')`,
+          })
+          c.set('tmp-bg-url-css')
+        }
+      })
+  }
+  editor.trigger('publish:start', data)
+  let res
+  let json
+  try {
+    res = await fetch(`${ rootUrl }/publish`, {
+      method: 'POST',
+      body: JSON.stringify({
+        data,
+        token: _token,
+      }),
+      headers: {
+        'Content-Type': 'application/json'
+      },
+    })
+  } catch(e) {
+    displayError(editor, `An error occured, your site is not published. ${e.message}`)
+    editor.trigger('publish:stop', {success: false, message: e.message})
+    return
+  }
+  try {
+    json = await res.json()
+  } catch(e) {
+    displayError(editor, `Could not parse the server response, your site may be published. ${e.message}`)
+    editor.trigger('publish:stop', {success: false, message: e.message})
+    return
+  }
+  if(!res.ok) {
+    displayError(editor, `An network error occured, your site is not published. ${json.message}`)
+    editor.trigger('publish:stop', {success: false, message: json.message})
+    return
+  }
+  url = json.url
+  if(json.statusUrl) {
+    trackProgress(editor, json.statusUrl)
+  } else {
+    status = STATUS_SUCCESS
+    update(editor)
+    editor.trigger('publish:stop', {success: true})
+  }
+}
+
+async function getFiles(editor, {siteSettings, publicationSettings, }) {
+  return editor.Pages.getAll().map(page => {
+    const pageSettings = page.get('settings')
+    const pageName = publicationSettings?.autoHomePage !== false && page.get('type') === 'main' ? 'index' : (page.get('name') || page.get('type'))
+    function getSetting(name) {
+      return (pageSettings || {})[name] || (siteSettings || [])[name] || ''
+    }
+    const component = page.getMainComponent()
+    const slug = getPageSlug(pageName)
+    return {
+      html: `
+      <!DOCTYPE html>
+      <html lang="${ getSetting('lang') }">
+      <head>
+      <link rel="stylesheet" href="${publicationSettings?.css?.url || ''}/${slug}.css" />
+      ${ siteSettings?.head || '' }
+      ${ pageSettings?.head || '' }
+      <title>${ getSetting('title') }</title>
+      <link rel="icon" href="${ getSetting('favicon') }" />
+      ${
+  ['description', 'og:title', 'og:description', 'og:image']
+    .map(prop => `<meta property="${ prop }" content="${ getSetting(prop) }"/>`)
+    .join('\n')
+}
+      </head>
+      ${ editor.getHtml({ component }) }
+      </html>
+      `,
+      css: editor.getCss({ component }),
+      cssPath: `${ publicationSettings?.css?.path || '' }/${slug}${publicationSettings?.css?.ext || '.css'}`,
+      htmlPath: `${ publicationSettings?.html?.path || '' }/${slug}${publicationSettings?.html?.ext || '.html'}`,
+    }
+  })
+}
+
+export async function trackProgress(editor, statusUrl) {
+  let res
+  let json
+  try {
+    res = await fetch(statusUrl)
+  } catch(e) {
+    displayError(editor, `An error occured, your site is not published. ${e.message}`)
+    editor.trigger('publish:stop', {success: false, message: e.message})
+    return
+  }
+  try {
+    state = await res.json()
+  } catch(e) {
+    displayError(editor, `Could not parse the server response, your site may be published. ${e.message}`)
+    editor.trigger('publish:stop', {success: false, message: e.message})
+    return
+  }
+  if(!res.ok) {
+    displayError(editor, `An network error occured, your site is not published. ${res.statusText}`)
+    editor.trigger('publish:stop', {success: false, message: `An network error occured, your site is not published. ${res.statusText}`})
+    return
+  }
+  if(state.running) {
+    setTimeout(() => trackProgress(editor, statusUrl), 2000)
+  } else {
+    status = state.error ? STATUS_ERROR : STATUS_SUCCESS
+    editor.trigger('publish:stop', {success: state.error})
+  }
+  update(editor)
+}

package/src/ts/client/grapesjs/rich-text.ts

@@ -0,0 +1,16 @@
+import * as grapesjs from 'grapesjs/dist/grapes.min.js'
+
+const pluginName = 'richText'
+
+export const richTextPlugin = grapesjs.plugins.add(pluginName, (editor, opts) => {
+  editor.RichTextEditor.add('orderedList', {
+    icon: '1.',
+    attributes: {title: 'Ordered List'},
+    result: rte => rte.exec('insertOrderedList'),
+  })
+  editor.RichTextEditor.add('unorderedList', {
+    icon: '<i class="fa fa-list-ul"></i>',
+    attributes: {title: 'Unordered List'},
+    result: rte => rte.exec('insertUnorderedList'),
+  })
+})

package/src/ts/client/grapesjs/semantic.ts

@@ -0,0 +1,96 @@
+import {html, render} from 'lit-html'
+import {map} from 'lit-html/directives/map.js'
+import grapesjs from 'grapesjs/dist/grapes.min.js'
+
+// constants
+const pluginName = 'semantic'
+
+const tags = [
+  'DIV',
+  'P',
+  'H1',
+  'H2',
+  'H3',
+  'H4',
+  'H5',
+  'H6',
+  'SPAN',
+  'MAIN',
+  'ASIDE',
+  'SECTION',
+  'ADDRESS',
+  'ARTICLE',
+  'NAV',
+  'HEADER',
+  'FOOTER',
+  'DETAILS',
+  'SUMMARY',
+  'PRE',
+  'BLOCKQUOTE',
+]
+
+// plugin code
+export const semanticPlugin = grapesjs.plugins.add(pluginName, (editor, opts) => {
+  // Add the new trait to all component types
+  editor.DomComponents.getTypes().map(type => {
+    editor.DomComponents.addType(type.id, {
+      model: {
+        defaults: {
+          traits: [
+            // Keep the type original traits
+            ...editor.DomComponents.getType(type.id).model.prototype.defaults.traits,
+            // Add the new trait
+            {
+              label: 'Tag name',
+              type: 'tag-name',
+            },
+          ]
+        }
+      }
+    })
+  })
+
+  function doRender(el: HTMLElement, tagName: string) {
+    const tagsWithCurrent = tags.includes(tagName.toUpperCase()) ? tags : tags.concat(tagName.toUpperCase())
+    render(html`
+      <label for="semantic__select" class="gjs-one-bg silex-label">Type</label>
+      <select id="semantic__select" @change=${event => doRender(el, event.target.value)}>
+        ${map<string>(tagsWithCurrent, tag => html`
+          <option value="${tag}" ?selected=${tagName.toUpperCase() === tag}>${tag}</option>
+        `)}
+      </select>
+    `, el)
+  }
+  function doRenderCurrent(el: HTMLElement) {
+    doRender(el, editor.getSelected()?.get('tagName') || '')
+  }
+
+  // Add semantic traits
+  // inspired by https://github.com/olivmonnier/grapesjs-plugin-header/blob/master/src/components.js
+  editor.TraitManager.addType('tag-name', {
+    createInput({ trait }) {
+      // Create a new element container and add some content
+      const el = document.createElement('div')
+      // update the UI when a page is added/renamed/removed
+      editor.on('page', () => doRenderCurrent(el))
+      doRenderCurrent(el)
+      // this will be the element passed to onEvent and onUpdate
+      return el
+    },
+    // Update the component based on UI changes
+    // `elInput` is the result HTMLElement you get from `createInput`
+    onEvent({ elInput, component, event }) {
+      const value = elInput.querySelector('#semantic__select').value
+      if(component.get('tagName').toUpperCase() === value.toUpperCase()){
+        // Already done
+      } else {
+        component.set('tagName', value)
+      }
+    },
+    // Update UI on the component change
+    onUpdate({ elInput, component }) {
+      const tagName = component.get('tagName')
+      doRender(elInput, tagName)
+    },
+  })
+})

package/src/ts/client/grapesjs/settings.ts

@@ -0,0 +1,190 @@
+import {html, render} from 'lit-html'
+import {live} from 'lit-html/directives/live.js'
+import * as grapesjs from 'grapesjs/dist/grapes.min.js'
+
+import { WebsiteSettings } from '../../types'
+
+const pluginName = 'settings-dialog'
+const el = document.createElement('div')
+let modal
+
+// Get version from webpack (see plugin in webpack.config.js)
+declare const VERSION: string
+
+export const cmdOpenSettings = 'open-settings'
+
+let version = 'v3'
+export const settingsDialog = grapesjs.plugins.add(pluginName, (editor, opts) => {
+  // Display Silex version from package.json
+  try {
+    version = VERSION
+  } catch (error) {
+    // Cannot get version from webpack (see plugin in webpack.config.js)
+  }
+  console.log('Silex version:', version)
+  editor.Commands.add(cmdOpenSettings, {
+    run: (_, sender, {page}) => {
+      modal = editor.Modal.open({
+        title: page ? 'Page settings' : 'Site Settings',
+        content: '',
+        attributes: { class: 'settings-dialog' },
+      })
+        .onceClose(() => {
+          editor.stopCommand(cmdOpenSettings) // apparently this is needed to be able to run the command several times
+        })
+      displaySettings(editor, opts, page)
+      modal.setContent(el)
+      const form = el.querySelector('form')
+      form.onsubmit = event => {
+        event.preventDefault()
+        saveSettings(editor, opts, page)
+        editor.stopCommand(cmdOpenSettings)
+      }
+      form.querySelector('input')?.focus()
+      return modal
+    },
+    stop: () => {
+      modal.close()
+    },
+  })
+  // add settings to the website
+  editor.on('storage:start:store', (data) => {
+    data.settings = editor.getModel().get('settings')
+    data.name = editor.getModel().get('name')
+  })
+  editor.on('storage:end:load', (data) => {
+    const model = editor.getModel()
+    model.set('settings', data.settings || {})
+    model.set('name', data.name)
+    updateDom(editor)
+  })
+  editor.on('page', (e) => {
+    editor.Canvas.getFrameEl().addEventListener('load', () => {
+      updateDom(editor)
+    })
+  })
+})
+
+// Is the model a site or a page?
+function isSite(model) { return !!model.getHtml }
+
+function displaySettings(editor, config, model = editor.getModel()) {
+  const settings = model.get('settings') || {} as WebsiteSettings
+  model.set('settings', settings)
+  render(html`
+    <p>The page settings will override site settings, <a href="https://github.com/silexlabs/Silex/wiki/Settings" target="_blank">more info about settings here</a>.</p>
+    <form class="silex-form">
+      <h2>General settings</h2>
+      <div class="silex-form__group col2">
+        <label class="silex-form__element">
+          <h3>${isSite(model) ? 'Site name' : 'Page name'}</h3>
+          <p>${isSite(model) ? 'The project name in the editor, for you and your team.' : 'Label of the page in the editor, and file name of the HTML page.'}</p>
+          <input type="text" name="name" .value=${live(model.get('name') || '')}/>
+        </label>
+        <label class="silex-form__element">
+          <h3>Website language</h3>
+          <p>This is the default language code for this website. Example: en, fr, es...</p>
+          <input type="text" name="lang" .value=${live(settings.lang || '')}/>
+        </label>
+        <label class="silex-form__element">
+          <h3>Title</h3>
+          <p>Title of the browser window, and title in the search engines results. It is used by search engines to find out what your site is talking about. The title should be a maximum of 70 characters long, including spaces.</p>
+          <input type="text" name="title" .value=${live(settings.title || '')}/>
+        </label>
+        <label class="silex-form__element">
+          <h3>Description</h3>
+          <p>Description displayed by the search engines in search results. It is used by search engines to find out what your site is talking about. It is best to keep meta descriptions between 150 and 160 characters.</p>
+          <input type="text" name="description" .value=${live(settings.description || '')}/>
+        </label>
+        <label class="silex-form__element">
+          <h3>Favicon</h3>
+          <p>Small image displayed in the browser's address bar and in tabs. The recommended size is 16×16 or 32×32 pixels. This can be a URL or a relative path.</p>
+          <input type="text" name="favicon" .value=${live(settings.favicon || '')}/>
+        </label>
+      </div>
+      <h2>Social networks sharing</h2>
+      <div>
+        <p>Once your website is live, you can use these tools to test sharing:&nbsp;<a target="_blank" href="https://developers.facebook.com/tools/debug/">Facebook</a>,
+        <a target="_blank" href="https://cards-dev.twitter.com/validator">Twitter</a>,
+        <a target="_blank" href="https://www.linkedin.com/post-inspector/inspect/">Linkedin</a></p>
+      </div>
+      <div class="silex-form__group col2">
+        <label class="silex-form__element">
+          <h3>Title</h3>
+          <p>The title of your website displayed when a user shares your website on a social network.
+        Do not include any branding in this title, just eye-catching phrase, e.g. "Learn everything about fishing".
+        Title should be between 60 and 90 characters long.</p>
+          <input type="text" name="og:title" .value=${live(settings['og:title'] || '')}/>
+        </label>
+        <label class="silex-form__element">
+          <h3>Description</h3>
+          <p>Description displayed when a user shares your website on a social network. Make it catchy, and invite readers to visit your website too, e.g. "Sam's website about fishing, check it out!" Title should be between 60 and 90 characters long.</p>
+          <input type="text" name="og:description" .value=${live(settings['og:description'] || '')}/>
+        </label>
+        <label class="silex-form__element">
+          <h3>Image</h3>
+          <p>Thumbnail image which is displayed when your website is shared on a social network. The optimal size is 1200×627 pixels. At this size, your thumbnail will be big and stand out from the crowd. But do not exceed the 5MB size limit. If you use an image that is smaller than 400 pixels x 209 pixels, it will render as a much smaller thumbnail.</p>
+          <p>Please enter the full URL here, e.g. "http://mysite.com/path/to/image.jpg"</p>
+          <input type="text" name="og:image" .value=${live(settings['og:image'] || '')}/>
+        </label>
+      </div>
+      <h2>Code</h2>
+      <div class="silex-form__group">
+        <label class="silex-form__element">
+          <h3>HTML head</h3>
+          <p>HTML code which will be inserted in the HEAD tag.</p>
+          <textarea name="head" .value=${live(settings.head || '')}></textarea>
+        </label>
+      </div>
+      <footer>
+        <p class="silex-version">Silex ${version}</p>
+        <input class="silex-button" type="button" @click=${e => editor.stopCommand(cmdOpenSettings)} value="Cancel">
+        <input class="silex-button" type="submit" value="Ok">
+      </footer>
+    </form>
+  `, el)
+}
+
+function saveSettings(editor, config, model = editor.getModel()) {
+  const form = el.querySelector('form')
+  const formData = new FormData(form)
+  const data = Array.from(formData as any)
+    .reduce((aggregate, [key, value]) => {
+      aggregate[key] = value
+      return aggregate
+    }, {}) as {[key: string]: any}
+    // take the name out to the main model (by design in grapesjs pages)
+  const { name, ...settings } = data
+  model.set({
+    settings,
+    name,
+  })
+  // save if auto save is on
+  editor.getModel().set('changesCount', editor.getDirtyCount() + 1)
+  // update the DOM
+  updateDom(editor)
+}
+function getHeadContainer(doc, className) {
+  const container = doc.head.querySelector(`.${className}`)
+  if(container) {
+    return container
+  }
+  const newContainer = doc.createElement('div')
+  newContainer.classList.add(className)
+  doc.head.appendChild(newContainer)
+  return newContainer
+}
+function updateDom(editor) {
+  const doc = editor.Canvas.getDocument()
+  if(doc) {
+    // Site head
+    getHeadContainer(doc, 'site-head')
+      .innerHTML = editor.getModel().get('settings').head || ''
+    // Pages head
+    getHeadContainer(doc, 'page-head')
+      .innerHTML = editor.Pages.getSelected().get('settings')?.head || ''
+  } else {
+    // No document??
+  }
+}
+