@altano/astro-opengraph 0.0.1-alpha.2 → 0.1.0-alpha.3

package/README.md

@@ -86,7 +86,7 @@ In order serve the component from the prior step as an image, you need a js/ts [
 
 ```ts
 import opengraphTemplate from "../components/opengraph.astro";
-import { makeOpengraphEndpoint } from "@altano/astro-opengraph";
+import { makeOpengraphEndpoint } from "@altano/astro-opengraph/endpoint";
 
 export const GET = makeOpengraphEndpoint({
   template: opengraphTemplate,
@@ -142,6 +142,8 @@ import OpenGraphMeta from "@altano/astro-opengraph/components/meta.astro";
 </html>
 ```
 
+You can also provide an `alt` prop which would set the `og:image:alt` meta tag, but my understanding is that it isn't well supported, so feel free to omit this.
+
 If you want the `OpenGraphMeta` component to use a different set of defaults for your whole site, you can provide the `componentMetaTagFallbacks` integration config, e.g. to provide a default title:
 
 ```ts
@@ -274,7 +276,7 @@ It doesn't matter where you put your Open Graph component or endpoints, as long
 ```ts
 // import your component, wherever it is
 import opengraphTemplate from "../components/my-custom-component.astro";
-import { makeOpengraphEndpoint } from "@altano/astro-opengraph";
+import { makeOpengraphEndpoint } from "@altano/astro-opengraph/endpoint";
 
 export const GET = makeOpengraphEndpoint({
   template: opengraphTemplate,

package/components/meta.astro

@@ -21,6 +21,10 @@ export type Props = {
    *   something else, provide the path to the resulting image here.
    */
   image?: string;
+  /**
+   * The specification says "A description of what is in the image (not a caption). If the page specifies an og:image it should specify og:image:alt." but people have found this to be poorly supported. Use if you want.
+   */
+  alt?: string;
   /**
    * Override the width, which otherwise defaults to:
    *
@@ -42,9 +46,9 @@ export type Props = {
    */
   height?: number;
   /**
-   * Override the mimetype, which defaults to "image/png"
+   * Override `og:image:type` MIME type, which defaults to "image/png"
    */
-  mimeType?: string;
+  type?: string;
 };
 
 const { imageOptions, componentMetaTagFallbacks } = await getResolvedConfig();
@@ -56,12 +60,13 @@ const {
 } = componentMetaTagFallbacks;
 
 const {
+  alt,
   title = titleFallback,
   description = descriptionFallback,
   image = imageUrlFallback,
   width = imageOptions.width,
   height = imageOptions.height,
-  mimeType = "image/png",
+  type = "image/png",
 } = Astro.props;
 
 const urlStr = Astro.url.toString();
@@ -72,6 +77,7 @@ const opengraphImageUrl = new URL(image, urlWithTrailingSlash);
 {title && <meta property="og:title" content={title} />}
 {description && <meta property="og:description" content={description} />}
 <meta property="og:image" content={opengraphImageUrl.toString()} />
-<meta property="og:image:type" content={mimeType} />
+{alt && <meta property="og:image:alt" content={alt} />}
+<meta property="og:image:type" content={type} />
 <meta property="og:image:width" content={width.toString()} />
 <meta property="og:image:height" content={height.toString()} />

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { default } from "./integration.js";
+export type { OpengraphImageConfig, ImageOptionsWithFontPaths, ComponentMetaTagFallbacks, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@altano/astro-opengraph",
-  "version": "0.0.1-alpha.2",
+  "version": "0.1.0-alpha.3",
   "description": "Open Graph Tools for Astro",
   "keywords": [
     "astro",
@@ -40,6 +40,7 @@
     "satori-html": "^0.3.2"
   },
   "devDependencies": {
+    "@astrojs/check": "^0.9.4",
     "@inox-tools/astro-tests": "0.5.1",
     "@playwright/test": "1.47.0",
     "@types/he": "^1.2.3",
@@ -58,11 +59,13 @@
     "typescript": "^5.8.2",
     "vite": "^6.2.5",
     "vitest": "^3.1.1",
+    "zx": "^8.5.2",
     "@altano/assets": "0.0.0",
-    "@altano/testing": "0.0.0",
-    "@altano/vitest-plugins": "1.1.0",
     "@altano/build-config": "0.0.0",
-    "@altano/tsconfig": "0.0.0"
+    "@altano/testing": "0.0.0",
+    "@altano/tsconfig": "0.0.0",
+    "@altano/tiny-async-pool": "3.0.2",
+    "@altano/vitest-plugins": "1.1.0"
   },
   "peerDependencies": {
     "@types/react": ">=18",
@@ -77,6 +80,7 @@
   "scripts": {
     "build": "tsup --config ./tsup.config.ts",
     "build:types": "tsc --project tsconfig.declarations.json",
+    "check:types:astro-fixtures": "node --experimental-strip-types ./scripts/check-fixtures.ts",
     "check:types:src": "tsc --noEmit",
     "check:types:test": "tsc --noEmit --project ./tests/tsconfig.json",
     "check:unused-dependencies": "depcheck",