@janiscommerce/api-save

API Save

A package to handle JANIS Views Save APIs

Installation

npm install @janiscommerce/api-save

Usage

'use strict';

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

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

class MyApiSaveData extends ApiSaveData {

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

	getStruct() {
		return struct({
			id: 'number',
			data: struct.partial({
				name: 'string',
				description: 'string?',
				status: 'number'
			}),
			relationships: struct.partial({
				children: ['number']
			})
		});
	}

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

}

module.exports = MyApiSaveData;

Changelog

[2.1.0] - 2019-07-26

Added

• Support for client specific models instanciation

Changed

• Now save APIs rely on API package, so they can be handled as common REST APIs

Fixed

• README updated