@oscarpalmer/atoms 0.193.0 → 0.194.0

package/src/internal/value/has.ts

@@ -1,118 +0,0 @@
-import type {NestedKeys, NestedValue, PlainObject, ToString} from '../../models';
-import type {Result} from '../../result/models';
-import {getNestedValue} from './misc';
-
-// #region Functions
-
-/**
- * Check if a property is defined in an object
- *
- * @param data Object to check in
- * @param path Path for property, e.g., `foo.bar.baz`
- * @returns `true` if the property exists, otherwise `false`
- *
- * @example
- * ```typescript
- * const data = {foo: {bar: {baz: 42}}};
- *
- * hasValue(data, 'foo');         // => true
- * hasValue(data, 'foo.bar');     // => true
- * hasValue(data, 'foo.bar.baz'); // => true
- * hasValue(data, 'foo.nope');    // => false
- * ```
- */
-export function hasValue<Data extends PlainObject, Path extends NestedKeys<Data>>(
-	data: Data,
-	path: Path,
-): boolean;
-
-/**
- * Check if a property is defined in an object
- *
- * @param data Object to check in
- * @param path Path for property, e.g., `foo.bar.baz`
- * @param ignoreCase If `true`, the path matching is case-insensitive
- * @returns `true` if the property exists, otherwise `false`
- *
- * @example
- * ```typescript
- * const data = {foo: {bar: {baz: 42}}};
- *
- * hasValue(data, 'foo');               // => true
- * hasValue(data, 'foo.bar');           // => true
- * hasValue(data, 'Foo.Bar.Baz', true); // => true
- * hasValue(data, 'foo.nope');          // => false
- * ```
- */
-export function hasValue<Data extends PlainObject>(
-	data: Data,
-	path: string,
-	ignoreCase?: boolean,
-): boolean;
-
-export function hasValue(data: PlainObject, path: string, ignoreCase?: boolean): boolean {
-	return getNestedValue(data, path, ignoreCase === true).ok;
-}
-
-hasValue.get = hasValueResult;
-
-/**
- * Check if a property is defined in an object, and get its value if it is
- *
- * _Available as `hasValueResult` and `hasValue.get`_
- *
- * @param data Object to check in
- * @param path Path for property, e.g., `foo.bar.baz`
- * @param ignoreCase If `true`, the path matching is case-insensitive
- * @returns Result object
- *
- * @example
- * ```typescript
- * const data = {foo: {bar: {baz: 42}}};
- *
- * hasValueResult(data, 'foo');         // => {ok: true, value: {bar: {baz: 42}}}
- * hasValueResult(data, 'foo.bar');     // => {ok: true, value: {baz: 42}}
- * hasValueResult(data, 'foo.bar.baz'); // => {ok: true, value: 42}
- * hasValueResult(data, 'foo.nope');    // => {ok: false, error: 'Expected property to exist in object'}
- * ```
- */
-export function hasValueResult<Data extends PlainObject, Path extends NestedKeys<Data>>(
-	data: Data,
-	path: Path,
-): Result<NestedValue<Data, ToString<Path>>, string>;
-
-/**
- * Check if a property is defined in an object, and get its value if it is
- *
- * _Available as `hasValueResult` and `hasValue.get`_
- *
- * @param data Object to check in
- * @param path Path for property, e.g., `foo.bar.baz`
- * @param ignoreCase If `true`, the path matching is case-insensitive
- * @returns Result object
- *
- * @example
- * ```typescript
- * const data = {foo: {bar: {baz: 42}}};
- *
- * hasValueResult(data, 'foo');               // => {ok: true, value: {bar: {baz: 42}}}
- * hasValueResult(data, 'foo.bar');           // => {ok: true, value: {baz: 42}}
- * hasValueResult(data, 'Foo.Bar.Baz', true); // => {ok: true, value: 42}
- * hasValueResult(data, 'foo.nope');          // => {ok: false, error: 'Expected property to exist in object'}
- * ```
- */
-export function hasValueResult<Data extends PlainObject>(
-	data: Data,
-	path: string,
-	ignoreCase?: boolean,
-): Result<unknown, string>;
-
-export function hasValueResult(
-	data: PlainObject,
-	path: string,
-	ignoreCase?: boolean,
-): Result<unknown, string> {
-	return getNestedValue(data, path, ignoreCase === true);
-}
-
-// #endregion

package/src/internal/value/misc.ts

