@augment-vir/common 19.0.0 → 19.0.2

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

@@ -4,7 +4,7 @@ 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. This also encodes each URL part.
+ * removes consecutive slashes in the path.
  *
  * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
  */
@@ -27,7 +27,7 @@ function joinUrlParts(...urlParts) {
             return part;
         }
         else {
-            return encodeURIComponent(part);
+            return part;
         }
     })
         .reduce((fillingUpArray, currentEntry, currentIndex, inputArray) => {

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

@@ -1,7 +1,7 @@
 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. This also encodes each URL part.
+ * removes consecutive slashes in the path.
  *
  * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
  */
@@ -24,7 +24,7 @@ export function joinUrlParts(...urlParts) {
             return part;
         }
         else {
-            return encodeURIComponent(part);
+            return part;
         }
     })
         .reduce((fillingUpArray, currentEntry, currentIndex, inputArray) => {

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

@@ -1,6 +1,6 @@
 /**
  * Joins all given arguments together as if they were parts of a URL. Preserves trailing slashes and
- * removes consecutive slashes in the path. This also encodes each URL part.
+ * removes consecutive slashes in the path.
  *
  * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "19.0.0",
+    "version": "19.0.2",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -18,13 +18,13 @@
     "module": "dist/esm/index.js",
     "types": "dist/types/index.d.ts",
     "scripts": {
-        "compile": "tsc --project tsconfig.json && tsc --project tsconfig.cjs.json",
+        "compile": "rm -rf dist && tsc --project tsconfig.json && tsc --project tsconfig.cjs.json",
         "test": "echo \"use common-test to run tests\" && exit 0",
         "test:coverage": "npm test",
         "test:types": "tsc --noEmit"
     },
     "dependencies": {
-        "type-fest": "^4.3.1"
+        "type-fest": "^4.3.2"
     },
     "devDependencies": {
         "typescript": "^5.2.2"

package/dist/cjs/augments/date/date.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDateFromUtcIsoFormat = exports.createDateFromNamedCommaFormat = exports.createDateFromSlashFormat = exports.InvalidDateError = exports.englishShortMonthNames = exports.englishFullMonthNames = void 0;
-exports.englishFullMonthNames = [
-    'january',
-    'february',
-    'march',
-    'april',
-    'may',
-    'june',
-    'july',
-    'august',
-    'september',
-    'october',
-    'november',
-    'december',
-];
-exports.englishShortMonthNames = exports.englishFullMonthNames.map((longMonthName) => longMonthName.slice(0, 3));
-class InvalidDateError extends Error {
-    constructor() {
-        super(...arguments);
-        this.name = 'InvalidDateError';
-    }
-}
-exports.InvalidDateError = InvalidDateError;
-/**
- * @param slashFormatString String that should be of format "MM/DD/YY", "MM/DD/YYYY". When the year
- *   portion only contains 2 numbers ("MM/DD/YY") the century must be provided in the form of the
- *   yearPrefix input.
- * @param yearPrefix String or number that is used to prefix slash format strings that only contain
- *   2 digits ("MM/DD/YY"). If the year is entirely missing form the given slash format string, the
- *   year will default to year 00 of the given century. See test file for examples.
- */
-function createDateFromSlashFormat(slashFormatString, yearPrefix = '') {
-    const [month, day, rawYearEnding = '',] = slashFormatString.split('/');
-    if (!month || !day) {
-        throw new Error(`Unable to extract month or day from "${slashFormatString}"`);
-    }
-    const yearEnding = rawYearEnding.length < 4 ? `${yearPrefix}${rawYearEnding.padStart(2, '0')}` : rawYearEnding;
-    const returnDate = createDateFromUtcIsoFormat(`${yearEnding.padStart(4, '0')}-${month.padStart(2, '0')}-${day.padStart(2, '0')}`);
-    return returnDate;
-}
-exports.createDateFromSlashFormat = createDateFromSlashFormat;
-/**
- * @param commaFormatString Should be at string of the form "monthName dayNumber, fullYear" Example:
- *   "May 19, 2005"
- * @param ignoreInvalidMonth Set to true to ignore invalid months and just use the current UTC month
- */
-function createDateFromNamedCommaFormat(commaFormatString, ignoreInvalidMonth = false) {
-    const [monthName, dayNumber, fullYear,] = commaFormatString.replace(',', '').split(' ');
-    if (!monthName || !dayNumber || !fullYear) {
-        throw new InvalidDateError(`Invalid ${createDateFromNamedCommaFormat.name} input: ${commaFormatString}`);
-    }
-    const longMonthIndex = exports.englishFullMonthNames.indexOf(monthName.toLowerCase());
-    const shortMonthIndex = exports.englishShortMonthNames.indexOf(monthName.toLowerCase());
-    let monthIndex = longMonthIndex === -1 ? shortMonthIndex : longMonthIndex;
-    if (monthIndex === -1) {
-        if (ignoreInvalidMonth) {
-            monthIndex = new Date().getUTCMonth();
-        }
-        else {
-            throw new InvalidDateError(`Month name ${monthName} was not found.`);
-        }
-    }
-    const returnDate = createDateFromUtcIsoFormat(`${fullYear.padStart(4, '0')}-${String(monthIndex + 1).padStart(2, '0')}-${dayNumber.padStart(2, '0')}`);
-    return returnDate;
-}
-exports.createDateFromNamedCommaFormat = createDateFromNamedCommaFormat;
-/**
- * Converts an iso-formatted string to a UTC date object. The time is nulled out to all zeros.
- *
- * @param isoFormatString Should be a date in the format YYYY-MM-DD.
- */
-function createDateFromUtcIsoFormat(isoFormatString) {
-    const utcDate = new Date(isoFormatString + 'T00:00:00.000Z');
-    if (isNaN(Number(utcDate))) {
-        throw new InvalidDateError(`Invalid utc date formed from input "${isoFormatString}"`);
-    }
-    return utcDate;
-}
-exports.createDateFromUtcIsoFormat = createDateFromUtcIsoFormat;

package/dist/cjs/augments/date/relative-date.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateRelativeDate = void 0;
-const __1 = require("../..");
-/**
- * For the properties that don't have setters and getters named directly after them. For example, to
- * modify "milliseconds", we can just use that string directly: getUTCMilliseconds. However, for
- * "Months", we have to use getUTCMonth.
- */
-const differentlyNamedDateSettersAndGetterKeys = {
-    days: {
-        getKey: 'getUTCDate',
-        setKey: 'setUTCDate',
-    },
-    months: {
-        getKey: 'getUTCMonth',
-        setKey: 'setUTCMonth',
-    },
-    years: {
-        getKey: 'getUTCFullYear',
-        setKey: 'setUTCFullYear',
-    },
-};
-function calculateRelativeDate(startingDate, calculations) {
-    if (!(startingDate instanceof Date)) {
-        startingDate = new Date(startingDate);
-    }
-    let returnDate = new Date(startingDate);
-    (0, __1.getObjectTypedKeys)(calculations).forEach((calculationKey) => {
-        const calculationValue = calculations[calculationKey];
-        if (!calculationValue) {
-            return;
-        }
-        const { getKey, setKey } = (0, __1.hasKey)(differentlyNamedDateSettersAndGetterKeys, calculationKey)
-            ? differentlyNamedDateSettersAndGetterKeys[calculationKey]
-            : {
-                getKey: `getUTC${(0, __1.capitalizeFirstLetter)(calculationKey)}`,
-                setKey: `setUTC${(0, __1.capitalizeFirstLetter)(calculationKey)}`,
-            };
-        const currentValue = returnDate[getKey]();
-        returnDate[setKey](currentValue + calculationValue);
-    });
-    return returnDate;
-}
-exports.calculateRelativeDate = calculateRelativeDate;

package/dist/cjs/augments/pixel.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removePx = exports.addPx = void 0;
-function addPx(input) {
-    if (String(input).endsWith('px')) {
-        return String(input);
-    }
-    else {
-        return `${input}px`;
-    }
-}
-exports.addPx = addPx;
-function removePx(input) {
-    return Number(input.replace(/px$/, ''));
-}
-exports.removePx = removePx;

package/dist/esm/augments/date/date.js

@@ -1,74 +0,0 @@
-export const englishFullMonthNames = [
-    'january',
-    'february',
-    'march',
-    'april',
-    'may',
-    'june',
-    'july',
-    'august',
-    'september',
-    'october',
-    'november',
-    'december',
-];
-export const englishShortMonthNames = englishFullMonthNames.map((longMonthName) => longMonthName.slice(0, 3));
-export class InvalidDateError extends Error {
-    constructor() {
-        super(...arguments);
-        this.name = 'InvalidDateError';
-    }
-}
-/**
- * @param slashFormatString String that should be of format "MM/DD/YY", "MM/DD/YYYY". When the year
- *   portion only contains 2 numbers ("MM/DD/YY") the century must be provided in the form of the
- *   yearPrefix input.
- * @param yearPrefix String or number that is used to prefix slash format strings that only contain
- *   2 digits ("MM/DD/YY"). If the year is entirely missing form the given slash format string, the
- *   year will default to year 00 of the given century. See test file for examples.
- */
-export function createDateFromSlashFormat(slashFormatString, yearPrefix = '') {
-    const [month, day, rawYearEnding = '',] = slashFormatString.split('/');
-    if (!month || !day) {
-        throw new Error(`Unable to extract month or day from "${slashFormatString}"`);
-    }
-    const yearEnding = rawYearEnding.length < 4 ? `${yearPrefix}${rawYearEnding.padStart(2, '0')}` : rawYearEnding;
-    const returnDate = createDateFromUtcIsoFormat(`${yearEnding.padStart(4, '0')}-${month.padStart(2, '0')}-${day.padStart(2, '0')}`);
-    return returnDate;
-}
-/**
- * @param commaFormatString Should be at string of the form "monthName dayNumber, fullYear" Example:
- *   "May 19, 2005"
- * @param ignoreInvalidMonth Set to true to ignore invalid months and just use the current UTC month
- */
-export function createDateFromNamedCommaFormat(commaFormatString, ignoreInvalidMonth = false) {
-    const [monthName, dayNumber, fullYear,] = commaFormatString.replace(',', '').split(' ');
-    if (!monthName || !dayNumber || !fullYear) {
-        throw new InvalidDateError(`Invalid ${createDateFromNamedCommaFormat.name} input: ${commaFormatString}`);
-    }
-    const longMonthIndex = englishFullMonthNames.indexOf(monthName.toLowerCase());
-    const shortMonthIndex = englishShortMonthNames.indexOf(monthName.toLowerCase());
-    let monthIndex = longMonthIndex === -1 ? shortMonthIndex : longMonthIndex;
-    if (monthIndex === -1) {
-        if (ignoreInvalidMonth) {
-            monthIndex = new Date().getUTCMonth();
-        }
-        else {
-            throw new InvalidDateError(`Month name ${monthName} was not found.`);
-        }
-    }
-    const returnDate = createDateFromUtcIsoFormat(`${fullYear.padStart(4, '0')}-${String(monthIndex + 1).padStart(2, '0')}-${dayNumber.padStart(2, '0')}`);
-    return returnDate;
-}
-/**
- * Converts an iso-formatted string to a UTC date object. The time is nulled out to all zeros.
- *
- * @param isoFormatString Should be a date in the format YYYY-MM-DD.
- */
-export function createDateFromUtcIsoFormat(isoFormatString) {
-    const utcDate = new Date(isoFormatString + 'T00:00:00.000Z');
-    if (isNaN(Number(utcDate))) {
-        throw new InvalidDateError(`Invalid utc date formed from input "${isoFormatString}"`);
-    }
-    return utcDate;
-}

package/dist/esm/augments/date/relative-date.js

@@ -1,41 +0,0 @@
-import { capitalizeFirstLetter, getObjectTypedKeys, hasKey } from '../..';
-/**
- * For the properties that don't have setters and getters named directly after them. For example, to
- * modify "milliseconds", we can just use that string directly: getUTCMilliseconds. However, for
- * "Months", we have to use getUTCMonth.
- */
-const differentlyNamedDateSettersAndGetterKeys = {
-    days: {
-        getKey: 'getUTCDate',
-        setKey: 'setUTCDate',
-    },
-    months: {
-        getKey: 'getUTCMonth',
-        setKey: 'setUTCMonth',
-    },
-    years: {
-        getKey: 'getUTCFullYear',
-        setKey: 'setUTCFullYear',
-    },
-};
-export function calculateRelativeDate(startingDate, calculations) {
-    if (!(startingDate instanceof Date)) {
-        startingDate = new Date(startingDate);
-    }
-    let returnDate = new Date(startingDate);
-    getObjectTypedKeys(calculations).forEach((calculationKey) => {
-        const calculationValue = calculations[calculationKey];
-        if (!calculationValue) {
-            return;
-        }
-        const { getKey, setKey } = hasKey(differentlyNamedDateSettersAndGetterKeys, calculationKey)
-            ? differentlyNamedDateSettersAndGetterKeys[calculationKey]
-            : {
-                getKey: `getUTC${capitalizeFirstLetter(calculationKey)}`,
-                setKey: `setUTC${capitalizeFirstLetter(calculationKey)}`,
-            };
-        const currentValue = returnDate[getKey]();
-        returnDate[setKey](currentValue + calculationValue);
-    });
-    return returnDate;
-}

package/dist/esm/augments/pixel.js

@@ -1,11 +0,0 @@
-export function addPx(input) {
-    if (String(input).endsWith('px')) {
-        return String(input);
-    }
-    else {
-        return `${input}px`;
-    }
-}
-export function removePx(input) {
-    return Number(input.replace(/px$/, ''));
-}

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

@@ -1,26 +0,0 @@
-export declare const englishFullMonthNames: readonly ["january", "february", "march", "april", "may", "june", "july", "august", "september", "october", "november", "december"];
-export declare const englishShortMonthNames: string[];
-export declare class InvalidDateError extends Error {
-    readonly name = "InvalidDateError";
-}
-/**
- * @param slashFormatString String that should be of format "MM/DD/YY", "MM/DD/YYYY". When the year
- *   portion only contains 2 numbers ("MM/DD/YY") the century must be provided in the form of the
- *   yearPrefix input.
- * @param yearPrefix String or number that is used to prefix slash format strings that only contain
- *   2 digits ("MM/DD/YY"). If the year is entirely missing form the given slash format string, the
- *   year will default to year 00 of the given century. See test file for examples.
- */
-export declare function createDateFromSlashFormat(slashFormatString: string, yearPrefix?: number | string): Date;
-/**
- * @param commaFormatString Should be at string of the form "monthName dayNumber, fullYear" Example:
- *   "May 19, 2005"
- * @param ignoreInvalidMonth Set to true to ignore invalid months and just use the current UTC month
- */
-export declare function createDateFromNamedCommaFormat(commaFormatString: string, ignoreInvalidMonth?: boolean): Date;
-/**
- * Converts an iso-formatted string to a UTC date object. The time is nulled out to all zeros.
- *
- * @param isoFormatString Should be a date in the format YYYY-MM-DD.
- */
-export declare function createDateFromUtcIsoFormat(isoFormatString: string): Date;

package/dist/types/augments/date/relative-date.d.ts

@@ -1,11 +0,0 @@
-import { PartialAndUndefined } from '../..';
-export type RelativeDateCalculation = PartialAndUndefined<{
-    milliseconds: number;
-    seconds: number;
-    minutes: number;
-    hours: number;
-    days: number;
-    months: number;
-    years: number;
-}>;
-export declare function calculateRelativeDate(startingDate: Date | number | string, calculations: RelativeDateCalculation): Date;

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

@@ -1,3 +0,0 @@
-export type WithPx = `${string | number}px`;
-export declare function addPx(input: number | string): WithPx;
-export declare function removePx(input: WithPx | string): number;