@gofynd/fdk-client-javascript 3.17.2 → 3.18.0

package/README.md

@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.17.2' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.18.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "3.17.2",
+  "version": "3.18.0",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -12,6 +12,10 @@
   },
   "author": "Jigar Dafda",
   "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gofynd/fdk-client-javascript.git"
+  },
   "dependencies": {
     "axios": "^1.6.4",
     "camelcase": "^6.3.0",
@@ -42,4 +46,4 @@
     "!dist",
     "!cypress"
   ]
-}
+}

package/sdk/common/AxiosHelper.js

@@ -1,4 +1,4 @@
-const { isAbsoluteURL, combineURLs } = require("./utils");
+const { isAbsoluteURL, combineURLs, isWebWorker } = require("./utils");
 const axios = require("axios").default;
 const querystring = require("query-string");
 const { sign } = require("@gofynd/fp-signature");
@@ -79,12 +79,19 @@ function requestInterceptorFn() {
     return config;
   };
 }
-const fdkAxios = axios.create({
+
+const axiosConfig = {
   withCredentials: true,
   paramsSerializer: (params) => {
     return querystring.stringify(params);
   },
-});
+};
+
+if (isWebWorker()) {
+  axiosConfig.adapter = "fetch";
+}
+
+const fdkAxios = axios.create(axiosConfig);
 
 // Generate Curl in debug mode
 fdkAxios.interceptors.request.use(

package/sdk/common/utils.d.ts

@@ -7,7 +7,7 @@ export function findBestMatchingLink(allLinks?: any[], pathname?: string): {
     value: string;
     params: {};
 };
-export function convertStringToBase64(string: any): string;
+export function convertStringToBase64(string: any): any;
 export function isBrowser(): boolean;
 export function isNode(): boolean;
 export namespace NAV_TYPE {
@@ -29,3 +29,13 @@ export function combineURLs(baseURL: string, relativeURL: string): string;
  * @returns {boolean} True if the specified URL is absolute, otherwise false
  */
 export function isAbsoluteURL(url: string): boolean;
+/**
+ * Checks if the current execution context is a Web Worker (DedicatedWorker).
+ *
+ * This function determines whether the code is running inside a Dedicated Web
+ * Worker by verifying that the global `self` object exists, has a constructor,
+ * and that the constructor's name is "DedicatedWorkerGlobalScope".
+ *
+ * @returns {boolean} True if running in a Dedicated Web Worker, otherwise false.
+ */
+export function isWebWorker(): boolean;

package/sdk/common/utils.js

@@ -166,11 +166,27 @@ const isNode = () => {
   );
 };
 
+/**
+ * Checks if the current execution context is a Web Worker (DedicatedWorker).
+ *
+ * This function determines whether the code is running inside a Dedicated Web
+ * Worker by verifying that the global `self` object exists, has a constructor,
+ * and that the constructor's name is "DedicatedWorkerGlobalScope".
+ *
+ * @returns {boolean} True if running in a Dedicated Web Worker, otherwise false.
+ */
+const isWebWorker = () =>
+  typeof self === "object" &&
+  self.constructor &&
+  self.constructor.name === "DedicatedWorkerGlobalScope";
+
 const convertStringToBase64 = (string) => {
   if (isNode()) {
     return Buffer.from(string, "utf-8").toString("base64");
   } else if (isBrowser()) {
     return window.btoa(string);
+  } else if (isWebWorker()) {
+    return BufferPolyFill.from(string, "utf-8").toString("base64");
   } else {
     throw new FDKException("Base64 conversion error: Unsupported environment");
   }
@@ -217,4 +233,5 @@ module.exports = {
   NAV_TYPE,
   combineURLs,
   isAbsoluteURL,
+  isWebWorker,
 };

package/sdk/platform/Communication/CommunicationPlatformModel.d.ts

@@ -662,8 +662,6 @@ export = CommunicationPlatformModel;
  * @property {SendOtpCommsReqData} [data]
  * @property {SendOtpCommsReqSms} [sms]
  * @property {SendOtpCommsReqEmail} [email]
- * @property {Object} [additional_variables] - Additional data in key-value
- *   format where values can be of any type
  */
 /**
  * @typedef SendOtpCommsRes
@@ -1710,11 +1708,6 @@ type SendOtpCommsReq = {
     data?: SendOtpCommsReqData;
     sms?: SendOtpCommsReqSms;
     email?: SendOtpCommsReqEmail;
-    /**
-     * - Additional data in key-value
-     * format where values can be of any type
-     */
-    additional_variables?: any;
 };
 /** @returns {SendOtpCommsRes} */
 declare function SendOtpCommsRes(): SendOtpCommsRes;

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -757,8 +757,6 @@ const Joi = require("joi");
  * @property {SendOtpCommsReqData} [data]
  * @property {SendOtpCommsReqSms} [sms]
  * @property {SendOtpCommsReqEmail} [email]
- * @property {Object} [additional_variables] - Additional data in key-value
- *   format where values can be of any type
  */
 
 /**
@@ -1994,7 +1992,6 @@ class CommunicationPlatformModel {
       data: CommunicationPlatformModel.SendOtpCommsReqData(),
       sms: CommunicationPlatformModel.SendOtpCommsReqSms(),
       email: CommunicationPlatformModel.SendOtpCommsReqEmail(),
-      additional_variables: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 

package/sdk/platform/Order/OrderPlatformClient.d.ts

@@ -85,7 +85,7 @@ declare class Order {
      * @returns {Promise<Object>} - Success response
      * @name createOrder
      * @summary: Create Order
-     * @description: Creates an order in the OMS. Use the (<a href='https://docs.fynd.com/partners/commerce/sdk/latest/platform/application/serviceability#createShipments'>createShipments API</a>) to determine shipments before creating an order.  Click <a href='https://docs.fynd.com/partners/commerce/miscellaneous/createOrder-useCases'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
+     * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
      */
     createOrder({ xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<any>;
     /**

package/sdk/platform/Order/OrderPlatformClient.js

@@ -604,7 +604,7 @@ class Order {
    * @returns {Promise<Object>} - Success response
    * @name createOrder
    * @summary: Create Order
-   * @description: Creates an order in the OMS. Use the (<a href='https://docs.fynd.com/partners/commerce/sdk/latest/platform/application/serviceability#createShipments'>createShipments API</a>) to determine shipments before creating an order.  Click <a href='https://docs.fynd.com/partners/commerce/miscellaneous/createOrder-useCases'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
+   * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
    */
   async createOrder(
     { xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders } = {

package/sdk/platform/Order/OrderPlatformModel.d.ts

@@ -2858,8 +2858,8 @@ export = OrderPlatformModel;
  *   offline mode. Used to enable offline-specific processing and sync behavior.
  * @property {LineItemSchema[]} [line_items] - A list of items included in the shipment.
  * @property {OrderFulfillmentTimelineSchema} [order_fulfillment_timeline]
- * @property {number} [location_id] - The location ID from which this shipment
- *   is being fulfilled.
+ * @property {number} location_id - The location ID from which this shipment is
+ *   being fulfilled.
  * @property {string} [external_location_id] - The external location ID from
  *   which this shipment is being fulfilled.
  * @property {number} [return_location_id] - Overrides the article's default
@@ -11344,10 +11344,10 @@ type CreateOrderShipmentSchema = {
     line_items?: LineItemSchema[];
     order_fulfillment_timeline?: OrderFulfillmentTimelineSchema;
     /**
-     * - The location ID from which this shipment
-     * is being fulfilled.
+     * - The location ID from which this shipment is
+     * being fulfilled.
      */
-    location_id?: number;
+    location_id: number;
     /**
      * - The external location ID from
      * which this shipment is being fulfilled.

package/sdk/platform/Order/OrderPlatformModel.js

@@ -3117,8 +3117,8 @@ const Joi = require("joi");
  *   offline mode. Used to enable offline-specific processing and sync behavior.
  * @property {LineItemSchema[]} [line_items] - A list of items included in the shipment.
  * @property {OrderFulfillmentTimelineSchema} [order_fulfillment_timeline]
- * @property {number} [location_id] - The location ID from which this shipment
- *   is being fulfilled.
+ * @property {number} location_id - The location ID from which this shipment is
+ *   being fulfilled.
  * @property {string} [external_location_id] - The external location ID from
  *   which this shipment is being fulfilled.
  * @property {number} [return_location_id] - Overrides the article's default
@@ -8898,7 +8898,7 @@ class OrderPlatformModel {
       invoice_id: Joi.string().allow(""),
       line_items: Joi.array().items(OrderPlatformModel.LineItemSchema()),
       order_fulfillment_timeline: OrderPlatformModel.OrderFulfillmentTimelineSchema(),
-      location_id: Joi.number(),
+      location_id: Joi.number().required(),
       external_location_id: Joi.string().allow(""),
       return_location_id: Joi.number(),
       courier_partner_details: OrderPlatformModel.CourierPartnerDetailsSchema(),