@oscarpalmer/atoms 0.74.1 → 0.76.0

package/types/value/smush.d.ts

@@ -1,11 +1,11 @@
 import type { Get, Paths, Simplify } from 'type-fest';
 import type { ToString } from 'type-fest/source/internal/string';
-import type { PlainObject } from '../models';
+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

@@ -0,0 +1,141 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+Create a union of all keys from a given type, even those exclusive to specific union members.
+
+Unlike the native `keyof` keyword, which returns keys present in **all** union members, this type returns keys from **any** member.
+
+@link https://stackoverflow.com/a/49402091
+
+@example
+```
+import type {KeysOfUnion} from 'type-fest';
+
+type A = {
+	common: string;
+	a: number;
+};
+
+type B = {
+	common: string;
+	b: string;
+};
+
+type C = {
+	common: string;
+	c: boolean;
+};
+
+type Union = A | B | C;
+
+type CommonKeys = keyof Union;
+//=> 'common'
+
+type AllKeys = KeysOfUnion<Union>;
+//=> 'common' | 'a' | 'b' | 'c'
+```
+
+@category Object
+*/
+export type KeysOfUnion<ObjectType> = ObjectType extends unknown ? keyof ObjectType : never;
+/**
+Represents an object with `unknown` value. You probably want this instead of `{}`.
+
+Use case: You have an object whose keys and values are unknown to you.
+
+@example
+```
+import type {UnknownRecord} from 'type-fest';
+
+function toJson(object: UnknownRecord) {
+	return JSON.stringify(object);
+}
+
+toJson({hello: 'world'});
+//=> '{"hello":"world"}'
+
+function isObject(value: unknown): value is UnknownRecord {
+	return typeof value === 'object' && value !== null;
+}
+
+isObject({hello: 'world'});
+//=> true
+
+isObject('hello');
+//=> false
+```
+
+@category Type
+@category Object
+*/
+export type UnknownRecord = Record<PropertyKey, unknown>;
+/**
+Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
+
+@example
+```
+import type {Simplify} from 'type-fest';
+
+type PositionProps = {
+	top: number;
+	left: number;
+};
+
+type SizeProps = {
+	width: number;
+	height: number;
+};
+
+// In your editor, hovering over `Props` will show a flattened object with all the properties.
+type Props = Simplify<PositionProps & SizeProps>;
+```
+
+Sometimes it is desired to pass a value as a function argument that has a different type. At first inspection it may seem assignable, and then you discover it is not because the `value`'s type definition was defined as an interface. In the following example, `fn` requires an argument of type `Record<string, unknown>`. If the value is defined as a literal, then it is assignable. And if the `value` is defined as type using the `Simplify` utility the value is assignable.  But if the `value` is defined as an interface, it is not assignable because the interface is not sealed and elsewhere a non-string property could be added to the interface.
+
+If the type definition must be an interface (perhaps it was defined in a third-party npm package), then the `value` can be defined as `const value: Simplify<SomeInterface> = ...`. Then `value` will be assignable to the `fn` argument.  Or the `value` can be cast as `Simplify<SomeInterface>` if you can't re-declare the `value`.
+
+@example
+```
+import type {Simplify} from 'type-fest';
+
+interface SomeInterface {
+	foo: number;
+	bar?: string;
+	baz: number | undefined;
+}
+
+type SomeType = {
+	foo: number;
+	bar?: string;
+	baz: number | undefined;
+};
+
+const literal = {foo: 123, bar: 'hello', baz: 456};
+const someType: SomeType = literal;
+const someInterface: SomeInterface = literal;
+
+function fn(object: Record<string, unknown>): void {}
+
+fn(literal); // Good: literal object type is sealed
+fn(someType); // Good: type is sealed
+fn(someInterface); // Error: Index signature for type 'string' is missing in type 'someInterface'. Because `interface` can be re-opened
+fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface` into a `type`
+```
+
+@link https://github.com/microsoft/TypeScript/issues/15300
+@see SimplifyDeep
+@category Object
+*/
+export type Simplify<T> = {
+	[KeyType in keyof T]: T[KeyType];
+} & {};
+export type PlainObject = UnknownRecord;
+export type Unsmushed<Value extends PlainObject> = Simplify<Omit<{
+	[Key in KeysOfUnion<Value>]: Value[Key];
+}, `${string}.${string}`>>;
+/**
+ * Unsmush a smushed object _(turning dot notation keys into nested keys)_
+ */
+export declare function unsmush<Value extends PlainObject>(value: Value): Unsmushed<Value>;
+
+export {};

package/types/value/unsmush.d.ts

