warframe-worldstate-data 3.1.12 → 3.1.13

package/tools/translation.ts

@@ -1,430 +0,0 @@
-import data, { WorldstateLangBundle, type Locale } from '../exports';
-import { ArchonShard, SolNode, Conclave, SteelPath } from '../types';
-
-/**
- * Rough Titlecase!
- * @param {string} str string to be titlecased
- * @returns {string} titlecased string
- */
-export const toTitleCase = (str: string): string => {
-  return str.replace(/\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase());
-};
-
-/**
- * Utility function to split the resource name and return somewhat human-readable string
- * @param {string} str localization resource key
- * @returns {string} human-readable string
- */
-export const splitResourceName = (str: string): string =>
-  str
-    .split(/([A-Z]?[^A-Z]*)/g)
-    .filter(Boolean)
-    .join(' ');
-
-export const lastResourceName = (str: string | undefined) => (str ? str.split?.('/').reverse()[0] : str);
-
-const i18n = (locale: Locale = 'en') => data[locale] || data;
-
-const keyInData = <T>(key: keyof WorldstateLangBundle, dataOverride?: Locale): T =>
-  key in i18n(dataOverride) ? (i18n(dataOverride)[key] as T) : (key as T);
-
-/**
- *
- * @param {string} color - The internal color name
- * @param {string} dataOverride locale for use with translation
- * @returns {Object | undefined}
- */
-export const archonShard = (color: string, dataOverride: Locale = 'en') => {
-  return keyInData<Record<string, ArchonShard>>('archonShards', dataOverride)[color] as ArchonShard;
-};
-
-/**
- *
- * @param {string} color - The internal color name
- * @param {string} dataOverride locale for use with translation
- * @returns {string}
- */
-export const archonShardColor = (color: string, dataOverride: Locale = 'en'): string =>
-  archonShard(color, dataOverride)?.value ?? color;
-
-/**
- *
- * @param {string} color - The internal color name
- * @param {string} upgradeType - The upgrade type
- * @param {string} dataOverride locale for use with translation
- * @returns {string}
- */
-export const archonShardUpgradeType = (color: string, upgradeType: string, dataOverride: Locale = 'en'): string =>
-  archonShard(color, dataOverride)?.upgradeTypes[upgradeType]?.value ?? lastResourceName(upgradeType);
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} faction name
- */
-export const faction = (key: string, dataOverride: Locale = 'en'): string =>
-  keyInData<Record<string, { value: string }>>('factions', dataOverride)[key]?.value ?? key;
-
-const solNode = (key: string, thing: keyof SolNode, dataOverride: Locale = 'en') =>
-  keyInData<Record<string, SolNode>>('solNodes', dataOverride)?.[key]?.[thing] ?? lastResourceName(key) ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} node name
- */
-export const node = (key: string, dataOverride: Locale = 'en'): string => solNode(key, 'value', dataOverride);
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} mission type of the node
- */
-export const nodeMissionType = (key: string, dataOverride: Locale = 'en'): string => solNode(key, 'type', dataOverride);
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} faction that controls the node
- */
-export const nodeEnemy = (key: string, dataOverride: Locale = 'en'): string => {
-  return key in i18n(dataOverride).solNodes ? i18n(dataOverride).solNodes[key].enemy : (lastResourceName(key) ?? key);
-};
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} localization for language string
- */
-export const languageString = (key: string, dataOverride: Locale = 'en'): string => {
-  const lowerKey: string = String(key).toLowerCase();
-  return (
-    i18n(dataOverride).languages[lowerKey]?.value ??
-    i18n(dataOverride).languages[key]?.value ??
-    (key ? toTitleCase(splitResourceName(lastResourceName(String(key)) ?? '')) : key)
-  );
-};
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} localization for language description
- */
-export const languageDesc = (key: string, dataOverride: Locale = 'en'): string => {
-  const lowerKey = String(key).toLowerCase();
-  return (
-    i18n(dataOverride).languages[lowerKey]?.desc ??
-    i18n(dataOverride).languages[key]?.desc ??
-    (key ? `[PH] ${toTitleCase(splitResourceName(lastResourceName(String(key)) ?? ''))} Desc` : key)
-  );
-};
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} translation for mission type
- */
-export const missionType = (key: string, dataOverride: Locale = 'en'): string => {
-  const keyBased = key && typeof key === 'string' && toTitleCase((key ?? '').replace(/^MT_/, ''));
-  return key in i18n(dataOverride).missionTypes ? i18n(dataOverride).missionTypes[key].value : (keyBased as string);
-};
-
-const conclave = (key: string, thing: keyof Conclave, dataOverride: Locale = 'en') =>
-  keyInData<Conclave>('conclave', dataOverride)?.[thing]?.[key];
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} conclave mode
- */
-export const conclaveMode = (key: string, dataOverride: Locale = 'en'): string =>
-  (conclave(key, 'modes', dataOverride) as { value: string })?.value ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {{ value: string; description: string }} conclave category
- */
-export const conclaveCategory = (key: string, dataOverride: Locale = 'en'): string =>
-  (conclave(key, 'categories', dataOverride) as { value: string; description: string })?.value ?? key;
-
-const fissure = (key: string, dataOverride: Locale = 'en') =>
-  keyInData<Record<string, { value: string; num: number }>>('fissureModifiers', dataOverride)?.[key] ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} fissure modifier data
- */
-export const fissureModifier = (key: string, dataOverride: Locale = 'en'): string =>
-  fissure(key, dataOverride)?.value ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {number | string} fissure tier
- */
-export const fissureTier = (key: string, dataOverride: Locale = 'en'): number | string =>
-  fissure(key, dataOverride).num ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} syndicate name
- */
-export const syndicate = (key: string, dataOverride: Locale = 'en'): string =>
-  i18n(dataOverride).syndicates[key]?.name ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} upgrade type
- */
-export const upgrade = (key: string, dataOverride: Locale = 'en'): string =>
-  i18n(dataOverride).upgradeTypes[key]?.value ?? key;
-
-const oppo = (key: string, dataOverride: Locale = 'en') => i18n(dataOverride).operationTypes[key];
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} mathematical operation value
- */
-export const operation = (key: string, dataOverride: Locale = 'en'): string => oppo(key, dataOverride)?.value ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} symbol of mathematical operation
- */
-export const operationSymbol = (key: string, dataOverride: Locale = 'en'): string =>
-  oppo(key, dataOverride)?.symbol ?? key;
-
-const sortie = (key: string, dataOverride: Locale = 'en') => i18n(dataOverride).sortie.bosses[key];
-
-/**
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} sortie boss name
- */
-export const sortieBoss = (key: string, dataOverride: Locale = 'en'): string => sortie(key, dataOverride)?.name ?? key;
-
-/**
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} faction for a sortie based on the boss
- */
-export const sortieFaction = (key: string, dataOverride: Locale = 'en'): string =>
-  sortie(key, dataOverride)?.faction ?? key;
-
-/**
- *
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} sortie modifier data
- */
-export const sortieModifier = (key: string, dataOverride: Locale = 'en'): string =>
-  i18n(dataOverride).sortie.modifierTypes?.[key] ?? key;
-
-/**
- * @param {string} key - The data key
- * @param {string} dataOverride locale for use with translation
- * @returns {string} sortie modifier description
- */
-export const sortieModDesc = (key: string, dataOverride: Locale = 'en'): string =>
-  i18n(dataOverride).sortie.modifierDescriptions?.[key] ?? key;
-
-/**
- * Retrieve the localized region for a given key
- * @param {string | number} key - The region key
- * @param {string} dataOverride - The locale to use for translations
- * @returns {string} localized region name
- */
-export const region = (key: number, dataOverride: Locale = 'en'): string | number =>
-  (key && i18n(dataOverride).persistentEnemy?.regions[key]) ?? key;
-
-/**
- * Retrieve conclave challenge name for the given key and locale
- * @param {string} key key to retrieve
- * @param {string} dataOverride locale key override
- * @returns {{
- *   title: string,
- *   description: string,
- *   standing: number,
- * }} - The conclave challenge name for the given key
- */
-export const conclaveChallenge = (
-  key: string,
-  dataOverride: Locale = 'en'
-): {
-  title: string;
-  description: string;
-  standing: number;
-} => {
-  const splitKey = lastResourceName(String(key))!;
-
-  if (splitKey !== undefined && i18n(dataOverride).conclave?.challenges?.[splitKey]) {
-    return i18n(dataOverride).conclave.challenges[splitKey];
-  }
-  return {
-    title: toTitleCase(splitResourceName(splitKey)),
-    description: toTitleCase(splitResourceName(splitKey)),
-    standing: 0,
-  };
-};
-
-/**
- * Get the steel path data for given key
- * @param {string} dataOverride - The locale to use for translations
- * @returns {string} - The steel path data for the given key
- */
-export const steelPath = (dataOverride: Locale = 'en'): SteelPath =>
-  (i18n(dataOverride) || /* istanbul ignore next */ data).steelPath;
-
-const valMapping = (key: string, map: Record<string, string>) => {
-  let val = 'None';
-  Object.keys(map).forEach((k) => {
-    if (key.includes(k)) {
-      val = map[k];
-    }
-  });
-  return val;
-};
-
-const focusMap = {
-  'Focus/Attack': 'Madurai',
-  'Focus/Defense': 'Vazarin',
-  'Focus/Tactic': 'Naramon',
-  'Focus/Power': 'Zenurik',
-  'Focus/Ward': 'Unairu',
-};
-/**
- * Translate the given focus school
- * @param {string} focus The focus school to translate
- * @returns {string} The translated focus school
- */
-export const translateFocus = (focus: string = ''): string => valMapping(focus, focusMap);
-
-const polarityMap = {
-  AP_ATTACK: 'Madurai',
-  AP_DEFENSE: 'Vazarin',
-  AP_TACTIC: 'Naramon',
-  AP_POWER: 'Zenurik',
-  AP_WARD: 'Unairu',
-  AP_UMBRA: 'Umbra',
-  AP_ANY: 'Aura',
-};
-
-/**
- * Translate the given polarity
- * @param {string?} pol The polarity to translate
- * @returns {string} The translated polarity
- */
-export const translatePolarity = (pol: string = ''): string => valMapping(pol, polarityMap);
-
-const eventTypeMap = {
-  CET_CHALLENGE: 'To Do',
-  CET_UPGRADE: 'Override',
-  CET_REWARD: 'Big Prize!',
-  CET_PLOT: 'Birthday',
-};
-
-/**
- * Translate the given event key
- * @param {string} key Unique event type
- * @returns {string}
- */
-export const translateCalendarEvent = (key: string): string => valMapping(key, eventTypeMap);
-
-/**
- * Translate the given season name to a non-unique string
- * @param {string} season Unique season name
- * @returns {string}
- */
-export const translateSeason = (season: string): string => toTitleCase(season.replace('CST_', ''));
-
-const archimedeaTypes = {
-  CT_LAB: "Deep Archimedea",
-  CT_HEX: "Temporal Archimedea"
-}
-
-export const translateArchimedeaType = (type: string) => valMapping(type, archimedeaTypes);
-
-/**
- * An object containing functions to convert in-game names to their localizations
- * @typedef {Record<string, function>} Translator
- * @property {function} faction          - Converts faction names
- * @property {function} node             - Converts star map node names
- * @property {function} nodeMissionType  - Returns the mission type of given node
- * @property {function} nodeEnemy        - Returns the faction that controls a given node
- * @property {function} languageString   - Converts generic language strings
- * @property {function} languageDesc     - Converts generic language strings
- *                                          and retrieves the description
- * @property {function} missionType      - Converts mission types
- * @property {function} conclaveMode     - Converts conclave modes
- * @property {function} conclaveCategory - Converts conclave challenge categories
- * @property {function} fissureModifier  - Converts fissure mission modifiers
- * @property {function} syndicate        - Converts syndicate names
- * @property {function} upgrade          - Converts upgrade types
- * @property {function} operation        - Converts operation types
- * @property {function} sortieBoss       - Converts sortie boss names
- * @property {function} sortieModifier    - Converts sortie modifier types
- * @property {function} sortieModDesc    - Converts sortie modifier type descriptions
- * @property {function} region           - Converts persistent enemy region indicies
- * @property {function} conclaveChallenge - Convert conclave identifiers into standing data
- * @property {function} steelPath        -  Retrieve Steel Path rotation data for locale
- * @property {function} toTitleCase      - Format provided string as titlecase
- * @property {function} translateFocus   - Translate focus schools
- * @property {function} translatePolarity - Translate polarities
- * @property {function} archonShard      - Converts archon shard names
- * @property {function} archonShardColor - Converts archon shard names to in-game color values
- * @property {function} archonShardUpgradeType - Convert archon shard upgrade type
- * @property {function} translateCalendarEvent - Translate the given event key
- * @property {function} translateSeason - Translate the given season name to a non-unique string
- */
-export default {
-  faction,
-  node,
-  nodeMissionType,
-  nodeEnemy,
-  languageString,
-  languageDesc,
-  missionType,
-  conclaveMode,
-  conclaveCategory,
-  fissureModifier,
-  fissureTier,
-  syndicate,
-  upgrade,
-  operation,
-  operationSymbol,
-  sortieBoss,
-  sortieModifier,
-  sortieModDesc,
-  sortieFaction,
-  region,
-  conclaveChallenge,
-  steelPath,
-  toTitleCase,
-  translateFocus,
-  translatePolarity,
-  archonShard,
-  archonShardColor,
-  archonShardUpgradeType,
-  translateCalendarEvent,
-  translateSeason,
-};

