@launchdarkly/js-sdk-common 0.1.0

package/dist/Context.js

@@ -0,0 +1,385 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AttributeReference_1 = require("./AttributeReference");
+const validators_1 = require("./validators");
+// The general strategy for the context is to transform the passed in context
+// as little as possible. We do convert the legacy users to a single kind
+// context, but we do not translate all passed contexts into a rigid structure.
+// The context will have to be copied for events, but we want to avoid any
+// copying that we can.
+// So we validate that the information we are given is correct, and then we
+// just proxy calls with a nicely typed interface.
+// This is to reduce work on the hot-path. Later, for event processing, deeper
+// cloning of the context will be done.
+// Validates a kind excluding check that it isn't "kind".
+const KindValidator = validators_1.TypeValidators.stringMatchingRegex(/^(\w|\.|-)+$/);
+// When no kind is specified, then this kind will be used.
+const DEFAULT_KIND = 'user';
+// The API allows for calling with an `LDContext` which is
+// `LDUser | LDSingleKindContext | LDMultiKindContext`. When ingesting a context
+// first the type must be determined to allow us to put it into a consistent type.
+/**
+ * The partial URL encoding is needed because : is a valid character in context keys.
+ *
+ * Partial encoding is the replacement of all colon (:) characters with the URL
+ * encoded equivalent (%3A) and all percent (%) characters with the URL encoded
+ * equivalent (%25).
+ * @param key The key to encode.
+ * @returns Partially URL encoded key.
+ */
+function encodeKey(key) {
+    if (key.includes('%') || key.includes(':')) {
+        return key.replace(/%/g, '%25').replace(/:/g, '%3A');
+    }
+    return key;
+}
+/**
+ * Check if a context is a single kind context.
+ * @param context
+ * @returns true if the context is a single kind context.
+ */
+function isSingleKind(context) {
+    if ('kind' in context) {
+        return validators_1.TypeValidators.String.is(context.kind) && context.kind !== 'multi';
+    }
+    return false;
+}
+/**
+ * Check if a context is a multi-kind context.
+ * @param context
+ * @returns true if it is a multi-kind context.
+ */
+function isMultiKind(context) {
+    if ('kind' in context) {
+        return validators_1.TypeValidators.String.is(context.kind) && context.kind === 'multi';
+    }
+    return false;
+}
+/**
+ * Check if a context is a legacy user context.
+ * @param context
+ * @returns true if it is a legacy user context.
+ */
+function isLegacyUser(context) {
+    return !('kind' in context) || context.kind === null || context.kind === undefined;
+}
+/**
+ * Check if the given value is a LDContextCommon.
+ * @param kindOrContext
+ * @returns true if it is an LDContextCommon
+ *
+ * Due to a limitation in the expressiveness of these highly polymorphic types any field
+ * in a multi-kind context can either be a context or 'kind'. So we need to re-assure
+ * the compiler that it isn't the word multi.
+ *
+ * Because we do not allow top level values in a multi-kind context we can validate
+ * that as well.
+ */
+function isContextCommon(kindOrContext) {
+    return kindOrContext && validators_1.TypeValidators.Object.is(kindOrContext);
+}
+/**
+ * Validate a context kind.
+ * @param kind
+ * @returns true if the kind is valid.
+ */
+function validKind(kind) {
+    return KindValidator.is(kind) && kind !== 'kind';
+}
+/**
+ * Validate a context key.
+ * @param key
+ * @returns true if the key is valid.
+ */
+function validKey(key) {
+    return validators_1.TypeValidators.String.is(key) && key !== '';
+}
+function processPrivateAttributes(privateAttributes, literals = false) {
+    if (privateAttributes) {
+        return privateAttributes.map((privateAttribute) => new AttributeReference_1.default(privateAttribute, literals));
+    }
+    return [];
+}
+function defined(value) {
+    return value !== null && value !== undefined;
+}
+/**
+ * Convert a legacy user to a single kind context.
+ * @param user
+ * @returns A single kind context.
+ */
+function legacyToSingleKind(user) {
+    const singleKindContext = Object.assign(Object.assign({}, (user.custom || [])), { kind: 'user', key: String(user.key) });
+    // For legacy users we never established a difference between null
+    // and undefined for inputs. Because anonymous can be used in evaluations
+    // we would want it to not possibly match true/false unless defined.
+    // Which is different than coercing a null/undefined anonymous as `false`.
+    if (defined(user.anonymous)) {
+        const anonymous = !!user.anonymous;
+        delete singleKindContext.anonymous;
+        singleKindContext.anonymous = anonymous;
+    }
+    if (user.name !== null && user.name !== undefined) {
+        singleKindContext.name = user.name;
+    }
+    if (user.ip !== null && user.ip !== undefined) {
+        singleKindContext.ip = user.ip;
+    }
+    if (user.firstName !== null && user.firstName !== undefined) {
+        singleKindContext.firstName = user.firstName;
+    }
+    if (user.lastName !== null && user.lastName !== undefined) {
+        singleKindContext.lastName = user.lastName;
+    }
+    if (user.email !== null && user.email !== undefined) {
+        singleKindContext.email = user.email;
+    }
+    if (user.avatar !== null && user.avatar !== undefined) {
+        singleKindContext.avatar = user.avatar;
+    }
+    if (user.country !== null && user.country !== undefined) {
+        singleKindContext.country = user.country;
+    }
+    // We are not pulling private attributes over because we will serialize
+    // those from attribute references for events.
+    return singleKindContext;
+}
+/**
+ * Container for a context/contexts. Because contexts come from external code
+ * they must be thoroughly validated and then formed to comply with
+ * the type system.
+ */
+class Context {
+    /**
+     * Contexts should be created using the static factory method {@link Context.fromLDContext}.
+     * @param kind The kind of the context.
+     *
+     * The factory methods are static functions within the class because they access private
+     * implementation details, so they cannot be free functions.
+     */
+    constructor(valid, kind, message) {
+        this.isMulti = false;
+        this.isUser = false;
+        this.wasLegacy = false;
+        this.contexts = {};
+        this.kind = kind;
+        this.valid = valid;
+        this.message = message;
+    }
+    static contextForError(kind, message) {
+        return new Context(false, kind, message);
+    }
+    static getValueFromContext(reference, context) {
+        if (!context || !reference.isValid) {
+            return undefined;
+        }
+        if (reference.depth === 1 && reference.getComponent(0) === 'anonymous') {
+            return !!(context === null || context === void 0 ? void 0 : context.anonymous);
+        }
+        return reference.get(context);
+    }
+    contextForKind(kind) {
+        if (this.isMulti) {
+            return this.contexts[kind];
+        }
+        if (this.kind === kind) {
+            return this.context;
+        }
+        return undefined;
+    }
+    static fromMultiKindContext(context) {
+        const kinds = Object.keys(context).filter((key) => key !== 'kind');
+        const kindsValid = kinds.every(validKind);
+        if (!kinds.length) {
+            return Context.contextForError('multi', 'A multi-kind context must contain at least one kind');
+        }
+        if (!kindsValid) {
+            return Context.contextForError('multi', 'Context contains invalid kinds');
+        }
+        const privateAttributes = {};
+        let contextsAreObjects = true;
+        const contexts = kinds.reduce((acc, kind) => {
+            var _a;
+            const singleContext = context[kind];
+            if (isContextCommon(singleContext)) {
+                acc[kind] = singleContext;
+                privateAttributes[kind] = processPrivateAttributes((_a = singleContext._meta) === null || _a === void 0 ? void 0 : _a.privateAttributes);
+            }
+            else {
+                // No early break isn't the most efficient, but it is an error condition.
+                contextsAreObjects = false;
+            }
+            return acc;
+        }, {});
+        if (!contextsAreObjects) {
+            return Context.contextForError('multi', 'Context contained contexts that were not objects');
+        }
+        if (!Object.values(contexts).every((part) => validKey(part.key))) {
+            return Context.contextForError('multi', 'Context contained invalid keys');
+        }
+        // There was only a single kind in the multi-kind context.
+        // So we can just translate this to a single-kind context.
+        if (kinds.length === 1) {
+            const kind = kinds[0];
+            const created = new Context(true, kind);
+            created.context = contexts[kind];
+            created.privateAttributeReferences = privateAttributes;
+            created.isUser = kind === 'user';
+            return created;
+        }
+        const created = new Context(true, context.kind);
+        created.contexts = contexts;
+        created.privateAttributeReferences = privateAttributes;
+        created.isMulti = true;
+        return created;
+    }
+    static fromSingleKindContext(context) {
+        var _a;
+        const { key, kind } = context;
+        const kindValid = validKind(kind);
+        const keyValid = validKey(key);
+        if (!kindValid) {
+            return Context.contextForError(kind !== null && kind !== void 0 ? kind : 'unknown', 'The kind was not valid for the context');
+        }
+        if (!keyValid) {
+            return Context.contextForError(kind, 'The key for the context was not valid');
+        }
+        // The JSON interfaces uses dangling _.
+        // eslint-disable-next-line no-underscore-dangle
+        const privateAttributeReferences = processPrivateAttributes((_a = context._meta) === null || _a === void 0 ? void 0 : _a.privateAttributes);
+        const created = new Context(true, kind);
+        created.isUser = kind === 'user';
+        created.context = context;
+        created.privateAttributeReferences = {
+            [kind]: privateAttributeReferences,
+        };
+        return created;
+    }
+    static fromLegacyUser(context) {
+        const keyValid = context.key !== undefined && context.key !== null;
+        // For legacy users we allow empty keys.
+        if (!keyValid) {
+            return Context.contextForError('user', 'The key for the context was not valid');
+        }
+        const created = new Context(true, 'user');
+        created.isUser = true;
+        created.wasLegacy = true;
+        created.context = legacyToSingleKind(context);
+        created.privateAttributeReferences = {
+            user: processPrivateAttributes(context.privateAttributeNames, true),
+        };
+        return created;
+    }
+    /**
+     * Attempt to create a {@link Context} from an {@link LDContext}.
+     * @param context The input context to create a Context from.
+     * @returns a {@link Context}, if the context was not valid, then the returned contexts `valid`
+     * property will be false.
+     */
+    static fromLDContext(context) {
+        if (!context) {
+            return Context.contextForError('unknown', 'No context specified. Returning default value');
+        }
+        if (isSingleKind(context)) {
+            return Context.fromSingleKindContext(context);
+        }
+        if (isMultiKind(context)) {
+            return Context.fromMultiKindContext(context);
+        }
+        if (isLegacyUser(context)) {
+            return Context.fromLegacyUser(context);
+        }
+        return Context.contextForError('unknown', 'Context was not of a valid kind');
+    }
+    /**
+     * Attempt to get a value for the given context kind using the given reference.
+     * @param reference The reference to the value to get.
+     * @param kind The kind of the context to get the value for.
+     * @returns a value or `undefined` if one is not found.
+     */
+    valueForKind(reference, kind = DEFAULT_KIND) {
+        if (reference.isKind) {
+            return this.kinds;
+        }
+        return Context.getValueFromContext(reference, this.contextForKind(kind));
+    }
+    /**
+     * Attempt to get a key for the specified kind.
+     * @param kind The kind to get a key for.
+     * @returns The key for the specified kind, or undefined.
+     */
+    key(kind = DEFAULT_KIND) {
+        var _a;
+        return (_a = this.contextForKind(kind)) === null || _a === void 0 ? void 0 : _a.key;
+    }
+    /**
+     * True if this is a multi-kind context.
+     */
+    get isMultiKind() {
+        return this.isMulti;
+    }
+    /**
+     * Get the canonical key for this context.
+     */
+    get canonicalKey() {
+        if (this.isUser) {
+            return this.context.key;
+        }
+        if (this.isMulti) {
+            return Object.keys(this.contexts)
+                .sort()
+                .map((key) => `${key}:${encodeKey(this.contexts[key].key)}`)
+                .join(':');
+        }
+        return `${this.kind}:${encodeKey(this.context.key)}`;
+    }
+    /**
+     * Get the kinds of this context.
+     */
+    get kinds() {
+        if (this.isMulti) {
+            return Object.keys(this.contexts);
+        }
+        return [this.kind];
+    }
+    /**
+     * Get the kinds, and their keys, for this context.
+     */
+    get kindsAndKeys() {
+        if (this.isMulti) {
+            return Object.entries(this.contexts).reduce((acc, [kind, context]) => {
+                acc[kind] = context.key;
+                return acc;
+            }, {});
+        }
+        return { [this.kind]: this.context.key };
+    }
+    /**
+     * Get the attribute references.
+     *
+     * @param kind
+     */
+    privateAttributes(kind) {
+        var _a;
+        return ((_a = this.privateAttributeReferences) === null || _a === void 0 ? void 0 : _a[kind]) || [];
+    }
+    /**
+     * Get the underlying context objects from this context.
+     *
+     * This method is intended to be used in event generation.
+     *
+     * The returned objects should not be modified.
+     */
+    getContexts() {
+        if (this.isMulti) {
+            return Object.entries(this.contexts);
+        }
+        return [[this.kind, this.context]];
+    }
+    get legacy() {
+        return this.wasLegacy;
+    }
+}
+exports.default = Context;
+Context.userKind = DEFAULT_KIND;
+//# sourceMappingURL=Context.js.map

