@lti-tool/core 0.13.0 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lti-tool/core
 
+## 0.13.1
+
+### Patch Changes
+
+- 7bb4c98: Improve JSDoc for service layers
+
 ## 0.13.0
 
 ### Minor Changes

package/dist/ltiTool.js

@@ -446,7 +446,7 @@ export class LTITool {
      */
     async completeDynamicRegistration(dynamicRegistrationForm) {
         if (!this.dynamicRegistrationService) {
-            throw new Error('Dynmaic registration service is not configured');
+            throw new Error('Dynamic registration service is not configured');
         }
         return await this.dynamicRegistrationService.completeDynamicRegistration(dynamicRegistrationForm);
     }

package/dist/services/ags.service.d.ts

@@ -14,6 +14,13 @@ export declare class AGSService {
     private tokenService;
     private storage;
     private logger;
+    /**
+     * Creates a new AGSService instance.
+     *
+     * @param tokenService - Token service for obtaining OAuth2 bearer tokens
+     * @param storage - Storage adapter for retrieving launch configurations
+     * @param logger - Logger instance for debug and error logging
+     */
     constructor(tokenService: TokenService, storage: LTIStorage, logger: BaseLogger);
     /**
      * Submits a grade score to the platform using LTI Assignment and Grade Services.
@@ -108,6 +115,16 @@ export declare class AGSService {
      * @param updateLineItem - Updated line item data including all required fields
      * @returns Promise resolving to the HTTP response containing the updated line item
      * @throws {Error} When AGS line item service is not available for the session or update fails
+     *
+     * @example
+     * ```typescript
+     * const response = await agsService.updateLineItem(session, {
+     *   label: 'Quiz 1 (Updated)',
+     *   scoreMaximum: 100,
+     *   tag: 'quiz'
+     * });
+     * const updatedLineItem = await response.json();
+     * ```
      */
     updateLineItem(session: LTISession, updateLineItem: UpdateLineItem): Promise<Response>;
     /**
@@ -116,6 +133,12 @@ export declare class AGSService {
      * @param session - Active LTI session containing AGS line item endpoint configuration
      * @returns Promise resolving to the HTTP response (typically 204 No Content on success)
      * @throws {Error} When AGS line item service is not available for the session or deletion fails
+     *
+     * @example
+     * ```typescript
+     * const response = await agsService.deleteLineItem(session);
+     * console.log('Line item deleted successfully');
+     * ```
      */
     deleteLineItem(session: LTISession): Promise<Response>;
     private getAGSToken;

package/dist/services/ags.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ags.service.d.ts","sourceRoot":"","sources":["../../src/services/ags.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACf,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AAGtF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD;;;;;GAKG;AACH,qBAAa,UAAU;IAEnB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;gBAFN,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,UAAU;IAG5B;;;;;;;;;;;;;;;;;;OAkBG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiCjF;;;;;;;;;;;;;OAaG;IACG,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IA4BvD;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsB3D;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsBzD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAuBpB;;;;;;;OAOG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAuBpB;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;YAqB9C,WAAW;YAeX,mBAAmB;CAalC"}
+{"version":3,"file":"ags.service.d.ts","sourceRoot":"","sources":["../../src/services/ags.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACf,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AAGtF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD;;;;;GAKG;AACH,qBAAa,UAAU;IASnB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IAVhB;;;;;;OAMG;gBAEO,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,UAAU;IAG5B;;;;;;;;;;;;;;;;;;OAkBG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiCjF;;;;;;;;;;;;;OAaG;IACG,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IA4BvD;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsB3D;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsBzD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAuBpB;;;;;;;;;;;;;;;;;OAiBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAuBpB;;;;;;;;;;;;OAYG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;YAqB9C,WAAW;YAeX,mBAAmB;CAalC"}

package/dist/services/ags.service.js

@@ -9,6 +9,13 @@ export class AGSService {
     tokenService;
     storage;
     logger;
+    /**
+     * Creates a new AGSService instance.
+     *
+     * @param tokenService - Token service for obtaining OAuth2 bearer tokens
+     * @param storage - Storage adapter for retrieving launch configurations
+     * @param logger - Logger instance for debug and error logging
+     */
     constructor(tokenService, storage, logger) {
         this.tokenService = tokenService;
         this.storage = storage;
@@ -193,6 +200,16 @@ export class AGSService {
      * @param updateLineItem - Updated line item data including all required fields
      * @returns Promise resolving to the HTTP response containing the updated line item
      * @throws {Error} When AGS line item service is not available for the session or update fails
+     *
+     * @example
+     * ```typescript
+     * const response = await agsService.updateLineItem(session, {
+     *   label: 'Quiz 1 (Updated)',
+     *   scoreMaximum: 100,
+     *   tag: 'quiz'
+     * });
+     * const updatedLineItem = await response.json();
+     * ```
      */
     async updateLineItem(session, updateLineItem) {
         if (!session.services?.ags?.lineitem) {
@@ -216,6 +233,12 @@ export class AGSService {
      * @param session - Active LTI session containing AGS line item endpoint configuration
      * @returns Promise resolving to the HTTP response (typically 204 No Content on success)
      * @throws {Error} When AGS line item service is not available for the session or deletion fails
+     *
+     * @example
+     * ```typescript
+     * const response = await agsService.deleteLineItem(session);
+     * console.log('Line item deleted successfully');
+     * ```
      */
     async deleteLineItem(session) {
         if (!session.services?.ags?.lineitem) {

package/dist/services/deepLinking.service.d.ts

@@ -5,14 +5,19 @@ import type { DeepLinkingContentItem } from '../schemas/lti13/deepLinking/conten
  * Deep Linking service for LTI 1.3.
  * Generates signed JWT responses containing selected content items to return to the platform.
  *
- * @param keyPair - RSA key pair for signing client assertion JWTs (must be RS256 compatible)
- * @param keyId - Key identifier for JWT header, should match JWKS key ID (defaults to 'main')
  * @see https://www.imsglobal.org/spec/lti-dl/v2p0
  */
 export declare class DeepLinkingService {
     private keyPair;
     private logger;
     private keyId;
+    /**
+     * Creates a new DeepLinkingService instance.
+     *
+     * @param keyPair - RSA key pair for signing client assertion JWTs (must be RS256 compatible)
+     * @param logger - Logger instance for debug and error logging
+     * @param keyId - Key identifier for JWT header, should match JWKS key ID (defaults to 'main')
+     */
     constructor(keyPair: CryptoKeyPair, logger: BaseLogger, keyId?: string);
     /**
      * Creates a Deep Linking response with selected content items.
@@ -20,7 +25,7 @@ export declare class DeepLinkingService {
      *
      * @param session - Active LTI session containing Deep Linking configuration
      * @param contentItems - Array of content items selected by the user
-     * @returns HTML string containing auto-submit form
+     * @returns Promise resolving to an HTML string containing auto-submit form
      * @throws {Error} When Deep Linking is not available for the session
      *
      * @example
@@ -41,7 +46,7 @@ export declare class DeepLinkingService {
      *
      * @param session - Active LTI session with Deep Linking configuration
      * @param contentItems - Array of selected content items
-     * @returns Signed JWT string
+     * @returns Promise resolving to a signed JWT string
      */
     private createDeepLinkingJWT;
     /**

package/dist/services/deepLinking.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deepLinking.service.d.ts","sourceRoot":"","sources":["../../src/services/deepLinking.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oDAAoD,CAAC;AAEjG;;;;;;;GAOG;AACH,qBAAa,kBAAkB;IAE3B,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,KAAK;gBAFL,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,UAAU,EAClB,KAAK,SAAS;IAGxB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,YAAY,EAAE,sBAAsB,EAAE,GACrC,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;OAMG;YACW,oBAAoB;IA6BlC;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;CAiB/B"}
+{"version":3,"file":"deepLinking.service.d.ts","sourceRoot":"","sources":["../../src/services/deepLinking.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oDAAoD,CAAC;AAEjG;;;;;GAKG;AACH,qBAAa,kBAAkB;IAS3B,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,KAAK;IAVf;;;;;;OAMG;gBAEO,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,UAAU,EAClB,KAAK,SAAS;IAGxB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,YAAY,EAAE,sBAAsB,EAAE,GACrC,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;OAMG;YACW,oBAAoB;IA6BlC;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;CAiB/B"}

package/dist/services/deepLinking.service.js

@@ -3,14 +3,19 @@ import { SignJWT } from 'jose';
  * Deep Linking service for LTI 1.3.
  * Generates signed JWT responses containing selected content items to return to the platform.
  *
- * @param keyPair - RSA key pair for signing client assertion JWTs (must be RS256 compatible)
- * @param keyId - Key identifier for JWT header, should match JWKS key ID (defaults to 'main')
  * @see https://www.imsglobal.org/spec/lti-dl/v2p0
  */
 export class DeepLinkingService {
     keyPair;
     logger;
     keyId;
+    /**
+     * Creates a new DeepLinkingService instance.
+     *
+     * @param keyPair - RSA key pair for signing client assertion JWTs (must be RS256 compatible)
+     * @param logger - Logger instance for debug and error logging
+     * @param keyId - Key identifier for JWT header, should match JWKS key ID (defaults to 'main')
+     */
     constructor(keyPair, logger, keyId = 'main') {
         this.keyPair = keyPair;
         this.logger = logger;
@@ -22,7 +27,7 @@ export class DeepLinkingService {
      *
      * @param session - Active LTI session containing Deep Linking configuration
      * @param contentItems - Array of content items selected by the user
-     * @returns HTML string containing auto-submit form
+     * @returns Promise resolving to an HTML string containing auto-submit form
      * @throws {Error} When Deep Linking is not available for the session
      *
      * @example
@@ -53,7 +58,7 @@ export class DeepLinkingService {
      *
      * @param session - Active LTI session with Deep Linking configuration
      * @param contentItems - Array of selected content items
-     * @returns Signed JWT string
+     * @returns Promise resolving to a signed JWT string
      */
     async createDeepLinkingJWT(session, contentItems) {
         const deepLinking = session.services.deepLinking;

package/dist/services/dynamicRegistration.service.d.ts

@@ -53,6 +53,13 @@ export declare class DynamicRegistrationService {
     private storage;
     private dynamicRegistrationConfig;
     private logger;
+    /**
+     * Creates a new DynamicRegistrationService instance.
+     *
+     * @param storage - Storage adapter for persisting client and deployment configurations
+     * @param dynamicRegistrationConfig - Tool configuration including URLs and service settings
+     * @param logger - Logger instance for debug and error logging
+     */
     constructor(storage: LTIStorage, dynamicRegistrationConfig: DynamicRegistrationConfig, logger: BaseLogger);
     /**
      * Fetches and validates the OpenID Connect configuration from an LTI platform during dynamic registration.

package/dist/services/dynamicRegistration.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamicRegistration.service.d.ts","sourceRoot":"","sources":["../../src/services/dynamicRegistration.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gDAAgD,CAAC;AACpG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uEAAuE,CAAC;AAErH,OAAO,EACL,KAAK,mBAAmB,EAEzB,MAAM,oEAAoE,CAAC;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oEAAoE,CAAC;AAS9G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,qBAAa,0BAA0B;IAEnC,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,yBAAyB;IACjC,OAAO,CAAC,MAAM;gBAFN,OAAO,EAAE,UAAU,EACnB,yBAAyB,EAAE,yBAAyB,EACpD,MAAM,EAAE,UAAU;IAG5B;;;;;;;OAOG;IACG,0BAA0B,CAC9B,mBAAmB,EAAE,mBAAmB,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAkC/B;;;;;;;;OAQG;IACG,2BAA2B,CAC/B,mBAAmB,EAAE,mBAAmB,EACxC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC;IAsClB;;;;;;;OAOG;IACG,2BAA2B,CAC/B,uBAAuB,EAAE,uBAAuB,GAC/C,OAAO,CAAC,MAAM,CAAC;IAoDlB;;;;;;OAMG;IACG,yBAAyB,CAC7B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,6BAA6B,GAAG,SAAS,CAAC;IAQrD;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa;IAoBrB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAoBnB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;YAkClB,mCAAmC;IAgBjD,OAAO,CAAC,0BAA0B;CAiDnC"}
+{"version":3,"file":"dynamicRegistration.service.d.ts","sourceRoot":"","sources":["../../src/services/dynamicRegistration.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gDAAgD,CAAC;AACpG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uEAAuE,CAAC;AAErH,OAAO,EACL,KAAK,mBAAmB,EAEzB,MAAM,oEAAoE,CAAC;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oEAAoE,CAAC;AAS9G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,qBAAa,0BAA0B;IASnC,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,yBAAyB;IACjC,OAAO,CAAC,MAAM;IAVhB;;;;;;OAMG;gBAEO,OAAO,EAAE,UAAU,EACnB,yBAAyB,EAAE,yBAAyB,EACpD,MAAM,EAAE,UAAU;IAG5B;;;;;;;OAOG;IACG,0BAA0B,CAC9B,mBAAmB,EAAE,mBAAmB,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAkC/B;;;;;;;;OAQG;IACG,2BAA2B,CAC/B,mBAAmB,EAAE,mBAAmB,EACxC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC;IAsClB;;;;;;;OAOG;IACG,2BAA2B,CAC/B,uBAAuB,EAAE,uBAAuB,GAC/C,OAAO,CAAC,MAAM,CAAC;IAoDlB;;;;;;OAMG;IACG,yBAAyB,CAC7B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,6BAA6B,GAAG,SAAS,CAAC;IAQrD;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa;IAoBrB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAoBnB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;YAkClB,mCAAmC;IAgBjD,OAAO,CAAC,0BAA0B;CAiDnC"}

package/dist/services/dynamicRegistration.service.js

@@ -48,6 +48,13 @@ export class DynamicRegistrationService {
     storage;
     dynamicRegistrationConfig;
     logger;
+    /**
+     * Creates a new DynamicRegistrationService instance.
+     *
+     * @param storage - Storage adapter for persisting client and deployment configurations
+     * @param dynamicRegistrationConfig - Tool configuration including URLs and service settings
+     * @param logger - Logger instance for debug and error logging
+     */
     constructor(storage, dynamicRegistrationConfig, logger) {
         this.storage = storage;
         this.dynamicRegistrationConfig = dynamicRegistrationConfig;

package/dist/services/nrps.service.d.ts

@@ -12,14 +12,28 @@ export declare class NRPSService {
     private tokenService;
     private storage;
     private logger;
+    /**
+     * Creates a new NRPSService instance.
+     *
+     * @param tokenService - Token service for obtaining OAuth2 bearer tokens
+     * @param storage - Storage adapter for retrieving launch configurations
+     * @param logger - Logger instance for debug and error logging
+     */
     constructor(tokenService: TokenService, storage: LTIStorage, logger: BaseLogger);
     /**
      * Retrieves all members (users) in the current course/context from the platform.
      * Returns raw response that should be parsed by the calling service.
      *
      * @param session - Active LTI session containing NRPS service endpoints
-     * @returns Raw HTTP response containing membership data
+     * @returns Promise resolving to the HTTP response containing membership data
      * @throws {Error} When NRPS is not available for this session or request fails
+     *
+     * @example
+     * ```typescript
+     * const response = await nrpsService.getMembers(session);
+     * const data = await response.json();
+     * console.log('Course members:', data.members);
+     * ```
      */
     getMembers(session: LTISession): Promise<Response>;
     private getNRPSToken;

package/dist/services/nrps.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nrps.service.d.ts","sourceRoot":"","sources":["../../src/services/nrps.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAG9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD;;;;;GAKG;AACH,qBAAa,WAAW;IAEpB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;gBAFN,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,UAAU;IAG5B;;;;;;;OAOG;IACG,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;YAsB1C,YAAY;YAeZ,oBAAoB;CAanC"}
+{"version":3,"file":"nrps.service.d.ts","sourceRoot":"","sources":["../../src/services/nrps.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAG9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD;;;;;GAKG;AACH,qBAAa,WAAW;IASpB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IAVhB;;;;;;OAMG;gBAEO,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,UAAU;IAG5B;;;;;;;;;;;;;;OAcG;IACG,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;YAsB1C,YAAY;YAeZ,oBAAoB;CAanC"}

package/dist/services/nrps.service.js

@@ -9,6 +9,13 @@ export class NRPSService {
     tokenService;
     storage;
     logger;
+    /**
+     * Creates a new NRPSService instance.
+     *
+     * @param tokenService - Token service for obtaining OAuth2 bearer tokens
+     * @param storage - Storage adapter for retrieving launch configurations
+     * @param logger - Logger instance for debug and error logging
+     */
     constructor(tokenService, storage, logger) {
         this.tokenService = tokenService;
         this.storage = storage;
@@ -19,8 +26,15 @@ export class NRPSService {
      * Returns raw response that should be parsed by the calling service.
      *
      * @param session - Active LTI session containing NRPS service endpoints
-     * @returns Raw HTTP response containing membership data
+     * @returns Promise resolving to the HTTP response containing membership data
      * @throws {Error} When NRPS is not available for this session or request fails
+     *
+     * @example
+     * ```typescript
+     * const response = await nrpsService.getMembers(session);
+     * const data = await response.json();
+     * console.log('Course members:', data.members);
+     * ```
      */
     async getMembers(session) {
         if (!session.services?.nrps?.membershipUrl) {

package/dist/services/token.service.d.ts

@@ -4,6 +4,8 @@
  *
  * Implements RFC 7523 (JWT Profile for OAuth 2.0 Client Authentication and Authorization Grants)
  * as required by LTI 1.3 security framework.
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc7523
  */
 export declare class TokenService {
     private keyPair;
@@ -20,7 +22,7 @@ export declare class TokenService {
      *
      * @param clientId - OAuth2 client identifier
      * @param tokenUrl - Platform's token endpoint URL
-     * @returns Signed JWT client assertion
+     * @returns Promise resolving to a signed JWT client assertion string
      */
     createClientAssertion(clientId: string, tokenUrl: string): Promise<string>;
     /**
@@ -29,7 +31,8 @@ export declare class TokenService {
      * @param clientId - OAuth2 client identifier
      * @param tokenUrl - Platform's token endpoint URL
      * @param scope - Requested OAuth2 scope (e.g., AGS score scope)
-     * @returns Bearer access token for API calls
+     * @returns Promise resolving to a bearer access token string for API calls
+     * @throws {Error} When the token request fails or response is missing access_token
      */
     getBearerToken(clientId: string, tokenUrl: string, scope: string): Promise<string>;
 }

package/dist/services/token.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"token.service.d.ts","sourceRoot":"","sources":["../../src/services/token.service.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,qBAAa,YAAY;IAQrB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,KAAK;IARf;;;;;OAKG;gBAEO,OAAO,EAAE,aAAa,EACtB,KAAK,SAAS;IAGxB;;;;;;OAMG;IACG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBhF;;;;;;;OAOG;IACG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;CA6BnB"}
+{"version":3,"file":"token.service.d.ts","sourceRoot":"","sources":["../../src/services/token.service.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,qBAAa,YAAY;IAQrB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,KAAK;IARf;;;;;OAKG;gBAEO,OAAO,EAAE,aAAa,EACtB,KAAK,SAAS;IAGxB;;;;;;OAMG;IACG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBhF;;;;;;;;OAQG;IACG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;CA6BnB"}

package/dist/services/token.service.js

@@ -5,6 +5,8 @@ import { SignJWT } from 'jose';
  *
  * Implements RFC 7523 (JWT Profile for OAuth 2.0 Client Authentication and Authorization Grants)
  * as required by LTI 1.3 security framework.
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc7523
  */
 export class TokenService {
     keyPair;
@@ -24,7 +26,7 @@ export class TokenService {
      *
      * @param clientId - OAuth2 client identifier
      * @param tokenUrl - Platform's token endpoint URL
-     * @returns Signed JWT client assertion
+     * @returns Promise resolving to a signed JWT client assertion string
      */
     async createClientAssertion(clientId, tokenUrl) {
         return await new SignJWT({
@@ -48,7 +50,8 @@ export class TokenService {
      * @param clientId - OAuth2 client identifier
      * @param tokenUrl - Platform's token endpoint URL
      * @param scope - Requested OAuth2 scope (e.g., AGS score scope)
-     * @returns Bearer access token for API calls
+     * @returns Promise resolving to a bearer access token string for API calls
+     * @throws {Error} When the token request fails or response is missing access_token
      */
     async getBearerToken(clientId, tokenUrl, scope) {
         const assertion = await this.createClientAssertion(clientId, tokenUrl);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lti-tool/core",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "description": "LTI 1.3 implementation for Node.js",
   "keywords": [
     "lti",

package/src/ltiTool.ts

@@ -579,7 +579,7 @@ export class LTITool {
     dynamicRegistrationForm: DynamicRegistrationForm,
   ): Promise<string> {
     if (!this.dynamicRegistrationService) {
-      throw new Error('Dynmaic registration service is not configured');
+      throw new Error('Dynamic registration service is not configured');
     }
 
     return await this.dynamicRegistrationService.completeDynamicRegistration(

package/src/services/ags.service.ts

@@ -18,6 +18,13 @@ import type { TokenService } from './token.service.js';
  * @see https://www.imsglobal.org/spec/lti-ags/v2p0
  */
 export class AGSService {
+  /**
+   * Creates a new AGSService instance.
+   *
+   * @param tokenService - Token service for obtaining OAuth2 bearer tokens
+   * @param storage - Storage adapter for retrieving launch configurations
+   * @param logger - Logger instance for debug and error logging
+   */
   constructor(
     private tokenService: TokenService,
     private storage: LTIStorage,
@@ -243,6 +250,16 @@ export class AGSService {
    * @param updateLineItem - Updated line item data including all required fields
    * @returns Promise resolving to the HTTP response containing the updated line item
    * @throws {Error} When AGS line item service is not available for the session or update fails
+   *
+   * @example
+   * ```typescript
+   * const response = await agsService.updateLineItem(session, {
+   *   label: 'Quiz 1 (Updated)',
+   *   scoreMaximum: 100,
+   *   tag: 'quiz'
+   * });
+   * const updatedLineItem = await response.json();
+   * ```
    */
   async updateLineItem(
     session: LTISession,
@@ -276,6 +293,12 @@ export class AGSService {
    * @param session - Active LTI session containing AGS line item endpoint configuration
    * @returns Promise resolving to the HTTP response (typically 204 No Content on success)
    * @throws {Error} When AGS line item service is not available for the session or deletion fails
+   *
+   * @example
+   * ```typescript
+   * const response = await agsService.deleteLineItem(session);
+   * console.log('Line item deleted successfully');
+   * ```
    */
   async deleteLineItem(session: LTISession): Promise<Response> {
     if (!session.services?.ags?.lineitem) {

package/src/services/deepLinking.service.ts

@@ -8,11 +8,16 @@ import type { DeepLinkingContentItem } from '../schemas/lti13/deepLinking/conten
  * Deep Linking service for LTI 1.3.
  * Generates signed JWT responses containing selected content items to return to the platform.
  *
- * @param keyPair - RSA key pair for signing client assertion JWTs (must be RS256 compatible)
- * @param keyId - Key identifier for JWT header, should match JWKS key ID (defaults to 'main')
  * @see https://www.imsglobal.org/spec/lti-dl/v2p0
  */
 export class DeepLinkingService {
+  /**
+   * Creates a new DeepLinkingService instance.
+   *
+   * @param keyPair - RSA key pair for signing client assertion JWTs (must be RS256 compatible)
+   * @param logger - Logger instance for debug and error logging
+   * @param keyId - Key identifier for JWT header, should match JWKS key ID (defaults to 'main')
+   */
   constructor(
     private keyPair: CryptoKeyPair,
     private logger: BaseLogger,
@@ -25,7 +30,7 @@ export class DeepLinkingService {
    *
    * @param session - Active LTI session containing Deep Linking configuration
    * @param contentItems - Array of content items selected by the user
-   * @returns HTML string containing auto-submit form
+   * @returns Promise resolving to an HTML string containing auto-submit form
    * @throws {Error} When Deep Linking is not available for the session
    *
    * @example
@@ -65,7 +70,7 @@ export class DeepLinkingService {
    *
    * @param session - Active LTI session with Deep Linking configuration
    * @param contentItems - Array of selected content items
-   * @returns Signed JWT string
+   * @returns Promise resolving to a signed JWT string
    */
   private async createDeepLinkingJWT(
     session: LTISession,

package/src/services/dynamicRegistration.service.ts

@@ -63,6 +63,13 @@ import {
  * @see https://www.imsglobal.org/spec/lti-dr/v1p0 LTI 1.3 Dynamic Registration specification
  */
 export class DynamicRegistrationService {
+  /**
+   * Creates a new DynamicRegistrationService instance.
+   *
+   * @param storage - Storage adapter for persisting client and deployment configurations
+   * @param dynamicRegistrationConfig - Tool configuration including URLs and service settings
+   * @param logger - Logger instance for debug and error logging
+   */
   constructor(
     private storage: LTIStorage,
     private dynamicRegistrationConfig: DynamicRegistrationConfig,

package/src/services/nrps.service.ts

@@ -13,6 +13,13 @@ import type { TokenService } from './token.service.js';
  * @see https://www.imsglobal.org/spec/lti-nrps/v2p0
  */
 export class NRPSService {
+  /**
+   * Creates a new NRPSService instance.
+   *
+   * @param tokenService - Token service for obtaining OAuth2 bearer tokens
+   * @param storage - Storage adapter for retrieving launch configurations
+   * @param logger - Logger instance for debug and error logging
+   */
   constructor(
     private tokenService: TokenService,
     private storage: LTIStorage,
@@ -24,8 +31,15 @@ export class NRPSService {
    * Returns raw response that should be parsed by the calling service.
    *
    * @param session - Active LTI session containing NRPS service endpoints
-   * @returns Raw HTTP response containing membership data
+   * @returns Promise resolving to the HTTP response containing membership data
    * @throws {Error} When NRPS is not available for this session or request fails
+   *
+   * @example
+   * ```typescript
+   * const response = await nrpsService.getMembers(session);
+   * const data = await response.json();
+   * console.log('Course members:', data.members);
+   * ```
    */
   async getMembers(session: LTISession): Promise<Response> {
     if (!session.services?.nrps?.membershipUrl) {

package/src/services/token.service.ts

@@ -6,6 +6,8 @@ import { SignJWT } from 'jose';
  *
  * Implements RFC 7523 (JWT Profile for OAuth 2.0 Client Authentication and Authorization Grants)
  * as required by LTI 1.3 security framework.
+ *
+ * @see https://www.rfc-editor.org/rfc/rfc7523
  */
 export class TokenService {
   /**
@@ -24,7 +26,7 @@ export class TokenService {
    *
    * @param clientId - OAuth2 client identifier
    * @param tokenUrl - Platform's token endpoint URL
-   * @returns Signed JWT client assertion
+   * @returns Promise resolving to a signed JWT client assertion string
    */
   async createClientAssertion(clientId: string, tokenUrl: string): Promise<string> {
     return await new SignJWT({
@@ -49,7 +51,8 @@ export class TokenService {
    * @param clientId - OAuth2 client identifier
    * @param tokenUrl - Platform's token endpoint URL
    * @param scope - Requested OAuth2 scope (e.g., AGS score scope)
-   * @returns Bearer access token for API calls
+   * @returns Promise resolving to a bearer access token string for API calls
+   * @throws {Error} When the token request fails or response is missing access_token
    */
   async getBearerToken(
     clientId: string,