@ti-engine/core 1.8.1 → 1.9.0

package/types/integrations/redis-integration.d.ts

@@ -0,0 +1,223 @@
+export { cacheCommandsEnum as cacheCommands };
+export { clientStatusEnum as clientStatus };
+export { cacheOverrideModeEnum as cacheOverrideMode };
+export declare var createRedisClient: (identifier: string) => RedisClient;
+import ConnectionObserver = require("#connection-observer");
+export type TiRedisCommand = string;
+/**
+ * Enum for listing all used Redis cache commands.
+ *
+ * @readonly
+ * @enum {string}
+ * @typedef {string} TiRedisCommand
+ */
+declare let cacheCommandsEnum: import("../components/definitions.types").TiEnumOf<{
+    ADD_TO_SET: string[];
+    DELETE_VALUE: string[];
+    EXPIRE: string[];
+    GET_ALL_FROM_SET: string[];
+    GET_VALUE: string[];
+    HASH_GET: string[];
+    HASH_GET_ALL: string[];
+    HASH_REMOVE: string[];
+    HASH_EXPIRE: string[];
+    HASH_SET: string[];
+    HASH_SET_MANY: string[];
+    IS_SET_MEMBER: string[];
+    JSON_ARRAY_APPEND: string[];
+    JSON_GET: string[];
+    JSON_MERGE: string[];
+    JSON_MGET: string[];
+    JSON_SET: string[];
+    KEYS: string[];
+    LIST_PUSH: string[];
+    LIST_POP_TAIL_BLOCKING: string[];
+    LIST_POP_TAIL_PUSH_HEAD_BLOCKING: string[];
+    LIST_REMOVE: string[];
+    SET_VALUE: string[];
+    UNION_OF_SETS: string[];
+}>;
+export type TiRedisClientStatus = number;
+/**
+ * Enum for listing all client statuses.
+ *
+ * @readonly
+ * @enum {number}
+ * @typedef {number} TiRedisClientStatus
+ */
+declare let clientStatusEnum: import("../components/definitions.types").TiEnumOf<{
+    UNINITIALIZED: (string | number)[];
+    CONNECTED: (string | number)[];
+    CONNECTING: (string | number)[];
+    DISRUPTED: (string | number)[];
+    SHUTTING_DOWN: (string | number)[];
+    DISCONNECTED: (string | number)[];
+}>;
+export type TiRedisOverrideMode = string;
+/**
+ * Enum for listing the Redis key override modes.
+ *
+ * @readonly
+ * @enum {string}
+ * @typedef {string} TiRedisOverrideMode
+ */
+declare let cacheOverrideModeEnum: import("../components/definitions.types").TiEnumOf<{
+    DEFAULT: string[];
+    NX: string[];
+    XX: string[];
+}>;
+/**
+ * Used to create a Redis Cache client.
+ * <br/>
+ * NOTE: This client is set to automatically resend all pending commands on connection recovery with no limit on the retry attempts.
+ * This is done to avoid losing any pending commands in case of a connection failure. For a different behavior, use custom implementation.
+ *
+ * @class RedisClient
+ * @public
+ */
+declare class RedisClient {
+    #private;
+    /**
+     * @constructor
+     * @param {string} identifier
+     * @returns {RedisClient}
+     */
+    constructor(identifier: string);
+    /**
+     * Used to return the Redis client identifier assigned internally.
+     *
+     * @property
+     * @returns {string}
+     * @public
+     */
+    get identifier(): string;
+    /**
+     * Used to return the client ID assigned by the Redis server.
+     *
+     * @property
+     * @returns {number}
+     * @public
+     */
+    get clientID(): number;
+    /**
+     * Used to return the Redis client status.
+     *
+     * @property
+     * @returns {number}
+     * @public
+     */
+    get clientStatus(): number;
+    /**
+     * Used to return the Redis server version.
+     *
+     * @property
+     * @returns {number}
+     * @public
+     */
+    get serverVersion(): number;
+    /**
+     * Verify if Redis server supports JSON data types.
+     *
+     * @property
+     * @returns {boolean}
+     * @public
+     */
+    get isJSONSupported(): boolean;
+    /**
+     * Used to initialize the Redis client.
+     *
+     * @method
+     * @param {string} host
+     * @param {number} port
+     * @param {string} authKey
+     * @param {string} user
+     * @param {number} defaultDB
+     * @param {number} [retryMaxIntervalMs=1000] Optional max backoff interval.
+     * @param {number|undefined} [retryMaxAttempts=undefined] Optional max (re)connection attempts before abort.
+     * @public
+     */
+    initialize(host: string, port: number, authKey: string, user: string, defaultDB: number, retryMaxIntervalMs?: number, retryMaxAttempts?: number | undefined): Promise<any>;
+    /**
+     * Used to register a new {@link ConnectionObserver} for events related to the Redis connection state.
+     *
+     * @method
+     * @param {ConnectionObserver} connectionObserver The {@link ConnectionObserver} that will be notified of any changes.
+     * @public
+     */
+    addConnectionObserver(connectionObserver: ConnectionObserver): void;
+    /**
+     * Used to execute multiple commands within a Redis transaction.
+     *
+     * @method
+     * @param {Array[]} commands
+     * @returns {Promise<*>}
+     * @public
+     */
+    executeCommands(commands: any[][]): Promise<any>;
+    /**
+     * Used to send a new blocking command to Redis.
+     * <br/>
+     * WARNING: This will reserve the client connection until a result is received.
+     *
+     * @method
+     * @param {string} command
+     * @param {Array} commandArguments
+     * @returns {Promise<*>}
+     * @public
+     */
+    blockingCommand(command: string, commandArguments: any[]): Promise<any>;
+    /**
+     * Used to publish a message to the specified channel.
+     *
+     * @method
+     * @param {string} channel
+     * @param {(Object|string)} message
+     * @returns {Promise<number>}
+     * @public
+     */
+    publishCommand(channel: string, message: (Object | string)): Promise<number>;
+    /**
+     * Used to subscribe to the specified channel for messages.
+     * <br/>
+     * NOTE: Call unsubscribeCommand(channel) to detach later.
+     *
+     * @method
+     * @param {string} channel Unique identifier of the channel to subscribe to.
+     * @param {(message: Object) => void} messageHandler Will execute this handler every time a new message is received.
+     * @returns {Promise}
+     * @public
+     */
+    subscribeCommand(channel: string, messageHandler: (message: Object) => void): Promise<any>;
+    /**
+     * Used to unsubscribe from a channel and remove its message handler.
+     *
+     * @method
+     * @param {string} channel Unique identifier of the channel to unsubscribe from.
+     * @returns {Promise}
+     * @public
+     */
+    unsubscribeCommand(channel: string): Promise<any>;
+    /**
+     * Used to execute any Redis command in an unmanaged way.
+     * <br/>
+     * WARNING: Use this only if there is no other implemented function in this module and the command
+     * you want to execute is not supported by the 'multi' Redis command (implemented in {@link RedisClient.executeCommands}).
+     * Make sure to handle the result as it will be returned raw.
+     *
+     * @method
+     * @param {string[]} commandArguments
+     * @returns {Promise<Object>}
+     * @public
+     */
+    callCommand(commandArguments: string[]): Promise<Object>;
+    /**
+     * Used to gracefully close the Redis connection.
+     * Attempts to quit(), then falls back to disconnect() on timeout.
+     *
+     * @method
+     * @param {number} [timeoutMs=1000]
+     * @returns {Promise}
+     * @public
+     */
+    shutDown(timeoutMs?: number): Promise<any>;
+}