package/dist/Context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Context.js","sourceRoot":"","sources":["../src/Context.ts"],"names":[],"mappings":";;AAIA,6DAAsD;AACtD,6CAA8C;AAE9C,6EAA6E;AAC7E,yEAAyE;AACzE,+EAA+E;AAC/E,0EAA0E;AAC1E,uBAAuB;AACvB,2EAA2E;AAC3E,kDAAkD;AAClD,8EAA8E;AAC9E,uCAAuC;AAEvC,yDAAyD;AACzD,MAAM,aAAa,GAAG,2BAAc,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;AAEzE,0DAA0D;AAC1D,MAAM,YAAY,GAAG,MAAM,CAAC;AAE5B,0DAA0D;AAC1D,gFAAgF;AAChF,kFAAkF;AAElF;;;;;;;;GAQG;AACH,SAAS,SAAS,CAAC,GAAW;IAC5B,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAC1C,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;KACtD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,OAAkB;IACtC,IAAI,MAAM,IAAI,OAAO,EAAE;QACrB,OAAO,2BAAc,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC;KAC3E;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,OAAkB;IACrC,IAAI,MAAM,IAAI,OAAO,EAAE;QACrB,OAAO,2BAAc,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC;KAC3E;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,OAAkB;IACtC,OAAO,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;AACrF,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,eAAe,CACtB,aAAwC;IAExC,OAAO,aAAa,IAAI,2BAAc,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,IAAY;IAC7B,OAAO,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,MAAM,CAAC;AACnD,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,GAAW;IAC3B,OAAO,2BAAc,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,EAAE,CAAC;AACrD,CAAC;AAED,SAAS,wBAAwB,CAC/B,iBAA4B,EAC5B,WAAoB,KAAK;IAEzB,IAAI,iBAAiB,EAAE;QACrB,OAAO,iBAAiB,CAAC,GAAG,CAC1B,CAAC,gBAAgB,EAAE,EAAE,CAAC,IAAI,4BAAkB,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CACzE,CAAC;KACH;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,OAAO,CAAC,KAAU;IACzB,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,IAAY;IACtC,MAAM,iBAAiB,mCAElB,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,KACtB,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GACtB,CAAC;IAEF,kEAAkE;IAClE,yEAAyE;IACzE,oEAAoE;IACpE,0EAA0E;IAC1E,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QAC3B,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QACnC,OAAO,iBAAiB,CAAC,SAAS,CAAC;QACnC,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC;KACzC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QACjD,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;KACpC;IACD,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE;QAC7C,iBAAiB,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;KAChC;IACD,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;QAC3D,iBAAiB,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;KAC9C;IACD,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;QACzD,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;KAC5C;IACD,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;QACnD,iBAAiB,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;KACtC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;QACrD,iBAAiB,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;KACxC;IACD,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;QACvD,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;KAC1C;IAED,uEAAuE;IACvE,8CAA8C;IAE9C,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAqB,OAAO;IAyB1B;;;;;;OAMG;IACH,YAAoB,KAAc,EAAE,IAAY,EAAE,OAAgB;QA7B1D,YAAO,GAAY,KAAK,CAAC;QAEzB,WAAM,GAAY,KAAK,CAAC;QAExB,cAAS,GAAY,KAAK,CAAC;QAE3B,aAAQ,GAAoC,EAAE,CAAC;QAwBrD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,OAAe;QAC1D,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAChC,SAA6B,EAC7B,OAAyB;QAEzB,IAAI,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;YAClC,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,SAAS,CAAC,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,WAAW,EAAE;YACtE,OAAO,CAAC,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAA,CAAC;SAC7B;QACD,OAAO,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAEO,cAAc,CAAC,IAAY;QACjC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC5B;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC;SACrB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,OAA2B;QAC7D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE1C,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACjB,OAAO,OAAO,CAAC,eAAe,CAC5B,OAAO,EACP,qDAAqD,CACtD,CAAC;SACH;QAED,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC;SAC3E;QAED,MAAM,iBAAiB,GAAyC,EAAE,CAAC;QACnE,IAAI,kBAAkB,GAAG,IAAI,CAAC;QAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAAoC,EAAE,IAAI,EAAE,EAAE;;YAC3E,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,eAAe,CAAC,aAAa,CAAC,EAAE;gBAClC,GAAG,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC;gBAC1B,iBAAiB,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,MAAA,aAAa,CAAC,KAAK,0CAAE,iBAAiB,CAAC,CAAC;aAC5F;iBAAM;gBACL,yEAAyE;gBACzE,kBAAkB,GAAG,KAAK,CAAC;aAC5B;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,IAAI,CAAC,kBAAkB,EAAE;YACvB,OAAO,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,kDAAkD,CAAC,CAAC;SAC7F;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;YAChE,OAAO,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC;SAC3E;QAED,0DAA0D;QAC1D,0DAA0D;QAC1D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACxC,OAAO,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjC,OAAO,CAAC,0BAA0B,GAAG,iBAAiB,CAAC;YACvD,OAAO,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;YACjC,OAAO,OAAO,CAAC;SAChB;QAED,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC5B,OAAO,CAAC,0BAA0B,GAAG,iBAAiB,CAAC;QAEvD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,OAA4B;;QAC/D,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QAC9B,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE/B,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,OAAO,CAAC,eAAe,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,SAAS,EAAE,wCAAwC,CAAC,CAAC;SAC7F;QAED,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,uCAAuC,CAAC,CAAC;SAC/E;QAED,uCAAuC;QACvC,gDAAgD;QAChD,MAAM,0BAA0B,GAAG,wBAAwB,CAAC,MAAA,OAAO,CAAC,KAAK,0CAAE,iBAAiB,CAAC,CAAC;QAC9F,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxC,OAAO,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;QACjC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;QAC1B,OAAO,CAAC,0BAA0B,GAAG;YACnC,CAAC,IAAI,CAAC,EAAE,0BAA0B;SACnC,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,OAAe;QAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,KAAK,IAAI,CAAC;QACnE,wCAAwC;QACxC,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,uCAAuC,CAAC,CAAC;SACjF;QACD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QACtB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;QACzB,OAAO,CAAC,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9C,OAAO,CAAC,0BAA0B,GAAG;YACnC,IAAI,EAAE,wBAAwB,CAAC,OAAO,CAAC,qBAAqB,EAAE,IAAI,CAAC;SACpE,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,OAAkB;QAC5C,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,+CAA+C,CAAC,CAAC;SAC5F;QACD,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE;YACzB,OAAO,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;SAC/C;QACD,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE;YACxB,OAAO,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;SAC9C;QACD,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE;YACzB,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;SACxC;QAED,OAAO,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,iCAAiC,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,SAA6B,EAAE,OAAe,YAAY;QAC5E,IAAI,SAAS,CAAC,MAAM,EAAE;YACpB,OAAO,IAAI,CAAC,KAAK,CAAC;SACnB;QACD,OAAO,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,OAAe,YAAY;;QACpC,OAAO,MAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,0CAAE,GAAG,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,IAAI,CAAC,OAAQ,CAAC,GAAG,CAAC;SAC1B;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;iBAC9B,IAAI,EAAE;iBACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;iBAC3D,IAAI,CAAC,GAAG,CAAC,CAAC;SACd;QACD,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,OAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACnC;QACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CACzC,CAAC,GAA2B,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE;gBAC/C,GAAG,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;gBACxB,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAAE,CACH,CAAC;SACH;QACD,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,OAAQ,CAAC,GAAG,EAAE,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,IAAY;;QACnC,OAAO,CAAA,MAAA,IAAI,CAAC,0BAA0B,0CAAG,IAAI,CAAC,KAAI,EAAE,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,WAAW;QAChB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACtC;QACD,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;;AA1RH,0BA2RC;AApQiB,gBAAQ,GAAW,YAAY,CAAC"}

