founder-schema 0.3.0 → 0.5.0

package/dist/domains/members/members.js

@@ -0,0 +1,106 @@
+/**
+ * founder-schema: the staff member directory
+ *
+ *   GET    /api/v1/members                        ?q&status&role&limit&cursor
+ *   GET    /api/v1/members/:memberId              one member, as staff see them
+ *   POST   /api/v1/members/:memberId/suspension   { reason }  suspend
+ *   DELETE /api/v1/members/:memberId/suspension               lift it
+ *
+ * Every staff role has a Members tab: a moderator looks up who wrote
+ * something, a support agent finds the person who wrote in, a manager decides
+ * on a suspension. What each sees is the server's call, per field: a
+ * moderator gets no email (`email: null`), because finding a member's
+ * address is support's job, not moderation's.
+ *
+ * A SUSPENDED member cannot use the product at all, on any device, from the
+ * next request on (every call answers `ACCOUNT_SUSPENDED`); their posts stay
+ * up unless moderated separately, and a staff role they were acting in is
+ * switched off. Lifting it restores everything else.
+ *
+ * SEARCH (`q`) finds people by the start of their name or handle among listed
+ * founders, or by their exact email among everyone (only for a role that may
+ * see emails: a moderator's email search finds nothing). It returns up to
+ * `limit` matches in one page (type more to narrow), not a pageable list. Who may suspend whom is the access policy's: never
+ * yourself, never a superadmin, and a manager never a fellow manager.
+ *
+ * Each detail carries a `viewer` block of what the asking staff member may do
+ * to THIS member, worked out by the server, so the screen shows only the
+ * buttons that will work.
+ *
+ * @module founder-schema/domains/members
+ */
+import { z } from 'zod';
+import { platformRoleSchema } from '../../access/roles.js';
+import { emptyStringToUndefined, objectIdSchema, optionalTrimmedString, paginationQuerySchema, usernameSchema, } from '../../core/common.js';
+import { MEMBER_SEARCH_MAX, SUSPENSION_REASON_MAX, SUSPENSION_REASON_MIN, } from '../../core/limits.js';
+import { paginatedSchema } from '../../core/responses.js';
+/** What staff can see an account's state as. A deleted account is not listed. */
+export const MEMBER_STATUS_VALUES = ['active', 'suspended'];
+export const memberStatusSchema = z.enum(MEMBER_STATUS_VALUES);
+/** `:memberId` in the paths above. */
+export const memberParamsSchema = z.object({ memberId: objectIdSchema });
+/**
+ * The directory's query. `q` is a name or handle prefix, or a whole email
+ * address (anything with an `@` is matched as an email, exactly). An emptied
+ * box is "no search", not an error.
+ */
+export const memberDirectoryQuerySchema = paginationQuerySchema.extend({
+    q: optionalTrimmedString(MEMBER_SEARCH_MAX),
+    status: z.preprocess(emptyStringToUndefined, memberStatusSchema.optional()),
+    /** Only people holding this staff role. */
+    role: z.preprocess(emptyStringToUndefined, platformRoleSchema.optional()),
+});
+/** One row of the directory. */
+export const memberSummarySchema = z.object({
+    id: objectIdSchema,
+    displayName: z.string(),
+    /** Null when they have no founder profile (never finished onboarding). */
+    username: usernameSchema.nullable(),
+    avatarUrl: z.url().nullable(),
+    /** Null when the asking role may not see it. */
+    email: z.string().nullable(),
+    status: memberStatusSchema,
+    /** Staff roles held, highest first. Empty for an ordinary member. */
+    roles: z.array(platformRoleSchema),
+    joinedAt: z.iso.datetime(),
+    lastActiveAt: z.iso.datetime().nullable(),
+});
+export const memberDirectoryPageSchema = paginatedSchema(memberSummarySchema);
+/** A suspension in force. */
+export const suspensionSchema = z.object({
+    since: z.iso.datetime(),
+    reason: z.string(),
+    /** Who suspended them, by name at the time. */
+    by: z.object({ id: objectIdSchema, displayName: z.string() }).nullable(),
+});
+/** One member, as staff see them. */
+export const memberDetailSchema = memberSummarySchema.extend({
+    headline: z.string().nullable(),
+    /** Their city, as declared on their profile. */
+    city: z.string().nullable(),
+    counts: z.object({
+        posts: z.number().int().min(0),
+        polls: z.number().int().min(0),
+        comments: z.number().int().min(0),
+        /** Reports filed about their posts, polls and comments that are still up. */
+        reportsAgainst: z.number().int().min(0),
+        /** Tickets they have raised. */
+        tickets: z.number().int().min(0),
+    }),
+    suspension: suspensionSchema.nullable(),
+    /** What the asking staff member may do to this member. */
+    viewer: z.object({
+        canSuspend: z.boolean(),
+        /** Roles the asker may grant or revoke on this member (never their own). */
+        grantableRoles: z.array(platformRoleSchema),
+        /** May clear this member's forgotten MPIN (superadmin, someone else). */
+        canResetMpin: z.boolean(),
+    }),
+    /** Whether they have set an MPIN. Only meaningful for staff. */
+    mpinSet: z.boolean(),
+});
+/** `POST /members/:memberId/suspension`. The reason is on record in the audit log. */
+export const suspendMemberBodySchema = z.object({
+    reason: z.string().trim().min(SUSPENSION_REASON_MIN).max(SUSPENSION_REASON_MAX),
+});
+//# sourceMappingURL=members.js.map

