@memberjunction/global 2.111.0 → 2.112.0

package/dist/generic/interfaces.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AllMetadata = exports.EntityRecordNameResult = exports.EntityRecordNameInput = exports.EntityMergeOptions = exports.EntityDeleteOptions = exports.EntitySaveOptions = exports.PotentialDuplicateResponse = exports.PotentialDuplicateResult = exports.PotentialDuplicateRequest = exports.PotentialDuplicate = exports.ProviderType = exports.MetadataInfo = exports.ProviderConfigDataBase = void 0;
+const compositeKey_1 = require("./compositeKey");
+/**
+ * Base configuration class for data providers.
+ * Contains schema inclusion/exclusion rules and configuration data.
+ * Used to configure which database schemas should be included or excluded from metadata scanning.
+ */
+class ProviderConfigDataBase {
+    get Data() {
+        return this._data;
+    }
+    get IncludeSchemas() {
+        return this._includeSchemas;
+    }
+    get MJCoreSchemaName() {
+        return this._MJCoreSchemaName;
+    }
+    get ExcludeSchemas() {
+        return this._excludeSchemas;
+    }
+    get IgnoreExistingMetadata() {
+        return this._ignoreExistingMetadata;
+    }
+    /**
+     * Constructor for ProviderConfigDataBase
+     * @param data
+     * @param MJCoreSchemaName
+     * @param includeSchemas
+     * @param excludeSchemas
+     * @param ignoreExistingMetadata if set to true, even if a global provider is already registered for the Metadata static Provider member, this class will still load up fresh metadata for itself. By default this is off and a class will use existing loaded metadata if it exists
+     */
+    constructor(data, MJCoreSchemaName = '__mj', includeSchemas, excludeSchemas, ignoreExistingMetadata = true) {
+        this._includeSchemas = [];
+        this._excludeSchemas = [];
+        this._MJCoreSchemaName = '__mj';
+        this._ignoreExistingMetadata = false;
+        this._data = data;
+        this._MJCoreSchemaName = MJCoreSchemaName;
+        if (includeSchemas)
+            this._includeSchemas = includeSchemas;
+        if (excludeSchemas)
+            this._excludeSchemas = excludeSchemas;
+        this._ignoreExistingMetadata = ignoreExistingMetadata;
+    }
+}
+exports.ProviderConfigDataBase = ProviderConfigDataBase;
+/**
+ * Information about metadata timestamps and record counts.
+ * Used to track when metadata was last updated and how many records exist.
+ * Helps determine if local metadata cache is up-to-date with the server.
+ */
+class MetadataInfo {
+}
+exports.MetadataInfo = MetadataInfo;
+exports.ProviderType = {
+    Database: 'Database',
+    Network: 'Network',
+};
+/**
+ * Represents a potential duplicate record with its probability score.
+ * Extends CompositeKey to support multi-field primary keys.
+ * Used in duplicate detection and record merging operations.
+ */
+class PotentialDuplicate extends compositeKey_1.CompositeKey {
+}
+exports.PotentialDuplicate = PotentialDuplicate;
+/**
+ * Request parameters for finding potential duplicate records.
+ * Supports various matching strategies including list-based and document-based comparisons.
+ * Can use either a pre-defined list or entity document for duplicate detection.
+ */
+class PotentialDuplicateRequest {
+}
+exports.PotentialDuplicateRequest = PotentialDuplicateRequest;
+/**
+ * Result of a potential duplicate search for a single record.
+ * Contains the record being checked and all potential duplicates found.
+ * Includes match details and duplicate run information for tracking.
+ */
+class PotentialDuplicateResult {
+    constructor() {
+        this.RecordCompositeKey = new compositeKey_1.CompositeKey();
+        this.Duplicates = [];
+        this.DuplicateRunDetailMatchRecordIDs = [];
+    }
+}
+exports.PotentialDuplicateResult = PotentialDuplicateResult;
+/**
+ * Response wrapper for potential duplicate searches.
+ * Includes status information and array of results.
+ * Status can be 'Inprogress' for asynchronous operations, 'Success' when complete, or 'Error' on failure.
+ */
+class PotentialDuplicateResponse {
+}
+exports.PotentialDuplicateResponse = PotentialDuplicateResponse;
+/**
+ * Save options used when saving an entity record.
+ * Provides fine-grained control over the save operation including validation,
+ * action execution, and conflict detection.
+ */
+class EntitySaveOptions {
+    constructor() {
+        /**
+         * If set to true, the record will be saved to the database even if nothing is detected to be "dirty" or changed since the prior load.
+         */
+        this.IgnoreDirtyState = false;
+        /**
+         * If set to true, an AI actions associated with the entity will be skipped during the save operation
+         */
+        this.SkipEntityAIActions = false;
+        /**
+         * If set to true, any Entity Actions associated with invocation types of Create or Update will be skipped during the save operation
+         */
+        this.SkipEntityActions = false;
+        /**
+         * When set to true, the save operation will BYPASS Validate() and the actual process of saving changes to the database but WILL invoke any associated actions (AI Actions, Entity Actions, etc...)
+         * Subclasses can also override the Save() method to provide custom logic that will be invoked when ReplayOnly is set to true
+         */
+        this.ReplayOnly = false;
+        /**
+         * Setting this to true means that the system will not look for inconsistency between the state of the record at the time it was loaded and the current database version of the record. This is normally on
+         * because it is a good way to prevent overwriting changes made by other users that happened after your version of the record was loaded. However, in some cases, you may want to skip this check, such as when you are
+         * updating a record that you know has not been changed by anyone else since you loaded it. In that case, you can set this property to true to skip the check which will be more efficient.
+         * * IMPORTANT: This is only used for client-side providers. On server-side providers, this check never occurs because server side operations are as up to date as this check would yield.
+         */
+        this.SkipOldValuesCheck = false;
+        /**
+         * When set to true, the entity will skip the asynchronous ValidateAsync() method during save.
+         * This is an advanced setting and should only be used when you are sure the async validation is not needed.
+         * The default behavior is to run the async validation and the default value is undefined.
+         * Also, you can set an Entity level default in a BaseEntity subclass by overriding the DefaultSkipAsyncValidation() getter property.
+         * @see BaseEntity.DefaultSkipAsyncValidation
+         */
+        this.SkipAsyncValidation = undefined;
+    }
+}
+exports.EntitySaveOptions = EntitySaveOptions;
+/**
+ * Options used when deleting an entity record.
+ * Controls whether associated actions and AI operations should be executed
+ * during the deletion process.
+ */
+class EntityDeleteOptions {
+    constructor() {
+        /**
+         * If set to true, an AI actions associated with the entity will be skipped during the delete operation
+         */
+        this.SkipEntityAIActions = false;
+        /**
+         * If set to true, any Entity Actions associated with invocation types of Delete will be skipped during the delete operation
+         */
+        this.SkipEntityActions = false;
+        /**
+         * When set to true, the save operation will BYPASS Validate() and the actual process of deleting the record from the database but WILL invoke any associated actions (AI Actions, Entity Actions, etc...)
+         * Subclasses can also override the Delete() method to provide custom logic that will be invoked when ReplayOnly is set to true
+         */
+        this.ReplayOnly = false;
+    }
+}
+exports.EntityDeleteOptions = EntityDeleteOptions;
+/**
+ * Options used when merging entity records.
+ * Controls transaction isolation and other merge-specific behaviors.
+ */
+class EntityMergeOptions {
+}
+exports.EntityMergeOptions = EntityMergeOptions;
+/**
+ * Input parameters for retrieving entity record names.
+ * Used for batch operations to get display names for multiple records.
+ */
+class EntityRecordNameInput {
+}
+exports.EntityRecordNameInput = EntityRecordNameInput;
+/**
+ * Result of an entity record name lookup operation.
+ * Contains the display name and status information for the requested record.
+ */
+class EntityRecordNameResult {
+}
+exports.EntityRecordNameResult = EntityRecordNameResult;
+/**
+ * AllMetadata is used to pass all metadata around in a single object for convenience and type safety.
+ * Contains all system metadata collections including entities, applications, security, and queries.
+ * This class provides a centralized way to access all MemberJunction metadata.
+ */
+class AllMetadata {
+    constructor() {
+        this.CurrentUser = null;
+        // Arrays of Metadata below
+        this.AllEntities = [];
+        this.AllApplications = [];
+        this.AllRoles = [];
+        this.AllRowLevelSecurityFilters = [];
+        this.AllAuditLogTypes = [];
+        this.AllAuthorizations = [];
+        this.AllQueryCategories = [];
+        this.AllQueries = [];
+        this.AllQueryFields = [];
+        this.AllQueryPermissions = [];
+        this.AllQueryEntities = [];
+        this.AllQueryParameters = [];
+        this.AllEntityDocumentTypes = [];
+        this.AllLibraries = [];
+        this.AllExplorerNavigationItems = [];
+    }
+}
+exports.AllMetadata = AllMetadata;
+//# sourceMappingURL=interfaces.js.map

