@casomoltd/tooling 0.39.0 → 0.40.1

package/README.md

@@ -15,7 +15,7 @@ Shared linting, formatting, commit config, and CLI tools for Casomo Ltd's repos.
 | `@casomoltd/tooling/knip` | Knip config for unused exports/dependencies |
 | `@casomoltd/tooling/jscpd` | Copy-paste detection config |
 | `@casomoltd/tooling/readability` | `scoreText()` — readability scoring for page content |
-| `@casomoltd/tooling/identity` | `CASOMO_ORGANIZATION`, the schema.org `Organization`, logo included, that every Casomo site names as publisher in its JSON-LD. App code imports it at build time, so a site that installs only production dependencies at runtime lists the package under `dependencies` |
+| `@casomoltd/tooling/identity` | `CASOMO_ORGANIZATION`, the schema.org `Organization`, logo included, that every Casomo site names as publisher in its JSON-LD; and the company's public registrations, `COMPANY_REGISTER`, `ICO_REGISTER` and `REGISTERED_OFFICE` ([types](identity/index.d.mts)). App code imports it at build time, so a site that installs only production dependencies at runtime lists the package under `dependencies` |
 | `@casomoltd/tooling/buttondown` | For a repo using the `buttondown` command: the shared email blocks and skins (`createEmailBlocks`, `emailBaseCss`, `composeWebSkin`), `tokenReader()`, `loadSettings()` and `buildPayload()`, and `EMAIL_CHROME_HIDES` and `WEB_CHROME_HIDES` ([docs/buttondown.md](docs/buttondown.md)) |
 
 ### Bin commands

package/bin/check-personal-data.mjs

@@ -66,6 +66,9 @@ const FIELD_SUFFIX = /(?:value|val|text|node|display|content)$/;
 /** A key that names a birth. */
 const BIRTH_KEY = /(?:dob|dateofbirth|birthdate|born)$/;
 
