@smartmemory/wiki-components 0.3.0 → 0.4.0

package/README.md

@@ -26,7 +26,7 @@ npm install @smartmemory/wiki-components react react-dom date-fns lucide-react
 
 ## Contract
 
-`src/data-client.d.ts` is the contract: six calls (`identity`, `featureHub`, `decisions`, `decisionsPage`, `sourcesPage`, `search`), the endpoint and
+`src/data-client.d.ts` is the contract: seven calls (`identity`, `featureHub`, `decisions`, `decisionsPage`, `sourcesPage`, `docsByArea`, `search`), the endpoint and
 request body each maps to on the wiki API, and the result types (from `wiki/contracts/query.schema.json`). The same list is
 runtime data in `DATA_CLIENT_CALLS`; `ui/test/wiki-components.test.jsx` pins the typed file, the table and the app's client
 to each other. `<WikiDataProvider>` refuses a client missing a method.
@@ -34,15 +34,16 @@ to each other. `<WikiDataProvider>` refuses a client missing a method.
 ## Use
 
 ```jsx
-import { WikiDataProvider, FeatureHub, Search, Decisions, Sources, wikiPath } from "@smartmemory/wiki-components";
+import { WikiDataProvider, FeatureHub, Search, Decisions, Sources, AreaDocs, wikiPath } from "@smartmemory/wiki-components";
 
 <WikiDataProvider client={myClient}>
   <FeatureHub featureId="CORE-1" workspace="wiki-eng" />
   <Search query="recall" workspaces={["wiki-eng", "wiki-gtm"]}
-    onNavigate={(target) => /* {kind: "search", query?, workspace?} | {kind: "note", workspace, docId} */ go(target)}
+    onNavigate={(target) => /* {kind: "search", query?, workspace?} | {kind: "note", workspace, docId} | {kind: "area", area} */ go(target)}
     hrefFor={(target) => `http://127.0.0.1:8791/ui${wikiPath(target)}`} />
   <Decisions workspace="wiki-eng" />
   <Sources workspace="wiki-eng" />
