wapi-client 0.12.3 → 0.12.5-beta.1

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

@@ -1,242 +0,0 @@
-import { DbFilterFunctionWhereIn, DbFilterFunctionWhereMetadataIn, DbFilterFunctionWhereNull, DbFilterInner, DbFilterFunctionWhereMetadataPrimitive, DbFilterFunctionWhereObject, DbFilterFunctionWherePrimitive, DbFilterOperatorForNumbers, DbFilterOperatorExtended, DbFilterFunctionWhereMetadataNull, DbFilterOperatorString } from '../db/consts.enums';
-import { ITxAggregator, ITxGroups, ITxLimitingOptions, ITxOrderingOptions, ITxPeriodSimple, ITxSelectOptions } from '../txs/consts.enums';
-import { StreamPromise } from './stream-promise';
-import { ReadStream } from './isomorphic/node/streams';
-export type Primitive = string | number | boolean;
-type QueryBuilderDbFilter = DbFilterFunctionWhereObject | DbFilterFunctionWherePrimitive | DbFilterFunctionWhereNull | DbFilterFunctionWhereMetadataNull | DbFilterFunctionWhereIn | DbFilterFunctionWhereMetadataIn | DbFilterInner | DbFilterFunctionWhereMetadataPrimitive;
-/**
- * @internal
- */
-declare class QueryBuilderInner<Fields extends string, StringFields extends string, MetadataFields extends string, Result> {
-    private filter;
-    private modifierFn?;
-    constructor(modifiers?: (field: Fields | StringFields | MetadataFields, value: Primitive | {
-        [k: string]: unknown;
-    }) => unknown);
-    private add;
-    private addWhere;
-    where(field: Fields, operator: DbFilterOperatorForNumbers, value: Primitive): this;
-    where(field: StringFields, operator: DbFilterOperatorForNumbers | DbFilterOperatorString, value: string): this;
-    where(field: Fields, value: Primitive): this;
-    where(field: StringFields, value: string): this;
-    where(field: MetadataFields, value: {
-        [k: string]: unknown;
-    }): this;
-    where(field: {
-        [key in Fields]?: Primitive;
-    } & {
-        [key in StringFields]?: string;
-    } & {
-        [key in MetadataFields]?: {
-            [k: string]: unknown;
-        };
-    }): this;
-    where(field: (builder: QueryBuilderInner<Fields, StringFields, MetadataFields, Result>) => void): this;
-    orWhere(field: Fields, operator: DbFilterOperatorForNumbers, value: Primitive): this;
-    orWhere(field: StringFields, operator: DbFilterOperatorForNumbers | DbFilterOperatorString, value: string): this;
-    orWhere(field: Fields, value: Primitive): this;
-    orWhere(field: StringFields, value: string): this;
-    orWhere(field: MetadataFields, value: {
-        [k: string]: unknown;
-    }): this;
-    orWhere(field: {
-        [key in Fields]?: Primitive;
-    } & {
-        [key in StringFields]?: string;
-    } & {
-        [key in MetadataFields]?: {
-            [k: string]: unknown;
-        };
-    }): this;
-    orWhere(field: (builder: QueryBuilderInner<Fields, StringFields, MetadataFields, Result>) => void): this;
-    whereIn(field: StringFields, value: string[]): this;
-    whereIn(field: Fields, value: string[] | number[]): this;
-    orWhereIn(field: StringFields, value: string[]): this;
-    orWhereIn(field: Fields, value: string[] | number[]): this;
-    whereNull(field: Fields | StringFields | MetadataFields): this;
-    orWhereNull(field: Fields | StringFields | MetadataFields): this;
-    whereNotNull(field: Fields | StringFields | MetadataFields): this;
-    orWhereNotNull(field: Fields | StringFields | MetadataFields): this;
-    whereMetadata(field: string, operator: DbFilterOperatorExtended, value: string | number): this;
-    whereMetadata(field: string, value: string | number | boolean): this;
-    orWhereMetadata(field: string, operator: DbFilterOperatorExtended, value: string | number): this;
-    orWhereMetadata(field: string, value: string | number | boolean): this;
-    whereMetadataIn(field: string, value: string[] | number[]): this;
-    orWhereMetadataIn(field: string, value: string[] | number[]): this;
-    whereMetadataNull(field: string): this;
-    orWhereMetadataNull(field: string): this;
-    whereMetadataNotNull(field: string): this;
-    orWhereMetadataNotNull(field: string): this;
-    toJSON(): {
-        filter: QueryBuilderDbFilter[];
-    };
-}
-export type BuiltBaseQuery = {
-    filter: QueryBuilderDbFilter[];
-    options: {
-        [k: string]: unknown;
-    };
-};
-export type BuiltAggregateQueryDelta = {
-    groups: ITxGroups;
-    aggregators: ITxAggregator;
-};
-export type BuiltAggregateQuery = BuiltBaseQuery & BuiltAggregateQueryDelta;
-export type BuiltUpdateQueryDelta = {
-    update: {
-        [k: string]: unknown;
-    };
-};
-export type BuiltUpdateQuery = BuiltBaseQuery & BuiltUpdateQueryDelta;
-export type BuiltReverseQueryDelta = {
-    reverse: {
-        [k: string]: unknown;
-    };
-};
-export type BuiltReverseQuery = BuiltBaseQuery & BuiltReverseQueryDelta;
-export type BuiltQuery = BuiltBaseQuery & Partial<BuiltAggregateQueryDelta> & Partial<BuiltUpdateQueryDelta> & Partial<BuiltReverseQueryDelta>;
-export type BaseOptions = Partial<ITxLimitingOptions> & Partial<ITxOrderingOptions> & Partial<ITxSelectOptions>;
-export type QueryBuilderOrderingInputObject = {
-    column: string;
-    order?: 'asc' | 'desc';
-    nulls?: 'first' | 'last';
-};
-export type QueryBuilderOrderingInput = string | QueryBuilderOrderingInputObject;
-export declare class QueryBuilderInterface<TableFields extends string, StringFields extends string, MetadataFields extends string, Options, Result> extends QueryBuilderInner<TableFields, StringFields, MetadataFields, Result> {
-    private execFn;
-    protected optionsObject: {
-        [k: string]: unknown;
-    };
-    private optionsModifiers?;
-    constructor({ start, modifiers, optionsModifiers, }: {
-        start: (query: BuiltQuery) => StreamPromise<Result>;
-        modifiers?: (field: TableFields | StringFields | MetadataFields, value: Primitive | {
-            [k: string]: unknown;
-        }) => unknown;
-        optionsModifiers?: (field: string, value: unknown) => unknown;
-    });
-    private start;
-    toJSON(): BuiltBaseQuery;
-    options(optionsInput: Options): this;
-    then<TResult1 = Result, TResult2 = never>(onfulfilled?: (value: Result) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: Error) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>;
-    catch<TResult2 = never>(onerror: (reason: Error) => TResult2 | PromiseLike<TResult2>): Promise<Result | TResult2>;
-    stream(): ReadStream;
-}
-/**
- * A class for constructing queries for advanced filters
- * uses similar API as knex.js
- *
- * ```javascript
- * const queryBuilder = wapi.findTransfers();
- *
- * queryBuilder
- *   .where({
- *     metadata: {
- *       custom: true,
- *     }
- *   })
- *   .where('id', '>', 10)
- *   .orWhere(builder => {
- *     builder
- *       .where('status', 'finished')
- *       .orWhere('created_at', '>', '2019')
- *   })
- *   .limit(10)
- *   .offset(4)
- *   .orderBy('id', 'desc')
- *   .options({
- *     tracking_id: 'myIdHere',
- *   })
- *   //.stream() - if you want to use as stream
- *   //.then() - if you want to use as promise
- *
- * ```
- */
-export declare class QueryBuilder<TableFields extends string, StringFields extends string, MetadataFields extends string, ResultFields extends string, Options extends BaseOptions, Result> extends QueryBuilderInterface<TableFields, StringFields, MetadataFields, Options, Result> {
-    constructor({ start, modifiers, optionsModifiers, }: {
-        start: (query: BuiltQuery) => StreamPromise<Result>;
-        modifiers?: (field: TableFields | StringFields | MetadataFields, value: Primitive | {
-            [k: string]: unknown;
-        }) => unknown;
-        optionsModifiers?: (field: string, value: unknown) => unknown;
-    });
-    limit(nr: number): this;
-    offset(nr: number): this;
-    orderBy(input: ResultFields | `${string} ${'asc' | 'desc'}` | `${string} ${'asc' | 'desc'} nulls ${'first' | 'last'}` | QueryBuilderOrderingInput[], direction?: 'asc' | 'desc', nullsDirection?: 'first' | 'last'): this;
-    select(...fields: ResultFields[]): this;
-    deselect(...fields: ResultFields[]): this;
-}
-/**
- * A class for constructing queries for advanced filters
- * uses similar API as knex.js
- *
- * ```javascript
- * const queryBuilder = wapi.findTransfers();
- *
- * queryBuilder
- *   .where({
- *     metadata: {
- *       custom: true,
- *     }
- *   })
- *   .where('id', '>', 10)
- *   .orWhere(builder => {
- *     builder
- *       .where('status', 'finished')
- *       .orWhere('created_at', '>', '2019')
- *   })
- *   .groupBy('metadata.type as type')
- *   .sum('to.amount as amount')
- *   .options({
- *     tracking_id: 'myIdHere',
- *   })
- *   //.stream() - if you want to use as stream
- *   //.then() - if you want to use as promise
- *
- * ```
- */
-export declare class AggregateQueryBuilder<TableFields extends string, StringFields extends string, MetadataFields extends string, GroupFields extends string, Options, Result> extends QueryBuilderInterface<TableFields, StringFields, MetadataFields, Options, Result> {
-    private aggregatorObject;
-    private timezoneString;
-    constructor({ start, modifiers, optionsModifiers, }: {
-        start: (query: BuiltAggregateQuery) => StreamPromise<Result>;
-        modifiers?: (field: TableFields | StringFields | MetadataFields, value: Primitive | {
-            [k: string]: unknown;
-        }) => unknown;
-        optionsModifiers?: (field: string, value: unknown) => unknown;
-    });
-    toJSON(): BuiltAggregateQuery;
-    timezone(input: string): this;
-    groupBy(input: GroupFields | ITxPeriodSimple | `metadata.${string}`, ...rest: (GroupFields | ITxPeriodSimple | `metadata.${string}`)[]): this;
-    count(input?: string): this;
-    distinct(input?: string): this;
-    avg(input?: string): this;
-    min(input?: string): this;
-    max(input?: string): this;
-    sum(input?: string): this;
-}
-export declare class UpdateQueryBuilder<TableFields extends string, StringFields extends string, MetadataFields extends string, ResultFields extends string, UpdateFields, Options, Result> extends QueryBuilderInterface<TableFields, StringFields, MetadataFields, Options, Result> {
-    private updateObject;
-    constructor({ start, modifiers, optionsModifiers, }: {
-        start: (query: BuiltUpdateQuery) => StreamPromise<Result>;
-        modifiers?: (field: TableFields | StringFields | MetadataFields | ResultFields, value: Primitive | {
-            [k: string]: unknown;
-        }) => unknown;
-        optionsModifiers?: (field: string, value: unknown) => unknown;
-    });
-    toJSON(): BuiltUpdateQuery;
-    update(updateData: UpdateFields): this;
-}
-export declare class ReverseQueryBuilder<TableFields extends string, StringFields extends string, MetadataFields extends string, ReverseModifications, Options, Result> extends QueryBuilderInterface<TableFields, StringFields, MetadataFields, Options, Result> {
-    private reverseModifications;
-    constructor({ start, modifiers, optionsModifiers, }: {
-        start: (query: BuiltReverseQuery) => StreamPromise<Result>;
-        modifiers?: (field: TableFields | StringFields | MetadataFields, value: Primitive | {
-            [k: string]: unknown;
-        }) => unknown;
-        optionsModifiers?: (field: string, value: unknown) => unknown;
-    });
-    toJSON(): BuiltReverseQuery;
-    reverse(modifications: ReverseModifications): this;
-}
-export {};