@@ -1,125 +0,0 @@
-import type {PlainObject} from '../../models';
-import {error, ok} from '../../result/misc';
-import type {Result} from '../../result/models';
-import {ignoreKey} from '../string';
-
-// #region Functions
-
-export function findKey(needle: string, haystack: object): string {
-	const keys = Object.keys(haystack);
-	const normalized = keys.map(key => key.toLowerCase());
-	const index = normalized.indexOf(needle.toLowerCase());
-
-	return index > -1 ? keys[index] : needle;
-}
-
-export function getNestedValue(
-	data: object,
-	path: string,
-	ignoreCase: boolean,
-): Result<unknown, string> {
-	if (typeof data !== 'object' || data === null) {
-		return error(NESTED_MESSAGE_INPUT);
-	}
-
-	if (typeof path !== 'string' || path.trim().length === 0) {
-		return error(NESTED_MESSAGE_PATH);
-	}
-
-	const shouldIgnoreCase = ignoreCase === true;
-	const paths = getPaths(path, shouldIgnoreCase);
-
-	if (typeof paths === 'string') {
-		return handleValue(data, paths, null, true, shouldIgnoreCase);
-	}
-
-	const {length} = paths;
-
-	let current = data;
-
-	for (let index = 0; index < length; index += 1) {
-		const part = paths[index];
-
-		const handled = handleValue(current, part, null, true, shouldIgnoreCase);
-
-		if (!handled.ok) {
-			return handled;
-		}
-
-		current = handled.value as object;
-	}
-
-	return ok(current);
-}
-
-export function getPaths(path: string, lowercase: boolean): string | string[] {
-	const normalized = lowercase ? path.toLowerCase() : path;
-
-	if (!EXPRESSION_NESTED.test(normalized)) {
-		return normalized;
-	}
-
-	return normalized.replace(EXPRESSION_BRACKET, '.$1').replace(EXPRESSION_DOTS, '').split('.');
-}
-
-export function handleValue(
-	data: object,
-	path: string,
-	value: unknown,
-	get: true,
-	ignoreCase: boolean,
-): Result<unknown, string>;
-
-export function handleValue(
-	data: object,
-	path: string,
-	value: unknown,
-	get: false,
-	ignoreCase: boolean,
-): void;
-
-export function handleValue(
-	data: object,
-	path: string,
-	value: unknown,
-	get: boolean,
-	ignoreCase: boolean,
-): Result<unknown, string> | void {
-	if (typeof data === 'object' && data !== null) {
-		if (ignoreKey(path)) {
-			return error(NESTED_MESSAGE_UNSAFE);
-		}
-
-		const key = ignoreCase ? findKey(path, data) : path;
-
-		if (get) {
-			return key in data ? ok(data[key as never]) : error(NESTED_MESSAGE_MISSING);
-		}
-
-		(data as PlainObject)[key] = typeof value === 'function' ? value(data[key as never]) : value;
-	}
-
-	if (get) {
-		return error(NESTED_MESSAGE_MISSING);
-	}
-}
-
-// #endregion
-
-// #region Variables
-
-const EXPRESSION_BRACKET = /\[(\w+)\]/g;
-
-const EXPRESSION_DOTS = /^\.|\.$/g;
-
-const EXPRESSION_NESTED = /\.|\[\w+\]/;
-
-const NESTED_MESSAGE_INPUT = 'Expected data to be an object';
-
-const NESTED_MESSAGE_MISSING = 'Expected property to exist in object';
-
-const NESTED_MESSAGE_PATH = 'Expected path to be a string';
-
-const NESTED_MESSAGE_UNSAFE = 'Access to this property is not allowed';
-
-// #endregion

package/src/internal/value/partial.ts

@@ -1,46 +0,0 @@
-import type {PlainObject} from '../../models';
-
-export function partial<Value extends object, ValueKey extends keyof Value>(
-	value: unknown,
-	keys: ValueKey[],
-	omit: true,
-): Omit<Value, ValueKey>;
-
-export function partial<Value extends object, ValueKey extends keyof Value>(
-	value: unknown,
-	keys: ValueKey[],
-	omit: false,
-): Pick<Value, ValueKey>;
-
-export function partial<Value extends object, ValueKey extends keyof Value>(
-	value: unknown,
-	providedKeys: ValueKey[],
-	omit: boolean,
-): Partial<Value> {
-	if (typeof value !== 'object' || value === null) {
-		return {} as Partial<Value>;
-	}
-
-	const keys = omit ? Object.keys(value) : Array.isArray(providedKeys) ? providedKeys : [];
-	const {length} = keys;
-
-	if (length === 0) {
-		return omit ? (value as Partial<Value>) : ({} as Partial<Value>);
-	}
-
-	const partials: Partial<Value> = {};
-
-	for (let index = 0; index < length; index += 1) {
-		const key = keys[index];
-
-		if (!(key in value)) {
-			continue;
-		}
-
-		if (omit ? !providedKeys.includes(key as ValueKey) : true) {
-			(partials as PlainObject)[key] = (value as PlainObject)[key];
-		}
-	}
-
-	return partials;
-}

