Merge pull request #17 from microcmsio/feature/types

feature: Improved type definition

Author: shibe97

src/createClient.ts

@@ -5,15 +5,25 @@
 import fetch from 'node-fetch';
 import { parseQuery } from './utils/parseQuery';
 import { isString } from './utils/isCheckValue';
-import { ClientParams, MakeRequest, GetRequest } from './types';
+import {
+  MicroCMSClient,
+  MakeRequest,
+  GetRequest,
+  GetListRequest,
+  GetListDetailRequest,
+  GetObjectRequest,
+  MicroCMSListResponse,
+  MicroCMSListContent,
+  MicroCMSObjectContent,
+} from './types';
 
 const BASE_DOMAIN = 'microcms.io';
 const API_VERSION = 'v1';
 
 /**
  * Initialize SDK Client
  */
-export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: ClientParams) => {
+export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMSClient) => {
   if (!serviceDomain || !apiKey) {
     throw new Error('parameter is required (check serviceDomain and apiKey)');
   }
@@ -74,9 +84,9 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: ClientPa
   };
 
   /**
-   * Get API data for microCMS
+   * Get list and object API data for microCMS
    */
-  const get = async <T>({
+  const get = async <T = any>({
     endpoint,
     contentId,
     queries = {},
@@ -88,7 +98,62 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: ClientPa
     return await makeRequest<T>({ endpoint, contentId, queries, useGlobalDraftKey });
   };
 
+  /**
+   * Get list API data for microCMS
+   */
+  const getList = async <T = any>({
+    endpoint,
+    queries = {},
+    useGlobalDraftKey,
+  }: GetListRequest): Promise<MicroCMSListResponse<T>> => {
+    if (!endpoint) {
+      return Promise.reject(new Error('endpoint is required'));
+    }
+    return await makeRequest<MicroCMSListResponse<T>>({ endpoint, queries, useGlobalDraftKey });
+  };
+
+  /**
+   * Get list API detail data for microCMS
+   */
+  const getListDetail = async <T = any>({
+    endpoint,
+    contentId,
+    queries = {},
+    useGlobalDraftKey,
+  }: GetListDetailRequest): Promise<T & MicroCMSListContent> => {
+    if (!endpoint) {
+      return Promise.reject(new Error('endpoint is required'));
+    }
+    return await makeRequest<T & MicroCMSListContent>({
+      endpoint,
+      contentId,
+      queries,
+      useGlobalDraftKey,
+    });
+  };
+
+  /**
+   * Get object API data for microCMS
+   */
+  const getObject = async <T = any>({
+    endpoint,
+    queries = {},
+    useGlobalDraftKey,
+  }: GetObjectRequest): Promise<T & MicroCMSObjectContent> => {
+    if (!endpoint) {
+      return Promise.reject(new Error('endpoint is required'));
+    }
+    return await makeRequest<T & MicroCMSObjectContent>({
+      endpoint,
+      queries,
+      useGlobalDraftKey,
+    });
+  };
+
   return {
     get,
+    getList,
+    getListDetail,
+    getObject,
   };
 };

src/index.ts

@@ -1 +1,2 @@
 export { createClient } from './createClient';
+export * from './types';

src/types.ts

@@ -1,33 +1,107 @@
-export interface ClientParams {
+/**
+ * microCMS createClient params
+ */
+export interface MicroCMSClient {
   serviceDomain: string;
   apiKey: string;
   globalDraftKey?: string;
 }
 
+type depthNumber = 1 | 2 | 3;
+
+/**
+ * microCMS queries
+ * https://document.microcms.io/content-api/get-list-contents#h9ce528688c
+ * https://document.microcms.io/content-api/get-content#h9ce528688c
+ */
+export interface MicroCMSQueries {
+  draftKey?: string;
+  limit?: number;
+  offset?: number;
+  orders?: string;
+  fields?: string | string[];
+  q?: string;
+  depth?: depthNumber;
+  ids?: string | string[];
+  filters?: string;
+}
+
+/**
+ * microCMS contentId
+ * https://document.microcms.io/manual/content-id-setting
+ */
+export interface MicroCMSContentId {
+  id: string;
+}
+
+/**
+ * microCMS content common date
+ */
+export interface MicroCMSDate {
+  createdAt: string;
+  updatedAt: string;
+  publishedAt: string;
+  revisedAt: string;
+}
+
+/**
+ * microCMS image
+ */
+export interface MicroCMSImage {
+  url: string;
+  width?: number;
+  height?: number;
+}
+
+/**
+ * microCMS list api Response
+ */
+export interface MicroCMSListResponse<T> {
+  contents: (T & MicroCMSListContent)[];
+  totalCount: number;
+  limit?: number;
+  offset: number;
+}
+
+/**
+ * microCMS list content common types
+ */
+export type MicroCMSListContent = MicroCMSContentId & MicroCMSDate;
+
+/**
+ * microCMS object content common types
+ */
+export type MicroCMSObjectContent = MicroCMSDate;
+
 export interface MakeRequest {
   endpoint: string;
   contentId?: string;
-  queries?: QueriesType;
+  queries?: MicroCMSQueries;
   useGlobalDraftKey?: boolean;
 }
 
 export interface GetRequest {
   endpoint: string;
   contentId?: string;
-  queries?: QueriesType;
+  queries?: MicroCMSQueries;
   useGlobalDraftKey?: boolean;
 }
 
-type depthNumber = 1 | 2 | 3;
+export interface GetListDetailRequest {
+  endpoint: string;
+  contentId: string;
+  queries?: MicroCMSQueries;
+  useGlobalDraftKey?: boolean;
+}
 
-export interface QueriesType {
-  draftKey?: string;
-  limit?: number;
-  offset?: number;
-  orders?: string;
-  fields?: string|string[];
-  q?: string;
-  depth?: depthNumber;
-  ids?: string|string[];
-  filters?: string;
+export interface GetListRequest {
+  endpoint: string;
+  queries?: MicroCMSQueries;
+  useGlobalDraftKey?: boolean;
+}
+
+export interface GetObjectRequest {
+  endpoint: string;
+  queries?: MicroCMSQueries;
+  useGlobalDraftKey?: boolean;
 }

src/utils/parseQuery.ts

@@ -6,10 +6,10 @@
  */
 import qs from 'qs';
 import { isObject } from './isCheckValue';
-import { QueriesType } from '../types';
+import { MicroCMSQueries } from '../types';
 
-export const parseQuery = (queries: QueriesType): string => {
-  if (!isObject<QueriesType>(queries)) {
+export const parseQuery = (queries: MicroCMSQueries): string => {
+  if (!isObject<MicroCMSQueries>(queries)) {
     throw new Error('queries is not object');
   }
   const queryString = qs.stringify(queries, {arrayFormat: 'comma'});