+/** How many nested field-name layers a lead-in may carry before the key. */
+const MAX_FIELD_SUFFIXES = 4;
+
 /** The constructor a source file writes a date with. `new Date(1983, 6, 14)`
  *  matches neither the printed nor the ISO rule, and the words before it end
  *  `newdate` rather than a field name, so both halves would be blind at once
@@ -83,7 +86,7 @@ const DATE_CALL = /(?:new\s*)?date\($/;
  */
 function namesABirth(lead) {
   let rest = lead;
-  for (let depth = 0; depth < 4; depth += 1) {
+  for (let depth = 0; depth < MAX_FIELD_SUFFIXES; depth += 1) {
     if (BIRTH_KEY.test(rest)) return true;
     const trimmed = rest.replace(FIELD_SUFFIX, "");
     if (trimmed === rest) return false;
@@ -94,11 +97,14 @@ function namesABirth(lead) {
 
 const NON_WORD = /[^a-z0-9]/gi;
 
-/** What precedes a date, as a reader sees it: tags dropped, a generous
- *  window, because a label and its value are separated by a cell boundary
- *  and whatever styling that cell carries. */
+/** How far back a label may sit: generous, because a label and its value
+ *  are separated by a cell boundary and whatever styling that cell carries. */
+const LEAD_IN_CHARS = 120;
+
+/** What precedes a date, as a reader sees it: tags dropped, within
+ *  LEAD_IN_CHARS. */
 const leadIn = (before) =>
-  before.replace(/<[^<>]*>/g, " ").slice(-120).replace(NON_WORD, "")
+  before.replace(/<[^<>]*>/g, " ").slice(-LEAD_IN_CHARS).replace(NON_WORD, "")
     .toLowerCase();
 
 /** A real address ends in a letters-only top-level domain; without this a
@@ -155,31 +161,34 @@ export function identityRules(allowEmail = []) {
 
 /** Every finding in one file's text, against the rules and the names. */
 export function findPersonalData(text, rules, names = []) {
-  const hits = [];
   const lines = text.split("\n");
-  for (const rule of rules) {
-    for (const [i, line] of lines.entries()) {
-      for (const m of line.matchAll(rule.re)) {
-        if (rule.allow?.(m[0])) continue;
-        if (rule.context && !rule.context(line.slice(0, m.index))) continue;
-        hits.push({line: i + 1, rule: rule.name, text: m[0]});
-      }
-    }
-  }
-  for (const name of names) {
-    // No `g`: `.test()` on a global regex advances `lastIndex`, and a name
-    // on consecutive lines would be reported on every other one.
-    const re = new RegExp(
-      `\\b${name.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`, "i");
-    for (const [i, line] of lines.entries()) {
-      if (re.test(line)) {
-        hits.push({line: i + 1, rule: "name on the local denylist", text: name});
-      }
-    }
-  }
-  return hits;
+  return [
+    ...rules.flatMap((rule) =>
+      lines.flatMap((line, i) => ruleHitsOnLine(rule, line, i + 1))),
+    ...names.flatMap((name) => nameHits(lines, name)),
+  ];
 }
 
+/** One rule's findings on one line: each match its `allow` does not
+ *  excuse and its `context`, if it has one, confirms. */
+const ruleHitsOnLine = (rule, line, lineNumber) =>
+  [...line.matchAll(rule.re)]
+    .filter((m) => !rule.allow?.(m[0]))
+    .filter((m) => !rule.context || rule.context(line.slice(0, m.index)))
+    .map((m) => ({line: lineNumber, rule: rule.name, text: m[0]}));
+
+/** Each line naming someone on the local denylist. */
+const nameHits = (lines, name) => {
+  // No `g`: `.test()` on a global regex advances `lastIndex`, and a name on
+  // consecutive lines would be reported on every other one.
+  const re = new RegExp(
+    `\\b${name.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`, "i");
+  return lines.flatMap((line, i) =>
+    re.test(line)
+      ? [{line: i + 1, rule: "name on the local denylist", text: name}]
+      : []);
+};
+
 /* Tracked AND untracked-but-not-ignored: the moment this exists for is the
  * first commit of a new directory, and a tracked-only listing is blind to
  * exactly that. Ignored files are left out on purpose; they are the working
@@ -263,6 +272,7 @@ const isEntryPoint = () => {
   try {
     return import.meta.url === pathToFileURL(realpathSync(process.argv[1])).href;
   } catch {
+    // No resolvable argv[1] (imported by a test, or a bare REPL): not the entry.
     return false;
   }
 };

package/identity/index.d.mts

@@ -13,3 +13,16 @@ export interface CasomoOrganization {
 }
 
 export declare const CASOMO_ORGANIZATION: CasomoOrganization;
+
+/** An entry on a public register: its number, and the page that shows it. */
+export interface Registration {
+  readonly number: string;
+  readonly url: string;
+}
+
+/** The company's Companies House record. */
+export declare const COMPANY_REGISTER: Registration;
+/** The company's registration with the ICO, as a data controller. */
+export declare const ICO_REGISTER: Registration;
+/** The company's registered office, as Companies House holds it. */
+export declare const REGISTERED_OFFICE: string;

package/identity/index.mjs

@@ -3,4 +3,9 @@
  * lives in organization.mjs, where the typecheck can read it against the
  * declaration here; beside a .d.mts, TypeScript would skip it.
  */
-export {CASOMO_ORGANIZATION} from "./organization.mjs";
+export {
+  CASOMO_ORGANIZATION,
+  COMPANY_REGISTER,
+  ICO_REGISTER,
+  REGISTERED_OFFICE,
+} from "./organization.mjs";

package/identity/organization.mjs

@@ -1,11 +1,13 @@
 /**
- * Casomo Ltd as search engines should see it: the one schema.org
- * `Organization` every Casomo site names in its JSON-LD. Each site imports
- * this rather than typing its own, so no two sites can disagree about who
- * publishes them, and `sameAs` ties them all to the same profiles.
+ * Casomo Ltd's public identity, which every Casomo site imports rather than
+ * typing its own, so no two sites can disagree about the company. Here are the
+ * schema.org `Organization` every site names in its JSON-LD, whose `sameAs`
+ * ties them all to the same profiles, and the company's entries on the public
+ * registers, each by its number and the page that shows it.
  *
- * Public facts only: the company's name, its mark and the public addresses it
- * is known by. A person, such as an article's author, stays with the site.
+ * Public facts only: the company's name, its mark, the public addresses it
+ * is known by, and its public registrations. A person, such as an article's
+ * author, stays with the site.
  */
 const SITE = "https://casomoltd.com";
 
@@ -25,3 +27,29 @@ export const CASOMO_ORGANIZATION = Object.freeze({
     "https://www.linkedin.com/company/111967567/",
   ]),
 });
+
+const COMPANY_NUMBER = "15030496";
+/**
+ * The company's Companies House record.
+ * @type {import("./index.d.mts").Registration}
+ */
+export const COMPANY_REGISTER = Object.freeze({
+  number: COMPANY_NUMBER,
+  url:
+    "https://find-and-update.company-information.service.gov.uk"
+    + `/company/${COMPANY_NUMBER}`,
+});
+
+const ICO_NUMBER = "ZC219565";
+/**
+ * The company's registration with the ICO, as a data controller.
+ * @type {import("./index.d.mts").Registration}
+ */
+export const ICO_REGISTER = Object.freeze({
+  number: ICO_NUMBER,
+  url: `https://ico.org.uk/ESDWebPages/Entry/${ICO_NUMBER}`,
+});
+
+/** The company's registered office, as Companies House holds it. */
+export const REGISTERED_OFFICE =
+  "71-75 Shelton Street, Covent Garden, London, WC2H 9JQ";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casomoltd/tooling",
-  "version": "0.39.0",
+  "version": "0.40.1",
   "description": "Casomo's shared dev config: ESLint, Prettier, commitlint, knip & jscpd presets, dev CLIs (git hooks, readability, screenshots, design specs), and the build-time data and helpers sites import (the Buttondown engine, the shared Organization)",
   "license": "MIT",
   "repository": {