@instructure/platform-modules 0.3.0 → 0.4.0

package/dist/types/domain.d.ts

@@ -1,68 +1,22 @@
 import { z } from 'zod';
 import { CompletionRequirementTypeSchema, ModuleItemStatusSchema, ModuleItemTypeSchema, ModuleStatusSchema } from './enums';
-/**
- * The normalized domain model shared by every host and every transport.
- *
- * This is deliberately smaller than what either Canvas LMS or Canvas Career
- * fetches today: it is the *intersection* of what both need to render a
- * modules page. Anything host-specific (blueprint locks, mastery paths,
- * assignment overrides) rides in `extensions` rather than widening the model,
- * so a host can never make the shared contract depend on its own UI.
- *
- * Three normalization rules hold at every adapter boundary:
- *
- *   1. Ids are strings. GraphQL hands back `_id`/`id`, REST hands back numbers.
- *   2. `published` is always populated. REST omits the field for students,
- *      which means "published"; the adapter resolves that, not the caller.
- *   3. Item types are one closed enum. Canvas GraphQL distinguishes new quizzes
- *      with `isNewQuiz`, REST with `quiz_lti`; both collapse to `'quiz'` here.
- *      Every enum in this file is inferred from `./enums`, so the type and the
- *      runtime validator can never disagree.
- */
-/**
- * Every closed enum below is inferred from its Zod schema in `./enums`, never
- * written out twice. See that file for the members, where they come from, and
- * the runtime crash the single source of truth prevents.
- */
 export type ModuleItemType = z.infer<typeof ModuleItemTypeSchema>;
-/** Per-item state, from the designer's annotation. @see ./enums */
 export type ModuleItemStatus = z.infer<typeof ModuleItemStatusSchema>;
-/** Per-module rollup, from the designer's annotation. @see ./enums */
 export type ModuleStatus = z.infer<typeof ModuleStatusSchema>;
-/**
- * A student's progress through a module.
- *
- * Optional throughout: teacher and anonymous views have no progression, and
- * an adapter that doesn't fetch it must leave this undefined rather than
- * fabricate zeroes — "0 of 4 requirements met" and "we didn't ask" are
- * different things, and only one of them should render a progress bar.
- */
 export interface ModuleProgress {
     status: ModuleStatus;
-    /** Requirements the student has satisfied. */
     requirementsMet: number;
-    /** Requirements the module defines. Mirrors `Module.requirementCount`. */
+    /** Mirrors `Module.requirementCount`. */
     requirementCount: number;
     /** 0–100, precomputed so every host rounds it the same way. */
     percentComplete: number;
-    /** Latest due date across the module's items; drives the header byline. */
     latestDueAt?: string | null;
-    /** Items past due and unsubmitted. Drives the "Missing" filter chip. */
+    /** Items past due and unsubmitted. */
     missingCount: number;
 }
-/** The six types Canvas validates, plus `unknown` for forward compat. @see ./enums */
 export type CompletionRequirementType = z.infer<typeof CompletionRequirementTypeSchema>;
