@headless-lms/server 0.1.0 → 0.3.0

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

@@ -0,0 +1,537 @@
+import { z } from "zod";
+//#region src/http/schemas/community.d.ts
+declare const Community: z.ZodObject<{
+  orgId: z.ZodString;
+  id: z.ZodString;
+  type: z.ZodLiteral<"community">;
+  title: z.ZodString;
+  slug: z.ZodString;
+  description: z.ZodString;
+  status: z.ZodEnum<{
+    draft: "draft";
+    published: "published";
+  }>;
+  thumbnailAssetId: z.ZodNullable<z.ZodString>;
+  settings: z.ZodObject<{
+    dm: z.ZodObject<{
+      enabled: z.ZodBoolean;
+      memberToMember: z.ZodBoolean;
+      memberToStaff: z.ZodBoolean;
+      staffToAnyone: z.ZodBoolean;
+      firstMessageIsRequest: z.ZodBoolean;
+      groupChats: z.ZodBoolean;
+      groupSize: z.ZodNumber;
+    }, z.core.$strict>;
+  }, z.core.$strict>;
+  createdAt: z.ZodCoercedDate<unknown>;
+  updatedAt: z.ZodCoercedDate<unknown>;
+  thumbnailUrl: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+declare const CommunitiesQuery: z.ZodObject<{
+  page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  search: z.ZodOptional<z.ZodString>;
+  sort: z.ZodOptional<z.ZodString>;
+  status: z.ZodOptional<z.ZodEnum<{
+    draft: "draft";
+    published: "published";
+  }>>;
+}, z.core.$strip>;
+declare const CommunitiesPage: z.ZodObject<{
+  rows: z.ZodArray<z.ZodObject<{
+    orgId: z.ZodString;
+    id: z.ZodString;
+    type: z.ZodLiteral<"community">;
+    title: z.ZodString;
+    slug: z.ZodString;
+    description: z.ZodString;
+    status: z.ZodEnum<{
+      draft: "draft";
+      published: "published";
+    }>;
+    thumbnailAssetId: z.ZodNullable<z.ZodString>;
+    settings: z.ZodObject<{
+      dm: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        memberToMember: z.ZodBoolean;
+        memberToStaff: z.ZodBoolean;
+        staffToAnyone: z.ZodBoolean;
+        firstMessageIsRequest: z.ZodBoolean;
+        groupChats: z.ZodBoolean;
+        groupSize: z.ZodNumber;
+      }, z.core.$strict>;
+    }, z.core.$strict>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+    thumbnailUrl: z.ZodNullable<z.ZodString>;
+  }, z.core.$strict>>;
+  total: z.ZodNumber;
+  page: z.ZodNumber;
+  pageSize: z.ZodNumber;
+}, z.core.$strip>;
+declare const CreateCommunity: z.ZodObject<{
+  title: z.ZodString;
+  description: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+declare const UpdateCommunity: z.ZodObject<{
+  title: z.ZodOptional<z.ZodString>;
+  description: z.ZodOptional<z.ZodString>;
+  status: z.ZodOptional<z.ZodEnum<{
+    draft: "draft";
+    published: "published";
+  }>>;
+  thumbnailAssetId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+declare const PatchDmSettings: z.ZodObject<{
+  enabled: z.ZodOptional<z.ZodBoolean>;
+  memberToMember: z.ZodOptional<z.ZodBoolean>;
+  memberToStaff: z.ZodOptional<z.ZodBoolean>;
+  staffToAnyone: z.ZodOptional<z.ZodBoolean>;
+  firstMessageIsRequest: z.ZodOptional<z.ZodBoolean>;
+  groupChats: z.ZodOptional<z.ZodBoolean>;
+  groupSize: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+declare const DmSettings: z.ZodObject<{
+  enabled: z.ZodBoolean;
+  memberToMember: z.ZodBoolean;
+  memberToStaff: z.ZodBoolean;
+  staffToAnyone: z.ZodBoolean;
+  firstMessageIsRequest: z.ZodBoolean;
+  groupChats: z.ZodBoolean;
+  groupSize: z.ZodNumber;
+}, z.core.$strict>;
+declare const SpaceDetail: z.ZodObject<{
+  orgId: z.ZodString;
+  id: z.ZodString;
+  communityId: z.ZodString;
+  name: z.ZodString;
+  description: z.ZodString;
+  seq: z.ZodNumber;
+  accessRule: z.ZodEnum<{
+    all_members: "all_members";
+    by_request: "by_request";
+    by_invite: "by_invite";
+  }>;
+  capacity: z.ZodNullable<z.ZodNumber>;
+  settings: z.ZodObject<{
+    comments: z.ZodBoolean;
+    reactions: z.ZodBoolean;
+    requireReview: z.ZodBoolean;
+  }, z.core.$strict>;
+  createdAt: z.ZodCoercedDate<unknown>;
+  updatedAt: z.ZodCoercedDate<unknown>;
+  topics: z.ZodArray<z.ZodObject<{
+    orgId: z.ZodString;
+    id: z.ZodString;
+    spaceId: z.ZodString;
+    name: z.ZodString;
+    seq: z.ZodNumber;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+  }, z.core.$strict>>;
+  links: z.ZodArray<z.ZodObject<{
+    orgId: z.ZodString;
+    id: z.ZodString;
+    spaceId: z.ZodString;
+    contentId: z.ZodString;
+    seq: z.ZodNumber;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+  }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const SpaceMember: z.ZodObject<{
+  orgId: z.ZodString;
+  id: z.ZodString;
+  communityId: z.ZodString;
+  spaceId: z.ZodString;
+  orgUserId: z.ZodString;
+  status: z.ZodEnum<{
+    requested: "requested";
+    invited: "invited";
+    active: "active";
+    revoked: "revoked";
+  }>;
+  source: z.ZodEnum<{
+    request: "request";
+    invite: "invite";
+    manual: "manual";
+  }>;
+  createdAt: z.ZodCoercedDate<unknown>;
+  updatedAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strict>;
+declare const SpaceMembersPage: z.ZodObject<{
+  rows: z.ZodArray<z.ZodObject<{
+    orgId: z.ZodString;
+    id: z.ZodString;
+    communityId: z.ZodString;
+    spaceId: z.ZodString;
+    orgUserId: z.ZodString;
+    status: z.ZodEnum<{
+      requested: "requested";
+      invited: "invited";
+      active: "active";
+      revoked: "revoked";
+    }>;
+    source: z.ZodEnum<{
+      request: "request";
+      invite: "invite";
+      manual: "manual";
+    }>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+  }, z.core.$strict>>;
+  total: z.ZodNumber;
+  page: z.ZodNumber;
+  pageSize: z.ZodNumber;
+}, z.core.$strip>;
+declare const CreateSpace: z.ZodObject<{
+  name: z.ZodString;
+  description: z.ZodOptional<z.ZodString>;
+  accessRule: z.ZodOptional<z.ZodEnum<{
+    all_members: "all_members";
+    by_request: "by_request";
+    by_invite: "by_invite";
+  }>>;
+  capacity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  settings: z.ZodOptional<z.ZodObject<{
+    comments: z.ZodOptional<z.ZodBoolean>;
+    reactions: z.ZodOptional<z.ZodBoolean>;
+    requireReview: z.ZodOptional<z.ZodBoolean>;
+  }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const UpdateSpace: z.ZodObject<{
+  name: z.ZodOptional<z.ZodString>;
+  description: z.ZodOptional<z.ZodString>;
+  accessRule: z.ZodOptional<z.ZodEnum<{
+    all_members: "all_members";
+    by_request: "by_request";
+    by_invite: "by_invite";
+  }>>;
+  capacity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  settings: z.ZodOptional<z.ZodObject<{
+    comments: z.ZodOptional<z.ZodBoolean>;
+    reactions: z.ZodOptional<z.ZodBoolean>;
+    requireReview: z.ZodOptional<z.ZodBoolean>;
+  }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const SetSpaceTopics: z.ZodObject<{
+  topics: z.ZodArray<z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+  }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const OrderedIds: z.ZodObject<{
+  ids: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+declare const SpaceLinkBody: z.ZodObject<{
+  contentId: z.ZodString;
+}, z.core.$strict>;
+declare const CommunityIdParam: z.ZodObject<{
+  communityId: z.ZodString;
+}, z.core.$strip>;
+declare const CommunitySpaceParam: z.ZodObject<{
+  communityId: z.ZodString;
+  spaceId: z.ZodString;
+}, z.core.$strip>;
+declare const SpaceLinkParam: z.ZodObject<{
+  communityId: z.ZodString;
+  spaceId: z.ZodString;
+  linkId: z.ZodString;
+}, z.core.$strip>;
+declare const SpaceMemberParam: z.ZodObject<{
+  communityId: z.ZodString;
+  spaceId: z.ZodString;
+  orgUserId: z.ZodString;
+}, z.core.$strip>;
+declare const CommunityPostParam: z.ZodObject<{
+  communityId: z.ZodString;
+  postId: z.ZodString;
+}, z.core.$strip>;
+declare const CommunityCommentParam: z.ZodObject<{
+  communityId: z.ZodString;
+  commentId: z.ZodString;
+}, z.core.$strip>;
+declare const CommunityMessageParam: z.ZodObject<{
+  communityId: z.ZodString;
+  messageId: z.ZodString;
+}, z.core.$strip>;
+declare const CommunityChatParam: z.ZodObject<{
+  communityId: z.ZodString;
+  chatId: z.ZodString;
+}, z.core.$strip>;
+declare const CommunityMember: z.ZodObject<{
+  id: z.ZodString;
+  firstName: z.ZodNullable<z.ZodString>;
+  lastName: z.ZodNullable<z.ZodString>;
+  email: z.ZodString;
+  image: z.ZodNullable<z.ZodString>;
+  role: z.ZodEnum<{
+    owner: "owner";
+    admin: "admin";
+    instructor: "instructor";
+    moderator: "moderator";
+    student: "student";
+  }>;
+}, z.core.$strip>;
+declare const CommunityMembersQuery: z.ZodObject<{
+  page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  search: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+declare const CommunityMembersPage: z.ZodObject<{
+  rows: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodNullable<z.ZodString>;
+    lastName: z.ZodNullable<z.ZodString>;
+    email: z.ZodString;
+    image: z.ZodNullable<z.ZodString>;
+    role: z.ZodEnum<{
+      owner: "owner";
+      admin: "admin";
+      instructor: "instructor";
+      moderator: "moderator";
+      student: "student";
+    }>;
+  }, z.core.$strip>>;
+  total: z.ZodNumber;
+  page: z.ZodNumber;
+  pageSize: z.ZodNumber;
+}, z.core.$strip>;
+declare const DirectoryEntry: z.ZodObject<{
+  orgUserId: z.ZodString;
+  role: z.ZodString;
+  displayName: z.ZodNullable<z.ZodString>;
+  headline: z.ZodNullable<z.ZodString>;
+  bio: z.ZodNullable<z.ZodString>;
+  imageAssetId: z.ZodNullable<z.ZodString>;
+  imageUrl: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+declare const DirectoryQuery: z.ZodObject<{
+  page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  search: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+declare const DirectoryPage: z.ZodObject<{
+  rows: z.ZodArray<z.ZodObject<{
+    orgUserId: z.ZodString;
+    role: z.ZodString;
+    displayName: z.ZodNullable<z.ZodString>;
+    headline: z.ZodNullable<z.ZodString>;
+    bio: z.ZodNullable<z.ZodString>;
+    imageAssetId: z.ZodNullable<z.ZodString>;
+    imageUrl: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>>;
+  total: z.ZodNumber;
+  page: z.ZodNumber;
+  pageSize: z.ZodNumber;
+}, z.core.$strip>;
+declare const LockedCommunitySpace: z.ZodObject<{
+  id: z.ZodString;
+  name: z.ZodString;
+  memberCount: z.ZodNumber;
+  accessRule: z.ZodEnum<{
+    all_members: "all_members";
+    by_request: "by_request";
+    by_invite: "by_invite";
+  }>;
+  standing: z.ZodEnum<{
+    open: "open";
+    member: "member";
+    requested: "requested";
+    invited: "invited";
+    full: "full";
+    none: "none";
+  }>;
+  locked: z.ZodLiteral<true>;
+}, z.core.$strip>;
+declare const OpenCommunitySpace: z.ZodObject<{
+  id: z.ZodString;
+  name: z.ZodString;
+  memberCount: z.ZodNumber;
+  accessRule: z.ZodEnum<{
+    all_members: "all_members";
+    by_request: "by_request";
+    by_invite: "by_invite";
+  }>;
+  standing: z.ZodEnum<{
+    open: "open";
+    member: "member";
+    requested: "requested";
+    invited: "invited";
+    full: "full";
+    none: "none";
+  }>;
+  locked: z.ZodLiteral<false>;
+  description: z.ZodNullable<z.ZodString>;
+  capacity: z.ZodNullable<z.ZodNumber>;
+  settings: z.ZodObject<{
+    comments: z.ZodBoolean;
+    reactions: z.ZodBoolean;
+    requireReview: z.ZodBoolean;
+  }, z.core.$strip>;
+  topics: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+  }, z.core.$strip>>;
+  links: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    contentId: z.ZodString;
+    type: z.ZodEnum<{
+      community: "community";
+      course: "course";
+      download: "download";
+    }>;
+    title: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const CommunityHomeSpace: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  id: z.ZodString;
+  name: z.ZodString;
+  memberCount: z.ZodNumber;
+  accessRule: z.ZodEnum<{
+    all_members: "all_members";
+    by_request: "by_request";
+    by_invite: "by_invite";
+  }>;
+  standing: z.ZodEnum<{
+    open: "open";
+    member: "member";
+    requested: "requested";
+    invited: "invited";
+    full: "full";
+    none: "none";
+  }>;
+  locked: z.ZodLiteral<true>;
+}, z.core.$strip>, z.ZodObject<{
+  id: z.ZodString;
+  name: z.ZodString;
+  memberCount: z.ZodNumber;
+  accessRule: z.ZodEnum<{
+    all_members: "all_members";
+    by_request: "by_request";
+    by_invite: "by_invite";
+  }>;
+  standing: z.ZodEnum<{
+    open: "open";
+    member: "member";
+    requested: "requested";
+    invited: "invited";
+    full: "full";
+    none: "none";
+  }>;
+  locked: z.ZodLiteral<false>;
+  description: z.ZodNullable<z.ZodString>;
+  capacity: z.ZodNullable<z.ZodNumber>;
+  settings: z.ZodObject<{
+    comments: z.ZodBoolean;
+    reactions: z.ZodBoolean;
+    requireReview: z.ZodBoolean;
+  }, z.core.$strip>;
+  topics: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+  }, z.core.$strip>>;
+  links: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    contentId: z.ZodString;
+    type: z.ZodEnum<{
+      community: "community";
+      course: "course";
+      download: "download";
+    }>;
+    title: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>], "locked">;
+declare const CommunityHome: z.ZodObject<{
+  communityId: z.ZodString;
+  title: z.ZodString;
+  description: z.ZodString;
+  thumbnailUrl: z.ZodNullable<z.ZodString>;
+  dm: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    memberToMember: z.ZodBoolean;
+    memberToStaff: z.ZodBoolean;
+    staffToAnyone: z.ZodBoolean;
+    firstMessageIsRequest: z.ZodBoolean;
+    groupChats: z.ZodBoolean;
+    groupSize: z.ZodNumber;
+  }, z.core.$strict>;
+  spaces: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    memberCount: z.ZodNumber;
+    accessRule: z.ZodEnum<{
+      all_members: "all_members";
+      by_request: "by_request";
+      by_invite: "by_invite";
+    }>;
+    standing: z.ZodEnum<{
+      open: "open";
+      member: "member";
+      requested: "requested";
+      invited: "invited";
+      full: "full";
+      none: "none";
+    }>;
+    locked: z.ZodLiteral<true>;
+  }, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    memberCount: z.ZodNumber;
+    accessRule: z.ZodEnum<{
+      all_members: "all_members";
+      by_request: "by_request";
+      by_invite: "by_invite";
+    }>;
+    standing: z.ZodEnum<{
+      open: "open";
+      member: "member";
+      requested: "requested";
+      invited: "invited";
+      full: "full";
+      none: "none";
+    }>;
+    locked: z.ZodLiteral<false>;
+    description: z.ZodNullable<z.ZodString>;
+    capacity: z.ZodNullable<z.ZodNumber>;
+    settings: z.ZodObject<{
+      comments: z.ZodBoolean;
+      reactions: z.ZodBoolean;
+      requireReview: z.ZodBoolean;
+    }, z.core.$strip>;
+    topics: z.ZodArray<z.ZodObject<{
+      id: z.ZodString;
+      name: z.ZodString;
+    }, z.core.$strip>>;
+    links: z.ZodArray<z.ZodObject<{
+      id: z.ZodString;
+      contentId: z.ZodString;
+      type: z.ZodEnum<{
+        community: "community";
+        course: "course";
+        download: "download";
+      }>;
+      title: z.ZodString;
+    }, z.core.$strip>>;
+  }, z.core.$strip>], "locked">>;
+}, z.core.$strip>;
+declare const CommunityAnalytics: z.ZodObject<{
+  memberCount: z.ZodNumber;
+  activeMembers: z.ZodNumber;
+  postsPerSpace: z.ZodArray<z.ZodObject<{
+    spaceId: z.ZodString;
+    count: z.ZodNumber;
+  }, z.core.$strip>>;
+  commentsPerPost: z.ZodArray<z.ZodObject<{
+    postId: z.ZodString;
+    count: z.ZodNumber;
+  }, z.core.$strip>>;
+  messagesSent: z.ZodNumber;
+  flagsRaised: z.ZodNumber;
+  flagsResolved: z.ZodNumber;
+  grantsLapsed: z.ZodNumber;
+  grantsRenewed: z.ZodNumber;
+}, z.core.$strip>;
+//#endregion
+export { CommunitiesPage, CommunitiesQuery, Community, CommunityAnalytics, CommunityChatParam, CommunityCommentParam, CommunityHome, CommunityHomeSpace, CommunityIdParam, CommunityMember, CommunityMembersPage, CommunityMembersQuery, CommunityMessageParam, CommunityPostParam, CommunitySpaceParam, CreateCommunity, CreateSpace, DirectoryEntry, DirectoryPage, DirectoryQuery, DmSettings, LockedCommunitySpace, OpenCommunitySpace, OrderedIds, PatchDmSettings, SetSpaceTopics, SpaceDetail, SpaceLinkBody, SpaceLinkParam, SpaceMember, SpaceMemberParam, SpaceMembersPage, UpdateCommunity, UpdateSpace };
+//# sourceMappingURL=community.d.ts.map

package/dist/http/schemas/community.js

@@ -0,0 +1,129 @@
+import { ListQuery, OrgUserProfileSchema, PageQuery, paginated } from "./shared.js";
+import { z } from "zod";
+import { communityStatusSchema, communityViewSchema, createCommunityInputSchema, createSpaceInputSchema, dmSettingsSchema, idSchema, patchDmSettingsInputSchema, roleSchema, setSpaceTopicsInputSchema, spaceDetailSchema, spaceMemberSchema, updateCommunityInputSchema, updateSpaceInputSchema } from "@headless-lms/core/schemas";
+//#region src/http/schemas/community.ts
+const Community = communityViewSchema;
+const CommunitiesQuery = ListQuery.extend({ status: communityStatusSchema.optional() });
+const CommunitiesPage = paginated(Community);
+const CreateCommunity = createCommunityInputSchema;
+const UpdateCommunity = updateCommunityInputSchema;
+const PatchDmSettings = patchDmSettingsInputSchema;
+const DmSettings = dmSettingsSchema;
+const SpaceDetail = spaceDetailSchema;
+const SpaceMember = spaceMemberSchema;
+const SpaceMembersPage = paginated(SpaceMember);
+const CreateSpace = createSpaceInputSchema;
+const UpdateSpace = updateSpaceInputSchema;
+const SetSpaceTopics = setSpaceTopicsInputSchema;
+const OrderedIds = z.object({ ids: z.array(idSchema).min(1).max(200).describe("Every id in the collection, once each, in the new order") }).strict();
+const SpaceLinkBody = z.object({ contentId: idSchema.describe("The course, download or community to link") }).strict();
+const CommunityIdParam = z.object({ communityId: z.string() });
+const CommunitySpaceParam = z.object({
+	communityId: z.string(),
+	spaceId: z.string()
+});
+const SpaceLinkParam = CommunitySpaceParam.extend({ linkId: z.string() });
+const SpaceMemberParam = CommunitySpaceParam.extend({ orgUserId: z.string() });
+const CommunityPostParam = z.object({
+	communityId: z.string(),
+	postId: z.string()
+});
+const CommunityCommentParam = z.object({
+	communityId: z.string(),
+	commentId: z.string()
+});
+const CommunityMessageParam = z.object({
+	communityId: z.string(),
+	messageId: z.string()
+});
+const CommunityChatParam = z.object({
+	communityId: z.string(),
+	chatId: z.string()
+});
+const CommunityMember = OrgUserProfileSchema.extend({ role: roleSchema });
+const CommunityMembersQuery = PageQuery.extend({ search: z.string().trim().optional() });
+const CommunityMembersPage = paginated(CommunityMember);
+const DirectoryEntry = z.object({
+	orgUserId: z.string(),
+	role: z.string(),
+	displayName: z.string().nullable(),
+	headline: z.string().nullable(),
+	bio: z.string().nullable(),
+	imageAssetId: z.string().nullable(),
+	imageUrl: z.string().nullable()
+});
+const DirectoryQuery = PageQuery.extend({ search: z.string().trim().max(100).optional().describe("Matches part of a display name") });
+const DirectoryPage = paginated(DirectoryEntry);
+const CommunityHomeSpaceBase = z.object({
+	id: z.string(),
+	name: z.string(),
+	memberCount: z.number().int().describe("Active space members"),
+	accessRule: z.enum([
+		"all_members",
+		"by_request",
+		"by_invite"
+	]),
+	standing: z.enum([
+		"open",
+		"member",
+		"requested",
+		"invited",
+		"full",
+		"none"
+	]).describe("Where the viewer stands with this space, and so which action it offers. `open`: the viewer can open it without joining (an all-members space, or staff). `member`: the viewer belongs to it. `requested`: the viewer asked to join and awaits a decision. `invited`: the viewer may accept or refuse an invitation. `full`: it is at capacity. `none`: none of these; ask to join a `by_request` space, or wait for an invitation to a `by_invite` one.")
+});
+const LockedCommunitySpace = CommunityHomeSpaceBase.extend({ locked: z.literal(true).describe("The viewer cannot open this space. Only enough to request a place, accept an invite or contact staff is served; never its description, topics, links or settings") });
+const OpenCommunitySpace = CommunityHomeSpaceBase.extend({
+	locked: z.literal(false).describe("The viewer can open this space and read its feed"),
+	description: z.string().nullable(),
+	capacity: z.number().int().nullable(),
+	settings: z.object({
+		comments: z.boolean(),
+		reactions: z.boolean(),
+		requireReview: z.boolean()
+	}),
+	topics: z.array(z.object({
+		id: z.string(),
+		name: z.string()
+	})),
+	links: z.array(z.object({
+		id: z.string(),
+		contentId: z.string(),
+		type: z.enum([
+			"course",
+			"download",
+			"community"
+		]),
+		title: z.string()
+	})).describe("Linked content that is published; staff also see unpublished targets")
+});
+const CommunityHomeSpace = z.discriminatedUnion("locked", [LockedCommunitySpace, OpenCommunitySpace]).describe("A space as the viewer sees it. A by-invite space the viewer is not invited to or a member of is never served");
+const CommunityHome = z.object({
+	communityId: z.string(),
+	title: z.string(),
+	description: z.string(),
+	thumbnailUrl: z.string().nullable(),
+	dm: dmSettingsSchema,
+	spaces: z.array(CommunityHomeSpace)
+});
+const CommunityAnalytics = z.object({
+	memberCount: z.number().int(),
+	activeMembers: z.number().int(),
+	postsPerSpace: z.array(z.object({
+		spaceId: z.string(),
+		count: z.number().int()
+	})),
+	commentsPerPost: z.array(z.object({
+		postId: z.string(),
+		count: z.number().int()
+	})),
+	messagesSent: z.number().int(),
+	flagsRaised: z.number().int(),
+	flagsResolved: z.number().int(),
+	grantsLapsed: z.number().int(),
+	grantsRenewed: z.number().int()
+});
+//#endregion
+export { CommunitiesPage, CommunitiesQuery, Community, CommunityAnalytics, CommunityChatParam, CommunityCommentParam, CommunityHome, CommunityHomeSpace, CommunityIdParam, CommunityMember, CommunityMembersPage, CommunityMembersQuery, CommunityMessageParam, CommunityPostParam, CommunitySpaceParam, CreateCommunity, CreateSpace, DirectoryEntry, DirectoryPage, DirectoryQuery, DmSettings, LockedCommunitySpace, OpenCommunitySpace, OrderedIds, PatchDmSettings, SetSpaceTopics, SpaceDetail, SpaceLinkBody, SpaceLinkParam, SpaceMember, SpaceMemberParam, SpaceMembersPage, UpdateCommunity, UpdateSpace };
+
+//# sourceMappingURL=community.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"community.js","names":[],"sources":["../../../src/http/schemas/community.ts"],"sourcesContent":["import { z } from 'zod';\nimport {\n  communityStatusSchema,\n  roleSchema,\n  communityViewSchema,\n  createCommunityInputSchema,\n  createSpaceInputSchema,\n  dmSettingsSchema,\n  idSchema,\n  patchDmSettingsInputSchema,\n  setSpaceTopicsInputSchema,\n  spaceDetailSchema,\n  spaceMemberSchema,\n  updateCommunityInputSchema,\n  updateSpaceInputSchema,\n} from '@headless-lms/core/schemas';\nimport type {\n  CommunityAnalytics as DomainCommunityAnalytics,\n  CommunityMember as DomainCommunityMember,\n} from '@headless-lms/core/reporting/admin';\nimport type {\n  CommunityHome as DomainCommunityHome,\n  CommunityHomeSpace as DomainCommunityHomeSpace,\n  DirectoryEntry as DomainDirectoryEntry,\n} from '@headless-lms/core/reporting/member';\nimport { ListQuery, OrgUserProfileSchema, PageQuery, paginated, type Matches } from './shared.js';\n\nexport const Community = communityViewSchema;\nexport const CommunitiesQuery = ListQuery.extend({\n  status: communityStatusSchema.optional(),\n});\nexport const CommunitiesPage = paginated(Community);\nexport const CreateCommunity = createCommunityInputSchema;\nexport const UpdateCommunity = updateCommunityInputSchema;\nexport const PatchDmSettings = patchDmSettingsInputSchema;\nexport const DmSettings = dmSettingsSchema;\nexport const SpaceDetail = spaceDetailSchema;\nexport const SpaceMember = spaceMemberSchema;\nexport const SpaceMembersPage = paginated(SpaceMember);\nexport const CreateSpace = createSpaceInputSchema;\nexport const UpdateSpace = updateSpaceInputSchema;\nexport const SetSpaceTopics = setSpaceTopicsInputSchema;\nexport const OrderedIds = z\n  .object({\n    ids: z\n      .array(idSchema)\n      .min(1)\n      .max(200)\n      .describe('Every id in the collection, once each, in the new order'),\n  })\n  .strict();\nexport const SpaceLinkBody = z\n  .object({ contentId: idSchema.describe('The course, download or community to link') })\n  .strict();\n\nexport const CommunityIdParam = z.object({ communityId: z.string() });\nexport const CommunitySpaceParam = z.object({ communityId: z.string(), spaceId: z.string() });\nexport const SpaceLinkParam = CommunitySpaceParam.extend({ linkId: z.string() });\nexport const SpaceMemberParam = CommunitySpaceParam.extend({ orgUserId: z.string() });\nexport const CommunityPostParam = z.object({ communityId: z.string(), postId: z.string() });\nexport const CommunityCommentParam = z.object({ communityId: z.string(), commentId: z.string() });\nexport const CommunityMessageParam = z.object({ communityId: z.string(), messageId: z.string() });\nexport const CommunityChatParam = z.object({ communityId: z.string(), chatId: z.string() });\n\nexport const CommunityMember = OrgUserProfileSchema.extend({ role: roleSchema });\ntype _CommunityMemberMatches = Matches<DomainCommunityMember, z.infer<typeof CommunityMember>> &\n  Matches<z.infer<typeof CommunityMember>, DomainCommunityMember>;\nexport const CommunityMembersQuery = PageQuery.extend({ search: z.string().trim().optional() });\nexport const CommunityMembersPage = paginated(CommunityMember);\n\nexport const DirectoryEntry = z.object({\n  orgUserId: z.string(),\n  role: z.string(),\n  displayName: z.string().nullable(),\n  headline: z.string().nullable(),\n  bio: z.string().nullable(),\n  imageAssetId: z.string().nullable(),\n  imageUrl: z.string().nullable(),\n});\ntype _DirectoryMatches = Matches<\n  Omit<DomainDirectoryEntry, 'userId'>,\n  z.infer<typeof DirectoryEntry>\n> &\n  Matches<z.infer<typeof DirectoryEntry>, Omit<DomainDirectoryEntry, 'userId'>>;\nexport const DirectoryQuery = PageQuery.extend({\n  search: z.string().trim().max(100).optional().describe('Matches part of a display name'),\n});\nexport const DirectoryPage = paginated(DirectoryEntry);\n\nconst CommunityHomeSpaceBase = z.object({\n  id: z.string(),\n  name: z.string(),\n  memberCount: z.number().int().describe('Active space members'),\n  accessRule: z.enum(['all_members', 'by_request', 'by_invite']),\n  standing: z\n    .enum(['open', 'member', 'requested', 'invited', 'full', 'none'])\n    .describe(\n      'Where the viewer stands with this space, and so which action it offers. `open`: the viewer can open it without joining (an all-members space, or staff). `member`: the viewer belongs to it. `requested`: the viewer asked to join and awaits a decision. `invited`: the viewer may accept or refuse an invitation. `full`: it is at capacity. `none`: none of these; ask to join a `by_request` space, or wait for an invitation to a `by_invite` one.',\n    ),\n});\n\nexport const LockedCommunitySpace = CommunityHomeSpaceBase.extend({\n  locked: z\n    .literal(true)\n    .describe(\n      'The viewer cannot open this space. Only enough to request a place, accept an invite or contact staff is served; never its description, topics, links or settings',\n    ),\n});\n\nexport const OpenCommunitySpace = CommunityHomeSpaceBase.extend({\n  locked: z.literal(false).describe('The viewer can open this space and read its feed'),\n  description: z.string().nullable(),\n  capacity: z.number().int().nullable(),\n  settings: z.object({\n    comments: z.boolean(),\n    reactions: z.boolean(),\n    requireReview: z.boolean(),\n  }),\n  topics: z.array(z.object({ id: z.string(), name: z.string() })),\n  links: z\n    .array(\n      z.object({\n        id: z.string(),\n        contentId: z.string(),\n        type: z.enum(['course', 'download', 'community']),\n        title: z.string(),\n      }),\n    )\n    .describe('Linked content that is published; staff also see unpublished targets'),\n});\n\nexport const CommunityHomeSpace = z\n  .discriminatedUnion('locked', [LockedCommunitySpace, OpenCommunitySpace])\n  .describe(\n    'A space as the viewer sees it. A by-invite space the viewer is not invited to or a member of is never served',\n  );\ntype _HomeSpaceMatches = Matches<DomainCommunityHomeSpace, z.infer<typeof CommunityHomeSpace>> &\n  Matches<z.infer<typeof CommunityHomeSpace>, DomainCommunityHomeSpace>;\n\nexport const CommunityHome = z.object({\n  communityId: z.string(),\n  title: z.string(),\n  description: z.string(),\n  thumbnailUrl: z.string().nullable(),\n  dm: dmSettingsSchema,\n  spaces: z.array(CommunityHomeSpace),\n});\ntype _HomeMatches = Matches<DomainCommunityHome, z.infer<typeof CommunityHome>> &\n  Matches<z.infer<typeof CommunityHome>, DomainCommunityHome>;\n\nexport const CommunityAnalytics = z.object({\n  memberCount: z.number().int(),\n  activeMembers: z.number().int(),\n  postsPerSpace: z.array(z.object({ spaceId: z.string(), count: z.number().int() })),\n  commentsPerPost: z.array(z.object({ postId: z.string(), count: z.number().int() })),\n  messagesSent: z.number().int(),\n  flagsRaised: z.number().int(),\n  flagsResolved: z.number().int(),\n  grantsLapsed: z.number().int(),\n  grantsRenewed: z.number().int(),\n});\ntype _AnalyticsMatches = Matches<DomainCommunityAnalytics, z.infer<typeof CommunityAnalytics>> &\n  Matches<z.infer<typeof CommunityAnalytics>, DomainCommunityAnalytics>;\n"],"mappings":";;;;AA2BA,MAAa,YAAY;AACzB,MAAa,mBAAmB,UAAU,OAAO,EAC/C,QAAQ,sBAAsB,SAAS,EACzC,CAAC;AACD,MAAa,kBAAkB,UAAU,SAAS;AAClD,MAAa,kBAAkB;AAC/B,MAAa,kBAAkB;AAC/B,MAAa,kBAAkB;AAC/B,MAAa,aAAa;AAC1B,MAAa,cAAc;AAC3B,MAAa,cAAc;AAC3B,MAAa,mBAAmB,UAAU,WAAW;AACrD,MAAa,cAAc;AAC3B,MAAa,cAAc;AAC3B,MAAa,iBAAiB;AAC9B,MAAa,aAAa,EACvB,OAAO,EACN,KAAK,EACF,MAAM,QAAQ,CAAC,CACf,IAAI,CAAC,CAAC,CACN,IAAI,GAAG,CAAC,CACR,SAAS,yDAAyD,EACvE,CAAC,CAAC,CACD,OAAO;AACV,MAAa,gBAAgB,EAC1B,OAAO,EAAE,WAAW,SAAS,SAAS,2CAA2C,EAAE,CAAC,CAAC,CACrF,OAAO;AAEV,MAAa,mBAAmB,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;AACpE,MAAa,sBAAsB,EAAE,OAAO;CAAE,aAAa,EAAE,OAAO;CAAG,SAAS,EAAE,OAAO;AAAE,CAAC;AAC5F,MAAa,iBAAiB,oBAAoB,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC/E,MAAa,mBAAmB,oBAAoB,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;AACpF,MAAa,qBAAqB,EAAE,OAAO;CAAE,aAAa,EAAE,OAAO;CAAG,QAAQ,EAAE,OAAO;AAAE,CAAC;AAC1F,MAAa,wBAAwB,EAAE,OAAO;CAAE,aAAa,EAAE,OAAO;CAAG,WAAW,EAAE,OAAO;AAAE,CAAC;AAChG,MAAa,wBAAwB,EAAE,OAAO;CAAE,aAAa,EAAE,OAAO;CAAG,WAAW,EAAE,OAAO;AAAE,CAAC;AAChG,MAAa,qBAAqB,EAAE,OAAO;CAAE,aAAa,EAAE,OAAO;CAAG,QAAQ,EAAE,OAAO;AAAE,CAAC;AAE1F,MAAa,kBAAkB,qBAAqB,OAAO,EAAE,MAAM,WAAW,CAAC;AAG/E,MAAa,wBAAwB,UAAU,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;AAC9F,MAAa,uBAAuB,UAAU,eAAe;AAE7D,MAAa,iBAAiB,EAAE,OAAO;CACrC,WAAW,EAAE,OAAO;CACpB,MAAM,EAAE,OAAO;CACf,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CACjC,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS;CAC9B,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS;CACzB,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS;CAClC,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS;AAChC,CAAC;AAMD,MAAa,iBAAiB,UAAU,OAAO,EAC7C,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,gCAAgC,EACzF,CAAC;AACD,MAAa,gBAAgB,UAAU,cAAc;AAErD,MAAM,yBAAyB,EAAE,OAAO;CACtC,IAAI,EAAE,OAAO;CACb,MAAM,EAAE,OAAO;CACf,aAAa,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,sBAAsB;CAC7D,YAAY,EAAE,KAAK;EAAC;EAAe;EAAc;CAAW,CAAC;CAC7D,UAAU,EACP,KAAK;EAAC;EAAQ;EAAU;EAAa;EAAW;EAAQ;CAAM,CAAC,CAAC,CAChE,SACC,ybACF;AACJ,CAAC;AAED,MAAa,uBAAuB,uBAAuB,OAAO,EAChE,QAAQ,EACL,QAAQ,IAAI,CAAC,CACb,SACC,kKACF,EACJ,CAAC;AAED,MAAa,qBAAqB,uBAAuB,OAAO;CAC9D,QAAQ,EAAE,QAAQ,KAAK,CAAC,CAAC,SAAS,kDAAkD;CACpF,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CACjC,UAAU,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS;CACpC,UAAU,EAAE,OAAO;EACjB,UAAU,EAAE,QAAQ;EACpB,WAAW,EAAE,QAAQ;EACrB,eAAe,EAAE,QAAQ;CAC3B,CAAC;CACD,QAAQ,EAAE,MAAM,EAAE,OAAO;EAAE,IAAI,EAAE,OAAO;EAAG,MAAM,EAAE,OAAO;CAAE,CAAC,CAAC;CAC9D,OAAO,EACJ,MACC,EAAE,OAAO;EACP,IAAI,EAAE,OAAO;EACb,WAAW,EAAE,OAAO;EACpB,MAAM,EAAE,KAAK;GAAC;GAAU;GAAY;EAAW,CAAC;EAChD,OAAO,EAAE,OAAO;CAClB,CAAC,CACH,CAAC,CACA,SAAS,sEAAsE;AACpF,CAAC;AAED,MAAa,qBAAqB,EAC/B,mBAAmB,UAAU,CAAC,sBAAsB,kBAAkB,CAAC,CAAC,CACxE,SACC,8GACF;AAIF,MAAa,gBAAgB,EAAE,OAAO;CACpC,aAAa,EAAE,OAAO;CACtB,OAAO,EAAE,OAAO;CAChB,aAAa,EAAE,OAAO;CACtB,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS;CAClC,IAAI;CACJ,QAAQ,EAAE,MAAM,kBAAkB;AACpC,CAAC;AAID,MAAa,qBAAqB,EAAE,OAAO;CACzC,aAAa,EAAE,OAAO,CAAC,CAAC,IAAI;CAC5B,eAAe,EAAE,OAAO,CAAC,CAAC,IAAI;CAC9B,eAAe,EAAE,MAAM,EAAE,OAAO;EAAE,SAAS,EAAE,OAAO;EAAG,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI;CAAE,CAAC,CAAC;CACjF,iBAAiB,EAAE,MAAM,EAAE,OAAO;EAAE,QAAQ,EAAE,OAAO;EAAG,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI;CAAE,CAAC,CAAC;CAClF,cAAc,EAAE,OAAO,CAAC,CAAC,IAAI;CAC7B,aAAa,EAAE,OAAO,CAAC,CAAC,IAAI;CAC5B,eAAe,EAAE,OAAO,CAAC,CAAC,IAAI;CAC9B,cAAc,EAAE,OAAO,CAAC,CAAC,IAAI;CAC7B,eAAe,EAAE,OAAO,CAAC,CAAC,IAAI;AAChC,CAAC"}