@antelopejs/dms 0.9.2 → 0.9.3

package/frontend-vue/tests/form-validation.test.ts

@@ -1,213 +0,0 @@
-// @vitest-environment jsdom
-import { afterEach, describe, expect, it, vi } from "vitest";
-import { nextTick, reactive, ref } from "vue";
-import * as z from "zod";
-import {
-  codeEntryError,
-  focusFirstFormError,
-  isBlankValue,
-  localizeSchema,
-  requiredError,
-  useLiveFormErrors,
-} from "../layers/dms-core/app/composables/useFormValidation";
-import { passwordSchema } from "../layers/dms-ui/app/composables/usePasswordStrength";
-import { useCodeFieldError } from "../layers/dms-layout/app/build/composables/settings/security/useCodeFieldError";
-
-/** Marks the keys it translates, so a test sees what went through i18n. */
-const translate = (key: string) => `t(${key})`;
-
-async function issuesOf(
-  schema: z.ZodTypeAny,
-  value: unknown,
-): Promise<Array<{ message: string; path?: PropertyKey[] }>> {
-  const result = await localizeSchema(schema, translate)["~standard"].validate(
-    value,
-  );
-  return "issues" in result && result.issues ? result.issues : [];
-}
-
-describe("isBlankValue / requiredError", () => {
-  it.each([undefined, null, "", "   ", [], ["", " "]])(
-    "treats %j as not filled",
-    (value) => {
-      expect(isBlankValue(value)).toBe(true);
-      expect(requiredError(value)).toBe("$dms.field_errors.required");
-    },
-  );
-
-  it.each(["a", 0, false, ["1"]])("treats %j as filled", (value) => {
-    expect(isBlankValue(value)).toBe(false);
-    expect(requiredError(value)).toBeUndefined();
-  });
-});
-
-describe("codeEntryError", () => {
-  it("says required with no digit, incomplete with some, nothing when full", () => {
-    expect(codeEntryError(undefined, 6)).toBe("$dms.field_errors.required");
-    expect(codeEntryError(["", "", ""], 6)).toBe("$dms.field_errors.required");
-    expect(codeEntryError(["1", "2", "3"], 6)).toBe(
-      "$dms.field_errors.code_incomplete",
-    );
-    expect(codeEntryError(["1", "", "3", "4", "5", "6"], 6)).toBe(
-      "$dms.field_errors.code_incomplete",
-    );
-    expect(codeEntryError(["1", "2", "3", "4", "5", "6"], 6)).toBeUndefined();
-  });
-});
-
-describe("localizeSchema", () => {
-  const login = z.object({
-    email: z.string().trim().email(),
-    password: z.string().nonempty(),
-    name: z.string().trim().min(2),
-  });
-
-  it("words an empty field as required, whatever zod checked", async () => {
-    expect(await issuesOf(login, {})).toEqual([
-      { message: "t(dms.field_errors.required)", path: ["email"] },
-      { message: "t(dms.field_errors.required)", path: ["password"] },
-      { message: "t(dms.field_errors.required)", path: ["name"] },
-    ]);
-    // Typed then cleared: still "required", not "invalid e-mail".
-    expect(
-      await issuesOf(login, { email: " ", password: "", name: "" }),
-    ).toEqual([
-      { message: "t(dms.field_errors.required)", path: ["email"] },
-      { message: "t(dms.field_errors.required)", path: ["password"] },
-      { message: "t(dms.field_errors.required)", path: ["name"] },
-    ]);
-  });
-
-  it("words a malformed value with the dashboard's messages", async () => {
-    expect(
-      await issuesOf(login, { email: "nope", password: "x", name: "A" }),
-    ).toEqual([
-      { message: "t(dms.field_errors.invalid_email)", path: ["email"] },
-      { message: "t(dms.field_errors.too_short)", path: ["name"] },
-    ]);
-  });
-
-  it("translates a $key message and keeps one already in prose", async () => {
-    const schema = z.object({
-      code: z.string().refine(() => false, { message: "$page.custom.key" }),
-      note: z.string().refine(() => false, { message: "Already translated" }),
-    });
-    expect(await issuesOf(schema, { code: "a", note: "b" })).toEqual([
-      { message: "t(page.custom.key)", path: ["code"] },
-      { message: "Already translated", path: ["note"] },
-    ]);
-  });
-
-  it("hands the parsed value (transforms applied) back on success", async () => {
-    const schema = z.object({
-      code: z
-        .string()
-        .trim()
-        .transform((code) => code.toUpperCase()),
-    });
-    expect(
-      await localizeSchema(schema, translate)["~standard"].validate({
-        code: " abcd ",
-      }),
-    ).toEqual({ value: { code: "ABCD" } });
-  });
-
-  it("says required for an empty new password, the rules for a weak one", async () => {
-    const schema = z.object({ password: passwordSchema });
-    expect(await issuesOf(schema, {})).toEqual([
-      { message: "t(dms.field_errors.required)", path: ["password"] },
-    ]);
-    expect((await issuesOf(schema, { password: "" }))[0]).toEqual({
-      message: "t(dms.field_errors.required)",
-      path: ["password"],
-    });
-    expect((await issuesOf(schema, { password: "abc" }))[0]).toEqual({
-      message: "t(dms.field_errors.password_rules)",
-      path: ["password"],
-    });
-    expect(await issuesOf(schema, { password: "Abcdefg1!" })).toEqual([]);
-  });
-});
-
-describe("focusFirstFormError", () => {
-  afterEach(() => {
-    document.body.innerHTML = "";
-    vi.useRealTimers();
-  });
-
-  it("focuses the first control in error in page order, once enabled", () => {
-    vi.useFakeTimers();
-    document.body.innerHTML =
-      '<input id="first" disabled><input id="second"><input id="third">';
-    focusFirstFormError([{ id: "third" }, { id: "first" }, { id: "missing" }]);
-    // UForm re-enables its fields after emitting the error.
-    document.getElementById("first")!.removeAttribute("disabled");
-    vi.runAllTimers();
-    expect(document.activeElement?.id).toBe("first");
-  });
-});
-
-describe("useLiveFormErrors", () => {
-  it("re-checks a field in error as soon as it changes, only that one", async () => {
-    const state = reactive<Record<string, unknown>>({ email: "", name: "" });
-    const validate = vi.fn(async () => undefined);
-    const errors = new Set(["email"]);
-    const form = ref({
-      getErrors: (name?: string) => (name && errors.has(name) ? [{}] : []),
-      validate,
-    });
-    useLiveFormErrors(form, state);
-
-    state.name = "Camille";
-    await nextTick();
-    expect(validate).not.toHaveBeenCalled();
-
-    state.email = "c@example.com";
-    await nextTick();
-    expect(validate).toHaveBeenCalledExactlyOnceWith({
-      name: "email",
-      silent: true,
-    });
-  });
-});
-
-describe("useCodeFieldError", () => {
-  function setup() {
-    const container = document.createElement("div");
-    container.innerHTML = "<input><input><input>";
-    document.body.append(container);
-    const digits = ref<string[]>(["1", "2"]);
-    const error = ref<string>();
-    const { flag } = useCodeFieldError(digits, error, ref(container));
-    return { container, digits, error, flag };
-  }
-
-  afterEach(() => {
-    document.body.innerHTML = "";
-  });
-
-  it("keeps the digits of a code flagged before sending, focuses the gap", async () => {
-    const { container, digits, error, flag } = setup();
-    container.querySelectorAll("input")[0]!.value = "1";
-    flag("Enter every digit of the code.");
-    await nextTick();
-    await nextTick();
-    expect(error.value).toBe("Enter every digit of the code.");
-    expect(digits.value).toEqual(["1", "2"]);
-    expect(document.activeElement).toBe(container.querySelectorAll("input")[1]);
-
-    // Typing clears it.
-    digits.value = ["1", "2", "3"];
-    await nextTick();
-    expect(error.value).toBeUndefined();
-  });
-
-  it("empties the cells after a code the API refused", async () => {
-    const { digits, error } = setup();
-    error.value = "That code is invalid.";
-    await nextTick();
-    await nextTick();
-    expect(digits.value).toEqual([]);
-    expect(error.value).toBe("That code is invalid.");
-  });
-});

