refactor: http service (#2233)

packages/responses/src/Domain/Auth/ChangeCredentialsResponse.ts

@@ -1,6 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { ChangeCredentialsData } from './ChangeCredentialsData'
 
-export type ChangeCredentialsResponse = HttpResponse & {
-  data: ChangeCredentialsData
-}
+export type ChangeCredentialsResponse = ChangeCredentialsData

packages/responses/src/Domain/Auth/KeyParamsResponse.ts

@@ -1,6 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { KeyParamsData } from './KeyParamsData'
 
-export type KeyParamsResponse = HttpResponse & {
-  data: KeyParamsData
-}
+export type KeyParamsResponse = KeyParamsData

packages/responses/src/Domain/Auth/RegistrationResponse.ts

@@ -1,6 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { RegistrationData } from './RegistrationData'
 
-export type RegistrationResponse = HttpResponse & {
-  data: RegistrationData
-}
+export type RegistrationResponse = RegistrationData

packages/responses/src/Domain/Auth/SessionListResponse.ts

@@ -1,4 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { SessionListEntry } from './SessionListEntry'
 
-export type SessionListResponse = HttpResponse & { data: SessionListEntry[] }
+export type SessionListResponse = SessionListEntry[]

packages/responses/src/Domain/Auth/SessionRenewalResponse.ts

@@ -1,6 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { SessionRenewalData } from './SessionRenewalData'
 
-export type SessionRenewalResponse = HttpResponse & {
-  data: SessionRenewalData
-}
+export type SessionRenewalResponse = SessionRenewalData

packages/responses/src/Domain/Auth/SignInResponse.ts

@@ -1,6 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { SignInData } from './SignInData'
 
-export type SignInResponse = HttpResponse & {
-  data: SignInData
-}
+export type SignInResponse = SignInData

packages/responses/src/Domain/Auth/SignOutResponse.ts

@@ -1,3 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
+import { HttpSuccessResponse } from '../Http/HttpResponse'
 
-export type SignOutResponse = HttpResponse & Record<string, unknown>
+export type SignOutResponse = HttpSuccessResponse

packages/responses/src/Domain/Error/ClientError.ts

@@ -1,11 +1,9 @@
-import { Error } from '../Http/Error'
-
 export class ClientDisplayableError {
   constructor(public text: string, public title?: string, public tag?: string) {
     console.error('Client Displayable Error:', text, title || '', tag || '')
   }
 
-  static FromError(error: Error) {
+  static FromError(error: { message: string; tag?: string }) {
     return new ClientDisplayableError(error.message, undefined, error.tag)
   }
 }

packages/responses/src/Domain/Files/CloseUploadSessionResponse.ts

@@ -1,6 +1 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
-
-export type CloseUploadSessionResponse = MinimalHttpResponse & {
-  success: boolean
-  message: string
-}
+export type CloseUploadSessionResponse = { success: boolean; message: string }

packages/responses/src/Domain/Files/CreateValetTokenResponse.ts

@@ -1,6 +1,3 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 import { CreateValetTokenResponseData } from './CreateValetTokenResponseData'
 
-export type CreateValetTokenResponse = MinimalHttpResponse & {
-  data: CreateValetTokenResponseData
-}
+export type CreateValetTokenResponse = CreateValetTokenResponseData

packages/responses/src/Domain/Files/DownloadFileChunkResponse.ts

@@ -1,5 +1 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
-
-export type DownloadFileChunkResponse = MinimalHttpResponse & {
-  data: ArrayBuffer
-}
+export type DownloadFileChunkResponse = ArrayBuffer

packages/responses/src/Domain/Files/StartUploadSessionResponse.ts

@@ -1,6 +1,4 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
-
-export type StartUploadSessionResponse = MinimalHttpResponse & {
+export type StartUploadSessionResponse = {
   success: boolean
   uploadId: string
 }

packages/responses/src/Domain/Files/UploadFileChunkResponse.ts

@@ -1,5 +1,3 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
-
-export type UploadFileChunkResponse = MinimalHttpResponse & {
+export type UploadFileChunkResponse = {
   success: boolean
 }

packages/responses/src/Domain/Http/DeprecatedError.ts

@@ -0,0 +1,5 @@
+export type DeprecatedError = {
+  message: string
+  status: number
+  tag?: string
+}

packages/responses/src/Domain/Http/DeprecatedHttpResponse.ts

@@ -0,0 +1,13 @@
+import { DeprecatedError } from './DeprecatedError'
+import { HttpStatusCode } from './HttpStatusCode'
+import { DeprecatedResponseMeta } from './DeprecatedResponseMeta'
+
+export type DeprecatedHttpResponse = {
+  status: HttpStatusCode
+  error?: DeprecatedError
+  data?: {
+    error?: DeprecatedError
+  }
+  meta?: DeprecatedResponseMeta
+  headers?: Map<string, string | null>
+}

packages/responses/src/Domain/Http/DeprecatedMinimalHttpResponses.ts

@@ -0,0 +1,8 @@
+import { DeprecatedError } from './DeprecatedError'
+import { HttpStatusCode } from './HttpStatusCode'
+
+export type DeprecatedMinimalHttpResponse = {
+  status: HttpStatusCode
+  error?: DeprecatedError
+  headers?: Map<string, string | null>
+}

packages/responses/src/Domain/Http/DeprecatedResponseMeta.ts

@@ -0,0 +1,11 @@
+import { Role } from '@standardnotes/security'
+
+export type DeprecatedResponseMeta = {
+  auth: {
+    userUuid?: string
+    roles?: Role[]
+  }
+  server: {
+    filesServerUrl?: string
+  }
+}

packages/responses/src/Domain/Http/DeprecatedStatusCode.ts

@@ -1,7 +1,6 @@
-export enum StatusCode {
+export enum DeprecatedStatusCode {
   LocalValidationError = 10,
   CanceledMfa = 11,
-  UnknownError = 12,
 
   HttpStatusMinSuccess = 200,
   HttpStatusNoContent = 204,

packages/responses/src/Domain/Http/Error.ts

@@ -1,10 +0,0 @@
-export type Error = {
-  message: string
-  status: number
-  tag?: string
-  /** In the case of MFA required responses,
-   * the required prompt is returned as part of the error */
-  payload?: {
-    mfa_key?: string
-  }
-}

packages/responses/src/Domain/Http/ErrorTag.ts

@@ -0,0 +1,15 @@
+export enum ErrorTag {
+  MfaInvalid = 'mfa-invalid',
+  MfaRequired = 'mfa-required',
+  U2FRequired = 'u2f-required',
+  RefreshTokenInvalid = 'invalid-refresh-token',
+  RefreshTokenExpired = 'expired-refresh-token',
+  AccessTokenExpired = 'expired-access-token',
+  ParametersInvalid = 'invalid-parameters',
+  RevokedSession = 'revoked-session',
+  AuthInvalid = 'invalid-auth',
+  ReadOnlyAccess = 'read-only-access',
+
+  ClientValidationError = 'client-validation-error',
+  ClientCanceledMfa = 'client-canceled-mfa',
+}

packages/responses/src/Domain/Http/Functions.ts

@@ -1,6 +0,0 @@
-import { HttpResponse } from './HttpResponse'
-import { StatusCode } from './StatusCode'
-
-export function isErrorResponseExpiredToken(errorResponse: HttpResponse): boolean {
-  return errorResponse.status === StatusCode.HttpStatusExpiredAccessToken
-}

packages/responses/src/Domain/Http/HttpError.ts

@@ -0,0 +1,6 @@
+import { ErrorTag } from './ErrorTag'
+
+export type HttpError = {
+  message: string
+  tag?: ErrorTag
+}

packages/responses/src/Domain/Http/HttpErrorResponseBody.ts

@@ -0,0 +1,5 @@
+import { HttpError } from './HttpError'
+
+export type HttpErrorResponseBody = {
+  error: HttpError
+}

packages/responses/src/Domain/Http/HttpHeaders.ts

@@ -0,0 +1 @@
+export type HttpHeaders = Map<string, string | null>

packages/responses/src/Domain/Http/HttpRequest.ts

@@ -0,0 +1,13 @@
+import { HttpRequestParams } from './HttpRequestParams'
+import { HttpVerb } from './HttpVerb'
+
+export type HttpRequest = {
+  url: string
+  params?: HttpRequestParams
+  rawBytes?: Uint8Array
+  verb: HttpVerb
+  authentication?: string
+  customHeaders?: Record<string, string>[]
+  responseType?: XMLHttpRequestResponseType
+  external?: boolean
+}

packages/responses/src/Domain/Http/HttpRequestParams.ts

@@ -0,0 +1 @@
+export type HttpRequestParams = unknown

packages/responses/src/Domain/Http/HttpResponse.ts

@@ -1,13 +1,26 @@
-import { StatusCode } from './StatusCode'
-import { Error } from './Error'
-import { ResponseMeta } from './ResponseMeta'
+import { HttpErrorResponseBody } from './HttpErrorResponseBody'
+import { HttpResponseMeta } from './HttpResponseMeta'
+import { HttpHeaders } from './HttpHeaders'
+import { HttpStatusCode } from './HttpStatusCode'
 
-export type HttpResponse = {
-  status?: StatusCode
-  error?: Error
-  data?: {
-    error?: Error
-  }
-  meta?: ResponseMeta
-  headers?: Map<string, string | null>
+type AnySuccessRecord = Record<string, unknown> & { error?: never }
+
+interface HttpResponseBase {
+  status: HttpStatusCode
+  meta?: HttpResponseMeta
+  headers?: HttpHeaders
+}
+
+export interface HttpErrorResponse extends HttpResponseBase {
+  data: HttpErrorResponseBody
+}
+
+export interface HttpSuccessResponse<T = AnySuccessRecord> extends HttpResponseBase {
+  data: T
+}
+
+export type HttpResponse<T = AnySuccessRecord> = HttpErrorResponse | HttpSuccessResponse<T>
+
+export function isErrorResponse<T>(response: HttpResponse<T>): response is HttpErrorResponse {
+  return (response.data as HttpErrorResponseBody)?.error != undefined
 }

packages/responses/src/Domain/Http/HttpResponseMeta.ts

@@ -1,6 +1,6 @@
 import { Role } from '@standardnotes/security'
 
-export type ResponseMeta = {
+export type HttpResponseMeta = {
   auth: {
     userUuid?: string
     roles?: Role[]

packages/responses/src/Domain/Http/HttpStatusCode.ts

@@ -0,0 +1,11 @@
+export enum HttpStatusCode {
+  Success = 200,
+  NoContent = 204,
+  MultipleChoices = 300,
+  BadRequest = 400,
+  Unauthorized = 401,
+  Forbidden = 403,
+  Gone = 410,
+  ExpiredAccessToken = 498,
+  InternalServerError = 500,
+}

packages/responses/src/Domain/Http/HttpVerb.ts

@@ -0,0 +1,7 @@
+export enum HttpVerb {
+  Get = 'GET',
+  Post = 'POST',
+  Put = 'PUT',
+  Patch = 'PATCH',
+  Delete = 'DELETE',
+}

packages/responses/src/Domain/Http/MinimalHttpResponses.ts

@@ -1,8 +0,0 @@
-import { StatusCode } from './StatusCode'
-import { Error } from './Error'
-
-export type MinimalHttpResponse = {
-  status?: StatusCode
-  error?: Error
-  headers?: Map<string, string | null>
-}

packages/responses/src/Domain/Http/index.ts

@@ -0,0 +1,15 @@
+export * from './ErrorTag'
+export * from './HttpErrorResponseBody'
+export * from './HttpHeaders'
+export * from './HttpRequest'
+export * from './HttpRequestParams'
+export * from './HttpResponse'
+export * from './HttpResponseMeta'
+export * from './HttpVerb'
+export * from './DeprecatedError'
+export * from './DeprecatedHttpResponse'
+export * from './DeprecatedMinimalHttpResponses'
+export * from './DeprecatedResponseMeta'
+export * from './DeprecatedStatusCode'
+export * from './HttpStatusCode'
+export * from './HttpError'

packages/responses/src/Domain/Item/CheckIntegrityResponse.ts

@@ -1,8 +1,5 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 import { IntegrityPayload } from './IntegrityPayload'
 
-export type CheckIntegrityResponse = MinimalHttpResponse & {
-  data: {
-    mismatches: IntegrityPayload[]
-  }
+export type CheckIntegrityResponse = {
+  mismatches: IntegrityPayload[]
 }

packages/responses/src/Domain/Item/GetSingleItemResponse.ts

@@ -1,14 +1,11 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 import { ServerItemResponse } from './ServerItemResponse'
 
-export type GetSingleItemResponse = MinimalHttpResponse & {
-  data:
-    | {
-        success: true
-        item: ServerItemResponse
-      }
-    | {
-        success: false
-        message: string
-      }
-}
+export type GetSingleItemResponse =
+  | {
+      success: true
+      item: ServerItemResponse
+    }
+  | {
+      success: false
+      message: string
+    }

packages/responses/src/Domain/Item/RawSyncResponse.ts

@@ -1,4 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { RawSyncData } from './RawSyncData'
 
-export type RawSyncResponse = HttpResponse & { data: RawSyncData }
+export type RawSyncResponse = RawSyncData

packages/responses/src/Domain/Listed/ActionResponse.ts

@@ -1,8 +1,8 @@
 import { AnyKeyParamsContent, ContentType } from '@standardnotes/common'
-import { HttpResponse } from '../Http/HttpResponse'
+import { DeprecatedHttpResponse } from '../Http/DeprecatedHttpResponse'
 import { ServerItemResponse } from '../Item/ServerItemResponse'
 
-export type ActionResponse = HttpResponse & {
+export type ActionResponse = DeprecatedHttpResponse & {
   description: string
   supported_types: ContentType[]
   deprecation?: string

packages/responses/src/Domain/Listed/ListedAccountInfoResponse.ts

@@ -1,6 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { ListedAccountInfo } from './ListedAccountInfo'
 
-export type ListedAccountInfoResponse = HttpResponse & {
-  data: ListedAccountInfo
-}
+export type ListedAccountInfoResponse = ListedAccountInfo

packages/responses/src/Domain/Listed/ListedRegistrationResponse.ts

@@ -1,5 +1 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
-
-export type ListedRegistrationResponse = MinimalHttpResponse & {
-  data?: unknown
-}
+export type ListedRegistrationResponse = unknown

packages/responses/src/Domain/User/DeleteSettingResponse.ts

@@ -1,3 +1,3 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
+import { HttpResponse } from '../Http/HttpResponse'
 
-export type DeleteSettingResponse = MinimalHttpResponse
+export type DeleteSettingResponse = HttpResponse

packages/responses/src/Domain/User/GetAvailableSubscriptionsResponse.ts

@@ -1,6 +1,3 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 import { AvailableSubscriptions } from './AvailableSubscriptions'
 
-export type GetAvailableSubscriptionsResponse = MinimalHttpResponse & {
-  data?: AvailableSubscriptions
-}
+export type GetAvailableSubscriptionsResponse = AvailableSubscriptions

packages/responses/src/Domain/User/GetOfflineFeaturesResponse.ts

@@ -1,9 +1,6 @@
 import { FeatureDescription } from '@standardnotes/features'
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 
-export type GetOfflineFeaturesResponse = MinimalHttpResponse & {
-  data?: {
-    features: FeatureDescription[]
-    roles: string[]
-  }
+export type GetOfflineFeaturesResponse = {
+  features: FeatureDescription[]
+  roles: string[]
 }

packages/responses/src/Domain/User/GetSettingResponse.ts

@@ -1,9 +1,6 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 import { SettingData } from './SettingData'
 
-export type GetSettingResponse = MinimalHttpResponse & {
-  data?: {
-    success?: boolean
-    setting?: SettingData
-  }
+export type GetSettingResponse = {
+  success?: boolean
+  setting?: SettingData
 }

packages/responses/src/Domain/User/GetSubscriptionResponse.ts

@@ -1,8 +1,5 @@
 import { Subscription } from '@standardnotes/security'
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 
-export type GetSubscriptionResponse = MinimalHttpResponse & {
-  data?: {
-    subscription?: Subscription
-  }
+export type GetSubscriptionResponse = {
+  subscription?: Subscription
 }

packages/responses/src/Domain/User/ListSettingsResponse.ts

@@ -1,8 +1,5 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
 import { SettingData } from './SettingData'
 
-export type ListSettingsResponse = MinimalHttpResponse & {
-  data?: {
-    settings?: SettingData[]
-  }
+export type ListSettingsResponse = {
+  settings?: SettingData[]
 }

packages/responses/src/Domain/User/PostSubscriptionTokensResponse.ts

@@ -1,7 +1,3 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
-
-export type PostSubscriptionTokensResponse = MinimalHttpResponse & {
-  data?: {
-    token: string
-  }
+export type PostSubscriptionTokensResponse = {
+  token: string
 }

packages/responses/src/Domain/User/UpdateSettingResponse.ts

@@ -1,3 +1 @@
-import { MinimalHttpResponse } from '../Http/MinimalHttpResponses'
-
-export type UpdateSettingResponse = MinimalHttpResponse
+export type UpdateSettingResponse = unknown

packages/responses/src/Domain/User/UserFeaturesResponse.ts

@@ -1,6 +1,3 @@
-import { HttpResponse } from '../Http/HttpResponse'
 import { UserFeaturesData } from './UserFeaturesData'
 
-export type UserFeaturesResponse = HttpResponse & {
-  data: UserFeaturesData
-}
+export type UserFeaturesResponse = UserFeaturesData

packages/responses/src/Domain/index.ts

@@ -21,12 +21,7 @@ export * from './Files/CreateValetTokenResponseData'
 export * from './Files/DownloadFileChunkResponse'
 export * from './Files/StartUploadSessionResponse'
 export * from './Files/UploadFileChunkResponse'
-export * from './Http/Error'
-export * from './Http/Functions'
-export * from './Http/HttpResponse'
-export * from './Http/MinimalHttpResponses'
-export * from './Http/ResponseMeta'
-export * from './Http/StatusCode'
+export * from './Http'
 export * from './Item/ApiEndpointParam'
 export * from './Item/CheckIntegrityResponse'
 export * from './Item/ConflictParams'