@plitzi/sdk-elements 0.38.11 → 0.38.12

package/CHANGELOG.md

@@ -1,5 +1,117 @@
 # @plitzi/sdk-elements
 
+## 0.38.12
+
+### Patch Changes
+
+- 1301338: ## Builder
+
+  - **Icons in the canvas again** (`@plitzi/plitzi-builder`): the canvas inlined the SDK's Font Awesome sheet into its
+    `<style>`, where the sheet's `url(webfonts/…)` resolved against the editor's URL — a `srcdoc` frame takes it as its
+    base — so every icon was a 404 under `/spaces/<space>/webfonts/` and drew as an empty box. Only the Vite dev server,
+    which rewrites the URL, hid it. The canvas and the element preview now link the sheet from where the host serves it:
+    a new prop, `sdkIconsStylePath`, the one the host already gives the pages it renders
+    (`/sdk-assets/plitzi-sdk-icons.css` for sdk-server). Absent, the canvas links no icon sheet.
+
+  ## Plugins
+  - **A plugin's other elements, hosted by `custom`** (`@plitzi/sdk-elements`): `custom({ renderType: 'jamDisc' })` on a
+    space with a plugin installed whose main element is another (`plitzi plugin pack` of several folders: the first is the
+    plugin, the rest go in it) rendered "Custom Component jamDisc Not Found" — the page registers only the plugin's main
+    element, and a `custom` host looked nowhere else. It now loads the type from the installed plugin that packs it, as
+    an element of the type itself always did, so the two ways the docs give to place a plugin's element are the same
+    everywhere: in a project `plitzi create` wrote, and once the project is on Plitzi.
+  - **One way to place a plugin's element** (`@plitzi/sdk-authoring`, `@plitzi/cli`, docs): from its declaration,
+    `const seatPicker = defineElement(declaration)` then `seatPicker({ id, … })` — typed by what it
+    declares, and the element the builder adds when somebody drops it. The welcome space `plitzi create` writes, the
+    plugin package's preview, `plitzi plugin add` and `plitzi explain` all write it so (the template's
+    `PluginHostOptions` now takes the plugin's `type` and `declaration: { from, attributes? }`; `custom`/`element` hosting
+    is gone). `pluginFolders(folder)` (`@plitzi/sdk-authoring/node`) reads each plugin with the folder it is in;
+    `pluginDeclarations` is built on it. A `custom({ renderType })` naming a plugin the space was handed the declaration
+    of is offered the declaration instead — suggestion `plugin-custom-host`. `custom` stays for a component registered
+    by name with no declaration. The skills, the CLI README, the MCP guide, `docs/en` and the website say the same.
+  - **`definePlugin`** (`@plitzi/sdk-authoring/plugin`, a new entry of 3 KB with nothing else in it): a plugin's
+    declaration written from what only it can say —
+    `definePlugin<SeatPickerAttributes>()({ type, label, attributes, triggers, callbacks })` — and every other field
+    at the default all plugins share (the builder's gestures, the catalogue entry, each attribute bindable, an empty
+    style). It answers the whole declaration, branded with its attributes, so `defineElement(declaration)` is typed
+    without a generic. `plitzi plugin add` and `create --plugin` write declarations with it (about a third of the lines).
+  - **`usePluginTrigger(declaration)`** (`@plitzi/plitzi-sdk`): fires a plugin's declared event on its element — the
+    event name and what each hands a flow typed off the declaration's `preview` — on a live page only. The hook every
+    plugin wrote for itself (and `plugin add` generated as `use<Name>Events`) is gone from the scaffold.
+  - **Attributes as the types their defaults are** (`@plitzi/sdk-elements`): a plugin's attribute bound from text — a
+    state, a row, a channel message — reaches its component as the number or the flag its declared default is (`'112'`
+    as 112, `'true'` as true). A plugin no longer types its props `number | string` and parses them.
+
+  ## Server actions and functions
+  - **Task params with rules** (`@plitzi/sdk-server`, `@plitzi/sdk-shared`): a task declares `required`, a text's
+    `maxLength` and a number's `min`/`max`, and the runner refuses a call that breaks any of them — every rule broken at
+    once, in the words the page shows (`Title is required; Seconds is at most 300`) — before the code runs. A `text` param
+    bound to a number arrives as its digits. The manifest keeps the rules, so the platform's sandbox checks the same.
+  - **`taskAction(task, { trigger })`** (`@plitzi/sdk-authoring`): the action that runs one of the space's tasks and
+    answers its result, derived from the task — its id (`<namespace>-<action>`), name, description and input (the task's
+    params, once). An action of more than one step is still `defineAction`.
+  - **`ctx.rateLimit(bucket, { …, refuse })`**: past the limit the call is refused with those words instead of answering
+    `allowed: false` for the code to check — natively and in the sandbox.
+
+  ## Authoring
+  - **`runServerActionOrNotify(id, params, fallback)`**: a server action run and the notice the visitor reads when it
+    fails — the action's own refusal, or the fallback — as two steps to spread into a flow.
+  - **`repeated-shape` reads what copies bind**: copies whose bindings read their data in different forms (a count, a
+    total of a quota) and copies holding a provider resolved on the server (found by its own id) are no longer offered
+    as one component.
+  - **`element-color-inherited`** (suggestion): `elements` giving a heading, a text, a link… `color: inherit` or the
+    page's own colour. **A link inherits the page's colour** (`@plitzi/plitzi-sdk`, `@plitzi/sdk-elements`) rather than
+    holding the SDK's grey — the same by default, and the space's palette inside a card that is a link. The template
+    every space starts from writes its colours once, on the page.
+
+  ## Fixes
+  - **A dialog opened with an id** (`@plitzi/sdk-elements`): `openDialog('dialog', '{{ row.id }}')` reads the id as its
+    `content`, as `openModal` already did — a numeric id parsed as the number and the dialog's bindings read nothing.
+  - **A select's chevron** (`@plitzi/plitzi-sdk`): a drawn chevron in the field's own colour, sized by its type, in place
+    of the `▼` glyph — and laid out in the box, so it ends where the box's padding begins whatever that padding is, and
+    the chosen option stops short of it instead of running under it. A disabled select's is faded.
+  - **Every element has its settings** (`@plitzi/plitzi-builder`, `@plitzi/sdk-elements`): the builder found none for
+    `tabContainerHeader` (registered under a misspelt type), `themeToggle`, `dropdownPopup`, `loading` and `notFound`.
+    The theme toggle's panel sets its mode, its labels and whether it offers "System"; the registry is typed by element
+    type and must hold one for each.
+  - **A plugin's panel** (`@plitzi/cli`): `plitzi doctor` warns of a plugin with no `Settings.tsx`, or one its entry never
+    passes as `pluginSettings` (`plugin-settings-missing`); the example `create` writes has its panel, as every element
+    `plugin add` writes does, and the panels it generates are laid out as the project's Prettier lays them out.
+  - **A refused or failed run reaches `onFlowError` in every mode** (`@plitzi/sdk-interactions`): an awaited server
+    action the server refused fired no `onFlowError` on the element that started it, as `detached` and `stream` ones do
+    — a board rolling its edits back on a refusal never did; and a run answered `status: 'failed'` fired `onFlowEnd`
+    (detached) or nothing (awaited) rather than `onFlowError`.
+  - **A source renamed** (`@plitzi/sdk-shared`): the binding picker lists a provider, a form or a modal by the name its
+    element has now, not the one it had when it mounted.
+  - **A text's words in the builder** (`@plitzi/sdk-elements`): a `paragraph`, `text` or `heading` whose `content` is
+    `0` shows `0` while editing too, not its placeholder; one bound to nothing shows nothing rather than `null`.
+  - **Built-in declarations** (`@plitzi/sdk-shared`): `elementDeclaration` fills in what every element shares — the
+    builder's gestures, Plitzi's catalogue entry, a visible element with no bindings, its style named by its label —
+    from the defaults `definePlugin` uses; each element's declaration says only what is its own (a third of the lines).
+
+  ## Typed for plugins and hosts
+  - **`usePlitzi()` and `PlitziProvider`** (`@plitzi/sdk-shared/hooks/usePlitzi`, `@plitzi/plitzi-sdk`): what were
+    `usePlitziServiceContext()` and `PlitziServiceProvider` (and `PlitziServiceContextValue`, now `PlitziContextValue`),
+    holding only what the host rendering a space knows — `settings`, `root`, `utils`. Its `contexts` and
+    `customContexts` are gone: every context it carried is a shared one already, imported from its own module
+    (`@plitzi/sdk-interactions/InteractionsContext`, `@plitzi/sdk-shared/network/NetworkContext`…), and
+    `PluginsContext` moves to `@plitzi/sdk-shared/plugins/PluginsContext` beside the others.
+  - **`InteractionsManagerApi`** (`@plitzi/sdk-shared`): the interactions manager as everything outside
+    `@plitzi/sdk-interactions` reaches it, declared where every package can name it and implemented by
+    `InteractionsManager`, so `use(InteractionsContext)` is typed — `interactionTrigger`, `createChildManager`… — where it
+    was `any`.
+  - **`getPathsFromObject`** (`@plitzi/sdk-shared/helpers/utils`), spelt right; `getPathsFromObeject` is gone.
+  - **`ElementWords` places itself** (`@plitzi/sdk-elements`): `contentPlacement` and the element's children, so a button
+    and a link write their words once.
+
+- Updated dependencies [1301338]
+  - @plitzi/sdk-auth@0.38.12
+  - @plitzi/sdk-event-bridge@0.38.12
+  - @plitzi/sdk-interactions@0.38.12
+  - @plitzi/sdk-navigation@0.38.12
+  - @plitzi/sdk-schema@0.38.12
+  - @plitzi/sdk-shared@0.38.12
+
 ## 0.38.11
 
 ### Patch Changes

