@gomomento/sdk-core 1.12.8

package/dist/src/messages/responses/topic-item.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Represents the data received from a topic subscription.
+ *
+ * @remarks A subscription is created by calling {@link TopicClient.subscribe}.
+ * The value is guaranteed to be either a {@link string} or a {@link Uint8Array}.
+ * Call the appropriate accessor if you know the type of the value.
+ */
+export declare class TopicItem {
+    private readonly _value;
+    constructor(_value: string | Uint8Array);
+    /**
+     * Returns the data read from the stream.
+     * @returns string | Uint8Array
+     */
+    value(): string | Uint8Array;
+    /**
+     * Returns the data read from the stream as a {@link string}.
+     * @returns string
+     */
+    valueString(): string;
+    /**
+     * Returns the data read from the stream as a {@link Uint8Array}.
+     * @returns Uint8Array
+     */
+    valueUint8Array(): Uint8Array;
+    toString(): string;
+}

package/dist/src/messages/responses/topic-item.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TopicItem = void 0;
+const display_1 = require("../../internal/utils/display");
+/**
+ * Represents the data received from a topic subscription.
+ *
+ * @remarks A subscription is created by calling {@link TopicClient.subscribe}.
+ * The value is guaranteed to be either a {@link string} or a {@link Uint8Array}.
+ * Call the appropriate accessor if you know the type of the value.
+ */
+class TopicItem {
+    constructor(_value) {
+        this._value = _value;
+    }
+    /**
+     * Returns the data read from the stream.
+     * @returns string | Uint8Array
+     */
+    value() {
+        return this._value;
+    }
+    /**
+     * Returns the data read from the stream as a {@link string}.
+     * @returns string
+     */
+    valueString() {
+        return this.value().toString();
+    }
+    /**
+     * Returns the data read from the stream as a {@link Uint8Array}.
+     * @returns Uint8Array
+     */
+    valueUint8Array() {
+        return this.value();
+    }
+    toString() {
+        const display = (0, display_1.truncateString)(this.value().toString());
+        return `${this.constructor.name}: ${display}`;
+    }
+}
+exports.TopicItem = TopicItem;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidG9waWMtaXRlbS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9tZXNzYWdlcy9yZXNwb25zZXMvdG9waWMtaXRlbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwwREFBNEQ7QUFFNUQ7Ozs7OztHQU1HO0FBQ0gsTUFBYSxTQUFTO0lBRXBCLFlBQVksTUFBMkI7UUFDckMsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7SUFDdkIsQ0FBQztJQUNEOzs7T0FHRztJQUNJLEtBQUs7UUFDVixPQUFPLElBQUksQ0FBQyxNQUFNLENBQUM7SUFDckIsQ0FBQztJQUVEOzs7T0FHRztJQUNJLFdBQVc7UUFDaEIsT0FBTyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDakMsQ0FBQztJQUVEOzs7T0FHRztJQUNJLGVBQWU7UUFDcEIsT0FBTyxJQUFJLENBQUMsS0FBSyxFQUFnQixDQUFDO0lBQ3BDLENBQUM7SUFFTSxRQUFRO1FBQ2IsTUFBTSxPQUFPLEdBQUcsSUFBQSx3QkFBYyxFQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1FBQ3hELE9BQU8sR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksS0FBSyxPQUFPLEVBQUUsQ0FBQztJQUNoRCxDQUFDO0NBQ0Y7QUFqQ0QsOEJBaUNDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHt0cnVuY2F0ZVN0cmluZ30gZnJvbSAnLi4vLi4vaW50ZXJuYWwvdXRpbHMvZGlzcGxheSc7XG5cbi8qKlxuICogUmVwcmVzZW50cyB0aGUgZGF0YSByZWNlaXZlZCBmcm9tIGEgdG9waWMgc3Vic2NyaXB0aW9uLlxuICpcbiAqIEByZW1hcmtzIEEgc3Vic2NyaXB0aW9uIGlzIGNyZWF0ZWQgYnkgY2FsbGluZyB7QGxpbmsgVG9waWNDbGllbnQuc3Vic2NyaWJlfS5cbiAqIFRoZSB2YWx1ZSBpcyBndWFyYW50ZWVkIHRvIGJlIGVpdGhlciBhIHtAbGluayBzdHJpbmd9IG9yIGEge0BsaW5rIFVpbnQ4QXJyYXl9LlxuICogQ2FsbCB0aGUgYXBwcm9wcmlhdGUgYWNjZXNzb3IgaWYgeW91IGtub3cgdGhlIHR5cGUgb2YgdGhlIHZhbHVlLlxuICovXG5leHBvcnQgY2xhc3MgVG9waWNJdGVtIHtcbiAgcHJpdmF0ZSByZWFkb25seSBfdmFsdWU6IHN0cmluZyB8IFVpbnQ4QXJyYXk7XG4gIGNvbnN0cnVjdG9yKF92YWx1ZTogc3RyaW5nIHwgVWludDhBcnJheSkge1xuICAgIHRoaXMuX3ZhbHVlID0gX3ZhbHVlO1xuICB9XG4gIC8qKlxuICAgKiBSZXR1cm5zIHRoZSBkYXRhIHJlYWQgZnJvbSB0aGUgc3RyZWFtLlxuICAgKiBAcmV0dXJucyBzdHJpbmcgfCBVaW50OEFycmF5XG4gICAqL1xuICBwdWJsaWMgdmFsdWUoKTogc3RyaW5nIHwgVWludDhBcnJheSB7XG4gICAgcmV0dXJuIHRoaXMuX3ZhbHVlO1xuICB9XG5cbiAgLyoqXG4gICAqIFJldHVybnMgdGhlIGRhdGEgcmVhZCBmcm9tIHRoZSBzdHJlYW0gYXMgYSB7QGxpbmsgc3RyaW5nfS5cbiAgICogQHJldHVybnMgc3RyaW5nXG4gICAqL1xuICBwdWJsaWMgdmFsdWVTdHJpbmcoKTogc3RyaW5nIHtcbiAgICByZXR1cm4gdGhpcy52YWx1ZSgpLnRvU3RyaW5nKCk7XG4gIH1cblxuICAvKipcbiAgICogUmV0dXJucyB0aGUgZGF0YSByZWFkIGZyb20gdGhlIHN0cmVhbSBhcyBhIHtAbGluayBVaW50OEFycmF5fS5cbiAgICogQHJldHVybnMgVWludDhBcnJheVxuICAgKi9cbiAgcHVibGljIHZhbHVlVWludDhBcnJheSgpOiBVaW50OEFycmF5IHtcbiAgICByZXR1cm4gdGhpcy52YWx1ZSgpIGFzIFVpbnQ4QXJyYXk7XG4gIH1cblxuICBwdWJsaWMgdG9TdHJpbmcoKTogc3RyaW5nIHtcbiAgICBjb25zdCBkaXNwbGF5ID0gdHJ1bmNhdGVTdHJpbmcodGhpcy52YWx1ZSgpLnRvU3RyaW5nKCkpO1xuICAgIHJldHVybiBgJHt0aGlzLmNvbnN0cnVjdG9yLm5hbWV9OiAke2Rpc3BsYXl9YDtcbiAgfVxufVxuIl19

