@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/FileStorage/FileStoragePlatformModel.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 = FileStoragePlatformModel;
+/**
+ * @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 FileStoragePlatformModel {
 }
+declare namespace FileStoragePlatformModel {
+    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;
+};

package/sdk/platform/FileStorage/FileStoragePlatformModel.js

@@ -1,25 +1,188 @@
 const Joi = require("joi");
 
-class FileStorageModel {
+/**
+ * @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
+ */
+
+class FileStoragePlatformModel {
+  /** @returns {BrowseResponse} */
   static BrowseResponse() {
     return Joi.object({
-      items: Joi.array().items(FileStorageModel.DbRecord()).required(),
-      page: FileStorageModel.Page().required(),
+      items: Joi.array().items(FileStoragePlatformModel.DbRecord()).required(),
+      page: FileStoragePlatformModel.Page().required(),
     });
   }
+
+  /** @returns {BulkRequest} */
   static BulkRequest() {
     return Joi.object({
-      configuration: FileStorageModel.ReqConfiguration(),
-      destination: FileStorageModel.Destination().required(),
+      configuration: FileStoragePlatformModel.ReqConfiguration(),
+      destination: FileStoragePlatformModel.Destination().required(),
       urls: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
+
+  /** @returns {BulkUploadResponse} */
   static BulkUploadResponse() {
     return Joi.object({
-      task: FileStorageModel.CopyFileTask().required(),
+      task: FileStoragePlatformModel.CopyFileTask().required(),
       tracking_url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CDN} */
   static CDN() {
     return Joi.object({
       absolute_url: Joi.string().allow("").required(),
@@ -27,10 +190,12 @@ class FileStorageModel {
       url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CompleteResponse} */
   static CompleteResponse() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
-      cdn: FileStorageModel.CDN().required(),
+      cdn: FileStoragePlatformModel.CDN().required(),
       content_type: Joi.string().allow("").required(),
       created_on: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -41,28 +206,32 @@ class FileStorageModel {
       size: Joi.number().required(),
       success: Joi.boolean().required(),
       tags: Joi.array().items(Joi.string().allow("")),
-      upload: FileStorageModel.Upload().required(),
+      upload: FileStoragePlatformModel.Upload().required(),
     });
   }
+
+  /** @returns {CopyFileTask} */
   static CopyFileTask() {
     return Joi.object({
       attempts_made: Joi.number().required(),
-      data: FileStorageModel.BulkRequest().required(),
+      data: FileStoragePlatformModel.BulkRequest().required(),
       delay: Joi.number().required(),
       finished_on: Joi.number().required(),
       id: Joi.string().allow("").required(),
       name: Joi.string().allow("").required(),
-      opts: FileStorageModel.Opts().required(),
+      opts: FileStoragePlatformModel.Opts().required(),
       processed_on: Joi.number().required(),
       progress: Joi.number().required(),
       stacktrace: Joi.array().items(Joi.string().allow("")),
       timestamp: Joi.number().required(),
     });
   }
+
+  /** @returns {DbRecord} */
   static DbRecord() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
-      cdn: FileStorageModel.CDN().required(),
+      cdn: FileStoragePlatformModel.CDN().required(),
       content_type: Joi.string().allow("").required(),
       created_on: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -72,9 +241,11 @@ class FileStorageModel {
       operation: Joi.string().allow(""),
       success: Joi.boolean().required(),
       tags: Joi.array().items(Joi.string().allow("")).required(),
-      upload: FileStorageModel.Upload().required(),
+      upload: FileStoragePlatformModel.Upload().required(),
     });
   }
+
+  /** @returns {Destination} */
   static Destination() {
     return Joi.object({
       basepath: Joi.string().allow(""),
@@ -82,11 +253,15 @@ class FileStorageModel {
       rewrite: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {FailedResponse} */
   static FailedResponse() {
     return Joi.object({
       message: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {Opts} */
   static Opts() {
     return Joi.object({
       attempts: Joi.number(),
@@ -94,6 +269,8 @@ class FileStorageModel {
       timestamp: Joi.number(),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -105,22 +282,30 @@ class FileStorageModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ReqConfiguration} */
   static ReqConfiguration() {
     return Joi.object({
       concurrency: Joi.number(),
     });
   }
+
+  /** @returns {SignUrlRequest} */
   static SignUrlRequest() {
     return Joi.object({
       expiry: Joi.number().required(),
       urls: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
+
+  /** @returns {SignUrlResponse} */
   static SignUrlResponse() {
     return Joi.object({
-      urls: Joi.array().items(FileStorageModel.Urls()).required(),
+      urls: Joi.array().items(FileStoragePlatformModel.Urls()).required(),
     });
   }
+
+  /** @returns {StartRequest} */
   static StartRequest() {
     return Joi.object({
       content_type: Joi.string().allow("").required(),
@@ -130,9 +315,11 @@ class FileStorageModel {
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {StartResponse} */
   static StartResponse() {
     return Joi.object({
-      cdn: FileStorageModel.CDN().required(),
+      cdn: FileStoragePlatformModel.CDN().required(),
       content_type: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
@@ -141,15 +328,19 @@ class FileStorageModel {
       operation: Joi.string().allow("").required(),
       size: Joi.number().required(),
       tags: Joi.array().items(Joi.string().allow("")),
-      upload: FileStorageModel.Upload().required(),
+      upload: FileStoragePlatformModel.Upload().required(),
     });
   }
+
+  /** @returns {Upload} */
   static Upload() {
     return Joi.object({
       expiry: Joi.number().required(),
       url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {Urls} */
   static Urls() {
     return Joi.object({
       expiry: Joi.number().required(),
@@ -158,4 +349,4 @@ class FileStorageModel {
     });
   }
 }
-module.exports = FileStorageModel;
+module.exports = FileStoragePlatformModel;