@messagevisor/module-featurevisor 0.0.1 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [0.1.0](https://github.com/messagevisor/messagevisor/compare/v0.0.2...v0.1.0) (2026-05-31)
+
+**Note:** Version bump only for package @messagevisor/module-featurevisor
+
+
+
+
+
+## 0.0.2 (2026-05-31)
+
+**Note:** Version bump only for package @messagevisor/module-featurevisor

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Fahad Heylaal (https://fahad19.com)
+
+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.

package/README.md

@@ -0,0 +1,9 @@
+# @messagevisor/module-featurevisor
+
+Visit [https://messagevisor.com/docs/modules/featurevisor/](https://messagevisor.com/docs/modules/featurevisor/) for more information.
+
+Featurevisor docs available at: [https://featurevisor.com](https://featurevisor.com)
+
+## License
+
+MIT © [Fahad Heylaal](https://fahad19.com)

package/jest.config.js

@@ -0,0 +1,11 @@
+const base = require("../../jest.config");
+
+module.exports = {
+  ...base,
+  rootDir: "../..",
+  testRegex: undefined,
+  testMatch: ["<rootDir>/packages/module-featurevisor/src/**/*.spec.ts"],
+  moduleNameMapper: {
+    "^@messagevisor/sdk$": "<rootDir>/packages/sdk/src/index.ts",
+  },
+};

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+import type { FeaturevisorInstance } from "@featurevisor/sdk";
+import type { MessagevisorModule } from "@messagevisor/sdk";
+export interface FeaturevisorModuleOptions {
+    name?: string;
+    instance: FeaturevisorInstance;
+    passContext?: boolean;
+}
+export declare function createFeaturevisorModule(options: FeaturevisorModuleOptions): MessagevisorModule;

package/lib/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFeaturevisorModule = createFeaturevisorModule;
+function createFeaturevisorModule(options) {
+    const name = options.name || "featurevisor";
+    const instance = options.instance;
+    const passContext = options.passContext === true;
+    if (!instance) {
+        throw new Error("Featurevisor module requires an instance.");
+    }
+    return {
+        name,
+        setup({ setFlagResolver, setVariationResolver }) {
+            setFlagResolver((featureKey, context) => {
+                if (passContext) {
+                    return instance.isEnabled(featureKey, context);
+                }
+                return instance.isEnabled(featureKey);
+            });
+            setVariationResolver((experimentKey, context) => {
+                const variation = passContext
+                    ? instance.getVariation(experimentKey, context)
+                    : instance.getVariation(experimentKey);
+                return variation !== null && variation !== void 0 ? variation : null;
+            });
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAUA,4DA6BC;AA7BD,SAAgB,wBAAwB,CAAC,OAAkC;IACzE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,cAAc,CAAC;IAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,KAAK,IAAI,CAAC;IAEjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO;QACL,IAAI;QACJ,KAAK,CAAC,EAAE,eAAe,EAAE,oBAAoB,EAAE;YAC7C,eAAe,CAAC,CAAC,UAAU,EAAE,OAAiB,EAAE,EAAE;gBAChD,IAAI,WAAW,EAAE,CAAC;oBAChB,OAAO,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,OAA8B,CAAC,CAAC;gBACxE,CAAC;gBAED,OAAO,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,oBAAoB,CAAC,CAAC,aAAa,EAAE,OAAiB,EAAE,EAAE;gBACxD,MAAM,SAAS,GAAG,WAAW;oBAC3B,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,aAAa,EAAE,OAA8B,CAAC;oBACtE,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;gBAEzC,OAAO,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,15 +1,50 @@
 {
-	"name": "@messagevisor/module-featurevisor",
-	"version": "0.0.1",
-	"description": "Messagevisor package",
-	"license": "ISC",
-	"author": "",
-	"type": "commonjs",
-	"main": "index.js",
-	"publishConfig": {
-		"access": "public"
-	},
-	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
-	}
+  "name": "@messagevisor/module-featurevisor",
+  "version": "0.1.0",
+  "description": "Featurevisor integration module for Messagevisor",
+  "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "require": "./lib/index.js",
+      "import": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "transpile": "rimraf lib && tsc --project tsconfig.cjs.json",
+    "dist": "echo 'Nothing to dist here'",
+    "build": "npm run transpile",
+    "test": "jest --config jest.config.js --verbose",
+    "typecheck": "tsc --noEmit --skipLibCheck -p tsconfig.typecheck.json"
+  },
+  "author": {
+    "name": "Fahad Heylaal",
+    "url": "https://fahad19.com"
+  },
+  "homepage": "https://messagevisor.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/messagevisor/messagevisor.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "bugs": {
+    "url": "https://github.com/messagevisor/messagevisor/issues"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@messagevisor/sdk": "0.1.0"
+  },
+  "peerDependencies": {
+    "@featurevisor/sdk": ">=2.27.0"
+  },
+  "devDependencies": {
+    "@featurevisor/sdk": "^2.27.0"
+  },
+  "gitHead": "555119ab05473127a658ed0cfb6a2743ea3a6db8"
 }

package/src/index.spec.ts

@@ -0,0 +1,240 @@
+import { createInstance, type FeaturevisorInstance } from "@featurevisor/sdk";
+import { createMessagevisor } from "@messagevisor/sdk";
+import type { DatafileContent } from "@messagevisor/types";
+
+import { createFeaturevisorModule } from "./index";
+
+const datafile: DatafileContent = {
+  schemaVersion: "1",
+  messagevisorVersion: "0.0.1",
+  revision: "1",
+  target: "web",
+  locale: "en-US",
+  segments: {},
+  messages: {
+    checkout: {
+      overrides: [
+        {
+          key: "feature-enabled",
+          conditions: {
+            feature: "new-checkout",
+            operator: "isEnabled",
+          },
+          translation: "Fast checkout",
+        },
+        {
+          key: "feature-disabled",
+          conditions: {
+            feature: "legacy-checkout",
+            operator: "isDisabled",
+          },
+          translation: "Classic checkout",
+        },
+      ],
+    },
+    experiment: {
+      overrides: [
+        {
+          key: "bold-copy",
+          conditions: {
+            experiment: "checkout-copy",
+            operator: "hasVariation",
+            value: "bold",
+          },
+          translation: "Bold checkout copy",
+        },
+      ],
+    },
+    missingExperiment: {
+      overrides: [
+        {
+          key: "missing",
+          conditions: {
+            experiment: "missing-copy",
+            operator: "hasVariation",
+            value: "bold",
+          },
+          translation: "Missing experiment matched",
+        },
+      ],
+    },
+  },
+  translations: {
+    checkout: "Default checkout",
+    experiment: "Default experiment",
+    missingExperiment: "Default missing experiment",
+  },
+};
+
+describe("@messagevisor/module-featurevisor", function () {
+  it("connects feature and experiment conditions to a Featurevisor instance", function () {
+    const f = createInstance({
+      logLevel: "fatal",
+      sticky: {
+        "new-checkout": {
+          enabled: true,
+        },
+        "legacy-checkout": {
+          enabled: false,
+        },
+        "checkout-copy": {
+          enabled: true,
+          variation: "bold",
+        },
+      },
+    });
+    const m = createMessagevisor({
+      datafile,
+      logLevel: "fatal",
+      modules: [createFeaturevisorModule({ instance: f })],
+    });
+
+    expect(m.translate("checkout")).toEqual("Fast checkout");
+    expect(m.translate("experiment")).toEqual("Bold checkout copy");
+    expect(m.translate("missingExperiment")).toEqual("Default missing experiment");
+  });
+
+  it("supports isDisabled feature conditions", function () {
+    const f = createInstance({
+      logLevel: "fatal",
+      sticky: {
+        "new-checkout": {
+          enabled: false,
+        },
+        "legacy-checkout": {
+          enabled: false,
+        },
+      },
+    });
+    const m = createMessagevisor({
+      datafile,
+      logLevel: "fatal",
+      modules: [createFeaturevisorModule({ instance: f })],
+    });
+
+    expect(m.translate("checkout")).toEqual("Classic checkout");
+  });
+
+  it("does not pass Messagevisor context to Featurevisor evaluations by default", function () {
+    const calls: Array<{ method: string; key: string; context: unknown }> = [];
+    const instance = {
+      isEnabled(featureKey, context) {
+        calls.push({ method: "isEnabled", key: featureKey, context });
+        return true;
+      },
+      getVariation(experimentKey, context) {
+        calls.push({ method: "getVariation", key: experimentKey, context });
+        return "bold";
+      },
+    } as unknown as FeaturevisorInstance;
+    const m = createMessagevisor({
+      datafile,
+      logLevel: "fatal",
+      context: {
+        platform: "web",
+        plan: "pro",
+      },
+      modules: [createFeaturevisorModule({ instance })],
+    });
+
+    expect(m.translate("checkout", {}, { context: { userId: "user-123" } })).toEqual(
+      "Fast checkout",
+    );
+    expect(m.translate("experiment")).toEqual("Bold checkout copy");
+    expect(calls).toEqual([
+      {
+        method: "isEnabled",
+        key: "new-checkout",
+        context: undefined,
+      },
+      {
+        method: "getVariation",
+        key: "checkout-copy",
+        context: undefined,
+      },
+    ]);
+  });
+
+  it("passes merged Messagevisor context to Featurevisor evaluations when enabled", function () {
+    const calls: Array<{ method: string; key: string; context: unknown }> = [];
+    const instance = {
+      isEnabled(featureKey, context) {
+        calls.push({ method: "isEnabled", key: featureKey, context });
+        return context?.platform === "web" && context?.userId === "user-123";
+      },
+      getVariation(experimentKey, context) {
+        calls.push({ method: "getVariation", key: experimentKey, context });
+        return context?.plan === "pro" ? "bold" : null;
+      },
+    } as unknown as FeaturevisorInstance;
+    const m = createMessagevisor({
+      datafile,
+      logLevel: "fatal",
+      context: {
+        platform: "web",
+        plan: "pro",
+      },
+      modules: [createFeaturevisorModule({ instance, passContext: true })],
+    });
+
+    expect(m.translate("checkout", {}, { context: { userId: "user-123" } })).toEqual(
+      "Fast checkout",
+    );
+    expect(m.translate("experiment")).toEqual("Bold checkout copy");
+    expect(calls).toEqual([
+      {
+        method: "isEnabled",
+        key: "new-checkout",
+        context: {
+          platform: "web",
+          plan: "pro",
+          userId: "user-123",
+        },
+      },
+      {
+        method: "getVariation",
+        key: "checkout-copy",
+        context: {
+          platform: "web",
+          plan: "pro",
+        },
+      },
+    ]);
+  });
+
+  it("converts null variations to non-matches", function () {
+    const instance = {
+      isEnabled() {
+        return false;
+      },
+      getVariation() {
+        return null;
+      },
+    } as unknown as FeaturevisorInstance;
+    const m = createMessagevisor({
+      datafile,
+      logLevel: "fatal",
+      modules: [createFeaturevisorModule({ instance })],
+    });
+
+    expect(m.translate("experiment")).toEqual("Default experiment");
+  });
+
+  it("uses a stable default module name and supports custom names", function () {
+    expect(createFeaturevisorModule({ instance: {} as FeaturevisorInstance }).name).toEqual(
+      "featurevisor",
+    );
+    expect(
+      createFeaturevisorModule({
+        name: "flags",
+        instance: {} as FeaturevisorInstance,
+      }).name,
+    ).toEqual("flags");
+  });
+
+  it("requires a Featurevisor instance", function () {
+    expect(() => createFeaturevisorModule({ instance: undefined as any })).toThrow(
+      "Featurevisor module requires an instance.",
+    );
+  });
+});

package/src/index.ts

@@ -0,0 +1,40 @@
+import type { Context as FeaturevisorContext, FeaturevisorInstance } from "@featurevisor/sdk";
+import type { MessagevisorModule } from "@messagevisor/sdk";
+import type { Context } from "@messagevisor/types";
+
+export interface FeaturevisorModuleOptions {
+  name?: string;
+  instance: FeaturevisorInstance;
+  passContext?: boolean;
+}
+
+export function createFeaturevisorModule(options: FeaturevisorModuleOptions): MessagevisorModule {
+  const name = options.name || "featurevisor";
+  const instance = options.instance;
+  const passContext = options.passContext === true;
+
+  if (!instance) {
+    throw new Error("Featurevisor module requires an instance.");
+  }
+
+  return {
+    name,
+    setup({ setFlagResolver, setVariationResolver }) {
+      setFlagResolver((featureKey, context?: Context) => {
+        if (passContext) {
+          return instance.isEnabled(featureKey, context as FeaturevisorContext);
+        }
+
+        return instance.isEnabled(featureKey);
+      });
+
+      setVariationResolver((experimentKey, context?: Context) => {
+        const variation = passContext
+          ? instance.getVariation(experimentKey, context as FeaturevisorContext)
+          : instance.getVariation(experimentKey);
+
+        return variation ?? null;
+      });
+    },
+  };
+}

package/tsconfig.cjs.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.cjs.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "target": "es2018",
+    "lib": ["es2021", "es2021.intl", "dom"],
+    "skipLibCheck": true
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["./src/**/*.spec.ts"]
+}

package/tsconfig.typecheck.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.cjs.json",
+  "exclude": []
+}