@lti-tool/core 0.12.2 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @lti-tool/core
 
+## 0.13.1
+
+### Patch Changes
+
+- 7bb4c98: Improve JSDoc for service layers
+
+## 0.13.0
+
+### Minor Changes
+
+- d5a2793: Pass through keyId to utilize in kid when signing the Deep Linking JWT
+
 ## 0.12.2
 
 ### Patch Changes

package/dist/ltiTool.d.ts

@@ -8,6 +8,7 @@ import { type DynamicRegistrationForm, type LTI13JwtPayload, type RegistrationRe
 import { type CreateLineItem, type LineItem, type LineItems, type UpdateLineItem } from './schemas/lti13/ags/lineItem.schema.js';
 import { type Results } from './schemas/lti13/ags/result.schema.js';
 import { type ScoreSubmission } from './schemas/lti13/ags/scoreSubmission.schema.js';
+import { type DeepLinkingContentItem } from './schemas/lti13/deepLinking/contentItem.schema.js';
 import { type OpenIDConfiguration } from './schemas/lti13/dynamicRegistration/openIDConfiguration.schema.js';
 import { type Member } from './schemas/lti13/nrps/contextMembership.schema.js';
 /**
@@ -41,6 +42,7 @@ export declare class LTITool {
     private tokenService;
     private agsService;
     private nrpsService;
+    private deepLinkingService;
     private dynamicRegistrationService?;
     /**
      * Creates a new LTI Tool instance.
@@ -197,6 +199,28 @@ export declare class LTITool {
      * ```
      */
     getMembers(session: LTISession): Promise<Member[]>;
+    /**
+     * Creates a Deep Linking response with selected content items.
+     * Generates a signed JWT and returns HTML form that auto-submits to the platform.
+     *
+     * @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
+     * @throws {Error} When Deep Linking is not available for the session
+     *
+     * @example
+     * ```typescript
+     * const html = await ltiTool.createDeepLinkingResponse(session, [
+     *   {
+     *     type: 'ltiResourceLink',
+     *     title: 'Quiz 1',
+     *     url: 'https://tool.example.com/quiz/1'
+     *   }
+     * ]);
+     * // Render the HTML to return content items to platform
+     * ```
+     */
+    createDeepLinkingResponse(session: LTISession, contentItems: DeepLinkingContentItem[]): Promise<string>;
     /**
      * Fetches and validates the OpenID Connect configuration from an LTI platform during dynamic registration.
      * Validates that the OIDC endpoint and issuer have matching hostnames for security.

package/dist/ltiTool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ltiTool.d.ts","sourceRoot":"","sources":["../src/ltiTool.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,+CAA+C,CAAC;AACnG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EACL,KAAK,uBAAuB,EAE5B,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EAGzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,SAAS,EAGd,KAAK,cAAc,EACpB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,+CAA+C,CAAC;AACrF,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,mEAAmE,CAAC;AAC7G,OAAO,EACL,KAAK,MAAM,EAEZ,MAAM,kDAAkD,CAAC;AAQ1D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,OAAO;IAcN,OAAO,CAAC,MAAM;IAb1B,4DAA4D;IAC5D,OAAO,CAAC,SAAS,CAA4D;IAC7E,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,0BAA0B,CAAC,CAA6B;IAEhE;;;;OAIG;gBACiB,MAAM,EAAE,SAAS;IA6BrC;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,MAAM,EAAE;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,GAAG,GAAG,MAAM,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,eAAe,EAAE,MAAM,CAAC;QACxB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,OAAO,CAAC,MAAM,CAAC;IAgDnB;;;;;;;;;;;;;;OAcG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAuD5E;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAc9B;;;;;OAKG;IACG,aAAa,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;IAM1E;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAKpE;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAW7E;;;;;;;;;;;;OAYG;IACG,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAUtD;;;;;;OAMG;IACG,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAU5D;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAUzD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAapB;;;;;;;OAOG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAapB;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxD;;;;;;;;;;;;;;OAcG;IACG,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwBxD;;;;;;;;;;;;;;;;OAgBG;IACG,0BAA0B,CAC9B,mBAAmB,EAAE,mBAAmB,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAS/B;;;;;;;;OAQG;IACG,2BAA2B,CAC/B,mBAAmB,EAAE,mBAAmB,EACxC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC;IAUlB;;;;;;;OAOG;IACG,2BAA2B,CAC/B,uBAAuB,EAAE,uBAAuB,GAC/C,OAAO,CAAC,MAAM,CAAC;IAYlB;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC;IAI9D;;;;;OAKG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,aAAa,CAAC,CAAC,GACrD,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;OAKG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAIrE;;;;;OAKG;IACG,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,aAAa,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAK/E;;;;OAIG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMnD;;;;;OAKG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAIjE;;;;;;OAMG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAIrC;;;;;;OAMG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,GACpC,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;;OAMG;IACG,gBAAgB,CACpB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,GACjC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;OAKG;IACG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7E;;;;;;OAMG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;OAMG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,6BAA6B,GAAG,SAAS,CAAC;IAIrD;;;;;OAKG;IACG,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGlE"}
+{"version":3,"file":"ltiTool.d.ts","sourceRoot":"","sources":["../src/ltiTool.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,+CAA+C,CAAC;AACnG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EACL,KAAK,uBAAuB,EAE5B,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EAGzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,SAAS,EAGd,KAAK,cAAc,EACpB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,+CAA+C,CAAC;AACrF,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,mEAAmE,CAAC;AAC7G,OAAO,EACL,KAAK,MAAM,EAEZ,MAAM,kDAAkD,CAAC;AAS1D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,OAAO;IAeN,OAAO,CAAC,MAAM;IAd1B,4DAA4D;IAC5D,OAAO,CAAC,SAAS,CAA4D;IAC7E,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,0BAA0B,CAAC,CAA6B;IAEhE;;;;OAIG;gBACiB,MAAM,EAAE,SAAS;IAkCrC;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,MAAM,EAAE;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,GAAG,GAAG,MAAM,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,eAAe,EAAE,MAAM,CAAC;QACxB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,OAAO,CAAC,MAAM,CAAC;IAgDnB;;;;;;;;;;;;;;OAcG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAuD5E;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAc9B;;;;;OAKG;IACG,aAAa,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;IAM1E;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAKpE;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAW7E;;;;;;;;;;;;OAYG;IACG,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAUtD;;;;;;OAMG;IACG,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAU5D;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAUzD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAapB;;;;;;;OAOG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,EACnB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAapB;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxD;;;;;;;;;;;;;;OAcG;IACG,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwBxD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,EACnB,YAAY,EAAE,sBAAsB,EAAE,GACrC,OAAO,CAAC,MAAM,CAAC;IAWlB;;;;;;;;;;;;;;;;OAgBG;IACG,0BAA0B,CAC9B,mBAAmB,EAAE,mBAAmB,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAS/B;;;;;;;;OAQG;IACG,2BAA2B,CAC/B,mBAAmB,EAAE,mBAAmB,EACxC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC;IAUlB;;;;;;;OAOG;IACG,2BAA2B,CAC/B,uBAAuB,EAAE,uBAAuB,GAC/C,OAAO,CAAC,MAAM,CAAC;IAYlB;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC;IAI9D;;;;;OAKG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,aAAa,CAAC,CAAC,GACrD,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;OAKG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAIrE;;;;;OAKG;IACG,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,aAAa,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAK/E;;;;OAIG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMnD;;;;;OAKG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAIjE;;;;;;OAMG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAIrC;;;;;;OAMG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,GACpC,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;;OAMG;IACG,gBAAgB,CACpB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,GACjC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;OAKG;IACG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7E;;;;;;OAMG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;OAMG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,6BAA6B,GAAG,SAAS,CAAC;IAIrD;;;;;OAKG;IACG,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGlE"}

package/dist/ltiTool.js

@@ -5,6 +5,7 @@ import { LineItemSchema, LineItemsSchema, } from './schemas/lti13/ags/lineItem.s
 import { ResultsSchema } from './schemas/lti13/ags/result.schema.js';
 import { NRPSContextMembershipResponseSchema, } from './schemas/lti13/nrps/contextMembership.schema.js';
 import { AGSService } from './services/ags.service.js';
+import { DeepLinkingService } from './services/deepLinking.service.js';
 import { DynamicRegistrationService } from './services/dynamicRegistration.service.js';
 import { NRPSService } from './services/nrps.service.js';
 import { createSession } from './services/session.service.js';
@@ -41,6 +42,7 @@ export class LTITool {
     tokenService;
     agsService;
     nrpsService;
+    deepLinkingService;
     dynamicRegistrationService;
     /**
      * Creates a new LTI Tool instance.
@@ -60,6 +62,7 @@ export class LTITool {
         this.tokenService = new TokenService(this.config.keyPair, this.config.security?.keyId ?? 'main');
         this.agsService = new AGSService(this.tokenService, this.config.storage, this.logger);
         this.nrpsService = new NRPSService(this.tokenService, this.config.storage, this.logger);
+        this.deepLinkingService = new DeepLinkingService(this.config.keyPair, this.logger, this.config.security?.keyId ?? 'main');
         if (this.config.dynamicRegistration) {
             this.dynamicRegistrationService = new DynamicRegistrationService(this.config.storage, this.config.dynamicRegistration, this.logger);
         }
@@ -365,6 +368,36 @@ export class LTITool {
             roles: member.roles,
         }));
     }
+    /**
+     * Creates a Deep Linking response with selected content items.
+     * Generates a signed JWT and returns HTML form that auto-submits to the platform.
+     *
+     * @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
+     * @throws {Error} When Deep Linking is not available for the session
+     *
+     * @example
+     * ```typescript
+     * const html = await ltiTool.createDeepLinkingResponse(session, [
+     *   {
+     *     type: 'ltiResourceLink',
+     *     title: 'Quiz 1',
+     *     url: 'https://tool.example.com/quiz/1'
+     *   }
+     * ]);
+     * // Render the HTML to return content items to platform
+     * ```
+     */
+    async createDeepLinkingResponse(session, contentItems) {
+        if (!session) {
+            throw new Error('session is required');
+        }
+        if (!contentItems) {
+            throw new Error('contentItems is required');
+        }
+        return await this.deepLinkingService.createResponse(session, contentItems);
+    }
     /**
      * Fetches and validates the OpenID Connect configuration from an LTI platform during dynamic registration.
      * Validates that the OIDC endpoint and issuer have matching hostnames for security.
@@ -413,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/schemas/index.d.ts

@@ -1,4 +1,5 @@
 export { SessionIdSchema } from './common.schema.js';
+export { ContentItemSchema, type DeepLinkingContentItem, type DeepLinkingFile, type DeepLinkingHtml, type DeepLinkingImage, type DeepLinkingLink, type DeepLinkingLtiResourceLink, } from './lti13/deepLinking/contentItem.schema.js';
 export { DynamicRegistrationFormSchema, type DynamicRegistrationForm, } from './lti13/dynamicRegistration/ltiDynamicRegistration.schema.js';
 export { LTIMessagesArraySchema, type LTIMessage, } from './lti13/dynamicRegistration/ltiMessages.schema.js';
 export { type OpenIDConfiguration } from './lti13/dynamicRegistration/openIDConfiguration.schema.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EACL,6BAA6B,EAC7B,KAAK,uBAAuB,GAC7B,MAAM,8DAA8D,CAAC;AACtE,OAAO,EACL,sBAAsB,EACtB,KAAK,UAAU,GAChB,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,2DAA2D,CAAC;AACrG,OAAO,EACL,yBAAyB,EACzB,KAAK,mBAAmB,GACzB,MAAM,2DAA2D,CAAC;AACnE,OAAO,EACL,0BAA0B,EAC1B,KAAK,oBAAoB,GAC1B,MAAM,4DAA4D,CAAC;AACpE,OAAO,EACL,qBAAqB,EACrB,KAAK,eAAe,GACrB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EACL,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,0BAA0B,GAChC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EACL,6BAA6B,EAC7B,KAAK,uBAAuB,GAC7B,MAAM,8DAA8D,CAAC;AACtE,OAAO,EACL,sBAAsB,EACtB,KAAK,UAAU,GAChB,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,2DAA2D,CAAC;AACrG,OAAO,EACL,yBAAyB,EACzB,KAAK,mBAAmB,GACzB,MAAM,2DAA2D,CAAC;AACnE,OAAO,EACL,0BAA0B,EAC1B,KAAK,oBAAoB,GAC1B,MAAM,4DAA4D,CAAC;AACpE,OAAO,EACL,qBAAqB,EACrB,KAAK,eAAe,GACrB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/schemas/index.js

@@ -1,4 +1,5 @@
 export { SessionIdSchema } from './common.schema.js';
+export { ContentItemSchema, } from './lti13/deepLinking/contentItem.schema.js';
 export { DynamicRegistrationFormSchema, } from './lti13/dynamicRegistration/ltiDynamicRegistration.schema.js';
 export { LTIMessagesArraySchema, } from './lti13/dynamicRegistration/ltiMessages.schema.js';
 export { RegistrationRequestSchema, } from './lti13/dynamicRegistration/registrationRequest.schema.js';

package/dist/schemas/lti13/ags/lineItem.schema.d.ts

@@ -22,13 +22,13 @@ export declare const LineItemSchema: z.ZodObject<{
  * @see https://www.imsglobal.org/spec/lti-ags/v2p0/#line-item-service
  */
 export declare const CreateLineItemSchema: z.ZodObject<{
-    label: z.ZodString;
     scoreMaximum: z.ZodNumber;
+    label: z.ZodString;
     resourceId: z.ZodOptional<z.ZodString>;
-    resourceLinkId: z.ZodOptional<z.ZodString>;
     tag: z.ZodOptional<z.ZodString>;
     startDateTime: z.ZodOptional<z.ZodISODateTime>;
     endDateTime: z.ZodOptional<z.ZodISODateTime>;
+    resourceLinkId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
  * Schema for updating an existing LTI Assignment and Grade Services (AGS) Line Item.
@@ -38,8 +38,8 @@ export declare const CreateLineItemSchema: z.ZodObject<{
  * @see https://www.imsglobal.org/spec/lti-ags/v2p0/#line-item-service
  */
 export declare const UpdateLineItemSchema: z.ZodObject<{
-    label: z.ZodString;
     scoreMaximum: z.ZodNumber;
+    label: z.ZodString;
     resourceId: z.ZodOptional<z.ZodString>;
     tag: z.ZodOptional<z.ZodString>;
     startDateTime: z.ZodOptional<z.ZodISODateTime>;

package/dist/schemas/lti13/deepLinking/contentItem.schema.d.ts

@@ -0,0 +1,313 @@
+import * as z from 'zod';
+/**
+ * Zod schema for LTI Resource Link content item.
+ * Represents a launchable LTI tool resource that can be embedded in the platform.
+ *
+ * @property type - Always 'ltiResourceLink' for this content type
+ * @property url - Optional launch URL for the resource
+ * @property custom - Optional custom parameters passed to the tool on launch
+ * @property lineItem - Optional gradebook column configuration for this resource
+ * @property available - Optional availability window with start/end dates
+ * @property submission - Optional submission window with start/end dates
+ *
+ * @see https://www.imsglobal.org/spec/lti-dl/v2p0#lti-resource-link
+ */
+export declare const LtiResourceLinkSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"ltiResourceLink">;
+    url: z.ZodOptional<z.ZodURL>;
+    custom: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    lineItem: z.ZodOptional<z.ZodObject<{
+        scoreMaximum: z.ZodNumber;
+        label: z.ZodString;
+        resourceId: z.ZodOptional<z.ZodString>;
+        tag: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    available: z.ZodOptional<z.ZodObject<{
+        startDateTime: z.ZodOptional<z.ZodISODateTime>;
+        endDateTime: z.ZodOptional<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+    submission: z.ZodOptional<z.ZodObject<{
+        startDateTime: z.ZodOptional<z.ZodISODateTime>;
+        endDateTime: z.ZodOptional<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Zod schema for simple link content item.
+ * Represents a standard web link that can be opened in various ways.
+ *
+ * @property type - Always 'link' for this content type
+ * @property url - Target URL for the link
+ * @property embed - Optional HTML embed code
+ * @property window - Optional window configuration for opening the link
+ * @property iframe - Optional iframe configuration for embedding the link
+ *
+ * @see https://www.imsglobal.org/spec/lti-dl/v2p0#link
+ */
+export declare const LinkSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"link">;
+    url: z.ZodURL;
+    embed: z.ZodOptional<z.ZodObject<{
+        html: z.ZodString;
+    }, z.core.$strip>>;
+    window: z.ZodOptional<z.ZodObject<{
+        targetName: z.ZodOptional<z.ZodString>;
+        windowFeatures: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    iframe: z.ZodOptional<z.ZodObject<{
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        src: z.ZodURL;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Zod schema for HTML fragment content item.
+ * Represents raw HTML content to be embedded directly in the platform.
+ *
+ * @property type - Always 'html' for this content type
+ * @property html - HTML content to be embedded
+ *
+ * @see https://www.imsglobal.org/spec/lti-dl/v2p0#html-fragment
+ */
+export declare const HtmlSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Zod schema for file content item.
+ * Represents a downloadable file resource.
+ *
+ * @property type - Always 'file' for this content type
+ * @property url - URL to download the file
+ * @property mediaType - MIME type of the file
+ * @property expiresAt - Optional expiration timestamp for the file URL
+ *
+ * @see https://www.imsglobal.org/spec/lti-dl/v2p0#file
+ */
+export declare const FileSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"file">;
+    url: z.ZodURL;
+    mediaType: z.ZodString;
+    expiresAt: z.ZodOptional<z.ZodISODateTime>;
+}, z.core.$strip>;
+/**
+ * Zod schema for image content item.
+ * Represents an image resource with optional dimensions.
+ *
+ * @property type - Always 'image' for this content type
+ * @property url - URL to the image
+ * @property width - Optional image width in pixels
+ * @property height - Optional image height in pixels
+ *
+ * @see https://www.imsglobal.org/spec/lti-dl/v2p0#image
+ */
+export declare const ImageSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"image">;
+    url: z.ZodURL;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Zod schema for validating any Deep Linking content item type.
+ * Uses discriminated union on the 'type' field to determine the specific content item schema.
+ * Supports: ltiResourceLink, link, html, file, and image content types.
+ *
+ * @see https://www.imsglobal.org/spec/lti-dl/v2p0#content-item-types
+ */
+export declare const ContentItemSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"ltiResourceLink">;
+    url: z.ZodOptional<z.ZodURL>;
+    custom: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    lineItem: z.ZodOptional<z.ZodObject<{
+        scoreMaximum: z.ZodNumber;
+        label: z.ZodString;
+        resourceId: z.ZodOptional<z.ZodString>;
+        tag: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    available: z.ZodOptional<z.ZodObject<{
+        startDateTime: z.ZodOptional<z.ZodISODateTime>;
+        endDateTime: z.ZodOptional<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+    submission: z.ZodOptional<z.ZodObject<{
+        startDateTime: z.ZodOptional<z.ZodISODateTime>;
+        endDateTime: z.ZodOptional<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"link">;
+    url: z.ZodURL;
+    embed: z.ZodOptional<z.ZodObject<{
+        html: z.ZodString;
+    }, z.core.$strip>>;
+    window: z.ZodOptional<z.ZodObject<{
+        targetName: z.ZodOptional<z.ZodString>;
+        windowFeatures: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    iframe: z.ZodOptional<z.ZodObject<{
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        src: z.ZodURL;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"html">;
+    html: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"file">;
+    url: z.ZodURL;
+    mediaType: z.ZodString;
+    expiresAt: z.ZodOptional<z.ZodISODateTime>;
+}, z.core.$strip>, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    type: z.ZodLiteral<"image">;
+    url: z.ZodURL;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>], "type">;
+/**
+ * Type representing a validated LTI Resource Link content item.
+ * Used for creating launchable LTI tool resources.
+ */
+export type DeepLinkingLtiResourceLink = z.infer<typeof LtiResourceLinkSchema>;
+/**
+ * Type representing a validated simple link content item.
+ * Used for creating standard web links.
+ */
+export type DeepLinkingLink = z.infer<typeof LinkSchema>;
+/**
+ * Type representing a validated HTML fragment content item.
+ * Used for embedding raw HTML content.
+ */
+export type DeepLinkingHtml = z.infer<typeof HtmlSchema>;
+/**
+ * Type representing a validated file content item.
+ * Used for linking to downloadable files.
+ */
+export type DeepLinkingFile = z.infer<typeof FileSchema>;
+/**
+ * Type representing a validated image content item.
+ * Used for embedding images.
+ */
+export type DeepLinkingImage = z.infer<typeof ImageSchema>;
+/**
+ * Type representing any validated Deep Linking content item.
+ * Can be any of: DeepLinkingLtiResourceLink, DeepLinkingLink, DeepLinkingHtml, DeepLinkingFile, or DeepLinkingImage.
+ */
+export type DeepLinkingContentItem = z.infer<typeof ContentItemSchema>;
+//# sourceMappingURL=contentItem.schema.d.ts.map

package/dist/schemas/lti13/deepLinking/contentItem.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentItem.schema.d.ts","sourceRoot":"","sources":["../../../../src/schemas/lti13/deepLinking/contentItem.schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAgCzB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwBhC,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqBrB,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;iBAGrB,CAAC;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;iBAKrB,CAAC;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;iBAKtB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAM5B,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}