@digitaldefiance/ecies-lib 2.1.2 → 2.1.3

package/src/errors/guid.d.ts

@@ -1,15 +0,0 @@
-import { GuidBrandType } from '../enumerations/guid-brand-type';
-import { GuidErrorType } from '../enumerations/guid-error-type';
-import { RawGuidUint8Array } from '../types';
-import { HandleableErrorOptions, TypedHandleableError } from '@digitaldefiance/i18n-lib';
-import { EciesStringKey } from '../enumerations/ecies-string-key';
-/**
- * Error class for handling GUID-related errors.
- */
-export declare class GuidError extends TypedHandleableError<typeof GuidErrorType, EciesStringKey> {
-    readonly brand?: GuidBrandType;
-    readonly length?: number;
-    readonly guid?: Uint8Array;
-    constructor(type: GuidErrorType, brand?: GuidBrandType, length?: number, guid?: RawGuidUint8Array | Uint8Array, options?: HandleableErrorOptions, language?: string);
-}
-//# sourceMappingURL=guid.d.ts.map

package/src/errors/guid.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"guid.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-ecies-lib/src/errors/guid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAkB,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACzG,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAGlE;;GAEG;AACH,qBAAa,SAAU,SAAQ,oBAAoB,CAAC,OAAO,aAAa,EAAE,cAAc,CAAC;IACvF,SAAgB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtC,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChC,SAAgB,IAAI,CAAC,EAAE,UAAU,CAAC;gBAGhC,IAAI,EAAE,aAAa,EACnB,KAAK,CAAC,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,iBAAiB,GAAG,UAAU,EACrC,OAAO,CAAC,EAAE,sBAAsB,EAChC,QAAQ,CAAC,EAAE,MAAM;CAyBpB"}

package/src/errors/guid.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GuidError = void 0;
-const guid_error_type_1 = require("../enumerations/guid-error-type");
-const i18n_lib_1 = require("@digitaldefiance/i18n-lib");
-const i18n_setup_1 = require("../i18n-setup");
-/**
- * Error class for handling GUID-related errors.
- */
-class GuidError extends i18n_lib_1.TypedHandleableError {
-    brand;
-    length;
-    guid;
-    constructor(type, brand, length, guid, options, language) {
-        const source = options?.cause instanceof Error ? options.cause : new Error();
-        super(i18n_setup_1.EciesComponentId, type, (0, i18n_lib_1.buildReasonMap)(guid_error_type_1.GuidErrorType, ['Error', 'GuidError'], new Set([guid_error_type_1.GuidErrorType.InvalidWithGuid, guid_error_type_1.GuidErrorType.UnknownBrand, guid_error_type_1.GuidErrorType.UnknownLength])), source, options, language, {
-            GUID: guid ? Array.from(guid).map(b => b.toString(16).padStart(2, '0')).join(' ') : '',
-            BRAND: String(brand) ?? '',
-            LENGTH: String(length) ?? '',
-        });
-        this.brand = brand;
-        this.length = length;
-        this.guid = guid;
-        this.name = 'GuidError';
-    }
-}
-exports.GuidError = GuidError;
-//# sourceMappingURL=guid.js.map

package/src/errors/guid.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"guid.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-ecies-lib/src/errors/guid.ts"],"names":[],"mappings":";;;AACA,qEAAgE;AAEhE,wDAAyG;AAEzG,8CAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,+BAA0D;IACvE,KAAK,CAAiB;IACtB,MAAM,CAAU;IAChB,IAAI,CAAc;IAElC,YACE,IAAmB,EACnB,KAAqB,EACrB,MAAe,EACf,IAAqC,EACrC,OAAgC,EAChC,QAAiB;QAEjB,MAAM,MAAM,GAAG,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;QAC7E,KAAK,CACH,6BAAgB,EAChB,IAAI,EACJ,IAAA,yBAAc,EACZ,+BAAa,EACb,CAAC,OAAO,EAAE,WAAW,CAAC,EACtB,IAAI,GAAG,CAAC,CAAC,+BAAa,CAAC,eAAe,EAAE,+BAAa,CAAC,YAAY,EAAE,+BAAa,CAAC,aAAa,CAAC,CAAC,CAClG,EACD,MAAM,EACN,OAAO,EACP,QAAQ,EACR;YACE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YACtF,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;YAC1B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;SAC7B,CACF,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC1B,CAAC;CACF;AApCD,8BAoCC"}