@@ -1,10 +1,10 @@
 import type { KeysOfUnion, Simplify } from 'type-fest';
-import type { PlainObject } from '../models';
+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/array/count.mjs

@@ -1,8 +0,0 @@
-// src/js/array/count.ts
-import { findValues } from "../internal/array-find";
-function count(array, value, key) {
-  return findValues("all", array, value, key).length;
-}
-export {
-  count
-};

package/dist/js/array/exists.mjs

@@ -1,8 +0,0 @@
-// src/js/array/exists.ts
-import { findValue } from "../internal/array-find";
-function exists(array, value, key) {
-  return findValue("index", array, value, key) > -1;
-}
-export {
-  exists
-};

package/dist/js/array/filter.mjs

@@ -1,8 +0,0 @@
-// src/js/array/filter.ts
-import { findValues } from "../internal/array-find";
-function filter(array, value, key) {
-  return findValues("all", array, value, key);
-}
-export {
-  filter
-};

package/dist/js/array/find.mjs

@@ -1,8 +0,0 @@
-// src/js/array/find.ts
-import { findValue } from "../internal/array-find";
-function find(array, value, key) {
-  return findValue("value", array, value, key);
-}
-export {
-  find
-};

package/dist/js/array/group-by.mjs

@@ -1,33 +0,0 @@
-// src/js/array/group-by.ts
-import { getCallbacks } from "../internal/array-callbacks";
-function groupBy(array, key) {
-  return groupValues(array, key, true, false);
-}
-function groupValues(array, key, arrays, indicable) {
-  const callbacks = getCallbacks(undefined, key);
-  const hasCallback = typeof callbacks?.key === "function";
-  if (!hasCallback && !indicable) {
-    return {};
-  }
-  const record = {};
-  const { length } = array;
-  for (let index = 0;index < length; index += 1) {
-    const value = array[index];
-    const key2 = hasCallback ? callbacks?.key?.(value, index, array) ?? index : index;
-    if (arrays) {
-      const existing = record[key2];
-      if (Array.isArray(existing)) {
-        existing.push(value);
-      } else {
-        record[key2] = [value];
-      }
-    } else {
-      record[key2] = value;
-    }
-  }
-  return record;
-}
-export {
-  groupValues,
-  groupBy
-};

package/dist/js/array/index-of.mjs

@@ -1,8 +0,0 @@
-// src/js/array/index-of.ts
-import { findValue } from "../internal/array-find";
-function indexOf(array, value, key) {
-  return findValue("index", array, value, key);
-}
-export {
-  indexOf
-};

package/dist/js/array/index.mjs

@@ -1,34 +0,0 @@
-// src/js/array/index.ts
-import { insertValues } from "./insert";
-function flatten(array) {
-  return array.flat(Number.POSITIVE_INFINITY);
-}
-function push(array, values) {
-  return insertValues("push", array, values, array.length, 0);
-}
-
-export * from "./chunk";
-export * from "./compact";
-export * from "./count";
-export * from "./exists";
-export * from "./filter";
-export * from "./find";
-import { groupBy } from "./group-by";
-
-export * from "./index-of";
-import { insert } from "./insert";
-
-export * from "./shuffle";
-import { sort } from "./sort";
-
-export * from "./splice";
-export * from "./to-map";
-export * from "./to-record";
-export * from "./unique";
-export {
-  sort,
-  push,
-  insert,
-  groupBy,
-  flatten
-};

package/dist/js/array/insert.mjs

@@ -1,22 +0,0 @@
-// src/js/array/insert.ts
-import { chunk } from "./chunk";
-function insert(array, index, values) {
-  insertValues("splice", array, values, index, 0);
-}
-function insertValues(type, array, values, start, deleteCount) {
-  const chunked = chunk(values);
-  const lastIndex = chunked.length - 1;
-  let index = Number(chunked.length);
-  let returned;
-  while (--index >= 0) {
-    const result = array.splice(start, index === lastIndex ? deleteCount : 0, ...chunked[index]);
-    if (returned == null) {
-      returned = result;
-    }
-  }
-  return type === "splice" ? returned : array.length;
-}
-export {
-  insertValues,
-  insert
-};

package/dist/js/array/splice.mjs

@@ -1,9 +0,0 @@
-// src/js/array/splice.ts
-import { insertValues } from "./insert";
-function splice(array, start, amountOrValues, values) {
-  const amoutOrValuesIsArray = Array.isArray(amountOrValues);
-  return insertValues("splice", array, amoutOrValuesIsArray ? amountOrValues : values ?? [], start, amoutOrValuesIsArray ? array.length : typeof amountOrValues === "number" && amountOrValues > 0 ? amountOrValues : 0);
-}
-export {
-  splice
-};

