qsharp-lang 1.27.0 → 1.27.2-dev

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qsharp-lang",
   "description": "qsharp language package for quantum development",
-  "version": "1.27.0",
+  "version": "1.27.2-dev",
   "license": "MIT",
   "engines": {
     "node": ">=16.17.0"
@@ -13,13 +13,13 @@
   },
   "exports": {
     ".": {
-      "browser": "./dist/browser.js",
-      "node": "./dist/main.js",
-      "default": "./dist/browser.js"
+      "browser": "./dist/main.js",
+      "node": "./dist/node.js",
+      "default": "./dist/main.js"
     },
-    "./compiler-worker": "./dist/compiler/worker-browser.js",
-    "./language-service-worker": "./dist/language-service/worker-browser.js",
-    "./debug-service-worker": "./dist/debug-service/worker-browser.js",
+    "./compiler-worker": "./dist/compiler/worker.js",
+    "./language-service-worker": "./dist/language-service/worker.js",
+    "./debug-service-worker": "./dist/debug-service/worker.js",
     "./katas": "./dist/katas.js",
     "./katas-md": "./dist/katas-md.js",
     "./state-viz": "./ux/circuit-vis/state-viz/worker/index.ts",
@@ -44,5 +44,8 @@
     "docs",
     "lib",
     "ux"
-  ]
+  ],
+  "optionalDependencies": {
+    "web-worker": "^1.5.0"
+  }
 }

package/ux/circuit-vis/draggable.ts

@@ -496,7 +496,7 @@ const makeDropzoneBox = (
   }
 
   const paddingY = 20;
