Schema Quick Start

Consider a typical blog post. The API response for a single post might look something like this:

{
  "id": "123",
  "author": {
    "id": "1",
    "name": "Paul"
  },
  "title": "My awesome blog post",
  "comments": [
    {
      "id": "324",
      "createdAt": "2013-05-29T00:00:00-04:00",
      "commenter": {
        "id": "2",
        "name": "Nicole"
      }
    }
  ]
}

We have two nested entity types within our article: users and comments. Using various schema, we can normalize all three entity types down:

TypeScript

import { normalize, schema, Entity } from '@data-client/normalizr';

// Define a users schema
class User extends Entity {
  readonly id: string = '';
  readonly name: string = '';

  pk() { return this.id; }
}

// Define your comments schema
class Comment extends Entity {
  readonly id: string = '';
  readonly createdAt = Temporal.Instant.fromEpochSeconds(0);
  readonly commenter: User = User.fromJS({});

  pk() { return this.id; }

  static schema = {
    commenter: User,
    createdAt: Temporal.Instant.from,
  }
}

// Define your article
class Article extends Entity {
  readonly id: string = '';
  readonly title: string = '';
  readonly author: User = User.fromJS({});
  readonly comments: Comment[] = [];

  pk() { return this.id; }

  static schema = {
    author: User,
    comments: [Comment],
  }
}

const normalizedData = normalize(originalData, article);

JavaScript

import { normalize, schema, Entity } from '@data-client/normalizr';

// Define a users schema
class User extends Entity {
  pk() { return this.id; }
}

// Define your comments schema
class Comment extends Entity {
  pk() { return this.id; }

  static schema = {
    commenter: User,
    createdAt: Date,
  }
}

// Define your article
class Article extends Entity {
  pk() { return this.id; }

  static schema = {
    author: User,
    comments: [Comment],
  }
}

const normalizedData = normalize(originalData, article);

Now, normalizedData will be:

{
  result: "123",
  entities: {
    "articles": Article {
      "123": {
        id: "123",
        author: "1",
        title: "My awesome blog post",
        comments: [ "324" ]
      }
    },
    "users": {
      "1": User { "id": "1", "name": "Paul" },
      "2": User { "id": "2", "name": "Nicole" }
    },
    "comments": {
      "324": Comment {
        id: "324",
        "createdAt": "2013-05-29T00:00:00-04:00",
        "commenter": "2"
      }
    }
  }
}