Allow for -ArgumentList on Routes, Handlers, Timers, Schedules, etc

[Badgerati]

This will contain a fair few changes, the main one is being able to supply an -ArgumentList on Routes, Schedules, Handlers, Timers, and possibly others (maybe Middleware and Authentication).

All:

• The event and supplied arguments should be splatted, so they can be like:

param($event, $arg1, $arg2, ...)

Schedules:

• Because they are invoked as a Runspace, the argument names are literal.
• The current, and only argument, is $Lockable. This should be changed to be within an $Event hashtable.
• Because parameter names are literal, the -ArgumentList for Schedules will be a hashtable rather than an array

Add-PodeSchedule -Name 'Example' -Cron '@minutely' -ScriptBlock {
    param($event, $key, $path)
    # logic
} -ArgumentList @{ Key = 'SomeValue'; Path = 'SomePath' }

Timers, Routes, and others:

• Allow for -ArgumentList array to be supplied

Add-PodeRoute -Method Get -Path '/' -ScriptBlock {
    param($e, $arg1, $opt2, $username)
    # logic
} -ArgumentList $SomeArgument, $SomeOption, $SomeUsername

Handlers:

• TCP handlers are correct - just need the -ArgumentList.
• SMTP handlers supply the wrong event. It should be $e.Email and $e.Lockable - but only the $email is supplied.
• Server handlers get no event at all, so that needs adding.

[LLIT]

Is this an alternative to Get-Podestate?
How about "Global" arguments, just like you have with the middleware?

[Badgerati]

Get-PodeState is more for creating and sharing variables between the different runspaces. This is like Invoke-Command, where you'll be able to set certain args that are always supplied to route scriptblocks for the route you set them against.

So arguments for specific routes/middleware/timers, etc., like the -Options on custom middleware/logging/authentication but -ArgumentList is replacing that for something more familiar.

It'll also allow more dynamic building of routes - as something I was going to look into was a ConvertTo-PodeRoute -Commands Get-ChildItem, Remove-Item or ConvertTo-PodeRoute -Module Azure, and Pode will dynamically build routes for the (public) functions for you (with the original function being supplied to a route in its -ArgumentList.

Ie:

Add-PodeRoute -Method Get -Path '/ChildItem' -ScriptBlock {
    param($e, $function)
    . $function
} -ArgumentList 'Get-ChildItem'