import {z} from 'zod' export type GetImpactDashboardOptions = {changeIds?: Array | undefined, viewInCurrency?: string | undefined, includeCollaborators?: boolean | undefined, isCollabicientView: boolean, scenarioIds?: Array | undefined}; export type CreateApiV1OrgOrgIdCompReviewCompReviewIdImpactDashboardArgs = {orgId: string, compReviewId: string, viewJobId?: string | undefined, preview?: boolean | undefined, includeAllRequests?: boolean | undefined, body: GetImpactDashboardOptions}; export type CreateApiV1OrgOrgIdCompReviewCompReviewIdImpactDashboardOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const money = z.object({amount: z.number(), currency: z.string(), places: z.number().int().optional()}); export const kpiCostImpact = z.object({preCycle: money, postCycle: money, deltaValue: money, deltaPercentage: z.number()}); export const kpiEmployeesImpacted = z.object({impactedCount: z.number().int(), eligibleCount: z.number().int(), impactedPercentage: z.number()}); export const kpiBudgetUtilization = z.object({used: money, allocated: money, remaining: money, usedPercentage: z.number()}); export const kpiGuidelineDeviation = z.object({deviationCount: z.number().int(), potentialCount: z.number().int(), deviationPercentage: z.number()}); export const impactDashboardKpiPayload = z.object({costImpact: kpiCostImpact, employeesImpacted: kpiEmployeesImpacted, budgetUtilization: kpiBudgetUtilization.optional(), guidelineDeviations: kpiGuidelineDeviation.optional()}); export const waterfallBarBreakdown = z.object({label: z.string(), value: money}); export const waterfallBar = z.object({label: z.string(), value: money, kind: z.enum(["PRE_CYCLE_TOTAL", "POST_CYCLE_TOTAL", "DELTA"]), breakdown: z.array(waterfallBarBreakdown).optional(), preCycleDefinition: z.string().optional(), postCycleDefinition: z.string().optional()}); export const impactDashboardWaterfallPayload = z.object({byType: z.array(waterfallBar), byBudgetPool: z.array(waterfallBar)}); export const budgetPoolSummaryRow = z.object({budgetPoolId: z.string(), label: z.string(), allocated: z.object({}), used: z.object({}), remaining: z.object({}), utilizationPercentage: z.number()}); export const budgetPoolTotalsRow = z.object({allocated: money, used: money, remaining: money, utilizationPercentage: z.number()}); export const impactDashboardBudgetPoolsPayload = z.object({pools: z.array(budgetPoolSummaryRow), currencyTotal: budgetPoolTotalsRow.optional()}); export const impactDashboardPivotDimension = z.object({key: z.string(), fieldCode: z.string().optional(), syntheticKind: z.literal("REVIEWER").optional()}); export const impactDashboardPivotChangeRow = z.object({changeId: z.string(), jobId: z.string(), groupByValues: z.record(z.string(), z.object({})), preCycleSpend: money, postCycleSpend: money, delta: money, isPromotion: z.boolean()}); export const impactDashboardPivotPayload = z.object({groupByOptions: z.array(impactDashboardPivotDimension), showPromotionsColumn: z.boolean(), changes: z.array(impactDashboardPivotChangeRow)}); export const compReviewImpactDashboardResponse = z.object({kpi: impactDashboardKpiPayload, waterfall: impactDashboardWaterfallPayload, budgetPools: impactDashboardBudgetPoolsPayload, pivot: impactDashboardPivotPayload.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get the aggregated Impact Dashboard payload for a comp review * * POST /v1/org/{orgId}/comp-review/{compReviewId}/impact-dashboard */ export const createApiV1OrgOrgIdCompReviewCompReviewIdImpactDashboard = async (args: CreateApiV1OrgOrgIdCompReviewCompReviewIdImpactDashboardArgs, options?: CreateApiV1OrgOrgIdCompReviewCompReviewIdImpactDashboardOptions) => { const {baseUrl = "https://localhost", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.viewJobId != null) query.append("viewJobId", String(args.viewJobId)) if (args.preview != null) query.append("preview", String(args.preview)) if (args.includeAllRequests != null) query.append("includeAllRequests", String(args.includeAllRequests)) const url = `${baseUrl.replace(/\/+$/, '')}/v1/org/${encodeURIComponent(String(args.orgId))}/comp-review/${encodeURIComponent(String(args.compReviewId))}/impact-dashboard${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(compReviewImpactDashboardResponse, await res.json()) };