added: domGlobals and a bit more documentation

README.md

@@ -164,6 +164,48 @@ import render from '@riotjs/ssr'
 const html = render('html', MyRootApplication) 
 ```
 
+### Better SSR control using the createRenderer
+
+For a better control over your HTML rendering you might want to use the `createRenderer` factory function. 
+This method allows the creation of a rendering function receiving the `{getHTML, css, dispose, element}` option object.
+- `getHTML`: give you the rendered html of your component as string
+- `css`: the css of your component as string
+- `dispose`: clean the memory used on the server needed to render your component
+- `element`: the component instance you are mounting
+
+For example
+
+```js
+import { createRenderer } from '@riotjs/ssr'
+
+const logRendrer = createRenderer(({getHTML, css, dispose, component}) => {
+  const html = getHTML()
+
+  console.log('Rendering the component: %s', component.name)
+
+  dispose()
+  return { html, css }
+})
+```
+
+### DOM Globals
+
+`@riotjs/ssr` needs DOM globals (like `window`, `document` ...) to properly render your markup. 
+With the `domGlobals` exported object you can decide manually when the globals should be created and deleted from in your node applications.
+
+```js
+import { domGlobals } from '@riotjs/ssr'
+
+domGlobals.create()
+
+// global DOM object in your node environement are now defined 
+console.log(global.window, global.document) 
+
+// they will be cleared and will be undefined
+domGlobals.clear()
+```
+
+
 #### Caveat
 
 If you are rendering your whole HTML you will not be able to use multiple times the inline `<script>` `<style>` tags.

src/dom.js

@@ -1,6 +1,11 @@
 import {parseHTML} from 'linkedom'
 
-export function setup() {
+export function create() {
+  // no need to recreate globals
+  if (global.window && global.document && global.Node) {
+    return
+  }
+
   const {
     window,
     document,
@@ -12,11 +17,12 @@ export function setup() {
   global.Node = Node
 }
 
-export function dispose() {
-  if (global.window === undefined) {
+export function clear() {
+  if (!(global.window && global.document && global.Node)) {
     return
   }
+
   global.window = undefined
   global.document = undefined
   global.Node = undefined
-}
+}

src/index.js

@@ -41,7 +41,7 @@ export function createRenderer(
   componentAPI,
   props = {}
 ) {
-  dom.setup()
+  dom.create()
 
   const isRootNode = tagName === 'html'
   const root = document.createElement(tagName)
@@ -51,7 +51,7 @@ export function createRenderer(
   })
   const dispose = () => {
     // clear global scope
-    dom.dispose()
+    dom.clear()
     // unmount the component
     element.unmount()
     // remove the old stored css
@@ -127,9 +127,10 @@ const renderComponentAsync = curry((renderer, rendererPayload) => {
 })
 
 export const asyncRenderTimeout = 3000
+export const domGlobals = dom
 export const renderAsync = curry(createRenderer)(renderComponentAsync(getOnlyHTMLFromRenderer))
 export const renderAsyncFragments = curry(createRenderer)(renderComponentAsync(getFragmentsFromRenderer))
 export const fragments = curry(createRenderer)(getFragmentsFromRenderer)
 export const render = curry(createRenderer)(getOnlyHTMLFromRenderer)
 
-export default render
+export default render

test/core.spec.js

@@ -2,7 +2,7 @@ const register = require('../register')
 const {expect} = require('chai')
 const ssr = require('../')
 const render = ssr.default
-const { renderAsync, renderAsyncFragments, fragments, asyncRenderTimeout } = ssr
+const { renderAsync, renderAsyncFragments, fragments, asyncRenderTimeout, domGlobals } = ssr
 
 describe('ssr', () => {
   let unregister // eslint-disable-line
@@ -15,6 +15,24 @@ describe('ssr', () => {
     unregister()
   })
 
+  it('creates and deletes globals properly', function() {
+    expect(global.window).to.be.not.ok
+    expect(global.document).to.be.not.ok
+    expect(global.Node).to.be.not.ok
+
+    domGlobals.create()
+
+    expect(global.window).to.be.ok
+    expect(global.document).to.be.ok
+    expect(global.Node).to.be.ok
+
+    domGlobals.clear()
+
+    expect(global.window).to.be.not.ok
+    expect(global.document).to.be.not.ok
+    expect(global.Node).to.be.not.ok
+  })
+
   it('raw components can be rendered', function() {
     const SimpleComponent = require('./tags/simple-component.riot').default
 
@@ -115,4 +133,4 @@ describe('ssr', () => {
   it('does not pollute global scope with dom implementation', function(){
     expect(global.window).to.be.undefined
   })
-})
+})