fix: improve types

KiwiKilian · Nov 7, 2024 · b384921 · b384921
1 parent 190d765
commit b384921
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 5 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,6 +1,48 @@
 import { SatoriOptions } from 'satori';
 import { FormatEnum, Sharp } from 'sharp';
-import { OgImage } from './src/OgImage.js';
+import TemplateConfig from '@11ty/eleventy/src/TemplateConfig';
+
+export interface OgImage {
+  inputPath: string;
+
+  data: Record<string, any>;
+
+  options: EleventyPluginOgImageMergedOptions;
+
+  templateConfig: typeof TemplateConfig;
+
+  results: {
+    html?: string;
+    svg?: string;
+    pngBuffer?: Buffer;
+  };
+
+  html(): Promise<string>;
+
+  svg(): Promise<string>;
+
+  pngBuffer(): Promise<Buffer>;
+
+  render(): Promise<Sharp>;
+
+  hash(): Promise<string>;
+
+  outputFileSlug(): Promise<string>;
+
+  outputFileName(): Promise<string>;
+
+  outputFilePath(): Promise<string>;
+
+  outputUrl(): Promise<string>;
+
+  cacheFilePath(): Promise<string>;
+
+  shortcodeOutput(): Promise<string>;
+
+  previewFilePath(): string;
+
+  previewHtml(): Promise<string>;
+}
 
 type DirectoriesConfig = {
   input: string;
@@ -23,7 +65,7 @@ type EleventyPluginOgImageOptions = {
   outputFileSlug?(ogImage: OgImage): Promise<string>;
   shortcodeOutput?(ogImage: OgImage): Promise<string>;
 
-  OgImage?: typeof OgImage;
+  OgImage?: OgImage;
 
   satoriOptions?: Partial<SatoriOptions>;
   sharpOptions?: SharpFormatOptions;

diff --git a/src/OgImage.js b/src/OgImage.js
@@ -20,14 +20,15 @@ const require = module.createRequire(import.meta.url);
 const Yoga = await initYoga(await fs.readFile(require.resolve('yoga-wasm-web/dist/yoga.wasm')));
 init(Yoga);
 
+/** @implements {import('eleventy-plugin-og-image').OgImage} */
 export class OgImage {
   /** @type {string} */
   inputPath;
 
   /** @type {Record<string, any>} */
   data;
 
-  /** @type {EleventyPluginOgImageMergedOptions} */
+  /** @type {import('eleventy-plugin-og-image').EleventyPluginOgImageMergedOptions} */
   options;
 
   /** @type {import('@11ty/eleventy/src/TemplateConfig').default} */
@@ -46,7 +47,7 @@ export class OgImage {
   /**
    * @param {string} inputPath
    * @param {Record<string, any>} data
-   * @param {EleventyPluginOgImageMergedOptions} options
+   * @param {import('eleventy-plugin-og-image').EleventyPluginOgImageMergedOptions} options
    * @param {import('@11ty/eleventy/src/TemplateConfig').default} templateConfig
    */
   constructor({ inputPath, data, options, templateConfig }) {
@@ -88,7 +89,7 @@ export class OgImage {
   /**
    * Returns the configured output format
    *
-   * @returns {Promise<Sharp>}
+   * @returns {Promise<import('sharp').Sharp>}
    */
   async render() {
     return sharp(await this.pngBuffer()).toFormat(this.options.outputFileExtension, this.options.sharpOptions);