Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tsuki-lab/microcms-ts-sdk
This package is a wrapper for "microcms-js-sdk". More type-safe.
https://github.com/tsuki-lab/microcms-ts-sdk
microcms sdk typescript
Last synced: 28 days ago
JSON representation
This package is a wrapper for "microcms-js-sdk". More type-safe.
- Host: GitHub
- URL: https://github.com/tsuki-lab/microcms-ts-sdk
- Owner: tsuki-lab
- License: apache-2.0
- Created: 2022-11-15T15:25:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T06:23:15.000Z (6 months ago)
- Last Synced: 2024-12-14T17:39:49.917Z (about 1 month ago)
- Topics: microcms, sdk, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/microcms-ts-sdk
- Size: 479 KB
- Stars: 31
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MicroCMS TypeScript SDK
This package is a wrapper for "microcms-js-sdk". More type-safe.
[](https://badge.fury.io/js/microcms-ts-sdk)
[](https://opensource.org/licenses/Apache-2.0)
## Getting Started
### install
install npm package.
```shell
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](https://github.com/microcmsio/microcms-js-sdk#how-to-use).
### Type safe usage
```ts
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({
serviceDomain: 'YOUR_DOMAIN', // YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
apiKey: 'YOUR_API_KEY'
});
// Schema type inference
type Schema = MicroCMSSchemaInfer;
/**
* 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)
```ts
import { createClient } from 'microcms-js-sdk';
import { MicroCMSClient } from 'microcms-ts-sdk';
type Endpoints = {
// definition
};
const client: MicroCMSClient = createClient({
serviceDomain: 'YOUR_DOMAIN',
apiKey: 'YOUR_API_KEY'
});
```
## Feature
Support endpoint specification.
```ts
// The "contents" will be complemented.
client.getList({ endpoint: 'contents' });
// Error: Not in list format endpoint.
client.getList({ endpoint: 'content' });
```
Support response types.
```ts
/**
* // 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.
```ts
/** Get all contents for endpoint */
client.getAll({
endpoint: 'contents'
});
```
Support relation schema.
https://document.microcms.io/manual/api-model-settings#h9c184228ff
```ts
import { MicroCMSRelation } from 'microcms-ts-sdk';
type Writer = {
name: string;
};
type Post = {
title: string;
writer: MicroCMSRelation;
relatedPosts: MicroCMSRelation[];
};
// 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;
type PostDetailDepth2 = MicroCMSDepthInfer; // 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