@bytebury/toolkit 1.0.0

package/script/src/strings.js

@@ -0,0 +1,209 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWhitespace = isWhitespace;
+exports.isNotWhitespace = isNotWhitespace;
+exports.trim = trim;
+exports.title = title;
+exports.lower = lower;
+exports.upper = upper;
+exports.kebab = kebab;
+exports.snake = snake;
+exports.keepAlphabetical = keepAlphabetical;
+exports.keepAlphanumeric = keepAlphanumeric;
+exports.keepNumeric = keepNumeric;
+/**
+ * Determines if the given text is only comprised of whitespace.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `true`.
+ *
+ * @example
+ * ```ts
+ * isWhitespace(null); // true
+ * isWhitespace("   "); // true
+ * isWhitespace("\n\t"); // true
+ * isWhitespace("Hello"); // false
+ * ```
+ */
+function isWhitespace(text) {
+    return trim(text).length === 0;
+}
+/**
+ * Determines if the given text contains any non-whitespace characters.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `false`.
+ *
+ * @example
+ * ```ts
+ * isNotWhitespace(null); // false
+ * isNotWhitespace("   "); // false
+ * isNotWhitespace("Hello"); // true
+ * ```
+ */
+function isNotWhitespace(text) {
+    return !isWhitespace(text);
+}
+/**
+ * Trims the whitespace from the beginning and the end. This is an
+ * alias for `.trim()`. Useful for when you're mapping over lists.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * trim(null); // ""
+ * trim(" HELLO WORLD    \n"); // "HELLO WORLD"
+ * [' hello ', ' world '].map(trim); // ['hello', 'world'];
+ * ```
+ */
+function trim(text) {
+    return (text || "").trim();
+}
+/**
+ * Converts the string to Title Case. This will capitalize
+ * the letter of each word that is separated by a space. Underscores
+ * are considered spaces. Hyphens are respected.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * title(null); // ""
+ * title("hello world"); // Hello World
+ * title("hello-world"); // Hello-world
+ * title("hello_world"); // Hello World
+ * title("HELLO wORLD"); // Hello World
+ * ```
+ */
+function title(text) {
+    return lower(text)
+        .replace(/_/g, " ")
+        .split(" ")
+        .map((word) => upper(word.charAt(0)) + word.slice(1))
+        .join(" ");
+}
+/**
+ * Converts the string to lowercase.
+ * An alias for `toLowerCase()`.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * lower(null); // ""
+ * lower("Hello WORLD"); // "hello world"
+ * ```
+ */
+function lower(text) {
+    return (text || "").toLowerCase();
+}
+/**
+ * Converts the string to uppercase.
+ * An alias for `toUpperCase()`.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * upper(null); // ""
+ * upper("Hello world"); // "HELLO WORLD"
+ * ```
+ */
+function upper(text) {
+    return (text || "").toUpperCase();
+}
+/**
+ * Converts the string to `kebab-case` by removing punctuation,
+ * trimming extra spaces, converting to lowercase, and joining words with hyphens.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * kebab(null); // ""
+ * kebab("Hello World!"); // "hello-world"
+ * kebab("  Clean THIS_up!! "); // "clean-this-up"
+ * ```
+ */
+function kebab(text) {
+    return trim(removePunctuation(lower(text))).replace(/\s+/g, "-");
+}
+/**
+ * Converts a string to `snake_case` by replacing spaces and punctuation with underscores.
+ * Uses `kebab()` internally, replacing hyphens with underscores.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * snake(null); // ""
+ * snake("Hello World"); // "hello_world"
+ * snake("User-Profile Page"); // "user_profile_page"
+ * ```
+ */
+function snake(text) {
+    return kebab(text).replace(/-/g, "_");
+}
+/**
+ * Returns a copy of the given string with all non-alpha characters removed,
+ * except for spaces. Letters are preserved regardless of case.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * keepAlphabetical(null); // ""
+ * keepAlphabetical("Hello, World!"); // "Hello World"
+ * keepAlphabetical("123@#Test"); // "Test"
+ * ```
+ */
+function keepAlphabetical(text) {
+    return (text || "").replace(/[^a-z ]/gi, "");
+}
+/**
+ * Returns a copy of the given string with all non-alphanumeric characters removed,
+ * except for spaces. Letters and digits are preserved regardless of case.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * keepAlphanumeric(null); // ""
+ * keepAlphanumeric("Hello, World!"); // "Hello World"
+ * keepAlphanumeric("123@#Test"); // "123Test"
+ * ```
+ */
+function keepAlphanumeric(text) {
+    return (text || "").replace(/[^a-z0-9 ]/gi, "");
+}
+/**
+ * Removes any non-numeric characters. This includes spaces.
+ *
+ * @remarks
+ * This is `null | undefined` safe. If you pass `null | undefined` then this will return `""`.
+ *
+ * @example
+ * ```ts
+ * keepNumeric(null); // ""
+ * keepNumeric('(555) 555-5555'); // 5555555555
+ * ```
+ */
+function keepNumeric(text) {
+    return (text || "").replace(/[^\d]/g, "");
+}
+function removePunctuation(text) {
+    return text
+        .normalize("NFKD")
+        .replace(/[-_]/g, " ")
+        .replace(/\s+/g, " ")
+        .replace(/[^a-zA-Z0-9\s]/g, "");
+}

