@featbit/js-client-sdk 2.0.1 → 3.0.0

package/dist/esm/options/Validators.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Interface for type validation.
+ */
+export interface TypeValidator {
+    messages?: string[];
+    is(u: unknown): boolean;
+    getType(): string;
+}
+/**
+ * Validate a factory or instance.
+ */
+export declare class FactoryOrInstance implements TypeValidator {
+    is(factoryOrInstance: unknown): boolean;
+    getType(): string;
+}
+/**
+ * Validate a basic type.
+ */
+export declare class Type<T> implements TypeValidator {
+    private typeName;
+    protected typeOf: string;
+    constructor(typeName: string, example: T);
+    is(u: unknown): u is T;
+    getType(): string;
+}
+/**
+ * Validate an array of the specified type.
+ *
+ * This does not validate instances of types. All class instances
+ * of classes will simply objects.
+ */
+export declare class TypeArray<T> implements TypeValidator {
+    private typeName;
+    protected typeOf: string;
+    constructor(typeName: string, example: T);
+    is(u: unknown): u is T;
+    getType(): string;
+}
+/**
+ * Validate a value is a number and is greater or eval than a minimum.
+ */
+export declare class NumberWithMinimum extends Type<number> {
+    readonly min: number;
+    constructor(min: number);
+    is(u: unknown): u is number;
+}
+/**
+ * Validate a value is a string and it matches the given expression.
+ */
+export declare class StringMatchingRegex extends Type<string> {
+    readonly expression: RegExp;
+    constructor(expression: RegExp);
+    is(u: unknown): u is string;
+}
+/**
+ * Validate a value is a function.
+ */
+export declare class Function implements TypeValidator {
+    is(u: unknown): u is (...args: any[]) => void;
+    getType(): string;
+}
+export declare class NullableBoolean implements TypeValidator {
+    is(u: unknown): boolean;
+    getType(): string;
+}
+export declare class BootstrapValidator implements TypeValidator {
+    messages: string[];
+    is(u: unknown): boolean;
+    getType(): string;
+}
+export declare class UserValidator implements TypeValidator {
+    messages: string[];
+    is(u: unknown): boolean;
+    getType(): string;
+}
+/**
+ * Validate a value is a date. Values which are numbers are treated as dates and any string
+ * which if compliant with `time.RFC3339Nano` is a date.
+ */
+export declare class DateValidator implements TypeValidator {
+    is(u: unknown): boolean;
+    getType(): string;
+}
+/**
+ * Validates that a string is a valid kind.
+ */
+export declare class KindValidator extends StringMatchingRegex {
+    constructor();
+    is(u: unknown): u is string;
+}
+/**
+ * A set of standard type validators.
+ */
+export declare class TypeValidators {
+    static readonly String: Type<string>;
+    static readonly Number: Type<number>;
+    static readonly ObjectOrFactory: FactoryOrInstance;
+    static readonly Object: Type<object>;
+    static readonly StringArray: TypeArray<string>;
+    static readonly Boolean: Type<boolean>;
+    static readonly User: Type<object>;
+    static readonly Bootstrap: Type<object>;
+    static readonly Function: Function;
+    static createTypeArray<T>(typeName: string, example: T): TypeArray<T>;
+    static numberWithMin(min: number): NumberWithMinimum;
+    static stringMatchingRegex(expression: RegExp): StringMatchingRegex;
+    static readonly Date: DateValidator;
+    static readonly Kind: KindValidator;
+    static readonly NullableBoolean: NullableBoolean;
+}
+//# sourceMappingURL=Validators.d.ts.map

