1 files changed, 71 insertions, 16 deletions

diff --git a/src/client/views/collections/collectionSchema/CollectionSchemaCells.tsx b/src/client/views/collections/collectionSchema/CollectionSchemaCells.tsx
index ed196349e..a439a7998 100644
--- a/src/client/views/collections/collectionSchema/CollectionSchemaCells.tsx
+++ b/src/client/views/collections/collectionSchema/CollectionSchemaCells.tsx
@@ -38,27 +38,35 @@ export interface CellProps {
     row: number;
     col: number;
     rowProps: CellInfo;
+    // currently unused
     CollectionView: Opt<CollectionView>;
+    // currently unused
     ContainingCollection: Opt<CollectionView>;
     Document: Doc;
+    // column name
     fieldKey: string;
+    // currently unused
     renderDepth: number;
+    // called when a button is pressed on the node itself
     addDocTab: (document: Doc, where: string) => boolean;
     pinToPres: (document: Doc) => void;
     moveDocument?: (document: Doc | Doc[], targetCollection: Doc | undefined,
         addDocument: (document: Doc | Doc[]) => boolean) => boolean;
     isFocused: boolean;
     changeFocusedCellByIndex: (row: number, col: number) => void;
+    // set whether the cell is in the isEditing mode
     setIsEditing: (isEditing: boolean) => void;
     isEditable: boolean;
     setPreviewDoc: (doc: Doc) => void;
     setComputed: (script: string, doc: Doc, field: string, row: number, col: number) => boolean;
     getField: (row: number, col?: number) => void;
+    // currnetly unused
     showDoc: (doc: Doc | undefined, dataDoc?: any, screenX?: number, screenY?: number) => void;
 }
 
 @observer
 export class CollectionSchemaCell extends React.Component<CellProps> {
+    // return a field key that is corrected for whether it COMMENT
     public static resolvedFieldKey(column: string, rowDoc: Doc) {
         const fieldKey = column;
         if (fieldKey.startsWith("*")) {
@@ -72,7 +80,9 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
     @observable protected _isEditing: boolean = false;
     protected _focusRef = React.createRef<HTMLDivElement>();
     protected _rowDoc = this.props.rowProps.original;
+    // Gets the serialized data in proto form of the base proto that this document's proto inherits from
     protected _rowDataDoc = Doc.GetProto(this.props.rowProps.original);
+    // methods for dragging and dropping
     protected _dropDisposer?: DragManager.DragDropDisposer;
     @observable contents: string = "";
 
@@ -81,6 +91,7 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
 
     @action
     onKeyDown = (e: KeyboardEvent): void => {
+        // If a cell is editable and clicked, hitting enter shoudl allow the user to edit it
         if (this.props.isFocused && this.props.isEditable && e.keyCode === KeyCodes.ENTER) {
             document.removeEventListener("keydown", this.onKeyDown);
             this._isEditing = true;
@@ -90,7 +101,11 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
 
     @action
     isEditingCallback = (isEditing: boolean): void => {
+        // a general method that takes a boolean that determines whether the cell should be in
+        // is-editing mode
+        // remove the event listener if it's there
         document.removeEventListener("keydown", this.onKeyDown);
+        // it's not already in is-editing mode, re-add the event listener
         isEditing && document.addEventListener("keydown", this.onKeyDown);
         this._isEditing = isEditing;
         this.props.setIsEditing(isEditing);
@@ -99,13 +114,15 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
 
     @action
     onPointerDown = async (e: React.PointerEvent): Promise<void> => {
+        // pan to the cell
         this.onItemDown(e);
+        // focus on it
         this.props.changeFocusedCellByIndex(this.props.row, this.props.col);
         this.props.setPreviewDoc(this.props.rowProps.original);
 
-        console.log("click cell");
         let url: string;
         if (url = StrCast(this.props.rowProps.row.href)) {
+            // opens up the the doc in a new window, blurring the old one
             try {
                 new URL(url);
                 const temp = window.open(url)!;
@@ -120,18 +137,25 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
 
     @undoBatch
     applyToDoc = (doc: Doc, row: number, col: number, run: (args?: { [name: string]: any }) => any) => {
+        // apply a specified change to the cell
         const res = run({ this: doc, $r: row, $c: col, $: (r: number = 0, c: number = 0) => this.props.getField(r + row, c + col) });
         if (!res.success) return false;
+        // change what is rendered to this new changed cell content
         doc[this.renderFieldKey] = res.result;
         return true;
+        // return whether the change was successful
     }
 
     private drop = (e: Event, de: DragManager.DropEvent) => {
+        // if the drag has data at its completion
         if (de.complete.docDragData) {
+            // if only one doc was dragged
             if (de.complete.docDragData.draggedDocuments.length === 1) {
+                // update the renderFieldKey
                 this._rowDataDoc[this.renderFieldKey] = de.complete.docDragData.draggedDocuments[0];
             }
             else {
+                // create schema document reflecting the new column arrangement
                 const coll = Docs.Create.SchemaDocument([new SchemaHeaderField("title", "#f1efeb")], de.complete.docDragData.draggedDocuments, {});
                 this._rowDataDoc[this.renderFieldKey] = coll;
             }
@@ -140,7 +164,9 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
     }
 
     protected dropRef = (ele: HTMLElement | null) => {
+        // if the drop disposer is not undefined, run its function
         this._dropDisposer?.();
+        // if ele is not null, give ele a non-undefined drop disposer
         ele && (this._dropDisposer = DragManager.MakeDropTarget(ele, this.drop.bind(this)));
     }
 
@@ -164,33 +190,46 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
         return <span style={{ color: contents ? "black" : "grey" }}>{contents ? contents?.valueOf() : "undefined"}</span>;
     }
 
-    @computed get renderFieldKey() { return CollectionSchemaCell.resolvedFieldKey(this.props.rowProps.column.id!, this.props.rowProps.original); }
+    @computed get renderFieldKey() {
+        // gets the resolved field key of this cell
+        return CollectionSchemaCell.resolvedFieldKey(this.props.rowProps.column.id!, this.props.rowProps.original);
+    }
+
     onItemDown = async (e: React.PointerEvent) => {
+        // if the document is a document used to change UI for search results in schema view
         if (this.props.Document._searchDoc) {
             const aliasdoc = await SearchUtil.GetAliasesOfDocument(this._rowDataDoc);
             const targetContext = aliasdoc.length <= 0 ? undefined : Cast(aliasdoc[0].context, Doc, null);
+            // Jump to the this document
             DocumentManager.Instance.jumpToDocument(this._rowDoc, false, emptyFunction, targetContext,
                 undefined, undefined, undefined, () => this.props.setPreviewDoc(this._rowDoc));
         }
     }
+
     renderCellWithType(type: string | undefined) {
         const dragRef: React.RefObject<HTMLDivElement> = React.createRef();
 
+        // the column
         const fieldKey = this.renderFieldKey;
+        // the exact cell
         const field = this._rowDoc[fieldKey];
 
         const onPointerEnter = (e: React.PointerEvent): void => {
+            // e.buttons === 1 means the left moue pointer is down
             if (e.buttons === 1 && SnappingManager.GetIsDragging() && (type === "document" || type === undefined)) {
                 dragRef.current!.className = "collectionSchemaView-cellContainer doc-drag-over";
             }
         };
         const onPointerLeave = (e: React.PointerEvent): void => {
+            // change the class name to indicate that the cell is no longer being dragged
             dragRef.current!.className = "collectionSchemaView-cellContainer";
         };
 
         let contents = Field.toString(field as Field);
+        // display 2 hyphens instead of a blank box for empty cells
         contents = contents === "" ? "--" : contents;
 
+        // classname reflects the tatus of the cell
         let className = "collectionSchemaView-cellWrapper";
         if (this._isEditing) className += " editing";
         if (this.props.isFocused && this.props.isEditable) className += " focused";
@@ -198,19 +237,23 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
 
         const positions = [];
         if (StrCast(this.props.Document._searchString).toLowerCase() !== "") {
+            // term is ...promise pending... if the field is a Promise, otherwise it is the cell's contents
             let term = (field instanceof Promise) ? "...promise pending..." : contents.toLowerCase();
             const search = StrCast(this.props.Document._searchString).toLowerCase();
             let start = term.indexOf(search);
             let tally = 0;
+            // if search is found in term
             if (start !== -1) {
                 positions.push(start);
             }
+            // if search is found in term, continue finding all instances of search in term
             while (start < contents?.length && start !== -1) {
                 term = term.slice(start + search.length + 1);
                 tally += start + search.length + 1;
                 start = term.indexOf(search);
                 positions.push(tally + start);
             }
+            // remove the last position
             if (positions.length > 1) {
                 positions.pop();
             }
@@ -280,6 +323,7 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
                                             //two options here: we can strip off outer quotes or we can figure out what's going on with the script
                                             const script = CompileScript(inputAsString, { requiredType: type, typecheck: false, editable: true, addReturn: true, params: { this: Doc.name, $r: "number", $c: "number", $: "any" } });
                                             const changeMade = inputAsString.length !== value.length || inputAsString.length - 2 !== value.length;
+                                            // change it if a change is made, otherwise, just compile using the old cell conetnts
                                             script.compiled && (retVal = this.applyToDoc(changeMade ? this._rowDoc : this._rowDataDoc, this.props.row, this.props.col, script.run));
                                             // handle numbers and expressions
                                         } else if (inputIsNum || value.startsWith("=")) {
@@ -309,6 +353,7 @@ export class CollectionSchemaCell extends React.Component<CellProps> {
                                     return retVal;
                                 })}
                                 OnFillDown={async (value: string) => {
+                                    // computes all of the value preceded by :=
                                     const script = CompileScript(value, { requiredType: type, typecheck: false, editable: true, addReturn: true, params: { this: Doc.name, $r: "number", $c: "number", $: "any" } });
                                     script.compiled && DocListCast(this.props.Document[this.props.fieldKey]).
                                         forEach((doc, i) => value.startsWith(":=") ?
@@ -339,7 +384,10 @@ export class CollectionSchemaStringCell extends CollectionSchemaCell { render()
 
 @observer
 export class CollectionSchemaDateCell extends CollectionSchemaCell {
-    @computed get _date(): Opt<DateField> { return this._rowDoc[this.renderFieldKey] instanceof DateField ? DateCast(this._rowDoc[this.renderFieldKey]) : undefined; }
+    @computed get _date(): Opt<DateField> {
+        // if the cell is a date field, cast then contents to a date. Otherrwwise, make the contents undefined.
+        return this._rowDoc[this.renderFieldKey] instanceof DateField ? DateCast(this._rowDoc[this.renderFieldKey]) : undefined;
+    }
 
     @action
     handleChange = (date: any) => {
@@ -378,8 +426,9 @@ export class CollectionSchemaDocCell extends CollectionSchemaCell {
             typecheck: true,
             transformer: DocumentIconContainer.getTransformer()
         });
-
+        // compile the script
         const results = script.compiled && script.run();
+        // if the script was compiled and run
         if (results && results.success) {
             this._rowDoc[this.renderFieldKey] = results.result;
             return true;
@@ -397,6 +446,7 @@ export class CollectionSchemaDocCell extends CollectionSchemaCell {
 
     @action
     isEditingCallback = (isEditing: boolean): void => {
+        // the isEditingCallback from a general CollectionSchemaCell
         document.removeEventListener("keydown", this.onKeyDown);
         isEditing && document.addEventListener("keydown", this.onKeyDown);
         this._isEditing = isEditing;
@@ -405,6 +455,7 @@ export class CollectionSchemaDocCell extends CollectionSchemaCell {
     }
 
     render() {
+        // if there's a doc, render it
         return !this._doc ? this.renderCellWithType("document") :
             <div className="collectionSchemaView-cellWrapper" ref={this._focusRef} tabIndex={-1}
                 onPointerDown={this.onPointerDown}
@@ -440,11 +491,11 @@ export class CollectionSchemaDocCell extends CollectionSchemaCell {
 export class CollectionSchemaImageCell extends CollectionSchemaCell {
 
     choosePath(url: URL) {
-        if (url.protocol === "data") return url.href;
-        if (url.href.indexOf(window.location.origin) === -1) return Utils.CorsProxy(url.href);
-        if (!/\.(png|jpg|jpeg|gif|webp)$/.test(url.href.toLowerCase())) return url.href;//Why is this here
+        if (url.protocol === "data") return url.href; // if the url ises the data protocol, just return the href
+        if (url.href.indexOf(window.location.origin) === -1) return Utils.CorsProxy(url.href); // otherwise, put it through the cors proxy erver
+        if (!/\.(png|jpg|jpeg|gif|webp)$/.test(url.href.toLowerCase())) return url.href;//Why is this here — good question
 
-        const ext = path.extname(url.href);
+        const ext = path.extname(url.href); // the extension of the file
         return url.href.replace(ext, "_o" + path.extname(url.href));
     }
 
@@ -453,12 +504,13 @@ export class CollectionSchemaImageCell extends CollectionSchemaCell {
         const alts = DocListCast(this._rowDoc[this.renderFieldKey + "-alternates"]); // retrieve alternate documents that may be rendered as alternate images
         const altpaths = alts.map(doc => Cast(doc[Doc.LayoutFieldKey(doc)], ImageField, null)?.url).filter(url => url).map(url => this.choosePath(url)); // access the primary layout data of the alternate documents
         const paths = field ? [this.choosePath(field.url), ...altpaths] : altpaths;
+        // If there is a path, follow it; otherwise, follow a link to a default image icon
         const url = paths.length ? paths : [Utils.CorsProxy("http://www.cs.brown.edu/~bcz/noImage.png")];
 
-        const aspect = Doc.NativeAspect(this._rowDoc);
-        let width = Math.min(75, this.props.rowProps.width);
-        const height = Math.min(75, width / aspect);
-        width = height * aspect;
+        const aspect = Doc.NativeAspect(this._rowDoc); // aspect ratio
+        let width = Math.min(75, this.props.rowProps.width); // get a with that is no smaller than 75px
+        const height = Math.min(75, width / aspect); // get a height either proportional to that or 75 px
+        width = height * aspect; // increase the width of the image if necessary to maintain proportionality
 
         const reference = React.createRef<HTMLDivElement>();
         return <div className="collectionSchemaView-cellWrapper" ref={this._focusRef} tabIndex={-1} onPointerDown={this.onPointerDown}>
@@ -478,13 +530,13 @@ export class CollectionSchemaListCell extends CollectionSchemaCell {
 
     @computed get _field() { return this._rowDoc[this.renderFieldKey]; }
     @computed get _optionsList() { return this._field as List<any>; }
-    @observable private _opened = false;
+    @observable private _opened = false; // whether the list is opened
     @observable private _text = "select an item";
-    @observable private _selectedNum = 0;
+    @observable private _selectedNum = 0; // the index of the list item selected
 
     @action
     onSetValue = (value: string) => {
-        // change if its a document
+        // change if it's a document
         this._optionsList[this._selectedNum] = this._text = value;
 
         (this._field as List<any>).splice(this._selectedNum, 1, value);
@@ -492,6 +544,7 @@ export class CollectionSchemaListCell extends CollectionSchemaCell {
 
     @action
     onSelected = (element: string, index: number) => {
+        // if an item is selected, the private variables should update to reflect this
         this._text = element;
         this._selectedNum = index;
     }
@@ -505,6 +558,7 @@ export class CollectionSchemaListCell extends CollectionSchemaCell {
         const link = false;
         const reference = React.createRef<HTMLDivElement>();
 
+        // if the list is not opened, don't display it; otherwise, do. 
         if (this._optionsList?.length) {
             const options = !this._opened ? (null) :
                 <div>
@@ -572,6 +626,7 @@ export class CollectionSchemaCheckboxCell extends CollectionSchemaCell {
 
 @observer
 export class CollectionSchemaButtons extends CollectionSchemaCell {
+    // the navigation buttons for schema view when it is used for search.
     render() {
         return !this.props.Document._searchDoc || ![DocumentType.PDF, DocumentType.RTF].includes(StrCast(this._rowDoc.type) as DocumentType) ? <></> :
             <div style={{ paddingTop: 8, paddingLeft: 3 }} >
@@ -583,4 +638,4 @@ export class CollectionSchemaButtons extends CollectionSchemaCell {
                 </button>
             </div>;
     }
-}
\ No newline at end of file
+}