mazey 5.6.9 → 5.7.0

package/lib/index.d.ts

@@ -1969,12 +1969,12 @@ declare function sha256Hex(input: string | BufferSource): Promise<string>;
  * Usage:
  *
  * ```javascript
- * import { isMobile } from "mazey";
+ * import { isValidPhoneNumber } from "mazey";
  *
- * const ret1 = isMobile("13800138000");
- * const ret2 = isMobile("1380013800");
- * const ret3 = isMobile("138001380000");
- * const ret4 = isMobile("1380013800a");
+ * const ret1 = isValidPhoneNumber("13800138000");
+ * const ret2 = isValidPhoneNumber("1380013800");
+ * const ret3 = isValidPhoneNumber("138001380000");
+ * const ret4 = isValidPhoneNumber("1380013800a");
  * console.log(ret1, ret2, ret3, ret4);
  * ```
  *
@@ -1989,6 +1989,15 @@ declare function sha256Hex(input: string | BufferSource): Promise<string>;
  * @category Util
  */
 declare function isValidPhoneNumber(mobile: string): boolean;
+/**
+ * Alias of {@link isValidPhoneNumber}.
+ *
+ * This helper validates an 11-digit Chinese mobile-shaped number. It does not
+ * detect a browser's device form factor; use `isPhone` for that purpose.
+ *
+ * @category Util
+ */
+declare const isMobile: typeof isValidPhoneNumber;
 /**
  * Check if the given string is a valid email.
  *
@@ -2885,6 +2894,50 @@ interface ResolveElementTargetOptions {
     /** Optional adapter for ref-like or framework-specific target wrappers. */
     unwrap?: (value: unknown) => unknown;
 }
+/**
+ * A target accepted by the DOM visibility helpers.
+ *
+ * @category DOM
+ */
+type DomVisibilityTarget = string | Element | Iterable<Element> | ArrayLike<Element> | null | undefined;
+/**
+ * Hide every resolved element while preserving its visible inline `display`
+ * value for a later call to {@link show}.
+ *
+ * ```javascript
+ * import { hide } from "mazey";
+ *
+ * hide(".notice");
+ * ```
+ *
+ * @remarks Selectors use the global document. Direct elements and collections
+ * use their owning documents. Invalid selectors and unsupported values are
+ * ignored. Duplicate elements are mutated once.
+ * @param target Selector, element, iterable, array-like collection, or an empty target.
+ * @returns The original target unchanged, to support chaining by the caller.
+ * @category DOM
+ */
+declare function hide<T extends DomVisibilityTarget>(target: T): T;
+/**
+ * Show every resolved element by restoring a display value preserved by
+ * {@link hide}, or by applying the document-aware default for CSS-hidden
+ * elements.
+ *
+ * ```javascript
+ * import { show } from "mazey";
+ *
+ * const notices = document.querySelectorAll(".notice");
+ * show(notices);
+ * ```
+ *
+ * @remarks Selectors use the global document. Direct elements and collections
+ * use their owning documents. Invalid selectors and unsupported values are
+ * ignored. Duplicate elements are mutated once.
+ * @param target Selector, element, iterable, array-like collection, or an empty target.
+ * @returns The original target unchanged, to support chaining by the caller.
+ * @category DOM
+ */
+declare function show<T extends DomVisibilityTarget>(target: T): T;
 /**
  * Resolve an element from a direct element, a selector, an optionally
  * unwrapped value, or a component-like object containing an `$el` element.
@@ -3673,6 +3726,68 @@ declare function getPerformance(camelCase?: boolean): Promise<WebPerformance>;
  * @category Browser Information
  */
 type VisitorType = "crawler" | "automation" | "unknown";
