Macros

[joshuawright11]

Now with Macros!

Adds a few macros to streamline building with Alchemy.

Routing

Use @{METHOD} to generate a route handler that automatically pulls function parameters from incoming requests and converts the return type to a response. Annotating your Application or Controller will automatically register the handlers, or you can access them via $nameOfTheFunction.

@Application
struct App {
    
    @POST("/user")
    func createUser(email: String, password: String) async throws -> User {
        // create user with parsed `email & `password`
    }
}

Automatically validate parameters with @Validate and a library (Coming Soon™️) of built in validators.

@Controller
struct UserController {
    
    @PATCH("/email")
    func updateEmail(@Validate(.email) email: String) async throws {
        // email is valid!
    }
}

Jobs

Quickly create a background job with just a function (global or static). Use the $ prefix to refer to the job.

@Job
func sendInvoice(email: String) async throws {
    ...
}

// run in foreground
try await sendInvoice(email: "[email protected]") 

// run as a background job
try await $sendInvoice(email: "[email protected]").dispatch()

Rune

Define models with the @Model macro.

@Model
struct User {
    var id: UUID
    var email: String
    var name: String
}

This unlocks some major quality of life improvements including type safe, KeyPath-based query builders which are Coming Soon™️

Relationships

Relationships look similar but get some powerful quality of life improvements including better join column inference, CRUD functions, and the ability to be defined in extensions.

struct Todo {
    var id: Int
    var name: String
    var isDone = false
   
    @BelongsToMany var tags: [Tag]
}

extension User {
    @HasMany var tags: [Tag]
}

// eager load with `$relationship`
User.query().with(\.$todos)

// chain relationships for nested loads (this loads todos & tags)
User.query().with(\.$todos.$tags)

// associates a todo with a user
let todo = Todo(name: "do laundry")
try await user.$todos.connect(todo)

If loaded, relationships are automatically encoded from route handlers.

@GET("/todos")
func getTodos() -> [Todo] {
    try await Todo.with(\.$tags).all()
}

[
    {
        "id": 1,
        "name": "Build great backends with Alchemy",
        "tags": [
            {
                "id": 1,
                "name": "Coding"
            },
            {
                "id": 2,
                "name": "Extremely Fun"
            }
        ]
    },
    {
        "id": 2,
        "name": "Make cookies",
        "tags": [
            {
                "id": 3,
                "name": "Cooking"
            }
        ]
    }
]