@venn-lang/data 0.1.0

package/src/faker/check-digits.ts

@@ -0,0 +1,56 @@
+import { pad } from "./primitives.js";
+
+// Check digits for the numbers real forms validate locally. A card, barcode or
+// IBAN with the wrong digit is rejected before any network call, so a generator
+// that skips these produces values no checkout would ever accept.
+
+/**
+ * The Luhn check digit for a card number.
+ *
+ * @param base The digits preceding the check digit.
+ * @returns One digit. Appending it makes `base` pass the Luhn test.
+ */
+export function luhnDigit(base: string): string {
+  let sum = 0;
+  let double = true;
+  for (let index = base.length - 1; index >= 0; index -= 1) {
+    const scaled = Number(base[index]) * (double ? 2 : 1);
+    sum += scaled > 9 ? scaled - 9 : scaled;
+    double = !double;
+  }
+  return String((10 - (sum % 10)) % 10);
+}
+
+/**
+ * The EAN-13 check digit for the leading 12 digits of a barcode.
+ *
+ * @param base Exactly 12 digits.
+ * @returns The thirteenth digit.
+ */
+export function eanDigit(base: string): string {
+  let sum = 0;
+  for (let index = 0; index < base.length; index += 1) {
+    sum += Number(base[index]) * (index % 2 === 0 ? 1 : 3);
+  }
+  return String((10 - (sum % 10)) % 10);
+}
+
+/**
+ * The two IBAN check digits: mod-97 over the rearranged, letter-expanded account.
+ *
+ * @param country The two-letter country code, upper case.
+ * @param account The account part, without check digits.
+ * @returns Two digits, zero-padded, to be inserted after the country code.
+ */
+export function ibanCheck(country: string, account: string): string {
+  const rearranged = `${account}${country}00`;
+  const expanded = rearranged.replace(/[A-Z]/g, (letter) => String(letter.charCodeAt(0) - 55));
+  return pad(98 - mod97(expanded), 2);
+}
+
+/** Mod 97 digit by digit, because an expanded IBAN overflows `Number`. */
+function mod97(value: string): number {
+  let rest = 0;
+  for (const char of value) rest = (rest * 10 + Number(char)) % 97;
+  return rest;
+}

package/src/faker/commerce.ts

@@ -0,0 +1,59 @@
+import { t } from "@venn-lang/types";
+import type { Rng } from "../rng/index.js";
+import { eanDigit } from "./check-digits.js";
+import { ADJECTIVES, CATEGORIES, COLORS, MATERIALS, PRODUCTS } from "./data/index.js";
+import type { FakerSpec } from "./faker.types.js";
+import { capitalize, chars, digits, floatBetween, pick } from "./primitives.js";
+
+function productName(rng: Rng): string {
+  const adjective = capitalize(pick(ADJECTIVES, rng));
+  return `${adjective} ${pick(MATERIALS, rng)} ${pick(PRODUCTS, rng)}`;
+}
+
+function sku(rng: Rng): string {
+  const letters = chars({ count: 3, alphabet: "ABCDEFGHJKLMNPQRSTUVWXYZ", rng });
+  return `${letters}-${digits(5, rng)}`;
+}
+
+/** A 13-digit EAN with a real check digit, so barcode validators accept it. */
+function barcode(rng: Rng): string {
+  const base = digits(12, rng);
+  return `${base}${eanDigit(base)}`;
+}
+
+export const commerceSpecs: readonly FakerSpec[] = [
+  {
+    name: "product",
+    doc: "A product noun.",
+    result: t.string,
+    make: (rng) => pick(PRODUCTS, rng),
+  },
+  { name: "productName", doc: "A full product name.", result: t.string, make: productName },
+  { name: "sku", doc: "A stock keeping unit.", result: t.string, make: sku },
+  { name: "barcode", doc: "A valid EAN-13 barcode.", result: t.string, make: barcode },
+  {
+    name: "category",
+    doc: "A product category.",
+    result: t.string,
+    make: (rng) => pick(CATEGORIES, rng),
+  },
+  {
+    name: "material",
+    doc: "A material, like `leather`.",
+    result: t.string,
+    make: (rng) => pick(MATERIALS, rng),
+  },
+  { name: "color", doc: "A colour name.", result: t.string, make: (rng) => pick(COLORS, rng)[0] },
+  {
+    name: "hexColor",
+    doc: "A colour as a hex triplet, like `#1e88e5`.",
+    result: t.string,
+    make: (rng) => pick(COLORS, rng)[1],
+  },
+  {
+    name: "price",
+    doc: "A retail price with two decimal places.",
+    result: t.number,
+    make: (rng) => floatBetween({ min: 5, max: 500, decimals: 2, rng }),
+  },
+];

