@elastic.io/oih-standard-library

OIH Standard Library

Table of Contents

• Actions
  • Upsert Object
  • Lookup Object (at most 1)
  • Lookup Objects (Plural)
  • Delete Object
• Triggers
  • Get New and Updated Objects Polling
  • Webhooks

Actions

Upsert Object

Lookup Object (at most 1)

Lookup Objects (Plural)

Delete Object

For implementing Delete action in most cases you need to extend from DeleteById or DeleteByUniqueCriteria classes. If you need completely custom behaviour you can extend from Delete class and override process and deleteObject method, in this case following OIH standard is your responsibility.

Delete By ID

Note:

• If more than 1 object was found with same id, error would be thrown by this implementation
• If deleteObject method is returning null empty object would be emitted. You can indicate with null that object hasn`t been deleted or found.

1. Create Action
2. Create class that extends DeleteById class
3. Override findObjectById and deleteObject() methods. Example below.
4. Optional override getType and getId methods. Default implementation expects objectType to be present in input configuration and id in input message.
5. Create instance of your class and pass logger to constructor. const myDeleteByIDImpl = new MyDeleteByIdImpl(logger);
6. Export myDeleteByIDImpl.process(msg, cfg, snapshot) as process method. Example below.

Example of Usage

Works in sailor > 2.4.2 Delete Action

const { DeleteById } = require('@elastic.io/oih-standard-library/lib/actions/delete');

class MyDeleteByIDImpl extends DeleteById {

  async findObjectById(id, type, cfg, msg) { // In most cases you need just id, type and cfg
     const object =  await findObjectInAPI(id, type, cfg, msg); // objects that match this id
     const numberOfObjects =  object.count; // You do not need to check or throw error in this case, action implementation will do this
     return { // return structure must contain object and numberOfObjects found
       object,
       numberOfObjects
     }
  }
  async deleteObject(object, cfg, msg) { // In most cases you need just object, type and cfg
    const deletedID = await deleteObjectInAPI(object, cfg, msg); // Delete object
    return deletedID; // Return deleted object ID if you return null, empty object would be emitted.
  }
  // You can also override getType and getId methods if needed
}
   

async function process(msg, cfg, snapshot = {}) {
  const deleteAction = new MyDeleteByIDImpl(this.logger); // Sailor version > 2.4.2
  return deleteAction.process(msg, cfg, snapshot);
}

module.exports.process = process;

Delete By Unique Criteria

Note:

• If more than 1 object was found with same uniqueCriteria, error would be thrown by this implementation
• If deleteObject method is returning null empty object would be emitted. You can indicate with null that object hasn`t been deleted or found.

1. Create Action
2. Create class that extends DeleteById class
3. Override findObjectByCriteria and deleteObject() methods. Example below.
4. Optional override getType and getCriteria methods. Default implementation expects objectType to be present in input configuration. For unique criteria: uniqueCriteria field name in input configuration and value in input message.
5. Create instance of your class and pass logger to constructor. const myDeleteByCriteriaImpl = new MyDeleteByCriteriaImpl(logger);
6. Export myDeleteByCriteriaImpl.process(msg, cfg, snapshot) as process method. Example below.

Example of Usage

Works in sailor > 2.4.2 Delete Action

const { DeleteByUniqueCriteria } = require('@elastic.io/oih-standard-library/lib/actions/delete');

class MyDeleteByCriteriaImpl extends DeleteByUniqueCriteria {

  async findObjectByUniqueCriteria(criteria, type, cfg, msg) { // In most cases you need just criteria, type and cfg
     // criteria sructure {
     //  uniqueCriteria: 'fieldName',
     //  value: 'fieldValue', 
     // }
     const object =  await findObjectInAPI(criteria, type, cfg, msg); // objects that match this criteria
     const numberOfObjects =  object.count; // You do not need to check or throw error in this case, action implementation will do this
     return { // return structure must contain object and numberOfObjects found
       object,
       numberOfObjects
     }
  }
  async deleteObject(object, cfg, msg) { // In most cases you need just object, type and cfg
    const deletedID = await deleteObjectInAPI(object, cfg, msg); // Delete object
    return deletedID; // Return deleted object ID if you return null, empty object would be emitted.
  }
  // You can also override getType and getId methods if needed
}
   

async function process(msg, cfg, snapshot = {}) {
  const deleteAction = new MyDeleteByCriteriaImpl(this.logger); // Sailor version > 2.4.2
  return deleteAction.process(msg, cfg, snapshot);
}

module.exports.process = process;

Triggers

Get New and Updated Objects Polling

Webhooks