caccl/src/server/shared/types/CACCLStatus.ts

Canvas App Complete Connection Library: an all-in-one library for connecting your app to Canvas, handling lti, access tokens, and api.

import LaunchInfo from 'caccl-lti/lib/shared/types/LaunchInfo';

/**
 * Status object passed back from CACCL status endpoint
 * @author Gabe Abrams
 */
type CACCLStatus = (
  // Not launched
  | {
    // True if the user has launched via LTI
    launched: false,
  }
  // Launched
  | {
    // True if the user has launched via LTI
    launched: true,
    // LTI launch info for the current user
    launchInfo: LaunchInfo,
    // True if the user is authorized with to use the Canvas API
    authorized: boolean,
  }
);

export default CACCLStatus;