OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

learning.getDashboard

Get learner dashboard data.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: stable
  • Tags: learning, dashboard
  • File: packages/modules/learning-journey/src/contracts/operations.ts
    • field.key.label
    learning.getDashboard
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    learning.getDashboard
    field.description.label

    Get learner dashboard data.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: stable
  • Tags: learning, dashboard
  • File: packages/modules/learning-journey/src/contracts/operations.ts
    • field.tags.label
    learning,dashboard
    field.owners.label
    field.stability.label
    stable

    Get learner dashboard data.

    Goal

    Display learner progress and stats.

    Context

    Called when viewing the learning dashboard.

    Source Definition

    import { defineCommand, defineQuery } from '@lssm-tech/lib.contracts-spec';
import {
	CompleteLessonInput,
	EnrollInCourseInput,
	EnrollmentModel,
	GetDueCardsInput,
	GetDueCardsOutput,
	GetLearnerDashboardInput,
	LearnerDashboardModel,
	SubmitCardReviewInput,
	SuccessOutput,
} from './models';
import { LEARNING_JOURNEY_OWNERS } from './shared';

export const GetLearnerDashboardContract = defineQuery({
	meta: {
		key: 'learning.getDashboard',
		version: '1.0.0',
		stability: 'stable',
		owners: [...LEARNING_JOURNEY_OWNERS],
		tags: ['learning', 'dashboard'],
		description: 'Get learner dashboard data.',
		goal: 'Display learner progress and stats.',
		context: 'Called when viewing the learning dashboard.',
	},
	io: {
		input: GetLearnerDashboardInput,
		output: LearnerDashboardModel,
	},
	policy: {
		auth: 'user',
	},
});