@dereekb/model 13.11.13 → 13.11.15

package/index.cjs.js

@@ -35,7 +35,7 @@ var makeError = require('make-error');
  * Returns the shared {@link EMPTY_ARKTYPE_TYPE} cast to the requested type, providing a typed empty-object schema
  * without creating a new ArkType instance each time.
  *
- * @returns the singleton empty type schema typed as `Type<T>`
+ * @returns The singleton empty type schema typed as `Type<T>`
  *
  * @example
  * ```typescript
@@ -123,8 +123,8 @@ function clearable(definition) {
 /**
  * Checks whether the given string is a valid {@link WebsiteLinkType}.
  *
- * @param input - the string to validate
- * @returns true if it matches the alphanumeric 1-32 character pattern
+ * @param input - Value to test against the website link type pattern.
+ * @returns True if it matches the alphanumeric 1-32 character pattern.
  *
  * @example
  * ```typescript
@@ -249,8 +249,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts a {@link WebsiteFileLink} to a {@link WebsiteLink} by encoding its fields into the data string.
  *
- * @param input - the file link to convert
- * @returns a WebsiteLink with type "f" and pipe-encoded data
+ * @param input - The file link to convert.
+ * @returns A WebsiteLink with type "f" and pipe-encoded data.
  *
  * @example
  * ```typescript
@@ -267,8 +267,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts a {@link WebsiteLink} back to a {@link WebsiteFileLink} by decoding the pipe-separated data string.
  *
- * @param input - a WebsiteLink whose data field contains an encoded file link
- * @returns the decoded file link with type, MIME, name, and data fields
+ * @param input - A WebsiteLink whose data field contains an encoded file link.
+ * @returns The decoded file link with type, MIME, name, and data fields.
  *
  * @example
  * ```typescript
@@ -288,8 +288,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Fields are encoded in order: type, MIME, data, name. Empty/undefined fields become empty strings.
  *
- * @param input - the file link to encode
- * @returns a pipe-separated encoded string
+ * @param input - The file link to encode.
+ * @returns A pipe-separated encoded string.
  *
  * @example
  * ```typescript
@@ -316,8 +316,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Empty fields in the encoded string are omitted from the result (falsy values are filtered out).
  *
- * @param input - the pipe-separated encoded string
- * @returns the decoded file link
+ * @param input - The pipe-separated encoded string.
+ * @returns The decoded file link.
  *
  * @example
  * ```typescript
@@ -358,9 +358,9 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Optionally prepends a prefix (e.g., "@" for TikTok, "$" for Cash App).
  *
- * @param input - a username or full profile URL
- * @param prefix - optional prefix to prepend to the extracted username
- * @returns the isolated username, optionally prefixed
+ * @param input - A username or full profile URL.
+ * @param prefix - Optional prefix to prepend to the extracted username.
+ * @returns The isolated username, optionally prefixed.
  *
  * @example
  * ```typescript
@@ -379,9 +379,9 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Used for platforms with non-standard URL patterns (e.g., Snapchat's `/add/{username}`, YouTube's `/c/{username}`).
  *
- * @param input - a username or full profile URL
- * @param isolateFn - custom function that extracts the relevant path segment from the URL
- * @returns the isolated username
+ * @param input - A username or full profile URL.
+ * @param isolateFn - Custom function that extracts the relevant path segment from the URL.
+ * @returns The isolated username.
  */ function usernameFromUsernameOrWebsiteWithOneOffBaseUrlUsername(input, isolateFn) {
     return util.toRelativeSlashPathStartType(isolateFn(usernameOrWebsiteUrlToWebsiteUrl(input)));
 }
@@ -390,8 +390,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * If the input has a website domain, it is returned as-is. Otherwise, it is treated as a path and converted to an absolute slash path.
  *
- * @param input - a username or website URL
- * @returns a normalized website URL
+ * @param input - A username or website URL.
+ * @returns A normalized website URL.
  */ function usernameOrWebsiteUrlToWebsiteUrl(input) {
     return util.hasWebsiteDomain(input) ? input : util.toAbsoluteSlashPathStartType(util.removeHttpFromUrl(input));
 }
@@ -402,8 +402,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts a generic website URL into a {@link WebsiteLink}, stripping the HTTP/HTTPS protocol.
  *
- * @param input - the full website URL
- * @returns a WebsiteLink with the protocol removed from the data
+ * @param input - The full website URL.
+ * @returns A WebsiteLink with the protocol removed from the data.
  *
  * @example
  * ```typescript
