@internetarchive/recaptcha-manager 0.1.2-webdev-7354.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,7 @@
1
- import { MockGrecaptcha } from './mock-grecaptcha';
2
1
  export class MockLazyLoaderService {
2
+ constructor(onloadFn = () => { }) {
3
+ this.onloadFn = onloadFn;
4
+ }
3
5
  on(event, callback) {
4
6
  throw new Error('Method not implemented.');
5
7
  }
@@ -8,11 +10,7 @@ export class MockLazyLoaderService {
8
10
  }
9
11
  async loadScript(options) {
10
12
  this.loadScriptSrc = options.src;
11
- window.grecaptcha = new MockGrecaptcha({
12
- mode: 'success',
13
- });
14
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
15
- window.grecaptchaLoadedCallback();
13
+ this.onloadFn();
16
14
  }
17
15
  }
18
16
  //# sourceMappingURL=mock-lazy-loader.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"mock-lazy-loader.js","sourceRoot":"","sources":["../../test/mock-lazy-loader.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,MAAM,OAAO,qBAAqB;IAGhC,EAAE,CACA,KAAQ,EACR,QAAoC;QAEpC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAGhB;QACC,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAIhB;QACC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;QACjC,MAAM,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC;YACrC,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;QACH,8DAA8D;QAC7D,MAAc,CAAC,wBAAwB,EAAE,CAAC;IAC7C,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\nimport {\n BundleType,\n LazyLoaderServiceEvents,\n LazyLoaderServiceInterface,\n} from '@internetarchive/lazy-loader-service';\nimport { Unsubscribe } from 'nanoevents';\nimport { MockGrecaptcha } from './mock-grecaptcha';\n\nexport class MockLazyLoaderService implements LazyLoaderServiceInterface {\n loadScriptSrc?: string;\n\n on<E extends keyof LazyLoaderServiceEvents>(\n event: E,\n callback: LazyLoaderServiceEvents[E],\n ): Unsubscribe {\n throw new Error('Method not implemented.');\n }\n\n async loadBundle(bundle: {\n module?: string;\n nomodule?: string;\n }): Promise<void> {\n console.debug('loadBundle', bundle);\n }\n\n async loadScript(options: {\n src: string;\n bundleType?: BundleType;\n attributes?: Record<string, string>;\n }): Promise<void> {\n this.loadScriptSrc = options.src;\n window.grecaptcha = new MockGrecaptcha({\n mode: 'success',\n });\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n (window as any).grecaptchaLoadedCallback();\n }\n}\n"]}
1
+ {"version":3,"file":"mock-lazy-loader.js","sourceRoot":"","sources":["../../test/mock-lazy-loader.ts"],"names":[],"mappings":"AAQA,MAAM,OAAO,qBAAqB;IAGhC,YAAoB,WAA0B,GAAG,EAAE,GAAE,CAAC;QAAlC,aAAQ,GAAR,QAAQ,CAA0B;IAAG,CAAC;IAE1D,EAAE,CACA,KAAQ,EACR,QAAoC;QAEpC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAGhB;QACC,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAIhB;QACC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;QACjC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\r\nimport {\r\n BundleType,\r\n LazyLoaderServiceEvents,\r\n LazyLoaderServiceInterface,\r\n} from '@internetarchive/lazy-loader-service';\r\nimport { Unsubscribe } from 'nanoevents';\r\n\r\nexport class MockLazyLoaderService implements LazyLoaderServiceInterface {\r\n loadScriptSrc?: string;\r\n\r\n constructor(private onloadFn: () => unknown = () => {}) {}\r\n\r\n on<E extends keyof LazyLoaderServiceEvents>(\r\n event: E,\r\n callback: LazyLoaderServiceEvents[E],\r\n ): Unsubscribe {\r\n throw new Error('Method not implemented.');\r\n }\r\n\r\n async loadBundle(bundle: {\r\n module?: string;\r\n nomodule?: string;\r\n }): Promise<void> {\r\n console.debug('loadBundle', bundle);\r\n }\r\n\r\n async loadScript(options: {\r\n src: string;\r\n bundleType?: BundleType;\r\n attributes?: Record<string, string>;\r\n }): Promise<void> {\r\n this.loadScriptSrc = options.src;\r\n this.onloadFn();\r\n }\r\n}\r\n"]}
@@ -51,14 +51,53 @@ describe('ReCaptcha Management', () => {
51
51
  expect(recaptcha1).to.equal(recaptcha2);
52
52
  });
