@augment-vir/common 12.11.2 → 12.12.0

package/dist/cjs/augments/function.d.ts

@@ -1,4 +1,27 @@
+import { ArrayElement } from './type';
 export type AnyFunction<ReturnGeneric = any> = (...args: any[]) => ReturnGeneric;
 export type NoInputsFunction<ReturnGeneric = any> = () => ReturnGeneric;
+/**
+ * Accepts an "Arguments" and "Return" generic to quickly make a function type. If "Arguments" is an
+ * array, it is spread into the full function's Parameters list. If any argument should be an array,
+ * instead of a rest parameter, put it inside of a tuple. If no arguments should be possible, pass
+ * void to "Arguments". If you need an optional argument, pass it inside of a tuple.
+ *
+ * @example
+ *     TypedFunction<string, number>; // (input: string) => number
+ *
+ * @example
+ *     TypedFunction<string[], number>; // (...inputs: string[]) => number
+ *
+ * @example
+ *     TypedFunction<[string[]], number>; // (input: string[]) => number
+ *
+ * @example
+ *     TypedFunction<[string, number], number>; // (input1: string, input2: number) => number
+ *
+ * @example
+ *     TypedFunction<[string | undefined], number>; // (input1: string|undefined) => number
+ */
+export type TypedFunction<Arguments, Return> = Arguments extends readonly any[] ? number extends Arguments['length'] ? (...args: ArrayElement<Arguments>[]) => Return : (...args: Arguments) => Return : void extends Arguments ? () => Return : (arg: Arguments) => Return;
 export declare function isTruthy<T>(input: T): input is NonNullable<T>;
 //# sourceMappingURL=function.d.ts.map

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

@@ -0,0 +1,8 @@
+/**
+ * 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 part of the
+ *
+ * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
+ */
+export declare function joinUrlParts(...urlParts: ReadonlyArray<string>): string;
+//# sourceMappingURL=url.d.ts.map

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

@@ -0,0 +1,29 @@
+"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. This also encodes each part of the
+ *
+ * @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,
+        ];
+    const fixedRest = rawRest
+        .replace(/\/{2,}/g, '/')
+        .split('/')
+        .map((part) => encodeURIComponent(part));
+    return [
+        protocol,
+        protocol ? protocolSplit : '',
+        fixedRest.join('/'),
+    ].join('');
+}
+exports.joinUrlParts = joinUrlParts;

package/dist/cjs/augments/type.d.ts

@@ -58,5 +58,4 @@ export type NoInfer<T> = [T][T extends any ? 0 : never];
  * input.
  */
 export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;
-export type TypedFunction<ParametersGeneric extends any[], ReturnTypeGeneric> = (...args: ParametersGeneric) => ReturnTypeGeneric;
 //# sourceMappingURL=type.d.ts.map

package/dist/cjs/index.d.ts

@@ -22,6 +22,7 @@ export * from './augments/object/typed-has-property';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
+export * from './augments/string/url';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/cjs/index.js

@@ -38,6 +38,7 @@ __exportStar(require("./augments/object/typed-has-property"), exports);
 __exportStar(require("./augments/promise"), exports);
 __exportStar(require("./augments/regexp"), exports);
 __exportStar(require("./augments/runtime-type-of"), exports);
+__exportStar(require("./augments/string/url"), exports);
 __exportStar(require("./augments/truncate-number"), exports);
 __exportStar(require("./augments/tuple"), exports);
 __exportStar(require("./augments/type"), exports);

package/dist/esm/augments/function.d.ts

@@ -1,4 +1,27 @@
+import { ArrayElement } from './type';
 export type AnyFunction<ReturnGeneric = any> = (...args: any[]) => ReturnGeneric;
 export type NoInputsFunction<ReturnGeneric = any> = () => ReturnGeneric;
+/**
+ * Accepts an "Arguments" and "Return" generic to quickly make a function type. If "Arguments" is an
+ * array, it is spread into the full function's Parameters list. If any argument should be an array,
+ * instead of a rest parameter, put it inside of a tuple. If no arguments should be possible, pass
+ * void to "Arguments". If you need an optional argument, pass it inside of a tuple.
+ *
+ * @example
+ *     TypedFunction<string, number>; // (input: string) => number
+ *
+ * @example
+ *     TypedFunction<string[], number>; // (...inputs: string[]) => number
+ *
+ * @example
+ *     TypedFunction<[string[]], number>; // (input: string[]) => number
+ *
+ * @example
+ *     TypedFunction<[string, number], number>; // (input1: string, input2: number) => number
+ *
+ * @example
+ *     TypedFunction<[string | undefined], number>; // (input1: string|undefined) => number
+ */
+export type TypedFunction<Arguments, Return> = Arguments extends readonly any[] ? number extends Arguments['length'] ? (...args: ArrayElement<Arguments>[]) => Return : (...args: Arguments) => Return : void extends Arguments ? () => Return : (arg: Arguments) => Return;
 export declare function isTruthy<T>(input: T): input is NonNullable<T>;
 //# sourceMappingURL=function.d.ts.map

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

