@internetarchive/recaptcha-manager 0.1.2-alpha.1 → 1.0.0

package/eslint.config.mjs

@@ -0,0 +1,53 @@
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import html from 'eslint-plugin-html';
+import tsParser from '@typescript-eslint/parser';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  ...compat.extends('plugin:@typescript-eslint/recommended'),
+  {
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+      html,
+    },
+
+    languageOptions: {
+      parser: tsParser,
+    },
+
+    settings: {
+      'import/resolver': {
+        node: {
+          extensions: ['.ts', '.tsx'],
+          moduleDirectory: ['node_modules', 'src', 'demo'],
+        },
+      },
+    },
+
+    rules: {
+      '@typescript-eslint/no-unsafe-function-type': 'warn',
+      '@typescript-eslint/no-unused-vars': 'warn',
+      '@typescript-eslint/no-explicit-any': 'warn',
+    },
+  },
+  {
+    ignores: ['**/*.js', '**/*.mjs'],
+  },
+  {
+    files: ['**/*.test.ts'],
+    rules: {
+      '@typescript-eslint/no-unused-expressions': 'off',
+    },
+  },
+];

package/index.ts

@@ -1,10 +1,10 @@
-export {
-  RecaptchaManager,
-  RecaptchaManagerInterface,
-} from './src/recaptcha-manager.js';
-
-export {
-  RecaptchaWidget,
-  RecaptchaWidgetInterface,
-  RecaptchaWidgetConfig,
-} from './src/recaptcha-widget.js';
+export {
+  RecaptchaManager,
+  RecaptchaManagerInterface,
+} from './src/recaptcha-manager';
+
+export {
+  RecaptchaWidget,
+  RecaptchaWidgetInterface,
+  RecaptchaWidgetConfig,
+} from './src/recaptcha-widget';

package/package.json

@@ -1,98 +1,76 @@
-{
-  "name": "@internetarchive/recaptcha-manager",
-  "description": "A library that lets you lazy load and interact with reCaptcha.",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/internetarchive/iaux-recaptcha-manager.git"
-  },
-  "license": "AGPL-3.0-only",
-  "author": "Internet Archive",
-  "version": "0.1.2-alpha.1",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "type": "module",
-  "scripts": {
-    "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wds\"",
-    "build": "tsc",
-    "prepare": "tsc && husky install",
-    "lint": "eslint --ext .ts,.html . --ignore-path .gitignore && prettier \"**/*.ts\" --check --ignore-path .gitignore",
-    "format": "eslint --ext .ts,.html . --fix --ignore-path .gitignore && prettier \"**/*.ts\" --write --ignore-path .gitignore",
-    "circular": "madge --circular --extensions ts .",
-    "test": "tsc && yarn run lint && yarn run circular && wtr --coverage",
-    "test:watch": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wtr --watch\""
-  },
-  "types": "dist/index.d.ts",
-  "dependencies": {
-    "@internetarchive/lazy-loader-service": "^0.2.1-alpha.1",
-    "@types/grecaptcha": "^2"
-  },
-  "devDependencies": {
-    "@open-wc/eslint-config": "^7.0.0",
-    "@open-wc/testing": "^3.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.3.1",
-    "@typescript-eslint/parser": "^5.3.1",
-    "@web/dev-server": "^0.1.28",
-    "@web/test-runner": "^0.13.22",
-    "concurrently": "^6.3.0",
-    "eslint": "^8.2.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-lit-a11y": "^2.2.0",
-    "eslint-plugin-wc": "^1.3.2",
-    "husky": "^7.0.0",
-    "lit": "^2.2.0",
-    "madge": "^5.0.1",
-    "nanoevents": "^6.0.2",
-    "prettier": "^2.4.1",
-    "sinon": "^12.0.1",
-    "tslib": "^2.3.1",
-    "typescript": "^4.4.4"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "extends": [
-      "@open-wc",
-      "prettier"
-    ],
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "globals": {
-      "ReCaptchaV2": "readonly"
-    },
-    "rules": {
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": [
-        "error"
-      ],
-      "no-shadow": "off",
-      "@typescript-eslint/no-shadow": [
-        "error"
-      ],
-      "class-methods-use-this": "off",
-      "import/no-unresolved": "off",
-      "import/extensions": [
-        "off",
-        "ignorePackages",
-        {
-          "js": "never",
-          "ts": "never"
-        }
-      ]
-    }
-  },
-  "prettier": {
-    "singleQuote": true,
-    "arrowParens": "avoid"
-  },
-  "lint-staged": {
-    "*.ts": [
-      "eslint --fix",
-      "prettier --write",
-      "git add"
-    ]
-  }
-}
+{
+  "name": "@internetarchive/recaptcha-manager",
+  "description": "A library that lets you lazy load and interact with reCaptcha.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/internetarchive/iaux-recaptcha-manager.git"
+  },
+  "license": "AGPL-3.0-only",
+  "author": "Internet Archive",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "scripts": {
+    "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wds\"",
+    "prepare": "rimraf dist && tsc && husky install",
+    "build": "tsc",
+    "lint": "eslint . && prettier \"**/*.ts\" --check",
+    "format": "eslint . --fix && prettier \"**/*.ts\" --write",
+    "circular": "madge --circular --extensions ts .",
+    "test": "tsc && npm run lint && npm run circular && wtr --coverage",
+    "test:watch": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wtr --watch\"",
+    "ghpages:build": "rimraf ghpages && npm run prepare && vite build",
+    "ghpages:publish": "npm run ghpages:prepare -e $(git branch --show-current)",
+    "ghpages:prepare": "npm run ghpages:build && touch ghpages/.nojekyll && npm run ghpages:generate",
+    "ghpages:generate": "gh-pages -t -d ghpages -m \"Build for $(git log --pretty=format:\"%h %an %ai %s\" -n1) [skip ci]\""
+  },
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@open-wc/eslint-config": "^12.0.3",
+    "@open-wc/testing": "^4.0.0",
+    "@types/mocha": "^10.0.10",
+    "@typescript-eslint/eslint-plugin": "^8.19.1",
+    "@typescript-eslint/parser": "^8.19.1",
+    "@web/dev-server": "^0.4.6",
+    "@web/test-runner": "^0.20.0",
+    "concurrently": "^9.1.2",
+    "eslint": "^9.17.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-html": "^8.1.2",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-lit": "^1.15.0",
+    "eslint-plugin-lit-a11y": "^4.1.4",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-wc": "^2.2.0",
+    "gh-pages": "^6.3.0",
+    "husky": "^9.1.7",
+    "madge": "^8.0.0",
+    "nanoevents": "^6.0.2",
+    "prettier": "^3.4.2",
+    "rimraf": "^6.0.1",
+    "sinon": "^19.0.2",
+    "ts-lit-plugin": "^2.0.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.7"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "prettier": {
+    "singleQuote": true,
+    "arrowParens": "avoid"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix",
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "dependencies": {
+    "lit": "^2.8.0",
+    "@internetarchive/lazy-loader-service": "^0.2.0",
+    "@types/grecaptcha": "^2"
+  }
+}

