configurations and test-sample added

cresteem · Apr 22, 2024 · 8b85f14 · 8b85f14
commit 8b85f14
Show file tree

Hide file tree

Showing 29 changed files with 3,119 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,10 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,7 @@
+{
+	"parser": "@typescript-eslint/parser",
+	"plugins": ["@typescript-eslint"],
+	"rules": {
+	  "@typescript-eslint/explicit-function-return-type": "error"
+	}
+  }
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,15 @@
+{
+
+  "bracketSameLine": true,
+  "semi": true,
+  "proseWrap": "always",
+  "printWidth": 75,
+  "arrowParens": "always",
+  "singleAttributePerLine": true,
+  "trailingComma": "all",
+  "embeddedLanguageFormatting": "auto",
+  "experimentalTernaries": true,
+  "parser": "typescript",
+  "tabWidth": 2,
+  "useTabs": true
+}
diff --git a/NAs.txt b/NAs.txt
@@ -0,0 +1,24 @@
+!# marked item are under development
+
+Book Action !#
+DataSet
+Discussion and Forum
+Education Q&A !#
+Employer Aggregate Rating !#
+Image MetaData !#
+Job Posting !#
+Math Solver
+Practice Problem
+Q&A not FAQ
+Special Announcement
+Subscription & Pay walled content !#
+Vocational renting !#
+Vehicle Listing !#
+
+
+##########################################################################
+# Omitted Structured Data as either Not Helpful or inefficient are below #
+##########################################################################
+!warning "This is only our team opinion"
+1.Speakable 
+2.Fact Check
diff --git a/package.json b/package.json
@@ -0,0 +1,58 @@
+{
+	"name": "@cresteem/richie-js",
+	"displayName": "Richie JS",
+	"exports": {
+		".": "./dist/richie.js"
+	},
+	"description": "Rich Result Generator",
+	"version": "0.1a",
+	"main": "./dist/richie.js",
+	"types": "./dist/types/",
+	"files": [
+		"dist"
+	],
+	"directories": {
+		"lib": "./dist/lib"
+	},
+	"dist": {
+		"shasum": "not added"
+	},
+	"icon": "not added",
+	"engines": {"node": ">=21.7.3","npm":">=10.50.0"},
+	"engineStrict": false,
+	"preferGlobal": true,
+	"scripts": {
+		"build": "rimraf dist && npx tsc -b",
+		"watch": "npx tsc --watch"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/cresteem/Richie-JS.git"
+	},
+	"keywords": [
+		"Rich",
+		"Result",
+		"Generator"
+	],
+	"author": "@cresteem",
+	"license": "UNLICENCED",
+	"maintainers": ["@cresteem","@iamspdarsan"],
+	"bugs": {
+		"url": "https://github.com/cresteem/Richie-JS/issues"
+	},
+	"homepage": "https://github.com/cresteem/Richie-JS#readme",
+	"dependencies": {
+		"@prettier/sync": "^0.5.1",
+		"axios": "^1.6.7",
+		"cheerio": "^1.0.0-rc.12",
+		"country-list": "^2.3.0",
+		"luxon": "^3.4.4",
+		"puppeteer": "^22.3.0",
+		"typescript": "^5.4.5"
+	},
+	"devDependencies": {
+		"@types/country-list": "^2.1.4",
+		"@types/luxon": "^3.4.2",
+		"@typescript-eslint/eslint-plugin": "^7.7.0"
+	}
+}
diff --git a/richie.config.json b/richie.config.json
@@ -0,0 +1,24 @@
+{
+      "aggregator": {
+        "timeFormat": "yyyy-MM-dd hh:mm a",
+        "authorBasename": "rauthor",
+        "pubBasename": "rpub",
+        "movieBasename": "rmovie",
+        "domainAddress": "cresteem.com",
+        "recipeBaseID": "rrecipe",
+        "courseBaseID": "rcourse",
+        "restaurantBaseID": "rrest",
+        "faqBaseID": "rfaq",
+        "siteSearchBoxFieldName": "query_str",
+        "softwareAppBaseID": "rsapp",
+        "videoBaseID": "rvid",
+        "localBusinessBaseID": "rlb",
+        "organisationBaseID": "rorg",
+        "profileBaseID": "rpp",
+        "eventBaseID": "revent",
+        "productBaseID": "rprod",
+        "productPriceValidUntilNext": "30", 
+        "productGroupIDHashLength": "128", 
+        "producrVariableDelimiter": "|"
+      }
+}
diff --git a/test-sample/article.html b/test-sample/article.html
@@ -0,0 +1,43 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Article about test</title>
+    <link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
+  </head>
+
+  <body data-articletype="NewsArticle">
+    <p class="pub-dt">2024-06-06 08:37 PM</p>
+    <p class="mod-dt">2024-02-26 05:23 PM</p>
+    <main>
+      <img
+        src="https://cdn.britannica.com/22/187222-050-07B17FB6/apples-on-a-tree-branch.jpg"
+        alt=""
+        class="rich-thumb"
+      />
+      <img
+        src="https://media.licdn.com/dms/image/D5603AQEuP5Pn5X2RWQ/profile-displayphoto-shrink_800_800/0/1706536645940?e=2147483647&v=beta&t=nRJZKKhqCP76WVDDJZ71OfbbyGPpJdO79IOabHMpX_I"
+        alt=""
+        class="rich-thumb"
+      />
+      <p class="rauthor-1-name">Dr.Darsan</p>
+      <p class="rauthor-1-type">Person</p>
+      <a class="rauthor-1-url" href="https://www.instagram.com/iamspdarsan/"
+        >User Profile</a
+      >
+      <p class="rauthor-1-jobtitle">Software Engineer</p>
+
+      <p class="rauthor-2-name">Winchester</p>
+      <p class="rauthor-2-type">Organization</p>
+      <a class="rauthor-2-url" href="https://www.linkedin.com/in/iamspdarsan/"
+        >User Profile</a
+      >
+      <p class="rpub-1-name">Cresteem</p>
+      <a class="rpub-1-url" href="https://cresteem.com/blogs/"></a>
+
+      <p class="rpub-2-name">Google</p>
+      <a class="rpub-2-url" href="https://google.com/blogs/"></a>
+    </main>
+  </body>
+</html>
diff --git a/test-sample/breadcrumb.html b/test-sample/breadcrumb.html
@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Destination Page</title>
+  </head>
+  <body></body>
+</html>
diff --git a/test-sample/carousels/courses.html b/test-sample/carousels/courses.html
@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Courses</title>
+</head>
+
+<body>
+    <main>
+        <div id="rcourse-1">
+            <p class="rcourse-1-name" data-lang="English">Python Crash Course</p>
+            <!-- "By<space>" can be added or not in instructor inner text-->
+            <p class="rcourse-1-ins">By InstructorX</p>
+            <p class="rcourse-1-mode">online</p>
+            <p class="rcourse-1-desc">This course serves as an introduction to Python programming, covering essential
+                concepts and skills necessary for beginners to start coding in Python. Participants will learn about
+                basic syntax, data types, control flow structures, functions, and file handling. Additionally, the
+                course will cover key Python libraries and modules for common tasks such as data manipulation,
+                visualization, and working with external files. Throughout the course, hands-on exercises and projects
+                will reinforce learning objectives, allowing participants to apply their newfound knowledge to
+                real-world scenarios.</p>
+            <p class="rcourse-1-duration" data-freq="monthly" data-rep="8">68 Hours</p>
+            <p class="rcourse-1-price" data-currency="usd">100 USD</p>
+            <a class="rcourse-1-purl" href="https://cresteem.com/">
+                <p class="rcourse-1-pub">cresteem</p>
+            </a>
+        </div>
+
+        <div id="rcourse-2">
+            <p class="rcourse-2-name" data-lang="Tamil">Node.Js introduction</p>
+            <!-- "By<space>" can be added or not in instructor inner text-->
+            <p class="rcourse-2-ins">By InstructorZ</p>
+            <p class="rcourse-2-mode">onsite</p>
+            <p class="rcourse-2-desc">This course provides a comprehensive introduction to Node.js, a popular runtime
+                environment for executing JavaScript code server-side. Participants will learn how to build scalable,
+                high-performance web applications using Node.js, leveraging its asynchronous, event-driven architecture.
+                The course covers essential concepts such as event loops, modules, package management, and asynchronous
+                programming patterns. Additionally, participants will explore key Node.js frameworks and libraries for
+                web development, including Express.js for building web servers and handling HTTP requests. Hands-on
+                exercises and projects will reinforce learning objectives, allowing participants to apply their
+                knowledge to real-world scenarios.</p>
+            <p class="rcourse-2-duration" data-freq="daily" data-rep="4">24 Hours</p>
+            <p class="rcourse-2-price" data-currency="usd">2000 USD</p>
+            <a class="rcourse-2-purl" href="https://edureka.com/">
+                <p class="rcourse-2-pub">edureka</p>
+            </a>
+        </div>
+
+        <!-- non data option for lang -->
+        <div id="rcourse-3">
+            <p class="rcourse-3-name" data-lang="Tamil">Java Intermediate to Advanced</p>
+            <!-- "By<space>" can be added or not in instructor inner text-->
+            <p class="rcourse-3-ins">Meg</p>
+            <p class="rcourse-3-mode">online</p>
+            <p class="rcourse-3-lang">English</p>
+            <p class="rcourse-3-desc">This course offers a comprehensive introduction to Java programming, covering core
+                concepts and principles essential for beginners to embark on their journey in Java development.
+                Participants will learn about Java syntax, object-oriented programming (OOP), control flow structures,
+                exception handling, and input/output operations. Additionally, the course will cover key Java libraries
+                and frameworks, providing a solid foundation for developing robust, scalable applications. Hands-on
+                exercises and projects will reinforce learning objectives, enabling participants to apply their
+                knowledge to practical scenarios.</p>
+            <p class="rcourse-3-duration" data-freq="daily" data-rep="7">1 Months</p>
+            <p class="rcourse-3-price" data-currency="inr">2000 RS</p>
+            <a class="rcourse-3-purl" href="https://oracle.com/">
+                <p class="rcourse-3-pub">oracle</p>
+            </a>
+        </div>
+    </main>
+</body>
+
+</html>
diff --git a/test-sample/carousels/movies.html b/test-sample/carousels/movies.html
@@ -0,0 +1,71 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Movies</title>
+  </head>
+  <body>
+    <div id="rmovie-1">
+      <p class="rmovie-1-name">Dawn of Justice</p>
+      <img
+        class="rmovie-1-img"
+        src="https://miro.medium.com/v2/resize:fit:7680/1*IC3vGBv9v2l4Pll4v3CNSw.jpeg"
+        alt=""
+      />
+      <p class="rmovie-1-dc">2016-02-05</p>
+      <p class="rmovie-1-dir">Zack Synder</p>
+      <div class="aggrate-info">
+        <!-- aggregate rate that got -->
+        <p class="rmovie-1-arv">100</p>
+
+        <!-- max possibly rate -->
+        <p class="rmovie-1-arl">100</p>
+
+        <p class="rmovie-1-arc">1000</p>
+        <div class="userreviews">
+          <div class="rmovie-1-urate">
+            <p class="rname">Darsan</p>
+            <p class="br">100</p>
+            <p class="rt">98</p>
+            <p class="rpname">IMDB</p>
+          </div>
+
+          <div class="rmovie-1-urate">
+            <p class="rname">Priya</p>
+            <p class="br">100</p>
+            <p class="rt">98</p>
+            <p class="rpname">IMDB</p>
+          </div>
+        </div>
+      </div>
+    </div>
+
+    <div id="rmovie-2">
+      <p class="rmovie-2-name">The Dark Knight Rises</p>
+      <img
+        class="rmovie-2-img"
+        src="https://variety.com/wp-content/uploads/2013/07/dark_knight_rises.jpg"
+        alt=""
+      />
+      <p class="rmovie-2-dc">2010-11-03</p>
+      <p class="rmovie-2-dir">C.Nolan</p>
+      <div class="aggrate-info">
+        <!-- aggregate rate that got -->
+        <p class="rmovie-2-arv">98</p>
+
+        <!-- max possibly rate -->
+        <p class="rmovie-2-arl">100</p>
+
+        <p class="rmovie-2-arc">1000</p>
+      </div>
+
+      <div class="rmovie-2-urate">
+        <p class="rname">Dean</p>
+        <p class="br">100</p>
+        <p class="rt">90</p>
+        <p class="rpname">Rotten Tomato</p>
+      </div>
+    </div>
+  </body>
+</html>