Merge pull request #34542 from software-mansion-labs/ts/centralized-a…

…pi-types

[TS migration] Create centralized types for API params

src/libs/API.ts → src/libs/API/index.ts

@@ -1,15 +1,15 @@
 import type {OnyxUpdate} from 'react-native-onyx';
 import Onyx from 'react-native-onyx';
-import type {ValueOf} from 'type-fest';
+import Log from '@libs/Log';
+import * as Middleware from '@libs/Middleware';
+import * as SequentialQueue from '@libs/Network/SequentialQueue';
+import * as Pusher from '@libs/Pusher/pusher';
+import * as Request from '@libs/Request';
 import CONST from '@src/CONST';
 import type OnyxRequest from '@src/types/onyx/Request';
 import type Response from '@src/types/onyx/Response';
-import pkg from '../../package.json';
-import Log from './Log';
-import * as Middleware from './Middleware';
-import * as SequentialQueue from './Network/SequentialQueue';
-import * as Pusher from './Pusher/pusher';
-import * as Request from './Request';
+import pkg from '../../../package.json';
+import type {ApiRequest, ApiRequestCommandParameters, ReadCommand, SideEffectRequestCommand, WriteCommand} from './types';
 
 // Setup API middlewares. Each request made will pass through a series of middleware functions that will get called in sequence (each one passing the result of the previous to the next).
 // Note: The ordering here is intentional as we want to Log, Recheck Connection, Reauthenticate, and Save the Response in Onyx. Errors thrown in one middleware will bubble to the next.
@@ -38,8 +38,6 @@ type OnyxData = {
     finallyData?: OnyxUpdate[];
 };
 
-type ApiRequestType = ValueOf<typeof CONST.API_REQUEST_TYPE>;
-
 /**
  * All calls to API.write() will be persisted to disk as JSON with the params, successData, and failureData (or finallyData, if included in place of the former two values).
  * This is so that if the network is unavailable or the app is closed, we can send the WRITE request later.
@@ -54,7 +52,7 @@ type ApiRequestType = ValueOf<typeof CONST.API_REQUEST_TYPE>;
  * @param [onyxData.failureData] - Onyx instructions that will be passed to Onyx.update() when the response has jsonCode !== 200.
  * @param [onyxData.finallyData] - Onyx instructions that will be passed to Onyx.update() when the response has jsonCode === 200 or jsonCode !== 200.
  */
