@eduardoalvarez/arrecife 0.5.1 → 0.6.0

package/dist/og/index.d.cts

@@ -1,164 +1,168 @@
-import { C as Cara, P as Pose } from '../catalogo-Du5ID-Hi.cjs';
+import { F as Face, P as Pose } from '../catalog-D13txprv.cjs';
 
 /**
- * Las cuatro plantillas de Open Graph, 1200×630.
+ * The four Open Graph templates, 1200×630.
  *
- * NO son componentes de React. Devuelven el árbol de elementos que Satori
- * espera —`{ type, props }`— construido solo con tokens y con el catálogo de la
- * marca, que es dato puro. Este módulo se puede importar desde un worker, un
- * script de build o una función de borde sin montar nada.
+ * They are NOT React components. They return the element tree Satori expects —
+ * `{ type, props }` — built only from tokens and from the brand catalog, which
+ * is pure data. This module can be imported from a worker, a build script or an
+ * edge function without mounting anything.
  *
- * Es el caso que justifica la restricción de `src/tokens/`: si un token hubiera
- * terminado dependiendo de un componente, este archivo no existiría.
+ * It is the case that justifies the `src/tokens/` constraint: if a token had
+ * ended up depending on a component, this file would not exist.
  *
- * LA RETÍCULA ES UNA, del documento: eyebrow arriba, titular a la izquierda,
- * firma abajo y la mascota anclada a la derecha. Lo único que cambia entre
- * plantillas es el fondo y qué pose entra. Por eso no hay cuatro maquetaciones
- * aquí: hay una, y tres parámetros.
+ * THERE IS ONE GRID, from the document: eyebrow on top, headline on the left,
+ * signature at the bottom and the mascot anchored to the right. The only things
+ * that change between templates are the background and which pose comes in.
+ * Which is why there are not four layouts here: there is one, and three
+ * parameters.
  *
- *   lienzo 1200×630 · margen 64
- *   eyebrow  mono 20 · tracking 0.12em
- *   titular  display 800 · 58 · máx 3 líneas al 70 % del ancho
- *   firma    mono 21 · con la aleta a 34
- *   mascota  anclada a la derecha · alto máx 430
+ *   canvas    1200×630 · margin 64
+ *   eyebrow   mono 20 · tracking 0.12em
+ *   headline  display 800 · 58 · max 3 lines at 70 % of the width
+ *   signature mono 21 · with the fin at 34
+ *   mascot    anchored right · max height 430
  *
- * La de por defecto es la excepción declarada: retícula propia de dos columnas
- * con la aleta a 200 y divisor en x=290, y Geist 72/700 y 28/400 en vez de la
- * display. Está en el documento como excepción, así que está aquí como función
- * aparte y no como un `if` dentro de la común.
+ * The default one is the declared exception: a two-column grid of its own with
+ * the fin at 200 and a divider at x=290, and Geist 72/700 and 28/400 instead of
+ * the display face. It is in the document as an exception, so it is here as a
+ * separate function and not as an `if` inside the shared one.
  *
- * LA ALETA NO ES UN PARÁMETRO. El documento avisa de que «es el error más fácil
- * de cometer en un generador, porque el fondo es un parámetro»: espuma en las
- * tres plantillas oscuras, dos azules en la de curso. Aquí la elige el modo de
- * la plantilla, igual que `Isotipo` la elige con `sobre`. No hay forma de pedir
- * la combinación mala.
+ * THE FIN IS NOT A PARAMETER. The document warns that «it is the easiest
+ * mistake to make in a generator, because the background is a parameter»: foam
+ * in the three dark templates, two blues in the course one. Here it is chosen by
+ * the template's mode, the same way `Isotype` chooses it from `background`.
+ * There is no way to ask for the bad combination.
  *
- * El titular se trunca a 3 líneas con elipsis y NUNCA baja de tamaño: un titular
- * a 44 y otro a 58 en el mismo feed se ven como dos marcas distintas.
+ * The headline truncates to 3 lines with an ellipsis and NEVER shrinks: a
+ * headline at 44 and another at 58 in the same feed read as two different
+ * brands.
  *
- * Las imágenes llevan `alt=''`. Satori no lo necesita —pinta a SVG—, pero la
- * mascota y la aleta SON decorativas aquí: lo que la tarjeta dice es el titular,
- * y el `alt` de una OG lo pone el `<meta property="og:image:alt">` de la página.
- * Además, la story las monta como `<img>` de verdad y sin `alt` no pasan axe.
+ * The images carry `alt=''`. Satori does not need it — it paints to SVG — but
+ * the mascot and the fin ARE decorative here: what the card says is the
+ * headline, and an OG's `alt` is set by the page's
+ * `<meta property="og:image:alt">`. On top of that, the story mounts them as
+ * real `<img>` elements and without `alt` they do not pass axe.
  *
- * Uso:
+ * Usage:
  *
  *   import satori from 'satori';
- *   import { plantillaArticulo, OG } from '@eduardoalvarez/arrecife/og';
+ *   import { articleTemplate, OG } from '@eduardoalvarez/arrecife/og';
  *
- *   const svg = await satori(plantillaArticulo({ title, category, readingMinutes }), {
+ *   const svg = await satori(articleTemplate({ title, category, readingMinutes }), {
  *     width: OG.width,
  *     height: OG.height,
  *     fonts: [...],
  *   });
  */
 