package/src/faker/company.ts

@@ -0,0 +1,41 @@
+import { t } from "@venn-lang/types";
+import type { Rng } from "../rng/index.js";
+import {
+  BUZZWORDS,
+  CATCH_VERBS,
+  COMPANY_ROOTS,
+  COMPANY_SUFFIXES,
+  DEPARTMENTS,
+} from "./data/index.js";
+import type { FakerSpec } from "./faker.types.js";
+import { capitalize, pick } from "./primitives.js";
+
+function company(rng: Rng): string {
+  return `${pick(COMPANY_ROOTS, rng)} ${pick(COMPANY_SUFFIXES, rng)}`;
+}
+
+function catchPhrase(rng: Rng): string {
+  return `${capitalize(pick(CATCH_VERBS, rng))} your ${pick(BUZZWORDS, rng)}`;
+}
+
+export const companySpecs: readonly FakerSpec[] = [
+  { name: "company", doc: "A company name.", result: t.string, make: company },
+  {
+    name: "department",
+    doc: "A department name.",
+    result: t.string,
+    make: (rng) => pick(DEPARTMENTS, rng),
+  },
+  {
+    name: "catchPhrase",
+    doc: "A marketing catch phrase.",
+    result: t.string,
+    make: catchPhrase,
+  },
+  {
+    name: "buzzword",
+    doc: "A single piece of business jargon.",
+    result: t.string,
+    make: (rng) => pick(BUZZWORDS, rng),
+  },
+];

package/src/faker/data/business.ts

@@ -0,0 +1,80 @@
+export const COMPANY_ROOTS: readonly string[] = [
+  "Northwind",
+  "Acme",
+  "Globex",
+  "Initech",
+  "Umbrella",
+  "Vandelay",
+  "Stark",
+  "Wayne",
+  "Tyrell",
+  "Cyberdyne",
+  "Aperture",
+  "Soylent",
+  "Massive",
+  "Hooli",
+];
+
+export const COMPANY_SUFFIXES: readonly string[] = [
+  "Ltd",
+  "Inc",
+  "GmbH",
+  "S.A.",
+  "LLC",
+  "Group",
+  "Labs",
+  "Systems",
+  "Holdings",
+];
+
+export const DEPARTMENTS: readonly string[] = [
+  "Engineering",
+  "Design",
+  "Sales",
+  "Marketing",
+  "Support",
+  "Finance",
+  "Legal",
+  "People",
+  "Operations",
+  "Security",
+  "Data",
+  "Research",
+];
+
+export const JOB_TITLES: readonly string[] = [
+  "Software Engineer",
+  "Product Designer",
+  "Data Analyst",
+  "Engineering Manager",
+  "QA Engineer",
+  "Site Reliability Engineer",
+  "Technical Writer",
+  "Product Manager",
+  "Security Analyst",
+  "Solutions Architect",
+  "Support Specialist",
+  "Accountant",
+];
+
+export const BUZZWORDS: readonly string[] = [
+  "synergy",
+  "scalability",
+  "throughput",
+  "observability",
+  "resilience",
+  "alignment",
+  "velocity",
+  "leverage",
+  "bandwidth",
+  "runway",
+];
+
+export const CATCH_VERBS: readonly string[] = [
+  "streamline",
+  "orchestrate",
+  "unlock",
+  "accelerate",
+  "simplify",
+  "amplify",
+];

package/src/faker/data/commerce.ts

