feat: prepare as pesde & npm package

* Add README with basic documentation
* Add exports.ts with required TS and Luau exports
* Add build script to extract Luau exports from exports.ts
* Setup pesde package manifest
* Apply formatting, setup stylua

.gitignore

@@ -1,4 +1,8 @@
+# ts 
 /node_modules
 /out
 /include
 *.tsbuildinfo
+
+# pesde
+*_packages/

.vscode/extensions.json

@@ -1,7 +1,3 @@
 {
-    "recommendations": [
-        "esbenp.prettier-vscode",
-        "dbaeumer.vscode-eslint",
-        "DavidAnson.vscode-markdownlint"
-    ]
+	"recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint", "DavidAnson.vscode-markdownlint"]
 }

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
 	"editor.formatOnSave": true,
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.defaultFormatter": "esbenp.prettier-vscode"
 }

README.md

@@ -1,3 +1,38 @@
 # pako-roblox-ts
 
 Fork of [pako](https://github.com/nodeca/pako) for Roblox-TS.
+
+## Installation
+
+Supported as a pesde (Luau) package and npm (roblox-ts) package:
+
+```sh
+# pesde
+pesde add 0x5eal/pako
+
+# roblox-ts
+npm add @rbxts/pako
+```
+
+## Usage
+
+### Luau
+
+```luau
+local serde = require("@lune/serde")
+local pako = require("./luau_packages/pako")
+
+local test = { my = "super", puper = { 456, 567 }, awesome = "pako" }
+local compressed = pako.deflate(serde.encode("json", test))
+local restored = serde.decode(pako.inflate(compressed, { to = "string" }))
+```
+
+### roblox-ts
+
+```ts
+import pako from "@rbxts/pako";
+
+const test = { my: "super", puper: [456, 567], awesome: "pako" };
+const compressed = pako.deflate(JSON.stringify(test));
+const restored = JSON.parse(pako.inflate(compressed, { to: "string" }));
+```

build.ts

@@ -0,0 +1,24 @@
+// extracts the Luau exports section from a given file path
+async function extractLuauExports(file: string): Promise<string | null> {
+	const input = await Bun.file(file).text();
+	const regex = /\/\/ @@@@@@@@@ LUAU_START @@@@@@@@@([\s\S]*?)\/\/ @@@@@@@@@ LUAU_END @@@@@@@@@/;
+	const match = input.match(regex);
+	if (match) {
+		// remove leading comment specifier from each line from each line
+		return match[1]
+			.split("\n")
+			.map((line) => line.replace(/\/\/\s?/, ""))
+			.join("\n")
+			.trim();
+	}
+
+	return null;
+}
+
+const EXPORTS_TS_FILE = "./src/exports.ts";
+const EXPORTS_LUAU_FILE = "./out/init.luau";
+
+console.log("extract and export Luau type thunk");
+await extractLuauExports(EXPORTS_TS_FILE).then((exports) => Bun.write(EXPORTS_LUAU_FILE, exports!));
+
+export {}; // treat as esmodule

package.json

@@ -1,10 +1,11 @@
 {
 	"name": "@rbxts/pako",
-  "version": "1.0.0",
+	"version": "0.1.0",
 	"description": "fork of pako for Roblox-TS",
 	"main": "out/init.lua",
 	"scripts": {
-    "build": "rbxtsc",
+		"build": "rbxtsc --verbose && bun run build.ts",
+		"fmt": "prettier -w . && stylua .",
 		"watch": "rbxtsc -w",
 		"prepublishOnly": "bun run build"
 	},
@@ -30,8 +31,10 @@
 		"access": "public"
 	},
 	"devDependencies": {
+		"@johnnymorganz/stylua-bin": "^2.0.2",
 		"@rbxts/compiler-types": "3.0.0-types.0",
 		"@rbxts/types": "^1.0.813",
+		"@types/bun": "^1.1.14",
 		"@typescript-eslint/eslint-plugin": "^8.18.2",
 		"@typescript-eslint/parser": "^8.18.2",
 		"eslint": "^9.17.0",
@@ -44,5 +47,8 @@
 	},
 	"patchedDependencies": {
 		"@rbxts/types@1.0.813": "patches/@rbxts%2Ftypes@1.0.813.patch"
-  }
+	},
+	"trustedDependencies": [
+		"@johnnymorganz/stylua-bin"
+	]
 }

