@headless-lms/server 0.2.0 → 0.4.0

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

@@ -0,0 +1,597 @@
+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>;
+    digest: z.ZodNullable<z.ZodObject<{
+      cadence: z.ZodEnum<{
+        daily: "daily";
+        weekly: "weekly";
+      }>;
+      weekday: z.ZodNumber;
+      hour: z.ZodNumber;
+      timeZone: z.ZodString;
+    }, 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>;
+      digest: z.ZodNullable<z.ZodObject<{
+        cadence: z.ZodEnum<{
+          daily: "daily";
+          weekly: "weekly";
+        }>;
+        weekday: z.ZodNumber;
+        hour: z.ZodNumber;
+        timeZone: z.ZodString;
+      }, 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 PatchCommunitySettings: 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>;
+  digest: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    cadence: z.ZodEnum<{
+      daily: "daily";
+      weekly: "weekly";
+    }>;
+    weekday: z.ZodNumber;
+    hour: z.ZodNumber;
+    timeZone: z.ZodString;
+  }, z.core.$strict>>>;
+}, 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<{
+    active: "active";
+    invited: "invited";
+    requested: "requested";
+    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<{
+      active: "active";
+      invited: "invited";
+      requested: "requested";
+      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 SpaceIdParam: z.ZodObject<{
+  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<{
+    invited: "invited";
+    member: "member";
+    open: "open";
+    requested: "requested";
+    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<{
+    invited: "invited";
+    member: "member";
+    open: "open";
+    requested: "requested";
+    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>>;
+  subscription: z.ZodNullable<z.ZodObject<{
+    state: z.ZodEnum<{
+      following: "following";
+      muted: "muted";
+    }>;
+    mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+  }, z.core.$strict>>;
+}, 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<{
+    invited: "invited";
+    member: "member";
+    open: "open";
+    requested: "requested";
+    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<{
+    invited: "invited";
+    member: "member";
+    open: "open";
+    requested: "requested";
+    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>>;
+  subscription: z.ZodNullable<z.ZodObject<{
+    state: z.ZodEnum<{
+      following: "following";
+      muted: "muted";
+    }>;
+    mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+  }, z.core.$strict>>;
+}, 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<{
+      invited: "invited";
+      member: "member";
+      open: "open";
+      requested: "requested";
+      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<{
+      invited: "invited";
+      member: "member";
+      open: "open";
+      requested: "requested";
+      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>>;
+    subscription: z.ZodNullable<z.ZodObject<{
+      state: z.ZodEnum<{
+        following: "following";
+        muted: "muted";
+      }>;
+      mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    }, z.core.$strict>>;
+  }, 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, PatchCommunitySettings, PatchDmSettings, SetSpaceTopics, SpaceDetail, SpaceIdParam, SpaceLinkBody, SpaceLinkParam, SpaceMember, SpaceMemberParam, SpaceMembersPage, UpdateCommunity, UpdateSpace };
+//# sourceMappingURL=community.d.ts.map