permit v0.0.1

Permit.Types (permit v0.0.1)

Link to this section Summary

Types

authorization_outcome()
condition()
conn()
controller_action()
crud()
hook_outcome()
id()
id_param_name()
loader()
plug_opts()
  • :authorization_module -- (Required) The app's authorization module that uses use Permit.
  • preload_resource_in -- (Optional) The list of actions that resources will be preloaded and authorized in, in addition to :show, :delete, :edit and :update.
  • repo -- (Required, unless :loader_fn defined) The application's Repo. If a :loader_fn is not given, it's used for fetching records in singular resource functions (:show, :edit, :update, :delete and other defined as :preload_resource_in).
  • loader_fn -- (Required, unless :repo defined) The loader, 1-arity function, used to fetch records in singular resource functions (:show, :edit, :update, :delete and other defined as :preload_resource_in). It is convenient to use context getter functions as loaders.
  • resource -- (Required) The struct module defining the specific resource the controller is dealing with.
  • id_param_name -- (Required, if singular record actions are present) The parameter name used to look for IDs of resources, passed to the loader function or the repo.
  • action_crud_mapping -- (Optional) The mapping of controller actions not corresponding to standard Phoenix controller action names to :create, :read, :update or :delete - it directs the authorization framework to look for a specific CRUD rule for that given controller action. For instance: [view: :read, show: :read]
  • fallback_path -- (Optional) A string, or a function taking (conn, params) returning a string, denoting redirect path when unauthorized. Defaults to "/".
  • error_msg -- (Optional) An error message to put into the flash when unauthorizd. Defaults to "You do not have permission to perform this action."
  • `handle_unauthorized - (Optional) A function taking (conn, plug_opts), performing specific action when authorization is not successful. Defaults to redirecting to :fallback_path.
resource()
resource_module()
role()
role_record()
socket()
subject()
subject_with_role()

Link to this section Types

Link to this type

authorization_outcome()

@type authorization_outcome() :: {:authorized | :unauthorized, socket()}
Link to this type

condition()

@type condition() ::
  boolean()
  | {atom(), any()}
  | (struct() -> boolean())
  | (Types.subject(), struct() -> boolean())
Link to this type

conn()

@type conn() :: Plug.Conn.t()
Link to this type

controller_action()

@type controller_action() :: atom()
Link to this type

crud()

@type crud() :: :create | :read | :update | :delete
Link to this type

hook_outcome()

@type hook_outcome() :: {:halt, socket()} | {:cont, socket()}
Link to this type

id()

@type id() :: integer() | binary()
Link to this type

id_param_name()

@type id_param_name() :: binary()
Link to this type

loader()

@type loader() :: (id() -> struct() | nil)
Link to this type

plug_opts()

@type plug_opts() :: [
  authorization_module: module() | function(),
  loader_fn: loader() | function(),
  resource_module: resource_module() | function(),
  preload_resource_in: [atom()] | function(),
  id_param_name: id_param_name() | function(),
  action_crud_mapping: keyword(crud()) | function(),
  except: [atom()] | function(),
  fallback_path:
    (Plug.Conn.t(), map() | keyword() -> binary()) | binary() | function(),
  error_msg: binary() | function(),
  handle_unauthorized: function()
]
  • :authorization_module -- (Required) The app's authorization module that uses use Permit.
  • preload_resource_in -- (Optional) The list of actions that resources will be preloaded and authorized in, in addition to :show, :delete, :edit and :update.
  • repo -- (Required, unless :loader_fn defined) The application's Repo. If a :loader_fn is not given, it's used for fetching records in singular resource functions (:show, :edit, :update, :delete and other defined as :preload_resource_in).
  • loader_fn -- (Required, unless :repo defined) The loader, 1-arity function, used to fetch records in singular resource functions (:show, :edit, :update, :delete and other defined as :preload_resource_in). It is convenient to use context getter functions as loaders.
  • resource -- (Required) The struct module defining the specific resource the controller is dealing with.
  • id_param_name -- (Required, if singular record actions are present) The parameter name used to look for IDs of resources, passed to the loader function or the repo.
  • action_crud_mapping -- (Optional) The mapping of controller actions not corresponding to standard Phoenix controller action names to :create, :read, :update or :delete - it directs the authorization framework to look for a specific CRUD rule for that given controller action. For instance: [view: :read, show: :read]
  • fallback_path -- (Optional) A string, or a function taking (conn, params) returning a string, denoting redirect path when unauthorized. Defaults to "/".
  • error_msg -- (Optional) An error message to put into the flash when unauthorizd. Defaults to "You do not have permission to perform this action."
  • `handle_unauthorized - (Optional) A function taking (conn, plug_opts), performing specific action when authorization is not successful. Defaults to redirecting to :fallback_path.
Link to this type

resource()

@type resource() :: struct() | resource_module()
Link to this type

resource_module()

@type resource_module() :: module()
Link to this type

role()

@type role() :: atom()
Link to this type

role_record()

@type role_record() :: %{:role => role(), optional(any()) => any()}
Link to this type

socket()

@type socket() :: Phoenix.LiveView.Socket.t()
Link to this type

subject()

@type subject() :: map() | struct()
Link to this type

subject_with_role()

@type subject_with_role() :: %{
  :__struct__ => resource_module(),
  :role => role_record(),
  optional(any()) => any()
}