@oscarpalmer/atoms 0.75.0 → 0.76.0

package/types/value/clone.d.cts

@@ -1,6 +1,8 @@
 // Generated by dts-bundle-generator v9.5.1
 
-export declare function clone(fn: (...args: unknown[]) => unknown): null;
-export declare function clone<Value>(value: Value): Value;
+/**
+ * Clone any kind of value _(deeply, if needed)_
+ */
+export declare function clone(value: unknown): {} | null | undefined;
 
 export {};

package/types/value/clone.d.ts

@@ -1,2 +1,4 @@
-export declare function clone(fn: (...args: unknown[]) => unknown): null;
-export declare function clone<Value>(value: Value): Value;
+/**
+ * Clone any kind of value _(deeply, if needed)_
+ */
+export declare function clone(value: unknown): {} | null | undefined;

package/types/value/get.d.ts

@@ -1,5 +1,5 @@
-import type { Get, Paths, PlainObject } from '@/models';
 import type { ToString } from 'type-fest/source/internal/string';
+import type { Get, Paths, PlainObject } from '~/models';
 /**
  * - Get the value from an object using a known path
  * - You can retrieve a nested value by using dot notation, e.g., `foo.bar.baz`

package/types/value/index.d.cts

@@ -1396,8 +1396,10 @@ export type Get<
 > = GetWithPath<BaseType, Path extends string ? ToPath<Path> : Path, Options>;
 export type ArrayOrPlainObject = UnknownArray | UnknownRecord;
 export type PlainObject = UnknownRecord;
-export declare function clone(fn: (...args: unknown[]) => unknown): null;
-export declare function clone<Value>(value: Value): Value;
+/**
+ * Clone any kind of value _(deeply, if needed)_
+ */
+export declare function clone(value: unknown): {} | null | undefined;
 /**
  * Compare two values _(for sorting purposes)_
  */
