Utility for removing extraneous params via ts-interface-checker

[!WARNING]
It's fine if you use this library from NPM package with a static versioning in case you want it for some pet-project or to test it's capabilities.

But for production use it's strongly recommended to create a fork, because I do not write Changelogs and may break / add some functionality without notice.

Installation

Add dk-checker-remove-extraneous to package.json and install.

Usage

This lib works with ts-interface-checker. You can use dk-file-generator for suitable validators generation.

Add to places where validators are used, ex. for API response:

1import _ from 'lodash';
2import { createCheckers } from 'ts-interface-checker';
3import { removeExtraneousParams } from 'dk-checker-remove-extraneous';
4
5import * as apiValidatorsRaw from 'validators/api';
6
7const apiValidators = _.mapValues(apiValidatorsRaw, (value) => createCheckers(value));
8
9function validateResponse(
10  apiName: string,
11  response: any
12) {
13  const validators = apiValidators[apiName];
14
15  try {
16    // Check mandatory params, throw on error
17    validators.TypeResponse.check(response);
18
19    // Clear extraneous params for compatibility (mutable operation)
20    removeExtraneousParams({
21      data: response,
22      validators: validators.TypeResponse, // TypeResponse is a checker, use your name
23      logger: ({ extraneousPaths }) => {
24        console.warn(`Omitted extraneous ${JSON.stringify(extraneousPaths)} for "api/${apiName}"`);
25      },
26    });
27
28    // Now response is carefully checked and extraneous params are removed,
29    // it's safe to use it as expected
30    return response;
31  } catch (error) {
32    throw new Error(`validateResponse: ${error.message} for "api/${apiName}"`);
33  }
34}
35
36// Use in fetch
37fetch(url)
38  .then(fetchResponse => fetchResponse.json())
39  .then(response => validateResponse('someApi', response))
40  .then(validatedResponse => someLogic(validatedResponse))
41  .catch((error) => someErrorHandler(error));