@adshift/react-native-plugin 3.0.0 → 3.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/AdShiftReactNativePlugin.podspec +20 -4
- package/CHANGELOG.md +30 -17
- package/README.md +55 -47
- package/android/build.gradle +2 -3
- package/android/consumer-rules.pro +2 -21
- package/android/src/main/AndroidManifest.xml +1 -1
- package/android/src/main/java/com/adshift/reactnativeplugin/ActivityIntents.kt +307 -0
- package/android/src/main/java/com/adshift/reactnativeplugin/AdShiftReactNativePluginModule.kt +83 -157
- package/android/src/test/java/com/adshift/reactnativeplugin/ConsentSnapshotTest.kt +0 -20
- package/android/src/test/java/com/adshift/reactnativeplugin/DeepLinkDeliveryTest.kt +0 -4
- package/android/src/test/java/com/adshift/reactnativeplugin/InitializeOrderingTest.kt +37 -5
- package/android/src/test/java/com/adshift/reactnativeplugin/IntentLinkDedupTest.kt +0 -5
- package/android/src/test/java/com/adshift/reactnativeplugin/LaunchIntentForwardingTest.kt +7 -26
- package/android/src/test/java/com/adshift/reactnativeplugin/LaunchLinkRecordTest.kt +420 -0
- package/android/src/test/java/com/adshift/reactnativeplugin/ModuleTestSupport.kt +93 -34
- package/android/src/test/java/com/adshift/reactnativeplugin/StartVerdictTest.kt +0 -4
- package/ios/AdShiftReactNativePlugin.h +0 -12
- package/ios/AdShiftReactNativePlugin.mm +2 -14
- package/ios/AdShiftReactNativePluginHelper.swift +14 -73
- package/ios/Core/BridgeRules.swift +24 -29
- package/lib/commonjs/Adshift.js +78 -285
- package/lib/commonjs/Adshift.js.map +1 -1
- package/lib/commonjs/NativeAdShiftReactNativePlugin.js +2 -11
- package/lib/commonjs/NativeAdShiftReactNativePlugin.js.map +1 -1
- package/lib/commonjs/index.js.map +1 -1
- package/lib/commonjs/jest/index.js +4 -18
- package/lib/commonjs/jest/index.js.map +1 -1
- package/lib/commonjs/nativeSdkVersions.js +4 -6
- package/lib/commonjs/nativeSdkVersions.js.map +1 -1
- package/lib/commonjs/types/AdshiftAdRevenue.js +0 -24
- package/lib/commonjs/types/AdshiftAdRevenue.js.map +1 -1
- package/lib/commonjs/types/AdshiftConfig.js +3 -24
- package/lib/commonjs/types/AdshiftConfig.js.map +1 -1
- package/lib/commonjs/types/AdshiftConsent.js +9 -45
- package/lib/commonjs/types/AdshiftConsent.js.map +1 -1
- package/lib/commonjs/types/AdshiftConsentSnapshot.js +5 -24
- package/lib/commonjs/types/AdshiftConsentSnapshot.js.map +1 -1
- package/lib/commonjs/types/AdshiftDeepLink.js +3 -30
- package/lib/commonjs/types/AdshiftDeepLink.js.map +1 -1
- package/lib/commonjs/types/AdshiftError.js +7 -27
- package/lib/commonjs/types/AdshiftError.js.map +1 -1
- package/lib/commonjs/types/AdshiftEventParam.js +4 -38
- package/lib/commonjs/types/AdshiftEventParam.js.map +1 -1
- package/lib/commonjs/types/AdshiftEventType.js +1 -39
- package/lib/commonjs/types/AdshiftEventType.js.map +1 -1
- package/lib/commonjs/types/AdshiftThirdPartySharing.js +7 -38
- package/lib/commonjs/types/AdshiftThirdPartySharing.js.map +1 -1
- package/lib/commonjs/version.js +1 -1
- package/lib/module/Adshift.js +78 -285
- package/lib/module/Adshift.js.map +1 -1
- package/lib/module/NativeAdShiftReactNativePlugin.js +2 -12
- package/lib/module/NativeAdShiftReactNativePlugin.js.map +1 -1
- package/lib/module/index.js +1 -46
- package/lib/module/index.js.map +1 -1
- package/lib/module/jest/index.js +4 -18
- package/lib/module/jest/index.js.map +1 -1
- package/lib/module/nativeSdkVersions.js +4 -6
- package/lib/module/nativeSdkVersions.js.map +1 -1
- package/lib/module/types/AdshiftAdRevenue.js +0 -24
- package/lib/module/types/AdshiftAdRevenue.js.map +1 -1
- package/lib/module/types/AdshiftConfig.js +3 -24
- package/lib/module/types/AdshiftConfig.js.map +1 -1
- package/lib/module/types/AdshiftConsent.js +9 -45
- package/lib/module/types/AdshiftConsent.js.map +1 -1
- package/lib/module/types/AdshiftConsentSnapshot.js +5 -24
- package/lib/module/types/AdshiftConsentSnapshot.js.map +1 -1
- package/lib/module/types/AdshiftDeepLink.js +3 -31
- package/lib/module/types/AdshiftDeepLink.js.map +1 -1
- package/lib/module/types/AdshiftError.js +7 -28
- package/lib/module/types/AdshiftError.js.map +1 -1
- package/lib/module/types/AdshiftEventParam.js +4 -38
- package/lib/module/types/AdshiftEventParam.js.map +1 -1
- package/lib/module/types/AdshiftEventType.js +1 -39
- package/lib/module/types/AdshiftEventType.js.map +1 -1
- package/lib/module/types/AdshiftThirdPartySharing.js +7 -38
- package/lib/module/types/AdshiftThirdPartySharing.js.map +1 -1
- package/lib/module/version.js +1 -1
- package/lib/typescript/commonjs/src/Adshift.d.ts +61 -185
- package/lib/typescript/commonjs/src/Adshift.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/NativeAdShiftReactNativePlugin.d.ts +10 -36
- package/lib/typescript/commonjs/src/NativeAdShiftReactNativePlugin.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/index.d.ts +0 -32
- package/lib/typescript/commonjs/src/index.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/jest/index.d.ts +6 -20
- package/lib/typescript/commonjs/src/jest/index.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/nativeSdkVersions.d.ts +4 -6
- package/lib/typescript/commonjs/src/nativeSdkVersions.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftAdRevenue.d.ts +0 -24
- package/lib/typescript/commonjs/src/types/AdshiftAdRevenue.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftConfig.d.ts +10 -37
- package/lib/typescript/commonjs/src/types/AdshiftConfig.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftConsent.d.ts +9 -49
- package/lib/typescript/commonjs/src/types/AdshiftConsent.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftConsentSnapshot.d.ts +10 -28
- package/lib/typescript/commonjs/src/types/AdshiftConsentSnapshot.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftDeepLink.d.ts +6 -34
- package/lib/typescript/commonjs/src/types/AdshiftDeepLink.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftError.d.ts +7 -26
- package/lib/typescript/commonjs/src/types/AdshiftError.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftEventParam.d.ts +3 -19
- package/lib/typescript/commonjs/src/types/AdshiftEventParam.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftEventType.d.ts +1 -23
- package/lib/typescript/commonjs/src/types/AdshiftEventType.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/types/AdshiftThirdPartySharing.d.ts +7 -38
- package/lib/typescript/commonjs/src/types/AdshiftThirdPartySharing.d.ts.map +1 -1
- package/lib/typescript/commonjs/src/version.d.ts +1 -1
- package/lib/typescript/module/src/Adshift.d.ts +61 -185
- package/lib/typescript/module/src/Adshift.d.ts.map +1 -1
- package/lib/typescript/module/src/NativeAdShiftReactNativePlugin.d.ts +10 -36
- package/lib/typescript/module/src/NativeAdShiftReactNativePlugin.d.ts.map +1 -1
- package/lib/typescript/module/src/index.d.ts +0 -32
- package/lib/typescript/module/src/index.d.ts.map +1 -1
- package/lib/typescript/module/src/jest/index.d.ts +6 -20
- package/lib/typescript/module/src/jest/index.d.ts.map +1 -1
- package/lib/typescript/module/src/nativeSdkVersions.d.ts +4 -6
- package/lib/typescript/module/src/nativeSdkVersions.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftAdRevenue.d.ts +0 -24
- package/lib/typescript/module/src/types/AdshiftAdRevenue.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftConfig.d.ts +10 -37
- package/lib/typescript/module/src/types/AdshiftConfig.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftConsent.d.ts +9 -49
- package/lib/typescript/module/src/types/AdshiftConsent.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftConsentSnapshot.d.ts +10 -28
- package/lib/typescript/module/src/types/AdshiftConsentSnapshot.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftDeepLink.d.ts +6 -34
- package/lib/typescript/module/src/types/AdshiftDeepLink.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftError.d.ts +7 -26
- package/lib/typescript/module/src/types/AdshiftError.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftEventParam.d.ts +3 -19
- package/lib/typescript/module/src/types/AdshiftEventParam.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftEventType.d.ts +1 -23
- package/lib/typescript/module/src/types/AdshiftEventType.d.ts.map +1 -1
- package/lib/typescript/module/src/types/AdshiftThirdPartySharing.d.ts +7 -38
- package/lib/typescript/module/src/types/AdshiftThirdPartySharing.d.ts.map +1 -1
- package/lib/typescript/module/src/version.d.ts +1 -1
- package/package.json +11 -1
- package/src/Adshift.ts +82 -286
- package/src/NativeAdShiftReactNativePlugin.ts +10 -48
- package/src/index.tsx +1 -44
- package/src/jest/index.ts +6 -20
- package/src/nativeSdkVersions.ts +4 -6
- package/src/types/AdshiftAdRevenue.ts +0 -24
- package/src/types/AdshiftConfig.ts +11 -54
- package/src/types/AdshiftConsent.ts +9 -49
- package/src/types/AdshiftConsentSnapshot.ts +11 -38
- package/src/types/AdshiftDeepLink.ts +6 -34
- package/src/types/AdshiftError.ts +7 -26
- package/src/types/AdshiftEventParam.ts +4 -38
- package/src/types/AdshiftEventType.ts +1 -39
- package/src/types/AdshiftThirdPartySharing.ts +7 -38
- package/src/version.ts +1 -1
- package/vendor/ios/AdshiftSDK.files.json +30 -0
- package/vendor/ios/AdshiftSDK.xcframework/Info.plist +44 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/AdshiftSDK +0 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/Headers/AdshiftSDK-Swift.h +315 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/Info.plist +0 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios.abi.json +18729 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios.private.swiftinterface +414 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios.swiftdoc +0 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios.swiftinterface +414 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/Modules/module.modulemap +4 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64/AdshiftSDK.framework/PrivacyInfo.xcprivacy +132 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/AdshiftSDK +0 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Headers/AdshiftSDK-Swift.h +626 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Info.plist +0 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios-simulator.abi.json +18729 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +414 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios-simulator.swiftdoc +0 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/arm64-apple-ios-simulator.swiftinterface +414 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/x86_64-apple-ios-simulator.abi.json +18729 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface +414 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/x86_64-apple-ios-simulator.swiftdoc +0 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/AdshiftSDK.swiftmodule/x86_64-apple-ios-simulator.swiftinterface +414 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/Modules/module.modulemap +4 -0
- package/vendor/ios/AdshiftSDK.xcframework/ios-arm64_x86_64-simulator/AdshiftSDK.framework/PrivacyInfo.xcprivacy +132 -0
- package/android/src/main/java/com/adshift/reactnativeplugin/RestoredIntents.kt +0 -64
|
@@ -1,8 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Mediation platform that reported the ad impression.
|
|
3
|
-
*
|
|
4
|
-
* Values are the identifiers used on the wire by the native SDKs.
|
|
5
|
-
*/
|
|
6
1
|
export declare const AdshiftMediationNetwork: {
|
|
7
2
|
readonly AppLovinMAX: "applovin_max";
|
|
8
3
|
readonly GoogleAdMob: "google_admob";
|
|
@@ -19,24 +14,7 @@ export declare const AdshiftMediationNetwork: {
|
|
|
19
14
|
readonly DirectMonetization: "direct_monetization_network";
|
|
20
15
|
readonly Other: "other";
|
|
21
16
|
};
|
|
22
|
-
/**
|
|
23
|
-
* Type of all mediation network values.
|
|
24
|
-
*/
|
|
25
17
|
export type AdshiftMediationNetworkValue = (typeof AdshiftMediationNetwork)[keyof typeof AdshiftMediationNetwork];
|
|
26
|
-
/**
|
|
27
|
-
* Parameters for `Adshift.logAdRevenue()`.
|
|
28
|
-
*
|
|
29
|
-
* @example
|
|
30
|
-
* ```typescript
|
|
31
|
-
* await Adshift.logAdRevenue({
|
|
32
|
-
* monetizationNetwork: 'admob',
|
|
33
|
-
* mediationNetwork: AdshiftMediationNetwork.GoogleAdMob,
|
|
34
|
-
* currency: 'USD',
|
|
35
|
-
* revenue: 0.0125,
|
|
36
|
-
* adUnitId: 'ca-app-pub-1234/5678',
|
|
37
|
-
* });
|
|
38
|
-
* ```
|
|
39
|
-
*/
|
|
40
18
|
export interface AdRevenueParams {
|
|
41
19
|
/** Ad network that served the impression, e.g. `admob`, `meta`. */
|
|
42
20
|
monetizationNetwork: string;
|
|
@@ -46,11 +24,9 @@ export interface AdRevenueParams {
|
|
|
46
24
|
currency: string;
|
|
47
25
|
/** Revenue of the single impression in `currency`. Must be positive. */
|
|
48
26
|
revenue: number;
|
|
49
|
-
/** Ad unit identifier, when available. */
|
|
50
27
|
adUnitId?: string;
|
|
51
28
|
/** Revenue precision reported by the network, e.g. `exact`, `estimated`. */
|
|
52
29
|
precision?: string;
|
|
53
|
-
/** Extra parameters attached to the event. */
|
|
54
30
|
additionalParameters?: Record<string, string | number | boolean>;
|
|
55
31
|
}
|
|
56
32
|
//# sourceMappingURL=AdshiftAdRevenue.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftAdRevenue.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftAdRevenue.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftAdRevenue.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftAdRevenue.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;CAe1B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GACtC,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC;AAEzE,MAAM,WAAW,eAAe;IAC9B,mEAAmE;IACnE,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uDAAuD;IACvD,gBAAgB,EAAE,4BAA4B,CAAC;IAC/C,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CAClE"}
|
|
@@ -7,27 +7,14 @@ export type AdshiftDeferredDeepLinkClipboard = 'disabled' | 'prompt' | 'pasteCon
|
|
|
7
7
|
/** @internal */
|
|
8
8
|
export declare const DEFERRED_DEEP_LINK_CLIPBOARD_MODES: ReadonlySet<string>;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
* Every option other than `apiKey` is optional; omitted options keep the
|
|
13
|
-
* native SDK defaults. All options must be set before `Adshift.start()`.
|
|
14
|
-
*
|
|
15
|
-
* @example
|
|
16
|
-
* ```typescript
|
|
17
|
-
* Adshift.initialize({
|
|
18
|
-
* apiKey: 'your-api-key',
|
|
19
|
-
* isDebug: __DEV__,
|
|
20
|
-
* brandedDomains: ['links.example.com'],
|
|
21
|
-
* });
|
|
22
|
-
* ```
|
|
10
|
+
* Options for `Adshift.initialize()`; an omitted option keeps the native SDK
|
|
11
|
+
* default.
|
|
23
12
|
*/
|
|
24
13
|
export interface AdshiftConfig {
|
|
25
|
-
/**
|
|
26
|
-
* API key from the AdShift dashboard. Required.
|
|
27
|
-
*/
|
|
14
|
+
/** API key from the AdShift dashboard. */
|
|
28
15
|
apiKey: string;
|
|
29
16
|
/**
|
|
30
|
-
*
|
|
17
|
+
* Verbose SDK logging.
|
|
31
18
|
* @default false
|
|
32
19
|
*/
|
|
33
20
|
isDebug?: boolean;
|
|
@@ -60,11 +47,9 @@ export interface AdshiftConfig {
|
|
|
60
47
|
*/
|
|
61
48
|
pushDeepLinkPaths?: string[][];
|
|
62
49
|
/**
|
|
63
|
-
* Forward every URL that opens the app to the SDK
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* iOS: the plugin uses `Linking` (`getInitialURL` and the `url` event).
|
|
67
|
-
* Set to `false` to call `Adshift.handleDeepLink()` yourself.
|
|
50
|
+
* Forward every URL that opens the app to the SDK: on Android from the
|
|
51
|
+
* Activity's Intents, on iOS through React Native `Linking`. Set to `false`
|
|
52
|
+
* to call `Adshift.handleDeepLink()` yourself.
|
|
68
53
|
* @default true
|
|
69
54
|
*/
|
|
70
55
|
autoHandleDeepLinks?: boolean;
|
|
@@ -105,21 +90,9 @@ export interface AdshiftConfig {
|
|
|
105
90
|
*/
|
|
106
91
|
collectOaid?: boolean;
|
|
107
92
|
/**
|
|
108
|
-
* Called when the SDK declines a call
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
* Methods that return nothing cannot answer the caller, and the SDK never
|
|
112
|
-
* raises into your code, so this is how those failures become visible. In
|
|
113
|
-
* development they are also written to the console. Wire it to your own
|
|
114
|
-
* reporting to catch integration mistakes in release builds.
|
|
115
|
-
*
|
|
116
|
-
* @example
|
|
117
|
-
* ```typescript
|
|
118
|
-
* Adshift.initialize({
|
|
119
|
-
* apiKey: 'your-api-key',
|
|
120
|
-
* onError: (error) => Sentry.captureMessage(`AdShift: ${error.code}`),
|
|
121
|
-
* });
|
|
122
|
-
* ```
|
|
93
|
+
* Called when the SDK declines a call: an invalid argument, an unusable
|
|
94
|
+
* config, or an API key the backend rejected. Methods that return nothing
|
|
95
|
+
* report their failures only here (and to the console in development).
|
|
123
96
|
*/
|
|
124
97
|
onError?: (error: AdshiftError) => void;
|
|
125
98
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftConfig.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GACxC,UAAU,GACV,QAAQ,GACR,cAAc,CAAC;AAEnB,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,WAAW,CAAC,MAAM,CAIjE,CAAC;AAEH
|
|
1
|
+
{"version":3,"file":"AdshiftConfig.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GACxC,UAAU,GACV,QAAQ,GACR,cAAc,CAAC;AAEnB,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,WAAW,CAAC,MAAM,CAIjE,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;OAQG;IACH,yBAAyB,CAAC,EAAE,gCAAgC,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;CACzC;AAmBD,wBAAgB,WAAW,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAS1E"}
|
|
@@ -1,75 +1,35 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A single consent decision.
|
|
3
|
-
*
|
|
4
|
-
* `true` = granted, `false` = denied, `null` = not decided yet.
|
|
5
|
-
* Undecided flags are not sent to the backend.
|
|
6
|
-
*/
|
|
1
|
+
/** `true` granted, `false` denied, `null` not decided yet. */
|
|
7
2
|
export type ConsentFlag = boolean | null;
|
|
8
3
|
/**
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* @example
|
|
12
|
-
* ```typescript
|
|
13
|
-
* // GDPR user who accepted everything
|
|
14
|
-
* Adshift.setConsentData(
|
|
15
|
-
* AdshiftConsent.forGDPRUser({
|
|
16
|
-
* hasConsentForDataUsage: true,
|
|
17
|
-
* hasConsentForAdsPersonalization: true,
|
|
18
|
-
* hasConsentForAdStorage: true,
|
|
19
|
-
* })
|
|
20
|
-
* );
|
|
21
|
-
*
|
|
22
|
-
* // Non-GDPR user
|
|
23
|
-
* Adshift.setConsentData(AdshiftConsent.forNonGDPRUser());
|
|
24
|
-
* ```
|
|
4
|
+
* GDPR/DMA consent; build it with `AdshiftConsent.forGDPRUser()` or
|
|
5
|
+
* `forNonGDPRUser()`. The flags are ignored unless `isUserSubjectToGDPR`.
|
|
25
6
|
*/
|
|
26
7
|
export interface AdshiftConsent {
|
|
27
|
-
/** Whether the user is subject to GDPR. */
|
|
28
8
|
isUserSubjectToGDPR: boolean;
|
|
29
|
-
/** Consent to data usage. Ignored when `isUserSubjectToGDPR` is false. */
|
|
30
9
|
hasConsentForDataUsage?: ConsentFlag;
|
|
31
|
-
/** Consent to ads personalization. Ignored when `isUserSubjectToGDPR` is false. */
|
|
32
10
|
hasConsentForAdsPersonalization?: ConsentFlag;
|
|
33
|
-
/** Consent to ad storage. Ignored when `isUserSubjectToGDPR` is false. */
|
|
34
11
|
hasConsentForAdStorage?: ConsentFlag;
|
|
35
12
|
}
|
|
36
|
-
/**
|
|
37
|
-
* Helper functions for creating `AdshiftConsent` objects.
|
|
38
|
-
*/
|
|
13
|
+
/** Builds `AdshiftConsent` values. */
|
|
39
14
|
export declare const AdshiftConsent: {
|
|
40
|
-
/**
|
|
41
|
-
* Creates consent for a user subject to GDPR.
|
|
42
|
-
*
|
|
43
|
-
* Flags that are omitted or `null` are treated as not decided.
|
|
44
|
-
*/
|
|
15
|
+
/** An omitted flag counts as not decided. */
|
|
45
16
|
forGDPRUser(options: {
|
|
46
17
|
hasConsentForDataUsage?: ConsentFlag;
|
|
47
18
|
hasConsentForAdsPersonalization?: ConsentFlag;
|
|
48
19
|
hasConsentForAdStorage?: ConsentFlag;
|
|
49
20
|
}): AdshiftConsent;
|
|
50
|
-
/**
|
|
51
|
-
* Creates consent for a user NOT subject to GDPR.
|
|
52
|
-
*
|
|
53
|
-
* All processing is treated as permitted; individual flags are not sent.
|
|
54
|
-
*/
|
|
21
|
+
/** All processing counts as permitted. */
|
|
55
22
|
forNonGDPRUser(): AdshiftConsent;
|
|
56
23
|
/**
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* both data usage and ad storage.
|
|
24
|
+
* Non-GDPR users are always granted; GDPR users need consent to both data
|
|
25
|
+
* usage and ad storage.
|
|
60
26
|
*/
|
|
61
27
|
isConsentGranted(consent: AdshiftConsent): boolean;
|
|
62
|
-
/**
|
|
63
|
-
* Creates consent from a plain object.
|
|
64
|
-
*
|
|
65
|
-
* @internal
|
|
66
|
-
*/
|
|
28
|
+
/** @internal */
|
|
67
29
|
fromMap(map: Record<string, unknown>): AdshiftConsent;
|
|
68
30
|
};
|
|
69
31
|
/**
|
|
70
|
-
* Converts `AdshiftConsent` to a plain object for the native bridge.
|
|
71
32
|
* Undecided flags are sent as `null`.
|
|
72
|
-
*
|
|
73
33
|
* @internal
|
|
74
34
|
*/
|
|
75
35
|
export declare function consentToMap(consent: AdshiftConsent): Record<string, boolean | null>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftConsent.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftConsent.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftConsent.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftConsent.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,IAAI,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,mBAAmB,EAAE,OAAO,CAAC;IAE7B,sBAAsB,CAAC,EAAE,WAAW,CAAC;IAErC,+BAA+B,CAAC,EAAE,WAAW,CAAC;IAE9C,sBAAsB,CAAC,EAAE,WAAW,CAAC;CACtC;AAED,sCAAsC;AACtC,eAAO,MAAM,cAAc;IACzB,6CAA6C;yBACxB;QACnB,sBAAsB,CAAC,EAAE,WAAW,CAAC;QACrC,+BAA+B,CAAC,EAAE,WAAW,CAAC;QAC9C,sBAAsB,CAAC,EAAE,WAAW,CAAC;KACtC,GAAG,cAAc;IAUlB,0CAA0C;sBACxB,cAAc;IAIhC;;;OAGG;8BACuB,cAAc,GAAG,OAAO;IAQlD,gBAAgB;iBACH,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,cAAc;CActD,CAAC;AAMF;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,cAAc,GACtB,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,CAWhC"}
|
|
@@ -1,15 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
* - `manual`: set through `Adshift.setConsentData()`
|
|
5
|
-
* - `tcf`: read from an IAB TCF v2.2 CMP
|
|
6
|
-
* - `gpp`: read from an IAB GPP string written by the CMP
|
|
7
|
-
* - `none`: no consent information available
|
|
2
|
+
* `manual`: from `Adshift.setConsentData()`; `tcf`: an IAB TCF v2.2 CMP;
|
|
3
|
+
* `gpp`: an IAB GPP string written by the CMP; `none`: no consent information.
|
|
8
4
|
*/
|
|
9
5
|
export type ConsentSource = 'manual' | 'tcf' | 'gpp' | 'none';
|
|
10
|
-
/**
|
|
11
|
-
* Consent state as seen by the SDK, returned by `Adshift.refreshConsent()`.
|
|
12
|
-
*/
|
|
6
|
+
/** Consent as the SDK applies it. */
|
|
13
7
|
export interface ConsentSnapshot {
|
|
14
8
|
source: ConsentSource;
|
|
15
9
|
/** IAB `gdprApplies` value when known (0 or 1). */
|
|
@@ -19,14 +13,9 @@ export interface ConsentSnapshot {
|
|
|
19
13
|
/** Whether a GPP string is present on the device. */
|
|
20
14
|
gppPresent?: boolean;
|
|
21
15
|
/**
|
|
22
|
-
* Whether a CMP has run on this device
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* This is the field that separates the two cases the flags above cannot: a CMP
|
|
26
|
-
* installed but not yet answered looks identical to no CMP at all, and the two
|
|
27
|
-
* are fixed by opposite actions. `false` while you expect a CMP means it never
|
|
28
|
-
* ran or was never wired up; `true` with `source: 'none'` means it ran and the
|
|
29
|
-
* user has not answered yet, which resolves itself once they do.
|
|
16
|
+
* Whether a CMP has run on this device. `false` while you expect one: it
|
|
17
|
+
* never ran or is not wired up. `true` with `source: 'none'`: it ran and the
|
|
18
|
+
* user has not answered yet.
|
|
30
19
|
*/
|
|
31
20
|
cmpDetected: boolean;
|
|
32
21
|
/** Ad user data flag, when decided. */
|
|
@@ -38,19 +27,12 @@ export interface ConsentSnapshot {
|
|
|
38
27
|
/** When the snapshot was applied, in milliseconds since epoch. */
|
|
39
28
|
appliedAtMillis: number;
|
|
40
29
|
/**
|
|
41
|
-
* Whether consent lets the SDK attach the
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* Each platform answers with the rule it applies to the flags above, and
|
|
46
|
-
* those rules differ, so read this instead of comparing the flags yourself.
|
|
30
|
+
* Whether consent lets the SDK attach the advertising id (GAID or OAID on
|
|
31
|
+
* Android, IDFA on iOS); `adshift_device_id` is never affected. The platforms
|
|
32
|
+
* judge the flags by different rules, so read this, not the flags.
|
|
47
33
|
*/
|
|
48
34
|
adIdentifiersAllowed: boolean;
|
|
49
35
|
}
|
|
50
|
-
/**
|
|
51
|
-
* Builds a `ConsentSnapshot` from a native bridge object.
|
|
52
|
-
*
|
|
53
|
-
* @internal
|
|
54
|
-
*/
|
|
36
|
+
/** @internal */
|
|
55
37
|
export declare function consentSnapshotFromMap(map: Record<string, unknown>): ConsentSnapshot;
|
|
56
38
|
//# sourceMappingURL=AdshiftConsentSnapshot.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftConsentSnapshot.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftConsentSnapshot.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftConsentSnapshot.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftConsentSnapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;AAE9D,qCAAqC;AACrC,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,aAAa,CAAC;IACtB,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6DAA6D;IAC7D,eAAe,EAAE,OAAO,CAAC;IACzB,qDAAqD;IACrD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,6CAA6C;IAC7C,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,qCAAqC;IACrC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kEAAkE;IAClE,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,oBAAoB,EAAE,OAAO,CAAC;CAC/B;AASD,gBAAgB;AAChB,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,eAAe,CA4BjB"}
|
|
@@ -1,6 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Status of a deep link result.
|
|
3
|
-
*/
|
|
4
1
|
export declare enum AdshiftDeepLinkStatus {
|
|
5
2
|
/** A RightLink link, or a deferred deep link with a value. Navigate on this. */
|
|
6
3
|
Found = "found",
|
|
@@ -9,9 +6,6 @@ export declare enum AdshiftDeepLinkStatus {
|
|
|
9
6
|
/** Not resolved yet; the same link can still arrive as `found`. */
|
|
10
7
|
Error = "error"
|
|
11
8
|
}
|
|
12
|
-
/**
|
|
13
|
-
* How the link of a result reached the app.
|
|
14
|
-
*/
|
|
15
9
|
export declare enum AdshiftDeepLinkSource {
|
|
16
10
|
/** A Universal Link, or a link the app passed in itself. iOS. */
|
|
17
11
|
UniversalLink = "ul",
|
|
@@ -33,20 +27,9 @@ export declare enum AdshiftDeepLinkSource {
|
|
|
33
27
|
Foreign = "foreign"
|
|
34
28
|
}
|
|
35
29
|
/**
|
|
36
|
-
* Deep link delivered through `Adshift.onDeepLink()`.
|
|
37
|
-
*
|
|
38
30
|
* Navigate only on `status: 'found'`, and validate `deepLinkValue` first:
|
|
39
31
|
* anyone can write a link. Any other URL comes back `notFound` with the URL
|
|
40
32
|
* in `deepLink`. Treat `error` as "not yet".
|
|
41
|
-
*
|
|
42
|
-
* @example
|
|
43
|
-
* ```typescript
|
|
44
|
-
* Adshift.onDeepLink((deepLink) => {
|
|
45
|
-
* if (deepLink.status === AdshiftDeepLinkStatus.Found) {
|
|
46
|
-
* const productId = deepLink.params?.product_id;
|
|
47
|
-
* }
|
|
48
|
-
* });
|
|
49
|
-
* ```
|
|
50
33
|
*/
|
|
51
34
|
export interface AdshiftDeepLink {
|
|
52
35
|
/**
|
|
@@ -54,7 +37,7 @@ export interface AdshiftDeepLink {
|
|
|
54
37
|
* none: route on `deepLinkValue`.
|
|
55
38
|
*/
|
|
56
39
|
deepLink?: string;
|
|
57
|
-
/**
|
|
40
|
+
/** Routing value, `deep_link_value`. */
|
|
58
41
|
deepLinkValue?: string;
|
|
59
42
|
/**
|
|
60
43
|
* Query parameters of a RightLink link, your own keys included. Absent for
|
|
@@ -74,9 +57,8 @@ export interface AdshiftDeepLink {
|
|
|
74
57
|
*/
|
|
75
58
|
clickId?: string;
|
|
76
59
|
/**
|
|
77
|
-
* `false`
|
|
78
|
-
*
|
|
79
|
-
* a reward because of it.
|
|
60
|
+
* `false` when a deferred result is not certain to belong to this user: route
|
|
61
|
+
* them, but do not sign them in or grant a reward because of it.
|
|
80
62
|
* @platform ios
|
|
81
63
|
*/
|
|
82
64
|
matchGuaranteed?: boolean;
|
|
@@ -96,9 +78,7 @@ export interface AdshiftDeepLink {
|
|
|
96
78
|
/** Custom sub-parameter 5 (`deep_link_sub5`). */
|
|
97
79
|
deepLinkSub5?: string;
|
|
98
80
|
}
|
|
99
|
-
/**
|
|
100
|
-
* Helper functions for creating `AdshiftDeepLink` objects.
|
|
101
|
-
*/
|
|
81
|
+
/** Builds `AdshiftDeepLink` values. */
|
|
102
82
|
export declare const AdshiftDeepLink: {
|
|
103
83
|
found(options: {
|
|
104
84
|
deepLink: string;
|
|
@@ -117,17 +97,9 @@ export declare const AdshiftDeepLink: {
|
|
|
117
97
|
}): AdshiftDeepLink;
|
|
118
98
|
notFound(): AdshiftDeepLink;
|
|
119
99
|
error(message: string): AdshiftDeepLink;
|
|
120
|
-
/**
|
|
121
|
-
* Creates a deep link from a native bridge object.
|
|
122
|
-
*
|
|
123
|
-
* @internal
|
|
124
|
-
*/
|
|
100
|
+
/** @internal */
|
|
125
101
|
fromMap(map: Record<string, unknown>): AdshiftDeepLink;
|
|
126
102
|
};
|
|
127
|
-
/**
|
|
128
|
-
* Converts `AdshiftDeepLink` to a plain object.
|
|
129
|
-
*
|
|
130
|
-
* @internal
|
|
131
|
-
*/
|
|
103
|
+
/** @internal */
|
|
132
104
|
export declare function deepLinkToMap(deepLink: AdshiftDeepLink): Record<string, unknown>;
|
|
133
105
|
//# sourceMappingURL=AdshiftDeepLink.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftDeepLink.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftDeepLink.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftDeepLink.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftDeepLink.ts"],"names":[],"mappings":"AAAA,oBAAY,qBAAqB;IAC/B,gFAAgF;IAChF,KAAK,UAAU;IAEf,qEAAqE;IACrE,QAAQ,aAAa;IAErB,mEAAmE;IACnE,KAAK,UAAU;CAChB;AAED,oBAAY,qBAAqB;IAC/B,iEAAiE;IACjE,aAAa,OAAO;IAEpB,gEAAgE;IAChE,OAAO,aAAa;IAEpB,oFAAoF;IACpF,MAAM,WAAW;IAEjB,kDAAkD;IAClD,GAAG,QAAQ;IAEX,2BAA2B;IAC3B,IAAI,SAAS;IAEb,mDAAmD;IACnD,gBAAgB,QAAQ;IAExB,yEAAyE;IACzE,WAAW,iBAAiB;IAE5B,oDAAoD;IACpD,QAAQ,aAAa;IAErB,+CAA+C;IAC/C,OAAO,YAAY;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,wCAAwC;IACxC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC,2EAA2E;IAC3E,UAAU,EAAE,OAAO,CAAC;IAEpB,MAAM,EAAE,qBAAqB,CAAC;IAE9B,4EAA4E;IAC5E,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,oCAAoC;IACpC,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAE/B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAYD,uCAAuC;AACvC,eAAO,MAAM,eAAe;mBACX;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,MAAM,CAAC,EAAE,qBAAqB,CAAC;QAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,eAAe;gBAiCP,eAAe;mBAOZ,MAAM,GAAG,eAAe;IAQvC,gBAAgB;iBACH,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,eAAe;CAuCvD,CAAC;AA2BF,gBAAgB;AAChB,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,eAAe,GACxB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAWzB"}
|
|
@@ -1,7 +1,4 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Platform-neutral error codes used by every rejected promise and by
|
|
3
|
-
* `StartResult.errorCode`.
|
|
4
|
-
*/
|
|
1
|
+
/** Codes of every rejected promise and of `StartResult.errorCode`. */
|
|
5
2
|
export declare enum AdshiftErrorCode {
|
|
6
3
|
/** `Adshift.initialize()` has not been called. */
|
|
7
4
|
NotInitialized = "NOT_INITIALIZED",
|
|
@@ -9,48 +6,32 @@ export declare enum AdshiftErrorCode {
|
|
|
9
6
|
NotStarted = "NOT_STARTED",
|
|
10
7
|
/** The API key was rejected by the AdShift backend. */
|
|
11
8
|
InvalidApiKey = "INVALID_API_KEY",
|
|
12
|
-
/** Tracking is
|
|
9
|
+
/** Tracking is turned off for this device. */
|
|
13
10
|
OptedOut = "OPTED_OUT",
|
|
14
|
-
/**
|
|
11
|
+
/** Too many calls are queued; this one was not accepted. */
|
|
15
12
|
QueueFull = "QUEUE_FULL",
|
|
16
13
|
/** A parameter failed validation. */
|
|
17
14
|
InvalidArgument = "INVALID_ARGUMENT",
|
|
18
15
|
/** Any other failure. See `userInfo.nativeCode` for the platform code. */
|
|
19
16
|
Unknown = "UNKNOWN"
|
|
20
17
|
}
|
|
21
|
-
/**
|
|
22
|
-
* Platform-specific details attached to an `AdshiftError`.
|
|
23
|
-
*/
|
|
24
18
|
export interface AdshiftErrorInfo {
|
|
25
19
|
/** Raw code reported by the native SDK, when available. */
|
|
26
20
|
nativeCode?: number | string;
|
|
27
21
|
/** Error domain on iOS, when available. */
|
|
28
22
|
nativeDomain?: string;
|
|
29
23
|
}
|
|
30
|
-
/**
|
|
31
|
-
* Error thrown or rejected by the AdShift plugin.
|
|
32
|
-
*
|
|
33
|
-
* `code` is always one of `AdshiftErrorCode`; the original native code, when
|
|
34
|
-
* there is one, is available in `userInfo.nativeCode`.
|
|
35
|
-
*/
|
|
24
|
+
/** `code` is always an `AdshiftErrorCode`; a native code is in `userInfo`. */
|
|
36
25
|
export interface AdshiftError extends Error {
|
|
37
26
|
code: AdshiftErrorCode;
|
|
38
27
|
userInfo: AdshiftErrorInfo;
|
|
39
28
|
}
|
|
40
|
-
/**
|
|
41
|
-
* Type guard for errors produced by the plugin.
|
|
42
|
-
*/
|
|
43
29
|
export declare function isAdshiftError(error: unknown): error is AdshiftError;
|
|
44
|
-
/**
|
|
45
|
-
* Builds an `AdshiftError` from a code and message.
|
|
46
|
-
*
|
|
47
|
-
* @internal
|
|
48
|
-
*/
|
|
30
|
+
/** @internal */
|
|
49
31
|
export declare function createAdshiftError(code: AdshiftErrorCode, message: string, userInfo?: AdshiftErrorInfo): AdshiftError;
|
|
50
32
|
/**
|
|
51
|
-
*
|
|
52
|
-
* `
|
|
53
|
-
*
|
|
33
|
+
* Native modules reject with `{ code, message, userInfo }`; a code outside
|
|
34
|
+
* `AdshiftErrorCode` becomes `UNKNOWN`, kept as `nativeCode`.
|
|
54
35
|
* @internal
|
|
55
36
|
*/
|
|
56
37
|
export declare function toAdshiftError(error: unknown): AdshiftError;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftError.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftError.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftError.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftError.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,oBAAY,gBAAgB;IAC1B,kDAAkD;IAClD,cAAc,oBAAoB;IAClC,wDAAwD;IACxD,UAAU,gBAAgB;IAC1B,uDAAuD;IACvD,aAAa,oBAAoB;IACjC,8CAA8C;IAC9C,QAAQ,cAAc;IACtB,4DAA4D;IAC5D,SAAS,eAAe;IACxB,qCAAqC;IACrC,eAAe,qBAAqB;IACpC,0EAA0E;IAC1E,OAAO,YAAY;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,8EAA8E;AAC9E,MAAM,WAAW,YAAa,SAAQ,KAAK;IACzC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAID,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAOpE;AAED,gBAAgB;AAChB,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,MAAM,EACf,QAAQ,GAAE,gBAAqB,GAC9B,YAAY,CAMd;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CA2B3D"}
|
|
@@ -1,20 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Standard
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
* custom parameter, so a misspelled or invented name is stored but never
|
|
6
|
-
* counted — use the constants for anything a report has to add up, revenue
|
|
7
|
-
* above all.
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
* ```typescript
|
|
11
|
-
* await Adshift.trackEvent(AdshiftEventType.Purchase, {
|
|
12
|
-
* [AdshiftEventParam.Revenue]: 9.99,
|
|
13
|
-
* [AdshiftEventParam.Currency]: 'USD',
|
|
14
|
-
* [AdshiftEventParam.ContentId]: 'SKU123',
|
|
15
|
-
* size: 'XL', // custom parameters are fine alongside them
|
|
16
|
-
* });
|
|
17
|
-
* ```
|
|
2
|
+
* Standard names for `trackEvent()` values. Reports add up only these; any
|
|
3
|
+
* other key is kept as a custom parameter and never counted, so use the
|
|
4
|
+
* constants for revenue above all.
|
|
18
5
|
*/
|
|
19
6
|
export declare const AdshiftEventParam: {
|
|
20
7
|
readonly Price: "as_price";
|
|
@@ -104,8 +91,5 @@ export declare const AdshiftEventParam: {
|
|
|
104
91
|
readonly AdRevenuePrecision: "as_adrev_precision";
|
|
105
92
|
};
|
|
106
93
|
export type AdshiftEventParamValue = (typeof AdshiftEventParam)[keyof typeof AdshiftEventParam];
|
|
107
|
-
/**
|
|
108
|
-
* Returns all standard parameter names as an array.
|
|
109
|
-
*/
|
|
110
94
|
export declare function getAllEventParams(): AdshiftEventParamValue[];
|
|
111
95
|
//# sourceMappingURL=AdshiftEventParam.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftEventParam.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftEventParam.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftEventParam.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftEventParam.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;IAG5B,0EAA0E;;IAG1E,0DAA0D;;IAG1D,iCAAiC;;;;IAOjC,2EAA2E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyJnE,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAChC,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE7D,wBAAgB,iBAAiB,IAAI,sBAAsB,EAAE,CAE5D"}
|
|
@@ -1,23 +1,4 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Predefined event types for AdShift SDK.
|
|
3
|
-
*
|
|
4
|
-
* Use these constants for consistent event naming across your app.
|
|
5
|
-
*
|
|
6
|
-
* Pair them with `AdshiftEventParam` for the values.
|
|
7
|
-
*
|
|
8
|
-
* @example
|
|
9
|
-
* ```typescript
|
|
10
|
-
* await Adshift.trackEvent(AdshiftEventType.AddToCart, {
|
|
11
|
-
* [AdshiftEventParam.ContentId]: 'SKU123',
|
|
12
|
-
* [AdshiftEventParam.Price]: 29.99,
|
|
13
|
-
* });
|
|
14
|
-
* ```
|
|
15
|
-
*
|
|
16
|
-
* You can also use custom event names as strings:
|
|
17
|
-
* ```typescript
|
|
18
|
-
* await Adshift.trackEvent('custom_event_name');
|
|
19
|
-
* ```
|
|
20
|
-
*/
|
|
1
|
+
/** Standard event names; any other name is tracked as a custom event. */
|
|
21
2
|
export declare const AdshiftEventType: {
|
|
22
3
|
readonly AddToCart: "as_add_to_cart";
|
|
23
4
|
readonly AddToWishList: "as_add_to_wishlist";
|
|
@@ -57,8 +38,5 @@ export declare const AdshiftEventType: {
|
|
|
57
38
|
readonly CustomerSegment: "as_customer_segment";
|
|
58
39
|
};
|
|
59
40
|
export type AdshiftEventTypeValue = (typeof AdshiftEventType)[keyof typeof AdshiftEventType];
|
|
60
|
-
/**
|
|
61
|
-
* Returns all predefined event types as an array.
|
|
62
|
-
*/
|
|
63
41
|
export declare function getAllEventTypes(): AdshiftEventTypeValue[];
|
|
64
42
|
//# sourceMappingURL=AdshiftEventType.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftEventType.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftEventType.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftEventType.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftEventType.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;IA+B3B,2EAA2E;;;;;;;;;;;IAqB3E,8DAA8D;;IAG9D,6DAA6D;;IAG7D,yEAAyE;;IAGzE,2EAA2E;;IAG3E,2DAA2D;;CAEnD,CAAC;AAEX,MAAM,MAAM,qBAAqB,GAC/B,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAE3D,wBAAgB,gBAAgB,IAAI,qBAAqB,EAAE,CAE1D"}
|
|
@@ -1,53 +1,22 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
* default. Consent under GDPR must be affirmative, so a flag nobody set counts
|
|
6
|
-
* as no consent. Here nothing said means sharing is allowed — which is why this
|
|
7
|
-
* is not a fourth flag on the consent object: folding the two together would
|
|
8
|
-
* make one of them wrong.
|
|
9
|
-
*
|
|
10
|
-
* The three states live in the calls rather than in a nullable field. Never
|
|
11
|
-
* calling `Adshift.setThirdPartySharing()` leaves the question unanswered,
|
|
12
|
-
* `Adshift.clearThirdPartySharing()` returns to unanswered, and the value here
|
|
13
|
-
* is the answer itself.
|
|
14
|
-
*
|
|
15
|
-
* An object rather than a bare `boolean` so a field can be added later without
|
|
16
|
-
* breaking callers.
|
|
17
|
-
*
|
|
18
|
-
* @example
|
|
19
|
-
* ```typescript
|
|
20
|
-
* // The user asked not to have their data passed on
|
|
21
|
-
* Adshift.setThirdPartySharing(AdshiftThirdPartySharing.optedOut());
|
|
22
|
-
*
|
|
23
|
-
* // The user was asked and did not opt out
|
|
24
|
-
* Adshift.setThirdPartySharing(AdshiftThirdPartySharing.allowed());
|
|
25
|
-
* ```
|
|
2
|
+
* The user's answer on passing their data on to advertising partners. Unlike
|
|
3
|
+
* consent, no answer means allowed. Until `Adshift.setThirdPartySharing()` is
|
|
4
|
+
* called, or after `clearThirdPartySharing()`, the question is unanswered.
|
|
26
5
|
*/
|
|
27
6
|
export interface AdshiftThirdPartySharing {
|
|
28
7
|
/** `true` withholds this user's data from advertising partners. */
|
|
29
8
|
optOut: boolean;
|
|
30
9
|
}
|
|
31
|
-
/**
|
|
32
|
-
* Helper functions for creating `AdshiftThirdPartySharing` objects.
|
|
33
|
-
*/
|
|
10
|
+
/** Builds `AdshiftThirdPartySharing` values. */
|
|
34
11
|
export declare const AdshiftThirdPartySharing: {
|
|
35
12
|
/** The user asked not to have their data passed on. */
|
|
36
13
|
optedOut(): AdshiftThirdPartySharing;
|
|
37
14
|
/**
|
|
38
|
-
* The user did not
|
|
39
|
-
*
|
|
40
|
-
* Only worth sending when the app has actually asked. Setting this at startup
|
|
41
|
-
* as a default is the one mistake to avoid here: a CMP answer arriving later
|
|
42
|
-
* cannot be undone for events already sent, and the declaration is recorded
|
|
43
|
-
* as the app's own rather than as the absence of one.
|
|
15
|
+
* The user was asked and did not opt out. Not a default for startup: a later
|
|
16
|
+
* answer cannot correct events already sent.
|
|
44
17
|
*/
|
|
45
18
|
allowed(): AdshiftThirdPartySharing;
|
|
46
19
|
};
|
|
47
|
-
/**
|
|
48
|
-
* Converts `AdshiftThirdPartySharing` to a plain object for the native bridge.
|
|
49
|
-
*
|
|
50
|
-
* @internal
|
|
51
|
-
*/
|
|
20
|
+
/** @internal */
|
|
52
21
|
export declare function thirdPartySharingToMap(sharing: AdshiftThirdPartySharing): Record<string, boolean>;
|
|
53
22
|
//# sourceMappingURL=AdshiftThirdPartySharing.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdshiftThirdPartySharing.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftThirdPartySharing.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"AdshiftThirdPartySharing.d.ts","sourceRoot":"","sources":["../../../../../src/types/AdshiftThirdPartySharing.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,mEAAmE;IACnE,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,gDAAgD;AAChD,eAAO,MAAM,wBAAwB;IACnC,uDAAuD;gBAC3C,wBAAwB;IAIpC;;;OAGG;eACQ,wBAAwB;CAGpC,CAAC;AAEF,gBAAgB;AAChB,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,wBAAwB,GAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzB"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const PLUGIN_VERSION = "3.
|
|
1
|
+
export declare const PLUGIN_VERSION = "3.1.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|