package/dist/ContextFilter.d.ts

@@ -0,0 +1,11 @@
+import AttributeReference from './AttributeReference';
+import Context from './Context';
+export default class ContextFilter {
+    private readonly allAttributesPrivate;
+    private readonly privateAttributes;
+    constructor(allAttributesPrivate: boolean, privateAttributes: AttributeReference[]);
+    filter(context: Context): any;
+    private getAttributesToFilter;
+    private filterSingleKind;
+}
+//# sourceMappingURL=ContextFilter.d.ts.map

package/dist/ContextFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextFilter.d.ts","sourceRoot":"","sources":["../src/ContextFilter.ts"],"names":[],"mappings":"AAGA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,OAAO,MAAM,WAAW,CAAC;AAyFhC,MAAM,CAAC,OAAO,OAAO,aAAa;IAE9B,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IACrC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;gBADjB,oBAAoB,EAAE,OAAO,EAC7B,iBAAiB,EAAE,kBAAkB,EAAE;IAG1D,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG;IAc7B,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,gBAAgB;CA6BzB"}

package/dist/ContextFilter.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AttributeReference_1 = require("./AttributeReference");
+// These attributes cannot be removed via a private attribute.
+const protectedAttributes = ['key', 'kind', '_meta', 'anonymous'].map((str) => new AttributeReference_1.default(str, true));
+// Attributes that should be stringified for legacy users.
+const legacyTopLevelCopyAttributes = [
+    'name',
+    'ip',
+    'firstName',
+    'lastName',
+    'email',
+    'avatar',
+    'country',
+];
+function compare(a, b) {
+    return a.depth === b.length && b.every((value, index) => value === a.getComponent(index));
+}
+function cloneWithRedactions(target, references) {
+    const stack = [];
+    const cloned = {};
+    const excluded = [];
+    stack.push(...Object.keys(target).map((key) => ({
+        key,
+        ptr: [key],
+        source: target,
+        parent: cloned,
+        visited: [target],
+    })));
+    while (stack.length) {
+        const item = stack.pop();
+        const redactRef = references.find((ref) => compare(ref, item.ptr));
+        if (!redactRef) {
+            const value = item.source[item.key];
+            // Handle null because it overlaps with object, which we will want to handle later.
+            if (value === null) {
+                item.parent[item.key] = value;
+            }
+            else if (Array.isArray(value)) {
+                item.parent[item.key] = [...value];
+            }
+            else if (typeof value === 'object') {
+                // Arrays and null must already be handled.
+                // Prevent cycles by not visiting the same object
+                // with in the same branch. Different branches
+                // may contain the same object.
+                //
+                // Same object visited twice in different branches.
+                // A -> B -> D
+                //   -> C -> D
+                // This is fine, which is why it doesn't just check if the object
+                // was visited ever.
+                if (!item.visited.includes(value)) {
+                    item.parent[item.key] = {};
+                    stack.push(...Object.keys(value).map((key) => ({
+                        key,
+                        ptr: [...item.ptr, key],
+                        source: value,
+                        parent: item.parent[item.key],
+                        visited: [...item.visited, value],
+                    })));
+                }
+            }
+            else {
+                item.parent[item.key] = value;
+            }
+        }
+        else {
+            excluded.push(redactRef.redactionName);
+        }
+    }
+    return { cloned, excluded: excluded.sort() };
+}
+class ContextFilter {
+    constructor(allAttributesPrivate, privateAttributes) {
+        this.allAttributesPrivate = allAttributesPrivate;
+        this.privateAttributes = privateAttributes;
+    }
+    filter(context) {
+        const contexts = context.getContexts();
+        if (contexts.length === 1) {
+            return this.filterSingleKind(context, contexts[0][1], contexts[0][0]);
+        }
+        const filteredMulti = {
+            kind: 'multi',
+        };
+        contexts.forEach(([kind, single]) => {
+            filteredMulti[kind] = this.filterSingleKind(context, single, kind);
+        });
+        return filteredMulti;
+    }
+    getAttributesToFilter(context, single, kind) {
+        return (this.allAttributesPrivate
+            ? Object.keys(single).map((k) => new AttributeReference_1.default(k, true))
+            : [...this.privateAttributes, ...context.privateAttributes(kind)]).filter((attr) => !protectedAttributes.some((protectedAttr) => protectedAttr.compare(attr)));
+    }
+    filterSingleKind(context, single, kind) {
+        const { cloned, excluded } = cloneWithRedactions(single, this.getAttributesToFilter(context, single, kind));
+        if (context.legacy) {
+            legacyTopLevelCopyAttributes.forEach((name) => {
+                if (name in cloned) {
+                    cloned[name] = String(cloned[name]);
+                }
+            });
+        }
+        if (excluded.length) {
+            if (!cloned._meta) {
+                cloned._meta = {};
+            }
+            cloned._meta.redactedAttributes = excluded;
+        }
+        if (cloned._meta) {
+            delete cloned._meta.privateAttributes;
+            if (Object.keys(cloned._meta).length === 0) {
+                delete cloned._meta;
+            }
+        }
+        return cloned;
+    }
+}
+exports.default = ContextFilter;
+//# sourceMappingURL=ContextFilter.js.map

