Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.prism.byescaleira.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Core Protocols

PrismFoundation defines the base protocols used across every Prism module. They provide consistent patterns for modeling data, handling errors, generating test fixtures, and logging.

​
PrismEntity

The standard protocol for data models. Combines Codable, Equatable, Hashable, CustomStringConvertible, and PrismLogger into a single conformance with automatic JSON serialization and logging.
Defining an Entity
import PrismFoundation

struct User: PrismEntity {
    let id: UUID
    let name: String
    let email: String
}

let user = User(id: UUID(), name: "Alice", email: "alice@example.com")

// Auto-generated JSON description
print(user.description)
// {"id":"...","name":"Alice","email":"alice@example.com"}

// Log the entity via os.Logger
user.log()
PrismEntity arrays also conform automatically — [User] is itself a PrismEntity and can call .log() directly.

​
PrismError

A typed error protocol that extends Error, LocalizedError, and PrismLogger. Provides structured error descriptions with failure reasons and recovery suggestions.
Defining a Custom Error
import PrismFoundation

enum PaymentError: PrismError {
    case insufficientFunds(required: Decimal, available: Decimal)
    case cardExpired

    var errorDescription: String? {
        switch self {
        case .insufficientFunds(let required, let available):
            return "Insufficient funds: need \(required), have \(available)"
        case .cardExpired:
            return "Payment card has expired"
        }
    }

    var failureReason: String? {
        switch self {
        case .insufficientFunds:
            return "The account balance is below the required amount."
        case .cardExpired:
            return "The card expiration date is in the past."
        }
    }

    var recoverySuggestion: String? {
        switch self {
        case .insufficientFunds:
            return "Add funds to your account and try again."
        case .cardExpired:
            return "Update your payment method with a valid card."
        }
    }
}

// Logs error, failure reason, and recovery suggestion automatically
PaymentError.cardExpired.log()

​
PrismMock

A protocol for generating test data. Provides a mock instance and a mocks array (default: 10 items).
Defining Mock Data
import PrismFoundation

struct Product: PrismEntity, PrismMock {
    let id: UUID
    let name: String
    let price: Double

    static var mock: Product {
        Product(id: UUID(), name: "Widget", price: 9.99)
    }
}

// Single mock instance
let product = Product.mock

// Array of 10 mock instances
let products = Product.mocks
Override static var mocks: [Self] if you need a custom collection size or varied data.

​
PrismLogger

The simplest logging protocol — a single log() method. Both PrismEntity and PrismError conform to it, so any model or error can log itself.
Custom Logger Conformance
struct APIRequest: PrismLogger {
    let method: String
    let path: String

    func log() {
        print("[\(method)] \(path)")
    }
}

​
PrismSystemLogger

A more structured logging protocol that wraps os.Logger with typed log messages.
System Logger
import os
import PrismFoundation

struct NetworkLogger: PrismSystemLogger {
    typealias Message = PrismNetworkLogMessage

    let logger = Logger(subsystem: "com.app", category: "network")

    func info(_ message: Message) {
        logger.info("\(message.description)")
    }

    func warning(_ message: Message) {
        logger.warning("\(message.description)")
    }

    func error(_ message: Message) {
        logger.error("\(message.description)")
    }
}

​
Protocol Hierarchy

PrismEntity

Codable + Equatable + Hashable + CustomStringConvertible + PrismLogger. The base for all data models. Auto-generates JSON description and logging.

PrismError

Error + LocalizedError + PrismLogger. Structured errors with description, failure reason, and recovery suggestion. Auto-logs all three fields.

PrismMock

Test data generation with mock and mocks. Default implementation provides 10-item arrays.

PrismLogger / PrismSystemLogger

Simple log() protocol and os.Logger wrapper with typed messages for info, warning, and error levels.