package/script/src/strings_test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings_test.d.ts","sourceRoot":"","sources":["../../src/src/strings_test.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC"}

package/script/src/utility_types.d.ts

@@ -0,0 +1,117 @@
+/**
+ * This is a utility type that allows you to Autocomplete a string.
+ *
+ * For example, let's say you have a situation where you would like an input
+ * autocompleted with suggestion, but you also want people to be able to type
+ * whatever they want. This would come in handy.
+ *
+ * @example
+ * ```ts
+ * // You will get autocomplete suggestions for 'free', 'paid', and 'admin'.
+ * // but, you can also type anything you want.
+ * function setUserRole(role: AutoComplete<'free' | 'paid' | 'admin'>): void {
+ *  // omitted
+ * }
+ * ```
+ */
+export type AutoComplete<T extends string> = T | (string & Record<PropertyKey, unknown>);
+/**
+ * This is a utility type that allows you to get the keys from an object or list.
+ *
+ * If `T` is a type of list, then this behaves the same as `ValuesOf`.
+ *
+ * @example
+ * ```ts
+ * const MyEnum = { foo: 'bar', another: 'baz' } as const;
+ * const MyList = ['apple', 'banana', 'orange'] as const;
+ *
+ * function example(param: KeyOf<typeof MyEnum>): void {
+ *   // param would be: "foo" | "another"
+ * }
+ *
+ * function example2(param: KeyOf<typeof MyList): void {
+ *   // param would be: "apple" | "banana" | "orange"
+ * }
+ * ```
+ */
+export type KeyOf<T> = T extends Readonly<unknown[]> ? ValueOf<T> : keyof T;
+/**
+ * This is a utility type that allows you to get the keys from a list.
+ *
+ * @example
+ * ```ts
+ * const MyList = ['apple', 'banana', 'orange'] as const;
+ *
+ * function example2(param: OneOf<typeof MyList>): void {
+ *   // param would be: "apple" | "banana" | "orange"
+ * }
+ * ```
+ */
+export type OneOf<T extends Readonly<unknown[]>> = T[number];
+/**
+ * This is a utility type that allows you to get the values from an object
+ * or a list.
+ *
+ * @example
+ * ```ts
+ * const MyEnum = { foo: 'bar', another: 'baz' } as const;
+ * const MyList = ['apple', 'banana', 'orange'] as const;
+ *
+ * function example(param: ValueOf<typeof MyEnum>): void {
+ *   // param would be: "bar" | "baz"
+ * }
+ *
+ * function example2(param: ValueOf<typeof MyList): void {
+ *   // param would be: "apple" | "banana" | "orange"
+ * }
+ * ```
+ */
+export type ValueOf<T> = T extends Readonly<unknown[]> ? T[number] : T[keyof T];
+/** Represents any primitive ECMAScript value. */
+export type Primitive = string | number | boolean | bigint | symbol | null | undefined;
+/**
+ * Represents when there can be one or many of someting
+ */
+export type OneOrMany<T> = T | T[];
+/**
+ * Represents a non-empty list.
+ */
+export type NonEmptyList<T> = [T, ...T[]];
+/**
+ * Represents a thing that might be `None` (null or undefined).
+ */
+export type Option<T> = T | None;
+/**
+ * A utility type that takes an object type and makes the hover overlay
+ * more readable for the developer.
+ */
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/**
+ * Syntactic sugar for `null | undefined`.
+ */
+export type None = null | undefined;
+/**
+ * Represents a type that is branded with a unique symbol.
+ *
+ * Useful for creating types that are unique to your application.
+ *
+ * @remarks
+ * We use Branded types in our `Duration` class to remove the guess-work
+ * and make the code more readable in regards to time units.
+ *
+ * @example
+ * ```ts
+ * type Seconds = Brand<number, 'Seconds'>;
+ * type Milliseconds = Brand<number, 'Milliseconds'>;
+ *
+ * function secondsToMilliseconds(seconds: Seconds): Milliseconds {
+ *   return seconds * 1000;
+ * }
+ * ```
+ */
+export type Brand<T, B> = T & {
+    __brand: B;
+};
+//# sourceMappingURL=utility_types.d.ts.map

package/script/src/utility_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility_types.d.ts","sourceRoot":"","sources":["../../src/src/utility_types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IACrC,CAAC,GACD,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AAE5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AAE5E;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhF,iDAAiD;AACjD,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,IAAI,GACJ,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEjC;;;GAGG;AAEH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;AAEpC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/script/src/utility_types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });