Celestia ✨

A GraphQL API for fetching Animal Crossing villager & amiibo data.

Table of Contents

Package
- Installation
  - Using Npm
  - Using Yarn
Usage
- Using Fetch
- Using Centra
Meta

Package

The package that comes with this API uses GraphQL Code Generator for full typings of the API.

Installation

Using Npm

npm install @ruffpuff/celestia

Using Yarn

yarn add @ruffpuff/celestia

Usage

Here is some example usage with the API, using the package @ruffpuff/celestia

Using Fetch

import type { Query } from '@ruffpuff/celestia';

interface AnimalCrossingResponse<K extends keyof Omit<Query, '__typename'>> {
  data: Record<K, Omit<Query[K], '__typename'>>;
}

fetch('http://localhost:0617', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    query: `
      {
        getVillagerByName(villager: bob) {
          key
          keyJp
          art
          species
          catchphrase
        }
      }
    `
  })
})
  .then(res => res.json() as Promise<AnimalCrossingResponse<'getVillagerByName'>>)
  .then(json => console.log(json.data));

Using @foxxie/fetch

import type { Query } from '@ruffpuff/celestia';
import { fetch } from '@foxxie/fetch';

interface AnimalCrossingResponse<K extends keyof Omit<Query, '__typename'>> {
  data: Record<K, Omit<Query[K], '__typename'>>;
}

fetch('http://localhost:0617')
  .body({
    query: `
        {
          getVillagerByName(villager: bob) {
            key
            keyJp
            art
            species
            catchphrase
          }
        }
    `
   })
  .post()
  .json<AnimalCrossingResponse<'getVillagerByName'>>()
    .then(json => console.log(json.data));