@instructure/platform-mock-canvas-api 0.4.0 → 0.5.1

package/dist/fixtures/index.d.ts

@@ -1,5 +1,7 @@
 export { courses } from './courses';
 export { educatorAccessibilityCourseStatistics, mockEducatorAccessibilityStatistic, } from './educatorAccessibility';
+export type { CanvasCompletionRequirement, CanvasContentDetails, CanvasCourseModules, CanvasModule, CanvasModuleItem, CanvasModuleItemType, } from './modules';
+export { buildCanvasCourseModules, MODULE_ITEMS_INLINE_LIMIT, MODULES_SMALL_MODULE_COUNT, moduleScenariosByCourseId, modulesCourseEmpty, modulesCourseFatModule, modulesCourseLarge, modulesCourseSmall, } from './modules';
 export { stickerDescriptions } from './stickerDescriptions';
 export { stickerTranslations } from './stickerTranslations';
 export { submissions, submissionsStore } from './submissions';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EACL,qCAAqC,EACrC,kCAAkC,GACnC,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EACL,qCAAqC,EACrC,kCAAkC,GACnC,MAAM,yBAAyB,CAAA;AAChC,YAAY,EACV,2BAA2B,EAC3B,oBAAoB,EACpB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,EACzB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA"}

package/dist/fixtures/modules.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Canvas REST wire shapes for the modules API.
+ *
+ * These are deliberately *not* the normalised domain model that
+ * `@instructure/platform-modules` exposes — they are what
+ * `lib/api/v1/context_module.rb` actually puts on the wire: snake_case keys,
+ * numeric ids, CamelCase item types, `quiz_lti` for new quizzes, and an
+ * `estimated_duration` that Canvas Career serialises as an ISO-8601 duration.
+ * A REST adapter that can turn these into the domain model has been proven
+ * against the real shape rather than a tidied-up one.
+ *
+ * The four scenarios are sized to match the ones in
+ * `packages/modules/src/fixtures/scenarios.ts`, so a REST run and an in-memory
+ * run are comparable. Generation is deterministic: no `Math.random()`, no
+ * `Date.now()`.
+ *
+ * The generation *rules* are deliberately not identical, and it would be wrong to
+ * claim they are: these produce Canvas's wire shape, so the student state arrives
+ * as a module-level `state` string plus a per-item `completion_requirement.completed`
+ * flag, where the domain fixtures carry an already-derived `ModuleStatus` and
+ * `ModuleItemStatus`. Turning the former into the latter is exactly the job a REST
+ * adapter has to do, so the two must not agree too early.
+ *
+ * These fixtures cannot be imported from `@instructure/platform-modules` — that
+ * package depends on this one — so the shared numbers are restated here with the
+ * reason attached rather than derived.
+ */
+/** Canvas's item `type` values, as sent. */
+export type CanvasModuleItemType = 'Assignment' | 'Quiz' | 'Discussion' | 'Page' | 'File' | 'ExternalUrl' | 'ExternalTool' | 'SubHeader';
+export interface CanvasCompletionRequirement {
+    type: string;
+    /** Sent only for `min_score` (`lib/api/v1/context_module.rb:166`). */
+    min_score?: number;
+    /** Sent only for `min_percentage` (`lib/api/v1/context_module.rb:167`). */
+    min_percentage?: number;
+    /** Per-student: whether this requirement is in `progression.requirements_met`. */
+    completed: boolean;
+}
+export interface CanvasContentDetails {
+    points_possible?: number;
+    due_at?: string | null;
+    unlock_at?: string | null;
+    lock_at?: string | null;
+}
+export interface CanvasModuleItem {
+    id: number;
+    module_id: number;
+    position: number;
+    title: string;
+    indent: number;
+    type: CanvasModuleItemType;
+    content_id?: number;
+    html_url: string;
+    url?: string;
+    page_url?: string;
+    external_url?: string;
+    new_tab?: boolean;
+    published: boolean;
+    /** Set on new quizzes, which Canvas reports as `Assignment`. */
+    quiz_lti?: boolean;
+    completion_requirement?: CanvasCompletionRequirement;
+    content_details?: CanvasContentDetails;
+    /** Canvas Career only. ISO-8601 duration, e.g. `PT25M`. */
+    estimated_duration?: string;
+}
+export interface CanvasModule {
+    id: number;
+    name: string;
+    position: number;
+    unlock_at: string | null;
+    require_sequential_progress: boolean;
+    prerequisite_module_ids: number[];
+    published: boolean;
+    items_count: number;
+    items_url: string;
+    /**
+     * Present only when the module has at most `MODULE_ITEMS_INLINE_LIMIT`
+     * items. Above that Canvas omits the key entirely — see the note on the
+     * constant.
+     */
+    items?: CanvasModuleItem[];
+    state: string;
+    completed_at: string | null;
+    publish_final_grade: boolean;
+}
+export interface CanvasCourseModules {
+    courseId: number;
+    modules: CanvasModule[];
+    /** Every module's items, including the ones too large to be inlined. */
+    itemsByModuleId: Record<string, CanvasModuleItem[]>;
+}
+/**
+ * Canvas refuses to inline items for a module with more than this many
+ * (`Api::MAX_PER_PAGE`, via `lib/api/v1/context_module.rb`): the `items` key is
+ * absent from the response rather than truncated, and the client is expected
+ * to fall back to `items_url`. Mirrors `INLINE_ITEM_LIMIT` in
+ * `@instructure/platform-modules`.
+ */
+export declare const MODULE_ITEMS_INLINE_LIMIT = 100;
+/** Build a course's modules from a per-module item count, e.g. `[8, 250, 8]`. */
+export declare function buildCanvasCourseModules(courseId: number, itemCounts: readonly number[]): CanvasCourseModules;
+/**
+ * 7 modules × 8 items. Everything inlines; the course loads in ~2 requests.
+ *
+ * Seven, matching `courseSmall` in `packages/modules` — sized to `MODULE_STATUS_CYCLE.length`
+ * so no `ModuleStatus` is silently omitted.
+ */
+export declare const MODULES_SMALL_MODULE_COUNT = 7;
+export declare function modulesCourseSmall(): CanvasCourseModules;
+/** 120 modules × 25 items. Forces module-list pagination past `per_page=100`. */
+export declare function modulesCourseLarge(): CanvasCourseModules;
+/** 3 modules, the middle one 250 items — that module ships with no `items` key. */
+export declare function modulesCourseFatModule(): CanvasCourseModules;
+/** No modules. The empty state, on the wire. */
+export declare function modulesCourseEmpty(): CanvasCourseModules;
+/**
+ * Which scenario each course id serves. The ids line up with the `courses`
+ * fixture, so `GET /api/v1/courses/2/modules` is the 120-module course.
+ *
+ * Builders rather than values: `modulesCourseLarge()` is 3,000 item objects
+ * and nothing should pay for it at import time.
+ */
+export declare const moduleScenariosByCourseId: Record<string, () => CanvasCourseModules>;
+//# sourceMappingURL=modules.d.ts.map

