@webspellchecker/wproofreader-learnosity

WProofreader for Learnosity. Spelling, grammar and style assistance inside Learnosity rich-text widgets, with one function call.

v1.2.1. Apache-2.0. TypeScript definitions included. Two install paths: npm (ESM) and CDN (IIFE). Cloud and self-hosted WProofreader. Per-editor surface filter, lifecycle cleanup, locale-aware defaults, optional escape hatches for unusual host apps.

Install

The connector offers two install paths. The runtime API is identical, LearnosityWProofreader.init({...}) in both.

Via npm (Node host apps)

npm install @webspellchecker/wproofreader-learnosity

import LearnosityWProofreader from '@webspellchecker/wproofreader-learnosity';

LearnosityWProofreader.init({
  wproofreader: { serviceId: 'YOUR_WPROOFREADER_SERVICE_ID' }
});

Via <script> tag (non-Node host apps)

For host apps where adding a bundler is overkill (classic HTML, PHP, Python, Java, ASP.NET, Ruby), load the connector from jsDelivr:

<script src="https://cdn.jsdelivr.net/npm/@webspellchecker/[email protected]/dist/wproofreader-learnosity.min.js"></script>
<script>
  LearnosityWProofreader.init({
    wproofreader: { serviceId: 'YOUR_WPROOFREADER_SERVICE_ID' }
  });
</script>

The bundle exposes a single global, window.LearnosityWProofreader, with the same init method. About 5 KB minified, no runtime dependencies. jsDelivr serves from npm, so the pinned URL above resolves once the package is published.

Quickstart

import LearnosityWProofreader from '@webspellchecker/wproofreader-learnosity';

// Before Learnosity widgets render.
LearnosityWProofreader.init({
  wproofreader: { serviceId: 'YOUR_WPROOFREADER_SERVICE_ID' }
});

// Initialise Learnosity as normal. The connector attaches to longtextV2 editors automatically.
LearnosityApp.init(signedRequest, {
  readyListener() { console.log('Learnosity ready'); },
  errorListener(err) { console.error(err); }
});

init() is idempotent: calling it again updates the live configuration without reloading the WProofreader bundle.

Getting a service ID

WProofreader is a commercial service from WebSpellChecker. The service ID passed to init({ wproofreader: { serviceId } }) is your account's activation key.

• Free trial: https://webspellchecker.com/free-trial/ issues a service ID for evaluation.
• Paid subscription converts the trial to a production licence with the domain set you need.
• Domain locking: every service ID is bound to a list of allowed origins. Whitelist your production and development domains in the WebSpellChecker dashboard; otherwise the spell-check API returns 403 for those origins.

If you run WProofreader on your own infrastructure (Docker, Helm, on-prem) you skip the service ID entirely. See Self-hosted WProofreader below.

Self-hosted WProofreader

For customers running the WProofreader Server on their own infrastructure (Docker, Helm, on-prem), pass the service connection options inside the wproofreader block instead of (or alongside) serviceId. Every property on wproofreader is forwarded to WProofreader unchanged:

LearnosityWProofreader.init({
  wproofreader: {
    serviceProtocol: 'https',
    serviceHost: 'localhost',
    servicePort: 443,
    servicePath: '/wscservice/api'
  },
  bundleUrl: 'https://localhost/wscservice/wscbundle/wscbundle.js'
});

Either wproofreader.serviceId or wproofreader.serviceHost must be set; otherwise init() no-ops with a console warning.

Configuration

init() takes a single options object with two groups: a nested wproofreader sub-object (forwarded to WProofreader unchanged) and connector-only fields at the top level.

WProofreader options (under wproofreader)

These pass straight through to WProofreader's runtime config. The tables below cover the frequently-used ones; the full surface is documented in Documentation and support.

| Option | Default | Notes | |-------------------|--------------------------------------|--------------------------------------------------------| | serviceId | none | WProofreader Cloud service ID. Domain-locked server-side. Required for the Cloud path. Omit when using a self-hosted deployment. | | serviceProtocol | none | Self-hosted: 'http' or 'https'. | | serviceHost | none | Self-hosted: WProofreader server hostname. Presence of serviceHost (or serviceId) is what activates init(). | | servicePort | none | Self-hosted: port. | | servicePath | none | Self-hosted: URL path to the WProofreader API. | | enableGrammar | true | Grammar checking on top of spell checking. | | autocorrect | true | Suggested replacement on typo accept. | | lang | host page's <html lang>, or en_US| Read from <html lang> with - normalised to _ (e.g. en-US → en_US). Falls back to en_US if the page does not set a lang or sets a bare un-regioned one (en, fr), because WProofreader expects region-qualified codes. Pass explicitly to override. |

If neither wproofreader.serviceId nor wproofreader.serviceHost is set, init() no-ops with a console warning so the host app can call it unconditionally.

Connector options (top level)

| Option | Default | Notes | |-------------------|---------------|--------------------------------------------------------| | surfaces | ['author'] | Subset of ['questions','items','author']. Per-editor filter: each editor's ancestry is walked for surface-specific markers (lrn-author* → author, lrn_player* → items, otherwise → questions); editors whose surface is not in the allowed list are skipped. Default is Author only, for assessment integrity. Opt in to assessment proofreading explicitly with ['questions', 'items', 'author']. | | enableShorttext | false | Also attach to shorttext inputs (<input type="text">) inside Learnosity scope. Off by default because plain text inputs are usually short and proofreading them is noisy. | | customSelectors | [] | Extra ancestor CSS selectors that count as "inside Learnosity scope" for unusual host apps. Each entry is matched via element.matches. | | bundleUrl | (default CDN) | Override the WProofreader bundle URL for non-default CDNs or self-hosted servers. |

Examples

// Authoring-only (the default). No-ops on assessment pages.
LearnosityWProofreader.init({
  wproofreader: { serviceId: '...' }
});

// All three surfaces, including assessment. The host app should derive this
// from server-side activity metadata so it cannot be flipped from the console.
LearnosityWProofreader.init({
  wproofreader: { serviceId: '...' },
  surfaces: ['questions', 'items', 'author']
});

// Unusual host app that wraps Learnosity inside its own container class.
LearnosityWProofreader.init({
  wproofreader: { serviceId: '...' },
  customSelectors: ['.my-host-app-learnosity-region']
});

Supported surfaces

| Learnosity API | Surface | |----------------|-------------------------------| | Questions API | longtextV2 (rich-text essay) | | Author API | All rich-text fields | | Items API | assess rendering type |

shorttext (plain text input) is opt-in via enableShorttext: true.

Supported Learnosity versions

Tested manually against the latest-lts channel. The connector tracks editor placement via the lrn-prefixed class convention plus a small per-surface marker set; class-rename changes between LTS releases are an isolated update in src/index.js.

Documentation and support

• WProofreader product page: https://webspellchecker.com/wsc-proofreader/
• Configuration reference (every WProofreader option beyond what this connector documents): https://webspellchecker.com/docs/api/wscbundle/Options.html
• WProofreader SDK source (the underlying library the connector wraps): https://github.com/WebSpellChecker/wproofreader-sdk-js
• Self-hosted server image: https://hub.docker.com/r/webspellchecker/wproofreader
• Contact and commercial enquiries: https://webspellchecker.com/contact-us/

Tests

npm install
npm test

npm test runs the unit suite under node --test.

License

Apache-2.0. See LICENSE.