app/lib/carrel/content-id.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/lib/carrel/content-kinds.server.ts, app/lib/dictionary/compile.mjs, app/lib/publications/validate.mjs.

Source

1// The one place a content kind and its slug become a site-api content id and back. site-api's ContentId
2// is `^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$` (no colon), so the separator is a dot. Pure, so the publication
3// validator can share the length rule with the registry (content-kinds.server.ts).
4
5/** The contract's ContentId allows at most 200 characters (site-api contract.ts). */
6const CONTENT_ID_MAX = 200;
7
8/** The kind that keeps a bare slug for its id, so every id posts already had is unchanged. */
9export const DEFAULT_KIND = "post";
10
11/** The separator between a kind and a slug. A bare id has none; a slug may itself contain it. */
12const SEPARATOR = ".";
13
14/**
15 * The contract id for a kind's slug: posts keep the bare slug, every other kind is `<kind>.<slug>`.
16 *
17 * @param {string} kind
18 * @param {string} slug
19 */
20export function encodeContentId(kind, slug) {
21  return kind === DEFAULT_KIND ? slug : `${kind}${SEPARATOR}${slug}`;
22}
23
24/**
25 * The kind and slug of a contract id. A post slug never contains the separator (SLUG_PATTERN), so an id
26 * with none is a post; otherwise the kind is everything before the FIRST separator and the slug is the rest.
27 *
28 * @param {string} id
29 * @returns {{ kind: string, slug: string }}
30 */
31export function decodeContentId(id) {
32  const at = id.indexOf(SEPARATOR);
33  if (at === -1) return { kind: DEFAULT_KIND, slug: id };
34  return { kind: id.slice(0, at), slug: id.slice(at + 1) };
35}
36
37/**
38 * Whether `<kind>.<slug>` fits the contract's id length, for a validator to refuse a slug that cannot.
39 *
40 * @param {string} kind
41 * @param {string} slug
42 */
43export function contentIdFits(kind, slug) {
44  return encodeContentId(kind, slug).length <= CONTENT_ID_MAX;
45}