@aptly-as/express-scope 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,2 @@
1
+ # Aptly scope middleware
2
+ # express-scope
package/lib/Scope.d.ts ADDED
@@ -0,0 +1,34 @@
1
+ import { NextFunction, Request, Response } from 'express';
2
+ import { ScopeAccess, ScopeFn, ScopeRolesSchema, ScopeModuleSchema, ScopeRequest, ScopeRequestItem, ScopeRequestValidate } from './types.js';
3
+ export default class Scope<R extends Request, SCOPE extends string, MODULE extends ScopeModuleSchema<string, SCOPE>, USER extends ScopeRolesSchema<string, SCOPE>, ORG extends ScopeRolesSchema<string, SCOPE>> {
4
+ private _modules;
5
+ private _userRoles;
6
+ private _organizationRoles;
7
+ private _request;
8
+ private _error;
9
+ readonly _scopes: SCOPE[];
10
+ constructor(_modules: MODULE, _userRoles: USER, _organizationRoles: ORG, _request: ScopeFn<R, SCOPE, MODULE, USER, ORG>, _error: (req: R, obj: object) => object);
11
+ get user(): USER;
12
+ get organization(): ORG;
13
+ get scopes(): SCOPE[];
14
+ /**
15
+ * @deprecated use access instead
16
+ */
17
+ crud(scope: SCOPE | SCOPE[], access: ScopeAccess, validate?: ScopeRequestValidate<R>): (req: R, res: Response, next?: NextFunction | undefined) => boolean | void | Response;
18
+ access(scope: SCOPE | SCOPE[], access: ScopeAccess, validate?: ScopeRequestValidate<R>): (req: R, res: Response, next?: NextFunction) => boolean | void | Response;
19
+ /**
20
+ * @deprecated use list instead
21
+ */
22
+ validate(crudArray: ScopeRequestItem<R, SCOPE> | Array<ScopeRequestItem<R, SCOPE>>): (req: R, res: Response, next?: NextFunction | undefined) => boolean | void | Response;
23
+ list(crudArray: ScopeRequestItem<R, SCOPE> | Array<ScopeRequestItem<R, SCOPE>>): (req: R, res: Response, next?: NextFunction) => boolean | void | Response;
24
+ get<K extends 'json' | 'next' | 'return' = 'json'>(action?: K, key?: K extends 'next' ? keyof R : undefined): (req: R, res: Response, next: NextFunction) => any;
25
+ req(req: R, res: Response): ScopeRequest<R, SCOPE>;
26
+ private _getScopeArray;
27
+ private _getScopeFromModelScopes;
28
+ private _joinSetsToArray;
29
+ private _checkScope;
30
+ private _getObjects;
31
+ private _getScopes;
32
+ private _scopeAccess;
33
+ private _unauthorized;
34
+ }
package/lib/Scope.js ADDED
@@ -0,0 +1,183 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class Scope {
4
+ constructor(_modules, _userRoles, _organizationRoles, _request, _error) {
5
+ this._modules = _modules;
6
+ this._userRoles = _userRoles;
7
+ this._organizationRoles = _organizationRoles;
8
+ this._request = _request;
9
+ this._error = _error;
10
+ const userScopes = Object.keys(this._userRoles)
11
+ .map((key) => Object.keys(this._userRoles[key]))
12
+ .flat();
13
+ const organizationScopes = Object.keys(this._organizationRoles)
14
+ .map((key) => Object.keys(this._organizationRoles[key]))
15
+ .flat();
16
+ this._scopes = [
17
+ ...new Set([...userScopes, ...organizationScopes]),
18
+ ];
19
+ }
20
+ get user() {
21
+ return this._userRoles;
22
+ }
23
+ get organization() {
24
+ return this._organizationRoles;
25
+ }
26
+ get scopes() {
27
+ return this._scopes;
28
+ }
29
+ /**
30
+ * @deprecated use access instead
31
+ */
32
+ crud(scope, access, validate) {
33
+ return this.access(scope, access, validate);
34
+ }
35
+ access(scope, access, validate) {
36
+ return (req, res, next) => {
37
+ const hasNext = typeof next === 'function';
38
+ try {
39
+ const scopes = this._getScopes(scope);
40
+ if (this._checkScope(req, scopes, access) &&
41
+ (!validate || validate(req))) {
42
+ return hasNext ? next() : true;
43
+ }
44
+ return hasNext
45
+ ? this._unauthorized(req, res, {
46
+ scope,
47
+ access,
48
+ validate,
49
+ })
50
+ : false;
51
+ }
52
+ catch (e) {
53
+ console.error('Permission error', hasNext, e);
54
+ return hasNext ? next(e) : false;
55
+ }
56
+ };
57
+ }
58
+ /**
59
+ * @deprecated use list instead
60
+ */
61
+ validate(crudArray) {
62
+ return this.list(crudArray);
63
+ }
64
+ list(crudArray) {
65
+ return (req, res, next) => {
66
+ const crudArrays = this._getObjects(crudArray);
67
+ const isNext = typeof next === 'function';
68
+ try {
69
+ if (crudArrays.some(([scope, crud, validate]) => this._checkScope(req, this._getScopes(scope), crud) &&
70
+ (!validate || validate(req)))) {
71
+ return isNext ? next() : true;
72
+ }
73
+ return isNext ? this._unauthorized(req, res, { crudArray }) : false;
74
+ }
75
+ catch (e) {
76
+ console.error(e);
77
+ return isNext ? next(e) : false;
78
+ }
79
+ };
80
+ }
81
+ get(action, key) {
82
+ return (req, res, next) => {
83
+ try {
84
+ const { user, organization, modules, override } = this._scopeAccess(req);
85
+ if (override) {
86
+ return res.json(override);
87
+ }
88
+ let json = this._scopes.reduce((obj, modelKey) => {
89
+ const userPermission = new Set(this._getScopeArray(user, this._userRoles, modelKey));
90
+ const orgPermission = new Set(this._getScopeArray(organization, this._organizationRoles, modelKey));
91
+ obj[modelKey] = this._joinSetsToArray(userPermission, orgPermission);
92
+ return obj;
93
+ }, {});
94
+ if (modules) {
95
+ const flatModels = modules.map((x) => this._modules[x]).flat();
96
+ json = flatModels.reduce((obj, x) => {
97
+ obj[x] = json[x];
98
+ return obj;
99
+ }, {});
100
+ }
101
+ if (action === 'return') {
102
+ return json;
103
+ }
104
+ else if (action === 'next') {
105
+ if (!key) {
106
+ throw new Error('keyNotProvidedWithNextAction');
107
+ }
108
+ req[key] = json;
109
+ return next();
110
+ }
111
+ else {
112
+ res.json(json);
113
+ }
114
+ }
115
+ catch (e) {
116
+ console.error(e);
117
+ next(e);
118
+ }
119
+ };
120
+ }
121
+ req(req, res) {
122
+ return {
123
+ crud: (scope, access, validate) => this.access(scope, access, validate)(req, res),
124
+ validate: (crudArray) => this.validate(crudArray)(req, res),
125
+ };
126
+ }
127
+ _getScopeArray(scopes, model, key) {
128
+ return scopes
129
+ .map((x) => this._getScopeFromModelScopes(model, x, key))
130
+ .flat();
131
+ }
132
+ _getScopeFromModelScopes(scope, x, key) {
133
+ var _a, _b;
134
+ return ((_b = (_a = scope[x]) === null || _a === void 0 ? void 0 : _a[key]) === null || _b === void 0 ? void 0 : _b.split('')) || [];
135
+ }
136
+ _joinSetsToArray(arr1, arr2) {
137
+ return [...new Set([...arr1, ...arr2])].join('');
138
+ }
139
+ _checkScope(req, scopes, access) {
140
+ const { user, organization, modules, override } = this._scopeAccess(req);
141
+ if (modules &&
142
+ !modules.some((module) => scopes.some((scope) => { var _a; return (_a = this._modules[module]) === null || _a === void 0 ? void 0 : _a.includes(scope); }))) {
143
+ return false;
144
+ }
145
+ if (override) {
146
+ return scopes.some((mod) => override[mod] && override[mod].includes(access));
147
+ }
148
+ if (user === null || user === void 0 ? void 0 : user.some((glob) => scopes.some((mod) => { var _a, _b; return (_b = (_a = this._userRoles[glob]) === null || _a === void 0 ? void 0 : _a[mod]) === null || _b === void 0 ? void 0 : _b.includes(access); }))) {
149
+ return true;
150
+ }
151
+ if (organization === null || organization === void 0 ? void 0 : organization.some((org) => scopes.some((mod) => { var _a, _b; return (_b = (_a = this._organizationRoles[org]) === null || _a === void 0 ? void 0 : _a[mod]) === null || _b === void 0 ? void 0 : _b.includes(access); }))) {
152
+ return true;
153
+ }
154
+ return false;
155
+ }
156
+ _getObjects(obj) {
157
+ return (Array.isArray(obj) ? obj : [obj]);
158
+ }
159
+ _getScopes(scope) {
160
+ return Array.isArray(scope) ? scope : [scope];
161
+ }
162
+ _scopeAccess(req) {
163
+ const { user, organization, modules, override } = this._request(req);
164
+ return {
165
+ user: Array.isArray(user) ? user : user ? [user] : [],
166
+ organization: Array.isArray(organization)
167
+ ? organization
168
+ : organization
169
+ ? [organization]
170
+ : [],
171
+ modules: Array.isArray(modules)
172
+ ? modules
173
+ : modules
174
+ ? [modules]
175
+ : undefined,
176
+ override,
177
+ };
178
+ }
179
+ _unauthorized(req, res, obj) {
180
+ return res.status(403).json(this._error(req, obj));
181
+ }
182
+ }
183
+ exports.default = Scope;
@@ -0,0 +1,8 @@
1
+ import { Request } from 'express';
2
+ import Scope from './Scope.js';
3
+ import { ScopeMiddleware } from './ScopeMiddleware.js';
4
+ export declare class ScopeHandler<R extends Request, S extends string> {
5
+ private scope;
6
+ constructor(scope: Scope<R, S, any, any, any>);
7
+ new(scope: S | S[]): ScopeMiddleware<R, S>;
8
+ }
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ScopeHandler = void 0;
4
+ const ScopeMiddleware_js_1 = require("./ScopeMiddleware.js");
5
+ class ScopeHandler {
6
+ constructor(scope) {
7
+ this.scope = scope;
8
+ }
9
+ new(scope) {
10
+ return new ScopeMiddleware_js_1.ScopeMiddleware(this.scope, scope);
11
+ }
12
+ }
13
+ exports.ScopeHandler = ScopeHandler;
@@ -0,0 +1,14 @@
1
+ import { Request } from 'express';
2
+ import Scope from './Scope.js';
3
+ import { ScopeValidateFn } from './types.js';
4
+ export declare class ScopeMiddleware<R extends Request, S extends string> {
5
+ private _scope;
6
+ readonly CREATE: ScopeValidateFn<R>;
7
+ readonly READ: ScopeValidateFn<R>;
8
+ readonly UPDATE: ScopeValidateFn<R>;
9
+ readonly DELETE: ScopeValidateFn<R>;
10
+ constructor(_scope: Scope<R, S, any, any, any>, scope: S | S[]);
11
+ get scope(): Scope<R, S, any, any, any>;
12
+ get list(): (crudArray: import("./types.js").ScopeRequestItem<R, S> | import("./types.js").ScopeRequestItem<R, S>[]) => (req: R, res: import("express").Response, next?: import("express").NextFunction | undefined) => boolean | void | import("express").Response;
13
+ get validate(): (crudArray: import("./types.js").ScopeRequestItem<R, S> | import("./types.js").ScopeRequestItem<R, S>[]) => (req: R, res: import("express").Response, next?: import("express").NextFunction | undefined) => boolean | void | import("express").Response;
14
+ }
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ScopeMiddleware = void 0;
4
+ class ScopeMiddleware {
5
+ constructor(_scope, scope) {
6
+ this._scope = _scope;
7
+ this.CREATE = _scope.access(scope, 'C');
8
+ this.READ = _scope.access(scope, 'R');
9
+ this.UPDATE = _scope.access(scope, 'U');
10
+ this.DELETE = _scope.access(scope, 'D');
11
+ }
12
+ get scope() {
13
+ return this._scope;
14
+ }
15
+ get list() {
16
+ return this._scope.list.bind(this._scope);
17
+ }
18
+ get validate() {
19
+ return this._scope.validate.bind(this._scope);
20
+ }
21
+ }
22
+ exports.ScopeMiddleware = ScopeMiddleware;
package/lib/index.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ import Scope from './Scope.js';
2
+ export * from './ScopeHandler.js';
3
+ export * from './types.js';
4
+ export default Scope;
5
+ export { Scope };
6
+ export { ScopeMiddleware } from './ScopeMiddleware.js';
package/lib/index.js ADDED
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.ScopeMiddleware = exports.Scope = void 0;
18
+ const Scope_js_1 = require("./Scope.js");
19
+ exports.Scope = Scope_js_1.default;
20
+ __exportStar(require("./ScopeHandler.js"), exports);
21
+ __exportStar(require("./types.js"), exports);
22
+ exports.default = Scope_js_1.default;
23
+ var ScopeMiddleware_js_1 = require("./ScopeMiddleware.js");
24
+ Object.defineProperty(exports, "ScopeMiddleware", { enumerable: true, get: function () { return ScopeMiddleware_js_1.ScopeMiddleware; } });
@@ -0,0 +1 @@
1
+ {"program":{"fileNames":["../node_modules/typescript/lib/lib.es5.d.ts","../node_modules/typescript/lib/lib.es2015.d.ts","../node_modules/typescript/lib/lib.es2016.d.ts","../node_modules/typescript/lib/lib.es2017.d.ts","../node_modules/typescript/lib/lib.es2018.d.ts","../node_modules/typescript/lib/lib.es2019.d.ts","../node_modules/typescript/lib/lib.dom.d.ts","../node_modules/typescript/lib/lib.es2015.core.d.ts","../node_modules/typescript/lib/lib.es2015.collection.d.ts","../node_modules/typescript/lib/lib.es2015.generator.d.ts","../node_modules/typescript/lib/lib.es2015.iterable.d.ts","../node_modules/typescript/lib/lib.es2015.promise.d.ts","../node_modules/typescript/lib/lib.es2015.proxy.d.ts","../node_modules/typescript/lib/lib.es2015.reflect.d.ts","../node_modules/typescript/lib/lib.es2015.symbol.d.ts","../node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts","../node_modules/typescript/lib/lib.es2016.array.include.d.ts","../node_modules/typescript/lib/lib.es2017.object.d.ts","../node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts","../node_modules/typescript/lib/lib.es2017.string.d.ts","../node_modules/typescript/lib/lib.es2017.intl.d.ts","../node_modules/typescript/lib/lib.es2017.typedarrays.d.ts","../node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts","../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts","../node_modules/typescript/lib/lib.es2018.intl.d.ts","../node_modules/typescript/lib/lib.es2018.promise.d.ts","../node_modules/typescript/lib/lib.es2018.regexp.d.ts","../node_modules/typescript/lib/lib.es2019.array.d.ts","../node_modules/typescript/lib/lib.es2019.object.d.ts","../node_modules/typescript/lib/lib.es2019.string.d.ts","../node_modules/typescript/lib/lib.es2019.symbol.d.ts","../node_modules/typescript/lib/lib.es2019.intl.d.ts","../node_modules/typescript/lib/lib.es2020.bigint.d.ts","../node_modules/typescript/lib/lib.es2020.intl.d.ts","../node_modules/typescript/lib/lib.esnext.intl.d.ts","../node_modules/typescript/lib/lib.decorators.d.ts","../node_modules/typescript/lib/lib.decorators.legacy.d.ts","../node_modules/@types/node/globals.d.ts","../node_modules/@types/node/assert.d.ts","../node_modules/@types/node/async_hooks.d.ts","../node_modules/@types/node/buffer.d.ts","../node_modules/@types/node/child_process.d.ts","../node_modules/@types/node/cluster.d.ts","../node_modules/@types/node/console.d.ts","../node_modules/@types/node/constants.d.ts","../node_modules/@types/node/crypto.d.ts","../node_modules/@types/node/dgram.d.ts","../node_modules/@types/node/dns.d.ts","../node_modules/@types/node/domain.d.ts","../node_modules/@types/node/events.d.ts","../node_modules/@types/node/fs.d.ts","../node_modules/@types/node/http.d.ts","../node_modules/@types/node/http2.d.ts","../node_modules/@types/node/https.d.ts","../node_modules/@types/node/inspector.d.ts","../node_modules/@types/node/module.d.ts","../node_modules/@types/node/net.d.ts","../node_modules/@types/node/os.d.ts","../node_modules/@types/node/path.d.ts","../node_modules/@types/node/perf_hooks.d.ts","../node_modules/@types/node/process.d.ts","../node_modules/@types/node/punycode.d.ts","../node_modules/@types/node/querystring.d.ts","../node_modules/@types/node/readline.d.ts","../node_modules/@types/node/repl.d.ts","../node_modules/@types/node/stream.d.ts","../node_modules/@types/node/string_decoder.d.ts","../node_modules/@types/node/timers.d.ts","../node_modules/@types/node/tls.d.ts","../node_modules/@types/node/trace_events.d.ts","../node_modules/@types/node/tty.d.ts","../node_modules/@types/node/url.d.ts","../node_modules/@types/node/util.d.ts","../node_modules/@types/node/v8.d.ts","../node_modules/@types/node/vm.d.ts","../node_modules/@types/node/worker_threads.d.ts","../node_modules/@types/node/zlib.d.ts","../node_modules/@types/node/base.d.ts","../node_modules/@types/node/ts3.2/fs.d.ts","../node_modules/@types/node/ts3.2/util.d.ts","../node_modules/@types/node/ts3.2/globals.d.ts","../node_modules/@types/node/ts3.2/index.d.ts","../node_modules/@types/range-parser/index.d.ts","../node_modules/@types/express-serve-static-core/index.d.ts","../node_modules/@types/mime/index.d.ts","../node_modules/@types/serve-static/index.d.ts","../node_modules/@types/connect/index.d.ts","../node_modules/@types/body-parser/index.d.ts","../node_modules/@types/express/index.d.ts","../src/types.ts","../src/scope.ts","../src/scopemiddleware.ts","../src/scopehandler.ts","../src/index.ts","../node_modules/@types/chai/index.d.ts","../node_modules/@types/chai-subset/index.d.ts","../node_modules/@types/minimatch/index.d.ts","../node_modules/@types/sinonjs__fake-timers/index.d.ts","../node_modules/@types/sinon/index.d.ts"],"fileInfos":[{"version":"6a6b471e7e43e15ef6f8fe617a22ce4ecb0e34efa6c3dfcfe7cebd392bcca9d2","affectsGlobalScope":true},"45b7ab580deca34ae9729e97c13cfd999df04416a79116c3bfb483804f85ded4","dc48272d7c333ccf58034c0026162576b7d50ea0e69c3b9292f803fc20720fd5","27147504487dc1159369da4f4da8a26406364624fa9bc3db632f7d94a5bae2c3","5e1c4c362065a6b95ff952c0eab010f04dcd2c3494e813b493ecfd4fcb9fc0d8","68d73b4a11549f9c0b7d352d10e91e5dca8faa3322bfb77b661839c42b1ddec7",{"version":"fcd3ecc9f764f06f4d5c467677f4f117f6abf49dee6716283aa204ff1162498b","affectsGlobalScope":true},{"version":"f296963760430fb65b4e5d91f0ed770a91c6e77455bacf8fa23a1501654ede0e","affectsGlobalScope":true},{"version":"5114a95689b63f96b957e00216bc04baf9e1a1782aa4d8ee7e5e9acbf768e301","affectsGlobalScope":true},{"version":"4443e68b35f3332f753eacc66a04ac1d2053b8b035a0e0ac1d455392b5e243b3","affectsGlobalScope":true},{"version":"ab22100fdd0d24cfc2cc59d0a00fc8cf449830d9c4030dc54390a46bd562e929","affectsGlobalScope":true},{"version":"f7bd636ae3a4623c503359ada74510c4005df5b36de7f23e1db8a5c543fd176b","affectsGlobalScope":true},{"version":"ce691fb9e5c64efb9547083e4a34091bcbe5bdb41027e310ebba8f7d96a98671","affectsGlobalScope":true},{"version":"8d697a2a929a5fcb38b7a65594020fcef05ec1630804a33748829c5ff53640d0","affectsGlobalScope":true},{"version":"0c20f4d2358eb679e4ae8a4432bdd96c857a2960fd6800b21ec4008ec59d60ea","affectsGlobalScope":true},{"version":"36ae84ccc0633f7c0787bc6108386c8b773e95d3b052d9464a99cd9b8795fbec","affectsGlobalScope":true},{"version":"82d0d8e269b9eeac02c3bd1c9e884e85d483fcb2cd168bccd6bc54df663da031","affectsGlobalScope":true},{"version":"b8deab98702588840be73d67f02412a2d45a417a3c097b2e96f7f3a42ac483d1","affectsGlobalScope":true},{"version":"4738f2420687fd85629c9efb470793bb753709c2379e5f85bc1815d875ceadcd","affectsGlobalScope":true},{"version":"2f11ff796926e0832f9ae148008138ad583bd181899ab7dd768a2666700b1893","affectsGlobalScope":true},{"version":"376d554d042fb409cb55b5cbaf0b2b4b7e669619493c5d18d5fa8bd67273f82a","affectsGlobalScope":true},{"version":"9fc46429fbe091ac5ad2608c657201eb68b6f1b8341bd6d670047d32ed0a88fa","affectsGlobalScope":true},{"version":"61c37c1de663cf4171e1192466e52c7a382afa58da01b1dc75058f032ddf0839","affectsGlobalScope":true},{"version":"c4138a3dd7cd6cf1f363ca0f905554e8d81b45844feea17786cdf1626cb8ea06","affectsGlobalScope":true},{"version":"6ff3e2452b055d8f0ec026511c6582b55d935675af67cdb67dd1dc671e8065df","affectsGlobalScope":true},{"version":"03de17b810f426a2f47396b0b99b53a82c1b60e9cba7a7edda47f9bb077882f4","affectsGlobalScope":true},{"version":"8184c6ddf48f0c98429326b428478ecc6143c27f79b79e85740f17e6feb090f1","affectsGlobalScope":true},{"version":"261c4d2cf86ac5a89ad3fb3fafed74cbb6f2f7c1d139b0540933df567d64a6ca","affectsGlobalScope":true},{"version":"6af1425e9973f4924fca986636ac19a0cf9909a7e0d9d3009c349e6244e957b6","affectsGlobalScope":true},{"version":"576711e016cf4f1804676043e6a0a5414252560eb57de9faceee34d79798c850","affectsGlobalScope":true},{"version":"89c1b1281ba7b8a96efc676b11b264de7a8374c5ea1e6617f11880a13fc56dc6","affectsGlobalScope":true},{"version":"15a630d6817718a2ddd7088c4f83e4673fde19fa992d2eae2cf51132a302a5d3","affectsGlobalScope":true},{"version":"b7e9f95a7387e3f66be0ed6db43600c49cec33a3900437ce2fd350d9b7cb16f2","affectsGlobalScope":true},{"version":"9cc66b0513ad41cb5f5372cca86ef83a0d37d1c1017580b7dace3ea5661836df","affectsGlobalScope":true},{"version":"307c8b7ebbd7f23a92b73a4c6c0a697beca05b06b036c23a34553e5fe65e4fdc","affectsGlobalScope":true},{"version":"189c0703923150aa30673fa3de411346d727cc44a11c75d05d7cf9ef095daa22","affectsGlobalScope":true},{"version":"782dec38049b92d4e85c1585fbea5474a219c6984a35b004963b00beb1aab538","affectsGlobalScope":true},{"version":"6cf62fbc792aa81fa62f99dab5cc692c5315ecd5da09dd35f1ccc82778c4d5bc","affectsGlobalScope":true},"7860312f33f0cf2c93500787d02c4cc43ea3d0c080d4781095ac7715d5da3316","1305b079a057355f496bdde048716189178877a6b4fe0e9267a46af67f8c7561","61215c1a376bbe8f51cab4cc4ddbf3746387015113c37a84d981d4738c21b878","163b9cd8ff3c8f1d4a7fd110099bb5d606a389c58233562516d70ac2d7e0ec7c","ce629710e5e58724902b753212e97861fd73e2aa09f5d88cb6d55dc763cf8c8a","525c8fc510d9632d2a0a9de2d41c3ac1cdd79ff44d3b45c6d81cacabb683528d","0279383034fae92db8097d0a41350293553599cc9c3c917b60e2542d0dfcbd44","43f461871cd5ae52073e97d3c2e5869ebd955c42d30a51d3eb3a6c2cd16b80c4","7954df44c35d39b851b996fdc1af0a252e4e23f862abfef388a058203bb94c30","ef226a42de7022eacdfa0f15aabf73b46c47af93044c8ebfab8aa8e3cf6c330c","d5b7c8819ce1bd31a45f7675309e145ec28e3aa1b60a8e0637fd0e8916255baa","3ad728027671c2c3c829e21803f8d7a15b29d808293644d50d928213280c072d","91b0f655867e04d42d86347eb12b78316faed8bd2c75a7f8400e43e9e34e4ebd","d5470fad800f025be0c4bd1b14c013ea5b4aeec90e53ab0e2703a8fe01f292b3","272c8598c3a29a3fa3027bd0a645c5f49b3f7832dfcf8e47b7260843ec8a40f3","dacbe08610729f6343ea9880ea8e737c6d7a6efa4a318d8f6acaf85db4aceed6","4218ced3933a31eed1278d350dd63c5900df0f0904f57d61c054d7a4b83dbe4c","03394bf8deb8781b490ae9266a843fbdf00647947d79e25fcbf1d89a9e9c8a66","358398fe4034395d85c87c319cca7a04001434b13dc68d067481ecb374385bfc","d9bc6f1917c24d862a68d2633e4a32fd586bfe3e412e5d11fd07d8266b94ced5","5fb30076f0e0e5744db8993648bfb67aadd895f439edad5cce039127a87a8a36","27ef4001526ee9d8afa57687a60bb3b59c52b32d29db0a2260094ab64726164f",{"version":"0e0d58f5e90c0a270dac052b9c5ad8ccdfc8271118c2105b361063218d528d6e","affectsGlobalScope":true},"30ec6f9c683b988c3cfaa0c4690692049c4e7ed7dc6f6e94f56194c06b86f5e1","5b34786b5d59b4e627c76f1294a00b5e92260a31ca87b29d9b7cb9acd3ba1acc","e1045d32a6a59dbcbe0ed2edddc6568221acc299ac68d92284153e7c00b39d51","30b9c2c0949e27506c7e751bd51749ca5ecb0d0a3ea854064039ffaa3707fad4","87a856ce45263344ebf69270ea1b0fc4eb13236a6194300bd5e99d1f022b0c6e","7e62aac2cc9c0710d772047ad89e8d7117f52592c791eb995ce1f865fedab432","b40652bf8ce4a18133b31349086523b219724dca8df3448c1a0742528e7ad5b9","6ba512fc25cfb3db60007c7b1b4428ce497986ac442c370da879223c3c258872","a77fdb357c78b70142b2fdbbfb72958d69e8f765fd2a3c69946c1018e89d4638","df905913ad47e24b6cb41d33f0c1f500bf9c4befe4325413a7644c9eb1e7965c","1e3da92862604b1f7a32265169f9aa712c4567742d42597704e04ae3e07019e7","bf237fb2ca1ac62fde63e5f8178a9030e4d6b11987744007272f03a9deec6f76","4407bd5f1d6f748590ba125195eb1d7a003c2de2f3b057456d3ac76a742d2561","bf244a366e8ee68acda125761c6e337c8795b37eef05947d62f89b584de926b3","7780573ed8387aaadcc61d87f3d60d77dabf1e060da252dc72ab1d73401988bb","f409183966a1dd93d3a9cd1d54fbeb85c73101e87cd5b19467c5e37b252f3fd8","6622f76993bdfeaacb947ba7c4cf26f2e5c5194194d02d792c3cba4174cd8fce","1ed55651f38540dba21f4a864bd89834ddb552446dce8c8a5f9dc0b44ce0b024","4f54f0a9dd3b644c99ec32b32f8804d5978bc854799b228ae9c467bf3c84c64c",{"version":"4926e99d2ad39c0bbd36f2d37cc8f52756bc7a5661ad7b12815df871a4b07ba1","affectsGlobalScope":true},"7c7dabe6de2f88a1b4a4d9a15479c2a99b6f5864b434b9d960fc312ba9498c0a","4e88b833be14c7f384e0dcd57bb30acd799e8e34d212635d693e41a75a71164b",{"version":"79f5491e53054886824c5cfee16f4d9682d78e2ec6d13ef4eae6ec2f82fe0cec","affectsGlobalScope":true},"be27a64e821a3e5af838650e4aa25805c60f057d0c37a9762c378d19d364b3e6","cdbae5083ef8f786069519405ca1f1e2ce72b9efebdf5e1931584fba747f3bc0","c3be42b83b5f57ae2f65280fa395f6d31f61304ac1a29b7b406b6a0e71da8c82","599abfa56230d73afc30a3bde749c2efd90acb58301b446835d5e235b35e2768","6e1c6fe784daeba017901db7766e6b872f535defe33b0e0196d2a12c26f50517",{"version":"9ff45904bd70acf8e977977344989909abbd7ca0a19ccd76b9b44a8ee2bd56b8","signature":"761468fd3482f1648d2e0d093b6355d07c10a6fd105a9e4fc62965f9f0f5108c"},{"version":"20b8afb823433cfbf37a6ad659adfecfe79cc7550bac400af396d35958852e69","signature":"4f1df7f10d8c590f6ca824add3d90c63bafa43ea8b0150a5c56cad5824f298fa"},{"version":"12e68e61e1b4c5acd16d4986f0e93987be3c126f4744558bc043e03be2ddd329","signature":"d901da05f273c40a3e415323bbe5670c83781b4d055d9b1a322ad788b09a9572"},{"version":"6870c22947cb0d3f93807ccb15cdf7f4b77a316e629c180fc483f4da28c2614d","signature":"9b7fd17ca12c86afba71ab8615b2ab13fe4222ec45a5938a56ab96db8177591e"},{"version":"2746350b1ab6f2e77aa95d7eeda939f5d45df57ef619a300acd06325fb7d940d","signature":"75475e39b4d7f12dd6f03ae740ff19c472bfe74e380de4fca589d8395b4882f7"},{"version":"c3bc5d095c3c22fd20b5a6550b9c9a6d56c3ffbb87ef057ccce7764b6bed4428","affectsGlobalScope":true},{"version":"f4c0db3a49cea9babd5d224ba14243a6a6119bf65a65198994033aaea3a60a71","affectsGlobalScope":true},"1d1e6bd176eee5970968423d7e215bfd66828b6db8d54d17afec05a831322633","f83b320cceccfc48457a818d18fc9a006ab18d0bdd727aa2c2e73dc1b4a45e98","cffac9db07bba0b35754412e48215d1bc5153c03c46409bbeaf315848359822b"],"root":[[90,94]],"options":{"declaration":true,"jsx":2,"module":1,"noUnusedLocals":false,"noUnusedParameters":false,"outDir":"./","skipLibCheck":true,"sourceMap":false,"strict":true,"target":2},"fileIdsList":[[51,52,73,79,80,82,87],[51,73,79,80,95],[51,73,79,80],[51,52,73,79,80,82],[50,51,52,73,79,80,82,83],[51,73,79,80,84,86,88],[38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,79,80],[50,51,57,66,73,79,80],[42,50,51,57,73,79,80],[51,66,73,79,80],[48,50,51,57,73,79,80],[50,51,73,79,80],[50,66,72,73,79,80],[50,51,57,66,72,73,79,80],[50,51,52,57,66,69,72,73,79,80],[50,51,52,69,72,73,79,80],[48,50,51,66,73,79,80],[40,51,73,79,80],[51,71,73,79,80],[50,51,66,73,79,80],[51,64,73,75,79,80],[46,48,51,57,66,73,79,80],[51,73,80],[38,51,73,79,80],[51,73,78,79,80,81],[51,73,79],[51,57,73,79,80],[51,63,73,79,80],[51,79,80],[50,51,66,73,75,79,80],[51,73,79,80,84,85],[51,73,79,80,98],[51,73,79,80,90,91,92,93],[51,73,79,80,89,90],[51,73,79,80,89,91,92],[51,73,79,80,89,90,91],[51,73,79,80,89],[90,91,92,93],[89,90],[89,91,92],[89,90,91],[89]],"referencedMap":[[88,1],[96,2],[95,3],[87,4],[84,5],[89,6],[85,3],[97,3],[39,3],[40,3],[78,7],[41,3],[42,8],[43,9],[44,3],[45,3],[46,10],[47,11],[48,3],[49,12],[50,3],[51,13],[38,3],[52,14],[53,15],[54,16],[55,12],[56,3],[57,17],[58,3],[59,3],[60,18],[61,19],[62,3],[63,3],[64,20],[65,21],[66,12],[67,3],[68,3],[69,22],[70,3],[79,23],[81,24],[82,25],[80,26],[71,27],[72,28],[73,29],[74,10],[75,3],[76,30],[77,10],[83,3],[86,31],[99,32],[98,3],[36,3],[37,3],[7,3],[9,3],[8,3],[2,3],[10,3],[11,3],[12,3],[13,3],[14,3],[15,3],[16,3],[17,3],[3,3],[4,3],[21,3],[18,3],[19,3],[20,3],[22,3],[23,3],[24,3],[5,3],[25,3],[26,3],[27,3],[28,3],[6,3],[32,3],[29,3],[30,3],[31,3],[33,3],[34,3],[1,3],[35,3],[94,33],[91,34],[93,35],[92,36],[90,37]],"exportedModulesMap":[[88,1],[96,2],[95,3],[87,4],[84,5],[89,6],[85,3],[97,3],[39,3],[40,3],[78,7],[41,3],[42,8],[43,9],[44,3],[45,3],[46,10],[47,11],[48,3],[49,12],[50,3],[51,13],[38,3],[52,14],[53,15],[54,16],[55,12],[56,3],[57,17],[58,3],[59,3],[60,18],[61,19],[62,3],[63,3],[64,20],[65,21],[66,12],[67,3],[68,3],[69,22],[70,3],[79,23],[81,24],[82,25],[80,26],[71,27],[72,28],[73,29],[74,10],[75,3],[76,30],[77,10],[83,3],[86,31],[99,32],[98,3],[36,3],[37,3],[7,3],[9,3],[8,3],[2,3],[10,3],[11,3],[12,3],[13,3],[14,3],[15,3],[16,3],[17,3],[3,3],[4,3],[21,3],[18,3],[19,3],[20,3],[22,3],[23,3],[24,3],[5,3],[25,3],[26,3],[27,3],[28,3],[6,3],[32,3],[29,3],[30,3],[31,3],[33,3],[34,3],[1,3],[35,3],[94,38],[91,39],[93,40],[92,41],[90,42]],"semanticDiagnosticsPerFile":[88,96,95,87,84,89,85,97,39,40,78,41,42,43,44,45,46,47,48,49,50,51,38,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,79,81,82,80,71,72,73,74,75,76,77,83,86,99,98,36,37,7,9,8,2,10,11,12,13,14,15,16,17,3,4,21,18,19,20,22,23,24,5,25,26,27,28,6,32,29,30,31,33,34,1,35,94,91,93,92,90]},"version":"5.0.4"}
package/lib/types.d.ts ADDED
@@ -0,0 +1,30 @@
1
+ import { NextFunction, Request, Response } from 'express';
2
+ export type ScopeAccessValue = 'C' | 'CR' | 'CRU' | 'CRUD' | 'R' | 'RU' | 'RUD' | 'U' | 'UD' | 'D';
3
+ export type ScopeAccess = 'C' | 'R' | 'U' | 'D';
4
+ export type ScopeAccessSchema<SCOPE extends string> = {
5
+ [key in SCOPE]: ScopeAccessValue;
6
+ };
7
+ export type ScopeRolesSchema<ROLE extends string, SCOPE extends string> = {
8
+ [key in ROLE]: Partial<ScopeAccessSchema<SCOPE>>;
9
+ };
10
+ export type ScopeModuleSchema<MODULE extends string, SCOPE extends string> = {
11
+ [key in MODULE]: SCOPE[];
12
+ };
13
+ export type ScopeFn<R extends Request, SCOPE extends string, MODULE extends ScopeModuleSchema<string, SCOPE>, USER extends ScopeRolesSchema<string, SCOPE>, ORG extends ScopeRolesSchema<string, SCOPE>> = (req: R) => ScopeOptions<SCOPE, MODULE, USER, ORG>;
14
+ export interface ScopeOptions<SCOPE extends string, MODULE extends ScopeModuleSchema<string, SCOPE>, USER extends ScopeRolesSchema<string, SCOPE>, ORG extends ScopeRolesSchema<string, SCOPE>> {
15
+ modules?: Array<keyof MODULE>;
16
+ override?: ScopeAccessSchema<any>;
17
+ organization?: Array<keyof ORG>;
18
+ user?: Array<keyof USER>;
19
+ }
20
+ export type ScopeRequestValidate<R extends Request> = (req: R) => boolean;
21
+ export type ScopeRequestItem<R extends Request, SCOPE extends string> = [
22
+ SCOPE | SCOPE[],
23
+ ScopeAccess,
24
+ ScopeRequestValidate<R>?
25
+ ];
26
+ export interface ScopeRequest<R extends Request, SCOPE extends string> {
27
+ crud: (scope: SCOPE | SCOPE[], access: ScopeAccess, validate?: ScopeRequestValidate<R>) => boolean;
28
+ validate: (crudArray: ScopeRequestItem<R, SCOPE> | Array<ScopeRequestItem<R, SCOPE>>) => boolean;
29
+ }
30
+ export type ScopeValidateFn<R> = (req: R, res: Response, next?: NextFunction | undefined) => boolean | void | Response;
package/lib/types.js ADDED
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/package.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "name": "@aptly-as/express-scope",
3
+ "version": "1.0.0",
4
+ "description": "",
5
+ "type": "module",
6
+ "main": "./lib/index.js",
7
+ "types": "./lib/index.d.ts",
8
+ "scripts": {
9
+ "dev": "yarn build:watch",
10
+ "build": "tsc",
11
+ "build:watch": "tsc --watch --incremental",
12
+ "lint": "tslint --project \"./tsconfig.json\"",
13
+ "test:watch": "mocha --watch --watch-extensions ts -r ts-node/register",
14
+ "test": "vitest run",
15
+ "test:ui": "vitest --ui --api 9527",
16
+ "coverage": "nyc mocha -r ts-node/register",
17
+ "coveralls": "yarn coverage | coveralls",
18
+ "postversion": "git push && git push --tags",
19
+ "prepublish": "yarn test && yarn build",
20
+ "preversion": "yarn build",
21
+ "prepare": "husky install"
22
+ },
23
+ "author": "Emil A Olsen (EmilsWebbod)",
24
+ "license": "ISC",
25
+ "devDependencies": {
26
+ "@types/express": "^4.17.2",
27
+ "@types/sinon": "^10.0.15",
28
+ "@vitest/ui": "^0.31.1",
29
+ "coveralls": "^3.0.7",
30
+ "express": "^4.17.1",
31
+ "husky": "^8.0.3",
32
+ "lint-staged": "^13.2.2",
33
+ "nyc": "^14.1.1",
34
+ "prettier": "^2.8.8",
35
+ "pretty-quick": "^2.0.1",
36
+ "sinon": "^15.0.4",
37
+ "ts-node": "^8.5.0",
38
+ "tslint": "^5.20.1",
39
+ "typescript": "^5.0.4",
40
+ "vitest": "^0.31.1"
41
+ },
42
+ "files": [
43
+ "lib"
44
+ ],
45
+ "bugs": {
46
+ "url": "https://github.com/aptly-as/express-scope/issues"
47
+ },
48
+ "homepage": "https://github.com/aptly-as/express-scope#readme",
49
+ "lint-staged": {
50
+ "**/*": "prettier --write --ignore-unknown"
51
+ }
52
+ }