@surfside/ads-react 0.1.5 → 0.1.7
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/lib/cjs/components/SurfsideBanner.js +2 -27
- package/lib/cjs/components/SurfsideBanner.js.map +1 -1
- package/lib/cjs/components/SurfsideBannerRenderer.js +45 -0
- package/lib/cjs/components/SurfsideBannerRenderer.js.map +1 -0
- package/lib/cjs/components/SurfsideBannerVideoRenderer.js +25 -0
- package/lib/cjs/components/SurfsideBannerVideoRenderer.js.map +1 -0
- package/lib/cjs/components/SurfsideVideo.js +1 -1
- package/lib/cjs/components/SurfsideVideoRenderer.js +42 -0
- package/lib/cjs/components/SurfsideVideoRenderer.js.map +1 -0
- package/lib/cjs/components/index.js +20 -20
- package/lib/cjs/components/index.js.map +1 -1
- package/lib/cjs/hooks/index.js +17 -19
- package/lib/cjs/hooks/index.js.map +1 -1
- package/lib/cjs/hooks/useSurfsideProducts.js +14 -5
- package/lib/cjs/hooks/useSurfsideProducts.js.map +1 -1
- package/lib/cjs/index.js +53 -17
- package/lib/cjs/index.js.map +1 -1
- package/lib/cjs/provider/SurfsideContextProvider.js +2 -1
- package/lib/cjs/provider/SurfsideContextProvider.js.map +1 -1
- package/lib/cjs/provider/index.js +6 -16
- package/lib/cjs/provider/index.js.map +1 -1
- package/lib/cjs/utils/index.js +9 -15
- package/lib/cjs/utils/index.js.map +1 -1
- package/lib/esm/components/SurfsideBanner.js +3 -28
- package/lib/esm/components/SurfsideBanner.js.map +1 -1
- package/lib/esm/components/SurfsideBannerRenderer.js +41 -0
- package/lib/esm/components/SurfsideBannerRenderer.js.map +1 -0
- package/lib/esm/components/SurfsideBannerVideoRenderer.js +21 -0
- package/lib/esm/components/SurfsideBannerVideoRenderer.js.map +1 -0
- package/lib/esm/components/SurfsideVideo.js +1 -1
- package/lib/esm/components/SurfsideVideoRenderer.js +38 -0
- package/lib/esm/components/SurfsideVideoRenderer.js.map +1 -0
- package/lib/esm/components/index.js +8 -6
- package/lib/esm/components/index.js.map +1 -1
- package/lib/esm/hooks/index.js +4 -5
- package/lib/esm/hooks/index.js.map +1 -1
- package/lib/esm/hooks/useSurfsideProducts.js +14 -5
- package/lib/esm/hooks/useSurfsideProducts.js.map +1 -1
- package/lib/esm/index.js +18 -3
- package/lib/esm/index.js.map +1 -1
- package/lib/esm/provider/SurfsideContextProvider.js +2 -1
- package/lib/esm/provider/SurfsideContextProvider.js.map +1 -1
- package/lib/esm/provider/index.js +1 -2
- package/lib/esm/provider/index.js.map +1 -1
- package/lib/esm/utils/index.js +1 -1
- package/lib/esm/utils/index.js.map +1 -1
- package/lib/types/components/SurfsideBannerRenderer.d.ts +40 -0
- package/lib/types/components/SurfsideBannerVideoRenderer.d.ts +49 -0
- package/lib/types/components/SurfsideVideoRenderer.d.ts +38 -0
- package/lib/types/components/index.d.ts +8 -5
- package/lib/types/hooks/index.d.ts +4 -4
- package/lib/types/hooks/useSurfsideProducts.d.ts +6 -2
- package/lib/types/index.d.ts +14 -3
- package/lib/types/provider/SurfsideContextProvider.d.ts +19 -0
- package/lib/types/provider/index.d.ts +1 -1
- package/lib/types/utils/index.d.ts +1 -1
- package/package.json +3 -3
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import React, { type ReactNode } from 'react';
|
|
2
2
|
import { type ILogger, type ErrResult } from '@surfside/ads-core';
|
|
3
3
|
import { type ISurfsideWebApi } from '@surfside/ads-core-web';
|
|
4
|
+
import { type IMockSurfsideProduct } from '@surfside/ads-core-mock';
|
|
4
5
|
/**
|
|
5
6
|
* The arguments for initializing the Surfside ads context. user ID is optional because it is not always
|
|
6
7
|
* available at initialization time, but it can be set later via the context's `setIds` function.
|
|
@@ -24,7 +25,25 @@ export interface ISurfsideProviderProps {
|
|
|
24
25
|
config?: {
|
|
25
26
|
/** Whether or not to enable default logging */
|
|
26
27
|
debug?: boolean;
|
|
28
|
+
/** Whether or not to use mock services. Default false */
|
|
27
29
|
mock?: boolean;
|
|
30
|
+
/** The % chance that the mock bidder will return No Bids, from 0-1. If 1, the mock bidder will always
|
|
31
|
+
* return no response. If 0, the mock bidder will always return a successful response. If the number
|
|
32
|
+
* if somewhere in between, that is the % chance that the bidder returns no response.
|
|
33
|
+
*
|
|
34
|
+
* i.e, if simulateNoResponse = 0.25, there is a 25% chance the bidder will return no response.
|
|
35
|
+
*
|
|
36
|
+
* If mock = false, this has no effect. Default 0 */
|
|
37
|
+
simulateNoResponse?: number;
|
|
38
|
+
/** The time, in milliseconds, of network latency to simulate in the mock bidder.
|
|
39
|
+
* If mock = false, this has no effect. If this is undefined, no latency is added.
|
|
40
|
+
* Default undefined
|
|
41
|
+
*/
|
|
42
|
+
simulateTimeout?: number;
|
|
43
|
+
customMockData?: {
|
|
44
|
+
mockSponsoredProducts?: IMockSurfsideProduct[];
|
|
45
|
+
mockRecommendedProducts?: IMockSurfsideProduct[];
|
|
46
|
+
};
|
|
28
47
|
};
|
|
29
48
|
/** A callback for when any surfside services return an error */
|
|
30
49
|
onError?: (error: ErrResult) => void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export
|
|
1
|
+
export { ISurfsideProviderProps, ISurfsideContextValueBase, ISurfsideContextValueInitialized, ISurfsideContextValueUninitialized, ISurfsideContextValueHasError, ISurfsideContextValueNoError, SurfsideContextValue, useSurfsideContext, SurfsideProvider, InvalidStateError, NotInProviderError, } from './SurfsideContextProvider';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export
|
|
1
|
+
export { IImpressionAnalytics, IClickAnalytics, trackProductClick, trackBannerClick, trackProductImpressions, trackBannerImpression, trackVideoImpression, trackVideoEvent, trackZoneEvent, } from './Analytics';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@surfside/ads-react",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.7",
|
|
4
4
|
"description": "React components for Surfside Ads",
|
|
5
5
|
"main": "./lib/cjs/index.js",
|
|
6
6
|
"module": "./lib/esm/index.js",
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"typescript": "^5.8.3"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@surfside/ads-core-web": "^0.1.
|
|
32
|
-
"@surfside/ads-core-mock": "^0.1.
|
|
31
|
+
"@surfside/ads-core-web": "^0.1.7",
|
|
32
|
+
"@surfside/ads-core-mock": "^0.1.7"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@types/bun": "latest",
|