@oscarpalmer/atoms 0.211.0 → 0.212.0

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 = {

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

@@ -6795,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>;
   /**
@@ -6833,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
 /**
@@ -7539,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?
@@ -8508,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 };

package/dist/index.mjs

@@ -4847,10 +4847,20 @@ const beaconSubscription = {
 	value: SUBSCRIPTION_NAME
 };
 //#endregion
-//#region src/internal/herald.ts
+//#region src/internal/models/herald.model.ts
+const HERALD_MESSAGE_ARRAY = "Herald requires an array of event names.";
+const HERALD_MESSAGE_ONCREATE = `Herald requires a valid onCreate callback for subscription creation`;
+const HERALD_MESSAGE_PROPERTY = `Herald requires valid property information for subscription identification`;
 const HERALD_NAME_EVENTS = "events";
 const HERALD_NAME_HERALD = "herald";
 const HERALD_PROPERTY = "$herald";
+const HERALD_SYMBOL = Symbol(HERALD_PROPERTY);
+const heraldSubscription = {
+	key: HERALD_PROPERTY,
+	value: SUBSCRIPTION_NAME
+};
+//#endregion
+//#region src/internal/herald.ts
 function Events(herald, state) {
 	for (const key of state.keys) Object.defineProperty(this, key, { value: (callback, signal) => herald.subscribe(key, callback, signal) });
 }
@@ -4937,7 +4947,7 @@ function isHeraldEvents(value) {
 	return isHeraldInstance(HERALD_NAME_EVENTS, value);
 }
 function isHeraldInstance(name, value) {
-	return typeof value === "object" && value !== null && HERALD_PROPERTY in value && value[HERALD_PROPERTY] === name;
+	return typeof value === "object" && value !== null && "$herald" in value && value["$herald"] === name;
 }
 /**
 * Is the value a herald subscription?
@@ -4946,7 +4956,7 @@ function isHeraldInstance(name, value) {
 * @returns `true` if the value is a herald subscription, otherwise `false`
 */
 function isHeraldSubscription(value) {
-	return isSubscription(value) && HERALD_PROPERTY in value && value[HERALD_PROPERTY] === "subscription";
+	return isSubscription(value) && "$herald" in value && value["$herald"] === "subscription";
 }
 function subscribeToHerald(key, callback, signal) {
 	const { state } = this[HERALD_SYMBOL];
@@ -4958,14 +4968,6 @@ function subscribeToHerald(key, callback, signal) {
 	if (!existing) state.onCreate?.(key, callback, subscription);
 	return subscription;
 }
-const HERALD_MESSAGE_ARRAY = "Herald requires an array of event names.";
-const HERALD_MESSAGE_ONCREATE = `Herald requires a valid onCreate callback for subscription creation`;
-const HERALD_MESSAGE_PROPERTY = `Herald requires valid property information for subscription identification`;
-const HERALD_SYMBOL = Symbol(HERALD_PROPERTY);
-const heraldSubscription = {
-	key: HERALD_PROPERTY,
-	value: SUBSCRIPTION_NAME
-};
 //#endregion
 //#region src/color/constants.ts
 const COLOR_ALPHA = {

package/dist/internal/herald.d.mts

@@ -1,43 +1,7 @@
 import { GenericCallback } from "../models.mjs";
-import { Subscription, SubscriptionProperty } from "./subscription.mjs";
+import { Subscription } from "./subscription.mjs";
+import { Herald, HeraldEvents, HeraldOptions } from "./models/herald.model.mjs";
 //#region src/internal/herald.d.ts
-export type Herald<Events extends Record<string, GenericCallback>> = {
-  readonly events: HeraldEvents<Events>;
-  /**
-   * Remove all event subscribers
-   */
-  clear(): void;
-  /**
-   * Emit an event with parameters
-   *
-   * @param event Event name
-   * @param parameters Event parameters
-   */
-  emit<Event extends keyof Events>(event: Event, ...parameters: Parameters<Events[Event]>): void;
-  /**
-   * Is the event observed by any subscribers?
-   *
-   * @param event Event name
-   * @returns `true` if the event is observed, otherwise `false`
-   */
-  observed<Event extends keyof Events>(event: Event): boolean;
-  /**
-   * Subscribe to an event with a callback
-   *
-   * @param event Event name
-   * @param callback Callback function
-   * @param signal Optional abort signal to cancel the subscription
-   * @returns Subscription instance
-   */
-  subscribe<Event extends keyof Events>(event: Event, callback: Events[Event], signal?: AbortSignal): Subscription;
-};
-export type HeraldEvents<Events extends Record<string, GenericCallback>> = { [Key in keyof Events]: Key extends "*" ? never : (callback: Events[Key], signal?: AbortSignal) => void; };
-type HeraldOnCreate<Events extends Record<string, GenericCallback>> = <Event extends keyof Events>(event: Event, callback: Events[Event], subscription: Subscription) => void;
-export type HeraldOptions<Events extends Record<string, GenericCallback>> = {
-  names: Array<keyof Events>;
-  property?: SubscriptionProperty;
-  onCreate?: HeraldOnCreate<Events>;
-};
 /**
  * Create a _Herald_ for announcing named events
  *

package/dist/internal/herald.mjs

@@ -1,9 +1,7 @@
 import { isPlainObject } from "./is.mjs";
-import { SUBSCRIPTION_NAME, isSubscription, subscriptions } from "./subscription.mjs";
+import { isSubscription, subscriptions } from "./subscription.mjs";
+import { HERALD_MESSAGE_ARRAY, HERALD_MESSAGE_ONCREATE, HERALD_MESSAGE_PROPERTY, HERALD_NAME_EVENTS, HERALD_NAME_HERALD, HERALD_PROPERTY, HERALD_SYMBOL, heraldSubscription } from "./models/herald.model.mjs";
 //#region src/internal/herald.ts
-const HERALD_NAME_EVENTS = "events";
-const HERALD_NAME_HERALD = "herald";
-const HERALD_PROPERTY = "$herald";
 function Events(herald, state) {
 	for (const key of state.keys) Object.defineProperty(this, key, { value: (callback, signal) => herald.subscribe(key, callback, signal) });
 }
@@ -91,7 +89,7 @@ function isHeraldEvents(value) {
 	return isHeraldInstance(HERALD_NAME_EVENTS, value);
 }
 function isHeraldInstance(name, value) {
-	return typeof value === "object" && value !== null && HERALD_PROPERTY in value && value[HERALD_PROPERTY] === name;
+	return typeof value === "object" && value !== null && "$herald" in value && value["$herald"] === name;
 }
 /**
 * Is the value a herald subscription?
@@ -100,7 +98,7 @@ function isHeraldInstance(name, value) {
 * @returns `true` if the value is a herald subscription, otherwise `false`
 */
 function isHeraldSubscription(value) {
-	return isSubscription(value) && HERALD_PROPERTY in value && value[HERALD_PROPERTY] === "subscription";
+	return isSubscription(value) && "$herald" in value && value["$herald"] === "subscription";
 }
 function subscribeToHerald(key, callback, signal) {
 	const { state } = this[HERALD_SYMBOL];
@@ -112,13 +110,5 @@ function subscribeToHerald(key, callback, signal) {
 	if (!existing) state.onCreate?.(key, callback, subscription);
 	return subscription;
 }
-const HERALD_MESSAGE_ARRAY = "Herald requires an array of event names.";
-const HERALD_MESSAGE_ONCREATE = `Herald requires a valid onCreate callback for subscription creation`;
-const HERALD_MESSAGE_PROPERTY = `Herald requires valid property information for subscription identification`;
-const HERALD_SYMBOL = Symbol(HERALD_PROPERTY);
-const heraldSubscription = {
-	key: HERALD_PROPERTY,
-	value: SUBSCRIPTION_NAME
-};
 //#endregion
 export { herald, isHerald, isHeraldEvents, isHeraldSubscription };

package/dist/internal/models/herald.model.d.mts

@@ -0,0 +1,60 @@
+import { GenericCallback } from "../../models.mjs";
+import { Subscription, SubscriptionProperty, Subscriptions } from "../subscription.mjs";
+//#region src/internal/models/herald.model.d.ts
+export type Herald<Events extends Record<string, GenericCallback>> = {
+  readonly events: HeraldEvents<Events>;
+  /**
+   * Remove all event subscribers
+   */
+  clear(): void;
+  /**
+   * Emit an event with parameters
+   *
+   * @param event Event name
+   * @param parameters Event parameters
+   */
+  emit<Event extends keyof Events>(event: Event, ...parameters: Parameters<Events[Event]>): void;
+  /**
+   * Is the event observed by any subscribers?
+   *
+   * @param event Event name
+   * @returns `true` if the event is observed, otherwise `false`
+   */
+  observed<Event extends keyof Events>(event: Event): boolean;
+  /**
+   * Subscribe to an event with a callback
+   *
+   * @param event Event name
+   * @param callback Callback function
+   * @param signal Optional abort signal to cancel the subscription
+   * @returns Subscription instance
+   */
+  subscribe<Event extends keyof Events>(event: Event, callback: Events[Event], signal?: AbortSignal): Subscription;
+};
+export type HeraldEvents<Events extends Record<string, GenericCallback>> = { [Key in keyof Events]: Key extends "*" ? never : (callback: Events[Key], signal?: AbortSignal) => void; };
+export type HeraldOnCreate<Events extends Record<string, GenericCallback>> = <Event extends keyof Events>(event: Event, callback: Events[Event], subscription: Subscription) => void;
+export type HeraldOptions<Events extends Record<string, GenericCallback>> = {
+  names: Array<keyof Events>;
+  property?: SubscriptionProperty;
+  onCreate?: HeraldOnCreate<Events>;
+};
+export type HeraldState = {
+  keys: Set<string>;
+  store: Subscriptions<GenericCallback>;
+  onCreate?: HeraldOnCreate<Record<string, GenericCallback>>;
+};
+export type InternalHerald = {
+  [HERALD_SYMBOL]: {
+    events: HeraldEvents<Record<string, GenericCallback>>;
+    state: HeraldState;
+  };
+} & Herald<Record<string, GenericCallback>>;
+export declare const HERALD_MESSAGE_ARRAY = "Herald requires an array of event names.";
+export declare const HERALD_MESSAGE_ONCREATE = "Herald requires a valid onCreate callback for subscription creation";
+export declare const HERALD_MESSAGE_PROPERTY = "Herald requires valid property information for subscription identification";
+export declare const HERALD_NAME_EVENTS = "events";
+export declare const HERALD_NAME_HERALD = "herald";
+export declare const HERALD_PROPERTY = "$herald";
+export declare const HERALD_SYMBOL: unique symbol;
+export declare const heraldSubscription: SubscriptionProperty;
+//#endregion

package/dist/internal/models/herald.model.mjs

@@ -0,0 +1,15 @@
+import { SUBSCRIPTION_NAME } from "../subscription.mjs";
+//#region src/internal/models/herald.model.ts
+const HERALD_MESSAGE_ARRAY = "Herald requires an array of event names.";
+const HERALD_MESSAGE_ONCREATE = `Herald requires a valid onCreate callback for subscription creation`;
+const HERALD_MESSAGE_PROPERTY = `Herald requires valid property information for subscription identification`;
+const HERALD_NAME_EVENTS = "events";
+const HERALD_NAME_HERALD = "herald";
+const HERALD_PROPERTY = "$herald";
+const HERALD_SYMBOL = Symbol(HERALD_PROPERTY);
+const heraldSubscription = {
+	key: HERALD_PROPERTY,
+	value: SUBSCRIPTION_NAME
+};
+//#endregion
+export { HERALD_MESSAGE_ARRAY, HERALD_MESSAGE_ONCREATE, HERALD_MESSAGE_PROPERTY, HERALD_NAME_EVENTS, HERALD_NAME_HERALD, HERALD_PROPERTY, HERALD_SYMBOL, heraldSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.211.0",
+	"version": "0.212.0",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"array",