-  let dropzone = null;
+  let dropzone;
   if (interColumn) {
     dropzone = box(
       xOffset - gatePadding * 2,

package/ux/circuit-vis/sqore.ts

@@ -80,7 +80,7 @@ export type DrawOptions = {
 export class Sqore {
   circuit: Circuit;
   gateRegistry: GateRegistry = {};
-  renderDepth: number = this.options.renderDepth ?? 0;
+  renderDepth: number;
   container: HTMLElement | null = null;
   zoomOnResize: boolean = true;
   zoomLevel: number = 100;
@@ -103,6 +103,7 @@ export class Sqore {
         `No circuit found in file. Please provide a valid circuit.`,
       );
     }
+    this.renderDepth = options.renderDepth ?? 0;
     // For now we only visualize the first circuit in the group
     this.circuit = this.circuitGroup.circuits[0];
   }

package/ux/report.ts

@@ -24,7 +24,7 @@ type ReportEntry = {
 // THIS CODE HAS BEEN AUTOMATICALLY GENERATED WITH generate_report_code.py from output_data.md
 export function CreateReport(result: SingleEstimateResult): ReportData {
   const groups = [] as ReportGroup[];
-  let entries = [] as ReportEntry[];
+  let entries: ReportEntry[];
   const numberFormat = new Intl.NumberFormat();
   const numberFormatF64 = new Intl.NumberFormat(undefined, {
     maximumFractionDigits: 2,

package/ux/resultsTable.tsx

@@ -321,8 +321,7 @@ export function ResultsTable(props: {
               >
                 {getColumnList().map((elem) => (
                   <div
-                    width="100px"
-                    height="20px"
+                    style="width: 100px; height: 20px;"
                     class={
                       elem.show
                         ? "qs-resultsTable-columnSelected"

package/ux/saveImage.tsx

@@ -20,8 +20,7 @@ async function cloneChildren<T extends HTMLElement>(
   nativeNode: T,
   clonedNode: T,
 ): Promise<T> {
-  let children: T[] = [];
-  children = toArray<T>((nativeNode.shadowRoot ?? nativeNode).childNodes);
+  const children = toArray<T>((nativeNode.shadowRoot ?? nativeNode).childNodes);
 
   // Depth-first traversal of DOM objects
   await children.reduce(

package/ux/tsconfig.json

@@ -1,12 +1,13 @@
 {
   "compilerOptions": {
     "outDir": "../dist",
+    "rootDir": "..",
     "declaration": true,
     "sourceMap": true,
     "module": "nodenext",
     "moduleResolution": "nodenext",
-    "target": "ES2020",
-    "lib": ["DOM", "ES2020"],
+    "target": "ES2022",
+    "lib": ["DOM", "ES2022"],
     "strict": true /* enable all strict type-checking options */,
     "jsx": "react-jsx",
     "jsxImportSource": "preact",

package/dist/browser.d.ts

@@ -1,32 +0,0 @@
-import * as wasm from "../lib/web/qsc_wasm.js";
-import { IProjectHost, ProjectType, TargetProfile } from "../lib/web/qsc_wasm.js";
-import { ICompiler, ICompilerWorker } from "./compiler/compiler.js";
-import { IDebugService, IDebugServiceWorker } from "./debug-service/debug-service.js";
-import { ILanguageService, ILanguageServiceWorker, qsharpGithubUriScheme, qsharpLibraryUriScheme } from "./language-service/language-service.js";
-import { LogLevel, log } from "./log.js";
-import { ProjectLoader } from "./project.js";
-export { qsharpGithubUriScheme, qsharpLibraryUriScheme };
-export declare function loadWasmModule(uriOrBuffer: string | ArrayBuffer): Promise<void>;
-export declare function getLibrarySourceContent(path: string): Promise<string | undefined>;
-export declare function getDebugService(): Promise<IDebugService>;
-export declare function getProjectLoader(host: IProjectHost): Promise<ProjectLoader>;
-export declare function getDebugServiceWorker(worker: string | Worker): IDebugServiceWorker;
-export declare function getCompiler(): Promise<ICompiler>;
-export declare function getCompilerWorker(worker: string | Worker): ICompilerWorker;
-export declare function getLanguageService(host?: IProjectHost): Promise<ILanguageService>;
-export declare function getLanguageServiceWorker(worker: string | Worker): ILanguageServiceWorker;
-export declare function getTargetProfileFromEntryPoint(fileName: string, source: string): Promise<wasm.TargetProfile | undefined>;
-export { StepResultId } from "../lib/web/qsc_wasm.js";
-export type { IBreakpointSpan, ICodeAction, ICodeLens, IDocFile, ILocation, IOperationInfo, IPosition, IProjectConfig, IProjectHost, IQSharpError, IRange, IStackFrame, IStructStepResult, ITestDescriptor, IVariable, IVariableChild, IWorkspaceEdit, VSDiagnostic, } from "../lib/web/qsc_wasm.js";
-export { type Dump, type ShotResult } from "./compiler/common.js";
-export { type CompilerState, type ProgramConfig } from "./compiler/compiler.js";
-export { QscEventTarget } from "./compiler/events.js";
-export { QdkDiagnostics } from "./diagnostics.js";
-export type { LanguageServiceDiagnosticEvent, LanguageServiceEvent, LanguageServiceTestCallablesEvent, } from "./language-service/language-service.js";
-export { default as openqasm_samples } from "./openqasm-samples.generated.js";
-export type { ProjectLoader } from "./project.js";
-export { default as samples } from "./samples.generated.js";
-export type { CircuitGroup as CircuitData } from "./data-structures/circuit.js";
-export * as utils from "./utils.js";
-export { log, type LogLevel, type ProjectType, type TargetProfile };
-export type { ICompiler, ICompilerWorker, IDebugService, IDebugServiceWorker, ILanguageService, ILanguageServiceWorker, };

package/dist/browser.js

@@ -1,126 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-// This module is the entry point for browser environments. For Node.js environment,
-// the "./main.js" module is the entry point.
-import * as wasm from "../lib/web/qsc_wasm.js";
-import initWasm from "../lib/web/qsc_wasm.js";
-import { Compiler, compilerProtocol, } from "./compiler/compiler.js";
-import { QSharpDebugService, debugServiceProtocol, } from "./debug-service/debug-service.js";
-import { callAndTransformExceptions } from "./diagnostics.js";
-import { QSharpLanguageService, languageServiceProtocol, qsharpGithubUriScheme, qsharpLibraryUriScheme, } from "./language-service/language-service.js";
-import { log } from "./log.js";
-import { ProjectLoader } from "./project.js";
-import { createProxy } from "./workers/browser.js";
-export { qsharpGithubUriScheme, qsharpLibraryUriScheme };
-// Create once. A module is stateless and can be efficiently passed to WebWorkers.
-let wasmModule = null;
-let wasmModulePromise = null;
-// Used to track if an instance is already instantiated
-let wasmInstancePromise = null;
-async function wasmLoader(uriOrBuffer) {
-    if (typeof uriOrBuffer === "string") {
-        log.info("Fetching wasm module from %s", uriOrBuffer);
-        performance.mark("fetch-wasm-start");
-        const wasmRequst = await fetch(uriOrBuffer);
-        const wasmBuffer = await wasmRequst.arrayBuffer();
-        const fetchTiming = performance.measure("fetch-wasm", "fetch-wasm-start");
-        log.logTelemetry({
-            id: "fetch-wasm",
-            data: {
-                duration: fetchTiming.duration,
-                uri: uriOrBuffer,
-            },
-        });
-        wasmModule = await WebAssembly.compile(wasmBuffer);
-    }
-    else {
-        log.info("Compiling wasm module from provided buffer");
-        wasmModule = await WebAssembly.compile(uriOrBuffer);
-    }
-}
-export function loadWasmModule(uriOrBuffer) {
-    // Only initiate if not already in flight, to avoid race conditions
-    if (!wasmModulePromise) {
-        wasmModulePromise = wasmLoader(uriOrBuffer);
-    }
-    return wasmModulePromise;
-}
-async function instantiateWasm() {
-    // Ensure loading the module has been initiated, and wait for it.
-    if (!wasmModulePromise)
-        throw "Wasm module must be loaded first";
-    await wasmModulePromise;
-    if (!wasmModule)
-        throw "Wasm module failed to load";
-    if (wasmInstancePromise) {
-        // Either in flight or already complete. The prior request will do the init,
-        // so just wait on that.
-        await wasmInstancePromise;
-        return;
-    }
-    // Set the promise to signal this is in flight, then wait on the result.
-    wasmInstancePromise = initWasm(wasmModule);
-    await wasmInstancePromise;
-    // Once ready, set up logging and telemetry as soon as possible after instantiating
-    wasm.initLogging(log.logWithLevel, log.getLogLevel());
-    log.onLevelChanged = (level) => wasm.setLogLevel(level);
-}
-export async function getLibrarySourceContent(path) {
-    await instantiateWasm();
-    return wasm.get_library_source_content(path);
-}
-export async function getDebugService() {
-    await instantiateWasm();
-    return new QSharpDebugService(wasm);
-}
-export async function getProjectLoader(host) {
-    await instantiateWasm();
-    return new ProjectLoader(wasm, host);
-}
-// Create the debugger inside a WebWorker and proxy requests.
-// If the Worker was already created via other means and is ready to receive
-// messages, then the worker may be passed in and it will be initialized.
-export function getDebugServiceWorker(worker) {
-    if (!wasmModule)
-        throw "Wasm module must be loaded first";
-    return createProxy(worker, wasmModule, debugServiceProtocol);
-}
-export async function getCompiler() {
-    await instantiateWasm();
-    return new Compiler(wasm);
-}
-// Create the compiler inside a WebWorker and proxy requests.
-// If the Worker was already created via other means and is ready to receive
-// messages, then the worker may be passed in and it will be initialized.
-export function getCompilerWorker(worker) {
-    if (!wasmModule)
-        throw "Wasm module must be loaded first";
-    return createProxy(worker, wasmModule, compilerProtocol);
-}
-export async function getLanguageService(host) {
-    await instantiateWasm();
-    return new QSharpLanguageService(wasm, host);
-}
-// Create the compiler inside a WebWorker and proxy requests.
-// If the Worker was already created via other means and is ready to receive
-// messages, then the worker may be passed in and it will be initialized.
-export function getLanguageServiceWorker(worker) {
-    if (!wasmModule)
-        throw "Wasm module must be loaded first";
-    return createProxy(worker, wasmModule, languageServiceProtocol);
-}
-/// Extracts the target profile from a Q# source file's entry point.
-/// Scans the provided source code for an EntryPoint argument specifying
-/// a profile and returns the corresponding TargetProfile value, if found.
-/// Returns undefined if no profile is specified or if the profile is not recognized.
-export async function getTargetProfileFromEntryPoint(fileName, source) {
-    await instantiateWasm();
-    return callAndTransformExceptions(async () => wasm.get_target_profile_from_entry_point(fileName, source));
-}
-export { StepResultId } from "../lib/web/qsc_wasm.js";
-export { QscEventTarget } from "./compiler/events.js";
-export { QdkDiagnostics } from "./diagnostics.js";
-export { default as openqasm_samples } from "./openqasm-samples.generated.js";
-export { default as samples } from "./samples.generated.js";
-export * as utils from "./utils.js";
-export { log };

package/dist/compiler/worker-node.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/compiler/worker-node.js

@@ -1,5 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import { createWorker } from "../workers/node.js";
-import { compilerProtocol } from "./compiler.js";
-createWorker(compilerProtocol);

package/dist/debug-service/worker-node.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/debug-service/worker-node.js

@@ -1,5 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import { createWorker } from "../workers/node.js";
-import { debugServiceProtocol } from "./debug-service.js";
-createWorker(debugServiceProtocol);

package/dist/language-service/worker-node.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/language-service/worker-node.js

@@ -1,5 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import { createWorker } from "../workers/node.js";
-import { languageServiceProtocol } from "./language-service.js";
-createWorker(languageServiceProtocol);

package/dist/workers/browser.js

@@ -1,67 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import * as wasm from "../../lib/web/qsc_wasm.js";
-import { log } from "../log.js";
-import { createProxyInternal, initService, } from "./common.js";
-/**
- * Creates an initializes a service, setting it up to receive requests.
- * This function to be is used in the worker.
- *
- * @param serviceProtocol An object that describes the service: its constructor, methods and events
- * @returns A message handler to be assigned to the `self.onmessage` handler in a web worker
- */
-export function createWorker(serviceProtocol) {
-    let invokeService = null;
-    // This export should be assigned to 'self.onmessage' in a WebWorker
-    return function messageHandler(e) {
-        const data = e.data;
-        if (!data.type || typeof data.type !== "string") {
-            log.error(`Unrecognized msg: ${data}`);
-            return;
-        }
-        switch (data.type) {
-            case "init":
-                {
-                    wasm.initSync({ module: data.wasmModule });
-                    invokeService = initService(self.postMessage.bind(self), serviceProtocol, wasm, data.qscLogLevel);
-                }
-                break;
-            default:
-                if (!invokeService) {
-                    log.error(`Received message before the service was initialized: %o`, data);
-                }
-                else {
-                    invokeService(data);
-                }
-        }
-    };
-}
-/**
- * Creates and initializes a service in a web worker, and returns a proxy for the service
- * to be used from the main thread.
- *
- * @param workerArg The service web worker or the URL of the web worker script.
- * @param wasmModule The wasm module to initialize the service with
- * @param serviceProtocol An object that describes the service: its constructor, methods and events
- * @returns A proxy object that implements the service interface.
- *   This interface can now be used as if calling into the real service,
- *   and the calls will be proxied to the web worker.
- */
-export function createProxy(workerArg, wasmModule, serviceProtocol) {
-    // Create or use the WebWorker
-    const worker = typeof workerArg === "string" ? new Worker(workerArg) : workerArg;
-    // Send it the Wasm module to instantiate
-    worker.postMessage({
-        type: "init",
-        wasmModule,
-        qscLogLevel: log.getLogLevel(),
-    });
-    // If you lose the 'this' binding, some environments have issues
-    const postMessage = worker.postMessage.bind(worker);
-    const onTerminate = () => worker.terminate();
-    // Create the proxy which will forward method calls to the worker
-    const proxy = createProxyInternal(postMessage, onTerminate, serviceProtocol.methods);
-    // Let proxy handle response and event messages from the worker
-    worker.onmessage = (ev) => proxy.onMsgFromWorker(ev.data);
-    return proxy;
-}

package/dist/workers/node.d.ts

@@ -1,20 +0,0 @@
-import { IServiceEventMessage, IServiceProxy, ServiceMethods, ServiceProtocol } from "./common.js";
-/**
- * Creates an initializes a service, setting it up to receive requests.
- * This function to be is used in the worker.
- *
- * @param serviceProtocol An object that describes the service: its constructor, methods and events
- */
-export declare function createWorker<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(protocol: ServiceProtocol<TService, TServiceEventMsg>): void;
-/**
- * Creates and initializes a service in a worker thread, and returns a proxy for the service
- * to be used from the main thread.
- *
- * @param workerArg The the URL of the service web worker script.
- * @param wasmModule The wasm module to initialize the service with
- * @param serviceProtocol An object that describes the service: its constructor, methods and events
- * @returns A proxy object that implements the service interface.
- *   This interface can now be used as if calling into the real service,
- *   and the calls will be proxied to the web worker.
- */
-export declare function createProxy<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(workerArg: string, serviceProtocol: ServiceProtocol<TService, TServiceEventMsg>): TService & IServiceProxy;

package/dist/workers/node.js

@@ -1,56 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-import { Worker, isMainThread, parentPort, workerData, } from "node:worker_threads";
-import * as wasm from "../../lib/nodejs/qsc_wasm.cjs";
-import { log } from "../log.js";
-import { createProxyInternal, initService, } from "./common.js";
-/**
- * Creates an initializes a service, setting it up to receive requests.
- * This function to be is used in the worker.
- *
- * @param serviceProtocol An object that describes the service: its constructor, methods and events
- */
-export function createWorker(protocol) {
-    if (isMainThread)
-        throw "Worker script should be loaded in a Worker thread only";
-    const port = parentPort;
-    const postMessage = port.postMessage.bind(port);
-    const invokeService = initService(postMessage, protocol, wasm, // Need to cast due to difference in web and node wasm types
-    workerData && typeof workerData.qscLogLevel === "number"
-        ? workerData.qscLogLevel
-        : undefined);
-    function messageHandler(data) {
-        if (!data.type || typeof data.type !== "string") {
-            log.error(`Unrecognized msg: %O"`, data);
-            return;
-        }
-        invokeService(data);
-    }
-    port.addListener("message", messageHandler);
-}
-/**
- * Creates and initializes a service in a worker thread, and returns a proxy for the service
- * to be used from the main thread.
- *
- * @param workerArg The the URL of the service web worker script.
- * @param wasmModule The wasm module to initialize the service with
- * @param serviceProtocol An object that describes the service: its constructor, methods and events
- * @returns A proxy object that implements the service interface.
- *   This interface can now be used as if calling into the real service,
- *   and the calls will be proxied to the web worker.
- */
-export function createProxy(workerArg, serviceProtocol) {
-    const thisDir = dirname(fileURLToPath(import.meta.url));
-    const worker = new Worker(join(thisDir, workerArg), {
-        workerData: { qscLogLevel: log.getLogLevel() },
-    });
-    // Create the proxy which will forward method calls to the worker
-    const proxy = createProxyInternal(
-    // If you lose the 'this' binding, some environments have issues.
-    worker.postMessage.bind(worker), () => worker.terminate(), serviceProtocol.methods);
-    // Let proxy handle response and event messages from the worker
-    worker.addListener("message", proxy.onMsgFromWorker);
-    return proxy;
-}