refactor!: remove v8 deprecated type aliases (#2754)

faker-js · Mar 16, 2024 · 2ec602b · 2ec602b
1 parent 39648f2
commit 2ec602b
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 60 deletions.
diff --git a/docs/guide/upgrading_v9/2754.md b/docs/guide/upgrading_v9/2754.md
@@ -0,0 +1,31 @@
+### Remove deprecated type aliases
+
+Removed deprecated type aliases
+
+| old                              | replacement                     |
+| -------------------------------- | ------------------------------- |
+| `AddressDefinitions`             | `LocationDefinition`            |
+| `AirlineDefinitions`             | `AirlineDefinition`             |
+| `AnimalDefinitions`              | `AnimalDefinition`              |
+| `ColorDefinitions`               | `ColorDefinition`               |
+| `CommerceDefinitions`            | `CommerceDefinition`            |
+| `CommerceProductNameDefinitions` | `CommerceProductNameDefinition` |
+| `CompanyDefinitions`             | `CompanyDefinition`             |
+| `DatabaseDefinitions`            | `DatabaseDefinition`            |
+| `DateDefinitions`                | `DateDefinition`                |
+| `FinanceDefinitions`             | `FinanceDefinition`             |
+| `HackerDefinitions`              | `HackerDefinition`              |
+| `InternetDefinitions`            | `InternetDefinition`            |
+| `LoremDefinitions`               | `LoremDefinition`               |
+| `MusicDefinitions`               | `MusicDefinition`               |
+| `NameDefinitions`                | `PersonDefinition`              |
+| `PhoneNumberDefinitions`         | `PhoneNumberDefinition`         |
+| `ScienceDefinitions`             | `ScienceDefinition`             |
+| `SystemDefinitions`              | `SystemDefinition`              |
+| `SystemMimeTypeEntryDefinitions` | `SystemMimeTypeEntryDefinition` |
+| `VehicleDefinitions`             | `VehicleDefinition`             |
+| `WordDefinitions`                | `WordDefinition`                |
+| `CSSFunction`                    | `CssFunctionType`               |
+| `CSSSpace`                       | `CssSpaceType`                  |
+| `AddressModule`                  | `LocationModule`                |
+| `NameModule`                     | `PersonModule`                  |
diff --git a/src/index.ts b/src/index.ts
@@ -1,73 +1,30 @@
-// organize-imports-ignore
 export type {
-  /** @deprecated Use LocationDefinitions instead */
-  LocationDefinition as AddressDefinitions,
   AirlineDefinition,
-  /** @deprecated Use AirlineDefinition instead */
-  AirlineDefinition as AirlineDefinitions,
   AnimalDefinition,
-  /** @deprecated Use AnimalDefinition instead */
-  AnimalDefinition as AnimalDefinitions,
   ColorDefinition,
-  /** @deprecated Use ColorDefinition instead */
-  ColorDefinition as ColorDefinitions,
   CommerceDefinition,
-  /** @deprecated Use CommerceDefinition instead */
-  CommerceDefinition as CommerceDefinitions,
   CommerceProductNameDefinition,
-  /** @deprecated Use CommerceProductNameDefinition instead */
-  CommerceProductNameDefinition as CommerceProductNameDefinitions,
   CompanyDefinition,
-  /** @deprecated Use CompanyDefinition instead */
-  CompanyDefinition as CompanyDefinitions,
   DatabaseDefinition,
-  /** @deprecated Use DatabaseDefinition instead */
-  DatabaseDefinition as DatabaseDefinitions,
   DateDefinition,
-  /** @deprecated Use DateDefinition instead */
-  DateDefinition as DateDefinitions,
   DateEntryDefinition,
   FinanceDefinition,
-  /** @deprecated Use FinanceDefinition instead */
-  FinanceDefinition as FinanceDefinitions,
   FoodDefinition,
   HackerDefinition,
-  /** @deprecated Use HackerDefinition instead */
-  HackerDefinition as HackerDefinitions,
   InternetDefinition,
-  /** @deprecated Use InternetDefinition instead */
-  InternetDefinition as InternetDefinitions,
   LocaleDefinition,
   LocaleEntry,
   LocationDefinition,
   LoremDefinition,
-  /** @deprecated Use LoremDefinition instead */
-  LoremDefinition as LoremDefinitions,
   MetadataDefinition,
   MusicDefinition,
-  /** @deprecated Use MusicDefinition instead */
-  MusicDefinition as MusicDefinitions,
-  /** @deprecated Use PersonDefinitions instead */
-  PersonDefinition as NameDefinitions,
   PersonDefinition,
   PhoneNumberDefinition,
-  /** @deprecated Use PhoneNumberDefinition instead */
-  PhoneNumberDefinition as PhoneNumberDefinitions,
   ScienceDefinition,
-  /** @deprecated Use ScienceDefinition instead */
-  ScienceDefinition as ScienceDefinitions,
   SystemDefinition,
-  /** @deprecated Use SystemDefinition instead */
-  SystemDefinition as SystemDefinitions,
   SystemMimeTypeEntryDefinition,
-  /** @deprecated Use SystemMimeTypeEntryDefinition instead */
-  SystemMimeTypeEntryDefinition as SystemMimeTypeEntryDefinitions,
   VehicleDefinition,
-  /** @deprecated Use VehicleDefinition instead */
-  VehicleDefinition as VehicleDefinitions,
   WordDefinition,
-  /** @deprecated Use WordDefinition instead */
-  WordDefinition as WordDefinitions,
 } from './definitions';
 export { FakerError } from './errors/faker-error';
 export { Faker } from './faker';
@@ -85,10 +42,6 @@ export type { AircraftType, AirlineModule } from './modules/airline';
 export type { AnimalModule } from './modules/animal';
 export { CssFunction, CssSpace } from './modules/color';
 export type {
-  /** @deprecated Use CssFunctionType instead */
-  CssFunctionType as CSSFunction,
-  /** @deprecated Use CssSpaceType instead */
-  CssSpaceType as CSSSpace,
   Casing,
   ColorFormat,
   ColorModule,
@@ -109,21 +62,12 @@ export type { HackerModule } from './modules/hacker';
 export type { HelpersModule, SimpleHelpersModule } from './modules/helpers';
 export type { ImageModule } from './modules/image';
 export type { InternetModule } from './modules/internet';
-export type {
-  /** @deprecated Use LocationModule instead */
-  LocationModule as AddressModule,
-  LocationModule,
-} from './modules/location';
+export type { LocationModule } from './modules/location';
 export type { LoremModule } from './modules/lorem';
 export type { MusicModule } from './modules/music';
 export type { NumberModule } from './modules/number';
 export { Sex } from './modules/person';
-export type {
-  /** @deprecated Use PersonModule instead */
-  PersonModule as NameModule,
-  PersonModule,
-  SexType,
-} from './modules/person';
+export type { PersonModule, SexType } from './modules/person';
 export type { PhoneModule } from './modules/phone';
 export type { ChemicalElement, ScienceModule, Unit } from './modules/science';
 export type { StringModule } from './modules/string';

diff --git a/src/locales/base/system/mimeTypes.ts b/src/locales/base/system/mimeTypes.ts
@@ -1,4 +1,4 @@
-import type { SystemDefinitions } from '../../..';
+import type { SystemDefinition } from '../../..';
 
 export default {
   'application/epub+zip': {
@@ -240,4 +240,4 @@ export default {
   'video/x-msvideo': {
     extensions: ['avi'],
   },
-} satisfies SystemDefinitions['mimeTypes'];
+} satisfies SystemDefinition['mimeTypes'];