opensearch-ts 1.2.2

package/dist/tests/metric.test.js

@@ -0,0 +1,258 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger = require("../logger");
+const typescriptOS_1 = require("../typescriptOS");
+const testUtil_1 = require("../testUtil");
+var esClient;
+var tsClient;
+jest.setTimeout(20000);
+beforeAll(async () => {
+    esClient = await (0, testUtil_1.makeClientWithEndpoint)();
+    tsClient = new typescriptOS_1.TypescriptOSProxyClient(esClient);
+});
+afterAll(async () => {
+    await esClient.close();
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/average/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "avg_taxful_total_price": {
+                "avg": {
+                    "field": "taxful_total_price"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.avg_taxful_total_price.value);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/cardinality/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "unique_products": {
+                "cardinality": {
+                    "field": "products.product_id"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.unique_products.value);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/extended-stats/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "extended_stats_taxful_total_price": {
+                "extended_stats": {
+                    "field": "taxful_total_price"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.extended_stats_taxful_total_price);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/extended-stats/  sigma", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "extended_stats_taxful_total_price": {
+                "extended_stats": {
+                    "field": "taxful_total_price",
+                    "sigma": 3
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.extended_stats_taxful_total_price);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/geobounds/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "geo": {
+                "geo_bounds": {
+                    "field": "geoip.location"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.geo.bounds);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/matrix-stats/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "matrix_stats_taxful_total_price": {
+                "matrix_stats": {
+                    "fields": ["taxful_total_price", "products.base_price"]
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.matrix_stats_taxful_total_price.fields);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/maximum/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "max_taxful_total_price": {
+                "max": {
+                    "field": "taxful_total_price"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.max_taxful_total_price.value);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/minimum/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "min_taxful_total_price": {
+                "min": {
+                    "field": "taxful_total_price"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.min_taxful_total_price.value);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/percentile-ranks/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "percentile_rank_taxful_total_price": {
+                "percentile_ranks": {
+                    "field": "taxful_total_price",
+                    "values": [
+                        10,
+                        15
+                    ]
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.percentile_rank_taxful_total_price.values);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/percentile/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "percentile_taxful_total_price": {
+                "percentiles": {
+                    "field": "taxful_total_price",
+                    "percents": [
+                        50
+                    ]
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.percentile_taxful_total_price.values);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/scripted-metric/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "responses.counts": {
+                "scripted_metric": {
+                    "init_script": "state.responses = ['error':0L,'success':0L,'other':0L]",
+                    "map_script": `
+                    def code = doc['response.keyword'].value;
+                       if (code.startsWith('5') || code.startsWith('4')) {
+                        state.responses.error += 1 ;
+                        } else if(code.startsWith('2')) {
+                         state.responses.success += 1;
+                        } else {
+                        state.responses.other += 1;
+                      }
+                   `,
+                    "combine_script": "state.responses",
+                    "reduce_script": `
+                  def counts = ['error': 0L, 'success': 0L, 'other': 0L];
+                      for (responses in states) {
+                       counts.error += responses['error'];
+                        counts.success += responses['success'];
+                      counts.other += responses['other'];
+              }
+              return counts;
+              `
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations["responses.counts"].value.error);
+    logger.info(result.aggregations["responses.counts"].value.other);
+    logger.info(result.aggregations["responses.counts"].value.success);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/stats/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "stats_taxful_total_price": {
+                "stats": {
+                    "field": "taxful_total_price"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.stats_taxful_total_price);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/sum/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "sum_taxful_total_price": {
+                "sum": {
+                    "field": "taxful_total_price"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.sum_taxful_total_price.value);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/top-hits/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "top_hits_products": {
+                "top_hits": {
+                    "size": 5
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.top_hits_products.hits.hits);
+    logger.info(result.aggregations.top_hits_products.hits.total.value);
+    logger.info(result.aggregations.top_hits_products.hits.total.relation);
+    logger.info(result.aggregations.top_hits_products.hits.max_score);
+});
+test("https://opensearch.org/docs/latest/aggregations/metric/top-hits/", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "number_of_values": {
+                "value_count": {
+                    "field": "taxful_total_price"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_ecommerce" });
+    logger.info(result.aggregations.number_of_values.value);
+});

package/dist/tests/pipeline.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/pipeline.test.js

@@ -0,0 +1,342 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger = require("../logger");
+const typescriptOS_1 = require("../typescriptOS");
+const testUtil_1 = require("../testUtil");
+var esClient;
+var tsClient;
+jest.setTimeout(20000);
+beforeAll(async () => {
+    esClient = await (0, testUtil_1.makeClientWithEndpoint)();
+    tsClient = new typescriptOS_1.TypescriptOSProxyClient(esClient);
+});
+afterAll(async () => {
+    await esClient.close();
+});
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#quick-example", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "number_of_bytes": {
+                "histogram": {
+                    "field": "bytes",
+                    "interval": 10000
+                },
+                "aggs": {
+                    "sum_total_memory": {
+                        "sum": {
+                            "field": "phpmemory"
+                        }
+                    }
+                }
+            },
+            "sum_copies": {
+                "sum_bucket": {
+                    "buckets_path": "number_of_bytes>sum_total_memory"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.number_of_bytes);
+    logger.info(result.aggregations.sum_copies);
+});
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#avg_bucket-sum_bucket-min_bucket-max_bucket", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "visits_per_month": {
+                "date_histogram": {
+                    "field": "@timestamp",
+                    "interval": "month"
+                },
+                "aggs": {
+                    "sum_of_bytes": {
+                        "sum": {
+                            "field": "bytes"
+                        }
+                    }
+                }
+            },
+            "avg_monthly_bytes": {
+                "avg_bucket": {
+                    "buckets_path": "visits_per_month>sum_of_bytes"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.avg_monthly_bytes);
+    logger.info(result.aggregations.visits_per_month);
+});
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#stats_bucket-extended_stats_bucket", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "visits_per_month": {
+                "date_histogram": {
+                    "field": "@timestamp",
+                    "interval": "month"
+                },
+                "aggs": {
+                    "sum_of_bytes": {
+                        "sum": {
+                            "field": "bytes"
+                        }
+                    }
+                }
+            },
+            "stats_monthly_bytes": {
+                "stats_bucket": {
+                    "buckets_path": "visits_per_month>sum_of_bytes"
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.stats_monthly_bytes);
+    logger.info(result.aggregations.visits_per_month);
+});
+// bucket_script, bucket_selector
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#bucket_script-bucket_selector", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "sales_per_month": {
+                "histogram": {
+                    "field": "bytes",
+                    "interval": "10000"
+                },
+                "aggs": {
+                    "total_ram": {
+                        "sum": {
+                            "field": "machine.ram"
+                        }
+                    },
+                    "ext-type": {
+                        "filter": {
+                            "term": {
+                                "extension.keyword": "zip"
+                            }
+                        },
+                        "aggs": {
+                            "total_ram": {
+                                "sum": {
+                                    "field": "machine.ram"
+                                }
+                            }
+                        }
+                    },
+                    "ram-percentage": {
+                        "bucket_script": {
+                            "buckets_path": {
+                                "machineRam": "ext-type>total_ram",
+                                "totalRam": "total_ram"
+                            },
+                            "script": "params.machineRam / params.totalRam"
+                        }
+                    }
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.sales_per_month.buckets);
+});
+/**
+test("params.totalBytes > 20000 bucket_selector", async () => {
+
+  type QuickExample = Search<ServerLog,
+  {
+    bytes_per_month : {
+      agg : "date_histogram",
+      aggs : {
+        "total_bytes" : {
+          agg : "sum"
+        },
+        "bytes_bucket_filter" : {
+          agg : "bucket_selector"
+        }
+      }
+    }
+  }>
+
+  const search : QuickExample =
+  {
+    "size": 0,
+    "aggs": {
+      "bytes_per_month": {
+        "date_histogram": {
+          "field": "@timestamp",
+          "calendar_interval": "month"
+        },
+        "aggs": {
+          "total_bytes": {
+            "sum": {
+              "field": "bytes"
+            }
+          },
+          "bytes_bucket_filter": {
+            "bucket_selector": {
+              "buckets_path": {
+                "totalBytes": "total_bytes"
+              },
+              "script": "params.totalBytes > 20000"
+            }
+          }
+        }
+      }
+    }
+  }
+
+  const result = await tsClient.searchTS({body : search, index : "opensearch_dashboards_sample_data_logs"})
+
+  logger.info(result.aggregations.bytes_per_month.buckets.map(b => b.bytes_bucket_filter))
+  logger.info(result.aggregations.bytes_per_month.buckets.map(b => b))
+
+})
+ */
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#bucket_sort", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "sales_per_month": {
+                "date_histogram": {
+                    "field": "@timestamp",
+                    "calendar_interval": "month"
+                },
+                "aggs": {
+                    "total_bytes": {
+                        "sum": {
+                            "field": "bytes"
+                        }
+                    },
+                    "bytes_bucket_sort": {
+                        "bucket_sort": {
+                            "sort": [
+                                { "total_bytes": { "order": "desc" } }
+                            ],
+                            "size": 3
+                        }
+                    }
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.sales_per_month.buckets.map(b => ({
+        "key_as_string": b.key_as_string,
+        "key": b.key,
+        "doc_count": b.doc_count,
+        "total_bytes": {
+            "value": b.total_bytes.value
+        }
+    })));
+});
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#cumulative_sum", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "sales_per_month": {
+                "date_histogram": {
+                    "field": "@timestamp",
+                    "calendar_interval": "month"
+                },
+                "aggs": {
+                    "number_of_bytes": {
+                        "sum": {
+                            "field": "bytes"
+                        }
+                    },
+                    "cumulative_bytes": {
+                        "cumulative_sum": {
+                            "buckets_path": "number_of_bytes"
+                        }
+                    }
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.sales_per_month.buckets.map(b => b.cumulative_bytes.value));
+});
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#cumulative_sum", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "sales_per_month": {
+                "date_histogram": {
+                    "field": "@timestamp",
+                    "calendar_interval": "month"
+                },
+                "aggs": {
+                    "number_of_bytes": {
+                        "sum": {
+                            "field": "bytes"
+                        }
+                    },
+                    "bytes_deriv": {
+                        "derivative": {
+                            "buckets_path": "number_of_bytes"
+                        }
+                    }
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.sales_per_month.buckets.map(b => b.bytes_deriv));
+});
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#moving_avg", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "my_date_histogram": {
+                "date_histogram": {
+                    "field": "@timestamp",
+                    "calendar_interval": "month"
+                },
+                "aggs": {
+                    "sum_of_bytes": {
+                        "sum": { "field": "bytes" }
+                    },
+                    "moving_avg_of_sum_of_bytes": {
+                        "moving_avg": {
+                            "buckets_path": "sum_of_bytes"
+                        }
+                    }
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.my_date_histogram.buckets.map(b => { var _a; return (_a = b === null || b === void 0 ? void 0 : b.moving_avg_of_sum_of_bytes) === null || _a === void 0 ? void 0 : _a.value; }));
+});
+test("https://opensearch.org/docs/latest/aggregations/pipeline-agg/#serial_diff", async () => {
+    const search = {
+        "size": 0,
+        "aggs": {
+            "my_date_histogram": {
+                "date_histogram": {
+                    "field": "@timestamp",
+                    "calendar_interval": "day"
+                },
+                "aggs": {
+                    "the_sum": {
+                        "sum": {
+                            "field": "bytes"
+                        }
+                    },
+                    "thirtieth_difference": {
+                        "serial_diff": {
+                            "buckets_path": "the_sum",
+                            "lag": 7
+                        }
+                    }
+                }
+            }
+        }
+    };
+    const result = await tsClient.searchTS({ body: search, index: "opensearch_dashboards_sample_data_logs" });
+    logger.info(result.aggregations.my_date_histogram.buckets);
+});

