Skip to content

The OSINT investigator's workbench. One case, one folder, every tool. Local-first: your media and your investigations never leave your machine.

JavaScript
4.5 KB
Raw Blame
/**
 * Workspace model (docs/UI.md §3): the rail holds a fixed set of activity
 * workspaces in investigation-pipeline order; tools are tabs inside them.
 * `uiState.tool` stays the single source of truth everywhere — the active
 * workspace is always derived from the active tool, so cross-tool handoffs
 * (`uiState.tool = 'proof'`) keep working untouched.
 *
 * Future tools land as new entries in a workspace's `tools` array rather than as
 * new rail entries.
 *
 * `case` is a workspace like any other — tabs, deep links, its own remembered
 * sidebar — and sits on the rail under the four stages, a rule apart from them:
 * the case is not a stage but what every stage files into, and a door into it
 * from the topbar was one nobody took.
 *
 * The Timeline is its first tab, so `#case` and a first visit land where events are
 * noted and read; the Board, the index of who and what, is the next one. `#board`
 * is still a tab of its own, and the tool id stays `board` in every stored view.
 */
import { splitHash } from './hash.js';

export const CASE_WORKSPACE = {
  id: 'case',
  label: 'Case',
  icon: 'graph',
  tools: ['timeline', 'board', 'graph', 'sheet'],
};

/**
 * Where the app opens, and the same argument decides where it sits: the rail is a
 * sequence of stages and home is not one of them, so it hangs off the wordmark in
 * the topbar rather than taking a fifth rail seat. Every app puts home on its own
 * mark, which is the one affordance that needs no label.
 *
 * Two tabs. *Overview* answers "what is this case waiting on" for somebody who has
 * been here before; *Guide* answers "what is this app" for somebody who has not. A
 * fresh install has no case to summarise, so the overview's empty state is the front
 * door and the guide is one click from it.
 */
export const HOME_WORKSPACE = {
  id: 'home',
  label: 'Home',
  icon: 'compass',
  tools: ['overview'],
};

/** The rail, in investigation order. */
export const WORKSPACES = [
  { id: 'collect', label: 'Sources', icon: 'download', tools: ['media', 'files', 'reverse'] },
  { id: 'examine', label: 'Examine', icon: 'inspect', tools: ['inspect', 'collage'] },
  { id: 'map', label: 'Map', icon: 'satellite', tools: ['satellite', 'compare', 'detect', 'horizon', 'coordinates'] },
  { id: 'compose', label: 'Compose', icon: 'proof', tools: ['proof', 'post', 'plate', 'notebook'] },
];

/** Every workspace, on the rail or not — what tool lookup and deep links resolve against. */
export const ALL_WORKSPACES = [HOME_WORKSPACE, CASE_WORKSPACE, ...WORKSPACES];

export const TOOL_LABELS = {
  overview: 'Overview',
  board: 'Board',
  graph: 'Graph',
  timeline: 'Timeline',
  sheet: 'Sheet',
  media: 'Media',
  files: 'Files',
  reverse: 'Reverse Search',
  inspect: 'Inspect',
  collage: 'Collage',
  satellite: 'Satellite',
  compare: 'Compare',
  detect: 'Detect',
  horizon: 'Horizon',
  coordinates: 'Coords & Sky',
  proof: 'Geo Proof',
  post: 'Geo Report',
  plate: 'Map plate',
  notebook: 'Notebook',
  settings: 'Settings',
};

export function workspaceOf(tool) {
  return ALL_WORKSPACES.find((w) => w.tools.includes(tool)) ?? null;
}

/** Return the session's sidebar state for a workspace, falling back to defaults.
 *
 *  Closed on `map`, which needs the width; on `case`, where the board already lists
 *  the same entities — two lists of one case side by side is a question about which
 *  one is the real one — and on `home`, which is read rather than worked in and whose
 *  whole subject is the case the sidebar would be listing again. */
const SIDEBAR_CLOSED = new Set(['map', 'case', 'home']);

export function sidebarOpenForWorkspace(workspaceId, remembered = {}) {
  if (remembered[workspaceId] !== undefined) return remembered[workspaceId];
  return !SIDEBAR_CLOSED.has(workspaceId);
}

/**
 * Resolve a location hash to a tool id, or null if it matches nothing.
 * Accepted forms, in priority order:
 *   '#<tool>'            — stable pre-workspace links (#media, #proof, …)
 *   '#<workspace>/<tool>' — a specific tab (#compose/post)
 *   '#<workspace>'       — the workspace's first tool (#compose → proof)
 * Any of them may carry the tool's own state as a query (`#satellite?ll=…`).
 */
export function toolFromHash(hash, allTools) {
  // A tool may keep its own state after the route (`#satellite?ll=…`, see
  // lib/hash.js); the route is all that names a tool.
  const [head, sub] = splitHash(hash).route.split('/');
  if (allTools.includes(head)) return head;
  const ws = ALL_WORKSPACES.find((w) => w.id === head);
  if (!ws) return null;
  return sub && ws.tools.includes(sub) ? sub : ws.tools[0];
}