xscrape 1.1.1 → 1.3.0

package/README.md

@@ -20,7 +20,7 @@ Effect Schema, allowing you to use your preferred validation tool.
 | Schema Library                                       | Status              | Notes                                                              |
 | ---------------------------------------------------- | ------------------- | ------------------------------------------------------------------ |
 | [Zod](https://github.com/colinhacks/zod)             | ✅ Supported        | Default schema tool for `xscrape`                                  |
-| [Effect/Schema](https://github.com/Effect-TS/schema) | 🚧 Planned          | Planned support for Effect/Schema for additional flexibility       |
+| [Effect/Schema](https://github.com/Effect-TS/effect) | ✅ Supported        | Support for Effect/Schema for additional flexibility               |
 | [Joi](https://github.com/sideway/joi)                | 🚧 Planned          | Support for Joi for those familiar with server-side validation     |
 | [Yup](https://github.com/jquense/yup)                | 🚧 Planned          | Adding Yup support for schema validation in front-end applications |
 | Others...                                            | 🔄 In Consideration | Potential support for other schema tools as per user feedback      |

package/dist/index.cjs

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  EffectValidator: () => EffectValidator,
   ZodValidator: () => ZodValidator,
   createScraper: () => createScraper
 });
@@ -81,6 +82,19 @@ var createScraper = ({
   };
 };
 
+// src/validators/effect.ts
+var Schema = __toESM(require("effect/Schema"), 1);
+var import_effect = require("effect");
+var EffectValidator = class {
+  constructor(schema) {
+    this.schema = schema;
+  }
+  validate(data) {
+    const result = Schema.decodeUnknown(this.schema)(data);
+    return import_effect.Effect.runSync(result);
+  }
+};
+
 // src/validators/zod.ts
 var import_zod = require("zod");
 var ZodValidator = class {
@@ -93,6 +107,7 @@ var ZodValidator = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  EffectValidator,
   ZodValidator,
   createScraper
 });

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import * as cheerio from 'cheerio';
+import * as Schema from 'effect/Schema';
 import { ZodSchema } from 'zod';
 
 type ScrapeConfig<T> = {
@@ -24,10 +25,16 @@ interface SchemaValidator<T> {
 
 declare const createScraper: <T>({ fields, validator, }: ScrapeConfig<T>) => ((html: cheerio.CheerioAPI | string) => T);
 
+declare class EffectValidator<A, I = A> implements SchemaValidator<A> {
+    private schema;
+    constructor(schema: Schema.Schema<A, I>);
+    validate(data: unknown): A;
+}
+
 declare class ZodValidator<T> implements SchemaValidator<T> {
     private schema;
     constructor(schema: ZodSchema<T>);
     validate(data: unknown): T;
 }
 
-export { type FieldDefinition, type SchemaFieldDefinitions, type SchemaValidator, type ScrapeConfig, ZodValidator, createScraper };
+export { EffectValidator, type FieldDefinition, type SchemaFieldDefinitions, type SchemaValidator, type ScrapeConfig, ZodValidator, createScraper };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as cheerio from 'cheerio';
+import * as Schema from 'effect/Schema';
 import { ZodSchema } from 'zod';
 
 type ScrapeConfig<T> = {
@@ -24,10 +25,16 @@ interface SchemaValidator<T> {
 
 declare const createScraper: <T>({ fields, validator, }: ScrapeConfig<T>) => ((html: cheerio.CheerioAPI | string) => T);
 
+declare class EffectValidator<A, I = A> implements SchemaValidator<A> {
+    private schema;
+    constructor(schema: Schema.Schema<A, I>);
+    validate(data: unknown): A;
+}
+
 declare class ZodValidator<T> implements SchemaValidator<T> {
     private schema;
     constructor(schema: ZodSchema<T>);
     validate(data: unknown): T;
 }
 
-export { type FieldDefinition, type SchemaFieldDefinitions, type SchemaValidator, type ScrapeConfig, ZodValidator, createScraper };
+export { EffectValidator, type FieldDefinition, type SchemaFieldDefinitions, type SchemaValidator, type ScrapeConfig, ZodValidator, createScraper };

package/dist/index.js

@@ -44,6 +44,19 @@ var createScraper = ({
   };
 };
 
+// src/validators/effect.ts
+import * as Schema from "effect/Schema";
+import { Effect } from "effect";
+var EffectValidator = class {
+  constructor(schema) {
+    this.schema = schema;
+  }
+  validate(data) {
+    const result = Schema.decodeUnknown(this.schema)(data);
+    return Effect.runSync(result);
+  }
+};
+
 // src/validators/zod.ts
 import "zod";
 var ZodValidator = class {
@@ -55,6 +68,7 @@ var ZodValidator = class {
   }
 };
 export {
+  EffectValidator,
   ZodValidator,
   createScraper
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xscrape",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "A flexible and powerful library designed to extract and transform data from HTML documents using user-defined schemas",
   "main": "dist/index.js",
   "exports": {
@@ -13,16 +13,6 @@
     "dist"
   ],
   "type": "module",
-  "scripts": {
-    "build": "tsup",
-    "ci": "npm run build && npm run check-format && npm run check-exports && npm run lint && npm run test",
-    "lint": "tsc",
-    "test": "vitest run",
-    "format": "prettier --write .",
-    "check-format": "prettier --check .",
-    "check-exports": "attw --pack .",
-    "local-release": "npm run ci && changeset version && changeset publish"
-  },
   "keywords": [
     "web-scraping",
     "data-extraction",
@@ -58,6 +48,17 @@
   },
   "dependencies": {
     "cheerio": "^1.0.0",
+    "effect": "^3.10.4",
     "zod": "^3.23.8"
+  },
+  "scripts": {
+    "build": "tsup",
+    "ci": "npm run build && npm run check-format && npm run check-exports && npm run lint && npm run test",
+    "lint": "tsc",
+    "test": "vitest run",
+    "format": "prettier --write ./src",
+    "check-format": "prettier --check ./src",
+    "check-exports": "attw --pack .",
+    "local-release": "npm run ci && changeset version && changeset publish"
   }
-}
+}