@instructure/outcomes-ui 4.0.0 → 4.1.0

package/es/translated/zh-Hant/i18n/__tests__/i18n.test.ts

@@ -0,0 +1,144 @@
+import { expect, jest, describe, it, beforeEach } from '@jest/globals'
+
+// Mock the translation loader
+jest.mock('../translationLoader', () => ({
+  loadDefaultTranslations: () => ({
+    en: {
+      test_key_1: { message: 'Test message 1' },
+      test_key_2: { message: 'Test message 2' },
+    },
+    es: {
+      test_key_1: { message: 'Mensaje de prueba 1' },
+      test_key_2: { message: 'Mensaje de prueba 2' },
+    },
+  }),
+}))
+
+// Mock format-message
+jest.mock('format-message')
+
+// Mock format-message-generate-id
+jest.mock('format-message-generate-id/underscored_crc32')
+
+// Now import
+import formatMessage, { type SetupOptions } from 'format-message'
+import { setupI18n, getAvailableLanguages, isLanguageAvailable } from '../i18n'
+
+describe('i18n', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+
+    // Setup mocks
+    const mockSetup = jest.fn()
+    ;(formatMessage.setup as unknown) = mockSetup
+  })
+
+  describe('getAvailableLanguages', () => {
+    it('returns list of available languages', () => {
+      const languages = getAvailableLanguages()
+      expect(Array.isArray(languages)).toBe(true)
+      expect(languages.length).toBeGreaterThan(0)
+      // Should include at least the languages from the translations folder
+      expect(languages).toContain('en')
+    })
+  })
+
+  describe('isLanguageAvailable', () => {
+    it('returns true for available language', () => {
+      expect(isLanguageAvailable('en')).toBe(true)
+    })
+
+    it('returns false for unavailable language', () => {
+      expect(isLanguageAvailable('xyz')).toBe(false)
+    })
+  })
+
+  describe('setupI18n', () => {
+    it('calls formatMessage.setup with correct parameters', () => {
+      setupI18n('en')
+
+      expect(formatMessage.setup).toHaveBeenCalledTimes(1)
+      const callArgs = (formatMessage.setup as jest.Mock).mock.calls[0][0] as SetupOptions
+
+      expect(callArgs.locale).toBe('en')
+      expect(callArgs.translations).toBeDefined()
+      expect(callArgs.generateId).toBeDefined()
+    })
+
+    it('merges overrides with default translations', () => {
+      const overrides = {
+        en: {
+          custom_key: { message: 'Custom message' },
+        },
+      }
+
+      setupI18n('en', overrides)
+
+      const callArgs = (formatMessage.setup as jest.Mock).mock.calls[0][0] as SetupOptions
+      const translations = callArgs.translations!
+
+      expect(translations.en!.custom_key).toEqual({ message: 'Custom message' })
+    })
+
+    it('preserves default translations when overriding', () => {
+      const overrides = {
+        en: {
+          custom_key: { message: 'Custom message' },
+        },
+      }
+
+      setupI18n('en', overrides)
+
+      const callArgs = (formatMessage.setup as jest.Mock).mock.calls[0][0] as SetupOptions
+      const translations = callArgs.translations!
+
+      // Original translations should still be present
+      expect(translations.en!.test_key_1).toBeDefined()
+      expect(translations.en!.custom_key).toEqual({ message: 'Custom message' })
+    })
+
+    it('warns when language is not available and no override provided', () => {
+      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {})
+
+      setupI18n('xyz')
+
+      expect(consoleWarnSpy).toHaveBeenCalledWith(
+        expect.stringContaining('Language "xyz" not available')
+      )
+
+      consoleWarnSpy.mockRestore()
+    })
+
+    it('does not warn when unavailable language has override', () => {
+      const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {})
+
+      setupI18n('xyz', {
+        xyz: { key1: { message: 'Test' } },
+      })
+
+      expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+      consoleWarnSpy.mockRestore()
+    })
+
+    it('handles empty overrides object', () => {
+      setupI18n('en', {})
+
+      expect(formatMessage.setup).toHaveBeenCalledTimes(1)
+      const callArgs = (formatMessage.setup as jest.Mock).mock.calls[0][0] as SetupOptions
+
+      expect(callArgs.locale).toBe('en')
+      expect(callArgs.translations).toBeDefined()
+    })
+
+    it('handles undefined overrides', () => {
+      setupI18n('en', undefined)
+
+      expect(formatMessage.setup).toHaveBeenCalledTimes(1)
+      const callArgs = (formatMessage.setup as jest.Mock).mock.calls[0][0] as SetupOptions
+
+      expect(callArgs.locale).toBe('en')
+      expect(callArgs.translations).toBeDefined()
+    })
+  })
+})

package/es/translated/zh-Hant/i18n/format-message-generate-id.d.ts

