mirror of
https://github.com/outline/outline.git
synced 2026-11-21 21:44:30 +03:00
* 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
253 lines
6.6 KiB
TypeScript
253 lines
6.6 KiB
TypeScript
import invariant from "invariant";
|
|
import { isEmpty, orderBy, sortBy } from "es-toolkit/compat";
|
|
import { action, computed, makeObservable, override, runInAction } from "mobx";
|
|
import type { Filter } from "@shared/helpers/FilterHelper";
|
|
import {
|
|
CollectionPermission,
|
|
type FileOperationFormat,
|
|
SubscriptionType,
|
|
} from "@shared/types";
|
|
import Collection from "~/models/Collection";
|
|
import type { PaginationParams, Properties } from "~/types";
|
|
import { client } from "~/utils/ApiClient";
|
|
import IndexedStore from "./base/IndexedStore";
|
|
import type RootStore from "./RootStore";
|
|
|
|
export default class CollectionsStore extends IndexedStore<Collection> {
|
|
constructor(rootStore: RootStore) {
|
|
super(rootStore, Collection);
|
|
makeObservable(this);
|
|
}
|
|
|
|
/**
|
|
* Returns the currently active collection, or undefined if not in the context of a collection.
|
|
*
|
|
* @returns The active Collection or undefined
|
|
*/
|
|
@computed
|
|
get active(): Collection | undefined {
|
|
return this.rootStore.ui.activeCollectionId
|
|
? this.data.get(this.rootStore.ui.activeCollectionId)
|
|
: undefined;
|
|
}
|
|
|
|
/** Active collections, other than the personal collection. */
|
|
@computed
|
|
get allActive() {
|
|
return this.orderedData.filter((c) => c.isActive && !c.isPersonal);
|
|
}
|
|
|
|
/**
|
|
* Returns the personal collection of the current user, if it was loaded.
|
|
*
|
|
* @returns The personal Collection or undefined
|
|
*/
|
|
@computed
|
|
get personal(): Collection | undefined {
|
|
const userId = this.rootStore.auth.user?.id;
|
|
return userId
|
|
? this.orderedData.find((c) => c.ownerId === userId)
|
|
: undefined;
|
|
}
|
|
|
|
@override
|
|
get orderedData(): Collection[] {
|
|
return super.orderedData.filter((collection) => {
|
|
if (collection.deletedAt) {
|
|
return false;
|
|
}
|
|
|
|
const can = this.rootStore.policies.abilities(collection.id);
|
|
return isEmpty(can) || can.readDocument;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Returns all collections that are require explicit permission to access.
|
|
*/
|
|
@computed
|
|
get private(): Collection[] {
|
|
return this.all.filter((collection) => collection.isPrivate);
|
|
}
|
|
|
|
/**
|
|
* Returns all collections that are accessible by default.
|
|
*/
|
|
@computed
|
|
get nonPrivate(): Collection[] {
|
|
return this.all.filter(
|
|
(collection) => collection.isActive && !collection.isPrivate
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns all collections that are accessible to the current user.
|
|
*/
|
|
@computed
|
|
get all(): Collection[] {
|
|
return sortBy(
|
|
Array.from(this.data.values()),
|
|
(collection) => collection.displayName
|
|
);
|
|
}
|
|
|
|
@action
|
|
import = async (
|
|
attachmentId: string,
|
|
options: { format?: string; permission?: CollectionPermission | null }
|
|
) => {
|
|
await client.post("/collections.import", {
|
|
attachmentId,
|
|
...options,
|
|
});
|
|
};
|
|
|
|
@action
|
|
duplicate = async (
|
|
collection: Collection,
|
|
options?: {
|
|
name?: string;
|
|
}
|
|
): Promise<Collection> => {
|
|
const res = await client.post("/collections.duplicate", {
|
|
id: collection.id,
|
|
...options,
|
|
});
|
|
invariant(res?.data, "Data should be available");
|
|
|
|
this.addPolicies(res.policies);
|
|
return this.add(res.data);
|
|
};
|
|
|
|
@action
|
|
move = async (collectionId: string, index: string) => {
|
|
const res = await client.post("/collections.move", {
|
|
id: collectionId,
|
|
index,
|
|
});
|
|
invariant(res?.success, "Collection could not be moved");
|
|
const collection = this.get(collectionId);
|
|
|
|
if (collection) {
|
|
collection.updateIndex(res.data.index);
|
|
}
|
|
};
|
|
|
|
@action
|
|
archive = async (collection: Collection) => {
|
|
const res = await client.post("/collections.archive", {
|
|
id: collection.id,
|
|
});
|
|
runInAction(() => {
|
|
invariant(res?.data, "Data should be available");
|
|
this.add(res.data);
|
|
this.addPolicies(res.policies);
|
|
});
|
|
};
|
|
|
|
@action
|
|
restore = async (collection: Collection) => {
|
|
const res = await client.post("/collections.restore", {
|
|
id: collection.id,
|
|
});
|
|
runInAction(() => {
|
|
invariant(res?.data, "Data should be available");
|
|
this.add(res.data);
|
|
this.addPolicies(res.policies);
|
|
});
|
|
};
|
|
|
|
async update(params: Properties<Collection>): Promise<Collection> {
|
|
const result = await super.update(params);
|
|
|
|
// If we're changing sharing permissions on the collection then we need to
|
|
// remove all locally cached policies for documents in the collection as they
|
|
// are now invalid
|
|
if (params.sharing !== undefined) {
|
|
this.rootStore.documents.inCollection(result.id).forEach((document) => {
|
|
this.rootStore.policies.remove(document.id);
|
|
});
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
fetchNamedPage = async (
|
|
request = "list",
|
|
options: (PaginationParams & { filters?: Filter[] }) | undefined
|
|
): Promise<Collection[]> =>
|
|
this.fetchPaginated(`/collections.${request}`, options);
|
|
|
|
@action
|
|
fetchArchived = async (options?: PaginationParams): Promise<Collection[]> =>
|
|
this.fetchNamedPage("list", {
|
|
...options,
|
|
filters: [{ field: "archivedAt", operator: "isNotNull" }],
|
|
});
|
|
|
|
get(id: string = ""): Collection | undefined {
|
|
return this.getByIdOrUrlId(id);
|
|
}
|
|
|
|
@computed
|
|
get archived(): Collection[] {
|
|
return orderBy(this.orderedData, "archivedAt", "desc").filter(
|
|
(c) => c.isArchived && !c.isDeleted
|
|
);
|
|
}
|
|
|
|
@computed
|
|
get publicCollections() {
|
|
return this.orderedData.filter(
|
|
(collection) =>
|
|
collection.permission &&
|
|
Object.values(CollectionPermission).includes(collection.permission)
|
|
);
|
|
}
|
|
|
|
star = async (collection: Collection, index?: string) => {
|
|
await this.rootStore.stars.create({
|
|
collectionId: collection.id,
|
|
index,
|
|
});
|
|
};
|
|
|
|
unstar = async (collection: Collection) => {
|
|
const star = this.rootStore.stars.orderedData.find(
|
|
(s) => s.collectionId === collection.id
|
|
);
|
|
await star?.delete();
|
|
};
|
|
|
|
subscribe = (collection: Collection) =>
|
|
this.rootStore.subscriptions.create({
|
|
collectionId: collection.id,
|
|
event: SubscriptionType.Document,
|
|
});
|
|
|
|
unsubscribe = (collection: Collection) => {
|
|
const subscription = this.rootStore.subscriptions.getByCollectionId(
|
|
collection.id
|
|
);
|
|
|
|
return subscription?.delete();
|
|
};
|
|
|
|
@computed
|
|
get navigationNodes() {
|
|
return this.orderedData.map((collection) => collection.asNavigationNode);
|
|
}
|
|
|
|
async delete(collection: Collection) {
|
|
await super.delete(collection);
|
|
await this.rootStore.documents.fetchRecentlyUpdated();
|
|
await this.rootStore.documents.fetchRecentlyViewed();
|
|
}
|
|
|
|
export = (options: {
|
|
format: FileOperationFormat;
|
|
includeAttachments: boolean;
|
|
includePrivate: boolean;
|
|
}) => client.post("/collections.export_all", options);
|
|
}
|