@stryke/hash 0.8.3 → 0.9.0

package/README.md

@@ -22,7 +22,7 @@ This package is part of Storm Software's **🌩️ Stryke** monorepo. Stryke pac
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.8.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/stryke/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.8.3-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/stryke/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 > [!IMPORTANT] This repository, and the apps, libraries, and tools contained
 > within, is still in it's initial development phase. As a result, bugs and

package/dist/hash.cjs

@@ -4,11 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.hash = hash;
-var _isString = require("@stryke/type-checks/is-string");
-var _hashObject = require("./hash-object.cjs");
-var _sha = require("./sha-256.cjs");
-function hash(t, e) {
-  const s = (0, _sha.sha256base64)((0, _isString.isString)(t) ? t : (0, _hashObject.hashObject)(t, e)),
+var _ohash = require("ohash");
+function hash(s, e) {
+  const t = (0, _ohash.hash)(s),
     n = e?.maxLength ?? 32;
-  return s.length > n ? s.slice(0, n) : s;
+  return t.length > n ? t.slice(0, n) : t;
 }

package/dist/hash.d.ts

@@ -1,5 +1,4 @@
-import type { HashObjectOptions } from "./hash-object";
-export interface HashOptions extends HashObjectOptions {
+export interface HashOptions {
     /**
      * The maximum length of the hash
      *

package/dist/hash.mjs

@@ -1 +1 @@
-import{isString as r}from"@stryke/type-checks/is-string";import{hashObject as h}from"./hash-object";import{sha256base64 as a}from"./sha-256";export function hash(t,e){const s=a(r(t)?t:h(t,e)),n=e?.maxLength??32;return s.length>n?s.slice(0,n):s}
+import{hash as h}from"ohash";export function hash(s,e){const t=h(s),n=e?.maxLength??32;return t.length>n?t.slice(0,n):t}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/hash",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "type": "module",
   "description": "A package containing utility functions that hash data using various algorithms.",
   "repository": {
@@ -11,8 +11,8 @@
   "private": false,
   "dependencies": {
     "js-xxhash": "^4.0.0",
-    "@stryke/fs": ">=0.10.4",
-    "@stryke/type-checks": ">=0.1.3"
+    "ohash": "^2.0.11",
+    "@stryke/fs": ">=0.10.5"
   },
   "publishConfig": { "access": "public" },
   "devDependencies": {},
@@ -114,20 +114,6 @@
       "require": { "types": "./dist/hash.d.ts", "default": "./dist/hash.cjs" },
       "default": { "types": "./dist/hash.d.ts", "default": "./dist/hash.mjs" }
     },
-    "./hash-object": {
-      "import": {
-        "types": "./dist/hash-object.d.ts",
-        "default": "./dist/hash-object.mjs"
-      },
-      "require": {
-        "types": "./dist/hash-object.d.ts",
-        "default": "./dist/hash-object.cjs"
-      },
-      "default": {
-        "types": "./dist/hash-object.d.ts",
-        "default": "./dist/hash-object.mjs"
-      }
-    },
     "./hash-files": {
       "import": {
         "types": "./dist/hash-files.d.ts",

package/dist/hash-object.cjs

@@ -1,230 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.hashObject = hashObject;
-const f = Object.freeze({
-  ignoreUnknown: !1,
-  respectType: !1,
-  respectFunctionNames: !1,
-  respectFunctionProperties: !1,
-  unorderedObjects: !0,
-  unorderedArrays: !1,
-  unorderedSets: !1,
-  excludeKeys: void 0,
-  excludeValues: void 0,
-  replacer: void 0
-});
-function hashObject(t, o) {
-  o ? o = {
-    ...f,
-    ...o
-  } : o = f;
-  const u = p(o);
-  return u.dispatch(t), u.toString();
-}
-const b = Object.freeze(["prototype", "__proto__", "constructor"]);
-function p(t) {
-  let o = "",
-    u = new Map();
-  const r = e => {
-    o += e;
-  };
-  return {
-    toString() {
-      return o;
-    },
-    getContext() {
-      return u;
-    },
-    dispatch(e) {
-      return t.replacer && (e = t.replacer(e)), this[e === null ? "null" : typeof e](e);
-    },
-    object(e) {
-      if (e && typeof e.toJSON == "function") return this.object(e.toJSON());
-      const n = Object.prototype.toString.call(e);
-      let a = "";
-      const y = n.length;
-      y < 10 ? a = `unknown:[${n}]` : a = n.slice(8, y - 1), a = a.toLowerCase();
-      let l = null;
-      if ((l = u.get(e)) === void 0) u.set(e, u.size);else return this.dispatch(`[CIRCULAR:${l}]`);
-      if (typeof Buffer < "u" && Buffer.isBuffer && Buffer.isBuffer(e)) return r("buffer:"), r(e.toString("utf8"));
-      if (a !== "object" && a !== "function" && a !== "asyncfunction") this[a] ? this[a](e) : t.ignoreUnknown || this.unknown(e, a);else {
-        let i = Object.keys(e);
-        t.unorderedObjects && (i = i.sort());
-        let c = [];
-        t.respectType !== !1 && !g(e) && (c = b), t.excludeKeys && (i = i.filter(s => !t.excludeKeys(s)), c = c.filter(s => !t.excludeKeys(s))), r(`object:${i.length + c.length}:`);
-        const d = s => {
-          this.dispatch(s), r(":"), t.excludeValues || this.dispatch(e[s]), r(",");
-        };
-        for (const s of i) d(s);
-        for (const s of c) d(s);
-      }
-    },
-    array(e, n) {
-      if (n = n === void 0 ? t.unorderedArrays !== !1 : n, r(`array:${e.length}:`), !n || e.length <= 1) {
-        for (const l of e) this.dispatch(l);
-        return;
-      }
-      const a = new Map(),
-        y = e.map(l => {
-          const i = p(t);
-          i.dispatch(l);
-          for (const [c, d] of i.getContext()) a.set(c, d);
-          return i.toString();
-        });
-      return u = a, y.sort(), this.array(y, !1);
-    },
-    date(e) {
-      return r(`date:${e.toJSON()}`);
-    },
-    symbol(e) {
-      return r(`symbol:${e.toString()}`);
-    },
-    unknown(e, n) {
-      if (r(n), !!e && (r(":"), e && typeof e.entries == "function")) return this.array(Array.from(e.entries()), !0);
-    },
-    error(e) {
-      return r(`error:${e.toString()}`);
-    },
-    boolean(e) {
-      return r(`bool:${e}`);
-    },
-    string(e) {
-      r(`string:${e.length}:`), r(e);
-    },
-    function(e) {
-      r("fn:"), g(e) ? this.dispatch("[native]") : this.dispatch(e.toString()), t.respectFunctionNames !== !1 && this.dispatch(`function-name:${String(e.name)}`), t.respectFunctionProperties && this.object(e);
-    },
-    number(e) {
-      return r(`number:${e}`);
-    },
-    xml(e) {
-      return r(`xml:${e.toString()}`);
-    },
-    null() {
-      return r("Null");
-    },
-    undefined() {
-      return r("Undefined");
-    },
-    regexp(e) {
-      return r(`regex:${e.toString()}`);
-    },
-    uint8array(e) {
-      return r("uint8array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    uint8clampedarray(e) {
-      return r("uint8clampedarray:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    int8array(e) {
-      return r("int8array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    uint16array(e) {
-      return r("uint16array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    int16array(e) {
-      return r("int16array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    uint32array(e) {
-      return r("uint32array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    int32array(e) {
-      return r("int32array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    float32array(e) {
-      return r("float32array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    float64array(e) {
-      return r("float64array:"), this.dispatch(Array.prototype.slice.call(e));
-    },
-    arraybuffer(e) {
-      return r("arraybuffer:"), this.dispatch(new Uint8Array(e));
-    },
-    url(e) {
-      return r(`url:${e.toString()}`);
-    },
-    map(e) {
-      r("map:");
-      const n = [...e];
-      return this.array(n, t.unorderedSets !== !1);
-    },
-    set(e) {
-      r("set:");
-      const n = [...e];
-      return this.array(n, t.unorderedSets !== !1);
-    },
-    file(e) {
-      return r("file:"), this.dispatch([e.name, e.size, e.type, e.lastModfied]);
-    },
-    blob() {
-      if (t.ignoreUnknown) return r("[blob]");
-      throw new Error(`Hashing Blob objects is currently not supported
-Use "options.replacer" or "options.ignoreUnknown"
-`);
-    },
-    domwindow() {
-      return r("domwindow");
-    },
-    bigint(e) {
-      return r(`bigint:${e.toString()}`);
-    },
-    process() {
-      return r("process");
-    },
-    timer() {
-      return r("timer");
-    },
-    pipe() {
-      return r("pipe");
-    },
-    tcp() {
-      return r("tcp");
-    },
-    udp() {
-      return r("udp");
-    },
-    tty() {
-      return r("tty");
-    },
-    statwatcher() {
-      return r("statwatcher");
-    },
-    securecontext() {
-      return r("securecontext");
-    },
-    connection() {
-      return r("connection");
-    },
-    zlib() {
-      return r("zlib");
-    },
-    context() {
-      return r("context");
-    },
-    nodescript() {
-      return r("nodescript");
-    },
-    httpparser() {
-      return r("httpparser");
-    },
-    dataview() {
-      return r("dataview");
-    },
-    signal() {
-      return r("signal");
-    },
-    fsevent() {
-      return r("fsevent");
-    },
-    tlswrap() {
-      return r("tlswrap");
-    }
-  };
-}
-const h = "[native code] }",
-  w = h.length;
-function g(t) {
-  return typeof t != "function" ? !1 : Function.prototype.toString.call(t).slice(-w) === h;
-}

package/dist/hash-object.d.ts

@@ -1,71 +0,0 @@
-export interface HashObjectOptions {
-    /**
-     * Function to determine if a key should be excluded from hashing.
-     * @optional
-     * @param key - The key to check for exclusion.
-     * @returns {boolean} - Returns true to exclude the key from hashing.
-     */
-    excludeKeys?: ((key: string) => boolean) | undefined;
-    /**
-     * Specifies whether to exclude values from hashing, so that only the object keys are hashed.
-     * @optional
-     */
-    excludeValues?: boolean | undefined;
-    /**
-     * Specifies whether to ignore objects of unknown type (not directly serialisable) when hashing.
-     * @optional
-     * @default false
-     */
-    ignoreUnknown?: boolean | undefined;
-    /**
-     * A function that replaces values before they are hashed, which can be used to customise the hashing process.
-     * @optional
-     * @param value - The current value to be hashed.
-     * @returns {any} - The value to use for hashing instead.
-     */
-    replacer?: ((value: any) => any) | undefined;
-    /**
-     * Specifies whether the 'name' property of functions should be taken into account when hashing.
-     * @optional
-     * @default false
-     */
-    respectFunctionNames?: boolean | undefined;
-    /**
-     * Specifies whether properties of functions should be taken into account when hashing.
-     * @optional
-     * @default false
-     */
-    respectFunctionProperties?: boolean | undefined;
-    /**
-     * Specifies whether to include type-specific properties such as prototype or constructor in the hash to distinguish between types.
-     * @optional
-     * @default false
-     */
-    respectType?: boolean | undefined;
-    /**
-     * Specifies whether arrays should be sorted before hashing to ensure consistent order.
-     * @optional
-     * @default false
-     */
-    unorderedArrays?: boolean | undefined;
-    /**
-     * Specifies whether Set and Map instances should be sorted by key before hashing to ensure consistent order.
-     * @optional
-     * @default true
-     */
-    unorderedObjects?: boolean | undefined;
-    /**
-     * Specifies whether the elements of `Set' and keys of `Map' should be sorted before hashing to ensure consistent order.
-     * @optional
-     * @default false
-     */
-    unorderedSets?: boolean | undefined;
-}
-/**
- * Serialize any JS value into a stable, hashable string
- * @param {object} object value to hash
- * @param {HashObjectOptions} options hashing options. See {@link HashObjectOptions}.
- * @return {string} serialized value
- * @api public
- */
-export declare function hashObject(object: any, options?: HashObjectOptions): string;

package/dist/hash-object.mjs

@@ -1,3 +0,0 @@
-const f=Object.freeze({ignoreUnknown:!1,respectType:!1,respectFunctionNames:!1,respectFunctionProperties:!1,unorderedObjects:!0,unorderedArrays:!1,unorderedSets:!1,excludeKeys:void 0,excludeValues:void 0,replacer:void 0});export function hashObject(t,o){o?o={...f,...o}:o=f;const u=p(o);return u.dispatch(t),u.toString()}const b=Object.freeze(["prototype","__proto__","constructor"]);function p(t){let o="",u=new Map;const r=e=>{o+=e};return{toString(){return o},getContext(){return u},dispatch(e){return t.replacer&&(e=t.replacer(e)),this[e===null?"null":typeof e](e)},object(e){if(e&&typeof e.toJSON=="function")return this.object(e.toJSON());const n=Object.prototype.toString.call(e);let a="";const y=n.length;y<10?a=`unknown:[${n}]`:a=n.slice(8,y-1),a=a.toLowerCase();let l=null;if((l=u.get(e))===void 0)u.set(e,u.size);else return this.dispatch(`[CIRCULAR:${l}]`);if(typeof Buffer<"u"&&Buffer.isBuffer&&Buffer.isBuffer(e))return r("buffer:"),r(e.toString("utf8"));if(a!=="object"&&a!=="function"&&a!=="asyncfunction")this[a]?this[a](e):t.ignoreUnknown||this.unknown(e,a);else{let i=Object.keys(e);t.unorderedObjects&&(i=i.sort());let c=[];t.respectType!==!1&&!g(e)&&(c=b),t.excludeKeys&&(i=i.filter(s=>!t.excludeKeys(s)),c=c.filter(s=>!t.excludeKeys(s))),r(`object:${i.length+c.length}:`);const d=s=>{this.dispatch(s),r(":"),t.excludeValues||this.dispatch(e[s]),r(",")};for(const s of i)d(s);for(const s of c)d(s)}},array(e,n){if(n=n===void 0?t.unorderedArrays!==!1:n,r(`array:${e.length}:`),!n||e.length<=1){for(const l of e)this.dispatch(l);return}const a=new Map,y=e.map(l=>{const i=p(t);i.dispatch(l);for(const[c,d]of i.getContext())a.set(c,d);return i.toString()});return u=a,y.sort(),this.array(y,!1)},date(e){return r(`date:${e.toJSON()}`)},symbol(e){return r(`symbol:${e.toString()}`)},unknown(e,n){if(r(n),!!e&&(r(":"),e&&typeof e.entries=="function"))return this.array(Array.from(e.entries()),!0)},error(e){return r(`error:${e.toString()}`)},boolean(e){return r(`bool:${e}`)},string(e){r(`string:${e.length}:`),r(e)},function(e){r("fn:"),g(e)?this.dispatch("[native]"):this.dispatch(e.toString()),t.respectFunctionNames!==!1&&this.dispatch(`function-name:${String(e.name)}`),t.respectFunctionProperties&&this.object(e)},number(e){return r(`number:${e}`)},xml(e){return r(`xml:${e.toString()}`)},null(){return r("Null")},undefined(){return r("Undefined")},regexp(e){return r(`regex:${e.toString()}`)},uint8array(e){return r("uint8array:"),this.dispatch(Array.prototype.slice.call(e))},uint8clampedarray(e){return r("uint8clampedarray:"),this.dispatch(Array.prototype.slice.call(e))},int8array(e){return r("int8array:"),this.dispatch(Array.prototype.slice.call(e))},uint16array(e){return r("uint16array:"),this.dispatch(Array.prototype.slice.call(e))},int16array(e){return r("int16array:"),this.dispatch(Array.prototype.slice.call(e))},uint32array(e){return r("uint32array:"),this.dispatch(Array.prototype.slice.call(e))},int32array(e){return r("int32array:"),this.dispatch(Array.prototype.slice.call(e))},float32array(e){return r("float32array:"),this.dispatch(Array.prototype.slice.call(e))},float64array(e){return r("float64array:"),this.dispatch(Array.prototype.slice.call(e))},arraybuffer(e){return r("arraybuffer:"),this.dispatch(new Uint8Array(e))},url(e){return r(`url:${e.toString()}`)},map(e){r("map:");const n=[...e];return this.array(n,t.unorderedSets!==!1)},set(e){r("set:");const n=[...e];return this.array(n,t.unorderedSets!==!1)},file(e){return r("file:"),this.dispatch([e.name,e.size,e.type,e.lastModfied])},blob(){if(t.ignoreUnknown)return r("[blob]");throw new Error(`Hashing Blob objects is currently not supported
-Use "options.replacer" or "options.ignoreUnknown"
-`)},domwindow(){return r("domwindow")},bigint(e){return r(`bigint:${e.toString()}`)},process(){return r("process")},timer(){return r("timer")},pipe(){return r("pipe")},tcp(){return r("tcp")},udp(){return r("udp")},tty(){return r("tty")},statwatcher(){return r("statwatcher")},securecontext(){return r("securecontext")},connection(){return r("connection")},zlib(){return r("zlib")},context(){return r("context")},nodescript(){return r("nodescript")},httpparser(){return r("httpparser")},dataview(){return r("dataview")},signal(){return r("signal")},fsevent(){return r("fsevent")},tlswrap(){return r("tlswrap")}}}const h="[native code] }",w=h.length;function g(t){return typeof t!="function"?!1:Function.prototype.toString.call(t).slice(-w)===h}