@cratis/scene.primereact 0.1.0

package/dist/esm/theme/usePrimeReactTheme.js

@@ -0,0 +1,45 @@
+import { useEffect } from 'react';
+import { applyPrimeReactTheme } from './applyPrimeReactTheme.js';
+import { themeLinkElementId } from './primeReactThemeStylesheet.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Keeps the loaded PrimeReact theme stylesheet in step with the active Scene {@link Theme}.
+ *
+ * Theming a Scene screen that uses this package takes two halves, and this is the half `SceneThemeProvider`
+ * cannot do. The provider writes the theme's semantic tokens onto the wrapping element, which reaches
+ * anything reading `--scene-*` - this package's own wrappers, `core`'s primitives, a layout's CSS. But
+ * PrimeReact 10's components are skinned by a compiled stylesheet, and no amount of token-setting
+ * changes which stylesheet is loaded. So: provider for the tokens, this hook for the stylesheet.
+ *
+ * Use them together:
+ *
+ * ```tsx
+ * const [theme, setTheme] = useState(primeReactTheme('lara-light-blue'));
+ * usePrimeReactTheme(theme);
+ * return <SceneThemeProvider theme={theme}>{children}</SceneThemeProvider>;
+ * ```
+ *
+ * Switching is live: nothing reloads, nothing below the provider remounts, and no state is lost. That is
+ * what lets a gallery change theme as fast as someone can click through a picker, which is the whole
+ * reason theme switching is re-resolution rather than a restart.
+ *
+ * @param theme The active theme. A theme this package does not ship - or `undefined` - leaves the loaded
+ * stylesheet alone rather than unloading it, so a profile mixing in a theme from another package does
+ * not strip PrimeReact's skin on its way past.
+ * @param linkElementId The id of the stylesheet `<link>`, should the application use something other than
+ * PrimeReact's conventional `theme-link`.
+ */ function usePrimeReactTheme(theme, linkElementId = themeLinkElementId) {
+    const themeName = theme?.name;
+    useEffect(()=>{
+        if (themeName === undefined) return;
+        applyPrimeReactTheme(themeName, linkElementId);
+    }, [
+        themeName,
+        linkElementId
+    ]);
+}
+
+export { usePrimeReactTheme };
+//# sourceMappingURL=usePrimeReactTheme.js.map

package/dist/esm/theme/usePrimeReactTheme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePrimeReactTheme.js","sources":["../../../theme/usePrimeReactTheme.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { useEffect } from 'react';\nimport { Theme } from '@cratis/scene.model';\nimport { applyPrimeReactTheme } from './applyPrimeReactTheme';\nimport { themeLinkElementId } from './primeReactThemeStylesheet';\n\n/**\n * Keeps the loaded PrimeReact theme stylesheet in step with the active Scene {@link Theme}.\n *\n * Theming a Scene screen that uses this package takes two halves, and this is the half `SceneThemeProvider`\n * cannot do. The provider writes the theme's semantic tokens onto the wrapping element, which reaches\n * anything reading `--scene-*` - this package's own wrappers, `core`'s primitives, a layout's CSS. But\n * PrimeReact 10's components are skinned by a compiled stylesheet, and no amount of token-setting\n * changes which stylesheet is loaded. So: provider for the tokens, this hook for the stylesheet.\n *\n * Use them together:\n *\n * ```tsx\n * const [theme, setTheme] = useState(primeReactTheme('lara-light-blue'));\n * usePrimeReactTheme(theme);\n * return <SceneThemeProvider theme={theme}>{children}</SceneThemeProvider>;\n * ```\n *\n * Switching is live: nothing reloads, nothing below the provider remounts, and no state is lost. That is\n * what lets a gallery change theme as fast as someone can click through a picker, which is the whole\n * reason theme switching is re-resolution rather than a restart.\n *\n * @param theme The active theme. A theme this package does not ship - or `undefined` - leaves the loaded\n * stylesheet alone rather than unloading it, so a profile mixing in a theme from another package does\n * not strip PrimeReact's skin on its way past.\n * @param linkElementId The id of the stylesheet `<link>`, should the application use something other than\n * PrimeReact's conventional `theme-link`.\n */\nexport function usePrimeReactTheme(theme: Theme | undefined, linkElementId: string = themeLinkElementId): void {\n    const themeName = theme?.name;\n\n    useEffect(() => {\n        if (themeName === undefined) return;\n        applyPrimeReactTheme(themeName, linkElementId);\n    }, [themeName, linkElementId]);\n}\n"],"names":["usePrimeReactTheme","theme","linkElementId","themeLinkElementId","themeName","name","useEffect","undefined","applyPrimeReactTheme"],"mappings":";;;;AAAA;AACA;AAOA;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BC,IACM,SAASA,kBAAAA,CAAmBC,KAAwB,EAAEC,gBAAwBC,kBAAkB,EAAA;AACnG,IAAA,MAAMC,YAAYH,KAAAA,EAAOI,IAAAA;IAEzBC,SAAAA,CAAU,IAAA;AACN,QAAA,IAAIF,cAAcG,SAAAA,EAAW;AAC7BC,QAAAA,oBAAAA,CAAqBJ,SAAAA,EAAWF,aAAAA,CAAAA;IACpC,CAAA,EAAG;AAACE,QAAAA,SAAAA;AAAWF,QAAAA;AAAc,KAAA,CAAA;AACjC;;;;"}

