api-keys.service.ts•4.16 kB
/*
* Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
* http://github.com/fonoster/fonoster
*
* This file is part of Fonoster
*
* Licensed under the MIT License (the "License");
* you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://opensource.org/licenses/MIT
*
* 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 {
type CreateApiKeyRequest as ResourceCreateRequest,
type ListApiKeysRequest as ResourceListRequest
} from "@fonoster/types";
import { type ApiKey as Resource } from "./api-keys.interfaces";
import { useQuery } from "@tanstack/react-query";
import { useOptimisticCreateResource } from "~/core/hooks/use-optimistic-create-resource";
import { useOptimisticDeleteResource } from "~/core/hooks/use-optimistic-delete-resource";
import { useFonoster } from "~/core/sdk/hooks/use-fonoster";
import { useWorkspaceId } from "~/workspaces/hooks/use-workspace-id";
/**
* Constant query key used to cache and track the list of apiKeys.
* Should be used consistently to avoid query duplication and cache mismatch.
*/
export const COLLECTION_QUERY_KEY = ["collection:api_keys"];
/**
* Constant query key prefix used to cache and track individual apiKey resources.
* Should be combined with a specific apiKey reference (ID).
*/
export const RESOURCE_QUERY_KEY = ["resource:api_key"];
/**
* Hook to fetch the list of apiKeys using the Fonoster SDK.
*
* This hook uses React Query's `useQuery` to:
* - Fetch the apiKey list from the backend.
* - Automatically manage loading and error states.
* - Cache the data for performance and offline support.
*
* @param params - Optional parameters to filter or paginate the list of apiKeys.
* @returns A React Query object containing apiKey data and query metadata.
*/
export const useApiKeys = (params?: ResourceListRequest) => {
const { sdk } = useFonoster();
const workspaceId = useWorkspaceId();
const { data, ...rest } = useQuery({
queryKey: [...COLLECTION_QUERY_KEY, workspaceId, params],
queryFn: async () => await sdk.apiKeys.listApiKeys({ ...params })
});
return {
data: data?.items || [],
nextPageToken: data?.nextPageToken,
...rest
};
};
/**
* Hook to create a new apiKey using the Fonoster SDK with optimistic UI updates.
*
* Internally uses a custom `useOptimisticCreateResource` hook which:
* - Adds the new apiKey to the cache optimistically (before server confirmation).
* - Rolls back changes on error.
* - Replaces temporary data with server-confirmed data on success.
* - Invalidates the apiKey list to refresh from the server.
*
* @returns A mutation object that can be used to trigger the creation.
*/
export const useCreateApiKey = () => {
const { sdk } = useFonoster();
const workspaceId = useWorkspaceId();
const COLLECTION_KEY = [...COLLECTION_QUERY_KEY, workspaceId];
const RESOURCE_KEY = [...RESOURCE_QUERY_KEY, workspaceId];
return useOptimisticCreateResource<Resource, ResourceCreateRequest>(
(req) => sdk.apiKeys.createApiKey(req),
COLLECTION_KEY,
RESOURCE_KEY
);
};
/**
* Hook to delete an apiKey by reference using the Fonoster SDK with optimistic cache updates.
*
* Internally uses `useOptimisticDeleteResource`, which:
* - Removes the apiKey from the cache before server confirmation.
* - Restores it if the deletion fails.
* - Invalidates relevant queries on completion to re-sync data.
*
* @returns A mutation object for deleting an apiKey.
*/
export const useDeleteApiKey = () => {
const { sdk } = useFonoster();
const workspaceId = useWorkspaceId();
const COLLECTION_KEY = [...COLLECTION_QUERY_KEY, workspaceId];
const RESOURCE_KEY = [...RESOURCE_QUERY_KEY, workspaceId];
return useOptimisticDeleteResource(
(ref) => sdk.apiKeys.deleteApiKey(ref),
COLLECTION_KEY,
RESOURCE_KEY
);
};