@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/FileStorage/FileStorageApplicationClient.js

@@ -2,8 +2,8 @@ const ApplicationAPIClient = require("../ApplicationAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const FileStorageValidator = require("./FileStorageApplicationValidator");
-const FileStorageModel = require("./FileStorageApplicationModel");
+const FileStorageApplicationValidator = require("./FileStorageApplicationValidator");
+const FileStorageApplicationModel = require("./FileStorageApplicationModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 const axios = require("axios");
@@ -35,13 +35,10 @@ class FileStorage {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Segregation of different types of
-   *   files(products, orders, logistics etc), Required for validating the
-   *   data of the file being uploaded, decides where exactly the file will be
-   *   stored inside the storage bucket.
-   * @param {StartResponse} arg.body
-   * @returns {Promise<CompleteResponse>} - Success response
+   * @param {FileStorageApplicationValidator.CompleteUploadParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
+   * @name completeUpload
    * @summary: Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
    * @description: Use this API to perform the third step of uploading (i.e. **Complete**) an arbitrarily sized buffer or blob.
    *
@@ -61,9 +58,13 @@ class FileStorage {
    * ### Complete
    * After successfully upload, call the `completeUpload` API to finish the upload process.
    * This operation will return the URL of the uploaded file.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
    */
-  async completeUpload({ namespace, body } = {}) {
-    const { error } = FileStorageValidator.completeUpload().validate(
+  async completeUpload(
+    { namespace, body } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = FileStorageApplicationValidator.completeUpload().validate(
       { namespace, body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -72,16 +73,17 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.completeUpload().validate(
+    const {
+      error: warrning,
+    } = FileStorageApplicationValidator.completeUpload().validate(
       { namespace, body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for completeUpload",
+        message: `Parameter Validation warrnings for application > FileStorage > completeUpload \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -97,12 +99,18 @@ class FileStorage {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = FileStorageModel.CompleteResponse().validate(response, {
+    } = FileStorageApplicationModel.CompleteResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -110,23 +118,23 @@ class FileStorage {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for completeUpload",
+        message: `Response Validation Warnnings for application > FileStorage > completeUpload \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {SignUrlRequest} arg.body
-   * @returns {Promise<SignUrlResponse>} - Success response
+   * @param {FileStorageApplicationValidator.SignUrlsParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
+   * @name signUrls
    * @summary: Explain here
-   * @description: Describe here
+   * @description: Describe here - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
    */
-  async signUrls({ body } = {}) {
-    const { error } = FileStorageValidator.signUrls().validate(
+  async signUrls({ body } = {}, { headers } = { headers: false }) {
+    const { error } = FileStorageApplicationValidator.signUrls().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -135,16 +143,17 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.signUrls().validate(
+    const {
+      error: warrning,
+    } = FileStorageApplicationValidator.signUrls().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for signUrls",
+        message: `Parameter Validation warrnings for application > FileStorage > signUrls \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -160,12 +169,18 @@ class FileStorage {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = FileStorageModel.SignUrlResponse().validate(response, {
+    } = FileStorageApplicationModel.SignUrlResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -173,22 +188,18 @@ class FileStorage {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for signUrls",
+        message: `Response Validation Warnnings for application > FileStorage > signUrls \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Segregation of different types of
-   *   files(products, orders, logistics etc), Required for validating the
-   *   data of the file being uploaded, decides where exactly the file will be
-   *   stored inside the storage bucket.
-   * @param {StartRequest} arg.body
-   * @returns {Promise<StartResponse>} - Success response
+   * @param {FileStorageApplicationValidator.StartUploadParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
+   * @name startUpload
    * @summary: Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.
    * @description: Use this API to perform the first step of uploading (i.e. **Start**) an arbitrarily sized buffer or blob.
    *
@@ -208,9 +219,13 @@ class FileStorage {
    * ### Complete
    * After successfully upload, call the `completeUpload` API to finish the upload process.
    * This operation will return the URL of the uploaded file.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
    */
-  async startUpload({ namespace, body } = {}) {
-    const { error } = FileStorageValidator.startUpload().validate(
+  async startUpload(
+    { namespace, body } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = FileStorageApplicationValidator.startUpload().validate(
       { namespace, body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -219,16 +234,17 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.startUpload().validate(
+    const {
+      error: warrning,
+    } = FileStorageApplicationValidator.startUpload().validate(
       { namespace, body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for startUpload",
+        message: `Parameter Validation warrnings for application > FileStorage > startUpload \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -244,12 +260,18 @@ class FileStorage {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = FileStorageModel.StartResponse().validate(response, {
+    } = FileStorageApplicationModel.StartResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -257,9 +279,8 @@ class FileStorage {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for startUpload",
+        message: `Response Validation Warnnings for application > FileStorage > startUpload \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;

package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts

@@ -1,21 +1,300 @@
-export = FileStorageModel;
-declare class FileStorageModel {
-    static BrowseResponse(): any;
-    static BulkRequest(): any;
-    static BulkUploadResponse(): any;
-    static CDN(): any;
-    static CompleteResponse(): any;
-    static CopyFileTask(): any;
-    static DbRecord(): any;
-    static Destination(): any;
-    static FailedResponse(): any;
-    static Opts(): any;
-    static Page(): any;
-    static ReqConfiguration(): any;
-    static SignUrlRequest(): any;
-    static SignUrlResponse(): any;
-    static StartRequest(): any;
-    static StartResponse(): any;
-    static Upload(): any;
-    static Urls(): any;
+export = FileStorageApplicationModel;
+/**
+ * @typedef BrowseResponse
+ * @property {DbRecord[]} items
+ * @property {Page} page
+ */
+/**
+ * @typedef BulkRequest
+ * @property {ReqConfiguration} [configuration]
+ * @property {Destination} destination
+ * @property {string[]} urls
+ */
+/**
+ * @typedef BulkUploadResponse
+ * @property {CopyFileTask} task
+ * @property {string} tracking_url
+ */
+/**
+ * @typedef CDN
+ * @property {string} absolute_url
+ * @property {string} relative_url
+ * @property {string} url
+ */
+/**
+ * @typedef CompleteResponse
+ * @property {string} _id
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} created_on
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} modified_on
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {boolean} success
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+/**
+ * @typedef CopyFileTask
+ * @property {number} attempts_made
+ * @property {BulkRequest} data
+ * @property {number} delay
+ * @property {number} finished_on
+ * @property {string} id
+ * @property {string} name
+ * @property {Opts} opts
+ * @property {number} processed_on
+ * @property {number} progress
+ * @property {string[]} [stacktrace]
+ * @property {number} timestamp
+ */
+/**
+ * @typedef DbRecord
+ * @property {string} _id
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} created_on
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} modified_on
+ * @property {string} namespace
+ * @property {string} [operation]
+ * @property {boolean} success
+ * @property {string[]} tags
+ * @property {Upload} upload
+ */
+/**
+ * @typedef Destination
+ * @property {string} [basepath]
+ * @property {string} namespace
+ * @property {string} rewrite
+ */
+/**
+ * @typedef FailedResponse
+ * @property {string} message
+ */
+/**
+ * @typedef Opts
+ * @property {number} [attempts]
+ * @property {number} [delay]
+ * @property {number} [timestamp]
+ */
+/**
+ * @typedef Page
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {boolean} [has_previous]
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {number} [size]
+ * @property {string} type
+ */
+/**
+ * @typedef ReqConfiguration
+ * @property {number} [concurrency]
+ */
+/**
+ * @typedef SignUrlRequest
+ * @property {number} expiry
+ * @property {string[]} urls
+ */
+/**
+ * @typedef SignUrlResponse
+ * @property {Urls[]} urls
+ */
+/**
+ * @typedef StartRequest
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {Object} [params]
+ * @property {number} size
+ * @property {string[]} [tags]
+ */
+/**
+ * @typedef StartResponse
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} [method]
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+/**
+ * @typedef Upload
+ * @property {number} expiry
+ * @property {string} url
+ */
+/**
+ * @typedef Urls
+ * @property {number} expiry
+ * @property {string} signed_url
+ * @property {string} url
+ */
+declare class FileStorageApplicationModel {
 }
+declare namespace FileStorageApplicationModel {
+    export { BrowseResponse, BulkRequest, BulkUploadResponse, CDN, CompleteResponse, CopyFileTask, DbRecord, Destination, FailedResponse, Opts, Page, ReqConfiguration, SignUrlRequest, SignUrlResponse, StartRequest, StartResponse, Upload, Urls };
+}
+/** @returns {BrowseResponse} */
+declare function BrowseResponse(): BrowseResponse;
+type BrowseResponse = {
+    items: DbRecord[];
+    page: Page;
+};
+/** @returns {BulkRequest} */
+declare function BulkRequest(): BulkRequest;
+type BulkRequest = {
+    configuration?: ReqConfiguration;
+    destination: Destination;
+    urls: string[];
+};
+/** @returns {BulkUploadResponse} */
+declare function BulkUploadResponse(): BulkUploadResponse;
+type BulkUploadResponse = {
+    task: CopyFileTask;
+    tracking_url: string;
+};
+/** @returns {CDN} */
+declare function CDN(): CDN;
+type CDN = {
+    absolute_url: string;
+    relative_url: string;
+    url: string;
+};
+/** @returns {CompleteResponse} */
+declare function CompleteResponse(): CompleteResponse;
+type CompleteResponse = {
+    _id: string;
+    cdn: CDN;
+    content_type: string;
+    created_on: string;
+    file_name: string;
+    file_path: string;
+    modified_on: string;
+    namespace: string;
+    operation: string;
+    size: number;
+    success: boolean;
+    tags?: string[];
+    upload: Upload;
+};
+/** @returns {CopyFileTask} */
+declare function CopyFileTask(): CopyFileTask;
+type CopyFileTask = {
+    attempts_made: number;
+    data: BulkRequest;
+    delay: number;
+    finished_on: number;
+    id: string;
+    name: string;
+    opts: Opts;
+    processed_on: number;
+    progress: number;
+    stacktrace?: string[];
+    timestamp: number;
+};
+/** @returns {DbRecord} */
+declare function DbRecord(): DbRecord;
+type DbRecord = {
+    _id: string;
+    cdn: CDN;
+    content_type: string;
+    created_on: string;
+    file_name: string;
+    file_path: string;
+    modified_on: string;
+    namespace: string;
+    operation?: string;
+    success: boolean;
+    tags: string[];
+    upload: Upload;
+};
+/** @returns {Destination} */
+declare function Destination(): Destination;
+type Destination = {
+    basepath?: string;
+    namespace: string;
+    rewrite: string;
+};
+/** @returns {FailedResponse} */
+declare function FailedResponse(): FailedResponse;
+type FailedResponse = {
+    message: string;
+};
+/** @returns {Opts} */
+declare function Opts(): Opts;
+type Opts = {
+    attempts?: number;
+    delay?: number;
+    timestamp?: number;
+};
+/** @returns {Page} */
+declare function Page(): Page;
+type Page = {
+    current?: number;
+    has_next?: boolean;
+    has_previous?: boolean;
+    item_total?: number;
+    next_id?: string;
+    size?: number;
+    type: string;
+};
+/** @returns {ReqConfiguration} */
+declare function ReqConfiguration(): ReqConfiguration;
+type ReqConfiguration = {
+    concurrency?: number;
+};
+/** @returns {SignUrlRequest} */
+declare function SignUrlRequest(): SignUrlRequest;
+type SignUrlRequest = {
+    expiry: number;
+    urls: string[];
+};
+/** @returns {SignUrlResponse} */
+declare function SignUrlResponse(): SignUrlResponse;
+type SignUrlResponse = {
+    urls: Urls[];
+};
+/** @returns {StartRequest} */
+declare function StartRequest(): StartRequest;
+type StartRequest = {
+    content_type: string;
+    file_name: string;
+    params?: any;
+    size: number;
+    tags?: string[];
+};
+/** @returns {StartResponse} */
+declare function StartResponse(): StartResponse;
+type StartResponse = {
+    cdn: CDN;
+    content_type: string;
+    file_name: string;
+    file_path: string;
+    method?: string;
+    namespace: string;
+    operation: string;
+    size: number;
+    tags?: string[];
+    upload: Upload;
+};
+/** @returns {Upload} */
+declare function Upload(): Upload;
+type Upload = {
+    expiry: number;
+    url: string;
+};
+/** @returns {Urls} */
+declare function Urls(): Urls;
+type Urls = {
+    expiry: number;
+    signed_url: string;
+    url: string;
+};