package/dist/esm/options/Validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validators.d.ts","sourceRoot":"","sources":["../../../src/options/Validators.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAExB,OAAO,IAAI,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,aAAa;IACrD,EAAE,CAAC,iBAAiB,EAAE,OAAO;IAS7B,OAAO,IAAI,MAAM;CAGlB;AAED;;GAEG;AACH,qBAAa,IAAI,CAAC,CAAC,CAAE,YAAW,aAAa;IAC3C,OAAO,CAAC,QAAQ,CAAS;IAEzB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEb,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAKxC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC;IAOtB,OAAO,IAAI,MAAM;CAGlB;AAED;;;;;GAKG;AACH,qBAAa,SAAS,CAAC,CAAC,CAAE,YAAW,aAAa;IAChD,OAAO,CAAC,QAAQ,CAAS;IAEzB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEb,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAKxC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC;IAUtB,OAAO,IAAI,MAAM;CAGlB;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,IAAI,CAAC,MAAM,CAAC;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;gBAET,GAAG,EAAE,MAAM;IAKd,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM;CAGrC;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,IAAI,CAAC,MAAM,CAAC;IACnD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;gBAEhB,UAAU,EAAE,MAAM;IAKrB,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM;CAGrC;AAED;;GAEG;AACH,qBAAa,QAAS,YAAW,aAAa;IAC5C,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAQ7C,OAAO,IAAI,MAAM;CAGlB;AAED,qBAAa,eAAgB,YAAW,aAAa;IACnD,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO;IAIvB,OAAO,IAAI,MAAM;CAGlB;AAED,qBAAa,kBAAmB,YAAW,aAAa;IACtD,QAAQ,EAAE,MAAM,EAAE,CAAM;IAExB,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO;IAgCvB,OAAO,IAAI,MAAM;CAGlB;AAED,qBAAa,aAAc,YAAW,aAAa;IACjD,QAAQ,EAAE,MAAM,EAAE,CAAM;IAExB,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO;IAqBvB,OAAO,IAAI,MAAM;CAGlB;AAUD;;;GAGG;AACH,qBAAa,aAAc,YAAW,aAAa;IACjD,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO;IAIvB,OAAO,IAAI,MAAM;CAGlB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,mBAAmB;;IAK3C,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM;CAGrC;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB,MAAM,CAAC,QAAQ,CAAC,MAAM,eAAkC;IAExD,MAAM,CAAC,QAAQ,CAAC,MAAM,eAAiC;IAEvD,MAAM,CAAC,QAAQ,CAAC,eAAe,oBAA2B;IAE1D,MAAM,CAAC,QAAQ,CAAC,MAAM,eAAkC;IAExD,MAAM,CAAC,QAAQ,CAAC,WAAW,oBAAyC;IAEpE,MAAM,CAAC,QAAQ,CAAC,OAAO,gBAAsC;IAE7D,MAAM,CAAC,QAAQ,CAAC,IAAI,eAAkC;IAEtD,MAAM,CAAC,QAAQ,CAAC,SAAS,eAAkC;IAE3D,MAAM,CAAC,QAAQ,CAAC,QAAQ,WAAkB;IAE1C,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAItD,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB;IAIpD,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB;IAInE,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAuB;IAE3C,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAuB;IAC3C,MAAM,CAAC,QAAQ,CAAC,eAAe,kBAAyB;CACzD"}

package/dist/esm/options/Validators.js