package/src/guid.d.ts

@@ -1,168 +0,0 @@
-import { GuidBrandType } from './enumerations/guid-brand-type';
-import { IGuidV4 } from './interfaces/guid';
-import { Base64Guid, BigIntGuid, FullHexGuid, MongoObjectIdGuid, MongoObjectIdHexString, RawGuidUint8Array, ShortHexGuid } from './types';
-import { ObjectId } from 'bson';
-export type { Base64Guid };
-export type GuidInput = string | FullHexGuid | ShortHexGuid | Base64Guid | BigIntGuid | MongoObjectIdGuid | RawGuidUint8Array | ObjectId | bigint | Uint8Array;
-/**
- * GuidV4 represents a GUID (Globally Unique Identifier) that is compliant with the RFC 4122 standard.
- * GuidV4 instances can be created from a variety of input types, including:
- * - FullHexGuid: A 36-character string representation of the GUID, including dashes
- * - ShortHexGuid: A 32-character string representation of the GUID, excluding dashes
- * - Base64Guid: A 24-character base64-encoded string representation of the GUID
- * - BigIntGuid: A bigint representation of the GUID
- * - RawGuidUint8Array: A 16-byte Uint8Array representation of the GUID
- * GuidV4 instances can be converted to any of these representations using the appropriate method.
- */
-export declare class GuidV4 implements IGuidV4 {
-    /**
-     * GUID is stored internally as a raw 16-byte Uint8Array.
-     */
-    private readonly _value;
-    constructor(value: GuidInput);
-    static isValid(value: string | FullHexGuid | ShortHexGuid | Base64Guid | BigIntGuid | MongoObjectIdGuid | RawGuidUint8Array): boolean;
-    static validateUuid(value: string): boolean;
-    serialize(): string;
-    static hydrate(value: string): GuidV4;
-    private static readonly LengthMap;
-    private static readonly ReverseLengthMap;
-    private static readonly VerifyFunctions;
-    /**
-     * Returns the GUID as a raw Uint8Array.
-     */
-    get asRawGuidUint8Array(): RawGuidUint8Array;
-    static new<TStringKey extends string, TLanguage extends string>(): GuidV4;
-    /**
-     * Creates a GuidV4 from a MongoDB ObjectId (BSON ObjectId or hex string)
-     * Pads the ObjectId to 32 characters to create a valid GUID
-     * @param objectId - BSON ObjectId instance or 24-character hex string
-     * @returns GuidV4 instance
-     */
-    static fromMongoObjectId(objectId: ObjectId | MongoObjectIdHexString | string): GuidV4;
-    /**
-     * Returns the GUID as a full hex string.
-     */
-    get asFullHexGuid(): FullHexGuid;
-    /**
-     * Returns the GUID as a raw Uint8Array.
-     */
-    get asUint8Array(): Uint8Array;
-    /**
-     * Returns the GUID as a short hex string.
-     */
-    get asShortHexGuid(): ShortHexGuid;
-    /**
-     * Returns the GUID as a base64 string.
-     */
-    toString(): Base64Guid;
-    /**
-     * Returns the GUID as a JSON string.
-     * @returns The GUID as a JSON string.
-     */
-    toJson(): string;
-    /**
-     * Returns the GUID as a bigint.
-     */
-    get asBigIntGuid(): BigIntGuid;
-    /**
-     * Returns the GUID as a base64 string.
-     */
-    get asBase64Guid(): Base64Guid;
-    /**
-     * Converts the GUID back to a MongoDB ObjectId hex string (24 characters)
-     * Strips the padding zeros that were added during conversion
-     * @returns 24-character hex string compatible with MongoDB ObjectId
-     */
-    get asMongoObjectId(): MongoObjectIdGuid;
-    /**
-     * Verifies if a given GUID is valid for the given brand.
-     * @param guidBrand The brand of the GUID to verify.
-     * @param guid The GUID to verify.
-     * @returns True if the GUID is valid for the given brand, false otherwise.
-     */
-    static verifyGuid(guidBrand: GuidBrandType, guid: GuidInput): boolean;
-    /**
-     * Returns the length of the GUID for the given brand.
-     * @param guidBrand The brand of the GUID to get the length for.
-     * @returns The length of the GUID for the given brand.
-     */
-    static guidBrandToLength<TStringKey extends string, TLanguage extends string>(guidBrand: GuidBrandType): number;
-    /**
-     * Returns the brand of the GUID for the given length.
-     * @param length The length of the GUID to get the brand for.
-     * @param isUint8Array Whether the GUID is a Uint8Array.
-     * @returns The brand of the GUID for the given length.
-     */
-    static lengthToGuidBrand<TStringKey extends string, TLanguage extends string>(length: number, isUint8Array: boolean): GuidBrandType;
-    /**
-     * Verifies if a given GUID is a valid full hex GUID.
-     * @param fullHexGuidValue The full hex GUID to verify.
-     * @returns True if the GUID is a valid full hex GUID, false otherwise.
-     */
-    static isFullHexGuid(fullHexGuidValue: GuidInput): boolean;
-    /**
-     * Verifies if a given GUID is a valid short hex GUID.
-     * @param shortHexGuidValue The short hex GUID to verify.
-     * @returns True if the GUID is a valid short hex GUID, false otherwise.
-     */
-    static isShortHexGuid(shortHexGuidValue: GuidInput): boolean;
-    /**
-     * Verifies if a given GUID is a valid base64 GUID.
-     * @param value The base64 GUID to verify.
-     * @returns True if the GUID is a valid base64 GUID, false otherwise.
-     */
-    static isBase64Guid(value: GuidInput): boolean;
-    /**
-     * Verifies if a given GUID is a valid raw GUID buffer.
-     * @param value The raw GUID buffer to verify.
-     * @returns True if the GUID is a valid raw GUID buffer, false otherwise.
-     */
-    static isRawGuidUint8Array(value: GuidInput): boolean;
-    /**
-     * Verifies if a given GUID is a valid bigint GUID.
-     * @param value The bigint GUID to verify.
-     * @returns True if the GUID is a valid bigint GUID, false otherwise.
-     */
-    static isBigIntGuid(value: GuidInput): boolean;
-    static isMongoObjectIdGuid(value: GuidInput): boolean;
-    /**
-     * Determines the brand of a given GUID value.
-     * @param value The GUID value to determine the brand of.
-     * @returns The brand of the GUID value.
-     */
-    static whichBrand(value: GuidInput): GuidBrandType;
-    /**
-     * Converts a given short hex GUID to a full hex GUID.
-     * @param shortGuid The short hex GUID to convert.
-     * @returns The short hex GUID as a full hex GUID.
-     */
-    private static shortGuidToFullGuid;
-    /**
-     * Converts a given GUID value to a full hex GUID.
-     * @param guid The GUID value to convert.
-     * @param dateCreated The date created for Mongoose IDs
-     * @returns The GUID value as a full hex GUID.
-     */
-    static toFullHexGuid<TStringKey extends string, TLanguage extends string>(guid: RawGuidUint8Array | BigIntGuid | Base64Guid | ShortHexGuid | FullHexGuid | MongoObjectIdGuid | ObjectId | string): FullHexGuid;
-    static toShortHexGuid<TStringKey extends string, TLanguage extends string>(guid: RawGuidUint8Array | BigIntGuid | Base64Guid | ShortHexGuid | FullHexGuid | ObjectId | string): ShortHexGuid;
-    /**
-     * Converts a given bigint to a full hex GUID.
-     * @param bigInt The bigint to convert.
-     * @returns The bigint as a full hex GUID.
-     */
-    static toFullHexFromBigInt<TStringKey extends string, TLanguage extends string>(bigInt: bigint): FullHexGuid;
-    /**
-     * Converts a given GUID value to a raw GUID buffer.
-     * @param value The GUID value to convert.
-     * @param dateCreated The date the GUID was created for Mongoose GUIDs
-     * @returns The GUID value as a raw GUID buffer.
-     */
-    static toRawGuidUint8Array<TStringKey extends string, TLanguage extends string>(value: GuidInput): RawGuidUint8Array;
-    /**
-     * Compare two GuidV4 instances
-     * @param other - The other GuidV4 instance to compare
-     * @returns True if the two GuidV4 instances are equal, false otherwise
-     */
-    equals(other: IGuidV4): boolean;
-}
-//# sourceMappingURL=guid.d.ts.map

