@augment-vir/common 23.4.0 → 25.0.0

package/dist/cjs/augments/error.js

@@ -52,9 +52,9 @@ function ensureErrorAndPrependMessage(maybeError, prependMessage) {
     return error;
 }
 exports.ensureErrorAndPrependMessage = ensureErrorAndPrependMessage;
-function wrapInTry(inputs) {
+function wrapInTry(callback, inputs) {
     try {
-        const returnValue = inputs.callback();
+        const returnValue = callback();
         if (returnValue instanceof Promise) {
             return returnValue.catch((error) => {
                 if (inputs.catchCallback) {

package/dist/cjs/index.js

@@ -49,9 +49,7 @@ __exportStar(require("./augments/promise/wait"), exports);
 __exportStar(require("./augments/random"), exports);
 __exportStar(require("./augments/regexp"), exports);
 __exportStar(require("./augments/string/prefixes"), exports);
-__exportStar(require("./augments/string/search-params"), exports);
 __exportStar(require("./augments/string/suffixes"), exports);
-__exportStar(require("./augments/string/url"), exports);
 __exportStar(require("./augments/string/uuid"), exports);
 __exportStar(require("./augments/time"), exports);
 __exportStar(require("./augments/truncate-number"), exports);

package/dist/esm/augments/error.js

@@ -44,9 +44,9 @@ export function ensureErrorAndPrependMessage(maybeError, prependMessage) {
     error.message = `${prependMessage}: ${error.message}`;
     return error;
 }
-export function wrapInTry(inputs) {
+export function wrapInTry(callback, inputs) {
     try {
-        const returnValue = inputs.callback();
+        const returnValue = callback();
         if (returnValue instanceof Promise) {
             return returnValue.catch((error) => {
                 if (inputs.catchCallback) {

package/dist/esm/index.js

@@ -33,9 +33,7 @@ export * from './augments/promise/wait';
 export * from './augments/random';
 export * from './augments/regexp';
 export * from './augments/string/prefixes';
-export * from './augments/string/search-params';
 export * from './augments/string/suffixes';
-export * from './augments/string/url';
 export * from './augments/string/uuid';
 export * from './augments/time';
 export * from './augments/truncate-number';

package/dist/types/augments/error.d.ts

@@ -9,12 +9,10 @@ export declare function combineErrorMessages(errors?: ReadonlyArray<Error | stri
 export declare function extractErrorMessage(maybeError: unknown): string;
 export declare function ensureError(maybeError: unknown): Error;
 export declare function ensureErrorAndPrependMessage(maybeError: unknown, prependMessage: string): Error;
-export type TryWrapInputs<CallbackReturn, FallbackReturn> = {
-    callback: () => CallbackReturn;
-} & RequireExactlyOne<{
+export type TryWrapConfig<FallbackReturn> = RequireExactlyOne<{
     fallbackValue: FallbackReturn;
     catchCallback: (error: unknown) => FallbackReturn;
 }>;
-export declare function wrapInTry<CallbackReturn, FallbackReturn>(inputs: TryWrapInputs<CallbackReturn, FallbackReturn>): FallbackReturn | CallbackReturn;
+export declare function wrapInTry<CallbackReturn, FallbackReturn>(callback: () => CallbackReturn, inputs: TryWrapConfig<FallbackReturn>): FallbackReturn | CallbackReturn;
 export declare function executeAndReturnError<CallbackGeneric extends NoInputsFunction<PromiseLike<any>>>(callback: CallbackGeneric): Promise<Error | Awaited<ReturnType<CallbackGeneric>>>;
 export declare function executeAndReturnError<CallbackGeneric extends NoInputsFunction>(callback: CallbackGeneric): Error | ReturnType<CallbackGeneric>;

package/dist/types/index.d.ts

@@ -33,9 +33,7 @@ export * from './augments/promise/wait';
 export * from './augments/random';
 export * from './augments/regexp';
 export * from './augments/string/prefixes';
-export * from './augments/string/search-params';
 export * from './augments/string/suffixes';
-export * from './augments/string/url';
 export * from './augments/string/uuid';
 export * from './augments/time';
 export * from './augments/truncate-number';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "23.4.0",
+    "version": "25.0.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -26,7 +26,7 @@
     "dependencies": {
         "browser-or-node": "^2.1.1",
         "run-time-assertions": "^1.0.0",
-        "type-fest": "^4.10.2"
+        "type-fest": "^4.12.0"
     },
     "devDependencies": {
         "typescript": "5.3.3"

package/dist/cjs/augments/string/search-params.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.urlToSearchParamsObject = exports.objectToSearchParamsString = void 0;
-const run_time_assertions_1 = require("run-time-assertions");
-const boolean_1 = require("../boolean");
-const common_string_1 = require("../common-string");
-const matches_object_shape_1 = require("../object/matches-object-shape");
-const prefixes_1 = require("./prefixes");
-function objectToSearchParamsString(inputObject) {
-    const valueStrings = Object.entries(inputObject)
-        .map(([key, value,]) => {
-        if (value == undefined) {
-            return undefined;
-        }
-        return `${key}=${String(value)}`;
-    })
-        .filter(boolean_1.isTruthy);
-    if (valueStrings.length) {
-        return `?${valueStrings.join('&')}`;
-    }
-    else {
-        return '';
-    }
-}
-exports.objectToSearchParamsString = objectToSearchParamsString;
-function splitSearchString(searchString) {
-    const params = (0, prefixes_1.removePrefix)({ value: searchString, prefix: '?' }).split('&');
-    const paramEntries = params
-        .map((param) => {
-        const [key, ...everythingElse] = (0, common_string_1.typedSplit)(param, '=');
-        const value = everythingElse.join('');
-        if (!value && !key) {
-            return undefined;
-        }
-        return [
-            key,
-            value,
-        ];
-    })
-        .filter(boolean_1.isTruthy);
-    return paramEntries;
-}
-function urlToSearchParamsObject(inputUrl, verifyShape) {
-    const ensuredUrl = (0, run_time_assertions_1.isRunTimeType)(inputUrl, 'string') ? new URL(inputUrl) : inputUrl;
-    const searchEntries = splitSearchString(ensuredUrl.search);
-    const paramsObject = Object.fromEntries(searchEntries);
-    if (verifyShape) {
-        (0, matches_object_shape_1.assertMatchesObjectShape)(paramsObject, verifyShape);
-    }
-    return paramsObject;
-}
-exports.urlToSearchParamsObject = urlToSearchParamsObject;

package/dist/cjs/augments/string/url.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.joinUrlParts = void 0;
-const protocolSplit = '://';
-/**
- * Joins all given arguments together as if they were parts of a URL. Preserves trailing slashes and
- * removes consecutive slashes in the path.
- *
- * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
- */
-function joinUrlParts(...urlParts) {
-    const rawJoined = urlParts.join('/');
-    const [protocol, rawRest = '',] = rawJoined.includes(protocolSplit)
-        ? rawJoined.split(protocolSplit)
-        : [
-            '',
-            rawJoined,
-        ];
-    let mapSearchParamsStarted = false;
-    let reduceSearchParamsStarted = false;
-    const fixedRest = rawRest
-        .replace(/\/{2,}/g, '/')
-        .split('/')
-        .map((part) => {
-        if (part.includes('?') || mapSearchParamsStarted) {
-            mapSearchParamsStarted = true;
-            return part;
-        }
-        else {
-            return part;
-        }
-    })
-        .reduce((fillingUpArray, currentEntry, currentIndex, inputArray) => {
-        if (reduceSearchParamsStarted) {
-            return fillingUpArray;
-        }
-        const nextEntry = inputArray[currentIndex + 1];
-        let newEntry = currentEntry;
-        const nextHasQuestion = !currentEntry.includes('?') && nextEntry?.startsWith('?');
-        if (nextEntry?.startsWith('?') || nextHasQuestion) {
-            reduceSearchParamsStarted = true;
-            let foundHash = false;
-            const subsequentSearchParams = inputArray
-                .slice(nextHasQuestion ? currentIndex + 2 : currentIndex + 1)
-                .reduce((joinedParams, currentParam) => {
-                if (currentParam.includes('#')) {
-                    foundHash = true;
-                }
-                if (foundHash) {
-                    return joinedParams.concat(currentParam);
-                }
-                else {
-                    return [
-                        joinedParams,
-                        currentParam,
-                    ].join('&');
-                }
-            }, '');
-            newEntry = [
-                currentEntry,
-                nextEntry,
-                subsequentSearchParams,
-            ].join('');
-        }
-        return fillingUpArray.concat(newEntry);
-    }, []);
-    return [
-        protocol,
-        protocol ? protocolSplit : '',
-        fixedRest.join('/'),
-    ].join('');
-}
-exports.joinUrlParts = joinUrlParts;

package/dist/esm/augments/string/search-params.js

@@ -1,47 +0,0 @@
-import { isRunTimeType } from 'run-time-assertions';
-import { isTruthy } from '../boolean';
-import { typedSplit } from '../common-string';
-import { assertMatchesObjectShape } from '../object/matches-object-shape';
-import { removePrefix } from './prefixes';
-export function objectToSearchParamsString(inputObject) {
-    const valueStrings = Object.entries(inputObject)
-        .map(([key, value,]) => {
-        if (value == undefined) {
-            return undefined;
-        }
-        return `${key}=${String(value)}`;
-    })
-        .filter(isTruthy);
-    if (valueStrings.length) {
-        return `?${valueStrings.join('&')}`;
-    }
-    else {
-        return '';
-    }
-}
-function splitSearchString(searchString) {
-    const params = removePrefix({ value: searchString, prefix: '?' }).split('&');
-    const paramEntries = params
-        .map((param) => {
-        const [key, ...everythingElse] = typedSplit(param, '=');
-        const value = everythingElse.join('');
-        if (!value && !key) {
-            return undefined;
-        }
-        return [
-            key,
-            value,
-        ];
-    })
-        .filter(isTruthy);
-    return paramEntries;
-}
-export function urlToSearchParamsObject(inputUrl, verifyShape) {
-    const ensuredUrl = isRunTimeType(inputUrl, 'string') ? new URL(inputUrl) : inputUrl;
-    const searchEntries = splitSearchString(ensuredUrl.search);
-    const paramsObject = Object.fromEntries(searchEntries);
-    if (verifyShape) {
-        assertMatchesObjectShape(paramsObject, verifyShape);
-    }
-    return paramsObject;
-}

package/dist/esm/augments/string/url.js

@@ -1,69 +0,0 @@
-const protocolSplit = '://';
-/**
- * Joins all given arguments together as if they were parts of a URL. Preserves trailing slashes and
- * removes consecutive slashes in the path.
- *
- * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
- */
-export function joinUrlParts(...urlParts) {
-    const rawJoined = urlParts.join('/');
-    const [protocol, rawRest = '',] = rawJoined.includes(protocolSplit)
-        ? rawJoined.split(protocolSplit)
-        : [
-            '',
-            rawJoined,
-        ];
-    let mapSearchParamsStarted = false;
-    let reduceSearchParamsStarted = false;
-    const fixedRest = rawRest
-        .replace(/\/{2,}/g, '/')
-        .split('/')
-        .map((part) => {
-        if (part.includes('?') || mapSearchParamsStarted) {
-            mapSearchParamsStarted = true;
-            return part;
-        }
-        else {
-            return part;
-        }
-    })
-        .reduce((fillingUpArray, currentEntry, currentIndex, inputArray) => {
-        if (reduceSearchParamsStarted) {
-            return fillingUpArray;
-        }
-        const nextEntry = inputArray[currentIndex + 1];
-        let newEntry = currentEntry;
-        const nextHasQuestion = !currentEntry.includes('?') && nextEntry?.startsWith('?');
-        if (nextEntry?.startsWith('?') || nextHasQuestion) {
-            reduceSearchParamsStarted = true;
-            let foundHash = false;
-            const subsequentSearchParams = inputArray
-                .slice(nextHasQuestion ? currentIndex + 2 : currentIndex + 1)
-                .reduce((joinedParams, currentParam) => {
-                if (currentParam.includes('#')) {
-                    foundHash = true;
-                }
-                if (foundHash) {
-                    return joinedParams.concat(currentParam);
-                }
-                else {
-                    return [
-                        joinedParams,
-                        currentParam,
-                    ].join('&');
-                }
-            }, '');
-            newEntry = [
-                currentEntry,
-                nextEntry,
-                subsequentSearchParams,
-            ].join('');
-        }
-        return fillingUpArray.concat(newEntry);
-    }, []);
-    return [
-        protocol,
-        protocol ? protocolSplit : '',
-        fixedRest.join('/'),
-    ].join('');
-}

package/dist/types/augments/string/search-params.d.ts

@@ -1,5 +0,0 @@
-import { Primitive } from 'type-fest';
-export type SearchParamObjectBase = Record<string, Exclude<Primitive, symbol>>;
-export declare function objectToSearchParamsString(inputObject: SearchParamObjectBase): string;
-export declare function urlToSearchParamsObject<VerifyShapeGeneric extends SearchParamObjectBase>(inputUrl: string | Pick<URL, 'search'>, verifyShape: VerifyShapeGeneric): VerifyShapeGeneric;
-export declare function urlToSearchParamsObject<VerifyShapeGeneric extends SearchParamObjectBase>(inputUrl: string | Pick<URL, 'search'>, verifyShape?: VerifyShapeGeneric | undefined): Record<string, string>;

package/dist/types/augments/string/url.d.ts

@@ -1,7 +0,0 @@
-/**
- * Joins all given arguments together as if they were parts of a URL. Preserves trailing slashes and
- * removes consecutive slashes in the path.
- *
- * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
- */
-export declare function joinUrlParts(...urlParts: ReadonlyArray<string>): string;