package/dist/generic/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/generic/interfaces.ts"],"names":[],"mappings":";;;AAUA,iDAA8C;AAG9C;;;;GAIG;AACH,MAAa,sBAAsB;IAO/B,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,IAAW,gBAAgB;QACvB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IACD,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,IAAW,sBAAsB;QAC7B,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,IAAO,EAAE,mBAA2B,MAAM,EAAE,cAAyB,EAAE,cAAyB,EAAE,yBAAkC,IAAI;QA9B5I,oBAAe,GAAa,EAAE,CAAC;QAC/B,oBAAe,GAAa,EAAE,CAAC;QAC/B,sBAAiB,GAAW,MAAM,CAAC;QAEnC,4BAAuB,GAAY,KAAK,CAAC;QA2B7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,cAAc;YACd,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QAC1C,IAAI,cAAc;YACd,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QAC1C,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAC;IAC1D,CAAC;CACJ;AAxCD,wDAwCC;AAED;;;;GAIG;AACH,MAAa,YAAY;CAKxB;AALD,oCAKC;AAEY,QAAA,YAAY,GAAG;IACxB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;CACZ,CAAC;AAKX;;;;GAIG;AACH,MAAa,kBAAmB,SAAQ,2BAAY;CAEnD;AAFD,gDAEC;AAED;;;;GAIG;AACH,MAAa,yBAAyB;CA2BrC;AA3BD,8DA2BC;AAED;;;;GAIG;AACH,MAAa,wBAAwB;IAEjC;QACI,IAAI,CAAC,kBAAkB,GAAG,IAAI,2BAAY,EAAE,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,gCAAgC,GAAG,EAAE,CAAC;IAC/C,CAAC;CAMJ;AAZD,4DAYC;AAED;;;;GAIG;AACH,MAAa,0BAA0B;CAItC;AAJD,gEAIC;AAmBD;;;;GAIG;AACH,MAAa,iBAAiB;IAA9B;QACI;;WAEG;QACH,qBAAgB,GAAY,KAAK,CAAC;QAClC;;WAEG;QACH,wBAAmB,GAAa,KAAK,CAAC;QACtC;;WAEG;QACH,sBAAiB,GAAa,KAAK,CAAC;QACpC;;;WAGG;QACH,eAAU,GAAa,KAAK,CAAC;QAC7B;;;;;WAKG;QACH,uBAAkB,GAAa,KAAK,CAAC;QAErC;;;;;;WAMG;QACH,wBAAmB,GAAa,SAAS,CAAC;IAC9C,CAAC;CAAA;AAlCD,8CAkCC;AAED;;;;GAIG;AACH,MAAa,mBAAmB;IAAhC;QACI;;WAEG;QACH,wBAAmB,GAAa,KAAK,CAAC;QAEtC;;WAEG;QACH,sBAAiB,GAAa,KAAK,CAAC;QAEpC;;;WAGG;QACH,eAAU,GAAa,KAAK,CAAC;IACjC,CAAC;CAAA;AAhBD,kDAgBC;AAED;;;GAGG;AACH,MAAa,kBAAkB;CAE9B;AAFD,gDAEC;AAED;;;GAGG;AACH,MAAa,qBAAqB;CAGjC;AAHD,sDAGC;AAED;;;GAGG;AACH,MAAa,sBAAsB;CAMjC;AANF,wDAME;AAkbF;;;;GAIG;AACH,MAAa,WAAW;IAAxB;QACI,gBAAW,GAAa,IAAI,CAAC;QAE7B,2BAA2B;QAC3B,gBAAW,GAAiB,EAAE,CAAC;QAC/B,oBAAe,GAAsB,EAAE,CAAC;QACxC,aAAQ,GAAe,EAAE,CAAC;QAC1B,+BAA0B,GAAiC,EAAE,CAAC;QAC9D,qBAAgB,GAAuB,EAAE,CAAC;QAC1C,sBAAiB,GAAwB,EAAE,CAAC;QAC5C,uBAAkB,GAAwB,EAAE,CAAC;QAC7C,eAAU,GAAgB,EAAE,CAAC;QAC7B,mBAAc,GAAqB,EAAE,CAAC;QACtC,wBAAmB,GAA0B,EAAE,CAAC;QAChD,qBAAgB,GAAsB,EAAE,CAAC;QACzC,uBAAkB,GAAyB,EAAE,CAAC;QAC9C,2BAAsB,GAA6B,EAAE,CAAC;QACtD,iBAAY,GAAkB,EAAE,CAAC;QACjC,+BAA0B,GAA6B,EAAE,CAAC;IAC9D,CAAC;CAAA;AAnBD,kCAmBC"}

