@indodev/toolkit 0.6.0 → 0.7.0

package/dist/parse-B3UzEHq3.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Validates an Indonesian license plate number format.
+ * Format: [1-2 letters] [1-4 digits] [1-3 letters]
+ *
+ * @param plate - The plate number string to validate
+ * @returns `true` if valid, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * validatePlate('B 1234 ABC'); // true
+ * validatePlate('AB 1 CD'); // true
+ * ```
+ */
+declare function validatePlate(plate: string): boolean;
+/**
+ * Gets the region name from a license plate number.
+ *
+ * @param plate - The plate number
+ * @returns Region name or null if not found
+ */
+declare function getRegionFromPlate(plate: string): string | null;
+/**
+ * Formats a license plate number with spaces (e.g., B 1234 ABC).
+ *
+ * @param plate - The plate number
+ * @returns Formatted plate string
+ */
+declare function formatPlate(plate: string): string;
+
+/**
+ * Error thrown when an invalid vehicle plate is provided to a function.
+ * Extends native Error with a `code` property for programmatic error handling.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   requirePlate('invalid');
+ * } catch (error) {
+ *   if (error instanceof InvalidPlateError) {
+ *     console.log(error.code); // 'INVALID_PLATE'
+ *   }
+ * }
+ * ```
+ *
+ * @public
+ */
+declare class InvalidPlateError extends Error {
+    readonly code: "INVALID_PLATE";
+    constructor(message?: string);
+}
+
+/**
+ * Information extracted from a valid Indonesian license plate number.
+ *
+ * Contains parsed data including the plate prefix, number, suffix,
+ * type classification, and formatted representation.
+ *
+ * @example
+ * ```typescript
+ * const info: PlateInfo = {
+ *   prefix: 'B',
+ *   number: '1234',
+ *   suffix: 'ABC',
+ *   type: 'private',
+ *   formatted: 'B 1234 ABC',
+ *   isValid: true,
+ * };
+ * ```
+ *
+ * @public
+ */
+interface PlateInfo {
+    /**
+     * Plate prefix (letters before number).
+     * Indicates the region where the vehicle is registered.
+     */
+    prefix: string;
+    /**
+     * Plate number (digits).
+     */
+    number: string;
+    /**
+     * Plate suffix (letters after number, if any).
+     */
+    suffix: string;
+    /**
+     * Type of vehicle registration.
+     * - 'private': Private vehicle
+     * - 'public': Public transportation
+     * - 'diplomat': Diplomatic vehicle
+     * - `null`: Unknown or invalid type
+     */
+    type: 'private' | 'public' | 'diplomat' | null;
+    /**
+     * Formatted plate string with proper spacing.
+     * @example 'B 1234 ABC'
+     */
+    formatted: string;
+    /**
+     * Whether the plate passed validation.
+     * If `false`, other fields may contain partial data.
+     */
+    isValid: boolean;
+}
+
+/**
+ * Parses an Indonesian license plate number into its component parts.
+ *
+ * Extracts the prefix (region code), number, and suffix (optional letters)
+ * from a plate number. Also determines the plate type and returns a
+ * formatted representation.
+ *
+ * @param plate - The plate string to parse
+ * @returns PlateInfo object with extracted components, or null if invalid
+ *
+ * @example
+ * Private plate:
+ * ```typescript
+ * parsePlate('B 1234 ABC');
+ * // {
+ * //   prefix: 'B',
+ * //   number: '1234',
+ * //   suffix: 'ABC',
+ * //   type: 'private',
+ * //   formatted: 'B 1234 ABC',
+ * //   isValid: true
+ * // }
+ * ```
+ *
+ * @example
+ * Public transport plate:
+ * ```typescript
+ * parsePlate('AB 1 CD');
+ * // {
+ * //   prefix: 'AB',
+ * //   number: '1',
+ * //   suffix: 'CD',
+ * //   type: 'public',
+ * //   formatted: 'AB 1 CD',
+ * //   isValid: true
+ * // }
+ * ```
+ *
+ * @example
+ * Invalid plate returns null:
+ * ```typescript
+ * parsePlate('invalid');
+ * // null
+ * ```
+ *
+ * @public
+ */
+declare function parsePlate(plate: string): PlateInfo | null;
+
+export { InvalidPlateError as I, type PlateInfo as P, formatPlate as f, getRegionFromPlate as g, parsePlate as p, validatePlate as v };