package/dist/src/messages/responses/topic-publish.d.ts

@@ -0,0 +1,61 @@
+import { SdkError } from '../../errors/errors';
+import { ResponseBase } from './response-base';
+/**
+ * Parent response type for a topic publish request.  The
+ * response object is resolved to a type-safe object of one of
+ * the following subtypes:
+ *
+ * - {Success}
+ * - {Error}
+ *
+ * `instanceof` type guards can be used to operate on the appropriate subtype.
+ * @example
+ * For example:
+ * ```
+ * if (response instanceof TopicPublish.Error) {
+ *   // Handle error as appropriate.  The compiler will smart-cast `response` to type
+ *   // `TopicPublish.Error` in this block, so you will have access to the properties
+ *   // of the Error class; e.g. `response.errorCode()`.
+ * }
+ * ```
+ */
+export declare abstract class Response extends ResponseBase {
+}
+declare class _Success extends Response {
+}
+declare const Success_base: {
+    new (...args: any[]): {
+        readonly is_success: boolean;
+    };
+} & typeof _Success;
+/**
+ * Indicates a Successful cache set request.
+ */
+export declare class Success extends Success_base {
+}
+declare class _Error extends Response {
+    protected _innerException: SdkError;
+    constructor(_innerException: SdkError);
+}
+declare const Error_base: {
+    new (...args: any[]): {
+        _innerException: SdkError;
+        message(): string;
+        innerException(): SdkError;
+        errorCode(): import("../../errors/errors").MomentoErrorCode;
+        toString(): string;
+    };
+} & typeof _Error;
+/**
+ * Indicates that an error occurred during the cache set request.
+ *
+ * This response object includes the following fields that you can use to determine
+ * how you would like to handle the error:
+ *
+ * - `errorCode()` - a unique Momento error code indicating the type of error that occurred.
+ * - `message()` - a human-readable description of the error
+ * - `innerException()` - the original error that caused the failure; can be re-thrown.
+ */
+export declare class Error extends Error_base {
+}
+export {};

