@ezez/utils 4.6.0 → 4.7.0

package/.github/workflows/docs.yml

@@ -29,22 +29,23 @@ jobs:
 
       - name: Deploy versioned documentation
         uses: easingthemes/ssh-deploy@main
-        env:
+        with:
           SSH_PRIVATE_KEY: ${{ secrets.DOCS_SERVER_PRIVATE_KEY }}
           REMOTE_HOST: ${{ secrets.DOCS_SERVER_HOST }}
           REMOTE_USER: ${{ secrets.DOCS_SERVER_USER }}
           REMOTE_PORT: ${{ secrets.DOCS_SERVER_PORT }}
           SOURCE: "docs/"
           TARGET: "/docs/${{ env.PROJECT_NAME }}/${{ env.APP_VERSION }}"
+          ARGS: "-rltgoDzvO"
 
       - name: Deploy latest documentation
         uses: easingthemes/ssh-deploy@main
-        env:
+        with:
           SSH_PRIVATE_KEY: ${{ secrets.DOCS_SERVER_PRIVATE_KEY }}
           REMOTE_HOST: ${{ secrets.DOCS_SERVER_HOST }}
           REMOTE_USER: ${{ secrets.DOCS_SERVER_USER }}
           REMOTE_PORT: ${{ secrets.DOCS_SERVER_PORT }}
-          ARGS: "-rlgoDzvc -i --delete"
+          ARGS: "-rlgoDzv --delete"
           SOURCE: "docs/"
           TARGET: "/docs/${{ env.PROJECT_NAME }}/latest"
 

package/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [UNRELEASED]
 - (nothing yet)
 
+## [4.7.0] - 2025-10-16
+### Added
+- `hasProps` method
+- `assertProps` method
+### Changed
+- deprecated `match`
+
 ## [4.6.0] - 2025-10-10
 ### Added
 - `ignore` method

package/README.md

@@ -30,14 +30,17 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
 ## Supported methods
 
 ### String related
-- `addPrefix` - add prefix to a string if not already present
-- `addSuffix` - add suffix to a string if not already present
 - `capitalize` - capitalize a string, optionally lower casing the rest
+- `ensurePrefix` - add prefix to a string if not already present
+- `ensureSuffix` - add suffix to a string if not already present
 - `isNumericString` - check if given value is a numeric string, features configurable
 - `occurrences` - count occurrences of a substring in a string, optionally allow overlapping
 - `replace` - replace all occurrences of a substring using a map of replacements
 - `stripPrefix` - strip prefix from a string
 - `stripSuffix` - strip suffix from a string
+- `trim` - remove given characters from both sides of a string
+- `trimEnd` - remove given characters from the end of a string
+- `trimStart` - remove given characters from the start of a string
 
 ### Number related
 - `cap` - cap a value between lower and upper bound
@@ -53,7 +56,12 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
 - `mostFrequent` - find most frequent value in an array
 - `pull` - remove values from an array (by mutating)
 - `remove` - remove values from an array (by mutating) using predicate function and return removed values
+- `sample` - pick a random element from an array
+- `samples` - pick multiple random elements from an array without duplicates
+- `shuffle` - shuffle an array, returning a new array
 - `sortBy` - sort an array by given property (create callback function for `Array.prototype.sort`)
+- `sortByMultiple` - sort an array by multiple properties with individual sort directions
+- `toggle` - toggle an item in an array (add if missing, remove if present)
 - `unique` - get unique values from an array
 
 ### Object related
@@ -64,9 +72,11 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
 - `merge` - merge two objects shallowly, allowing to remove properties while doing so
 - `omit` - omit properties from an object
 - `pick` - pick some properties from an object
+- `removeCommonProperties` - remove properties from targets that have the same value as in source
 - `replaceDeep` - recursively replace all occurrences of a value in an object/array
-- `sortProps` - sort object properties by key
+- `replaceDeepByFn` - recursively replace values in an object/array using a callback function
 - `serialize` - like JSON.stringify but any data type is allowed
+- `sortProps` - sort object properties by key
 
 ### Date related
 - `ensureDate` - ensure that given value is a Date instance
@@ -80,22 +90,25 @@ object, with just some properties copied. Easy, right? Few lines of code? Lodash
 - `safe` - runs function and returns its result or default value if function throws an error
 
 ### Flow related
+- `ignore` - execute a callback and ignore its result, errors, or promise rejections
 - `later` - create a promise you can resolve later, outside of Promise constructor
 - `mapAsync` - map an array asynchronously if sync version blocks your event loop for too long
 - `noop` - do nothing
