@decaf-ts/for-couchdb 0.1.28 → 0.1.29

package/lib/query/Statement.d.ts

@@ -1,13 +0,0 @@
-import { Adapter, Statement } from "@decaf-ts/core";
-import { Paginator } from "@decaf-ts/core";
-import { MangoQuery } from "../types";
-export declare class CouchDBStatement<Y> extends Statement<MangoQuery> {
-    constructor(adapter: Adapter<Y, MangoQuery>);
-    /**
-     * @inheritDoc
-     */
-    execute<Y>(): Promise<Y>;
-    paginate<R>(size: number): Promise<Paginator<R, MangoQuery>>;
-    private processRecord;
-    raw<R>(rawInput: MangoQuery, ...args: any[]): Promise<R>;
-}

package/lib/query/ValuesClause.d.ts

@@ -1,7 +0,0 @@
-import { ValuesClause } from "@decaf-ts/core";
-import { ModelArg, Model } from "@decaf-ts/decorator-validation";
-import { MangoQuery } from "../types";
-export declare class CouchDBValuesClause<M extends Model> extends ValuesClause<MangoQuery, M> {
-    constructor(clause: ModelArg<ValuesClause<MangoQuery, M>>);
-    build(previous: MangoQuery): MangoQuery;
-}

package/lib/query/WhereClause.d.ts

@@ -1,7 +0,0 @@
-import { WhereClause } from "@decaf-ts/core";
-import { ModelArg } from "@decaf-ts/decorator-validation";
-import { MangoQuery } from "../types";
-export declare class CouchDBWhereClause extends WhereClause<MangoQuery> {
-    constructor(clause: ModelArg<WhereClause<MangoQuery>>);
-    build(query: MangoQuery): MangoQuery;
-}

package/lib/query/constants.d.ts

@@ -1,4 +0,0 @@
-import { MangoOperator } from "../types";
-export declare const CouchDBOperator: Record<string, MangoOperator>;
-export declare const CouchDBGroupOperator: Record<string, MangoOperator>;
-export declare const CouchDBConst: Record<string, string>;

package/lib/query/factory.d.ts

@@ -1,24 +0,0 @@
-import { ClauseFactory, Condition, FromClause, FromSelector, GroupBySelector, LimitSelector, OffsetSelector, OrderBySelector, SelectSelector, Statement } from "@decaf-ts/core";
-import { LimitClause } from "@decaf-ts/core";
-import { SelectClause } from "@decaf-ts/core";
-import { WhereClause } from "@decaf-ts/core";
-import { OffsetClause } from "@decaf-ts/core";
-import { OrderByClause } from "@decaf-ts/core";
-import { GroupByClause } from "@decaf-ts/core";
-import { ValuesClause } from "@decaf-ts/core";
-import { InsertClause } from "@decaf-ts/core";
-import { Model } from "@decaf-ts/decorator-validation";
-import { CouchDBAdapter } from "../adapter";
-import { MangoQuery } from "../types";
-export declare class Factory<S> extends ClauseFactory<S, MangoQuery> {
-    constructor(adapter: CouchDBAdapter<S>);
-    from<M extends Model>(statement: Statement<MangoQuery>, selector: FromSelector<M>): FromClause<MangoQuery, M>;
-    groupBy(statement: Statement<MangoQuery>, selector: GroupBySelector): GroupByClause<MangoQuery>;
-    insert<M extends Model>(): InsertClause<MangoQuery, M>;
-    limit(statement: Statement<MangoQuery>, selector: LimitSelector): LimitClause<MangoQuery>;
-    offset(statement: Statement<MangoQuery>, selector: OffsetSelector): OffsetClause<MangoQuery>;
-    orderBy(statement: Statement<MangoQuery>, selector: OrderBySelector[]): OrderByClause<MangoQuery>;
-    select<M extends Model>(selector: SelectSelector | undefined): SelectClause<MangoQuery, M>;
-    values<M extends Model>(statement: Statement<MangoQuery>, values: M[]): ValuesClause<MangoQuery, M>;
-    where(statement: Statement<MangoQuery>, condition: Condition): WhereClause<MangoQuery>;
-}

package/lib/query/index.d.ts

@@ -1 +0,0 @@
-export * from "./factory";

package/lib/query/translate.d.ts

@@ -1,3 +0,0 @@
-import { GroupOperator, Operator } from "@decaf-ts/core";
-import { MangoOperator } from "../types";
-export declare function translateOperators(operator: GroupOperator | Operator): MangoOperator;

package/lib/sequences/Sequence.d.ts

@@ -1,49 +0,0 @@
-import { Sequence as Seq } from "../model/CouchDBSequence";
-import { Adapter, SequenceOptions } from "@decaf-ts/core";
-import { Sequence } from "@decaf-ts/core";
-import { MangoQuery } from "../types";
-import { CouchDBRepository } from "../interfaces";
-/**
- * @summary Abstract implementation of a Sequence
- * @description provides the basic functionality for {@link Sequence}s
- *
- * @param {SequenceOptions} options
- *
- * @class CouchDBSequence
- * @implements Sequence
- *
- * @category Sequences
- */
-export declare class CouchDBSequence extends Sequence {
-    protected repo: CouchDBRepository<Seq, any>;
-    constructor(options: SequenceOptions, adapter: Adapter<any, MangoQuery>);
-    /**
-     * @summary Retrieves the current value for the sequence
-     * @protected
-     */
-    current(): Promise<string | number | bigint>;
-    /**
-     * @summary Parses the {@link Sequence} value
-     *
-     * @protected
-     * @param value
-     */
-    private parse;
-    /**
-     * @summary increments the sequence
-     * @description Sequence specific implementation
-     *
-     * @param {string | number | bigint} current
-     * @param count
-     * @protected
-     */
-    private increment;
-    /**
-     * @summary Generates the next value in th sequence
-     * @description calls {@link Sequence#parse} on the current value
-     * followed by {@link Sequence#increment}
-     *
-     */
-    next(): Promise<number | string | bigint>;
-    range(count: number): Promise<(number | string | bigint)[]>;
-}