@@ -0,0 +1,247 @@
+"use strict";
+/* eslint-disable class-methods-use-this */
+/* eslint-disable max-classes-per-file */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeValidators = exports.KindValidator = exports.DateValidator = exports.UserValidator = exports.BootstrapValidator = exports.NullableBoolean = exports.Function = exports.StringMatchingRegex = exports.NumberWithMinimum = exports.TypeArray = exports.Type = exports.FactoryOrInstance = void 0;
+// The classes here are static, but needs to be instantiated to
+// support the generic functionality. Which is why we do not care about using
+// `this`
+// These validators are also of trivial complexity, so we are allowing more than
+// one per file.
+const OptionMessages_1 = __importDefault(require("./OptionMessages"));
+/**
+ * Validate a factory or instance.
+ */
+class FactoryOrInstance {
+    is(factoryOrInstance) {
+        if (Array.isArray(factoryOrInstance)) {
+            return false;
+        }
+        const anyFactory = factoryOrInstance;
+        const typeOfFactory = typeof anyFactory;
+        return typeOfFactory === 'function' || typeOfFactory === 'object';
+    }
+    getType() {
+        return 'factory method or object';
+    }
+}
+exports.FactoryOrInstance = FactoryOrInstance;
+/**
+ * Validate a basic type.
+ */
+class Type {
+    constructor(typeName, example) {
+        this.typeName = typeName;
+        this.typeOf = typeof example;
+    }
+    is(u) {
+        if (Array.isArray(u)) {
+            return false;
+        }
+        return typeof u === this.typeOf;
+    }
+    getType() {
+        return this.typeName;
+    }
+}
+exports.Type = Type;
+/**
+ * Validate an array of the specified type.
+ *
+ * This does not validate instances of types. All class instances
+ * of classes will simply objects.
+ */
+class TypeArray {
+    constructor(typeName, example) {
+        this.typeName = typeName;
+        this.typeOf = typeof example;
+    }
+    is(u) {
+        if (Array.isArray(u)) {
+            if (u.length > 0) {
+                return u.every((val) => typeof val === this.typeOf);
+            }
+            return true;
+        }
+        return false;
+    }
+    getType() {
+        return this.typeName;
+    }
+}
+exports.TypeArray = TypeArray;
+/**
+ * Validate a value is a number and is greater or eval than a minimum.
+ */
+class NumberWithMinimum extends Type {
+    constructor(min) {
+        super(`number with minimum value of ${min}`, 0);
+        this.min = min;
+    }
+    is(u) {
+        return typeof u === this.typeOf && u >= this.min;
+    }
+}
+exports.NumberWithMinimum = NumberWithMinimum;
+/**
+ * Validate a value is a string and it matches the given expression.
+ */
+class StringMatchingRegex extends Type {
+    constructor(expression) {
+        super(`string matching ${expression}`, '');
+        this.expression = expression;
+    }
+    is(u) {
+        return !!u.match(this.expression);
+    }
+}
+exports.StringMatchingRegex = StringMatchingRegex;
+/**
+ * Validate a value is a function.
+ */
+class Function {
+    is(u) {
+        // We cannot inspect the parameters and there isn't really
+        // a generic function type we can instantiate.
+        // So the type guard is here just to make TS comfortable
+        // calling something after using this guard.
+        return typeof u === 'function';
+    }
+    getType() {
+        return 'function';
+    }
+}
+exports.Function = Function;
+class NullableBoolean {
+    is(u) {
+        return typeof u === 'boolean' || typeof u === 'undefined' || u === null;
+    }
+    getType() {
+        return 'boolean | undefined | null';
+    }
+}
+exports.NullableBoolean = NullableBoolean;
+class BootstrapValidator {
+    constructor() {
+        this.messages = [];
+    }
+    is(u) {
+        if (typeof u !== 'object' || u === null) {
+            this.messages.push(OptionMessages_1.default.invalidOptionValue('bootstrap'));
+            return false;
+        }
+        try {
+            const bootstrap = u;
+            for (let flag of bootstrap) {
+                const hasMandatoryKeys = ['id', 'variation'].every((key) => Object.keys(flag).includes(key));
+                const keys = Object.keys(flag);
+                if (keys.includes('id')) {
+                    this.messages.push(OptionMessages_1.default.missingKeyInBootstrapValue('id'));
+                }
+                if (keys.includes('variation')) {
+                    this.messages.push(OptionMessages_1.default.missingKeyInBootstrapValue('variation'));
+                }
+                if (this.messages.length > 0) {
+                    return false;
+                }
+            }
+        }
+        catch (_) {
+            this.messages.push(OptionMessages_1.default.wrongOptionType('bootstrap', this.getType(), typeof u));
+            return false;
+        }
+        return true;
+    }
+    getType() {
+        return 'IFlagBase[]';
+    }
+}
+exports.BootstrapValidator = BootstrapValidator;
+class UserValidator {
+    constructor() {
+        this.messages = [];
+    }
+    is(u) {
+        if (typeof u !== 'object' || u === null) {
+            this.messages.push(OptionMessages_1.default.mandatory('user'));
+            return false;
+        }
+        const user = u;
+        if (typeof user.keyId !== 'string' || user.keyId.trim() === '') {
+            this.messages.push(OptionMessages_1.default.mandatory('user.keyId'));
+            return false;
+        }
+        if (typeof user.name !== 'string' || user.name.trim() === '') {
+            this.messages.push(OptionMessages_1.default.mandatory('user.name'));
+            return false;
+        }
+        return true;
+    }
+    getType() {
+        return 'user';
+    }
+}
+exports.UserValidator = UserValidator;
+// Our reference SDK, Go, parses date/time strings with the time.RFC3339Nano format.
+// This regex should match strings that are valid in that format, and no others.
+// Acceptable:
+//   2019-10-31T23:59:59Z, 2019-10-31T23:59:59.100Z,
+//   2019-10-31T23:59:59-07, 2019-10-31T23:59:59-07:00, etc.
+// Unacceptable: no "T", no time zone designation
+const DATE_REGEX = /^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d\d*)?(Z|[-+]\d\d(:\d\d)?)/;
+/**
+ * Validate a value is a date. Values which are numbers are treated as dates and any string
+ * which if compliant with `time.RFC3339Nano` is a date.
+ */
+class DateValidator {
+    is(u) {
+        return typeof u === 'number' || (typeof u === 'string' && DATE_REGEX.test(u));
+    }
+    getType() {
+        return 'date';
+    }
+}
+exports.DateValidator = DateValidator;
+/**
+ * Validates that a string is a valid kind.
+ */
+class KindValidator extends StringMatchingRegex {
+    constructor() {
+        super(/^(\w|\.|-)+$/);
+    }
+    is(u) {
+        return super.is(u) && u !== 'kind';
+    }
+}
+exports.KindValidator = KindValidator;
+/**
+ * A set of standard type validators.
+ */
+class TypeValidators {
+    static createTypeArray(typeName, example) {
+        return new TypeArray(typeName, example);
+    }
+    static numberWithMin(min) {
+        return new NumberWithMinimum(min);
+    }
+    static stringMatchingRegex(expression) {
+        return new StringMatchingRegex(expression);
+    }
+}
+exports.TypeValidators = TypeValidators;
+TypeValidators.String = new Type('string', '');
+TypeValidators.Number = new Type('number', 0);
+TypeValidators.ObjectOrFactory = new FactoryOrInstance();
+TypeValidators.Object = new Type('object', {});
+TypeValidators.StringArray = new TypeArray('string[]', '');
+TypeValidators.Boolean = new Type('boolean', true);
+TypeValidators.User = new Type('object', {});
+TypeValidators.Bootstrap = new Type('object', {});
+TypeValidators.Function = new Function();
+TypeValidators.Date = new DateValidator();
+TypeValidators.Kind = new KindValidator();
+TypeValidators.NullableBoolean = new NullableBoolean();
+//# sourceMappingURL=Validators.js.map