package/types/utils/cache.d.ts

@@ -0,0 +1,320 @@
+declare const _exported: Readonly<CommonMemoryCache>;
+export { _exported as instance };
+import ConnectionObserver = require("#connection-observer");
+/**
+ * Used to create and/or return a Common Memory Cache singleton instance.
+ *
+ * @class CommonMemoryCache
+ * @extends ConnectionObserver
+ * @singleton
+ * @public
+ */
+declare class CommonMemoryCache extends ConnectionObserver {
+    #private;
+    /**
+     * @constructor
+     * @return {CommonMemoryCache}
+     */
+    constructor();
+    /**
+     * Property returning the operational state of the cache.
+     *
+     * @property
+     * @returns {boolean}
+     * @public
+     */
+    get isOperational(): boolean;
+    /**
+     * Property returning the connection identifier of the cache service.
+     *
+     * @property
+     * @returns {string}
+     * @public
+     */
+    get connectionIdentifier(): string;
+    /**
+     * Used to initialize the cache service.
+     *
+     * @method
+     * @returns {Promise}
+     * @public
+     */
+    initialize(): Promise<any>;
+    /**
+     * Used to gracefully shut down the cache service.
+     *
+     * @method
+     * @return {Promise}
+     * @public
+     */
+    shutDown(): Promise<any>;
+    /**
+     * Needs to be invoked by the connection handler when the connection is disrupted.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @override
+     * @public
+     */
+    onConnectionDisrupted(identifier: string): void;
+    /**
+     * Needs to be invoked by the connection handler when the connection is recovered.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @override
+     * @public
+     */
+    onConnectionRecovered(identifier: string): void;
+    /**
+     * Needs to be invoked by the connection handler when the connection is irrevocably lost.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @throws {TiException.E_GEN_SYSTEM_CACHE_UNAVAILABLE} If the cache service is no longer available.
+     * @override
+     * @public
+     */
+    onConnectionLost(identifier: string): void;
+    /**
+     * Used to register a new {@link ConnectionObserver} for events related to the underlying Redis connection state.
+     *
+     * @method
+     * @param {ConnectionObserver} connectionObserver The {@link ConnectionObserver} that will be notified of any changes.
+     * @public
+     */
+    addConnectionObserver(connectionObserver: ConnectionObserver): void;
+    /**
+     * Used to search for keys by a given pattern.
+     *
+     * @method
+     * @param {string} pattern
+     * @returns {Promise<Array>}
+     * @public
+     */
+    matchKeys(pattern: string): Promise<any[]>;
+    /**
+     * Used to set a specific string value.
+     *
+     * @method
+     * @param {string} key
+     * @param {string} value
+     * @param {number} [expiration] Expiration value is in seconds.
+     * @return {Promise<string>}
+     * @public
+     */
+    setValue(key: string, value: string, expiration?: number): Promise<string>;
+    /**
+     * Used to set multiple string values.
+     *
+     * @method
+     * @param {Object} keyValues
+     * @param {string} [prefix]
+     * @param {number} [expiration]
+     * @return {Promise}
+     * @public
+     */
+    setValues(keyValues: Object, prefix?: string, expiration?: number): Promise<any>;
+    /**
+     * Used to get a string value.
+     *
+     * @method
+     * @param {string} key
+     * @return {Promise}
+     * @public
+     */
+    getValue(key: string): Promise<any>;
+    /**
+     * Used to get multiple string values.
+     *
+     * @method
+     * @param {string[]} keys
+     * @param {string} [prefix]
+     * @return {Promise}
+     * @public
+     */
+    getValues(keys: string[], prefix?: string): Promise<any>;
+    /**
+     * Used to delete a value / item.
+     *
+     * @method
+     * @param {string} key
+     * @returns {Promise<boolean>}
+     * @public
+     */
+    deleteValue(key: string): Promise<boolean>;
+    /**
+     * Used to set expiration in seconds to an existing key.
+     * <br/>
+     * NOTE: For performance optimization reasons, only use this only if the Redis command does not itself support the 'EX' argument.
+     *
+     * @method
+     * @param {string} key
+     * @param {number} seconds
+     * @param {string} [name] If you need to expire a field in a hash set instead, provide the name of the set here.
+     * @returns {Promise<number>} This will resolve with the seconds as provided initially by the caller.
+     * @public
+     */
+    expireValue(key: string, seconds: number, name?: string): Promise<number>;
+    /**
+     * Used to add the specified values to a list.
+     *
+     * @method
+     * @param {string} listName
+     * @param {Object[]} values
+     * @returns {Promise<number>}
+     * @public
+     */
+    listPushValue(listName: string, values: Object[]): Promise<number>;
+    /**
+     * Used to add the specified value to a set.
+     *
+     * @method
+     * @param {string} key
+     * @param {string|Object} value
+     * @returns {Promise}
+     * @public
+     */
+    addToSet(key: string, value: string | Object): Promise<any>;
+    /**
+     * Used to add multiple values to multiple sets in one transactional request.
+     * <br/>
+     * NOTE: The two arrays of keys and values must have correct index relations (i.e., first pair on keys[0] and values[0] and so on)!
+     *
+     * @method
+     * @param {string[]} keys
+     * @param {string[]} values
+     * @returns {Promise}
+     * @public
+     */
+    addToSetMulti(keys: string[], values: string[]): Promise<any>;
+    /**
+     * Used to check if the provided value is a member of the specified set.
+     *
+     * @method
+     * @param {string} setName
+     * @param {string} value
+     * @returns {Promise<boolean>}
+     * @public
+     */
+    isSetMember(setName: string, value: string): Promise<boolean>;
+    /**
+     * Used to get all elements of a set.
+     *
+     * @method
+     * @param {string} key
+     * @returns {Promise<Object[]>}
+     * @public
+     */
+    membersOfSet(key: string): Promise<Object[]>;
+    /**
+     * Used to get a union of all elements in the list of sets.
+     *
+     * @method
+     * @param {string[]} keys
+     * @returns {Promise<Object[]>}
+     * @public
+     */
+    unionOfSets(keys: string[]): Promise<Object[]>;
+    /**
+     * Used to set a single hash field.
+     *
+     * @method
+     * @deprecated
+     * @param {string} key
+     * @param {string} name
+     * @param {*} value
+     * @returns {Promise}
+     * @public
+     */
+    hashSetField(key: string, name: string, value: any): Promise<any>;
+    /**
+     * Used to set multiple hash fields.
+     *
+     * @method
+     * @deprecated
+     * @param {string} key
+     * @param {Object[]} fields
+     * @param {string} fields[].name
+     * @param {*} fields[].value
+     * @returns {Promise}
+     * @public
+     */
+    hashSetFields(key: string, fields: {
+        name: string;
+        value: any;
+    }[]): Promise<any>;
+    /**
+     * Used to get a single field from a hash.
+     *
+     * @method
+     * @param {string} key
+     * @param {string} field
+     * @return {Promise}
+     * @public
+     */
+    hashGetField(key: string, field: string): Promise<any>;
+    /**
+     * Used to remove a single field from a hash.
+     *
+     * @method
+     * @param {string} key
+     * @param {string} field
+     * @return {Promise<boolean>} Will return 'true' if the field was removed, 'false' otherwise.
+     * @public
+     */
+    hashDeleteField(key: string, field: string): Promise<boolean>;
+    /**
+     * Used to store a JSON variable.
+     * <br/>
+     * NOTE: Requires ReJSON module installed on server to work.
+     *
+     * @method
+     * @param {string} key
+     * @param {Object} value
+     * @param {string|string[]} [path="$"] A dot-separated JSONPath string, or an array of literal key segments (use the array form when key names may contain dots or other special characters).
+     * @param {number} [overrideMode=0] By default this allows full override for existing keys.
+     * Option 1 will set the key only if it doesn't already exist. Option 2 will set it only if it already exists.
+     * @returns {Promise}
+     * @public
+     */
+    setJSON(key: string, value: Object, path?: string | string[], overrideMode?: number): Promise<any>;
+    /**
+     * Used to fetch a JSON variable.
+     * <br/>
+     * NOTE: Requires ReJSON module installed on server to work.
+     *
+     * @method
+     * @param {string} key
+     * @param {string|string[]} [path="$"] A dot-separated JSONPath string, or an array of literal key segments (use the array form when key names may contain dots or other special characters).
+     * @returns {Promise<Object>}
+     * @public
+     */
+    getJSON(key: string, path?: string | string[]): Promise<Object>;
+    /**
+     * Used to update/edit an existing JSON variable.
+     * <br/>
+     * NOTE: Requires ReJSON module installed on server to work.
+     *
+     * @method
+     * @param {string} key
+     * @param {Object} value
+     * @param {string|string[]} [path="$"] A dot-separated JSONPath string, or an array of literal key segments (use the array form when key names may contain dots or other special characters).
+     * @returns {Promise}
+     * @public
+     */
+    editJSON(key: string, value: Object, path?: string | string[]): Promise<any>;
+    /**
+     * Used to add an item to a JSON array. That array needs to exist already.
+     * <br/>
+     * NOTE: Requires ReJSON module installed on server to work.
+     *
+     * @method
+     * @param {string} key
+     * @param {Object} value
+     * @param {string|string[]} [path="$"] A dot-separated JSONPath string, or an array of literal key segments (use the array form when key names may contain dots or other special characters).
+     * @returns {Promise}
+     * @public
+     */
+    arrayAppendJSON(key: string, value: Object, path?: string | string[]): Promise<any>;
+}

