@dereekb/util 13.9.0 → 13.10.0

package/src/lib/path/path.d.ts

@@ -38,6 +38,10 @@ export type InferredSlashPathFolder = SlashPathFolder | EmptyRelativeSlashPathFo
  * The file extension of a SlashPathTypedFile.
  *
  * e.g. 'png' in 'image.png'
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:path
  */
 export type SlashPathTypedFileExtension = string;
 /**
@@ -48,6 +52,10 @@ export type SlashPathTypedFileExtension = string;
 export type SlashPathTypedFileSuffix = `${SlashFileTypeSeparatorString}${SlashPathTypedFileExtension}`;
 /**
  * A SlashPath file name without a file type identifier (e.g. 'image', and not 'image.png')
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:path
  */
 export type SlashPathUntypedFile = string;
 /**

package/src/lib/promise/promise.d.ts

@@ -124,6 +124,11 @@ export declare function performAsyncTasks<I, O = unknown, K extends PrimativeKey
 export declare function performAsyncTask<O>(taskFn: () => Promise<O>, config?: PerformAsyncTaskConfig<0>): Promise<PerformAsyncTaskResult<O>>;
 /**
  * Used as a key to identify the "group" that a task belongs to to prevent other concurrent tasks from that group from running in parallel when parallel execution is desired.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:concurrency
  */
 export type PerformTasksInParallelTaskUniqueKey = string;
 /**

package/src/lib/relation/relation.d.ts

@@ -40,6 +40,11 @@ export declare const RelationChange: {
 export type RelationChangeType = (typeof RelationChange)[keyof typeof RelationChange];
 /**
  * A string-based relation identifier.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:relation
  */
 export type RelationString = string;
 /**
@@ -48,6 +53,11 @@ export type RelationString = string;
 export type RelationObject = RelationString | object;
 /**
  * A string identifying the type/category of a relation model.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:relation
  */
 export type RelationModelType = string;
 /**

package/src/lib/sort.d.ts

@@ -15,6 +15,9 @@ export declare const SORT_VALUE_EQUAL: SortComparisonNumber;
  *
  * In "descending" order, this returns the opposite values as "ascending".
  * - Example: b - a
+ *
+ * @semanticType
+ * @semanticTopic numeric
  */
 export type SortComparisonNumber = number;
 /**

package/src/lib/storage/storage.d.ts

@@ -1,10 +1,19 @@
 import { type UnixDateTimeMillisecondsNumber } from '../date/date';
 /**
  * String representation of data that is stored.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic reference
  */
 export type StoredDataString = string;
 /**
  * Key used for accessing stored data.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic reference
  */
 export type StoredDataStorageKey = string;
 /**

package/src/lib/string/case.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Pure string-case converters that do not pull in the
+ * {@link change-case-all} dependency.
+ *
+ * Use these for the common SCREAMING_SNAKE ↔ camelCase conversions
+ * (constant-name ↔ symbol-name flips) without paying for the full
+ * change-case bundle. For arbitrary case detection / round-tripping
+ * across mixed inputs, prefer the dedicated package.
+ */
+/**
+ * Converts a SCREAMING_SNAKE_CASE string into camelCase.
+ *
+ * Empty segments (e.g. leading underscores in `_USER_ID`) are skipped.
+ *
+ * @param input The SCREAMING_SNAKE_CASE input.
+ * @returns The camelCase form.
+ */
+export declare function screamingSnakeToCamelCase(input: string): string;
+/**
+ * Converts a camelCase or PascalCase string into SCREAMING_SNAKE_CASE.
+ *
+ * Each upper-case character (other than the first) is preceded by an
+ * underscore, then the whole result is upper-cased.
+ *
+ * @param input The camelCase / PascalCase input.
+ * @returns The SCREAMING_SNAKE_CASE form.
+ */
+export declare function camelOrPascalToScreamingSnake(input: string): string;

package/src/lib/string/dencoder.d.ts

