@jamwidgets/astro 0.5.0 → 0.6.1

package/README.md

@@ -11,6 +11,18 @@ Astro components and content loader for [Jamwidgets](https://jamwidgets.com) - w
 npm install @jamwidgets/astro
 ```
 
+## Galleries
+
+```astro
+---
+import GalleryIndex from "@jamwidgets/astro/GalleryIndex";
+import Gallery from "@jamwidgets/astro/Gallery";
+---
+
+<GalleryIndex siteKey="your-key" deepLink />
+<Gallery siteKey="your-key" slug="field-notes" tag="portraits" />
+```
+
 ## Setup
 
 Add your Jamwidgets site key to your `.env`:
@@ -58,6 +70,49 @@ const posts = await getCollection("posts");
 ))}
 ```
 
+Render a post's Markdown body with Astro's content component:
+
+```astro
+---
+import { getEntry, render } from "astro:content";
+import { Image } from "astro:assets";
+const post = await getEntry("posts", "hello-world");
+if (!post) throw new Error("Post not found");
+const { Content } = await render(post);
+---
+
+{post.data.coverImage && (
+  <Image
+    src={post.data.coverImage}
+    inferSize
+    layout="full-width"
+    alt={post.data.title}
+  />
+)}
+<article><Content /></article>
+```
+
+`post.data.content` is Markdown, not an HTML string. Do not render it with
+`set:html`; use Astro's `render()` and `<Content />` as above.
+
+For responsive uploaded images, authorize Jamwidgets' asset host in your Astro
+config. Astro will then generate correctly sized image variants for Markdown
+images. The hostname below is for Jamwidgets Cloud; self-hosted deployments use
+the hostname configured by `ASSET_BASE_URL` (or fall back to
+`<AWS_S3_BUCKET>.s3.<AWS_S3_REGION>.amazonaws.com`):
+
+```js
+import { defineConfig } from "astro/config";
+
+export default defineConfig({
+  image: {
+    domains: ["assets.jamwidgets.com"],
+    layout: "constrained",
+    responsiveStyles: true,
+  },
+});
+```
+
 ### Loader Options
 
 ```ts

package/dist/index.d.ts

@@ -5,7 +5,8 @@
  * Re-exports all types, API functions, and controllers from @jamwidgets/core.
  */
 export { DEFAULT_ENDPOINT, API_PATH, VISITOR_STORAGE_KEY, type JamwidgetsConfig, type SeriphConfig, // deprecated alias
-type Comment, type ReactionCounts, type FormSubmitResponse, type SubscribeResponse, type JamwidgetsPost, type SeriphPost, // deprecated alias
-type Announcement, type AnnouncementType, type Poll, type PollOption, type PollSettings, type PollWithResults, type ShowResultsMode, type FeedbackType, buildUrl, getSiteKey, getVisitorId, setVisitorId, type SubmitFormOptions, submitForm, type FetchCommentsOptions, fetchComments, type PostCommentOptions, postComment, type FetchReactionsOptions, type FetchReactionsResponse, fetchReactions, type AddReactionOptions, addReaction, type RemoveReactionOptions, removeReaction, type SubscribeOptions, subscribe, type JoinWaitlistOptions, type JoinWaitlistResponse, joinWaitlist, type ViewCountsOptions, type ViewCounts, type RecordViewResponse, getViewCounts, recordView, type SubmitFeedbackOptions, type SubmitFeedbackResponse, submitFeedback, type FetchPollOptions, fetchPoll, type VotePollOptions, type VotePollResponse, votePoll, type FetchAnnouncementsOptions, fetchAnnouncements, type DismissAnnouncementOptions, dismissAnnouncement, type FetchPostsOptions, fetchPosts, type FetchPostOptions, fetchPost, type SiteConfig, fetchSiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, type ControllerStatus, type ControllerListener, type SubscribeState, type FormState, type ReactionsState, type CommentsState, type WaitlistState, type ViewCountsState, type FeedbackState, type PollState, type AnnouncementsState, SubscribeController, WaitlistController, FormController, ReactionsController, CommentsController, ViewCountsController, FeedbackController, PollController, AnnouncementsController, } from "@jamwidgets/core";
+type Comment, type ReactionCounts, type FormSubmitResponse, type SubscribeResponse, type JamwidgetsPost, type JamwidgetsGallery, type GalleryPhoto, type GallerySummary, type SeriphPost, // deprecated alias
+type Announcement, type AnnouncementType, type Poll, type PollOption, type PollSettings, type PollWithResults, type ShowResultsMode, type FeedbackType, buildUrl, getSiteKey, getVisitorId, setVisitorId, type SubmitFormOptions, submitForm, type FetchCommentsOptions, fetchComments, type PostCommentOptions, postComment, type FetchReactionsOptions, type FetchReactionsResponse, fetchReactions, type AddReactionOptions, addReaction, type RemoveReactionOptions, removeReaction, type SubscribeOptions, subscribe, type JoinWaitlistOptions, type JoinWaitlistResponse, joinWaitlist, type ViewCountsOptions, type ViewCounts, type RecordViewResponse, getViewCounts, recordView, type SubmitFeedbackOptions, type SubmitFeedbackResponse, submitFeedback, type FetchPollOptions, fetchPoll, type VotePollOptions, type VotePollResponse, votePoll, type FetchAnnouncementsOptions, fetchAnnouncements, type DismissAnnouncementOptions, dismissAnnouncement, type FetchPostsOptions, fetchPosts, type FetchPostOptions, fetchPost, type FetchGalleriesOptions, fetchGalleries, type FetchGalleryOptions, fetchGallery, type FetchRandomPhotoOptions, fetchRandomPhoto, type SiteConfig, fetchSiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, type ControllerStatus, type ControllerListener, type SubscribeState, type FormState, type ReactionsState, type CommentsState, type WaitlistState, type ViewCountsState, type FeedbackState, type PollState, type AnnouncementsState, SubscribeController, WaitlistController, FormController, ReactionsController, CommentsController, ViewCountsController, FeedbackController, PollController, AnnouncementsController, } from "@jamwidgets/core";
 export { jamwidgetsPostsLoader, seriphPostsLoader, // deprecated alias
-type JamwidgetsPostsLoaderOptions, type SeriphPostsLoaderOptions, } from "./loader.js";
+type JamwidgetsPostsLoaderOptions, type SeriphPostsLoaderOptions, // deprecated alias
+jamwidgetsGalleriesLoader, type JamwidgetsGalleriesLoaderOptions, } from "./loader.js";

package/dist/index.js

@@ -9,7 +9,7 @@ export {
 // Constants
 DEFAULT_ENDPOINT, API_PATH, VISITOR_STORAGE_KEY, 
 // Helpers
-buildUrl, getSiteKey, getVisitorId, setVisitorId, submitForm, fetchComments, postComment, fetchReactions, addReaction, removeReaction, subscribe, joinWaitlist, getViewCounts, recordView, submitFeedback, fetchPoll, votePoll, fetchAnnouncements, dismissAnnouncement, fetchPosts, fetchPost, fetchSiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, SubscribeController, WaitlistController, FormController, ReactionsController, CommentsController, ViewCountsController, FeedbackController, PollController, AnnouncementsController, } from "@jamwidgets/core";
+buildUrl, getSiteKey, getVisitorId, setVisitorId, submitForm, fetchComments, postComment, fetchReactions, addReaction, removeReaction, subscribe, joinWaitlist, getViewCounts, recordView, submitFeedback, fetchPoll, votePoll, fetchAnnouncements, dismissAnnouncement, fetchPosts, fetchPost, fetchGalleries, fetchGallery, fetchRandomPhoto, fetchSiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, SubscribeController, WaitlistController, FormController, ReactionsController, CommentsController, ViewCountsController, FeedbackController, PollController, AnnouncementsController, } from "@jamwidgets/core";
 // Re-export loader (Astro-specific)
 export { jamwidgetsPostsLoader, seriphPostsLoader, // deprecated alias
- } from "./loader.js";
+jamwidgetsGalleriesLoader, } from "./loader.js";

package/dist/loader.d.ts

@@ -45,3 +45,10 @@ export type SeriphPostsLoaderOptions = JamwidgetsPostsLoaderOptions;
 export declare function jamwidgetsPostsLoader(options: JamwidgetsPostsLoaderOptions): Loader;
 /** @deprecated Use jamwidgetsPostsLoader instead */
 export declare const seriphPostsLoader: typeof jamwidgetsPostsLoader;
+export interface JamwidgetsGalleriesLoaderOptions {
+    siteKey: string;
+    endpoint?: string;
+    origin?: string;
+    onError?: "throw" | "warn" | "ignore";
+}
+export declare function jamwidgetsGalleriesLoader(options: JamwidgetsGalleriesLoaderOptions): Loader;

package/dist/loader.js

@@ -16,7 +16,7 @@
  *
  * export const collections = { posts };
  */
-import { DEFAULT_ENDPOINT, API_PATH, getSiteKey, fetchPosts as coreFetchPosts, fetchPost as coreFetchPost, } from "@jamwidgets/core";
+import { DEFAULT_ENDPOINT, API_PATH, getSiteKey, fetchPosts as coreFetchPosts, fetchPost as coreFetchPost, fetchGalleries as coreFetchGalleries, fetchGallery as coreFetchGallery, } from "@jamwidgets/core";
 export { coreFetchPosts as fetchPosts, coreFetchPost as fetchPost };
 /**
  * Creates an Astro content loader that fetches posts from Jamwidgets.
@@ -30,7 +30,7 @@ export function jamwidgetsPostsLoader(options) {
     return {
         name: "jamwidgets-posts-loader",
         async load(context) {
-            const { store, logger } = context;
+            const { store, logger, renderMarkdown } = context;
             try {
                 const url = new URL(`${baseUrl}/posts`);
                 url.searchParams.set("limit", String(limit));
@@ -50,12 +50,15 @@ export function jamwidgetsPostsLoader(options) {
                     throw new Error(`Failed to fetch posts: ${response.status} ${response.statusText}`);
                 }
                 const data = await response.json();
+                const entries = await Promise.all(data.posts.map(async (post) => ({
+                    id: post.slug,
+                    data: { ...post },
+                    body: post.content,
+                    rendered: await renderMarkdown(post.content),
+                })));
                 store.clear();
-                for (const post of data.posts) {
-                    store.set({
-                        id: post.slug,
-                        data: { ...post },
-                    });
+                for (const entry of entries) {
+                    store.set(entry);
                 }
                 logger.info(`Loaded ${data.posts.length} posts from Jamwidgets`);
             }
@@ -74,3 +77,43 @@ export function jamwidgetsPostsLoader(options) {
 }
 /** @deprecated Use jamwidgetsPostsLoader instead */
 export const seriphPostsLoader = jamwidgetsPostsLoader;
+export function jamwidgetsGalleriesLoader(options) {
+    const { endpoint = DEFAULT_ENDPOINT, origin, onError = "throw" } = options;
+    const siteKey = getSiteKey({ siteKey: options.siteKey });
+    return {
+        name: "jamwidgets-galleries-loader",
+        async load({ store, logger }) {
+            try {
+                const summaries = [];
+                let after;
+                do {
+                    const page = await coreFetchGalleries({
+                        siteKey,
+                        endpoint,
+                        origin,
+                        limit: 100,
+                        after,
+                    });
+                    summaries.push(...page.galleries);
+                    after = page.nextCursor;
+                } while (after);
+                const galleries = [];
+                for (const summary of summaries) {
+                    galleries.push(await coreFetchGallery({ siteKey, endpoint, origin, slug: summary.slug }));
+                }
+                const entries = galleries.filter((gallery) => gallery !== null);
+                store.clear();
+                for (const gallery of entries)
+                    store.set({ id: gallery.slug, data: { ...gallery } });
+                logger.info(`Loaded ${entries.length} galleries from Jamwidgets at build time`);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                if (onError === "throw")
+                    throw error;
+                if (onError === "warn")
+                    logger.warn(`Error loading galleries: ${message}`);
+            }
+        },
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jamwidgets/astro",
-  "version": "0.5.0",
-  "description": "Astro components and content loader for Jamwidgets (forms, comments, reactions, posts)",
+  "version": "0.6.1",
+  "description": "Astro components and content loaders for Jamwidgets",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jamwidgets/astro.git"
@@ -33,7 +33,10 @@
     "./Announcements": "./src/Announcements.astro",
     "./Feedback": "./src/Feedback.astro",
     "./Waitlist": "./src/Waitlist.astro",
-    "./Embed": "./src/Embed.astro"
+    "./Embed": "./src/Embed.astro",
+    "./Gallery": "./src/Gallery.astro",
+    "./GalleryIndex": "./src/GalleryIndex.astro",
+    "./RandomPhoto": "./src/RandomPhoto.astro"
   },
   "files": [
     "src",
@@ -57,10 +60,10 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@jamwidgets/core": "^0.4.0"
+    "@jamwidgets/core": "^0.5.1"
   },
   "peerDependencies": {
-    "astro": "^5.0.0 || ^6.0.0 || ^7.0.0"
+    "astro": "^5.9.0 || ^6.0.0 || ^7.0.0"
   },
   "devDependencies": {
     "astro": "^7.1.3",

package/src/Embed.astro

@@ -7,7 +7,8 @@
  * any embedded polls, reactions, etc.
  *
  * @example
- * <article set:html={post.content} />
+ * const { Content } = await render(post);
+ * <article><Content /></article>
  * <Embed siteKey={import.meta.env.JAMWIDGETS_SITE_KEY} />
  */
 

package/src/Gallery.astro

@@ -0,0 +1,8 @@
+---
+interface Props { siteKey: string; slug: string; endpoint?: string; tag?: string }
+const { siteKey, slug, endpoint, tag } = Astro.props;
+---
+<jamwidgets-gallery site-key={siteKey} slug={slug} endpoint={endpoint} tag={tag} />
+<script>
+  import "@jamwidgets/core/gallery-elements";
+</script>

package/src/GalleryIndex.astro

@@ -0,0 +1,8 @@
+---
+interface Props { siteKey: string; endpoint?: string; deepLink?: boolean }
+const { siteKey, endpoint, deepLink = false } = Astro.props;
+---
+<jamwidgets-gallery-index site-key={siteKey} endpoint={endpoint} deep-link={deepLink ? "" : undefined} />
+<script>
+  import "@jamwidgets/core/gallery-elements";
+</script>

package/src/RandomPhoto.astro

@@ -0,0 +1,8 @@
+---
+interface Props { siteKey: string; slug: string; endpoint?: string; tag?: string; seed?: string }
+const { siteKey, slug, endpoint, tag, seed } = Astro.props;
+---
+<jamwidgets-random-photo site-key={siteKey} slug={slug} endpoint={endpoint} tag={tag} seed={seed} />
+<script>
+  import "@jamwidgets/core/gallery-elements";
+</script>

package/src/index.ts

@@ -20,6 +20,9 @@ export {
   type FormSubmitResponse,
   type SubscribeResponse,
   type JamwidgetsPost,
+  type JamwidgetsGallery,
+  type GalleryPhoto,
+  type GallerySummary,
   type SeriphPost, // deprecated alias
   type Announcement,
   type AnnouncementType,
@@ -94,6 +97,12 @@ export {
   fetchPosts,
   type FetchPostOptions,
   fetchPost,
+  type FetchGalleriesOptions,
+  fetchGalleries,
+  type FetchGalleryOptions,
+  fetchGallery,
+  type FetchRandomPhotoOptions,
+  fetchRandomPhoto,
 
   // Site config + powered-by attribution
   type SiteConfig,
@@ -130,4 +139,6 @@ export {
   seriphPostsLoader, // deprecated alias
   type JamwidgetsPostsLoaderOptions,
   type SeriphPostsLoaderOptions, // deprecated alias
+  jamwidgetsGalleriesLoader,
+  type JamwidgetsGalleriesLoaderOptions,
 } from "./loader.js";

package/src/loader.ts

@@ -27,6 +27,10 @@ import {
   type SeriphPost, // deprecated alias
   type FetchPostsOptions,
   type FetchPostOptions,
+  fetchGalleries as coreFetchGalleries,
+  fetchGallery as coreFetchGallery,
+  type JamwidgetsGallery,
+  type GallerySummary,
 } from "@jamwidgets/core";
 import type { Loader, LoaderContext } from "astro/loaders";
 
@@ -78,7 +82,7 @@ export function jamwidgetsPostsLoader(options: JamwidgetsPostsLoaderOptions): Lo
     name: "jamwidgets-posts-loader",
 
     async load(context: LoaderContext) {
-      const { store, logger } = context;
+      const { store, logger, renderMarkdown } = context;
 
       try {
         const url = new URL(`${baseUrl}/posts`);
@@ -106,13 +110,18 @@ export function jamwidgetsPostsLoader(options: JamwidgetsPostsLoaderOptions): Lo
 
         const data: ApiResponse = await response.json();
 
-        store.clear();
-
-        for (const post of data.posts) {
-          store.set({
+        const entries = await Promise.all(
+          data.posts.map(async (post) => ({
             id: post.slug,
             data: { ...post },
-          });
+            body: post.content,
+            rendered: await renderMarkdown(post.content),
+          })),
+        );
+
+        store.clear();
+        for (const entry of entries) {
+          store.set(entry);
         }
 
         logger.info(`Loaded ${data.posts.length} posts from Jamwidgets`);
@@ -132,3 +141,49 @@ export function jamwidgetsPostsLoader(options: JamwidgetsPostsLoaderOptions): Lo
 
 /** @deprecated Use jamwidgetsPostsLoader instead */
 export const seriphPostsLoader = jamwidgetsPostsLoader;
+
+export interface JamwidgetsGalleriesLoaderOptions {
+  siteKey: string;
+  endpoint?: string;
+  origin?: string;
+  onError?: "throw" | "warn" | "ignore";
+}
+
+export function jamwidgetsGalleriesLoader(options: JamwidgetsGalleriesLoaderOptions): Loader {
+  const { endpoint = DEFAULT_ENDPOINT, origin, onError = "throw" } = options;
+  const siteKey = getSiteKey({ siteKey: options.siteKey });
+  return {
+    name: "jamwidgets-galleries-loader",
+    async load({ store, logger }: LoaderContext) {
+      try {
+        const summaries: GallerySummary[] = [];
+        let after: string | undefined;
+        do {
+          const page = await coreFetchGalleries({
+            siteKey,
+            endpoint,
+            origin,
+            limit: 100,
+            after,
+          });
+          summaries.push(...page.galleries);
+          after = page.nextCursor;
+        } while (after);
+        const galleries: Array<JamwidgetsGallery | null> = [];
+        for (const summary of summaries) {
+          galleries.push(
+            await coreFetchGallery({ siteKey, endpoint, origin, slug: summary.slug }),
+          );
+        }
+        const entries = galleries.filter((gallery): gallery is JamwidgetsGallery => gallery !== null);
+        store.clear();
+        for (const gallery of entries) store.set({ id: gallery.slug, data: { ...gallery } });
+        logger.info(`Loaded ${entries.length} galleries from Jamwidgets at build time`);
+      } catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        if (onError === "throw") throw error;
+        if (onError === "warn") logger.warn(`Error loading galleries: ${message}`);
+      }
+    },
+  };
+}