@gomomento/sdk-core 1.113.0 → 1.115.0

package/dist/src/internal/clients/cache/AbstractCacheClient.d.ts

@@ -1,6 +1,6 @@
-import { CreateCache, DeleteCache, ListCaches, CacheFlush, CacheGet, CacheSet, CacheDelete, CacheIncrement, IncrementOptions, CacheSetIfNotExists, SetIfNotExistsOptions, SetIfAbsentOptions, SetIfPresentOptions, SetIfEqualOptions, SetIfNotEqualOptions, SetIfPresentAndNotEqualOptions, SetIfAbsentOrEqualOptions, CacheSetFetch, CacheSetAddElement, CacheSetAddElements, CacheSetContainsElement, CacheSetContainsElements, CacheSetRemoveElement, CacheSetRemoveElements, CacheListFetch, CacheListLength, CacheListPushFront, CacheListPushBack, CacheListConcatenateBack, CacheListConcatenateFront, CacheListPopBack, CacheListPopFront, CacheListRemoveValue, CacheListRetain, CacheDictionarySetField, CacheDictionarySetFields, CacheDictionaryGetField, CacheDictionaryGetFields, CacheDictionaryIncrement, CacheDictionaryFetch, CacheDictionaryRemoveField, CacheDictionaryRemoveFields, CacheDictionaryLength, CacheSortedSetFetch, CacheSortedSetPutElement, CacheSortedSetPutElements, CacheSortedSetGetRank, CacheSortedSetGetScore, CacheSortedSetGetScores, CacheSortedSetIncrementScore, CacheSortedSetRemoveElement, CacheSortedSetRemoveElements, CacheSortedSetLength, CacheSortedSetLengthByScore, CacheSortedSetUnionStore, CacheItemGetTtl, CacheItemGetType, CacheKeyExists, CacheKeysExist, CacheUpdateTtl, CacheIncreaseTtl, CacheDecreaseTtl, CacheGetBatch, CacheSetBatch, CacheSetIfAbsent, CacheSetIfPresent, CacheSetIfEqual, CacheSetIfNotEqual, CacheSetIfPresentAndNotEqual, CacheSetIfAbsentOrEqual, CacheSetSample, CacheSetPop, CacheSetLength } from '../../../index';
+import { CreateCache, DeleteCache, ListCaches, CacheFlush, CacheGet, CacheSet, CacheDelete, CacheIncrement, IncrementOptions, CacheSetIfNotExists, SetIfNotExistsOptions, SetIfAbsentOptions, SetIfPresentOptions, SetIfEqualOptions, SetIfNotEqualOptions, SetIfPresentAndNotEqualOptions, SetIfAbsentOrEqualOptions, SetIfPresentAndHashEqualOptions, SetIfPresentAndHashNotEqualOptions, SetIfAbsentOrHashEqualOptions, SetIfAbsentOrHashNotEqualOptions, CacheSetFetch, CacheSetAddElement, CacheSetAddElements, CacheSetContainsElement, CacheSetContainsElements, CacheSetRemoveElement, CacheSetRemoveElements, CacheListFetch, CacheListLength, CacheListPushFront, CacheListPushBack, CacheListConcatenateBack, CacheListConcatenateFront, CacheListPopBack, CacheListPopFront, CacheListRemoveValue, CacheListRetain, CacheDictionarySetField, CacheDictionarySetFields, CacheDictionaryGetField, CacheDictionaryGetFields, CacheDictionaryIncrement, CacheDictionaryFetch, CacheDictionaryRemoveField, CacheDictionaryRemoveFields, CacheDictionaryLength, CacheSortedSetFetch, CacheSortedSetPutElement, CacheSortedSetPutElements, CacheSortedSetGetRank, CacheSortedSetGetScore, CacheSortedSetGetScores, CacheSortedSetIncrementScore, CacheSortedSetRemoveElement, CacheSortedSetRemoveElements, CacheSortedSetLength, CacheSortedSetLengthByScore, CacheSortedSetUnionStore, CacheItemGetTtl, CacheItemGetType, CacheKeyExists, CacheKeysExist, CacheUpdateTtl, CacheIncreaseTtl, CacheDecreaseTtl, CacheGetBatch, CacheSetBatch, CacheSetIfAbsent, CacheSetIfPresent, CacheSetIfEqual, CacheSetIfNotEqual, CacheSetIfPresentAndNotEqual, CacheSetIfAbsentOrEqual, CacheSetSample, CacheSetPop, CacheSetLength, CacheGetWithHash, CacheSetWithHash, CacheSetIfPresentAndHashEqual, CacheSetIfPresentAndHashNotEqual, CacheSetIfAbsentOrHashEqual, CacheSetIfAbsentOrHashNotEqual } from '../../../index';
 import { ListFetchCallOptions, ListRetainCallOptions, SetBatchItem, SortedSetSource } from '../../../utils';
