@launchdarkly/js-sdk-common 2.19.0 → 2.20.0

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

@@ -0,0 +1,43 @@
+import { PayloadProcessor } from './payloadProcessor';
+interface fdv1Payload {
+    flags: {
+        [name: string]: any;
+    };
+    segments: {
+        [name: string]: any;
+    };
+}
+/**
+ * The FDv1PayloadAdaptor is a helper class that converts FDv1 payloads into events that the PayloadProcessor can understand.
+ */
+export interface FDv1PayloadAdaptor {
+    /**
+     * The PayloadProcessor that will be used to process the events.
+     */
+    readonly _processor: PayloadProcessor;
+    /**
+     * The selector that will be used to identify the payload.
+     */
+    _selector: string;
+    /**
+     * The method that will be used to set a selector for the payload that is
+     * being processed.
+     *
+     * @remarks
+     * This method probably shouldn't be used in most instances as FDv1 payloads
+     * do not have the concept of a selector.
+     *
+     * @param selector - The selector to set for the payload.
+     * @returns this FDv1PayloadAdaptor instance
+     */
+    useSelector: (selector: string) => FDv1PayloadAdaptor;
+    /**
+     * The method that will be used to process a full transfer changeset.
+     *
+     * @param data - The data to process.
+     */
+    processFullTransfer: (data: fdv1Payload) => void;
+}
+export declare function fdv1PayloadAdaptor(processor: PayloadProcessor): FDv1PayloadAdaptor;
+export {};
+//# sourceMappingURL=FDv1PayloadAdaptor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FDv1PayloadAdaptor.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/FDv1PayloadAdaptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD,UAAU,WAAW;IACnB,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC/B,QAAQ,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACnC;AAID;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;IAEtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;OAUG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,kBAAkB,CAAC;IAEtD;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;CAClD;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,GAAG,kBAAkB,CA+DlF"}

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

@@ -1,4 +1,5 @@
+import { fdv1PayloadAdaptor as FDv1PayloadAdaptor } from './FDv1PayloadAdaptor';
 import { FDv2EventsCollection, Payload, PayloadListener, PayloadProcessor, Update } from './payloadProcessor';
 import { PayloadStreamReader } from './payloadStreamReader';
-export { FDv2EventsCollection, Payload, PayloadListener, PayloadProcessor, PayloadStreamReader, Update, };
+export { FDv2EventsCollection, Payload, PayloadListener, PayloadProcessor, PayloadStreamReader, Update, FDv1PayloadAdaptor, };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,MAAM,EACP,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,MAAM,GACP,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,MAAM,EACP,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,MAAM,EACN,kBAAkB,GACnB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"payloadProcessor.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/payloadProcessor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAWvD,MAAM,WAAW,aAAa;IAC5B,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC;CACtC;AAGD,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAGD,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,CAAC;CACX;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,CAAC,EAAE,MAAM,CAAC;IACf,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,gBAAgB;IAezB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAhB3B,OAAO,CAAC,UAAU,CAAyB;IAE3C,OAAO,CAAC,OAAO,CAAC,CAAqB;IACrC,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;;OAMG;gBAEgB,cAAc,EAAE,aAAa,EAC7B,aAAa,CAAC,eAAc,mBAAmB,WAAW,MAAM,KAAK,IAAI,aAAA,EACzE,OAAO,CAAC,sBAAU;IAGrC,kBAAkB,CAAC,QAAQ,EAAE,eAAe;IAI5C,qBAAqB,CAAC,QAAQ,EAAE,eAAe;IAO/C;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,SAAS,EAAE;IAkCjC,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,oBAAoB,CA6B1B;IAEF,OAAO,CAAC,iBAAiB,CA0BvB;IAEF,OAAO,CAAC,oBAAoB,CAa1B;IAEF,OAAO,CAAC,kBAAkB,CAgBxB;IAEF,OAAO,CAAC,0BAA0B,CAqBhC;IAEF,OAAO,CAAC,eAAe,CAKrB;IAEF,OAAO,CAAC,aAAa,CAKnB;IAEF,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,SAAS;CAKlB"}
+{"version":3,"file":"payloadProcessor.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/payloadProcessor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAWvD,MAAM,WAAW,aAAa;IAC5B,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC;CACtC;AAGD,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAGD,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,CAAC;CACX;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,CAAC,EAAE,MAAM,CAAC;IACf,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,gBAAgB;IAezB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAhB3B,OAAO,CAAC,UAAU,CAAyB;IAE3C,OAAO,CAAC,OAAO,CAAC,CAAqB;IACrC,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;;OAMG;gBAEgB,cAAc,EAAE,aAAa,EAC7B,aAAa,CAAC,eAAc,mBAAmB,WAAW,MAAM,KAAK,IAAI,aAAA,EACzE,OAAO,CAAC,sBAAU;IAGrC,kBAAkB,CAAC,QAAQ,EAAE,eAAe;IAI5C,qBAAqB,CAAC,QAAQ,EAAE,eAAe;IAO/C;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,SAAS,EAAE;IAkCjC,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,oBAAoB,CA6B1B;IAEF,OAAO,CAAC,iBAAiB,CA0BvB;IAEF,OAAO,CAAC,oBAAoB,CAa1B;IAEF,OAAO,CAAC,kBAAkB,CAgBxB;IAEF,OAAO,CAAC,0BAA0B,CAwBhC;IAEF,OAAO,CAAC,eAAe,CAKrB;IAEF,OAAO,CAAC,aAAa,CAKnB;IAEF,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,SAAS;CAKlB"}

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

@@ -1,11 +1,13 @@
+export type EventType = 'server-intent' | 'put-object' | 'delete-object' | 'payload-transferred' | 'goodbye' | 'error' | 'heart-beat';
+export type IntentCode = 'xfer-full' | 'xfer-changes' | 'none';
+export type ObjectKind = 'flag' | 'segment';
 export interface Event {
-    event: string;
-    data: any;
+    event: EventType;
+    data: ServerIntentData | PutObject | DeleteObject | PayloadTransferred | GoodbyeObject | ErrorObject;
 }
 export interface ServerIntentData {
     payloads: PayloadIntent[];
 }
-export type IntentCode = 'xfer-full' | 'xfer-changes' | 'none';
 export interface PayloadIntent {
     id: string;
     target: number;
@@ -13,18 +15,28 @@ export interface PayloadIntent {
     reason: string;
 }
 export interface PutObject {
-    kind: string;
+    kind: ObjectKind;
     key: string;
     version: number;
     object: any;
 }
 export interface DeleteObject {
-    kind: string;
+    kind: ObjectKind;
     key: string;
     version: number;
 }
+export interface GoodbyeObject {
+    reason: string;
+    silent: boolean;
+    catastrophe: boolean;
+}
+export interface ErrorObject {
+    payload_id: string;
+    reason: string;
+}
 export interface PayloadTransferred {
     state: string;
     version: number;
+    id?: string;
 }
 //# sourceMappingURL=proto.d.ts.map

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

@@ -1 +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,UAAU,EAAE,UAAU,CAAC;IACvB,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"}
+{"version":3,"file":"proto.d.ts","sourceRoot":"","sources":["../../../src/internal/fdv2/proto.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACjB,eAAe,GACf,YAAY,GACZ,eAAe,GACf,qBAAqB,GACrB,SAAS,GACT,OAAO,GACP,YAAY,CAAC;AACjB,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,cAAc,GAAG,MAAM,CAAC;AAC/D,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAE5C,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,SAAS,CAAC;IACjB,IAAI,EACA,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,kBAAkB,GAClB,aAAa,GACb,WAAW,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb"}

package/package.json

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