Correxit¶

Tokens and contracts for composing Correxit JupyterLab plugins.

Namespaces¶

Namespace	Description
CommandIDs	-
Error	-
Icons	-
Unlocker	-

Type Aliases¶

Collector¶

Collector = (certified) => Promise\<string | null>

Defined in: src/correxit/correxit.ts:13

A collector of certified workbook grades.

Parameters¶

Parameter	Type
`certified`	`Certified`

Returns¶

Promise\<string | null>

Distributor¶

Distributor = (propagated) => Promise\<boolean>

Defined in: src/correxit/correxit.ts:28

Called for each assignee during propagation, and again on a single-workbook retry. Returns true to confirm delivery (the propagator attempts to write the local file with assignment.distribution recorded, and emits distributed only when that save succeeds), false to skip the assignee without writing a local file (the propagator emits skipped), or throws to signal an unexpected failure (the propagator attempts to write the local file for recovery but emits distribute-error and does not record assignment.distribution). A distributor with no external target should return true unconditionally.

Parameters¶

Parameter	Type
`propagated`	{ `identifier`: `Assigned`; `notebook`: `INotebookContent`; `overwrite`: `boolean`; `path`: `string`; `resources`: `Resource`[] \| `null`; }
`propagated.identifier`	`Assigned`
`propagated.notebook`	`INotebookContent`
`propagated.overwrite`	`boolean`
`propagated.path`	`string`
`propagated.resources`	`Resource`[] \| `null`

Returns¶

Promise\<boolean>

Injector¶

Injector = (workbook) => void

Defined in: src/correxit/correxit.ts:36

Parameters¶

Parameter	Type
`workbook`	`Workbook` \| `null`

Returns¶

void

Monitor¶

Monitor = AsyncIterable\<Workbook | null>

Defined in: src/correxit/correxit.ts:39

Connects/disconnects workbooks and yields them to plugins.

Registrar¶

Registrar = (workbook, identifier) => Promise\<Registration[] | object[] | null>

Defined in: src/correxit/correxit.ts:48

A registrar that provides assignment registrations for a workbook.

Notes¶

If the returned registrations are null, assignment input is unlocked. If registrations are empty or populated, assignment input is locked.

Parameters¶

Parameter	Type
`workbook`	`Workbook`
`identifier`	`Identifier`

Returns¶

Promise\<Registration[] | object[] | null>

Resource¶

Resource = object

Defined in: src/correxit/correxit.ts:60

A simple sidecar file utility type to encapsulate required workbook files.

Properties¶

data¶

data: Uint8Array

Defined in: src/correxit/correxit.ts:60

name¶

name: string

Defined in: src/correxit/correxit.ts:60

Submitter¶

Submitter = (workbook, identifier) => Promise\<string | null>

Defined in: src/correxit/correxit.ts:62

Parameters¶

Parameter	Type
`workbook`	`Workbook`
`identifier`	`Assigned`

Returns¶

Promise\<string | null>

Unlocker¶

Unlocker = object

Defined in: src/correxit/correxit.ts:67

Methods¶

request()¶

request(workbook, purpose, credentials): Promise\<{ secret: Secret | null; } | null>

Defined in: src/correxit/correxit.ts:76

Acquire credentials without changing the workbook. Null cancels; { secret: null } submits without revision access or skips recovery. Throw on denied access or failed custody; commands stop on failure.

Parameters¶

Parameter	Type
`workbook`	`Workbook`
`purpose`	`Purpose`
`credentials`	`Partial`\<`Credentials`> \| `null`

Returns¶

Promise\<{ secret: Secret | null; } | null>

store()¶

store(id, key): Promise\<void>

Defined in: src/correxit/correxit.ts:69

Store an author key for a given rubric id.

Parameters¶

Parameter	Type
`id`	`string`
`key`	`string`

Returns¶

Promise\<void>

unlock()¶

unlock(workbook, credentials): Promise\<Unlocked | null>

Defined in: src/correxit/correxit.ts:83

Authenticate and unlock the author-side rubric.

Parameters¶

Parameter	Type
`workbook`	`Workbook`
`credentials`	`Partial`\<Credentials & { silent: boolean; }> \| `null`

Returns¶

Promise\<Unlocked | null>

Variables¶

Collector¶

Collector: Token\<Collector>

Defined in: src/correxit/correxit.ts:13

COLLECTOR¶

const COLLECTOR: "correxit:collector" = 'correxit:collector'

Defined in: src/correxit/correxit.ts:93

commands¶

const commands: (app, utilities) => IDisposable[] = COMMANDS

Defined in: src/correxit/correxit.ts:99

Parameters¶

Parameter	Type
`app`	`JupyterFrontEnd`
`utilities`	{ `collector`: `Collector`; `distributor`: `Distributor`; `documents`: `IDocumentManager`; `injector`: `Injector`; `registrar`: `Registrar`; `submitter`: `Submitter`; `translator`: `ITranslator`; `unlocker`: `Unlocker`; }
`utilities.collector`	`Collector`
`utilities.distributor`	`Distributor`
`utilities.documents`	`IDocumentManager`
`utilities.injector`	`Injector`
`utilities.registrar`	`Registrar`
`utilities.submitter`	`Submitter`
`utilities.translator`	`ITranslator`
`utilities.unlocker`	`Unlocker`