@memberjunction/global 6.2.0-edge.1 → 6.2.0-edge.3

package/dist/util/BinaryEncoding.js

@@ -0,0 +1,388 @@
+/**
+ * Binary encoding primitives shared by every MemberJunction tier.
+ *
+ * MemberJunction stores binary database columns (SQL Server `binary` / `varbinary` / `image`,
+ * PostgreSQL `bytea`) in `BaseEntity` and on the wire as **base64 strings**. A string keeps the
+ * value JSON-safe, so dirty tracking, Record Changes, the RunView caches, GraphQL and remote
+ * invalidation broadcasts all handle it without special cases. Code that needs the actual bytes
+ * converts at the edge with the functions in this module.
+ *
+ * Everything here is dependency-free and runs unchanged in browsers, Node and workers. Each
+ * conversion picks the fastest implementation the host offers:
+ *
+ * | Host | base64 → bytes | bytes → base64 |
+ * |---|---|---|
+ * | Browsers with the TC39 base64 API (Chrome 140+, Firefox 133+, Safari 18.2+) | `Uint8Array.fromBase64` | `Uint8Array.prototype.toBase64` |
+ * | Node.js | `Buffer.from(s, 'base64')` | `Buffer#toString('base64')` |
+ * | Anything else | `atob` | `btoa` (chunked) |
+ *
+ * The fast paths are detected by duck typing, once per process, so older browsers keep working.
+ * All three implementations accept and produce exactly the same strings, and the decoders
+ * validate input identically, so a value never decodes on one tier and fails on another.
+ *
+ * @module BinaryEncoding
+ */
+/**
+ * Lookup table over every UTF-16 code unit (64 KB, so the scan needs no range check): 1 for the standard base64 alphabet (`A–Z a–z 0–9 + /`),
+ * 0 otherwise. Data URIs, URL-safe base64 and MIME line breaks are deliberately rejected: binary
+ * columns only ever carry canonical base64. A table scan is used instead of a regular expression
+ * because validation runs on every decode, and on an 8 KB vector a regex costs about five times
+ * as much as the decode itself.
+ */
+/** Char code of the base64 padding character `=`. */
+const EQUALS_CODE = 0x3d;
+const BASE64_ALPHABET = (() => {
+    const table = new Uint8Array(0x10000);
+    const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
+    for (let i = 0; i < alphabet.length; i++)
+        table[alphabet.charCodeAt(i)] = 1;
+    return table;
+})();
+/** `String.fromCharCode` argument count per call when building a binary string for `btoa`. */
+const BTOA_CHUNK = 0x8000;
+/** Reads a global by name without assuming any particular host typings. */
+function readGlobal(name) {
+    return Reflect.get(globalThis, name);
+}
+/** Native TC39 base64 support on `Uint8Array`, detected by duck typing. */
+const NativeCodec = {
+    Name: 'Uint8Array.fromBase64 / toBase64',
+    IsAvailable() {
+        return typeof Reflect.get(Uint8Array, 'fromBase64') === 'function'
+            && typeof Reflect.get(Uint8Array.prototype, 'toBase64') === 'function';
+    },
+    Encode(bytes) {
+        return bytes.toBase64();
+    },
+    Decode(base64) {
+        const fromBase64 = Reflect.get(Uint8Array, 'fromBase64');
+        return fromBase64.call(Uint8Array, base64, { lastChunkHandling: 'loose' });
+    },
+};
+/** Node's `Buffer`, which encodes and decodes in native code. */
+const NodeBufferCodec = {
+    Name: 'Node Buffer',
+    IsAvailable() {
+        return typeof readGlobal('Buffer')?.from === 'function';
+    },
+    Encode(bytes) {
+        const nodeBuffer = readGlobal('Buffer');
+        return nodeBuffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength).toString('base64');
+    },
+    Decode(base64) {
+        const nodeBuffer = readGlobal('Buffer');
+        const decoded = nodeBuffer.from(base64, 'base64');
+        // Copy out of Node's shared allocation pool: a pooled Buffer views a larger ArrayBuffer at
+        // an arbitrary offset, which typed-array views and transfers would otherwise trip over.
+        return new Uint8Array(decoded);
+    },
+    /**
+     * Validates by decoding. Node's decoder silently SKIPS characters outside the alphabet
+     * (whitespace, punctuation, non-ASCII) and stops at an early `=`, so any such character makes the
+     * output shorter than a canonical string of the same length decodes to — the length check rejects
+     * it. The one thing it accepts that canonical base64 does not is the URL-safe alphabet (`-`, `_`),
+     * rejected separately with a native `indexOf`. About five times cheaper than a JavaScript
+     * character scan on vector-sized values; fuzz-tested against {@link IsValidBase64}.
+     */
+    TryDecode(base64) {
+        if (!HasValidBase64Shape(base64))
+            return null;
+        if (base64.indexOf('-') !== -1 || base64.indexOf('_') !== -1)
+            return null;
+        if (base64.length === 0)
+            return new Uint8Array(0);
+        const decoded = this.Decode(base64);
+        return decoded.length === Base64DecodedByteLength(base64) ? decoded : null;
+    },
+};
+/** `atob` / `btoa`, available in every browser, worker and modern Node. */
+const PortableCodec = {
+    Name: 'atob / btoa',
+    IsAvailable() {
+        return typeof readGlobal('atob') === 'function' && typeof readGlobal('btoa') === 'function';
+    },
+    Encode(bytes) {
+        let binary = '';
+        for (let start = 0; start < bytes.length; start += BTOA_CHUNK) {
+            const chunk = bytes.subarray(start, Math.min(start + BTOA_CHUNK, bytes.length));
+            binary += String.fromCharCode(...chunk);
+        }
+        return btoa(binary);
+    },
+    Decode(base64) {
+        const binary = atob(base64);
+        const bytes = new Uint8Array(binary.length);
+        for (let i = 0; i < binary.length; i++)
+            bytes[i] = binary.charCodeAt(i);
+        return bytes;
+    },
+};
+/**
+ * Every base64 implementation, fastest first. Exposed so tests can prove the implementations are
+ * interchangeable; application code should call {@link BytesToBase64} / {@link Base64ToBytes}.
+ */
+export const Base64Codecs = [NativeCodec, NodeBufferCodec, PortableCodec];
+let selectedCodec;
+/**
+ * Returns the fastest base64 implementation this host supports. The choice is made once and
+ * cached; it cannot change during a process's life.
+ *
+ * @throws Error when the host offers none of the implementations (no JavaScript host MJ supports).
+ */
+export function GetBase64Codec() {
+    const codec = findBase64Codec();
+    if (!codec)
+        throw new Error('No base64 implementation is available on this host');
+    return codec;
+}
+/** The selected codec, choosing it on first use; `undefined` when the host offers none. */
+function findBase64Codec() {
+    selectedCodec ??= Base64Codecs.find(codec => codec.IsAvailable());
+    return selectedCodec;
+}
+/**
+ * True when `value` is canonical base64: the standard alphabet (`A–Z a–z 0–9 + /`), optional
+ * `=` padding, no whitespace, and a length that can encode whole bytes. The empty string is valid
+ * and decodes to zero bytes.
+ *
+ * @param value - The string to check.
+ */
+export function IsValidBase64(value) {
+    if (!HasValidBase64Shape(value))
+        return false;
+    const dataLength = value.length - trailingPadding(value);
+    for (let i = 0; i < dataLength; i++) {
+        if (BASE64_ALPHABET[value.charCodeAt(i)] === 0)
+            return false;
+    }
+    return true;
+}
+/** Number of trailing `=` characters, counting at most two. */
+function trailingPadding(value) {
+    const length = value.length;
+    if (length === 0 || value.charCodeAt(length - 1) !== EQUALS_CODE)
+        return 0;
+    return length > 1 && value.charCodeAt(length - 2) === EQUALS_CODE ? 2 : 1;
+}
+/**
+ * The length rules of canonical base64, without looking at the characters: a length that can
+ * encode whole bytes, and padding only on a full final quantum ("xx==" or "xxx="), never on a bare
+ * remainder. Part of {@link IsValidBase64}; exposed so a codec's fused validate-and-decode
+ * ({@link Base64Codec.TryDecode}) applies the same rules.
+ *
+ * @param value - The string to check.
+ */
+export function HasValidBase64Shape(value) {
+    const length = value.length;
+    if (length % 4 === 1)
+        return false;
+    return trailingPadding(value) === 0 || length % 4 === 0;
+}
+/**
+ * Returns how many bytes a base64 string decodes to, without decoding it. Useful for size checks
+ * on large values. The input is assumed to be valid (see {@link IsValidBase64}); padding is
+ * optional.
+ *
+ * @param base64 - Canonical base64.
+ */
+export function Base64DecodedByteLength(base64) {
+    const padding = base64.endsWith('==') ? 2 : base64.endsWith('=') ? 1 : 0;
+    const dataChars = base64.length - padding;
+    return Math.floor((dataChars * 3) / 4);
+}
+/** Prefix of the text recorded in a change log in place of a binary value. See {@link FormatBinaryChangeValue}. */
+export const BINARY_CHANGE_VALUE_PREFIX = '[binary:';
+/**
+ * The text a change log records, and change history shows, in place of a binary field's base64
+ * value: `[binary: 6,144 bytes]`. The bytes themselves stay in the record snapshot
+ * (`FullRecordJSON`), which restore reads; only the per-field diff (`ChangesJSON`) and its
+ * on-screen rendering use this, so a change to an embedding or a file is visible without carrying
+ * the content twice more per save. Invalid base64 is reported as such rather than thrown on.
+ *
+ * @param base64 - The field's value as held above the database.
+ */
+export function FormatBinaryChangeValue(base64) {
+    if (!IsValidBase64(base64))
+        return `${BINARY_CHANGE_VALUE_PREFIX} invalid base64]`;
+    return `${BINARY_CHANGE_VALUE_PREFIX} ${Base64DecodedByteLength(base64).toLocaleString('en-US')} bytes]`;
+}
+/** Whether `value` is text produced by {@link FormatBinaryChangeValue}, so it is shown as-is and never decoded. */
+export function IsBinaryChangeValue(value) {
+    return typeof value === 'string' && value.startsWith(BINARY_CHANGE_VALUE_PREFIX) && value.endsWith(']');
+}
+/**
+ * Encodes bytes as standard, padded base64 using the fastest implementation the host offers.
+ *
+ * @param bytes - The bytes to encode. Any `Uint8Array` works, including a Node `Buffer` or a view
+ *   into a larger buffer; only the viewed range is encoded.
+ * @returns The base64 string; `''` for zero bytes.
+ */
+export function BytesToBase64(bytes) {
+    if (bytes.length === 0)
+        return '';
+    return GetBase64Codec().Encode(bytes);
+}
+/**
+ * Decodes base64 into a new `Uint8Array` that owns its own `ArrayBuffer` (offset 0, never a view
+ * into a shared pool), using the fastest implementation the host offers.
+ *
+ * @param base64 - Canonical base64 (see {@link IsValidBase64}); padding may be omitted.
+ * @returns The decoded bytes.
+ * @throws Error when `base64` is not valid base64. Use {@link TryBase64ToBytes} to get `null` instead.
+ */
+export function Base64ToBytes(base64) {
+    const bytes = decodeValidated(base64);
+    if (!bytes) {
+        throw new Error(`Invalid base64 value (length ${base64.length})`);
+    }
+    return bytes;
+}
+/**
+ * Validates and decodes in one step: the codec's fused {@link Base64Codec.TryDecode} when it has
+ * one, else {@link IsValidBase64} followed by a plain decode. `null` when invalid.
+ */
+function decodeValidated(base64) {
+    if (base64.length === 0)
+        return new Uint8Array(0);
+    const codec = findBase64Codec();
+    if (codec?.TryDecode)
+        return codec.TryDecode(base64);
+    // No fused decoder — or no codec at all, in which case invalid input still answers null and
+    // only a valid value reaches GetBase64Codec() and its "no implementation" error.
+    if (!IsValidBase64(base64))
+        return null;
+    return (codec ?? GetBase64Codec()).Decode(base64);
+}
+/**
+ * Like {@link Base64ToBytes}, but returns `null` instead of throwing when the input is not a
+ * string or not valid base64. Convenient for reading a nullable binary entity field.
+ *
+ * @param base64 - The value to decode, typically a binary entity field (`string | null`).
+ */
+export function TryBase64ToBytes(base64) {
+    return typeof base64 === 'string' ? decodeValidated(base64) : null;
+}
+/**
+ * True when `value` is a byte array: a `Uint8Array`, which includes a Node `Buffer`. Database
+ * drivers return binary columns this way; use it at the provider boundary to recognise values
+ * that must be converted to base64 before they reach a `BaseEntity`.
+ *
+ * @param value - Any value.
+ */
+export function IsByteArray(value) {
+    return value instanceof Uint8Array;
+}
+/**
+ * Returns `row` with every top-level byte-array value replaced by its base64 string.
+ *
+ * Copy-on-write: when the row holds no byte arrays (the normal case, since the database providers
+ * already convert binary columns) the same object is returned untouched; otherwise a shallow copy
+ * is returned and the original — which may be a frozen cache entry — is never modified.
+ *
+ * Use it as a safety net wherever rows are serialized for a transport: `JSON.stringify` turns a
+ * Node `Buffer` into `{"type":"Buffer","data":[...]}` and GraphQL's `String` scalar rejects it.
+ *
+ * @param row - A data row.
+ */
+export function ReplaceByteArraysWithBase64(row) {
+    let copy = null;
+    for (const key of Object.keys(row)) {
+        const value = row[key];
+        if (IsByteArray(value)) {
+            if (!copy)
+                copy = { ...row };
+            copy[key] = BytesToBase64(value);
+        }
+    }
+    return (copy ?? row);
+}
+/* ------------------------------------------------------------------------------------------ */
+/* Float32 vectors                                                                             */
+/* ------------------------------------------------------------------------------------------ */
+/**
+ * The byte layout MemberJunction uses for persisted embedding vectors: consecutive
+ * IEEE-754 single-precision values, little-endian, 4 bytes each, no header. The dimension count
+ * is `byteLength / 4`. This is the layout of a `Float32Array` on every little-endian host, which
+ * is every platform MemberJunction runs on; big-endian hosts are still handled correctly.
+ */
+export const FLOAT32_VECTOR_BYTES_PER_VALUE = 4;
+/** True when this host stores multi-byte numbers little-endian. */
+function hostIsLittleEndian() {
+    return new Uint8Array(new Uint32Array([1]).buffer)[0] === 1;
+}
+/** Typed-array copy; correct only on little-endian hosts. */
+const TypedArrayFloat32Codec = {
+    Name: 'typed array (little-endian host)',
+    Encode(values) {
+        return new Uint8Array(Float32Array.from(values).buffer);
+    },
+    Decode(bytes) {
+        // Copy first: the source may be a misaligned view (e.g. a pooled Node Buffer), and a
+        // Float32Array over it would also alias memory the caller does not own.
+        return new Float32Array(bytes.slice().buffer);
+    },
+};
+/** Explicit little-endian reads and writes; correct on every host. */
+const DataViewFloat32Codec = {
+    Name: 'DataView (any host)',
+    Encode(values) {
+        const bytes = new Uint8Array(values.length * FLOAT32_VECTOR_BYTES_PER_VALUE);
+        const view = new DataView(bytes.buffer);
+        for (let i = 0; i < values.length; i++)
+            view.setFloat32(i * FLOAT32_VECTOR_BYTES_PER_VALUE, values[i], true);
+        return bytes;
+    },
+    Decode(bytes) {
+        const count = bytes.byteLength / FLOAT32_VECTOR_BYTES_PER_VALUE;
+        const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        const values = new Float32Array(count);
+        for (let i = 0; i < count; i++)
+            values[i] = view.getFloat32(i * FLOAT32_VECTOR_BYTES_PER_VALUE, true);
+        return values;
+    },
+};
+/** Both float32 vector implementations. Exposed for tests; use the functions below instead. */
+export const Float32VectorCodecs = [TypedArrayFloat32Codec, DataViewFloat32Codec];
+const float32Codec = hostIsLittleEndian() ? TypedArrayFloat32Codec : DataViewFloat32Codec;
+/**
+ * Encodes a vector as little-endian float32 bytes. Values are rounded to single precision, which
+ * is the precision embedding models produce; `NaN` and infinities are stored as-is.
+ *
+ * @param values - The vector, e.g. a `number[]` or a `Float32Array`.
+ * @returns A new byte array of `values.length × 4` bytes.
+ */
+export function Float32VectorToBytes(values) {
+    return float32Codec.Encode(values);
+}
+/**
+ * Decodes little-endian float32 bytes into a new `Float32Array` that owns its memory.
+ *
+ * @param bytes - Bytes in the {@link FLOAT32_VECTOR_BYTES_PER_VALUE persisted vector layout}.
+ * @returns The vector, or `null` when `bytes` is empty or not a whole number of float32 values,
+ *   so a truncated or foreign value is treated as missing rather than misread.
+ */
+export function BytesToFloat32Vector(bytes) {
+    if (!bytes || bytes.byteLength === 0 || bytes.byteLength % FLOAT32_VECTOR_BYTES_PER_VALUE !== 0)
+        return null;
+    return float32Codec.Decode(bytes);
+}
+/**
+ * Encodes a vector as base64 of its little-endian float32 bytes: the value stored in a binary
+ * vector entity field such as `VectorBinary`.
+ *
+ * @param values - The vector.
+ */
+export function Float32VectorToBase64(values) {
+    return BytesToBase64(Float32VectorToBytes(values));
+}
+/**
+ * Decodes a binary vector entity field (base64 of little-endian float32 bytes).
+ *
+ * @param base64 - The field value; `null` / `undefined` are allowed.
+ * @returns The vector, or `null` when the value is missing, not valid base64, empty, or not a
+ *   whole number of float32 values. Callers usually fall back to a JSON copy of the vector.
+ */
+export function Base64ToFloat32Vector(base64) {
+    return BytesToFloat32Vector(TryBase64ToBytes(base64));
+}
+//# sourceMappingURL=BinaryEncoding.js.map

