timeback 0.1.5 → 0.1.6

package/dist/cli/src/config.d.ts

@@ -1,8 +0,0 @@
-/**
- * Config types for timeback.config.ts files.
- *
- * Re-exported from `@timeback/types` so users can import `timeback/config`
- * for editor IntelliSense in TS config files. SDK users can also use
- * `@timeback/sdk/config` which exports the same types.
- */
-export type { CourseConfig, CourseDefaults, CourseGoals, CourseIds, CourseMetadata, CourseMetrics, CourseType, PublishStatus, TimebackConfig, } from '@timeback/types';

package/dist/types/src/config.d.ts

@@ -1,186 +0,0 @@
-/**
- * Timeback Config Types
- *
- * Types for timeback.config.ts files.
- *
- * Note: Runtime validation is enforced by `@timeback/types/zod` (see
- * `packages/types/src/zod/config.ts`). These TS types are a convenience layer
- * and should not be treated as a replacement for Zod validation.
- */
-import type { TimebackGrade, TimebackSubject } from './primitives';
-/**
- * Environment-specific course IDs.
- * Populated by `timeback sync` for each environment.
- */
-export interface CourseIds {
-    staging?: string;
-    production?: string;
-}
-/**
- * Course classification type.
- */
-export type CourseType = 'base' | 'hole-filling' | 'optional';
-/**
- * Course publication status.
- */
-export type PublishStatus = 'draft' | 'testing' | 'published' | 'deactivated';
-/**
- * Daily learning goals for a course.
- */
-export interface CourseGoals {
-    /** Target XP to earn per day */
-    dailyXp?: number;
-    /** Target lessons to complete per day */
-    dailyLessons?: number;
-    /** Target active learning minutes per day */
-    dailyActiveMinutes?: number;
-    /** Target accuracy percentage (0-100) */
-    dailyAccuracy?: number;
-    /** Target units to master per day */
-    dailyMasteredUnits?: number;
-}
-/**
- * Aggregate metrics for a course.
- */
-export interface CourseMetrics {
-    /** Total XP available in the course */
-    totalXp?: number;
-    /** Total number of lessons/activities */
-    totalLessons?: number;
-    /** Total grade levels covered */
-    totalGrades?: number;
-}
-/**
- * Course metadata (matches API metadata object).
- */
-export interface CourseMetadata {
-    /** Course classification (base, hole-filling, optional) */
-    courseType?: CourseType;
-    /** Whether this is supplemental to a base course */
-    isSupplemental?: boolean;
-    /** Whether this is a custom course for an individual student */
-    isCustom?: boolean;
-    /** Publication status */
-    publishStatus?: PublishStatus;
-    /** Contact email for course issues */
-    contactEmail?: string;
-    /** Primary application identifier */
-    primaryApp?: string;
-    /** Daily learning goals */
-    goals?: CourseGoals;
-    /** Aggregate metrics */
-    metrics?: CourseMetrics;
-}
-/**
- * Default properties that apply to all courses unless overridden.
- * Set these at the root level to avoid repetition.
- */
-export interface CourseDefaults {
-    /** Course code (e.g., "MATH101") */
-    courseCode?: string;
-    /** Course level (e.g., "AP", "Honors") */
-    level?: string;
-    /** Course metadata */
-    metadata?: CourseMetadata;
-}
-/**
- * Environment-specific course overrides.
- *
- * Non-identity fields that can differ per environment.
- * Excludes `subject`, `grade`, `courseCode` (identity) and `ids` (already env-scoped).
- */
-export interface CourseEnvOverrides {
-    /** Course level override for this environment */
-    level?: string;
-    /** Caliper sensor URL override for this environment */
-    sensor?: string;
-    /** Launch URL override for this environment (used in dashboard resource links) */
-    launchUrl?: string;
-    /** Metadata override for this environment (merged with base metadata) */
-    metadata?: CourseMetadata;
-}
-/**
- * Per-environment course overrides.
- *
- * Allows staging and production to have different non-identity properties.
- */
-export interface CourseOverrides {
-    /** Overrides applied when syncing to staging */
-    staging?: CourseEnvOverrides;
-    /** Overrides applied when syncing to production */
-    production?: CourseEnvOverrides;
-}
-/**
- * Configuration for a single course in a Timeback app.
- *
- * Course identity is determined by one of:
- * - **Grade-based**: `(subject, grade)` — traditional K-12 courses
- * - **Grade-less**: `courseCode` — apps without grade levels (e.g., CS platforms)
- *
- * At least one identity must be present:
- * - If `grade` is provided, the course is identified by `(subject, grade)`.
- * - If `grade` is omitted, `courseCode` is required as the identifier.
- *
- * Sensor/LaunchUrl resolution:
- * - Each course must have an effective sensor (either `course.sensor` or top-level `sensor`).
- * - Each course must have an effective launchUrl (either `course.launchUrl` or top-level `launchUrl`).
- *
- * Environment overrides:
- * - Use `overrides.staging` or `overrides.production` to vary non-identity fields per env.
- */
-export interface CourseConfig extends CourseDefaults {
-    /** Subject area (e.g., 'Math', 'Reading') */
-    subject: TimebackSubject;
-    /**
-     * Grade level (-1 = Pre-K, 0 = K, 1-12 = grades, 13 = AP).
-     * Optional for grade-less apps; if omitted, `courseCode` is required.
-     */
-    grade?: TimebackGrade;
-    /** Timeback course IDs per environment (populated after sync) */
-    ids?: CourseIds | null;
-    /**
-     * Caliper sensor URL for this course.
-     * Overrides the top-level `sensor` if set.
-     */
-    sensor?: string;
-    /**
-     * Launch URL for this course (used in dashboard resource links).
-     * Overrides the top-level `launchUrl` if set.
-     */
-    launchUrl?: string;
-    /**
-     * Environment-specific overrides for non-identity fields.
-     * Merged with base course config when syncing to a specific environment.
-     */
-    overrides?: CourseOverrides;
-}
-/**
- * Root configuration for a Timeback app.
- * Define this in your timeback.config.ts file.
- *
- * Sensor resolution: every course must have an effective sensor.
- * - Set `sensor` at the top level as a default for all courses.
- * - Override per course with `courses[].sensor`.
- *
- * LaunchUrl resolution: every course must have an effective launchUrl.
- * - Set `launchUrl` at the top level as a default for all courses.
- * - Override per course with `courses[].launchUrl`.
- */
-export interface TimebackConfig {
-    /** Display name for your app */
-    name: string;
-    /** Default properties applied to all courses */
-    defaults?: CourseDefaults;
-    /** Courses available in this app */
-    courses: CourseConfig[];
-    /**
-     * Default Caliper sensor URL for activity events.
-     * Can be overridden per course with `courses[].sensor`.
-     */
-    sensor?: string;
-    /**
-     * Default launch URL for dashboard resource links.
-     * Can be overridden per course with `courses[].launchUrl`.
-     */
-    launchUrl?: string;
-}