package/dist/generic/libraryInfo.d.ts

@@ -0,0 +1,40 @@
+import { BaseInfo } from "./baseInfo";
+/**
+ * Metadata about a single library that's available for code generation or other purposes.
+ */
+export declare class LibraryInfo extends BaseInfo {
+    ID: string;
+    /**
+     * Name of the library - used for import statements and within package.json
+     */
+    Name: string;
+    /**
+     * User readable/AI readable description of the library
+     */
+    Description: string;
+    /**
+     * Only Active libraries are used for new code generation but disabling a library means it won't be used for new code generation, but doesn't remove it from use from previously generated code.
+     */
+    Status: 'Pending' | 'Active' | 'Disabled';
+    /**
+     * Comma-delimted list of items that are exported from the library such as classes, functions, types, etc.
+     */
+    ExportedItems: string;
+    /**
+     * Code definitions for the types that are exported from the library
+     */
+    TypeDefinitions: string;
+    /**
+     * Sample code that demonstrates how to use the library
+     */
+    SampleCode: string;
+    __mj_CreatedAt: Date;
+    __mj_UpdatedAt: Date;
+    private _exportItemsArray;
+    /**
+     * Helper method to get the ExportedItems as an array of strings, parsing the comma delimited string in the ExportedItems property
+     */
+    get ExportItemsArray(): string[];
+    constructor(initData?: any);
+}
+//# sourceMappingURL=libraryInfo.d.ts.map