@@ -0,0 +1,73 @@
+export const PRODUCTS: readonly string[] = [
+  "Chair",
+  "Keyboard",
+  "Lamp",
+  "Backpack",
+  "Mug",
+  "Notebook",
+  "Headphones",
+  "Monitor",
+  "Desk",
+  "Bottle",
+  "Jacket",
+  "Sneakers",
+  "Table",
+  "Shelf",
+  "Camera",
+];
+
+export const MATERIALS: readonly string[] = [
+  "cotton",
+  "steel",
+  "oak",
+  "leather",
+  "glass",
+  "aluminium",
+  "ceramic",
+  "linen",
+];
+
+export const CATEGORIES: readonly string[] = [
+  "Electronics",
+  "Home",
+  "Outdoors",
+  "Books",
+  "Clothing",
+  "Toys",
+  "Grocery",
+  "Sports",
+  "Beauty",
+  "Automotive",
+];
+
+export const COLORS: readonly [string, string][] = [
+  ["black", "#000000"],
+  ["white", "#ffffff"],
+  ["red", "#e53935"],
+  ["blue", "#1e88e5"],
+  ["green", "#43a047"],
+  ["amber", "#ffb300"],
+  ["violet", "#8e24aa"],
+  ["teal", "#00897b"],
+  ["slate", "#546e7a"],
+  ["coral", "#ff7043"],
+];
+
+/** `[code, symbol, name]`. */
+export const CURRENCIES: readonly [string, string, string][] = [
+  ["BRL", "R$", "Brazilian Real"],
+  ["USD", "$", "US Dollar"],
+  ["EUR", "€", "Euro"],
+  ["GBP", "£", "Pound Sterling"],
+  ["JPY", "¥", "Japanese Yen"],
+  ["CAD", "$", "Canadian Dollar"],
+];
+
+/** `[brand, prefix, length]`. The prefixes are the real issuer ranges. */
+export const CARD_BRANDS: readonly [string, string, number][] = [
+  ["Visa", "4", 16],
+  ["Mastercard", "51", 16],
+  ["Mastercard", "55", 16],
+  ["Discover", "6011", 16],
+  ["Elo", "4011", 16],
+];

package/src/faker/data/index.ts

@@ -0,0 +1,36 @@
+export {
+  BUZZWORDS,
+  CATCH_VERBS,
+  COMPANY_ROOTS,
+  COMPANY_SUFFIXES,
+  DEPARTMENTS,
+  JOB_TITLES,
+} from "./business.js";
+export { CARD_BRANDS, CATEGORIES, COLORS, CURRENCIES, MATERIALS, PRODUCTS } from "./commerce.js";
+export {
+  FIRST_NAMES,
+  GENDERS,
+  LAST_NAMES,
+  NAME_PREFIXES,
+  NAME_SUFFIXES,
+} from "./names.js";
+export {
+  BR_CITIES,
+  BR_STATES,
+  BR_STREET_NAMES,
+  BR_STREET_TYPES,
+  CITIES,
+  COUNTRIES,
+  STREET_TYPES,
+  TIMEZONES,
+} from "./places.js";
+export {
+  HTTP_METHODS,
+  HTTP_STATUSES,
+  MIME_TYPES,
+  PROTOCOLS,
+  SAFE_DOMAINS,
+  TLDS,
+  USER_AGENTS,
+} from "./web.js";
+export { ADJECTIVES, LOREM, NOUNS } from "./words.js";

package/src/faker/data/names.ts

