Merge pull request #48 from adjust/v100

YaraMatkova · YaraMatkova · commit 91c5d58e2380 · 2023-11-22T23:02:46.000+01:00
Version 1.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+### Version 1.0.0 (23rd November 2023)
+
+The first release of a new Adjust Smart Banner SDK!
+
+#### Added
+- Three sizes of banner: small, medium and large.
+- Banner custom colors and images support.
+- Automatic detection of browser language and ability to force SDK to show banners in chosen language.
+- Placement conditions support: choose pages where show banners.
+- UTM parameters passing to campaign parameters.
+- Dynamic deeplinks.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Adjust GmbH, https://www.adjust.com
+Copyright (c) 2023 Adjust GmbH, https://www.adjust.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -28,11 +28,11 @@ The sdk is also available through CDN and then accessible through global `Adjust
 To <a id="loading-snippet">load Smart Banner SDK through CDN</a> paste the following snippet into the `<head>` tag:
 ```html
 <script type="application/javascript">
-!function(e,n,t,a,o,s,r,i,c){var d=o+"_q";e[o]=e[o]||{},e[d]=e[d]||[];for(var u=0;u<s.length;u++)r(e[o],e[d],s[u]);i=n.createElement(t),c=n.getElementsByTagName(t)[0],i.async=!0,i.src="https://cdn.adjust.com/adjust-smart-banner-latest.min.js",i.onload=function(){e[o]=e[o].default;for(var n=0;n<e[d].length;n++)e[o][e[d][n][0]]?e[o][e[d][n][0]].apply(e[o],e[d][n][1]):console.error("No such function found in "+o+": "+e[d][n][0]);e[d]=[]},c.parentNode.insertBefore(i,c)}(window,document,"script",0,"AdjustSmartBanner",["init","show","hide","setLanguage","setIosDeepLinkPath","setAndroidDeepLinkPath","setContext","setAndroidAppSchema","setDeepLinkPath"],(function(e,n,t){e[t]=function(){n.push([t,arguments])}}));
+!function(n,t,e,o,a,s,r,i,c){var u=a+"_q";n[a]=n[a]||{},n[u]=n[u]||[];for(var d=0;d<s.length;d++)r(n[a],n[u],s[d]);i=t.createElement(e),c=t.getElementsByTagName(e)[0],i.async=!0,i.src="https://cdn.adjust.com/adjust-smart-banner-latest.min.js",i.onload=function(){n[a]=n[a].default;for(var t=0;t<n[u].length;t++)n[a][n[u][t][0]]?n[a][n[u][t][0]].apply(n[a],n[u][t][1]):console.error("No such function found in "+a+": "+n[u][t][0]);n[u]=[]},c.parentNode.insertBefore(i,c)}(window,document,"script",0,"AdjustSmartBanner",["init","show","hide","setLanguage","setIosDeepLinkPath","setAndroidDeepLinkPath","setContext"],(function(n,t,e){n[e]=function(){t.push([e,arguments])}}));
 </script>
 ```
 
-When loading the sdk through CDN we suggest using minified version. You can target specific version like `https://cdn.adjust.com/adjust-smart-banner-0.0.7.min.js`, or you can target latest version `https://cdn.adjust.com/adjust-smart-banner-latest.min.js` if you want automatic updates without need to change the target file. The sdk files are cached so they are served as fast as possible, and the cache is refreshed every half an hour. If you want updates immediately make sure to target specific version.
+When loading the sdk through CDN we suggest using minified version. You can target specific version like `https://cdn.adjust.com/adjust-smart-banner-1.0.0.min.js`, or you can target latest version `https://cdn.adjust.com/adjust-smart-banner-latest.min.js` if you want automatic updates without need to change the target file. The sdk files are cached so they are served as fast as possible, and the cache is refreshed every half an hour. If you want updates immediately make sure to target specific version.
 
 
 ## <a id="initialization">Initialization</a>