package/dist/parse-DlrgrRfY.d.cts

@@ -0,0 +1,155 @@
+/**
+ * Validates a Vehicle Identification Number (VIN) based on ISO 3779.
+ *
+ * Checks for:
+ * - Exactly 17 characters length.
+ * - Exclusion of characters I, O, and Q.
+ * - Checksum validation using the check digit at position 9.
+ *
+ * @param vin - The VIN string to validate
+ * @returns boolean indicating if the VIN is valid
+ *
+ * @example
+ * ```typescript
+ * import { validateVIN } from '@indodev/toolkit/vin';
+ *
+ * validateVIN('1HBHA82L7ZB000001'); // true
+ * validateVIN('1HBHA82I7ZB000001'); // false (contains 'I')
+ * ```
+ */
+declare function validateVIN(vin: string): boolean;
+
+/**
+ * VIN Validation options.
+ */
+interface VINOptions {
+    /**
+     * Whether to include error messages in the validation result.
+     */
+    includeDetails?: boolean;
+}
+/**
+ * Detailed validation result.
+ */
+interface VINValidationResult {
+    isValid: boolean;
+    error?: string;
+}
+/**
+ * Information extracted from a valid Vehicle Identification Number (VIN).
+ *
+ * Contains parsed data including the world manufacturer identifier (WMI),
+ * vehicle descriptor section (VDS), check digit, model year code, plant code,
+ * and serial number.
+ *
+ * @example
+ * ```typescript
+ * const info: VINInfo = {
+ *   wmi: '1HB',
+ *   vds: 'HA82L7',
+ *   checkDigit: 'Z',
+ *   modelYearCode: 'B',
+ *   plantCode: '7',
+ *   serialNumber: 'ZB000001',
+ *   isValid: true,
+ * };
+ * ```
+ *
+ * @public
+ */
+interface VINInfo {
+    /**
+     * World manufacturer identifier (positions 1-3).
+     * Identifies the manufacturer and vehicle type.
+     */
+    wmi: string;
+    /**
+     * Vehicle descriptor section (positions 4-9).
+     * Contains information about the vehicle attributes.
+     */
+    vds: string;
+    /**
+     * Check digit (position 9).
+     * Used for VIN validation checksum.
+     */
+    checkDigit: string;
+    /**
+     * Model year code (position 10).
+     * Indicates the vehicle's model year.
+     */
+    modelYearCode: string;
+    /**
+     * Plant code (position 11).
+     * Identifies the manufacturing plant.
+     */
+    plantCode: string;
+    /**
+     * Serial number (positions 12-17).
+     * Uniquely identifies the vehicle.
+     */
+    serialNumber: string;
+    /**
+     * Whether the VIN passed validation.
+     * If `false`, other fields may contain partial data.
+     */
+    isValid: boolean;
+}
+
+/**
+ * Error thrown when an invalid VIN is provided to a function.
+ * Extends native Error with a `code` property for programmatic error handling.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   requireVIN('invalid');
+ * } catch (error) {
+ *   if (error instanceof InvalidVINError) {
+ *     console.log(error.code); // 'INVALID_VIN'
+ *   }
+ * }
+ * ```
+ *
+ * @public
+ */
+declare class InvalidVINError extends Error {
+    readonly code: "INVALID_VIN";
+    constructor(message?: string);
+}
+
+/**
+ * Parses a Vehicle Identification Number (VIN) into its component parts.
+ *
+ * Extracts the WMI (World Manufacturer Identifier), VDS (Vehicle Descriptor Section),
+ * check digit, model year code, plant code, and serial number from a VIN.
+ *
+ * @param vin - The VIN string to parse
+ * @returns VINInfo object with extracted components, or null if invalid
+ *
+ * @example
+ * Valid VIN:
+ * ```typescript
+ * parseVIN('1HBHA82L7ZB000001');
+ * // {
+ * //   wmi: '1HB',
+ * //   vds: 'HA82L7',
+ * //   checkDigit: '7',
+ * //   modelYearCode: 'Z',
+ * //   plantCode: 'B',
+ * //   serialNumber: '0000001',
+ * //   isValid: true
+ * // }
+ * ```
+ *
+ * @example
+ * Invalid VIN returns null:
+ * ```typescript
+ * parseVIN('invalid');
+ * // null
+ * ```
+ *
+ * @public
+ */
+declare function parseVIN(vin: string): VINInfo | null;
+
+export { InvalidVINError as I, type VINOptions as V, type VINValidationResult as a, type VINInfo as b, parseVIN as p, validateVIN as v };

