dce-reactkit 4.3.4 → 5.0.0

package/src/types/Log/LogMainInfo.ts

@@ -1,69 +0,0 @@
-// Import shared types
-import LogLevel from '../LogLevel';
-
-/**
- * Main information in a log event
- * @author Gabe Abrams
- */
-type LogMainInfo = {
-  // Unique id of the log event
-  id: string,
-  // First name of the user
-  userFirstName: string,
-  // Last name of the user
-  userLastName: string,
-  // User email
-  userEmail: string,
-  // User Canvas Id
-  userId: number,
-  // If true, the user is a learner
-  isLearner: boolean,
-  // If true, the user is an admin
-  isAdmin: boolean,
-  // If true, the user is a ttm
-  isTTM: boolean,
-  // The id of the Canvas course that the user launched from
-  courseId: number,
-  // The name of the Canvas course
-  courseName: string,
-  // Browser info
-  browser: {
-    // Name of the browser
-    name: string,
-    // Version of the browser
-    version: string,
-  },
-  // Device info
-  device: {
-    // Name of the operating system
-    os: string,
-    // If true, device is a mobile device
-    isMobile: boolean,
-  },
-  // Calendar year that the event is from
-  year: number,
-  // Month that the event is from (1 = Jan, 12 = Dec)
-  month: number,
-  // Day of the month that the event is from
-  day: number,
-  // Hour of the day (24hr) when the event occurred
-  hour: number,
-  // Minute of the day when the event occurred
-  minute: number,
-  // Timestamp of event (ms since epoch)
-  timestamp: number,
-  // Context of the event (each app determines how to organize contexts)
-  context: string,
-  // Subcontext of the event (each app determines how to organize subcontexts)
-  subcontext: string,
-  // List of tags that apply to this action (each app determines tag usage)
-  tags: string[],
-  // Log level
-  level: LogLevel,
-  // Additional optional custom metadata
-  metadata?: {
-    [k: string]: any,
-  },
-};
-
-export default LogMainInfo;

package/src/types/Log/LogSourceSpecificInfo.ts

@@ -1,25 +0,0 @@
-// Import shared types
-import LogSource from '../LogSource';
-
-/**
- * Log info that is specific to the type of source
- * @author Gabe Abrams
- */
-type LogSourceSpecificInfo = (
-  // Client
-  | {
-    // Source of the event
-    source: LogSource.Client,
-  }
-  // Server
-  | {
-    // Source of the event
-    source: LogSource.Server,
-    // Route path (e.g. /api/admin/courses/53450/blocks)
-    routePath: string,
-    // Route template (e.g. /api/admin/courses/:courseId/blocks)
-    routeTemplate: string,
-  }
-);
-
-export default LogSourceSpecificInfo;

package/src/types/Log/LogTypeSpecificInfo.ts

@@ -1,33 +0,0 @@
-// Import shared types
-import LogAction from '../LogAction';
-import LogType from '../LogType';
-
-/**
- * Log info that is specific to the type of log
- * @author Gabe Abrams
- */
-type LogTypeSpecificInfo = (
-  // Error
-  | {
-    // Type of the event
-    type: LogType.Error,
-    // The error message
-    errorMessage: string,
-    // The error code
-    errorCode: string,
-    // Error stack trace
-    errorStack: string,
-  }
-  // Action
-  | {
-    // Type of the event
-    type: LogType.Action,
-    // Target of the action (each app determines the list of targets)
-    // These are usually buttons, panels, elements, etc.
-    target: string,
-    // The type of action performed on the target
-    action: LogAction,
-  }
-);
-
-export default LogTypeSpecificInfo;

package/src/types/Log/index.ts

@@ -1,17 +0,0 @@
-// Import shared types
-import LogMainInfo from './LogMainInfo';
-import LogSourceSpecificInfo from './LogSourceSpecificInfo';
-import LogTypeSpecificInfo from './LogTypeSpecificInfo';
-
-/**
- * A single log event corresponding to an action performed by a user or an
- *   error encountered by a user
- * @author Gabe Abrams
- */
-type Log = (
-  LogMainInfo
-  & LogSourceSpecificInfo
-  & LogTypeSpecificInfo
-);
-
-export default Log;