package/dist/generic/libraryInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"libraryInfo.d.ts","sourceRoot":"","sources":["../../src/generic/libraryInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC;;GAEG;AACH,qBAAa,WAAY,SAAQ,QAAQ;IAC9B,EAAE,EAAE,MAAM,CAAQ;IACzB;;OAEG;IACI,IAAI,EAAE,MAAM,CAAQ;IAC3B;;OAEG;IACI,WAAW,EAAE,MAAM,CAAQ;IAClC;;OAEG;IACI,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAQ;IACxD;;OAEG;IACI,aAAa,EAAE,MAAM,CAAQ;IACpC;;OAEG;IACI,eAAe,EAAE,MAAM,CAAQ;IACtC;;OAEG;IACI,UAAU,EAAE,MAAM,CAAQ;IACjC,cAAc,EAAE,IAAI,CAAO;IAC3B,cAAc,EAAE,IAAI,CAAO;IAE3B,OAAO,CAAC,iBAAiB,CAAkB;IAC3C;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,EAAE,CAQtC;gBAEW,QAAQ,GAAE,GAAU;CAMnC"}

package/dist/generic/libraryInfo.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LibraryInfo = void 0;
+const baseInfo_1 = require("./baseInfo");
+/**
+ * Metadata about a single library that's available for code generation or other purposes.
+ */
+class LibraryInfo extends baseInfo_1.BaseInfo {
+    /**
+     * Helper method to get the ExportedItems as an array of strings, parsing the comma delimited string in the ExportedItems property
+     */
+    get ExportItemsArray() {
+        if (!this._exportItemsArray && this.ExportedItems && this.ExportedItems.length > 0) {
+            this._exportItemsArray = this.ExportedItems.split(',').map(item => item.trim());
+        }
+        else
+            this._exportItemsArray = [];
+        return this._exportItemsArray;
+    }
+    constructor(initData = null) {
+        super();
+        this.ID = null;
+        /**
+         * Name of the library - used for import statements and within package.json
+         */
+        this.Name = null;
+        /**
+         * User readable/AI readable description of the library
+         */
+        this.Description = null;
+        /**
+         * Only Active libraries are used for new code generation but disabling a library means it won't be used for new code generation, but doesn't remove it from use from previously generated code.
+         */
+        this.Status = null;
+        /**
+         * Comma-delimted list of items that are exported from the library such as classes, functions, types, etc.
+         */
+        this.ExportedItems = null;
+        /**
+         * Code definitions for the types that are exported from the library
+         */
+        this.TypeDefinitions = null;
+        /**
+         * Sample code that demonstrates how to use the library
+         */
+        this.SampleCode = null;
+        this.__mj_CreatedAt = null;
+        this.__mj_UpdatedAt = null;
+        this._exportItemsArray = null;
+        if (initData) {
+            this.copyInitData(initData);
+        }
+    }
+}
+exports.LibraryInfo = LibraryInfo;
+//# sourceMappingURL=libraryInfo.js.map

