@dxos/react-ui-syntax-highlighter 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@dxos/react-ui-syntax-highlighter",
-  "version": "0.8.4-main.c1de068",
+  "version": "0.8.4-main.c85a9c8dae",
   "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,28 @@
     "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.c85a9c8dae"
   },
   "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.c1de068",
-    "@dxos/react-ui-theme": "0.8.4-main.c1de068",
-    "@dxos/storybook-utils": "0.8.4-main.c1de068"
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^7.1.11",
+    "@dxos/random": "0.8.4-main.c85a9c8dae",
+    "@dxos/util": "0.8.4-main.c85a9c8dae",
+    "@dxos/ui-theme": "0.8.4-main.c85a9c8dae",
+    "@dxos/storybook-utils": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui": "0.8.4-main.c85a9c8dae"
   },
   "peerDependencies": {
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.c1de068",
-    "@dxos/react-ui-theme": "0.8.4-main.c1de068"
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.c85a9c8dae",
+    "@dxos/ui-theme": "0.8.4-main.c85a9c8dae"
   },
   "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 { faker } from '@dxos/random';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { Json } from './Json';
+
+faker.seed(0);
+
+const createNode = () => {
+  const data: Record<string, any> = {};
+  const keys = [...Array(faker.number.int({ min: 1, max: 5 }))].map(() => faker.lorem.word());
+  keys.forEach((key) => {
+    switch (faker.helpers.arrayElement(['object', 'string', 'number', 'boolean', 'null'])) {
+      case 'object':
+        data[key] = createNode();
+        break;
+      case 'string':
+        data[key] = faker.lorem.word();
+        break;
+      case 'number':
+        data[key] = faker.number.int();
+        break;
+      case 'boolean':
+        data[key] = faker.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 = faker.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 meta = {
+  title: 'ui/react-ui-syntax-highlighter/Json',
+  component: Json,
+  decorators: [withTheme(), withLayout({ layout: 'column' })],
+} satisfies Meta<typeof Json>;
+
+export default meta;
+
+type Story = StoryObj<typeof Json>;
+
+const data = createData();
+
+export const Default: Story = {
+  args: {
+    classNames: 'text-sm',
+    data,
+  },
+};
+
+export const Filter: Story = {
+  args: {
+    classNames: 'text-sm',
+    filter: true,
+    data,
+  },
+};
+
+export const Large: Story = {
+  args: {
+    classNames: 'text-sm',
+    filter: true,
+    data: createData({ depth: 5 }),
+    replacer: {
+      maxDepth: 3,
+      maxArrayLen: 10,
+      maxStringLen: 10,
+    },
+  },
+};
+
+const cycle: any = {
+  a: 1,
+  b: [],
+};
+
+cycle.b.push(cycle);
+
+// NOTE: Storybook args cannot be circular.
+export const Cycle: Story = {
+  render: () => <Json data={cycle} />,
+};

package/src/Json/Json.tsx

@@ -2,56 +2,78 @@
 // 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, { forwardRef, useEffect, useState } from 'react';
 
 import { Input, type ThemedClassName } from '@dxos/react-ui';
+import { type CreateReplacerProps, createReplacer, safeStringify } from '@dxos/util';
 
 import { SyntaxHighlighter } from '../SyntaxHighlighter';
 
-export type JsonProps = ThemedClassName<{ data?: any; testId?: string }>;
+export type JsonProps = ThemedClassName<{
+  data?: any;
+  filter?: boolean;
+  replacer?: CreateReplacerProps;
+  testId?: string;
+}>;
 
-export const Json = ({ data, classNames, testId }: JsonProps) => {
+export const Json = forwardRef<HTMLDivElement, JsonProps>((props, forwardedRef) => {
+  if (props.filter) {
+    return <JsonFilter {...props} />;
+  }
+
+  const { classNames, data, replacer, testId } = props;
   return (
-    <SyntaxHighlighter language='json' classNames={['w-full', classNames]} data-testid={testId}>
-      {JSON.stringify(data, null, 2)}
+    <SyntaxHighlighter
+      language='json'
+      classNames={['w-full overflow-y-auto text-sm', classNames]}
+      data-testid={testId}
+      ref={forwardedRef}
+    >
+      {safeStringify(data, replacer && createReplacer(replacer), 2)}
     </SyntaxHighlighter>
   );
-};
-
-export const JsonFilter = ({ data: initialData, classNames, testId }: JsonProps) => {
-  const [data, setData] = useState(initialData);
-  const [text, setText] = useState('');
-  const [error, setError] = useState<Error | null>(null);
-  useEffect(() => {
-    if (!initialData || !text.trim().length) {
-      setData(initialData);
-    } else {
-      try {
-        setData(jp.query(initialData, text));
-        setError(null);
-      } catch (err) {
+});
+
+export const JsonFilter = forwardRef<HTMLDivElement, JsonProps>(
+  ({ classNames, data: initialData, replacer, testId }, forwardedRef) => {
+    const [data, setData] = useState(initialData);
+    const [text, setText] = useState('');
+    const [error, setError] = useState<Error | null>(null);
+
+    useEffect(() => {
+      if (!initialData || !text.trim().length) {
         setData(initialData);
-        setError(err as Error);
+      } else {
+        try {
+          setData(JSONPath({ path: text, json: initialData }));
+          setError(null);
+        } catch (err) {
+          setData(initialData);
+          setError(err as Error);
+        }
       }
-    }
-  }, [initialData, text]); // TODO(burdon): Need structural diff.
+    }, [initialData, text]); // TODO(burdon): Need structural diff.
 
-  return (
-    <div className='flex flex-col grow overflow-hidden'>
-      <Input.Root validationValence={error ? 'error' : 'success'}>
-        <Input.TextInput
-          classNames={['p-1 px-2 font-mono', error && 'border-red-500']}
-          variant='subdued'
-          value={text}
-          onChange={(event) => setText(event.target.value)}
-          placeholder='JSONPath (e.g., $.graph.nodes)'
-        />
-      </Input.Root>
-      <SyntaxHighlighter language='json' classNames={['grow overflow-y-auto', classNames]} data-testid={testId}>
-        {JSON.stringify(data, null, 2)}
-      </SyntaxHighlighter>
-    </div>
-  );
-};
+    return (
+      <div className='flex flex-col h-full overflow-hidden' ref={forwardedRef}>
+        <Input.Root validationValence={error ? 'error' : 'success'}>
+          <Input.TextInput
+            classNames={['p-1 px-2 font-mono', error && 'border-rose-500']}
+            variant='subdued'
+            value={text}
+            placeholder='JSONPath (e.g., $.graph.nodes)'
+            onChange={(event) => setText(event.target.value)}
+          />
+        </Input.Root>
+        <SyntaxHighlighter
+          language='json'
+          classNames={['w-full overflow-y-auto text-sm', classNames]}
+          data-testid={testId}
+        >
+          {safeStringify(data, replacer && createReplacer(replacer), 2)}
+        </SyntaxHighlighter>
+      </div>
+    );
+  },
+);

package/src/SyntaxHighlighter/SyntaxHighlighter.stories.tsx

@@ -2,19 +2,24 @@
 // 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: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta<typeof SyntaxHighlighter>;
 
 export default meta;
 
@@ -24,19 +29,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

@@ -3,47 +3,64 @@
 //
 
 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 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 { type ThemedClassName, useThemeContext } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import { ScrollArea, type ThemedClassName, useThemeContext } from '@dxos/react-ui';
+import { mx } from '@dxos/ui-theme';
 
 const zeroWidthSpace = '\u200b';
 
 export type SyntaxHighlighterProps = ThemedClassName<
-  NativeSyntaxHighlighterProps & {
+  NaturalSyntaxHighlighterProps & {
     fallback?: string;
   }
 >;
 
-light.hljs.background = '';
-dark.hljs.background = '';
-
 /**
+ * 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
  */
+// TODO(burdon): Replace with react-ui-editor (and reuse styles).
 export const SyntaxHighlighter = ({
   classNames,
   children,
+  language = 'text',
   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>
+    <ScrollArea.Root thin classNames={mx('p1', classNames)}>
+      <ScrollArea.Viewport>
+        <div role='none'>
+          <NativeSyntaxHighlighter
+            language={languages[language as keyof typeof languages] || language}
+            style={themeMode === 'dark' ? dark : light}
+            customStyle={{
+              background: 'unset',
+              border: 'none',
+              boxShadow: 'none',
+              padding: 0,
+              margin: 0,
+            }}
+            {...props}
+          >
+            {/* Non-empty fallback prevents collapse. */}
+            {children || fallback}
+          </NativeSyntaxHighlighter>
+        </div>
+      </ScrollArea.Viewport>
+    </ScrollArea.Root>
   );
 };
+
+const languages = {
+  js: 'javascript',
+  ts: 'typescript',
+};