npm - @tsdoctor/seo - Versions diffs - 0.1.2 → 0.2.1 - Mend

@tsdoctor/seo 0.1.2 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/OpenGraph.js CHANGED Viewed

@@ -8,9 +8,9 @@ import { Schema } from "effect";
 * page-metadata assembly and the two tag emitters.
 *
 * @remarks
-* The schemas and {@link createPageMetadata} / {@link ogAltText} moved here
-* verbatim from the RSPress adapter (`schemas/opengraph.ts` and
-* `og-resolver.ts`). {@link openGraphTags} is the tag-emission logic that was
+* The schemas and {@link createPageMetadata} moved here verbatim from the
+* RSPress adapter (`schemas/opengraph.ts` and `og-resolver.ts`).
+* {@link openGraphTags} is the tag-emission logic that was
 * inlined in the adapter's `generateFrontmatter`, lifted unchanged — same tag
 * order, same conditional emission of each optional image sub-tag — so that a
 * second adapter can reach the vocabulary rather than reimplement it.
@@ -52,6 +52,10 @@ const OpenGraphMetadata = Schema.Struct({
 	siteUrl: Schema.String,
 	/** Page route path (e.g. `/api/classes/myclass`). */
 	pageRoute: Schema.String,
+	/** Page title for the `og:title` and `twitter:title` tags. */
+	title: Schema.String,
+	/** Site name for the `og:site_name` tag, when the site declares one. */
+	siteName: Schema.optional(Schema.String),
 	/** Page description for the `og:description` tag. */
 	description: Schema.String,
 	/** ISO 8601 date string for `article:published_time`. */
@@ -68,14 +72,6 @@ const OpenGraphMetadata = Schema.Struct({
 	ogType: Schema.String
 });
 /**
-* Descriptive alt text for a package's (or one API's) OG image.
-*
-* @public
-*/
-function ogAltText(packageName, apiName) {
-	return apiName ? `${apiName} - ${packageName} API Documentation` : `${packageName} API Documentation`;
-}
-/**
 * Assemble the complete Open Graph metadata for one documentation page.
 *
 * @public
@@ -84,6 +80,8 @@ function createPageMetadata(options) {
 	return {
 		siteUrl: options.siteUrl,
 		pageRoute: options.pageRoute,
+		title: options.title,
+		...options.siteName != null ? { siteName: options.siteName } : {},
 		description: options.description,
 		publishedTime: options.publishedTime,
 		modifiedTime: options.modifiedTime,
@@ -111,8 +109,10 @@ function openGraphTags(metadata) {
 	const tags = [
 		meta("og:url", canonicalUrl(metadata.siteUrl, metadata.pageRoute)),
 		meta("og:type", metadata.ogType),
-		meta("og:description", metadata.description)
+		meta("og:title", metadata.title)
 	];
+	if (metadata.siteName !== void 0 && metadata.siteName !== "") tags.push(meta("og:site_name", metadata.siteName));
+	tags.push(meta("og:description", metadata.description));
 	const image = metadata.ogImage;
 	if (image) {
 		tags.push(meta("og:image", image.url));
@@ -143,7 +143,11 @@ function openGraphTags(metadata) {
 * @public
 */
 function twitterTags(metadata, site) {
-	const tags = [metaNamed("twitter:card", metadata.ogImage ? "summary_large_image" : "summary"), metaNamed("twitter:description", metadata.description)];
+	const tags = [
+		metaNamed("twitter:card", metadata.ogImage ? "summary_large_image" : "summary"),
+		metaNamed("twitter:title", metadata.title),
+		metaNamed("twitter:description", metadata.description)
+	];
 	if (site != null && site !== "") tags.push(metaNamed("twitter:site", site));
 	if (metadata.ogImage) {
 		tags.push(metaNamed("twitter:image", metadata.ogImage.url));
@@ -153,4 +157,4 @@ function twitterTags(metadata, site) {
 }
 //#endregion
-export { OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, createPageMetadata, ogAltText, openGraphTags, twitterTags };
+export { OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, createPageMetadata, openGraphTags, twitterTags };

package/README.md CHANGED Viewed

@@ -16,7 +16,7 @@ Framework-neutral `<head>` metadata for static TypeScript API documentation: sch
 - **`headTags(input: SeoPageInput)`** — every `<head>` tag for one page, in a fixed order so a diff over generated pages stays readable.
 - **`HeadTag`, `meta`, `metaNamed`, `link`, `jsonLd`, `escapeScriptBody`** — the neutral tag vocabulary. `escapeScriptBody` is idempotent, so a body already escaped by an upstream serializer survives a second pass unchanged.
 - **`deriveSiteUrl`, `canonicalUrl`, `resolveUrl`, `imageMimeType`** — URL derivation. With no configured origin the prefix is `""`, so URLs stay root-relative and the tags are still emitted rather than dropped.
-- **`OpenGraphImageConfig`, `OpenGraphImageMetadata`, `OpenGraphMetadata`, `createPageMetadata`, `openGraphTags`, `twitterTags`, `ogAltText`** — the Open Graph and Twitter card vocabulary, as Effect Schemas plus the emitters over them.
+- **`OpenGraphImageConfig`, `OpenGraphImageMetadata`, `OpenGraphMetadata`, `createPageMetadata`, `openGraphTags`, `twitterTags`** — the Open Graph and Twitter card vocabulary, as Effect Schemas plus the emitters over them.
 - **`attributionFacts(manifest)`** — author, maintainers, repository URL, homepage, SPDX license ids and per-license canonical URLs, and keywords, derived from an `@effected/package-json` `PackageManifest`. Total and synchronous: a manifest carrying none of these yields empty arrays and no optional properties.
 - **`packageContext`, `derive`, `deriveScriptBody`** — the schema.org graph. `packageContext` is derived once per package; `derive` assembles a page's `@graph` (a `SoftwareSourceCode`, a `TechArticle` and an `APIReference`, linked by `isPartOf` and `mainEntity`, plus a `Person` per credited human).

package/Seo.js CHANGED Viewed

@@ -29,6 +29,8 @@ function headTags(input) {
 	const metadata = createPageMetadata({
 		siteUrl: input.siteUrl,
 		pageRoute: input.pageRoute,
+		title: input.title,
+		...input.siteName != null ? { siteName: input.siteName } : {},
 		description: input.description,
 		publishedTime: input.publishedTime,
 		modifiedTime: input.modifiedTime,

package/index.d.ts CHANGED Viewed

@@ -100,7 +100,7 @@ interface AttributionFacts {
  *
  * @public
  */
-declare function attributionFacts(manifest: PackageManifest): AttributionFacts;
+export declare function attributionFacts(manifest: PackageManifest): AttributionFacts;
 //#endregion
 //#region src/Canonical.d.ts
 /**
@@ -122,7 +122,7 @@ declare function attributionFacts(manifest: PackageManifest): AttributionFacts;
  *
  * @public
  */
-declare function imageMimeType(type: string | undefined): string | undefined;
+export declare function imageMimeType(type: string | undefined): string | undefined;
 /**
  * Turn a configured URL into an absolute one.
  *
@@ -133,7 +133,7 @@ declare function imageMimeType(type: string | undefined): string | undefined;
  *
  * @public
  */
-declare function resolveUrl(siteUrl: string, url: string): string | undefined;
+export declare function resolveUrl(siteUrl: string, url: string): string | undefined;
 /**
  * Derive the site URL prefix from the framework's own config.
  *
@@ -162,7 +162,7 @@ declare function resolveUrl(siteUrl: string, url: string): string | undefined;
  *
  * @public
  */
-declare function deriveSiteUrl(siteOrigin: string | undefined, base: string | undefined): string;
+export declare function deriveSiteUrl(siteOrigin: string | undefined, base: string | undefined): string;
 /**
  * The canonical URL for a page.
  *
@@ -174,7 +174,7 @@ declare function deriveSiteUrl(siteOrigin: string | undefined, base: string | un
  *
  * @public
  */
-declare function canonicalUrl(siteUrl: string, pageRoute: string): string;
+export declare function canonicalUrl(siteUrl: string, pageRoute: string): string;
 //#endregion
 //#region src/HeadTag.d.ts
 /**
@@ -223,15 +223,15 @@ interface HeadTag {
  *
  * @public
  */
-declare function escapeScriptBody(json: string): string;
+export declare function escapeScriptBody(json: string): string;
 /** An Open Graph style `<meta property=… content=…>`. @public */
-declare function meta(property: string, content: string): HeadTag;
+export declare function meta(property: string, content: string): HeadTag;
 /** A Twitter/standard style `<meta name=… content=…>`. @public */
-declare function metaNamed(name: string, content: string): HeadTag;
+export declare function metaNamed(name: string, content: string): HeadTag;
 /** A `<link rel=… href=…>`. @public */
-declare function link(rel: string, href: string): HeadTag;
+export declare function link(rel: string, href: string): HeadTag;
 /** A `<script type="application/ld+json">` carrying an escaped body. @public */
-declare function jsonLd(json: string): HeadTag;
+export declare function jsonLd(json: string): HeadTag;
 //#endregion
 //#region src/OpenGraph.d.ts
 /**
@@ -239,7 +239,7 @@ declare function jsonLd(json: string): HeadTag;
  *
  * @public
  */
-declare const OpenGraphImageMetadata: Schema.Struct<{
+export declare const OpenGraphImageMetadata: Schema.Struct<{
   /** Absolute URL of the image. */
   readonly url: Schema.String;
   /** HTTPS URL of the image (for secure contexts). */
@@ -254,13 +254,13 @@ declare const OpenGraphImageMetadata: Schema.Struct<{
   readonly alt: Schema.optional<Schema.String>;
 }>;
 /** @public */
-type OpenGraphImageMetadata = typeof OpenGraphImageMetadata.Type;
+export type OpenGraphImageMetadata = typeof OpenGraphImageMetadata.Type;
 /**
  * Open Graph image: either a plain URL string or structured `OpenGraphImageMetadata`.
  *
  * @public
  */
-declare const OpenGraphImageConfig: Schema.Union<readonly [Schema.String, Schema.Struct<{
+export declare const OpenGraphImageConfig: Schema.Union<readonly [Schema.String, Schema.Struct<{
   /** Absolute URL of the image. */
   readonly url: Schema.String;
   /** HTTPS URL of the image (for secure contexts). */
@@ -275,17 +275,21 @@ declare const OpenGraphImageConfig: Schema.Union<readonly [Schema.String, Schema
   readonly alt: Schema.optional<Schema.String>;
 }>]>;
 /** @public */
-type OpenGraphImageConfig = typeof OpenGraphImageConfig.Type;
+export type OpenGraphImageConfig = typeof OpenGraphImageConfig.Type;
 /**
  * Resolved Open Graph metadata for one documentation page.
  *
  * @public
  */
-declare const OpenGraphMetadata: Schema.Struct<{
+export declare const OpenGraphMetadata: Schema.Struct<{
   /** Canonical site base URL. */
   readonly siteUrl: Schema.String;
   /** Page route path (e.g. `/api/classes/myclass`). */
   readonly pageRoute: Schema.String;
+  /** Page title for the `og:title` and `twitter:title` tags. */
+  readonly title: Schema.String;
+  /** Site name for the `og:site_name` tag, when the site declares one. */
+  readonly siteName: Schema.optional<Schema.String>;
   /** Page description for the `og:description` tag. */
   readonly description: Schema.String;
   /** ISO 8601 date string for `article:published_time`. */
@@ -315,21 +319,17 @@ declare const OpenGraphMetadata: Schema.Struct<{
   readonly ogType: Schema.String;
 }>;
 /** @public */
-type OpenGraphMetadata = typeof OpenGraphMetadata.Type;
-/**
- * Descriptive alt text for a package's (or one API's) OG image.
- *
- * @public
- */
-declare function ogAltText(packageName: string, apiName?: string): string;
+export type OpenGraphMetadata = typeof OpenGraphMetadata.Type;
 /**
  * Assemble the complete Open Graph metadata for one documentation page.
  *
  * @public
  */
-declare function createPageMetadata(options: {
+export declare function createPageMetadata(options: {
   siteUrl: string;
   pageRoute: string;
+  title: string;
+  siteName?: string;
   description: string;
   publishedTime: string;
   modifiedTime: string;
@@ -347,7 +347,7 @@ declare function createPageMetadata(options: {
  *
  * @public
  */
-declare function openGraphTags(metadata: OpenGraphMetadata): ReadonlyArray<HeadTag>;
+export declare function openGraphTags(metadata: OpenGraphMetadata): ReadonlyArray<HeadTag>;
 /**
  * Twitter card tags derived from the same metadata as the Open Graph block.
  *
@@ -362,7 +362,7 @@ declare function openGraphTags(metadata: OpenGraphMetadata): ReadonlyArray<HeadT
  *
  * @public
  */
-declare function twitterTags(metadata: OpenGraphMetadata, site?: string): ReadonlyArray<HeadTag>;
+export declare function twitterTags(metadata: OpenGraphMetadata, site?: string): ReadonlyArray<HeadTag>;
 //#endregion
 //#region src/Seo.d.ts
 /**
@@ -375,6 +375,10 @@ interface SeoPageInput {
   readonly siteUrl: string;
   /** Page route path, beginning with `/`. */
   readonly pageRoute: string;
+  /** Page title, used for both `og:title` and `twitter:title`. */
+  readonly title: string;
+  /** Site name for the `og:site_name` tag, when the site declares one. */
+  readonly siteName?: string;
   /** Page description, used for both `og:description` and `twitter:description`. */
   readonly description: string;
   /** ISO 8601 date string for `article:published_time`. */
@@ -403,7 +407,7 @@ interface SeoPageInput {
  *
  * @public
  */
-declare function headTags(input: SeoPageInput): ReadonlyArray<HeadTag>;
+export declare function headTags(input: SeoPageInput): ReadonlyArray<HeadTag>;
 //#endregion
 //#region src/StructuredData.d.ts
 /**
@@ -500,7 +504,7 @@ interface PackageContext {
  *
  * @public
  */
-declare function packageContext(input: PackageNodeInput): PackageContext;
+export declare function packageContext(input: PackageNodeInput): PackageContext;
 /**
  * Derive the schema.org graph for one documentation page.
  *
@@ -522,7 +526,7 @@ declare function packageContext(input: PackageNodeInput): PackageContext;
  *
  * @public
  */
-declare function derive(pkg: PackageContext, page: PageNodeInput): Result.Result<JsonLdDocument, StructuredDataError>;
+export declare function derive(pkg: PackageContext, page: PageNodeInput): Result.Result<JsonLdDocument, StructuredDataError>;
 /**
  * {@link derive}, serialized to the text an adapter embeds in a `<script>`.
  *
@@ -537,7 +541,7 @@ declare function derive(pkg: PackageContext, page: PageNodeInput): Result.Result
  *
  * @public
  */
-declare function deriveScriptBody(pkg: PackageContext, page: PageNodeInput): Result.Result<string, StructuredDataError>;
+export declare function deriveScriptBody(pkg: PackageContext, page: PageNodeInput): Result.Result<string, StructuredDataError>;
 //#endregion
-export { type AttributionFacts, type HeadTag, OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, type PackageContext, type PackageNodeInput, type PageNodeInput, type SeoPageInput, type StructuredDataError, attributionFacts, canonicalUrl, createPageMetadata, derive, deriveScriptBody, deriveSiteUrl, escapeScriptBody, headTags, imageMimeType, jsonLd, link, meta, metaNamed, ogAltText, openGraphTags, packageContext, resolveUrl, twitterTags };
+export type { AttributionFacts, HeadTag, PackageContext, PackageNodeInput, PageNodeInput, SeoPageInput, StructuredDataError };
 //# sourceMappingURL=index.d.ts.map

package/index.js CHANGED Viewed

@@ -1,8 +1,8 @@
 import { attributionFacts } from "./Attribution.js";
 import { canonicalUrl, deriveSiteUrl, imageMimeType, resolveUrl } from "./Canonical.js";
 import { escapeScriptBody, jsonLd, link, meta, metaNamed } from "./HeadTag.js";
-import { OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, createPageMetadata, ogAltText, openGraphTags, twitterTags } from "./OpenGraph.js";
+import { OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, createPageMetadata, openGraphTags, twitterTags } from "./OpenGraph.js";
 import { headTags } from "./Seo.js";
 import { derive, deriveScriptBody, packageContext } from "./StructuredData.js";
-export { OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, attributionFacts, canonicalUrl, createPageMetadata, derive, deriveScriptBody, deriveSiteUrl, escapeScriptBody, headTags, imageMimeType, jsonLd, link, meta, metaNamed, ogAltText, openGraphTags, packageContext, resolveUrl, twitterTags };
+export { OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, attributionFacts, canonicalUrl, createPageMetadata, derive, deriveScriptBody, deriveSiteUrl, escapeScriptBody, headTags, imageMimeType, jsonLd, link, meta, metaNamed, openGraphTags, packageContext, resolveUrl, twitterTags };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@tsdoctor/seo",
-	"version": "0.1.2",
+	"version": "0.2.1",
 	"private": false,
 	"description": "Framework-neutral head metadata for static TypeScript API documentation: schema.org JSON-LD, Open Graph and Twitter card vocabulary, canonical URLs, and package attribution derived from an api.json model plus its manifest.",
 	"keywords": [
@@ -37,10 +37,10 @@
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"@effected/package-json": "^0.13.0",
-		"@effected/schema-org": "^0.1.0",
-		"@effected/spdx": "^0.5.0",
-		"effect": "4.0.0-rc.109"
+		"@effected/package-json": "^0.14.0",
+		"@effected/schema-org": "^0.2.0",
+		"@effected/spdx": "^0.6.0",
+		"effect": "4.0.0-rc.112"
 	},
 	"engines": {
 		"node": ">=24.11.0"