+/**
+ * Check whether a user agent represents a mobile phone or handset-class
+ * device. Tablet devices are classified separately by {@link isTablet}.
+ *
+ * The classifier recognizes iPhone and iPod user agents, Android user agents
+ * that contain the `Mobile` token, and a bounded `Mobile` token as a fallback
+ * for otherwise unknown clients. Stronger tablet signals take priority.
+ *
+ * @param userAgent Optional user-agent string. Defaults to the current
+ * browser's guarded navigator signals. An explicit string is classified by
+ * itself without current platform or touch information.
+ * @returns `true` for a recognized phone or handset-class device; otherwise
+ * `false`. Returns `false` during SSR when no explicit user agent is available.
+ * @throws {TypeError} If an explicitly supplied user agent is not a string.
+ * @remarks Device classification is heuristic and spoofable. Do not use this
+ * helper as a security boundary or as a substitute for responsive CSS or
+ * feature detection. It does not inspect viewport dimensions. The separate
+ * `isMobile` export is an alias of the `isValidPhoneNumber` string validator.
+ * @category Browser Information
+ */
+declare function isPhone(userAgent?: string): boolean;
+/**
+ * Check whether a user agent represents a desktop or laptop-class device.
+ *
+ * The classifier recognizes Windows, ordinary macOS, Linux, and ChromeOS.
+ * Touch capability does not make a Windows device a tablet. A current browser
+ * with the existing MacIntel multi-touch iPadOS compatibility signals is
+ * excluded from desktop classification.
+ *
+ * @param userAgent Optional user-agent string. Defaults to the current
+ * browser's guarded navigator signals. An explicit string is classified by
+ * itself without current platform or touch information.
+ * @returns `true` for a recognized desktop or laptop-class device; otherwise
+ * `false`. Returns `false` during SSR when no explicit user agent is available.
+ * @throws {TypeError} If an explicitly supplied user agent is not a string.
+ * @remarks Device classification is heuristic and spoofable. Do not use this
+ * helper as a security boundary or as a substitute for responsive CSS or
+ * feature detection. It does not inspect viewport dimensions.
+ * @category Browser Information
+ */
+declare function isDesktop(userAgent?: string): boolean;
+/**
+ * Check whether a user agent represents a tablet device.
+ *
+ * The classifier recognizes conventional iPad user agents, bounded `Tablet`
+ * tokens, and Android user agents without a `Mobile` token. When no explicit
+ * user agent is supplied, it also recognizes modern iPadOS desktop mode from a
+ * Macintosh user agent, `MacIntel` platform, and more than one touch point.
+ * An explicit user agent never borrows current platform or touch signals.
+ *
+ * @param userAgent Optional user-agent string. Defaults to the current
+ * browser's guarded navigator signals. An explicit string is classified by
+ * itself without current platform or touch information.
+ * @returns `true` for a recognized tablet device; otherwise `false`. Returns
+ * `false` during SSR when no explicit user agent is available.
+ * @throws {TypeError} If an explicitly supplied user agent is not a string.
+ * @remarks Device classification is heuristic and spoofable. Do not use this
+ * helper as a security boundary or as a substitute for responsive CSS or
+ * feature detection. It does not inspect viewport dimensions.
+ * @category Browser Information
+ */
+declare function isTablet(userAgent?: string): boolean;
 /**
  * Check whether a user agent represents iOS or iPadOS.
  *
@@ -4382,5 +4497,5 @@ declare const mazeyCon: Console;
  */
 declare const timeCon: Console;
 