@@ -0,0 +1,8 @@
+/**
+ * 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 part of the
+ *
+ * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
+ */
+export declare function joinUrlParts(...urlParts: ReadonlyArray<string>): string;
+//# sourceMappingURL=url.d.ts.map

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

@@ -0,0 +1,25 @@
+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 part of the
+ *
+ * @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,
+        ];
+    const fixedRest = rawRest
+        .replace(/\/{2,}/g, '/')
+        .split('/')
+        .map((part) => encodeURIComponent(part));
+    return [
+        protocol,
+        protocol ? protocolSplit : '',
+        fixedRest.join('/'),
+    ].join('');
+}

package/dist/esm/augments/type.d.ts

@@ -58,5 +58,4 @@ export type NoInfer<T> = [T][T extends any ? 0 : never];
  * input.
  */
 export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;
-export type TypedFunction<ParametersGeneric extends any[], ReturnTypeGeneric> = (...args: ParametersGeneric) => ReturnTypeGeneric;
 //# sourceMappingURL=type.d.ts.map

package/dist/esm/index.d.ts

@@ -22,6 +22,7 @@ export * from './augments/object/typed-has-property';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
+export * from './augments/string/url';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/esm/index.js

@@ -22,6 +22,7 @@ export * from './augments/object/typed-has-property';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
+export * from './augments/string/url';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

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

@@ -1,4 +1,27 @@
+import { ArrayElement } from './type';
 export type AnyFunction<ReturnGeneric = any> = (...args: any[]) => ReturnGeneric;
 export type NoInputsFunction<ReturnGeneric = any> = () => ReturnGeneric;
+/**
+ * Accepts an "Arguments" and "Return" generic to quickly make a function type. If "Arguments" is an
+ * array, it is spread into the full function's Parameters list. If any argument should be an array,
+ * instead of a rest parameter, put it inside of a tuple. If no arguments should be possible, pass
+ * void to "Arguments". If you need an optional argument, pass it inside of a tuple.
+ *
+ * @example
+ *     TypedFunction<string, number>; // (input: string) => number
+ *
+ * @example
+ *     TypedFunction<string[], number>; // (...inputs: string[]) => number
+ *
+ * @example
+ *     TypedFunction<[string[]], number>; // (input: string[]) => number
+ *
+ * @example
+ *     TypedFunction<[string, number], number>; // (input1: string, input2: number) => number
+ *
+ * @example
+ *     TypedFunction<[string | undefined], number>; // (input1: string|undefined) => number
+ */
+export type TypedFunction<Arguments, Return> = Arguments extends readonly any[] ? number extends Arguments['length'] ? (...args: ArrayElement<Arguments>[]) => Return : (...args: Arguments) => Return : void extends Arguments ? () => Return : (arg: Arguments) => Return;
 export declare function isTruthy<T>(input: T): input is NonNullable<T>;
 //# sourceMappingURL=function.d.ts.map

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

@@ -0,0 +1,8 @@
+/**
+ * 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 part of the
+ *
+ * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
+ */
+export declare function joinUrlParts(...urlParts: ReadonlyArray<string>): string;
+//# sourceMappingURL=url.d.ts.map

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

@@ -58,5 +58,4 @@ export type NoInfer<T> = [T][T extends any ? 0 : never];
  * input.
  */
 export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;
-export type TypedFunction<ParametersGeneric extends any[], ReturnTypeGeneric> = (...args: ParametersGeneric) => ReturnTypeGeneric;
 //# sourceMappingURL=type.d.ts.map

package/dist/types/index.d.ts

@@ -22,6 +22,7 @@ export * from './augments/object/typed-has-property';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
+export * from './augments/string/url';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "12.11.2",
+    "version": "12.12.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,7 +24,7 @@
         "test:types": "tsc --noEmit"
     },
     "dependencies": {
-        "type-fest": "^3.6.0"
+        "type-fest": "^3.6.1"
     },
     "devDependencies": {
         "typescript": "^4.9.5"