@@ -100,16 +100,6 @@ AdjustSmartBanner.init({
 
 These parameters allow you to specify where your user lands in your app when they click on banner. For further information see [Deeplinks](#deeplinks).
 
-##### <a id="init-schema">**androidAppSchema**</a> `string`
-
-> [!WARNING]
-> Parameter `androidAppSchema` is deprecated, please don't use it anymore.
-
-##### <a id="init-deeplinkpath">**deepLinkPath**</a> `string`
-
-> [!WARNING]
-> Parameter `deepLinkPath` is deprecated, please use [`androidDeepLinkPath`](#init-androiddeeplinkpath) and [`iosDeepLinkPath`](#init-iosdeeplinkpath) respectivetely the platform where you want deeplink path to be changed.
-
 ##### <a id="init-androiddeeplinkpath">**androidDeepLinkPath**</a> `string`
 
 Overrides Android deeplink path, which allows you to change user destination in your mobile app when they click on banner.
@@ -349,16 +339,6 @@ AdjustSmartBanner.setContext({ product_id: "999888" });
 
 There are several functions to set custom deeplink path or deeplink path template and its context.
 
-#### <a id="deeplinks-setters-schema">**setAndroidAppScheme**</a>
-
-> [!WARNING]
-> Method `setAndroidAppSchema` is deprecated, please don't use it anymore.
-
-#### <a id="deeplinks-setters-deeplinkpath">**setDeepLinkPath**</a>
-
-> [!WARNING]
-> Method `setDeepLinkPath` is deprecated and will be removed, please use [`setAndroidDeepLinkPath`](#init-androiddeeplinkpath) and [`setIosDeepLinkPath`](#init-iosdeeplinkpath) respectivetely the platform where you want deeplink path to be changed.
-
 #### <a id="deeplinks-setters-androidDeeplinkpath">**setAndroidDeepLinkPath**</a>
 
 Accepts a string representing deep link path or deeplint path template.
diff --git a/demo/package.json b/demo/package.json
@@ -10,7 +10,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "@adjustcom/smart-banner-sdk": "^0.0.7",
+    "@adjustcom/smart-banner-sdk": "^1.0.0",
     "lorem-ipsum": "^2.0.8"
   },
   "author": "Adjust GmbH",
diff --git a/loading-snippet.js b/loading-snippet.js
@@ -40,11 +40,7 @@
     'setLanguage',
     'setIosDeepLinkPath',
     'setAndroidDeepLinkPath',
-    'setContext',
-
-    /* deprecated functions */
-    'setAndroidAppSchema',
-    'setDeepLinkPath'
+    'setContext'
   ],
   function (context, queue, methodName) {
     context[methodName] = function () {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@adjustcom/smart-banner-sdk-project",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Adjust Smart Banner SDK",
   "scripts": {
     "build": "npm run build --workspace=layout && npm run build --workspace=sdk && npm run build:snippet && npm run copy",
diff --git a/sdk/package.json b/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@adjustcom/smart-banner-sdk",
-  "version": "0.0.7",
+  "version": "1.0.0",
   "description": "Adjust Smart Banner SDK",
   "scripts": {
     "build:sdk": "webpack --config ./webpack.config.js",
diff --git a/sdk/src/data/types.ts b/sdk/src/data/types.ts
@@ -62,7 +62,7 @@ export interface SmartBannerResponseData {
 }
 
 export interface PlacementCondition {
-  operator: "or" | "and";
+  operator: 'or' | 'and';
   rules: Array<PlacementCondition | string>;
 }
 
diff --git a/sdk/src/domain/banners-filter/display-rules.ts b/sdk/src/domain/banners-filter/display-rules.ts
@@ -12,7 +12,7 @@ export class DisplayRules implements BannerFilter {
   constructor(private url: string) { }
 
   private and(rules: Array<PlacementCondition | string>): boolean {
-    for (let rule of rules) {
+    for (const rule of rules) {
       if (typeof rule === 'string') {
         if (!new RegExp(rule, 'i').test(this.url)) {
           return false;  // if at least one rule form rules array doesn't match then the entire condition doesn't match
@@ -28,7 +28,7 @@ export class DisplayRules implements BannerFilter {
   }
 
   private or(rules: Array<PlacementCondition | string>): boolean {
-    for (let rule of rules) {
+    for (const rule of rules) {
       if (typeof rule === 'string') {
         if (new RegExp(rule, 'i').test(this.url)) {
           return true; // if at least one rule form rules array does match then the entire condition does match
@@ -50,7 +50,7 @@ export class DisplayRules implements BannerFilter {
       return this.and(condition.rules);
     }
 
-    Logger.warn('Unknown operator ' + condition.operator + ', try to update the SDK.')
+    Logger.warn('Unknown operator ' + condition.operator + ', try to update the SDK.');
     return false;
   }
 
@@ -81,7 +81,7 @@ export class DisplayRules implements BannerFilter {
       } else if (match === MatchType.default) {
         defaultBanners.push(it);
       }
-    })
+    });
 
     if (matchingNonDefault.length > 0) {
       return matchingNonDefault;
diff --git a/sdk/src/domain/banners-filter/types.ts b/sdk/src/domain/banners-filter/types.ts
@@ -1,4 +1,4 @@
-import { SmartBannerData } from "../../data/types";
+import { SmartBannerData } from '../../data/types';
 
 export interface BannerFilter {
   filter(data: SmartBannerData[]): SmartBannerData[] | null;
diff --git a/sdk/src/domain/smart-banner.ts b/sdk/src/domain/smart-banner.ts
@@ -29,21 +29,8 @@ export class SmartBanner {
   private url: string = window.location.href;
 
   constructor(appToken: string, options: SmartBannerOptions, private deviceOs: DeviceOS) {
-
-    // TODO: remove in a next version
-    if (Object.prototype.hasOwnProperty.call(options, 'androidAppSchema')) {
-      Logger.warn('Property `androidAppSchema` is deprecated and will not be applied');
-    }
-
-    let deprecatedDeepLinkPath: string | undefined = undefined;
-    if (Object.prototype.hasOwnProperty.call(options, 'deepLinkPath')) {
-      Logger.warn('Property `deepLinkPath` is deprecated, please use `iosDeepLinkPath` and `androidDeepLinkPath` instead');
-
-      deprecatedDeepLinkPath = (options as any)['deepLinkPath']; // eslint-disable-line  @typescript-eslint/no-explicit-any
-    }
-
-    const { language, bannerParent, onCreated, onDismissed } = options;
-    let { iosDeepLinkPath, androidDeepLinkPath, context } = options;
+    const { language, bannerParent, iosDeepLinkPath, androidDeepLinkPath, onCreated, onDismissed } = options;
+    let { context } = options;
 
     this.dismissHandler = new DismissHandler();
 
@@ -72,17 +59,6 @@ export class SmartBanner {
 
     context = context || {};
 
-    // TODO: remove in a next version
-    if (deprecatedDeepLinkPath) {
-      if (androidDeepLinkPath === undefined) {
-        androidDeepLinkPath = deprecatedDeepLinkPath;
-      }
-
-      if (iosDeepLinkPath === undefined) {
-        iosDeepLinkPath = deprecatedDeepLinkPath;
-      }
-    }
-
     this.customDeeplinkData = { androidDeepLinkPath, iosDeepLinkPath, context };
 
     this.init();
diff --git a/sdk/src/main.ts b/sdk/src/main.ts
@@ -107,20 +107,6 @@ export default class AdjustSmartBanner {
     }
   }
 
-  static setAndroidAppSchema(_appScheme: string): void {
-    // TODO: remove this function in a next version
-    Logger.warn('Method `setAndroidAppSchema` is deprecated and will not be applied');
-  }
-
-  static setDeepLinkPath(path: string): void {
-    // TODO: remove this function in a next version
-    Logger.warn('Method `setDeepLinkPath` is deprecated, please use `setIosDeepLinkPath` and ' +
-      '`setAndroidDeepLinkPath` setters instead');
-
-    this.setAndroidDeepLinkPath(path);
-    this.setIosDeepLinkPath(path);
-  }
-
   static setContext(context?: Record<string, string>): void {
     // TODO: type check
     if (this.smartBanner) {
diff --git a/test/domain/banners-filter/banner-selector.spec.ts b/test/domain/banners-filter/banner-selector.spec.ts
@@ -14,13 +14,13 @@ describe('BannersSelector tests', () => {
     const displayRules = url === null ? null : {
       operator: 'or',
       rules: [url]
-    } as PlacementCondition
+    } as PlacementCondition;
 
     return {
       id,
       dismissal_period: dismissalPeriod,
       display_rules: displayRules
-    } as SmartBannerData
+    } as SmartBannerData;
   };
 
   //#region Set of test 'banners'
diff --git a/test/domain/banners-filter/display-rules.spec.ts b/test/domain/banners-filter/display-rules.spec.ts
diff --git a/test/domain/smart-banner.spec.ts b/test/domain/smart-banner.spec.ts
diff --git a/test/main.spec.ts b/test/main.spec.ts
diff --git a/test/utils/logger.spec.ts b/test/utils/logger.spec.ts
diff --git a/test/utils/random.spec.ts b/test/utils/random.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@adjustcom/smart-banner-sdk-project",`
`3`		`- "version": "0.0.1",`
	`3`	`+ "version": "1.0.0",`
`4`	`4`	`"description": "Adjust Smart Banner SDK",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"build": "npm run build --workspace=layout && npm run build --workspace=sdk && npm run build:snippet && npm run copy",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@adjustcom/smart-banner-sdk",`
`3`		`- "version": "0.0.7",`
	`3`	`+ "version": "1.0.0",`
`4`	`4`	`"description": "Adjust Smart Banner SDK",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"build:sdk": "webpack --config ./webpack.config.js",`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ export interface SmartBannerResponseData {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`export interface PlacementCondition {`
`65`		`- operator: "or" \| "and";`
	`65`	`+ operator: 'or' \| 'and';`
`66`	`66`	`rules: Array<PlacementCondition \| string>;`
`67`	`67`	`}`
`68`	`68`