@germondai/ts-utils 0.0.5 → 0.1.0

package/dist/runtime/string.d.ts

@@ -1,38 +1,81 @@
 /**
- * Capitalizes the first character of a string and lowercases the remainder.
+ * Reverses a string.
  *
- * @param str - The string to capitalize.
- * @returns The capitalized string.
+ * @param str - The string to reverse.
+ * @returns The reversed string.
+ *
+ * @example
+ * reverse("hello") // "olleh"
+ */
+export declare const reverse: (str: string) => string;
+/**
+ * Counts the number of occurrences of a substring in a string.
+ *
+ * @param str - The string to search in.
+ * @param search - The substring to search for.
+ * @returns The number of occurrences.
+ *
+ * @example
+ * countOccurrences("hello world hello", "hello") // 2
+ */
+export declare const countOccurrences: (str: string, search: string) => number;
+/**
+ * Pads a string to the specified length with the given character.
+ *
+ * @param str - The string to pad.
+ * @param length - The desired length.
+ * @param char - The character to pad with (default: ' ').
+ * @param direction - The padding direction: 'left', 'right', or 'both' (default: 'left').
+ * @returns The padded string.
+ *
+ * @example
+ * pad("5", 3, "0") // "005"
+ * pad("hi", 6, " ", "both") // "  hi  "
  */
-export declare const capitalize: (str: string) => string;
+export declare const pad: (str: string, length: number, char?: string, direction?: "left" | "right" | "both") => string;
 /**
- * Truncates a string to a maximum length.
+ * Masks a string, showing only the last N characters.
  *
- * If the string exceeds the maximum length, it will be cut off.
- * Optionally, an ellipsis ("...") is appended.
+ * @param str - The string to mask.
+ * @param visibleCount - The number of characters to leave visible at the end (default: 4).
+ * @param maskChar - The character to use for masking (default: '*').
+ * @returns The masked string.
  *
- * @param text - The text to truncate.
- * @param maxLength - The maximum allowed length.
- * @param ellipsis - Whether to append "..." if truncated (default is false).
- * @returns The truncated string.
+ * @example
+ * mask("1234567890") // "******7890"
+ * mask("secret", 2, "#") // "####et"
  */
-export declare const truncate: (text: string, maxLength: number, ellipsis?: boolean) => string;
+export declare const mask: (str: string, visibleCount?: number, maskChar?: string) => string;
 /**
- * Generates a URL-friendly slug from a given string.
+ * Extracts initials from a name.
  *
- * The function normalizes accented characters, converts the string to lowercase,
- * trims whitespace, replaces spaces with hyphens, removes invalid characters,
- * and limits the slug length.
+ * @param name - The full name.
+ * @returns The uppercase initials.
  *
- * @param title - The input string to slugify.
- * @param length - Maximum length of the slug (default is 64).
- * @returns The slugified string.
+ * @example
+ * initials("John Doe") // "JD"
+ * initials("Alice Bob Charlie") // "ABC"
  */
-export declare const slugify: (title: string, length?: number) => string;
+export declare const initials: (name: string) => string;
 /**
- * Strips HTML tags from a string.
+ * Counts the number of words in a string.
+ *
+ * @param str - The string to count words in.
+ * @returns The number of words.
+ *
+ * @example
+ * wordCount("Hello world") // 2
+ */
+export declare const wordCount: (str: string) => number;
+/**
+ * Checks if a string is empty or contains only whitespace.
+ *
+ * @param str - The string to check.
+ * @returns True if the string is blank.
  *
- * @param html - The HTML string.
- * @returns The string without HTML tags.
+ * @example
+ * isBlank("") // true
+ * isBlank("  ") // true
+ * isBlank("hello") // false
  */
-export declare const stripTags: (html: string) => string;
+export declare const isBlank: (str: string) => boolean;

package/dist/runtime/type.d.ts

@@ -48,3 +48,52 @@ export declare const isEmpty: (value: unknown) => boolean;
  *
  */
 export declare const isJSON: (value: string) => boolean;