@@ -0,0 +1,4 @@
+declare module 'format-message-generate-id/underscored_crc32' {
+  function underscoredCrc32(pattern: string): string
+  export = underscoredCrc32
+}

package/es/translated/zh-Hant/i18n/i18n.ts

@@ -0,0 +1,64 @@
+// i18n.ts
+// Translation wrapper for format-message with override support
+
+import formatMessage, { type Translations } from 'format-message'
+import underscoredCrc32 from 'format-message-generate-id/underscored_crc32'
+import { loadDefaultTranslations } from './translationLoader'
+
+const defaultTranslations = loadDefaultTranslations()
+
+/**
+ * Utility to merge default and override translations for all languages.
+ */
+function getMergedTranslations(overrides?: Translations): Translations {
+  const merged: Translations = { ...defaultTranslations }
+
+  if (overrides) {
+    for (const language in overrides) {
+      const langOverrides = overrides[language]
+
+      if (langOverrides && typeof langOverrides === 'object') {
+        merged[language] = merged[language]
+          ? { ...merged[language], ...langOverrides }
+          : langOverrides
+      }
+    }
+  }
+
+  return merged
+}
+
+/**
+ * Get list of available languages.
+ */
+export function getAvailableLanguages(): string[] {
+  return Object.keys(defaultTranslations)
+}
+
+/**
+ * Check if a language is available.
+ */
+export function isLanguageAvailable(language: string): boolean {
+  return language in defaultTranslations
+}
+
+/**
+ * Setup format-message for a given language and resource overrides.
+ *
+ * @param language - The current language code (e.g., 'en', 'es')
+ * @param overrides - Optional resource overrides for any language (nested structure: { lang: { key: "text" } })
+ * @throws {Error} If the language is not available and no overrides are provided
+ */
+export function setupI18n(language: string, overrides?: Translations): void {
+  if (!isLanguageAvailable(language) && !overrides?.[language]) {
+    console.warn(`Language "${language}" not available. Available: ${getAvailableLanguages().join(', ')}`)
+  }
+
+  const translations = getMergedTranslations(overrides)
+
+  formatMessage.setup({
+    locale: language,
+    translations,
+    generateId: underscoredCrc32,
+  })
+}

package/es/translated/zh-Hant/i18n/translationLoader.ts

