@pyqdeck/community-sdk 0.1.0 → 0.2.0

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { type HttpOptions, type RequestOptions } from "./http.js";
-import type { Comment, CommunityInfo, LinkInfo, LinkedResource, LocalImage, Member, MediaItem, Notification, NotificationType, OwnMember, Page, PageParams, Post, ProfileUpdate, ReportGroup, ReportReason, ReportTarget, TrendingTag, UploadTicket } from "./types.js";
+import type { Comment, CommunityInfo, LinkInfo, LinkedResource, LocalImage, Member, MediaItem, ModerationEvent, ModerationEventFilter, PageMeta, Notification, NotificationType, OwnMember, Page, PageParams, Post, ProfileUpdate, ReportGroup, ReportReason, ReportTarget, TrendingTag, UploadTicket } from "./types.js";
 import { type FileUploader } from "./upload.js";
 export interface CommunityClientOptions extends HttpOptions {
     /** The community this client talks to (`beu`, `gate`, ...). Added to every path; one client per app (IR-SDK-12). */
@@ -150,6 +150,12 @@ export declare function createCommunityClient(options: CommunityClientOptions):
             closed: number;
         }>;
     };
+    moderation: {
+        events: (filter?: ModerationEventFilter, o?: RequestOptions) => Promise<{
+            items: ModerationEvent[];
+            page: PageMeta;
+        }>;
+    };
     links: {
         /** Destination host and safety verdict, so the app can show its own warning before opening a link. */
         resolve: (code: string, o?: RequestOptions) => Promise<LinkInfo>;

package/dist/client.js

@@ -86,6 +86,18 @@ export function createCommunityClient(options) {
         queue: async (p = {}, o) => (await get("/reports", { ...p }, o)).data,
         resolve: async (input, o) => (await send("POST", "/reports/resolve", input, o)).data,
     };
+    // Moderators and admins only. The history of every content check, allowed results included.
+    const moderation = {
+        events: async (filter = {}, o) => {
+            const res = await http.call({
+                method: "GET",
+                path: `${root}/moderation/events`,
+                query: { ...filter, escalate: filter.escalate === undefined ? undefined : String(filter.escalate) },
+                ...o,
+            });
+            return { items: res.data, page: res.pagination };
+        },
+    };
     const links = {
         /** Destination host and safety verdict, so the app can show its own warning before opening a link. */
         resolve: async (code, o) => (await get(`/links/${enc(code)}`, undefined, o)).data,
@@ -168,6 +180,7 @@ export function createCommunityClient(options) {
         members,
         notifications,
         reports,
+        moderation,
         links,
         media,
         publishPost,

package/dist/http.d.ts

@@ -19,9 +19,16 @@ interface Call extends RequestOptions {
 }
 export interface Envelope<T> {
     data: T;
+    /** Cursor lists send `nextCursor` and `hasMore`; the few offset lists (moderation history) send page numbers. */
     pagination?: {
         nextCursor?: string | null;
         hasMore?: boolean;
+        total?: number;
+        page?: number;
+        limit?: number;
+        totalPages?: number;
+        hasNext?: boolean;
+        hasPrev?: boolean;
     };
 }
 export declare class Http {

package/dist/types.d.ts

@@ -81,6 +81,9 @@ export interface Comment {
     editedAt: string | null;
     createdAt: string;
     rawBody?: string;
+    /** Own comments and, for moderators, anyone's. */
+    heldReason?: "moderation" | "reports" | null;
+    removedReason?: string | null;
     hasPendingEdit?: boolean;
 }
 export interface Member extends Author {
@@ -179,6 +182,15 @@ export interface ReportGroup {
     reasons: ReportReason[];
     notes: string[];
     firstReportedAt: string;
+    /** What the reported thing is, so a moderator does not have to open it. Null if it no longer exists. */
+    preview: {
+        title: string;
+        snippet?: string;
+        authorUsername?: string | null;
+        /** The post to open (the post itself, or the post a comment belongs to). */
+        postId?: string;
+        status?: string;
+    } | null;
 }
 export interface LinkInfo {
     code: string;
@@ -188,6 +200,43 @@ export interface LinkInfo {
     /** What a tap would do: open at once, show the warning page, or refuse. */
     decision: "redirect" | "warn" | "blocked" | "gone" | "notfound";
 }
+/** One result of the content check. The content itself is never stored, only who, where, the result and the scores. */
+export interface ModerationEvent {
+    _id: string;
+    /** The member who submitted it. */
+    userId?: string;
+    /** Where it was submitted: media, post, comment or profile. */
+    source: string;
+    /** The checked thing: a media id for images. */
+    sourceId?: string;
+    action: "allow" | "review" | "reject";
+    /** The checker was unavailable, so there is no real verdict. */
+    degraded: boolean;
+    /** Sexual content involving minors: needs the child-safety process. */
+    escalate: boolean;
+    categories: string[];
+    scores: Record<string, number>;
+    /** Which checker decided, e.g. openai or profanity-filter. */
+    provider: string;
+    createdAt: string;
+}
+export interface PageMeta {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+}
+export interface ModerationEventFilter {
+    page?: number;
+    limit?: number;
+    action?: "allow" | "review" | "reject";
+    source?: string;
+    sourceId?: string;
+    userId?: string;
+    escalate?: boolean;
+}
 /** A cursor page. Pass `nextCursor` back to get the next one. */
 export interface Page<T> {
     items: T[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pyqdeck/community-sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Typed client for the PYQDeck Community API (posts, comments, members, short links). No Clerk, React or cache inside: the app supplies the token and owns caching.",
   "keywords": [
     "pyqdeck",