useCodingTask reference

Learn more about the useCodingTask hook.

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 /* * Copyright 2025 Palantir Technologies, Inc. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { useCallback, useEffect, useState } from "react"; import useSWR from "swr"; import { useOsdkClient } from "@osdk/react"; import { ITask } from "./useTasks"; import { osdkCodingTask } from "@avanced-to-do-application/sdk"; import type { User } from "@osdk/foundry.admin"; import type { ObjectMetadata } from "@osdk/client"; interface CodingTaskEnriched { osdkCodingTask: osdkCodingTask.OsdkInstance; createdBy: User; assignedTo: User; } function useCodingTask(task: ITask) { const client = useOsdkClient(); const [metadata, setMetadata] = useState<ObjectMetadata>(); // Define the fetcher using useCallback. const fetcher = useCallback(async () => { // We are using $as to pivot to the osdkCodingTask interface implementation. // Note that this is possible because we used `$includeAllBaseObjectProperties: true` when fetching the task in useTasks. const codingTask: osdkCodingTask.OsdkInstance = task.osdkTask.$as(osdkCodingTask); const codingTaskEnriched: CodingTaskEnriched = { osdkCodingTask: codingTask, createdBy: task.createdBy, assignedTo: task.assignedTo, }; return codingTaskEnriched; }, [task]); // Only pass the fetcher if the data is not already cached. const { data, error, isValidating } = useSWR<CodingTaskEnriched>( task.osdkTask.$primaryKey as string, fetcher, { revalidateOnFocus: false, revalidateOnReconnect: false, } ); // This shows how we read the object type metadata and use the property display name from the ontology. const getObjectTypeMetadata = useCallback(async () => { const objectTypeMetadata = await client.fetchMetadata(osdkCodingTask); setMetadata(objectTypeMetadata); }, [client]); useEffect(() => { getObjectTypeMetadata(); }, [getObjectTypeMetadata]); return { codingTask: data, isLoading: !data && !error, isValidating, isError: error, metadata, }; } export default useCodingTask;