@alanszp/jwt 12.0.3 → 14.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.
Files changed (38) hide show
  1. package/babel.config.js +7 -0
  2. package/dist/BitmaskUtils.d.ts +48 -0
  3. package/dist/BitmaskUtils.js +64 -0
  4. package/dist/BitmaskUtils.js.map +1 -0
  5. package/dist/BitmaskUtils.test.d.ts +1 -0
  6. package/dist/BitmaskUtils.test.js +152 -0
  7. package/dist/BitmaskUtils.test.js.map +1 -0
  8. package/dist/JWTUser.d.ts +58 -2
  9. package/dist/JWTUser.js +158 -3
  10. package/dist/JWTUser.js.map +1 -1
  11. package/dist/PermissionService.d.ts +26 -0
  12. package/dist/PermissionService.js +108 -0
  13. package/dist/PermissionService.js.map +1 -0
  14. package/dist/axiosPermissionsResolutionFactory.d.ts +4 -0
  15. package/dist/axiosPermissionsResolutionFactory.js +52 -0
  16. package/dist/axiosPermissionsResolutionFactory.js.map +1 -0
  17. package/dist/errors/NoPermissionError.d.ts +7 -0
  18. package/dist/errors/NoPermissionError.js +20 -0
  19. package/dist/errors/NoPermissionError.js.map +1 -0
  20. package/dist/errors/PermissionNotFound.d.ts +9 -0
  21. package/dist/errors/PermissionNotFound.js +24 -0
  22. package/dist/errors/PermissionNotFound.js.map +1 -0
  23. package/dist/errors/PermissionServiceError.d.ts +3 -0
  24. package/dist/errors/PermissionServiceError.js +8 -0
  25. package/dist/errors/PermissionServiceError.js.map +1 -0
  26. package/dist/errors/PermissionServiceNotInstantiated.d.ts +7 -0
  27. package/dist/errors/PermissionServiceNotInstantiated.js +17 -0
  28. package/dist/errors/PermissionServiceNotInstantiated.js.map +1 -0
  29. package/dist/errors/PermissionServiceRequestError.d.ts +9 -0
  30. package/dist/errors/PermissionServiceRequestError.js +23 -0
  31. package/dist/errors/PermissionServiceRequestError.js.map +1 -0
  32. package/dist/index.d.ts +7 -0
  33. package/dist/index.js +7 -0
  34. package/dist/index.js.map +1 -1
  35. package/dist/types.d.ts +7 -0
  36. package/jest.config.js +10 -0
  37. package/package.json +13 -2
  38. package/tsconfig.json +5 -2
