@internetarchive/recaptcha-manager 2.0.0 → 2.0.1

package/test/mock-lazy-loader.ts

@@ -1,36 +1,36 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import {
-  BundleType,
-  LazyLoaderServiceEvents,
-  LazyLoaderServiceInterface,
-} from '@internetarchive/lazy-loader-service';
-import { Unsubscribe } from 'nanoevents';
-
-export class MockLazyLoaderService implements LazyLoaderServiceInterface {
-  loadScriptSrc?: string;
-
-  constructor(private onloadFn: () => unknown = () => {}) {}
-
-  on<E extends keyof LazyLoaderServiceEvents>(
-    event: E,
-    callback: LazyLoaderServiceEvents[E],
-  ): Unsubscribe {
-    throw new Error('Method not implemented.');
-  }
-
-  async loadBundle(bundle: {
-    module?: string;
-    nomodule?: string;
-  }): Promise<void> {
-    console.debug('loadBundle', bundle);
-  }
-
-  async loadScript(options: {
-    src: string;
-    bundleType?: BundleType;
-    attributes?: Record<string, string>;
-  }): Promise<void> {
-    this.loadScriptSrc = options.src;
-    this.onloadFn();
-  }
-}
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  BundleType,
+  LazyLoaderServiceEvents,
+  LazyLoaderServiceInterface,
+} from '@internetarchive/lazy-loader-service';
+import { Unsubscribe } from 'nanoevents';
+
+export class MockLazyLoaderService implements LazyLoaderServiceInterface {
+  loadScriptSrc?: string;
+
+  constructor(private onloadFn: () => unknown = () => {}) {}
+
+  on<E extends keyof LazyLoaderServiceEvents>(
+    event: E,
+    callback: LazyLoaderServiceEvents[E],
+  ): Unsubscribe {
+    throw new Error('Method not implemented.');
+  }
+
+  async loadBundle(bundle: {
+    module?: string;
+    nomodule?: string;
+  }): Promise<void> {
+    console.debug('loadBundle', bundle);
+  }
+
+  async loadScript(options: {
+    src: string;
+    bundleType?: BundleType;
+    attributes?: Record<string, string>;
+  }): Promise<void> {
+    this.loadScriptSrc = options.src;
+    this.onloadFn();
+  }
+}

package/test/recaptcha-manager.test.ts