package/src/types/LogAction.ts

@@ -1,52 +0,0 @@
-/**
- * Types of actions
- * @author Gabe Abrams
- */
-enum LogAction {
-  // Target was opened by the user (it was not on screen, but now it is)
-  Open = 'Open',
-  // Target was closed by the user (it was on screen, but now it is not)
-  Close = 'Close',
-  // Target was cancelled by the user (it was on closed without saving)
-  Cancel = 'Cancel',
-  // Target was expanded by the user (it always remains on screen, but size was changed)
-  Expand = 'Expand',
-  // Target was collapsed by the user (it always remains on screen, but size was changed)
-  Collapse = 'Collapse',
-  // Target was viewed by the user (only for items that are not opened or closed, those must use Open/Close actions)
-  View = 'View',
-  // Target interrupted the user (popup, dialog, validation message, etc. appeared without user prompting)
-  Interrupt = 'Interrupt',
-  // Target was created by the user (it did not exist before)
-  Create = 'Create',
-  // Target was modified by the user (it existed and was changed)
-  Modify = 'Modify',
-  // Target was deleted by the user (it existed and now it doesn't)
-  Delete = 'Delete',
-  // Target was added by the user (it already existed and was added to another place)
-  Add = 'Add',
-  // Target was removed by the user (it was removed from something but still exists)
-  Remove = 'Remove',
-  // Target was activated by the user (click, check, tap, keypress, etc.)
-  Activate = 'Activate',
-  // Target was deactivated by the user (click away, uncheck, tap outside of, tab away, etc.)
-  Deactivate = 'Deactivate',
-  // User showed interest in a target (hover, peek, etc.)
-  Peek = 'Peek',
-  // Halt a process (pause, etc.)
-  Halt = 'Halt',
-  // Resume a process (resume a halted process)
-  Resume = 'Resume',
-  // Jump to/seek to/reveal/go to/navigate to a target
-  Jump = 'Jump',
-  // Post a submission/message/etc. into the target
-  Post = 'Post',
-  // Like something
-  Like = 'Like',
-  // Dislike something
-  Dislike = 'Dislike',
-  // Unknown action
-  Unknown = 'Unknown',
-}
-
-export default LogAction;

package/src/types/LogBuiltInMetadata.ts

@@ -1,19 +0,0 @@
-/**
- * Built-in metadata for logs
- * @author Gabe Abrams
- */
-const LogBuiltInMetadata = {
-  // Contexts
-  Context: {
-    Uncategorized: 'Uncategorized',
-    ServerRenderedErrorPage: 'ServerRenderedErrorPage',
-    ServerEndpointError: 'ServerEndpointError',
-    ClientFatalError: 'ClientFatalError',
-  },
-  // Targets
-  Target: {
-    NoTarget: 'NoTarget',
-  },
-};
-
-export default LogBuiltInMetadata;

package/src/types/LogFunction.ts

@@ -1,46 +0,0 @@
-// Import shared types
-import Log from './Log';
-import LogAction from './LogAction';
-import LogLevel from './LogLevel';
-
-/**
- * Type of a log action function
- * @author Gabe Abrams
- */
-type LogFunction = (
-  opts: (
-    // Shared info
-    {
-      // Context of the event (each app determines how to organize contexts)
-      context: string | { _: string },
-      // Subcontext of the event (each app determines how to organize subcontexts)
-      subcontext?: string,
-      // List of tags that apply to this action (each app determines tag usage)
-      tags?: string[],
-      // Additional optional custom metadata
-      metadata?: {
-        [k: string]: any,
-      },
-      // Log level (default is info)
-      level?: LogLevel,
-    } & (
-      // Error
-      | {
-        // The error object to log
-        error: any,
-      }
-      // Action
-      | {
-        // The type of action performed
-        action: LogAction,
-        // Target of the action (each app determines the list of targets)
-        // These are usually buttons, panels, elements, etc.
-        // If no target is included, this should indicate that this is an action
-        // being performed on the whole feature (open/close/etc)
-        target?: string,
-      }
-    )
-  ),
-) => Promise<Log>;
-
-export default LogFunction;

