@launchdarkly/js-sdk-common 1.1.0-beta.1 → 1.2.0-alpha

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to `@launchdarkly/js-sdk-common` will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [1.1.0](https://github.com/launchdarkly/js-core/compare/js-sdk-common-v1.0.3...js-sdk-common-v1.1.0) (2023-08-14)
+
+
+### Features
+
+* Allow specifying the user agent per-sdk implementation. ([#226](https://github.com/launchdarkly/js-core/issues/226)) ([e57716f](https://github.com/launchdarkly/js-core/commit/e57716f3f6f0ba8568e32b0937903ca46e5470ad))
+
+## [1.0.3](https://github.com/launchdarkly/js-core/compare/js-sdk-common-v1.0.2...js-sdk-common-v1.0.3) (2023-08-10)
+
+
+### Bug Fixes
+
+* Switch to es2017 target to ensure native async/await. ([a83e4e6](https://github.com/launchdarkly/js-core/commit/a83e4e62d04c66105a1b0e8893640a7ca2d641e4))
+
 ## [1.0.2](https://github.com/launchdarkly/js-core/compare/js-sdk-common-v1.0.1...js-sdk-common-v1.0.2) (2023-06-13)
 
 

package/dist/api/platform/Info.d.ts

@@ -38,6 +38,11 @@ export interface SdkData {
      * The version of the SDK.
      */
     version?: string;
+    /**
+     * If this is a top-level (not a wrapper) SDK this will be used to create the user agent string.
+     * It will take the form 'userAgentBase/version`.
+     */
+    userAgentBase?: string;
     /**
      * Name of the wrapper SDK if present.
      */

package/dist/api/platform/Info.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Info.d.ts","sourceRoot":"","sources":["../../../src/api/platform/Info.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,EAAE,CAAC,EAAE;QACH;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,6BAA6B;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,YAAY,IAAI,YAAY,CAAC;IAE7B;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC;CACpB"}
+{"version":3,"file":"Info.d.ts","sourceRoot":"","sources":["../../../src/api/platform/Info.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,EAAE,CAAC,EAAE;QACH;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,6BAA6B;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,YAAY,IAAI,YAAY,CAAC;IAE7B;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC;CACpB"}

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

@@ -0,0 +1,16 @@
+/**
+ * This is for internal use only.
+ *
+ * Edge sdks use clientSideID to query feature stores. They also send analytics
+ * using this clientSideID. This is a hybrid behavior because they are based
+ * on js-server-common, but uses the clientSideID instead of the sdkKey for the
+ * above reasons. These internal options allow the edge sdks to use the
+ * EventSender to send analytics to the correct LD endpoints using
+ * the clientSideId.
+ */
+export type LDInternalOptions = {
+    analyticsEventPath?: string;
+    diagnosticEventPath?: string;
+    includeAuthorizationHeader?: boolean;
+};
+//# sourceMappingURL=LDInternalOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LDInternalOptions.d.ts","sourceRoot":"","sources":["../../../src/internal/events/LDInternalOptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC,CAAC"}

package/dist/internal/events/LDInternalOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LDInternalOptions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LDInternalOptions.js","sourceRoot":"","sources":["../../../src/internal/events/LDInternalOptions.ts"],"names":[],"mappings":""}

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

@@ -3,5 +3,6 @@ import InputCustomEvent from './InputCustomEvent';
 import InputEvalEvent from './InputEvalEvent';
 import InputEvent from './InputEvent';
 import InputIdentifyEvent from './InputIdentifyEvent';
-export { InputCustomEvent, InputEvalEvent, InputEvent, InputIdentifyEvent, EventProcessor };
+import type { LDInternalOptions } from './LDInternalOptions';
+export { EventProcessor, InputCustomEvent, InputEvalEvent, InputEvent, InputIdentifyEvent, LDInternalOptions, };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/internal/events/index.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/internal/events/index.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,kBAAkB,EAClB,iBAAiB,GAClB,CAAC"}

package/dist/internal/events/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventProcessor = exports.InputIdentifyEvent = exports.InputEvalEvent = exports.InputCustomEvent = void 0;
+exports.InputIdentifyEvent = exports.InputEvalEvent = exports.InputCustomEvent = exports.EventProcessor = void 0;
 const EventProcessor_1 = require("./EventProcessor");
 exports.EventProcessor = EventProcessor_1.default;
 const InputCustomEvent_1 = require("./InputCustomEvent");

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/internal/events/index.ts"],"names":[],"mappings":";;;AAAA,qDAA8C;AAM6B,yBANpE,wBAAc,CAMoE;AALzF,yDAAkD;AAKzC,2BALF,0BAAgB,CAKE;AAJzB,qDAA8C;AAInB,yBAJpB,wBAAc,CAIoB;AAFzC,6DAAsD;AAEC,6BAFhD,4BAAkB,CAEgD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/internal/events/index.ts"],"names":[],"mappings":";;;AAAA,qDAA8C;AAQ5C,yBARK,wBAAc,CAQL;AAPhB,yDAAkD;AAQhD,2BARK,0BAAgB,CAQL;AAPlB,qDAA8C;AAQ5C,yBARK,wBAAc,CAQL;AANhB,6DAAsD;AAQpD,6BARK,4BAAkB,CAQL"}

package/dist/options/ServiceEndpoints.d.ts

@@ -5,6 +5,19 @@ export default class ServiceEndpoints {
     readonly streaming: string;
     readonly polling: string;
     readonly events: string;
-    constructor(streaming: string, polling: string, events: string);
+    /** Valid paths are:
+     * /bulk
+     * /events/bulk/envId
+     * /mobile
+     */
+    readonly analyticsEventPath: string;
+    /** Valid paths are:
+     * /diagnostic
+     * /events/diagnostic/envId
+     * /mobile/events/diagnostic
+     */
+    readonly diagnosticEventPath: string;
+    readonly includeAuthorizationHeader: boolean;
+    constructor(streaming: string, polling: string, events: string, analyticsEventPath?: string, diagnosticEventPath?: string, includeAuthorizationHeader?: boolean);
 }
 //# sourceMappingURL=ServiceEndpoints.d.ts.map

package/dist/options/ServiceEndpoints.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ServiceEndpoints.d.ts","sourceRoot":"","sources":["../../src/options/ServiceEndpoints.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC,SAAgB,MAAM,EAAE,MAAM,CAAC;gBAEZ,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAKtE"}
+{"version":3,"file":"ServiceEndpoints.d.ts","sourceRoot":"","sources":["../../src/options/ServiceEndpoints.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAE3C;;;;OAIG;IACH,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAG5C,SAAgB,0BAA0B,EAAE,OAAO,CAAC;gBAGlD,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,kBAAkB,GAAE,MAAgB,EACpC,mBAAmB,GAAE,MAAsB,EAC3C,0BAA0B,GAAE,OAAc;CAS7C"}

package/dist/options/ServiceEndpoints.js

@@ -7,10 +7,13 @@ function canonicalizeUri(uri) {
  * Specifies the base service URIs used by SDK components.
  */
 class ServiceEndpoints {
-    constructor(streaming, polling, events) {
+    constructor(streaming, polling, events, analyticsEventPath = '/bulk', diagnosticEventPath = '/diagnostic', includeAuthorizationHeader = true) {
         this.streaming = canonicalizeUri(streaming);
         this.polling = canonicalizeUri(polling);
         this.events = canonicalizeUri(events);
+        this.analyticsEventPath = analyticsEventPath;
+        this.diagnosticEventPath = diagnosticEventPath;
+        this.includeAuthorizationHeader = includeAuthorizationHeader;
     }
 }
 exports.default = ServiceEndpoints;

package/dist/options/ServiceEndpoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"ServiceEndpoints.js","sourceRoot":"","sources":["../../src/options/ServiceEndpoints.ts"],"names":[],"mappings":";;AAAA,SAAS,eAAe,CAAC,GAAW;IAClC,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAqB,gBAAgB;IAOnC,YAAmB,SAAiB,EAAE,OAAe,EAAE,MAAc;QACnE,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;CACF;AAZD,mCAYC"}
+{"version":3,"file":"ServiceEndpoints.js","sourceRoot":"","sources":["../../src/options/ServiceEndpoints.ts"],"names":[],"mappings":";;AAAA,SAAS,eAAe,CAAC,GAAW;IAClC,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAqB,gBAAgB;IAwBnC,YACE,SAAiB,EACjB,OAAe,EACf,MAAc,EACd,qBAA6B,OAAO,EACpC,sBAA8B,aAAa,EAC3C,6BAAsC,IAAI;QAE1C,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;IAC/D,CAAC;CACF;AAvCD,mCAuCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchdarkly/js-sdk-common",
-  "version": "1.1.0-beta.1",
+  "version": "1.2.0-alpha",
   "type": "commonjs",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -19,7 +19,6 @@
     "client"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "test": "npx jest --ci",
     "build": "npx tsc",
     "clean": "npx tsc --build --clean",
@@ -42,7 +41,7 @@
     "launchdarkly-js-test-helpers": "^2.2.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.0.5",
-    "typedoc": "0.23.26",
-    "typescript": "^5.1.6"
+    "typedoc": "0.25.0",
+    "typescript": "5.1.6"
   }
 }