package/dist/typescriptOS.d.ts

@@ -0,0 +1,38 @@
+import * as os from "@opensearch-project/opensearch";
+import { TransportRequestOptions } from "@opensearch-project/opensearch/lib/Transport";
+import * as q from "./search";
+import { AggsQuery } from "./aggInput";
+export declare const IGNORE_ATTS: string[];
+export type DictResponse<T, MSEARCH extends {
+    [a: string]: q.Search<T, AggsQuery>;
+}> = {
+    [K in keyof MSEARCH]: q.SearchResponse<T, AggsQuery>;
+};
+export type MSearch<T> = {
+    [key: string]: q.Search<T, AggsQuery>;
+};
+export type CountResponse = {
+    "count": number;
+    "_shards": {
+        "total": number;
+        "successful": number;
+        "skipped": number;
+        "failed": number;
+    };
+};
+export declare class TypescriptOSProxyClient {
+    esClient: os.Client;
+    constructor(esClient: os.Client);
+    countTs<T, A extends AggsQuery>(search: {
+        body: q.Search<T, A>;
+        index?: string;
+    }, options?: TransportRequestOptions): Promise<CountResponse>;
+    searchTS<T, A extends AggsQuery>(search: {
+        body: q.Search<T, A>;
+        index?: string;
+    }, options?: TransportRequestOptions): Promise<q.SearchResponse<T, A>>;
+    msearchDictTS<T>(search: {
+        [k: string]: any;
+    }, index?: string): Promise<void>;
+    msearchTS<T, A extends AggsQuery>(msearchTs: q.Search<T, A>[], index?: string, options?: TransportRequestOptions): Promise<q.SearchResponse<T, A>[]>;
+}