@@ -1,199 +1,201 @@
-import { expect } from '@open-wc/testing';
-import { MockGrecaptcha } from './mock-grecaptcha';
-import { RecaptchaManager } from '../src/recaptcha-manager';
-import { MockLazyLoaderService } from './mock-lazy-loader';
-
-const mockLazyLoader = new MockLazyLoaderService();
-
-describe('ReCaptcha Management', () => {
-  describe('ReCaptcha Manager', () => {
-    it('can return recaptchas', async () => {
-      const mockGrecaptcha = new MockGrecaptcha({
-        mode: 'success',
-      });
-      mockGrecaptcha.response = 'foo';
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        grecaptchaLibrary: mockGrecaptcha,
-        defaultSiteKey: '123',
-      });
-      const recaptcha = await recaptchaManager.getRecaptchaWidget();
-      const result = await recaptcha.execute();
-      expect(result).to.equal('foo');
-    });
-
-    it('throws an error if no site key found', async () => {
-      const mockGrecaptcha = new MockGrecaptcha({
-        mode: 'success',
-      });
-      mockGrecaptcha.response = 'foo';
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        grecaptchaLibrary: mockGrecaptcha,
-      });
-      try {
-        await recaptchaManager.getRecaptchaWidget();
-        expect.fail('should not get here');
-      } catch (e) {
-        expect((e as Error).message).to.equal(
-          'The reCaptcha widget requires a site key',
-        );
-      }
-    });
-
-    it('returns a cached version if one already exists for a given site key', async () => {
-      const mockGrecaptcha = new MockGrecaptcha({
-        mode: 'success',
-      });
-      mockGrecaptcha.response = 'foo';
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        grecaptchaLibrary: mockGrecaptcha,
-        defaultSiteKey: '123',
-      });
-      const recaptcha1 = await recaptchaManager.getRecaptchaWidget();
-      const recaptcha2 = await recaptchaManager.getRecaptchaWidget();
-      expect(recaptcha1).to.equal(recaptcha2);
-    });
-
-    it('loads the recaptcha library if needed', async () => {
-      // Mock lazy loader that mimics the grecaptcha script calling the callback on load
-      const mockLazyLoaderWithCallback = new MockLazyLoaderService(() => {
-        window.grecaptcha = new MockGrecaptcha({
-          mode: 'success',
-        });
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (window as any).grecaptchaLoadedCallback();
-      });
-
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoaderWithCallback,
-        defaultSiteKey: '123',
-        timeout: 100,
-      });
-
-      await recaptchaManager.getRecaptchaWidget();
-      const loadUrl = mockLazyLoaderWithCallback.loadScriptSrc;
-      expect(
-        loadUrl?.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback'),
-      ).to.be.true;
-    });
-
-    it('rejects after specified timeout if grecaptcha fails to execute callback', async () => {
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        defaultSiteKey: '123',
-        timeout: 100,
-      });
-
-      try {
-        await recaptchaManager.getRecaptchaWidget();
-        expect.fail('recaptcha load did not time out as expected');
-      } catch (err) {
-        expect(err).to.be.instanceOf(Error);
-        expect((err as Error).message).to.equal(
-          'grecaptcha failed to execute callback',
-        );
-      }
-    });
-
-    it('can set the timeout delay', async () => {
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        defaultSiteKey: '123',
-      });
-
-      recaptchaManager.setTimeoutDelay(1);
-
-      try {
-        await recaptchaManager.getRecaptchaWidget();
-        expect.fail('recaptcha load did not time out as expected');
-      } catch (err) {
-        expect(err).to.be.instanceOf(Error);
-        expect((err as Error).message).to.equal(
-          'grecaptcha failed to execute callback',
-        );
-      }
-    });
-  });
-
-  describe('ReCaptcha Widget', () => {
-    it('can error properly like a Promise', async () => {
-      const mockGrecaptcha = new MockGrecaptcha({
-        mode: 'error',
-      });
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        grecaptchaLibrary: mockGrecaptcha,
-        defaultSiteKey: '123',
-      });
-      const recaptcha = await recaptchaManager.getRecaptchaWidget();
-
-      try {
-        await recaptcha.execute();
-        expect.fail('should not get here');
-      } catch (error) {
-        expect((error as Error).message).to.equal('error');
-      }
-    });
-
-    it('can expire properly like a Promise', async () => {
-      const mockGrecaptcha = new MockGrecaptcha({
-        mode: 'expired',
-      });
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        grecaptchaLibrary: mockGrecaptcha,
-        defaultSiteKey: '123',
-      });
-      const recaptcha = await recaptchaManager.getRecaptchaWidget();
-
-      try {
-        await recaptcha.execute();
-        expect.fail('should not get here');
-      } catch (error) {
-        expect((error as Error).message).to.equal('expired');
-      }
-    });
-
-    it('resets the captcha after execution', async () => {
-      const mockGrecaptcha = new MockGrecaptcha({
-        mode: 'success',
-        addDelay: true,
-      });
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        grecaptchaLibrary: mockGrecaptcha,
-        defaultSiteKey: '123',
-      });
-      const recaptcha = await recaptchaManager.getRecaptchaWidget();
-
-      expect(mockGrecaptcha.resetCallCount).to.equal(0);
-      await recaptcha.execute();
-      expect(mockGrecaptcha.resetCallCount).to.equal(1);
-      await recaptcha.execute();
-      expect(mockGrecaptcha.resetCallCount).to.equal(2);
-    });
-
-    // there's no way to know if the user has dismissed the captcha so if another execution
-    // comes through while the captcha is still active, it will be reset
-    it('resets the captcha if another execution gets called', async () => {
-      const mockGrecaptcha = new MockGrecaptcha({
-        mode: 'success',
-        addDelay: true,
-      });
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        grecaptchaLibrary: mockGrecaptcha,
-        defaultSiteKey: '123',
-      });
-      const recaptcha = await recaptchaManager.getRecaptchaWidget();
-
-      expect(mockGrecaptcha.resetCallCount).to.equal(0);
-      recaptcha.execute();
-      expect(mockGrecaptcha.resetCallCount).to.equal(0);
-      await recaptcha.execute();
-      expect(mockGrecaptcha.resetCallCount).to.equal(2);
-    });
-  });
-});
+import { expect } from '@open-wc/testing';
+import { MockGrecaptcha } from './mock-grecaptcha';
+import { RecaptchaManager } from '../src/recaptcha-manager';
+import { MockLazyLoaderService } from './mock-lazy-loader';
+
+const mockLazyLoader = new MockLazyLoaderService();
+
+describe('ReCaptcha Management', () => {
+  describe('ReCaptcha Manager', () => {
+    it('can return recaptchas', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+      });
+      mockGrecaptcha.response = 'foo';
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+      const result = await recaptcha.execute();
+      expect(result).to.equal('foo');
+    });
+
+    it('throws an error if no site key found', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+      });
+      mockGrecaptcha.response = 'foo';
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+      });
+      try {
+        await recaptchaManager.getRecaptchaWidget();
+        expect.fail('should not get here');
+      } catch (e) {
+        expect((e as Error).message).to.equal(
+          'The reCaptcha widget requires a site key',
+        );
+      }
+    });
+
+    it('returns a cached version if one already exists for a given site key', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+      });
+      mockGrecaptcha.response = 'foo';
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha1 = await recaptchaManager.getRecaptchaWidget();
+      const recaptcha2 = await recaptchaManager.getRecaptchaWidget();
+      expect(recaptcha1).to.equal(recaptcha2);
+    });
+
+    it('loads the recaptcha library if needed', async () => {
+      // Mock lazy loader that mimics the grecaptcha script calling the callback on load
+      const mockLazyLoaderWithCallback = new MockLazyLoaderService(() => {
+        window.grecaptcha = new MockGrecaptcha({
+          mode: 'success',
+        });
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (window as any).grecaptchaLoadedCallback();
+      });
+
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoaderWithCallback,
+        defaultSiteKey: '123',
+        timeout: 100,
+      });
+
+      await recaptchaManager.getRecaptchaWidget();
+      const loadUrl = mockLazyLoaderWithCallback.loadScriptSrc;
+      expect(
+        loadUrl?.includes(
+          'https://www.recaptcha.net/recaptcha/api.js?onload=grecaptchaLoadedCallback',
+        ),
+      ).to.be.true;
+    });
+
+    it('rejects after specified timeout if grecaptcha fails to execute callback', async () => {
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        defaultSiteKey: '123',
+        timeout: 100,
+      });
+
+      try {
+        await recaptchaManager.getRecaptchaWidget();
+        expect.fail('recaptcha load did not time out as expected');
+      } catch (err) {
+        expect(err).to.be.instanceOf(Error);
+        expect((err as Error).message).to.equal(
+          'grecaptcha failed to execute callback',
+        );
+      }
+    });
+
+    it('can set the timeout delay', async () => {
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        defaultSiteKey: '123',
+      });
+
+      recaptchaManager.setTimeoutDelay(1);
+
+      try {
+        await recaptchaManager.getRecaptchaWidget();
+        expect.fail('recaptcha load did not time out as expected');
+      } catch (err) {
+        expect(err).to.be.instanceOf(Error);
+        expect((err as Error).message).to.equal(
+          'grecaptcha failed to execute callback',
+        );
+      }
+    });
+  });
+
+  describe('ReCaptcha Widget', () => {
+    it('can error properly like a Promise', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'error',
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      try {
+        await recaptcha.execute();
+        expect.fail('should not get here');
+      } catch (error) {
+        expect((error as Error).message).to.equal('error');
+      }
+    });
+
+    it('can expire properly like a Promise', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'expired',
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      try {
+        await recaptcha.execute();
+        expect.fail('should not get here');
+      } catch (error) {
+        expect((error as Error).message).to.equal('expired');
+      }
+    });
+
+    it('resets the captcha after execution', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+        addDelay: true,
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      expect(mockGrecaptcha.resetCallCount).to.equal(0);
+      await recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(1);
+      await recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(2);
+    });
+
+    // there's no way to know if the user has dismissed the captcha so if another execution
+    // comes through while the captcha is still active, it will be reset
+    it('resets the captcha if another execution gets called', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+        addDelay: true,
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      expect(mockGrecaptcha.resetCallCount).to.equal(0);
+      recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(0);
+      await recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(2);
+    });
+  });
+});

