Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply tsc check for Plugins/PackageToJS/Templates files #324

Merged
merged 4 commits into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
root = true

[*]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
1 change: 0 additions & 1 deletion Plugins/PackageToJS/Templates/instantiate.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
// @ts-check
// @ts-ignore
import { SwiftRuntime } from "./runtime.js"

export const MODULE_PATH = "@PACKAGE_TO_JS_MODULE_PATH@";
Expand Down
2 changes: 2 additions & 0 deletions Plugins/PackageToJS/Templates/platforms/browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
import { MODULE_PATH /* #if USE_SHARED_MEMORY */, MEMORY_TYPE /* #endif */} from "../instantiate.js"
/* #if IS_WASI */
/* #if USE_WASI_CDN */
// @ts-ignore
import { WASI, File, OpenFile, ConsoleStdout, PreopenDirectory } from 'https://cdn.jsdelivr.net/npm/@bjorn3/[email protected]/+esm';
/* #else */
// @ts-ignore
import { WASI, File, OpenFile, ConsoleStdout, PreopenDirectory } from '@bjorn3/browser_wasi_shim';
/* #endif */
/* #endif */
Expand Down
56 changes: 3 additions & 53 deletions Plugins/PackageToJS/Templates/runtime.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,58 +18,8 @@ declare class Memory {
writeFloat64: (ptr: pointer, value: number) => void;
}

declare const enum Kind {
Boolean = 0,
String = 1,
Number = 2,
Object = 3,
Null = 4,
Undefined = 5,
Function = 6,
Symbol = 7,
BigInt = 8
}

type ref = number;
type pointer = number;
type bool = number;
type JavaScriptValueKind = number;
type JavaScriptValueKindAndFlags = number;
interface ImportedFunctions {
swjs_set_prop(ref: number, name: number, kind: Kind, payload1: number, payload2: number): void;
swjs_get_prop(ref: number, name: number, payload1_ptr: pointer, payload2_ptr: pointer): JavaScriptValueKind;
swjs_set_subscript(ref: number, index: number, kind: Kind, payload1: number, payload2: number): void;
swjs_get_subscript(ref: number, index: number, payload1_ptr: pointer, payload2_ptr: pointer): JavaScriptValueKind;
swjs_encode_string(ref: number, bytes_ptr_result: pointer): number;
swjs_decode_string(bytes_ptr: pointer, length: number): number;
swjs_load_string(ref: number, buffer: pointer): void;
swjs_call_function(ref: number, argv: pointer, argc: number, payload1_ptr: pointer, payload2_ptr: pointer): JavaScriptValueKindAndFlags;
swjs_call_function_no_catch(ref: number, argv: pointer, argc: number, payload1_ptr: pointer, payload2_ptr: pointer): JavaScriptValueKindAndFlags;
swjs_call_function_with_this(obj_ref: ref, func_ref: ref, argv: pointer, argc: number, payload1_ptr: pointer, payload2_ptr: pointer): JavaScriptValueKindAndFlags;
swjs_call_function_with_this_no_catch(obj_ref: ref, func_ref: ref, argv: pointer, argc: number, payload1_ptr: pointer, payload2_ptr: pointer): JavaScriptValueKindAndFlags;
swjs_call_new(ref: number, argv: pointer, argc: number): number;
swjs_call_throwing_new(ref: number, argv: pointer, argc: number, exception_kind_ptr: pointer, exception_payload1_ptr: pointer, exception_payload2_ptr: pointer): number;
swjs_instanceof(obj_ref: ref, constructor_ref: ref): boolean;
swjs_value_equals(lhs_ref: ref, rhs_ref: ref): boolean;
swjs_create_function(host_func_id: number, line: number, file: ref): number;
swjs_create_typed_array(constructor_ref: ref, elementsPtr: pointer, length: number): number;
swjs_create_object(): number;
swjs_load_typed_array(ref: ref, buffer: pointer): void;
swjs_release(ref: number): void;
swjs_release_remote(tid: number, ref: number): void;
swjs_i64_to_bigint(value: bigint, signed: bool): ref;
swjs_bigint_to_i64(ref: ref, signed: bool): bigint;
swjs_i64_to_bigint_slow(lower: number, upper: number, signed: bool): ref;
swjs_unsafe_event_loop_yield: () => void;
swjs_send_job_to_main_thread: (unowned_job: number) => void;
swjs_listen_message_from_main_thread: () => void;
swjs_wake_up_worker_thread: (tid: number) => void;
swjs_listen_message_from_worker_thread: (tid: number) => void;
swjs_terminate_worker_thread: (tid: number) => void;
swjs_get_worker_thread_id: () => number;
swjs_request_sending_object: (sending_object: ref, transferring_objects: pointer, transferring_objects_count: number, object_source_tid: number, sending_context: pointer) => void;
swjs_request_sending_objects: (sending_objects: pointer, sending_objects_count: number, transferring_objects: pointer, transferring_objects_count: number, object_source_tid: number, sending_context: pointer) => void;
}

