@sandboxsonny/ace-kit 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @sandboxsonny/ace-kit
 
+## 0.10.0
+
+### Minor Changes
+
+- 4215f32: Show the site's favicon in `<AceSeo>`. The favicon is chosen in the site's settings in the CMS; `<AceSeo>` adds `<link rel="icon">` and `<link rel="apple-touch-icon">` for it when you don't pass a `favicon` yourself. If your layout already has its own icon link, remove it, or the browser may pick either. `getSite()` now also returns the favicon.
+
 ## 0.9.0
 
 ### Minor Changes

package/astro/AceSeo.astro

@@ -7,10 +7,15 @@ import { getSite } from "../dist/astro.js";
 
 type Props = AceSeoOptions;
 
-// With no picture of its own, a page shows the social image chosen in the site's settings. The tags are never worth
-// failing the page for, so a CMS that can't be reached just means no picture.
-const site = Astro.props.image === undefined ? await getSite().catch(() => null) : null;
-const properties = seoProperties({ ...Astro.props, image: Astro.props.image ?? site?.social_image?.src });
+// With no picture or icon of its own, a page shows the ones chosen in the site's settings. The tags are never worth
+// failing the page for, so a CMS that can't be reached just means none.
+const needsSite = Astro.props.image === undefined || Astro.props.favicon === undefined;
+const site = needsSite ? await getSite().catch(() => null) : null;
+const properties = seoProperties({
+  ...Astro.props,
+  image: Astro.props.image ?? site?.social_image?.src,
+  favicon: Astro.props.favicon ?? site?.favicon ?? undefined,
+});
 ---
 
 <SEO {...properties} />

package/dist/astro.d.ts

@@ -29,6 +29,18 @@ type AceImageData = {
   content_type: string;
 };
 
