Provide full type definitions

[LinqLover]

E.g., I'd like to know what telemetry levels there are or what possible messages are sent via didChangeStatus`.

An exhaustive overview such as type definition file would help me catch all the cases without too much experimenting.

[tpope]

I'd like to do this. It would take some engineering work on our end.

E.g., I'd like to know what telemetry levels there are

Workspace configuration would be a step beyond basic protocol types. Informally you can often look at what VS Code does, either by poking around in its settings UI or diving into its source. For example, here are the types that our http.proxy* settings are based on: https://github.com/microsoft/vscode/blob/ad05d15e38162b24a829692306d595fb61dd83af/src/vs/platform/request/common/request.ts#L197-L266

For telemetry.telemetryLevel, if you set the value to "off", it will prevent the SDK from directly sending client-side telemetry (e.g., "the user accepted a completion"). But if you care about the data that is collected rather than the means of collecting it, you would be better served by adjusting the "Allow GitHub to..." policies found in Copilot settings. I wouldn't recommend making this setting directly available to users for that reason. Instead, you could direct them to this documentation.

In fact, I might yank those 3 lines of JSON from the README because I think they're more misleading than helpful.

or what possible messages are sent via didChangeStatus.

The type here would be message?: string; as these messages are arbitrary text intended for directly displaying to the user. They are subject to change and may include dynamic content (e.g., an error message sent from the server). Or to put it another way, the API does not currently provide the information you are looking for. It's not ideal, but for now, I would advise allowing the user to sign in again in case of any Error.

[LinqLover]

Thanks for the detailed reply! I will check out the VS Code references soon. I really love this SDK!

Regarding status messages, I have also noticed that the server is emitting undocumented statusNotification messages with additional details busy and status. If these could be documented as well, that would be great.

[tpope]

Regarding status messages, I have also noticed that the server is emitting undocumented statusNotification messages with additional details busy and status. If these could be documented as well, that would be great.

This is not part of the API, and will be cleaned up eventually.