feat(frontend): Orval generated react-query helpers from API

Author: Akuukis

jsapp/js/api.ts

@@ -118,13 +118,13 @@ export interface FetchDataOptions {
   includeHeaders?: boolean
 }
 
-const fetchData = async <T>(
+export const fetchDataRaw = async <T>(
   /**
    * If you have full url to be called, remember to use `prependRootUrl` option.
    */
   path: string,
   method: FetchHttpMethod,
-  data?: Json,
+  data?: string,
   options?: FetchDataOptions,
 ) => {
   // Prepare options
@@ -158,7 +158,7 @@ const fetchData = async <T>(
   }
 
   if (data) {
-    fetchOptions['body'] = JSON.stringify(data)
+    fetchOptions['body'] = data
   }
 
   const response = await fetch(url, fetchOptions)
@@ -210,9 +210,22 @@ const fetchData = async <T>(
     } as { headers: Headers } & T
   }
 
-  return responseJson as T
+  return { data: responseJson, status: response.status, headers: response.headers } as T
 }
 
+const fetchData = async <T>(
+  /**
+   * If you have full url to be called, remember to use `prependRootUrl` option.
+   */
+  path: string,
+  method: FetchHttpMethod,
+  data?: Json,
+  options?: FetchDataOptions,
+) => {
+  const body = data ? JSON.stringify(data) : undefined
+  const response = await fetchDataRaw<{ data: T; status: number; headers: unknown }>(path, method, body, options)
+  return response.data
+}
 /** GET Kobo API at path */
 export const fetchGet = async <T>(path: string, options?: FetchDataOptions) =>
   fetchData<T>(path, 'GET', undefined, options)

jsapp/js/api/models/_dataResponseAttachments.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type _DataResponseAttachments = {
+  download_url?: string
+  download_large_url?: string
+  download_medium_url?: string
+  download_small_url?: string
+  mimetype?: string
+  filename?: string
+  uid?: string
+  question_xpath?: string
+}

jsapp/js/api/models/_exportCreatePayloadQueryAndItemSubmissionTime.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type _ExportCreatePayloadQueryAndItemSubmissionTime = {
+  $gte?: string
+}

jsapp/js/api/models/_exportSettingCreatePayloadExportSettingsQueryAndItemSubmissionTime.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type _ExportSettingCreatePayloadExportSettingsQueryAndItemSubmissionTime = {
+  $gte?: string
+}

jsapp/js/api/models/_permissionAssignmentCreateRequestOneOfTwoPartialPermissionItemFilterItemSubmittedBy.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type _PermissionAssignmentCreateRequestOneOfTwoPartialPermissionItemFilterItemSubmittedBy = {
+  $in?: string[]
+}

jsapp/js/api/models/accessLogsListParams.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AccessLogsListParams = {
+  /**
+   * Number of results to return per page.
+   */
+  limit?: number
+  /**
+   * The initial index from which to return the results.
+   */
+  offset?: number
+  q?: string
+}

jsapp/js/api/models/accessLogsMeListParams.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AccessLogsMeListParams = {
+  /**
+   * Number of results to return per page.
+   */
+  limit?: number
+  /**
+   * The initial index from which to return the results.
+   */
+  offset?: number
+  q?: string
+}

jsapp/js/api/models/asset.ts

@@ -0,0 +1,95 @@
+import type { AssetAdvancedFeatures } from './assetAdvancedFeatures'
+import type { AssetAdvancedSubmissionSchema } from './assetAdvancedSubmissionSchema'
+import type { AssetAnalysisFormJson } from './assetAnalysisFormJson'
+import type { AssetAssignablePermissionsItem } from './assetAssignablePermissionsItem'
+import type { AssetChildren } from './assetChildren'
+import type { AssetContent } from './assetContent'
+import type { AssetDataSharing } from './assetDataSharing'
+import type { AssetDeployedVersions } from './assetDeployedVersions'
+import type { AssetDeploymentDataDownloadLinks } from './assetDeploymentDataDownloadLinks'
+import type { AssetDeploymentLinks } from './assetDeploymentLinks'
+import type { AssetDownloadsItem } from './assetDownloadsItem'
+import type { AssetEffectivePermissionsItem } from './assetEffectivePermissionsItem'
+import type { AssetEmbedsItem } from './assetEmbedsItem'
+import type { AssetExportSettings } from './assetExportSettings'
+import type { AssetMapCustom } from './assetMapCustom'
+import type { AssetMapStyles } from './assetMapStyles'
+import type { AssetProjectOwnership } from './assetProjectOwnership'
+import type { AssetReportCustom } from './assetReportCustom'
+import type { AssetReportStyles } from './assetReportStyles'
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+import type { AssetSettings } from './assetSettings'
+import type { AssetSummary } from './assetSummary'
+import type { AssetTypeEnum } from './assetTypeEnum'
+
+export interface Asset {
+  readonly url: string
+  readonly owner: string
+  /** Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. */
+  readonly owner__username: string
+  /** @nullable */
+  parent?: string | null
+  settings?: AssetSettings
+  asset_type: AssetTypeEnum
+  readonly files: readonly string[]
+  readonly summary: AssetSummary
+  date_created?: string
+  date_modified?: string
+  /** @nullable */
+  date_deployed?: string | null
+  readonly version_id: string
+  readonly version__content_hash: string
+  readonly version_count: number
+  readonly has_deployment: boolean
+  readonly deployed_version_id: string
+  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
+  readonly deployment__encrypted: boolean
+  readonly deployment__uuid: string
+  readonly deployment_status: string
+  report_styles?: AssetReportStyles
+  report_custom?: AssetReportCustom
+  advanced_features?: AssetAdvancedFeatures
+  readonly advanced_submission_schema: AssetAdvancedSubmissionSchema
+  readonly analysis_form_json: AssetAnalysisFormJson
+  map_styles?: AssetMapStyles
+  map_custom?: AssetMapCustom
+  content?: AssetContent
+  readonly downloads: readonly AssetDownloadsItem[]
+  readonly embeds: readonly AssetEmbedsItem[]
+  readonly xform_link: string
+  readonly hooks_link: string
+  tag_string?: string
+  readonly uid: string
+  readonly kind: string
+  readonly xls_link: string
+  /** @maxLength 255 */
+  name?: string
+  readonly assignable_permissions: readonly AssetAssignablePermissionsItem[]
+  readonly permissions: readonly string[]
+  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[]
+  data_sharing?: AssetDataSharing
+  readonly paired_data: string
+  /** @nullable */
+  readonly project_ownership: AssetProjectOwnership
+  readonly owner_label: string
+  /** @nullable */
+  readonly last_modified_by: string | null
+}

jsapp/js/api/models/assetAdvancedFeatures.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AssetAdvancedFeatures = { [key: string]: unknown }

jsapp/js/api/models/assetAdvancedSubmissionSchema.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * KoboToolbox API
+ * Powerful and intuitive data collection tools to make an impact
+ * OpenAPI spec version: 2.0.0 (api_v2)
+ */
+
+export type AssetAdvancedSubmissionSchema = {
+  readonly type?: string
+  readonly $description?: string
+}