package/dist/esm/options/Validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validators.js","sourceRoot":"","sources":["../../../src/options/Validators.ts"],"names":[],"mappings":";AAAA,2CAA2C;AAC3C,yCAAyC;;;;;;AAEzC,+DAA+D;AAC/D,6EAA6E;AAC7E,SAAS;AAET,gFAAgF;AAChF,gBAAgB;AAEhB,sEAA8C;AAe9C;;GAEG;AACH,MAAa,iBAAiB;IAC5B,EAAE,CAAC,iBAA0B;QAC3B,IAAI,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE;YACpC,OAAO,KAAK,CAAC;SACd;QACD,MAAM,UAAU,GAAG,iBAAwB,CAAC;QAC5C,MAAM,aAAa,GAAG,OAAO,UAAU,CAAC;QACxC,OAAO,aAAa,KAAK,UAAU,IAAI,aAAa,KAAK,QAAQ,CAAC;IACpE,CAAC;IAED,OAAO;QACL,OAAO,0BAA0B,CAAC;IACpC,CAAC;CACF;AAbD,8CAaC;AAED;;GAEG;AACH,MAAa,IAAI;IAKf,YAAY,QAAgB,EAAE,OAAU;QACtC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,OAAO,OAAO,CAAC;IAC/B,CAAC;IAED,EAAE,CAAC,CAAU;QACX,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACpB,OAAO,KAAK,CAAC;SACd;QACD,OAAO,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC;IAClC,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AApBD,oBAoBC;AAED;;;;;GAKG;AACH,MAAa,SAAS;IAKpB,YAAY,QAAgB,EAAE,OAAU;QACtC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,OAAO,OAAO,CAAC;IAC/B,CAAC;IAED,EAAE,CAAC,CAAU;QACX,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACpB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBAChB,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;aACrD;YACD,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAvBD,8BAuBC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,IAAY;IAGjD,YAAY,GAAW;QACrB,KAAK,CAAC,gCAAiC,GAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAEQ,EAAE,CAAC,CAAU;QACpB,OAAO,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,IAAK,CAAY,IAAI,IAAI,CAAC,GAAG,CAAC;IAC/D,CAAC;CACF;AAXD,8CAWC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,IAAY;IAGnD,YAAY,UAAkB;QAC5B,KAAK,CAAC,mBAAoB,UAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEQ,EAAE,CAAC,CAAU;QACpB,OAAO,CAAC,CAAE,CAAY,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAChD,CAAC;CACF;AAXD,kDAWC;AAED;;GAEG;AACH,MAAa,QAAQ;IACnB,EAAE,CAAC,CAAU;QACX,0DAA0D;QAC1D,8CAA8C;QAC9C,wDAAwD;QACxD,4CAA4C;QAC5C,OAAO,OAAO,CAAC,KAAK,UAAU,CAAC;IACjC,CAAC;IAED,OAAO;QACL,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAZD,4BAYC;AAED,MAAa,eAAe;IAC1B,EAAE,CAAC,CAAU;QACX,OAAO,OAAO,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,WAAW,IAAI,CAAC,KAAK,IAAI,CAAC;IAC1E,CAAC;IAED,OAAO;QACL,OAAO,4BAA4B,CAAC;IACtC,CAAC;CACF;AARD,0CAQC;AAED,MAAa,kBAAkB;IAA/B;QACE,aAAQ,GAAa,EAAE,CAAC;IAqC1B,CAAC;IAnCC,EAAE,CAAC,CAAU;QACX,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,EAAE;YACvC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,wBAAc,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC;YACnE,OAAO,KAAK,CAAC;SACd;QAED,IAAI;YACF,MAAM,SAAS,GAAG,CAAgB,CAAC;YACnC,KAAK,IAAI,IAAI,IAAI,SAAS,EAAE;gBAC1B,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC7F,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAE/B,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;oBACvB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,wBAAc,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAC;iBACrE;gBAED,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;oBAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,wBAAc,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,CAAC;iBAC5E;gBAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC5B,OAAO,KAAK,CAAC;iBACd;aACF;SACF;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,wBAAc,CAAC,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1F,OAAO,KAAK,CAAC;SACd;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAtCD,gDAsCC;AAED,MAAa,aAAa;IAA1B;QACE,aAAQ,GAAa,EAAE,CAAC;IA0B1B,CAAC;IAxBC,EAAE,CAAC,CAAU;QACX,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,EAAE;YACvC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,wBAAc,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACrD,OAAO,KAAK,CAAC;SACd;QAED,MAAM,IAAI,GAAG,CAAQ,CAAC;QAEtB,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC9D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,wBAAc,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;YAC3D,OAAO,KAAK,CAAC;SACd;QAED,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC5D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,wBAAc,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;YAC1D,OAAO,KAAK,CAAC;SACd;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA3BD,sCA2BC;AAED,oFAAoF;AACpF,gFAAgF;AAChF,cAAc;AACd,oDAAoD;AACpD,4DAA4D;AAC5D,iDAAiD;AACjD,MAAM,UAAU,GAAG,kEAAkE,CAAC;AAEtF;;;GAGG;AACH,MAAa,aAAa;IACxB,EAAE,CAAC,CAAU;QACX,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,OAAO;QACL,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AARD,sCAQC;AAED;;GAEG;AACH,MAAa,aAAc,SAAQ,mBAAmB;IACpD;QACE,KAAK,CAAC,cAAc,CAAC,CAAC;IACxB,CAAC;IAEQ,EAAE,CAAC,CAAU;QACpB,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;IACrC,CAAC;CACF;AARD,sCAQC;AAED;;GAEG;AACH,MAAa,cAAc;IAmBzB,MAAM,CAAC,eAAe,CAAI,QAAgB,EAAE,OAAU;QACpD,OAAO,IAAI,SAAS,CAAI,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,GAAW;QAC9B,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,UAAkB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC;;AA7BH,wCAmCC;AAlCiB,qBAAM,GAAG,IAAI,IAAI,CAAS,QAAQ,EAAE,EAAE,CAAC,CAAC;AAExC,qBAAM,GAAG,IAAI,IAAI,CAAS,QAAQ,EAAE,CAAC,CAAC,CAAC;AAEvC,8BAAe,GAAG,IAAI,iBAAiB,EAAE,CAAC;AAE1C,qBAAM,GAAG,IAAI,IAAI,CAAS,QAAQ,EAAE,EAAE,CAAC,CAAC;AAExC,0BAAW,GAAG,IAAI,SAAS,CAAS,UAAU,EAAE,EAAE,CAAC,CAAC;AAEpD,sBAAO,GAAG,IAAI,IAAI,CAAU,SAAS,EAAE,IAAI,CAAC,CAAC;AAE7C,mBAAI,GAAG,IAAI,IAAI,CAAS,QAAQ,EAAE,EAAE,CAAC,CAAC;AAEtC,wBAAS,GAAG,IAAI,IAAI,CAAS,QAAQ,EAAE,EAAE,CAAC,CAAC;AAE3C,uBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;AAc1B,mBAAI,GAAG,IAAI,aAAa,EAAE,CAAC;AAE3B,mBAAI,GAAG,IAAI,aAAa,EAAE,CAAC;AAC3B,8BAAe,GAAG,IAAI,eAAe,EAAE,CAAC"}

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

