@swan-admin/swan-ai-measurements 1.0.57 → 1.0.59

package/auth.js

@@ -1,11 +1,11 @@
-const axios = require("axios");
-const { API_ENDPOINTS, APP_AUTH_BASE_URL, APP_AUTH_WEBSOCKET_URL, APP_BASE_URL, REQUIRED_MESSAGE } = require("./constants.js");
-const { checkParameters } = require("./utils.js");
+import axios from "axios";
+import { API_ENDPOINTS, APP_AUTH_BASE_URL, APP_AUTH_WEBSOCKET_URL, APP_BASE_URL, REQUIRED_MESSAGE } from "./constants.js";
+import { checkParameters } from "./utils.js";
 
 /**
  * Represents a Auth class for handling authentication operations.
  */
-class Auth {
+export default class Auth {
   #socketRef;
 
   /**
@@ -149,5 +149,3 @@ class Auth {
     };
   };
 }
-
-module.exports = Auth;

package/constants.js

@@ -1,18 +1,18 @@
-const APP_BASE_URL = "https://fitview-server-staging.ft2a64raup4pg.us-east-1.cs.amazonlightsail.com";
-const APP_AUTH_BASE_URL = "https://staging.api.getswan.co";
-const APP_AUTH_WEBSOCKET_URL = "wss://staging.wsnotify.api.getswan.co";
-const APP_TRY_ON_WEBSOCKET_URL = "wss://bucbzczxjk.execute-api.ap-south-1.amazonaws.com";
-const APP_RECOMMENDATION_WEBSOCKET_URL = "wss://staging.wsnotify.api.getswan.co/scanning";
-const APP_POSE_DETECTION_WEbSOCKET_URL = "https://posedetect-service-staging.ft2a64raup4pg.us-east-1.cs.amazonlightsail.com";
+export const APP_BASE_URL = "https://fitview-server-staging.ft2a64raup4pg.us-east-1.cs.amazonlightsail.com";
+export const APP_AUTH_BASE_URL = "https://staging.api.getswan.co";
+export const APP_AUTH_WEBSOCKET_URL = "wss://staging.wsnotify.api.getswan.co";
+export const APP_TRY_ON_WEBSOCKET_URL = "wss://bucbzczxjk.execute-api.ap-south-1.amazonaws.com";
+export const APP_RECOMMENDATION_WEBSOCKET_URL = "wss://staging.wsnotify.api.getswan.co/scanning";
+export const APP_POSE_DETECTION_WEbSOCKET_URL = "https://posedetect-service-staging.ft2a64raup4pg.us-east-1.cs.amazonlightsail.com";
 
-const UPPY_FILE_UPLOAD_ENDPOINT = {
+export const UPPY_FILE_UPLOAD_ENDPOINT = {
   UPLOAD_START: "/upload/start",
   UPLOAD_COMPLETE: "/upload/complete",
   UPLOAD_SIGN_PART: "/upload/signpart",
   UPLOAD_ABORT: "/upload/abort",
 };
 
-const API_ENDPOINTS = {
+export const API_ENDPOINTS = {
   GET_USER_DETAIL: "/api/user",
   REGISTER_USER: "/auth/register",
   VERIFY_USER: "/auth/verify",
@@ -27,20 +27,16 @@ const API_ENDPOINTS = {
   TRY_ON: "/tryon",
   AUTH: "/auth",
 };
-const requiredMetaData = ["gender", "scan_id", "email", "focal_length", "height", "customer_store_url", "scan_type", "callback_url", "clothes_fit"];
-const REQUIRED_MESSAGE = "Please verify required parameters";
-const REQUIRED_MESSAGE_FOR_META_DATA = "Please verify required parameters in meta data";
-
-module.exports = {
-  APP_BASE_URL,
-  APP_AUTH_BASE_URL,
-  APP_AUTH_WEBSOCKET_URL,
-  APP_TRY_ON_WEBSOCKET_URL,
-  APP_RECOMMENDATION_WEBSOCKET_URL,
-  APP_POSE_DETECTION_WEbSOCKET_URL,
-  REQUIRED_MESSAGE_FOR_META_DATA,
-  REQUIRED_MESSAGE,
-  requiredMetaData,
-  API_ENDPOINTS,
-  UPPY_FILE_UPLOAD_ENDPOINT,
-};
+export const requiredMetaData = [
+  "gender",
+  "scan_id",
+  "email",
+  "focal_length",
+  "height",
+  "customer_store_url",
+  "scan_type",
+  "callback_url",
+  "clothes_fit",
+];
+export const REQUIRED_MESSAGE = "Please verify required parameters";
+export const REQUIRED_MESSAGE_FOR_META_DATA = "Please verify required parameters in meta data";

package/custom.js

@@ -1,6 +1,6 @@
-const axios = require("axios");
-const { API_ENDPOINTS, APP_AUTH_BASE_URL, REQUIRED_MESSAGE } = require("./constants.js");
-const { checkParameters } = require("./utils.js");
+import axios from "axios";
+import { API_ENDPOINTS, APP_AUTH_BASE_URL, REQUIRED_MESSAGE } from "./constants.js";
+import { checkParameters } from "./utils.js";
 
 /**
  * Represents a Custom class for handling custom operations.
@@ -51,4 +51,4 @@ class Custom {
   };
 }
 
-module.exports = Custom;
+export default Custom;

package/{types → dist}/auth.d.ts

@@ -1,8 +1,7 @@
-export = Auth;
 /**
  * Represents a Auth class for handling authentication operations.
  */
-declare class Auth {
+export default class Auth {
     /**
      * Constructs a new instance of the Auth class.
      * @param {string} accessKey - The access key used for authentication.

package/dist/auth.js

@@ -0,0 +1,133 @@
+import axios from "axios";
+import { API_ENDPOINTS, APP_AUTH_BASE_URL, APP_AUTH_WEBSOCKET_URL, APP_BASE_URL, REQUIRED_MESSAGE } from "./constants.js";
+import { checkParameters } from "./utils.js";
+/**
+ * Represents a Auth class for handling authentication operations.
+ */
+export default class Auth {
+    #socketRef;
+    /**
+     * The access key used for authentication.
+     * @type {string}
+     * @private
+     */
+    #accessKey;
+    /**
+     * Constructs a new instance of the Auth class.
+     * @param {string} accessKey - The access key used for authentication.
+     */
+    constructor(accessKey) {
+        this.#accessKey = accessKey;
+    }
+    /**
+     * Register a new user.
+     * @param {Object} params - The parameters for user registration.
+     * @param {string} params.email - The email of the user.
+     * @param {string} params.appVerifyUrl - The verification URL.
+     * @param {string} [params.gender] - Optional. The gender of the user.
+     * @param {string} [params.height] - Optional. The height of the user.
+     * @param {string} params.username - Optional. The username of the user.
+     * @returns {Promise} - The axios response promise.
+     */
+    registerUser({ email, appVerifyUrl, gender, height, username }) {
+        if (checkParameters(email, appVerifyUrl) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        let body = {
+            username,
+            email,
+            appVerifyUrl,
+        };
+        if (gender && height) {
+            body = { ...body, attributes: { gender, height } };
+        }
+        return axios.post(`${APP_AUTH_BASE_URL}${API_ENDPOINTS.REGISTER_USER}`, body, {
+            headers: { "X-Api-Key": this.#accessKey },
+        });
+    }
+    /**
+     * Verify a user token.
+     * @param {string} token
+     * @returns {Promise}
+     */
+    verifyToken = (token, accessKey) => {
+        if (checkParameters(token) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        return axios.post(`${APP_AUTH_BASE_URL}${API_ENDPOINTS.VERIFY_USER}`, null, {
+            params: { token },
+            headers: { "X-Api-Key": this.#accessKey },
+        });
+    };
+    /**
+     * Add a user.
+     * @param {Object} params
+     * @param {string} params.scanId - The scan ID.
+     * @param {string} params.email - The email of the user.
+     * @param {string} params.name - The name of the user.
+     * @param {string} params.height - The height of the user.
+     * @param {string} params.gender - The gender of the user.
+     * @param {boolean} [params.offsetMarketingConsent] - Optional. The marketing consent offset.
+     * @returns {Promise} - The axios response promise.
+     */
+    addUser = ({ scanId, email, name, height, gender, offsetMarketingConsent }) => {
+        if (checkParameters(scanId, email, height, gender) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        return axios.post(`${APP_AUTH_BASE_URL}${API_ENDPOINTS.ADD_USER}`, {
+            scan_id: scanId,
+            email,
+            name,
+            offsetMarketingConsent,
+            attributes: JSON.stringify({ height, gender }),
+        }, { headers: { "X-Api-Key": this.#accessKey } });
+    };
+    /**
+     * Get user details.
+     * @param {string} email
+     * @returns {Promise}
+     */
+    getUserDetail = (email) => {
+        if (checkParameters(email) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        return axios.get(`${APP_BASE_URL}${API_ENDPOINTS.GET_USER_DETAIL}/${email}`, {
+            headers: { "X-Api-Key": this.#accessKey },
+        });
+    };
+    /**
+     * Handle authentication via WebSocket.
+     * @param {Object} params
+     * @param {string} params.email - The email address of the user.
+     * @param {string} params.scanId - The scan ID associated with the user.
+     * @param {function} [params.onError] - Optional. Callback function to handle errors.
+     * @param {function} [params.onSuccess] - Optional. Callback function to handle successful authentication.
+     * @param {function} [params.onClose] - Optional. Callback function to handle the WebSocket close event.
+     * @param {function} [params.onOpen] - Optional. Callback function to handle the WebSocket open event.
+     */
+    handleAuthSocket = ({ email, scanId, onError, onSuccess, onClose, onOpen }) => {
+        if (checkParameters(email, scanId) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        this.#socketRef?.close?.();
+        this.#socketRef = new WebSocket(`${APP_AUTH_WEBSOCKET_URL}${API_ENDPOINTS.AUTH}`);
+        const detailObj = {
+            email,
+            scanId,
+        };
+        this.#socketRef.onopen = () => {
+            this.#socketRef.send(JSON.stringify(detailObj));
+            onOpen?.();
+        };
+        this.#socketRef.onmessage = (event) => {
+            const data = JSON.parse(event.data);
+            onSuccess?.(data);
+        };
+        this.#socketRef.onclose = () => {
+            onClose?.();
+        };
+        this.#socketRef.onerror = (event) => {
+            onError?.(event);
+        };
+    };
+}

package/dist/constants.js

@@ -0,0 +1,40 @@
+export const APP_BASE_URL = "https://fitview-server-staging.ft2a64raup4pg.us-east-1.cs.amazonlightsail.com";
+export const APP_AUTH_BASE_URL = "https://staging.api.getswan.co";
+export const APP_AUTH_WEBSOCKET_URL = "wss://staging.wsnotify.api.getswan.co";
+export const APP_TRY_ON_WEBSOCKET_URL = "wss://bucbzczxjk.execute-api.ap-south-1.amazonaws.com";
+export const APP_RECOMMENDATION_WEBSOCKET_URL = "wss://staging.wsnotify.api.getswan.co/scanning";
+export const APP_POSE_DETECTION_WEbSOCKET_URL = "https://posedetect-service-staging.ft2a64raup4pg.us-east-1.cs.amazonlightsail.com";
+export const UPPY_FILE_UPLOAD_ENDPOINT = {
+    UPLOAD_START: "/upload/start",
+    UPLOAD_COMPLETE: "/upload/complete",
+    UPLOAD_SIGN_PART: "/upload/signpart",
+    UPLOAD_ABORT: "/upload/abort",
+};
+export const API_ENDPOINTS = {
+    GET_USER_DETAIL: "/api/user",
+    REGISTER_USER: "/auth/register",
+    VERIFY_USER: "/auth/verify",
+    ADD_USER: "/user",
+    CUSTOM_CUSTOMER: "/customers/custom",
+    MODEL: "/model",
+    TRY_ON_SCAN: "/tryon/scan",
+    TRY_ON_IMAGE_UPLOAD: "/tryon/user-image-urls/upload",
+    TRY_ON_IMAGE_DOWNLOAD: "/tryon/user-image-urls/download",
+    TRY_ON_IMAGE_URLS: "/tryon/user-image-urls",
+    TRY_ON_RESULT_IMAGE_DOWNLOAD: "/tryon/result-image-urls/download",
+    TRY_ON: "/tryon",
+    AUTH: "/auth",
+};
+export const requiredMetaData = [
+    "gender",
+    "scan_id",
+    "email",
+    "focal_length",
+    "height",
+    "customer_store_url",
+    "scan_type",
+    "callback_url",
+    "clothes_fit",
+];
+export const REQUIRED_MESSAGE = "Please verify required parameters";
+export const REQUIRED_MESSAGE_FOR_META_DATA = "Please verify required parameters in meta data";

package/{types → dist}/custom.d.ts

@@ -1,4 +1,4 @@
-export = Custom;
+export default Custom;
 /**
  * Represents a Custom class for handling custom operations.
  */

package/dist/custom.js

@@ -0,0 +1,49 @@
+import axios from "axios";
+import { API_ENDPOINTS, APP_AUTH_BASE_URL, REQUIRED_MESSAGE } from "./constants.js";
+import { checkParameters } from "./utils.js";
+/**
+ * Represents a Custom class for handling custom operations.
+ */
+class Custom {
+    /**
+     * The access key used for authentication.
+     * @type {string}
+     * @private
+     */
+    #accessKey;
+    /**
+     * Constructs a new instance of the Custom class.
+     * @param {string} accessKey - The access key used for authentication.
+     */
+    constructor(accessKey) {
+        this.#accessKey = accessKey;
+    }
+    /**
+     * Retrieves custom customer configuration based on the store URL.
+     * @param {string} store_url - The URL of the store.
+     * @returns {Promise} - A promise that resolves with the custom customer configuration.
+     * @throws {Error} - If required parameters are missing.
+     */
+    getCustomCustomerConfig = (store_url) => {
+        if (checkParameters(store_url) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        return axios.get(`${APP_AUTH_BASE_URL}${API_ENDPOINTS.CUSTOM_CUSTOMER}`, {
+            params: { store_url },
+            headers: { "X-Api-Key": this.#accessKey },
+        });
+    };
+    /**
+     * Retrieves the model URL based on the model ID.
+     * @param {string} id - The ID of the model.
+     * @returns {Promise} - A promise that resolves with the model URL.
+     * @throws {Error} - If required parameters are missing.
+     */
+    getModelUrl = (id) => {
+        if (checkParameters(id) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        return axios.get(`${APP_AUTH_BASE_URL}${API_ENDPOINTS.MODEL}/${id}`, { headers: { "X-Api-Key": this.#accessKey } });
+    };
+}
+export default Custom;

package/{types → dist}/fileUpload.d.ts

@@ -1,4 +1,4 @@
-export = FileUpload;
+export default FileUpload;
 /**
  * Class representing a file uploader using Uppy for multipart uploads.
  */

package/dist/fileUpload.js

@@ -0,0 +1,136 @@
+import { REQUIRED_MESSAGE, REQUIRED_MESSAGE_FOR_META_DATA, UPPY_FILE_UPLOAD_ENDPOINT } from "./constants.js";
+import { checkMetaDataValue, checkParameters, fetchData } from "./utils.js";
+/**
+ * Class representing a file uploader using Uppy for multipart uploads.
+ */
+class FileUpload {
+    /**
+     * The Uppy instance.
+     * @type {Object}
+     * @private
+     */
+    #uppyIns;
+    /**
+     * Reference to the Uppy module.
+     * @type {Object}
+     * @private
+     */
+    #Uppy;
+    /**
+     * Reference to the AwsS3Multipart module.
+     * @type {Object}
+     * @private
+     */
+    #AwsS3Multipart;
+    /**
+     * The access key used for authentication.
+     * @type {string}
+     * @private
+     */
+    #accessKey;
+    /**
+     * Constructs a new instance of the FileUpload class.
+     * @param {string} accessKey - The access key used for authentication.
+     */
+    constructor(accessKey) {
+        this.initializeModules();
+        this.#accessKey = accessKey;
+    }
+    /**
+     * Asynchronously initializes the Uppy and AwsS3Multipart modules.
+     * @private
+     */
+    async initializeModules() {
+        this.#Uppy = (await import("@uppy/core")).default;
+        this.#AwsS3Multipart = (await import("@uppy/aws-s3-multipart")).default;
+    }
+    /**
+     * Uploads a file with optional metadata and scan ID.
+     * @param {Object} params - The parameters for file upload.
+     * @param {File} params.file - The file to upload.
+     * @param {Object} params.objMetaData - Optional. Metadata associated with the file.
+     * @param {string} params.scanId - Optional. The ID of the scan.
+     * @returns {Promise} - A promise that resolves when the file is uploaded successfully.
+     * @throws {Error} - If required parameters are missing or metadata value is invalid.
+     */
+    async uploadFile({ file, objMetaData, scanId }) {
+        if (checkParameters(file, objMetaData, scanId) === false) {
+            throw new Error(REQUIRED_MESSAGE);
+        }
+        if (checkMetaDataValue(objMetaData) === false) {
+            throw new Error(REQUIRED_MESSAGE_FOR_META_DATA);
+        }
+        if (!this.#Uppy || !this.#AwsS3Multipart) {
+            await this.initializeModules();
+        }
+        return new Promise((resolve, reject) => {
+            if (this.#uppyIns) {
+                this.#uppyIns.close();
+            }
+            this.#uppyIns = new this.#Uppy({ autoProceed: true });
+            this.#uppyIns.use(this.#AwsS3Multipart, {
+                limit: 10,
+                retryDelays: [0, 1000, 3000, 5000],
+                getChunkSize: () => 5 * 1024 * 1024,
+                createMultipartUpload: (file) => {
+                    const objectKey = `${scanId}.${file.extension}`;
+                    return fetchData({
+                        path: UPPY_FILE_UPLOAD_ENDPOINT.UPLOAD_START,
+                        apiKey: this.#accessKey,
+                        body: {
+                            objectKey,
+                            contentType: file.type,
+                            objectMetadata: objMetaData,
+                        },
+                    });
+                },
+                completeMultipartUpload: (file, { uploadId, key, parts }) => fetchData({
+                    path: UPPY_FILE_UPLOAD_ENDPOINT.UPLOAD_COMPLETE,
+                    apiKey: this.#accessKey,
+                    body: {
+                        uploadId,
+                        objectKey: key,
+                        parts,
+                        originalFileName: file.name,
+                    },
+                }),
+                signPart: (file, partData) => fetchData({
+                    path: UPPY_FILE_UPLOAD_ENDPOINT.UPLOAD_SIGN_PART,
+                    apiKey: this.#accessKey,
+                    body: {
+                        objectKey: partData.key,
+                        uploadId: partData.uploadId,
+                        partNumber: partData.partNumber,
+                    },
+                }),
+                abortMultipartUpload: (file, { uploadId, key }) => fetchData({
+                    path: UPPY_FILE_UPLOAD_ENDPOINT.UPLOAD_ABORT,
+                    apiKey: this.#accessKey,
+                    body: {
+                        uploadId,
+                        objectKey: key,
+                        originalFileName: file.name,
+                    },
+                }),
+            });
+            this.#uppyIns.addFile({
+                source: "manual",
+                name: file.name,
+                type: file.type,
+                data: file,
+            });
+            this.#uppyIns.on("upload-error", (file, error, response) => {
+                reject(error);
+            });
+            this.#uppyIns.on("upload-success", () => {
+                resolve({ message: "file uploaded successfully" });
+            });
+            this.#uppyIns.on("complete", (result) => {
+                if (this.#uppyIns) {
+                    this.#uppyIns.close();
+                }
+            });
+        });
+    }
+}
+export default FileUpload;

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import Auth from "./auth";
+import Custom from "./custom";
+import FileUpload from "./fileUpload";
+import Measurement from "./measurement";
+import PoseDetection from "./poseDetection";
+import TryOn from "./tryOn";
+
+export default class Swan {
+  constructor(accessKey: string);
+
+  auth: Auth;
+  custom: Custom;
+  fileUpload: FileUpload;
+  measurement: Measurement;
+  poseDetection: PoseDetection;
+  tryOn: TryOn;
+
+  #private;
+}

package/dist/index.js

@@ -0,0 +1,19 @@
+import Auth from "./auth.js";
+import Custom from "./custom.js";
+import FileUpload from "./fileUpload.js";
+import Measurement from "./measurement.js";
+import PoseDetection from "./poseDetection.js";
+import TryOn from "./tryOn.js";
+class Swan {
+    #accessKey;
+    constructor(accessKey) {
+        this.#accessKey = accessKey;
+    }
+    auth = new Auth(this.#accessKey);
+    custom = new Custom(this.#accessKey);
+    fileUpload = new FileUpload(this.#accessKey);
+    measurement = new Measurement(this.#accessKey);
+    poseDetection = new PoseDetection(this.#accessKey);
+    tryOn = new TryOn(this.#accessKey);
+}
+export default Swan;

package/{types → dist}/measurement.d.ts

@@ -1,4 +1,4 @@
-export = Measurement;
+export default Measurement;
 /**
  * Class representing measurement-related functionality.
  */