feat: type declarations (#7)

Author: DSergiu

.npmrc

@@ -2,4 +2,4 @@ public-hoist-pattern[]=*eslint*
 public-hoist-pattern[]=*prettier*
 public-hoist-pattern[]=@types*
 
-auto-install-peers=true
+auto-install-peers=true

.nvmrc

@@ -1 +1 @@
-v18.16
+v18.16

README.md

@@ -30,17 +30,17 @@ const { response } = await hcaptcha.execute({ async: true });
 ```
 
 ### Props
-|Name|Values/Type|Required|Default|Description|
-|---|---|---|---|---|
-|`loadAsync`|Boolean|No|`true`|Set if the script should be loaded asynchronously.|
-|`cleanup`|Boolean|No|`true`|Remove script tag after setup.|
-|`crossOrigin`|String|No|`-`|Set script cross origin attribute such as "anonymous".|
-|`scriptLocation`|HTMLElement|No|`document.head`| Location of where to append the script tag. Make sure to add it to an area that will persist to prevent loading multiple times in the same document view.|
-|`apihost`|String|No|`-`|See enterprise docs.|
-|`assethost`|String|No|`-`|See enterprise docs.|
-|`endpoint`|String|No|`-`|See enterprise docs.|
-|`host`|String|No|`-`|See enterprise docs.|
-|`imghost`|String|No|`-`|See enterprise docs.|
-|`reportapi`|String|No|`-`|See enterprise docs.|
-|`sentry`|Boolean|No|`-`|See enterprise docs.|
-|`custom`|Boolean|No|`-`|See enterprise docs.|
+| Name             | Values/Type | Required | Default         | Description                                                                                                                                               |
+|------------------|-------------|----------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `loadAsync`      | Boolean     | No       | `true`          | Set if the script should be loaded asynchronously.                                                                                                        |
+| `cleanup`        | Boolean     | No       | `true`          | Remove script tag after setup.                                                                                                                            |
+| `crossOrigin`    | String      | No       | `-`             | Set script cross origin attribute such as "anonymous".                                                                                                    |
+| `scriptLocation` | HTMLElement | No       | `document.head` | Location of where to append the script tag. Make sure to add it to an area that will persist to prevent loading multiple times in the same document view. |
+| `apihost`        | String      | No       | `-`             | See enterprise docs.                                                                                                                                      |
+| `assethost`      | String      | No       | `-`             | See enterprise docs.                                                                                                                                      |
+| `endpoint`       | String      | No       | `-`             | See enterprise docs.                                                                                                                                      |
+| `host`           | String      | No       | `-`             | See enterprise docs.                                                                                                                                      |
+| `imghost`        | String      | No       | `-`             | See enterprise docs.                                                                                                                                      |
+| `reportapi`      | String      | No       | `-`             | See enterprise docs.                                                                                                                                      |
+| `sentry`         | Boolean     | No       | `-`             | See enterprise docs.                                                                                                                                      |
+| `custom`         | Boolean     | No       | `-`             | See enterprise docs.                                                                                                                                      |

lib/esbuild.config.js

@@ -25,7 +25,7 @@ const config = {
   bundle: true,
   entryPoints: [resolve(SRC, 'index.ts')],
   external: ['@hcaptcha/types'],
-  tsconfig: './tsconfig.json',
+  tsconfig: 'tsconfig.json',
   define: {
       'process.env.SENTRY_DSN_TOKEN': JSON.stringify(SENTRY),
 

lib/package.json

@@ -4,11 +4,11 @@
   "type": "module",
   "main": "src/index.ts",
   "scripts": {
-    "compile:build": "node ./esbuild.config.js",
+    "compile:build": "rm -rf ../dist && node ./esbuild.config.js && tsc -p tsconfig.types.json",
     "compile:watch": "WATCH=true node ./esbuild.config.js",
     "fix:lint": "eslint -c .eslintrc.json --fix ./src",
     "test:lint": "eslint -c .eslintrc.json ./src",
-    "test:types": "tsc --project ./tsconfig.json",
+    "test:types": "tsc -p tsconfig.json",
     "test:unit": "jest"
   },
   "dependencies": {

lib/src/index.ts

@@ -1 +1 @@
-export { hCaptchaLoader } from './loader.js';
+export { hCaptchaLoader } from './loader';

lib/tsconfig.json

@@ -4,17 +4,17 @@
   "compilerOptions": {
     "target": "esnext",
     "module": "esnext",
-    "moduleResolution": "node"
+    "moduleResolution": "node",
+    "isolatedModules": true,
+    "noEmit": true
   },
-
   "types": [
     "node",
     "jest",
     "@hcaptcha/types"
   ],
 
   "include": [
-    "./jest.setup.ts",
     "./src/**/*"
   ],
 

lib/tsconfig.types.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../tsconfig.json",
+
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "declaration": true,
+    "isolatedModules": false,
+    "emitDeclarationOnly": true,
+    "outDir": "../dist/types"
+  },
+
+  "include": [
+    "src/**/*"
+  ]
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hcaptcha/loader",
   "description": "This is a JavaScript library to easily configure the loading of the hCaptcha JS client SDK with built-in error handling.",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "author": "hCaptcha team and contributors",
   "license": "MIT",
   "keywords": [
@@ -10,28 +10,30 @@
   ],
   "type": "module",
   "main": "dist/index.mjs",
+  "types": "dist/types/src/index.d.ts",
   "exports": {
     "import": "dist/index.mjs",
-    "require": "dis/index.cjs"
+    "require": "dist/index.cjs"
   },
   "files": [
     "README.md",
-    "dist"
+    "dist",
+    "!**/*.tsbuildinfo"
   ],
   "repository": {
     "type": "git",
     "url": "https://github.com/hCaptcha/hcaptcha-loader.git"
   },
   "scripts": {
     "prepare": "pnpm run build:lib",
-    "build:lib": "pnpm --filter @loader/lib run compile:build",
-    "dev:lib": "pnpm --filter @loader/lib run compile:watch",
+    "build:lib": "pnpm -r --stream run compile:build",
+    "dev:lib": "pnpm -r --stream run compile:watch",
     "display:demo": "http-server ./ --cors -d -o ./demo/src",
     "serve:demo": "http-server ./",
-    "fix:lint": "pnpm --filter @loader/* run fix:lint",
-    "test:lint": "pnpm --filter @loader/* run test:lint",
-    "test:types": "pnpm --filter @loader/* run test:types",
-    "test:unit": "pnpm --filter @loader/lib run test:unit",
+    "fix:lint": "pnpm -r --stream run fix:lint",
+    "test:lint": "pnpm -r --stream run test:lint",
+    "test:types": "pnpm -r --stream run test:types",
+    "test:unit": "pnpm -r --stream run test:unit",
     "test:integration": "playwright test -c playwright.config.ts"
   },
   "devDependencies": {

tsconfig.json

@@ -5,7 +5,6 @@
     "declaration": true,
     "strict": false,
     "allowJs": true,
-    "noEmit": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
     "incremental": true,
@@ -18,7 +17,6 @@
     "module": "nodenext",
     "moduleResolution": "nodenext",
     "resolveJsonModule": true,
-    "isolatedModules": true,
 
     "typeRoots": [
       "node_modules/@hcaptcha",