microcms-ts-sdk

MicroCMS TypeScript SDK

This package is a wrapper for "microcms-js-sdk". More type-safe.

Getting Started

install

install npm package.

npm i microcms-ts-sdk
# or
yarn add microcms-ts-sdk

How to use

Supported of "microcms-js-sdk".
For more information on how to use this service, please click here.

Type safe usage

import { createClient, MicroCMSSchemaInfer } from 'microcms-ts-sdk';

// Type definition
type Content = {
  text: string;
};

interface Endpoints {
  // API in list format.
  list: {
    contents: Content;
  };
  // API in object format
  object: {
    content: Content;
  };
}

// Initialize Client SDK.
const client = createClient<Endpoints>({
  serviceDomain: 'YOUR_DOMAIN', // YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
  apiKey: 'YOUR_API_KEY'
});

// Schema type inference
type Schema = MicroCMSSchemaInfer<typeof client>;
/**
 * Schema[contents]
 * {
 *   id: string;
 *   createdAt: string;
 *   updatedAt: string;
 *   publishedAt?: string;
 *   revisedAt?: string;
 *   text: string;
 * }
 *
 * Schema[content]
 * {
 *   createdAt: string;
 *   updatedAt: string;
 *   publishedAt?: string;
 *   revisedAt?: string;
 *   text: string;
 * }
 */

It is also possible to use only type definitions for the original client. (Unsupported getAll method)

import { createClient } from 'microcms-js-sdk';
import { MicroCMSClient } from 'microcms-ts-sdk';

type Endpoints = {
  // definition
};

const client: MicroCMSClient<Endpoints> = createClient({
  serviceDomain: 'YOUR_DOMAIN',
  apiKey: 'YOUR_API_KEY'
});

Feature

Support endpoint specification.

// The "contents" will be complemented.
client.getList({ endpoint: 'contents' });

// Error: Not in list format endpoint.
client.getList({ endpoint: 'content' });

Support response types.

/**
 * // getList response type
 * {
 *  contents: {
 *    id: string;
 *    createdAt: string;
 *    updatedAt: string;
 *    publishedAt?: string;
 *    revisedAt?: string;
 *    text: string;
 *  }[];
 *  totalCount: number;
 *  limit: number;
 *  offset: number;
 * }
 */
client.getList({ endpoint: 'contents' });

/**
 * // Set options "queries.fields"
 * {
 *  contents: {
 *    id: string;
 *    publishedAt?: string;
 *    text: string;
 *  }[];
 *  totalCount: number;
 *  limit: number;
 *  offset: number;
 * }
 */
client.getList({
  endpoint: 'contents',
  queries: {
    fields: ['id', 'text', 'publishedAt'] // (keyof (Content & MicroCMSListContent))[]
  }
});

Support for all acquisitions.

/** Get all contents for endpoint */
client.getAll({
  endpoint: 'contents'
});

Support relation schema.
https://document.microcms.io/manual/api-model-settings#h9c184228ff

import { MicroCMSRelation } from 'microcms-ts-sdk';

type Writer = {
  name: string;
};

type Post = {
  title: string;
  writer: MicroCMSRelation<Writer>;
  relatedPosts: MicroCMSRelation<Post>[];
};

// endpoint name `posts` API type List for `Post`
client
  .getListDetail({
    endpoint: 'posts',
    contentId: 'xxxx',
    queries: {
      depth: 1 // 1 <= default | https://document.microcms.io/content-api/get-list-contents#h30fce9c966
    }
  })
  .then((res) => console.log(res));
/**
 * {
 *   id: string;
 *   createdAt: string;
 *   updatedAt: string;
 *   publishedAt?: string;
 *   revisedAt?: string;
 *   title: string;
 *   writer: {
 *     id: string;
 *     createdAt: string;
 *     updatedAt: string;
 *     publishedAt?: string;
 *     revisedAt?: string;
 *     name: string;
 *   }
 *   relatedPosts: {
 *     id: string;
 *     createdAt: string;
 *     updatedAt: string;
 *     publishedAt?: string;
 *     revisedAt?: string;
 *     title: string;
 *     writer: {
 *       id: string;
 *     }
 *     relatedPosts: {
 *       id: string;
 *     }
 *   }[]
 * }
 */

// get individual schema of depth.
type MicroCMSSchema = MicroCMSSchemaInfer<typeof client>;
type PostDetailDepth2 = MicroCMSDepthInfer<MicroCMSSchema['posts'], 2>; // depth: 2
/**
 * {
 *   id: string;
 *   createdAt: string;
 *   updatedAt: string;
 *   publishedAt?: string;
 *   revisedAt?: string;
 *   title: string;
 *   writer: {
 *     id: string;
 *     createdAt: string;
 *     updatedAt: string;
 *     publishedAt?: string;
 *     revisedAt?: string;
 *     name: string;
 *   }
 *   relatedPosts: {
 *     id: string;
 *     createdAt: string;
 *     updatedAt: string;
 *     publishedAt?: string;
 *     revisedAt?: string;
 *     title: string;
 *     writer: {
 *       id: string;
 *       createdAt: string;
 *       updatedAt: string;
 *       publishedAt?: string;
 *       revisedAt?: string;
 *       name: string;
 *     }
 *     relatedPosts: {
 *       id: string;
 *       createdAt: string;
 *       updatedAt: string;
 *       publishedAt?: string;
 *       revisedAt?: string;
 *       title: string;
 *       writer: {
 *         id: string;
 *       }
 *       relatedPosts: {
 *         id: string;
 *       }[]
 *     }[]
 *   }[]
 * }
 */

// microCMS POST method API
client.create({
  endpoint: 'posts',
  content: {
    title: 'example',
    writer: '< WRITER_CONTENT_ID >', // type-safe
    relatedPosts: ['< POST_CONTENT_ID >'] // type-safe
  }
});

LICENSE

Apache-2.0