cursedbelt-core 2.4.0 → 2.6.0

package/dist/core/file-tree/fileTreeModel.d.ts

@@ -35,6 +35,21 @@ export interface FileTreeNode {
     /** Stable across re-derivation — it is the React key, the selection value and the drag id. */
     id: string;
     name: string;
+    /**
+     * Drawn right after the name, a step quieter — a file's extension, `.md`.
+     *
+     * For a consumer whose extension is DERIVED rather than part of the stored name
+     * (`apps/desk` works a note's suffix out from its format): *"show the extensions in the
+     * file tree like vscode does. I need to be able to tell what type each file is"*. Quieter
+     * because the name is what you scan FOR and the suffix is what you scan BY.
+     *
+     * 🔴 It is part of the name everywhere a person types one: {@link matchTypeahead} and
+     * {@link filterFileTree} match `name + suffix`, because what is drawn and what can be
+     * typed are the same string or they are a bug (*"I typed .json but it said 'Nothing is
+     * called that'"*). A rename opens on `name + suffix` with only the name selected — VS
+     * Code's field — and hands back whatever was typed, suffix and all.
+     */
+    suffix?: string;
     kind: FileTreeNodeKind;
     /** Folders only. A folder with `[]` is empty; a file's is ignored. */
     children?: readonly FileTreeNode[];
@@ -86,10 +101,12 @@ export interface FileTreeNode {
      * container of its own — a drop on the middle half of its row is `{ kind: 'into',
      * parentId: <the file> }`. `apps/desk` is why: a workbook is a leaf in its tree, and
      * dropping a sheet onto one makes the sheet one of its tabs (the owner, desk file `02`).
-     * The edges of the row, and the middle whenever {@link ResolveDropOptions.canDrop} vetoes
-     * the file, still mean *the folder the file is in* — so a column of such files is never a
-     * wall of rows that refuse everything that cannot go inside them. Absent or `false`, a
-     * file row means its folder along its whole height, exactly as before.
+     * The edges of the row still mean *the folder the file is in*, and so does the middle for
+     * any drag {@link ResolveDropOptions.takesDrop} says is not a candidate — so a column of
+     * such files is never a wall of rows that refuse everything that cannot go inside them.
+     * A candidate that {@link ResolveDropOptions.canDrop} vetoes is REFUSED with its words:
+     * the file was the target, and why it cannot take this one has a remedy worth saying.
+     * Absent or `false`, a file row means its folder along its whole height, as before.
      */
     acceptsDrop?: boolean;
     /**
@@ -218,6 +235,17 @@ export interface ResolveDropOptions {
      * this tree is that an impossible drop is never drawn as possible.
      */
     canDrop?: (dragId: string | null, target: FileTreeDrop) => string | null;
+    /**
+     * Whether a file that accepts drops (`acceptsDrop: true` on a FILE) is a candidate for
+     * THIS drag at all. Default: every drag is.
+     *
+     * 🔴 This is the question {@link canDrop} cannot answer, because its `null` means "allow":
+     * `apps/desk` takes a SHEET into a workbook and never a note, so a note over a workbook
+     * must mean the workbook's folder — not a refusal, and not a merge. `false` here is that:
+     * the row goes back to meaning its folder. `true` makes the file the target, and then
+     * `canDrop` decides, in words — *"“Beta” has 2 sheets"* is a refusal with a remedy.
+     */
+    takesDrop?: (dragId: string | null, file: FileTreeNode) => boolean;
 }
 /**
  * Where the pointer currently is, as a decision.
@@ -226,7 +254,7 @@ export interface ResolveDropOptions {
  * offered.** Every refusal below returns a reason rather than a null target, so the cursor
  * and the chip can say no while the row is still in the air.
  */
-export declare function resolveDrop({ nodes, row, offsetRatio, dragId, allowReorder, lockedReason, canDrop, }: ResolveDropOptions): DropOffer;
+export declare function resolveDrop({ nodes, row, offsetRatio, dragId, allowReorder, lockedReason, canDrop, takesDrop, }: ResolveDropOptions): DropOffer;
 export interface KeyboardMoveOptions {
     nodes: readonly FileTreeNode[];
     /** The rows on screen — siblings are read off these, which is every sibling by construction. */
@@ -300,6 +328,8 @@ export declare function accessMarkCopy(access: FileTreeAccess | undefined, copy?
  * Typeahead is what makes a long tree usable without a search box — `bud` jumps to
  * `budget-2026` — and wrapping is what stops it dying at the bottom of the list.
  */
+/** The name as the row draws it — with its {@link FileTreeNode.suffix}. */
+export declare function drawnName(node: FileTreeNode): string;
 export declare function matchTypeahead(rows: readonly FileTreeRow[], query: string, fromIndex: number): number;
 /**
  * The tree narrowed to what matches, with the folders on the way to a match kept.

package/dist/core/file-tree/fileTreeModel.js

@@ -125,7 +125,7 @@ export const INTO_ZONE = 0.5;
  * offered.** Every refusal below returns a reason rather than a null target, so the cursor
  * and the chip can say no while the row is still in the air.
  */
-export function resolveDrop({ nodes, row, offsetRatio, dragId, allowReorder = false, lockedReason = 'That folder is locked', canDrop, }) {
+export function resolveDrop({ nodes, row, offsetRatio, dragId, allowReorder = false, lockedReason = 'That folder is locked', canDrop, takesDrop, }) {
     // Blank space under the last row: out of every folder. The one gesture that needs no
     // target, and the only way to say "top level" when the top level has no row of its own.
     if (!row)
@@ -156,15 +156,17 @@ export function resolveDrop({ nodes, row, offsetRatio, dragId, allowReorder = fa
             return { target: null, refused: true, reason: lockedReason };
         return vetted({ target: { kind: 'into', parentId: target.id }, refused: false, reason: null });
     };
-    // A FILE the consumer opted in as a container takes the drop on the middle of its row —
-    // see `FileTreeNode.acceptsDrop`. Vetoed, it falls through to meaning its folder below.
-    if (target.kind === 'file' && !allowReorder && target.acceptsDrop === true && target.id !== dragId) {
+    // A FILE the consumer opted in as a container takes a CANDIDATE drag on the middle of its
+    // row, vetted with words — see `FileTreeNode.acceptsDrop` and `takesDrop`. Anything else
+    // falls through to meaning its folder below.
+    if (target.kind === 'file' &&
+        !allowReorder &&
+        target.acceptsDrop === true &&
+        target.id !== dragId &&
+        (takesDrop?.(dragId, target) ?? true)) {
         const band = (1 - INTO_ZONE) / 2;
-        if (offsetRatio > band && offsetRatio < 1 - band) {
-            const into = vetted({ target: { kind: 'into', parentId: target.id }, refused: false, reason: null });
-            if (into.target)
-                return into;
-        }
+        if (offsetRatio > band && offsetRatio < 1 - band)
+            return vetted({ target: { kind: 'into', parentId: target.id }, refused: false, reason: null });
     }
     // A FILE row means "the folder that row is in" — what every file explorer does, and what
     // keeps a long list of files from being a wall of rows nothing can be dropped on.
@@ -308,6 +310,10 @@ export function accessMarkCopy(access, copy) {
  * Typeahead is what makes a long tree usable without a search box — `bud` jumps to
  * `budget-2026` — and wrapping is what stops it dying at the bottom of the list.
  */
+/** The name as the row draws it — with its {@link FileTreeNode.suffix}. */
+export function drawnName(node) {
+    return node.suffix ? `${node.name}${node.suffix}` : node.name;
+}
 export function matchTypeahead(rows, query, fromIndex) {
     if (!query)
         return -1;
@@ -315,7 +321,7 @@ export function matchTypeahead(rows, query, fromIndex) {
     for (let step = 1; step <= rows.length; step += 1) {
         const index = (fromIndex + step + rows.length) % rows.length;
         const row = rows[index];
-        if (row?.node.name.toLowerCase().startsWith(needle))
+        if (row && drawnName(row.node).toLowerCase().startsWith(needle))
             return index;
     }
     return -1;
@@ -332,7 +338,7 @@ export function filterFileTree(nodes, query) {
     if (!needle)
         return nodes;
     const keep = (node) => {
-        const hit = node.name.toLowerCase().includes(needle);
+        const hit = drawnName(node).toLowerCase().includes(needle);
         if (hit)
             return node;
         const kids = childrenOf(node)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "cursedbelt-core",
-	"version": "2.4.0",
+	"version": "2.6.0",
 	"license": "ISC",
 	"type": "module",
 	"description": "Framework-agnostic core of the cursedbelt split — isomorphic domain logic. cwip below it, cursedbelt-server and cursedbelt (react) above it.",

package/src/core/file-tree/fileTreeModel.spec.ts

@@ -13,6 +13,7 @@ import {
   resolveDrop,
   resolveKeyboardMove,
   describeDrop,
+  drawnName,
 } from './fileTreeModel.js';
 
 /**
@@ -245,8 +246,14 @@ describe('resolveDrop onto a file that accepts drops', () => {
     { id: 'loose', name: 'loose.csv', kind: 'file' },
   ];
   const rows = flattenFileTree(nodes, []);
-  const on = (id: string, dragId: string, offsetRatio: number, canDrop?: (d: string | null, t: FileTreeDrop) => string | null) =>
-    resolveDrop({ nodes, row: rowFor(rows, id), offsetRatio, dragId, ...(canDrop ? { canDrop } : {}) });
+  const on = (
+    id: string,
+    dragId: string,
+    offsetRatio: number,
+    canDrop?: (d: string | null, t: FileTreeDrop) => string | null,
+    takesDrop?: (d: string | null, file: FileTreeNode) => boolean,
+  ) =>
+    resolveDrop({ nodes, row: rowFor(rows, id), offsetRatio, dragId, ...(canDrop ? { canDrop } : {}), ...(takesDrop ? { takesDrop } : {}) });
 
   test('the middle of its row is INTO the file', () => {
     expect(on('q3', 'loose', 0.5).target).toEqual({ kind: 'into', parentId: 'q3' });
@@ -257,11 +264,22 @@ describe('resolveDrop onto a file that accepts drops', () => {
     expect(on('q3', 'loose', 0.9).target).toEqual({ kind: 'into', parentId: 'work' });
   });
 
-  test('🔴 a veto on the file falls back to its folder rather than refusing the row', () => {
-    const onlySheets = (dragId: string | null, target: FileTreeDrop) =>
-      target.kind === 'into' && target.parentId === 'q3' && dragId !== 'loose' ? 'Only a sheet can become a tab' : null;
-    expect(on('q3', 'report', 0.5, onlySheets).target).toEqual({ kind: 'into', parentId: 'work' });
-    expect(on('q3', 'loose', 0.5, onlySheets).target).toEqual({ kind: 'into', parentId: 'q3' });
+  test('🔴 a drag that is not a candidate means the folder — not a refusal, not the file', () => {
+    // desk: a note over a workbook files it beside the workbook.
+    const onlySheets = (dragId: string | null) => dragId === 'loose';
+    expect(on('q3', 'report', 0.5, undefined, onlySheets).target).toEqual({ kind: 'into', parentId: 'work' });
+    expect(on('q3', 'loose', 0.5, undefined, onlySheets).target).toEqual({ kind: 'into', parentId: 'q3' });
+  });
+
+  test('🔴 a candidate the consumer vetoes is REFUSED, in its words — the file was the target', () => {
+    const full = (_dragId: string | null, target: FileTreeDrop) =>
+      target.kind === 'into' && target.parentId === 'q3' ? '“loose” has 2 sheets' : null;
+    const offer = on('q3', 'loose', 0.5, full);
+    expect(offer.target).toBeNull();
+    expect(offer.refused).toBe(true);
+    expect(offer.reason).toBe('“loose” has 2 sheets');
+    // …and the edges still file it beside the workbook.
+    expect(on('q3', 'loose', 0.1, full).target).toEqual({ kind: 'into', parentId: 'work' });
   });
 
   test('a file never takes itself', () => {
@@ -526,3 +544,25 @@ describe('accessMarkCopy', () => {
     expect(accessMarkCopy(undefined)).toBe('');
   });
 });
+
+/** `suffix` — a derived extension, drawn and matched as part of the name. */
+describe('a suffix is part of the name a person types', () => {
+  const notes: FileTreeNode = { id: 'n', name: 'notes', suffix: '.md', kind: 'file' };
+  const nodes: FileTreeNode[] = [folder('docs', 'Docs', [notes]), { id: 'b', name: 'budget', kind: 'file' }];
+
+  test('drawnName carries it, and a node without one is its name', () => {
+    expect(drawnName(notes)).toBe('notes.md');
+    expect(drawnName({ id: 'b', name: 'budget', kind: 'file' })).toBe('budget');
+  });
+
+  test('typeahead matches through the dot', () => {
+    const rows = flattenFileTree(nodes, []);
+    expect(matchTypeahead(rows, 'notes.m', 0)).toBe(rows.findIndex((row) => row.node.id === 'n'));
+  });
+
+  test('a filter for the extension finds the file', () => {
+    const kept = filterFileTree(nodes, '.md');
+    expect(kept.map((node) => node.id)).toEqual(['docs']);
+    expect((kept[0]?.children ?? []).map((node) => node.id)).toEqual(['n']);
+  });
+});

package/src/core/file-tree/fileTreeModel.ts

@@ -38,6 +38,21 @@ export interface FileTreeNode {
   /** Stable across re-derivation — it is the React key, the selection value and the drag id. */
   id: string;
   name: string;
+  /**
+   * Drawn right after the name, a step quieter — a file's extension, `.md`.
+   *
+   * For a consumer whose extension is DERIVED rather than part of the stored name
+   * (`apps/desk` works a note's suffix out from its format): *"show the extensions in the
+   * file tree like vscode does. I need to be able to tell what type each file is"*. Quieter
+   * because the name is what you scan FOR and the suffix is what you scan BY.
+   *
+   * 🔴 It is part of the name everywhere a person types one: {@link matchTypeahead} and
+   * {@link filterFileTree} match `name + suffix`, because what is drawn and what can be
+   * typed are the same string or they are a bug (*"I typed .json but it said 'Nothing is
+   * called that'"*). A rename opens on `name + suffix` with only the name selected — VS
+   * Code's field — and hands back whatever was typed, suffix and all.
+   */
+  suffix?: string;
   kind: FileTreeNodeKind;
   /** Folders only. A folder with `[]` is empty; a file's is ignored. */
   children?: readonly FileTreeNode[];
@@ -89,10 +104,12 @@ export interface FileTreeNode {
    * container of its own — a drop on the middle half of its row is `{ kind: 'into',
    * parentId: <the file> }`. `apps/desk` is why: a workbook is a leaf in its tree, and
    * dropping a sheet onto one makes the sheet one of its tabs (the owner, desk file `02`).
-   * The edges of the row, and the middle whenever {@link ResolveDropOptions.canDrop} vetoes
-   * the file, still mean *the folder the file is in* — so a column of such files is never a
-   * wall of rows that refuse everything that cannot go inside them. Absent or `false`, a
-   * file row means its folder along its whole height, exactly as before.
+   * The edges of the row still mean *the folder the file is in*, and so does the middle for
+   * any drag {@link ResolveDropOptions.takesDrop} says is not a candidate — so a column of
+   * such files is never a wall of rows that refuse everything that cannot go inside them.
+   * A candidate that {@link ResolveDropOptions.canDrop} vetoes is REFUSED with its words:
+   * the file was the target, and why it cannot take this one has a remedy worth saying.
+   * Absent or `false`, a file row means its folder along its whole height, as before.
    */
   acceptsDrop?: boolean;
   /**
@@ -296,6 +313,17 @@ export interface ResolveDropOptions {
    * this tree is that an impossible drop is never drawn as possible.
    */
   canDrop?: (dragId: string | null, target: FileTreeDrop) => string | null;
+  /**
+   * Whether a file that accepts drops (`acceptsDrop: true` on a FILE) is a candidate for
+   * THIS drag at all. Default: every drag is.
+   *
+   * 🔴 This is the question {@link canDrop} cannot answer, because its `null` means "allow":
+   * `apps/desk` takes a SHEET into a workbook and never a note, so a note over a workbook
+   * must mean the workbook's folder — not a refusal, and not a merge. `false` here is that:
+   * the row goes back to meaning its folder. `true` makes the file the target, and then
+   * `canDrop` decides, in words — *"“Beta” has 2 sheets"* is a refusal with a remedy.
+   */
+  takesDrop?: (dragId: string | null, file: FileTreeNode) => boolean;
 }
 
 /**
@@ -313,6 +341,7 @@ export function resolveDrop({
   allowReorder = false,
   lockedReason = 'That folder is locked',
   canDrop,
+  takesDrop,
 }: ResolveDropOptions): DropOffer {
   // Blank space under the last row: out of every folder. The one gesture that needs no
   // target, and the only way to say "top level" when the top level has no row of its own.
@@ -347,14 +376,19 @@ export function resolveDrop({
     return vetted({ target: { kind: 'into', parentId: target.id }, refused: false, reason: null });
   };
 
-  // A FILE the consumer opted in as a container takes the drop on the middle of its row —
-  // see `FileTreeNode.acceptsDrop`. Vetoed, it falls through to meaning its folder below.
-  if (target.kind === 'file' && !allowReorder && target.acceptsDrop === true && target.id !== dragId) {
+  // A FILE the consumer opted in as a container takes a CANDIDATE drag on the middle of its
+  // row, vetted with words — see `FileTreeNode.acceptsDrop` and `takesDrop`. Anything else
+  // falls through to meaning its folder below.
+  if (
+    target.kind === 'file' &&
+    !allowReorder &&
+    target.acceptsDrop === true &&
+    target.id !== dragId &&
+    (takesDrop?.(dragId, target) ?? true)
+  ) {
     const band = (1 - INTO_ZONE) / 2;
-    if (offsetRatio > band && offsetRatio < 1 - band) {
-      const into = vetted({ target: { kind: 'into', parentId: target.id }, refused: false, reason: null });
-      if (into.target) return into;
-    }
+    if (offsetRatio > band && offsetRatio < 1 - band)
+      return vetted({ target: { kind: 'into', parentId: target.id }, refused: false, reason: null });
   }
 
   // A FILE row means "the folder that row is in" — what every file explorer does, and what
@@ -530,6 +564,11 @@ export function accessMarkCopy(
  * Typeahead is what makes a long tree usable without a search box — `bud` jumps to
  * `budget-2026` — and wrapping is what stops it dying at the bottom of the list.
  */
+/** The name as the row draws it — with its {@link FileTreeNode.suffix}. */
+export function drawnName(node: FileTreeNode): string {
+  return node.suffix ? `${node.name}${node.suffix}` : node.name;
+}
+
 export function matchTypeahead(
   rows: readonly FileTreeRow[],
   query: string,
@@ -540,7 +579,7 @@ export function matchTypeahead(
   for (let step = 1; step <= rows.length; step += 1) {
     const index = (fromIndex + step + rows.length) % rows.length;
     const row = rows[index];
-    if (row?.node.name.toLowerCase().startsWith(needle)) return index;
+    if (row && drawnName(row.node).toLowerCase().startsWith(needle)) return index;
   }
   return -1;
 }
@@ -559,7 +598,7 @@ export function filterFileTree(
   const needle = query.trim().toLowerCase();
   if (!needle) return nodes;
   const keep = (node: FileTreeNode): FileTreeNode | null => {
-    const hit = node.name.toLowerCase().includes(needle);
+    const hit = drawnName(node).toLowerCase().includes(needle);
     if (hit) return node;
     const kids = childrenOf(node)
       .map(keep)