package/renovate.json

@@ -0,0 +1,6 @@
+{
+  "extends": [
+    "config:base",
+    ":preserveSemverRanges"
+  ]
+}

package/src/recaptcha-manager.ts

@@ -1,87 +1,89 @@
-import {
-  LazyLoaderService,
-  LazyLoaderServiceInterface,
-} from '@internetarchive/lazy-loader-service';
-import { RecaptchaWidget, RecaptchaWidgetInterface } from './recaptcha-widget.js';
-
-export interface RecaptchaManagerInterface {
-  /**
-   * Load a recaptcha widget for a given site key or the default site key.
-   */
-  getRecaptchaWidget(options?: {
-    siteKey?: string;
-    recaptchaParams?: ReCaptchaV2.Parameters;
-  }): Promise<RecaptchaWidgetInterface>;
-}
-
-export class RecaptchaManager implements RecaptchaManagerInterface {
-  private lazyLoader: LazyLoaderServiceInterface;
-
-  private defaultSiteKey?: string;
-
-  private recaptchaCache: Record<string, RecaptchaWidget> = {};
-
-  constructor(options?: {
-    defaultSiteKey?: string;
-    lazyLoader?: LazyLoaderServiceInterface;
-    grecaptchaLibrary?: ReCaptchaV2.ReCaptcha; // allows dependency injection or will be lazy loaded
-  }) {
-    this.defaultSiteKey = options?.defaultSiteKey;
-    this.lazyLoader = options?.lazyLoader ?? new LazyLoaderService();
-    this.grecaptchaLibraryCache = options?.grecaptchaLibrary;
-  }
-
-  /** @inheritdoc */
-  async getRecaptchaWidget(options?: {
-    siteKey?: string;
-    recaptchaParams?: ReCaptchaV2.Parameters;
-  }): Promise<RecaptchaWidgetInterface> {
-    const key = options?.siteKey ?? this.defaultSiteKey;
-    if (!key) {
-      throw new Error('The reCaptcha widget requires a site key');
-    }
-
-    const cached = this.recaptchaCache[key];
-    if (cached) return cached;
-
-    const grecaptchaLibrary = await this.getRecaptchaLibrary();
-    const recaptcha = new RecaptchaWidget(
-      {
-        siteKey: key,
-        grecaptchaLibrary,
-      },
-      options?.recaptchaParams
-    );
-
-    this.recaptchaCache[key] = recaptcha;
-    return recaptcha;
-  }
-
-  /**
-   * Load the Recaptch library from Google.
-   *
-   * @returns Promise<ReCaptchaV2.ReCaptcha>
-   */
-  private async getRecaptchaLibrary(): Promise<ReCaptchaV2.ReCaptcha> {
-    if (this.grecaptchaLibraryCache) {
-      return this.grecaptchaLibraryCache;
-    }
-    return new Promise(resolve => {
-      (window as any).grecaptchaLoadedCallback = (): void => {
-        setTimeout(() => {
-          // remove the callback when we're done with it
-          delete (window as any).grecaptchaLoadedCallback;
-        }, 10);
-        this.grecaptchaLibraryCache = window.grecaptcha;
-        resolve(window.grecaptcha);
-      };
-
-      this.lazyLoader.loadScript({
-        src: 'https://www.google.com/recaptcha/api.js?onload=grecaptchaLoadedCallback&render=explicit',
-      });
-    });
-  }
-
-  /** don't use directly, use `getRecaptchaLibrary()` */
-  private grecaptchaLibraryCache?: ReCaptchaV2.ReCaptcha;
-}
+import {
+  LazyLoaderService,
+  LazyLoaderServiceInterface,
+} from '@internetarchive/lazy-loader-service';
+import { RecaptchaWidget, RecaptchaWidgetInterface } from './recaptcha-widget';
+
+export interface RecaptchaManagerInterface {
+  /**
+   * Load a recaptcha widget for a given site key or the default site key.
+   */
+  getRecaptchaWidget(options?: {
+    siteKey?: string;
+    recaptchaParams?: ReCaptchaV2.Parameters;
+  }): Promise<RecaptchaWidgetInterface>;
+}
+
+export class RecaptchaManager implements RecaptchaManagerInterface {
+  private lazyLoader: LazyLoaderServiceInterface;
+
+  private defaultSiteKey?: string;
+
+  private recaptchaCache: Record<string, RecaptchaWidget> = {};
+
+  constructor(options?: {
+    defaultSiteKey?: string;
+    lazyLoader?: LazyLoaderServiceInterface;
+    grecaptchaLibrary?: ReCaptchaV2.ReCaptcha; // allows dependency injection or will be lazy loaded
+  }) {
+    this.defaultSiteKey = options?.defaultSiteKey;
+    this.lazyLoader = options?.lazyLoader ?? new LazyLoaderService();
+    this.grecaptchaLibraryCache = options?.grecaptchaLibrary;
+  }
+
+  /** @inheritdoc */
+  async getRecaptchaWidget(options?: {
+    siteKey?: string;
+    recaptchaParams?: ReCaptchaV2.Parameters;
+  }): Promise<RecaptchaWidgetInterface> {
+    const key = options?.siteKey ?? this.defaultSiteKey;
+    if (!key) {
+      throw new Error('The reCaptcha widget requires a site key');
+    }
+
+    const cached = this.recaptchaCache[key];
+    if (cached) return cached;
+
+    const grecaptchaLibrary = await this.getRecaptchaLibrary();
+    const recaptcha = new RecaptchaWidget(
+      {
+        siteKey: key,
+        grecaptchaLibrary,
+      },
+      options?.recaptchaParams,
+    );
+
+    this.recaptchaCache[key] = recaptcha;
+    return recaptcha;
+  }
+
+  /**
+   * Load the Recaptch library from Google.
+   *
+   * @returns Promise<ReCaptchaV2.ReCaptcha>
+   */
+  private async getRecaptchaLibrary(): Promise<ReCaptchaV2.ReCaptcha> {
+    if (this.grecaptchaLibraryCache) {
+      return this.grecaptchaLibraryCache;
+    }
+    return new Promise(resolve => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (window as any).grecaptchaLoadedCallback = (): void => {
+        setTimeout(() => {
+          // remove the callback when we're done with it
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          delete (window as any).grecaptchaLoadedCallback;
+        }, 10);
+        this.grecaptchaLibraryCache = window.grecaptcha;
+        resolve(window.grecaptcha);
+      };
+
+      this.lazyLoader.loadScript({
+        src: 'https://www.google.com/recaptcha/api.js?onload=grecaptchaLoadedCallback&render=explicit',
+      });
+    });
+  }
+
+  /** don't use directly, use `getRecaptchaLibrary()` */
+  private grecaptchaLibraryCache?: ReCaptchaV2.ReCaptcha;
+}