qsharp-lang 1.3.5-dev → 1.4.0

package/dist/browser.d.ts

@@ -19,9 +19,9 @@ export declare function getLanguageService(readFile?: (uri: string) => Promise<s
 } | null>): Promise<ILanguageService>;
 export declare function getLanguageServiceWorker(worker: string | Worker): ILanguageServiceWorker;
 export { StepResultId, type IStructStepResult } from "../lib/web/qsc_wasm.js";
-export type { IBreakpointSpan, ICodeLens, ILocation, IOperationInfo, IPosition, IRange, IStackFrame, VSDiagnostic, } from "../lib/web/qsc_wasm.js";
+export type { IBreakpointSpan, ICodeLens, ILocation, IOperationInfo, IPosition, IRange, IStackFrame, VSDiagnostic, IDocFile, } from "../lib/web/qsc_wasm.js";
 export { type Dump, type ShotResult } from "./compiler/common.js";
-export { type CompilerState } from "./compiler/compiler.js";
+export { type CompilerState, type ProgramConfig } from "./compiler/compiler.js";
 export { QscEventTarget } from "./compiler/events.js";
 export { getAllKatas, getExerciseSources, getKata, type ContentItem, type Example, type Exercise, type ExplainedSolution, type ExplainedSolutionItem, type Kata, type KataSection, type Lesson, type LessonItem, type Question, } from "./katas.js";
 export { type LanguageServiceEvent } from "./language-service/language-service.js";

package/dist/compiler/compiler.d.ts

@@ -1,10 +1,11 @@
 import { type Circuit as CircuitData } from "@microsoft/quantum-viz.js/lib/circuit.js";
-import { IOperationInfo, TargetProfile, type VSDiagnostic } from "../../lib/web/qsc_wasm.js";
+import { IDocFile, IOperationInfo, TargetProfile, type VSDiagnostic } from "../../lib/web/qsc_wasm.js";
 import { IServiceProxy, ServiceProtocol, ServiceState } from "../workers/common.js";
 import { IQscEventTarget, QscEventData } from "./events.js";
 type Wasm = typeof import("../../lib/web/qsc_wasm.js");
 export interface ICompiler {
     checkCode(code: string): Promise<VSDiagnostic[]>;
+    getAst(code: string, languageFeatures?: string[]): Promise<string>;
     getHir(code: string, languageFeatures?: string[]): Promise<string>;
     /** @deprecated -- switch to using `ProgramConfig`-based overload. Instead of passing
      * sources and language features separately, pass an object with named properties. This change was made
@@ -30,7 +31,8 @@ export interface ICompiler {
      **/
     getEstimates(sources: [string, string][], params: string, languageFeatures?: string[]): Promise<string>;
     getEstimates(config: ProgramConfig, params: string): Promise<string>;
-    getCircuit(config: ProgramConfig, target: TargetProfile, operation?: IOperationInfo): Promise<CircuitData>;
+    getCircuit(config: ProgramConfig, target: TargetProfile, simulate: boolean, operation?: IOperationInfo): Promise<CircuitData>;
+    getDocumentation(): Promise<IDocFile[]>;
     checkExerciseSolution(userCode: string, exerciseSources: string[], eventHandler: IQscEventTarget): Promise<boolean>;
 }
 /** Type definition for the configuration of a program. */
@@ -39,6 +41,8 @@ export type ProgramConfig = {
     sources: [string, string][];
     /** An array of language features to be opted in to in this compilation. */
     languageFeatures?: string[];
+    /** Target compilation profile. */
+    profile?: TargetProfile;
 };
 export type ICompilerWorker = ICompiler & IServiceProxy;
 export type CompilerState = ServiceState;