@@ -0,0 +1,9 @@
+export * from './ClientContext';
+export * from './IClientContext';
+export * from './IOptions';
+export * from './IUser';
+export * from './IValidatedOptions';
+export * from './OptionMessages';
+export * from './UserBuilder';
+export * from './Validators';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/options/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC"}

package/dist/esm/options/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ClientContext"), exports);
+__exportStar(require("./IClientContext"), exports);
+__exportStar(require("./IOptions"), exports);
+__exportStar(require("./IUser"), exports);
+__exportStar(require("./IValidatedOptions"), exports);
+__exportStar(require("./OptionMessages"), exports);
+__exportStar(require("./UserBuilder"), exports);
+__exportStar(require("./Validators"), exports);
+//# sourceMappingURL=index.js.map

package/dist/esm/options/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/options/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,mDAAiC;AACjC,6CAA2B;AAC3B,0CAAwB;AACxB,sDAAoC;AACpC,mDAAiC;AACjC,gDAA8B;AAC9B,+CAA6B"}

package/dist/esm/platform/IInfo.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Information about the platform of the SDK and the environment it is executing.
+ */
+export interface IPlatformData {
+    /**
+     * Information about the OS on which the SDK is running. Should be populated
+     * when available. Not all platforms will make this data accessible.
+     */
+    os?: {
+        /**
+         * The architecture. Ideally at runtime, but may be build time if that is
+         * a constraint.
+         */
+        arch?: string;
+        /**
+         * The name of the OS. "MacOS", "Windows", or "Linux". If not one of those,
+         * then use the value provided by the OS.
+         */
+        name?: string;
+        /** The version of the OS. */
+        version?: string;
+    };
+    /**
+     * The name of the platform the SDK is running on. For instance 'Node'.
+     */
+    name?: string;
+    /**
+     * Any additional attributes associated with the platform.
+     */
+    additional?: Record<string, string>;
+}
+export interface ISdkData {
+    /**
+     * The name of the SDK. e.g. "browser-server-sdk"
+     */
+    name?: string;
+    /**
+     * 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.
+     */
+    wrapperName?: string;
+    /**
+     * Version of the wrapper if present.
+     */
+    wrapperVersion?: string;
+}
+/**
+ * Interface for getting information about the SDK or the environment it is
+ * executing in.
+ */
+export interface IInfo {
+    /**
+     * Get the app type
+     */
+    get appType(): string;
+    /**
+     * Get information about the platform.
+     */
+    platformData(): IPlatformData;
+    /**
+     * Get information about the SDK implementation.
+     */
+    sdkData(): ISdkData;
+}
+//# sourceMappingURL=IInfo.d.ts.map

