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

package/test/recaptcha-manager.test.ts

@@ -1,151 +1,151 @@
-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 () => {
-      const recaptchaManager = new RecaptchaManager({
-        lazyLoader: mockLazyLoader,
-        defaultSiteKey: '123',
-      });
-      await recaptchaManager.getRecaptchaWidget();
-      const loadUrl = mockLazyLoader.loadScriptSrc;
-      expect(
-        loadUrl?.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback')
-      ).to.be.true;
-    });
-  });
-
-  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 () => {
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        defaultSiteKey: '123',
+      });
+      await recaptchaManager.getRecaptchaWidget();
+      const loadUrl = mockLazyLoader.loadScriptSrc;
+      expect(
+        loadUrl?.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback')
+      ).to.be.true;
+    });
+  });
+
+  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,20 +1,20 @@
-{
-  "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,
-  },
-  "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,
+  },
+  "include": ["**/*.ts"]
+}

package/web-dev-server.config.mjs

@@ -1,28 +1,28 @@
-// 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,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Confgure 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,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Confgure 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
+});

package/web-test-runner.config.mjs

@@ -1,41 +1,41 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});

package/dist/src/recaptcha-manager copy.d.ts

@@ -1,82 +0,0 @@
-/// <reference types="grecaptcha" />
-import { LazyLoaderServiceInterface } from '@internetarchive/lazy-loader-service';
-export interface RecaptchaManagerInterface {
-    /**
-     * Executes the recaptcha and returns a token
-     *
-     * Example:
-     *
-     * try {
-     *   const recaptchaResult = await recaptchaManager.execute();
-     *   console.log('recaptcha token:', recaptchaResult);
-     * } catch {
-     *   console.error('something happened')
-     * }
-     */
-    execute(): Promise<string>;
-    /**
-     * Create the recaptcha widget.
-     *
-     * If the `container` is not passed in, one will be created.
-     *
-     * @param options
-     */
-    setup(options?: {
-        container?: HTMLElement;
-        tabIndex?: number;
-        theme?: ReCaptchaV2.Theme;
-        type?: ReCaptchaV2.Type;
-        size?: ReCaptchaV2.Size;
-    }): void;
-}
-export declare class RecaptchaManager implements RecaptchaManagerInterface {
-    /**
-     * This is a convenience initializer that also lazily loads
-     * the recaptcha library from Google.
-     *
-     * @param options
-     * @returns
-     */
-    static getRecaptchaManager(siteKey: string, options?: {
-        lazyLoader?: LazyLoaderServiceInterface;
-        tabIndex?: number;
-        theme?: ReCaptchaV2.Theme;
-        type?: ReCaptchaV2.Type;
-        size?: ReCaptchaV2.Size;
-    }): Promise<RecaptchaManagerInterface>;
-    /**
-     * Load the Recaptch library from Google.
-     *
-     * @param options
-     * @returns
-     */
-    static loadRecaptchaLibrary(options?: {
-        lazyLoader?: LazyLoaderServiceInterface;
-    }): Promise<ReCaptchaV2.ReCaptcha>;
-    private grecaptchaLibrary;
-    private siteKey;
-    constructor(options: {
-        grecaptchaLibrary: ReCaptchaV2.ReCaptcha;
-        siteKey: string;
-    });
-    private executionSuccessBlock?;
-    private executionExpiredBlock?;
-    private executionErrorBlock?;
-    private isExecuting;
-    private containerElement;
-    /** @inheritdoc */
-    execute(): Promise<string>;
-    /** @inheritdoc */
-    setup(options?: {
-        container?: HTMLElement;
-        tabIndex?: number;
-        theme?: ReCaptchaV2.Theme;
-        type?: ReCaptchaV2.Type;
-        size?: ReCaptchaV2.Size;
-    }): void;
-    private createContainer;
-    private finishExecution;
-    private responseHandler;
-    private expiredHandler;
-    private errorHandler;
-}