package/src/internal/value/set.ts

@@ -1,132 +0,0 @@
-import type {NestedKeys, NestedValue, PlainObject} from '../../models';
-import type {Ok} from '../../result/models';
-import {getPaths, handleValue} from './misc';
-
-// #region Functions
-
-/**
- * Update the value in an object using a known path
- *
- * @param data Object to set value in
- * @param path Path for value, e.g., `foo.bar.baz`
- * @param updater Function to update the current value
- * @returns Updated object
- *
- * @example
- * ```typescript
- * const data = {foo: {bar: {baz: 42}}};
- *
- * setValue(data, 'foo.bar.baz', (current) => current + 1); // => {foo: {bar: {baz: 43}}}
- * ```
- */
-export function setValue<Data extends PlainObject, Path extends NestedKeys<Data>>(
-	data: Data,
-	path: Path,
-	updater: (current: NestedValue<Data, Path>) => NestedValue<Data, Path>,
-): Data;
-
-/**
- * Set the value in an object using a known path
- *
- * @param data Object to set value in
- * @param path Path for value, e.g., `foo.bar.baz`
- * @param value Value to set
- * @returns Updated object
- *
- * @example
- * ```typescript
- * const data = {foo: {bar: {baz: 42}}};
- *
- * setValue(data, 'foo.bar.baz', 99); // => {foo: {bar: {baz: 99}}}
- * ```
- */
-export function setValue<Data extends PlainObject, Path extends NestedKeys<Data>>(
-	data: Data,
-	path: Path,
-	value: NestedValue<Data, Path>,
-): Data;
-
-/**
- * Set the value in an object using an unknown path
- *
- * @param data Object to set value in
- * @param path Path for value, e.g., `foo.bar.baz`
- * @param value Value to set
- * @param ignoreCase If `true`, the path matching is case-insensitive
- * @returns Updated object
- *
- * @example
- * ```typescript
- * const data = {foo: {bar: {baz: 42}}};
- *
- * setValue(data, 'Foo.Bar.Baz', 99, true); // => {foo: {bar: {baz: 99}}}
- * ```
- */
-export function setValue<Data extends PlainObject>(
-	data: Data,
-	path: string,
-	value: unknown,
-	ignoreCase?: boolean,
-): Data;
-
-export function setValue(data: object, path: string, value: unknown, ignoreCase?: boolean): object {
-	if (
-		typeof data !== 'object' ||
-		data === null ||
-		typeof path !== 'string' ||
-		path.trim().length === 0
-	) {
-		return data;
-	}
-
-	const shouldIgnoreCase = ignoreCase === true;
-	const paths = getPaths(path, shouldIgnoreCase);
-
-	if (typeof paths === 'string') {
-		handleValue(data, paths, value, false, shouldIgnoreCase);
-
-		return data;
-	}
-
-	const {length} = paths;
-	const lastIndex = length - 1;
-
-	let target = data;
-
-	for (let index = 0; index < length; index += 1) {
-		const currentPath = paths[index];
-
-		if (index === lastIndex) {
-			handleValue(target, currentPath, value, false, shouldIgnoreCase);
-
-			break;
-		}
-
-		let next = (handleValue(target, currentPath, null, true, shouldIgnoreCase) as Ok<unknown>)
-			.value;
-
-		if (typeof next !== 'object' || next === null) {
-			const nextPath = paths[index + 1];
-
-			if (EXPRESSION_INDEX.test(nextPath)) {
-				next = Array.from({length: Number(nextPath) + 1}, () => undefined);
-			} else {
-				next = {};
-			}
-
-			(target as PlainObject)[currentPath] = next;
-		}
-
-		target = next as object;
-	}
-
-	return data;
-}
-
-// #endregion
-
-// #region Variables
-
-const EXPRESSION_INDEX = /^\d+$/;
-
-// #endregion

package/src/is.ts

