qsharp-lang 1.6.1-dev → 1.6.3-dev

package/lib/node/qsc_wasm.d.cts

@@ -14,29 +14,23 @@ export function setLogLevel(level: number): void;
 */
 export function git_hash(): string;
 /**
-* @param {(Array<any>)[]} sources
-* @param {(string)[]} language_features
-* @param {string} profile
+* @param {IProgramConfig} program
 * @returns {string}
 */
-export function get_qir(sources: (Array<any>)[], language_features: (string)[], profile: string): string;
+export function get_qir(program: IProgramConfig): string;
 /**
-* @param {(Array<any>)[]} sources
+* @param {IProgramConfig} program
 * @param {string} params
-* @param {(string)[]} language_features
-* @param {string} targetProfile
 * @returns {string}
 */
-export function get_estimates(sources: (Array<any>)[], params: string, language_features: (string)[], targetProfile: string): string;
+export function get_estimates(program: IProgramConfig, params: string): string;
 /**
-* @param {(Array<any>)[]} sources
-* @param {string} targetProfile
-* @param {(string)[]} language_features
+* @param {IProgramConfig} program
 * @param {boolean} simulate
 * @param {IOperationInfo | undefined} [operation]
 * @returns {any}
 */
-export function get_circuit(sources: (Array<any>)[], targetProfile: string, language_features: (string)[], simulate: boolean, operation?: IOperationInfo): any;
+export function get_circuit(program: IProgramConfig, simulate: boolean, operation?: IOperationInfo): any;
 /**
 * @param {string} name
 * @returns {string | undefined}
@@ -57,15 +51,13 @@ export function get_ast(code: string, language_features: (string)[], profile: st
 */
 export function get_hir(code: string, language_features: (string)[], profile: string): string;
 /**
-* @param {(Array<any>)[]} sources
+* @param {IProgramConfig} program
 * @param {string} expr
 * @param {Function} event_cb
 * @param {number} shots
-* @param {(string)[]} language_features
-* @param {string} profile
 * @returns {boolean}
 */
-export function run(sources: (Array<any>)[], expr: string, event_cb: Function, shots: number, language_features: (string)[], profile: string): boolean;
+export function run(program: IProgramConfig, expr: string, event_cb: Function, shots: number): boolean;
 /**
 * @param {string} solution_code
 * @param {any} exercise_sources_js
@@ -74,12 +66,10 @@ export function run(sources: (Array<any>)[], expr: string, event_cb: Function, s
 */
 export function check_exercise_solution(solution_code: string, exercise_sources_js: any, event_cb: Function): boolean;
 /**
-* @param {(Array<any>)[] | undefined} [additionalSources]
-* @param {string | undefined} [targetProfile]
-* @param {(string)[] | undefined} [languageFeatures]
+* @param {IProgramConfig | undefined} [additional_program]
 * @returns {(IDocFile)[]}
 */
-export function generate_docs(additionalSources?: (Array<any>)[], targetProfile?: string, languageFeatures?: (string)[]): (IDocFile)[];
+export function generate_docs(additional_program?: IProgramConfig): (IDocFile)[];
 /**
 */
 export enum StepResultId {
@@ -264,6 +254,59 @@ export interface ILocation {
         span: IRange;
     }
 
+
+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>;
+}
+
+/**
+ * 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;
+}
+
+
+
+    export type PackageKey = string;
+
+    export interface IPackageGraphSources {
+        root: IPackageInfo;
+        packages: Record<PackageKey,IPackageInfo>;
+    }
+
+
+    
+    export interface IPackageInfo {
+        sources: [string, string][];
+        languageFeatures: string[];
+        dependencies: Record<string,string>;
+        packageType?: "exe" | "lib";
+    }
+
+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;
+        }[];
+        errors: string[];
+    }
+
 export interface IDocFile {
         filename: string;
         metadata: string;
@@ -286,13 +329,11 @@ export class DebugService {
 */
   constructor();
 /**
-* @param {(Array<any>)[]} sources
-* @param {string} target_profile
-* @param {string | undefined} entry
-* @param {(string)[]} language_features
+* @param {IProgramConfig} program
+* @param {string | undefined} [entry]
 * @returns {string}
 */
-  load_source(sources: (Array<any>)[], target_profile: string, entry: string | undefined, language_features: (string)[]): string;
+  load_program(program: IProgramConfig, entry?: string): string;
 /**
 * @returns {IQuantumStateList}
 */
