@skedulo/pulse-solution-services 0.0.5

package/dist/index.d.ts

@@ -0,0 +1,644 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * Interface representing the structure of metadata for an object.
+ */
+export interface Metadata {
+	label: string;
+	labelPlural: string | null;
+	mapping: string;
+	name: string;
+}
+/**
+ * Interface representing the metadata for a specific object, extending the base Metadata interface.
+ */
+export interface ObjectMetadata extends Metadata {
+	relationships: any[];
+	fields: any[];
+}
+/**
+ * Interface representing the structure of a relationship.
+ */
+export interface RelationshipMapping {
+	schemaMapping: string;
+	mapping: string;
+	fieldMapping: string;
+}
+/**
+ * Interface representing the structure of a field.
+ */
+export interface FieldMetadata {
+	label: string;
+	mapping: string;
+	type: string;
+	nillable: boolean;
+	length: number;
+	maxLength: number | null;
+	precision: number | null;
+	scale: number | null;
+	upsertKey: boolean;
+	unique: boolean;
+	readOnly: boolean;
+	accessMode: "read_only" | "read_write";
+	relationship: RelationshipMapping | null;
+	values: Array<PicklistValue>;
+	name: string;
+}
+export interface PicklistValue {
+	label: string;
+	value: string;
+	active: boolean;
+	defaultValue: boolean;
+}
+/**
+ * Interface defining the base configuration for API clients.
+ */
+export interface BaseConfig {
+	apiServer: string;
+	apiToken: string;
+}
+/**
+ * Base client for making API requests with standardized error handling.
+ * Provides methods for setting up headers and performing API requests using fetch.
+ */
+export declare class BaseClient {
+	protected config: BaseConfig;
+	/**
+	 * Creates an instance of BaseClient.
+	 * @param {BaseConfig} config - The configuration object containing API server and token.
+	 */
+	constructor(config: BaseConfig);
+	/**
+	 * Constructs the headers for API requests.
+	 * @returns {Record<string, string>} - The headers including authorization and content type.
+	 */
+	protected getHeaders(): {
+		Authorization: string;
+		"Content-Type": string;
+	};
+	/**
+	 * Performs an API request with standardized error handling using fetch.
+	 * @template T
+	 * @param {Object} options - The request options.
+	 * @param {string} options.method - HTTP method (default: GET).
+	 * @param {string} options.endpoint - The API endpoint to call.
+	 * @param {object} [options.body] - The request body.
+	 * @param {Record<string, string>} [options.headers] - Additional headers.
+	 * @returns {Promise<T>} - The parsed response data.
+	 * @throws {Error} - If the request fails or the response is not OK.
+	 */
+	protected performRequest<T = any>({ method, endpoint, headers, body, }: {
+		method?: string;
+		endpoint: string;
+		body?: object;
+		headers?: Record<string, string>;
+	}): Promise<T>;
+	/**
+	 * Handles exceptions encountered during API requests.
+	 * @param {any} error - The error to handle.
+	 */
+	protected handleException(error: any): void;
+}
+/**
+ * MetadataClient class to handle API requests related to metadata.
+ * Extends BaseClient to perform API operations.
+ */
+export declare class MetadataClient extends BaseClient {
+	/**
+	 * Fetches all metadata mappings from the metadata endpoint.
+	 * @returns {Promise<{ result: Metadata[] }>} - A promise resolving to an object containing an array of Metadata.
+	 */
+	fetchAllMetadata(): Promise<{
+		result: Metadata[];
+	}>;
+	/**
+	 * Fetches metadata for a specific object using its mapping.
+	 * @param {string} mapping - The API mapping for the object.
+	 * @returns {Promise<{ result: ObjectMetadata }>} - A promise resolving to an object containing the metadata of the requested object.
+	 */
+	fetchObjectMetadata(mapping: string): Promise<{
+		result: ObjectMetadata;
+	}>;
+}
+/**
+ * MetadataService class to process and filter metadata.
+ */
+export declare class MetadataService {
+	private client;
+	constructor(client: MetadataClient);
+	/**
+	 * Retrieves metadata for specific objects.
+	 *
+	 * @param objectNames - The names of the objects.
+	 * @returns A promise that resolves to metadata records.
+	 */
+	getObjectMetadata(objectNames: string[]): Promise<Record<string, ObjectMetadata>>;
+	/**
+	 * Extracts picklist values from the object metadata.
+	 *
+	 * @param metadata - The metadata of the object.
+	 * @returns An object containing the picklist values for each picklist field.
+	 */
+	getPicklistValues(metadata: ObjectMetadata): Record<string, string[]>;
+}
+export interface ConfigVar {
+	key?: string;
+	configType: string;
+	value: string;
+	description?: string;
+	status?: "active" | "inactive" | "expired";
+	updatedBy?: string;
+	createdBy?: string;
+	createdAt?: string;
+	updatedAt?: string;
+}
+/**
+ * Client for managing configuration variables through API requests.
+ * Provides methods to create, retrieve, update, search, and delete configuration variables.
+ */
+export declare class ConfigVarClient extends BaseClient {
+	/**
+	 * Creates a new configuration variable.
+	 * @param {ConfigVar} configVar - The configuration variable to create.
+	 * @returns {Promise<ConfigVar>} - The created configuration variable.
+	 */
+	create(configVar: ConfigVar): Promise<ConfigVar>;
+	/**
+	 * Retrieves a configuration variable by key.
+	 * @param {string} key - The key of the configuration variable.
+	 * @returns {Promise<ConfigVar>} - The retrieved configuration variable.
+	 */
+	get(key: string): Promise<ConfigVar>;
+	/**
+	 * Updates an existing configuration variable.
+	 * @param {ConfigVar} configVar - The configuration variable with updated values. Only the value and description can be updated.
+	 * @returns {Promise<ConfigVar>} - A promise that resolves when the update is complete.
+	 */
+	update(configVar: ConfigVar): Promise<ConfigVar>;
+	/**
+	 * Searches for configuration variables with pagination.
+	 * @param {number} [pageSize] - The number of results per page (default max is 1000).
+	 * @returns {Promise<ConfigVar[]>} - A list of configuration variables.
+	 */
+	search(pageSize?: number): Promise<ConfigVar[]>;
+	/**
+	 * Deletes a configuration variable by key.
+	 * @param {string} key - The key of the configuration variable to delete.
+	 * @returns {Promise<string>} - A response indicating the result of the delete operation.
+	 */
+	delete(key: string): Promise<string>;
+}
+export interface HasId {
+	UID?: string;
+	[key: string]: any;
+}
+export interface GraphQlResponse<T = any> {
+	data: T;
+	errors?: object[];
+}
+export interface FetchRecordsQueryParams {
+	objectName: string;
+	first?: number;
+	offset?: number;
+	orderBy?: string;
+	filter?: string;
+	after?: string;
+	fields?: string;
+}
+export interface QueryResult {
+	records: HasId[];
+	totalCount: number;
+	pageInfo: any;
+	endCursor?: string;
+	endOffset?: number;
+}
+export interface MutationResult {
+	data: {
+		schema: {
+			[alias: string]: string;
+		};
+	};
+}
+/**
+ * A client for executing GraphQL queries and mutations.
+ * Extends the BaseClient to interact with the GraphQL API.
+ */
+export declare class GraphQLClient extends BaseClient {
+	/**
+	 * Executes a GraphQL query or mutation.
+	 * @param {string} graphqlQuery - The GraphQL query or mutation string.
+	 * @returns {Promise<GraphQlResponse>} - The response from the GraphQL API.
+	 * @throws {Error} - If the request fails or if there are errors in the response.
+	 */
+	execute(graphqlQuery: string): Promise<GraphQlResponse>;
+}
+export declare const CONFIG_VAR_TYPE: {
+	PLAIN_TEXT: string;
+	SECRET: string;
+};
+export declare const CONFIG_VAR_STATUS: {
+	ACTIVE: string;
+	INACTIVE: string;
+	EXPIRED: string;
+};
+export declare const HTTP_METHOD: {
+	GET: string;
+	POST: string;
+	PUT: string;
+	DELETE: string;
+	PATCH: string;
+};
+export declare const TENANT_ENDPOINTS: {
+	readonly CONFIG_VAR: {
+		readonly CREATE: "configuration/extension";
+		readonly GET: (key: string) => string;
+		readonly UPDATE: (key: string) => string;
+		readonly DELETE: (key: string) => string;
+		readonly SEARCH: "configuration/extension/search";
+	};
+	readonly GRAPHQL: "graphql/graphql";
+	readonly METADATA: {
+		readonly ALL: "custom/metadata";
+		readonly OBJECT: (objectMapping: string) => string;
+	};
+};
+export declare const TENANT_OBJECTS: {
+	Accounts: string;
+	Jobs: string;
+	JobAllocations: string;
+	Regions: string;
+	Contacts: string;
+	Locations: string;
+	Resources: string;
+	Tags: string;
+	JobTags: string;
+	ResourceTags: string;
+	Activities: string;
+	Availabilities: string;
+	Holidays: string;
+	AvailabilityPatterns: string;
+	AvailabilityPatternResources: string;
+	AccountResourceScores: string;
+	LocationResourceScores: string;
+	Products: string;
+	JobProducts: string;
+};
+export declare const PULSE_SOLUTION_NAMESPACE = "PSS";
+/**
+ * This decorator logs the input arguments and output results of a method,
+ * including error handling with ANSI color-coded logs for better console readability.
+ * It allows selective logging based on the `LOG_NAMESPACE` environment variable.
+ */
+export declare function LogMethod(namespace?: string): MethodDecorator;
+/**
+ * Logger class for managing log messages.
+ * Provides methods for logging information and errors, retrieving logs, and formatting logs.
+ */
+export declare class Logger {
+	logs: {
+		level: string;
+		message: string;
+	}[];
+	/**
+	 * Constructs an instance of Logger.
+	 * Initializes an empty array for storing log messages.
+	 */
+	constructor();
+	/**
+	 * Logs an informational message.
+	 *
+	 * @param message - The message to log.
+	 */
+	info(message: string): void;
+	/**
+	 * Logs an error message.
+	 *
+	 * @param message - The message to log.
+	 */
+	error(message: string): void;
+	/**
+	 * Retrieves all log messages.
+	 *
+	 * @returns An array of log messages.
+	 */
+	getLogs(): {
+		level: string;
+		message: string;
+	}[];
+	/**
+	 * Formats and retrieves all log messages as a single string.
+	 *
+	 * @param separator - The separator to use between log messages. Defaults to a newline character.
+	 * @returns A formatted string of all log messages.
+	 */
+	getFormattedLogs(separator?: string): string;
+	/**
+	 * Clears all log messages.
+	 */
+	clear(): void;
+}
+export declare class CacheService<T> {
+	private storage;
+	private secondaryCache?;
+	/**
+	 * Creates an instance of CacheService.
+	 * @param {CacheStorage<string>} storage - The cache storage implementation.
+	 */
+	constructor(storage: CacheStorage<string>);
+	/**
+	 * Sets a secondary cache service to use as a fallback.
+	 * @param {CacheService<T>} secondaryCache - The secondary cache service.
+	 * @returns {void}
+	 */
+	setSecondaryCache(secondaryCache: CacheService<T>): void;
+	/**
+	 * Retrieves a cached value by key.
+	 * If the value is not found, it attempts to retrieve it from a secondary service or loader.
+	 * @param {string} key - The cache key.
+	 * @param {object} options - Optional parameters.
+	 * @param {CacheLoader<T>} [options.loader] - A function to load the value if not cached.
+	 * @param {boolean} [options.useSecondaryCache] - Whether to use the secondary cache service.
+	 * @returns {Promise<T | null>} - The cached value or null if not found or expired.
+	 */
+	get(key: string, options?: CacheOptions<T>): Promise<T | null>;
+	/**
+	 * Stores a value in the cache with an optional TTL.
+	 * @param {string} key - The cache key.
+	 * @param {T} value - The value to store.
+	 * @param {object} options - Optional parameters.
+	 * @returns {Promise<void>}
+	 */
+	set(key: string, value: T, options?: CacheOptions<T>): Promise<void>;
+	/**
+	 * Deletes a specific key from the cache.
+	 * @param {string} key - The cache key to delete.
+	 * @returns {Promise<void>}
+	 */
+	delete(key: string): Promise<void>;
+	/**
+	 * Clears all cache entries.
+	 * @returns {Promise<void>}
+	 */
+	clear(): Promise<void>;
+	/**
+	 * Adds the cache key prefix to a key if it is not already present.
+	 * @param {string} key - The cache key.
+	 * @returns {string} - The key with the prefix
+	 */
+	addPrefix(key: string): string;
+	/**
+	 * Deserializes the cached metadata and returns the original value in the correct type.
+	 * @param {any} metadata - The cached metadata object.
+	 * @returns {T} - The deserialized value.
+	 */
+	private deserialize;
+}
+/**
+ * Interface for cache storage.
+ * This defines the basic storage operations without loader logic.
+ */
+export interface CacheStorage<T = any> {
+	set(key: string, value: T): Promise<void>;
+	get(key: string): Promise<T | null>;
+	delete(key: string): Promise<void>;
+	clear(): Promise<void>;
+}
+export interface CacheOptions<T> {
+	ttl?: number;
+	useSecondaryCache?: boolean;
+}
+/**
+ * A utility class for building GraphQL queries dynamically.
+ */
+export declare class GraphQLQueryBuilder {
+	private objectName;
+	private fields;
+	private filters;
+	private first?;
+	private offset?;
+	private orderBy?;
+	private after?;
+	private parentQueries;
+	private childQueries;
+	private isParent;
+	/**
+	 * Creates an instance of GraphQLQueryBuilder.
+	 * @param {string} objectName - The name of the object being queried.
+	 * @param {boolean} [isParent=false] - Indicates if this query is a parent query.
+	 */
+	constructor(objectName: string, isParent?: boolean);
+	/**
+	 * Specifies the fields to be retrieved.
+	 * @param {string[]} fields - The list of fields to select.
+	 * @returns {this} - The query builder instance.
+	 */
+	withFields(fields: string[]): this;
+	/**
+	 * Adds a filter condition to the query.
+	 * @param {string} condition - The filter condition.
+	 * @returns {this} - The query builder instance.
+	 */
+	withFilter(condition: string): this;
+	/**
+	 * Sets a limit on the number of records to retrieve.
+	 * @param {number} first - The number of records to fetch.
+	 * @returns {this} - The query builder instance.
+	 */
+	withLimit(first: number): this;
+	/**
+	 * Sets an offset for pagination.
+	 * @param {number} offset - The offset value.
+	 * @returns {this} - The query builder instance.
+	 */
+	withOffset(offset: number): this;
+	/**
+	 * Sets the order in which records should be retrieved.
+	 * @param {string} orderBy - The field to order by.
+	 * @returns {this} - The query builder instance.
+	 */
+	withOrderBy(orderBy: string): this;
+	/**
+	 * Applies cursor-based pagination.
+	 * @param {string} after - The cursor position.
+	 * @returns {this} - The query builder instance.
+	 */
+	withCursor(after: string): this;
+	/**
+	 * Creates a parent query.
+	 * @param {string} objectName - The name of the parent object.
+	 * @returns {GraphQLQueryBuilder} - A new query builder instance for the parent.
+	 */
+	withParentQuery(objectName: string): GraphQLQueryBuilder;
+	/**
+	 * Creates a child query.
+	 * @param {string} objectName - The name of the child object.
+	 * @returns {GraphQLQueryBuilder} - A new query builder instance for the child.
+	 */
+	withChildQuery(objectName: string): GraphQLQueryBuilder;
+	/**
+	 * Builds the GraphQL query parameters.
+	 * @returns {FetchRecordsQueryParams} - The formatted query parameters.
+	 */
+	build(): FetchRecordsQueryParams;
+}
+/**
+ * A service class for handling GraphQL operations.
+ */
+export declare class GraphQLService {
+	private client;
+	/**
+	 * Creates an instance of GraphQLService.
+	 * @param {GraphQLClient} client - The GraphQL client to use for queries and mutations.
+	 */
+	constructor(client: GraphQLClient);
+	/**
+	 * Executes a GraphQL query to fetch records.
+	 * @param {FetchRecordsQueryParams} params - The query parameters.
+	 * @returns {Promise<QueryResult>} - The query result including records, total count, page info, and cursors.
+	 */
+	query(params: FetchRecordsQueryParams): Promise<QueryResult>;
+	/**
+	 * Deletes records from the GraphQL API.
+	 * @param {string} objectName - The name of the object.
+	 * @param {HasId[]} records - The records to delete.
+	 * @returns {Promise<any>} - The response from the delete operation.
+	 */
+	delete(objectName: string, records: HasId[]): Promise<any>;
+	/**
+	 * Updates records in the GraphQL API.
+	 * @param {string} objectName - The name of the object.
+	 * @param {HasId[]} records - The records to update.
+	 * @returns {Promise<any>} - The response from the update operation.
+	 */
+	update(objectName: string, records: HasId[]): Promise<any>;
+	/**
+	 * Inserts records into the GraphQL API.
+	 * @param {string} objectName - The name of the object.
+	 * @param {HasId[]} records - The records to insert.
+	 * @returns {Promise<any>} - The response from the insert operation.
+	 */
+	insert(objectName: string, records: HasId[]): Promise<any>;
+	/**
+	 * Extracts job UIDs from a GraphQL mutation response.
+	 * @param {MutationResult} response - The response object.
+	 * @returns {string[]} - An array of job UIDs.
+	 */
+	extractJobUIDs(response: MutationResult): string[];
+}
+/**
+ * ConfigHelper class provides methods to access and parse configuration variables.
+ * It supports retrieving configuration values as numbers, JSON objects, and strings.
+ * This ensures that configuration values are correctly parsed and validated.
+ */
+export declare class ConfigHelper {
+	private vars;
+	/**
+	 * Constructs an instance of ConfigHelper.
+	 *
+	 * @param vars - The configuration variables.
+	 */
+	constructor(vars: any);
+	/**
+	 * Retrieves a configuration variable as a number.
+	 *
+	 * @param varName - The name of the configuration variable.
+	 * @returns The configuration value as a number, or null if it cannot be parsed as a number.
+	 */
+	getNumber(varName: string): number | null;
+	/**
+	 * Retrieves a configuration variable as a JSON object.
+	 *
+	 * @param varName - The name of the configuration variable.
+	 * @returns The configuration value as a JSON object, or null if it cannot be parsed as JSON.
+	 */
+	getJson(varName: string): any;
+	/**
+	 * Retrieves a configuration variable as a string.
+	 *
+	 * @param varName - The name of the configuration variable.
+	 * @returns The configuration value as a string.
+	 */
+	getString(varName: string): string;
+}
+export declare class ExecutionContext {
+	skedContext: any;
+	contextData: any;
+	private baseConfig;
+	private _logger?;
+	private _configHelper?;
+	private _graphqlClient?;
+	private _graphqlService?;
+	private _metadataClient?;
+	private _metadataService?;
+	private _configVarClient?;
+	private _configVarCache?;
+	private _inMemoryCache?;
+	protected constructor(skedContext: any);
+	static fromContext(skedContext: any): ExecutionContext;
+	static fromCredentials({ apiServer, apiToken }: {
+		apiServer: string;
+		apiToken: string;
+	}): ExecutionContext;
+	get logger(): Logger;
+	get configHelper(): ConfigHelper;
+	get graphqlClient(): GraphQLClient;
+	get graphqlService(): GraphQLService;
+	newQueryBuilder(objectName: string): GraphQLQueryBuilder;
+	get metadataClient(): MetadataClient;
+	get metadataService(): MetadataService;
+	get configVarClient(): ConfigVarClient;
+	get configVarCache(): CacheService<any>;
+	get inMemoryCache(): CacheService<any>;
+	dispose(): void;
+	private lazyInit;
+}
+export interface BatchJobSchemaData extends HasId {
+	StatusDetails?: string;
+	MaximumBatches?: number;
+	Status?: string;
+	ProcessedBatches?: number;
+	ObjectName?: string;
+	JobType?: string;
+	BatchProcessor?: string;
+	CreatedDate?: string;
+	FilterCondition?: string;
+	OrderBy?: string;
+	Fields?: string;
+	JobHandler?: string;
+	State?: string;
+	DelaySeconds?: number;
+	CallbackURL?: string;
+	ProcessingAt?: string;
+	CompletedAt?: string;
+	FailedBatches?: number;
+	FetchingStrategy?: string;
+}
+export interface BatchOrchestratorConfig {
+	isAsyncProcessing?: boolean;
+}
+export interface BatchState {
+	processor?: {
+		cursor?: string;
+		allCursors?: string[];
+		batchNumber?: number;
+	};
+	worker?: any;
+}
+export declare class BatchOrchestrator {
+	protected context: ExecutionContext;
+	protected config: BatchOrchestratorConfig;
+	constructor(context: ExecutionContext, config?: BatchOrchestratorConfig);
+	processBatchJob(): Promise<void>;
+	protected validateJob(): void;
+	protected prepareData(): Promise<void>;
+	protected sendWorkerStateToCallbackUrl(): Promise<void>;
+	protected getWorkerState(): object;
+	protected delay(ms: number): Promise<void>;
+	protected processWorker(): Promise<void>;
+	protected processNextBatch(): Promise<void>;
+	protected postProcess(): Promise<void>;
+	protected updateJobStatus(): Promise<void>;
+	private isCompleted;
+}
+
+export {};

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var i=Object.getOwnPropertyDescriptor(r,t);i&&!("get"in i?!r.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,i)}:function(e,r,t,o){void 0===o&&(o=t),e[o]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./clients"),exports),__exportStar(require("./constants"),exports),__exportStar(require("./core"),exports),__exportStar(require("./interfaces"),exports),__exportStar(require("./logging"),exports),__exportStar(require("./services"),exports),__exportStar(require("./utils"),exports);

package/dist/interfaces/config-var.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/interfaces/graphql.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/interfaces/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./config-var"),exports),__exportStar(require("./graphql"),exports),__exportStar(require("./metadata"),exports);

package/dist/interfaces/metadata.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/logging/decorators/index.d.ts

@@ -0,0 +1 @@
+export * from "./log-method";

package/dist/logging/decorators/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./log-method"),exports);

package/dist/logging/decorators/log-method.d.ts

@@ -0,0 +1,7 @@
+export declare const PULSE_SOLUTION_NAMESPACE = "PSS";
+/**
+ * This decorator logs the input arguments and output results of a method,
+ * including error handling with ANSI color-coded logs for better console readability.
+ * It allows selective logging based on the `LOG_NAMESPACE` environment variable.
+ */
+export declare function LogMethod(namespace?: string): MethodDecorator;

package/dist/logging/decorators/log-method.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PULSE_SOLUTION_NAMESPACE=void 0,exports.LogMethod=LogMethod,exports.PULSE_SOLUTION_NAMESPACE="PSS";const COLORS={RESET:"",GREEN:"",YELLOW:"",RED:"",CYAN:"",MAGENTA:""};function LogMethod(t=exports.PULSE_SOLUTION_NAMESPACE){return function(o,n,e){const O=e.value,r=process.env.LOG_NAMESPACE||"",E=parseInt(process.env.LOG_ENTRY_MAX_LENGTH||"120",10),S=r===t||"ALL"===r.toUpperCase();function s(o,n,e,O,r){const S=(new Date).toISOString(),s="ERROR"===o?COLORS.RED:"INPUT"===O?COLORS.CYAN:COLORS.MAGENTA;console.log(`${COLORS.GREEN}[${o}]${COLORS.RESET} | ${COLORS.YELLOW}${S}${COLORS.RESET} | ${COLORS.GREEN}${t}${COLORS.RESET} | ${n} | ${e} - ${s}${O}${COLORS.RESET}: ${function(t){if(!t)return"";const o="string"==typeof t?t:JSON.stringify(t);return o.length>E?`${o.substring(0,E-3)}...`:o}(r)}`)}return e.value=function(...t){S&&s("INFO",o.constructor.name,n.toString(),"INPUT",t);try{const e=O.apply(this,t);return e instanceof Promise?e.then((t=>(S&&s("INFO",o.constructor.name,n.toString(),"OUTPUT",t),t))):(S&&s("INFO",o.constructor.name,n.toString(),"OUTPUT",e),e)}catch(t){throw s("ERROR",o.constructor.name,n.toString(),"ERROR",t.message||t),t}},e}}

package/dist/logging/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,o,i)}:function(e,t,r,o){void 0===o&&(o=r),e[o]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./decorators"),exports),__exportStar(require("./logger"),exports);

package/dist/logging/logger.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Logger=void 0;class Logger{constructor(){this.logs=[]}info(e){this.logs.push({level:"info",message:e})}error(e){this.logs.push({level:"error",message:e}),console.error(`ERROR: ${this.getFormattedLogs()}`)}getLogs(){return this.logs}getFormattedLogs(e="\n"){return this.logs.map((e=>`${e.level.toUpperCase()}: ${e.message}`)).join(e)}clear(){this.logs=[]}}exports.Logger=Logger;