package/dist/util/BinaryEncoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BinaryEncoding.js","sourceRoot":"","sources":["../../src/util/BinaryEncoding.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAmDH;;;;;;GAMG;AACH,qDAAqD;AACrD,MAAM,WAAW,GAAG,IAAI,CAAC;AAEzB,MAAM,eAAe,GAAe,CAAC,GAAG,EAAE;IACtC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,kEAAkE,CAAC;IACpF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC5E,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC,EAAE,CAAC;AAEL,8FAA8F;AAC9F,MAAM,UAAU,GAAG,MAAM,CAAC;AAE1B,2EAA2E;AAC3E,SAAS,UAAU,CAAI,IAAY;IAC/B,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAkB,CAAC;AAC1D,CAAC;AAED,2EAA2E;AAC3E,MAAM,WAAW,GAAgB;IAC7B,IAAI,EAAE,kCAAkC;IACxC,WAAW;QACP,OAAO,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,YAAY,CAAC,KAAK,UAAU;eAC3D,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,UAAU,CAAC;IAC/E,CAAC;IACD,MAAM,CAAC,KAAiB;QACpB,OAAQ,KAA2C,CAAC,QAAQ,EAAE,CAAC;IACnE,CAAC;IACD,MAAM,CAAC,MAAc;QACjB,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,YAAY,CAAsC,CAAC;QAC9F,OAAO,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACJ,CAAC;AAEF,iEAAiE;AACjE,MAAM,eAAe,GAAgB;IACjC,IAAI,EAAE,aAAa;IACnB,WAAW;QACP,OAAO,OAAO,UAAU,CAAoB,QAAQ,CAAC,EAAE,IAAI,KAAK,UAAU,CAAC;IAC/E,CAAC;IACD,MAAM,CAAC,KAAiB;QACpB,MAAM,UAAU,GAAG,UAAU,CAAoB,QAAQ,CAAsB,CAAC;QAChF,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAChG,CAAC;IACD,MAAM,CAAC,MAAc;QACjB,MAAM,UAAU,GAAG,UAAU,CAAoB,QAAQ,CAAsB,CAAC;QAChF,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClD,2FAA2F;QAC3F,wFAAwF;QACxF,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IACD;;;;;;;OAOG;IACH,SAAS,CAAC,MAAc;QACpB,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,CAAC;QAC9C,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC,MAAM,KAAK,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,CAAC;CACJ,CAAC;AAEF,2EAA2E;AAC3E,MAAM,aAAa,GAAgB;IAC/B,IAAI,EAAE,aAAa;IACnB,WAAW;QACP,OAAO,OAAO,UAAU,CAAU,MAAM,CAAC,KAAK,UAAU,IAAI,OAAO,UAAU,CAAU,MAAM,CAAC,KAAK,UAAU,CAAC;IAClH,CAAC;IACD,MAAM,CAAC,KAAiB;QACpB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,UAAU,EAAE,CAAC;YAC5D,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAChF,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IACD,MAAM,CAAC,MAAc;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE;YAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACxE,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAA2B,CAAC,WAAW,EAAE,eAAe,EAAE,aAAa,CAAC,CAAC;AAElG,IAAI,aAAsC,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,UAAU,cAAc;IAC1B,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IAClF,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,2FAA2F;AAC3F,SAAS,eAAe;IACpB,aAAa,KAAK,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;IAClE,OAAO,aAAa,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IACvC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9C,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,IAAI,eAAe,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;IACjE,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,+DAA+D;AAC/D,SAAS,eAAe,CAAC,KAAa;IAClC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC5B,IAAI,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,WAAW;QAAE,OAAO,CAAC,CAAC;IAC3E,OAAO,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC5B,IAAI,MAAM,GAAG,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAc;IAClD,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzE,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED,mHAAmH;AACnH,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAAC;AAErD;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAc;IAClD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QAAE,OAAO,GAAG,0BAA0B,kBAAkB,CAAC;IACnF,OAAO,GAAG,0BAA0B,IAAI,uBAAuB,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC;AAC7G,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,mBAAmB,CAAC,KAAc;IAC9C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,0BAA0B,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC5G,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,KAAiB;IAC3C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAClC,OAAO,cAAc,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc;IACxC,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,MAAc;IACnC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,IAAI,KAAK,EAAE,SAAS;QAAE,OAAO,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACrD,4FAA4F;IAC5F,iFAAiF;IACjF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IACxC,OAAO,CAAC,KAAK,IAAI,cAAc,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAiC;IAC9D,OAAO,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACvE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACtC,OAAO,KAAK,YAAY,UAAU,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,2BAA2B,CAAoC,GAAM;IACjF,IAAI,IAAI,GAAmC,IAAI,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,IAAI;gBAAE,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;IACD,OAAO,CAAC,IAAI,IAAI,GAAG,CAAM,CAAC;AAC9B,CAAC;AAED,gGAAgG;AAChG,iGAAiG;AACjG,gGAAgG;AAEhG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC;AAgBhD,mEAAmE;AACnE,SAAS,kBAAkB;IACvB,OAAO,IAAI,UAAU,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,6DAA6D;AAC7D,MAAM,sBAAsB,GAAuB;IAC/C,IAAI,EAAE,kCAAkC;IACxC,MAAM,CAAC,MAAyB;QAC5B,OAAO,IAAI,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,CAAC,KAAiB;QACpB,qFAAqF;QACrF,wEAAwE;QACxE,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;CACJ,CAAC;AAEF,sEAAsE;AACtE,MAAM,oBAAoB,GAAuB;IAC7C,IAAI,EAAE,qBAAqB;IAC3B,MAAM,CAAC,MAAyB;QAC5B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,8BAA8B,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE;YAAE,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,8BAA8B,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7G,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,CAAC,KAAiB;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,GAAG,8BAA8B,CAAC;QAChE,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE;YAAE,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,8BAA8B,EAAE,IAAI,CAAC,CAAC;QACtG,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ,CAAC;AAEF,+FAA+F;AAC/F,MAAM,CAAC,MAAM,mBAAmB,GAAkC,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;AAEjH,MAAM,YAAY,GAAuB,kBAAkB,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,oBAAoB,CAAC;AAE9G;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAyB;IAC1D,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAoC;IACrE,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,GAAG,8BAA8B,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7G,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAyB;IAC3D,OAAO,aAAa,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAiC;IACnE,OAAO,oBAAoB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;AAC1D,CAAC"}

