@instructure/platform-modules 0.4.0 → 1.0.0

package/dist/types/domain.d.ts

@@ -4,19 +4,16 @@ export type ModuleItemType = z.infer<typeof ModuleItemTypeSchema>;
 export type ModuleItemStatus = z.infer<typeof ModuleItemStatusSchema>;
 export type ModuleStatus = z.infer<typeof ModuleStatusSchema>;
 export interface ModuleProgress {
-    status: ModuleStatus;
+    status?: ModuleStatus;
     requirementsMet: number;
-    /** Mirrors `Module.requirementCount`. */
     requirementCount: number;
-    /** 0–100, precomputed so every host rounds it the same way. */
     percentComplete: number;
     latestDueAt?: string | null;
-    /** Items past due and unsubmitted. */
     missingCount: number;
+    incompleteCount: number;
 }
 export type CompletionRequirementType = z.infer<typeof CompletionRequirementTypeSchema>;
 export interface CompletionRequirement {
-    /** Canvas's `ModuleCompletionRequirement.id` is the content tag id, i.e. the item id. */
     itemId: string;
     type: CompletionRequirementType;
     minScore?: number | null;
@@ -27,32 +24,17 @@ export interface ModuleItem {
     moduleId: string;
     title: string;
     type: ModuleItemType;
-    /** 1-based position within the module, as Canvas reports it. */
     position: number;
     indent: number;
     published: boolean;
     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;
-    /** Undefined when not fetched — distinct from `'not_started'`. */
     status?: ModuleItemStatus;
-    /** Null for types that cannot be graded. */
     pointsPossible?: number | null;
-    /** 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;
@@ -62,20 +44,15 @@ export interface Module {
     name: string;
     position: number;
     published: boolean;
-    /** Independent of how many have been fetched. */
     itemCount: number;
-    /** `[]` is fetched-and-empty; `undefined` is not fetched. */
+    /** Absent means the adapter did not inline them. `[]` means it did, and found none. */
     items?: ModuleItem[];
     unlockAt?: string | null;
-    /** Unfiltered and not the lock reason — see `PrerequisiteModule`. */
     prerequisiteModules: PrerequisiteModule[];
     requirementCount?: number | null;
     requireSequentialProgress: boolean;
     completionRequirements?: CompletionRequirement[];
-    /**
-     * 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.
-     */
+    /** Absent means not fetched. Do not default it — that is not the same as nothing done. */
     progress?: ModuleProgress;
     extensions?: Record<string, unknown>;
 }

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,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"}
+{"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;AAE7D,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,YAAY,EAAE,MAAM,CAAA;IACpB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAEvF,MAAM,WAAW,qBAAqB;IACpC,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,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,OAAO,CAAA;IAClB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpD,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,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,SAAS,EAAE,MAAM,CAAA;IACjB,uFAAuF;IACvF,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,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,0FAA0F;IAC1F,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

@@ -9,14 +9,6 @@ export declare const ModuleItemTypeSchema: z.ZodEnum<[
     'external_tool',
     'sub_header'
 ]>;
-/**
- * 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.
- *
- * 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',
@@ -27,29 +19,15 @@ export declare const ModuleItemStatusSchema: z.ZodEnum<[
     'missing',
     'locked'
 ]>;
-/**
- * Per-module rollup state.
- *
- * Also from the design annotation: "Not started / In progress / All submitted /
- * All graded / Missing (1+ item past due) / Locked".
- *
- * NOTE: the mock renders a pill reading "All items complete" which is not in that
- * list. Treated as a presentation label over `all_graded`/`all_submitted` until
- * the designer says otherwise — flagged rather than guessed at.
- */
 export declare const ModuleStatusSchema: z.ZodEnum<[
     'not_started',
     'in_progress',
-    'all_submitted',
-    'all_graded',
+    'complete',
     'missing',
+    'incomplete',
+    'missing_and_incomplete',
     'locked'
 ]>;
-/**
- * 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',
     'must_mark_done',

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;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"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/types/enums.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,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,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,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CACxC;IACE,aAAa;IACb,aAAa;IACb,UAAU;IACV,SAAS;IACT,YAAY;IACZ,wBAAwB;IACxB,QAAQ;CACT,CASD,CAAA;AAEF,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,27 +1,5 @@
 import { ModuleItem } from './domain';
-/**
- * Minutes Canvas Career estimates an item takes.
- *
- * Career-only: Canvas LMS has no such field, does not fetch it, and renders
- * nothing for it. It lives here rather than on `ModuleItem` for exactly that
- * reason — a field that is null for one of the two hosts is not part of the
- * intersection the domain model is supposed to be.
- *
- * Canvas exposes it as an `ISO8601Duration` (`PT45M`); the adapter converts to
- * whole minutes, because that is the only unit either UI renders.
- */
 export declare const EXT_CAREER_ESTIMATED_DURATION_MINUTES = "career.estimatedDurationMinutes";
-/**
- * @returns the estimate in whole minutes, or `null` when the host did not supply
- * one — including when it supplied something that is not a positive number.
- */
 export declare function getEstimatedDurationMinutes(item: Pick<ModuleItem, 'extensions'>): number | null;
-/**
- * Merge an estimate into an extensions bag, or leave the bag absent.
- *
- * Returns `undefined` for a null estimate rather than an object holding a null,
- * so an item with nothing host-specific about it carries no `extensions` key at
- * all. That keeps the common case — every Canvas LMS item — free.
- */
 export declare function withEstimatedDurationMinutes(extensions: Record<string, unknown> | undefined, minutes: number | null | undefined): Record<string, unknown> | undefined;
 //# sourceMappingURL=extensions.d.ts.map

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;;;;;;;;;;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,eAAO,MAAM,qCAAqC,oCAAoC,CAAA;AAEtF,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,GAAG,MAAM,GAAG,IAAI,CAI/F;AAED,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/filterClause.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export type FilterTarget = 'module' | 'item';
+/** Must stay serializable: it goes in a query key. See `docs/adr/0008-filtering-and-the-data-layer.md`. */
+export interface FilterClause {
+    target: FilterTarget;
+    field: string;
+    op: 'eq' | 'contains';
+    value: string | boolean;
+}
+export declare const FilterClauseSchema: z.ZodType<FilterClause>;
+export type TargetCapabilities = Readonly<Record<string, ReadonlyArray<FilterClause['op']>>>;
+/** Absent means the transport serves no clause at all. */
+export interface FilterCapabilities {
+    module?: TargetCapabilities;
+    item?: TargetCapabilities;
+}
+export declare function servesClause(capabilities: FilterCapabilities | undefined, clause: FilterClause): boolean;
+//# sourceMappingURL=filterClause.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"filterClause.d.ts","sourceRoot":"","sources":["../../src/types/filterClause.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAA;AAE5C,2GAA2G;AAC3G,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,YAAY,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,IAAI,GAAG,UAAU,CAAA;IACrB,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CACxB;AAED,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAO5C,CAAA;AAEX,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;AAE5F,0DAA0D;AAC1D,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B,IAAI,CAAC,EAAE,kBAAkB,CAAA;CAC1B;AAED,wBAAgB,YAAY,CAC1B,YAAY,EAAE,kBAAkB,GAAG,SAAS,EAC5C,MAAM,EAAE,YAAY,GACnB,OAAO,CAIT"}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export type { ModuleItemStatus, ModuleProgress, ModuleStatus, CompletionRequirement, CompletionRequirementType, Module, ModuleItem, ModuleItemsPage, ModuleItemType, ModulesPage, PageInfo, PrerequisiteModule, } from './domain';
+export { type FilterCapabilities, type FilterClause, FilterClauseSchema, type FilterTarget, servesClause, type TargetCapabilities, } from './filterClause';
 export type { ModuleItemNavigation } from './navigation';
 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';

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,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"}
+{"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,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,kBAAkB,EAClB,KAAK,YAAY,EACjB,YAAY,EACZ,KAAK,kBAAkB,GACxB,MAAM,gBAAgB,CAAA;AACvB,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/navigation.d.ts

@@ -1,13 +1,7 @@
 import { MouseEvent } from 'react';
 import { ModuleItem } from './domain';
-/**
- * Optional host navigation for item rows. Titles link to `ModuleItem.url`
- * without it. Pass a stable reference: `ModuleItemRow` is memoized.
- */
 export interface ModuleItemNavigation {
-    /** Rewrite an item's href. Falls back to `item.url` when it returns nullish. */
     getItemHref?: (item: ModuleItem) => string | null | undefined;
-    /** Called on click, in addition to the href rather than instead of it. */
     onItemClick?: (item: ModuleItem, event: MouseEvent<HTMLAnchorElement>) => void;
 }
 //# sourceMappingURL=navigation.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../src/types/navigation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,gFAAgF;IAChF,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAE7D,0EAA0E;IAC1E,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAA;CAC/E"}
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../src/types/navigation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAE7D,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAA;CAC/E"}

package/dist/types/schemas.d.ts

@@ -6,11 +6,6 @@ export declare const CompletionRequirementSchema: z.ZodType<CompletionRequiremen
 export declare const ModuleItemSchema: z.ZodType<ModuleItem>;
 export declare const PrerequisiteModuleSchema: z.ZodType<PrerequisiteModule>;
 export declare const ModuleSchema: z.ZodType<Module>;
-/**
- * `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>;
 export declare const ModuleItemsPageSchema: z.ZodType<ModuleItemsPage>;

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,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"}
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../src/types/schemas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,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,CAQzD,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,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

@@ -10,6 +10,7 @@
   "expandAll": "Expand all",
   "collapseAll": "Collapse all",
   "searchScopeHint": "Search matches module names only — items of collapsed modules are not loaded.",
+  "filterScopeHint": "This filter runs on the modules loaded so far — load more to filter the rest of the course.",
   "modulesLoadErrorAlert": "Modules failed to load: %{message}",
   "modulesLoadingSpinnerLabel": "Loading modules",
   "noModulesEmptyState": "This course has no modules.",
@@ -17,6 +18,7 @@
     "one": "The only loaded module does not match this filter.",
     "other": "None of the %{count} loaded modules match this filter."
   },
+  "noFilterMatches": "No modules match this filter.",
   "clearFilters": "Clear filters",
   "loadMoreModulesLoading": "Loading more modules…",
   "loadMoreModules": "Load more modules (%{count} loaded)",
@@ -47,9 +49,10 @@
   "expandModule": "Expand %{name}",
   "moduleStatusNotStarted": "Not started",
   "moduleStatusInProgress": "In progress",
-  "moduleStatusAllSubmitted": "All items complete",
-  "moduleStatusAllGraded": "All items graded",
-  "moduleStatusMissing": "Missing",
+  "moduleStatusComplete": "All completed",
+  "moduleStatusMissing": "%{count} Missing",
+  "moduleStatusIncomplete": "%{count} Incomplete",
+  "moduleStatusMissingAndIncomplete": "%{missing} & %{incomplete}",
   "moduleStatusLocked": "Locked",
   "itemStatusNotStarted": "Not started",
   "itemStatusInProgress": "In progress",
@@ -67,6 +70,14 @@
   "itemTypeExternalUrl": "External URL",
   "itemTypeExternalTool": "External tool",
   "itemTypeSubHeader": "Text header",
+
+  "metaFieldTypeLabel": "Item type",
+  "metaFieldDueAtLabel": "Due date",
+  "metaFieldPointsLabel": "Points",
+  "metaFieldRequirementLabel": "Requirement",
+  "metaFieldDurationLabel": "Estimated duration",
+  "metaFieldPublishStateLabel": "Publish state",
+
   "requirementMustView": "View the item",
   "requirementMustSubmit": "Submit the assignment",
   "requirementMustContribute": "Contribute to the page",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/platform-modules",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -17,21 +17,22 @@
     "locales"
   ],
   "peerDependencies": {
+    "@instructure/emotion": "^11.0.0",
     "@instructure/ui-a11y-content": "^11.0.0",
-    "@instructure/ui-alerts": "^11.0.0",
-    "@instructure/ui-buttons": "^11.0.0",
-    "@instructure/ui-flex": "^11.0.0",
-    "@instructure/ui-heading": "^11.0.0",
+    "@instructure/ui-alerts": "^11.7.0",
+    "@instructure/ui-buttons": "^11.7.0",
+    "@instructure/ui-flex": "^11.7.0",
+    "@instructure/ui-heading": "^11.7.0",
     "@instructure/ui-icons": "^11.0.0",
-    "@instructure/ui-link": "^11.0.0",
-    "@instructure/ui-menu": "^11.0.0",
-    "@instructure/ui-pill": "^11.0.0",
+    "@instructure/ui-link": "^11.7.0",
+    "@instructure/ui-menu": "^11.7.0",
+    "@instructure/ui-pill": "^11.7.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",
-    "@instructure/ui-view": "^11.0.0",
+    "@instructure/ui-spinner": "^11.7.0",
+    "@instructure/ui-text": "^11.7.0",
+    "@instructure/ui-text-input": "^11.7.0",
+    "@instructure/ui-view": "^11.7.0",
     "@tanstack/react-query": "^5.0.0",
     "graphql": "^16.0.0",
     "react": "^18.0.0",
@@ -77,7 +78,7 @@
     "vite-plugin-dts": "^4.0.0",
     "vitest": "^4.0.0",
     "zod": "^3.23.8",
-    "@instructure/platform-mock-canvas-api": "0.5.0"
+    "@instructure/platform-mock-canvas-api": "0.5.1"
   },
   "scripts": {
     "build": "vite build",