-type NodoSatori = {
+type SatoriNode = {
     type: string;
     props: Record<string, unknown> & {
         style?: Record<string, string | number>;
-        children?: Hijo | readonly Hijo[];
+        children?: Child | readonly Child[];
     };
 };
-type Hijo = NodoSatori | string | null | undefined | false;
-/** El lienzo y la retícula. Son las medidas de producción. */
+type Child = SatoriNode | string | null | undefined | false;
+/** The canvas and the grid. These are the production measurements. */
 declare const OG: {
     readonly width: 1200;
     readonly height: 630;
-    readonly margen: 64;
-    /** Alto máximo de la mascota. */
-    readonly mascota: 430;
-    /** La aleta de la firma. */
-    readonly aletaFirma: 34;
+    readonly margin: 64;
+    /** The mascot's maximum height. */
+    readonly mascot: 430;
+    /** The signature's fin. */
+    readonly signatureFin: 34;
     /**
-     * Hueco que deja la columna cuando la pose va a la izquierda (curso).
+     * The gap the column leaves when the pose goes on the left (course).
      *
-     * Son 560 y no 420 porque una pose completa a 430 de alto mide ~534 de ancho:
-     * con el hueco justo, el tiburón se comía el titular. La reserva se mide por
-     * el ancho real de la pose, no por el margen.
+     * It is 560 and not 420 because a full pose at 430 tall measures ~534 wide:
+     * with the exact gap, the shark ate into the headline. The reserve is measured
+     * by the pose's real width, not by the margin.
      */
-    readonly reservaMascota: 560;
+    readonly mascotReserve: 560;
 };
-type DatosBase = {
+type BaseData = {
     title: string;
     /**
-     * Dónde se sirven los PNG. Satori no lee del disco: en un worker esto tiene
-     * que ser una URL absoluta o un `data:` URI.
+     * Where the PNGs are served from. Satori does not read from disk: in a worker
+     * this has to be an absolute URL or a `data:` URI.
      */
     basePath?: string | undefined;
 };
 /**
- * La retícula compartida. Tres de las cuatro plantillas son esto con otro fondo
- * y otra pieza de mascota.
+ * The shared grid. Three of the four templates are this with a different
+ * background and a different mascot piece.
  */
-declare function tarjeta(opciones: {
-    modo: 'oscuro' | 'claro';
-    fondo: string;
+declare function card(options: {
+    mode: 'dark' | 'light';
+    background: string;
     eyebrow: {
-        texto: string;
+        text: string;
         color: string;
     };
     title: string;
-    /** Línea bajo el titular, opcional. */
+    /** A line under the headline, optional. */
     bajada?: string | undefined;
-    firma: string;
+    signature: string;
     firmaColor: string;
     base: string;
-    /** La pieza de la derecha, ya montada. */
-    mascota?: NodoSatori | null | undefined;
-    /** `curso` la pone a la izquierda: es la única que invierte la retícula. */
+    /** The right-hand piece, already assembled. */
+    mascot?: SatoriNode | null | undefined;
+    /** `curso` puts it on the left: it is the only one that inverts the grid. */
     mascotaIzquierda?: boolean | undefined;
     tinta: string;
     tintaSecundaria: string;
-}): NodoSatori;
-type DatosArticulo = DatosBase & {
-    /** El slug de la categoría. Va en arena, en versalitas. */
+}): SatoriNode;
+type ArticleData = BaseData & {
+    /** The category slug. It goes in sand, in small caps. */
     category?: string | undefined;
     readingMinutes?: number | undefined;
     /**
-     * La cara, «según el tono del texto». No hay defecto pensado como neutro:
-     * `hearts` es la que el manual asigna al OG de artículo.
+     * The face, «according to the text's tone». There is no default meant as
+     * neutral: `hearts` is the one the manual assigns to the article OG.
      */
-    expresion?: Cara | undefined;
+    expression?: Face | undefined;
 };
-/** Artículo · degradado 145° sobre abismo, categoría y lectura en arena. */
-declare function plantillaArticulo(datos: DatosArticulo): NodoSatori;
-type DatosCurso = DatosBase & {
+/** Article · 145° gradient over abyss, category and reading time in sand. */
+declare function articleTemplate(data: ArticleData): SatoriNode;
+type CourseData = BaseData & {
     modules?: number | undefined;
     duration?: string | undefined;
-    /** El dominio del pie. Por defecto, el subdominio de cursos. */
+    /** The footer's domain. The courses subdomain by default. */
     url?: string | undefined;
     pose?: Pose | undefined;
 };
 /**
- * Curso · LA ÚNICA PLANTILLA EN CLARO.
+ * Course · THE ONLY LIGHT TEMPLATE.
  *
- * Pose completa a la izquierda —invierte la retícula—, eyebrow y URL en arena
- * oscura, y por tanto la aleta a dos azules. Esa última parte no se decide aquí:
- * sale de que el modo es claro.
+ * Full pose on the left — it inverts the grid — eyebrow and URL in dark sand,
+ * and therefore the two-blue fin. That last part is not decided here: it follows
+ * from the mode being light.
  */
-declare function plantillaCurso(datos: DatosCurso): NodoSatori;
-type DatosCharla = DatosBase & {
+declare function courseTemplate(data: CourseData): SatoriNode;
+type TalkData = BaseData & {
     event?: string | undefined;
     year?: string | number | undefined;
     location?: string | undefined;
     summary?: string | undefined;
     pose?: Pose | undefined;
 };
-/** Charla · eyebrow en bioluz con evento y año, pose sangrando por la esquina. */
-declare function plantillaCharla(datos: DatosCharla): NodoSatori;
-type DatosDefecto = Omit<DatosBase, 'title'> & {
-    /** El nombre. Por defecto, el wordmark. */
+/** Talk · eyebrow in biolume with the event and year, pose bleeding off the corner. */
+declare function talkTemplate(data: TalkData): SatoriNode;
+type DefaultData = Omit<BaseData, 'title'> & {
+    /** The name. The wordmark by default. */
     title?: string | undefined;
     description?: string | undefined;
 };
 /**
- * Por defecto · la excepción declarada del documento.
+ * Default · the document's declared exception.
  *
- * Retícula propia de dos columnas: la aleta en bioluz a 200 con halo, divisor en
- * x=290 y Geist 72/700 y 28/400 — NO la display. No comparte casco con las otras
- * tres porque el documento dice que la define el generador, no la tabla.
+ * A two-column grid of its own: the fin in biolume at 200 with a halo, a divider
+ * at x=290 and Geist 72/700 and 28/400 — NOT the display face. It does not share
+ * the shell with the other three because the document says the generator defines
+ * it, not the table.
  */
-declare function plantillaDefecto(datos?: DatosDefecto): NodoSatori;
+declare function defaultTemplate(data?: DefaultData): SatoriNode;
 
-export { type DatosArticulo, type DatosBase, type DatosCharla, type DatosCurso, type DatosDefecto, type NodoSatori, OG, plantillaArticulo, tarjeta as plantillaBase, plantillaCharla, plantillaCurso, plantillaDefecto };
+export { type ArticleData, type BaseData, type CourseData, type DefaultData, OG, type SatoriNode, type TalkData, articleTemplate, courseTemplate, defaultTemplate, card as plantillaBase, talkTemplate };

package/dist/og/index.d.ts

@@ -1,164 +1,168 @@
-import { C as Cara, P as Pose } from '../catalogo-Du5ID-Hi.js';
+import { F as Face, P as Pose } from '../catalog-D13txprv.js';
 
 /**
- * Las cuatro plantillas de Open Graph, 1200×630.
+ * The four Open Graph templates, 1200×630.
  *
- * NO son componentes de React. Devuelven el árbol de elementos que Satori
- * espera —`{ type, props }`— construido solo con tokens y con el catálogo de la
- * marca, que es dato puro. Este módulo se puede importar desde un worker, un
- * script de build o una función de borde sin montar nada.
+ * They are NOT React components. They return the element tree Satori expects —
+ * `{ type, props }` — built only from tokens and from the brand catalog, which
+ * is pure data. This module can be imported from a worker, a build script or an
+ * edge function without mounting anything.
  *
- * Es el caso que justifica la restricción de `src/tokens/`: si un token hubiera
- * terminado dependiendo de un componente, este archivo no existiría.
+ * It is the case that justifies the `src/tokens/` constraint: if a token had
+ * ended up depending on a component, this file would not exist.
  *
- * LA RETÍCULA ES UNA, del documento: eyebrow arriba, titular a la izquierda,
- * firma abajo y la mascota anclada a la derecha. Lo único que cambia entre
- * plantillas es el fondo y qué pose entra. Por eso no hay cuatro maquetaciones
- * aquí: hay una, y tres parámetros.
+ * THERE IS ONE GRID, from the document: eyebrow on top, headline on the left,
+ * signature at the bottom and the mascot anchored to the right. The only things
+ * that change between templates are the background and which pose comes in.
+ * Which is why there are not four layouts here: there is one, and three
+ * parameters.
  *
- *   lienzo 1200×630 · margen 64
- *   eyebrow  mono 20 · tracking 0.12em
- *   titular  display 800 · 58 · máx 3 líneas al 70 % del ancho
- *   firma    mono 21 · con la aleta a 34
- *   mascota  anclada a la derecha · alto máx 430
+ *   canvas    1200×630 · margin 64
+ *   eyebrow   mono 20 · tracking 0.12em
+ *   headline  display 800 · 58 · max 3 lines at 70 % of the width
+ *   signature mono 21 · with the fin at 34
+ *   mascot    anchored right · max height 430
  *
- * La de por defecto es la excepción declarada: retícula propia de dos columnas
- * con la aleta a 200 y divisor en x=290, y Geist 72/700 y 28/400 en vez de la
- * display. Está en el documento como excepción, así que está aquí como función
- * aparte y no como un `if` dentro de la común.
+ * The default one is the declared exception: a two-column grid of its own with
+ * the fin at 200 and a divider at x=290, and Geist 72/700 and 28/400 instead of
+ * the display face. It is in the document as an exception, so it is here as a
+ * separate function and not as an `if` inside the shared one.
  *
- * LA ALETA NO ES UN PARÁMETRO. El documento avisa de que «es el error más fácil
- * de cometer en un generador, porque el fondo es un parámetro»: espuma en las
- * tres plantillas oscuras, dos azules en la de curso. Aquí la elige el modo de
- * la plantilla, igual que `Isotipo` la elige con `sobre`. No hay forma de pedir
- * la combinación mala.
+ * THE FIN IS NOT A PARAMETER. The document warns that «it is the easiest
+ * mistake to make in a generator, because the background is a parameter»: foam
+ * in the three dark templates, two blues in the course one. Here it is chosen by
+ * the template's mode, the same way `Isotype` chooses it from `background`.
+ * There is no way to ask for the bad combination.
  *
- * El titular se trunca a 3 líneas con elipsis y NUNCA baja de tamaño: un titular
- * a 44 y otro a 58 en el mismo feed se ven como dos marcas distintas.
+ * The headline truncates to 3 lines with an ellipsis and NEVER shrinks: a
+ * headline at 44 and another at 58 in the same feed read as two different
+ * brands.
  *
- * Las imágenes llevan `alt=''`. Satori no lo necesita —pinta a SVG—, pero la
- * mascota y la aleta SON decorativas aquí: lo que la tarjeta dice es el titular,
- * y el `alt` de una OG lo pone el `<meta property="og:image:alt">` de la página.
- * Además, la story las monta como `<img>` de verdad y sin `alt` no pasan axe.
+ * The images carry `alt=''`. Satori does not need it — it paints to SVG — but
+ * the mascot and the fin ARE decorative here: what the card says is the
+ * headline, and an OG's `alt` is set by the page's
+ * `<meta property="og:image:alt">`. On top of that, the story mounts them as
+ * real `<img>` elements and without `alt` they do not pass axe.
  *
- * Uso:
+ * Usage:
  *
  *   import satori from 'satori';
- *   import { plantillaArticulo, OG } from '@eduardoalvarez/arrecife/og';
+ *   import { articleTemplate, OG } from '@eduardoalvarez/arrecife/og';
  *
- *   const svg = await satori(plantillaArticulo({ title, category, readingMinutes }), {
+ *   const svg = await satori(articleTemplate({ title, category, readingMinutes }), {
  *     width: OG.width,
  *     height: OG.height,
  *     fonts: [...],
  *   });
  */
 
-type NodoSatori = {
+type SatoriNode = {
     type: string;
     props: Record<string, unknown> & {
         style?: Record<string, string | number>;
-        children?: Hijo | readonly Hijo[];
+        children?: Child | readonly Child[];
     };
 };
-type Hijo = NodoSatori | string | null | undefined | false;
-/** El lienzo y la retícula. Son las medidas de producción. */
+type Child = SatoriNode | string | null | undefined | false;
+/** The canvas and the grid. These are the production measurements. */
 declare const OG: {
     readonly width: 1200;
     readonly height: 630;
-    readonly margen: 64;
-    /** Alto máximo de la mascota. */
-    readonly mascota: 430;
-    /** La aleta de la firma. */
-    readonly aletaFirma: 34;
+    readonly margin: 64;
+    /** The mascot's maximum height. */
+    readonly mascot: 430;
+    /** The signature's fin. */
+    readonly signatureFin: 34;
     /**
-     * Hueco que deja la columna cuando la pose va a la izquierda (curso).
+     * The gap the column leaves when the pose goes on the left (course).
      *
-     * Son 560 y no 420 porque una pose completa a 430 de alto mide ~534 de ancho:
-     * con el hueco justo, el tiburón se comía el titular. La reserva se mide por
-     * el ancho real de la pose, no por el margen.
+     * It is 560 and not 420 because a full pose at 430 tall measures ~534 wide:
+     * with the exact gap, the shark ate into the headline. The reserve is measured
+     * by the pose's real width, not by the margin.
      */
-    readonly reservaMascota: 560;
+    readonly mascotReserve: 560;
 };
-type DatosBase = {
+type BaseData = {
     title: string;
     /**
-     * Dónde se sirven los PNG. Satori no lee del disco: en un worker esto tiene
-     * que ser una URL absoluta o un `data:` URI.
+     * Where the PNGs are served from. Satori does not read from disk: in a worker
+     * this has to be an absolute URL or a `data:` URI.
      */
     basePath?: string | undefined;
 };
 /**
- * La retícula compartida. Tres de las cuatro plantillas son esto con otro fondo
- * y otra pieza de mascota.
+ * The shared grid. Three of the four templates are this with a different
+ * background and a different mascot piece.
  */
-declare function tarjeta(opciones: {
-    modo: 'oscuro' | 'claro';
-    fondo: string;
+declare function card(options: {
+    mode: 'dark' | 'light';
+    background: string;
     eyebrow: {
-        texto: string;
+        text: string;
         color: string;
     };
     title: string;
-    /** Línea bajo el titular, opcional. */
+    /** A line under the headline, optional. */
     bajada?: string | undefined;
-    firma: string;
+    signature: string;
     firmaColor: string;
     base: string;
-    /** La pieza de la derecha, ya montada. */
-    mascota?: NodoSatori | null | undefined;
-    /** `curso` la pone a la izquierda: es la única que invierte la retícula. */
+    /** The right-hand piece, already assembled. */
+    mascot?: SatoriNode | null | undefined;
+    /** `curso` puts it on the left: it is the only one that inverts the grid. */
     mascotaIzquierda?: boolean | undefined;
     tinta: string;
     tintaSecundaria: string;
-}): NodoSatori;
-type DatosArticulo = DatosBase & {
-    /** El slug de la categoría. Va en arena, en versalitas. */
+}): SatoriNode;
+type ArticleData = BaseData & {
+    /** The category slug. It goes in sand, in small caps. */
     category?: string | undefined;
     readingMinutes?: number | undefined;
     /**
-     * La cara, «según el tono del texto». No hay defecto pensado como neutro:
-     * `hearts` es la que el manual asigna al OG de artículo.
+     * The face, «according to the text's tone». There is no default meant as
+     * neutral: `hearts` is the one the manual assigns to the article OG.
      */
-    expresion?: Cara | undefined;
+    expression?: Face | undefined;
 };
-/** Artículo · degradado 145° sobre abismo, categoría y lectura en arena. */
-declare function plantillaArticulo(datos: DatosArticulo): NodoSatori;
-type DatosCurso = DatosBase & {
+/** Article · 145° gradient over abyss, category and reading time in sand. */
+declare function articleTemplate(data: ArticleData): SatoriNode;
+type CourseData = BaseData & {
     modules?: number | undefined;
     duration?: string | undefined;
-    /** El dominio del pie. Por defecto, el subdominio de cursos. */
+    /** The footer's domain. The courses subdomain by default. */
     url?: string | undefined;
     pose?: Pose | undefined;
 };
 /**
- * Curso · LA ÚNICA PLANTILLA EN CLARO.
+ * Course · THE ONLY LIGHT TEMPLATE.
  *
- * Pose completa a la izquierda —invierte la retícula—, eyebrow y URL en arena
- * oscura, y por tanto la aleta a dos azules. Esa última parte no se decide aquí:
- * sale de que el modo es claro.
+ * Full pose on the left — it inverts the grid — eyebrow and URL in dark sand,
+ * and therefore the two-blue fin. That last part is not decided here: it follows
+ * from the mode being light.
  */
-declare function plantillaCurso(datos: DatosCurso): NodoSatori;
-type DatosCharla = DatosBase & {
+declare function courseTemplate(data: CourseData): SatoriNode;
+type TalkData = BaseData & {
     event?: string | undefined;
     year?: string | number | undefined;
     location?: string | undefined;
     summary?: string | undefined;
     pose?: Pose | undefined;
 };
-/** Charla · eyebrow en bioluz con evento y año, pose sangrando por la esquina. */
-declare function plantillaCharla(datos: DatosCharla): NodoSatori;
-type DatosDefecto = Omit<DatosBase, 'title'> & {
-    /** El nombre. Por defecto, el wordmark. */
+/** Talk · eyebrow in biolume with the event and year, pose bleeding off the corner. */
+declare function talkTemplate(data: TalkData): SatoriNode;
+type DefaultData = Omit<BaseData, 'title'> & {
+    /** The name. The wordmark by default. */
     title?: string | undefined;
     description?: string | undefined;
 };
 /**
- * Por defecto · la excepción declarada del documento.
+ * Default · the document's declared exception.
  *
- * Retícula propia de dos columnas: la aleta en bioluz a 200 con halo, divisor en
- * x=290 y Geist 72/700 y 28/400 — NO la display. No comparte casco con las otras
- * tres porque el documento dice que la define el generador, no la tabla.
+ * A two-column grid of its own: the fin in biolume at 200 with a halo, a divider
+ * at x=290 and Geist 72/700 and 28/400 — NOT the display face. It does not share
+ * the shell with the other three because the document says the generator defines
+ * it, not the table.
  */
-declare function plantillaDefecto(datos?: DatosDefecto): NodoSatori;
+declare function defaultTemplate(data?: DefaultData): SatoriNode;
 
-export { type DatosArticulo, type DatosBase, type DatosCharla, type DatosCurso, type DatosDefecto, type NodoSatori, OG, plantillaArticulo, tarjeta as plantillaBase, plantillaCharla, plantillaCurso, plantillaDefecto };
+export { type ArticleData, type BaseData, type CourseData, type DefaultData, OG, type SatoriNode, type TalkData, articleTemplate, courseTemplate, defaultTemplate, card as plantillaBase, talkTemplate };