@gofynd/fdk-client-javascript 1.5.1 → 1.6.0

package/sdk/public/Catalog/CatalogPublicModel.d.ts

@@ -0,0 +1,155 @@
+export = CatalogPublicModel;
+/**
+ * @typedef TaxonomyItemAttributeSchemaObject
+ * @property {string} [type] - The data type of the attribute".
+ * @property {boolean} [mandatory] - Specifies if the attribute is mandatory.
+ */
+/**
+ * @typedef TaxonomyItemAttributesResponseSchema
+ * @property {string} [id] - Unique identifier for the attribute.
+ * @property {string} [name] - The name of the attribute, such as "Color" or "Size".
+ * @property {string} [slug] - A URL-friendly identifier for the attribute,
+ *   which is used for filtering or querying.
+ * @property {TaxonomyItemAttributeSchemaObject} [schema]
+ */
+/**
+ * @typedef TaxonomyItemResponseSchema
+ * @property {number} uid - Unique identifier for the taxonomy item.
+ * @property {string} name - The name of the taxonomy item. For example, it
+ *   could be the name of a department or category.
+ * @property {string} slug - A URL-friendly identifier for the taxonomy item.
+ *   The slug differs based on the level: - At level 0, it refers to the
+ *   department. - At level 1, it refers to the L1 category. - At level 2, it
+ *   refers to the L2 category. - At level 3, it refers to the L3 category.
+ * @property {number} level - The level level of the taxonomy item in the
+ *   hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
+ * @property {TaxonomyItemAttributesResponseSchema[]} [attributes] - A list of
+ *   attributes associated with the taxonomy item, such as color or size. These
+ *   attributes may differ depending on the level of the taxonomy.
+ * @property {string} [product_template_slug] - A slug identifier for the
+ *   template associated with this taxonomy item. It links the taxonomy to a
+ *   specific product template.
+ * @property {string} [product_template_name] - A Name for the template
+ *   associated with this taxonomy item. It links the taxonomy to a specific
+ *   product template.
+ */
+/**
+ * @typedef TaxonomyResponseSchema
+ * @property {TaxonomyItemResponseSchema[]} [items] - List of taxonomy items for
+ *   the requested level level. Each item represents a taxonomy node with
+ *   details about its category, attributes, and associated template.
+ */
+/**
+ * @typedef ValidationErrors
+ * @property {ValidationError[]} errors
+ */
+/**
+ * @typedef ValidationError
+ * @property {string} message - A brief description of the error encountered.
+ * @property {string} field - The field in the request that caused the error.
+ */
+declare class CatalogPublicModel {
+}
+declare namespace CatalogPublicModel {
+    export { TaxonomyItemAttributeSchemaObject, TaxonomyItemAttributesResponseSchema, TaxonomyItemResponseSchema, TaxonomyResponseSchema, ValidationErrors, ValidationError };
+}
+/** @returns {TaxonomyItemAttributeSchemaObject} */
+declare function TaxonomyItemAttributeSchemaObject(): TaxonomyItemAttributeSchemaObject;
+type TaxonomyItemAttributeSchemaObject = {
+    /**
+     * - The data type of the attribute".
+     */
+    type?: string;
+    /**
+     * - Specifies if the attribute is mandatory.
+     */
+    mandatory?: boolean;
+};
+/** @returns {TaxonomyItemAttributesResponseSchema} */
+declare function TaxonomyItemAttributesResponseSchema(): TaxonomyItemAttributesResponseSchema;
+type TaxonomyItemAttributesResponseSchema = {
+    /**
+     * - Unique identifier for the attribute.
+     */
+    id?: string;
+    /**
+     * - The name of the attribute, such as "Color" or "Size".
+     */
+    name?: string;
+    /**
+     * - A URL-friendly identifier for the attribute,
+     * which is used for filtering or querying.
+     */
+    slug?: string;
+    schema?: TaxonomyItemAttributeSchemaObject;
+};
+/** @returns {TaxonomyItemResponseSchema} */
+declare function TaxonomyItemResponseSchema(): TaxonomyItemResponseSchema;
+type TaxonomyItemResponseSchema = {
+    /**
+     * - Unique identifier for the taxonomy item.
+     */
+    uid: number;
+    /**
+     * - The name of the taxonomy item. For example, it
+     * could be the name of a department or category.
+     */
+    name: string;
+    /**
+     * - A URL-friendly identifier for the taxonomy item.
+     * The slug differs based on the level: - At level 0, it refers to the
+     * department. - At level 1, it refers to the L1 category. - At level 2, it
+     * refers to the L2 category. - At level 3, it refers to the L3 category.
+     */
+    slug: string;
+    /**
+     * - The level level of the taxonomy item in the
+     * hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
+     */
+    level: number;
+    /**
+     * - A list of
+     * attributes associated with the taxonomy item, such as color or size. These
+     * attributes may differ depending on the level of the taxonomy.
+     */
+    attributes?: TaxonomyItemAttributesResponseSchema[];
+    /**
+     * - A slug identifier for the
+     * template associated with this taxonomy item. It links the taxonomy to a
+     * specific product template.
+     */
+    product_template_slug?: string;
+    /**
+     * - A Name for the template
+     * associated with this taxonomy item. It links the taxonomy to a specific
+     * product template.
+     */
+    product_template_name?: string;
+};
+/** @returns {TaxonomyResponseSchema} */
+declare function TaxonomyResponseSchema(): TaxonomyResponseSchema;
+type TaxonomyResponseSchema = {
+    /**
+     * - List of taxonomy items for
+     * the requested level level. Each item represents a taxonomy node with
+     * details about its category, attributes, and associated template.
+     */
+    items?: TaxonomyItemResponseSchema[];
+};
+/** @returns {ValidationErrors} */
+declare function ValidationErrors(): ValidationErrors;
+type ValidationErrors = {
+    errors: ValidationError[];
+};
+/** @returns {ValidationError} */
+declare function ValidationError(): ValidationError;
+type ValidationError = {
+    /**
+     * - A brief description of the error encountered.
+     */
+    message: string;
+    /**
+     * - The field in the request that caused the error.
+     */
+    field: string;
+};

