Add basic types for sub-encoder

types/sub-encoder/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/sub-encoder/index.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+
+type JsonPrimitive = string | number | boolean | null;
+type JsonArray = SubEncoder.JsonValue[];
+interface JsonObject {
+    [key: string]: undefined | SubEncoder.JsonValue;
+}
+
+interface Encoding<TInput, TOutput = TInput> {
+    input: TInput;
+    output: TOutput;
+}
+
+interface EncodingLookup {
+    ascii: Encoding<string>;
+    base64: Encoding<string>;
+    binary: Encoding<string | Buffer, Buffer>;
+    hex: Encoding<string>;
+    json: Encoding<SubEncoder.JsonValue>;
+    ndjson: Encoding<SubEncoder.JsonValue>;
+    ucs2: Encoding<string>;
+    "utf-8": Encoding<string>;
+    utf16le: Encoding<string>;
+}
+
+declare class SubEncoder<T extends keyof EncodingLookup = "binary"> {
+    /**
+     * Create a new SubEncoder. Optionally set the initial prefix and encoding.
+     *
+     * `prefix` can be string or Buffer.
+     */
+    constructor(prefix?: null | string | Buffer, encoding?: T);
+
+    /**
+     * Encode a key.
+     */
+    encode(key: EncodingLookup[T]["input"]): Buffer;
+
+    /**
+     * Decode a key.
+     */
+    decode(buf: Buffer): EncodingLookup[T]["output"];
+}
+
+declare namespace SubEncoder {
+    type JsonValue = JsonPrimitive | JsonArray | JsonObject;
+}
+
+export = SubEncoder;

types/sub-encoder/package.json

@@ -0,0 +1,20 @@
+{
+    "private": true,
+    "name": "@types/sub-encoder",
+    "version": "2.1.9999",
+    "projects": [
+        "https://github.com/holepunchto/sub-encoder#readme"
+    ],
+    "dependencies": {
+        "@types/node": "*"
+    },
+    "devDependencies": {
+        "@types/sub-encoder": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Evan Hahn",
+            "githubUsername": "EvanHahn"
+        }
+    ]
+}

types/sub-encoder/sub-encoder-tests.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+
+import SubEncoder = require("sub-encoder");
+import type { JsonValue } from "sub-encoder";
+
+{
+    const enc = new SubEncoder();
+
+    enc.encode("str"); // $ExpectType Buffer
+    enc.encode(Buffer.alloc(0)); // $ExpectType Buffer
+    enc.decode(Buffer.alloc(0)); // $ExpectType Buffer
+
+    // @ts-expect-error
+    enc.encode(123);
+}
+
+{
+    const enc = new SubEncoder(null, "binary");
+
+    enc.encode(""); // $ExpectType Buffer
+    enc.encode(Buffer.alloc(0)); // $ExpectType Buffer
+    enc.decode(Buffer.alloc(0)); // $ExpectType Buffer
+
+    // @ts-expect-error
+    enc.encode(123);
+}
+
+{
+    const STRING_ENCODINGS = ["ascii", "base64", "utf-8", "hex", "ucs2", "utf16le"] as const;
+
+    for (const encoding of STRING_ENCODINGS) {
+        const enc = new SubEncoder(null, encoding);
+        enc.encode(""); // $ExpectType Buffer
+        enc.decode(Buffer.alloc(0)); // $ExpectType string
+    }
+
+    // @ts-expect-error
+    enc.encode(Buffer.alloc(0));
+}
+
+{
+    const JSON_ENCODING = ["json", "ndjson"] as const;
+
+    for (const encoding of JSON_ENCODING) {
+        const enc = new SubEncoder(null, encoding);
+        enc.encode({ foo: "bar" }); // $ExpectType Buffer
+        enc.decode(Buffer.alloc(0)); // $ExpectType JsonValue
+    }
+}

types/sub-encoder/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": ["index.d.ts", "sub-encoder-tests.ts"]
+}