-export { addClass, addEvent, addStyle, assignDefined, calLongestCommonSubsequence, calLongestCommonSubstring, calculateCAGR, camelCase2Underscore, camelCaseToKebabCase, cancelBubble, clearHTML, clearHtml, convert10To26, convertCamelToKebab, convertCamelToUnder, convertHttpToHttps, convertKebabToCamel, convertObjectToQuery, convertToHtmlBreaks, convertUnderToCamel, cutCHSString, cutZHString, debounce, deepCopy, deepCopyObject, deepFreeze, delCookie, derivePackageMetadata, detectVisitorType, doFn, escapeHtmlAttribute, extractElementText, fireEvent, floatFixed, floatToPercent, formatByteSize, formatDate, formatDistanceToNow, formatDurationFromMs, formatLocalDateTime, genBrowserAttrs, genCustomConsole, genHashCode, genRndNumString, genStyleString, genUniqueNumString, generateCalendarVersion, generateRndNum, generateUniqueNum, getAllQueryParams, getBrowserInfo, getCLS, getCookie, getCurrentVersion, getDateDifference, getDefineListeners, getDomain, getFCP, getFID, getFP, getFileSize, getFriendlyInterval, getHashQueryParam, getLCP, getLocalJSON, getLocalStorage, getPageMeta, getPerformance, getQueryParam, getScriptQueryParam, getSessionJSON, getSessionStorage, getSystemTheme, getTTFB, getUrlFileType, getUrlHost, getUrlParam, getUrlPath, hasClass, inRate, invokeEvent, invokeFn, isAndroid, isArray, isBool, isBoolean, isBrowser, isFunction, isHit, isIOS, isJSONString, isJsonString, isLinux, isMacOS, isNonEmptyArray, isNonEmptyObject, isNumber, isPureObject, isSafePWAEnv, isStandalonePWA, isString, isSupportWebp, isSupportedEntryType, isThisHour, isThisMonth, isThisWeek, isThisYear, isToday, isUdfOrNul, isValidCssSelector, isValidData, isValidDate, isValidEmail, isValidHttpUrl, isValidPhoneNumber, isValidUrl, isWindows, listenMediaQueryChanges, loadCSS, loadImage, loadScript, loadScriptIfUndefined, longestComSubsequence, longestComSubstring, mNow, mTrim, mazeyCon, newLine, onURLChange, parseGitHubRepository, parseJsonSafe, parseLocalDateTime, removeClass, removeCookie, removeEvent, removeHTML, removeHtml, repeatUntilConditionMet, replaceHttp, resolveElementTarget, resolveLanguagePreference, resolveThemePreference, sanitizeInput, setClass, setCookie, setImgSizeBySrc, setImgWidHeiBySrc, setLanguagePreference, setLocalJSON, setLocalStorage, setSessionJSON, setSessionStorage, setThemePreference, sha256Hex, sleep, subYears, throttle, timeCon, toJavaScriptGlobalName, truncateZHString, unsanitize, unsanitizeInput, updateQueryParam, waitTime, watchServiceWorkerUpdates, windowLoaded, zAxiosIsValidRes };
-export type { DerivePackageMetadataOptions, DerivedPackageMetadata, FormatByteSizeOptions, GitHubRepositoryDetails, InvestmentReturnRate, IsSafePWAEnvOptions, LocalDateTimePrecision, PackageManager, PackageManifest, PackageManifestAuthor, PreferenceResult, ResolveElementTargetOptions, ResolvedTheme, ServiceWorkerUpdateCallbacks, ServiceWorkerUpdateWatcher, ThemePreference, VisitorType };
+export { addClass, addEvent, addStyle, assignDefined, calLongestCommonSubsequence, calLongestCommonSubstring, calculateCAGR, camelCase2Underscore, camelCaseToKebabCase, cancelBubble, clearHTML, clearHtml, convert10To26, convertCamelToKebab, convertCamelToUnder, convertHttpToHttps, convertKebabToCamel, convertObjectToQuery, convertToHtmlBreaks, convertUnderToCamel, cutCHSString, cutZHString, debounce, deepCopy, deepCopyObject, deepFreeze, delCookie, derivePackageMetadata, detectVisitorType, doFn, escapeHtmlAttribute, extractElementText, fireEvent, floatFixed, floatToPercent, formatByteSize, formatDate, formatDistanceToNow, formatDurationFromMs, formatLocalDateTime, genBrowserAttrs, genCustomConsole, genHashCode, genRndNumString, genStyleString, genUniqueNumString, generateCalendarVersion, generateRndNum, generateUniqueNum, getAllQueryParams, getBrowserInfo, getCLS, getCookie, getCurrentVersion, getDateDifference, getDefineListeners, getDomain, getFCP, getFID, getFP, getFileSize, getFriendlyInterval, getHashQueryParam, getLCP, getLocalJSON, getLocalStorage, getPageMeta, getPerformance, getQueryParam, getScriptQueryParam, getSessionJSON, getSessionStorage, getSystemTheme, getTTFB, getUrlFileType, getUrlHost, getUrlParam, getUrlPath, hasClass, hide, inRate, invokeEvent, invokeFn, isAndroid, isArray, isBool, isBoolean, isBrowser, isDesktop, isFunction, isHit, isIOS, isJSONString, isJsonString, isLinux, isMacOS, isMobile, isNonEmptyArray, isNonEmptyObject, isNumber, isPhone, isPureObject, isSafePWAEnv, isStandalonePWA, isString, isSupportWebp, isSupportedEntryType, isTablet, isThisHour, isThisMonth, isThisWeek, isThisYear, isToday, isUdfOrNul, isValidCssSelector, isValidData, isValidDate, isValidEmail, isValidHttpUrl, isValidPhoneNumber, isValidUrl, isWindows, listenMediaQueryChanges, loadCSS, loadImage, loadScript, loadScriptIfUndefined, longestComSubsequence, longestComSubstring, mNow, mTrim, mazeyCon, newLine, onURLChange, parseGitHubRepository, parseJsonSafe, parseLocalDateTime, removeClass, removeCookie, removeEvent, removeHTML, removeHtml, repeatUntilConditionMet, replaceHttp, resolveElementTarget, resolveLanguagePreference, resolveThemePreference, sanitizeInput, setClass, setCookie, setImgSizeBySrc, setImgWidHeiBySrc, setLanguagePreference, setLocalJSON, setLocalStorage, setSessionJSON, setSessionStorage, setThemePreference, sha256Hex, show, sleep, subYears, throttle, timeCon, toJavaScriptGlobalName, truncateZHString, unsanitize, unsanitizeInput, updateQueryParam, waitTime, watchServiceWorkerUpdates, windowLoaded, zAxiosIsValidRes };
+export type { DerivePackageMetadataOptions, DerivedPackageMetadata, DomVisibilityTarget, FormatByteSizeOptions, GitHubRepositoryDetails, InvestmentReturnRate, IsSafePWAEnvOptions, LocalDateTimePrecision, PackageManager, PackageManifest, PackageManifestAuthor, PreferenceResult, ResolveElementTargetOptions, ResolvedTheme, ServiceWorkerUpdateCallbacks, ServiceWorkerUpdateWatcher, ThemePreference, VisitorType };