cozy-pouch-link 57.4.0 → 57.6.0

package/types/db/dbInterface.d.ts

@@ -0,0 +1,117 @@
+export default DatabaseQueryEngine;
+export type FindParams = {
+    /**
+     * - The mango selector
+     */
+    selector: object;
+    /**
+     * - Following the mango selector syntax, used to filter out documents at indexing time
+     */
+    partialFilter: object;
+    /**
+     * - The mango sort
+     */
+    sort: any[];
+    /**
+     * - The doctype
+     */
+    doctype: string;
+    /**
+     * - Array of indexed field name
+     */
+    indexedFields: Array<string>;
+    /**
+     * - Maximum number of documents to return
+     */
+    limit: number;
+    /**
+     * - Number of documents to skip
+     */
+    skip: number;
+    /**
+     * - Whether or not an existing index should be recreated
+     */
+    recreateIndex: boolean;
+};
+export type AllDocsParams = {
+    /**
+     * - Maximum number of documents to return
+     */
+    limit: number;
+    /**
+     * - Number of documents to skip
+     */
+    skip: number;
+};
+export type QueryResponse = {
+    /**
+     * - The documents retrieved by the query
+     */
+    data: Array<object>;
+};
+export type QueryResponseSingleDoc = {
+    /**
+     * - The document retrieved by the query
+     */
+    data: object;
+};
+/**
+ * @typedef {object} FindParams
+ * @property {object} selector - The mango selector
+ * @property {object} partialFilter - Following the mango selector syntax, used to filter out documents at indexing time
+ * @property {Array} sort - The mango sort
+ * @property {string} doctype - The doctype
+ * @property {Array<string>} indexedFields - Array of indexed field name
+ * @property {number} limit - Maximum number of documents to return
+ * @property {number} skip - Number of documents to skip
+ * @property {boolean} recreateIndex - Whether or not an existing index should be recreated
+ */
+/**
+ * @typedef {object} AllDocsParams
+ * @property {number} limit - Maximum number of documents to return
+ * @property {number} skip - Number of documents to skip
+ */
+/**
+ * @typedef {object} QueryResponse
+ * @property {Array<object>} data - The documents retrieved by the query
+ */
+/**
+ * @typedef {object} QueryResponseSingleDoc
+ * @property {object} data - The document retrieved by the query
+ */
+declare class DatabaseQueryEngine {
+    /**
+     * Open the database
+     *
+     * @param {string} dbName - The database name
+     */
+    openDB(dbName: string): void;
+    /**
+     * Find docs with filtered query
+     *
+     * @param {FindParams} options - The find options
+     * @returns {Promise<QueryResponse>} The found docs
+     */
+    find(options: FindParams): Promise<QueryResponse>;
+    /**
+     * Get all docs
+     *
+     * @param {AllDocsParams} options - The all docs options
+     * @returns {Promise<QueryResponse>} The found docs
+     */
+    allDocs(options: AllDocsParams): Promise<QueryResponse>;
+    /**
+     * Get a single doc by its id
+     *
+     * @param {string} id - id of the document to get
+     * @returns {Promise<QueryResponseSingleDoc>} The found docs
+     */
+    getById(id: string): Promise<QueryResponseSingleDoc>;
+    /**
+     * Get several docs by their ids
+     *
+     * @param {Array<string>} ids - ids of the documents to get
+     * @returns {Promise<QueryResponse>} The found docs
+     */
+    getByIds(ids: Array<string>): Promise<QueryResponse>;
+}

package/types/db/helpers.d.ts

@@ -0,0 +1,3 @@
+export function getExistingDocument(queryEngine: DatabaseQueryEngine, id: string, throwIfNotFound?: boolean): Promise<import('./dbInterface').QueryResponseSingleDoc>;
+export function areDocsEqual(oldDoc: any, newDoc: any): Promise<boolean>;
+import DatabaseQueryEngine from "./dbInterface";

package/types/db/pouchdb/getDocs.d.ts

@@ -0,0 +1,18 @@
+export function getDocsAndNormalize({ client, doctype, db, queryFunc, queryParams, withRows }: {
+    client: any;
+    doctype: any;
+    db: any;
+    queryFunc: any;
+    queryParams?: {};
+    withRows?: boolean;
+}): Promise<{
+    data: any;
+    meta: {
+        count: any;
+    };
+    skip: any;
+    next: boolean;
+} | {
+    data: any;
+}>;
+export function getDocs(db: any, fct: any, queryParams?: {}): any;

package/types/db/pouchdb/pouchdb.d.ts

@@ -0,0 +1,8 @@
+export default class PouchDBQueryEngine extends DatabaseQueryEngine {
+    constructor(pouchManager: any, doctype: any);
+    pouchManager: any;
+    client: any;
+    doctype: any;
+    db: any;
+}
+import DatabaseQueryEngine from "../dbInterface";

package/types/db/sqlite/sql.d.ts