/**
* A thread channel is a set of functions that are used to communicate between
Expand Down Expand Up @@ -254,11 +204,11 @@ declare class SwiftRuntime {
private get closureDeallocator();
private callHostFunction;
/** @deprecated Use `wasmImports` instead */
importObjects: () => ImportedFunctions;
get wasmImports(): ImportedFunctions;
importObjects: () => WebAssembly.ModuleImports;
get wasmImports(): WebAssembly.ModuleImports;
private postMessageToMainThread;
private postMessageToWorkerThread;
}

export { SwiftRuntime };
export type { SwiftRuntimeOptions };
export type { SwiftRuntimeOptions, SwiftRuntimeThreadChannel };
10 changes: 10 additions & 0 deletions Plugins/PackageToJS/Templates/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"compilerOptions": {
"module": "esnext",
"noEmit": true,
"allowJs": true,
"skipLibCheck": true,
"moduleResolution": "node"
},
"include": ["**/*.d.ts", "**/*.js"]
}
20 changes: 20 additions & 0 deletions Plugins/PackageToJS/Tests/TemplatesTests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import Testing
import Foundation
@testable import PackageToJS

@Suite struct TemplatesTests {
static let templatesPath = URL(fileURLWithPath: #filePath)
.deletingLastPathComponent()
.deletingLastPathComponent()
.appendingPathComponent("Templates")

/// `npx tsc -p Templates/tsconfig.json`
@Test func tscCheck() throws {
let tsc = Process()
tsc.executableURL = try which("npx")
tsc.arguments = ["tsc", "-p", Self.templatesPath.appending(path: "tsconfig.json").path]
try tsc.run()
tsc.waitUntilExit()
#expect(tsc.terminationStatus == 0)
}
}
14 changes: 7 additions & 7 deletions Runtime/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import {
ref,
pointer,
TypedArray,
ImportedFunctions,
MAIN_THREAD_TID,
} from "./types.js";
import * as JSValue from "./js-value.js";
import { Memory } from "./memory.js";
import { deserializeError, MainToWorkerMessage, MessageBroker, ResponseMessage, ITCInterface, serializeError, SwiftRuntimeThreadChannel, WorkerToMainMessage } from "./itc.js";
import { decodeObjectRefs } from "./js-value.js";
export { SwiftRuntimeThreadChannel };

export type SwiftRuntimeOptions = {
/**
Expand Down Expand Up @@ -181,7 +181,7 @@ export class SwiftRuntime {
/** @deprecated Use `wasmImports` instead */
importObjects = () => this.wasmImports;

get wasmImports(): ImportedFunctions {
get wasmImports(): WebAssembly.ModuleImports {
let broker: MessageBroker | null = null;
const getMessageBroker = (threadChannel: SwiftRuntimeThreadChannel) => {
if (broker) return broker;
Expand Down Expand Up @@ -575,7 +575,7 @@ export class SwiftRuntime {
return BigInt.asIntN(64, object);
}
},
swjs_i64_to_bigint_slow: (lower, upper, signed) => {
swjs_i64_to_bigint_slow: (lower: number, upper: number, signed: number) => {
const value =
BigInt.asUintN(32, BigInt(lower)) +
(BigInt.asUintN(32, BigInt(upper)) << BigInt(32));
Expand All @@ -586,7 +586,7 @@ export class SwiftRuntime {
swjs_unsafe_event_loop_yield: () => {
throw new UnsafeEventLoopYield();
},
swjs_send_job_to_main_thread: (unowned_job) => {
swjs_send_job_to_main_thread: (unowned_job: number) => {
this.postMessageToMainThread({ type: "job", data: unowned_job });
},
swjs_listen_message_from_main_thread: () => {
Expand Down Expand Up @@ -616,10 +616,10 @@ export class SwiftRuntime {
}
});
},
swjs_wake_up_worker_thread: (tid) => {
swjs_wake_up_worker_thread: (tid: number) => {
this.postMessageToWorkerThread(tid, { type: "wake" });
},
swjs_listen_message_from_worker_thread: (tid) => {
swjs_listen_message_from_worker_thread: (tid: number) => {
const threadChannel = this.options.threadChannel;
if (!(threadChannel && "listenMessageFromWorkerThread" in threadChannel)) {
throw new Error(
Expand Down Expand Up @@ -648,7 +648,7 @@ export class SwiftRuntime {
},
);
},
swjs_terminate_worker_thread: (tid) => {
swjs_terminate_worker_thread: (tid: number) => {
const threadChannel = this.options.threadChannel;
if (threadChannel && "terminateWorkerThread" in threadChannel) {
threadChannel.terminateWorkerThread?.(tid);
Expand Down
110 changes: 0 additions & 110 deletions Runtime/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import * as JSValue from "./js-value.js";

export type ref = number;
export type pointer = number;
export type bool = number;
Expand All @@ -26,114 +24,6 @@ export interface ExportedFunctions {
swjs_receive_error(error: ref, context: number): void;
}

export interface ImportedFunctions {
swjs_set_prop(
ref: number,
name: number,
kind: JSValue.Kind,
payload1: number,
payload2: number
): void;
swjs_get_prop(
ref: number,
name: number,
payload1_ptr: pointer,
payload2_ptr: pointer
): JavaScriptValueKind;
swjs_set_subscript(
ref: number,
index: number,
kind: JSValue.Kind,
payload1: number,
payload2: number
): void;
swjs_get_subscript(
ref: number,
index: number,
payload1_ptr: pointer,
payload2_ptr: pointer
): JavaScriptValueKind;
swjs_encode_string(ref: number, bytes_ptr_result: pointer): number;
swjs_decode_string(bytes_ptr: pointer, length: number): number;
swjs_load_string(ref: number, buffer: pointer): void;
swjs_call_function(
ref: number,
argv: pointer,
argc: number,
payload1_ptr: pointer,
payload2_ptr: pointer
): JavaScriptValueKindAndFlags;
swjs_call_function_no_catch(
ref: number,
argv: pointer,
argc: number,
payload1_ptr: pointer,
payload2_ptr: pointer
): JavaScriptValueKindAndFlags;
swjs_call_function_with_this(
obj_ref: ref,
func_ref: ref,
argv: pointer,
argc: number,
payload1_ptr: pointer,
payload2_ptr: pointer
): JavaScriptValueKindAndFlags;
swjs_call_function_with_this_no_catch(
obj_ref: ref,
func_ref: ref,
argv: pointer,
argc: number,
payload1_ptr: pointer,
payload2_ptr: pointer
): JavaScriptValueKindAndFlags;
swjs_call_new(ref: number, argv: pointer, argc: number): number;
swjs_call_throwing_new(
ref: number,
argv: pointer,
argc: number,
exception_kind_ptr: pointer,
exception_payload1_ptr: pointer,
exception_payload2_ptr: pointer
): number;
swjs_instanceof(obj_ref: ref, constructor_ref: ref): boolean;
swjs_value_equals(lhs_ref: ref, rhs_ref: ref): boolean;
swjs_create_function(host_func_id: number, line: number, file: ref): number;
swjs_create_typed_array(
constructor_ref: ref,
elementsPtr: pointer,
length: number
): number;
swjs_create_object(): number;
swjs_load_typed_array(ref: ref, buffer: pointer): void;
swjs_release(ref: number): void;
swjs_release_remote(tid: number, ref: number): void;
swjs_i64_to_bigint(value: bigint, signed: bool): ref;
swjs_bigint_to_i64(ref: ref, signed: bool): bigint;
swjs_i64_to_bigint_slow(lower: number, upper: number, signed: bool): ref;
swjs_unsafe_event_loop_yield: () => void;
swjs_send_job_to_main_thread: (unowned_job: number) => void;
swjs_listen_message_from_main_thread: () => void;
swjs_wake_up_worker_thread: (tid: number) => void;
swjs_listen_message_from_worker_thread: (tid: number) => void;
swjs_terminate_worker_thread: (tid: number) => void;
swjs_get_worker_thread_id: () => number;
swjs_request_sending_object: (
sending_object: ref,
transferring_objects: pointer,
transferring_objects_count: number,
object_source_tid: number,
sending_context: pointer,
) => void;
swjs_request_sending_objects: (
sending_objects: pointer,
sending_objects_count: number,
transferring_objects: pointer,
transferring_objects_count: number,
object_source_tid: number,
sending_context: pointer,
) => void;
}

export const enum LibraryFeatures {
WeakRefs = 1 << 0,
}
Expand Down
23 changes: 23 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@
"author": "swiftwasm",
"license": "MIT",
"devDependencies": {
"@bjorn3/browser_wasi_shim": "^0.4.1",
"@rollup/plugin-typescript": "^12.1.2",
"@types/node": "^22.13.14",
"playwright": "^1.51.0",
"prettier": "3.5.3",
"rollup": "^4.37.0",
Expand Down