@yangsaiyam/helper 1.6.0 → 1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yangsaiyam/helper",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
   "exports": {

package/src/roles/index.test.ts

@@ -16,6 +16,8 @@ assert.equal(normalizeRole(0), "super-admin");
 assert.equal(normalizeRole("admin"), "admin");
 assert.equal(normalizeRole(2), "staff");
 assert.equal(normalizeRole("hr"), "hr");
+assert.equal(normalizeRole(32766), "visitor");
+assert.equal(normalizeRole("none"), "none");
 assert.equal(normalizeRole("unknown"), undefined);
 assert.equal(normalizeRole(undefined), undefined);
 
@@ -23,12 +25,16 @@ assert.equal(roleToId("super-admin"), 0);
 assert.equal(roleToId("admin"), 1);
 assert.equal(roleToId("staff"), 2);
 assert.equal(roleToId("hr"), 3);
+assert.equal(roleToId("visitor"), 32766);
+assert.equal(roleToId("none"), 32767);
 assert.equal(roleToId("unknown"), undefined);
 
 assert.equal(roleLabelKey(0), "users.roleSuperAdmin");
 assert.equal(roleLabelKey("admin"), "users.roleAdmin");
 assert.equal(roleLabelKey(2), "users.roleStaff");
 assert.equal(roleLabelKey("hr"), "users.roleHr");
+assert.equal(roleLabelKey("visitor"), "users.roleVisitor");
+assert.equal(roleLabelKey("none"), "users.roleNone");
 assert.equal(roleLabelKey(undefined), "users.roleStaff");
 
 assert.deepEqual(ROLE[0], {
@@ -37,6 +43,16 @@ assert.deepEqual(ROLE[0], {
   i18nKey: "users.roleSuperAdmin",
 });
 assert.equal(ROLE[3]?.i18nKey, "users.roleHr");
+assert.deepEqual(ROLE[4], {
+  key: 32766,
+  value: "visitor",
+  i18nKey: "users.roleVisitor",
+});
+assert.deepEqual(ROLE[5], {
+  key: 32767,
+  value: "none",
+  i18nKey: "users.roleNone",
+});
 
 assert.equal(
   PERMISSION_I18N_KEY[Permission.ALLOWED_EMAILS_READ],
@@ -55,6 +71,7 @@ assert.equal(
   "permissions.twoFactorAuthWrite",
 );
 assert.equal(permissionLabelKey(Permission.VIEWS_READ), "permissions.viewsRead");
+assert.equal(permissionLabelKey(Permission.LOGS_READ), "permissions.logsRead");
 
 assert.ok(ROLE_PERMISSIONS["super-admin"].includes(Permission.USERS_DELETE));
 assert.ok(ROLE_PERMISSIONS["super-admin"].includes(Permission.OTP_ATTEMPTS_READ));
@@ -62,14 +79,18 @@ assert.ok(
   ROLE_PERMISSIONS["super-admin"].includes(Permission.TWO_FACTOR_AUTH_WRITE),
 );
 assert.ok(ROLE_PERMISSIONS["super-admin"].includes(Permission.VIEWS_READ));
+assert.ok(ROLE_PERMISSIONS["super-admin"].includes(Permission.LOGS_READ));
 assert.ok(ROLE_PERMISSIONS.admin.includes(Permission.CONTACT_FORM_DELETE));
 assert.ok(ROLE_PERMISSIONS.admin.includes(Permission.VIEWS_READ));
+assert.ok(ROLE_PERMISSIONS.admin.includes(Permission.LOGS_READ));
 assert.equal(
   ROLE_PERMISSIONS.admin.includes(Permission.USERS_WRITE),
   false,
 );
 assert.ok(ROLE_PERMISSIONS.hr.includes(Permission.JOB_APPLICATIONS_READ));
 assert.deepEqual(ROLE_PERMISSIONS.staff, [Permission.CONTACT_FORM_READ]);
+assert.deepEqual(ROLE_PERMISSIONS.visitor, []);
+assert.deepEqual(ROLE_PERMISSIONS.none, []);
 
 assert.equal(hasPermission("super-admin", Permission.USERS_WRITE), true);
 assert.equal(hasPermission("super-admin", Permission.OTP_ATTEMPTS_WRITE), true);
@@ -78,4 +99,6 @@ assert.equal(hasPermission("hr", Permission.CAREERS_WRITE), true);
 assert.equal(hasPermission("staff", Permission.CAREERS_WRITE), false);
 assert.equal(hasPermission("staff", Permission.CONTACT_FORM_READ), true);
 assert.equal(hasPermission("admin", Permission.VIEWS_READ), true);
+assert.equal(hasPermission("visitor", Permission.VIEWS_READ), false);
+assert.equal(hasPermission(32767, Permission.LOGS_READ), false);
 assert.equal(hasPermission(undefined, Permission.CAREERS_READ), false);

package/src/roles/index.ts

@@ -1,32 +1,53 @@
 import type { MappingOption } from "../shared/types";
 
-export type CanonicalRole = "super-admin" | "admin" | "hr" | "staff";
+export type CanonicalRole =
+  | "super-admin"
+  | "admin"
+  | "staff"
+  | "hr"
+  | "visitor"
+  | "none";
 export type RoleValue = CanonicalRole | number;
 export type RoleInput = RoleValue | string;
 
+export const ROLE_MAP: Record<number, CanonicalRole> = {
+  0: "super-admin",
+  1: "admin",
+  2: "staff",
+  3: "hr",
+  32766: "visitor",
+  32767: "none",
+};
+
 export const ROLE = [
   { key: 0, value: "super-admin", i18nKey: "users.roleSuperAdmin" },
   { key: 1, value: "admin", i18nKey: "users.roleAdmin" },
   { key: 2, value: "staff", i18nKey: "users.roleStaff" },
   { key: 3, value: "hr", i18nKey: "users.roleHr" },
+  { key: 32766, value: "visitor", i18nKey: "users.roleVisitor" },
+  { key: 32767, value: "none", i18nKey: "users.roleNone" },
 ] as const satisfies readonly MappingOption[];
 
 export function normalizeRole(
   role: RoleInput | undefined,
 ): CanonicalRole | undefined {
+  if (typeof role === "number") {
+    return ROLE_MAP[role];
+  }
+
   switch (role) {
-    case 0:
     case "super-admin":
       return "super-admin";
-    case 1:
     case "admin":
       return "admin";
-    case 2:
     case "staff":
       return "staff";
-    case 3:
     case "hr":
       return "hr";
+    case "visitor":
+      return "visitor";
+    case "none":
+      return "none";
     default:
       return undefined;
   }
@@ -42,24 +63,18 @@ export function roleLabelKey(role: RoleInput | undefined): string {
       return "users.roleHr";
     case "staff":
       return "users.roleStaff";
+    case "visitor":
+      return "users.roleVisitor";
+    case "none":
+      return "users.roleNone";
     default:
       return "users.roleStaff";
   }
 }
 
 export function roleToId(role: RoleInput | undefined): number | undefined {
-  switch (normalizeRole(role)) {
-    case "super-admin":
-      return 0;
-    case "admin":
-      return 1;
-    case "staff":
-      return 2;
-    case "hr":
-      return 3;
-    default:
-      return undefined;
-  }
+  const normalizedRole = normalizeRole(role);
+  return ROLE.find((option) => option.value === normalizedRole)?.key;
 }
 
 export const Permission = {
@@ -79,6 +94,7 @@ export const Permission = {
   TWO_FACTOR_AUTH_READ: "two-factor-auth:read",
   TWO_FACTOR_AUTH_WRITE: "two-factor-auth:write",
   VIEWS_READ: "views:read",
+  LOGS_READ: "logs:read",
 } as const;
 
 export type Permission = (typeof Permission)[keyof typeof Permission];
@@ -100,6 +116,7 @@ export const PERMISSION_I18N_KEY: Record<Permission, string> = {
   [Permission.TWO_FACTOR_AUTH_READ]: "permissions.twoFactorAuthRead",
   [Permission.TWO_FACTOR_AUTH_WRITE]: "permissions.twoFactorAuthWrite",
   [Permission.VIEWS_READ]: "permissions.viewsRead",
+  [Permission.LOGS_READ]: "permissions.logsRead",
 };
 
 export const ROLE_PERMISSIONS: Record<CanonicalRole, Permission[]> = {
@@ -120,6 +137,7 @@ export const ROLE_PERMISSIONS: Record<CanonicalRole, Permission[]> = {
     Permission.TWO_FACTOR_AUTH_READ,
     Permission.TWO_FACTOR_AUTH_WRITE,
     Permission.VIEWS_READ,
+    Permission.LOGS_READ,
   ],
   admin: [
     Permission.ALLOWED_EMAILS_READ,
@@ -132,6 +150,7 @@ export const ROLE_PERMISSIONS: Record<CanonicalRole, Permission[]> = {
     Permission.CONTACT_FORM_DELETE,
     Permission.JOB_APPLICATIONS_READ,
     Permission.VIEWS_READ,
+    Permission.LOGS_READ,
   ],
   hr: [
     Permission.CAREERS_READ,
@@ -140,6 +159,8 @@ export const ROLE_PERMISSIONS: Record<CanonicalRole, Permission[]> = {
     Permission.JOB_APPLICATIONS_READ,
   ],
   staff: [Permission.CONTACT_FORM_READ],
+  visitor: [],
+  none: [],
 };
 
 export function hasPermission(

package/src/url-prefix/index.ts

@@ -0,0 +1,10 @@
+import { Website } from "../website";
+
+export const URL_PREFIXES = {
+  [Website.KORRE]: {
+    contact: "https://www.korre.site/contact",
+    careerDetail: "https://www.korre.site/career/[id]",
+    careerApply: "https://www.korre.site/career/[id]/apply",
+  },
+  [Website.KORRE_LABS]: {},
+};

package/src/website/index.ts

@@ -0,0 +1,17 @@
+export enum Website {
+  KORRE = 1,
+  KORRE_LABS = 2,
+}
+
+export const WEBSITES = {
+  [Website.KORRE]: {
+    id: Website.KORRE,
+    name: "Korre Evolution",
+    url: "https://public.korre.site/images/korre-evo.png",
+  },
+  [Website.KORRE_LABS]: {
+    id: Website.KORRE_LABS,
+    name: "Korre Labs",
+    url: "https://public.korre.site/images/korre-labs.png",
+  },
+};