fix most types

Author: jackkav

packages/insomnia/src/main/importers/entities.ts

@@ -1,5 +1,7 @@
 import type * as Har from 'har-format';
 
+import type { SupportedAuthTypes } from '~/models/request';
+
 export interface Comment {
   comment?: string;
 }
@@ -12,7 +14,7 @@ export interface Authentication extends Comment {
   clientId?: string;
   clientSecret?: Variable;
   scope?: string;
-  type?: 'basic' | 'oauth2';
+  type?: SupportedAuthTypes;
   grantType?: 'authorization_code' | 'password' | 'client_credentials';
   disabled?: boolean;
   username?: string;

packages/insomnia/src/main/importers/importers/curl.ts

@@ -1,8 +1,11 @@
 import { URL } from 'node:url';
 
 import * as curlconverter from 'curlconverter';
+import type { AuthType } from 'curlconverter/dist/src/Request';
 import { type ControlOperator, parse, type ParseEntry } from 'shell-quote';
 
+import type { SupportedAuthTypes } from '~/models/request';
+
 import { type Converter, type ImportRequest, type Parameter } from '../entities';
 
 export const id = 'curl';
@@ -443,31 +446,36 @@ const transformCurlDataObjectToInsomniaBody = (
   if (!data) {
     return { mimeType };
   }
+  // Handle non-form-urlencoded bodies as text
   if (mimeType !== 'application/x-www-form-urlencoded') {
     return {
       text: new URLSearchParams(data).toString(),
       mimeType,
     };
   }
+  // curlconverter gives us an object: {key: value}
   if (typeof data === 'object') {
     return {
-      params: Object.entries(data).map(([name, value]) => ({ name, value })),
+      params: Object.entries(data).map(([name, value]) => ({ name, value })) as Parameter[],
       mimeType,
     };
   }
+  // curlconverter gives us a file upload string: key@filename
   if (data.includes('@')) {
     const [name, fileName] = data.split('@');
     return {
       params: [{ name, fileName, type: 'file' }],
       mimeType,
     };
   }
+  // curlconverter gives us url params: key=value&key2=value2
   if (data.includes('&')) {
     return {
       params: [...new URLSearchParams(data).entries()].map(([name, value]) => ({ name, value })),
       mimeType,
     };
   }
+  // curlconverter gives us a single binary param: key=value
   if (data.includes('=')) {
     const firstEqual = data.indexOf('=');
     const name = data.slice(0, firstEqual);
@@ -478,6 +486,7 @@ const transformCurlDataObjectToInsomniaBody = (
     };
   }
 
+  // we default to decoding uri components, unclear why it works this way but this preserves existing behaviour
   return {
     params: [{ name: '', value: decodeURIComponent(data) }],
     mimeType,
@@ -486,11 +495,30 @@ const transformCurlDataObjectToInsomniaBody = (
 const transformCurlObjectToInsomniaRequest = (output: curlconverter.JSONOutput): ImportRequest => {
   const mimeType = output.headers?.['Content-Type'] || '';
   const body = transformCurlDataObjectToInsomniaBody(output.data, mimeType);
+
+  // Match our auth types to curlconverter
+  const mapAuthTypeToInsomniaAuthType: Record<AuthType, SupportedAuthTypes> = {
+    'basic': 'basic',
+    'bearer': 'bearer',
+    'digest': 'digest',
+    'ntlm': 'ntlm',
+    'ntlm-wb': 'ntlm',
+    'none': 'none',
+    'negotiate': 'none', // not supported in Insomnia, may be similar to ntlm
+    'aws-sigv4': 'none', // not supported in Insomnia, may be similar to hawk
+  };
   const authentication = output.auth
-    ? { type: output.auth_type, username: output.auth.user, password: output.auth.password }
+    ? {
+        type: output.auth_type ? mapAuthTypeToInsomniaAuthType[output.auth_type] : 'none',
+        username: output.auth.user,
+        password: output.auth.password,
+      }
     : {};
+  // Preserves existing behaviour of putting query params in the parameters section for GET requests, and in the body for other requests
   const parameters =
-    output.method === 'GET' && output.data ? Object.entries(output.data).map(([name, value]) => ({ name, value })) : [];
+    output.method === 'GET' && output.data
+      ? (Object.entries(output.data).map(([name, value]) => ({ name, value })) as Parameter[])
+      : [];
   const count = requestCount++;
   return {
     _id: `__REQ_${count}__`,

packages/insomnia/src/models/request.ts

@@ -32,6 +32,20 @@ export const canDuplicate = true;
 
 export const canSync = true;
 
+export type SupportedAuthTypes =
+  | 'basic'
+  | 'apikey'
+  | 'oauth2'
+  | 'hawk'
+  | 'oauth1'
+  | 'digest'
+  | 'ntlm'
+  | 'bearer'
+  | 'iam'
+  | 'netrc'
+  | 'asap'
+  | 'none'
+  | 'singleToken';
 /**
  * Basic Authentication configuration
  * Uses username and password with optional ISO-8859-1 encoding