g-comments 0.1.0 → 0.2.1

package/dist/element.d.ts

@@ -178,6 +178,54 @@ type CountRef = {
 } | {
     topicId: number;
 };
+/** One palette of a theme (`ForumTheme#scheme_payload`). */
+interface ForumColorScheme {
+    id: number;
+    name: string;
+    type: "light" | "dark";
+    /**
+     * Every custom property the forum's colour definitions emit, without the
+     * `--` prefix and with references already resolved: `primary`, `secondary`,
+     * `tertiary`, `primary-low`, `primary-medium`, `danger`, …
+     */
+    colors: Record<string, string>;
+}
+/** A `@font-face` source the forum serves. */
+interface ForumFontFace {
+    family: string;
+    /** A CSS `src` value, e.g. `url("https://forum/fonts/x.woff2") format("woff2")`. */
+    src: string;
+    weight: number | string;
+}
+interface ForumFont {
+    key: string;
+    name: string;
+    /** A CSS `font-family` value. */
+    stack: string;
+    /** Empty for fonts the forum expects to be installed. */
+    faces: ForumFontFace[];
+}
+/** `GET /comments/theme`: the forum's look as data. */
+interface ForumTheme {
+    theme: {
+        id: number;
+        name: string;
+    } | null;
+    schemes: {
+        light: ForumColorScheme;
+        /** Present when the theme has a dark palette. */
+        dark: ForumColorScheme | null;
+    };
+    fonts: {
+        body: ForumFont | null;
+        heading: ForumFont | null;
+        monospace: ForumFont | null;
+    };
+    /** The theme's "Embedded CSS" stylesheets, absolute URLs. */
+    stylesheets: string[];
+    /** Changes whenever any of the above changes. */
+    version: string;
+}
 
 type CommentsErrorType = "invalid_key" | "not_logged_in" | "invalid_access" | "invalid_parameters" | "not_found" | "rate_limit" | "thread_conflict" | "page_not_allowed" | "invalid_url" | "no_category" | "thread_not_created" | "invalid_grant" | "user_not_allowed" | "submission_rejected" | "not_a_root_comment" | "pin_limit_reached" | "cancelled" | "storage_unavailable" | "unreachable" | "unknown";
 interface CommentsErrorOptions {
@@ -207,7 +255,7 @@ declare class CommentsError extends Error {
 }
 
 /** What the widget was doing when an `error` event fired. */
-type CommentsAction = "open" | "load" | "loadMore" | "loadReplies" | "context" | "post" | "edit" | "delete" | "like" | "flag" | "pin" | "upload" | "preview" | "signIn";
+type CommentsAction = "open" | "load" | "loadMore" | "loadReplies" | "context" | "post" | "edit" | "delete" | "like" | "flag" | "pin" | "upload" | "preview" | "signIn" | "theme";
 /** Delivered to `<DiscourseComments onEvent>`. */
 type CommentsEvent = {
     type: "comment.posted";
@@ -428,6 +476,8 @@ interface CommentsClient {
     };
     /** Cached; refetched after sign-in and sign-out. */
     config(): Promise<Config>;
+    /** The forum's palettes, fonts and theme stylesheets; cached for the client's lifetime. */
+    theme(): Promise<ForumTheme>;
     /** Batched per tick, at most 50 refs per request. Keys are encoded refs (see `encodeRef`). */
     counts(refs: readonly CountRef[]): Promise<Counts>;
     count(ref: CountRef): Promise<number>;
@@ -439,8 +489,11 @@ interface CommentsClient {
     dispose(): void;
 }
 
-/** `auto` follows `prefers-color-scheme`; `inherit` leaves the colours to the page. */
-type Theme = "auto" | "light" | "dark" | "inherit";
+/**
+ * `auto` follows `prefers-color-scheme`, `inherit` leaves the colours to the
+ * page, and `forum` applies the forum's own palettes, fonts and theme CSS.
+ */
+type Theme = "auto" | "light" | "dark" | "inherit" | "forum";
 
 /**
  * Where signing in happens: `inline` shows a "Join the conversation" panel,
@@ -514,7 +567,7 @@ declare const COMMENTS_ATTRIBUTES: {
     };
     readonly theme: {
         readonly prop: "theme";
-        readonly type: readonly ["auto", "light", "dark", "inherit"];
+        readonly type: readonly ["auto", "light", "dark", "inherit", "forum"];
     };
     readonly locale: {
         readonly prop: "locale";
@@ -598,7 +651,7 @@ declare class DiscourseCommentsElement extends ReactHostElement<DiscourseComment
         };
         readonly theme: {
             readonly prop: "theme";
-            readonly type: readonly ["auto", "light", "dark", "inherit"];
+            readonly type: readonly ["auto", "light", "dark", "inherit", "forum"];
         };
         readonly locale: {
             readonly prop: "locale";