@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js

@@ -0,0 +1,301 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const FileStorageValidator = require("./FileStoragePlatformApplicationValidator");
+
+class FileStorage {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {StartRequest} arg.body
+   * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `appStartUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `appCompleteUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
+   */
+  appStartUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.appStartUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.appStartUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for appStartUpload");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/start/`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {StartResponse} arg.body
+   * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `appStartUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `appCompleteUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
+   */
+  appCompleteUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.appCompleteUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = FileStorageValidator.appCompleteUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for appCompleteUpload");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/complete/`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {boolean} [arg.sync] - Sync
+   * @param {BulkRequest} arg.body
+   * @summary: Copy Files
+   * @description: Copy Files
+   */
+  appCopyFiles({ body, sync } = {}) {
+    const { error } = FileStorageValidator.appCopyFiles().validate(
+      {
+        body,
+        sync,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.appCopyFiles().validate(
+      {
+        body,
+        sync,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for appCopyFiles");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+    query_params["sync"] = sync;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/uploads/copy/`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {number} [arg.pageNo] - Page no
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browse({ namespace, pageNo } = {}) {
+    const { error } = FileStorageValidator.browse().validate(
+      {
+        namespace,
+        pageNo,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.browse().validate(
+      {
+        namespace,
+        pageNo,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for browse");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/browse/`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {number} arg.companyId - Company_id
+   * @param {number} arg.applicationId - Application_id
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browsePaginator({ namespace, companyId, applicationId } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.browse({
+        namespace: namespace,
+        companyId: companyId,
+        applicationId: applicationId,
+        pageNo: pageNo,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+}
+module.exports = FileStorage;
+
+/**
+ * @param data
+ * @param {string} file_name
+ * @param {string} content_type
+ * @param {string} namespace
+ * @param {number} size
+ * @param {number} tags
+ */
+FileStorage.prototype.upload = function ({
+  data,
+  file_name,
+  content_type,
+  namespace,
+  size,
+  tags,
+} = {}) {
+  return new Promise(async (resolve, reject) => {
+    try {
+      const dataObj = await this.appStartUpload({
+        namespace,
+        body: {
+          file_name,
+          content_type,
+          size: size,
+          tags: tags,
+        },
+      });
+      if (dataObj.upload && dataObj.upload.url) {
+        await axios.put(dataObj.upload.url, data, {
+          withCredentials: false,
+          headers: { "Content-Type": content_type },
+        });
+      } else {
+        reject({ message: "Failed to upload file" });
+      }
+      delete dataObj.tags;
+
+      const completeRes = await this.appCompleteUpload({
+        namespace,
+        body: dataObj,
+      });
+
+      resolve(completeRes);
+    } catch (err) {
+      reject(err);
+    }
+  });
+};

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts

@@ -0,0 +1,7 @@
+export = FileStorageValidator;
+declare class FileStorageValidator {
+    static appStartUpload(): any;
+    static appCompleteUpload(): any;
+    static appCopyFiles(): any;
+    static browse(): any;
+}

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js

@@ -0,0 +1,38 @@
+const Joi = require("joi");
+const FileStorageModel = require("./FileStoragePlatformModel");
+
+class FileStorageValidator {
+  static appStartUpload() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+
+      body: FileStorageModel.StartRequest().required(),
+    }).required();
+  }
+
+  static appCompleteUpload() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+
+      body: FileStorageModel.StartResponse().required(),
+    }).required();
+  }
+
+  static appCopyFiles() {
+    return Joi.object({
+      sync: Joi.boolean(),
+
+      body: FileStorageModel.BulkRequest().required(),
+    }).required();
+  }
+
+  static browse() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+
+      pageNo: Joi.number(),
+    }).required();
+  }
+}
+
+module.exports = FileStorageValidator;

package/sdk/platform/{client → FileStorage}/FileStoragePlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const FileStorageValidator = require("../models/FileStorageValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const FileStorageValidator = require("./FileStoragePlatformValidator");
 class FileStorage {
   constructor(config) {
     this.config = config;
@@ -43,6 +43,19 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.startUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for startUpload");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -93,6 +106,19 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.completeUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for completeUpload");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -124,6 +150,18 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.getSignUrls().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getSignUrls");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -157,6 +195,19 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.copyFiles().validate(
+      {
+        body,
+        sync,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for copyFiles");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["sync"] = sync;
 
@@ -191,6 +242,19 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.browse().validate(
+      {
+        namespace,
+        pageNo,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for browse");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
 
@@ -249,6 +313,18 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.proxy().validate(
+      {
+        url,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for proxy");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["url"] = url;
 

package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts

@@ -0,0 +1,21 @@
+export = FileStorageModel;
+declare class FileStorageModel {
+    static FailedResponse(): any;
+    static CDN(): any;
+    static Upload(): any;
+    static StartResponse(): any;
+    static StartRequest(): any;
+    static CompleteResponse(): any;
+    static Opts(): any;
+    static CopyFileTask(): any;
+    static BulkUploadResponse(): any;
+    static ReqConfiguration(): any;
+    static Destination(): any;
+    static BulkRequest(): any;
+    static Urls(): any;
+    static SignUrlResponse(): any;
+    static SignUrlRequest(): any;
+    static Page(): any;
+    static DbRecord(): any;
+    static BrowseResponse(): any;
+}