test(frontend): use orval to generate MSW mocks DEV-2232

jsapp/jest/setupUnitTest.ts

@@ -9,6 +9,18 @@ import $ from 'jquery'
 Object.defineProperty(globalThis, 'TextEncoder', { value: TextEncoder, configurable: true })
 Object.defineProperty(globalThis, 'TextDecoder', { value: TextDecoder, configurable: true })
 
+// MSW needs BroadcastChannel for WebSocket mocking
+if (typeof globalThis.BroadcastChannel === 'undefined') {
+  // @ts-expect-error: Minimal polyfill for test environment
+  globalThis.BroadcastChannel = class BroadcastChannel {
+    constructor(public name: string) {}
+    postMessage() {}
+    close() {}
+    addEventListener() {}
+    removeEventListener() {}
+  }
+}
+
 // Add global t() mock (see /static/js/global_t.js)
 global.t = (str: string) => str
 

jsapp/jest/unit.config.ts

@@ -41,6 +41,9 @@ const config: Config = {
     ...defaults.testPathIgnorePatterns, // 📦 exclude '/node_modules/'
   ],
 
+  // Transform ESM modules from node_modules (MSW and its dependencies)
+  transformIgnorePatterns: ['node_modules/(?!(msw|@mswjs|@bundled-es-modules|statuses|until-async)/)'],
+
   // Set up test environment
   testEnvironment: 'jsdom',
 

jsapp/js/account/DeleteAccountBanner.stories.tsx