package/dist/domains/members/members.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"members.js","sourceRoot":"","sources":["../../../src/domains/members/members.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,GACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,iFAAiF;AACjF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAU,CAAC;AACrE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAG/D,sCAAsC;AACtC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC;AAGzE;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,qBAAqB,CAAC,MAAM,CAAC;IACrE,CAAC,EAAE,qBAAqB,CAAC,iBAAiB,CAAC;IAC3C,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC;IAC3E,2CAA2C;IAC3C,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC;CAC1E,CAAC,CAAC;AAIH,gCAAgC;AAChC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,EAAE,EAAE,cAAc;IAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,0EAA0E;IAC1E,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC7B,gDAAgD;IAChD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,kBAAkB;IAC1B,qEAAqE;IACrE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;IAClC,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC1B,YAAY,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAC;AAG9E,6BAA6B;AAC7B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,+CAA+C;IAC/C,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzE,CAAC,CAAC;AAGH,qCAAqC;AACrC,MAAM,CAAC,MAAM,kBAAkB,GAAG,mBAAmB,CAAC,MAAM,CAAC;IAC3D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,gDAAgD;IAChD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACjC,6EAA6E;QAC7E,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,gCAAgC;QAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KACjC,CAAC;IACF,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACvC,0DAA0D;IAC1D,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;QACvB,4EAA4E;QAC5E,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;QAC3C,yEAAyE;QACzE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;KAC1B,CAAC;IACF,gEAAgE;IAChE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAGH,sFAAsF;AACtF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC;CAChF,CAAC,CAAC","sourcesContent":["/**\n * founder-schema: the staff member directory\n *\n *   GET    /api/v1/members                        ?q&status&role&limit&cursor\n *   GET    /api/v1/members/:memberId              one member, as staff see them\n *   POST   /api/v1/members/:memberId/suspension   { reason }  suspend\n *   DELETE /api/v1/members/:memberId/suspension               lift it\n *\n * Every staff role has a Members tab: a moderator looks up who wrote\n * something, a support agent finds the person who wrote in, a manager decides\n * on a suspension. What each sees is the server's call, per field: a\n * moderator gets no email (`email: null`), because finding a member's\n * address is support's job, not moderation's.\n *\n * A SUSPENDED member cannot use the product at all, on any device, from the\n * next request on (every call answers `ACCOUNT_SUSPENDED`); their posts stay\n * up unless moderated separately, and a staff role they were acting in is\n * switched off. Lifting it restores everything else.\n *\n * SEARCH (`q`) finds people by the start of their name or handle among listed\n * founders, or by their exact email among everyone (only for a role that may\n * see emails: a moderator's email search finds nothing). It returns up to\n * `limit` matches in one page (type more to narrow), not a pageable list. Who may suspend whom is the access policy's: never\n * yourself, never a superadmin, and a manager never a fellow manager.\n *\n * Each detail carries a `viewer` block of what the asking staff member may do\n * to THIS member, worked out by the server, so the screen shows only the\n * buttons that will work.\n *\n * @module founder-schema/domains/members\n */\n\nimport { z } from 'zod';\nimport { platformRoleSchema } from '../../access/roles.js';\nimport {\n  emptyStringToUndefined,\n  objectIdSchema,\n  optionalTrimmedString,\n  paginationQuerySchema,\n  usernameSchema,\n} from '../../core/common.js';\nimport {\n  MEMBER_SEARCH_MAX,\n  SUSPENSION_REASON_MAX,\n  SUSPENSION_REASON_MIN,\n} from '../../core/limits.js';\nimport { paginatedSchema } from '../../core/responses.js';\n\n/** What staff can see an account's state as. A deleted account is not listed. */\nexport const MEMBER_STATUS_VALUES = ['active', 'suspended'] as const;\nexport const memberStatusSchema = z.enum(MEMBER_STATUS_VALUES);\nexport type MemberStatus = z.infer<typeof memberStatusSchema>;\n\n/** `:memberId` in the paths above. */\nexport const memberParamsSchema = z.object({ memberId: objectIdSchema });\nexport type MemberParams = z.infer<typeof memberParamsSchema>;\n\n/**\n * The directory's query. `q` is a name or handle prefix, or a whole email\n * address (anything with an `@` is matched as an email, exactly). An emptied\n * box is \"no search\", not an error.\n */\nexport const memberDirectoryQuerySchema = paginationQuerySchema.extend({\n  q: optionalTrimmedString(MEMBER_SEARCH_MAX),\n  status: z.preprocess(emptyStringToUndefined, memberStatusSchema.optional()),\n  /** Only people holding this staff role. */\n  role: z.preprocess(emptyStringToUndefined, platformRoleSchema.optional()),\n});\nexport type MemberDirectoryQuery = z.infer<typeof memberDirectoryQuerySchema>;\nexport type MemberDirectoryQueryInput = z.input<typeof memberDirectoryQuerySchema>;\n\n/** One row of the directory. */\nexport const memberSummarySchema = z.object({\n  id: objectIdSchema,\n  displayName: z.string(),\n  /** Null when they have no founder profile (never finished onboarding). */\n  username: usernameSchema.nullable(),\n  avatarUrl: z.url().nullable(),\n  /** Null when the asking role may not see it. */\n  email: z.string().nullable(),\n  status: memberStatusSchema,\n  /** Staff roles held, highest first. Empty for an ordinary member. */\n  roles: z.array(platformRoleSchema),\n  joinedAt: z.iso.datetime(),\n  lastActiveAt: z.iso.datetime().nullable(),\n});\nexport type MemberSummary = z.infer<typeof memberSummarySchema>;\n\nexport const memberDirectoryPageSchema = paginatedSchema(memberSummarySchema);\nexport type MemberDirectoryPage = z.infer<typeof memberDirectoryPageSchema>;\n\n/** A suspension in force. */\nexport const suspensionSchema = z.object({\n  since: z.iso.datetime(),\n  reason: z.string(),\n  /** Who suspended them, by name at the time. */\n  by: z.object({ id: objectIdSchema, displayName: z.string() }).nullable(),\n});\nexport type Suspension = z.infer<typeof suspensionSchema>;\n\n/** One member, as staff see them. */\nexport const memberDetailSchema = memberSummarySchema.extend({\n  headline: z.string().nullable(),\n  /** Their city, as declared on their profile. */\n  city: z.string().nullable(),\n  counts: z.object({\n    posts: z.number().int().min(0),\n    polls: z.number().int().min(0),\n    comments: z.number().int().min(0),\n    /** Reports filed about their posts, polls and comments that are still up. */\n    reportsAgainst: z.number().int().min(0),\n    /** Tickets they have raised. */\n    tickets: z.number().int().min(0),\n  }),\n  suspension: suspensionSchema.nullable(),\n  /** What the asking staff member may do to this member. */\n  viewer: z.object({\n    canSuspend: z.boolean(),\n    /** Roles the asker may grant or revoke on this member (never their own). */\n    grantableRoles: z.array(platformRoleSchema),\n    /** May clear this member's forgotten MPIN (superadmin, someone else). */\n    canResetMpin: z.boolean(),\n  }),\n  /** Whether they have set an MPIN. Only meaningful for staff. */\n  mpinSet: z.boolean(),\n});\nexport type MemberDetail = z.infer<typeof memberDetailSchema>;\n\n/** `POST /members/:memberId/suspension`. The reason is on record in the audit log. */\nexport const suspendMemberBodySchema = z.object({\n  reason: z.string().trim().min(SUSPENSION_REASON_MIN).max(SUSPENSION_REASON_MAX),\n});\nexport type SuspendMemberBody = z.infer<typeof suspendMemberBodySchema>;\n"]}

