@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -1,5 +1,113 @@
 const Joi = require("joi");
 
+/**
+ * @typedef MarketplaceTheme
+ * @property {string} [_id] - Theme ID
+ * @property {PaymentInfo} [payment]
+ * @property {ContactInfo} [contact]
+ * @property {string[]} [industry] - Industries the theme is suitable for
+ * @property {boolean} [is_update] - Indicates if the theme is an update
+ * @property {boolean} [is_default] - Indicates if the theme is a default theme
+ * @property {string} [name] - Theme name
+ * @property {string} [tagline] - Theme tagline
+ * @property {string} [description] - Theme description
+ * @property {CatalogSize} [catalog_size]
+ * @property {MarketplaceThemeImages} [images]
+ * @property {CarouselItem[]} [carousel]
+ * @property {string} [src] - Theme source URL
+ * @property {ExploreInfo} [explore]
+ * @property {Feature[]} [features]
+ * @property {Highlight[]} [highlights]
+ * @property {Variation[]} [variations]
+ * @property {Documentation} [documentation]
+ * @property {string} [status] - Theme status
+ * @property {number} [step] - Theme step
+ * @property {Comments} [comments]
+ * @property {Release} [release]
+ * @property {string} [slug] - Theme slug
+ * @property {string} [organization_id] - Organization ID
+ * @property {string} [user_id] - User ID
+ * @property {string} [created_at] - Theme creation timestamp
+ * @property {string} [updated_at] - Theme update timestamp
+ * @property {string} [template_theme_id] - Template theme ID
+ * @property {string} [theme_type] - Theme type
+ */
+
+/**
+ * @typedef PaymentInfo
+ * @property {boolean} [is_paid] - Indicates if the theme is paid
+ * @property {number} [amount] - Amount of payment
+ */
+
+/**
+ * @typedef ContactInfo
+ * @property {string[]} [developer_contact] - Developer contact information
+ * @property {string} [seller_contact] - Seller contact information
+ */
+
+/**
+ * @typedef CatalogSize
+ * @property {number} [min] - Minimum catalog size
+ * @property {number} [max] - Maximum catalog size
+ */
+
+/**
+ * @typedef MarketplaceThemeImages
+ * @property {string} [desktop] - Desktop theme image URL
+ * @property {string} [mobile] - Mobile theme image URL
+ */
+
+/**
+ * @typedef CarouselItem
+ * @property {string} [desktop] - Desktop carousel image URL
+ * @property {string} [mobile] - Mobile carousel image URL
+ */
+
+/**
+ * @typedef ExploreInfo
+ * @property {string} [title] - Explore feature title
+ * @property {string} [description] - Explore feature description
+ */
+
+/**
+ * @typedef Feature
+ * @property {string} [category] - Feature category
+ * @property {FeatureItem[]} [list]
+ */
+
+/**
+ * @typedef FeatureItem
+ * @property {string} [label] - Feature properties
+ * @property {string} [description] - Feature description
+ */
+
+/**
+ * @typedef Highlight
+ * @property {string} [title] - Highlight title
+ * @property {string} [description] - Highlight description
+ * @property {string} [image] - Highlight image URL
+ */
+
+/**
+ * @typedef Variation
+ * @property {string} [name] - Variation name
+ * @property {string} [color] - Variation color
+ * @property {string} [demo_url] - Variation demo URL
+ * @property {MarketplaceThemeImages} [images]
+ */
+
+/**
+ * @typedef Documentation
+ * @property {string} [notes] - Documentation notes
+ * @property {string} [url] - Documentation URL
+ */
+
+/**
+ * @typedef Comments
+ * @property {string} [developer_remark] - Developer remark
+ * @property {string} [reviewer_feedback] - Reviewer feedback
+ */
+
 /**
  * @typedef GetExtensionSectionRes
  * @property {string} [extension_id]
@@ -53,6 +161,22 @@ const Joi = require("joi");
  * @property {AppliedThemes[]} [applied_themes]
  */
 