package/lib/sequences/index.d.ts

@@ -1 +0,0 @@
-export * from "./Sequence";

package/lib/sequences/utils.d.ts

@@ -1 +0,0 @@
-export declare function parseSequenceValue(type: "Number" | "BigInt" | undefined, value: string | number | bigint): string | number | bigint;

package/lib/types.d.ts

@@ -1,112 +0,0 @@
-/** Mango response.
- * @see Docs: {@link https://docs.couchdb.org/en/latest/api/database/find.html#db-find}  */
-export interface MangoResponse<D> {
-    /** Array of documents matching the search.
-     *
-     * In each matching document, the fields specified in the fields part of the request body are listed, along with
-     * their values. */
-    docs: (D & {
-        _id: string;
-        _rev: string;
-    })[];
-    /** A string that enables you to specify which page of results you require.
-     *
-     * Used for paging through result sets. */
-    bookmark?: string;
-    /** Execution warnings */
-    warning?: string;
-    /** Basic execution statistics for a specific request. */
-    execution_stats?: MangoExecutionStats;
-}
-/** Mango execution stats.
- * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#execution-statistics} */
-export interface MangoExecutionStats {
-    /** Number of index keys examined. Currently always 0. */
-    total_keys_examined: number;
-    /** Number of documents fetched from the database / index.
-     *
-     * Equivalent to using include_docs = true in a view. */
-    total_docs_examined: number;
-    /** Number of documents fetched from the database using an out-of-band document fetch.
-     *
-     * This is only non-zero when read quorum > 1 is specified in the query parameters. */
-    total_quorum_docs_examined: number;
-    /** Number of results returned from the query. */
-    results_returned: number;
-    /** Total execution time in milliseconds as measured by the database. */
-    execution_time_ms: number;
-}
-/** Mango create index parameters.
- * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#db-index} */
-export interface CreateIndexRequest {
-    /** JSON object describing the index to create */
-    index: {
-        /** Array of field names following the sort syntax. */
-        fields: SortOrder[];
-        /** A selector to apply to documents at indexing time, creating a partial index. */
-        partial_filter_selector?: MangoSelector;
-    };
-    /** Name of the design document in which the index will be created. */
-    ddoc?: string;
-    /** Name of the index. If no name is provided, a name will be generated automatically. */
-    name?: string;
-    /** Can be "json" or "text".
-     *
-     * @default "json" */
-    type?: "json" | "text";
-    /** This field sets whether the created index will be a partitioned or global index. */
-    partitioned?: boolean;
-}
-export type MangoValue = number | string | Date | boolean | object | null;
-export type MangoOperator = "$lt" | "$lte" | "$eq" | "$ne" | "$gte" | "$gt" | "$exists" | "$type" | "$in" | "$nin" | "$size" | "$mod" | "$regex" | "$or" | "$and" | "$nor" | "$not" | "$all" | "$allMatch" | "$elemMatch";
-/** Mango selector syntax.
- * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#selector-syntax} */
-export type MangoSelector = {
-    [K in MangoOperator | string]: MangoSelector | MangoSelector[] | MangoValue | MangoValue[];
-};
-/** Mango sort syntax
- * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#sort-syntax} */
-export type SortOrder = string | string[] | {
-    [key: string]: "asc" | "desc";
-};
-/** Mango query syntax.
- * @see Docs: {@link https://docs.couchdb.org/en/latest/api/database/find.html#db-find}  */
-export interface MangoQuery {
-    /** JSON object describing criteria used to select documents. */
-    selector: MangoSelector;
-    /** Maximum number of results returned. @default 25 */
-    limit?: number;
-    /** Skip the first 'n' results, where 'n' is the value specified. */
-    skip?: number;
-    /** JSON array following sort syntax. */
-    sort?: SortOrder[];
-    /** JSON array specifying which fields of each object should be returned.
-     *
-     * If it is omitted, the entire object is returned.
-     *
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#filtering-fields} */
-    fields?: string[];
-    use_index?: string | [string, string];
-    /** Read quorum needed for the result.
-     *
-     * @default 1 */
-    r?: number;
-    /** A string that enables you to specify which page of results you require.
-     *
-     * Used for paging through result sets. */
-    bookmark?: string;
-    /** Whether to update the index prior to returning the result.
-     *
-     * @default true */
-    update?: boolean;
-    /** Whether or not the view results should be returned from a “stable” set of shards. */
-    stable?: boolean;
-    /** Combination of update = false and stable = true options.
-     *
-     * Possible options: "ok", false (default). */
-    stale?: "ok" | false;
-    /** Include execution statistics in the query response.
-     *
-     * Optional, default: false. */
-    execution_stats?: boolean;
-}

package/lib/utils.d.ts

@@ -1,7 +0,0 @@
-import { OrderDirection } from "@decaf-ts/core";
-import { CreateIndexRequest } from "./types";
-export declare function reAuth(con: any, user: string, pass: string): Promise<any>;
-export declare function wrapDocumentScope(con: any, dbName: string, user: string, pass: string): any;
-export declare function testReservedAttributes(attr: string): RegExpMatchArray | null;
-export declare function generateIndexName(attribute: string, tableName: string, compositions?: string[], order?: OrderDirection, separator?: string): string;
-export declare function generateIndexDoc(attribute: string, tableName: string, compositions?: string[], order?: OrderDirection, separator?: string): CreateIndexRequest;