@maebog/lotr-sdk v1.0.3

Lord of the Rings SDK

This is an SDK for working with The One API To Rule Them all which provides facts and trivia concerning the Lord of The Rings franchise. The SDK currently supports a subset of the API's endpoints including those related to movies and quotes.

Installation

Add the SDK to your project using your favorite package manager:

npm i @maebog/lotr-sdk

OR

yarn add @maebog/lotr-sdk

OR

pnpm install @maebog/lotr-sdk

In order to use this SDK, you will need an API key which can be obtained from the API's website here. Remember to store it in a safe place, like in a .env file!

Usage

The SDK is written to be simple and typesafe. Refer to the following for examples of basic usage.

import { Client } from "@maebog/lotr-sdk";

const client = new Client({
  apiKey: "123",
});

// Fetch all movies using the API's default pagination settings
const response = await client.getMovies();

// response.data contains the exact response from the API
const movies = response.ok ? response.data.docs : [];

import { Client } from "@maebog/lotr-sdk";

const client = new Client({
  apiKey: "123",
});

// Fetch all movies matching the given regex sorted by name in ascending order
const response = await client.getMovies({
  sort: {
    field: "name",
    direction: "asc",
  },
  filter: [
    {
      field: "name",
      comparator: FilterType.REGEX,
      value: "/th/",
    },
  ],
});

const movies = response.ok ? response.data.docs : [];

import { Client } from "@maebog/lotr-sdk";

const client = new Client({
  apiKey: "123",
});

// Fetch a single movie by ID
const response = await client.getMovie("5cd95395de30eff6ebccde56");

const movie = response.ok ? response.data.docs[0] : undefined;

Testing

The SDK repository contains both unit and integration tests. In order to run integration tests, you will need to have an API key (see above) present in a .env file in the project root with the following contents:

API_KEY=<YOUR_API_KEY>

To run unit tests:

git clone https://github.com/hatchways-community/b37e95d01a0644f591f9c1314534bb55

npm install

npm run test:unit

To run integration tests:

git clone https://github.com/hatchways-community/b37e95d01a0644f591f9c1314534bb55

npm install

npm run test:integration

To run all tests:

git clone https://github.com/hatchways-community/b37e95d01a0644f591f9c1314534bb55

npm install

npm run test