npm - @ampless/runtime - Versions diffs - 1.0.0-alpha.23 → 1.0.0-alpha.24 - Mend

@ampless/runtime 1.0.0-alpha.23 → 1.0.0-alpha.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -123,19 +123,50 @@ interface SeoApi {
     siteMetadata(): Promise<Metadata>;
 }
+/**
+ * Per-instance flat map of stored field values, keyed by the field's
+ * `key` (not the full `plugins.<instanceId>.<key>` SK). The keys
+ * here mirror the field manifest so callers can hand the map
+ * directly to `resolvePluginSettings`.
+ */
+type PluginSettingsSnapshot = Map<string, Record<string, unknown>>;
+interface PluginSettingsApi {
+    /**
+     * Fetch all `plugins.*` settings from the public cache and bucket
+     * them by `instanceId`. Returns an empty Map on any failure mode
+     * (storage unconfigured, 404, JSON parse error) — callers fall
+     * back to manifest defaults so the layout never crashes when the
+     * cache is missing.
+     */
+    loadAll(): Promise<PluginSettingsSnapshot>;
+}
+declare function createPluginSettings(storage: StorageApi): PluginSettingsApi;
 interface PluginHeadApi {
-    /** React children safe to drop into `<head>`. */
-    renderHead(): ReactNode;
+    /**
+     * React children safe to drop into `<head>`. Async because admin-
+     * managed settings are read from S3 on the first call per request.
+     * Within a single request both `renderHead` and `renderBodyEnd` share
+     * the same fetched snapshot via Next.js fetch dedup on the
+     * `site-settings` cache tag.
+     */
+    renderHead(): Promise<ReactNode>;
     /** React children safe to drop just before `</body>`. */
-    renderBodyEnd(): ReactNode;
+    renderBodyEnd(): Promise<ReactNode>;
 }
 /**
  * Create the head/body renderer for a `Config`. The constructor-time
  * pass logs a single dev warning when two plugins share an
  * `instanceId ?? name`; everything else happens at render time so
  * descriptors reflect per-request site config.
+ *
+ * `pluginSettings` (Phase 2) is the runtime accessor that pulls
+ * admin-managed `settings.public` values from the S3 site-settings
+ * cache. Within a single request we fetch once via `loadAll()` and
+ * bind a per-plugin `ctx.setting(key)` accessor before invoking
+ * either `publicHead` or `publicBodyEnd`.
  */
