Skip to content

Commit 5b2a76d

Browse files
author
nextcaptcha
committed
nextcaptcha typescript
0 parents  commit 5b2a76d

File tree

8 files changed

+1072
-0
lines changed

8 files changed

+1072
-0
lines changed

‎.github/workflows/publish.yaml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Publish to npm
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
publish:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: actions/setup-node@v3
14+
with:
15+
node-version: '16.x'
16+
registry-url: 'https://registry.npmjs.org'
17+
- run: npm ci
18+
- run: npm run build
19+
- run: npm publish
20+
env:
21+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.gitignore

+161
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
node_modules/
146+
147+
# Pyre type checker
148+
.pyre/
149+
150+
# pytype static type analyzer
151+
.pytype/
152+
153+
# Cython debug symbols
154+
cython_debug/
155+
156+
# PyCharm
157+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
158+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
159+
# and can be added to the global gitignore or merged into this file. For a more nuclear
160+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
161+
.idea/

‎.npmignore

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
# Files
3+
.yarn.lock
4+
.gitignore
5+
download.jpg
6+
readme.md
7+
jsdoc.json
8+
.env
9+
.idea/
10+
src/
11+
node_modules/
12+
tests/
13+
tsconfig.json/
14+
out/
15+
docs/
16+
issues/

‎LICENSE

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The MIT License (MIT)
2+
Copyright © 2024 NextCaptcha, https://nextcaptcha.com <[email protected]>
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
6+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7+
8+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# NextCaptcha Node.js SDK
2+
3+
NextCaptcha is a powerful captcha solving service that supports various types of captchas including reCAPTCHA v2,
4+
reCAPTCHA v2 Enterprise, reCAPTCHA v3, reCAPTCHA Mobile, hCaptcha, hCaptcha Enterprise, and FunCaptcha. With
5+
NextCaptcha, you can easily solve a variety of captcha challenges in your automation scripts and programs.
6+
7+
This SDK provides a simple and easy-to-use Node.js interface for interacting with the NextCaptcha API. It supports all
8+
available captcha types and offers intuitive methods for solving different types of captchas.
9+
10+
## Installation
11+
12+
You can install the NextCaptcha Node.js SDK using npm:
13+
14+
```shell
15+
npm install nextcaptcha-ts
16+
```
17+
18+
## Usage
19+
20+
To start using the NextCaptcha Node.js SDK, you first need to obtain your API key from the NextCaptcha Dashboard. Then,
21+
you can create a NextCaptcha instance:
22+
23+
```typescript
24+
import {NextCaptcha} from 'nextcaptcha';
25+
26+
const apiKey = 'YOUR_API_KEY';
27+
const nextCaptcha = new NextCaptcha(apiKey);
28+
```
29+
30+
Now, you can use the nextCaptcha object to solve various types of captchas.
31+
Solving reCAPTCHA v2
32+
To solve reCAPTCHA v2 challenges, use the recaptchaV2 method:
33+
34+
```typescript
35+
const result = await nextCaptcha.recaptchaV2(websiteURL, websiteKey);
36+
```
37+
38+
Solving reCAPTCHA v3
39+
To solve reCAPTCHA v3 challenges, use the recaptchaV3 method:
40+
41+
```typescript
42+
const result = await nextCaptcha.recaptchaV3(websiteURL, websiteKey, pageAction);
43+
```
44+
45+
Solving reCAPTCHA Mobile
46+
To solve reCAPTCHA Mobile challenges, use the recaptchaMobile method:
47+
48+
```typescript
49+
const result = await nextCaptcha.recaptchaMobile(websiteURL, websiteKey);
50+
```
51+
52+
Solving hCaptcha
53+
To solve hCaptcha challenges, use the hcaptcha method:
54+
55+
```typescript
56+
const result = await nextCaptcha.hcaptcha(websiteURL, websiteKey);
57+
```
58+
59+
Solving hCaptcha Enterprise
60+
To solve hCaptcha Enterprise challenges, use the hcaptchaEnterprise method:
61+
62+
```
63+
const result = await nextCaptcha.hcaptchaEnterprise(websiteURL, websiteKey, enterprisePayload);
64+
```
65+
66+
Solving FunCaptcha
67+
To solve FunCaptcha challenges, use the funcaptcha method:
68+
69+
```
70+
const result = await nextCaptcha.funcaptcha(websitePublicKey);
71+
```
72+
73+
Checking Account Balance
74+
To check your NextCaptcha account balance, use the getBalance method:
75+
76+
```
77+
const balance = await nextCaptcha.getBalance();
78+
console.log(`Account balance: ${balance}`);
79+
```
80+
81+
## Error Handling
82+
83+
If an error occurs while solving a captcha, the SDK will throw an error. You can catch and handle these errors using a
84+
try-catch block.
85+
86+
## Contributing
87+
88+
If you find any bugs or have suggestions for improvement, please feel free to submit an issue or send a pull request. We
89+
welcome all contributions!
90+
91+
## License
92+
93+
This project is licensed under the MIT License. For more information, please see the LICENSE file.

0 commit comments

Comments
 (0)