+- `race` - timeout your promises while keeping TypeScript types correct
 - `rethrow` - throw given value
-- `seq` - sequentially execute Promise-returning functions until one returns a value
 - `retry` - execute Promise-returning in a loop until it resolves
+- `seq` - sequentially execute Promise-returning functions until one returns a value
 - `wait` - wait given amount of time (async)
-- `waitSync` - wait given amount of time (sync)
 - `waitFor` - wait for a condition to be true, checking every given amount of time
+- `waitSync` - wait given amount of time (sync)
 
 ### Various
 - `get` - extract a value from a deep object using specified path, optionally with a default value
 - `getMultiple` - same as above, but test multiple paths
+- `isEmpty` - check if given value is empty
+- `memoize` - memoize a function, caching the result of the last call
 - `set` - set a value in a deep object using specified path
 - `setImmutable` - set a value in a deep object using specified path, but return a new object
-- `isEmpty` - check if given value is empty
 - `throttle` - throttle a function, very configurable
 - `truthy` - is value truthy? (useful for filtering with more correct TypeScript support than `filter(Boolean)`)
 

package/dist/assertProps.d.ts

@@ -0,0 +1,6 @@
+type AssertPropsFn = <T extends Record<string, "string" | "number" | "boolean">>(obj: unknown, schema: T) => asserts obj is {
+    [K in keyof T]: T[K] extends "string" ? string : T[K] extends "number" ? number : T[K] extends "boolean" ? boolean : never;
+};
+declare const assertProps: AssertPropsFn;
+export { assertProps, };
+//# sourceMappingURL=assertProps.d.ts.map

package/dist/assertProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertProps.d.ts","sourceRoot":"","sources":["../src/assertProps.ts"],"names":[],"mappings":"AAEA,KAAK,aAAa,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC,EAC3E,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,CAAC,KACR,OAAO,CAAC,GAAG,IAAI;KACf,CAAC,IAAI,MAAM,CAAC,GACb,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,MAAM,GACxB,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,MAAM,GAC1B,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,OAAO,GAC5B,KAAK;CACtB,CAAC;AAcF,QAAA,MAAM,WAAW,EAAE,aAOlB,CAAC;AAEF,OAAO,EACH,WAAW,GACd,CAAC"}

package/dist/assertProps.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertProps = void 0;
+const hasProps_1 = require("./hasProps");
+const assertProps = (obj, schema) => {
+    if (!(0, hasProps_1.hasProps)(obj, schema)) {
+        throw new Error("Object does not match the required schema");
+    }
+};
+exports.assertProps = assertProps;
+//# sourceMappingURL=assertProps.js.map

package/dist/assertProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertProps.js","sourceRoot":"","sources":["../src/assertProps.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAyBtC,MAAM,WAAW,GAAkB,CAC/B,GAAY,EACZ,MAAS,EACX,EAAE;IACA,IAAI,CAAC,IAAA,mBAAQ,EAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IACjE,CAAC;AACL,CAAC,CAAC;AAGE,kCAAW"}

package/dist/hasProps.d.ts

@@ -0,0 +1,3 @@
+declare const hasProps: <T extends Record<string, "string" | "number" | "boolean">>(obj: unknown, schema: T) => obj is { [K in keyof T]: T[K] extends "string" ? string : T[K] extends "number" ? number : T[K] extends "boolean" ? boolean : never; };
+export { hasProps, };
+//# sourceMappingURL=hasProps.d.ts.map

package/dist/hasProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasProps.d.ts","sourceRoot":"","sources":["../src/hasProps.ts"],"names":[],"mappings":"AAaA,QAAA,MAAM,QAAQ,GACV,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC,EAEzD,KAAK,OAAO,EACZ,QAAQ,CAAC,KACV,GAAG,IAAI,GACL,CAAC,IAAI,MAAM,CAAC,GACb,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,MAAM,GACxB,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,MAAM,GAC1B,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,OAAO,GAC5B,KAAK,GAQtB,CAAC;AAEF,OAAO,EACH,QAAQ,GACX,CAAC"}

package/dist/hasProps.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasProps = void 0;
+const hasProps = (obj, schema) => {
+    if (typeof obj !== "object" || obj === null || Array.isArray(obj)) {
+        return false;
+    }
+    for (const [key, type] of Object.entries(schema)) {
+        if (typeof obj[key] !== type) {
+            return false;
+        }
+    }
+    return true;
+};
+exports.hasProps = hasProps;
+//# sourceMappingURL=hasProps.js.map

