api v7 — coming soon! 🤘🏽

[kanadgupta]

Hey everyone! We wanted to provide y'all with an update on what we've been cooking up lately ⏲️

We've spent the last few weeks making lots of quality-of-life improvements to the code generation process and the generated SDKs themselves. We're still not quite finished yet, but we're excited to announce that the next major version of api is right around the corner!

Here's what you can expect:

• We've totally overhauled our SDK generation strategy so the generated SDK's types and module resolution should be consistent across all modern¹ JavaScript environments (CommonJS, ES Modules, TypeScript, etc.). The CLI no longer asks confusing configuration questions about the type of JavaScript SDK you want to generate — it now generates a fully-typed JavaScript SDK that ✨ just works ✨ in pretty much every modern JavaScript environment.
• New api CLI commands to help you better manage your SDK installation(s) — commands to list, rebuild, uninstall your SDKs.
• Lots of little DX niceties (license generation, configuration files with sensible defaults, etc.) so you can generate and publish a high-quality SDK to the NPM registry within minutes 🚀

Anything else you'd like to see? We'd love to hear your thoughts — feel free to leave a comment below! Also, if you could take a second to answer the poll below, we'd love to understand how you're using api-generated SDKs in practice.

Thanks for your feedback thus far — excited to see what y'all build with api v7!

-Kanad and the ReadMe team 🦉

Footnotes

1. Note that api v7 will require Node.js v18 or greater if you're a Node.js user, and TypeScript 5.2 if you're a TypeScript user. ↩

[jimmymcpeter]

I came across this library from Wistia's docs and was excited to try it. I ran into issues using it from my ESM package in Node v18 and was ready to use raw node-fetch/axios until I saw your comment on #604 to use api@next. I was able to use npx api@next install https://dash.readme.com/api/v1/api-registry/1sia28loivyd0b and now have a proper SDK with typings and autocomplete -- thank you for this upgrade

[kanadgupta]

Great to hear it's working for you @jimmymcpeter!

[elongberg]

Using this for the first time with 7shifts, TypeScript 5.2 and commonjs module, had a few issues at first with the api 6.1.1 version but switched to npx api@next install @7shifts/v2.2023.0501#1mj6ytblo5wg4q4 and everything just works!

Just a few changes I'd like to see so far:

1. The currently generated code exports a single instance of the SDK. However, we need multiple concurrent instances of the SDK each with a different .auth(...) setup. It's my understanding that the v6 api supported this with something like const client = sdk(...), but that's no longer the case. We're working around this by tweaking the generated index.ts, but it would be nice if we didn't have to.
2. This is a bit of a special case, but 7Shifts isn't a valid identifier. The generated code snippets to try out don't consider that, i.e.

import 7Shifts from '@api/7shifts';

7Shifts.auth('token');
7Shifts.auth('token');
7Shifts.whoAmI()
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));

3. Perhaps related to the above: we've had to do some finagling to get the importing working. This is BEFORE any changes mentioned above:

import * as fauxAPI from "@api/7shifts";
const api = (fauxAPI as any).default as typeof fauxAPI;
api.auth(...);

[ben-pr-p]

Hi all, any timeline for release?

I'm getting this error: #698

With .postUsers_list using npx api install "@solidarity-tech/v1.0#qsba52hlzrqusc0" --lang ts --yes, and not sure how to proceed.