@isdk/web-fetcher 0.2.0

package/docs/interfaces/PendingEngineRequest.md

@@ -0,0 +1,51 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / PendingEngineRequest
+
+# Interface: PendingEngineRequest
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:108](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L108)
+
+Represents a pending navigation request awaiting resolution.
+
+## Remarks
+
+Tracks navigation requests that have been queued but not yet processed by the request handler.
+
+## Properties
+
+### reject()
+
+> **reject**: (`reason?`) => `void`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:110](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L110)
+
+#### Parameters
+
+##### reason?
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### resolve()
+
+> **resolve**: (`value`) => `void`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:109](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L109)
+
+#### Parameters
+
+##### value
+
+`any`
+
+#### Returns
+
+`void`

package/docs/interfaces/SubmitActionOptions.md

@@ -0,0 +1,23 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / SubmitActionOptions
+
+# Interface: SubmitActionOptions
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:67](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L67)
+
+Options for the [FetchEngine.submit](../classes/FetchEngine.md#submit) action, configuring form submission behavior.
+
+## Remarks
+
+Specifies encoding type for form submissions, particularly relevant for JSON-based APIs.
+
+## Properties
+
+### enctype?
+
+> `optional` **enctype**: `"application/x-www-form-urlencoded"` \| `"application/json"` \| `"multipart/form-data"`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:68](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L68)

package/docs/interfaces/WaitForActionOptions.md

@@ -0,0 +1,39 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / WaitForActionOptions
+
+# Interface: WaitForActionOptions
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:55](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L55)
+
+Options for the [FetchEngine.waitFor](../classes/FetchEngine.md#waitfor) action, specifying conditions to wait for before continuing.
+
+## Remarks
+
+Controls timing behavior for interactions, allowing waiting for elements, time intervals, or network conditions.
+
+## Properties
+
+### ms?
+
+> `optional` **ms**: `number`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:56](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L56)
+
+***
+
+### networkIdle?
+
+> `optional` **networkIdle**: `boolean`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:58](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L58)
+
+***
+
+### selector?
+
+> `optional` **selector**: `string`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:57](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L57)

package/docs/type-aliases/BaseFetchActionOptions.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / BaseFetchActionOptions
+
+# Type Alias: BaseFetchActionOptions
+
+> **BaseFetchActionOptions** = `RequireAtLeastOne`\<[`BaseFetchActionProperties`](../interfaces/BaseFetchActionProperties.md), `"id"` \| `"name"`\>
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:59](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L59)