@@ -0,0 +1,93 @@
+/** Given names, mixing the computing pantheon with names common in Brazil. */
+export const FIRST_NAMES: readonly string[] = [
+  "Ada",
+  "Alan",
+  "Grace",
+  "Linus",
+  "Edsger",
+  "Barbara",
+  "Katherine",
+  "Dennis",
+  "Margaret",
+  "Donald",
+  "Anita",
+  "Tim",
+  "Radia",
+  "Ken",
+  "Frances",
+  "Vint",
+  "Ana",
+  "Bruno",
+  "Camila",
+  "Diego",
+  "Eduarda",
+  "Felipe",
+  "Gabriela",
+  "Heitor",
+  "Isabela",
+  "João",
+  "Larissa",
+  "Mateus",
+  "Natália",
+  "Otávio",
+  "Paula",
+  "Rafael",
+  "Sofia",
+  "Thiago",
+  "Valentina",
+  "Yuri",
+  "Beatriz",
+  "Caio",
+  "Débora",
+  "Enzo",
+];
+
+/** Family names, likewise mixed. */
+export const LAST_NAMES: readonly string[] = [
+  "Lovelace",
+  "Turing",
+  "Hopper",
+  "Torvalds",
+  "Dijkstra",
+  "Liskov",
+  "Johnson",
+  "Ritchie",
+  "Hamilton",
+  "Knuth",
+  "Borg",
+  "Berners-Lee",
+  "Perlman",
+  "Thompson",
+  "Allen",
+  "Cerf",
+  "Silva",
+  "Santos",
+  "Oliveira",
+  "Souza",
+  "Rodrigues",
+  "Ferreira",
+  "Almeida",
+  "Costa",
+  "Gomes",
+  "Martins",
+  "Araújo",
+  "Melo",
+  "Barbosa",
+  "Ribeiro",
+  "Carvalho",
+  "Pereira",
+  "Lima",
+  "Moreira",
+  "Cardoso",
+  "Teixeira",
+  "Correia",
+];
+
+/** Honorifics that precede a name. */
+export const NAME_PREFIXES: readonly string[] = ["Dr.", "Dra.", "Sr.", "Sra.", "Prof.", "Eng."];
+
+/** Generational suffixes that follow a name. */
+export const NAME_SUFFIXES: readonly string[] = ["Jr.", "Neto", "Filho", "II", "III"];
+
+/** Gender values shaped the way most forms model them. */
+export const GENDERS: readonly string[] = ["female", "male", "non-binary", "prefer not to say"];

package/src/faker/data/places.ts

@@ -0,0 +1,109 @@
+export const CITIES: readonly string[] = [
+  "Lisbon",
+  "Porto",
+  "Amsterdam",
+  "Berlin",
+  "Toronto",
+  "Austin",
+  "Dublin",
+  "Wellington",
+  "Reykjavík",
+  "Kyoto",
+  "Montréal",
+  "Helsinki",
+  "Tallinn",
+  "Bergen",
+];
+
+export const COUNTRIES: readonly [string, string][] = [
+  ["Brazil", "BR"],
+  ["Portugal", "PT"],
+  ["Netherlands", "NL"],
+  ["Germany", "DE"],
+  ["Canada", "CA"],
+  ["United States", "US"],
+  ["Ireland", "IE"],
+  ["New Zealand", "NZ"],
+  ["Japan", "JP"],
+  ["Finland", "FI"],
+  ["Estonia", "EE"],
+  ["Norway", "NO"],
+];
+
+export const STREET_TYPES: readonly string[] = [
+  "Street",
+  "Avenue",
+  "Road",
+  "Lane",
+  "Way",
+  "Square",
+];
+
+export const TIMEZONES: readonly string[] = [
+  "America/Sao_Paulo",
+  "America/New_York",
+  "Europe/Lisbon",
+  "Europe/Berlin",
+  "Europe/Helsinki",
+  "Asia/Tokyo",
+  "Pacific/Auckland",
+  "UTC",
+];
+
+/** Brazilian federal units, as `[name, code]`. */
+export const BR_STATES: readonly [string, string][] = [
+  ["São Paulo", "SP"],
+  ["Rio de Janeiro", "RJ"],
+  ["Minas Gerais", "MG"],
+  ["Bahia", "BA"],
+  ["Paraná", "PR"],
+  ["Rio Grande do Sul", "RS"],
+  ["Pernambuco", "PE"],
+  ["Ceará", "CE"],
+  ["Santa Catarina", "SC"],
+  ["Goiás", "GO"],
+  ["Pará", "PA"],
+  ["Espírito Santo", "ES"],
+  ["Amazonas", "AM"],
+  ["Distrito Federal", "DF"],
+];
+
+export const BR_CITIES: readonly string[] = [
+  "São Paulo",
+  "Rio de Janeiro",
+  "Belo Horizonte",
+  "Salvador",
+  "Curitiba",
+  "Porto Alegre",
+  "Recife",
+  "Fortaleza",
+  "Florianópolis",
+  "Goiânia",
+  "Belém",
+  "Vitória",
+  "Manaus",
+  "Brasília",
+  "Campinas",
+  "Uberlândia",
+];
+
+export const BR_STREET_TYPES: readonly string[] = [
+  "Rua",
+  "Avenida",
+  "Travessa",
+  "Alameda",
+  "Praça",
+];
+
+export const BR_STREET_NAMES: readonly string[] = [
+  "das Flores",
+  "Sete de Setembro",
+  "Getúlio Vargas",
+  "XV de Novembro",
+  "Santos Dumont",
+  "do Comércio",
+  "Paulista",
+  "Brasil",
+  "das Palmeiras",
+  "Tiradentes",
+];

