@mkody/twitch-emoticons 2.9.6 → 3.0.0-beta.2

package/typings/index.d.ts

@@ -1,124 +1,241 @@
-declare module '@mkody/twitch-emoticons' {
-    export class Channel {
-        public constructor(fetcher: EmoteFetcher, id: number);
+export class Channel {
+  public constructor (
+    fetcher: EmoteFetcher,
+    id: number
+  )
 
-        public fetcher: EmoteFetcher;
-        public id: number;
-        public emotes: Collection<string, Emote>;
+  public fetcher: EmoteFetcher
+  public id: number
+  public emotes: Collection<string, Emote>
 
-        public fetchBTTVEmotes(): Promise<Collection<string, BTTVEmote>>;
-        public fetchFFZEmotes(): Promise<Collection<string, FFZEmote>>;
-        public fetchSevenTVEmotes(): Promise<Collection<string, SevenTVEmote>>;
-    }
+  public fetchBTTVEmotes (): Promise<Collection<string, BTTVEmote>>
 
-    export abstract class Emote {
-        public constructor(channel: Channel, id: string, data: object);
+  public fetchFFZEmotes (): Promise<Collection<string, FFZEmote>>
 
-        public fetcher: EmoteFetcher;
-        public channel: Channel;
-        public id: string;
-        public type: 'twitch' | 'bttv' | 'ffz' | '7tv';
-        public code: string;
-    }
+  public fetchSevenTVEmotes (): Promise<Collection<string, SevenTVEmote>>
+}
 
-    export class EmoteFetcher {
-        public constructor(
-            clientId?: string,
-            clientSecret?: string,
-            options?: {
-                apiClient?: object
-            }
-        );
-
-        public emotes: Collection<string, Emote>;
-        public channels: Collection<string, Channel>;
-
-        public fetchTwitchEmotes(id?: number): Promise<Collection<string, TwitchEmote>>;
-        public fetchBTTVEmotes(id?: number): Promise<Collection<string, BTTVEmote>>;
-        public fetchFFZEmotes(id?: number): Promise<Collection<string, FFZEmote>>;
-        public fetchSevenTVEmotes(id?: number, format?: 'webp' | 'avif'): Promise<Collection<string, SevenTVEmote>>;
-        public fromObject(emotesArray: EmoteObject[]): Emote[];
-    }
+export abstract class Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public fetcher: EmoteFetcher
+  public channel: Channel
+  public id: string
+  public type: 'twitch' | 'bttv' | 'ffz' | '7tv' | null
+  public code: string
+}
 
-    export class EmoteParser {
-        public constructor(
-            fetcher: EmoteFetcher, 
-            options: {
-                template?: string,
-                type?: 'html' | 'markdown' | 'bbcode' | 'plain',
-                match?: RegExp
-            }
-        );
-
-        public parse(text: string, size?: number): string;
+export class EmoteFetcher {
+  public constructor (
+    options?: {
+      twitchAppID?: string,
+      twitchAppSecret?: string,
+      apiClient?: object,
+      forceStatic?: boolean,
+      twitchThemeMode?: 'dark' | 'light'
     }
+  )
 
-    export class TwitchEmote extends Emote {
-        public constructor(channel: Channel, id: string, data: object);
-
-        public set?: string;
-        public animated: boolean;
-        public imageType: 'png' | 'gif';
-        public readonly owner: Channel;
+  public emotes: Collection<string, Emote>
+  public channels: Collection<string, Channel>
+  public forceStatic: boolean
+  public twitchThemeMode: 'dark' | 'light'
 
-        public toLink(size: number): string;
-        public toObject(): EmoteObject;
-    }
+  public fetchTwitchEmotes (
+    id?: number
+  ): Promise<Collection<string, TwitchEmote>>
 
-    export class BTTVEmote extends Emote {
-        public constructor(channel: Channel, id: string, data: any);
+  public fetchBTTVEmotes (
+    id?: number
+  ): Promise<Collection<string, BTTVEmote>>
 
-        public ownerName: string | null;
-        public animated: boolean;
-        public imageType: 'webp';
-        public readonly owner?: Channel;
+  public fetchFFZEmotes (
+    id?: number
+  ): Promise<Collection<string, FFZEmote>>
 
-        public toLink(size: number): string;
-        public toObject(): EmoteObject;
+  public fetchSevenTVEmotes (
+    id?: number,
+    options?: {
+      format?: 'webp' | 'avif'
     }
+  ): Promise<Collection<string, SevenTVEmote>>
 
-    export class FFZEmote extends Emote {
-        public constructor(channel: Channel, id: string, data: object);
-
-        public ownerName: string | null;
-        public sizes: string[];
-        public animated: boolean;
-        public imageType: 'png' | 'webp';
-        public modifier: boolean;
-        public readonly owner?: Channel;
+  public fromObject (
+    emotesArray: EmoteObject[]
+  ): Emote[]
+}
 
-        public toLink(size: number): string;
-        public toObject(): EmoteObject;
+export class EmoteParser {
+  public constructor (
+    fetcher: EmoteFetcher,
+    options?: {
+      template?: string,
+      type?: 'html' | 'markdown' | 'bbcode' | 'plain',
+      match?: RegExp
+    }
+  )
+
+  public parse (
+    text: string,
+    options?: {
+      size?: number,
+      forceStatic?: boolean,
+      themeMode?: 'dark' | 'light'
     }
+  ): string
+}
 
-    export class SevenTVEmote extends Emote {
-        public constructor(channel: Channel, id: string, data: object);
+export class TwitchEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public set?: string;
+  public animated: boolean
+  public imageType: 'png' | 'gif'
+  public readonly owner: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean,
+      themeMode?: 'dark' | 'light'
+    }
+  ): string
 
-        public ownerName: string | null;
-        public sizes: string[];
-        public animated: boolean;
-        public imageType: 'webp' | 'avif';
-        public readonly owner?: Channel;
+  public toObject (): EmoteObject
+}
 
-        public toLink(size: number): string;
-        public toObject(): EmoteObject;
+export class BTTVEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: any
+  )
+
+  public ownerName: string | null
+  public animated: boolean
+  public imageType: 'webp'
+  public readonly owner?: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean
     }