@@ -0,0 +1,7 @@
1
+ // Used by Jest
2
+ module.exports = {
3
+ presets: [
4
+ ["@babel/preset-env", { targets: { node: "current" } }],
5
+ "@babel/preset-typescript",
6
+ ],
7
+ };
@@ -0,0 +1,48 @@
1
+ /**
2
+ * Bitmask utility class
3
+ * - Use to handle binary numbers
4
+ * - Support binary numbers larger than 32 bits (Node.js uses 32-bit numbers)
5
+ */
6
+ export declare class BitmaskUtils {
7
+ /**
8
+ * Encode a position into a binary number
9
+ * @example Bitmask.encodeFromPosition(0) // 1 or 0b1
10
+ * @example Bitmask.encodeFromPosition(1) // 2 or 0b10
11
+ * @example Bitmask.encodeFromPosition(2) // 4 or 0b100
12
+ * @example Bitmask.encodeFromPosition(3) // 8 or 0b1000
13
+ */
14
+ static encodeFromPosition(position: number): bigint;
15
+ /**
16
+ * Check if a bitmask has a specific bit set
17
+ * @param bitmask - the bitmask to check
18
+ * @param check - the bit to check (also a bitmask with only one bit set)
19
+ * @example Bitmask.checkBitmask(0b1010, 0b1000) // true
20
+ * @example Bitmask.checkBitmask(0b1010, 0b0100) // false
21
+ */
22
+ static checkBitmask(bitmask: bigint, check: bigint): boolean;
23
+ /**
24
+ * Combine multiple bitmasks into one
25
+ * Uses the bitwise OR operator to combine the bitmasks
26
+ * @param bitmasks - An array of bitmasks
27
+ * @returns The combined bitmask
28
+ * @example Bitmask.combineBitmasks([0b1000, 0b0100]) // 0b1100
29
+ * @example Bitmask.combineBitmasks([0b1000, 0b0100, 0b0010]) // 0b1110
30
+ */
31
+ static combineBitmasks(bitmasks: bigint[]): bigint;
32
+ /**
33
+ * Decode a base64 encoded string into a binary number
34
+ * @param base64 Base64 encoded bitmask (valid utf-8 string of a number)
35
+ * @returns The decoded bitmask
36
+ * @example Bitmask.decodeFromBase64("AQ==") // 1 or 0b1
37
+ * @example Bitmask.decodeFromBase64("Ag==") // 2 or 0b10
38
+ */
39
+ static decodeFromBase64(base64: string): bigint;
40
+ /**
41
+ * Encode a binary number into a base64 string
42
+ * @param bitmask The bitmask to encode
43
+ * @returns The base64 encoded bitmask
44
+ * @example Bitmask.encodeToBase64(1) // "AQ=="
45
+ * @example Bitmask.encodeToBase64(2) // "Ag=="
46
+ */
47
+ static encodeToBase64(bitmask: bigint): string;
48
+ }
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BitmaskUtils = void 0;
4
+ /**
5
+ * Bitmask utility class
6
+ * - Use to handle binary numbers
7
+ * - Support binary numbers larger than 32 bits (Node.js uses 32-bit numbers)
8
+ */
9
+ class BitmaskUtils {
10
+ /**
11
+ * Encode a position into a binary number
12
+ * @example Bitmask.encodeFromPosition(0) // 1 or 0b1
13
+ * @example Bitmask.encodeFromPosition(1) // 2 or 0b10
14
+ * @example Bitmask.encodeFromPosition(2) // 4 or 0b100
15
+ * @example Bitmask.encodeFromPosition(3) // 8 or 0b1000
16
+ */
17
+ static encodeFromPosition(position) {
18
+ return BigInt(1) << BigInt(position);
19
+ }
20
+ /**
21
+ * Check if a bitmask has a specific bit set
22
+ * @param bitmask - the bitmask to check
23
+ * @param check - the bit to check (also a bitmask with only one bit set)
24
+ * @example Bitmask.checkBitmask(0b1010, 0b1000) // true
25
+ * @example Bitmask.checkBitmask(0b1010, 0b0100) // false
26
+ */
27
+ static checkBitmask(bitmask, check) {
28
+ return (bitmask & check) === check;
29
+ }
30
+ /**
31
+ * Combine multiple bitmasks into one
32
+ * Uses the bitwise OR operator to combine the bitmasks
33
+ * @param bitmasks - An array of bitmasks
34
+ * @returns The combined bitmask
35
+ * @example Bitmask.combineBitmasks([0b1000, 0b0100]) // 0b1100
36
+ * @example Bitmask.combineBitmasks([0b1000, 0b0100, 0b0010]) // 0b1110
37
+ */
38
+ static combineBitmasks(bitmasks) {
39
+ return bitmasks.reduce((acc, bitmask) => acc | bitmask, BigInt(0));
40
+ }
41
+ /**
42
+ * Decode a base64 encoded string into a binary number
43
+ * @param base64 Base64 encoded bitmask (valid utf-8 string of a number)
44
+ * @returns The decoded bitmask
45
+ * @example Bitmask.decodeFromBase64("AQ==") // 1 or 0b1
46
+ * @example Bitmask.decodeFromBase64("Ag==") // 2 or 0b10
47
+ */
48
+ static decodeFromBase64(base64) {
49
+ const string = Buffer.from(base64, "base64").toString("utf-8");
50
+ return BigInt(string);
51
+ }
52
+ /**
53
+ * Encode a binary number into a base64 string
54
+ * @param bitmask The bitmask to encode
55
+ * @returns The base64 encoded bitmask
56
+ * @example Bitmask.encodeToBase64(1) // "AQ=="
57
+ * @example Bitmask.encodeToBase64(2) // "Ag=="
58
+ */
59
+ static encodeToBase64(bitmask) {
60
+ return Buffer.from(bitmask.toString()).toString("base64");
61
+ }
62
+ }
63
+ exports.BitmaskUtils = BitmaskUtils;
64
+ //# sourceMappingURL=BitmaskUtils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BitmaskUtils.js","sourceRoot":"","sources":["../src/BitmaskUtils.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,YAAY;IACvB;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAAC,QAAgB;QAC/C,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,YAAY,CAAC,OAAe,EAAE,KAAa;QACvD,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC,KAAK,KAAK,CAAC;IACrC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,eAAe,CAAC,QAAkB;QAC9C,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAc;QAC3C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,cAAc,CAAC,OAAe;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;CACF;AAzDD,oCAyDC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,152 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const BitmaskUtils_1 = require("./BitmaskUtils");
4
+ describe("BitmaskUtils", () => {
5
+ describe("encodeFromPosition", () => {
6
+ it.each([
7
+ { position: 0, expected: BigInt(0b1) },
8
+ { position: 1, expected: BigInt(0b10) },
9
+ { position: 5, expected: BigInt(0b100000) },
10
+ { position: 10, expected: BigInt(0b10000000000) },
11
+ { position: 15, expected: BigInt(0b1000000000000000) },
12
+ { position: 30, expected: BigInt(0b1000000000000000000000000000000) },
13
+ {
14
+ position: 31,
15
+ expected: BigInt(0b10000000000000000000000000000000),
16
+ },
17
+ // 32 is the maximum position for a 32-bit number - Node.js uses 32-bit numbers (when using unsigned ints), we should support more than 32 bits
18
+ {
19
+ position: 32,
20
+ expected: BigInt("0b100000000000000000000000000000000"),
21
+ },
22
+ {
23
+ position: 50,
24
+ expected: BigInt("0b100000000000000000000000000000000000000000000000000"),
25
+ },
26
+ {
27
+ position: 100,
28
+ expected: BigInt("0b10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"),
29
+ },
30
+ ])("Should encode a numeric position $position to a binary number", ({ position, expected }) => {
31
+ const result = BitmaskUtils_1.BitmaskUtils.encodeFromPosition(position);
32
+ expect(result).toStrictEqual(expected);
33
+ });
34
+ });
35
+ describe("checkBitmask", () => {
36
+ it.each([
37
+ {
38
+ bitmask: BigInt(0b1010),
39
+ position: 3,
40
+ expected: true,
41
+ },
42
+ {
43
+ bitmask: BigInt(0b1010),
44
+ position: 2,
45
+ expected: false,
46
+ },
47
+ {
48
+ bitmask: BigInt(0b1010),
49
+ position: 1,
50
+ expected: true,
51
+ },
52
+ {
53
+ bitmask: BigInt(0b1010),
54
+ position: 0,
55
+ expected: false,
56
+ },
57
+ ])("Should check if a bitmask has a specific bit set in position $position", ({ bitmask, position, expected }) => {
58
+ const check = BitmaskUtils_1.BitmaskUtils.encodeFromPosition(position);
59
+ const result = BitmaskUtils_1.BitmaskUtils.checkBitmask(bitmask, check);
60
+ expect(result).toStrictEqual(expected);
61
+ });
62
+ it("Should check if a bitmask has a specific bit set with big numbers", () => {
63
+ const bitmask = BitmaskUtils_1.BitmaskUtils.encodeFromPosition(100);
64
+ const result = BitmaskUtils_1.BitmaskUtils.checkBitmask(bitmask, bitmask);
65
+ expect(result).toStrictEqual(true);
66
+ });
67
+ it("Should check if a bitmask has a specific bit set with enormous numbers", () => {
68
+ const bitmask = BitmaskUtils_1.BitmaskUtils.encodeFromPosition(500);
69
+ const result = BitmaskUtils_1.BitmaskUtils.checkBitmask(bitmask, bitmask);
70
+ expect(result).toStrictEqual(true);
71
+ });
72
+ });
73
+ describe("combineBitmasks", () => {
74
+ it.each([
75
+ {
76
+ bitmasks: [BigInt(0b1000), BigInt(0b0100)],
77
+ expected: BigInt(0b1100),
78
+ },
79
+ {
80
+ bitmasks: [BigInt(0b1000), BigInt(0b0100), BigInt(0b0010)],
81
+ expected: BigInt(0b1110),
82
+ },
83
+ {
84
+ bitmasks: [
85
+ BigInt(0b1000),
86
+ BigInt(0b0100),
87
+ BigInt(0b0010),
88
+ BigInt(0b0001),
89
+ ],
90
+ expected: BigInt(0b1111),
91
+ },
92
+ {
93
+ bitmasks: [
94
+ BitmaskUtils_1.BitmaskUtils.encodeFromPosition(100),
95
+ BitmaskUtils_1.BitmaskUtils.encodeFromPosition(200),
96
+ BitmaskUtils_1.BitmaskUtils.encodeFromPosition(300),
97
+ BitmaskUtils_1.BitmaskUtils.encodeFromPosition(400),
98
+ ],
99
+ expected: BitmaskUtils_1.BitmaskUtils.encodeFromPosition(100) |
100
+ BitmaskUtils_1.BitmaskUtils.encodeFromPosition(200) |
101
+ BitmaskUtils_1.BitmaskUtils.encodeFromPosition(300) |
102
+ BitmaskUtils_1.BitmaskUtils.encodeFromPosition(400),
103
+ },
104
+ ])("Should combine multiple bitmasks into one", ({ bitmasks, expected }) => {
105
+ const result = BitmaskUtils_1.BitmaskUtils.combineBitmasks(bitmasks);
106
+ expect(result).toStrictEqual(expected);
107
+ });
108
+ });
109
+ describe("decodeFromBase64", () => {
110
+ it.each([
111
+ { base64: "MA==", expected: BigInt(0b0) },
112
+ { base64: "MQ==", expected: BigInt(0b1) },
113
+ { base64: "Mg==", expected: BigInt(0b10) },
114
+ { base64: "NjY3", expected: BigInt(0b1010011011) },
115
+ {
116
+ base64: "MTI2NzY1MDYwMDIyODIyOTQwMTQ5NjcwMzIwNTM3Ng==",
117
+ expected: BitmaskUtils_1.BitmaskUtils.encodeFromPosition(100),
118
+ },
119
+ ])("Should decode a base64 encoded bitmask for $base64", ({ base64, expected }) => {
120
+ const result = BitmaskUtils_1.BitmaskUtils.decodeFromBase64(base64);
121
+ expect(result).toStrictEqual(expected);
122
+ });
123
+ });
124
+ describe("encodeToBase64", () => {
125
+ it.each([
126
+ { bitmask: BigInt(0b0), expected: "MA==" },
127
+ { bitmask: BigInt(0b1), expected: "MQ==" },
128
+ { bitmask: BigInt(0b10), expected: "Mg==" },
129
+ { bitmask: BigInt(0b1010011011), expected: "NjY3" },
130
+ {
131
+ bitmask: BitmaskUtils_1.BitmaskUtils.encodeFromPosition(100),
132
+ expected: "MTI2NzY1MDYwMDIyODIyOTQwMTQ5NjcwMzIwNTM3Ng==",
133
+ },
134
+ ])("Should encode a bitmask to a base64 string for $bitmask", ({ bitmask, expected }) => {
135
+ const result = BitmaskUtils_1.BitmaskUtils.encodeToBase64(bitmask);
136
+ expect(result).toStrictEqual(expected);
137
+ });
138
+ it("Should encode and decode a bitmask from and to a base64 string", () => {
139
+ const bitmask = BigInt(0b1010011011);
140
+ const base64 = BitmaskUtils_1.BitmaskUtils.encodeToBase64(bitmask);
141
+ const result = BitmaskUtils_1.BitmaskUtils.decodeFromBase64(base64);
142
+ expect(result).toStrictEqual(bitmask);
143
+ });
144
+ it("Should encode and decode a bitmask from and to a base64 string with enormous numbers", () => {
145
+ const bitmask = BitmaskUtils_1.BitmaskUtils.encodeFromPosition(500);
146
+ const base64 = BitmaskUtils_1.BitmaskUtils.encodeToBase64(bitmask);
147
+ const result = BitmaskUtils_1.BitmaskUtils.decodeFromBase64(base64);
148
+ expect(result).toStrictEqual(bitmask);
149
+ });
150
+ });
151
+ });
152
+ //# sourceMappingURL=BitmaskUtils.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BitmaskUtils.test.js","sourceRoot":"","sources":["../src/BitmaskUtils.test.ts"],"names":[],"mappings":";;AAAA,iDAA8C;AAE9C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,IAAI,CAAC;YACN,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE;YACtC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE;YACvC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC3C,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,aAAa,CAAC,EAAE;YACjD,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,kBAAkB,CAAC,EAAE;YACtD,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,iCAAiC,CAAC,EAAE;YACrE;gBACE,QAAQ,EAAE,EAAE;gBACZ,QAAQ,EAAE,MAAM,CAAC,kCAAkC,CAAC;aACrD;YACD,+IAA+I;YAC/I;gBACE,QAAQ,EAAE,EAAE;gBACZ,QAAQ,EAAE,MAAM,CAAC,qCAAqC,CAAC;aACxD;YACD;gBACE,QAAQ,EAAE,EAAE;gBACZ,QAAQ,EAAE,MAAM,CACd,uDAAuD,CACxD;aACF;YACD;gBACE,QAAQ,EAAE,GAAG;gBACb,QAAQ,EAAE,MAAM,CACd,yGAAyG,CAC1G;aACF;SACF,CAAC,CACA,+DAA+D,EAC/D,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;YACzB,MAAM,MAAM,GAAG,2BAAY,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACzD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,IAAI,CAAC;YACN;gBACE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;gBACvB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,IAAI;aACf;YACD;gBACE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;gBACvB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;gBACvB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,IAAI;aACf;YACD;gBACE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;gBACvB,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC,CACA,wEAAwE,EACxE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;YAClC,MAAM,KAAK,GAAG,2BAAY,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,2BAAY,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACzD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;QAEF,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;YAC3E,MAAM,OAAO,GAAG,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,2BAAY,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;YAChF,MAAM,OAAO,GAAG,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,2BAAY,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,IAAI,CAAC;YACN;gBACE,QAAQ,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC1C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC;aACzB;YACD;gBACE,QAAQ,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC1D,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC;aACzB;YACD;gBACE,QAAQ,EAAE;oBACR,MAAM,CAAC,MAAM,CAAC;oBACd,MAAM,CAAC,MAAM,CAAC;oBACd,MAAM,CAAC,MAAM,CAAC;oBACd,MAAM,CAAC,MAAM,CAAC;iBACf;gBACD,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC;aACzB;YACD;gBACE,QAAQ,EAAE;oBACR,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACpC,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACpC,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACpC,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;iBACrC;gBACD,QAAQ,EACN,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACpC,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACpC,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACpC,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;aACvC;SACF,CAAC,CACA,2CAA2C,EAC3C,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;YACzB,MAAM,MAAM,GAAG,2BAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,IAAI,CAAC;YACN,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE;YACzC,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE;YACzC,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE;YAC1C,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE;YAClD;gBACE,MAAM,EAAE,8CAA8C;gBACtD,QAAQ,EAAE,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;aAC/C;SACF,CAAC,CACA,oDAAoD,EACpD,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE;YACvB,MAAM,MAAM,GAAG,2BAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,IAAI,CAAC;YACN,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE;YAC1C,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE;YAC1C,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE;YAC3C,EAAE,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE;YACnD;gBACE,OAAO,EAAE,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC;gBAC7C,QAAQ,EAAE,8CAA8C;aACzD;SACF,CAAC,CACA,yDAAyD,EACzD,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;YACxB,MAAM,MAAM,GAAG,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACpD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;QAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;YACrC,MAAM,MAAM,GAAG,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,2BAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sFAAsF,EAAE,GAAG,EAAE;YAC9F,MAAM,OAAO,GAAG,2BAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,2BAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
package/dist/JWTUser.d.ts CHANGED
@@ -1,5 +1,7 @@
1
+ import { IPermissionService } from "./PermissionService";
1
2
  import { IJWTUser, JWTPayload } from "./types";
