Files
outline/app/hooks/useCollectionTrees.ts
Tom Moor f8496ea2f7 feat: Personal collections (#14062)
* feat: Personal collections backend

Adds an owner to collections. A personal collection is private, one per user
per team, created lazily through collections.personal, and only its owner can
see or manage it. Admin bypasses in policies, lists, exports, events, webhooks
and file operations exclude the personal collections of other users. Turning
off the PersonalDocs preference makes the collection read-only.

* test: Access matrix for personal collections

Checks that collection and document endpoints, list and search results, MCP
tools, collaboration and websocket rooms agree with the read policy for the
owner, collaborators, members, admins, guests and other teams.

* feat: Personal collection in the sidebar

Adds a Personal sidebar section that renders the personal collection with the
collection document tree, creates the collection on the first new document,
and keeps it out of the Collections section. Adds the workspace setting, the
personal sidebar context, and hides collection sharing and membership UI for
personal collections.

* fix: Drag and drop in shared with me trees

Anchors the reorder drop cursor inside the row, and prefetches documents on
hover so that nested rows that were never opened can be dragged.

* feat: Personal collection owner for collaborators, no collection page

Presents the owner of the personal collection on documents, so that
collaborators see the owner in the share popover. Root rows in the Personal
section show the default document icon. A personal collection has no page:
the scene shows not found, and the breadcrumb, command bar and delete redirect
no longer link to it.

* fix: Personal sidebar indent and breadcrumb items without a link

Children of rows at depth 0 skip a level so that they start beyond the row
icon. Breadcrumb items without a destination, such as the personal and deleted
collection, are shown as plain text.

* test: Reduce personal collection tests to list paths

Endpoints that authorize a single model are already covered by the policy
tests. Keeps the lists and searches, which filter in queries, and the
presenter.

* test: Move personal collection list tests into collections tests

* feat: Create documents in the personal collection by alias

documents.create, documents.import and the MCP create_document tool accept
the collectionId "personal", which refers to the personal collection of the
user and creates it when it does not exist yet.

* refactor: Remove collections.personal route

The sidebar creates its first personal document with the personal
collectionId alias, so documents.create is the only path that creates the
personal collection.

* feat: Personal collection name, starring, templates and default

Personal collections cannot be starred, renamed or hold templates, and the
PersonalDocs preference is on by default. The app shows collections through a
displayName getter, which is the translated "Personal" for a personal
collection.

* fix: Use the same policy for starring and unstarring collections

* fix: No pins or viewer insights for personal documents

* revert: Show personal collection events in the audit log

Admins with audit access should see events in personal collections, even when
they cannot open the documents.

* fix: Load collection owner in share scopes

* fix: Keep personal collections out of workspace exports and webhooks

Workspace exports skip all personal collections, while an explicit export of
a personal collection stays available to its owner. Events in personal
collections, including attachments and documents moved after queueing, are
never delivered to workspace webhooks. Personal collections cannot be
renamed or made public through any path, cannot hold pins, and are not
offered as mentions.

* Change icon to avatar

* fix: Personal documents cannot be unpublished

* feat: Personal collection context for MCP

Collections are presented with an isPersonal flag, the server instructions
explain the personal collection, and move_document and update_document accept
the personal collectionId alias.

* fix: Keep moved personal exports private and remove pins on move

Document exports record the owner of the personal collection they came from,
so they stay private after the document moves. Moving documents into a
personal collection removes their pins, including pins to home.

* fix: Only create the personal collection in MCP when it is used
2026-10-13 07:53:06 -04:00

84 lines
2.3 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import type { CollectionSort, NavigationNode } from "@shared/types";
import { NavigationNodeType } from "@shared/types";
import { sortNavigationNodes } from "@shared/utils/collections";
import { useComputed } from "~/hooks/useComputed";
import useStores from "~/hooks/useStores";
import type Collection from "~/models/Collection";
/**
* React hook that returns the document structure of all collections in the
* store as navigation trees. Each node is a copy of the node in the store with
* extra attributes added – type, collectionId, depth, and parent.
*
* @returns the root node of each collection tree.
*/
export default function useCollectionTrees(): NavigationNode[] {
const { collections } = useStores();
return useComputed(
() => collections.orderedData.map(getCollectionTree),
[collections]
);
}
/**
* Builds the navigation tree for a collection.
*
* @param collection The collection to build the tree for.
* @returns the root node of the collection tree.
*/
function getCollectionTree(collection: Collection): NavigationNode {
const root: NavigationNode = {
id: collection.id,
title: collection.displayName,
url: collection.path,
type: NavigationNodeType.Collection,
collectionId: collection.id,
depth: 1,
parent: null,
children: [],
};
root.children = annotateNodes(
collection.documents ?? [],
collection.sort,
root
);
return root;
}
/**
* Copies the given nodes and their descendants in sorted order, adding the
* attributes needed to traverse and render the tree.
*
* @param nodes The nodes to copy.
* @param sort The sort of the collection the nodes belong to.
* @param parent The node that the given nodes are children of.
* @returns the copied nodes.
*/
function annotateNodes(
nodes: NavigationNode[],
sort: CollectionSort,
parent: NavigationNode
): NavigationNode[] {
if (!nodes.length) {
return [];
}
return sortNavigationNodes(nodes, sort, false).map((node) => {
const annotated: NavigationNode = {
...node,
type: node.type ?? NavigationNodeType.Document,
collectionId: parent.collectionId,
depth: (parent.depth ?? 0) + 1,
parent,
children: [],
};
annotated.children = annotateNodes(node.children ?? [], sort, annotated);
return annotated;
});
}