@devcycle/types - npm Package Compare versions

Comparing version 1.27.0 to 1.28.0

index.cjs.js

@@ -139,2 +139,48 @@ 'use strict';
 const SDKTypeValues = ['client', 'server', 'mobile', 'api'];
+exports.EVAL_REASONS = void 0;
+(function (EVAL_REASONS) {
+    EVAL_REASONS["TARGETING_MATCH"] = "TARGETING_MATCH";
+    EVAL_REASONS["SPLIT"] = "SPLIT";
+    EVAL_REASONS["DEFAULT"] = "DEFAULT";
+    EVAL_REASONS["DISABLED"] = "DISABLED";
+    EVAL_REASONS["ERROR"] = "ERROR";
+    EVAL_REASONS["OVERRIDE"] = "OVERRIDE";
+    EVAL_REASONS["OPT_IN"] = "OPT_IN";
+})(exports.EVAL_REASONS || (exports.EVAL_REASONS = {}));
+exports.EVAL_REASON_DETAILS = void 0;
+(function (EVAL_REASON_DETAILS) {
+    // All Users
+    EVAL_REASON_DETAILS["ALL_USERS"] = "All Users";
+    // Audiences
+    EVAL_REASON_DETAILS["AUDIENCE_MATCH"] = "Audience Match";
+    EVAL_REASON_DETAILS["NOT_IN_AUDIENCE"] = "Not in Audience";
+    // Opt-In
+    EVAL_REASON_DETAILS["OPT_IN"] = "Opt-In";
+    EVAL_REASON_DETAILS["NOT_OPTED_IN"] = "Not Opt-In";
+    // Overrides
+    EVAL_REASON_DETAILS["OVERRIDE"] = "Override";
+    // User Specific
+    EVAL_REASON_DETAILS["USER_ID"] = "User ID";
+    EVAL_REASON_DETAILS["EMAIL"] = "Email";
+    EVAL_REASON_DETAILS["COUNTRY"] = "Country";
+    EVAL_REASON_DETAILS["PLATFORM"] = "Platform";
+    EVAL_REASON_DETAILS["PLATFORM_VERSION"] = "Platform Version";
+    EVAL_REASON_DETAILS["APP_VERSION"] = "App Version";
+    EVAL_REASON_DETAILS["DEVICE_MODEL"] = "Device Model";
+    EVAL_REASON_DETAILS["CUSTOM_DATA"] = "Custom Data";
+})(exports.EVAL_REASON_DETAILS || (exports.EVAL_REASON_DETAILS = {}));
+exports.DEFAULT_REASON_DETAILS = void 0;
+(function (DEFAULT_REASON_DETAILS) {
+    DEFAULT_REASON_DETAILS["MISSING_CONFIG"] = "Missing Config";
+    DEFAULT_REASON_DETAILS["MISSING_VARIABLE"] = "Missing Variable";
+    DEFAULT_REASON_DETAILS["MISSING_FEATURE"] = "Missing Feature";
+    DEFAULT_REASON_DETAILS["MISSING_VARIATION"] = "Missing Variation";
+    DEFAULT_REASON_DETAILS["MISSING_VARIABLE_FOR_VARIATION"] = "Missing Variable for Variation";
+    DEFAULT_REASON_DETAILS["USER_NOT_IN_ROLLOUT"] = "User Not in Rollout";
+    DEFAULT_REASON_DETAILS["USER_NOT_TARGETED"] = "User Not Targeted";
+    DEFAULT_REASON_DETAILS["INVALID_VARIABLE_TYPE"] = "Invalid Variable Type";
+    DEFAULT_REASON_DETAILS["TYPE_MISMATCH"] = "Variable Type Mismatch";
+    DEFAULT_REASON_DETAILS["UNKNOWN"] = "Unknown";
+    DEFAULT_REASON_DETAILS["ERROR"] = "Error";
+})(exports.DEFAULT_REASON_DETAILS || (exports.DEFAULT_REASON_DETAILS = {}));
 const boolTransform = ({ value }) => {
@@ -692,3 +738,2 @@ if (value === 'true') {
     UserSubType["email"] = "email";
-    UserSubType["ip"] = "ip";
     UserSubType["country"] = "country";
@@ -695,0 +740,0 @@ UserSubType["platform"] = "platform";

index.esm.js

@@ -125,2 +125,48 @@ import isString from 'lodash/isString';
 const SDKTypeValues = ['client', 'server', 'mobile', 'api'];
+var EVAL_REASONS;
+(function (EVAL_REASONS) {
+    EVAL_REASONS["TARGETING_MATCH"] = "TARGETING_MATCH";
+    EVAL_REASONS["SPLIT"] = "SPLIT";
+    EVAL_REASONS["DEFAULT"] = "DEFAULT";
+    EVAL_REASONS["DISABLED"] = "DISABLED";
+    EVAL_REASONS["ERROR"] = "ERROR";
+    EVAL_REASONS["OVERRIDE"] = "OVERRIDE";
+    EVAL_REASONS["OPT_IN"] = "OPT_IN";
+})(EVAL_REASONS || (EVAL_REASONS = {}));
+var EVAL_REASON_DETAILS;
+(function (EVAL_REASON_DETAILS) {
+    // All Users
+    EVAL_REASON_DETAILS["ALL_USERS"] = "All Users";
+    // Audiences
+    EVAL_REASON_DETAILS["AUDIENCE_MATCH"] = "Audience Match";
+    EVAL_REASON_DETAILS["NOT_IN_AUDIENCE"] = "Not in Audience";
+    // Opt-In
+    EVAL_REASON_DETAILS["OPT_IN"] = "Opt-In";
+    EVAL_REASON_DETAILS["NOT_OPTED_IN"] = "Not Opt-In";
+    // Overrides
+    EVAL_REASON_DETAILS["OVERRIDE"] = "Override";
+    // User Specific
+    EVAL_REASON_DETAILS["USER_ID"] = "User ID";
+    EVAL_REASON_DETAILS["EMAIL"] = "Email";
+    EVAL_REASON_DETAILS["COUNTRY"] = "Country";
+    EVAL_REASON_DETAILS["PLATFORM"] = "Platform";
+    EVAL_REASON_DETAILS["PLATFORM_VERSION"] = "Platform Version";
+    EVAL_REASON_DETAILS["APP_VERSION"] = "App Version";
+    EVAL_REASON_DETAILS["DEVICE_MODEL"] = "Device Model";
+    EVAL_REASON_DETAILS["CUSTOM_DATA"] = "Custom Data";
+})(EVAL_REASON_DETAILS || (EVAL_REASON_DETAILS = {}));
+var DEFAULT_REASON_DETAILS;
+(function (DEFAULT_REASON_DETAILS) {
+    DEFAULT_REASON_DETAILS["MISSING_CONFIG"] = "Missing Config";
+    DEFAULT_REASON_DETAILS["MISSING_VARIABLE"] = "Missing Variable";
+    DEFAULT_REASON_DETAILS["MISSING_FEATURE"] = "Missing Feature";
+    DEFAULT_REASON_DETAILS["MISSING_VARIATION"] = "Missing Variation";
+    DEFAULT_REASON_DETAILS["MISSING_VARIABLE_FOR_VARIATION"] = "Missing Variable for Variation";
+    DEFAULT_REASON_DETAILS["USER_NOT_IN_ROLLOUT"] = "User Not in Rollout";
+    DEFAULT_REASON_DETAILS["USER_NOT_TARGETED"] = "User Not Targeted";
+    DEFAULT_REASON_DETAILS["INVALID_VARIABLE_TYPE"] = "Invalid Variable Type";
+    DEFAULT_REASON_DETAILS["TYPE_MISMATCH"] = "Variable Type Mismatch";
+    DEFAULT_REASON_DETAILS["UNKNOWN"] = "Unknown";
+    DEFAULT_REASON_DETAILS["ERROR"] = "Error";
+})(DEFAULT_REASON_DETAILS || (DEFAULT_REASON_DETAILS = {}));
 const boolTransform = ({ value }) => {
@@ -678,3 +724,2 @@ if (value === 'true') {
     UserSubType["email"] = "email";
-    UserSubType["ip"] = "ip";
     UserSubType["country"] = "country";
@@ -1286,2 +1331,2 @@ UserSubType["platform"] = "platform";
 
-export { Audience, AudienceFilter, AudienceFilterOrOperator, AudienceOperator, BooleanFilterComparator, ConfigBody, ConfigSource, DVCAPIUser, DVCBucketingUser, DVCClientAPIUser, DVCEvent, DVCOptInUser, DVCPopulatedRequestEventDto, DataKeyType, Environment, Feature, FeatureConfiguration, FeaturePrerequisites, FeatureSource, FeatureType, FeatureWinningVariation, FilterComparator, FilterType, IsDVCCustomDataJSONObject, ListAudience, ListAudienceSubType, NumberFilterComparator, Project, Audience as PublicAudience, Environment as PublicEnvironment, Feature as PublicFeature, FeatureConfiguration as PublicFeatureConfiguration, Project as PublicProject, Rollout as PublicRollout, RolloutStage as PublicRolloutStage, Target as PublicTarget, Variable as PublicVariable, Variation as PublicVariation, Rollout, RolloutStage, SDKEventRequestBody, SDKTypeValues, SemverFilterComparator, StringFilterComparator, Target, TargetAudience, TargetDistribution, TargetingRuleTypes, TopLevelOperator, UserError, UserSubType, Variable, VariableSource, VariableType, Variation, getVariableTypeFromValue, isValidDate, validate$1 as validate };
+export { Audience, AudienceFilter, AudienceFilterOrOperator, AudienceOperator, BooleanFilterComparator, ConfigBody, ConfigSource, DEFAULT_REASON_DETAILS, DVCAPIUser, DVCBucketingUser, DVCClientAPIUser, DVCEvent, DVCOptInUser, DVCPopulatedRequestEventDto, DataKeyType, EVAL_REASONS, EVAL_REASON_DETAILS, Environment, Feature, FeatureConfiguration, FeaturePrerequisites, FeatureSource, FeatureType, FeatureWinningVariation, FilterComparator, FilterType, IsDVCCustomDataJSONObject, ListAudience, ListAudienceSubType, NumberFilterComparator, Project, Audience as PublicAudience, Environment as PublicEnvironment, Feature as PublicFeature, FeatureConfiguration as PublicFeatureConfiguration, Project as PublicProject, Rollout as PublicRollout, RolloutStage as PublicRolloutStage, Target as PublicTarget, Variable as PublicVariable, Variation as PublicVariation, Rollout, RolloutStage, SDKEventRequestBody, SDKTypeValues, SemverFilterComparator, StringFilterComparator, Target, TargetAudience, TargetDistribution, TargetingRuleTypes, TopLevelOperator, UserError, UserSubType, Variable, VariableSource, VariableType, Variation, getVariableTypeFromValue, isValidDate, validate$1 as validate };

package.json

 {
   "name": "@devcycle/types",
-  "version": "1.27.0",
+  "version": "1.28.0",
   "license": "MIT",
@@ -5,0 +5,0 @@ "main": "./index.cjs.js",

src/types/apis/sdk/clientSDKAPI.d.ts

@@ -9,2 +9,44 @@ import { PublicEnvironment, PublicFeature, PublicProject, PublicVariable } from '../../config/configBody';
 };
+export declare enum EVAL_REASONS {
+    TARGETING_MATCH = "TARGETING_MATCH",
+    SPLIT = "SPLIT",
+    DEFAULT = "DEFAULT",
+    DISABLED = "DISABLED",
+    ERROR = "ERROR",
+    OVERRIDE = "OVERRIDE",
+    OPT_IN = "OPT_IN"
+}
+export declare enum EVAL_REASON_DETAILS {
+    ALL_USERS = "All Users",
+    AUDIENCE_MATCH = "Audience Match",
+    NOT_IN_AUDIENCE = "Not in Audience",
+    OPT_IN = "Opt-In",
+    NOT_OPTED_IN = "Not Opt-In",
+    OVERRIDE = "Override",
+    USER_ID = "User ID",
+    EMAIL = "Email",
+    COUNTRY = "Country",
+    PLATFORM = "Platform",
+    PLATFORM_VERSION = "Platform Version",
+    APP_VERSION = "App Version",
+    DEVICE_MODEL = "Device Model",
+    CUSTOM_DATA = "Custom Data"
+}
+export declare enum DEFAULT_REASON_DETAILS {
+    MISSING_CONFIG = "Missing Config",
+    MISSING_VARIABLE = "Missing Variable",
+    MISSING_FEATURE = "Missing Feature",
+    MISSING_VARIATION = "Missing Variation",
+    MISSING_VARIABLE_FOR_VARIATION = "Missing Variable for Variation",
+    USER_NOT_IN_ROLLOUT = "User Not in Rollout",
+    USER_NOT_TARGETED = "User Not Targeted",
+    INVALID_VARIABLE_TYPE = "Invalid Variable Type",
+    TYPE_MISMATCH = "Variable Type Mismatch",
+    UNKNOWN = "Unknown",
+    ERROR = "Error"
+}
+export type EvalReason = {
+    reason: EVAL_REASONS;
+    details?: string;
+};
 export type DVCCustomDataJSON = {
@@ -178,2 +220,3 @@ [key: string]: string | number | boolean | null;
     evalReason?: unknown;
+    eval?: EvalReason;
 };
@@ -184,3 +227,3 @@ export type SDKFeature = Pick<PublicFeature, '_id' | 'key' | 'type' | 'settings'> & {
     variationKey: string;
-    evalReason?: unknown;
+    eval?: EvalReason;
 };
@@ -187,0 +230,0 @@ type FeatureVariation = {

src/types/config/models/audience.d.ts

@@ -72,3 +72,2 @@ /**
     email = "email",
-    ip = "ip",
     country = "country",
@@ -75,0 +74,0 @@ platform = "platform",

ts3.5/src/types/apis/sdk/clientSDKAPI.d.ts

@@ -9,2 +9,44 @@ import { PublicEnvironment, PublicFeature, PublicProject, PublicVariable } from '../../config/configBody';
 };
+export declare enum EVAL_REASONS {
+    TARGETING_MATCH = "TARGETING_MATCH",
+    SPLIT = "SPLIT",
+    DEFAULT = "DEFAULT",
+    DISABLED = "DISABLED",
+    ERROR = "ERROR",
+    OVERRIDE = "OVERRIDE",
+    OPT_IN = "OPT_IN"
+}
+export declare enum EVAL_REASON_DETAILS {
+    ALL_USERS = "All Users",
+    AUDIENCE_MATCH = "Audience Match",
+    NOT_IN_AUDIENCE = "Not in Audience",
+    OPT_IN = "Opt-In",
+    NOT_OPTED_IN = "Not Opt-In",
+    OVERRIDE = "Override",
+    USER_ID = "User ID",
+    EMAIL = "Email",
+    COUNTRY = "Country",
+    PLATFORM = "Platform",
+    PLATFORM_VERSION = "Platform Version",
+    APP_VERSION = "App Version",
+    DEVICE_MODEL = "Device Model",
+    CUSTOM_DATA = "Custom Data"
+}
+export declare enum DEFAULT_REASON_DETAILS {
+    MISSING_CONFIG = "Missing Config",
+    MISSING_VARIABLE = "Missing Variable",
+    MISSING_FEATURE = "Missing Feature",
+    MISSING_VARIATION = "Missing Variation",
+    MISSING_VARIABLE_FOR_VARIATION = "Missing Variable for Variation",
+    USER_NOT_IN_ROLLOUT = "User Not in Rollout",
+    USER_NOT_TARGETED = "User Not Targeted",
+    INVALID_VARIABLE_TYPE = "Invalid Variable Type",
+    TYPE_MISMATCH = "Variable Type Mismatch",
+    UNKNOWN = "Unknown",
+    ERROR = "Error"
+}
+export type EvalReason = {
+    reason: EVAL_REASONS;
+    details?: string;
+};
 export type DVCCustomDataJSON = {
@@ -178,2 +220,3 @@ [key: string]: string | number | boolean | null;
     evalReason?: unknown;
+    eval?: EvalReason;
 };
@@ -184,3 +227,3 @@ export type SDKFeature = Pick<PublicFeature, '_id' | 'key' | 'type' | 'settings'> & {
     variationKey: string;
-    evalReason?: unknown;
+    eval?: EvalReason;
 };
@@ -187,0 +230,0 @@ type FeatureVariation = {

ts3.5/src/types/config/models/audience.d.ts

@@ -72,3 +72,2 @@ /**
     email = "email",
-    ip = "ip",
     country = "country",
@@ -75,0 +74,0 @@ platform = "platform",

No alert changes

Improved metrics

Total package byte prevSize

155162

4.86%

Lines of code

5009

3.6%

No dependency changes