@messagevisor/core 0.0.1 → 0.1.0

package/src/sets.ts

@@ -0,0 +1,74 @@
+import * as path from "path";
+
+import type { ProjectConfig } from "./config";
+import type { Datasource } from "./datasource";
+import { MessagevisorCLIError } from "./error";
+
+export interface ProjectSetExecution {
+  set: string;
+  projectConfig: ProjectConfig;
+  datasource: Datasource;
+}
+
+export async function getProjectSetExecutions(
+  projectConfig: ProjectConfig,
+  datasource: Datasource,
+  selectedSet?: string,
+): Promise<ProjectSetExecution[]> {
+  if (!projectConfig.sets) {
+    return [{ set: "", projectConfig, datasource }];
+  }
+
+  const availableSetKeys = await datasource.listSets();
+
+  if (selectedSet && !availableSetKeys.includes(selectedSet)) {
+    throw new MessagevisorCLIError(
+      `Unknown set "${selectedSet}". Available sets: ${availableSetKeys.join(", ") || "none"}.`,
+    );
+  }
+
+  const setKeys = selectedSet ? [selectedSet] : availableSetKeys;
+
+  if (setKeys.length === 0) {
+    throw new MessagevisorCLIError(`No sets found in ${projectConfig.setsDirectoryPath}.`);
+  }
+
+  return setKeys.map((set) => {
+    const setDatasource = datasource.forSet(set);
+
+    return {
+      set,
+      projectConfig: setDatasource.getConfig(),
+      datasource: setDatasource,
+    };
+  });
+}
+
+export function assertProjectSetJsonSelection(
+  projectConfig: ProjectConfig,
+  selectedSet: string | undefined,
+  json: boolean | undefined,
+) {
+  if (projectConfig.sets && json && !selectedSet) {
+    throw new MessagevisorCLIError(
+      "Pass --set=<set> when using --json in a project with sets enabled.",
+    );
+  }
+}
+
+export function getProjectSetRelativeFilePath(
+  projectConfig: ProjectConfig,
+  set: string,
+  filePath: string,
+) {
+  const setDirectoryPath = path.relative(
+    process.cwd(),
+    path.join(projectConfig.setsDirectoryPath, set),
+  );
+
+  if (filePath === setDirectoryPath || filePath.startsWith(`${setDirectoryPath}${path.sep}`)) {
+    return filePath;
+  }
+
+  return path.join(setDirectoryPath, filePath);
+}

package/src/tester/cliFormat.ts

@@ -0,0 +1,11 @@
+export const CLI_FORMAT_RED = "\x1b[31m%s\x1b[0m";
+export const CLI_FORMAT_GREEN = "\x1b[32m%s\x1b[0m";
+export const CLI_FORMAT_YELLOW = "\x1b[33m%s\x1b[0m";
+export const CLI_FORMAT_CYAN = "\x1b[36m%s\x1b[0m";
+export const CLI_FORMAT_DIM = "\x1b[2m%s\x1b[0m";
+export const CLI_FORMAT_BOLD = "\x1b[1m%s\x1b[0m";
+export const CLI_FORMAT_BOLD_UNDERLINE = "\x1b[1m\x1b[4m%s\x1b[0m";
+
+export function colorize(value: string, colorCode: number) {
+  return `\x1b[${colorCode}m${value}\x1b[0m`;
+}

package/src/tester/featurevisorIntegration.spec.ts

@@ -0,0 +1,101 @@
+import { createInstance as createFeaturevisor } from "@featurevisor/sdk";
+import { createMessagevisor } from "@messagevisor/sdk";
+import type { DatafileContent } from "@messagevisor/types";
+
+const messagevisorDatafile: DatafileContent = {
+  schemaVersion: "1",
+  messagevisorVersion: "0.0.1",
+  revision: "1",
+  target: "web",
+  locale: "en-US",
+  segments: {},
+  translations: {
+    checkoutBanner: "Classic checkout",
+    disabledBanner: "Checkout enabled",
+  },
+  messages: {
+    checkoutBanner: {
+      overrides: [
+        {
+          key: "faster-checkout-bold",
+          conditions: {
+            and: [
+              { feature: "new-checkout", operator: "isEnabled" },
+              { experiment: "checkout-copy", operator: "hasVariation", value: "bold" },
+            ],
+          },
+          translation: "Faster checkout",
+        },
+      ],
+    },
+    disabledBanner: {
+      overrides: [
+        {
+          key: "checkout-disabled",
+          conditions: { feature: "new-checkout", operator: "isDisabled" },
+          translation: "Checkout disabled",
+        },
+      ],
+    },
+  },
+};
+
+const featurevisorDatafile = {
+  schemaVersion: "2",
+  revision: "1",
+  segments: {},
+  features: {
+    "new-checkout": {
+      key: "new-checkout",
+      bucketBy: "userId",
+      traffic: [
+        {
+          key: "1",
+          segments: "*",
+          percentage: 100000,
+          allocation: [],
+        },
+      ],
+    },
+    "checkout-copy": {
+      key: "checkout-copy",
+      bucketBy: "userId",
+      variations: [{ value: "control" }, { value: "bold" }],
+      traffic: [
+        {
+          key: "1",
+          segments: "*",
+          percentage: 100000,
+          allocation: [
+            { variation: "control", range: [0, 0] },
+            { variation: "bold", range: [0, 100000] },
+          ],
+        },
+      ],
+    },
+  },
+};
+
+describe("Featurevisor integration", function () {
+  it("uses Featurevisor SDK evaluations for Messagevisor feature and experiment conditions", function () {
+    const context = { userId: "user-123" };
+    const featurevisor = createFeaturevisor({
+      datafile: featurevisorDatafile as any,
+      context,
+      logLevel: "warn",
+    });
+    const messagevisor = createMessagevisor({
+      datafile: messagevisorDatafile,
+      context,
+      resolveFlag: (featureKey) => featurevisor.isEnabled(featureKey, context),
+      resolveVariation: (experimentKey) =>
+        featurevisor.getVariation(experimentKey, context) as string,
+      logLevel: "warn",
+    });
+
+    expect(featurevisor.isEnabled("new-checkout", context)).toEqual(true);
+    expect(featurevisor.getVariation("checkout-copy", context)).toEqual("bold");
+    expect(messagevisor.translate("checkoutBanner")).toEqual("Faster checkout");
+    expect(messagevisor.translate("disabledBanner")).toEqual("Checkout enabled");
+  });
+});