@tooee/view 0.7.3 → 0.8.0

package/src/hooks/use-content-commands.ts

@@ -8,6 +8,11 @@ interface UseContentCommandsParams {
   textContent: string;
 }
 
+/** View display state controlled by content-level commands. */
+export interface ContentCommandsResult {
+  showLineNumbers: boolean;
+}
+
 /**
  * The commands a content viewer owns on top of `DocumentScreen`: copying the
  * whole document and toggling the line-number gutter. Theme, quit, actions and
@@ -16,7 +21,7 @@ interface UseContentCommandsParams {
 export const useContentCommands = function useContentCommands({
   content,
   textContent,
-}: UseContentCommandsParams) {
+}: UseContentCommandsParams): ContentCommandsResult {
   const config = useConfig();
   const [showLineNumbers, setShowLineNumbers] = useState(config.view?.gutter ?? true);
 

package/src/hooks/use-content-document.ts

@@ -0,0 +1,54 @@
+import type { ActionDefinition } from "@tooee/commands";
+import type { StatusBarItem } from "@tooee/layout";
+import type { DecorationLayer } from "@tooee/renderers";
+import { useDocumentController } from "@tooee/shell";
+import type { DocumentController, DocumentRowAdapter } from "@tooee/shell";
+import type { AnyContent } from "../types.js";
+import { useContentCommands } from "./use-content-commands.js";
+
+interface ContentDocumentProps {
+  actions?: ActionDefinition[];
+  content: AnyContent;
+  decorations: DecorationLayer[];
+  textContent: string;
+}
+
+interface ContentDocumentOptions<T> {
+  buildStatusItems?: (document: DocumentController<T>) => StatusBarItem[];
+  contextMenu?: boolean;
+  multiSelect: boolean;
+  preserveCursorByKey?: boolean;
+  statusItems?: StatusBarItem[];
+}
+
+/** Shared document state used by each built-in content subview. */
+export interface ContentDocumentResult<T> {
+  document: DocumentController<T>;
+  showLineNumbers: boolean;
+  statusItems: StatusBarItem[];
+}
+
+/** Build the command, controller, and status state shared by content subviews. */
+export const useContentDocument = function useContentDocument<T>(
+  rows: readonly T[],
+  adapter: DocumentRowAdapter<T>,
+  { actions, content, decorations, textContent }: ContentDocumentProps,
+  options: ContentDocumentOptions<T>,
+): ContentDocumentResult<T> {
+  const { showLineNumbers } = useContentCommands({ content, textContent });
+  const document = useDocumentController<T>({
+    adapter,
+    contextMenu: options.contextMenu === false ? false : actions,
+    decorations,
+    multiSelect: options.multiSelect,
+    preserveCursorByKey: options.preserveCursorByKey,
+    rows,
+  });
+  const statusItems = options.buildStatusItems?.(document) ??
+    options.statusItems ?? [
+      { label: "Format:", value: content.format },
+      { label: "Lines:", value: String(rows.length) },
+    ];
+
+  return { document, showLineNumbers, statusItems };
+};

package/src/hooks/use-content-loader.ts

@@ -1,6 +1,8 @@
 import { useCallback, useEffect, useMemo } from "react";
 import { useSelector } from "@xstate/store-react";
