@stacksjs/strings 0.70.44 → 0.70.53

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2023 Open Web Foundation
+
+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/dist/index.js

@@ -298,6 +298,20 @@ function splitPrefixSuffix(input, options = {}) {
 function toString(v) {
   return Object.prototype.toString.call(v);
 }
+function mask(value, character, index, length) {
+  if (character === "")
+    return value;
+  const len = value.length;
+  const start = index < 0 ? Math.max(0, len + index) : index;
+  if (start >= len)
+    return value;
+  const maskLen = length === undefined ? len - start : Math.max(0, length);
+  if (maskLen === 0)
+    return value;
+  const end = Math.min(len, start + maskLen);
+  const fill = character.charAt(0).repeat(end - start);
+  return value.slice(0, start) + fill + value.slice(end);
+}
 
 // src/pluralize.ts
 var pluralRules = [];
@@ -1240,6 +1254,7 @@ export {
   pascalCase,
   paramCase,
   noCase,
+  mask,
   lowercase,
   kebabCase,
   isUUID,

package/dist/src/helpers.d.ts

@@ -1 +1,23 @@
 export declare function toString(v: any): string;
+/**
+ * Mask a portion of a string with a repeated character, Laravel-style
+ * (stacksjs/stacks#314).
+ *
+ * Useful for redacting PII in logs (credit card middle, phone digits,
+ * email local part) without losing the format. The mask character is
+ * repeated for `length` characters starting at `index`; `length` defaults
+ * to "all remaining characters from index to end of string."
+ *
+ * `index` is the character offset, not a byte offset. Negative `index`
+ * counts from the end of the string (`-4` = "start four characters from
+ * the end"). An out-of-range `index` returns the original string.
+ *
+ * @example
+ * ```ts
+ * mask('1234567890123456', '*', 4, 8)   // → '1234********3456'
+ * mask('1234567890123456', '*', 4)      // → '1234************'
+ * mask('1234567890123456', '*', -4, 4)  // → '123456789012****'
+ * mask('hello@example.com', '*', 1, 4)  // → 'h****@example.com'
+ * ```
+ */
+export declare function mask(value: string, character: string, index: number, length?: number): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/strings",
   "type": "module",
-  "version": "0.70.44",
+  "version": "0.70.53",
   "description": "The Stacks string utilities.",
   "author": "Chris Breuer",
   "contributors": [
@@ -60,9 +60,9 @@
     "prepublishOnly": "bun run build"
   },
   "devDependencies": {
-    "@stacksjs/alias": "^0.70.44",
+    "@stacksjs/alias": "0.70.53",
     "better-dx": "^0.2.12",
-    "@stacksjs/types": "^0.70.44"
+    "@stacksjs/types": "0.70.53"
   },
   "sideEffects": false
 }