@plitzi/sdk-elements 0.38.13 → 0.38.15

package/dist/elements/internal/Page/Settings.mjs

@@ -12,39 +12,39 @@ import m from "@plitzi/plitzi-ui/TextArea";
 import h from "@plitzi/plitzi-ui/Select";
 import g from "@plitzi/plitzi-ui/Select2";
 //#region src/elements/internal/Page/Settings.tsx
-var _ = ({ id: _ = "", seoEnabled: v = !1, enabled: y = !0, name: b = "", folder: x = "", seoPageTitle: S = "Title", seoPageDescription: C = "Description", slug: w = "", layout: T = "", layoutContainer: E = "", accessLevel: D = "", unauthorizedBehaviour: O = "", unauthorizedPageRedirect: k = "", onUpdate: A }) => {
-	let [[j, M, N]] = i([
+var _ = ({ id: _ = "", seoEnabled: v = !1, enabled: y = !0, name: b = "", folder: x = "", seoPageTitle: S = "Title", seoPageDescription: C = "Description", slug: w = "", layout: T = "", layoutContainer: E = "", accessLevel: D = "", unauthorizedBehaviour: O = "", unauthorizedPageRedirect: k = "", documentScroll: A = "", onUpdate: j }) => {
+	let [[M, N, P]] = i([
 		"schema.flat",
 		"schema.pages",
 		"schema.pageFolders"
-	]), P = r(() => Object.values(o(j, M.filter((e) => e !== _))), [
-		j,
+	]), F = r(() => Object.values(o(M, N.filter((e) => e !== _))), [
+		M,
 		_,
-		M
-	]), F = e(A), I = n((e) => {
-		A?.("name", e);
+		N
+	]), I = e(j), L = n((e) => {
+		j?.("name", e);
 		let t = b.replaceAll(" ", "-").toLowerCase().replaceAll(/([^a-z0-9]+)/gi, "");
-		(!w || w === t) && A?.("slug", e.replaceAll(" ", "-").toLowerCase().replaceAll(/([^a-z0-9-]+)/gi, ""));
+		(!w || w === t) && j?.("slug", e.replaceAll(" ", "-").toLowerCase().replaceAll(/([^a-z0-9-]+)/gi, ""));
 	}, [
-		A,
+		j,
 		w,
 		b
-	]), L = n((e) => {
+	]), R = n((e) => {
 		if (/^[a-zA-Z0-9:*/_-]+$/gim.test(e) || !e) {
 			let t = e.replaceAll("//", "/");
-			A?.("slug", t);
+			j?.("slug", t);
 		}
-	}, [A]), R = n((e) => {
-		A?.("accessLevel", e), A?.("unauthorizedBehaviour", ""), A?.("unauthorizedPageRedirect", "");
-	}, [A]), z = n((e) => A?.("seoEnabled", e.target.checked), [A]), B = n((e) => A?.("enabled", e.target.checked), [A]), V = n((e) => A?.("folder", e?.value ?? ""), [A]), H = r(() => [{
+	}, [j]), z = n((e) => {
+		j?.("accessLevel", e), j?.("unauthorizedBehaviour", ""), j?.("unauthorizedPageRedirect", "");
+	}, [j]), B = n((e) => j?.("seoEnabled", e.target.checked), [j]), V = n((e) => j?.("enabled", e.target.checked), [j]), H = n((e) => j?.("folder", e?.value ?? ""), [j]), U = r(() => [{
 		value: "",
 		label: "None"
-	}, ...N.map(({ id: e, name: t }) => ({
+	}, ...P.map(({ id: e, name: t }) => ({
 		value: e,
 		label: t
-	}))], [N]), U = r(() => u(j, N, _, !0), [
-		j,
-		N,
+	}))], [P]), W = r(() => u(M, P, _, !0), [
+		M,
+		P,
 		_
 	]);
 	return /* @__PURE__ */ l("div", {
@@ -62,13 +62,13 @@ var _ = ({ id: _ = "", seoEnabled: v = !1, enabled: y = !0, name: b = "", folder
 			/* @__PURE__ */ c(f, {
 				label: " Page Enabled",
 				checked: y,
-				onChange: B,
+				onChange: V,
 				size: "xs"
 			}),
 			/* @__PURE__ */ c(p, {
 				value: b,
 				label: "Page Name",
-				onChange: I,
+				onChange: L,
 				size: "xs"
 			}),
 			/* @__PURE__ */ c(d, {
@@ -84,36 +84,36 @@ var _ = ({ id: _ = "", seoEnabled: v = !1, enabled: y = !0, name: b = "", folder
 				className: "flex flex-col",
 				children: [/* @__PURE__ */ c(p, {
 					value: w,
-					onChange: L,
+					onChange: R,
 					label: "Slug / Path",
 					className: { inputContainer: "rounded-none rounded-tl rounded-tr" },
 					size: "xs"
 				}), /* @__PURE__ */ l("div", {
 					className: "truncate rounded-b border-x border-b border-gray-200 px-1 py-0.5 text-xs",
-					title: U,
+					title: W,
 					children: ["Full Path: ", /* @__PURE__ */ c("span", {
 						className: "font-bold",
-						children: U
+						children: W
 					})]
 				})]
 			}),
 			/* @__PURE__ */ c(g, {
 				label: "Folder",
 				value: x,
-				options: H,
+				options: U,
 				placeholder: "None",
-				onChange: V,
+				onChange: H,
 				size: "xs"
 			}),
 			/* @__PURE__ */ c(t, {
 				layout: T,
 				layoutContainer: E,
-				onUpdate: A
+				onUpdate: j
 			}),
 			/* @__PURE__ */ l(h, {
 				value: D,
 				label: "Restrict Access",
-				onChange: R,
+				onChange: z,
 				placeholder: "None",
 				size: "xs",
 				children: [/* @__PURE__ */ c("option", {
@@ -145,7 +145,7 @@ var _ = ({ id: _ = "", seoEnabled: v = !1, enabled: y = !0, name: b = "", folder
 			D !== "" && /* @__PURE__ */ c(h, {
 				label: "Unauthorized Behaviour",
 				value: O,
-				onChange: F.text("unauthorizedBehaviour"),
+				onChange: I.text("unauthorizedBehaviour"),
 				placeholder: "None",
 				size: "xs",
 				children: /* @__PURE__ */ c("option", {
@@ -156,31 +156,63 @@ var _ = ({ id: _ = "", seoEnabled: v = !1, enabled: y = !0, name: b = "", folder
 			O === "redirect" && /* @__PURE__ */ c(h, {
 				value: k,
 				label: "Redirect Page",
-				onChange: F.text("unauthorizedPageRedirect"),
+				onChange: I.text("unauthorizedPageRedirect"),
 				placeholder: "None",
 				size: "xs",
-				children: P.map((e) => /* @__PURE__ */ c("option", {
+				children: F.map((e) => /* @__PURE__ */ c("option", {
 					value: e.id,
 					children: a(e, "attributes.name")
 				}, e.id))
 			}),
+			/* @__PURE__ */ l(h, {
+				value: A,
+				label: "Document Scroll",
+				onChange: I.text("documentScroll"),
+				placeholder: "Scrolls",
+				size: "xs",
+				children: [/* @__PURE__ */ c("option", {
+					value: "noBounce",
+					children: "No bounce"
+				}), /* @__PURE__ */ c("option", {
+					value: "locked",
+					children: "Locked"
+				})]
+			}),
+			A === "noBounce" && /* @__PURE__ */ c(d, {
+				intent: "info",
+				solid: !1,
+				size: "xs",
+				children: /* @__PURE__ */ c("span", {
+					className: "text-xs",
+					children: "The page scrolls, but a finger pulled past either end no longer bounces it or reloads it"
+				})
+			}),
+			A === "locked" && /* @__PURE__ */ c(d, {
+				intent: "info",
+				solid: !1,
+				size: "xs",
+				children: /* @__PURE__ */ c("span", {
+					className: "text-xs",
+					children: "The page holds still: only the parts set to scroll on their own (overflow auto) move. For a screen that fills the window — a dashboard, a board"
+				})
+			}),
 			/* @__PURE__ */ c(f, {
 				label: " SEO Enabled",
 				checked: v,
-				onChange: z,
+				onChange: B,
 				size: "xs"
 			}),
 			v && /* @__PURE__ */ l(s, { children: [
 				/* @__PURE__ */ c(p, {
 					value: S,
 					label: "SEO Title",
-					onChange: F.text("seoPageTitle"),
+					onChange: I.text("seoPageTitle"),
 					size: "xs"
 				}),
 				/* @__PURE__ */ c(m, {
 					label: "SEO Description",
 					value: C,
-					onChange: F.text("seoPageDescription"),
+					onChange: I.text("seoPageDescription"),
 					rows: 3,
 					size: "xs"
 				}),

package/dist/elements/internal/Page/declaration.d.ts

@@ -2,9 +2,19 @@ import { PageProps } from './Page';
 import { AuthorableAttributes } from '@plitzi/sdk-shared/authoring/declare';
 /** What this element can be authored with — its component's own props, minus what the runtime supplies. */
 export type PageAttributes = AuthorableAttributes<PageProps>;
+/**
+ * How the document holding a page moves under a finger or a wheel, when the page says so — see
+ * `PageProps.documentScroll`. Read by the authoring surface to refuse anything else.
+ */
+export declare const DOCUMENT_SCROLLS: readonly ["locked", "noBounce"];
+export type DocumentScroll = (typeof DOCUMENT_SCROLLS)[number];
+export declare const isDocumentScroll: (value: unknown) => value is DocumentScroll;
 declare const declaration: import('@plitzi/sdk-shared/authoring/declare').DeclaredElement<{
     readonly type: "page";
     readonly serverTemplates: readonly ["seoPageTitle", "seoPageDescription", "notFound"];
+    readonly attributeValues: {
+        readonly documentScroll: readonly ["locked", "noBounce"];
+    };
     readonly triggers: {
         readonly onPageLoad: {
             readonly action: "onPageLoad";
@@ -70,5 +80,6 @@ declare const declaration: import('@plitzi/sdk-shared/authoring/declare').Declar
     seoEnabled?: boolean | undefined;
     seoPageTitle?: string | undefined;
     seoPageDescription?: string | undefined;
+    documentScroll?: (DocumentScroll | "") | undefined;
 }>>;
 export default declaration;

package/dist/elements/internal/Page/declaration.mjs

@@ -1,12 +1,13 @@
 import { elementDeclaration as e } from "@plitzi/sdk-shared/authoring/declare";
 //#region src/elements/internal/Page/declaration.ts
-var t = e()({
+var t = ["locked", "noBounce"], n = (e) => t.some((t) => t === e), r = e()({
 	type: "page",
 	serverTemplates: [
 		"seoPageTitle",
 		"seoPageDescription",
 		"notFound"
 	],
+	attributeValues: { documentScroll: t },
 	triggers: { onPageLoad: {
 		action: "onPageLoad",
 		title: "On Page Load",
@@ -59,4 +60,4 @@ var t = e()({
 	}
 });
 //#endregion
-export { t as default };
+export { t as DOCUMENT_SCROLLS, r as default, n as isDocumentScroll };

package/dist/elements/internal/Page/index.d.ts

@@ -4,6 +4,9 @@ declare const Page: {
 } & {
     readonly type: "page";
     readonly serverTemplates: readonly ["seoPageTitle", "seoPageDescription", "notFound"];
+    readonly attributeValues: {
+        readonly documentScroll: readonly ["locked", "noBounce"];
+    };
     readonly triggers: {
         readonly onPageLoad: {
             readonly action: "onPageLoad";
@@ -71,5 +74,6 @@ declare const Page: {
     seoEnabled?: boolean | undefined;
     seoPageTitle?: string | undefined;
     seoPageDescription?: string | undefined;
+    documentScroll?: (import('./declaration').DocumentScroll | "") | undefined;
 }>>;
 export default Page;

package/dist/elements/provider/Channel/Channel.mjs

@@ -62,11 +62,13 @@ var S = (e) => {
 		me: R.me ?? "",
 		members: R.members,
 		messages: N,
-		last: N.at(-1) ?? null
+		last: N.at(-1) ?? null,
+		retained: R.retained
 	}), [
 		R.connected,
 		R.me,
 		R.members,
+		R.retained,
 		N
 	]), H = c(() => i(V), [V]);
 	_({

package/dist/elements/provider/Channel/declaration.mjs

@@ -93,7 +93,7 @@ var n = e()({
 		},
 		definition: {
 			label: "Channel",
-			description: "A realtime channel: every OTHER page on the same `topic` hears what one publishes, within milliseconds — the page that sent it too with `echo` (its `from` is then the `me` of the channel). The topic must match a channel the space declares in its settings (`channels`), e.g. `board:{{ id }}` under `board:{id}`. A topic of a private channel (`grant: true`) opens only with `grant`, bound to the grant the action that let this visitor in returned (its `realtime.grant` step). ITS DESCENDANTS bind to its source `channel_<id>`: `connected`, `members` (with the state each announced), `messages` (the last `keep`) and `last`. It fires `onMessage`; `onJoin` when somebody who came after this page has announced who they are, and `onLeave` when somebody goes — each with `from`, `user` and the `state` they announced; and answers `publish({ type, data, echo })` and `setPresence({ data })`; `presence` is the state this page announces (a name, a colour). Closed in the builder and anywhere without a server.",
+			description: "A realtime channel: every OTHER page on the same `topic` hears what one publishes, within milliseconds — the page that sent it too with `echo` (its `from` is then the `me` of the channel). The topic must match a channel the space declares in its settings (`channels`), e.g. `board:{{ id }}` under `board:{id}`. A topic of a private channel (`grant: true`) opens only with `grant`, bound to the grant the action that let this visitor in returned (its `realtime.grant` step). ITS DESCENDANTS bind to its source `channel_<id>`: `connected`, `members` (with the state each announced), `messages` (the last `keep`), `last` and — on a `retain: true` channel — `retained`, the latest data the server said of each type, there as the page joins (`retained.lists`). It fires `onMessage`; `onJoin` when somebody who came after this page has announced who they are, and `onLeave` when somebody goes — each with `from`, `user` and the `state` they announced; and answers `publish({ type, data, echo })` and `setPresence({ data })`; `presence` is the state this page announces (a name, a colour). Closed in the builder and anywhere without a server.",
 			items: []
 		},
 		market: {

package/dist/index.d.ts

@@ -647,6 +647,9 @@ export declare const defaultElements: {
     } & {
         readonly type: "page";
         readonly serverTemplates: readonly ["seoPageTitle", "seoPageDescription", "notFound"];
+        readonly attributeValues: {
+            readonly documentScroll: readonly ["locked", "noBounce"];
+        };
         readonly triggers: {
             readonly onPageLoad: {
                 readonly action: "onPageLoad";
@@ -714,6 +717,7 @@ export declare const defaultElements: {
         seoEnabled?: boolean | undefined;
         seoPageTitle?: string | undefined;
         seoPageDescription?: string | undefined;
+        documentScroll?: (import('./elements/internal/Page/declaration').DocumentScroll | "") | undefined;
     }>>;
     container: {
         (props: import('./Element/hocs/withElement').WithElementProps<import('./elements/structure/Container/Container').ContainerProps>): import('react').JSX.Element;

package/dist/realtime/useChannel.d.ts

@@ -20,6 +20,11 @@ export type ChannelHandle = {
     /** This page's name on the channel — the `from` of what it sends. */
     me: string | undefined;
     members: RealtimeMember[];
+    /**
+     * What a `retain: true` channel keeps, by type: the latest data the server said of each — there as the page joins,
+     * and changed as it is said again. Empty on any other channel.
+     */
+    retained: Record<string, unknown>;
     /** Heard by every other page on the topic — and by this one too with `{ echo: true }`, once the server took it. */
     publish: (type: string, data: unknown, options?: RealtimePublishOptions) => Promise<boolean>;
     setPresence: (state: unknown) => void;
@@ -29,7 +34,8 @@ export type ChannelHandle = {
  * the speed of a cursor reads directly.
  *
  * Messages arrive through `onMessage` rather than as state, so a canvas redrawing sixty cursors a second does not
- * re-render the component sixty times a second. Closed — no connection, no members — where the page has no server to
+ * re-render the component sixty times a second — all but what a `retain: true` channel keeps, which is state
+ * (`retained`): a page that joins hears each kept message as if it had just been said. Closed — no connection, no members — where the page has no server to
  * connect to (the builder, an embed), and on the server.
  */
 declare const useChannel: (asked: string | undefined, { grant, presence, onMessage, onJoin, onLeave }?: UseChannelOptions) => ChannelHandle;

package/dist/realtime/useChannel.mjs

@@ -2,56 +2,64 @@ import { useCallback as e, useEffect as t, useMemo as n, useRef as r, useState a
 import { useCommonStore as a } from "@plitzi/sdk-shared/store";
 import { REVOKED_TYPE as o, isValidTopic as s, matchChannel as c, realtimeClientFor as l, trackPresence as u } from "@plitzi/sdk-shared/realtime";
 //#region src/realtime/useChannel.ts
-var d = (d, { grant: f, presence: p, onMessage: m, onJoin: h, onLeave: g } = {}) => {
-	let [_] = a("schema.settings.channels"), v = d && (_ ? c(d, _) : s(d)) ? d : void 0, [y] = a("realtime.endpoint"), [b] = a("realtime.transport"), x = n(() => y && typeof window < "u" ? l(y, b) : void 0, [y, b]), [S, C] = i(!1), [w, T] = i([]), E = r(void 0), D = r({
-		onMessage: m,
-		onJoin: h,
-		onLeave: g
+var d = (e, t) => {
+	if (Object.hasOwn(e, t.type) && e[t.type].at > t.at) return e;
+	let n = Object.fromEntries(Object.entries(e).filter(([e]) => e !== t.type));
+	return t.data === null ? n : {
+		...n,
+		[t.type]: t
+	};
+}, f = (f, { grant: p, presence: m, onMessage: h, onJoin: g, onLeave: _ } = {}) => {
+	let [v] = a("schema.settings.channels"), y = f && (v ? c(f, v) : s(f)) ? f : void 0, [b] = a("realtime.endpoint"), [x] = a("realtime.transport"), S = n(() => b && typeof window < "u" ? l(b, x) : void 0, [b, x]), [C, w] = i(!1), [T, E] = i([]), [D, O] = i({}), k = r(void 0), A = r({
+		onMessage: h,
+		onJoin: g,
+		onLeave: _
 	});
 	t(() => {
-		D.current = {
-			onMessage: m,
-			onJoin: h,
-			onLeave: g
+		A.current = {
+			onMessage: h,
+			onJoin: g,
+			onLeave: _
 		};
 	}), t(() => {
-		x && v && f && x.grant(v, f);
+		S && y && p && S.grant(y, p);
 	}, [
-		x,
-		v,
-		f
+		S,
+		y,
+		p
 	]), t(() => {
-		if (!x || !v) return;
-		let e = u(x, v, {
-			onChange: T,
+		if (!S || !y) return;
+		let e = u(S, y, {
+			onChange: E,
 			onMessage: (e) => {
-				e.type === o && e.from === "server" && C(!1), D.current.onMessage?.(e);
+				e.type === o && e.from === "server" && w(!1), e.retained === !0 && e.from === "server" && O((t) => d(t, e)), A.current.onMessage?.(e);
 			},
-			onArrive: (e) => D.current.onJoin?.(e),
-			onDepart: (e) => D.current.onLeave?.(e)
+			onArrive: (e) => A.current.onJoin?.(e),
+			onDepart: (e) => A.current.onLeave?.(e)
 		});
-		E.current = e, C(x.status === "open" && !x.refusal(v));
-		let t = x.onStatus((e) => C(e === "open" && !x.refusal(v)));
+		k.current = e, w(S.status === "open" && !S.refusal(y));
+		let t = S.onStatus((e) => w(e === "open" && !S.refusal(y)));
 		return () => {
-			t(), e.stop(), E.current = void 0, T([]), C(!1);
+			t(), e.stop(), k.current = void 0, E([]), O({}), w(!1);
 		};
-	}, [x, v]);
-	let O = p === void 0 ? void 0 : JSON.stringify(p);
+	}, [S, y]);
+	let j = m === void 0 ? void 0 : JSON.stringify(m);
 	t(() => {
-		O !== void 0 && E.current?.set(JSON.parse(O));
+		j !== void 0 && k.current?.set(JSON.parse(j));
 	}, [
-		O,
-		x,
-		v
+		j,
+		S,
+		y
 	]);
-	let k = e((e, t, n) => x && v ? x.publish(v, e, t, n) : Promise.resolve(!1), [x, v]), A = e((e) => E.current?.set(e), []);
+	let M = e((e, t, n) => S && y ? S.publish(y, e, t, n) : Promise.resolve(!1), [S, y]), N = e((e) => k.current?.set(e), []), P = n(() => Object.fromEntries(Object.entries(D).map(([e, t]) => [e, t.data])), [D]);
 	return {
-		connected: S,
-		me: S ? x?.me : void 0,
-		members: w,
-		publish: k,
-		setPresence: A
+		connected: C,
+		me: C ? S?.me : void 0,
+		members: T,
+		retained: P,
+		publish: M,
+		setPresence: N
 	};
 };
 //#endregion
-export { d as default };
+export { f as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plitzi/sdk-elements",
-  "version": "0.38.13",
+  "version": "0.38.15",
   "license": "AGPL-3.0",
   "files": [
     "dist"
@@ -394,6 +394,10 @@
       "types": "./dist/elements/advanced/PlitziSdk/Settings.d.ts",
       "import": "./dist/elements/advanced/PlitziSdk/Settings.mjs"
     },
+    "./elements/advanced/PlitziSdk/declaration": {
+      "types": "./dist/elements/advanced/PlitziSdk/declaration.d.ts",
+      "import": "./dist/elements/advanced/PlitziSdk/declaration.mjs"
+    },
     "./elements/advanced/Reference": {
       "types": "./dist/elements/advanced/Reference/index.d.ts",
       "import": "./dist/elements/advanced/Reference/index.mjs"
@@ -1419,12 +1423,12 @@
     "@dr.pogodin/react-helmet": "^3.3.2",
     "@plitzi/nexus": "^1.4.0",
     "@plitzi/plitzi-ui": "^1.6.33",
-    "@plitzi/sdk-auth": "0.38.13",
-    "@plitzi/sdk-event-bridge": "0.38.13",
-    "@plitzi/sdk-interactions": "0.38.13",
-    "@plitzi/sdk-navigation": "0.38.13",
-    "@plitzi/sdk-schema": "0.38.13",
-    "@plitzi/sdk-shared": "0.38.13",
+    "@plitzi/sdk-auth": "0.38.15",
+    "@plitzi/sdk-event-bridge": "0.38.15",
+    "@plitzi/sdk-interactions": "0.38.15",
+    "@plitzi/sdk-navigation": "0.38.15",
+    "@plitzi/sdk-schema": "0.38.15",
+    "@plitzi/sdk-shared": "0.38.15",
     "clsx": "^2.1.1",
     "immer": "^11.1.21",
     "react-markdown": "^10.1.0",