@superawesome/permissions-nestjs

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>SuperAwesome Permissions for NestJs (@superawesome/permissions-nestjs)</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> <link rel="stylesheet" href="../styles/postmark.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">SuperAwesome Permissions for NestJs (@superawesome/permissions-nestjs)</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div>  <div class="content interface"> <div class="content-data"> <ol class="breadcrumb"> <li>Interfaces</li> <li>IPermissionsModuleOptions</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="active"> <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a> </li> <li > <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="c-info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/types.ts</code> </p> <p class="comment"> <h3>Extends</h3> </p> <p class="comment"> <code>IPermissionsOptions</code> </p> <section> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Optional</span> <a href="#extractUserFromRequest">extractUserFromRequest</a> </li> <li> <span class="modifier">Optional</span> <a href="#projectResourceId">projectResourceId</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section> <h3 id="inputs">Properties</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="extractUserFromRequest"></a> <span class="name"><b>extractUserFromRequest</b><a href="#extractUserFromRequest"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>extractUserFromRequest: <code><a href="../miscellaneous/typealiases.html#TExtractUserFromRequest" target="_self" >TExtractUserFromRequest<TUserId></a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../miscellaneous/typealiases.html#TExtractUserFromRequest" target="_self" >TExtractUserFromRequest<TUserId></a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Optional</i> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="projectResourceId"></a> <span class="name"><b>projectResourceId</b><a href="#projectResourceId"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>projectResourceId: <code><a href="../miscellaneous/typealiases.html#TProjectTo" target="_self" >TProjectTo<TResourceId></a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../miscellaneous/typealiases.html#TProjectTo" target="_self" >TProjectTo<TResourceId></a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Optional</i> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { IUser, PermissionDefinition, IPermissionsOptions, Tid } from '@superawesome/permissions'; /** * @internal */ export const PERMISSIONS_TOKEN = 'PERMISSIONS_TOKEN'; export const PERMISSIONS_OWNERSHIP_SERVICE_TOKEN = 'PERMISSIONS_OWNERSHIP_SERVICE_TOKEN'; /** * @internal */ export const PERMISSIONS_EXTRACT_USER_FROM_REQUEST_TOKEN = 'PERMISSIONS_EXTRACT_USER_FROM_REQUEST_TOKEN'; /** * @internal */ export const PERMISSIONS_MAP_RESOURCE_ID_TOKEN = 'PERMISSIONS_MAP_RESOURCE_ID_TOKEN'; /** The `extractUserFromRequest` callback extracts and returns an `IUser {id: TId; roles: string[]}`. Usually our User is in `req.user` object or similar, placed by our authentication middleware. Alternatively you can use something like request-context or its newer cls-hooked incarnations etc. If `req.user` complies already, you can omit this callback as `defaultExtractUserFromRequest` does it for you. You can use also to inject test or hardcode environment users etc. */ export type TExtractUserFromRequest<TUserId extends Tid = number> = ( req: any ) => Promise<IUser<TUserId>>; /** * Project from one value to another, used to project req to our ResourceId (projectResourceId) */ export type TProjectTo<TResourceId extends Tid = number> = (paramStr: string) => TResourceId; /** **PermissionDefinitions** in SuperAwesome Permissions for NestJS have an important difference to [Permissions ones](https://permissions.docs.superawesome.com/additional-documentation/detailed-usage-&-examples.html): all ownership hooks are replaced with a string name, corresponding to a method name in the PermissionOwnershipService. This is cause [its currently impossible](https://stackoverflow.com/questions/55560858/in-nest-js-is-it-possible-to-get-service-instance-inside-a-param-decorator) to [inject on a guard/decorator](https://github.com/nestjs/nest/issues/1038) on nestjs. See code comments in createPermissionsGuard for more context. __Note:__ If a method declared in IPermissionDefinitionStringOwnHooks is missing from PermissionsOwnershipService, you'll get an exception at module build time. */ export interface IPermissionDefinitionStringOwnHooks extends Omit<PermissionDefinition, 'isOwner' | 'listOwned' | 'limitOwned'> { isOwner?: string; listOwned?: string; limitOwned?: string; } export interface IPermissionsModuleOptions< TUserId extends Tid = number, TResourceId extends Tid = number > extends IPermissionsOptions<TUserId> { extractUserFromRequest?: TExtractUserFromRequest<TUserId>; projectResourceId?: TProjectTo<TResourceId>; } </code></pre> </div> </div> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div>  </div> </div> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface'; var COMPODOC_CURRENT_PAGE_URL = 'IPermissionsModuleOptions.html'; </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script>  <script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script> <script src="../js/menu-wc.js" defer></script> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/clipboard.min.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/search/search_index.js"></script> <script src="../js/lazy-load-graphs.js"></script> </body> </html>