@@ -423,8 +423,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts an email address into a {@link WebsiteLink}.
  *
- * @param input - the email address
- * @returns a WebsiteLink storing the email as data
+ * @param input - The email address.
+ * @returns A WebsiteLink storing the email as data.
  */ function emailAddressToWebsiteLink(input) {
     return {
         t: EMAIL_URL_WEBSITE_LINK_TYPE,
@@ -438,8 +438,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts an E.164 phone number into a {@link WebsiteLink}.
  *
- * @param input - the phone number in E.164 format
- * @returns a WebsiteLink storing the phone number as data
+ * @param input - The phone number in E.164 format.
+ * @returns A WebsiteLink storing the phone number as data.
  */ function phoneNumberToWebsiteLink(input) {
     return {
         t: PHONE_URL_WEBSITE_LINK_TYPE,
@@ -458,8 +458,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Accepts either a raw username or a full Facebook profile URL.
  *
- * @param input - a Facebook profile ID or full profile URL
- * @returns a WebsiteLink with the isolated username as data
+ * @param input - A Facebook profile ID or full profile URL.
+ * @returns A WebsiteLink with the isolated username as data.
  *
  * @example
  * ```typescript
@@ -478,8 +478,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full Facebook profile URL from a profile ID.
  *
- * @param profileId - the Facebook profile ID or username
- * @returns the full profile URL
+ * @param profileId - The Facebook profile ID or username.
+ * @returns The full profile URL.
  */ function facebookProfileUrl(profileId) {
     return "".concat(FACEBOOK_BASE_URL, "/").concat(profileId);
 }
@@ -493,8 +493,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts an Instagram profile ID or URL into a {@link WebsiteLink}.
  *
- * @param input - an Instagram username or full profile URL
- * @returns a WebsiteLink with the isolated username as data
+ * @param input - An Instagram username or full profile URL.
+ * @returns A WebsiteLink with the isolated username as data.
  */ function instagramProfileUrlToWebsiteLink(input) {
     return {
         t: INSTAGRAM_WEBSITE_LINK_TYPE,
@@ -504,8 +504,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full Instagram profile URL from a profile ID.
  *
- * @param profileId - the Instagram username
- * @returns the full profile URL
+ * @param profileId - The Instagram username.
+ * @returns The full profile URL.
  */ function instagramProfileUrl(profileId) {
     return "".concat(INSTAGRAM_BASE_URL, "/").concat(profileId);
 }
@@ -519,8 +519,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts a Twitter profile ID or URL into a {@link WebsiteLink}.
  *
- * @param input - a Twitter username or full profile URL
- * @returns a WebsiteLink with the isolated username as data
+ * @param input - A Twitter username or full profile URL.
+ * @returns A WebsiteLink with the isolated username as data.
  */ function twitterProfileUrlToWebsiteLink(input) {
     return {
         t: TWITTER_WEBSITE_LINK_TYPE,
@@ -530,8 +530,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full Twitter profile URL from a profile ID.
  *
- * @param profileId - the Twitter username
- * @returns the full profile URL
+ * @param profileId - The Twitter username.
+ * @returns The full profile URL.
  */ function twitterProfileUrl(profileId) {
     return "".concat(TWITTER_BASE_URL, "/").concat(profileId);
 }
@@ -550,8 +550,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Automatically prepends the "@" prefix if not already present.
  *
- * @param input - a TikTok username (with or without "@") or full profile URL
- * @returns a WebsiteLink with the "@"-prefixed username as data
+ * @param input - A TikTok username (with or without "@") or full profile URL.
+ * @returns A WebsiteLink with the "@"-prefixed username as data.
  */ function tiktokProfileUrlToWebsiteLink(input) {
     return {
         t: TIKTOK_WEBSITE_LINK_TYPE,
@@ -561,8 +561,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full TikTok profile URL from a profile ID.
  *
- * @param profileId - the TikTok username (without "@" prefix)
- * @returns the full profile URL with "@" prefix
+ * @param profileId - The TikTok username (without "@" prefix)
+ * @returns The full profile URL with "@" prefix.
  */ function tiktokProfileUrl(profileId) {
     return "".concat(TIKTOK_BASE_URL, "/@").concat(profileId);
 }
@@ -586,8 +586,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Handles Snapchat's `/add/{username}` URL pattern.
  *
- * @param input - a Snapchat username or full profile URL
- * @returns a WebsiteLink with the isolated username as data
+ * @param input - A Snapchat username or full profile URL.
+ * @returns A WebsiteLink with the isolated username as data.
  */ function snapchatProfileUrlToWebsiteLink(input) {
     return {
         t: SNAPCHAT_WEBSITE_LINK_TYPE,
@@ -597,8 +597,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full Snapchat profile URL from a profile ID.
  *
- * @param profileId - the Snapchat username
- * @returns the full profile URL with `/add/` path
+ * @param profileId - The Snapchat username.
+ * @returns The full profile URL with `/add/` path.
  */ function snapchatProfileUrl(profileId) {
     return "".concat(SNAPCHAT_BASE_URL, "/add/").concat(profileId);
 }
@@ -622,8 +622,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Handles YouTube's `/c/{channel}` URL pattern.
  *
- * @param input - a YouTube channel name or full channel URL
- * @returns a WebsiteLink with the isolated channel name as data
+ * @param input - A YouTube channel name or full channel URL.
+ * @returns A WebsiteLink with the isolated channel name as data.
  */ function youtubeProfileUrlToWebsiteLink(input) {
     return {
         t: YOUTUBE_WEBSITE_LINK_TYPE,
@@ -633,8 +633,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full YouTube channel URL from a profile ID.
  *
- * @param profileId - the YouTube channel name
- * @returns the full channel URL with `/c/` path
+ * @param profileId - The YouTube channel name.
+ * @returns The full channel URL with `/c/` path.
  */ function youtubeProfileUrl(profileId) {
     return "".concat(YOUTUBE_BASE_URL, "/c/").concat(profileId);
 }
@@ -648,8 +648,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Converts a PayPal profile ID or URL into a {@link WebsiteLink}.
  *
- * @param input - a PayPal username or full PayPal.me URL
- * @returns a WebsiteLink with the isolated username as data
+ * @param input - A PayPal username or full PayPal.me URL.
+ * @returns A WebsiteLink with the isolated username as data.
  */ function paypalProfileUrlToWebsiteLink(input) {
     return {
         t: PAYPAL_WEBSITE_LINK_TYPE,
@@ -659,8 +659,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full PayPal.me profile URL from a profile ID.
  *
- * @param profileId - the PayPal username
- * @returns the full PayPal.me URL
+ * @param profileId - The PayPal username.
+ * @returns The full PayPal.me URL.
  */ function paypalProfileUrl(profileId) {
     return "".concat(PAYPAL_BASE_URL, "/").concat(profileId);
 }
@@ -679,8 +679,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Automatically prepends the "$" prefix if not already present.
  *
- * @param input - a Cash App username (with or without "$") or full profile URL
- * @returns a WebsiteLink with the "$"-prefixed username as data
+ * @param input - A Cash App username (with or without "$") or full profile URL.
+ * @returns A WebsiteLink with the "$"-prefixed username as data.
  */ function cashappProfileUrlToWebsiteLink(input) {
     return {
         t: CASHAPP_WEBSITE_LINK_TYPE,
@@ -690,8 +690,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full Cash App profile URL from a profile ID.
  *
- * @param profileId - the Cash App username (without "$" prefix)
- * @returns the full Cash App URL with "$" prefix
+ * @param profileId - The Cash App username (without "$" prefix)
+ * @returns The full Cash App URL with "$" prefix.
  */ function cashappProfileUrl(profileId) {
     return "".concat(CASHAPP_BASE_URL, "/$").concat(profileId);
 }
@@ -715,8 +715,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Handles Venmo's `/u/{username}` URL pattern.
  *
- * @param input - a Venmo username or full profile URL
- * @returns a WebsiteLink with the isolated username as data
+ * @param input - A Venmo username or full profile URL.
+ * @returns A WebsiteLink with the isolated username as data.
  */ function venmoProfileUrlToWebsiteLink(input) {
     return {
         t: VENMO_WEBSITE_LINK_TYPE,
@@ -726,8 +726,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full Venmo profile URL from a profile ID.
  *
- * @param profileId - the Venmo username
- * @returns the full profile URL with `/u/` path
+ * @param profileId - The Venmo username.
+ * @returns The full profile URL with `/u/` path.
  */ function venmoProfileUrl(profileId) {
     return "".concat(VENMO_BASE_URL, "/u/").concat(profileId);
 }
@@ -751,8 +751,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
  *
  * Handles Spotify's `/user/{username}` URL pattern.
  *
- * @param input - a Spotify username or full profile URL
- * @returns a WebsiteLink with the isolated username as data
+ * @param input - A Spotify username or full profile URL.
+ * @returns A WebsiteLink with the isolated username as data.
  */ function spotifyProfileUrlToWebsiteLink(input) {
     return {
         t: SPOTIFY_WEBSITE_LINK_TYPE,
@@ -762,8 +762,8 @@ function _unsupported_iterable_to_array$2(o, minLen) {
 /**
  * Constructs a full Spotify profile URL from a profile ID.
  *
- * @param profileId - the Spotify username
- * @returns the full profile URL with `/user/` path
+ * @param profileId - The Spotify username.
+ * @returns The full profile URL with `/user/` path.
  */ function spotifyProfileUrl(profileId) {
     return "".concat(SPOTIFY_BASE_URL, "/user/").concat(profileId);
 }
@@ -851,8 +851,8 @@ var GRANTED_ADMIN_ROLE_KEY = 'admin';
 /**
  * Checks whether the given role represents an admin-level permission (either "admin" or "owner").
  *
- * @param role - the role to check
- * @returns true if the role is an admin or owner role
+ * @param role - The role to check.
+ * @returns True if the role is an admin or owner role.
  *
  * @example
  * ```typescript
@@ -871,7 +871,7 @@ var NO_ACCESS_ROLE_KEY = '__EMPTY__';
 /**
  * Creates a {@link GrantedRoleMap} that explicitly denies all access.
  *
- * @returns a role map with only the no-access marker set
+ * @returns A role map with only the no-access marker set.
  *
  * @example
  * ```typescript
@@ -884,15 +884,15 @@ var NO_ACCESS_ROLE_KEY = '__EMPTY__';
 /**
  * Type guard that checks whether a role map is a no-access map.
  *
- * @param input - the role map to check
- * @returns true if the map has the no-access marker
+ * @param input - The role map to check.
+ * @returns True if the map has the no-access marker.
  */ function isNoAccessRoleMap(input) {
     return input[NO_ACCESS_ROLE_KEY] === true;
 }
 /**
  * Creates a {@link GrantedRoleMap} that grants full access to all roles.
  *
- * @returns a role map with the full-access marker set
+ * @returns A role map with the full-access marker set.
  *
  * @example
  * ```typescript
@@ -905,8 +905,8 @@ var NO_ACCESS_ROLE_KEY = '__EMPTY__';
 /**
  * Type guard that checks whether a role map is a full-access map.
  *
- * @param input - the role map to check
- * @returns true if the map has the full-access marker
+ * @param input - The role map to check.
+ * @returns True if the map has the full-access marker.
  */ function isFullAccessRoleMap(input) {
     return input[FULL_ACCESS_ROLE_KEY] === true;
 }
@@ -916,8 +916,8 @@ var NO_ACCESS_ROLE_KEY = '__EMPTY__';
  * The reader handles full-access and no-access maps as special cases, and provides methods
  * for checking individual roles or sets of roles.
  *
- * @param map - the granted role map to read from
- * @returns a reader instance for querying the map
+ * @param map - The granted role map to read from.
+ * @returns A reader instance for querying the map.
  *
  * @example
  * ```typescript
@@ -1046,9 +1046,9 @@ var GrantedRoleMapReaderInstance = /*#__PURE__*/ function() {
 /**
  * Converts an array of role strings into a {@link GrantedRoleKeysMap} where each role is mapped to the given boolean value.
  *
- * @param roles - the role strings to include
- * @param value - the boolean value to assign to each role (defaults to true)
- * @returns a map of roles to boolean values
+ * @param roles - Role keys to include in the resulting map.
+ * @param value - Truthiness to assign to every role entry (defaults to true).
+ * @returns Map keyed by role with the supplied truthiness for each entry.
  *
  * @example
  * ```typescript
@@ -1067,9 +1067,9 @@ var GrantedRoleMapReaderInstance = /*#__PURE__*/ function() {
 /**
  * Creates a {@link ContextGrantedModelRoles} with a no-access role map, indicating the context has no permissions.
  *
- * @param context - the context that was evaluated
- * @param data - optional model data, if it was loaded
- * @returns a ContextGrantedModelRoles with no access
+ * @param context - The context that was evaluated.
+ * @param data - Optional model data, if it was loaded.
+ * @returns A ContextGrantedModelRoles with no access.
  *
  * @example
  * ```typescript
@@ -1082,9 +1082,9 @@ var GrantedRoleMapReaderInstance = /*#__PURE__*/ function() {
 /**
  * Creates a {@link ContextGrantedModelRoles} with a full-access role map, granting all permissions.
  *
- * @param context - the context that was evaluated
- * @param data - optional model data
- * @returns a ContextGrantedModelRoles with full access
+ * @param context - The context that was evaluated.
+ * @param data - Optional model data.
+ * @returns A ContextGrantedModelRoles with full access.
  *
  * @example
  * ```typescript
@@ -1097,10 +1097,10 @@ var GrantedRoleMapReaderInstance = /*#__PURE__*/ function() {
 /**
  * Creates a {@link ContextGrantedModelRoles} with the given role map, data, and context.
  *
- * @param context - the context that was evaluated
- * @param data - the model data, if loaded
- * @param roles - the granted role map
- * @returns a ContextGrantedModelRoles combining all inputs
+ * @param context - The context that was evaluated.
+ * @param data - The model data, if loaded.
+ * @param roles - The granted role map.
+ * @returns A ContextGrantedModelRoles combining all inputs.
  */ function contextGrantedModelRoles(context, data, roles) {
     return {
         data: data,
@@ -1405,8 +1405,8 @@ function _ts_generator$3(thisArg, body) {
  * If the input is a string, it is treated as a commonId and paired with the given commonType.
  * If the input is already a pair, it is returned as-is.
  *
- * @param commonType - the default common type to use when input is a plain string
- * @returns a factory function that produces SyncEntityCommonTypeIdPair instances
+ * @param commonType - The default common type to use when input is a plain string.
+ * @returns A factory function that produces SyncEntityCommonTypeIdPair instances.
  *
  * @example
  * ```typescript
@@ -1414,6 +1414,7 @@ function _ts_generator$3(thisArg, body) {
  * factory('abc123');  // { commonType: 'user', commonId: 'abc123' }
  * factory({ commonType: 'user', commonId: 'abc123' });  // passed through as-is
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */ function syncEntityCommonTypeIdPairFactory(commonType) {
     return function(input) {
@@ -1435,8 +1436,8 @@ function _ts_generator$3(thisArg, body) {
  * The factory attaches the configured source info and optionally transforms the commonId into an entity id
  * using the provided idFactory (defaults to identity).
  *
- * @param config - source info and optional id factory
- * @returns a factory that creates SyncEntity instances
+ * @param config - Source info and optional id factory.
+ * @returns A factory that creates SyncEntity instances.
  *
  * @example
  * ```typescript
@@ -1447,6 +1448,7 @@ function _ts_generator$3(thisArg, body) {
  * const entity = factory({ commonType: 'user', commonId: 'abc123' });
  * // entity.id === 'abc123', entity.sourceInfo.id === 'api'
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */ function syncEntityFactory(config) {
     var inputIdFactory = config.idFactory, sourceInfo = config.sourceInfo;
@@ -1604,9 +1606,9 @@ function _is_native_reflect_construct() {
  * Registers common type synchronizers and provides lookup by common type. Throws
  * {@link UnregisteredSyncEntityCommonTypeError} if an unregistered common type is requested.
  *
- * @param config - contains the list of common type synchronizers to register
- * @returns a synchronizer that delegates to the appropriate common type synchronizer
- * @throws {UnregisteredSyncEntityCommonTypeError} when requesting an unregistered common type
+ * @param config - Contains the list of common type synchronizers to register.
+ * @returns A synchronizer that delegates to the appropriate common type synchronizer.
+ * @throws {UnregisteredSyncEntityCommonTypeError} When requesting an unregistered common type.
  *
  * @example
  * ```typescript
@@ -1884,11 +1886,12 @@ function _ts_generator$2(thisArg, body) {
  * 2. Secondary sources are synchronized sequentially; if a secondary reports deletion while primary did not, the sync restarts once.
  * 3. Replica sources are synchronized concurrently (up to 3 in parallel).
  *
- * @param config - common type, sources, and context loader
- * @returns a synchronizer for the configured common type
- * @throws {NoPrimarySyncSourceError} when no primary source is found
- * @throws {MultiplePrimarySyncSourceError} when more than one primary source is found
- * @throws {SynchronizationFailedError} when primary or secondary sync returns failed/error
+ * @param config - Common type, sources, and context loader.
+ * @returns A synchronizer for the configured common type.
+ * @throws {NoPrimarySyncSourceError} When no primary source is found.
+ * @throws {MultiplePrimarySyncSourceError} When more than one primary source is found.
+ * @throws {SynchronizationFailedError} When primary or secondary sync returns failed/error.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function basicSyncEntityCommonTypeSynchronizerInstanceFactory(config) {
     var _sourcesByContextType_get, _sourcesByContextType_get1;
@@ -1902,8 +1905,8 @@ function _ts_generator$2(thisArg, body) {
     /**
      * Loads the relevant sources for the given entity and context.
      *
-     * @param entityCommonTypeIdPair The common type/id pair identifying the entity.
-     * @param entitySourceContext The contextual information for the entity.
+     * @param entityCommonTypeIdPair - The common type/id pair identifying the entity.
+     * @param entitySourceContext - The contextual information for the entity.
      * @returns The relevant sources for the entity.
      */ function loadSources(entityCommonTypeIdPair, entitySourceContext) {
         var globalSources = entitySourceContext.globalSources, contextSources = entitySourceContext.contextSources;
@@ -2017,7 +2020,7 @@ function _ts_generator$2(thisArg, body) {
                 /**
          * Performs the synchronization for this entity instance.
          *
-         * @param context Optional synchronization context with additional configuration.
+         * @param context - Optional synchronization context with additional configuration.
          * @returns The result of the synchronization operation.
          */ synchronize = function synchronize(context) {
                     return _async_to_generator$2(function() {
@@ -2441,8 +2444,8 @@ function _ts_generator$1(thisArg, body) {
  *
  * On validation success, calls the configured handler function. On validation failure, delegates to the error handler.
  *
- * @param config - schema, handler function, and validation error handler
- * @returns a function that validates and processes input objects
+ * @param config - Schema, handler function, and validation error handler.
+ * @returns Wrapped function that runs validation then either invokes the handler or routes failures to the error handler.
  *
  * @example
  * ```typescript
@@ -2459,7 +2462,7 @@ function _ts_generator$1(thisArg, body) {
     var handleValidationError = config.handleValidationError;
     return function(input, context) {
         return _async_to_generator$1(function() {
-            var x, result;
+            var x, output, result;
             return _ts_generator$1(this, function(_state) {
                 switch(_state.label){
                     case 0:
@@ -2469,27 +2472,34 @@ function _ts_generator$1(thisArg, body) {
                         ];
                     case 1:
                         x = _state.sent();
-                        if (x.success) {
-                            return [
-                                2,
-                                {
-                                    object: x.object,
-                                    result: x.result
-                                }
-                            ];
-                        }
+                        if (!x.success) return [
+                            3,
+                            2
+                        ];
+                        output = {
+                            object: x.object,
+                            result: x.result
+                        };
+                        return [
+                            3,
+                            4
+                        ];
+                    case 2:
                         return [
                             4,
                             handleValidationError(x.validationErrors)
                         ];
-                    case 2:
+                    case 3:
                         result = _state.sent();
+                        output = {
+                            object: undefined,
+                            result: result
+                        };
+                        _state.label = 4;
+                    case 4:
                         return [
                             2,
-                            {
-                                object: undefined,
-                                result: result
-                            }
+                            output
                         ];
                 }
             });
@@ -2502,8 +2512,9 @@ function _ts_generator$1(thisArg, body) {
  * The factory pre-configures error handling so individual function calls
  * only need to specify the schema and handler.
  *
- * @param defaults - default error handler
- * @returns a factory function that creates TransformAndValidateObjectFunction instances
+ * @param defaults - Default error handler.
+ * @returns A factory function that creates TransformAndValidateObjectFunction instances.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function transformAndValidateObjectFactory(defaults) {
     var defaultHandleValidationError = defaults.handleValidationError;
@@ -2522,8 +2533,8 @@ function _ts_generator$1(thisArg, body) {
  * Returns `{ success: true, object, result }` on valid input, or `{ success: false, validationErrors }` on failure.
  * The caller is responsible for handling the error case.
  *
- * @param config - schema and handler function
- * @returns a function that returns a success/error discriminated result
+ * @param config - Schema and handler function.
+ * @returns Wrapped function that yields a discriminated result so the caller can branch on success or validation failure.
  *
  * @example
  * ```typescript
@@ -2543,34 +2554,41 @@ function _ts_generator$1(thisArg, body) {
     var schema = config.schema, fn = config.fn;
     return function(input) {
         return _async_to_generator$1(function() {
-            var out, object, result;
+            var out, output, object, result;
             return _ts_generator$1(this, function(_state) {
                 switch(_state.label){
                     case 0:
                         out = schema(input);
-                        if (_instanceof(out, arktype.type.errors)) {
-                            return [
-                                2,
-                                {
-                                    validationErrors: out,
-                                    success: false
-                                }
-                            ];
-                        }
+                        if (!_instanceof(out, arktype.type.errors)) return [
+                            3,
+                            1
+                        ];
+                        output = {
+                            validationErrors: out,
+                            success: false
+                        };
+                        return [
+                            3,
+                            3
+                        ];
+                    case 1:
                         object = out;
                         return [
                             4,
                             fn(object)
                         ];
-                    case 1:
+                    case 2:
                         result = _state.sent();
+                        output = {
+                            object: object,
+                            result: result,
+                            success: true
+                        };
+                        _state.label = 3;
+                    case 3:
                         return [
                             2,
-                            {
-                                object: object,
-                                result: result,
-                                success: true
-                            }
+                            output
                         ];
                 }
             });
@@ -2581,8 +2599,9 @@ function _ts_generator$1(thisArg, body) {
 /**
  * Creates a factory for transform-and-validate functions that return the result with the parsed object attached as `params`.
  *
- * @param defaults - shared error handler defaults
- * @returns a factory that produces functions returning {@link TransformAndValidateFunctionResult}
+ * @param defaults - Shared error handler defaults.
+ * @returns A factory that produces functions returning {@link TransformAndValidateFunctionResult}
+ *
  * @__NO_SIDE_EFFECTS__
  */ function transformAndValidateFunctionResultFactory(defaults) {
     return toTransformAndValidateFunctionResultFactory(transformAndValidateObjectFactory(defaults));
@@ -2591,8 +2610,9 @@ function _ts_generator$1(thisArg, body) {
  * Wraps an existing {@link TransformAndValidateObjectFactory} to produce functions that attach the parsed object
  * as `params` on the result.
  *
- * @param transformAndValidateObjectFactory - the base factory to wrap
- * @returns a factory that produces functions returning results with `params` attached
+ * @param transformAndValidateObjectFactory - The base factory to wrap.
+ * @returns A factory that produces functions returning results with `params` attached.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function toTransformAndValidateFunctionResultFactory(transformAndValidateObjectFactory) {
     return function(schema, fn, handleValidationError) {
@@ -2744,8 +2764,9 @@ function _ts_generator(thisArg, body) {
  *
  * Useful when you only need the processed output and don't need access to the validated input.
  *
- * @param defaults - shared error handler defaults
- * @returns a factory that produces functions returning only the handler's result
+ * @param defaults - Shared error handler defaults.
+ * @returns A factory that produces functions returning only the handler's result.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function transformAndValidateResultFactory(defaults) {
     var factory = transformAndValidateObjectFactory(defaults);
@@ -2819,8 +2840,8 @@ function _ts_generator(thisArg, body) {
 /**
  * Creates an ArkType schema that validates an array has no duplicate keys.
  *
- * @param readKey - function that extracts the key from each array element
- * @returns an ArkType schema that narrows `T[]` to ensure uniqueness
+ * @param readKey - Function that extracts the key from each array element.
+ * @returns An ArkType schema that narrows `T[]` to ensure uniqueness.
  *
  * @example
  * ```typescript