nextcaptcha typescript

.github/workflows/publish.yaml

@@ -0,0 +1,21 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+node_modules/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

.npmignore

@@ -0,0 +1,16 @@
+
+# Files
+.yarn.lock
+.gitignore
+download.jpg
+readme.md
+jsdoc.json
+.env
+.idea/
+src/
+node_modules/
+tests/
+tsconfig.json/
+out/
+docs/
+issues/

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2024 NextCaptcha, https://nextcaptcha.com <[email protected]>
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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

@@ -0,0 +1,93 @@
+# NextCaptcha Node.js SDK
+
+NextCaptcha is a powerful captcha solving service that supports various types of captchas including reCAPTCHA v2,
+reCAPTCHA v2 Enterprise, reCAPTCHA v3, reCAPTCHA Mobile, hCaptcha, hCaptcha Enterprise, and FunCaptcha. With
+NextCaptcha, you can easily solve a variety of captcha challenges in your automation scripts and programs.
+
+This SDK provides a simple and easy-to-use Node.js interface for interacting with the NextCaptcha API. It supports all
+available captcha types and offers intuitive methods for solving different types of captchas.
+
+## Installation
+
+You can install the NextCaptcha Node.js SDK using npm:
+
+```shell
+npm install nextcaptcha-ts
+```
+
+## Usage
+
+To start using the NextCaptcha Node.js SDK, you first need to obtain your API key from the NextCaptcha Dashboard. Then,
+you can create a NextCaptcha instance:
+
+```typescript
+import {NextCaptcha} from 'nextcaptcha';
+
+const apiKey = 'YOUR_API_KEY';
+const nextCaptcha = new NextCaptcha(apiKey);
+```
+
+Now, you can use the nextCaptcha object to solve various types of captchas.
+Solving reCAPTCHA v2
+To solve reCAPTCHA v2 challenges, use the recaptchaV2 method:
+
+```typescript
+const result = await nextCaptcha.recaptchaV2(websiteURL, websiteKey);
+```
+
+Solving reCAPTCHA v3
+To solve reCAPTCHA v3 challenges, use the recaptchaV3 method:
+
+```typescript
+const result = await nextCaptcha.recaptchaV3(websiteURL, websiteKey, pageAction);
+```
+
+Solving reCAPTCHA Mobile
+To solve reCAPTCHA Mobile challenges, use the recaptchaMobile method:
+
+```typescript
+const result = await nextCaptcha.recaptchaMobile(websiteURL, websiteKey);
+```
+
+Solving hCaptcha
+To solve hCaptcha challenges, use the hcaptcha method:
+
+```typescript
+const result = await nextCaptcha.hcaptcha(websiteURL, websiteKey);
+```
+
+Solving hCaptcha Enterprise
+To solve hCaptcha Enterprise challenges, use the hcaptchaEnterprise method:
+
+```
+const result = await nextCaptcha.hcaptchaEnterprise(websiteURL, websiteKey, enterprisePayload);
+```
+
+Solving FunCaptcha
+To solve FunCaptcha challenges, use the funcaptcha method:
+
+```
+const result = await nextCaptcha.funcaptcha(websitePublicKey);
+```
+
+Checking Account Balance
+To check your NextCaptcha account balance, use the getBalance method:
+
+```
+const balance = await nextCaptcha.getBalance();
+console.log(`Account balance: ${balance}`);
+```
+
+## Error Handling
+
+If an error occurs while solving a captcha, the SDK will throw an error. You can catch and handle these errors using a
+try-catch block.
+
+## Contributing
+
+If you find any bugs or have suggestions for improvement, please feel free to submit an issue or send a pull request. We
+welcome all contributions!
+
+## License
+
+This project is licensed under the MIT License. For more information, please see the LICENSE file.