@andesine/pages 0.0.0-stage → 0.6.0

package/dist/chunks/types-DBzuXfSe.d.ts

@@ -0,0 +1,53 @@
+import { Font } from "satori";
+//#region src/social/html.d.ts
+type MarkupValue = Markup | string | number | boolean | null | undefined | MarkupValue[];
+/** Card markup from the `html` template tag, whose values are already escaped. */
+declare class Markup {
+  readonly value: string;
+  constructor(value: string);
+  toString(): string;
+}
+/**
+ * A template tag for social card markup. It escapes values, joins arrays, and leaves out
+ * `false`, `null`, and `undefined`, so `${condition && html`…`}` adds optional parts.
+ */
+declare const html: (strings: TemplateStringsArray, ...values: MarkupValue[]) => Markup;
+//#endregion
+//#region src/social/types.d.ts
+interface SocialCardData {
+  siteName: string;
+  /** Shows the site name after the logo, like the page header; always without a logo. */
+  showSiteName: boolean;
+  /** The format of the configured logo. */
+  logoFormat?: "icon" | "full";
+  title: string;
+  description?: string;
+  /** Label of the page's group. */
+  group?: string;
+  /** Data URL of the configured logo. */
+  logo?: string;
+  /** Data URL of the configured card background. */
+  background?: string;
+  brand: {
+    primary: string;
+    secondary: string;
+    tertiary: string;
+  };
+}
+interface SocialCardFont extends Omit<Font, "data"> {
+  /** The font file, or a data URL of it, e.g. from a Vite `?inline` import. */
+  data: Font["data"] | string;
+}
+/** The template's social card: the design of generated page images. */
+interface SocialCard {
+  /** Fonts for the card text. Satori reads TTF, OTF, and WOFF files, but not WOFF2. */
+  fonts(): SocialCardFont[] | Promise<SocialCardFont[]>;
+  /**
+   * Returns the card as HTML, 1200 by 630 pixels, e.g. from the `html` tag. Satori supports a
+   * subset of CSS, and Tailwind classes in `tw` attributes.
+   */
+  render(data: SocialCardData): Markup | string;
+}
+//#endregion
+export { MarkupValue as a, Markup as i, SocialCardData as n, html as o, SocialCardFont as r, SocialCard as t };
+//# sourceMappingURL=types-DBzuXfSe.d.ts.map