src/contract/base.ts

Functions

None: it only declares types or values.

Imports

It imports no other module of this repo. Imported by src/contract.ts, src/contract/content.ts, src/contract/media.ts, src/contract/mentions.ts.

Source

1// The ids, versions and text every group of the contract shares.
2
3import { z } from "zod";
4
5/** Opaque to Carrel: each site decides what a version is. It should identify the item's own content (dustinedwards.info uses the git blob sha of the item's own file). */
6export const Version = z.string().min(1).max(200);
7
8/** Carrel's id for one change, carried into the site's commit or row so the two records join. */
9export const ChangeId = z.string().regex(/^[A-Za-z0-9_-]{1,128}$/);
10
11/** A site's id for one piece of content: a slug, or a row id. Never a path. */
12export const ContentId = z.string().regex(/^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/);
13
14export const Timestamp = z.iso.datetime({ offset: true });
15
16/** Two million characters: far above any article, far below a Worker's memory. */
17export const Source = z.string().max(2_000_000);
18
19export const SortDir = z.enum(["asc", "desc"]);
20
21export const SiteInfo = z.object({
22  id: z.string().regex(/^[a-z0-9-]{1,64}$/),
23  name: z.string().min(1).max(200),
24  origin: z.url(),
25});
26
27export type SiteInfo = z.infer<typeof SiteInfo>;
28export type SortDir = z.infer<typeof SortDir>;