package/frontend-vue/tests/github-star-prompt.test.ts

@@ -1,328 +0,0 @@
-// @vitest-environment jsdom
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import {
-  computed,
-  createApp,
-  defineComponent,
-  h,
-  nextTick,
-  ref,
-  type App,
-  type Component,
-  type Ref,
-} from "vue";
-import GithubStarPrompt from "../layers/dms-layout/app/build/components/layout/GithubStarPrompt.vue";
-import EmptyLayout from "../layers/dms-layout/app/custom-layouts/EmptyLayout.vue";
-import SaveBar from "../layers/dms-ui/app/components/save-bar/SaveBar.vue";
-import {
-  GITHUB_STAR_PROMPT_DELAY_MS,
-  GITHUB_STAR_PROMPT_KEYS,
-  GITHUB_STAR_PROMPT_SNOOZE_MS,
-  GITHUB_STAR_PROMPT_TICK_MS,
-} from "../layers/dms-layout/app/build/composables/general/useGithubStarPrompt";
-import { GITHUB_REPOSITORY_URL } from "../layers/dms-layout/app/build/utils/github-repository";
-
-vi.mock("../layers/dms-layout/app/build/components/layout/Footer.vue", () => ({
-  default: { render: () => null },
-}));
-
-const MINUTE_MS = 60 * 1000;
-const HOUR_MS = 60 * MINUTE_MS;
-
-let storage: Map<string, string>;
-let user: Ref<object | null>;
-let toasts: Ref<object[]>;
-let visibility: DocumentVisibilityState;
-let app: App | undefined;
-let host: HTMLDivElement;
-
-const ButtonStub = defineComponent({
-  inheritAttrs: false,
-  props: { label: { type: String, default: undefined } },
-  emits: ["click"],
-  setup:
-    (props, { attrs, emit }) =>
-    () =>
-      h(
-        "button",
-        {
-          type: "button",
-          "data-action": attrs["data-action"],
-          "aria-label": attrs["aria-label"],
-          onClick: () => emit("click"),
-        },
-        props.label,
-      ),
-});
-
-const memoryStorage = {
-  getItem: (key: string) => storage.get(key) ?? null,
-  setItem: (key: string, value: string) => void storage.set(key, value),
-  removeItem: (key: string) => void storage.delete(key),
-};
-
-const throwingStorage = {
-  getItem: () => {
-    throw new Error("SecurityError");
-  },
-  setItem: () => {
-    throw new Error("QuotaExceededError");
-  },
-};
-
-async function mount(component: Component = GithubStarPrompt): Promise<void> {
-  host = document.createElement("div");
-  document.body.append(host);
-  app = createApp(component);
-  app.component("UButton", ButtonStub);
-  app.component("UIcon", { render: () => null });
-  app.component("DmsIconWell", { render: () => null });
-  app.component("DmsAppLogo", { render: () => null });
-  app.mount(host);
-  await nextTick();
-}
-
-function prompt(): HTMLElement | null {
-  return host.querySelector('[role="dialog"]');
-}
-
-async function click(action: string): Promise<void> {
-  host.querySelector<HTMLButtonElement>(`[data-action="${action}"]`)!.click();
-  await nextTick();
-}
-
-async function advance(ms: number): Promise<void> {
-  vi.advanceTimersByTime(ms);
-  await nextTick();
-}
-
-async function setVisibility(state: DocumentVisibilityState): Promise<void> {
-  visibility = state;
-  document.dispatchEvent(new Event("visibilitychange"));
-  await nextTick();
-}
-
-function seedActiveTime(ms: number): void {
-  storage.set(GITHUB_STAR_PROMPT_KEYS.activeMs, String(ms));
-}
-
-beforeEach(() => {
-  vi.useFakeTimers();
-  vi.stubEnv("DEV", true);
-  storage = new Map();
-  user = ref({ email: "user@example.com" });
-  toasts = ref([]);
-  visibility = "visible";
-  vi.spyOn(document, "visibilityState", "get").mockImplementation(
-    () => visibility,
-  );
-  vi.stubGlobal("localStorage", memoryStorage);
-  vi.stubGlobal("computed", computed);
-  vi.stubGlobal("ref", ref);
-  vi.stubGlobal("useI18n", () => ({ t: (key: string) => key }));
-  vi.stubGlobal("useCurrentUser", () => ({ user }));
-  vi.stubGlobal("useToast", () => ({ toasts }));
-  vi.stubGlobal("useColorModePreference", () => ref("system"));
-  vi.stubGlobal("open", vi.fn());
-});
-
-afterEach(() => {
-  app?.unmount();
-  app = undefined;
-  host?.remove();
-  vi.useRealTimers();
-  vi.restoreAllMocks();
-  vi.unstubAllGlobals();
-  vi.unstubAllEnvs();
-});
-
-describe("GithubStarPrompt", () => {
-  it("stays hidden before 15 minutes of use", async () => {
-    await mount();
-    await advance(GITHUB_STAR_PROMPT_DELAY_MS - GITHUB_STAR_PROMPT_TICK_MS);
-
-    expect(prompt()).toBeNull();
-    expect(Number(storage.get(GITHUB_STAR_PROMPT_KEYS.activeMs))).toBe(
-      GITHUB_STAR_PROMPT_DELAY_MS - GITHUB_STAR_PROMPT_TICK_MS,
-    );
-  });
-
-  it("shows in dev mode after 15 minutes of visible time, added up across sessions", async () => {
-    seedActiveTime(10 * MINUTE_MS);
-    await mount();
-    await advance(4 * MINUTE_MS);
-    expect(prompt()).toBeNull();
-
-    await advance(MINUTE_MS);
-
-    expect(prompt()).not.toBeNull();
-    expect(prompt()!.getAttribute("aria-labelledby")).toBeTruthy();
-  });
-
-  it("does not count the time the tab is hidden", async () => {
-    seedActiveTime(14 * MINUTE_MS);
-    await mount();
-    await setVisibility("hidden");
-    await advance(HOUR_MS);
-    expect(prompt()).toBeNull();
-
-    await setVisibility("visible");
-    await advance(MINUTE_MS);
-
-    expect(prompt()).not.toBeNull();
-  });
-
-  it("hides on Later and shows again 48 hours after", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    await mount();
-    expect(prompt()).not.toBeNull();
-
-    await click("later");
-
-    expect(prompt()).toBeNull();
-    expect(Number(storage.get(GITHUB_STAR_PROMPT_KEYS.snoozedUntil))).toBe(
-      Date.now() + GITHUB_STAR_PROMPT_SNOOZE_MS,
-    );
-    await advance(GITHUB_STAR_PROMPT_SNOOZE_MS - HOUR_MS);
-    expect(prompt()).toBeNull();
-
-    await advance(HOUR_MS);
-    expect(prompt()).not.toBeNull();
-  });
-
-  it("opens the repository on star, and never shows again", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    await mount();
-
-    await click("star");
-
-    expect(window.open).toHaveBeenCalledWith(
-      GITHUB_REPOSITORY_URL,
-      "_blank",
-      "noopener,noreferrer",
-    );
-    expect(prompt()).toBeNull();
-    expect(storage.get(GITHUB_STAR_PROMPT_KEYS.dismissed)).toBe("1");
-
-    app!.unmount();
-    host.remove();
-    await mount();
-    await advance(GITHUB_STAR_PROMPT_SNOOZE_MS);
-    expect(prompt()).toBeNull();
-  });
-
-  it("treats the close button as never show again", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    await mount();
-
-    await click("close");
-
-    expect(prompt()).toBeNull();
-    expect(storage.get(GITHUB_STAR_PROMPT_KEYS.dismissed)).toBe("1");
-    expect(window.open).not.toHaveBeenCalled();
-  });
-
-  it("follows a choice made in another tab", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    await mount();
-
-    storage.set(GITHUB_STAR_PROMPT_KEYS.dismissed, "1");
-    await advance(GITHUB_STAR_PROMPT_TICK_MS);
-
-    expect(prompt()).toBeNull();
-  });
-
-  // The time and the choices then last as long as the page.
-  it("does not crash when storage throws", async () => {
-    vi.stubGlobal("localStorage", throwingStorage);
-    await mount();
-    await advance(GITHUB_STAR_PROMPT_DELAY_MS - GITHUB_STAR_PROMPT_TICK_MS);
-    expect(prompt()).toBeNull();
-    await advance(GITHUB_STAR_PROMPT_TICK_MS);
-    expect(prompt()).not.toBeNull();
-
-    await click("later");
-    await advance(GITHUB_STAR_PROMPT_TICK_MS);
-    expect(prompt()).toBeNull();
-
-    await advance(GITHUB_STAR_PROMPT_SNOOZE_MS);
-    await click("close");
-    await advance(GITHUB_STAR_PROMPT_SNOOZE_MS);
-    expect(prompt()).toBeNull();
-  });
-
-  it("steps aside while a toast is up", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    toasts.value = [{ id: 1 }];
-    await mount();
-    expect(prompt()).toBeNull();
-
-    toasts.value = [];
-    await nextTick();
-    expect(prompt()).not.toBeNull();
-  });
-
-  it("steps aside while a floating save bar is shown", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    vi.stubGlobal("useTranslation", () => ({
-      processI18n: (text: string) => text,
-    }));
-    const dirty = ref(false);
-    const variant = ref<"floating" | "band">("floating");
-    await mount(
-      defineComponent({
-        setup: () => () => [
-          h(GithubStarPrompt),
-          h(SaveBar, { dirty: dirty.value, variant: variant.value }),
-        ],
-      }),
-    );
-    // Nothing to save: the bar keeps its place, hidden.
-    expect(prompt()).not.toBeNull();
-
-    dirty.value = true;
-    await nextTick();
-    expect(prompt()).toBeNull();
-
-    // A form card's footer band is not the bar sticking to the bottom.
-    variant.value = "band";
-    await nextTick();
-    expect(prompt()).not.toBeNull();
-
-    variant.value = "floating";
-    await nextTick();
-    expect(prompt()).toBeNull();
-
-    dirty.value = false;
-    await nextTick();
-    expect(prompt()).not.toBeNull();
-  });
-
-  it("renders nothing without a signed-in user", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    user.value = null;
-    await mount();
-
-    expect(prompt()).toBeNull();
-  });
-
-  it("is not part of the auth pages' layout", async () => {
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    await mount(EmptyLayout);
-
-    expect(prompt()).toBeNull();
-  });
-
-  it("never shows outside dev mode, nor counts or stores anything", async () => {
-    vi.stubEnv("DEV", false);
-    const setItem = vi.spyOn(memoryStorage, "setItem");
-    await mount();
-    await advance(GITHUB_STAR_PROMPT_DELAY_MS);
-    seedActiveTime(GITHUB_STAR_PROMPT_DELAY_MS);
-    await advance(GITHUB_STAR_PROMPT_TICK_MS);
-
-    expect(prompt()).toBeNull();
-    expect(setItem).not.toHaveBeenCalled();
-    expect(vi.getTimerCount()).toBe(0);
-  });
-});