@yangsaiyam/helper 1.5.3 → 1.7.0

package/README.md

@@ -69,6 +69,12 @@ src/
 - `CAREER_CATEGORY`
 - `CAREER_MODE`
 - `CAREER_LOCATION`
+- `ROUTES`
+- `ROUTE`
+- `buildLocalizedRoute`
+- `buildRoutePathName`
+- `routeLabelKey`
+- `routePathKey`
 - `CONTACT_FORM_ENQUIRY_TYPE`
 - `FILE_STATUS`
 - `FILE_ORIGIN`

package/package.json

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

package/src/index.ts

@@ -4,6 +4,7 @@ export * from "./contact-form";
 export * from "./files";
 export * from "./locale";
 export * from "./roles";
+export * from "./routes";
 export * from "./shared/helpers";
 export * from "./shared/types";
 export * from "./time";

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/routes/index.test.ts

@@ -0,0 +1,114 @@
+import assert from "node:assert/strict";
+
+import {
+  ROUTE,
+  ROUTES,
+  buildRoutePathName,
+  buildLocalizedRoute,
+  routeLabelKey,
+  routePathKey,
+} from "./index";
+
+assert.deepEqual(ROUTES, [
+  {
+    key: "home",
+    path: "/[locale]",
+    path_name: "/",
+    path_key: "/",
+    i18nKey: "routes.home",
+  },
+  {
+    key: "about",
+    path: "/[locale]/about",
+    path_name: "/about",
+    path_key: "/about",
+    i18nKey: "routes.about",
+  },
+  {
+    key: "career",
+    path: "/[locale]/career",
+    path_name: "/career",
+    path_key: "/career",
+    i18nKey: "routes.career",
+  },
+  {
+    key: "careerDetail",
+    path: "/[locale]/career/[id]",
+    path_name: "/career/[id]",
+    path_key: "/career/[id]",
+    i18nKey: "routes.careerDetail",
+  },
+  {
+    key: "careerApply",
+    path: "/[locale]/career/[id]/apply",
+    path_name: "/career/[id]/apply",
+    path_key: "/career/[id]/apply",
+    i18nKey: "routes.careerApply",
+  },
+  {
+    key: "careerAssessment",
+    path: "/[locale]/career/[id]/apply/assessment",
+    path_name: "/career/[id]/apply/assessment",
+    path_key: "/career/[id]/apply/assessment",
+    i18nKey: "routes.careerAssessment",
+  },
+  {
+    key: "contact",
+    path: "/[locale]/contact",
+    path_name: "/contact",
+    path_key: "/contact",
+    i18nKey: "routes.contact",
+  },
+  {
+    key: "services",
+    path: "/[locale]/services",
+    path_name: "/services",
+    path_key: "/services",
+    i18nKey: "routes.services",
+  },
+  {
+    key: "servicesAdvertisingPlatform",
+    path: "/[locale]/services/advertising-platform",
+    path_name: "/services/advertising-platform",
+    path_key: "/services/advertising-platform",
+    i18nKey: "routes.servicesAdvertisingPlatform",
+  },
+  {
+    key: "servicesMcnBusiness",
+    path: "/[locale]/services/mcn-business",
+    path_name: "/services/mcn-business",
+    path_key: "/services/mcn-business",
+    i18nKey: "routes.servicesMcnBusiness",
+  },
+  {
+    key: "servicesSoftwareDevelopment",
+    path: "/[locale]/services/software-development",
+    path_name: "/services/software-development",
+    path_key: "/services/software-development",
+    i18nKey: "routes.servicesSoftwareDevelopment",
+  },
+]);
+
+assert.equal(ROUTE.home, "/[locale]");
+assert.equal(ROUTE.careerAssessment, "/[locale]/career/[id]/apply/assessment");
+assert.equal(
+  buildLocalizedRoute("careerApply", "en", { id: "frontend-engineer" }),
+  "/en/career/frontend-engineer/apply",
+);
+assert.equal(
+  buildLocalizedRoute("servicesMcnBusiness", "zh"),
+  "/zh/services/mcn-business",
+);
+assert.equal(
+  buildRoutePathName("careerApply", { id: "frontend-engineer" }),
+  "/career/frontend-engineer/apply",
+);
+assert.equal(routePathKey("home"), "/");
+assert.equal(routePathKey("careerApply"), "/career/[id]/apply");
+assert.throws(() => buildLocalizedRoute("careerDetail", "en"), {
+  message: 'Route "careerDetail" requires an id parameter.',
+});
+assert.equal(
+  routeLabelKey("servicesSoftwareDevelopment"),
+  "routes.servicesSoftwareDevelopment",
+);

package/src/routes/index.ts