-declare function createPluginHead(cmsConfig: Config): PluginHeadApi;
+declare function createPluginHead(cmsConfig: Config, pluginSettings: PluginSettingsApi): PluginHeadApi;
 interface ThemesRegistry {
     /** Map of theme name → loaded theme module. */
@@ -351,8 +382,8 @@ interface Ampless {
     loadThemeConfig(): Promise<EffectiveThemeConfig>;
     postMetadata(post: Post): Promise<Metadata>;
     siteMetadata(): Promise<Metadata>;
-    publicHead(): ReactNode;
-    publicBodyEnd(): ReactNode;
+    publicHead(): Promise<ReactNode>;
+    publicBodyEnd(): Promise<ReactNode>;
     renderBody(post: Post): string;
     renderThemeCss(cssVars: Record<string, string>): string;
     publicAssetUrl(key: string): string;
@@ -368,6 +399,7 @@ interface Ampless {
     readonly themeConfig: ThemeConfigApi;
     readonly storageApi: StorageApi;
     readonly pluginHead: PluginHeadApi;
+    readonly pluginSettings: PluginSettingsApi;
 }
 /**
  * Wire up the ampless runtime from user-supplied config blobs. The
@@ -378,4 +410,4 @@ interface Ampless {
  */
 declare function createAmpless(opts: CreateAmplessOpts): Ampless;
-export { type Ampless, type AmplessOutputs, COLOR_SCHEME_SETTING_KEY, type ColorScheme, type CreateAmplessOpts, DEFAULT_COLOR_SCHEME, type DataOutput, type EffectiveSiteSettings, type EffectiveThemeConfig, type ListPostsByTagOptions, type ListPostsOptions, type ListPostsResult, type MediaApi, type PluginHeadApi, type PostsApi, type PublicMediaShape, type PublicPostConnectionShape, type PublicPostShape, type ResolvedAssetMeta, type ResolvedMedia, type ResolvedTheme, type SeoApi, type SiteSettingsApi, type StorageOutput, type StreamS3Options, type ThemeActiveApi, type ThemeConfigApi, type ThemesRegistry, _resetStreamS3Cache, createAmpless, createPluginHead, htmlToMarkdown, markdownToHtml, renderBody, renderThemeCss, streamS3Object, streamS3ObjectWithRunner, tiptapToHtml, tiptapToMarkdown, validateColorScheme };
+export { type Ampless, type AmplessOutputs, COLOR_SCHEME_SETTING_KEY, type ColorScheme, type CreateAmplessOpts, DEFAULT_COLOR_SCHEME, type DataOutput, type EffectiveSiteSettings, type EffectiveThemeConfig, type ListPostsByTagOptions, type ListPostsOptions, type ListPostsResult, type MediaApi, type PluginHeadApi, type PluginSettingsApi, type PluginSettingsSnapshot, type PostsApi, type PublicMediaShape, type PublicPostConnectionShape, type PublicPostShape, type ResolvedAssetMeta, type ResolvedMedia, type ResolvedTheme, type SeoApi, type SiteSettingsApi, type StorageOutput, type StreamS3Options, type ThemeActiveApi, type ThemeConfigApi, type ThemesRegistry, _resetStreamS3Cache, createAmpless, createPluginHead, createPluginSettings, htmlToMarkdown, markdownToHtml, renderBody, renderThemeCss, streamS3Object, streamS3ObjectWithRunner, tiptapToHtml, tiptapToMarkdown, validateColorScheme };

package/dist/index.js CHANGED Viewed

@@ -230,6 +230,10 @@ import {
   Fragment,
   createElement
 } from "react";
+import {
+  isValidPluginKey,
+  resolvePluginSettings
+} from "ampless";
 function isPlugin2(p) {
   return typeof p === "object" && p !== null && "apiVersion" in p;
 }
@@ -419,11 +423,25 @@ function dedupeAndKey(entries) {
   }
   return kept;
 }
-function collectFor(plugins, ctx, surface, renderOne) {
+function makeCtx(plugin, site, snapshot) {
+  const instanceId = plugin.instanceId ?? plugin.name;
+  const stored = snapshot.get(instanceId) ?? {};
+  const resolved = resolvePluginSettings(plugin.settings, stored);
+  return {
+    site,
+    setting(key) {
+      if (!isValidPluginKey(key)) return void 0;
+      const v = resolved[key];
+      return v === void 0 ? void 0 : v;
+    }
+  };
+}
+function collectFor(plugins, site, snapshot, surface, renderOne) {
   const entries = [];
   for (const plugin of plugins) {
     const factory = surface(plugin);
     if (!factory) continue;
+    const ctx = makeCtx(plugin, site, snapshot);
     let descriptors;
     try {
       descriptors = factory.call(plugin, ctx) ?? [];
@@ -443,18 +461,35 @@ function collectFor(plugins, ctx, surface, renderOne) {
   const keyed = dedupeAndKey(entries);
   return createElement(Fragment, null, ...keyed);
 }
-function createPluginHead(cmsConfig) {
+function createPluginHead(cmsConfig, pluginSettings) {
   const plugins = (cmsConfig.plugins ?? []).filter(isPlugin2);
+  const validPlugins = [];
   const seenNamespaces = /* @__PURE__ */ new Set();
   for (const plugin of plugins) {
     const ns = plugin.instanceId ?? plugin.name;
     const label = plugin.instanceId ? `${plugin.name}#${plugin.instanceId}` : plugin.name;
+    if (!isValidPluginKey(ns)) {
+      warn(
+        `${label}: plugin namespace "${ns}" violates ${`/^[a-zA-Z0-9_-]+$/`}. Use a simple identifier (letters / digits / "-" / "_"). Skipping plugin.`
+      );
+      continue;
+    }
     if (seenNamespaces.has(ns)) {
       warn(
         `duplicate plugin namespace "${ns}" detected in cms.config.plugins. Set distinct \`instanceId\` on each instance to disambiguate.`
       );
     }
     seenNamespaces.add(ns);
+    if (plugin.settings?.public) {
+      for (const field of plugin.settings.public) {
+        if (!isValidPluginKey(field.key)) {
+          warn(
+            `${label}: settings.public field key "${field.key}" violates ${`/^[a-zA-Z0-9_-]+$/`}. The field will not be readable through ctx.setting(). Rename the field key.`
+          );
+        }
+      }
+    }
+    validPlugins.push(plugin);
     const caps = plugin.capabilities;
     if (caps) {
       if (caps.includes("publicHead") && !plugin.publicHead) {
@@ -480,18 +515,22 @@ function createPluginHead(cmsConfig) {
     }
   }
   return {
-    renderHead() {
+    async renderHead() {
+      const snapshot = await pluginSettings.loadAll();
       return collectFor(
-        plugins,
-        { site: cmsConfig.site },
+        validPlugins,
+        cmsConfig.site,
+        snapshot,
         (p) => p.publicHead,
         renderHeadDescriptor
       );
     },
-    renderBodyEnd() {
+    async renderBodyEnd() {
+      const snapshot = await pluginSettings.loadAll();
       return collectFor(
-        plugins,
-        { site: cmsConfig.site },
+        validPlugins,
+        cmsConfig.site,
+        snapshot,
         (p) => p.publicBodyEnd,
         renderBodyDescriptor
       );
@@ -499,6 +538,44 @@ function createPluginHead(cmsConfig) {
   };
 }
+// src/plugin-settings.ts
+import { unflattenSettings as unflattenSettings2 } from "ampless";
+function createPluginSettings(storage) {
+  return {
+    async loadAll() {
+      const out = /* @__PURE__ */ new Map();
+      if (!storage.isStorageConfigured()) return out;
+      let url;
+      try {
+        url = storage.publicAssetUrl("public/site-settings.json");
+      } catch {
+        return out;
+      }
+      let flat;
+      try {
+        const res = await fetch(url, {
+          // Same revalidate + tag as site-settings.ts so a single
+          // request to the public route hits the JSON once and both
+          // helpers share the cached body.
+          next: { revalidate: 60, tags: ["site-settings"] }
+        });
+        if (!res.ok) return out;
+        flat = await res.json();
+      } catch {
+        return out;
+      }
+      const nested = unflattenSettings2(flat);
+      const pluginsBlock = nested.plugins;
+      if (!pluginsBlock || typeof pluginsBlock !== "object") return out;
+      for (const [instanceId, block] of Object.entries(pluginsBlock)) {
+        if (!block || typeof block !== "object" || Array.isArray(block)) continue;
+        out.set(instanceId, { ...block });
+      }
+      return out;
+    }
+  };
+}
 // src/theme-active.ts
 import { headers } from "next/headers";
 function createThemeActive(registry, storage) {
@@ -931,7 +1008,8 @@ function createAmpless(opts) {
   const media = createMediaApi(outputs);
   const settings = createSiteSettings(cmsConfig, storage);
   const seo = createSeo(cmsConfig, settings);
-  const pluginHead = createPluginHead(cmsConfig);
+  const pluginSettings = createPluginSettings(storage);
+  const pluginHead = createPluginHead(cmsConfig, pluginSettings);
   const themeActive = createThemeActive(themes, storage);
   const themeConfig = createThemeConfig(themeActive, storage);
   return {
@@ -961,7 +1039,8 @@ function createAmpless(opts) {
     themeActive,
     themeConfig,
     storageApi: storage,
-    pluginHead
+    pluginHead,
+    pluginSettings
   };
 }
 export {
@@ -970,6 +1049,7 @@ export {
   _resetStreamS3Cache,
   createAmpless,
   createPluginHead,
+  createPluginSettings,
   htmlToMarkdown,
   markdownToHtml,
   renderBody,

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@ampless/runtime",
-  "version": "1.0.0-alpha.23",
+  "version": "1.0.0-alpha.24",
   "description": "Public-side runtime for ampless: post fetching, theme dispatch, middleware, public route handlers",
   "license": "MIT",
   "type": "module",
@@ -49,8 +49,8 @@
     "lucide-react": "^1.16.0",
     "marked": "^18.0.4",
     "tailwind-merge": "^3.6.0",
-    "ampless": "1.0.0-alpha.17",
-    "@ampless/plugin-og-image": "0.2.0-alpha.17"
+    "ampless": "1.0.0-alpha.18",
+    "@ampless/plugin-og-image": "0.2.0-alpha.18"
   },
   "peerDependencies": {
     "next": "^15 || ^16",