@yangsaiyam/helper 1.5.3 → 1.6.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.6.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/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[];