@oscarpalmer/atoms 0.210.0 → 0.212.0

package/dist/array/sort.d.mts

@@ -53,7 +53,7 @@ export type ArrayValueSorter<Item> = {
   /**
    * Value to sort by
    */
-  value: (item: Item) => unknown;
+  value(item: Item): unknown;
 };
 /**
  * Comparator to use when comparing items and values

package/dist/color/models.d.mts

@@ -1,5 +1,5 @@
 import { Subscription } from "../internal/subscription.mjs";
-import { Herald, HeraldEvents } from "../internal/herald.mjs";
+import { Herald, HeraldEvents } from "../internal/models/herald.model.mjs";
 import { COLOR_SYMBOL } from "./constants.mjs";
 //#region src/color/models.d.ts
 export type Alpha = {
@@ -187,16 +187,16 @@ export type Color = {
   unsubscribe(): void;
 };
 export type ColorChanges = {
-  "*": (value: Color) => void;
-  alpha: (value: number) => void;
-  hex: (value: string) => void;
-  hexa: (value: string) => void;
-  hsl: (value: HSLColor) => void;
-  hsla: (value: HSLAColor) => void;
-  hwb: (value: HWBColor) => void;
-  hwba: (value: HWBAColor) => void;
-  rgb: (value: RGBColor) => void;
-  rgba: (value: RGBAColor) => void;
+  "*"(value: Color): void;
+  alpha(value: number): void;
+  hex(value: string): void;
+  hexa(value: string): void;
+  hsl(value: HSLColor): void;
+  hsla(value: HSLAColor): void;
+  hwb(value: HWBColor): void;
+  hwba(value: HWBAColor): void;
+  rgb(value: RGBColor): void;
+  rgba(value: RGBAColor): void;
 };
 export type ColorDefaults = {
   alpha: Alpha;

package/dist/herald.d.mts

@@ -1,2 +1,3 @@
+import { Herald, HeraldEvents } from "./internal/models/herald.model.mjs";
 import { herald, isHerald, isHeraldEvents, isHeraldSubscription } from "./internal/herald.mjs";
-export { herald, isHerald, isHeraldEvents, isHeraldSubscription };
+export { type Herald, type HeraldEvents, herald, isHerald, isHeraldEvents, isHeraldSubscription };

package/dist/index.d.mts

@@ -90,7 +90,7 @@ export type OnceAsync<Callback extends GenericAsyncCallback> = {
    * @param parameters Callback parameters
    * @returns Call result
    */
-  run: (...parameters: Parameters<Callback>) => ReturnType<Callback>;
+  run(...parameters: Parameters<Callback>): ReturnType<Callback>;
 } & OnceProperties;
 /**
  * A callback function that can only be called once, returning the same value on subsequent calls
@@ -102,7 +102,7 @@ export type Once<Callback extends GenericCallback> = {
    * @param parameters Callback parameters
    * @returns Call result
    */
-  run: (...parameters: Parameters<Callback>) => ReturnType<Callback>;
+  run(...parameters: Parameters<Callback>): ReturnType<Callback>;
 } & OnceProperties;
 type OnceProperties = {
   /**
@@ -116,7 +116,7 @@ type OnceProperties = {
   /**
    * Clear the callback's cached value
    */
-  clear: () => void;
+  clear(): void;
 };
 /**
  * A generic object
@@ -2615,7 +2615,7 @@ export type ArrayValueSorter<Item> = {
   /**
    * Value to sort by
    */
-  value: (item: Item) => unknown;
+  value(item: Item): unknown;
 };
 /**
  * Comparator to use when comparing items and values
@@ -3711,14 +3711,14 @@ export type ResultMatch<Value, Returned, E = Error> = {
    * @param original Original error, if available
    * @returns Value to return
    */
-  error: (error: E, original?: Error) => Returned;
+  error(error: E, original?: Error): Returned;
   /**
    * Callback for ok result
    *
    * @param value Ok value
    * @returns Value to return
    */