53
53
  it('loads the recaptcha library if needed', async () => {
54
+ // Mock lazy loader that mimics the grecaptcha script calling the callback on load
55
+ const mockLazyLoaderWithCallback = new MockLazyLoaderService(() => {
56
+ window.grecaptcha = new MockGrecaptcha({
57
+ mode: 'success',
58
+ });
59
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
60
+ window.grecaptchaLoadedCallback();
61
+ });
54
62
  const recaptchaManager = new RecaptchaManager({
55
- lazyLoader: mockLazyLoader,
63
+ lazyLoader: mockLazyLoaderWithCallback,
56
64
  defaultSiteKey: '123',
65
+ timeout: 100,
57
66
  });
58
67
  await recaptchaManager.getRecaptchaWidget();
59
- const loadUrl = mockLazyLoader.loadScriptSrc;
68
+ const loadUrl = mockLazyLoaderWithCallback.loadScriptSrc;
60
69
  expect(loadUrl === null || loadUrl === void 0 ? void 0 : loadUrl.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback')).to.be.true;
61
70
  });
71
+ it('rejects after specified timeout if grecaptcha fails to execute callback', async () => {
72
+ const recaptchaManager = new RecaptchaManager({
73
+ lazyLoader: mockLazyLoader,
74
+ defaultSiteKey: '123',
75
+ timeout: 100,
76
+ });
77
+ try {
78
+ await recaptchaManager.getRecaptchaWidget();
79
+ expect.fail('recaptcha load did not time out as expected');
80
+ }
81
+ catch (err) {
82
+ expect(err).to.be.instanceOf(Error);
83
+ expect(err.message).to.equal('grecaptcha failed to execute callback');
84
+ }
85
+ });
86
+ it('can set the timeout delay', async () => {
87
+ const recaptchaManager = new RecaptchaManager({
88
+ lazyLoader: mockLazyLoader,
89
+ defaultSiteKey: '123',
90
+ });
91
+ recaptchaManager.setTimeoutDelay(1);
92
+ try {
93
+ await recaptchaManager.getRecaptchaWidget();
94
+ expect.fail('recaptcha load did not time out as expected');
95
+ }
96
+ catch (err) {
97
+ expect(err).to.be.instanceOf(Error);
98
+ expect(err.message).to.equal('grecaptcha failed to execute callback');
99
+ }
100
+ });
62
101
  });
