@oscarpalmer/atoms 0.213.0 → 0.214.0

package/dist/value/merge.d.mts

@@ -1,67 +1,8 @@
-import { ArrayOrPlainObject, NestedPartial, PlainObject, UnionToIntersection } from "../models.mjs";
+import { ArrayOrPlainObject, PlainObject, UnionToIntersection } from "../models/index.mjs";
+import { AssignOptions, Assigner, MergeOptions, Merger, MergingOptions } from "../models/value/value.merge.model.mjs";
 //#region src/value/merge.d.ts
-/**
- * Options for assigning values
- */
-export type AssignOptions = Omit<MergeOptions, "assignValues">;
-/**
- * An assigner function for assigning values from one or more objects to the first one
- */
-export type Assigner = {
-  /**
-   * Assign values from one or more objects to the first one
-   *
-   * @param to Value to assign to
-   * @param from Values to assign
-   * @returns Assigned value
-   */
-  assign<To extends PlainObject, From extends PlainObject[]>(to: To, from: [...From]): To & UnionToIntersection<From[number]>;
-};
-/**
- * Options for merging values
- */
-export type MergeOptions = {
-  /**
-   * Assign values to the first array or object instead of creating a new one?
-   */
-  assignValues?: boolean;
-  /**
-   * Key _(or key epxressions)_ for values that should be replaced
-   *
-   * ```ts
-   * merge([{items: [1, 2, 3]}, {items: [99]}]); // => {items: [99]}
-   * ```
-   */
-  replaceableObjects?: string | RegExp | Array<string | RegExp>;
-  /**
-   * Skip nullable values when merging objects?
-   *
-   * ```ts
-   * merge({a: 1, b: 2}, {b: null, c: 3}, {d: null}); // => {a: 1, b: 2, c: 3}
-   * ```
-   */
-  skipNullableAny?: boolean;
-  /**
-   * Skip nullable values when merging arrays?
-   *
-   * ```ts
-   * merge([1, 2, 3], [null, null, 99]); // => [1, 2, 99]
-   * ```
-   */
-  skipNullableInArrays?: boolean;
-};
-/**
- * A merger function for merging multiple arrays or objects into a single one
- */
-export type Merger = {
-  /**
-   * Merge multiple arrays or objects into a single one
-   *
-   * @param values Values to merge
-   * @returns Merged value
-   */
-  merge<Values extends ArrayOrPlainObject[]>(values: Array<NestedPartial<Values[number]>>): UnionToIntersection<Values[number]>;
-};
+declare function Assigner(this: any, options: MergingOptions): void;
+declare function Merger(this: any, options: MergingOptions): void;
 /**
  * Assign values from one or more objects to the first one
  *
@@ -103,4 +44,5 @@ export declare namespace assign {
 export declare namespace merge {
   export var initialize: typeof initializeMerger;
 }
-//#endregion
+//#endregion
+export type { AssignOptions, Assigner, MergeOptions, Merger };

package/dist/value/merge.mjs

@@ -1,4 +1,5 @@
 import { isArrayOrPlainObject } from "../internal/is.mjs";
+import { MERGE_SYMBOL_ASSIGN, MERGE_SYMBOL_MERGE } from "../models/value/value.merge.model.mjs";
 //#region src/value/merge.ts
 function Assigner(options) {
 	this[MERGE_SYMBOL_ASSIGN] = {
@@ -20,21 +21,22 @@ Merger.prototype.merge = mergeFromMerger;
 * @returns Assigned value
 */
 function assign(to, from, options) {
-	const actual = createMergeOptions(options);
+	const actual = createMergingOptions(options);
 	actual.assignValues = true;
 	return mergeValues([to, ...from], actual);
 }
 function assignFromAssigner(to, from) {
 	return mergeValues([to, ...from], this[MERGE_SYMBOL_ASSIGN]);
 }