package/src/types/LogLevel.ts

@@ -1,11 +0,0 @@
-/**
- * Allowed log levels
- * @author Gabe Abrams
- */
-enum LogLevel {
-  Warn = 'Warn',
-  Info = 'Info', // Default
-  Debug = 'Debug',
-}
-
-export default LogLevel;

package/src/types/LogMetadataContextMap.ts

@@ -1,15 +0,0 @@
-/**
- * Type of the context map in a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataContextMap = {
-  [k: string]: (
-    | string
-    | {
-      _: string,
-      [k: string]: string
-    }
-  )
-};
-
-export default LogMetadataContextMap;

package/src/types/LogMetadataTagMap.ts

@@ -1,9 +0,0 @@
-/**
- * Type of the tag map inside a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataTagMap = {
-  [k: string]: string
-};
-
-export default LogMetadataTagMap;

package/src/types/LogMetadataTargetMap.ts

@@ -1,9 +0,0 @@
-/**
- * Type of the target map inside a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataTargetMap = {
-  [k: string]: string
-};
-
-export default LogMetadataTargetMap;

package/src/types/LogMetadataType.ts

@@ -1,16 +0,0 @@
-// Import shared types
-import LogMetadataContextMap from './LogMetadataContextMap';
-import LogMetadataTagMap from './LogMetadataTagMap';
-import LogMetadataTargetMap from './LogMetadataTargetMap';
-
-/**
- * Type of a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataType = {
-  Context?: LogMetadataContextMap,
-  Tag?: LogMetadataTagMap,
-  Target?: LogMetadataTargetMap,
-};
-
-export default LogMetadataType;

package/src/types/LogReviewerFilterState/ActionErrorFilterState.ts

@@ -1,24 +0,0 @@
-import LogType from '../LogType';
-
-/**
- * Action filter state (only relevant for action logs)
- * @author Yuen Ler Chow
- */
-type ActionErrorFilterState = {
-  // Required type of log
-  type: LogType | undefined, // If undefined, no filter applied
-  // Query for error message (only relevant if type is error)
-  errorMessage: string, // If empty, no filter applied
-  // Query for error code (only relevant if type is error)
-  errorCode: string, // If empty, no filter applied
-  // Action targets to include (only relevant if type is action)
-  target: {
-    [k: string]: boolean
-  },
-  // Action types to include (only relevant if type is action)
-  action: {
-    [k: string]: boolean
-  },
-};
-
-export default ActionErrorFilterState;

package/src/types/LogReviewerFilterState/AdvancedFilterState.ts

@@ -1,36 +0,0 @@
-import LogSource from '../LogSource';
-
-/**
- * Advanced filter state
- * @author Yuen Ler Chow
- */
-type AdvancedFilterState = {
-  // Query for user first name (case insensitive)
-  userFirstName: string, // If empty, no filter applied
-  // Query for user last name (case insensitive)
-  userLastName: string, // If empty, no filter applied
-  // Query for user email (case insensitive)
-  userEmail: string, // If empty, no filter applied
-  // Match for userId (numerical)
-  userId: string, // If empty, no filter applied
-  // If true, include students
-  includeLearners: boolean,
-  // If true, include ttms
-  includeTTMs: boolean,
-  // If true, include admins
-  includeAdmins: boolean,
-  // Match for courseId (numerical)
-  courseId: string, // If empty, no filter applied
-  // Query for course name (case insensitive)
-  courseName: string, // If empty, no filter applied
-  // Required isMobile value
-  isMobile: (true | false | undefined), // If undefined, no filter applied
-  // Required log source value
-  source: LogSource | undefined, // If undefined, no filter applied
-  // Query for route path (only relevant if source is server)
-  routePath: string, // If empty, no filter applied
-  // Query for route template (only relevant if source is server)
-  routeTemplate: string, // If empty, no filter applied
-};
-
-export default AdvancedFilterState;

package/src/types/LogReviewerFilterState/ContextFilterState.ts

