@mythryl/protocol

The messages a Mythryl mini app and its host send each other: types, guards, protocol versions and error codes.

Most apps use @mythryl/app-sdk in the browser and @mythryl/server-sdk on the server, and never import this package directly. It is for code that implements the other end of the protocol, such as a host.

npm install @mythryl/protocol

Contents

• Messages: RequestMessage, ResponseMessage and EventMessage, with the guards isRequestMessage, isResponseMessage and isEventMessage for data received from a transport.
• Calls and events: the Methods map (parameters and result of each call), Events, and Capability.
• Versions: SUPPORTED_VERSIONS, LATEST_VERSION and negotiate(theirs, ours). A version is never removed after release, so apps built with an older SDK keep working.
• Errors: ProtocolError and the codes cancelled, unsupported, not_consented, rate_limited, too_large, quota_exceeded and unavailable.
• Storage: JsonValue, StorageEntry and the limits STORAGE_MAX_KEY_LENGTH, STORAGE_MAX_VALUE_BYTES and STORAGE_MAX_TOTAL_BYTES, which hosts check against.
• Tokens: APP_TOKEN_TYPE, MYTHRYL_ISSUER, JWKS_PATH and the AppTokenClaims type for the token returned by sdk.auth.signin().

Message format

Every message carries source: "mythryl" and the protocol version v. A request has an id, a method and params; a response repeats the id and carries either result or error; an event has an event name and data. The first request is always hello, which selects the version used afterwards.

License

MIT