@timeback/oneroster 0.1.0

package/dist/types/gradebook.d.ts

@@ -0,0 +1,262 @@
+/**
+ * OneRoster Gradebook Types
+ *
+ * Types for gradebook entities: results, line items, categories, score scales, assessments.
+ */
+import type { ScoreStatus } from '@timeback/types';
+import type { Base, LearningObjectiveSet, Ref } from './base';
+/**
+ * A value within a score scale (e.g., "A" = 90-100).
+ */
+export interface ScoreScaleValue {
+    /** Left-hand side of the range (e.g., "90") */
+    itemValueLHS: string;
+    /** Right-hand side of the range (e.g., "100") */
+    itemValueRHS: string;
+    /** Display value (e.g., "A") */
+    value?: string;
+    /** Description of this score level */
+    description?: string;
+}
+/**
+ * A grading scale defining how scores are interpreted.
+ *
+ * Score scales can be associated with classes or courses and define
+ * the mapping between numeric scores and letter grades.
+ */
+export interface ScoreScale extends Base {
+    /** Scale title (e.g., "Standard Grading Scale") */
+    title: string;
+    /** Type of scale */
+    type?: string;
+    /** Class this scale applies to */
+    class?: Ref;
+    /** Course this scale applies to */
+    course?: Ref | null;
+    /** Values defining the scale */
+    scoreScaleValue?: ScoreScaleValue[];
+    /** Minimum possible score */
+    minScore?: number;
+    /** Maximum possible score */
+    maxScore?: number;
+}
+/**
+ * A category for organizing line items (e.g., "Homework", "Tests", "Projects").
+ */
+export interface Category extends Base {
+    /** Category name */
+    title: string;
+    /** Weight for grade calculation (0.0 to 1.0) */
+    weight?: number | null;
+}
+/**
+ * Input for creating/updating a category.
+ */
+export interface CategoryCreateInput {
+    /** Category name */
+    title: string;
+    /** Status */
+    status: 'active' | 'tobedeleted';
+    /** Client-supplied sourcedId (optional) */
+    sourcedId?: string;
+    /** Weight for grade calculation (0.0 to 1.0) */
+    weight?: number | null;
+    /** Metadata */
+    metadata?: Record<string, unknown> | null;
+}
+/**
+ * A line item (assignment, test, or other gradable item).
+ *
+ * Line items represent work that students complete and receive grades for.
+ */
+export interface LineItem extends Base {
+    /** Title of the assignment */
+    title: string;
+    /** Description of the assignment */
+    description?: string | null;
+    /** Date the assignment was given (ISO 8601 datetime) */
+    assignDate: string;
+    /** Due date for the assignment (ISO 8601 datetime) */
+    dueDate: string;
+    /** Class this line item belongs to */
+    class: Ref;
+    /** School */
+    school: Ref;
+    /** Category for this line item */
+    category: Ref;
+    /** Grading period */
+    gradingPeriod?: Ref | null;
+    /** Academic session */
+    academicSession?: Ref | null;
+    /** Score scale to use for grading */
+    scoreScale?: Ref | null;
+    /** Minimum possible score */
+    resultValueMin?: number | null;
+    /** Maximum possible score */
+    resultValueMax?: number | null;
+    /** Associated learning objectives */
+    learningObjectiveSet?: LearningObjectiveSet;
+}
+/**
+ * A result (grade) for a student on a line item.
+ *
+ * Results record the score a student received on an assignment.
+ */
+export interface Result extends Base {
+    /** Line item this result is for */
+    lineItem: Ref;
+    /** Student who received this grade */
+    student: Ref;
+    /** Class (optional, for context) */
+    class?: Ref | null;
+    /** Score scale used */
+    scoreScale?: Ref | null;
+    /** Status of the score */
+    scoreStatus: ScoreStatus;
+    /** Numeric score */
+    score?: number | null;
+    /** Text-based score */
+    textScore?: string | null;
+    /** Date the score was recorded */
+    scoreDate: string;
+    /** Teacher comment */
+    comment?: string | null;
+    /** Learning objective scores */
+    learningObjectiveSet?: LearningObjectiveSet;
+    /** Whether work is in progress */
+    inProgress?: string;
+    /** Whether work is incomplete */
+    incomplete?: string;
+    /** Whether submission was late */
+    late?: string;
+    /** Whether submission is missing */
+    missing?: string;
+}
+/**
+ * An assessment line item for standardized or formal assessments.
+ *
+ * Assessment line items are similar to line items but designed for
+ * formal assessments with more detailed tracking capabilities.
+ */
+export interface AssessmentLineItem extends Base {
+    /** Assessment title */
+    title: string;
+    /** Assessment description */
+    description?: string | null;
+    /** Class this assessment is for */
+    class?: Ref | null;
+    /** Parent assessment (for hierarchical assessments) */
+    parentAssessmentLineItem?: Ref | null;
+    /** Score scale */
+    scoreScale?: Ref | null;
+    /** Minimum possible score */
+    resultValueMin?: number | null;
+    /** Maximum possible score */
+    resultValueMax?: number | null;
+    /** Course component reference (proprietary extension) */
+    component?: Ref | null;
+    /** Component resource reference (proprietary extension) */
+    componentResource?: Ref | null;
+    /** Learning objectives */
+    learningObjectiveSet?: LearningObjectiveSet;
+    /** Course reference (proprietary extension) */
+    course?: Ref | null;
+}
+/**
+ * A result for an assessment line item.
+ */
+export interface AssessmentResult extends Base {
+    /** Assessment this result is for */
+    assessmentLineItem: Ref;
+    /** Student who took the assessment */
+    student: Ref;
+    /** Numeric score */
+    score?: number | null;
+    /** Text-based score */
+    textScore?: string | null;
+    /** Date of the assessment */
+    scoreDate: string;
+    /** Score scale used */
+    scoreScale?: Ref | null;
+    /** Percentile ranking */
+    scorePercentile?: number | null;
+    /** Status of the score */
+    scoreStatus: ScoreStatus;
+    /** Teacher/grader comment */
+    comment?: string | null;
+    /** Learning objective scores */
+    learningObjectiveSet?: LearningObjectiveSet;
+    /** Whether assessment is in progress */
+    inProgress?: string | null;
+    /** Whether assessment is incomplete */
+    incomplete?: string | null;
+    /** Whether submission was late */
+    late?: string | null;
+    /** Whether assessment is missing */
+    missing?: string | null;
+}
+/**
+ * Input for creating a new line item.
+ */
+export interface LineItemCreateInput {
+    /** Title of the assignment */
+    title: string;
+    /** Class this line item belongs to */
+    class: Ref;
+    /** School */
+    school: Ref;
+    /** Category for this line item */
+    category: Ref;
+    /** Date the assignment was given (ISO 8601 datetime, e.g., "2024-09-01T00:00:00Z") */
+    assignDate: string;
+    /** Due date for the assignment (ISO 8601 datetime, e.g., "2024-09-15T00:00:00Z") */
+    dueDate: string;
+    /** Status */
+    status: 'active' | 'tobedeleted';
+    /** Client-supplied sourcedId (optional) */
+    sourcedId?: string;
+    /** Description of the assignment */
+    description?: string | null;
+    /** Grading period */
+    gradingPeriod?: Ref | null;
+    /** Academic session */
+    academicSession?: Ref | null;
+    /** Score scale to use for grading */
+    scoreScale?: Ref | null;
+    /** Minimum possible score */
+    resultValueMin?: number | null;
+    /** Maximum possible score */
+    resultValueMax?: number | null;
+    /** Associated learning objectives */
+    learningObjectiveSet?: LearningObjectiveSet;
+}
+/**
+ * Input for creating a new result.
+ */
+export interface ResultCreateInput {
+    /** Line item this result is for */
+    lineItem: Ref;
+    /** Student who received this grade */
+    student: Ref;
+    /** Date the score was recorded */
+    scoreDate: string;
+    /** Status of the score */
+    scoreStatus: ScoreStatus;
+    /** Status */
+    status: 'active' | 'tobedeleted';
+    /** Client-supplied sourcedId (optional) */
+    sourcedId?: string;
+    /** Class (optional, for context) */
+    class?: Ref | null;
+    /** Score scale used */
+    scoreScale?: Ref | null;
+    /** Numeric score */
+    score?: number | null;
+    /** Text-based score */
+    textScore?: string | null;
+    /** Teacher comment */
+    comment?: string | null;
+    /** Learning objective scores */
+    learningObjectiveSet?: LearningObjectiveSet;
+}
+//# sourceMappingURL=gradebook.d.ts.map

