Use additional return instead of option

josh-hemphill · Oct 29, 2023 · 9451383 · 9451383
1 parent 2676cbd
commit 9451383
Show file tree

Hide file tree

Showing 26 changed files with 5,294 additions and 89 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -19,11 +19,8 @@ export const config = {
   defaults: defaultOptions,
 };
 
-export type FaviconHtmlElement = {
-  readonly tag: string;
-  readonly attrs: Record<string, string | boolean>;
-};
-export class FaviconElement implements FaviconHtmlElement {
+export type FaviconHtmlElement = string;
+export class FaviconHtmlTag {
   readonly tag: string;
   readonly attrs: Record<string, string | boolean>;
 
@@ -46,25 +43,18 @@ export class FaviconElement implements FaviconHtmlElement {
   }
 }
 
-export interface FaviconResponse<T> {
+export interface FaviconResponse {
   readonly images: FaviconImage[];
   readonly files: FaviconFile[];
-  readonly html: T[];
+  readonly html: FaviconHtmlElement[];
+  readonly htmlTags: FaviconHtmlTag[];
 }
 
 export type FaviconsSource = string | Buffer | (string | Buffer)[];
-export async function favicons(
-  source: FaviconsSource,
-  options: FaviconOptions & { readonly htmlUnStringified: true },
-): Promise<FaviconResponse<FaviconElement>>;
-export async function favicons(
-  source: FaviconsSource,
-  options: FaviconOptions & { readonly htmlUnStringified: false },
-): Promise<FaviconResponse<string>>;
 export async function favicons(
   source: FaviconsSource,
   options: FaviconOptions & { readonly htmlUnStringified?: boolean } = {},
-): Promise<FaviconResponse<FaviconElement | string>> {
+): Promise<FaviconResponse> {
   options = {
     ...defaultOptions,
     ...options,
@@ -82,7 +72,7 @@ export async function favicons(
       return a.localeCompare(b);
     });
 
-  const responses: FaviconResponse<FaviconElement | string>[] = [];
+  const responses: FaviconResponse[] = [];
 
   for (const platformName of platforms) {
     const platform = getPlatform(platformName, options);
@@ -94,6 +84,7 @@ export async function favicons(
     images: responses.flatMap((r) => r.images),
     files: responses.flatMap((r) => r.files),
     html: responses.flatMap((r) => r.html),
+    htmlTags: responses.flatMap((r) => r.htmlTags),
   };
 }
 
@@ -105,23 +96,18 @@ export interface FaviconStreamOptions extends FaviconOptions {
   readonly emitBuffers?: boolean;
 }
 
-export type HandleHTML<K> = (html: K[]) => void;
+export type HandleHTML = (
+  html: FaviconHtmlElement[],
+  htmlTags: FaviconHtmlTag[],
+) => void;
 
-class FaviconStream<T> extends Transform {
+class FaviconStream extends Transform {
   #options: FaviconStreamOptions & { readonly htmlUnStringified?: boolean };
-  #handleHTML: HandleHTML<T extends true ? FaviconElement : string>;
+  #handleHTML: HandleHTML;
 
-  constructor(
-    options: FaviconStreamOptions & { readonly htmlUnStringified: T & false },
-    handleHTML: HandleHTML<T extends true ? FaviconElement : string>,
-  );
-  constructor(
-    options: FaviconStreamOptions & { readonly htmlUnStringified: T & true },
-    handleHTML: HandleHTML<T extends true ? FaviconElement : string>,
-  );
   constructor(
     options: FaviconStreamOptions & { readonly htmlUnStringified?: boolean },
-    handleHTML: HandleHTML<T extends true ? FaviconElement : string>,
+    handleHTML: HandleHTML,
   ) {
     super({ objectMode: true });
     this.#options = options;
@@ -136,7 +122,7 @@ class FaviconStream<T> extends Transform {
     const { html: htmlPath, pipeHTML, ...options } = this.#options;
 
     favicons(file, { ...options, htmlUnStringified: true })
-      .then(({ images, files, html }) => {
+      .then(({ images, files, html, htmlTags }) => {
         for (const { name, contents } of [...images, ...files]) {
           this.push({
             name,
@@ -145,9 +131,7 @@ class FaviconStream<T> extends Transform {
         }
 
         if (this.#handleHTML) {
-          this.#handleHTML(
-            <(T extends true ? FaviconElement : string)[]>(<unknown>html),
-          );
+          this.#handleHTML(html, htmlTags);
         }
 
         if (pipeHTML) {
@@ -169,20 +153,6 @@ class FaviconStream<T> extends Transform {
   }
 }
 
-export function stream<T>(
-  options: FaviconStreamOptions & { readonly htmlUnStringified: T & false },
-  handleHTML: HandleHTML<T extends true ? FaviconElement : string>,
-): FaviconStream<false>;
-export function stream<T>(
-  options: FaviconStreamOptions & { readonly htmlUnStringified: T & true },
-  handleHTML: HandleHTML<T extends true ? FaviconElement : string>,
-): FaviconStream<true>;
-export function stream<T>(
-  options: FaviconStreamOptions & { readonly htmlUnStringified: T },
-  handleHTML: HandleHTML<T extends true ? FaviconElement : string>,
-) {
-  return new FaviconStream(
-    options as typeof options & { readonly htmlUnStringified: T & true },
-    handleHTML,
-  ) as T extends true ? FaviconStream<true> : FaviconStream<false>;
+export function stream(options: FaviconStreamOptions, handleHTML: HandleHTML) {
+  return new FaviconStream(options, handleHTML);
 }
diff --git a/src/platforms/android.ts b/src/platforms/android.ts
@@ -1,5 +1,5 @@
 import escapeHtml from "escape-html";
-import { FaviconElement, FaviconFile, FaviconImage } from "../index";
+import { FaviconHtmlTag, FaviconFile, FaviconImage } from "../index";
 import {
   FaviconOptions,
   IconOptions,
@@ -136,32 +136,32 @@ export class AndroidPlatform extends Platform {
     return [this.manifest()];
   }
 
-  override async createHtml(): Promise<FaviconElement[]> {
+  override async createHtml(): Promise<FaviconHtmlTag[]> {
     return [
       this.options.loadManifestWithCredentials
-        ? new FaviconElement("link", {
+        ? new FaviconHtmlTag("link", {
             rel: "manifest",
             href: this.cacheBusting(this.relative(this.manifestFileName())),
             crossOrigin: "use-credentials",
           })
-        : new FaviconElement("link", {
+        : new FaviconHtmlTag("link", {
             rel: "manifest",
             href: this.cacheBusting(this.relative(this.manifestFileName())),
           }),
-      new FaviconElement("meta", {
+      new FaviconHtmlTag("meta", {
         name: "mobile-web-app-capable",
         content: "yes",
       }),
-      new FaviconElement("meta", {
+      new FaviconHtmlTag("meta", {
         name: "theme-color",
         content: this.options.theme_color || this.options.background,
       }),
       this.options.appName
-        ? new FaviconElement("meta", {
+        ? new FaviconHtmlTag("meta", {
             name: "application-name",
             content: escapeHtml(this.options.appName),
           })
-        : new FaviconElement("meta", {
+        : new FaviconHtmlTag("meta", {
             name: "application-name",
           }),
     ];

diff --git a/src/platforms/appleIcon.ts b/src/platforms/appleIcon.ts
@@ -1,5 +1,5 @@
 import escapeHtml from "escape-html";
-import { FaviconElement } from "../index";
+import { FaviconHtmlTag } from "../index";
 import { FaviconOptions, NamedIconOptions } from "../config/defaults";
 import { opaqueIcon } from "../config/icons";
 import { Platform, uniformIconOptions } from "./base";
@@ -28,12 +28,12 @@ export class AppleIconPlatform extends Platform {
     );
   }
 
-  override async createHtml(): Promise<FaviconElement[]> {
+  override async createHtml(): Promise<FaviconHtmlTag[]> {
     const icons = this.iconOptions
       .filter(({ name }) => /\d/.test(name)) // with a size in a name
       .map((options) => {
         const { width, height } = options.sizes[0];
-        return new FaviconElement("link", {
+        return new FaviconHtmlTag("link", {
           rel: "apple-touch-icon",
           sizes: `${width}x${height}`,
           href: this.cacheBusting(this.relative(options.name)),
@@ -44,20 +44,20 @@ export class AppleIconPlatform extends Platform {
 
     return [
       ...icons,
-      new FaviconElement("meta", {
+      new FaviconHtmlTag("meta", {
         name: "apple-mobile-web-app-capable",
         content: "yes",
       }),
-      new FaviconElement("meta", {
+      new FaviconHtmlTag("meta", {
         name: "apple-mobile-web-app-status-bar-style",
         content: this.options.appleStatusBarStyle,
       }),
       name
-        ? new FaviconElement("meta", {
+        ? new FaviconHtmlTag("meta", {
             name: "apple-mobile-web-app-title",
             content: escapeHtml(name),
           })
-        : new FaviconElement("meta", {
+        : new FaviconHtmlTag("meta", {
             name: "apple-mobile-web-app-title",
           }),
     ];

diff --git a/src/platforms/appleStartup.ts b/src/platforms/appleStartup.ts
@@ -1,4 +1,4 @@
-import { FaviconElement } from "../index";
+import { FaviconHtmlTag } from "../index";
 import { FaviconOptions, NamedIconOptions } from "../config/defaults";
 import { opaqueIcon } from "../config/icons";
 import { Platform, uniformIconOptions } from "./base";
@@ -66,10 +66,10 @@ export class AppleStartupPlatform extends Platform<AppleStartupImage> {
     );
   }
 
-  override async createHtml(): Promise<FaviconElement[]> {
+  override async createHtml(): Promise<FaviconHtmlTag[]> {
     return this.iconOptions.map(
       (item) =>
-        new FaviconElement("link", {
+        new FaviconHtmlTag("link", {
           rel: "apple-touch-startup-image",
           media: `(device-width: ${item.deviceWidth}px) and (device-height: ${item.deviceHeight}px) and (-webkit-device-pixel-ratio: ${item.pixelRatio}) and (orientation: ${item.orientation})`,
           href: this.cacheBusting(this.relative(item.name)),

diff --git a/src/platforms/base.ts b/src/platforms/base.ts
@@ -1,6 +1,6 @@
 import {
   FaviconFile,
-  FaviconElement,
+  FaviconHtmlTag,
   FaviconImage,
   FaviconResponse,
 } from "../index";
@@ -72,23 +72,19 @@ export class Platform<IO extends NamedIconOptions = NamedIconOptions> {
     this.iconOptions = iconOptions;
   }
 
-  async create(
-    sourceset: SourceImage[],
-  ): Promise<FaviconResponse<FaviconElement | string>> {
+  async create(sourceset: SourceImage[]): Promise<FaviconResponse> {
     const { output } = this.options;
     const images = output.images ? await this.createImages(sourceset) : [];
     const files = output.files ? await this.createFiles() : [];
-    let html = [];
+    let htmlTags = [];
     if (output.html) {
-      const htmlElements = await this.createHtml();
-      html = this.options.htmlUnStringified
-        ? htmlElements
-        : htmlElements.map((element) => element.stringify());
+      htmlTags = await this.createHtml();
     }
     return {
       images,
       files,
-      html,
+      html: htmlTags.map((element) => element.stringify()),
+      htmlTags,
     };
   }
 
@@ -104,7 +100,7 @@ export class Platform<IO extends NamedIconOptions = NamedIconOptions> {
     return [];
   }
 
-  async createHtml(): Promise<FaviconElement[]> {
+  async createHtml(): Promise<FaviconHtmlTag[]> {
     return [];
   }
 

diff --git a/src/platforms/favicons.ts b/src/platforms/favicons.ts
@@ -1,4 +1,4 @@
-import { FaviconElement } from "../index";
+import { FaviconHtmlTag } from "../index";
 import { FaviconOptions, NamedIconOptions } from "../config/defaults";
 import { transparentIcon, transparentIcons } from "../config/icons";
 import { OptionalMixin, Platform, uniformIconOptions } from "./base";
@@ -19,7 +19,7 @@ export class FaviconsPlatform extends Platform {
     );
   }
 
-  override async createHtml(): Promise<FaviconElement[]> {
+  override async createHtml(): Promise<FaviconHtmlTag[]> {
     return this.iconOptions.map(({ name, ...options }) => {
       const baseAttrs: Record<string, string> = {
         rel: "icon",
@@ -33,7 +33,7 @@ export class FaviconsPlatform extends Platform {
         const { width, height } = options.sizes[0];
         baseAttrs.sizes = `${width}x${height}`;
       }
-      return new FaviconElement("link", {
+      return new FaviconHtmlTag("link", {
         ...baseAttrs,
         href: this.cacheBusting(this.relative(name)),
       });

diff --git a/src/platforms/windows.ts b/src/platforms/windows.ts
@@ -1,5 +1,5 @@
 import xml2js from "xml2js";
-import { FaviconElement, FaviconFile } from "../index";
+import { FaviconHtmlTag, FaviconFile } from "../index";
 import { FaviconOptions, IconSize, NamedIconOptions } from "../config/defaults";
 import { transparentIcon } from "../config/icons";
 import { relativeTo } from "../helpers";
@@ -43,21 +43,21 @@ export class WindowsPlatform extends Platform {
     return [this.browserConfig()];
   }
 
-  override async createHtml(): Promise<FaviconElement[]> {
+  override async createHtml(): Promise<FaviconHtmlTag[]> {
     const tile = "mstile-144x144.png";
 
     return [
-      new FaviconElement("meta", {
+      new FaviconHtmlTag("meta", {
         name: "msapplication-TileColor",
         content: this.options.background,
       }),
       this.iconOptions.find((iconOption) => iconOption.name === tile)
-        ? new FaviconElement("meta", {
+        ? new FaviconHtmlTag("meta", {
             name: "msapplication-TileImage",
             content: this.cacheBusting(this.relative(tile)),
           })
         : undefined,
-      new FaviconElement("meta", {
+      new FaviconHtmlTag("meta", {
         name: "msapplication-config",
         content: this.cacheBusting(this.relative(this.manifestFileName())),
       }),

diff --git a/src/platforms/yandex.ts b/src/platforms/yandex.ts
@@ -1,4 +1,4 @@
-import { FaviconFile, FaviconElement } from "../index";
+import { FaviconFile, FaviconHtmlTag } from "../index";
 import { FaviconOptions, NamedIconOptions } from "../config/defaults";
 import { transparentIcon } from "../config/icons";
 import { relativeTo } from "../helpers";
@@ -20,9 +20,9 @@ export class YandexPlatform extends Platform {
     return [this.manifest()];
   }
 
-  override async createHtml(): Promise<FaviconElement[]> {
+  override async createHtml(): Promise<FaviconHtmlTag[]> {
     return [
-      new FaviconElement("link", {
+      new FaviconHtmlTag("link", {
         rel: "yandex-tableau-widget",
         href: this.cacheBusting(this.relative(this.manifestFileName())),
       }),