opensearch-ts 1.2.2

package/dist/search.d.ts

@@ -0,0 +1,194 @@
+import { ShardStatistics } from "@opensearch-project/opensearch/api/_types/_common";
+import { TotalHits } from "@opensearch-project/opensearch/api/_types/_core.search";
+import { RequireAtLeastOne, RequireExactlyOne } from "type-fest";
+import { AggTypeDictionaryRecursive, AggsQuery } from "./aggInput";
+import { AggTypeResponseDictionary2 } from "./aggOutput";
+import * as att from "./attributes";
+import { NumberField } from "./fields";
+import * as f from "./filters";
+import * as m from "./match";
+/**
+ * Represents a document
+ */
+export type Document<T> = {
+    _index: string;
+    _id: string;
+    _score: number;
+    _source: T;
+    sort?: any[];
+};
+/**
+ * Represents (Hits|Search Results)
+ */
+export type Hits<T> = {
+    "total": number & TotalHits;
+    "max_score": any;
+    "hits": Document<T>[];
+};
+export type Source<T> = {
+    includes?: att.AnyAttribute<T>[];
+    excludes?: att.AnyAttribute<T>[];
+};
+export type BooleanStatement<T> = {
+    should?: f.FilterStatement<T>[] | f.FilterStatement<T>;
+    filter?: f.FilterStatement<T>[] | f.FilterStatement<T>;
+    must?: f.FilterStatement<T>[] | f.FilterStatement<T>;
+    must_not?: f.FilterStatement<T>[] | f.FilterStatement<T>;
+    minimum_should_match?: number;
+};
+export type Boosting<T> = {
+    positive: {
+        match: m.Match<T>;
+    };
+    negative: {
+        match: m.Match<T>;
+    };
+    negative_boost: number;
+};
+export type ConstanScore<T> = {
+    filter: f.FilterStatement<T>;
+    boost: number;
+};
+export type DisjointMatrix<T> = {
+    queries: m.Match<T>[];
+};
+export type FunctionScore<T> = {
+    weight: number;
+    query: m.Match<T>;
+} & RequireAtLeastOne<{
+    random_score: {
+        seed: number;
+    } & NumberField<T>;
+    field_value_factor: {
+        factor: number;
+        modifier: "log" | "log1p" | "log2p" | "ln" | "ln1p" | "ln2p" | "reciprocal" | "square" | "sqrt" | "none";
+        missing?: number;
+    } & NumberField<T>;
+    script_score: {
+        script: string | {
+            params: {
+                [k: string]: number;
+            };
+            source: string;
+        };
+    };
+    exp: {
+        [a in att.AnyAttribute<T>]: {
+            origin?: string;
+            offset?: string;
+            scale?: string;
+            decay?: number;
+        };
+    };
+}>;
+export type IDs = {
+    ids: {
+        values: string[];
+    };
+};
+export type Nested<T> = {
+    path: string;
+    query: OSQuery<T>;
+    ignore_unmapped?: boolean;
+    score_mode?: string;
+    boost?: number;
+    inner_hits?: {
+        ignore_unmapped?: boolean;
+        from?: number;
+        size?: number;
+        version?: boolean;
+        seq_no_primary_term?: false;
+        explain?: false;
+        track_scores?: false;
+        _source?: Source<T>;
+    };
+};
+/**
+ * Query to select a sub-set of documents
+ */
+export type OSQuery<T> = {
+    function_score?: FunctionScore<T>;
+    constant_score?: ConstanScore<T>;
+    boosting?: Boosting<T>;
+    match_all?: {};
+    bool?: BooleanStatement<T>;
+    nested?: Nested<T>;
+    dis_max?: DisjointMatrix<T>;
+    match_phrase?: m.MatchPhrase<T>;
+    match?: m.Match<T>;
+} & Partial<f.FilterStatement<T>>;
+export type AggsExp<T, A extends AggsQuery> = {
+    [K in keyof A]: AggTypeDictionaryRecursive<T, A[K]["agg"], A[K]["aggs"]>;
+};
+/**
+ * Search query with description of the aggs, as well as the response
+ */
+export type Search<T, A extends AggsQuery> = {
+    /** Aggs query */
+    aggs?: AggsExp<T, A>;
+    docvalue_fields?: att.AnyAttribute<T>[];
+    /** Query used for search */
+    query?: OSQuery<T>;
+    /** Subset of attributes used for search */
+    _source?: Source<T> | boolean;
+    indices_boost?: {
+        [a: string]: number;
+    }[];
+    min_score?: number;
+    seq_no_primary_term?: boolean;
+    terminate_after?: number;
+    /** Number of documents to return in search */
+    size?: number;
+    stats?: string[];
+    track_total_hits?: boolean;
+    version?: boolean;
+    explain?: boolean;
+    from?: number;
+    timeout?: string;
+    stored_fields?: att.AnyAttribute<T>[];
+    /** How to sort */
+    sort?: RequireExactlyOne<{
+        [key in att.AnyAttribute<T>]: {
+            order?: "desc" | "asc";
+            missing?: "_first" | "_last";
+            nested_filter?: OSQuery<T>;
+            nested_path?: string;
+            mode?: "min" | "max" | "avg" | "sum";
+        };
+    }>[];
+    search_after?: any[];
+    /** Response which will be populated after searching */
+    response?: SearchResponse<T, A>;
+    /** Index used for the search */
+    index?: string;
+};
+/**
+ * Type 'ResponseItem' is not assignable to type 'SearchResponse<T, A>'.
+  Type 'MultiSearchItem' is not assignable to type 'SearchResponse<T, A>'.
+    Types of property '"_shards"' are incompatible.
+      Type 'ShardStatistics' is not assignable to type 'ShardsHitResult'.
+        Property '"skipped"' is optional in type 'ShardStatistics' but required in type 'ShardsHitResult'.
+ */
+/**
+ * Details of the Shards Hit
+ */
+/**
+ * The search response JSON
+ */
+export type SearchResponse<T, A extends AggsQuery> = {
+    "took": number;
+    "timed_out": boolean;
+    "_shards": ShardStatistics;
+    "hits": Hits<T>;
+    "aggregations"?: {
+        [K in keyof A]: AggTypeResponseDictionary2<T, A[K]["agg"], A[K]["aggs"]>;
+    };
+};
+/**
+ * Class to parse Reponse JSON to it's corresponding type
+ */
+export declare class ResponseParser<T, A extends AggsQuery> {
+    search: Search<T, A>;
+    constructor(search: Search<T, A>);
+    parseSearchResponse: (response: any) => SearchResponse<T, A>;
+}