package/dist/ContextFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextFilter.js","sourceRoot":"","sources":["../src/ContextFilter.ts"],"names":[],"mappings":";;AAGA,6DAAsD;AAGtD,8DAA8D;AAC9D,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,GAAG,CACnE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,4BAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,CAC3C,CAAC;AAEF,0DAA0D;AAC1D,MAAM,4BAA4B,GAAG;IACnC,MAAM;IACN,IAAI;IACJ,WAAW;IACX,UAAU;IACV,OAAO;IACP,QAAQ;IACR,SAAS;CACV,CAAC;AAEF,SAAS,OAAO,CAAC,CAAqB,EAAE,CAAW;IACjD,OAAO,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAuB,EAAE,UAAgC;IACpF,MAAM,KAAK,GAML,EAAE,CAAC;IACT,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,KAAK,CAAC,IAAI,CACR,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACnC,GAAG;QACH,GAAG,EAAE,CAAC,GAAG,CAAC;QACV,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,CAAC,MAAM,CAAC;KAClB,CAAC,CAAC,CACJ,CAAC;IAEF,OAAO,KAAK,CAAC,MAAM,EAAE;QACnB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAC1B,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEpC,mFAAmF;YACnF,IAAI,KAAK,KAAK,IAAI,EAAE;gBAClB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aAC/B;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;aACpC;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACpC,2CAA2C;gBAE3C,iDAAiD;gBACjD,8CAA8C;gBAC9C,+BAA+B;gBAC/B,EAAE;gBACF,mDAAmD;gBACnD,cAAc;gBACd,cAAc;gBACd,iEAAiE;gBACjE,oBAAoB;gBACpB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;oBAE3B,KAAK,CAAC,IAAI,CACR,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;wBAClC,GAAG;wBACH,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC;wBACvB,MAAM,EAAE,KAAK;wBACb,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;wBAC7B,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC;qBAClC,CAAC,CAAC,CACJ,CAAC;iBACH;aACF;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aAC/B;SACF;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;SACxC;KACF;IACD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;AAC/C,CAAC;AAED,MAAqB,aAAa;IAChC,YACmB,oBAA6B,EAC7B,iBAAuC;QADvC,yBAAoB,GAApB,oBAAoB,CAAS;QAC7B,sBAAiB,GAAjB,iBAAiB,CAAsB;IACvD,CAAC;IAEJ,MAAM,CAAC,OAAgB;QACrB,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvE;QACD,MAAM,aAAa,GAAQ;YACzB,IAAI,EAAE,OAAO;SACd,CAAC;QACF,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;YAClC,aAAa,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;IACvB,CAAC;IAEO,qBAAqB,CAAC,OAAgB,EAAE,MAAuB,EAAE,IAAY;QACnF,OAAO,CACL,IAAI,CAAC,oBAAoB;YACvB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,4BAAkB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,iBAAiB,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CACpE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;IAEO,gBAAgB,CAAC,OAAgB,EAAE,MAAuB,EAAE,IAAY;QAC9E,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,mBAAmB,CAC9C,MAAM,EACN,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAClD,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,4BAA4B,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC5C,IAAI,IAAI,IAAI,MAAM,EAAE;oBAClB,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;iBACrC;YACH,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,QAAQ,CAAC,MAAM,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;gBACjB,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC;aACnB;YACD,MAAM,CAAC,KAAK,CAAC,kBAAkB,GAAG,QAAQ,CAAC;SAC5C;QACD,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,OAAO,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;YACtC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1C,OAAO,MAAM,CAAC,KAAK,CAAC;aACrB;SACF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAzDD,gCAyDC"}

