generated from openedx/frontend-template-application
-
Notifications
You must be signed in to change notification settings - Fork 2
feat: PlanDetails page now uses a StatefulButton and creates a CheckoutIntent #60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
src/components/app/data/hooks/useCreateCheckoutIntentMutation.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
import { useMutation, UseMutationOptions } from '@tanstack/react-query'; | ||
|
||
import createCheckoutIntent from '@/components/app/data/services/checkout-intent'; | ||
|
||
import type { AxiosError, AxiosResponse } from 'axios'; | ||
|
||
interface UseCreateCheckoutIntentMutationProps extends Omit< | ||
UseMutationOptions< | ||
AxiosResponse<CreateCheckoutIntentSuccessResponseSchema>, | ||
AxiosError<CreateCheckoutIntentErrorResponseSchema>, | ||
CreateCheckoutIntentRequestSchema | ||
>, | ||
'mutationFn' | 'onSuccess' | 'onError' | ||
> { | ||
onSuccess?: (data: CreateCheckoutIntentSuccessResponseSchema) => void; | ||
onError?: (errorData: CreateCheckoutIntentErrorResponseSchema | undefined) => void; | ||
} | ||
|
||
export default function useCreateCheckoutIntentMutation({ | ||
onSuccess, | ||
onError, | ||
...mutationConfig | ||
}: UseCreateCheckoutIntentMutationProps = {}) { | ||
return useMutation< | ||
AxiosResponse<CreateCheckoutIntentSuccessResponseSchema>, | ||
AxiosError<CreateCheckoutIntentErrorResponseSchema>, | ||
CreateCheckoutIntentRequestSchema | ||
>({ | ||
mutationFn: (requestData) => createCheckoutIntent(requestData), | ||
onSuccess: (axiosResponse) => { | ||
onSuccess?.(axiosResponse.data); | ||
}, | ||
onError: (axiosError) => { | ||
onError?.(axiosError.response?.data); | ||
}, | ||
...mutationConfig, | ||
}); | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth'; | ||
import { getConfig } from '@edx/frontend-platform/config'; | ||
import { camelCaseObject, snakeCaseObject } from '@edx/frontend-platform/utils'; | ||
import axios, { AxiosResponse } from 'axios'; | ||
|
||
/** | ||
* Types for creating a CheckoutIntent. | ||
* These are intentionally minimal for the current usage (Plan Details step). | ||
* Extend as needed if additional writable fields are later required. | ||
*/ | ||
declare global { | ||
/** | ||
* Writable request subset for creating a CheckoutIntent. | ||
* (Backend serializer may accept additional fields; include as needed.) | ||
*/ | ||
interface CreateCheckoutIntentRequestSchema { | ||
quantity: number; | ||
enterpriseName?: string; | ||
enterpriseSlug?: string; | ||
country?: string; | ||
termsMetadata?: Record<string, any>; | ||
} | ||
|
||
/** | ||
* Success response (shape based on CheckoutIntentCreateRequest / Read serializer). | ||
* We keep it loose but strongly typed for known fields we might use. | ||
*/ | ||
interface CreateCheckoutIntentSuccessResponseSchema { | ||
id: number; | ||
state: string; | ||
quantity: number; | ||
enterpriseName?: string; | ||
enterpriseSlug?: string; | ||
stripeCheckoutSessionId?: string | null; | ||
expiresAt?: string; | ||
created?: string; | ||
modified?: string; | ||
// Add any other fields returned by backend as needed | ||
[key: string]: any; | ||
} | ||
|
||
type CreateCheckoutIntentErrorResponseSchema = Record<string, unknown>; | ||
|
||
type CreateCheckoutIntentRequestPayload = Payload<CreateCheckoutIntentRequestSchema>; | ||
type CreateCheckoutIntentSuccessResponsePayload = Payload<CreateCheckoutIntentSuccessResponseSchema>; | ||
type CreateCheckoutIntentErrorResponsePayload = Payload<CreateCheckoutIntentErrorResponseSchema>; | ||
} | ||
|
||
const camelCaseResponse = ( | ||
data: CreateCheckoutIntentSuccessResponsePayload | CreateCheckoutIntentErrorResponsePayload, | ||
) => camelCaseObject(data); | ||
|
||
/** | ||
* createCheckoutIntent | ||
* POST /api/v1/checkout-intent/ | ||
* | ||
* Only callable for an authenticated user. | ||
*/ | ||
export default async function createCheckoutIntent( | ||
requestData: CreateCheckoutIntentRequestSchema, | ||
): Promise<AxiosResponse<CreateCheckoutIntentSuccessResponseSchema>> { | ||
const { ENTERPRISE_ACCESS_BASE_URL } = getConfig(); | ||
const url = `${ENTERPRISE_ACCESS_BASE_URL}/api/v1/checkout-intent/`; | ||
const requestPayload: CreateCheckoutIntentRequestPayload = snakeCaseObject(requestData); | ||
|
||
const requestConfig = { | ||
// Preserve default transforms plus our camelCase transform. | ||
// @ts-ignore(TS2339) | ||
transformResponse: axios.defaults.transformResponse!.concat(camelCaseResponse), | ||
pwnage101 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
}; | ||
pwnage101 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
const response: AxiosResponse<CreateCheckoutIntentSuccessResponseSchema> = await getAuthenticatedHttpClient() | ||
.post<CreateCheckoutIntentSuccessResponsePayload>(url, requestPayload, requestConfig); | ||
|
||
return response; | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using @ts-ignore suppresses TypeScript errors and should be avoided. Consider properly typing the transformResponse property or using a type assertion with proper typing instead.
Copilot uses AI. Check for mistakes.