morphism - GitLite

KO | EN

gitlite — search

#javascript #llm #go #golang #android #rust #deep-learning #windows #awesome #cli #kubernetes #security #openai #open-source

morphism

(★ 502)

⚡ Type-safe data transformer for JavaScript, TypeScript & Node.js.

File Explorer

Download Latest Version (.zip)

- config.yml
- - bug_report.md
  - feature_request.md
- PULL_REQUEST_TEMPLATE.MD
- settings.json
- - mophism-function-full-example.png
  - morphism.png
  - schema.png
- inferred-field-type.png
- schema-required-fields.png
- schema.png
- ts-action-function.png
- - reporter.spec.ts
  - reporter.ts
  - Validation.spec.ts
  - Validation.ts
- classObjects.spec.ts
- helpers.ts
- jsObjects.spec.ts
- morphism.spec.ts
- morphism.ts
- MorphismDecorator.ts
- MorphismRegistry.spec.ts
- MorphismRegistry.ts
- MorphismTree.spec.ts
- MorphismTree.ts
- types.ts
- typescript.spec.ts
- utils-test.ts
.babelrc
.editorconfig
.eslintrc.json
.gitattributes
.gitignore
.prettierrc
_config.yml
CODE_OF_CONDUCT.md
jest.config.js
LICENSE
now.json
package.json
README.md
tsconfig.json
tsconfig.prod.json
tsconfig.webpack.json
tslint.json
typedoc.js
webpack.config.ts
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/nobrainr/morphism

Downloads the entire project code from GitHub to your computer.

cd morphism

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install --save morphism

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Morphism

