npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

microcms_sdk_generator

v0.1.1

Published

A type-safe MicroCMS SDK Generator

Downloads

220

Readme

microcms_sdk_generator

microcms_sdk_generator is a Deno tool designed to automatically generate TypeScript SDKs from your microCMS API schema. The tool leverages Zod schemas to ensure TypeScript type safety. Installation and usage are easily handled via npm or Deno.

Table of Contents

Features

  • Generates TypeScript SDKs from your microCMS API schema automatically.
  • Utilizes Zod schemas to maintain TypeScript type safety.
  • Supports usage in both server-side and client-side environments.

Getting Started

Installation with Deno

Execute the following command for installation using Deno.

deno install --allow-read --allow-write https://deno.land/x/microcms_sdk_generator/microcms_sdk_generator.ts

microcms_sdk_generator | Deno

Or execute directly.

deno run --allow-read --allow-write https://deno.land/x/microcms_sdk_generator/microcms_sdk_generator.ts

Installation with npm

Execute the following command for installation using npm.

npm install --global microcms_sdk_generator

microcms_sdk_generator - npm

Or execute directly.

npx microcms_sdk_generator

Usage

To use the tool, specify the directory of the schema files and the destination TypeScript file.

microcms_sdk_generator <schema directory> <destination typescript file>

For example, execute the following command on the root of this repository.

microcms_sdk_generator ./src/testdata/schemas ./src/testdata/generated.ts

SDK Usage

Initialize

Initialize the client with your service domain and API key.

const client = createClient({
  serviceDomain: "YOUR_SERVICE_DOMAIN",
  apiKey: "YOUR_API_KEY",
});

Making Requests

Use the client to make requests as follows.

const resp = await client[`${endpointName}`].list({...})
const resp = await client[`${endpointName}`].get({...})
const resp = await client[`${endpointName}`].post({...})
const resp = await client[`${endpointName}`].put({...})
const resp = await client[`${endpointName}`].patch({...})
const resp = await client[`${endpointName}`].delete({...})
const resp = await client[`${endpointName}`].listMetadata({...})
const resp = await client[`${endpointName}`].getMetadata({...})
const resp = await client[`${endpointName}`].patchStatus({...})

For example, for the sampleForListApi endpoint.

const listResp = await client.sampleForListApi.list({
  limit: 2,
  orders: ["-createdAt"],
});
if (!listResp.ok) {
  throw listResp;
}
console.log(listResp.data.contents);

Schema Files

Schema files need to be placed under the schema directory in the following structure:

  • {schema directory}
    • list
      • {endpointName}.json
      • ...
    • object
      • {endpointName}.json
      • ...

NOTE: microCMS currently does not support exporting schemas per endpoint. You will need to use the exported schema file, but this file does not resolve endpointName and API type (list or object). Therefore, you should structure your files as shown above.

Contributing

We welcome bug reports and feature requests through GitHub issues. Pull requests are also welcome.

License

This project is open-sourced under the MIT License. See the LICENSE file for details.

FAQ

How can I set up a retry policy?

You can prepare a fetcher capable of retrying, and specify it as a customFetcher in option.

e.g. vercel/async-retry: Retrying made simple, easy and async