@linkprobe/core 0.1.0 → 0.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Hossein Hosseini
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Hossein Hosseini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,155 +1,155 @@
-# @linkprobe/core
-
-The framework-agnostic metadata extraction engine for LinkProbe.
-
-`@linkprobe/core` provides utilities for extracting and resolving webpage metadata from URLs. It supports Open Graph, Twitter Cards, and standard HTML metadata, making it ideal for building link previews, content cards, social embeds, and metadata-driven experiences.
-
-## Installation
-
-```bash
-pnpm add @linkprobe/core
-```
-
-## Quick Start
-
-```ts
-import {probe} from "@linkprobe/core";
-
-const result = await probe("https://github.com");
-
-if (result.status === "success") {
-  console.log(result.metadata);
-}
-```
-
-## Example Response
-
-```ts
-{
-  status: "success",
-  metadata: {
-    url: "https://github.com",
-    openGraph: {
-      title: "GitHub",
-      description: "...",
-      image: "..."
-    },
-    twitter: {
-      title: "GitHub"
-    },
-    html: {
-      title: "GitHub"
-    }
-  },
-  page: {
-    requestedUrl: "https://github.com",
-    finalUrl: "https://github.com",
-    contentType: "text/html"
-  }
-}
-```
-
-## Metadata Resolution
-
-Metadata may be available from multiple sources.
-
-Use `resolveMetadata()` to create a unified representation using customizable priority rules.
-
-```ts
-import {probe, resolveMetadata} from "@linkprobe/core";
-
-const result = await probe("https://github.com");
-
-if (result.status === "success") {
-  const metadata = resolveMetadata(result.metadata);
-
-  console.log(metadata);
-}
-```
-
-Example output:
-
-```ts
-{
-  title: "GitHub",
-  description: "...",
-  image: "...",
-  favicon: "...",
-  siteName: "GitHub"
-}
-```
-
-## Custom Priorities
-
-```ts
-const metadata = resolveMetadata(result.metadata, {
-  titlePriority: ["twitter", "openGraph", "html"],
-});
-```
-
-## Options
-
-### probe(url, options)
-
-```ts
-await probe("https://github.com", {
-  timeout: 5000,
-});
-```
-
-| Option  | Type   | Description                     |
-| ------- | ------ | ------------------------------- |
-| timeout | number | Request timeout in milliseconds |
-
-## Supported Sources
-
-### Open Graph
-
-```html
-<meta property="og:title" />
-<meta property="og:description" />
-<meta property="og:image" />
-```
-
-### Twitter Cards
-
-```html
-<meta name="twitter:title" />
-<meta name="twitter:description" />
-<meta name="twitter:image" />
-```
-
-### HTML Metadata
-
-```html
-<title>...</title>
-<meta name="description" />
-<link rel="icon" />
-<link rel="canonical" />
-```
-
-## Error Handling
-
-```ts
-const result = await probe(url);
-
-if (result.status === "failed") {
-  console.error(result.error.code, result.error.message);
-}
-```
-
-Possible error codes:
-
-```txt
-FETCH_FAILED
-TIMEOUT
-UNKNOWN_ERROR
-```
-
-## TypeScript
-
-All public APIs are fully typed and exported by the package.
-
-```ts
-import type {Metadata, ProbeResult, ProbeOptions, ResolvedMetadata} from "@linkprobe/core";
-```
+# @linkprobe/core
+
+The framework-agnostic metadata extraction engine for LinkProbe.
+
+`@linkprobe/core` provides utilities for extracting and resolving webpage metadata from URLs. It supports Open Graph, Twitter Cards, and standard HTML metadata, making it ideal for building link previews, content cards, social embeds, and metadata-driven experiences.
+
+## Installation
+
+```bash
+pnpm add @linkprobe/core
+```
+
+## Quick Start
+
+```ts
+import {probe} from "@linkprobe/core";
+
+const result = await probe("https://github.com");
+
+if (result.status === "success") {
+  console.log(result.metadata);
+}
+```
+
+## Example Response
+
+```ts
+{
+  status: "success",
+  metadata: {
+    url: "https://github.com",
+    openGraph: {
+      title: "GitHub",
+      description: "...",
+      image: "..."
+    },
+    twitter: {
+      title: "GitHub"
+    },
+    html: {
+      title: "GitHub"
+    }
+  },
+  page: {
+    requestedUrl: "https://github.com",
+    finalUrl: "https://github.com",
+    contentType: "text/html"
+  }
+}
+```
+
+## Metadata Resolution
+
+Metadata may be available from multiple sources.
+
+Use `resolveMetadata()` to create a unified representation using customizable priority rules.
+
+```ts
+import {probe, resolveMetadata} from "@linkprobe/core";
+
+const result = await probe("https://github.com");
+
+if (result.status === "success") {
+  const metadata = resolveMetadata(result.metadata);
+
+  console.log(metadata);
+}
+```
+
+Example output:
+
+```ts
+{
+  title: "GitHub",
+  description: "...",
+  image: "...",
+  favicon: "...",
+  siteName: "GitHub"
+}
+```
+
+## Custom Priorities
+
+```ts
+const metadata = resolveMetadata(result.metadata, {
+  titlePriority: ["twitter", "openGraph", "html"],
+});
+```
+
+## Options
+
+### probe(url, options)
+
+```ts
+await probe("https://github.com", {
+  timeout: 5000,
+});
+```
+
+| Option  | Type   | Description                     |
+| ------- | ------ | ------------------------------- |
+| timeout | number | Request timeout in milliseconds |
+
+## Supported Sources
+
+### Open Graph
+
+```html
+<meta property="og:title" />
+<meta property="og:description" />
+<meta property="og:image" />
+```
+
+### Twitter Cards
+
+```html
+<meta name="twitter:title" />
+<meta name="twitter:description" />
+<meta name="twitter:image" />
+```
+
+### HTML Metadata
+
+```html
+<title>...</title>
+<meta name="description" />
+<link rel="icon" />
+<link rel="canonical" />
+```
+
+## Error Handling
+
+```ts
+const result = await probe(url);
+
+if (result.status === "failed") {
+  console.error(result.error.code, result.error.message);
+}
+```
+
+Possible error codes:
+
+```txt
+FETCH_FAILED
+TIMEOUT
+UNKNOWN_ERROR
+```
+
+## TypeScript
+
+All public APIs are fully typed and exported by the package.
+
+```ts
+import type {Metadata, ProbeResult, ProbeOptions, ResolvedMetadata} from "@linkprobe/core";
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkprobe/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Core metadata extraction engine for LinkProbe",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -9,16 +9,21 @@
     "dist"
   ],
   "license": "MIT",
-  "author": "Hossein-i",
+  "author": {
+    "name": "Hossein-i",
+    "email": "sayhi@hossein-i.ir",
+    "url": "https://www.hossein-i.ir"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Hossein-i/linkprobe.git",
+    "url": "git+https://github.com/linkprobe/linkprobe.git",
     "directory": "packages/core"
   },
   "bugs": {
-    "url": "https://github.com/Hossein-i/linkprobe/issues"
+    "url": "https://github.com/linkprobe/linkprobe/issues",
+    "email": "sayhi@hossein-i.ir"
   },
-  "homepage": "https://github.com/Hossein-i/linkprobe",
+  "homepage": "https://github.com/linkprobe/linkprobe",
   "dependencies": {
     "cheerio": "^1.2.0"
   },
@@ -26,7 +31,7 @@
     "tsup": "^8.5.1",
     "typescript": "6.0.3",
     "vitest": "^4.1.7",
-    "@linkprobe/standard": "0.1.0"
+    "@linkprobe/standard": "0.1.1"
   },
   "publishConfig": {
     "access": "public"