npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@janiscommerce/lambda-model-wrapper

v4.0.0

Published

A package to simplify wrapper model lambda functions in Janis Services

Downloads

1,042

Readme

Lambda Model Wrapper

Build Status Coverage Status npm version

A package to simplify wrapper model lambda functions in Janis Services

:inbox_tray: Installation

npm install @janiscommerce/lambda-model-wrapper

:page_with_curl: Usage

LambdaGet

LambdaGet is used to wrap the get() and getPaged() method from models.

Configuration

  • The getter modelClass should return the Model for our entity.
  • You can use mustHaveClient to defines if the function will be used for Client models. default true.
  • You can use mustHavePayload to make payload mandatory or not. default false.

ℹ️ The payload is used to apply params to the get() method, this will be explained below.

Parameters

All parameters are optional

  • fields. String Array to reduce response. For more information see @janiscommerce/model.
  • excludeFields. String Array to reduce response. Since 2.1.0. For more information see @janiscommerce/model.
  • allItems. Boolean to obtain all items, using getPaged() method. default false. Since 2.0.0
  • calculateTotals. Boolean to calculate totals with getTotals() method. default false. Since 2.0.0
  • filters, page, limit, order, changeKeys. Classic get() parameters. For more information see @janiscommerce/model.
  • formatParams. Object to pass parameters to format() method. Since 2.1.0. See Formatting results below.
  • onlyTotals. Boolean to only calculate totals with optional filters. Since 4.0.0.

Formatting results

The optional method async format(items, formatParams) allows you to format every item. The formatParams can be used give different behaviors to the function.

Totals

To obtain the totals object is required to

Response

The response of the lambda functions is explained in the @janiscommerce/lambda package.

Examples

First you need to create your lambda function.

'use strict';

const { Handler } = require('@janiscommerce/lambda');
const { LambdaGet } = require('@janiscommerce/lambda-wrapper-model');

const ProductModel = require('../../models/product');

class GetProduct extends LambdaGet {

	get modelClass() {
		return ProductModel;
	}

	async format(items, { countImages }) {
		return items.map(item => ({
			...item,
			...countImages && { imagesCount: item?.images.length || 0 }
		}));
	}
}

module.exports.handler = (...args) => Handler.handle(GetProduct, ...args);

For using the lambda you need to invoke with the @janiscommerce/lambda package.

'use strict';

const { Invoker } = require('@janiscommerce/lambda');

async () => {

	const response = await Invoker.clientCall('GetProduct', 'my-client-code');

	/**
	 *	response.payload: {
		 	items: [
				{ id: 1, referenceId: 'coke-2lt', name: 'Coke lts', stock: 100, images: ['coke-2lt.jpg'] },
				{ id: 2, referenceId: 'pepsi-2lt', name: 'Pepsi 2lts', stock: 100 },
				{ id: 3, referenceId: 'fanta-2lt', name: 'Fanta 2lts', stock: 95 }
			]
	 	}
	 */

	const filteredResponse = await Invoker.clientCall('GetProduct', 'my-client-code', {
		filters: { stock: 100 },
		fields: ['referenceId', 'images'],
		calculateTotals: true,
		formatParams: { countImages: true }
	});

	/**
	 *	filteredResponse.payload: {
		 	items: [
				{ id: 1, referenceId: 'coke-2lt', images: ['coke-2lt.jpg'], imagesCount: 1 },
				{ id: 2, referenceId: 'pepsi-2lt', imagesCount: 0 }
			],
			totals: { total: 2, page: 1 }
	 	}
	 */

};