Reference

API Reference

Quick reference of every symbol exported from @admicaa/netpress-permissions.

Core runtime primitives such as Auth, BaseController, service providers, and the primary authorization pipeline live in @admicaa/netpress: <https://github.com/admicaa/netpress>

Models

Symbol	Kind	Notes
`Role`	class	Eloquent-style model for roles
`Permission`	class	Eloquent-style model for permissions

Traits

Symbol	Kind	Notes
`HasRoles`	mixin	Adds `roles()` and role helpers
`HasPermissions`	mixin	Adds `permissions()`, `can`, `cannot`, permission helpers
`Authorizable`	mixin	Composes `HasRoles` and `HasPermissions`
`applyAuthorizable(Class)`	function	Attaches the full trait set to an existing class
`applyModelMixin(Class, mixin)`	function	Low-level mixin applicator

AuthGuard

Symbol	Kind	Notes
`AuthGuard.authenticated()`	middleware	Require `req.user`
`AuthGuard.can(ability, resourceResolver?)`	middleware	Policy-aware ability check
`AuthGuard.canAny(abilities, resourceResolver?)`	middleware	Require at least one ability
`AuthGuard.canAll(abilities, resourceResolver?)`	middleware	Require every ability
`AuthGuard.role(...names)`	middleware	Any of the listed roles
`AuthGuard.roles(...names)`	middleware	All of the listed roles
`AuthGuard.permission(...names)`	middleware	Any of the listed permissions
`AuthGuard.permissions(...names)`	middleware	All of the listed permissions
`AuthGuard.guest()`	middleware	Require no authenticated user

Configuration

Symbol	Kind	Notes
`buildPermissionsConfig(overrides?)`	function	Pure merge on top of the current runtime config
`configurePermissions(overrides?)`	function	Mutates the runtime config
`createDefaultPermissionsConfig()`	function	Fresh clone of the package defaults
`getPermissionsConfig()`	function	Read-only clone of the current config
`resolvePermissionsConfig()`	function	Live reference to the current config
`resolvePermissionsMorphTypeColumn(config?)`	function	Returns `${morphName}Type`
`resetPermissionsConfig()`	function	Restore defaults

Migrations

Symbol	Kind	Notes
`createPermissionTables(target, overrides?)`	async	Build the five package tables/collections
`dropPermissionTables(target, overrides?)`	async	Tear the five tables down

Publisher

Symbol	Kind	Notes
`NetpressPermissionsServiceProvider`	class	Auto-loads config into the package runtime
`permissionsPublisher`	object	Publisher descriptor used by `vendor:publish`
`publishPermissionsPackage(options?)`	async	Programmatic publisher entry point

Re-exported From `@admicaa/netpress`

Convenience re-exports so you can import authorization primitives from one place:

authorizeRequest
can
listPolicies
registerPolicies
registerPolicy
resetPolicies
resolvePolicy