package/dist/search.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseParser = void 0;
+/**
+ * Class to parse Reponse JSON to it's corresponding type
+ */
+class ResponseParser {
+    constructor(search) {
+        this.parseSearchResponse = (response) => response;
+        this.search = search;
+    }
+}
+exports.ResponseParser = ResponseParser;

package/dist/testUtil.d.ts

@@ -0,0 +1,2 @@
+import * as os from "@opensearch-project/opensearch";
+export declare const makeClientWithEndpoint: (endpoint?: string) => Promise<os.Client>;

package/dist/testUtil.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeClientWithEndpoint = void 0;
+const credential_provider_node_1 = require("@aws-sdk/credential-provider-node");
+const os = require("@opensearch-project/opensearch");
+const aws_1 = require("@opensearch-project/opensearch/aws");
+const makeClientWithEndpoint = async (endpoint) => {
+    return new os.Client({
+        ...(0, aws_1.AwsSigv4Signer)({
+            region: process.env.AWS_REGION || "ap-southeast-2",
+            service: 'es',
+            getCredentials: () => {
+                const credentialsProvider = (0, credential_provider_node_1.defaultProvider)();
+                return credentialsProvider();
+            },
+        }),
+        node: `https://${endpoint || process.env.ES_ENDPOINT || "search-alertops-qeosrpbxjt4uyywic5fycm4pg4.ap-southeast-2.es.amazonaws.com"}`
+    });
+};
+exports.makeClientWithEndpoint = makeClientWithEndpoint;

