123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151 |
- import type {Client} from 'sentry/api';
- import {ApiQueryKey, useApiQuery, UseApiQueryOptions} from 'sentry/utils/queryClient';
- type PromptsUpdateParams = {
- /**
- * The prompt feature name
- */
- feature: string;
- /**
- * The numeric organization ID as a string
- */
- organizationId: string;
- status: 'snoozed' | 'dismissed';
- /**
- * The numeric project ID as a string
- */
- projectId?: string;
- };
- /**
- * Update the status of a prompt
- */
- export function promptsUpdate(api: Client, params: PromptsUpdateParams) {
- return api.requestPromise('/prompts-activity/', {
- method: 'PUT',
- data: {
- organization_id: params.organizationId,
- project_id: params.projectId,
- feature: params.feature,
- status: params.status,
- },
- });
- }
- type PromptCheckParams = {
- /**
- * The prompt feature name
- */
- feature: string;
- /**
- * The numeric organization ID as a string
- */
- organizationId: string;
- /**
- * The numeric project ID as a string
- */
- projectId?: string;
- };
- export type PromptResponseItem = {
- dismissed_ts?: number;
- snoozed_ts?: number;
- };
- export type PromptResponse = {
- data?: PromptResponseItem;
- features?: {[key: string]: PromptResponseItem};
- };
- export type PromptData = null | {
- dismissedTime?: number;
- snoozedTime?: number;
- };
- /**
- * Get the status of a prompt
- */
- export async function promptsCheck(
- api: Client,
- params: PromptCheckParams
- ): Promise<PromptData> {
- const query = {
- feature: params.feature,
- organization_id: params.organizationId,
- ...(params.projectId === undefined ? {} : {project_id: params.projectId}),
- };
- const response: PromptResponse = await api.requestPromise('/prompts-activity/', {
- query,
- });
- if (response?.data) {
- return {
- dismissedTime: response.data.dismissed_ts,
- snoozedTime: response.data.snoozed_ts,
- };
- }
- return null;
- }
- export const makePromptsCheckQueryKey = ({
- feature,
- organizationId,
- projectId,
- }: PromptCheckParams): ApiQueryKey => [
- '/prompts-activity/',
- {query: {feature, organization_id: organizationId, project_id: projectId}},
- ];
- /**
- * @param organizationId org numerical id, not the slug
- */
- export function usePromptsCheck(
- {feature, organizationId, projectId}: PromptCheckParams,
- options: Partial<UseApiQueryOptions<PromptResponse>> = {}
- ) {
- return useApiQuery<PromptResponse>(
- makePromptsCheckQueryKey({feature, organizationId, projectId}),
- {
- staleTime: 120000,
- ...options,
- }
- );
- }
- /**
- * Get the status of many prompt
- */
- export async function batchedPromptsCheck<T extends readonly string[]>(
- api: Client,
- features: T,
- params: {organizationId: string; projectId?: string}
- ): Promise<{[key in T[number]]: PromptData}> {
- const query = {
- feature: features,
- organization_id: params.organizationId,
- ...(params.projectId === undefined ? {} : {project_id: params.projectId}),
- };
- const response: PromptResponse = await api.requestPromise('/prompts-activity/', {
- query,
- });
- const responseFeatures = response?.features;
- const result: {[key in T[number]]?: PromptData} = {};
- if (!responseFeatures) {
- return result as {[key in T[number]]: PromptData};
- }
- for (const featureName of features) {
- const item = responseFeatures[featureName];
- if (item) {
- result[featureName] = {
- dismissedTime: item.dismissed_ts,
- snoozedTime: item.snoozed_ts,
- };
- } else {
- result[featureName] = null;
- }
- }
- return result as {[key in T[number]]: PromptData};
- }
|