@launchdarkly/js-sdk-common 2.12.0 → 2.13.0

package/dist/esm/internal/fdv2/payloadReader.d.ts

@@ -0,0 +1,58 @@
+import { EventListener, EventName, LDLogger } from '../../api';
+import { DataSourceErrorKind } from '../../datasource';
+export interface EventStream {
+    addEventListener(type: EventName, listener: EventListener): void;
+}
+export interface ObjProcessors {
+    [kind: string]: (object: any) => any;
+}
+export interface Update {
+    kind: string;
+    key: string;
+    version: number;
+    object?: any;
+    deleted?: boolean;
+}
+export interface Payload {
+    id: string;
+    version: number;
+    state: string;
+    basis: boolean;
+    updates: Update[];
+}
+export type PayloadListener = (payload: Payload) => void;
+/**
+ * A FDv2 PayloadReader can be used to parse payloads from a stream of FDv2 events. It will send payloads
+ * to the PayloadListeners as the payloads are received. Invalid series of events may be dropped silently,
+ * but the payload reader will continue to operate.
+ */
+export declare class PayloadReader {
+    private readonly _objProcessors;
+    private readonly _errorHandler?;
+    private readonly _logger?;
+    private _listeners;
+    private _tempId?;
+    private _tempBasis?;
+    private _tempUpdates;
+    /**
+     * Creates a PayloadReader
+     *
+     * @param eventStream event stream of FDv2 events
+     * @param _objProcessors defines object processors for each object kind.
+     * @param _errorHandler that will be called with errors as they are encountered
+     * @param _logger for logging
+     */
+    constructor(eventStream: EventStream, _objProcessors: ObjProcessors, _errorHandler?: ((errorKind: DataSourceErrorKind, message: string) => void) | undefined, _logger?: LDLogger | undefined);
+    addPayloadListener(listener: PayloadListener): void;
+    removePayloadListener(listener: PayloadListener): void;
+    private _attachHandler;
+    private _processObj;
+    private _processServerIntent;
+    private _processPutObject;
+    private _processDeleteObject;
+    private _processPayloadTransferred;
+    private _processGoodbye;
+    private _processError;
+    private _resetState;
+}
+//# sourceMappingURL=payloadReader.d.ts.map

package/dist/esm/internal/fdv2/payloadReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payloadReader.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/payloadReader.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAIvD,MAAM,WAAW,WAAW;IAC1B,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;CAClE;AAID,MAAM,WAAW,aAAa;IAC5B,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC;CACtC;AAGD,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAID,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAEzD;;;;GAIG;AACH,qBAAa,aAAa;IAiBtB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAlB3B,OAAO,CAAC,UAAU,CAAyB;IAE3C,OAAO,CAAC,OAAO,CAAC,CAAqB;IACrC,OAAO,CAAC,UAAU,CAAC,CAAsB;IACzC,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;;;OAOG;gBAED,WAAW,EAAE,WAAW,EACP,cAAc,EAAE,aAAa,EAC7B,aAAa,CAAC,eAAc,mBAAmB,WAAW,MAAM,KAAK,IAAI,aAAA,EACzE,OAAO,CAAC,sBAAU;IAUrC,kBAAkB,CAAC,QAAQ,EAAE,eAAe;IAI5C,qBAAqB,CAAC,QAAQ,EAAE,eAAe;IAO/C,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,oBAAoB,CAyB1B;IAEF,OAAO,CAAC,iBAAiB,CA0BvB;IAEF,OAAO,CAAC,oBAAoB,CAa1B;IAEF,OAAO,CAAC,0BAA0B,CAsBhC;IAEF,OAAO,CAAC,eAAe,CAKrB;IAEF,OAAO,CAAC,aAAa,CAKnB;IAEF,OAAO,CAAC,WAAW;CAKpB"}

package/dist/esm/internal/fdv2/proto.d.ts

