@internetarchive/recaptcha-manager 0.0.1-alpha.4 → 0.1.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.
- package/README.md +30 -1
- package/demo/app-root.ts +2 -2
- package/dist/demo/app-root.js +2 -2
- package/dist/demo/app-root.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js.map +1 -1
- package/dist/src/recaptcha-manager.js +1 -1
- package/dist/src/recaptcha-manager.js.map +1 -1
- package/dist/src/recaptcha-widget.js +1 -0
- package/dist/src/recaptcha-widget.js.map +1 -1
- package/dist/test/mock-grecaptcha.d.ts +24 -0
- package/dist/test/mock-grecaptcha.js +61 -98
- package/dist/test/mock-grecaptcha.js.map +1 -1
- package/dist/test/mock-lazy-loader.d.ts +15 -0
- package/dist/test/mock-lazy-loader.js +17 -0
- package/dist/test/mock-lazy-loader.js.map +1 -0
- package/dist/test/recaptcha-manager.test.d.ts +1 -0
- package/dist/test/recaptcha-manager.test.js +136 -67
- package/dist/test/recaptcha-manager.test.js.map +1 -1
- package/index.ts +1 -0
- package/package.json +4 -3
- package/src/recaptcha-manager.ts +1 -1
- package/src/recaptcha-widget.ts +2 -0
- package/test/mock-grecaptcha.ts +87 -124
- package/test/mock-lazy-loader.ts +38 -0
- package/test/recaptcha-manager.test.ts +149 -66
|
@@ -1,69 +1,138 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
1
|
+
import { expect } from '@open-wc/testing';
|
|
2
|
+
import { MockGrecaptcha } from './mock-grecaptcha';
|
|
3
|
+
import { RecaptchaManager } from '../src/recaptcha-manager';
|
|
4
|
+
import { MockLazyLoaderService } from './mock-lazy-loader';
|
|
5
|
+
const mockLazyLoader = new MockLazyLoaderService();
|
|
6
|
+
describe('ReCaptcha Management', () => {
|
|
7
|
+
describe('ReCaptcha Manager', () => {
|
|
8
|
+
it('can return recaptchas', async () => {
|
|
9
|
+
const mockGrecaptcha = new MockGrecaptcha({
|
|
10
|
+
mode: 'success',
|
|
11
|
+
});
|
|
12
|
+
mockGrecaptcha.response = 'foo';
|
|
13
|
+
const recaptchaManager = new RecaptchaManager({
|
|
14
|
+
lazyLoader: mockLazyLoader,
|
|
15
|
+
grecaptchaLibrary: mockGrecaptcha,
|
|
16
|
+
defaultSiteKey: '123',
|
|
17
|
+
});
|
|
18
|
+
const recaptcha = await recaptchaManager.getRecaptchaWidget();
|
|
19
|
+
const result = await recaptcha.execute();
|
|
20
|
+
expect(result).to.equal('foo');
|
|
21
|
+
});
|
|
22
|
+
it('throws an error if no site key found', async () => {
|
|
23
|
+
const mockGrecaptcha = new MockGrecaptcha({
|
|
24
|
+
mode: 'success',
|
|
25
|
+
});
|
|
26
|
+
mockGrecaptcha.response = 'foo';
|
|
27
|
+
const recaptchaManager = new RecaptchaManager({
|
|
28
|
+
lazyLoader: mockLazyLoader,
|
|
29
|
+
grecaptchaLibrary: mockGrecaptcha,
|
|
30
|
+
});
|
|
31
|
+
try {
|
|
32
|
+
await recaptchaManager.getRecaptchaWidget();
|
|
33
|
+
expect.fail('should not get here');
|
|
34
|
+
}
|
|
35
|
+
catch (e) {
|
|
36
|
+
expect(e.message).to.equal('The reCaptcha widget requires a site key');
|
|
37
|
+
}
|
|
38
|
+
});
|
|
39
|
+
it('returns a cached version if one already exists for a given site key', async () => {
|
|
40
|
+
const mockGrecaptcha = new MockGrecaptcha({
|
|
41
|
+
mode: 'success',
|
|
42
|
+
});
|
|
43
|
+
mockGrecaptcha.response = 'foo';
|
|
44
|
+
const recaptchaManager = new RecaptchaManager({
|
|
45
|
+
lazyLoader: mockLazyLoader,
|
|
46
|
+
grecaptchaLibrary: mockGrecaptcha,
|
|
47
|
+
defaultSiteKey: '123',
|
|
48
|
+
});
|
|
49
|
+
const recaptcha1 = await recaptchaManager.getRecaptchaWidget();
|
|
50
|
+
const recaptcha2 = await recaptchaManager.getRecaptchaWidget();
|
|
51
|
+
expect(recaptcha1).to.equal(recaptcha2);
|
|
52
|
+
});
|
|
53
|
+
it('loads the recaptcha library if needed', async () => {
|
|
54
|
+
const recaptchaManager = new RecaptchaManager({
|
|
55
|
+
lazyLoader: mockLazyLoader,
|
|
56
|
+
defaultSiteKey: '123',
|
|
57
|
+
});
|
|
58
|
+
await recaptchaManager.getRecaptchaWidget();
|
|
59
|
+
const loadUrl = mockLazyLoader.loadScriptSrc;
|
|
60
|
+
expect(loadUrl === null || loadUrl === void 0 ? void 0 : loadUrl.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback')).to.be.true;
|
|
61
|
+
});
|
|
62
|
+
});
|
|
63
|
+
describe('ReCaptcha Widget', () => {
|
|
64
|
+
it('can error properly like a Promise', async () => {
|
|
65
|
+
const mockGrecaptcha = new MockGrecaptcha({
|
|
66
|
+
mode: 'error',
|
|
67
|
+
});
|
|
68
|
+
const recaptchaManager = new RecaptchaManager({
|
|
69
|
+
lazyLoader: mockLazyLoader,
|
|
70
|
+
grecaptchaLibrary: mockGrecaptcha,
|
|
71
|
+
defaultSiteKey: '123',
|
|
72
|
+
});
|
|
73
|
+
const recaptcha = await recaptchaManager.getRecaptchaWidget();
|
|
74
|
+
try {
|
|
75
|
+
await recaptcha.execute();
|
|
76
|
+
expect.fail('should not get here');
|
|
77
|
+
}
|
|
78
|
+
catch (error) {
|
|
79
|
+
expect(error.message).to.equal('error');
|
|
80
|
+
}
|
|
81
|
+
});
|
|
82
|
+
it('can expire properly like a Promise', async () => {
|
|
83
|
+
const mockGrecaptcha = new MockGrecaptcha({
|
|
84
|
+
mode: 'expired',
|
|
85
|
+
});
|
|
86
|
+
const recaptchaManager = new RecaptchaManager({
|
|
87
|
+
lazyLoader: mockLazyLoader,
|
|
88
|
+
grecaptchaLibrary: mockGrecaptcha,
|
|
89
|
+
defaultSiteKey: '123',
|
|
90
|
+
});
|
|
91
|
+
const recaptcha = await recaptchaManager.getRecaptchaWidget();
|
|
92
|
+
try {
|
|
93
|
+
await recaptcha.execute();
|
|
94
|
+
expect.fail('should not get here');
|
|
95
|
+
}
|
|
96
|
+
catch (error) {
|
|
97
|
+
expect(error.message).to.equal('expired');
|
|
98
|
+
}
|
|
99
|
+
});
|
|
100
|
+
it('resets the captcha after execution', async () => {
|
|
101
|
+
const mockGrecaptcha = new MockGrecaptcha({
|
|
102
|
+
mode: 'success',
|
|
103
|
+
addDelay: true,
|
|
104
|
+
});
|
|
105
|
+
const recaptchaManager = new RecaptchaManager({
|
|
106
|
+
lazyLoader: mockLazyLoader,
|
|
107
|
+
grecaptchaLibrary: mockGrecaptcha,
|
|
108
|
+
defaultSiteKey: '123',
|
|
109
|
+
});
|
|
110
|
+
const recaptcha = await recaptchaManager.getRecaptchaWidget();
|
|
111
|
+
expect(mockGrecaptcha.resetCallCount).to.equal(0);
|
|
112
|
+
await recaptcha.execute();
|
|
113
|
+
expect(mockGrecaptcha.resetCallCount).to.equal(1);
|
|
114
|
+
await recaptcha.execute();
|
|
115
|
+
expect(mockGrecaptcha.resetCallCount).to.equal(2);
|
|
116
|
+
});
|
|
117
|
+
// there's no way to know if the user has dismissed the captcha so if another execution
|
|
118
|
+
// comes through while the captcha is still active, it will be reset
|
|
119
|
+
it('resets the captcha if another execution gets called', async () => {
|
|
120
|
+
const mockGrecaptcha = new MockGrecaptcha({
|
|
121
|
+
mode: 'success',
|
|
122
|
+
addDelay: true,
|
|
123
|
+
});
|
|
124
|
+
const recaptchaManager = new RecaptchaManager({
|
|
125
|
+
lazyLoader: mockLazyLoader,
|
|
126
|
+
grecaptchaLibrary: mockGrecaptcha,
|
|
127
|
+
defaultSiteKey: '123',
|
|
128
|
+
});
|
|
129
|
+
const recaptcha = await recaptchaManager.getRecaptchaWidget();
|
|
130
|
+
expect(mockGrecaptcha.resetCallCount).to.equal(0);
|
|
131
|
+
recaptcha.execute();
|
|
132
|
+
expect(mockGrecaptcha.resetCallCount).to.equal(0);
|
|
133
|
+
await recaptcha.execute();
|
|
134
|
+
expect(mockGrecaptcha.resetCallCount).to.equal(2);
|
|
135
|
+
});
|
|
136
|
+
});
|
|
68
137
|
});
|
|
69
138
|
//# sourceMappingURL=recaptcha-manager.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"recaptcha-manager.test.js","sourceRoot":"","sources":["../../test/recaptcha-manager.test.ts"],"names":[],"mappings":"
|
|
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;gBACF,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;aACpC;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CACnC,0CAA0C,CAC3C,CAAC;aACH;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;gBACF,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;aACpC;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aACpD;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;gBACF,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;aACpC;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;aACtD;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"]}
|
package/index.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@internetarchive/recaptcha-manager",
|
|
3
|
-
"description": "A library that lets you lazy load and interact with reCaptcha
|
|
3
|
+
"description": "A library that lets you lazy load and interact with reCaptcha.",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/internetarchive/iaux-recaptcha-manager.git"
|
|
7
7
|
},
|
|
8
8
|
"license": "AGPL-3.0-only",
|
|
9
9
|
"author": "Internet Archive",
|
|
10
|
-
"version": "0.
|
|
10
|
+
"version": "0.1.0",
|
|
11
11
|
"main": "dist/index.js",
|
|
12
12
|
"module": "dist/index.js",
|
|
13
13
|
"scripts": {
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"types": "dist/index.d.ts",
|
|
24
24
|
"dependencies": {
|
|
25
25
|
"@internetarchive/lazy-loader-service": "^0.2.0",
|
|
26
|
-
"@types/grecaptcha": "^
|
|
26
|
+
"@types/grecaptcha": "^2"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"@open-wc/eslint-config": "^7.0.0",
|
|
@@ -41,6 +41,7 @@
|
|
|
41
41
|
"husky": "^7.0.0",
|
|
42
42
|
"lit": "^2.2.0",
|
|
43
43
|
"madge": "^5.0.1",
|
|
44
|
+
"nanoevents": "^6.0.2",
|
|
44
45
|
"prettier": "^2.4.1",
|
|
45
46
|
"sinon": "^12.0.1",
|
|
46
47
|
"tslib": "^2.3.1",
|
package/src/recaptcha-manager.ts
CHANGED
|
@@ -38,7 +38,7 @@ export class RecaptchaManager implements RecaptchaManagerInterface {
|
|
|
38
38
|
}): Promise<RecaptchaWidget> {
|
|
39
39
|
const key = options?.siteKey ?? this.defaultSiteKey;
|
|
40
40
|
if (!key) {
|
|
41
|
-
throw new Error('
|
|
41
|
+
throw new Error('The reCaptcha widget requires a site key');
|
|
42
42
|
}
|
|
43
43
|
|
|
44
44
|
const cached = this.recaptchaCache[key];
|
package/src/recaptcha-widget.ts
CHANGED
|
@@ -64,6 +64,8 @@ export class RecaptchaWidget implements RecaptchaWidgetInterface {
|
|
|
64
64
|
this.finishExecution();
|
|
65
65
|
}
|
|
66
66
|
|
|
67
|
+
this.isExecuting = true;
|
|
68
|
+
|
|
67
69
|
return new Promise((resolve, reject) => {
|
|
68
70
|
this.executionSuccessBlock = (token: string): void => {
|
|
69
71
|
this.finishExecution();
|
package/test/mock-grecaptcha.ts
CHANGED
|
@@ -1,124 +1,87 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
// // }
|
|
89
|
-
|
|
90
|
-
// // async execute(siteKey?: any, action?: any): void | PromiseLike<string> {
|
|
91
|
-
|
|
92
|
-
// // }
|
|
93
|
-
|
|
94
|
-
// ready(callback: () => void): void {
|
|
95
|
-
|
|
96
|
-
// }
|
|
97
|
-
|
|
98
|
-
// private callCallback(): void {
|
|
99
|
-
// switch (this.mode) {
|
|
100
|
-
// case MockGrecaptchaMode.Success:
|
|
101
|
-
// if (this.callback) {
|
|
102
|
-
// this.callback('foo');
|
|
103
|
-
// }
|
|
104
|
-
// break;
|
|
105
|
-
// case MockGrecaptchaMode.Error:
|
|
106
|
-
// if (this['error-callback']) {
|
|
107
|
-
// this['error-callback']();
|
|
108
|
-
// }
|
|
109
|
-
// break;
|
|
110
|
-
// case MockGrecaptchaMode.Expired:
|
|
111
|
-
// if (this['expired-callback']) {
|
|
112
|
-
// this['expired-callback']();
|
|
113
|
-
// }
|
|
114
|
-
// break;
|
|
115
|
-
// default:
|
|
116
|
-
// break;
|
|
117
|
-
// }
|
|
118
|
-
// }
|
|
119
|
-
|
|
120
|
-
// constructor(mode: MockGrecaptchaMode, addDelay = false) {
|
|
121
|
-
// this.mode = mode;
|
|
122
|
-
// this.addDelay = addDelay;
|
|
123
|
-
// }
|
|
124
|
-
// }
|
|
1
|
+
/* eslint-disable camelcase */
|
|
2
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
3
|
+
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
4
|
+
|
|
5
|
+
export type MockGrecaptchaMode = 'success' | 'expired' | 'error';
|
|
6
|
+
|
|
7
|
+
export class MockGrecaptcha implements ReCaptchaV2.ReCaptcha {
|
|
8
|
+
response = 'foo';
|
|
9
|
+
|
|
10
|
+
renderCalled = false;
|
|
11
|
+
|
|
12
|
+
executeCalled = false;
|
|
13
|
+
|
|
14
|
+
resetCallCount = 0;
|
|
15
|
+
|
|
16
|
+
getResponseCalled = false;
|
|
17
|
+
|
|
18
|
+
mode: MockGrecaptchaMode;
|
|
19
|
+
|
|
20
|
+
addDelay: boolean;
|
|
21
|
+
|
|
22
|
+
callback?: (response: string) => void;
|
|
23
|
+
|
|
24
|
+
'expired-callback'?: () => void;
|
|
25
|
+
|
|
26
|
+
'error-callback'?: () => void;
|
|
27
|
+
|
|
28
|
+
render(
|
|
29
|
+
container: string | HTMLElement,
|
|
30
|
+
parameters?: ReCaptchaV2.Parameters | undefined,
|
|
31
|
+
inherit?: boolean | undefined
|
|
32
|
+
): number {
|
|
33
|
+
this.callback = parameters?.callback?.bind(this);
|
|
34
|
+
this['error-callback'] = parameters?.['error-callback']?.bind(this);
|
|
35
|
+
this['expired-callback'] = parameters?.['expired-callback']?.bind(this);
|
|
36
|
+
this.renderCalled = true;
|
|
37
|
+
return 1;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
reset(opt_widget_id?: number | undefined): void {
|
|
41
|
+
this.resetCallCount += 1;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
getResponse(opt_widget_id?: number | undefined): string {
|
|
45
|
+
this.getResponseCalled = true;
|
|
46
|
+
return 'foo';
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
execute(opt_widget_id?: number): void {
|
|
50
|
+
this.executeCalled = true;
|
|
51
|
+
|
|
52
|
+
if (this.addDelay) {
|
|
53
|
+
setTimeout(this.callCallback.bind(this), 100);
|
|
54
|
+
} else {
|
|
55
|
+
this.callCallback();
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
ready(callback: () => void): void {}
|
|
60
|
+
|
|
61
|
+
private callCallback(): void {
|
|
62
|
+
switch (this.mode) {
|
|
63
|
+
case 'success':
|
|
64
|
+
if (this.callback) {
|
|
65
|
+
this.callback('foo');
|
|
66
|
+
}
|
|
67
|
+
break;
|
|
68
|
+
case 'error':
|
|
69
|
+
if (this['error-callback']) {
|
|
70
|
+
this['error-callback']();
|
|
71
|
+
}
|
|
72
|
+
break;
|
|
73
|
+
case 'expired':
|
|
74
|
+
if (this['expired-callback']) {
|
|
75
|
+
this['expired-callback']();
|
|
76
|
+
}
|
|
77
|
+
break;
|
|
78
|
+
default:
|
|
79
|
+
break;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
constructor(options: { mode: MockGrecaptchaMode; addDelay?: boolean }) {
|
|
84
|
+
this.mode = options.mode;
|
|
85
|
+
this.addDelay = options.addDelay ?? false;
|
|
86
|
+
}
|
|
87
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
2
|
+
import {
|
|
3
|
+
BundleType,
|
|
4
|
+
LazyLoaderServiceEvents,
|
|
5
|
+
LazyLoaderServiceInterface,
|
|
6
|
+
} from '@internetarchive/lazy-loader-service';
|
|
7
|
+
import { Unsubscribe } from 'nanoevents';
|
|
8
|
+
import { MockGrecaptcha } from './mock-grecaptcha';
|
|
9
|
+
|
|
10
|
+
export class MockLazyLoaderService implements LazyLoaderServiceInterface {
|
|
11
|
+
loadScriptSrc?: string;
|
|
12
|
+
|
|
13
|
+
on<E extends keyof LazyLoaderServiceEvents>(
|
|
14
|
+
event: E,
|
|
15
|
+
callback: LazyLoaderServiceEvents[E]
|
|
16
|
+
): Unsubscribe {
|
|
17
|
+
throw new Error('Method not implemented.');
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
async loadBundle(bundle: {
|
|
21
|
+
module?: string;
|
|
22
|
+
nomodule?: string;
|
|
23
|
+
}): Promise<void> {
|
|
24
|
+
console.debug('loadBundle', bundle);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
async loadScript(options: {
|
|
28
|
+
src: string;
|
|
29
|
+
bundleType?: BundleType;
|
|
30
|
+
attributes?: Record<string, string>;
|
|
31
|
+
}): Promise<void> {
|
|
32
|
+
this.loadScriptSrc = options.src;
|
|
33
|
+
window.grecaptcha = new MockGrecaptcha({
|
|
34
|
+
mode: 'success',
|
|
35
|
+
});
|
|
36
|
+
(window as any).grecaptchaLoadedCallback();
|
|
37
|
+
}
|
|
38
|
+
}
|