package/dist/generic/libraryInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"libraryInfo.js","sourceRoot":"","sources":["../../src/generic/libraryInfo.ts"],"names":[],"mappings":";;;AAAA,yCAAqC;AAErC;;GAEG;AACH,MAAa,WAAY,SAAQ,mBAAQ;IA8BrC;;OAEG;IACH,IAAW,gBAAgB;QACvB,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjF,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACpF,CAAC;;YAEG,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAEhC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED,YAAY,WAAgB,IAAI;QAC5B,KAAK,EAAE,CAAC;QA3CL,OAAE,GAAW,IAAI,CAAC;QACzB;;WAEG;QACI,SAAI,GAAW,IAAI,CAAC;QAC3B;;WAEG;QACI,gBAAW,GAAW,IAAI,CAAC;QAClC;;WAEG;QACI,WAAM,GAAsC,IAAI,CAAC;QACxD;;WAEG;QACI,kBAAa,GAAW,IAAI,CAAC;QACpC;;WAEG;QACI,oBAAe,GAAW,IAAI,CAAC;QACtC;;WAEG;QACI,eAAU,GAAW,IAAI,CAAC;QACjC,mBAAc,GAAS,IAAI,CAAA;QAC3B,mBAAc,GAAS,IAAI,CAAA;QAEnB,sBAAiB,GAAa,IAAI,CAAC;QAgBvC,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;CACJ;AAjDD,kCAiDC"}