+/**
+ * Checks if a value is a function.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is a function.
+ */
+export declare const isFunction: (value: unknown) => value is Function;
+/**
+ * Checks if a value is a valid Date instance.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is a valid Date.
+ */
+export declare const isDate: (value: unknown) => value is Date;
+/**
+ * Checks if a value is a number (and not NaN).
+ *
+ * @param value - The value to check.
+ * @returns True if the value is a finite number.
+ */
+export declare const isNumber: (value: unknown) => value is number;
+/**
+ * Checks if a value is a string.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is a string.
+ */
+export declare const isString: (value: unknown) => value is string;
+/**
+ * Checks if a value is a boolean.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is a boolean.
+ */
+export declare const isBoolean: (value: unknown) => value is boolean;
+/**
+ * Checks if a value is null or undefined.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is null or undefined.
+ */
+export declare const isNil: (value: unknown) => value is null | undefined;
+/**
+ * Checks if a value is a RegExp instance.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is a RegExp.
+ */
+export declare const isRegExp: (value: unknown) => value is RegExp;

package/dist/types.d.ts

@@ -0,0 +1,52 @@
+/** Flatten intersections for readable hover types */
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/** Recursive Partial — makes all properties optional at every depth */
+export type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
+/** Recursive Required — makes all properties required at every depth */
+export type DeepRequired<T> = {
+    [K in keyof T]-?: T[K] extends object ? DeepRequired<T[K]> : T[K];
+};
+/** Recursive Readonly — makes all properties readonly at every depth */
+export type DeepReadonly<T> = {
+    readonly [K in keyof T]: T[K] extends object ? DeepReadonly<T[K]> : T[K];
+};
+/** Makes a type nullable */
+export type Nullable<T> = T | null;
+/** Makes a type nullable or undefined */
+export type Maybe<T> = T | null | undefined;
+/** Recursively removes null and undefined from all properties */
+export type NonNullableDeep<T> = {
+    [K in keyof T]: T[K] extends object ? NonNullableDeep<NonNullable<T[K]>> : NonNullable<T[K]>;
+};
+/** Omit that enforces K extends keyof T */
+export type StrictOmit<T, K extends keyof T> = Omit<T, K>;
+/** Extract that enforces U extends T */
+export type StrictExtract<T, U extends T> = Extract<T, U>;
+/** Get the union of all property value types */
+export type ValueOf<T> = T[keyof T];
+/** Typed Object.entries return type */
+export type Entries<T> = {
+    [K in keyof T]: [K, T[K]];
+}[keyof T][];
+/** Convert a union type to an intersection type */
+export type UnionToIntersection<U> = (U extends any ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
+/** Require at least one of the specified keys */
+export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Omit<T, Keys> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+/** Require exactly one of the specified keys */
+export type RequireExactlyOne<T, Keys extends keyof T = keyof T> = Omit<T, Keys> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
+}[Keys];
+/** Remove readonly from all properties */
+export type Mutable<T> = {
+    -readonly [K in keyof T]: T[K];
+};
+/** Make specific keys optional */
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/** Make specific keys required */
+export type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@germondai/ts-utils",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Germond's TypeScript Utilities",
   "repository": {
     "type": "git",
@@ -8,6 +8,16 @@
   },
   "author": "germondai",
   "license": "MIT",
+  "keywords": [
+    "typescript",
+    "utilities",
+    "utils",
+    "helpers",
+    "type-utils",
+    "string-utils",
+    "array-utils",
+    "object-utils"
+  ],
   "type": "module",
   "exports": {
     ".": {
@@ -22,6 +32,8 @@
     "dist"
   ],
   "scripts": {
+    "test": "bun test",
+    "test:watch": "bun test --watch",
     "prepack": "bun run build",
     "build": "bun build --target=node ./src/module.ts --outfile=dist/module.js && bun run build:types",
     "build:types": "tsc --emitDeclarationOnly --project tsconfig.types.json",
@@ -31,10 +43,10 @@
     "fmt": "bun prettier:fix"
   },
   "devDependencies": {
-    "@types/bun": "latest",
-    "prettier": "^3.5.0"
+    "@types/bun": "^1.3.9",
+    "prettier": "^3.8.1"
   },
   "peerDependencies": {
-    "typescript": "^5.7.3"
+    "typescript": "^5.9.3"
   }
 }