npm - @company-semantics/contracts - Versions diffs - 36.0.0 → 37.0.0 - Mend

@company-semantics/contracts 36.0.0 → 37.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/src/notifications/renderers/email/__tests__/amp.test.ts DELETED Viewed

@@ -1,217 +0,0 @@
-/**
- * The AMP surface's constraints (ADR-CONTRACTS-089).
- *
- * **What this file can and cannot claim.** AMP validity is defined by the AMP
- * validator, and the validator fetches itself over the network — so it cannot live
- * in this package's pure suite and runs behind `pnpm validate:amp` instead. What is
- * asserted here is narrower and honest: *the constraints we know*, checked over
- * every fixture. A green run here means "we did not do any of the things we know
- * AMP forbids", not "this is valid AMP".
- *
- * The constraints are structural rather than cosmetic. Each one is a thing the html
- * surface does deliberately and this surface must not do at all — which is why the
- * markup belongs to neither and both are derived from `../styles.ts`.
- */
-import { describe, expect, it } from "vitest";
-import { hoverStyle } from "../colors";
-import { NOTIFICATION_FIXTURES, fixtureKey } from "../../../__tests__/fixtures";
-import type { RenderContext } from "../../../context";
-import { NOTIFICATION_DEFINITIONS } from "../../../registry";
-import { emailRenderer } from "../index";
-import { ampify } from "../styles";
-const CONTEXT: RenderContext = {
-  brand: { name: "Company Semantics", copyrightYear: 2026 },
-};
-/** Gmail's `amp-custom` ceiling. */
-const AMP_CUSTOM_LIMIT = 75_000;
-/** Every fixture, rendered once. */
-const RENDERED = NOTIFICATION_FIXTURES.map((fixture) => {
-  const definition = NOTIFICATION_DEFINITIONS[fixture.kind];
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const content = definition.compose(fixture.payload as any, CONTEXT);
-  return {
-    key: fixtureKey(fixture.kind, fixture.name),
-    ...emailRenderer.render(content, CONTEXT),
-  };
-});
-/** The `<style amp-custom>` block's contents. */
-function ampCustom(amp: string): string {
-  const open = "<style amp-custom>";
-  const start = amp.indexOf(open);
-  return amp.slice(start + open.length, amp.indexOf("</style></head>"));
-}
-/** Everything a reader would actually read, tags removed. */
-function visibleText(html: string): string {
-  return html
-    .replace(/<style[^>]*>[\s\S]*?<\/style>/g, "")
-    .replace(/<script[\s\S]*?<\/script>/g, "")
-    .replace(/<!--[\s\S]*?-->/g, "")
-    .replace(/<[^>]+>/g, " ")
-    .replace(/\s+/g, " ")
-    .trim();
-}
-describe("the AMP surface", () => {
-  it("emits every fixture", () => {
-    // Guards every loop below: a fixture list that silently emptied would turn
-    // each of them into a vacuous pass.
-    expect(RENDERED.length).toBeGreaterThan(0);
-  });
-  describe.each(RENDERED)("$key", ({ amp }) => {
-    it("declares itself AMP, with the runtime and the boilerplate", () => {
-      expect(amp.startsWith("<!DOCTYPE html>\n<html amp4email")).toBe(true);
-      expect(amp).toContain(
-        '<script async src="https://cdn.ampproject.org/v0.js"></script>',
-      );
-      // The boilerplate hides the body until the runtime unhides it — which is
-      // why an AMP document that cannot run scripts renders blank rather than
-      // unstyled.
-      expect(amp).toContain(
-        "<style amp4email-boilerplate>body{visibility:hidden}</style>",
-      );
-    });
-    it("carries no inline style — the constraint the whole split exists for", () => {
-      expect(amp).not.toContain('style="');
-    });
-    it("carries no !important, which amp-custom forbids", () => {
-      expect(ampCustom(amp)).not.toContain("!important");
-    });
-    it("carries no conditional comment", () => {
-      // `MSO_CTA_STYLE` is `htmlShell`'s business. It lives in that shell's
-      // `<head>`, never in an `EmailLine`, so this holds by construction rather
-      // than by stripping.
-      expect(amp).not.toContain("<!--[if");
-    });
-    it("has exactly one amp-custom stylesheet, in the head", () => {
-      expect(amp.match(/<style amp-custom>/g)).toHaveLength(1);
-      expect(amp.indexOf("<style amp-custom>")).toBeLessThan(
-        amp.indexOf("</head>"),
-      );
-    });
-    it("fits Gmail's amp-custom budget", () => {
-      expect(ampCustom(amp).length).toBeLessThan(AMP_CUSTOM_LIMIT);
-    });
-    it("draws images as amp-img, never img", () => {
-      expect(amp).not.toMatch(/<img\s/);
-    });
-    it("styles every recipe class it applies", () => {
-      // The end-to-end direction: start from the output, so a recipe class that
-      // reaches the markup with no rule behind it is caught. On this surface a
-      // recipe is the ONLY thing carrying an element's appearance — `htmlShell`
-      // spends them inline and drops them; here they must all land as rules, or
-      // the element renders naked.
-      //
-      // Role hooks (`cs-`) are deliberately NOT required to have one. They ride
-      // along because the markup is shared with the html surface, where
-      // `DARK_STYLE` needs them — and dark is exactly what this surface cannot
-      // have. So `cs-faint`/`cs-bubble`/`cs-cta`/`cs-link` are inert here: their
-      // colours already arrived via their recipe's `roleDecl`. That is the price
-      // of one markup, and it is bytes rather than correctness. The one role rule
-      // this surface DOES carry is asserted separately below — it is the feature.
-      const body = amp.slice(amp.indexOf("<body"));
-      const applied = new Set(
-        [...body.matchAll(/class="([^"]+)"/g)].flatMap((m) =>
-          m[1].split(/\s+/),
-        ),
-      );
-      const recipes = [...applied].filter((c) => c.startsWith("csr-"));
-      expect(recipes.length).toBeGreaterThan(0);
-      const sheet = ampCustom(amp);
-      for (const className of recipes) {
-        expect(sheet, `${className} is applied but never styled`).toMatch(
-          new RegExp(`\\.${className} \\{`),
-        );
-      }
-    });
-  });
-  it("says exactly what the html surface says", () => {
-    // The claim `EmailLine` exists to make, now across three surfaces instead of
-    // two: the parts of a `multipart/alternative` are ALTERNATIVES, so a client
-    // choosing between them must not change what the notification said. This is
-    // what a second hand-authored AMP template could never promise.
-    for (const { key, html, amp } of RENDERED) {
-      expect(visibleText(amp), `${key} says something else in AMP`).toBe(
-        visibleText(html),
-      );
-    }
-  });
-  it("states the hover rule without !important, and the html surface with", () => {
-    // The one rule both surfaces carry, and the only thing they disagree on: the
-    // html surface must beat an inline style, this one has none to beat and
-    // forbids the keyword. One template, one parameter; see `../colors.ts`.
-    expect(hoverStyle(true)).toContain("!important");
-    expect(hoverStyle(false)).not.toContain("!important");
-    // The same rule, not merely two rules that both exist.
-    expect(hoverStyle(true).replaceAll(" !important", "")).toBe(
-      hoverStyle(false),
-    );
-  });
-  it("carries the hover rule — the reason this surface exists at all", () => {
-    // ADR-CONTRACTS-088 bought a `:hover` state that Gmail does not honour, and
-    // Gmail is most opens. This surface is where that rule finally reaches a
-    // recipient, so its presence is the feature, not an implementation detail.
-    const { amp } = RENDERED[0];
-    expect(ampCustom(amp)).toContain(".cs-cta-hover:hover");
-  });
-  it("carries no dark scheme, because AMP disallows the media feature", () => {
-    // NOT an omission to fix later: `prefers-color-scheme` is a disallowed media
-    // feature in amp-custom (verified against the AMP validator, with and without
-    // `data-css-strict`), so this surface cannot have dark in any form. It costs
-    // nothing — the dark block's clients (Apple Mail, iOS Mail, Outlook for Mac)
-    // and this surface's clients (Gmail, Yahoo, Mail.ru) are disjoint sets, and
-    // the latter force-invert rather than read a stylesheet.
-    //
-    // This test exists so that "add dark mode to AMP" fails here with the reason,
-    // rather than in `pnpm validate:amp` with a CSS syntax error.
-    for (const { key, amp } of RENDERED) {
-      expect(amp, `${key} would be invalid AMP`).not.toContain(
-        "prefers-color-scheme",
-      );
-    }
-  });
-  describe("ampify", () => {
-    it("gives a sized image explicit layout", () => {
-      expect(
-        ampify(
-          '<img src="a.png" alt="A" width="600" height="200" class="csr-hero-normal">',
-        ),
-      ).toBe(
-        '<amp-img src="a.png" alt="A" width="600" height="200" class="csr-hero-normal" layout="intrinsic"></amp-img>',
-      );
-    });
-    it("degrades an unsized image to its alt text, keeping its spacing", () => {
-      // `../../content.ts` makes dimensions optional, so this surface must have an
-      // answer for their absence. `alt` is required exactly so that a channel with
-      // nothing else has something to say.
-      expect(
-        ampify('<img src="a.png" alt="A logo" class="csr-hero-tight">'),
-      ).toBe('<p class="csr-p-tight">A logo</p>');
-    });
-    it("leaves markup with no image alone", () => {
-      const plain = '<p class="csr-p-none">x</p>';
-      expect(ampify(plain)).toBe(plain);
-    });
-  });
-});