search

StreamElements / widgets

284 stars 119 forks source link

Typescript / JSONSchema Types #49

Open braebo opened 3 weeks ago

braebo commented 3 weeks ago

Why are there no types provided? Or an OpenAPI schema from which to generate types at least?

It would be very simple to provide type definitions (or at least a JSONSchema). Doing so would make this unwieldy API 10x easier to learn, debug, update, and write for, and could be done entirely with JSDoc comments in vanilla JS files.

c4ldas commented 3 weeks ago

I believe you came a little late to the party. The widgets here are part of the old Overlays system, which won't receive updates or new features anymore, unfortunately. The new Elements (https://streamelements.com/dashboard/alerts-and-widgets) is the way Streamelements is going to be used for widgets and overlays (still in public beta, but open to use) and it is not compatible with Overlays. In case you want, the documentation is here:

https://dev.streamelements.com/docs/widgets-elements-sdk/

And the staff is available for suggestions and bug reports on Streamelements Discord (https://strms.net/discord), channel #elements-editor-widgets20

Sairenix commented 3 weeks ago

Why aren't the old docs linking to the new featureset? Googling custom widget only returns the old docs with NO mention of deprecation.

c4ldas commented 3 weeks ago

Why aren't the old docs linking to the new featureset? Googling custom widget only returns the old docs with NO mention of deprecation.

I have no idea. I'm not part of the team, I'm just a user like you. There isn't anyone from the staff answering issues here or even accepting PRs.

The documentation for the API, Overlays/custom widgets, and Elements is available at https://dev.streamelements.com/ and https://docs.streamelements.com/. However, neither of them is complete. The first one lacks a lot of information (especially in terms of API endpoints), and the latter is still in development.