@bipsync/apiclient/sample-reports/every-note-since-date.js

var APIClient = require( '@bipsync/apiclient' );


APIClient.generateReportTool( {

    'formats' : [ 'csv' ],

    schema : {
        'type' : 'object',
        'properties' : {
            'since' : {
                'title' : 'Get notes since this date',
                'type' : 'string'
            }
        },
        "required" : [ "since" ]
    },

    fetch : function() {

        APIClient( 'https://devenvone-api.bipsync.dev' )
            .then( function( client ) {

                // fetch all notes after since date
                client.requestAll( 'v1/research', { body : {
                        select : 'title,user,created,sharedGroups,fields,sharedUsers',
                        limit : 500,
                        sort: { 'created':  1 },
                        dateFormat : 'm/j/Y',
                        since: client.options.since
                    } } )
                    .then( function( notes ) {

                        // get all unique users, entities and project ids in notes
                        var userIds = new Set(),
                            entityIds = new Set(),
                            projectIds = new Set();
                        notes.forEach( function( note ) {
                            userIds.add( note.user );
                            ( ( note.fields ? note.fields.entities : [] ) || [] )
                                .map( entityIds.add.bind( entityIds ) );
                            ( ( note.fields ? note.fields.projects : [] ) || [] )
                                .forEach( projectIds.add.bind( projectIds ) );
                        } );

                        var output = {
                            notes : notes,
                            classifications : {}
                        };

                        // fetch all classifications
                        var chain = Promise.resolve().then( function() {
                            return client.request( 'v1/classification' );
                        } )
                            .catch( function() {} )
                            .then( function( documents ) {
                                if ( documents && documents.results ) {
                                    documents.results.forEach( function( document ) {
                                        output.classifications[ document.id ] = document;
                                    } );
                                }
                            } );

                        // resolve all references
                        var collections = [
                            { ids : userIds, url : 'v1/user/', name : 'users' },
                            { ids : entityIds, url : 'v2/category/', name : 'entities' },
                            { ids : projectIds, url : 'v1/project/', name : 'projects' }
                        ];
                        collections.forEach( function( collection ) {
                            collection.ids.forEach( function( id ) {
                                chain = chain.then( function() {
                                    return client.request( collection.url + id );
                                } )
                                    .catch( function() {} )
                                    .then( function( document ) {
                                        output[ collection.name ] = output[ collection.name ] || {};
                                        output[ collection.name ][ id ] = document;
                                    } );
                            } );
                        } );

                        chain.then( function() {
                            client.output( output );
                        } );

                    } );

            } );

    },

    render : function( helpers, view ) {

        var notes = view.notes,
            users = view.users,
            entities = view.entities,
            projects = view.projects,
            classifications = view.classifications;

        helpers.outputCSVLine( [
            'Subject',
            'Author',
            'Created Date',
            'User Group',
            'Entity/Project',
            'Content Type',
            'Sub Type'
        ] );

        notes.forEach( function( note ) {
            var shared = ( note.sharedGroups || [] ).length || ( note.sharedUsers || [] ).length;
            var line = [
                ( note.title || 'Untitled' ).substring( 0, 70 ),
                ( ( users[ note.user ] || {} ).name || '' ),
                note.created,
                !shared ? 'Private' : ( note.sharedGroups || [] ).join( ', ' )
            ];
            if ( note.fields && note.fields.entities ) {
                note.fields.entities.forEach( function( entityId ) {
                    var entity = ( entities[ entityId ] || {} );
                    helpers.outputCSVLine( line.concat( [
                        entity.name || '',
                        'Entity',
                        ( classifications[ entity.classification ] || {} ).name || ''
                    ] ) );
                } );
            }
            if ( note.fields && note.fields.projects ) {
                note.fields.projects.forEach( function( projectId ) {
                    var project = ( projects[ projectId ] || {} );
                    helpers.outputCSVLine( line.concat( [
                        project.name || '',
                        'Project',
                        project.pipeline || ''
                    ] ) );
                } );
            }
        } );

    }

} );