@janiscommerce/api-save

API Save

A package to handle Janis Save APIs

Installation

npm install @janiscommerce/api-save

Usage

'use strict';

const { ApiSaveData } = require('@janiscommerce/api-save');
const { struct } = require('@janiscommerce/superstruct');

const MyRelatedModel = require('../../models/my-related-model');
const someAsyncTask = require('./async-task');

module.exports = class MyApiSaveData extends ApiSaveData {

	static get relationshipsParameters() {
		return {
			children: {
				modelClass: MyRelatedModel,
				mainIdentifierField: 'dbFieldForMainEntity',
				secondaryIdentifierField: 'dbFieldForRelatedEntity',
				shouldClean: false
			}
		};
	}

	static get idStruct() {
		return struct.optional('string|number');
	}

	static get mainStruct() {
		return struct.partial({
			name: 'string',
			description: 'string?',
			status: 'number'
		});
	}

	static get relationshipsStruct() {
		return struct.partial({
			children: ['string']
		});
	}

	postStructValidate() {
		return someAsyncTask(this.dataToSave.main);
	}

	format({ someField, ...restOfTheRecord }) {
		return {
			...restOfTheRecord,
			someField: `prefix-${someField}`
		};
	}

	async shouldSave(formattedItem) {
		const currentItem = await this.getCurrent();
		return formattedItem.someField !== currentItem.someField;
	}

	postSaveHook(id, savedData) {
		return someAsyncTask(id, savedData);
	}

};

API

The following getters and methods can be used to customize and validate your Save API. All of them are optional, however you're encouraged to implement static get mainStruct() so you don't save trash data in your DB.

static get relationshipsParameters()

You need to use this in case you're saving relationships with other models (mostly for relational databases) If you don't have any relationship, there's no need to implement it.

This getter must return an object mapping the name of the field that contains the relationship (must be a key in the struct's relationships property) to the parameters of that relationship. The parameters contain the following properties:

• modelClass: The class of the model that should save this relationship
• mainIdentifierField: The field name where the main ID should be saved
• secondaryIdentifierField: The field name where the related ID should be saved
• shouldClean: Indicates if previous relationships should be removed. Optional, defaults to false

static get idStruct()

This is used to validate the ID received as path parameter. Defaults to an optional string or number.

static get mainStruct()

This is used to validate the data received in the request, checking the data to be saved in the main entity. Defaults to an object with any property.

static get relationshipsStruct()

This is used to validate the data received in the request, checking the data to be passed to the relationships. Defaults to an object partial with no properties.

async postStructValidate()

This is used to validate the data received in the request, making additional validation even injecting data to the received data. If it returns a Promise, it will be awaited.

format(record)

You can use this to format your main record before it's saved. For example, mapping user friendly values to DB friendly values, add default values, etc. If it returns a Promise, it will be awaited.

async shouldSave(formattedItem)

This an optional method allows you to validate if saving the item is really necessary. This method is called after formatting the item with format().

• If you return false, the model will not be called for insert the new item or update the current. The API will response the status code 200 adding the id if received at the response body.
• If you return false on an API Post (without recordId) the API will set the status code 204 No Content .

async getCurrent()

You can use this to obtain the current item for DB. It only works when the API receives the id in the Endpoint (API PUT or PATCH) This method will throw an Error if is used in an API POST (without recordId)

async postSaveHook(id, record)

You can use this to perform a task after saving your main record. For example, emitting an event, logging something, etc. If it returns a Promise, it will be awaited.

Changelog

[8.0.0] - 2023-09-18

Changed

• Update @janiscommerce/api to version 8.0.0