@markless/serializer 0.1.0

package/dist/protocol-validation.d.ts

@@ -0,0 +1,55 @@
+import { ProtocolStatePayload, ProtocolViewPayload } from "./protocol.js";
+
+//#region src/protocol-validation.d.ts
+type EncodedPayloadScripts = {
+  readonly stateScript: string;
+  readonly viewScript: string;
+};
+type DecodedPayloadScripts = {
+  readonly state: ProtocolStatePayload;
+  readonly view: ProtocolViewPayload;
+};
+type RuntimePayloadType = 'markless/state' | 'markless/view';
+type RuntimePayloadErrorCode = 'MARKLESS_PAYLOAD_INVALID' | 'MARKLESS_PROTOCOL_VERSION_MISMATCH';
+type RuntimePayloadDiagnostic = {
+  readonly code: RuntimePayloadErrorCode;
+  readonly severity: 'error';
+  readonly phase: 'payload';
+  readonly title: string;
+  readonly message: string;
+  readonly why: string;
+  readonly payloadType: RuntimePayloadType;
+  readonly payloadScript: string;
+  readonly expectedVersion?: number;
+  readonly actualVersion?: unknown;
+  readonly suggestions: ReadonlyArray<{
+    readonly message: string;
+  }>;
+  readonly docsUrl: string;
+};
+declare class RuntimePayloadError extends Error implements RuntimePayloadDiagnostic {
+  readonly code: RuntimePayloadErrorCode;
+  readonly severity: 'error';
+  readonly phase: 'payload';
+  readonly title: string;
+  readonly why: string;
+  readonly payloadType: RuntimePayloadType;
+  readonly payloadScript: string;
+  readonly expectedVersion?: number;
+  readonly actualVersion?: unknown;
+  readonly suggestions: ReadonlyArray<{
+    readonly message: string;
+  }>;
+  readonly docsUrl: string;
+  constructor(diagnostic: RuntimePayloadDiagnostic);
+}
+declare function decodePayloadScripts(input: EncodedPayloadScripts): DecodedPayloadScripts;
+declare function assertProtocolStatePayload(payload: unknown): asserts payload is ProtocolStatePayload;
+declare function assertProtocolStateCellPayload(cell: unknown, context: string): asserts cell is ProtocolStatePayload['cells'][number];
+declare function assertProtocolViewPayload(payload: unknown): asserts payload is ProtocolViewPayload;
+declare function payloadInvalidError(payloadType: RuntimePayloadType, message: string, why: string, suggestions: ReadonlyArray<{
+  readonly message: string;
+}>): RuntimePayloadError;
+declare function payloadScriptSelector(type: RuntimePayloadType): string;
+//#endregion
+export { DecodedPayloadScripts, EncodedPayloadScripts, RuntimePayloadDiagnostic, RuntimePayloadError, RuntimePayloadErrorCode, RuntimePayloadType, assertProtocolStateCellPayload, assertProtocolStatePayload, assertProtocolViewPayload, decodePayloadScripts, payloadInvalidError, payloadScriptSelector };