@lti-tool/core 0.13.1 → 0.14.0

package/src/schemas/lti13/dynamicRegistration/ltiMessages.schema.ts

@@ -28,7 +28,15 @@ const LTIDeepLinkingMessageSchema = z.object({
   target_link_uri: z.url().optional(),
   label: z.string().optional(),
   placements: z
-    .array(z.enum(['ContentArea', 'RichTextEditor', 'CourseNavigation']))
+    .array(
+      z.enum([
+        'editor_button',
+        'assignment_selection',
+        'link_selection',
+        'module_index_menu_modal',
+        'module_menu_modal',
+      ]),
+    )
     .optional(),
   supported_types: z
     .array(z.enum(['ltiResourceLink', 'file', 'html', 'link', 'image']))

package/src/services/dynamicRegistration.service.ts

@@ -189,9 +189,16 @@ export class DynamicRegistrationService {
       throw new Error('Invalid or expired session');
     }
 
+    // Extract platform family from session
+    const platformFamily =
+      session.openIdConfiguration[
+        'https://purl.imsglobal.org/spec/lti-platform-configuration'
+      ].product_family_code;
+
     // 1. build payload
     const toolRegistrationPayload = this.buildRegistrationPayload(
       dynamicRegistrationForm.services ?? [],
+      platformFamily,
     );
 
     // 2. Post request to Moodle
@@ -249,29 +256,88 @@ export class DynamicRegistrationService {
     return session;
   }
 
+  /**
+   * Builds Canvas-specific deep linking messages for the 5 common placements.
+   * Creates separate messages for editor, module menu, assignments, modules page, and link selection.
+   *
+   * @param deepLinkingUri - URI where deep linking requests should be sent
+   * @param toolName - Display name of the tool
+   * @returns Array of Canvas deep linking message configurations
+   */
+  private buildCanvasDeepLinkingMessages(
+    deepLinkingUri: string,
+    toolName: string,
+  ): LTIMessage[] {
+    return [
+      {
+        type: 'LtiDeepLinkingRequest' as const,
+        target_link_uri: deepLinkingUri,
+        label: toolName,
+        placements: ['editor_button' as const],
+        supported_types: ['ltiResourceLink' as const],
+      },
+      {
+        type: 'LtiDeepLinkingRequest' as const,
+        target_link_uri: deepLinkingUri,
+        label: toolName,
+        placements: ['module_menu_modal' as const],
+        supported_types: ['ltiResourceLink' as const],
+      },
+      {
+        type: 'LtiDeepLinkingRequest' as const,
+        target_link_uri: deepLinkingUri,
+        label: toolName,
+        placements: ['assignment_selection' as const],
+        supported_types: ['ltiResourceLink' as const],
+      },
+      {
+        type: 'LtiDeepLinkingRequest' as const,
+        target_link_uri: deepLinkingUri,
+        label: toolName,
+        placements: ['module_index_menu_modal' as const],
+        supported_types: ['ltiResourceLink' as const],
+      },
+      {
+        type: 'LtiDeepLinkingRequest' as const,
+        target_link_uri: deepLinkingUri,
+        label: toolName,
+        placements: ['link_selection' as const],
+        supported_types: ['ltiResourceLink' as const],
+      },
+    ];
+  }
+
   /**
    * Builds array of LTI message types based on selected services during registration.
    * Always includes ResourceLinkRequest, conditionally adds DeepLinkingRequest.
    *
    * @param selectedServices - Array of service names selected by administrator
    * @param deepLinkingUri - URI where deep linking requests should be sent
+   * @param platformFamily - Platform family code (e.g., 'canvas', 'moodle')
+   * @param toolName - Display name of the tool
    * @returns Array of LTI message configurations for the registration payload
    */
   private buildMessages(
     selectedServices: string[],
     deepLinkingUri: string,
+    platformFamily: string,
+    toolName: string,
   ): LTIMessage[] {
-    const messages = [];
+    const messages: LTIMessage[] = [];
     messages.push({ type: 'LtiResourceLinkRequest' as const });
 
     if (selectedServices?.includes('deep_linking')) {
-      messages.push({
-        type: 'LtiDeepLinkingRequest' as const,
-        target_link_uri: deepLinkingUri,
-        label: 'Content Selection',
-        placements: ['ContentArea' as const], // Focus on content area only
-        supported_types: ['ltiResourceLink' as const], // Standard content selection
-      });
+      if (platformFamily.toLowerCase() === 'canvas') {
+        messages.push(...this.buildCanvasDeepLinkingMessages(deepLinkingUri, toolName));
+      } else {
+        messages.push({
+          type: 'LtiDeepLinkingRequest' as const,
+          target_link_uri: deepLinkingUri,
+          label: toolName,
+          placements: ['editor_button' as const],
+          supported_types: ['ltiResourceLink' as const],
+        });
+      }
     }
 
     return messages;
@@ -309,9 +375,13 @@ export class DynamicRegistrationService {
    * Combines tool configuration, selected services, and OAuth parameters into LTI 1.3 registration format.
    *
    * @param selectedServices - Array of service names selected by administrator
+   * @param platformFamily - Platform family code (e.g., 'canvas', 'moodle')
    * @returns Complete registration payload ready for platform submission
    */
-  private buildRegistrationPayload(selectedServices: string[]): ToolRegistrationPayload {
+  private buildRegistrationPayload(
+    selectedServices: string[],
+    platformFamily: string,
+  ): ToolRegistrationPayload {
     const config = this.dynamicRegistrationConfig;
 
     const deepLinkingUri = config.deepLinkingUri || `${config.url}/lti/deep-linking`;
@@ -319,7 +389,12 @@ export class DynamicRegistrationService {
     const launchUri = config.launchUri || `${config.url}/lti/launch`;
     const loginUri = config.loginUri || `${config.url}/lti/login`;
 
-    const messages = this.buildMessages(selectedServices, deepLinkingUri);
+    const messages = this.buildMessages(
+      selectedServices,
+      deepLinkingUri,
+      platformFamily,
+      config.name,
+    );
     const scopes = this.buildScopes(selectedServices);
 
     const toolRegistrationPayload: ToolRegistrationPayload = {

package/src/services/dynamicRegistrationHandlers/moodle.ts

@@ -173,7 +173,7 @@ export async function postRegistrationToMoodle(
   if (!response.ok) {
     const errorText = await response.json();
     logger.error({ errorText }, 'lti dynamic registration error');
-    throw new Error(errorText);
+    throw new Error(JSON.stringify(errorText));
   }
 
   const data = await response.json();

package/src/utils/errorFormatting.ts

@@ -0,0 +1,22 @@
+/**
+ * Formats an unknown error into a readable string message.
+ * Handles Error objects, strings, and other types safely.
+ *
+ * @param error - The error to format (can be Error, string, or any other type)
+ * @returns Formatted error message string
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await riskyOperation();
+ * } catch (error) {
+ *   throw new Error(`Operation failed: ${formatError(error)}`);
+ * }
+ * ```
+ */
+export function formatError(error: unknown): string {
+  if (error instanceof Error) {
+    return error.message;
+  }
+  return String(error);
+}