package/dist/src/messages/responses/topic-publish.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = exports.Success = exports.Response = void 0;
+const response_base_1 = require("./response-base");
+/**
+ * Parent response type for a topic publish request.  The
+ * response object is resolved to a type-safe object of one of
+ * the following subtypes:
+ *
+ * - {Success}
+ * - {Error}
+ *
+ * `instanceof` type guards can be used to operate on the appropriate subtype.
+ * @example
+ * For example:
+ * ```
+ * if (response instanceof TopicPublish.Error) {
+ *   // Handle error as appropriate.  The compiler will smart-cast `response` to type
+ *   // `TopicPublish.Error` in this block, so you will have access to the properties
+ *   // of the Error class; e.g. `response.errorCode()`.
+ * }
+ * ```
+ */
+class Response extends response_base_1.ResponseBase {
+}
+exports.Response = Response;
+class _Success extends Response {
+}
+/**
+ * Indicates a Successful cache set request.
+ */
+class Success extends (0, response_base_1.ResponseSuccess)(_Success) {
+}
+exports.Success = Success;
+class _Error extends Response {
+    constructor(_innerException) {
+        super();
+        this._innerException = _innerException;
+    }
+}
+/**
+ * Indicates that an error occurred during the cache set request.
+ *
+ * This response object includes the following fields that you can use to determine
+ * how you would like to handle the error:
+ *
+ * - `errorCode()` - a unique Momento error code indicating the type of error that occurred.
+ * - `message()` - a human-readable description of the error
+ * - `innerException()` - the original error that caused the failure; can be re-thrown.
+ */
+class Error extends (0, response_base_1.ResponseError)(_Error) {
+}
+exports.Error = Error;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidG9waWMtcHVibGlzaC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9tZXNzYWdlcy9yZXNwb25zZXMvdG9waWMtcHVibGlzaC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSxtREFBNkU7QUFFN0U7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQWtCRztBQUNILE1BQXNCLFFBQVMsU0FBUSw0QkFBWTtDQUFHO0FBQXRELDRCQUFzRDtBQUV0RCxNQUFNLFFBQVMsU0FBUSxRQUFRO0NBQUc7QUFFbEM7O0dBRUc7QUFDSCxNQUFhLE9BQVEsU0FBUSxJQUFBLCtCQUFlLEVBQUMsUUFBUSxDQUFDO0NBQUc7QUFBekQsMEJBQXlEO0FBRXpELE1BQU0sTUFBTyxTQUFRLFFBQVE7SUFDM0IsWUFBc0IsZUFBeUI7UUFDN0MsS0FBSyxFQUFFLENBQUM7UUFEWSxvQkFBZSxHQUFmLGVBQWUsQ0FBVTtJQUUvQyxDQUFDO0NBQ0Y7QUFFRDs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFhLEtBQU0sU0FBUSxJQUFBLDZCQUFhLEVBQUMsTUFBTSxDQUFDO0NBQUc7QUFBbkQsc0JBQW1EIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtTZGtFcnJvcn0gZnJvbSAnLi4vLi4vZXJyb3JzL2Vycm9ycyc7XG5pbXBvcnQge1Jlc3BvbnNlQmFzZSwgUmVzcG9uc2VFcnJvciwgUmVzcG9uc2VTdWNjZXNzfSBmcm9tICcuL3Jlc3BvbnNlLWJhc2UnO1xuXG4vKipcbiAqIFBhcmVudCByZXNwb25zZSB0eXBlIGZvciBhIHRvcGljIHB1Ymxpc2ggcmVxdWVzdC4gIFRoZVxuICogcmVzcG9uc2Ugb2JqZWN0IGlzIHJlc29sdmVkIHRvIGEgdHlwZS1zYWZlIG9iamVjdCBvZiBvbmUgb2ZcbiAqIHRoZSBmb2xsb3dpbmcgc3VidHlwZXM6XG4gKlxuICogLSB7U3VjY2Vzc31cbiAqIC0ge0Vycm9yfVxuICpcbiAqIGBpbnN0YW5jZW9mYCB0eXBlIGd1YXJkcyBjYW4gYmUgdXNlZCB0byBvcGVyYXRlIG9uIHRoZSBhcHByb3ByaWF0ZSBzdWJ0eXBlLlxuICogQGV4YW1wbGVcbiAqIEZvciBleGFtcGxlOlxuICogYGBgXG4gKiBpZiAocmVzcG9uc2UgaW5zdGFuY2VvZiBUb3BpY1B1Ymxpc2guRXJyb3IpIHtcbiAqICAgLy8gSGFuZGxlIGVycm9yIGFzIGFwcHJvcHJpYXRlLiAgVGhlIGNvbXBpbGVyIHdpbGwgc21hcnQtY2FzdCBgcmVzcG9uc2VgIHRvIHR5cGVcbiAqICAgLy8gYFRvcGljUHVibGlzaC5FcnJvcmAgaW4gdGhpcyBibG9jaywgc28geW91IHdpbGwgaGF2ZSBhY2Nlc3MgdG8gdGhlIHByb3BlcnRpZXNcbiAqICAgLy8gb2YgdGhlIEVycm9yIGNsYXNzOyBlLmcuIGByZXNwb25zZS5lcnJvckNvZGUoKWAuXG4gKiB9XG4gKiBgYGBcbiAqL1xuZXhwb3J0IGFic3RyYWN0IGNsYXNzIFJlc3BvbnNlIGV4dGVuZHMgUmVzcG9uc2VCYXNlIHt9XG5cbmNsYXNzIF9TdWNjZXNzIGV4dGVuZHMgUmVzcG9uc2Uge31cblxuLyoqXG4gKiBJbmRpY2F0ZXMgYSBTdWNjZXNzZnVsIGNhY2hlIHNldCByZXF1ZXN0LlxuICovXG5leHBvcnQgY2xhc3MgU3VjY2VzcyBleHRlbmRzIFJlc3BvbnNlU3VjY2VzcyhfU3VjY2Vzcykge31cblxuY2xhc3MgX0Vycm9yIGV4dGVuZHMgUmVzcG9uc2Uge1xuICBjb25zdHJ1Y3Rvcihwcm90ZWN0ZWQgX2lubmVyRXhjZXB0aW9uOiBTZGtFcnJvcikge1xuICAgIHN1cGVyKCk7XG4gIH1cbn1cblxuLyoqXG4gKiBJbmRpY2F0ZXMgdGhhdCBhbiBlcnJvciBvY2N1cnJlZCBkdXJpbmcgdGhlIGNhY2hlIHNldCByZXF1ZXN0LlxuICpcbiAqIFRoaXMgcmVzcG9uc2Ugb2JqZWN0IGluY2x1ZGVzIHRoZSBmb2xsb3dpbmcgZmllbGRzIHRoYXQgeW91IGNhbiB1c2UgdG8gZGV0ZXJtaW5lXG4gKiBob3cgeW91IHdvdWxkIGxpa2UgdG8gaGFuZGxlIHRoZSBlcnJvcjpcbiAqXG4gKiAtIGBlcnJvckNvZGUoKWAgLSBhIHVuaXF1ZSBNb21lbnRvIGVycm9yIGNvZGUgaW5kaWNhdGluZyB0aGUgdHlwZSBvZiBlcnJvciB0aGF0IG9jY3VycmVkLlxuICogLSBgbWVzc2FnZSgpYCAtIGEgaHVtYW4tcmVhZGFibGUgZGVzY3JpcHRpb24gb2YgdGhlIGVycm9yXG4gKiAtIGBpbm5lckV4Y2VwdGlvbigpYCAtIHRoZSBvcmlnaW5hbCBlcnJvciB0aGF0IGNhdXNlZCB0aGUgZmFpbHVyZTsgY2FuIGJlIHJlLXRocm93bi5cbiAqL1xuZXhwb3J0IGNsYXNzIEVycm9yIGV4dGVuZHMgUmVzcG9uc2VFcnJvcihfRXJyb3IpIHt9XG4iXX0=

package/dist/src/messages/responses/topic-subscribe.d.ts

@@ -0,0 +1,69 @@
+import { SdkError } from '../../errors/errors';
+import { ResponseBase } from './response-base';
+import { SubscriptionState } from '../../internal/subscription-state';
+/**
+ * Parent response type for a cache get request.  The
+ * response object is resolved to a type-safe object of one of
+ * the following subtypes:
+ *
+ * - {Subscription}
+ * - {Item}
+ * - {Error}
+ *
+ * `instanceof` type guards can be used to operate on the appropriate subtype.
+ * @example
+ * For example:
+ * ```
+ * if (response instanceof TopicSubscribe.Error) {
+ *   // Handle error as appropriate.  The compiler will smart-cast `response` to type
+ *   // `CacheGet.Error` in this block, so you will have access to the properties
+ *   // of the Error class; e.g. `response.errorCode()`.
+ * }
+ * ```
+ */
+export declare abstract class Response extends ResponseBase {
+}
+/**
+ * Encapsulates a topic subscription.
+ *
+ * @remarks Currently allows unsubscribing from the topic.
+ * In the future, this may be extended to include additional
+ * statistics about the subscription.
+ */
+export declare class Subscription extends Response {
+    private subscriptionState;
+    constructor(subscriptionState: SubscriptionState);
+    /**
+     * Unsubscribes from the topic.
+     *
+     * @returns void
+     */
+    unsubscribe(): void;
+    get isSubscribed(): boolean;
+}
+declare class _Error extends Response {
+    protected _innerException: SdkError;
+    constructor(_innerException: SdkError);
+}
+declare const Error_base: {
+    new (...args: any[]): {
+        _innerException: SdkError;
+        message(): string;
+        innerException(): SdkError;
+        errorCode(): import("../../errors/errors").MomentoErrorCode;
+        toString(): string;
+    };
+} & typeof _Error;
+/**
+ * Indicates that an error occurred during the topic subscribe request.
+ *
+ * This response object includes the following fields that you can use to determine
+ * how you would like to handle the error:
+ *
+ * - `errorCode()` - a unique Momento error code indicating the type of error that occurred.
+ * - `message()` - a human-readable description of the error
+ * - `innerException()` - the original error that caused the failure; can be re-thrown.
+ */
+export declare class Error extends Error_base {
+}
+export {};

