totalum-api-sdk 1.0.6 → 1.0.7

package/index.js

@@ -49,6 +49,18 @@ const endpoints = {
         deleteObjectAndSubElements: 'api/v1/crud/:typeId/:id/:pageId/subelements',
         updateLastUsersActions: 'api/v1/crud/:typeId/:id/lastUsersActions'
     },
+    files: {
+        uploadFile: 'api/v1/files/upload',
+        getDownloadUrl: 'api/v1/files/download/:fileName',
+        deleteFile: 'api/v1/files/:fileName',
+    },
+    filter: {
+        lookUpFilter: 'api/v1/filter/:idPage',
+        customMongoFilter: 'api/v1/filter/custom-mongo-filter'
+    },
+    pdfTemplate: {
+        generatePdfByTemplate: 'api/v1/pdf-template/generatePdfByTemplate/:id'
+    },
 };
 class TotalumApiSdk {
     constructor(authOptions) {
@@ -106,16 +118,41 @@ class TotalumApiSdk {
             return axios_1.default.post(url, item, { headers: this.headers });
         });
     }
-    /**
-     *
-     * @param customMongoFilter an string with the mongo filter query
-     * @param rootTypeId an string with the id of the element that we make the aggregation query
-     * @param typeIdToGet the id of the type that we want to get
-     * @param options
-     * @param returnCount
-     */
-    customMongoFilter(customMongoFilter, rootTypeId, typeIdToGet, options, returnCount) {
+    generatePdfByTemplate(id, variables, name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.getUrl(endpoints.pdfTemplate.generatePdfByTemplate, { id });
+            return axios_1.default.post(url, { templateId: id, variables, name }, { headers: this.headers });
+        });
+    }
+    uploadFile(fileFormData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.getUrl(endpoints.files.uploadFile);
+            return axios_1.default.post(url, fileFormData, { headers: this.headers });
+        });
+    }
+    getDownloadUrl(fileName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.getUrl(endpoints.files.getDownloadUrl, { fileName });
+            return axios_1.default.get(url, { headers: this.headers });
+        });
+    }
+    customMongoFilter(customMongoFilter, rootTypeId, typeIdToGet, options) {
         return __awaiter(this, void 0, void 0, function* () {
+            const url = this.getUrl(endpoints.filter.customMongoFilter, {});
+            const body = { sort: options === null || options === void 0 ? void 0 : options.sort, variables: options === null || options === void 0 ? void 0 : options.variables, customMongoFilter, pagination: options === null || options === void 0 ? void 0 : options.pagination, rootTypeId, typeIdToGet };
+            const params = (options === null || options === void 0 ? void 0 : options.returnCount) ? { returnCount: options === null || options === void 0 ? void 0 : options.returnCount } : null;
+            return axios_1.default.post(url, body, { params: params, headers: this.headers });
+        });
+    }
+    lookUpFilter(idPage, query, idsOfMultipleNodesToSearch, returnCount) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.getUrl(endpoints.filter.lookUpFilter, { idPage });
+            const params = {
+                query: encodeURIComponent(JSON.stringify(query)),
+                idsOfMultipleNodesToSearch: encodeURIComponent(JSON.stringify(idsOfMultipleNodesToSearch)),
+                returnCount: returnCount,
+            };
+            return axios_1.default.get(url, { params: params, headers: this.headers });
         });
     }
 }

package/index.ts

