@vakwerk/seo 0.1.3 → 0.2.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export type { SEOProps } from './types.js';
 export { resolveCanonicalUrl, resolveImageUrl, resolveTitle } from './url.js';
+export { faqPage, breadcrumbList, webSite, itemList, howTo, article, organization, } from './schemas.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC9E,OAAO,EACN,OAAO,EACP,cAAc,EACd,OAAO,EACP,QAAQ,EACR,KAAK,EACL,OAAO,EACP,YAAY,GACZ,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -1,2 +1,3 @@
 export { resolveCanonicalUrl, resolveImageUrl, resolveTitle } from './url.js';
+export { faqPage, breadcrumbList, webSite, itemList, howTo, article, organization, } from './schemas.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC9E,OAAO,EACN,OAAO,EACP,cAAc,EACd,OAAO,EACP,QAAQ,EACR,KAAK,EACL,OAAO,EACP,YAAY,GACZ,MAAM,cAAc,CAAC"}

package/dist/schemas.d.ts

@@ -0,0 +1,100 @@
+export declare function faqPage(items: {
+    question: string;
+    answer: string;
+}[]): {
+    '@context': string;
+    '@type': "FAQPage";
+    mainEntity: {
+        '@type': "Question";
+        name: string;
+        acceptedAnswer: {
+            '@type': "Answer";
+            text: string;
+        };
+    }[];
+};
+export declare function breadcrumbList(items: {
+    name: string;
+    url: string;
+}[]): {
+    '@context': string;
+    '@type': "BreadcrumbList";
+    itemListElement: {
+        '@type': "ListItem";
+        position: number;
+        name: string;
+        item: string;
+    }[];
+};
+export declare function webSite(name: string, url: string): {
+    '@context': string;
+    '@type': "WebSite";
+    name: string;
+    url: string;
+};
+export declare function itemList(name: string, items: {
+    name: string;
+    url: string;
+}[]): {
+    '@context': string;
+    '@type': "ItemList";
+    name: string;
+    itemListElement: {
+        '@type': "ListItem";
+        position: number;
+        name: string;
+        item: string;
+    }[];
+};
+export declare function howTo(name: string, steps: string[], opts?: {
+    description?: string;
+}): {
+    step: {
+        '@type': "HowToStep";
+        position: number;
+        text: string;
+    }[];
+    description?: string | undefined;
+    '@context': string;
+    '@type': "HowTo";
+    name: string;
+};
+export declare function article(headline: string, opts: {
+    author: {
+        name: string;
+        url?: string;
+    };
+    datePublished: string;
+    dateModified?: string;
+    image?: string | string[];
+    description?: string;
+    url?: string;
+}): {
+    url?: string | undefined;
+    description?: string | undefined;
+    image?: string | string[] | undefined;
+    dateModified?: string | undefined;
+    '@context': string;
+    '@type': "Article";
+    headline: string;
+    author: {
+        url?: string | undefined;
+        '@type': "Person";
+        name: string;
+    };
+    datePublished: string;
+};
+export declare function organization(name: string, url: string, opts?: {
+    logo?: string;
+    description?: string;
+    sameAs?: string[];
+}): {
+    sameAs?: string[] | undefined;
+    description?: string | undefined;
+    logo?: string | undefined;
+    '@context': string;
+    '@type': "Organization";
+    name: string;
+    url: string;
+};
+//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAEA,wBAAgB,OAAO,CAAC,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAAE;;;;;;;;;;;EAapE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE;;;;;;;;;EAWpE;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;;;;;EAOhD;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE;;;;;;;;;;EAY5E;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;;;;;;EAYnF;AAED,wBAAgB,OAAO,CACrB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE;IACJ,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;;;;;;;;;;;;;;EAiBF;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE;;;;;;;;EAWlE"}

package/dist/schemas.js

@@ -0,0 +1,90 @@
+const CONTEXT = 'https://schema.org';
+export function faqPage(items) {
+    return {
+        '@context': CONTEXT,
+        '@type': 'FAQPage',
+        mainEntity: items.map((item) => ({
+            '@type': 'Question',
+            name: item.question,
+            acceptedAnswer: {
+                '@type': 'Answer',
+                text: item.answer,
+            },
+        })),
+    };
+}
+export function breadcrumbList(items) {
+    return {
+        '@context': CONTEXT,
+        '@type': 'BreadcrumbList',
+        itemListElement: items.map((item, index) => ({
+            '@type': 'ListItem',
+            position: index + 1,
+            name: item.name,
+            item: item.url,
+        })),
+    };
+}
+export function webSite(name, url) {
+    return {
+        '@context': CONTEXT,
+        '@type': 'WebSite',
+        name,
+        url,
+    };
+}
+export function itemList(name, items) {
+    return {
+        '@context': CONTEXT,
+        '@type': 'ItemList',
+        name,
+        itemListElement: items.map((item, index) => ({
+            '@type': 'ListItem',
+            position: index + 1,
+            name: item.name,
+            item: item.url,
+        })),
+    };
+}
+export function howTo(name, steps, opts) {
+    return {
+        '@context': CONTEXT,
+        '@type': 'HowTo',
+        name,
+        ...(opts?.description && { description: opts.description }),
+        step: steps.map((text, index) => ({
+            '@type': 'HowToStep',
+            position: index + 1,
+            text,
+        })),
+    };
+}
+export function article(headline, opts) {
+    return {
+        '@context': CONTEXT,
+        '@type': 'Article',
+        headline,
+        author: {
+            '@type': 'Person',
+            name: opts.author.name,
+            ...(opts.author.url && { url: opts.author.url }),
+        },
+        datePublished: opts.datePublished,
+        ...(opts.dateModified && { dateModified: opts.dateModified }),
+        ...(opts.image && { image: opts.image }),
+        ...(opts.description && { description: opts.description }),
+        ...(opts.url && { url: opts.url }),
+    };
+}
+export function organization(name, url, opts) {
+    return {
+        '@context': CONTEXT,
+        '@type': 'Organization',
+        name,
+        url,
+        ...(opts?.logo && { logo: opts.logo }),
+        ...(opts?.description && { description: opts.description }),
+        ...(opts?.sameAs && { sameAs: opts.sameAs }),
+    };
+}
+//# sourceMappingURL=schemas.js.map

