@dereekb/model 13.11.14 → 13.11.16

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dereekb/model",
-  "version": "13.11.14",
+  "version": "13.11.16",
   "sideEffects": false,
   "peerDependencies": {
-    "@dereekb/util": "13.11.14",
+    "@dereekb/util": "13.11.16",
     "arktype": "^2.2.0",
     "make-error": "^1.3.6"
   },

package/src/lib/data/website/link.d.ts

@@ -18,8 +18,8 @@ export declare const WEBSITE_LINK_TYPE_REGEX: RegExp;
 /**
  * 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

package/src/lib/data/website/link.file.d.ts

@@ -100,8 +100,8 @@ export declare const WEBSITE_FILE_LINK_WEBSITE_LINK_TYPE = "f";
 /**
  * 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
@@ -114,8 +114,8 @@ export declare function websiteFileLinkToWebsiteLink(input: WebsiteFileLink): We
 /**
  * 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
@@ -134,8 +134,8 @@ export declare const WEBSITE_FILE_LINK_ENCODE_SEPARATOR = "|";
  *
  * 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
@@ -154,8 +154,8 @@ export declare function encodeWebsiteFileLinkToWebsiteLinkEncodedData(input: Web
  *
  * 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

package/src/lib/data/website/link.website.d.ts

@@ -18,9 +18,9 @@ export declare const WEBSITE_LINK_ISOLATE_BASE_URL_PROFILE_ID: IsolateWebsitePat
  *
  * 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
@@ -37,9 +37,9 @@ export declare function usernameFromUsernameOrWebsiteWithBaseUrlUsername(input:
  *
  * 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.
  */
 export declare function usernameFromUsernameOrWebsiteWithOneOffBaseUrlUsername(input: ModelKey | WebsiteUrl, isolateFn: IsolateWebsitePathFunction): string;
 /**
@@ -47,8 +47,8 @@ export declare function usernameFromUsernameOrWebsiteWithOneOffBaseUrlUsername(i
  *
  * 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.
  */
 export declare function usernameOrWebsiteUrlToWebsiteUrl(input: string): WebsiteUrl;
 /**
@@ -58,8 +58,8 @@ export declare const WEBSITE_URL_WEBSITE_LINK_TYPE = "w";
 /**
  * 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
@@ -75,8 +75,8 @@ export declare const EMAIL_URL_WEBSITE_LINK_TYPE = "e";
 /**
  * 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.
  */
 export declare function emailAddressToWebsiteLink(input: EmailAddress): WebsiteLink;
 /**
@@ -86,8 +86,8 @@ export declare const PHONE_URL_WEBSITE_LINK_TYPE = "p";
 /**
  * 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.
  */
 export declare function phoneNumberToWebsiteLink(input: E164PhoneNumber): WebsiteLink;
 /**
@@ -115,8 +115,8 @@ export type FacebookWebsiteLinkType = typeof FACEBOOK_WEBSITE_LINK_TYPE;
  *
  * 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
@@ -131,8 +131,8 @@ export declare function facebookProfileUrlToWebsiteLink(input: FacebookProfileId
 /**
  * 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.
  */
 export declare function facebookProfileUrl<P extends FacebookProfileId>(profileId: P): FacebookProfileUrl<P>;
 /**
@@ -158,15 +158,15 @@ export type InstagramWebsiteLinkType = typeof INSTAGRAM_WEBSITE_LINK_TYPE;
 /**
  * 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.
  */
 export declare function instagramProfileUrlToWebsiteLink(input: InstagramProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function instagramProfileUrl<P extends InstagramProfileId>(profileId: P): InstagramProfileUrl<P>;
 /**
@@ -192,15 +192,15 @@ export type TwitterWebsiteLinkType = typeof TWITTER_WEBSITE_LINK_TYPE;
 /**
  * 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.
  */
 export declare function twitterProfileUrlToWebsiteLink(input: TwitterProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function twitterProfileUrl<P extends TwitterProfileId>(profileId: P): TwitterProfileUrl<P>;
 /**
@@ -232,15 +232,15 @@ export type TikTokWebsiteLinkType = typeof TIKTOK_WEBSITE_LINK_TYPE;
  *
  * 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.
  */
 export declare function tiktokProfileUrlToWebsiteLink(input: TikTokProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function tiktokProfileUrl<P extends TikTokProfileId>(profileId: P): TikTokProfileUrl<P>;
 /**
@@ -272,15 +272,15 @@ export declare const SNAPCHAT_WEBSITE_LINK_ISOLATE_PROFILE_ID: IsolateWebsitePat
  *
  * 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.
  */
 export declare function snapchatProfileUrlToWebsiteLink(input: SnapchatProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function snapchatProfileUrl<P extends SnapchatProfileId>(profileId: P): SnapchatProfileUrl<P>;
 /**
@@ -312,15 +312,15 @@ export declare const YOUTUBE_WEBSITE_LINK_ISOLATE_PROFILE_ID: IsolateWebsitePath
  *
  * 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.
  */
 export declare function youtubeProfileUrlToWebsiteLink(input: YouTubeProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function youtubeProfileUrl<P extends YouTubeProfileId>(profileId: P): YouTubeProfileUrl<P>;
 /**
@@ -346,15 +346,15 @@ export type PayPalWebsiteLinkType = typeof PAYPAL_WEBSITE_LINK_TYPE;
 /**
  * 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.
  */
 export declare function paypalProfileUrlToWebsiteLink(input: PayPalProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function paypalProfileUrl<P extends PayPalProfileId>(profileId: P): PayPalProfileUrl<P>;
 /**
@@ -386,15 +386,15 @@ export type CashappWebsiteLinkType = typeof CASHAPP_WEBSITE_LINK_TYPE;
  *
  * 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.
  */
 export declare function cashappProfileUrlToWebsiteLink(input: CashappProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function cashappProfileUrl<P extends CashappProfileId>(profileId: P): CashappProfileUrl<P>;
 /**
@@ -426,15 +426,15 @@ export declare const VENMO_WEBSITE_LINK_ISOLATE_PROFILE_ID: IsolateWebsitePathFu
  *
  * 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.
  */
 export declare function venmoProfileUrlToWebsiteLink(input: VenmoProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function venmoProfileUrl<P extends VenmoProfileId>(profileId: P): VenmoProfileUrl<P>;
 /**
@@ -466,14 +466,14 @@ export declare const SPOTIFY_WEBSITE_LINK_ISOLATE_PROFILE_ID: IsolateWebsitePath
  *
  * 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.
  */
 export declare function spotifyProfileUrlToWebsiteLink(input: SpotifyProfileId | WebsiteUrl): WebsiteLink;
 /**
  * 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.
  */
 export declare function spotifyProfileUrl<P extends SpotifyProfileId>(profileId: P): SpotifyProfileUrl<P>;

package/src/lib/service/permission/permission.d.ts

@@ -13,9 +13,9 @@ export interface ContextGrantedModelRoles<O, C = unknown, R extends string = str
 /**
  * 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
@@ -27,9 +27,9 @@ export declare function noAccessContextGrantedModelRoles<O, C = unknown, R exten
 /**
  * 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
@@ -41,9 +41,9 @@ export declare function fullAccessGrantedModelRoles<O, C = unknown, R extends st
 /**
  * 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.
  */
 export declare function contextGrantedModelRoles<O, C = unknown, R extends string = string>(context: C, data: Maybe<O>, roles: GrantedRoleMap<R>): ContextGrantedModelRoles<O, C, R>;

package/src/lib/service/permission/role.d.ts

@@ -26,8 +26,8 @@ export declare const 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
@@ -66,7 +66,7 @@ export type NoAccessRoleMap = {
 /**
  * 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
@@ -78,8 +78,8 @@ export declare function noAccessRoleMap<R extends string = string>(): GrantedRol
 /**
  * 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.
  */
 export declare function isNoAccessRoleMap<R extends string = string>(input: GrantedRoleMap<R> | NoAccessRoleMap): input is NoAccessRoleMap;
 export type FullAccessRoleMap = {
@@ -88,7 +88,7 @@ export type FullAccessRoleMap = {
 /**
  * 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
@@ -100,8 +100,8 @@ export declare function fullAccessRoleMap<R extends string = string>(): GrantedR
 /**
  * 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.
  */
 export declare function isFullAccessRoleMap<R extends string = string>(input: GrantedRoleMap<R> | FullAccessRoleMap): input is FullAccessRoleMap;
 export type GrantedRoleMap<R extends GrantedRole = string> = NoAccessRoleMap | FullAccessRoleMap | GrantedRoleKeysMap<R>;
@@ -153,8 +153,8 @@ export interface GrantedRoleMapReader<R extends GrantedRole = GrantedRole> {
  * 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
@@ -182,9 +182,9 @@ export declare class GrantedRoleMapReaderInstance<R extends GrantedRole = string
 /**
  * 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

package/src/lib/service/sync/sync.entity.d.ts

@@ -44,8 +44,8 @@ export type SyncEntityCommonTypeIdPairFactory = (input: SyncEntityCommonTypeIdPa
  * 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
@@ -53,6 +53,7 @@ export type SyncEntityCommonTypeIdPairFactory = (input: SyncEntityCommonTypeIdPa
  * factory('abc123');  // { commonType: 'user', commonId: 'abc123' }
  * factory({ commonType: 'user', commonId: 'abc123' });  // passed through as-is
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function syncEntityCommonTypeIdPairFactory(commonType: SyncEntityCommonType): SyncEntityCommonTypeIdPairFactory;
@@ -92,8 +93,8 @@ export type SyncEntityFactory = FactoryWithRequiredInput<SyncEntity, SyncEntityC
  * 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
@@ -104,6 +105,7 @@ export type SyncEntityFactory = FactoryWithRequiredInput<SyncEntity, SyncEntityC
  * const entity = factory({ commonType: 'user', commonId: 'abc123' });
  * // entity.id === 'abc123', entity.sourceInfo.id === 'api'
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function syncEntityFactory(config: SyncEntityFactoryConfig): SyncEntityFactory;

package/src/lib/service/sync/sync.entity.synchronizer.basic.d.ts

@@ -123,11 +123,12 @@ export interface BasicSyncEntityCommonTypeSynchronizerConfig {
  * 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__
  */
 export declare function basicSyncEntityCommonTypeSynchronizerInstanceFactory(config: BasicSyncEntityCommonTypeSynchronizerConfig): BasicSyncEntityCommonTypeSynchronizer;

package/src/lib/service/sync/sync.entity.synchronizer.d.ts

@@ -56,9 +56,9 @@ export interface SyncEntitySynchronizerConfig {
  * 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

package/src/lib/transform/transform.d.ts

@@ -16,8 +16,8 @@ export interface TransformAndValidateObject<T extends object, O, C = unknown> ex
  *
  * 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
@@ -47,8 +47,9 @@ export type TransformAndValidateObjectFactory<C = unknown> = <T extends object,
  * 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__
  */
 export declare function transformAndValidateObjectFactory<C = unknown>(defaults: TransformAndValidateObjectFactoryDefaults<C>): TransformAndValidateObjectFactory<C>;
@@ -73,8 +74,8 @@ export interface TransformAndValidateObjectResultFunctionConfig<T extends object
  * 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

package/src/lib/transform/transform.function.d.ts

@@ -12,8 +12,9 @@ export type TransformAndValidateFunctionResultFactory<C = unknown> = <T extends
 /**
  * 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__
  */
 export declare function transformAndValidateFunctionResultFactory<C = unknown>(defaults: TransformAndValidateObjectFactoryDefaults<C>): TransformAndValidateFunctionResultFactory<C>;
@@ -21,8 +22,9 @@ export declare function transformAndValidateFunctionResultFactory<C = unknown>(d
  * 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__
  */
 export declare function toTransformAndValidateFunctionResultFactory<C = unknown>(transformAndValidateObjectFactory: TransformAndValidateObjectFactory<C>): TransformAndValidateFunctionResultFactory<C>;

package/src/lib/transform/transform.result.d.ts

@@ -10,8 +10,9 @@ export type TransformAndValidateResultFactory<C = unknown> = <T extends object,
  *
  * 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__
  */
 export declare function transformAndValidateResultFactory<C = unknown>(defaults: TransformAndValidateObjectFactoryDefaults<C>): TransformAndValidateResultFactory<C>;

package/src/lib/type/type.d.ts

@@ -34,7 +34,7 @@ export declare const EMPTY_ARKTYPE_TYPE: Type<{}>;
  * 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
@@ -70,5 +70,5 @@ export declare function emptyType<T = {}>(): Type<T>;
  * @param definition The ArkType definition string or Type instance to make clearable.
  * @returns An ArkType schema that accepts the defined type, null, or undefined.
  */
-export declare function clearable<const def extends string>(definition: def): Type<type.infer<def> | null | undefined>;
-export declare function clearable<T>(definition: Type<T>): Type<T | null | undefined>;
+export declare function clearable<const def extends string>(definition: def): Type<Maybe<type.infer<def>>>;
+export declare function clearable<T>(definition: Type<T>): Type<Maybe<T>>;

package/src/lib/validator/unique.d.ts

@@ -2,8 +2,8 @@ import { type ReadKeyFunction } from '@dereekb/util';
 /**
  * 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