63
102
  describe('ReCaptcha Widget', () => {
64
103
  it('can error properly like a Promise', async () => {
@@ -1 +1 @@
1
- {"version":3,"file":"recaptcha-manager.test.js","sourceRoot":"","sources":["../../test/recaptcha-manager.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,cAAc,GAAG,IAAI,qBAAqB,EAAE,CAAC;AAEnD,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACrC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,cAAc,CAAC,QAAQ,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC9D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACpD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,cAAc,CAAC,QAAQ,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;aAClC,CAAC,CAAC;YACH,IAAI,CAAC;gBACH,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CACnC,0CAA0C,CAC3C,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;YACnF,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,cAAc,CAAC,QAAQ,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC/D,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,cAAc,CAAC,aAAa,CAAC;YAC7C,MAAM,CACJ,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC,kDAAkD,CAAC,CACtE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,OAAO;aACd,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,IAAI,CAAC;gBACH,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,IAAI,CAAC;gBACH,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACvD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,uFAAuF;QACvF,oEAAoE;QACpE,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,SAAS,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { expect } from '@open-wc/testing';\nimport { MockGrecaptcha } from './mock-grecaptcha';\nimport { RecaptchaManager } from '../src/recaptcha-manager';\nimport { MockLazyLoaderService } from './mock-lazy-loader';\n\nconst mockLazyLoader = new MockLazyLoaderService();\n\ndescribe('ReCaptcha Management', () => {\n describe('ReCaptcha Manager', () => {\n it('can return recaptchas', async () => {\n const mockGrecaptcha = new MockGrecaptcha({\n mode: 'success',\n });\n mockGrecaptcha.response = 'foo';\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n grecaptchaLibrary: mockGrecaptcha,\n defaultSiteKey: '123',\n });\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\n const result = await recaptcha.execute();\n expect(result).to.equal('foo');\n });\n\n it('throws an error if no site key found', async () => {\n const mockGrecaptcha = new MockGrecaptcha({\n mode: 'success',\n });\n mockGrecaptcha.response = 'foo';\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n grecaptchaLibrary: mockGrecaptcha,\n });\n try {\n await recaptchaManager.getRecaptchaWidget();\n expect.fail('should not get here');\n } catch (e) {\n expect((e as Error).message).to.equal(\n 'The reCaptcha widget requires a site key',\n );\n }\n });\n\n it('returns a cached version if one already exists for a given site key', async () => {\n const mockGrecaptcha = new MockGrecaptcha({\n mode: 'success',\n });\n mockGrecaptcha.response = 'foo';\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n grecaptchaLibrary: mockGrecaptcha,\n defaultSiteKey: '123',\n });\n const recaptcha1 = await recaptchaManager.getRecaptchaWidget();\n const recaptcha2 = await recaptchaManager.getRecaptchaWidget();\n expect(recaptcha1).to.equal(recaptcha2);\n });\n\n it('loads the recaptcha library if needed', async () => {\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n defaultSiteKey: '123',\n });\n await recaptchaManager.getRecaptchaWidget();\n const loadUrl = mockLazyLoader.loadScriptSrc;\n expect(\n loadUrl?.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback'),\n ).to.be.true;\n });\n });\n\n describe('ReCaptcha Widget', () => {\n it('can error properly like a Promise', async () => {\n const mockGrecaptcha = new MockGrecaptcha({\n mode: 'error',\n });\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n grecaptchaLibrary: mockGrecaptcha,\n defaultSiteKey: '123',\n });\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\n\n try {\n await recaptcha.execute();\n expect.fail('should not get here');\n } catch (error) {\n expect((error as Error).message).to.equal('error');\n }\n });\n\n it('can expire properly like a Promise', async () => {\n const mockGrecaptcha = new MockGrecaptcha({\n mode: 'expired',\n });\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n grecaptchaLibrary: mockGrecaptcha,\n defaultSiteKey: '123',\n });\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\n\n try {\n await recaptcha.execute();\n expect.fail('should not get here');\n } catch (error) {\n expect((error as Error).message).to.equal('expired');\n }\n });\n\n it('resets the captcha after execution', async () => {\n const mockGrecaptcha = new MockGrecaptcha({\n mode: 'success',\n addDelay: true,\n });\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n grecaptchaLibrary: mockGrecaptcha,\n defaultSiteKey: '123',\n });\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\n\n expect(mockGrecaptcha.resetCallCount).to.equal(0);\n await recaptcha.execute();\n expect(mockGrecaptcha.resetCallCount).to.equal(1);\n await recaptcha.execute();\n expect(mockGrecaptcha.resetCallCount).to.equal(2);\n });\n\n // there's no way to know if the user has dismissed the captcha so if another execution\n // comes through while the captcha is still active, it will be reset\n it('resets the captcha if another execution gets called', async () => {\n const mockGrecaptcha = new MockGrecaptcha({\n mode: 'success',\n addDelay: true,\n });\n const recaptchaManager = new RecaptchaManager({\n lazyLoader: mockLazyLoader,\n grecaptchaLibrary: mockGrecaptcha,\n defaultSiteKey: '123',\n });\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\n\n expect(mockGrecaptcha.resetCallCount).to.equal(0);\n recaptcha.execute();\n expect(mockGrecaptcha.resetCallCount).to.equal(0);\n await recaptcha.execute();\n expect(mockGrecaptcha.resetCallCount).to.equal(2);\n });\n });\n});\n"]}
1
+ {"version":3,"file":"recaptcha-manager.test.js","sourceRoot":"","sources":["../../test/recaptcha-manager.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,cAAc,GAAG,IAAI,qBAAqB,EAAE,CAAC;AAEnD,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACrC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,cAAc,CAAC,QAAQ,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC9D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACpD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,cAAc,CAAC,QAAQ,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;aAClC,CAAC,CAAC;YACH,IAAI,CAAC;gBACH,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CACnC,0CAA0C,CAC3C,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;YACnF,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,cAAc,CAAC,QAAQ,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC/D,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,kFAAkF;YAClF,MAAM,0BAA0B,GAAG,IAAI,qBAAqB,CAAC,GAAG,EAAE;gBAChE,MAAM,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC;oBACrC,IAAI,EAAE,SAAS;iBAChB,CAAC,CAAC;gBACH,8DAA8D;gBAC7D,MAAc,CAAC,wBAAwB,EAAE,CAAC;YAC7C,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,0BAA0B;gBACtC,cAAc,EAAE,KAAK;gBACrB,OAAO,EAAE,GAAG;aACb,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,0BAA0B,CAAC,aAAa,CAAC;YACzD,MAAM,CACJ,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC,kDAAkD,CAAC,CACtE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACvF,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,cAAc,EAAE,KAAK;gBACrB,OAAO,EAAE,GAAG;aACb,CAAC,CAAC;YAEH,IAAI,CAAC;gBACH,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAC7D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACpC,MAAM,CAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CACrC,uCAAuC,CACxC,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;YACzC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YAEH,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YAEpC,IAAI,CAAC;gBACH,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAC7D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACpC,MAAM,CAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CACrC,uCAAuC,CACxC,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,OAAO;aACd,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,IAAI,CAAC;gBACH,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,IAAI,CAAC;gBACH,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACvD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,uFAAuF;QACvF,oEAAoE;QACpE,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;gBACxC,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;gBAC5C,UAAU,EAAE,cAAc;gBAC1B,iBAAiB,EAAE,cAAc;gBACjC,cAAc,EAAE,KAAK;aACtB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YAE9D,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,SAAS,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { expect } from '@open-wc/testing';\r\nimport { MockGrecaptcha } from './mock-grecaptcha';\r\nimport { RecaptchaManager } from '../src/recaptcha-manager';\r\nimport { MockLazyLoaderService } from './mock-lazy-loader';\r\n\r\nconst mockLazyLoader = new MockLazyLoaderService();\r\n\r\ndescribe('ReCaptcha Management', () => {\r\n describe('ReCaptcha Manager', () => {\r\n it('can return recaptchas', async () => {\r\n const mockGrecaptcha = new MockGrecaptcha({\r\n mode: 'success',\r\n });\r\n mockGrecaptcha.response = 'foo';\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n grecaptchaLibrary: mockGrecaptcha,\r\n defaultSiteKey: '123',\r\n });\r\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\r\n const result = await recaptcha.execute();\r\n expect(result).to.equal('foo');\r\n });\r\n\r\n it('throws an error if no site key found', async () => {\r\n const mockGrecaptcha = new MockGrecaptcha({\r\n mode: 'success',\r\n });\r\n mockGrecaptcha.response = 'foo';\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n grecaptchaLibrary: mockGrecaptcha,\r\n });\r\n try {\r\n await recaptchaManager.getRecaptchaWidget();\r\n expect.fail('should not get here');\r\n } catch (e) {\r\n expect((e as Error).message).to.equal(\r\n 'The reCaptcha widget requires a site key',\r\n );\r\n }\r\n });\r\n\r\n it('returns a cached version if one already exists for a given site key', async () => {\r\n const mockGrecaptcha = new MockGrecaptcha({\r\n mode: 'success',\r\n });\r\n mockGrecaptcha.response = 'foo';\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n grecaptchaLibrary: mockGrecaptcha,\r\n defaultSiteKey: '123',\r\n });\r\n const recaptcha1 = await recaptchaManager.getRecaptchaWidget();\r\n const recaptcha2 = await recaptchaManager.getRecaptchaWidget();\r\n expect(recaptcha1).to.equal(recaptcha2);\r\n });\r\n\r\n it('loads the recaptcha library if needed', async () => {\r\n // Mock lazy loader that mimics the grecaptcha script calling the callback on load\r\n const mockLazyLoaderWithCallback = new MockLazyLoaderService(() => {\r\n window.grecaptcha = new MockGrecaptcha({\r\n mode: 'success',\r\n });\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n (window as any).grecaptchaLoadedCallback();\r\n });\r\n\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoaderWithCallback,\r\n defaultSiteKey: '123',\r\n timeout: 100,\r\n });\r\n\r\n await recaptchaManager.getRecaptchaWidget();\r\n const loadUrl = mockLazyLoaderWithCallback.loadScriptSrc;\r\n expect(\r\n loadUrl?.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback'),\r\n ).to.be.true;\r\n });\r\n\r\n it('rejects after specified timeout if grecaptcha fails to execute callback', async () => {\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n defaultSiteKey: '123',\r\n timeout: 100,\r\n });\r\n\r\n try {\r\n await recaptchaManager.getRecaptchaWidget();\r\n expect.fail('recaptcha load did not time out as expected');\r\n } catch (err) {\r\n expect(err).to.be.instanceOf(Error);\r\n expect((err as Error).message).to.equal(\r\n 'grecaptcha failed to execute callback',\r\n );\r\n }\r\n });\r\n\r\n it('can set the timeout delay', async () => {\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n defaultSiteKey: '123',\r\n });\r\n\r\n recaptchaManager.setTimeoutDelay(1);\r\n\r\n try {\r\n await recaptchaManager.getRecaptchaWidget();\r\n expect.fail('recaptcha load did not time out as expected');\r\n } catch (err) {\r\n expect(err).to.be.instanceOf(Error);\r\n expect((err as Error).message).to.equal(\r\n 'grecaptcha failed to execute callback',\r\n );\r\n }\r\n });\r\n });\r\n\r\n describe('ReCaptcha Widget', () => {\r\n it('can error properly like a Promise', async () => {\r\n const mockGrecaptcha = new MockGrecaptcha({\r\n mode: 'error',\r\n });\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n grecaptchaLibrary: mockGrecaptcha,\r\n defaultSiteKey: '123',\r\n });\r\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\r\n\r\n try {\r\n await recaptcha.execute();\r\n expect.fail('should not get here');\r\n } catch (error) {\r\n expect((error as Error).message).to.equal('error');\r\n }\r\n });\r\n\r\n it('can expire properly like a Promise', async () => {\r\n const mockGrecaptcha = new MockGrecaptcha({\r\n mode: 'expired',\r\n });\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n grecaptchaLibrary: mockGrecaptcha,\r\n defaultSiteKey: '123',\r\n });\r\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\r\n\r\n try {\r\n await recaptcha.execute();\r\n expect.fail('should not get here');\r\n } catch (error) {\r\n expect((error as Error).message).to.equal('expired');\r\n }\r\n });\r\n\r\n it('resets the captcha after execution', async () => {\r\n const mockGrecaptcha = new MockGrecaptcha({\r\n mode: 'success',\r\n addDelay: true,\r\n });\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n grecaptchaLibrary: mockGrecaptcha,\r\n defaultSiteKey: '123',\r\n });\r\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\r\n\r\n expect(mockGrecaptcha.resetCallCount).to.equal(0);\r\n await recaptcha.execute();\r\n expect(mockGrecaptcha.resetCallCount).to.equal(1);\r\n await recaptcha.execute();\r\n expect(mockGrecaptcha.resetCallCount).to.equal(2);\r\n });\r\n\r\n // there's no way to know if the user has dismissed the captcha so if another execution\r\n // comes through while the captcha is still active, it will be reset\r\n it('resets the captcha if another execution gets called', async () => {\r\n const mockGrecaptcha = new MockGrecaptcha({\r\n mode: 'success',\r\n addDelay: true,\r\n });\r\n const recaptchaManager = new RecaptchaManager({\r\n lazyLoader: mockLazyLoader,\r\n grecaptchaLibrary: mockGrecaptcha,\r\n defaultSiteKey: '123',\r\n });\r\n const recaptcha = await recaptchaManager.getRecaptchaWidget();\r\n\r\n expect(mockGrecaptcha.resetCallCount).to.equal(0);\r\n recaptcha.execute();\r\n expect(mockGrecaptcha.resetCallCount).to.equal(0);\r\n await recaptcha.execute();\r\n expect(mockGrecaptcha.resetCallCount).to.equal(2);\r\n });\r\n });\r\n});\r\n"]}
package/eslint.config.mjs CHANGED
@@ -1,53 +1,53 @@
1
- import typescriptEslint from '@typescript-eslint/eslint-plugin';
2
- import html from 'eslint-plugin-html';
3
- import tsParser from '@typescript-eslint/parser';
4
- import path from 'node:path';
5
- import { fileURLToPath } from 'node:url';
6
- import js from '@eslint/js';
7
- import { FlatCompat } from '@eslint/eslintrc';
8
-
9
- const __filename = fileURLToPath(import.meta.url);
10
- const __dirname = path.dirname(__filename);
11
- const compat = new FlatCompat({
12
- baseDirectory: __dirname,
13
- recommendedConfig: js.configs.recommended,
14
- allConfig: js.configs.all,
15
- });
16
-
17
- export default [
18
- ...compat.extends('plugin:@typescript-eslint/recommended'),
19
- {
20
- plugins: {
21
- '@typescript-eslint': typescriptEslint,
22
- html,
23
- },
24
-
25
- languageOptions: {
26
- parser: tsParser,
27
- },
28
-
29
- settings: {
30
- 'import/resolver': {
31
- node: {
32
- extensions: ['.ts', '.tsx'],
33
- moduleDirectory: ['node_modules', 'src', 'demo'],
34
- },
35
- },
36
- },
37
-
38
- rules: {
39
- '@typescript-eslint/no-unsafe-function-type': 'warn',
40
- '@typescript-eslint/no-unused-vars': 'warn',
41
- '@typescript-eslint/no-explicit-any': 'warn',
42
- },
43
- },
44
- {
45
- ignores: ['**/*.js', '**/*.mjs'],
46
- },
47
- {
48
- files: ['**/*.test.ts'],
49
- rules: {
50
- '@typescript-eslint/no-unused-expressions': 'off',
51
- },
52
- },
53
- ];
1
+ import typescriptEslint from '@typescript-eslint/eslint-plugin';
2
+ import html from 'eslint-plugin-html';
3
+ import tsParser from '@typescript-eslint/parser';
4
+ import path from 'node:path';
5
+ import { fileURLToPath } from 'node:url';
6
+ import js from '@eslint/js';
7
+ import { FlatCompat } from '@eslint/eslintrc';
8
+
9
+ const __filename = fileURLToPath(import.meta.url);
10
+ const __dirname = path.dirname(__filename);
11
+ const compat = new FlatCompat({
12
+ baseDirectory: __dirname,
13
+ recommendedConfig: js.configs.recommended,
14
+ allConfig: js.configs.all,
15
+ });
16
+
17
+ export default [
18
+ ...compat.extends('plugin:@typescript-eslint/recommended'),
19
+ {
20
+ plugins: {
21
+ '@typescript-eslint': typescriptEslint,
22
+ html,
23
+ },
24
+
25
+ languageOptions: {
26
+ parser: tsParser,
27
+ },
28
+
29
+ settings: {
30
+ 'import/resolver': {
31
+ node: {
32
+ extensions: ['.ts', '.tsx'],
33
+ moduleDirectory: ['node_modules', 'src', 'demo'],
34
+ },
35
+ },
36
+ },
37
+
38
+ rules: {
39
+ '@typescript-eslint/no-unsafe-function-type': 'warn',
40
+ '@typescript-eslint/no-unused-vars': 'warn',
41
+ '@typescript-eslint/no-explicit-any': 'warn',
42
+ },
43
+ },
44
+ {
45
+ ignores: ['**/*.js', '**/*.mjs'],
46
+ },
47
+ {
48
+ files: ['**/*.test.ts'],
49
+ rules: {
50
+ '@typescript-eslint/no-unused-expressions': 'off',
51
+ },
52
+ },
53
+ ];
package/package.json CHANGED
@@ -1,76 +1,76 @@
1
- {
2
- "name": "@internetarchive/recaptcha-manager",
3
- "description": "A library that lets you lazy load and interact with reCaptcha.",
4
- "repository": {
5
- "type": "git",
6
- "url": "git+https://github.com/internetarchive/iaux-recaptcha-manager.git"
7
- },
8
- "license": "AGPL-3.0-only",
9
- "author": "Internet Archive",
10
- "version": "0.1.2-webdev-7354.0",
11
- "main": "dist/index.js",
12
- "module": "dist/index.js",
13
- "scripts": {
14
- "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wds\"",
15
- "prepare": "rimraf dist && tsc && husky install",
16
- "build": "tsc",
17
- "lint": "eslint . && prettier \"**/*.ts\" --check",
18
- "format": "eslint . --fix && prettier \"**/*.ts\" --write",
19
- "circular": "madge --circular --extensions ts .",
20
- "test": "tsc && npm run lint && npm run circular && wtr --coverage",
21
- "test:watch": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wtr --watch\"",
22
- "ghpages:build": "rimraf ghpages && npm run prepare && vite build",
23
- "ghpages:publish": "npm run ghpages:prepare -e $(git branch --show-current)",
24
- "ghpages:prepare": "npm run ghpages:build && touch ghpages/.nojekyll && npm run ghpages:generate",
25
- "ghpages:generate": "gh-pages -t -d ghpages -m \"Build for $(git log --pretty=format:\"%h %an %ai %s\" -n1) [skip ci]\""
26
- },
27
- "types": "dist/index.d.ts",
28
- "devDependencies": {
29
- "@open-wc/eslint-config": "^12.0.3",
30
- "@open-wc/testing": "^4.0.0",
31
- "@types/mocha": "^10.0.10",
32
- "@typescript-eslint/eslint-plugin": "^8.19.1",
33
- "@typescript-eslint/parser": "^8.19.1",
34
- "@web/dev-server": "^0.4.6",
35
- "@web/test-runner": "^0.20.0",
36
- "concurrently": "^9.1.2",
37
- "eslint": "^9.17.0",
38
- "eslint-config-prettier": "^10.1.1",
39
- "eslint-plugin-html": "^8.1.2",
40
- "eslint-plugin-import": "^2.31.0",
41
- "eslint-plugin-lit": "^1.15.0",
42
- "eslint-plugin-lit-a11y": "^4.1.4",
43
- "eslint-plugin-no-only-tests": "^3.3.0",
44
- "eslint-plugin-wc": "^2.2.0",
45
- "gh-pages": "^6.3.0",
46
- "husky": "^9.1.7",
47
- "madge": "^8.0.0",
48
- "nanoevents": "^6.0.2",
49
- "prettier": "^3.4.2",
50
- "rimraf": "^6.0.1",
51
- "sinon": "^19.0.2",
52
- "ts-lit-plugin": "^2.0.2",
53
- "tslib": "^2.8.1",
54
- "typescript": "^5.7.2",
55
- "vite": "^6.0.7"
56
- },
57
- "publishConfig": {
58
- "access": "public"
59
- },
60
- "prettier": {
61
- "singleQuote": true,
62
- "arrowParens": "avoid"
63
- },
64
- "lint-staged": {
65
- "*.ts": [
66
- "eslint --fix",
67
- "prettier --write",
68
- "git add"
69
- ]
70
- },
71
- "dependencies": {
72
- "lit": "^2.8.0",
73
- "@internetarchive/lazy-loader-service": "^0.2.0",
74
- "@types/grecaptcha": "^2"
75
- }
76
- }
1
+ {
2
+ "name": "@internetarchive/recaptcha-manager",
3
+ "description": "A library that lets you lazy load and interact with reCaptcha.",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "git+https://github.com/internetarchive/iaux-recaptcha-manager.git"
7
+ },
8
+ "license": "AGPL-3.0-only",
9
+ "author": "Internet Archive",
10
+ "version": "2.0.0",
11
+ "main": "dist/index.js",
12
+ "module": "dist/index.js",
13
+ "scripts": {
14
+ "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wds\"",
15
+ "prepare": "rimraf dist && tsc && husky install",
16
+ "build": "tsc",
17
+ "lint": "eslint . && prettier \"**/*.ts\" --check",
18
+ "format": "eslint . --fix && prettier \"**/*.ts\" --write",
19
+ "circular": "madge --circular --extensions ts .",
20
+ "test": "tsc && npm run lint && npm run circular && wtr --coverage",
21
+ "test:watch": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wtr --watch\"",
22
+ "ghpages:build": "rimraf ghpages && npm run prepare && vite build",
23
+ "ghpages:publish": "npm run ghpages:prepare -e $(git branch --show-current)",
24
+ "ghpages:prepare": "npm run ghpages:build && touch ghpages/.nojekyll && npm run ghpages:generate",
25
+ "ghpages:generate": "gh-pages -t -d ghpages -m \"Build for $(git log --pretty=format:\"%h %an %ai %s\" -n1) [skip ci]\""
26
+ },
27
+ "types": "dist/index.d.ts",
28
+ "devDependencies": {
29
+ "@open-wc/eslint-config": "^12.0.3",
30
+ "@open-wc/testing": "^4.0.0",
31
+ "@types/grecaptcha": "^2",
32
+ "@types/mocha": "^10.0.10",
33
+ "@typescript-eslint/eslint-plugin": "^8.19.1",
34
+ "@typescript-eslint/parser": "^8.19.1",
35
+ "@web/dev-server": "^0.4.6",
36
+ "@web/test-runner": "^0.20.0",
37
+ "concurrently": "^9.1.2",
38
+ "eslint": "^9.17.0",
39
+ "eslint-config-prettier": "^10.1.1",
40
+ "eslint-plugin-html": "^8.1.2",
41
+ "eslint-plugin-import": "^2.31.0",
42
+ "eslint-plugin-lit": "^1.15.0",
43
+ "eslint-plugin-lit-a11y": "^4.1.4",
44
+ "eslint-plugin-no-only-tests": "^3.3.0",
45
+ "eslint-plugin-wc": "^2.2.0",
46
+ "gh-pages": "^6.3.0",
47
+ "husky": "^9.1.7",
48
+ "madge": "^8.0.0",
49
+ "nanoevents": "^6.0.2",
50
+ "prettier": "^3.4.2",
51
+ "rimraf": "^6.0.1",
52
+ "sinon": "^19.0.2",
53
+ "ts-lit-plugin": "^2.0.2",
54
+ "tslib": "^2.8.1",
55
+ "typescript": "^5.7.2",
56
+ "vite": "^6.0.7"
57
+ },
58
+ "publishConfig": {
59
+ "access": "public"
60
+ },
61
+ "prettier": {
62
+ "singleQuote": true,
63
+ "arrowParens": "avoid"
64
+ },
65
+ "lint-staged": {
66
+ "*.ts": [
67
+ "eslint --fix",
68
+ "prettier --write",
69
+ "git add"
70
+ ]
71
+ },
72
+ "dependencies": {
73
+ "lit": "^2.8.0",
74
+ "@internetarchive/lazy-loader-service": "^0.2.0"
75
+ }
76
+ }
package/renovate.json CHANGED
@@ -1,6 +1,6 @@
1
- {
2
- "extends": [
3
- "config:base",
4
- ":preserveSemverRanges"
5
- ]
6
- }
1
+ {
2
+ "extends": [
3
+ "config:base",
4
+ ":preserveSemverRanges"
5
+ ]
6
+ }
@@ -1,89 +1,113 @@
1
- import {
2
- LazyLoaderService,
3
- LazyLoaderServiceInterface,
4
- } from '@internetarchive/lazy-loader-service';
5
- import { RecaptchaWidget, RecaptchaWidgetInterface } from './recaptcha-widget';
6
-
7
- export interface RecaptchaManagerInterface {
8
- /**
9
- * Load a recaptcha widget for a given site key or the default site key.
10
- */
11
- getRecaptchaWidget(options?: {
12
- siteKey?: string;
13
- recaptchaParams?: ReCaptchaV2.Parameters;
14
- }): Promise<RecaptchaWidgetInterface>;
15
- }
16
-
17
- export class RecaptchaManager implements RecaptchaManagerInterface {
18
- private lazyLoader: LazyLoaderServiceInterface;
19
-
20
- private defaultSiteKey?: string;
21
-
22
- private recaptchaCache: Record<string, RecaptchaWidget> = {};
23
-
24
- constructor(options?: {
25
- defaultSiteKey?: string;
26
- lazyLoader?: LazyLoaderServiceInterface;
27
- grecaptchaLibrary?: ReCaptchaV2.ReCaptcha; // allows dependency injection or will be lazy loaded
28
- }) {
29
- this.defaultSiteKey = options?.defaultSiteKey;
30
- this.lazyLoader = options?.lazyLoader ?? new LazyLoaderService();
31
- this.grecaptchaLibraryCache = options?.grecaptchaLibrary;
32
- }
33
-
34
- /** @inheritdoc */
35
- async getRecaptchaWidget(options?: {
36
- siteKey?: string;
37
- recaptchaParams?: ReCaptchaV2.Parameters;
38
- }): Promise<RecaptchaWidgetInterface> {
39
- const key = options?.siteKey ?? this.defaultSiteKey;
40
- if (!key) {
41
- throw new Error('The reCaptcha widget requires a site key');
42
- }
43
-
44
- const cached = this.recaptchaCache[key];
45
- if (cached) return cached;
46
-
47
- const grecaptchaLibrary = await this.getRecaptchaLibrary();
48
- const recaptcha = new RecaptchaWidget(
49
- {
50
- siteKey: key,
51
- grecaptchaLibrary,
52
- },
53
- options?.recaptchaParams,
54
- );
55
-
56
- this.recaptchaCache[key] = recaptcha;
57
- return recaptcha;
58
- }
59
-
60
- /**
61
- * Load the Recaptch library from Google.
62
- *
63
- * @returns Promise<ReCaptchaV2.ReCaptcha>
64
- */
65
- private async getRecaptchaLibrary(): Promise<ReCaptchaV2.ReCaptcha> {
66
- if (this.grecaptchaLibraryCache) {
67
- return this.grecaptchaLibraryCache;
68
- }
69
- return new Promise(resolve => {
70
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
71
- (window as any).grecaptchaLoadedCallback = (): void => {
72
- setTimeout(() => {
73
- // remove the callback when we're done with it
74
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
75
- delete (window as any).grecaptchaLoadedCallback;
76
- }, 10);
77
- this.grecaptchaLibraryCache = window.grecaptcha;
78
- resolve(window.grecaptcha);
79
- };
80
-
81
- this.lazyLoader.loadScript({
82
- src: 'https://www.google.com/recaptcha/api.js?onload=grecaptchaLoadedCallback&render=explicit',
83
- });
84
- });
85
- }
86
-
87
- /** don't use directly, use `getRecaptchaLibrary()` */
88
- private grecaptchaLibraryCache?: ReCaptchaV2.ReCaptcha;
89
- }
1
+ import {
2
+ LazyLoaderService,
3
+ LazyLoaderServiceInterface,
4
+ } from '@internetarchive/lazy-loader-service';
5
+ import { RecaptchaWidget, RecaptchaWidgetInterface } from './recaptcha-widget';
6
+
7
+ export interface RecaptchaManagerInterface {
8
+ /**
9
+ * Changes the manager's timeout delay to the given number of milliseconds.
10
+ */
11
+ setTimeoutDelay(delay: number): void;
12
+
13
+ /**
14
+ * Load a recaptcha widget for a given site key or the default site key.
15
+ */
16
+ getRecaptchaWidget(options?: {
17
+ siteKey?: string;
18
+ recaptchaParams?: ReCaptchaV2.Parameters;
19
+ }): Promise<RecaptchaWidgetInterface>;
20
+ }
21
+
22
+ export class RecaptchaManager implements RecaptchaManagerInterface {
23
+ private static readonly DEFAULT_TIMEOUT = 10000;
24
+
25
+ private lazyLoader: LazyLoaderServiceInterface;
26
+
27
+ private defaultSiteKey?: string;
28
+
29
+ private recaptchaCache: Record<string, RecaptchaWidget> = {};
30
+
31
+ /**
32
+ * How long in milliseconds to wait for the recaptcha library to load before timing out.
33
+ */
34
+ private timeout = RecaptchaManager.DEFAULT_TIMEOUT;
35
+
36
+ constructor(options?: {
37
+ defaultSiteKey?: string;
38
+ lazyLoader?: LazyLoaderServiceInterface;
39
+ grecaptchaLibrary?: ReCaptchaV2.ReCaptcha; // allows dependency injection or will be lazy loaded
40
+ timeout?: number;
41
+ }) {
42
+ this.defaultSiteKey = options?.defaultSiteKey;
43
+ this.lazyLoader = options?.lazyLoader ?? new LazyLoaderService();
44
+ this.grecaptchaLibraryCache = options?.grecaptchaLibrary;
45
+ this.timeout = options?.timeout ?? RecaptchaManager.DEFAULT_TIMEOUT;
46
+ }
47
+
48
+ /** @inheritdoc */
49
+ setTimeoutDelay(delay: number): void {
50
+ this.timeout = delay;
51
+ }
52
+
53
+ /** @inheritdoc */
54
+ async getRecaptchaWidget(options?: {
55
+ siteKey?: string;
56
+ recaptchaParams?: ReCaptchaV2.Parameters;
57
+ }): Promise<RecaptchaWidgetInterface> {
58
+ const key = options?.siteKey ?? this.defaultSiteKey;
59
+ if (!key) {
60
+ throw new Error('The reCaptcha widget requires a site key');
61
+ }
62
+
63
+ const cached = this.recaptchaCache[key];
64
+ if (cached) return cached;
65
+
66
+ const grecaptchaLibrary = await this.getRecaptchaLibrary();
67
+ const recaptcha = new RecaptchaWidget(
68
+ {
69
+ siteKey: key,
70
+ grecaptchaLibrary,
71
+ },
72
+ options?.recaptchaParams,
73
+ );
74
+
75
+ this.recaptchaCache[key] = recaptcha;
76
+ return recaptcha;
77
+ }
78
+
79
+ /**
80
+ * Load the Recaptcha library from Google.
81
+ *
82
+ * @returns Promise<ReCaptchaV2.ReCaptcha>
83
+ */
84
+ private async getRecaptchaLibrary(): Promise<ReCaptchaV2.ReCaptcha> {
85
+ if (this.grecaptchaLibraryCache) {
86
+ return this.grecaptchaLibraryCache;
87
+ }
88
+ return new Promise((resolve, reject) => {
89
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
90
+ (window as any).grecaptchaLoadedCallback = (): void => {
91
+ setTimeout(() => {
92
+ // remove the callback when we're done with it
93
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
94
+ delete (window as any).grecaptchaLoadedCallback;
95
+ }, 10);
96
+ this.grecaptchaLibraryCache = window.grecaptcha;
97
+ resolve(window.grecaptcha);
98
+ };
99
+
100
+ setTimeout(
101
+ () => reject(new Error('grecaptcha failed to execute callback')),
102
+ this.timeout,
103
+ );
104
+
105
+ this.lazyLoader.loadScript({
106
+ src: 'https://www.google.com/recaptcha/api.js?onload=grecaptchaLoadedCallback&render=explicit',
107
+ });
108
+ });
109
+ }
110
+
111
+ /** don't use directly, use `getRecaptchaLibrary()` */
112
+ private grecaptchaLibraryCache?: ReCaptchaV2.ReCaptcha;
113
+ }