aboutsummaryrefslogtreecommitdiff
path: root/src/definitions/definitions.ts
blob: 30f965c30a915694f0c1548291ab552c49a7621d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
import type { AirlineDefinition } from './airline';
import type { AnimalDefinition } from './animal';
import type { ColorDefinition } from './color';
import type { CommerceDefinition } from './commerce';
import type { CompanyDefinition } from './company';
import type { DatabaseDefinition } from './database';
import type { DateDefinition } from './date';
import type { FinanceDefinition } from './finance';
import type { HackerDefinition } from './hacker';
import type { InternetDefinition } from './internet';
import type { LocationDefinition } from './location';
import type { LoremDefinition } from './lorem';
import type { MetadataDefinition } from './metadata';
import type { MusicDefinition } from './music';
import type { PersonDefinition } from './person';
import type { PhoneNumberDefinition } from './phone_number';
import type { ScienceDefinition } from './science';
import type { SystemDefinition } from './system';
import type { VehicleDefinition } from './vehicle';
import type { WordDefinition } from './word';

/**
 * Wrapper type for all definition categories that will make all properties optional and allow extra properties.
 */
export type LocaleEntry<T extends Record<string, unknown>> = {
  [P in keyof T]?: T[P] | null;
} & Record<string, unknown>; // Unsupported & custom entries

/**
 * The definitions as used by the translations/locales.
 */
export type LocaleDefinition = {
  metadata?: MetadataDefinition;
  airline?: AirlineDefinition;
  animal?: AnimalDefinition;
  color?: ColorDefinition;
  commerce?: CommerceDefinition;
  company?: CompanyDefinition;
  database?: DatabaseDefinition;
  date?: DateDefinition;
  finance?: FinanceDefinition;
  hacker?: HackerDefinition;
  internet?: InternetDefinition;
  location?: LocationDefinition;
  lorem?: LoremDefinition;
  music?: MusicDefinition;
  person?: PersonDefinition;
  phone_number?: PhoneNumberDefinition;
  science?: ScienceDefinition;
  system?: SystemDefinition;
  vehicle?: VehicleDefinition;
  word?: WordDefinition;
} & Record<string, Record<string, unknown> | undefined>;