rich-domain/core/id.js

This package provide utils file and interfaces to assistant build a complex application with domain driving design

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Id = exports.Uid = exports.id = exports.ID = void 0;
const crypto_1 = require("./crypto");
/**
 * @description Represents a unique identifier for Entities or Aggregates, providing methods
 * to generate and manipulate ID values, including the ability to create new IDs, convert them
 * to a shorter format, clone them, and check for equality.
 */
class ID {
    _value;
    _isNew;
    _createdAt;
    MAX_SIZE = 16;
    constructor(id) {
        this._createdAt = new Date();
        if (typeof id === 'undefined') {
            const uuid = (0, crypto_1.UUID)();
            this._value = uuid;
            this._isNew = true;
            return this;
        }
        const isString = typeof id === 'string';
        this._value = isString ? id : String(id);
        this._isNew = false;
        return this;
    }
    ;
    /**
     * @description Marks the current ID as new.
     * @private
     */
    setAsNew() {
        this._isNew = true;
    }
    /**
     * @description Convert the current ID value into a shortened, 16-byte version.
     * If the current ID value is shorter than 16 bytes, a UUID is prepended to ensure
     * sufficient length.
     * @returns An updated `ID` instance with a short, 16-byte value.
     */
    toShort() {
        let short = '';
        let longValue = this._value;
        if (longValue.length < this.MAX_SIZE) {
            longValue = (0, crypto_1.UUID)() + longValue;
        }
        longValue = longValue.toUpperCase().replace(/-/g, '');
        const chars = longValue.split('');
        while (short.length < this.MAX_SIZE) {
            const lastChar = chars.pop();
            short = lastChar + short;
        }
        this._createdAt = new Date();
        this._value = short;
        return this;
    }
    /**
     * @description Retrieves the current ID value.
     * @returns The ID value as a string.
     */
    value() {
        return this._value;
    }
    /**
     * @description Indicates whether this `ID` instance was created as a new,
     * previously uninitialized ID (no value passed to `create()`), or if it was
     * initialized from a provided value.
     * @returns `true` if the ID is new; otherwise, `false`.
     *
     * @example
     * ```typescript
     * ID.create("some-value").isNew(); // returns false
     * ID.create().isNew(); // returns true, since no argument was provided
     * ```
     */
    isNew() {
        return this._isNew;
    }
    /**
     * @description Retrieves the creation date of this `ID` instance.
     * @returns The `Date` object representing when this ID was created or last modified.
     */
    createdAt() {
        return this._createdAt;
    }
    /**
     * @description Checks if the current ID is short (16 bytes).
     * @returns `true` if the ID is 16 bytes long, `false` otherwise.
     */
    isShort() {
        return this._value.length === this.MAX_SIZE;
    }
    /**
     * @description Compares the current ID against another `UID` instance by value.
     * @param id Another `UID` to compare to.
     * @returns `true` if both IDs share the same value type and string value, otherwise `false`.
     */
    equal(id) {
        return (typeof this._value === typeof id?.value()) && (this._value === id?.value());
    }
    /**
     * @description Alias for `equal`. Compares the current ID against another `UID` instance by value.
     * @param id Another `UID` to compare to.
     * @returns `true` if both IDs share the same value, otherwise `false`.
     */
    isEqual(id) {
        return this.equal(id);
    }
    /**
     * @description Performs a deep comparison by serializing both IDs and checking if
     * the JSON representation is identical.
     * @param id Another `UID` to compare to.
     * @returns `true` if both IDs are deeply equal; otherwise `false`.
     */
    deepEqual(id) {
        const A = JSON.stringify(this);
        const B = JSON.stringify(id);
        return A === B;
    }
    /**
     * @description Creates a new `UID` instance cloned from the current one, but marks
     * the new clone as a new ID.
     * @returns A cloned `UID` instance that is considered new.
     */
    cloneAsNew() {
        const newUUID = new ID(this._value);
        newUUID.setAsNew();
        return newUUID;
    }
    /**
     * @description Creates a clone of the current `UID` instance with the same value
     * and properties, but without marking it as new.
     * @returns A cloned `UID` instance identical to the current one.
     */
    clone() {
        return new ID(this._value);
    }
    /**
     * @description Creates a new short (16-byte) ID. If no `id` value is provided,
     * a new UUID is generated and then shortened.
     * @param id An optional string or number to use as the base value.
     * @returns A `UID` instance with a short, 16-byte value.
     */
    static short(id) {
        const _id = new ID(id);
        if (typeof id === 'undefined')
            _id.setAsNew();
        _id.toShort();
        return _id;
    }
    ;
    /**
     * @description Creates a new `ID` instance. If no `id` value is provided, a new
     * UUID is generated. If an `id` is provided, that value is used directly.
     * @param id Optional value to initialize the ID with. If not provided, a new UUID is created.
     * @returns A `UID` instance.
     */
    static create(id) {
        return new ID(id);
    }
}
exports.ID = ID;
exports.default = ID;
exports.id = ID;
exports.Uid = ID.create;
exports.Id = ID.create;
//# sourceMappingURL=id.js.map