@@ -0,0 +1,30 @@
+export interface Event {
+    event: string;
+    data: any;
+}
+export interface ServerIntentData {
+    payloads: PayloadIntent[];
+}
+export type IntentCode = 'xfer-full' | 'xfer-changes' | 'none';
+export interface PayloadIntent {
+    id: string;
+    target: number;
+    code: IntentCode;
+    reason: string;
+}
+export interface PutObject {
+    kind: string;
+    key: string;
+    version: number;
+    object: any;
+}
+export interface DeleteObject {
+    kind: string;
+    key: string;
+    version: number;
+}
+export interface PayloadTransferred {
+    state: string;
+    version: number;
+}
+//# sourceMappingURL=proto.d.ts.map

package/dist/esm/internal/fdv2/proto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proto.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/proto.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,cAAc,GAAG,MAAM,CAAC;AAE/D,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB"}

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

@@ -2,5 +2,5 @@ export * from './context';
 export * from './diagnostics';
 export * from './evaluation';
 export * from './events';
-export * from './stream';
+export * from './fdv2';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchdarkly/js-sdk-common",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "type": "module",
   "main": "./dist/esm/index.mjs",
   "types": "./dist/esm/index.d.ts",

package/dist/cjs/internal/stream/StreamingProcessor.d.ts

@@ -1,39 +0,0 @@
-import { EventName, ProcessStreamResponse } from '../../api';
-import { LDStreamProcessor } from '../../api/subsystem';
-import { ClientContext } from '../../options';
-import { LDHeaders } from '../../utils';
-import { DiagnosticsManager } from '../diagnostics';
-import { StreamingErrorHandler } from './types';
-declare class StreamingProcessor implements LDStreamProcessor {
-    private readonly _listeners;
-    private readonly _diagnosticsManager?;
-    private readonly _errorHandler?;
-    private readonly _streamInitialReconnectDelay;
-    private readonly _headers;
-    private readonly _streamUri;
-    private readonly _logger?;
-    private _eventSource?;
-    private _requests;
-    private _connectionAttemptStartTime?;
-    constructor(clientContext: ClientContext, streamUriPath: string, parameters: {
-        key: string;
-        value: string;
-    }[], _listeners: Map<EventName, ProcessStreamResponse>, baseHeaders: LDHeaders, _diagnosticsManager?: DiagnosticsManager | undefined, _errorHandler?: StreamingErrorHandler | undefined, _streamInitialReconnectDelay?: number);
-    private _logConnectionStarted;
-    private _logConnectionResult;
-    /**
-     * This is a wrapper around the passed errorHandler which adds additional
-     * diagnostics and logging logic.
-     *
-     * @param err The error to be logged and handled.
-     * @return boolean whether to retry the connection.
-     *
-     * @private
-     */
-    private _retryAndHandleError;
-    start(): void;
-    stop(): void;
-    close(): void;
-}
-export default StreamingProcessor;
-//# sourceMappingURL=StreamingProcessor.d.ts.map

package/dist/cjs/internal/stream/StreamingProcessor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StreamingProcessor.d.ts","sourceRoot":"","sources":["../../../src/internal/stream/StreamingProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAIT,qBAAqB,EAEtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,OAAO,EAAoB,SAAS,EAAe,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAgBhD,cAAM,kBAAmB,YAAW,iBAAiB;IAajD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAE3B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,4BAA4B;IAhB/C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuC;IAChE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAW;IAEpC,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,2BAA2B,CAAC,CAAS;gBAG3C,aAAa,EAAE,aAAa,EAC5B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,EAC3B,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,qBAAqB,CAAC,EAClE,WAAW,EAAE,SAAS,EACL,mBAAmB,CAAC,gCAAoB,EACxC,aAAa,CAAC,mCAAuB,EACrC,4BAA4B,SAAI;IAgBnD,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,oBAAoB;IAY5B;;;;;;;;OAQG;IACH,OAAO,CAAC,oBAAoB;IAgB5B,KAAK;IAuDL,IAAI;IAKJ,KAAK;CAGN;AAED,eAAe,kBAAkB,CAAC"}

package/dist/cjs/internal/stream/index.d.ts

@@ -1,5 +0,0 @@
-import StreamingProcessor from './StreamingProcessor';
-import type { StreamingErrorHandler } from './types';
-export { StreamingProcessor };
-export type { StreamingErrorHandler };
-//# sourceMappingURL=index.d.ts.map

