xscrape 3.0.1 → 3.0.2

package/README.md

@@ -1,6 +1,21 @@
-# xscrape
-
-`xscrape` is a powerful and flexible library designed for extracting and transforming data from HTML documents using user-defined schemas. It now supports any validation library that implements the **Standard Schema**, allowing you to bring your own schema for robust, type-safe data validation.
+<p align="center">
+
+  <h1 align="center">🕷️<br/><code>xscrape</code></h1>
+  <p align="center">Extract and transform HTML with your own schema, powered by <code>Standard Schema</code> compatibility.
+    <br/>
+    by <a href="https://github.com/johnie">@johnie</a>
+  </p>
+</p>
+<br/>
+
+<p align="center">
+<a href="https://opensource.org/licenses/MIT" rel="nofollow"><img src="https://img.shields.io/github/license/johnie/xscrape" alt="License"></a>
+<a href="https://www.npmjs.com/package/xscrape" rel="nofollow"><img src="https://img.shields.io/npm/v/xscrape.svg" alt="npm"></a>
+<a href="https://github.com/johnie/xscrape" rel="nofollow"><img src="https://img.shields.io/github/stars/johnie/xscrape" alt="stars"></a>
+</p>
+
+<br/>
+<br/>
 
 ## Features
 

package/dist/index.d.cts

@@ -7,13 +7,14 @@ interface ExtractDescriptor {
     value?: string | ExtractDescriptorFn | ExtractMap;
 }
 type ExtractValue = string | ExtractDescriptor | [string | ExtractDescriptor];
-interface ExtractMap {
-    [key: string]: ExtractValue;
-}
+type ExtractMap = Record<string, ExtractValue>;
 
+type SchemaAwareExtractMap<T> = {
+    [K in keyof T]: ExtractMap[string];
+};
 type ScraperConfig<S extends StandardSchemaV1, R extends StandardSchemaV1.InferOutput<S> = StandardSchemaV1.InferOutput<S>> = {
     schema: S;
-    extract: ExtractMap;
+    extract: SchemaAwareExtractMap<StandardSchemaV1.InferOutput<S>>;
     transform?: (data: StandardSchemaV1.InferOutput<S>) => Promise<R> | R;
 };
 type ValidationResult<T> = {
@@ -26,6 +27,6 @@ type ScraperResult<T> = {
     error?: unknown;
 };
 
-declare function defineScraper<S extends StandardSchemaV1, R extends StandardSchemaV1.InferOutput<S> = StandardSchemaV1.InferOutput<S>>(config: ScraperConfig<S, R>): (html: string) => Promise<ScraperResult<R>>;
+declare function defineScraper<S extends StandardSchemaV1, T extends StandardSchemaV1.InferOutput<S> = StandardSchemaV1.InferOutput<S>, R extends T = T>(config: ScraperConfig<S, R>): (html: string) => Promise<ScraperResult<R>>;
 
 export { type ScraperConfig, type ScraperResult, type ValidationResult, defineScraper };

package/dist/index.d.ts

@@ -7,13 +7,14 @@ interface ExtractDescriptor {
     value?: string | ExtractDescriptorFn | ExtractMap;
 }
 type ExtractValue = string | ExtractDescriptor | [string | ExtractDescriptor];
-interface ExtractMap {
-    [key: string]: ExtractValue;
-}
+type ExtractMap = Record<string, ExtractValue>;
 
+type SchemaAwareExtractMap<T> = {
+    [K in keyof T]: ExtractMap[string];
+};
 type ScraperConfig<S extends StandardSchemaV1, R extends StandardSchemaV1.InferOutput<S> = StandardSchemaV1.InferOutput<S>> = {
     schema: S;
-    extract: ExtractMap;
+    extract: SchemaAwareExtractMap<StandardSchemaV1.InferOutput<S>>;
     transform?: (data: StandardSchemaV1.InferOutput<S>) => Promise<R> | R;
 };
 type ValidationResult<T> = {
@@ -26,6 +27,6 @@ type ScraperResult<T> = {
     error?: unknown;
 };
 
-declare function defineScraper<S extends StandardSchemaV1, R extends StandardSchemaV1.InferOutput<S> = StandardSchemaV1.InferOutput<S>>(config: ScraperConfig<S, R>): (html: string) => Promise<ScraperResult<R>>;
+declare function defineScraper<S extends StandardSchemaV1, T extends StandardSchemaV1.InferOutput<S> = StandardSchemaV1.InferOutput<S>, R extends T = T>(config: ScraperConfig<S, R>): (html: string) => Promise<ScraperResult<R>>;
 
 export { type ScraperConfig, type ScraperResult, type ValidationResult, defineScraper };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xscrape",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "A flexible and powerful library designed to extract and transform data from HTML documents using user-defined schemas",
   "main": "dist/index.js",
   "exports": {
@@ -26,7 +26,8 @@
     "zod",
     "valibot",
     "arktype",
-    "effect-schema"
+    "effect-schema",
+    "standard-schema"
   ],
   "author": "Johnie Hjelm <johnie@hjelm.im>",
   "license": "MIT",