[![Financial Contributors on Open Collective](https://opencollective.com/morphism/all/badge.svg?label=financial+contributors)](https://opencollective.com/morphism) [![npm](https://img.shields.io/npm/v/morphism.svg?style=for-the-badge)][npm-url]
[![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/morphism.svg?style=for-the-badge)](https://github.com/nobrainr/morphism)
[![npm](https://img.shields.io/npm/dy/morphism.svg?style=for-the-badge)][trends-url]
[![CircleCI (all branches)](https://img.shields.io/circleci/project/github/nobrainr/morphism/master.svg?style=for-the-badge)][circleci-url]
[![Deps](https://img.shields.io/david/nobrainr/morphism.svg?style=for-the-badge)][deps-url]

> In many fields of mathematics, morphism refers to a structure-preserving map from one mathematical structure to another. A morphism **f** with source **X** and target **Y** is written **f : X → Y**. Thus a morphism is represented by an arrow from its **source** to its **target**.

_https://en.wikipedia.org/wiki/Morphism_

- ⚛️ Write your schema once, Transform your data everywhere
- 0️⃣ Zero dependencies
- 💪🏽 Typescript Support

---

- [Morphism](#Morphism)
  - [Getting started](#Getting-started)
    - [Installation](#Installation)
    - [Usage](#Usage)
    - [Example (TypeScript)](#Example-TypeScript)
  - [Motivation](#Motivation)
  - [TypeScript integration](#TypeScript-integration)
  - [Docs](#Docs)
    - [1. The Schema](#1-The-Schema)
      - [Schema actions](#Schema-actions)
      - [Schema Example](#Schema-Example)
      - [1.1 Using a strict Schema](#11-Using-a-strict-Schema)
    - [2. Morphism as Currying Function](#2-Morphism-as-Currying-Function)
      - [API](#API)
      - [Currying Function Example](#Currying-Function-Example)
    - [3. Morphism Function as Decorators](#3-Morphism-Function-as-Decorators)
      - [`toJsObject` Decorator](#toJsObject-Decorator)
      - [`toClassObject` Decorator](#toClassObject-Decorator)
      - [`morph` Decorator](#morph-Decorator)
    - [4. Default export: Morphism object](#4-Default-export-Morphism-object)
  - [More Schema examples](#More-Schema-examples)
    - [Flattening or Projection](#Flattening-or-Projection)
    - [Function over a source property's value](#Function-over-a-source-propertys-value)
    - [Function over a source property](#Function-over-a-source-property)
    - [Properties Aggregation](#Properties-Aggregation)
  - [Registry API](#Registry-API)
    - [Register](#Register)
    - [Map](#Map)
    - [Get or Set an existing mapper configuration](#Get-or-Set-an-existing-mapper-configuration)
    - [Delete a registered mapper](#Delete-a-registered-mapper)
    - [List registered mappers](#List-registered-mappers)
  - [Contribution](#Contribution)
  - [Similar Projects](#Similar-Projects)
  - [License](#License)

## Getting started

### Installation

```sh
npm install --save morphism
```

or in the browser

```html
<script src="https://unpkg.com/morphism/dist/morphism.js"></script>
<script>
  const { morphism, createSchema } = Morphism
</script>
```

### Usage

The entry point of a **morphism** is the **schema**. The `keys` represent the shape of your **target** object, and the `values` represents one of the several ways to access the properties of the incoming source.

```typescript
const schema = {
  targetProperty: 'sourceProperty'
};
```

Then use the `morphism` function along with the **schema** to transform any **source** to your desired **target**

```typescript
import { morphism } from 'morphism';

const source = {
  _firstName: 'Mirza'
};

const schema = {
  name: '_firstName'
};

morphism(schema, source);
➡
{
  "name": "Mirza"
}
```

You may specify properties deep within the source object to be copied to your desired target by using dot notation in the mapping `value`.
This is [one of the actions available](#schema-actions) to transform the source data

```typescript
const schema = {
  foo: 'deep.foo',
  bar: {
    baz: 'deep.foo'
  }
};

const source = {
  deep: {
    foo: 'value'
  }
};

morphism(schema, source);
➡
{
  "foo": "value",
  "bar": {
    "baz": "value"
  }
}
```

One important rule of `Morphism` is that **it will always return a result respecting the dimension of the source data.** If the source data is an `array`, morphism will outputs an `array`, if the source data is an `object` you'll have an `object`

```typescript
const schema = {
  foo: 'bar'
};

// The source is a single object
const object = {
  bar: 'value'
};

morphism(schema, object);
➡
{
  "foo": "value"
}

// The source is a collection of objects
const multipleObjects = [{
  bar: 'value'
}];

morphism(schema, multipleObjects);
➡
[{
  "foo": "value"
}]
```

### Example (TypeScript)

```typescript
import { morphism, StrictSchema } from 'morphism';

// What we have
interface Source {
  ugly_field: string;
}

// What we want
interface Destination {
  field: string;
}

const source: Source = {
  ugly_field: 'field value'
};

// Destination and Source types are optional
morphism<StrictSchema<Destination, Source>>({ field: 'ugly_field' }, source);
// => {field: "field value"}

// Or
const sources = [source];
const schema: StrictSchema<Destination, Source> = { field: 'ugly_field' };
morphism(schema, sources);
// => [{field: "field value"}]
```

▶️ [Test with Repl.it](https://repl.it/@yrnd1/Morphism-Full-Example)

## Motivation

We live in a era where we deal with mutiple data contracts coming from several sources (Rest API, Services, Raw JSON...). When it comes to transform multiple data contracts to match with your domain objects, it's common to create your objects with `Object.assign`, `new Object(sourceProperty1, sourceProperty2)` or by simply assigning each source properties to your destination. This can result in your business logic being spread all over the place.

`Morphism` allows you to keep this business logic centralized and brings you a top-down view of your data transformation. When a contract change occurs, it helps to track the bug since you just need to refer to your `schema`

## TypeScript integration

When you type your schema, this library will require you to specify each transformation for your required fields.

![schema](https://raw.githubusercontent.com/nobrainr/morphism/master/images/schema.png)

![schema-required-fields](https://raw.githubusercontent.com/nobrainr/morphism/master/images/schema-required-fields.png)

This library uses TypeScript extensively. The target type will be inferred from the defined schema.

![inferred field type](https://raw.githubusercontent.com/nobrainr/morphism/master/images/inferred-field-type.png)

When using an [`ActionFunction`](https://morphism.now.sh/modules/morphism#actionfunction) the input type is also inferred to enforce your transformations

![typed action function](https://raw.githubusercontent.com/nobrainr/morphism/master/images/ts-action-function.png)

See below the different options you have for the schema.

## Docs

📚 **[API documentation](https://morphism.now.sh)**

**`Morphism` comes with 3 artifacts to achieve your transformations:**

### 1. The Schema

A schema is an object-preserving map from one data structure to another.

The keys of the schema match the desired destination structure. Each value corresponds to an Action applied by Morphism when iterating over the input data.

#### Schema actions

You can use **4 kind of values** for the keys of your schema:

- [`ActionString`](https://morphism.now.sh/modules/_types_#actionstring): A string that allows to perform a projection from a property
- [`ActionSelector`](https://morphism.now.sh/interfaces/_types_.actionselector): An Object that allows to perform a function over a source property's value
- [`ActionFunction`](https://morphism.now.sh/interfaces/_types_.actionfunction): A Function that allows to perform a function over source property
- [`ActionAggregator`](https://morphism.now.sh/modules/_types_#actionaggregator): An Array of Strings that allows to perform a function over source property

#### Schema Example

```ts
import { morphism } from 'morphism';

const input = {
  foo: {
    baz: 'value1'
  }
};

const schema = {
  bar: 'foo', // ActionString: Allows to perform a projection from a property
  qux: ['foo', 'foo.baz'], // ActionAggregator: Allows to aggregate multiple properties
  quux: (iteratee, source, destination) => {
    // ActionFunction: Allows to perform a function over source property
    return iteratee.foo;
  },
  corge: {
    // ActionSelector: Allows to perform a function over a source property's value
    path: 'foo.baz',
    fn: (propertyValue, source) => {
      return propertyValue;
    }
  }
};

morphism(schema, input);
// {
//   "bar": {
//     "baz": "value1"
//   },
//   "qux": {
//     "foo": {
//       "baz": "value1"
//     }
//   },
//   "quux": {
//     "baz": "value1"
//   },
//   "corge": "value1"
// }
```

▶️ [Test with Repl.it](https://repl.it/@yrnd1/Morphism-Schema-Options)

⏩ [More Schema examples](#more-schema-examples)

📚 [Schema Docs](https://morphism.now.sh/classes/_morphismtree_.morphismschematree)

#### 1.1 Using a strict Schema

You might want to enforce the keys provided in your schema using `Typescript`. This is possible using a `StrictSchema`. Doing so will require to map every field of the `Target` type provided.

```ts
interface IFoo {
  foo: string;
  bar: number;
}
const schema: StrictSchema<IFoo> = { foo: 'qux', bar: () => 'test' };
const source = { qux: 'foo' };
const target = morphism(schema, source);
// {
//   "foo": "qux",
//   "bar": "test"
// }
```

### 2. Morphism as Currying Function

The simplest way to use morphism is to import the currying function:

```ts
import { morphism } from 'morphism';
```

`morphism` either outputs a mapping function or the transformed data depending on the usage:

#### API

```ts
morphism(schema: Schema, items?: any, type?: any): any
```

📚 [Currying Function Docs](https://morphism.now.sh/modules/morphism#morphism-1)

#### Currying Function Example

```ts
// Outputs a function when only a schema is provided
const fn = morphism(schema);
const result = fn(data);

// Outputs the transformed data when a schema and the source data are provided
const result = morphism(schema, data);

// Outputs the transformed data as an ES6 Class Object when a schema, the source data and an ES6 Class are provided
const result = morphism(schema, data, Foo);
// => Items in result are instance of Foo
```

### 3. Morphism Function as Decorators

You can also use Function Decorators on your method or functions to transform the return value using `Morphism`:

#### `toJsObject` Decorator

```ts
import { toJSObject } from 'morphism';

class Service {
  @toJSObject({
    foo: currentItem => currentItem.foo,
    baz: 'bar.baz'
  })
  async fetch() {
    const response = await fetch('https://api.com');
    return response.json();
    // =>
    // {
    //   foo: 'fooValue'
    //   bar: {
    //     baz: 'bazValue'
    //   }
    // };
  }
}

// await service.fetch() will return
// =>
// {
//   foo: 'fooValue',
//   baz: 'bazValue'
// }

--------------------------------

// Using Typescript will enforce the key from the target to be required
class Target {
  a: string = null;
  b: string = null;
}
class Service {
  // By Using <Target>, Mapping for Properties `a` and `b` will be required
  @toJSObject<Target>({
    a: currentItem => currentItem.foo,
    b: 'bar.baz'
  })
  fetch();
}
```

#### `toClassObject` Decorator

```ts
import { toClassObject } from 'morphism';

class Target {
  foo = null;
  bar = null;
}
const schema = {
  foo: currentItem => currentItem.foo,
  baz: 'bar.baz'
};
class Service {
  @toClassObject(schema, Target)
  async fetch() {
    const response = await fetch('https://api.com');
    return response.json();
    // =>
    // {
    //   foo: 'fooValue'
    //   bar: {
    //     baz: 'bazValue'
    //   }
    // };
  }
}

// await service.fetch() will be instanceof Target
// =>
// Target {
//   foo: 'fooValue',
//   baz: 'bazValue'
// }
```

#### `morph` Decorator

Utility decorator wrapping `toClassObject` and `toJSObject` decorators

```ts
import { toClassObject } from 'morphism';

class Target {
  foo = null;
  bar = null;
}
const schema = {
  foo: currentItem => currentItem.foo,
  baz: 'bar.baz'
};
class Service {
  @morph(schema)
  async fetch() {
    const response = await fetch('https://api.com');
    return response.json();
    // =>
    // {
    //   foo: 'fooValue'
    //   bar: {
    //     baz: 'bazValue'
    //   }
    // };
  }
  @morph(schema, Target)
  async fetch2() {
    const response = await fetch('https://api.com');
    return response.json();
  }
}
// await service.fetch() will be
// =>
// {
//   foo: 'fooValue',
//   baz: 'bazValue'
// }

// await service.fetch() will be instanceof Target
// =>
// Target {
//   foo: 'fooValue',
//   baz: 'bazValue'
// }
```

📚 [Morphism Function as Decorators Docs](https://morphism.now.sh/modules/_morphism_)

### 4. Default export: Morphism object

Morphism comes along with an internal registry you can use to save your schema attached to a specific **ES6 Class**.

In order to use the registry, you might want to use the default export:

```ts
import Morphism from 'morphism';
```

All features available with the currying function are also available when using the plain object plus the internal registry:

```typescript
// Currying Function
Morphism(schema: Schema, items?: any, type?: any): any

// Registry API
Morphism.register(type: any, schema?: Schema);
Morphism.map(type: any, data?: any);
Morphism.setMapper(type: any, schema: Schema);
Morphism.getMapper(type);
Morphism.deleteMapper(type);
Morphism.mappers
```

🔗 [Registry API Documentation](#registry-api)

## More Schema examples

### Flattening or Projection

```ts
import { morphism } from 'morphism';
// Source data coming from an API.
const source = {
  foo: 'baz',
  bar: ['bar', 'foo'],
  baz: {
    qux: 'bazqux'
  }
};
const schema = {
  foo: 'foo', // Simple Projection
  bazqux: 'baz.qux' // Grab a value from a deep path
};

morphism(schema, source);
//=> { foo: 'baz', bazqux: 'bazqux' }
```

▶️ [Test with Repl.it](https://repl.it/@yrnd1/Morphism-Flattening-Projection)

### Function over a source property's value

```ts
import { morphism } from 'morphism';
// Source data coming from an API.
const source = {
  foo: {
    bar: 'bar'
  }
};
let schema = {
  barqux: {
    path: 'foo.bar',
    fn: value => `${value}qux` // Apply a function over the source property's value
  }
};

morphism(schema, source);
//=> { barqux: 'barqux' }
```

▶️ [Test with Repl.it](https://repl.it/@yrnd1/Morphism-Function-over-a-source-propertys-value)

### Function over a source property

```ts
import { morphism } from 'morphism';
// Source data coming from an API.
const source = {
  foo: {
    bar: 'bar'
  }
};
let schema = {
  bar: iteratee => {
    // Apply a function over the source propery
    return iteratee.foo.bar;
  }
};

morphism(schema, source);
//=> { bar: 'bar' }
```

▶️ [Test with Repl.it](https://repl.it/@yrnd1/Function-over-a-source-property)

### Properties Aggregation

```ts
import { morphism } from 'morphism';
// Source data coming from an API.
const source = {
  foo: 'foo',
  bar: 'bar'
};
let schema = {
  fooAndBar: ['foo', 'bar'] // Grab these properties into fooAndBar
};

morphism(schema, source);
//=> { fooAndBar: { foo: 'foo', bar: 'bar' } }
```

▶️ [Test with Repl.it](https://repl.it/@yrnd1/Morphism-Properties-Aggregation)

## Registry API

📚 [Registry API Documentation](https://morphism.now.sh/classes/_morphismregistry_.morphismregistry)

#### Register

Register a mapper for a specific type. The schema is optional.

```js
Morphism.register(type: any, schema?: Schema);
```

#### Map

Map a collection of objects to the specified type

```ts
Morphism.map(type: any, data?: any);
```

#### Get or Set an existing mapper configuration

```ts
Morphism.setMapper(type: any, schema: Schema);
Morphism.getMapper(type);
```

#### Delete a registered mapper

```js
Morphism.deleteMapper(type);
```

#### List registered mappers

```js
Morphism.mappers;
```

## Contribution

- Twitter: [@renaudin_yann][twitter-account]
- Pull requests and stars are always welcome 🙏🏽 For bugs and feature requests, [please create an issue](https://github.com/emyann/morphism/issues)

## Similar Projects

- [`io-ts`](https://github.com/gcanti/io-ts)
- [`joi`](https://github.com/hapijs/joi/)
- [`object-mapper`](https://www.npmjs.com/package/object-mapper)
- [`autoMapper-ts`](https://www.npmjs.com/package/automapper-ts)
- [`C# AutoMapper`](https://github.com/AutoMapper/AutoMapper)
- [`node-data-transform`](https://github.com/bozzltron/node-json-transform)

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/nobrainr/morphism/graphs/contributors"><img src="https://opencollective.com/morphism/contributors.svg?width=890&button=false" /></a>

### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/morphism/contribute)]

#### Individuals

<a href="https://opencollective.com/morphism"><img src="https://opencollective.com/morphism/individuals.svg?width=890"></a>

#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/morphism/contribute)]

<a href="https://opencollective.com/morphism/organization/0/website"><img src="https://opencollective.com/morphism/organization/0/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/1/website"><img src="https://opencollective.com/morphism/organization/1/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/2/website"><img src="https://opencollective.com/morphism/organization/2/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/3/website"><img src="https://opencollective.com/morphism/organization/3/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/4/website"><img src="https://opencollective.com/morphism/organization/4/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/5/website"><img src="https://opencollective.com/morphism/organization/5/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/6/website"><img src="https://opencollective.com/morphism/organization/6/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/7/website"><img src="https://opencollective.com/morphism/organization/7/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/8/website"><img src="https://opencollective.com/morphism/organization/8/avatar.svg"></a>
<a href="https://opencollective.com/morphism/organization/9/website"><img src="https://opencollective.com/morphism/organization/9/avatar.svg"></a>

## License

MIT © [Yann Renaudin][twitter-account]

[twitter-account]: https://twitter.com/YannRenaudin
[npm-image]: https://badge.fury.io/js/morphism.svg?style=flat-square
[npm-url]: https://npmjs.org/package/morphism
[deps-url]: https://www.npmjs.com/package/morphism?activeTab=dependencies
[circleci-url]: https://circleci.com/gh/nobrainr/morphism
[trends-url]: https://www.npmtrends.com/morphism