package/dist/util.d.ts

@@ -280,18 +280,25 @@ export declare function GetIrregularPlural(singularName: string): string | null;
 /** @deprecated Use {@link GetIrregularPlural}. */
 export declare function getIrregularPlural(singularName: string): string | null;
 /**
- * Converts a singular word to its plural form, handling common pluralization rules
- * and irregular plurals.
+ * Converts a singular name to its plural form. The head of the name is kept
+ * verbatim, including the separator that ends it, and only the tail is pluralized.
+ * The tail keeps its own case. A linear scan finds the tail: the last space,
+ * underscore, or hyphen, or else the last Unicode capital that starts a word.
+ * A regex over ASCII letters is not used, because it drops a leading character
+ * such as Ä and it erases the underscore that distinguishes user_profile from
+ * userProfile.
  *
- * @param singularName - The singular form of the word to pluralize.
- * @returns The plural form of the word.
+ * @param singularName - The singular form of the name to pluralize.
+ * @returns The plural form of the name.
  *
  * @example
  * ```typescript
- * generatePluralName('child'); // returns 'children'
- * generatePluralName('box'); // returns 'boxes'
- * generatePluralName('party'); // returns 'parties'
- * generatePluralName('dog'); // returns 'dogs'
+ * GeneratePluralName('child'); // returns 'children'
+ * GeneratePluralName('box'); // returns 'boxes'
+ * GeneratePluralName('party'); // returns 'parties'
+ * GeneratePluralName('dog'); // returns 'dogs'
+ * GeneratePluralName('Contact Person'); // returns 'Contact People'
+ * GeneratePluralName('user_profile', { capitalizeFirstLetterOnly: true }); // returns 'user_Profiles'
  * ```
  */
 export declare function GeneratePluralName(singularName: string, options?: {

package/dist/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AASD,wBAAgB,oBAAoB,IAAI,iBAAiB,GAAG,IAAI,CA6B/D;AAGD;;;;;;;;;;;;;;;;;;;GAmBG;AACH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE9E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,EACjD,KAAK,EAAE,CAAC,EACR,yBAAyB,GAAE,OAAe,EAC1C,QAAQ,GAAE,MAAW,GACtB,OAAO,CAAC,CAAC,CAAC,CAkHZ;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,wBAAgB,iBAAiB,CAAC,CAAC,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,EAAE,SAAS,GAAE,OAAe,GAAG,CAAC,GAAG,IAAI,CAS3G;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CA2InE;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,oDAAoD;IACpD,QAAQ,EAAE,OAAO,CAAC;IAClB,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8DAA8D;IAE9D,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,0EAA0E;IAC1E,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAgB,kBAAkB,CAC9B,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,UAAU,GAAE,MAAkC,GAC/C,wBAAwB,CA0C1B;AAiGD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,CAe9D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,wBAAgB,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe,GAAG,CAAC,GAAG,IAAI,CAY/F;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,YAAY,EAAE,SAAS,GAAG,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAalH;AAOD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gJAAgJ;IAChJ,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sEAAsE;IACtE,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAoBlF;AAED,iDAAiD;AACjD,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAElF;AAuTD;;;;;EAKE;AACF,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAc9D;AAED,4DAA4D;AAC5D,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE9D;AAGD;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAMjD;AAED,+CAA+C;AAC/C,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjD;AAuED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEtE;AAED,kDAAkD;AAClD,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEtE;AAuCD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAG;IAAE,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAAC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAwCnJ;AAED,kDAAkD;AAClD,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAG;IAAE,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAAC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAEnJ;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IACjD,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,wBAAwB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAuBhD;AAED,4CAA4C;AAC5C,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IACjD,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,wBAAwB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAEhD;AAID;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,GAAG,MAAM,CAerG;AAED,kDAAkD;AAClD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,GAAG,MAAM,CAErG;AAGD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAalD;AAED,gDAAgD;AAChD,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAElD;AAGD;;;GAGG;AACH,wBAAgB,MAAM,IAAI,MAAM,CAE/B;AAED,sCAAsC;AACtC,wBAAgB,MAAM,IAAI,MAAM,CAE/B;AAGD;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAE,OAAc,GAAG,MAAM,EAAE,CA4CvG;AAED,oDAAoD;AACpD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAE,OAAc,GAAG,MAAM,EAAE,CAEvG;AASD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oHAAoH;IACpH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iEAAiE;IACjE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAmBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,GAAE,gBAAqB,GAAG,GAAG,CAUhF;AA2DD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAGxE;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;AAE3D,kFAAkF;AAClF,eAAO,MAAM,6BAA6B,MAAM,CAAC;AA8BjD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,oBAAoB,CAChC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,aAAa,GAAE,MAAsC,GACtD,cAAc,CAchB;AAED,oDAAoD;AACpD,wBAAgB,oBAAoB,CAChC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,aAAa,GAAE,MAAsC,GACtD,cAAc,CAEhB;AA2BD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CA2B9F;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAYrE;AAkFD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAIlF;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAIjG;AAED,8CAA8C;AAC9C,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAEjG"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AASD,wBAAgB,oBAAoB,IAAI,iBAAiB,GAAG,IAAI,CA6B/D;AAGD;;;;;;;;;;;;;;;;;;;GAmBG;AACH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE9E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,EACjD,KAAK,EAAE,CAAC,EACR,yBAAyB,GAAE,OAAe,EAC1C,QAAQ,GAAE,MAAW,GACtB,OAAO,CAAC,CAAC,CAAC,CAkHZ;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,wBAAgB,iBAAiB,CAAC,CAAC,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,EAAE,SAAS,GAAE,OAAe,GAAG,CAAC,GAAG,IAAI,CAS3G;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CA2InE;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,oDAAoD;IACpD,QAAQ,EAAE,OAAO,CAAC;IAClB,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8DAA8D;IAE9D,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,0EAA0E;IAC1E,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAgB,kBAAkB,CAC9B,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,UAAU,GAAE,MAAkC,GAC/C,wBAAwB,CA0C1B;AAiGD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,CAe9D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,wBAAgB,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe,GAAG,CAAC,GAAG,IAAI,CAY/F;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,YAAY,EAAE,SAAS,GAAG,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAalH;AAOD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gJAAgJ;IAChJ,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sEAAsE;IACtE,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAoBlF;AAED,iDAAiD;AACjD,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAElF;AAuTD;;;;;EAKE;AACF,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAc9D;AAED,4DAA4D;AAC5D,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE9D;AAGD;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAMjD;AAED,+CAA+C;AAC/C,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjD;AAuED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEtE;AAED,kDAAkD;AAClD,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEtE;AAuCD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAG;IAAE,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAAC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAanJ;AA2FD,kDAAkD;AAClD,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAG;IAAE,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAAC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAEnJ;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IACjD,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,wBAAwB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAuBhD;AAED,4CAA4C;AAC5C,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IACjD,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,wBAAwB,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAEhD;AAID;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,GAAG,MAAM,CAerG;AAED,kDAAkD;AAClD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,GAAG,MAAM,CAErG;AAGD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAalD;AAED,gDAAgD;AAChD,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAElD;AAGD;;;GAGG;AACH,wBAAgB,MAAM,IAAI,MAAM,CAE/B;AAED,sCAAsC;AACtC,wBAAgB,MAAM,IAAI,MAAM,CAE/B;AAGD;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAE,OAAc,GAAG,MAAM,EAAE,CA4CvG;AAED,oDAAoD;AACpD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAE,OAAc,GAAG,MAAM,EAAE,CAEvG;AASD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oHAAoH;IACpH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iEAAiE;IACjE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAmBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,GAAE,gBAAqB,GAAG,GAAG,CAUhF;AA2DD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAGxE;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;AAE3D,kFAAkF;AAClF,eAAO,MAAM,6BAA6B,MAAM,CAAC;AA8BjD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,oBAAoB,CAChC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,aAAa,GAAE,MAAsC,GACtD,cAAc,CAchB;AAED,oDAAoD;AACpD,wBAAgB,oBAAoB,CAChC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,aAAa,GAAE,MAAsC,GACtD,cAAc,CAEhB;AA2BD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CA2B9F;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAYrE;AAkFD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAIlF;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAIjG;AAED,8CAA8C;AAC9C,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAEjG"}

package/dist/util.js

@@ -1130,21 +1130,88 @@ function getSingularForm(word) {
     return word;
 }
 /**
- * Converts a singular word to its plural form, handling common pluralization rules
- * and irregular plurals.
+ * Converts a singular name to its plural form. The head of the name is kept
+ * verbatim, including the separator that ends it, and only the tail is pluralized.
+ * The tail keeps its own case. A linear scan finds the tail: the last space,
+ * underscore, or hyphen, or else the last Unicode capital that starts a word.
+ * A regex over ASCII letters is not used, because it drops a leading character
+ * such as Ä and it erases the underscore that distinguishes user_profile from
+ * userProfile.
  *
- * @param singularName - The singular form of the word to pluralize.
- * @returns The plural form of the word.
+ * @param singularName - The singular form of the name to pluralize.
+ * @returns The plural form of the name.
  *
  * @example
  * ```typescript
- * generatePluralName('child'); // returns 'children'
- * generatePluralName('box'); // returns 'boxes'
- * generatePluralName('party'); // returns 'parties'
- * generatePluralName('dog'); // returns 'dogs'
+ * GeneratePluralName('child'); // returns 'children'
+ * GeneratePluralName('box'); // returns 'boxes'
+ * GeneratePluralName('party'); // returns 'parties'
+ * GeneratePluralName('dog'); // returns 'dogs'
+ * GeneratePluralName('Contact Person'); // returns 'Contact People'
+ * GeneratePluralName('user_profile', { capitalizeFirstLetterOnly: true }); // returns 'user_Profiles'
  * ```
  */
 export function GeneratePluralName(singularName, options) {
+    const name = singularName.trim();
+    if (name.length === 0)
+        return name;
+    const { head, tail } = splitPluralTail(name);
+    if (tail.length === 0) {
+        return options?.capitalizeEntireWord ? name.toUpperCase() : name;
+    }
+    // capitalizeEntireWord applies to the whole name, not only the tail.
+    const tailOptions = options?.capitalizeEntireWord
+        ? { ...options, capitalizeEntireWord: false }
+        : options;
+    const joined = head + pluralizeOneWord(tail, tailOptions);
+    return options?.capitalizeEntireWord ? joined.toUpperCase() : joined;
+}
+function isUnicodeLetter(ch) {
+    return ch.toLowerCase() !== ch.toUpperCase();
+}
+function isUnicodeUpper(ch) {
+    return isUnicodeLetter(ch) && ch === ch.toUpperCase();
+}
+function isUnicodeLower(ch) {
+    return isUnicodeLetter(ch) && ch === ch.toLowerCase();
+}
+/**
+ * Head is everything through the last separator, kept verbatim. With no
+ * separator, the tail starts at the last capital that begins a new word
+ * (a capital after a lowercase letter, or a capital whose next letter is
+ * lowercase, so an acronym stays on the head).
+ */
+function splitPluralTail(name) {
+    for (let i = name.length - 1; i >= 0; i--) {
+        const ch = name[i];
+        if (ch === ' ' || ch === '_' || ch === '-' || ch === '\t') {
+            return { head: name.slice(0, i + 1), tail: name.slice(i + 1) };
+        }
+    }
+    let tailStart = 0;
+    for (let i = 1; i < name.length; i++) {
+        const current = name[i];
+        if (!isUnicodeUpper(current))
+            continue;
+        const next = i + 1 < name.length ? name[i + 1] : '';
+        if (isUnicodeLower(name[i - 1]) || isUnicodeLower(next))
+            tailStart = i;
+    }
+    if (tailStart > 0)
+        return { head: name.slice(0, tailStart), tail: name.slice(tailStart) };
+    return { head: '', tail: name };
+}
+function matchTailCase(source, pluralLower) {
+    const letters = [...source].filter(isUnicodeLetter);
+    if (letters.length > 0 && letters.every(isUnicodeUpper))
+        return pluralLower.toUpperCase();
+    const first = source.charAt(0);
+    if (first && isUnicodeUpper(first)) {
+        return pluralLower.charAt(0).toUpperCase() + pluralLower.slice(1);
+    }
+    return pluralLower;
+}
+function pluralizeOneWord(singularName, options) {
     // Check if it's already plural
     const detectedSingular = getSingularForm(singularName);
     if (!detectedSingular) {
@@ -1158,10 +1225,11 @@ export function GeneratePluralName(singularName, options) {
         // but if we were passed a true singular, then we keep on going
         return AdjustCasing(singularName, options);
     }
-    // Check for irregular plurals
+    // The irregular map stores lowercase values. Restore the tail's case so
+    // "Person" becomes "People" and "PERSON" becomes "PEOPLE".
     const irregularPlural = GetIrregularPlural(singularName);
     if (irregularPlural) {
-        return AdjustCasing(irregularPlural, options);
+        return AdjustCasing(matchTailCase(singularName, irregularPlural), options);
     }
     // Handle common pluralization rules
     if (singularName.endsWith('y') && singularName.length > 1) {