package/dist/js/array/to-map.mjs

@@ -1,27 +0,0 @@
-// src/js/array/to-map.ts
-import { getCallbacks } from "../internal/array-callbacks";
-function toMap(array, first, second) {
-  const asArrays = first === true || second === true;
-  const callbacks = getCallbacks(undefined, first);
-  const hasCallback = typeof callbacks?.key === "function";
-  const map = new Map;
-  const { length } = array;
-  for (let index = 0;index < length; index += 1) {
-    const value = array[index];
-    const key = hasCallback ? callbacks?.key?.(value, index, array) ?? index : index;
-    if (asArrays) {
-      const existing = map.get(key);
-      if (Array.isArray(existing)) {
-        existing.push(value);
-      } else {
-        map.set(key, [value]);
-      }
-    } else {
-      map.set(key, value);
-    }
-  }
-  return map;
-}
-export {
-  toMap
-};

package/dist/js/array/to-record.mjs

@@ -1,8 +0,0 @@
-// src/js/array/to-record.ts
-import { groupValues } from "./group-by";
-function toRecord(array, first, second) {
-  return groupValues(array, first, first === true || second === true, true);
-}
-export {
-  toRecord
-};

package/dist/js/array/unique.mjs

@@ -1,8 +0,0 @@
-// src/js/array/unique.ts
-import { findValues } from "../internal/array-find";
-function unique(array, key) {
-  return findValues("unique", array, undefined, key);
-}
-export {
-  unique
-};

package/dist/js/colour/index.mjs

@@ -1,30 +0,0 @@
-// src/js/colour/index.ts
-function getForegroundColour(value) {
-  const values = [value.blue / 255, value.green / 255, value.red / 255];
-  for (let colour of values) {
-    if (colour <= 0.03928) {
-      colour /= 12.92;
-    } else {
-      colour = ((colour + 0.055) / 1.055) ** 2.4;
-    }
-  }
-  const luminance = 0.2126 * values[2] + 0.7152 * values[1] + 0.0722 * values[0];
-  return luminance > 0.625 ? "black" : "white";
-}
-import { getHexColour, HexColour } from "./hex";
-import { getHSLColour, HSLColour } from "./hsl";
-import { isColour, isHexColour, isHSLColour, isRGBColour } from "./is";
-import { getRGBColour, RGBColour } from "./rgb";
-export {
-  isRGBColour,
-  isHexColour,
-  isHSLColour,
-  isColour,
-  getRGBColour,
-  getHexColour,
-  getHSLColour,
-  getForegroundColour,
-  RGBColour,
-  HexColour,
-  HSLColour
-};

package/dist/js/index.mjs

@@ -1,17 +0,0 @@
-// src/js/index.ts
-export * from "./array/index";
-export * from "./colour/index";
-export * from "./emitter";
-export * from "./function";
-export * from "./is";
-export * from "./logger";
-export * from "./math";
-export * from "./models";
-export * from "./number";
-export * from "./query";
-export * from "./queue";
-export * from "./random";
-export * from "./sized";
-export * from "./string/index";
-export * from "./touch";
-export * from "./value/index";

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

@@ -1,19 +0,0 @@
-// src/js/internal/array-callbacks.ts
-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?.[key]
-  };
-}
-export {
-  getCallbacks
-};

package/dist/js/internal/array-find.mjs

@@ -1,51 +0,0 @@
-// src/js/internal/array-find.ts
-import { getCallbacks } from "./array-callbacks";
-function findValue(type, array, value, key) {
-  const callbacks = getCallbacks(value, key);
-  if (callbacks?.bool == null && callbacks?.key == null) {
-    return type === "index" ? array.indexOf(value) : array.find((item) => item === value);
-  }
-  if (callbacks.bool != null) {
-    const index = array.findIndex(callbacks.bool);
-    return type === "index" ? index : index > -1 ? array[index] : undefined;
-  }
-  const { length } = array;
-  for (let index = 0;index < length; index += 1) {
-    const item = array[index];
-    if (callbacks.key?.(item, index, array) === value) {
-      return type === "index" ? index : item;
-    }
-  }
-  return type === "index" ? -1 : undefined;
-}
-function findValues(type, array, value, key) {
-  const callbacks = getCallbacks(value, key);
-  const { length } = array;
-  if (type === "unique" && callbacks?.key == null && length >= 100) {
-    return Array.from(new Set(array));
-  }
-  if (typeof callbacks?.bool === "function") {
-    return array.filter(callbacks.bool);
-  }
-  if (type === "all" && key == null) {
-    return array.filter((item) => item === value);
-  }
-  const hasCallback = typeof callbacks?.key === "function";
-  const result = [];
-  const values = hasCallback ? [] : result;
-  for (let index = 0;index < length; index += 1) {
-    const item = array[index];
-    const itemKey = hasCallback ? callbacks.key?.(item, index, array) : item;
-    if (type === "all" && itemKey === value || type === "unique" && values.indexOf(itemKey) === -1) {
-      if (values !== result) {
-        values.push(itemKey);
-      }
-      result.push(item);
-    }
-  }
-  return result;
-}
-export {
-  findValues,
-  findValue
-};

