Bi-Directional Adapter

Factory to create bi-directional adapters that can convert between two distinct data structures. Using adapters helps to decouple systems which share common data structures and may need to alter them independently without introducing conflicts in each other.

Why?

You have multiple services which each operate on a single shared resource but want to represent the data differently in each service or want to isolate each service from data structure changes required by the other.

With bidirectional-adapter you can define a simple entity which can be used to transform data between two formats.

const adapter = createAdapter<string, number>(
  (stringValue) => parseInt(stringValue, 10),
  (numericValue) => String(numericValue)
);

Example

import axios from 'axios';
import createAdapter from 'bidirectional-adapter';

const accountAdapter = createAdapter(
  (dbAccount) => ({
    id: dbAccount.user_id,
    name: `${dbAccount.user.firstName} ${dbAccount.user.lastName}`,
    email: dbAccount.user.email,
  }),
  (appAccount) => ({
    user_id: appAcount.id,
    user: {
      firstName: appAccount.name.split(' ')[0],
      lastName: appAccount.name.split(' ')[1],
    },
    email: appAccount.email,
  })
);

const fetchAccount = (userID) => {
  // state is in the shape of propertyTwo
  // do reducer stuff here
  return axios.get(`/account/${userID}`).then((res) => accountAdapter.fromDB(res.data));
};

const updateAccount = (account) => {
  // state is in the shape of propertyTwo
  // do reducer stuff here
  return axios.post(`/account/${userID}`, accountAdapter.toDB(account));
};

Smart Adapter Example

import { createSmartMultiAdapter } from 'bidirectional-adapter';

interface DBModel {
  x: number;
  a: number;
  b: string;
  c1: boolean;
}

interface Model {
  x: number;
  ab: string;
  c2: boolean;
}

type KeyMap = [['a' | 'b', 'ab'], ['c1', 'c2']];

const adapter = createSmartMultiAdapter<DBModel, Model, [], [], KeyMap>(
  () => ({} as any),
  () => ({} as any)
);

adapter.fromDB({ a: 1, b: 'a', c1: false, x: 1 }); // Model
adapter.fromDB({ a: 1, b: 'a', c1: false }); // Pick<Model, 'ab' | 'c2'>
adapter.fromDB({ b: 'a', c1: false }); // Pick<Model, 'c2'>
adapter.fromDB({ x: 1 }); // Pick<Model, 'x1'>
adapter.fromDB({}); // EmptyObject

adapter.mapFromDB([{ a: 1, b: 'a', c1: false, x: 1 }]); // Model[]
adapter.mapFromDB([{ a: 1, b: 'a', c1: false }]); // Pick<Model, 'ab' | 'c2'>[]
adapter.mapFromDB([{ b: 'a', c1: false }]); // Pick<Model, 'c2'>[]
adapter.mapFromDB([{ x: 1 }]); // Pick<Model, 'x1'>[]
adapter.mapFromDB([{}]); // EmptyObject[]

adapter.toDB({ ab: '1', c2: false, x: 1 }); // DBModel
adapter.toDB({ ab: '1', x: 1 }); // Pick<DBModel, 'a' | 'b' | 'x'>
adapter.toDB({ c2: false }); // Pick<Model, 'c2'>
adapter.toDB({ x: 1 }); // Pick<Model, 'x1'>
adapter.toDB({}); // EmptyObject

adapter.mapToDB([{ ab: '1', c2: false, x: 1 }]); // DBModel
adapter.mapToDB([{ ab: '1', x: 1 }]); // Pick<DBModel, 'a' | 'b' | 'x'>
adapter.mapToDB([{ c2: false }]); // Pick<Model, 'c2'>
adapter.mapToDB([{ x: 1 }]); // Pick<Model, 'x1'>
adapter.mapToDB([{}]); // EmptyObject

Installation

To use bidirectional-adapter, install it as a dependency:

# If you use npm:
npm install bidirectional-adapter

# Or if you use Yarn:
yarn add bidirectional-adapter

This assumes that you’re using a package manager such as npm.

License