Change the package to com.squareup.zstd (#8)

swankjesse · squarejesse · web-flow · commit 3b7f5e30cc80 · 2025-07-15T13:21:43.000Z
Co-authored-by: Jesse Wilson &lt;jwilson@squareup.com&gt;
diff --git a/README.md b/README.md
@@ -1,6 +1,9 @@
-# Okio Zstd
+# Zstd-KMP
 
-Build the native libraries:
+The [ZStandard compression library (zstd)][zstd], packaged for [Kotlin multiplatform (kmp)][kmp].
+
+
+## Building
 
 # Git Submodules
 
@@ -15,13 +18,13 @@ git submodule update
 brew install cmake
 ```
 
-# macOS
+# Build JNI libraries on macOS
 
 ```
 ./zstd-kmp/src/jvmMain/build-mac.sh
 ```
 
-# Linux
+# Build JNI libraries on Linux
 
 ```
 ./zstd-kmp/src/jvmMain/build-linux.sh
@@ -32,3 +35,6 @@ brew install cmake
 ```
 ./gradlew zstd-kmp:jvmTest
 ```
+
+[kmp]: https://kotlinlang.org/docs/multiplatform.html
+[zstd]: https://github.com/facebook/zstd
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -53,7 +53,7 @@ configure<SpotlessExtension> {
 }
 
 allprojects {
-  group = "com.squareup.okio-zstd"
+  group = "com.squareup.zstd"
   version = project.property("VERSION_NAME") as String
 
   repositories {
@@ -74,7 +74,7 @@ subprojects {
 }
 
 tasks.named("dokkaHtmlMultiModule", DokkaMultiModuleTask::class.java).configure {
-  moduleName.set("Okio-Zstd")
+  moduleName.set("Zstd-Kmp")
 }
 
 allprojects {
@@ -160,7 +160,7 @@ allprojects {
       publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL, automaticRelease = true)
       signAllPublications()
       pom {
-        description.set("ZStandard for Okio")
+        description.set("ZStandard for Kotlin Multiplatform")
         name.set(project.name)
         url.set("https://github.com/square/okio-zstd/")
         licenses {
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,4 +1,4 @@
-rootProject.name = "okio-zstd-root"
+rootProject.name = "zstd-kmp-root"
 
 include(":zstd-kmp")
 
diff --git a/zstd-kmp/api/android/zstd-kmp.api b/zstd-kmp/api/android/zstd-kmp.api
@@ -1,4 +1,4 @@
-public final class okio/zstd/Zstd {
+public final class com/squareup/zstd/Zstd {
 	public static final fun zstdCompress (Lokio/Sink;)Lokio/Sink;
 	public static final fun zstdDecompress (Lokio/Source;)Lokio/Source;
 }
diff --git a/zstd-kmp/api/jvm/zstd-kmp.api b/zstd-kmp/api/jvm/zstd-kmp.api
@@ -1,4 +1,4 @@
-public final class okio/zstd/Zstd {
+public final class com/squareup/zstd/Zstd {
 	public static final fun zstdCompress (Lokio/Sink;)Lokio/Sink;
 	public static final fun zstdDecompress (Lokio/Source;)Lokio/Source;
 }
diff --git a/zstd-kmp/build.gradle.kts b/zstd-kmp/build.gradle.kts
@@ -78,7 +78,7 @@ kotlin {
       main.cinterops {
         create("zstd") {
           header(file("../zstd/lib/zstd.h"))
-          packageName("okio.zstd.internal")
+          packageName("com.squareup.zstd.internal")
         }
       }
     }
@@ -127,7 +127,7 @@ cklib {
 }
 
 android {
-  namespace = "okio.zstd"
+  namespace = "com.squareup.zstd"
   compileSdk = libs.versions.compileSdk.get().toInt()
 
   defaultConfig {
diff --git a/zstd-kmp/native/ZstdKmp.cpp b/zstd-kmp/native/ZstdKmp.cpp
@@ -39,35 +39,35 @@ JniZstd::JniZstd(JNIEnv *env, jclass zstdCompressorClass, jclass zstdDecompresso
 }
 
 extern "C" JNIEXPORT jstring JNICALL
-Java_okio_zstd_JniZstd_getErrorName(JNIEnv* env, jobject type, jlong code) {
+Java_com_squareup_zstd_JniZstd_getErrorName(JNIEnv* env, jobject type, jlong code) {
   auto codeSizeT = static_cast<size_t>(code);
   if (!ZSTD_isError(codeSizeT)) return NULL;
   auto errorString = ZSTD_getErrorName(codeSizeT);
   return env->NewStringUTF(errorString);
 }
 
 extern "C" JNIEXPORT jlong JNICALL
-Java_okio_zstd_JniZstd_createJniZstd(JNIEnv* env, jclass type) {
-  auto zstdCompressorClass = env->FindClass("okio/zstd/ZstdCompressor");
-  auto zstdDecompressorClass = env->FindClass("okio/zstd/ZstdDecompressor");
+Java_com_squareup_zstd_JniZstd_createJniZstd(JNIEnv* env, jclass type) {
+  auto zstdCompressorClass = env->FindClass("com/squareup/zstd/ZstdCompressor");
+  auto zstdDecompressorClass = env->FindClass("com/squareup/zstd/ZstdDecompressor");
   auto jniZstd = new JniZstd(env, zstdCompressorClass, zstdDecompressorClass);
   return reinterpret_cast<jlong>(jniZstd);
 }
 
 extern "C" JNIEXPORT jlong JNICALL
-Java_okio_zstd_JniZstd_createZstdCompressor(JNIEnv* env, jclass type) {
+Java_com_squareup_zstd_JniZstd_createZstdCompressor(JNIEnv* env, jclass type) {
   ZSTD_CCtx* cctx = ZSTD_createCCtx(); // Could be NULL.
   return reinterpret_cast<jlong>(cctx);
 }
 
 extern "C" JNIEXPORT jlong JNICALL
-Java_okio_zstd_JniZstdCompressor_setParameter(JNIEnv* env, jobject type, jlong cctxPointer, jint param, jint value) {
+Java_com_squareup_zstd_JniZstdCompressor_setParameter(JNIEnv* env, jobject type, jlong cctxPointer, jint param, jint value) {
   auto cctx = reinterpret_cast<ZSTD_CCtx*>(cctxPointer);
   return ZSTD_CCtx_setParameter(cctx, static_cast<ZSTD_cParameter>(param), value);
 }
 
 extern "C" JNIEXPORT jlong JNICALL
-Java_okio_zstd_JniZstdCompressor_compressStream2(JNIEnv* env, jobject type, jlong jniZstdPointer, jlong cctxPointer, jbyteArray outputByteArray, jint outputEnd, jint outputStart, jbyteArray inputByteArray, jint inputEnd, jint inputStart, jint mode) {
+Java_com_squareup_zstd_JniZstdCompressor_compressStream2(JNIEnv* env, jobject type, jlong jniZstdPointer, jlong cctxPointer, jbyteArray outputByteArray, jint outputEnd, jint outputStart, jbyteArray inputByteArray, jint inputEnd, jint inputStart, jint mode) {
   auto jniZstd = reinterpret_cast<JniZstd*>(jniZstdPointer);
   auto cctx = reinterpret_cast<ZSTD_CCtx*>(cctxPointer);
 
@@ -95,19 +95,19 @@ Java_okio_zstd_JniZstdCompressor_compressStream2(JNIEnv* env, jobject type, jlon
 }
 
 extern "C" JNIEXPORT void JNICALL
-Java_okio_zstd_JniZstdCompressor_close(JNIEnv* env, jobject type, jlong cctxPointer) {
+Java_com_squareup_zstd_JniZstdCompressor_close(JNIEnv* env, jobject type, jlong cctxPointer) {
   auto cctx = reinterpret_cast<ZSTD_CCtx*>(cctxPointer);
   ZSTD_freeCCtx(cctx);
 }
 
 extern "C" JNIEXPORT jlong JNICALL
-Java_okio_zstd_JniZstd_createZstdDecompressor(JNIEnv* env, jclass type) {
+Java_com_squareup_zstd_JniZstd_createZstdDecompressor(JNIEnv* env, jclass type) {
   ZSTD_DCtx* dctx = ZSTD_createDCtx(); // Could be NULL.
   return reinterpret_cast<jlong>(dctx);
 }
 
 extern "C" JNIEXPORT jlong JNICALL
-Java_okio_zstd_JniZstdDecompressor_decompressStream(JNIEnv* env, jobject type, jlong jniZstdPointer, jlong dctxPointer, jbyteArray outputByteArray, jint outputEnd, jint outputStart, jbyteArray inputByteArray, jint inputEnd, jint inputStart) {
+Java_com_squareup_zstd_JniZstdDecompressor_decompressStream(JNIEnv* env, jobject type, jlong jniZstdPointer, jlong dctxPointer, jbyteArray outputByteArray, jint outputEnd, jint outputStart, jbyteArray inputByteArray, jint inputEnd, jint inputStart) {
   auto jniZstd = reinterpret_cast<JniZstd*>(jniZstdPointer);
   auto dctx = reinterpret_cast<ZSTD_DCtx*>(dctxPointer);
 
@@ -134,7 +134,7 @@ Java_okio_zstd_JniZstdDecompressor_decompressStream(JNIEnv* env, jobject type, j
 }
 
 extern "C" JNIEXPORT void JNICALL
-Java_okio_zstd_JniZstdDecompressor_close(JNIEnv* env, jobject type, jlong dctxPointer) {
+Java_com_squareup_zstd_JniZstdDecompressor_close(JNIEnv* env, jobject type, jlong dctxPointer) {
   auto dctx = reinterpret_cast<ZSTD_DCtx*>(dctxPointer);
   ZSTD_freeDCtx(dctx);
 }
diff --git a/zstd-kmp/src/androidMain/kotlin/com/squareup/zstd/AndroidZstd.kt b/zstd-kmp/src/androidMain/kotlin/com/squareup/zstd/AndroidZstd.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 internal actual fun loadNativeLibrary() {
   System.loadLibrary("zstd-kmp")
diff --git a/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/Zstd.kt b/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/Zstd.kt
@@ -16,7 +16,7 @@
 @file:Suppress("ktlint:standard:property-naming")
 @file:JvmName("Zstd")
 
-package okio.zstd
+package com.squareup.zstd
 
 import kotlin.jvm.JvmName
 import okio.IOException
diff --git a/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdCompressSink.kt b/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdCompressSink.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import kotlin.jvm.JvmField
 import okio.Buffer
diff --git a/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdCompressor.kt b/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdCompressor.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import kotlin.jvm.JvmField
 import okio.Closeable
diff --git a/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdDecompressSource.kt b/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdDecompressSource.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import kotlin.jvm.JvmField
 import okio.Buffer
diff --git a/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdDecompressor.kt b/zstd-kmp/src/commonMain/kotlin/com/squareup/zstd/ZstdDecompressor.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import kotlin.jvm.JvmField
 import okio.Closeable
diff --git a/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdCompressSinkTest.kt b/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdCompressSinkTest.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
diff --git a/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdDecompressSourceTest.kt b/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdDecompressSourceTest.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
diff --git a/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdTest.kt b/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdTest.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
diff --git a/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdTesting.kt b/zstd-kmp/src/commonTest/kotlin/com/squareup/zstd/ZstdTesting.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
diff --git a/zstd-kmp/src/jniMain/kotlin/com/squareup/zstd/JniZstd.kt b/zstd-kmp/src/jniMain/kotlin/com/squareup/zstd/JniZstd.kt
@@ -15,7 +15,7 @@
  */
 @file:JvmName("JniZstd")
 
-package okio.zstd
+package com.squareup.zstd
 
 internal val jniZstdPointer: Long = run {
   loadNativeLibrary()
diff --git a/zstd-kmp/src/jniMain/kotlin/com/squareup/zstd/JniZstdCompressor.kt b/zstd-kmp/src/jniMain/kotlin/com/squareup/zstd/JniZstdCompressor.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 internal class JniZstdCompressor : ZstdCompressor() {
   @JvmField
diff --git a/zstd-kmp/src/jniMain/kotlin/com/squareup/zstd/JniZstdDecompressor.kt b/zstd-kmp/src/jniMain/kotlin/com/squareup/zstd/JniZstdDecompressor.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 internal class JniZstdDecompressor : ZstdDecompressor() {
   @JvmField
diff --git a/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/JniZstdCompressSinkTest.kt b/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/JniZstdCompressSinkTest.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
diff --git a/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/JniZstdDecompressSourceTest.kt b/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/JniZstdDecompressSourceTest.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
diff --git a/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/JniZstdTesting.kt b/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/JniZstdTesting.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import com.github.luben.zstd.ZstdInputStream
 import com.github.luben.zstd.ZstdOutputStream
diff --git a/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/LubenZstdJniInteropTest.kt b/zstd-kmp/src/jniTest/kotlin/com/squareup/zstd/LubenZstdJniInteropTest.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package okio.zstd
+package com.squareup.zstd
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
@@ -34,15 +34,15 @@ import okio.buffer
 internal class LubenZstdJniInteropTest {
 
   @Test
-  fun lubenCompressOkioDecompress() {
+  fun lubenCompressKmpDecompress() {
     val original = "hello world".encodeUtf8()
     val compressed = LubenZstd.compress(original.toByteArray())
     val decompressed = oneShotDecompress(compressed.toByteString())
     assertThat(decompressed).isEqualTo(original)
   }
 
   @Test
-  fun okioCompressLubenDecompress() {
+  fun kmpCompressLubenDecompress() {
     val original = "hello world".encodeUtf8()
     val compressed = compress(original)
     val decompressed = compressed.referenceDecompress()
diff --git a/zstd-kmp/src/jvmMain/kotlin/com/squareup/zstd/JvmZstd.kt b/zstd-kmp/src/jvmMain/kotlin/com/squareup/zstd/JvmZstd.kt
@@ -15,7 +15,7 @@
  */
 @file:JvmName("JvmZstd")
 
-package okio.zstd
+package com.squareup.zstd
 
 import java.nio.file.Files
 import java.util.Locale.US
diff --git a/zstd-kmp/src/nativeMain/kotlin/com/squareup/zstd/NativeZstd.kt b/zstd-kmp/src/nativeMain/kotlin/com/squareup/zstd/NativeZstd.kt
@@ -15,12 +15,12 @@
  */
 @file:OptIn(ExperimentalForeignApi::class)
 
-package okio.zstd
+package com.squareup.zstd
 
+import com.squareup.zstd.internal.ZSTD_getErrorName
+import com.squareup.zstd.internal.ZSTD_isError
 import kotlinx.cinterop.ExperimentalForeignApi
 import kotlinx.cinterop.toKString
-import okio.zstd.internal.ZSTD_getErrorName
-import okio.zstd.internal.ZSTD_isError
 
 internal actual fun zstdCompressor(): ZstdCompressor = NativeZstdCompressor()
 
diff --git a/zstd-kmp/src/nativeMain/kotlin/com/squareup/zstd/NativeZstdCompressor.kt b/zstd-kmp/src/nativeMain/kotlin/com/squareup/zstd/NativeZstdCompressor.kt
@@ -15,20 +15,20 @@
  */
 @file:OptIn(ExperimentalForeignApi::class)
 
-package okio.zstd
+package com.squareup.zstd
 
+import com.squareup.zstd.internal.ZSTD_CCtx_setParameter
+import com.squareup.zstd.internal.ZSTD_compressStream2
+import com.squareup.zstd.internal.ZSTD_createCCtx
+import com.squareup.zstd.internal.ZSTD_freeCCtx
+import com.squareup.zstd.internal.ZSTD_inBuffer
+import com.squareup.zstd.internal.ZSTD_outBuffer
 import kotlinx.cinterop.ExperimentalForeignApi
 import kotlinx.cinterop.addressOf
 import kotlinx.cinterop.alloc
 import kotlinx.cinterop.memScoped
 import kotlinx.cinterop.ptr
 import kotlinx.cinterop.usePinned
-import okio.zstd.internal.ZSTD_CCtx_setParameter
-import okio.zstd.internal.ZSTD_compressStream2
-import okio.zstd.internal.ZSTD_createCCtx
-import okio.zstd.internal.ZSTD_freeCCtx
-import okio.zstd.internal.ZSTD_inBuffer
-import okio.zstd.internal.ZSTD_outBuffer
 
 internal class NativeZstdCompressor : ZstdCompressor() {
   private var cctx = ZSTD_createCCtx()
diff --git a/zstd-kmp/src/nativeMain/kotlin/com/squareup/zstd/NativeZstdDecompressor.kt b/zstd-kmp/src/nativeMain/kotlin/com/squareup/zstd/NativeZstdDecompressor.kt
diff --git a/zstd-kmp/src/nativeTest/kotlin/com/squareup/zstd/NativeZstdTesting.kt b/zstd-kmp/src/nativeTest/kotlin/com/squareup/zstd/NativeZstdTesting.kt

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-rootProject.name = "okio-zstd-root"`
	`1`	`+rootProject.name = "zstd-kmp-root"`
`2`	`2`
`3`	`3`	`include(":zstd-kmp")`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-public final class okio/zstd/Zstd {`
	`1`	`+public final class com/squareup/zstd/Zstd {`
`2`	`2`	`public static final fun zstdCompress (Lokio/Sink;)Lokio/Sink;`
`3`	`3`	`public static final fun zstdDecompress (Lokio/Source;)Lokio/Source;`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ kotlin {`
`78`	`78`	`main.cinterops {`
`79`	`79`	`create("zstd") {`
`80`	`80`	`header(file("../zstd/lib/zstd.h"))`
`81`		`- packageName("okio.zstd.internal")`
	`81`	`+ packageName("com.squareup.zstd.internal")`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`	`}`
`@@ -127,7 +127,7 @@ cklib {`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`android {`
`130`		`- namespace = "okio.zstd"`
	`130`	`+ namespace = "com.squareup.zstd"`
`131`	`131`	`compileSdk = libs.versions.compileSdk.get().toInt()`
`132`	`132`
`133`	`133`	`defaultConfig {`