search

useshortcut / shortcut-client-js

The official JavaScript client library for the Shortcut (formerly Clubhouse) REST API.
https://useshortcut.github.io/shortcut-client-js/
133 stars 31 forks source link

🚀 Complete rewrite for v1 #126

Closed charpeni closed 3 years ago

charpeni commented 3 years ago

Good news, everyone!

We heard you about missing endpoints and outdated types. We started this library based on our internal usages, especially for the mobile application. Unfortunately, we started moving to GraphQL and this library didn't receive all the attention it should and that's unfortunate. We want this library to follow closely our latest changes so we can all profit from this library and build awesome things with the Shortcut REST API.

So, we are working on a new and updated Swagger / OpenAPI schema that will expose our endpoints and their expected types. Then, from that Swagger schema, we rewrote entirely this library so we could generate a TypeScript client and all their associated entities. No more manual updates! 👏

The Swagger file will be available here (additional changes will land soon): https://shortcut.com/api/rest/v3#Swagger-OpenAPI-file.

We're still working on some tweaks, but we will soon be ready to publish a beta version of the complete rewrite as v1. ⚠️ We'll also publish it under a new name and not clubhouse-lib as formerly known.

👀 If you are curious and are not afraid of WIP, you can have a peek on next branch.

charpeni commented 3 years ago

A first beta version is now available at https://www.npmjs.com/package/@useshortcut/client.

charpeni commented 3 years ago

Published as @useshortcut/client@1.0.0. 🎉