@kameleoon/javascript-sdk-core 4.4.8 → 5.0.1

package/dist/visitorCodeManager/visitorCodeManager.d.ts

@@ -1,4 +1,6 @@
+import { Result } from 'ts-res';
 import { SetDataCallbackParametersType } from '../types';
+import { KameleoonError } from '../kameleoonError';
 import { IVisitorCodeManager } from './types';
 /**
  * VisitorCodeManager - a class which manages visitor codes using cookies, offering functions to generate, retrieve,
@@ -13,5 +15,7 @@ export declare class VisitorCodeManager implements IVisitorCodeManager {
     set getData(callback: () => string);
     set setData(callback: (params: SetDataCallbackParametersType) => void);
     get setData(): (params: SetDataCallbackParametersType) => void;
+    validateVisitorCode(visitorCode: string): Result<void, KameleoonError>;
     getVisitorCode(defaultVisitorCode?: string): string;
+    private generateVisitorCode;
 }

package/dist/visitorCodeManager/visitorCodeManager.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.VisitorCodeManager=void 0;var _constants=require("../constants"),_storage=require("../storage"),_utilities=require("../utilities"),_constants2=require("./constants");function _defineProperty(a,b,c){return b=_toPropertyKey(b),b in a?Object.defineProperty(a,b,{value:c,enumerable:!0,configurable:!0,writable:!0}):a[b]=c,a}function _toPropertyKey(a){var b=_toPrimitive(a,"string");return"symbol"==typeof b?b:b+""}function _toPrimitive(a,b){if("object"!=typeof a||!a)return a;var c=a[Symbol.toPrimitive];if(void 0!==c){var d=c.call(a,b||"default");if("object"!=typeof d)return d;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===b?String:Number)(a)}class VisitorCodeManager{constructor(){_defineProperty(this,"isConsentRequired",!1),_defineProperty(this,"setDataCallback",void 0),_defineProperty(this,"getDataCallback",void 0)}set consentRequired(a){this.isConsentRequired=a}get consentRequired(){return this.isConsentRequired}set getData(a){this.getDataCallback=a}set setData(a){this.setDataCallback=a}get setData(){if(this.setDataCallback)return this.setDataCallback;throw new Error("Missing setDataCallback!")}getVisitorCode(a){if(!this.getDataCallback||!this.setDataCallback)throw new Error("Missing getDataCallback or setDataCallback methods in getVisitorCode!");let b;const c=this.getDataCallback(_storage.KameleoonStorageKey.VisitorCode);return c&&(b=c),b||(a?(_utilities.Utilities.validateVisitorCode(a).throw(),b=a):b=_utilities.Utilities.generateRandomString(_constants.VISITOR_CODE_LENGTH)),this.isConsentRequired||this.setDataCallback({visitorCode:b,key:_storage.KameleoonStorageKey.VisitorCode,maxAge:_constants2.DEFAULT_MAX_AGE,path:_constants2.PATH}),b}}exports.VisitorCodeManager=VisitorCodeManager;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.VisitorCodeManager=void 0;var _tsRes=require("ts-res"),_storage=require("../storage"),_kameleoonError=require("../kameleoonError"),_constants=require("./constants");function _defineProperty(a,b,c){return(b=_toPropertyKey(b))in a?Object.defineProperty(a,b,{value:c,enumerable:!0,configurable:!0,writable:!0}):a[b]=c,a}function _toPropertyKey(a){var b=_toPrimitive(a,"string");return"symbol"==typeof b?b:b+""}function _toPrimitive(a,b){if("object"!=typeof a||!a)return a;var c=a[Symbol.toPrimitive];if(void 0!==c){var d=c.call(a,b||"default");if("object"!=typeof d)return d;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===b?String:Number)(a)}class VisitorCodeManager{constructor(){_defineProperty(this,"isConsentRequired",!1),_defineProperty(this,"setDataCallback",void 0),_defineProperty(this,"getDataCallback",void 0)}set consentRequired(a){this.isConsentRequired=a}get consentRequired(){return this.isConsentRequired}set getData(a){this.getDataCallback=a}set setData(a){this.setDataCallback=a}get setData(){if(this.setDataCallback)return this.setDataCallback;throw new Error("Missing setDataCallback!")}validateVisitorCode(a){return 0===a.length?(0,_tsRes.Err)(new _kameleoonError.KameleoonError(_kameleoonError.KameleoonException.VisitorCodeEmpty)):a.length>_constants.VISITOR_CODE_MAX_LENGTH?(0,_tsRes.Err)(new _kameleoonError.KameleoonError(_kameleoonError.KameleoonException.VisitorCodeMaxLength)):(0,_tsRes.Ok)()}getVisitorCode(a){if(!this.getDataCallback||!this.setDataCallback)throw new Error("Missing getDataCallback or setDataCallback methods in getVisitorCode!");let b;const c=this.getDataCallback(_storage.KameleoonStorageKey.VisitorCode);return c&&(b=c),b||(a?(this.validateVisitorCode(a).throw(),b=a):b=this.generateVisitorCode()),this.isConsentRequired||this.setDataCallback({visitorCode:b,key:_storage.KameleoonStorageKey.VisitorCode,maxAge:_constants.DEFAULT_MAX_AGE,path:_constants.PATH}),b}generateVisitorCode(){const a="abcdefghijklmnopqrstuvwxyz0123456789",b=[];for(let c=0;c<_constants.VISITOR_CODE_LENGTH;c++)b.push(a[Math.floor(Math.random()*a.length)]);return b.join("")}}exports.VisitorCodeManager=VisitorCodeManager;
 //# sourceMappingURL=visitorCodeManager.js.map

package/dist/visitorCodeManager/visitorCodeManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"visitorCodeManager.js","names":["VisitorCodeManager","constructor","_defineProperty","consentRequired","isRequired","isConsentRequired","getData","callback","getDataCallback","setData","setDataCallback","Error","getVisitorCode","defaultVisitorCode","visitorCode","existingVisitorCode","KameleoonStorageKey","VisitorCode","Utilities","validateVisitorCode","throw","generateRandomString","VISITOR_CODE_LENGTH","key","maxAge","DEFAULT_MAX_AGE","path","PATH","exports"],"sources":["../../src/visitorCodeManager/visitorCodeManager.ts"],"sourcesContent":["import { VISITOR_CODE_LENGTH } from 'src/constants';\nimport { KameleoonStorageKey } from 'src/storage';\nimport { Utilities } from 'src/utilities';\nimport { SetDataCallbackParametersType } from 'src/types';\nimport { IVisitorCodeManager } from './types';\nimport { DEFAULT_MAX_AGE, PATH } from './constants';\n\n/**\n * VisitorCodeManager - a class which manages visitor codes using cookies, offering functions to generate, retrieve,\n * and handle these codes while considering user consent.\n **/\nexport class VisitorCodeManager implements IVisitorCodeManager {\n  private isConsentRequired: boolean = false;\n  private setDataCallback?: (params: SetDataCallbackParametersType) => void;\n  private getDataCallback?: (key: string) => string | null;\n\n  set consentRequired(isRequired: boolean) {\n    this.isConsentRequired = isRequired;\n  }\n\n  get consentRequired(): boolean {\n    return this.isConsentRequired;\n  }\n\n  set getData(callback: () => string) {\n    this.getDataCallback = callback;\n  }\n\n  set setData(callback: (params: SetDataCallbackParametersType) => void) {\n    this.setDataCallback = callback;\n  }\n\n  get setData(): (params: SetDataCallbackParametersType) => void {\n    if (this.setDataCallback) {\n      return this.setDataCallback;\n    }\n\n    throw new Error('Missing setDataCallback!');\n  }\n\n  public getVisitorCode(defaultVisitorCode?: string): string {\n    if (!this.getDataCallback || !this.setDataCallback) {\n      throw new Error(\n        'Missing getDataCallback or setDataCallback methods in getVisitorCode!',\n      );\n    }\n\n    let visitorCode;\n\n    const existingVisitorCode = this.getDataCallback(\n      KameleoonStorageKey.VisitorCode,\n    );\n\n    if (existingVisitorCode) {\n      visitorCode = existingVisitorCode;\n    }\n\n    if (!visitorCode) {\n      if (defaultVisitorCode) {\n        Utilities.validateVisitorCode(defaultVisitorCode).throw();\n        visitorCode = defaultVisitorCode;\n      } else {\n        visitorCode = Utilities.generateRandomString(VISITOR_CODE_LENGTH);\n      }\n    }\n\n    if (!this.isConsentRequired) {\n      this.setDataCallback({\n        visitorCode,\n        key: KameleoonStorageKey.VisitorCode,\n        maxAge: DEFAULT_MAX_AGE,\n        path: PATH,\n      });\n    }\n\n    return visitorCode;\n  }\n}\n"],"mappings":"qvBAWO,KAAM,CAAAA,kBAAkD,CAAAC,YAAA,EAAAC,eAAA,8BAAAA,eAAA,gCAAAA,eAAA,gCAK7D,GAAI,CAAAC,eAAeA,CAACC,CAAmB,CAAE,CACvC,IAAI,CAACC,iBAAiB,CAAGD,CAC3B,CAEA,GAAI,CAAAD,eAAeA,CAAA,CAAY,CAC7B,MAAO,KAAI,CAACE,iBACd,CAEA,GAAI,CAAAC,OAAOA,CAACC,CAAsB,CAAE,CAClC,IAAI,CAACC,eAAe,CAAGD,CACzB,CAEA,GAAI,CAAAE,OAAOA,CAACF,CAAyD,CAAE,CACrE,IAAI,CAACG,eAAe,CAAGH,CACzB,CAEA,GAAI,CAAAE,OAAOA,CAAA,CAAoD,CAC7D,GAAI,IAAI,CAACC,eAAe,CACtB,MAAO,KAAI,CAACA,eAAe,CAG7B,KAAM,IAAI,CAAAC,KAAK,CAAC,0BAA0B,CAC5C,CAEOC,cAAcA,CAACC,CAA2B,CAAU,CACzD,GAAI,CAAC,IAAI,CAACL,eAAe,EAAI,CAAC,IAAI,CAACE,eAAe,CAChD,KAAM,IAAI,CAAAC,KAAK,CACb,uEACF,CAAC,CAGH,GAAI,CAAAG,CAAW,CAEf,KAAM,CAAAC,CAAmB,CAAG,IAAI,CAACP,eAAe,CAC9CQ,4BAAmB,CAACC,WACtB,CAAC,CAwBD,MAtBI,CAAAF,CAAmB,GACrBD,CAAW,CAAGC,CAAmB,EAG9BD,CAAW,GACVD,CAAkB,EACpBK,oBAAS,CAACC,mBAAmB,CAACN,CAAkB,CAAC,CAACO,KAAK,CAAC,CAAC,CACzDN,CAAW,CAAGD,CAAkB,EAEhCC,CAAW,CAAGI,oBAAS,CAACG,oBAAoB,CAACC,8BAAmB,CAAC,EAIhE,IAAI,CAACjB,iBAAiB,EACzB,IAAI,CAACK,eAAe,CAAC,CACnBI,WAAW,CAAXA,CAAW,CACXS,GAAG,CAAEP,4BAAmB,CAACC,WAAW,CACpCO,MAAM,CAAEC,2BAAe,CACvBC,IAAI,CAAEC,gBACR,CAAC,CAAC,CAGGb,CACT,CACF,CAACc,OAAA,CAAA5B,kBAAA,CAAAA,kBAAA"}
+{"version":3,"file":"visitorCodeManager.js","names":["VisitorCodeManager","constructor","_defineProperty","consentRequired","isRequired","isConsentRequired","getData","callback","getDataCallback","setData","setDataCallback","Error","validateVisitorCode","visitorCode","length","Err","KameleoonError","KameleoonException","VisitorCodeEmpty","VISITOR_CODE_MAX_LENGTH","VisitorCodeMaxLength","Ok","getVisitorCode","defaultVisitorCode","existingVisitorCode","KameleoonStorageKey","VisitorCode","throw","generateVisitorCode","key","maxAge","DEFAULT_MAX_AGE","path","PATH","characters","randomCharacterArray","i","VISITOR_CODE_LENGTH","push","Math","floor","random","join","exports"],"sources":["../../src/visitorCodeManager/visitorCodeManager.ts"],"sourcesContent":["import { Err, Ok, Result } from 'ts-res';\nimport { KameleoonStorageKey } from 'src/storage';\nimport { SetDataCallbackParametersType } from 'src/types';\nimport { KameleoonError, KameleoonException } from 'src/kameleoonError';\nimport { IVisitorCodeManager } from './types';\nimport {\n  DEFAULT_MAX_AGE,\n  PATH,\n  VISITOR_CODE_LENGTH,\n  VISITOR_CODE_MAX_LENGTH,\n} from './constants';\n\n/**\n * VisitorCodeManager - a class which manages visitor codes using cookies, offering functions to generate, retrieve,\n * and handle these codes while considering user consent.\n **/\nexport class VisitorCodeManager implements IVisitorCodeManager {\n  private isConsentRequired: boolean = false;\n  private setDataCallback?: (params: SetDataCallbackParametersType) => void;\n  private getDataCallback?: (key: string) => string | null;\n\n  set consentRequired(isRequired: boolean) {\n    this.isConsentRequired = isRequired;\n  }\n\n  get consentRequired(): boolean {\n    return this.isConsentRequired;\n  }\n\n  set getData(callback: () => string) {\n    this.getDataCallback = callback;\n  }\n\n  set setData(callback: (params: SetDataCallbackParametersType) => void) {\n    this.setDataCallback = callback;\n  }\n\n  get setData(): (params: SetDataCallbackParametersType) => void {\n    if (this.setDataCallback) {\n      return this.setDataCallback;\n    }\n\n    throw new Error('Missing setDataCallback!');\n  }\n\n  public validateVisitorCode(\n    visitorCode: string,\n  ): Result<void, KameleoonError> {\n    if (visitorCode.length === 0) {\n      return Err(new KameleoonError(KameleoonException.VisitorCodeEmpty));\n    }\n\n    if (visitorCode.length > VISITOR_CODE_MAX_LENGTH) {\n      return Err(new KameleoonError(KameleoonException.VisitorCodeMaxLength));\n    }\n\n    return Ok();\n  }\n\n  public getVisitorCode(defaultVisitorCode?: string): string {\n    if (!this.getDataCallback || !this.setDataCallback) {\n      throw new Error(\n        'Missing getDataCallback or setDataCallback methods in getVisitorCode!',\n      );\n    }\n\n    let visitorCode;\n\n    const existingVisitorCode = this.getDataCallback(\n      KameleoonStorageKey.VisitorCode,\n    );\n\n    if (existingVisitorCode) {\n      visitorCode = existingVisitorCode;\n    }\n\n    if (!visitorCode) {\n      if (defaultVisitorCode) {\n        this.validateVisitorCode(defaultVisitorCode).throw();\n        visitorCode = defaultVisitorCode;\n      } else {\n        visitorCode = this.generateVisitorCode();\n      }\n    }\n\n    if (!this.isConsentRequired) {\n      this.setDataCallback({\n        visitorCode,\n        key: KameleoonStorageKey.VisitorCode,\n        maxAge: DEFAULT_MAX_AGE,\n        path: PATH,\n      });\n    }\n\n    return visitorCode;\n  }\n\n  private generateVisitorCode(): string {\n    const characters = 'abcdefghijklmnopqrstuvwxyz0123456789';\n    const randomCharacterArray: string[] = [];\n\n    for (let i = 0; i < VISITOR_CODE_LENGTH; i++) {\n      randomCharacterArray.push(\n        characters[Math.floor(Math.random() * characters.length)],\n      );\n    }\n\n    return randomCharacterArray.join('');\n  }\n}\n"],"mappings":"kvBAgBO,KAAM,CAAAA,kBAAkD,CAAAC,YAAA,EAAAC,eAAA,8BAAAA,eAAA,gCAAAA,eAAA,gCAK7D,GAAI,CAAAC,eAAeA,CAACC,CAAmB,CAAE,CACvC,IAAI,CAACC,iBAAiB,CAAGD,CAC3B,CAEA,GAAI,CAAAD,eAAeA,CAAA,CAAY,CAC7B,MAAO,KAAI,CAACE,iBACd,CAEA,GAAI,CAAAC,OAAOA,CAACC,CAAsB,CAAE,CAClC,IAAI,CAACC,eAAe,CAAGD,CACzB,CAEA,GAAI,CAAAE,OAAOA,CAACF,CAAyD,CAAE,CACrE,IAAI,CAACG,eAAe,CAAGH,CACzB,CAEA,GAAI,CAAAE,OAAOA,CAAA,CAAoD,CAC7D,GAAI,IAAI,CAACC,eAAe,CACtB,MAAO,KAAI,CAACA,eAAe,CAG7B,KAAM,IAAI,CAAAC,KAAK,CAAC,0BAA0B,CAC5C,CAEOC,mBAAmBA,CACxBC,CAAmB,CACW,OACH,EAAC,GAAxBA,CAAW,CAACC,MAAY,CACnB,GAAAC,UAAG,EAAC,GAAI,CAAAC,8BAAc,CAACC,kCAAkB,CAACC,gBAAgB,CAAC,CAAC,CAGjEL,CAAW,CAACC,MAAM,CAAGK,kCAAuB,CACvC,GAAAJ,UAAG,EAAC,GAAI,CAAAC,8BAAc,CAACC,kCAAkB,CAACG,oBAAoB,CAAC,CAAC,CAGlE,GAAAC,SAAE,EAAC,CACZ,CAEOC,cAAcA,CAACC,CAA2B,CAAU,CACzD,GAAI,CAAC,IAAI,CAACf,eAAe,EAAI,CAAC,IAAI,CAACE,eAAe,CAChD,KAAM,IAAI,CAAAC,KAAK,CACb,uEACF,CAAC,CAGH,GAAI,CAAAE,CAAW,CAEf,KAAM,CAAAW,CAAmB,CAAG,IAAI,CAAChB,eAAe,CAC9CiB,4BAAmB,CAACC,WACtB,CAAC,CAwBD,MAtBI,CAAAF,CAAmB,GACrBX,CAAW,CAAGW,CAAmB,EAG9BX,CAAW,GACVU,CAAkB,EACpB,IAAI,CAACX,mBAAmB,CAACW,CAAkB,CAAC,CAACI,KAAK,CAAC,CAAC,CACpDd,CAAW,CAAGU,CAAkB,EAEhCV,CAAW,CAAG,IAAI,CAACe,mBAAmB,CAAC,CAAC,EAIvC,IAAI,CAACvB,iBAAiB,EACzB,IAAI,CAACK,eAAe,CAAC,CACnBG,WAAW,CAAXA,CAAW,CACXgB,GAAG,CAAEJ,4BAAmB,CAACC,WAAW,CACpCI,MAAM,CAAEC,0BAAe,CACvBC,IAAI,CAAEC,eACR,CAAC,CAAC,CAGGpB,CACT,CAEQe,mBAAmBA,CAAA,CAAW,MAC9B,CAAAM,CAAU,CAAG,sCAAsC,CACnDC,CAA8B,CAAG,EAAE,CAEzC,IAAK,GAAI,CAAAC,CAAC,CAAG,CAAC,CAAEA,CAAC,CAAGC,8BAAmB,CAAED,CAAC,EAAE,CAC1CD,CAAoB,CAACG,IAAI,CACvBJ,CAAU,CAACK,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,MAAM,CAAC,CAAC,CAAGP,CAAU,CAACpB,MAAM,CAAC,CAC1D,CAAC,CAGH,MAAO,CAAAqB,CAAoB,CAACO,IAAI,CAAC,EAAE,CACrC,CACF,CAACC,OAAA,CAAA3C,kBAAA,CAAAA,kBAAA","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kameleoon/javascript-sdk-core",
-  "version": "4.4.8",
+  "version": "5.0.1",
   "description": "Kameleoon JS SDK Core",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,7 +38,7 @@
   },
   "dependencies": {
     "crypto-js": "^4.1.1",
-    "ts-res": "^1.1.1"
+    "ts-res": "^1.2.1"
   },
   "devDependencies": {
     "@types/crypto-js": "^4.1.1",