@lppedd/kotlinx-charset 0.0.2 → 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Edoardo Luppi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,7 +1,19 @@
 # kotlinx-charset
 
+![Build status](https://github.com/lppedd/kotlinx-charset/workflows/Build/badge.svg)
+![MIT license](https://img.shields.io/github/license/lppedd/kotlinx-charset)
+![Kotlin 2.1.20](https://img.shields.io/badge/kotlin-2.1.20-blue.svg?logo=kotlin)
+
 Minimal charset support for Kotlin Multiplatform.
 
+### Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).
+
+### Supported Kotlin platforms
+
+All Kotlin platforms are supported, except for Android.
+
 ## core
 
 The `core` module provides the foundational components for implementing
@@ -25,9 +37,10 @@ val encoder = charset.newEncoder()
 The `ebcdic` module adds support for:
 
 ```text
-IBM037
-IBM930
-IBM1047
+IBM037  IBM939
+IBM273  IBM1047
+IBM297  IBM1141
+IBM930  IBM1147
 ```
 
 You can register supported EBCDIC charsets to your `XCharsetRegistrar`
@@ -54,11 +67,23 @@ You can depend on the [@lppedd/kotlinx-charset][1] npm package.
 For example, consuming the library from TypeScript would look like:
 
 ```ts
-import { decode, encode } from "@lppedd/kotlinx-charset";
+import { decode, encode, getCharset } from "@lppedd/kotlinx-charset";
+
+function funsExample(bytes: Uint8Array): Uint8Array {
+  const str = decode("ibm037", bytes);
+  return encode("ibm037", str);
+}
+
+// Alternatively, you can interact with a charset instance directly.
+// This allows setting or removing (by passing null) the replacement character.
+function instanceExample(bytes: Uint8Array): Uint8Array {
+  const charset = getCharset("ibm037");
+
+  const decoder = charset.newDecoder();
+  const str = decoder.decode(bytes);
 
-function example(bytes: Uint8Array): Uint8Array {
-  const str = decode("cp037", bytes);
-  return encode("cp037", str);
+  const encoder = charset.newEncoder();
+  return encoder.encode(str);
 }
 ```
 

package/kotlinx-charset-exported.d.ts

@@ -1,3 +1,29 @@
 type Nullable<T> = T | null | undefined
+export declare function getCharset(charsetName: string): XCharset;
 export declare function decode(charsetName: string, bytes: Uint8Array): string;
-export declare function encode(charsetName: string, value: string): Uint8Array;
+export declare function encode(charsetName: string, value: string): Uint8Array;
+export declare interface XCharset {
+    readonly name: string;
+    readonly aliases: Array<string>;
+    newDecoder(): XCharsetDecoder;
+    newEncoder(): XCharsetEncoder;
+    readonly __doNotUseOrImplementIt: {
+        readonly "com.github.lppedd.kotlinx.charset.exported.XCharset": unique symbol;
+    };
+}
+export declare interface XCharsetDecoder {
+    decode(bytes: Uint8Array): string;
+    setReplacement(newReplacement: Nullable<string>): void;
+    reset(): void;
+    readonly __doNotUseOrImplementIt: {
+        readonly "com.github.lppedd.kotlinx.charset.exported.XCharsetDecoder": unique symbol;
+    };
+}
+export declare interface XCharsetEncoder {
+    encode(value: string): Uint8Array;
+    setReplacement(newReplacement: Nullable<Uint8Array>): void;
+    reset(): void;
+    readonly __doNotUseOrImplementIt: {
+        readonly "com.github.lppedd.kotlinx.charset.exported.XCharsetEncoder": unique symbol;
+    };
+}