packages/website/ts/utils/doc_utils.ts


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
46
47
48
49
50
51

import findVersions = require('find-versions');
import * as _ from 'lodash';
import { DoxityDocObj, S3FileObject, TypeDocNode, VersionToFileName } from 'ts/types';
import { utils } from 'ts/utils/utils';
import convert = require('xml-js');

export const docUtils = {
    async getVersionToFileNameAsync(s3DocJsonRoot: string): Promise<VersionToFileName> {
        const versionFileNames = await this.getVersionFileNamesAsync(s3DocJsonRoot);
        const versionToFileName: VersionToFileName = {};
        _.each(versionFileNames, fileName => {
            const [version] = findVersions(fileName);
            versionToFileName[version] = fileName;
        });
        return versionToFileName;
    },
    async getVersionFileNamesAsync(s3DocJsonRoot: string): Promise<string[]> {
        const response = await fetch(s3DocJsonRoot);
        if (response.status !== 200) {
            // TODO: Show the user an error message when the docs fail to load
            const errMsg = await response.text();
            utils.consoleLog(`Failed to load JSON file list: ${response.status} ${errMsg}`);
            return;
        }
        const responseXML = await response.text();
        const responseJSONString = convert.xml2json(responseXML, {
            compact: true,
        });
        const responseObj = JSON.parse(responseJSONString);
        const fileObjs: S3FileObject[] = _.isArray(responseObj.ListBucketResult.Contents)
            ? (responseObj.ListBucketResult.Contents as S3FileObject[])
            : [responseObj.ListBucketResult.Contents];

        const versionFileNames = _.map(fileObjs, fileObj => {
            return fileObj.Key._text;
        });
        return versionFileNames;
    },
    async getJSONDocFileAsync(fileName: string, s3DocJsonRoot: string): Promise<TypeDocNode | DoxityDocObj> {
        const endpoint = `${s3DocJsonRoot}/${fileName}`;
        const response = await fetch(endpoint);
        if (response.status !== 200) {
            // TODO: Show the user an error message when the docs fail to load
            const errMsg = await response.text();
            utils.consoleLog(`Failed to load Doc JSON: ${response.status} ${errMsg}`);
            return;
        }
        const jsonDocObj = await response.json();
        return jsonDocObj;
    },
};