@plitzi/sdk-elements 0.37.1 → 0.37.3

package/dist/index.mjs

@@ -24,16 +24,18 @@ import S from "./elements/media/FontAwesome/index.mjs";
 import C from "./elements/media/Image/index.mjs";
 import w from "./elements/media/Video/index.mjs";
 import T from "./elements/provider/ApiContainer/index.mjs";
-import E from "./elements/structure/Container/index.mjs";
-import D from "./elements/structure/DialogContainer/index.mjs";
-import O from "./elements/structure/List/index.mjs";
-import k from "./elements/structure/ModalContainer/index.mjs";
-import A from "./elements/structure/Pagination/index.mjs";
-import j from "./elements/structure/TabContainer/index.mjs";
-import { elements_exports as M } from "./elements/index.mjs";
-import { defaultElementsSettings as N, settings_exports as P } from "./elements/settings.mjs";
+import E from "./realtime/useChannel.mjs";
+import D from "./elements/provider/Channel/index.mjs";
+import O from "./elements/structure/Container/index.mjs";
+import k from "./elements/structure/DialogContainer/index.mjs";
+import A from "./elements/structure/List/index.mjs";
+import j from "./elements/structure/ModalContainer/index.mjs";
+import M from "./elements/structure/Pagination/index.mjs";
+import N from "./elements/structure/TabContainer/index.mjs";
+import { elements_exports as P } from "./elements/index.mjs";
+import { defaultElementsSettings as F, settings_exports as I } from "./elements/settings.mjs";
 //#region src/index.ts