package/dist/api/context/LDContext.d.ts

@@ -0,0 +1,8 @@
+import { LDMultiKindContext } from './LDMultiKindContext';
+import { LDSingleKindContext } from './LDSingleKindContext';
+import { LDUser } from './LDUser';
+/**
+ * A LaunchDarkly context object.
+ */
+export type LDContext = LDUser | LDSingleKindContext | LDMultiKindContext;
+//# sourceMappingURL=LDContext.d.ts.map

package/dist/api/context/LDContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDContext.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,mBAAmB,GAAG,kBAAkB,CAAC"}

package/dist/api/context/LDContext.js

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

package/dist/api/context/LDContext.js.map

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

package/dist/api/context/LDContextCommon.d.ts

@@ -0,0 +1,29 @@
+import { LDContextMeta } from './LDContextMeta';
+export interface LDContextCommon {
+    /**
+     * A unique string identifying a context.
+     */
+    key: string;
+    /**
+     * The context's name.
+     *
+     * You can search for contexts on the Contexts page by name.
+     */
+    name?: string;
+    /**
+     * Meta attributes are used to control behavioral aspects of the Context, such as private
+     * private attributes. See {@link LDContextMeta.privateAttributes} as an example.
+     *
+     * They cannot be addressed in targeting rules.
+     */
+    _meta?: LDContextMeta;
+    /**
+     * If true, the context will _not_ appear on the Contexts page in the LaunchDarkly dashboard.
+     */
+    anonymous?: boolean;
+    /**
+     * Any additional attributes associated with the context.
+     */
+    [attribute: string]: any;
+}
+//# sourceMappingURL=LDContextCommon.d.ts.map