-function createMergeOptions(options) {
+function createMergingOptions(input) {
 	const actual = {
 		assignValues: false,
 		replaceableObjects: void 0,
 		skipNullableAny: false,
 		skipNullableInArrays: false
 	};
-	if (typeof options !== "object" || options == null) return actual;
+	if (typeof input !== "object" || input == null) return actual;
+	const options = input;
 	actual.replaceableObjects = getReplaceableObjects(options.replaceableObjects);
 	actual.assignValues = options.assignValues === true;
 	actual.skipNullableAny = options.skipNullableAny === true;
@@ -55,7 +57,7 @@ function getReplaceableObjects(value) {
 * @returns Assigner function
 */
 function initializeAssigner(options) {
-	return new Assigner(createMergeOptions(options));
+	return new Assigner(createMergingOptions(options));
 }
 /**
 * Create a merger with predefined options
@@ -66,7 +68,7 @@ function initializeAssigner(options) {
 * @returns Merger function
 */
 function initializeMerger(options) {
-	return new Merger(createMergeOptions(options));
+	return new Merger(createMergingOptions(options));
 }
 /**
 * Merge multiple arrays or objects into a single one
@@ -76,7 +78,7 @@ function initializeMerger(options) {
 * @returns Merged value
 */
 function merge(values, options) {
-	return mergeValues(values, createMergeOptions(options));
+	return mergeValues(values, createMergingOptions(options));
 }
 function mergeFromMerger(values) {
 	return mergeValues(values, this[MERGE_SYMBOL_MERGE]);
@@ -110,8 +112,6 @@ function mergeValues(values, options, prefix) {
 	if (actual.length > 1) return mergeObjects(actual, options, options.assignValues ? actual[0] : void 0, prefix);
 	return options.assignValues ? actual[0] : Array.isArray(actual[0]) ? actual[0].slice() : { ...actual[0] };
 }
-const MERGE_SYMBOL_ASSIGN = Symbol("assign");
-const MERGE_SYMBOL_MERGE = Symbol("merge");
 assign.initialize = initializeAssigner;
 merge.initialize = initializeMerger;
 //#endregion

package/dist/value/omit.d.mts

@@ -1,4 +1,4 @@
-import { PlainObject } from "../models.mjs";
+import { PlainObject } from "../models/index.mjs";
 //#region src/value/omit.d.ts
 /**
  * Create a new object without the specified keys

package/dist/value/pick.d.mts

@@ -1,4 +1,4 @@
-import { PlainObject } from "../models.mjs";
+import { PlainObject } from "../models/index.mjs";
 //#region src/value/pick.d.ts
 /**
  * Create a new object with only the specified keys

package/dist/value/shake.d.mts

@@ -1,9 +1,6 @@
-import { PlainObject, Simplify } from "../models.mjs";
+import { PlainObject } from "../models/index.mjs";
+import { Shaken } from "../models/value/value.misc.model.mjs";
 //#region src/value/shake.d.ts
-/**
- * A shaken object, without any `undefined` values
- */
-export type Shaken<Value extends PlainObject> = Simplify<{ [Key in keyof Value as undefined extends Value[Key] ? never : Key]: Value[Key]; } & { [Key in keyof Value as undefined extends Value[Key] ? [Value[Key]] extends [undefined] ? never : Key : never]?: Exclude<Value[Key], undefined>; }>;
 /**
  * Shake an object, removing all keys with `undefined` values
  *
@@ -11,4 +8,5 @@ export type Shaken<Value extends PlainObject> = Simplify<{ [Key in keyof Value a
  * @returns Shaken object
  */
 export declare function shake<Value extends PlainObject>(value: Value): Shaken<Value>;
-//#endregion
+//#endregion
+export type { Shaken };

package/dist/value/smush.d.mts

@@ -1,9 +1,6 @@
-import { NestedKeys, NestedValue, PlainObject, Simplify, ToString } from "../models.mjs";
+import { PlainObject } from "../models/index.mjs";
+import { Smushed } from "../models/value/value.misc.model.mjs";
 //#region src/value/smush.d.ts
-/**
- * A smushed object, with all nested objects flattened into a single level, using dot notation keys
- */
-export type Smushed<Value extends PlainObject> = Simplify<{ [NestedKey in NestedKeys<Value>]: NestedValue<Value, ToString<NestedKey>>; }>;
 /**
  * Smush an object into a flat object that uses dot notation keys
  *
@@ -11,4 +8,5 @@ export type Smushed<Value extends PlainObject> = Simplify<{ [NestedKey in Nested
  * @returns Smushed object with dot notation keys
  */
 export declare function smush<Value extends PlainObject>(value: Value): Smushed<Value>;
-//#endregion
+//#endregion
+export type { Smushed };

package/dist/value/smush.mjs

@@ -1,8 +1,9 @@
 import { isArrayOrPlainObject } from "../internal/is.mjs";
+import "../models/value/value.misc.model.mjs";
 import { join } from "../internal/string/misc.mjs";
 //#region src/value/smush.ts
 function flattenObject(value, depth, smushed, prefix) {
-	if (depth >= SMUSH_MAX_DEPTH) return {};
+	if (depth >= 100) return {};
 	if (smushed.has(value)) return smushed.get(value);
 	const keys = Object.keys(value);
 	const { length } = keys;
@@ -34,6 +35,5 @@ function flattenObject(value, depth, smushed, prefix) {
 function smush(value) {
 	return typeof value === "object" && value !== null ? flattenObject(value, 0, /* @__PURE__ */ new WeakMap()) : {};
 }
-const SMUSH_MAX_DEPTH = 100;
 //#endregion
 export { smush };

package/dist/value/transform.d.mts

@@ -1,25 +1,8 @@
-import { PlainObject } from "../models.mjs";
+import { PlainObject } from "../models/index.mjs";
+import { TransformCallback, TransformCallbacks, TransformHandler } from "../models/value/value.transform.model.mjs";
 //#region src/value/transform.d.ts
-/**
- * A callback transform an object's properties
- */
-type TransformCallback<Value extends PlainObject, Key extends keyof Value> = (key: Key, value: Value[Key]) => Value[Key];
-/**
- * A collection of keyed callbacks to transform an object's properties
- */
-type TransformCallbacks<Value extends PlainObject> = Partial<{ [Key in keyof Value]: (value: Value[Key]) => Value[Key]; }>;
-/**
- * A transformer for an object, with predefined callbacks for transforming its properties
- */
-export type Transformer<Value extends PlainObject> = {
-  /**
-   * Transform an object's properties
-   *
-   * @param value Object to transform
-   * @returns Transformed object
-   */
-  transform(value: Value): Value;
-};
+declare function Transformer(this: any, transformer: ReturnType<typeof getTransformHandler>): void;
+declare function getTransformHandler<Value extends PlainObject, Key extends keyof Value>(input: unknown): TransformHandler<Value> | undefined;
 /**
  * Initialize a transformer for an object with a transformer function
  *
@@ -57,4 +40,5 @@ export declare function transform<Value extends PlainObject>(value: Value, trans
 export declare namespace transform {
   export var initialize: typeof initializeTransformer;
 }
-//#endregion
+//#endregion
+export type { TransformCallback, TransformCallbacks, Transformer };

package/dist/value/transform.mjs

@@ -1,4 +1,5 @@
 import { isNonPlainObject } from "../internal/is.mjs";
+import { TRANSFORM_SYMBOL } from "../models/value/value.transform.model.mjs";
 //#region src/value/transform.ts
 function Transformer(transformer) {
 	this[TRANSFORM_SYMBOL] = transformer;
@@ -37,7 +38,6 @@ function transformValue(value) {
 	}
 	return value;
 }
-const TRANSFORM_SYMBOL = Symbol("transform");
 transform.initialize = initializeTransformer;
 //#endregion
 export { initializeTransformer, transform };

package/dist/value/unsmush.d.mts

@@ -1,13 +1,6 @@
-import { PlainObject, Simplify, UnionToIntersection } from "../models.mjs";
+import { PlainObject } from "../models/index.mjs";
+import { Unsmushed } from "../models/value/value.misc.model.mjs";
 //#region src/value/unsmush.d.ts
-/**
- * Thanks, type-fest!
- */
-type KeysOfUnion<ObjectType> = keyof UnionToIntersection<ObjectType extends unknown ? Record<keyof ObjectType, never> : never>;
-/**
- * An unsmushed object, with all dot notation keys turned into nested keys
- */
-export type Unsmushed<Value extends PlainObject> = Simplify<Omit<{ [UnionKey in KeysOfUnion<Value>]: Value[UnionKey]; }, `${string}.${string}`>>;
 /**
  * Unsmush a smushed object _(turning dot notation keys into nested keys)_
  *
@@ -15,4 +8,5 @@ export type Unsmushed<Value extends PlainObject> = Simplify<Omit<{ [UnionKey in
  * @returns Unsmushed object with nested keys
  */
 export declare function unsmush<Value extends PlainObject>(value: Value): Unsmushed<Value>;
-//#endregion
+//#endregion
+export type { Unsmushed };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.213.0",
+	"version": "0.214.0",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"array",
@@ -30,6 +30,7 @@
 		"plugin"
 	],
 	"type": "module",
+	"sideEffects": false,
 	"module": "./dist/index.mjs",
 	"types": "./dist/index.d.mts",
 	"exports": {
@@ -143,7 +144,7 @@
 			"default": "./dist/math.mjs"
 		},
 		"./models": {
-			"types": "./dist/models.d.mts"
+			"types": "./dist/models/index.d.mts"
 		},
 		"./number": {
 			"types": "./dist/number.d.mts",
@@ -164,6 +165,14 @@
 		"./plan/models": {
 			"default": "./dist/plan/models.mjs"
 		},
+		"./plan/result": {
+			"types": "./dist/plan/result.d.mts",
+			"default": "./dist/plan/result.mjs"
+		},
+		"./plan/run": {
+			"types": "./dist/plan/run.d.mts",
+			"default": "./dist/plan/run.mjs"
+		},
 		"./promise": {
 			"types": "./dist/promise/index.d.mts",
 			"default": "./dist/promise/index.mjs"
@@ -212,7 +221,7 @@
 			"default": "./dist/result/misc.mjs"
 		},
 		"./result/models": {
-			"default": "./dist/internal/models/result.model.mjs"
+			"default": "./dist/models/result.model.mjs"
 		},
 		"./result/pipe": {
 			"types": "./dist/result/work/pipe.d.mts",
@@ -295,7 +304,6 @@
 			"default": "./dist/value/transform.mjs"
 		}
 	},
-	"sideEffects": false,
 	"scripts": {
 		"build": "npx vp pack && npm run tsdown:build",
 		"tsdown:build": "npx tsdown -c ./tsdown.config.ts",

package/dist/promise/constants.d.mts

@@ -1,17 +0,0 @@
-import { PromiseStrategy } from "./models.mjs";
-//#region src/promise/constants.d.ts
-export declare const PROMISE_ABORT_EVENT = "abort";
-export declare const PROMISE_ABORT_OPTIONS: {
-  once: boolean;
-};
-export declare const PROMISE_ERROR_NAME = "PromiseTimeoutError";
-export declare const PROMISE_MESSAGE_EXPECTATION_ATTEMPT = "Attempt expected a function or a promise";
-export declare const PROMISE_MESSAGE_EXPECTATION_ITEMS_TYPE = "promises expected an array or object holding promise-functions or promises";
-export declare const PROMISE_MESSAGE_EXPECTATION_RESULT = "toResult expected a Promise";
-export declare const PROMISE_MESSAGE_EXPECTATION_TIMED = "Timed function expected a Promise";
-export declare const PROMISE_MESSAGE_TIMEOUT = "Promise timed out";
-export declare const PROMISE_STRATEGY_ALL: Set<PromiseStrategy>;
-export declare const PROMISE_STRATEGY_DEFAULT: PromiseStrategy;
-export declare const PROMISE_TYPE_FULFILLED = "fulfilled";
-export declare const PROMISE_TYPE_REJECTED = "rejected";
-//#endregion

package/dist/promise/constants.mjs

@@ -1,15 +0,0 @@
-//#region src/promise/constants.ts
-const PROMISE_ABORT_EVENT = "abort";
-const PROMISE_ABORT_OPTIONS = { once: true };
-const PROMISE_ERROR_NAME = "PromiseTimeoutError";
-const PROMISE_MESSAGE_EXPECTATION_ATTEMPT = "Attempt expected a function or a promise";
-const PROMISE_MESSAGE_EXPECTATION_ITEMS_TYPE = "promises expected an array or object holding promise-functions or promises";
-const PROMISE_MESSAGE_EXPECTATION_RESULT = "toResult expected a Promise";
-const PROMISE_MESSAGE_EXPECTATION_TIMED = "Timed function expected a Promise";
-const PROMISE_MESSAGE_TIMEOUT = "Promise timed out";
-const PROMISE_STRATEGY_ALL = /* @__PURE__ */ new Set(["complete", "first"]);
-const PROMISE_STRATEGY_DEFAULT = "complete";
-const PROMISE_TYPE_FULFILLED = "fulfilled";
-const PROMISE_TYPE_REJECTED = "rejected";
-//#endregion
-export { PROMISE_ABORT_EVENT, PROMISE_ABORT_OPTIONS, PROMISE_ERROR_NAME, PROMISE_MESSAGE_EXPECTATION_ATTEMPT, PROMISE_MESSAGE_EXPECTATION_ITEMS_TYPE, PROMISE_MESSAGE_EXPECTATION_RESULT, PROMISE_MESSAGE_EXPECTATION_TIMED, PROMISE_MESSAGE_TIMEOUT, PROMISE_STRATEGY_ALL, PROMISE_STRATEGY_DEFAULT, PROMISE_TYPE_FULFILLED, PROMISE_TYPE_REJECTED };