Files
gerbeur/shared/validation.ts
khannurien f3f07ed1e3
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 49s
Build and Deploy Static Documentation Site / build-and-push (push) Successful in 22s
v3: every doc opens with the role, then the mechanism, then the details — the docs were written bottom-up: what a thing does first ("Declares the three contexts WSProvider fills…"), details that only make sense once its purpose is known next, and the reason it exists last ("…so that a feed doesn't re-render"), so a reader had nothing to hang the first sentences on. The README's rule caused it, since a module doc "opened with what the module does"; it now opens with the module's role in the app, and the value-side phrasing of a type ("Returned to Y by X") comes once the role is said, with WSContext as the before and after. WSContext.ts is rewritten that way throughout, and so are the docs elsewhere that buried their purpose in a trailing "so that" (the migrations, og, image-proxy, public-address, useFading, useFeedCache, the drafts), opened on a generic verb that hid it ("Holds", "Declares", "Loads", "Defines", "Types": the contexts and providers, the shared types, the models, the hooks), or were label fragments ("The page of a dump…", "A row of tabs."). A function whose verb is its action ("Stores session"), a props or result type, and a protocol message ("Sent by X when Y") already say their role and are left as they are. Only comments changed, and the catalogs only move their references; deno fmt, deno lint and doc:lint are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-29 21:42:08 +00:00

51 lines
1.5 KiB
TypeScript

/**
* Makes the forms check the same limits on what users submit as the server
* enforces, by holding them in one place.
*
* @module
*/
/**
* Read by the validators and services, which refuse what breaks a limit, and
* by the forms, which say so before sending. Lengths are JavaScript string
* lengths, so an emoji may count for two. The category limits are checked on
* the server only.
*/
export const VALIDATION = {
USERNAME_MIN: 1,
USERNAME_MAX: 32,
PASSWORD_MIN: 8,
PASSWORD_MAX: 128,
DUMP_TITLE_MAX: 200,
/** Applies to a dump's note, which the API calls its comment. */
DUMP_COMMENT_MAX: 5000,
PLAYLIST_TITLE_MAX: 100,
PLAYLIST_DESCRIPTION_MAX: 2000,
COMMENT_BODY_MAX: 5000,
USER_DESCRIPTION_MAX: 2000,
CATEGORY_NAME_MAX: 50,
CATEGORY_SLUG_MAX: 50,
CHAT_MESSAGE_MAX: 2000,
} as const;
/**
* Matches a valid username, made of letters, digits and underscores within the
* `VALIDATION` limits. Sign-up checks it on both sides. It uses the same `\w`
* that a mention's pattern reads a name with.
*/
export const USERNAME_RE: RegExp = new RegExp(
`^[a-zA-Z0-9_]{${VALIDATION.USERNAME_MIN},${VALIDATION.USERNAME_MAX}}$`,
);
/**
* Matches an email address well enough to catch a typo; only the reset email
* arriving proves it.
*/
export const EMAIL_RE: RegExp = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
/**
* The largest file a file dump may hold, in bytes. dump-service refuses a
* bigger one, and the create form before uploading it.
*/
export const DUMP_MAX_FILE_SIZE_BYTES: number = 50 * 1024 * 1024;