@@ -1,182 +0,0 @@
-import {getArray} from './array/get';
-import {isNumber} from './internal/is';
-import {getString} from './internal/string';
-
-// #region Functions
-
-/**
- * Is the value empty, or only containing `null` or `undefined` values?
- *
- * @param value Value to check
- * @returns `true` if the value is considered empty, otherwise `false`
- */
-export function isEmpty(value: unknown): boolean {
-	if (value == null) {
-		return true;
-	}
-
-	if (typeof value === 'string') {
-		return value.length === 0;
-	}
-
-	const values = getArray(value);
-	const {length} = values;
-
-	for (let index = 0; index < length; index += 1) {
-		const item = values[index];
-
-		if (Array.isArray(item) ? item[1] != null : item != null) {
-			return false;
-		}
-	}
-
-	return true;
-}
-
-/**
- * Is the value not empty, or holding non-empty values?
- *
- * @param value Value to check
- * @returns `true` if the value is not considered empty, otherwise `false`
- */
-export function isNonEmpty(value: unknown): boolean {
-	return !isEmpty(value);
-}
-
-/**
- * Is the value not `undefined` or `null`?
- *
- * @param value Value to check
- * @returns `true` if the value is not `undefined` or `null`, otherwise `false`
- */
-export function isNonNullable<Value>(value: Value): value is Exclude<Value, undefined | null> {
-	return value != null;
-}
-
-/**
- * Is the value not `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
- *
- * @param value Value to check
- * @returns `true` if the value is not `undefined`, `null`, or matches an empty string, otherwise `false`
- */
-export function isNonNullableOrEmpty<Value>(
-	value: Value,
-): value is Exclude<Value, undefined | null | ''> {
-	return value != null && getString(value) !== '';
-}
-
-/**
- * Is the value not `undefined`, `null`, or stringified as a whitespace-only string?
- *
- * @param value Value to check
- * @returns `true` if the value is not `undefined`, `null`, or matches a whitespace-only string, otherwise `false`
- */
-export function isNonNullableOrWhitespace<Value>(
-	value: Value,
-): value is Exclude<Value, undefined | null | ''> {
-	return value != null && !EXPRESSION_WHITESPACE.test(getString(value));
-}
-
-/**
- * Is the value not a number or a number-like string?
- *
- * @param value Value to check
- * @returns `true` if the value is not a number or a number-like string, otherwise `false`
- */
-export function isNonNumerical<Value>(value: Value): value is Exclude<Value, number | `${number}`> {
-	return !isNumerical(value);
-}
-
-/**
- * Is the value not an object _(or function)_?
- *
- * @param value Value to check
- * @returns `true` if the value is not an object, otherwise `false`
- */
-export function isNonObject<Value>(value: Value): value is Exclude<Value, object> {
-	return !isObject(value);
-}
-
-/**
- * Is the value `undefined` or `null`?
- *
- * @param value Value to check
- * @returns `true` if the value is `undefined` or `null`, otherwise `false`
- */
-export function isNullable(value: unknown): value is undefined | null {
-	return value == null;
-}
-
-/**
- * Is the value `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
- *
- * @param value Value to check
- * @returns `true` if the value is nullable or matches an empty string, otherwise `false`
- */
-export function isNullableOrEmpty(value: unknown): value is undefined | null | '' {
-	return value == null || getString(value) === '';
-}
-
-/**
- * Is the value `undefined`, `null`, or stringified as a whitespace-only string?
- *
- * @param value Value to check
- * @returns `true` if the value is nullable or matches a whitespace-only string, otherwise `false`
- */
-export function isNullableOrWhitespace(value: unknown): value is undefined | null | '' {
-	return value == null || EXPRESSION_WHITESPACE.test(getString(value));
-}
-
-/**
- * Is the value a number or a number-like string?
- *
- * @param value Value to check
- * @returns `true` if the value is a number or a number-like string, otherwise `false`
- */
-export function isNumerical(value: unknown): value is number | `${number}` {
-	return (
-		isNumber(value) ||
-		(typeof value === 'string' && value.trim().length > 0 && !Number.isNaN(+value))
-	);
-}
-
-/**
- * Is the value an object _(or function)_?
- *
- * @param value Value to check
- * @returns `true` if the value matches, otherwise `false`
- */
-export function isObject(value: unknown): value is object {
-	return (typeof value === 'object' && value !== null) || typeof value === 'function';
-}
-
-// #endregion
-
-// #region Variables
-
-const EXPRESSION_WHITESPACE = /^\s*$/;
-
-// #endregion
-
-// #region Exports
-
-export {
-	isArrayOrPlainObject,
-	isConstructor,
-	isInstanceOf,
-	isKey,
-	isNonArrayOrPlainObject,
-	isNonConstructor,
-	isNonInstanceOf,
-	isNonKey,
-	isNonNumber,
-	isNonPlainObject,
-	isNonPrimitive,
-	isNonTypedArray,
-	isNumber,
-	isPlainObject,
-	isPrimitive,
-	isTypedArray,
-} from './internal/is';
-
-// #endregion