@@ -0,0 +1,22 @@
+import { type Translations } from 'format-message'
+
+/**
+ * Load translation files using webpack's require.context.
+ */
+export function loadTranslationContext() {
+  return require.context('../../translations', false, /\.json$/)
+}
+
+/**
+ * Load and build the default translations object from all translation files.
+ */
+export function loadDefaultTranslations(): Readonly<Translations> {
+  const translationContext = loadTranslationContext()
+
+  return Object.freeze(
+    translationContext.keys().reduce((acc, fileName) => {
+      const languageCode = fileName.replace(/^\.\//, '').replace(/\.json$/, '')
+      return { ...acc, [languageCode]: translationContext(fileName) }
+    }, {} as Translations)
+  )
+}

package/es/translated/zh-Hant/jest-dom.d.ts

@@ -0,0 +1,10 @@
+import type {TestingLibraryMatchers} from '@testing-library/jest-dom/matchers'
+import type {expect} from '@jest/globals'
+
+declare module '@jest/expect' {
+  interface Matchers<R extends void | Promise<void>>
+    extends TestingLibraryMatchers<
+      ReturnType<typeof expect.stringContaining>,
+      R
+    > {}
+}

package/es/translated/zh-Hant/test/jest-setup/__mocks__/msw-storybook-addon.js

@@ -0,0 +1,15 @@
+/* eslint-env jest */
+// Mock for msw-storybook-addon in Jest environment
+// Storybook MSW integration is not needed in Jest tests
+
+// Provide a default export as well for ES6 imports
+var mswStorybook = {
+  initialize: jest.fn(),
+  mswLoader: jest.fn(function () {
+    return {};
+  })
+};
+module.exports = mswStorybook;
+module.exports.initialize = mswStorybook.initialize;
+module.exports.mswLoader = mswStorybook.mswLoader;
+module.exports.default = mswStorybook;

package/es/translated/zh-Hant/test/jest-setup/__mocks__/msw.js

@@ -0,0 +1,58 @@
+/* eslint-env jest */
+// Mock for msw in Jest environment
+// MSW is used in Storybook but not needed in Jest snapshot tests
+
+var HttpResponse = {
+  json: jest.fn(function (data, options) {
+    return {
+      data: data,
+      options: options
+    };
+  }),
+  text: jest.fn(function (text, options) {
+    return {
+      text: text,
+      options: options
+    };
+  })
+};
+var http = {
+  get: jest.fn(function () {
+    return jest.fn();
+  }),
+  post: jest.fn(function () {
+    return jest.fn();
+  }),
+  put: jest.fn(function () {
+    return jest.fn();
+  }),
+  patch: jest.fn(function () {
+    return jest.fn();
+  }),
+  delete: jest.fn(function () {
+    return jest.fn();
+  }),
+  all: jest.fn(function () {
+    return jest.fn();
+  })
+};
+var setupWorker = jest.fn(function () {
+  return {
+    start: jest.fn(),
+    stop: jest.fn(),
+    use: jest.fn()
+  };
+});
+var setupServer = jest.fn(function () {
+  return {
+    listen: jest.fn(),
+    close: jest.fn(),
+    use: jest.fn()
+  };
+});
+module.exports = {
+  http: http,
+  HttpResponse: HttpResponse,
+  setupWorker: setupWorker,
+  setupServer: setupServer
+};

package/es/translated/zh-Hant/types/gradebook/index.ts

@@ -0,0 +1,56 @@
+export interface Student {
+  id: string
+  name: string
+  display_name: string
+  sortable_name: string
+  sis_id?: string
+  integration_id?: string
+  login_id?: string
+  avatar_url?: string
+  status?: string
+}
+
+export interface MasteryBucket {
+  name: string
+  icon: MasteryLevel
+  count: number
+}
+
+export interface StudentMasteryScores {
+  grossAverage: number | null
+  averageIcon: MasteryLevel
+  averageText: string
+  buckets: {
+    [key: string]: MasteryBucket
+  }
+}
+
+export type MasteryLevel =
+  | 'exceeds_mastery'
+  | 'mastery'
+  | 'near_mastery'
+  | 'remediation'
+  | 'unassessed'
+  | 'no_evidence'
+
+export interface Section {
+  id: number
+  name: string
+}
+
+export interface LmgbUserDetails {
+  course: {
+    name: string
+  }
+  user: {
+    sections: Section[]
+    last_login: string | null
+  }
+}
+
+export interface Pagination {
+  currentPage: number
+  perPage: number
+  totalPages: number
+  totalCount: number
+}

package/es/translated/zh-Hant/types/react-csv.d.ts

@@ -0,0 +1 @@
+declare module 'react-csv'

package/es/translated/zh-Hant/typescript-placeholder.ts

@@ -0,0 +1,6 @@
+// This is a placeholder file to satisfy TypeScript compiler (typecheck fails
+// if there are no .ts or .tsx files in the codebase)
+// It can be safely deleted once real TypeScript files are added to the codebase
+// This file is not imported or used anywhere in the codebase
+
+export const FOO = 'bar'

package/es/translated/zh-Hant/util/gradebook/colors.ts

@@ -0,0 +1,19 @@
+import { ViewProps } from '@instructure/ui-view'
+
+type IconButtonColor = 'primary' | 'primary-inverse'
+
+const INVERSE_COLOR: Record<NonNullable<ViewProps['background']>, IconButtonColor> = {
+  transparent:       'primary',
+  primary:           'primary',
+  secondary:         'primary',
+  'primary-inverse': 'primary-inverse',
+  brand:             'primary-inverse',
+  info:              'primary-inverse',
+  alert:             'primary-inverse',
+  success:           'primary-inverse',
+  danger:            'primary-inverse',
+  warning:           'primary-inverse',
+}
+
+export const getInverseColor = (background: ViewProps['background']): IconButtonColor =>
+  background ? INVERSE_COLOR[background] ?? 'primary' : 'primary'

package/es/translated/zh-Hant/util/gradebook/constants.ts

@@ -0,0 +1,42 @@
+export const COLUMN_WIDTH = 160
+export const CELL_HEIGHT = 48
+
+export enum SortOrder {
+  ASC = 'asc',
+  DESC = 'desc',
+}
+
+export enum SortBy {
+  Outcome = 'outcome',
+}
+
+export enum SecondaryInfoDisplay {
+  NONE = 'none',
+  SIS_ID = 'sis_id',
+  INTEGRATION_ID = 'integration_id',
+  LOGIN_ID = 'login_id',
+}
+
+export enum DisplayFilter {
+  SHOW_UNPUBLISHED_ASSIGNMENTS = 'show_unpublished_assignments',
+  SHOW_STUDENTS_WITH_NO_RESULTS = 'show_students_with_no_results',
+  SHOW_OUTCOMES_WITH_NO_RESULTS = 'show_outcomes_with_no_results',
+  SHOW_STUDENT_AVATARS = 'show_student_avatars',
+}
+
+export enum NameDisplayFormat {
+  FIRST_LAST = 'first_last',
+  LAST_FIRST = 'last_first',
+}
+
+export enum ScoreDisplayFormat {
+  ICON_ONLY = 'icon_only',
+  ICON_AND_POINTS = 'icon_and_points',
+  ICON_AND_LABEL = 'icon_and_label',
+}
+
+export enum OutcomeArrangement {
+  ALPHABETICAL = 'alphabetical',
+  CUSTOM = 'custom',
+  UPLOAD_ORDER = 'upload_order',
+}

package/es/types/gradebook/index.ts

@@ -0,0 +1,56 @@
+export interface Student {
+  id: string
+  name: string
+  display_name: string
+  sortable_name: string
+  sis_id?: string
+  integration_id?: string
+  login_id?: string
+  avatar_url?: string
+  status?: string
+}
+
+export interface MasteryBucket {
+  name: string
+  icon: MasteryLevel
+  count: number
+}
+
+export interface StudentMasteryScores {
+  grossAverage: number | null
+  averageIcon: MasteryLevel
+  averageText: string
+  buckets: {
+    [key: string]: MasteryBucket
+  }
+}
+
+export type MasteryLevel =
+  | 'exceeds_mastery'
+  | 'mastery'
+  | 'near_mastery'
+  | 'remediation'
+  | 'unassessed'
+  | 'no_evidence'
+
+export interface Section {
+  id: number
+  name: string
+}
+
+export interface LmgbUserDetails {
+  course: {
+    name: string
+  }
+  user: {
+    sections: Section[]
+    last_login: string | null
+  }
+}
+
+export interface Pagination {
+  currentPage: number
+  perPage: number
+  totalPages: number
+  totalCount: number
+}

package/es/types/react-csv.d.ts

@@ -0,0 +1 @@
+declare module 'react-csv'

package/es/typescript-placeholder.ts

@@ -0,0 +1,6 @@
+// This is a placeholder file to satisfy TypeScript compiler (typecheck fails
+// if there are no .ts or .tsx files in the codebase)
+// It can be safely deleted once real TypeScript files are added to the codebase
+// This file is not imported or used anywhere in the codebase
+
+export const FOO = 'bar'

package/es/util/gradebook/colors.ts

@@ -0,0 +1,19 @@
+import { ViewProps } from '@instructure/ui-view'
+
+type IconButtonColor = 'primary' | 'primary-inverse'
+
+const INVERSE_COLOR: Record<NonNullable<ViewProps['background']>, IconButtonColor> = {
+  transparent:       'primary',
+  primary:           'primary',
+  secondary:         'primary',
+  'primary-inverse': 'primary-inverse',
+  brand:             'primary-inverse',
+  info:              'primary-inverse',
+  alert:             'primary-inverse',
+  success:           'primary-inverse',
+  danger:            'primary-inverse',
+  warning:           'primary-inverse',
+}
+
+export const getInverseColor = (background: ViewProps['background']): IconButtonColor =>
+  background ? INVERSE_COLOR[background] ?? 'primary' : 'primary'

package/es/util/gradebook/constants.ts

@@ -0,0 +1,42 @@
+export const COLUMN_WIDTH = 160
+export const CELL_HEIGHT = 48
+
+export enum SortOrder {
+  ASC = 'asc',
+  DESC = 'desc',
+}
+
+export enum SortBy {
+  Outcome = 'outcome',
+}
+
+export enum SecondaryInfoDisplay {
+  NONE = 'none',
+  SIS_ID = 'sis_id',
+  INTEGRATION_ID = 'integration_id',
+  LOGIN_ID = 'login_id',
+}
+
+export enum DisplayFilter {
+  SHOW_UNPUBLISHED_ASSIGNMENTS = 'show_unpublished_assignments',
+  SHOW_STUDENTS_WITH_NO_RESULTS = 'show_students_with_no_results',
+  SHOW_OUTCOMES_WITH_NO_RESULTS = 'show_outcomes_with_no_results',
+  SHOW_STUDENT_AVATARS = 'show_student_avatars',
+}
+
+export enum NameDisplayFormat {
+  FIRST_LAST = 'first_last',
+  LAST_FIRST = 'last_first',
+}
+
+export enum ScoreDisplayFormat {
+  ICON_ONLY = 'icon_only',
+  ICON_AND_POINTS = 'icon_and_points',
+  ICON_AND_LABEL = 'icon_and_label',
+}
+
+export enum OutcomeArrangement {
+  ALPHABETICAL = 'alphabetical',
+  CUSTOM = 'custom',
+  UPLOAD_ORDER = 'upload_order',
+}

package/lib/components/FlashAlert/index.d.ts

@@ -0,0 +1,11 @@
+export interface ShowFlashAlertProps {
+  message: string
+  err?: Error | unknown
+  type?: 'info' | 'success' | 'warning' | 'error'
+  timeout?: number
+  srOnly?: boolean
+}
+
+export function showFlashAlert(props: ShowFlashAlertProps): void
+
+export declare const defaultTimeout: number