@@ -108,16 +108,28 @@ export type PrimativeKeyStringDencoderFunction<D extends PrimativeKey, E extends
 export declare function primativeKeyStringDencoder<D extends PrimativeKey, E extends PrimativeKey>(config: PrimativeKeyStringDencoderConfig<D, E>): PrimativeKeyStringDencoderFunction<D, E>;
 /**
  * An encodable number. This is typically a positive integer value.
+ *
+ * @semanticType
+ * @semanticTopic numeric
+ * @semanticTopic dereekb-util:encoding
  */
 export type NumberStringDencoderNumber = number;
 /**
  * A number-encoded string. Little-Endian. Should Decode to the same value each time.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:encoding
  */
 export type NumberStringDencoderString = string;
 /**
  * Digits used when encoding/decoding a value.
  *
  * The number of digits/characters must be a factor of 2. I.E. 8, 16, 32, 64
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:encoding
  */
 export type NumberStringDencoderDigits = string;
 /**

package/src/lib/string/html.d.ts

@@ -7,6 +7,10 @@ import { type PrimativeValue } from '../type';
 export type HtmlHeaderLevel = 1 | 2 | 3 | 4 | 5 | 6;
 /**
  * Represents a single CSS Class
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:css
  */
 export type CssClass = string;
 /**
@@ -16,6 +20,10 @@ export type CssClass = string;
  * ```ts
  * const name: CssTokenName = 'dbx-primary-color';
  * ```
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:css
  */
 export type CssTokenName = string;
 /**
@@ -62,10 +70,18 @@ export type CssVariableVar<T extends CssToken = CssToken> = CssTokenVar<T>;
 export declare const cssVariableVar: typeof cssTokenVar;
 /**
  * Represents a single CSS Style
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:css
  */
 export type CssStyle = string;
 /**
  * Represents one or more CssClasses that are space separated.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:css
  */
 export type SpaceSeparatedCssClasses = string;
 /**
@@ -74,6 +90,10 @@ export type SpaceSeparatedCssClasses = string;
 export type CssStyleObject = Record<string, Maybe<PrimativeValue>>;
 /**
  * Represents one or more CssStyles that are space separated.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:css
  */
 export type SpaceSeparatedCssStyles = string;
 /**

package/src/lib/string/index.d.ts

@@ -1,3 +1,4 @@
+export * from './case';
 export * from './char';
 export * from './dencoder';
 export * from './factory';

package/src/lib/string/json.d.ts

@@ -1,4 +1,8 @@
 /**
  * A json encoded string.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:encoding
  */
 export type JSONEncodedString = string;

package/src/lib/string/mimetype.d.ts

@@ -4,6 +4,10 @@ import { type Maybe } from '../value/maybe.type';
  * A simple mime type string with just the type/subtype and no parameters.
  *
  * I.E. "application/json"
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:mime
  */
 export type MimeTypeWithoutParameters = string;
 /**
@@ -14,12 +18,20 @@ export type MimeTypeWildcard = '*';
  * A mime type with a wildcard subtype. Has a star as the subtype.
  *
  * I.E. "application/*"
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:mime
  */
 export type MimeTypeWithSubtypeWildcardWithoutParameters = string;
 /**
  * A mime type string that may contain additional parameters.
  *
  * I.E. "text/plain", "application/json; charset=utf-8"
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:mime
  */
 export type ContentTypeMimeType = string;
 /**

package/src/lib/string/password.d.ts

@@ -1,4 +1,8 @@
 /**
  * A password string
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:secret
  */
 export type PasswordString = string;

package/src/lib/string/prefix.d.ts

@@ -3,16 +3,28 @@ import { type Maybe } from '../value/maybe.type';
  * A character or string that is added to the start of a string.
  *
  * Example: '-' in "-class"
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:prefix
  */
 export type CharacterPrefix = string;
 /**
  * A character or string that is added to the end of a string.
  *
  * Example: '-' in "class-"
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:prefix
  */
 export type CharacterSuffix = string;
 /**
  * A string that does not have a CharacterPrefix or CharacterSuffix.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:prefix
  */
 export type CharacterPrefixSuffixCleanString = string;
 /**
@@ -83,6 +95,30 @@ export interface CharacterPrefixSuffixInstance<P extends CharacterPrefix = '', S
  * @returns A new instance for managing prefix/suffix operations on strings.
  */
 export declare function characterPrefixSuffixInstance<P extends CharacterPrefix = '', S extends CharacterSuffix = ''>(config: CharacterPrefixSuffixInstanceConfiguration<P, S>): CharacterPrefixSuffixInstance<P, S>;