package/dist/src/messages/responses/topic-subscribe.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = exports.Subscription = exports.Response = void 0;
+const response_base_1 = require("./response-base");
+/**
+ * Parent response type for a cache get request.  The
+ * response object is resolved to a type-safe object of one of
+ * the following subtypes:
+ *
+ * - {Subscription}
+ * - {Item}
+ * - {Error}
+ *
+ * `instanceof` type guards can be used to operate on the appropriate subtype.
+ * @example
+ * For example:
+ * ```
+ * if (response instanceof TopicSubscribe.Error) {
+ *   // Handle error as appropriate.  The compiler will smart-cast `response` to type
+ *   // `CacheGet.Error` in this block, so you will have access to the properties
+ *   // of the Error class; e.g. `response.errorCode()`.
+ * }
+ * ```
+ */
+class Response extends response_base_1.ResponseBase {
+}
+exports.Response = Response;
+/**
+ * Encapsulates a topic subscription.
+ *
+ * @remarks Currently allows unsubscribing from the topic.
+ * In the future, this may be extended to include additional
+ * statistics about the subscription.
+ */
+class Subscription extends Response {
+    constructor(subscriptionState) {
+        super();
+        this.subscriptionState = subscriptionState;
+    }
+    /**
+     * Unsubscribes from the topic.
+     *
+     * @returns void
+     */
+    unsubscribe() {
+        this.subscriptionState.unsubscribe();
+    }
+    get isSubscribed() {
+        return this.subscriptionState.isSubscribed;
+    }
+}
+exports.Subscription = Subscription;
+class _Error extends Response {
+    constructor(_innerException) {
+        super();
+        this._innerException = _innerException;
+    }
+}
+/**
+ * Indicates that an error occurred during the topic subscribe request.
+ *
+ * This response object includes the following fields that you can use to determine
+ * how you would like to handle the error:
+ *
+ * - `errorCode()` - a unique Momento error code indicating the type of error that occurred.
+ * - `message()` - a human-readable description of the error
+ * - `innerException()` - the original error that caused the failure; can be re-thrown.
+ */
+class Error extends (0, response_base_1.ResponseError)(_Error) {
+}
+exports.Error = Error;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidG9waWMtc3Vic2NyaWJlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL21lc3NhZ2VzL3Jlc3BvbnNlcy90b3BpYy1zdWJzY3JpYmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsbURBQTREO0FBRzVEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBbUJHO0FBQ0gsTUFBc0IsUUFBUyxTQUFRLDRCQUFZO0NBQUc7QUFBdEQsNEJBQXNEO0FBRXREOzs7Ozs7R0FNRztBQUNILE1BQWEsWUFBYSxTQUFRLFFBQVE7SUFHeEMsWUFBWSxpQkFBb0M7UUFDOUMsS0FBSyxFQUFFLENBQUM7UUFDUixJQUFJLENBQUMsaUJBQWlCLEdBQUcsaUJBQWlCLENBQUM7SUFDN0MsQ0FBQztJQUVEOzs7O09BSUc7SUFDSSxXQUFXO1FBQ2hCLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUN2QyxDQUFDO0lBRUQsSUFBVyxZQUFZO1FBQ3JCLE9BQU8sSUFBSSxDQUFDLGlCQUFpQixDQUFDLFlBQVksQ0FBQztJQUM3QyxDQUFDO0NBQ0Y7QUFwQkQsb0NBb0JDO0FBRUQsTUFBTSxNQUFPLFNBQVEsUUFBUTtJQUMzQixZQUFzQixlQUF5QjtRQUM3QyxLQUFLLEVBQUUsQ0FBQztRQURZLG9CQUFlLEdBQWYsZUFBZSxDQUFVO0lBRS9DLENBQUM7Q0FDRjtBQUVEOzs7Ozs7Ozs7R0FTRztBQUNILE1BQWEsS0FBTSxTQUFRLElBQUEsNkJBQWEsRUFBQyxNQUFNLENBQUM7Q0FBRztBQUFuRCxzQkFBbUQiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBvbGRlciB2ZXJzaW9ucyBvZiBub2RlIGRvbid0IGhhdmUgdGhlIGdsb2JhbCB1dGlsIHZhcmlhYmxlcyBodHRwczovL2dpdGh1Yi5jb20vbm9kZWpzL25vZGUvaXNzdWVzLzIwMzY1XG5pbXBvcnQge1Nka0Vycm9yfSBmcm9tICcuLi8uLi9lcnJvcnMvZXJyb3JzJztcbmltcG9ydCB7UmVzcG9uc2VCYXNlLCBSZXNwb25zZUVycm9yfSBmcm9tICcuL3Jlc3BvbnNlLWJhc2UnO1xuaW1wb3J0IHtTdWJzY3JpcHRpb25TdGF0ZX0gZnJvbSAnLi4vLi4vaW50ZXJuYWwvc3Vic2NyaXB0aW9uLXN0YXRlJztcblxuLyoqXG4gKiBQYXJlbnQgcmVzcG9uc2UgdHlwZSBmb3IgYSBjYWNoZSBnZXQgcmVxdWVzdC4gIFRoZVxuICogcmVzcG9uc2Ugb2JqZWN0IGlzIHJlc29sdmVkIHRvIGEgdHlwZS1zYWZlIG9iamVjdCBvZiBvbmUgb2ZcbiAqIHRoZSBmb2xsb3dpbmcgc3VidHlwZXM6XG4gKlxuICogLSB7U3Vic2NyaXB0aW9ufVxuICogLSB7SXRlbX1cbiAqIC0ge0Vycm9yfVxuICpcbiAqIGBpbnN0YW5jZW9mYCB0eXBlIGd1YXJkcyBjYW4gYmUgdXNlZCB0byBvcGVyYXRlIG9uIHRoZSBhcHByb3ByaWF0ZSBzdWJ0eXBlLlxuICogQGV4YW1wbGVcbiAqIEZvciBleGFtcGxlOlxuICogYGBgXG4gKiBpZiAocmVzcG9uc2UgaW5zdGFuY2VvZiBUb3BpY1N1YnNjcmliZS5FcnJvcikge1xuICogICAvLyBIYW5kbGUgZXJyb3IgYXMgYXBwcm9wcmlhdGUuICBUaGUgY29tcGlsZXIgd2lsbCBzbWFydC1jYXN0IGByZXNwb25zZWAgdG8gdHlwZVxuICogICAvLyBgQ2FjaGVHZXQuRXJyb3JgIGluIHRoaXMgYmxvY2ssIHNvIHlvdSB3aWxsIGhhdmUgYWNjZXNzIHRvIHRoZSBwcm9wZXJ0aWVzXG4gKiAgIC8vIG9mIHRoZSBFcnJvciBjbGFzczsgZS5nLiBgcmVzcG9uc2UuZXJyb3JDb2RlKClgLlxuICogfVxuICogYGBgXG4gKi9cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBSZXNwb25zZSBleHRlbmRzIFJlc3BvbnNlQmFzZSB7fVxuXG4vKipcbiAqIEVuY2Fwc3VsYXRlcyBhIHRvcGljIHN1YnNjcmlwdGlvbi5cbiAqXG4gKiBAcmVtYXJrcyBDdXJyZW50bHkgYWxsb3dzIHVuc3Vic2NyaWJpbmcgZnJvbSB0aGUgdG9waWMuXG4gKiBJbiB0aGUgZnV0dXJlLCB0aGlzIG1heSBiZSBleHRlbmRlZCB0byBpbmNsdWRlIGFkZGl0aW9uYWxcbiAqIHN0YXRpc3RpY3MgYWJvdXQgdGhlIHN1YnNjcmlwdGlvbi5cbiAqL1xuZXhwb3J0IGNsYXNzIFN1YnNjcmlwdGlvbiBleHRlbmRzIFJlc3BvbnNlIHtcbiAgcHJpdmF0ZSBzdWJzY3JpcHRpb25TdGF0ZTogU3Vic2NyaXB0aW9uU3RhdGU7XG5cbiAgY29uc3RydWN0b3Ioc3Vic2NyaXB0aW9uU3RhdGU6IFN1YnNjcmlwdGlvblN0YXRlKSB7XG4gICAgc3VwZXIoKTtcbiAgICB0aGlzLnN1YnNjcmlwdGlvblN0YXRlID0gc3Vic2NyaXB0aW9uU3RhdGU7XG4gIH1cblxuICAvKipcbiAgICogVW5zdWJzY3JpYmVzIGZyb20gdGhlIHRvcGljLlxuICAgKlxuICAgKiBAcmV0dXJucyB2b2lkXG4gICAqL1xuICBwdWJsaWMgdW5zdWJzY3JpYmUoKTogdm9pZCB7XG4gICAgdGhpcy5zdWJzY3JpcHRpb25TdGF0ZS51bnN1YnNjcmliZSgpO1xuICB9XG5cbiAgcHVibGljIGdldCBpc1N1YnNjcmliZWQoKTogYm9vbGVhbiB7XG4gICAgcmV0dXJuIHRoaXMuc3Vic2NyaXB0aW9uU3RhdGUuaXNTdWJzY3JpYmVkO1xuICB9XG59XG5cbmNsYXNzIF9FcnJvciBleHRlbmRzIFJlc3BvbnNlIHtcbiAgY29uc3RydWN0b3IocHJvdGVjdGVkIF9pbm5lckV4Y2VwdGlvbjogU2RrRXJyb3IpIHtcbiAgICBzdXBlcigpO1xuICB9XG59XG5cbi8qKlxuICogSW5kaWNhdGVzIHRoYXQgYW4gZXJyb3Igb2NjdXJyZWQgZHVyaW5nIHRoZSB0b3BpYyBzdWJzY3JpYmUgcmVxdWVzdC5cbiAqXG4gKiBUaGlzIHJlc3BvbnNlIG9iamVjdCBpbmNsdWRlcyB0aGUgZm9sbG93aW5nIGZpZWxkcyB0aGF0IHlvdSBjYW4gdXNlIHRvIGRldGVybWluZVxuICogaG93IHlvdSB3b3VsZCBsaWtlIHRvIGhhbmRsZSB0aGUgZXJyb3I6XG4gKlxuICogLSBgZXJyb3JDb2RlKClgIC0gYSB1bmlxdWUgTW9tZW50byBlcnJvciBjb2RlIGluZGljYXRpbmcgdGhlIHR5cGUgb2YgZXJyb3IgdGhhdCBvY2N1cnJlZC5cbiAqIC0gYG1lc3NhZ2UoKWAgLSBhIGh1bWFuLXJlYWRhYmxlIGRlc2NyaXB0aW9uIG9mIHRoZSBlcnJvclxuICogLSBgaW5uZXJFeGNlcHRpb24oKWAgLSB0aGUgb3JpZ2luYWwgZXJyb3IgdGhhdCBjYXVzZWQgdGhlIGZhaWx1cmU7IGNhbiBiZSByZS10aHJvd24uXG4gKi9cbmV4cG9ydCBjbGFzcyBFcnJvciBleHRlbmRzIFJlc3BvbnNlRXJyb3IoX0Vycm9yKSB7fVxuIl19