package/sdk/public/Catalog/CatalogPublicModel.js

@@ -0,0 +1,116 @@
+const Joi = require("joi");
+
+/**
+ * @typedef TaxonomyItemAttributeSchemaObject
+ * @property {string} [type] - The data type of the attribute".
+ * @property {boolean} [mandatory] - Specifies if the attribute is mandatory.
+ */
+
+/**
+ * @typedef TaxonomyItemAttributesResponseSchema
+ * @property {string} [id] - Unique identifier for the attribute.
+ * @property {string} [name] - The name of the attribute, such as "Color" or "Size".
+ * @property {string} [slug] - A URL-friendly identifier for the attribute,
+ *   which is used for filtering or querying.
+ * @property {TaxonomyItemAttributeSchemaObject} [schema]
+ */
+
+/**
+ * @typedef TaxonomyItemResponseSchema
+ * @property {number} uid - Unique identifier for the taxonomy item.
+ * @property {string} name - The name of the taxonomy item. For example, it
+ *   could be the name of a department or category.
+ * @property {string} slug - A URL-friendly identifier for the taxonomy item.
+ *   The slug differs based on the level: - At level 0, it refers to the
+ *   department. - At level 1, it refers to the L1 category. - At level 2, it
+ *   refers to the L2 category. - At level 3, it refers to the L3 category.
+ * @property {number} level - The level level of the taxonomy item in the
+ *   hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
+ * @property {TaxonomyItemAttributesResponseSchema[]} [attributes] - A list of
+ *   attributes associated with the taxonomy item, such as color or size. These
+ *   attributes may differ depending on the level of the taxonomy.
+ * @property {string} [product_template_slug] - A slug identifier for the
+ *   template associated with this taxonomy item. It links the taxonomy to a
+ *   specific product template.
+ * @property {string} [product_template_name] - A Name for the template
+ *   associated with this taxonomy item. It links the taxonomy to a specific
+ *   product template.
+ */
+
+/**
+ * @typedef TaxonomyResponseSchema
+ * @property {TaxonomyItemResponseSchema[]} [items] - List of taxonomy items for
+ *   the requested level level. Each item represents a taxonomy node with
+ *   details about its category, attributes, and associated template.
+ */
+
+/**
+ * @typedef ValidationErrors
+ * @property {ValidationError[]} errors
+ */
+
+/**
+ * @typedef ValidationError
+ * @property {string} message - A brief description of the error encountered.
+ * @property {string} field - The field in the request that caused the error.
+ */
+
+class CatalogPublicModel {
+  /** @returns {TaxonomyItemAttributeSchemaObject} */
+  static TaxonomyItemAttributeSchemaObject() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      mandatory: Joi.boolean(),
+    });
+  }
+
+  /** @returns {TaxonomyItemAttributesResponseSchema} */
+  static TaxonomyItemAttributesResponseSchema() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      schema: CatalogPublicModel.TaxonomyItemAttributeSchemaObject(),
+    });
+  }
+
+  /** @returns {TaxonomyItemResponseSchema} */
+  static TaxonomyItemResponseSchema() {
+    return Joi.object({
+      uid: Joi.number().required(),
+      name: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      level: Joi.number().required(),
+      attributes: Joi.array().items(
+        CatalogPublicModel.TaxonomyItemAttributesResponseSchema()
+      ),
+      product_template_slug: Joi.string().allow(""),
+      product_template_name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {TaxonomyResponseSchema} */
+  static TaxonomyResponseSchema() {
+    return Joi.object({
+      items: Joi.array().items(CatalogPublicModel.TaxonomyItemResponseSchema()),
+    });
+  }
+
+  /** @returns {ValidationErrors} */
+  static ValidationErrors() {
+    return Joi.object({
+      errors: Joi.array()
+        .items(CatalogPublicModel.ValidationError())
+        .required(),
+    });
+  }
+
+  /** @returns {ValidationError} */
+  static ValidationError() {
+    return Joi.object({
+      message: Joi.string().allow("").required(),
+      field: Joi.string().allow("").required(),
+    });
+  }
+}
+module.exports = CatalogPublicModel;

package/sdk/public/Catalog/CatalogPublicValidator.d.ts

@@ -0,0 +1,55 @@
+export = CatalogPublicValidator;
+/**
+ * @typedef GetTaxonomyByLevelParam
+ * @property {number} level - The level of taxonomy hierarchy to fetch: 0: Fetch
+ *   departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+ * @property {string} [l0Slug] - Level 0 (Department) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l1Slug] - Level 1 (L1 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l2Slug] - Level 2 (L2 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l3Slug] - Level 3 (L3 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {number} [limit] - Applied limit on the number of items to be
+ *   returned. Default is 5000.
+ */
+declare class CatalogPublicValidator {
+    /** @returns {GetTaxonomyByLevelParam} */
+    static getTaxonomyByLevel(): GetTaxonomyByLevelParam;
+}
+declare namespace CatalogPublicValidator {
+    export { GetTaxonomyByLevelParam };
+}
+type GetTaxonomyByLevelParam = {
+    /**
+     * - The level of taxonomy hierarchy to fetch: 0: Fetch
+     * departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+     */
+    level: number;
+    /**
+     * - Level 0 (Department) slug of the taxonomy to
+     * filter results.
+     */
+    l0Slug?: string;
+    /**
+     * - Level 1 (L1 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l1Slug?: string;
+    /**
+     * - Level 2 (L2 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l2Slug?: string;
+    /**
+     * - Level 3 (L3 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l3Slug?: string;
+    /**
+     * - Applied limit on the number of items to be
+     * returned. Default is 5000.
+     */
+    limit?: number;
+};

package/sdk/public/Catalog/CatalogPublicValidator.js

@@ -0,0 +1,35 @@
+const Joi = require("joi");
+
+const CatalogPublicModel = require("./CatalogPublicModel");
+
+/**
+ * @typedef GetTaxonomyByLevelParam
+ * @property {number} level - The level of taxonomy hierarchy to fetch: 0: Fetch
+ *   departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+ * @property {string} [l0Slug] - Level 0 (Department) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l1Slug] - Level 1 (L1 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l2Slug] - Level 2 (L2 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l3Slug] - Level 3 (L3 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {number} [limit] - Applied limit on the number of items to be
+ *   returned. Default is 5000.
+ */
+
+class CatalogPublicValidator {
+  /** @returns {GetTaxonomyByLevelParam} */
+  static getTaxonomyByLevel() {
+    return Joi.object({
+      level: Joi.number().required(),
+      l0Slug: Joi.string().allow(""),
+      l1Slug: Joi.string().allow(""),
+      l2Slug: Joi.string().allow(""),
+      l3Slug: Joi.string().allow(""),
+      limit: Joi.number(),
+    }).required();
+  }
+}
+
+module.exports = CatalogPublicValidator;

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -49,6 +49,14 @@ class Configuration {
     { locationType, id, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ConfigurationPublicValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: true }
@@ -130,6 +138,14 @@ class Configuration {
     { authorization, query, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ConfigurationPublicValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: true }

package/sdk/public/Content/ContentPublicClient.js

@@ -58,6 +58,14 @@ class Content {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getAllTags().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -134,6 +142,14 @@ class Content {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getAnalyticsTags().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -212,6 +228,14 @@ class Content {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getBasicDetails().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -290,6 +314,21 @@ class Content {
     { entityType, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+
+    if (!entityType) {
+      invalidInput.push({
+        message: `The 'entityType' field is required.`,
+        path: ["entityType"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getCredentialsByEntity().validate(
       { entityType },
       { abortEarly: false, allowUnknown: true }
@@ -368,6 +407,21 @@ class Content {
     { slug, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+
+    if (!slug) {
+      invalidInput.push({
+        message: `The 'slug' field is required.`,
+        path: ["slug"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getCustomPage().validate(
       { slug },
       { abortEarly: false, allowUnknown: true }
@@ -444,6 +498,14 @@ class Content {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getFooterContent().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -522,6 +584,21 @@ class Content {
     { pageType, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+
+    if (!pageType) {
+      invalidInput.push({
+        message: `The 'pageType' field is required.`,
+        path: ["pageType"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getHomePageContent().validate(
       { pageType },
       { abortEarly: false, allowUnknown: true }
@@ -601,6 +678,14 @@ class Content {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getMenuContent().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -679,6 +764,21 @@ class Content {
     { type, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+
+    if (!type) {
+      invalidInput.push({
+        message: `The 'type' field is required.`,
+        path: ["type"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getMenuContentByType().validate(
       { type },
       { abortEarly: false, allowUnknown: true }
@@ -757,6 +857,14 @@ class Content {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getNavbar().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -833,6 +941,14 @@ class Content {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getPricingBanner().validate(
       {},
       { abortEarly: false, allowUnknown: true }

package/sdk/public/Partner/PartnerPublicClient.js

@@ -48,6 +48,21 @@ class Partner {
     { slug, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    let invalidInput = [];
+
+    if (!slug) {
+      invalidInput.push({
+        message: `The 'slug' field is required.`,
+        path: ["slug"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const {
       error,
     } = PartnerPublicValidator.getPanelExtensionDetails().validate(

package/sdk/public/PublicClient.d.ts

@@ -12,6 +12,7 @@ declare class PublicClient {
      */
     constructor(config: import("./PublicConfig"));
     config: import("./PublicConfig");
+    catalog: Catalog;
     configuration: Configuration;
     content: Content;
     partner: Partner;
@@ -24,6 +25,7 @@ declare class PublicClient {
      */
     setExtraHeaders(header: object): void;
 }
+import Catalog = require("./Catalog/CatalogPublicClient");
 import Configuration = require("./Configuration/ConfigurationPublicClient");
 import Content = require("./Content/ContentPublicClient");
 import Partner = require("./Partner/PartnerPublicClient");

package/sdk/public/PublicClient.js

@@ -1,3 +1,5 @@
+const Catalog = require("./Catalog/CatalogPublicClient");
+
 const Configuration = require("./Configuration/ConfigurationPublicClient");
 
 const Content = require("./Content/ContentPublicClient");
@@ -22,6 +24,8 @@ class PublicClient {
   constructor(config) {
     this.config = config;
 
+    this.catalog = new Catalog(config);
+
     this.configuration = new Configuration(config);
 
     this.content = new Content(config);