package/dist/Element/ElementWords.d.ts

@@ -1,3 +1,4 @@
+import { ReactNode } from 'react';
 export type IconPlacement = 'before' | 'after';
 export type ElementWordsProps = {
     /** The element's own words. */
@@ -7,10 +8,13 @@ export type ElementWordsProps = {
     iconPlacement?: IconPlacement;
     /** What the element's `icon` slot carries. */
     iconClassName?: string;
+    /** Where the words go beside the element's children. */
+    contentPlacement?: 'before' | 'after';
+    children?: ReactNode;
 };
 /**
  * What a button or a link says itself — its words and an icon beside them, one element instead of a `text` and a
- * `fontAwesome` inside it. Each element places the whole beside its children with its own `contentPlacement`.
+ * `fontAwesome` inside it — placed before or after the element's children, as its `contentPlacement` says.
  */
-declare const ElementWords: ({ content, icon, iconPlacement, iconClassName }: ElementWordsProps) => import('react').JSX.Element;
+declare const ElementWords: ({ content, icon, iconPlacement, iconClassName, contentPlacement, children }: ElementWordsProps) => import('react').JSX.Element;
 export default ElementWords;

package/dist/Element/ElementWords.mjs

@@ -4,16 +4,23 @@ import r from "clsx";
 var i = ({ icon: e, className: n }) => e ? /* @__PURE__ */ t("i", {
 	className: r("plitzi-element-icon", e, n),
 	"aria-hidden": "true"
-}) : null, a = ({ content: r = "", icon: a = "", iconPlacement: o = "before", iconClassName: s }) => /* @__PURE__ */ n(e, { children: [
-	o === "before" && /* @__PURE__ */ t(i, {
-		icon: a,
-		className: s
-	}),
-	r,
-	o === "after" && /* @__PURE__ */ t(i, {
-		icon: a,
-		className: s
-	})
-] });
+}) : null, a = ({ content: r = "", icon: a = "", iconPlacement: o = "before", iconClassName: s, contentPlacement: c = "after", children: l }) => {
+	let u = /* @__PURE__ */ n(e, { children: [
+		o === "before" && /* @__PURE__ */ t(i, {
+			icon: a,
+			className: s
+		}),
+		r,
+		o === "after" && /* @__PURE__ */ t(i, {
+			icon: a,
+			className: s
+		})
+	] });
+	return /* @__PURE__ */ n(e, { children: [
+		c === "before" && u,
+		l,
+		c === "after" && u
+	] });
+};
 //#endregion
 export { a as default };

