jamespot-user-api 1.0.188 → 1.0.189

package/lib/src/apis/drive/drive.d.ts

@@ -1,25 +1,42 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, DriveAccount, DriveGetAccount, DriveGetAccountParams, DriveGetDocumentParams, DriveGetDocumentsParams, DriveGetGroupsParams, DriveGetTenantsParams, DriveLogoutParams, DriveSetDefaultAccountParams, FormatList, jFileLittle, MSDocumentEntity, MSGroupEntity, MSSiteEntity, MSTenantEntity } from '../../types';
+import { ApiWrapper, DriveAccount, DriveGetAccount, DriveGetAccountParams, DriveGetDocumentParams, MSGetDocumentsParams, DriveGetGroupsParams, DriveGetTenantsParams, DriveLogoutParams, DriveSetDefaultAccountParams, FormatList, jFileLittle, MSDocumentEntity, MSGroupEntity, MSSiteEntity, MSTenantEntity, DropboxDocumentEntity, DropboxGetDocumentsParams } from '../../types';
 export declare class JDriveApi extends JBaseApi {
     /**
      * Microsoft graph only
      * @returns
      */
-    tenants(params?: DriveGetTenantsParams): Promise<ApiWrapper<MSTenantEntity[]>>;
+    tenants(params?: DriveGetTenantsParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<MSTenantEntity[]>>;
     /**
      * Microsoft graph only
      * @returns
      */
-    groups(params: DriveGetGroupsParams): Promise<ApiWrapper<MSGroupEntity[]>>;
+    groups(params: DriveGetGroupsParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<MSGroupEntity[]>>;
     /**
      * Microsoft graph only
      * @returns
      */
-    sites(): Promise<ApiWrapper<MSSiteEntity[]>>;
-    listAccount(service: string): Promise<ApiWrapper<DriveAccount[]>>;
-    isAccountLogged(service: string, id: string): Promise<ApiWrapper<boolean>>;
-    checkAccountToken(service: string): Promise<ApiWrapper<boolean>>;
-    documents(params: DriveGetDocumentsParams): Promise<ApiWrapper<MSDocumentEntity[]>>;
+    sites(options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<MSSiteEntity[]>>;
+    listAccount(service: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<DriveAccount[]>>;
+    isAccountLogged(service: string, id: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<boolean>>;
+    checkAccountToken(service: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<boolean>>;
+    msDocuments(params: MSGetDocumentsParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<MSDocumentEntity[]>>;
+    dropboxDocuments(params: DropboxGetDocumentsParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<DropboxDocumentEntity[]>>;
     getDocument<T extends jFileLittle = jFileLittle>(params: DriveGetDocumentParams, options?: {
         signal?: AbortSignal;
         format?: FormatList;

package/lib/src/apis/drive/drive.mock.d.ts

@@ -1,7 +1,7 @@
 import { ApiWrapper, BaseMessages, DriveGetAccount, DriveItemType, jFileLittle, MSGroupEntity, MSTenantEntity } from '../../types';
 export declare const driveGetTenants: ApiWrapper<MSTenantEntity[], BaseMessages>;
 export declare const driveGetGroups: ApiWrapper<MSGroupEntity[], BaseMessages>;
-export declare const driveGetDocuments: ApiWrapper<DriveItemType[], BaseMessages>;
+export declare const driveMsDocuments: ApiWrapper<DriveItemType[], BaseMessages>;
 export declare const driveGetDocument: ApiWrapper<jFileLittle>;
 export declare const driveLogout: ApiWrapper<boolean>;
 export declare const driveGetAccount: ApiWrapper<DriveGetAccount>;

package/lib/src/apis/file/file.d.ts

@@ -23,9 +23,7 @@ export declare class JFileApi extends JBaseApi {
     }>;
     /**
      * Upload a list of files to the server. use the same token to link the file to an article
-     * @param attrName file name (attachment, image, bannerImage, etc.)
-     * @param files files
-     * @param token token
+     * @param configArray
      */
     uploadMany(configArray: Array<UploadConfig>): Promise<{
         response: ApiWrapper<{
@@ -43,9 +41,15 @@ export declare class JFileApi extends JBaseApi {
         }, import("../../types").BaseMessages>;
         token: string;
     }[]>;
-    get<T extends jFileLittle>(idFile: number, format?: FormatList): Promise<ApiWrapper<T>>;
-    getParent<T extends jObjectLittle>(idFile: number, format?: FormatList): Promise<ApiWrapper<T>>;
-    getWithHash<T extends jFileLittle>(idFile: number, hash: string, format?: FormatList): Promise<ApiWrapper<T>>;
+    get<T extends jFileLittle>(idFile: number, format?: FormatList, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<T>>;
+    getParent<T extends jObjectLittle>(idFile: number, format?: FormatList, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<T>>;
+    getWithHash<T extends jFileLittle>(idFile: number, hash: string, format?: FormatList, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<T>>;
     duplicate(idFile: number, title: string, publishTo?: string[]): Promise<ApiWrapper<{
         idFile: number;
         article: jObjectLittle;
@@ -53,10 +57,15 @@ export declare class JFileApi extends JBaseApi {
     updateFile(idFile: number, title: string): Promise<ApiWrapper<boolean>>;
     /**
      * Crop an image
+     * @param idFile
+     * @param type
      * @param config crop configuration
+     * @param options
      * @returns
      */
-    update(idFile: number | string, type: string, config: FileCropConfig): Promise<ApiWrapper<{
+    update(idFile: number | string, type: string, config: FileCropConfig, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<{
         type: string;
         id: number;
         mainType: string;
@@ -84,6 +93,7 @@ export declare class JFileApi extends JBaseApi {
      * @param idFile file id
      * @param attrName attribute name
      * @param token token
+     * @param signal
      * @returns
      */
     deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<ApiWrapper<boolean, import("../../types").BaseMessages>>;
@@ -91,16 +101,23 @@ export declare class JFileApi extends JBaseApi {
      * delete the image associated with a content. This action is permanent. There is no two step process with a token
      * @param id content id
      * @param type content type
+     * @param options
      * @returns
      */
-    deleteImage(id: number | string, type: string): Promise<ApiWrapper<{
+    deleteImage(id: number | string, type: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<{
         id: number;
     }, import("../../types").BaseMessages>>;
-    getDownload(id: number): Promise<ApiWrapper<{
+    getDownload(id: number, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<{
         count: number;
         list: UserDownload[];
     }>>;
-    generatePreview(id: number): Promise<ApiWrapper<boolean>>;
+    generatePreview(id: number, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApiWrapper<boolean>>;
     copy<T extends jFileLittle = jFileLittle>(params: FileCopyParams, options?: {
         format?: FormatList;
         signal?: AbortSignal;

package/lib/src/types/drive.d.ts

@@ -1,24 +1,20 @@
 import { z } from 'zod';
 export declare const msTenantsSchema: z.ZodUnion<[z.ZodLiteral<"groups">, z.ZodLiteral<"sites">, z.ZodLiteral<"onedrive">, z.ZodLiteral<"group">, z.ZodLiteral<"documents">, z.ZodLiteral<"me">]>;
 export type MSTenants = z.infer<typeof msTenantsSchema>;
-export declare const msBaseEntitySchema: z.ZodObject<{
-    title: z.ZodString;
-    id: z.ZodString;
-    type: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: string;
-    id: string;
+export type BaseEntity = {
     title: string;
-}, {
-    type: string;
     id: string;
-    title: string;
-}>;
-export type MSBaseEntity = z.infer<typeof msBaseEntitySchema>;
+    type: string;
+};
+export declare const baseEntitySchema: z.ZodObject<{
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
+}, "strip", z.ZodTypeAny, BaseEntity, BaseEntity>;
 export declare const msTenantEntitySchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
-    title: z.ZodString;
-    id: z.ZodString;
-    type: z.ZodString;
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
 }, "id">, {
     name: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"groups">, z.ZodLiteral<"sites">, z.ZodLiteral<"onedrive">, z.ZodLiteral<"group">, z.ZodLiteral<"documents">, z.ZodLiteral<"me">]>>;
 }>, "strip", z.ZodTypeAny, {
@@ -32,41 +28,57 @@ export declare const msTenantEntitySchema: z.ZodObject<z.objectUtil.extendShape<
 }>;
 export type MSTenantEntity = z.infer<typeof msTenantEntitySchema>;
 export declare const msSiteEntitySchema: z.ZodIntersection<z.ZodObject<{
-    title: z.ZodString;
-    id: z.ZodString;
-    type: z.ZodString;
-}, "strip", z.ZodTypeAny, {
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
+}, "strip", z.ZodTypeAny, BaseEntity, BaseEntity>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+export type MSSiteEntity = z.infer<typeof msSiteEntitySchema>;
+export declare const msGroupEntitySchema: z.ZodObject<z.objectUtil.extendShape<{
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
+}, {
+    visibility: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"public">, z.ZodLiteral<"private">]>>;
+}>, "strip", z.ZodTypeAny, {
     type: string;
     id: string;
     title: string;
+    visibility?: "public" | "private" | undefined;
 }, {
     type: string;
     id: string;
     title: string;
-}>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
-export type MSSiteEntity = z.infer<typeof msSiteEntitySchema>;
-export declare const msGroupEntitySchema: z.ZodObject<z.objectUtil.extendShape<{
-    title: z.ZodString;
-    id: z.ZodString;
-    type: z.ZodString;
+    visibility?: "public" | "private" | undefined;
+}>;
+export type MSGroupEntity = z.infer<typeof msGroupEntitySchema>;
+export declare const documentEntitySchema: z.ZodObject<z.objectUtil.extendShape<{
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
 }, {
-    visibility: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"public">, z.ZodLiteral<"private">]>>;
+    mimetype: z.ZodOptional<z.ZodString>;
+    webUrl: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodNumber>;
 }>, "strip", z.ZodTypeAny, {
     type: string;
     id: string;
     title: string;
-    visibility?: "public" | "private" | undefined;
+    mimetype?: string | undefined;
+    size?: number | undefined;
+    webUrl?: string | undefined;
 }, {
     type: string;
     id: string;
     title: string;
-    visibility?: "public" | "private" | undefined;
+    mimetype?: string | undefined;
+    size?: number | undefined;
+    webUrl?: string | undefined;
 }>;
-export type MSGroupEntity = z.infer<typeof msGroupEntitySchema>;
+export type DocumentEntity = z.infer<typeof documentEntitySchema>;
 export declare const msDocumentEntitySchema: z.ZodObject<z.objectUtil.extendShape<{
-    title: z.ZodString;
-    id: z.ZodString;
-    type: z.ZodString;
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
 }, {
     mimetype: z.ZodOptional<z.ZodString>;
     webUrl: z.ZodOptional<z.ZodString>;
@@ -87,10 +99,48 @@ export declare const msDocumentEntitySchema: z.ZodObject<z.objectUtil.extendShap
     webUrl?: string | undefined;
 }>;
 export type MSDocumentEntity = z.infer<typeof msDocumentEntitySchema>;
+export declare const dropboxDocumentEntitySchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
+}, {
+    mimetype: z.ZodOptional<z.ZodString>;
+    webUrl: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodNumber>;
+}>, {
+    _extend: z.ZodObject<{
+        path: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+    }, {
+        path: string;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: string;
+    id: string;
+    title: string;
+    _extend: {
+        path: string;
+    };
+    mimetype?: string | undefined;
+    size?: number | undefined;
+    webUrl?: string | undefined;
+}, {
+    type: string;
+    id: string;
+    title: string;
+    _extend: {
+        path: string;
+    };
+    mimetype?: string | undefined;
+    size?: number | undefined;
+    webUrl?: string | undefined;
+}>;
+export type DropboxDocumentEntity = z.infer<typeof dropboxDocumentEntitySchema>;
 export declare const msUnifiedEntitySchema: z.ZodIntersection<z.ZodObject<z.objectUtil.extendShape<{
-    title: z.ZodString;
-    id: z.ZodString;
-    type: z.ZodString;
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
 }, {
     visibility: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"public">, z.ZodLiteral<"private">]>>;
 }>, "strip", z.ZodTypeAny, {
@@ -104,9 +154,9 @@ export declare const msUnifiedEntitySchema: z.ZodIntersection<z.ZodObject<z.obje
     title: string;
     visibility?: "public" | "private" | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    title: z.ZodString;
-    id: z.ZodString;
-    type: z.ZodString;
+    title: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    type: z.ZodType<string, z.ZodTypeDef, string>;
 }, {
     mimetype: z.ZodOptional<z.ZodString>;
     webUrl: z.ZodOptional<z.ZodString>;
@@ -164,7 +214,7 @@ export declare const driveItemTypeSchema: z.ZodObject<{
     webUrl?: string | undefined;
 }>;
 export type DriveItemType = z.infer<typeof driveItemTypeSchema>;
-export declare const driveDocumentParamsSchema: z.ZodObject<{
+export declare const msDocumentParamsSchema: z.ZodObject<{
     msTenant: z.ZodUnion<[z.ZodUnion<[z.ZodLiteral<"groups">, z.ZodLiteral<"sites">, z.ZodLiteral<"onedrive">, z.ZodLiteral<"group">, z.ZodLiteral<"documents">, z.ZodLiteral<"me">]>, z.ZodUndefined]>;
     msId: z.ZodUnion<[z.ZodString, z.ZodUndefined]>;
     idFolder: z.ZodUnion<[z.ZodString, z.ZodUndefined]>;
@@ -186,7 +236,18 @@ export declare const driveDocumentParamsSchema: z.ZodObject<{
     msId?: string | undefined;
     idFolder?: string | undefined;
 }>;
-export type DriveDocumentParams = z.infer<typeof driveDocumentParamsSchema>;
+export type MSDocumentParams = z.infer<typeof msDocumentParamsSchema>;
+export declare const dropboxDocumentParamsSchema: z.ZodObject<{
+    path_lower: z.ZodString;
+    query: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    path_lower: string;
+    query?: string | null | undefined;
+}, {
+    path_lower: string;
+    query?: string | null | undefined;
+}>;
+export type DropboxDocumentParams = z.infer<typeof dropboxDocumentParamsSchema>;
 export declare const driveTmpFileSchema: z.ZodObject<{
     id: z.ZodNumber;
     name: z.ZodString;
@@ -219,9 +280,9 @@ export declare const driveGetDocumentParamsSchema: z.ZodObject<{
         title: z.ZodString;
         mimetype: z.ZodOptional<z.ZodString>;
         _document: z.ZodObject<z.objectUtil.extendShape<{
-            title: z.ZodString;
-            id: z.ZodString;
-            type: z.ZodString;
+            title: z.ZodType<string, z.ZodTypeDef, string>;
+            id: z.ZodType<string, z.ZodTypeDef, string>;
+            type: z.ZodType<string, z.ZodTypeDef, string>;
         }, {
             mimetype: z.ZodOptional<z.ZodString>;
             webUrl: z.ZodOptional<z.ZodString>;
@@ -381,8 +442,7 @@ export declare const driveGetTenantsParamsSchema: z.ZodObject<{
     allow?: ("groups" | "me")[] | undefined;
 }>;
 export type DriveGetTenantsParams = z.infer<typeof driveGetTenantsParamsSchema>;
-export declare const driveGetDocumentsParamsSchema: z.ZodObject<{
-    service: z.ZodString;
+export declare const msGetDocumentsParamsSchema: z.ZodObject<{
     id: z.ZodString;
     documentParams: z.ZodObject<{
         msTenant: z.ZodUnion<[z.ZodUnion<[z.ZodLiteral<"groups">, z.ZodLiteral<"sites">, z.ZodLiteral<"onedrive">, z.ZodLiteral<"group">, z.ZodLiteral<"documents">, z.ZodLiteral<"me">]>, z.ZodUndefined]>;
@@ -408,7 +468,6 @@ export declare const driveGetDocumentsParamsSchema: z.ZodObject<{
     }>;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    service: string;
     documentParams: {
         limit: number;
         page: number;
@@ -419,7 +478,6 @@ export declare const driveGetDocumentsParamsSchema: z.ZodObject<{
     };
 }, {
     id: string;
-    service: string;
     documentParams: {
         limit: number;
         page: number;
@@ -429,7 +487,33 @@ export declare const driveGetDocumentsParamsSchema: z.ZodObject<{
         idFolder?: string | undefined;
     };
 }>;
-export type DriveGetDocumentsParams = z.infer<typeof driveGetDocumentsParamsSchema>;
+export type MSGetDocumentsParams = z.infer<typeof msGetDocumentsParamsSchema>;
+export declare const dropboxGetDocumentsParamsSchema: z.ZodObject<{
+    id: z.ZodString;
+    documentParams: z.ZodObject<{
+        path_lower: z.ZodString;
+        query: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        path_lower: string;
+        query?: string | null | undefined;
+    }, {
+        path_lower: string;
+        query?: string | null | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    documentParams: {
+        path_lower: string;
+        query?: string | null | undefined;
+    };
+}, {
+    id: string;
+    documentParams: {
+        path_lower: string;
+        query?: string | null | undefined;
+    };
+}>;
+export type DropboxGetDocumentsParams = z.infer<typeof dropboxGetDocumentsParamsSchema>;
 export declare const driveGetGroupsParamsSchema: z.ZodObject<{
     query: z.ZodOptional<z.ZodString>;
     filter: z.ZodOptional<z.ZodString>;

package/lib/src/types/uri.d.ts

@@ -15,7 +15,7 @@ export declare const typeIdSchema: z.ZodObject<{
     recordId: string | number;
 }>;
 export type TypeId = z.infer<typeof typeIdSchema>;
-export declare const ensureTypeId: (o: unknown) => o is {
+export declare const ensureTypeId: (o: unknown, passThrough?: boolean) => o is {
     type: string;
     recordId: string | number;
 };
@@ -30,7 +30,7 @@ export declare const uriSchema: z.ZodObject<{
     uri: string;
 }>;
 export type Uri = z.infer<typeof uriSchema>;
-export declare const ensureUri: (o: unknown) => o is {
+export declare const ensureUri: (o: unknown, passThrough?: boolean) => o is {
     uri: string;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jamespot-user-api",
-  "version": "1.0.188",
+  "version": "1.0.189",
   "main": "lib/jamespot-user-api.js",
   "types": "lib/src/index.d.ts",
   "directories": {