@react-pakistan/util-functions 1.22.11 → 1.22.13

package/general/generate-blog-schema.d.ts

@@ -0,0 +1,34 @@
+/**
+ * A util function to create Rich Schema for FAQ
+ *
+ * @returns formatted date - Saturday, 11/01/2020
+ * @author Taimoor Khan
+ * @remarks AppCorp
+ */
+/** End file docs */
+interface Blog {
+    authorImage: string;
+    authorName: string;
+    banner: string;
+    createdAt: string;
+    excerpt: string;
+    title: string;
+    updatedAt: string;
+    url: string;
+}
+export declare const generateBlogSchema: ({ authorImage, authorName, banner, createdAt, excerpt, title, updatedAt, url, }: Blog) => {
+    "@context": string;
+    "@type": string;
+    headline: string;
+    dateModified: string;
+    datePublished: string;
+    description: string;
+    image: string;
+    url: string;
+    author: {
+        "@type": string;
+        name: string;
+        url: string;
+    };
+};
+export {};

package/general/generate-blog-schema.js

@@ -0,0 +1,22 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateBlogSchema = void 0;
+const generateBlogSchema = ({ authorImage, authorName, banner, createdAt, excerpt, title, updatedAt, url, }) => {
+    return {
+        "@context": "https://schema.org",
+        "@type": "BlogPosting",
+        "headline": `${title}`,
+        "dateModified": `${updatedAt}`,
+        "datePublished": `${createdAt}`,
+        "description": `${excerpt}`,
+        "image": `${banner}`,
+        "url": `${url}`,
+        "author": {
+            "@type": "Person",
+            "name": `${authorName}`,
+            "url": `${authorImage}`,
+        },
+    };
+};
+exports.generateBlogSchema = generateBlogSchema;

package/general/generate-breadcrumb-schema.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A util function to create Rich Schema for Breadcrumbs
+ *
+ * @returns formatted date - Saturday, 11/01/2020
+ * @author Taimoor Khan
+ * @remarks AppCorp
+ */
+/** End file docs */
+export declare const generateBreadcrumbSchema: (arr: Array<string>, baseUrl: string) => {
+    "@context": string;
+    "@type": string;
+    itemListElement: {
+        "@type": string;
+        position: number;
+        name: string;
+        item: string;
+    }[];
+};

package/general/generate-breadcrumb-schema.js

@@ -0,0 +1,35 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateBreadcrumbSchema = void 0;
+/**
+ * A util function to create Rich Schema for Breadcrumbs
+ *
+ * @returns formatted date - Saturday, 11/01/2020
+ * @author Taimoor Khan
+ * @remarks AppCorp
+ */
+/** End file docs */
+const generateBreadcrumbSchema = (arr, baseUrl) => {
+    const items = arr.map((text, index) => {
+        let urlItem = '';
+        if (text === 'Home') {
+            urlItem = baseUrl;
+        }
+        else {
+            urlItem = `${baseUrl}/${text.toLowerCase()}`;
+        }
+        return ({
+            "@type": "ListItem",
+            "position": index + 1,
+            "name": text,
+            "item": urlItem,
+        });
+    });
+    return {
+        "@context": "https://schema.org",
+        "@type": "BreadcrumbList",
+        "itemListElement": items,
+    };
+};
+exports.generateBreadcrumbSchema = generateBreadcrumbSchema;

package/general/generate-faq-schema.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A util function to create Rich Schema for FAQ
+ *
+ * @returns formatted date - Saturday, 11/01/2020
+ * @author Taimoor Khan
+ * @remarks AppCorp
+ */
+/** End file docs */
+interface FAQ {
+    answer: string;
+    question: string;
+}
+export declare const generateFAQSchema: (arr: Array<FAQ>) => {
+    "@context": string;
+    "@type": string;
+    mainEntity: {
+        "@type": string;
+        name: string;
+        acceptedAnswer: {
+            "@type": string;
+            text: string;
+        };
+    }[];
+};
+export {};