package/dist/src/messages/signing-key.d.ts

@@ -0,0 +1,9 @@
+export declare class SigningKey {
+    private readonly keyId;
+    private readonly expiresAt;
+    private readonly endpoint;
+    constructor(keyId: string, expiresAt: Date, endpoint: string);
+    getKeyId(): string;
+    getExpiresAt(): Date;
+    getEndpoint(): string;
+}

package/dist/src/messages/signing-key.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SigningKey = void 0;
+class SigningKey {
+    constructor(keyId, expiresAt, endpoint) {
+        this.keyId = keyId;
+        this.expiresAt = expiresAt;
+        this.endpoint = endpoint;
+    }
+    getKeyId() {
+        return this.keyId;
+    }
+    getExpiresAt() {
+        return this.expiresAt;
+    }
+    getEndpoint() {
+        return this.endpoint;
+    }
+}
+exports.SigningKey = SigningKey;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2lnbmluZy1rZXkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbWVzc2FnZXMvc2lnbmluZy1rZXkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsTUFBYSxVQUFVO0lBS3JCLFlBQVksS0FBYSxFQUFFLFNBQWUsRUFBRSxRQUFnQjtRQUMxRCxJQUFJLENBQUMsS0FBSyxHQUFHLEtBQUssQ0FBQztRQUNuQixJQUFJLENBQUMsU0FBUyxHQUFHLFNBQVMsQ0FBQztRQUMzQixJQUFJLENBQUMsUUFBUSxHQUFHLFFBQVEsQ0FBQztJQUMzQixDQUFDO0lBRU0sUUFBUTtRQUNiLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNwQixDQUFDO0lBRU0sWUFBWTtRQUNqQixPQUFPLElBQUksQ0FBQyxTQUFTLENBQUM7SUFDeEIsQ0FBQztJQUVNLFdBQVc7UUFDaEIsT0FBTyxJQUFJLENBQUMsUUFBUSxDQUFDO0lBQ3ZCLENBQUM7Q0FDRjtBQXRCRCxnQ0FzQkMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgY2xhc3MgU2lnbmluZ0tleSB7XG4gIHByaXZhdGUgcmVhZG9ubHkga2V5SWQ6IHN0cmluZztcbiAgcHJpdmF0ZSByZWFkb25seSBleHBpcmVzQXQ6IERhdGU7XG4gIHByaXZhdGUgcmVhZG9ubHkgZW5kcG9pbnQ6IHN0cmluZztcblxuICBjb25zdHJ1Y3RvcihrZXlJZDogc3RyaW5nLCBleHBpcmVzQXQ6IERhdGUsIGVuZHBvaW50OiBzdHJpbmcpIHtcbiAgICB0aGlzLmtleUlkID0ga2V5SWQ7XG4gICAgdGhpcy5leHBpcmVzQXQgPSBleHBpcmVzQXQ7XG4gICAgdGhpcy5lbmRwb2ludCA9IGVuZHBvaW50O1xuICB9XG5cbiAgcHVibGljIGdldEtleUlkKCkge1xuICAgIHJldHVybiB0aGlzLmtleUlkO1xuICB9XG5cbiAgcHVibGljIGdldEV4cGlyZXNBdCgpIHtcbiAgICByZXR1cm4gdGhpcy5leHBpcmVzQXQ7XG4gIH1cblxuICBwdWJsaWMgZ2V0RW5kcG9pbnQoKSB7XG4gICAgcmV0dXJuIHRoaXMuZW5kcG9pbnQ7XG4gIH1cbn1cbiJdfQ==