-var F = {
+var L = {
 	dropdown: c,
 	notFound: b,
 	loading: y,
@@ -43,11 +45,11 @@ var F = {
 	nodeHtml: a,
 	blockJsx: r,
 	page: x,
-	container: E,
+	container: O,
 	layoutContainer: v,
-	dialogContainer: D,
-	modalContainer: k,
-	tabContainer: j,
+	dialogContainer: k,
+	modalContainer: j,
+	tabContainer: N,
 	heading: l,
 	image: C,
 	video: w,
@@ -56,14 +58,15 @@ var F = {
 	paragraph: f,
 	text: m,
 	themeToggle: h,
-	list: O,
+	list: A,
 	link: u,
 	markdown: d,
 	richText: p,
-	pagination: A,
+	pagination: M,
 	form: g,
 	formControl: _,
-	apiContainer: T
+	apiContainer: T,
+	channel: D
 };
 //#endregion
-export { T as ApiContainer, n as BlockHtml, r as BlockJsx, s as Button, E as Container, i as Custom, D as DialogContainer, c as Dropdown, S as FontAwesome, g as Form, _ as FormControl, l as Heading, C as Image, t as JsxManager, v as LayoutContainer, u as Link, O as List, y as Loading, d as Markdown, k as ModalContainer, a as NodeHtml, b as NotFound, x as Page, A as Pagination, f as Paragraph, o as Reference, p as RichText, j as TabContainer, m as Text, h as ThemeToggle, w as Video, F as defaultElements, N as defaultElementsSettings, P as elementSettings, M as elements, e as useRscData };
+export { T as ApiContainer, n as BlockHtml, r as BlockJsx, s as Button, D as Channel, O as Container, i as Custom, k as DialogContainer, c as Dropdown, S as FontAwesome, g as Form, _ as FormControl, l as Heading, C as Image, t as JsxManager, v as LayoutContainer, u as Link, A as List, y as Loading, d as Markdown, j as ModalContainer, a as NodeHtml, b as NotFound, x as Page, M as Pagination, f as Paragraph, o as Reference, p as RichText, N as TabContainer, m as Text, h as ThemeToggle, w as Video, L as defaultElements, F as defaultElementsSettings, I as elementSettings, P as elements, E as useChannel, e as useRscData };

package/dist/realtime/useChannel.d.ts

@@ -0,0 +1,35 @@
+import { RealtimeMessage } from '@plitzi/sdk-shared';
+import { RealtimeMember } from '@plitzi/sdk-shared/realtime';
+export type UseChannelOptions = {
+    /**
+     * What opens a topic of a `grant: true` channel: the grant a flow's `realtime.grant` answered this visitor. Without
+     * it such a topic is refused. A new one — the page asked its action again — reconnects with it.
+     */
+    grant?: string;
+    /** What this page announces to the channel's members — a name, a colour. Announced again when it changes. */
+    presence?: unknown;
+    /** Each message, as it arrives. Read through a ref: a new function each render does not reconnect anything. */
+    onMessage?: (message: RealtimeMessage) => void;
+    /** Somebody who came after this page, once they said who they are — read through a ref, as `onMessage` is. */
+    onJoin?: (member: RealtimeMember) => void;
+    /** Somebody who went, as they last said they were. */
+    onLeave?: (member: RealtimeMember) => void;
+};
+export type ChannelHandle = {
+    connected: boolean;
+    /** This page's name on the channel — the `from` of what it sends. */
+    me: string | undefined;
+    members: RealtimeMember[];
+    publish: (type: string, data: unknown) => Promise<boolean>;
+    setPresence: (state: unknown) => void;
+};
+/**
+ * A realtime channel, for a component: what the `channel` element is built on, and what a plugin that has to move at
+ * 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
+ * connect to (the builder, an embed), and on the server.
+ */
+declare const useChannel: (topic: string | undefined, { grant, presence, onMessage, onJoin, onLeave }?: UseChannelOptions) => ChannelHandle;
+export default useChannel;

package/dist/realtime/useChannel.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plitzi/sdk-elements",
-  "version": "0.37.1",
+  "version": "0.37.3",
   "license": "AGPL-3.0",
   "files": [
     "dist"
@@ -134,6 +134,10 @@
       "types": "./dist/Element/hooks/useInternalItems.d.ts",
       "import": "./dist/Element/hooks/useInternalItems.mjs"
     },
+    "./Element/hooks/useKeyTriggers": {
+      "types": "./dist/Element/hooks/useKeyTriggers.d.ts",
+      "import": "./dist/Element/hooks/useKeyTriggers.mjs"
+    },
     "./Element/hooks/useLayoutChain": {
       "types": "./dist/Element/hooks/useLayoutChain.d.ts",
       "import": "./dist/Element/hooks/useLayoutChain.mjs"
@@ -346,6 +350,10 @@
       "types": "./dist/elements/basic/Dropdown/useDropdown.d.ts",
       "import": "./dist/elements/basic/Dropdown/useDropdown.mjs"
     },
+    "./elements/basic/Dropdown/useDropdownTrigger": {
+      "types": "./dist/elements/basic/Dropdown/useDropdownTrigger.d.ts",
+      "import": "./dist/elements/basic/Dropdown/useDropdownTrigger.mjs"
+    },
     "./elements/basic/Heading": {
       "types": "./dist/elements/basic/Heading/index.d.ts",
       "import": "./dist/elements/basic/Heading/index.mjs"
@@ -530,6 +538,10 @@
       "types": "./dist/elements/form/FormControl/components/Label.d.ts",
       "import": "./dist/elements/form/FormControl/components/Label.mjs"
     },
+    "./elements/form/FormControl/components/visuallyHidden": {
+      "types": "./dist/elements/form/FormControl/components/visuallyHidden.d.ts",
+      "import": "./dist/elements/form/FormControl/components/visuallyHidden.mjs"
+    },
     "./elements/form/FormControl/declaration": {
       "types": "./dist/elements/form/FormControl/declaration.d.ts",
       "import": "./dist/elements/form/FormControl/declaration.mjs"
@@ -566,6 +578,10 @@
       "types": "./dist/elements/form/FormControl/inputs/Textarea.d.ts",
       "import": "./dist/elements/form/FormControl/inputs/Textarea.mjs"
     },
+    "./elements/form/FormControl/inputs/useFocusWhenShown": {
+      "types": "./dist/elements/form/FormControl/inputs/useFocusWhenShown.d.ts",
+      "import": "./dist/elements/form/FormControl/inputs/useFocusWhenShown.mjs"
+    },
     "./elements/index": {
       "types": "./dist/elements/index.d.ts",
       "import": "./dist/elements/index.mjs"
@@ -746,10 +762,26 @@
       "types": "./dist/elements/provider/ApiContainer/declaration.d.ts",
       "import": "./dist/elements/provider/ApiContainer/declaration.mjs"
     },
+    "./elements/provider/ApiContainer/helpers/isEmptyAnswer": {
+      "types": "./dist/elements/provider/ApiContainer/helpers/isEmptyAnswer.d.ts",
+      "import": "./dist/elements/provider/ApiContainer/helpers/isEmptyAnswer.mjs"
+    },
+    "./elements/provider/ApiContainer/helpers/providerOutcome": {
+      "types": "./dist/elements/provider/ApiContainer/helpers/providerOutcome.d.ts",
+      "import": "./dist/elements/provider/ApiContainer/helpers/providerOutcome.mjs"
+    },
+    "./elements/provider/ApiContainer/helpers/queryInput": {
+      "types": "./dist/elements/provider/ApiContainer/helpers/queryInput.d.ts",
+      "import": "./dist/elements/provider/ApiContainer/helpers/queryInput.mjs"
+    },
     "./elements/provider/ApiContainer/hooks/useApi": {
       "types": "./dist/elements/provider/ApiContainer/hooks/useApi.d.ts",
       "import": "./dist/elements/provider/ApiContainer/hooks/useApi.mjs"
     },
+    "./elements/provider/ApiContainer/hooks/useAutoRefresh": {
+      "types": "./dist/elements/provider/ApiContainer/hooks/useAutoRefresh.d.ts",
+      "import": "./dist/elements/provider/ApiContainer/hooks/useAutoRefresh.mjs"
+    },
     "./elements/provider/ApiContainer/hooks/useProviderPagination": {
       "types": "./dist/elements/provider/ApiContainer/hooks/useProviderPagination.d.ts",
       "import": "./dist/elements/provider/ApiContainer/hooks/useProviderPagination.mjs"
@@ -762,6 +794,26 @@
       "types": "./dist/elements/provider/ApiContainer/index.d.ts",
       "import": "./dist/elements/provider/ApiContainer/index.mjs"
     },
+    "./elements/provider/Channel": {
+      "types": "./dist/elements/provider/Channel/index.d.ts",
+      "import": "./dist/elements/provider/Channel/index.mjs"
+    },
+    "./elements/provider/Channel/Channel": {
+      "types": "./dist/elements/provider/Channel/Channel.d.ts",
+      "import": "./dist/elements/provider/Channel/Channel.mjs"
+    },
+    "./elements/provider/Channel/Settings": {
+      "types": "./dist/elements/provider/Channel/Settings.d.ts",
+      "import": "./dist/elements/provider/Channel/Settings.mjs"
+    },
+    "./elements/provider/Channel/declaration": {
+      "types": "./dist/elements/provider/Channel/declaration.d.ts",
+      "import": "./dist/elements/provider/Channel/declaration.mjs"
+    },
+    "./elements/provider/Channel/index": {
+      "types": "./dist/elements/provider/Channel/index.d.ts",
+      "import": "./dist/elements/provider/Channel/index.mjs"
+    },
     "./elements/settings": {
       "types": "./dist/elements/settings.d.ts",
       "import": "./dist/elements/settings.mjs"
@@ -886,6 +938,14 @@
       "types": "./dist/elements/structure/ModalContainer/index.d.ts",
       "import": "./dist/elements/structure/ModalContainer/index.mjs"
     },
+    "./elements/structure/ModalContainer/metadataFromText": {
+      "types": "./dist/elements/structure/ModalContainer/metadataFromText.d.ts",
+      "import": "./dist/elements/structure/ModalContainer/metadataFromText.mjs"
+    },
+    "./elements/structure/ModalContainer/useModalDialog": {
+      "types": "./dist/elements/structure/ModalContainer/useModalDialog.d.ts",
+      "import": "./dist/elements/structure/ModalContainer/useModalDialog.mjs"
+    },
     "./elements/structure/Pagination": {
       "types": "./dist/elements/structure/Pagination/index.d.ts",
       "import": "./dist/elements/structure/Pagination/index.mjs"
@@ -997,6 +1057,10 @@
     "./index": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs"
+    },
+    "./realtime/useChannel": {
+      "types": "./dist/realtime/useChannel.d.ts",
+      "import": "./dist/realtime/useChannel.mjs"
     }
   },
   "scripts": {
@@ -1012,15 +1076,15 @@
   "type": "module",
   "sideEffects": false,
   "dependencies": {
-    "@plitzi/nexus": "^1.2.2",
-    "@plitzi/plitzi-ui": "^1.6.21",
-    "@plitzi/sdk-auth": "0.37.1",
-    "@plitzi/sdk-dev-tools": "0.37.1",
-    "@plitzi/sdk-event-bridge": "0.37.1",
-    "@plitzi/sdk-interactions": "0.37.1",
-    "@plitzi/sdk-navigation": "0.37.1",
-    "@plitzi/sdk-schema": "0.37.1",
-    "@plitzi/sdk-shared": "0.37.1",
+    "@plitzi/nexus": "^1.3.1",
+    "@plitzi/plitzi-ui": "^1.6.24",
+    "@plitzi/sdk-auth": "0.37.3",
+    "@plitzi/sdk-dev-tools": "0.37.3",
+    "@plitzi/sdk-event-bridge": "0.37.3",
+    "@plitzi/sdk-interactions": "0.37.3",
+    "@plitzi/sdk-navigation": "0.37.3",
+    "@plitzi/sdk-schema": "0.37.3",
+    "@plitzi/sdk-shared": "0.37.3",
     "clsx": "^2.1.1",
     "immer": "^11.1.18"
   },
@@ -1032,7 +1096,7 @@
     "eslint": "^9.39.5",
     "react": "^19.3.0",
     "typescript": "^6.0.3",
-    "vite": "^8.3.0",
+    "vite": "^8.3.1",
     "vitest": "^5.0.1"
   }
 }

package/dist/elements/media/FontAwesome/FontAwesome.stories-paused.d.ts

@@ -1 +0,0 @@
-export {};