junobuild-utils 0.4.0

use candid::Principal as CandidPrincipal;

/// Represents a wrapper around the `candid::Principal` type.
///
/// This struct is designed to encapsulate a Candid Principal, allowing for
/// integration and usage within Juno hooks contexts.
///
/// # Fields
/// - `value`: The `Principal` this struct wraps.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct JsonDataPrincipal {
    pub value: CandidPrincipal,
}

/// Represents a large integer value for document data, particularly useful for interacting with
/// languages or environments that support large numeric types, such as the `bigint` in JavaScript.
///
/// # Fields
/// - `value`: A `u64` integer representing the large numeric value encapsulated by this struct.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct JsonDataBigInt {
    pub value: u64,
}

/// Represents an arbitrary precision natural number for document data,
/// mirroring Candid's `nat` type. Useful for values that exceed `u64::MAX`
/// or must be compatible with Candid's `nat` type.
///
/// # Fields
/// - `value`: A `u128` integer representing the natural number.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct JsonDataNat {
    pub value: u128,
}

/// Represents a byte array value for document data, mirroring JavaScript's `Uint8Array`.
///
/// This struct is useful for transporting raw binary data across the JSON boundary,
/// where it is serialized as `{ "__uint8array__": number[] }` (see custom serde impl).
///
/// # Fields
/// - `value`: The underlying bytes.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct JsonDataUint8Array {
    pub value: Vec<u8>,
}
/// Alias for [`JsonDataPrincipal`].
pub type DocDataPrincipal = JsonDataPrincipal;

/// Alias for [`JsonDataBigInt`].
pub type DocDataBigInt = JsonDataBigInt;

/// Alias for [`JsonDataUint8Array`].
pub type DocDataUint8Array = JsonDataUint8Array;