+/** The site's favicon as the CMS Ace public API returns it: the original, and square PNG copies. */
+type AceFavicon = {
+  id: number;
+  /** The untouched original. */
+  url: string;
+  /** A small square PNG (48 pixels), for the browser tab and search results. */
+  icon: string;
+  /** A square PNG (180 pixels), for a phone's home screen. */
+  apple_touch_icon: string;
+  content_type: string;
+};
+
 /** The site the request is for, as the CMS Ace public API returns it. */
 type AceSite = {
   id: number;
@@ -37,6 +49,8 @@ type AceSite = {
   handle: string;
   /** The picture the site's owners chose to show in search results and social posts; null if none. */
   social_image: AceImageData | null;
+  /** The small picture the site's owners chose for browser tabs; null if none. */
+  favicon: AceFavicon | null;
 };
 
 /** One link of a menu as the public API returns it, with its address already worked out. */

package/dist/cli.js

@@ -9,7 +9,7 @@ if (major < 22 || major === 22 && minor < 12) {
   process.exit(1);
 }
 try {
-  const { createRealEnvironment } = await import("./environment-YCQRJ56U.js");
+  const { createRealEnvironment } = await import("./environment-M3B4UZ5T.js");
   const { runCli } = await import("./main-6O2IIVHO.js");
   const environment = await createRealEnvironment();
   process.exit(await runCli(process.argv.slice(2), environment));

package/dist/{environment-YCQRJ56U.js → environment-M3B4UZ5T.js}

@@ -145,7 +145,7 @@ function createLastApiUrl(path) {
 }
 
 // src/cli/version.ts
-var aceKitVersion = true ? "0.9.0" : "development";
+var aceKitVersion = true ? "0.10.0" : "development";
 
 // src/cli/environment.ts
 var runCommand = (command, commandArguments, input) => new Promise((resolve, reject) => {

package/dist/index.d.ts

@@ -99,6 +99,18 @@ type AceImageData = {
   content_type: string;
 };
 
+/** The site's favicon as the CMS Ace public API returns it: the original, and square PNG copies. */
+type AceFavicon = {
+  id: number;
+  /** The untouched original. */
+  url: string;
+  /** A small square PNG (48 pixels), for the browser tab and search results. */
+  icon: string;
+  /** A square PNG (180 pixels), for a phone's home screen. */
+  apple_touch_icon: string;
+  content_type: string;
+};
+
 /** The site the request is for, as the CMS Ace public API returns it. */
 type AceSite = {
   id: number;
@@ -107,6 +119,8 @@ type AceSite = {
   handle: string;
   /** The picture the site's owners chose to show in search results and social posts; null if none. */
   social_image: AceImageData | null;
+  /** The small picture the site's owners chose for browser tabs; null if none. */
+  favicon: AceFavicon | null;
 };
 
 /**
@@ -478,6 +492,11 @@ type AceSeoOptions = {
      * social image chosen in the site's settings in the CMS (if any).
      */
     image?: string;
+    /**
+     * The site's favicon. In the Astro `<AceSeo>`, leaving it out uses the favicon chosen in the site's settings in the
+     * CMS (if any); it then adds `<link rel="icon">` and `<link rel="apple-touch-icon">`.
+     */
+    favicon?: Pick<AceFavicon, "icon" | "apple_touch_icon">;
     /** Tells search engines to leave the page out, as for a draft shown in preview. */
     noindex?: boolean;
 };
@@ -486,6 +505,11 @@ type Meta = {
     name?: string;
     content: string;
 };
+type Link = {
+    rel: string;
+    href: string;
+    sizes?: string;
+};
 /** What `astro-seo`'s `<SEO>` takes (only the parts used here). */
 type AceSeoProperties = {
     title?: string;
@@ -500,6 +524,7 @@ type AceSeoProperties = {
     };
     extend: {
         meta: Meta[];
+        link?: Link[];
     };
 };
 /**
@@ -551,4 +576,4 @@ type AceSection = {
   blocks: AceSectionBlock[];
 };
 
-export { type AceAddress, type AceClient, type AceClientOptions, type AceContentTypeHandle, type AceContentTypeSchema, type AceContentTypes, type AceDateFormat, type AceEntry, type AceFieldSchema, type AceImageAttributes, type AceImageData, type AceImageOptions, type AceLinkAttributes, type AceLinkData, type AceMenu, type AceMenuItem, type AceNavigationLink, type AcePage, AcePreviewExpiredError, type AceRichTextDocument, type AceRichTextMark, type AceRichTextNode, type AceSection, type AceSectionBlock, type AceSeoOptions, type AceSeoProperties, type AceSite, AceUnavailableError, type AceValuesOf, type BlockDefinition, type SectionDefinition, type SectionFieldDefinition, type SectionFieldType, type SectionOf, type SectionTypesPayload, type ValuesOfFields, addFramingPolicy, addressFromPath, checkSectionDefinition, createAceClient, defineSection, formatAceDate, framingPolicy, headingLevel, homeAddress, imageAttributes, isCurrentPage, isHomeAddress, isInternalPath, isRefreshRequest, linkAddress, linkAttributes, linksFromMenu, listStart, listenForPreviewRefresh, loadMenuLinks, loadPage, originOf, pageNotices, pathOfAddress, previewHeaders, previewParameter, previewTokenFrom, refreshMessageType, refreshPageContent, renderRichText, renderTextArea, richTextImageSizes, sectionTypesPayload, seoDescriptionHandle, seoProperties, seoTitleHandle, swapPageContent, visitablePath };
+export { type AceAddress, type AceClient, type AceClientOptions, type AceContentTypeHandle, type AceContentTypeSchema, type AceContentTypes, type AceDateFormat, type AceEntry, type AceFavicon, type AceFieldSchema, type AceImageAttributes, type AceImageData, type AceImageOptions, type AceLinkAttributes, type AceLinkData, type AceMenu, type AceMenuItem, type AceNavigationLink, type AcePage, AcePreviewExpiredError, type AceRichTextDocument, type AceRichTextMark, type AceRichTextNode, type AceSection, type AceSectionBlock, type AceSeoOptions, type AceSeoProperties, type AceSite, AceUnavailableError, type AceValuesOf, type BlockDefinition, type SectionDefinition, type SectionFieldDefinition, type SectionFieldType, type SectionOf, type SectionTypesPayload, type ValuesOfFields, addFramingPolicy, addressFromPath, checkSectionDefinition, createAceClient, defineSection, formatAceDate, framingPolicy, headingLevel, homeAddress, imageAttributes, isCurrentPage, isHomeAddress, isInternalPath, isRefreshRequest, linkAddress, linkAttributes, linksFromMenu, listStart, listenForPreviewRefresh, loadMenuLinks, loadPage, originOf, pageNotices, pathOfAddress, previewHeaders, previewParameter, previewTokenFrom, refreshMessageType, refreshPageContent, renderRichText, renderTextArea, richTextImageSizes, sectionTypesPayload, seoDescriptionHandle, seoProperties, seoTitleHandle, swapPageContent, visitablePath };

package/dist/index.js

@@ -160,7 +160,15 @@ function seoProperties(options) {
       ...description && { description },
       ...options.image && { image: options.image }
     },
-    extend: { meta }
+    extend: {
+      meta,
+      ...options.favicon && {
+        link: [
+          { rel: "icon", href: options.favicon.icon, sizes: "48x48" },
+          { rel: "apple-touch-icon", href: options.favicon.apple_touch_icon }
+        ]
+      }
+    }
   };
 }
 

package/dist/react-router-server.d.ts

@@ -50,6 +50,18 @@ type AceImageData = {
   content_type: string;
 };
 
+/** The site's favicon as the CMS Ace public API returns it: the original, and square PNG copies. */
+type AceFavicon = {
+  id: number;
+  /** The untouched original. */
+  url: string;
+  /** A small square PNG (48 pixels), for the browser tab and search results. */
+  icon: string;
+  /** A square PNG (180 pixels), for a phone's home screen. */
+  apple_touch_icon: string;
+  content_type: string;
+};
+
 /** The site the request is for, as the CMS Ace public API returns it. */
 type AceSite = {
   id: number;
@@ -58,6 +70,8 @@ type AceSite = {
   handle: string;
   /** The picture the site's owners chose to show in search results and social posts; null if none. */
   social_image: AceImageData | null;
+  /** The small picture the site's owners chose for browser tabs; null if none. */
+  favicon: AceFavicon | null;
 };
 
 /** One link of a menu as the public API returns it, with its address already worked out. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sandboxsonny/ace-kit",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Everything a website needs to use CMS Ace: a typed client, addressing, images, menus, rich text, live preview, and Astro and React adapters.",
   "keywords": [
     "cms",