farmhashjs 1.0.0

package/LICENSE

@@ -0,0 +1,216 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Google Inc.
+   Copyright 2026 Crisp IM SAS
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+-------------------------------------------------------------------------------
+
+This project is a pure JavaScript/TypeScript port of Google's FarmHash
+(https://github.com/google/farmhash), specifically the farmhashna::Hash64
+(Fingerprint64) implementation.
+
+The original FarmHash library is:
+  Copyright 2014 Google Inc.
+  Licensed under the MIT License
+
+This JavaScript port is:
+  Copyright 2026 Crisp IM SAS
+  Licensed under the Apache License, Version 2.0

package/README.md

@@ -0,0 +1,108 @@
+# farmhashjs
+
+Pure JavaScript implementation of Google's [FarmHash](https://github.com/google/farmhash) algorithm. No native dependencies, works in Node.js and browsers.
+
+## Why?
+
+The native `farmhash` npm package requires C++ compilation, which can be problematic:
+- Fails on some platforms (Windows, Alpine Linux, etc.)
+- Requires node-gyp and build tools
+- Doesn't work in browsers or edge runtimes
+
+`farmhashjs` provides the same hash outputs with zero native dependencies.
+
+## Installation
+
+```bash
+npm install farmhashjs
+```
+
+## Usage
+
+```javascript
+import { fingerprint64, fingerprint32, legacyHash64, legacyHash32 } from 'farmhashjs';
+
+// Modern stable fingerprints (recommended)
+fingerprint64('hello world');  // "6381520714923946011"
+fingerprint32('hello world');  // 430397466
+
+// Legacy hashes (compatible with farmhash@3.3.1)
+legacyHash64('hello world');   // "16022978042064026561"
+legacyHash32('hello world');   // 3602808830
+```
+
+## API
+
+### Modern Functions (Stable Fingerprints)
+
+These produce stable hashes guaranteed to be consistent across all platforms and versions.
+
+| Function | Returns | Description |
+|----------|---------|-------------|
+| `fingerprint64(input)` | `string` | 64-bit hash as decimal string |
+| `fingerprint64BigInt(input)` | `bigint` | 64-bit hash as BigInt |
+| `fingerprint32(input)` | `number` | 32-bit hash as number |
+
+### Legacy Functions (farmhash v3.x Compatible)
+
+These are compatible with `farmhash@3.3.1` which was compiled with `FARMHASH_DEBUG=1`.
+
+| Function | Returns | Description |
+|----------|---------|-------------|
+| `legacyHash64(input)` | `string` | 64-bit hash as decimal string |
+| `legacyHash64BigInt(input)` | `bigint` | 64-bit hash as BigInt |
+| `legacyHash32(input)` | `number` | 32-bit hash as number |
+
+### Aliases
+
+```javascript
+import { hash64, hash32 } from 'farmhashjs';
+
+// hash64 = fingerprint64
+// hash32 = fingerprint32
+```
+
+## Compatibility
+
+Tested against native implementations:
+
+| Function | Compared Against |
+|----------|------------------|
+| `fingerprint64` | `farmhash@5.0.0` fingerprint64 |
+| `fingerprint32` | `farmhash@5.0.0` fingerprint32 |
+| `legacyHash64` | `farmhash@3.3.1` hash64 |
+| `legacyHash32` | `farmhash@3.3.1` hash32 |
+
+## Performance
+
+Benchmarked on Apple M1:
+
+| Function | 44 bytes | 500 bytes | 5 KB |
+|----------|----------|-----------|------|
+| `fingerprint32` | 251 ns/op | 903 ns/op | 9 µs/op |
+| `fingerprint64` | 843 ns/op | 7 µs/op | 65 µs/op |
+| `legacyHash32` | 302 ns/op | 974 ns/op | 9 µs/op |
+| `legacyHash64` | 1.1 µs/op | 6.8 µs/op | 58 µs/op |
+
+32-bit functions are faster because they use native `number` operations. 64-bit functions use `BigInt` which has more overhead.
+
+For comparison, native C++ (`farmhash@5.0.0`) is ~2-10x faster depending on input size.
+
+## When to Use
+
+**Use `farmhashjs` when:**
+- You need cross-platform compatibility
+- You're running in browsers, Cloudflare Workers, or edge runtimes
+- You can't compile native modules
+- You're hashing moderate volumes (< 100K hashes/second)
+
+**Use native `farmhash` when:**
+- Maximum performance is critical
+- You're in a Node.js environment that supports native modules
+- You're hashing millions of strings per second
+
+## License
+
+Apache-2.0
+
+This is a port of Google's FarmHash. Original FarmHash is Copyright 2014 Google Inc.

package/dist/index.d.ts

@@ -0,0 +1,90 @@
+/**
+ * farmhashjs - Pure JavaScript implementation of Google's FarmHash
+ *
+ * Copyright (c) 2025 Crisp IM SAS
+ * Licensed under the Apache-2.0 License
+ *
+ * This module provides both legacy-compatible and modern stable hash functions:
+ *
+ * Legacy (v3.x compatible):
+ *   - legacyHash64(): Compatible with farmhash v3.3.1 hash64()
+ *   - legacyHash32(): Compatible with farmhash v3.3.1 hash32()
+ *
+ * Modern (stable fingerprints):
+ *   - fingerprint64(): Stable 64-bit hash (same as farmhash fingerprint64)
+ *   - fingerprint32(): Stable 32-bit hash (same as farmhash fingerprint32)
+ *
+ * The difference is that legacy functions apply a "DebugTweak" transformation
+ * that was present in farmhash v3.x (compiled with FARMHASH_DEBUG=1).
+ * Modern fingerprint functions are guaranteed stable across all platforms.
+ */
+/**************************************************************************
+ * PUBLIC API - LEGACY (with DebugTweak, compatible with farmhash v3.3.1)
+ ***************************************************************************/
+/**
+ * Compute a 64-bit hash compatible with farmhash v3.3.1 hash64()
+ * @param input - The string to hash
+ * @returns The hash as a decimal string
+ */
+export declare function legacyHash64(input: string): string;
+/**
+ * Compute a 64-bit hash compatible with farmhash v3.3.1 hash64()
+ * @param input - The string to hash
+ * @returns The hash as a BigInt
+ */
+export declare function legacyHash64BigInt(input: string): bigint;
+/**
+ * Compute a 32-bit hash compatible with farmhash v3.3.1 hash32()
+ * @param input - The string to hash
+ * @returns The hash as a number
+ */
+export declare function legacyHash32(input: string): number;
+/**************************************************************************
+ * PUBLIC API - MODERN (stable fingerprints, same as farmhash v5)
+ ***************************************************************************/
+/**
+ * Compute a stable 64-bit fingerprint hash
+ * This is guaranteed stable across all platforms and versions.
+ * @param input - The string to hash
+ * @returns The hash as a decimal string
+ */
+export declare function fingerprint64(input: string): string;
+/**
+ * Compute a stable 64-bit fingerprint hash
+ * This is guaranteed stable across all platforms and versions.
+ * @param input - The string to hash
+ * @returns The hash as a BigInt
+ */
+export declare function fingerprint64BigInt(input: string): bigint;
+/**
+ * Compute a stable 32-bit fingerprint hash
+ * This is guaranteed stable across all platforms and versions.
+ * @param input - The string to hash
+ * @returns The hash as a number
+ */
+export declare function fingerprint32(input: string): number;
+/**************************************************************************
+ * ALIASES
+ ***************************************************************************/
+/** Alias for fingerprint64 */
+export declare const hash64: typeof fingerprint64;
+/** Alias for fingerprint64BigInt */
+export declare const hash64BigInt: typeof fingerprint64BigInt;
+/** Alias for fingerprint32 */
+export declare const hash32: typeof fingerprint32;
+/**************************************************************************
+ * DEFAULT EXPORT
+ ***************************************************************************/
+declare const _default: {
+    legacyHash64: typeof legacyHash64;
+    legacyHash64BigInt: typeof legacyHash64BigInt;
+    legacyHash32: typeof legacyHash32;
+    fingerprint64: typeof fingerprint64;
+    fingerprint64BigInt: typeof fingerprint64BigInt;
+    fingerprint32: typeof fingerprint32;
+    hash64: typeof fingerprint64;
+    hash64BigInt: typeof fingerprint64BigInt;
+    hash32: typeof fingerprint32;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AA4fH;;6EAE6E;AAE7E;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIxD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED;;6EAE6E;AAE7E;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAGnD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAGnD;AAED;;6EAE6E;AAE7E,8BAA8B;AAC9B,eAAO,MAAM,MAAM,sBAAgB,CAAC;AAEpC,oCAAoC;AACpC,eAAO,MAAM,YAAY,4BAAsB,CAAC;AAEhD,8BAA8B;AAC9B,eAAO,MAAM,MAAM,sBAAgB,CAAC;AAEpC;;6EAE6E;;;;;;;;;;;;AAE7E,wBAaE"}