canvas-lms-mcp 2.8.4 → 2.9.0

package/README.md

@@ -11,7 +11,7 @@
 
 MCP server for [Canvas LMS](https://www.instructure.com/canvas). Read courses, assignments, submissions, rubrics, quizzes; grade, comment, manage course content, and handle Canvas admin workflows from any AI agent.
 
-183 tools across Canvas courses, assignments, submissions, gradebook history, rubrics, quizzes, New Quizzes (LTI), files, users, groups, enrollments, discussions, modules, pages, calendar, conversations, peer reviews, accounts, analytics, outcomes, grading standards, grade projection, link audit, accessibility audit, content exports, content migrations, quiz accommodations, appointment groups, student workflows, student search, dashboard, instructor attention workflows, and health checks. Three deployment modes: stdio, HTTP, and library import.
+187 tools across Canvas courses, assignments, submissions, gradebook history, rubrics, quizzes, New Quizzes (LTI), files, users, groups, enrollments, discussions, modules, pages, calendar, conversations, peer reviews, accounts, analytics, outcomes, grading standards, grade projection, link audit, accessibility audit, content exports, content migrations, quiz accommodations, appointment groups, student workflows, student search, dashboard, instructor attention workflows, and health checks. Three deployment modes: stdio, HTTP, and library import.
 
 ## One-click install (Claude Desktop)
 
@@ -38,14 +38,14 @@ Click a badge to open Cursor or VS Code with canvas-lms-mcp pre-configured (plac
 /plugin install canvas-lms-mcp
 ```
 
-Installs the MCP server (via `npx canvas-lms-mcp`) and all 16 [Agent Skills](#agent-skills) in a single step, versioned and updatable through Claude Code's plugin manager. On enable, Claude Code prompts for your Canvas API token and base URL (and the optional FERPA pseudonymization settings). See the [Claude Code plugins reference](https://code.claude.com/docs/en/plugins-reference) for how marketplaces and plugin manifests work.
+Installs the MCP server (via `npx canvas-lms-mcp`) and all 17 [Agent Skills](#agent-skills) in a single step, versioned and updatable through Claude Code's plugin manager. On enable, Claude Code prompts for your Canvas API token and base URL (and the optional FERPA pseudonymization settings). See the [Claude Code plugins reference](https://code.claude.com/docs/en/plugins-reference) for how marketplaces and plugin manifests work.
 
 ## Comparison
 
 | | canvas-lms-mcp | [vishalsachdev/canvas-mcp](https://github.com/vishalsachdev/canvas-mcp) | [DMontgomery40/mcp-canvas-lms](https://github.com/DMontgomery40/mcp-canvas-lms) |
 |---|---|---|---|
 | Language | TypeScript | Python | TypeScript |
-| Tools | 183 | 80+ | 54 |
+| Tools | 187 | 80+ | 54 |
 | License | [![License: MIT](https://img.shields.io/github/license/bruchris/canvas-lms-mcp)](https://github.com/bruchris/canvas-lms-mcp/blob/main/LICENSE) | [![License](https://img.shields.io/github/license/vishalsachdev/canvas-mcp)](https://github.com/vishalsachdev/canvas-mcp/blob/main/LICENSE) | [![License](https://img.shields.io/github/license/DMontgomery40/mcp-canvas-lms)](https://github.com/DMontgomery40/mcp-canvas-lms/blob/main/LICENSE) |
 | Last commit | [![Last commit](https://img.shields.io/github/last-commit/bruchris/canvas-lms-mcp)](https://github.com/bruchris/canvas-lms-mcp) | [![Last commit](https://img.shields.io/github/last-commit/vishalsachdev/canvas-mcp)](https://github.com/vishalsachdev/canvas-mcp) | [![Last commit](https://img.shields.io/github/last-commit/DMontgomery40/mcp-canvas-lms)](https://github.com/DMontgomery40/mcp-canvas-lms) |
 
@@ -89,7 +89,7 @@ npx skills add bruchris/canvas-lms-mcp
 
 Skills are markdown workflow files (no extra dependencies). They work with the MCP server you already have installed. See the [`skills/` directory](./skills/) for the full list.
 
-The same 16 workflows are also served over MCP as [prompts](https://modelcontextprotocol.io/docs/concepts/prompts), so a host without a skill-file loader — Claude Desktop, ChatGPT, or an application embedding this server in-process — can list them with `prompts/list` and fetch one with `prompts/get`. Each prompt advertises optional `course_id`-style arguments a host can prefill, and marks the workflows that reach write tools. Prompts are inert templates the user chooses: selecting one grants the model no tool authority it did not already have.
+The same 17 workflows are also served over MCP as [prompts](https://modelcontextprotocol.io/docs/concepts/prompts), so a host without a skill-file loader — Claude Desktop, ChatGPT, or an application embedding this server in-process — can list them with `prompts/list` and fetch one with `prompts/get`. Each prompt advertises optional `course_id`-style arguments a host can prefill, and marks the workflows that reach write tools. Prompts are inert templates the user chooses: selecting one grants the model no tool authority it did not already have.
 
 ## Example Prompts
 
@@ -106,13 +106,13 @@ Once configured, try these prompts with your AI client:
 
 ## Tool Inventory
 
-### All Registered Tools (183)
+### All Registered Tools (187)
 
 | Category | Tools |
 |----------|-------|
 | Health | `health_check` |
-| Courses | `list_courses`, `get_course`, `get_syllabus`, `create_course`, `update_course` |
-| Assignments | `list_assignments`, `get_assignment`, `list_assignment_groups`, `create_assignment`, `update_assignment`, `delete_assignment` |
+| Courses | `list_courses`, `get_course`, `get_syllabus`, `list_sections`, `create_course`, `update_course` |
+| Assignments | `list_assignments`, `get_assignment`, `list_assignment_groups`, `create_assignment_group`, `update_assignment_group`, `create_assignment`, `update_assignment`, `delete_assignment` |
 | Assignment Overrides | `list_assignment_overrides`, `create_assignment_override`, `set_student_assignment_dates` |
 | Submissions | `list_submissions`, `get_submission`, `grade_submission`, `comment_on_submission` |
 | Submissions Awaiting Grading | `list_submissions_awaiting_grading` |
@@ -152,7 +152,7 @@ Once configured, try these prompts with your AI client:
 | Attention | `list_submission_comments_needing_attention`, `list_students_needing_attention` |
 | FERPA (conditional) | `resolve_pseudonym` — stdio only, registered when `CANVAS_PSEUDONYMIZE_STUDENTS=true` and `CANVAS_PSEUDONYMIZE_REVERSE_LOOKUP=true` |
 
-123 tools are read-only and 60 tools perform Canvas write operations. When FERPA mode is enabled **on the stdio transport**, `resolve_pseudonym` is registered as the 184th tool overall (124th read tool). The HTTP transport never registers it — see [FERPA mode](#ferpa-mode-student-pseudonymization).
+125 tools are read-only and 62 tools perform Canvas write operations. When FERPA mode is enabled **on the stdio transport**, `resolve_pseudonym` is registered as the 188th tool overall (126th read tool). The HTTP transport never registers it — see [FERPA mode](#ferpa-mode-student-pseudonymization).
 
 All write tools require appropriate Canvas permissions. Canvas enforces its own permission model -- the MCP server does not bypass it.
 
@@ -317,6 +317,8 @@ const courses = await canvas.courses.list()
 | `--issuer` | `CANVAS_MCP_ISSUER` | (required in `oauth_brokered`) | Public URL of this server; OAuth issuer and resource prefix |
 | `doctor` | -- | -- | Print an identity-safe setup report (also `auth status`); exit 1 when something is missing |
 | `--role` | `CANVAS_ROLE` | (all tools) | Filter tools by Canvas role: `student`, `teacher`, or `admin` (see [Role-based tool filtering](#role-based-tool-filtering)) |
+| `--toolsets <list>` | `CANVAS_TOOLSETS` | (all tools) | Comma-separated Canvas areas to expose: `core`, `grading`, `quizzes`, `people`, `communication`, `outcomes`, `course_ops`, `account`, `student` (see [Toolset filtering](#toolset-filtering)) |
+| `--read-only` | `CANVAS_READ_ONLY` | `false` | Register only `readOnlyHint` tools (see [Read-only mode](#read-only-mode)) |
 | `--destructive-tools=<mode>` | `CANVAS_DESTRUCTIVE_TOOLS` | `allow` | `allow` or `block`. `block` unregisters the twelve irreversible delete tools (see [Destructive tool policy](#destructive-tool-policy)) |
 
 ## Environment Variables
@@ -344,6 +346,8 @@ const courses = await canvas.courses.list()
 | `CANVAS_PSEUDONYM_DIR` | No | Absolute path that overrides the default pseudonym map directory |
 | `CANVAS_PSEUDONYM_AUDIT_LOG` | No | Path to an append-only file that mirrors `resolve_pseudonym` audit lines (stderr is always written) |
 | `CANVAS_PROVENANCE_FENCING` | No | **On by default.** Set to exactly `false` to disable [provenance fencing](#provenance-fencing-untrusted-canvas-content) |
+| `CANVAS_TOOLSETS` | No | Comma-separated Canvas areas to expose; unset or `all` exposes every tool (see [Toolset filtering](#toolset-filtering)) |
+| `CANVAS_READ_ONLY` | No | Set truthy to register only `readOnlyHint` tools (see [Read-only mode](#read-only-mode)) |
 | `CANVAS_DESTRUCTIVE_TOOLS` | No | `allow` (default) or `block`. Set to exactly `block` to unregister the twelve irreversible delete tools (see [Destructive tool policy](#destructive-tool-policy)) |
 | `CANVAS_STRING_IDS` | No | **Off by default.** Set to exactly `true` to request Canvas identifiers as JSON strings instead of numbers (see [64-bit Canvas identifiers](#64-bit-canvas-identifiers-opt-in-string-ids)) |
 
@@ -569,10 +573,10 @@ Three roles, plus the default of "unset = every tool":
 
 | `CANVAS_ROLE` | Tools exposed | Typical use |
 |---------------|---------------|-------------|
-| _(unset)_ | all (~183) | default; backwards-compatible |
-| `student` | ~63 | a student's own courses, grades, submissions, and read-only course content |
-| `teacher` | ~160 | grading, roster, content authoring, analytics |
-| `admin` | ~172 | everything `teacher` sees plus account-level tools (`enroll_user`, `list_account_users`, …) |
+| _(unset)_ | all (~187) | default; backwards-compatible |
+| `student` | ~67 | a student's own courses, grades, submissions, and read-only course content |
+| `teacher` | ~165 | grading, roster, content authoring, analytics |
+| `admin` | ~175 | everything `teacher` sees plus account-level tools (`enroll_user`, `list_account_users`, …) |
 
 Notes:
 
@@ -585,6 +589,70 @@ Notes:
 
 Design rationale in [BRU-1530](https://github.com/bruchris/canvas-lms-mcp) (role taxonomy, why three roles, auto-detect deferred to v2).
 
+## Toolset filtering
+
+Where a role answers *who is calling*, a toolset answers *what they are here to do*. Selecting one or more narrows the tool list to whole Canvas areas, which is the cheaper lever when a client's context budget is the constraint. Like roles this is a **client-side UX / context-reduction filter only** — asking for a toolset grants nothing, and Canvas still enforces permissions server-side.
+
+```bash
+# stdio: env var or --toolsets flag (flag wins)
+CANVAS_TOOLSETS=grading canvas-lms-mcp --base-url https://school.instructure.com
+canvas-lms-mcp --base-url https://school.instructure.com --toolsets core,grading
+```
+
+Nine toolsets, plus the default of "unset = every tool". Every tool domain belongs to exactly **one** of them, so a selection is a partition rather than a set of overlapping tags:
+
+| `CANVAS_TOOLSETS` | Covers |
+|-------------------|--------|
+| _(unset, or `all`)_ | every tool — the default, backwards-compatible surface |
+| `core` | courses, assignments, modules, pages, files, health check |
+| `grading` | submissions, rubrics, peer reviews, gradebook history, grade explanation and projection, analytics |
+| `quizzes` | Classic and New Quizzes, quiz responses, quiz accommodations |
+| `people` | users, groups, enrollments, cross-course student search |
+| `communication` | discussions, announcements, conversations |
+| `outcomes` | outcomes, outcome groups, rollups, mastery |
+| `course_ops` | course setup, content exports and migrations, calendar, appointment groups, link and accessibility audits |
+| `account` | account and sub-account administration |
+| `student` | the caller-is-a-student surface: my courses, grades, submissions, planner, dashboard |
+
+Notes:
+
+- **Counts are derived, not documented.** `docs/generated/tool-manifest.json` carries a `toolset` field on every entry (schema 1.2), so the exact surface for any selection is computable from the generated artifact instead of a number in this file that can go stale.
+- Values are **case-insensitive**, comma-separated, and union together: `--toolsets core,grading` exposes both.
+- `all` is an explicit "no filter", accepted anywhere in the list.
+- **An unrecognised name discards the whole selection**, logs a warning to stderr, and registers all tools. A typo therefore fails towards *more* tools, never towards a narrower surface than you asked for — the one outcome a misconfigured client cannot detect from the result. (Same rule as `CANVAS_ROLE`.)
+- **Prompts are filtered to match.** A workflow that names a tool this server did not register is not advertised, so no prompt points the model at a tool it cannot call. Most workflows span two to four toolsets, so a single narrow selection can leave **no** prompts at all — the server then declares no `prompts` capability, rather than advertising an empty list. Select the toolsets a workflow needs (for example `core,grading` for `canvas-grading-pass`) to keep it.
+- **HTTP transport:** read per request from the `X-Canvas-Toolsets` header, falling back to `CANVAS_TOOLSETS` from the server config. A valid header (or `all`) overrides the configured default; an invalid header is ignored with a warning and the configured selection is kept.
+
+## Read-only mode
+
+`CANVAS_READ_ONLY=true` (or `--read-only`) registers only tools annotated `readOnlyHint: true`. Nothing that writes to Canvas is registered at all, so there is no write handler for a model to reach.
+
+```bash
+CANVAS_READ_ONLY=true canvas-lms-mcp --base-url https://school.instructure.com
+canvas-lms-mcp --base-url https://school.instructure.com --read-only
+```
+
+- This is not a new mechanism: it exposes the write-tool policy the OAuth profile already applies to a token without the `canvas:write` scope.
+- **It is a floor.** On the OAuth HTTP profile it is applied on top of the caller's scopes, so a token that carries `canvas:write` cannot widen a server the operator started read-only. A scope-blocked token still blocks exactly as before.
+- Server configuration only — there is deliberately **no** request header, for the same reason `CANVAS_DESTRUCTIVE_TOOLS` has none: a client that could pick the value could switch the restriction off.
+- `false`, `0`, `off`, `no` and unset all preserve the default write surface. The flag is one-way; there is no `--no-read-only`.
+- Write workflows are hidden from `prompts/list` too, since their tools are absent.
+
+## How the four tool-surface filters compose
+
+All four are **opt-in**. With none of them set, the registered surface is every tool and every prompt — the default this package has always shipped.
+
+| Control | Selects by | Narrows to | Client-overridable (HTTP)? | Real boundary? |
+|---------|-----------|-----------|---------------------------|----------------|
+| `CANVAS_ROLE` | who is calling | audiences that role can see | yes, `X-Canvas-Role` | no — UX filter |
+| `CANVAS_TOOLSETS` | what they are doing | domains in the selected toolsets | yes, `X-Canvas-Toolsets` | no — UX filter |
+| `CANVAS_READ_ONLY` | operator policy | `readOnlyHint: true` tools | no | yes — handler never registered |
+| `CANVAS_DESTRUCTIVE_TOOLS=block` | operator policy | drops the twelve irreversible deletes | no | yes — handler never registered |
+
+They **intersect**, in that order of concern: a tool is registered only if every active control admits it. So no control can add back a tool another removed, and the surface can only ever shrink as you add controls. The two client-overridable filters narrow what a caller sees; the two operator policies bound what any caller can do, which is why neither has a header.
+
+Prompts follow the result rather than being filtered separately: a workflow is advertised only when every tool it names survives all four.
+
 ## Development
 
 ```bash

package/bin/canvas-lms-mcp.js

@@ -20,6 +20,15 @@ directories can read its tool list, but then every tool call fails):
   --token <t>         Canvas API token (or CANVAS_API_TOKEN)
   --base-url <u>      Canvas base URL, origin only (or CANVAS_BASE_URL)
 
+Tool surface (all opt-in; with none set, every tool and prompt is registered):
+  --toolsets <list>   Comma-separated Canvas areas (or CANVAS_TOOLSETS):
+                      core, grading, quizzes, people, communication,
+                      outcomes, course_ops, account, student. "all" = no filter
+  --read-only         Register only read-only tools (or CANVAS_READ_ONLY)
+  --role <r>          student | teacher | admin (or CANVAS_ROLE)
+  --destructive-tools=<mode>
+                      allow (default) or block (or CANVAS_DESTRUCTIVE_TOOLS)
+
 Options:
   -h, --help          Show this help and exit
 `

package/dist/canvas/accounts.d.ts

@@ -1,6 +1,14 @@
 import type { CanvasHttpClient } from './client';
 import type { CanvasAccount, CanvasAccountNotification, CanvasAccountReport, CanvasCourse, CanvasUser } from './types';
 import type { CanvasId } from './id';
+import type { SearchUserInclude, UserSort } from './users';
+export type AccountUserSort = UserSort | 'id';
+export interface ListAccountUsersOptions {
+    search_term?: string;
+    sort?: AccountUserSort;
+    order?: 'asc' | 'desc';
+    include?: ReadonlyArray<SearchUserInclude>;
+}
 export declare class AccountsModule {
     private client;
     constructor(client: CanvasHttpClient);
@@ -10,9 +18,7 @@ export declare class AccountsModule {
     listCourses(accountId: CanvasId, params?: {
         search_term?: string;
     }): Promise<CanvasCourse[]>;
-    listUsers(accountId: CanvasId, params?: {
-        search_term?: string;
-    }): Promise<CanvasUser[]>;
+    listUsers(accountId: CanvasId, params?: ListAccountUsersOptions): Promise<CanvasUser[]>;
     getReports(accountId: CanvasId): Promise<CanvasAccountReport[]>;
     listNotifications(accountId: string): Promise<CanvasAccountNotification[]>;
 }

package/dist/canvas/accounts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/canvas/accounts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EACV,aAAa,EACb,yBAAyB,EACzB,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACX,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,qBAAa,cAAc;IACb,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,GAAG,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAIhD,IAAI,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAIhC,eAAe,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI9D,WAAW,CACf,SAAS,EAAE,QAAQ,EACnB,MAAM,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAChC,OAAO,CAAC,YAAY,EAAE,CAAC;IASpB,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IASxF,UAAU,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI/D,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;CAKjF"}
+{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/canvas/accounts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,OAAO,KAAK,EACV,aAAa,EACb,yBAAyB,EACzB,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACX,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAO1D,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,IAAI,CAAA;AAE7C,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;CAC3C;AAED,qBAAa,cAAc;IACb,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,GAAG,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAIhD,IAAI,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAIhC,eAAe,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI9D,WAAW,CACf,SAAS,EAAE,QAAQ,EACnB,MAAM,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAChC,OAAO,CAAC,YAAY,EAAE,CAAC;IASpB,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAYvF,UAAU,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI/D,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;CAKjF"}

package/dist/canvas/assignments.d.ts

@@ -1,5 +1,5 @@
 import type { CanvasHttpClient } from './client';
-import type { CanvasAssignment, CanvasAssignmentGroup, CanvasAssignmentOverride, CreateAssignmentOverrideParams, CreateAssignmentParams, UpdateAssignmentParams } from './types';
+import type { CanvasAssignment, CanvasAssignmentGroup, CanvasAssignmentOverride, CreateAssignmentGroupParams, CreateAssignmentOverrideParams, CreateAssignmentParams, UpdateAssignmentGroupParams, UpdateAssignmentParams } from './types';
 import type { CanvasId } from './id';
 export type AssignmentListInclude = 'submission' | 'assignment_visibility' | 'all_dates' | 'overrides' | 'observed_users' | 'can_edit' | 'score_statistics';
 export type AssignmentGetInclude = 'submission' | 'assignment_visibility' | 'overrides' | 'observed_users' | 'can_edit' | 'score_statistics' | 'all_dates';
@@ -36,6 +36,22 @@ export declare class AssignmentsModule {
     list(courseId: CanvasId, opts?: ListAssignmentsOptions): Promise<CanvasAssignment[]>;
     get(courseId: CanvasId, assignmentId: CanvasId, opts?: GetAssignmentOptions): Promise<CanvasAssignment>;
     listGroups(courseId: CanvasId, opts?: ListAssignmentGroupsOptions): Promise<CanvasAssignmentGroup[]>;
+    /**
+     * `POST /api/v1/courses/:course_id/assignment_groups`.
+     *
+     * Top-level params, not an `assignment_group[...]` envelope — see
+     * {@link CreateAssignmentGroupParams}. Returns the created group.
+     */
+    createGroup(courseId: CanvasId, params: CreateAssignmentGroupParams): Promise<CanvasAssignmentGroup>;
+    /**
+     * `PUT /api/v1/courses/:course_id/assignment_groups/:assignment_group_id`.
+     *
+     * A partial update: Canvas assigns only the attributes present in the request
+     * (`update_assignment_group` -> `assignment_group.attributes = ...`), so
+     * omitted fields keep their current value and repeating the same call leaves
+     * the same state.
+     */
+    updateGroup(courseId: CanvasId, assignmentGroupId: CanvasId, params: UpdateAssignmentGroupParams): Promise<CanvasAssignmentGroup>;
     create(courseId: CanvasId, params: CreateAssignmentParams): Promise<CanvasAssignment>;
     update(courseId: CanvasId, assignmentId: CanvasId, params: UpdateAssignmentParams): Promise<CanvasAssignment>;
     delete(courseId: CanvasId, assignmentId: CanvasId): Promise<void>;

package/dist/canvas/assignments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assignments.d.ts","sourceRoot":"","sources":["../../src/canvas/assignments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,OAAO,KAAK,EACV,gBAAgB,EAChB,qBAAqB,EACrB,wBAAwB,EACxB,8BAA8B,EAC9B,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,uBAAuB,GACvB,WAAW,GACX,WAAW,GACX,gBAAgB,GAChB,UAAU,GACV,kBAAkB,CAAA;AAEtB,MAAM,MAAM,oBAAoB,GAC5B,YAAY,GACZ,uBAAuB,GACvB,WAAW,GACX,gBAAgB,GAChB,UAAU,GACV,kBAAkB,GAClB,WAAW,CAAA;AAEf,MAAM,MAAM,gBAAgB,GAC1B,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAA;AAErF,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAA;AAE9D,MAAM,MAAM,sBAAsB,GAC9B,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,uBAAuB,GACvB,WAAW,GACX,YAAY,GACZ,gBAAgB,GAChB,UAAU,GACV,kBAAkB,CAAA;AAEtB,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAA;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,cAAc,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;IACxC,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CAAC,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAA;IAC/C,cAAc,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;IACxC,mCAAmC,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC3D,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,iBAAiB,CAAC,EAAE,QAAQ,CAAA;IAC5B,4BAA4B,CAAC,EAAE,OAAO,CAAA;CACvC;AAoBD,qBAAa,iBAAiB;IAChB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAE,sBAA2B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAOxF,GAAG,CACP,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,IAAI,GAAE,oBAAyB,GAC9B,OAAO,CAAC,gBAAgB,CAAC;IAOtB,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE,2BAAgC,GACrC,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAO7B,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOrF,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAUtB,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjE,aAAa,CACjB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,GACrB,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAMhC,cAAc,CAClB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,MAAM,EAAE,8BAA8B,GACrC,OAAO,CAAC,wBAAwB,CAAC;CASrC"}
+{"version":3,"file":"assignments.d.ts","sourceRoot":"","sources":["../../src/canvas/assignments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,OAAO,KAAK,EACV,gBAAgB,EAChB,qBAAqB,EACrB,wBAAwB,EACxB,2BAA2B,EAC3B,8BAA8B,EAC9B,sBAAsB,EACtB,2BAA2B,EAC3B,sBAAsB,EACvB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,uBAAuB,GACvB,WAAW,GACX,WAAW,GACX,gBAAgB,GAChB,UAAU,GACV,kBAAkB,CAAA;AAEtB,MAAM,MAAM,oBAAoB,GAC5B,YAAY,GACZ,uBAAuB,GACvB,WAAW,GACX,gBAAgB,GAChB,UAAU,GACV,kBAAkB,GAClB,WAAW,CAAA;AAEf,MAAM,MAAM,gBAAgB,GAC1B,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAA;AAErF,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAA;AAE9D,MAAM,MAAM,sBAAsB,GAC9B,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,uBAAuB,GACvB,WAAW,GACX,YAAY,GACZ,gBAAgB,GAChB,UAAU,GACV,kBAAkB,CAAA;AAEtB,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAA;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,cAAc,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;IACxC,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CAAC,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAA;IAC/C,cAAc,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;IACxC,mCAAmC,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC3D,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,iBAAiB,CAAC,EAAE,QAAQ,CAAA;IAC5B,4BAA4B,CAAC,EAAE,OAAO,CAAA;CACvC;AAoBD,qBAAa,iBAAiB;IAChB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAE,sBAA2B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAOxF,GAAG,CACP,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,IAAI,GAAE,oBAAyB,GAC9B,OAAO,CAAC,gBAAgB,CAAC;IAOtB,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE,2BAAgC,GACrC,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAOnC;;;;;OAKG;IACG,WAAW,CACf,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,2BAA2B,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAUjC;;;;;;;OAOG;IACG,WAAW,CACf,QAAQ,EAAE,QAAQ,EAClB,iBAAiB,EAAE,QAAQ,EAC3B,MAAM,EAAE,2BAA2B,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAU3B,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOrF,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAUtB,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjE,aAAa,CACjB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,GACrB,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAMhC,cAAc,CAClB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,MAAM,EAAE,8BAA8B,GACrC,OAAO,CAAC,wBAAwB,CAAC;CASrC"}

package/dist/canvas/courses.d.ts

@@ -1,5 +1,5 @@
 import type { CanvasHttpClient } from './client';
-import type { CanvasCourse, CreateCourseParams, UpdateCourseParams } from './types';
+import type { CanvasCourse, CanvasCourseSection, CreateCourseParams, UpdateCourseParams } from './types';
 import type { CanvasId } from './id';
 export type CourseEnrollmentState = 'active' | 'invited_or_pending' | 'completed';
 export type CourseWorkflowState = 'unpublished' | 'available' | 'completed' | 'deleted';
@@ -16,11 +16,38 @@ export interface GetCourseOptions {
     include?: ReadonlyArray<CourseGetInclude>;
     teacher_limit?: number;
 }
+/**
+ * `include[]` values `SectionsController#index` documents.
+ *
+ * `students`, `enrollments` and `avatar_url` are deliberately absent: the first
+ * makes Canvas embed a capped list of `User` objects in every section (student
+ * names, and avatar URLs when `avatar_url` rides along), and this server has a
+ * dedicated, pseudonymized roster surface already (`list_course_users` /
+ * `list_students`). `passback_status` is omitted as SIS grade-passback plumbing
+ * unrelated to the section-identification job this tool exists for.
+ */
+export type CourseSectionInclude = 'total_students' | 'permissions';
+export interface ListCourseSectionsOptions {
+    include?: ReadonlyArray<CourseSectionInclude>;
+    /** Canvas requires at least 2 characters; shorter terms are ignored, not an error. */
+    search_term?: string;
+}
 export declare class CoursesModule {
     private client;
     constructor(client: CanvasHttpClient);
     list(opts?: ListCoursesOptions): Promise<CanvasCourse[]>;
     get(courseId: CanvasId, opts?: GetCourseOptions): Promise<CanvasCourse>;
+    /**
+     * `GET /api/v1/courses/:course_id/sections` — a paginated, flat array of
+     * `Section` objects (no root envelope).
+     *
+     * `SectionsController#index` nulls `params[:include]` entirely unless the
+     * caller holds one of `:read_roster`, `:view_all_grades` or `:manage_grades`
+     * on the course, so a caller with only `:read` gets the base section fields
+     * whatever is requested here — the call succeeds, the extras are silently
+     * dropped.
+     */
+    listSections(courseId: CanvasId, opts?: ListCourseSectionsOptions): Promise<CanvasCourseSection[]>;
     getSyllabus(courseId: CanvasId): Promise<string | null>;
     create(params: CreateCourseParams): Promise<CanvasCourse>;
     update(courseId: CanvasId, params: UpdateCourseParams): Promise<CanvasCourse>;

package/dist/canvas/courses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"courses.d.ts","sourceRoot":"","sources":["../../src/canvas/courses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AACnF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,oBAAoB,GAAG,WAAW,CAAA;AAEjF,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAA;AAEvF,MAAM,MAAM,iBAAiB,GACzB,qBAAqB,GACrB,eAAe,GACf,oBAAoB,GACpB,cAAc,GACd,+BAA+B,GAC/B,iBAAiB,GACjB,MAAM,GACN,SAAS,GACT,iBAAiB,GACjB,UAAU,GACV,uBAAuB,GACvB,gBAAgB,GAChB,iBAAiB,GACjB,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,cAAc,GACd,cAAc,GACd,WAAW,GACX,gBAAgB,GAChB,eAAe,CAAA;AAEnB,MAAM,MAAM,gBAAgB,GAC1B,iBAAiB,GAAG,aAAa,GAAG,aAAa,GAAG,oBAAoB,CAAA;AAE1E,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IACxC,KAAK,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAA;IAC1C,kBAAkB,CAAC,EAAE,QAAQ,CAAA;IAC7B,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC1C,yBAAyB,CAAC,EAAE,OAAO,CAAA;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAA;IACzC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAKD,qBAAa,aAAa;IACZ,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,IAAI,GAAE,kBAAuB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAY5D,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IAO3E,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOvD,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAQzD,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;CAMpF"}
+{"version":3,"file":"courses.d.ts","sourceRoot":"","sources":["../../src/canvas/courses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,OAAO,KAAK,EACV,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,oBAAoB,GAAG,WAAW,CAAA;AAEjF,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAA;AAEvF,MAAM,MAAM,iBAAiB,GACzB,qBAAqB,GACrB,eAAe,GACf,oBAAoB,GACpB,cAAc,GACd,+BAA+B,GAC/B,iBAAiB,GACjB,MAAM,GACN,SAAS,GACT,iBAAiB,GACjB,UAAU,GACV,uBAAuB,GACvB,gBAAgB,GAChB,iBAAiB,GACjB,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,cAAc,GACd,cAAc,GACd,WAAW,GACX,gBAAgB,GAChB,eAAe,CAAA;AAEnB,MAAM,MAAM,gBAAgB,GAC1B,iBAAiB,GAAG,aAAa,GAAG,aAAa,GAAG,oBAAoB,CAAA;AAE1E,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IACxC,KAAK,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAA;IAC1C,kBAAkB,CAAC,EAAE,QAAQ,CAAA;IAC7B,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC1C,yBAAyB,CAAC,EAAE,OAAO,CAAA;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAA;IACzC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,aAAa,CAAA;AAEnE,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,sFAAsF;IACtF,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAKD,qBAAa,aAAa;IACZ,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,IAAI,GAAE,kBAAuB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAY5D,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IAOjF;;;;;;;;;OASG;IACG,YAAY,CAChB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE,yBAA8B,GACnC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAO3B,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOvD,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAQzD,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;CAMpF"}

package/dist/canvas/dashboard.d.ts

@@ -1,11 +1,15 @@
 import type { CanvasHttpClient } from './client';
+import type { CalendarEventType } from './calendar';
 import type { CanvasDashboardCard, CanvasTodoItem, CanvasUpcomingEvent, CanvasMissingSubmission } from './types';
+export interface GetUpcomingEventsOptions {
+    type?: CalendarEventType;
+}
 export declare class DashboardModule {
     private client;
     constructor(client: CanvasHttpClient);
     getDashboardCards(): Promise<CanvasDashboardCard[]>;
     getTodoItems(): Promise<CanvasTodoItem[]>;
-    getUpcomingEvents(): Promise<CanvasUpcomingEvent[]>;
+    getUpcomingEvents(opts?: GetUpcomingEventsOptions): Promise<CanvasUpcomingEvent[]>;
     getMissingSubmissions(): Promise<CanvasMissingSubmission[]>;
 }
 //# sourceMappingURL=dashboard.d.ts.map

package/dist/canvas/dashboard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../../src/canvas/dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAEhB,qBAAa,eAAe;IACd,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAInD,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAIzC,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAInD,qBAAqB,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;CAGlE"}
+{"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../../src/canvas/dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAEhB,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,iBAAiB,CAAA;CACzB;AAED,qBAAa,eAAe;IACd,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAInD,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAWzC,iBAAiB,CAAC,IAAI,GAAE,wBAA6B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAQtF,qBAAqB,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;CAGlE"}

package/dist/canvas/enrollments.d.ts

@@ -26,12 +26,35 @@ export interface ListUserEnrollmentsOptions {
     grading_period_id?: CanvasId;
     enrollment_term_id?: CanvasId;
 }
+/**
+ * The two optional `enrollment[...]` fields `enroll` forwards beyond
+ * role and state.
+ *
+ * `course_section_id` is the section to enroll into; Canvas ignores it on the
+ * section-scoped URL variant, which this client does not use.
+ * `limit_privileges_to_course_section` confines the user to that section — for
+ * teachers and TAs that includes grading privileges, and a section-limited
+ * student sees no user (teachers included) outside their own sections. Canvas
+ * documents it as taking effect relative to `course_section_id`, so passing it
+ * without a section restricts the user to whichever section Canvas picks.
+ */
+export interface EnrollUserOptions {
+    course_section_id?: CanvasId;
+    limit_privileges_to_course_section?: boolean;
+}
 export declare class EnrollmentsModule {
     private client;
     constructor(client: CanvasHttpClient);
     list(opts?: ListUserEnrollmentsOptions): Promise<CanvasEnrollment[]>;
     listForCourse(courseId: CanvasId, opts?: ListCourseEnrollmentsOptions): Promise<CanvasEnrollment[]>;
-    enroll(courseId: CanvasId, userId: CanvasId, type: string, enrollmentState?: string): Promise<CanvasEnrollment>;
+    /**
+     * `POST /api/v1/courses/:course_id/enrollments`, under the `enrollment[...]`
+     * envelope Canvas documents.
+     *
+     * `opts` keys are spread last and only when present, so a call that omits
+     * them produces the same request body as before they existed.
+     */
+    enroll(courseId: CanvasId, userId: CanvasId, type: string, enrollmentState?: string, opts?: EnrollUserOptions): Promise<CanvasEnrollment>;
     remove(courseId: CanvasId, enrollmentId: CanvasId, task: string): Promise<CanvasEnrollment>;
     listMyGrades(courseId?: CanvasId): Promise<CanvasEnrollment[]>;
 }

package/dist/canvas/enrollments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enrollments.d.ts","sourceRoot":"","sources":["../../src/canvas/enrollments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,cAAc,GACtB,mBAAmB,GACnB,mBAAmB,GACnB,cAAc,GACd,oBAAoB,GACpB,oBAAoB,CAAA;AAExB,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,SAAS,GACT,kBAAkB,GAClB,SAAS,GACT,UAAU,GACV,WAAW,GACX,UAAU,GACV,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,CAAA;AAE3B,MAAM,MAAM,iBAAiB,GACzB,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,gBAAgB,GAChB,gBAAgB,GAChB,MAAM,GACN,gBAAgB,GAChB,QAAQ,CAAA;AAEZ,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAA;IACpC,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,KAAK,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC1C,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,iBAAiB,CAAC,EAAE,QAAQ,CAAA;IAC5B,kBAAkB,CAAC,EAAE,QAAQ,CAAA;IAC7B,cAAc,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACtC,aAAa,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACrC,cAAc,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACtC,WAAW,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACnC,kBAAkB,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAA;IACpC,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,KAAK,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC1C,iBAAiB,CAAC,EAAE,QAAQ,CAAA;IAC5B,kBAAkB,CAAC,EAAE,QAAQ,CAAA;CAC9B;AAoBD,qBAAa,iBAAiB;IAChB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,IAAI,GAAE,0BAA+B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAOxE,aAAa,CACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE,4BAAiC,GACtC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAOxB,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,QAAQ,EAChB,IAAI,EAAE,MAAM,EACZ,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,gBAAgB,CAAC;IActB,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,gBAAgB,CAAC;IAOtB,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAWrE"}
+{"version":3,"file":"enrollments.d.ts","sourceRoot":"","sources":["../../src/canvas/enrollments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,cAAc,GACtB,mBAAmB,GACnB,mBAAmB,GACnB,cAAc,GACd,oBAAoB,GACpB,oBAAoB,CAAA;AAExB,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,SAAS,GACT,kBAAkB,GAClB,SAAS,GACT,UAAU,GACV,WAAW,GACX,UAAU,GACV,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,CAAA;AAE3B,MAAM,MAAM,iBAAiB,GACzB,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,gBAAgB,GAChB,gBAAgB,GAChB,MAAM,GACN,gBAAgB,GAChB,QAAQ,CAAA;AAEZ,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAA;IACpC,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,KAAK,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC1C,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,iBAAiB,CAAC,EAAE,QAAQ,CAAA;IAC5B,kBAAkB,CAAC,EAAE,QAAQ,CAAA;IAC7B,cAAc,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACtC,aAAa,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACrC,cAAc,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACtC,WAAW,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACnC,kBAAkB,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAA;IACpC,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,KAAK,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC1C,iBAAiB,CAAC,EAAE,QAAQ,CAAA;IAC5B,kBAAkB,CAAC,EAAE,QAAQ,CAAA;CAC9B;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,CAAC,EAAE,QAAQ,CAAA;IAC5B,kCAAkC,CAAC,EAAE,OAAO,CAAA;CAC7C;AAoBD,qBAAa,iBAAiB;IAChB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,IAAI,GAAE,0BAA+B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAOxE,aAAa,CACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE,4BAAiC,GACtC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAO9B;;;;;;OAMG;IACG,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,QAAQ,EAChB,IAAI,EAAE,MAAM,EACZ,eAAe,CAAC,EAAE,MAAM,EACxB,IAAI,GAAE,iBAAsB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAoBtB,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,QAAQ,EACtB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,gBAAgB,CAAC;IAOtB,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAWrE"}

package/dist/canvas/groups.d.ts

@@ -12,6 +12,20 @@ export interface CreateGroupParams {
 export declare class GroupsModule {
     private client;
     constructor(client: CanvasHttpClient);
+    /**
+     * The groups the CALLING user is a member of, optionally narrowed to course
+     * contexts. This is deliberately not `list(courseId)`: `/courses/:id/groups`
+     * is gated on `:read_roster` and returns every group in the course, so a
+     * student with roster access reads back groups they are not in. Attributing a
+     * per-group discussion's child topic to one of those would report another
+     * group's state as the caller's own.
+     *
+     * `course_id` is on each group (`context_type: 'Course'`), so the caller
+     * filters locally rather than per-course fan-out.
+     */
+    listMine(opts?: {
+        contextType?: 'Course' | 'Account';
+    }): Promise<CanvasGroup[]>;
     list(courseId: CanvasId): Promise<CanvasGroup[]>;
     listMembers(groupId: CanvasId): Promise<CanvasUser[]>;
     listCategories(courseId: CanvasId): Promise<CanvasGroupCategory[]>;

package/dist/canvas/groups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"groups.d.ts","sourceRoot":"","sources":["../../src/canvas/groups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAClG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,0BAA0B,GAAG,wBAAwB,GAAG,iBAAiB,CAAA;CACvF;AAED,qBAAa,YAAY;IACX,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAIhD,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAIrD,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAIxE,4DAA4D;IACtD,cAAc,CAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;;;OAIG;IACG,MAAM,CAAC,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAOxF,yFAAyF;IACnF,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC;IAIrD,oGAAoG;IAC9F,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAOpF,iEAAiE;IAC3D,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,CAAC;CAKlF"}
+{"version":3,"file":"groups.d.ts","sourceRoot":"","sources":["../../src/canvas/groups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAClG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,0BAA0B,GAAG,wBAAwB,GAAG,iBAAiB,CAAA;CACvF;AAED,qBAAa,YAAY;IACX,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAE5C;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,IAAI,GAAE;QAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAQnF,IAAI,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAIhD,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAIrD,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAIxE,4DAA4D;IACtD,cAAc,CAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;;;OAIG;IACG,MAAM,CAAC,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAOxF,yFAAyF;IACnF,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC;IAIrD,oGAAoG;IAC9F,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAOpF,iEAAiE;IAC3D,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,CAAC;CAKlF"}

package/dist/canvas/index.cjs

@@ -6,13 +6,13 @@
 
 
 
-var _chunk4TAI5SSRcjs = require('../chunk-4TAI5SSR.cjs');
+var _chunkLMKNKL5Ccjs = require('../chunk-LMKNKL5C.cjs');
 
 
 
 
 
-var _chunkXDAWAHU7cjs = require('../chunk-XDAWAHU7.cjs');
+var _chunkQWLAP6MWcjs = require('../chunk-QWLAP6MW.cjs');
 require('../chunk-AMZAZNZZ.cjs');
 
 
@@ -26,5 +26,5 @@ require('../chunk-AMZAZNZZ.cjs');
 
 
 
-exports.CANVAS_MAX_ID = _chunk4TAI5SSRcjs.CANVAS_MAX_ID; exports.CanvasApiError = _chunkXDAWAHU7cjs.CanvasApiError; exports.CanvasClient = _chunk4TAI5SSRcjs.CanvasClient; exports.CanvasHttpClient = _chunkXDAWAHU7cjs.CanvasHttpClient; exports.MAX_SAFE_CANVAS_NUMBER_ID = _chunk4TAI5SSRcjs.MAX_SAFE_CANVAS_NUMBER_ID; exports.appendCanvasQuery = _chunkXDAWAHU7cjs.appendCanvasQuery; exports.canvasIdInput = _chunk4TAI5SSRcjs.canvasIdInput; exports.canvasIdList = _chunk4TAI5SSRcjs.canvasIdList; exports.compareCanvasIds = _chunk4TAI5SSRcjs.compareCanvasIds; exports.normalizeCanvasIdInput = _chunk4TAI5SSRcjs.normalizeCanvasIdInput; exports.toCanvasQuery = _chunkXDAWAHU7cjs.toCanvasQuery;
+exports.CANVAS_MAX_ID = _chunkLMKNKL5Ccjs.CANVAS_MAX_ID; exports.CanvasApiError = _chunkQWLAP6MWcjs.CanvasApiError; exports.CanvasClient = _chunkLMKNKL5Ccjs.CanvasClient; exports.CanvasHttpClient = _chunkQWLAP6MWcjs.CanvasHttpClient; exports.MAX_SAFE_CANVAS_NUMBER_ID = _chunkLMKNKL5Ccjs.MAX_SAFE_CANVAS_NUMBER_ID; exports.appendCanvasQuery = _chunkQWLAP6MWcjs.appendCanvasQuery; exports.canvasIdInput = _chunkLMKNKL5Ccjs.canvasIdInput; exports.canvasIdList = _chunkLMKNKL5Ccjs.canvasIdList; exports.compareCanvasIds = _chunkLMKNKL5Ccjs.compareCanvasIds; exports.normalizeCanvasIdInput = _chunkLMKNKL5Ccjs.normalizeCanvasIdInput; exports.toCanvasQuery = _chunkQWLAP6MWcjs.toCanvasQuery;
 //# sourceMappingURL=index.cjs.map

package/dist/canvas/index.js

@@ -6,13 +6,13 @@ import {
   canvasIdList,
   compareCanvasIds,
   normalizeCanvasIdInput
-} from "../chunk-HF7IV5SM.js";
+} from "../chunk-W624KMYI.js";
 import {
   CanvasApiError,
   CanvasHttpClient,
   appendCanvasQuery,
   toCanvasQuery
-} from "../chunk-SYO65DQF.js";
+} from "../chunk-6XNWSJQF.js";
 import "../chunk-XLORAICV.js";
 export {
   CANVAS_MAX_ID,

package/dist/canvas/modules.d.ts

@@ -29,14 +29,48 @@ export declare class ModulesModule {
     /**
      * List a course's modules with each module's items inlined via `include[]=items`.
      * Unlike `getCourseStructure`, this returns the raw Canvas shapes (including the
-     * `published` state on every module and item, even unpublished ones), which the
-     * course-setup health check needs to detect unpublished content.
+     * `published` state on every module and item, and each item's
+     * `completion_requirement`, all of which `getCourseStructure` projects away), which
+     * the course-setup health check needs to detect unpublished content.
+     *
+     * **`items` can be absent, and absent is not empty.** `module_json` inlines items
+     * only when `includes.include?("items") && count <= Api::MAX_PER_PAGE`, with
+     * `Api::MAX_PER_PAGE = 100` (`lib/api.rb`). A module with 101 or more items comes back
+     * with **no `items` key at all** — not a truncated array, not an error. Compare
+     * `items.length` against `items_count` and fall back to `listItems` for that module;
+     * `items ?? []` silently reports a large module as empty.
+     *
+     * `per_page` needs no argument here: `CanvasHttpClient.paginate` sets `per_page=100`
+     * whenever the caller did not, so this never falls back to Canvas's
+     * `Api::PER_PAGE = 10` default.
+     *
+     * @param opts.contentDetails adds `include[]=content_details`, which is the only way
+     *   to see `locked_for_user` and the caller's override-applied effective `due_at` per
+     *   item. Off by default so existing callers keep their current response size.
+     * @param opts.maxItems stops after this many MODULES. Pass `limit + 1` to probe for
+     *   truncation: `paginate()` reports what it accumulated, never whether more was
+     *   waiting, so asking for exactly `limit` makes "there are exactly `limit`" and
+     *   "there are more" indistinguishable. Off by default.
      */
-    listWithItems(courseId: CanvasId): Promise<(CanvasModule & {
+    listWithItems(courseId: CanvasId, opts?: {
+        contentDetails?: boolean;
+        maxItems?: number;
+    }): Promise<(CanvasModule & {
         items?: CanvasModuleItem[];
     })[]>;
     get(courseId: CanvasId, moduleId: CanvasId): Promise<CanvasModule>;
-    listItems(courseId: CanvasId, moduleId: CanvasId): Promise<CanvasModuleItem[]>;
+    /**
+     * List one module's items. This is the paginating endpoint, so it is also the recovery
+     * path for the `include[]=items` cliff documented on {@link listWithItems}: a module
+     * with more than 100 items has to be read here.
+     *
+     * @param opts.contentDetails adds `include[]=content_details`, so a module recovered
+     *   through this path carries the same `locked_for_user` and effective-date evidence
+     *   as one inlined by `listWithItems({ contentDetails: true })`. Off by default.
+     */
+    listItems(courseId: CanvasId, moduleId: CanvasId, opts?: {
+        contentDetails?: boolean;
+    }): Promise<CanvasModuleItem[]>;
     create(courseId: CanvasId, params: {
         name: string;
         position?: number;

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

@@ -1 +1 @@
-{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../src/canvas/modules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,QAAQ,CAAA;IACrB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,QAAQ,CAAA;CACrB;AAED,qBAAa,aAAa;IACZ,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAIvD;;;;;OAKG;IACG,aAAa,CACjB,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC,CAAC,YAAY,GAAG;QAAE,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAAE,CAAC,EAAE,CAAC;IAOvD,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAIlE,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM9E,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,QAAQ,EAAE,CAAA;KACrC,GACA,OAAO,CAAC,YAAY,CAAC;IAOlB,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAChE,OAAO,CAAC,YAAY,CAAC;IAOxB;;;;OAIG;IACG,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAMrE,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAUtB,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,QAAQ,EAChB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAU5B,wEAAwE;IAClE,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,QAAQ,GACf,OAAO,CAAC,gBAAgB,CAAC;IAOtB,kBAAkB,CACtB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE;QAAE,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAAC,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAAO,GAC7E,OAAO,CAAC,qBAAqB,CAAC;CAkDlC"}
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../src/canvas/modules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,QAAQ,CAAA;IACrB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,QAAQ,CAAA;CACrB;AAED,qBAAa,aAAa;IACZ,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAEtC,IAAI,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAIvD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,aAAa,CACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GACzD,OAAO,CAAC,CAAC,YAAY,GAAG;QAAE,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAAE,CAAC,EAAE,CAAC;IAcvD,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxE;;;;;;;;OAQG;IACG,SAAS,CACb,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAA;KAAO,GACtC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IASxB,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,QAAQ,EAAE,CAAA;KACrC,GACA,OAAO,CAAC,YAAY,CAAC;IAOlB,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAChE,OAAO,CAAC,YAAY,CAAC;IAOxB;;;;OAIG;IACG,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAMrE,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAUtB,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,QAAQ,EAChB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAU5B,wEAAwE;IAClE,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,QAAQ,GACf,OAAO,CAAC,gBAAgB,CAAC;IAOtB,kBAAkB,CACtB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE;QAAE,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAAC,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAAO,GAC7E,OAAO,CAAC,qBAAqB,CAAC;CAkDlC"}