import {z} from 'zod' export type GetApiV1IndexesIndexForecastArgs = {index: string}; export type GetApiV1IndexesIndexForecastOptions = {baseUrl?: string | undefined, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const indexForecastRuleDto = z.object({code: z.string().nullable().optional(), label: z.string().nullable().optional(), outcome: z.string().nullable().optional(), requirement: z.string().nullable().optional(), observed: z.string().nullable().optional()}); export const indexForecastCandidateDto = z.object({rank: z.number().int().optional(), ticker: z.string().nullable().optional(), name: z.string().nullable().optional(), isLinked: z.boolean().optional(), rankingValueUsd: z.number().nullable().optional(), probability: z.number().nullable().optional(), isMigration: z.boolean().optional(), indexFundOwnership: z.number().nullable().optional(), memberMedianIndexFundOwnership: z.number().nullable().optional(), passiveDemandShares: z.number().int().nullable().optional(), passiveDemandUsd: z.number().nullable().optional(), passiveDemandDaysOfVolume: z.number().nullable().optional(), fundOwnershipAsOf: z.string().nullable().optional(), rules: z.array(indexForecastRuleDto).nullable().optional()}); export const indexForecastBucketDto = z.object({title: z.string().nullable().optional(), note: z.string().nullable().optional(), count: z.number().int().optional(), rows: z.array(indexForecastCandidateDto).nullable().optional()}); export const indexForecastResponse = z.object({slug: z.string().nullable().optional(), name: z.string().nullable().optional(), kind: z.string().nullable().optional(), headline: z.string().nullable().optional(), asOfDate: z.string().optional(), methodologySource: z.string().nullable().optional(), methodologyVersion: z.string().nullable().optional(), probabilityHorizonDays: z.number().int().nullable().optional(), probabilityModelVersion: z.string().nullable().optional(), probabilitySource: z.string().nullable().optional(), probabilitySourceUrl: z.string().nullable().optional(), exitCalibrationSource: z.string().nullable().optional(), exitCalibrationSourceUrl: z.string().nullable().optional(), exitCalibrationMethod: z.string().nullable().optional(), scoredCount: z.number().int().optional(), unmeasuredMemberCount: z.number().int().optional(), candidatesLocked: z.boolean().optional(), upgradeUrl: z.string().nullable().optional(), additions: indexForecastBucketDto.optional(), migrations: indexForecastBucketDto.optional(), departures: indexForecastBucketDto.optional(), notEvaluated: indexForecastBucketDto.optional(), limitations: z.array(z.string()).nullable().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 }; /** * An index's own published entry rules applied to every company we track, with a rule-by-rule scorecard behind each company. The S&P 500 adds a versioned probability over probabilityHorizonDays for each eligible join candidate and every current member exit. kind is "Screen" for the S&P indexes, whose additions a committee decides, and "Projection" for the Russell indexes and Nasdaq-100, whose membership a published ranking decides. Each model revision is immutable; a model-version change may append a higher revision for the same trading day, and readers use the highest revision. * * GET /v1/indexes/{index}/forecast */ export const getApiV1IndexesIndexForecast = async (args: GetApiV1IndexesIndexForecastArgs, options?: GetApiV1IndexesIndexForecastOptions) => { const {baseUrl = "https://api.equibles.com", fetch: fetchFn = fetch, ApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKey !== undefined) headers.set('authorization', `Bearer ${ApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/indexes/${encodeURIComponent(String(args.index))}/forecast${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(indexForecastResponse, await res.json()) };