-import type { ContentProvider } from "../types.js";
+import type { AnyContent, ContentProvider } from "../types.js";
+import type { MarkSet } from "@tooee/marks";
+import type { ContentLoaderStatus } from "../content-loader-store.js";
 import {
   createContentLoaderStore,
   isAsyncIterable,
@@ -13,7 +15,19 @@ import {
   selectStreaming,
 } from "../content-loader-store.js";
 
-export const useContentLoader = function useContentLoader(contentProvider: ContentProvider) {
+/** Reactive state exposed by the content provider loader. */
+export interface ContentLoaderState {
+  content: AnyContent | null;
+  error: string | null;
+  providerMarks: MarkSet[];
+  reload: () => void;
+  status: ContentLoaderStatus;
+  streaming: boolean;
+}
+
+export const useContentLoader = function useContentLoader(
+  contentProvider: ContentProvider,
+): ContentLoaderState {
   const store = useMemo(createContentLoaderStore, []);
   const loadSeq = useSelector(store, (snapshot) => selectLoadSeq(snapshot.context));
 
@@ -37,7 +51,7 @@ export const useContentLoader = function useContentLoader(contentProvider: Conte
       void (async () => {
         try {
           while (true) {
-            // Deferred(lint-sweep): preserve sequential stream consumption for ordered backpressure.
+            // preserve sequential stream consumption for ordered backpressure.
             // oxlint-disable-next-line no-await-in-loop -- each chunk must be consumed in iterator order
             const result = await iterator.next();
             if (result.done === true) {

package/src/hooks/use-view-command-context.ts

@@ -27,7 +27,7 @@ export interface ViewCommandContext {
 
 declare module "@tooee/commands" {
   interface CommandContext {
-    view: ViewCommandContext;
+    view?: ViewCommandContext;
   }
 }
 
@@ -50,6 +50,18 @@ export interface CreateViewCommandContextOptions {
 
 export type ProvideViewCommandContextOptions = CreateViewCommandContextOptions;
 
+type ViewCommandContextInput =
+  | ProvideViewCommandContextOptions
+  | (() => ProvideViewCommandContextOptions);
+
+/** Resolve the hook's public eager-or-lazy option union at its boundary. */
+const resolveViewCommandContextOptions = function resolveViewCommandContextOptions(
+  options: ViewCommandContextInput,
+): ProvideViewCommandContextOptions {
+  // oxlint-disable-next-line anti-slop/no-runtime-typeof -- public hook boundary distinguishes the documented lazy options callback from eager options
+  return typeof options === "function" ? options() : options;
+};
+
 export const createViewCommandContext = function createViewCommandContext({
   content,
   format,
@@ -84,9 +96,9 @@ export const createViewCommandContext = function createViewCommandContext({
 };
 
 export const useProvideViewCommandContext = function useProvideViewCommandContext(
-  options: ProvideViewCommandContextOptions | (() => ProvideViewCommandContextOptions),
-) {
+  options: ViewCommandContextInput,
+): void {
   useProvideCommandContextKey("view", () =>
-    createViewCommandContext(typeof options === "function" ? options() : options),
+    createViewCommandContext(resolveViewCommandContextOptions(options)),
   );
 };

package/src/index.ts

@@ -20,6 +20,8 @@ export type {
   ProvideViewCommandContextOptions,
   ViewCommandContext,
 } from "./hooks/use-view-command-context.js";
+export type { ContentLoaderState } from "./hooks/use-content-loader.js";
+export type { ContentCommandsResult } from "./hooks/use-content-commands.js";
 export type {
   AnyContent,
   Content,

package/src/launch.tsx

@@ -1,9 +1,10 @@
-import { launchCli } from "@tooee/shell";
+import { launchCli, runCliSession } from "@tooee/shell";
 import type { ActionDefinition } from "@tooee/commands";
 import type { CodeBlockRenderer } from "@tooee/renderers";
 import { View } from "./view.js";
 import { DirectoryView } from "./directory-view.js";
 import type { ContentProvider, ContentRenderer } from "./types.js";
+import type { ReactNode } from "react";
 
 export interface ViewLaunchOptions {
   contentProvider: ContentProvider;
@@ -23,13 +24,15 @@ export interface DirectoryLaunchOptions {
 }
 
 export const launch = async function launch(options: ViewLaunchOptions): Promise<void> {
-  await launchCli(
-    <View
-      contentProvider={options.contentProvider}
-      actions={options.actions}
-      renderers={options.renderers}
-      codeBlockRenderers={options.codeBlockRenderers}
-    />,
+  await runCliSession<undefined>(
+    (): ReactNode => (
+      <View
+        contentProvider={options.contentProvider}
+        actions={options.actions}
+        renderers={options.renderers}
+        codeBlockRenderers={options.codeBlockRenderers}
+      />
+    ),
   );
 };
 

package/src/types.ts

@@ -1,6 +1,7 @@
 import type { ReactNode } from "react";
 import type { ImageFit, ImageRenderProtocol, ImageSource } from "@opentui/core";
 import type { CommandContext } from "@tooee/commands";
+import { formatTableCell } from "@tooee/renderers";
 import type { ColumnDef, SourceLineRow, TableRow } from "@tooee/renderers";
 import type { DocumentController } from "@tooee/shell";
 import type { MarkSet } from "@tooee/marks";
@@ -18,6 +19,7 @@ export type Content =
 export type ContentFormat = Content["format"];
 
 /** Handles an inline Markdown link with the View's live command context. */
+// oxlint-disable-next-line anti-slop/no-unknown-returns -- public callback contract preserves the renderer's exact-true link-consumption result and permits legacy return values
 export type MarkdownLinkActivateHandler = (href: string, context: CommandContext) => unknown;
 
 interface BaseContent {
@@ -152,40 +154,6 @@ export const isCustomContent = function isCustomContent(
   return !BUILTIN_FORMATS.has(content.format);
 };
 
-const stringifyCell = function stringifyCell(value: unknown): string {
-  if (value === null || value === undefined) {
-    return "";
-  }
-  if (typeof value === "string") {
-    return value;
-  }
-  if (typeof value === "number" || typeof value === "boolean") {
-    return String(value);
-  }
-  if (typeof value === "string") {
-    return value;
-  }
-  if (
-    typeof value === "number" ||
-    typeof value === "bigint" ||
-    typeof value === "boolean" ||
-    typeof value === "symbol"
-  ) {
-    return value.toString();
-  }
-  if (value === null || value === undefined) {
-    return String(value);
-  }
-  if (typeof value === "function") {
-    return Function.prototype.toString.call(value);
-  }
-  try {
-    return JSON.stringify(value);
-  } catch {
-    return Array.isArray(value) ? value.join(",") : Object.prototype.toString.call(value);
-  }
-};
-
 export const getTextContent = function getTextContent(content: AnyContent): string {
   if (content.getTextContent) {
     return content.getTextContent();
@@ -209,6 +177,7 @@ export const getTextContent = function getTextContent(content: AnyContent): stri
       return content.text;
     }
     case "image": {
+      // oxlint-disable-next-line anti-slop/no-runtime-typeof -- ImageSource is OpenTUI's public string-or-binary union; only its string and URL variants have text content
       if (typeof content.src === "string") {
         return content.src;
       }
@@ -217,7 +186,7 @@ export const getTextContent = function getTextContent(content: AnyContent): stri
     case "table": {
       const headers = content.columns.map((column) => column.header ?? column.key);
       const rowLines = content.rows.map((row) =>
-        content.columns.map((column) => stringifyCell(row[column.key])).join("\t"),
+        content.columns.map((column) => formatTableCell(row[column.key])).join("\t"),
       );
       return [headers.join("\t"), ...rowLines].join("\n");
     }

package/src/view.tsx

@@ -16,6 +16,7 @@ import {
   DiffSubview,
   CustomSubview,
 } from "./components/subviews/index.js";
+import type { ReactNode } from "react";
 
 interface ViewProps {
   contentProvider: ContentProvider;
@@ -36,7 +37,7 @@ export const View = function View({
   renderers,
   codeBlockRenderers,
   onMarkdownLinkActivate,
-}: ViewProps): React.ReactNode {
+}: ViewProps): ReactNode {
   const { theme } = useTheme();
   const { content, streaming, error, providerMarks, reload } = useContentLoader(contentProvider);
 

package/dist/hooks/index.d.ts

@@ -1,5 +0,0 @@
-export { useContentLoader } from "./use-content-loader.js";
-export { useContentCommands } from "./use-content-commands.js";
-export { createViewCommandContext, useProvideViewCommandContext, } from "./use-view-command-context.js";
-export type { CreateViewCommandContextOptions, ProvideViewCommandContextOptions, ViewCommandContext, } from "./use-view-command-context.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACV,+BAA+B,EAC/B,gCAAgC,EAChC,kBAAkB,GACnB,MAAM,+BAA+B,CAAC"}

package/dist/hooks/index.js

@@ -1,4 +0,0 @@
-export { useContentLoader } from "./use-content-loader.js";
-export { useContentCommands } from "./use-content-commands.js";
-export { createViewCommandContext, useProvideViewCommandContext, } from "./use-view-command-context.js";
-//# sourceMappingURL=index.js.map

package/dist/hooks/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,+BAA+B,CAAC"}

package/src/hooks/index.ts

@@ -1,11 +0,0 @@
-export { useContentLoader } from "./use-content-loader.js";
-export { useContentCommands } from "./use-content-commands.js";
-export {
-  createViewCommandContext,
-  useProvideViewCommandContext,
-} from "./use-view-command-context.js";
-export type {
-  CreateViewCommandContextOptions,
-  ProvideViewCommandContextOptions,
-  ViewCommandContext,
-} from "./use-view-command-context.js";