@@ -47,14 +51,16 @@ export declare class Compiler implements ICompiler {
     constructor(wasm: Wasm);
     checkCode(code: string): Promise<VSDiagnostic[]>;
     getQir(sourcesOrConfig: [string, string][] | ProgramConfig, languageFeatures?: string[]): Promise<string>;
-    newGetQir({ sources, languageFeatures, }: ProgramConfig): Promise<string>;
+    newGetQir({ sources, languageFeatures, profile, }: ProgramConfig): Promise<string>;
     deprecatedGetQir(sources: [string, string][], languageFeatures: string[]): Promise<string>;
     getEstimates(sourcesOrConfig: [string, string][] | ProgramConfig, params: string, languageFeatures?: string[]): Promise<string>;
     newGetEstimates({ sources, languageFeatures }: ProgramConfig, params: string): Promise<string>;
     deprecatedGetEstimates(sources: [string, string][], params: string, languageFeatures: string[]): Promise<string>;
+    getAst(code: string, languageFeatures: string[]): Promise<string>;
     getHir(code: string, languageFeatures: string[]): Promise<string>;
     run(sourcesOrConfig: [string, string][] | ProgramConfig, expr: string, shots: number, eventHandler: IQscEventTarget): Promise<void>;
-    getCircuit(config: ProgramConfig, target: TargetProfile, operation?: IOperationInfo): Promise<CircuitData>;
+    getCircuit(config: ProgramConfig, target: TargetProfile, simulate: boolean, operation?: IOperationInfo): Promise<CircuitData>;
+    getDocumentation(): Promise<IDocFile[]>;
     checkExerciseSolution(userCode: string, exerciseSources: string[], eventHandler: IQscEventTarget): Promise<boolean>;
 }
 export declare function onCompilerEvent(msg: string, eventTarget: IQscEventTarget): void;

package/dist/compiler/compiler.js

@@ -30,14 +30,15 @@ export class Compiler {
             return this.deprecatedGetQir(sourcesOrConfig, languageFeatures || []);
         }
         else {
-            return this.newGetQir(sourcesOrConfig);
+            const config = sourcesOrConfig;
+            return this.newGetQir(config);
         }
     }
-    async newGetQir({ sources, languageFeatures = [], }) {
-        return this.wasm.get_qir(sources, languageFeatures);
+    async newGetQir({ sources, languageFeatures = [], profile = "base", }) {
+        return this.wasm.get_qir(sources, languageFeatures, profile);
     }
     async deprecatedGetQir(sources, languageFeatures) {
-        return this.wasm.get_qir(sources, languageFeatures);
+        return this.wasm.get_qir(sources, languageFeatures, "base");
     }
     async getEstimates(sourcesOrConfig, params, languageFeatures = []) {
         if (Array.isArray(sourcesOrConfig)) {
@@ -53,6 +54,9 @@ export class Compiler {
     async deprecatedGetEstimates(sources, params, languageFeatures) {
         return this.wasm.get_estimates(sources, params, languageFeatures);
     }
+    async getAst(code, languageFeatures) {
+        return this.wasm.get_ast(code, languageFeatures);
+    }
     async getHir(code, languageFeatures) {
         return this.wasm.get_hir(code, languageFeatures);
     }
@@ -73,8 +77,11 @@ export class Compiler {
         // may reject without all shots running or events firing.
         this.wasm.run(sources, expr, (msg) => onCompilerEvent(msg, eventHandler), shots, languageFeatures);
     }
-    async getCircuit(config, target, operation) {
-        return this.wasm.get_circuit(config.sources, target, operation, config.languageFeatures || []);
+    async getCircuit(config, target, simulate, operation) {
+        return this.wasm.get_circuit(config.sources, target, config.languageFeatures || [], simulate, operation);
+    }
+    async getDocumentation() {
+        return this.wasm.generate_docs();
     }
     async checkExerciseSolution(userCode, exerciseSources, eventHandler) {
         const success = this.wasm.check_exercise_solution(userCode, exerciseSources, (msg) => onCompilerEvent(msg, eventHandler));
@@ -114,10 +121,12 @@ export const compilerProtocol = {
     class: Compiler,
     methods: {
         checkCode: "request",
+        getAst: "request",
         getHir: "request",
         getQir: "request",
         getEstimates: "request",
         getCircuit: "request",
+        getDocumentation: "request",
         run: "requestWithProgress",
         checkExerciseSolution: "requestWithProgress",
     },