@featurevisor/sdk 1.35.3 → 2.0.0

package/src/child.ts

@@ -0,0 +1,285 @@
+import type {
+  Context,
+  StickyFeatures,
+  FeatureKey,
+  VariationValue,
+  VariableValue,
+  EvaluatedFeatures,
+} from "@featurevisor/types";
+
+import { EventName, EventCallback, Emitter } from "./emitter";
+import type { FeaturevisorInstance, OverrideOptions } from "./instance";
+import { getParamsForStickySetEvent } from "./events";
+
+export class FeaturevisorChildInstance {
+  private parent: FeaturevisorInstance;
+  private context: Context;
+  private sticky: StickyFeatures;
+  private emitter: Emitter;
+
+  constructor(options) {
+    this.parent = options.parent;
+    this.context = options.context;
+    this.sticky = options.sticky || {};
+    this.emitter = new Emitter();
+  }
+
+  on(eventName: EventName, callback: EventCallback) {
+    if (eventName === "context_set" || eventName === "sticky_set") {
+      return this.emitter.on(eventName, callback);
+    }
+
+    return this.parent.on(eventName, callback);
+  }
+
+  close() {
+    this.emitter.clearAll();
+  }
+
+  setContext(context: Context, replace = false) {
+    if (replace) {
+      this.context = context;
+    } else {
+      this.context = { ...this.context, ...context };
+    }
+
+    this.emitter.trigger("context_set", {
+      context: this.context,
+      replaced: replace,
+    });
+  }
+
+  getContext(context?: Context): Context {
+    return this.parent.getContext({
+      ...this.context,
+      ...context,
+    });
+  }
+
+  setSticky(sticky: StickyFeatures, replace = false) {
+    const previousStickyFeatures = this.sticky || {};
+
+    if (replace) {
+      this.sticky = { ...sticky };
+    } else {
+      this.sticky = {
+        ...this.sticky,
+        ...sticky,
+      };
+    }
+
+    const params = getParamsForStickySetEvent(previousStickyFeatures, this.sticky, replace);
+
+    this.emitter.trigger("sticky_set", params);
+  }
+
+  isEnabled(featureKey: FeatureKey, context: Context = {}, options: OverrideOptions = {}): boolean {
+    return this.parent.isEnabled(
+      featureKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariation(
+    featureKey: FeatureKey,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): VariationValue | null {
+    return this.parent.getVariation(
+      featureKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariable(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): VariableValue | null {
+    return this.parent.getVariable(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariableBoolean(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): boolean | null {
+    return this.parent.getVariableBoolean(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariableString(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): string | null {
+    return this.parent.getVariableString(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariableInteger(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): number | null {
+    return this.parent.getVariableInteger(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariableDouble(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): number | null {
+    return this.parent.getVariableDouble(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariableArray(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): string[] | null {
+    return this.parent.getVariableArray(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariableObject<T>(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): T | null {
+    return this.parent.getVariableObject<T>(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getVariableJSON<T>(
+    featureKey: FeatureKey,
+    variableKey: string,
+    context: Context = {},
+    options: OverrideOptions = {},
+  ): T | null {
+    return this.parent.getVariableJSON<T>(
+      featureKey,
+      variableKey,
+      {
+        ...this.context,
+        ...context,
+      },
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+
+  getAllEvaluations(
+    context: Context = {},
+    featureKeys: string[] = [],
+    options: OverrideOptions = {},
+  ): EvaluatedFeatures {
+    return this.parent.getAllEvaluations(
+      {
+        ...this.context,
+        ...context,
+      },
+      featureKeys,
+      {
+        sticky: this.sticky,
+        ...options,
+      },
+    );
+  }
+}

package/src/compareVersions.ts

@@ -0,0 +1,93 @@
+// taken from: https://github.com/omichelsen/compare-versions
+// this is done to avoid loading the whole package
+
+/*
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 Ole Michelsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+
+export const semver =
+  /^[v^~<>=]*?(\d+)(?:\.([x*]|\d+)(?:\.([x*]|\d+)(?:\.([x*]|\d+))?(?:-([\da-z\-]+(?:\.[\da-z\-]+)*))?(?:\+[\da-z\-]+(?:\.[\da-z\-]+)*)?)?)?$/i;
+
+export const validateAndParse = (version: string) => {
+  if (typeof version !== "string") {
+    throw new TypeError("Invalid argument expected string");
+  }
+  const match = version.match(semver);
+  if (!match) {
+    throw new Error(`Invalid argument not valid semver ('${version}' received)`);
+  }
+  match.shift();
+  return match;
+};
+
+const isWildcard = (s: string) => s === "*" || s === "x" || s === "X";
+
+const forceType = (a: string | number, b: string | number) =>
+  typeof a !== typeof b ? [String(a), String(b)] : [a, b];
+
+const tryParse = (v: string) => {
+  const n = parseInt(v, 10);
+  return isNaN(n) ? v : n;
+};
+
+const compareStrings = (a: string, b: string) => {
+  if (isWildcard(a) || isWildcard(b)) return 0;
+  const [ap, bp] = forceType(tryParse(a), tryParse(b));
+  if (ap > bp) return 1;
+  if (ap < bp) return -1;
+  return 0;
+};
+
+export const compareSegments = (
+  a: string | string[] | RegExpMatchArray,
+  b: string | string[] | RegExpMatchArray,
+) => {
+  for (let i = 0; i < Math.max(a.length, b.length); i++) {
+    const r = compareStrings(a[i] || "0", b[i] || "0");
+    if (r !== 0) return r;
+  }
+  return 0;
+};
+
+export const compareVersions = (v1: string, v2: string) => {
+  // validate input and split into segments
+  const n1 = validateAndParse(v1);
+  const n2 = validateAndParse(v2);
+
+  // pop off the patch
+  const p1 = n1.pop();
+  const p2 = n2.pop();
+
+  // validate numbers
+  const r = compareSegments(n1, n2);
+  if (r !== 0) return r;
+
+  // validate pre-release
+  if (p1 && p2) {
+    return compareSegments(p1.split("."), p2.split("."));
+  } else if (p1 || p2) {
+    return p1 ? -1 : 1;
+  }
+
+  return 0;
+};