package/dist/js/logger.mjs

@@ -1,69 +0,0 @@
-// src/js/logger.ts
-import { noop } from "./function";
-if (globalThis._atomic_logging == null) {
-  globalThis._atomic_logging = true;
-}
-
-class Logger {
-  get debug() {
-    return this.enabled ? console.debug : noop;
-  }
-  get dir() {
-    return this.enabled ? console.dir : noop;
-  }
-  get enabled() {
-    return globalThis._atomic_logging ?? true;
-  }
-  set enabled(value) {
-    globalThis._atomic_logging = value;
-  }
-  get error() {
-    return this.enabled ? console.error : noop;
-  }
-  get info() {
-    return this.enabled ? console.info : noop;
-  }
-  get log() {
-    return this.enabled ? console.log : noop;
-  }
-  get table() {
-    return this.enabled ? console.table : noop;
-  }
-  get trace() {
-    return this.enabled ? console.trace : noop;
-  }
-  get warn() {
-    return this.enabled ? console.warn : noop;
-  }
-  time(label) {
-    return new Time(label);
-  }
-}
-
-class Time {
-  constructor(label) {
-    this.state = {
-      label,
-      started: globalThis._atomic_logging ?? true,
-      stopped: false
-    };
-    if (this.state.started) {
-      console.time(label);
-    }
-  }
-  log() {
-    if (this.state.started && !this.state.stopped && logger.enabled) {
-      console.timeLog(this.state.label);
-    }
-  }
-  stop() {
-    if (this.state.started && !this.state.stopped) {
-      this.state.stopped = true;
-      console.timeEnd(this.state.label);
-    }
-  }
-}
-var logger = new Logger;
-export {
-  logger
-};

package/dist/js/string/index.mjs

@@ -1,44 +0,0 @@
-// src/js/string/index.ts
-import { compact } from "../array";
-function createUuid() {
-  return "10000000-1000-4000-8000-100000000000".replace(/[018]/g, (substring) => (substring ^ crypto.getRandomValues(new Uint8Array(1))[0] & 15 >> substring / 4).toString(16));
-}
-function getString(value) {
-  if (typeof value === "string") {
-    return value;
-  }
-  if (typeof value !== "object" || value == null) {
-    return String(value);
-  }
-  const valueOff = value.valueOf?.() ?? value;
-  const asString = valueOff?.toString?.() ?? String(valueOff);
-  return asString.startsWith("[object ") ? JSON.stringify(value) : asString;
-}
-function join(value, delimiter) {
-  return compact(value).map(getString).filter((value2) => value2.trim().length > 0).join(typeof delimiter === "string" ? delimiter : "");
-}
-function parse(value, reviver) {
-  try {
-    return JSON.parse(value, reviver);
-  } catch {
-  }
-}
-function truncate(value, length, suffix) {
-  const suffixLength = suffix?.length ?? 0;
-  const truncatedLength = length - suffixLength;
-  return value.length <= length ? value : `${value.slice(0, truncatedLength)}${suffix ?? ""}`;
-}
-function words(value) {
-  return value.match(/[^\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\x7f]+/g) ?? [];
-}
-
-export * from "./case";
-export * from "./template";
-export {
-  words,
-  truncate,
-  parse,
-  join,
-  getString,
-  createUuid
-};

package/dist/js/value/index.mjs

@@ -1,23 +0,0 @@
-// src/js/value/index.ts
-function partial(value, keys) {
-  const result = {};
-  const { length } = keys;
-  for (let index = 0;index < length; index += 1) {
-    const key = keys[index];
-    result[key] = value[key];
-  }
-  return result;
-}
-
-export * from "./clone";
-export * from "./compare";
-export * from "./diff";
-export * from "./equal";
-export * from "./get";
-export * from "./merge";
-export * from "./set";
-export * from "./smush";
-export * from "./unsmush";
-export {
-  partial
-};

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.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.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[];