Syntax errors in typescript file?

[christophfriedrich]

When opening openeo.d.ts in VS Code, it displays me "482 problems in this file". I think most (if not all) of them stem from a missing . when specifying types for object keys/values with object<x,y>, because everything is fine until here:

openeo-js-client/openeo.d.ts

Lines 122 to 131 in 6d0e09b

	/**
	* @protected
	* @type {object.<string, string>}
	*/
	protected apiToClientNames: object<string, string>;
	/**
	* @protected
	* @type {object.<string, string>}
	*/
	protected clientToApiNames: object<string, string>;

The JSDoc has the . but the actual code doesn't. Do they share the same syntax rules?

I'd be happy to go through the file and fix this all over. Just: Where is this file actually used so that I can test the changes?

[m-mohr]

The TS generation is done by the typescript compiler pretty much, the checks might be done by JSDoc and it seem different rules apply. So it probably depends on the installed VS Code extension.

v3.0.0 we could probably implement in typescript to get rid of the issues, but for now it's not a priority as long as TS users get the typing, which I never heard complaints about yet so I assume it works.

[christophfriedrich]

Hm okay. I tried a search&replace and indeed that resolved all the 'problems'.

However with some quick googling I couldn't find documentation for neither variant (not with nor without the dot), and all StackOverflow examples were using totally different syntax, so I ended up trying asking Copilot -- here's what it said:

I wouldn't take that as authoritative, but will leave the info here for someone to pick up if this should become a more relevant issue at some point.

[martinRenou]

Hello there! I've been hitting a very similar error today. I see one single issue with the d.ts file and it's with ProcessingParameter. I went ahead and opened a PR for it: #85

Though I'm afraid this is all manual editing of the .d.ts file which seems a bit bad... I'm wondering if you are now maintaining this file manually and stopped generating it automatically anymore? Since I see the docstrings still contain many object.<string, any> notations that are now Records in the .d.ts.

If I run the .d.ts generation locally I get a very different result than what is committed on the repo.

Sorry in advance for the uninvited suggestion: you may want to commit package-lock.json instead of .gitignoreing it, that way I would be sure to use the same TypeScript version you are using. You may also not want to commit the .d.ts file since it's automatically generated.

Happy to make further PRs helping a bit on this if my help is welcome!

[martinRenou]

Since I see the docstrings still contain many object.<string, any> notations that are now Records in the .d.ts.

It looks like this was introduced in this PR #72

If I generate the .d.ts automatically those go back to being object<string, any> again.

[m-mohr]

Hi @martinRenou.

The file is manually maintained as the version that was (is?) generated by Typescript when we added it years ago was not correct / had issues (you also stumbled across the object/Record issue again). I hate doing these manual updates as it's slow and error-prone. I didn't find a better way yet, but I'm also not deep into TS and haven't checked recently. So if you or anyone has a better way to generate this automatically, happy to try it out.

That you got another version when using the tsd command is expected. Thus it's not an issue with a different TS version. Whether to commit the package-lock.json is a good questions, in some projects we do in some we don't. Pretty open on this though.

Thanks for the PR with the fix, I've merged it so that it's included in the next release.