@devslab/site-kit 0.11.1 → 0.12.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devslab/site-kit",
-  "version": "0.11.1",
+  "version": "0.12.2",
   "description": "Strict i18n, SEO/GEO, and Solid public-site shells for DevsLab products",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -60,7 +60,7 @@
     "./site-sections.css": "./site-sections.css"
   },
   "dependencies": {
-    "@devslab/dds-solid": "0.11.1"
+    "@devslab/dds-solid": "0.12.2"
   },
   "peerDependencies": {
     "@tanstack/solid-router": "1.170.30",

package/src/core/index.mjs

@@ -1,5 +1,5 @@
 export { FAMILY_LOCALES, LOCALES, canonicalLocale, defineLocaleRegistry, localeAttributes, resolveLocale } from "./locales.mjs";
 export { CatalogValidationError, createTranslator, validateCatalogs } from "./catalog.mjs";
-export { ROBOTS_USER_AGENTS, buildMetadata, buildRobots, buildSitemap, localizedPath, localizedUrl, renderSitemapXml } from "./seo.mjs";
+export { BRAND_ICON_FILES, ROBOTS_USER_AGENTS, brandIconLinks, buildMetadata, buildRobots, buildSitemap, localizedPath, localizedUrl, renderSitemapXml } from "./seo.mjs";
 export { VerifiedFactRegistry, buildVerifiedJsonLd, renderLlmsTxt } from "./geo.mjs";
 export { definePublisher, buildPublisher, serializeJsonLd, renderPublisherHtml } from "./publisher.mjs";

package/src/core/seo.d.mts

@@ -15,3 +15,8 @@ export declare function renderSitemapXml(entries: ReturnType<typeof buildSitemap
 export type RobotsPolicy = "allow" | "disallow";
 export declare const ROBOTS_USER_AGENTS: { readonly citation: readonly string[]; readonly modelTraining: readonly string[] };
 export declare function buildRobots(input: { baseUrl: string; environment: "production" | "preview" | "development"; policies?: { search: RobotsPolicy; citation: RobotsPolicy; modelTraining: RobotsPolicy } }): string;
+/** The @devslab/linq-brand icon files a page head links, in link order. */
+export declare const BRAND_ICON_FILES: readonly ["favicon.svg", "mark-48.png", "favicon.ico", "apple-touch-icon.png"];
+export interface BrandIconLink { rel: "icon" | "apple-touch-icon"; href: string; type?: string; sizes?: string }
+/** `<link>` descriptors for BRAND_ICON_FILES served at `basePath` (default "/brand"; a same-origin path, never a URL). */
+export declare function brandIconLinks(options?: { basePath?: string }): BrandIconLink[];

package/src/core/seo.mjs

@@ -92,3 +92,46 @@ export function buildRobots({ baseUrl, environment, policies }) {
   if (environment !== "production") return "User-agent: *\nDisallow: /\n";
   return `User-agent: *\nAllow: /\nSitemap: ${cleanBase(baseUrl)}/sitemap.xml\n`;
 }
+
+/**
+ * The icon files @devslab/linq-brand ships for every product under
+ * dist/<product>/, in the order a page head should link them. A product
+ * serves that directory as-is (VisionLinq, BookLinq: /brand/*) or vendors
+ * the bytes and serves them under the same names (AskLinq); either way the
+ * head links come from here, so the four family sites cannot each pick a
+ * different subset — which is what they did before this existed.
+ *
+ * favicon.svg   — the tab icon, crisp at every size, linked first so a
+ *                 browser that understands it never fetches a raster.
+ * mark-48.png   — one raster of at least 48px: search engines want a
+ *                 <link>-declared square, Google "at least 8x8px,
+ *                 preferably >48x48px", and a 32px-only site shows its
+ *                 previous icon in results long after the file changed.
+ * favicon.ico   — 16/32/48 in one container, the bare-URL convention.
+ * apple-touch-icon.png — 180px, iOS home screen.
+ */
+export const BRAND_ICON_FILES = Object.freeze(["favicon.svg", "mark-48.png", "favicon.ico", "apple-touch-icon.png"]);
+
+const iconBase = (basePath) => {
+  const value = String(basePath ?? "/brand");
+  if (/^[a-z][a-z0-9+.-]*:|^\/\//i.test(value)) {
+    throw new RangeError("brandIconLinks basePath is a same-origin path, not a URL: a product serves its own icons");
+  }
+  const trimmed = value.replace(/^\/+|\/+$/g, "");
+  return trimmed ? `/${trimmed}` : "";
+};
+
+/**
+ * `<link>` descriptors for BRAND_ICON_FILES at `basePath` (default /brand).
+ * Same shape as toTanStackHead's `links`; a non-Start renderer can print
+ * them as attributes in this order.
+ */
+export function brandIconLinks({ basePath = "/brand" } = {}) {
+  const base = iconBase(basePath);
+  return [
+    { rel: "icon", type: "image/svg+xml", href: `${base}/favicon.svg` },
+    { rel: "icon", type: "image/png", sizes: "48x48", href: `${base}/mark-48.png` },
+    { rel: "icon", sizes: "16x16 32x32 48x48", href: `${base}/favicon.ico` },
+    { rel: "apple-touch-icon", sizes: "180x180", href: `${base}/apple-touch-icon.png` },
+  ];
+}

package/src/tanstack-start.d.mts

@@ -6,5 +6,7 @@ import type { SiteLocale } from "./core/locales.mjs";
  * registry (D-018) yields `SiteMetadata<string>`; the adapter reads the
  * same fields whatever the code type is, so it must not refuse that.
  */
-export declare function toTanStackHead<Code extends string = SiteLocale>(metadata: SiteMetadata<Code>): { meta: Array<Record<string, string>>; links: Array<Record<string, string>> };
+/** `icons: true` appends brandIconLinks() (the /brand default); an object passes its options through. Omitted, no icon links are emitted. */
+export interface TanStackHeadOptions { icons?: boolean | { basePath?: string } }
+export declare function toTanStackHead<Code extends string = SiteLocale>(metadata: SiteMetadata<Code>, options?: TanStackHeadOptions): { meta: Array<Record<string, string>>; links: Array<Record<string, string>> };
 export declare const toHtmlAttributes: <Code extends string = SiteLocale>(metadata: SiteMetadata<Code>) => { lang: Code; dir: string };

package/src/tanstack-start.mjs

@@ -1,4 +1,10 @@
-export function toTanStackHead(metadata) {
+import { brandIconLinks } from "./core/seo.mjs";
+
+// `icons` is opt-in: the adapter cannot know where (or whether) a product
+// serves the linq-brand files, and a head that links icons the server 404s
+// is worse than one that links none. `true` takes the /brand default.
+export function toTanStackHead(metadata, options = {}) {
+  const icons = options.icons === true ? brandIconLinks() : options.icons ? brandIconLinks(options.icons) : [];
   return {
     meta: [
       { title: metadata.title },
@@ -18,6 +24,7 @@ export function toTanStackHead(metadata) {
     links: [
       { rel: "canonical", href: metadata.canonical },
       ...metadata.alternates.map(({ hreflang, href }) => ({ rel: "alternate", hreflang, href })),
+      ...icons,
     ],
   };
 }