package/dist/types/gradebook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gradebook.d.ts","sourceRoot":"","sources":["../../src/types/gradebook.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,KAAK,EAAE,IAAI,EAAE,oBAAoB,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAA;AAE7D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAA;IACpB,iDAAiD;IACjD,YAAY,EAAE,MAAM,CAAA;IACpB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI;IACvC,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAA;IACb,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kCAAkC;IAClC,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,mCAAmC;IACnC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACnB,gCAAgC;IAChC,eAAe,CAAC,EAAE,eAAe,EAAE,CAAA;IACnC,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,IAAI;IACrC,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,aAAa;IACb,MAAM,EAAE,QAAQ,GAAG,aAAa,CAAA;IAChC,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAS,SAAQ,IAAI;IACrC,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAA;IACf,sCAAsC;IACtC,KAAK,EAAE,GAAG,CAAA;IACV,aAAa;IACb,MAAM,EAAE,GAAG,CAAA;IACX,kCAAkC;IAClC,QAAQ,EAAE,GAAG,CAAA;IACb,qBAAqB;IACrB,aAAa,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAC1B,uBAAuB;IACvB,eAAe,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAC5B,qCAAqC;IACrC,UAAU,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACvB,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,qCAAqC;IACrC,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAO,SAAQ,IAAI;IACnC,mCAAmC;IACnC,QAAQ,EAAE,GAAG,CAAA;IACb,sCAAsC;IACtC,OAAO,EAAE,GAAG,CAAA;IACZ,oCAAoC;IACpC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAClB,uBAAuB;IACvB,UAAU,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACvB,0BAA0B;IAC1B,WAAW,EAAE,WAAW,CAAA;IACxB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gCAAgC;IAChC,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI;IAC/C,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mCAAmC;IACnC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAClB,uDAAuD;IACvD,wBAAwB,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACrC,kBAAkB;IAClB,UAAU,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACvB,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,yDAAyD;IACzD,SAAS,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACtB,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAC9B,0BAA0B;IAC1B,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C,+CAA+C;IAC/C,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,IAAI;IAC7C,oCAAoC;IACpC,kBAAkB,EAAE,GAAG,CAAA;IACvB,sCAAsC;IACtC,OAAO,EAAE,GAAG,CAAA;IACZ,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,uBAAuB;IACvB,UAAU,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACvB,yBAAyB;IACzB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,0BAA0B;IAC1B,WAAW,EAAE,WAAW,CAAA;IACxB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gCAAgC;IAChC,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,sCAAsC;IACtC,KAAK,EAAE,GAAG,CAAA;IACV,aAAa;IACb,MAAM,EAAE,GAAG,CAAA;IACX,kCAAkC;IAClC,QAAQ,EAAE,GAAG,CAAA;IACb,sFAAsF;IACtF,UAAU,EAAE,MAAM,CAAA;IAClB,oFAAoF;IACpF,OAAO,EAAE,MAAM,CAAA;IACf,aAAa;IACb,MAAM,EAAE,QAAQ,GAAG,aAAa,CAAA;IAChC,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,qBAAqB;IACrB,aAAa,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAC1B,uBAAuB;IACvB,eAAe,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAC5B,qCAAqC;IACrC,UAAU,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACvB,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,qCAAqC;IACrC,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,mCAAmC;IACnC,QAAQ,EAAE,GAAG,CAAA;IACb,sCAAsC;IACtC,OAAO,EAAE,GAAG,CAAA;IACZ,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,0BAA0B;IAC1B,WAAW,EAAE,WAAW,CAAA;IACxB,aAAa;IACb,MAAM,EAAE,QAAQ,GAAG,aAAa,CAAA;IAChC,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oCAAoC;IACpC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IAClB,uBAAuB;IACvB,UAAU,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;IACvB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gCAAgC;IAChC,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;CAC3C"}

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * OneRoster Types
+ *
+ * All types for the OneRoster SDK.
+ */
+export * from './base';
+export * from './callable';
+export * from './client';
+export * from './filters';
+export * from './gradebook';
+export * from './resources';
+export * from './rostering';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,QAAQ,CAAA;AACtB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA"}

