@sitecore-cloudsdk/events 0.4.4 → 0.5.0-rc.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.
Files changed (69) hide show
  1. package/dist/cjs/package.json +3 -3
  2. package/dist/cjs/src/browser.d.ts +0 -3
  3. package/dist/cjs/src/browser.js +1 -7
  4. package/dist/cjs/src/lib/consts.d.ts +0 -3
  5. package/dist/cjs/src/lib/consts.js +0 -3
  6. package/dist/cjs/src/lib/eventStorage/addToEventQueue.js +9 -22
  7. package/dist/cjs/src/lib/eventStorage/clearEventQueue.js +1 -1
  8. package/dist/cjs/src/lib/eventStorage/processEventQueue.js +1 -1
  9. package/dist/cjs/src/lib/events/custom-event/custom-event.d.ts +2 -2
  10. package/dist/cjs/src/lib/events/custom-event/custom-event.js +2 -2
  11. package/dist/cjs/src/lib/events/custom-event/event.js +9 -22
  12. package/dist/cjs/src/lib/events/custom-event/eventServer.js +5 -14
  13. package/dist/cjs/src/lib/events/custom-event/form.js +17 -39
  14. package/dist/cjs/src/lib/events/identity/identity.js +9 -22
  15. package/dist/cjs/src/lib/events/identity/identityServer.d.ts +1 -1
  16. package/dist/cjs/src/lib/events/identity/identityServer.js +5 -16
  17. package/dist/cjs/src/lib/events/page-view/page-view-server.d.ts +1 -1
  18. package/dist/cjs/src/lib/events/page-view/page-view-server.js +5 -16
  19. package/dist/cjs/src/lib/events/page-view/page-view.js +10 -24
  20. package/dist/cjs/src/lib/initializer/browser/initializer.d.ts +1 -0
  21. package/dist/cjs/src/lib/initializer/browser/initializer.js +8 -1
  22. package/dist/cjs/src/lib/initializer/server/initializer.d.ts +1 -0
  23. package/dist/cjs/src/lib/initializer/server/initializer.js +7 -2
  24. package/dist/cjs/src/server.d.ts +1 -2
  25. package/dist/cjs/src/server.js +2 -4
  26. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  27. package/dist/esm/package.json +3 -3
  28. package/dist/esm/src/browser.d.ts +0 -3
  29. package/dist/esm/src/browser.js +0 -3
  30. package/dist/esm/src/lib/consts.d.ts +0 -3
  31. package/dist/esm/src/lib/consts.js +0 -3
  32. package/dist/esm/src/lib/eventStorage/addToEventQueue.js +10 -23
  33. package/dist/esm/src/lib/eventStorage/clearEventQueue.js +1 -1
  34. package/dist/esm/src/lib/eventStorage/processEventQueue.js +1 -1
  35. package/dist/esm/src/lib/events/custom-event/custom-event.d.ts +2 -2
  36. package/dist/esm/src/lib/events/custom-event/custom-event.js +2 -2
  37. package/dist/esm/src/lib/events/custom-event/event.js +10 -23
  38. package/dist/esm/src/lib/events/custom-event/eventServer.js +6 -15
  39. package/dist/esm/src/lib/events/custom-event/form.js +18 -40
  40. package/dist/esm/src/lib/events/identity/identity.js +10 -23
  41. package/dist/esm/src/lib/events/identity/identityServer.d.ts +1 -1
  42. package/dist/esm/src/lib/events/identity/identityServer.js +6 -17
  43. package/dist/esm/src/lib/events/page-view/page-view-server.d.ts +1 -1
  44. package/dist/esm/src/lib/events/page-view/page-view-server.js +6 -17
  45. package/dist/esm/src/lib/events/page-view/page-view.js +11 -25
  46. package/dist/esm/src/lib/initializer/browser/initializer.d.ts +1 -0
  47. package/dist/esm/src/lib/initializer/browser/initializer.js +8 -2
  48. package/dist/esm/src/lib/initializer/server/initializer.d.ts +1 -0
  49. package/dist/esm/src/lib/initializer/server/initializer.js +6 -2
  50. package/dist/esm/src/server.d.ts +1 -2
  51. package/dist/esm/src/server.js +1 -2
  52. package/dist/esm/tsconfig.tsbuildinfo +1 -1
  53. package/package.json +3 -3
  54. package/dist/cjs/src/lib/getBrowserId/getBrowserId.d.ts +0 -8
  55. package/dist/cjs/src/lib/getBrowserId/getBrowserId.js +0 -16
  56. package/dist/cjs/src/lib/getGuestId/getGuestId.d.ts +0 -9
  57. package/dist/cjs/src/lib/getGuestId/getGuestId.js +0 -30
  58. package/dist/cjs/src/lib/init/browser/initializer.d.ts +0 -13
  59. package/dist/cjs/src/lib/init/browser/initializer.js +0 -48
  60. package/dist/cjs/src/lib/init/server/initializer.d.ts +0 -11
  61. package/dist/cjs/src/lib/init/server/initializer.js +0 -26
  62. package/dist/esm/src/lib/getBrowserId/getBrowserId.d.ts +0 -8
  63. package/dist/esm/src/lib/getBrowserId/getBrowserId.js +0 -12
  64. package/dist/esm/src/lib/getGuestId/getGuestId.d.ts +0 -9
  65. package/dist/esm/src/lib/getGuestId/getGuestId.js +0 -26
  66. package/dist/esm/src/lib/init/browser/initializer.d.ts +0 -13
  67. package/dist/esm/src/lib/init/browser/initializer.js +0 -43
  68. package/dist/esm/src/lib/init/server/initializer.d.ts +0 -11
  69. package/dist/esm/src/lib/init/server/initializer.js +0 -22
