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.

Sign up for GitHub

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

PackageToJS: Package TypeScript type definitions for runtime #311

Merged
merged 2 commits into from
Mar 24, 2025
Merged

PackageToJS: Package TypeScript type definitions for runtime #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7751f9c
Bundle d.ts files with rollup-plugin-dts
kateinoigakukun Mar 24, 2025
24f479a
PackageToJS: Package TypeScript type definitions for runtime
kateinoigakukun Mar 24, 2025
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ perf-tester:
.PHONY: regenerate_swiftpm_resources
regenerate_swiftpm_resources:
npm run build
cp Runtime/lib/index.js Runtime/lib/index.mjs Sources/JavaScriptKit/Runtime
cp Runtime/lib/index.js Runtime/lib/index.mjs Runtime/lib/index.d.ts Sources/JavaScriptKit/Runtime
1 change: 1 addition & 0 deletions Plugins/PackageToJS/Sources/PackageToJS.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,7 @@ struct PackagingPlanner {
("Plugins/PackageToJS/Templates/platforms/node.js", "platforms/node.js"),
("Plugins/PackageToJS/Templates/platforms/node.d.ts", "platforms/node.d.ts"),
("Sources/JavaScriptKit/Runtime/index.mjs", "runtime.js"),
("Sources/JavaScriptKit/Runtime/index.d.ts", "runtime.d.ts"),
] {
packageInputs.append(
planCopyTemplateFile(
Expand Down
4 changes: 1 addition & 3 deletions Plugins/PackageToJS/Templates/instantiate.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
/* #if USE_SHARED_MEMORY */
import type { SwiftRuntimeThreadChannel, SwiftRuntime } from "./runtime.js";
/* #endif */
import type { /* #if USE_SHARED_MEMORY */SwiftRuntimeThreadChannel, /* #endif */SwiftRuntime } from "./runtime.js";

export type Import = {
// TODO: Generate type from imported .d.ts files
Expand Down
20 changes: 19 additions & 1 deletion Plugins/PackageToJS/Tests/__Snapshots__/PackagingPlannerTests/planBuild_debug.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,23 @@
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
"$SELF_PACKAGE\/Sources\/JavaScriptKit\/Runtime\/index.d.ts",
"$INTERMEDIATES\/wasm-imports.json"
],
"output" : "$OUTPUT\/runtime.d.ts",
"salt" : "eyJjb25kaXRpb25zIjp7IklTX1dBU0kiOnRydWUsIlVTRV9TSEFSRURfTUVNT1JZIjpmYWxzZSwiVVNFX1dBU0lfQ0ROIjpmYWxzZX0sInN1YnN0aXR1dGlvbnMiOnsiUEFDS0FHRV9UT19KU19NT0RVTEVfUEFUSCI6Im1haW4ud2FzbSIsIlBBQ0tBR0VfVE9fSlNfUEFDS0FHRV9OQU1FIjoidGVzdCJ9fQ==",
"wants" : [
"$OUTPUT",
"$OUTPUT\/platforms",
"$INTERMEDIATES\/wasm-imports.json"
]
},
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
Expand Down Expand Up @@ -269,7 +286,8 @@
"$OUTPUT\/platforms\/browser.worker.js",
"$OUTPUT\/platforms\/node.js",
"$OUTPUT\/platforms\/node.d.ts",
"$OUTPUT\/runtime.js"
"$OUTPUT\/runtime.js",
"$OUTPUT\/runtime.d.ts"
]
}
]
20 changes: 19 additions & 1 deletion Plugins/PackageToJS/Tests/__Snapshots__/PackagingPlannerTests/planBuild_release.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,23 @@
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
"$SELF_PACKAGE\/Sources\/JavaScriptKit\/Runtime\/index.d.ts",
"$INTERMEDIATES\/wasm-imports.json"
],
"output" : "$OUTPUT\/runtime.d.ts",
"salt" : "eyJjb25kaXRpb25zIjp7IklTX1dBU0kiOnRydWUsIlVTRV9TSEFSRURfTUVNT1JZIjpmYWxzZSwiVVNFX1dBU0lfQ0ROIjpmYWxzZX0sInN1YnN0aXR1dGlvbnMiOnsiUEFDS0FHRV9UT19KU19NT0RVTEVfUEFUSCI6Im1haW4ud2FzbSIsIlBBQ0tBR0VfVE9fSlNfUEFDS0FHRV9OQU1FIjoidGVzdCJ9fQ==",
"wants" : [
"$OUTPUT",
"$OUTPUT\/platforms",
"$INTERMEDIATES\/wasm-imports.json"
]
},
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
Expand Down Expand Up @@ -284,7 +301,8 @@
"$OUTPUT\/platforms\/browser.worker.js",
"$OUTPUT\/platforms\/node.js",
"$OUTPUT\/platforms\/node.d.ts",
"$OUTPUT\/runtime.js"
"$OUTPUT\/runtime.js",
"$OUTPUT\/runtime.d.ts"
]
}
]
20 changes: 19 additions & 1 deletion Plugins/PackageToJS/Tests/__Snapshots__/PackagingPlannerTests/planBuild_release_dwarf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,23 @@
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
"$SELF_PACKAGE\/Sources\/JavaScriptKit\/Runtime\/index.d.ts",
"$INTERMEDIATES\/wasm-imports.json"
],
"output" : "$OUTPUT\/runtime.d.ts",
"salt" : "eyJjb25kaXRpb25zIjp7IklTX1dBU0kiOnRydWUsIlVTRV9TSEFSRURfTUVNT1JZIjpmYWxzZSwiVVNFX1dBU0lfQ0ROIjpmYWxzZX0sInN1YnN0aXR1dGlvbnMiOnsiUEFDS0FHRV9UT19KU19NT0RVTEVfUEFUSCI6Im1haW4ud2FzbSIsIlBBQ0tBR0VfVE9fSlNfUEFDS0FHRV9OQU1FIjoidGVzdCJ9fQ==",
"wants" : [
"$OUTPUT",
"$OUTPUT\/platforms",
"$INTERMEDIATES\/wasm-imports.json"
]
},
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
Expand Down Expand Up @@ -269,7 +286,8 @@
"$OUTPUT\/platforms\/browser.worker.js",
"$OUTPUT\/platforms\/node.js",
"$OUTPUT\/platforms\/node.d.ts",
"$OUTPUT\/runtime.js"
"$OUTPUT\/runtime.js",
"$OUTPUT\/runtime.d.ts"
]
}
]
20 changes: 19 additions & 1 deletion Plugins/PackageToJS/Tests/__Snapshots__/PackagingPlannerTests/planBuild_release_name.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,23 @@
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
"$SELF_PACKAGE\/Sources\/JavaScriptKit\/Runtime\/index.d.ts",
"$INTERMEDIATES\/wasm-imports.json"
],
"output" : "$OUTPUT\/runtime.d.ts",
"salt" : "eyJjb25kaXRpb25zIjp7IklTX1dBU0kiOnRydWUsIlVTRV9TSEFSRURfTUVNT1JZIjpmYWxzZSwiVVNFX1dBU0lfQ0ROIjpmYWxzZX0sInN1YnN0aXR1dGlvbnMiOnsiUEFDS0FHRV9UT19KU19NT0RVTEVfUEFUSCI6Im1haW4ud2FzbSIsIlBBQ0tBR0VfVE9fSlNfUEFDS0FHRV9OQU1FIjoidGVzdCJ9fQ==",
"wants" : [
"$OUTPUT",
"$OUTPUT\/platforms",
"$INTERMEDIATES\/wasm-imports.json"
]
},
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
Expand Down Expand Up @@ -284,7 +301,8 @@
"$OUTPUT\/platforms\/browser.worker.js",
"$OUTPUT\/platforms\/node.js",
"$OUTPUT\/platforms\/node.d.ts",
"$OUTPUT\/runtime.js"
"$OUTPUT\/runtime.js",
"$OUTPUT\/runtime.d.ts"
]
}
]
20 changes: 19 additions & 1 deletion .../PackageToJS/Tests/__Snapshots__/PackagingPlannerTests/planBuild_release_no_optimize.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,23 @@
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
"$SELF_PACKAGE\/Sources\/JavaScriptKit\/Runtime\/index.d.ts",
"$INTERMEDIATES\/wasm-imports.json"
],
"output" : "$OUTPUT\/runtime.d.ts",
"salt" : "eyJjb25kaXRpb25zIjp7IklTX1dBU0kiOnRydWUsIlVTRV9TSEFSRURfTUVNT1JZIjpmYWxzZSwiVVNFX1dBU0lfQ0ROIjpmYWxzZX0sInN1YnN0aXR1dGlvbnMiOnsiUEFDS0FHRV9UT19KU19NT0RVTEVfUEFUSCI6Im1haW4ud2FzbSIsIlBBQ0tBR0VfVE9fSlNfUEFDS0FHRV9OQU1FIjoidGVzdCJ9fQ==",
"wants" : [
"$OUTPUT",
"$OUTPUT\/platforms",
"$INTERMEDIATES\/wasm-imports.json"
]
},
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
Expand Down Expand Up @@ -269,7 +286,8 @@
"$OUTPUT\/platforms\/browser.worker.js",
"$OUTPUT\/platforms\/node.js",
"$OUTPUT\/platforms\/node.d.ts",
"$OUTPUT\/runtime.js"
"$OUTPUT\/runtime.js",
"$OUTPUT\/runtime.d.ts"
]
}
]
18 changes: 18 additions & 0 deletions Plugins/PackageToJS/Tests/__Snapshots__/PackagingPlannerTests/planTestBuild.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,23 @@
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
"$SELF_PACKAGE\/Sources\/JavaScriptKit\/Runtime\/index.d.ts",
"$INTERMEDIATES\/wasm-imports.json"
],
"output" : "$OUTPUT\/runtime.d.ts",
"salt" : "eyJjb25kaXRpb25zIjp7IklTX1dBU0kiOnRydWUsIlVTRV9TSEFSRURfTUVNT1JZIjpmYWxzZSwiVVNFX1dBU0lfQ0ROIjpmYWxzZX0sInN1YnN0aXR1dGlvbnMiOnsiUEFDS0FHRV9UT19KU19NT0RVTEVfUEFUSCI6Im1haW4ud2FzbSIsIlBBQ0tBR0VfVE9fSlNfUEFDS0FHRV9OQU1FIjoidGVzdCJ9fQ==",
"wants" : [
"$OUTPUT",
"$OUTPUT\/platforms",
"$INTERMEDIATES\/wasm-imports.json"
]
},
{
"attributes" : [

],
"inputs" : [
"$PLANNER_SOURCE_PATH",
Expand Down Expand Up @@ -356,6 +373,7 @@
"$OUTPUT\/platforms\/node.js",
"$OUTPUT\/platforms\/node.d.ts",
"$OUTPUT\/runtime.js",
"$OUTPUT\/runtime.d.ts",
"$INTERMEDIATES\/npm-install.stamp",
"$OUTPUT\/bin",
"$OUTPUT\/test.js",
Expand Down
37 changes: 24 additions & 13 deletions Runtime/rollup.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
import typescript from "@rollup/plugin-typescript";
import dts from "rollup-plugin-dts";

/** @type {import('rollup').RollupOptions} */
const config = {
input: "src/index.ts",
output: [
{
file: "lib/index.mjs",
const config = [
{
input: "src/index.ts",
output: [
{
file: "lib/index.mjs",
format: "esm",
},
{
file: "lib/index.js",
format: "umd",
name: "JavaScriptKit",
},
],
plugins: [typescript()],
},
{
input: "src/index.ts",
output: {
file: "lib/index.d.ts",
format: "esm",
},
{
dir: "lib",
format: "umd",
name: "JavaScriptKit",
},
],
plugins: [typescript()],
};
plugins: [dts()],
},
];

export default config;
3 changes: 1 addition & 2 deletions Runtime/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"compilerOptions": {
"declaration": true,
"declarationDir": "lib",
"declaration": false,
"importHelpers": true,
"module": "esnext",
"noEmit": true,
Expand Down
Loading