package/dist/generic/logging.d.ts

@@ -0,0 +1,179 @@
+/**
+ * Logs a debug message using the default 'MJGlobal' namespace logger.
+ *
+ * This function wraps the debug library's logger for the 'MJGlobal' namespace.
+ * It accepts any number of arguments and forwards them directly to the underlying
+ * debug logger. This provides a simple, out-of-the-box logging function for the MJGlobal library.
+ *
+ * @param {...any} args - The messages or objects to be logged.
+ *
+ * @example
+ * LogDebug('Initialization complete, version %s', '1.0.0');
+ */
+export declare function LogDebug(...args: any[]): void;
+/**
+ * Options for the enhanced LogErrorEx function
+ */
+export interface LogErrorOptions {
+    /** The error message */
+    message: string;
+    /** Optional file name to log to */
+    logToFileName?: string;
+    /** Additional arguments to pass to console.error (varargs) */
+    additionalArgs?: any[];
+    /** Error severity level */
+    severity?: 'warning' | 'error' | 'critical';
+    /** Category for filtering logs */
+    category?: string;
+    /** The actual error object */
+    error?: Error;
+    /** Additional metadata about the error */
+    metadata?: Record<string, any>;
+    /** Whether to include stack trace */
+    includeStack?: boolean;
+}
+/**
+ * Enhanced error logging function with structured error information.
+ *
+ * Provides rich error logging capabilities including severity levels, categories,
+ * error objects with stack traces, metadata, and varargs support.
+ *
+ * @param options - Error logging options or a simple string message for backward compatibility
+ *
+ * @example
+ * // Simple string message
+ * LogErrorEx('Something went wrong');
+ *
+ * @example
+ * // With error object and metadata
+ * LogErrorEx({
+ *   message: 'Failed to process request',
+ *   error: new Error('Network timeout'),
+ *   severity: 'critical',
+ *   category: 'NetworkError',
+ *   metadata: {
+ *     url: 'https://api.example.com',
+ *     timeout: 5000
+ *   }
+ * });
+ *
+ * @example
+ * // With additional arguments (varargs)
+ * LogErrorEx({
+ *   message: 'Multiple values failed',
+ *   additionalArgs: [value1, value2, value3]
+ * });
+ */
+export declare function LogErrorEx(options: LogErrorOptions | string): void;
+export declare function LogError(message: any, logToFileName?: string | null, ...args: any[]): void;
+/**
+ * Options for the enhanced LogStatusEx function
+ */
+export interface LogStatusOptions {
+    /** The message to log */
+    message: string;
+    /** Optional file name to log to */
+    logToFileName?: string;
+    /** Additional arguments to pass to console.log (varargs) */
+    additionalArgs?: any[];
+    /** If true, only logs when verbose mode is enabled */
+    verboseOnly?: boolean;
+    /** Optional custom function to check if verbose logging is enabled */
+    isVerboseEnabled?: () => boolean;
+    /** Severity level for future extensibility */
+    severity?: SeverityType;
+    /** Category for filtering logs */
+    category?: string;
+}
+/**
+ * Enhanced status logging function with verbose control and extensibility.
+ *
+ * Provides flexible logging with verbose mode support, custom verbose checks,
+ * categories, severity levels, and varargs support. Messages can be conditionally
+ * logged based on global or custom verbose settings.
+ *
+ * @param options - Logging options or a simple string message for backward compatibility
+ *
+ * @example
+ * // Simple string message
+ * LogStatusEx('Operation completed');
+ *
+ * @example
+ * // Verbose-only message with global check
+ * LogStatusEx({
+ *   message: 'Detailed trace information',
+ *   verboseOnly: true
+ * });
+ *
+ * @example
+ * // With custom verbose check and additional args
+ * LogStatusEx({
+ *   message: 'Processing items:',
+ *   verboseOnly: true,
+ *   isVerboseEnabled: () => params.verbose === true,
+ *   additionalArgs: [item1, item2, item3]
+ * });
+ *
+ * @example
+ * // With category and file logging
+ * LogStatusEx({
+ *   message: 'Batch processing complete',
+ *   category: 'BatchJob',
+ *   logToFileName: '/logs/batch.log'
+ * });
+ */
+export declare function LogStatusEx(options: LogStatusOptions | string): void;
+/**
+ * Checks if verbose logging is enabled globally
+ * Works in both Node.js and Browser environments
+ * @returns true if verbose logging is enabled
+ */
+export declare function IsVerboseLoggingEnabled(): boolean;
+/**
+ * Sets verbose logging mode in browser environments
+ * @param enabled Whether to enable verbose logging
+ */
+export declare function SetVerboseLogging(enabled: boolean): void;
+export declare function LogStatus(message: any, logToFileName?: string, ...args: any[]): void;
+export declare function GetProductionStatus(): boolean;
+export declare function SetProductionStatus(isProduction: boolean): void;
+export declare function FormatConsoleMessage(message: string, serverity: SeverityType): string;
+export declare function FormatFileMessage(message: string, serverity: SeverityType): string;
+export declare const SeverityType: {
+    readonly Trace: "Trace";
+    readonly Debug: "Debug";
+    readonly Info: "Info";
+    readonly Warning: "Warning";
+    readonly Critical: "Critical";
+};
+export type SeverityType = typeof SeverityType[keyof typeof SeverityType];
+/**
+ * Enum of console colors that can be used to update the console line color.
+ */
+export declare const ConsoleColor: {
+    readonly black: "black";
+    readonly red: "red";
+    readonly green: "green";
+    readonly yellow: "yellow";
+    readonly blue: "blue";
+    readonly magenta: "magenta";
+    readonly cyan: "cyan";
+    readonly white: "white";
+    readonly gray: "gray";
+    readonly crimson: "crimson";
+};
+type ConsoleColor = typeof ConsoleColor[keyof typeof ConsoleColor];
+/**
+ * Helper function to get the ANSI color code for the given console color.
+ * @param color
+ */
+export declare function getAnsiColorCode(color: ConsoleColor): number;
+/**
+ * Utility function that udpates the current console line with the provided message and color.
+ * @param message
+ * @param color
+ */
+export declare function UpdateCurrentConsoleLine(message: string, color?: ConsoleColor): void;
+export declare function UpdateCurrentConsoleProgress(message: string, current: number, total: number, color?: ConsoleColor): void;
+export {};
+//# sourceMappingURL=logging.d.ts.map

package/dist/generic/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../../src/generic/logging.ts"],"names":[],"mappings":"AAiBA;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAG7C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;IAEhB,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,GAAG,EAAE,CAAC;IAEvB,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;IAE5C,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,GAAG,IAAI,CAuClE;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,aAAa,GAAE,MAAM,GAAG,IAAW,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,QAOzF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAEhB,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,4DAA4D;IAC5D,cAAc,CAAC,EAAE,GAAG,EAAE,CAAC;IAEvB,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,MAAM,OAAO,CAAC;IAEjC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,CAqBpE;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,OAAO,CAqCjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CASxD;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,aAAa,GAAE,MAAa,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,QAQnF;AAkBD,wBAAgB,mBAAmB,IAAI,OAAO,CAa7C;AAED,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,OAAO,QAExD;AAUD,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,MAAM,CAarF;AAMD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,MAAM,CAelF;AAED,eAAO,MAAM,YAAY;;;;;;CAMf,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;CAWf,CAAC;AACX,KAAK,YAAY,GAAG,OAAO,YAAY,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAGnE;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAc5D;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,YAAiC,QAYjG;AAED,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,YAAiC,QAGrI"}