package/dist/domains/moderation/moderation.d.ts

@@ -0,0 +1,184 @@
+/**
+ * founder-schema: moderation
+ *
+ *   GET  /api/v1/moderation/queue                            ?limit&cursor
+ *        what members reported and nobody has decided on, oldest report first
+ *   GET  /api/v1/moderation/content                          ?state&limit&cursor
+ *        by state, newest first: visible is posts and polls by when posted;
+ *        hidden and removed also hold comments (so a hidden comment can be
+ *        found and put back), by when hidden or removed
+ *   A decision that changes nothing (hiding what is already hidden, removing
+ *   what its author deleted) leaves the reports open and writes nothing: for
+ *   those, dismiss.
+ *   POST /api/v1/moderation/:contentKind/:contentId/decision { action, note? }
+ *        decide on one post, poll or comment; answers the item as it now is
+ *
+ * ONE ITEM PER THING, NOT PER REPORT. Five members reporting one post is one
+ * row with five reports, so a moderator decides once. The queue's order is
+ * the oldest open report first: whoever has waited longest is seen first, and
+ * a pile-on cannot jump the line.
+ *
+ * THE DECISIONS
+ *   dismiss  it stays up; its open reports close as dismissed
+ *   hide     out of every feed and thread, kept, restorable; reports actioned
+ *   restore  a hidden item goes back up
+ *   remove   deleted as its author deleting it would (counts move), not
+ *            restorable from here; reports actioned
+ * Every decision on someone else's content is written to the audit log, with
+ * the note when there is one.
+ *
+ * A report's `note` was written by a member: untrusted text, shown as text.
+ *
+ * @module founder-schema/domains/moderation
+ */
+import { z } from 'zod';
+/** Where a post, poll or comment stands. */
+export declare const MODERATION_STATE_VALUES: readonly ["visible", "hidden", "removed"];
+export declare const moderationStateSchema: z.ZodEnum<{
+    visible: "visible";
+    hidden: "hidden";
+    removed: "removed";
+}>;
+export type ModerationState = z.infer<typeof moderationStateSchema>;
+export declare const MODERATION_ACTION_VALUES: readonly ["dismiss", "hide", "restore", "remove"];
+export declare const moderationActionSchema: z.ZodEnum<{
+    dismiss: "dismiss";
+    hide: "hide";
+    restore: "restore";
+    remove: "remove";
+}>;
+export type ModerationAction = z.infer<typeof moderationActionSchema>;
+/** One post, poll or comment as moderation sees it. */
+export declare const moderationItemSchema: z.ZodObject<{
+    target: z.ZodObject<{
+        kind: z.ZodEnum<{
+            post: "post";
+            poll: "poll";
+            comment: "comment";
+        }>;
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    }, z.core.$strip>;
+    content: z.ZodObject<{
+        kind: z.ZodEnum<{
+            post: "post";
+            poll: "poll";
+        }>;
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    }, z.core.$strip>;
+    excerpt: z.ZodString;
+    author: z.ZodObject<{
+        id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        displayName: z.ZodString;
+        avatarUrl: z.ZodNullable<z.ZodURL>;
+    }, z.core.$strip>;
+    createdAt: z.ZodISODateTime;
+    state: z.ZodEnum<{
+        visible: "visible";
+        hidden: "hidden";
+        removed: "removed";
+    }>;
+    reports: z.ZodObject<{
+        open: z.ZodNumber;
+        total: z.ZodNumber;
+        reasons: z.ZodArray<z.ZodObject<{
+            reason: z.ZodEnum<{
+                other: "other";
+                spam: "spam";
+                harassment: "harassment";
+                misinformation: "misinformation";
+                off_topic: "off_topic";
+                impersonation: "impersonation";
+            }>;
+            count: z.ZodNumber;
+        }, z.core.$strip>>;
+        notes: z.ZodArray<z.ZodString>;
+        oldestOpenAt: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strip>;
+    viewer: z.ZodObject<{
+        canDismiss: z.ZodBoolean;
+        canHide: z.ZodBoolean;
+        canRestore: z.ZodBoolean;
+        canRemove: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type ModerationItem = z.infer<typeof moderationItemSchema>;
+export declare const moderationPageSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        target: z.ZodObject<{
+            kind: z.ZodEnum<{
+                post: "post";
+                poll: "poll";
+                comment: "comment";
+            }>;
+            id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        }, z.core.$strip>;
+        content: z.ZodObject<{
+            kind: z.ZodEnum<{
+                post: "post";
+                poll: "poll";
+            }>;
+            id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        }, z.core.$strip>;
+        excerpt: z.ZodString;
+        author: z.ZodObject<{
+            id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+            displayName: z.ZodString;
+            avatarUrl: z.ZodNullable<z.ZodURL>;
+        }, z.core.$strip>;
+        createdAt: z.ZodISODateTime;
+        state: z.ZodEnum<{
+            visible: "visible";
+            hidden: "hidden";
+            removed: "removed";
+        }>;
+        reports: z.ZodObject<{
+            open: z.ZodNumber;
+            total: z.ZodNumber;
+            reasons: z.ZodArray<z.ZodObject<{
+                reason: z.ZodEnum<{
+                    other: "other";
+                    spam: "spam";
+                    harassment: "harassment";
+                    misinformation: "misinformation";
+                    off_topic: "off_topic";
+                    impersonation: "impersonation";
+                }>;
+                count: z.ZodNumber;
+            }, z.core.$strip>>;
+            notes: z.ZodArray<z.ZodString>;
+            oldestOpenAt: z.ZodNullable<z.ZodISODateTime>;
+        }, z.core.$strip>;
+        viewer: z.ZodObject<{
+            canDismiss: z.ZodBoolean;
+            canHide: z.ZodBoolean;
+            canRestore: z.ZodBoolean;
+            canRemove: z.ZodBoolean;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type ModerationPage = z.infer<typeof moderationPageSchema>;
+/** `GET /moderation/content`. Visible when not said. */
+export declare const moderationContentQuerySchema: z.ZodObject<{
+    limit: z.ZodPreprocess<z.ZodDefault<z.ZodCoercedNumber<unknown>>, unknown>;
+    cursor: z.ZodOptional<z.ZodString>;
+    state: z.ZodPreprocess<z.ZodDefault<z.ZodEnum<{
+        visible: "visible";
+        hidden: "hidden";
+        removed: "removed";
+    }>>, unknown>;
+}, z.core.$strip>;
+export type ModerationContentQuery = z.infer<typeof moderationContentQuerySchema>;
+export type ModerationContentQueryInput = z.input<typeof moderationContentQuerySchema>;
+/** `POST /moderation/:contentKind/:contentId/decision`. */
+export declare const moderationDecisionBodySchema: z.ZodObject<{
+    action: z.ZodEnum<{
+        dismiss: "dismiss";
+        hide: "hide";
+        restore: "restore";
+        remove: "remove";
+    }>;
+    note: z.ZodPreprocess<z.ZodOptional<z.ZodString>, unknown>;
+}, z.core.$strip>;
+export type ModerationDecisionBody = z.infer<typeof moderationDecisionBodySchema>;
+//# sourceMappingURL=moderation.d.ts.map

package/dist/domains/moderation/moderation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moderation.d.ts","sourceRoot":"","sources":["../../../src/domains/moderation/moderation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB,4CAA4C;AAC5C,eAAO,MAAM,uBAAuB,2CAA4C,CAAC;AACjF,eAAO,MAAM,qBAAqB;;;;EAAkC,CAAC;AACrE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,eAAO,MAAM,wBAAwB,mDAAoD,CAAC;AAC1F,eAAO,MAAM,sBAAsB;;;;;EAAmC,CAAC;AACvE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAItE,uDAAuD;AACvD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgC/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAwC,CAAC;AAC1E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,wDAAwD;AACxD,eAAO,MAAM,4BAA4B;;;;;;;;iBAEvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAClF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEvF,2DAA2D;AAC3D,eAAO,MAAM,4BAA4B;;;;;;;;iBAIvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}

package/dist/domains/moderation/moderation.js

@@ -0,0 +1,90 @@
+/**
+ * founder-schema: moderation
+ *
+ *   GET  /api/v1/moderation/queue                            ?limit&cursor
+ *        what members reported and nobody has decided on, oldest report first
+ *   GET  /api/v1/moderation/content                          ?state&limit&cursor
+ *        by state, newest first: visible is posts and polls by when posted;
+ *        hidden and removed also hold comments (so a hidden comment can be
+ *        found and put back), by when hidden or removed
+ *   A decision that changes nothing (hiding what is already hidden, removing
+ *   what its author deleted) leaves the reports open and writes nothing: for
+ *   those, dismiss.
+ *   POST /api/v1/moderation/:contentKind/:contentId/decision { action, note? }
+ *        decide on one post, poll or comment; answers the item as it now is
+ *
+ * ONE ITEM PER THING, NOT PER REPORT. Five members reporting one post is one
+ * row with five reports, so a moderator decides once. The queue's order is
+ * the oldest open report first: whoever has waited longest is seen first, and
+ * a pile-on cannot jump the line.
+ *
+ * THE DECISIONS
+ *   dismiss  it stays up; its open reports close as dismissed
+ *   hide     out of every feed and thread, kept, restorable; reports actioned
+ *   restore  a hidden item goes back up
+ *   remove   deleted as its author deleting it would (counts move), not
+ *            restorable from here; reports actioned
+ * Every decision on someone else's content is written to the audit log, with
+ * the note when there is one.
+ *
+ * A report's `note` was written by a member: untrusted text, shown as text.
+ *
+ * @module founder-schema/domains/moderation
+ */
+import { z } from 'zod';
+import { emptyStringToUndefined, objectIdSchema, optionalTrimmedString, paginationQuerySchema, } from '../../core/common.js';
+import { MODERATION_NOTE_MAX } from '../../core/limits.js';
+import { paginatedSchema } from '../../core/responses.js';
+import { contentKindSchema, engagementTargetKindSchema, reportReasonSchema } from '../feed/feed.js';
+/** Where a post, poll or comment stands. */
+export const MODERATION_STATE_VALUES = ['visible', 'hidden', 'removed'];
+export const moderationStateSchema = z.enum(MODERATION_STATE_VALUES);
+export const MODERATION_ACTION_VALUES = ['dismiss', 'hide', 'restore', 'remove'];
+export const moderationActionSchema = z.enum(MODERATION_ACTION_VALUES);
+const count = z.number().int().min(0);
+/** One post, poll or comment as moderation sees it. */
+export const moderationItemSchema = z.object({
+    target: z.object({ kind: engagementTargetKindSchema, id: objectIdSchema }),
+    /** The post or poll itself, or the one a comment is on: where it is read in the app. */
+    content: z.object({ kind: contentKindSchema, id: objectIdSchema }),
+    /** Its first words (a poll's question), cut to `MODERATION_EXCERPT_MAX`. */
+    excerpt: z.string(),
+    author: z.object({
+        id: objectIdSchema,
+        displayName: z.string(),
+        avatarUrl: z.url().nullable(),
+    }),
+    createdAt: z.iso.datetime(),
+    state: moderationStateSchema,
+    reports: z.object({
+        /** Reports nobody has decided on. */
+        open: count,
+        /** Every report ever filed about it. */
+        total: count,
+        /** Why it was reported, among the open ones, most-given first. */
+        reasons: z.array(z.object({ reason: reportReasonSchema, count })),
+        /** The reporters' notes, among the open ones, newest first (a few, not all). */
+        notes: z.array(z.string()),
+        /** When the oldest open report was filed. Null when none is open. */
+        oldestOpenAt: z.iso.datetime().nullable(),
+    }),
+    /** What the asking staff member may do to it now. */
+    viewer: z.object({
+        canDismiss: z.boolean(),
+        canHide: z.boolean(),
+        canRestore: z.boolean(),
+        canRemove: z.boolean(),
+    }),
+});
+export const moderationPageSchema = paginatedSchema(moderationItemSchema);
+/** `GET /moderation/content`. Visible when not said. */
+export const moderationContentQuerySchema = paginationQuerySchema.extend({
+    state: z.preprocess(emptyStringToUndefined, moderationStateSchema.default('visible')),
+});
+/** `POST /moderation/:contentKind/:contentId/decision`. */
+export const moderationDecisionBodySchema = z.object({
+    action: moderationActionSchema,
+    /** Why, for the audit log. Optional: an obvious spam removal needs no essay. */
+    note: optionalTrimmedString(MODERATION_NOTE_MAX),
+});
+//# sourceMappingURL=moderation.js.map

package/dist/domains/moderation/moderation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moderation.js","sourceRoot":"","sources":["../../../src/domains/moderation/moderation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEpG,4CAA4C;AAC5C,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AACjF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;AAGrE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AAC1F,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;AAGvE,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEtC,uDAAuD;AACvD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,0BAA0B,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC;IAC1E,wFAAwF;IACxF,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC;IAClE,4EAA4E;IAC5E,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,EAAE,EAAE,cAAc;QAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;IACF,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,qBAAqB;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,qCAAqC;QACrC,IAAI,EAAE,KAAK;QACX,wCAAwC;QACxC,KAAK,EAAE,KAAK;QACZ,kEAAkE;QAClE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC;QACjE,gFAAgF;QAChF,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1B,qEAAqE;QACrE,YAAY,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KAC1C,CAAC;IACF,qDAAqD;IACrD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;QACvB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;QACpB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;QACvB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;KACvB,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,oBAAoB,CAAC,CAAC;AAG1E,wDAAwD;AACxD,MAAM,CAAC,MAAM,4BAA4B,GAAG,qBAAqB,CAAC,MAAM,CAAC;IACvE,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;CACtF,CAAC,CAAC;AAIH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,MAAM,EAAE,sBAAsB;IAC9B,gFAAgF;IAChF,IAAI,EAAE,qBAAqB,CAAC,mBAAmB,CAAC;CACjD,CAAC,CAAC","sourcesContent":["/**\n * founder-schema: moderation\n *\n *   GET  /api/v1/moderation/queue                            ?limit&cursor\n *        what members reported and nobody has decided on, oldest report first\n *   GET  /api/v1/moderation/content                          ?state&limit&cursor\n *        by state, newest first: visible is posts and polls by when posted;\n *        hidden and removed also hold comments (so a hidden comment can be\n *        found and put back), by when hidden or removed\n *   A decision that changes nothing (hiding what is already hidden, removing\n *   what its author deleted) leaves the reports open and writes nothing: for\n *   those, dismiss.\n *   POST /api/v1/moderation/:contentKind/:contentId/decision { action, note? }\n *        decide on one post, poll or comment; answers the item as it now is\n *\n * ONE ITEM PER THING, NOT PER REPORT. Five members reporting one post is one\n * row with five reports, so a moderator decides once. The queue's order is\n * the oldest open report first: whoever has waited longest is seen first, and\n * a pile-on cannot jump the line.\n *\n * THE DECISIONS\n *   dismiss  it stays up; its open reports close as dismissed\n *   hide     out of every feed and thread, kept, restorable; reports actioned\n *   restore  a hidden item goes back up\n *   remove   deleted as its author deleting it would (counts move), not\n *            restorable from here; reports actioned\n * Every decision on someone else's content is written to the audit log, with\n * the note when there is one.\n *\n * A report's `note` was written by a member: untrusted text, shown as text.\n *\n * @module founder-schema/domains/moderation\n */\n\nimport { z } from 'zod';\nimport {\n  emptyStringToUndefined,\n  objectIdSchema,\n  optionalTrimmedString,\n  paginationQuerySchema,\n} from '../../core/common.js';\nimport { MODERATION_NOTE_MAX } from '../../core/limits.js';\nimport { paginatedSchema } from '../../core/responses.js';\nimport { contentKindSchema, engagementTargetKindSchema, reportReasonSchema } from '../feed/feed.js';\n\n/** Where a post, poll or comment stands. */\nexport const MODERATION_STATE_VALUES = ['visible', 'hidden', 'removed'] as const;\nexport const moderationStateSchema = z.enum(MODERATION_STATE_VALUES);\nexport type ModerationState = z.infer<typeof moderationStateSchema>;\n\nexport const MODERATION_ACTION_VALUES = ['dismiss', 'hide', 'restore', 'remove'] as const;\nexport const moderationActionSchema = z.enum(MODERATION_ACTION_VALUES);\nexport type ModerationAction = z.infer<typeof moderationActionSchema>;\n\nconst count = z.number().int().min(0);\n\n/** One post, poll or comment as moderation sees it. */\nexport const moderationItemSchema = z.object({\n  target: z.object({ kind: engagementTargetKindSchema, id: objectIdSchema }),\n  /** The post or poll itself, or the one a comment is on: where it is read in the app. */\n  content: z.object({ kind: contentKindSchema, id: objectIdSchema }),\n  /** Its first words (a poll's question), cut to `MODERATION_EXCERPT_MAX`. */\n  excerpt: z.string(),\n  author: z.object({\n    id: objectIdSchema,\n    displayName: z.string(),\n    avatarUrl: z.url().nullable(),\n  }),\n  createdAt: z.iso.datetime(),\n  state: moderationStateSchema,\n  reports: z.object({\n    /** Reports nobody has decided on. */\n    open: count,\n    /** Every report ever filed about it. */\n    total: count,\n    /** Why it was reported, among the open ones, most-given first. */\n    reasons: z.array(z.object({ reason: reportReasonSchema, count })),\n    /** The reporters' notes, among the open ones, newest first (a few, not all). */\n    notes: z.array(z.string()),\n    /** When the oldest open report was filed. Null when none is open. */\n    oldestOpenAt: z.iso.datetime().nullable(),\n  }),\n  /** What the asking staff member may do to it now. */\n  viewer: z.object({\n    canDismiss: z.boolean(),\n    canHide: z.boolean(),\n    canRestore: z.boolean(),\n    canRemove: z.boolean(),\n  }),\n});\nexport type ModerationItem = z.infer<typeof moderationItemSchema>;\n\nexport const moderationPageSchema = paginatedSchema(moderationItemSchema);\nexport type ModerationPage = z.infer<typeof moderationPageSchema>;\n\n/** `GET /moderation/content`. Visible when not said. */\nexport const moderationContentQuerySchema = paginationQuerySchema.extend({\n  state: z.preprocess(emptyStringToUndefined, moderationStateSchema.default('visible')),\n});\nexport type ModerationContentQuery = z.infer<typeof moderationContentQuerySchema>;\nexport type ModerationContentQueryInput = z.input<typeof moderationContentQuerySchema>;\n\n/** `POST /moderation/:contentKind/:contentId/decision`. */\nexport const moderationDecisionBodySchema = z.object({\n  action: moderationActionSchema,\n  /** Why, for the audit log. Optional: an obvious spam removal needs no essay. */\n  note: optionalTrimmedString(MODERATION_NOTE_MAX),\n});\nexport type ModerationDecisionBody = z.infer<typeof moderationDecisionBodySchema>;\n"]}