Generate sources based on OpenAPI definition

[donny-dont]

There are a good amount of API values missing from the definitions in the package. Keeping track of all the values is a pretty large task given how big the API is. Since the values are defined in an OpenAPI specification it makes sense to generate code from that definition for the package.

[donny-dont]

@arnemolland so I've been working on this over in https://github.com/donny-dont/figma/tree/v8 and I'm ready to start landing the changes.

Initial PR for starting the dev is #64 which sets things up for the coming changes.

My thought is to generate definitions specific to each API endpoint and open individual PRs on them so its easier to review. Last step would be landing the generator in the tool folder.

I've gotten things to generate for things that don't require a hierarchy and that's really the last step to get stuff like Node nailed down.

This seem reasonable?

[donny-dont]

Would be good to have a copyright header to use as well while we're here.

[donny-dont]

👋 hey @arnemolland wanted to give you an update on all of this.

So I have this branch https://github.com/donny-dont/figma/tree/v8-dev where I've pretty much completed the transition to generating all the files, minus the client itself from the OpenAPI definition. It hits all the data types used by the endpoints the library currently uses. The only thing missing is some converters for some types that are typedefed to Object.

I have the generator on a different branch, https://github.com/donny-dont/figma/tree/v8. Its got a bunch of experiments on it so its something I'm going to need to go back clean up and land properly.

I've also been adding PRs to the rest spec definition over at https://github.com/figma/rest-api-spec/pulls .

So my question about copyright headers is still outstanding but the bigger question is how to land this all. Not sure your long term plans for the library is. After the code generation has landed I don't think there will need to be much development at all, just rerun the generator whenever a new version appears. I've got a project at work that's using the library that needed additional types so that's why I've been doing this. I know you've got other things going on but it would be great if we could work through these commits and release a dev version in the next week or so.

Let me know what you want to do with everything. Thanks again for all the reviews and assistance.

[arnemolland]

👋 hey @arnemolland wanted to give you an update on all of this.

So I have this branch https://github.com/donny-dont/figma/tree/v8-dev where I've pretty much completed the transition to generating all the files, minus the client itself from the OpenAPI definition. It hits all the data types used by the endpoints the library currently uses. The only thing missing is some converters for some types that are typedefed to Object.

I have the generator on a different branch, https://github.com/donny-dont/figma/tree/v8. Its got a bunch of experiments on it so its something I'm going to need to go back clean up and land properly.

I've also been adding PRs to the rest spec definition over at https://github.com/figma/rest-api-spec/pulls .

So my question about copyright headers is still outstanding but the bigger question is how to land this all. Not sure your long term plans for the library is. After the code generation has landed I don't think there will need to be much development at all, just rerun the generator whenever a new version appears. I've got a project at work that's using the library that needed additional types so that's why I've been doing this. I know you've got other things going on but it would be great if we could work through these commits and release a dev version in the next week or so.

Let me know what you want to do with everything. Thanks again for all the reviews and assistance.

Sorry for being late, I don't read my notifications as often as I should! I'd say the best way to land this is to get all the work onto main, and once we're satisfied with the outcome we'll release a new major version. Of course, we can release some dev releases while we're still working on it.

There might be room for some utility layer on top of the models that makes it somewhat easier to work with Figma files programmatically, but the package essentially just being a client generated from OAPI specs is totally fine by me.

[donny-dont]

Everything sounds good @arnemolland ! Would greatly appreciate you taking a look at the notifications till things are done here. There are a number of patches on my branch and I'm using this at work so I'd like to have an official package with it all 😸

[donny-dont]

Hey @arnemolland I would greatly appreciate it if you could check the repo daily until this is done. Spending a bunch of time on this because I have a work project that uses this library and the 7.x didn't have the values I needed exposed.

Wanted to contribute back rather than doing a fork so it could benefit everyone but I'm getting a bit frustrated by how long its taking to land. There's still at least 6 patches to go before the migration is complete.

As a large benefit once everything is generated it should just be pretty low maintenance, just take in the changes whenever the rest spec has a new version, and rerun the generator.

[arnemolland]

Hey @arnemolland I would greatly appreciate it if you could check the repo daily until this is done. Spending a bunch of time on this because I have a work project that uses this library and the 7.x didn't have the values I needed exposed.

Wanted to contribute back rather than doing a fork so it could benefit everyone but I'm getting a bit frustrated by how long its taking to land. There's still at least 6 patches to go before the migration is complete.

As a large benefit once everything is generated it should just be pretty low maintenance, just take in the changes whenever the rest spec has a new version, and rerun the generator.

Will do. Much appreciated effort!

[donny-dont]

@arnemolland I think its just 3 more commits to get a v8.0.0-dev out the door. At which point maybe people could try it and see if any of their things blow up.

Got #79 which generates the responses from the data.

Next up adds converters for things like ClientMeta and VariableValue which are unions which require manual serialization. Additionally there's some tests for them. Since its adding actual code code it would be good to have some kind of copyright header going in there.

And finally I've got one more commit that handles some real world cases of things I've encountered in file where there's an enum value that isnt in the spec or something could be null but the spec says otherwise.

Appreciate you really going through a bunch of PRs just got a few more till this is good to go.

[donny-dont]

The three required commits are lined up on https://github.com/donny-dont/figma/tree/v8-dev guess the only other thing to do is to add a CHANGELOG entry. Not sure what your preference is there @arnemolland . That need to get done for a dev release or just for the official release.

[donny-dont]

Alrighty think we’re ready for a v8.0.0-dev release @arnemolland

[donny-dont]

So next step for me is to clean up the generator and land it.