package/tsconfig.json

@@ -1,31 +1,31 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "plugins": [
-      {
-        "name": "ts-lit-plugin"
-      }
-    ],
-    "paths": {
-      // workaround for: https://github.com/vitest-dev/vitest/issues/4567
-      "rollup/parseAst": [
-        "./node_modules/rollup/dist/parseAst"
-    ]
-}
-  },
-  "include": ["**/*.ts"]
-}
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "plugins": [
+      {
+        "name": "ts-lit-plugin"
+      }
+    ],
+    "paths": {
+      // workaround for: https://github.com/vitest-dev/vitest/issues/4567
+      "rollup/parseAst": [
+        "./node_modules/rollup/dist/parseAst"
+    ]
+}
+  },
+  "include": ["**/*.ts"]
+}

package/web-dev-server.config.mjs

@@ -1,32 +1,32 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  nodeResolve: true,
-  open: '/demo',
-  watch: !hmr,
-  sslCert: './ssl/server.crt',
-  sslKey: './ssl/server.key',
-  hostname: 'local.archive.org',
-  http2: true,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Configure bare import resolve plugin */
-  // nodeResolve: {
-  //   exportConditions: ['browser', 'development']
-  // },
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  // See documentation for all available options
-});
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/demo',
+  watch: !hmr,
+  sslCert: './ssl/server.crt',
+  sslKey: './ssl/server.key',
+  hostname: 'local.archive.org',
+  http2: true,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Configure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  // See documentation for all available options
+});