Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 54 additions & 1 deletion ui-v2/src/api/block-documents/block-documents.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
buildGetBlockDocumentQuery,
buildListFilterBlockDocumentsQuery,
queryKeyFactory,
useCreateBlockDocument,
useDeleteBlockDocument,
useUpdateBlockDocument,
} from "./block-documents";
Expand Down Expand Up @@ -88,11 +89,63 @@ describe("block documents queries", () => {
expect(result.current.data).toEqual(1);
});

describe("useCreateDeployment", () => {
const mockCreateBlockDocumentAPI = (blockDocument: BlockDocument) => {
server.use(
http.post(buildApiUrl("/block_documents/"), () => {
return HttpResponse.json(blockDocument);
}),
);
};

it("invalidates cache and fetches updated value", async () => {
const mockBlockDocument = createFakeBlockDocument();
const newBlockDocumentBody = {
block_schema_id: mockBlockDocument.block_schema_id,
block_type_id: mockBlockDocument.block_type_id,
is_anonymous: false,
};
mockCreateBlockDocumentAPI(mockBlockDocument);
mockFilterListBlocksAPI([mockBlockDocument]);
const queryClient = new QueryClient();
const FILTER = {
offset: 0,
sort: "NAME_ASC" as const,
include_secrets: false,
};
queryClient.setQueryData(queryKeyFactory.listFilter(FILTER), []);

const { result: useListBlockDocumentsResult } = renderHook(
() => useSuspenseQuery(buildListFilterBlockDocumentsQuery(FILTER)),
{ wrapper: createWrapper({ queryClient }) },
);

const { result: useCreateBlockDocumentResult } = renderHook(
useCreateBlockDocument,
{ wrapper: createWrapper({ queryClient }) },
);

act(() =>
useCreateBlockDocumentResult.current.createBlockDocument(
newBlockDocumentBody,
),
);

await waitFor(() =>
expect(useCreateBlockDocumentResult.current.isSuccess).toBe(true),
);
expect(useListBlockDocumentsResult.current.data?.length).toEqual(1);
const newBlockDocument = useListBlockDocumentsResult.current.data?.find(
(blockDocument) => blockDocument.id === mockBlockDocument.id,
);
expect(newBlockDocument).toEqual(mockBlockDocument);
});
});

describe("useDeleteBlockDocument", () => {
it("invalidates cache and fetches updated value", async () => {
const mockBlockDocument = createFakeBlockDocument();
mockFilterListBlocksAPI([]);

const queryClient = new QueryClient();
const FILTER = {
offset: 0,
Expand Down
41 changes: 41 additions & 0 deletions ui-v2/src/api/block-documents/block-documents.ts
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,47 @@ export const useDeleteBlockDocument = () => {
return { deleteBlockDocument, ...rest };
};

/**
* Hook for creating a block document
*
* @returns Mutation object for creating a block document with loading/error states and trigger function
*
* @example
* ```ts
* const { createBlockDocument } = useCreateBlockDocument();
*
* // Update a block document by id
* createBlockDocument(newBlockDocument, {
* onSuccess: () => {
* // Handle successful update
* console.log('Block document created successfully');
* },
* onError: (error) => {
* // Handle error
* console.error('Failed to create block document:', error);
* }
* });
* ```
*/
export const useCreateBlockDocument = () => {
const queryClient = useQueryClient();

const { mutate: createBlockDocument, ...rest } = useMutation({
mutationFn: (body: components["schemas"]["BlockDocumentCreate"]) =>
getQueryService().POST("/block_documents/", { body }),
onSuccess: () => {
void queryClient.invalidateQueries({
queryKey: queryKeyFactory.lists(),
});
void queryClient.invalidateQueries({
queryKey: queryKeyFactory.counts(),
});
},
});

return { createBlockDocument, ...rest };
};

type UseUpdateBlockDocument = {
id: string;
} & components["schemas"]["BlockDocumentUpdate"];
Expand Down
1 change: 1 addition & 0 deletions ui-v2/src/api/block-documents/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export {
buildCountAllBlockDocumentsQuery,
buildCountFilterBlockDocumentsQuery,
buildGetBlockDocumentQuery,
useCreateBlockDocument,
useDeleteBlockDocument,
useUpdateBlockDocument,
} from "./block-documents";