package/dist/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG,oBAAoB,CAAC;AAErC,MAAM,UAAU,OAAO,CAAC,KAA6C;IACnE,OAAO;QACL,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,SAAkB;QAC3B,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC/B,OAAO,EAAE,UAAmB;YAC5B,IAAI,EAAE,IAAI,CAAC,QAAQ;YACnB,cAAc,EAAE;gBACd,OAAO,EAAE,QAAiB;gBAC1B,IAAI,EAAE,IAAI,CAAC,MAAM;aAClB;SACF,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAsC;IACnE,OAAO;QACL,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,gBAAyB;QAClC,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAC3C,OAAO,EAAE,UAAmB;YAC5B,QAAQ,EAAE,KAAK,GAAG,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,GAAG;SACf,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,IAAY,EAAE,GAAW;IAC/C,OAAO;QACL,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,SAAkB;QAC3B,IAAI;QACJ,GAAG;KACJ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,KAAsC;IAC3E,OAAO;QACL,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,UAAmB;QAC5B,IAAI;QACJ,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAC3C,OAAO,EAAE,UAAmB;YAC5B,QAAQ,EAAE,KAAK,GAAG,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,GAAG;SACf,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,KAAe,EAAE,IAA+B;IAClF,OAAO;QACL,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,OAAgB;QACzB,IAAI;QACJ,GAAG,CAAC,IAAI,EAAE,WAAW,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3D,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAChC,OAAO,EAAE,WAAoB;YAC7B,QAAQ,EAAE,KAAK,GAAG,CAAC;YACnB,IAAI;SACL,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,OAAO,CACrB,QAAgB,EAChB,IAOC;IAED,OAAO;QACL,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,SAAkB;QAC3B,QAAQ;QACR,MAAM,EAAE;YACN,OAAO,EAAE,QAAiB;YAC1B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;SACjD;QACD,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,GAAG,CAAC,IAAI,CAAC,YAAY,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;QAC7D,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1D,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,IAAY,EACZ,GAAW,EACX,IAAiE;IAEjE,OAAO;QACL,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,cAAuB;QAChC,IAAI;QACJ,GAAG;QACH,GAAG,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACtC,GAAG,CAAC,IAAI,EAAE,WAAW,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3D,GAAG,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;KAC7C,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,26 +1,28 @@
 {
   "name": "@vakwerk/seo",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
-    "./SEO.astro": "./src/SEO.astro"
+    "./SEO.astro": "./src/SEO.astro",
+    "./JsonLd.astro": "./src/JsonLd.astro"
   },
   "files": [
     "dist",
-    "src/SEO.astro"
+    "src/SEO.astro",
+    "src/JsonLd.astro"
   ],
+  "peerDependencies": {
+    "astro": ">=5.0.0"
+  },
   "scripts": {
     "build": "tsc",
     "test": "vitest run",
     "test:watch": "vitest",
     "check:types": "tsc --noEmit",
     "lint": "echo 'no linter configured yet'"
-  },
-  "peerDependencies": {
-    "astro": ">=5.0.0"
   }
-}
+}

package/src/JsonLd.astro

@@ -0,0 +1,12 @@
+---
+interface Props {
+	data: Record<string, unknown> | Record<string, unknown>[];
+}
+
+const { data } = Astro.props;
+const schemas = Array.isArray(data) ? data : [data];
+---
+
+{schemas.map((schema) => (
+	<script type="application/ld+json" set:html={JSON.stringify(schema).replaceAll('<', '\\u003c')} />
+))}

package/src/SEO.astro

@@ -1,6 +1,7 @@
 ---
 import type { SEOProps } from '@vakwerk/seo';
 import { resolveCanonicalUrl, resolveImageUrl, resolveTitle } from '@vakwerk/seo';
+import JsonLd from './JsonLd.astro';
 
 type Props = SEOProps;
 
@@ -44,6 +45,4 @@ const robots = noindex ? 'noindex, nofollow' : 'index, follow';
 <meta name="twitter:description" content={description} />
 {resolvedImage && <meta name="twitter:image" content={resolvedImage} />}
 
-{schemas.map((schema) => (
-	<script is:inline type="application/ld+json" set:html={JSON.stringify(schema).replace(/<\/script>/gi, '<\\/script>')} />
-))}
+{schemas.length > 0 && <JsonLd data={schemas} />}