@headless-lms/core 0.3.0 → 0.5.0

package/dist/reporting/member/model.d.ts

@@ -1,14 +1,18 @@
-import { ActivityView, CourseView, DownloadFile, DownloadView, Module } from "../../types/schemas/content.js";
-import { NotificationKind } from "../../types/schemas/identity.js";
+import { JsonValue } from "../../types/shared.js";
+import { ActivityView, CourseView, DigestSchedule, DownloadFile, DownloadView, EventAttendee, MemberEvent, MemberEventSummary, MemberEventsQuery, Module } from "../../types/schemas/content.js";
+import { Permission } from "../../types/schemas/organizations.js";
+import { SubscriptionView } from "../../types/schemas/discussion.js";
+import { Reason, Scope, SubjectRef } from "../../types/notifications.js";
+import "../../types/index.js";
 import "../../content/index.js";
-import "../../identity/index.js";
+import { EventAttendeeRow, EventReader } from "../events/index.js";
+import { ResolvedChannel } from "../../shared/notification-settings.js";
 //#region src/reporting/member/model.d.ts
 /** Per-course progress for the student surface. Derived on read against the
  *  current published structure — never stored. */
 interface DirectoryRow {
   orgUserId: string;
   userId: string;
-  role: string;
   displayName: string | null;
   headline: string | null;
   bio: string | null;
@@ -21,6 +25,25 @@ interface DirectoryQuery {
 }
 interface DirectoryEntry extends DirectoryRow {
   imageUrl: string | null;
+  team: boolean;
+  roleName: string | null;
+  opensEverySpace: boolean;
+}
+interface MemberViewer {
+  orgUserId: string;
+  orgRole: {
+    key: string;
+    name: string;
+  };
+  permissions: Permission[];
+  orgPermissions: Permission[];
+}
+interface CommunityViewer {
+  permissions: Permission[];
+  opensEverySpace: boolean;
+  team: boolean;
+  roleName: string;
+  canCreateEvents: boolean;
 }
 interface CommunityHomeLink {
   id: string;
@@ -53,6 +76,7 @@ interface OpenCommunitySpace extends CommunityHomeSpaceBase {
     name: string;
   }[];
   links: CommunityHomeLink[];
+  subscription: SubscriptionView | null;
 }
 type CommunityHomeSpace = LockedCommunitySpace | OpenCommunitySpace;
 interface CommunityHome {
@@ -63,13 +87,14 @@ interface CommunityHome {
   dm: {
     enabled: boolean;
     memberToMember: boolean;
-    memberToStaff: boolean;
-    staffToAnyone: boolean;
+    memberToTeam: boolean;
+    teamToAnyone: boolean;
     firstMessageIsRequest: boolean;
     groupChats: boolean;
     groupSize: number;
   };
   spaces: CommunityHomeSpace[];
+  viewer: CommunityViewer;
 }
 interface CourseProgressView {
   /** Keyed by activity id; absent key = not started. */
@@ -81,18 +106,20 @@ interface CourseProgressView {
   /** Per-activity reported state (the record's position map); absent key = none reported. */
   positions: Record<string, unknown>;
 }
-/** One of the viewer's notifications, with the names of what it refers to.
- *  A post or chat the viewer can no longer see comes back null. */
+interface NotificationItemView {
+  type: SubjectRef['type'];
+  id: string;
+  title?: string;
+  excerpt?: string;
+}
 interface NotificationView {
   id: string;
-  kind: NotificationKind;
-  createdAt: Date;
-  readAt: Date | null;
-  actor: {
-    orgUserId: string;
-    displayName: string | null;
-    imageUrl: string | null;
-  } | null;
+  type: string;
+  scope: Scope;
+  reasons: Reason[];
+  matchedReason: Reason;
+  category: string;
+  display: Record<string, JsonValue>;
   community: {
     id: string;
     title: string;
@@ -101,16 +128,22 @@ interface NotificationView {
     id: string;
     name: string;
   } | null;
-  post: {
-    id: string;
-    title: string;
-  } | null;
-  commentId: string | null;
-  chat: {
-    id: string;
-    title: string;
+  actor: {
+    orgUserId: string;
+    name: string | null;
+    imageUrl: string | null;
   } | null;
-  messageId: string | null;
+  subject: NotificationItemView | null;
+  parent: NotificationItemView | null;
+  createdAt: Date;
+  readAt: Date | null;
+}
+interface NotificationUnreadCounts {
+  org: number;
+  communities: {
+    communityId: string;
+    unread: number;
+  }[];
 }
 interface NotificationsView {
   rows: NotificationView[];
@@ -119,6 +152,27 @@ interface NotificationsView {
   pageSize: number;
   unreadCount: number;
 }
+interface SettingsChannelView extends ResolvedChannel {
+  default: boolean;
+}
+interface NotificationSettingsCategoryView {
+  key: string;
+  perSpace: boolean;
+  channels: SettingsChannelView[];
+  spaces?: {
+    spaceId: string;
+    name: string;
+    channels: SettingsChannelView[];
+  }[];
+}
+interface CommunityNotificationSettingsView {
+  communityId: string;
+  digest: DigestSchedule | null;
+  categories: NotificationSettingsCategoryView[];
+}
+interface OrgNotificationSettingsView {
+  categories: NotificationSettingsCategoryView[];
+}
 //#endregion
-export { type ActivityView, CommunityHome, CommunityHomeLink, CommunityHomeSpace, CourseProgressView, type CourseView, DirectoryEntry, DirectoryQuery, DirectoryRow, type DownloadFile, type DownloadView, LockedCommunitySpace, type Module, NotificationView, NotificationsView, OpenCommunitySpace };
+export { type ActivityView, CommunityHome, CommunityHomeLink, CommunityHomeSpace, CommunityNotificationSettingsView, CommunityViewer, CourseProgressView, type CourseView, DirectoryEntry, DirectoryQuery, DirectoryRow, type DownloadFile, type DownloadView, type EventAttendee, type EventAttendeeRow, type EventReader, LockedCommunitySpace, type MemberEvent, type MemberEventSummary, type MemberEventsQuery, MemberViewer, type Module, NotificationItemView, NotificationSettingsCategoryView, NotificationUnreadCounts, NotificationView, NotificationsView, OpenCommunitySpace, OrgNotificationSettingsView, SettingsChannelView };
 //# sourceMappingURL=model.d.ts.map

package/dist/reporting/member/ports.d.ts

@@ -1,44 +1,66 @@
 import { Page } from "../../types/shared.js";
-import { ActivityView, CourseView, DownloadFile, DownloadView, Module } from "../../types/schemas/content.js";
-import { Notification } from "../../types/schemas/identity.js";
+import { ActivityView, CourseView, DownloadFile, DownloadView, EventAttendee, MemberEvent, MemberEventSummary, MemberEventsQuery, Module } from "../../types/schemas/content.js";
+import { NotificationFilter } from "../../types/notifications.js";
 import "../../types/index.js";
 import { Actor } from "../../shared/actor.js";
+import { MemberActor } from "../../identity/ports.js";
 import "../../identity/index.js";
-import { CommunityHome, CommunityHomeSpace, CourseProgressView, DirectoryEntry, DirectoryQuery, DirectoryRow, NotificationView, NotificationsView } from "./model.js";
+import { EventAttendeeRow, EventFaces, EventReader } from "../events/index.js";
+import { CommunityHome, CommunityHomeSpace, CommunityNotificationSettingsView, CourseProgressView, DirectoryEntry, DirectoryQuery, DirectoryRow, MemberViewer, NotificationUnreadCounts, NotificationView, NotificationsView, OrgNotificationSettingsView } from "./model.js";
 //#region src/reporting/member/ports.d.ts
 interface MemberReportService {
-  listCourses(orgId: string, orgUserId: string): Promise<CourseView[]>;
-  getCourse(orgId: string, orgUserId: string, courseId: string): Promise<CourseView | null>;
-  listModules(orgId: string, orgUserId: string, courseId: string): Promise<Module[] | null>;
-  listActivities(orgId: string, orgUserId: string, courseId: string): Promise<ActivityView[] | null>;
-  courseProgress(orgId: string, orgUserId: string, courseId: string): Promise<CourseProgressView | null>;
-  listDownloads(orgId: string, orgUserId: string): Promise<DownloadView[]>;
-  getDownload(orgId: string, orgUserId: string, downloadId: string): Promise<{
+  /** Who the caller is in the org, and the permissions they hold. */
+  viewer(actor: Actor): MemberViewer;
+  listCourses(actor: Actor): Promise<CourseView[]>;
+  getCourse(courseId: string, actor: Actor): Promise<CourseView>;
+  listModules(courseId: string, actor: Actor): Promise<Module[]>;
+  listActivities(courseId: string, actor: Actor): Promise<ActivityView[]>;
+  courseProgress(courseId: string, actor: Actor): Promise<CourseProgressView>;
+  listDownloads(actor: Actor): Promise<DownloadView[]>;
+  getDownload(downloadId: string, actor: Actor): Promise<{
     download: DownloadView;
     assets: DownloadFile[];
-  } | null>;
-  /** Signed URL of a course, download or community thumbnail: published, or staff. */
-  thumbnailFile(orgId: string, actor: Actor, owner: 'course' | 'download' | 'community', id: string): Promise<string | null>;
-  /** Signed URL of an asset the activity links, for a student who can open its course. */
-  activityFile(orgId: string, actor: Actor, activityId: string, assetId: string): Promise<string | null>;
-  /** Signed download URL of a file in a download the student can open. */
-  downloadFile(orgId: string, actor: Actor, downloadId: string, assetId: string): Promise<string | null>;
-  /** Signed URL of an org user's profile photo, when it belongs to this org. */
-  personImage(orgId: string, orgUserId: string): Promise<string | null>;
-  directory(orgId: string, actor: Actor, communityId: string, query: DirectoryQuery): Promise<Page<DirectoryEntry> | null>;
-  communityHome(orgId: string, actor: Actor, communityId: string): Promise<CommunityHome | null>;
-  communitySpace(orgId: string, actor: Actor, communityId: string, spaceId: string): Promise<CommunityHomeSpace | null>;
-  notifications(orgId: string, actor: Actor, userId: string, query: {
+  }>;
+  /** Signed URL of a course, download or community thumbnail: published, or the item's read
+   *  permission. An event's when the caller can read the event. */
+  thumbnailFile(owner: 'course' | 'download' | 'community' | 'event', id: string, actor: Actor): Promise<string>;
+  getEvent(eventId: string, actor: Actor): Promise<MemberEvent>;
+  listEvents(query: MemberEventsQuery, actor: Actor): Promise<Page<MemberEventSummary>>;
+  eventCalendar(eventId: string, actor: Actor): Promise<string>;
+  eventAttendees(eventId: string, query: {
     page: number;
     pageSize: number;
-  }): Promise<NotificationsView>;
-  /** One notification the way `notifications` lists it. */
-  notificationView(orgId: string, actor: Actor, notification: Notification): Promise<NotificationView>;
+  }, actor: Actor): Promise<Page<EventAttendee>>;
+  eventFile(eventId: string, assetId: string, actor: Actor): Promise<string>;
+  /** Signed URL of an asset the activity links, for a person who can open its course. */
+  activityFile(activityId: string, assetId: string, actor: Actor): Promise<string>;
+  /** Signed download URL of a file in a download the person can open. */
+  downloadFile(downloadId: string, assetId: string, actor: Actor): Promise<string>;
+  directory(communityId: string, query: DirectoryQuery, actor: Actor): Promise<Page<DirectoryEntry>>;
+  communityHome(communityId: string, actor: Actor): Promise<CommunityHome>;
+  communitySpace(communityId: string, spaceId: string, actor: Actor): Promise<CommunityHomeSpace>;
+  notifications(filter: NotificationFilter, page: {
+    page: number;
+    pageSize: number;
+  }, actor: MemberActor): Promise<NotificationsView>;
+  notification(notificationId: string, actor: MemberActor): Promise<NotificationView>;
+  notificationUnreadCounts(actor: MemberActor): Promise<NotificationUnreadCounts>;
+  /** The person's notification settings in a community they can open, resolved per channel. */
+  communityNotificationSettings(communityId: string, actor: MemberActor): Promise<CommunityNotificationSettingsView>;
+  /** The person's notification settings for the org's categories. */
+  orgNotificationSettings(actor: MemberActor): Promise<OrgNotificationSettingsView>;
 }
 interface MemberReportRepository {
-  directory(orgId: string, communityId: string, query: DirectoryQuery): Promise<Page<DirectoryRow>>;
-  spaceMemberCounts(orgId: string, communityId: string): Promise<Record<string, number>>;
+  directory(orgId: string, communityId: string, query: DirectoryQuery, readerIds: string[]): Promise<Page<DirectoryRow>>;
+  spaceMemberCounts(orgId: string, communityId: string, excluding: string[]): Promise<Record<string, number>>;
   people(orgId: string, orgUserIds: string[]): Promise<DirectoryRow[]>;
+  eventAttendees(orgId: string, eventId: string, page: {
+    page: number;
+    pageSize: number;
+  }): Promise<Page<EventAttendeeRow>>;
+  eventFaces(orgId: string, eventIds: string[], limit: number): Promise<Record<string, EventFaces>>;
+  directEventGrants(orgId: string, orgUserId: string, eventIds: string[]): Promise<string[]>;
+  events(orgId: string, query: MemberEventsQuery, reader: EventReader, now: Date): Promise<Page<string>>;
 }
 //#endregion
 export { MemberReportRepository, MemberReportService };

package/dist/reporting/member/service.d.ts

@@ -1,35 +1,55 @@
 import { Page } from "../../types/shared.js";
-import { ActivityView, CourseView, DownloadFile, DownloadView, Module } from "../../types/schemas/content.js";
-import { Notification } from "../../types/schemas/identity.js";
+import { ActivityView, CourseView, DownloadFile, DownloadView, EventAttendee, MemberEvent, MemberEventSummary, MemberEventsQuery, Module } from "../../types/schemas/content.js";
+import { NotificationFilter } from "../../types/notifications.js";
 import "../../types/index.js";
+import { Actor } from "../../shared/actor.js";
+import { ChannelRegistry, NotificationCategoryService } from "../../shared/ports.js";
 import { FileUrls } from "../../assets/file-urls.js";
 import { AssetFiles } from "../../assets/ports.js";
 import "../../assets/index.js";
-import { Actor } from "../../shared/actor.js";
-import { ContentService } from "../../content/ports.js";
+import { ContentService, ItemTitles } from "../../content/ports.js";
 import "../../content/index.js";
-import { NotificationInbox } from "../../identity/ports.js";
-import "../../identity/index.js";
 import { EntitlementsService } from "../../entitlements/ports.js";
 import "../../entitlements/index.js";
-import { ChatService, PostService } from "../../discussion/ports.js";
+import { MemberActor, NotificationSettingsService } from "../../identity/ports.js";
+import "../../identity/index.js";
+import { NotificationsService } from "../../automations/ports.js";
+import "../../automations/index.js";
+import { ItemTitles as ItemTitles$1, SubscriptionService } from "../../discussion/ports.js";
 import "../../discussion/index.js";
+import { OrganizationService } from "../../organizations/ports.js";
+import "../../organizations/index.js";
 import { ProgressService } from "../../progress/ports.js";
 import "../../progress/index.js";
-import { CommunityHome, CommunityHomeSpace, CourseProgressView, DirectoryEntry, DirectoryQuery, NotificationView, NotificationsView } from "./model.js";
+import { CommunityHome, CommunityHomeSpace, CommunityNotificationSettingsView, CourseProgressView, DirectoryEntry, DirectoryQuery, MemberViewer, NotificationUnreadCounts, NotificationView, NotificationsView, OrgNotificationSettingsView } from "./model.js";
 import { MemberReportRepository, MemberReportService } from "./ports.js";
 //#region src/reporting/member/service.d.ts
-type MemberAccess = Pick<EntitlementsService, 'isCommunityMember' | 'openSpaceIds' | 'spaceStandings' | 'hasAccess' | 'listAccessibleContent'>;
+type MemberAccess = Pick<EntitlementsService, 'isCommunityMember' | 'openSpaceIds' | 'spaceStandings' | 'hasAccess' | 'listAccessibleContent' | 'openCommunityIds' | 'opensEverySpace' | 'everySpaceOpeners'>;
+type MemberContent = Pick<ContentService, 'findCourse' | 'listCourseModules' | 'listCourseActivityViews' | 'listCourseActivities' | 'listCourseActivityAssets' | 'getActivity' | 'findDownload' | 'listDownloadAssets' | 'findCommunity' | 'listSpaces' | 'getSpace' | 'findEvent' | 'findEvents' | 'eventFilesFor'>;
+type MemberPeople = Pick<OrganizationService, 'systemActor' | 'permissionsOfMany' | 'holders'>;
+type Owner = 'course' | 'download' | 'community' | 'event';
 type MemberReportServiceParams = {
   repo: MemberReportRepository;
-  content: ContentService;
-  progress: ProgressService;
+  content: MemberContent;
+  progress: Pick<ProgressService, 'get' | 'listByTargets'>;
   files: Pick<AssetFiles, 'signFile'>;
   fileUrls: FileUrls;
   access: MemberAccess;
-  notifications: Pick<NotificationInbox, 'listNotifications'>;
-  posts: Pick<PostService, 'visibleTitles'>;
-  chats: Pick<ChatService, 'titlesFor'>;
+  people: MemberPeople;
+  notifications: Pick<NotificationsService, 'list' | 'get' | 'unreadCounts'>;
+  titles: {
+    discussion: ItemTitles$1;
+    content: ItemTitles;
+  };
+  subscriptions: Pick<SubscriptionService, 'viewerSubscriptions'>;
+  notificationCategories: {
+    community: Pick<NotificationCategoryService, 'get'>;
+    org: Pick<NotificationCategoryService, 'get'>;
+  };
+  notificationSettings: Pick<NotificationSettingsService, 'get'>;
+  channels: Pick<ChannelRegistry, 'list'>;
+  studentPortalUrl: string;
+  now?: () => Date;
 };
 declare class MemberReportServiceImpl implements MemberReportService {
   private readonly repo;
@@ -38,33 +58,59 @@ declare class MemberReportServiceImpl implements MemberReportService {
   private readonly files;
   private readonly fileUrls;
   private readonly access;
-  private readonly inbox;
-  private readonly posts;
-  private readonly chats;
+  private readonly people;
+  private readonly notificationList;
+  private readonly titles;
+  private readonly subscriptions;
+  private readonly notificationCategories;
+  private readonly notificationSettings;
+  private readonly channels;
+  private readonly studentPortalUrl;
+  private readonly now;
   constructor(params: MemberReportServiceParams);
-  notifications(orgId: string, actor: Actor, userId: string, query: {
+  private system;
+  viewer(actor: Actor): MemberViewer;
+  communityNotificationSettings(communityId: string, actor: MemberActor): Promise<CommunityNotificationSettingsView>;
+  orgNotificationSettings(actor: MemberActor): Promise<OrgNotificationSettingsView>;
+  private settingsView;
+  notifications(filter: NotificationFilter, page: {
     page: number;
     pageSize: number;
-  }): Promise<NotificationsView>;
-  notificationView(orgId: string, actor: Actor, notification: Notification): Promise<NotificationView>;
+  }, actor: MemberActor): Promise<NotificationsView>;
+  notification(notificationId: string, actor: MemberActor): Promise<NotificationView>;
+  notificationUnreadCounts(actor: MemberActor): Promise<NotificationUnreadCounts>;
   private describeNotifications;
-  listCourses(orgId: string, orgUserId: string): Promise<CourseView[]>;
-  getCourse(orgId: string, orgUserId: string, courseId: string): Promise<CourseView | null>;
-  listModules(orgId: string, orgUserId: string, courseId: string): Promise<Module[] | null>;
-  listActivities(orgId: string, orgUserId: string, courseId: string): Promise<ActivityView[] | null>;
-  courseProgress(orgId: string, orgUserId: string, courseId: string): Promise<CourseProgressView | null>;
-  listDownloads(orgId: string, orgUserId: string): Promise<DownloadView[]>;
-  getDownload(orgId: string, orgUserId: string, downloadId: string): Promise<{
+  private opensCourse;
+  private opensDownload;
+  listCourses(actor: Actor): Promise<CourseView[]>;
+  private requireCourse;
+  getCourse(courseId: string, actor: Actor): Promise<CourseView>;
+  listModules(courseId: string, actor: Actor): Promise<Module[]>;
+  listActivities(courseId: string, actor: Actor): Promise<ActivityView[]>;
+  courseProgress(courseId: string, actor: Actor): Promise<CourseProgressView>;
+  listDownloads(actor: Actor): Promise<DownloadView[]>;
+  getDownload(downloadId: string, actor: Actor): Promise<{
     download: DownloadView;
     assets: DownloadFile[];
-  } | null>;
-  thumbnailFile(orgId: string, actor: Actor, owner: 'course' | 'download' | 'community', id: string): Promise<string | null>;
-  activityFile(orgId: string, actor: Actor, activityId: string, assetId: string): Promise<string | null>;
-  downloadFile(orgId: string, actor: Actor, downloadId: string, assetId: string): Promise<string | null>;
-  personImage(orgId: string, orgUserId: string): Promise<string | null>;
-  directory(orgId: string, actor: Actor, communityId: string, query: DirectoryQuery): Promise<Page<DirectoryEntry> | null>;
-  communityHome(orgId: string, actor: Actor, communityId: string): Promise<CommunityHome | null>;
-  communitySpace(orgId: string, actor: Actor, communityId: string, spaceId: string): Promise<CommunityHomeSpace | null>;
+  }>;
+  thumbnailFile(owner: Owner, id: string, actor: Actor): Promise<string>;
+  activityFile(activityId: string, assetId: string, actor: Actor): Promise<string>;
+  downloadFile(downloadId: string, assetId: string, actor: Actor): Promise<string>;
+  private seeEvents;
+  private requireEvent;
+  private eventSummaries;
+  private eventSummary;
+  getEvent(eventId: string, actor: Actor): Promise<MemberEvent>;
+  listEvents(query: MemberEventsQuery, actor: Actor): Promise<Page<MemberEventSummary>>;
+  eventCalendar(eventId: string, actor: Actor): Promise<string>;
+  eventAttendees(eventId: string, query: {
+    page: number;
+    pageSize: number;
+  }, actor: Actor): Promise<Page<EventAttendee>>;
+  eventFile(eventId: string, assetId: string, actor: Actor): Promise<string>;
+  directory(communityId: string, query: DirectoryQuery, actor: Actor): Promise<Page<DirectoryEntry>>;
+  communityHome(communityId: string, actor: Actor): Promise<CommunityHome>;
+  communitySpace(communityId: string, spaceId: string, actor: Actor): Promise<CommunityHomeSpace>;
   private homeSpaces;
   private linkViews;
 }