Pique_output_verifier

This is to ensure the contract between the pique models and the visualizer yvette is creating is up held.

Full Schema

Requirements

• Need node and npm ideally most recent version

Run

• run these commands

npm i
npm run build
npm run start 'path to your eval file'

How is the json defined (crash course in Zod)

const RootEvalType = z.object({
    name : z.string(),
    additionalData : z.object({
        projectName : z.string(),
    }),
    global_config : z.object({
        benchmark_strategy : z.string(),
        weights_strategy : z.string(),
    }),
    factors : z.object({
        product_factors : z.record(product_factor),
        quality_aspects : z.record(quality_aspect),
        tqi : z.record(tqi)
    })
});

• if you are familiar with json this wont be too bad. The only thing that may not be recognizable is the z.record this is just a way to represent the classic

{
  "key1": {
    "name": string,
    "value": number
  },
  "key2": {
    "name": string,
    "value": number
  }
}

situation where there is a dictionary of key value pairs where all the values have the same structure.

Full Schema

const finding = z.object({
    vulnSource: z.string(),
    vulnSourceVersion : z.string(),
    name : z.string(),
    value : z.number(),
    description : z.string(),
    children: z.record(z.object({})),
    weights : z.record(z.number()),
    eval_strategy : z.string(),
    normalizer : z.string(),
    utility_function : z.object({
        name: z.string(),
        description : z.string(),
    })
})

const diagnostic = z.object({
    toolName: z.string(),
    name: z.string(),
    value : z.number(),
    description : z.string(),
    children: z.record(finding.or(z.object({}))),
    weights : z.record(z.number()),
    eval_strategy : z.string(),
    normalizer : z.string(),
    utility_function : z.object({
        name: z.string(),
        description : z.string(),
    })
});

const measure = z.object({
    positive : z.boolean(),
    name: z.string(),
    value : z.number(),
    description : z.string(),
    children: z.record(diagnostic),
    weights : z.record(z.number()),
    thresholds : z.array(z.number()),
    eval_strategy : z.string(),
    normalizer : z.string(),
    utility_function : z.object({
        name: z.string(),
        description : z.string(),
    })
});

const product_factor = z.object({
    name: z.string(),
    value : z.number(),
    description : z.string(),
    children: z.record(measure),
    weights : z.record(z.number()),
    eval_strategy : z.string(),
    normalizer : z.string(),
    utility_function : z.object({
        name: z.string(),
        description : z.string(),
    })
});

const quality_aspect = z.object({
    name: z.string(),
    value : z.number(),
    description : z.string(),
    children: z.record(product_factor.or(measure)),
    weights : z.record(z.number()),
    eval_strategy : z.string(),
    normalizer : z.string(),
    utility_function : z.object({
        name: z.string(),
        description : z.string(),
    })
});


const tqi = z.object({
    name: z.string(),
    value : z.number(),
    description : z.string(),
    children: z.record(quality_aspect),
    weights : z.record(z.number()),
    eval_strategy : z.string(),
    normalizer : z.string(),
    utility_function : z.object({
        name: z.string(),
        description : z.string(),
    })
});

const RootEvalType = z.object({
    name : z.string(),
    additionalData : z.object({
        projectName : z.string(),
    }),
    global_config : z.object({
        benchmark_strategy : z.string(),
        weights_strategy : z.string(),
    }),
    factors : z.object({
        product_factors : z.record(product_factor),
        quality_aspects : z.record(quality_aspect),
        tqi : z.record(tqi)
    }),
    measures : z.record(measure),
    diagnostics : z.record(diagnostic)
});

export default RootEvalType;
export type EvalType = z.infer<typeof RootEvalType>