@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -1,30 +1,370 @@
 const Joi = require("joi");
 
-class ThemeModel {
+/**
+ * @typedef AddThemeRequestSchema
+ * @property {string} [theme_id]
+ */
+
+/**
+ * @typedef AllAvailablePageSchema
+ * @property {AvailablePageSchema[]} [pages]
+ */
+
+/**
+ * @typedef AssetsSchema
+ * @property {CommonJs} [common_js]
+ * @property {Css} [css]
+ * @property {UmdJs} [umd_js]
+ */
+
+/**
+ * @typedef AvailablePagePredicate
+ * @property {AvailablePageRoutePredicate} [route]
+ * @property {AvailablePageScreenPredicate} [screen]
+ * @property {AvailablePageUserPredicate} [user]
+ */
+
+/**
+ * @typedef AvailablePageRoutePredicate
+ * @property {string} [exact_url]
+ * @property {Object} [query]
+ * @property {string} [selected]
+ */
+
+/**
+ * @typedef AvailablePageSchema
+ * @property {string} [_id]
+ * @property {string} [path]
+ * @property {Object[]} [props]
+ * @property {AvailablePageSchemaSections[]} [sections]
+ * @property {AvailablePageSectionMetaAttributes[]} [sections_meta]
+ * @property {AvailablePageSeo} [seo]
+ * @property {string} [text]
+ * @property {string} [theme]
+ * @property {string} [type]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef AvailablePageSchemaSections
+ * @property {Object[]} [blocks]
+ * @property {string} [label]
+ * @property {string} [name]
+ * @property {AvailablePagePredicate} [predicate]
+ * @property {Object} [preset]
+ * @property {Object} [props]
+ */
+
+/**
+ * @typedef AvailablePageScreenPredicate
+ * @property {boolean} [desktop]
+ * @property {boolean} [mobile]
+ * @property {boolean} [tablet]
+ */
+
+/**
+ * @typedef AvailablePageSectionMetaAttributes
+ * @property {Object} [attributes]
+ */
+
+/**
+ * @typedef AvailablePageSeo
+ * @property {string} [_id]
+ * @property {string} [description]
+ * @property {string} [title]
+ */
+
+/**
+ * @typedef AvailablePageUserPredicate
+ * @property {boolean} [anonymous]
+ * @property {boolean} [authenticated]
+ */
+
+/**
+ * @typedef availableSectionSchema
+ * @property {Blocks[]} [blocks]
+ * @property {string} [label]
+ * @property {string} [name]
+ * @property {BlocksProps[]} [props]
+ */
+
+/**
+ * @typedef BlitzkriegApiErrorSchema
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef BlitzkriegInternalServerErrorSchema
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef BlitzkriegNotFoundSchema
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef Blocks
+ * @property {string} [name]
+ * @property {BlocksProps[]} [props]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef BlocksProps
+ * @property {string} [id]
+ * @property {string} [label]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Bold
+ * @property {string} [file]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef Colors
+ * @property {string} [accent_color]
+ * @property {string} [bg_color]
+ * @property {string} [button_secondary_color]
+ * @property {string} [link_color]
+ * @property {string} [primary_color]
+ * @property {string} [secondary_color]
+ */
+
+/**
+ * @typedef CommonJs
+ * @property {string} [link]
+ */
+
+/**
+ * @typedef Config
+ * @property {string} [current]
+ * @property {GlobalSchema} [global_schema]
+ * @property {ListSchemaItem[]} [list]
+ * @property {Preset} [preset]
+ */
+
+/**
+ * @typedef ConfigPage
+ * @property {string} [page]
+ * @property {Object} [settings]
+ */
+
+/**
+ * @typedef Css
+ * @property {string} [link]
+ * @property {string[]} [links]
+ */
+
+/**
+ * @typedef Custom
+ * @property {Object} [props]
+ */
+
+/**
+ * @typedef Font
+ * @property {string} [family]
+ * @property {Variants} [variants]
+ */
+
+/**
+ * @typedef FontsSchema
+ * @property {FontsSchemaItems} [items]
+ * @property {string} [kind]
+ */
+
+/**
+ * @typedef FontsSchemaItems
+ * @property {string} [category]
+ * @property {string} [family]
+ * @property {FontsSchemaItemsFiles} [files]
+ * @property {string} [kind]
+ * @property {string} [last_modified]
+ * @property {string[]} [subsets]
+ * @property {string[]} [variants]
+ * @property {string} [version]
+ */
+
+/**
+ * @typedef FontsSchemaItemsFiles
+ * @property {string} [bold]
+ * @property {string} [italic]
+ * @property {string} [regular]
+ */
+
+/**
+ * @typedef GlobalSchema
+ * @property {GlobalSchemaProps[]} [props]
+ */
+
+/**
+ * @typedef GlobalSchemaProps
+ * @property {string} [category]
+ * @property {string} [id]
+ * @property {string} [label]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Images
+ * @property {string[]} [android]
+ * @property {string[]} [desktop]
+ * @property {string[]} [ios]
+ * @property {string[]} [thumbnail]
+ */
+
+/**
+ * @typedef Information
+ * @property {string} [description]
+ * @property {string[]} [features]
+ * @property {Images} [images]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef Light
+ * @property {string} [file]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef ListSchemaItem
+ * @property {Object} [global_config]
+ * @property {string} [name]
+ * @property {ConfigPage[]} [page]
+ */
+
+/**
+ * @typedef Medium
+ * @property {string} [file]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef PaginationSchema
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {number} [item_total]
+ * @property {number} [size]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Preset
+ * @property {AvailablePageSchema[]} [pages]
+ */
+
+/**
+ * @typedef Regular
+ * @property {string} [file]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef Sections
+ * @property {string} [attributes]
+ */
+
+/**
+ * @typedef SemiBold
+ * @property {string} [file]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef Src
+ * @property {string} [link]
+ */
+
+/**
+ * @typedef ThemesListingResponseSchema
+ * @property {ThemesSchema[]} [items]
+ * @property {PaginationSchema} [page]
+ */
+
+/**
+ * @typedef ThemesSchema
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {boolean} [applied]
+ * @property {boolean} [archived]
+ * @property {AssetsSchema} [assets]
+ * @property {availableSectionSchema[]} [available_sections]
+ * @property {Colors} [colors]
+ * @property {Config} [config]
+ * @property {string} [created_at]
+ * @property {boolean} [customized]
+ * @property {Font} [font]
+ * @property {Information} [information]
+ * @property {string} [parent_theme]
+ * @property {string} [parent_theme_version]
+ * @property {boolean} [published]
+ * @property {Src} [src]
+ * @property {Object} [styles]
+ * @property {string[]} [tags]
+ * @property {string} [updated_at]
+ * @property {string} [version]
+ */
+
+/**
+ * @typedef UmdJs
+ * @property {string} [link]
+ * @property {string[]} [links]
+ */
+
+/**
+ * @typedef UpgradableThemeSchema
+ * @property {string} [applied_theme]
+ * @property {string} [parent_theme]
+ * @property {boolean} [upgrade]
+ */
+
+/**
+ * @typedef Variants
+ * @property {Bold} [bold]
+ * @property {Light} [light]
+ * @property {Medium} [medium]
+ * @property {Regular} [regular]
+ * @property {SemiBold} [semi_bold]
+ */
+
+class ThemePlatformModel {
+  /** @returns {AddThemeRequestSchema} */
   static AddThemeRequestSchema() {
     return Joi.object({
       theme_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AllAvailablePageSchema} */
   static AllAvailablePageSchema() {
     return Joi.object({
-      pages: Joi.array().items(ThemeModel.AvailablePageSchema()),
+      pages: Joi.array().items(ThemePlatformModel.AvailablePageSchema()),
     });
   }
+
+  /** @returns {AssetsSchema} */
   static AssetsSchema() {
     return Joi.object({
-      common_js: ThemeModel.CommonJs(),
-      css: ThemeModel.Css(),
-      umd_js: ThemeModel.UmdJs(),
+      common_js: ThemePlatformModel.CommonJs(),
+      css: ThemePlatformModel.Css(),
+      umd_js: ThemePlatformModel.UmdJs(),
     });
   }
+
+  /** @returns {AvailablePagePredicate} */
   static AvailablePagePredicate() {
     return Joi.object({
-      route: ThemeModel.AvailablePageRoutePredicate(),
-      screen: ThemeModel.AvailablePageScreenPredicate(),
-      user: ThemeModel.AvailablePageUserPredicate(),
+      route: ThemePlatformModel.AvailablePageRoutePredicate(),
+      screen: ThemePlatformModel.AvailablePageScreenPredicate(),
+      user: ThemePlatformModel.AvailablePageUserPredicate(),
     });
   }
+
+  /** @returns {AvailablePageRoutePredicate} */
   static AvailablePageRoutePredicate() {
     return Joi.object({
       exact_url: Joi.string().allow(""),
@@ -32,32 +372,40 @@ class ThemeModel {
       selected: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AvailablePageSchema} */
   static AvailablePageSchema() {
     return Joi.object({
       _id: Joi.string().allow(""),
       path: Joi.string().allow(""),
       props: Joi.array().items(Joi.any()),
-      sections: Joi.array().items(ThemeModel.AvailablePageSchemaSections()),
+      sections: Joi.array().items(
+        ThemePlatformModel.AvailablePageSchemaSections()
+      ),
       sections_meta: Joi.array().items(
-        ThemeModel.AvailablePageSectionMetaAttributes()
+        ThemePlatformModel.AvailablePageSectionMetaAttributes()
       ),
-      seo: ThemeModel.AvailablePageSeo(),
+      seo: ThemePlatformModel.AvailablePageSeo(),
       text: Joi.string().allow(""),
       theme: Joi.string().allow(""),
       type: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AvailablePageSchemaSections} */
   static AvailablePageSchemaSections() {
     return Joi.object({
       blocks: Joi.array().items(Joi.any()),
       label: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      predicate: ThemeModel.AvailablePagePredicate(),
+      predicate: ThemePlatformModel.AvailablePagePredicate(),
       preset: Joi.any(),
       props: Joi.any(),
     });
   }
+
+  /** @returns {AvailablePageScreenPredicate} */
   static AvailablePageScreenPredicate() {
     return Joi.object({
       desktop: Joi.boolean(),
@@ -65,11 +413,15 @@ class ThemeModel {
       tablet: Joi.boolean(),
     });
   }
+
+  /** @returns {AvailablePageSectionMetaAttributes} */
   static AvailablePageSectionMetaAttributes() {
     return Joi.object({
       attributes: Joi.any(),
     });
   }
+
+  /** @returns {AvailablePageSeo} */
   static AvailablePageSeo() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -77,42 +429,56 @@ class ThemeModel {
       title: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AvailablePageUserPredicate} */
   static AvailablePageUserPredicate() {
     return Joi.object({
       anonymous: Joi.boolean(),
       authenticated: Joi.boolean(),
     });
   }
+
+  /** @returns {availableSectionSchema} */
   static availableSectionSchema() {
     return Joi.object({
-      blocks: Joi.array().items(ThemeModel.Blocks()),
+      blocks: Joi.array().items(ThemePlatformModel.Blocks()),
       label: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      props: Joi.array().items(ThemeModel.BlocksProps()),
+      props: Joi.array().items(ThemePlatformModel.BlocksProps()),
     });
   }
+
+  /** @returns {BlitzkriegApiErrorSchema} */
   static BlitzkriegApiErrorSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {BlitzkriegInternalServerErrorSchema} */
   static BlitzkriegInternalServerErrorSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {BlitzkriegNotFoundSchema} */
   static BlitzkriegNotFoundSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Blocks} */
   static Blocks() {
     return Joi.object({
       name: Joi.string().allow(""),
-      props: Joi.array().items(ThemeModel.BlocksProps()),
+      props: Joi.array().items(ThemePlatformModel.BlocksProps()),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {BlocksProps} */
   static BlocksProps() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -120,12 +486,16 @@ class ThemeModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Bold} */
   static Bold() {
     return Joi.object({
       file: Joi.string().allow(""),
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Colors} */
   static Colors() {
     return Joi.object({
       accent_color: Joi.string().allow(""),
@@ -136,53 +506,69 @@ class ThemeModel {
       secondary_color: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CommonJs} */
   static CommonJs() {
     return Joi.object({
       link: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Config} */
   static Config() {
     return Joi.object({
       current: Joi.string().allow(""),
-      global_schema: ThemeModel.GlobalSchema(),
-      list: Joi.array().items(ThemeModel.ListSchemaItem()),
-      preset: ThemeModel.Preset(),
+      global_schema: ThemePlatformModel.GlobalSchema(),
+      list: Joi.array().items(ThemePlatformModel.ListSchemaItem()),
+      preset: ThemePlatformModel.Preset(),
     });
   }
+
+  /** @returns {ConfigPage} */
   static ConfigPage() {
     return Joi.object({
       page: Joi.string().allow(""),
       settings: Joi.any(),
     });
   }
+
+  /** @returns {Css} */
   static Css() {
     return Joi.object({
       link: Joi.string().allow(""),
       links: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {Custom} */
   static Custom() {
     return Joi.object({
       props: Joi.any(),
     });
   }
+
+  /** @returns {Font} */
   static Font() {
     return Joi.object({
       family: Joi.string().allow(""),
-      variants: ThemeModel.Variants(),
+      variants: ThemePlatformModel.Variants(),
     });
   }
+
+  /** @returns {FontsSchema} */
   static FontsSchema() {
     return Joi.object({
-      items: ThemeModel.FontsSchemaItems(),
+      items: ThemePlatformModel.FontsSchemaItems(),
       kind: Joi.string().allow(""),
     });
   }
+
+  /** @returns {FontsSchemaItems} */
   static FontsSchemaItems() {
     return Joi.object({
       category: Joi.string().allow(""),
       family: Joi.string().allow(""),
-      files: ThemeModel.FontsSchemaItemsFiles(),
+      files: ThemePlatformModel.FontsSchemaItemsFiles(),
       kind: Joi.string().allow(""),
       last_modified: Joi.string().allow(""),
       subsets: Joi.array().items(Joi.string().allow("")),
@@ -190,6 +576,8 @@ class ThemeModel {
       version: Joi.string().allow(""),
     });
   }
+
+  /** @returns {FontsSchemaItemsFiles} */
   static FontsSchemaItemsFiles() {
     return Joi.object({
       bold: Joi.string().allow(""),
@@ -197,11 +585,15 @@ class ThemeModel {
       regular: Joi.string().allow(""),
     });
   }
+
+  /** @returns {GlobalSchema} */
   static GlobalSchema() {
     return Joi.object({
-      props: Joi.array().items(ThemeModel.GlobalSchemaProps()),
+      props: Joi.array().items(ThemePlatformModel.GlobalSchemaProps()),
     });
   }
+
+  /** @returns {GlobalSchemaProps} */
   static GlobalSchemaProps() {
     return Joi.object({
       category: Joi.string().allow(""),
@@ -210,6 +602,8 @@ class ThemeModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Images} */
   static Images() {
     return Joi.object({
       android: Joi.array().items(Joi.string().allow("")),
@@ -218,33 +612,43 @@ class ThemeModel {
       thumbnail: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {Information} */
   static Information() {
     return Joi.object({
       description: Joi.string().allow(""),
       features: Joi.array().items(Joi.string().allow("")),
-      images: ThemeModel.Images(),
+      images: ThemePlatformModel.Images(),
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Light} */
   static Light() {
     return Joi.object({
       file: Joi.string().allow(""),
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ListSchemaItem} */
   static ListSchemaItem() {
     return Joi.object({
       global_config: Joi.any(),
       name: Joi.string().allow(""),
-      page: Joi.array().items(ThemeModel.ConfigPage()),
+      page: Joi.array().items(ThemePlatformModel.ConfigPage()),
     });
   }
+
+  /** @returns {Medium} */
   static Medium() {
     return Joi.object({
       file: Joi.string().allow(""),
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PaginationSchema} */
   static PaginationSchema() {
     return Joi.object({
       current: Joi.number(),
@@ -254,39 +658,53 @@ class ThemeModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Preset} */
   static Preset() {
     return Joi.object({
-      pages: Joi.array().items(ThemeModel.AvailablePageSchema()),
+      pages: Joi.array().items(ThemePlatformModel.AvailablePageSchema()),
     });
   }
+
+  /** @returns {Regular} */
   static Regular() {
     return Joi.object({
       file: Joi.string().allow(""),
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Sections} */
   static Sections() {
     return Joi.object({
       attributes: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SemiBold} */
   static SemiBold() {
     return Joi.object({
       file: Joi.string().allow(""),
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Src} */
   static Src() {
     return Joi.object({
       link: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ThemesListingResponseSchema} */
   static ThemesListingResponseSchema() {
     return Joi.object({
-      items: Joi.array().items(ThemeModel.ThemesSchema()),
-      page: ThemeModel.PaginationSchema(),
+      items: Joi.array().items(ThemePlatformModel.ThemesSchema()),
+      page: ThemePlatformModel.PaginationSchema(),
     });
   }
+
+  /** @returns {ThemesSchema} */
   static ThemesSchema() {
     return Joi.object({
       __v: Joi.number(),
@@ -294,32 +712,36 @@ class ThemeModel {
       application: Joi.string().allow(""),
       applied: Joi.boolean(),
       archived: Joi.boolean(),
-      assets: ThemeModel.AssetsSchema(),
+      assets: ThemePlatformModel.AssetsSchema(),
       available_sections: Joi.array().items(
-        ThemeModel.availableSectionSchema()
+        ThemePlatformModel.availableSectionSchema()
       ),
-      colors: ThemeModel.Colors(),
-      config: ThemeModel.Config(),
+      colors: ThemePlatformModel.Colors(),
+      config: ThemePlatformModel.Config(),
       created_at: Joi.string().allow(""),
       customized: Joi.boolean(),
-      font: ThemeModel.Font(),
-      information: ThemeModel.Information(),
+      font: ThemePlatformModel.Font(),
+      information: ThemePlatformModel.Information(),
       parent_theme: Joi.string().allow(""),
       parent_theme_version: Joi.string().allow(""),
       published: Joi.boolean(),
-      src: ThemeModel.Src(),
+      src: ThemePlatformModel.Src(),
       styles: Joi.any(),
       tags: Joi.array().items(Joi.string().allow("")),
       updated_at: Joi.string().allow(""),
       version: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UmdJs} */
   static UmdJs() {
     return Joi.object({
       link: Joi.string().allow(""),
       links: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {UpgradableThemeSchema} */
   static UpgradableThemeSchema() {
     return Joi.object({
       applied_theme: Joi.string().allow(""),
@@ -327,14 +749,16 @@ class ThemeModel {
       upgrade: Joi.boolean(),
     });
   }
+
+  /** @returns {Variants} */
   static Variants() {
     return Joi.object({
-      bold: ThemeModel.Bold(),
-      light: ThemeModel.Light(),
-      medium: ThemeModel.Medium(),
-      regular: ThemeModel.Regular(),
-      semi_bold: ThemeModel.SemiBold(),
+      bold: ThemePlatformModel.Bold(),
+      light: ThemePlatformModel.Light(),
+      medium: ThemePlatformModel.Medium(),
+      regular: ThemePlatformModel.Regular(),
+      semi_bold: ThemePlatformModel.SemiBold(),
     });
   }
 }
-module.exports = ThemeModel;
+module.exports = ThemePlatformModel;