@decaf-ts/for-couchdb 0.1.14 → 0.1.16

package/lib/types.d.ts

@@ -187,219 +187,3 @@ export interface MangoQuery {
      * Optional, default: false. */
     execution_stats?: boolean;
 }
-/** Database authentication response.
- * @see Docs: {@link http://docs.couchdb.org/en/latest/api/server/authn.html#cookie-authentication} */
-export interface DatabaseAuthResponse {
-    /** Operation status */
-    ok: boolean;
-    /** Username */
-    name: string;
-    /** List of user roles */
-    roles: string[];
-}
-/** Database _session response.
- * @see Docs: {@link http://docs.couchdb.org/en/latest/api/server/authn.html#get--_session} */
-export interface DatabaseSessionResponse {
-    /** Operation status */
-    ok: boolean;
-    /** User context for the current user */
-    userCtx: any;
-    /** Server authentication configuration */
-    info: any;
-}
-export interface MaybeIdentifiedDocument {
-    _id?: string;
-}
-export interface IdentifiedDocument {
-    _id: string;
-}
-export interface MaybeRevisionedDocument {
-    _rev?: string;
-}
-export interface RevisionedDocument {
-    _rev: string;
-}
-export interface MaybeDocument extends MaybeIdentifiedDocument, MaybeRevisionedDocument {
-}
-export interface Document extends IdentifiedDocument, RevisionedDocument {
-}
-export type DocumentInfer<D> = (doc: D & Document) => void;
-export interface View<D> {
-    map?: string | DocumentInfer<D>;
-    reduce?: string | DocumentInfer<D>;
-}
-export interface ViewDocument<D> extends IdentifiedDocument {
-    views: {
-        [name: string]: View<D>;
-    };
-}
-/** Document insert parameters.
- * @see POST docs: {@link http://docs.couchdb.org/en/latest/api/database/common.html#post--db}
- * @see PUT docs: {@link http://docs.couchdb.org/en/latest/api/document/common.html#put--db-docid} */
-export interface DocumentInsertParams {
-    /** Document ID */
-    docName?: string;
-    /** Document’s revision if updating an existing document. Alternative to If-Match header or document key. */
-    rev?: string;
-    /** Stores document in batch mode. */
-    batch?: "ok";
-    /** Prevents insertion of a conflicting document.
-     *
-     * If false, a well-formed `_rev` must be included in the document. `new_edits=false` is used by the replicator to
-     * insert documents into the target database even if that leads to the creation of conflicts.
-     *
-     * @default true */
-    new_edits?: boolean;
-}
-/** Document get parameters.
- * @see Docs: {@link http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid} */
-export interface DocumentGetParams {
-    /** Includes attachments bodies in response.
-     *
-     * @default false */
-    attachments?: boolean;
-    /** Includes encoding information in attachment stubs if the particular attachment is compressed.
-     *
-     * @default false */
-    att_encoding_info?: boolean;
-    /** Includes attachments only since specified revisions.
-     *
-     * Doesn’t includes attachments for specified revisions. */
-    atts_since?: any[];
-    /** Includes information about conflicts in document.
-     *
-     * @default false */
-    conflicts?: boolean;
-    /** Includes information about deleted conflicted revisions.
-     *
-     * @default false */
-    deleted_conflicts?: boolean;
-    /** Forces retrieving latest “leaf” revision, no matter what rev was requested.
-     *
-     * @default false */
-    latest?: boolean;
-    /** Includes last update sequence for the document.
-     *
-     * @default false */
-    local_seq?: boolean;
-    /** Acts same as specifying all conflicts, deleted_conflicts and revs_info query parameters.
-     *
-     * @default false */
-    meta?: boolean;
-    /** Retrieves documents of specified leaf revisions.
-     *
-     * Additionally, it accepts value as all to return all leaf revisions. */
-    open_revs?: any[];
-    /** Retrieves document of specified revision. */
-    rev?: string;
-    /** Includes list of all known document revisions. */
-    revs?: boolean;
-    /** Includes detailed information for all known document revisions.
-     *
-     * @default false */
-    revs_info?: boolean;
-}
-/** Server scope */
-export interface ServerScope {
-    /**
-     * Returns a database object that allows you to perform operations against that database.
-     * @see README: {@link https://www.npmjs.com/package/nano#nanousename}
-     */
-    use<D>(db: string): DocumentScope<D>;
-    /**
-     * Initiates new session for specified user credentials by providing Cookie value.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/server/authn.html#cookie-authentication} */
-    auth(username: string, userpass: string): Promise<DatabaseAuthResponse>;
-    /**
-     * Returns information about the authenticated user, including a User Context Object, the authentication method and database that were used, and a list of configured authentication handlers on the server.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/server/authn.html#get--_session} */
-    session(): Promise<DatabaseSessionResponse>;
-}
-/** Fetch with POST _all_docs parameters.
- * @see Docs: {@link https://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs} */
-export interface DocumentFetchParams {
-    conflicts?: boolean;
-    descending?: boolean;
-    end_key?: string;
-    end_key_doc_id?: string;
-    include_docs?: boolean;
-    inclusive_end?: boolean;
-    key?: string;
-    keys?: string | string[];
-    limit?: number;
-    skip?: number;
-    stale?: string;
-    start_key?: string;
-    start_key_doc_id?: string;
-    update_seq?: boolean;
-}
-/** Document fetch error */
-export interface DocumentLookupFailure {
-    key: string;
-    error: string;
-}
-/** Bulk API per-document response. */
-export interface DocumentResponseRowMeta {
-    id: string;
-    key: string;
-    value: {
-        rev: string;
-    };
-    error?: string;
-}
-/** Bulk API per-document response with document body. */
-export interface DocumentResponseRow<D> extends DocumentResponseRowMeta {
-    doc?: D & Document;
-}
-/** Fetch with POST _all_docs response
- * @see Docs: {@link https://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs} */
-export interface DocumentFetchResponse<D> {
-    offset: number;
-    rows: Array<DocumentResponseRow<D> | DocumentLookupFailure>;
-    total_rows: number;
-    update_seq?: number | string;
-}
-/** Documents scope */
-export interface DocumentScope<D> {
-    /** Initiates new session for specified user credentials by providing Cookie value.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/server/authn.html#cookie-authentication} */
-    auth(username: string, userpass: string): Promise<DatabaseAuthResponse>;
-    /** Returns information about the authenticated user, including a User Context Object, the authentication method and database that were used, and a list of configured authentication handlers on the server.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/server/authn.html#get--_session} */
-    session(): Promise<DatabaseSessionResponse>;
-    /** Insert a document into this database.
-     * @see POST Docs: {@link http://docs.couchdb.org/en/latest/api/database/common.html#post--db}
-     * @see PUT Docs: {@link http://docs.couchdb.org/en/latest/api/document/common.html#put--db-docid} */
-    insert(document: ViewDocument<D> | (D & MaybeDocument)): Promise<DocumentInsertResponse>;
-    /**
-     * Insert a document into this database with options.
-     * @see POST Docs: {@link http://docs.couchdb.org/en/latest/api/database/common.html#post--db}
-     * @see PUT Docs: {@link http://docs.couchdb.org/en/latest/api/document/common.html#put--db-docid} */
-    insert(document: ViewDocument<D> | (D & MaybeDocument), params: DocumentInsertParams | string | null): Promise<DocumentInsertResponse>;
-    /** Fetch a document from this database.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid} */
-    get(docname: string): Promise<DocumentGetResponse & D>;
-    /** Fetch a document from this database with options.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid} */
-    get(docname: string, params?: DocumentGetParams): Promise<DocumentGetResponse & D>;
-    /** Delete a document from this database.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/document/common.html#delete--db-docid} */
-    destroy(docname: string, rev: string): Promise<DocumentDestroyResponse>;
-    /** Bulk insert/update/delete multiple documents in this database.
-     * @see Docs: {@link https://docs.couchdb.org/en/stable/api/database/bulk-api.html#db-bulk-docs} */
-    bulk(docs: BulkModifyDocsWrapper): Promise<DocumentBulkResponse[]>;
-    /** Bulk insert/update/delete multiple documents in this database, with options.
-     * @see Docs: {@link https://docs.couchdb.org/en/stable/api/database/bulk-api.html#db-bulk-docs} */
-    bulk(docs: BulkModifyDocsWrapper, params: any): Promise<DocumentInsertResponse[]>;
-    /** Create a Mango index.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#db-index} */
-    createIndex(indexDef: CreateIndexRequest): Promise<CreateIndexResponse>;
-    /** Fetch a list of documents by _id with options.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs} */
-    fetch(docnames: BulkFetchDocsWrapper, params: DocumentFetchParams): Promise<DocumentFetchResponse<D>>;
-    /** Run Mango query.
-     * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#db-find} */
-    find(query: MangoQuery): Promise<MangoResponse<D>>;
-    /** Server scope */
-    server: ServerScope;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/for-couchdb",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "template for ts projects",
   "type": "module",
   "exports": {