@headless-lms/server 0.4.0 → 0.5.0

package/dist/http/schemas/discussion.d.ts

@@ -15,13 +15,8 @@ declare const CommentAuthor: z.ZodObject<{
   image: z.ZodNullable<z.ZodString>;
   imageAssetId: z.ZodNullable<z.ZodString>;
   imageUrl: z.ZodNullable<z.ZodString>;
-  role: z.ZodEnum<{
-    owner: "owner";
-    admin: "admin";
-    instructor: "instructor";
-    moderator: "moderator";
-    student: "student";
-  }>;
+  team: z.ZodBoolean;
+  roleName: z.ZodNullable<z.ZodString>;
 }, z.core.$strict>;
 type CommentAuthor = z.infer<typeof CommentAuthor>;
 /** Any single emoji. Open, so widening the picker needs no schema change. */
@@ -59,13 +54,8 @@ declare const CommentView: z.ZodObject<{
     image: z.ZodNullable<z.ZodString>;
     imageAssetId: z.ZodNullable<z.ZodString>;
     imageUrl: z.ZodNullable<z.ZodString>;
-    role: z.ZodEnum<{
-      owner: "owner";
-      admin: "admin";
-      instructor: "instructor";
-      moderator: "moderator";
-      student: "student";
-    }>;
+    team: z.ZodBoolean;
+    roleName: z.ZodNullable<z.ZodString>;
   }, z.core.$strict>;
   body: z.ZodNullable<z.ZodString>;
   status: z.ZodEnum<{
@@ -82,13 +72,8 @@ declare const CommentView: z.ZodObject<{
     image: z.ZodNullable<z.ZodString>;
     imageAssetId: z.ZodNullable<z.ZodString>;
     imageUrl: z.ZodNullable<z.ZodString>;
-    role: z.ZodEnum<{
-      owner: "owner";
-      admin: "admin";
-      instructor: "instructor";
-      moderator: "moderator";
-      student: "student";
-    }>;
+    team: z.ZodBoolean;
+    roleName: z.ZodNullable<z.ZodString>;
   }, z.core.$strict>>;
   reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
   viewerReaction: z.ZodOptional<z.ZodString>;
@@ -146,13 +131,8 @@ declare const ActivityComments: z.ZodObject<{
       image: z.ZodNullable<z.ZodString>;
       imageAssetId: z.ZodNullable<z.ZodString>;
       imageUrl: z.ZodNullable<z.ZodString>;
-      role: z.ZodEnum<{
-        owner: "owner";
-        admin: "admin";
-        instructor: "instructor";
-        moderator: "moderator";
-        student: "student";
-      }>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>;
     body: z.ZodNullable<z.ZodString>;
     status: z.ZodEnum<{
@@ -169,13 +149,8 @@ declare const ActivityComments: z.ZodObject<{
       image: z.ZodNullable<z.ZodString>;
       imageAssetId: z.ZodNullable<z.ZodString>;
       imageUrl: z.ZodNullable<z.ZodString>;
-      role: z.ZodEnum<{
-        owner: "owner";
-        admin: "admin";
-        instructor: "instructor";
-        moderator: "moderator";
-        student: "student";
-      }>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>>;
     reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
     viewerReaction: z.ZodOptional<z.ZodString>;
@@ -197,7 +172,7 @@ declare const EditComment: z.ZodObject<{
   body: z.ZodString;
 }, z.core.$strict>;
 type EditComment = z.infer<typeof EditComment>;
-/** The staff PATCH writes status and nothing else: publishing covers approving
+/** The moderator's PATCH writes status and nothing else: publishing covers approving
  *  a pending comment and restoring a removed one. Revising the text is the
  *  author's own edit, under /api/member. */
 declare const PatchComment: z.ZodObject<{
@@ -264,19 +239,14 @@ declare const CommentReportSummary: z.ZodObject<{
     image: z.ZodNullable<z.ZodString>;
     imageAssetId: z.ZodNullable<z.ZodString>;
     imageUrl: z.ZodNullable<z.ZodString>;
-    role: z.ZodEnum<{
-      owner: "owner";
-      admin: "admin";
-      instructor: "instructor";
-      moderator: "moderator";
-      student: "student";
-    }>;
+    team: z.ZodBoolean;
+    roleName: z.ZodNullable<z.ZodString>;
   }, z.core.$strict>;
   reason: z.ZodString;
   createdAt: z.ZodCoercedDate<unknown>;
 }, z.core.$strict>;
 type CommentReportSummary = z.infer<typeof CommentReportSummary>;
-/** One row of the staff comment list: the comment plus the context a
+/** One row of the moderation comment list: the comment plus the context a
  *  moderation decision needs, so the list needs no follow-up request. */
 declare const CommentListItem: z.ZodObject<{
   id: z.ZodString;
@@ -299,13 +269,8 @@ declare const CommentListItem: z.ZodObject<{
     image: z.ZodNullable<z.ZodString>;
     imageAssetId: z.ZodNullable<z.ZodString>;
     imageUrl: z.ZodNullable<z.ZodString>;
-    role: z.ZodEnum<{
-      owner: "owner";
-      admin: "admin";
-      instructor: "instructor";
-      moderator: "moderator";
-      student: "student";
-    }>;
+    team: z.ZodBoolean;
+    roleName: z.ZodNullable<z.ZodString>;
   }, z.core.$strict>;
   authorEmail: z.ZodEmail;
   removedBy: z.ZodNullable<z.ZodString>;
@@ -319,13 +284,8 @@ declare const CommentListItem: z.ZodObject<{
       image: z.ZodNullable<z.ZodString>;
       imageAssetId: z.ZodNullable<z.ZodString>;
       imageUrl: z.ZodNullable<z.ZodString>;
-      role: z.ZodEnum<{
-        owner: "owner";
-        admin: "admin";
-        instructor: "instructor";
-        moderator: "moderator";
-        student: "student";
-      }>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>;
     reason: z.ZodString;
     createdAt: z.ZodCoercedDate<unknown>;
@@ -372,13 +332,8 @@ declare const CommentsPage: z.ZodObject<{
       image: z.ZodNullable<z.ZodString>;
       imageAssetId: z.ZodNullable<z.ZodString>;
       imageUrl: z.ZodNullable<z.ZodString>;
-      role: z.ZodEnum<{
-        owner: "owner";
-        admin: "admin";
-        instructor: "instructor";
-        moderator: "moderator";
-        student: "student";
-      }>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>;
     authorEmail: z.ZodEmail;
     removedBy: z.ZodNullable<z.ZodString>;
@@ -392,13 +347,8 @@ declare const CommentsPage: z.ZodObject<{
         image: z.ZodNullable<z.ZodString>;
         imageAssetId: z.ZodNullable<z.ZodString>;
         imageUrl: z.ZodNullable<z.ZodString>;
-        role: z.ZodEnum<{
-          owner: "owner";
-          admin: "admin";
-          instructor: "instructor";
-          moderator: "moderator";
-          student: "student";
-        }>;
+        team: z.ZodBoolean;
+        roleName: z.ZodNullable<z.ZodString>;
       }, z.core.$strict>;
       reason: z.ZodString;
       createdAt: z.ZodCoercedDate<unknown>;

package/dist/http/schemas/discussion.js

@@ -46,7 +46,7 @@ const PostComment = z.object({
 	parentId: idSchema.nullable().default(null).describe("The comment this replies to. Replies nest one level, under a root comment")
 }).strict();
 const EditComment = z.object({ body: z.string().min(1).max(1e4) }).strict();
-/** The staff PATCH writes status and nothing else: publishing covers approving
+/** The moderator's PATCH writes status and nothing else: publishing covers approving
 *  a pending comment and restoring a removed one. Revising the text is the
 *  author's own edit, under /api/member. */
 const PatchComment = z.object({ status: z.literal("published") });
@@ -68,7 +68,7 @@ const CommentReport = z.object({
 /** An unresolved report on a listed comment. Resolved ones are history and are
 *  never served here. */
 const CommentReportSummary = commentReportSummarySchema;
-/** One row of the staff comment list: the comment plus the context a
+/** One row of the moderation comment list: the comment plus the context a
 *  moderation decision needs, so the list needs no follow-up request. */
 const CommentListItem = commentListItemSchema;
 const CommentsQuery = ListQuery.extend({

package/dist/http/schemas/discussion.js.map

@@ -1 +1 @@
-{"version":3,"file":"discussion.js","names":[],"sources":["../../../src/http/schemas/discussion.ts"],"sourcesContent":["// Discussion resource schemas. Comments attach to an activity; settings are\n// per course, with a per-activity override carried on the activity's own\n// settings blob rather than a resource of its own.\n//\n// The author is the org user's profile minus its email — learners read each\n// other's comments and the list must not be a directory of the cohort's\n// addresses. The staff-facing comment list carries `authorEmail` separately.\nimport type { CommentSettings as DomainCommentSettings } from '@headless-lms/core/types';\nimport {\n  commentAuthorSchema,\n  commentListItemSchema,\n  commentReportSummarySchema,\n  commentSchema,\n  commentFlagResolutionSchema,\n  commentStatusSchema,\n  commentViewSchema,\n  idSchema,\n} from '@headless-lms/core/schemas';\nimport { z } from 'zod';\nimport { DateTimeInput, ListQuery, type Matches, paginated } from './shared.js';\n\nexport const CommentStatus = commentStatusSchema;\nexport type CommentStatus = z.infer<typeof CommentStatus>;\n\nexport const CommentAuthor = commentAuthorSchema;\nexport type CommentAuthor = z.infer<typeof CommentAuthor>;\n\n/** Any single emoji. Open, so widening the picker needs no schema change. */\nexport const ReactionEmoji = z.string().min(1).max(16);\nexport type ReactionEmoji = z.infer<typeof ReactionEmoji>;\n\n/** Counts by emoji; unused ones are absent, so no reactions serves `{}`. */\nexport const ReactionCounts = z.record(z.string(), z.number().int());\nexport type ReactionCounts = z.infer<typeof ReactionCounts>;\n\nconst Following = z\n  .object({ state: z.literal('following') })\n  .strict()\n  .describe('Follow the post: you are notified of its new comments');\nconst Muted = z\n  .object({\n    state: z.literal('muted'),\n    mutedUntil: DateTimeInput.nullable()\n      .optional()\n      .describe('When the mute ends. Omit or null to mute until you change it'),\n  })\n  .strict()\n  .describe('Mute it: its activity stops notifying you, except mentions and actions on you');\nconst Unsubscribed = z\n  .object({ state: z.literal('none') })\n  .strict()\n  .describe('Neither follow nor mute it');\n\nexport const SetPostSubscription = z.discriminatedUnion('state', [Following, Muted, Unsubscribed]);\nexport const SetMute = z.discriminatedUnion('state', [Muted, Unsubscribed]);\n\nexport const CommentView = commentViewSchema;\nexport type CommentView = z.infer<typeof CommentView>;\n\n/** What a reaction write on a post, message or comment returns, so the client never recomputes a count. */\nexport const Reactions = z.object({\n  reactions: ReactionCounts,\n  viewerReaction: ReactionEmoji.optional().describe('Absent when you have no reaction'),\n});\nexport type Reactions = z.infer<typeof Reactions>;\n\n/** A course's comment settings. Stored under the course, carried on the course\n *  payload as `settings.comments`. */\nexport const CommentSettings = z.object({\n  enabled: z.boolean(),\n  threaded: z.boolean(),\n  requireReview: z.boolean(),\n  reactions: z.boolean(),\n});\nexport type CommentSettings = z.infer<typeof CommentSettings>;\ntype _CommentSettingsMatchesDomain = Matches<DomainCommentSettings, CommentSettings> &\n  Matches<CommentSettings, DomainCommentSettings>;\n\n/** The course settings with the activity's override applied: `enabled` is the\n *  resolved answer for this activity, not the course switch. */\nexport const CommentsConfig = CommentSettings;\nexport type CommentsConfig = z.infer<typeof CommentsConfig>;\n\nexport const ActivityComments = z.object({\n  config: CommentsConfig,\n  comments: z.array(CommentView),\n});\nexport type ActivityComments = z.infer<typeof ActivityComments>;\n\nexport const PostComment = z\n  .object({\n    body: z.string().min(1).max(10_000),\n    parentId: idSchema\n      .nullable()\n      .default(null)\n      .describe('The comment this replies to. Replies nest one level, under a root comment'),\n  })\n  .strict();\nexport type PostComment = z.infer<typeof PostComment>;\n\nexport const EditComment = z.object({ body: z.string().min(1).max(10_000) }).strict();\nexport type EditComment = z.infer<typeof EditComment>;\n\n/** The staff PATCH writes status and nothing else: publishing covers approving\n *  a pending comment and restoring a removed one. Revising the text is the\n *  author's own edit, under /api/member. */\nexport const PatchComment = z.object({\n  status: z.literal('published'),\n});\nexport type PatchComment = z.infer<typeof PatchComment>;\n\n/** Replaces whatever the reader had. Clearing is DELETE, which carries no body. */\nexport const SetReaction = z\n  .object({ emoji: ReactionEmoji.describe('Replaces any reaction you already had') })\n  .strict();\nexport type SetReaction = z.infer<typeof SetReaction>;\n\nexport const ResolveCommentFlags = z\n  .object({\n    resolution: commentFlagResolutionSchema\n      .extract(['dismissed'])\n      .describe(\n        '`dismissed` closes the open flags and leaves the comment up. Removing the comment resolves its flags as `removed` instead.',\n      ),\n  })\n  .strict();\nexport type ResolveCommentFlags = z.infer<typeof ResolveCommentFlags>;\n\n/** A moderator's reply, posted from the queue against the comment it answers. */\nexport const ReplyToComment = z.object({\n  body: z.string().min(1).max(10_000),\n});\nexport type ReplyToComment = z.infer<typeof ReplyToComment>;\n\nexport const ReportComment = z.object({ reason: z.string().max(1_000).default('') }).strict();\nexport type ReportComment = z.infer<typeof ReportComment>;\n\nexport const Comment = commentSchema;\nexport type Comment = z.infer<typeof Comment>;\n\nexport const CommentReport = z.object({\n  id: z.string(),\n  commentId: z.string(),\n  orgUserId: z.string(),\n  reason: z.string(),\n  resolvedAt: z.date().nullable(),\n  createdAt: z.date(),\n});\nexport type CommentReport = z.infer<typeof CommentReport>;\n\n/** An unresolved report on a listed comment. Resolved ones are history and are\n *  never served here. */\nexport const CommentReportSummary = commentReportSummarySchema;\nexport type CommentReportSummary = z.infer<typeof CommentReportSummary>;\n\n/** One row of the staff comment list: the comment plus the context a\n *  moderation decision needs, so the list needs no follow-up request. */\nexport const CommentListItem = commentListItemSchema;\nexport type CommentListItem = z.infer<typeof CommentListItem>;\n\nexport const CommentsQuery = ListQuery.extend({\n  status: CommentStatus.optional(),\n  /** true = only comments carrying an unresolved report, false = only those\n   *  carrying none. `z.stringbool` because query values arrive as strings and\n   *  `z.coerce.boolean()` would read \"false\" as true. */\n  reported: z.stringbool().optional(),\n  courseId: z.string().optional(),\n  activityId: z.string().optional(),\n  /** Scope to one author (org_users.id). */\n  orgUserId: z.string().optional(),\n});\nexport type CommentsQuery = z.infer<typeof CommentsQuery>;\n\nexport const CommentsPage = paginated(CommentListItem);\nexport type CommentsPage = z.infer<typeof CommentsPage>;\n\nexport const DiscussionActivityParam = z.object({ activityId: z.string() });\nexport type DiscussionActivityParam = z.infer<typeof DiscussionActivityParam>;\n\nexport const CommentIdParam = z.object({ commentId: z.string() });\nexport type CommentIdParam = z.infer<typeof CommentIdParam>;\n"],"mappings":";;;;AAqBA,MAAa,gBAAgB;AAG7B,MAAa,gBAAgB;;AAI7B,MAAa,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE;;AAIrD,MAAa,iBAAiB,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;AAGnE,MAAM,YAAY,EACf,OAAO,EAAE,OAAO,EAAE,QAAQ,WAAW,EAAE,CAAC,CAAC,CACzC,OAAO,CAAC,CACR,SAAS,uDAAuD;AACnE,MAAM,QAAQ,EACX,OAAO;CACN,OAAO,EAAE,QAAQ,OAAO;CACxB,YAAY,cAAc,SAAS,CAAC,CACjC,SAAS,CAAC,CACV,SAAS,8DAA8D;AAC5E,CAAC,CAAC,CACD,OAAO,CAAC,CACR,SAAS,+EAA+E;AAC3F,MAAM,eAAe,EAClB,OAAO,EAAE,OAAO,EAAE,QAAQ,MAAM,EAAE,CAAC,CAAC,CACpC,OAAO,CAAC,CACR,SAAS,4BAA4B;AAExC,MAAa,sBAAsB,EAAE,mBAAmB,SAAS;CAAC;CAAW;CAAO;AAAY,CAAC;AACjG,MAAa,UAAU,EAAE,mBAAmB,SAAS,CAAC,OAAO,YAAY,CAAC;AAE1E,MAAa,cAAc;;AAI3B,MAAa,YAAY,EAAE,OAAO;CAChC,WAAW;CACX,gBAAgB,cAAc,SAAS,CAAC,CAAC,SAAS,kCAAkC;AACtF,CAAC;;;AAKD,MAAa,kBAAkB,EAAE,OAAO;CACtC,SAAS,EAAE,QAAQ;CACnB,UAAU,EAAE,QAAQ;CACpB,eAAe,EAAE,QAAQ;CACzB,WAAW,EAAE,QAAQ;AACvB,CAAC;;;AAOD,MAAa,iBAAiB;AAG9B,MAAa,mBAAmB,EAAE,OAAO;CACvC,QAAQ;CACR,UAAU,EAAE,MAAM,WAAW;AAC/B,CAAC;AAGD,MAAa,cAAc,EACxB,OAAO;CACN,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAM;CAClC,UAAU,SACP,SAAS,CAAC,CACV,QAAQ,IAAI,CAAC,CACb,SAAS,2EAA2E;AACzF,CAAC,CAAC,CACD,OAAO;AAGV,MAAa,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAM,EAAE,CAAC,CAAC,CAAC,OAAO;;;;AAMpF,MAAa,eAAe,EAAE,OAAO,EACnC,QAAQ,EAAE,QAAQ,WAAW,EAC/B,CAAC;;AAID,MAAa,cAAc,EACxB,OAAO,EAAE,OAAO,cAAc,SAAS,uCAAuC,EAAE,CAAC,CAAC,CAClF,OAAO;AAGV,MAAa,sBAAsB,EAChC,OAAO,EACN,YAAY,4BACT,QAAQ,CAAC,WAAW,CAAC,CAAC,CACtB,SACC,4HACF,EACJ,CAAC,CAAC,CACD,OAAO;;AAIV,MAAa,iBAAiB,EAAE,OAAO,EACrC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAM,EACpC,CAAC;AAGD,MAAa,gBAAgB,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,GAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO;AAG5F,MAAa,UAAU;AAGvB,MAAa,gBAAgB,EAAE,OAAO;CACpC,IAAI,EAAE,OAAO;CACb,WAAW,EAAE,OAAO;CACpB,WAAW,EAAE,OAAO;CACpB,QAAQ,EAAE,OAAO;CACjB,YAAY,EAAE,KAAK,CAAC,CAAC,SAAS;CAC9B,WAAW,EAAE,KAAK;AACpB,CAAC;;;AAKD,MAAa,uBAAuB;;;AAKpC,MAAa,kBAAkB;AAG/B,MAAa,gBAAgB,UAAU,OAAO;CAC5C,QAAQ,cAAc,SAAS;;;;CAI/B,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS;CAClC,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS;CAC9B,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS;;CAEhC,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;AACjC,CAAC;AAGD,MAAa,eAAe,UAAU,eAAe;AAGrD,MAAa,0BAA0B,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AAG1E,MAAa,iBAAiB,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"discussion.js","names":[],"sources":["../../../src/http/schemas/discussion.ts"],"sourcesContent":["// Discussion resource schemas. Comments attach to an activity; settings are\n// per course, with a per-activity override carried on the activity's own\n// settings blob rather than a resource of its own.\n//\n// The author is the org user's profile minus its email — learners read each\n// other's comments and the list must not be a directory of the cohort's\n// addresses. The staff-facing comment list carries `authorEmail` separately.\nimport type { CommentSettings as DomainCommentSettings } from '@headless-lms/core/types';\nimport {\n  commentAuthorSchema,\n  commentListItemSchema,\n  commentReportSummarySchema,\n  commentSchema,\n  commentFlagResolutionSchema,\n  commentStatusSchema,\n  commentViewSchema,\n  idSchema,\n} from '@headless-lms/core/schemas';\nimport { z } from 'zod';\nimport { DateTimeInput, ListQuery, type Matches, paginated } from './shared.js';\n\nexport const CommentStatus = commentStatusSchema;\nexport type CommentStatus = z.infer<typeof CommentStatus>;\n\nexport const CommentAuthor = commentAuthorSchema;\nexport type CommentAuthor = z.infer<typeof CommentAuthor>;\n\n/** Any single emoji. Open, so widening the picker needs no schema change. */\nexport const ReactionEmoji = z.string().min(1).max(16);\nexport type ReactionEmoji = z.infer<typeof ReactionEmoji>;\n\n/** Counts by emoji; unused ones are absent, so no reactions serves `{}`. */\nexport const ReactionCounts = z.record(z.string(), z.number().int());\nexport type ReactionCounts = z.infer<typeof ReactionCounts>;\n\nconst Following = z\n  .object({ state: z.literal('following') })\n  .strict()\n  .describe('Follow the post: you are notified of its new comments');\nconst Muted = z\n  .object({\n    state: z.literal('muted'),\n    mutedUntil: DateTimeInput.nullable()\n      .optional()\n      .describe('When the mute ends. Omit or null to mute until you change it'),\n  })\n  .strict()\n  .describe('Mute it: its activity stops notifying you, except mentions and actions on you');\nconst Unsubscribed = z\n  .object({ state: z.literal('none') })\n  .strict()\n  .describe('Neither follow nor mute it');\n\nexport const SetPostSubscription = z.discriminatedUnion('state', [Following, Muted, Unsubscribed]);\nexport const SetMute = z.discriminatedUnion('state', [Muted, Unsubscribed]);\n\nexport const CommentView = commentViewSchema;\nexport type CommentView = z.infer<typeof CommentView>;\n\n/** What a reaction write on a post, message or comment returns, so the client never recomputes a count. */\nexport const Reactions = z.object({\n  reactions: ReactionCounts,\n  viewerReaction: ReactionEmoji.optional().describe('Absent when you have no reaction'),\n});\nexport type Reactions = z.infer<typeof Reactions>;\n\n/** A course's comment settings. Stored under the course, carried on the course\n *  payload as `settings.comments`. */\nexport const CommentSettings = z.object({\n  enabled: z.boolean(),\n  threaded: z.boolean(),\n  requireReview: z.boolean(),\n  reactions: z.boolean(),\n});\nexport type CommentSettings = z.infer<typeof CommentSettings>;\ntype _CommentSettingsMatchesDomain = Matches<DomainCommentSettings, CommentSettings> &\n  Matches<CommentSettings, DomainCommentSettings>;\n\n/** The course settings with the activity's override applied: `enabled` is the\n *  resolved answer for this activity, not the course switch. */\nexport const CommentsConfig = CommentSettings;\nexport type CommentsConfig = z.infer<typeof CommentsConfig>;\n\nexport const ActivityComments = z.object({\n  config: CommentsConfig,\n  comments: z.array(CommentView),\n});\nexport type ActivityComments = z.infer<typeof ActivityComments>;\n\nexport const PostComment = z\n  .object({\n    body: z.string().min(1).max(10_000),\n    parentId: idSchema\n      .nullable()\n      .default(null)\n      .describe('The comment this replies to. Replies nest one level, under a root comment'),\n  })\n  .strict();\nexport type PostComment = z.infer<typeof PostComment>;\n\nexport const EditComment = z.object({ body: z.string().min(1).max(10_000) }).strict();\nexport type EditComment = z.infer<typeof EditComment>;\n\n/** The moderator's PATCH writes status and nothing else: publishing covers approving\n *  a pending comment and restoring a removed one. Revising the text is the\n *  author's own edit, under /api/member. */\nexport const PatchComment = z.object({\n  status: z.literal('published'),\n});\nexport type PatchComment = z.infer<typeof PatchComment>;\n\n/** Replaces whatever the reader had. Clearing is DELETE, which carries no body. */\nexport const SetReaction = z\n  .object({ emoji: ReactionEmoji.describe('Replaces any reaction you already had') })\n  .strict();\nexport type SetReaction = z.infer<typeof SetReaction>;\n\nexport const ResolveCommentFlags = z\n  .object({\n    resolution: commentFlagResolutionSchema\n      .extract(['dismissed'])\n      .describe(\n        '`dismissed` closes the open flags and leaves the comment up. Removing the comment resolves its flags as `removed` instead.',\n      ),\n  })\n  .strict();\nexport type ResolveCommentFlags = z.infer<typeof ResolveCommentFlags>;\n\n/** A moderator's reply, posted from the queue against the comment it answers. */\nexport const ReplyToComment = z.object({\n  body: z.string().min(1).max(10_000),\n});\nexport type ReplyToComment = z.infer<typeof ReplyToComment>;\n\nexport const ReportComment = z.object({ reason: z.string().max(1_000).default('') }).strict();\nexport type ReportComment = z.infer<typeof ReportComment>;\n\nexport const Comment = commentSchema;\nexport type Comment = z.infer<typeof Comment>;\n\nexport const CommentReport = z.object({\n  id: z.string(),\n  commentId: z.string(),\n  orgUserId: z.string(),\n  reason: z.string(),\n  resolvedAt: z.date().nullable(),\n  createdAt: z.date(),\n});\nexport type CommentReport = z.infer<typeof CommentReport>;\n\n/** An unresolved report on a listed comment. Resolved ones are history and are\n *  never served here. */\nexport const CommentReportSummary = commentReportSummarySchema;\nexport type CommentReportSummary = z.infer<typeof CommentReportSummary>;\n\n/** One row of the moderation comment list: the comment plus the context a\n *  moderation decision needs, so the list needs no follow-up request. */\nexport const CommentListItem = commentListItemSchema;\nexport type CommentListItem = z.infer<typeof CommentListItem>;\n\nexport const CommentsQuery = ListQuery.extend({\n  status: CommentStatus.optional(),\n  /** true = only comments carrying an unresolved report, false = only those\n   *  carrying none. `z.stringbool` because query values arrive as strings and\n   *  `z.coerce.boolean()` would read \"false\" as true. */\n  reported: z.stringbool().optional(),\n  courseId: z.string().optional(),\n  activityId: z.string().optional(),\n  /** Scope to one author (org_users.id). */\n  orgUserId: z.string().optional(),\n});\nexport type CommentsQuery = z.infer<typeof CommentsQuery>;\n\nexport const CommentsPage = paginated(CommentListItem);\nexport type CommentsPage = z.infer<typeof CommentsPage>;\n\nexport const DiscussionActivityParam = z.object({ activityId: z.string() });\nexport type DiscussionActivityParam = z.infer<typeof DiscussionActivityParam>;\n\nexport const CommentIdParam = z.object({ commentId: z.string() });\nexport type CommentIdParam = z.infer<typeof CommentIdParam>;\n"],"mappings":";;;;AAqBA,MAAa,gBAAgB;AAG7B,MAAa,gBAAgB;;AAI7B,MAAa,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE;;AAIrD,MAAa,iBAAiB,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;AAGnE,MAAM,YAAY,EACf,OAAO,EAAE,OAAO,EAAE,QAAQ,WAAW,EAAE,CAAC,CAAC,CACzC,OAAO,CAAC,CACR,SAAS,uDAAuD;AACnE,MAAM,QAAQ,EACX,OAAO;CACN,OAAO,EAAE,QAAQ,OAAO;CACxB,YAAY,cAAc,SAAS,CAAC,CACjC,SAAS,CAAC,CACV,SAAS,8DAA8D;AAC5E,CAAC,CAAC,CACD,OAAO,CAAC,CACR,SAAS,+EAA+E;AAC3F,MAAM,eAAe,EAClB,OAAO,EAAE,OAAO,EAAE,QAAQ,MAAM,EAAE,CAAC,CAAC,CACpC,OAAO,CAAC,CACR,SAAS,4BAA4B;AAExC,MAAa,sBAAsB,EAAE,mBAAmB,SAAS;CAAC;CAAW;CAAO;AAAY,CAAC;AACjG,MAAa,UAAU,EAAE,mBAAmB,SAAS,CAAC,OAAO,YAAY,CAAC;AAE1E,MAAa,cAAc;;AAI3B,MAAa,YAAY,EAAE,OAAO;CAChC,WAAW;CACX,gBAAgB,cAAc,SAAS,CAAC,CAAC,SAAS,kCAAkC;AACtF,CAAC;;;AAKD,MAAa,kBAAkB,EAAE,OAAO;CACtC,SAAS,EAAE,QAAQ;CACnB,UAAU,EAAE,QAAQ;CACpB,eAAe,EAAE,QAAQ;CACzB,WAAW,EAAE,QAAQ;AACvB,CAAC;;;AAOD,MAAa,iBAAiB;AAG9B,MAAa,mBAAmB,EAAE,OAAO;CACvC,QAAQ;CACR,UAAU,EAAE,MAAM,WAAW;AAC/B,CAAC;AAGD,MAAa,cAAc,EACxB,OAAO;CACN,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAM;CAClC,UAAU,SACP,SAAS,CAAC,CACV,QAAQ,IAAI,CAAC,CACb,SAAS,2EAA2E;AACzF,CAAC,CAAC,CACD,OAAO;AAGV,MAAa,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAM,EAAE,CAAC,CAAC,CAAC,OAAO;;;;AAMpF,MAAa,eAAe,EAAE,OAAO,EACnC,QAAQ,EAAE,QAAQ,WAAW,EAC/B,CAAC;;AAID,MAAa,cAAc,EACxB,OAAO,EAAE,OAAO,cAAc,SAAS,uCAAuC,EAAE,CAAC,CAAC,CAClF,OAAO;AAGV,MAAa,sBAAsB,EAChC,OAAO,EACN,YAAY,4BACT,QAAQ,CAAC,WAAW,CAAC,CAAC,CACtB,SACC,4HACF,EACJ,CAAC,CAAC,CACD,OAAO;;AAIV,MAAa,iBAAiB,EAAE,OAAO,EACrC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAM,EACpC,CAAC;AAGD,MAAa,gBAAgB,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,GAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO;AAG5F,MAAa,UAAU;AAGvB,MAAa,gBAAgB,EAAE,OAAO;CACpC,IAAI,EAAE,OAAO;CACb,WAAW,EAAE,OAAO;CACpB,WAAW,EAAE,OAAO;CACpB,QAAQ,EAAE,OAAO;CACjB,YAAY,EAAE,KAAK,CAAC,CAAC,SAAS;CAC9B,WAAW,EAAE,KAAK;AACpB,CAAC;;;AAKD,MAAa,uBAAuB;;;AAKpC,MAAa,kBAAkB;AAG/B,MAAa,gBAAgB,UAAU,OAAO;CAC5C,QAAQ,cAAc,SAAS;;;;CAI/B,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS;CAClC,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS;CAC9B,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS;;CAEhC,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;AACjC,CAAC;AAGD,MAAa,eAAe,UAAU,eAAe;AAGrD,MAAa,0BAA0B,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AAG1E,MAAa,iBAAiB,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC"}

package/dist/http/schemas/entitlements.d.ts

@@ -9,6 +9,7 @@ type EntitlementStatus = z.infer<typeof EntitlementStatus>;
 declare const ContentType: z.ZodEnum<{
   course: "course";
   download: "download";
+  event: "event";
 }>;
 type ContentType = z.infer<typeof ContentType>;
 /** Reference to the granted content: identity + display name (join-derived).
@@ -18,6 +19,7 @@ declare const ContentRef: z.ZodObject<{
   type: z.ZodEnum<{
     course: "course";
     download: "download";
+    event: "event";
   }>;
   title: z.ZodString;
 }, z.core.$strip>;
@@ -55,6 +57,7 @@ declare const EntitlementsQuery: z.ZodObject<{
   type: z.ZodOptional<z.ZodEnum<{
     course: "course";
     download: "download";
+    event: "event";
   }>>;
 }, z.core.$strip>;
 type EntitlementsQuery = z.infer<typeof EntitlementsQuery>;
@@ -88,18 +91,12 @@ declare const GrantEntitlement: z.ZodObject<{
   expiresAt: z.ZodNullable<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>;
 }, z.core.$strip>;
 type GrantEntitlement = z.infer<typeof GrantEntitlement>;
-/** Revoke/reinstate access by setting the active|revoked status. */
-declare const SetEntitlementStatus: z.ZodObject<{
-  status: z.ZodEnum<{
-    active: "active";
-    revoked: "revoked";
-  }>;
-}, z.core.$strip>;
-type SetEntitlementStatus = z.infer<typeof SetEntitlementStatus>;
-declare const EntitlementIdParam: z.ZodObject<{
-  id: z.ZodString;
+declare const RevokeEntitlement: z.ZodObject<{
+  orgUserId: z.ZodString;
+  contentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  bundleId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
-type EntitlementIdParam = z.infer<typeof EntitlementIdParam>;
+type RevokeEntitlement = z.infer<typeof RevokeEntitlement>;
 //#endregion
-export { ContentRef, ContentType, Entitlement, EntitlementIdParam, EntitlementStatus, EntitlementsPage, EntitlementsQuery, GrantEntitlement, SetEntitlementStatus };
+export { ContentRef, ContentType, Entitlement, EntitlementStatus, EntitlementsPage, EntitlementsQuery, GrantEntitlement, RevokeEntitlement };
 //# sourceMappingURL=entitlements.d.ts.map

package/dist/http/schemas/entitlements.js

@@ -7,7 +7,11 @@ const EntitlementStatus = z.enum([
 	"expired",
 	"revoked"
 ]);
-const ContentType = z.enum(["course", "download"]);
+const ContentType = z.enum([
+	"course",
+	"download",
+	"event"
+]);
 /** Reference to the granted content: identity + display name (join-derived).
 *  The full content object lives on its own resource. */
 const ContentRef = z.object({
@@ -34,10 +38,12 @@ const GrantEntitlement = z.object({
 	bundleId: idSchema.nullish(),
 	expiresAt: DateTimeInput.nullable().describe("When access ends; null never expires")
 }).refine((v) => v.contentId != null !== (v.bundleId != null), { message: "Provide exactly one of contentId or bundleId" });
-/** Revoke/reinstate access by setting the active|revoked status. */
-const SetEntitlementStatus = z.object({ status: z.enum(["active", "revoked"]) });
-const EntitlementIdParam = z.object({ id: z.string() });
+const RevokeEntitlement = z.object({
+	orgUserId: idSchema,
+	contentId: idSchema.nullish(),
+	bundleId: idSchema.nullish()
+}).refine((v) => v.contentId != null !== (v.bundleId != null), { message: "Provide exactly one of contentId or bundleId" });
 //#endregion
-export { ContentRef, ContentType, Entitlement, EntitlementIdParam, EntitlementStatus, EntitlementsPage, EntitlementsQuery, GrantEntitlement, SetEntitlementStatus };
+export { ContentRef, ContentType, Entitlement, EntitlementStatus, EntitlementsPage, EntitlementsQuery, GrantEntitlement, RevokeEntitlement };
 
 //# sourceMappingURL=entitlements.js.map

package/dist/http/schemas/entitlements.js.map

@@ -1 +1 @@
-{"version":3,"file":"entitlements.js","names":[],"sources":["../../../src/http/schemas/entitlements.ts"],"sourcesContent":["// Entitlements resource schemas. An entitlement is a student's access grant to\n// a piece of content — generic over content types (course today) — its\n// validity + source. Distinct from payment and from completion.\nimport { z } from 'zod';\nimport { entitlementSchema, idSchema } from '@headless-lms/core/schemas';\nimport { DateTimeInput, ListQuery, paginated } from './shared.js';\n\nexport const EntitlementStatus = z.enum(['active', 'expired', 'revoked']);\nexport type EntitlementStatus = z.infer<typeof EntitlementStatus>;\n\nexport const ContentType = z.enum(['course', 'download']);\nexport type ContentType = z.infer<typeof ContentType>;\n\n/** Reference to the granted content: identity + display name (join-derived).\n *  The full content object lives on its own resource. */\nexport const ContentRef = z.object({\n  id: z.string(),\n  type: ContentType,\n  title: z.string(),\n});\nexport type ContentRef = z.infer<typeof ContentRef>;\n\nexport const Entitlement = entitlementSchema;\nexport type Entitlement = z.infer<typeof Entitlement>;\n\nexport const EntitlementsQuery = ListQuery.extend({\n  status: EntitlementStatus.optional(),\n  source: z.string().optional(),\n  /** Scope to a single student (used by the student detail view). */\n  orgUserId: z.string().optional(),\n  /** Scope to a single piece of content. */\n  contentId: z.string().optional(),\n  /** Scope to one content type. */\n  type: ContentType.optional(),\n});\nexport type EntitlementsQuery = z.infer<typeof EntitlementsQuery>;\n\nexport const EntitlementsPage = paginated(Entitlement);\nexport type EntitlementsPage = z.infer<typeof EntitlementsPage>;\n\n/** A grant targets exactly one of: a single content item or a bundle. */\nexport const GrantEntitlement = z\n  .object({\n    orgUserId: idSchema,\n    contentId: idSchema.nullish(),\n    bundleId: idSchema.nullish(),\n    expiresAt: DateTimeInput.nullable().describe('When access ends; null never expires'),\n  })\n  .refine((v) => (v.contentId != null) !== (v.bundleId != null), {\n    message: 'Provide exactly one of contentId or bundleId',\n  });\nexport type GrantEntitlement = z.infer<typeof GrantEntitlement>;\n\n/** Revoke/reinstate access by setting the active|revoked status. */\nexport const SetEntitlementStatus = z.object({\n  status: z.enum(['active', 'revoked']),\n});\nexport type SetEntitlementStatus = z.infer<typeof SetEntitlementStatus>;\n\nexport const EntitlementIdParam = z.object({ id: z.string() });\nexport type EntitlementIdParam = z.infer<typeof EntitlementIdParam>;\n"],"mappings":";;;;AAOA,MAAa,oBAAoB,EAAE,KAAK;CAAC;CAAU;CAAW;AAAS,CAAC;AAGxE,MAAa,cAAc,EAAE,KAAK,CAAC,UAAU,UAAU,CAAC;;;AAKxD,MAAa,aAAa,EAAE,OAAO;CACjC,IAAI,EAAE,OAAO;CACb,MAAM;CACN,OAAO,EAAE,OAAO;AAClB,CAAC;AAGD,MAAa,cAAc;AAG3B,MAAa,oBAAoB,UAAU,OAAO;CAChD,QAAQ,kBAAkB,SAAS;CACnC,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS;;CAE5B,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;;CAE/B,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;;CAE/B,MAAM,YAAY,SAAS;AAC7B,CAAC;AAGD,MAAa,mBAAmB,UAAU,WAAW;;AAIrD,MAAa,mBAAmB,EAC7B,OAAO;CACN,WAAW;CACX,WAAW,SAAS,QAAQ;CAC5B,UAAU,SAAS,QAAQ;CAC3B,WAAW,cAAc,SAAS,CAAC,CAAC,SAAS,sCAAsC;AACrF,CAAC,CAAC,CACD,QAAQ,MAAO,EAAE,aAAa,UAAW,EAAE,YAAY,OAAO,EAC7D,SAAS,+CACX,CAAC;;AAIH,MAAa,uBAAuB,EAAE,OAAO,EAC3C,QAAQ,EAAE,KAAK,CAAC,UAAU,SAAS,CAAC,EACtC,CAAC;AAGD,MAAa,qBAAqB,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"entitlements.js","names":[],"sources":["../../../src/http/schemas/entitlements.ts"],"sourcesContent":["// Entitlements resource schemas. An entitlement is a student's access grant to\n// a piece of content — generic over content types (course today) — its\n// validity + source. Distinct from payment and from completion.\nimport { z } from 'zod';\nimport { entitlementSchema, idSchema } from '@headless-lms/core/schemas';\nimport { DateTimeInput, ListQuery, paginated } from './shared.js';\n\nexport const EntitlementStatus = z.enum(['active', 'expired', 'revoked']);\nexport type EntitlementStatus = z.infer<typeof EntitlementStatus>;\n\nexport const ContentType = z.enum(['course', 'download', 'event']);\nexport type ContentType = z.infer<typeof ContentType>;\n\n/** Reference to the granted content: identity + display name (join-derived).\n *  The full content object lives on its own resource. */\nexport const ContentRef = z.object({\n  id: z.string(),\n  type: ContentType,\n  title: z.string(),\n});\nexport type ContentRef = z.infer<typeof ContentRef>;\n\nexport const Entitlement = entitlementSchema;\nexport type Entitlement = z.infer<typeof Entitlement>;\n\nexport const EntitlementsQuery = ListQuery.extend({\n  status: EntitlementStatus.optional(),\n  source: z.string().optional(),\n  /** Scope to a single student (used by the student detail view). */\n  orgUserId: z.string().optional(),\n  /** Scope to a single piece of content. */\n  contentId: z.string().optional(),\n  /** Scope to one content type. */\n  type: ContentType.optional(),\n});\nexport type EntitlementsQuery = z.infer<typeof EntitlementsQuery>;\n\nexport const EntitlementsPage = paginated(Entitlement);\nexport type EntitlementsPage = z.infer<typeof EntitlementsPage>;\n\n/** A grant targets exactly one of: a single content item or a bundle. */\nexport const GrantEntitlement = z\n  .object({\n    orgUserId: idSchema,\n    contentId: idSchema.nullish(),\n    bundleId: idSchema.nullish(),\n    expiresAt: DateTimeInput.nullable().describe('When access ends; null never expires'),\n  })\n  .refine((v) => (v.contentId != null) !== (v.bundleId != null), {\n    message: 'Provide exactly one of contentId or bundleId',\n  });\nexport type GrantEntitlement = z.infer<typeof GrantEntitlement>;\n\nexport const RevokeEntitlement = z\n  .object({\n    orgUserId: idSchema,\n    contentId: idSchema.nullish(),\n    bundleId: idSchema.nullish(),\n  })\n  .refine((v) => (v.contentId != null) !== (v.bundleId != null), {\n    message: 'Provide exactly one of contentId or bundleId',\n  });\nexport type RevokeEntitlement = z.infer<typeof RevokeEntitlement>;\n"],"mappings":";;;;AAOA,MAAa,oBAAoB,EAAE,KAAK;CAAC;CAAU;CAAW;AAAS,CAAC;AAGxE,MAAa,cAAc,EAAE,KAAK;CAAC;CAAU;CAAY;AAAO,CAAC;;;AAKjE,MAAa,aAAa,EAAE,OAAO;CACjC,IAAI,EAAE,OAAO;CACb,MAAM;CACN,OAAO,EAAE,OAAO;AAClB,CAAC;AAGD,MAAa,cAAc;AAG3B,MAAa,oBAAoB,UAAU,OAAO;CAChD,QAAQ,kBAAkB,SAAS;CACnC,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS;;CAE5B,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;;CAE/B,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;;CAE/B,MAAM,YAAY,SAAS;AAC7B,CAAC;AAGD,MAAa,mBAAmB,UAAU,WAAW;;AAIrD,MAAa,mBAAmB,EAC7B,OAAO;CACN,WAAW;CACX,WAAW,SAAS,QAAQ;CAC5B,UAAU,SAAS,QAAQ;CAC3B,WAAW,cAAc,SAAS,CAAC,CAAC,SAAS,sCAAsC;AACrF,CAAC,CAAC,CACD,QAAQ,MAAO,EAAE,aAAa,UAAW,EAAE,YAAY,OAAO,EAC7D,SAAS,+CACX,CAAC;AAGH,MAAa,oBAAoB,EAC9B,OAAO;CACN,WAAW;CACX,WAAW,SAAS,QAAQ;CAC5B,UAAU,SAAS,QAAQ;AAC7B,CAAC,CAAC,CACD,QAAQ,MAAO,EAAE,aAAa,UAAW,EAAE,YAAY,OAAO,EAC7D,SAAS,+CACX,CAAC"}