package/docs/type-aliases/BaseFetchCollectorOptions.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / BaseFetchCollectorOptions
+
+# Type Alias: BaseFetchCollectorOptions
+
+> **BaseFetchCollectorOptions** = `RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](../interfaces/BaseFetchCollectorActionProperties.md), `"id"` \| `"name"`\>
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:72](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L72)

package/docs/type-aliases/BrowserEngine.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / BrowserEngine
+
+# Type Alias: BrowserEngine
+
+> **BrowserEngine** = `"playwright"` \| `"puppeteer"`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:21](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L21)

package/docs/type-aliases/FetchActionCapabilities.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchActionCapabilities
+
+# Type Alias: FetchActionCapabilities
+
+> **FetchActionCapabilities** = `{ [mode in FetchEngineType]?: FetchActionCapabilityMode }`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:80](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L80)

package/docs/type-aliases/FetchActionCapabilityMode.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchActionCapabilityMode
+
+# Type Alias: FetchActionCapabilityMode
+
+> **FetchActionCapabilityMode** = `"native"` \| `"simulate"` \| `"noop"`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:23](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L23)

package/docs/type-aliases/FetchActionOptions.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchActionOptions
+
+# Type Alias: FetchActionOptions
+
+> **FetchActionOptions** = `RequireAtLeastOne`\<[`FetchActionProperties`](../interfaces/FetchActionProperties.md), `"id"` \| `"name"`\>
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:78](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L78)

package/docs/type-aliases/FetchEngineAction.md

@@ -0,0 +1,18 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchEngineAction
+
+# Type Alias: FetchEngineAction
+
+> **FetchEngineAction** = \{ `selector`: `string`; `type`: `"click"`; \} \| \{ `selector`: `string`; `type`: `"fill"`; `value`: `string`; \} \| \{ `options?`: [`WaitForActionOptions`](../interfaces/WaitForActionOptions.md); `type`: `"waitFor"`; \} \| \{ `options?`: [`SubmitActionOptions`](../interfaces/SubmitActionOptions.md); `selector?`: `any`; `type`: `"submit"`; \} \| \{ `type`: `"getContent"`; \} \| \{ `opts?`: [`GotoActionOptions`](../interfaces/GotoActionOptions.md); `type`: `"navigate"`; `url`: `string`; \} \| \{ `schema`: `ExtractSchema`; `type`: `"extract"`; \} \| \{ `message?`: `string`; `type`: `"pause"`; \} \| \{ `type`: `"dispose"`; \}
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:78](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L78)
+
+Union type representing all possible engine actions that can be dispatched.
+
+## Remarks
+
+Defines the command structure processed during page interactions. Each action type corresponds to
+a specific user interaction or navigation command within the action loop architecture.

package/docs/type-aliases/FetchEngineType.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchEngineType
+
+# Type Alias: FetchEngineType
+
+> **FetchEngineType** = `"http"` \| `"browser"`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:20](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L20)

package/docs/type-aliases/FetchReturnType.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchReturnType
+
+# Type Alias: FetchReturnType
+
+> **FetchReturnType** = `"response"` \| `"context"` \| `"outputs"` \| `"any"` \| `"none"`
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:5](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L5)

package/docs/type-aliases/FetchReturnTypeFor.md

@@ -0,0 +1,17 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchReturnTypeFor
+
+# Type Alias: FetchReturnTypeFor\<R\>
+
+> **FetchReturnTypeFor**\<`R`\> = `R` *extends* keyof [`FetchReturnTypeRegistry`](../interfaces/FetchReturnTypeRegistry.md) ? [`FetchReturnTypeRegistry`](../interfaces/FetchReturnTypeRegistry.md)\[`R`\] : `never`
+
+Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:22](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/fetch-return-type.ts#L22)
+
+## Type Parameters
+
+### R
+
+`R` *extends* [`FetchReturnType`](FetchReturnType.md)

package/docs/type-aliases/OnFetchPauseCallback.md

@@ -0,0 +1,23 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / OnFetchPauseCallback
+
+# Type Alias: OnFetchPauseCallback()
+
+> **OnFetchPauseCallback** = (`options`) => `Promise`\<`void`\>
+
+Defined in: [packages/web-fetcher/src/core/types.ts:90](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L90)
+
+## Parameters
+
+### options
+
+#### message?
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/type-aliases/ResourceType.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / ResourceType
+
+# Type Alias: ResourceType
+
+> **ResourceType** = `"image"` \| `"stylesheet"` \| `"font"` \| `"script"` \| `"media"` \| `string`
+
+Defined in: [packages/web-fetcher/src/core/types.ts:24](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L24)

package/docs/variables/DefaultFetcherProperties.md

@@ -0,0 +1,11 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / DefaultFetcherProperties
+
+# Variable: DefaultFetcherProperties
+
+> `const` **DefaultFetcherProperties**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
+
+Defined in: [packages/web-fetcher/src/core/types.ts:131](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/types.ts#L131)

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@isdk/web-fetcher",
+  "version": "0.2.0",
+  "author": "Riceball LEE <snowyu.lee@gmail.com>",
+  "homepage": "https://github.com/isdk/web-fetcher.js",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/isdk/web-fetcher.js.git"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "dependencies": {
+    "@isdk/common-error": "^0.2.0",
+    "camoufox-js": "^0.7.0",
+    "cheerio": "^1.1.2",
+    "crawlee": "^3.15.1",
+    "events-ex": "^2.1.1",
+    "jsdom": "^27.0.0",
+    "lodash-es": "^4.17.21",
+    "playwright": "^1.56.0",
+    "util-ex": "^2.4.0"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^4.10.1",
+    "@fastify/formbody": "^8.0.2",
+    "@types/jest": "^29.5.14",
+    "@types/jsdom": "^27.0.0",
+    "@types/lodash-es": "^4.17.12",
+    "@typescript-eslint/eslint-plugin": "~8.41.0",
+    "eslint": "^9.34.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-tsdoc": "^0.4.0",
+    "fastify": "^5.6.1",
+    "prettier": "^3.6.2",
+    "terser": "^5.44.0",
+    "tsup": "^8.5.0",
+    "tsx": "^4.20.5",
+    "type-fest": "^4.41.0",
+    "typedoc": "^0.28.13",
+    "typedoc-plugin-markdown": "^4.8.1",
+    "typescript": "~5.7.3",
+    "vite": "^7.1.4",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.2.4",
+    "vitest-fetch-mock": "^0.4.5"
+  },
+  "files": [
+    "docs",
+    "dist"
+  ],
+  "keywords": [
+    "web",
+    "fetch",
+    "crawler",
+    "spiler",
+    "structure",
+    "data"
+  ],
+  "maintainers": [
+    "Riceball LEE <snowyu.lee@gmail.com>"
+  ],
+  "engines": {
+    "node": ">=20.11.1"
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build-fast": "tsup",
+    "build": "pnpm run build-fast --dts-resolve --dts && pnpm run doc:md",
+    "clean": "rm -fr web docs dist",
+    "doc": "typedoc --plugin none --out web",
+    "doc:md": "typedoc --plugin typedoc-plugin-markdown --out docs",
+    "style": "pnpm run format:base -c && pnpm run lint",
+    "style:fix": "pnpm run format:fix && npm run lint:fix",
+    "format": "pnpm run format:base -c",
+    "format:base": "prettier \"src/**/*.{ts,tsx,js,jsx,css,scss,sass,less,md}\"",
+    "format:fix": "pnpm run format:base --write",
+    "lint": "eslint .",
+    "lint:fix": "pnpm run lint --fix",
+    "test": "vitest run",
+    "release": "pnpm run clean && pnpm run build && git add -f docs && git ci -m 'docs: update API docs' && pnpm dlx commit-and-tag-version -s",
+    "release.alpha": "pnpm run release -- --prerelease alpha"
+  }
+}