gajus/slonik-interceptor-preset

Slonik interceptor preset.

slonik-interceptor-preset

Slonik interceptor preset.

Motivation

Slonik functionality is extendable using interceptors. Each interceptor is contained in a separate package. Installing and configuring each interceptor becomes a tedious task when using Slonik across multiple projects. slonik-interceptor-preset provides a factory function (createInterceptors) for constructing a collection of selected interceptors.

slonik-interceptor-preset installs these presets:

Name	Description
slonik-interceptor-field-name-transformation	Transforms Slonik query result field names.
slonik-interceptor-query-benchmarking	Benchmarks Slonik queries.
slonik-interceptor-query-logging	Logs Slonik queries.
slonik-interceptor-query-normalisation	Normalises Slonik queries.

Each interceptor can be selectively enabled/ disabled (see API).

API

import {
  createInterceptors
} from 'slonik-interceptor-preset';

/**
 * @property benchmarkQueries Dictates whether to enable the [query benchmarking interceptor](https://github.com/gajus/slonik-interceptor-query-benchmarking). (Default: false)
 * @property logQueries Dictates whether to enable the [query logging interceptor](https://github.com/gajus/slonik-interceptor-query-logging). (Default: true)
 * @property normaliseQueries Dictates whether to enable the [query normalisation interceptor](https://github.com/gajus/slonik-interceptor-query-normalisation). (Default: true)
 * @property transformFieldNames Dictates whether to enable the [field name transformation interceptor](https://github.com/gajus/slonik-interceptor-field-name-transformation). (Default: true)
 */
type UserConfigurationType = {|
  +benchmarkQueries: boolean,
  +logQueries: boolean,
  +normaliseQueries: boolean,
  +transformFieldNames: boolean
|};

(userConfiguration: UserConfigurationType) => $ReadOnlyArray<InterceptorType>;

Example usage

import {
  createPool
} from 'slonik';
import {
  createInterceptors
} from 'slonik-interceptor-preset';

const connection = createPool('postgres://', {
  interceptors: [
    ...createInterceptors()
  ]
});

slonik-interceptor-preset's Issues

TypeScript support

Would you consider adding TypeScript support to all of your interceptors ?

TypeScript type definitions

I would love to use this package in my TypeScript project, but the lack of types prevents this. Is there any way I can help get types for this package? Thank you for Slonik 💙!

make slonik a dev dependency

Since slonik is only used for types in this and all the child packages, could it be relegated to devDependencies? The dependency in package.json (16.8.0) isn't the latest version so by using this it's causing multiple copies of slonik to end up in my node_modules.

As a separate suggestion - might it make sense for this and all the other slonik-* packages be moved to https://github.com/gajus/slonik and that repo be made a lerna/yarn monorepo? That way it'd make it easier to apply fixed versioning to packages that do depend on slonik, test, track issues etc.