package/dist/typescriptOS.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypescriptOSProxyClient = exports.IGNORE_ATTS = void 0;
+const _ = require("lodash");
+const search_1 = require("./search");
+exports.IGNORE_ATTS = ["_source", "response", "index"];
+class TypescriptOSProxyClient {
+    constructor(esClient) {
+        this.esClient = esClient;
+    }
+    async countTs(search, options) {
+        return this.esClient.count({
+            index: search.body.index || search.index,
+            body: _.omit(search.body, exports.IGNORE_ATTS)
+        }, options)
+            .then(resp => {
+            return resp.body;
+        });
+    }
+    async searchTS(search, options) {
+        return this.esClient.search({
+            index: search.body.index || search.index,
+            body: _.omit(search.body, exports.IGNORE_ATTS)
+        }, options)
+            .then(resp => {
+            search.body.response = resp.body;
+            return search.body.response;
+        });
+    }
+    async msearchDictTS(search, index) {
+        const msearch = search;
+        const entries = Object.entries(msearch);
+        const queries = entries.map(([, value]) => value);
+        const keys = entries.map(([key,]) => key);
+        await this.msearchTS(queries, index);
+        keys.forEach((key, i) => {
+            search[key] = queries[i];
+        });
+    }
+    async msearchTS(msearchTs, index, options) {
+        const msearch = msearchTs.flatMap(s => [{
+                index: s.index || index
+            }, _.omit(s, exports.IGNORE_ATTS)]);
+        const responses = (await this.esClient.msearch({ body: msearch, index }, options)).body.responses;
+        responses.forEach((resp, i) => {
+            msearchTs[i].response = resp;
+        });
+        return msearchTs.map((search, i) => new search_1.ResponseParser(search).parseSearchResponse(responses[i]));
+    }
+}
+exports.TypescriptOSProxyClient = TypescriptOSProxyClient;