+/**
+ * @typedef CompanyThemeReqSchema
+ * @property {string} [marketplace_theme_id] - Theme id of the marketplace
+ */
+
+/**
+ * @typedef CompanyThemeResponse
+ * @property {string} [_id] - The unique identifier for the theme.
+ * @property {string} [name] - The name of the theme.
+ * @property {string} [marketplace_theme_id]
+ * @property {number} [company_id] - The ID of the company that the theme belongs to.
+ * @property {CompanyThemeMeta} [meta]
+ * @property {string} [created_at] - The timestamp when the theme was created.
+ * @property {string} [updated_at] - The timestamp when the theme was last updated.
+ */
+
 /**
  * @typedef MarketplaceThemeId
  * @property {string} [_id] - The unique identifier for the marketplace theme.
@@ -98,6 +222,7 @@ const Joi = require("joi");
  * @property {string} [_id]
  * @property {string} [created_at] - The creation timestamp of the page
  * @property {string} [updated_at] - The last update timestamp of the page
+ * @property {string} [application]
  */
 
 /**
@@ -142,12 +267,14 @@ const Joi = require("joi");
  * @property {string} [description]
  * @property {SEOMetaItem[]} [meta_tags]
  * @property {SEOSitemap} [sitemap]
- * @property {SEObreadcrumb[]} [breadcrumb]
+ * @property {SEObreadcrumb[]} [breadcrumbs]
  * @property {string} [_id]
+ * @property {string} [canonical_url]
  */
 
 /**
  * @typedef AvailablePageSchemaSections
+ * @property {string} [_id] - Unique Id for section.
  * @property {string} [name]
  * @property {string} [label]
  * @property {Object} [props]
@@ -222,7 +349,7 @@ const Joi = require("joi");
 
 /**
  * @typedef FontsSchema
- * @property {FontsSchemaItems} [items]
+ * @property {Object[]} [items]
  * @property {string} [kind]
  */
 
@@ -246,6 +373,7 @@ const Joi = require("joi");
  * @property {FontsSchemaItemsFiles} [files]
  * @property {string} [category]
  * @property {string} [kind]
+ * @property {string} [menu]
  */
 
 /**
@@ -272,6 +400,7 @@ const Joi = require("joi");
  * @property {Object} [styles] - The styles associated with the theme
  * @property {string} [created_at] - The creation timestamp of the theme
  * @property {string} [updated_at] - The last update timestamp of the theme
+ * @property {Object[]} [global_sections]
  * @property {Assets} [assets]
  * @property {SectionItem[]} [available_sections] - Available sections information
  * @property {string} [theme_type]
@@ -280,9 +409,9 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ThemeUpgradable
+ * @typedef ThemeUpgradableResponse
  * @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
- * @property {ThemeVersions} [versions]
+ * @property {Object} [versions]
  * @property {string} [message] - A message describing the theme upgrade status
  */
 
@@ -323,7 +452,7 @@ const Joi = require("joi");
  * @property {string} current - The current configuration
  * @property {ThemeConfiguration[]} list - A list of configurations
  * @property {GlobalSchema} [global_schema]
- * @property {Preset} [preset]
+ * @property {Object} [preset] - An Object of default theme configurations
  */
 
 /**
@@ -447,6 +576,7 @@ const Joi = require("joi");
 /**
  * @typedef Prop
  * @property {string} [type] - The type of the property
+ * @property {Option[]} [options]
  * @property {string} [category] - The category of the property
  * @property {string} [value] - The value of the property
  * @property {string} [id] - The ID of the property
@@ -483,6 +613,7 @@ const Joi = require("joi");
  * @property {Object[]} [props]
  * @property {Object[]} [blocks] - Blocks
  * @property {string} [name] - Name of the section
+ * @property {SectionPreset} [preset]
  * @property {string} [label] - Label for the section
  */
 
@@ -595,7 +726,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef DummyTheme
+ * @typedef DummyResponse
  * @property {string} [message]
  */
 
@@ -619,6 +750,12 @@ const Joi = require("joi");
  * @property {CompanyThemeMeta} [meta]
  */
 