pesde.lock

@@ -0,0 +1,3 @@
+name = "0x5eal/pako"
+version = "0.1.0"
+target = "luau"

pesde.toml

@@ -0,0 +1,30 @@
+name = "0x5eal/pako"
+version = "0.1.0"
+description = "ZLib port for JavaScript, compiled to Luau"
+repository = "https://github.com/0x5eal/rbxts-pako"
+license = "MIT"
+authors = [
+    "Andrei Tuputcyn (https://github.com/andr83)",
+    "Vitaly Puzrin (https://github.com/puzrin)",
+    "Friedel Ziegelmayer (https://github.com/dignifiedquire)",
+    "Kirill Efimov (https://github.com/Kirill89)",
+    "Jean-loup Gailly",
+    "Mark Adler",
+    "daimond113 (https://www.daimond113.com) <contact@daimond113.com>",
+    "Erica Marigold <hi@devcomp.xyz>"
+]
+
+includes = [
+    "pesde.toml", 
+    "README.md", 
+    "out/**/*.luau", 
+    "!out/*.tsbuildinfo", 
+    "!out/**/*.d.ts"
+]
+
+[target]
+environment = "luau"
+lib = "out/init.luau"
+
+[indices]
+default = "https://github.com/pesde-pkg/index"

src/deflate.ts

@@ -1,7 +1,7 @@
 "use strict";
 
 import type { DeflateState } from "./zlib/deflate";
-import type Messages from "./zlib/messages"
+import type Messages from "./zlib/messages";
 import type * as TypedArrays from "./utils/typedArrays";
 
 const { ZStream } = require("./zlib/zstream") as typeof import("./zlib/zstream");
@@ -14,7 +14,7 @@ const { Uint8Array } = require("./utils/typedArrays") as typeof TypedArrays;
 /* Public constants ==========================================================*/
 /* ===========================================================================*/
 