package/dist/parse-DlrgrRfY.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Validates a Vehicle Identification Number (VIN) based on ISO 3779.
+ *
+ * Checks for:
+ * - Exactly 17 characters length.
+ * - Exclusion of characters I, O, and Q.
+ * - Checksum validation using the check digit at position 9.
+ *
+ * @param vin - The VIN string to validate
+ * @returns boolean indicating if the VIN is valid
+ *
+ * @example
+ * ```typescript
+ * import { validateVIN } from '@indodev/toolkit/vin';
+ *
+ * validateVIN('1HBHA82L7ZB000001'); // true
+ * validateVIN('1HBHA82I7ZB000001'); // false (contains 'I')
+ * ```
+ */
+declare function validateVIN(vin: string): boolean;
+
+/**
+ * VIN Validation options.
+ */
+interface VINOptions {
+    /**
+     * Whether to include error messages in the validation result.
+     */
+    includeDetails?: boolean;
+}
+/**
+ * Detailed validation result.
+ */
+interface VINValidationResult {
+    isValid: boolean;
+    error?: string;
+}
+/**
+ * Information extracted from a valid Vehicle Identification Number (VIN).
+ *
+ * Contains parsed data including the world manufacturer identifier (WMI),
+ * vehicle descriptor section (VDS), check digit, model year code, plant code,
+ * and serial number.
+ *
+ * @example
+ * ```typescript
+ * const info: VINInfo = {
+ *   wmi: '1HB',
+ *   vds: 'HA82L7',
+ *   checkDigit: 'Z',
+ *   modelYearCode: 'B',
+ *   plantCode: '7',
+ *   serialNumber: 'ZB000001',
+ *   isValid: true,
+ * };
+ * ```
+ *
+ * @public
+ */
+interface VINInfo {
+    /**
+     * World manufacturer identifier (positions 1-3).
+     * Identifies the manufacturer and vehicle type.
+     */
+    wmi: string;
+    /**
+     * Vehicle descriptor section (positions 4-9).
+     * Contains information about the vehicle attributes.
+     */
+    vds: string;
+    /**
+     * Check digit (position 9).
+     * Used for VIN validation checksum.
+     */
+    checkDigit: string;
+    /**
+     * Model year code (position 10).
+     * Indicates the vehicle's model year.
+     */
+    modelYearCode: string;
+    /**
+     * Plant code (position 11).
+     * Identifies the manufacturing plant.
+     */
+    plantCode: string;
+    /**
+     * Serial number (positions 12-17).
+     * Uniquely identifies the vehicle.
+     */
+    serialNumber: string;
+    /**
+     * Whether the VIN passed validation.
+     * If `false`, other fields may contain partial data.
+     */
+    isValid: boolean;
+}
+
+/**
+ * Error thrown when an invalid VIN is provided to a function.
+ * Extends native Error with a `code` property for programmatic error handling.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   requireVIN('invalid');
+ * } catch (error) {
+ *   if (error instanceof InvalidVINError) {
+ *     console.log(error.code); // 'INVALID_VIN'
+ *   }
+ * }
+ * ```
+ *
+ * @public
+ */
+declare class InvalidVINError extends Error {
+    readonly code: "INVALID_VIN";
+    constructor(message?: string);
+}
+
+/**
+ * Parses a Vehicle Identification Number (VIN) into its component parts.
+ *
+ * Extracts the WMI (World Manufacturer Identifier), VDS (Vehicle Descriptor Section),
+ * check digit, model year code, plant code, and serial number from a VIN.
+ *
+ * @param vin - The VIN string to parse
+ * @returns VINInfo object with extracted components, or null if invalid
+ *
+ * @example
+ * Valid VIN:
+ * ```typescript
+ * parseVIN('1HBHA82L7ZB000001');
+ * // {
+ * //   wmi: '1HB',
+ * //   vds: 'HA82L7',
+ * //   checkDigit: '7',
+ * //   modelYearCode: 'Z',
+ * //   plantCode: 'B',
+ * //   serialNumber: '0000001',
+ * //   isValid: true
+ * // }
+ * ```
+ *
+ * @example
+ * Invalid VIN returns null:
+ * ```typescript
+ * parseVIN('invalid');
+ * // null
+ * ```
+ *
+ * @public
+ */
+declare function parseVIN(vin: string): VINInfo | null;
+
+export { InvalidVINError as I, type VINOptions as V, type VINValidationResult as a, type VINInfo as b, parseVIN as p, validateVIN as v };

