adding types to project and adding better support for both cjs and esm

Author: jshemas

package.json

@@ -3,11 +3,21 @@
   "description": "Javascript scraper module for Open Graph and Twitter Card info",
   "version": "2.0.0",
   "license": "MIT",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "scripts": {
-    "build": "rm -rf dist/ && tsc",
-    "ci": "npm run eslint && npm run build && npm run test",
+    "build:cjs": "tsc --project tsconfig.build.json --module commonjs --outDir dist/cjs/",
+    "build:declaration": "tsc --project tsconfig.declaration.json --module node16 --moduleResolution node16",
+    "build:esm": "tsc --project tsconfig.build.json --module node16 --moduleResolution node16 --outDir dist/esm/",
+    "build": "rm -rf dist/ && npm run build:cjs && npm run build:esm",
+    "ci": "npm run eslint && npm run build && npm run build:declaration && npm run test",
     "eslint:fix": "eslint . --ext .js,.ts --fix",
     "eslint": "eslint . --ext .js,.ts",
     "mocha:unit": "nyc --reporter=html --reporter=text --exclude=tests/ ts-mocha --recursive \"./tests/unit/**/*.spec.ts\"",

tsconfig.build.json

@@ -0,0 +1,17 @@
+{
+  "include": [
+    "index.ts",
+    "lib/**/*"
+  ],
+  "exclude": [
+    "tests/**/*"
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["es2023"],
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "es2022",
+  }
+}

tsconfig.declaration.json

@@ -0,0 +1,20 @@
+{
+  "include": [
+    "index.ts",
+    "lib/**/*"
+  ],
+  "exclude": [
+    "tests/**/*"
+  ],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationDir": "./types",
+    "emitDeclarationOnly": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["es2023"],
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "es2022",
+  }
+}

tsconfig.json

@@ -7,16 +7,13 @@
     "tests/**/*"
   ],
   "compilerOptions": {
-    "allowJs": true,
-    "declaration": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "lib": ["es2017"],
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "outDir": "./dist",
+    "lib": ["es2023"],
+    "module": "node16",
+    "moduleResolution": "node16",
     "skipLibCheck": true,
-    "target": "es2017"
+    "strict": true,
+    "target": "es2022",
   }
 }

types/index.d.ts

@@ -0,0 +1,25 @@
+import type { OpenGraphScraperOptions, OgObject } from './lib/types';
+/**
+ * `open-graph-scraper` uses [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) for http requests
+ * for scraping Open Graph and Twitter Card info off a website.
+ *
+ * @param {object} options - The options used by Open Graph Scraper
+ * @param {boolean} [options.onlyGetOpenGraphInfo] - Only fetch open graph info and don't fall back on anything else.
+ * @param {object} [options.customMetaTags] - Here you can define custom meta tags you want to scrape.
+ * @param {string} options.html - You can pass in an HTML string to run ogs on it. (use without options.url)
+ * @returns {Promise} Promise Object with the Open Graph results
+ */
+export default function run(options: OpenGraphScraperOptions): Promise<ErrorResult | SuccessResult>;
+export interface SuccessResult {
+    error: false;
+    html: string;
+    result: OgObject;
+}
+export interface ErrorResult {
+    error: true;
+    html: undefined;
+    result: OgObject;
+}
+
+// adding this line in to fix ESM imports for `module/moduleResolution = NodeNext` projects
+export = run;

types/lib/extract.d.ts

@@ -0,0 +1,10 @@
+import type { OgObjectInteral, OpenGraphScraperOptions } from './types';
+/**
+ * extract all of the meta tags needed for ogs
+ *
+ * @param {sting} body - the body of the fetch request
+ * @param {object} options - options for ogs
+ * @return {object} object with ogs results
+ *
+ */
+export default function extractMetaTags(body: string, options: OpenGraphScraperOptions): OgObjectInteral;

types/lib/fallback.d.ts

@@ -0,0 +1,13 @@
+import type { CheerioAPI } from 'cheerio';
+import type { OpenGraphScraperOptions, OgObjectInteral } from './types';
+/**
+ * ogs fallbacks
+ *
+ * @param {object} ogObject - the current ogObject
+ * @param {object} options - options for ogs
+ * @param {object} $ - cheerio.load() of the current html
+ * @return {object} object with ogs results with updated fallback values
+ *
+ */
+export declare function fallback(ogObject: OgObjectInteral, options: OpenGraphScraperOptions, $: CheerioAPI, body: string): OgObjectInteral;
+export default fallback;

types/lib/fields.d.ts

@@ -0,0 +1,14 @@
+import type { OgObjectInteral } from './types';
+type Fields = {
+    multiple: boolean;
+    property: string;
+    fieldName: keyof OgObjectInteral;
+}[];
+/**
+ * array of meta tags ogs is looking for
+ *
+ * @return {array} array of meta tags
+ *
+ */
+declare const fields: Fields;
+export default fields;

types/lib/media.d.ts

@@ -0,0 +1,11 @@
+import type { OgObjectInteral } from './types';
+/**
+ * formats the multiple media values
+ *
+ * @param {object} ogObject - the current ogObject
+ * @param {object} options - options for ogs
+ * @return {object} object with ogs results with updated media values
+ *
+ */
+export declare function mediaSetup(ogObject: OgObjectInteral): OgObjectInteral;
+export default mediaSetup;

types/lib/openGraphScraper.d.ts

@@ -0,0 +1,15 @@
+import type { OpenGraphScraperOptions } from './types';
+/**
+ * sets up options for the fetch request and calls extract on html
+ *
+ * @param {object} options - options for ogs
+ * @return {object} object with ogs results
+ *
+ */
+export default function setOptionsAndReturnOpenGraphResults(ogsOptions: OpenGraphScraperOptions): Promise<{
+    ogObject: import("./types").OgObjectInteral;
+    response: {
+        body: string;
+    };
+    html: string;
+}>;