package/dist/types/src/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * TypeScript types for Timeback platform protocols.
- */
-export * from './primitives';
-export * from './config';

package/dist/types/src/primitives.d.ts

@@ -1,53 +0,0 @@
-/**
- * Timeback Shared Primitives
- *
- * Core types used across multiple Timeback protocols.
- *
- * Organization:
- * - Shared types (this file): Used by multiple protocols (Caliper, OneRoster, etc.)
- * - Protocol-specific types: Live in their respective protocols/X/primitives.ts files
- *
- * What belongs here:
- * - TimebackSubject - Used in OneRoster courses AND Caliper events
- * - TimebackGrade - Used across OneRoster, Caliper, and QTI
- * - IMSErrorResponse - IMS Global standard used by multiple 1EdTech protocols
- *
- * What doesn't belong here:
- * - OneRoster-specific: protocols/oneroster/primitives.ts
- * - QTI-specific: protocols/qti/primitives.ts
- */
-/**
- * Valid Timeback subject values.
- * Used in OneRoster courses and Caliper events.
- */
-export type TimebackSubject = 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None' | 'Other';
-/**
- * Grade levels per Timeback OneRoster GradeEnum (numeric).
- * -1 = Pre-K, 0 = Kindergarten, 1-12 = Grades 1-12, 13 = AP
- *
- * Use for input types where numbers are accepted.
- */
-export type TimebackGrade = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13;
-/**
- * Grade levels as strings (API response format).
- * The database stores grades as text, so API responses return strings.
- *
- * Use for response types.
- */
-export type TimebackGradeString = '-1' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13';
-/**
- * IMS Global error response format.
- * Used across OneRoster, Caliper, and other 1EdTech protocols.
- */
-export interface IMSErrorResponse {
-    imsx_codeMajor: 'failure' | 'success';
-    imsx_severity: 'error' | 'warning' | 'status';
-    imsx_description: string;
-    imsx_CodeMinor?: {
-        imsx_codeMinorField: Array<{
-            imsx_codeMinorFieldName: string;
-            imsx_codeMinorFieldValue: string;
-        }>;
-    };
-    imsx_error_details?: Array<Record<string, string>>;
-}