parse-audit-log v1.0.10

parse-audit-logger

A typescript framework that helps you audit log the changes to your parse objects as well as log queries on the objects. 📕📖

Installation

Simply install the package from the official npm repository

npm install parse-audit-logger

Usage

To use parse audit logger in your parse server, you need initialize the auditLogger in your entry point.. The constructor takes various options read about the options .

// src/server.ts
import { AuditLogger } from 'parse-audit-logger'
AuditLogger.initialize({
    /// can provide options. 
})

Now you can use AuditLogger.audit(req) in your triggers to audit the request.

// controllers/myClass.ts
import { AuditLogger } from 'parse-audit-logger'
    
Parse.Cloud.AfterSave('MyClass', async (req)=>{
    //Do your stuff here
    // .
    // .
    // .

    await AuditLogger.audit(req);
})

Important note

If in your parse server allowClientClassCreation is set to false, you either need to supply useMasterKey: true while creating the AuditLogger object, or else supply the audit schemas by using getAuditLoggerSchemas while creating schemas.

/*
* If allowClientClassCreation is set to false,
* either use masterKey to create the audit objects
*/
AuditLogger.initialize({
    // ...other options
	useMasterKey:true,
});
	
/*
* Or,supply the returned schemas along with your schemas 
* to your parse server
*/ 
const auditSchemas = AuditLogger.schemas(...yourClassName);
const parseServerOptions = {
    // ...yourParseServerOptions,
    schema:{
        // ...yourParseServerSchemaOptions
        definitions: [
            // ...yourDefinitions,
            ...auditSchemas
        ]
    }
};

const parse = new ParseServer(parseServerOptions);

Options

The options taken by the constructor are given below

Issues & Contributions

Feel free to create issues 😵‍💫 or ask questions 🤨 in issues tab if you have any. You can also create pull requests 💻 to main branch if you have something to contribute. Thanks! 🙏