@@ -1,26 +0,0 @@
1
- // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
2
- import { getBrowserId, getCloudSDKSettingsBrowser as getCloudSDKSettings, getEnabledPackageBrowser as getEnabledPackage, getGuestId as getGuestIdFromCore, getSettings, handleGetSettingsError } from '@sitecore-cloudsdk/core/internal';
3
- import { getCookieValueClientSide } from '@sitecore-cloudsdk/utils';
4
- import { ErrorMessages, PACKAGE_NAME } from '../consts';
5
- import { awaitInit } from '../init/browser/initializer';
6
- /**
7
- * A function that returns the guest ID.
8
- * @returns - A promise that resolves with the guest ID
9
- * @throws - Will throw an error if the sitecoreEdgeContextId is incorrect
10
- * @deprecated Cloud SDK v0.4 introduces a new getGuestId function. If you are upgrading from v0.3, we recommend that
11
- * you use the getGuestId function that is exposed from \@sitecore-cloudsdk/core/browser. The v0.3 function will be
12
- * deprecated and removed in a future Cloud SDK release.
13
- */
14
- export async function getGuestId() {
15
- await awaitInit();
16
- if (getEnabledPackage(PACKAGE_NAME)?.initState) {
17
- const settings = getCloudSDKSettings();
18
- const id = getCookieValueClientSide(settings.cookieSettings.name.browserId);
19
- return getGuestIdFromCore(id, settings.sitecoreEdgeContextId, settings.sitecoreEdgeUrl);
20
- }
21
- else {
22
- const settings = handleGetSettingsError(getSettings, ErrorMessages.IE_0014);
23
- const id = getBrowserId();
24
- return getGuestIdFromCore(id, settings.sitecoreEdgeContextId, settings.sitecoreEdgeUrl);
25
- }
26
- }
@@ -1,13 +0,0 @@
1
- import type { BrowserSettings } from '@sitecore-cloudsdk/core/internal';
2
- export declare let initPromise: Promise<void> | null;
3
- /**
4
- * Initiates the Events library using the global settings added by the developer
5
- * @param settings - Global settings added by the developer
6
- * @returns A promise that resolves with an object that handles the library functionality
7
- * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
8
- */
9
- export declare function init(settings: BrowserSettings): Promise<void>;
10
- /**
11
- * A function that handles the async browser init logic. Throws an error or awaits the promise.
12
- */
13
- export declare function awaitInit(): Promise<void>;
@@ -1,43 +0,0 @@
1
- // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
2
- import { EVENTS_NAMESPACE, ErrorMessages, PACKAGE_NAME, PACKAGE_VERSION } from '../../consts';
3
- import { debug, getBrowserId, getEnabledPackageBrowser as getEnabledPackage, initCore } from '@sitecore-cloudsdk/core/internal';
4
- export let initPromise = null;
5
- /* eslint-disable max-len */
6
- /**
7
- * Initiates the Events library using the global settings added by the developer
8
- * @param settings - Global settings added by the developer
9
- * @returns A promise that resolves with an object that handles the library functionality
10
- * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
11
- */
12
- /* eslint-enable max-len */
13
- export async function init(settings) {
14
- if (typeof window === 'undefined')
15
- throw new Error(ErrorMessages.IE_0001);
16
- try {
17
- initPromise = initCore(settings);
18
- await initPromise;
19
- debug(EVENTS_NAMESPACE)('eventsClient library initialized');
20
- }
21
- catch (error) {
22
- debug(EVENTS_NAMESPACE)('Error on initializing eventsClient library: %o', error);
23
- initPromise = null;
24
- throw new Error(error);
25
- }
26
- window.Engage = {
27
- ...window.Engage,
28
- getBrowserId: () => getBrowserId(),
29
- versions: {
30
- ...window.Engage?.versions,
31
- events: PACKAGE_VERSION
32
- }
33
- };
34
- }
35
- /**
36
- * A function that handles the async browser init logic. Throws an error or awaits the promise.
37
- */
38
- export async function awaitInit() {
39
- const initState = getEnabledPackage(PACKAGE_NAME)?.initState;
40
- if (initPromise === null && !initState)
41
- throw new Error(ErrorMessages.IE_0014);
42
- initPromise ? await initPromise : await initState;
43
- }
@@ -1,11 +0,0 @@
1
- import type { Request, Response } from '@sitecore-cloudsdk/utils';
2
- import type { ServerSettings } from '@sitecore-cloudsdk/core/internal';
3
- /**
4
- * Initiates the server Events library using the global settings added by the developer
5
- * @param request - The request object, either a Middleware Request or an HTTP Request
6
- * @param response - The response object, either a Middleware Next Response or an HTTP Response
7
- * @param settings - Global settings added by the developer
8
- * @returns A promise that resolves with an object that handles the library functionality
9
- * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
10
- */
11
- export declare function initServer(request: Request, response: Response, settings: ServerSettings): Promise<void>;
@@ -1,22 +0,0 @@
1
- import { debug, initCoreServer } from '@sitecore-cloudsdk/core/internal';
2
- import { EVENTS_NAMESPACE } from '../../consts';
3
- /* eslint-disable max-len */
4
- /**
5
- * Initiates the server Events library using the global settings added by the developer
6
- * @param request - The request object, either a Middleware Request or an HTTP Request
7
- * @param response - The response object, either a Middleware Next Response or an HTTP Response
8
- * @param settings - Global settings added by the developer
9
- * @returns A promise that resolves with an object that handles the library functionality
10
- * @deprecated Cloud SDK v0.4 introduces new initialization logic. If you are upgrading from v0.3, we recommend that you upgrade your initialization code. The v0.3 initialization logic will be deprecated and removed in a future Cloud SDK release.
11
- */
12
- /* eslint-enable max-len */
13
- export async function initServer(request, response, settings) {
14
- try {
15
- await initCoreServer(settings, request, response);
16
- debug(EVENTS_NAMESPACE)('eventsServer library initialized');
17
- }
18
- catch (error) {
19
- debug(EVENTS_NAMESPACE)('Error on initializing eventsServer library with error: %o', error);
20
- throw new Error(error);
21
- }
22
- }