reactioncommerce / api-utils

Utility functions for the Reaction API.

This repository is deprecated

This code is now located in our monorepo here

api-utils

Utility functions for the Reaction API.

How To Use

Note: Be sure you are using NPM 5+

First install in your project directory:

npm install @reactioncommerce/api-utils

Import API util functions in the file you wish to use them in

import functionName from "@reactioncommerce/api-utils/functionName.js";

Refer to package docs for a list of available functions.

Releases

This NPM package is published automatically on every push to the trunk branch. Be sure to use proper Git commit messages so that the version will be bumped properly and release notes can be automatically generated.

• Refer to https://github.com/semantic-release/semantic-release#commit-message-format
• To avoid triggering a release, such as for a README-only change, include [skip release] in your commit message.

api-utils's Issues

`totalCount` always equals `1` when using `getPaginatedResponseFromAggregate`

I've recently noticed that, no matter what pipeline you pass it, getPaginatedResponseFromAggregate seems to always return totalCount: 1.

The issue is that the $addFields stage that we're currently using doesn't seem to work anymore for calculating the number of objects returned.

getPaginatedResponseFromAggregate will return totalcount = null when no row return

should return 0 instead ?
maybe the sum aggregate will not take effect when no row returns.

Update Currency and Country definations for ZM

• Zambian ZM currency changed from ZMK to ZMW hence it will need to be updated
• There is no entry in currency defition for ZMW

getPaginatedResponse doesn't support MongoDB aggregate cursor

When passing an aggregate cursor to getPaginatedResponse, multiple errors are thrown because getPaginatedResponse tries to use methods and properties that don't work on aggregates, such as .count() and apparently .options.db.databaseName.

[Bug] - Searching for product with specific slug results in error while product slug exists

Issue Description

When searching for a product with the query catalogProductItem and using the value 8706401, it thinks it as a base64 string while it's the value of a valid product with slug.

Steps to Reproduce

1. Create a product with 8706401 as slug
2. Publish the product
3. Use catalogProductItem query to find the product by slug (value of slugOrId is 8706401)

Possible Solution

I think there needs to be a check if the provided value of property slugOrId is a valid base64 string which contains the namespace. If not, it needs to check if the slug exists.

Version

Reaction Commerce API: 3.8
api-catalog: 1.0.1

Pagination broken with `applyOffsetPaginationToMongoAggregate`

Aggregate pagination is very finicky. The $skip pipeline must always come before $limit. They are reversed in implementation, thus breaking offset based pagination for aggregations.

Missing Currency PKR

lib/CurrencyDefinitions.js does not include PKR although it's defined in CountryDefinitions.js

api-utils/lib/CountryDefinitions.js

Lines 1712 to 1720 in ac2f07c

	PK: {
	name: "Pakistan",
	native: "Pakistan",
	phone: "92",
	continent: "AS",
	capital: "Islamabad",
	currency: "PKR",
	languages: "en,ur"
	},

Cannot import mockConext in tests from plugins like api-plugin-catalogs

Jest globals cannot be imported outside of the test env. Jest seems to be complaining that mockContext imports @jest/globals outside of the test env. mocContext.js is imported into a test in a plugin.

 FAIL  src/mutations/applyCustomPublisherTransforms.test.js
  ● Test suite failed to run

    Do not import `@jest/globals` outside of the Jest test environment

      at Object.<anonymous> (node_modules/@jest/globals/build/index.js:23:7)
      at Object.<anonymous> (node_modules/@reactioncommerce/api-utils/lib/tests/mockContext.js:1:1)

Missing Currency (LKR - Sri Lankan Rupee)

LKR definition missing in both api-utils/lib/CurrencyDefinitions.js and reaction-admin/imports/utils/CurrencyDefinitions.js

Add method that accepts internal database ids as-is or an encoded opaque id

Summary

We've been in talks on whether the field _id and other encoded id fields in responses from the Reaction API should be prefixed and base64 encoded as opaque ids. We've decided to support both values in the response, and accept both as input for queries and mutations.

As part of the solution to this problem, we have to consider a method that can accept both the database id and the encoded opaque id.

Issue

Queries and mutations expect the ID to be the encoded opaque id.

Possible Solution

• Create a method that will accept both the internal database id or the encoded opaque id as input.
• Selectively decode the opaque ID or return the database id as-is

Considerations

• It should be fast. This method will be used a lot and the additional check may be a performance hit.
• There are no rules on what internal database ids can be. They may be generated by Random.id, or a Mongo object id or even generated from an external system.

Deprecation warnings in Node 16

When using Node 16 using this plugin gives you this warning for every plugin that uses it:

[DEP0148] DeprecationWarning: Use of deprecated folder mapping "./" in the "exports" field module 

Deprecation warnings in Node 16

When using Node 16 using this plugin gives you this warning for every plugin that uses it:

[DEP0148] DeprecationWarning: Use of deprecated folder mapping "./" in the "exports" field module 

Issue with decodeOpaqueId and product slugs

Issue : Decoding following product slug : "congelateur-midea-hs-186cn-copy" gives the error : ID namespace must be reaction/catalogItem

The Buffer.toString using utf8 returns a string containing : and thus gives namespace a weird value.
To fast check : https://stackblitz.com/edit/node-21kuap

Removing the "186" seems to fix it.