@tsdoctor/seo 0.2.0 → 0.2.1

package/index.d.ts

@@ -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,13 +275,13 @@ 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`). */
@@ -319,13 +319,13 @@ declare const OpenGraphMetadata: Schema.Struct<{
   readonly ogType: Schema.String;
 }>;
 /** @public */
-type OpenGraphMetadata = typeof OpenGraphMetadata.Type;
+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;
@@ -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
 /**
@@ -407,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
 /**
@@ -504,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.
  *
@@ -526,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>`.
  *
@@ -541,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, openGraphTags, packageContext, resolveUrl, twitterTags };
+export type { AttributionFacts, HeadTag, PackageContext, PackageNodeInput, PageNodeInput, SeoPageInput, StructuredDataError };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tsdoctor/seo",
-	"version": "0.2.0",
+	"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"