qsharp-lang 1.26.1 → 1.26.3-dev

package/lib/nodejs/qsc_wasm.d.cts

@@ -1,360 +1,383 @@
 /* tslint:disable */
 /* eslint-disable */
-export function initLogging(callback: any, level: number): void;
-export function setLogLevel(level: number): void;
-export function git_hash(): string;
-export function get_qir(program: IProgramConfig): string;
-export function get_estimates(program: IProgramConfig, expr: string, params: string): string;
-export function get_circuit(program: IProgramConfig, operation: IOperationInfo | null | undefined, config: ICircuitConfig): any;
-export function get_library_source_content(name: string): string | undefined;
-export function get_ast(code: string, language_features: string[]): string;
-export function get_hir(code: string, language_features: string[]): string;
-export function get_rir(program: IProgramConfig): string[];
-export function get_target_profile_from_entry_point(file_name: string, source: string): string | undefined;
-export function run(program: IProgramConfig, expr: string, event_cb: Function, shots: number): boolean;
-export function runWithNoise(program: IProgramConfig, expr: string, event_cb: Function, shots: number, pauliNoise: any, qubitLoss: any): boolean;
-export function check_exercise_solution(solution_code: string, exercise_sources_js: any, event_cb: Function): boolean;
-export function generate_docs(additional_program?: IProgramConfig | null): IDocFile[];
-export function get_library_summaries(): string;
-export enum StepResultId {
-  BreakpointHit = 0,
-  Next = 1,
-  StepIn = 2,
-  StepOut = 3,
-  Return = 4,
-  Fail = 5,
-}
-export interface IStructStepResult {
-        id: number;
-        value: number;
-        error: string | undefined;
-    }
 
-export interface IBreakpointSpanList {
-        spans: Array<IBreakpointSpan>
-    }
-    
 
-export interface IBreakpointSpan {
-        id: number;
-        range: IRange;
-    }
+export interface IPackageInfo {
+    sources: [string, string][];
+    languageFeatures: string[];
+    dependencies: Record<string,string>;
+    packageType?: "exe" | "lib";
+}
 
-export interface IStackFrameList {
-        frames: Array<IStackFrame>
-    }
-    
 
-export interface IStackFrame {
-        name: string;
-        location: ILocation
-    }
+export type PackageKey = string;
 
-export interface IVariableList {
-        variables: Array<IVariable>
-    }
+export interface IPackageGraphSources {
+    root: IPackageInfo;
+    packages: Record<PackageKey,IPackageInfo>;
+    hasManifest: boolean;
+}
 
-export interface IVariableChild {
-        index: number;
-        value: string;
-        varType: "Array"
-            | "BigInt"
-            | "Bool"
-            | "Closure"
-            | "Double"
-            | "Global"
-            | "Int"
-            | "Pauli"
-            | "Qubit"
-            | "Range"
-            | "Result"
-            | "String"
-            | "Tuple";
-    }
 
-export interface IVariable {
-        name: string;
-        value: string;
-        varType: "Array"
-            | "BigInt"
-            | "Bool"
-            | "Closure"
-            | "Double"
-            | "Global"
-            | "Int"
-            | "Pauli"
-            | "Qubit"
-            | "Range"
-            | "Result"
-            | "String"
-            | "Tuple";
-        length: number | undefined;
-        elementType: string | undefined;
-        previewChildren: Array<IVariableChild> | undefined;
-        truncated: boolean | undefined;
-    }
+export interface IProjectHost {
+    readFile(uri: string): Promise<string | null>;
+    listDirectory(uri: string): Promise<[string, number][]>;
+    resolvePath(base: string, path: string): Promise<string | null>;
+    fetchGithub(owner: string, repo: string, ref: string, path: string): Promise<string>;
+    findManifestDirectory(docUri: string): Promise<string | null>;
+}
 
-export interface IQuantumStateList {
-        entries: Array<IQuantumState>
-    }
+/**
+ * Copy of the ProgramConfig type defined in compiler.ts,
+ * but with all the properties required and filled in with defaults where necessary.
+ */
+export interface IProgramConfig {
+    packageGraphSources: IPackageGraphSources;
+    profile: TargetProfile;
+    projectType: ProjectType;
+}
 
-export interface IQuantumState {
-        name: string;
-        value: string;
-    }
 