package/dist/Element/JsxManager.mjs

@@ -2,25 +2,25 @@ import e from "./PluginRemote.mjs";
 import { getRemoteSettings as t } from "./helpers/pluginSelector.mjs";
 import n from "../elements/internal/NotFound/NotFound.mjs";
 import { memo as r, use as i, useMemo as a } from "react";
-import o from "@plitzi/sdk-shared/hooks/usePlitziServiceContext";
-import s from "@plitzi/sdk-shared/elements/ComponentContext";
+import o from "@plitzi/sdk-shared/elements/ComponentContext";
+import s from "@plitzi/sdk-shared/plugins/PluginsContext";
 import { jsx as c } from "react/jsx-runtime";
 var l = r(({ plitziJsxSkipHOC: r = !0, as: l = "", internalProps: u, children: d, ...f }) => {
-	let { contexts: { PluginsContext: p } } = o(), { components: m } = i(s), { plugins: h } = i(p), g = l ? m.current[l] : void 0, _ = a(() => g ? void 0 : t({
+	let { components: p } = i(o), { plugins: m } = i(s), h = l ? p.current[l] : void 0, g = a(() => h ? void 0 : t({
 		type: l,
-		plugins: h
+		plugins: m
 	}), [
-		g,
 		h,
+		m,
 		l
 	]);
-	return l ? !g && _ ? /* @__PURE__ */ c(e, {
+	return l ? !h && g ? /* @__PURE__ */ c(e, {
 		internalProps: u,
-		url: _.url,
+		url: g.url,
 		type: l,
 		plitziJsxSkipHOC: r,
 		plitziJsxProps: f
-	}) : (g ||= n, /* @__PURE__ */ c(g, {
+	}) : (h ||= n, /* @__PURE__ */ c(h, {
 		plitziJsxSkipHOC: r,
 		...f,
 		internalProps: u,

package/dist/Element/PluginManager.mjs

@@ -1,9 +1,9 @@
 import e from "./helpers/pluginSelector.mjs";
 import { memo as t, use as n } from "react";
-import r from "@plitzi/sdk-shared/hooks/usePlitziServiceContext";
-import i from "@plitzi/sdk-shared/elements/ComponentContext";
+import r from "@plitzi/sdk-shared/elements/ComponentContext";
+import i from "@plitzi/sdk-shared/plugins/PluginsContext";
 var a = t(({ plitziElementLayout: t = void 0, type: a = "", internalProps: o }) => {
-	let { components: s } = n(i), { contexts: { PluginsContext: c } } = r(), { plugins: l } = n(c);
+	let { components: s } = n(r), { plugins: c } = n(i);
 	return e({
 		type: a,
 		internalProps: {
@@ -12,7 +12,7 @@ var a = t(({ plitziElementLayout: t = void 0, type: a = "", internalProps: o })
 		},
 		plitziElementLayout: t,
 		components: s.current,
-		plugins: l
+		plugins: c
 	});
 });
 //#endregion

package/dist/Element/ReplicaProvider.mjs

@@ -1,16 +1,16 @@
 import { use as e, useEffect as t, useMemo as n } from "react";
-import r from "@plitzi/sdk-shared/hooks/usePlitziServiceContext";
-import { jsx as i } from "react/jsx-runtime";
+import { jsx as r } from "react/jsx-runtime";
+import i from "@plitzi/sdk-interactions/InteractionsContext";
 //#region src/Element/ReplicaProvider.tsx
 var a = ({ children: a }) => {
-	let { contexts: { InteractionsContext: o } } = r(), s = e(o), c = n(() => s.interactionsManager.createChildManager(), [s]), l = n(() => ({
-		...s,
-		interactionsManager: c
-	}), [s, c]);
+	let o = e(i), s = n(() => o.interactionsManager.createChildManager(), [o]), c = n(() => ({
+		...o,
+		interactionsManager: s
+	}), [o, s]);
 	return t(() => () => {
-		s.interactionsManager.removeChildManager(c);
-	}, [s, c]), /* @__PURE__ */ i(o, {
-		value: l,
+		o.interactionsManager.removeChildManager(s);
+	}, [o, s]), /* @__PURE__ */ r(i, {
+		value: c,
 		children: a
 	});
 };

package/dist/Element/RootElement.mjs

@@ -2,77 +2,77 @@ import e from "./hooks/useElement.mjs";
 import t from "./helpers/parseStyle.mjs";
 import n from "./helpers/renderStaticTag.mjs";
 import r from "./hooks/useRootElementInteractions.mjs";
-import { useMemo as i } from "react";
-import a from "@plitzi/sdk-shared/hooks/usePlitziServiceContext";
-import { motionAttributes as o } from "@plitzi/sdk-shared/schema/motion";
+import { use as i, useMemo as a } from "react";
+import o from "@plitzi/sdk-shared/hooks/usePlitzi";
+import s from "@plitzi/sdk-interactions/InteractionsContext";
+import { motionAttributes as c } from "@plitzi/sdk-shared/schema/motion";
 //#region src/Element/RootElement.tsx
-var s = ({ ref: s, children: c, tag: l = "div", className: u = "", interactionTriggers: d, interactionCallbacks: f, style: p, ...m }) => {
-	let h = i(() => t(p), [p]), g = e(), _ = a(), v = _.settings.previewMode ?? !0, y = !!_.settings.debugMode;
-	if (g.plitziJsxSkipHOC) return n({
-		tag: l,
-		refProp: s,
-		style: h,
-		className: u,
-		otherProps: m,
-		children: c
+var l = ({ ref: l, children: u, tag: d = "div", className: f = "", interactionTriggers: p, interactionCallbacks: m, style: h, ...g }) => {
+	let _ = a(() => t(h), [h]), v = e(), y = o(), b = y.settings.previewMode ?? !0, x = !!y.settings.debugMode;
+	if (v.plitziJsxSkipHOC) return n({
+		tag: d,
+		refProp: l,
+		style: _,
+		className: f,
+		otherProps: g,
+		children: u
 	});
-	let { root: { baseElementId: b }, contexts: x } = _, S = x.InteractionsContext, { id: C, rootId: w, style: T, plitziElementLayout: E, definition: { type: D, label: O, runtime: k, anchor: A, parentId: j, motion: M } } = g, N = o(M), P = k === "server" ? { "data-rsc-id": C } : void 0, F = E?.type === "component" && !j && E.rootId !== C ? E.rootId : void 0, I = _.settings.testAttributes === !1 ? void 0 : {
-		"data-plitzi-el": C,
-		...F === void 0 ? {} : { "data-plitzi-instance": F }
-	}, L = !y && (v || !D || w !== b) ? {} : {
-		"data-id": C,
-		"data-name": O || D || "unknown",
-		"data-root-id": w,
-		"data-type": D || "unknown",
+	let { root: { baseElementId: S } } = y, C = !!i(s).interactionsManager, { id: w, rootId: T, style: E, plitziElementLayout: D, definition: { type: O, label: k, runtime: A, anchor: j, parentId: M, motion: N } } = v, P = c(N), F = A === "server" ? { "data-rsc-id": w } : void 0, I = D?.type === "component" && !M && D.rootId !== w ? D.rootId : void 0, L = y.settings.testAttributes === !1 ? void 0 : {
+		"data-plitzi-el": w,
+		...I === void 0 ? {} : { "data-plitzi-instance": I }
+	}, R = !x && (b || !O || T !== S) ? {} : {
+		"data-id": w,
+		"data-name": k || O || "unknown",
+		"data-root-id": T,
+		"data-type": O || "unknown",
 		"data-root-render-element": !0
 	};
-	if (!S) return n({
-		tag: l,
-		refProp: s,
+	if (!C) return n({
+		tag: d,
+		refProp: l,
 		style: {
-			...T,
-			...h,
-			...N.style
+			...E,
+			..._,
+			...P.style
 		},
-		className: u,
-		otherProps: m,
-		anchor: A,
-		params: L,
-		serverMarker: P,
-		motion: N.attributes,
-		testMarker: I,
-		children: c
+		className: f,
+		otherProps: g,
+		anchor: j,
+		params: R,
+		serverMarker: F,
+		motion: P.attributes,
+		testMarker: L,
+		children: u
 	});
-	let R = r({
-		elementContext: g,
-		InteractionsContext: S,
-		previewMode: v,
-		debugMode: y,
-		baseElementId: b,
-		className: u,
-		interactionTriggers: d,
-		interactionCallbacks: f,
-		otherProps: m,
-		ref: s
+	let z = r({
+		elementContext: v,
+		previewMode: b,
+		debugMode: x,
+		baseElementId: S,
+		className: f,
+		interactionTriggers: p,
+		interactionCallbacks: m,
+		otherProps: g,
+		ref: l
 	});
 	return n({
-		tag: l,
-		refProp: R.nodeRef,
+		tag: d,
+		refProp: z.nodeRef,
 		style: {
-			...T,
-			...h,
-			...N.style
+			...E,
+			..._,
+			...P.style
 		},
-		className: R.className,
-		otherProps: m,
-		anchor: A,
-		params: L,
-		serverMarker: P,
-		motion: N.attributes,
-		testMarker: I,
-		events: R.events,
-		children: c
+		className: z.className,
+		otherProps: g,
+		anchor: j,
+		params: R,
+		serverMarker: F,
+		motion: P.attributes,
+		testMarker: L,
+		events: z.events,
+		children: u
 	});
 };
 //#endregion
-export { s as RootElement, s as default };
+export { l as RootElement, l as default };

package/dist/Element/helpers/declaredAttributes.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A plugin's attributes as the types its declaration's defaults are: a value bound from text — a state, a row, what a
+ * channel said — arrives as the number or the flag its default is (`'112'` as 112, `'true'` as true), so the component
+ * reads the type it declares and never writes `Number(…)`. Anything else, and every attribute it has no default for,
+ * as it is.
+ *
+ * Only a plugin carries its declaration on the component this wraps (`Object.assign(Component, declaration)`); a
+ * built-in element is handed its attributes untouched.
+ */
+export declare const declaredAttributes: (component: unknown, attributes: Record<string, unknown>) => Record<string, unknown>;

package/dist/Element/helpers/declaredAttributes.mjs

@@ -0,0 +1,22 @@
+import { isRecord as e } from "@plitzi/sdk-shared/helpers/isRecord";
+//#region src/Element/helpers/declaredAttributes.ts
+var t = (e, t) => {
+	if (typeof t != "string") return t;
+	if (typeof e == "number") {
+		let e = Number(t.trim());
+		return t.trim() !== "" && Number.isFinite(e) ? e : t;
+	}
+	return typeof e == "boolean" && (t === "true" || t === "false") ? t === "true" : t;
+}, n = (n, r) => {
+	if (typeof n != "function" || !("content" in n) || !e(n.content)) return r;
+	let i = n.content.attributes;
+	if (!e(i)) return r;
+	let a = !1, o = { ...r };
+	for (let [e, n] of Object.entries(r)) {
+		let r = t(i[e], n);
+		r !== n && (o[e] = r, a = !0);
+	}
+	return a ? o : r;
+};
+//#endregion
+export { n as declaredAttributes };