@headless-lms/core 0.2.0 → 0.4.0

package/dist/reporting/admin/service.js

@@ -0,0 +1,38 @@
+//#region src/reporting/admin/service.ts
+var AdminReportServiceImpl = class {
+	repo;
+	constructor(params) {
+		this.repo = params.repo;
+	}
+	overview(orgId) {
+		return this.repo.overview(orgId);
+	}
+	enrollments(orgId, days) {
+		return this.repo.enrollments(orgId, days);
+	}
+	courseAnalytics(orgId, courseId) {
+		return this.repo.courseAnalytics(orgId, courseId);
+	}
+	courseEnrollments(orgId, courseId, days) {
+		return this.repo.courseEnrollments(orgId, courseId, days);
+	}
+	listStudents(orgId, query) {
+		return this.repo.listStudents(orgId, query);
+	}
+	getStudent(orgId, id) {
+		return this.repo.getStudent(orgId, id);
+	}
+	studentAnalytics(orgId, id) {
+		return this.repo.studentAnalytics(orgId, id);
+	}
+	communityAnalytics(orgId, communityId) {
+		return this.repo.communityAnalytics(orgId, communityId);
+	}
+	communityMembers(orgId, communityId, query) {
+		return this.repo.communityMembers(orgId, communityId, query);
+	}
+};
+//#endregion
+export { AdminReportServiceImpl };
+
+//# sourceMappingURL=service.js.map

package/dist/reporting/admin/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","names":[],"sources":["../../../src/reporting/admin/service.ts"],"sourcesContent":["import type {\n  CommunityAnalytics,\n  CommunityMember,\n  CommunityMembersQuery,\n  CourseAnalytics,\n  CourseEnrollmentPoint,\n  EnrollmentPoint,\n  OverviewStats,\n  Page,\n  Student,\n  StudentAnalytics,\n  StudentsQuery,\n} from './model.js';\nimport type { AdminReportRepository, AdminReportService } from './ports.js';\n\nexport type AdminReportServiceParams = {\n  repo: AdminReportRepository;\n};\n\nexport class AdminReportServiceImpl implements AdminReportService {\n  private readonly repo: AdminReportRepository;\n\n  constructor(params: AdminReportServiceParams) {\n    this.repo = params.repo;\n  }\n\n  overview(orgId: string): Promise<OverviewStats> {\n    return this.repo.overview(orgId);\n  }\n\n  enrollments(orgId: string, days: number): Promise<EnrollmentPoint[]> {\n    return this.repo.enrollments(orgId, days);\n  }\n\n  courseAnalytics(orgId: string, courseId: string): Promise<CourseAnalytics | null> {\n    return this.repo.courseAnalytics(orgId, courseId);\n  }\n\n  courseEnrollments(\n    orgId: string,\n    courseId: string,\n    days: number,\n  ): Promise<CourseEnrollmentPoint[] | null> {\n    return this.repo.courseEnrollments(orgId, courseId, days);\n  }\n\n  listStudents(orgId: string, query: StudentsQuery): Promise<Page<Student>> {\n    return this.repo.listStudents(orgId, query);\n  }\n\n  getStudent(orgId: string, id: string): Promise<Student | null> {\n    return this.repo.getStudent(orgId, id);\n  }\n\n  studentAnalytics(orgId: string, id: string): Promise<StudentAnalytics | null> {\n    return this.repo.studentAnalytics(orgId, id);\n  }\n\n  communityAnalytics(orgId: string, communityId: string): Promise<CommunityAnalytics | null> {\n    return this.repo.communityAnalytics(orgId, communityId);\n  }\n\n  communityMembers(\n    orgId: string,\n    communityId: string,\n    query: CommunityMembersQuery,\n  ): Promise<Page<CommunityMember> | null> {\n    return this.repo.communityMembers(orgId, communityId, query);\n  }\n}\n"],"mappings":";AAmBA,IAAa,yBAAb,MAAkE;CAChE;CAEA,YAAY,QAAkC;EAC5C,KAAK,OAAO,OAAO;CACrB;CAEA,SAAS,OAAuC;EAC9C,OAAO,KAAK,KAAK,SAAS,KAAK;CACjC;CAEA,YAAY,OAAe,MAA0C;EACnE,OAAO,KAAK,KAAK,YAAY,OAAO,IAAI;CAC1C;CAEA,gBAAgB,OAAe,UAAmD;EAChF,OAAO,KAAK,KAAK,gBAAgB,OAAO,QAAQ;CAClD;CAEA,kBACE,OACA,UACA,MACyC;EACzC,OAAO,KAAK,KAAK,kBAAkB,OAAO,UAAU,IAAI;CAC1D;CAEA,aAAa,OAAe,OAA8C;EACxE,OAAO,KAAK,KAAK,aAAa,OAAO,KAAK;CAC5C;CAEA,WAAW,OAAe,IAAqC;EAC7D,OAAO,KAAK,KAAK,WAAW,OAAO,EAAE;CACvC;CAEA,iBAAiB,OAAe,IAA8C;EAC5E,OAAO,KAAK,KAAK,iBAAiB,OAAO,EAAE;CAC7C;CAEA,mBAAmB,OAAe,aAAyD;EACzF,OAAO,KAAK,KAAK,mBAAmB,OAAO,WAAW;CACxD;CAEA,iBACE,OACA,aACA,OACuC;EACvC,OAAO,KAAK,KAAK,iBAAiB,OAAO,aAAa,KAAK;CAC7D;AACF"}

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