@@ -0,0 +1,45 @@
+export function keepDocWitHighestRev(docs: any): any;
+export function parseResults(client: any, result: any, doctype: any, { isSingleDoc, skip, limit }?: {
+    isSingleDoc?: boolean;
+    skip?: number;
+    limit?: any;
+}): {
+    data: any;
+    meta?: undefined;
+    skip?: undefined;
+    next?: undefined;
+} | {
+    data: any[];
+    meta: {
+        count: number;
+    };
+    skip: number;
+    next: boolean;
+};
+export function mangoSelectorToSQL(selector: any): string;
+export function makeWhereClause(selector: any): string;
+export function makeSortClause(mangoSortBy: any): string;
+export function makeSQLQueryFromMango({ selector, sort, indexName, limit, skip }: {
+    selector: any;
+    sort: any;
+    indexName: any;
+    limit: any;
+    skip?: number;
+}): string;
+export function makeSQLQueryForId(id: any): string;
+export function makeSQLQueryForIds(ids: any): string;
+export function makeSQLQueryAll({ limit, skip }?: {
+    limit?: number;
+    skip?: number;
+}): string;
+export function makeSQLDropIndex(indexName: any): string;
+export function makeSQLCreateMangoIndex(indexName: any, fieldsToIndex: any, { partialFilter }: {
+    partialFilter: any;
+}): string;
+export function makeSQLCreateDocIDIndex(): string;
+export function makeSQLCreateDeletedIndex(): string;
+export function createMangoIndex(db: any, indexName: any, fieldsToIndex: any, { partialFilter }: {
+    partialFilter: any;
+}): Promise<any>;
+export function deleteIndex(db: any, indexName: any): Promise<void>;
+export function executeSQL(db: any, sql: any): Promise<any>;

package/types/db/sqlite/sqliteDb.d.ts

@@ -0,0 +1,7 @@
+export default class SQLiteQueryEngine extends DatabaseQueryEngine {
+    constructor(pouchManager: any, doctype: any);
+    db: any;
+    client: any;
+    doctype: any;
+}
+import DatabaseQueryEngine from "../dbInterface";

package/types/errors.d.ts

@@ -1 +1,3 @@
 export function isExpiredTokenError(error: any): any;
+export function isMissingSQLiteIndexError(error: any): boolean;
+export function isMissingPouchDBIndexError(error: any): boolean;

package/types/helpers.d.ts

@@ -1,10 +1,7 @@
+export const LIMIT_BUG: 999;
 export default helpers;
 declare namespace helpers {
     function isAdapterBugged(adapterName: any): boolean;
-    function withoutDesignDocuments(res: any): any;
-    function getDocs(db: any, fct: any, options?: {}): any;
-    function allDocs(db: any, options?: {}): Promise<any>;
-    function find(db: any, options?: {}): Promise<any>;
     function isDesignDocument(doc: any): boolean;
     function isDeletedDocument(doc: any): any;
     function insertBulkDocs(db: any, docs: any): Promise<any>;

package/types/index.d.ts

@@ -1 +1,2 @@
 export { default } from "./CozyPouchLink";
+export { default as SQLiteQuery } from "./db/sqlite/sqliteDb";

package/types/jsonapi.d.ts

@@ -15,4 +15,6 @@ export function fromPouchResult({ res, withRows, doctype, client }: {
 } | {
     data: any;
 };
+export function sanitized(doc: any): Pick<any, string | number | symbol>;
+export function sanitizeJsonApi(doc: any): Pick<Pick<any, string | number | symbol>, string | number | symbol>;
 import CozyClient from "cozy-client";

package/types/mango.d.ts

@@ -1,3 +1,21 @@
 export function makeKeyFromPartialFilter(condition: object): string;
 export function getIndexNameFromFields(fields: Array<string>, partialFilter?: object): string;
-export function getIndexFields({ selector, sort, partialFilter }: import('./types').MangoQueryOptions): string[];
+export function getIndexFieldsFromFind({ selector, sort, partialFilter }: import('./types').MangoQueryOptions): string[];
+export function createIndex(db: object, fields: any[], { partialFilter, indexName, doctype }?: {
+    partialFilter: object;
+    indexName: string;
+    doctype: string;
+}): Promise<import('./types').PouchDbIndex>;
+export function findExistingIndex(doctype: string, options: import('./types').MangoQueryOptions, indexName: string): import('./types').PouchDbIndex | undefined;
+export function getIndexFields({ selector, sort, partialFilter, indexedFields }: {
+    selector: any;
+    sort: any;
+    partialFilter: any;
+    indexedFields: any;
+}): any;
+export function getIndexName({ selector, sort, indexedFields, partialFilter }: {
+    selector: any;
+    sort: any;
+    indexedFields: any;
+    partialFilter: any;
+}): string;

package/types/migrations/pouchdb.d.ts

@@ -0,0 +1 @@
+export function destroyOldDatabases(PouchDB: any, doctypes: any, prefix: any): void;

package/types/types.d.ts

@@ -33,6 +33,7 @@ export type LinkPlatform = {
      * PouchDB class (can be pouchdb-core or pouchdb-browser)
      */
     pouchAdapter: any;
+    queryEngine: DatabaseQueryEngine;
     /**
      * Method that check if the app is connected to internet
      */
@@ -144,3 +145,4 @@ export type PouchDBChanges = {
      */
     doc: object;
 };
+import DatabaseQueryEngine from "./db/dbInterface";

package/types/utils.d.ts

@@ -1,4 +1,7 @@
+export const DATABASE_NAME_SEPARATOR: "__doctype__";
 export function getDatabaseName(prefix: string, doctype: string): string;
+export function getOldDatabaseName(prefix: string, doctype: string): string;
+export function getDoctypeFromDatabaseName(dbName: any): any;
 export function getPrefix(uri: string): string;
 export function formatAggregatedError(aggregatedError: any): any;
 export function allSettled(promises: Promise<any>[]): Promise<(FulfilledPromise | RejectedPromise)[]>;