@hackler/react-sdk 11.41.0 → 11.43.0

package/lib/client.d.ts

@@ -26,14 +26,77 @@ export declare class HackleReactSDKClient extends Emitter<HackleReactSDKClientEv
     setUserId(userId: string | undefined): void;
     setDeviceId(deviceId: string): void;
     setUserProperty(key: string, value: any): void;
+    /**
+     * Updates the user's properties.
+     *
+     * @param operations Property operations to update user properties.
+     *
+     */
     updateUserProperties(operations: PropertyOperations): void;
     resetUser(): void;
+    /**
+     * Determine the variation to expose to the user for experiment.
+     *
+     * This method return the {"A"} if:
+     * - The experiment key is invalid
+     * - The experiment has not started yet
+     * - The user is not allocated to the experiment
+     * - The determined variation has been dropped
+     *
+     * @param experimentKey     the unique key of the experiment.
+     * @param user              the user to participate in the experiment. MUST NOT be null.
+     * @param defaultVariation  the default variation of the experiment.
+     *
+     * @return string the decided variation for the user, or the default variation.
+     */
     variation(experimentKey: number, user?: User | null, defaultVariation?: string): string;
+    /**
+     * Determine the variation to expose to the user for experiment, and returns an object that
+     * describes the way the variation was determined.
+     *
+     * @param experimentKey    the unique key of the experiment.
+     * @param user             the user to participate in the experiment. MUST NOT be null. (e.g. { id: "userId"} )
+     * @param defaultVariation the default variation of the experiment. MUST NOT be null.
+     *
+     * @return {Decision} object
+     */
     variationDetail(experimentKey: number, user?: User | null, defaultVariation?: string): Decision;
+    /**
+     * Determine whether the feature is turned on to the user.
+     *
+     * @param featureKey the unique key for the feature.
+     * @param user       the user requesting the feature.
+     *
+     * @return boolean True if the feature is on. False if the feature is off.
+     *
+     * @since 2.0.0
+     */
     isFeatureOn(featureKey: number, user?: User | null): boolean;
+    /**
+     * Determine whether the feature is turned on to the user, and returns an object that
+     * describes the way the value was determined.
+     *
+     * @param featureKey the unique key for the feature.
+     * @param user     the identifier of user.
+     *
+     * @return {FeatureFlagDecision}
+     *
+     * @since 2.0.0
+     */
     featureFlagDetail(featureKey: number, user?: User | null): FeatureFlagDecision;
+    /**
+     * Records the event performed by the user.
+     *
+     * @param event the unique key of the event. MUST NOT be null.
+     * @param user the identifier of user that performed the event. id MUST NOT be null. (e.g. { id: "userId"} )
+     */
     track(event: string | HackleEvent, user?: User | null): void;
     trackPageView(option?: PageView): void;
