oembed-spec 1.3.33 → 1.4.1

package/package.json

@@ -2,7 +2,8 @@
   "name": "oembed-spec",
   "description": "A parser for oEmbed specification",
   "homepage": "https://github.com/microlinkhq/oembed-spec",
-  "version": "1.3.33",
+  "version": "1.4.1",
+  "types": "src/index.d.ts",
   "main": "src/index.js",
   "author": {
     "email": "hello@microlink.io",
@@ -21,6 +22,10 @@
     {
       "name": "Rémi Berson",
       "email": "remi@cliqz.com"
+    },
+    {
+      "name": "Michael Lip",
+      "email": "51033404+theluckystrike@users.noreply.github.com"
     }
   ],
   "repository": {

package/src/index.d.ts

@@ -0,0 +1,64 @@
+'use strict'
+
+interface Provider {
+  name: string
+  url: string
+  oembedUrl: string
+}
+
+interface OembedOptions {
+  maxwidth?: number
+  maxheight?: number
+  [key: string]: string | number | undefined
+}
+
+interface OembedResponse {
+  type: string
+  version: string
+  title?: string
+  author_name?: string
+  author_url?: string
+  provider_name?: string
+  provider_url?: string
+  cache_age?: number
+  thumbnail_url?: string
+  thumbnail_width?: number
+  thumbnail_height?: number
+  html?: string
+  width?: number
+  height?: number
+  url?: string
+}
+
+/**
+ * oembed-spec - A parser for oEmbed specification
+ * 
+ * @param url - The URL to get oembed data for
+ * @param opts - Optional oembed parameters
+ * @param gotOpts - Optional got library options for HTTP requests
+ * @returns Promise resolving to oembed response data, or undefined if no provider found
+ */
+declare function oembed(
+  url: string,
+  opts?: OembedOptions,
+  gotOpts?: Record<string, any>
+): Promise<OembedResponse | undefined>
+
+declare namespace oembed {
+  /**
+   * Find an oEmbed provider for a given URL
+   */
+  function findProvider(url: string): Provider | undefined
+
+  /**
+   * Fetch oEmbed data from a specific provider
+   */
+  function fetchProvider(
+    provider: Provider,
+    url: string,
+    opts?: OembedOptions,
+    gotOpts?: Record<string, any>
+  ): Promise<OembedResponse>
+}
+
+export = oembed