package/dist/esm/platform/IInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInfo.d.ts","sourceRoot":"","sources":["../../../src/platform/IInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;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,QAAQ;IACvB;;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,KAAK;IACpB;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,IAAI,aAAa,CAAC;IAE9B;;OAEG;IACH,OAAO,IAAI,QAAQ,CAAC;CACrB"}

package/dist/esm/platform/IInfo.js

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

package/dist/esm/platform/IInfo.js.map

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

package/dist/esm/platform/IPlatform.d.ts

@@ -0,0 +1,19 @@
+import { IRequests } from "./requests";
+import { IInfo } from "./IInfo";
+import { IWebSocketWithEvents } from "./IWebSocket";
+export interface IPlatform {
+    /**
+     * The interface for getting information about the platform and the execution
+     * environment.
+     */
+    info: IInfo;
+    /**
+     * The interface for performing http/https requests.
+     */
+    requests: IRequests;
+    /**
+     * The interface for performing websocket connections.
+     */
+    webSocket: IWebSocketWithEvents;
+}
+//# sourceMappingURL=IPlatform.d.ts.map

package/dist/esm/platform/IPlatform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPlatform.d.ts","sourceRoot":"","sources":["../../../src/platform/IPlatform.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,oBAAoB,CAAC;CACjC"}

package/dist/esm/platform/IPlatform.js

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

package/dist/esm/platform/IPlatform.js.map

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