package/dist/src/utils/cache-call-options.d.ts

@@ -0,0 +1,99 @@
+import { CollectionTtl } from './collection-ttl';
+export interface ScalarCallOptions {
+    /**
+     * The time to live in seconds of the object being modified.
+     */
+    ttl?: number;
+}
+export interface CollectionCallOptions {
+    /**
+     * The length of the TTL and whether it should be refreshed when the collection is modified.
+     */
+    ttl?: CollectionTtl;
+}
+export interface FrontTruncatableCallOptions extends CollectionCallOptions {
+    /**
+     * If the collection exceeds this length, remove excess from the start of the list. Must be positive.
+     */
+    truncateFrontToSize?: number;
+}
+export interface BackTruncatableCallOptions extends CollectionCallOptions {
+    /**
+     * If the collection exceeds this length, remove excess from the end of the list. Must be positive.
+     */
+    truncateBackToSize?: number;
+}
+export declare enum SortedSetOrder {
+    Ascending = "ASC",
+    Descending = "DESC"
+}
+export interface SortedSetFetchByRankCallOptions {
+    /**
+     * The rank of the first element to return, inclusive.
+     * If negative, the rank is relative to the end of the list.
+     * If the rank is not specified, the first element is used.
+     */
+    startRank?: number;
+    /**
+     * The rank of the last element to return, exclusive.
+     * If negative, the rank is relative to the end of the list.
+     * If the rank is not specified, the range extends to the end of the list.
+     */
+    endRank?: number;
+    /**
+     * The order in which to return the elements.
+     * If the order is not specified, the elements are returned in ascending order.
+     * If descending order is used, the start and end ranks are interpreted as if
+     * the list were reversed.
+     */
+    order?: SortedSetOrder;
+}
+export interface SortedSetFetchByScoreCallOptions {
+    /**
+     * The minimum score of the elements to return, inclusive.
+     * If the minimum score is not specified, the range extends to the lowest score.
+     */
+    minScore?: number;
+    /**
+     * The maximum score of the elements to return, inclusive.
+     * If the maximum score is not specified, the range extends to the highest score.
+     */
+    maxScore?: number;
+    /**
+     * The order in which to return the elements.
+     * If the order is not specified, the elements are returned in ascending order.
+     */
+    order?: SortedSetOrder;
+    /**
+     * The index offset of the first element to return, relative to the first element in the result set.
+     * If specified must be non-negative (>= 0).
+     * Defaults to zero, ie. the start at first element in the result set.
+     */
+    offset?: number;
+    /**
+     * The maximum number of elements to return.
+     * If specified must be strictly positive (> 0).
+     * Defaults to all elements in the result set.
+     */
+    count?: number;
+}
+export interface ListRetainCallOptions extends CollectionCallOptions {
+    /**
+     * Starting inclusive index of operation.
+     */
+    startIndex?: number;
+    /**
+     * Ending exclusive index of operation.
+     */
+    endIndex?: number;
+}
+export interface ListFetchCallOptions {
+    /**
+     * Starting inclusive index of operation.
+     */
+    startIndex?: number;
+    /**
+     * Ending exclusive index of operation.
+     */
+    endIndex?: number;
+}

