vzcode 0.4.0 → 0.6.0

package/src/types.ts

@@ -0,0 +1,57 @@
+// FileId
+//   * A unique ID for a file.
+//   * This is a random string.
+export type FileId = string;
+
+// Files
+//  * A collection of files.
+//  * Keys are _not_ file names or array indices,
+//    because based on past experience, that
+//    leads to very difficult frontend logic around
+//    OT in the case that a file is renamed or deleted.
+//  * When the file name changes, or files are added/deleted,
+//    this ID stays the same, simplifying things re:OT.
+export interface Files {
+  [fileId: FileId]: File;
+}
+
+// File
+//  * A file with `name` and `text`.
+export interface File {
+  // The file name.
+  // e.g. "index.html".
+  name: string;
+
+  // The text content of the file.
+  // e.g. "<body>Hello</body>"
+  text: string;
+}
+
+// FileTree
+//  * A tree of files.
+//  * Each node in the tree is either a directory or a file.
+//  * Each directory has a `children` array.
+//  * Each file has a `file` object.
+//  * Each file has a `fileId` string.
+//  * Each directory has a `name` string.
+//  * Each directory has a `path` string.
+//  * The `path` string is the path to the directory.
+//    e.g. "src/components".
+//  * The `path` string is the path to the file.
+//    e.g. "src/components/HelloWorld.js".
+export interface FileTree {
+  name: string;
+  path?: string;
+  children?: Array<FileTree | FileTreeFile>;
+}
+
+// FileTreeFile
+//  * A file in a file tree.
+//  * Each file has a `name` string.
+//  * Each file has a `file` object.
+//  * Each file has a `fileId` string.
+export interface FileTreeFile {
+  name: string;
+  file: File;
+  fileId: FileId;
+}