package/dist/phone/index.cjs

@@ -660,28 +660,42 @@ function maskPhoneNumber(phone, options = {}) {
   if (toMask.length < 4) {
     return phone;
   }
-  const { char = "*", separator } = options;
-  let { start = 4, end = 4 } = options;
-  if (start + end >= toMask.length) {
+  const { maskChar, separator, visibleStart, visibleEnd, start, end, char } = options;
+  const hasLegacyOptions = start !== void 0 || end !== void 0 || char !== void 0;
+  if (hasLegacyOptions) {
+    console.warn(
+      "[DEPRECATED] Mask options start/end/char are deprecated. Use visibleStart/visibleEnd/maskChar instead. These old names will be removed in v1.0.0."
+    );
+  }
+  const effectiveStart = visibleStart !== void 0 ? visibleStart : start !== void 0 ? start : 4;
+  const effectiveEnd = visibleEnd !== void 0 ? visibleEnd : end !== void 0 ? end : 4;
+  const effectiveChar = maskChar !== void 0 ? maskChar : char !== void 0 ? char : "*";
+  if (effectiveStart + effectiveEnd >= toMask.length) {
     if (toMask.length < 10) {
       const minMaskLength = 1;
       const availableForVisible = toMask.length - minMaskLength;
       if (availableForVisible >= 2) {
-        start = Math.floor(availableForVisible / 2);
-        end = availableForVisible - start;
+        const newStart = Math.floor(availableForVisible / 2);
+        const newEnd = availableForVisible - newStart;
+        const startPart2 = toMask.substring(0, newStart);
+        const endPart2 = toMask.substring(toMask.length - newEnd);
+        const masked2 = startPart2 + effectiveChar + endPart2;
+        if (separator) {
+          return `${startPart2}${separator}${effectiveChar}${separator}${endPart2}`;
+        }
+        return masked2;
       } else {
         return toMask;
       }
-    } else {
-      return toMask;
     }
+    return toMask;
   }
-  const startPart = toMask.substring(0, start);
-  const endPart = toMask.substring(toMask.length - end);
-  const maskLength = toMask.length - start - end;
-  const masked = startPart + char.repeat(maskLength) + endPart;
+  const startPart = toMask.substring(0, effectiveStart);
+  const endPart = toMask.substring(toMask.length - effectiveEnd);
+  const maskLength = toMask.length - effectiveStart - effectiveEnd;
+  const masked = startPart + effectiveChar.repeat(maskLength) + endPart;
   if (separator) {
-    return `${masked.substring(0, start)}${separator}${masked.substring(start, masked.length - end)}${separator}${masked.substring(masked.length - end)}`;
+    return `${masked.substring(0, effectiveStart)}${separator}${masked.substring(effectiveStart, masked.length - effectiveEnd)}${separator}${masked.substring(masked.length - effectiveEnd)}`;
   }
   return masked;
 }
@@ -773,6 +787,16 @@ function isProvider(phone, providerName) {
   return operator.toLowerCase() === providerName.toLowerCase();
 }
 
+// src/phone/errors.ts
+var InvalidPhoneError = class extends Error {
+  constructor(message = "Invalid phone number provided") {
+    super(message);
+    this.code = "INVALID_PHONE";
+    this.name = "InvalidPhoneError";
+  }
+};
+
+exports.InvalidPhoneError = InvalidPhoneError;
 exports.cleanPhoneNumber = cleanPhoneNumber;
 exports.comparePhones = comparePhones;
 exports.formatPhoneNumber = formatPhoneNumber;