@aglyn/aglyn 1.0.0-beta.207 → 1.0.0-beta.209

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aglyn/aglyn",
-  "version": "1.0.0-beta.207",
+  "version": "1.0.0-beta.209",
   "license": "Apache-2.0",
   "homepage": "https://aglyn.com",
   "repository": {
@@ -33,16 +33,16 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@aglyn/shared-data-enums": "1.0.0-beta.207",
-    "@aglyn/shared-data-mdi": "1.0.0-beta.207",
-    "@aglyn/shared-data-types": "1.0.0-beta.207",
-    "@aglyn/shared-util-email": "1.0.0-beta.207",
-    "@aglyn/shared-util-first-touch": "1.0.0-beta.207",
-    "@aglyn/shared-util-http": "1.0.0-beta.207",
-    "@aglyn/shared-util-logger": "1.0.0-beta.207",
-    "@aglyn/shared-util-timestamp": "1.0.0-beta.207",
-    "@aglyn/shared-util-tools": "1.0.0-beta.207",
-    "@aglyn/shared-util-vendor": "1.0.0-beta.207",
+    "@aglyn/shared-data-enums": "1.0.0-beta.209",
+    "@aglyn/shared-data-mdi": "1.0.0-beta.209",
+    "@aglyn/shared-data-types": "1.0.0-beta.209",
+    "@aglyn/shared-util-email": "1.0.0-beta.209",
+    "@aglyn/shared-util-first-touch": "1.0.0-beta.209",
+    "@aglyn/shared-util-http": "1.0.0-beta.209",
+    "@aglyn/shared-util-logger": "1.0.0-beta.209",
+    "@aglyn/shared-util-timestamp": "1.0.0-beta.209",
+    "@aglyn/shared-util-tools": "1.0.0-beta.209",
+    "@aglyn/shared-util-vendor": "1.0.0-beta.209",
     "@data-driven-forms/react-form-renderer": "^4.2.0",
     "@msgpack/msgpack": "^3.1.3",
     "@types/unist": "^3.0.3",

package/src/lib/app-utils/announce-site-wide-change.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * A plugin's console card just saved a SITE-WIDE setting: drop every cached
+ * page of the site (AGL-3386).
+ *
+ * The plugin-side door to the console's own `/api/screens/revalidate`, which
+ * a plugin cannot import. A setting that lives on the host document, or on a
+ * site-wide settings document beside it — the announcement bar, the popup,
+ * the store's currency — is rendered on every page and saved with no publish
+ * step, so without this the live site shows it only once each page's
+ * hour-long cache happens to lapse.
+ *
+ * `entireHost` because such a setting has no address of its own. It is the
+ * console route's explicit whole-site branch, authorized for exactly the
+ * roles the rules let write the site — the caller already proved that by
+ * writing.
+ *
+ * Call it AFTER the write has succeeded, and do not await it into the save's
+ * outcome: it never throws and never rejects, because a cache hint that fails
+ * must not make a successful save look failed. The hour-long window is still
+ * underneath as the backstop.
+ */
+export declare function announceSiteWideChange(options: {
+    /** The signed-in user; its ID token authenticates the console route. */
+    user: {
+        getIdToken?: () => Promise<string>;
+    } | null | undefined;
+    hostId: string;
+}): Promise<boolean>;
+export default announceSiteWideChange;

package/src/lib/app-utils/announce-site-wide-change.js

@@ -0,0 +1,58 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ import { authorizedFetch } from "@aglyn/shared-util-http/authorized-token";
+/**
+ * A plugin's console card just saved a SITE-WIDE setting: drop every cached
+ * page of the site (AGL-3386).
+ *
+ * The plugin-side door to the console's own `/api/screens/revalidate`, which
+ * a plugin cannot import. A setting that lives on the host document, or on a
+ * site-wide settings document beside it — the announcement bar, the popup,
+ * the store's currency — is rendered on every page and saved with no publish
+ * step, so without this the live site shows it only once each page's
+ * hour-long cache happens to lapse.
+ *
+ * `entireHost` because such a setting has no address of its own. It is the
+ * console route's explicit whole-site branch, authorized for exactly the
+ * roles the rules let write the site — the caller already proved that by
+ * writing.
+ *
+ * Call it AFTER the write has succeeded, and do not await it into the save's
+ * outcome: it never throws and never rejects, because a cache hint that fails
+ * must not make a successful save look failed. The hour-long window is still
+ * underneath as the backstop.
+ */ export async function announceSiteWideChange(options) {
+    const { user, hostId } = options;
+    if (!hostId) return false;
+    try {
+        const response = await authorizedFetch(user, '/api/screens/revalidate', {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({
+                hostId,
+                entireHost: true
+            })
+        });
+        return response.ok;
+    } catch (unused) {
+        return false;
+    }
+}
+export default announceSiteWideChange;
+
+//# sourceMappingURL=announce-site-wide-change.js.map

package/src/lib/app-utils/announce-site-wide-change.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/aglyn/src/lib/app-utils/announce-site-wide-change.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { authorizedFetch } from '@aglyn/shared-util-http/authorized-token'\n\n/**\n * A plugin's console card just saved a SITE-WIDE setting: drop every cached\n * page of the site (AGL-3386).\n *\n * The plugin-side door to the console's own `/api/screens/revalidate`, which\n * a plugin cannot import. A setting that lives on the host document, or on a\n * site-wide settings document beside it — the announcement bar, the popup,\n * the store's currency — is rendered on every page and saved with no publish\n * step, so without this the live site shows it only once each page's\n * hour-long cache happens to lapse.\n *\n * `entireHost` because such a setting has no address of its own. It is the\n * console route's explicit whole-site branch, authorized for exactly the\n * roles the rules let write the site — the caller already proved that by\n * writing.\n *\n * Call it AFTER the write has succeeded, and do not await it into the save's\n * outcome: it never throws and never rejects, because a cache hint that fails\n * must not make a successful save look failed. The hour-long window is still\n * underneath as the backstop.\n */\nexport async function announceSiteWideChange(options: {\n  /** The signed-in user; its ID token authenticates the console route. */\n  user: { getIdToken?: () => Promise<string> } | null | undefined\n  hostId: string\n}): Promise<boolean> {\n  const { user, hostId } = options\n  if (!hostId) return false\n  try {\n    const response = await authorizedFetch(user, '/api/screens/revalidate', {\n      method: 'POST',\n      headers: { 'Content-Type': 'application/json' },\n      body: JSON.stringify({ hostId, entireHost: true }),\n    })\n    return response.ok\n  } catch {\n    return false\n  }\n}\n\nexport default announceSiteWideChange\n"],"names":["authorizedFetch","announceSiteWideChange","options","user","hostId","response","method","headers","body","JSON","stringify","entireHost","ok"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAASA,eAAe,QAAQ,2CAA0C;AAE1E;;;;;;;;;;;;;;;;;;;;CAoBC,GACD,OAAO,eAAeC,uBAAuBC,OAI5C;IACC,MAAM,EAAEC,IAAI,EAAEC,MAAM,EAAE,GAAGF;IACzB,IAAI,CAACE,QAAQ,OAAO;IACpB,IAAI;QACF,MAAMC,WAAW,MAAML,gBAAgBG,MAAM,2BAA2B;YACtEG,QAAQ;YACRC,SAAS;gBAAE,gBAAgB;YAAmB;YAC9CC,MAAMC,KAAKC,SAAS,CAAC;gBAAEN;gBAAQO,YAAY;YAAK;QAClD;QACA,OAAON,SAASO,EAAE;IACpB,EAAE,eAAM;QACN,OAAO;IACT;AACF;AAEA,eAAeX,uBAAsB"}