@@ -348,12 +389,10 @@ export class LanguageService {
   constructor();
 /**
 * @param {(uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void} diagnostics_callback
-* @param {(uri: string) => Promise<string | null>} read_file
-* @param {(uri: string) => Promise<[string, number][]>} list_directory
-* @param {(uri: string) => Promise<{ manifestDirectory: string }| null>} get_manifest
+* @param {IProjectHost} host
 * @returns {Promise<any>}
 */
-  start_background_work(diagnostics_callback: (uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void, read_file: (uri: string) => Promise<string | null>, list_directory: (uri: string) => Promise<[string, number][]>, get_manifest: (uri: string) => Promise<{ manifestDirectory: string }| null>): Promise<any>;
+  start_background_work(diagnostics_callback: (uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void, host: IProjectHost): Promise<any>;
 /**
 */
   stop_background_work(): void;
@@ -449,14 +488,12 @@ export class LanguageService {
 export class ProjectLoader {
   free(): void;
 /**
-* @param {(uri: string) => Promise<string | null>} read_file
-* @param {(uri: string) => Promise<[string, number][]>} list_directory
-* @param {(uri: string) => Promise<{ manifestDirectory: string }| null>} get_manifest
+* @param {IProjectHost} project_host
 */
-  constructor(read_file: (uri: string) => Promise<string | null>, list_directory: (uri: string) => Promise<[string, number][]>, get_manifest: (uri: string) => Promise<{ manifestDirectory: string }| null>);
+  constructor(project_host: IProjectHost);
 /**
-* @param {{ manifestDirectory: string }} manifest
-* @returns {Promise<[string, string][]>}
+* @param {string} directory
+* @returns {Promise<IProjectConfig>}
 */
-  load_project(manifest: { manifestDirectory: string }): Promise<[string, string][]>;
+  load_project_with_deps(directory: string): Promise<IProjectConfig>;
 }

package/lib/web/qsc_wasm.d.ts

@@ -14,29 +14,23 @@ export function setLogLevel(level: number): void;
 */
 export function git_hash(): string;
 /**
-* @param {(Array<any>)[]} sources
-* @param {(string)[]} language_features
-* @param {string} profile
+* @param {IProgramConfig} program
 * @returns {string}
 */
-export function get_qir(sources: (Array<any>)[], language_features: (string)[], profile: string): string;
+export function get_qir(program: IProgramConfig): string;
 /**
-* @param {(Array<any>)[]} sources
+* @param {IProgramConfig} program
 * @param {string} params
-* @param {(string)[]} language_features
-* @param {string} targetProfile
 * @returns {string}
 */
-export function get_estimates(sources: (Array<any>)[], params: string, language_features: (string)[], targetProfile: string): string;
+export function get_estimates(program: IProgramConfig, params: string): string;
 /**
-* @param {(Array<any>)[]} sources
-* @param {string} targetProfile
-* @param {(string)[]} language_features
+* @param {IProgramConfig} program
 * @param {boolean} simulate
 * @param {IOperationInfo | undefined} [operation]
 * @returns {any}
 */
-export function get_circuit(sources: (Array<any>)[], targetProfile: string, language_features: (string)[], simulate: boolean, operation?: IOperationInfo): any;
+export function get_circuit(program: IProgramConfig, simulate: boolean, operation?: IOperationInfo): any;
 /**
 * @param {string} name
 * @returns {string | undefined}
@@ -57,15 +51,13 @@ export function get_ast(code: string, language_features: (string)[], profile: st
 */
 export function get_hir(code: string, language_features: (string)[], profile: string): string;
 /**
-* @param {(Array<any>)[]} sources
+* @param {IProgramConfig} program
 * @param {string} expr
 * @param {Function} event_cb
 * @param {number} shots
-* @param {(string)[]} language_features
-* @param {string} profile
 * @returns {boolean}
 */
-export function run(sources: (Array<any>)[], expr: string, event_cb: Function, shots: number, language_features: (string)[], profile: string): boolean;
+export function run(program: IProgramConfig, expr: string, event_cb: Function, shots: number): boolean;
 /**
 * @param {string} solution_code
 * @param {any} exercise_sources_js
@@ -74,12 +66,10 @@ export function run(sources: (Array<any>)[], expr: string, event_cb: Function, s
 */
 export function check_exercise_solution(solution_code: string, exercise_sources_js: any, event_cb: Function): boolean;
 /**
-* @param {(Array<any>)[] | undefined} [additionalSources]
-* @param {string | undefined} [targetProfile]
-* @param {(string)[] | undefined} [languageFeatures]
+* @param {IProgramConfig | undefined} [additional_program]
 * @returns {(IDocFile)[]}
 */
-export function generate_docs(additionalSources?: (Array<any>)[], targetProfile?: string, languageFeatures?: (string)[]): (IDocFile)[];
+export function generate_docs(additional_program?: IProgramConfig): (IDocFile)[];
 /**
 */
 export enum StepResultId {
@@ -264,6 +254,59 @@ export interface ILocation {
         span: IRange;
     }
 
+
+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>;
+}
+
+/**
+ * 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;
+}
+
+
+
+    export type PackageKey = string;
+
+    export interface IPackageGraphSources {
+        root: IPackageInfo;
+        packages: Record<PackageKey,IPackageInfo>;
+    }
+
+
+    
+    export interface IPackageInfo {
+        sources: [string, string][];
+        languageFeatures: string[];
+        dependencies: Record<string,string>;
+        packageType?: "exe" | "lib";
+    }
+
+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;
+        }[];
+        errors: string[];
+    }
+
 export interface IDocFile {
         filename: string;
         metadata: string;
@@ -286,13 +329,11 @@ export class DebugService {
 */
   constructor();
 /**
-* @param {(Array<any>)[]} sources
-* @param {string} target_profile
-* @param {string | undefined} entry
-* @param {(string)[]} language_features
+* @param {IProgramConfig} program
+* @param {string | undefined} [entry]
 * @returns {string}
 */
-  load_source(sources: (Array<any>)[], target_profile: string, entry: string | undefined, language_features: (string)[]): string;
+  load_program(program: IProgramConfig, entry?: string): string;
 /**
 * @returns {IQuantumStateList}
 */
@@ -348,12 +389,10 @@ export class LanguageService {
   constructor();
 /**
 * @param {(uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void} diagnostics_callback
-* @param {(uri: string) => Promise<string | null>} read_file
-* @param {(uri: string) => Promise<[string, number][]>} list_directory
-* @param {(uri: string) => Promise<{ manifestDirectory: string }| null>} get_manifest
+* @param {IProjectHost} host
 * @returns {Promise<any>}
 */
-  start_background_work(diagnostics_callback: (uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void, read_file: (uri: string) => Promise<string | null>, list_directory: (uri: string) => Promise<[string, number][]>, get_manifest: (uri: string) => Promise<{ manifestDirectory: string }| null>): Promise<any>;
+  start_background_work(diagnostics_callback: (uri: string, version: number | undefined, diagnostics: VSDiagnostic[]) => void, host: IProjectHost): Promise<any>;
 /**
 */
   stop_background_work(): void;
@@ -449,16 +488,14 @@ export class LanguageService {
 export class ProjectLoader {
   free(): void;
 /**
-* @param {(uri: string) => Promise<string | null>} read_file
-* @param {(uri: string) => Promise<[string, number][]>} list_directory
-* @param {(uri: string) => Promise<{ manifestDirectory: string }| null>} get_manifest
+* @param {IProjectHost} project_host
 */
-  constructor(read_file: (uri: string) => Promise<string | null>, list_directory: (uri: string) => Promise<[string, number][]>, get_manifest: (uri: string) => Promise<{ manifestDirectory: string }| null>);
+  constructor(project_host: IProjectHost);
 /**
-* @param {{ manifestDirectory: string }} manifest
-* @returns {Promise<[string, string][]>}
+* @param {string} directory
+* @returns {Promise<IProjectConfig>}
 */
-  load_project(manifest: { manifestDirectory: string }): Promise<[string, string][]>;
+  load_project_with_deps(directory: string): Promise<IProjectConfig>;
 }
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
@@ -467,7 +504,7 @@ export interface InitOutput {
   readonly memory: WebAssembly.Memory;
   readonly __wbg_debugservice_free: (a: number) => void;
   readonly debugservice_new: () => number;
-  readonly debugservice_load_source: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => void;
+  readonly debugservice_load_program: (a: number, b: number, c: number, d: number, e: number) => void;
   readonly debugservice_capture_quantum_state: (a: number) => number;
   readonly debugservice_get_circuit: (a: number, b: number) => void;
   readonly debugservice_get_stack_frames: (a: number) => number;
@@ -479,7 +516,7 @@ export interface InitOutput {
   readonly debugservice_get_locals: (a: number) => number;
   readonly __wbg_languageservice_free: (a: number) => void;
   readonly languageservice_new: () => number;
-  readonly languageservice_start_background_work: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly languageservice_start_background_work: (a: number, b: number, c: number) => number;
   readonly languageservice_stop_background_work: (a: number) => void;
   readonly languageservice_update_configuration: (a: number, b: number) => void;
   readonly languageservice_update_document: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
@@ -499,18 +536,18 @@ export interface InitOutput {
   readonly initLogging: (a: number, b: number, c: number) => void;
   readonly setLogLevel: (a: number) => void;
   readonly __wbg_projectloader_free: (a: number) => void;
-  readonly projectloader_new: (a: number, b: number, c: number) => number;
-  readonly projectloader_load_project: (a: number, b: number) => number;
+  readonly projectloader_new: (a: number) => number;
+  readonly projectloader_load_project_with_deps: (a: number, b: number, c: number) => number;
   readonly git_hash: (a: number) => void;
-  readonly get_qir: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
-  readonly get_estimates: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
-  readonly get_circuit: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+  readonly get_qir: (a: number, b: number) => void;
+  readonly get_estimates: (a: number, b: number, c: number, d: number) => void;
+  readonly get_circuit: (a: number, b: number, c: number, d: number) => void;
   readonly get_library_source_content: (a: number, b: number, c: number) => void;
   readonly get_ast: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
   readonly get_hir: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
-  readonly run: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => void;
+  readonly run: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
   readonly check_exercise_solution: (a: number, b: number, c: number, d: number) => number;
-  readonly generate_docs: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+  readonly generate_docs: (a: number, b: number) => void;
   readonly __wbindgen_export_0: (a: number, b: number) => number;
   readonly __wbindgen_export_1: (a: number, b: number, c: number, d: number) => number;
   readonly __wbindgen_export_2: WebAssembly.Table;