-/** A completion requirement attached to a module item. */
 export interface CompletionRequirement {
-    /**
-     * Id of the module **item** this requirement applies to — not an id of the
-     * requirement itself, which Canvas does not give one.
-     *
-     * Named `itemId` rather than `id` because that join is the non-obvious part:
-     * `ModuleCompletionRequirement.id` on the wire is the content tag id, which is
-     * what lets `completionRequirements` be matched against `ModuleItem.id` and
-     * against `ModuleProgression.requirementsMet`.
-     */
+    /** Canvas's `ModuleCompletionRequirement.id` is the content tag id, i.e. the item id. */
     itemId: string;
     type: CompletionRequirementType;
     minScore?: number | null;
@@ -75,65 +29,56 @@ export interface ModuleItem {
     type: ModuleItemType;
     /** 1-based position within the module, as Canvas reports it. */
     position: number;
-    /** Nesting depth used for visual indentation. */
     indent: number;
     published: boolean;
-    /** Canvas URL the item navigates to, when it has one. */
     url?: string | null;
     /** Canvas `ContentTag#new_tab`. Absent or null means the item opens in place. */
     newTab?: boolean | null;
     completionRequirement?: CompletionRequirement | null;
     /** ISO 8601. Overrides are already applied by the adapter when applicable. */
     dueAt?: string | null;
-    /**
-     * Student-view submission state. Undefined when not fetched (teacher view,
-     * anonymous, or an adapter that skips it) — distinct from `'not_started'`.
-     */
+    /** Undefined when not fetched — distinct from `'not_started'`. */
     status?: ModuleItemStatus;
-    /** Points the item is worth. Null for types that cannot be graded. */
+    /** Null for types that cannot be graded. */
     pointsPossible?: number | null;
-    /**
-     * Host-specific fields the shared contract does not model. Opaque to this
-     * package: passed through untouched, never merged, never read directly.
-     *
-     * Read it through the accessors in `types/extensions.ts` rather than by key —
-     * they own the `unknown` narrowing and document what is in here.
-     */
+    /** Read through the accessors in `types/extensions.ts`, never by bare key. */
     extensions?: Record<string, unknown>;
 }
+/**
+ * A module listed as a prerequisite of another.
+ *
+ * Mirrors Canvas's unfiltered `prerequisites` (`not_deleted`), which is a
+ * superset of the `active_prerequisites` that actually gate the lock, and is not
+ * filtered by viewer. It can name unpublished, unassigned and feature-hidden
+ * modules, so it is **not safe to render to a student unfiltered** and it is not
+ * the lock reason.
+ */
+export interface PrerequisiteModule {
+    id: string;
+    name: string;
+}
 export interface Module {
     id: string;
     name: string;
     position: number;
     published: boolean;
-    /**
-     * Total items in the module, independent of how many have been fetched.
-     * Drives the items-mode policy and any "showing 10 of 40" affordance.
-     */
+    /** Independent of how many have been fetched. */
     itemCount: number;
-    /**
-     * Present in `inline` mode, absent in `onDemand` mode. An empty array means
-     * "fetched, and the module is genuinely empty" — distinct from `undefined`,
-     * which means "not fetched yet".
-     */
+    /** `[]` is fetched-and-empty; `undefined` is not fetched. */
     items?: ModuleItem[];
     unlockAt?: string | null;
-    prerequisiteModuleIds: string[];
+    /** Unfiltered and not the lock reason — see `PrerequisiteModule`. */
+    prerequisiteModules: PrerequisiteModule[];
     requirementCount?: number | null;
     requireSequentialProgress: boolean;
     completionRequirements?: CompletionRequirement[];
     /**
-     * The student's progress. Undefined in teacher/anonymous views.
-     *
-     * Module-level by design: the status pill, the progress bar, the header due
-     * date and every filter chip read from here, so the whole filter row works
-     * without any item having been fetched. That is what keeps `onDemand` mode
-     * viable on a 120-module course.
+     * Module-level by design: the pill, the bar and every filter chip read from here, so the
+     * filter row works with no item fetched. That is what keeps `onDemand` viable.
      */
     progress?: ModuleProgress;
     extensions?: Record<string, unknown>;
 }
-/** Relay-style cursor pagination, normalized across GraphQL and REST. */
 export interface PageInfo {
     hasNextPage: boolean;
     endCursor: string | null;

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

@@ -1 +1 @@
-{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../../src/types/domain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,KAAK,EACV,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE,mEAAmE;AACnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAErE,sEAAsE;AACtE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAE7D;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,YAAY,CAAA;IACpB,8CAA8C;IAC9C,eAAe,EAAE,MAAM,CAAA;IACvB,0EAA0E;IAC1E,gBAAgB,EAAE,MAAM,CAAA;IACxB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,CAAA;IACvB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,wEAAwE;IACxE,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,sFAAsF;AACtF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAEvF,0DAA0D;AAC1D,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,yBAAyB,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,cAAc,CAAA;IACpB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,OAAO,CAAA;IAClB,yDAAyD;IACzD,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iFAAiF;IACjF,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpD,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAiBrB;;;OAGG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,sEAAsE;IACtE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,qBAAqB,EAAE,MAAM,EAAE,CAAA;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,yBAAyB,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAChD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,yEAAyE;AACzE,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,QAAQ,EAAE,QAAQ,CAAA;CACnB"}
+{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../../src/types/domain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,KAAK,EACV,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,SAAS,CAAA;AAEhB,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAErE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAI7D,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,YAAY,CAAA;IACpB,eAAe,EAAE,MAAM,CAAA;IACvB,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAA;IACxB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,sCAAsC;IACtC,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAEvF,MAAM,WAAW,qBAAqB;IACpC,yFAAyF;IACzF,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,yBAAyB,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,cAAc,CAAA;IACpB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,OAAO,CAAA;IAClB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iFAAiF;IACjF,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpD,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,kEAAkE;IAClE,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,4CAA4C;IAC5C,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,OAAO,CAAA;IAClB,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAA;IACjB,6DAA6D;IAC7D,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,qEAAqE;IACrE,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;IACzC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,yBAAyB,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAChD;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,QAAQ,EAAE,QAAQ,CAAA;CACnB"}

package/dist/types/enums.d.ts

@@ -1,30 +1,4 @@
 import { z } from 'zod';
-/**
- * Every closed enum in the contract, defined **once**, as a Zod schema.
- *
- * The types in `domain.ts` are `z.infer`red from these rather than hand-written
- * beside them. That inversion is the point, and it fixes a trap: when the union
- * and the `z.enum` were two separate lists, the two ways of desynchronizing them
- * behaved differently.
- *
- *   - Add a member to the `z.enum` but not the union → compile error. Loud.
- *   - Add a member to the union but not the `z.enum` → **compiles clean**. The UI
- *     can switch on it, an adapter can return it, tests pass. Then real data
- *     arrives, `ModuleItemSchema.parse()` throws "invalid enum value", and the
- *     modules page dies in the browser.
- *
- * Not hypothetical: `AiExperience` is a Canvas item type this adapter already
- * drops, so "someone adds `'ai_experience'` to `ModuleItemType`" is plausibly the
- * next change made to this file.
- *
- * They live in their own module, rather than in `schemas.ts`, so that `domain.ts`
- * can derive from them without a cycle — `schemas.ts` imports the object types
- * *from* `domain.ts` for its `z.ZodType<Module>` annotations.
- *
- * The explicit `z.ZodEnum<[...]>` annotations are required by the repo's
- * `isolatedDeclarations`; they duplicate the literals, but a mismatch there is a
- * compile error rather than a runtime one.
- */
 export declare const ModuleItemTypeSchema: z.ZodEnum<[
     'assignment',
     'quiz',
@@ -36,18 +10,20 @@ export declare const ModuleItemTypeSchema: z.ZodEnum<[
     'sub_header'
 ]>;
 /**
- * Per-item state as the student-view design labels it.
+ * Derived by the adapter from submission state, not stored on the item in Canvas. `complete`
+ * reports a met completion requirement; `excused` is distinct from `graded` because the
+ * student was exempted rather than assessed.
  *
- * Taken from the designer's annotation in the Modules Foundation file rather than
- * invented here: "Not started / In progress / Submitted / Graded / Missing /
- * Locked". Derived by the adapter from submission state, not stored on the item
- * in Canvas.
+ * No `unknown` member: an unnamed `gradingStatus` falls through to `not_started`, which
+ * understates rather than misreports.
  */
 export declare const ModuleItemStatusSchema: z.ZodEnum<[
     'not_started',
     'in_progress',
+    'complete',
     'submitted',
     'graded',
+    'excused',
     'missing',
     'locked'
 ]>;
@@ -70,16 +46,9 @@ export declare const ModuleStatusSchema: z.ZodEnum<[
     'locked'
 ]>;
 /**
- * The kinds of completion requirement Canvas can attach to a module item.
- *
- * Canvas validates the same six exhaustively when a teacher saves a module
- * (`app/models/context_module.rb:684,687`), so this is the whole set, not a
- * sample of it.
- *
- * `unknown` is the forward-compatibility member: a seventh type shipping in
- * Canvas must not make this package fail to parse a module. It lands here, the
- * label humanizes it, and nothing downstream has to handle a string it has never
- * heard of.
+ * Canvas validates the same six exhaustively on save (`app/models/context_module.rb:684,687`),
+ * so this is the whole set. `unknown` is the forward-compatibility member — a seventh type
+ * shipping in Canvas must not make this package fail to parse a module.
  */
 export declare const CompletionRequirementTypeSchema: z.ZodEnum<[
     'must_view',

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

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/types/enums.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAC1C;IACE,YAAY;IACZ,MAAM;IACN,YAAY;IACZ,MAAM;IACN,MAAM;IACN,cAAc;IACd,eAAe;IACf,YAAY;CACb,CAUD,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C;IAAC,aAAa;IAAE,aAAa;IAAE,WAAW;IAAE,QAAQ;IAAE,SAAS;IAAE,QAAQ;CAAC,CACU,CAAA;AAEtF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CACxC;IAAC,aAAa;IAAE,aAAa;IAAE,eAAe;IAAE,YAAY;IAAE,SAAS;IAAE,QAAQ;CAAC,CACU,CAAA;AAE9F;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD;IACE,WAAW;IACX,gBAAgB;IAChB,iBAAiB;IACjB,aAAa;IACb,WAAW;IACX,gBAAgB;IAChB,SAAS;CACV,CASD,CAAA"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/types/enums.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAC1C;IACE,YAAY;IACZ,MAAM;IACN,YAAY;IACZ,MAAM;IACN,MAAM;IACN,cAAc;IACd,eAAe;IACf,YAAY;CACb,CAUD,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C;IAAC,aAAa;IAAE,aAAa;IAAE,UAAU;IAAE,WAAW;IAAE,QAAQ;IAAE,SAAS;IAAE,SAAS;IAAE,QAAQ;CAAC,CAUjG,CAAA;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CACxC;IAAC,aAAa;IAAE,aAAa;IAAE,eAAe;IAAE,YAAY;IAAE,SAAS;IAAE,QAAQ;CAAC,CACU,CAAA;AAE9F;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD;IACE,WAAW;IACX,gBAAgB;IAChB,iBAAiB;IACjB,aAAa;IACb,WAAW;IACX,gBAAgB;IAChB,SAAS;CACV,CASD,CAAA"}

package/dist/types/extensions.d.ts

@@ -1,25 +1,4 @@
 import { ModuleItem } from './domain';
-/**
- * The `extensions` escape hatch, and the only sanctioned way through it.
- *
- * `Module.extensions` and `ModuleItem.extensions` are `Record<string, unknown>`
- * so a host can carry a field the shared contract does not model. The bag itself
- * is opaque to this package — never read, never merged, passed through as it
- * arrives — which is what stops one host's UI needs from widening the model
- * everyone else consumes.
- *
- * Opaque does not mean untyped at the edges. Every field that rides in here gets
- * a key constant and a reader in this file, so:
- *
- *   - the key is spelled once rather than stringly-typed at each use site,
- *   - the reader owns the `unknown` → narrow conversion, and a host that writes
- *     the wrong shape gets `null` rather than a render crash,
- *   - `grep` over this file answers "what is actually in extensions today".
- *
- * Keys are namespaced by the host that owns them. Two hosts adding a field they
- * both call `duration` must not collide, and an unprefixed key would make that
- * collision silent.
- */
 /**
  * Minutes Canvas Career estimates an item takes.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../../src/types/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qCAAqC,oCAAoC,CAAA;AAEtF;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,GAAG,MAAM,GAAG,IAAI,CAI/F;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,EAC/C,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAGrC"}
+{"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../../src/types/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qCAAqC,oCAAoC,CAAA;AAEtF;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,GAAG,MAAM,GAAG,IAAI,CAI/F;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,EAC/C,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAGrC"}

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export type { ModuleItemStatus, ModuleProgress, ModuleStatus, CompletionRequirement, CompletionRequirementType, Module, ModuleItem, ModuleItemsPage, ModuleItemType, ModulesPage, PageInfo, } from './domain';
+export type { ModuleItemStatus, ModuleProgress, ModuleStatus, CompletionRequirement, CompletionRequirementType, Module, ModuleItem, ModuleItemsPage, ModuleItemType, ModulesPage, PageInfo, PrerequisiteModule, } from './domain';
 export type { ModuleItemNavigation } from './navigation';
-export { CompletionRequirementSchema, CompletionRequirementTypeSchema, ModuleItemStatusSchema, ModuleProgressSchema, ModuleStatusSchema, ModuleItemSchema, ModuleItemsPageSchema, ModuleItemTypeSchema, ModuleSchema, ModulesPageSchema, PageInfoSchema, } from './schemas';
+export { CompletionRequirementSchema, CompletionRequirementTypeSchema, ModuleItemStatusSchema, ModuleProgressSchema, ModuleStatusSchema, ModuleItemSchema, ModuleItemsPageSchema, ModuleItemTypeSchema, ModuleSchema, ModulesPageSchema, PageInfoSchema, PrerequisiteModuleSchema, } from './schemas';
 export { EXT_CAREER_ESTIMATED_DURATION_MINUTES, getEstimatedDurationMinutes, withEstimatedDurationMinutes, } from './extensions';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,qBAAqB,EACrB,yBAAyB,EACzB,MAAM,EACN,UAAU,EACV,eAAe,EACf,cAAc,EACd,WAAW,EACX,QAAQ,GACT,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,YAAY,EACZ,iBAAiB,EACjB,cAAc,GACf,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,qCAAqC,EACrC,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,qBAAqB,EACrB,yBAAyB,EACzB,MAAM,EACN,UAAU,EACV,eAAe,EACf,cAAc,EACd,WAAW,EACX,QAAQ,EACR,kBAAkB,GACnB,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,wBAAwB,GACzB,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,qCAAqC,EACrC,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,cAAc,CAAA"}

package/dist/types/schemas.d.ts

@@ -1,36 +1,15 @@
 import { z } from 'zod';
-import { CompletionRequirement, Module, ModuleItem, ModuleItemsPage, ModuleProgress, ModulesPage, PageInfo } from './domain';
+import { CompletionRequirement, Module, ModuleItem, ModuleItemsPage, ModuleProgress, ModulesPage, PageInfo, PrerequisiteModule } from './domain';
 export { CompletionRequirementTypeSchema, ModuleItemStatusSchema, ModuleItemTypeSchema, ModuleStatusSchema, } from './enums';
-/**
- * Runtime schemas for the domain model.
- *
- * These validate at the *adapter boundary*, after normalization — not at the
- * wire. That is deliberate: the wire shapes differ per transport, but every
- * adapter must produce something that satisfies these, which is what makes
- * "one contract, two backends" enforceable rather than aspirational.
- *
- * Canvas LMS ships no response validation today and Canvas Career validates
- * its own REST shapes; neither can catch the case this catches — one adapter
- * quietly drifting from the other.
- */
 export declare const ModuleProgressSchema: z.ZodType<ModuleProgress>;
 export declare const CompletionRequirementSchema: z.ZodType<CompletionRequirement>;
 export declare const ModuleItemSchema: z.ZodType<ModuleItem>;
+export declare const PrerequisiteModuleSchema: z.ZodType<PrerequisiteModule>;
 export declare const ModuleSchema: z.ZodType<Module>;
 /**
- * Relay page info, with the dead-cursor combination refused.
- *
- * `hasNextPage: true` with a null `endCursor` type-checks but cannot be acted
- * on: the hooks report `hasNextPage` straight off the last page, while paging is
- * driven by `endCursor`, where null means "done" to TanStack Query. That pair
- * therefore renders a "Load more" control that can never load anything — the
- * silent-truncation failure this package exists to prevent, wearing a button.
- *
- * Relay's own spec makes it unreachable for a GraphQL adapter, but a REST
- * adapter parsing an RFC-5988 `Link` header is one plausible bug away from it:
- * see a `rel="next"`, set `hasNextPage`, then fail to extract the cursor from
- * the URL. The refine is what makes it unrepresentable rather than merely
- * unlikely.
+ * `hasNextPage: true` with a null `endCursor` type-checks but renders a "Load more" that can
+ * never load: paging is driven by `endCursor`, where null means "done" to TanStack Query.
+ * Relay makes it unreachable, but a REST adapter parsing a `Link` header is one bug away.
  */
 export declare const PageInfoSchema: z.ZodType<PageInfo>;
 export declare const ModulesPageSchema: z.ZodType<ModulesPage>;

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

@@ -1 +1 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../src/types/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EACV,qBAAqB,EACrB,MAAM,EACN,UAAU,EACV,eAAe,EACf,cAAc,EACd,WAAW,EACX,QAAQ,EACT,MAAM,UAAU,CAAA;AAWjB,OAAO,EACL,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAOzD,CAAA;AAEF,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAKvE,CAAA;AAEF,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAejD,CAAA;AAEF,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAczC,CAAA;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAU3C,CAAA;AAEJ,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAGnD,CAAA;AAEF,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAG3D,CAAA"}
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../src/types/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EACV,qBAAqB,EACrB,MAAM,EACN,UAAU,EACV,eAAe,EACf,cAAc,EACd,WAAW,EACX,QAAQ,EACR,kBAAkB,EACnB,MAAM,UAAU,CAAA;AAQjB,OAAO,EACL,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,SAAS,CAAA;AAEhB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAOzD,CAAA;AAEF,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAKvE,CAAA;AAEF,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAejD,CAAA;AAEF,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAGjE,CAAA;AAEF,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAczC,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAU3C,CAAA;AAEJ,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAGnD,CAAA;AAEF,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAG3D,CAAA"}

package/locales/en.json

@@ -24,14 +24,12 @@
     "one": "The only module in this course is loaded.",
     "other": "All %{count} modules in this course are loaded."
   },
-
   "filterGroupLabel": "Filter",
   "filterAll": "All",
   "filterInProgress": "In progress",
   "filterComplete": "Complete",
   "filterDueThisWeek": "Due this week",
   "filterMissing": "Missing",
-
   "lockedByline": "Locked until prerequisites are met",
   "moduleProgressScreenReaderLabel": "%{name} progress",
   "itemsLoadedAnnouncement": {
@@ -47,21 +45,20 @@
   "moduleUnpublishedBadge": "(unpublished)",
   "collapseModule": "Collapse %{name}",
   "expandModule": "Expand %{name}",
-
   "moduleStatusNotStarted": "Not started",
   "moduleStatusInProgress": "In progress",
   "moduleStatusAllSubmitted": "All items complete",
   "moduleStatusAllGraded": "All items graded",
   "moduleStatusMissing": "Missing",
   "moduleStatusLocked": "Locked",
-
   "itemStatusNotStarted": "Not started",
   "itemStatusInProgress": "In progress",
+  "itemStatusComplete": "Complete",
   "itemStatusSubmitted": "Submitted",
   "itemStatusGraded": "Graded",
+  "itemStatusExcused": "Excused",
   "itemStatusMissing": "Missing",
   "itemStatusLocked": "Locked",
-
   "itemTypeAssignment": "Assignment",
   "itemTypeQuiz": "Quiz",
   "itemTypeDiscussion": "Discussion",
@@ -70,7 +67,6 @@
   "itemTypeExternalUrl": "External URL",
   "itemTypeExternalTool": "External tool",
   "itemTypeSubHeader": "Text header",
-
   "requirementMustView": "View the item",
   "requirementMustSubmit": "Submit the assignment",
   "requirementMustContribute": "Contribute to the page",
@@ -80,11 +76,11 @@
   "requirementMinPercentageUnknown": "Score at least the minimum percentage",
   "requirementMinPercentage": "Score at least %{count}%",
   "requirementUnknown": "Complete the requirement",
-
   "dateTimeToday": "today, %{time}",
   "dateTimeYesterday": "yesterday, %{time}",
   "dateTimeTomorrow": "tomorrow, %{time}",
   "dateTimeWithDate": "%{date}, %{time}",
+  "timeWithZone": "%{time} (%{zone})",
   "dueByline": "Due %{when}",
   "unlockByline": "Will unlock on %{when}",
   "pointsAbbreviated": {
@@ -95,6 +91,10 @@
     "one": "%{percent}% | %{met} of %{count} requirement met",
     "other": "%{percent}% | %{met} of %{count} requirements met"
   },
+  "progressScreenReaderValue": {
+    "one": "%{percent}% complete, %{met} of %{count} requirement met",
+    "other": "%{percent}% complete, %{met} of %{count} requirements met"
+  },
   "durationMinutes": "%{count} min",
   "itemUnpublishedLabel": "Unpublished",
   "itemUntitled": "Untitled item",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/platform-modules",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -26,7 +26,8 @@
     "@instructure/ui-link": "^11.0.0",
     "@instructure/ui-menu": "^11.0.0",
     "@instructure/ui-pill": "^11.0.0",
-    "@instructure/ui-progress": "^11.0.0",
+    "@instructure/ui-progress": "^11.7.0",
+    "@instructure/ui-responsive": "^11.0.0",
     "@instructure/ui-spinner": "^11.0.0",
     "@instructure/ui-text": "^11.0.0",
     "@instructure/ui-text-input": "^11.0.0",
@@ -40,25 +41,27 @@
   "dependencies": {
     "graphql-tag": "^2.12.6",
     "p-limit": "^6.1.0",
-    "@instructure/platform-instui-bindings": "0.6.4"
+    "@instructure/platform-instui-bindings": "0.6.4",
+    "@instructure/platform-with-breakpoints": "0.3.0"
   },
   "devDependencies": {
-    "@instructure/emotion": "11.6.0",
-    "@instructure/ui-a11y-content": "11.6.0",
-    "@instructure/ui-alerts": "11.6.0",
-    "@instructure/ui-buttons": "11.6.0",
-    "@instructure/ui-flex": "11.6.0",
-    "@instructure/ui-heading": "11.6.0",
-    "@instructure/ui-icons": "11.6.0",
-    "@instructure/ui-link": "11.6.0",
-    "@instructure/ui-menu": "11.6.0",
-    "@instructure/ui-pill": "11.6.0",
-    "@instructure/ui-progress": "11.6.0",
-    "@instructure/ui-spinner": "11.6.0",
-    "@instructure/ui-text": "11.6.0",
-    "@instructure/ui-text-input": "11.6.0",
-    "@instructure/ui-themes": "11.6.0",
-    "@instructure/ui-view": "11.6.0",
+    "@instructure/emotion": "11.7.4",
+    "@instructure/ui-a11y-content": "11.7.4",
+    "@instructure/ui-alerts": "11.7.4",
+    "@instructure/ui-buttons": "11.7.4",
+    "@instructure/ui-flex": "11.7.4",
+    "@instructure/ui-heading": "11.7.4",
+    "@instructure/ui-icons": "11.7.4",
+    "@instructure/ui-link": "11.7.4",
+    "@instructure/ui-menu": "11.7.4",
+    "@instructure/ui-pill": "11.7.4",
+    "@instructure/ui-progress": "11.7.4",
+    "@instructure/ui-responsive": "11.7.4",
+    "@instructure/ui-spinner": "11.7.4",
+    "@instructure/ui-text": "11.7.4",
+    "@instructure/ui-text-input": "11.7.4",
+    "@instructure/ui-themes": "11.7.4",
+    "@instructure/ui-view": "11.7.4",
     "@storybook/react": "^10.0.8",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.0.0",