@@ -1466,7 +1468,7 @@ export type MergeOptions = {
 	skipNullable?: boolean;
 };
 /**
- * Merges multiple arrays or objects into a single one
+ * Merge multiple arrays or objects into a single one
  */
 export declare function merge<Model extends ArrayOrPlainObject>(
 	values: Model[],
@@ -1499,7 +1501,7 @@ export type Smushed<Value> = Simplify<{
 	[Key in Paths<Value>]: Get<Value, ToString<Key>>;
 }>;
 /**
- * Smushes an object into a flat object with dot notation keys
+ * Smush an object into a flat object that uses dot notation keys
  */
 export declare function smush<Value extends PlainObject>(
 	value: Value,
@@ -1513,13 +1515,13 @@ export type Unsmushed<Value extends PlainObject> = Simplify<
 	>
 >;
 /**
- * Unsmushes a smushed object _(turning dot notation keys into nested keys)_
+ * Unsmush a smushed object _(turning dot notation keys into nested keys)_
  */
 export declare function unsmush<Value extends PlainObject>(
 	value: Value,
 ): Unsmushed<Value>;
 /**
- * Creates a new object with only the specified keys
+ * Create a new object with only the specified keys
  */
 export declare function partial<
 	Value extends PlainObject,

package/types/value/index.d.ts

@@ -1,6 +1,6 @@
-import type { PlainObject } from '@/models';
+import type { PlainObject } from '~/models';
 /**
- * Creates a new object with only the specified keys
+ * Create a new object with only the specified keys
  */
 export declare function partial<Value extends PlainObject, Key extends keyof Value>(value: Value, keys: Key[]): Pick<Value, Key>;
 export * from './clone';

package/types/value/merge.d.cts

@@ -65,7 +65,7 @@ export type MergeOptions = {
 	skipNullable?: boolean;
 };
 /**
- * Merges multiple arrays or objects into a single one
+ * Merge multiple arrays or objects into a single one
  */
 export declare function merge<Model extends ArrayOrPlainObject>(values: Model[], options?: Partial<MergeOptions>): Model;
 

package/types/value/merge.d.ts

@@ -1,4 +1,4 @@
-import type { ArrayOrPlainObject } from '@/models';
+import type { ArrayOrPlainObject } from '~/models';
 type MergeOptions = {
     /**
      * - Skip nullable values when merging arrays?
@@ -7,7 +7,7 @@ type MergeOptions = {
     skipNullable?: boolean;
 };
 /**
- * Merges multiple arrays or objects into a single one
+ * Merge multiple arrays or objects into a single one
  */
 export declare function merge<Model extends ArrayOrPlainObject>(values: Model[], options?: Partial<MergeOptions>): Model;
 export {};

package/types/value/set.d.ts

@@ -1,4 +1,4 @@
-import type { Paths, PlainObject } from '@/models';
+import type { Paths, PlainObject } from '~/models';
 /**
  * - Set the value in an object using a known path
  * - You can set a nested value by using dot notation, e.g., `foo.bar.baz`

package/types/value/smush.d.cts

@@ -1359,7 +1359,7 @@ export type Smushed<Value> = Simplify<{
 	[Key in Paths<Value>]: Get<Value, ToString<Key>>;
 }>;
 /**
- * Smushes an object into a flat object with dot notation keys
+ * Smush an object into a flat object that uses dot notation keys
  */
 export declare function smush<Value extends PlainObject>(
 	value: Value,

package/types/value/smush.d.ts

@@ -1,11 +1,11 @@
-import type { PlainObject } from '@/models';
 import type { Get, Paths, Simplify } from 'type-fest';
 import type { ToString } from 'type-fest/source/internal/string';
+import type { PlainObject } from '~/models';
 type Smushed<Value> = Simplify<{
     [Key in Paths<Value>]: Get<Value, ToString<Key>>;
 }>;
 /**
- * Smushes an object into a flat object with dot notation keys
+ * Smush an object into a flat object that uses dot notation keys
  */
 export declare function smush<Value extends PlainObject>(value: Value): Smushed<Value>;
 export {};

package/types/value/unsmush.d.cts

@@ -134,7 +134,7 @@ export type Unsmushed<Value extends PlainObject> = Simplify<Omit<{
 	[Key in KeysOfUnion<Value>]: Value[Key];
 }, `${string}.${string}`>>;
 /**
- * Unsmushes a smushed object _(turning dot notation keys into nested keys)_
+ * Unsmush a smushed object _(turning dot notation keys into nested keys)_
  */
 export declare function unsmush<Value extends PlainObject>(value: Value): Unsmushed<Value>;
 

package/types/value/unsmush.d.ts

@@ -1,10 +1,10 @@
-import type { PlainObject } from '@/models';
 import type { KeysOfUnion, Simplify } from 'type-fest';
+import type { PlainObject } from '~/models';
 type Unsmushed<Value extends PlainObject> = Simplify<Omit<{
     [Key in KeysOfUnion<Value>]: Value[Key];
 }, `${string}.${string}`>>;
 /**
- * Unsmushes a smushed object _(turning dot notation keys into nested keys)_
+ * Unsmush a smushed object _(turning dot notation keys into nested keys)_
  */
 export declare function unsmush<Value extends PlainObject>(value: Value): Unsmushed<Value>;
 export {};

package/dist/js/internal/array-callbacks.cjs

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-function getCallbacks(bool, key) {
-  if (typeof bool === "function") {
-    return { bool };
-  }
-  if (typeof key === "function") {
-    return { key };
-  }
-  const isString = typeof key === "string";
-  if (!isString && typeof key !== "number" || isString && key.includes(".")) {
-    return;
-  }
-  return {
-    key: (value) => value == null ? void 0 : value[key]
-  };
-}
-exports.getCallbacks = getCallbacks;

package/dist/js/internal/array-callbacks.js

@@ -1,18 +0,0 @@
-function getCallbacks(bool, key) {
-  if (typeof bool === "function") {
-    return { bool };
-  }
-  if (typeof key === "function") {
-    return { key };
-  }
-  const isString = typeof key === "string";
-  if (!isString && typeof key !== "number" || isString && key.includes(".")) {
-    return;
-  }
-  return {
-    key: (value) => value == null ? void 0 : value[key]
-  };
-}
-export {
-  getCallbacks
-};

package/src/js/internal/array-callbacks.ts

@@ -1,28 +0,0 @@
-import type {BooleanCallback, Callbacks, KeyCallback} from '@/array/models';
-import type {Key, PlainObject} from '@/models';
-
-export function getCallbacks<Value>(
-	bool: unknown,
-	key: unknown,
-): Callbacks<Value> | undefined {
-	if (typeof bool === 'function') {
-		return {bool: bool as BooleanCallback<Value>};
-	}
-
-	if (typeof key === 'function') {
-		return {key: key as KeyCallback<Value>};
-	}
-
-	const isString = typeof key === 'string';
-
-	if (
-		(!isString && typeof key !== 'number') ||
-		(isString && key.includes('.'))
-	) {
-		return;
-	}
-
-	return {
-		key: (value: Value) => (value as PlainObject)?.[key as string] as Key,
-	};
-}

package/types/internal/array-callbacks.d.cts

@@ -1,13 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-export type Key = number | string;
-export type ArrayCallback<Value, Returned> = (value: Value, index: number, array: Value[]) => Returned;
-export type BooleanCallback<Value> = ArrayCallback<Value, boolean>;
-export type Callbacks<Value> = {
-	bool?: BooleanCallback<Value>;
-	key?: KeyCallback<Value>;
-};
-export type KeyCallback<Value> = ArrayCallback<Value, Key>;
-export declare function getCallbacks<Value>(bool: unknown, key: unknown): Callbacks<Value> | undefined;
-
-export {};

package/types/internal/array-callbacks.d.ts

@@ -1,2 +0,0 @@
-import type { Callbacks } from '@/array/models';
-export declare function getCallbacks<Value>(bool: unknown, key: unknown): Callbacks<Value> | undefined;

package/types/internal/array-find.d.cts

@@ -1,11 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-export type Key = number | string;
-export type ArrayCallback<Value, Returned> = (value: Value, index: number, array: Value[]) => Returned;
-export type BooleanCallback<Value> = ArrayCallback<Value, boolean>;
-export type FindType = "index" | "value";
-export type KeyCallback<Value> = ArrayCallback<Value, Key>;
-export declare function findValue<Model, Value = Model>(type: FindType, array: Model[], value: Value | BooleanCallback<Model>, key?: Key | KeyCallback<Model>): unknown;
-export declare function findValues<Model, Value = Model>(type: "all" | "unique", array: Model[], value: Value | BooleanCallback<Model>, key?: Key | KeyCallback<Model>): Model[];
-
-export {};

package/types/internal/array-find.d.ts

@@ -1,4 +0,0 @@
-import type { BooleanCallback, FindType, KeyCallback } from '@/array/models';
-import type { Key } from '@/models';
-export declare function findValue<Model, Value = Model>(type: FindType, array: Model[], value: Value | BooleanCallback<Model>, key?: Key | KeyCallback<Model>): unknown;
-export declare function findValues<Model, Value = Model>(type: 'all' | 'unique', array: Model[], value: Value | BooleanCallback<Model>, key?: Key | KeyCallback<Model>): Model[];