@types/open-graph-scraper 4.8.0 → 4.8.2

open-graph-scraper/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for open-graph-scraper (https://github.co
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/open-graph-scraper.
 
 ### Additional Details
- * Last updated: Fri, 21 May 2021 05:31:19 GMT
+ * Last updated: Wed, 19 Oct 2022 13:33:07 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 

open-graph-scraper/index.d.ts

@@ -9,186 +9,188 @@ import { PassThrough } from 'stream';
 
 declare namespace run {
     interface OpenGraphImage {
-        height: string;
+        // Height and Width can be optional, see doc on
+        // https://github.com/jshemas/openGraphScraper/blob/master/lib/media.js
+        height?: string;
         type: string;
         url: string;
-        width: string;
+        width?: string;
     }
 
     interface OpenGraphProperties {
         [key: string]: string | undefined;
-        alAndroidAppName?: string;
-        alAndroidClass?: string;
-        alAndroidPackage?: string;
-        alAndroidUrl?: string;
-        alIosAppName?: string;
-        alIosAppStoreId?: string;
-        alIosUrl?: string;
-        alIpadAppName?: string;
-        alIpadAppStoreId?: string;
-        alIpadUrl?: string;
-        alIphoneAppName?: string;
-        alIphoneAppStoreId?: string;
-        alIphoneUrl?: string;
-        alWebShouldFallback?: string;
-        alWebUrl?: string;
-        alWindowsAppId?: string;
-        alWindowsAppName?: string;
-        alWindowsPhoneAppId?: string;
-        alWindowsPhoneAppName?: string;
-        alWindowsPhoneUrl?: string;
-        alWindowsUniversalAppId?: string;
-        alWindowsUniversalAppName?: string;
-        alWindowsUniversalUrl?: string;
-        alWindowsUrl?: string;
-        articleAuthor?: string;
-        articleExpirationTime?: string;
-        articleModifiedTime?: string;
-        articlePublishedTime?: string;
-        articlePublisher?: string;
-        articleSection?: string;
-        articleTag?: string;
-        author?: string;
-        bookAuthor?: string;
-        bookCanonicalName?: string;
-        bookIsbn?: string;
-        bookReleaseDate?: string;
-        booksBook?: string;
-        booksRatingScale?: string;
-        booksRatingValue?: string;
-        bookTag?: string;
-        businessContactDataCountryName?: string;
-        businessContactDataLocality?: string;
-        businessContactDataPostalCode?: string;
-        businessContactDataRegion?: string;
-        businessContactDataStreetAddress?: string;
-        dcContributor?: string;
-        dcCoverage?: string;
-        dcCreator?: string;
-        dcDate?: string;
-        dcDateCreated?: string;
-        dcDateIssued?: string;
-        dcDescription?: string;
-        dcFormatMedia?: string;
-        dcFormatSize?: string;
-        dcIdentifier?: string;
-        dcLanguage?: string;
-        dcPublisher?: string;
-        dcRelation?: string;
-        dcRights?: string;
-        dcSource?: string;
-        dcSubject?: string;
-        dcTitle?: string;
-        dcType?: string;
-        modifiedTime?: string;
-        musicAlbum?: string;
-        musicAlbumDisc?: string;
-        musicAlbumTrack?: string;
-        musicAlbumUrl?: string;
-        musicCreator?: string;
-        musicDuration?: string;
-        musicMusician?: string;
-        musicReleaseDate?: string;
-        musicSong?: string;
-        musicSongDisc?: string;
-        musicSongTrack?: string;
-        musicSongUrl?: string;
-        ogArticleAuthor?: string;
-        ogArticleExpirationTime?: string;
-        ogArticleModifiedTime?: string;
-        ogArticlePublishedTime?: string;
-        ogArticlePublisher?: string;
-        ogArticleSection?: string;
-        ogArticleTag?: string;
-        ogAudio?: string;
-        ogAudioSecureURL?: string;
-        ogAudioType?: string;
-        ogAudioURL?: string;
-        ogAvailability?: string;
-        ogDate?: string;
-        ogDescription?: string;
-        ogDeterminer?: string;
-        ogImage?: string;
-        ogImageHeight?: string;
-        ogImageSecureURL?: string;
-        ogImageType?: string;
-        ogImageURL?: string;
-        ogImageWidth?: string;
-        ogLocale?: string;
-        ogLocaleAlternate?: string;
-        ogLogo?: string;
-        ogPriceAmount?: string;
-        ogPriceCurrency?: string;
-        ogProductAvailability?: string;
-        ogProductCondition?: string;
-        ogProductPriceAmount?: string;
-        ogProductPriceCurrency?: string;
-        ogProductRetailerItemId?: string;
-        ogSiteName?: string;
-        ogTitle?: string;
-        ogType?: string;
-        ogUrl?: string;
-        ogVideo?: string;
-        ogVideoActorId?: string;
-        ogVideoHeight?: string;
-        ogVideoSecureURL?: string;
-        ogVideoType?: string;
-        ogVideoWidth?: string;
-        placeLocationLatitude?: string;
-        placeLocationLongitude?: string;
-        profileFirstName?: string;
-        profileGender?: string;
-        profileLastName?: string;
-        profileUsername?: string;
-        publishedTime?: string;
-        releaseDate?: string;
-        restaurantContactInfoCountryName?: string;
-        restaurantContactInfoEmail?: string;
-        restaurantContactInfoLocality?: string;
-        restaurantContactInfoPhoneNumber?: string;
-        restaurantContactInfoPostalCode?: string;
-        restaurantContactInfoRegion?: string;
-        restaurantContactInfoStreetAddress?: string;
-        restaurantContactInfoWebsite?: string;
-        restaurantMenu?: string;
-        restaurantRestaurant?: string;
-        restaurantSection?: string;
-        restaurantVariationPriceAmount?: string;
-        restaurantVariationPriceCurrency?: string;
-        twitterAppIdGooglePlay?: string;
-        twitterAppIdiPad?: string;
-        twitterAppIdiPhone?: string;
-        twitterAppNameGooglePlay?: string;
-        twitterAppNameiPad?: string;
-        twitterAppNameiPhone?: string;
-        twitterAppUrlGooglePlay?: string;
-        twitterAppUrliPad?: string;
-        twitterAppUrliPhone?: string;
-        twitterCard?: string;
-        twitterCreator?: string;
-        twitterCreatorId?: string;
-        twitterDescription?: string;
-        twitterImage?: string;
-        twitterImageAlt?: string;
-        twitterImageHeight?: string;
-        twitterImageSrc?: string;
-        twitterImageWidth?: string;
-        twitterPlayer?: string;
-        twitterPlayerHeight?: string;
-        twitterPlayerStream?: string;
-        twitterPlayerStreamContentType?: string;
-        twitterPlayerWidth?: string;
-        twitterSite?: string;
-        twitterSiteId?: string;
-        twitterTitle?: string;
-        twitterUrl?: string;
-        updatedTime?: string;
+        alAndroidAppName?: string | undefined;
+        alAndroidClass?: string | undefined;
+        alAndroidPackage?: string | undefined;
+        alAndroidUrl?: string | undefined;
+        alIosAppName?: string | undefined;
+        alIosAppStoreId?: string | undefined;
+        alIosUrl?: string | undefined;
+        alIpadAppName?: string | undefined;
+        alIpadAppStoreId?: string | undefined;
+        alIpadUrl?: string | undefined;
+        alIphoneAppName?: string | undefined;
+        alIphoneAppStoreId?: string | undefined;
+        alIphoneUrl?: string | undefined;
+        alWebShouldFallback?: string | undefined;
+        alWebUrl?: string | undefined;
+        alWindowsAppId?: string | undefined;
+        alWindowsAppName?: string | undefined;
+        alWindowsPhoneAppId?: string | undefined;
+        alWindowsPhoneAppName?: string | undefined;
+        alWindowsPhoneUrl?: string | undefined;
+        alWindowsUniversalAppId?: string | undefined;
+        alWindowsUniversalAppName?: string | undefined;
+        alWindowsUniversalUrl?: string | undefined;
+        alWindowsUrl?: string | undefined;
+        articleAuthor?: string | undefined;
+        articleExpirationTime?: string | undefined;
+        articleModifiedTime?: string | undefined;
+        articlePublishedTime?: string | undefined;
+        articlePublisher?: string | undefined;
+        articleSection?: string | undefined;
+        articleTag?: string | undefined;
+        author?: string | undefined;
+        bookAuthor?: string | undefined;
+        bookCanonicalName?: string | undefined;
+        bookIsbn?: string | undefined;
+        bookReleaseDate?: string | undefined;
+        booksBook?: string | undefined;
+        booksRatingScale?: string | undefined;
+        booksRatingValue?: string | undefined;
+        bookTag?: string | undefined;
+        businessContactDataCountryName?: string | undefined;
+        businessContactDataLocality?: string | undefined;
+        businessContactDataPostalCode?: string | undefined;
+        businessContactDataRegion?: string | undefined;
+        businessContactDataStreetAddress?: string | undefined;
+        dcContributor?: string | undefined;
+        dcCoverage?: string | undefined;
+        dcCreator?: string | undefined;
+        dcDate?: string | undefined;
+        dcDateCreated?: string | undefined;
+        dcDateIssued?: string | undefined;
+        dcDescription?: string | undefined;
+        dcFormatMedia?: string | undefined;
+        dcFormatSize?: string | undefined;
+        dcIdentifier?: string | undefined;
+        dcLanguage?: string | undefined;
+        dcPublisher?: string | undefined;
+        dcRelation?: string | undefined;
+        dcRights?: string | undefined;
+        dcSource?: string | undefined;
+        dcSubject?: string | undefined;
+        dcTitle?: string | undefined;
+        dcType?: string | undefined;
+        modifiedTime?: string | undefined;
+        musicAlbum?: string | undefined;
+        musicAlbumDisc?: string | undefined;
+        musicAlbumTrack?: string | undefined;
+        musicAlbumUrl?: string | undefined;
+        musicCreator?: string | undefined;
+        musicDuration?: string | undefined;
+        musicMusician?: string | undefined;
+        musicReleaseDate?: string | undefined;
+        musicSong?: string | undefined;
+        musicSongDisc?: string | undefined;
+        musicSongTrack?: string | undefined;
+        musicSongUrl?: string | undefined;
+        ogArticleAuthor?: string | undefined;
+        ogArticleExpirationTime?: string | undefined;
+        ogArticleModifiedTime?: string | undefined;
+        ogArticlePublishedTime?: string | undefined;
+        ogArticlePublisher?: string | undefined;
+        ogArticleSection?: string | undefined;
+        ogArticleTag?: string | undefined;
+        ogAudio?: string | undefined;
+        ogAudioSecureURL?: string | undefined;
+        ogAudioType?: string | undefined;
+        ogAudioURL?: string | undefined;
+        ogAvailability?: string | undefined;
+        ogDate?: string | undefined;
+        ogDescription?: string | undefined;
+        ogDeterminer?: string | undefined;
+        ogImage?: string | undefined;
+        ogImageHeight?: string | undefined;
+        ogImageSecureURL?: string | undefined;
+        ogImageType?: string | undefined;
+        ogImageURL?: string | undefined;
+        ogImageWidth?: string | undefined;
+        ogLocale?: string | undefined;
+        ogLocaleAlternate?: string | undefined;
+        ogLogo?: string | undefined;
+        ogPriceAmount?: string | undefined;
+        ogPriceCurrency?: string | undefined;
+        ogProductAvailability?: string | undefined;
+        ogProductCondition?: string | undefined;
+        ogProductPriceAmount?: string | undefined;
+        ogProductPriceCurrency?: string | undefined;
+        ogProductRetailerItemId?: string | undefined;
+        ogSiteName?: string | undefined;
+        ogTitle?: string | undefined;
+        ogType?: string | undefined;
+        ogUrl?: string | undefined;
+        ogVideo?: string | undefined;
+        ogVideoActorId?: string | undefined;
+        ogVideoHeight?: string | undefined;
+        ogVideoSecureURL?: string | undefined;
+        ogVideoType?: string | undefined;
+        ogVideoWidth?: string | undefined;
+        placeLocationLatitude?: string | undefined;
+        placeLocationLongitude?: string | undefined;
+        profileFirstName?: string | undefined;
+        profileGender?: string | undefined;
+        profileLastName?: string | undefined;
+        profileUsername?: string | undefined;
+        publishedTime?: string | undefined;
+        releaseDate?: string | undefined;
+        restaurantContactInfoCountryName?: string | undefined;
+        restaurantContactInfoEmail?: string | undefined;
+        restaurantContactInfoLocality?: string | undefined;
+        restaurantContactInfoPhoneNumber?: string | undefined;
+        restaurantContactInfoPostalCode?: string | undefined;
+        restaurantContactInfoRegion?: string | undefined;
+        restaurantContactInfoStreetAddress?: string | undefined;
+        restaurantContactInfoWebsite?: string | undefined;
+        restaurantMenu?: string | undefined;
+        restaurantRestaurant?: string | undefined;
+        restaurantSection?: string | undefined;
+        restaurantVariationPriceAmount?: string | undefined;
+        restaurantVariationPriceCurrency?: string | undefined;
+        twitterAppIdGooglePlay?: string | undefined;
+        twitterAppIdiPad?: string | undefined;
+        twitterAppIdiPhone?: string | undefined;
+        twitterAppNameGooglePlay?: string | undefined;
+        twitterAppNameiPad?: string | undefined;
+        twitterAppNameiPhone?: string | undefined;
+        twitterAppUrlGooglePlay?: string | undefined;
+        twitterAppUrliPad?: string | undefined;
+        twitterAppUrliPhone?: string | undefined;
+        twitterCard?: string | undefined;
+        twitterCreator?: string | undefined;
+        twitterCreatorId?: string | undefined;
+        twitterDescription?: string | undefined;
+        twitterImage?: string | undefined;
+        twitterImageAlt?: string | undefined;
+        twitterImageHeight?: string | undefined;
+        twitterImageSrc?: string | undefined;
+        twitterImageWidth?: string | undefined;
+        twitterPlayer?: string | undefined;
+        twitterPlayerHeight?: string | undefined;
+        twitterPlayerStream?: string | undefined;
+        twitterPlayerStreamContentType?: string | undefined;
+        twitterPlayerWidth?: string | undefined;
+        twitterSite?: string | undefined;
+        twitterSiteId?: string | undefined;
+        twitterTitle?: string | undefined;
+        twitterUrl?: string | undefined;
+        updatedTime?: string | undefined;
     }
 
     interface SuccessResult {
         error: false;
         result: OpenGraphProperties & {
-            ogImage?: OpenGraphImage | OpenGraphImage[];
+            ogImage?: OpenGraphImage | OpenGraphImage[] | undefined;
             success: true;
         };
         response: PassThrough;
@@ -205,71 +207,71 @@ declare namespace run {
 
     interface URLValidatorSettings {
         /** default is `false`. */
-        allow_protocol_relative_urls?: boolean;
+        allow_protocol_relative_urls?: boolean | undefined;
         /** default is `false`. */
-        allow_trailing_dot?: boolean;
+        allow_trailing_dot?: boolean | undefined;
         /** default is `false`. */
-        allow_underscores?: boolean;
+        allow_underscores?: boolean | undefined;
         /** default is `false`. */
-        disallow_auth?: boolean;
+        disallow_auth?: boolean | undefined;
         /** default is `false`. */
-        host_blacklist?: boolean;
+        host_blacklist?: boolean | undefined;
         /** default is `false`. */
-        host_whitelist?: boolean;
+        host_whitelist?: boolean | undefined;
         /** default is `['http', 'https']`. */
-        protocols?: string[];
+        protocols?: string[] | undefined;
         /** default is `true`. */
-        require_host?: boolean;
+        require_host?: boolean | undefined;
         /** default is `false`. */
-        require_protocol?: boolean;
+        require_protocol?: boolean | undefined;
         /** default is `true`. */
-        require_tld?: boolean;
+        require_tld?: boolean | undefined;
         /** default is `true`. */
-        require_valid_protocol?: boolean;
+        require_valid_protocol?: boolean | undefined;
     }
 
     interface CustomMetaTag {
-        multiple?: boolean;
+        multiple?: boolean | undefined;
         property: string;
         fieldName: string;
     }
 
     interface Options {
         /** By default, OGS will only send back the first image/video it finds (default: `false`). */
-        allMedia?: boolean;
+        allMedia?: boolean | undefined;
         /** Pass in an array of sites you don't want `og`s to run on. */
-        blacklist?: string[];
+        blacklist?: string[] | undefined;
         /** Set the accept-encoding to `gzip/deflate` (default: `true`). */
-        decompress?: boolean;
+        decompress?: boolean | undefined;
         /**
          * Setting this to `null` might help with running `og`s on non english websites (default: `utf8`).
          * @deprecated
          */
-        encoding?: string | null;
+        encoding?: string | null | undefined;
         /** Defines if redirect responses should be followed automatically (default: `true`). */
-        followRedirect?: boolean;
+        followRedirect?: boolean | undefined;
         /** An object containing request headers. Useful for setting the user-agent. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string> | undefined;
         /** You can pass in an HTML string to run `og`s on it (use without `options.url`). */
-        html?: string;
+        html?: string | undefined;
         /** Max number of redirects `og`s will follow (default: `10`). */
-        maxRedirects?: number;
+        maxRedirects?: number | undefined;
         /** Fetch other images if no open graph ones are found (default: `true`). */
-        ogImageFallback?: boolean;
+        ogImageFallback?: boolean | undefined;
         /** Only fetch open graph info and don't fall back on anything else (default: `false`). */
-        onlyGetOpenGraphInfo?: boolean;
+        onlyGetOpenGraphInfo?: boolean | undefined;
         /** Sets the peekSize for the request (default: `1024`). */
-        peekSize?: number;
+        peekSize?: number | undefined;
         /** Number of times `og`s will retry the request (default: `2`). */
-        retry?: number;
+        retry?: number | undefined;
         /** Timeout of the request in ms (default: `2000`). */
-        timeout?: number;
+        timeout?: number | undefined;
         /** URL of the site. */
         url: string;
         /** Sets the options used by `validator.js` for testing the URL. */
-        urlValidatorSettings?: URLValidatorSettings;
+        urlValidatorSettings?: URLValidatorSettings | undefined;
         /** Here you can define custom meta tags you want to scrape. */
-        customMetaTags?: CustomMetaTag[];
+        customMetaTags?: CustomMetaTag[] | undefined;
     }
 }
 

open-graph-scraper/package.json

@@ -1,7 +1,8 @@
 {
     "name": "@types/open-graph-scraper",
-    "version": "4.8.0",
+    "version": "4.8.2",
     "description": "TypeScript definitions for open-graph-scraper",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/open-graph-scraper",
     "license": "MIT",
     "contributors": [
         {
@@ -21,6 +22,6 @@
     "dependencies": {
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "7b5a8b86155920d46150d99140cb9916e4be165620b3970bd930b237472f066d",
-    "typeScriptVersion": "3.5"
+    "typesPublisherContentHash": "765a7edb94fd229ab033a9d761fe3786b2728dee8e272930e272c685e45f24f9",
+    "typeScriptVersion": "4.1"
 }