mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-19 16:52:29 +00:00
876a0298a2
Summary: This removes the need for any information drawn from the content of recent actions when loading a document. The undo/redo system does need some facts about recent actions up front. But that system has an important restriction: only actions a particular client is known to have generated can be undone by that client. So in this diff, as we store which client has performed an action, we also store the few pieces of metadata about that action that the undo/redo system needs: `linkId`, `otherId`, `rowIdHint`, `isUndo` fields. These are all small integers (or in one case a boolean). An existing limitation is that information about which client has performed which action is stored in memory in the worker, and not persisted anywhere. This diff does not change that limitation, meaning that undos continue to not survive a worker transition. A reasonable way to deal with that would be to back the store with redis. Test Plan: existing tests pass Reviewers: dsagal Reviewed By: dsagal Differential Revision: https://phab.getgrist.com/D3044
93 lines
2.8 KiB
TypeScript
93 lines
2.8 KiB
TypeScript
import {MinimalActionGroup} from 'app/common/ActionGroup';
|
|
import {TableDataAction} from 'app/common/DocActions';
|
|
import {Role} from 'app/common/roles';
|
|
import {StringUnion} from 'app/common/StringUnion';
|
|
import {FullUser} from 'app/common/UserAPI';
|
|
|
|
// Possible flavors of items in a list of documents.
|
|
export type DocEntryTag = ''|'sample'|'invite'|'shared';
|
|
|
|
export const OpenDocMode = StringUnion(
|
|
'default', // open doc with user's maximal access level
|
|
'view', // open doc limited to view access (if user has at least that level of access)
|
|
'fork', // as for 'view', but suggest a fork on any attempt to edit - the client will
|
|
// enable the editing UI experience and trigger a fork on any edit.
|
|
);
|
|
export type OpenDocMode = typeof OpenDocMode.type;
|
|
|
|
/**
|
|
* Represents an entry in the DocList.
|
|
*/
|
|
export interface DocEntry {
|
|
docId?: string; // Set for shared docs and invites
|
|
name: string;
|
|
mtime?: Date;
|
|
size?: number;
|
|
tag: DocEntryTag;
|
|
senderName?: string;
|
|
senderEmail?: string;
|
|
}
|
|
|
|
export interface DocCreationInfo {
|
|
id: string;
|
|
title: string;
|
|
}
|
|
|
|
/**
|
|
* This documents the members of the structure returned when a local
|
|
* grist document is opened.
|
|
*/
|
|
export interface OpenLocalDocResult {
|
|
docFD: number;
|
|
clientId: string; // the docFD is meaningful only in the context of this session
|
|
doc: {[tableId: string]: TableDataAction};
|
|
log: MinimalActionGroup[];
|
|
recoveryMode?: boolean;
|
|
userOverride?: UserOverride;
|
|
}
|
|
|
|
export interface UserOverride {
|
|
user: FullUser|null;
|
|
access: Role|null;
|
|
}
|
|
|
|
export interface DocListAPI {
|
|
/**
|
|
* Returns a all known Grist documents and document invites to show in the doc list.
|
|
*/
|
|
getDocList(): Promise<{docs: DocEntry[], docInvites: DocEntry[]}>;
|
|
|
|
/**
|
|
* Creates a new document, fetches it, and adds a table to it. Returns its name.
|
|
*/
|
|
createNewDoc(): Promise<string>;
|
|
|
|
/**
|
|
* Makes a copy of the given sample doc. Returns the name of the new document.
|
|
*/
|
|
importSampleDoc(sampleDocName: string): Promise<string>;
|
|
|
|
/**
|
|
* Processes an upload, containing possibly multiple files, to create a single new document, and
|
|
* returns the new document's name.
|
|
*/
|
|
importDoc(uploadId: number): Promise<string>;
|
|
|
|
/**
|
|
* Deletes a Grist document. Returns the name of the deleted document. If `deletePermanently` is
|
|
* true, the doc is deleted permanently rather than just moved to the trash.
|
|
*/
|
|
deleteDoc(docName: string, deletePermanently: boolean): Promise<string>;
|
|
|
|
/**
|
|
* Renames a document.
|
|
*/
|
|
renameDoc(oldName: string, newName: string): Promise<void>;
|
|
|
|
/**
|
|
* Opens a document, loads it, subscribes to its userAction events, and returns its metadata.
|
|
*/
|
|
openDoc(userDocName: string, openMode?: OpenDocMode,
|
|
linkParameters?: Record<string, string>): Promise<OpenLocalDocResult>;
|
|
}
|