A field by its wire key: sdk, v, app, parts, rt, inst, …
The value of X-BIMworks-Client.
The socket's first message: {"hb": true, "client": header()}.
bimworks-<sdk>/<v> (<runtime>; <os>) <app>, for runtimes that may set a User-Agent.
The application that uses the SDK, sent as app (letters, digits and . _ + -; anything else becomes _).
Optionalversion: string | nullThe build's version, time (UTC, ISO 8601) and commit; a version of "DEV" or nothing is sent as dev.
Optionalbuilt: string | nullOptionalcommit: string | nullWithout the runtime and the platform.
A BIM.works package that uses the client, e.g. a viewer, sent in parts.
Optionalversion: string | nullFor an SDK generated from the OpenAPI spec: the spec's version, its SHA-256 prefix, generator/version.
OptionalspecSha: string | nullOptionalgenerator: string | nullStaticcreateA new identity for this SDK id (js, web, …) with this runtime, its platform and a fresh instance id.
What a client says it is, on every request (the X-BIMworks-Client header) and as the first message of its WebSocket. Immutable: every
with…returns a new identity.