@putkoff/abstract-utilities 1.0.31 → 1.0.34

package/dist/index.d.ts

@@ -360,12 +360,153 @@ declare function safeMultiply(...args: Array<number | string | null | undefined>
 declare function roundPercentage(x: any): number;
 declare function exponential(i: number, k: number): number;
 
-declare const toMeters: (v: number, unit: string) => number;
-declare const toSeconds: (v: number, unit: string) => number;
-declare const fromMeters: (d: number, unit: string) => number;
+type Second = 'sec' | 's' | 'second';
+type Hour = 'h' | 'hour';
+type Minute = 'm' | 'min' | 'minute';
+type Day = 'day' | 'd';
+type Mile = 'mi' | 'mile';
+type Kilometer = 'km' | 'kilometer';
+type Foot = 'ft' | 'f' | 'foot';
+type Meter = 'm' | 'meter';
+interface TargetAltIn {
+    angleDeg?: number | null;
+    targetAlt: number | null;
+    altUnit: DistanceUnit;
+    targetVel?: number | null;
+    velDistUnit?: DistanceUnit;
+    velTimeUnit?: TimeUnit;
+    startVel?: number | null;
+    startVelDist?: DistanceUnit;
+    startVelTime?: TimeUnit;
+}
+interface TargetVelIn {
+    angleDeg?: number | null;
+    targetAlt?: number | null;
+    altUnit?: DistanceUnit;
+    targetVel: number | null;
+    velDistUnit: DistanceUnit;
+    velTimeUnit: TimeUnit;
+    startVel?: number | null;
+    startVelDist?: DistanceUnit;
+    startVelTime?: TimeUnit;
+}
+interface StartVelIn {
+    angleDeg?: number | null;
+    targetAlt?: number | null;
+    altUnit?: DistanceUnit;
+    targetVel?: number | null;
+    velDistUnit?: DistanceUnit;
+    velTimeUnit?: TimeUnit;
+    startVel: number | null;
+    startVelDist: DistanceUnit;
+    startVelTime: TimeUnit;
+}
+interface OutSpeeds {
+    v: number;
+    d?: DistanceUnit;
+    t?: TimeUnit;
+}
+interface OutTimes {
+    t: number;
+    T?: TimeUnit;
+}
+interface ConvertDistance {
+    d: number;
+    fromDist: DistanceUnit;
+    toDist?: DistanceUnit;
+    vOnly?: boolean;
+}
+interface ConvertDistance {
+    d: number;
+    fromDist: DistanceUnit;
+    toDist?: DistanceUnit;
+    vOnly?: boolean;
+}
+interface ConvertTime {
+    t: number;
+    fromTime: TimeUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+interface ConvertTime {
+    t: number;
+    fromTime: TimeUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+interface ConvertSpeed {
+    v: number;
+    fromDist: DistanceUnit;
+    fromTime: TimeUnit;
+    toDist?: DistanceUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+interface ConvertSpeed {
+    v: number;
+    fromDist: DistanceUnit;
+    fromTime: TimeUnit;
+    toDist?: DistanceUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+type CanonDist = "m" | "km" | "mi" | "ft";
+type CanonTime = "s" | "min" | "h" | "day";
+type DistanceUnit = "m" | "meter" | "meters" | "km" | "kms" | "kilometer" | "kilometers" | "mi" | "mile" | "miles" | "ft" | "foot" | "feet" | "f";
+type TimeUnit = "s" | "sec" | "second" | "seconds" | "min" | "m" | "minute" | "minutes" | "h" | "hr" | "hour" | "hours" | "day" | "d" | "days";
+interface OutDistance {
+    d: number;
+    D?: DistanceUnit;
+}
+interface OutDistance {
+    d: number;
+    D?: DistanceUnit;
+}
+interface OutTime {
+    t: number;
+    T?: TimeUnit;
+}
+interface OutSpeed {
+    v: number;
+    d?: DistanceUnit;
+    t?: TimeUnit;
+}
+type OutDist = OutDistance | number | null;
+type OutTimeType = OutTime | number | null;
+type OutSpeedType = OutSpeed | number | null;
+
+declare const DIST_ALIASES: Record<string, CanonDist>;
+declare const TIME_ALIASES: Record<string, CanonTime>;
+declare const DIST_FACTORS: Record<CanonDist, number>;
+declare const TIME_FACTORS: Record<CanonTime, number>;
+declare function canonDist(u: DistanceUnit | string | undefined): CanonDist;
+declare function canonTime(u: TimeUnit | string | undefined): CanonTime;
+declare function distanceToMeters(d: number, unit: DistanceUnit | string): number;
+declare function metersToDistance(v: number, unit: DistanceUnit | string): number;
+declare function timeToSeconds(t: number, unit: TimeUnit | string): number;
+declare function secondsToTime(v: number, unit: TimeUnit | string): number;
+declare function speedToMps(v: number, distUnit: DistanceUnit | string, timeUnit: TimeUnit | string): number;
+declare function mpsToSpeed(vMps: number, distUnit: DistanceUnit | string, timeUnit: TimeUnit | string): number;
+declare function convertDistance({ d, fromDist, toDist, vOnly, }: ConvertDistance): OutDist;
+declare function convertTime({ t, fromTime, toTime, vOnly, }: ConvertTime): OutTimeType;
+declare function convertSpeed({ v, fromDist, fromTime, toDist, toTime, vOnly, }: ConvertSpeed): OutSpeedType;
+interface UnitConverter<T> {
+    normalize: (value: number, unit: T) => number;
+    unnormalize: (value: number, unit: T) => number;
+}
+declare const DistanceConverter: UnitConverter<DistanceUnit>;
+declare const TimeConverter: UnitConverter<TimeUnit>;
+declare const SpeedConverter: UnitConverter<[DistanceUnit, TimeUnit]>;
+declare const toMeters: typeof distanceToMeters;
+declare const fromMeters: typeof metersToDistance;
+declare const toSeconds: typeof timeToSeconds;
+declare const fromSeconds: typeof secondsToTime;
 declare const velocityToMs: (value: number, unit: string) => number;
 declare const velocityFromMs: (value: number, unit: string) => number;
-declare const fromMps: (v: number, dist_unit: string, time_unit: string) => number;
+/** Non-canonical helper for arbitrary rate conversion, e.g. ft/day → m/s */
+declare const fromMps: (v: number, dist_unit: DistanceUnit | string, time_unit: TimeUnit | string) => number;
+declare const isFiniteNum: (x: any) => x is number;
+declare const fmt: (n: number, digits?: number) => string;
 
 declare const SECOND: number;
 declare const ZEPTOSECOND: number;
@@ -387,12 +528,12 @@ declare const SECONDS_PER_HOUR: number;
 declare const SECONDS_PER_DAY: number;
 declare const PI: number;
 declare const PI2: number;
-declare const M_IN_KM = 1000;
-declare const M_IN_MI = 1609.34;
-declare const M_IN_FT = 0.3048;
-declare const KM_IN_M: number;
-declare const MI_IN_M: number;
-declare const FT_IN_M: number;
+declare const METERS_PER_KM = 1000;
+declare const METERS_PER_MILE = 1609.34;
+declare const METERS_PER_FOOT = 0.3048;
+declare const KMS_PER_METER: number;
+declare const MILES_PER_METER: number;
+declare const FEET_PER_METER: number;
 declare const MIN_IN_S: number;
 declare const HOUR_IN_S: number;
 declare const DAY_IN_S: number;
@@ -648,5 +789,5 @@ declare function processKeywords(keywords: string | string[]): string[];
  */
 declare function get_keyword_string(keywords: any): string;
 
-export { API_PREFIX, ATTOSECOND, BASE_URL, Button, CENTISECOND, Checkbox, DAY, DAY_IN_S, DECISECOND, DEV_PREFIX, DOMAIN_NAME, FEMTOSECOND, FT_IN_M, HOUR, HOUR_IN_S, Input, KM_IN_M, MEDIA_TYPES, MICROSECOND, MILISECOND, MIME_TYPES, MINUTE, MIN_IN_S, MI_IN_M, MONTH, MONTH_IN_S, MPerS_TO_MiPerH, M_IN_FT, M_IN_KM, M_IN_MI, MiPerH_TO_MPerS, NANOSECOND, PI, PI2, PICOSECOND, PROD_PREFIX, PROTOCOL, SECOND, SECONDS_PER_DAY, SECONDS_PER_HOUR, SECONDS_PER_MINUTE, SUB_DIR, Spinner, YEAR, YEAR_IN_S, ZEPTOSECOND, alertit, assureArray, assureList, assureNumber, assureString, assure_array, assure_list, assure_number, assure_string, callStorage, callWindowMethod, capitalize, capitalize_str, checkResponse, cleanArray, cleanText, confirmType, confirm_type, create_list_string, currentUsername, currentUsernames, decodeJwt, eatAll, eatEnd, eatInner, eatOuter, ensureArray, ensureList, ensureNumber, ensureString, ensure_array, ensure_list, ensure_number, ensure_string, exponential, fetchIndexHtml, fetchIndexHtmlContainer, fetchIt, formatNumber, fromMeters, fromMps, geAuthsUtilsDirectory, geBackupsUtilsDirectory, geConstantsUtilsDirectory, geEnvUtilsDirectory, geFetchUtilsDirectory, geFileUtilsDirectory, gePathUtilsDirectory, geStaticDirectory, geStringUtilsDirectory, geTypeUtilsDirectory, get, getAbsDir, getAbsPath, getAllFileTypes, getAllFileTypesSync, getAlphaNum, getAlphas, getAuthorizationHeader, getBaseDir, getBody, getChar, getCleanArray, getComponentsUtilsDirectory, getConfig, getConfigContent, getConfigVar, getDbConfigsPath, getDistDir, getDocumentProp, getEnvDir, getEnvPath, getFetchVars, getFunctionsDir, getFunctionsUtilsDirectory, getHeaders, getHooksUtilsDirectory, getHtmlDirectory, getLibUtilsDirectory, getMediaExts, getMediaMap, getMethod, getMimeType, getNums, getPublicDir, getResult, getSafeDocument, getSafeLocalStorage, getSafeWindow, getSchemasDirPath, getSchemasPath, getSrcDir, getSubstring, getToken, getWindowHost, getWindowProp, get_all_file_types, get_basename, get_dirname, get_extname, get_filename, get_full_path, get_full_url, get_key_value, get_keyword_string, get_media_exts, get_media_map, get_mime_type, get_relative_path, get_splitext, get_window, get_window_location, get_window_parts, get_window_pathname, isLoggedIn, isMediaType, isNum, isStrInString, isTokenExpired, isType, is_media_type, loadConfig, make_path, make_sanitized_path, normalizeUrl, parseResult, path_to_url, processKeywords, readJsonFile, removeToken, requireToken, roundPercentage, safeDivide, safeGlobalProp, safeMultiply, safeNums, safeStorage, sanitizeFilename, stripPrefixes, toMeters, toSeconds, truncateString, tryParse, urlJoin, url_to_path, velocityFromMs, velocityToMs };
-export type { ApiRow, AppConfig, ChangePasswordFormProps, ChangePasswordProps, FetchVariables, FileItem, FileListResponse, InputProps, JwtPayload, LoginFormProps, LoginProps, LogoutButtonProps, MediaCategory, MediaMap, MediaOptions, MimeByExt, Promise$1 as Promise, UrlKey };
+export { API_PREFIX, ATTOSECOND, BASE_URL, Button, CENTISECOND, Checkbox, DAY, DAY_IN_S, DECISECOND, DEV_PREFIX, DIST_ALIASES, DIST_FACTORS, DOMAIN_NAME, DistanceConverter, FEET_PER_METER, FEMTOSECOND, HOUR, HOUR_IN_S, Input, KMS_PER_METER, MEDIA_TYPES, METERS_PER_FOOT, METERS_PER_KM, METERS_PER_MILE, MICROSECOND, MILES_PER_METER, MILISECOND, MIME_TYPES, MINUTE, MIN_IN_S, MONTH, MONTH_IN_S, MPerS_TO_MiPerH, MiPerH_TO_MPerS, NANOSECOND, PI, PI2, PICOSECOND, PROD_PREFIX, PROTOCOL, SECOND, SECONDS_PER_DAY, SECONDS_PER_HOUR, SECONDS_PER_MINUTE, SUB_DIR, SpeedConverter, Spinner, TIME_ALIASES, TIME_FACTORS, TimeConverter, YEAR, YEAR_IN_S, ZEPTOSECOND, alertit, assureArray, assureList, assureNumber, assureString, assure_array, assure_list, assure_number, assure_string, callStorage, callWindowMethod, canonDist, canonTime, capitalize, capitalize_str, checkResponse, cleanArray, cleanText, confirmType, confirm_type, convertDistance, convertSpeed, convertTime, create_list_string, currentUsername, currentUsernames, decodeJwt, distanceToMeters, eatAll, eatEnd, eatInner, eatOuter, ensureArray, ensureList, ensureNumber, ensureString, ensure_array, ensure_list, ensure_number, ensure_string, exponential, fetchIndexHtml, fetchIndexHtmlContainer, fetchIt, fmt, formatNumber, fromMeters, fromMps, fromSeconds, geAuthsUtilsDirectory, geBackupsUtilsDirectory, geConstantsUtilsDirectory, geEnvUtilsDirectory, geFetchUtilsDirectory, geFileUtilsDirectory, gePathUtilsDirectory, geStaticDirectory, geStringUtilsDirectory, geTypeUtilsDirectory, get, getAbsDir, getAbsPath, getAllFileTypes, getAllFileTypesSync, getAlphaNum, getAlphas, getAuthorizationHeader, getBaseDir, getBody, getChar, getCleanArray, getComponentsUtilsDirectory, getConfig, getConfigContent, getConfigVar, getDbConfigsPath, getDistDir, getDocumentProp, getEnvDir, getEnvPath, getFetchVars, getFunctionsDir, getFunctionsUtilsDirectory, getHeaders, getHooksUtilsDirectory, getHtmlDirectory, getLibUtilsDirectory, getMediaExts, getMediaMap, getMethod, getMimeType, getNums, getPublicDir, getResult, getSafeDocument, getSafeLocalStorage, getSafeWindow, getSchemasDirPath, getSchemasPath, getSrcDir, getSubstring, getToken, getWindowHost, getWindowProp, get_all_file_types, get_basename, get_dirname, get_extname, get_filename, get_full_path, get_full_url, get_key_value, get_keyword_string, get_media_exts, get_media_map, get_mime_type, get_relative_path, get_splitext, get_window, get_window_location, get_window_parts, get_window_pathname, isFiniteNum, isLoggedIn, isMediaType, isNum, isStrInString, isTokenExpired, isType, is_media_type, loadConfig, make_path, make_sanitized_path, metersToDistance, mpsToSpeed, normalizeUrl, parseResult, path_to_url, processKeywords, readJsonFile, removeToken, requireToken, roundPercentage, safeDivide, safeGlobalProp, safeMultiply, safeNums, safeStorage, sanitizeFilename, secondsToTime, speedToMps, stripPrefixes, timeToSeconds, toMeters, toSeconds, truncateString, tryParse, urlJoin, url_to_path, velocityFromMs, velocityToMs };
+export type { ApiRow, AppConfig, CanonDist, CanonTime, ChangePasswordFormProps, ChangePasswordProps, ConvertDistance, ConvertSpeed, ConvertTime, Day, DistanceUnit, FetchVariables, FileItem, FileListResponse, Foot, Hour, InputProps, JwtPayload, Kilometer, LoginFormProps, LoginProps, LogoutButtonProps, MediaCategory, MediaMap, MediaOptions, Meter, Mile, MimeByExt, Minute, OutDist, OutDistance, OutSpeed, OutSpeedType, OutSpeeds, OutTime, OutTimeType, OutTimes, Promise$1 as Promise, Second, StartVelIn, TargetAltIn, TargetVelIn, TimeUnit, UnitConverter, UrlKey };

package/dist/types/functions/math_utils/constants.d.ts

@@ -18,12 +18,12 @@ export declare const SECONDS_PER_HOUR: number;
 export declare const SECONDS_PER_DAY: number;
 export declare const PI: number;
 export declare const PI2: number;
-export declare const M_IN_KM = 1000;
-export declare const M_IN_MI = 1609.34;
-export declare const M_IN_FT = 0.3048;
-export declare const KM_IN_M: number;
-export declare const MI_IN_M: number;
-export declare const FT_IN_M: number;
+export declare const METERS_PER_KM = 1000;
+export declare const METERS_PER_MILE = 1609.34;
+export declare const METERS_PER_FOOT = 0.3048;
+export declare const KMS_PER_METER: number;
+export declare const MILES_PER_METER: number;
+export declare const FEET_PER_METER: number;
 export declare const MIN_IN_S: number;
 export declare const HOUR_IN_S: number;
 export declare const DAY_IN_S: number;

package/dist/types/functions/math_utils/conversions.d.ts

@@ -1,6 +1,33 @@
-export declare const toMeters: (v: number, unit: string) => number;
-export declare const toSeconds: (v: number, unit: string) => number;
-export declare const fromMeters: (d: number, unit: string) => number;
+import type { CanonTime, CanonDist, DistanceUnit, TimeUnit, ConvertDistance, ConvertTime, ConvertSpeed, OutDist, OutTimeType, OutSpeedType } from './scaleInterfaces';
+export declare const DIST_ALIASES: Record<string, CanonDist>;
+export declare const TIME_ALIASES: Record<string, CanonTime>;
+export declare const DIST_FACTORS: Record<CanonDist, number>;
+export declare const TIME_FACTORS: Record<CanonTime, number>;
+export declare function canonDist(u: DistanceUnit | string | undefined): CanonDist;
+export declare function canonTime(u: TimeUnit | string | undefined): CanonTime;
+export declare function distanceToMeters(d: number, unit: DistanceUnit | string): number;
+export declare function metersToDistance(v: number, unit: DistanceUnit | string): number;
+export declare function timeToSeconds(t: number, unit: TimeUnit | string): number;
+export declare function secondsToTime(v: number, unit: TimeUnit | string): number;
+export declare function speedToMps(v: number, distUnit: DistanceUnit | string, timeUnit: TimeUnit | string): number;
+export declare function mpsToSpeed(vMps: number, distUnit: DistanceUnit | string, timeUnit: TimeUnit | string): number;
+export declare function convertDistance({ d, fromDist, toDist, vOnly, }: ConvertDistance): OutDist;
+export declare function convertTime({ t, fromTime, toTime, vOnly, }: ConvertTime): OutTimeType;
+export declare function convertSpeed({ v, fromDist, fromTime, toDist, toTime, vOnly, }: ConvertSpeed): OutSpeedType;
+export interface UnitConverter<T> {
+    normalize: (value: number, unit: T) => number;
+    unnormalize: (value: number, unit: T) => number;
+}
+export declare const DistanceConverter: UnitConverter<DistanceUnit>;
+export declare const TimeConverter: UnitConverter<TimeUnit>;
+export declare const SpeedConverter: UnitConverter<[DistanceUnit, TimeUnit]>;
+export declare const toMeters: typeof distanceToMeters;
+export declare const fromMeters: typeof metersToDistance;
+export declare const toSeconds: typeof timeToSeconds;
+export declare const fromSeconds: typeof secondsToTime;
 export declare const velocityToMs: (value: number, unit: string) => number;
 export declare const velocityFromMs: (value: number, unit: string) => number;
-export declare const fromMps: (v: number, dist_unit: string, time_unit: string) => number;
+/** Non-canonical helper for arbitrary rate conversion, e.g. ft/day → m/s */
+export declare const fromMps: (v: number, dist_unit: DistanceUnit | string, time_unit: TimeUnit | string) => number;
+export declare const isFiniteNum: (x: any) => x is number;
+export declare const fmt: (n: number, digits?: number) => string;

package/dist/types/functions/math_utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './safe_math';
 export * from './conversions';
 export * from './constants';
+export * from './scaleInterfaces';

package/dist/types/functions/math_utils/scaleInterfaces.d.ts

@@ -0,0 +1,114 @@
+export type Second = 'sec' | 's' | 'second';
+export type Hour = 'h' | 'hour';
+export type Minute = 'm' | 'min' | 'minute';
+export type Day = 'day' | 'd';
+export type Mile = 'mi' | 'mile';
+export type Kilometer = 'km' | 'kilometer';
+export type Foot = 'ft' | 'f' | 'foot';
+export type Meter = 'm' | 'meter';
+export interface TargetAltIn {
+    angleDeg?: number | null;
+    targetAlt: number | null;
+    altUnit: DistanceUnit;
+    targetVel?: number | null;
+    velDistUnit?: DistanceUnit;
+    velTimeUnit?: TimeUnit;
+    startVel?: number | null;
+    startVelDist?: DistanceUnit;
+    startVelTime?: TimeUnit;
+}
+export interface TargetVelIn {
+    angleDeg?: number | null;
+    targetAlt?: number | null;
+    altUnit?: DistanceUnit;
+    targetVel: number | null;
+    velDistUnit: DistanceUnit;
+    velTimeUnit: TimeUnit;
+    startVel?: number | null;
+    startVelDist?: DistanceUnit;
+    startVelTime?: TimeUnit;
+}
+export interface StartVelIn {
+    angleDeg?: number | null;
+    targetAlt?: number | null;
+    altUnit?: DistanceUnit;
+    targetVel?: number | null;
+    velDistUnit?: DistanceUnit;
+    velTimeUnit?: TimeUnit;
+    startVel: number | null;
+    startVelDist: DistanceUnit;
+    startVelTime: TimeUnit;
+}
+export interface ConvertSpeed {
+    v: number;
+    fromDist: DistanceUnit;
+    fromTime: TimeUnit;
+    toDist?: DistanceUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+export interface OutSpeeds {
+    v: number;
+    d?: DistanceUnit;
+    t?: TimeUnit;
+}
+export interface ConvertTime {
+    t: number;
+    fromTime: TimeUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+export interface OutTimes {
+    t: number;
+    T?: TimeUnit;
+}
+export interface ConvertDistance {
+    d: number;
+    fromDist: DistanceUnit;
+    toDist?: DistanceUnit;
+    vOnly?: boolean;
+}
+export interface OutDistance {
+    d: number;
+    D?: DistanceUnit;
+}
+export interface ConvertDistance {
+    d: number;
+    fromDist: DistanceUnit;
+    toDist?: DistanceUnit;
+    vOnly?: boolean;
+}
+export interface ConvertTime {
+    t: number;
+    fromTime: TimeUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+export interface ConvertSpeed {
+    v: number;
+    fromDist: DistanceUnit;
+    fromTime: TimeUnit;
+    toDist?: DistanceUnit;
+    toTime?: TimeUnit;
+    vOnly?: boolean;
+}
+export type CanonDist = "m" | "km" | "mi" | "ft";
+export type CanonTime = "s" | "min" | "h" | "day";
+export type DistanceUnit = "m" | "meter" | "meters" | "km" | "kms" | "kilometer" | "kilometers" | "mi" | "mile" | "miles" | "ft" | "foot" | "feet" | "f";
+export type TimeUnit = "s" | "sec" | "second" | "seconds" | "min" | "m" | "minute" | "minutes" | "h" | "hr" | "hour" | "hours" | "day" | "d" | "days";
+export interface OutDistance {
+    d: number;
+    D?: DistanceUnit;
+}
+export interface OutTime {
+    t: number;
+    T?: TimeUnit;
+}
+export interface OutSpeed {
+    v: number;
+    d?: DistanceUnit;
+    t?: TimeUnit;
+}
+export type OutDist = OutDistance | number | null;
+export type OutTimeType = OutTime | number | null;
+export type OutSpeedType = OutSpeed | number | null;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@putkoff/abstract-utilities",
-    "version": "1.0.31",
+    "version": "1.0.34",
     "type": "module",
     "description": "A reusable React Login component with JWT authentication",
     "main": "dist/cjs/index.js",