@frontegg/react-hooks 6.144.0-alpha.3 → 6.145.0-alpha.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/auth/entitlements.d.ts +15 -0
- package/auth/entitlements.js +34 -0
- package/index.js +1 -1
- package/node/auth/entitlements.js +38 -2
- package/node/index.js +1 -1
- package/package.json +3 -3
package/auth/entitlements.d.ts
CHANGED
|
@@ -14,3 +14,18 @@ export declare const usePermissionEntitlements: (key: string) => Entitlement;
|
|
|
14
14
|
@returns if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
|
|
15
15
|
*/
|
|
16
16
|
export declare const useEntitlements: (options: EntitledToOptions) => Entitlement;
|
|
17
|
+
/**
|
|
18
|
+
@param entitledToOptions including permission or feature key
|
|
19
|
+
@returns an action your can use to detect if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
|
|
20
|
+
*/
|
|
21
|
+
export declare const useEntitlementsActions: () => {
|
|
22
|
+
isEntitledTo: (options: EntitledToOptions) => Entitlement;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
@returns if the option to use entitlements is enabled
|
|
26
|
+
*/
|
|
27
|
+
export declare const useEntitlementsOptions: () => {
|
|
28
|
+
isEntitlementsEnabled: boolean;
|
|
29
|
+
isEntitledTo: (options: EntitledToOptions) => Entitlement;
|
|
30
|
+
verifyIsEntitledFF: boolean;
|
|
31
|
+
};
|
package/auth/entitlements.js
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { getPermissionEntitlements, getFeatureEntitlements, getEntitlements } from '@frontegg/redux-store';
|
|
2
2
|
import { useAuth } from './hooks';
|
|
3
|
+
import { useMemo } from 'react';
|
|
4
|
+
import { useShadowDom } from '../common';
|
|
5
|
+
import { useFeatureFlags } from '../flags';
|
|
3
6
|
|
|
4
7
|
/**
|
|
5
8
|
* @returns entitlemenets state as stored in the user
|
|
@@ -33,4 +36,35 @@ export const usePermissionEntitlements = key => {
|
|
|
33
36
|
export const useEntitlements = options => {
|
|
34
37
|
const entitlements = useEntitlementsState();
|
|
35
38
|
return getEntitlements(entitlements, options);
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
@param entitledToOptions including permission or feature key
|
|
43
|
+
@returns an action your can use to detect if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
|
|
44
|
+
*/
|
|
45
|
+
export const useEntitlementsActions = () => {
|
|
46
|
+
const entitlements = useEntitlementsState();
|
|
47
|
+
return useMemo(() => ({
|
|
48
|
+
isEntitledTo: options => getEntitlements(entitlements, options)
|
|
49
|
+
}), [entitlements]);
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
@returns if the option to use entitlements is enabled
|
|
54
|
+
*/
|
|
55
|
+
export const useEntitlementsOptions = () => {
|
|
56
|
+
var _entitlementsOptions$;
|
|
57
|
+
const {
|
|
58
|
+
entitlementsOptions
|
|
59
|
+
} = useShadowDom();
|
|
60
|
+
const isEntitlementsEnabled = (_entitlementsOptions$ = entitlementsOptions == null ? void 0 : entitlementsOptions.enabled) != null ? _entitlementsOptions$ : false;
|
|
61
|
+
const {
|
|
62
|
+
isEntitledTo
|
|
63
|
+
} = useEntitlementsActions();
|
|
64
|
+
const [verifyIsEntitledFF] = useFeatureFlags(['admin-portal-use-is-entitled']);
|
|
65
|
+
return {
|
|
66
|
+
isEntitlementsEnabled,
|
|
67
|
+
isEntitledTo,
|
|
68
|
+
verifyIsEntitledFF
|
|
69
|
+
};
|
|
36
70
|
};
|
package/index.js
CHANGED
|
@@ -3,9 +3,12 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.usePermissionEntitlements = exports.useFeatureEntitlements = exports.useEntitlements = void 0;
|
|
6
|
+
exports.usePermissionEntitlements = exports.useFeatureEntitlements = exports.useEntitlementsOptions = exports.useEntitlementsActions = exports.useEntitlements = void 0;
|
|
7
7
|
var _reduxStore = require("@frontegg/redux-store");
|
|
8
8
|
var _hooks = require("./hooks");
|
|
9
|
+
var _react = require("react");
|
|
10
|
+
var _common = require("../common");
|
|
11
|
+
var _flags = require("../flags");
|
|
9
12
|
/**
|
|
10
13
|
* @returns entitlemenets state as stored in the user
|
|
11
14
|
*/
|
|
@@ -41,4 +44,37 @@ const useEntitlements = options => {
|
|
|
41
44
|
const entitlements = useEntitlementsState();
|
|
42
45
|
return (0, _reduxStore.getEntitlements)(entitlements, options);
|
|
43
46
|
};
|
|
44
|
-
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
@param entitledToOptions including permission or feature key
|
|
50
|
+
@returns an action your can use to detect if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
|
|
51
|
+
*/
|
|
52
|
+
exports.useEntitlements = useEntitlements;
|
|
53
|
+
const useEntitlementsActions = () => {
|
|
54
|
+
const entitlements = useEntitlementsState();
|
|
55
|
+
return (0, _react.useMemo)(() => ({
|
|
56
|
+
isEntitledTo: options => (0, _reduxStore.getEntitlements)(entitlements, options)
|
|
57
|
+
}), [entitlements]);
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
@returns if the option to use entitlements is enabled
|
|
62
|
+
*/
|
|
63
|
+
exports.useEntitlementsActions = useEntitlementsActions;
|
|
64
|
+
const useEntitlementsOptions = () => {
|
|
65
|
+
var _entitlementsOptions$;
|
|
66
|
+
const {
|
|
67
|
+
entitlementsOptions
|
|
68
|
+
} = (0, _common.useShadowDom)();
|
|
69
|
+
const isEntitlementsEnabled = (_entitlementsOptions$ = entitlementsOptions == null ? void 0 : entitlementsOptions.enabled) != null ? _entitlementsOptions$ : false;
|
|
70
|
+
const {
|
|
71
|
+
isEntitledTo
|
|
72
|
+
} = useEntitlementsActions();
|
|
73
|
+
const [verifyIsEntitledFF] = (0, _flags.useFeatureFlags)(['admin-portal-use-is-entitled']);
|
|
74
|
+
return {
|
|
75
|
+
isEntitlementsEnabled,
|
|
76
|
+
isEntitledTo,
|
|
77
|
+
verifyIsEntitledFF
|
|
78
|
+
};
|
|
79
|
+
};
|
|
80
|
+
exports.useEntitlementsOptions = useEntitlementsOptions;
|
package/node/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@frontegg/react-hooks",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.145.0-alpha.0",
|
|
4
4
|
"main": "./node/index.js",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Frontegg LTD",
|
|
7
7
|
"dependencies": {
|
|
8
8
|
"@babel/runtime": "^7.18.6",
|
|
9
|
-
"@frontegg/redux-store": "6.
|
|
10
|
-
"@frontegg/types": "6.
|
|
9
|
+
"@frontegg/redux-store": "6.145.0-alpha.0",
|
|
10
|
+
"@frontegg/types": "6.145.0-alpha.0",
|
|
11
11
|
"@types/react": "*",
|
|
12
12
|
"get-value": "^3.0.1",
|
|
13
13
|
"react-redux": "^7.x"
|