@dxos/react-ui-syntax-highlighter 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@dxos/react-ui-syntax-highlighter",
-  "version": "0.8.4-main.f9ba587",
+  "version": "0.8.4-main.fcfe5033a5",
   "description": "A syntax highlighter wrapper.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
@@ -24,27 +29,29 @@
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "jsonpath": "^1.1.1",
-    "react-syntax-highlighter": "^15.5.0"
+    "jsonpath-plus": "^10.3.0",
+    "react-syntax-highlighter": "^15.6.1",
+    "@dxos/util": "0.8.4-main.fcfe5033a5",
+    "@dxos/ui-types": "0.8.4-main.fcfe5033a5"
   },
   "devDependencies": {
-    "@types/jsonpath": "^0.2.4",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
     "@types/react-syntax-highlighter": "^15.5.13",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/react-ui": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-theme": "0.8.4-main.f9ba587",
-    "@dxos/storybook-utils": "0.8.4-main.f9ba587"
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^7.1.11",
+    "@dxos/random": "0.8.4-main.fcfe5033a5",
+    "@dxos/storybook-utils": "0.8.4-main.fcfe5033a5",
+    "@dxos/ui-theme": "0.8.4-main.fcfe5033a5",
+    "@dxos/react-ui": "0.8.4-main.fcfe5033a5",
+    "@dxos/util": "0.8.4-main.fcfe5033a5"
   },
   "peerDependencies": {
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-theme": "0.8.4-main.f9ba587"
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.fcfe5033a5",
+    "@dxos/ui-theme": "0.8.4-main.fcfe5033a5"
   },
   "publishConfig": {
     "access": "public"

package/src/Json/Json.stories.tsx

@@ -0,0 +1,106 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+
+import { random } from '@dxos/random';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { Json } from './Json';
+
+random.seed(0);
+
+const createNode = () => {
+  const data: Record<string, any> = {};
+  const keys = [...Array(random.number.int({ min: 1, max: 5 }))].map(() => random.lorem.word());
+  keys.forEach((key) => {
+    switch (random.helpers.arrayElement(['object', 'string', 'number', 'boolean', 'null'])) {
+      case 'object':
+        data[key] = createNode();
+        break;
+      case 'string':
+        data[key] = random.lorem.word();
+        break;
+      case 'number':
+        data[key] = random.number.int();
+        break;
+      case 'boolean':
+        data[key] = random.datatype.boolean();
+        break;
+      case 'null':
+        data[key] = null;
+        break;
+    }
+  });
+
+  return data;
+};
+
+const createData = ({ depth = 2, children = 3 } = {}): any => {
+  const createChildren = (root: any, d = 0) => {
+    if (d < depth) {
+      const num = random.number.int({ min: 1, max: Math.round(Math.log(depth + 1 - d) * children) });
+      root.children = [...new Array(num)].map(() => {
+        return createChildren(createNode(), d + 1);
+      });
+    }
+
+    return root;
+  };
+
+  return createChildren(createNode());
+};
+
+const createCycle = () => {
+  const data: any = {
+    a: 1,
+    b: [],
+  };
+
+  data.b.push(data);
+  return data;
+};
+
+const meta = {
+  title: 'ui/react-ui-syntax-highlighter/Json',
+  component: Json.Root,
+  decorators: [withTheme(), withLayout({ layout: 'column' })],
+} satisfies Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+/** Standalone Json.Data — simplest usage. */
+export const Default: Story = {
+  render: (args) => <Json.Data {...args} />,
+  args: {
+    data: createData(),
+  },
+};
+
+/** Circular reference handling. */
+export const Cycle: Story = {
+  render: (args) => <Json.Data {...args} />,
+  args: {
+    data: createCycle(),
+  },
+};
+
+/** Large dataset with replacer. */
+export const Filter: Story = {
+  render: (args) => (
+    <Json.Root {...args}>
+      <Json.Content>
+        <Json.Filter />
+        <Json.Data />
+      </Json.Content>
+    </Json.Root>
+  ),
+  args: {
+    data: createData({ depth: 5 }),
+    replacer: { maxDepth: 3, maxArrayLen: 10, maxStringLen: 10 },
+  },
+};

package/src/Json/Json.tsx

@@ -2,57 +2,189 @@
 // Copyright 2025 DXOS.org
 //
 
-// TODO(burdon): Move to jsonpath-plus.
-import jp from 'jsonpath';
-import React, { useEffect, useState } from 'react';
+import { JSONPath } from 'jsonpath-plus';
+import React, {
+  createContext,
+  type PropsWithChildren,
+  forwardRef,
+  useContext,
+  useEffect,
+  useMemo,
+  useState,
+} from 'react';
 
-import { Input, type ThemedClassName } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import { Input } from '@dxos/react-ui';
+import { composable, composableProps } from '@dxos/ui-theme';
+import { type ComposableProps } from '@dxos/ui-types';
+import { type CreateReplacerProps, createReplacer, safeStringify } from '@dxos/util';
 
 import { SyntaxHighlighter } from '../SyntaxHighlighter';
 
-export type JsonProps = ThemedClassName<{ data?: any; testId?: string }>;
+//
+// Context
+//
 
-export const Json = ({ data, classNames, testId }: JsonProps) => {
-  return (
-    <SyntaxHighlighter language='json' classNames={['w-full', classNames]} data-testid={testId}>
-      {JSON.stringify(data, null, 2)}
-    </SyntaxHighlighter>
-  );
+type JsonContextType = {
+  data: any;
+  filteredData: any;
+  filterText: string;
+  setFilterText: (text: string) => void;
+  filterError: Error | null;
+  replacer?: CreateReplacerProps;
+};
+
+const JsonContext = createContext<JsonContextType | null>(null);
+
+/** Require Json context (throws if used outside Json.Root). */
+const useJsonContext = (consumerName: string): JsonContextType => {
+  const context = useContext(JsonContext);
+  if (!context) {
+    throw new Error(`\`${consumerName}\` must be used within \`Json.Root\`.`);
+  }
+  return context;
 };
 
-export const JsonFilter = ({ data: initialData, classNames, testId }: JsonProps) => {
-  const [data, setData] = useState(initialData);
-  const [text, setText] = useState('');
-  const [error, setError] = useState<Error | null>(null);
+/** Optional Json context (returns null outside Json.Root). */
+const useOptionalJsonContext = (): JsonContextType | null => {
+  return useContext(JsonContext);
+};
+
+//
+// Root
+//
+
+const JSON_ROOT_NAME = 'Json.Root';
+
+type JsonRootProps = PropsWithChildren<{
+  data?: any;
+  replacer?: CreateReplacerProps;
+}>;
+
+/** Headless context provider for Json composite. */
+const JsonRoot = forwardRef<HTMLDivElement, JsonRootProps>(({ children, data, replacer }, _forwardedRef) => {
+  const [filterText, setFilterText] = useState('');
+  const [filteredData, setFilteredData] = useState(data);
+  const [filterError, setFilterError] = useState<Error | null>(null);
+
   useEffect(() => {
-    if (!initialData || !text.trim().length) {
-      setData(initialData);
+    if (!filterText.trim().length) {
+      setFilteredData(data);
+      setFilterError(null);
     } else {
       try {
-        setData(jp.query(initialData, text));
-        setError(null);
+        setFilteredData(JSONPath({ path: filterText, json: data }));
+        setFilterError(null);
       } catch (err) {
-        setData(initialData);
-        setError(err as Error);
+        setFilteredData(data);
+        setFilterError(err as Error);
       }
     }
-  }, [initialData, text]); // TODO(burdon): Need structural diff.
+  }, [data, filterText]);
+
+  const context = useMemo(
+    () => ({ data, filteredData, filterText, setFilterText, filterError, replacer }),
+    [data, filteredData, filterText, setFilterText, filterError, replacer],
+  );
+
+  return <JsonContext.Provider value={context}>{children}</JsonContext.Provider>;
+});
+
+JsonRoot.displayName = JSON_ROOT_NAME;
 
+//
+// Content
+//
+
+const JSON_CONTENT_NAME = 'Json.Content';
+
+type JsonContentProps = ComposableProps;
+
+/** Layout container for Json composite parts. */
+const JsonContent = composable<HTMLDivElement, JsonContentProps>(({ children, ...props }, forwardedRef) => {
   return (
-    <div className='flex flex-col grow overflow-hidden'>
-      <Input.Root validationValence={error ? 'error' : 'success'}>
+    <div {...composableProps(props, { classNames: 'flex flex-col h-full min-h-0 overflow-hidden' })} ref={forwardedRef}>
+      {children}
+    </div>
+  );
+});
+
+JsonContent.displayName = JSON_CONTENT_NAME;
+
+//
+// Filter
+//
+
+const JSON_FILTER_NAME = 'Json.Filter';
+
+type JsonFilterProps = ComposableProps<{
+  placeholder?: string;
+}>;
+
+/** JSONPath filter input. Must be used within Json.Root. */
+const JsonFilter = forwardRef<HTMLInputElement, JsonFilterProps>(
+  ({ classNames, placeholder = 'JSONPath (e.g., $.graph.nodes)' }, forwardedRef) => {
+    const { filterText, setFilterText, filterError } = useJsonContext(JSON_FILTER_NAME);
+
+    return (
+      <Input.Root validationValence={filterError ? 'error' : 'success'}>
         <Input.TextInput
-          classNames={mx('p-1 px-2 font-mono', error && 'border-red-500')}
+          classNames={['p-1 px-2 font-mono', filterError && 'border-rose-500', classNames]}
           variant='subdued'
-          value={text}
-          onChange={(event) => setText(event.target.value)}
-          placeholder='JSONPath (e.g., $.graph.nodes)'
+          value={filterText}
+          placeholder={placeholder}
+          onChange={(event) => setFilterText(event.target.value)}
+          ref={forwardedRef}
         />
       </Input.Root>
-      <SyntaxHighlighter language='json' classNames={mx('grow overflow-y-auto', classNames)} data-testid={testId}>
-        {JSON.stringify(data, null, 2)}
+    );
+  },
+);
+
+JsonFilter.displayName = JSON_FILTER_NAME;
+
+//
+// Data
+//
+
+const JSON_DATA_NAME = 'Json.Data';
+
+type JsonDataProps = ComposableProps<{
+  data?: any;
+  replacer?: CreateReplacerProps;
+  testId?: string;
+}>;
+
+/** Syntax-highlighted JSON display. Works standalone or within Json.Root. */
+const JsonData = composable<HTMLDivElement, JsonDataProps>(
+  ({ data: dataProp, replacer: replacerProp, testId, ...props }, forwardedRef) => {
+    const context = useOptionalJsonContext();
+    const data = dataProp ?? context?.filteredData;
+    const replacer = replacerProp ?? context?.replacer;
+
+    return (
+      <SyntaxHighlighter
+        {...composableProps(props, { classNames: 'flex-1 min-h-0 w-full py-1 px-2 overflow-y-auto text-sm' })}
+        language='json'
+        data-testid={testId}
+        ref={forwardedRef}
+      >
+        {safeStringify(data, replacer && createReplacer(replacer), 2)}
       </SyntaxHighlighter>
-    </div>
-  );
+    );
+  },
+);
+
+JsonData.displayName = JSON_DATA_NAME;
+
+//
+// Json
+//
+
+export const Json = {
+  Root: JsonRoot,
+  Content: JsonContent,
+  Filter: JsonFilter,
+  Data: JsonData,
 };
+
+export type { JsonRootProps, JsonContentProps, JsonFilterProps, JsonDataProps };

package/src/Json/index.ts

@@ -2,4 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './Json';
+export { Json, type JsonRootProps, type JsonContentProps, type JsonFilterProps, type JsonDataProps } from './Json';

package/src/SyntaxHighlighter/SyntaxHighlighter.stories.tsx

@@ -2,19 +2,23 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 
-import { withTheme } from '@dxos/storybook-utils';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { trim } from '@dxos/util';
 
+// @ts-ignore - Vite raw import.
+import TEXT from '../../package.json?raw';
 import { SyntaxHighlighter } from './SyntaxHighlighter';
 
-const meta: Meta<typeof SyntaxHighlighter> = {
+const meta = {
   title: 'ui/react-ui-syntax-highlighter/SyntaxHighlighter',
   component: SyntaxHighlighter,
-  decorators: [withTheme],
-};
+  decorators: [withTheme(), withLayout({ layout: 'column' })],
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta<typeof SyntaxHighlighter>;
 
 export default meta;
 
@@ -24,19 +28,21 @@ export const Default: Story = {
   args: {
     language: 'json',
     classNames: 'text-sm',
-    children: JSON.stringify({ message: 'DXOS', initialized: true }, null, 2),
+    children: TEXT,
   },
 };
 
 export const Typescript: Story = {
   args: {
-    language: 'ts',
-    children: 'const x = 100;',
+    language: 'tsx',
+    children: trim`
+      import React from 'react'
+
+      const Test = () => {
+        return <div>Test</div>
+      }
+    `,
   },
 };
 
-export const Empty: Story = {
-  args: {
-    children: false,
-  },
-};
+export const Empty: Story = {};

package/src/SyntaxHighlighter/SyntaxHighlighter.tsx

@@ -2,48 +2,64 @@
 // Copyright 2024 DXOS.org
 //
 
-import React from 'react';
-import { type SyntaxHighlighterProps as NativeSyntaxHighlighterProps } from 'react-syntax-highlighter';
-// Using `light-async` version directly from dist to avoid any chance of the heavy one being loaded.
-// Lightweight version will load specific language parsers asynchronously.
-// eslint-disable-next-line no-restricted-imports
-import NativeSyntaxHighlighter from 'react-syntax-highlighter/dist/esm/light-async';
-// eslint-disable-next-line no-restricted-imports
-import { github as light, a11yDark as dark } from 'react-syntax-highlighter/dist/esm/styles/hljs';
-
-import { type ThemedClassName, useThemeContext } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import React, { CSSProperties } from 'react';
+import { type SyntaxHighlighterProps as NaturalSyntaxHighlighterProps } from 'react-syntax-highlighter';
+import NativeSyntaxHighlighter from 'react-syntax-highlighter/dist/esm/prism-async-light';
+import { coldarkDark as dark, coldarkCold as light } from 'react-syntax-highlighter/dist/esm/styles/prism';
+
+import { ScrollArea, useThemeContext } from '@dxos/react-ui';
+import { composable, composableProps } from '@dxos/ui-theme';
 
 const zeroWidthSpace = '\u200b';
 
-export type SyntaxHighlighterProps = ThemedClassName<
-  NativeSyntaxHighlighterProps & {
-    fallback?: string;
-  }
->;
+const languages = {
+  js: 'javascript',
+  ts: 'typescript',
+};
 
-light.hljs.background = '';
-dark.hljs.background = '';
+export type SyntaxHighlighterProps = NaturalSyntaxHighlighterProps & {
+  fallback?: string;
+};
 
 /**
+ * NOTE: Using `light-async` version directly from dist to avoid any chance of the heavy one being loaded.
+ * The lightweight version will load specific language parsers asynchronously.
+ *
  * https://github.com/react-syntax-highlighter/react-syntax-highlighter
+ * https://react-syntax-highlighter.github.io/react-syntax-highlighter/demo/prism.html
  */
-export const SyntaxHighlighter = ({
-  classNames,
-  children,
-  fallback = zeroWidthSpace,
-  ...props
-}: SyntaxHighlighterProps) => {
-  const { themeMode } = useThemeContext();
-
-  return (
-    <NativeSyntaxHighlighter
-      className={mx('w-full p-0 font-thin overflow-auto scrollbar-thin !text-baseText', classNames)}
-      style={themeMode === 'dark' ? dark : light}
-      {...props}
-    >
-      {/* Non-empty fallback prevents collapse. */}
-      {children || fallback}
-    </NativeSyntaxHighlighter>
-  );
-};
+export const SyntaxHighlighter = composable<HTMLDivElement, SyntaxHighlighterProps>(
+  (
+    { children, language = 'text', fallback = zeroWidthSpace, classNames, className, style, ...nativeProps },
+    forwardedRef,
+  ) => {
+    const { themeMode } = useThemeContext();
+
+    return (
+      <ScrollArea.Root {...composableProps({ classNames, className })} thin ref={forwardedRef}>
+        <ScrollArea.Viewport>
+          {/* NOTE: The div prevents NativeSyntaxHighlighter from managing scrolling. */}
+          <div role='none'>
+            <NativeSyntaxHighlighter
+              language={languages[language as keyof typeof languages] || language}
+              style={(style as { [key: string]: CSSProperties }) ?? (themeMode === 'dark' ? dark : light)}
+              customStyle={{
+                background: 'unset',
+                border: 'none',
+                boxShadow: 'none',
+                padding: 0,
+                margin: 0,
+              }}
+              {...nativeProps}
+            >
+              {/* Non-empty fallback prevents collapse. */}
+              {children || fallback}
+            </NativeSyntaxHighlighter>
+          </div>
+        </ScrollArea.Viewport>
+      </ScrollArea.Root>
+    );
+  },
+);
+
+SyntaxHighlighter.displayName = 'SyntaxHighlighter';