+/**
+ * Removes the given suffix from the input string when present, or
+ * returns `undefined` when the input does not end with the suffix.
+ *
+ * Use this when callers want to detect whether the suffix was present
+ * (vs. {@link removeFirstMatchingSuffix}, which silently passes the
+ * input through).
+ *
+ * @param input The string to trim.
+ * @param suffix The suffix to remove.
+ * @returns The input without the suffix, or `undefined` when the input
+ *   does not end with the suffix.
+ */
+export declare function removeSuffix(input: string, suffix: string): Maybe<string>;
+/**
+ * Removes the first matching suffix from the input string. Returns the
+ * input unchanged when none of the suffixes match.
+ *
+ * @param input The string to trim.
+ * @param suffixes The suffixes to try in order.
+ * @returns The input with the first matching suffix removed, or the
+ *   input unchanged when no suffix matches.
+ */
+export declare function removeFirstMatchingSuffix(input: string, suffixes: readonly string[]): string;
 /**
  * A string with a dash prefix.
  *

package/src/lib/string/tree.d.ts

@@ -2,6 +2,10 @@ import { type ArrayOrValue } from '../array/array';
 import { type Maybe } from '../value/maybe.type';
 /**
  * A string value representing a node in a split string tree.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:tree
  */
 export type SplitStringTreeNodeString = string;
 /**

package/src/lib/string/url.d.ts

@@ -8,6 +8,10 @@ import { type Maybe } from '../value/maybe.type';
  * Connection protocol
  *
  * I.E. http, https, etc.
+ *
+ * @semanticType
+ * @semanticTopic url
+ * @semanticTopic string
  */
 export type WebsiteProtocol = string;
 /**
@@ -35,6 +39,10 @@ export declare function isKnownHttpWebsiteProtocol(input: string): input is Know
  * Examples:
  * - dereekb.com
  * - components.dereekb.com
+ *
+ * @semanticType
+ * @semanticTopic url
+ * @semanticTopic string
  */
 export type WebsiteDomain = string;
 /**
@@ -61,6 +69,10 @@ export declare function hasWebsiteDomain(input: string): input is WebsiteDomain;
  * Examples:
  * - com
  * - net
+ *
+ * @semanticType
+ * @semanticTopic url
+ * @semanticTopic string
  */
 export type WebsiteTopLevelDomain = string;
 /**
@@ -87,6 +99,10 @@ export declare const HAS_PORT_NUMBER_REGEX: RegExp;
  * Example:
  * - 443
  * - 8080
+ *
+ * @semanticType
+ * @semanticTopic numeric
+ * @semanticTopic url
  */
 export type PortNumber = number;
 /**
@@ -138,6 +154,10 @@ export declare function baseWebsiteUrl(input: BaseWebsiteUrlInput, defaultTld?:
  * - https://components.dereekb.com/
  * - https://components.dereekb.com/doc/home?
  * - https://components.dereekb.com/doc/home?test=true&test2=true
+ *
+ * @semanticType
+ * @semanticTopic url
+ * @semanticTopic string
  */
 export type WebsiteUrl = string;
 /**
@@ -207,6 +227,10 @@ export interface WebsiteUrlDetails {
 export declare function websiteUrlDetails(input: string): WebsiteUrlDetails;
 /**
  * A website url that starts with the proper http/https prefix.
+ *
+ * @semanticType
+ * @semanticTopic url
+ * @semanticTopic string
  */
 export type WebsiteUrlWithPrefix = string;
 /**
@@ -231,6 +255,10 @@ export declare function isWebsiteUrlWithPrefix(input: string): input is WebsiteU
  * Non-examples:
  * - localhost:8080       // not internet-accessible
  * - test://dereekb.com   // non-http/https protocol
+ *
+ * @semanticType
+ * @semanticTopic url
+ * @semanticTopic string
  */
 export type StandardInternetAccessibleWebsiteUrl = string;
 /**
@@ -247,6 +275,10 @@ export declare function isStandardInternetAccessibleWebsiteUrl(input: string): i
  * - dereekb.com
  * - components.dereekb.com/
  * - components.dereekb.com/doc/home
+ *
+ * @semanticType
+ * @semanticTopic url
+ * @semanticTopic string
  */
 export type WebsiteDomainAndPath = string;
 /**

package/src/lib/value/address.d.ts

@@ -1,30 +1,65 @@
 import { type Maybe } from './maybe.type';
 /**
  * City name string (e.g. "San Antonio").
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:address
  */
 export type CityString = string;
 /**
  * Full state name string (e.g. "Texas").
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:address
  */
 export type StateString = string;
 /**
  * Two-letter US state code (e.g. "TX").
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:address
  */
 export type StateCodeString = string;
 /**
  * Full country name string (e.g. "United States").
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:address
  */
 export type CountryString = string;
 /**
  * Country code string (e.g. "US").
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:address
  */
 export type CountryCodeString = string;
 /**
  * A single line in a street address.
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:address
  */
 export type AddressLineString = string;
 /**
  * Postal/zip code string.
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:address
  */
 export type ZipCodeString = string;
 /**

package/src/lib/value/cron.d.ts

@@ -1,6 +1,10 @@
 import { type Minutes } from '../date/date';
 /**
  * A cron schedule expression string
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic dereekb-util:cron
  */
 export type CronExpression = string;
 /**

package/src/lib/value/indexed.d.ts

@@ -10,6 +10,10 @@ import { type FilterUniqueFunctionExcludeKeysInput } from '../array/array.unique
  * An integer that denotes which index an item is at.
  *
  * Is typically non-negative only.
+ *
+ * @semanticType
+ * @semanticTopic numeric
+ * @semanticTopic reference
  */
 export type IndexNumber = number;
 /**

package/src/lib/value/modifier.d.ts

@@ -2,6 +2,10 @@ import { type ArrayOrValue } from '../array';
 import { type Maybe } from './maybe.type';
 /**
  * String key that uniquely identifies a modifier within a {@link ModifierMap}.
+ *
+ * @semanticType
+ * @semanticTopic string
+ * @semanticTopic identifier
  */
 export type ModifierKey = string;
 /**

package/src/lib/value/pixel.d.ts

@@ -1,2 +1,16 @@
+/**
+ * Pixel count.
+ *
+ * @semanticType
+ * @semanticTopic measurement
+ * @semanticTopic numeric
+ */
 export type Pixels = number;