package/dist/esm/treeNodes.d.ts

@@ -0,0 +1,5 @@
+import type { TreeNode } from 'primereact/treenode';
+import { SceneElement } from '@cratis/scene.model';
+export declare function toTreeNodes(entries: unknown[], parentKey?: string): TreeNode[];
+export declare function treeNodesProperty(element: SceneElement, name: string): TreeNode[];
+//# sourceMappingURL=treeNodes.d.ts.map

package/dist/esm/treeNodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeNodes.d.ts","sourceRoot":"","sources":["../../treeNodes.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAgBnD,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,SAAS,SAAK,GAAG,QAAQ,EAAE,CAuB1E;AASD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,EAAE,CAEjF"}

package/dist/esm/treeNodes.js

@@ -0,0 +1,54 @@
+import { arrayProperty } from './properties.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Turns raw authored entries into the `TreeNode` model PrimeReact's tree, tree table, tree select and
+ * organization chart all share.
+ *
+ * A `key` is synthesized from the node's path when an author did not supply one. That is not cosmetic:
+ * PrimeReact keys expansion, selection and virtual scrolling off `key`, so a tree of unkeyed nodes
+ * expands the wrong rows the moment two siblings share a label. Deriving the key from the path makes it
+ * unique and stable across re-renders without asking the author for anything.
+ *
+ * @param entries The raw entries to convert.
+ * @param parentKey The key of the node these entries belong to, used to build stable child keys.
+ * @returns The converted nodes, in order.
+ */ function toTreeNodes(entries, parentKey = '') {
+    const nodes = [];
+    entries.forEach((entry, index)=>{
+        const path = parentKey === '' ? `${index}` : `${parentKey}-${index}`;
+        if (typeof entry === 'string') {
+            nodes.push({
+                key: path,
+                label: entry
+            });
+            return;
+        }
+        if (typeof entry !== 'object' || entry === undefined || entry === null || Array.isArray(entry)) return;
+        const record = entry;
+        const node = {
+            key: typeof record.key === 'string' ? record.key : path
+        };
+        if (typeof record.label === 'string') node.label = record.label;
+        if (typeof record.icon === 'string') node.icon = record.icon;
+        if (typeof record.className === 'string') node.className = record.className;
+        if (typeof record.leaf === 'boolean') node.leaf = record.leaf;
+        if (typeof record.data === 'object' && record.data !== null) node.data = record.data;
+        if (Array.isArray(record.children)) node.children = toTreeNodes(record.children, node.key);
+        nodes.push(node);
+    });
+    return nodes;
+}
+/**
+ * Reads a tree model off a Scene element's properties.
+ *
+ * @param element The element whose properties to read.
+ * @param name The property name holding the entries.
+ * @returns The converted nodes, empty when the property is missing or is not an array.
+ */ function treeNodesProperty(element, name) {
+    return toTreeNodes(arrayProperty(element, name));
+}
+
+export { toTreeNodes, treeNodesProperty };
+//# sourceMappingURL=treeNodes.js.map

