@sera4/essentia 1.1.65 → 3.0.6

package/README.md

@@ -1,10 +1,354 @@
 # ESSENTIA
 
-A collection of small modules providing essential utilities for TWS services:
-
-* [Sequelize Paginator](paginator/README.md)
-* [Sequelize HAL Decorator](hal/README.md)
-* A logging tool
-* An HTTP response tool for consistenty formatting error responses
-* A small utility to dump the last commit of the project
-* [Paper Trail](paper-trail/README.md)
+[![License](https://img.shields.io/badge/License-Proprietary-red.svg)](LICENSE)
+[![Docker](https://img.shields.io/badge/Docker-Ready-blue.svg)](https://hub.docker.com/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.3+-blue.svg)](https://www.typescriptlang.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
+
+A comprehensive TypeScript library providing essential utilities for TWS services. Built with modern TypeScript practices and full type safety.
+
+## Project Structure
+
+All modules are written in TypeScript and located in the `/ts` directory:
+
+- `/ts/logger` - S4Logger implementation with Winston integration
+- `/ts/utils` - Utility functions (UUID validation, array conversion, etc.)
+- `/ts/dns` - DNS caching functionality with configurable TTL
+- `/ts/health` - Health check utilities for service monitoring
+- `/ts/cycle` - Cycle deployment watcher for version tracking
+- `/ts/constants` - Shared constants and configuration
+- `/ts/helpers` - Helper functions and utilities
+- `/ts/paginator` - Pagination utilities for SQL and data arrays
+- `/ts/cache` - Redis cache helper with connection management
+- `/ts/prompts` - CLI prompt utilities with argument parsing
+- `/ts/safe-proxy` - Safe object property access with error handling
+- `/ts/queue` - AMQP message queue management
+- `/ts/last-commit` - Git commit information retrieval
+- `/ts/hal` - HAL decorator for API responses
+- `/ts/formatter` - Data formatting and error response utilities
+- `/ts/serializer` - Sequelize model serialization utilities
+- `/ts/paper-trail` - Data versioning and change tracking
+
+## Quick Start
+
+Install the package:
+
+```bash
+npm install @sera4/essentia
+```
+
+### Basic Usage
+
+```typescript
+import {
+  sqlPaginator,
+  paginator,
+  DnsCache,
+  S4Logger,
+  utils,
+  constants
+} from '@sera4/essentia';
+
+// Pagination
+const result = sqlPaginator('SELECT * FROM users', { page: 1, limit: 10 });
+const paginated = paginator(data, { page: 1, limit: 20 });
+
+// DNS caching
+const dnsCache = new DnsCache();
+const ip = await dnsCache.resolveTarget('https://example.com');
+
+// Logging
+const logger = new S4Logger();
+logger.configure({ level: 'debug', service: 'my-service' });
+logger.info('Application started');
+
+// Utilities
+const isValidUuid = utils.isValidUuidV4('123e4567-e89b-12d3-a456-426614174000');
+```
+
+### Advanced Usage
+
+```typescript
+import {
+  sqlPaginator,
+  paginator,
+  DnsCache,
+  S4Logger,
+  HealthCheck,
+  CycleDeploymentWatcher,
+  halDecorator,
+  formatter,
+  queue,
+  paperTrail,
+  serializer,
+  lastCommit,
+  utils,
+  constants,
+  helpers,
+  prompts,
+  safeProxy
+} from '@sera4/essentia';
+
+// Pagination examples
+const sqlResult = sqlPaginator('SELECT * FROM users WHERE active = ?', {
+  page: 1,
+  limit: 10,
+  orderBy: 'created_at',
+  orderDirection: 'DESC'
+});
+
+const paginatedData = paginator(userList, {
+  page: 1,
+  limit: 20,
+  total: 100
+});
+
+// DNS caching with configuration
+const dnsCache = DnsCache.getInstance({
+  cacheTtlMs: 5000,
+  purgeIntervalMs: 120000,
+  debug: true
+});
+const ip = await dnsCache.resolveTarget('https://example.com');
+
+// Logging with advanced configuration
+const logger = new S4Logger();
+logger.configure({
+  level: 'debug',
+  service: 'my-service',
+  format: 'json'
+});
+logger.info('Application started');
+
+// Health checks
+const healthCheck = new HealthCheck();
+healthCheck.addCheck('database', async () => {
+  // Your database health check logic
+  return { status: 'healthy' };
+});
+
+// Cycle deployment monitoring
+const watcher = CycleDeploymentWatcher.getInstance();
+const currentVersion = watcher.getCurrentVersion('gateway');
+
+// HAL decorator for API responses
+const response = halDecorator(data, {
+  self: '/api/users',
+  next: '/api/users?page=2'
+});
+
+// Queue management
+await queue.openConnection({
+  connectionUrl: 'amqp://localhost',
+  logEnabled: true
+});
+await queue.registerPublisher({
+  exchange: { name: 'my-exchange', type: 'topic' }
+});
+await queue.publishMessage('my-exchange', 'my-routing-key', { data: 'message' });
+
+// Paper trail for data versioning
+const trail = paperTrail(originalData, {
+  userId: 'user123',
+  action: 'update'
+});
+
+// Data serialization
+const serialized = serializer(data, {
+  format: 'json',
+  pretty: true
+});
+
+// Last commit information
+const commitInfo = await lastCommit.getLastCommit();
+console.log(`Deployed version: ${commitInfo.hash}`);
+
+// Utility functions
+const safeData = safeProxy(data);
+const helper = helpers.someHelperFunction();
+const parser = prompts.setupCLIParser('My CLI Tool');
+```
+
+## Available Modules
+
+All modules are written in TypeScript and provide full type safety:
+
+### Core Modules
+- **Logging**: `S4Logger` - Winston-based logging utility with multiple log levels and formatting options
+- **DNS Cache**: `DnsCache` - Singleton class for caching DNS lookups with configurable TTL
+- **Health Checks**: `HealthCheck` - Utilities for implementing health check endpoints
+- **Cycle Deployment Watcher**: `CycleDeploymentWatcher` - Monitor and react to changes in Cycle deployment tags
+- **Utils**: `utils` - General utility functions (UUID validation, array conversion, route type detection, JSONB helpers)
+
+### Data Management
+- **Pagination**: `sqlPaginator`, `paginator` - Utilities for handling pagination in SQL queries and data arrays
+- **Cache**: `cache` - Redis cache helper with connection management and key generation
+- **Serializer**: `serializer` - Sequelize model serialization utilities with custom decorators
+- **Paper Trail**: `paperTrail` - Track changes to data models with automatic versioning and diff generation
+
+### API & Communication
+- **HAL Decorator**: `halDecorator` - Adds HAL (Hypertext Application Language) support to API responses
+- **Formatter**: `formatter` - Data formatting utilities and error response formatting
+- **Queue**: `queue` - AMQP message queue management with publishers and subscribers
+- **Safe Proxy**: `safeProxy` - Safe object property access with error handling
+
+### Utilities
+- **Constants**: `constants` - Shared constants and configuration values
+- **Helpers**: `helpers` - Helper functions and utilities
+- **Prompts**: `prompts` - CLI prompt utilities with argument parsing
+- **Last Commit**: `lastCommit` - Retrieve and display git commit information
+
+### Cycle Deployment Watcher
+
+The Cycle Deployment Watcher provides functionality to monitor and react to changes in Cycle deployment tags. It's particularly useful for tracking deployment tags in a Cycle environment.
+
+#### Methods
+
+- `getInstance()`: Returns the singleton instance of the watcher
+- `getCurrentVersion(service: string)`: Returns the current version for a service
+- `getLegacyVersion(service: string)`: Returns the legacy version for a service
+- `getTagsForVersion(version: string)`: Returns all tags that match a specific version
+- `addListener(listener: (tags: Record<string, string>) => void)`: Adds a listener for tag changes
+- `destroy()`: Cleans up resources and removes all listeners
+
+#### Environment Variables
+
+- `CYCLE_DEPLOYMENT_VERSION`: Optional environment variable to specify the current deployment version
+
+## TypeScript Support
+
+This package is built entirely in TypeScript and provides:
+
+- **Full Type Safety**: All modules include comprehensive TypeScript interfaces and type definitions
+- **IntelliSense Support**: Complete autocomplete and IntelliSense in modern IDEs
+- **Compile-time Error Checking**: Catch errors at compile time rather than runtime
+- **Modern ES Modules**: Uses ES modules with proper import/export syntax
+- **Declaration Files**: Generated `.d.ts` files for all modules
+
+### Type Definitions
+
+All modules export their TypeScript interfaces, allowing you to use them in your own code:
+
+```typescript
+import {
+  LoggerOptions,
+  DnsCacheConfig,
+  HealthCheckOptions,
+  PaginationOptions
+} from '@sera4/essentia';
+
+// Use the types in your own interfaces
+interface MyServiceConfig {
+  logger: LoggerOptions;
+  dns: DnsCacheConfig;
+  health: HealthCheckOptions;
+}
+```
+
+## Contributing
+
+When contributing new features or fixes, please:
+
+1. Use TypeScript for all new code
+2. Follow the existing TypeScript patterns and conventions
+3. Include appropriate type definitions and interfaces
+4. Add unit tests for new functionality
+5. Update this documentation as needed
+6. Ensure all code passes the TypeScript compiler with strict mode enabled
+
+## Running Tests
+
+The project uses Mocha and Chai for testing. To run the tests:
+
+1. Install dependencies:
+```bash
+npm install
+```
+
+2. Run all tests:
+```bash
+npm test
+```
+
+3. Run tests for a specific module:
+```bash
+npm test -- --grep "DnsCache"
+```
+
+4. Run tests with coverage:
+```bash
+npm run test:coverage
+```
+
+5. Run tests in watch mode (useful during development):
+```bash
+npm run test:watch
+```
+
+### Test Environment
+
+The test environment is configured to:
+- Use ES modules
+- Support TypeScript
+- Mock external dependencies
+- Run tests in parallel
+
+### Writing Tests
+
+When writing new tests:
+1. Place test files in the `test` directory, mirroring the source structure
+2. Use `.test.ts` extension for TypeScript test files
+3. Follow the existing test patterns and conventions
+4. Use sinon for mocking and stubbing
+5. Include both positive and negative test cases
+6. Test edge cases and error conditions
+
+Example test structure:
+```typescript
+import { expect } from 'chai';
+import sinon from 'sinon';
+import { MyModule } from '../../ts/my-module';
+
+describe('MyModule', () => {
+  let myModule: MyModule;
+  let mockDependency: sinon.SinonStub;
+
+  beforeEach(() => {
+    myModule = new MyModule();
+    mockDependency = sinon.stub();
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  describe('someMethod', () => {
+    it('should do something', async () => {
+      mockDependency.resolves('expected result');
+
+      const result = await myModule.someMethod();
+
+      expect(result).to.equal('expected result');
+      expect(mockDependency.calledOnce).to.be.true;
+    });
+  });
+});
+```
+
+## Building
+
+To build the project:
+
+```bash
+npm run build
+```
+
+This will:
+- Compile all TypeScript files to JavaScript
+- Generate declaration files (`.d.ts`)
+- Create source maps for debugging
+- Output everything to the `dist/` directory
+
+## License
+
+This project is proprietary software. All rights reserved.

package/dist/ts/cache/index.d.ts

@@ -0,0 +1,33 @@
+interface CacheConfig {
+    password?: string;
+    database?: number;
+    host?: string;
+    port?: number;
+    fake?: boolean;
+    [key: string]: any;
+}
+declare class CacheConfigError extends Error {
+    constructor(message: string);
+}
+declare class Cache {
+    private redisClient;
+    private servicePrefix;
+    constructor(config: CacheConfig, servicePrefix: string);
+    ping(): Promise<string>;
+    properKey(key: string, path?: string): string;
+    writeHash(path: string, key: string, value: any): Promise<number>;
+    writeHashBlocking(path: string, key: string, value: any): void;
+    writeMultiHash(path: string, j: Record<string, any>): Promise<string>;
+    readHashKey(obj: string, key: string, autoConvert?: boolean): Promise<any>;
+    readHash(path: string): Promise<Record<string, any> | null>;
+    deleteHashKey(hash: string, key: string): Promise<void>;
+    get(key: string): Promise<string | null>;
+    getAsync(key: string): Promise<string | null>;
+    writeKey(key: string, value: any, expiry?: number): Promise<string>;
+    deleteKey(key: string): Promise<number>;
+    expire(path: string, expiry: number): Promise<number>;
+    exists(path: string): Promise<number>;
+    deleteAllKeys(): Promise<string>;
+}
+export default function (config: CacheConfig, servicePrefix: string): Cache;
+export { Cache, CacheConfigError };

package/dist/ts/cache/index.js

@@ -0,0 +1,171 @@
+import { promisify } from "util";
+import { S4Logger } from "../logger/s4-logger.js";
+const logger = new S4Logger();
+const isEmpty = (obj) => {
+    return [Object, Array].includes((obj || {}).constructor) && !Object.entries((obj || {})).length;
+};
+class CacheConfigError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "CacheConfigError";
+    }
+}
+/* Redis cache helper
+ * Example use: Place the following code in your project to setup redis use
+ *
+ *    import { cache } from "@sera4/essentia";
+ *    const cacheHelper = cache({ password: .., database: .., host: .., port: .. }, "service:"));
+ *
+ */
+const convertRedisKeyValueToJson = (v) => {
+    return (v && v.length > 0 && v[0] !== null) ? JSON.parse(v) : null;
+};
+const convertRedisHashToJson = (v) => {
+    if (v) {
+        const result = {};
+        for (const k in v) {
+            if (v.hasOwnProperty(k)) {
+                result[k] = JSON.parse(v[k]);
+            }
+        }
+        return result;
+    }
+    else {
+        return null;
+    }
+};
+function convertJsonToRedisValue(j) {
+    const result = {};
+    for (const key in j) {
+        if (j.hasOwnProperty(key)) {
+            result[key] = JSON.stringify(j[key]);
+        }
+    }
+    return result;
+}
+class Cache {
+    constructor(config, servicePrefix) {
+        if ((config == undefined) || isEmpty(config)) {
+            throw new CacheConfigError("Invalid cache configuration");
+        }
+        if (servicePrefix == null) {
+            throw new CacheConfigError("Invalid service prefix");
+        }
+        if (config.fake) {
+            // used in testing
+            this.redisClient = require("fakeredis").createClient("fake backend");
+        }
+        else {
+            this.redisClient = require("redis").createClient(config);
+        }
+        this.redisClient.on("error", (err) => {
+            logger.error("Cache/Redis error: ", err);
+        });
+        this.servicePrefix = servicePrefix;
+    }
+    ping() {
+        return this.redisClient.ping();
+    }
+    properKey(key, path) {
+        let p = this.servicePrefix + key;
+        if (path) {
+            p += path;
+        }
+        return p;
+    }
+    writeHash(path, key, value) {
+        return this.redisClient.hsetAsync(this.properKey(key), key, value);
+    }
+    writeHashBlocking(path, key, value) {
+        return this.redisClient.hset(this.properKey(key), key, value);
+    }
+    // write multiple hash keys and stringify every value
+    writeMultiHash(path, j) {
+        return this.redisClient.hmsetAsync(this.properKey(path), convertJsonToRedisValue(j));
+    }
+    readHashKey(obj, key, autoConvert = true) {
+        return new Promise((resolve, reject) => {
+            this.redisClient.hget(this.properKey(key, obj), key, (e, r) => {
+                if (e) {
+                    logger.error("Redis hmget error:", e);
+                    reject(e);
+                }
+                else {
+                    resolve(autoConvert ? convertRedisKeyValueToJson(r) : r);
+                }
+            });
+        });
+    }
+    readHash(path) {
+        return new Promise((resolve, reject) => {
+            this.redisClient.hgetall(this.properKey(path), (e, r) => {
+                if (e) {
+                    console.log("Redis hget error:", e);
+                    reject(e);
+                }
+                else {
+                    resolve(convertRedisHashToJson(r));
+                }
+            });
+        });
+    }
+    deleteHashKey(hash, key) {
+        return new Promise((resolve, reject) => {
+            this.redisClient.hdel(this.properKey(key, hash), key, (err) => {
+                if (err) {
+                    logger.error("Redis hdel error:", err);
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+    get(key) {
+        return this.redisClient.getAsync(this.properKey(key));
+    }
+    getAsync(key) {
+        return promisify(this.redisClient.get.bind(this.redisClient))(this.properKey(key));
+    }
+    /* a single key write with optional expiry */
+    // returns bluebird promise
+    writeKey(key, value, expiry) {
+        const fullKey = this.servicePrefix + key;
+        if (expiry) {
+            return this.redisClient.setAsync(fullKey, value, "EX", expiry);
+        }
+        else {
+            return this.redisClient.setAsync(fullKey, value);
+        }
+    }
+    deleteKey(key) {
+        return this.redisClient.delAsync(this.properKey(key));
+    }
+    expire(path, expiry) {
+        return this.redisClient.expire(path, expiry);
+    }
+    exists(path) {
+        return this.redisClient.exists(path);
+    }
+    deleteAllKeys() {
+        return new Promise((resolve, reject) => {
+            if (process.env.NODE_ENV === "production") {
+                throw new Error("Clearing system cache is not permitted in production");
+            }
+            this.redisClient.flushdb((err, res) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(res);
+                }
+            });
+        });
+    }
+}
+export default function (config, servicePrefix) {
+    return new Cache(config, servicePrefix);
+}
+export { Cache, CacheConfigError };
+//# sourceMappingURL=index.js.map

package/dist/ts/cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/cache/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;AAW9B,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAW,EAAE;IACpC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAClG,CAAC,CAAC;AAEF,MAAM,gBAAiB,SAAQ,KAAK;IAClC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF;AAED;;;;;;GAMG;AAEH,MAAM,0BAA0B,GAAG,CAAC,CAAM,EAAO,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACrE,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,CAA6B,EAA8B,EAAE;IAC3F,IAAI,CAAC,EAAE,CAAC;QACN,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxB,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,SAAS,uBAAuB,CAAC,CAAsB;IACrD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,KAAK;IAIT,YAAY,MAAmB,EAAE,aAAqB;QACpD,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,gBAAgB,CAAC,6BAA6B,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,IAAI,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,kBAAkB;YAClB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QACvE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAQ,EAAE,EAAE;YACxC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,SAAS,CAAC,GAAW,EAAE,IAAa;QAClC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;QACjC,IAAI,IAAI,EAAE,CAAC;YACT,CAAC,IAAI,IAAI,CAAC;QACZ,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,GAAW,EAAE,KAAU;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAED,iBAAiB,CAAC,IAAY,EAAE,GAAW,EAAE,KAAU;QACrD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED,qDAAqD;IACrD,cAAc,CAAC,IAAY,EAAE,CAAsB;QACjD,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,WAAW,CAAC,GAAW,EAAE,GAAW,EAAE,cAAuB,IAAI;QAC/D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE;gBACtE,IAAI,CAAC,EAAE,CAAC;oBACN,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC;oBACtC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACZ,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE;gBAChE,IAAI,CAAC,EAAE,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;oBACpC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACZ,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,IAAY,EAAE,GAAW;QACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,GAAQ,EAAE,EAAE;gBACjE,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;oBACvC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,GAAW;QACb,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,QAAQ,CAAC,GAAW;QAClB,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IACrF,CAAC;IAED,6CAA6C;IAC7C,2BAA2B;IAC3B,QAAQ,CAAC,GAAW,EAAE,KAAU,EAAE,MAAe;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,SAAS,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,IAAY,EAAE,MAAc;QACjC,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,aAAa;QACX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,GAAW,EAAE,EAAE;gBACjD,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,CAAC;gBACf,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,CAAC,OAAO,WAAU,MAAmB,EAAE,aAAqB;IAChE,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAC1C,CAAC;AAED,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/ts/configurations/server-config.d.ts

@@ -0,0 +1,4 @@
+export interface ServerConfig {
+    s4_identity_endpoint: string;
+    debug_dns?: boolean;
+}

package/dist/ts/configurations/server-config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=server-config.js.map

package/dist/ts/configurations/server-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-config.js","sourceRoot":"","sources":["../../../ts/configurations/server-config.ts"],"names":[],"mappings":""}

package/dist/ts/constants/index.d.ts

@@ -0,0 +1,7 @@
+export declare const TWS_ROUTE_TYPES: Readonly<{
+    readonly web: 1;
+    readonly mobile: 2;
+    readonly api: 3;
+    readonly other: 4;
+}>;
+export type TWSRouteType = typeof TWS_ROUTE_TYPES[keyof typeof TWS_ROUTE_TYPES];

package/{constants → dist/ts/constants}/index.js

@@ -1,9 +1,8 @@
-"use strict";
-
 // indicate what target URL was used for a request
 export const TWS_ROUTE_TYPES = Object.freeze({
-  'web': 1,
-  'mobile': 2,
-  'api': 3,
-  'other': 4
+    'web': 1,
+    'mobile': 2,
+    'api': 3,
+    'other': 4
 });
+//# sourceMappingURL=index.js.map

package/dist/ts/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/constants/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,KAAK,EAAE,CAAC;IACR,QAAQ,EAAE,CAAC;IACX,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC;CACF,CAAC,CAAC"}

package/dist/ts/cycle/index.d.ts

@@ -0,0 +1,53 @@
+export declare class CycleDeploymentWatcher {
+    private static instance;
+    private readonly metadataPath;
+    private watcher;
+    private currentTags;
+    private listeners;
+    private readonly deploymentVersion;
+    private constructor();
+    static getInstance(): CycleDeploymentWatcher;
+    private initializeWatcher;
+    private readAndParseFile;
+    private notifyListeners;
+    /**
+     * Get all tags for a specific deployment version
+     * @param version - The deployment version to find tags for (e.g., 'gwy-20250505-UTC18:54:32')
+     * @returns Array of tag names that match the version
+     */
+    getTagsForVersion(version: string): string[];
+    /**
+     * Get the current version for a specific service
+     * @param service - The service name (e.g., 'gateway', 'apm', etc.)
+     * @returns The current version or undefined if not found
+     */
+    getCurrentVersion(service: string): string | undefined;
+    /**
+     * Get the legacy version for a specific service
+     * @param service - The service name (e.g., 'gateway', 'apm', etc.)
+     * @returns The legacy version or undefined if not found
+     */
+    getLegacyVersion(service: string): string | undefined;
+    /**
+     * Get the current deployment version
+     * @returns The current deployment version from environment, or empty string if not available
+     */
+    getDeploymentVersion(): string;
+    /**
+     * Get all tags for the current deployment version
+     * @returns Array of tag names that match the current deployment version
+     */
+    getCurrentDeploymentTags(): string[];
+    /**
+     * Add a listener for tag changes
+     * @param listener - Function to call when tags change
+     * @returns Function to remove the listener
+     */
+    addListener(listener: (tags: Record<string, string>) => void): () => void;
+    /**
+     * Clean up resources
+     */
+    destroy(): void;
+}
+declare const _default: CycleDeploymentWatcher;
+export default _default;