-import { ICacheClient, SetOptions, SetAddElementOptions, SetAddElementsOptions, ListPushFrontOptions, ListPushBackOptions, ListConcatenateBackOptions, ListConcatenateFrontOptions, DictionarySetFieldOptions, DictionarySetFieldsOptions, DictionaryIncrementOptions, SortedSetFetchByRankOptions, SortedSetPutElementOptions, SortedSetPutElementsOptions, SortedSetFetchByScoreOptions, SortedSetGetRankOptions, SortedSetIncrementOptions, SortedSetLengthByScoreOptions, SortedSetUnionStoreOptions, SetBatchOptions, GetOptions, GetBatchOptions } from '../../../clients/ICacheClient';
+import { ICacheClient, SetOptions, SetAddElementOptions, SetAddElementsOptions, ListPushFrontOptions, ListPushBackOptions, ListConcatenateBackOptions, ListConcatenateFrontOptions, DictionarySetFieldOptions, DictionarySetFieldsOptions, DictionaryIncrementOptions, SortedSetFetchByRankOptions, SortedSetPutElementOptions, SortedSetPutElementsOptions, SortedSetFetchByScoreOptions, SortedSetGetRankOptions, SortedSetIncrementOptions, SortedSetLengthByScoreOptions, SortedSetUnionStoreOptions, SetBatchOptions, GetOptions, GetBatchOptions, GetWithHashOptions, SetWithHashOptions } from '../../../clients/ICacheClient';
 import { IControlClient } from './IControlClient';
 import { IDataClient } from './IDataClient';
 import { IPingClient } from './IPingClient';
