wapi-client 0.12.3 → 0.12.5-beta.0

package/dist/lib/query-builder/aggregate-query-builder.cjs

@@ -0,0 +1,388 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/lib/query-builder/aggregate-query-builder.ts
+var aggregate_query_builder_exports = {};
+__export(aggregate_query_builder_exports, {
+  AggregateQueryBuilder: () => AggregateQueryBuilder
+});
+module.exports = __toCommonJS(aggregate_query_builder_exports);
+var import_consts = require('../../txs/consts.cjs');
+var import_errors = require('../errors.cjs');
+var import_utils = require('../utils.cjs');
+var import_query_builder = require('./query-builder.cjs');
+function getITxGroup(field, alias, timezone) {
+  if (field in import_consts.ITxPeriodSimpleEnum) {
+    return __spreadValues({
+      type: "period",
+      alias: alias != null ? alias : field
+    }, timezone ? { field: { period: field, timezone } } : { field });
+  } else if (field.startsWith("metadata.")) {
+    return {
+      type: "metadata_field",
+      field: field.replace(`metadata.`, ""),
+      alias: alias != null ? alias : field.replace(`metadata.`, "")
+    };
+  } else {
+    return {
+      type: "field",
+      field,
+      alias: alias != null ? alias : field
+    };
+  }
+}
+function getITxAggregator(fn, field, alias) {
+  if (!field) {
+    return {
+      function: fn,
+      alias: fn
+    };
+  }
+  return {
+    function: fn,
+    field,
+    alias: alias != null ? alias : fn
+  };
+}
+var AggregateQueryBuilder = class _AggregateQueryBuilder extends import_query_builder.QueryBuilder {
+  constructor({
+    $queries,
+    $options,
+    start,
+    schema,
+    schemaBasic,
+    optionsSchema,
+    aggregators,
+    groups,
+    aggregatableSchema,
+    groupableSchema,
+    timezone
+  }) {
+    super(schemaBasic, schema, $queries);
+    __publicField(this, "$options");
+    __publicField(this, "$optionsSchema");
+    __publicField(this, "$start");
+    __publicField(this, "$aggregators");
+    __publicField(this, "$groups");
+    __publicField(this, "$aggregatableSchema");
+    __publicField(this, "$groupableSchema");
+    __publicField(this, "$timezone");
+    this.$options = $options;
+    this.$optionsSchema = optionsSchema;
+    this.$start = start;
+    this.$aggregators = aggregators;
+    this.$groups = groups;
+    this.$aggregatableSchema = aggregatableSchema;
+    this.$groupableSchema = groupableSchema;
+    this.$timezone = timezone;
+  }
+  add(addQuery) {
+    return new _AggregateQueryBuilder({
+      $queries: [...this.$queries, addQuery],
+      $options: this.$options,
+      start: this.$start,
+      schemaBasic: this.$schemaBasic,
+      aggregators: this.$aggregators,
+      groups: this.$groups,
+      schema: this.$schema,
+      optionsSchema: this.$optionsSchema,
+      aggregatableSchema: this.$aggregatableSchema,
+      groupableSchema: this.$groupableSchema,
+      timezone: this.$timezone
+    });
+  }
+  start() {
+    return this.$start(this.toJSON());
+  }
+  getAggregators() {
+    return Object.entries(this.$aggregators).map(([, value]) => value);
+  }
+  getGroups() {
+    return Object.entries(this.$groups).map(([, value]) => value);
+  }
+  toJSON() {
+    return {
+      filter: super.toQuery(),
+      options: this.$options,
+      aggregators: this.getAggregators(),
+      groups: this.getGroups()
+    };
+  }
+  then(onfulfilled, onrejected) {
+    return this.start().then(onfulfilled, onrejected);
+  }
+  catch(onerror) {
+    return this.start().catch(onerror);
+  }
+  finally(fn) {
+    return this.start().finally(fn);
+  }
+  stream() {
+    return this.start().stream();
+  }
+  options(options) {
+    const validatedOptions = this.$optionsSchema.parse(__spreadValues({}, options));
+    const mergedOptions = (0, import_utils.mergeFnOptionsOrderBy)(validatedOptions);
+    return new _AggregateQueryBuilder({
+      $queries: this.$queries,
+      $options: __spreadValues(__spreadValues({}, this.$options), mergedOptions),
+      start: this.$start,
+      schemaBasic: this.$schemaBasic,
+      schema: this.$schema,
+      aggregators: this.$aggregators,
+      groups: this.$groups,
+      optionsSchema: this.$optionsSchema,
+      aggregatableSchema: this.$aggregatableSchema,
+      groupableSchema: this.$groupableSchema,
+      timezone: this.$timezone
+    });
+  }
+  timezone(timezone) {
+    const tzGroups = Object.fromEntries(
+      Object.entries(this.$groups).map(([alias, group]) => {
+        if (group.type !== "period") {
+          return [alias, group];
+        }
+        return [
+          alias,
+          __spreadProps(__spreadValues({}, group), {
+            field: {
+              period: group.field,
+              timezone
+            }
+          })
+        ];
+      })
+    );
+    return new _AggregateQueryBuilder({
+      $queries: this.$queries,
+      $options: this.$options,
+      start: this.$start,
+      schemaBasic: this.$schemaBasic,
+      schema: this.$schema,
+      aggregators: this.$aggregators,
+      groups: __spreadValues({}, tzGroups),
+      optionsSchema: this.$optionsSchema,
+      aggregatableSchema: this.$aggregatableSchema,
+      groupableSchema: this.$groupableSchema,
+      timezone
+    });
+  }
+  groupBy(first, ...input) {
+    if (!first) {
+      throw new import_errors.ValidationError("String input expected");
+    }
+    const extension = Object.fromEntries(
+      [first, ...input].map((entry) => {
+        if (typeof entry !== "string") {
+          throw new import_errors.ValidationError({ input }, "Expected an array of strings");
+        }
+        const [field, alias] = entry.split(" as ");
+        const group = getITxGroup(field, alias, this.$timezone);
+        return [group.alias, group];
+      })
+    );
+    return new _AggregateQueryBuilder({
+      $queries: this.$queries,
+      $options: this.$options,
+      start: this.$start,
+      schemaBasic: this.$schemaBasic,
+      schema: this.$schema,
+      aggregators: this.$aggregators,
+      groups: __spreadValues(__spreadValues({}, this.$groups), extension),
+      optionsSchema: this.$optionsSchema,
+      aggregatableSchema: this.$aggregatableSchema,
+      groupableSchema: this.$groupableSchema,
+      timezone: this.$timezone
+    });
+  }
+  addAggregator(fn, first, ...input) {
+    const extension = first === void 0 ? { [fn]: getITxAggregator(fn) } : Object.fromEntries(
+      [first, ...input].map((entry) => {
+        if (typeof entry !== "string") {
+          throw new import_errors.ValidationError("expected string input");
+        }
+        const [field, alias] = entry.split(" as ");
+        const aggregator = getITxAggregator(fn, field, alias);
+        return [aggregator.alias, aggregator];
+      })
+    );
+    return new _AggregateQueryBuilder({
+      $queries: this.$queries,
+      $options: this.$options,
+      start: this.$start,
+      schemaBasic: this.$schemaBasic,
+      aggregators: __spreadValues(__spreadValues({}, this.$aggregators), extension),
+      groups: this.$groups,
+      schema: this.$schema,
+      optionsSchema: this.$optionsSchema,
+      aggregatableSchema: this.$aggregatableSchema,
+      groupableSchema: this.$groupableSchema,
+      timezone: this.$timezone
+    });
+  }
+  count(first, ...input) {
+    return this.addAggregator("count", first, ...input);
+  }
+  distinct(first, ...input) {
+    return this.addAggregator("countDistinct", first, ...input);
+  }
+  avg(first, ...input) {
+    return this.addAggregator("average", first, ...input);
+  }
+  min(first, ...input) {
+    return this.addAggregator("min", first, ...input);
+  }
+  max(first, ...input) {
+    return this.addAggregator("max", first, ...input);
+  }
+  sum(first, ...input) {
+    return this.addAggregator("sum", first, ...input);
+  }
+  where(field, operator, value) {
+    return this.addWhere({
+      fn: "where",
+      field,
+      operator,
+      value
+    });
+  }
+  orWhere(field, operator, value) {
+    return this.addWhere({
+      fn: "orWhere",
+      field,
+      operator,
+      value
+    });
+  }
+  whereIn(field, value) {
+    return this.addIn({
+      fn: "whereIn",
+      field,
+      value
+    });
+  }
+  orWhereIn(field, value) {
+    return this.addIn({
+      fn: "orWhereIn",
+      field,
+      value
+    });
+  }
+  whereNull(field) {
+    return this.addNull({
+      fn: "whereNull",
+      field
+    });
+  }
+  orWhereNull(field) {
+    return this.addNull({
+      fn: "orWhereNull",
+      field
+    });
+  }
+  whereNotNull(field) {
+    return this.addNull({
+      fn: "whereNotNull",
+      field
+    });
+  }
+  orWhereNotNull(field) {
+    return this.addNull({
+      fn: "orWhereNotNull",
+      field
+    });
+  }
+  whereMetadata(field, operator, value) {
+    return this.addMetadata({
+      fn: "whereMetadata",
+      field,
+      operator,
+      value
+    });
+  }
+  orWhereMetadata(field, operator, value) {
+    return this.addMetadata({
+      fn: "orWhereMetadata",
+      field,
+      operator,
+      value
+    });
+  }
+  whereMetadataIn(field, value) {
+    return this.addMetadataIn({
+      fn: "whereMetadataIn",
+      field,
+      value
+    });
+  }
+  orWhereMetadataIn(field, value) {
+    return this.addMetadataIn({
+      fn: "orWhereMetadataIn",
+      field,
+      value
+    });
+  }
+  whereMetadataNull(field) {
+    return this.addMetadataNull({
+      fn: "whereMetadataNull",
+      field
+    });
+  }
+  orWhereMetadataNull(field) {
+    return this.addMetadataNull({
+      fn: "orWhereMetadataNull",
+      field
+    });
+  }
+  whereMetadataNotNull(field) {
+    return this.addMetadataNull({
+      fn: "whereMetadataNotNull",
+      field
+    });
+  }
+  orWhereMetadataNotNull(field) {
+    return this.addMetadataNull({
+      fn: "orWhereMetadataNotNull",
+      field
+    });
+  }
+  // FILTERING FUNCTIONS
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AggregateQueryBuilder
+});