package/general/generate-faq-schema.js

@@ -0,0 +1,22 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateFAQSchema = void 0;
+const generateFAQSchema = (arr) => {
+    const items = arr.map(({ answer, question }) => {
+        return ({
+            "@type": "Question",
+            "name": question,
+            "acceptedAnswer": {
+                "@type": "Answer",
+                "text": `<p>${answer}</p>`
+            },
+        });
+    });
+    return {
+        "@context": "https://schema.org",
+        "@type": "FAQPage",
+        "mainEntity": items,
+    };
+};
+exports.generateFAQSchema = generateFAQSchema;

package/general/generate-organization-schema.d.ts

@@ -0,0 +1,44 @@
+/**
+ * A util function to create Rich Schema for Organization
+ *
+ * @returns formatted date - Saturday, 11/01/2020
+ * @author Taimoor Khan
+ * @remarks AppCorp
+ */
+/** End file docs */
+interface Organization {
+    addressCountry: string;
+    addressLocality: string;
+    addressRegion: string;
+    appName: string;
+    baseUrl: string;
+    description: string;
+    email: string;
+    image: string;
+    logo: string;
+    postalCode: string;
+    sameAsArr: Array<string>;
+    streetAddress: string;
+    telephone: string;
+}
+export declare const generateOrganizationSchema: ({ addressCountry, addressLocality, addressRegion, appName, baseUrl, description, email, image, logo, postalCode, sameAsArr, streetAddress, telephone, }: Organization) => {
+    "@context": string;
+    "@type": string;
+    image: string;
+    url: string;
+    sameAs: string[];
+    logo: string;
+    name: string;
+    description: string;
+    email: string;
+    telephone: string;
+    address: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressCountry: string;
+        addressRegion: string;
+        postalCode: string;
+    };
+};
+export {};

package/general/generate-organization-schema.js

@@ -0,0 +1,27 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOrganizationSchema = void 0;
+const generateOrganizationSchema = ({ addressCountry, addressLocality, addressRegion, appName, baseUrl, description, email, image, logo, postalCode, sameAsArr, streetAddress, telephone, }) => {
+    return {
+        "@context": "https://schema.org",
+        "@type": "Organization",
+        "image": `${image}`,
+        "url": `${baseUrl}`,
+        "sameAs": sameAsArr,
+        "logo": `${logo}`,
+        "name": `${appName}`,
+        "description": `${description}`,
+        "email": `${email}`,
+        "telephone": `${telephone}`,
+        "address": {
+            "@type": "PostalAddress",
+            "streetAddress": `${streetAddress}`,
+            "addressLocality": `${addressLocality}`,
+            "addressCountry": `${addressCountry}`,
+            "addressRegion": `${addressRegion}`,
+            "postalCode": `${postalCode}`,
+        },
+    };
+};
+exports.generateOrganizationSchema = generateOrganizationSchema;

package/general/index.d.ts

@@ -5,6 +5,8 @@ export * from './check-even-odd-length';
 export * from './countries';
 export * from './currencies';
 export * from './format-date';
+export * from './generate-breadcrumb-schema';
+export * from './generate-faq-schema';
 export * from './generate-grid';
 export * from './get-day-name';
 export * from './get-href';

package/general/index.js

@@ -22,6 +22,8 @@ __exportStar(require("./check-even-odd-length"), exports);
 __exportStar(require("./countries"), exports);
 __exportStar(require("./currencies"), exports);
 __exportStar(require("./format-date"), exports);
+__exportStar(require("./generate-breadcrumb-schema"), exports);
+__exportStar(require("./generate-faq-schema"), exports);
 __exportStar(require("./generate-grid"), exports);
 __exportStar(require("./get-day-name"), exports);
 __exportStar(require("./get-href"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-pakistan/util-functions",
-  "version": "1.22.11",
+  "version": "1.22.13",
   "description": "A library of all util functions",
   "main": "index.js",
   "scripts": {