feat: add casbinJsGetPermissionForUser

kingiw · kingiw · commit 30ae126b962d · 2020-08-11T11:48:53.000+08:00
Signed-off-by: kingiw &lt;kingiw@hotmail.com&gt;
diff --git a/src/frontend.ts b/src/frontend.ts
@@ -0,0 +1,38 @@
+// Copyright 2020 The Casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { Enforcer } from './enforcer';
+
+/**
+ * getPermissionForCasbinJs returns a string describing the permission of a given user.
+ * You can pass the returned string to the frontend and manage your webpage widgets and APIs with Casbin.js.
+ * The returned permission depends on `getImplicitPermissionsForUser`.
+ * In other words, getPermissionForCasbinJs will load all of the explicit and implicit permission (role's permission).
+ * @param e the initialized enforcer
+ * @param user the user
+ */
+export async function casbinJsGetPermissionForUser(e: Enforcer, user: string): Promise<string> {
+  const policies = await e.getImplicitPermissionsForUser(user);
+  const permission: { [key: string]: string[] } = {};
+  policies.forEach(policy => {
+    if (!(policy[2] in permission)) {
+      permission[policy[2]] = [];
+    }
+    if (permission[policy[2]].indexOf(policy[1]) == -1) {
+      permission[policy[2]].push(policy[1]);
+    }
+  });
+  const permString = JSON.stringify(permission);
+  return permString;
+}
diff --git a/src/index.ts b/src/index.ts
@@ -23,4 +23,5 @@ export * from './model';
 export * from './persist';
 export * from './rbac';
 export * from './log';
+export * from './frontend';
 export { Util };
diff --git a/test/frontend.test.ts b/test/frontend.test.ts
@@ -0,0 +1,33 @@
+// Copyright 2020 The Casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { newEnforcer } from '../src/index';
+import { casbinJsGetPermissionForUser } from '../src/frontend';
+
+test('TestCasbinJsGetPermissionForUser', async () => {
+  const e = await newEnforcer('examples/rbac_model.conf', 'examples/rbac_with_hierarchy_policy.csv');
+  let permStr = await casbinJsGetPermissionForUser(e, 'alice');
+  let perm = JSON.parse(permStr);
+  expect(perm['read']).toContain('data1');
+  expect(perm['write']).toContain('data1');
+  expect(perm['read']).toContain('data2');
+  expect(perm['write']).toContain('data2');
+
+  permStr = await casbinJsGetPermissionForUser(e, 'bob');
+  perm = JSON.parse(permStr);
+  expect(perm['write']).toContain('data2');
+  expect(perm['write']).not.toContain('data1');
+  expect(perm['read']).not.toBeNull;
+  expect(perm['rm_rf']).toBeNull;
+});