package/dist/types/resources.d.ts

@@ -0,0 +1,191 @@
+/**
+ * OneRoster Resources Types
+ *
+ * Types for digital learning resources and content.
+ */
+import type { LessonType } from '@timeback/types';
+import type { Base, LearningObjectiveSet, Ref } from './base';
+/**
+ * Resource type - determines which path prefix to use.
+ */
+export type ResourceType = 'rostering' | 'gradebook' | 'resources';
+/**
+ * Common metadata fields shared across all resource types.
+ */
+export interface BaseResourceMetadata {
+    /** Academic subject area (e.g., "Math", "Science", "Language") */
+    subject?: string;
+    /** Array or range of grade levels (e.g., ["03", "04"]) */
+    grades?: string[];
+    /** Language of the content, using standard IETF BCP 47 codes (e.g., "en-US") */
+    language?: string;
+    /** Experience points (XP) assigned for completing this resource */
+    xp?: number;
+    /** Learning objectives this resource is aligned to */
+    learningObjectiveSet?: LearningObjectiveSet;
+    /** Array of topic-related tags or important terms covered by the content */
+    keywords?: string[];
+    /** Direct content URL or support URL */
+    url?: string;
+    /** Estimated seconds for a student to consume the content */
+    timeLength?: number;
+    /** UI label for the activity badge (e.g., "Article", "Exercise", "Quiz", "Video"). */
+    activityType?: string;
+    /** Extensible for custom vendor-specific fields */
+    [key: string]: unknown;
+}
+/**
+ * Metadata for QTI (IMS Question and Test Interoperability) resources.
+ */
+export interface QtiResourceMetadata extends BaseResourceMetadata {
+    type: 'qti';
+    /** Specific QTI type: "qti-question", "qti-test", "qti-test-bank", "qti-stimulus" */
+    subType?: 'qti-question' | 'qti-test' | 'qti-test-bank' | 'qti-stimulus';
+}
+/**
+ * Metadata for textual resources (PDFs, eBooks, etc.).
+ */
+export interface TextualResourceMetadata extends BaseResourceMetadata {
+    type: 'text';
+    /** File or content format (e.g., "pdf", "epub", "docx", "html") */
+    format?: string;
+    /** Name of the person or organization that created the content */
+    author?: string;
+    /** Number of pages if applicable */
+    pageCount?: number;
+    /** Number of words in the content */
+    wordLength?: number;
+}
+/**
+ * Metadata for audio recordings.
+ */
+export interface AudioResourceMetadata extends BaseResourceMetadata {
+    type: 'audio';
+    /** Length of the audio in HH:MM:SS format */
+    duration?: string;
+    /** Audio format (e.g., "mp3", "wav") */
+    format?: string;
+    /** Name of the speaker or narrator */
+    speaker?: string;
+}
+/**
+ * Metadata for video content.
+ */
+export interface VideoResourceMetadata extends BaseResourceMetadata {
+    type: 'video';
+    /** Length of the video in HH:MM:SS format */
+    duration?: string;
+    /** Indicates if closed captions are available */
+    captionsAvailable?: boolean;
+    /** Video format (e.g., "mp4", "webm", "mov") */
+    format?: string;
+}
+/**
+ * Metadata for interactive 3rd party tools (Desmos, LTI apps, etc.).
+ */
+export interface InteractiveResourceMetadata extends BaseResourceMetadata {
+    type: 'interactive';
+    /** The URL used to launch the tool, often via LTI or similar protocols */
+    launchUrl?: string;
+    /** Name of the external tool provider (e.g., "Desmos", "Khan Academy") */
+    toolProvider?: string;
+    /** Teaching method supported (e.g., "exploratory", "direct-instruction") */
+    instructionalMethod?: string;
+}
+/**
+ * Metadata for visual resources (images, diagrams, etc.).
+ */
+export interface VisualResourceMetadata extends BaseResourceMetadata {
+    type: 'visual';
+    /** Image format (e.g., "png", "jpeg", "svg", "pdf") */
+    format?: string;
+    /** Dimensions in pixels (e.g., "1920x1080") */
+    resolution?: string;
+}
+/**
+ * Metadata for structured course materials.
+ */
+export interface CourseMaterialResourceMetadata extends BaseResourceMetadata {
+    type: 'course-material';
+    /** Material classification: "unit", "course", "resource-collection" */
+    subType?: 'unit' | 'course' | 'resource-collection';
+    /** Name of the person or organization who created the material */
+    author?: string;
+    /** File format (e.g., "docx", "pdf", "cc") */
+    format?: string;
+    /** Teaching method supported (e.g., "direct-instruction", "project-based") */
+    instructionalMethod?: string;
+}
+/**
+ * Metadata for a collection of assessments served in sequence.
+ */
+export interface AssessmentBankResourceMetadata extends BaseResourceMetadata {
+    type: 'assessment-bank';
+    /** Array of individual test Resource IDs included in this bank */
+    resources: string[];
+}
+/**
+ * Union of all valid resource metadata types.
+ * Uses the `type` field as a discriminator.
+ */
+export type ResourceMetadata = QtiResourceMetadata | TextualResourceMetadata | AudioResourceMetadata | VideoResourceMetadata | InteractiveResourceMetadata | VisualResourceMetadata | CourseMaterialResourceMetadata | AssessmentBankResourceMetadata | BaseResourceMetadata;
+/**
+ * A digital learning resource (content, activity, or material).
+ *
+ * Resources represent external content that can be assigned to
+ * students through courses and classes.
+ */
+export interface Resource extends Base {
+    /** Resource title */
+    title: string;
+    /** Roles this resource is intended for */
+    roles?: ('primary' | 'secondary')[];
+    /** Importance level of this resource */
+    importance?: 'primary' | 'secondary';
+    /** Vendor's identifier for this resource */
+    vendorResourceId: string;
+    /** Vendor identifier */
+    vendorId?: string;
+    /** Application identifier */
+    applicationId?: string;
+    /** Content-specific metadata */
+    metadata?: ResourceMetadata | null;
+}
+/**
+ * A resource linked to a course component.
+ *
+ * Component resources map digital content to specific parts
+ * of a course structure.
+ */
+export interface ComponentResource extends Base {
+    /** Resource title */
+    title: string;
+    /** Course component this resource belongs to */
+    courseComponent: Ref;
+    /** The resource being linked */
+    resource: Ref;
+    /** Display order within the component */
+    sortOrder?: number;
+    /** Type of lesson (proprietary extension) */
+    lessonType?: LessonType;
+}
+/**
+ * Input for creating a new component resource.
+ */
+export interface ComponentResourceCreateInput {
+    /** Resource title */
+    title: string;
+    /** Course component this resource belongs to */
+    courseComponent: Ref;
+    /** The resource being linked */
+    resource: Ref;
+    /** Status */
+    status: 'active' | 'tobedeleted';
+    /** Client-supplied sourcedId (optional) */
+    sourcedId?: string;
+    /** Display order within the component */
+    sortOrder?: number;
+    /** Type of lesson */
+    lessonType?: LessonType | null;
+}
+//# sourceMappingURL=resources.d.ts.map

