summaryrefslogtreecommitdiffstats
path: root/packages/gitbook/src/api/encodePage.js
blob: 89daccbe62f96df73fb6140a67563250ff1e801a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
const JSONUtils = require('../json');
const deprecate = require('./deprecate');
const encodeProgress = require('./encodeProgress');

/**
 * Encode a page in a context to a JS API
 *
 * @param {Output} output
 * @param {Page} page
 * @return {Object}
 */
function encodePage(output, page) {
    const book = output.getBook();
    const urls = output.getURLIndex();
    const summary = book.getSummary();
    const fs = book.getContentFS();
    const file = page.getFile();

    // JS Page is based on the JSON output
    const result = JSONUtils.encodePage(page, summary, urls);

    result.type = file.getType();
    result.path = file.getPath();
    result.rawPath = fs.resolve(result.path);

    result.setAttribute = (key, value) => {
        result.attributes[key] = value;
        return result;
    };

    deprecate.field(output, 'page.progress', result, 'progress', () => {
        return encodeProgress(output, page);
    }, '"page.progress" property is deprecated');

    deprecate.field(output, 'page.sections', result, 'sections', [
        {
            content: result.content,
            type: 'normal'
        }
    ], '"sections" property is deprecated, use page.content instead');

    return result;
}

module.exports = encodePage;