@upcrawl/sdk 1.0.0

package/dist/index.mjs

@@ -0,0 +1,206 @@
+// src/types.ts
+var UpcrawlError = class extends Error {
+  constructor(message, status, code = "UNKNOWN_ERROR") {
+    super(message);
+    this.name = "UpcrawlError";
+    this.status = status;
+    this.code = code;
+  }
+};
+
+// src/client.ts
+import axios from "axios";
+var DEFAULT_BASE_URL = "https://api.upcrawl.dev/api/v1";
+var DEFAULT_TIMEOUT = 12e4;
+var globalConfig = {
+  apiKey: void 0,
+  baseUrl: DEFAULT_BASE_URL,
+  timeout: DEFAULT_TIMEOUT
+};
+function createClient() {
+  if (!globalConfig.apiKey) {
+    throw new UpcrawlError(
+      "API key not set. Call Upcrawl.setApiKey(apiKey) before making requests.",
+      401,
+      "API_KEY_NOT_SET"
+    );
+  }
+  return axios.create({
+    baseURL: globalConfig.baseUrl,
+    timeout: globalConfig.timeout,
+    headers: {
+      "Content-Type": "application/json",
+      "Authorization": `Bearer ${globalConfig.apiKey}`
+    }
+  });
+}
+function handleError(error) {
+  if (axios.isAxiosError(error)) {
+    const axiosError = error;
+    const status = axiosError.response?.status || 500;
+    const data = axiosError.response?.data;
+    if (data?.error) {
+      throw new UpcrawlError(data.error.message, status, data.error.code);
+    }
+    switch (status) {
+      case 401:
+        throw new UpcrawlError("Invalid or missing API key", 401, "UNAUTHORIZED");
+      case 403:
+        throw new UpcrawlError("Access forbidden", 403, "FORBIDDEN");
+      case 404:
+        throw new UpcrawlError("Resource not found", 404, "NOT_FOUND");
+      case 429:
+        throw new UpcrawlError("Rate limit exceeded", 429, "RATE_LIMIT_EXCEEDED");
+      case 500:
+        throw new UpcrawlError("Internal server error", 500, "INTERNAL_ERROR");
+      case 503:
+        throw new UpcrawlError("Service unavailable", 503, "SERVICE_UNAVAILABLE");
+      default:
+        throw new UpcrawlError(
+          axiosError.message || "An unknown error occurred",
+          status,
+          "UNKNOWN_ERROR"
+        );
+    }
+  }
+  if (error instanceof UpcrawlError) {
+    throw error;
+  }
+  throw new UpcrawlError(
+    error instanceof Error ? error.message : "An unknown error occurred",
+    500,
+    "UNKNOWN_ERROR"
+  );
+}
+function setApiKey(apiKey) {
+  if (!apiKey || typeof apiKey !== "string") {
+    throw new UpcrawlError("API key must be a non-empty string", 400, "INVALID_API_KEY");
+  }
+  globalConfig.apiKey = apiKey;
+}
+function setBaseUrl(baseUrl) {
+  if (!baseUrl || typeof baseUrl !== "string") {
+    throw new UpcrawlError("Base URL must be a non-empty string", 400, "INVALID_BASE_URL");
+  }
+  globalConfig.baseUrl = baseUrl.replace(/\/$/, "");
+}
+function setTimeout(timeout) {
+  if (typeof timeout !== "number" || timeout < 1e3) {
+    throw new UpcrawlError("Timeout must be a number >= 1000ms", 400, "INVALID_TIMEOUT");
+  }
+  globalConfig.timeout = timeout;
+}
+function configure(config) {
+  if (config.apiKey) setApiKey(config.apiKey);
+  if (config.baseUrl) setBaseUrl(config.baseUrl);
+  if (config.timeout) setTimeout(config.timeout);
+}
+function getConfig() {
+  return {
+    apiKeySet: !!globalConfig.apiKey,
+    baseUrl: globalConfig.baseUrl,
+    timeout: globalConfig.timeout
+  };
+}
+function resetConfig() {
+  globalConfig = {
+    apiKey: void 0,
+    baseUrl: DEFAULT_BASE_URL,
+    timeout: DEFAULT_TIMEOUT
+  };
+}
+async function scrape(options) {
+  try {
+    const client = createClient();
+    const response = await client.post("/scrape/single", options);
+    return response.data;
+  } catch (error) {
+    handleError(error);
+  }
+}
+async function batchScrape(options) {
+  try {
+    const client = createClient();
+    const response = await client.post("/scrape/batch", options);
+    return response.data;
+  } catch (error) {
+    handleError(error);
+  }
+}
+async function search(options) {
+  try {
+    const client = createClient();
+    const response = await client.post("/search", options);
+    return response.data;
+  } catch (error) {
+    handleError(error);
+  }
+}
+
+// src/index.ts
+var Upcrawl = {
+  /**
+   * Set the API key globally
+   * @param apiKey - Your Upcrawl API key (starts with 'uc-')
+   */
+  setApiKey,
+  /**
+   * Set a custom base URL (useful for self-hosted or testing)
+   * @param baseUrl - Custom API base URL
+   */
+  setBaseUrl,
+  /**
+   * Set request timeout in milliseconds
+   * @param timeout - Timeout in milliseconds
+   */
+  setTimeout,
+  /**
+   * Configure multiple options at once
+   * @param config - Configuration object
+   */
+  configure,
+  /**
+   * Get current configuration (for debugging)
+   */
+  getConfig,
+  /**
+   * Reset configuration to defaults
+   */
+  resetConfig,
+  /**
+   * Scrape a single URL
+   * @param options - Scrape options including the URL to scrape
+   * @returns Promise with scrape response
+   */
+  scrape,
+  /**
+   * Scrape multiple URLs in a batch
+   * @param options - Batch scrape options including URLs to scrape
+   * @returns Promise with batch scrape response
+   */
+  batchScrape,
+  /**
+   * Search the web
+   * @param options - Search options including queries
+   * @returns Promise with search response
+   */
+  search,
+  /**
+   * Error class for Upcrawl API errors
+   */
+  UpcrawlError
+};
+var index_default = Upcrawl;
+export {
+  UpcrawlError,
+  batchScrape,
+  configure,
+  index_default as default,
+  getConfig,
+  resetConfig,
+  scrape,
+  search,
+  setApiKey,
+  setBaseUrl,
+  setTimeout
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@upcrawl/sdk",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Official Upcrawl SDK - Extract data from any website with a single API call",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "upcrawl",
+    "web-scraping",
+    "scraper",
+    "crawler",
+    "web-crawler",
+    "data-extraction",
+    "ai",
+    "llm",
+    "markdown",
+    "search",
+    "api"
+  ],
+  "author": "Upcrawl",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/upcrawl/upcrawl-js"
+  },
+  "homepage": "https://upcrawl.dev",
+  "bugs": {
+    "url": "https://github.com/upcrawl/upcrawl-js/issues"
+  },
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}