@@ -0,0 +1,5 @@
+import { CourseView, Module } from "../../types/schemas/content.js";
+import { CommunityHome, CommunityHomeSpace, CommunityNotificationSettingsView, CourseProgressView, DirectoryEntry, DirectoryQuery, DirectoryRow, LockedCommunitySpace, NotificationItemView, NotificationSettingsCategoryView, NotificationUnreadCounts, NotificationView, NotificationsView, OpenCommunitySpace, OrgNotificationSettingsView, SettingsChannelView } from "./model.js";
+import { MemberReportRepository, MemberReportService } from "./ports.js";
+import { MemberReportServiceImpl } from "./service.js";
+export { type CommunityHome, type CommunityHomeSpace, type CommunityNotificationSettingsView, type CourseProgressView, type CourseView, type DirectoryEntry, type DirectoryQuery, type DirectoryRow, type LockedCommunitySpace, type MemberReportRepository, type MemberReportService, MemberReportServiceImpl, type Module, type NotificationItemView, type NotificationSettingsCategoryView, type NotificationUnreadCounts, type NotificationView, type NotificationsView, type OpenCommunitySpace, type OrgNotificationSettingsView, type SettingsChannelView };

package/dist/reporting/member/index.js

@@ -0,0 +1,2 @@
+import { MemberReportServiceImpl } from "./service.js";
+export { MemberReportServiceImpl };

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

@@ -0,0 +1,157 @@
+import { JsonValue } from "../../types/shared.js";
+import { ActivityView, CourseView, DigestSchedule, DownloadFile, DownloadView, Module } from "../../types/schemas/content.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 { 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;
+  imageAssetId: string | null;
+}
+interface DirectoryQuery {
+  page: number;
+  pageSize: number;
+  search?: string;
+}
+interface DirectoryEntry extends DirectoryRow {
+  imageUrl: string | null;
+}
+interface CommunityHomeLink {
+  id: string;
+  contentId: string;
+  type: 'course' | 'download' | 'community';
+  title: string;
+}
+interface CommunityHomeSpaceBase {
+  id: string;
+  name: string;
+  memberCount: number;
+  accessRule: 'all_members' | 'by_request' | 'by_invite';
+  standing: 'open' | 'member' | 'requested' | 'invited' | 'full' | 'none';
+}
+/** A space the viewer can see but not open: enough to request, accept or ask. */
+interface LockedCommunitySpace extends CommunityHomeSpaceBase {
+  locked: true;
+}
+interface OpenCommunitySpace extends CommunityHomeSpaceBase {
+  locked: false;
+  description: string | null;
+  capacity: number | null;
+  settings: {
+    comments: boolean;
+    reactions: boolean;
+    requireReview: boolean;
+  };
+  topics: {
+    id: string;
+    name: string;
+  }[];
+  links: CommunityHomeLink[];
+  subscription: SubscriptionView | null;
+}
+type CommunityHomeSpace = LockedCommunitySpace | OpenCommunitySpace;
+interface CommunityHome {
+  communityId: string;
+  title: string;
+  description: string;
+  thumbnailUrl: string | null;
+  dm: {
+    enabled: boolean;
+    memberToMember: boolean;
+    memberToStaff: boolean;
+    staffToAnyone: boolean;
+    firstMessageIsRequest: boolean;
+    groupChats: boolean;
+    groupSize: number;
+  };
+  spaces: CommunityHomeSpace[];
+}
+interface CourseProgressView {
+  /** Keyed by activity id; absent key = not started. */
+  activities: Record<string, 'in-progress' | 'completed'>;
+  /** Integer 0–100: completed ÷ current published activities, rounded. */
+  percent: number;
+  /** The course target's own record says so. */
+  completed: boolean;
+  /** Per-activity reported state (the record's position map); absent key = none reported. */
+  positions: Record<string, unknown>;
+}
+interface NotificationItemView {
+  type: SubjectRef['type'];
+  id: string;
+  title?: string;
+  excerpt?: string;
+}
+interface NotificationView {
+  id: string;
+  type: string;
+  scope: Scope;
+  reasons: Reason[];
+  matchedReason: Reason;
+  category: string;
+  display: Record<string, JsonValue>;
+  community: {
+    id: string;
+    title: string;
+  } | null;
+  space: {
+    id: string;
+    name: string;
+  } | null;
+  actor: {
+    orgUserId: string;
+    name: string | null;
+    imageUrl: string | null;
+  } | 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[];
+  total: number;
+  page: number;
+  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, CommunityNotificationSettingsView, CourseProgressView, type CourseView, DirectoryEntry, DirectoryQuery, DirectoryRow, type DownloadFile, type DownloadView, LockedCommunitySpace, type Module, NotificationItemView, NotificationSettingsCategoryView, NotificationUnreadCounts, NotificationView, NotificationsView, OpenCommunitySpace, OrgNotificationSettingsView, SettingsChannelView };
+//# sourceMappingURL=model.d.ts.map

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

