@platecms/delta-types 1.13.0 → 1.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-types",
-  "version": "1.13.0",
+  "version": "1.15.0",
   "description": "This package contains various utility types.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -17,8 +17,8 @@
     "src/**/*"
   ],
   "peerDependencies": {
-    "@platecms/delta-cast": "1.13.0",
-    "@platecms/delta-plate-resource-notation": "1.13.0",
+    "@platecms/delta-cast": "1.15.0",
+    "@platecms/delta-plate-resource-notation": "1.15.0",
     "class-transformer": "0.5.1",
     "reflect-metadata": "0.2.2",
     "tslib": "2.8.1"

package/src/index.ts

@@ -6,3 +6,7 @@ export * from "./lib/stage.enum";
 export * from "./lib/header-keys.enum";
 export * from "./lib/action-type.enum";
 export * from "./lib/processed-asset-options.interface";
+export * from "./lib/language-status.enum";
+export type * from "./lib/language-option.interface";
+export * from "./lib/language-options.const";
+export * from "./lib/language-locale.util";

package/src/lib/language-locale.util.ts

@@ -0,0 +1,74 @@
+import { LanguageOption } from "./language-option.interface";
+import { LANGUAGE_OPTIONS } from "./language-options.const";
+
+export function languageOptionKey(code: string, countryCode: string): string {
+  return `${code.toLowerCase()}:${countryCode.toUpperCase()}`;
+}
+
+export const LANGUAGE_OPTIONS_BY_KEY: ReadonlyMap<string, LanguageOption> = new Map(
+  LANGUAGE_OPTIONS.map((option) => [languageOptionKey(option.code, option.countryCode), option]),
+);
+
+export function formatLocale(code: string, countryCode: string): string {
+  return `${code.toLowerCase()}-${countryCode.toUpperCase()}`;
+}
+
+export function formatLocaleFromEntity(
+  entity: Record<string, unknown> & { code: string; countryCode: string },
+): string {
+  return formatLocale(entity.code, entity.countryCode);
+}
+
+export function parseLocale(locale: string): { code: string; countryCode: string } {
+  const dashIndex = locale.indexOf("-");
+  if (dashIndex <= 0) {
+    throw new Error("Invalid locale format. Expected locale in the form 'll-CC'.");
+  }
+
+  return {
+    code: locale.slice(0, dashIndex).toLowerCase(),
+    countryCode: locale.slice(dashIndex + 1).toUpperCase(),
+  };
+}
+
+export function findLanguageOption(code: string, countryCode: string): LanguageOption | undefined {
+  return LANGUAGE_OPTIONS_BY_KEY.get(languageOptionKey(code, countryCode));
+}
+
+export function isValidLanguageOption(code: string, countryCode: string): boolean {
+  return findLanguageOption(code, countryCode) != null;
+}
+
+export function assertKnownLanguageOption(code: string, countryCode: string): LanguageOption {
+  const option = findLanguageOption(code, countryCode);
+  if (option == null) {
+    throw new Error(`Unknown language option '${formatLocale(code, countryCode)}'.`);
+  }
+
+  return option;
+}
+
+export function formatLanguageDisplayName(
+  code: string,
+  countryCode: string,
+  uiLocale: string,
+  selectedLocales: readonly Pick<LanguageOption, "code" | "countryCode">[] = [],
+  options: { alwaysIncludeRegion?: boolean } = {},
+): string {
+  const normalizedCode = code.toLowerCase();
+  const normalizedCountryCode = countryCode.toUpperCase();
+  const languageNames = new Intl.DisplayNames([uiLocale], { type: "language" });
+  const regionNames = new Intl.DisplayNames([uiLocale], { type: "region" });
+  const languageName = languageNames.of(normalizedCode) ?? normalizedCode;
+  const regionName = regionNames.of(normalizedCountryCode) ?? normalizedCountryCode;
+
+  const hasConflict =
+    options.alwaysIncludeRegion === true ||
+    selectedLocales.filter((locale) => locale.code.toLowerCase() === normalizedCode).length > 1;
+
+  if (hasConflict) {
+    return `${languageName} (${regionName})`;
+  }
+
+  return languageName;
+}

package/src/lib/language-option.interface.ts

@@ -0,0 +1,4 @@
+export interface LanguageOption {
+  readonly code: string;
+  readonly countryCode: string;
+}

package/src/lib/language-options.const.ts

@@ -0,0 +1,600 @@
+import { LanguageOption } from "./language-option.interface";
+
+export const LANGUAGE_OPTIONS: readonly LanguageOption[] = [
+  {
+    code: "af",
+    countryCode: "ZA",
+  },
+  {
+    code: "ar",
+    countryCode: "AE",
+  },
+  {
+    code: "ar",
+    countryCode: "BH",
+  },
+  {
+    code: "ar",
+    countryCode: "DZ",
+  },
+  {
+    code: "ar",
+    countryCode: "EG",
+  },
+  {
+    code: "ar",
+    countryCode: "IQ",
+  },
+  {
+    code: "ar",
+    countryCode: "JO",
+  },
+  {
+    code: "ar",
+    countryCode: "KW",
+  },
+  {
+    code: "ar",
+    countryCode: "LB",
+  },
+  {
+    code: "ar",
+    countryCode: "LY",
+  },
+  {
+    code: "ar",
+    countryCode: "MA",
+  },
+  {
+    code: "ar",
+    countryCode: "OM",
+  },
+  {
+    code: "ar",
+    countryCode: "QA",
+  },
+  {
+    code: "ar",
+    countryCode: "SA",
+  },
+  {
+    code: "ar",
+    countryCode: "SY",
+  },
+  {
+    code: "ar",
+    countryCode: "TN",
+  },
+  {
+    code: "ar",
+    countryCode: "YE",
+  },
+  {
+    code: "az",
+    countryCode: "AZ",
+  },
+  {
+    code: "be",
+    countryCode: "BY",
+  },
+  {
+    code: "bg",
+    countryCode: "BG",
+  },
+  {
+    code: "bs",
+    countryCode: "BA",
+  },
+  {
+    code: "ca",
+    countryCode: "ES",
+  },
+  {
+    code: "cs",
+    countryCode: "CZ",
+  },
+  {
+    code: "cy",
+    countryCode: "GB",
+  },
+  {
+    code: "da",
+    countryCode: "DK",
+  },
+  {
+    code: "de",
+    countryCode: "AT",
+  },
+  {
+    code: "de",
+    countryCode: "CH",
+  },
+  {
+    code: "de",
+    countryCode: "DE",
+  },
+  {
+    code: "de",
+    countryCode: "LI",
+  },
+  {
+    code: "de",
+    countryCode: "LU",
+  },
+  {
+    code: "dv",
+    countryCode: "MV",
+  },
+  {
+    code: "el",
+    countryCode: "GR",
+  },
+  {
+    code: "en",
+    countryCode: "AU",
+  },
+  {
+    code: "en",
+    countryCode: "BZ",
+  },
+  {
+    code: "en",
+    countryCode: "CA",
+  },
+  {
+    code: "en",
+    countryCode: "CB",
+  },
+  {
+    code: "en",
+    countryCode: "GB",
+  },
+  {
+    code: "en",
+    countryCode: "IE",
+  },
+  {
+    code: "en",
+    countryCode: "JM",
+  },
+  {
+    code: "en",
+    countryCode: "NZ",
+  },
+  {
+    code: "en",
+    countryCode: "PH",
+  },
+  {
+    code: "en",
+    countryCode: "TT",
+  },
+  {
+    code: "en",
+    countryCode: "US",
+  },
+  {
+    code: "en",
+    countryCode: "ZA",
+  },
+  {
+    code: "en",
+    countryCode: "ZW",
+  },
+  {
+    code: "es",
+    countryCode: "AR",
+  },
+  {
+    code: "es",
+    countryCode: "BO",
+  },
+  {
+    code: "es",
+    countryCode: "CL",
+  },
+  {
+    code: "es",
+    countryCode: "CO",
+  },
+  {
+    code: "es",
+    countryCode: "CR",
+  },
+  {
+    code: "es",
+    countryCode: "DO",
+  },
+  {
+    code: "es",
+    countryCode: "EC",
+  },
+  {
+    code: "es",
+    countryCode: "ES",
+  },
+  {
+    code: "es",
+    countryCode: "GT",
+  },
+  {
+    code: "es",
+    countryCode: "HN",
+  },
+  {
+    code: "es",
+    countryCode: "MX",
+  },
+  {
+    code: "es",
+    countryCode: "NI",
+  },
+  {
+    code: "es",
+    countryCode: "PA",
+  },
+  {
+    code: "es",
+    countryCode: "PE",
+  },
+  {
+    code: "es",
+    countryCode: "PR",
+  },
+  {
+    code: "es",
+    countryCode: "PY",
+  },
+  {
+    code: "es",
+    countryCode: "SV",
+  },
+  {
+    code: "es",
+    countryCode: "UY",
+  },
+  {
+    code: "es",
+    countryCode: "VE",
+  },
+  {
+    code: "et",
+    countryCode: "EE",
+  },
+  {
+    code: "eu",
+    countryCode: "ES",
+  },
+  {
+    code: "fa",
+    countryCode: "IR",
+  },
+  {
+    code: "fi",
+    countryCode: "FI",
+  },
+  {
+    code: "fo",
+    countryCode: "FO",
+  },
+  {
+    code: "fr",
+    countryCode: "BE",
+  },
+  {
+    code: "fr",
+    countryCode: "CA",
+  },
+  {
+    code: "fr",
+    countryCode: "CH",
+  },
+  {
+    code: "fr",
+    countryCode: "FR",
+  },
+  {
+    code: "fr",
+    countryCode: "LU",
+  },
+  {
+    code: "fr",
+    countryCode: "MC",
+  },
+  {
+    code: "gl",
+    countryCode: "ES",
+  },
+  {
+    code: "gu",
+    countryCode: "IN",
+  },
+  {
+    code: "he",
+    countryCode: "IL",
+  },
+  {
+    code: "hi",
+    countryCode: "IN",
+  },
+  {
+    code: "hr",
+    countryCode: "BA",
+  },
+  {
+    code: "hr",
+    countryCode: "HR",
+  },
+  {
+    code: "hu",
+    countryCode: "HU",
+  },
+  {
+    code: "hy",
+    countryCode: "AM",
+  },
+  {
+    code: "id",
+    countryCode: "ID",
+  },
+  {
+    code: "is",
+    countryCode: "IS",
+  },
+  {
+    code: "it",
+    countryCode: "CH",
+  },
+  {
+    code: "it",
+    countryCode: "IT",
+  },
+  {
+    code: "ja",
+    countryCode: "JP",
+  },
+  {
+    code: "ka",
+    countryCode: "GE",
+  },
+  {
+    code: "kk",
+    countryCode: "KZ",
+  },
+  {
+    code: "kn",
+    countryCode: "IN",
+  },
+  {
+    code: "ko",
+    countryCode: "KR",
+  },
+  {
+    code: "kok",
+    countryCode: "IN",
+  },
+  {
+    code: "ky",
+    countryCode: "KG",
+  },
+  {
+    code: "lt",
+    countryCode: "LT",
+  },
+  {
+    code: "lv",
+    countryCode: "LV",
+  },
+  {
+    code: "mi",
+    countryCode: "NZ",
+  },
+  {
+    code: "mk",
+    countryCode: "MK",
+  },
+  {
+    code: "mn",
+    countryCode: "MN",
+  },
+  {
+    code: "mr",
+    countryCode: "IN",
+  },
+  {
+    code: "ms",
+    countryCode: "BN",
+  },
+  {
+    code: "ms",
+    countryCode: "MY",
+  },
+  {
+    code: "mt",
+    countryCode: "MT",
+  },
+  {
+    code: "nb",
+    countryCode: "NO",
+  },
+  {
+    code: "nl",
+    countryCode: "BE",
+  },
+  {
+    code: "nl",
+    countryCode: "NL",
+  },
+  {
+    code: "nn",
+    countryCode: "NO",
+  },
+  {
+    code: "ns",
+    countryCode: "ZA",
+  },
+  {
+    code: "pa",
+    countryCode: "IN",
+  },
+  {
+    code: "pl",
+    countryCode: "PL",
+  },
+  {
+    code: "ps",
+    countryCode: "AR",
+  },
+  {
+    code: "pt",
+    countryCode: "BR",
+  },
+  {
+    code: "pt",
+    countryCode: "PT",
+  },
+  {
+    code: "qu",
+    countryCode: "BO",
+  },
+  {
+    code: "qu",
+    countryCode: "EC",
+  },
+  {
+    code: "qu",
+    countryCode: "PE",
+  },
+  {
+    code: "ro",
+    countryCode: "RO",
+  },
+  {
+    code: "ru",
+    countryCode: "RU",
+  },
+  {
+    code: "sa",
+    countryCode: "IN",
+  },
+  {
+    code: "se",
+    countryCode: "FI",
+  },
+  {
+    code: "se",
+    countryCode: "NO",
+  },
+  {
+    code: "se",
+    countryCode: "SE",
+  },
+  {
+    code: "sk",
+    countryCode: "SK",
+  },
+  {
+    code: "sl",
+    countryCode: "SI",
+  },
+  {
+    code: "sq",
+    countryCode: "AL",
+  },
+  {
+    code: "sr",
+    countryCode: "BA",
+  },
+  {
+    code: "sr",
+    countryCode: "SP",
+  },
+  {
+    code: "sv",
+    countryCode: "FI",
+  },
+  {
+    code: "sv",
+    countryCode: "SE",
+  },
+  {
+    code: "sw",
+    countryCode: "KE",
+  },
+  {
+    code: "syr",
+    countryCode: "SY",
+  },
+  {
+    code: "ta",
+    countryCode: "IN",
+  },
+  {
+    code: "te",
+    countryCode: "IN",
+  },
+  {
+    code: "th",
+    countryCode: "TH",
+  },
+  {
+    code: "tl",
+    countryCode: "PH",
+  },
+  {
+    code: "tn",
+    countryCode: "ZA",
+  },
+  {
+    code: "tr",
+    countryCode: "TR",
+  },
+  {
+    code: "tt",
+    countryCode: "RU",
+  },
+  {
+    code: "uk",
+    countryCode: "UA",
+  },
+  {
+    code: "ur",
+    countryCode: "PK",
+  },
+  {
+    code: "uz",
+    countryCode: "UZ",
+  },
+  {
+    code: "vi",
+    countryCode: "VN",
+  },
+  {
+    code: "xh",
+    countryCode: "ZA",
+  },
+  {
+    code: "zh",
+    countryCode: "CN",
+  },
+  {
+    code: "zh",
+    countryCode: "HK",
+  },
+  {
+    code: "zh",
+    countryCode: "MO",
+  },
+  {
+    code: "zh",
+    countryCode: "SG",
+  },
+  {
+    code: "zh",
+    countryCode: "TW",
+  },
+  {
+    code: "zu",
+    countryCode: "ZA",
+  },
+] as const;

package/src/lib/language-status.enum.ts

@@ -0,0 +1,4 @@
+export enum LanguageStatus {
+  ENABLED = "ENABLED",
+  DISABLED = "DISABLED",
+}