Are the Cloud Code type definitions (.d.ts) in the local setup guide outdated?
-
Hello,
I am currently setting up a local development environment for Cloud Code using TypeScript, following this guide: https://help.getbraincloud.com/en/articles/8705906-using-cloud-code-type-declaration-files-in-your-local-vscodeHowever, I noticed that the .d.ts files provided in the article seem to have some discrepancies with the current API. It appears they might be a bit outdated.
Is there a way to obtain the most up-to-date type declaration files that match the latest API version?
-
Thanks for pointing this out. We’ve updated the linked file to the latest version.
Also, I’d like to mention that we’ve created a Visual Studio Code extension for Cloud Code scripts. It includes IntelliSense and other helpful features that you may want to give it a try.
You can find more details here:
https://forums.getbraincloud.com/topic/307/early-access-visual-studio-code-extension -
Thanks for the update and the recommendation!
Regarding the extension, does it allow us to configure a specific target directory for syncing?
Since I work in TypeScript, my workflow involves transpiling TS files into a separate output folder (e.g., ./dist) as JavaScript. Currently, I have to manually copy-paste these resulting JS files into the BrainCloud console, which is quite tedious.
If the extension can be configured to watch and sync the transpiled JS files from my build folder (instead of the source TS files), it would greatly streamline my workflow. Is this currently possible?
-
Thanks for reaching out and for raising the question.
At the moment, the VS Code extension does not support targeting or importing from a specific directory. Its primary purpose is to synchronize Cloud Scripts stored in brainCloud and provide a convenient way to edit them using standard VS Code workflows and tooling.
We have created an internal task to review this limitation and discuss potential improvements to the extension so that it better supports directory-based workflows in the future.
In the meantime, one practical workaround is to export your Cloud Scripts directly from the brainCloud portal. Once exported, all scripts can be reviewed locally. You can then organize them into a folder structure that mirrors your desired layout, including the use of subfolders and .ccjs files. From there, you can zip the contents and import them back into your app, which can significantly reduce the need for repetitive copy and paste actions across individual files.
Please let us know if this approach works for your use case or if you have additional feedback on how you would like to see the extension evolve.
-
Thank you for the response! Could I ask one more thing?
I noticed that the d.ts file included in the VS Code extension is regularly updated to reflect the latest specs. However, regarding the TypeScript-compatible d.ts file you shared via the separate link, is there a specific URL where we can always find the most up-to-date version?
Currently, our workflow involves writing Cloud Code in TypeScript and transpiling it to JavaScript for deployment. To maintain this workflow smoothly, could you provide guidance on how we can consistently access or sync with the latest d.ts definitions?