package/dist/esm/platform/IStore.d.ts

@@ -0,0 +1,110 @@
+import { IDataKind } from "../IDataKind";
+import { IKeyedStoreItem, IStoreDataStorage, IStoreItem, IStoreKindData } from "../store/store";
+import { IUser } from "../options/IUser";
+/**
+ * Interface for a feature store component.
+ *
+ * The feature store is what the client uses to store feature flag data that has been received
+ * from FeatBit. By default, it uses an in-memory implementation; database integrations are
+ * also available. Read the [SDK features guide](xxx).
+ * You will not need to use this interface unless you are writing your own implementation.
+ *
+ * Feature store methods can and should call their callbacks directly whenever possible, rather
+ * than deferring them with setImmediate() or process.nextTick(). This means that if for any
+ * reason you are updating or querying a feature store directly in your application code (which
+ * is not part of normal use of the SDK) you should be aware that the callback may be executed
+ * immediately.
+ */
+export interface IStore {
+    /**
+     * Set the current user of the store.
+     *
+     * @param user
+     *   The current user. The actual type of this parameter is
+     *   {@link IUser}.
+     */
+    identify(user: IUser): void;
+    /**
+     * Get the current user of the store.
+     */
+    user: IUser;
+    /**
+     * Get an entity from the store.
+     *
+     * The store should treat any entity with the property `deleted: true` as "not found".
+     *
+     * @param kind
+     *   The type of data to be accessed. The store should not make any assumptions about the format
+     *   of the data, but just return a JSON object. The actual type of this parameter is
+     *   {@link DataKind}.
+     *
+     * @param key
+     *   The unique key of the entity within the specified collection.
+     */
+    get(kind: IDataKind, key: string): IStoreItem | null;
+    /**
+     * Get all entities from a collection.
+     *
+     * The store should filter out any entities with the property `deleted: true`.
+     *
+     * @param kind
+     *   The type of data to be accessed. The store should not make any assumptions about the format
+     *   of the data, but just return an object in which each key is the `key` property of an entity
+     *   and the value is the entity. The actual type of this parameter is
+     *   {@link IDataKind}.
+     */
+    all(kind: IDataKind): [IStoreKindData, number];
+    /**
+     * Initialize the store, overwriting any existing data.
+     *
+     * @param allData
+     *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
+     *   the value is an object that maps keys to entities. The actual type of this parameter is
+     *   `interfaces.FullDataSet<VersionedData>`.
+     *
+     * @param callback
+     *   Will be called when the store has been initialized.
+     */
+    init(allData: IStoreDataStorage, callback: () => void): void;
+    /**
+     * Add an entity or update an existing entity.
+     *
+     * @param kind
+     *   The type of data to be accessed. The actual type of this parameter is
+     *   {@link IDataKind}.
+     *
+     * @param data
+     *   The contents of the entity, as an object that can be converted to JSON. The store
+     *   should check the `version` property of this object, and should *not* overwrite any
+     *   existing data if the existing `version` is greater than or equal to that value.
+     *   The actual type of this parameter is {@link IKeyedStoreItem}.
+     *
+     * @param callback
+     *   Will be called after the upsert operation is complete.
+     */
+    upsert(kind: IDataKind, data: IKeyedStoreItem, callback: () => void): void;
+    /**
+     * Tests whether the store is initialized.
+     *
+     * "Initialized" means that the store has been populated with data, either by the client
+     * having called `init()` within this process, or by another process (if this is a shared
+     * database).
+     *
+     * @param callback
+     *   Will be called back with the boolean result.
+     */
+    initialized(): boolean;
+    /**
+     * Releases any resources being used by the feature store.
+     */
+    close(): void;
+    /**
+     * Get a description of the store.
+     */
+    getDescription?(): string;
+    /**
+     * The current version of the store.
+     */
+    version: number;
+}
+//# sourceMappingURL=IStore.d.ts.map

package/dist/esm/platform/IStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStore.d.ts","sourceRoot":"","sources":["../../../src/platform/IStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChG,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAA;IAEpD;;;;;;;;;;OAUG;IACH,GAAG,CAAC,IAAI,EAAE,SAAS,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAE/C;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE7D;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE3E;;;;;;;;;OASG;IACH,WAAW,IAAI,OAAO,CAAC;IAEvB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,IAAI,MAAM,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/esm/platform/IStore.js

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

package/dist/esm/platform/IStore.js.map

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