import {z} from 'zod' export type GetApiApi2JsonCommunityEngageCountryIso2FirstNameLastNameArgs = {countryIso2: string, firstName: string, lastName: string}; export type GetApiApi2JsonCommunityEngageCountryIso2FirstNameLastNameOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const religionStatOut = z.object({religion: z.string().optional(), pct: z.number().optional()}); export const personalNameDiasporaedOut = z.object({script: z.string().optional(), id: z.string().optional(), explanation: z.string().optional(), name: z.string().optional(), score: z.number().gte(0).lte(100).optional(), ethnicityAlt: z.string().optional(), ethnicity: z.string().optional(), lifted: z.boolean().optional(), countryIso2: z.string().optional(), ethnicitiesTop: z.array(z.string()).optional(), probabilityCalibrated: z.number().gte(-1).lte(1).optional(), probabilityAltCalibrated: z.number().gte(-1).lte(1).optional(), religionStats: z.array(religionStatOut).optional(), religionStatsAlt: z.array(religionStatOut).optional()}); export const personalNameOriginedOut = z.object({script: z.string().optional(), id: z.string().optional(), explanation: z.string().optional(), name: z.string().optional(), countryOrigin: z.string().optional(), countryOriginAlt: z.string().optional(), countriesOriginTop: z.array(z.string()).optional(), score: z.number().gte(0).lte(100).optional(), regionOrigin: z.string().optional(), topRegionOrigin: z.string().optional(), subRegionOrigin: z.string().optional(), probabilityCalibrated: z.number().gte(-1).lte(1).optional(), probabilityAltCalibrated: z.number().gte(-1).lte(1).optional(), religionStats: z.array(religionStatOut).optional(), religionStatsAlt: z.array(religionStatOut).optional(), religionStatsSynthetic: z.array(religionStatOut).optional()}); export const personalNameGeoOut = z.object({script: z.string().optional(), id: z.string().optional(), explanation: z.string().optional(), name: z.string().optional(), score: z.number().gte(0).lte(100).optional(), country: z.string().optional(), countryAlt: z.string().optional(), region: z.string().optional(), topRegion: z.string().optional(), subRegion: z.string().optional(), countriesTop: z.array(z.string()).optional(), probabilityCalibrated: z.number().gte(-1).lte(1).optional(), probabilityAltCalibrated: z.number().gte(-1).lte(1).optional(), religionStats: z.array(religionStatOut).optional(), religionStatsAlt: z.array(religionStatOut).optional()}); export const personalNameGenderedOut = z.object({script: z.string().optional(), id: z.string().optional(), explanation: z.string().optional(), name: z.string().optional(), likelyGender: z.enum(["male", "female", "unknown"]).optional(), genderScale: z.number().gte(-1).lte(1).optional(), score: z.number().gte(0).lte(100).optional(), probabilityCalibrated: z.number().gte(-1).lte(1).optional()}); export const personalNameUSRaceEthnicityOut = z.object({script: z.string().optional(), id: z.string().optional(), explanation: z.string().optional(), name: z.string().optional(), raceEthnicityAlt: z.enum(["W_NL", "HL", "A", "B_NL", "AI_AN", "PI"]).optional(), raceEthnicity: z.enum(["W_NL", "HL", "A", "B_NL", "AI_AN", "PI"]).optional(), score: z.number().gte(0).lte(100).optional(), raceEthnicitiesTop: z.array(z.string()).optional(), probabilityCalibrated: z.number().gte(-1).lte(1).optional(), probabilityAltCalibrated: z.number().gte(-1).lte(1).optional()}); export const communityEngageOut = z.object({id: z.string().optional(), PersonalNameDiasporaedOut: personalNameDiasporaedOut.optional(), PersonalNameOriginedOut: personalNameOriginedOut.optional(), country: personalNameGeoOut.optional(), gender: personalNameGenderedOut.optional(), PersonalNameUSRaceEthnicityOut: personalNameUSRaceEthnicityOut.optional(), prime: z.boolean().optional(), scoped: z.boolean().optional(), script: z.string().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 }; /** * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) * * GET /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName} */ export const getApiApi2JsonCommunityEngageCountryIso2FirstNameLastName = async (args: GetApiApi2JsonCommunityEngageCountryIso2FirstNameLastNameArgs, options?: GetApiApi2JsonCommunityEngageCountryIso2FirstNameLastNameOptions) => { const {baseUrl = "https://v2.namsor.com/NamSorAPIv2", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (apiKey !== undefined) headers.set("X-API-KEY", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/api2/json/communityEngage/${encodeURIComponent(String(args.countryIso2))}/${encodeURIComponent(String(args.firstName))}/${encodeURIComponent(String(args.lastName))}${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(communityEngageOut, await res.json()) };