@ottochain/sdk 2.2.5 → 2.4.0

package/dist/types/ottochain/normalize.d.ts

@@ -1,79 +0,0 @@
-/**
- * Normalize OttoChain Messages for Signing
- *
- * Converts OttoChain message objects to the wire format expected by the
- * Scala metagraph. Specifically, ensures all `Option[A]=None` fields are
- * present as explicit `null` values, matching what circe's magnolia encoder
- * produces on the Scala side.
- *
- * This is necessary because metakit's `JsonBinaryCodec.deriveDataUpdate`
- * (rc.8) canonicalizes the circe-encoded JSON **including null fields**.
- * If the TypeScript client omits optional fields (undefined), the canonical
- * JSON won't match and signature verification will fail.
- *
- * Schema mapping (Scala → TypeScript):
- * - `Option[A] = None` → `null` (must be explicit, not undefined/absent)
- * - `Option[A] = Some(v)` → `v`
- * - `List.empty` → `[]`
- * - `Map.empty` → `{}`
- */
-/**
- * Normalize a CreateStateMachine message for wire format
- *
- * Ensures all Option/default fields are explicit in wire format:
- * - definition.metadata → null when absent
- * - definition.states[*].metadata → null when absent
- * - definition.transitions[*].dependencies → [] when absent
- * - parentFiberId → null when absent
- *
- * @example
- * ```typescript
- * const message = normalizeCreateStateMachine({
- *   fiberId: '...',
- *   definition: { states: { INIT: { id: { value: 'INIT' }, isFinal: false } }, ... },
- *   initialData: {}
- * });
- * // message now has parentFiberId: null, definition.metadata: null, etc.
- * ```
- */
-export declare function normalizeCreateStateMachine(msg: Record<string, unknown>): Record<string, unknown>;
-/**
- * Normalize a TransitionStateMachine message for wire format
- *
- * Scala TransitionStateMachine schema:
- *   fiberId: UUID (required)
- *   eventName: String (required)
- *   payload: JsonLogicValue (required)
- *   targetSequenceNumber: FiberOrdinal (required)
- *
- * All fields are required — no Option types, so no null normalization needed.
- */
-export declare function normalizeTransitionStateMachine(msg: Record<string, unknown>): Record<string, unknown>;
-/**
- * Normalize an ArchiveStateMachine message for wire format
- *
- * Scala ArchiveStateMachine schema:
- *   fiberId: UUID (required)
- *   targetSequenceNumber: FiberOrdinal (required)
- *
- * All fields are required — no Option types, so no null normalization needed.
- */
-export declare function normalizeArchiveStateMachine(msg: Record<string, unknown>): Record<string, unknown>;
-/**
- * Normalize any OttochainMessage wrapper for wire format.
- *
- * Detects the message type from the wrapper key and applies the
- * appropriate normalization.
- *
- * @param message - OttochainMessage in wrapper format: `{ CreateStateMachine: {...} }`
- * @returns Normalized message with all Option fields as explicit null
- *
- * @example
- * ```typescript
- * const normalized = normalizeMessage({
- *   CreateStateMachine: { fiberId: '...', definition: {...}, initialData: {} }
- * });
- * const signed = await signDataUpdate(normalized, privateKey);
- * ```
- */
-export declare function normalizeMessage(message: Record<string, unknown>): Record<string, unknown>;