package/src/faker/data/web.ts

@@ -0,0 +1,45 @@
+/** Reserved by RFC 2606/6761, so a generated address never resolves to anyone real. */
+export const SAFE_DOMAINS: readonly string[] = [
+  "example.test",
+  "example.com",
+  "example.org",
+  "example.net",
+  "test.invalid",
+];
+
+export const TLDS: readonly string[] = ["com", "org", "net", "io", "dev", "app", "com.br"];
+
+export const HTTP_METHODS: readonly string[] = [
+  "GET",
+  "POST",
+  "PUT",
+  "PATCH",
+  "DELETE",
+  "HEAD",
+  "OPTIONS",
+];
+
+export const HTTP_STATUSES: readonly number[] = [
+  200, 201, 202, 204, 301, 302, 304, 400, 401, 403, 404, 409, 422, 429, 500, 502, 503,
+];
+
+export const MIME_TYPES: readonly string[] = [
+  "application/json",
+  "text/html",
+  "text/plain",
+  "text/csv",
+  "application/pdf",
+  "image/png",
+  "image/jpeg",
+  "image/svg+xml",
+  "application/octet-stream",
+];
+
+export const USER_AGENTS: readonly string[] = [
+  "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0 Safari/537.36",
+  "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Safari/605.1.15",
+  "Mozilla/5.0 (X11; Linux x86_64; rv:127.0) Gecko/20100101 Firefox/127.0",
+  "Mozilla/5.0 (iPhone; CPU iPhone OS 17_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
+];
+
+export const PROTOCOLS: readonly string[] = ["https", "http"];

package/src/faker/data/words.ts

@@ -0,0 +1,104 @@
+/** Classic lorem vocabulary: filler text that is obviously filler. */
+export const LOREM: readonly string[] = [
+  "lorem",
+  "ipsum",
+  "dolor",
+  "sit",
+  "amet",
+  "consectetur",
+  "adipiscing",
+  "elit",
+  "sed",
+  "do",
+  "eiusmod",
+  "tempor",
+  "incididunt",
+  "ut",
+  "labore",
+  "et",
+  "dolore",
+  "magna",
+  "aliqua",
+  "enim",
+  "ad",
+  "minim",
+  "veniam",
+  "quis",
+  "nostrud",
+  "exercitation",
+  "ullamco",
+  "laboris",
+  "nisi",
+  "aliquip",
+  "ex",
+  "ea",
+  "commodo",
+  "consequat",
+  "duis",
+  "aute",
+  "irure",
+  "in",
+  "reprehenderit",
+  "voluptate",
+  "velit",
+  "esse",
+  "cillum",
+  "eu",
+  "fugiat",
+  "nulla",
+  "pariatur",
+  "excepteur",
+  "sint",
+  "occaecat",
+  "cupidatat",
+  "non",
+  "proident",
+  "culpa",
+  "officia",
+  "deserunt",
+  "mollit",
+  "anim",
+  "id",
+  "est",
+  "laborum",
+];
+
+/** Adjectives, for product and project names. */
+export const ADJECTIVES: readonly string[] = [
+  "quiet",
+  "bright",
+  "rapid",
+  "solid",
+  "gentle",
+  "bold",
+  "clever",
+  "plain",
+  "sturdy",
+  "sleek",
+  "warm",
+  "crisp",
+  "amber",
+  "hollow",
+  "northern",
+  "silent",
+];
+
+/** Concrete nouns, for the same. */
+export const NOUNS: readonly string[] = [
+  "harbour",
+  "lantern",
+  "meadow",
+  "compass",
+  "anchor",
+  "ridge",
+  "beacon",
+  "quarry",
+  "willow",
+  "falcon",
+  "cascade",
+  "summit",
+  "orchard",
+  "canyon",
+  "delta",
+  "ember",
+];