Module @hiyve/courses/hiyve

@hiyve/courses/hiyve — keep courses in Hiyve user files.

Each document is a JSON file in the owner's Hiyve files, shared with exactly the people the access rules allow:

Document	Owner	Shared with
Course outline	provider	every enrolled client
Lesson content (and the files it uses)	provider	clients the lesson is open to
Private quiz answers	provider	nobody
Enrollment	provider	that client
Progress	client	the provider
Review settings	provider	nobody

Creating documents, sharing and reading work without a room. Changing a saved document needs a connected client (a room or a no-video room), passed in through getFileClient; without one, saves that change an existing document reject with a 'not-ready' CourseStorageError.

Example

import { createHiyveCourseStorage } from '@hiyve/courses/hiyve';

const storage = createHiyveCourseStorage({
  store,                                   // your HiyveStore
  userId: 'provider@example.com',
  getFileClient: () => store.getSlice('client').client,
});
const courses = await storage.listCourses();

Interfaces

HiyveCourseStorage
HiyveCourseStorageOptions

Type Aliases

HiyveCourseFileStore

Variables

DEFAULT_HIYVE_COURSES_LOCATION
HIYVE_COURSE_RESOURCE_TYPES

Functions

createHiyveCourseStorage