korre-mapping

Shared key-value mappings for Korre projects.

Install

SSH:

pnpm add git+ssh://[email protected]:your-org/korre-mapping.git

HTTPS:

pnpm add github:your-org/korre-mapping

Use

import { CAREER_LOCATION, getLabelByKey } from "@korre/mapping";

const label = getLabelByKey(CAREER_LOCATION, 1);
// KualaLumpur

import { CAREER_JOB_TYPE, getOptionByKey } from "@korre/mapping";

type CareerCardProps = {
  career: {
    title: string;
    jobType: number;
  };
};

export default function CareerCard({ career }: CareerCardProps) {
  const jobType = getOptionByKey(CAREER_JOB_TYPE, career.jobType);

  return (
    <div>
      <h2>{career.title}</h2>
      <p>{jobType?.value ?? "Unknown"}</p>
    </div>
  );
}

Structure

src/
├─ career/
│  └─ index.ts
├─ contact-form/
│  └─ index.ts
├─ files/
│  └─ index.ts
├─ shared/
│  ├─ helpers.ts
│  └─ types.ts
└─ index.ts

Exports

• CAREER_JOB_TYPE
• CAREER_CATEGORY
• CAREER_MODE
• CAREER_LOCATION
• ROUTES
• ROUTE
• buildLocalizedRoute
• buildRoutePathName
• routeLabelKey
• routePathKey
• CONTACT_FORM_ENQUIRY_TYPE
• FILE_STATUS
• FILE_ORIGIN
• getOptionByKey
• getLabelByKey
• getI18nKeyByKey
• toRecord

Update mappings

Update src/index.ts, then commit and push:

git add .
git commit -m "update mappings"
git push

In consuming repos:

pnpm update @korre/mapping