+  ): string
 
-    export interface EmoteObject {
-        code: string,
-        id: string,
-        channel_id: string,
-        type: 'twitch' | 'bttv' | 'ffz' | '7tv'
-        animated?: boolean,
-        ownerName?: string,
-        sizes?: string[],
-        set?: string,
-        imageType?: string
+  public toObject (): EmoteObject
+}
+
+export class FFZEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public ownerName: string | null
+  public sizes: string[]
+  public animated: boolean
+  public imageType: 'png' | 'webp'
+  public modifier: boolean
+  public readonly owner?: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean
     }
+  ): string
+
+  public toObject (): EmoteObject
+}
 
-    export class Collection<K, V> extends Map<K, V> {
-        public find(propOrFunc: string | ((item: V, index: number, coll: this) => boolean), value?: any): V;
-        public filter(func: (item: V, index: number, coll: this) => boolean): Collection<K, V>;
-        public map(func: (item: V, index: number, coll: this) => any): Array<any>;
+export class SevenTVEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public ownerName: string | null
+  public sizes: string[]
+  public animated: boolean
+  public imageType: 'webp' | 'avif'
+  public readonly owner?: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean
     }
+  ): string
+
+  public toObject (): EmoteObject
+}
+
+export interface EmoteObject {
+  code: string,
+  id: string,
+  channel_id: string | null,
+  type: 'twitch' | 'bttv' | 'ffz' | '7tv' | null,
+  animated?: boolean,
+  ownerName?: string,
+  sizes?: string[],
+  set?: string,
+  imageType?: string
+}
+
+export declare const Constants: {
+  Twitch: {
+    CDN: (id: string, size?: number, forceStatic?: boolean, theme?: 'dark' | 'light') => string;
+  };
+  BTTV: {
+    Global: string;
+    Channel: (id: string) => string;
+    CDN: (id: string, size?: number, forceStatic?: boolean) => string;
+  };
+  SevenTV: {
+    Global: string;
+    Channel: (id: string) => string;
+    CDN: (id: string, format: string, size?: number, forceStatic?: boolean) => string;
+  };
+  FFZ: {
+    sets: {
+      Global: number;
+      Modifiers: number;
+    };
+    Set: (id: string) => string;
+    Channel: (id: string) => string;
+    CDN: (id: string, size?: number) => string;
+    CDNAnimated: (id: string, size?: number) => string;
+  };
+  Templates: {
+    html: string;
+    markdown: string;
+    bbcode: string;
+    plain: string;
+  };
+}
+
+export class Collection<K, V> extends Map<K, V> {
+  public find (
+    propOrFunc: string | ((item: V, index: number, coll: this) => boolean),
+    value?: any
+  ): V
+
+  public filter (
+    func: (item: V, index: number, coll: this) => boolean
+  ): Collection<K, V>
+
+  public map (
+    func: (item: V, index: number, coll: this) => any
+  ): Array<any>
 }

package/.jsdoc.json

@@ -1,46 +0,0 @@
-{
-    "tags": {
-        "allowUnknownTags": true,
-        "dictionaries": ["jsdoc"]
-    },
-    "source": {
-        "include": ["README.md", "src/struct", "src/util", "package.json"],
-        "includePattern": ".js$",
-        "excludePattern": "(node_modules/|docs)"
-    },
-    "templates": {
-        "cleverLinks": false,
-        "monospaceLinks": true,
-        "useLongnameInNav": false,
-        "default": {
-            "includeDate": false
-        }
-    },
-    "opts": {
-        "destination": "./docs",
-        "encoding": "utf8",
-        "private": true,
-        "recurse": true,
-        "verbose": true,
-        "template": "./node_modules/docdash"
-    },
-    "plugins": ["plugins/markdown"],
-    "markdown": {
-        "hardwrap": true
-    },
-    "docdash": {
-        "sort": false,
-        "private": false,
-        "menu": {
-            "GitHub": {
-                "href":"https://github.com/mkody/twitch-emoticons",
-                "target":"_blank",
-                "class":"menu-item",
-                "id":"github_link"
-            }
-        },
-        "scopeInOutputPath": false,
-        "nameInOutputPath": false,
-        "versionInOutputPath": false
-    }
-}

package/.nvmrc

@@ -1 +0,0 @@
-24