package/dist/src/utils/cache-call-options.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortedSetOrder = void 0;
+var SortedSetOrder;
+(function (SortedSetOrder) {
+    SortedSetOrder["Ascending"] = "ASC";
+    SortedSetOrder["Descending"] = "DESC";
+})(SortedSetOrder = exports.SortedSetOrder || (exports.SortedSetOrder = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGUtY2FsbC1vcHRpb25zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3V0aWxzL2NhY2hlLWNhbGwtb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUE4QkEsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLG1DQUFpQixDQUFBO0lBQ2pCLHFDQUFtQixDQUFBO0FBQ3JCLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7Q29sbGVjdGlvblR0bH0gZnJvbSAnLi9jb2xsZWN0aW9uLXR0bCc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgU2NhbGFyQ2FsbE9wdGlvbnMge1xuICAvKipcbiAgICogVGhlIHRpbWUgdG8gbGl2ZSBpbiBzZWNvbmRzIG9mIHRoZSBvYmplY3QgYmVpbmcgbW9kaWZpZWQuXG4gICAqL1xuICB0dGw/OiBudW1iZXI7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQ29sbGVjdGlvbkNhbGxPcHRpb25zIHtcbiAgLyoqXG4gICAqIFRoZSBsZW5ndGggb2YgdGhlIFRUTCBhbmQgd2hldGhlciBpdCBzaG91bGQgYmUgcmVmcmVzaGVkIHdoZW4gdGhlIGNvbGxlY3Rpb24gaXMgbW9kaWZpZWQuXG4gICAqL1xuICB0dGw/OiBDb2xsZWN0aW9uVHRsO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIEZyb250VHJ1bmNhdGFibGVDYWxsT3B0aW9ucyBleHRlbmRzIENvbGxlY3Rpb25DYWxsT3B0aW9ucyB7XG4gIC8qKlxuICAgKiBJZiB0aGUgY29sbGVjdGlvbiBleGNlZWRzIHRoaXMgbGVuZ3RoLCByZW1vdmUgZXhjZXNzIGZyb20gdGhlIHN0YXJ0IG9mIHRoZSBsaXN0LiBNdXN0IGJlIHBvc2l0aXZlLlxuICAgKi9cbiAgdHJ1bmNhdGVGcm9udFRvU2l6ZT86IG51bWJlcjtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBCYWNrVHJ1bmNhdGFibGVDYWxsT3B0aW9ucyBleHRlbmRzIENvbGxlY3Rpb25DYWxsT3B0aW9ucyB7XG4gIC8qKlxuICAgKiBJZiB0aGUgY29sbGVjdGlvbiBleGNlZWRzIHRoaXMgbGVuZ3RoLCByZW1vdmUgZXhjZXNzIGZyb20gdGhlIGVuZCBvZiB0aGUgbGlzdC4gTXVzdCBiZSBwb3NpdGl2ZS5cbiAgICovXG4gIHRydW5jYXRlQmFja1RvU2l6ZT86IG51bWJlcjtcbn1cblxuZXhwb3J0IGVudW0gU29ydGVkU2V0T3JkZXIge1xuICBBc2NlbmRpbmcgPSAnQVNDJyxcbiAgRGVzY2VuZGluZyA9ICdERVNDJyxcbn1cblxuZXhwb3J0IGludGVyZmFjZSBTb3J0ZWRTZXRGZXRjaEJ5UmFua0NhbGxPcHRpb25zIHtcbiAgLyoqXG4gICAqIFRoZSByYW5rIG9mIHRoZSBmaXJzdCBlbGVtZW50IHRvIHJldHVybiwgaW5jbHVzaXZlLlxuICAgKiBJZiBuZWdhdGl2ZSwgdGhlIHJhbmsgaXMgcmVsYXRpdmUgdG8gdGhlIGVuZCBvZiB0aGUgbGlzdC5cbiAgICogSWYgdGhlIHJhbmsgaXMgbm90IHNwZWNpZmllZCwgdGhlIGZpcnN0IGVsZW1lbnQgaXMgdXNlZC5cbiAgICovXG4gIHN0YXJ0UmFuaz86IG51bWJlcjtcbiAgLyoqXG4gICAqIFRoZSByYW5rIG9mIHRoZSBsYXN0IGVsZW1lbnQgdG8gcmV0dXJuLCBleGNsdXNpdmUuXG4gICAqIElmIG5lZ2F0aXZlLCB0aGUgcmFuayBpcyByZWxhdGl2ZSB0byB0aGUgZW5kIG9mIHRoZSBsaXN0LlxuICAgKiBJZiB0aGUgcmFuayBpcyBub3Qgc3BlY2lmaWVkLCB0aGUgcmFuZ2UgZXh0ZW5kcyB0byB0aGUgZW5kIG9mIHRoZSBsaXN0LlxuICAgKi9cbiAgZW5kUmFuaz86IG51bWJlcjtcbiAgLyoqXG4gICAqIFRoZSBvcmRlciBpbiB3aGljaCB0byByZXR1cm4gdGhlIGVsZW1lbnRzLlxuICAgKiBJZiB0aGUgb3JkZXIgaXMgbm90IHNwZWNpZmllZCwgdGhlIGVsZW1lbnRzIGFyZSByZXR1cm5lZCBpbiBhc2NlbmRpbmcgb3JkZXIuXG4gICAqIElmIGRlc2NlbmRpbmcgb3JkZXIgaXMgdXNlZCwgdGhlIHN0YXJ0IGFuZCBlbmQgcmFua3MgYXJlIGludGVycHJldGVkIGFzIGlmXG4gICAqIHRoZSBsaXN0IHdlcmUgcmV2ZXJzZWQuXG4gICAqL1xuICBvcmRlcj86IFNvcnRlZFNldE9yZGVyO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIFNvcnRlZFNldEZldGNoQnlTY29yZUNhbGxPcHRpb25zIHtcbiAgLyoqXG4gICAqIFRoZSBtaW5pbXVtIHNjb3JlIG9mIHRoZSBlbGVtZW50cyB0byByZXR1cm4sIGluY2x1c2l2ZS5cbiAgICogSWYgdGhlIG1pbmltdW0gc2NvcmUgaXMgbm90IHNwZWNpZmllZCwgdGhlIHJhbmdlIGV4dGVuZHMgdG8gdGhlIGxvd2VzdCBzY29yZS5cbiAgICovXG4gIG1pblNjb3JlPzogbnVtYmVyO1xuICAvKipcbiAgICogVGhlIG1heGltdW0gc2NvcmUgb2YgdGhlIGVsZW1lbnRzIHRvIHJldHVybiwgaW5jbHVzaXZlLlxuICAgKiBJZiB0aGUgbWF4aW11bSBzY29yZSBpcyBub3Qgc3BlY2lmaWVkLCB0aGUgcmFuZ2UgZXh0ZW5kcyB0byB0aGUgaGlnaGVzdCBzY29yZS5cbiAgICovXG4gIG1heFNjb3JlPzogbnVtYmVyO1xuICAvKipcbiAgICogVGhlIG9yZGVyIGluIHdoaWNoIHRvIHJldHVybiB0aGUgZWxlbWVudHMuXG4gICAqIElmIHRoZSBvcmRlciBpcyBub3Qgc3BlY2lmaWVkLCB0aGUgZWxlbWVudHMgYXJlIHJldHVybmVkIGluIGFzY2VuZGluZyBvcmRlci5cbiAgICovXG4gIG9yZGVyPzogU29ydGVkU2V0T3JkZXI7XG4gIC8qKlxuICAgKiBUaGUgaW5kZXggb2Zmc2V0IG9mIHRoZSBmaXJzdCBlbGVtZW50IHRvIHJldHVybiwgcmVsYXRpdmUgdG8gdGhlIGZpcnN0IGVsZW1lbnQgaW4gdGhlIHJlc3VsdCBzZXQuXG4gICAqIElmIHNwZWNpZmllZCBtdXN0IGJlIG5vbi1uZWdhdGl2ZSAoPj0gMCkuXG4gICAqIERlZmF1bHRzIHRvIHplcm8sIGllLiB0aGUgc3RhcnQgYXQgZmlyc3QgZWxlbWVudCBpbiB0aGUgcmVzdWx0IHNldC5cbiAgICovXG4gIG9mZnNldD86IG51bWJlcjtcbiAgLyoqXG4gICAqIFRoZSBtYXhpbXVtIG51bWJlciBvZiBlbGVtZW50cyB0byByZXR1cm4uXG4gICAqIElmIHNwZWNpZmllZCBtdXN0IGJlIHN0cmljdGx5IHBvc2l0aXZlICg+IDApLlxuICAgKiBEZWZhdWx0cyB0byBhbGwgZWxlbWVudHMgaW4gdGhlIHJlc3VsdCBzZXQuXG4gICAqL1xuICBjb3VudD86IG51bWJlcjtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBMaXN0UmV0YWluQ2FsbE9wdGlvbnMgZXh0ZW5kcyBDb2xsZWN0aW9uQ2FsbE9wdGlvbnMge1xuICAvKipcbiAgICogU3RhcnRpbmcgaW5jbHVzaXZlIGluZGV4IG9mIG9wZXJhdGlvbi5cbiAgICovXG4gIHN0YXJ0SW5kZXg/OiBudW1iZXI7XG5cbiAgLyoqXG4gICAqIEVuZGluZyBleGNsdXNpdmUgaW5kZXggb2Ygb3BlcmF0aW9uLlxuICAgKi9cbiAgZW5kSW5kZXg/OiBudW1iZXI7XG59XG5leHBvcnQgaW50ZXJmYWNlIExpc3RGZXRjaENhbGxPcHRpb25zIHtcbiAgLyoqXG4gICAqIFN0YXJ0aW5nIGluY2x1c2l2ZSBpbmRleCBvZiBvcGVyYXRpb24uXG4gICAqL1xuICBzdGFydEluZGV4PzogbnVtYmVyO1xuXG4gIC8qKlxuICAgKiBFbmRpbmcgZXhjbHVzaXZlIGluZGV4IG9mIG9wZXJhdGlvbi5cbiAgICovXG4gIGVuZEluZGV4PzogbnVtYmVyO1xufVxuIl19

package/dist/src/utils/collection-ttl.d.ts

@@ -0,0 +1,78 @@
+/** Represents the desired behavior for managing the TTL on collection
+ *  objects (dictionaries, lists, sets) in your cache.
+ *
+ *  For cache operations that modify a collection, there are a few things
+ *  to consider.  The first time the collection is created, we need to
+ *  set a TTL on it.  For subsequent operations that modify the collection
+ *  you may choose to update the TTL in order to prolong the life of the
+ *  cached collection object, or you may choose to leave the TTL unmodified
+ *  in order to ensure that the collection expires at the original TTL.
+ *
+ *  The default behavior is to refresh the TTL (to prolong the life of the
+ *  collection) each time it is written.  This behavior can be modified
+ *  by calling CollectionTtl.withNoRefreshTtlOnUpdates().
+ *
+ *  A null TTL means to use the client's TTL.
+ */
+export declare class CollectionTtl {
+    private readonly _ttlSeconds;
+    private readonly _refreshTtl;
+    /**
+     * If refreshTtl is true, the client must update the collection's TTL
+     * when it modifies a collection.
+     * A null ttl means to use the client's TTL.
+     * @param {number | null} [ttlSeconds=null]
+     * @param {boolean} [refreshTtl=true]
+     */
+    constructor(ttlSeconds?: number | null, refreshTtl?: boolean);
+    /** Time-to-live, in seconds.
+     * @returns {number | null}
+     */
+    ttlSeconds(): number | null;
+    /** Time-to-live, in milliseconds.
+     * @returns {number | null}
+     */
+    ttlMilliseconds(): number | null;
+    /** Whether or not to refresh a collection's TTL when it's modified.
+     * @returns {boolean}
+     */
+    refreshTtl(): boolean;
+    /** The default way to handle TTLs for collections. The client's default TTL
+     *  will be used, and the TTL for the collection will be refreshed any
+     *  time the collection is modified.
+     * @constructor
+     * @returns {CollectionTtl}
+     */
+    static fromCacheTtl(): CollectionTtl;
+    /** Constructs a CollectionTtl with the specified TTL. The TTL
+     *  for the collection will be refreshed any time the collection is
+     *  modified.
+     * @constructor
+     * @param {number} [ttlSeconds]
+     * @returns {CollectionTtl}
+     */
+    static of(ttlSeconds: number): CollectionTtl;
+    /** Constructs a CollectionTtl with the specified TTL.
+     *  Will only refresh if the TTL is provided.
+     * @constructor
+     * @param {number | null} [ttlSeconds=null]
+     * @returns {CollectionTtl}
+     */
+    static refreshTtlIfProvided(ttlSeconds?: number | null): CollectionTtl;
+    /** Copies the CollectionTtl, but it will refresh the TTL when
+     *  the collection is modified.
+     * @returns {CollectionTtl}
+     */
+    withRefreshTtlOnUpdates(): CollectionTtl;
+    /** Copies the CollectionTTL, but the TTL will not be refreshed
+     *  when the collection is modified. Use this if you want to ensure
+     *  that your collection expires at the originally specified time, even
+     *  if you make modifications to the value of the collection.
+     * @returns {CollectionTtl}
+     */
+    withNoRefreshTtlOnUpdates(): CollectionTtl;
+    /** A string represenation of the CollectionTtl for debugging purposes.
+     * @return {CollectionTtl}
+     */
+    toString(): string;
+}