jamespot-user-api 1.0.113 → 1.0.114

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

@@ -1,24 +1,25 @@
-import { FileCropConfig, FileResponse, UploadConfig } from '../types';
+import { ApiWrapper, FileCropConfig, FileResponse, JFileExtended, UploadConfig } from '../types';
 import { JBaseApi } from './base';
 export declare class JFileApi extends JBaseApi {
     /**
      * Upload a file to the server. use the same token to link the file to an article
      * @param config configuration object. One of "file" and "url" is mandatory
      */
-    upload(config: UploadConfig): Promise<import("../types").ApiWrapper<FileResponse, import("../types").BaseMessages>>;
+    upload(config: UploadConfig): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages>>;
     /**
      * 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
      */
-    uploadMany(configArray: Array<UploadConfig>): Promise<import("../types").ApiWrapper<FileResponse, import("../types").BaseMessages>[]>;
+    uploadMany(configArray: Array<UploadConfig>): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages>[]>;
+    get<T extends JFileExtended>(idFile: number, format?: string): Promise<ApiWrapper<T>>;
     /**
      * Crop an image
      * @param config crop configuration
      * @returns
      */
-    update(idFile: number | string, type: string, config: FileCropConfig): Promise<import("../types").ApiWrapper<FileResponse, import("../types").BaseMessages> | {
+    update(idFile: number | string, type: string, config: FileCropConfig): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages> | {
         result: {
             crop: {
                 width: any;
@@ -28,6 +29,10 @@ export declare class JFileApi extends JBaseApi {
                 rotation: any;
             };
             id: string;
+            /**
+             * Upload a file to the server. use the same token to link the file to an article
+             * @param config configuration object. One of "file" and "url" is mandatory
+             */
             name: string;
             type: string;
             token?: string;
@@ -51,14 +56,14 @@ export declare class JFileApi extends JBaseApi {
      * @param token token
      * @returns
      */
-    deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<import("../types").ApiWrapper<"", import("../types").BaseMessages>>;
+    deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<ApiWrapper<"", import("../types").BaseMessages>>;
     /**
      * 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
      * @returns
      */
-    deleteImage(id: number | string, type: string): Promise<import("../types").ApiWrapper<{
+    deleteImage(id: number | string, type: string): Promise<ApiWrapper<{
         id: number;
     }, import("../types").BaseMessages>>;
 }

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

@@ -33,3 +33,14 @@ export declare type jFileLittle = Readable<Omit<jObjectLittle, 'dateModified'> &
     dateCreation: string;
     dateModified: string | null;
 }>;
+export declare type jFileRendition = {
+    name: string;
+    filename: string;
+    dateModified: string;
+    mimetype: string;
+};
+export declare type JFileExtended = jFileLittle & {
+    meta?: string;
+    _renditions: string[];
+    _renditionsData: Record<string, jFileRendition>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jamespot-user-api",
-    "version": "1.0.113",
+    "version": "1.0.114",
     "scripts": {
         "build": "npx webpack --env NODE_ENV=production",
         "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",