@@ -0,0 +1,48 @@
+import { Page } from "../../types/shared.js";
+import { ActivityView, CourseView, DownloadFile, DownloadView, Module } from "../../types/schemas/content.js";
+import { NotificationFilter } from "../../types/notifications.js";
+import "../../types/index.js";
+import { Actor } from "../../shared/actor.js";
+import { CommunityHome, CommunityHomeSpace, CommunityNotificationSettingsView, CourseProgressView, DirectoryEntry, DirectoryQuery, DirectoryRow, 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<{
+    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, filter: NotificationFilter, page: {
+    page: number;
+    pageSize: number;
+  }): Promise<NotificationsView>;
+  notification(orgId: string, actor: Actor, userId: string, notificationId: string): Promise<NotificationView | null>;
+  notificationUnreadCounts(orgId: string, actor: Actor, userId: string): Promise<NotificationUnreadCounts>;
+  /** The person's notification settings in a community they can open, resolved per channel. */
+  communityNotificationSettings(orgId: string, actor: Actor, userId: string, communityId: string): Promise<CommunityNotificationSettingsView | null>;
+  /** The person's notification settings for the org's categories. */
+  orgNotificationSettings(orgId: string, userId: string): Promise<OrgNotificationSettingsView>;
+}
+interface MemberReportRepository {
+  directory(orgId: string, communityId: string, query: DirectoryQuery): Promise<Page<DirectoryRow>>;
+  spaceMemberCounts(orgId: string, communityId: string): Promise<Record<string, number>>;
+  people(orgId: string, orgUserIds: string[]): Promise<DirectoryRow[]>;
+}
+//#endregion
+export { MemberReportRepository, MemberReportService };
+//# sourceMappingURL=ports.d.ts.map

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

@@ -0,0 +1,92 @@
+import { Page } from "../../types/shared.js";
+import { ActivityView, CourseView, DownloadFile, DownloadView, Module } from "../../types/schemas/content.js";
+import { NotificationFilter } from "../../types/notifications.js";
+import "../../types/index.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, ItemTitles } from "../../content/ports.js";
+import "../../content/index.js";
+import { NotificationSettingsService } from "../../identity/ports.js";
+import "../../identity/index.js";
+import { EntitlementsService } from "../../entitlements/ports.js";
+import "../../entitlements/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 { ProgressService } from "../../progress/ports.js";
+import "../../progress/index.js";
+import { CommunityHome, CommunityHomeSpace, CommunityNotificationSettingsView, CourseProgressView, DirectoryEntry, DirectoryQuery, 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' | 'openCommunityIds'>;
+type MemberReportServiceParams = {
+  repo: MemberReportRepository;
+  content: ContentService;
+  progress: ProgressService;
+  files: Pick<AssetFiles, 'signFile'>;
+  fileUrls: FileUrls;
+  access: MemberAccess;
+  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'>;
+};
+declare class MemberReportServiceImpl implements MemberReportService {
+  private readonly repo;
+  private readonly content;
+  private readonly progress;
+  private readonly files;
+  private readonly fileUrls;
+  private readonly access;
+  private readonly notificationList;
+  private readonly titles;
+  private readonly subscriptions;
+  private readonly notificationCategories;
+  private readonly notificationSettings;
+  private readonly channels;
+  constructor(params: MemberReportServiceParams);
+  communityNotificationSettings(orgId: string, actor: Actor, userId: string, communityId: string): Promise<CommunityNotificationSettingsView | null>;
+  orgNotificationSettings(orgId: string, userId: string): Promise<OrgNotificationSettingsView>;
+  private settingsView;
+  notifications(orgId: string, actor: Actor, userId: string, filter: NotificationFilter, page: {
+    page: number;
+    pageSize: number;
+  }): Promise<NotificationsView>;
+  notification(orgId: string, actor: Actor, userId: string, notificationId: string): Promise<NotificationView | null>;
+  notificationUnreadCounts(orgId: string, actor: Actor, userId: string): 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<{
+    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>;
+  private homeSpaces;
+  private linkViews;
+}
+//#endregion
+export { MemberReportServiceImpl, MemberReportServiceParams };
+//# sourceMappingURL=service.d.ts.map