2
3
  export declare class JWTUser implements IJWTUser {
4
+ #private;
3
5
  id: string;
4
6
  employeeReference: string | null;
5
7
  organizationReference: string;
@@ -7,6 +9,14 @@ export declare class JWTUser implements IJWTUser {
7
9
  roles: string[];
8
10
  permissions: string;
9
11
  segmentReference: string | null;
12
+ /**
13
+ * Instantiate the permission service for all instances of JWTUser
14
+ */
15
+ static setPermissionService(service: IPermissionService): void;
16
+ /**
17
+ * @throws {PermissionServiceNotInstantiated}
18
+ */
19
+ static getPermissionService(): IPermissionService;
10
20
  constructor({ id, employeeReference, organizationReference, roles, permissions, segmentReference, }: IJWTUser);
11
21
  static fromPayload(payload: JWTPayload): JWTUser;
12
22
  toTokenPayload(): JWTPayload;
@@ -23,9 +33,55 @@ export declare class JWTUser implements IJWTUser {
23
33
  hasRoles(validateRoles: string | string[]): boolean;
24
34
  /**
25
35
  * Check if user has permission to perform an action
26
- * @note - not implemented, will be implemented in the next release
27
36
  * @param permissionCode - permission code to check
28
37
  * @returns boolean
38
+ * @throws {PermissionDefinitionNotFound}
39
+ * @throws {PermissionServiceNotInstantiated}
40
+ */
41
+ hasPermission(permissionCode: string): Promise<boolean>;
42
+ /**
43
+ * Throws an error if the user does not have the required permission
44
+ * @param permissionCode
45
+ * @throws {NoPermissionError}
46
+ * @throws {PermissionDefinitionNotFound}
47
+ * @throws {PermissionServiceNotInstantiated}
48
+ */
49
+ validatePermission(permissionCode: string): Promise<void>;
50
+ /**
51
+ * Check if user has all permissions to perform an action
52
+ * @param permissionCodes - permission codes to check
53
+ * @returns boolean
54
+ * @throws {PermissionDefinitionNotFound}
55
+ * @throws {PermissionServiceNotInstantiated}
56
+ */
57
+ hasEveryPermission(permissionCodes: string[]): Promise<boolean>;
58
+ /**
59
+ * Throws an error if the user does not have all permissions
60
+ * @param permissionCode
61
+ * @throws {NoPermissionError}
62
+ * @throws {PermissionDefinitionNotFound}
63
+ * @throws {PermissionServiceNotInstantiated}
64
+ */
65
+ validateEveryPermission(permissionCodes: string[]): Promise<void>;
66
+ /**
67
+ * Check if user has at least one permission
68
+ * @param permissionCodes - permission codes to check
69
+ * @returns boolean
70
+ * @throws {PermissionDefinitionNotFound}
71
+ * @throws {PermissionServiceNotInstantiated}
72
+ */
73
+ hasSomePermission(permissionCodes: string[]): Promise<boolean>;
74
+ /**
75
+ * Throws an error if the user does not have at least one of the permissions
76
+ * @param permissionCode
77
+ * @throws {NoPermissionError}
78
+ * @throws {PermissionDefinitionNotFound}
79
+ * @throws {PermissionServiceNotInstantiated}
80
+ */
81
+ validateSomePermission(permissionCodes: string[]): Promise<void>;
82
+ /**
83
+ * @throws {PermissionDefinitionNotFound}
84
+ * @throws {PermissionServiceNotInstantiated}
29
85
  */
30
- hasPermission(_permissionCode: string): boolean;
86
+ private getPermissionDefinition;
31
87
  }
package/dist/JWTUser.js CHANGED
@@ -1,6 +1,31 @@
1
1
  "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
12
+ if (kind === "m") throw new TypeError("Private method is not writable");
13
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
14
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
15
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
16
+ };
17
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
18
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
19
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
20
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
21
+ };
22
+ var _a, _JWTUser_permissionService;
2
23
  Object.defineProperty(exports, "__esModule", { value: true });