package/dist/api/context/LDContextCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDContextCommon.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDContextCommon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC1B"}

package/dist/api/context/LDContextCommon.js

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

package/dist/api/context/LDContextCommon.js.map

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

package/dist/api/context/LDContextMeta.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Meta attributes are used to control behavioral aspects of the Context.
+ * They cannot be addressed in targeting rules.
+ */
+export interface LDContextMeta {
+    /**
+     *
+     * Designate any number of Context attributes, or properties within them, as private: that is,
+     * their values will not be sent to LaunchDarkly.
+     *
+     * Each parameter can be a simple attribute name, such as "email". Or, if the first character is
+     * a slash, the parameter is interpreted as a slash-delimited path to a property within a JSON
+     * object, where the first path component is a Context attribute name and each following
+     * component is a nested property name: for example, suppose the attribute "address" had the
+     * following JSON object value:
+     *
+     * ```
+     * {"street": {"line1": "abc", "line2": "def"}}
+     * ```
+     *
+     * Using ["/address/street/line1"] in this case would cause the "line1" property to be marked as
+     * private. This syntax deliberately resembles JSON Pointer, but other JSON Pointer features
+     * such as array indexing are not supported for Private.
+     *
+     * This action only affects analytics events that involve this particular Context. To mark some
+     * (or all) Context attributes as private for all users, use the overall configuration for the
+     * SDK.
+     * See {@link LDOptions.allAttributesPrivate} and {@link LDOptions.privateAttributes}.
+     *
+     * The attributes "kind" and "key", and the "_meta" attributes cannot be made private.
+     *
+     * In this example, firstName is marked as private, but lastName is not:
+     *
+     * ```
+     * const context = {
+     *   kind: 'org',
+     *   key: 'my-key',
+     *   firstName: 'Pierre',
+     *   lastName: 'Menard',
+     *   _meta: {
+     *     privateAttributes: ['firstName'],
+     *   }
+     * };
+     * ```
+     *
+     * This is a metadata property, rather than an attribute that can be addressed in evaluations:
+     * that is, a rule clause that references the attribute name "privateAttributes", will not use
+     * this value, but would use a "privateAttributes" attribute set on the context.
+     */
+    privateAttributes?: string[];
+}
+//# sourceMappingURL=LDContextMeta.d.ts.map