package/dist/hasProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasProps.js","sourceRoot":"","sources":["../src/hasProps.ts"],"names":[],"mappings":";;;AAaA,MAAM,QAAQ,GAAG,CAGb,GAAY,EACZ,MAAS,EAOX,EAAE;IACA,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAAC,OAAO,KAAK,CAAC;IAAC,CAAC;IACpF,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAE/C,IAAI,OAAQ,GAA0B,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;YAAC,OAAO,KAAK,CAAC;QAAC,CAAC;IAC3E,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAGE,4BAAQ"}

package/dist/match.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"match.d.ts","sourceRoot":"","sources":["../src/match.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;AAO9C,QAAA,MAAM,KAAK,GAAI,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,aAAa,CAAC,CAAC,CAAC,KAAG;IAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAAC,SAAS,EAAE,CAAC,EAAE,CAAA;CAejF,CAAC;AAEF,OAAO,EACH,KAAK,GACR,CAAC;AACF,YAAY,EACR,aAAa,GAChB,CAAC"}
+{"version":3,"file":"match.d.ts","sourceRoot":"","sources":["../src/match.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;AAQ9C,QAAA,MAAM,KAAK,GAAI,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,aAAa,CAAC,CAAC,CAAC,KAAG;IAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAAC,SAAS,EAAE,CAAC,EAAE,CAAA;CAejF,CAAC;AAEF,OAAO,EACH,KAAK,GACR,CAAC;AACF,YAAY,EACR,aAAa,GAChB,CAAC"}

package/dist/match.js.map

@@ -1 +1 @@
-{"version":3,"file":"match.js","sourceRoot":"","sources":["../src/match.ts"],"names":[],"mappings":";;;AAOA,MAAM,KAAK,GAAG,CAAI,IAAS,EAAE,EAAoB,EAAoC,EAAE;IACnF,MAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAChB,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,OAAO;QACX,CAAC;QACD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,OAAO;QACH,OAAO;QACP,SAAS;KACZ,CAAC;AACN,CAAC,CAAC;AAGE,sBAAK"}
+{"version":3,"file":"match.js","sourceRoot":"","sources":["../src/match.ts"],"names":[],"mappings":";;;AAQA,MAAM,KAAK,GAAG,CAAI,IAAS,EAAE,EAAoB,EAAoC,EAAE;IACnF,MAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAChB,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,OAAO;QACX,CAAC;QACD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,OAAO;QACH,OAAO;QACP,SAAS;KACZ,CAAC;AACN,CAAC,CAAC;AAGE,sBAAK"}

package/docs/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "eJyNmc1y0zAUhd/FbAu0tJTSHW0ThhmgHRzYMCwUR3FELcuVZJrC9N25/ol/4vhcb32/88WWJfmq/fkv8HLrg8vgeiPSWCYmDo6CTPgNXVqZKNcy9e51U3y18Toh4l6lq+Dy4vTi4vz44vmosdBluW0N2qzyRLrX5eV+9s1REG1UsrIyDS5/trdhdCasvLMmc7eZVyZ1rU6lXtq1iBrjAXrvV96ed+7uo/Rf8sSrLJGhyW0kgXrAMuIpQl70yX2lIbcqCr1VacyPwOEA+onbKMpp0EnB2wcsEofSf9I692I5YXiHMKOeYuRFi4013idyNc/TqHii2dZbgYZgJDHlR/jx3SOR9Dp33ugb6ehli0T9lbYj9k9ZuyaG4J73+P27k7dvBu5wmjmc7v0s6HkPu8oSl/8ish8iyaWbp4ctHYB3+WhzLZJkKaL7MVsHYX3SxnLxaEZUdZWzhPJhJmzydGWluB8bqz1ognNsvMrSlHw910cmQpfgbe1CvytUI8Y+xVkHq/KwdoBxXr2bUN+/hrNFK/0jaNIv209Zn+tbT3vCYiJwsoYBokhkrWG9G/3aQMV+9PysH1W+XLLQUDNIZATddYQ0NQEl5Tf7g7XiySFTB+N1ZQvA2koKyFbtrjnu6kBAJVOX17c/rupArOqGdkzOVDCsaGatsZyphFjVnZVrteVcFcXKwnw9QVZRrGyhtHReaLBo9kCkdLQ85DcZz7bI16GAbG2sFh6/zZYBolj6cQMVcXTX3ELFDgIqFafGAktVR4KUlpMPJa1P4dHE3AOR0s105sG6q4F9BR1JEuFcuRFkVkY0/qug5+0128jfA+Gt3iVCpbfL3zICr7OHAR3dPrAUVRjutWvDNJVfngABfRU/uKc0GnfsCCypPq3QUiFQQ80cUlAZxaU28CtQA1BBn3UkoDKKG+fnVj7kdAIHlg4FZKkxYOcqqiBsilNgdQwcd3QgpNIKPExRBeFMdTv3/XBRReE8SUCYqiBsBWp6iioK00z5g+JlnRVcG61NWnQwtAsq9CoO8/AHsgQ/YQXwihspwTzrQFDlqW1/RJoSwAoLtv+yjOImp2vj8aIM4k6swVgWVRjW8Ktc1VkBmB41gBSRgLdQlFFcPoCwfMDR9qgLJS0GdWw3P6WXb5iFuaL2E30kByjUgr3QwQbOdc7L0NFQSLahO4WeCkAKY/0VWHFVnRXwTWmfY4TMobBBkIYauIw75nQgTsUdcjoQUPn67xrjnh2BJCaOoaKsI4FVGsSpyoRnaJetAUYRemHBKmoQqMn9Bszdqg4Eeaqo/xoXVHUoaLaNuTWa22MO4kD/KFDTVVSZ8Bwdy2qAUYTwWLAjpv1p5tAYDf/T9KKTWFNiuUtU8rOT92enxyNvAXr7XN/26/nXf0rpcaE="
+window.navigationData = "eJyVmUtz0zAURv+L2RZoaSmlO9omDDNAOziwYVgojuKIWpYryTSF4b9z/Ygfcfxds/U934ks69l+/xN4ufXBZXC9EWksExMHR0Em/IYerUyUa5l697Ipvth4nRBxr9JVcHlxenFxfnzx96ix0GO5bQ3arPJEupfl43721VEQbVSysjINLr+3zTA6E1beWZO528wrk7pWp1Iv7VpEjfEAvfcrr887rXsv/ac88SpLZGhyG0mgHrCMeIqQF31wn6nLrYpCb1Ua8z1wOIB+4jaKcup0UvD2AYvEofQftM69WE7o3iHMqKcYedFiY433iVzN8zQq3mi29VagLhhJTPkRvn/3SCS9zp03+kY6+tgiUb+l7Yj9U9bOiSG45z1+++bk9auBO5xmDqd7Pwp638OussTlP4nsm0hy6ebpYUsH4F0+2lyLJFmK6H7M1kFYn7SxXDyaEVVd5SyhfJgJmzxdWSnux/pqD5rgHOuvsjQlX4/1kYHQJXhbO9HvCtWIsU9x1sGsPKwdYJxX7wbU18/hbNFKfwka9Mt2K+tzfetpT1gMBE7WMEAUiaw1rHe9Xxuo2I+en/WjypdTFhpqBomMoFZHSFMTUFLu2e+sFU8OmToYryuPAKytpIBs1a6a464OBFQydXnd/HFVB2JVN7RicqaCYUUza43lTCXEqu6sXKst56ooVhbm6wmyimJlC6Wl80KDSbMHIqWj6SG/yHi2Rb4OBWRrY7Xw+Gu2DBDF0o8bqIiju8MtVOwgoFJxaiywVHUkSGk6+VDS/BQeDcw9ECndTGcezLsa2FfQlSQRzpULQWZlRP2/Cnre3mEb+XsgbOpdIlR6u/wpI/A5exjQUfOBpajCcO+4NkxT+fkJENCu+M49pdG4Y0dgSbW1QkuFQA0d5pCCyv/7/bXUBm4NNYCaVez1SEBlFDfOz618yOlaDiwdCshSY8ByVlRB2BRXw+puOO7oQEilFXiZogrCmeoe5/fDRRWF8yQBYaqCsBXoJFRUUZhGyi8UL+us4NpobdLiWENLo0Kf4jAPfyBL8BtWAK+4kRKMsw4EVZ7O8o9IUwJYYcGeUJZR3OT0bDxelEHciTXoy6IKwxpu1VWdFYDhUQNIEQnYhKKM4vIBhOUDjrb3XyhpMahjj/hTDvgNszBXdCZFO+cAhVqwFjp4qnOdSzR0NBSSbail0FMBSGGsvwIzrqqzAv6k2ucYIXNTbBCkoVNdxt19OhCn4m4+HQiofP3HjnHPjkASE8dQUdaRwCoN4lRlwjO0ytYAowi9sGAWNQjU5H4Dxm5VB4I8VXT+GhdUdSholo25NZpbYw7iQP8o0KGrqDLhObqr1QCjCOFdYUdM+3vNoT4a/vvpWSexpsRyl6jkZydvz06PR74C9Pa5vu3H3x//AKXPeLY="