Skip to content

Commit 536a3b9

Browse files
alexanderkirtzelalexanderkirtzel
committed
createSourceWalkerjs
1 parent 9a16a0b commit 536a3b9

File tree

7 files changed

+39
-39
lines changed

7 files changed

+39
-39
lines changed

‎packages/sources/walkerjs/src/__tests__/commands.test.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { SourceWalkerjs } from '..';
22
import type { Elb, WalkerOS } from '@elbwalker/types';
33
import { mockDataLayer } from '@elbwalker/jest/web.setup';
4-
import { createInstance } from '..';
4+
import { createSourceWalkerjs } from '..';
55

66
describe('Commands', () => {
77
let elb: Elb.Fn;
@@ -12,7 +12,7 @@ describe('Commands', () => {
1212
.fn()
1313
.mockReturnValue([{ type: 'navigate' }]);
1414

15-
const { elb: elbFn, instance } = createInstance({
15+
const { elb: elbFn, instance } = createSourceWalkerjs({
1616
default: true,
1717
consent: { test: true },
1818
pageview: false,
@@ -114,7 +114,7 @@ describe('Commands', () => {
114114

115115
test('walker consent', async () => {
116116
jest.clearAllMocks();
117-
const { elb, instance } = createInstance({
117+
const { elb, instance } = createSourceWalkerjs({
118118
consent: { functional: true },
119119
default: true,
120120
pageview: false,
@@ -160,7 +160,7 @@ describe('Commands', () => {
160160
});
161161

162162
test('walker globals', async () => {
163-
const { elb } = createInstance({
163+
const { elb } = createSourceWalkerjs({
164164
default: true,
165165
globalsStatic: { static: 'value' },
166166
});
@@ -188,7 +188,7 @@ describe('Commands', () => {
188188
});
189189

190190
test('walker custom', async () => {
191-
const { elb, instance } = createInstance({
191+
const { elb, instance } = createSourceWalkerjs({
192192
default: true,
193193
custom: { static: 'value' },
194194
});

‎packages/sources/walkerjs/src/__tests__/destination.test.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { SourceWalkerjs, DestinationWeb } from '..';
22
import { mockDataLayer } from '@elbwalker/jest/web.setup';
33
import { getEvent } from '@elbwalker/utils';
4-
import { createInstance, elb as elbOrg } from '..';
4+
import { createSourceWalkerjs, elb as elbOrg } from '..';
55

66
describe('Destination', () => {
77
let instance: SourceWalkerjs.Instance;
@@ -15,7 +15,7 @@ describe('Destination', () => {
1515
let config: DestinationWeb.Config;
1616

1717
beforeEach(() => {
18-
({ elb, instance } = createInstance({
18+
({ elb, instance } = createSourceWalkerjs({
1919
pageview: false,
2020
session: false,
2121
}));
@@ -372,7 +372,7 @@ describe('Destination', () => {
372372

373373
test('consent', async () => {
374374
jest.clearAllMocks();
375-
const { elb } = createInstance({
375+
const { elb } = createSourceWalkerjs({
376376
consent: { functional: true, marketing: false },
377377
pageview: false,
378378
session: false,
@@ -447,7 +447,7 @@ describe('Destination', () => {
447447
});
448448

449449
test('queue', async () => {
450-
const { elb } = createInstance({
450+
const { elb } = createSourceWalkerjs({
451451
consent: { functional: true },
452452
pageview: false,
453453
session: false,
@@ -654,7 +654,7 @@ describe('Destination', () => {
654654
});
655655

656656
test('temp async queue', async () => {
657-
const { elb } = createInstance({ elbLayer: [], pageview: false });
657+
const { elb } = createSourceWalkerjs({ elbLayer: [], pageview: false });
658658
elb('walker run');
659659
elb('walker destination', destination);
660660

@@ -821,7 +821,7 @@ describe('Destination', () => {
821821
});
822822

823823
test('dataLayer config', async () => {
824-
const { elb } = createInstance({
824+
const { elb } = createSourceWalkerjs({
825825
default: true,
826826
pageview: false,
827827
session: false,
@@ -889,7 +889,7 @@ describe('Destination', () => {
889889
},
890890
};
891891

892-
const { elb } = createInstance({
892+
const { elb } = createSourceWalkerjs({
893893
run: true,
894894
pageview: false,
895895
session: false,
@@ -937,7 +937,7 @@ describe('Destination', () => {
937937
},
938938
};
939939

940-
const { elb } = createInstance({
940+
const { elb } = createSourceWalkerjs({
941941
run: true,
942942
pageview: false,
943943
session: false,

‎packages/sources/walkerjs/src/__tests__/elblayer.test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { SourceWalkerjs, DestinationWeb, Elb } from '..';
22
import type { WalkerOS } from '@elbwalker/types';
33
import { mockDataLayer } from '@elbwalker/jest/web.setup';
4-
import { elb as elbOrg, Walkerjs, createInstance, elb } from '..';
4+
import { elb as elbOrg, Walkerjs, createSourceWalkerjs, elb } from '..';
55

66
describe('elbLayer', () => {
77
const w = window;
@@ -364,7 +364,7 @@ describe('elbLayer', () => {
364364
});
365365

366366
test('command order', async () => {
367-
const { instance } = createInstance();
367+
const { instance } = createSourceWalkerjs();
368368
const pushSpy = jest.spyOn(instance, 'push');
369369

370370
elb('walker run');
@@ -388,7 +388,7 @@ describe('elbLayer', () => {
388388
{ any: 'thing' }, // custom
389389
);
390390

391-
const { elb } = createInstance({ default: true, pageview: false });
391+
const { elb } = createSourceWalkerjs({ default: true, pageview: false });
392392

393393
await jest.runAllTimersAsync();
394394
expect(mockDataLayer).toHaveBeenCalledWith(

‎packages/sources/walkerjs/src/__tests__/hooks.test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { Hooks } from '@elbwalker/types';
22
import type { SourceWalkerjs, DestinationWeb } from '..';
33
import { mockDataLayer } from '@elbwalker/jest/web.setup';
4-
import { Walkerjs, createInstance } from '..';
4+
import { Walkerjs, createSourceWalkerjs } from '..';
55

66
describe('Hooks', () => {
77
let walkerjs: SourceWalkerjs.Instance;
@@ -44,7 +44,7 @@ describe('Hooks', () => {
4444
return params.fn(...args);
4545
});
4646

47-
const { elb, instance } = createInstance({
47+
const { elb, instance } = createSourceWalkerjs({
4848
pageview: false,
4949
session: false,
5050
});
@@ -105,7 +105,7 @@ describe('Hooks', () => {
105105
});
106106
const postPush: Hooks.AnyFunction = jest.fn();
107107

108-
const { elb, instance } = createInstance({
108+
const { elb, instance } = createSourceWalkerjs({
109109
dataLayer: true,
110110
pageview: false,
111111
session: false,

‎packages/sources/walkerjs/src/__tests__/source.test.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { Data } from '@elbwalker/types';
22
import type { Elb, SourceWalkerjs } from '..';
33
import { mockDataLayer } from '@elbwalker/jest/web.setup';
4-
import { Walkerjs, createInstance } from '..';
4+
import { Walkerjs, createSourceWalkerjs } from '..';
55
import fs from 'fs';
66

77
describe('Walkerjs', () => {
@@ -16,7 +16,7 @@ describe('Walkerjs', () => {
1616
.fn()
1717
.mockReturnValue([{ type: 'navigate' }]);
1818

19-
const { elb: elbFn, instance } = createInstance({
19+
const { elb: elbFn, instance } = createSourceWalkerjs({
2020
default: true,
2121
consent: { test: true },
2222
pageview: false,
@@ -160,7 +160,7 @@ describe('Walkerjs', () => {
160160

161161
jest.clearAllMocks(); // skip previous init
162162
w.elbLayer = [];
163-
const { elb } = createInstance({
163+
const { elb } = createSourceWalkerjs({
164164
default: true,
165165
pageview: false,
166166
session: false,
@@ -234,7 +234,7 @@ describe('Walkerjs', () => {
234234
test('timing', async () => {
235235
jest.clearAllMocks();
236236
jest.advanceTimersByTime(2500); // 2.5 sec load time
237-
const { elb } = createInstance({ default: true });
237+
const { elb } = createSourceWalkerjs({ default: true });
238238

239239
await jest.runAllTimersAsync();
240240
expect(mockDataLayer.mock.calls[0][0].timing).toEqual(2.5);

‎packages/sources/walkerjs/src/__tests__/trigger.test.ts‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { mockDataLayer } from '@elbwalker/jest/web.setup';
22
import { Trigger } from '../lib/trigger';
3-
import { createInstance } from '..';
3+
import { createSourceWalkerjs } from '..';
44

55
describe('Trigger', () => {
66
const w = window;
@@ -25,7 +25,7 @@ describe('Trigger', () => {
2525

2626
test('elb', async () => {
2727
w.elbLayer = undefined as never;
28-
const { elb } = createInstance({ default: true, session: false });
28+
const { elb } = createSourceWalkerjs({ default: true, session: false });
2929

3030
expect(w.elbLayer).toBeDefined();
3131

@@ -39,7 +39,7 @@ describe('Trigger', () => {
3939
test('init global', () => {
4040
expect(mockAddEventListener).toHaveBeenCalledTimes(0);
4141

42-
createInstance({ default: true, session: false });
42+
createSourceWalkerjs({ default: true, session: false });
4343
expect(mockAddEventListener).toHaveBeenCalledWith(
4444
Trigger.Click,
4545
expect.any(Function),
@@ -52,7 +52,7 @@ describe('Trigger', () => {
5252

5353
test('init scope', async () => {
5454
document.body.innerHTML = `<div id="init" data-elb="e" data-elbaction="load:all"><div data-elbaction="load:init"></div></div>`;
55-
const { elb } = createInstance({ default: true, session: false });
55+
const { elb } = createSourceWalkerjs({ default: true, session: false });
5656

5757
// Both e load events should be triggered
5858
await elb('walker init');
@@ -81,7 +81,7 @@ describe('Trigger', () => {
8181
});
8282

8383
test('load page view', async () => {
84-
const { elb } = createInstance({ dataLayer: true, session: false });
84+
const { elb } = createSourceWalkerjs({ dataLayer: true, session: false });
8585
document.body.setAttribute('data-elb-page', 'foo:bar');
8686
document.body.setAttribute('data-elbcontext', 'baz:qux');
8787
await elb('walker run');
@@ -120,7 +120,7 @@ describe('Trigger', () => {
120120
});
121121

122122
// New page run on new page
123-
const { elb } = createInstance({ dataLayer: true, session: false });
123+
const { elb } = createSourceWalkerjs({ dataLayer: true, session: false });
124124

125125
await elb('walker run');
126126
expect(mockDataLayer).toHaveBeenCalledWith(
@@ -158,7 +158,7 @@ describe('Trigger', () => {
158158
});
159159

160160
test('load readyState loading', async () => {
161-
const { elb } = createInstance({
161+
const { elb } = createSourceWalkerjs({
162162
dataLayer: true,
163163
session: false,
164164
});
@@ -190,7 +190,7 @@ describe('Trigger', () => {
190190

191191
test('click', async () => {
192192
document.body.innerHTML = `<div id="click" data-elb="e" data-elbaction="click"></div>`;
193-
createInstance({ default: true, session: false, pageview: false });
193+
createSourceWalkerjs({ default: true, session: false, pageview: false });
194194

195195
const elem = document.getElementById('click');
196196

@@ -214,7 +214,7 @@ describe('Trigger', () => {
214214
<button type="submit">Submit</button>
215215
</form>
216216
`;
217-
createInstance({ default: true, session: false, pageview: false });
217+
createSourceWalkerjs({ default: true, session: false, pageview: false });
218218

219219
// https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event
220220
const form = document.getElementById('form');
@@ -233,7 +233,7 @@ describe('Trigger', () => {
233233

234234
test('hover', async () => {
235235
document.body.innerHTML = `<div id="hover" data-elb="mouse" data-elbaction="hover"></div>`;
236-
createInstance({ default: true, session: false, pageview: false });
236+
createSourceWalkerjs({ default: true, session: false, pageview: false });
237237

238238
const elem = document.getElementById('hover') as Element;
239239
const hoverEvent = new MouseEvent('mouseenter', {
@@ -267,7 +267,7 @@ describe('Trigger', () => {
267267

268268
test('wait', async () => {
269269
document.body.innerHTML = `<div data-elb="timer" data-elb-timer="its:time" data-elbaction="wait(4000):alarm"></div>`;
270-
createInstance({ default: true, session: false, pageview: false });
270+
createSourceWalkerjs({ default: true, session: false, pageview: false });
271271

272272
expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 4000);
273273

@@ -294,7 +294,7 @@ describe('Trigger', () => {
294294

295295
test('pulse', async () => {
296296
document.body.innerHTML = `<div id="pulse" data-elb="pulse" data-elbaction="pulse(5000):beat"></div>`;
297-
createInstance({ default: true, session: false, pageview: false });
297+
createSourceWalkerjs({ default: true, session: false, pageview: false });
298298

299299
expect(setInterval).toHaveBeenCalledWith(expect.any(Function), 5000);
300300

@@ -356,7 +356,7 @@ describe('Trigger', () => {
356356
test('scroll', async () => {
357357
// New instance without cached scroll listener
358358
document.body.innerHTML = `<div id="scroll" data-elb="scroll" data-elbaction="scroll(80):80percent"></div>`;
359-
createInstance({ default: true, session: false, pageview: false });
359+
createSourceWalkerjs({ default: true, session: false, pageview: false });
360360

361361
const innerHeight = window.innerHeight;
362362
const elem = document.getElementById('scroll') as HTMLElement;
@@ -441,8 +441,8 @@ describe('Trigger', () => {
441441

442442
// Reimport with the mocked isVisible
443443
document.body.innerHTML = `<div id="visible" data-elb="visible" data-elbaction="visible:impression"></div>`;
444-
const { createInstance } = jest.requireActual('../');
445-
createInstance({ default: true, session: false, pageview: false });
444+
const { createSourceWalkerjs } = jest.requireActual('../');
445+
createSourceWalkerjs({ default: true, session: false, pageview: false });
446446

447447
const target = document.getElementById('visible');
448448
const [observer] = (window.IntersectionObserver as jest.Mock).mock.calls[0];

‎packages/sources/walkerjs/src/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export * from './types';
1515

1616
export const elb = createElb();
1717

18-
export function createInstance(customConfig?: SourceWalkerjs.InitConfig) {
18+
export function createSourceWalkerjs(customConfig?: SourceWalkerjs.InitConfig) {
1919
const instance = Walkerjs(customConfig);
2020
const elb = instance.push;
2121

0 commit comments

Comments
 (0)