@lincyaw/addon-session 0.0.0-stage → 1.0.0-rc.1

package/src/domain/session-record.ts

@@ -0,0 +1,72 @@
+import type { Participant, SessionStatus } from '@lincyaw/kernel'
+
+export interface Position {
+  slide: number
+  step: number
+  view?: string
+  section?: string
+  trail?: string[]
+  back?: string
+}
+
+export type FollowMode = 'follow' | 'free'
+
+export interface SessionRecord {
+  status?: 'active' | 'ended'
+  presenter?: string
+  presenterName?: string
+  cursor?: Position
+  startedAt?: number
+  endedAt?: number
+  archive?: string
+  archivedAt?: number
+}
+
+export function sessionStatus(record: SessionRecord): Exclude<SessionStatus, 'idle'> {
+  return record.status === 'ended' ? 'ended' : 'active'
+}
+
+export function startRecord(presenter: Participant, now: number): SessionRecord {
+  return { status: 'active', presenter: presenter.id, presenterName: presenter.name, startedAt: now }
+}
+
+export function endRecord(now: number): SessionRecord {
+  return { status: 'ended', endedAt: now }
+}
+
+export function samePosition(a: Position | undefined, b: Position | undefined): boolean {
+  return a?.slide === b?.slide && a?.step === b?.step && a?.view === b?.view && a?.section === b?.section
+    && a?.trail?.join('\n') === b?.trail?.join('\n') && a?.back === b?.back
+}
+
+export function clonePosition(position: Position): Position {
+  const { slide, step, view, section, trail, back } = position
+  return { slide, step, ...view ? { view } : {}, ...section ? { section } : {}, ...trail ? { trail: [...trail] } : {}, ...back ? { back } : {} }
+}
+
+export function followTarget(me: Participant | undefined, follow: FollowMode, record: SessionRecord): Position | undefined {
+  if (me?.role !== 'learner' || follow !== 'follow' || sessionStatus(record) !== 'active') return undefined
+  return record.cursor
+}
+
+export function jsonClone<T>(value: T): T {
+  return value === undefined ? value : JSON.parse(JSON.stringify(value)) as T
+}
+
+export function changedEntries(current: (key: string) => unknown, next: Readonly<Record<string, unknown>>): [string, unknown][] {
+  return Object.entries(jsonClone(next)).filter(([key, value]) => value !== undefined && JSON.stringify(current(key)) !== JSON.stringify(value))
+}
+
+function isParticipant(value: unknown): value is Participant {
+  const p = value as Partial<Participant> | null | undefined
+  return typeof p?.id === 'string' && typeof p.name === 'string' && (p.role === 'presenter' || p.role === 'learner')
+}
+
+export function participantsOf(states: Iterable<unknown>): Participant[] {
+  const byId = new Map<string, Participant>()
+  for (const state of states) {
+    const participant = (state as { participant?: unknown } | null)?.participant
+    if (isParticipant(participant)) byId.set(participant.id, { id: participant.id, name: participant.name, role: participant.role })
+  }
+  return [...byId.values()].sort((a, b) => (a.role === b.role ? a.name.localeCompare(b.name, 'zh') : a.role === 'presenter' ? -1 : 1))
+}

package/src/domain/session-service.ts

@@ -0,0 +1,49 @@
+import type { ClassroomStore, SessionService, SessionSnapshot, Unsubscribe } from '@lincyaw/kernel'
+import type { SessionMessages } from './messages.ts'
+import type { FollowMode } from './session-record.ts'
+
+export interface ClassroomSnapshot extends SessionSnapshot {
+  server?: string
+  connection: 'offline' | 'connecting' | 'connected'
+  follow: FollowMode
+  joinUrl?: string
+  invitation?: string
+  rejoin?: string
+  error?: string
+  refused?: boolean
+  archive?: string
+}
+
+export interface ClassroomSession extends SessionService {
+  snapshot(): ClassroomSnapshot
+  subscribe(listener: (snapshot: ClassroomSnapshot) => void): Unsubscribe
+  setFollow(mode: FollowMode): void
+  rejoin(): Promise<void>
+  archive(): Promise<string>
+  readonly personal: ClassroomStore
+}
+
+export function isClassroomSession(service: SessionService | undefined): service is ClassroomSession {
+  return typeof (service as Partial<ClassroomSession> | undefined)?.setFollow === 'function'
+}
+
+export function statusText(s: ClassroomSnapshot, t: SessionMessages): string {
+  if (!s.server) return t.status.noServer
+  if (s.status === 'idle') {
+    if (s.error) return t.status.failed(s.error)
+    return s.invitation ? t.status.invited(s.invitation) : t.status.idle
+  }
+  if (s.status === 'ended') return s.archive ? t.status.archived(s.archive) : t.status.ended
+  if (s.connection !== 'connected') return t.status.connecting
+  if (s.me?.role === 'presenter') return t.status.presenting
+  return s.follow === 'follow' ? t.status.following : t.status.browsing
+}
+
+export function shortStatus(s: ClassroomSnapshot, t: SessionMessages): string {
+  if (!s.server) return t.short.noServer
+  if (s.status === 'idle') return t.short.idle
+  if (s.status === 'ended') return s.archive ? t.short.archived : t.short.ended
+  if (s.connection !== 'connected') return t.short.connecting
+  if (s.me?.role === 'presenter') return t.short.presenter
+  return s.follow === 'follow' ? t.short.follow : t.short.free
+}

package/src/node/presmium.ts

@@ -0,0 +1,45 @@
+import { createRequire } from 'node:module'
+import { startClassroomServer } from '@lincyaw/classroom-server'
+import { isRecord, jsonResponse } from '@lincyaw/kernel'
+import type { Check, PresmiumNodePlugin } from '@lincyaw/kernel'
+import { SESSION_ID, SYNC_PATH, toSessionConfig } from '../domain/index.ts'
+
+const { version } = createRequire(import.meta.url)('../../package.json') as { version: string }
+
+const serverCheck: Check = {
+  id: SESSION_ID,
+  async run(ctx) {
+    const config = ctx.ir.config.presmium[SESSION_ID]
+    if (toSessionConfig(isRecord(config) ? config : {}).server) return []
+    return [{
+      checkId: SESSION_ID,
+      severity: 'info',
+      message: 'no classroom server: presmium dev and presmium serve sync the classroom on their own port; a build shows no classroom',
+      hint: 'for a published deck, start presmium-classroom-server and set presmium: { presmium.session: { server: ws://<host>:<port> } } in the frontmatter',
+    }]
+  },
+}
+
+const plugin: PresmiumNodePlugin = {
+  id: SESSION_ID,
+  version,
+  kernel: '^1.0.0',
+  checks: [serverCheck],
+  async server(ctx) {
+    const classroom = await startClassroomServer({
+      port: 0,
+      listenAddress: '127.0.0.1',
+      deck: ctx.deckDir,
+      onDropped: (room, writer, reason) => ctx.log.warn(`classroom ${room}: dropped ${reason} from ${writer.presenter ? 'the presenter' : writer.participant ? `participant ${writer.participant}` : 'an unidentified participant'}`),
+    })
+    return {
+      routes: {
+        classroom: { role: 'reader', handle: (_request, { document }) => jsonResponse({ path: `/__presmium/${SESSION_ID}/${SYNC_PATH}`, document }) },
+      },
+      proxies: [{ path: SYNC_PATH, target: `http://127.0.0.1:${classroom.port}`, role: 'reader' }],
+      close: () => classroom.close(),
+    }
+  },
+}
+
+export default plugin