qsharp-lang 1.4.0 → 1.4.2-dev

package/dist/compiler/common.d.ts

@@ -12,7 +12,7 @@ export type Result = {
 interface DumpMsg {
     type: "DumpMachine";
     state: Dump;
-    stateLatex: string;
+    stateLatex: string | null;
 }
 interface MessageMsg {
     type: "Message";

package/dist/compiler/compiler.d.ts

@@ -5,8 +5,8 @@ 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>;
+    getAst(code: string, languageFeatures?: string[], profile?: TargetProfile): Promise<string>;
+    getHir(code: string, languageFeatures?: string[], profile?: TargetProfile): 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
      * for the sake of extensibility and future-compatibility. Note that only the new API
@@ -32,7 +32,7 @@ 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, simulate: boolean, operation?: IOperationInfo): Promise<CircuitData>;
-    getDocumentation(): Promise<IDocFile[]>;
+    getDocumentation(additionalSources?: [string, string][], targetProfile?: string, languageFeatures?: string[]): Promise<IDocFile[]>;
     checkExerciseSolution(userCode: string, exerciseSources: string[], eventHandler: IQscEventTarget): Promise<boolean>;
 }
 /** Type definition for the configuration of a program. */
@@ -56,11 +56,11 @@ export declare class Compiler implements ICompiler {
     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>;
+    getAst(code: string, languageFeatures?: string[], profile?: TargetProfile): Promise<string>;
+    getHir(code: string, languageFeatures: string[], profile: TargetProfile): Promise<string>;
     run(sourcesOrConfig: [string, string][] | ProgramConfig, expr: string, shots: number, eventHandler: IQscEventTarget): Promise<void>;
     getCircuit(config: ProgramConfig, target: TargetProfile, simulate: boolean, operation?: IOperationInfo): Promise<CircuitData>;
-    getDocumentation(): Promise<IDocFile[]>;
+    getDocumentation(additionalSources?: [string, string][], targetProfile?: string, languageFeatures?: string[]): 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

@@ -54,11 +54,11 @@ 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 getAst(code, languageFeatures, profile) {
+        return this.wasm.get_ast(code, languageFeatures ?? [], profile ?? "adaptive_ri");
     }
-    async getHir(code, languageFeatures) {
-        return this.wasm.get_hir(code, languageFeatures);
+    async getHir(code, languageFeatures, profile) {
+        return this.wasm.get_hir(code, languageFeatures ?? [], profile ?? "adaptive_ri");
     }
     async run(sourcesOrConfig, expr, shots, eventHandler) {
         let sources;
@@ -80,8 +80,12 @@ export class Compiler {
     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();
+    // Returns all autogenerated documentation files for the standard library
+    // and loaded project (if requested). This include file names and metadata,
+    // including specially formatted table of content file.
+    async getDocumentation(additionalSources, targetProfile, languageFeatures) {
+        // Get documentation from wasm layer
+        return this.wasm.generate_docs(additionalSources, targetProfile, languageFeatures);
     }
     async checkExerciseSolution(userCode, exerciseSources, eventHandler) {
         const success = this.wasm.check_exercise_solution(userCode, exerciseSources, (msg) => onCompilerEvent(msg, eventHandler));

package/dist/compiler/events.d.ts

@@ -7,7 +7,7 @@ export type QscEventData = {
     type: "DumpMachine";
     detail: {
         state: Dump;
-        stateLatex: string;
+        stateLatex: string | null;
     };
 } | {
     type: "Result";