air-script.d.ts

declare module '@guildofweavers/air-script' {

    // IMPORTS AND RE-EXPORTS
    // --------------------------------------------------------------------------------------------
    import { AirSchema, InputRegisterMaster, Dimensions, ValueSequence } from '@guildofweavers/air-assembly';
    export { AirSchema } from '@guildofweavers/air-assembly';

    // PUBLIC INTERFACES
    // --------------------------------------------------------------------------------------------
    export class AirScriptError {
        readonly errors: any[];
        constructor(errors: any[]);
    }

    /**
     * Parses and compiles AirScript file into an AirSchema object.
     * @param path Path to the file containing AirScript source.
     * @param componentName Optional component name to be assigned to the parsed module.
     */
    export function compile(path: string, componentName?: string): AirSchema;

    /**
     * Parses and compiles AirScript source code into an AirSchema object.
     * @param source Buffer containing AirScript source code.
     * @param componentName Optional component name to be assigned to the parsed module.
     */
    export function compile(source: Buffer, componentName?: string): AirSchema;

    // INTERNAL INTERFACES
    // --------------------------------------------------------------------------------------------
    export type Interval = [number, number];

    export interface InputRegister {
        readonly scope      : string;
        readonly binary     : boolean;
        readonly master?    : InputRegisterMaster;
        readonly steps?     : number;
        readonly loopAnchor?: boolean;
    }
    
    export interface MaskRegister {
        readonly input  : number;
        readonly path   : number[];
    }
    
    export interface SegmentRegister {
        readonly mask   : bigint[];
        readonly path   : number[];
    }

    export interface StaticRegister {
        readonly values : bigint[] | ValueSequence;
    }

    export interface SymbolInfo {
        readonly type       : 'const' | 'input' | 'static' | 'param' | 'func';
        readonly handle     : string;
        readonly dimensions : Dimensions;
        readonly subset     : boolean;
        readonly offset?    : number;
    }
    
    export interface FunctionInfo extends SymbolInfo {
        readonly type       : 'func';
        readonly rank       : number;
        readonly auxOffset  : number;
        readonly auxCount   : number;
        readonly maskCount  : number;
        readonly inputCount : number;
        readonly cycleLength: number;
    }
    
    export interface InputInfo extends SymbolInfo {
        readonly type       : 'input';
        readonly scope      : string;
        readonly binary     : boolean;
        readonly rank       : number;
    }
    
}