@uniqbit/mate-core 0.17.0-canary.8 → 0.17.1

package/src/cli/commands/studio/selection.ts

@@ -16,21 +16,44 @@ export const COMPANION_PARAM = "companion";
 export const VIEW_PARAM = "view";
 export const REFRESH_PARAM = "refresh";
 export const FILE_PARAM = "path";
+export const DIR_PARAM = "dir";
+
+/** Every URL parameter Studio names; no other module writes one out. */
+export const STUDIO_PARAMS: readonly string[] = [
+  COMPANION_PARAM,
+  VIEW_PARAM,
+  REFRESH_PARAM,
+  FILE_PARAM,
+  DIR_PARAM,
+];
 
 /** Filled into a prompt when no change is named, so a prompt is never half-written. */
 export const CHANGE_PLACEHOLDER = "<change-name>";
 
 const DIGEST_LENGTH = 10;
 
-export interface StudioSelection {
+interface SelectionBase {
   companionDigest: string | null;
-  view: StudioView;
-  /**
-   * One-shot: the refresh control asks for it, and it is never carried forward
-   * into the URL another control builds. Switching a view is not a refresh.
-   */
+  /** One-shot: only the `refresh` move sets it, and every other move clears it. */
   refresh: boolean;
+}
+
+export interface StudioVaultSelection extends SelectionBase {
+  view: "vault";
   openPath: string | null;
+  /** A folder of the listed tree; never looked up on disk. */
+  openDir: string | null;
+}
+
+export interface StudioPlainSelection extends SelectionBase {
+  view: Exclude<StudioView, "vault">;
+}
+
+export type StudioSelection = StudioVaultSelection | StudioPlainSelection;
+
+export interface SelectionField {
+  name: string;
+  value: string;
 }
 
 /**
@@ -60,11 +83,104 @@ function readView(value: string | null): StudioView {
   return STUDIO_VIEWS.includes(value as StudioView) ? (value as StudioView) : "dashboard";
 }
 
-export function parseStudioSelection(url: URL): StudioSelection {
+function readText(value: string | null): string | null {
+  return value?.trim() || null;
+}
+
+/** An empty or malformed digest selects no companion, as an unmatched one already does. */
+function readDigest(value: string | null): string | null {
+  const digest = readText(value);
+  return digest && COMPANION_DIGEST_PATTERN.test(digest) ? digest : null;
+}
+
+function readBase(params: URLSearchParams): SelectionBase {
+  return {
+    companionDigest: readDigest(params.get(COMPANION_PARAM)),
+    refresh: params.get(REFRESH_PARAM) === "1",
+  };
+}
+
+function readVault(params: URLSearchParams): StudioVaultSelection {
+  return {
+    ...readBase(params),
+    view: "vault",
+    openPath: readText(params.get(FILE_PARAM)),
+    openDir: readText(params.get(DIR_PARAM)),
+  };
+}
+
+/** Forgiving: parameters the named view does not have are ignored. */
+export function parse(url: URL): StudioSelection {
+  const view = readView(url.searchParams.get(VIEW_PARAM));
+  if (view === "vault") return readVault(url.searchParams);
+  return { ...readBase(url.searchParams), view };
+}
+
+/** For the `/api/vault/*` routes, which imply the vault view whatever `view` says. */
+export function parseVaultSelection(url: URL): StudioVaultSelection {
+  return readVault(url.searchParams);
+}
+
+/** Drops the vault's target. */
+export function switchView(selection: StudioSelection, view: StudioView): StudioSelection {
+  const base = { companionDigest: selection.companionDigest, refresh: false };
+  if (view === "vault") return { ...base, view, openPath: null, openDir: null };
+  return { ...base, view };
+}
+
+/** Keeps the view and drops the vault's target: it belongs to the companion being left. */
+export function switchCompanion(
+  selection: StudioSelection,
+  digest: string | null,
+): StudioSelection {
+  return { ...switchView(selection, selection.view), companionDigest: digest };
+}
+
+export function openFile(selection: StudioSelection, path: string): StudioVaultSelection {
   return {
-    companionDigest: url.searchParams.get(COMPANION_PARAM)?.trim() || null,
-    view: readView(url.searchParams.get(VIEW_PARAM)),
-    refresh: url.searchParams.get(REFRESH_PARAM) === "1",
-    openPath: url.searchParams.get(FILE_PARAM)?.trim() || null,
+    companionDigest: selection.companionDigest,
+    refresh: false,
+    view: "vault",
+    openPath: path,
+    openDir: null,
   };
 }
+
+/** `null` opens the companion root. */
+export function openFolder(selection: StudioSelection, dir: string | null): StudioVaultSelection {
+  return {
+    companionDigest: selection.companionDigest,
+    refresh: false,
+    view: "vault",
+    openPath: null,
+    openDir: dir,
+  };
+}
+
+export function refresh(selection: StudioSelection): StudioSelection {
+  return { ...selection, refresh: true };
+}
+
+/** Omits defaults (the Dashboard view, an unset target), so URLs stay short. */
+export function toFields(selection: StudioSelection): SelectionField[] {
+  const fields: SelectionField[] = [];
+  if (selection.companionDigest) {
+    fields.push({ name: COMPANION_PARAM, value: selection.companionDigest });
+  }
+  if (selection.view !== "dashboard") fields.push({ name: VIEW_PARAM, value: selection.view });
+  if (selection.view === "vault") {
+    if (selection.openPath) fields.push({ name: FILE_PARAM, value: selection.openPath });
+    if (selection.openDir) fields.push({ name: DIR_PARAM, value: selection.openDir });
+  }
+  if (selection.refresh) fields.push({ name: REFRESH_PARAM, value: "1" });
+  return fields;
+}
+
+export function toSearchParams(selection: StudioSelection): URLSearchParams {
+  return new URLSearchParams(toFields(selection).map(({ name, value }) => [name, value]));
+}
+
+export function toHref(selection: StudioSelection, route = "/"): string {
+  const query = toSearchParams(selection).toString();
+  return query ? `${route}?${query}` : route;
+}