package/src/guid.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"guid.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-ecies-lib/src/guid.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAG/D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EACL,UAAU,EACV,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAIhC,YAAY,EAAE,UAAU,EAAE,CAAC;AAG3B,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,WAAW,GACX,YAAY,GACZ,UAAU,GACV,UAAU,GACV,iBAAiB,GACjB,iBAAiB,GACjB,QAAQ,GACR,MAAM,GACN,UAAU,CAAC;AAEf;;;;;;;;;GASG;AACH,qBAAa,MAAO,YAAW,OAAO;IACpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;gBAC/B,KAAK,EAAE,SAAS;WA+Cd,OAAO,CACnB,KAAK,EACD,MAAM,GACN,WAAW,GACX,YAAY,GACZ,UAAU,GACV,UAAU,GACV,iBAAiB,GACjB,iBAAiB;WAmCT,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAI3C,SAAS,IAAI,MAAM;WAIZ,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAQ/B;IAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAOtC;IAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAarC;IAEF;;OAEG;IACH,IAAW,mBAAmB,IAAI,iBAAiB,CAElD;WACa,GAAG,CACf,UAAU,SAAS,MAAM,EACzB,SAAS,SAAS,MAAM,KACrB,MAAM;IAoBX;;;;;OAKG;WACW,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,sBAAsB,GAAG,MAAM,GAAG,MAAM;IAkB7F;;OAEG;IACH,IAAW,aAAa,IAAI,WAAW,CAEtC;IACD;;OAEG;IACH,IAAW,YAAY,IAAI,UAAU,CAEpC;IACD;;OAEG;IACH,IAAW,cAAc,IAAI,YAAY,CAExC;IACD;;OAEG;IACI,QAAQ,IAAI,UAAU;IAG7B;;;OAGG;IACI,MAAM,IAAI,MAAM;IAGvB;;OAEG;IACH,IAAW,YAAY,IAAI,UAAU,CAGpC;IACD;;OAEG;IACH,IAAW,YAAY,IAAI,UAAU,CAEpC;IAED;;;;OAIG;IACH,IAAW,eAAe,IAAI,iBAAiB,CAK9C;IAED;;;;;OAKG;WACW,UAAU,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO;IAY5E;;;;OAIG;WACW,iBAAiB,CAC7B,UAAU,SAAS,MAAM,EACzB,SAAS,SAAS,MAAM,EACxB,SAAS,EAAE,aAAa,GAAG,MAAM;IAWnC;;;;;OAKG;WACW,iBAAiB,CAC7B,UAAU,SAAS,MAAM,EACzB,SAAS,SAAS,MAAM,EACxB,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,aAAa;IA6BvD;;;;OAIG;WACW,aAAa,CAAC,gBAAgB,EAAE,SAAS,GAAG,OAAO;IAuBjE;;;;OAIG;WACW,cAAc,CAAC,iBAAiB,EAAE,SAAS,GAAG,OAAO;IA6BnE;;;;OAIG;WACW,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAuCrD;;;;OAIG;WACW,mBAAmB,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAwC5D;;;;OAIG;WACW,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;WA+BvC,mBAAmB,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAyB5D;;;;OAIG;WACW,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,aAAa;IAoCzD;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IASlC;;;;;OAKG;WACW,aAAa,CACzB,UAAU,SAAS,MAAM,EACzB,SAAS,SAAS,MAAM,EAExB,IAAI,EACA,iBAAiB,GACjB,UAAU,GACV,UAAU,GACV,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,QAAQ,GACR,MAAM,GACT,WAAW;WAoDA,cAAc,CAC1B,UAAU,SAAS,MAAM,EACzB,SAAS,SAAS,MAAM,EAExB,IAAI,EACA,iBAAiB,GACjB,UAAU,GACV,UAAU,GACV,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,MAAM,GACT,YAAY;IAkDf;;;;OAIG;WACW,mBAAmB,CAC/B,UAAU,SAAS,MAAM,EACzB,SAAS,SAAS,MAAM,EACxB,MAAM,EAAE,MAAM,GAAG,WAAW;IAyB9B;;;;;OAKG;WACW,mBAAmB,CAC/B,UAAU,SAAS,MAAM,EACzB,SAAS,SAAS,MAAM,EACxB,KAAK,EAAE,SAAS,GAAG,iBAAiB;IAwEtC;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;CASvC"}