@@ -21,9 +21,9 @@ export interface FilterSearchQueryI {
 
 export type FilterLookupSearchQueryI = {
     pagination: {
-      limit?: number;
-      page?: number;
-      skip?: number;
+        limit?: number;
+        page?: number;
+        skip?: number;
     };
     filters: FilterStructureLevelsI
 };
@@ -39,12 +39,12 @@ export interface ISearchQueryFilterOr {
     or: ISearchQueryFilterOptions[]
 }
 
-export interface ISearchQuerySort{
-    [key : string]: 1 | -1
+export interface ISearchQuerySort {
+    [key: string]: 1 | -1
 }
 
 export interface ISearchQueryFilterOptions {
-    [key : string]: number | Date | boolean | string | PropertyQueryOptionsI
+    [key: string]: number | Date | boolean | string | PropertyQueryOptionsI
 }
 
 export interface PropertyQueryOptionsI {
@@ -74,7 +74,7 @@ export interface DataValues {
 }
 
 export interface DataProperties {
-    [key: string] : {
+    [key: string]: {
         value: fieldValuesEnabled,
     },
 }
@@ -91,85 +91,116 @@ const endpoints = {
         deleteObjectAndSubElements: 'api/v1/crud/:typeId/:id/:pageId/subelements',
         updateLastUsersActions: 'api/v1/crud/:typeId/:id/lastUsersActions'
     },
+    files: {
+        uploadFile: 'api/v1/files/upload',
+        getDownloadUrl: 'api/v1/files/download/:fileName',
+        deleteFile: 'api/v1/files/:fileName',
+    },
+    filter: {
+        lookUpFilter: 'api/v1/filter/:idPage',
+        customMongoFilter: 'api/v1/filter/custom-mongo-filter'
+    },
+    pdfTemplate: {
+        generatePdfByTemplate: 'api/v1/pdf-template/generatePdfByTemplate/:id'
+    },
 }
 
 export interface AuthOptions {
-    token?:{
+    token?: {
         accessToken: string
-    }, 
+    },
     apiKey?: {
-        apiKey:string,
-        apiKeyName:string,
-        organizationId:string,
+        apiKey: string,
+        apiKeyName: string,
+        organizationId: string,
     }
 }
 
 export class TotalumApiSdk {
-  public baseUrl= 'https://api.totalum.app/';
-  private authOptions: AuthOptions;
-  private headers: {[key:string]: string};
-
-  constructor(authOptions: AuthOptions) {
-    this.authOptions = authOptions;
-    if (this.authOptions.token?.accessToken){
-        this.headers = {
-            authorization: this.authOptions.token.accessToken
+    public baseUrl = 'https://api.totalum.app/';
+    private authOptions: AuthOptions;
+    private headers: { [key: string]: string };
+
+    constructor(authOptions: AuthOptions) {
+        this.authOptions = authOptions;
+        if (this.authOptions.token?.accessToken) {
+            this.headers = {
+                authorization: this.authOptions.token.accessToken
+            }
+        } else if (this.authOptions.apiKey?.apiKey && this.authOptions.apiKey?.organizationId) {
+            this.headers = {
+                'api-key': this.authOptions.apiKey.apiKey,
+                'organization-id': this.authOptions.apiKey.organizationId,
+                'api-key-name': this.authOptions.apiKey.apiKeyName
+            }
+        } else {
+            throw new Error('Error: invalid auth options')
         }
-    } else if(this.authOptions.apiKey?.apiKey && this.authOptions.apiKey?.organizationId) {
-        this.headers = {
-            'api-key': this.authOptions.apiKey.apiKey,
-            'organization-id': this.authOptions.apiKey.organizationId,
-            'api-key-name': this.authOptions.apiKey.apiKeyName
+    }
+
+    public changeBaseUrl(newBaseUrl: string) {
+        this.baseUrl = newBaseUrl;
+    }
+
+    private getUrl(pattern: string, params?: any): string {
+        let url = this.baseUrl + pattern;
+        for (const key in params) {
+            url = url.replace(`:${key}`, params[key]);
         }
-    } else {
-        throw new Error('Error: invalid auth options')
+        return url;
+    }
+
+    public async getItems(itemType: string, query?: FilterSearchQueryI) {
+        const queryString = qs.stringify(query);
+        const url = this.getUrl(endpoints.crud.getObjects, { typeId: itemType });
+        return axios.get(url, { params: queryString, headers: this.headers });
+    }
+
+    public async deleteItemById(itemType: string, id: string) {
+        const url = this.getUrl(endpoints.crud.deleteObject, { typeId: itemType, id });
+        return axios.delete(url, { headers: this.headers });
+    }
+
+    public async editItemById(itemType: string, id: string, properties: any) {
+        const url = this.getUrl(endpoints.crud.editObjectProperties, { typeId: itemType, id });
+        return axios.patch(url, properties, { headers: this.headers });
     }
-  }
 
-  public changeBaseUrl(newBaseUrl:string){
-    this.baseUrl = newBaseUrl;
-  }   
+    public async createItem(itemType: string, item: DataProperties) {
+        const url = this.getUrl(endpoints.crud.createObject, { typeId: itemType });
+        return axios.post(url, item, { headers: this.headers });
+    }
+
+    public async generatePdfByTemplate(id: string, variables: { [variableName: string]: any }, name: string) {
+        const url = this.getUrl(endpoints.pdfTemplate.generatePdfByTemplate, { id });
+        return axios.post(url, { templateId: id, variables, name }, { headers: this.headers });
+    }
 
-  private getUrl(pattern: string, params?: any): string {
-    let url = this.baseUrl + pattern;
-    for (const key in params) {
-      url = url.replace(`:${key}`, params[key]);
+    public async uploadFile(fileFormData: any) {
+        const url = this.getUrl(endpoints.files.uploadFile);
+        return axios.post(url, fileFormData, { headers: this.headers });
     }
-    return url;
-  }
-
-  public async getItems(itemType:string, query?:FilterSearchQueryI){
-    const queryString = qs.stringify(query);
-    const url = this.getUrl(endpoints.crud.getObjects, {typeId: itemType});
-    return axios.get(url, { params: queryString, headers: this.headers });
-  }
-
-  public async deleteItemById(itemType:string, id:string){
-    const url = this.getUrl(endpoints.crud.deleteObject, {typeId: itemType, id});
-    return axios.delete(url, {headers: this.headers});
-  }
-
-  public async editItemById(itemType:string, id:string, properties:any){
-    const url = this.getUrl(endpoints.crud.editObjectProperties, {typeId:itemType, id});
-    return axios.patch(url, properties, {headers: this.headers});
-  }
-
-  public async createItem(itemType:string, item:DataProperties){
-    const url = this.getUrl(endpoints.crud.createObject, {typeId: itemType});
-    return axios.post(url, item, {headers: this.headers});
-  }
-
-  /**
-   * 
-   * @param customMongoFilter an string with the mongo filter query
-   * @param rootTypeId an string with the id of the element that we make the aggregation query
-   * @param typeIdToGet the id of the type that we want to get
-   * @param options 
-   * @param returnCount 
-   */
-  public async customMongoFilter(customMongoFilter: string,rootTypeId:string, typeIdToGet:string, options?: {variables: any, pagination?: any, sort: any}, returnCount?:boolean){
-
-  }
 
+    public async getDownloadUrl(fileName: string) {
+        const url = this.getUrl(endpoints.files.getDownloadUrl, { fileName });
+        return axios.get(url, { headers: this.headers });
+    }
+
+    public async customMongoFilter(customMongoFilter: string, rootTypeId: string, typeIdToGet: string, options?: { variables?: any, pagination?: any, sort?: any, returnCount?: boolean }) {
+        const url = this.getUrl(endpoints.filter.customMongoFilter, {});
+        const body = { sort: options?.sort, variables: options?.variables, customMongoFilter, pagination: options?.pagination, rootTypeId, typeIdToGet };
+        const params = options?.returnCount ? { returnCount: options?.returnCount } : null;
+        return axios.post(url, body, { params: params, headers: this.headers });
+    }
+
+    public async lookUpFilter(idPage: string, query: FilterLookupSearchQueryI, idsOfMultipleNodesToSearch?: string[], returnCount?: boolean) {
+        const url = this.getUrl(endpoints.filter.lookUpFilter, { idPage });
+        const params = {
+            query: encodeURIComponent(JSON.stringify(query)),
+            idsOfMultipleNodesToSearch: encodeURIComponent(JSON.stringify(idsOfMultipleNodesToSearch)),
+            returnCount: returnCount,
+        };
+        return axios.get(url, { params: params, headers: this.headers });
+    }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "totalum-api-sdk",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Totalum sdk wraper of totalum api",
   "main": "index.js",
   "scripts": {