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

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

@@ -1,45 +0,0 @@
-/**
- * @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

@@ -1,58 +0,0 @@
-/**
- * @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

@@ -1 +0,0 @@
-{"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"}