-export interface VSDiagnostic {
-        range: IRange,
-        message: string;
-        severity: "error" | "warning" | "info"
-        code?: string;
-        uri?: string;
-        related?: IRelatedInformation[];
-    }
 
-export interface IRelatedInformation {
-        location: ILocation,
-        message: string;
-    }
+export type LanguageFeatures = "v2-preview-syntax";
 
-export interface IQSharpError {
-        /** Source URI or name */
-        document: string;
-        diagnostic: VSDiagnostic;
-        stack?: string;
-    }
 
-export interface IWorkspaceConfiguration {
-        targetProfile?: TargetProfile;
-        packageType?: "exe" | "lib";
-        languageFeatures?: LanguageFeatures[];
-        lints?: ({ lint: string; level: string } | { group: string; level: string })[];
-        devDiagnostics?: boolean;
-    }
 
-export interface ICodeAction {
-        title: string;
-        edit?: IWorkspaceEdit;
-        kind?: "Empty" | "QuickFix" | "Refactor" | "RefactorExtract" | "RefactorInline" | "RefactorMove" | "RefactorRewrite" | "Source" | "SourceOrganizeImports" | "SourceFixAll" | "Notebook";
-        isPreferred?: boolean;
-    }
+export type ProjectType = "qsharp" | "openqasm";
 
-export interface ICompletionList {
-        items: ICompletionItem[]
-    }
 
-export interface ICompletionItem {
-        label: string;
-        kind: "function" | "interface" | "keyword" | "module" | "property" | "variable" | "typeParameter" | "field" | "class";
-        sortText?: string;
-        detail?: string;
-        additionalTextEdits?: ITextEdit[];
-    }
 
-export interface ITextEdit {
-        range: IRange;
-        newText: string;
-    }
+export type TargetProfile = "base" | "adaptive_ri" | "adaptive_rif" | "unrestricted";
 
-export interface IHover {
-        contents: string;
-        span: IRange
-    }
 
-export interface ISignatureHelp {
-        signatures: ISignatureInformation[];
-        activeSignature: number;
-        activeParameter: number;
-    }
+export interface IBreakpointSpan {
+    id: number;
+    range: IRange;
+}
 
-export interface ISignatureInformation {
-        label: string;
-        documentation: string;
-        parameters: IParameterInformation[];
-    }
+export interface IBreakpointSpanList {
+    spans: Array<IBreakpointSpan>
+}
 
-export interface IParameterInformation {
-        label: [number, number];
-        documentation: string;
-    }
 
-export type ICodeLens = {
-        range: IRange;
-        command: "histogram" | "estimate" | "debug" | "run" | "circuit";
-        args?: any[];
-    }
+export interface ICell {
+    uri: string;
+    version: number;
+    code: string;
+}
 
-export interface IOperationInfo {
-        operation: string;
-        totalNumQubits: number;
-    }
+export interface ICircuitConfig {
+    generationMethod: "simulate" | "classicalEval" | "static";
+    maxOperations: number;
+    sourceLocations: boolean;
+    groupByScope: boolean;
+}
 
-export interface IWorkspaceEdit {
-        changes: [string, ITextEdit[]][];
-    }
+export interface ICodeAction {
+    title: string;
+    edit?: IWorkspaceEdit;
+    kind?: "Empty" | "QuickFix" | "Refactor" | "RefactorExtract" | "RefactorInline" | "RefactorMove" | "RefactorRewrite" | "Source" | "SourceOrganizeImports" | "SourceFixAll" | "Notebook";
+    isPreferred?: boolean;
+}
 
-export interface ICell {
-        uri: string;
-        version: number;
-        code: string;
-    }
+export interface ICompletionItem {
+    label: string;
+    kind: "function" | "interface" | "keyword" | "module" | "property" | "variable" | "typeParameter" | "field" | "class";
+    sortText?: string;
+    detail?: string;
+    additionalTextEdits?: ITextEdit[];
+}
 
-export interface INotebookMetadata {
-        targetProfile?: "base" | "adaptive_ri" | "adaptive_rif" | "unrestricted";
-        languageFeatures?: "v2-preview-syntax"[];
-        manifest?: string;
-        projectRoot?: string;
-    }
+export interface ICompletionList {
+    items: ICompletionItem[]
+}
 
-export interface IPosition {
-        line: number;
-        character: number;
-    }
+export interface IDocFile {
+    filename: string;
+    metadata: string;
+    contents: string;
+}
 
