feat: add type definitions

Author: LuanRT

.gitignore

@@ -0,0 +1,49 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+.npmignore
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "allowJs": true,
+        "outDir": "./typings",
+        "lib": ["ESNext"],
+        "target": "ESNext",
+        "moduleResolution": "node"
+    },
+    "include": [
+        "./lib/**/*.js",
+        "./index.js"
+    ],
+    "exclude": [
+        "node_modules",
+        "**/*.d.ts"
+    ]
+}

typings/index.d.ts

@@ -0,0 +1,2 @@
+declare const _exports: typeof import("./lib/googlethis");
+export = _exports;

typings/lib/constants.d.ts

@@ -0,0 +1,69 @@
+export namespace URLS {
+    const GIS: string;
+    const GOOGLE: string;
+    const W_GOOGLE: string;
+    const GOOGLE_NEWS: string;
+    const FAVICONKIT: string;
+}
+export namespace REGEX {
+    const IMAGE_SEARCH: RegExp;
+    const IMAGE_ORIGIN: RegExp;
+}
+export namespace SELECTORS {
+    const TITLE: string;
+    const DESCRIPTION: string;
+    const URL: string;
+    const DID_YOU_MEAN: string;
+    const KNO_PANEL_TITLE: string[];
+    const KNO_PANEL_DESCRIPTION: string;
+    const KNO_PANEL_URL: string;
+    const KNO_PANEL_METADATA: string;
+    const KNO_PANEL_TYPE: string;
+    const KNO_PANEL_SONG_LYRICS: string;
+    const KNO_PANEL_AVAILABLE_ON: string;
+    const KNO_PANEL_IMAGES: string;
+    const KNO_PANEL_BOOKS: string;
+    const KNO_PANEL_TV_SHOWS_AND_MOVIES: string;
+    const KNO_PANEL_FILM_GOOGLEUSERS_RATING: string;
+    const KNO_PANEL_FILM_RATINGS: string[];
+    const FEATURED_SNIPPET_TITLE: string[];
+    const FEATURED_SNIPPET_DESC: string[];
+    const FEATURED_SNIPPET_URL: string;
+    const UNIT_CONVERTER_INPUT: string;
+    const UNIT_CONVERTER_OUTPUT: string;
+    const UNIT_CONVERTER_FORMULA: string;
+    const INPUT_CURRENCY_NAME: string;
+    const OUTPUT_CURRENCY_NAME: string;
+    const CURRENCY_CONVERTER_INPUT: string;
+    const CURRENCY_CONVERTER_OUTPUT: string;
+    const WEATHER_LOCATION: string;
+    const WEATHER_FORECAST: string;
+    const PRECIPITATION: string;
+    const AIR_HUMIDITY: string;
+    const TEMPERATURE: string;
+    const WIND_SPEED: string;
+    const CURRENT_TIME_HOUR: string;
+    const CURRENT_TIME_DATE: string;
+    const LOCATION_TITLE: string;
+    const LOCATION_DISTANCE: string;
+    const LOCATION_IMAGE: string;
+    const GD_WORD: string;
+    const GD_PHONETIC: string;
+    const GD_AUDIO: string;
+    const GD_DEFINITIONS: string;
+    const GD_EXAMPLES: string;
+    const TR_SOURCE_LANGUAGE: string;
+    const TR_TARGET_LANGUAGE: string;
+    const TR_SOURCE_TEXT: string;
+    const TR_TARGET_TEXT: string;
+    const TOP_STORIES_DESCRIPTION: string[];
+    const TOP_STORIES_URL: string;
+    const TOP_STORIES_SNIPPET: string;
+    const TOP_STORIES_WEBSITE: string;
+    const PAA: string[];
+    const PASF: string;
+    const PUBLISHER: string;
+    const STORY_TITLE: string;
+    const STORY_IMG: string;
+    const STORY_TIME: string;
+}