package/types/utils/config.d.ts

@@ -0,0 +1,40 @@
+export { settingsEnum as setting };
+export declare var getSetting: (setting: string | TiSetting, defaultValue?: any) => any;
+export type TiSetting = string;
+/**
+ * Enum for listing all system settings.
+ *
+ * @readonly
+ * @enum {string} Keys of this ENUM are strings.
+ * @typedef {string} TiSetting
+ */
+declare const settingsEnum: import("../components/definitions.types").TiEnumOf<{
+    AUDITING_LOG_CONSOLE_ENABLED: string[];
+    AUDITING_LOG_DETAILS: string[];
+    AUDITING_LOG_MIN_LEVEL: string[];
+    AUDITING_LOG_USES_JSON: string[];
+    GCLOUD_API_KEY: string[];
+    GCLOUD_PROJECT_ID: string[];
+    LOCALIZATION_LABELS_PATH: string[];
+    LOCALIZATION_LANGUAGE: string[];
+    MEMORY_CACHE_AUTH_KEY: string[];
+    MEMORY_CACHE_REDIS_DB: string[];
+    MEMORY_CACHE_REDIS_HOST: string[];
+    MEMORY_CACHE_REDIS_PORT: string[];
+    MEMORY_CACHE_RETRY_MAX_ATTEMPTS: string[];
+    MEMORY_CACHE_RETRY_MAX_INTERVAL: string[];
+    MEMORY_CACHE_USER: string[];
+    MESSAGE_EXCHANGE_QUEUE_PREFIX: string[];
+    MESSAGE_EXCHANGE_MESSAGE_STORE: string[];
+    MESSAGE_EXCHANGE_SECURITY_HASH_ENABLED: string[];
+    MESSAGE_EXCHANGE_SECURITY_HASH_KEY: string[];
+    MESSAGE_EXCHANGE_TRACE_EXPIRATION_TIME: string[];
+    MESSAGE_EXCHANGE_TRACE_LOG_ENABLED: string[];
+    MESSAGE_EXCHANGE_TRACE_REPOSITORY: string[];
+    SERVICE_EXECUTION_TIMEOUT: string[];
+    SERVICE_HEALTH_CHECK_ADDRESS: string[];
+    SERVICE_HEALTH_CHECK_INTERVAL: string[];
+    SERVICE_HEALTH_CHECK_TIMEOUT: string[];
+    SERVICE_REGISTRY_ADDRESS: string[];
+    OPERATION_MODE: string[];
+}>;