import {z} from 'zod' export type GetApiV3CorrelationsArgs = {causeVariableName?: string | undefined, effectVariableName?: string | undefined, causeVariableId?: number | undefined, effectVariableId?: number | undefined, predictorVariableName?: string | undefined, outcomeVariableName?: string | undefined, sort?: string | undefined, limit?: number | undefined, offset?: number | undefined, userId?: number | undefined, correlationCoefficient?: string | undefined, updatedAt?: string | undefined, outcomesOfInterest?: boolean | undefined, clientId?: string | undefined, commonOnly?: boolean | undefined}; export type GetApiV3CorrelationsOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const button = z.object({accessibilityText: z.string().optional(), action: z.object({}).optional(), additionalInformation: z.string().optional(), color: z.string().optional(), confirmationText: z.string().optional(), functionName: z.string().optional(), parameters: z.object({}).optional(), html: z.string().optional(), id: z.string().optional(), image: z.string().optional(), ionIcon: z.string().optional(), link: z.string(), stateName: z.string().optional(), stateParams: z.object({}).optional(), successToastText: z.string().optional(), successAlertTitle: z.string().optional(), successAlertBody: z.string().optional(), text: z.string(), tooltip: z.string().optional(), webhookUrl: z.string().optional()}); export const inputField = z.object({displayName: z.string(), helpText: z.string().optional(), hint: z.string().optional(), icon: z.string().optional(), id: z.string().optional(), image: z.string().optional(), key: z.string().optional(), labelLeft: z.string().optional(), labelRight: z.string().optional(), link: z.string().optional(), maxLength: z.number().int().optional(), maxValue: z.number().optional(), minLength: z.number().int().optional(), minValue: z.number().optional(), options: z.array(z.string()).optional(), placeholder: z.string().optional(), postUrl: z.string().optional(), required: z.boolean().optional(), show: z.boolean().optional(), submitButton: button.optional(), type: z.enum(["check_box", "date", "email", "number", "postal_code", "select_option", "string", "switch", "text_area", "unit", "variable_category"]), validationPattern: z.string().optional(), value: z.string().optional()}); export const card: z.ZodType = z.object({actionSheetButtons: z.array(button).optional(), avatar: z.string().optional(), avatarCircular: z.string().optional(), backgroundColor: z.string().optional(), buttons: z.array(button).optional(), buttonsSecondary: z.array(button).optional(), content: z.string().optional(), headerTitle: z.string().optional(), html: z.string().optional(), htmlContent: z.string().optional(), id: z.string(), image: z.string().optional(), inputFields: z.array(inputField).optional(), ionIcon: z.string().optional(), link: z.string().optional(), parameters: z.object({}).optional(), relatedCards: z.array(z.lazy(() => card)).optional(), selectedButton: button.optional(), sharingBody: z.string().optional(), sharingButtons: z.array(button).optional(), sharingTitle: z.string().optional(), subHeader: z.string().optional(), subTitle: z.string().optional(), title: z.string().optional()}); export const connectInstructions = z.object({parameters: z.array(z.object({})).optional(), url: z.string(), usePopup: z.boolean().optional()}); export const dataSource = z.object({affiliate: z.boolean(), backgroundColor: z.string().optional(), buttons: z.array(button).optional(), card: card.optional(), clientId: z.string().optional(), connected: z.boolean().optional(), connectError: z.string().optional(), connectInstructions: connectInstructions.optional(), connectorId: z.number().int().optional(), connectStatus: z.string().optional(), count: z.number().int().optional(), createdAt: z.string().optional(), connectorClientId: z.string(), defaultVariableCategoryName: z.string(), displayName: z.string(), enabled: z.number().int(), getItUrl: z.string(), id: z.number().int(), image: z.string(), imageHtml: z.string(), lastSuccessfulUpdatedAt: z.string().optional(), lastUpdate: z.number().int().optional(), linkedDisplayNameHtml: z.string(), longDescription: z.string(), message: z.string().optional(), mobileConnectMethod: z.string().optional(), name: z.string(), platforms: z.array(z.string()).optional(), premium: z.boolean().optional(), scopes: z.array(z.string()).optional(), shortDescription: z.string(), spreadsheetUploadLink: z.string().optional(), totalMeasurementsInLastUpdate: z.number().int().optional(), updatedAt: z.string().optional(), updateRequestedAt: z.string().optional(), updateStatus: z.string().optional(), userId: z.number().int().optional()}); export const studyHtml = z.object({chartHtml: z.string(), downloadButtonsHtml: z.string().optional(), fullPageWithHead: z.string().optional(), fullStudyHtml: z.string(), fullStudyHtmlWithCssStyles: z.string().optional(), participantInstructionsHtml: z.string().optional(), statisticsTableHtml: z.string().optional(), studyAbstractHtml: z.string().optional(), studyHeaderHtml: z.string().optional(), studyImageHtml: z.string().optional(), studyMetaHtml: z.string().optional(), studyTextHtml: z.string().optional(), socialSharingButtonHtml: z.string().optional(), studySummaryBoxHtml: z.string().optional()}); export const studyImages = z.object({causeVariableImageUrl: z.string().optional(), causeVariableIonIcon: z.string().optional(), effectVariableImageUrl: z.string().optional(), effectVariableIonIcon: z.string().optional(), gaugeImage: z.string(), gaugeImageSquare: z.string(), gaugeSharingImageUrl: z.string().optional(), imageUrl: z.string(), robotSharingImageUrl: z.string().optional(), avatar: z.string().optional()}); export const studyLinks = z.object({studyJoinLink: z.string().optional(), studyLinkEmail: z.string(), studyLinkFacebook: z.string(), studyLinkGoogle: z.string(), studyLinkStatic: z.string(), studyLinkDynamic: z.string(), studyLinkTwitter: z.string()}); export const studyText = z.object({averageEffectFollowingHighCauseExplanation: z.string().optional(), averageEffectFollowingLowCauseExplanation: z.string().optional(), valuePredictingHighOutcomeExplanation: z.string().optional(), valuePredictingLowOutcomeExplanation: z.string().optional(), dataAnalysis: z.string().optional(), dataSources: z.string().optional(), dataSourcesParagraphForCause: z.string().optional(), dataSourcesParagraphForEffect: z.string().optional(), lastCauseDailyValueSentenceExtended: z.string().optional(), lastCauseAndOptimalValueSentence: z.string().optional(), lastCauseDailyValueSentence: z.string().optional(), optimalDailyValueSentence: z.string().optional(), participantInstructions: z.string().optional(), predictorExplanation: z.string().optional(), significanceExplanation: z.string().optional(), studyAbstract: z.string(), studyDesign: z.string(), studyLimitations: z.string(), studyObjective: z.string(), studyResults: z.string(), studyTitle: z.string(), studyInvitation: z.string().optional(), studyQuestion: z.string().optional(), studyBackground: z.string().optional()}); export const correlation: z.ZodType = z.object({averageDailyHighCause: z.number().optional(), averageDailyLowCause: z.number().optional(), averageEffect: z.number().optional(), averageEffectFollowingHighCause: z.number().optional(), averageEffectFollowingLowCause: z.number().optional(), averageForwardPearsonCorrelationOverOnsetDelays: z.number().optional(), averageReversePearsonCorrelationOverOnsetDelays: z.number().optional(), averageVote: z.number().optional(), causeChanges: z.number().int().optional(), causeDataSource: dataSource.optional(), causeUserVariableShareUserMeasurements: z.number().int().optional(), causeVariableCategoryId: z.number().int().optional(), causeVariableCategoryName: z.string().optional(), causeVariableCombinationOperation: z.string().optional(), causeVariableUnitAbbreviatedName: z.string().optional(), causeVariableId: z.number().int().optional(), causeVariableMostCommonConnectorId: z.number().int().optional(), causeVariableName: z.string(), confidenceInterval: z.number().optional(), confidenceLevel: z.string().optional(), correlationCoefficient: z.number().optional(), correlationIsContradictoryToOptimalValues: z.boolean().optional(), createdAt: z.string().optional(), criticalTValue: z.number().optional(), direction: z.string().optional(), durationOfAction: z.number().int().optional(), durationOfActionInHours: z.number().optional(), degreesOfFreedom: z.number().int().optional(), effectNumberOfProcessedDailyMeasurements: z.number().int().optional(), error: z.string().optional(), effectChanges: z.number().int().optional(), effectDataSource: dataSource.optional(), effectSize: z.string().optional(), effectUnit: z.string().optional(), effectUserVariableShareUserMeasurements: z.number().int().optional(), effectVariableCategoryId: z.number().int().optional(), effectVariableCategoryName: z.string().optional(), effectVariableCombinationOperation: z.string().optional(), effectVariableCommonAlias: z.string().optional(), effectVariableUnitAbbreviatedName: z.string().optional(), effectVariableUnitId: z.number().int().optional(), effectVariableUnitName: z.string().optional(), effectVariableId: z.number().int().optional(), effectVariableMostCommonConnectorId: z.number().int().optional(), effectVariableName: z.string(), experimentEndTime: z.string().optional(), experimentStartTime: z.string().optional(), forwardSpearmanCorrelationCoefficient: z.number().optional(), numberOfPairs: z.number().int().optional(), onsetDelay: z.number().int().optional(), onsetDelayInHours: z.number().optional(), onsetDelayWithStrongestPearsonCorrelation: z.number().int().optional(), onsetDelayWithStrongestPearsonCorrelationInHours: z.number().optional(), optimalPearsonProduct: z.number().optional(), outcomeFillingValue: z.number().int().optional(), outcomeMaximumAllowedValue: z.number().optional(), outcomeMinimumAllowedValue: z.number().optional(), pearsonCorrelationWithNoOnsetDelay: z.number().optional(), predictivePearsonCorrelation: z.number().optional(), predictivePearsonCorrelationCoefficient: z.number().optional(), predictorDataSources: z.string().optional(), predictorFillingValue: z.number().int().optional(), predictorMaximumAllowedValue: z.number().optional(), predictorMinimumAllowedValue: z.number().optional(), predictsHighEffectChange: z.number().int().optional(), predictsLowEffectChange: z.number().int().optional(), pValue: z.number().optional(), qmScore: z.number().optional(), reversePearsonCorrelationCoefficient: z.number().optional(), shareUserMeasurements: z.boolean().optional(), sharingDescription: z.string().optional(), sharingTitle: z.string().optional(), significantDifference: z.boolean().optional(), statisticalSignificance: z.number().optional(), strengthLevel: z.string().optional(), strongestPearsonCorrelationCoefficient: z.number().optional(), studyHtml: studyHtml.optional(), studyImages: studyImages.optional(), studyLinks: studyLinks.optional(), studyText: studyText.optional(), tValue: z.number().optional(), updatedAt: z.string().optional(), userId: z.number().int().optional(), userVote: z.number().int().optional(), valuePredictingHighOutcome: z.number().optional(), valuePredictingLowOutcome: z.number().optional(), outcomeDataSources: z.string().optional(), principalInvestigator: z.string().optional(), reverseCorrelation: z.number().optional(), averagePearsonCorrelationCoefficientOverOnsetDelays: z.number().optional(), causeNumberOfRawMeasurements: z.number().int().optional(), correlationsOverDurationsOfAction: z.array(z.lazy(() => correlation)).optional(), correlationsOverOnsetDelays: z.array(z.lazy(() => correlation)).optional(), correlationsOverDurationsOfActionChartConfig: z.object({}).optional(), correlationsOverOnsetDelaysChartConfig: z.object({}).optional(), numberOfUsers: z.number().optional(), rawCauseMeasurementSignificance: z.number().optional(), rawEffectMeasurementSignificance: z.number().optional(), reversePairsCount: z.string().optional(), voteStatisticalSignificance: z.number().int().optional(), aggregateQMScore: z.number().optional(), forwardPearsonCorrelationCoefficient: z.number().optional(), numberOfCorrelations: z.number().int().optional(), vote: z.number().optional()}); export const image = z.object({height: z.string(), imageUrl: z.string(), width: z.string()}); export const explanationStartTracking = z.object({button: button, description: z.string(), title: z.string()}); export const explanation = z.object({description: z.string(), image: image, ionIcon: z.string(), startTracking: explanationStartTracking, title: z.string(), html: z.string().optional()}); export const error = z.object({message: z.string()}); export const getCorrelationsDataResponse = z.object({correlations: z.array(correlation), explanation: explanation, description: z.string().optional(), summary: z.string().optional(), errors: z.array(error).optional(), status: z.string().optional(), success: z.boolean().optional(), code: z.number().optional(), link: z.string().optional(), card: card.optional()}); export const getCorrelationsResponse = z.object({data: getCorrelationsDataResponse.optional(), description: z.string(), summary: z.string(), avatar: z.string().optional(), errors: z.array(error).optional(), status: z.string().optional(), success: z.boolean().optional(), code: z.number().optional(), link: z.string().optional(), card: card.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 correlations * * GET /v3/correlations * * Also accepts auth: curedao_oauth2 */ export const getApiV3Correlations = async (args: GetApiV3CorrelationsArgs, options?: GetApiV3CorrelationsOptions) => { const {baseUrl = "https://app.quantimo.do/api", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.causeVariableName != null) query.append("causeVariableName", String(args.causeVariableName)) if (args.effectVariableName != null) query.append("effectVariableName", String(args.effectVariableName)) if (args.causeVariableId != null) query.append("causeVariableId", String(args.causeVariableId)) if (args.effectVariableId != null) query.append("effectVariableId", String(args.effectVariableId)) if (args.predictorVariableName != null) query.append("predictorVariableName", String(args.predictorVariableName)) if (args.outcomeVariableName != null) query.append("outcomeVariableName", String(args.outcomeVariableName)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.userId != null) query.append("userId", String(args.userId)) if (args.correlationCoefficient != null) query.append("correlationCoefficient", String(args.correlationCoefficient)) if (args.updatedAt != null) query.append("updatedAt", String(args.updatedAt)) if (args.outcomesOfInterest != null) query.append("outcomesOfInterest", String(args.outcomesOfInterest)) if (args.clientId != null) query.append("clientId", String(args.clientId)) if (args.commonOnly != null) query.append("commonOnly", String(args.commonOnly)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v3/correlations${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(getCorrelationsResponse, await res.json()) };