cos-api4node/api.js

Atelier REST API wrapper

/** Atelier REST API wrapper
* http://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GSCF_ref#GSCF_C29114
*/
const httpModule = require('http')
const httpsModule = require('https')

module.exports = ( conn ) => {

    const { host, port, username, password, path, version, ns, https } = conn
    const http = https ? httpsModule : httpModule
    const auth = `${username}:${password}`
    const ok = res => ( res.statusCode === 200 ) || ( res.statusCode === 201 )
    // by default cache without license have up to 25 connections
    const agent = new http.Agent({ keepAlive: true, maxSockets: 10 })
    let cookies = []; //
    const updateCookies = res => {
        const resp_cookies = res.headers["set-cookie"] || []
        if ( !cookies.length ) {
            cookies = ( resp_cookies ).map( c => c ) //init session
        } else if ( resp_cookies[0] != cookies[0] ){
            cookies = ( resp_cookies ).map( c => c ) //update session
        }
    }

    const getHeaders = () => ({ "Cookie": cookies })
    // response handler factory
    const OnResp = ( cb ) => ( res ) => {

        let data = ''
        res.on( 'data', chunk => { data += chunk }) //accumulate all chunks
        res.on( 'end', () => {
            updateCookies( res )
            let parsed;
            if ( data ) try {
                parsed = JSON.parse( data )
            } catch ( e ) {
                parsed = data
            }

            if ( !ok( res ) ){
                const err = { code: res.statusCode, message: res.statusMessage }
                return cb( err, parsed )
            }
            cb( null, parsed )

        })

    }

    const headServer = ( cb ) => {

        const headers = getHeaders()
        http.request(
                { method: 'HEAD', host, port, path, auth, agent, headers },
                res => updateCookies( res ) || cb( !ok( res ) ) //without payload
            )
            .on( 'error', cb )
            .end()

    }

    const getServer = ( cb ) => {
        const headers = getHeaders()
        http.request( { host, port, path, auth, agent, headers }, OnResp( cb ) )
            .on( 'error', cb )
            .end()

    }

    const getDocNames = ( opts, cb ) => {

        opts = opts || {}
        let generated = +opts.generated || 0
        let filter = opts.filter || ''
        let category = opts.category || '*'
        const url = `${path}${version}/${ns}/docnames/${category}?generated=${generated}&filter=${filter}`
        const headers = getHeaders()
        http.request( { host, port, 'path': encodeURI(url), auth, agent, headers }, OnResp( cb ) )
            .on( 'error', cb )
            .end()

    }

    const getDoc = ( doc, cb ) => {

        const url = `${path}${version}/${ns}/doc/${doc}`
        const headers = getHeaders()
        http.request( { host, port, 'path': encodeURI(url), auth, agent, headers }, OnResp( cb ) )
            .on( 'error', cb )
            .end()

    }

    const putDoc = ( name, doc, params, cb ) => {

        if (typeof name !== "string")
            throw new Error(`Document name must be a string (${ name })`);
        if (!doc || typeof doc['enc'] === 'undefined' || !doc['content'])
            throw new Error(`Invalid document data ${ JSON.stringify(doc) }`);
        if (typeof params === "function" || !params) {
            cb = params;
            params = {};
        }

        const url = `${path}${version}/${ns}/doc/${name}${
            typeof params.ignoreConflict !== 'undefined'
                ? '?ignoreConflict=' + +params.ignoreConflict
                : ''
        }`
        const body = JSON.stringify(doc)

        const headers = Object.assign( {}, getHeaders(), {
            'Content-Type': 'application/json',
            'Content-Length': Buffer.byteLength(body, "utf8")
        })

        if ( params['If-None-Match'] ) {
            headers['If-None-Match'] = params['If-None-Match']
        }

        const req = http.request( {
            method: 'PUT', host, port, path: encodeURI(url), auth, agent, headers
        } , cb ? OnResp( cb ) : updateCookies )

        if (cb) {
            req.on( 'error', cb )
        }

        req.write( body )
        req.end()

    }

    const compile = ( docNames, cb ) => {

        if (typeof docNames === 'string')
            docNames = [ docNames ];
        if (!(docNames instanceof Array))
            throw new Error(`Document names must be an array (${ docNames })`);

        const url = `${path}${version}/${ns}/action/compile`
        const body = JSON.stringify(docNames)
        const headers = Object.assign( {}, getHeaders(), {
            'Content-Type': 'application/json',
            'Content-Length': Buffer.byteLength(body, "utf8")
        })

        const req = http.request( {
            method: 'POST', host, port, path: encodeURI(url), auth, agent, headers
        } , cb ? OnResp( cb ) : updateCookies )
        if (cb) req.on( 'error', cb )
        req.write( body )
        req.end()

    }

    const deleteDocs = ( docNames, cb ) => {

        if (typeof docNames === 'string')
            docNames = [ docNames ];
        if (!(docNames instanceof Array))
            throw new Error(`Document names must be an array (${ docNames })`);

        const url = `${path}${version}/${ns}/docs`
        const body = JSON.stringify(docNames)
        const headers = Object.assign({}, getHeaders(), {
            'Content-Type': 'application/json',
            'Content-Length': Buffer.byteLength(body, "utf8")
        })

        const req = http.request( {
            method: 'DELETE', host, port, path: encodeURI(url), auth, agent, headers
        } , cb ? OnResp( cb ) : updateCookies )
        if (cb) req.on( 'error', cb )
        req.write( JSON.stringify(docNames) )
        req.end()

    }

    return {
        compile,
        deleteDocs,
        getServer,
        getDocNames,
        getDoc,
        headServer,
        putDoc
    }

}