package/dist/lib/query-builder/aggregate-query-builder.d.ts

@@ -0,0 +1,115 @@
+import { GetDefaultAliasedObject, GetSelectedObject, Merge, OperatorType, RemoveMetadata, SearchableInObject, SearchableNullObject, SearchableObject, Selection, SelectionWithMetadata, StringKeyObject } from '.';
+import { DbFilterType } from '../../db/consts';
+import { DbFilterAllowedValue, DbFilterOperatorEquals, DbFilterOperatorForNumbers, DbFilterOperatorForStrings } from '../../db/consts.enums';
+import { ITxAggregator, ITxAggregatorSimple, ITxGroup, ITxPeriodSimple } from '../../txs/consts.enums';
+import { ReadStream } from '../isomorphic/node/streams';
+import { StreamPromise } from '../stream-promise';
+import { InnerBuiltQuery, InnerWhereBuilder, QueryBuilder } from './query-builder';
+type AggregateBuiltQuery<Options extends Zod.ZodTypeAny> = InnerBuiltQuery & {
+    aggregators: ITxAggregator[];
+    groups: ITxGroup[];
+    options: Zod.infer<Options>;
+};
+type AggregateRow<Aggregators, Groups> = {
+    [k in keyof Aggregators]: number;
+} & {
+    [k in keyof Groups]: string;
+};
+type AggregateResult<Result extends object, Aggregators extends object, Groups extends object> = {
+    [k in keyof Result]: k extends 'metadata' ? Result[k] : AggregateRow<Aggregators, Groups>[];
+};
+type AggregateMap = {
+    [key: string]: ITxAggregator;
+};
+type GroupMap = {
+    [key: string]: ITxGroup;
+};
+type GetAggregateObject<Fn extends ITxAggregatorSimple, First, Aggregate> = First extends undefined ? {
+    [k in Fn]: ITxAggregator;
+} : GetDefaultAliasedObject<First | Aggregate, Fn, ITxAggregator>;
+export declare class AggregateQueryBuilder<SearchableBasic extends Zod.AnyZodObject, Searchable extends Zod.AnyZodObject, Options extends Zod.ZodTypeAny, Aggregators extends AggregateMap, Groups extends GroupMap, AggregatableFields extends Zod.ZodTypeAny, GroupableFields extends Zod.ZodTypeAny, Result extends StringKeyObject> extends QueryBuilder<SearchableBasic, Searchable> {
+    $options: Zod.infer<Options>;
+    $optionsSchema: Options;
+    $start: (q: AggregateBuiltQuery<Options>) => StreamPromise<Result>;
+    $aggregators: Aggregators;
+    $groups: Groups;
+    $aggregatableSchema: AggregatableFields;
+    $groupableSchema: GroupableFields;
+    $timezone?: string;
+    constructor({ $queries, $options, start, schema, schemaBasic, optionsSchema, aggregators, groups, aggregatableSchema, groupableSchema, timezone, }: {
+        start: (q: AggregateBuiltQuery<Options>) => StreamPromise<Result>;
+        schemaBasic: SearchableBasic;
+        schema: Searchable;
+        optionsSchema: Options;
+        aggregators: Aggregators;
+        groups: Groups;
+        aggregatableSchema: AggregatableFields;
+        groupableSchema: GroupableFields;
+        $queries?: DbFilterType[];
+        $options?: Zod.infer<Options>;
+        timezone?: string;
+    });
+    protected add(addQuery: DbFilterType): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators, Groups, AggregatableFields, GroupableFields, Result>;
+    private start;
+    private getAggregators;
+    private getGroups;
+    toJSON(): AggregateBuiltQuery<Options>;
+    then<TResult1 = AggregateResult<Result, Aggregators, Groups>, TResult2 = never>(onfulfilled?: (value: AggregateResult<Result, Aggregators, Groups>) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: Error) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>;
+    catch<TResult2 = never>(onerror: (reason: Error) => TResult2 | PromiseLike<TResult2>): Promise<AggregateResult<Result, Aggregators, Groups> | TResult2>;
+    finally(fn: () => void): Promise<AggregateResult<Result, Aggregators, Groups>>;
+    stream(): ReadStream;
+    options(options: Zod.input<Options>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators, Groups, AggregatableFields, GroupableFields, Result>;
+    timezone(timezone: string): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators, Groups, AggregatableFields, GroupableFields, Result>;
+    groupBy<FirstInput extends SelectionWithMetadata<Zod.infer<GroupableFields> | ITxPeriodSimple>, GroupInput extends SelectionWithMetadata<Zod.infer<GroupableFields> | ITxPeriodSimple> | undefined = undefined>(first: FirstInput, ...input: ReadonlyArray<GroupInput>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators, Groups & GetSelectedObject<FirstInput | GroupInput, "year" | "month" | "week" | "day" | "hour" | "minute" | import("zod").TypeOf<GroupableFields>, {
+        type: "period";
+        field: "year" | "month" | "week" | "day" | "hour" | "minute" | {
+            period: "year" | "month" | "week" | "day" | "hour" | "minute";
+            timezone: string;
+        };
+        alias?: string | undefined;
+    } | {
+        type: "field";
+        field: string;
+        alias?: string | undefined;
+    } | {
+        type: "metadata_field";
+        field: string;
+        alias?: string | undefined;
+    }>, AggregatableFields, GroupableFields, Result>;
+    private addAggregator;
+    count<FirstInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined, AggregateInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined>(first?: FirstInput, ...input: ReadonlyArray<AggregateInput>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators & GetAggregateObject<"count", FirstInput, AggregateInput>, Groups, AggregatableFields, GroupableFields, Result>;
+    distinct<FirstInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined, AggregateInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined>(first?: FirstInput, ...input: ReadonlyArray<AggregateInput>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators & GetAggregateObject<"countDistinct", FirstInput, AggregateInput>, Groups, AggregatableFields, GroupableFields, Result>;
+    avg<FirstInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined, AggregateInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined>(first?: FirstInput, ...input: ReadonlyArray<AggregateInput>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators & GetAggregateObject<"average", FirstInput, AggregateInput>, Groups, AggregatableFields, GroupableFields, Result>;
+    min<FirstInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined, AggregateInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined>(first?: FirstInput, ...input: ReadonlyArray<AggregateInput>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators & GetAggregateObject<"min", FirstInput, AggregateInput>, Groups, AggregatableFields, GroupableFields, Result>;
+    max<FirstInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined, AggregateInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined>(first?: FirstInput, ...input: ReadonlyArray<AggregateInput>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators & GetAggregateObject<"max", FirstInput, AggregateInput>, Groups, AggregatableFields, GroupableFields, Result>;
+    sum<FirstInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined, AggregateInput extends Selection<Zod.infer<AggregatableFields>> | undefined = undefined>(first?: FirstInput, ...input: ReadonlyArray<AggregateInput>): AggregateQueryBuilder<SearchableBasic, Searchable, Options, Aggregators & GetAggregateObject<"sum", FirstInput, AggregateInput>, Groups, AggregatableFields, GroupableFields, Result>;
+    where(field: SearchableObject<Zod.input<SearchableBasic>>): ReturnType<typeof this.add>;
+    where(field: InnerWhereBuilder<SearchableBasic, Searchable>): ReturnType<typeof this.add>;
+    where<F extends keyof RemoveMetadata<Zod.input<Searchable>>, V extends Zod.input<Merge<SearchableBasic, Searchable>>[F]>(field: F, operator: V): ReturnType<typeof this.add>;
+    where<F extends keyof RemoveMetadata<Zod.input<Searchable>>, V extends Zod.input<Merge<SearchableBasic, Searchable>>[F]>(field: F, operator: OperatorType<V>, value: V): ReturnType<typeof this.add>;
+    orWhere(field: SearchableObject<Zod.input<SearchableBasic>>): ReturnType<typeof this.add>;
+    orWhere(field: InnerWhereBuilder<SearchableBasic, Searchable>): ReturnType<typeof this.add>;
+    orWhere<F extends keyof RemoveMetadata<Zod.input<Searchable>>, V extends Zod.input<Merge<SearchableBasic, Searchable>>[F]>(field: F, operator: V): ReturnType<typeof this.add>;
+    orWhere<F extends keyof RemoveMetadata<Zod.input<Searchable>>, V extends Zod.input<Merge<SearchableBasic, Searchable>>[F]>(field: F, operator: OperatorType<V>, value: V): ReturnType<typeof this.add>;
+    whereIn<F extends keyof SearchableInObject<Zod.input<Searchable>>, V extends SearchableInObject<Zod.input<Searchable>>[F]>(field: F, value: V): ReturnType<typeof this.add>;
+    orWhereIn<F extends keyof SearchableInObject<Zod.input<Searchable>>, V extends SearchableInObject<Zod.input<Searchable>>[F]>(field: F, value: V): ReturnType<typeof this.add>;
+    whereNull<F extends keyof SearchableNullObject<Searchable>>(field: F): ReturnType<typeof this.add>;
+    orWhereNull<F extends keyof SearchableNullObject<Zod.input<Searchable>>>(field: F): ReturnType<typeof this.add>;
+    whereNotNull<F extends keyof SearchableNullObject<Zod.input<Searchable>>>(field: F): ReturnType<typeof this.add>;
+    orWhereNotNull<F extends keyof SearchableNullObject<Zod.input<Searchable>>>(field: F): ReturnType<typeof this.add>;
+    whereMetadata(field: string, value: DbFilterAllowedValue): ReturnType<typeof this.add>;
+    whereMetadata(field: string, operator: DbFilterOperatorEquals, value: boolean): ReturnType<typeof this.add>;
+    whereMetadata(field: string, operator: DbFilterOperatorForNumbers, value: number): ReturnType<typeof this.add>;
+    whereMetadata(field: string, operator: DbFilterOperatorForStrings, value: string): ReturnType<typeof this.add>;
+    orWhereMetadata(field: string, value: DbFilterAllowedValue): ReturnType<typeof this.add>;
+    orWhereMetadata(field: string, operator: DbFilterOperatorEquals, value: boolean): ReturnType<typeof this.add>;
+    orWhereMetadata(field: string, operator: DbFilterOperatorForNumbers, value: number): ReturnType<typeof this.add>;
+    orWhereMetadata(field: string, operator: DbFilterOperatorForStrings, value: string): ReturnType<typeof this.add>;
+    whereMetadataIn(field: string, value: string[] | number[]): ReturnType<typeof this.add>;
+    orWhereMetadataIn(field: string, value: string[] | number[]): ReturnType<typeof this.add>;
+    whereMetadataNull(field: string): ReturnType<typeof this.add>;
+    orWhereMetadataNull(field: string): ReturnType<typeof this.add>;
+    whereMetadataNotNull(field: string): ReturnType<typeof this.add>;
+    orWhereMetadataNotNull(field: string): ReturnType<typeof this.add>;
+}
+export {};