@@ -0,0 +1,148 @@
+export type RouteKey =
+  | "home"
+  | "about"
+  | "career"
+  | "careerDetail"
+  | "careerApply"
+  | "careerAssessment"
+  | "contact"
+  | "services"
+  | "servicesAdvertisingPlatform"
+  | "servicesMcnBusiness"
+  | "servicesSoftwareDevelopment";
+
+export type RouteMapping = {
+  key: RouteKey;
+  path: string;
+  path_name: string;
+  path_key: string;
+  i18nKey: string;
+};
+
+export const ROUTES = [
+  {
+    key: "home",
+    path: "/[locale]",
+    path_name: "/",
+    path_key: "/",
+    i18nKey: "routes.home",
+  },
+  {
+    key: "about",
+    path: "/[locale]/about",
+    path_name: "/about",
+    path_key: "/about",
+    i18nKey: "routes.about",
+  },
+  {
+    key: "career",
+    path: "/[locale]/career",
+    path_name: "/career",
+    path_key: "/career",
+    i18nKey: "routes.career",
+  },
+  {
+    key: "careerDetail",
+    path: "/[locale]/career/[id]",
+    path_name: "/career/[id]",
+    path_key: "/career/[id]",
+    i18nKey: "routes.careerDetail",
+  },
+  {
+    key: "careerApply",
+    path: "/[locale]/career/[id]/apply",
+    path_name: "/career/[id]/apply",
+    path_key: "/career/[id]/apply",
+    i18nKey: "routes.careerApply",
+  },
+  {
+    key: "careerAssessment",
+    path: "/[locale]/career/[id]/apply/assessment",
+    path_name: "/career/[id]/apply/assessment",
+    path_key: "/career/[id]/apply/assessment",
+    i18nKey: "routes.careerAssessment",
+  },
+  {
+    key: "contact",
+    path: "/[locale]/contact",
+    path_name: "/contact",
+    path_key: "/contact",
+    i18nKey: "routes.contact",
+  },
+  {
+    key: "services",
+    path: "/[locale]/services",
+    path_name: "/services",
+    path_key: "/services",
+    i18nKey: "routes.services",
+  },
+  {
+    key: "servicesAdvertisingPlatform",
+    path: "/[locale]/services/advertising-platform",
+    path_name: "/services/advertising-platform",
+    path_key: "/services/advertising-platform",
+    i18nKey: "routes.servicesAdvertisingPlatform",
+  },
+  {
+    key: "servicesMcnBusiness",
+    path: "/[locale]/services/mcn-business",
+    path_name: "/services/mcn-business",
+    path_key: "/services/mcn-business",
+    i18nKey: "routes.servicesMcnBusiness",
+  },
+  {
+    key: "servicesSoftwareDevelopment",
+    path: "/[locale]/services/software-development",
+    path_name: "/services/software-development",
+    path_key: "/services/software-development",
+    i18nKey: "routes.servicesSoftwareDevelopment",
+  },
+] as const satisfies readonly RouteMapping[];
+
+export const ROUTE = Object.fromEntries(
+  ROUTES.map((route) => [route.key, route.path]),
+) as Record<RouteKey, string>;
+
+export function routeLabelKey(route: RouteKey): string {
+  return ROUTES.find((item) => item.key === route)?.i18nKey ?? "routes.home";
+}
+
+export function routePathKey(route: RouteKey): string {
+  return ROUTES.find((item) => item.key === route)?.path_key ?? "/";
+}
+
+export function buildRoutePathName(
+  route: RouteKey,
+  params: Partial<Record<"id", string | number>> = {},
+): string {
+  let pathName: string =
+    ROUTES.find((item) => item.key === route)?.path_name ?? "/";
+
+  if (pathName.includes("[id]")) {
+    if (params.id === undefined || params.id === null) {
+      throw new Error(`Route "${route}" requires an id parameter.`);
+    }
+
+    pathName = pathName.replace("[id]", encodeURIComponent(String(params.id)));
+  }
+
+  return pathName;
+}
+
+export function buildLocalizedRoute(
+  route: RouteKey,
+  locale: string,
+  params: Partial<Record<"id", string | number>> = {},
+): string {
+  let path = ROUTE[route].replace("[locale]", encodeURIComponent(locale));
+
+  if (path.includes("[id]")) {
+    if (params.id === undefined || params.id === null) {
+      throw new Error(`Route "${route}" requires an id parameter.`);
+    }
+
+    path = path.replace("[id]", encodeURIComponent(String(params.id)));
+  }
+
+  return path;
+}

package/src/track/index.test.ts

@@ -0,0 +1,9 @@
+import assert from "node:assert/strict";
+
+import { ORIGIN } from "./index";
+
+assert.deepEqual(ORIGIN[0], {
+  key: 0,
+  value: "Website",
+  i18nKey: "track.origin.0",
+});

package/src/track/index.ts

@@ -1,16 +1,16 @@
 import { MappingOption } from "../shared/types";
 
-export const ORIGIN = [
-  {
-    key: 1,
-    value: "Website",
-    i18nKey: "track.origin.1",
-  },
-  {
-    key: 2,
-    value: "Linkedin",
-    i18nKey: "track.origin.2",
-  },
-  { key: 3, value: "Jobstreet", i18nKey: "track.origin.3" },
-  { key: 4, value: "Maukerja", i18nKey: "track.origin.4" },
-] as const satisfies readonly MappingOption[];
+export const ORIGIN = [
+  {
+    key: 0,
+    value: "Website",
+    i18nKey: "track.origin.0",
+  },
+  {
+    key: 1,
+    value: "Linkedin",
+    i18nKey: "track.origin.1",
+  },
+  { key: 2, value: "Jobstreet", i18nKey: "track.origin.2" },
+  { key: 3, value: "Maukerja", i18nKey: "track.origin.3" },
+] as const satisfies readonly MappingOption[];