+  <AreaDocs area="search" workspace="wiki-eng" onNavigate={go} hrefFor={href} />
 </WikiDataProvider>
 ```
 
@@ -56,6 +57,10 @@ import { WikiDataProvider, FeatureHub, Search, Decisions, Sources, wikiPath } fr
   `client.sourcesPage({workspace, cursor?, size?})` (`POST /query/sources`, `filters: {}`, `page: {size, cursor?}`), which
   resolves `{items, total, next_cursor, generated_at}` with `SourceItem` rows. Also exported: `FreshnessBadge`,
   `OverdueBadge`, `useNow`, `ago`, `fmtDuration`.
+- `AreaDocs` is the paged list of the docs filed under one area (`area` prop, required), 50 a page. Its data is
+  `client.docsByArea({workspace, area, cursor?, size?})` (`POST /query/docs_by_area`, `filters: {area}`, `page: {size, cursor?}`),
+  which resolves `{items, total, next_cursor, generated_at}` with `DocItem` rows. With `onNavigate` or `hrefFor`, each doc
+  lists its areas as links, the new NavTarget `{kind: "area", area}` (`wikiPath` gives `/area/<area>`; `areaUrl` is exported).
 - `workspace` / `workspaces` are optional: without them a screen calls `client.identity()` and uses the caller's grants
   (FeatureHub the first one).
 - `onNavigate(target)` receives a plain left click on a link and the search box's submit. `hrefFor(target)` is each link's

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartmemory/wiki-components",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "The wiki's feature hub and search screens as router-free React components fed by an injected DataClient (WIKI-UI-COMPONENTS-1). Ships JSX source for a bundler host (Vite).",
   "license": "BUSL-1.1",
   "author": "Regression Analytics LLC",

package/src/AreaDocs.jsx

@@ -0,0 +1,26 @@
+import React from "react";
+import { useDataClient, useWorkspaces } from "./data-client";
+import { usePagedCall } from "./paged";
+import ListPage from "./parts/ListPage";
+import PageHeader from "./parts/PageHeader";
+import DocRow from "./parts/DocRow";
+import Loading from "./parts/Loading";
+import Pager from "./parts/Pager";
+import ErrorBox from "./parts/ErrorBox";
+
+/** The docs filed under one area: `area` of `workspace` (default: the first of identity().workspaces), 50 a page with a
+ *  pager. Each doc lists its areas as links: `onNavigate({kind: "area", area})` follows one, `hrefFor(target)` is its href.
+ *  Data: DataClient docsByArea. */
+export default function AreaDocs({ area, workspace: given, onNavigate, hrefFor }) {
+  const client = useDataClient();
+  const ws = useWorkspaces(given ? [given] : undefined);
+  const workspace = given || ws.workspaces?.[0];
+  const p = usePagedCall(["docs_by_area", workspace, area], (page) => client.docsByArea({ workspace, area, ...page }), { enabled: !!workspace && !!area });
+  const error = p.error || ws.error;
+  return (
+    <ListPage header={<PageHeader eyebrow="Area" title={area}>{p.total != null && `${p.total} docs`}</PageHeader>} foot={<Pager p={p} />}>
+      <ErrorBox error={error} />
+      {p.isLoading || ws.isLoading ? <Loading /> : !error && p.items.length === 0 ? <p className="text-sm text-neutral-400">No docs in this area yet.</p> : p.items.map((d) => <DocRow key={d.doc_id} doc={d} onNavigate={onNavigate} hrefFor={hrefFor} />)}
+    </ListPage>
+  );
+}

package/src/data-client.d.ts

@@ -1,4 +1,4 @@
-// WIKI-UI-COMPONENTS-1: the DataClient contract. Every call the FeatureHub, Search, Decisions and Sources screens make, and nothing else.
+// WIKI-UI-COMPONENTS-1: the DataClient contract. Every call the FeatureHub, Search, Decisions, Sources and AreaDocs screens make, and nothing else.
 // A host (the wiki's /ui/ app, Compose's wiki tab) passes one object with these async methods to <WikiDataProvider>.
 // The components never fetch: each call below is the whole of their I/O.
 //
@@ -11,6 +11,7 @@
 //   decisions    POST /query/decisions        {query: "decisions",   workspace, filters: {feature_id}, page: {size: 50}}
 //   decisionsPage POST /query/decisions       {query: "decisions",   workspace, filters: {},           page: {size: 50, cursor?}}
 //   sourcesPage  POST /query/sources          {query: "sources",     workspace, filters: {},           page: {size: 50, cursor?}}
+//   docsByArea   POST /query/docs_by_area     {query: "docs_by_area", workspace, filters: {area}, page: {size: 50, cursor?}}
 //   search       POST /query/search           {query: "search",      workspace, filters: {q},          page: {}}
 //
 // The same table is runtime data in data-client.jsx (DATA_CLIENT_CALLS); a test pins the two to each other.
@@ -128,6 +129,9 @@ export interface DataClient {
   /** POST /query/sources, filters {}, page {size (default 50), cursor?}: one page of the workspace's ingestion sources.
    *  `cursor` is the previous page's `next_cursor`, opaque. */
   sourcesPage(args: { workspace: Workspace; cursor?: string; size?: number }): Promise<QueryResult<SourceItem>>;
+  /** POST /query/docs_by_area, filters {area} (required, 1 to 200 characters), page {size (default 50), cursor?}: one page of the live docs
+   *  filed under `area`. `cursor` is the previous page's `next_cursor`, opaque. */
+  docsByArea(args: { workspace: Workspace; area: string; cursor?: string; size?: number }): Promise<QueryResult<DocItem>>;
   /** POST /query/search, filters {q} (1 to 256 characters), page {}. One call per workspace searched. */
   search(args: { workspace: Workspace; q: string }): Promise<SearchResult>;
 }
@@ -136,4 +140,5 @@ export interface DataClient {
  *  (the /ui/ app: wikiPath()). */
 export type NavTarget =
   | { kind: "search"; query?: string; workspace?: Workspace }
-  | { kind: "note"; workspace: Workspace; docId: string };
+  | { kind: "note"; workspace: Workspace; docId: string }
+  | { kind: "area"; area: string };

package/src/data-client.jsx

@@ -8,6 +8,7 @@ export const DATA_CLIENT_CALLS = [
   { method: "decisions", endpoint: "POST /query/decisions", query: "decisions", page: { size: 50 } },
   { method: "decisionsPage", endpoint: "POST /query/decisions", query: "decisions", page: { size: 50 } },
   { method: "sourcesPage", endpoint: "POST /query/sources", query: "sources", page: { size: 50 } },
+  { method: "docsByArea", endpoint: "POST /query/docs_by_area", query: "docs_by_area", page: { size: 50 } },
   { method: "search", endpoint: "POST /query/search", query: "search", page: {} },
 ];
 

package/src/index.d.ts

@@ -28,6 +28,9 @@ export function Decisions(props: { workspace?: Workspace | null } & NavProps): R
 /** Every ingestion source of `workspace` (default: the first of identity().workspaces), 50 a page with a pager. */
 export function Sources(props: { workspace?: Workspace | null } & NavProps): ReactElement;
 
+/** The docs filed under `area` of `workspace` (default: the first of identity().workspaces), 50 a page with a pager. Each doc's other areas link to their own AreaDocs through `onNavigate({kind: "area", area})`. */
+export function AreaDocs(props: { area: string; workspace?: Workspace | null } & NavProps): ReactElement;
+
 /** One DataClient call paged by cursor. `run({cursor?, size})` fetches a page; a new `key` restarts at page one. */
 export function usePagedCall<T>(
   key: unknown,
@@ -46,3 +49,5 @@ export function Pager(props: { p: { total?: number; index: number; size: number;
 /** A NavTarget as a path of the wiki's /ui/ app (relative to its basename, e.g. "/search?q=x"). */
 export function wikiPath(target: NavTarget): string;
 export function wsName(workspace: Workspace): string;
+/** The path of an area's docs page in the wiki's /ui/ app. */
+export function areaUrl(area: string): string;

package/src/index.js

@@ -4,9 +4,10 @@ export { default as FeatureHub, prefixOnly } from "./FeatureHub";
 export { default as Search } from "./Search";
 export { default as Decisions } from "./Decisions";
 export { default as Sources } from "./Sources";
+export { default as AreaDocs } from "./AreaDocs";
 export { usePagedCall } from "./paged";
 export { WikiDataProvider, useDataClient, useClientCall, DATA_CLIENT_CALLS } from "./data-client";
-export { wikiPath, wsName, wsUrl, noteUrl, toDate, fmtDate, ago, fmtDuration, summaryOf } from "./lib";
+export { wikiPath, wsName, wsUrl, noteUrl, areaUrl, toDate, fmtDate, ago, fmtDuration, summaryOf } from "./lib";
 export { default as useNow } from "./useNow";
 // The parts the screens are built from; the /ui/ app's other pages use them too (ui/src/components/wiki/* re-export them).
 export { default as ErrorBox } from "./parts/ErrorBox";

package/src/lib.js

@@ -10,6 +10,7 @@ export const wsName = (ws) => {
   return WS_NAMES[tail] || tail.split(/[-_]+/).filter(Boolean).map((w) => w[0].toUpperCase() + w.slice(1)).join(" ") || "Workspace";
 };
 export const wsUrl = (ws) => `/w/${encodeURIComponent(ws)}`;
+export const areaUrl = (a) => `/area/${encodeURIComponent(a)}`;
 export const noteUrl = (ws, id) => `${wsUrl(ws)}/note?id=${encodeURIComponent(id)}`;
 
 export const toDate = (d) => (d ? new Date(d.length <= 10 || /([zZ]|[+-]\d\d:?\d\d)$/.test(d) ? d : d + "Z") : null);
@@ -33,6 +34,7 @@ export const summaryOf = (feature) => (typeof feature?.summary === "string" && f
 /** A NavTarget (data-client.d.ts) as a route of the wiki's own /ui/ app, relative to its basename. */
 export function wikiPath(target) {
   if (target.kind === "note") return noteUrl(target.workspace, target.docId);
+  if (target.kind === "area") return areaUrl(target.area);
   if (target.kind === "search") {
     const p = new URLSearchParams({ ...(target.query ? { q: target.query } : {}), ...(target.workspace ? { workspace: target.workspace } : {}) });
     return `/search?${p}`;

package/src/parts/DocRow.jsx

@@ -1,9 +1,13 @@
 import React from "react";
 import TypeBadge from "./TypeBadge";
+import NavLink from "./NavLink";
 import { fmtDate } from "../lib";
 
-export default function DocRow({ doc, right }) {
-  return (
+/** One doc. With `onNavigate` or `hrefFor` (a screen that links, e.g. AreaDocs) the doc's areas are listed under the row,
+ *  each a NavTarget {kind: "area"}; without them the row is exactly as before. */
+export default function DocRow({ doc, right, onNavigate, hrefFor }) {
+  const links = (onNavigate || hrefFor) && doc.areas?.length > 0;
+  const row = (
     <div className="grid items-center gap-3 rounded-md px-3 py-2 hover:bg-neutral-50 grid-cols-[6.5rem_1fr_auto] sm:grid-cols-[6.5rem_1fr_16rem_6.5rem]">
       <TypeBadge type={doc.kind} />
       <span className="truncate font-medium text-neutral-900">{doc.title}</span>
@@ -12,4 +16,15 @@ export default function DocRow({ doc, right }) {
       {right}
     </div>
   );
+  if (!links) return row;
+  return (
+    <div>
+      {row}
+      <div className="flex flex-wrap gap-1.5 px-3 pb-2 pl-[7.75rem]" data-testid="area-links">
+        {doc.areas.map((a) => (
+          <NavLink key={a} target={{ kind: "area", area: a }} hrefFor={hrefFor} onNavigate={onNavigate} className="rounded-full border border-neutral-200 px-2 py-0.5 text-[11px] text-neutral-600 hover:border-blue-500 hover:text-neutral-900">{a}</NavLink>
+        ))}
+      </div>
+    </div>
+  );
 }