package/dist/cjs/internal/stream/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/internal/stream/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,CAAC;AAC9B,YAAY,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/cjs/internal/stream/types.d.ts

@@ -1,3 +0,0 @@
-import { LDStreamingError } from '../../datasource/errors';
-export type StreamingErrorHandler = (err: LDStreamingError) => void;
-//# sourceMappingURL=types.d.ts.map

package/dist/cjs/internal/stream/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/internal/stream/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,MAAM,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC"}

package/dist/esm/internal/stream/StreamingProcessor.d.ts

@@ -1,39 +0,0 @@
-import { EventName, ProcessStreamResponse } from '../../api';
-import { LDStreamProcessor } from '../../api/subsystem';
-import { ClientContext } from '../../options';
-import { LDHeaders } from '../../utils';
-import { DiagnosticsManager } from '../diagnostics';
-import { StreamingErrorHandler } from './types';
-declare class StreamingProcessor implements LDStreamProcessor {
-    private readonly _listeners;
-    private readonly _diagnosticsManager?;
-    private readonly _errorHandler?;
-    private readonly _streamInitialReconnectDelay;
-    private readonly _headers;
-    private readonly _streamUri;
-    private readonly _logger?;
-    private _eventSource?;
-    private _requests;
-    private _connectionAttemptStartTime?;
-    constructor(clientContext: ClientContext, streamUriPath: string, parameters: {
-        key: string;
-        value: string;
-    }[], _listeners: Map<EventName, ProcessStreamResponse>, baseHeaders: LDHeaders, _diagnosticsManager?: DiagnosticsManager | undefined, _errorHandler?: StreamingErrorHandler | undefined, _streamInitialReconnectDelay?: number);
-    private _logConnectionStarted;
-    private _logConnectionResult;
-    /**
-     * This is a wrapper around the passed errorHandler which adds additional
-     * diagnostics and logging logic.
-     *
-     * @param err The error to be logged and handled.
-     * @return boolean whether to retry the connection.
-     *
-     * @private
-     */
-    private _retryAndHandleError;
-    start(): void;
-    stop(): void;
-    close(): void;
-}
-export default StreamingProcessor;
-//# sourceMappingURL=StreamingProcessor.d.ts.map

package/dist/esm/internal/stream/StreamingProcessor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StreamingProcessor.d.ts","sourceRoot":"","sources":["../../../src/internal/stream/StreamingProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAIT,qBAAqB,EAEtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,OAAO,EAAoB,SAAS,EAAe,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAgBhD,cAAM,kBAAmB,YAAW,iBAAiB;IAajD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAE3B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,4BAA4B;IAhB/C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuC;IAChE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAW;IAEpC,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,2BAA2B,CAAC,CAAS;gBAG3C,aAAa,EAAE,aAAa,EAC5B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,EAC3B,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,qBAAqB,CAAC,EAClE,WAAW,EAAE,SAAS,EACL,mBAAmB,CAAC,gCAAoB,EACxC,aAAa,CAAC,mCAAuB,EACrC,4BAA4B,SAAI;IAgBnD,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,oBAAoB;IAY5B;;;;;;;;OAQG;IACH,OAAO,CAAC,oBAAoB;IAgB5B,KAAK;IAuDL,IAAI;IAKJ,KAAK;CAGN;AAED,eAAe,kBAAkB,CAAC"}

package/dist/esm/internal/stream/index.d.ts

@@ -1,5 +0,0 @@
-import StreamingProcessor from './StreamingProcessor';
-import type { StreamingErrorHandler } from './types';
-export { StreamingProcessor };
-export type { StreamingErrorHandler };
-//# sourceMappingURL=index.d.ts.map

package/dist/esm/internal/stream/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/internal/stream/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,CAAC;AAC9B,YAAY,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/esm/internal/stream/types.d.ts

@@ -1,3 +0,0 @@
-import { LDStreamingError } from '../../datasource/errors';
-export type StreamingErrorHandler = (err: LDStreamingError) => void;
-//# sourceMappingURL=types.d.ts.map

package/dist/esm/internal/stream/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/internal/stream/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,MAAM,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC"}