nav/Yonexus.Protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tighten protocol typings for strict consumers

Browse Source
This commit is contained in:
nav
2026-04-09 04:37:59 +00:00
parent a7e1a9c210
commit 8744a771a2
2 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/codec.ts
View File

@@ -128,7 +128,7 @@ export function decodeBuiltin(raw: string): BuiltinEnvelope {
throw new CodecError("Missing or invalid 'type' field in envelope"); throw new CodecError("Missing or invalid 'type' field in envelope");
} }
return envelope as BuiltinEnvelope; return envelope as unknown as BuiltinEnvelope;
} catch (cause) { } catch (cause) {
if (cause instanceof CodecError) { if (cause instanceof CodecError) {
throw cause; throw cause;

32
src/types.ts
View File

@@ -22,7 +22,7 @@ export type BuiltinMessageType = (typeof builtinMessageTypes)[number];
export interface BuiltinEnvelope< export interface BuiltinEnvelope<
TType extends BuiltinMessageType = BuiltinMessageType, TType extends BuiltinMessageType = BuiltinMessageType,
TPayload extends Record<string, unknown> = Record<string, unknown> TPayload = Record<string, unknown>
> { > {
type: TType; type: TType;
requestId?: string; requestId?: string;
@@ -30,7 +30,7 @@ export interface BuiltinEnvelope<
payload?: TPayload; payload?: TPayload;
} }
export interface HelloPayload { export interface HelloPayload extends Record<string, unknown> {
identifier: string; identifier: string;
hasSecret: boolean; hasSecret: boolean;
hasKeyPair: boolean; hasKeyPair: boolean;
@@ -44,14 +44,14 @@ export type HelloAckNextAction =
| "rejected" | "rejected"
| "waiting_pair_confirm"; | "waiting_pair_confirm";
export interface HelloAckPayload { export interface HelloAckPayload extends Record<string, unknown> {
identifier: string; identifier: string;
nextAction: HelloAckNextAction; nextAction: HelloAckNextAction;
} }
export type AdminNotificationStatus = "sent" | "failed"; export type AdminNotificationStatus = "sent" | "failed";
export interface PairRequestPayload { export interface PairRequestPayload extends Record<string, unknown> {
identifier: string; identifier: string;
expiresAt: number; expiresAt: number;
ttlSeconds: number; ttlSeconds: number;
@@ -59,12 +59,12 @@ export interface PairRequestPayload {
codeDelivery: "out_of_band"; codeDelivery: "out_of_band";
} }
export interface PairConfirmPayload { export interface PairConfirmPayload extends Record<string, unknown> {
identifier: string; identifier: string;
pairingCode: string; pairingCode: string;
} }
export interface PairSuccessPayload { export interface PairSuccessPayload extends Record<string, unknown> {
identifier: string; identifier: string;
secret: string; secret: string;
pairedAt: number; pairedAt: number;
@@ -77,12 +77,12 @@ export type PairFailedReason =
| "admin_notification_failed" | "admin_notification_failed"
| "internal_error"; | "internal_error";
export interface PairFailedPayload { export interface PairFailedPayload extends Record<string, unknown> {
identifier: string; identifier: string;
reason: PairFailedReason; reason: PairFailedReason;
} }
export interface AuthRequestPayload { export interface AuthRequestPayload extends Record<string, unknown> {
identifier: string; identifier: string;
nonce: string; nonce: string;
proofTimestamp: number; proofTimestamp: number;
@@ -90,7 +90,7 @@ export interface AuthRequestPayload {
publicKey?: string; publicKey?: string;
} }
export interface AuthSuccessPayload { export interface AuthSuccessPayload extends Record<string, unknown> {
identifier: string; identifier: string;
authenticatedAt: number; authenticatedAt: number;
status: "online"; status: "online";
@@ -107,33 +107,33 @@ export type AuthFailedReason =
| "rate_limited" | "rate_limited"
| "re_pair_required"; | "re_pair_required";
export interface AuthFailedPayload { export interface AuthFailedPayload extends Record<string, unknown> {
identifier: string; identifier: string;
reason: AuthFailedReason; reason: AuthFailedReason;
} }
export interface RePairRequiredPayload { export interface RePairRequiredPayload extends Record<string, unknown> {
identifier: string; identifier: string;
reason: "nonce_collision" | "rate_limited" | "trust_revoked"; reason: "nonce_collision" | "rate_limited" | "trust_revoked";
} }
export interface HeartbeatPayload { export interface HeartbeatPayload extends Record<string, unknown> {
identifier: string; identifier: string;
status: "alive"; status: "alive";
} }
export interface HeartbeatAckPayload { export interface HeartbeatAckPayload extends Record<string, unknown> {
identifier: string; identifier: string;
status: "online" | "unstable" | "offline"; status: "online" | "unstable" | "offline";
} }
export interface StatusUpdatePayload { export interface StatusUpdatePayload extends Record<string, unknown> {
identifier: string; identifier: string;
status: "online" | "unstable" | "offline"; status: "online" | "unstable" | "offline";
reason: string; reason: string;
} }
export interface DisconnectNoticePayload { export interface DisconnectNoticePayload extends Record<string, unknown> {
identifier: string; identifier: string;
reason: string; reason: string;
} }
@@ -152,7 +152,7 @@ export type ProtocolErrorCode =
| "CLIENT_OFFLINE" | "CLIENT_OFFLINE"
| "INTERNAL_ERROR"; | "INTERNAL_ERROR";
export interface ErrorPayload { export interface ErrorPayload extends Record<string, unknown> {
code: ProtocolErrorCode; code: ProtocolErrorCode;
message?: string; message?: string;
details?: Record<string, unknown>; details?: Record<string, unknown>;