cozy-client 38.0.0 → 38.0.2

package/types/helpers/urlHelper.d.ts

@@ -7,8 +7,8 @@ export function generateWebLink({ cozyUrl, searchParams: searchParamsOption, pat
     slug: string;
     subDomainType: string;
 }): string;
-export function deconstructCozyWebLinkWithSlug(webLink: string, subDomainType?: SubdomainType): CozyLinkData;
-export function deconstructRedirectLink(redirectLink: string): RedirectLinkData;
+export function deconstructCozyWebLinkWithSlug(webLink: string, subDomainType?: import("../types").SubdomainType): import("../types").CozyLinkData;
+export function deconstructRedirectLink(redirectLink: string): import("../types").RedirectLinkData;
 export class InvalidRedirectLinkError extends Error {
     constructor(redirectLink: any);
     redirectLink: any;
@@ -22,6 +22,3 @@ export class InvalidCozyUrlError extends Error {
     url: any;
 }
 export function rootCozyUrl(url: URL): Promise<URL>;
-import { SubdomainType } from "../types";
-import { CozyLinkData } from "../types";
-import { RedirectLinkData } from "../types";

package/types/hooks/useAppsInMaintenance.d.ts

@@ -4,8 +4,7 @@ export default useAppsInMaintenance;
  *
  * @param {CozyClient} client CozyClient instance
  *
- * @returns {AppsDoctype[]} An array with all apps in maintenance
+ * @returns {import("../types").AppsDoctype[]} An array with all apps in maintenance
  */
-declare function useAppsInMaintenance(client: CozyClient): AppsDoctype[];
+declare function useAppsInMaintenance(client: CozyClient): import("../types").AppsDoctype[];
 import CozyClient from "../CozyClient";
-import { AppsDoctype } from "../types";

package/types/hooks/useQuery.d.ts

@@ -4,10 +4,8 @@ export default useQuery;
  * Fetches a queryDefinition and returns the queryState
  *
  * @param {QueryDefinition} queryDefinition - Definition created with Q()
- * @param {QueryOptions} options - Options created with Q()
- * @returns {UseQueryReturnValue}
+ * @param {import("../types").QueryOptions} options - Options created with Q()
+ * @returns {import("../types").UseQueryReturnValue}
  */
-declare function useQuery(queryDefinition: QueryDefinition, options: QueryOptions): UseQueryReturnValue;
+declare function useQuery(queryDefinition: QueryDefinition, options: import("../types").QueryOptions): import("../types").UseQueryReturnValue;
 import { QueryDefinition } from "../queries/dsl";
-import { QueryOptions } from "../types";
-import { UseQueryReturnValue } from "../types";

package/types/hooks/useQueryAll.d.ts

@@ -3,10 +3,8 @@ export default useQueryAll;
  * Fetches a queryDefinition and run fetchMore on the query until the query is fully loaded
  *
  * @param {QueryDefinition} queryDefinition - Definition created with Q()
- * @param {QueryOptions} options - Options created with Q()
- * @returns {UseQueryReturnValue}
+ * @param {import("../types").QueryOptions} options - Options created with Q()
+ * @returns {import("../types").UseQueryReturnValue}
  */
-declare function useQueryAll(queryDefinition: QueryDefinition, options: QueryOptions): UseQueryReturnValue;
+declare function useQueryAll(queryDefinition: QueryDefinition, options: import("../types").QueryOptions): import("../types").UseQueryReturnValue;
 import { QueryDefinition } from "../queries/dsl";
-import { QueryOptions } from "../types";
-import { UseQueryReturnValue } from "../types";

package/types/models/dacc.d.ts

@@ -1,8 +1,8 @@
 export function isCorrectDateFormat(date: string): boolean;
-export function checkMeasureParams(measure: DACCMeasure): void;
-export function sendMeasureToDACC(client: CozyClient, remoteDoctype: string, measure: DACCMeasure): Promise<void>;
-export function buildAggregateParams(params: Params): DACCAggregatesParams;
-export function fetchAggregatesFromDACC(client: CozyClient, remoteDoctype: string, params: DACCAggregatesParams): Promise<DACCAggregatesResponse>;
+export function checkMeasureParams(measure: import("../types").DACCMeasure): void;
+export function sendMeasureToDACC(client: CozyClient, remoteDoctype: string, measure: import("../types").DACCMeasure): Promise<void>;
+export function buildAggregateParams(params: Params): import("../types").DACCAggregatesParams;
+export function fetchAggregatesFromDACC(client: CozyClient, remoteDoctype: string, params: import("../types").DACCAggregatesParams): Promise<import("../types").DACCAggregatesResponse>;
 /**
  * - The unformatted DACC aggregate params
  */
@@ -20,7 +20,4 @@ export type Params = {
      */
     endDate?: string;
 };
-import { DACCMeasure } from "../types";
 import CozyClient from "../CozyClient";
-import { DACCAggregatesParams } from "../types";
-import { DACCAggregatesResponse } from "../types";

package/types/models/document/documentTypeData.d.ts

@@ -1,5 +1,4 @@
 /**
- * @type {ThemesList}
+ * @type {import("../../types").ThemesList}
  */
-export const themesList: ThemesList;
-import { ThemesList } from "../../types";
+export const themesList: import("../../types").ThemesList;

package/types/models/document/documentTypeDataHelpers.d.ts

@@ -1,3 +1 @@
-export function getThemeByItem(item: QualificationAttributes): Theme | undefined;
-import { QualificationAttributes } from "../../types";
-import { Theme } from "../../types";
+export function getThemeByItem(item: import("../../types").QualificationAttributes): import("../../types").Theme | undefined;

package/types/models/file.d.ts

@@ -25,25 +25,25 @@ export function ensureFilePath(file: object, parent: object): object;
  */
 export function getParentFolderId(file: object): string | null;
 export const ALBUMS_DOCTYPE: "io.cozy.photos.albums";
-export function splitFilename(file: IOCozyFile): object;
-export function isFile(file: IOCozyFile): boolean;
-export function isDirectory(file: IOCozyFile): boolean;
-export function isNote(file: IOCozyFile): boolean;
-export function isEncrypted(file: IOCozyFile): boolean;
-export function isOnlyOfficeFile(file: IOCozyFile): boolean;
-export function shouldBeOpenedByOnlyOffice(file: IOCozyFile): boolean;
-export function isShortcut(file: IOCozyFile): boolean;
-export function getSharingShortcutStatus(file: IOCozyFile): string;
-export function getSharingShortcutTargetMime(file: IOCozyFile): string;
-export function getSharingShortcutTargetDoctype(file: IOCozyFile): string;
-export function isSharingShortcut(file: IOCozyFile): boolean;
-export function isSharingShorcut(file: IOCozyFile): boolean;
-export function isSharingShortcutNew(file: IOCozyFile): boolean;
+export function splitFilename(file: import("../types").IOCozyFile): object;
+export function isFile(file: import("../types").IOCozyFile): boolean;
+export function isDirectory(file: import("../types").IOCozyFile): boolean;
+export function isNote(file: import("../types").IOCozyFile): boolean;
+export function isEncrypted(file: import("../types").IOCozyFile): boolean;
+export function isOnlyOfficeFile(file: import("../types").IOCozyFile): boolean;
+export function shouldBeOpenedByOnlyOffice(file: import("../types").IOCozyFile): boolean;
+export function isShortcut(file: import("../types").IOCozyFile): boolean;
+export function getSharingShortcutStatus(file: import("../types").IOCozyFile): string;
+export function getSharingShortcutTargetMime(file: import("../types").IOCozyFile): string;
+export function getSharingShortcutTargetDoctype(file: import("../types").IOCozyFile): string;
+export function isSharingShortcut(file: import("../types").IOCozyFile): boolean;
+export function isSharingShorcut(file: import("../types").IOCozyFile): boolean;
+export function isSharingShortcutNew(file: import("../types").IOCozyFile): boolean;
 export function isSharingShorcutNew(file: object): boolean;
-export function saveFileQualification(client: CozyClient, file: IOCozyFile, qualification: object): Promise<IOCozyFile>;
-export function fetchFilesByQualificationRules(client: object, docRules: object): Promise<QueryResult>;
+export function saveFileQualification(client: CozyClient, file: import("../types").IOCozyFile, qualification: object): Promise<import("../types").IOCozyFile>;
+export function fetchFilesByQualificationRules(client: object, docRules: object): Promise<import("../types").QueryResult>;
 export function hasMetadataAttribute({ file, attribute }: {
-    file: IOCozyFile;
+    file: import("../types").IOCozyFile;
     attribute: string;
 }): boolean;
 export function getFullpath(client: CozyClient, dirId: string, name: string): Promise<string>;
@@ -51,16 +51,16 @@ export function move(client: CozyClient, fileId: string, destination: {
     folderId: string;
     path: string;
 }, force?: boolean): Promise<any>;
-export function overrideFileForPath(client: CozyClient, dirPath: string, file: object, metadata: object): Promise<IOCozyFile>;
+export function overrideFileForPath(client: CozyClient, dirPath: string, file: object, metadata: object): Promise<import("../types").IOCozyFile>;
 export function generateNewFileNameOnConflict(filenameWithoutExtension: string): string;
-export function generateFileNameForRevision(file: IOCozyFile, revision: object, f: Function): string;
+export function generateFileNameForRevision(file: import("../types").IOCozyFile, revision: object, f: Function): string;
 export function uploadFileWithConflictStrategy(client: CozyClient, file: string | ArrayBuffer, options: FileUploadOptions): any;
 export function readMobileFile(fileURL: string): Promise<any>;
 export function doMobileUpload(client: CozyClient, fileURL: string, options: FileUploadOptions): Promise<any>;
 export function isPlainText(mimeType?: string, fileName?: string): boolean;
-export function hasQualifications(file: IOCozyFile): boolean;
-export function hasCertifications(file: IOCozyFile): boolean;
-export function isFromKonnector(file: IOCozyFile): boolean;
+export function hasQualifications(file: import("../types").IOCozyFile): boolean;
+export function hasCertifications(file: import("../types").IOCozyFile): boolean;
+export function isFromKonnector(file: import("../types").IOCozyFile): boolean;
 export function fetchBlobFileById(client: CozyClient, fileId: string): Promise<Blob>;
 export type FileUploadOptions = {
     /**
@@ -84,6 +84,4 @@ export type FileUploadOptions = {
      */
     conflictStrategy?: string;
 };
-import { IOCozyFile } from "../types";
 import CozyClient from "../CozyClient";
-import { QueryResult } from "../types";

package/types/models/folder.d.ts

@@ -8,9 +8,7 @@ export namespace MAGIC_FOLDERS {
     const PAPERS: string;
     const COACH_CO2: string;
 }
-export function ensureMagicFolder(client: CozyClient, id: string, path: string): Promise<IOCozyFolder>;
-export function createFolderWithReference(client: CozyClient, path: string, document: CozyClientDocument): Promise<IOCozyFolder>;
-export function getReferencedFolder(client: CozyClient, document: CozyClientDocument): Promise<IOCozyFolder>;
+export function ensureMagicFolder(client: CozyClient, id: string, path: string): Promise<import("../types").IOCozyFolder>;
+export function createFolderWithReference(client: CozyClient, path: string, document: import("../types").CozyClientDocument): Promise<import("../types").IOCozyFolder>;
+export function getReferencedFolder(client: CozyClient, document: import("../types").CozyClientDocument): Promise<import("../types").IOCozyFolder>;
 import CozyClient from "../CozyClient";
-import { IOCozyFolder } from "../types";
-import { CozyClientDocument } from "../types";

package/types/queries/dsl.d.ts

@@ -1,4 +1,4 @@
-export function Q(doctype: Doctype): QueryDefinition;
+export function Q(doctype: import('../types').Doctype): QueryDefinition;
 export function isAGetByIdQuery(queryDefinition: QueryDefinition): boolean;
 export function createDocument(document: any): {
     mutationType: string;
@@ -73,7 +73,6 @@ export type PartialQueryDefinition = {
 };
 export type MangoSelector = any;
 export type MangoPartialFilter = any;
-import { Doctype } from "../types";
 /**
  * @typedef PartialQueryDefinition
  *
@@ -100,9 +99,9 @@ export class QueryDefinition {
      * @class
      *
      * @param {object} options Initial options for the query definition
-     * @param {Doctype} [options.doctype] - The doctype of the doc.
-     * @param {DocId|null} [options.id] - The id of the doc.
-     * @param {Array<DocId>} [options.ids] - The ids of the docs.
+     * @param  {import('../types').Doctype} [options.doctype] - The doctype of the doc.
+     * @param {import('../types').DocId|null} [options.id] - The id of the doc.
+     * @param {Array<import('../types').DocId>} [options.ids] - The ids of the docs.
      * @param {MangoSelector} [options.selector] - The selector to query the docs.
      * @param {Array<string>} [options.fields] - The fields to return.
      * @param {Array<string>} [options.indexedFields] - The fields to index.
@@ -112,13 +111,13 @@ export class QueryDefinition {
      * @param {string|null} [options.referenced] - The referenced document.
      * @param {number|null} [options.limit] - The document's limit to return.
      * @param {number|null} [options.skip] - The number of docs to skip.
-     * @param {CouchDBViewCursor} [options.cursor] - The cursor to paginate views.
+     * @param {import('../types').CouchDBViewCursor} [options.cursor] - The cursor to paginate views.
      * @param {string} [options.bookmark] - The bookmark to paginate mango queries.
      */
     constructor(options?: {
-        doctype: Doctype;
-        id: DocId | null;
-        ids: Array<DocId>;
+        doctype: import('../types').Doctype;
+        id: import('../types').DocId | null;
+        ids: Array<import('../types').DocId>;
         selector: MangoSelector;
         fields: Array<string>;
         indexedFields: Array<string>;
@@ -128,7 +127,7 @@ export class QueryDefinition {
         referenced: string | null;
         limit: number | null;
         skip: number | null;
-        cursor: CouchDBViewCursor;
+        cursor: import('../types').CouchDBViewCursor;
         bookmark: string;
     });
     doctype: string;
@@ -143,7 +142,7 @@ export class QueryDefinition {
     referenced: string;
     limit: number;
     skip: number;
-    cursor: CouchDBViewCursor;
+    cursor: import("../types").CouchDBViewCursor;
     bookmark: string;
     /**
      * Checks if the sort order matches the index' fields order.
@@ -259,10 +258,10 @@ export class QueryDefinition {
      * the starting document of the query, e.g. "file-id".
      * Use the last docid of each query as startkey_docid to paginate or leave blank for the first query.
      *
-     * @param {CouchDBViewCursor} cursor The cursor for pagination.
+     * @param {import('../types').CouchDBViewCursor} cursor The cursor for pagination.
      * @returns {QueryDefinition}  The QueryDefinition object.
      */
-    offsetCursor(cursor: CouchDBViewCursor): QueryDefinition;
+    offsetCursor(cursor: import('../types').CouchDBViewCursor): QueryDefinition;
     /**
      * Use [bookmark](https://docs.couchdb.org/en/2.2.0/api/database/find.html#pagination) pagination.
      * Note this only applies for mango-queries (not views) and is way more efficient than skip pagination.
@@ -293,7 +292,7 @@ export class QueryDefinition {
         referenced: string;
         limit: number;
         skip: number;
-        cursor: CouchDBViewCursor;
+        cursor: import("../types").CouchDBViewCursor;
         bookmark: string;
     };
 }
@@ -306,6 +305,4 @@ declare const REMOVE_REFERENCES_TO: "REMOVE_REFERENCES_TO";
 declare const ADD_REFERENCED_BY: "ADD_REFERENCED_BY";
 declare const REMOVE_REFERENCED_BY: "REMOVE_REFERENCED_BY";
 declare const UPLOAD_FILE: "UPLOAD_FILE";
-import { CouchDBViewCursor } from "../types";
-import { DocId } from "../types";
 export {};

package/types/store/documents.d.ts

@@ -1,7 +1,6 @@
-export function mergeDocumentsWithRelationships(prevDocument?: {}, nextDocument?: {}): CozyClientDocument;
+export function mergeDocumentsWithRelationships(prevDocument?: {}, nextDocument?: {}): import("../types").CozyClientDocument;
 export default documents;
 export function getDocumentFromSlice(state: {}, doctype: any, id: any): any;
 export function getCollectionFromSlice(state: {}, doctype: any): any[];
 export function extractAndMergeDocument(data: any, updatedStateWithIncluded: any): any;
-import { CozyClientDocument } from "../types";
 declare function documents(state: {}, action: any): any;

package/types/store/queries.d.ts

@@ -1,18 +1,18 @@
 export function isQueryAction(action: any): boolean;
 export function isReceivingData(action: any): boolean;
-export function sortAndLimitDocsIds(queryState: QueryState, documents: DocumentsStateSlice, ids: Array<string>, { count, fetchedPagesCount }: {
+export function sortAndLimitDocsIds(queryState: import("../types").QueryState, documents: import("../types").DocumentsStateSlice, ids: Array<string>, { count, fetchedPagesCount }: {
     count: number;
     fetchedPagesCount: number;
 }): Array<string>;
 export function convert$gtNullSelectors(selector: any): object;
 export function mergeSelectorAndPartialIndex(queryDefinition: object): object;
-export function makeSorterFromDefinition(definition: QueryDefinition): (arg0: Array<CozyClientDocument>) => Array<CozyClientDocument>;
-export function updateData(query: QueryState, newData: Array<CozyClientDocument>, documents: DocumentsStateSlice): QueryState;
+export function makeSorterFromDefinition(definition: QueryDefinition): (arg0: Array<import("../types").CozyClientDocument>) => Array<import("../types").CozyClientDocument>;
+export function updateData(query: import("../types").QueryState, newData: Array<import("../types").CozyClientDocument>, documents: import("../types").DocumentsStateSlice): import("../types").QueryState;
 export default queries;
-export function initQuery(queryId: string, queryDefinition: QueryDefinition, options?: QueryOptions): object;
-export function loadQuery(queryId: string, options?: QueryOptions): object;
-export function receiveQueryResult(queryId: string, response: object, options?: QueryOptions): object;
-export function receiveQueryError(queryId: string, error: object, options?: QueryOptions): object;
+export function initQuery(queryId: string, queryDefinition: QueryDefinition, options?: import("../types").QueryOptions): object;
+export function loadQuery(queryId: string, options?: import("../types").QueryOptions): object;
+export function receiveQueryResult(queryId: string, response: object, options?: import("../types").QueryOptions): object;
+export function receiveQueryError(queryId: string, error: object, options?: import("../types").QueryOptions): object;
 export function getQueryFromSlice(state: any, queryId: any, documents: any): any;
 export class QueryIDGenerator {
     idCounter: number;
@@ -35,17 +35,12 @@ export class QueryIDGenerator {
 export namespace QueryIDGenerator {
     const UNNAMED: string;
 }
-import { QueryState } from "../types";
-import { DocumentsStateSlice } from "../types";
 import { QueryDefinition } from "../queries/dsl";
-import { CozyClientDocument } from "../types";
 /**
- * @param  {QueriesStateSlice}  state - Redux slice containing all the query states indexed by name
+ * @param  {import("../types").QueriesStateSlice}  state - Redux slice containing all the query states indexed by name
  * @param  {object}  action - Income redux action
- * @param  {DocumentsStateSlice}  documents - Reference to documents slice
+ * @param  {import("../types").DocumentsStateSlice}  documents - Reference to documents slice
  * @param  {boolean} haveDocumentsChanged - Has the document slice changed with current action
- * @returns {QueriesStateSlice}
+ * @returns {import("../types").QueriesStateSlice}
  */
-declare function queries(state: QueriesStateSlice, action: object, documents?: DocumentsStateSlice, haveDocumentsChanged?: boolean): QueriesStateSlice;
-import { QueryOptions } from "../types";
-import { QueriesStateSlice } from "../types";
+declare function queries(state: import("../types").QueriesStateSlice, action: object, documents?: import("../types").DocumentsStateSlice, haveDocumentsChanged?: boolean): import("../types").QueriesStateSlice;