@anywayseo/tools 6.0.0 → 6.2.0

package/dist/types/content/seo/index.d.ts

@@ -1,11 +1,29 @@
-export interface ISeoMetadata {
-    title: string;
-    description: string;
+import { Nullable } from '../../common';
+import { ILocale } from '../../i18n';
+/** Meta */
+export interface ISeoMetaItemPlaceholders {
+    siteName: string;
+    currentYear: string;
+    currentMonth: string;
+}
+type SeoMetaItemGetter = (placeholders: ISeoMetaItemPlaceholders) => string;
+export type SeoMetaItem = string | SeoMetaItemGetter;
+export interface ISeoMetadata<T = string> {
+    title: T;
+    description: T;
 }
+/** Href Langs */
 export interface IHrefLang {
     href: string;
     hrefLang: string;
 }
+/** Structured Data */
+interface IStructuredDataImage {
+    url: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+}
 interface IStructuredDataAuthor {
     name: string;
     url?: string;
@@ -21,10 +39,12 @@ interface IStructuredDataReview {
     publishedAt: string;
     updatedAt?: string;
     rating?: IStructuredDataRating;
+    image?: IStructuredDataImage;
 }
 interface IStructuredDataGame {
     name: string;
     genre?: string;
+    image?: IStructuredDataImage;
 }
 export interface IStructuredDataContent {
     author?: IStructuredDataAuthor;
@@ -38,4 +58,37 @@ export interface IStructuredData {
     entity: StructuredDataEntity;
     content: IStructuredDataContent;
 }
+/** Open Graph */
+interface IOpenGraphImageData {
+    url: string;
+    alt: string;
+    width?: number;
+    height?: number;
+}
+interface IOpenGraphArticleData {
+    createdAt: string;
+    updatedAt: string;
+    author?: string;
+    section?: string;
+    tags?: string[];
+}
+interface IOpenGraphContent {
+    image?: IOpenGraphImageData;
+    article?: IOpenGraphArticleData;
+}
+interface IOpenGraphOptions {
+    withTwitterCard?: boolean;
+}
+export interface IOpenGraph {
+    content: IOpenGraphContent;
+    options?: IOpenGraphOptions;
+}
+export interface ISeo {
+    lang?: Nullable<ILocale['code']>;
+    meta?: Nullable<ISeoMetadata<Nullable<SeoMetaItem>>>;
+    canonicalUrl?: Nullable<string>;
+    hrefLangs?: Nullable<IHrefLang[]>;
+    structuredData?: Nullable<IStructuredData>;
+    openGraph?: Nullable<IOpenGraph>;
+}
 export {};

package/dist/types/i18n/index.d.ts

@@ -1,4 +1,4 @@
-export type LanguageCode = 'en' | 'es' | 'it' | 'de' | 'fr' | 'ru' | 'pt' | 'ka' | 'fi' | 'bg' | 'da';
+export type LanguageCode = 'en' | 'es' | 'it' | 'de' | 'fr' | 'ru' | 'pt' | 'ka' | 'fi' | 'bg' | 'da' | 'bn' | 'nl' | 'hu' | 'el' | 'nb' | 'pl' | 'ro' | 'sr' | 'tr' | 'uz' | 'cs' | 'sv';
 type SpanishSpeakingCurrencyCode = 'ARS' | 'BOB' | 'CLP' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'USD' | 'BTC' | 'XAF' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PYG' | 'PEN' | 'EUR' | 'UYU' | 'VES';
 export type Currency = 'USD' | 'EUR' | 'GBP' | 'RUB' | 'BRL' | SpanishSpeakingCurrencyCode;
 type LocaleCode = string;

package/dist/types/index.d.ts

@@ -3,6 +3,6 @@ export * from './common';
 export * from './components';
 export * from './content';
 export * from './i18n';
-export * from './json-ld';
+export * from './seo';
 export * from './site';
 export * from './theme';

package/dist/types/seo/index.d.ts

@@ -0,0 +1,2 @@
+export * from './json-ld';
+export * from './open-graph';

package/dist/types/seo/open-graph/index.d.ts

@@ -0,0 +1,11 @@
+type OpenGraphImageMetaTag = 'image' | 'image:alt' | 'image:width' | 'image:height';
+type OpenGraphArticleMetaTag = 'article:published_time' | 'article:modified_time' | 'article:author' | 'article:section' | 'article:tag';
+type OpenGraphSiteMetaTag = 'site_name' | 'locale';
+type OpenGraphPageMetaTag = 'type' | 'url' | 'title' | 'description' | OpenGraphImageMetaTag | OpenGraphArticleMetaTag;
+type OpenGraphMetaTag = OpenGraphSiteMetaTag | OpenGraphPageMetaTag;
+export type OpenGraphType = 'website' | 'article';
+export interface IOpenGraphMetaItem {
+    property: `og:${OpenGraphMetaTag}`;
+    content: string;
+}
+export {};

package/dist/utils/api/strapi-guards.d.ts

@@ -1,4 +1,5 @@
-import { IStrapiComponentFragment, IStrapiPageContext, IStrapiPageData } from '../../types';
+import { IStrapiComponentFragment, IStrapiPageContext, IStrapiPageData, IStrapiRichText } from '../../types';
 export declare function isStrapiContent(array: unknown): array is IStrapiComponentFragment[];
+export declare function isStrapiRichText(value?: unknown): value is IStrapiRichText;
 export declare function isStrapiPageData(data: unknown): data is Partial<IStrapiPageData>;
 export declare function isStrapiPageContext(context: unknown): context is Partial<IStrapiPageContext>;

package/dist/utils/api/strapi-seo.d.ts

@@ -1,13 +1,2 @@
-import { IHrefLang, ILocale, ISeoMetadata, IStructuredData, Nullable } from '../../types';
-interface ISeoData {
-    locale: Nullable<ILocale['code']>;
-    meta: {
-        title: Nullable<ISeoMetadata['title']>;
-        description: Nullable<ISeoMetadata['description']>;
-    };
-    canonicalUrl: Nullable<string>;
-    hrefLangs: IHrefLang[];
-    structuredData: Nullable<IStructuredData>;
-}
-export declare function extractSeoData(pageData: unknown, pageContext?: unknown): ISeoData;
-export {};
+import { ISeo } from '../../types';
+export declare function buildSeoFromStrapi(pageData: unknown, pageContext?: unknown): ISeo;

package/dist/utils/index.cjs

@@ -1,19 +1,20 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const index = require("../index-C6MG_f24.js");
-const index$1 = require("../index-BJsA8Upb.js");
-const index$2 = require("../index-BU1gLt1p.js");
+const index$1 = require("../index-BKWX6mIo.js");
+const index$2 = require("../index-DHKoOk4o.js");
 const index$3 = require("../index-ov4J7p3D.js");
 const index$4 = require("../index-CAjUjAgI.js");
 const index$5 = require("../index-CbuiYkSg.js");
 exports.Animation = index.Animation;
-exports.extractSeoData = index$1.extractSeoData;
+exports.buildSeoFromStrapi = index$1.buildSeoFromStrapi;
 exports.getLocale = index$1.getLocale;
 exports.getLocales = index$1.getLocales;
 exports.getNavigation = index$1.getNavigation;
 exports.getSiteName = index$1.getSiteName;
 exports.buildGameReviewSchema = index$2.buildGameReviewSchema;
 exports.buildGraph = index$2.buildGraph;
+exports.buildOpenGraphMeta = index$2.buildOpenGraphMeta;
 exports.buildOrganizationSchema = index$2.buildOrganizationSchema;
 exports.buildWebpageSchema = index$2.buildWebpageSchema;
 exports.buildWebsiteSchema = index$2.buildWebsiteSchema;
@@ -23,6 +24,7 @@ exports.getSeededRandomComparator = index$2.getSeededRandomComparator;
 exports.isStrapiContent = index$2.isStrapiContent;
 exports.isStrapiPageContext = index$2.isStrapiPageContext;
 exports.isStrapiPageData = index$2.isStrapiPageData;
+exports.isStrapiRichText = index$2.isStrapiRichText;
 exports.randomComparator = index$2.randomComparator;
 exports.formatDate = index$3.formatDate;
 exports.formatNumber = index$3.formatNumber;

package/dist/utils/index.d.ts

@@ -2,7 +2,7 @@ export * from './animation';
 export * from './api';
 export * from './currency';
 export * from './date';
-export * from './json-ld';
+export * from './seo';
 export * from './navigation';
 export * from './numbers';
 export * from './sorting';

package/dist/utils/index.mjs

@@ -1,6 +1,6 @@
 import { A } from "../index-BJRvnR8Q.mjs";
-import { e, a, b, c, g } from "../index-CUDzMwnz.mjs";
-import { j, c as c2, d, h, e as e2, g as g2, f, k, i, b as b2, a as a2, r } from "../index-0AAkKSsc.mjs";
+import { d, a, b, c, g } from "../index-B--qmL1V.mjs";
+import { k, d as d2, l, e, j, f, g as g2, h, m, i, c as c2, b as b2, a as a2, r } from "../index-BTfTkIed.mjs";
 import { f as f2, b as b3, a as a3, g as g3, r as r2, t } from "../index-BPthShL-.mjs";
 import { a as a4, b as b4, c as c3, i as i2 } from "../index-CQC6DRGf.mjs";
 import { D, L } from "../index-BRVKhbs6.mjs";
@@ -9,29 +9,31 @@ export {
   D as DARK_THEME_COLOR,
   L as LIGHT_THEME_COLOR,
   a4 as buildCanonicalUrl,
-  j as buildGameReviewSchema,
-  c2 as buildGraph,
-  d as buildOrganizationSchema,
+  k as buildGameReviewSchema,
+  d2 as buildGraph,
+  l as buildOpenGraphMeta,
+  e as buildOrganizationSchema,
   b4 as buildPath,
-  h as buildWebpageSchema,
-  e2 as buildWebsiteSchema,
-  e as extractSeoData,
+  d as buildSeoFromStrapi,
+  j as buildWebpageSchema,
+  f as buildWebsiteSchema,
   f2 as formatDate,
   b3 as formatNumber,
   g2 as getCurrencySymbol,
   a3 as getCurrentMonth,
   g3 as getCurrentYear,
-  f as getEntitySchema,
+  h as getEntitySchema,
   a as getLocale,
   b as getLocales,
   c as getNavigation,
-  k as getSeededRandomComparator,
+  m as getSeededRandomComparator,
   g as getSiteName,
   c3 as isAbsolutePath,
   i2 as isRelativePath,
   i as isStrapiContent,
-  b2 as isStrapiPageContext,
-  a2 as isStrapiPageData,
+  c2 as isStrapiPageContext,
+  b2 as isStrapiPageData,
+  a2 as isStrapiRichText,
   r as randomComparator,
   r2 as round,
   t as toFixedTwo

package/dist/utils/seo/index.d.ts

@@ -0,0 +1,2 @@
+export * from './json-ld';
+export * from './open-graph';

package/dist/utils/{json-ld → seo/json-ld}/index.d.ts

@@ -1,4 +1,4 @@
-import { GameSchema, ILocale, ISiteLogo, IStructuredData, Nullable, OrganizationSchema, ReviewSchema, Schema, Schemas, WebPageSchema, WebSiteSchema } from '../../types';
+import { GameSchema, ILocale, ISiteLogo, IStructuredData, Nullable, OrganizationSchema, ReviewSchema, Schema, Schemas, WebPageSchema, WebSiteSchema } from '../../../types';
 export declare function buildGraph(schemas: Schemas): Schema[];
 interface BuildOrganizationSchemaParams {
     site: {

package/dist/utils/seo/open-graph/index.d.ts

@@ -0,0 +1,15 @@
+import { ILocale, IOpenGraph, IOpenGraphMetaItem } from '../../../types';
+interface BuildOpenGraphParams {
+    site: {
+        name: string;
+    };
+    page: {
+        url: string;
+        title: string;
+        description: string;
+    };
+    lang: ILocale['code'];
+    content?: IOpenGraph['content'];
+}
+export declare function buildOpenGraphMeta(params: BuildOpenGraphParams): IOpenGraphMetaItem[];
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@anywayseo/tools",
   "description": "Shared UI Components and Modules",
-  "version": "6.0.0",
+  "version": "6.2.0",
   "keywords": [
     "react",
     "ui",

package/dist/components/seo/types.d.ts

@@ -1,14 +0,0 @@
-import { IHrefLang, ILocale, ISeoMetadata, IStructuredData, Nullable } from '../../types';
-export interface ISeoMetaItemPlaceholders {
-    siteName: string;
-    currentYear: string;
-    currentMonth: string;
-}
-type SeoMetaItemGetter = (placeholders: ISeoMetaItemPlaceholders) => string;
-export type SeoLocale = Nullable<ILocale['code']>;
-export type SeoTitle = Nullable<ISeoMetadata['title'] | SeoMetaItemGetter>;
-export type SeoDescription = Nullable<ISeoMetadata['description'] | SeoMetaItemGetter>;
-export type SeoCanonical = Nullable<string>;
-export type SeoHrefLangs = IHrefLang[];
-export type SeoStructuredData = Nullable<IStructuredData>;
-export {};