@@ -1,16 +0,0 @@
-/**
- * Context filter state
- * @author Yuen Ler Chow
- */
-type ContextFilterState = {
-  [k: string]: (
-    // No subcontexts
-    | boolean // True if selected
-    // Includes subcontexts
-    | {
-      [k: string]: boolean // True if selected
-    }
-  )
-};
-
-export default ContextFilterState;

package/src/types/LogReviewerFilterState/DateFilterState.ts

@@ -1,26 +0,0 @@
-/**
- * Date filter state
- * @author Yuen Ler Chow
- */
-type DateFilterState = {
-  // Current start date
-  startDate: {
-    // Full year
-    year: number,
-    // 1-indexed month
-    month: number,
-    // 1-indexed day
-    day: number,
-  },
-  // Current end date
-  endDate: {
-    // Full year
-    year: number,
-    // 1-indexed month
-    month: number,
-    // 1-indexed day
-    day: number,
-  },
-};
-
-export default DateFilterState;

package/src/types/LogReviewerFilterState/TagFilterState.ts

@@ -1,9 +0,0 @@
-/**
- * Tag filter state
- * @author Yuen Ler Chow
- */
-type TagFilterState = {
-  [k: string]: boolean // tag => true if in the list of tags to show
-};
-
-export default TagFilterState;

package/src/types/LogReviewerFilterState/index.ts

@@ -1,24 +0,0 @@
-import DateFilterState from './DateFilterState';
-import ContextFilterState from './ContextFilterState';
-import TagFilterState from './TagFilterState';
-import ActionErrorFilterState from './ActionErrorFilterState';
-import AdvancedFilterState from './AdvancedFilterState';
-
-/**
- * A bundle of filter state objects for each type of filter
- * @author Gabe Abrams
- */
-type LogReviewerFilterState = {
-  // Date filter state
-  dateFilterState: DateFilterState,
-  // Context filter state
-  contextFilterState: ContextFilterState,
-  // Tag filter state
-  tagFilterState: TagFilterState,
-  // Action error filter state
-  actionErrorFilterState: ActionErrorFilterState,
-  // Advanced filter state
-  advancedFilterState: AdvancedFilterState,
-};
-
-export default LogReviewerFilterState;

package/src/types/LogSource.ts

@@ -1,12 +0,0 @@
-/**
- * Source of a log event
- * @author Gabe Abrams
- */
-enum LogSource {
-  // Client
-  Client = 'client',
-  // Server
-  Server = 'server',
-}
-
-export default LogSource;

package/src/types/LogType.ts

@@ -1,12 +0,0 @@
-/**
- * Type of a log event
- * @author Gabe Abrams
- */
-enum LogType {
-  // User action
-  Action = 'action',
-  // Error
-  Error = 'error',
-}
-
-export default LogType;

package/src/types/ParamType.ts

@@ -1,18 +0,0 @@
-/**
- * Server-side API param types
- * @author Gabe Abrams
- */
-enum ParamType {
-  Boolean = 'Boolean', // Boolean
-  BooleanOptional = 'BooleanOptional', // Optional boolean
-  Float = 'Float', // Float Number
-  FloatOptional = 'FloatOptional', // Optional Float Number
-  Int = 'Int', // Integer Number
-  IntOptional = 'IntOptional', // Optional Integer Number
-  JSON = 'JSON', // JSONified object
-  JSONOptional = 'JSONOptional', // Optional JSONified object
-  String = 'String', // String
-  StringOptional = 'StringOptional', // Optional string
-}
-
-export default ParamType;

package/src/types/ReactKitErrorCode.tsx

@@ -1,17 +0,0 @@
-// Highest error code = DRK37
-
-/**
- * List of error codes built into the react kit
- * @author Gabe Abrams
- */
-enum ReactKitErrorCode {
-  NoResponse = 'DRK1',
-  NoCode = 'DRK2',
-  SessionExpired = 'DRK3',
-  NoCACCLSendRequestFunction = 'DRK7',
-  SimpleDateChooserInvalidDateRange = 'DRK35',
-  SimpleDateChooserInvalidNumMonths = 'DRK36',
-  ETTimestampInvalid = 'DRK37',
-}
-
-export default ReactKitErrorCode;