@launchdarkly/js-client-sdk-common 1.1.4 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.2.0](https://github.com/launchdarkly/js-core/compare/js-client-sdk-common-v1.1.5...js-client-sdk-common-v1.2.0) (2024-07-31)
+
+
+### Features
+
+* Remove mock fetch from mocks. ([#525](https://github.com/launchdarkly/js-core/issues/525)) ([fa8e579](https://github.com/launchdarkly/js-core/commit/fa8e579b150770721347a173b4a65b3102d6b347))
+
+## [1.1.5](https://github.com/launchdarkly/js-core/compare/js-client-sdk-common-v1.1.4...js-client-sdk-common-v1.1.5) (2024-07-12)
+
+
+### Bug Fixes
+
+* Correct documentation for variationDetail for client SDKs. ([#509](https://github.com/launchdarkly/js-core/issues/509)) ([496e39f](https://github.com/launchdarkly/js-core/commit/496e39f54a4437866dd1ab4050fd5522cfc78f23))
+
 ## [1.1.4](https://github.com/launchdarkly/js-core/compare/js-client-sdk-common-v1.1.3...js-client-sdk-common-v1.1.4) (2024-06-04)
 
 

package/dist/api/LDClient.d.ts

@@ -295,8 +295,7 @@ export interface LDClient {
      * Determines the variation of a feature flag for a context, along with information about how it was
      * calculated.
      *
-     * Note that this will only work if you have set `evaluationExplanations` to true in {@link LDOptions}.
-     * Otherwise, the `reason` property of the result will be null.
+     * Note that this will only work if you have set `withReasons` to true in {@link LDOptions}.
      *
      * The `reason` property of the result will also be included in analytics events, if you are
      * capturing detailed event data for this flag.

package/dist/api/LDClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LDClient.d.ts","sourceRoot":"","sources":["../../src/api/LDClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACvB,SAAS,EACT,WAAW,EACX,QAAQ,EACT,MAAM,6BAA6B,CAAC;AAErC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;OAOG;IACH,QAAQ,IAAI,SAAS,CAAC;IAEtB;;;;;;;;;;OAUG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE1F;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;;;;;OASG;IACH,KAAK,IAAI,OAAO,CAAC;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAErD;;;;;OAKG;IACH,iBAAiB,IAAI,cAAc,CAAC;IAEpC;;;;;OAKG;IACH,UAAU,IAAI,SAAS,GAAG,SAAS,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,eAAe,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjF;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE1F;;;;;;;OAOG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE1F;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE1F;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,WAAW,GAAG,kBAAkB,CAAC;CAC9E"}
+{"version":3,"file":"LDClient.d.ts","sourceRoot":"","sources":["../../src/api/LDClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACvB,SAAS,EACT,WAAW,EACX,QAAQ,EACT,MAAM,6BAA6B,CAAC;AAErC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;OAOG;IACH,QAAQ,IAAI,SAAS,CAAC;IAEtB;;;;;;;;;;OAUG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE1F;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;;;;;OASG;IACH,KAAK,IAAI,OAAO,CAAC;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAErD;;;;;OAKG;IACH,iBAAiB,IAAI,cAAc,CAAC;IAEpC;;;;;OAKG;IACH,UAAU,IAAI,SAAS,GAAG,SAAS,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,eAAe,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjF;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE1F;;;;;;;OAOG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE1F;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE1F;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,WAAW,GAAG,kBAAkB,CAAC;CAC9E"}

package/package.json

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

package/dist/evaluation/fetchFlags.d.ts

@@ -1,6 +0,0 @@
-import { LDContext, Platform } from '@launchdarkly/js-sdk-common';
-import Configuration from '../configuration';
-import { Flags } from '../types';
-declare const fetchFlags: (sdkKey: string, context: LDContext, config: Configuration, { encoding, info, requests }: Platform) => Promise<Flags>;
-export default fetchFlags;
-//# sourceMappingURL=fetchFlags.d.ts.map

package/dist/evaluation/fetchFlags.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetchFlags.d.ts","sourceRoot":"","sources":["../../src/evaluation/fetchFlags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAElE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAGjC,QAAA,MAAM,UAAU,WACN,MAAM,WACL,SAAS,UACV,aAAa,gCACS,QAAQ,KACrC,QAAQ,KAAK,CAOf,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/evaluation/fetchFlags.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fetchUtils_1 = require("./fetchUtils");
-const fetchFlags = async (sdkKey, context, config, { encoding, info, requests }) => {
-    const fetchUrl = (0, fetchUtils_1.createFetchUrl)(sdkKey, context, config, encoding);
-    const fetchOptions = (0, fetchUtils_1.createFetchOptions)(sdkKey, context, config, info);
-    // TODO: add error handling, retry and timeout
-    const response = await requests.fetch(fetchUrl, fetchOptions);
-    return response.json();
-};
-exports.default = fetchFlags;
-//# sourceMappingURL=fetchFlags.js.map

package/dist/evaluation/fetchFlags.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetchFlags.js","sourceRoot":"","sources":["../../src/evaluation/fetchFlags.ts"],"names":[],"mappings":";;AAIA,6CAAkE;AAElE,MAAM,UAAU,GAAG,KAAK,EACtB,MAAc,EACd,OAAkB,EAClB,MAAqB,EACrB,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAY,EACtB,EAAE;IAClB,MAAM,QAAQ,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAS,CAAC,CAAC;IACpE,MAAM,YAAY,GAAG,IAAA,+BAAkB,EAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAEvE,8CAA8C;IAC9C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC9D,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC,CAAC;AAEF,kBAAe,UAAU,CAAC"}

package/dist/evaluation/fetchUtils.d.ts

@@ -1,7 +0,0 @@
-import { Encoding, Info, LDContext, Options } from '@launchdarkly/js-sdk-common';
-import Configuration from '../configuration';
-export declare const createFetchPath: (sdkKey: string, context: LDContext, baseUrlPolling: string, useReport: boolean, encoding: Encoding) => string;
-export declare const createQueryString: (hash: string | undefined, withReasons: boolean) => string;
-export declare const createFetchUrl: (sdkKey: string, context: LDContext, config: Configuration, encoding: Encoding) => string;
-export declare const createFetchOptions: (sdkKey: string, context: LDContext, config: Configuration, info: Info) => Options;
-//# sourceMappingURL=fetchUtils.d.ts.map

package/dist/evaluation/fetchUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetchUtils.d.ts","sourceRoot":"","sources":["../../src/evaluation/fetchUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,EACR,IAAI,EACJ,SAAS,EACT,OAAO,EACR,MAAM,6BAA6B,CAAC;AAErC,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAE7C,eAAO,MAAM,eAAe,WAClB,MAAM,WACL,SAAS,kBACF,MAAM,aACX,OAAO,YACR,QAAQ,WAOX,CAAC;AAEV,eAAO,MAAM,iBAAiB,SAAU,MAAM,GAAG,SAAS,eAAe,OAAO,WAc/E,CAAC;AAEF,eAAO,MAAM,cAAc,WACjB,MAAM,WACL,SAAS,UACV,aAAa,YACX,QAAQ,WAYnB,CAAC;AAEF,eAAO,MAAM,kBAAkB,WACrB,MAAM,WACL,SAAS,UACV,aAAa,QACf,IAAI,KACT,OAgBF,CAAC"}

package/dist/evaluation/fetchUtils.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFetchOptions = exports.createFetchUrl = exports.createQueryString = exports.createFetchPath = void 0;
-const js_sdk_common_1 = require("@launchdarkly/js-sdk-common");
-const createFetchPath = (sdkKey, context, baseUrlPolling, useReport, encoding) => useReport
-    ? `${baseUrlPolling}/sdk/evalx/${sdkKey}/context`
-    : `${baseUrlPolling}/sdk/evalx/${sdkKey}/contexts/${(0, js_sdk_common_1.base64UrlEncode)(JSON.stringify(context), encoding)}`;
-exports.createFetchPath = createFetchPath;
-const createQueryString = (hash, withReasons) => {
-    const qs = {
-        h: hash,
-        withReasons,
-    };
-    const qsArray = [];
-    Object.entries(qs).forEach(([key, value]) => {
-        if (value) {
-            qsArray.push(`${key}=${value}`);
-        }
-    });
-    return qsArray.join('&');
-};
-exports.createQueryString = createQueryString;
-const createFetchUrl = (sdkKey, context, config, encoding) => {
-    const { withReasons, hash, serviceEndpoints: { polling }, useReport, } = config;
-    const path = (0, exports.createFetchPath)(sdkKey, context, polling, useReport, encoding);
-    const qs = (0, exports.createQueryString)(hash, withReasons);
-    return qs ? `${path}?${qs}` : path;
-};
-exports.createFetchUrl = createFetchUrl;
-const createFetchOptions = (sdkKey, context, config, info) => {
-    const { useReport, tags } = config;
-    const headers = (0, js_sdk_common_1.defaultHeaders)(sdkKey, info, tags);
-    if (useReport) {
-        return {
-            method: 'REPORT',
-            headers: Object.assign(Object.assign({}, headers), { 'content-type': 'application/json' }),
-            body: JSON.stringify(context),
-        };
-    }
-    return {
-        method: 'GET',
-        headers,
-    };
-};
-exports.createFetchOptions = createFetchOptions;
-//# sourceMappingURL=fetchUtils.js.map

package/dist/evaluation/fetchUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetchUtils.js","sourceRoot":"","sources":["../../src/evaluation/fetchUtils.ts"],"names":[],"mappings":";;;AAAA,+DAOqC;AAI9B,MAAM,eAAe,GAAG,CAC7B,MAAc,EACd,OAAkB,EAClB,cAAsB,EACtB,SAAkB,EAClB,QAAkB,EAClB,EAAE,CACF,SAAS;IACP,CAAC,CAAC,GAAG,cAAc,cAAc,MAAM,UAAU;IACjD,CAAC,CAAC,GAAG,cAAc,cAAc,MAAM,aAAa,IAAA,+BAAe,EAC/D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EACvB,QAAQ,CACT,EAAE,CAAC;AAZG,QAAA,eAAe,mBAYlB;AAEH,MAAM,iBAAiB,GAAG,CAAC,IAAwB,EAAE,WAAoB,EAAE,EAAE;IAClF,MAAM,EAAE,GAAG;QACT,CAAC,EAAE,IAAI;QACP,WAAW;KACZ,CAAC;IAEF,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC1C,IAAI,KAAK,EAAE;YACT,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC;SACjC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC,CAAC;AAdW,QAAA,iBAAiB,qBAc5B;AAEK,MAAM,cAAc,GAAG,CAC5B,MAAc,EACd,OAAkB,EAClB,MAAqB,EACrB,QAAkB,EAClB,EAAE;IACF,MAAM,EACJ,WAAW,EACX,IAAI,EACJ,gBAAgB,EAAE,EAAE,OAAO,EAAE,EAC7B,SAAS,GACV,GAAG,MAAM,CAAC;IACX,MAAM,IAAI,GAAG,IAAA,uBAAe,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5E,MAAM,EAAE,GAAG,IAAA,yBAAiB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEhD,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACrC,CAAC,CAAC;AAhBW,QAAA,cAAc,kBAgBzB;AAEK,MAAM,kBAAkB,GAAG,CAChC,MAAc,EACd,OAAkB,EAClB,MAAqB,EACrB,IAAU,EACD,EAAE;IACX,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IACnC,MAAM,OAAO,GAAG,IAAA,8BAAc,EAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAEnD,IAAI,SAAS,EAAE;QACb,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,kCAAO,OAAO,KAAE,cAAc,EAAE,kBAAkB,GAAE;YAC3D,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CAAC;KACH;IAED,OAAO;QACL,MAAM,EAAE,KAAK;QACb,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AArBW,QAAA,kBAAkB,sBAqB7B"}