@plitzi/plitzi-builder 0.38.11 → 0.38.12

package/CHANGELOG.md

@@ -1,5 +1,124 @@
 # @plitzi/plitzi-builder
 
+## 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/plitzi-sdk@0.38.12
+  - @plitzi/sdk-auth@0.38.12
+  - @plitzi/sdk-authoring@0.38.12
+  - @plitzi/sdk-dev-tools@0.38.12
+  - @plitzi/sdk-elements@0.38.12
+  - @plitzi/sdk-event-bridge@0.38.12
+  - @plitzi/sdk-interactions@0.38.12
+  - @plitzi/sdk-navigation@0.38.12
+  - @plitzi/sdk-plugins@0.38.12
+  - @plitzi/sdk-schema@0.38.12
+  - @plitzi/sdk-shared@0.38.12
+  - @plitzi/sdk-style@0.38.12
+  - @plitzi/sdk-variables@0.38.12
+
 ## 0.38.11
 
 ### Patch Changes

package/dist/App.d.ts

@@ -13,6 +13,11 @@ export type AppProps = {
      * of this package, from wherever the host serves the builder's files. Absent, the panel edits and saves without it.
      */
     functionsWorkerUrl?: string;
+    /**
+     * Where the SDK's Font Awesome sheet (`plitzi-sdk-icons.css`) is served, with its `webfonts/` beside it — the one
+     * the host already gives the pages it renders. The canvas links it; absent, its icons draw as empty boxes.
+     */
+    sdkIconsStylePath?: string;
 };
 declare const App: (props: AppProps) => import('react').JSX.Element;
 export default App;

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import { default as PluginRemote } from '@plitzi/sdk-elements/Element/PluginRemo
 import { default as ReplicaProvider } from '@plitzi/sdk-elements/Element/ReplicaProvider';
 import { default as RootElement } from '@plitzi/sdk-elements/Element/RootElement';
 import { default as ComponentContext } from '@plitzi/sdk-shared/elements/ComponentContext';
-import { default as usePlitziServiceContext, PlitziServiceProvider } from '@plitzi/sdk-shared/hooks/usePlitziServiceContext';
+import { default as usePlitzi, PlitziProvider } from '@plitzi/sdk-shared/hooks/usePlitzi';
 import { useBuilderStore } from '@plitzi/sdk-shared/store';
 import { AppProps } from './App';
 import { ComponentPlugin, RenderMode, Server } from '@plitzi/sdk-shared';
@@ -29,11 +29,12 @@ export type PlitziBuilderProps = {
     state?: object;
     debugMode?: boolean;
     functionsWorkerUrl?: AppProps['functionsWorkerUrl'];
+    sdkIconsStylePath?: AppProps['sdkIconsStylePath'];
 };
 declare const PlitziBuilder: {
     (props: PlitziBuilderProps): import('react').JSX.Element;
     Plugin: (_props: import('./modules/Builder/BuilderPlugin').BuilderPluginProps) => undefined;
 };
 export declare const version: string;
-export { useBuilderStore, ComponentProvider, ComponentContext, usePlitziServiceContext, PlitziServiceProvider, RootElement, withElement, JsxManager, PluginManager, PluginRemote, ReplicaProvider, useElement, useRscData };
+export { useBuilderStore, ComponentProvider, ComponentContext, usePlitzi, PlitziProvider, RootElement, withElement, JsxManager, PluginManager, PluginRemote, ReplicaProvider, useElement, useRscData };
 export default PlitziBuilder;

package/dist/index.html

@@ -56,6 +56,7 @@
           userKey: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cHM6Ly9zZXJ2ZXIucGxpdHppLmxvY2FsIiwiYXVkIjpbImh0dHBzOi8vcGxpdHppLmxvY2FsIiwiaHR0cHM6Ly9hcHAucGxpdHppLmxvY2FsIiwiaHR0cHM6Ly9hcHAucGxpdHppLmxvY2FsOjMwMDAiLCJodHRwczovL2FwcC5wbGl0emkubG9jYWw6MzAwMSIsImh0dHBzOi8vYXBpLnBsaXR6aS5sb2NhbCIsImh0dHBzOi8vc3NyLnBsaXR6aS5sb2NhbCIsImh0dHBzOi8vc2VydmVyLnBsaXR6aS5sb2NhbCIsImh0dHBzOi8vbWNwLnBsaXR6aS5sb2NhbCIsImh0dHBzOi8vYXV0aC5wbGl0emkubG9jYWwiLCJodHRwOi8vMTI3LjAuMC4xOjUzMDAiLCJodHRwOi8vbG9jYWxob3N0OjUxODAiXSwic2NvcGUiOiJ1c2VyIiwiZXhwIjoxNzkxNTQ1ODcxLCJpYXQiOjE3OTE0NTk0NzEsImp0aSI6IjMwNjQ3NmFlN2YzOTgwMmMiLCJuYmYiOjE3OTE0NTk0NzF9.1yw4JxzN9qkssRYSHAqg4hjFRvatT82PkYVGwF3SP_I',
           environment: 'main',
           functionsWorkerUrl: '/plitzi-functions-worker.js',