+/**
+ * Pixel count as a string with a "px" suffix (e.g. "100px").
+ *
+ * @semanticType
+ * @semanticTopic measurement
+ * @semanticTopic string
+ */
 export type PixelsString = string;

package/src/lib/value/point.d.ts

@@ -3,10 +3,18 @@ import { type NumberPrecision, type RoundToPrecisionFunctionType } from '../numb
 import { type Maybe } from './maybe.type';
 /**
  * Latitude value in degrees, ranging from -90 to 90.
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic numeric
  */
 export type Latitude = number;
 /**
  * Longitude value in degrees, ranging from -180 to 180.
+ *
+ * @semanticType
+ * @semanticTopic geo
+ * @semanticTopic numeric
  */
 export type Longitude = number;
 /**
@@ -35,6 +43,9 @@ export declare const MAX_LONGITUDE_VALUE = 180;
 export declare const TOTAL_LONGITUDE_RANGE: number;
 /**
  * A geographic point represented by latitude and longitude.
+ *
+ * @semanticType
+ * @semanticTopic geo
  */
 export interface LatLngPoint {
     lat: Latitude;

package/src/lib/value/zoom.d.ts

@@ -1,5 +1,9 @@
 /**
  * Camera zoom level.
+ *
+ * @semanticType
+ * @semanticTopic measurement
+ * @semanticTopic numeric
  */
 export type ZoomLevel = number;
 /**

package/test/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@dereekb/util/test",
-  "version": "13.9.0",
+  "version": "13.10.0",
   "peerDependencies": {
-    "@dereekb/util": "13.9.0",
+    "@dereekb/util": "13.10.0",
     "make-error": "^1.3.0"
   },
   "exports": {