hwdtech / office-online-utils

Utility set for easy Office Online integration

Utility belt for Office Online integration

Discovery loader

WOPI discovery is the process by which a WOPI host identifies Office Online capabilities and how to initialize Office Online applications within a site See more here Discovery loader helps to process discovery.xml files easily, for ex

const { Discovery, actions } = require('office-online-utils');

(async () => {
  const discovery = await Discovery.fromFile(`path/to/discovery.xml`);

  // finds an action in https net-zone for viewing .docx files
  const action = discovery.action('https', actions.VIEW, 'docx');
})()

Discovery action urls have a bunch of template placeholders you have to replace. Actions allow to easily build final Office Online url, for ex

const { placeholders } = require('office-online-utils');

const officeUrl = action.getUrl(
  'https://example.com/wopi/files/123',
  {
    [placeholders.DC_LLCC]: 'en-US',
    [placeholders.UI_LLCC]: 'en-US',
    [placeholders.BUSINESS_USER]: false
  }
);

The resulted Office Online url can be used at the host page later

Default Host Page renderer

In the most cases file host page is a fullscreen version of Office Online page. Default host page renderer makes this event easier. Express example:

const { DefaultHostPage } = require('office-online-utils');

// assume app is an express app or router
app.get('/files/:id', (req, res, next) => {
  // build page options first 
  const hostPage = new DefaultHostPage(opts);
  res.setHeader('Content-Type', 'text/html');
  res.end(hostPage.render());
  
  // or
  hostPage.sendResponse(res);
});

You can see all available options here