+          sdkIconsStylePath: '',
           server: {
             basePath: '',
             // Dashboard

package/dist/modules/App/AppContext.d.ts

@@ -27,6 +27,8 @@ export type AppContextValue = {
     setMobilePreview: Dispatch<SetStateAction<boolean>>;
     /** Where the Functions panel's TypeScript worker is served; empty when the host serves none. */
     functionsWorkerUrl: string;
+    /** Where the SDK's icon sheet is served, for the canvases to link; empty when the host serves none. */
+    sdkIconsStylePath: string;
 };
 declare const AppContext: import('react').Context<AppContextValue>;
 export default AppContext;

package/dist/modules/App/AppMain.d.ts

@@ -14,6 +14,7 @@ export type AppMainProps = {
     children?: ReactNode;
     debugMode?: boolean;
     functionsWorkerUrl?: string;
+    sdkIconsStylePath?: string;
 };
-declare const AppMain: ({ webKey, webId, userKey, instanceId, server, environment, includeSubscriptions, includeRealTime, externalStyle, debugMode, functionsWorkerUrl }: AppMainProps) => import('react').JSX.Element;
+declare const AppMain: ({ webKey, webId, userKey, instanceId, server, environment, includeSubscriptions, includeRealTime, externalStyle, debugMode, functionsWorkerUrl, sdkIconsStylePath }: AppMainProps) => import('react').JSX.Element;
 export default AppMain;

package/dist/modules/Builder/helpers/canvasIcons.d.ts

@@ -0,0 +1,10 @@
+import { Asset } from '@plitzi/sdk-shared';
+/**
+ * The SDK's Font Awesome sheet in a canvas: linked, never inlined.
+ *
+ * The sheet names its fonts relative to itself (`webfonts/…`), so they are found wherever the sheet is served from.
+ * Inlined into the canvas's `<style>` they resolved against the document instead — a `srcdoc` frame takes the editor's
+ * URL as its base — and every icon was a 404 under `/spaces/<space>/webfonts/`. Only the Vite dev server, which
+ * rewrites the URL, hid it.
+ */
+export declare const canvasIconsAssets: (href: string) => Record<string, Asset>;

package/dist/modules/Builder/helpers/canvasIcons.test.d.ts

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

package/dist/modules/Network/contexts/BuilderSubscriptionsContext.d.ts

@@ -3,7 +3,7 @@ export type BuilderSubscriptionsContextValue = {
     includeSubscriptions: boolean;
     supportRealTime: boolean;
     subscriptionsPush: (data: RTMessageManagedClient) => void;
-    subscriptionsRegisterCallback: (type: RTEvent, callback: RTCallback, subscriberId?: string) => void;
+    subscriptionsRegisterCallback: <E extends RTEvent>(type: E, callback: RTCallback<E>, subscriberId?: string) => void;
     subscriptionsUnregisterCallback: (type: RTEvent, subscriberId?: string) => void;
 };
 declare const BuilderSubscriptionsContext: import('react').Context<BuilderSubscriptionsContextValue>;

package/dist/modules/Queue/QueueContext.d.ts

@@ -3,14 +3,23 @@ import { SchemaReducerActions } from '@plitzi/sdk-schema/SchemaReducer';
 import { Schema, Style } from '@plitzi/sdk-shared';
 import { StyleReducerActions } from '@plitzi/sdk-style/StyleReducer';
 import { ActionDispatch } from 'react';
-export type QueueItem<TState = any, TDispatchAction = any> = {
+export type QueueItem<TState, TDispatchAction> = {
     action: TDispatchAction;
     prevState: TState;
     state: TState;
     dispatch: ActionDispatch<[action: TDispatchAction]>;
 };
+/** A change the queue sends: to the schema or to the style, each with its own reducer's state and action. */
+export type QueuedChange = ({
+    kind: 'schema';
+} & QueueItem<Schema, SchemaReducerActions>) | ({
+    kind: 'style';
+} & QueueItem<Style, StyleReducerActions>);
 export type QueueContextValue = {
-    enqueueMiddleware: ReducerMiddlewareCallback<Schema | Style, [action: StyleReducerActions | SchemaReducerActions]>;
+    /** What queues the schema reducer's changes, as its middleware. */
+    enqueueSchema: ReducerMiddlewareCallback<Schema, [action: SchemaReducerActions]>;
+    /** What queues the style reducer's changes, as its middleware. */
+    enqueueStyle: ReducerMiddlewareCallback<Style, [action: StyleReducerActions]>;
 };
 declare const QueueContext: import('react').Context<QueueContextValue>;
 export default QueueContext;

package/dist/modules/Queue/hooks/useQueueManager.d.ts

@@ -1,4 +1,4 @@
-import { QueueItem } from '../QueueContext';
+import { QueuedChange } from '../QueueContext';
 import { BuilderMutationsMap, BuilderQueriesMap } from '@plitzi/sdk-shared';
 import { NetworkContextValue } from '@plitzi/sdk-shared/network/NetworkContext';
 export type UseQueueManagerProps = {
@@ -9,7 +9,7 @@ export type UseQueueManagerProps = {
     disabled?: boolean;
 };
 declare const useQueueManager: ({ delay, mutate, maxRetries, retryTimeout, disabled }: UseQueueManagerProps) => {
-    enqueue: (item: QueueItem) => void;
+    enqueue: (item: QueuedChange) => void;
     processing: boolean;
 };
 export default useQueueManager;

package/dist/modules/Undoable/UndoableContext.d.ts

@@ -4,21 +4,30 @@ import { SchemaReducerActions } from '@plitzi/sdk-schema/SchemaReducer';
 import { Schema, Style } from '@plitzi/sdk-shared';
 import { StyleReducerActions } from '@plitzi/sdk-style/StyleReducer';
 import { ActionDispatch } from 'react';
-export type UndoableItem<TState = any, TDispatchAction = any> = {
+export type UndoableItem<TState, TDispatchAction> = {
     action: TDispatchAction;
     dispatch: ActionDispatch<[action: TDispatchAction]>;
     nextState: TState;
     prevState: TState;
 };
+/** A change the history keeps: to the schema or to the style, each with its own reducer's state and action. */
+export type UndoableChange = ({
+    kind: 'schema';
+} & UndoableItem<Schema, SchemaReducerActions>) | ({
+    kind: 'style';
+} & UndoableItem<Style, StyleReducerActions>);
 export type UndoableContextValue = {
     canUndo: boolean;
     canRedo: boolean;
     dispatchUndoable: ActionDispatch<[action: UndoableReducerActions]>;
-    undoableAddUndo: (prevState: UndoableItem['prevState'], action: UndoableItem['action'], nextState: UndoableItem['nextState'], dispatch: UndoableItem['dispatch']) => void;
+    undoableAddUndo: (change: UndoableChange) => void;
     undoableUndo: () => void;
     undoableRedo: () => void;
     undoableClearHistory: () => void;
-    undoableMiddleware: ReducerMiddlewareCallback<Schema | Style, [action: StyleReducerActions | SchemaReducerActions]>;
+    /** What remembers the schema reducer's changes, as its middleware. */
+    undoableSchema: ReducerMiddlewareCallback<Schema, [action: SchemaReducerActions]>;
+    /** What remembers the style reducer's changes, as its middleware. */
+    undoableStyle: ReducerMiddlewareCallback<Style, [action: StyleReducerActions]>;
 };
 declare const UndoableContext: import('react').Context<UndoableContextValue>;
 export default UndoableContext;

package/dist/modules/Undoable/UndoableReducer.d.ts

@@ -1,20 +1,21 @@
-import { UndoableItem } from './UndoableContext';
-export type UndoableReducerActions = ({
+import { UndoableChange } from './UndoableContext';
+export type UndoableReducerActions = {
     type: 'undoableAddUndo';
-} & UndoableItem) | {
+    change: UndoableChange;
+} | {
     type: 'undoableUndo';
-    past: UndoableItem[];
-    future: UndoableItem[];
+    past: UndoableChange[];
+    future: UndoableChange[];
 } | {
     type: 'undoableRedo';
-    past: UndoableItem[];
-    future: UndoableItem[];
+    past: UndoableChange[];
+    future: UndoableChange[];
 } | {
     type: 'undoableClearHistory';
 };
 export type UndoableState = {
-    past: UndoableItem[];
-    future: UndoableItem[];
+    past: UndoableChange[];
+    future: UndoableChange[];
     canUndo: boolean;
     canRedo: boolean;
 };

package/dist/package.json.d.ts

@@ -1,6 +1,6 @@
 declare const _default: {
   "name": "@plitzi/plitzi-builder",
-  "version": "0.38.11",
+  "version": "0.38.12",
   "homepage": "./",
   "license": "AGPL-3.0",
   "files": [