-  ok: (value: Value) => Returned;
+  ok(value: Value): Returned;
 };
 /**
  * Unwrap a result value
@@ -4257,9 +4257,9 @@ type BaseHandler = {
   handlers: WeakMap<WeakKey, string | GenericCallback>;
   options: BaseHandlerOptions;
   owner: GenericCallback;
-  deregister: (constructor: Constructor) => void;
-  get: (first: unknown, second: unknown) => string | GenericCallback | undefined;
-  register: (constructor: Constructor, handler?: string | GenericCallback) => void;
+  deregister(constructor: Constructor): void;
+  get(first: unknown, second: unknown): string | GenericCallback | undefined;
+  register(constructor: Constructor, handler?: string | GenericCallback): void;
 };
 type BaseHandlerOptions = {
   callback: GenericCallback;
@@ -4591,86 +4591,148 @@ export declare function setValue<Data extends PlainObject>(data: Data, path: str
 /**
  * An asynchronous plan of execution that can yield intermediate results and eventually return a result
  */
-type AsyncPlan<Yielded, Returned> = {
+type AsyncPlan<Yielded, Returned, Parameters extends unknown[]> = {
   /**
    * Get the asynchronous generator for the plan
    *
    * @returns Asynchronous generator
    */
   [Symbol.asyncIterator]: () => AsyncGenerator<Yielded, Returned, unknown>;
+  /**
+   * Attempt to run the plan to completion
+   *
+   * _Returns a promised {@link Result} instead of a raw value or throwing an error_
+   *
+   * @returns Promised result
+   */
+  attempt(...parameters: Parameters): Promise<Result<PlanResult<Returned>, PlanError<Yielded, Returned>>>;
   /**
    * Run the plan to completion
    *
    * @throws {PlanError<Yielded, Returned>}
    * @returns Result
    */
-  run: () => Promise<PlanResult<Returned>>;
+  run(...parameters: Parameters): Promise<PlanResult<Returned>>;
 };
 /**
  * A plan of execution that can yield intermediate results and eventually return a result
  */
-type Plan<Yielded, Returned> = {
+type Plan<Yielded, Returned, Parameters extends unknown[]> = {
   /**
    * Get the generator for the plan
    *
    * @returns Generator
    */
   [Symbol.iterator]: () => Generator<Yielded, Returned, unknown>;
+  /**
+   * Attempt to run the plan to completion
+   *
+   * _Returns a {@link Result} instead of a raw value or throwing an error_
+   *
+   * @returns Result
+   */
+  attempt(...parameters: Parameters): Result<PlanResult<Returned>, PlanError<Yielded, Returned>>;
   /**
    * Run the plan to completion
    *
    * @throws {PlanError<Yielded, Returned>}
    * @returns Result
    */
-  run: () => PlanResult<Returned>;
+  run(...parameters: Parameters): PlanResult<Returned>;
 };
-type PlanErrorValues<Original> = Original extends Error ? Original : never;
+type PlanErrorValues<Original> = Original extends Error ? Original : Original extends Err<infer Error> ? Error : Original extends Result<infer _, infer Error> ? Error : never;
 type PlanError<Yielded, Returned> = PlanErrorValues<Yielded> | PlanErrorValues<Returned> | Error;
-type PlanResult<Returned> = Returned extends Error ? never : Returned;
+type PlanResult<Returned> = Returned extends Error ? never : Returned extends Err<infer _> ? never : Returned extends Ok<infer Value> ? Value : Returned extends Result<infer Value, infer _> ? Value : Returned;
 //#endregion
-//#region src/plan/index.d.ts
+//#region src/plan/result.d.ts
 /**
- * Create a plan for an asynchronous generator function
+ * Attempt to run the generator to completion
  *
- * @param generator Generator to plan for
- * @returns Generator plan
+ * _Returns a promised {@link Result} instead of a raw value or throwing an error_
+ *
+ * @returns Promised result
  */
-export declare function plan<Yielded, Returned>(generator: () => AsyncGenerator<Yielded, Returned>): AsyncPlan<Yielded, Returned>;
+export declare function asyncAttemptRun<Yielded, Returned, Parameters extends unknown[]>(generator: (...parameters: Parameters) => AsyncGenerator<Yielded, Returned, unknown>, ...parameters: Parameters): Promise<Result<PlanResult<Returned>, PlanError<Yielded, Returned>>>;
 /**
- * Create a plan for a generator function
+ * Attempt to run the plan to completion
  *
- * @param generator Generator to plan for
- * @returns Generator plan
+ * _Returns a promised {@link Result} instead of a raw value or throwing an error_
+ *
+ * @returns Promised result
  */
-export declare function plan<Yielded, Returned>(generator: () => Generator<Yielded, Returned>): Plan<Yielded, Returned>;
+export declare function asyncAttemptRun<Yielded, Returned, Parameters extends unknown[]>(plan: AsyncPlan<Yielded, Returned, Parameters>, ...parameters: Parameters): Promise<Result<PlanResult<Returned>, PlanError<Yielded, Returned>>>;
+/**
+ * Attempt to run the generator to completion
+ *
+ * _Returns a {@link Result} instead of a raw value or throwing an error_
+ *
+ * @returns Result
+ */
+export declare function attemptRun<Yielded, Returned>(generator: () => Generator<Yielded, Returned, unknown>, ...parameters: Parameters<typeof generator>): Result<PlanResult<Returned>, PlanError<Yielded, Returned>>;
+/**
+ * Attempt to run the plan to completion
+ *
+ * _Returns a {@link Result} instead of a raw value or throwing an error_
+ *
+ * @returns Result
+ */
+export declare function attemptRun<Yielded, Returned, Parameters extends unknown[]>(plan: Plan<Yielded, Returned, Parameters>, ...parameters: Parameters): Result<PlanResult<Returned>, PlanError<Yielded, Returned>>;
+export declare namespace attemptRun {
+  export var async: typeof asyncAttemptRun;
+}
+//#endregion
+//#region src/plan/run.d.ts
 /**
  * Run an asynchronous generator to completion
  *
  * @param generator Generator to run
  * @returns Result
  */
-export declare function run<Yielded, Returned>(generator: () => AsyncGenerator<Yielded, Returned>): Promise<PlanResult<Returned> | PlanError<Yielded, Returned>>;
+export declare function asyncRun<Yielded, Returned, Parameters extends unknown[]>(generator: (...parameters: Parameters) => AsyncGenerator<Yielded, Returned, unknown>, ...parameters: Parameters): Promise<PlanResult<Returned>>;
 /**
  * Run an asynchronous plan to completion
  *
  * @param plan Plan to run
  * @returns Result
  */
-export declare function run<Yielded, Returned>(plan: AsyncPlan<Yielded, Returned>): Promise<PlanResult<Returned> | PlanError<Yielded, Returned>>;
+export declare function asyncRun<Yielded, Returned, Parameters extends unknown[]>(plan: AsyncPlan<Yielded, Returned, Parameters>, ...parameters: Parameters): Promise<PlanResult<Returned>>;
 /**
  * Run a generator to completion
  *
  * @param generator Generator to run
  * @returns Result
  */
-export declare function run<Yielded, Returned>(generator: () => Generator<Yielded, Returned>): PlanResult<Returned> | PlanError<Yielded, Returned>;
+export declare function run<Yielded, Returned, Parameters extends unknown[]>(generator: (...parameters: Parameters) => Generator<Yielded, Returned, unknown>, ...parameters: Parameters): PlanResult<Returned> | PlanError<Yielded, Returned>;
 /**
  * Run a plan to completion
  *
  * @param plan Plan to run
  * @returns Result
  */
-export declare function run<Yielded, Returned>(plan: Plan<Yielded, Returned>): PlanResult<Returned> | PlanError<Yielded, Returned>;
+export declare function run<Yielded, Returned, Parameters extends unknown[]>(plan: Plan<Yielded, Returned, Parameters>, ...parameters: Parameters): PlanResult<Returned> | PlanError<Yielded, Returned>;
+export declare namespace asyncRun {
+  export var attempt: typeof asyncAttemptRun;
+}
+export declare namespace run {
+  export var async: typeof asyncRun;
+  export var attempt: typeof attemptRun;
+}
+//#endregion
+//#region src/plan/index.d.ts
+/**
+ * Create a plan for an asynchronous generator function
+ *
+ * @param generator Generator to plan for
+ * @returns Generator plan
+ */
+export declare function plan<Yielded, Returned, Parameters extends unknown[]>(generator: (...parameters: Parameters) => AsyncGenerator<Yielded, Returned>): AsyncPlan<Yielded, Returned, Parameters>;
+/**
+ * Create a plan for a generator function
+ *
+ * @param generator Generator to plan for
+ * @returns Generator plan
+ */
+export declare function plan<Yielded, Returned, Parameters extends unknown[]>(generator: (...parameters: Parameters) => Generator<Yielded, Returned>): Plan<Yielded, Returned, Parameters>;
 //#endregion
 //#region src/internal/plan.d.ts
 /**
@@ -4679,7 +4741,7 @@ export declare function run<Yielded, Returned>(plan: Plan<Yielded, Returned>): P
  * @param reason Failure reason
  * @returns Failing generator
  */
-export declare function fail<Reason>(reason: Reason): Generator<never, never>;
+export declare function fail<Reason>(reason: Reason): Generator<unknown, never>;
 /**
  * Is the value an asynchronous generator function?
  *
@@ -4693,7 +4755,7 @@ export declare function isAsyncGenerator(value: unknown): value is () => AsyncGe
  * @param value Value to check
  * @returns `true` if the value is an asynchronous plan, otherwise `false`
  */
-export declare function isAsyncPlan<Yielded = unknown, Returned = unknown>(value: unknown): value is AsyncPlan<Yielded, Returned>;
+export declare function isAsyncPlan<Yielded = unknown, Returned = unknown, Parameters extends unknown[] = unknown[]>(value: unknown): value is AsyncPlan<Yielded, Returned, Parameters>;
 /**
  * Is the value a generator function?
  *
@@ -4707,20 +4769,20 @@ export declare function isGenerator(value: unknown): value is () => Generator;
  * @param value Value to check
  * @returns `true` if the value is a plan, otherwise `false`
  */
-export declare function isPlan<Yielded = unknown, Returned = unknown>(value: unknown): value is Plan<Yielded, Returned>;
+export declare function isPlan<Yielded = unknown, Returned = unknown, Parameters extends unknown[] = unknown[]>(value: unknown): value is Plan<Yielded, Returned, Parameters>;
 /**
  * Create an immediately succeeding generator
  *
  * @param value Success value
  * @returns Succeeding generator
  */
-export declare function succeed<Value>(value: Value): Generator<never, Value>;
+export declare function succeed<Value>(value: Value): Generator<unknown, Value>;
 //#endregion
 //#region src/internal/aborter.d.ts
 type Aborter = {
   callback: GenericCallback;
+  cancel(): void;
   signal: AbortSignal;
-  cancel: () => void;
 };
 //#endregion
 //#region src/promise/constants.d.ts
@@ -4759,8 +4821,8 @@ export type PromiseData = {
   result: ArrayOrPlainObject;
 };
 export type PromiseHandlers = {
-  resolve: (value: unknown[]) => void;
-  reject: (reason: unknown) => void;
+  resolve(value: unknown[]): void;
+  reject(reason: unknown): void;
 };
 /**
  * Options for a _Promise_-handling function
@@ -6556,14 +6618,14 @@ type Subscriptions<Value = unknown> = {
   /**
    * Clear all subscriptions
    */
-  clear: () => void;
+  clear(): void;
   /**
    * Create _(or retrieve)_ a subscription
    *
    * @param parameters Subscription parameters
    * @returns Tuple holding subsccription and existing boolean
    */
-  create: (parameters: SubscriptionParameters) => [Subscription, boolean];
+  create(parameters: SubscriptionParameters): [Subscription, boolean];
 };
 /**
  * Parameters for creating a subscription store
@@ -6733,7 +6795,7 @@ export declare function isBeaconSubscription(value: unknown): value is Subscript
  */
 export declare function isObservable<Value = unknown>(value: unknown): value is Observable<Value>;
 //#endregion
-//#region src/internal/herald.d.ts
+//#region src/internal/models/herald.model.d.ts
 type Herald<Events extends Record<string, GenericCallback>> = {
   readonly events: HeraldEvents<Events>;
   /**
@@ -6771,35 +6833,6 @@ type HeraldOptions<Events extends Record<string, GenericCallback>> = {
   property?: SubscriptionProperty;
   onCreate?: HeraldOnCreate<Events>;
 };
-/**
- * Create a _Herald_ for announcing named events
- *
- * @param names Event names
- * @param property Optional property for subscription identification _(defaults to `$herald`)_
- * @returns _Herald_ instance
- */
-export declare function herald<Events extends Record<string, GenericCallback>>(options: HeraldOptions<Events>): Herald<Events>;
-/**
- * Is the value a herald?
- *
- * @param value Value to check
- * @returns `true` if the value is a herald, otherwise `false`
- */
-export declare function isHerald<Events extends Record<string, GenericCallback> = Record<string, GenericCallback>>(value: unknown): value is Herald<Events>;
-/**
- * Is the value events for a herald?
- *
- * @param value Value to check
- * @returns `true` if the value is events for a herald, otherwise `false`
- */
-export declare function isHeraldEvents<Events extends Record<string, GenericCallback> = Record<string, GenericCallback>>(value: unknown): value is HeraldEvents<Events>;
-/**
- * Is the value a herald subscription?
- *
- * @param value Value to check
- * @returns `true` if the value is a herald subscription, otherwise `false`
- */
-export declare function isHeraldSubscription(value: unknown): value is Subscription;
 //#endregion
 //#region src/color/models.d.ts
 /**
@@ -6983,16 +7016,16 @@ type Color = {
   unsubscribe(): void;
 };
 type ColorChanges = {
-  "*": (value: Color) => void;
-  alpha: (value: number) => void;
-  hex: (value: string) => void;
-  hexa: (value: string) => void;
-  hsl: (value: HSLColor) => void;
-  hsla: (value: HSLAColor) => void;
-  hwb: (value: HWBColor) => void;
-  hwba: (value: HWBAColor) => void;
-  rgb: (value: RGBColor) => void;
-  rgba: (value: RGBAColor) => void;
+  "*"(value: Color): void;
+  alpha(value: number): void;
+  hex(value: string): void;
+  hexa(value: string): void;
+  hsl(value: HSLColor): void;
+  hsla(value: HSLAColor): void;
+  hwb(value: HWBColor): void;
+  hwba(value: HWBAColor): void;
+  rgb(value: RGBColor): void;
+  rgba(value: RGBAColor): void;
 };
 type ColorWithAlpha = {
   /**
@@ -7477,6 +7510,37 @@ export declare function rgbToHwba(rgb: RGBAColor | RGBColor): HWBAColor;
  */
 export declare function getColor(value: unknown): Color;
 //#endregion
+//#region src/internal/herald.d.ts
+/**
+ * Create a _Herald_ for announcing named events
+ *
+ * @param names Event names
+ * @param property Optional property for subscription identification _(defaults to `$herald`)_
+ * @returns _Herald_ instance
+ */
+export declare function herald<Events extends Record<string, GenericCallback>>(options: HeraldOptions<Events>): Herald<Events>;
+/**
+ * Is the value a herald?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is a herald, otherwise `false`
+ */
+export declare function isHerald<Events extends Record<string, GenericCallback> = Record<string, GenericCallback>>(value: unknown): value is Herald<Events>;
+/**
+ * Is the value events for a herald?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is events for a herald, otherwise `false`
+ */
+export declare function isHeraldEvents<Events extends Record<string, GenericCallback> = Record<string, GenericCallback>>(value: unknown): value is HeraldEvents<Events>;
+/**
+ * Is the value a herald subscription?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is a herald subscription, otherwise `false`
+ */
+export declare function isHeraldSubscription(value: unknown): value is Subscription;
+//#endregion
 //#region src/internal/is.d.ts
 /**
  * Is the value an array or a plain object?
@@ -8446,4 +8510,4 @@ export declare class SizedSet<Value = unknown> extends Set<Value> {
   get(value: Value, update?: boolean): Value | undefined;
 }
 //#endregion
-export { type AsyncLimiter, type AsyncPlan, type Color, type ColorType, type ColorTypeExtended, type ColorValue, type ColorValueExtended, type HSLAColor, type HSLColor, type HWBAColor, type HWBColor, Key$1 as Key, type Limiter, Logger, type Plan, type RGBAColor, type RGBColor, type Shaken, type Smushed, type Subscription, type SubscriptionParameters, type SubscriptionProperty, type Subscriptions, type SubscriptionsParameters, type TimeLogger, type Unsmushed, push as append, filterAndMap as select, toPromise as fromResult, getRandomFloatingNumber as getRandomFloat, isLogger, isTimeLogger, mapAndFilter as reverseSelect };
+export { type AsyncLimiter, type AsyncPlan, type Color, type ColorType, type ColorTypeExtended, type ColorValue, type ColorValueExtended, type HSLAColor, type HSLColor, type HWBAColor, type HWBColor, type Herald, type HeraldEvents, Key$1 as Key, type Limiter, Logger, type Plan, type RGBAColor, type RGBColor, type Shaken, type Smushed, type Subscription, type SubscriptionParameters, type SubscriptionProperty, type Subscriptions, type SubscriptionsParameters, type TimeLogger, type Unsmushed, push as append, filterAndMap as select, toPromise as fromResult, getRandomFloatingNumber as getRandomFloat, isLogger, isTimeLogger, mapAndFilter as reverseSelect };