3
24
  exports.JWTUser = void 0;
25
+ const BitmaskUtils_1 = require("./BitmaskUtils");
26
+ const PermissionNotFound_1 = require("./errors/PermissionNotFound");
27
+ const PermissionServiceNotInstantiated_1 = require("./errors/PermissionServiceNotInstantiated");
28
+ const NoPermissionError_1 = require("./errors/NoPermissionError");
4
29
  class JWTUser {
5
30
  constructor({ id, employeeReference, organizationReference, roles, permissions, segmentReference, }) {
6
31
  this.id = id;
@@ -10,6 +35,21 @@ class JWTUser {
10
35
  this.permissions = permissions;
11
36
  this.segmentReference = segmentReference;
12
37
  }
38
+ /**
39
+ * Instantiate the permission service for all instances of JWTUser
40
+ */
41
+ static setPermissionService(service) {
42
+ __classPrivateFieldSet(JWTUser, _a, service, "f", _JWTUser_permissionService);
43
+ }
44
+ /**
45
+ * @throws {PermissionServiceNotInstantiated}
46
+ */
47
+ static getPermissionService() {
48
+ if (!__classPrivateFieldGet(JWTUser, _a, "f", _JWTUser_permissionService)) {
49
+ throw new PermissionServiceNotInstantiated_1.PermissionServiceNotInstantiated();
50
+ }
51
+ return __classPrivateFieldGet(JWTUser, _a, "f", _JWTUser_permissionService);
52
+ }
13
53
  static fromPayload(payload) {
14
54
  return new JWTUser({
15
55
  id: payload.sub,
@@ -50,13 +90,128 @@ class JWTUser {
50
90
  }
51
91
  /**
52
92
  * Check if user has permission to perform an action
53
- * @note - not implemented, will be implemented in the next release
54
93
  * @param permissionCode - permission code to check
55
94
  * @returns boolean
95
+ * @throws {PermissionDefinitionNotFound}
96
+ * @throws {PermissionServiceNotInstantiated}
97
+ */
98
+ hasPermission(permissionCode) {
99
+ return __awaiter(this, void 0, void 0, function* () {
100
+ const definition = yield this.getPermissionDefinition(permissionCode);
101
+ const checkBitmask = BitmaskUtils_1.BitmaskUtils.encodeFromPosition(definition.position);
102
+ const permissionsBitmask = BitmaskUtils_1.BitmaskUtils.decodeFromBase64(this.permissions);
103
+ return BitmaskUtils_1.BitmaskUtils.checkBitmask(permissionsBitmask, checkBitmask);
104
+ });
105
+ }
106
+ /**
107
+ * Throws an error if the user does not have the required permission
108
+ * @param permissionCode
109
+ * @throws {NoPermissionError}
110
+ * @throws {PermissionDefinitionNotFound}
111
+ * @throws {PermissionServiceNotInstantiated}
112
+ */
113
+ validatePermission(permissionCode) {
114
+ return __awaiter(this, void 0, void 0, function* () {
115
+ const hasPermission = yield this.hasPermission(permissionCode);
116
+ if (!hasPermission) {
117
+ throw new NoPermissionError_1.NoPermissionError([permissionCode]);
118
+ }
119
+ });
120
+ }
121
+ /**
122
+ * Check if user has all permissions to perform an action
123
+ * @param permissionCodes - permission codes to check
124
+ * @returns boolean
125
+ * @throws {PermissionDefinitionNotFound}
126
+ * @throws {PermissionServiceNotInstantiated}
127
+ */
128
+ hasEveryPermission(permissionCodes) {
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ const permissionsNotMet = [];
131
+ for (const permissionCode of permissionCodes) {
132
+ const hasPermission = yield this.hasPermission(permissionCode);
133
+ if (!hasPermission) {
134
+ permissionsNotMet.push(permissionCode);
135
+ }
136
+ }
137
+ return permissionsNotMet.length === 0;
138
+ });
139
+ }
140
+ /**
141
+ * Throws an error if the user does not have all permissions
142
+ * @param permissionCode
143
+ * @throws {NoPermissionError}
144
+ * @throws {PermissionDefinitionNotFound}
145
+ * @throws {PermissionServiceNotInstantiated}
146
+ */
147
+ validateEveryPermission(permissionCodes) {
148
+ return __awaiter(this, void 0, void 0, function* () {
149
+ const permissionsNotMet = [];
150
+ for (const permissionCode of permissionCodes) {
151
+ const hasPermission = yield this.hasPermission(permissionCode);
152
+ if (!hasPermission) {
153
+ permissionsNotMet.push(permissionCode);
154
+ }
155
+ }
156
+ if (permissionsNotMet.length > 0) {
157
+ throw new NoPermissionError_1.NoPermissionError(permissionsNotMet);
158
+ }
159
+ });
160
+ }
161
+ /**
162
+ * Check if user has at least one permission
163
+ * @param permissionCodes - permission codes to check
164
+ * @returns boolean
165
+ * @throws {PermissionDefinitionNotFound}
166
+ * @throws {PermissionServiceNotInstantiated}
56
167
  */
57
- hasPermission(_permissionCode) {
58
- throw new Error("Not implemented");
168
+ hasSomePermission(permissionCodes) {
169
+ return __awaiter(this, void 0, void 0, function* () {
170
+ for (const permissionCode of permissionCodes) {
171
+ const hasPermission = yield this.hasPermission(permissionCode);
172
+ if (hasPermission) {
173
+ return true;
174
+ }
175
+ }
176
+ return false;
177
+ });
178
+ }
179
+ /**
180
+ * Throws an error if the user does not have at least one of the permissions
181
+ * @param permissionCode
182
+ * @throws {NoPermissionError}
183
+ * @throws {PermissionDefinitionNotFound}
184
+ * @throws {PermissionServiceNotInstantiated}
185
+ */
186
+ validateSomePermission(permissionCodes) {
187
+ return __awaiter(this, void 0, void 0, function* () {
188
+ const hasSomePermission = yield this.hasSomePermission(permissionCodes);
189
+ if (!hasSomePermission) {
190
+ throw new NoPermissionError_1.NoPermissionError(permissionCodes);
191
+ }
192
+ });
193
+ }
194
+ /**
195
+ * @throws {PermissionDefinitionNotFound}
196
+ * @throws {PermissionServiceNotInstantiated}
197
+ */
198
+ getPermissionDefinition(permissionCode) {
199
+ return __awaiter(this, void 0, void 0, function* () {
200
+ const definitions = yield JWTUser.getPermissionService().getPermissions();
201
+ const definition = definitions.find((def) => def.code === permissionCode);
202
+ if (!definition) {
203
+ throw new PermissionNotFound_1.PermissionDefinitionNotFound(permissionCode);
204
+ }
205
+ return definition;
206
+ });
59
207
  }
60
208
  }
61
209
  exports.JWTUser = JWTUser;
210
+ _a = JWTUser;
211
+ /**
212
+ * Static reference to the permission service
213
+ * This is used to make sure that the permission service is only instantiated once
214
+ * and can be used by all instances of JWTUser
215
+ */
216
+ _JWTUser_permissionService = { value: null };
62
217
  //# sourceMappingURL=JWTUser.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"JWTUser.js","sourceRoot":"","sources":["../src/JWTUser.ts"],"names":[],"mappings":";;;AAEA,MAAa,OAAO;IAelB,YAAY,EACV,EAAE,EACF,iBAAiB,EACjB,qBAAqB,EACrB,KAAK,EACL,WAAW,EACX,gBAAgB,GACP;QACT,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,OAAmB;QACpC,OAAO,IAAI,OAAO,CAAC;YACjB,EAAE,EAAE,OAAO,CAAC,GAAG;YACf,iBAAiB,EAAE,OAAO,CAAC,GAAG;YAC9B,qBAAqB,EAAE,OAAO,CAAC,GAAG;YAClC,KAAK,EAAE,OAAO,CAAC,GAAG;YAClB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,gBAAgB,EAAE,OAAO,CAAC,GAAG,IAAI,IAAI;SACtC,CAAC,CAAC;IACL,CAAC;IAEM,cAAc;QACnB,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,EAAE;YACZ,GAAG,EAAE,IAAI,CAAC,iBAAiB;YAC3B,GAAG,EAAE,IAAI,CAAC,qBAAqB;YAC/B,GAAG,EAAE,IAAI,CAAC,KAAK;YACf,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,GAAG,EAAE,IAAI,CAAC,gBAAgB;SAC3B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,IAAY;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,aAAgC;QAC9C,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACrC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SACpC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,eAAuB;QAC1C,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF;AAlFD,0BAkFC"}
1
+ {"version":3,"file":"JWTUser.js","sourceRoot":"","sources":["../src/JWTUser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAA8C;AAE9C,oEAA2E;AAC3E,gGAA6F;AAE7F,kEAA+D;AAE/D,MAAa,OAAO;IAuClB,YAAY,EACV,EAAE,EACF,iBAAiB,EACjB,qBAAqB,EACrB,KAAK,EACL,WAAW,EACX,gBAAgB,GACP;QACT,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;IA/BD;;OAEG;IACH,MAAM,CAAC,oBAAoB,CAAC,OAA2B;QACrD,uBAAA,OAAO,MAAsB,OAAO,kCAAA,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oBAAoB;QACzB,IAAI,CAAC,uBAAA,OAAO,sCAAmB,EAAE;YAC/B,MAAM,IAAI,mEAAgC,EAAE,CAAC;SAC9C;QACD,OAAO,uBAAA,OAAO,sCAAmB,CAAC;IACpC,CAAC;IAkBD,MAAM,CAAC,WAAW,CAAC,OAAmB;QACpC,OAAO,IAAI,OAAO,CAAC;YACjB,EAAE,EAAE,OAAO,CAAC,GAAG;YACf,iBAAiB,EAAE,OAAO,CAAC,GAAG;YAC9B,qBAAqB,EAAE,OAAO,CAAC,GAAG;YAClC,KAAK,EAAE,OAAO,CAAC,GAAG;YAClB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,gBAAgB,EAAE,OAAO,CAAC,GAAG,IAAI,IAAI;SACtC,CAAC,CAAC;IACL,CAAC;IAEM,cAAc;QACnB,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,EAAE;YACZ,GAAG,EAAE,IAAI,CAAC,iBAAiB;YAC3B,GAAG,EAAE,IAAI,CAAC,qBAAqB;YAC/B,GAAG,EAAE,IAAI,CAAC,KAAK;YACf,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,GAAG,EAAE,IAAI,CAAC,gBAAgB;SAC3B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,IAAY;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,aAAgC;QAC9C,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACrC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SACpC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACU,aAAa,CAAC,cAAsB;;YAC/C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;YACtE,MAAM,YAAY,GAAG,2BAAY,CAAC,kBAAkB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1E,MAAM,kBAAkB,GAAG,2BAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC3E,OAAO,2BAAY,CAAC,YAAY,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;QACrE,CAAC;KAAA;IAED;;;;;;OAMG;IACU,kBAAkB,CAAC,cAAsB;;YACpD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC/D,IAAI,CAAC,aAAa,EAAE;gBAClB,MAAM,IAAI,qCAAiB,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;aAC/C;QACH,CAAC;KAAA;IAED;;;;;;OAMG;IACU,kBAAkB,CAAC,eAAyB;;YACvD,MAAM,iBAAiB,GAAa,EAAE,CAAC;YACvC,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;gBAC5C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;gBAC/D,IAAI,CAAC,aAAa,EAAE;oBAClB,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;iBACxC;aACF;YACD,OAAO,iBAAiB,CAAC,MAAM,KAAK,CAAC,CAAC;QACxC,CAAC;KAAA;IAED;;;;;;OAMG;IACU,uBAAuB,CAClC,eAAyB;;YAEzB,MAAM,iBAAiB,GAAa,EAAE,CAAC;YACvC,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;gBAC5C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;gBAC/D,IAAI,CAAC,aAAa,EAAE;oBAClB,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;iBACxC;aACF;YACD,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;gBAChC,MAAM,IAAI,qCAAiB,CAAC,iBAAiB,CAAC,CAAC;aAChD;QACH,CAAC;KAAA;IAED;;;;;;OAMG;IACU,iBAAiB,CAAC,eAAyB;;YACtD,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;gBAC5C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;gBAC/D,IAAI,aAAa,EAAE;oBACjB,OAAO,IAAI,CAAC;iBACb;aACF;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KAAA;IAED;;;;;;OAMG;IACU,sBAAsB,CACjC,eAAyB;;YAEzB,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YACxE,IAAI,CAAC,iBAAiB,EAAE;gBACtB,MAAM,IAAI,qCAAiB,CAAC,eAAe,CAAC,CAAC;aAC9C;QACH,CAAC;KAAA;IAED;;;OAGG;IACW,uBAAuB,CACnC,cAAsB;;YAEtB,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,oBAAoB,EAAE,CAAC,cAAc,EAAE,CAAC;YAC1E,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;YAC1E,IAAI,CAAC,UAAU,EAAE;gBACf,MAAM,IAAI,iDAA4B,CAAC,cAAc,CAAC,CAAC;aACxD;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;KAAA;;AAnNH,0BAoNC;;AArMC;;;;GAIG;AACH,sCAAuD,IAAI,EAAC,CAAA"}
@@ -0,0 +1,26 @@
1
+ import { ILogger } from "@alanszp/logger";
2
+ import { Permission } from "./types";
3
+ import { PermissionsResolutionFunction } from "./axiosPermissionsResolutionFactory";
4
+ export interface IPermissionService {
5
+ getPermissions(): Promise<Permission[]>;
6
+ }
7
+ export declare class PermissionService implements IPermissionService {
8
+ #private;
9
+ private readonly logger;
10
+ constructor(logger: ILogger, permissionsResolutionFn: PermissionsResolutionFunction);
11
+ /**
12
+ * Retrieve all pages from a paginated {@link ListResult} request
13
+ * @todo this could be generalized, but tricky to do so because of the binding of the fetcher function
14
+ */
15
+ private getAllPagesFromPaginatedRequest;
16
+ hasCachedPermissions(): boolean;
17
+ /**
18
+ * Retrieve the permissions definitions
19
+ * @returns {Promise<Permission[]>}
20
+ */
21
+ getPermissions(checkCache?: boolean): Promise<Permission[]>;
22
+ isPermissionsCacheReady(): Promise<boolean>;
23
+ reloadPermissionCache(): Promise<void>;
24
+ startPermissionObserver(permissionRefetchInMs?: number): void;
25
+ stopPermissionObserver(): void;
26
+ }
@@ -0,0 +1,108 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
12
+ if (kind === "m") throw new TypeError("Private method is not writable");
13
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
14
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
15
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
16
+ };
17
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
18
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
19
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
20
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
21
+ };
22
+ var _PermissionService_permissionsResolutionFn, _PermissionService_cachedPermissions, _PermissionService_observerInterval, _PermissionService_permissionsPreheatedSuccessfully;
23
+ Object.defineProperty(exports, "__esModule", { value: true });
24
+ exports.PermissionService = void 0;
25
+ const DEFAULT_PERMISSIONS_REFETCH_TIMEOUT = 1000 * 60 * 60; // 1hs
26
+ class PermissionService {
27
+ constructor(logger, permissionsResolutionFn) {
28
+ _PermissionService_permissionsResolutionFn.set(this, void 0);
29
+ _PermissionService_cachedPermissions.set(this, void 0);
30
+ _PermissionService_observerInterval.set(this, void 0);
31
+ _PermissionService_permissionsPreheatedSuccessfully.set(this, void 0);
32
+ this.logger = logger;
33
+ __classPrivateFieldSet(this, _PermissionService_permissionsResolutionFn, permissionsResolutionFn, "f");
34
+ __classPrivateFieldSet(this, _PermissionService_cachedPermissions, null, "f");
35
+ __classPrivateFieldSet(this, _PermissionService_observerInterval, null, "f");
36
+ __classPrivateFieldSet(this, _PermissionService_permissionsPreheatedSuccessfully, Promise.resolve(), "f");
37
+ }
38
+ /**
39
+ * Retrieve all pages from a paginated {@link ListResult} request
40
+ * @todo this could be generalized, but tricky to do so because of the binding of the fetcher function
41
+ */
42
+ getAllPagesFromPaginatedRequest(fetcher, pageSize = 500) {
43
+ return __awaiter(this, void 0, void 0, function* () {
44
+ const fetcherBound = fetcher.bind(this);
45
+ const acc = [];
46
+ const firstPage = yield fetcherBound(1, pageSize);
47
+ acc.push(...firstPage.elements);
48
+ if (firstPage.total > firstPage.pageSize) {
49
+ const pages = Math.ceil(firstPage.total / firstPage.pageSize);
50
+ for (let i = 2; i <= pages; i++) {
51
+ const page = yield fetcherBound(i, pageSize);
52
+ acc.push(...page.elements);
53
+ }
54
+ }
55
+ return acc;
56
+ });
57
+ }
58
+ hasCachedPermissions() {
59
+ return __classPrivateFieldGet(this, _PermissionService_cachedPermissions, "f") !== null;
60
+ }
61
+ /**
62
+ * Retrieve the permissions definitions
63
+ * @returns {Promise<Permission[]>}
64
+ */
65
+ getPermissions(checkCache = true) {
66
+ return __awaiter(this, void 0, void 0, function* () {
67
+ if (checkCache) {
68
+ if (__classPrivateFieldGet(this, _PermissionService_cachedPermissions, "f")) {
69
+ this.logger.debug("auth.permission_service.get_permissions.cache_hit");
70
+ return __classPrivateFieldGet(this, _PermissionService_cachedPermissions, "f");
71
+ }
72
+ this.logger.debug("auth.permission_service.get_permissions.cache_miss");
73
+ }
74
+ const permissions = yield this.getAllPagesFromPaginatedRequest(__classPrivateFieldGet(this, _PermissionService_permissionsResolutionFn, "f"));
75
+ __classPrivateFieldSet(this, _PermissionService_cachedPermissions, permissions, "f");
76
+ return permissions;
77
+ });
78
+ }
79
+ isPermissionsCacheReady() {
80
+ return __awaiter(this, void 0, void 0, function* () {
81
+ yield __classPrivateFieldGet(this, _PermissionService_permissionsPreheatedSuccessfully, "f");
82
+ return __classPrivateFieldGet(this, _PermissionService_cachedPermissions, "f") !== null;
83
+ });
84
+ }
85
+ reloadPermissionCache() {
86
+ __classPrivateFieldSet(this, _PermissionService_permissionsPreheatedSuccessfully, this.getPermissions(false)
87
+ .then(() => {
88
+ this.logger.debug("auth.permission_service.reload_permission_cache.success");
89
+ })
90
+ .catch((error) => {
91
+ this.logger.error("auth.permission_service.reload_permission_cache.error", { error });
92
+ return;
93
+ }), "f");
94
+ return __classPrivateFieldGet(this, _PermissionService_permissionsPreheatedSuccessfully, "f");
95
+ }
96
+ startPermissionObserver(permissionRefetchInMs = DEFAULT_PERMISSIONS_REFETCH_TIMEOUT) {
97
+ __classPrivateFieldSet(this, _PermissionService_observerInterval, setInterval(() => this.reloadPermissionCache(), permissionRefetchInMs), "f");
98
+ }
99
+ stopPermissionObserver() {
100
+ if (__classPrivateFieldGet(this, _PermissionService_observerInterval, "f")) {
101
+ clearInterval(__classPrivateFieldGet(this, _PermissionService_observerInterval, "f"));
102
+ __classPrivateFieldSet(this, _PermissionService_observerInterval, null, "f");
103
+ }
104
+ }
105
+ }
106
+ exports.PermissionService = PermissionService;
107
+ _PermissionService_permissionsResolutionFn = new WeakMap(), _PermissionService_cachedPermissions = new WeakMap(), _PermissionService_observerInterval = new WeakMap(), _PermissionService_permissionsPreheatedSuccessfully = new WeakMap();
108
+ //# sourceMappingURL=PermissionService.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PermissionService.js","sourceRoot":"","sources":["../src/PermissionService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AASA,MAAM,mCAAmC,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM;AAElE,MAAa,iBAAiB;IAW5B,YACE,MAAe,EACf,uBAAsD;QAZxD,6DAAiE;QAEjE,uDAAwC;QAExC,sDAAyC;QAEzC,sEAAiD;QAQ/C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,uBAAA,IAAI,8CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,wCAAsB,IAAI,MAAA,CAAC;QAC/B,uBAAA,IAAI,uCAAqB,IAAI,MAAA,CAAC;QAC9B,uBAAA,IAAI,uDAAqC,OAAO,CAAC,OAAO,EAAE,MAAA,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACW,+BAA+B,CAC3C,OAAmE,EACnE,WAAmB,GAAG;;YAEtB,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,MAAM,GAAG,GAAQ,EAAE,CAAC;YACpB,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAClD,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YAChC,IAAI,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE;gBACxC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,EAAE,EAAE;oBAC/B,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;oBAC7C,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;iBAC5B;aACF;YAED,OAAO,GAAG,CAAC;QACb,CAAC;KAAA;IAEM,oBAAoB;QACzB,OAAO,uBAAA,IAAI,4CAAmB,KAAK,IAAI,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACU,cAAc,CAAC,UAAU,GAAG,IAAI;;YAC3C,IAAI,UAAU,EAAE;gBACd,IAAI,uBAAA,IAAI,4CAAmB,EAAE;oBAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;oBACvE,OAAO,uBAAA,IAAI,4CAAmB,CAAC;iBAChC;gBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACzE;YAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,+BAA+B,CAC5D,uBAAA,IAAI,kDAAyB,CAC9B,CAAC;YAEF,uBAAA,IAAI,wCAAsB,WAAW,MAAA,CAAC;YAEtC,OAAO,WAAW,CAAC;QACrB,CAAC;KAAA;IAEY,uBAAuB;;YAClC,MAAM,uBAAA,IAAI,2DAAkC,CAAC;YAC7C,OAAO,uBAAA,IAAI,4CAAmB,KAAK,IAAI,CAAC;QAC1C,CAAC;KAAA;IAEM,qBAAqB;QAC1B,uBAAA,IAAI,uDAAqC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;aAChE,IAAI,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,yDAAyD,CAC1D,CAAC;QACJ,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,uDAAuD,EACvD,EAAE,KAAK,EAAE,CACV,CAAC;YACF,OAAO;QACT,CAAC,CAAC,MAAA,CAAC;QAEL,OAAO,uBAAA,IAAI,2DAAkC,CAAC;IAChD,CAAC;IAEM,uBAAuB,CAC5B,wBAAgC,mCAAmC;QAEnE,uBAAA,IAAI,uCAAqB,WAAW,CAClC,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAClC,qBAAqB,CACtB,MAAA,CAAC;IACJ,CAAC;IAEM,sBAAsB;QAC3B,IAAI,uBAAA,IAAI,2CAAkB,EAAE;YAC1B,aAAa,CAAC,uBAAA,IAAI,2CAAkB,CAAC,CAAC;YACtC,uBAAA,IAAI,uCAAqB,IAAI,MAAA,CAAC;SAC/B;IACH,CAAC;CACF;AA7GD,8CA6GC"}
@@ -0,0 +1,4 @@
1
+ import { Permission } from "./types";
2
+ import { ListResult } from "@alanszp/core";
3
+ export declare type PermissionsResolutionFunction = (page: number, pageSize: number) => Promise<ListResult<Permission>>;
4
+ export declare function axiosPermissionsResolutionFactory(baseUrl: string, accessToken: string): () => PermissionsResolutionFunction;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.axiosPermissionsResolutionFactory = void 0;
13
+ const axios_node_1 = require("@alanszp/axios-node");
14
+ const PermissionServiceRequestError_1 = require("./errors/PermissionServiceRequestError");
15
+ function makeRequest(axios, baseURL, accessToken, method, url, params, retries = 5) {
16
+ return __awaiter(this, void 0, void 0, function* () {
17
+ try {
18
+ const request = yield axios.request({
19
+ baseURL,
20
+ url,
21
+ method,
22
+ params,
23
+ headers: {
24
+ authorization: `Bearer ${accessToken}`,
25
+ },
26
+ });
27
+ return request.data;
28
+ }
29
+ catch (error) {
30
+ if (retries > 0) {
31
+ this.logger.debug("auth.permission_service.make_request.retry", {
32
+ retriesLeft: retries,
33
+ });
34
+ const response = yield makeRequest(axios, baseURL, accessToken, method, url, params, retries - 1);
35
+ return response;
36
+ }
37
+ throw new PermissionServiceRequestError_1.PermissionServiceRequestError(error);
38
+ }
39
+ });
40
+ }
41
+ function axiosPermissionsResolutionFactory(baseUrl, accessToken) {
42
+ const axios = (0, axios_node_1.createAxios)();
43
+ return function axiosPermissionsResolution() {
44
+ return function getPermissionsPageFromApi(page = 1, pageSize = 500) {
45
+ return __awaiter(this, void 0, void 0, function* () {
46
+ return makeRequest(axios, baseUrl, accessToken, "GET", "/lara/v1/permissions", { page, pageSize });
47
+ });
48
+ };
49
+ };
50
+ }
51
+ exports.axiosPermissionsResolutionFactory = axiosPermissionsResolutionFactory;
52
+ //# sourceMappingURL=axiosPermissionsResolutionFactory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"axiosPermissionsResolutionFactory.js","sourceRoot":"","sources":["../src/axiosPermissionsResolutionFactory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oDAAkD;AAElD,0FAAuF;AAQvF,SAAe,WAAW,CACxB,KAAqC,EACrC,OAAe,EACf,WAAmB,EACnB,MAAa,EACb,GAAW,EACX,MAAgC,EAChC,UAAkB,CAAC;;QAEnB,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,OAAO,CAAI;gBACrC,OAAO;gBACP,GAAG;gBACH,MAAM;gBACN,MAAM;gBACN,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,WAAW,EAAE;iBACvC;aACF,CAAC,CAAC;YAEH,OAAO,OAAO,CAAC,IAAI,CAAC;SACrB;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,OAAO,GAAG,CAAC,EAAE;gBACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE;oBAC9D,WAAW,EAAE,OAAO;iBACrB,CAAC,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAChC,KAAK,EACL,OAAO,EACP,WAAW,EACX,MAAM,EACN,GAAG,EACH,MAAM,EACN,OAAO,GAAG,CAAC,CACZ,CAAC;gBACF,OAAO,QAAQ,CAAC;aACjB;YACD,MAAM,IAAI,6DAA6B,CAAC,KAAK,CAAC,CAAC;SAChD;IACH,CAAC;CAAA;AAED,SAAgB,iCAAiC,CAC/C,OAAe,EACf,WAAmB;IAEnB,MAAM,KAAK,GAAG,IAAA,wBAAW,GAAE,CAAC;IAC5B,OAAO,SAAS,0BAA0B;QACxC,OAAO,SAAe,yBAAyB,CAC7C,OAAe,CAAC,EAChB,QAAQ,GAAG,GAAG;;gBAEd,OAAO,WAAW,CAChB,KAAK,EACL,OAAO,EACP,WAAW,EACX,KAAK,EACL,sBAAsB,EACtB,EAAE,IAAI,EAAE,QAAQ,EAAE,CACnB,CAAC;YACJ,CAAC;SAAA,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AApBD,8EAoBC"}
@@ -0,0 +1,7 @@
1
+ import { HttpRenderableError, RenderableContext } from "@alanszp/errors";
2
+ export declare class NoPermissionError extends HttpRenderableError {
3
+ permissionsNotMet: string[];
4
+ constructor(permissionsNotMet: string[]);
5
+ httpCode(): number;
6
+ context(): RenderableContext;
7
+ }
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NoPermissionError = void 0;
4
+ const errors_1 = require("@alanszp/errors");
5
+ class NoPermissionError extends errors_1.HttpRenderableError {
6
+ constructor(permissionsNotMet) {
7
+ super("No permission error");
8
+ this.permissionsNotMet = permissionsNotMet;
9
+ }
10
+ httpCode() {
11
+ return 403;
12
+ }
13
+ context() {
14
+ return {
15
+ permissionsNotMet: this.permissionsNotMet,
16
+ };
17
+ }
18
+ }
19
+ exports.NoPermissionError = NoPermissionError;
20
+ //# sourceMappingURL=NoPermissionError.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NoPermissionError.js","sourceRoot":"","sources":["../../src/errors/NoPermissionError.ts"],"names":[],"mappings":";;;AAAA,4CAAyE;AAEzE,MAAa,iBAAkB,SAAQ,4BAAmB;IAGxD,YAAY,iBAA2B;QACrC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO;QACL,OAAO;YACL,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;SAC1C,CAAC;IACJ,CAAC;CACF;AAjBD,8CAiBC"}
@@ -0,0 +1,9 @@
1
+ import { RenderableContext } from "@alanszp/errors";
2
+ import { PermissionServiceError } from "./PermissionServiceError";
3
+ export declare class PermissionDefinitionNotFound extends PermissionServiceError {
4
+ permissionCode: string;
5
+ constructor(permissionCode: string);
6
+ renderMessage(): string;
7
+ httpCode(): number;
8
+ context(): RenderableContext;
9
+ }
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PermissionDefinitionNotFound = void 0;
4
+ const PermissionServiceError_1 = require("./PermissionServiceError");
5
+ class PermissionDefinitionNotFound extends PermissionServiceError_1.PermissionServiceError {
6
+ constructor(permissionCode) {
7
+ super("Permission not found");
8
+ this.permissionCode = permissionCode;
9
+ }
10
+ renderMessage() {
11
+ return "Permission code not found in the permission definitions";
12
+ }
13
+ httpCode() {
14
+ // 500 Internal Server Error because this indicates a configuration problem.
15
+ return 500;
16
+ }
17
+ context() {
18
+ return {
19
+ permissionCode: this.permissionCode,
20
+ };
21
+ }
22
+ }
23
+ exports.PermissionDefinitionNotFound = PermissionDefinitionNotFound;
24
+ //# sourceMappingURL=PermissionNotFound.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PermissionNotFound.js","sourceRoot":"","sources":["../../src/errors/PermissionNotFound.ts"],"names":[],"mappings":";;;AACA,qEAAkE;AAElE,MAAa,4BAA6B,SAAQ,+CAAsB;IAGtE,YAAY,cAAsB;QAChC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAED,aAAa;QACX,OAAO,yDAAyD,CAAC;IACnE,CAAC;IAED,QAAQ;QACN,4EAA4E;QAC5E,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO;QACL,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC;IACJ,CAAC;CACF;AAtBD,oEAsBC"}
@@ -0,0 +1,3 @@
1
+ import { HttpRenderableError } from "@alanszp/errors";
2
+ export declare abstract class PermissionServiceError extends HttpRenderableError {
3
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PermissionServiceError = void 0;
4
+ const errors_1 = require("@alanszp/errors");
5
+ class PermissionServiceError extends errors_1.HttpRenderableError {
6
+ }
7
+ exports.PermissionServiceError = PermissionServiceError;
8
+ //# sourceMappingURL=PermissionServiceError.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PermissionServiceError.js","sourceRoot":"","sources":["../../src/errors/PermissionServiceError.ts"],"names":[],"mappings":";;;AAAA,4CAAsD;AAEtD,MAAsB,sBAAuB,SAAQ,4BAAmB;CAAG;AAA3E,wDAA2E"}
@@ -0,0 +1,7 @@
1
+ import { RenderableContext } from "@alanszp/errors";
2
+ import { PermissionServiceError } from "./PermissionServiceError";
3
+ export declare class PermissionServiceNotInstantiated extends PermissionServiceError {
4
+ constructor();
5
+ httpCode(): number;
6
+ context(): RenderableContext;
7
+ }
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PermissionServiceNotInstantiated = void 0;
4
+ const PermissionServiceError_1 = require("./PermissionServiceError");
5
+ class PermissionServiceNotInstantiated extends PermissionServiceError_1.PermissionServiceError {
6
+ constructor() {
7
+ super("Permission service not instantiated");
8
+ }
9
+ httpCode() {
10
+ return 500;
11
+ }
12
+ context() {
13
+ return {};
14
+ }
15
+ }
16
+ exports.PermissionServiceNotInstantiated = PermissionServiceNotInstantiated;
17
+ //# sourceMappingURL=PermissionServiceNotInstantiated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PermissionServiceNotInstantiated.js","sourceRoot":"","sources":["../../src/errors/PermissionServiceNotInstantiated.ts"],"names":[],"mappings":";;;AACA,qEAAkE;AAElE,MAAa,gCAAiC,SAAQ,+CAAsB;IAC1E;QACE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IAC/C,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO;QACL,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAZD,4EAYC"}
@@ -0,0 +1,9 @@
1
+ import { RenderableContext } from "@alanszp/errors";
2
+ import { PermissionServiceError } from "./PermissionServiceError";
3
+ export declare class PermissionServiceRequestError extends PermissionServiceError {
4
+ error: unknown;
5
+ constructor(error: unknown);
6
+ renderMessage(): string;
7
+ httpCode(): number;
8
+ context(): RenderableContext;
9
+ }
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PermissionServiceRequestError = void 0;
4
+ const PermissionServiceError_1 = require("./PermissionServiceError");
5
+ class PermissionServiceRequestError extends PermissionServiceError_1.PermissionServiceError {
6
+ constructor(error) {
7
+ super("Permission service request error");
8
+ this.error = error;
9
+ }
10
+ renderMessage() {
11
+ return "Permission service request failed. Could not validate permission integrity";
12
+ }
13
+ httpCode() {
14
+ return 500;
15
+ }
16
+ context() {
17
+ return {
18
+ error: this.error,
19
+ };
20
+ }
21
+ }
22
+ exports.PermissionServiceRequestError = PermissionServiceRequestError;
23
+ //# sourceMappingURL=PermissionServiceRequestError.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PermissionServiceRequestError.js","sourceRoot":"","sources":["../../src/errors/PermissionServiceRequestError.ts"],"names":[],"mappings":";;;AACA,qEAAkE;AAElE,MAAa,6BAA8B,SAAQ,+CAAsB;IAGvE,YAAY,KAAc;QACxB,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,aAAa;QACX,OAAO,4EAA4E,CAAC;IACtF,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO;QACL,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;CACF;AArBD,sEAqBC"}
package/dist/index.d.ts CHANGED
@@ -1,3 +1,10 @@
1
1
  export * from "./types";
2
2
  export * from "./JWTUser";
3
3
  export * from "./jwt";
4
+ export * from "./PermissionService";
5
+ export * from "./BitmaskUtils";
6
+ export * from "./errors/NoPermissionError";
7
+ export * from "./errors/PermissionNotFound";
8
+ export * from "./errors/PermissionServiceNotInstantiated";
9
+ export * from "./errors/PermissionServiceRequestError";
10
+ export * from "./axiosPermissionsResolutionFactory";
package/dist/index.js CHANGED
@@ -13,4 +13,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
13
13
  __exportStar(require("./types"), exports);
14
14
  __exportStar(require("./JWTUser"), exports);
15
15
  __exportStar(require("./jwt"), exports);
16
+ __exportStar(require("./PermissionService"), exports);
17
+ __exportStar(require("./BitmaskUtils"), exports);
18
+ __exportStar(require("./errors/NoPermissionError"), exports);
19
+ __exportStar(require("./errors/PermissionNotFound"), exports);
20
+ __exportStar(require("./errors/PermissionServiceNotInstantiated"), exports);
21
+ __exportStar(require("./errors/PermissionServiceRequestError"), exports);
22
+ __exportStar(require("./axiosPermissionsResolutionFactory"), exports);
16
23
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B;AAC1B,wCAAsB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B;AAC1B,wCAAsB;AACtB,sDAAoC;AACpC,iDAA+B;AAC/B,6DAA2C;AAC3C,8DAA4C;AAC5C,4EAA0D;AAC1D,yEAAuD;AACvD,sEAAoD"}
package/dist/types.d.ts CHANGED
@@ -24,3 +24,10 @@ export interface VerifyOptions {
24
24
  issuer: string | string[];
25
25
  audience: string | string[];
26
26
  }
27
+ export interface Permission {
28
+ code: string;
29
+ description: string;
30
+ position: number;
31
+ priority: number | null;
32
+ organizationReference: string;
33
+ }
package/jest.config.js ADDED
@@ -0,0 +1,10 @@
1
+ module.exports = {
2
+ collectCoverageFrom: ["src/**/*.{js,jsx,ts,tsx}"],
3
+ roots: ["<rootDir>/src/"],
4
+ clearMocks: true,
5
+ resetMocks: true,
6
+ testEnvironment: "node",
7
+ moduleNameMapper: {
8
+ "@/(.*)": "<rootDir>/src/$1",
9
+ },
10
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alanszp/jwt",
3
- "version": "12.0.3",
3
+ "version": "14.0.0",
4
4
  "description": "Alan's jwt validator & signer.",
5
5
  "main": "dist/index.js",
6
6
  "typings": "dist/index.d.ts",
@@ -11,17 +11,28 @@
11
11
  "scripts": {
12
12
  "compile": "rm -rf ./dist && tsc --declaration",
13
13
  "compile-watch": "tsc -w",
14
+ "test": "TZ=Etc/UTC jest",
14
15
  "build": "yarn run compile",
15
16
  "prepack": "yarn run build",
16
17
  "yalc-publish": "yarn run yalc publish"
17
18
  },
18
19
  "devDependencies": {
20
+ "@babel/core": "^7.24.0",
21
+ "@babel/preset-env": "^7.24.0",
22
+ "@babel/preset-typescript": "^7.23.3",
23
+ "@types/jest": "^29.5.12",
19
24
  "@types/node": "^20.11.17",
25
+ "babel-jest": "^29.7.0",
26
+ "jest": "^29.7.0",
20
27
  "ts-node": "^10.0.0",
21
28
  "typescript": "^4.3.4"
22
29
  },
23
30
  "dependencies": {
31
+ "@alanszp/axios-node": "^14.0.0",
32
+ "@alanszp/core": "^14.0.0",
33
+ "@alanszp/errors": "^14.0.0",
34
+ "@alanszp/logger": "^14.0.0",
24
35
  "jose": "^5.2.2"
25
36
  },
26
- "gitHead": "3917709ea888ae321c2ea6ab36dfc90597ccd35e"
37
+ "gitHead": "da5adb213c30d9509ccdc0c182d6c7a130a38612"
27
38
  }
package/tsconfig.json CHANGED
@@ -4,12 +4,15 @@
4
4
  "outDir": "dist",
5
5
  "module": "commonjs",
6
6
  "target": "es6",
7
- "types": ["node"],
7
+ "types": ["jest", "node"],
8
8
  "esModuleInterop": true,
9
9
  "sourceMap": true,
10
10
 
11
11
  "alwaysStrict": true,
12
12
  "strictNullChecks": true
13
13
  },
14
- "exclude": ["node_modules"]
14
+ "exclude": ["node_modules"],
15
+ "paths": {
16
+ "@/*": ["src/*"]
17
+ }
15
18
  }