@instructure/platform-modules 0.3.0 → 1.0.0

package/dist/config/schemas.d.ts

@@ -1,12 +1,9 @@
+import { ReactNode } from 'react';
 import { z } from 'zod';
+import { TranslateFunction } from '../i18n';
+import { FilterClause, Module, ModuleItem } from '../types';
+import { BoundFormatters } from './useFormatters';
 import { ModulesConfig } from './types';
-/**
- * The shape every registry entry shares, schema first so the type is inferred
- * from one list of fields — same inversion as `types/enums.ts`.
- *
- * Registries are validated at runtime rather than typed with generics, because
- * a host may fetch one. See `docs/adr/0001-customization.md`.
- */
 export declare const RegistryEntrySchema: z.ZodObject<{
     label: z.ZodString;
     order: z.ZodNumber;
@@ -14,5 +11,38 @@ export declare const RegistryEntrySchema: z.ZodObject<{
 }>;
 export type RegistryEntry = z.infer<typeof RegistryEntrySchema>;
 export declare function registrySchema<E extends RegistryEntry>(entrySchema: z.ZodType<E>): z.ZodRecord<z.ZodString, z.ZodType<E>>;
+export interface ItemTypeContext {
+    item: ModuleItem;
+}
+export interface ItemTypeEntry extends RegistryEntry {
+    icon?: ReactNode;
+    renderIcon?: (context: ItemTypeContext) => ReactNode;
+}
+export declare const ItemTypeEntrySchema: z.ZodType<ItemTypeEntry>;
+export interface MetaFieldContext {
+    item: ModuleItem;
+    t: TranslateFunction;
+    today: Date;
+    locale: string;
+    timezone?: string;
+    formatters: BoundFormatters;
+    config: ModulesConfig;
+}
+export interface MetaFieldEntry extends RegistryEntry {
+    render: (context: MetaFieldContext) => ReactNode;
+}
+export declare const MetaFieldEntrySchema: z.ZodType<MetaFieldEntry>;
+export interface FilterContext {
+    today: Date;
+    timezone?: string;
+}
+export interface FilterEntry extends RegistryEntry {
+    /** Runs over loaded pages only. */
+    predicate: (module: Module, context: FilterContext) => boolean;
+    query?: FilterClause;
+    /** Ignore any inherited `query` and serve this filter by its predicate. */
+    clientOnly?: boolean;
+}
+export declare const FilterEntrySchema: z.ZodType<FilterEntry>;
 export declare const ModulesConfigSchema: z.ZodType<ModulesConfig>;
 //# sourceMappingURL=schemas.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../src/config/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,SAAS,CAAC;IAC5C,KAAK,EAAE,CAAC,CAAC,SAAS,CAAA;IAClB,KAAK,EAAE,CAAC,CAAC,SAAS,CAAA;IAClB,MAAM,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;CACpC,CASC,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,wBAAgB,cAAc,CAAC,CAAC,SAAS,aAAa,EACpD,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GACxB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAExC;AAID,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CASvD,CAAA"}
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../src/config/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AACtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,KAAK,YAAY,EAAsB,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,UAAU,CAAA;AAE9F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,SAAS,CAAC;IAC5C,KAAK,EAAE,CAAC,CAAC,SAAS,CAAA;IAClB,KAAK,EAAE,CAAC,CAAC,SAAS,CAAA;IAClB,MAAM,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;CACpC,CAMC,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,wBAAgB,cAAc,CAAC,CAAC,SAAS,aAAa,EACpD,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GACxB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAExC;AAID,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,IAAI,CAAC,EAAE,SAAS,CAAA;IAEhB,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,SAAS,CAAA;CACrD;AAgBD,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAK9C,CAAA;AAQX,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,UAAU,CAAA;IAChB,CAAC,EAAE,iBAAiB,CAAA;IACpB,KAAK,EAAE,IAAI,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,eAAe,CAAA;IAC3B,MAAM,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,MAAM,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,SAAS,CAAA;CACjD;AAED,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAIhD,CAAA;AAEX,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,IAAI,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,mCAAmC;IACnC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,KAAK,OAAO,CAAA;IAC9D,KAAK,CAAC,EAAE,YAAY,CAAA;IACpB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAM1C,CAAA;AAEX,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAgBvD,CAAA"}

package/dist/config/types.d.ts

@@ -1,30 +1,24 @@
+import { ModulesFormatters } from './formatters';
 import { Registry, RegistryOverride } from './registry';
-/** Pure display functions over domain values. */
-export interface ModulesFormatters {
-}
-/** Where a click on a module or an item goes. */
+import { FilterEntry, ItemTypeEntry, MetaFieldEntry } from './schemas';
 export interface ModulesNavigation {
 }
-/**
- * Everything a host can customize. Not customizable means nothing to set.
- */
 export interface ModulesConfig {
     formatters: ModulesFormatters;
-    itemTypes: Registry;
+    itemTypes: Registry<ItemTypeEntry>;
     itemStatuses: Registry;
-    itemMeta: Registry;
-    filters: Registry;
+    itemMeta: Registry<MetaFieldEntry>;
+    filters: Registry<FilterEntry>;
     moduleActions: Registry;
     itemActions: Registry;
     navigation: ModulesNavigation;
 }
-/** A host writes only the surfaces it wants different from the base. */
 export interface ModulesConfigOverride {
     formatters?: Partial<ModulesFormatters>;
-    itemTypes?: RegistryOverride;
+    itemTypes?: RegistryOverride<ItemTypeEntry>;
     itemStatuses?: RegistryOverride;
-    itemMeta?: RegistryOverride;
-    filters?: RegistryOverride;
+    itemMeta?: RegistryOverride<MetaFieldEntry>;
+    filters?: RegistryOverride<FilterEntry>;
     moduleActions?: RegistryOverride;
     itemActions?: RegistryOverride;
     navigation?: Partial<ModulesNavigation>;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAE5D,iDAAiD;AACjD,MAAM,WAAW,iBAAiB;CAAG;AAErC,iDAAiD;AACjD,MAAM,WAAW,iBAAiB;CAAG;AAErC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,iBAAiB,CAAA;IAC7B,SAAS,EAAE,QAAQ,CAAA;IACnB,YAAY,EAAE,QAAQ,CAAA;IACtB,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,QAAQ,CAAA;IACjB,aAAa,EAAE,QAAQ,CAAA;IACvB,WAAW,EAAE,QAAQ,CAAA;IACrB,UAAU,EAAE,iBAAiB,CAAA;CAC9B;AAED,wEAAwE;AACxE,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACvC,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAC5B,YAAY,CAAC,EAAE,gBAAgB,CAAA;IAC/B,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,aAAa,CAAC,EAAE,gBAAgB,CAAA;IAChC,WAAW,CAAC,EAAE,gBAAgB,CAAA;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;CACxC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE3E,MAAM,WAAW,iBAAiB;CAAG;AAErC,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,iBAAiB,CAAA;IAC7B,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAA;IAClC,YAAY,EAAE,QAAQ,CAAA;IACtB,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAA;IAClC,OAAO,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAA;IAC9B,aAAa,EAAE,QAAQ,CAAA;IACvB,WAAW,EAAE,QAAQ,CAAA;IACrB,UAAU,EAAE,iBAAiB,CAAA;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACvC,SAAS,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAC3C,YAAY,CAAC,EAAE,gBAAgB,CAAA;IAC/B,QAAQ,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAA;IAC3C,OAAO,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAA;IACvC,aAAa,CAAC,EAAE,gBAAgB,CAAA;IAChC,WAAW,CAAC,EAAE,gBAAgB,CAAA;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;CACxC"}

package/dist/config/useFormatters.d.ts

@@ -0,0 +1,10 @@
+import { Module } from '../types';
+export interface BoundFormatters {
+    moduleLabel: (position: number, module: Module) => string | null;
+    dueByline: (iso: string, today: Date) => string;
+    unlockByline: (iso: string, today: Date) => string;
+    points: (pointsPossible: number | null | undefined) => string | null;
+    progress: (percentComplete: number, met: number, total: number) => string;
+}
+export declare function useFormatters(): BoundFormatters;
+//# sourceMappingURL=useFormatters.d.ts.map

package/dist/config/useFormatters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFormatters.d.ts","sourceRoot":"","sources":["../../src/config/useFormatters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGtC,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IAChE,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,MAAM,CAAA;IAC/C,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,MAAM,CAAA;IAClD,MAAM,EAAE,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,KAAK,MAAM,GAAG,IAAI,CAAA;IACpE,QAAQ,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;CAC1E;AAED,wBAAgB,aAAa,IAAI,eAAe,CAiB/C"}

package/dist/fixtures/generate.d.ts

@@ -1,47 +1,11 @@
 import { InMemoryFixture } from '../adapters/inMemory';
 import { ModuleStatus } from '../types/domain';
-/**
- * The full `ModuleStatus` enum, one per module, cycled.
- *
- * Exported because it is also the reason `SMALL_MODULE_COUNT` is what it is:
- * a fixture shorter than this cycle cannot show every state.
- */
 export declare const MODULE_STATUS_CYCLE: readonly ModuleStatus[];
-/** The course every fixture belongs to; only used to build plausible URLs. */
 export declare const FIXTURE_COURSE_ID = "1";
-/**
- * Build a fixture from a per-module item count, e.g. `[8, 250, 8]` is three
- * modules where the middle one is far past the inline limit.
- */
-/**
- * Which audience the fixture describes.
- *
- * Not cosmetic: the two shapes are mutually exclusive in Canvas, and a fixture
- * that mixes them describes a page no host can ever render.
- *
- * - `student` — everything is published, and every module carries a `progress`
- *   with every item a `status`. A student's module list contains no unpublished
- *   content at all; that is exactly why normalization rule 2 reads a null
- *   `published` as `true` for a viewer without manage permission.
- * - `teacher` — publish state varies, and nothing carries progress. Canvas
- *   resolves `progression` to null for a viewer with no progression record, so a
- *   teacher fixture with a `progress` would be describing a student.
- *
- * The bug this fixes: the generator used to emit unpublished modules *and*
- * student progress on the same module, so `courseSmall`'s module 4 rendered as
- * "(unpublished)" next to a progress bar — a combination that cannot occur.
- */
+/** `student` publishes everything and carries progress. `teacher` does neither. */
 export type FixtureView = 'student' | 'teacher';
 export interface BuildFixtureOptions {
-    /** Defaults to `student`. */
     view?: FixtureView;
-    /**
-     * Which course the fixture is for. Defaults to `FIXTURE_COURSE_ID` ('1').
-     *
-     * Override it to prove a hook actually threads `courseId` through: with every
-     * fixture on course '1', a hook that hardcoded '1' internally would be
-     * indistinguishable from one that passed the caller's value.
-     */
     courseId?: string;
 }
 export declare function buildFixture(itemCounts: readonly number[], options?: BuildFixtureOptions): InMemoryFixture;

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

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/fixtures/generate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAQV,YAAY,EACb,MAAM,iBAAiB,CAAA;AA4DxB;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,EAAE,SAAS,YAAY,EAOtD,CAAA;AA6BD,8EAA8E;AAC9E,eAAO,MAAM,iBAAiB,MAAM,CAAA;AA4PpC;;;GAGG;AACH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,CAAA;AAE/C,MAAM,WAAW,mBAAmB;IAClC,6BAA6B;IAC7B,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAgBD,wBAAgB,YAAY,CAC1B,UAAU,EAAE,SAAS,MAAM,EAAE,EAC7B,OAAO,GAAE,mBAAwB,GAChC,eAAe,CAiBjB"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/fixtures/generate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAQV,YAAY,EACb,MAAM,iBAAiB,CAAA;AAcxB,eAAO,MAAM,mBAAmB,EAAE,SAAS,YAAY,EAQtD,CAAA;AAoBD,eAAO,MAAM,iBAAiB,MAAM,CAAA;AAsOpC,mFAAmF;AACnF,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,CAAA;AAE/C,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAeD,wBAAgB,YAAY,CAC1B,UAAU,EAAE,SAAS,MAAM,EAAE,EAC7B,OAAO,GAAE,mBAAwB,GAChC,eAAe,CAiBjB"}

package/dist/fixtures/index.d.ts

@@ -1,3 +1,3 @@
 export { buildFixture, type BuildFixtureOptions, FIXTURE_COURSE_ID, type FixtureView, MODULE_STATUS_CYCLE, } from './generate';
-export { courseEmpty, courseFatModule, courseItemLinks, courseLarge, courseSmall, FAT_MODULE_ITEM_COUNT, FAT_MODULE_SIBLING_ITEM_COUNT, LARGE_ITEMS_PER_MODULE, LARGE_MODULE_COUNT, SMALL_ITEMS_PER_MODULE, SMALL_MODULE_COUNT, } from './scenarios';
+export { courseEmpty, courseFatModule, courseItemLinks, courseItemRowVariants, courseLarge, courseLockReasons, courseSmall, FAT_MODULE_ITEM_COUNT, FAT_MODULE_SIBLING_ITEM_COUNT, FUTURE_UNLOCK_AT, LARGE_ITEMS_PER_MODULE, LARGE_MODULE_COUNT, PAST_UNLOCK_AT, SMALL_ITEMS_PER_MODULE, SMALL_MODULE_COUNT, } from './scenarios';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,KAAK,mBAAmB,EACxB,iBAAiB,EACjB,KAAK,WAAW,EAChB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,WAAW,EACX,eAAe,EACf,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,6BAA6B,EAC7B,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,KAAK,mBAAmB,EACxB,iBAAiB,EACjB,KAAK,WAAW,EAChB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,WAAW,EACX,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,WAAW,EACX,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,6BAA6B,EAC7B,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,cAAc,EACd,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,aAAa,CAAA"}

package/dist/fixtures/scenarios.d.ts

@@ -1,47 +1,17 @@
 import { InMemoryFixture } from '../adapters/inMemory';
-/**
- * Four named scales. Each one exists to make a specific failure impossible to
- * ship silently, so they are sized against real Canvas limits rather than
- * chosen for convenience.
- */
-/**
- * 6 modules × 8 items. Inline mode resolves; the whole course in ~2 requests.
- *
- * The module count is `MODULE_STATUS_CYCLE.length` rather than a round number:
- * this is the fixture a story reaches for by default, and at five modules it
- * would silently omit one of the six `ModuleStatus` states.
- */
+export declare const FUTURE_UNLOCK_AT = "2099-08-31T06:59:00Z";
+export declare const PAST_UNLOCK_AT = "2020-01-06T07:00:00Z";
 export declare const SMALL_MODULE_COUNT: number;
 export declare const SMALL_ITEMS_PER_MODULE = 8;
-/** 120 modules × 25 items. Past the 100-per-page module limit Career truncates at. */
 export declare const LARGE_MODULE_COUNT = 120;
 export declare const LARGE_ITEMS_PER_MODULE = 25;
-/** 3 modules, the middle one 250 items — 2.5× `INLINE_ITEM_LIMIT`. */
 export declare const FAT_MODULE_ITEM_COUNT = 250;
 export declare const FAT_MODULE_SIBLING_ITEM_COUNT = 8;
-/**
- * The happy path: everything fits in one page of modules with items inlined,
- * so a correct implementation renders the course in about two requests.
- */
 export declare function courseSmall(): InMemoryFixture;
-/**
- * Module-list pagination past 100. Canvas caps `per_page` at 100, so a client
- * that ignores the next cursor shows 100 of 120 modules and says nothing —
- * which is what Canvas Career does today.
- */
 export declare function courseLarge(): InMemoryFixture;
-/**
- * Item pagination past `INLINE_ITEM_LIMIT`. Canvas omits the `items` key
- * entirely for the fat module, so the client must fall back to a per-module
- * fetch and then page it. The "renders exactly 100 items and stops" bug lives
- * here and cannot recur while this fixture is in the suite.
- */
 export declare function courseFatModule(): InMemoryFixture;
-/** No modules at all. The empty state exists before the designs specify it. */
+export declare function courseLockReasons(): InMemoryFixture;
 export declare function courseEmpty(): InMemoryFixture;
-/**
- * The item-title edge cases, hand-authored: linked, new tab, sub-header, no url,
- * a very long title, and locked.
- */
+export declare function courseItemRowVariants(): InMemoryFixture;
 export declare function courseItemLinks(): InMemoryFixture;
 //# sourceMappingURL=scenarios.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"scenarios.d.ts","sourceRoot":"","sources":["../../src/fixtures/scenarios.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAO3D;;;;GAIG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAmC,CAAA;AACpE,eAAO,MAAM,sBAAsB,IAAI,CAAA;AAEvC,sFAAsF;AACtF,eAAO,MAAM,kBAAkB,MAAM,CAAA;AACrC,eAAO,MAAM,sBAAsB,KAAK,CAAA;AAExC,sEAAsE;AACtE,eAAO,MAAM,qBAAqB,MAAM,CAAA;AACxC,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAE9C;;;GAGG;AACH,wBAAgB,WAAW,IAAI,eAAe,CAE7C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,IAAI,eAAe,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,eAAe,CAMjD;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,IAAI,eAAe,CAE7C;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,eAAe,CA8CjD"}
+{"version":3,"file":"scenarios.d.ts","sourceRoot":"","sources":["../../src/fixtures/scenarios.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAM3D,eAAO,MAAM,gBAAgB,yBAAyB,CAAA;AACtD,eAAO,MAAM,cAAc,yBAAyB,CAAA;AAEpD,eAAO,MAAM,kBAAkB,EAAE,MAAmC,CAAA;AACpE,eAAO,MAAM,sBAAsB,IAAI,CAAA;AAEvC,eAAO,MAAM,kBAAkB,MAAM,CAAA;AACrC,eAAO,MAAM,sBAAsB,KAAK,CAAA;AAExC,eAAO,MAAM,qBAAqB,MAAM,CAAA;AACxC,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAE9C,wBAAgB,WAAW,IAAI,eAAe,CAE7C;AAED,wBAAgB,WAAW,IAAI,eAAe,CAE7C;AAED,wBAAgB,eAAe,IAAI,eAAe,CAMjD;AAED,wBAAgB,iBAAiB,IAAI,eAAe,CAyCnD;AAED,wBAAgB,WAAW,IAAI,eAAe,CAE7C;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CAmEvD;AAED,wBAAgB,eAAe,IAAI,eAAe,CA8CjD"}

package/dist/hooks/constants.d.ts

@@ -1,49 +1,15 @@
 import { PageInfo } from '../types/domain';
-/** Canvas's `Api::MAX_PER_PAGE`. One page of modules per request by default. */
+/** Canvas's `Api::MAX_PER_PAGE`. */
 export declare const DEFAULT_PAGE_SIZE: number;
-/** Items are paged separately; same ceiling. */
+/** Items page separately, against the same ceiling. */
 export declare const DEFAULT_ITEM_PAGE_SIZE: number;
-/**
- * Per-module ceiling above which inlining stops being worthwhile.
- *
- * Matches `Api::MAX_PER_PAGE` and `INLINE_ITEM_LIMIT`. On REST that is Canvas's
- * own rule — the `items` key is simply absent above it. On GraphQL it is this
- * package's policy rather than a server constraint. @see INLINE_ITEM_LIMIT
- */
+/** Per-module ceiling above which inlining stops paying. @see INLINE_ITEM_LIMIT */
 export declare const DEFAULT_INLINE_THRESHOLD: number;
-/**
- * How many per-module item requests may be in flight at once.
- *
- * Expanding "all modules" on a 40-module course should not open 40 sockets;
- * browsers queue them anyway, but the server sees the whole burst.
- */
+/** Caps the burst the server sees when a user expands every module at once. */
 export declare const DEFAULT_ITEM_CONCURRENCY: number;
-/**
- * Why this is not zero.
- *
- * With `staleTime: 0` every re-enable of a query — which is what re-expanding a
- * module is — counts as stale and refetches. That is the behavior this package
- * exists to remove. Five minutes is long enough that expand/collapse within a
- * sitting is free, short enough that coming back to the tab later is honest.
- */
+/** Not zero: re-expanding a module re-enables its query, and a stale query refetches. */
 export declare const DEFAULT_STALE_TIME_MS: number;
-/**
- * How many *collapsed* modules keep their item query subscribed.
- *
- * A collapsed module's observer is retained on purpose — that is what makes
- * re-expanding a guaranteed cache hit rather than a lucky one. But retention has
- * to stop somewhere: "Expand all" followed by "Collapse all" on a 120-module
- * course would otherwise leave 120 subscriptions alive for the life of the page,
- * each pinning its own pages of items past any `gcTime`.
- *
- * Twenty is chosen against the interaction rather than the data: a reader moving
- * through a course revisits the handful of modules around where they are, and
- * twenty covers that with room to spare while keeping the retained set a fixed
- * cost instead of one that grows with course size. Above the cap the
- * least-recently-active collapsed module is evicted, and re-expanding it may
- * refetch.
- */
+/** A collapsed query stays subscribed and pins its cache entry. Past this the oldest is evicted. */
 export declare const DEFAULT_RETAIN_COLLAPSED_LIMIT: number;
-/** The pageInfo of a query that has not resolved yet. Never truncates silently. */
 export declare const EMPTY_PAGE_INFO: PageInfo;
 //# sourceMappingURL=constants.d.ts.map

package/dist/hooks/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/hooks/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE/C,gFAAgF;AAChF,eAAO,MAAM,iBAAiB,EAAE,MAAY,CAAA;AAE5C,gDAAgD;AAChD,eAAO,MAAM,sBAAsB,EAAE,MAAY,CAAA;AAEjD;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAY,CAAA;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAU,CAAA;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAsB,CAAA;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,8BAA8B,EAAE,MAAW,CAAA;AAExD,mFAAmF;AACnF,eAAO,MAAM,eAAe,EAAE,QAAkD,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/hooks/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE/C,oCAAoC;AACpC,eAAO,MAAM,iBAAiB,EAAE,MAAY,CAAA;AAE5C,uDAAuD;AACvD,eAAO,MAAM,sBAAsB,EAAE,MAAY,CAAA;AAEjD,mFAAmF;AACnF,eAAO,MAAM,wBAAwB,EAAE,MAAY,CAAA;AAEnD,+EAA+E;AAC/E,eAAO,MAAM,wBAAwB,EAAE,MAAU,CAAA;AAEjD,yFAAyF;AACzF,eAAO,MAAM,qBAAqB,EAAE,MAAsB,CAAA;AAE1D,oGAAoG;AACpG,eAAO,MAAM,8BAA8B,EAAE,MAAW,CAAA;AAExD,eAAO,MAAM,eAAe,EAAE,QAAkD,CAAA"}

package/dist/hooks/queryOptions.d.ts

@@ -3,20 +3,7 @@ import { LimitFunction } from 'p-limit';
 import { ModulesDataAdapter } from '../adapters/types';
 import { ModuleItemsKey, ModulesListKey, ModulesView } from '../cache/keys';
 import { ModuleItemsPage, ModulesPage } from '../types/domain';
-/**
- * The two query definitions this package has, factored out of the hooks.
- *
- * They live here because the same definition is consumed two ways: through
- * `useInfiniteQuery` (one module, one hook) and through a raw
- * `InfiniteQueryObserver` (a dynamic set of expanded modules, which React's
- * rules of hooks will not let you express as N `useInfiniteQuery` calls).
- * Sharing the factory is what guarantees both paths land on the *same* cache
- * entry, so a module fetched by one is a cache hit for the other.
- */
-/**
- * The page cursor. `null` is the first page — the adapter contract forbids
- * synthesizing cursors, so this is only ever `null` or something a server said.
- */
+import { FilterClause } from '../types/filterClause';
 export type ModulesCursor = string | null;
 export type ModulesQueryOptions = InfiniteQueryObserverOptions<ModulesPage, Error, InfiniteData<ModulesPage, ModulesCursor>, ModulesListKey, ModulesCursor>;
 export type ModuleItemsQueryOptions = InfiniteQueryObserverOptions<ModuleItemsPage, Error, InfiniteData<ModuleItemsPage, ModulesCursor>, ModuleItemsKey, ModulesCursor>;
@@ -25,9 +12,8 @@ export interface ModulesQueryArgs {
     adapter: ModulesDataAdapter;
     pageSize: number;
     includeItems: boolean;
-    /** Items to request per module when inlining. @see ListModulesArgs.inlineItemsFirst */
+    filter?: FilterClause;
     inlineItemsFirst?: number;
-    /** Modules to request when inlining. @see ListModulesArgs.inlineFirst */
     inlineFirst?: number;
     view?: ModulesView;
     staleTime: number;
@@ -38,19 +24,9 @@ export interface ModuleItemsQueryArgs {
     moduleId: string;
     adapter: ModulesDataAdapter;
     pageSize: number;
-    /**
-     * The audience this page is rendered for. Not sent to the adapter — a host
-     * configures its adapter for the current user — but it partitions the key,
-     * because `published` is a per-item field. See `ModuleItemsKeyOptions`.
-     */
     view?: ModulesView;
     staleTime: number;
     enabled: boolean;
-    /**
-     * Shared concurrency gate. Every expanded module's item fetch goes through
-     * the same limiter instance, so "expand all" is a trickle rather than a
-     * thundering herd.
-     */
     limit?: LimitFunction;
 }
 export declare function modulesQueryOptions(args: ModulesQueryArgs): ModulesQueryOptions;

package/dist/hooks/queryOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryOptions.d.ts","sourceRoot":"","sources":["../../src/hooks/queryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAA;AACvF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EACjB,MAAM,eAAe,CAAA;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAEnE;;;;;;;;;GASG;AAEH;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,IAAI,CAAA;AAEzC,MAAM,MAAM,mBAAmB,GAAG,4BAA4B,CAC5D,WAAW,EACX,KAAK,EACL,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,EACxC,cAAc,EACd,aAAa,CACd,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,4BAA4B,CAChE,eAAe,EACf,KAAK,EACL,YAAY,CAAC,eAAe,EAAE,aAAa,CAAC,EAC5C,cAAc,EACd,aAAa,CACd,CAAA;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,yEAAyE;IACzE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAYD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,GAAG,mBAAmB,CAmC/E;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,oBAAoB,GAAG,uBAAuB,CAyB3F"}
+{"version":3,"file":"queryOptions.d.ts","sourceRoot":"","sources":["../../src/hooks/queryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAA;AACvF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EACjB,MAAM,eAAe,CAAA;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,IAAI,CAAA;AAEzC,MAAM,MAAM,mBAAmB,GAAG,4BAA4B,CAC5D,WAAW,EACX,KAAK,EACL,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,EACxC,cAAc,EACd,aAAa,CACd,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,4BAA4B,CAChE,eAAe,EACf,KAAK,EACL,YAAY,CAAC,eAAe,EAAE,aAAa,CAAC,EAC5C,cAAc,EACd,aAAa,CACd,CAAA;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAMD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,GAAG,mBAAmB,CAiC/E;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,oBAAoB,GAAG,uBAAuB,CAsB3F"}

package/dist/hooks/useItemsMode.d.ts

@@ -1,114 +1,33 @@
 import { ModulesDataAdapter } from '../adapters/types';
 import { ModulesView } from '../cache/keys';
 import { ModulesPage } from '../types/domain';
-/**
- * How a course's module items get fetched.
- *
- * - `inline` — ask for items alongside the module list. One round trip for the
- *   whole page. Great for a small course, ruinous for a big one: the response
- *   grows with the number of items, and no module over `inlineThreshold` is
- *   inlined on either transport anyway (@see INLINE_ITEM_LIMIT).
- * - `onDemand` — fetch a module's items when it is expanded. Constant-cost
- *   first paint, one extra request per module the user actually opens.
- * - `auto` — probe, then pick. The default.
- */
+import { FilterClause } from '../types/filterClause';
 export type ItemsMode = 'auto' | 'inline' | 'onDemand';
-/** What `auto` collapses to. */
 export type ResolvedItemsMode = 'inline' | 'onDemand';
 export interface UseItemsModeOptions {
     courseId: string;
     adapter: ModulesDataAdapter;
     mode?: ItemsMode;
-    /** Per-module ceiling for inlining. Defaults to 100. @see INLINE_ITEM_LIMIT */
     inlineThreshold?: number;
-    /**
-     * Ceiling on the implied request's node product.
-     *
-     * Defaults to what the adapter declares (`inlineNodeBudget`), then to
-     * `INLINE_QUERY_NODE_BUDGET`. Pass it only to override both.
-     */
     nodeBudget?: number;
     pageSize?: number;
+    /** Must match what the list query gets. The probe shares its key. */
+    filter?: FilterClause;
     view?: ModulesView;
     staleTime?: number;
 }
 export interface UseItemsModeResult {
-    /** `null` while the `auto` probe is still in flight. */
     resolvedMode: ResolvedItemsMode | null;
     isResolving: boolean;
-    /** True when a probe request was actually needed — i.e. `mode` was `auto`. */
     probed: boolean;
     error: Error | null;
-    /**
-     * How many items to actually ask for per module when inlining, and how many
-     * modules to ask for — both measured from the probe rather than assumed.
-     *
-     * `null` when unknown (probe unresolved, or an explicit mode skipped it), in
-     * which case the adapter falls back to its own defaults.
-     *
-     * It exists because a transport can charge for the shape of the request rather
-     * than the size of the result, so asking for what the probe actually saw is
-     * what keeps an inline page deliverable. @see INLINE_QUERY_NODE_BUDGET
-     */
     inlineShape: InlineQueryShape | null;
 }
-/** What an inline `listModules` should request, measured from the probe. */
 export interface InlineQueryShape {
-    /** Modules on page 1. */
     moduleCount: number;
-    /** The largest `itemCount` among them. */
     maxItemCount: number;
 }
-/**
- * The policy itself, as a pure function over the probe's first page.
- *
- * Inline is chosen only when all three hold:
- *
- *   1. The first page is the whole list. If there is a second page of modules,
- *      the course total is unknown, and guessing from a partial view is how you
- *      end up inlining a 3000-item course. Conservative on purpose.
- *   2. No single module exceeds `inlineThreshold`. Above it no adapter inlines
- *      the module — REST because Canvas drops the `items` key, GraphQL because
- *      this package declines to — so inlining buys nothing there and it would
- *      need an on-demand fetch regardless.
- *   3. The course total is within `inlineThreshold * 2`. One module at the
- *      ceiling is fine; forty of them is a payload nobody asked for.
- *   4. The implied request fits Canvas's complexity budget. Rules 1-3 bound the
- *      *data*; this one bounds the *query*, and they are not the same thing.
- *      @see INLINE_QUERY_NODE_BUDGET
- *
- * Exported so the policy can be unit-tested without React.
- */
 export declare function resolveItemsMode(firstPage: ModulesPage, inlineThreshold: number, nodeBudget?: number): ResolvedItemsMode;
-/**
- * Resolves the items mode for a course.
- *
- * An explicit `mode` skips the probe entirely — the probe query is disabled, so
- * it costs zero requests.
- *
- * For `auto`, the probe *is* the module list query with `includeItems: false`.
- * That matters: if the probe resolves to `onDemand`, the page's own list query
- * has the identical cache key and the probe becomes the first page for free. A
- * second request happens only when the answer is `inline`, because inlined
- * modules are a genuinely different payload and get their own key.
- *
- * Known cost of that shape, in the `auto -> inline` case only: the probe query
- * stays mounted and enabled on its own key alongside the list query's, since
- * `cache/keys.ts` partitions on `includeItems`. So `invalidateModuleList` refetches
- * both where one would do, and a course that changes shape between refetches can
- * flip the resolved mode mid-session. Neither is wrong, but neither is free —
- * disabling the probe once it has answered would fix the first and make the second
- * explicit.
- *
- * The decision is read from page 1 only, so paging further into the list can
- * never flip the mode out from under a rendered page.
- */
 export declare function useItemsMode(options: UseItemsModeOptions): UseItemsModeResult;
-/**
- * The smallest request that still returns the whole page inline.
- *
- * `maxItemCount` is at least 1 because `first: 0` is not a meaningful request,
- * and a course of entirely empty modules should still round-trip.
- */
 export declare function inlineShapeOf(firstPage: ModulesPage): InlineQueryShape;
 //# sourceMappingURL=useItemsMode.d.ts.map

package/dist/hooks/useItemsMode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useItemsMode.d.ts","sourceRoot":"","sources":["../../src/hooks/useItemsMode.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAIlD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEtD,gCAAgC;AAChC,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAA;AAErD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,+EAA+E;IAC/E,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,YAAY,EAAE,iBAAiB,GAAG,IAAI,CAAA;IACtC,WAAW,EAAE,OAAO,CAAA;IACpB,8EAA8E;IAC9E,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IACnB;;;;;;;;;;OAUG;IACH,WAAW,EAAE,gBAAgB,GAAG,IAAI,CAAA;CACrC;AAED,4EAA4E;AAC5E,MAAM,WAAW,gBAAgB;IAC/B,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,WAAW,EACtB,eAAe,EAAE,MAAM,EACvB,UAAU,GAAE,MAAiC,GAC5C,iBAAiB,CAuBnB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,kBAAkB,CA6D7E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,WAAW,GAAG,gBAAgB,CAMtE"}
+{"version":3,"file":"useItemsMode.d.ts","sourceRoot":"","sources":["../../src/hooks/useItemsMode.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAIzD,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEtD,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAA;AAErD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,qEAAqE;IACrE,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,iBAAiB,GAAG,IAAI,CAAA;IACtC,WAAW,EAAE,OAAO,CAAA;IACpB,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IACnB,WAAW,EAAE,gBAAgB,GAAG,IAAI,CAAA;CACrC;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,WAAW,EACtB,eAAe,EAAE,MAAM,EACvB,UAAU,GAAE,MAAiC,GAC5C,iBAAiB,CAgBnB;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,kBAAkB,CA4D7E;AAED,wBAAgB,aAAa,CAAC,SAAS,EAAE,WAAW,GAAG,gBAAgB,CAMtE"}

package/dist/hooks/useModuleItemQueries.d.ts

@@ -1,56 +1,12 @@
 import { InfiniteData, InfiniteQueryObserverResult } from '@tanstack/react-query';
 import { ModuleItemsPage } from '../types/domain';
 import { ModuleItemsQueryOptions, ModulesCursor } from './queryOptions';
-/**
- * A dynamic set of module-item infinite queries.
- *
- * ## Why this is not N `useModuleItems` calls
- *
- * The number of expanded modules changes at runtime, and React's rules of hooks
- * forbid a variable number of hook calls. `useQueries` would solve it for plain
- * queries, but it builds `QueryObserver`s, not `InfiniteQueryObserver`s — there
- * is no `useInfiniteQueries`. So this hook does what `useQueries` does
- * internally: it owns a map of observers keyed by module id, subscribes to each,
- * and republishes their results into React state.
- *
- * The observers are built from the same `moduleItemsQueryOptions` factory
- * `useModuleItems` uses, so both paths hit the same cache entry.
- *
- * ## Why a collapsed module keeps its observer
- *
- * Collapsing flips a module's options to `enabled: false` and leaves the
- * subscription in place, which pins the cache entry no matter how aggressive the
- * host's `gcTime` is. Re-expanding is then a cache hit by construction rather
- * than by luck.
- *
- * ## Why the retained set is nevertheless bounded
- *
- * "Bounded by the modules a user actually opened" is only reassuring while
- * opening a module is a click. `ModulesList` has an "Expand all", which on the
- * 120-module fixture would leave 120 subscribed `InfiniteQueryObserver`s alive
- * for the life of the page — each pinning its own pages of items — even after
- * the user collapsed the lot.
- *
- * So retention is capped at `retainCollapsedLimit` *collapsed* observers, evicted
- * least-recently-active first. Active observers are never evicted, whatever the
- * limit: they are the ones with something on screen. Eviction destroys the
- * observer, which unpins its cache entry and lets the host's `gcTime` apply —
- * meaning re-expanding an evicted module may refetch. That is the trade, and it
- * is the right way round: a guaranteed cache hit on the last N modules touched
- * beats an unbounded set of subscriptions.
- */
 type ItemsData = InfiniteData<ModuleItemsPage, ModulesCursor>;
 export type ModuleItemsObserverResult = InfiniteQueryObserverResult<ItemsData, Error>;
 export interface ModuleItemQueries {
     results: ReadonlyMap<string, ModuleItemsObserverResult>;
     fetchNextPage: (moduleId: string) => void;
 }
-export declare function useModuleItemQueries(
-/** Modules whose items should be fetching right now. */
-activeModuleIds: readonly string[], 
-/** Must be referentially stable — memoize it in the caller. */
-buildOptions: (moduleId: string, enabled: boolean) => ModuleItemsQueryOptions, 
-/** @see DEFAULT_RETAIN_COLLAPSED_LIMIT */
-retainCollapsedLimit?: number): ModuleItemQueries;
+export declare function useModuleItemQueries(activeModuleIds: readonly string[], buildOptions: (moduleId: string, enabled: boolean) => ModuleItemsQueryOptions, retainCollapsedLimit?: number): ModuleItemQueries;
 export {};
 //# sourceMappingURL=useModuleItemQueries.d.ts.map

package/dist/hooks/useModuleItemQueries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useModuleItemQueries.d.ts","sourceRoot":"","sources":["../../src/hooks/useModuleItemQueries.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,YAAY,EACjB,KAAK,2BAA2B,EACjC,MAAM,uBAAuB,CAAA;AAG9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,OAAO,KAAK,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,KAAK,SAAS,GAAG,YAAY,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;AAE7D,MAAM,MAAM,yBAAyB,GAAG,2BAA2B,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;AAUrF,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;IACvD,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CAC1C;AAOD,wBAAgB,oBAAoB;AAClC,wDAAwD;AACxD,eAAe,EAAE,SAAS,MAAM,EAAE;AAClC,+DAA+D;AAC/D,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,uBAAuB;AAC7E,0CAA0C;AAC1C,oBAAoB,GAAE,MAAuC,GAC5D,iBAAiB,CAoGnB"}
+{"version":3,"file":"useModuleItemQueries.d.ts","sourceRoot":"","sources":["../../src/hooks/useModuleItemQueries.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,YAAY,EACjB,KAAK,2BAA2B,EACjC,MAAM,uBAAuB,CAAA;AAG9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,OAAO,KAAK,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE5E,KAAK,SAAS,GAAG,YAAY,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;AAE7D,MAAM,MAAM,yBAAyB,GAAG,2BAA2B,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;AAUrF,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;IACvD,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CAC1C;AAMD,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,SAAS,MAAM,EAAE,EAClC,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,uBAAuB,EAC7E,oBAAoB,GAAE,MAAuC,GAC5D,iBAAiB,CA4EnB"}

package/dist/hooks/useModuleItems.d.ts

@@ -7,13 +7,7 @@ export interface UseModuleItemsOptions {
     moduleId: string;
     adapter: ModulesDataAdapter;
     pageSize?: number;
-    /** The audience being rendered. Partitions the cache; see `ModuleItemsKeyOptions`. */
     view?: ModulesView;
-    /**
-     * Set to the module's expanded state. A collapsed module fetches nothing, and
-     * — because the query stays mounted while disabled — re-expanding it is a
-     * cache hit rather than a refetch.
-     */
     enabled?: boolean;
     staleTime?: number;
     limit?: LimitFunction;
@@ -27,15 +21,5 @@ export interface UseModuleItemsResult {
     isFetchingNextPage: boolean;
     error: Error | null;
 }
-/**
- * One module's items, paged explicitly, keyed per module.
- *
- * The query's `AbortSignal` is handed to the adapter (in `queryOptions.ts`), so
- * canceling the query — which is what collapsing a module does — aborts the
- * request rather than letting a response nobody wants land in the cache.
- *
- * `useModulesPageData` is the hook a page should use; this one is for a caller
- * that already knows it wants exactly one module.
- */
 export declare function useModuleItems(options: UseModuleItemsOptions): UseModuleItemsResult;
 //# sourceMappingURL=useModuleItems.d.ts.map

package/dist/hooks/useModuleItems.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useModuleItems.d.ts","sourceRoot":"","sources":["../../src/hooks/useModuleItems.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAI3D,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sFAAsF;IACtF,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,QAAQ,EAAE,QAAQ,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,aAAa,EAAE,MAAM,IAAI,CAAA;IACzB,SAAS,EAAE,OAAO,CAAA;IAClB,kBAAkB,EAAE,OAAO,CAAA;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,oBAAoB,CA2CnF"}
+{"version":3,"file":"useModuleItems.d.ts","sourceRoot":"","sources":["../../src/hooks/useModuleItems.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAI3D,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,QAAQ,EAAE,QAAQ,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,aAAa,EAAE,MAAM,IAAI,CAAA;IACzB,SAAS,EAAE,OAAO,CAAA;IAClB,kBAAkB,EAAE,OAAO,CAAA;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACpB;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,oBAAoB,CA2CnF"}