-function write(command: string, apiCommandParameters: Record<string, unknown> = {}, onyxData: OnyxData = {}) {
+function write<TCommand extends WriteCommand>(command: TCommand, apiCommandParameters: ApiRequestCommandParameters[TCommand], onyxData: OnyxData = {}) {
     Log.info('Called API write', false, {command, ...apiCommandParameters});
     const {optimisticData, ...onyxDataWithoutOptimisticData} = onyxData;
 
@@ -112,11 +110,11 @@ function write(command: string, apiCommandParameters: Record<string, unknown> =
  *                                    response back to the caller or to trigger reconnection callbacks when re-authentication is required.
  * @returns
  */
-function makeRequestWithSideEffects(
-    command: string,
-    apiCommandParameters = {},
+function makeRequestWithSideEffects<TCommand extends SideEffectRequestCommand | WriteCommand | ReadCommand>(
+    command: TCommand,
+    apiCommandParameters: ApiRequestCommandParameters[TCommand],
     onyxData: OnyxData = {},
-    apiRequestType: ApiRequestType = CONST.API_REQUEST_TYPE.MAKE_REQUEST_WITH_SIDE_EFFECTS,
+    apiRequestType: ApiRequest = CONST.API_REQUEST_TYPE.MAKE_REQUEST_WITH_SIDE_EFFECTS,
 ): Promise<void | Response> {
     Log.info('Called API makeRequestWithSideEffects', false, {command, ...apiCommandParameters});
     const {optimisticData, ...onyxDataWithoutOptimisticData} = onyxData;
@@ -157,7 +155,7 @@ function makeRequestWithSideEffects(
  * @param [onyxData.failureData] - Onyx instructions that will be passed to Onyx.update() when the response has jsonCode !== 200.
  * @param [onyxData.finallyData] - Onyx instructions that will be passed to Onyx.update() when the response has jsonCode === 200 or jsonCode !== 200.
  */
-function read(command: string, apiCommandParameters: Record<string, unknown>, onyxData: OnyxData = {}) {
+function read<TCommand extends ReadCommand>(command: TCommand, apiCommandParameters: ApiRequestCommandParameters[TCommand], onyxData: OnyxData = {}) {
     // Ensure all write requests on the sequential queue have finished responding before running read requests.
     // Responses from read requests can overwrite the optimistic data inserted by
     // write requests that use the same Onyx keys and haven't responded yet.

src/libs/API/parameters/AcceptWalletTermsParams.ts

@@ -0,0 +1,6 @@
+type AcceptWalletTermsParams = {
+    hasAcceptedTerms: boolean;
+    reportID: string;
+};
+
+export default AcceptWalletTermsParams;

src/libs/API/parameters/ActivatePhysicalExpensifyCardParams.ts

@@ -0,0 +1,5 @@
+type ActivatePhysicalExpensifyCardParams = {
+    cardLastFourDigits: string;
+    cardID: number;
+};
+export default ActivatePhysicalExpensifyCardParams;

src/libs/API/parameters/AddCommentOrAttachementParams.ts

@@ -0,0 +1,13 @@
+type AddCommentOrAttachementParams = {
+    reportID: string;
+    reportActionID?: string;
+    commentReportActionID?: string | null;
+    reportComment?: string;
+    file?: File;
+    timezone?: string;
+    shouldAllowActionableMentionWhispers?: boolean;
+    clientCreatedTime?: string;
+    isOldDotConciergeChat?: boolean;
+};
+
+export default AddCommentOrAttachementParams;

src/libs/API/parameters/AddEmojiReactionParams.ts

@@ -0,0 +1,10 @@
+type AddEmojiReactionParams = {
+    reportID: string;
+    skinTone: string | number;
+    emojiCode: string;
+    reportActionID: string;
+    createdAt: string;
+    useEmojiReactions: boolean;
+};
+
+export default AddEmojiReactionParams;

src/libs/API/parameters/AddMembersToWorkspaceParams.ts

@@ -0,0 +1,8 @@
+type AddMembersToWorkspaceParams = {
+    employees: string;
+    welcomeNote: string;
+    policyID: string;
+    reportCreationData?: string;
+};
+
+export default AddMembersToWorkspaceParams;

src/libs/API/parameters/AddNewContactMethodParams.ts

@@ -0,0 +1,3 @@
+type AddNewContactMethodParams = {partnerUserID: string};
+
+export default AddNewContactMethodParams;

src/libs/API/parameters/AddPaymentCardParams.ts

@@ -0,0 +1,14 @@
+import type {ValueOf} from 'type-fest';
+import type CONST from '@src/CONST';
+
+type AddPaymentCardParams = {
+    cardNumber: string;
+    cardYear: string;
+    cardMonth: string;
+    cardCVV: string;
+    addressName: string;
+    addressZip: string;
+    currency: ValueOf<typeof CONST.CURRENCY>;
+    isP2PDebitCard: boolean;
+};
+export default AddPaymentCardParams;

src/libs/API/parameters/AddPersonalBankAccountParams.ts

@@ -0,0 +1,12 @@
+type AddPersonalBankAccountParams = {
+    addressName: string;
+    routingNumber: string;
+    accountNumber: string;
+    isSavings: boolean;
+    setupType: string;
+    bank?: string;
+    plaidAccountID: string;
+    plaidAccessToken: string;
+};
+
+export default AddPersonalBankAccountParams;

src/libs/API/parameters/AddSchoolPrincipalParams.ts

@@ -0,0 +1,9 @@
+type AddSchoolPrincipalParams = {
+    firstName: string;
+    lastName: string;
+    partnerUserID: string;
+    policyID: string;
+    reportCreationData: string;
+};
+
+export default AddSchoolPrincipalParams;

src/libs/API/parameters/AddWorkspaceRoomParams.ts

@@ -0,0 +1,15 @@
+import type {ValueOf} from 'type-fest';
+import type CONST from '@src/CONST';
+import type {WriteCapability} from '@src/types/onyx/Report';
+
+type AddWorkspaceRoomParams = {
+    reportID: string;
+    createdReportActionID: string;
+    policyID?: string;
+    reportName?: string;
+    visibility?: ValueOf<typeof CONST.REPORT.VISIBILITY>;
+    writeCapability?: WriteCapability;
+    welcomeMessage?: string;
+};
+
+export default AddWorkspaceRoomParams;

src/libs/API/parameters/AnswerQuestionsForWalletParams.ts

@@ -0,0 +1,6 @@
+type AnswerQuestionsForWalletParams = {
+    idologyAnswers: string;
+    idNumber: string;
+};
+
+export default AnswerQuestionsForWalletParams;

src/libs/API/parameters/AuthenticatePusherParams.ts

@@ -0,0 +1,10 @@
+type AuthenticatePusherParams = {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    socket_id: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    channel_name: string;
+    shouldRetry: boolean;
+    forceNetworkRequest: boolean;
+};
+
+export default AuthenticatePusherParams;

src/libs/API/parameters/BankAccountHandlePlaidErrorParams.ts

@@ -0,0 +1,7 @@
+type BankAccountHandlePlaidErrorParams = {
+    bankAccountID: number;
+    error: string;
+    errorDescription: string;
+    plaidRequestID: string;
+};
+export default BankAccountHandlePlaidErrorParams;

src/libs/API/parameters/BeginAppleSignInParams.ts

@@ -0,0 +1,9 @@
+import type {ValueOf} from 'type-fest';
+import type CONST from '@src/CONST';
+
+type BeginAppleSignInParams = {
+    idToken: string | undefined | null;
+    preferredLocale: ValueOf<typeof CONST.LOCALES> | null;
+};
+
+export default BeginAppleSignInParams;

src/libs/API/parameters/BeginGoogleSignInParams.ts

@@ -0,0 +1,9 @@
+import type {ValueOf} from 'type-fest';
+import type CONST from '@src/CONST';
+
+type BeginGoogleSignInParams = {
+    token: string | null;
+    preferredLocale: ValueOf<typeof CONST.LOCALES> | null;
+};
+
+export default BeginGoogleSignInParams;

src/libs/API/parameters/BeginSignInParams.ts

@@ -0,0 +1,5 @@
+type BeginSignInParams = {
+    email: string;
+};
+
+export default BeginSignInParams;

src/libs/API/parameters/CancelTaskParams.ts

@@ -0,0 +1,6 @@
+type CancelTaskParams = {
+    cancelledTaskReportActionID?: string;
+    taskReportID?: string;
+};
+
+export default CancelTaskParams;

src/libs/API/parameters/ChronosRemoveOOOEventParams.ts

@@ -0,0 +1,6 @@
+type ChronosRemoveOOOEventParams = {
+    googleEventID: string;
+    reportActionID: string;
+};
+
+export default ChronosRemoveOOOEventParams;

src/libs/API/parameters/CloseAccountParams.ts

@@ -0,0 +1,3 @@
+type CloseAccountParams = {message: string};
+
+export default CloseAccountParams;

src/libs/API/parameters/CompleteEngagementModalParams.ts

@@ -0,0 +1,10 @@
+type CompleteEngagementModalParams = {
+    reportID: string;
+    reportActionID?: string;
+    commentReportActionID?: string | null;
+    reportComment?: string;
+    engagementChoice: string;
+    timezone?: string;
+};
+
+export default CompleteEngagementModalParams;

src/libs/API/parameters/CompleteTaskParams.ts

@@ -0,0 +1,6 @@
+type CompleteTaskParams = {
+    taskReportID?: string;
+    completedTaskReportActionID?: string;
+};
+
+export default CompleteTaskParams;

src/libs/API/parameters/ConnectBankAccountManuallyParams.ts

@@ -0,0 +1,7 @@
+type ConnectBankAccountManuallyParams = {
+    bankAccountID: number;
+    accountNumber?: string;
+    routingNumber?: string;
+    plaidMask?: string;
+};
+export default ConnectBankAccountManuallyParams;

src/libs/API/parameters/ConnectBankAccountWithPlaidParams.ts

@@ -0,0 +1,10 @@
+type ConnectBankAccountWithPlaidParams = {
+    bankAccountID: number;
+    routingNumber: string;
+    accountNumber: string;
+    bank?: string;
+    plaidAccountID: string;
+    plaidAccessToken: string;
+};
+
+export default ConnectBankAccountWithPlaidParams;

src/libs/API/parameters/CreateTaskParams.ts

@@ -0,0 +1,15 @@
+type CreateTaskParams = {
+    parentReportActionID?: string;
+    parentReportID?: string;
+    taskReportID?: string;
+    createdTaskReportActionID?: string;
+    title?: string;
+    description?: string;
+    assignee?: string;
+    assigneeAccountID?: number;
+    assigneeChatReportID?: string;
+    assigneeChatReportActionID?: string;
+    assigneeChatCreatedReportActionID?: string;
+};
+
+export default CreateTaskParams;

src/libs/API/parameters/CreateWorkspaceFromIOUPaymentParams.ts

@@ -0,0 +1,20 @@
+type CreateWorkspaceFromIOUPaymentParams = {
+    policyID: string;
+    announceChatReportID: string;
+    adminsChatReportID: string;
+    expenseChatReportID: string;
+    ownerEmail: string;
+    makeMeAdmin: boolean;
+    policyName: string;
+    type: string;
+    announceCreatedReportActionID: string;
+    adminsCreatedReportActionID: string;
+    expenseCreatedReportActionID: string;
+    customUnitID: string;
+    customUnitRateID: string;
+    iouReportID: string;
+    memberData: string;
+    reportActionID: string;
+};
+
+export default CreateWorkspaceFromIOUPaymentParams;

src/libs/API/parameters/CreateWorkspaceParams.ts

@@ -0,0 +1,17 @@
+type CreateWorkspaceParams = {
+    policyID: string;
+    announceChatReportID: string;
+    adminsChatReportID: string;
+    expenseChatReportID: string;
+    ownerEmail: string;
+    makeMeAdmin: boolean;
+    policyName: string;
+    type: string;
+    announceCreatedReportActionID: string;
+    adminsCreatedReportActionID: string;
+    expenseCreatedReportActionID: string;
+    customUnitID: string;
+    customUnitRateID: string;
+};
+
+export default CreateWorkspaceParams;

src/libs/API/parameters/DeleteCommentParams.ts

@@ -0,0 +1,6 @@
+type DeleteCommentParams = {
+    reportID: string;
+    reportActionID: string;
+};
+
+export default DeleteCommentParams;

src/libs/API/parameters/DeleteContactMethodParams.ts

@@ -0,0 +1,3 @@
+type DeleteContactMethodParams = {partnerUserID: string};
+
+export default DeleteContactMethodParams;

src/libs/API/parameters/DeleteMembersFromWorkspaceParams.ts

@@ -0,0 +1,6 @@
+type DeleteMembersFromWorkspaceParams = {
+    emailList: string;
+    policyID: string;
+};
+
+export default DeleteMembersFromWorkspaceParams;

src/libs/API/parameters/DeletePaymentBankAccountParams.ts

@@ -0,0 +1,3 @@
+type DeletePaymentBankAccountParams = {bankAccountID: number};
+
+export default DeletePaymentBankAccountParams;

src/libs/API/parameters/DeletePaymentCardParams.ts

@@ -0,0 +1,4 @@
+type DeletePaymentCardParams = {
+    fundID: number;
+};
+export default DeletePaymentCardParams;

src/libs/API/parameters/DeleteWorkspaceAvatarParams.ts

@@ -0,0 +1,5 @@
+type DeleteWorkspaceAvatarParams = {
+    policyID: string;
+};
+
+export default DeleteWorkspaceAvatarParams;

src/libs/API/parameters/DeleteWorkspaceParams.ts

@@ -0,0 +1,5 @@
+type DeleteWorkspaceParams = {
+    policyID: string;
+};
+
+export default DeleteWorkspaceParams;

src/libs/API/parameters/EditTaskAssigneeParams.ts

@@ -0,0 +1,10 @@
+type EditTaskAssigneeParams = {
+    taskReportID?: string;
+    assignee?: string;
+    editedTaskReportActionID?: string;
+    assigneeChatReportID?: string;
+    assigneeChatReportActionID?: string;
+    assigneeChatCreatedReportActionID?: string;
+};
+
+export default EditTaskAssigneeParams;

src/libs/API/parameters/EditTaskParams.ts

@@ -0,0 +1,8 @@
+type EditTaskParams = {
+    taskReportID?: string;
+    title?: string;
+    description?: string;
+    editedTaskReportActionID?: string;
+};
+
+export default EditTaskParams;

src/libs/API/parameters/ExpandURLPreviewParams.ts

@@ -0,0 +1,6 @@
+type ExpandURLPreviewParams = {
+    reportID: string;
+    reportActionID: string;
+};
+
+export default ExpandURLPreviewParams;