package/dist/fixtures/modules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../src/fixtures/modules.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,4CAA4C;AAC5C,MAAM,MAAM,oBAAoB,GAC5B,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,MAAM,GACN,MAAM,GACN,aAAa,GACb,cAAc,GACd,WAAW,CAAA;AAEf,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2EAA2E;IAC3E,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,kFAAkF;IAClF,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,oBAAoB,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,gEAAgE;IAChE,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,sBAAsB,CAAC,EAAE,2BAA2B,CAAA;IACpD,eAAe,CAAC,EAAE,oBAAoB,CAAA;IACtC,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,2BAA2B,EAAE,OAAO,CAAA;IACpC,uBAAuB,EAAE,MAAM,EAAE,CAAA;IACjC,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mBAAmB,EAAE,OAAO,CAAA;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,wEAAwE;IACxE,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAA;CACpD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,MAAM,CAAA;AAuN5C,iFAAiF;AACjF,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,SAAS,MAAM,EAAE,GAC5B,mBAAmB,CAgBrB;AAED;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAE3C,wBAAgB,kBAAkB,IAAI,mBAAmB,CAKxD;AAED,iFAAiF;AACjF,wBAAgB,kBAAkB,IAAI,mBAAmB,CAKxD;AAED,mFAAmF;AACnF,wBAAgB,sBAAsB,IAAI,mBAAmB,CAE5D;AAED,gDAAgD;AAChD,wBAAgB,kBAAkB,IAAI,mBAAmB,CAExD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,mBAAmB,CAK/E,CAAA"}

