pxt-core/localtypings/validatorPlan.d.ts

Microsoft MakeCode provides Blocks / JavaScript / Python tools and editors

/// <reference path="./pxtpackage.d.ts" />

declare namespace pxt.blocks {
    // A set of validation checks (with inputs) to run for a given criteria.
    export interface ValidatorPlan {
        name: string;
        threshold: number;
        checks: ValidatorCheckBase[];
    }

    // Base class to describes a single validation check to run (with inputs).
    // Each type of validation will need to implement its own ValidatorCheck based on this.
    export interface ValidatorCheckBase {
        validator: string;
        childValidatorPlans?: string[]
    }

    // Inputs for "Blocks Exist" validation.
    export interface BlocksExistCountInfo extends ValidatorCheckBase {
        blockId: string;
        count: number;
    }
    export interface BlocksExistValidatorCheck extends ValidatorCheckBase {
        validator: "blocksExist";
        blockCounts: BlocksExistCountInfo[];
    }

    export interface BlockCommentsExistValidatorCheck extends ValidatorCheckBase {
        validator: "blockCommentsExist";
        count: number;
    }
    export interface SpecificBlockCommentsExistValidatorCheck extends ValidatorCheckBase {
        validator: "specificBlockCommentsExist";
        blockType: string;
    }

    export interface BlocksInSetExistValidatorCheck extends ValidatorCheckBase {
        validator: "blocksInSetExist";
        blocks: string[];
        count: number;
    }

    export interface VariableUsageValidatorCheck extends ValidatorCheckBase {
        validator: "variableUsage";
        count: number;
        name?: string;
    }

    export interface EvaluationResult {
        result?: boolean;
        notes?: string;
        executionSuccess: boolean;
        executionErrorMsg?: string;
    }

    export interface BlockFieldValueExistsCheck extends ValidatorCheckBase {
        validator: "blockFieldValueExists";
        fieldType: string;
        fieldValue: string;
        blockType: string;
    }

    export interface AiQuestionValidatorCheck extends ValidatorCheckBase {
        validator: "aiQuestion";
        question: string;
        shareId: string;
    }
}