typings/lib/googlethis.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Retrieves news from Google.
+ */
+export function getTopNews(): Promise<{
+    headline_stories: any[];
+}>;
+/**
+ * Search a given query on Google.
+ *
+ * @param {string} query - Search query
+ * @param {object} [options] Search options
+ * @param {boolean} [options.ris] - Use reverse image search
+ * @param {boolean} [options.safe] - Safe search
+ * @param {number} [options.page] - Pagination
+ * @param {object} [options.additional_params] - Parameters that will be passed to Google
+ */
+export function search(query: string, options?: {
+    ris?: boolean;
+    safe?: boolean;
+    page?: number;
+    additional_params?: object;
+}): Promise<{
+    results: any[];
+    did_you_mean: string;
+    knowledge_panel: {};
+    featured_snippet: {};
+    top_stories: any[];
+    people_also_ask: any[];
+    people_also_search_for: any[];
+}>;
+/**
+ * Google image search.
+ *
+ * @param {string} query - Search query
+ * @param {object} [options] - Search options
+ * @param {boolean} [options.safe] - Safe search
+ * @param {object} [options.additional_params] - Parameters that will be passed to Google
+ * @param {Array.<string>} [options.exclude_domains] - Domains that should be blocked
+ */
+export function image(query: string, options?: {
+    safe?: boolean;
+    additional_params?: object;
+    exclude_domains?: Array<string>;
+}): Promise<{
+    url: string;
+    width: string;
+    height: string;
+    origin: {
+        title: string;
+        source: string;
+    };
+}[]>;

typings/lib/parser.d.ts

@@ -0,0 +1,99 @@
+export = Parser;
+declare class Parser {
+    constructor(data: any);
+    data: any;
+    $: Cheerio.CheerioAPI;
+    getOrganicResults(): {
+        title: string;
+        description: string;
+        url: string;
+        favicons: {
+            high_res: string;
+            low_res: string;
+        };
+    }[];
+    getKnowledgeGraph(): {
+        title: string;
+        description: string;
+        url: string;
+        type: string;
+        books: {
+            title: string;
+            year: string;
+        }[];
+        tv_shows_and_movies: {
+            title: string;
+            year: string;
+        }[];
+        lyrics: string;
+        ratings: any[];
+        available_on: string[];
+        images: {
+            url: string;
+            source: string;
+        }[];
+        demonstration: string;
+    };
+    getFeaturedSnippet(): {
+        title: string;
+        description: string;
+        url: string;
+    };
+    getDidYouMean(): string;
+    getTopStories(): {
+        description: string;
+        url: string;
+    }[];
+    getTime(): {
+        hours: string;
+        date: string;
+    };
+    getWeather(): {
+        location: string;
+        forecast: string;
+        precipitation: string;
+        humidity: string;
+        temperature: string;
+        wind: string;
+    };
+    getLocation(date: any): {
+        title: string;
+        distance: string;
+        map: string;
+    };
+    getTranslation(): {
+        source_language: string;
+        target_language: string;
+        source_text: string;
+        target_text: string;
+    };
+    getDictionary(): {
+        word: string;
+        phonetic: string;
+        audio: string;
+        definitions: string[];
+        examples: string[];
+    };
+    getConverters(): {
+        input: string;
+        output: string;
+        formula: string;
+    } | {
+        input: {
+            name: string;
+            value: string;
+        };
+        output: {
+            name: string;
+            value: string;
+        };
+        formula?: undefined;
+    };
+    getPaa(): any[];
+    getPas(): {
+        title: string;
+        thumbnail: string;
+    }[];
+    #private;
+}
+import Cheerio = require("cheerio");

typings/lib/utils.d.ts

@@ -0,0 +1,31 @@
+export function SearchError(message: any, info: any): void;
+export class SearchError {
+    constructor(message: any, info: any);
+    info: any;
+    stack: string;
+    constructor: typeof SearchError;
+}
+/**
+ * Returns headers with a random user agent.
+ *
+ * @param {boolean} is_mobile
+ * @returns {string}
+ */
+export function getHeaders(is_mobile: boolean): string;
+/**
+ * Gets a string between two delimiters.
+ *
+ * @param {string} data - The data.
+ * @param {string} start_string - Start string.
+ * @param {string} end_string - End string.
+ *
+ * @returns {string}
+ */
+export function getStringBetweenStrings(data: string, start_string: string, end_string: string): string;
+/**
+ * Refines the html.
+ *
+ * @param {string} data - Raw html data.
+ * @returns {string}
+ */
+export function refineData(data: string): string;