package/src/lib/app-utils/docs-index.generated.js

@@ -6540,7 +6540,7 @@ export const ASSIST_DOCS_INDEX = [
         title: 'Publish your first screen',
         heading: 'How fast changes go live',
         anchor: '#how-fast-changes-go-live',
-        text: '- Publishing a screen refreshes its live page immediately — the very next visitor gets the new version, usually within seconds.\n- Publishing a layout or a reusable component refreshes every page that uses it the same way. When that fan-out is very large, the publish confirms that the remaining pages "update on their own within an hour" — and they do.\n- Saving is not publishing. A save writes your working version; the live site serves the published one. The one subtle case: if you edit the version that is currently live and press Save, the live site catches up on its own within about a minute — and because pages regenerate behind the scenes, you may need to refresh twice to see it.\n- Your site\'s sitemap.xml, robots.txt, and RSS feeds refresh within about five minutes (a publish refreshes the sitemap immediately).'
+        text: '- Publishing a screen refreshes its live page immediately — the very next visitor gets the new version, usually within seconds.\n- Publishing a layout or a reusable component refreshes every page that uses it the same way. When that fan-out is very large, the publish confirms that the remaining pages "update on their own within an hour" — and they do.\n- Site settings go live when you save them. Your theme, logo, favicon, app icon, social image, SEO and structured data, business details, languages, consent banner, announcement bar, popup and store settings have no publish step — saving one refreshes every page of the live site immediately, the same way a publish does. Installing, updating or resetting a marketplace theme does too.\n- Saving is not publishing. A save writes your working version; the live site serves the published one. The one subtle case: if you edit the version that is currently live and press Save, the live site catches up on its own within about a minute — and because pages regenerate behind the scenes, you may need to refresh twice to see it.\n- Your site\'s sitemap.xml, robots.txt, and RSS feeds refresh within about five minutes (a publish refreshes the sitemap immediately).'
     },
     {
         path: '/getting-started/publish-your-first-screen',