+/**
+ * @typedef Option
+ * @property {string} [text]
+ * @property {string} [value]
+ */
+
 /**
  * @typedef ActionPage
  * @property {Object} [params] - Parameters that should be considered in path.
@@ -679,6 +816,140 @@ const Joi = require("joi");
  */
 
 class ThemePlatformModel {
+  /** @returns {MarketplaceTheme} */
+  static MarketplaceTheme() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      payment: ThemePlatformModel.PaymentInfo(),
+      contact: ThemePlatformModel.ContactInfo(),
+      industry: Joi.array().items(Joi.string().allow("")),
+      is_update: Joi.boolean(),
+      is_default: Joi.boolean(),
+      name: Joi.string().allow(""),
+      tagline: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      catalog_size: ThemePlatformModel.CatalogSize(),
+      images: ThemePlatformModel.MarketplaceThemeImages(),
+      carousel: Joi.array().items(ThemePlatformModel.CarouselItem()),
+      src: Joi.string().allow(""),
+      explore: ThemePlatformModel.ExploreInfo(),
+      features: Joi.array().items(ThemePlatformModel.Feature()),
+      highlights: Joi.array().items(ThemePlatformModel.Highlight()),
+      variations: Joi.array().items(ThemePlatformModel.Variation()),
+      documentation: ThemePlatformModel.Documentation(),
+      status: Joi.string().allow(""),
+      step: Joi.number(),
+      comments: ThemePlatformModel.Comments(),
+      release: ThemePlatformModel.Release(),
+      slug: Joi.string().allow(""),
+      organization_id: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      template_theme_id: Joi.string().allow(""),
+      theme_type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PaymentInfo} */
+  static PaymentInfo() {
+    return Joi.object({
+      is_paid: Joi.boolean(),
+      amount: Joi.number(),
+    });
+  }
+
+  /** @returns {ContactInfo} */
+  static ContactInfo() {
+    return Joi.object({
+      developer_contact: Joi.array().items(Joi.string().allow("")),
+      seller_contact: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CatalogSize} */
+  static CatalogSize() {
+    return Joi.object({
+      min: Joi.number(),
+      max: Joi.number(),
+    });
+  }
+
+  /** @returns {MarketplaceThemeImages} */
+  static MarketplaceThemeImages() {
+    return Joi.object({
+      desktop: Joi.string().allow(""),
+      mobile: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CarouselItem} */
+  static CarouselItem() {
+    return Joi.object({
+      desktop: Joi.string().allow(""),
+      mobile: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ExploreInfo} */
+  static ExploreInfo() {
+    return Joi.object({
+      title: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Feature} */
+  static Feature() {
+    return Joi.object({
+      category: Joi.string().allow(""),
+      list: Joi.array().items(ThemePlatformModel.FeatureItem()),
+    });
+  }
+
+  /** @returns {FeatureItem} */
+  static FeatureItem() {
+    return Joi.object({
+      label: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Highlight} */
+  static Highlight() {
+    return Joi.object({
+      title: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      image: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Variation} */
+  static Variation() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+      color: Joi.string().allow(""),
+      demo_url: Joi.string().allow(""),
+      images: ThemePlatformModel.MarketplaceThemeImages(),
+    });
+  }
+
+  /** @returns {Documentation} */
+  static Documentation() {
+    return Joi.object({
+      notes: Joi.string().allow(""),
+      url: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Comments} */
+  static Comments() {
+    return Joi.object({
+      developer_remark: Joi.string().allow(""),
+      reviewer_feedback: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {GetExtensionSectionRes} */
   static GetExtensionSectionRes() {
     return Joi.object({
@@ -743,6 +1014,26 @@ class ThemePlatformModel {
     });
   }
 
+  /** @returns {CompanyThemeReqSchema} */
+  static CompanyThemeReqSchema() {
+    return Joi.object({
+      marketplace_theme_id: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CompanyThemeResponse} */
+  static CompanyThemeResponse() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      marketplace_theme_id: Joi.string().allow(""),
+      company_id: Joi.number(),
+      meta: ThemePlatformModel.CompanyThemeMeta(),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {MarketplaceThemeId} */
   static MarketplaceThemeId() {
     return Joi.object({
@@ -800,13 +1091,14 @@ class ThemePlatformModel {
       _id: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
+      application: Joi.string().allow(""),
     });
   }
 
   /** @returns {AvailablePageSectionMetaAttributes} */
   static AvailablePageSectionMetaAttributes() {
     return Joi.object({
-      attributes: Joi.object().pattern(/\S/, Joi.any()),
+      attributes: Joi.any(),
     });
   }
 
@@ -858,19 +1150,21 @@ class ThemePlatformModel {
       description: Joi.string().allow(""),
       meta_tags: Joi.array().items(ThemePlatformModel.SEOMetaItem()),
       sitemap: ThemePlatformModel.SEOSitemap(),
-      breadcrumb: Joi.array().items(ThemePlatformModel.SEObreadcrumb()),
+      breadcrumbs: Joi.array().items(ThemePlatformModel.SEObreadcrumb()),
       _id: Joi.string().allow(""),
+      canonical_url: Joi.string().allow(""),
     });
   }
 
   /** @returns {AvailablePageSchemaSections} */
   static AvailablePageSchemaSections() {
     return Joi.object({
+      _id: Joi.string().allow(""),
       name: Joi.string().allow(""),
       label: Joi.string().allow(""),
-      props: Joi.object().pattern(/\S/, Joi.any()),
+      props: Joi.any(),
       blocks: Joi.array().items(Joi.any()),
-      preset: Joi.object().pattern(/\S/, Joi.any()),
+      preset: Joi.any(),
       predicate: ThemePlatformModel.AvailablePagePredicate(),
       __source: ThemePlatformModel.SectionSource(),
     });
@@ -919,7 +1213,7 @@ class ThemePlatformModel {
     return Joi.object({
       selected: Joi.string().allow(""),
       exact_url: Joi.string().allow(""),
-      query: Joi.object().pattern(/\S/, Joi.any()),
+      query: Joi.any(),
     });
   }
 
@@ -958,7 +1252,7 @@ class ThemePlatformModel {
   /** @returns {FontsSchema} */
   static FontsSchema() {
     return Joi.object({
-      items: ThemePlatformModel.FontsSchemaItems(),
+      items: Joi.array().items(Joi.any()),
       kind: Joi.string().allow(""),
     });
   }
@@ -988,6 +1282,7 @@ class ThemePlatformModel {
       files: ThemePlatformModel.FontsSchemaItemsFiles(),
       category: Joi.string().allow(""),
       kind: Joi.string().allow(""),
+      menu: Joi.string().allow(""),
     });
   }
 
@@ -1015,9 +1310,10 @@ class ThemePlatformModel {
       name: Joi.string().allow(""),
       template_theme_id: Joi.string().allow(""),
       version: Joi.string().allow(""),
-      styles: Joi.object().pattern(/\S/, Joi.any()),
+      styles: Joi.any(),
       created_at: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
+      global_sections: Joi.array().items(Joi.any()),
       assets: ThemePlatformModel.Assets(),
       available_sections: Joi.array().items(ThemePlatformModel.SectionItem()),
       theme_type: Joi.string().allow(""),
@@ -1026,11 +1322,11 @@ class ThemePlatformModel {
     });
   }
 
-  /** @returns {ThemeUpgradable} */
-  static ThemeUpgradable() {
+  /** @returns {ThemeUpgradableResponse} */
+  static ThemeUpgradableResponse() {
     return Joi.object({
       upgrade: Joi.boolean(),
-      versions: ThemePlatformModel.ThemeVersions(),
+      versions: Joi.any(),
       message: Joi.string().allow(""),
     });
   }
@@ -1085,7 +1381,7 @@ class ThemePlatformModel {
         .items(ThemePlatformModel.ThemeConfiguration())
         .required(),
       global_schema: ThemePlatformModel.GlobalSchema(),
-      preset: ThemePlatformModel.Preset(),
+      preset: Joi.any(),
     });
   }
 
@@ -1093,7 +1389,7 @@ class ThemePlatformModel {
   static ThemeConfiguration() {
     return Joi.object({
       name: Joi.string().allow(""),
-      global_config: Joi.object().pattern(/\S/, Joi.any()),
+      global_config: Joi.any(),
       page: Joi.array().items(ThemePlatformModel.ThemeConfigListPage()),
     });
   }
@@ -1145,7 +1441,7 @@ class ThemePlatformModel {
   /** @returns {ThemeConfigListPageSettingsProps} */
   static ThemeConfigListPageSettingsProps() {
     return Joi.object({
-      props: Joi.object().pattern(/\S/, Joi.any()),
+      props: Joi.any(),
     });
   }
 
@@ -1232,6 +1528,7 @@ class ThemePlatformModel {
   static Prop() {
     return Joi.object({
       type: Joi.string().allow(""),
+      options: Joi.array().items(ThemePlatformModel.Option()),
       category: Joi.string().allow(""),
       value: Joi.string().allow(""),
       id: Joi.string().allow(""),
@@ -1275,9 +1572,10 @@ class ThemePlatformModel {
   /** @returns {SectionItem} */
   static SectionItem() {
     return Joi.object({
-      props: Joi.array().items(Joi.any()),
-      blocks: Joi.array().items(Joi.any()),
+      props: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
+      blocks: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
       name: Joi.string().allow(""),
+      preset: ThemePlatformModel.SectionPreset(),
       label: Joi.string().allow(""),
     });
   }
@@ -1424,8 +1722,8 @@ class ThemePlatformModel {
     });
   }
 
-  /** @returns {DummyTheme} */
-  static DummyTheme() {
+  /** @returns {DummyResponse} */
+  static DummyResponse() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
@@ -1455,6 +1753,14 @@ class ThemePlatformModel {
     });
   }
 
+  /** @returns {Option} */
+  static Option() {
+    return Joi.object({
+      text: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ActionPage} */
   static ActionPage() {
     return Joi.object({

package/sdk/platform/Theme/ThemePlatformValidator.d.ts

@@ -1,7 +1,7 @@
 export = ThemePlatformValidator;
 /**
  * @typedef AddMarketplaceThemeToCompanyParam
- * @property {ThemePlatformModel.ThemeReq} body
+ * @property {ThemePlatformModel.CompanyThemeReqSchema} body
  */
 /**
  * @typedef DeleteCompanyThemeParam
@@ -17,6 +17,7 @@ export = ThemePlatformValidator;
  * @property {string} [searchText] - Search Text to match the Theme Names and
  *   return the response.
  */
+/** @typedef GetDefaultMarketplaceThemeParam */
 declare class ThemePlatformValidator {
     /** @returns {AddMarketplaceThemeToCompanyParam} */
     static addMarketplaceThemeToCompany(): AddMarketplaceThemeToCompanyParam;
@@ -26,12 +27,14 @@ declare class ThemePlatformValidator {
     static getCompanyLevelPrivateThemes(): GetCompanyLevelPrivateThemesParam;
     /** @returns {GetCompanyLevelThemesParam} */
     static getCompanyLevelThemes(): GetCompanyLevelThemesParam;
+    /** @returns {GetDefaultMarketplaceThemeParam} */
+    static getDefaultMarketplaceTheme(): any;
 }
 declare namespace ThemePlatformValidator {
-    export { AddMarketplaceThemeToCompanyParam, DeleteCompanyThemeParam, GetCompanyLevelPrivateThemesParam, GetCompanyLevelThemesParam };
+    export { AddMarketplaceThemeToCompanyParam, DeleteCompanyThemeParam, GetCompanyLevelPrivateThemesParam, GetCompanyLevelThemesParam, GetDefaultMarketplaceThemeParam };
 }
 type AddMarketplaceThemeToCompanyParam = {
-    body: ThemePlatformModel.ThemeReq;
+    body: ThemePlatformModel.CompanyThemeReqSchema;
 };
 type DeleteCompanyThemeParam = {
     /**
@@ -53,4 +56,5 @@ type GetCompanyLevelThemesParam = {
      */
     searchText?: string;
 };
+type GetDefaultMarketplaceThemeParam = any;
 import ThemePlatformModel = require("./ThemePlatformModel");

package/sdk/platform/Theme/ThemePlatformValidator.js

@@ -4,7 +4,7 @@ const ThemePlatformModel = require("./ThemePlatformModel");
 
 /**
  * @typedef AddMarketplaceThemeToCompanyParam
- * @property {ThemePlatformModel.ThemeReq} body
+ * @property {ThemePlatformModel.CompanyThemeReqSchema} body
  */
 
 /**
@@ -24,11 +24,13 @@ const ThemePlatformModel = require("./ThemePlatformModel");
  *   return the response.
  */
 
+/** @typedef GetDefaultMarketplaceThemeParam */
+
 class ThemePlatformValidator {
   /** @returns {AddMarketplaceThemeToCompanyParam} */
   static addMarketplaceThemeToCompany() {
     return Joi.object({
-      body: ThemePlatformModel.ThemeReq().required(),
+      body: ThemePlatformModel.CompanyThemeReqSchema().required(),
     }).required();
   }
 
@@ -52,6 +54,11 @@ class ThemePlatformValidator {
       searchText: Joi.string().allow(""),
     }).required();
   }
+
+  /** @returns {GetDefaultMarketplaceThemeParam} */
+  static getDefaultMarketplaceTheme() {
+    return Joi.object({}).required();
+  }
 }
 
 module.exports = ThemePlatformValidator;