import {z} from 'zod' export type GetApiV1ThreatLibraryActionParametersArgs = {module_name?: string | undefined}; export type GetApiV1ThreatLibraryActionParametersOptions = {baseUrl?: string | undefined, AccessToken?: string | undefined, fetch?: typeof fetch | undefined}; export const actionParameterBase = z.object({id: z.string().optional(), name: z.string().optional()}); export const subTechnique = z.object({has_actions: z.boolean().optional(), id: z.number().int().optional(), name: z.string().optional()}); export const technique = z.object({has_actions: z.boolean().optional(), id: z.number().int().optional(), name: z.string().optional(), sub_techniques: z.array(subTechnique).optional()}); export const mitreParameter = z.object({has_actions: z.boolean().optional(), id: z.number().int().optional(), name: z.string().optional(), techniques: z.array(technique).optional()}); export const threatActor = z.object({aka: z.string().optional(), id: z.number().int().optional(), name: z.string().optional()}); export const getApiV1ThreatLibraryActionParametersResponse = z.object({action_categories: z.array(actionParameterBase).optional(), affected_operating_systems: z.array(z.string()).optional(), affected_products: z.array(z.string()).optional(), mitre: z.array(mitreParameter).optional(), platforms: z.array(actionParameterBase).optional(), threat_actors: z.array(threatActor).optional(), ukc_phases: z.array(actionParameterBase).optional(), url_categories: z.array(actionParameterBase).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 }; /** * # Action Parameters * * GET /v1/threat-library/action-parameters */ export const getApiV1ThreatLibraryActionParameters = async (args: GetApiV1ThreatLibraryActionParametersArgs, options?: GetApiV1ThreatLibraryActionParametersOptions) => { const {baseUrl = "https://api.picussecurity.com", fetch: fetchFn = fetch, AccessToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.module_name != null) query.append("module_name", String(args.module_name)) if (AccessToken !== undefined) headers.set("Authorization", AccessToken) const url = `${baseUrl.replace(/\/+$/, '')}/v1/threat-library/action-parameters${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(getApiV1ThreatLibraryActionParametersResponse, await res.json()) };