@superawesome/permissions-nestjs
Version:
NestJS Guard & Decorators for @superawesome/permissions, promoting orthogonal fine-grained API access control to resources.
276 lines (218 loc) • 9.02 kB
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>
<!-- START CONTENT -->
<div class="content module">
<div class="content-data">
<ol class="breadcrumb">
<li>Modules</li>
<li>PermissionsModule</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/permissions.module.ts</code>
</p>
<div class="container-fluid module">
<div class="row">
</div>
</div>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="forRoot"></a>
<span class="name">
<b>
<span class="modifier">Static</span>
forRoot
</b>
<a href="#forRoot"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>forRoot(undefined: <a href="../interfaces/IPermissionsModuleOptions.html">IPermissionsModuleOptions</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="16"
class="link-to-prism">src/permissions.module.ts:16</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>
<code><a href="../interfaces/IPermissionsModuleOptions.html" target="_self" >IPermissionsModuleOptions</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code>DynamicModule</code>
</div>
<div class="io-description">
</div>
</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 * as _ from 'lodash';
import { Permissions, Tid } from '@superawesome/permissions';
import { Module, DynamicModule, Global, Provider } from '@nestjs/common';
import {
PERMISSIONS_EXTRACT_USER_FROM_REQUEST_TOKEN,
PERMISSIONS_MAP_RESOURCE_ID_TOKEN,
PERMISSIONS_TOKEN,
IPermissionsModuleOptions,
} from './types';
import { PermissionsService } from './permissions.service';
import { defaultExtractUserFromRequest } from './utils';
@Global()
@Module({})
export class PermissionsModule<TUserId extends Tid = number, TResourceId extends Tid = number> {
public static forRoot({
permissionDefinitions,
permissionDefinitionDefaults,
limitOwnReduce,
extractUserFromRequest,
projectResourceId,
}: IPermissionsModuleOptions = {}): DynamicModule {
const permissions = new Permissions({
permissionDefinitions,
permissionDefinitionDefaults,
limitOwnReduce,
});
const permissionsProvider: Provider = {
provide: PERMISSIONS_TOKEN,
useValue: permissions,
};
const extractUserFromRequestProvider: Provider = {
provide: PERMISSIONS_EXTRACT_USER_FROM_REQUEST_TOKEN,
useValue: extractUserFromRequest || defaultExtractUserFromRequest,
};
const mapResourceIdProvider: Provider = {
provide: PERMISSIONS_MAP_RESOURCE_ID_TOKEN,
useValue: projectResourceId || _.identity,
};
return {
module: PermissionsModule,
providers: [
extractUserFromRequestProvider,
mapResourceIdProvider,
permissionsProvider,
PermissionsService,
],
exports: [extractUserFromRequestProvider, mapResourceIdProvider, permissionsProvider],
};
}
}
</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>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'PermissionsModule.html';
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<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>