mirror of
https://github.com/outline/outline.git
synced 2026-11-21 05:24:03 +03:00
* fix: Revision and document attribution to the wrong user in collaborative edits Capture the editing user synchronously with each Yjs update and persist an ordered, sequenced collaborator set in Redis so that snapshots and revisions are attributed to the user who actually made the change. * fix: Do not fail a committed save when the update event cannot be scheduled * fix: Consume collaborator attribution when a revision is skipped as identical * refactor: Add zlatestWithSequence to the Redis adapter
643 lines
15 KiB
TypeScript
643 lines
15 KiB
TypeScript
import type { ParameterizedContext, DefaultContext } from "koa";
|
|
import type { IRouterParamContext } from "koa-router";
|
|
import type { InferAttributes, Model, Transaction } from "sequelize";
|
|
import type { z } from "zod";
|
|
import type {
|
|
AuthenticationType,
|
|
CollectionSort,
|
|
NavigationNode,
|
|
Client,
|
|
CollectionPermission,
|
|
JSONValue,
|
|
MentionType,
|
|
UnfurlResourceType,
|
|
ProsemirrorData,
|
|
UnfurlResponse,
|
|
} from "@shared/types";
|
|
import type { BaseSchema } from "@server/routes/api/schema";
|
|
import type { AccountProvisionerResult } from "./commands/accountProvisioner";
|
|
import type { OAuthIntent, OAuthState } from "./utils/oauthState";
|
|
import type {
|
|
AccessRequest,
|
|
ApiKey,
|
|
Attachment,
|
|
AuthenticationProvider,
|
|
FileOperation,
|
|
Revision,
|
|
Team,
|
|
User,
|
|
UserMembership,
|
|
UserPasskey,
|
|
WebhookSubscription,
|
|
Pin,
|
|
Star,
|
|
Document,
|
|
Collection,
|
|
Group,
|
|
Integration,
|
|
Comment,
|
|
Subscription,
|
|
View,
|
|
Notification,
|
|
Share,
|
|
GroupMembership,
|
|
Import,
|
|
OAuthClient,
|
|
} from "./models";
|
|
|
|
export { AuthenticationType } from "@shared/types";
|
|
|
|
export type AuthenticationResult = AccountProvisionerResult & {
|
|
client: Client;
|
|
};
|
|
|
|
export type Authentication = {
|
|
/** The user associated with this session. */
|
|
user: User;
|
|
/** The token used for authenticating API requests, WebSocket connections, etc. */
|
|
token: string;
|
|
/** The type of authentication used to create this session (e.g., "api", "app", "oauth"). */
|
|
type?: AuthenticationType;
|
|
/** The authentication service used to create this session (e.g., "email", "passkeys", "google"). */
|
|
service?: string;
|
|
/** The OAuth scopes granted for this session, if applicable. */
|
|
scope?: string[];
|
|
};
|
|
|
|
export type Pagination = {
|
|
limit: number;
|
|
offset: number;
|
|
nextPath: string;
|
|
};
|
|
|
|
export type AppState = {
|
|
auth: Authentication | Record<string, never>;
|
|
transaction: Transaction;
|
|
pagination: Pagination;
|
|
/** The teams authorized to receive an inbound webhook. */
|
|
webhookTeamIds?: string[];
|
|
oauthClient?: OAuthClient;
|
|
oauthIntent?: OAuthIntent;
|
|
oauthState?: OAuthState;
|
|
/** The identifiers this request is rate limited against. */
|
|
rateLimiterIdentifiers?: string[];
|
|
};
|
|
|
|
export type AppContext = ParameterizedContext<AppState, DefaultContext>;
|
|
|
|
export type BaseReq = z.infer<typeof BaseSchema>;
|
|
|
|
export type BaseRes = unknown;
|
|
|
|
export interface APIContext<
|
|
ReqT = Partial<BaseReq>,
|
|
ResT = BaseRes,
|
|
> extends ParameterizedContext<
|
|
AppState,
|
|
DefaultContext & IRouterParamContext<AppState>,
|
|
ResT
|
|
> {
|
|
/** Typed and validated version of request, consisting of validated body, query, etc. */
|
|
input: ReqT;
|
|
|
|
/** The current request's context, which is passed to database mutations. */
|
|
context: {
|
|
transaction?: Transaction;
|
|
auth: Authentication;
|
|
ip?: string;
|
|
};
|
|
}
|
|
|
|
type BaseEvent<T extends Model> = {
|
|
teamId: string;
|
|
actorId: string;
|
|
ip: string | null;
|
|
authType?: AuthenticationType | null;
|
|
changes?: {
|
|
attributes: Partial<InferAttributes<T>>;
|
|
previous: Partial<InferAttributes<T>>;
|
|
} | null;
|
|
};
|
|
|
|
export type ApiKeyEvent = BaseEvent<ApiKey> & {
|
|
name: "api_keys.create" | "api_keys.delete";
|
|
modelId: string;
|
|
data: {
|
|
name: string;
|
|
};
|
|
};
|
|
|
|
export type AttachmentEvent = BaseEvent<Attachment> &
|
|
(
|
|
| {
|
|
name: "attachments.create";
|
|
modelId: string;
|
|
data: {
|
|
name: string;
|
|
source?: "import";
|
|
};
|
|
}
|
|
| {
|
|
name: "attachments.update";
|
|
modelId: string;
|
|
}
|
|
| {
|
|
name: "attachments.delete";
|
|
modelId: string;
|
|
data: {
|
|
name: string;
|
|
};
|
|
}
|
|
);
|
|
|
|
export type AuthenticationProviderEvent = BaseEvent<AuthenticationProvider> & {
|
|
name: "authenticationProviders.update";
|
|
modelId: string;
|
|
data: {
|
|
enabled: boolean;
|
|
};
|
|
};
|
|
|
|
export type UserEvent = BaseEvent<User> &
|
|
(
|
|
| {
|
|
name:
|
|
| "users.signin"
|
|
| "users.signout"
|
|
| "users.update"
|
|
| "users.suspend"
|
|
| "users.activate"
|
|
| "users.delete"
|
|
| "users.invite_accepted";
|
|
userId: string;
|
|
}
|
|
| {
|
|
name: "users.create" | "users.promote" | "users.demote";
|
|
userId: string;
|
|
data: {
|
|
name: string;
|
|
};
|
|
}
|
|
| {
|
|
name: "users.invite";
|
|
userId: string;
|
|
data: {
|
|
email: string;
|
|
name: string;
|
|
};
|
|
}
|
|
);
|
|
|
|
export type UserMembershipEvent = BaseEvent<UserMembership> & {
|
|
name: "userMemberships.update";
|
|
modelId: string;
|
|
userId: string;
|
|
documentId: string;
|
|
data: {
|
|
index: string | null;
|
|
};
|
|
};
|
|
|
|
export type DocumentMovedEvent = BaseEvent<Document> & {
|
|
name: "documents.move";
|
|
documentId: string;
|
|
collectionId: string;
|
|
data: {
|
|
collectionIds: string[];
|
|
documentIds: string[];
|
|
};
|
|
};
|
|
|
|
export type DocumentEvent = BaseEvent<Document> &
|
|
(
|
|
| {
|
|
name:
|
|
| "documents.create"
|
|
| "documents.publish"
|
|
| "documents.delete"
|
|
| "documents.permanent_delete"
|
|
| "documents.archive"
|
|
| "documents.restore";
|
|
documentId: string;
|
|
collectionId: string;
|
|
data?: {
|
|
source?: "import";
|
|
};
|
|
}
|
|
| {
|
|
name: "documents.unpublish";
|
|
documentId: string;
|
|
collectionId?: string;
|
|
}
|
|
| {
|
|
name: "documents.unarchive";
|
|
documentId: string;
|
|
collectionId: string;
|
|
}
|
|
| {
|
|
name:
|
|
| "documents.update"
|
|
| "documents.update.delayed"
|
|
| "documents.update.debounced";
|
|
documentId: string;
|
|
collectionId: string;
|
|
createdAt: string;
|
|
data?: {
|
|
done: boolean;
|
|
/** The latest collaborator sequence included in the persisted snapshot. */
|
|
collaborators?: number;
|
|
};
|
|
}
|
|
| {
|
|
name: "documents.title_change";
|
|
documentId: string;
|
|
collectionId: string;
|
|
createdAt: string;
|
|
}
|
|
| DocumentMovedEvent
|
|
| AccessRequestEvent
|
|
);
|
|
|
|
export type TemplateEvent = BaseEvent<Document> & {
|
|
name:
|
|
| "templates.create"
|
|
| "templates.update"
|
|
| "templates.delete"
|
|
| "templates.restore";
|
|
modelId: string;
|
|
collectionId?: string;
|
|
};
|
|
|
|
export type EmptyTrashEvent = {
|
|
name: "documents.empty_trash";
|
|
teamId: string;
|
|
actorId: string;
|
|
};
|
|
|
|
export type RevisionEvent = BaseEvent<Revision> & {
|
|
name: "revisions.create";
|
|
documentId: string;
|
|
modelId: string;
|
|
};
|
|
|
|
export type FileOperationEvent = BaseEvent<FileOperation> & {
|
|
name:
|
|
| "fileOperations.create"
|
|
| "fileOperations.update"
|
|
| "fileOperations.delete";
|
|
modelId: string;
|
|
data: Partial<FileOperation>;
|
|
};
|
|
|
|
export type CollectionUserEvent = BaseEvent<UserMembership> & {
|
|
name: "collections.add_user" | "collections.remove_user";
|
|
userId: string;
|
|
modelId: string;
|
|
collectionId: string;
|
|
/** Only present when the membership was created or updated. */
|
|
data?: {
|
|
isNew?: boolean;
|
|
};
|
|
};
|
|
|
|
export type CollectionGroupEvent = BaseEvent<GroupMembership> & {
|
|
name: "collections.add_group" | "collections.remove_group";
|
|
collectionId: string;
|
|
modelId: string;
|
|
data: { membershipId: string };
|
|
};
|
|
|
|
export type DocumentUserEvent = BaseEvent<UserMembership> & {
|
|
name: "documents.add_user" | "documents.remove_user";
|
|
userId: string;
|
|
modelId: string;
|
|
documentId: string;
|
|
/** Only present when the membership was created or updated. */
|
|
data?: {
|
|
isNew?: boolean;
|
|
};
|
|
};
|
|
|
|
export type AccessRequestEvent = BaseEvent<AccessRequest> & {
|
|
name: "access_requests.create";
|
|
modelId: string;
|
|
documentId: string;
|
|
};
|
|
|
|
export type DocumentGroupEvent = BaseEvent<GroupMembership> & {
|
|
name: "documents.add_group" | "documents.remove_group";
|
|
documentId: string;
|
|
modelId: string;
|
|
data: {
|
|
isNew?: boolean;
|
|
membershipId: string;
|
|
};
|
|
};
|
|
|
|
export type CollectionEvent = BaseEvent<Collection> & {
|
|
name:
|
|
| "collections.create"
|
|
| "collections.update"
|
|
| "collections.delete"
|
|
| "collections.archive"
|
|
| "collections.restore"
|
|
| "collections.move"
|
|
| "collections.permission_changed";
|
|
collectionId: string;
|
|
};
|
|
|
|
export type GroupUserEvent = BaseEvent<UserMembership> & {
|
|
name: "groups.add_user" | "groups.remove_user";
|
|
userId: string;
|
|
modelId: string;
|
|
};
|
|
|
|
export type GroupEvent = BaseEvent<Group> &
|
|
(
|
|
| GroupUserEvent
|
|
| {
|
|
name: "groups.create" | "groups.delete" | "groups.update";
|
|
modelId: string;
|
|
}
|
|
);
|
|
|
|
export type IntegrationEvent = BaseEvent<Integration> & {
|
|
name: "integrations.create" | "integrations.update" | "integrations.delete";
|
|
modelId: string;
|
|
};
|
|
|
|
export type TeamEvent = BaseEvent<Team> & {
|
|
name: "teams.create" | "teams.update" | "teams.delete" | "teams.destroy";
|
|
};
|
|
|
|
export type PinEvent = BaseEvent<Pin> & {
|
|
name: "pins.create" | "pins.update" | "pins.delete";
|
|
modelId: string;
|
|
documentId: string;
|
|
collectionId?: string;
|
|
};
|
|
|
|
export type CommentUpdateEvent = BaseEvent<Comment> & {
|
|
name: "comments.update";
|
|
modelId: string;
|
|
documentId: string;
|
|
actorId: string;
|
|
data?: {
|
|
newMentionIds: string[];
|
|
};
|
|
};
|
|
|
|
export type CommentReactionEvent = BaseEvent<Comment> & {
|
|
name: "comments.add_reaction" | "comments.remove_reaction";
|
|
modelId: string;
|
|
documentId: string;
|
|
data: {
|
|
emoji: string;
|
|
};
|
|
};
|
|
|
|
export type CommentEvent =
|
|
| (BaseEvent<Comment> & {
|
|
name: "comments.create";
|
|
modelId: string;
|
|
documentId: string;
|
|
actorId: string;
|
|
})
|
|
| CommentUpdateEvent
|
|
| (BaseEvent<Comment> & {
|
|
name: "comments.delete";
|
|
modelId: string;
|
|
documentId: string;
|
|
actorId: string;
|
|
collectionId: string;
|
|
})
|
|
| CommentReactionEvent;
|
|
|
|
export type StarEvent = BaseEvent<Star> & {
|
|
name: "stars.create" | "stars.update" | "stars.delete";
|
|
modelId: string;
|
|
documentId: string;
|
|
userId: string;
|
|
};
|
|
|
|
export type ShareEvent = BaseEvent<Share> & {
|
|
name: "shares.create" | "shares.update" | "shares.revoke";
|
|
modelId: string;
|
|
documentId: string;
|
|
collectionId?: string;
|
|
};
|
|
|
|
export type SubscriptionEvent = BaseEvent<Subscription> & {
|
|
name: "subscriptions.create" | "subscriptions.delete";
|
|
modelId: string;
|
|
userId: string;
|
|
documentId: string | null;
|
|
collectionId: string | null;
|
|
};
|
|
|
|
export type ViewEvent = BaseEvent<View> & {
|
|
name: "views.create";
|
|
documentId: string;
|
|
collectionId: string;
|
|
modelId: string;
|
|
data: {
|
|
title: string;
|
|
};
|
|
};
|
|
|
|
export type WebhookDeliveryStatus = "pending" | "success" | "failed";
|
|
|
|
export type WebhookSubscriptionEvent = BaseEvent<WebhookSubscription> & {
|
|
name:
|
|
| "webhookSubscriptions.create"
|
|
| "webhookSubscriptions.delete"
|
|
| "webhookSubscriptions.update";
|
|
modelId: string;
|
|
data: {
|
|
name: string;
|
|
url: string;
|
|
events: string[];
|
|
};
|
|
};
|
|
|
|
export type NotificationEvent = BaseEvent<Notification> & {
|
|
name:
|
|
| "notifications.create"
|
|
| "notifications.update"
|
|
| "notifications.delete";
|
|
modelId: string;
|
|
teamId: string;
|
|
userId: string;
|
|
actorId: string;
|
|
commentId?: string;
|
|
documentId?: string;
|
|
collectionId?: string;
|
|
membershipId?: string;
|
|
};
|
|
|
|
export type OAuthClientEvent = BaseEvent<OAuthClient> & {
|
|
name: "oauthClients.create" | "oauthClients.update" | "oauthClients.delete";
|
|
modelId: string;
|
|
};
|
|
|
|
export type UserPasskeyEvent = BaseEvent<UserPasskey> & {
|
|
name: "passkeys.create" | "passkeys.update" | "passkeys.delete";
|
|
modelId: string;
|
|
userId: string;
|
|
};
|
|
|
|
// oxlint-disable-next-line @typescript-eslint/no-explicit-any
|
|
export type ImportEvent = BaseEvent<Import<any>> & {
|
|
name:
|
|
| "imports.create"
|
|
| "imports.update"
|
|
| "imports.processed"
|
|
| "imports.delete";
|
|
modelId: string;
|
|
};
|
|
|
|
export type Event =
|
|
| ApiKeyEvent
|
|
| AttachmentEvent
|
|
| AuthenticationProviderEvent
|
|
| DocumentEvent
|
|
| DocumentUserEvent
|
|
| AccessRequestEvent
|
|
| DocumentMovedEvent
|
|
| DocumentGroupEvent
|
|
| PinEvent
|
|
| CommentEvent
|
|
| StarEvent
|
|
| CollectionEvent
|
|
| CollectionUserEvent
|
|
| CollectionGroupEvent
|
|
| FileOperationEvent
|
|
| IntegrationEvent
|
|
| GroupEvent
|
|
| RevisionEvent
|
|
| ShareEvent
|
|
| SubscriptionEvent
|
|
| TeamEvent
|
|
| TemplateEvent
|
|
| UserEvent
|
|
| UserMembershipEvent
|
|
| ViewEvent
|
|
| WebhookSubscriptionEvent
|
|
| NotificationEvent
|
|
| OAuthClientEvent
|
|
| UserPasskeyEvent
|
|
| EmptyTrashEvent
|
|
| ImportEvent;
|
|
|
|
export type NotificationMetadata = {
|
|
notificationId?: string;
|
|
};
|
|
|
|
export type JSONExportMetadata = {
|
|
/** The version of the export, allows updated structure in the future. */
|
|
exportVersion: number;
|
|
/** The version of the application that created the export. */
|
|
version: string;
|
|
/** The date the export was created. */
|
|
createdAt: string;
|
|
/** The ID of the user that created the export. */
|
|
createdById: string;
|
|
/** The email of the user that created the export. */
|
|
createdByEmail: string | null;
|
|
};
|
|
|
|
export type DocumentJSONExport = {
|
|
id: string;
|
|
urlId: string;
|
|
title: string;
|
|
/**
|
|
* For backward compatibility, maintain the `emoji` field.
|
|
* Future exports will use the `icon` field.
|
|
* */
|
|
emoji?: string | null;
|
|
icon: string | null;
|
|
color: string | null;
|
|
data: ProsemirrorData;
|
|
createdById: string;
|
|
createdByName: string;
|
|
createdByEmail: string | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
publishedAt: string | null;
|
|
fullWidth: boolean;
|
|
parentDocumentId: string | null;
|
|
};
|
|
|
|
export type AttachmentJSONExport = {
|
|
id: string;
|
|
documentId: string | null;
|
|
contentType: string;
|
|
name: string;
|
|
size: number;
|
|
key: string;
|
|
};
|
|
|
|
export type CollectionJSONExport = {
|
|
collection: {
|
|
id: string;
|
|
urlId: string;
|
|
name: string;
|
|
data?: ProsemirrorData | null;
|
|
description?: string | null;
|
|
permission?: CollectionPermission | null;
|
|
color?: string | null;
|
|
icon?: string | null;
|
|
sort: CollectionSort;
|
|
documentStructure: NavigationNode[] | null;
|
|
};
|
|
documents: {
|
|
[id: string]: DocumentJSONExport;
|
|
};
|
|
attachments: {
|
|
[id: string]: AttachmentJSONExport;
|
|
};
|
|
};
|
|
|
|
export type UnfurlIssueOrPR =
|
|
| UnfurlResponse[UnfurlResourceType.Issue]
|
|
| UnfurlResponse[UnfurlResourceType.PR];
|
|
|
|
export type UnfurlProject = UnfurlResponse[UnfurlResourceType.Project];
|
|
|
|
export type UnfurlURL = UnfurlResponse[UnfurlResourceType.URL];
|
|
|
|
export type Unfurl =
|
|
| UnfurlIssueOrPR
|
|
| UnfurlProject
|
|
| UnfurlURL
|
|
| {
|
|
type: Exclude<
|
|
UnfurlResourceType,
|
|
| UnfurlResourceType.Issue
|
|
| UnfurlResourceType.PR
|
|
| UnfurlResourceType.Project
|
|
| UnfurlResourceType.URL
|
|
>;
|
|
[x: string]: JSONValue;
|
|
};
|
|
|
|
export type UnfurlError = { error: string };
|
|
|
|
export type UnfurlSignature = (
|
|
url: string,
|
|
actor?: User
|
|
) => Promise<Unfurl | UnfurlError | undefined>;
|
|
|
|
/**
|
|
* Recognizes the URL of a resource belonging to the service and returns the
|
|
* type of mention that represents it, or undefined when the URL is not one the
|
|
* service can mention.
|
|
*/
|
|
export type MentionSignature = (url: URL) => MentionType | undefined;
|
|
|
|
export type UninstallSignature = (integration: Integration) => Promise<void>;
|
|
|
|
export type Replace<T, K extends keyof T, N extends string> = {
|
|
[P in keyof T as P extends K ? N : P]: T[P extends K ? K : P];
|
|
};
|