added tutorial tool, still need to integrate with metadatatool

1 files changed, 92 insertions, 72 deletions

diff --git a/src/client/documents/Documents.ts b/src/client/documents/Documents.ts
index 19ddbdd50..bb6f5d637 100644
--- a/src/client/documents/Documents.ts
+++ b/src/client/documents/Documents.ts
@@ -4,7 +4,7 @@ import { basename } from 'path';
 import { ClientUtils, OmitKeys } from '../../ClientUtils';
 import { DateField } from '../../fields/DateField';
 import { CreateLinkToActiveAudio, Doc, FieldType, Opt, updateCachedAcls } from '../../fields/Doc';
-import { Initializing } from '../../fields/DocSymbols';
+import { Id } from '../../fields/FieldSymbols';
 import { HtmlField } from '../../fields/HtmlField';
 import { InkField } from '../../fields/InkField';
 import { List } from '../../fields/List';
@@ -18,7 +18,6 @@ import { PointData } from '../../pen-gestures/GestureTypes';
 import { DocServer } from '../DocServer';
 import { dropActionType } from '../util/DropActionTypes';
 import { CollectionViewType, DocumentType } from './DocumentTypes';
-import { Id } from '../../fields/FieldSymbols';
 
 class EmptyBox {
     public static LayoutString() {
@@ -35,7 +34,7 @@ export enum FInfoFieldType {
     enumeration = 'enum',
     date = 'date',
     list = 'list',
-    rtf = 'rich text',
+    rtf = 'richtext',
     map = 'map',
 }
 export class FInfo {
@@ -43,7 +42,6 @@ export class FInfo {
     readOnly: boolean = false;
     fieldType?: FInfoFieldType;
     values?: FieldType[];
-    onLayout?: boolean;
     filterable?: boolean = true; // can be used as a Filter in FilterPanel
     // format?: string; // format to display values (e.g, decimal places, $, etc)
     // parse?: ScriptField; // parse a value from a string
@@ -156,12 +154,16 @@ type DROPt = DAInfo | dropActionType;
 type DATEt = DateInfo | number;
 type DTYPEt = DTypeInfo | string;
 export class DocumentOptions {
+    [key: string]: FInfo | FieldType | undefined;
     // coordinate and dimensions depending on view
     x?: NUMt = new NumInfo('horizontal coordinate in freeform view', false);
     y?: NUMt = new NumInfo('vertical coordinate in freeform view', false);
     z?: NUMt = new NumInfo('whether document is in overlay (1) or not (0)', false, false, [1, 0]);
+    zIndex?: NUMt = new NumInfo('stacking index of documents in freeform view (higher numbers are towards the top');
     overlayX?: NUMt = new NumInfo('horizontal coordinate in overlay view', false);
     overlayY?: NUMt = new NumInfo('vertical coordinate in overlay view', false);
+    embedContainer?: DOCt = new DocInfo('document that displays (contains) this document', false);
+
     text?: RTFt = new RtfInfo('plain or rich text', true);
     text_html?: STRt = new StrInfo('plain text or html', true);
     _dimMagnitude?: NUMt = new NumInfo("magnitude of collectionMulti{row,col} element's width or height", false);
@@ -216,8 +218,7 @@ export class DocumentOptions {
     author?: string; // STRt = new StrInfo('creator of document'); // bcz: don't change this. Otherwise, the userDoc's field Infos will have a FieldInfo assigned to its author field which will render it unreadable
     author_date?: DATEt = new DateInfo('date the document was created', true);
     annotationOn?: DOCt = new DocInfo('document annotated by this document', false);
-    _embedContainer?: DOCt = new DocInfo('document that displays (contains) this document', false);
-    rootDocument?: DOCt = new DocInfo('document that supplies the information needed for a rendering template (eg, pres slide for PresElement)');
+    rootDocument?: DOCt = new DocInfo('document that stores the data for compound template documents.');
     color?: STRt = new StrInfo('foreground color data doc', false);
     hidden?: BOOLt = new BoolInfo('whether the document is not rendered by its collection', false);
     backgroundColor?: STRt = new StrInfo('background color for data doc', false);
@@ -282,9 +283,8 @@ export class DocumentOptions {
     _layout_autoHeightMargins?: NUMt = new NumInfo('Margin heights to be added to the computed auto height of a Doc');
     _layout_curPage?: NUMt = new NumInfo('current page of a PDF or other? paginated document', false);
     _layout_currentTimecode?: NUMt = new NumInfo('the current timecode of a time-based document (e.g., current time of a video)  value is in seconds', false);
-    _layout_centered?: BOOLt = new BoolInfo('whether text should be vertically centered in Doc');
     _layout_fitWidth?: BOOLt = new BoolInfo('whether document should scale its contents to fit its rendered width or not (e.g., for PDFviews)');
-    _layout_fieldKey?: STRt = new StrInfo('the field key containing the current layout definition', false);
+    layout_fieldKey?: STRt = new StrInfo('the field key containing the current layout definition', false);
     _layout_enableAltContentUI?: BOOLt = new BoolInfo('whether to show alternate content button');
     _layout_flashcardType?: STRt = new StrInfo('flashcard style to render in ComparisonBox.  currently just "flashcard".');
     _layout_showTitle?: string; // field name to display in header (:hover is an optional suffix)
@@ -308,6 +308,7 @@ export class DocumentOptions {
     text_fontSize?: string;
     text_fontFamily?: string;
     text_fontWeight?: string;
+    text_centered?: BOOLt = new BoolInfo('whether text should be vertically centered in Doc');
     text_fitBox?: BOOLt = new BoolInfo("whether text box should be scaled to fit it's containing render box");
     text_align?: STRt = new StrInfo('horizontal text alignment default', undefined, undefined, ['left', 'center', 'right']);
     title_align?: STRt = new StrInfo('horizontal title alignment in label box', undefined, undefined, ['left', 'center', 'right']);
@@ -367,7 +368,7 @@ export class DocumentOptions {
     isGroup?: BOOLt = new BoolInfo('should collection use a grouping UI behavior');
     isFolder?: BOOLt = new BoolInfo('is document a tree view folder');
     _isTimelineLabel?: BOOLt = new BoolInfo('is document a timeline label');
-    _isLightbox?: BOOLt = new BoolInfo('whether a collection acts as a lightbox by opening lightbox links by hiding all other documents in collection besides link target');
+    isLightbox?: BOOLt = new BoolInfo('whether a collection acts as a lightbox by opening lightbox links by hiding all other documents in collection besides link target');
     cloneOnCopy?: BOOLt = new BoolInfo('if this Doc is a field of another Doc, then it should be copied when the other Doc is copied');
 
     mapPin?: DOCt = new DocInfo('pin associated with a config anchor', false);
@@ -525,6 +526,16 @@ export class DocumentOptions {
     ai?: string; // to mark items as ai generated
     ai_firefly_seed?: number;
     ai_firefly_prompt?: string;
+
+    /**
+     * JSON‐stringified slot configuration for ScrapbookBox
+     */
+    scrapbookConfig?: string;
+
+    /**
+     * The list of embedded Doc instances in each Scrapbook slot
+     */
+    scrapbookContents?: List<Doc>;
 }
 
 export const DocOptions = new DocumentOptions();
@@ -574,19 +585,6 @@ export namespace Docs {
                     options: { acl: '' },
                 },
             ],
-
-            // AARAV ADD //
-            [
-                DocumentType.JOURNAL,
-                {
-                    layout: { view: EmptyBox, dataField: 'text' },
-                    options: {
-                        title: 'Daily Journal',
-                        acl_Guest: SharingPermissions.View,
-                    },
-                },
-            ],
-            // AARAV ADD //
         ]);
 
         const suffix = 'Proto';
@@ -677,7 +675,7 @@ export namespace Docs {
             // whatever options pertain to this specific prototype
             const options: DocumentOptions = {
                 isSystem: true,
-                _layout_fieldKey: 'layout',
+                layout_fieldKey: 'layout',
                 title,
                 type,
                 isBaseProto: true,
@@ -687,10 +685,11 @@ export namespace Docs {
                 layout: layout.view?.LayoutString(layout.dataField),
             };
             Object.entries(options)
-                .filter(pair => typeof pair[1] === 'string' && pair[1].startsWith('@'))
-                .forEach(pair => {
-                    if (!existing || ScriptCast(existing[pair[0]])?.script.originalScript !== pair[1].substring(1)) {
-                        (options as { [key: string]: unknown })[pair[0]] = ComputedField.MakeFunction(pair[1].substring(1));
+                .filter(([, val]) => (val as string)?.startsWith?.('@'))
+                .map(([key, val]) => [key, val as string])
+                .forEach(([key, val]) => {
+                    if (!existing || ScriptCast(existing[key])?.script.originalScript !== val.substring(1)) {
+                        options[key] = ComputedField.MakeFunction(val.substring(1));
                     }
                 });
             return Doc.assign(existing ?? new Doc(prototypeId, true), OmitKeys(options, Object.keys(existing ?? {})).omit as { [key: string]: FieldType }, undefined, true);
@@ -723,7 +722,7 @@ export namespace Docs {
          */
         function InstanceFromProto(proto: Doc, data: FieldType | undefined, options: DocumentOptions, delegId?: string, fieldKey: string = 'data', protoId?: string, placeholderDocIn?: Doc, noView?: boolean) {
             const placeholderDoc = placeholderDocIn;
-            const viewKeys = ['x', 'y', 'isSystem']; // keys that should be addded to the view document even though they don't begin with an "_"
+            const viewKeys = ['x', 'y', 'isSystem', 'overlayX', 'overlayY', 'zIndex', 'embedContainer']; // keys that should be addded to the view document even though they don't begin with an "_"
             const { omit: dataProps, extract: viewProps } = OmitKeys(options, viewKeys, '^_') as { omit: { [key: string]: FieldType | undefined }; extract: { [key: string]: FieldType | undefined } };
 
             // dataProps.acl_Override = SharingPermissions.Unset;
@@ -838,7 +837,7 @@ export namespace Docs {
             return TextDocument(RichTextField.textToRtf(text, img?.[Id]), {
                 title, //
                 _layout_autoHeight: true,
-                _layout_centered: true,
+                text_centered: true,
                 text_align: 'center',
                 _layout_fitWidth: true,
                 ...opts,
@@ -918,25 +917,58 @@ export namespace Docs {
             return InstanceFromProto(Prototypes.get(DocumentType.RTF), field, options, undefined, fieldKey);
         }
 
+        export function ScrapbookDocument(items: Doc[] = [], options: DocumentOptions = {}, fieldKey: string = 'items') {
+            return InstanceFromProto(
+                Prototypes.get(DocumentType.SCRAPBOOK),
+                new List<Doc>(items),
+                {
+                    title:
+                        options.title ??
+                        new Date().toLocaleDateString(undefined, {
+                            year: 'numeric',
+                            month: 'short',
+                            day: 'numeric',
+                        }),
+                    ...options,
+                },
+                undefined,
+                fieldKey
+            );
+        }
+
         // AARAV ADD //
 
         export function DailyJournalDocument(text: string | RichTextField, options: DocumentOptions = {}, fieldKey: string = 'text') {
-            const styles = {
-                bold: true, // Make the journal date bold
-                color: 'blue', // Set the journal date color to blue
-                fontSize: 18, // Set the font size to 18px for the whole text
-            };
+            // const getFormattedDate = () => {
+            //     const date = new Date().toLocaleDateString(undefined, {
+            //         weekday: 'long',
+            //         year: 'numeric',
+            //         month: 'long',
+            //         day: 'numeric',
+            //     });
+            //     return date;
+            // };
+
+            // const getDailyText = () => {
+            //     const placeholderText = 'Start writing here...';
+            //     const dateText = `${getFormattedDate()}`;
+
+            //     return RichTextField.textToRtfFormat(
+            //         [
+            //             { text: 'Journal Entry:', styles: { bold: true, color: 'black', fontSize: 20 } },
+            //             { text: dateText, styles: { italic: true, color: 'gray', fontSize: 15 } },
+            //             { text: placeholderText, styles: { fontSize: 14, color: 'gray' } },
+            //         ],
+            //         undefined,
+            //         placeholderText.length
+            //     );
+            // };
 
             return InstanceFromProto(
                 Prototypes.get(DocumentType.JOURNAL),
-                typeof text === 'string' ? RichTextField.textToRtf(text, undefined, styles, undefined) : text,
+                '',
                 {
-                    title: new Date().toLocaleDateString(undefined, {
-                        weekday: 'long',
-                        year: 'numeric',
-                        month: 'long',
-                        day: 'numeric',
-                    }),
+                    title: '',
                     ...options,
                 },
                 undefined,
@@ -966,26 +998,22 @@ export namespace Docs {
 
         export function InkDocument(points: PointData[], options: DocumentOptions = {}, strokeWidth: number, color: string, strokeBezier: string, fillColor: string, arrowStart: string, arrowEnd: string, dash: string, isInkMask: boolean) {
             const ink = InstanceFromProto(Prototypes.get(DocumentType.INK), '', { title: 'ink', ...options });
-            const I = Doc.GetProto(ink);
-            // I.layout_hideOpenButton = true; // don't show open full screen button when selected
-            I.color = color;
-            I.fillColor = fillColor && fillColor !== 'transparent' ? fillColor : undefined;
-            I.stroke = new InkField(points);
-            I.stroke_width = strokeWidth;
-            I.stroke_bezier = strokeBezier;
-            I.stroke_startMarker = arrowStart;
-            I.stroke_endMarker = arrowEnd;
-            I.stroke_dash = dash;
-            I.stroke_isInkMask = isInkMask;
-            I.text_align = 'center';
-            I.rotation = 0;
-            I.width_min = 1;
-            I.height_min = 1;
-            I.defaultDoubleClick = 'ignore';
-            I.author_date = new DateField();
-            I.acl_Guest = Doc.defaultAclPrivate ? SharingPermissions.None : SharingPermissions.View;
-            // I.acl_Override = SharingPermissions.Unset;
-            I[Initializing] = false;
+            ink.$color = color;
+            ink.$fillColor = fillColor && fillColor !== 'transparent' ? fillColor : undefined;
+            ink.$stroke = new InkField(points);
+            ink.$stroke_width = strokeWidth;
+            ink.$stroke_bezier = strokeBezier;
+            ink.$stroke_startMarker = arrowStart;
+            ink.$stroke_endMarker = arrowEnd;
+            ink.$stroke_dash = dash;
+            ink.$stroke_isInkMask = isInkMask;
+            ink.$text_align = 'center';
+            ink.$rotation = 0;
+            ink.$width_min = 1;
+            ink.$height_min = 1;
+            ink.$defaultDoubleClick = 'ignore';
+            ink.$author_date = new DateField();
+            ink.$acl_Guest = Doc.defaultAclPrivate ? SharingPermissions.None : SharingPermissions.View;
 
             return ink;
         }
@@ -1060,10 +1088,6 @@ export namespace Docs {
             return InstanceFromProto(Prototypes.get(DocumentType.COL), new List(documents), { ...options, _type_collection: CollectionViewType.Linear }, id);
         }
 
-        export function MapCollectionDocument(documents: Array<Doc>, options: DocumentOptions = {}) {
-            return InstanceFromProto(Prototypes.get(DocumentType.COL), new List(documents), { ...options, _type_collection: CollectionViewType.Map });
-        }
-
         export function CarouselDocument(documents: Array<Doc>, options: DocumentOptions) {
             return InstanceFromProto(Prototypes.get(DocumentType.COL), new List(documents), { ...options, _type_collection: CollectionViewType.Carousel });
         }
@@ -1132,8 +1156,8 @@ export namespace Docs {
             return InstanceFromProto(Prototypes.get(DocumentType.FONTICON), undefined, { ...(options || {}) });
         }
 
-        export function PresElementBoxDocument() {
-            return Prototypes.get(DocumentType.PRESELEMENT);
+        export function PresSlideDocument() {
+            return Prototypes.get(DocumentType.PRESSLIDE);
         }
 
         export function DataVizDocument(url: string, options?: DocumentOptions, overwriteDoc?: Doc) {
@@ -1141,7 +1165,7 @@ export namespace Docs {
         }
 
         export function AnnoPaletteDocument(options?: DocumentOptions) {
-            return InstanceFromProto(Prototypes.get(DocumentType.ANNOPALETTE), new List([Doc.MyStickers]), { ...(options || {}) });
+            return InstanceFromProto(Prototypes.get(DocumentType.ANNOPALETTE), new List([...(Doc.MyStickers ? [Doc.MyStickers] : [])]), { ...(options || {}) });
         }
 
         export function DockDocument(documents: Array<Doc>, config: string, options: DocumentOptions, id?: string) {
@@ -1151,9 +1175,5 @@ export namespace Docs {
         export function DelegateDocument(proto: Doc, options: DocumentOptions = {}) {
             return InstanceFromProto(proto, undefined, options);
         }
-
-        export function SimulationDocument(options?: DocumentOptions) {
-            return InstanceFromProto(Prototypes.get(DocumentType.SIMULATION), undefined, { ...(options || {}) });
-        }
     }
 }