package/tools/utilities.ts

@@ -1,5 +0,0 @@
-/* istanbul ignore file */
-
-export * from './integrity';
-export * from './timeDate';
-export * from './translation';

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "exclude": [
-    "node_modules"
-  ],
-  "compilerOptions": {
-    "module": "esnext",
-    "target": "es2024", // set to the *lowest* target you support
-    "strict": true,
-    "moduleResolution": "bundler",
-    "esModuleInterop": true,
-    "isolatedModules": true,
-  }
-}

package/tsdown.config.ts

@@ -1,15 +0,0 @@
-import { defineConfig } from 'tsdown';
-
-export default defineConfig({
-  entry: [
-    'exports.ts',
-    'safeImport.ts',
-    'types.ts',
-    './tools/timeDate.ts',
-    './tools/translation.ts',
-    './tools/utilities.ts',
-  ],
-  copy: ['./data'],
-  dts: true,
-  format: 'esm',
-});

package/types.ts

@@ -1,70 +0,0 @@
-export interface Arcane {
-  regex: string;
-  name: string;
-  effect: string;
-  rarity: string;
-  location: string;
-  thumbnail: string;
-}
-
-export interface ArchonShard {
-  value: string;
-  upgradeTypes: Record<string, { value: string }>;
-}
-
-export interface Conclave {
-  modes: Record<string, { value: string }>;
-  categories: Record<string, { value: string; description: string }>;
-  challenges: Record<string, { title: string; description: string; standing: number }>;
-  affectors: Record<string, { title: string; description: string; standing: number }>;
-}
-
-export interface Events {
-  tags: Record<string, { value: string }>;
-  scoreVariables: Record<string, { value: { value: string } }>;
-  scoreMaxTags: Record<string, { value: { value: string } }>;
-}
-
-export interface SteelPath {
-  rotation: SteelPathOffering[];
-  evergreen: SteelPathOffering[];
-}
-
-export interface SteelPathOffering {
-  name: string;
-  cost: number;
-}
-
-export interface SynthesisTarget {
-  name: string;
-  locations: SynthesisTargetLocation[];
-}
-
-interface SynthesisTargetLocation {
-  last_verified: string;
-  level: string;
-  spawn_rate: string;
-  mission: string;
-  planet: string;
-  type: string;
-  faction: string;
-}
-
-export interface SolNode {
-  value: string;
-  enemy: string;
-  type: string;
-}
-
-interface SortieEndState {
-  bossName: string;
-  regions: { name: string; missions: string[] }[];
-}
-
-export interface SortieData {
-  modifierTypes: Record<string, string>;
-  modifierDescriptions: Record<string, string>;
-  bosses: Record<string, { name: string; faction: string }>;
-  endStates: SortieEndState[];
-  modifiers: string[];
-}