@@ -13,10 +13,7 @@ const meta: Meta<typeof DeleteAccountBanner> = {
   argTypes: {},
   parameters: {
     msw: {
-      handlers: {
-        organization: organizationMock(),
-        assets: assetsMock(),
-      },
+      handlers: [organizationMock(), assetsMock()],
     },
     a11y: { test: 'todo' },
   },
@@ -61,9 +58,7 @@ export const UserHasAssets: Story = {
 export const UserHasNoAssets: Story = {
   parameters: {
     msw: {
-      handlers: {
-        assets: assetsMock({ count: 0 }),
-      },
+      handlers: [organizationMock(), assetsMock({ count: 0 })],
     },
   },
   play: async ({ canvasElement }) => {
@@ -80,9 +75,7 @@ export const UserHasNoAssets: Story = {
 export const UserOwnsMMO: Story = {
   parameters: {
     msw: {
-      handlers: {
-        organization: organizationMock({ is_mmo: true }),
-      },
+      handlers: [organizationMock({ is_mmo: true }), assetsMock()],
     },
   },
   play: async ({ canvasElement }) => {

jsapp/js/api/models/_dataResponseSupplementalDetails.ts

@@ -1,7 +1,3 @@
-import type { SupplementalDetailsAutomaticQual } from './supplementalDetailsAutomaticQual'
-import type { SupplementalDetailsAutomaticTranscription } from './supplementalDetailsAutomaticTranscription'
-import type { SupplementalDetailsAutomaticTranslation } from './supplementalDetailsAutomaticTranslation'
-import type { SupplementalDetailsManualQual } from './supplementalDetailsManualQual'
 /**
  * Generated by orval v7.10.0 🍺
  * Do not edit manually.
@@ -13,18 +9,22 @@ The endpoints are grouped by area of intended use. Each category contains relate
 **General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
  * OpenAPI spec version: 2.0.0 (api_v2)
  */
-import type { SupplementalDetailsManualTranscription } from './supplementalDetailsManualTranscription'
-import type { SupplementalDetailsManualTranslation } from './supplementalDetailsManualTranslation'
+import type { _DataResponseSupplementalDetailsOneOf } from './_dataResponseSupplementalDetailsOneOf'
+import type { _DataResponseSupplementalDetailsOneOfFive } from './_dataResponseSupplementalDetailsOneOfFive'
+import type { _DataResponseSupplementalDetailsOneOfFour } from './_dataResponseSupplementalDetailsOneOfFour'
+import type { _DataResponseSupplementalDetailsOneOfSix } from './_dataResponseSupplementalDetailsOneOfSix'
+import type { _DataResponseSupplementalDetailsOneOfThree } from './_dataResponseSupplementalDetailsOneOfThree'
+import type { _DataResponseSupplementalDetailsOneOfTwo } from './_dataResponseSupplementalDetailsOneOfTwo'
 
 /**
  * Action-specific supplemental data attached to this submission. Structure varies by action type (transcription, translation, qual). Top-level keys are question XPaths, values are action objects.
  * @nullable
  */
 export type _DataResponseSupplementalDetails =
-  | SupplementalDetailsManualTranscription
-  | SupplementalDetailsManualTranslation
-  | SupplementalDetailsAutomaticTranscription
-  | SupplementalDetailsAutomaticTranslation
-  | SupplementalDetailsManualQual
-  | SupplementalDetailsAutomaticQual
+  | _DataResponseSupplementalDetailsOneOf
+  | _DataResponseSupplementalDetailsOneOfTwo
+  | _DataResponseSupplementalDetailsOneOfThree
+  | _DataResponseSupplementalDetailsOneOfFour
+  | _DataResponseSupplementalDetailsOneOfFive
+  | _DataResponseSupplementalDetailsOneOfSix
   | null

jsapp/js/api/models/supplementalDetailsManualTranscription.ts → jsapp/js/api/models/_dataResponseSupplementalDetailsOneOf.ts

@@ -14,7 +14,7 @@ import type { SupplementalDataManualTranscription } from './supplementalDataManu
 /**
  * Manual transcription supplemental details
  */
-export interface SupplementalDetailsManualTranscription {
+export type _DataResponseSupplementalDetailsOneOf = {
   [key: string]: {
     manual_transcription: SupplementalDataManualTranscription
   }

jsapp/js/api/models/supplementalDetailsManualQual.ts → jsapp/js/api/models/_dataResponseSupplementalDetailsOneOfFive.ts

@@ -14,7 +14,7 @@ import type { SupplementalDataManualQual } from './supplementalDataManualQual'
 /**
  * Manual qualitative supplemental details
  */
-export interface SupplementalDetailsManualQual {
+export type _DataResponseSupplementalDetailsOneOfFive = {
   [key: string]: {
     manual_qual: SupplementalDataManualQual
   }

jsapp/js/api/models/supplementalDetailsAutomaticTranslation.ts → jsapp/js/api/models/_dataResponseSupplementalDetailsOneOfFour.ts

@@ -14,7 +14,7 @@ import type { SupplementalDataAutomaticTranslation } from './supplementalDataAut
 /**
  * Automatic translation supplemental details
  */
-export interface SupplementalDetailsAutomaticTranslation {
+export type _DataResponseSupplementalDetailsOneOfFour = {
   [key: string]: {
     automatic_google_translation: SupplementalDataAutomaticTranslation
   }

jsapp/js/api/models/supplementalDetailsAutomaticQual.ts → jsapp/js/api/models/_dataResponseSupplementalDetailsOneOfSix.ts

@@ -14,7 +14,7 @@ import type { SupplementalDataAutomaticQual } from './supplementalDataAutomaticQ
 /**
  * Automatic qualitative supplemental details
  */
-export interface SupplementalDetailsAutomaticQual {
+export type _DataResponseSupplementalDetailsOneOfSix = {
   [key: string]: {
     automatic_bedrock_qual: SupplementalDataAutomaticQual
   }

jsapp/js/api/models/supplementalDetailsAutomaticTranscription.ts → jsapp/js/api/models/_dataResponseSupplementalDetailsOneOfThree.ts

@@ -14,7 +14,7 @@ import type { SupplementalDataAutomaticTranscription } from './supplementalDataA
 /**
  * Automatic transcription supplemental details
  */
-export interface SupplementalDetailsAutomaticTranscription {
+export type _DataResponseSupplementalDetailsOneOfThree = {
   [key: string]: {
     automatic_google_transcription: SupplementalDataAutomaticTranscription
   }

jsapp/js/api/models/supplementalDetailsManualTranslation.ts → jsapp/js/api/models/_dataResponseSupplementalDetailsOneOfTwo.ts

@@ -14,7 +14,7 @@ import type { SupplementalDataManualTranslation } from './supplementalDataManual
 /**
  * Manual translation supplemental details
  */
-export interface SupplementalDetailsManualTranslation {
+export type _DataResponseSupplementalDetailsOneOfTwo = {
   [key: string]: {
     manual_translation: SupplementalDataManualTranslation
   }

jsapp/js/api/models/asset.ts

@@ -1,3 +1,4 @@
+import type { AssetAccessTypes } from './assetAccessTypes'
 import type { AssetAdvancedFeatures } from './assetAdvancedFeatures'
 import type { AssetAnalysisFormJson } from './assetAnalysisFormJson'
 import type { AssetAssignablePermissionsItem } from './assetAssignablePermissionsItem'
@@ -12,8 +13,10 @@ import type { AssetDownloadsItem } from './assetDownloadsItem'
 import type { AssetEffectivePermissionsItem } from './assetEffectivePermissionsItem'
 import type { AssetEmbedsItem } from './assetEmbedsItem'
 import type { AssetExportSettings } from './assetExportSettings'
+import type { AssetFilesItem } from './assetFilesItem'
 import type { AssetMapCustom } from './assetMapCustom'
 import type { AssetMapStyles } from './assetMapStyles'
+import type { AssetPermissionsItem } from './assetPermissionsItem'
 import type { AssetProjectOwnership } from './assetProjectOwnership'
 import type { AssetReportCustom } from './assetReportCustom'
 import type { AssetReportStyles } from './assetReportStyles'
@@ -41,25 +44,30 @@ export interface Asset {
   parent?: string | null
   settings?: AssetSettings
   asset_type: AssetTypeEnum
-  readonly files: readonly string[]
+  readonly files: readonly AssetFilesItem[]
   readonly summary: AssetSummary
   date_created?: string
   date_modified?: string
   /** @nullable */
   date_deployed?: string | null
-  readonly version_id: string
-  readonly version__content_hash: string
+  /** @nullable */
+  readonly version_id: string | null
+  /** @nullable */
+  readonly version__content_hash: string | null
   readonly version_count: number
   readonly has_deployment: boolean
-  readonly deployed_version_id: string
+  /** @nullable */
+  readonly deployed_version_id: string | null
   readonly deployed_versions: AssetDeployedVersions
   readonly deployment__links: AssetDeploymentLinks
   readonly deployment__active: boolean
   readonly deployment__data_download_links: AssetDeploymentDataDownloadLinks
   readonly deployment__submission_count: number
-  readonly deployment__last_submission_time: string
+  /** @nullable */
+  readonly deployment__last_submission_time: string | null
   readonly deployment__encrypted: boolean
-  readonly deployment__uuid: string
+  /** @nullable */
+  readonly deployment__uuid: string | null
   readonly deployment_status: AssetDeploymentStatusEnum
   report_styles?: AssetReportStyles
   report_custom?: AssetReportCustom
@@ -79,15 +87,16 @@ export interface Asset {
   /** @maxLength 255 */
   name?: string
   readonly assignable_permissions: readonly AssetAssignablePermissionsItem[]
-  readonly permissions: readonly string[]
+  readonly permissions: readonly AssetPermissionsItem[]
   readonly effective_permissions: readonly AssetEffectivePermissionsItem[]
   readonly exports: string
   readonly export_settings: readonly AssetExportSettings[]
   readonly data: string
   readonly children: AssetChildren
   readonly subscribers_count: number
   readonly status: string
-  readonly access_types: readonly string[]
+  /** @nullable */
+  readonly access_types: AssetAccessTypes
   data_sharing?: AssetDataSharing
   readonly paired_data: string
   /** @nullable */

jsapp/js/api/models/assetAccessTypes.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+/**
+ * @nullable
+ */
+export type AssetAccessTypes = readonly string[] | null | null | null

jsapp/js/api/models/assetAdvancedFeatures.ts

@@ -1,3 +1,4 @@
+import type { AssetAdvancedFeaturesQual } from './assetAdvancedFeaturesQual'
 /**
  * Generated by orval v7.10.0 🍺
  * Do not edit manually.
@@ -9,5 +10,12 @@ The endpoints are grouped by area of intended use. Each category contains relate
 **General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
  * OpenAPI spec version: 2.0.0 (api_v2)
  */
+import type { AssetAdvancedFeaturesTranscript } from './assetAdvancedFeaturesTranscript'
+import type { AssetAdvancedFeaturesTranslation } from './assetAdvancedFeaturesTranslation'
 
-export type AssetAdvancedFeatures = { [key: string]: unknown }
+export type AssetAdvancedFeatures = {
+  transcript?: AssetAdvancedFeaturesTranscript
+  translation?: AssetAdvancedFeaturesTranslation
+  qual?: AssetAdvancedFeaturesQual
+  _version?: string
+}

jsapp/js/api/models/assetAdvancedFeaturesQual.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { AssetAdvancedFeaturesQualQualSurveyItem } from './assetAdvancedFeaturesQualQualSurveyItem'
+
+export type AssetAdvancedFeaturesQual = {
+  qual_survey?: AssetAdvancedFeaturesQualQualSurveyItem[]
+}

jsapp/js/api/models/assetAdvancedFeaturesQualQualSurveyItem.ts

@@ -0,0 +1,24 @@
+import type { AssetAdvancedFeaturesQualQualSurveyItemChoicesItem } from './assetAdvancedFeaturesQualQualSurveyItemChoicesItem'
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { AssetAdvancedFeaturesQualQualSurveyItemLabels } from './assetAdvancedFeaturesQualQualSurveyItemLabels'
+import type { AssetAdvancedFeaturesQualQualSurveyItemOptions } from './assetAdvancedFeaturesQualQualSurveyItemOptions'
+
+export type AssetAdvancedFeaturesQualQualSurveyItem = {
+  type: string
+  labels: AssetAdvancedFeaturesQualQualSurveyItemLabels
+  uuid?: string
+  options?: AssetAdvancedFeaturesQualQualSurveyItemOptions
+  xpath: string
+  scope: string
+  choices?: AssetAdvancedFeaturesQualQualSurveyItemChoicesItem[]
+}

jsapp/js/api/models/assetAdvancedFeaturesQualQualSurveyItemChoicesItem.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { AssetAdvancedFeaturesQualQualSurveyItemChoicesItemLabels } from './assetAdvancedFeaturesQualQualSurveyItemChoicesItemLabels'
+import type { AssetAdvancedFeaturesQualQualSurveyItemChoicesItemOptions } from './assetAdvancedFeaturesQualQualSurveyItemChoicesItemOptions'
+
+export type AssetAdvancedFeaturesQualQualSurveyItemChoicesItem = {
+  labels: AssetAdvancedFeaturesQualQualSurveyItemChoicesItemLabels
+  uuid: string
+  options?: AssetAdvancedFeaturesQualQualSurveyItemChoicesItemOptions
+}

jsapp/js/api/models/assetAdvancedFeaturesQualQualSurveyItemChoicesItemLabels.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AssetAdvancedFeaturesQualQualSurveyItemChoicesItemLabels = {
+  _default: string
+  [key: string]: string
+}

jsapp/js/api/models/assetAdvancedFeaturesQualQualSurveyItemChoicesItemOptions.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AssetAdvancedFeaturesQualQualSurveyItemChoicesItemOptions = {
+  deleted?: boolean
+}

jsapp/js/api/models/assetAdvancedFeaturesQualQualSurveyItemLabels.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AssetAdvancedFeaturesQualQualSurveyItemLabels = {
+  _default: string
+  [key: string]: string
+}

jsapp/js/api/models/assetAdvancedFeaturesQualQualSurveyItemOptions.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox Primary API
+ * This page documents all KoboToolbox API endpoints, except for those implementing the OpenRosa protocol, which are [documented separately](/api/openrosa/docs/).
+
+The endpoints are grouped by area of intended use. Each category contains related endpoints, with detailed documentation on usage and configuration. Use this as a reference to quickly find the right endpoint for managing projects, forms, data, permissions, integrations, logs, and organizational resources.
+
+**General note**: All projects (whether deployed or draft), as well as all library content (questions, blocks, templates, and collections) in the user-facing application are represented in the API as "assets".
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AssetAdvancedFeaturesQualQualSurveyItemOptions = {
+  deleted?: boolean
+}