-export interface IRange {
-        start: IPosition;
-        end: IPosition;
-    }
+export interface IHover {
+    contents: string;
+    span: IRange
+}
 
 export interface ILocation {
-        source: string;
-        span: IRange;
-    }
+    source: string;
+    span: IRange;
+}
 
+export interface INotebookMetadata {
+    targetProfile?: "base" | "adaptive_ri" | "adaptive_rif" | "unrestricted";
+    languageFeatures?: "v2-preview-syntax"[];
+    manifest?: string;
+    projectRoot?: string;
+}
 
-export interface IProjectHost {
-    readFile(uri: string): Promise<string | null>;
-    listDirectory(uri: string): Promise<[string, number][]>;
-    resolvePath(base: string, path: string): Promise<string | null>;
-    fetchGithub(owner: string, repo: string, ref: string, path: string): Promise<string>;
-    findManifestDirectory(docUri: string): Promise<string | null>;
+export interface IOperationInfo {
+    operation: string;
+    totalNumQubits: number;
 }
 
-/**
- * Copy of the ProgramConfig type defined in compiler.ts,
- * but with all the properties required and filled in with defaults where necessary.
- */
-export interface IProgramConfig {
+export interface IParameterInformation {
+    label: [number, number];
+    documentation: string;
+}
+
+export interface IPosition {
+    line: number;
+    character: number;
+}
+
+export interface IProjectConfig {
+    /**
+     * Friendly name for the project, based on the name of the Q# document or project directory
+     */
+    projectName: string;
+    /**
+     * Uri for the qsharp.json or the root source file (single file projects)
+     */
+    projectUri: string;
     packageGraphSources: IPackageGraphSources;
-    profile: TargetProfile;
+    lints: ({ lint: string; level: string } | { group: string; level: string })[];
+    errors: string[];
+    /**
+     * The type of project. This is used to determine how to load the project.
+     */
     projectType: ProjectType;
+    /**
+     * QIR target profile for the project, as set in qsharp.json.
+     */
+    profile?: TargetProfile;
 }
 
+export interface IQSharpError {
+    /** Source URI or name */
+    document: string;
+    diagnostic: VSDiagnostic;
+    stack?: string;
+}
 
+export interface IQuantumState {
+    name: string;
+    value: string;
+}
 
-    export type PackageKey = string;
+export interface IQuantumStateList {
+    entries: Array<IQuantumState>
+}
 
-    export interface IPackageGraphSources {
-        root: IPackageInfo;
-        packages: Record<PackageKey,IPackageInfo>;
-        hasManifest: boolean;
-    }
+export interface IRange {
+    start: IPosition;
+    end: IPosition;
+}
 
+export interface IRelatedInformation {
+    location: ILocation,
+    message: string;
+}
 
+export interface ISignatureHelp {
+    signatures: ISignatureInformation[];
+    activeSignature: number;
+    activeParameter: number;
+}
 
-    export interface IPackageInfo {
-        sources: [string, string][];
-        languageFeatures: string[];
-        dependencies: Record<string,string>;
-        packageType?: "exe" | "lib";
-    }
+export interface ISignatureInformation {
+    label: string;
+    documentation: string;
+    parameters: IParameterInformation[];
+}
 
-export interface IProjectConfig {
-        /**
-         * Friendly name for the project, based on the name of the Q# document or project directory
-         */
-        projectName: string;
-        /**
-         * Uri for the qsharp.json or the root source file (single file projects)
-         */
-        projectUri: string;
-        packageGraphSources: IPackageGraphSources;
-        lints: ({ lint: string; level: string } | { group: string; level: string })[];
-        errors: string[];
-        /**
-         * The type of project. This is used to determine how to load the project.
-         */
-        projectType: ProjectType;
-        /**
-         * QIR target profile for the project, as set in qsharp.json.
-         */
-        profile?: TargetProfile;
-    }
+export interface IStackFrame {
+    name: string;
+    location: ILocation
+}
 
-export interface ITestDescriptor {
-        callableName: string;
-        location: ILocation;
-        compilationUri: string;
-        friendlyName: string;
-    }
+export interface IStackFrameList {
+    frames: Array<IStackFrame>
+}
 
-export interface ICircuitConfig {
-        generationMethod: "simulate" | "classicalEval" | "static";
-        maxOperations: number;
-        sourceLocations: boolean;
-        groupByScope: boolean;
-    }
 
-export interface IDocFile {
-        filename: string;
-        metadata: string;
-        contents: string;
-    }
+export interface IStructStepResult {
+    id: number;
+    value: number;
+    error: string | undefined;
+}
 
+export interface ITestDescriptor {
+    callableName: string;
+    location: ILocation;
+    compilationUri: string;
+    friendlyName: string;
+}
 
-export type TargetProfile = "base" | "adaptive_ri" | "adaptive_rif" | "unrestricted";
+export interface ITextEdit {
+    range: IRange;
+    newText: string;
+}
 
+export interface IVariable {
+    name: string;
+    value: string;
+    varType: "Array"
+    | "BigInt"
+    | "Bool"
+    | "Closure"
+    | "Double"
+    | "Global"
+    | "Int"
+    | "Pauli"
+    | "Qubit"
+    | "Range"
+    | "Result"
+    | "String"
+    | "Tuple";
+    length: number | undefined;
+    elementType: string | undefined;
+    previewChildren: Array<IVariableChild> | undefined;
+    truncated: boolean | undefined;
+}
 
+export interface IVariableChild {
+    index: number;
+    value: string;
+    varType: "Array"
+    | "BigInt"
+    | "Bool"
+    | "Closure"
+    | "Double"
+    | "Global"
+    | "Int"
+    | "Pauli"
+    | "Qubit"
+    | "Range"
+    | "Result"
+    | "String"
+    | "Tuple";
+}
 
-export type LanguageFeatures = "v2-preview-syntax";
+export interface IVariableList {
+    variables: Array<IVariable>
+}
 
+export interface IWorkspaceConfiguration {
+    targetProfile?: TargetProfile;
+    packageType?: "exe" | "lib";
+    languageFeatures?: LanguageFeatures[];
+    lints?: ({ lint: string; level: string } | { group: string; level: string })[];
+    devDiagnostics?: boolean;
+}
 
+export interface IWorkspaceEdit {
+    changes: [string, ITextEdit[]][];
+}
 
-export type ProjectType = "qsharp" | "openqasm";
+export interface VSDiagnostic {
+    range: IRange,
+    message: string;
+    severity: "error" | "warning" | "info"
+    code?: string;
+    uri?: string;
+    related?: IRelatedInformation[];
+}
+
+export type ICodeLens = {
+    range: IRange;
+    command: "histogram" | "estimate" | "debug" | "run" | "circuit";
+    args?: any[];
+}
 
 
 export class DebugService {
-  free(): void;
-  constructor();
-  load_program(program: IProgramConfig, entry?: string | null): string;
-  capture_quantum_state(): IQuantumStateList;
-  get_circuit(): any;
-  get_stack_frames(): IStackFrameList;
-  eval_next(event_cb: Function, ids: Uint32Array): IStructStepResult;
-  eval_continue(event_cb: Function, ids: Uint32Array): IStructStepResult;
-  eval_step_in(event_cb: Function, ids: Uint32Array): IStructStepResult;
-  eval_step_out(event_cb: Function, ids: Uint32Array): IStructStepResult;
-  get_breakpoints(path: string): IBreakpointSpanList;
-  get_locals(frame_id: number): IVariableList;
+    free(): void;
+    [Symbol.dispose](): void;
+    capture_quantum_state(): IQuantumStateList;
+    eval_continue(event_cb: Function, ids: Uint32Array): IStructStepResult;
+    eval_next(event_cb: Function, ids: Uint32Array): IStructStepResult;
+    eval_step_in(event_cb: Function, ids: Uint32Array): IStructStepResult;
+    eval_step_out(event_cb: Function, ids: Uint32Array): IStructStepResult;
+    get_breakpoints(path: string): IBreakpointSpanList;
+    get_circuit(): any;
+    get_locals(frame_id: number): IVariableList;
+    get_stack_frames(): IStackFrameList;
+    load_program(program: IProgramConfig, entry?: string | null): string;
+    constructor();
 }
+
 export class LanguageService {
-  free(): void;
-  constructor();
-  start_background_work(diagnostics_callback: (uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void, test_callables_callback: (callables: ITestDescriptor[]) => void, host: IProjectHost): Promise<any>;
-  stop_background_work(): void;
-  update_configuration(config: IWorkspaceConfiguration): void;
-  update_document(uri: string, version: number, text: string, language_id: string): void;
-  close_document(uri: string, language_id: string): void;
-  update_notebook_document(notebook_uri: string, notebook_metadata: INotebookMetadata, cells: ICell[]): void;
-  close_notebook_document(notebook_uri: string): void;
-  get_code_actions(uri: string, range: IRange): ICodeAction[];
-  get_completions(uri: string, position: IPosition): ICompletionList;
-  get_definition(uri: string, position: IPosition): ILocation | undefined;
-  get_references(uri: string, position: IPosition, include_declaration: boolean): ILocation[];
-  get_format_changes(uri: string): ITextEdit[];
-  get_hover(uri: string, position: IPosition): IHover | undefined;
-  get_signature_help(uri: string, position: IPosition): ISignatureHelp | undefined;
-  get_rename(uri: string, position: IPosition, new_name: string): IWorkspaceEdit;
-  prepare_rename(uri: string, position: IPosition): ITextEdit | undefined;
-  get_code_lenses(uri: string): ICodeLens[];
+    free(): void;
+    [Symbol.dispose](): void;
+    close_document(uri: string, language_id: string): void;
+    close_notebook_document(notebook_uri: string): void;
+    get_code_actions(uri: string, range: IRange): ICodeAction[];
+    get_code_lenses(uri: string): ICodeLens[];
+    get_completions(uri: string, position: IPosition): ICompletionList;
+    get_definition(uri: string, position: IPosition): ILocation | undefined;
+    get_format_changes(uri: string): ITextEdit[];
+    get_hover(uri: string, position: IPosition): IHover | undefined;
+    get_references(uri: string, position: IPosition, include_declaration: boolean): ILocation[];
+    get_rename(uri: string, position: IPosition, new_name: string): IWorkspaceEdit;
+    get_signature_help(uri: string, position: IPosition): ISignatureHelp | undefined;
+    constructor();
+    prepare_rename(uri: string, position: IPosition): ITextEdit | undefined;
+    start_background_work(diagnostics_callback: (uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void, test_callables_callback: (callables: ITestDescriptor[]) => void, host: IProjectHost): Promise<any>;
+    stop_background_work(): void;
+    update_configuration(config: IWorkspaceConfiguration): void;
+    update_document(uri: string, version: number, text: string, language_id: string): void;
+    update_notebook_document(notebook_uri: string, notebook_metadata: INotebookMetadata, cells: ICell[]): void;
 }
+
 /**
  * a minimal implementation for interacting with async JS filesystem callbacks to
  * load project files
  */
 export class ProjectLoader {
-  free(): void;
-  constructor(project_host: IProjectHost);
-  load_project_with_deps(directory: string): Promise<IProjectConfig>;
-  load_openqasm_project(file_path: string, source?: string | null): Promise<IProjectConfig>;
+    free(): void;
+    [Symbol.dispose](): void;
+    load_openqasm_project(file_path: string, source?: string | null): Promise<IProjectConfig>;
+    load_project_with_deps(directory: string): Promise<IProjectConfig>;
+    constructor(project_host: IProjectHost);
+}
+
+export enum StepResultId {
+    BreakpointHit = 0,
+    Next = 1,
+    StepIn = 2,
+    StepOut = 3,
+    Return = 4,
+    Fail = 5,
 }
+
+export function check_exercise_solution(solution_code: string, exercise_sources_js: any, event_cb: Function): boolean;
+
+export function generate_docs(additional_program?: IProgramConfig | null): IDocFile[];
+
+export function get_ast(code: string, language_features: string[]): string;
+
+export function get_circuit(program: IProgramConfig, operation: IOperationInfo | null | undefined, config: ICircuitConfig): any;
+
+export function get_estimates(program: IProgramConfig, expr: string, params: string): string;
+
+export function get_hir(code: string, language_features: string[]): string;
+
+export function get_library_source_content(name: string): string | undefined;
+
+export function get_library_summaries(): string;
+
+export function get_qir(program: IProgramConfig): string;
+
+export function get_rir(program: IProgramConfig): string[];
+
+export function get_target_profile_from_entry_point(file_name: string, source: string): string | undefined;
+
+export function git_hash(): string;
+
+export function initLogging(callback: any, level: number): void;
+
+export function run(program: IProgramConfig, expr: string, event_cb: Function, shots: number): boolean;
+
+export function runWithNoise(program: IProgramConfig, expr: string, event_cb: Function, shots: number, pauliNoise: any, qubitLoss: any): boolean;
+
+export function setLogLevel(level: number): void;