+    /**
+     * Return a instance of Hackle Remote Config.
+     *
+     * @param user     the identifier of user.
+     */
     remoteConfig(user?: User | null): HackleRemoteConfig;
     onReady(cb: any, timeout?: number): void;
     onInitialized(config?: {
@@ -46,6 +109,16 @@ export declare class HackleReactSDKClient extends Emitter<HackleReactSDKClientEv
     hideUserExplorer(): void;
     fetch(): Promise<void>;
     setInAppMessageListener(listener: HackleInAppMessageListener | null): void;
+    /**
+     * Set user's phone number. Existing value will be replaced by new value if you call this method again.
+     *
+     * @param phoneNumber String satisfying valid E.164 format is accepted.
+     */
+    setPhoneNumber(phoneNumber: string): void;
+    /**
+     * Reset user's phone number to be an empty value.
+     */
+    unsetPhoneNumber(): void;
 }
 export declare function createInstance(sdkKey: string, config?: Config): HackleReactSDKClient;
 export {};

package/lib/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,mBAAmB,EAEnB,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,QAAQ,EACR,IAAI,EACJ,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAGnC,UAAU,MAAM;IACd,IAAI,CAAC,EAAE,IAAI,CAAA;IAEX,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,gCAAgC,CAAC,EAAE,MAAM,CAAA;IACzC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,YAAY,EAAE,sBAAsB,GAAG,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAA;IACrF,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,UAAU,4BAA4B;IACpC,cAAc,EAAE,IAAI,GAAG,IAAI,CAAA;CAC5B;AAED,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;IAC7E,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,YAAY,CAAoB;gBAE5B,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAoC3C,OAAO,IAAI,IAAI;IAIf,OAAO,CAAC,IAAI,EAAE,IAAI;IAKlB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAKpC,WAAW,CAAC,QAAQ,EAAE,MAAM;IAK5B,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAKvC,oBAAoB,CAAC,UAAU,EAAE,kBAAkB;IAKnD,SAAS;IAKT,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM;IAIvF,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ;IAI/F,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO;IAI5D,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,mBAAmB;IAI9E,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI;IAI5D,aAAa,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,IAAI;IAOtC,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,kBAAkB;IAIpD,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,MAAM;IAIjC,aAAa,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAI1E,OAAO,CAAC,eAAe;IAOvB,gBAAgB;IAIhB,gBAAgB;IAIhB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,uBAAuB,CAAC,QAAQ,EAAE,0BAA0B,GAAG,IAAI,GAAG,IAAI;CAG3E;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,oBAAoB,CAEpF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,mBAAmB,EAEnB,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,QAAQ,EACR,IAAI,EACJ,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAGnC,UAAU,MAAM;IACd,IAAI,CAAC,EAAE,IAAI,CAAA;IAEX,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,gCAAgC,CAAC,EAAE,MAAM,CAAA;IACzC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,YAAY,EAAE,sBAAsB,GAAG,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAA;IACrF,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,UAAU,4BAA4B;IACpC,cAAc,EAAE,IAAI,GAAG,IAAI,CAAA;CAC5B;AAED,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;IAC7E,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,YAAY,CAAoB;gBAE5B,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAoC3C,OAAO,IAAI,IAAI;IAIf,OAAO,CAAC,IAAI,EAAE,IAAI;IAKlB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAKpC,WAAW,CAAC,QAAQ,EAAE,MAAM;IAK5B,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAKvC;;;;;OAKG;IACH,oBAAoB,CAAC,UAAU,EAAE,kBAAkB;IAKnD,SAAS;IAKT;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM;IAIvF;;;;;;;;;OASG;IACH,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ;IAI/F;;;;;;;;;OASG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO;IAI5D;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,mBAAmB;IAI9E;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI;IAI5D,aAAa,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,IAAI;IAOtC;;;;OAIG;IACH,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,kBAAkB;IAIpD,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,MAAM;IAIjC,aAAa,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAI1E,OAAO,CAAC,eAAe;IAOvB,gBAAgB;IAIhB,gBAAgB;IAIhB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,uBAAuB,CAAC,QAAQ,EAAE,0BAA0B,GAAG,IAAI,GAAG,IAAI;IAI1E;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM;IAIlC;;OAEG;IACH,gBAAgB;CAGjB;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,oBAAoB,CAEpF"}

package/lib/index.es.js

@@ -64,7 +64,7 @@ function __read(o, n) {
 }
 
 var SDK_NAME_HEADER = "react-sdk";
-var SDK_VERSION_HEADER = "11.41.0" ;
+var SDK_VERSION_HEADER = "11.43.0" ;
 
 var Emitter = /** @class */ (function () {
     function Emitter() {
@@ -173,6 +173,12 @@ var HackleReactSDKClient = /** @class */ (function (_super) {
         this.client.setUserProperty(key, value);
         this.emitUpdatedUser(this.getUser());
     };
+    /**
+     * Updates the user's properties.
+     *
+     * @param operations Property operations to update user properties.
+     *
+     */
     HackleReactSDKClient.prototype.updateUserProperties = function (operations) {
         this.client.updateUserProperties(operations);
         this.emitUpdatedUser(this.getUser());
@@ -181,24 +187,81 @@ var HackleReactSDKClient = /** @class */ (function (_super) {
         this.client.resetUser();
         this.emitUpdatedUser(this.getUser());
     };
+    /**
+     * Determine the variation to expose to the user for experiment.
+     *
+     * This method return the {"A"} if:
+     * - The experiment key is invalid
+     * - The experiment has not started yet
+     * - The user is not allocated to the experiment
+     * - The determined variation has been dropped
+     *
+     * @param experimentKey     the unique key of the experiment.
+     * @param user              the user to participate in the experiment. MUST NOT be null.
+     * @param defaultVariation  the default variation of the experiment.
+     *
+     * @return string the decided variation for the user, or the default variation.
+     */
     HackleReactSDKClient.prototype.variation = function (experimentKey, user, defaultVariation) {
         return this.client.variation(experimentKey, user || undefined, defaultVariation);
     };
+    /**
+     * Determine the variation to expose to the user for experiment, and returns an object that
+     * describes the way the variation was determined.
+     *
+     * @param experimentKey    the unique key of the experiment.
+     * @param user             the user to participate in the experiment. MUST NOT be null. (e.g. { id: "userId"} )
+     * @param defaultVariation the default variation of the experiment. MUST NOT be null.
+     *
+     * @return {Decision} object
+     */
     HackleReactSDKClient.prototype.variationDetail = function (experimentKey, user, defaultVariation) {
         return this.client.variationDetail(experimentKey, user || undefined, defaultVariation);
     };
+    /**
+     * Determine whether the feature is turned on to the user.
+     *
+     * @param featureKey the unique key for the feature.
+     * @param user       the user requesting the feature.
+     *
+     * @return boolean True if the feature is on. False if the feature is off.
+     *
+     * @since 2.0.0
+     */
     HackleReactSDKClient.prototype.isFeatureOn = function (featureKey, user) {
         return this.client.isFeatureOn(featureKey, user || undefined);
     };
+    /**
+     * Determine whether the feature is turned on to the user, and returns an object that
+     * describes the way the value was determined.
+     *
+     * @param featureKey the unique key for the feature.
+     * @param user     the identifier of user.
+     *
+     * @return {FeatureFlagDecision}
+     *
+     * @since 2.0.0
+     */
     HackleReactSDKClient.prototype.featureFlagDetail = function (featureKey, user) {
         return this.client.featureFlagDetail(featureKey, user || undefined);
     };
+    /**
+     * Records the event performed by the user.
+     *
+     * @param event the unique key of the event. MUST NOT be null.
+     * @param user the identifier of user that performed the event. id MUST NOT be null. (e.g. { id: "userId"} )
+     */
     HackleReactSDKClient.prototype.track = function (event, user) {
         this.client.track(event, user || undefined);
     };
     HackleReactSDKClient.prototype.trackPageView = function (option) {
         this.client.trackPageView(__assign(__assign({}, option), { user: (option === null || option === void 0 ? void 0 : option.user) || undefined }));
     };
+    /**
+     * Return a instance of Hackle Remote Config.
+     *
+     * @param user     the identifier of user.
+     */
     HackleReactSDKClient.prototype.remoteConfig = function (user) {
         return this.client.remoteConfig(user || undefined);
     };
@@ -226,6 +289,20 @@ var HackleReactSDKClient = /** @class */ (function (_super) {
     HackleReactSDKClient.prototype.setInAppMessageListener = function (listener) {
         this.client.setInAppMessageListener(listener);
     };
+    /**
+     * Set user's phone number. Existing value will be replaced by new value if you call this method again.
+     *
+     * @param phoneNumber String satisfying valid E.164 format is accepted.
+     */
+    HackleReactSDKClient.prototype.setPhoneNumber = function (phoneNumber) {
+        this.client.setPhoneNumber(phoneNumber);
+    };
+    /**
+     * Reset user's phone number to be an empty value.
+     */
+    HackleReactSDKClient.prototype.unsetPhoneNumber = function () {
+        this.client.unsetPhoneNumber();
+    };
     return HackleReactSDKClient;
 }(Emitter));
 function createInstance(sdkKey, config) {

package/lib/index.js

@@ -89,7 +89,7 @@ function __read(o, n) {
 }
 
 var SDK_NAME_HEADER = "react-sdk";
-var SDK_VERSION_HEADER = "11.41.0" ;
+var SDK_VERSION_HEADER = "11.43.0" ;
 
 var Emitter = /** @class */ (function () {
     function Emitter() {
@@ -198,6 +198,12 @@ var HackleReactSDKClient = /** @class */ (function (_super) {
         this.client.setUserProperty(key, value);
         this.emitUpdatedUser(this.getUser());
     };
+    /**
+     * Updates the user's properties.
+     *
+     * @param operations Property operations to update user properties.
+     *
+     */
     HackleReactSDKClient.prototype.updateUserProperties = function (operations) {
         this.client.updateUserProperties(operations);
         this.emitUpdatedUser(this.getUser());
@@ -206,24 +212,81 @@ var HackleReactSDKClient = /** @class */ (function (_super) {
         this.client.resetUser();
         this.emitUpdatedUser(this.getUser());
     };
+    /**
+     * Determine the variation to expose to the user for experiment.
+     *
+     * This method return the {"A"} if:
+     * - The experiment key is invalid
+     * - The experiment has not started yet
+     * - The user is not allocated to the experiment
+     * - The determined variation has been dropped
+     *
+     * @param experimentKey     the unique key of the experiment.
+     * @param user              the user to participate in the experiment. MUST NOT be null.
+     * @param defaultVariation  the default variation of the experiment.
+     *
+     * @return string the decided variation for the user, or the default variation.
+     */
     HackleReactSDKClient.prototype.variation = function (experimentKey, user, defaultVariation) {
         return this.client.variation(experimentKey, user || undefined, defaultVariation);
     };
+    /**
+     * Determine the variation to expose to the user for experiment, and returns an object that
+     * describes the way the variation was determined.
+     *
+     * @param experimentKey    the unique key of the experiment.
+     * @param user             the user to participate in the experiment. MUST NOT be null. (e.g. { id: "userId"} )
+     * @param defaultVariation the default variation of the experiment. MUST NOT be null.
+     *
+     * @return {Decision} object
+     */
     HackleReactSDKClient.prototype.variationDetail = function (experimentKey, user, defaultVariation) {
         return this.client.variationDetail(experimentKey, user || undefined, defaultVariation);
     };
+    /**
+     * Determine whether the feature is turned on to the user.
+     *
+     * @param featureKey the unique key for the feature.
+     * @param user       the user requesting the feature.
+     *
+     * @return boolean True if the feature is on. False if the feature is off.
+     *
+     * @since 2.0.0
+     */
     HackleReactSDKClient.prototype.isFeatureOn = function (featureKey, user) {
         return this.client.isFeatureOn(featureKey, user || undefined);
     };
+    /**
+     * Determine whether the feature is turned on to the user, and returns an object that
+     * describes the way the value was determined.
+     *
+     * @param featureKey the unique key for the feature.
+     * @param user     the identifier of user.
+     *
+     * @return {FeatureFlagDecision}
+     *
+     * @since 2.0.0
+     */
     HackleReactSDKClient.prototype.featureFlagDetail = function (featureKey, user) {
         return this.client.featureFlagDetail(featureKey, user || undefined);
     };
+    /**
+     * Records the event performed by the user.
+     *
+     * @param event the unique key of the event. MUST NOT be null.
+     * @param user the identifier of user that performed the event. id MUST NOT be null. (e.g. { id: "userId"} )
+     */
     HackleReactSDKClient.prototype.track = function (event, user) {
         this.client.track(event, user || undefined);
     };
     HackleReactSDKClient.prototype.trackPageView = function (option) {
         this.client.trackPageView(__assign(__assign({}, option), { user: (option === null || option === void 0 ? void 0 : option.user) || undefined }));
     };
+    /**
+     * Return a instance of Hackle Remote Config.
+     *
+     * @param user     the identifier of user.
+     */
     HackleReactSDKClient.prototype.remoteConfig = function (user) {
         return this.client.remoteConfig(user || undefined);
     };
@@ -251,6 +314,20 @@ var HackleReactSDKClient = /** @class */ (function (_super) {
     HackleReactSDKClient.prototype.setInAppMessageListener = function (listener) {
         this.client.setInAppMessageListener(listener);
     };
+    /**
+     * Set user's phone number. Existing value will be replaced by new value if you call this method again.
+     *
+     * @param phoneNumber String satisfying valid E.164 format is accepted.
+     */
+    HackleReactSDKClient.prototype.setPhoneNumber = function (phoneNumber) {
+        this.client.setPhoneNumber(phoneNumber);
+    };
+    /**
+     * Reset user's phone number to be an empty value.
+     */
+    HackleReactSDKClient.prototype.unsetPhoneNumber = function () {
+        this.client.unsetPhoneNumber();
+    };
     return HackleReactSDKClient;
 }(Emitter));
 function createInstance(sdkKey, config) {