@synstack/web 1.1.3 → 1.1.5

package/README.md

@@ -1 +1,106 @@
-# @synstack/yaml
+# @synstack/web
+
+Web utilities for fetching and parsing web content
+
+> [!WARNING]
+> This package is included in the [@synstack/synscript](../synscript/README.md) package. It is not recommended to install both packages at the same time.
+
+## What is it for?
+
+This package provides utilities for fetching and parsing web content, including JSON data, plain text, and article extraction:
+
+```typescript
+import { fetchJson, fetchText, fetchArticle } from "@synstack/web";
+
+// Fetch and validate JSON data
+const data = await fetchJson("https://api.example.com/data", {
+  schema: myZodSchema,
+});
+
+// Fetch plain text content
+const text = await fetchText("https://example.com/content.txt");
+
+// Extract article content
+const article = await fetchArticle("https://blog.example.com/post");
+console.log(article.title); // Article title
+console.log(article.content); // Article HTML content
+```
+
+## Installation
+
+```bash
+npm install @synstack/web
+# or
+yarn add @synstack/web
+# or
+pnpm add @synstack/web
+```
+
+## Features
+
+### JSON Fetching
+
+Fetch and validate JSON data with optional schema validation:
+
+```typescript
+import { fetchJson } from "@synstack/web";
+import { z } from "zod";
+
+// Define a schema for type safety
+const userSchema = z.object({
+  id: z.number(),
+  name: z.string(),
+});
+
+// Fetch and validate JSON data
+const user = await fetchJson("https://api.example.com/user", {
+  schema: userSchema,
+});
+```
+
+### Text Fetching
+
+Retrieve plain text content from URLs:
+
+```typescript
+import { fetchText } from "@synstack/web";
+
+// Fetch text content
+const content = await fetchText("https://example.com/content.txt");
+```
+
+### Article Extraction
+
+Extract article content from web pages using Mozilla's Readability:
+
+```typescript
+import { fetchArticle } from "@synstack/web";
+
+// Extract article content
+const article = await fetchArticle("https://blog.example.com/post");
+
+console.log({
+  title: article.title, // Article title
+  content: article.content, // Article HTML content
+  byline: article.byline, // Author information
+  siteName: article.siteName, // Website name
+  lang: article.lang, // Article language
+  publishedTime: article.publishedTime, // Publication time
+});
+```
+
+### Error Handling
+
+Handle article extraction errors:
+
+```typescript
+import { fetchArticle, ArticleNotFoundException } from "@synstack/web";
+
+try {
+  const article = await fetchArticle("https://example.com/not-an-article");
+} catch (error) {
+  if (error instanceof ArticleNotFoundException) {
+    console.error("Could not extract article:", error.message);
+  }
+}
+```

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Web scraping utilities",
   "keywords": [
     "web",
@@ -20,7 +20,7 @@
   "homepage": "https://github.com/pAIrprogio/synscript/tree/main/packages/web",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pAIrprogio/syn-stack.git",
+    "url": "https://github.com/pAIrprogio/synscript.git",
     "directory": "packages/web"
   },
   "license": "Apache-2.0",
@@ -63,5 +63,5 @@
     "!src/**/*.test.ts",
     "dist/**/*"
   ],
-  "gitHead": "348d1987aba7aee8fbc5469d071e3c71663fc775"
+  "gitHead": "886036553ab02c6c1b98289b1de64240de866521"
 }