@launchdarkly/js-sdk-common 2.4.1 → 2.5.0

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to `@launchdarkly/js-sdk-common` will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [2.5.0](https://github.com/launchdarkly/js-core/compare/js-sdk-common-v2.4.2...js-sdk-common-v2.5.0) (2024-06-04)
+
+
+### Features
+
+* Add support for a cancel-able timeout. ([#476](https://github.com/launchdarkly/js-core/issues/476)) ([24ecf1d](https://github.com/launchdarkly/js-core/commit/24ecf1d74b01e1fb32cd250689f17f96d1af1f50))
+
+## [2.4.2](https://github.com/launchdarkly/js-core/compare/js-sdk-common-v2.4.1...js-sdk-common-v2.4.2) (2024-04-26)
+
+
+### Bug Fixes
+
+* Handle missing message with valid string. ([#450](https://github.com/launchdarkly/js-core/issues/450)) ([6ff8982](https://github.com/launchdarkly/js-core/commit/6ff8982d5a68f1fff4b8fcafc3eb015a75d3f002))
+* Produce a warning when track is called with a non-numeric metric value. ([#449](https://github.com/launchdarkly/js-core/issues/449)) ([6799742](https://github.com/launchdarkly/js-core/commit/6799742a7914d32b3313e54408f0a2a3dda3ff5c))
+
 ## [2.4.1](https://github.com/launchdarkly/js-core/compare/js-sdk-common-v2.4.0...js-sdk-common-v2.4.1) (2024-04-09)
 
 

package/dist/internal/events/ClientMessages.d.ts

@@ -3,5 +3,6 @@
  */
 export default class ClientMessages {
     static readonly missingContextKeyNoEvent = "Context was unspecified or had no key; event will not be sent";
+    static invalidMetricValue(badType: string): string;
 }
 //# sourceMappingURL=ClientMessages.d.ts.map

package/dist/internal/events/ClientMessages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClientMessages.d.ts","sourceRoot":"","sources":["../../../src/internal/events/ClientMessages.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,MAAM,CAAC,QAAQ,CAAC,wBAAwB,mEAC0B;CACnE"}
+{"version":3,"file":"ClientMessages.d.ts","sourceRoot":"","sources":["../../../src/internal/events/ClientMessages.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,MAAM,CAAC,QAAQ,CAAC,wBAAwB,mEAC0B;IAElE,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM;CAM1C"}

package/dist/internal/events/ClientMessages.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Messages for issues which can be encountered processing client requests.
  */
 class ClientMessages {
+    static invalidMetricValue(badType) {
+        return ('The track function was called with a non-numeric "metricValue"' +
+            ` (${badType}), only numeric metric values are supported.`);
+    }
 }
 ClientMessages.missingContextKeyNoEvent = 'Context was unspecified or had no key; event will not be sent';
 exports.default = ClientMessages;

package/dist/internal/events/ClientMessages.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClientMessages.js","sourceRoot":"","sources":["../../../src/internal/events/ClientMessages.ts"],"names":[],"mappings":";;AAAA;;GAEG;AACH,MAAqB,cAAc;;AACjB,uCAAwB,GACtC,+DAA+D,CAAC;kBAF/C,cAAc"}
+{"version":3,"file":"ClientMessages.js","sourceRoot":"","sources":["../../../src/internal/events/ClientMessages.ts"],"names":[],"mappings":";;AAAA;;GAEG;AACH,MAAqB,cAAc;IAIjC,MAAM,CAAC,kBAAkB,CAAC,OAAe;QACvC,OAAO,CACL,gEAAgE;YAChE,KAAK,OAAO,8CAA8C,CAC3D,CAAC;IACJ,CAAC;;AARe,uCAAwB,GACtC,+DAA+D,CAAC;kBAF/C,cAAc"}

package/dist/utils/cancelableTimedPromise.d.ts

@@ -0,0 +1,20 @@
+import { VoidFunction } from './VoidFunction';
+/**
+ * Represents a timeout that can be cancelled.
+ *
+ * When racing a timeout, and another task completes before the timeout,
+ * then the timeout should be cancelled. This prevents leaving open handles
+ * which can stop the runtime from exiting.
+ */
+export interface CancelableTimeout {
+    promise: Promise<void>;
+    cancel: VoidFunction;
+}
+/**
+ * Returns a promise which errors after t seconds.
+ *
+ * @param t Timeout in seconds.
+ * @param taskName Name of task being timed for logging and error reporting.
+ */
+export declare function cancelableTimedPromise(t: number, taskName: string): CancelableTimeout;
+//# sourceMappingURL=cancelableTimedPromise.d.ts.map

package/dist/utils/cancelableTimedPromise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancelableTimedPromise.d.ts","sourceRoot":"","sources":["../../src/utils/cancelableTimedPromise.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAiBrF"}

package/dist/utils/cancelableTimedPromise.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelableTimedPromise = void 0;
+const errors_1 = require("../errors");
+/**
+ * Returns a promise which errors after t seconds.
+ *
+ * @param t Timeout in seconds.
+ * @param taskName Name of task being timed for logging and error reporting.
+ */
+function cancelableTimedPromise(t, taskName) {
+    let timeout;
+    let resolve;
+    const promise = new Promise((_res, reject) => {
+        resolve = _res;
+        timeout = setTimeout(() => {
+            const e = `${taskName} timed out after ${t} seconds.`;
+            reject(new errors_1.LDTimeoutError(e));
+        }, t * 1000);
+    });
+    return {
+        promise,
+        cancel: () => {
+            resolve();
+            clearTimeout(timeout);
+        },
+    };
+}
+exports.cancelableTimedPromise = cancelableTimedPromise;
+//# sourceMappingURL=cancelableTimedPromise.js.map

package/dist/utils/cancelableTimedPromise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancelableTimedPromise.js","sourceRoot":"","sources":["../../src/utils/cancelableTimedPromise.ts"],"names":[],"mappings":";;;AAAA,sCAA2C;AAe3C;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,CAAS,EAAE,QAAgB;IAChE,IAAI,OAAsC,CAAC;IAC3C,IAAI,OAAqB,CAAC;IAC1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QACjD,OAAO,GAAG,IAAI,CAAC;QACf,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YACxB,MAAM,CAAC,GAAG,GAAG,QAAQ,oBAAoB,CAAC,WAAW,CAAC;YACtD,MAAM,CAAC,IAAI,uBAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IACH,OAAO;QACL,OAAO;QACP,MAAM,EAAE,GAAG,EAAE;YACX,OAAO,EAAE,CAAC;YACV,YAAY,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;KACF,CAAC;AACJ,CAAC;AAjBD,wDAiBC"}

package/dist/utils/http.js

@@ -29,7 +29,7 @@ function httpErrorMessage(err, context, retryMessage) {
         desc = `error ${err.status}${err.status === 401 ? ' (invalid SDK key)' : ''}`;
     }
     else {
-        desc = `I/O error (${err.message || err})`;
+        desc = `I/O error (${err.message || 'unknown error'})`;
     }
     const action = retryMessage !== null && retryMessage !== void 0 ? retryMessage : 'giving up permanently';
     return `Received ${desc} for ${context} - ${action}`;

package/dist/utils/http.js.map

@@ -1 +1 @@
-{"version":3,"file":"http.js","sourceRoot":"","sources":["../../src/utils/http.ts"],"names":[],"mappings":";;;AACA,sCAA8C;AAU9C,SAAgB,cAAc,CAC5B,MAAc,EACd,IAAU,EACV,IAAsB,EACtB,6BAAsC,IAAI;IAE1C,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAE/E,MAAM,OAAO,GAAc;QACzB,YAAY,EAAE,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,cAAc,IAAI,OAAO,EAAE;KAC9D,CAAC;IAEF,iEAAiE;IACjE,+CAA+C;IAC/C,IAAI,0BAA0B,EAAE;QAC9B,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC;KAChC;IAED,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,wBAAwB,CAAC,GAAG,cAAc;YAChD,CAAC,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE;YACpC,CAAC,CAAC,WAAW,CAAC;KACjB;IAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EAAE;QACf,OAAO,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;KAC7C;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AA7BD,wCA6BC;AAED,SAAgB,gBAAgB,CAC9B,GAAsB,EACtB,OAAe,EACf,YAAqB;IAErB,IAAI,IAAI,CAAC;IACT,IAAI,GAAG,CAAC,MAAM,EAAE;QACd,IAAI,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;KAC/E;SAAM;QACL,IAAI,GAAG,cAAc,GAAG,CAAC,OAAO,IAAI,GAAG,GAAG,CAAC;KAC5C;IACD,MAAM,MAAM,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,uBAAuB,CAAC;IACvD,OAAO,YAAY,IAAI,QAAQ,OAAO,MAAM,MAAM,EAAE,CAAC;AACvD,CAAC;AAbD,4CAaC;AAED,SAAgB,WAAW,CAAC,EAAE,MAAM,EAAqB;IACvD,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,0BAAiB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACnD,CAAC;AAFD,kCAEC;AAED;;;;;;;;GAQG;AACI,MAAM,eAAe,GAAG,CAAC,CAAS,EAAE,QAAkB,EAAU,EAAE,CACvE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AADjE,QAAA,eAAe,mBACkD"}
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../src/utils/http.ts"],"names":[],"mappings":";;;AACA,sCAA8C;AAU9C,SAAgB,cAAc,CAC5B,MAAc,EACd,IAAU,EACV,IAAsB,EACtB,6BAAsC,IAAI;IAE1C,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAE/E,MAAM,OAAO,GAAc;QACzB,YAAY,EAAE,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,cAAc,IAAI,OAAO,EAAE;KAC9D,CAAC;IAEF,iEAAiE;IACjE,+CAA+C;IAC/C,IAAI,0BAA0B,EAAE;QAC9B,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC;KAChC;IAED,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,wBAAwB,CAAC,GAAG,cAAc;YAChD,CAAC,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE;YACpC,CAAC,CAAC,WAAW,CAAC;KACjB;IAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EAAE;QACf,OAAO,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;KAC7C;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AA7BD,wCA6BC;AAED,SAAgB,gBAAgB,CAC9B,GAAsB,EACtB,OAAe,EACf,YAAqB;IAErB,IAAI,IAAI,CAAC;IACT,IAAI,GAAG,CAAC,MAAM,EAAE;QACd,IAAI,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;KAC/E;SAAM;QACL,IAAI,GAAG,cAAc,GAAG,CAAC,OAAO,IAAI,eAAe,GAAG,CAAC;KACxD;IACD,MAAM,MAAM,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,uBAAuB,CAAC;IACvD,OAAO,YAAY,IAAI,QAAQ,OAAO,MAAM,MAAM,EAAE,CAAC;AACvD,CAAC;AAbD,4CAaC;AAED,SAAgB,WAAW,CAAC,EAAE,MAAM,EAAqB;IACvD,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,0BAAiB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACnD,CAAC;AAFD,kCAEC;AAED;;;;;;;;GAQG;AACI,MAAM,eAAe,GAAG,CAAC,CAAS,EAAE,QAAkB,EAAU,EAAE,CACvE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AADjE,QAAA,eAAe,mBACkD"}

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
+import { cancelableTimedPromise, type CancelableTimeout } from './cancelableTimedPromise';
 import clone from './clone';
 import { secondsToMillis } from './date';
 import debounce from './debounce';
@@ -8,5 +9,5 @@ import noop from './noop';
 import sleep from './sleep';
 import timedPromise from './timedPromise';
 import { VoidFunction } from './VoidFunction';
-export { base64UrlEncode, clone, debounce, deepCompact, defaultHeaders, fastDeepEqual, httpErrorMessage, noop, LDHeaders, shouldRetry, secondsToMillis, sleep, timedPromise, VoidFunction, };
+export { base64UrlEncode, clone, debounce, deepCompact, defaultHeaders, fastDeepEqual, httpErrorMessage, noop, LDHeaders, shouldRetry, secondsToMillis, sleep, timedPromise, VoidFunction, type CancelableTimeout, cancelableTimedPromise, };
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACnG,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EACL,eAAe,EACf,KAAK,EACL,QAAQ,EACR,WAAW,EACX,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,IAAI,EACJ,SAAS,EACT,WAAW,EACX,eAAe,EACf,KAAK,EACL,YAAY,EACZ,YAAY,GACb,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,KAAK,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC1F,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACnG,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EACL,eAAe,EACf,KAAK,EACL,QAAQ,EACR,WAAW,EACX,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,IAAI,EACJ,SAAS,EACT,WAAW,EACX,eAAe,EACf,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,KAAK,iBAAiB,EACtB,sBAAsB,GACvB,CAAC"}

package/dist/utils/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.timedPromise = exports.sleep = exports.secondsToMillis = exports.shouldRetry = exports.noop = exports.httpErrorMessage = exports.fastDeepEqual = exports.defaultHeaders = exports.deepCompact = exports.debounce = exports.clone = exports.base64UrlEncode = void 0;
+exports.cancelableTimedPromise = exports.timedPromise = exports.sleep = exports.secondsToMillis = exports.shouldRetry = exports.noop = exports.httpErrorMessage = exports.fastDeepEqual = exports.defaultHeaders = exports.deepCompact = exports.debounce = exports.clone = exports.base64UrlEncode = void 0;
+const cancelableTimedPromise_1 = require("./cancelableTimedPromise");
+Object.defineProperty(exports, "cancelableTimedPromise", { enumerable: true, get: function () { return cancelableTimedPromise_1.cancelableTimedPromise; } });
 const clone_1 = require("./clone");
 exports.clone = clone_1.default;
 const date_1 = require("./date");

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,mCAA4B;AAa1B,gBAbK,eAAK,CAaL;AAZP,iCAAyC;AAqBvC,gGArBO,sBAAe,OAqBP;AApBjB,yCAAkC;AAYhC,mBAZK,kBAAQ,CAYL;AAXV,+CAAwC;AAYtC,sBAZK,qBAAW,CAYL;AAXb,uDAA8C;AAa5C,wBAbK,yBAAa,CAaL;AAZf,iCAAmG;AAOjG,gGAPO,sBAAe,OAOP;AAIf,+FAXwB,qBAAc,OAWxB;AAEd,iGAbwC,uBAAgB,OAaxC;AAGhB,4FAhBqE,kBAAW,OAgBrE;AAfb,iCAA0B;AAaxB,eAbK,cAAI,CAaL;AAZN,mCAA4B;AAgB1B,gBAhBK,eAAK,CAgBL;AAfP,iDAA0C;AAgBxC,uBAhBK,sBAAY,CAgBL"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,qEAA0F;AA4BxF,uGA5BO,+CAAsB,OA4BP;AA3BxB,mCAA4B;AAa1B,gBAbK,eAAK,CAaL;AAZP,iCAAyC;AAqBvC,gGArBO,sBAAe,OAqBP;AApBjB,yCAAkC;AAYhC,mBAZK,kBAAQ,CAYL;AAXV,+CAAwC;AAYtC,sBAZK,qBAAW,CAYL;AAXb,uDAA8C;AAa5C,wBAbK,yBAAa,CAaL;AAZf,iCAAmG;AAOjG,gGAPO,sBAAe,OAOP;AAIf,+FAXwB,qBAAc,OAWxB;AAEd,iGAbwC,uBAAgB,OAaxC;AAGhB,4FAhBqE,kBAAW,OAgBrE;AAfb,iCAA0B;AAaxB,eAbK,cAAI,CAaL;AAZN,mCAA4B;AAgB1B,gBAhBK,eAAK,CAgBL;AAfP,iDAA0C;AAgBxC,uBAhBK,sBAAY,CAgBL"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchdarkly/js-sdk-common",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "type": "commonjs",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",