@redis/time-series 1.0.3 → 1.0.5

package/README.md

@@ -4,4 +4,148 @@ This package provides support for the [RedisTimeSeries](https://redistimeseries.
 
 To use these extra commands, your Redis server must have the RedisTimeSeries module installed.
 
-For an example of how to add values to a time series, query a time series, and perform aggregated queries against a time series, see `time-series.js` in the Node Redis examples folder.
+## Usage
+
+For a complete example, see [`time-series.js`](https://github.com/redis/node-redis/blob/master/examples/time-series.js) in the Node Redis examples folder.
+
+### Creating Time Series data structure in Redis
+
+The [`TS.CREATE`](https://oss.redis.com/redistimeseries/commands/#tscreate) command creates a new time series.
+
+Here, we'll create a new time series "`temperature`":
+
+```javascript
+
+import { createClient } from 'redis';
+import { TimeSeriesDuplicatePolicies, TimeSeriesEncoding, TimeSeriesAggregationType } from '@redis/time-series';
+
+...
+
+ const created = await client.ts.create('temperature', {
+    RETENTION: 86400000, // 1 day in milliseconds
+    ENCODING: TimeSeriesEncoding.UNCOMPRESSED, // No compression - When not specified, the option is set to COMPRESSED
+    DUPLICATE_POLICY: TimeSeriesDuplicatePolicies.BLOCK, // No duplicates - When not specified: set to the global DUPLICATE_POLICY configuration of the database (which by default, is BLOCK).
+  });
+
+    if (created === 'OK') {
+    console.log('Created timeseries.');
+  } else {
+    console.log('Error creating timeseries :(');
+    process.exit(1);
+  }
+
+```
+
+### Adding new value to a Time Series data structure in Redis
+
+With RedisTimeSeries, we can add a single value to time series data structure using the [`TS.ADD`](https://redis.io/commands/ts.add/) command and if we would like to add multiple values we can use the [`TS.MADD`](https://redis.io/commands/ts.madd/) command.
+
+```javascript
+
+let value = Math.floor(Math.random() * 1000) + 1; // Random data point value
+  let currentTimestamp = 1640995200000; // Jan 1 2022 00:00:00
+  let num = 0;
+
+  while (num < 10000) {
+    // Add a new value to the timeseries, providing our own timestamp:
+    // https://redis.io/commands/ts.add/
+    await client.ts.add('temperature', currentTimestamp, value);
+    console.log(`Added timestamp ${currentTimestamp}, value ${value}.`);
+
+    num += 1;
+    value = Math.floor(Math.random() * 1000) + 1; // Get another random value
+    currentTimestamp += 1000; // Move on one second.
+  }
+
+  // Add multiple values to the timeseries in round trip to the server:
+  // https://redis.io/commands/ts.madd/
+  const response = await client.ts.mAdd([{
+    key: 'temperature',
+    timestamp: currentTimestamp + 60000,
+    value: Math.floor(Math.random() * 1000) + 1
+  }, {
+    key: 'temperature',
+    timestamp: currentTimestamp + 120000,
+    value: Math.floor(Math.random() * 1000) + 1
+  }]);
+
+
+```
+
+### Retrieving Time Series data from Redis
+
+With RedisTimeSeries, we can retrieve the time series data using the [`TS.RANGE`](https://redis.io/commands/ts.range/) command by passing the criteria as follows:
+
+```javascript
+
+// Query the timeseries with TS.RANGE:
+  // https://redis.io/commands/ts.range/
+  const fromTimestamp = 1640995200000; // Jan 1 2022 00:00:00
+  const toTimestamp = 1640995260000; // Jan 1 2022 00:01:00
+  const rangeResponse = await client.ts.range('temperature', fromTimestamp, toTimestamp, {
+    // Group into 10 second averages.
+    AGGREGATION: {
+      type: TimeSeriesAggregationType.AVERAGE,
+      timeBucket: 10000
+    }
+  });
+
+  console.log('RANGE RESPONSE:');
+  // rangeResponse looks like:
+  // [
+  //   { timestamp: 1640995200000, value: 356.8 },
+  //   { timestamp: 1640995210000, value: 534.8 },
+  //   { timestamp: 1640995220000, value: 481.3 },
+  //   { timestamp: 1640995230000, value: 437 },
+  //   { timestamp: 1640995240000, value: 507.3 },
+  //   { timestamp: 1640995250000, value: 581.2 },
+  //   { timestamp: 1640995260000, value: 600 }
+  // ]
+
+```
+
+### Altering Time Series data Stored in Redis
+
+RedisTimeSeries includes commands that can update values in a time series data structure.
+
+Using the [`TS.ALTER`](https://redis.io/commands/ts.alter/) command, we can update time series retention like this:
+
+```javascript
+
+  // https://redis.io/commands/ts.alter/
+  const alterResponse = await client.ts.alter('temperature', {
+    RETENTION: 0 // Keep the entries forever
+  });
+
+```
+
+### Retrieving Information about the timeseries Stored in Redis
+
+RedisTimeSeries also includes commands that can help to view the information on the state of a time series.
+
+Using the [`TS.INFO`](https://redis.io/commands/ts.info/) command, we can view timeseries information like this:
+
+```javascript
+
+ // Get some information about the state of the timeseries.
+  // https://redis.io/commands/ts.info/
+  const tsInfo = await client.ts.info('temperature');
+
+  // tsInfo looks like this:
+  // {
+  //   totalSamples: 1440,
+  //   memoryUsage: 28904,
+  //   firstTimestamp: 1641508920000,
+  //   lastTimestamp: 1641595320000,
+  //   retentionTime: 86400000,
+  //   chunkCount: 7,
+  //   chunkSize: 4096,
+  //   chunkType: 'uncompressed',
+  //   duplicatePolicy: 'block',
+  //   labels: [],
+  //   sourceKey: null,
+  //   rules: []
+  // }
+
+```
+

package/dist/commands/ALTER.d.ts

@@ -1,7 +1,9 @@
-import { Labels } from '.';
+import { Labels, TimeSeriesDuplicatePolicies } from '.';
 export declare const FIRST_KEY_INDEX = 1;
 interface AlterOptions {
     RETENTION?: number;
+    CHUNK_SIZE?: number;
+    DUPLICATE_POLICY?: TimeSeriesDuplicatePolicies;
     LABELS?: Labels;
 }
 export declare function transformArguments(key: string, options?: AlterOptions): Array<string>;

package/dist/commands/ALTER.js

@@ -6,6 +6,8 @@ exports.FIRST_KEY_INDEX = 1;
 function transformArguments(key, options) {
     const args = ['TS.ALTER', key];
     (0, _1.pushRetentionArgument)(args, options?.RETENTION);
+    (0, _1.pushChunkSizeArgument)(args, options?.CHUNK_SIZE);
+    (0, _1.pushDuplicatePolicy)(args, options?.DUPLICATE_POLICY);
     (0, _1.pushLabelsArgument)(args, options?.LABELS);
     return args;
 }

package/dist/commands/CREATE.js

@@ -8,9 +8,7 @@ function transformArguments(key, options) {
     (0, _1.pushRetentionArgument)(args, options?.RETENTION);
     (0, _1.pushEncodingArgument)(args, options?.ENCODING);
     (0, _1.pushChunkSizeArgument)(args, options?.CHUNK_SIZE);
-    if (options?.DUPLICATE_POLICY) {
-        args.push('DUPLICATE_POLICY', options.DUPLICATE_POLICY);
-    }
+    (0, _1.pushDuplicatePolicy)(args, options?.DUPLICATE_POLICY);
     (0, _1.pushLabelsArgument)(args, options?.LABELS);
     return args;
 }

package/dist/commands/CREATERULE.d.ts

@@ -1,4 +1,4 @@
 import { TimeSeriesAggregationType } from '.';
 export declare const FIRST_KEY_INDEX = 1;
-export declare function transformArguments(sourceKey: string, destinationKey: string, aggregationType: TimeSeriesAggregationType, timeBucket: number): Array<string>;
+export declare function transformArguments(sourceKey: string, destinationKey: string, aggregationType: TimeSeriesAggregationType, bucketDuration: number, alignTimestamp?: number): Array<string>;
 export declare function transformReply(): 'OK';

package/dist/commands/CREATERULE.js

@@ -2,14 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformArguments = exports.FIRST_KEY_INDEX = void 0;
 exports.FIRST_KEY_INDEX = 1;
-function transformArguments(sourceKey, destinationKey, aggregationType, timeBucket) {
-    return [
+function transformArguments(sourceKey, destinationKey, aggregationType, bucketDuration, alignTimestamp) {
+    const args = [
         'TS.CREATERULE',
         sourceKey,
         destinationKey,
         'AGGREGATION',
         aggregationType,
-        timeBucket.toString()
+        bucketDuration.toString()
     ];
+    if (alignTimestamp) {
+        args.push(alignTimestamp.toString());
+    }
+    return args;
 }
 exports.transformArguments = transformArguments;

package/dist/commands/DELETERULE.js

@@ -6,7 +6,7 @@ function transformArguments(sourceKey, destinationKey) {
     return [
         'TS.DELETERULE',
         sourceKey,
-        destinationKey,
+        destinationKey
     ];
 }
 exports.transformArguments = transformArguments;

package/dist/commands/GET.d.ts

@@ -1,5 +1,10 @@
+import { RedisCommandArguments } from '@redis/client/dist/lib/commands';
 import { SampleRawReply, SampleReply } from '.';
 export declare const FIRST_KEY_INDEX = 1;
 export declare const IS_READ_ONLY = true;
-export declare function transformArguments(key: string): Array<string>;
+interface GetOptions {
+    LATEST?: boolean;
+}
+export declare function transformArguments(key: string, options?: GetOptions): RedisCommandArguments;
 export declare function transformReply(reply: [] | SampleRawReply): null | SampleReply;
+export {};

package/dist/commands/GET.js

@@ -4,8 +4,8 @@ exports.transformReply = exports.transformArguments = exports.IS_READ_ONLY = exp
 const _1 = require(".");
 exports.FIRST_KEY_INDEX = 1;
 exports.IS_READ_ONLY = true;
-function transformArguments(key) {
-    return ['TS.GET', key];
+function transformArguments(key, options) {
+    return (0, _1.pushLatestArgument)(['TS.GET', key], options?.LATEST);
 }
 exports.transformArguments = transformArguments;
 function transformReply(reply) {

package/dist/commands/INFO.d.ts

@@ -2,31 +2,31 @@ import { TimeSeriesAggregationType, TimeSeriesDuplicatePolicies } from '.';
 export declare const FIRST_KEY_INDEX = 1;
 export declare const IS_READ_ONLY = true;
 export declare function transformArguments(key: string): Array<string>;
-export declare type InfoRawReply = [
-    _: string,
-    totalSamples: number,
-    _: string,
-    memoryUsage: number,
-    _: string,
-    firstTimestamp: number,
-    _: string,
-    lastTimestamp: number,
-    _: string,
-    retentionTime: number,
-    _: string,
-    chunkCount: number,
-    _: string,
-    chunkSize: number,
-    _: string,
-    chunkType: string,
-    _: string,
-    duplicatePolicy: TimeSeriesDuplicatePolicies | null,
-    _: string,
-    labels: Array<[name: string, value: string]>,
-    _: string,
-    sourceKey: string | null,
-    _: string,
-    rules: Array<[key: string, timeBucket: number, aggregationType: TimeSeriesAggregationType]>
+export type InfoRawReply = [
+    'totalSamples',
+    number,
+    'memoryUsage',
+    number,
+    'firstTimestamp',
+    number,
+    'lastTimestamp',
+    number,
+    'retentionTime',
+    number,
+    'chunkCount',
+    number,
+    'chunkSize',
+    number,
+    'chunkType',
+    string,
+    'duplicatePolicy',
+    TimeSeriesDuplicatePolicies | null,
+    'labels',
+    Array<[name: string, value: string]>,
+    'sourceKey',
+    string | null,
+    'rules',
+    Array<[key: string, timeBucket: number, aggregationType: TimeSeriesAggregationType]>
 ];
 export interface InfoReply {
     totalSamples: number;

package/dist/commands/INFO_DEBUG.d.ts

@@ -1,22 +1,22 @@
 import { InfoRawReply, InfoReply } from './INFO';
 export { IS_READ_ONLY, FIRST_KEY_INDEX } from './INFO';
 export declare function transformArguments(key: string): Array<string>;
-declare type InfoDebugRawReply = [
-    ...infoArgs: InfoRawReply,
-    _: string,
-    keySelfName: string,
-    _: string,
-    chunks: Array<[
-        _: string,
-        startTimestamp: number,
-        _: string,
-        endTimestamp: number,
-        _: string,
-        samples: number,
-        _: string,
-        size: number,
-        _: string,
-        bytesPerSample: string
+type InfoDebugRawReply = [
+    ...InfoRawReply,
+    'keySelfName',
+    string,
+    'chunks',
+    Array<[
+        'startTimestamp',
+        number,
+        'endTimestamp',
+        number,
+        'samples',
+        number,
+        'size',
+        number,
+        'bytesPerSample',
+        string
     ]>
 ];
 interface InfoDebugReply extends InfoReply {

package/dist/commands/MGET.d.ts

@@ -1,8 +1,11 @@
 import { RedisCommandArguments } from '@redis/client/dist/lib/commands';
 import { Filter, RawLabels, SampleRawReply, SampleReply } from '.';
 export declare const IS_READ_ONLY = true;
-export declare function transformArguments(filter: Filter): RedisCommandArguments;
-export declare type MGetRawReply = Array<[
+export interface MGetOptions {
+    LATEST?: boolean;
+}
+export declare function transformArguments(filter: Filter, options?: MGetOptions): RedisCommandArguments;
+export type MGetRawReply = Array<[
     key: string,
     labels: RawLabels,
     sample: SampleRawReply

package/dist/commands/MGET.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformReply = exports.transformArguments = exports.IS_READ_ONLY = void 0;
 const _1 = require(".");
 exports.IS_READ_ONLY = true;
-function transformArguments(filter) {
-    return (0, _1.pushFilterArgument)(['TS.MGET'], filter);
+function transformArguments(filter, options) {
+    const args = (0, _1.pushLatestArgument)(['TS.MGET'], options?.LATEST);
+    return (0, _1.pushFilterArgument)(args, filter);
 }
 exports.transformArguments = transformArguments;
 function transformReply(reply) {

package/dist/commands/MGET_WITHLABELS.d.ts

@@ -1,10 +1,11 @@
 import { SelectedLabels, Labels, Filter } from '.';
-import { MGetRawReply, MGetReply } from './MGET';
+import { MGetOptions, MGetRawReply, MGetReply } from './MGET';
+import { RedisCommandArguments } from '@redis/client/dist/lib/commands';
 export declare const IS_READ_ONLY = true;
-interface MGetWithLabelsOptions {
+interface MGetWithLabelsOptions extends MGetOptions {
     SELECTED_LABELS?: SelectedLabels;
 }
-export declare function transformArguments(filter: Filter, options?: MGetWithLabelsOptions): Array<string>;
+export declare function transformArguments(filter: Filter, options?: MGetWithLabelsOptions): RedisCommandArguments;
 export interface MGetWithLabelsReply extends MGetReply {
     labels: Labels;
 }

package/dist/commands/MGET_WITHLABELS.js

@@ -4,10 +4,8 @@ exports.transformReply = exports.transformArguments = exports.IS_READ_ONLY = voi
 const _1 = require(".");
 exports.IS_READ_ONLY = true;
 function transformArguments(filter, options) {
-    const args = ['TS.MGET'];
-    (0, _1.pushWithLabelsArgument)(args, options?.SELECTED_LABELS);
-    (0, _1.pushFilterArgument)(args, filter);
-    return args;
+    const args = (0, _1.pushWithLabelsArgument)(['TS.MGET'], options?.SELECTED_LABELS);
+    return (0, _1.pushFilterArgument)(args, filter);
 }
 exports.transformArguments = transformArguments;
 ;

package/dist/commands/index.d.ts

@@ -66,18 +66,22 @@ declare const _default: {
 };
 export default _default;
 export declare enum TimeSeriesAggregationType {
-    AVERAGE = "avg",
-    SUM = "sum",
-    MINIMUM = "min",
-    MAXIMUM = "max",
-    RANGE = "range",
-    COUNT = "count",
-    FIRST = "first",
-    LAST = "last",
-    STD_P = "std.p",
-    STD_S = "std.s",
-    VAR_P = "var.p",
-    VAR_S = "var.s"
+    AVG = "AVG",
+    AVERAGE = "AVG",
+    FIRST = "FIRST",
+    LAST = "LAST",
+    MIN = "MIN",
+    MINIMUM = "MIN",
+    MAX = "MAX",
+    MAXIMUM = "MAX",
+    SUM = "SUM",
+    RANGE = "RANGE",
+    COUNT = "COUNT",
+    STD_P = "STD.P",
+    STD_S = "STD.S",
+    VAR_P = "VAR.P",
+    VAR_S = "VAR.S",
+    TWA = "TWA"
 }
 export declare enum TimeSeriesDuplicatePolicies {
     BLOCK = "BLOCK",
@@ -88,11 +92,20 @@ export declare enum TimeSeriesDuplicatePolicies {
     SUM = "SUM"
 }
 export declare enum TimeSeriesReducers {
-    SUM = "sum",
-    MINIMUM = "min",
-    MAXIMUM = "max"
+    AVG = "AVG",
+    SUM = "SUM",
+    MIN = "MIN",
+    MINIMUM = "MIN",
+    MAX = "MAX",
+    MAXIMUM = "MAX",
+    RANGE = "range",
+    COUNT = "COUNT",
+    STD_P = "STD.P",
+    STD_S = "STD.S",
+    VAR_P = "VAR.P",
+    VAR_S = "VAR.S"
 }
-export declare type Timestamp = number | Date | string;
+export type Timestamp = number | Date | string;
 export declare function transformTimestampArgument(timestamp: Timestamp): string;
 export declare function pushRetentionArgument(args: RedisCommandArguments, retention?: number): RedisCommandArguments;
 export declare enum TimeSeriesEncoding {
@@ -101,8 +114,9 @@ export declare enum TimeSeriesEncoding {
 }
 export declare function pushEncodingArgument(args: RedisCommandArguments, encoding?: TimeSeriesEncoding): RedisCommandArguments;
 export declare function pushChunkSizeArgument(args: RedisCommandArguments, chunkSize?: number): RedisCommandArguments;
-export declare type RawLabels = Array<[label: string, value: string]>;
-export declare type Labels = {
+export declare function pushDuplicatePolicy(args: RedisCommandArguments, duplicatePolicy?: TimeSeriesDuplicatePolicies): RedisCommandArguments;
+export type RawLabels = Array<[label: string, value: string]>;
+export type Labels = {
     [label: string]: string;
 };
 export declare function transformLablesReply(reply: RawLabels): Labels;
@@ -115,13 +129,19 @@ export interface IncrDecrOptions {
     LABELS?: Labels;
 }
 export declare function transformIncrDecrArguments(command: 'TS.INCRBY' | 'TS.DECRBY', key: string, value: number, options?: IncrDecrOptions): RedisCommandArguments;
-export declare type SampleRawReply = [timestamp: number, value: string];
+export type SampleRawReply = [timestamp: number, value: string];
 export interface SampleReply {
     timestamp: number;
     value: number;
 }
 export declare function transformSampleReply(reply: SampleRawReply): SampleReply;
+export declare enum TimeSeriesBucketTimestamp {
+    LOW = "-",
+    HIGH = "+",
+    MID = "~"
+}
 export interface RangeOptions {
+    LATEST?: boolean;
     FILTER_BY_TS?: Array<Timestamp>;
     FILTER_BY_VALUE?: {
         min: number;
@@ -132,6 +152,8 @@ export interface RangeOptions {
     AGGREGATION?: {
         type: TimeSeriesAggregationType;
         timeBucket: Timestamp;
+        BUCKETTIMESTAMP?: TimeSeriesBucketTimestamp;
+        EMPTY?: boolean;
     };
 }
 export declare function pushRangeArguments(args: RedisCommandArguments, fromTimestamp: Timestamp, toTimestamp: Timestamp, options?: RangeOptions): RedisCommandArguments;
@@ -140,20 +162,20 @@ interface MRangeGroupBy {
     reducer: TimeSeriesReducers;
 }
 export declare function pushMRangeGroupByArguments(args: RedisCommandArguments, groupBy?: MRangeGroupBy): RedisCommandArguments;
-export declare type Filter = string | Array<string>;
+export type Filter = string | Array<string>;
 export declare function pushFilterArgument(args: RedisCommandArguments, filter: string | Array<string>): RedisCommandArguments;
 export interface MRangeOptions extends RangeOptions {
     GROUPBY?: MRangeGroupBy;
 }
 export declare function pushMRangeArguments(args: RedisCommandArguments, fromTimestamp: Timestamp, toTimestamp: Timestamp, filter: Filter, options?: MRangeOptions): RedisCommandArguments;
-export declare type SelectedLabels = string | Array<string>;
+export type SelectedLabels = string | Array<string>;
 export declare function pushWithLabelsArgument(args: RedisCommandArguments, selectedLabels?: SelectedLabels): RedisCommandArguments;
 export interface MRangeWithLabelsOptions extends MRangeOptions {
     SELECTED_LABELS?: SelectedLabels;
 }
 export declare function pushMRangeWithLabelsArguments(args: RedisCommandArguments, fromTimestamp: Timestamp, toTimestamp: Timestamp, filter: Filter, options?: MRangeWithLabelsOptions): RedisCommandArguments;
 export declare function transformRangeReply(reply: Array<SampleRawReply>): Array<SampleReply>;
-declare type MRangeRawReply = Array<[
+type MRangeRawReply = Array<[
     key: string,
     labels: RawLabels,
     samples: Array<SampleRawReply>
@@ -167,3 +189,4 @@ export interface MRangeWithLabelsReplyItem extends MRangeReplyItem {
     labels: Labels;
 }
 export declare function transformMRangeWithLabelsReply(reply: MRangeRawReply): Array<MRangeWithLabelsReplyItem>;
+export declare function pushLatestArgument(args: RedisCommandArguments, latest?: boolean): RedisCommandArguments;

package/dist/commands/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMRangeWithLabelsReply = exports.transformMRangeReply = exports.transformRangeReply = exports.pushMRangeWithLabelsArguments = exports.pushWithLabelsArgument = exports.pushMRangeArguments = exports.pushFilterArgument = exports.pushMRangeGroupByArguments = exports.pushRangeArguments = exports.transformSampleReply = exports.transformIncrDecrArguments = exports.pushLabelsArgument = exports.transformLablesReply = exports.pushChunkSizeArgument = exports.pushEncodingArgument = exports.TimeSeriesEncoding = exports.pushRetentionArgument = exports.transformTimestampArgument = exports.TimeSeriesReducers = exports.TimeSeriesDuplicatePolicies = exports.TimeSeriesAggregationType = void 0;
+exports.pushLatestArgument = exports.transformMRangeWithLabelsReply = exports.transformMRangeReply = exports.transformRangeReply = exports.pushMRangeWithLabelsArguments = exports.pushWithLabelsArgument = exports.pushMRangeArguments = exports.pushFilterArgument = exports.pushMRangeGroupByArguments = exports.pushRangeArguments = exports.TimeSeriesBucketTimestamp = exports.transformSampleReply = exports.transformIncrDecrArguments = exports.pushLabelsArgument = exports.transformLablesReply = exports.pushDuplicatePolicy = exports.pushChunkSizeArgument = exports.pushEncodingArgument = exports.TimeSeriesEncoding = exports.pushRetentionArgument = exports.transformTimestampArgument = exports.TimeSeriesReducers = exports.TimeSeriesDuplicatePolicies = exports.TimeSeriesAggregationType = void 0;
 const ADD = require("./ADD");
 const ALTER = require("./ALTER");
 const CREATE = require("./CREATE");
@@ -69,19 +69,26 @@ exports.default = {
 };
 var TimeSeriesAggregationType;
 (function (TimeSeriesAggregationType) {
-    TimeSeriesAggregationType["AVERAGE"] = "avg";
-    TimeSeriesAggregationType["SUM"] = "sum";
-    TimeSeriesAggregationType["MINIMUM"] = "min";
-    TimeSeriesAggregationType["MAXIMUM"] = "max";
-    TimeSeriesAggregationType["RANGE"] = "range";
-    TimeSeriesAggregationType["COUNT"] = "count";
-    TimeSeriesAggregationType["FIRST"] = "first";
-    TimeSeriesAggregationType["LAST"] = "last";
-    TimeSeriesAggregationType["STD_P"] = "std.p";
-    TimeSeriesAggregationType["STD_S"] = "std.s";
-    TimeSeriesAggregationType["VAR_P"] = "var.p";
-    TimeSeriesAggregationType["VAR_S"] = "var.s";
-})(TimeSeriesAggregationType = exports.TimeSeriesAggregationType || (exports.TimeSeriesAggregationType = {}));
+    TimeSeriesAggregationType["AVG"] = "AVG";
+    // @deprecated
+    TimeSeriesAggregationType["AVERAGE"] = "AVG";
+    TimeSeriesAggregationType["FIRST"] = "FIRST";
+    TimeSeriesAggregationType["LAST"] = "LAST";
+    TimeSeriesAggregationType["MIN"] = "MIN";
+    // @deprecated
+    TimeSeriesAggregationType["MINIMUM"] = "MIN";
+    TimeSeriesAggregationType["MAX"] = "MAX";
+    // @deprecated
+    TimeSeriesAggregationType["MAXIMUM"] = "MAX";
+    TimeSeriesAggregationType["SUM"] = "SUM";
+    TimeSeriesAggregationType["RANGE"] = "RANGE";
+    TimeSeriesAggregationType["COUNT"] = "COUNT";
+    TimeSeriesAggregationType["STD_P"] = "STD.P";
+    TimeSeriesAggregationType["STD_S"] = "STD.S";
+    TimeSeriesAggregationType["VAR_P"] = "VAR.P";
+    TimeSeriesAggregationType["VAR_S"] = "VAR.S";
+    TimeSeriesAggregationType["TWA"] = "TWA";
+})(TimeSeriesAggregationType || (exports.TimeSeriesAggregationType = TimeSeriesAggregationType = {}));
 var TimeSeriesDuplicatePolicies;
 (function (TimeSeriesDuplicatePolicies) {
     TimeSeriesDuplicatePolicies["BLOCK"] = "BLOCK";
@@ -90,13 +97,24 @@ var TimeSeriesDuplicatePolicies;
     TimeSeriesDuplicatePolicies["MIN"] = "MIN";
     TimeSeriesDuplicatePolicies["MAX"] = "MAX";
     TimeSeriesDuplicatePolicies["SUM"] = "SUM";
-})(TimeSeriesDuplicatePolicies = exports.TimeSeriesDuplicatePolicies || (exports.TimeSeriesDuplicatePolicies = {}));
+})(TimeSeriesDuplicatePolicies || (exports.TimeSeriesDuplicatePolicies = TimeSeriesDuplicatePolicies = {}));
 var TimeSeriesReducers;
 (function (TimeSeriesReducers) {
-    TimeSeriesReducers["SUM"] = "sum";
-    TimeSeriesReducers["MINIMUM"] = "min";
-    TimeSeriesReducers["MAXIMUM"] = "max";
-})(TimeSeriesReducers = exports.TimeSeriesReducers || (exports.TimeSeriesReducers = {}));
+    TimeSeriesReducers["AVG"] = "AVG";
+    TimeSeriesReducers["SUM"] = "SUM";
+    TimeSeriesReducers["MIN"] = "MIN";
+    // @deprecated
+    TimeSeriesReducers["MINIMUM"] = "MIN";
+    TimeSeriesReducers["MAX"] = "MAX";
+    // @deprecated
+    TimeSeriesReducers["MAXIMUM"] = "MAX";
+    TimeSeriesReducers["RANGE"] = "range";
+    TimeSeriesReducers["COUNT"] = "COUNT";
+    TimeSeriesReducers["STD_P"] = "STD.P";
+    TimeSeriesReducers["STD_S"] = "STD.S";
+    TimeSeriesReducers["VAR_P"] = "VAR.P";
+    TimeSeriesReducers["VAR_S"] = "VAR.S";
+})(TimeSeriesReducers || (exports.TimeSeriesReducers = TimeSeriesReducers = {}));
 function transformTimestampArgument(timestamp) {
     if (typeof timestamp === 'string')
         return timestamp;
@@ -106,7 +124,7 @@ function transformTimestampArgument(timestamp) {
 }
 exports.transformTimestampArgument = transformTimestampArgument;
 function pushRetentionArgument(args, retention) {
-    if (retention) {
+    if (retention !== undefined) {
         args.push('RETENTION', retention.toString());
     }
     return args;
@@ -116,21 +134,28 @@ var TimeSeriesEncoding;
 (function (TimeSeriesEncoding) {
     TimeSeriesEncoding["COMPRESSED"] = "COMPRESSED";
     TimeSeriesEncoding["UNCOMPRESSED"] = "UNCOMPRESSED";
-})(TimeSeriesEncoding = exports.TimeSeriesEncoding || (exports.TimeSeriesEncoding = {}));
+})(TimeSeriesEncoding || (exports.TimeSeriesEncoding = TimeSeriesEncoding = {}));
 function pushEncodingArgument(args, encoding) {
-    if (encoding) {
+    if (encoding !== undefined) {
         args.push('ENCODING', encoding);
     }
     return args;
 }
 exports.pushEncodingArgument = pushEncodingArgument;
 function pushChunkSizeArgument(args, chunkSize) {
-    if (chunkSize) {
+    if (chunkSize !== undefined) {
         args.push('CHUNK_SIZE', chunkSize.toString());
     }
     return args;
 }
 exports.pushChunkSizeArgument = pushChunkSizeArgument;
+function pushDuplicatePolicy(args, duplicatePolicy) {
+    if (duplicatePolicy !== undefined) {
+        args.push('DUPLICATE_POLICY', duplicatePolicy);
+    }
+    return args;
+}
+exports.pushDuplicatePolicy = pushDuplicatePolicy;
 function transformLablesReply(reply) {
     const labels = {};
     for (const [key, value] of reply) {
@@ -174,8 +199,15 @@ function transformSampleReply(reply) {
     };
 }
 exports.transformSampleReply = transformSampleReply;
+var TimeSeriesBucketTimestamp;
+(function (TimeSeriesBucketTimestamp) {
+    TimeSeriesBucketTimestamp["LOW"] = "-";
+    TimeSeriesBucketTimestamp["HIGH"] = "+";
+    TimeSeriesBucketTimestamp["MID"] = "~";
+})(TimeSeriesBucketTimestamp || (exports.TimeSeriesBucketTimestamp = TimeSeriesBucketTimestamp = {}));
 function pushRangeArguments(args, fromTimestamp, toTimestamp, options) {
     args.push(transformTimestampArgument(fromTimestamp), transformTimestampArgument(toTimestamp));
+    pushLatestArgument(args, options?.LATEST);
     if (options?.FILTER_BY_TS) {
         args.push('FILTER_BY_TS');
         for (const ts of options.FILTER_BY_TS) {
@@ -193,6 +225,12 @@ function pushRangeArguments(args, fromTimestamp, toTimestamp, options) {
     }
     if (options?.AGGREGATION) {
         args.push('AGGREGATION', options.AGGREGATION.type, transformTimestampArgument(options.AGGREGATION.timeBucket));
+        if (options.AGGREGATION.BUCKETTIMESTAMP) {
+            args.push('BUCKETTIMESTAMP', options.AGGREGATION.BUCKETTIMESTAMP);
+        }
+        if (options.AGGREGATION.EMPTY) {
+            args.push('EMPTY');
+        }
     }
     return args;
 }
@@ -206,15 +244,13 @@ function pushMRangeGroupByArguments(args, groupBy) {
 exports.pushMRangeGroupByArguments = pushMRangeGroupByArguments;
 function pushFilterArgument(args, filter) {
     args.push('FILTER');
-    (0, generic_transformers_1.pushVerdictArguments)(args, filter);
-    return args;
+    return (0, generic_transformers_1.pushVerdictArguments)(args, filter);
 }
 exports.pushFilterArgument = pushFilterArgument;
 function pushMRangeArguments(args, fromTimestamp, toTimestamp, filter, options) {
-    pushRangeArguments(args, fromTimestamp, toTimestamp, options);
-    pushFilterArgument(args, filter);
-    pushMRangeGroupByArguments(args, options?.GROUPBY);
-    return args;
+    args = pushRangeArguments(args, fromTimestamp, toTimestamp, options);
+    args = pushFilterArgument(args, filter);
+    return pushMRangeGroupByArguments(args, options?.GROUPBY);
 }
 exports.pushMRangeArguments = pushMRangeArguments;
 function pushWithLabelsArgument(args, selectedLabels) {
@@ -223,17 +259,16 @@ function pushWithLabelsArgument(args, selectedLabels) {
     }
     else {
         args.push('SELECTED_LABELS');
-        (0, generic_transformers_1.pushVerdictArguments)(args, selectedLabels);
+        args = (0, generic_transformers_1.pushVerdictArguments)(args, selectedLabels);
     }
     return args;
 }
 exports.pushWithLabelsArgument = pushWithLabelsArgument;
 function pushMRangeWithLabelsArguments(args, fromTimestamp, toTimestamp, filter, options) {
-    pushRangeArguments(args, fromTimestamp, toTimestamp, options);
-    pushWithLabelsArgument(args, options?.SELECTED_LABELS);
-    pushFilterArgument(args, filter);
-    pushMRangeGroupByArguments(args, options?.GROUPBY);
-    return args;
+    args = pushRangeArguments(args, fromTimestamp, toTimestamp, options);
+    args = pushWithLabelsArgument(args, options?.SELECTED_LABELS);
+    args = pushFilterArgument(args, filter);
+    return pushMRangeGroupByArguments(args, options?.GROUPBY);
 }
 exports.pushMRangeWithLabelsArguments = pushMRangeWithLabelsArguments;
 function transformRangeReply(reply) {
@@ -263,3 +298,10 @@ function transformMRangeWithLabelsReply(reply) {
     return args;
 }
 exports.transformMRangeWithLabelsReply = transformMRangeWithLabelsReply;
+function pushLatestArgument(args, latest) {
+    if (latest) {
+        args.push('LATEST');
+    }
+    return args;
+}
+exports.pushLatestArgument = pushLatestArgument;

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 export { default } from './commands';
-export { TimeSeriesDuplicatePolicies, TimeSeriesEncoding, TimeSeriesAggregationType } from './commands';
+export { TimeSeriesDuplicatePolicies, TimeSeriesEncoding, TimeSeriesAggregationType, TimeSeriesReducers, TimeSeriesBucketTimestamp } from './commands';

package/dist/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimeSeriesAggregationType = exports.TimeSeriesEncoding = exports.TimeSeriesDuplicatePolicies = exports.default = void 0;
+exports.TimeSeriesBucketTimestamp = exports.TimeSeriesReducers = exports.TimeSeriesAggregationType = exports.TimeSeriesEncoding = exports.TimeSeriesDuplicatePolicies = exports.default = void 0;
 var commands_1 = require("./commands");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return commands_1.default; } });
 var commands_2 = require("./commands");
 Object.defineProperty(exports, "TimeSeriesDuplicatePolicies", { enumerable: true, get: function () { return commands_2.TimeSeriesDuplicatePolicies; } });
 Object.defineProperty(exports, "TimeSeriesEncoding", { enumerable: true, get: function () { return commands_2.TimeSeriesEncoding; } });
 Object.defineProperty(exports, "TimeSeriesAggregationType", { enumerable: true, get: function () { return commands_2.TimeSeriesAggregationType; } });
+Object.defineProperty(exports, "TimeSeriesReducers", { enumerable: true, get: function () { return commands_2.TimeSeriesReducers; } });
+Object.defineProperty(exports, "TimeSeriesBucketTimestamp", { enumerable: true, get: function () { return commands_2.TimeSeriesBucketTimestamp; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redis/time-series",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,12 +18,24 @@
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@redis/test-utils": "*",
-    "@types/node": "^17.0.31",
+    "@types/node": "^20.5.3",
     "nyc": "^15.1.0",
-    "release-it": "^15.0.0",
+    "release-it": "^16.1.5",
     "source-map-support": "^0.5.21",
-    "ts-node": "^10.7.0",
-    "typedoc": "^0.22.15",
-    "typescript": "^4.6.4"
-  }
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.24.8",
+    "typescript": "^5.1.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/redis/node-redis.git"
+  },
+  "bugs": {
+    "url": "https://github.com/redis/node-redis/issues"
+  },
+  "homepage": "https://github.com/redis/node-redis/tree/master/packages/time-series",
+  "keywords": [
+    "redis",
+    "RedisTimeSeries"
+  ]
 }