package/dist/types/resources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/types/resources.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,IAAI,EAAE,oBAAoB,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAA;AAE7D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAA;AAElE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,gFAAgF;IAChF,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mEAAmE;IACnE,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,sDAAsD;IACtD,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,wCAAwC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,6DAA6D;IAC7D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,sFAAsF;IACtF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,mDAAmD;IACnD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAChE,IAAI,EAAE,KAAK,CAAA;IACX,qFAAqF;IACrF,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,eAAe,GAAG,cAAc,CAAA;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACpE,IAAI,EAAE,MAAM,CAAA;IACZ,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IAClE,IAAI,EAAE,OAAO,CAAA;IACb,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IAClE,IAAI,EAAE,OAAO,CAAA;IACb,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB;IACxE,IAAI,EAAE,aAAa,CAAA;IACnB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;IACnE,IAAI,EAAE,QAAQ,CAAA;IACd,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IAC3E,IAAI,EAAE,iBAAiB,CAAA;IACvB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,qBAAqB,CAAA;IACnD,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IAC3E,IAAI,EAAE,iBAAiB,CAAA;IACvB,kEAAkE;IAClE,SAAS,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GACzB,mBAAmB,GACnB,uBAAuB,GACvB,qBAAqB,GACrB,qBAAqB,GACrB,2BAA2B,GAC3B,sBAAsB,GACtB,8BAA8B,GAC9B,8BAA8B,GAC9B,oBAAoB,CAAA;AAEvB;;;;;GAKG;AACH,MAAM,WAAW,QAAS,SAAQ,IAAI;IACrC,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,0CAA0C;IAC1C,KAAK,CAAC,EAAE,CAAC,SAAS,GAAG,WAAW,CAAC,EAAE,CAAA;IACnC,wCAAwC;IACxC,UAAU,CAAC,EAAE,SAAS,GAAG,WAAW,CAAA;IACpC,4CAA4C;IAC5C,gBAAgB,EAAE,MAAM,CAAA;IACxB,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6BAA6B;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;CAClC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,IAAI;IAC9C,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,gDAAgD;IAChD,eAAe,EAAE,GAAG,CAAA;IACpB,gCAAgC;IAChC,QAAQ,EAAE,GAAG,CAAA;IACb,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,UAAU,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC5C,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,gDAAgD;IAChD,eAAe,EAAE,GAAG,CAAA;IACpB,gCAAgC;IAChC,QAAQ,EAAE,GAAG,CAAA;IACb,aAAa;IACb,MAAM,EAAE,QAAQ,GAAG,aAAa,CAAA;IAChC,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qBAAqB;IACrB,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;CAC9B"}