smolcanon 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning].
+
+This change log follows the format documented in [Keep a CHANGELOG].
+
+[semantic versioning]: http://semver.org/
+[keep a changelog]: http://keepachangelog.com/
+
+## v0.1.0 - 2025-08-17
+
+Initial version

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright © 2025 Sasha Koss
+
+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

@@ -0,0 +1,38 @@
+# Smol xxHash
+
+Tiny [xxHash](https://xxhash.com/) JS implementation.
+
+It is a modern, faster and smaller alternative to [xxhashjs](https://www.npmjs.com/package/xxhashjs) package. It is 3.8x faster and fits in just `381B`.
+
+It is just 1.8x slower than [xxhash-wasm](https://www.npmjs.com/package/xxhash-wasm) package.
+
+It features dual CJS/ESM support and built-in TypeScript definitions.
+
+It is based on [a reference C implementation](https://github.com/easyaspi314/xxhash-clean/blob/86a04ab3f01277049a23f6c9e2c4a6c174ff50c4/xxhash32-ref.c)
+
+## Installation
+
+The package is available on npm:
+
+```sh
+npm install smolxxh
+```
+
+## Usage
+
+Pass `Buffer` or `Uint8Array` to `xxh32` function to get the hash of the content:
+
+```ts
+import { xxh32 } from "smolxxh";
+
+xxh32(Buffer.from("hello world", "utf8")).toString(16);
+// => 0x31b7405d
+```
+
+## Changelog
+
+See [the changelog](./CHANGELOG.md).
+
+## License
+
+[MIT © Sasha Koss](https://koss.nocorp.me/mit/)

package/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+exports.canonize = canonize;
+/**
+ * Canonicalizes the input value as a string to use for hashing. It sorts keys,
+ * making sure deeply equal objects produce the same string.
+ *
+ * This version doesn't handle any instance types, such as custom classes, Date,
+ * Map, Set, etc.
+ *
+ * @param input - The value to canonicalize.
+ * @returns The canonicalized string representation of the input.
+ */
+function canonize(input) {
+  if (typeof input !== "object" || !input) {
+    if (Object.is(input, -0)) return "-0";
+    if (typeof input === "string") return JSON.stringify(input);
+    return String(input);
+  }
+  let canon = "";
+  for (const key of Object.keys(input).sort()) {
+    canon += `${key}:${canonize(input[key])};`;
+  }
+  return Array.isArray(input) ? `[${canon}]` : `{${canon}}`;
+}

package/index.d.cts

@@ -0,0 +1,11 @@
+/**
+ * Canonicalizes the input value as a string to use for hashing. It sorts keys,
+ * making sure deeply equal objects produce the same string.
+ *
+ * This version doesn't handle any instance types, such as custom classes, Date,
+ * Map, Set, etc.
+ *
+ * @param input - The value to canonicalize.
+ * @returns The canonicalized string representation of the input.
+ */
+export declare function canonize(input: unknown): string;

package/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Canonicalizes the input value as a string to use for hashing. It sorts keys,
+ * making sure deeply equal objects produce the same string.
+ *
+ * This version doesn't handle any instance types, such as custom classes, Date,
+ * Map, Set, etc.
+ *
+ * @param input - The value to canonicalize.
+ * @returns The canonicalized string representation of the input.
+ */
+export declare function canonize(input: unknown): string;

package/index.js

@@ -0,0 +1,22 @@
+/**
+ * Canonicalizes the input value as a string to use for hashing. It sorts keys,
+ * making sure deeply equal objects produce the same string.
+ *
+ * This version doesn't handle any instance types, such as custom classes, Date,
+ * Map, Set, etc.
+ *
+ * @param input - The value to canonicalize.
+ * @returns The canonicalized string representation of the input.
+ */
+export function canonize(input) {
+  if (typeof input !== "object" || !input) {
+    if (Object.is(input, -0)) return "-0";
+    if (typeof input === "string") return JSON.stringify(input);
+    return String(input);
+  }
+  let canon = "";
+  for (const key of Object.keys(input).sort()) {
+    canon += `${key}:${canonize(input[key])};`;
+  }
+  return Array.isArray(input) ? `[${canon}]` : `{${canon}}`;
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "smolcanon",
+  "version": "0.1.0",
+  "description": "Tiny JS objects canonicalization for hashing",
+  "type": "module",
+  "main": "index.cjs",
+  "module": "index.js",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "require": {
+        "types": "./index.d.cts",
+        "default": "./index.cjs"
+      },
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      }
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kossnocorp/smolcanon.git"
+  },
+  "keywords": [
+    "tiny",
+    "hashing",
+    "canonicalization",
+    "serialization"
+  ],
+  "author": "Sasha Koss <koss@nocorp.me>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kossnocorp/smolcanon/issues"
+  },
+  "homepage": "https://github.com/kossnocorp/smolcanon#readme",
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.16.4",
+    "@babel/cli": "^7.28.3",
+    "@babel/core": "^7.28.3",
+    "@babel/plugin-transform-modules-commonjs": "^7.27.1",
+    "@babel/preset-env": "^7.28.3",
+    "@babel/preset-typescript": "^7.27.1",
+    "@parcel/watcher": "^2.5.1",
+    "@swc/core": "^1.13.3",
+    "@types/xxhashjs": "^0.2.4",
+    "babel-plugin-replace-import-extension": "^1.1.5",
+    "bytes-iec": "^3.1.1",
+    "glob": "^10.4.5",
+    "minimatch": "^10.0.3",
+    "picocolors": "^1.1.1",
+    "tsx": "^4.20.4",
+    "typescript": "^5.9.2",
+    "vitest": "^1.6.1"
+  },
+  "scripts": {
+    "test": "vitest run"
+  }
+}