package/dist/tests/Ecommerce.d.ts

@@ -0,0 +1,60 @@
+export interface Ecommerce {
+    category: string[];
+    currency: string;
+    customer_first_name: string;
+    customer_full_name: string;
+    customer_gender: string;
+    customer_id: number;
+    customer_last_name: string;
+    customer_phone: string;
+    day_of_week: string;
+    day_of_week_i: number;
+    email: string;
+    manufacturer: string[];
+    order_date: Date;
+    order_id: number;
+    products: Product[];
+    sku: string[];
+    taxful_total_price: number;
+    taxless_total_price: number;
+    total_quantity: number;
+    total_unique_products: number;
+    type: string;
+    user: string;
+    geoip: Geoip;
+    event: Event;
+}
+export interface Event {
+    dataset: string;
+}
+export interface Geoip {
+    country_iso_code: string;
+    location: Location;
+    region_name: string;
+    continent_name: string;
+    city_name: string;
+}
+export interface Location {
+    lon: number;
+    lat: number;
+}
+export interface Product {
+    base_price: number;
+    discount_percentage: number;
+    quantity: number;
+    manufacturer: string;
+    tax_amount: number;
+    product_id: number;
+    category: string;
+    sku: string;
+    taxless_price: number;
+    unit_discount_amount: number;
+    min_price: number;
+    _id: string;
+    discount_amount: number;
+    created_on: Date;
+    product_name: string;
+    price: number;
+    taxful_price: number;
+    base_unit_price: number;
+}

package/dist/tests/Ecommerce.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/tests/Flight.d.ts

@@ -0,0 +1,33 @@
+export interface Flight {
+    FlightNum: string;
+    DestCountry: string;
+    OriginWeather: string;
+    OriginCityName: string;
+    AvgTicketPrice: number;
+    DistanceMiles: number;
+    FlightDelay: boolean;
+    DestWeather: string;
+    Dest: string;
+    FlightDelayType: string;
+    OriginCountry: string;
+    dayOfWeek: number;
+    DistanceKilometers: number;
+    timestamp: Date;
+    DestLocation: Location;
+    DestAirportID: string;
+    Carrier: string;
+    Cancelled: boolean;
+    FlightTimeMin: number;
+    Origin: string;
+    OriginLocation: Location;
+    DestRegion: string;
+    OriginAirportID: string;
+    OriginRegion: string;
+    DestCityName: string;
+    FlightTimeHour: number;
+    FlightDelayMin: number;
+}
+export interface Location {
+    lat: string;
+    lon: string;
+}

package/dist/tests/Flight.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/tests/ServerLog.d.ts

@@ -0,0 +1,40 @@
+export interface ServerLog {
+    agent: string;
+    bytes: number;
+    clientip: string;
+    extension: string;
+    geo: Geo;
+    host: string;
+    index: string;
+    ip: string;
+    machine: Machine;
+    memory: number;
+    message: string;
+    phpmemory: null;
+    referer: string;
+    request: string;
+    response: string;
+    tags: string[];
+    timestamp: Date;
+    "@timestamp": Date;
+    url: string;
+    utc_time: Date;
+    event: Event;
+}
+export interface Event {
+    dataset: string;
+}
+export interface Geo {
+    srcdest: string;
+    src: string;
+    dest: string;
+    coordinates: Coordinates;
+}
+export interface Coordinates {
+    lat: number;
+    lon: number;
+}
+export interface Machine {
+    ram: number;
+    os: string;
+}

package/dist/tests/ServerLog.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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