-export const {
+const {
 	Z_NO_FLUSH,
 	Z_SYNC_FLUSH,
 	Z_FULL_FLUSH,
@@ -113,7 +113,7 @@ export const {
  * ```
  **/
 
-type Options = {
+export type Options = {
 	level: number;
 	method: number;
 	chunkSize: number;

src/exports.ts

@@ -0,0 +1,176 @@
+//
+// Luau exports
+//
+
+// @@@@@@@@@ LUAU_START @@@@@@@@@
+// export type InflateOptions = {
+//   chunkSize: number?,
+//   windowBits: number?,
+//   to: string?,
+//   raw: boolean?,
+//   dictionary: (string | buffer)?
+// }
+//
+// export type InflateRawOptions = {
+//   chunkSize: number?,
+//   windowBits: number?,
+//   to: string?,
+//   dictionary: (string | buffer)?
+// }
+//
+// export type DeflateOptions = {
+//   level: number?,
+//   method: number?,
+//   chunkSize: number?,
+//   windowBits: number?,
+//   memLevel: number?,
+//   strategy: number?,
+//   raw: boolean?,
+//   gzip: boolean?,
+//   header: ({
+// 	    done: boolean?,
+// 	    time: number?,
+// 	    xflags: number?,
+// 	    os: number?,
+// 	    extra_len: number?,
+// 	    comment: string?,
+// 	    extra: buffer?,
+// 	    name: string?,
+// 	    hcrc: number?,
+// 	    text: number?,
+//   })?,
+//   dictionary: (buffer | string)?,
+// }
+//
+// export type DeflateRawOptions = {
+//   level: number?,
+//   method: number?,
+//   chunkSize: number?,
+//   windowBits: number?,
+//   memLevel: number?,
+//   strategy: number?,
+//   gzip: boolean?,
+//   header: ({
+// 	    done: boolean?,
+// 	    time: number?,
+// 	    xflags: number?,
+// 	    os: number?,
+// 	    extra_len: number?,
+// 	    comment: string?,
+// 	    extra: buffer?,
+// 	    name: string?,
+// 	    hcrc: number?,
+// 	    text: number?,
+//   })?,
+//   dictionary: (buffer | string)?,
+// }
+//
+// return require("./exports") :: {
+//    -- Inflate exports --
+//    Inflate: any, -- TODO: type Inflate class
+//    inflate: (input: string | buffer, options: InflateOptions?) -> (string | buffer)?,
+//    inflateRaw: (input: string | buffer, options: InflateRawOptions?) -> (string | buffer)?,
+//
+//    -- Deflate exports --
+//    Deflate: any, -- TODO: type Deflate class
+//    deflate: (input: string | buffer, options: DeflateOptions?) -> buffer?,
+//    deflateRaw: (input: string | buffer, options: DeflateRawOptions?) -> buffer?,
+// }
+// @@@@@@@@@ LUAU_END @@@@@@@@@
+
+const { Uint8Array } = require("./utils/typedArrays") as typeof import("./utils/typedArrays");
+
+//
+// Type exports
+//
+
+import type { Options as InflateOptionsInner } from "./inflate";
+import type { Options as DeflateOptionsInner } from "./deflate";
+export type InflateOptions = Omit<InflateOptionsInner, "dictionary"> & {
+	dictionary?: string | buffer;
+};
+export type DeflateOptions = Omit<DeflateOptionsInner, "dictionary"> & {
+	dictionary?: string | buffer;
+};
+
+//
+// Inflate exports
+//
+
+const {
+	Inflate,
+	inflate: inflateImpl,
+	inflateRaw: inflateRawImpl,
+} = require("./inflate") as typeof import("./inflate");
+
+export function inflate(input: string | buffer, options?: Partial<InflateOptions>): string | buffer | undefined {
+	const inputArray = Uint8Array.from(typeIs(input, "string") ? buffer.fromstring(input) : input);
+	const modifiedOptions = options as Partial<InflateOptionsInner>;
+	if (typeIs(options?.dictionary, "buffer")) {
+		modifiedOptions.dictionary = Uint8Array.from(options.dictionary);
+	}
+
+	return inflateImpl(inputArray, modifiedOptions);
+}
+
+export function inflateRaw(
+	input: string | buffer,
+	options?: Exclude<Partial<InflateOptions>, "raw">,
+): string | buffer | undefined {
+	const inputArray = Uint8Array.from(typeIs(input, "string") ? buffer.fromstring(input) : input);
+	const modifiedOptions = options as Exclude<Partial<InflateOptionsInner>, "raw">;
+	if (typeIs(options?.dictionary, "buffer")) {
+		modifiedOptions.dictionary = Uint8Array.from(options.dictionary);
+	}
+
+	return inflateRawImpl(inputArray, modifiedOptions);
+}
+
+export { Inflate };
+
+//
+// Deflate exports
+//
+
+const {
+	Deflate,
+	deflate: deflateImpl,
+	deflateRaw: deflateRawImpl,
+} = require("./deflate") as typeof import("./deflate");
+
+export function deflate(input: string | buffer, options?: Partial<DeflateOptions>): buffer | undefined {
+	const inputArray = Uint8Array.from(typeIs(input, "string") ? buffer.fromstring(input) : input);
+	const modifiedOptions = options as Partial<DeflateOptionsInner>;
+	if (typeIs(modifiedOptions?.dictionary, "buffer")) {
+		modifiedOptions.dictionary = Uint8Array.from(modifiedOptions.dictionary);
+	}
+	if (typeIs(modifiedOptions?.header?.extra, "buffer")) {
+		modifiedOptions.header.extra = Uint8Array.from(modifiedOptions.header.extra);
+	}
+
+	return deflateImpl(inputArray, modifiedOptions);
+}
+
+export function deflateRaw(
+	input: string | buffer,
+	options?: Exclude<Partial<DeflateOptions>, "raw">,
+): buffer | undefined {
+	const inputArray = Uint8Array.from(typeIs(input, "string") ? buffer.fromstring(input) : input);
+	const modifiedOptions = options as Exclude<Partial<DeflateOptionsInner>, "raw">;
+	if (typeIs(modifiedOptions?.dictionary, "buffer")) {
+		modifiedOptions.dictionary = Uint8Array.from(modifiedOptions.dictionary);
+	}
+	if (typeIs(modifiedOptions?.header?.extra, "buffer")) {
+		modifiedOptions.header.extra = Uint8Array.from(modifiedOptions.header.extra);
+	}
+
+	return deflateRawImpl(inputArray, modifiedOptions);
+}
+
+export { Deflate };
+
+//
+// Constants exports
+//
+
+export const constants = require("./zlib/constants") as typeof import("./zlib/constants");

src/inflate.ts

@@ -14,16 +14,8 @@ const { assign, flattenChunks } = require("./utils/common") as typeof import("./
 
 /* Public constants ==========================================================*/
 /* ===========================================================================*/
-export const {
-	Z_NO_FLUSH,
-	Z_FINISH,
-	Z_OK,
-	Z_STREAM_END,
-	Z_NEED_DICT,
-	Z_STREAM_ERROR,
-	Z_DATA_ERROR,
-	Z_MEM_ERROR,
-} = require("./zlib/constants") as typeof import("./zlib/constants");
+const { Z_NO_FLUSH, Z_FINISH, Z_OK, Z_STREAM_END, Z_NEED_DICT, Z_STREAM_ERROR, Z_DATA_ERROR, Z_MEM_ERROR } =
+	require("./zlib/constants") as typeof import("./zlib/constants");
 
 /* ===========================================================================*/
 
@@ -104,7 +96,7 @@ export const {
  * ```
  **/
 
-type Options = {
+export type Options = {
 	chunkSize: number;
 	windowBits: number;
 	to: string;

src/zlib/README.md

@@ -21,9 +21,7 @@ Copyright:
 (C) 1995-2013 Jean-loup Gailly and Mark Adler
 (C) 2014-2017 Vitaly Puzrin and Andrey Tupitsin
 
-
-From zlib's README
-=============================================================================
+# From zlib's README
 
 Acknowledgments:
 
@@ -54,6 +52,5 @@ freely, subject to the following restrictions:
    misrepresented as being the original software.
 3. This notice may not be removed or altered from any source distribution.
 
-
 Jean-loup Gailly Mark Adler
 jloup@gzip.org madler@alumni.caltech.edu

src/zlib/deflate.ts

@@ -24,7 +24,8 @@ import type { TreeDesc } from "./trees";
 import type Messages from "./messages";
 import type * as TypedArrays from "../utils/typedArrays";
 
-const { _tr_init, _tr_stored_block, _tr_flush_block, _tr_tally, _tr_align } = require("./trees") as typeof import("./trees");
+const { _tr_init, _tr_stored_block, _tr_flush_block, _tr_tally, _tr_align } =
+	require("./trees") as typeof import("./trees");
 const { adler32 } = require("./adler32") as typeof import("./adler32");
 const { crc32 } = require("./crc32") as typeof import("./crc32");
 const {

tsconfig.json

@@ -23,5 +23,7 @@
 		"incremental": true,
 		"tsBuildInfoFile": "out/tsconfig.tsbuildinfo",
 		"declaration": true
-	}
+	},
+
+	"include": ["src/**/*.ts"]
 }