Refactor enums to mapped objects

Author: minht11

lib/apev2/APEv2Token.ts

@@ -83,12 +83,13 @@ export interface IFooter {
   flags: ITagFlags // ToDo: what is this???
 }
 
-export enum DataType {
-  text_utf8 = 0,
-  binary = 1,
-  external_info = 2,
-  reserved = 3
+export const DataType = {
+  text_utf8: 0,
+  binary: 1,
+  external_info: 2,
+  reserved: 3
 }
+export type DataType = typeof DataType[keyof typeof DataType]
 
 /**
  * APE_DESCRIPTOR: defines the sizes (and offsets) of all the pieces, as well as the MD5 checksum

lib/asf/AsfObject.ts

@@ -16,32 +16,33 @@ export class AsfContentParseError extends makeUnexpectedFileContentError('ASF'){
 /**
  * Data Type: Specifies the type of information being stored. The following values are recognized.
  */
-export enum DataType {
+export const DataType = {
   /**
    * Unicode string. The data consists of a sequence of Unicode characters.
    */
-  UnicodeString = 0,
+  UnicodeString: 0,
   /**
    * BYTE array. The type of data is implementation-specific.
    */
-  ByteArray = 1,
+  ByteArray: 1,
   /**
    * BOOL. The data is 2 bytes long and should be interpreted as a 16-bit unsigned integer. Only 0x0000 or 0x0001 are permitted values.
    */
-  Bool = 2,
+  Bool: 2,
   /**
    * DWORD. The data is 4 bytes long and should be interpreted as a 32-bit unsigned integer.
    */
-  DWord = 3,
+  DWord: 3,
   /**
    * QWORD. The data is 8 bytes long and should be interpreted as a 64-bit unsigned integer.
    */
-  QWord = 4,
+  QWord: 4,
   /**
    * WORD. The data is 2 bytes long and should be interpreted as a 16-bit unsigned integer.
    */
-  Word = 5
+  Word: 5
 }
+export type DataType = typeof DataType[keyof typeof DataType]
 
 /**
  * Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/ee663575
@@ -607,7 +608,7 @@ export class WmPictureToken implements IGetToken<IWmPicture> {
     const description = new Token.StringType(index - 5, 'utf-16le').get(buffer, 5);
 
     return {
-      type: AttachedPictureType[typeId],
+      type: AttachedPictureType[typeId as keyof typeof AttachedPictureType],
       format,
       description,
       size,

lib/common/MetadataCollector.ts

@@ -2,7 +2,7 @@ import {
   type FormatId,
   type IAudioMetadata, type ICommonTagsResult,
   type IFormat,
-  type INativeTags, type IOptions, type IQualityInformation, type IPicture, type ITrackInfo, TrackType, type IComment, type AnyTagValue
+  type INativeTags, type IOptions, type IQualityInformation, type IPicture, type ITrackInfo, TrackTypeValueToKeyMap, type IComment, type AnyTagValue
 } from '../type.js';
 
 import initDebug from 'debug';
@@ -109,7 +109,7 @@ export class MetadataCollector implements INativeMetadataCollector {
   }
 
   public addStreamInfo(streamInfo: ITrackInfo) {
-    debug(`streamInfo: type=${streamInfo.type ? TrackType[streamInfo.type] : '?'}, codec=${streamInfo.codecName}`);
+    debug(`streamInfo: type=${streamInfo.type ? TrackTypeValueToKeyMap[streamInfo.type] : '?'}, codec=${streamInfo.codecName}`);
     this.format.trackInfo.push(streamInfo);
   }
 

lib/dsf/DsfChunk.ts

@@ -60,16 +60,16 @@ export const DsdChunk: IGetToken<IDsdChunk> = {
     };
   }
 };
-
-export enum ChannelType {
-  mono = 1,
-  stereo = 2,
-  channels = 3,
-  quad = 4,
-  '4 channels' = 5,
-  '5 channels' = 6,
-  '5.1 channels' = 7
+export const ChannelType = {
+  mono: 1,
+  stereo: 2,
+  channels: 3,
+  quad: 4,
+  '4 channels': 5,
+  '5 channels': 6,
+  '5.1 channels': 7
 }
+export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
 
 /**
  * Interface to format chunk payload chunk

lib/ebml/EbmlIterator.ts

@@ -18,13 +18,15 @@ export interface ILinkedElementType extends IElementType {
   readonly container?: { [id: number]: ILinkedElementType; };
 }
 
-export enum ParseAction {
-  ReadNext = 0,           // Continue reading the next elements
-  IgnoreElement = 2,      // Ignore (do not read) this element
-  SkipSiblings = 3,       // Skip all remaining elements at the same level
-  TerminateParsing = 4,   // Terminate the parsing process
-  SkipElement = 5         // Consider the element has read, assume position is at the next element
-}
+export const ParseAction = {
+  ReadNext: 0,           // Continue reading the next elements
+  IgnoreElement: 2,      // Ignore (do not read) this element
+  SkipSiblings: 3,       // Skip all remaining elements at the same level
+  TerminateParsing: 4,   // Terminate the parsing process
+  SkipElement: 5         // Consider the element has read, assume position is at the next element
+} as const;
+
+export type ParseAction = typeof ParseAction[keyof typeof ParseAction];
 
 /**
  * @return true, to quit the parser

lib/ebml/types.ts

@@ -1,6 +1,14 @@
 export interface ITree { [name: string]: string | number | boolean | Uint8Array | ITree | ITree[]; }
 
-export enum DataType { 'string' = 0, uint = 1, uid = 2, bool = 3, binary = 4, float = 5}
+export const DataType = {
+  string: 0,
+  uint: 1,
+  uid: 2,
+  bool: 3,
+  binary: 4,
+  float: 5,
+} as const;
+export type DataType = typeof DataType[keyof typeof DataType];
 
 export type ValueType = string | number | Uint8Array | boolean | ITree | ITree[];
 

lib/flac/FlacParser.ts

@@ -19,15 +19,16 @@ class FlacContentError extends makeUnexpectedFileContentError('FLAC'){
  * FLAC supports up to 128 kinds of metadata blocks; currently the following are defined:
  * ref: https://xiph.org/flac/format.html#metadata_block
  */
-enum BlockType {
-  STREAMINFO = 0,
-  PADDING = 1,
-  APPLICATION = 2,
-  SEEKTABLE = 3,
-  VORBIS_COMMENT = 4,
-  CUESHEET = 5,
-  PICTURE = 6
-}
+const BlockType = {
+  STREAMINFO: 0, // STREAMINFO
+  PADDING: 1, // PADDING
+  APPLICATION: 2, // APPLICATION
+  SEEKTABLE: 3, // SEEKTABLE
+  VORBIS_COMMENT: 4, // VORBIS_COMMENT
+  CUESHEET: 5, // CUESHEET
+  PICTURE: 6 // PICTURE
+};
+type BlockType = typeof BlockType[keyof typeof BlockType];
 
 export class FlacParser extends AbstractID3Parser {
 

lib/id3v2/FrameParser.ts

@@ -210,7 +210,7 @@ export class FrameParser {
 
           pic.format = FrameParser.fixPictureMimeType(pic.format);
 
-          pic.type = AttachedPictureType[uint8Array[offset]];
+          pic.type = AttachedPictureType[uint8Array[offset] as keyof typeof AttachedPictureType];
           offset += 1;
 
           fzero = util.findZero(uint8Array, offset, length, encoding);

lib/id3v2/ID3v2Token.ts

@@ -7,28 +7,28 @@ import * as util from '../common/Util.js';
  * The picture type according to the ID3v2 APIC frame
  * Ref: http://id3.org/id3v2.3.0#Attached_picture
  */
-export enum AttachedPictureType {
-  'Other' = 0,
-  "32x32 pixels 'file icon' (PNG only)" = 1,
-  'Other file icon' = 2,
-  'Cover (front)' = 3,
-  'Cover (back)' = 4,
-  'Leaflet page' = 5,
-  'Media (e.g. label side of CD)' = 6,
-  'Lead artist/lead performer/soloist' = 7,
-  'Artist/performer' = 8,
-  'Conductor' = 9,
-  'Band/Orchestra' = 10,
-  'Composer' = 11,
-  'Lyricist/text writer' = 12,
-  'Recording Location' = 13,
-  'During recording' = 14,
-  'During performance' = 15,
-  'Movie/video screen capture' = 16,
-  'A bright coloured fish' = 17,
-  'Illustration' = 18,
-  'Band/artist logotype' = 19,
-  'Publisher/Studio logotype' = 20
+export const AttachedPictureType = {
+  0: 'Other',
+  1: "32x32 pixels 'file icon' (PNG only)",
+  2: 'Other file icon',
+  3: 'Cover (front)',
+  4: 'Cover (back)',
+  5: 'Leaflet page',
+  6: 'Media (e.g. label side of CD)',
+  7: 'Lead artist/lead performer/soloist',
+  8: 'Artist/performer',
+  9: 'Conductor',
+  10: 'Band/Orchestra',
+  11: 'Composer',
+  12: 'Lyricist/text writer',
+  13: 'Recording Location',
+  14: 'During recording',
+  15: 'During performance',
+  16: 'Movie/video screen capture',
+  17: 'A bright coloured fish',
+  18: 'Illustration',
+  19: 'Band/artist logotype',
+  20: 'Publisher/Studio logotype'
 }
 
 export type ID3v2MajorVersion = 2 | 3 | 4;
@@ -46,21 +46,23 @@ export interface IExtendedHeader {
 /**
  * https://id3.org/id3v2.3.0#Synchronised_lyrics.2Ftext
  */
-export enum LyricsContentType {
-  other = 0,
-  lyrics = 1,
-  text = 2,
-  movement_part = 3,
-  events = 4,
-  chord = 5,
-  trivia_pop = 6
-}
+export const LyricsContentType = {
+  other: 0,
+  lyrics: 1,
+  text: 2,
+  movement_part: 3,
+  events: 4,
+  chord: 5,
+  trivia_pop: 6,
+};
+export type LyricsContentType = typeof LyricsContentType[keyof typeof LyricsContentType];
 
-export enum TimestampFormat {
-  notSynchronized0 = 0,
-  mpegFrameNumber = 1,
-  milliseconds = 2
-}
+export const TimestampFormat = {
+  notSynchronized0: 0,
+  mpegFrameNumber: 1,
+  milliseconds: 2
+};
+export type TimestampFormat = typeof TimestampFormat[keyof typeof TimestampFormat];
 
 /**
  * 28 bits (representing up to 256MB) integer, the msb is 0 to avoid 'false syncsignals'.

lib/matroska/types.ts

@@ -91,33 +91,43 @@ export interface ISimpleTag {
   default?: boolean;
 }
 
-export enum TargetType {
-  shot = 10,
-  scene = 20,
-  track = 30,
-  part = 40,
-  album = 50,
-  edition = 60,
-  collection = 70
+export const TargetType = {
+  10: 'shot',
+  20: 'scene',
+  30: 'track',
+  40: 'part',
+  50: 'album',
+  60: 'edition',
+  70: 'collection'
+}
+
+export const TrackType = {
+  video: 0x01,
+  audio: 0x02,
+  complex: 0x03,
+  logo: 0x04,
+  subtitle: 0x11,
+  button: 0x12,
+  control: 0x20
+};
+export type TrackType = typeof TrackType[keyof typeof TrackType];
+export type TrackTypeKey = keyof typeof TrackType;
+
+export const TrackTypeValueToKeyMap: Record<TrackType, TrackTypeKey> = {
+  [TrackType.video]: 'video',
+  [TrackType.audio]: 'audio',
+  [TrackType.complex]: 'complex',
+  [TrackType.logo]: 'logo',
+  [TrackType.subtitle]: 'subtitle',
+  [TrackType.button]: 'button',
+  [TrackType.control]: 'control'
 }
 
-export enum TrackType {
-  video = 0x01,
-  audio = 0x02,
-  complex = 0x03,
-  logo = 0x04,
-  subtitle= 0x11,
-  button = 0x12,
-  control = 0x20
-}
-
-export type TrackTypeKey = keyof TrackType;
-
 export interface ITarget {
   trackUID?: Uint8Array;
   chapterUID?: Uint8Array;
   attachmentUID?: Uint8Array;
-  targetTypeValue?: TargetType;
+  targetTypeValue?: keyof typeof TargetType;
   targetType?: string;
 }