npmからの依存関係を利用する

Kotlin/JSプロジェクトでは、すべての依存関係をGradleプラグインを通じて管理できます。これには、kotlinx.coroutines、kotlinx.serialization、ktor-clientなどのKotlin/Multiplatformライブラリが含まれます。

npmからのJavaScriptパッケージに依存する場合、Gradle DSLは、npmからインポートしたいパッケージを指定できるnpm関数を提供しています。is-sortedというNPMパッケージのインポートを考えてみましょう。

Gradleビルドファイルの対応する部分は次のようになります。

dependencies {
    // ...
    implementation(npm("is-sorted", "1.0.5"))
}

JavaScriptモジュールは通常動的に型付けされ、Kotlinは静的に型付けされた言語であるため、ある種のアダプターを提供する必要があります。Kotlinでは、このようなアダプターは_外部宣言_と呼ばれます。is-sortedパッケージは1つの関数しか提供しないため、この宣言は簡単に記述できます。ソースフォルダ内にis-sorted.ktという新しいファイルを作成し、以下の内容を記述します。

@JsModule("is-sorted")
@JsNonModule
external fun <T> sorted(a: Array<T>): Boolean

なお、CommonJSをターゲットとして使用している場合、@JsModuleおよび@JsNonModuleアノテーションはそれに応じて調整する必要があります。

このJavaScript関数は、通常のKotlin関数と同じように使用できるようになります。ヘッダーファイルで型情報を提供したため（単にパラメーターと戻り値の型をdynamicとして定義するのではなく）、適切なコンパイラのサポートと型チェックも利用できます。

console.log("Hello, Kotlin/JS!")
console.log(sorted(arrayOf(1,2,3)))
console.log(sorted(arrayOf(3,1,2)))

これらの3行をブラウザまたはNode.jsで実行すると、出力には、sortedへの呼び出しがis-sortedパッケージによってエクスポートされた関数に適切にマッピングされたことが示されます。

Hello, Kotlin/JS!
true
false

JavaScriptエコシステムでは、パッケージ内で関数を公開する方法が複数あるため（例えば、名前付きエクスポートやデフォルトエクスポートを通じて）、他のnpmパッケージでは、外部宣言の構造をわずかに変更する必要がある場合があります。

宣言の書き方について詳しく知るには、KotlinからJavaScriptを呼び出すを参照してください。