@@ -57,6 +57,20 @@ export declare abstract class AbstractCacheClient implements ICacheClient {
      * {@link CacheGet.Error} on failure.
      */
     get(cacheName: string, key: string | Uint8Array, options?: GetOptions): Promise<CacheGet.Response>;
+    /**
+     * Gets the value stored for the given key and its hash.
+     *
+     * @param {string} cacheName - The cache to perform the lookup in.
+     * @param {string | Uint8Array} key - The key to look up.
+     * @param {GetOptions} [options]
+     * @param {decompress} [options.decompress=false] - Whether to decompress the value. Overrides the client-wide
+     * automatic decompression setting.
+     * @returns {Promise<CacheGet.Response>} -
+     * {@link CacheGetWithHash.Hit} containing the value and hash if one is found.
+     * {@link CacheGetWithHash.Miss} if the key does not exist.
+     * {@link CacheGetWithHash.Error} on failure.
+     */
+    getWithHash(cacheName: string, key: string | Uint8Array, options?: GetWithHashOptions): Promise<CacheGetWithHash.Response>;
     /**
      * Associates the given key with the given value. If a value for the key is
      * already present it is replaced with the new value.
@@ -73,6 +87,23 @@ export declare abstract class AbstractCacheClient implements ICacheClient {
      * {@link CacheSet.Error} on failure.
      */
     set(cacheName: string, key: string | Uint8Array, value: string | Uint8Array, options?: SetOptions): Promise<CacheSet.Response>;
+    /**
+     * Associates the given key with the given value. If a value for the key is
+     * already present it is replaced with the new value. Returns the hash of the value.
+     *
+     * @param {string} cacheName - The cache to store the value in.
+     * @param {string | Uint8Array} key - The key to set.
+     * @param {string | Uint8Array} value - The value to be stored.
+     * @param {SetOptions} [options]
+     * @param {number} [options.ttl] - The time to live for the item in the cache.
+     * Uses the client's default TTL if this is not supplied.
+     * @param {boolean} [options.compress=false] - Whether to compress the value. Defaults to false.
+     * @returns {Promise<CacheSet.Response>} -
+     * {@link CacheSetWithHash.Stored} on success containing the hash of the value stored.
+     * {@link CacheSetWithHash.NotStored} on not storing the new value.
+     * {@link CacheSetWithHash.Error} on failure.
+     */
+    setWithHash(cacheName: string, key: string | Uint8Array, value: string | Uint8Array, options?: SetWithHashOptions): Promise<CacheSetWithHash.Response>;
     /**
      * Removes the given key from the cache. The key can represent a single value
      * or a collection.
@@ -515,6 +546,74 @@ export declare abstract class AbstractCacheClient implements ICacheClient {
      * {@link CacheSetIfAbsentOrEqual.Error} on failure.
      */
     setIfAbsentOrEqual(cacheName: string, key: string | Uint8Array, field: string | Uint8Array, equal: string | Uint8Array, options?: SetIfAbsentOrEqualOptions): Promise<CacheSetIfAbsentOrEqual.Response>;
+    /**
+     * Associates the given key with the given value if key is present in the cache
+     * and its hash is equal to the supplied 'hashEqual' hash.
+     *
+     * @param {string} cacheName - The cache to store the value in.
+     * @param {string | Uint8Array} key - The key to set.
+     * @param {string | Uint8Array} value - The value to be stored.
+     * @param {Uint8Array} hashEqual - The hash to compare to the cached hash.
+     * @param {SetIfPresentAndHashEqualOptions} [options]
+     * @param {number} [options.ttl] - The time to live for the item in the cache.
+     * Uses the client's default TTL if this is not supplied.
+     * @returns {Promise<CacheSetIfPresentAndHashEqual.Response>} -
+     * {@link CacheSetIfPresentAndHashEqual.Stored} on storing the new value.
+     * {@link CacheSetIfPresentAndHashEqual.NotStored} on not storing the new value.
+     * {@link CacheSetIfPresentAndHashEqual.Error} on failure.
+     */
+    setIfPresentAndHashEqual(cacheName: string, key: string | Uint8Array, value: string | Uint8Array, hashEqual: Uint8Array, options?: SetIfPresentAndHashEqualOptions): Promise<CacheSetIfPresentAndHashEqual.Response>;
+    /**
+     * Associates the given key with the given value if key is present in the cache
+     * and its hash is not equal to the supplied 'hashNotEqual' hash.
+     *
+     * @param {string} cacheName - The cache to store the value in.
+     * @param {string | Uint8Array} key - The key to set.
+     * @param {string | Uint8Array} value - The value to be stored.
+     * @param {Uint8Array} hashNotEqual - The hash to compare to the cached hash.
+     * @param {SetIfPresentAndHashNotEqualOptions} [options]
+     * @param {number} [options.ttl] - The time to live for the item in the cache.
+     * Uses the client's default TTL if this is not supplied.
+     * @returns {Promise<CacheSetIfPresentAndHashNotEqual.Response>} -
+     * {@link CacheSetIfPresentAndHashNotEqual.Stored} on storing the new value.
+     * {@link CacheSetIfPresentAndHashNotEqual.NotStored} on not storing the new value.
+     * {@link CacheSetIfPresentAndHashNotEqual.Error} on failure.
+     */
+    setIfPresentAndHashNotEqual(cacheName: string, key: string | Uint8Array, value: string | Uint8Array, hashNotEqual: Uint8Array, options?: SetIfPresentAndHashNotEqualOptions): Promise<CacheSetIfPresentAndHashNotEqual.Response>;
+    /**
+     * Associates the given key with the given value if key is absent or if the key is
+     * present and its value's hash is equal to the given 'hashEqual' hash.
+     *
+     * @param {string} cacheName - The cache to store the value in.
+     * @param {string | Uint8Array} key - The key to set.
+     * @param {string | Uint8Array} value - The value to be stored.
+     * @param {string | Uint8Array} hashEqual - The value to compare to the cached value.
+     * @param {setIfAbsentOrHashEqualOptions} [options]
+     * @param {number} [options.ttl] - The time to live for the item in the cache.
+     * Uses the client's default TTL if this is not supplied.
+     * @returns {Promise<CacheSetIfAbsentOrHashEqual.Response>} -
+     * {@link CacheSetIfAbsentOrHashEqual.Stored} on storing the new value.
+     * {@link CacheSetIfAbsentOrHashEqual.NotStored} on not storing the new value.
+     * {@link CacheSetIfAbsentOrHashEqual.Error} on failure.
+     */
+    setIfAbsentOrHashEqual(cacheName: string, key: string | Uint8Array, value: string | Uint8Array, hashEqual: Uint8Array, options?: SetIfAbsentOrHashEqualOptions): Promise<CacheSetIfAbsentOrHashEqual.Response>;
+    /**
+     * Associates the given key with the given value if key is absent or if the key is
+     * present and its value's hash is not equal to the given 'hashNotEqual' hash.
+     *
+     * @param {string} cacheName - The cache to store the value in.
+     * @param {string | Uint8Array} key - The key to set.
+     * @param {string | Uint8Array} value - The value to be stored.
+     * @param {string | Uint8Array} hashNotEqual - The value to compare to the cached value.
+     * @param {SetIfAbsentOrHashNotEqualOptions} [options]
+     * @param {number} [options.ttl] - The time to live for the item in the cache.
+     * Uses the client's default TTL if this is not supplied.
+     * @returns {Promise<CacheSetIfAbsentOrHashNotEqual.Response>} -
+     * {@link CacheSetIfAbsentOrHashNotEqual.Stored} on storing the new value.
+     * {@link CacheSetIfAbsentOrHashNotEqual.NotStored} on not storing the new value.
+     * {@link CacheSetIfAbsentOrHashNotEqual.Error} on failure.
+     */
+    setIfAbsentOrHashNotEqual(cacheName: string, key: string | Uint8Array, value: string | Uint8Array, hashNotEqual: Uint8Array, options?: SetIfAbsentOrHashNotEqualOptions): Promise<CacheSetIfAbsentOrHashNotEqual.Response>;
     /**
      * Flushes / clears all the items of the given cache
      *