@surfside/ads-react 0.1.0 → 0.1.2

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 (72) hide show
  1. package/README.md +127 -127
  2. package/lib/cjs/components/SurfsideBanner.js +71 -0
  3. package/lib/cjs/components/SurfsideBanner.js.map +1 -0
  4. package/lib/cjs/components/SurfsideCarousel.js +103 -0
  5. package/lib/cjs/components/SurfsideCarousel.js.map +1 -0
  6. package/lib/cjs/components/SurfsideDynamicZone.js +131 -0
  7. package/lib/cjs/components/SurfsideDynamicZone.js.map +1 -0
  8. package/lib/cjs/components/SurfsideProduct.js +3 -0
  9. package/lib/cjs/components/SurfsideProduct.js.map +1 -0
  10. package/lib/cjs/components/SurfsideVideo.js +82 -0
  11. package/lib/cjs/components/SurfsideVideo.js.map +1 -0
  12. package/lib/cjs/components/index.js +23 -0
  13. package/lib/cjs/components/index.js.map +1 -0
  14. package/lib/cjs/hooks/index.js +22 -0
  15. package/lib/cjs/hooks/index.js.map +1 -0
  16. package/lib/cjs/hooks/useSurfsideBanner.js +215 -0
  17. package/lib/cjs/hooks/useSurfsideBanner.js.map +1 -0
  18. package/lib/cjs/hooks/useSurfsideDynamicZone.js +202 -0
  19. package/lib/cjs/hooks/useSurfsideDynamicZone.js.map +1 -0
  20. package/lib/cjs/hooks/useSurfsideProducts.js +366 -0
  21. package/lib/cjs/hooks/useSurfsideProducts.js.map +1 -0
  22. package/lib/cjs/hooks/useSurfsideVideo.js +295 -0
  23. package/lib/cjs/hooks/useSurfsideVideo.js.map +1 -0
  24. package/lib/cjs/index.js +20 -16325
  25. package/lib/cjs/index.js.map +1 -0
  26. package/lib/cjs/provider/SurfsideContextProvider.js +158 -0
  27. package/lib/cjs/provider/SurfsideContextProvider.js.map +1 -0
  28. package/lib/cjs/provider/index.js +19 -0
  29. package/lib/cjs/provider/index.js.map +1 -0
  30. package/lib/cjs/utils/Analytics.js +181 -0
  31. package/lib/cjs/utils/Analytics.js.map +1 -0
  32. package/lib/cjs/utils/index.js +18 -0
  33. package/lib/cjs/utils/index.js.map +1 -0
  34. package/lib/esm/components/SurfsideBanner.js +67 -0
  35. package/lib/esm/components/SurfsideBanner.js.map +1 -0
  36. package/lib/esm/components/SurfsideCarousel.js +99 -0
  37. package/lib/esm/components/SurfsideCarousel.js.map +1 -0
  38. package/lib/esm/components/SurfsideDynamicZone.js +126 -0
  39. package/lib/esm/components/SurfsideDynamicZone.js.map +1 -0
  40. package/lib/esm/components/SurfsideProduct.js +2 -0
  41. package/lib/esm/components/SurfsideProduct.js.map +1 -0
  42. package/lib/esm/components/SurfsideVideo.js +78 -0
  43. package/lib/esm/components/SurfsideVideo.js.map +1 -0
  44. package/lib/esm/components/index.js +7 -0
  45. package/lib/esm/components/index.js.map +1 -0
  46. package/lib/esm/hooks/index.js +6 -0
  47. package/lib/esm/hooks/index.js.map +1 -0
  48. package/lib/esm/hooks/useSurfsideBanner.js +209 -0
  49. package/lib/esm/hooks/useSurfsideBanner.js.map +1 -0
  50. package/lib/esm/hooks/useSurfsideDynamicZone.js +197 -0
  51. package/lib/esm/hooks/useSurfsideDynamicZone.js.map +1 -0
  52. package/lib/esm/hooks/useSurfsideProducts.js +359 -0
  53. package/lib/esm/hooks/useSurfsideProducts.js.map +1 -0
  54. package/lib/esm/hooks/useSurfsideVideo.js +289 -0
  55. package/lib/esm/hooks/useSurfsideVideo.js.map +1 -0
  56. package/lib/esm/index.js +4 -16299
  57. package/lib/esm/index.js.map +1 -0
  58. package/lib/esm/provider/SurfsideContextProvider.js +151 -0
  59. package/lib/esm/provider/SurfsideContextProvider.js.map +1 -0
  60. package/lib/esm/provider/index.js +3 -0
  61. package/lib/esm/provider/index.js.map +1 -0
  62. package/lib/esm/utils/Analytics.js +171 -0
  63. package/lib/esm/utils/Analytics.js.map +1 -0
  64. package/lib/esm/utils/index.js +2 -0
  65. package/lib/esm/utils/index.js.map +1 -0
  66. package/lib/types/components/SurfsideBanner.d.ts +1 -2
  67. package/lib/types/components/SurfsideVideo.d.ts +0 -1
  68. package/lib/types/hooks/useSurfsideBanner.d.ts +1 -1
  69. package/package.json +13 -6
  70. package/lib/types/hooks/useSurfDynamicZone.d.ts +0 -7
  71. package/lib/types/types.d.ts +0 -33
  72. package/lib/types/utils/analytics.d.ts +0 -58
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}
@@ -0,0 +1,151 @@
1
+ 'use client';
2
+ import { jsx as _jsx } from "react/jsx-runtime";
3
+ import { createContext, useContext, useState, useEffect, useMemo, } from 'react';
4
+ import { InitLogger, Ctx, TryDo, Err, GetValueOrThrow, } from '@surfside/ads-core';
5
+ import { InitSurfAdsWeb, InitSurfAdsWebInternal } from '@surfside/ads-core-web';
6
+ import { InitSurfAdsCoreMock } from '@surfside/ads-core-mock';
7
+ ;
8
+ ;
9
+ ;
10
+ const SurfsideContext = createContext(undefined);
11
+ /**
12
+ * Returns the Surfside Context state, or throws an error if the context failed to return at all (i.e, you are calling
13
+ * useSurfsideContext outside of SurfsideProvider node)
14
+ *
15
+ * @throws {Error} If the context failed to initialize.
16
+ */
17
+ export const useSurfsideContext = () => {
18
+ const context = useContext(SurfsideContext);
19
+ if (context === undefined) {
20
+ return {
21
+ error: Err(new NotInProviderError),
22
+ status: 'error',
23
+ isReady: false,
24
+ setLocationId: () => void 0,
25
+ setUserId: () => void 0,
26
+ isInitializing: false,
27
+ hasError: true
28
+ };
29
+ }
30
+ return context;
31
+ };
32
+ const searchHasString = (str) => typeof window !== 'undefined' &&
33
+ window.location.search.toLowerCase().includes(str);
34
+ /**
35
+ * The provider for the Surfside ads context.
36
+ *
37
+ * @see {@link ISurfsideProviderProps}
38
+ */
39
+ export const SurfsideProvider = ({ accountId, channelId, siteId, locationId: cfgLocationId, userId: cfgUserId, config, onError, children, logger: userLogger }) => {
40
+ const [api, setApi] = useState();
41
+ const [isInitializing, setIsInitializing] = useState(true);
42
+ const [error, setError] = useState();
43
+ const [locationId, setLocationId] = useState(cfgLocationId);
44
+ const [userId, setUserId] = useState(cfgUserId);
45
+ const debug = config?.debug ?? searchHasString('surf_debug=true');
46
+ const mock = config?.mock ?? searchHasString('surf_mock=true');
47
+ const logger = useMemo(() => Ctx(userLogger ?? (debug ? InitLogger() : undefined)), [userLogger]);
48
+ const log = Ctx(logger)?.with('SurfsideProvider');
49
+ log?.info('Initializing Surfside provider');
50
+ useEffect(() => {
51
+ let cancel = false;
52
+ log?.info('Checking initialization state');
53
+ if (locationId === undefined) {
54
+ setLoadingState();
55
+ return;
56
+ }
57
+ const initializerPromise = !mock
58
+ ? InitSurfAdsWeb(accountId, siteId, channelId, locationId, userId, logger)
59
+ : InitSurfAdsWebInternal(InitSurfAdsCoreMock(accountId, channelId, siteId, locationId, userId, InitLogger()));
60
+ initializerPromise.then(web => {
61
+ if (cancel) {
62
+ return;
63
+ }
64
+ if (!web.ok) {
65
+ setErrorState(web);
66
+ return;
67
+ }
68
+ setSuccessState(web.value);
69
+ });
70
+ return () => {
71
+ cancel = true;
72
+ };
73
+ }, [locationId, accountId, siteId, channelId, userId, logger]);
74
+ const setLoadingState = () => {
75
+ setIsInitializing(true);
76
+ setError(undefined);
77
+ setApi(undefined);
78
+ };
79
+ const setErrorState = (err) => {
80
+ setIsInitializing(false);
81
+ setError(err);
82
+ setApi(undefined);
83
+ };
84
+ const setSuccessState = (api) => {
85
+ setIsInitializing(false);
86
+ setError(undefined);
87
+ setApi(api);
88
+ };
89
+ const contextValue = GetValueOrThrow(TryDo(() => {
90
+ if (isInitializing) { // Loading state
91
+ return {
92
+ isInitializing: true,
93
+ status: 'initializing',
94
+ isReady: false,
95
+ error: undefined,
96
+ hasError: false,
97
+ setLocationId,
98
+ setUserId
99
+ };
100
+ }
101
+ else if (error !== undefined) { // error state
102
+ return {
103
+ isInitializing: false,
104
+ status: 'error',
105
+ error,
106
+ setLocationId,
107
+ setUserId,
108
+ isReady: false,
109
+ hasError: true
110
+ };
111
+ }
112
+ else if (api !== undefined) { // success state
113
+ return {
114
+ ...api,
115
+ isReady: true,
116
+ status: 'ready',
117
+ setLocationId,
118
+ setUserId,
119
+ hasError: false,
120
+ isInitializing: false
121
+ };
122
+ }
123
+ else { // error - indeterminate state. Set error state
124
+ return {
125
+ error: Err(new InvalidStateError),
126
+ isReady: false,
127
+ isInitializing: false,
128
+ status: 'error',
129
+ setLocationId,
130
+ setUserId,
131
+ hasError: true
132
+ };
133
+ }
134
+ }));
135
+ if (contextValue.status === 'error') {
136
+ onError?.(contextValue.error);
137
+ }
138
+ return (_jsx(SurfsideContext.Provider, { value: contextValue, children: children }));
139
+ };
140
+ export class InvalidStateError extends Error {
141
+ constructor() {
142
+ super('Surfside context provider was left in an invalid state. Contact the vendor');
143
+ }
144
+ }
145
+ export class NotInProviderError extends Error {
146
+ constructor() {
147
+ super('useSurfsideContext must be used within a SurfsideProvider block. Did you forget to add the provider to' +
148
+ ' your App.tsx?');
149
+ }
150
+ }
151
+ //# sourceMappingURL=SurfsideContextProvider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SurfsideContextProvider.js","sourceRoot":"src/","sources":["provider/SurfsideContextProvider.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAc,EAGV,aAAa,EACb,UAAU,EACV,QAAQ,EACR,SAAS,EACT,OAAO,GACV,MAAM,OAAO,CAAC;AAEf,OAAO,EAIH,UAAU,EACV,GAAG,EACH,KAAK,EACL,GAAG,EACH,eAAe,GAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAwB,cAAc,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACtG,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AA+D7D,CAAC;AAkDD,CAAC;AAiBD,CAAC;AAUF,MAAM,eAAe,GAAG,aAAa,CACjC,SAAS,CACZ,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAyB,EAAE;IACzD,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAC5C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO;YACH,KAAK,EAAE,GAAG,CAAC,IAAI,kBAAkB,CAAC;YAClC,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC;YAC3B,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC;YACvB,cAAc,EAAE,KAAK;YACrB,QAAQ,EAAE,IAAI;SACjB,CAAC;IACN,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,EAAE,CACpC,OAAO,MAAM,KAAK,WAAW;IAC7B,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAEvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAqC,CAAC,EAC/D,SAAS,EACT,SAAS,EACT,MAAM,EACN,UAAU,EAAE,aAAa,EACzB,MAAM,EAAE,SAAS,EACjB,MAAM,EACN,OAAO,EACP,QAAQ,EACR,MAAM,EAAE,UAAU,EACrB,EAAE,EAAE;IACD,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,QAAQ,EAAmB,CAAC;IAClD,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAa,CAAC;IAChD,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC5D,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAEhD,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,eAAe,CAAC,iBAAiB,CAAC,CAAC;IAClE,MAAM,IAAI,GAAG,MAAM,EAAE,IAAI,IAAI,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAClG,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAClD,GAAG,EAAE,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAE5C,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,GAAG,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAC3C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC3B,eAAe,EAAE,CAAC;YAClB,OAAO;QACX,CAAC;QAED,MAAM,kBAAkB,GAAG,CAAC,IAAI;YAC5B,CAAC,CAAC,cAAc,CACZ,SAAS,EACT,MAAM,EACN,SAAS,EACT,UAAU,EACV,MAAM,EACN,MAAM,CACT;YACD,CAAC,CAAC,sBAAsB,CAAC,mBAAmB,CACxC,SAAS,EACT,SAAS,EACT,MAAM,EACN,UAAU,EACV,MAAM,EACN,UAAU,EAAE,CACf,CAAC,CAAC;QAEP,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC1B,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO;YACX,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACV,aAAa,CAAC,GAAG,CAAC,CAAC;gBACnB,OAAO;YACX,CAAC;YACD,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACR,MAAM,GAAG,IAAI,CAAC;QAClB,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/D,MAAM,eAAe,GAAG,GAAG,EAAE;QACzB,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,MAAM,CAAC,SAAS,CAAC,CAAC;IACtB,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,GAAc,EAAE,EAAE;QACrC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACzB,QAAQ,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,SAAS,CAAC,CAAC;IACtB,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CAAC,GAAoB,EAAE,EAAE;QAC7C,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACzB,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,MAAM,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,GAAyB,EAAE;QAClE,IAAI,cAAc,EAAE,CAAC,CAAC,gBAAgB;YAClC,OAAO;gBACH,cAAc,EAAE,IAAI;gBACpB,MAAM,EAAE,cAAc;gBACtB,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,SAAS;gBAChB,QAAQ,EAAE,KAAK;gBACf,aAAa;gBACb,SAAS;aACZ,CAAC;QACN,CAAC;aAAM,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC,CAAC,cAAc;YAC5C,OAAO;gBACH,cAAc,EAAE,KAAK;gBACrB,MAAM,EAAE,OAAO;gBACf,KAAK;gBACL,aAAa;gBACb,SAAS;gBACT,OAAO,EAAE,KAAK;gBACd,QAAQ,EAAE,IAAI;aACjB,CAAC;QACN,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC,CAAC,gBAAgB;YAC5C,OAAO;gBACH,GAAG,GAAG;gBACN,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,OAAO;gBACf,aAAa;gBACb,SAAS;gBACT,QAAQ,EAAE,KAAK;gBACf,cAAc,EAAE,KAAK;aACxB,CAAC;QACN,CAAC;aAAM,CAAC,CAAC,+CAA+C;YACpD,OAAO;gBACH,KAAK,EAAE,GAAG,CAAC,IAAI,iBAAiB,CAAC;gBACjC,OAAO,EAAE,KAAK;gBACd,cAAc,EAAE,KAAK;gBACrB,MAAM,EAAE,OAAO;gBACf,aAAa;gBACb,SAAS;gBACT,QAAQ,EAAE,IAAI;aACjB,CAAC;QACN,CAAC;IACL,CAAC,CAAC,CAAC,CAAC;IAEJ,IAAI,YAAY,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;QAClC,OAAO,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,CACH,KAAC,eAAe,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,YACxC,QAAQ,GACc,CAC9B,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IACxC;QACI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IACxF,CAAC;CACJ;AAED,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IACzC;QACI,KAAK,CAAC,wGAAwG;YAC1G,gBAAgB,CACnB,CAAC;IACN,CAAC;CACJ"}
@@ -0,0 +1,3 @@
1
+ 'use client';
2
+ export * from './SurfsideContextProvider';
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"src/","sources":["provider/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,cAAc,2BAA2B,CAAC"}
@@ -0,0 +1,171 @@
1
+ /**
2
+ * Track a product click event
3
+ * @param product The product that was clicked
4
+ * @param zoneId The zone ID where the product was displayed
5
+ * @param callback Optional callback for custom tracking
6
+ */
7
+ export const trackProductClick = (product, zoneId, callback) => {
8
+ const analytics = {
9
+ timestamp: Date.now(),
10
+ zoneId,
11
+ productId: product.id,
12
+ locationId: undefined, // Will be filled by the hook
13
+ };
14
+ // Log the click event
15
+ console.debug('[Surfside Analytics] Product click:', {
16
+ productId: product.id,
17
+ zoneId,
18
+ timestamp: analytics.timestamp,
19
+ });
20
+ // Call the callback if provided
21
+ if (callback !== undefined) {
22
+ callback(product, analytics);
23
+ }
24
+ };
25
+ /**
26
+ * Track a banner click event
27
+ * @param banner The banner that was clicked
28
+ * @param zoneId The zone ID where the banner was displayed
29
+ * @param callback Optional callback for custom tracking
30
+ */
31
+ export const trackBannerClick = (banner, zoneId, callback) => {
32
+ const analytics = {
33
+ timestamp: Date.now(),
34
+ zoneId,
35
+ bannerId: banner.id,
36
+ locationId: undefined, // Will be filled by the hook
37
+ };
38
+ // Log the click event
39
+ console.debug('[Surfside Analytics] Banner click:', {
40
+ bannerId: banner.id,
41
+ zoneId,
42
+ timestamp: analytics.timestamp,
43
+ });
44
+ // Call the callback if provided
45
+ if (callback !== undefined) {
46
+ callback(analytics);
47
+ }
48
+ };
49
+ /**
50
+ * Track product impressions
51
+ * @param products The products that were impressed
52
+ * @param zoneId The zone ID where the products were displayed
53
+ * @param callback Optional callback for custom tracking
54
+ */
55
+ export const trackProductImpressions = (products, zoneId, callback) => {
56
+ const analytics = {
57
+ timestamp: Date.now(),
58
+ zoneId,
59
+ productIds: products.map(p => p.id).filter(p => p !== undefined),
60
+ locationId: undefined, // Will be filled by the hook
61
+ };
62
+ // Log the impression event
63
+ console.debug('[Surfside Analytics] Product impressions:', {
64
+ productIds: analytics.productIds,
65
+ zoneId,
66
+ timestamp: analytics.timestamp,
67
+ });
68
+ // Call the callback if provided
69
+ if (callback !== undefined) {
70
+ callback(products, analytics);
71
+ }
72
+ };
73
+ /**
74
+ * Track banner impressions
75
+ * @param banner The banner that was impressed
76
+ * @param zoneId The zone ID where the banner was displayed
77
+ * @param callback Optional callback for custom tracking
78
+ */
79
+ export const trackBannerImpression = (banner, zoneId, callback) => {
80
+ const analytics = {
81
+ timestamp: Date.now(),
82
+ zoneId,
83
+ bannerId: banner.id,
84
+ locationId: undefined, // Will be filled by the hook
85
+ };
86
+ // Log the impression event
87
+ console.debug('[Surfside Analytics] Banner impression:', {
88
+ bannerId: banner.id,
89
+ zoneId,
90
+ timestamp: analytics.timestamp,
91
+ });
92
+ // Call the callback if provided
93
+ if (callback !== undefined) {
94
+ callback(analytics);
95
+ }
96
+ };
97
+ /**
98
+ * Track video impression
99
+ * @param video The video that was impressed
100
+ * @param zoneId The zone ID where the video was displayed
101
+ * @param callback Optional callback for custom tracking
102
+ */
103
+ export const trackVideoImpression = (video, zoneId, callback) => {
104
+ const analytics = {
105
+ timestamp: Date.now(),
106
+ zoneId,
107
+ videoId: video.id,
108
+ locationId: undefined, // Will be filled by the hook
109
+ };
110
+ // Log the impression event
111
+ console.debug('[Surfside Analytics] Video impression:', {
112
+ videoId: video.id,
113
+ zoneId,
114
+ timestamp: analytics.timestamp,
115
+ });
116
+ // Call the callback if provided
117
+ if (callback !== undefined) {
118
+ callback(analytics);
119
+ }
120
+ };
121
+ /**
122
+ * Track video events (play, pause, complete, etc.)
123
+ * @param video The video object
124
+ * @param zoneId The zone ID where the video was displayed
125
+ * @param eventType The type of event (play, pause, complete, etc.)
126
+ * @param position Current position in the video (seconds)
127
+ * @param callback Optional callback for custom tracking
128
+ */
129
+ export const trackVideoEvent = (video, zoneId, eventType, position, callback) => {
130
+ const analytics = {
131
+ timestamp: Date.now(),
132
+ zoneId,
133
+ videoId: video.id,
134
+ eventType,
135
+ position,
136
+ locationId: undefined, // Will be filled by the hook
137
+ };
138
+ // Log the event
139
+ console.debug('[Surfside Analytics] Video event:', {
140
+ videoId: video.id,
141
+ eventType,
142
+ zoneId,
143
+ position,
144
+ timestamp: analytics.timestamp,
145
+ });
146
+ // Call the callback if provided
147
+ if (callback !== undefined) {
148
+ callback(analytics);
149
+ }
150
+ };
151
+ /**
152
+ * Track zone events (ready, no content, error)
153
+ * @param zoneId The zone ID
154
+ * @param eventType The type of event (ready, no-content, error)
155
+ * @param data Additional data for the event
156
+ * @param callback Optional callback for custom tracking
157
+ */
158
+ export const trackZoneEvent = (zoneId, eventType, data, callback) => {
159
+ // Log the zone event
160
+ console.debug('[Surfside Analytics] Zone event:', {
161
+ zoneId,
162
+ eventType,
163
+ data,
164
+ timestamp: Date.now(),
165
+ });
166
+ // Call the callback if provided
167
+ if (callback !== undefined) {
168
+ callback(eventType, zoneId, data);
169
+ }
170
+ };
171
+ //# sourceMappingURL=Analytics.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Analytics.js","sourceRoot":"src/","sources":["utils/Analytics.ts"],"names":[],"mappings":"AAyBA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC7B,OAA4B,EAC5B,MAAc,EACd,QAA6E,EACzE,EAAE;IACN,MAAM,SAAS,GAAoB;QAC/B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,MAAM;QACN,SAAS,EAAE,OAAO,CAAC,EAAE;QACrB,UAAU,EAAE,SAAS,EAAE,6BAA6B;KACvD,CAAC;IAEF,sBAAsB;IACtB,OAAO,CAAC,KAAK,CAAC,qCAAqC,EAAE;QACjD,SAAS,EAAE,OAAO,CAAC,EAAE;QACrB,MAAM;QACN,SAAS,EAAE,SAAS,CAAC,SAAS;KACjC,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACjC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC5B,MAAe,EACf,MAAc,EACd,QAA+C,EAC3C,EAAE;IACN,MAAM,SAAS,GAAoB;QAC/B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,MAAM;QACN,QAAQ,EAAE,MAAM,CAAC,EAAE;QACnB,UAAU,EAAE,SAAS,EAAE,6BAA6B;KACvD,CAAC;IAEF,sBAAsB;IACtB,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE;QAChD,QAAQ,EAAE,MAAM,CAAC,EAAE;QACnB,MAAM;QACN,SAAS,EAAE,SAAS,CAAC,SAAS;KACjC,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxB,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACnC,QAA+B,EAC/B,MAAc,EACd,QAAqF,EACjF,EAAE;IACN,MAAM,SAAS,GAAyB;QACpC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,MAAM;QACN,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAa;QAC5E,UAAU,EAAE,SAAS,EAAE,6BAA6B;KACvD,CAAC;IAEF,2BAA2B;IAC3B,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE;QACvD,UAAU,EAAE,SAAS,CAAC,UAAU;QAChC,MAAM;QACN,SAAS,EAAE,SAAS,CAAC,SAAS;KACjC,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAClC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACjC,MAAe,EACf,MAAc,EACd,QAAoD,EAChD,EAAE;IACN,MAAM,SAAS,GAAyB;QACpC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,MAAM;QACN,QAAQ,EAAE,MAAM,CAAC,EAAE;QACnB,UAAU,EAAE,SAAS,EAAE,6BAA6B;KACvD,CAAC;IAEF,2BAA2B;IAC3B,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE;QACrD,QAAQ,EAAE,MAAM,CAAC,EAAE;QACnB,MAAM;QACN,SAAS,EAAE,SAAS,CAAC,SAAS;KACjC,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxB,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,KAAa,EACb,MAAc,EACd,QAAuD,EACnD,EAAE;IACN,MAAM,SAAS,GAAG;QACd,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,MAAM;QACN,OAAO,EAAE,KAAK,CAAC,EAAE;QACjB,UAAU,EAAE,SAAS,EAAE,6BAA6B;KACvD,CAAC;IAEF,2BAA2B;IAC3B,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE;QACpD,OAAO,EAAE,KAAK,CAAC,EAAE;QACjB,MAAM;QACN,SAAS,EAAE,SAAS,CAAC,SAAS;KACjC,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxB,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC3B,KAAa,EACb,MAAc,EACd,SAAiB,EACjB,QAAgB,EAChB,QAAuD,EACnD,EAAE;IACN,MAAM,SAAS,GAAG;QACd,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,MAAM;QACN,OAAO,EAAE,KAAK,CAAC,EAAE;QACjB,SAAS;QACT,QAAQ;QACR,UAAU,EAAE,SAAS,EAAE,6BAA6B;KACvD,CAAC;IAEF,gBAAgB;IAChB,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE;QAC/C,OAAO,EAAE,KAAK,CAAC,EAAE;QACjB,SAAS;QACT,MAAM;QACN,QAAQ;QACR,SAAS,EAAE,SAAS,CAAC,SAAS;KACjC,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxB,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC1B,MAAc,EACd,SAA2C,EAC3C,IAA8B,EAC9B,QAAsF,EAClF,EAAE;IACN,qBAAqB;IACrB,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE;QAC9C,MAAM;QACN,SAAS;QACT,IAAI;QACJ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;KACxB,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;AACL,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export * from './Analytics';
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"src/","sources":["utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
@@ -1,5 +1,5 @@
1
1
  import React from 'react';
2
- import { type ErrResult } from '@surfside/ads-core-client';
2
+ import { type ErrResult } from '@surfside/ads-core';
3
3
  /**
4
4
  * Props for the `SurfsideBanner` component. This component handles rendering of banner creatives
5
5
  * from Surfside’s ad platform, managing their loading, display, and error states.
@@ -64,4 +64,3 @@ export interface ISurfsideBannerProps {
64
64
  * @returns A responsive ad container that manages display and state transitions
65
65
  */
66
66
  export declare const SurfsideBanner: React.FC<ISurfsideBannerProps>;
67
- export default SurfsideBanner;
@@ -69,4 +69,3 @@ export interface ISurfsideVideoProps {
69
69
  * @returns A responsive ad container that manages display and state transitions
70
70
  */
71
71
  export declare const SurfsideVideo: ({ zoneId, size, minDuration, maxDuration, mimes, enabled, requestBuilder, onError }: ISurfsideVideoProps) => import("react/jsx-runtime").JSX.Element;
72
- export default SurfsideVideo;
@@ -161,7 +161,7 @@ export interface IUseSurfsideBannerReturnError extends IUseSurfsideBannerReturn
161
161
  *
162
162
  * if (error !== undefined) {
163
163
  * if (error instanceof NoBidsError) { // Not a big problem - just don't render anything
164
- * console.log("Bidder returned nothing - not rendering banner");
164
+ // * console.log("Bidder returned nothing - not rendering banner");
165
165
  * return <></>;
166
166
  * } else { // Actual error - Bidder returned an error code
167
167
  * throw error.error; // `error.error` is the actual javascript error type
package/package.json CHANGED
@@ -1,10 +1,17 @@
1
1
  {
2
2
  "name": "@surfside/ads-react",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "React components for Surfside Ads",
5
5
  "main": "./lib/cjs/index.js",
6
6
  "module": "./lib/esm/index.js",
7
7
  "types": "./lib/types/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "import": "./lib/esm/index.js",
11
+ "require": "./lib/cjs/index.js",
12
+ "types": "./lib/types/index.d.ts"
13
+ }
14
+ },
8
15
  "type": "module",
9
16
  "license": "UNLICENSED",
10
17
  "files": [
@@ -12,17 +19,17 @@
12
19
  "README.md"
13
20
  ],
14
21
  "scripts": {
15
- "build": "bun run bun.build.ts",
22
+ "clean": "rm -rf ./lib",
23
+ "build": "tsc -p ./tsconfig.types.json && tsc -p ./tsconfig.esm.json && tsc -p tsconfig.cjs.json",
16
24
  "lint": "npx eslint"
17
25
  },
18
26
  "peerDependencies": {
19
- "react": "^19",
20
- "react-dom": ">=16.8.0",
27
+ "react": ">=17",
21
28
  "typescript": "^5.8.3"
22
29
  },
23
30
  "dependencies": {
24
- "@surfside/ads-core-web": "^0.1.0",
25
- "@surfside/ads-core-mock": "^0.1.0"
31
+ "@surfside/ads-core-web": "^0.1.2",
32
+ "@surfside/ads-core-mock": "^0.1.2"
26
33
  },
27
34
  "devDependencies": {
28
35
  "@types/bun": "latest",
@@ -1,7 +0,0 @@
1
- import { IUseSurfDynamicZoneOptions, UseSurfDynamicZoneReturn } from '../types';
2
- /**
3
- * Hook for working with Surfside dynamic zones
4
- * Provides data and rendering functions for dynamic content zones
5
- */
6
- export declare const useSurfDynamicZone: ({ zoneId, enabled }: IUseSurfDynamicZoneOptions) => UseSurfDynamicZoneReturn;
7
- export default useSurfDynamicZone;
@@ -1,33 +0,0 @@
1
- export interface IResponsiveConfig {
2
- mobile: number;
3
- tablet?: number;
4
- desktop?: number;
5
- }
6
- export interface IDynamicContent {
7
- id: string;
8
- html: string;
9
- [key: string]: unknown;
10
- }
11
- export interface IClickAnalytics {
12
- timestamp: number;
13
- zoneId: string;
14
- productId?: string;
15
- bannerId?: string;
16
- locationId?: string;
17
- [key: string]: unknown;
18
- }
19
- export interface IImpressionAnalytics {
20
- timestamp: number;
21
- zoneId: string;
22
- productIds?: string[];
23
- bannerId?: string;
24
- locationId?: string;
25
- [key: string]: unknown;
26
- }
27
- export interface IBannerSize {
28
- width: number;
29
- height: number;
30
- }
31
- /**
32
- * Interface for video object returned by the API
33
- */
@@ -1,58 +0,0 @@
1
- import { IBanner, IClickAnalytics, IImpressionAnalytics } from '../types';
2
- import { IVideo } from '../hooks/useSurfsideVideo';
3
- import { IProductInformation } from '@surfside/ads-core';
4
- /**
5
- * Utility functions for tracking analytics events
6
- */
7
- /**
8
- * Track a product click event
9
- * @param product The product that was clicked
10
- * @param zoneId The zone ID where the product was displayed
11
- * @param callback Optional callback for custom tracking
12
- */
13
- export declare const trackProductClick: (product: IProductInformation, zoneId: string, callback?: (product: IProductInformation, analytics: IClickAnalytics) => void) => void;
14
- /**
15
- * Track a banner click event
16
- * @param banner The banner that was clicked
17
- * @param zoneId The zone ID where the banner was displayed
18
- * @param callback Optional callback for custom tracking
19
- */
20
- export declare const trackBannerClick: (banner: IBanner, zoneId: string, callback?: (analytics: IClickAnalytics) => void) => void;
21
- /**
22
- * Track product impressions
23
- * @param products The products that were impressed
24
- * @param zoneId The zone ID where the products were displayed
25
- * @param callback Optional callback for custom tracking
26
- */
27
- export declare const trackProductImpressions: (products: IProductInformation[], zoneId: string, callback?: (products: IProductInformation[], analytics: IImpressionAnalytics) => void) => void;
28
- /**
29
- * Track banner impressions
30
- * @param banner The banner that was impressed
31
- * @param zoneId The zone ID where the banner was displayed
32
- * @param callback Optional callback for custom tracking
33
- */
34
- export declare const trackBannerImpression: (banner: IBanner, zoneId: string, callback?: (analytics: IImpressionAnalytics) => void) => void;
35
- /**
36
- * Track video impression
37
- * @param video The video that was impressed
38
- * @param zoneId The zone ID where the video was displayed
39
- * @param callback Optional callback for custom tracking
40
- */
41
- export declare const trackVideoImpression: (video: IVideo, zoneId: string, callback?: (analytics: Record<string, unknown>) => void) => void;
42
- /**
43
- * Track video events (play, pause, complete, etc.)
44
- * @param video The video object
45
- * @param zoneId The zone ID where the video was displayed
46
- * @param eventType The type of event (play, pause, complete, etc.)
47
- * @param position Current position in the video (seconds)
48
- * @param callback Optional callback for custom tracking
49
- */
50
- export declare const trackVideoEvent: (video: IVideo, zoneId: string, eventType: string, position: number, callback?: (analytics: Record<string, unknown>) => void) => void;
51
- /**
52
- * Track zone events (ready, no content, error)
53
- * @param zoneId The zone ID
54
- * @param eventType The type of event (ready, no-content, error)
55
- * @param data Additional data for the event
56
- * @param callback Optional callback for custom tracking
57
- */
58
- export declare const trackZoneEvent: (zoneId: string, eventType: "ready" | "no-content" | "error", data?: Record<string, unknown>, callback?: (eventType: string, zoneId: string, data?: Record<string, unknown>) => void) => void;