Merge pull request #10 from ScrapeGraphAI/main

Alignment

Author: PeriniM

package.json

@@ -9,9 +9,6 @@
   },
   "author": "ScrapeGraphAI",
   "license": "MIT",
-  "workspaces": [
-    "scrapegraph-js"
-  ],
   "scripts": {
     "semantic-release": "semantic-release"
   },

scrapegraph-js/.prettierignore

@@ -0,0 +1 @@
+/node_modules

scrapegraph-js/.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "useTabs": false,
+  "printWidth": 110,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "quoteProps": "preserve"
+}

scrapegraph-js/eslint.config.js

@@ -0,0 +1,11 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  { languageOptions: { globals: { ...globals.browser, ...globals.node } } },
+  pluginJs.configs.recommended,
+  eslintPluginPrettierRecommended,
+  { ignorePatterns: ['node_modules/'] },
+];

scrapegraph-js/examples/.env.example

@@ -1,2 +1,2 @@
 # ScrapegraphAI API Key
-SGAI-APIKEY="your ScrapegraphAI API Key"
+SGAI_APIKEY="your ScrapegraphAI API Key"

scrapegraph-js/examples/getCredits_example.js

@@ -1,11 +1,10 @@
-import { getCredits } from "scrapegraph-sdk";
+import { getCredits } from 'scrapegraph-js';
 import 'dotenv/config';
 
-try {
-	const apiKey = process.env.SGAI_APIKEY;
+const apiKey = process.env.SGAI_APIKEY;
 
+try {
 	const myCredit = await getCredits(apiKey);
-
 	console.log(myCredit)
 } catch (error) {
 	console.error(error)

scrapegraph-js/examples/getSmartScraperRequest_example.js

@@ -1,12 +1,11 @@
-import { getSmartScraperRequest } from "scrapegraph-sdk";
+import { getSmartScraperRequest } from 'scrapegraph-js';
 import 'dotenv/config';
 
-try {
-  const apiKey = process.env.SGAI_APIKEY;
-  const requestId = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+const apiKey = process.env.SGAI_APIKEY;
+const requestId = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
 
+try {
   const requestInfo = await getSmartScraperRequest(apiKey, requestId);
-
   console.log(requestInfo);
 } catch (error) {
   console.error(error);

scrapegraph-js/examples/schema_smartScraper_example.js

@@ -0,0 +1,16 @@
+import { smartScraper } from 'scrapegraph-js';
+import { z } from 'zod';
+import 'dotenv/config';
+
+const apiKey = process.env.SGAI_APIKEY;
+const url = 'https://scrapegraphai.com/';
+const prompt = 'What does the company do? and ';
+
+const schema = 2;
+
+try {
+  const response = await smartScraper(apiKey, url, prompt, schema);
+  console.log(response.result);
+} catch (error) {
+  console.error(error);
+}

scrapegraph-js/examples/sendFeedback_example.js

@@ -1,12 +1,12 @@
-import { sendFeedback } from "scrapegraph-sdk";
+import { sendFeedback } from 'scrapegraph-js';
 import 'dotenv/config';
 
-try {
-  const apiKey = process.env.SGAI_APIKEY;
-  const requestId = "16a63a80-c87f-4cde-b005-e6c3ecda278b";
-  const rating = 5;
-  const feedbackMessage = "This is a test feedback message.";
+const apiKey = process.env.SGAI_APIKEY;
+const requestId = '16a63a80-c87f-4cde-b005-e6c3ecda278b';
+const rating = 5;
+const feedbackMessage = 'This is a test feedback message.';
 
+try {
   const feedback_response = await sendFeedback(apiKey, requestId, rating, feedbackMessage);
   console.log(feedback_response);
 } catch (error) {

scrapegraph-js/examples/smartScraper_example.js

@@ -1,13 +1,12 @@
-import { smartScraper } from "scrapegraph-sdk";
+import { smartScraper } from 'scrapegraph-js';
 import 'dotenv/config';
 
-try {
-  const apiKey = process.env.SGAI_APIKEY;
-  const url = "https://scrapegraphai.com";
-  const prompt = "What does the company do?";
+const apiKey = process.env.SGAI_APIKEY;
+const url = 'https://scrapegraphai.com';
+const prompt = 'What does the company do?';
 
+try {
   const response = await smartScraper(apiKey, url, prompt);
-
   console.log(response);
 } catch (error) {
   console.error(error);

scrapegraph-js/package-lock.json

@@ -1,13 +1,17 @@
 {
-  "name": "scrapegraph-sdk",
+  "name": "scrapegraph-js",
   "author": "ScrapeGraphAI",
   "version": "0.0.1",
-  "description": "Scrape and extract structured data from a webpage using ScrapeGraph AI.",
+  "description": "Scrape and extract structured data from a webpage using ScrapeGraphAI's APIs.",
   "repository": {
     "type": "git",
     "url": "https://github.com/ScrapeGraphAI/scrapegraph-sdk",
     "directory": "scrapegraph-js"
   },
+  "scripts": {
+    "format": "prettier --write --cache --cache-strategy metadata . !dist",
+    "lint": "eslint ."
+  },
   "license": "MIT",
   "homepage": "https://github.com/ScrapeGraphAI/scrapegraph-sdk/tree/main/scrapegraph-js",
   "keywords": [
@@ -23,9 +27,17 @@
   "module": "index.js",
   "type": "module",
   "dependencies": {
-    "axios": "^1.6.0"
+    "axios": "^1.6.0",
+    "zod": "^3.23.8",
+    "zod-to-json-schema": "^3.23.5"
   },
   "devDependencies": {
-    "dotenv": "^16.4.5"
+    "@eslint/js": "^9.16.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^9.16.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.12.0",
+    "prettier": "3.4.1"
   }
 }