package/dist/fixtures.js

@@ -1,4 +1,4 @@
-const i = [
+const I = [
   {
     id: "1",
     uuid: "WvAU2cWNVZjm0Dup4i36bSusZ4UReXfNVhBjxooC",
@@ -39,7 +39,7 @@ const i = [
     enrollment_term_id: "2",
     term: { id: "2", name: "Spring 2025" }
   }
-], a = (e = {}) => ({
+], D = (s = {}) => ({
   id: 1,
   course_id: 101,
   course_name: "Introduction to Biology",
@@ -51,8 +51,8 @@ const i = [
   workflow_state: "active",
   created_at: "2026-01-01T00:00:00Z",
   updated_at: "2026-01-02T00:00:00Z",
-  ...e
-}), c = [
+  ...s
+}), L = [
   {
     id: 1,
     course_id: 101,
@@ -92,7 +92,143 @@ const i = [
     course_code: "CHM301",
     published: !1
   }
-], r = {
+], k = 100, u = [
+  "assignment",
+  "quiz",
+  "discussion",
+  "page",
+  "file",
+  "external_url",
+  "external_tool",
+  "sub_header"
+], _ = [
+  "must_view",
+  "must_submit",
+  "must_contribute",
+  "must_mark_done",
+  "min_score",
+  "min_percentage"
+], f = ["assignment", "quiz", "discussion"], g = Date.UTC(2025, 0, 6), w = 864e5, l = (s) => new Date(g + s * w).toISOString(), m = ["unlocked", "started", "completed", "locked"], h = (s) => m[(s - 1) % m.length], A = (s, e) => {
+  const i = _[Math.floor(s / 3) % _.length], a = h(e), t = a === "completed" || a === "started" && s % 2 === 0;
+  return i === "min_score" ? { type: i, min_score: 10, completed: t } : i === "min_percentage" ? { type: i, min_percentage: 80, completed: t } : { type: i, completed: t };
+}, b = (s, e, i, a) => {
+  const t = i + 5e4;
+  switch (s) {
+    case "assignment":
+      return {
+        type: "Assignment",
+        content_id: t,
+        url: `/api/v1/courses/${e}/assignments/${t}`
+      };
+    case "quiz":
+      return Math.floor(a / u.length) % 2 === 0 ? {
+        type: "Quiz",
+        content_id: t,
+        url: `/api/v1/courses/${e}/quizzes/${t}`
+      } : {
+        type: "Assignment",
+        quiz_lti: !0,
+        content_id: t,
+        url: `/api/v1/courses/${e}/assignments/${t}`
+      };
+    case "discussion":
+      return {
+        type: "Discussion",
+        content_id: t,
+        url: `/api/v1/courses/${e}/discussion_topics/${t}`
+      };
+    case "page":
+      return {
+        type: "Page",
+        page_url: `page-${i}`,
+        url: `/api/v1/courses/${e}/pages/page-${i}`
+      };
+    case "file":
+      return { type: "File", content_id: t, url: `/api/v1/files/${t}` };
+    case "external_url":
+      return {
+        type: "ExternalUrl",
+        external_url: `https://example.com/resource/${i}`,
+        new_tab: !0
+      };
+    case "external_tool":
+      return {
+        type: "ExternalTool",
+        content_id: t,
+        external_url: `https://lti.example.com/launch/${i}`,
+        new_tab: !1
+      };
+    case "sub_header":
+      return { type: "SubHeader" };
+  }
+}, y = (s, e, i, a) => {
+  const t = u[a % u.length], o = e * 1e3 + i + 1, n = t === "sub_header", r = {
+    id: o,
+    module_id: e,
+    position: i + 1,
+    title: `${t} ${i + 1}`,
+    indent: i % 5 === 4 ? 1 : 0,
+    html_url: `/courses/${s}/modules/items/${o}`,
+    published: a % 7 !== 0,
+    ...b(t, s, o, a)
+  };
+  return a % 3 === 0 && !n && (r.completion_requirement = A(a, e)), f.includes(t) && a % 4 === 0 && (r.content_details = { points_possible: 10 + a % 5 * 5, due_at: l(a % 90) }), a % 37 === 0 && (r.estimated_duration = `PT${5 + a % 4 * 10}M`), r;
+}, S = (s, e, i) => {
+  const a = h(e), t = {
+    id: e,
+    name: `Module ${e}`,
+    position: e,
+    unlock_at: e % 5 === 0 ? l(e) : null,
+    require_sequential_progress: e % 6 === 0,
+    prerequisite_module_ids: e > 1 && e % 3 === 0 ? [e - 1] : [],
+    published: e % 4 !== 0,
+    // `items_count` is the true total, whether or not the items are inlined.
+    items_count: i.length,
+    items_url: `/api/v1/courses/${s}/modules/${e}/items`,
+    state: a,
+    // Canvas sets `completed_at` only on a completed progression
+    // (`app/models/context_module_progression.rb:57-61`).
+    completed_at: a === "completed" ? l(e + 30) : null,
+    publish_final_grade: !1
+  };
+  return i.length <= k && (t.items = i), t;
+};
+function c(s, e) {
+  const i = [], a = {};
+  let t = 0;
+  return e.forEach((o, n) => {
+    const r = n + 1, p = Array.from(
+      { length: o },
+      (Z, d) => y(s, r, d, t + d)
+    );
+    t += o, i.push(S(s, r, p)), a[String(r)] = p;
+  }), { courseId: s, modules: i, itemsByModuleId: a };
+}
+const T = 7;
+function v() {
+  return c(
+    1,
+    Array.from({ length: T }, () => 8)
+  );
+}
+function E() {
+  return c(
+    2,
+    Array.from({ length: 120 }, () => 25)
+  );
+}
+function C() {
+  return c(3, [8, 250, 8]);
+}
+function M() {
+  return c(4, []);
+}
+const O = {
+  1: v,
+  2: E,
+  3: C,
+  4: M
+}, B = {
   default: "A placeholder sticker with a smiley face and a plus sign.",
   star: "A sticker with a picture of a smiling star.",
   trophy: "A sticker with a picture of a golden trophy.",
@@ -144,13 +280,13 @@ const i = [
   tag: "A sticker with a picture of a clip-on identification tag.",
   presentation: "A sticker with a picture of a projector screen with presentation content on it.",
   column: "A sticker with a picture of a roman column."
-}, o = {
+}, x = {
   chooseASticker: "Choose a sticker",
   close: "Close",
   removeSticker: "Remove sticker",
   removedSticker: "Removed sticker",
   selectedSticker: "Selected sticker"
-}, t = [
+}, $ = [
   {
     id: "1",
     course_id: "1",
@@ -199,15 +335,23 @@ const i = [
     grade: "A+",
     score: 98
   }
-], s = new Map(
-  t.map((e) => [e.id, { ...e }])
+], q = new Map(
+  $.map((s) => [s.id, { ...s }])
 );
 export {
-  i as courses,
-  c as educatorAccessibilityCourseStatistics,
-  a as mockEducatorAccessibilityStatistic,
-  r as stickerDescriptions,
-  o as stickerTranslations,
-  t as submissions,
-  s as submissionsStore
+  T as MODULES_SMALL_MODULE_COUNT,
+  k as MODULE_ITEMS_INLINE_LIMIT,
+  c as buildCanvasCourseModules,
+  I as courses,
+  L as educatorAccessibilityCourseStatistics,
+  D as mockEducatorAccessibilityStatistic,
+  O as moduleScenariosByCourseId,
+  M as modulesCourseEmpty,
+  C as modulesCourseFatModule,
+  E as modulesCourseLarge,
+  v as modulesCourseSmall,
+  B as stickerDescriptions,
+  x as stickerTranslations,
+  $ as submissions,
+  q as submissionsStore
 };

package/dist/handlers/index.d.ts

@@ -1,8 +1,10 @@
 import { RequestHandler } from 'msw';
 import { courseHandlers } from './courses';
 import { educatorAccessibilityHandlers } from './educatorAccessibility';
+import { moduleHandlers } from './modules';
 import { submissionHandlers } from './submissions';
 import { userColorHandlers } from './userColors';
 export declare const handlers: RequestHandler[];
-export { courseHandlers, educatorAccessibilityHandlers, submissionHandlers, userColorHandlers };
+export { courseHandlers, educatorAccessibilityHandlers, moduleHandlers, submissionHandlers, userColorHandlers, };
+export { buildLinkHeader, resetModuleScenarios } from './modules';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/handlers/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAA;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,eAAO,MAAM,QAAQ,EAAE,cAAc,EAKpC,CAAA;AAED,OAAO,EAAE,cAAc,EAAE,6BAA6B,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/handlers/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAA;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,eAAO,MAAM,QAAQ,EAAE,cAAc,EAMpC,CAAA;AAED,OAAO,EACL,cAAc,EACd,6BAA6B,EAC7B,cAAc,EACd,kBAAkB,EAClB,iBAAiB,GAClB,CAAA;AACD,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA"}

package/dist/handlers/modules.d.ts

@@ -0,0 +1,11 @@
+import { RequestHandler } from 'msw';
+/** Drops any cached scenario, so a test can start from a clean fixture. */
+export declare function resetModuleScenarios(): void;
+/**
+ * An RFC-5988 `Link` header in Canvas's order: current, next, prev, first,
+ * last. `next` is absent on the final page — that absence is the only signal a
+ * client gets that it has reached the end.
+ */
+export declare function buildLinkHeader(url: URL, page: number, perPage: number, totalCount: number): string;
+export declare const moduleHandlers: RequestHandler[];
+//# sourceMappingURL=modules.d.ts.map

package/dist/handlers/modules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../src/handlers/modules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AAmDzC,2EAA2E;AAC3E,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C;AAgCD;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACjB,MAAM,CAQR;AASD,eAAO,MAAM,cAAc,EAAE,cAAc,EAuC1C,CAAA"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from './fixtures';
-export { courseHandlers, educatorAccessibilityHandlers, handlers, submissionHandlers, userColorHandlers, } from './handlers';
+export { buildLinkHeader, courseHandlers, educatorAccessibilityHandlers, handlers, moduleHandlers, resetModuleScenarios, submissionHandlers, userColorHandlers, } from './handlers';
 export type * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,OAAO,EACL,cAAc,EACd,6BAA6B,EAC7B,QAAQ,EACR,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,YAAY,CAAA;AACnB,mBAAmB,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,OAAO,EACL,eAAe,EACf,cAAc,EACd,6BAA6B,EAC7B,QAAQ,EACR,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,YAAY,CAAA;AACnB,mBAAmB,SAAS,CAAA"}

package/dist/index.js

@@ -1,70 +1,138 @@
-import { courses as c, educatorAccessibilityCourseStatistics as m, submissionsStore as u } from "./fixtures.js";
-import { mockEducatorAccessibilityStatistic as y, stickerDescriptions as _, stickerTranslations as S, submissions as h } from "./fixtures.js";
-import { http as i, HttpResponse as n } from "msw";
-const d = [
+import { courses as I, educatorAccessibilityCourseStatistics as _, moduleScenariosByCourseId as S, submissionsStore as m } from "./fixtures.js";
+import { MODULES_SMALL_MODULE_COUNT as F, MODULE_ITEMS_INLINE_LIMIT as R, buildCanvasCourseModules as O, mockEducatorAccessibilityStatistic as B, modulesCourseEmpty as G, modulesCourseFatModule as $, modulesCourseLarge as K, modulesCourseSmall as X, stickerDescriptions as Y, stickerTranslations as q, submissions as z } from "./fixtures.js";
+import { http as u, HttpResponse as r } from "msw";
+const j = [
   // GET /api/v1/courses
-  i.get("/api/v1/courses", () => n.json(c)),
+  u.get("/api/v1/courses", () => r.json(I)),
   // GET /api/v1/courses/:courseId  (courseId may be a numeric id or a `uuid:<uuid>` ref)
-  i.get("/api/v1/courses/:courseId", ({ params: e }) => {
-    const s = String(e.courseId).replace(/^uuid:/, ""), o = c.find((t) => t.id === s || t.uuid === s);
-    return o ? n.json(o) : n.json({ errors: [{ message: "Course not found" }] }, { status: 404 });
+  u.get("/api/v1/courses/:courseId", ({ params: e }) => {
+    const s = String(e.courseId).replace(/^uuid:/, ""), n = I.find((t) => t.id === s || t.uuid === s);
+    return n ? r.json(n) : r.json({ errors: [{ message: "Course not found" }] }, { status: 404 });
   })
-], b = [
-  i.get("/api/v1/users/:userId/educator_accessibility_course_statistics", () => n.json(m))
-], g = 300, l = [
+], P = [
+  u.get("/api/v1/users/:userId/educator_accessibility_course_statistics", () => r.json(_))
+], M = 10, k = 100, l = () => r.json(
+  { errors: [{ message: "The specified resource does not exist." }] },
+  {
+    status: 404
+  }
+), g = /* @__PURE__ */ new Map(), b = (e) => {
+  const s = g.get(e);
+  if (s) return s;
+  const n = S[e];
+  if (!n) return;
+  const t = n();
+  return g.set(e, t), t;
+};
+function H() {
+  g.clear();
+}
+const f = (e) => {
+  const s = Number.parseInt(e.searchParams.get("per_page") ?? "", 10), n = Number.parseInt(e.searchParams.get("page") ?? "", 10);
+  return {
+    perPage: Number.isFinite(s) && s > 0 ? Math.min(s, k) : M,
+    page: Number.isFinite(n) && n > 0 ? n : 1
+  };
+}, v = (e) => [...e.searchParams.getAll("include[]"), ...e.searchParams.getAll("include")].flatMap(
+  (s) => s.split(",")
+), y = (e, s, n) => {
+  const t = new URL(e.href);
+  return t.searchParams.set("page", String(s)), t.searchParams.set("per_page", String(n)), t.href;
+};
+function h(e, s, n, t) {
+  const o = Math.max(1, Math.ceil(t / n)), i = [["current", s]];
+  return s < o && i.push(["next", s + 1]), s > 1 && i.push(["prev", s - 1]), i.push(["first", 1], ["last", o]), i.map(([a, c]) => `<${y(e, c, n)}>; rel="${a}"`).join(",");
+}
+const L = (e) => {
+  const s = { ...e };
+  return delete s.items, s;
+}, A = [
+  // GET /api/v1/courses/:courseId/modules
+  u.get("/api/v1/courses/:courseId/modules", ({ params: e, request: s }) => {
+    const n = b(String(e.courseId));
+    if (!n) return l();
+    const t = new URL(s.url), { page: o, perPage: i } = f(t), a = v(t).includes("items"), c = (o - 1) * i, d = n.modules.slice(c, c + i).map((p) => a ? p : L(p));
+    return r.json(d, {
+      headers: { Link: h(t, o, i, n.modules.length) }
+    });
+  }),
+  // GET /api/v1/courses/:courseId/modules/:moduleId/items
+  u.get("/api/v1/courses/:courseId/modules/:moduleId/items", ({ params: e, request: s }) => {
+    const n = b(String(e.courseId));
+    if (!n) return l();
+    const t = String(e.moduleId), o = n.itemsByModuleId[t];
+    if (!o) return l();
+    const i = new URL(s.url), { page: a, perPage: c } = f(i), d = (a - 1) * c;
+    return r.json(o.slice(d, d + c), {
+      headers: { Link: h(i, a, c, o.length) }
+    });
+  })
+], C = 300, E = [
   // GET submission
-  i.get(
+  u.get(
     "/api/v1/courses/:courseId/assignments/:assignmentId/submissions/:submissionId",
     ({ params: e }) => {
-      const s = u.get(e.submissionId);
-      return s ? n.json(s) : n.json({ errors: [{ message: "Submission not found" }] }, { status: 404 });
+      const s = m.get(e.submissionId);
+      return s ? r.json(s) : r.json({ errors: [{ message: "Submission not found" }] }, { status: 404 });
     }
   ),
   // PATCH submission (update sticker)
-  i.patch(
+  u.patch(
     "/api/v1/courses/:courseId/assignments/:assignmentId/submissions/:submissionId",
     async ({ params: e, request: s }) => {
-      const { submissionId: o } = e, t = await s.json(), r = u.get(o);
-      return r ? (t.submission && "sticker" in t.submission && t.submission.sticker !== void 0 && (r.sticker = t.submission.sticker, u.set(o, r)), await new Promise((a) => setTimeout(a, g)), n.json(r)) : n.json({ errors: [{ message: "Submission not found" }] }, { status: 404 });
+      const { submissionId: n } = e, t = await s.json(), o = m.get(n);
+      return o ? (t.submission && "sticker" in t.submission && t.submission.sticker !== void 0 && (o.sticker = t.submission.sticker, m.set(n, o)), await new Promise((i) => setTimeout(i, C)), r.json(o)) : r.json({ errors: [{ message: "Submission not found" }] }, { status: 404 });
     }
   ),
   // GET all submissions for an assignment
-  i.get("/api/v1/courses/:courseId/assignments/:assignmentId/submissions", ({ params: e }) => {
-    const s = Array.from(u.values()).filter(
-      (o) => o.course_id === e.courseId && o.assignment_id === e.assignmentId
+  u.get("/api/v1/courses/:courseId/assignments/:assignmentId/submissions", ({ params: e }) => {
+    const s = Array.from(m.values()).filter(
+      (n) => n.course_id === e.courseId && n.assignment_id === e.assignmentId
     );
-    return n.json(s);
+    return r.json(s);
   })
-], p = [
+], w = [
   // PUT /api/v1/users/:userId/colors/:assetString  -> persist a course color
-  i.put("/api/v1/users/:userId/colors/:assetString", async ({ request: e }) => {
+  u.put("/api/v1/users/:userId/colors/:assetString", async ({ request: e }) => {
     const s = await e.json().catch(() => ({}));
-    return n.json({ hexcode: s.hexcode ?? "" });
+    return r.json({ hexcode: s.hexcode ?? "" });
   }),
   // PUT /api/v1/users/self/course_nicknames/:courseId  -> set a nickname
-  i.put("/api/v1/users/self/course_nicknames/:courseId", async ({ request: e }) => {
+  u.put("/api/v1/users/self/course_nicknames/:courseId", async ({ request: e }) => {
     const s = await e.json().catch(() => ({}));
-    return n.json({ nickname: s.nickname ?? "", name: s.nickname ?? "" });
+    return r.json({ nickname: s.nickname ?? "", name: s.nickname ?? "" });
   }),
   // DELETE /api/v1/users/self/course_nicknames/:courseId  -> clear a nickname
-  i.delete("/api/v1/users/self/course_nicknames/:courseId", () => n.json({ nickname: null, name: "" }))
-], j = [
-  ...d,
-  ...b,
-  ...l,
-  ...p
+  u.delete("/api/v1/users/self/course_nicknames/:courseId", () => r.json({ nickname: null, name: "" }))
+], N = [
+  ...j,
+  ...P,
+  ...A,
+  ...E,
+  ...w
 ];
 export {
-  d as courseHandlers,
-  c as courses,
-  m as educatorAccessibilityCourseStatistics,
-  b as educatorAccessibilityHandlers,
-  j as handlers,
-  y as mockEducatorAccessibilityStatistic,
-  _ as stickerDescriptions,
-  S as stickerTranslations,
-  l as submissionHandlers,
-  h as submissions,
-  u as submissionsStore,
-  p as userColorHandlers
+  F as MODULES_SMALL_MODULE_COUNT,
+  R as MODULE_ITEMS_INLINE_LIMIT,
+  O as buildCanvasCourseModules,
+  h as buildLinkHeader,
+  j as courseHandlers,
+  I as courses,
+  _ as educatorAccessibilityCourseStatistics,
+  P as educatorAccessibilityHandlers,
+  N as handlers,
+  B as mockEducatorAccessibilityStatistic,
+  A as moduleHandlers,
+  S as moduleScenariosByCourseId,
+  G as modulesCourseEmpty,
+  $ as modulesCourseFatModule,
+  K as modulesCourseLarge,
+  X as modulesCourseSmall,
+  H as resetModuleScenarios,
+  Y as stickerDescriptions,
+  q as stickerTranslations,
+  E as submissionHandlers,
+  z as submissions,
+  m as submissionsStore,
+  w as userColorHandlers
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/platform-mock-canvas-api",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -12,7 +12,7 @@
     },
     "./fixtures": {
       "types": "./dist/fixtures/index.d.ts",
-      "import": "./dist/fixtures/index.js"
+      "import": "./dist/fixtures.js"
     }
   },
   "files": [