package/dist/esm/treeNodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeNodes.js","sources":["../../treeNodes.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport type { TreeNode } from 'primereact/treenode';\nimport { SceneElement } from '@cratis/scene.model';\nimport { arrayProperty } from './properties';\n\n/**\n * Turns raw authored entries into the `TreeNode` model PrimeReact's tree, tree table, tree select and\n * organization chart all share.\n *\n * A `key` is synthesized from the node's path when an author did not supply one. That is not cosmetic:\n * PrimeReact keys expansion, selection and virtual scrolling off `key`, so a tree of unkeyed nodes\n * expands the wrong rows the moment two siblings share a label. Deriving the key from the path makes it\n * unique and stable across re-renders without asking the author for anything.\n *\n * @param entries The raw entries to convert.\n * @param parentKey The key of the node these entries belong to, used to build stable child keys.\n * @returns The converted nodes, in order.\n */\nexport function toTreeNodes(entries: unknown[], parentKey = ''): TreeNode[] {\n    const nodes: TreeNode[] = [];\n    entries.forEach((entry, index) => {\n        const path = parentKey === '' ? `${index}` : `${parentKey}-${index}`;\n        if (typeof entry === 'string') {\n            nodes.push({ key: path, label: entry });\n            return;\n        }\n\n        if (typeof entry !== 'object' || entry === undefined || entry === null || Array.isArray(entry)) return;\n\n        const record = entry as Record<string, unknown>;\n        const node: TreeNode = { key: typeof record.key === 'string' ? record.key : path };\n        if (typeof record.label === 'string') node.label = record.label;\n        if (typeof record.icon === 'string') node.icon = record.icon;\n        if (typeof record.className === 'string') node.className = record.className;\n        if (typeof record.leaf === 'boolean') node.leaf = record.leaf;\n        if (typeof record.data === 'object' && record.data !== null) node.data = record.data;\n        if (Array.isArray(record.children)) node.children = toTreeNodes(record.children, node.key as string);\n        nodes.push(node);\n    });\n\n    return nodes;\n}\n\n/**\n * Reads a tree model off a Scene element's properties.\n *\n * @param element The element whose properties to read.\n * @param name The property name holding the entries.\n * @returns The converted nodes, empty when the property is missing or is not an array.\n */\nexport function treeNodesProperty(element: SceneElement, name: string): TreeNode[] {\n    return toTreeNodes(arrayProperty(element, name));\n}\n"],"names":["toTreeNodes","entries","parentKey","nodes","forEach","entry","index","path","push","key","label","undefined","Array","isArray","record","node","icon","className","leaf","data","children","treeNodesProperty","element","name","arrayProperty"],"mappings":";;AAAA;AACA;AAMA;;;;;;;;;;;;AAYC,IACM,SAASA,WAAAA,CAAYC,OAAkB,EAAEC,YAAY,EAAE,EAAA;AAC1D,IAAA,MAAMC,QAAoB,EAAE;IAC5BF,OAAAA,CAAQG,OAAO,CAAC,CAACC,KAAAA,EAAOC,KAAAA,GAAAA;QACpB,MAAMC,IAAAA,GAAOL,SAAAA,KAAc,EAAA,GAAK,CAAA,EAAGI,KAAAA,CAAAA,CAAO,GAAG,CAAA,EAAGJ,SAAAA,CAAU,CAAC,EAAEI,KAAAA,CAAAA,CAAO;QACpE,IAAI,OAAOD,UAAU,QAAA,EAAU;AAC3BF,YAAAA,KAAAA,CAAMK,IAAI,CAAC;gBAAEC,GAAAA,EAAKF,IAAAA;gBAAMG,KAAAA,EAAOL;AAAM,aAAA,CAAA;AACrC,YAAA;AACJ,QAAA;QAEA,IAAI,OAAOA,KAAAA,KAAU,QAAA,IAAYA,KAAAA,KAAUM,SAAAA,IAAaN,UAAU,IAAA,IAAQO,KAAAA,CAAMC,OAAO,CAACR,KAAAA,CAAAA,EAAQ;AAEhG,QAAA,MAAMS,MAAAA,GAAST,KAAAA;AACf,QAAA,MAAMU,IAAAA,GAAiB;AAAEN,YAAAA,GAAAA,EAAK,OAAOK,MAAAA,CAAOL,GAAG,KAAK,QAAA,GAAWK,MAAAA,CAAOL,GAAG,GAAGF;AAAK,SAAA;QACjF,IAAI,OAAOO,OAAOJ,KAAK,KAAK,UAAUK,IAAAA,CAAKL,KAAK,GAAGI,MAAAA,CAAOJ,KAAK;QAC/D,IAAI,OAAOI,OAAOE,IAAI,KAAK,UAAUD,IAAAA,CAAKC,IAAI,GAAGF,MAAAA,CAAOE,IAAI;QAC5D,IAAI,OAAOF,OAAOG,SAAS,KAAK,UAAUF,IAAAA,CAAKE,SAAS,GAAGH,MAAAA,CAAOG,SAAS;QAC3E,IAAI,OAAOH,OAAOI,IAAI,KAAK,WAAWH,IAAAA,CAAKG,IAAI,GAAGJ,MAAAA,CAAOI,IAAI;AAC7D,QAAA,IAAI,OAAOJ,MAAAA,CAAOK,IAAI,KAAK,QAAA,IAAYL,MAAAA,CAAOK,IAAI,KAAK,IAAA,EAAMJ,IAAAA,CAAKI,IAAI,GAAGL,OAAOK,IAAI;AACpF,QAAA,IAAIP,KAAAA,CAAMC,OAAO,CAACC,MAAAA,CAAOM,QAAQ,CAAA,EAAGL,IAAAA,CAAKK,QAAQ,GAAGpB,WAAAA,CAAYc,MAAAA,CAAOM,QAAQ,EAAEL,KAAKN,GAAG,CAAA;AACzFN,QAAAA,KAAAA,CAAMK,IAAI,CAACO,IAAAA,CAAAA;AACf,IAAA,CAAA,CAAA;IAEA,OAAOZ,KAAAA;AACX;AAEA;;;;;;AAMC,IACM,SAASkB,iBAAAA,CAAkBC,OAAqB,EAAEC,IAAY,EAAA;IACjE,OAAOvB,WAAAA,CAAYwB,cAAcF,OAAAA,EAASC,IAAAA,CAAAA,CAAAA;AAC9C;;;;"}