Merge pull request #26 from wellmaintained/feature/decision-notes

mrdavidlaing · web-flow · commit fc3731d02028 · 2025-03-28T22:03:57.000Z
feature: Decision notes
diff --git a/components/decision-summary.tsx b/components/decision-summary.tsx
@@ -92,6 +92,15 @@ export function DecisionSummary({
           </div>
         )}
 
+        {decision.decisionNotes && !compact && (
+          <div className="space-y-2">
+            <h3 className="text-muted-foreground">Notes</h3>
+            <div className="prose prose-sm dark:prose-invert max-w-none">
+              <TipTapView content={decision.decisionNotes} />
+            </div>
+          </div>
+        )}
+
         {!compact && (
           <div className="grid grid-cols-2 gap-4 pt-4 border-t">
             <div className="space-y-2">
diff --git a/components/tiptap-editor.tsx b/components/tiptap-editor.tsx
@@ -14,14 +14,21 @@ import {
   TooltipProvider,
   TooltipTrigger,
 } from '@/components/ui/tooltip'
+import { cn } from "@/lib/utils"
 
 interface TipTapEditorProps {
   content: string
   onChange: (content: string) => void
   className?: string
+  minimal?: boolean
 }
 
-export function TipTapEditor({ content, onChange, className = '' }: TipTapEditorProps) {
+const getEditorClassNames = (minimal: boolean) => cn(
+  'prose prose-sm dark:prose-invert focus:outline-none max-w-none',
+  minimal ? 'p-2' : 'p-4 min-h-[200px]'
+);
+
+export function TipTapEditor({ content, onChange, className = '', minimal = false }: TipTapEditorProps) {
   const [isFocused, setIsFocused] = React.useState(false);
   const [isRawMode, setIsRawMode] = React.useState(false);
   const [rawMarkdown, setRawMarkdown] = React.useState(content || '');
@@ -53,7 +60,7 @@ export function TipTapEditor({ content, onChange, className = '' }: TipTapEditor
     },
     editorProps: {
       attributes: {
-        class: 'prose prose-sm dark:prose-invert focus:outline-none max-w-none p-4 min-h-[200px]'
+        class: getEditorClassNames(minimal)
       }
     },
     onFocus: () => setIsFocused(true),
@@ -173,35 +180,42 @@ export function TipTapEditor({ content, onChange, className = '' }: TipTapEditor
   ];
 
   return (
-    <Card className={`min-h-[300px] ${className}`}>
-      <div className="flex items-center gap-1 border-b p-2">
-        <TooltipProvider>
-          {tools
-            .filter(tool => isRawMode ? tool.showInRawMode : true)
-            .map((Tool) => (
-              <Tooltip key={Tool.title}>
-                <TooltipTrigger asChild>
-                  <Button 
-                    variant={Tool.isActive() ? "secondary" : "ghost"} 
-                    size="icon" 
-                    className="h-8 w-8"
-                    onClick={Tool.action}
-                    title={Tool.title}
-                  >
-                    <Tool.icon className="h-4 w-4" />
-                  </Button>
-                </TooltipTrigger>
-                <TooltipContent>{Tool.title}</TooltipContent>
-              </Tooltip>
-            ))}
-        </TooltipProvider>
-      </div>
+    <Card className={cn(
+      minimal ? 'min-h-0 border-0 shadow-none bg-transparent' : 'min-h-[300px]',
+      className
+    )}>
+      {!minimal && (
+        <div className="flex items-center gap-1 border-b p-2">
+          <TooltipProvider>
+            {tools
+              .filter(tool => isRawMode ? tool.showInRawMode : true)
+              .map((Tool) => (
+                <Tooltip key={Tool.title}>
+                  <TooltipTrigger asChild>
+                    <Button
+                      variant={Tool.isActive() ? "secondary" : "ghost"}
+                      size="icon"
+                      className="h-8 w-8"
+                      onClick={Tool.action}
+                      title={Tool.title}
+                    >
+                      <Tool.icon className="h-4 w-4" />
+                    </Button>
+                  </TooltipTrigger>
+                  <TooltipContent>{Tool.title}</TooltipContent>
+                </Tooltip>
+              ))}
+          </TooltipProvider>
+        </div>
+      )}
       
       {isRawMode ? (
         <Textarea
           value={rawMarkdown}
           onChange={handleRawMarkdownChange}
-          className="min-h-[200px] resize-none border-none rounded-none focus-visible:ring-0 p-4 font-mono text-sm"
+          className={`resize-none border-none rounded-none focus-visible:ring-0 p-4 font-mono text-sm ${
+            minimal ? 'min-h-0' : 'min-h-[200px]'
+          }`}
           placeholder="Enter markdown here..."
         />
       ) : (
diff --git a/components/workflow/WorkflowAccordion.tsx b/components/workflow/WorkflowAccordion.tsx
@@ -90,6 +90,7 @@ export default function WorkflowAccordion({
     removeStakeholder,
     updateStakeholders,
     publishDecision,
+    updateDecisionNotes,
   } = useDecision(decisionId, organisationId)
 
   const {
@@ -457,25 +458,42 @@ export default function WorkflowAccordion({
     if (step.key === 'choose' && decision) {
       return (
         <div className="space-y-8">
+          <div className="space-y-4">
+            <h2 className="text-xl text-muted-foreground">Notes</h2>
+            <TipTapEditor
+              content={decision.decisionNotes || ""}
+              onChange={(content) => updateDecisionNotes(content)}
+            />
+          </div>
+
           <DecisionRelationshipsList
             relationshipType="blocked_by"
             fromDecision={decision}
             title="Blocked By Decision(s)"
           />
 
-          <div className="space-y-4">
-            <h2 className="text-xl text-muted-foreground">Decision</h2>
-            <TipTapEditor 
-              content={decision.decision || ""}
-              onChange={(content) => updateDecisionContent(content)}
-            />
-          </div>
-
-          <SupportingMaterialsList 
+          <SupportingMaterialsList
             materials={decision.supportingMaterials}
             onAdd={addSupportingMaterial}
             onRemove={removeSupportingMaterial}
           />
+
+          <div className="space-y-4">
+            <div className="flex items-center gap-2">
+              <h2 className="text-xl text-muted-foreground">Decision</h2>
+              <span className="text-sm text-muted-foreground">
+                - state your decision concisely in 1-2 sentences
+              </span>
+            </div>
+            <div className="rounded-md border">
+              <TipTapEditor
+                content={decision.decision || ""}
+                onChange={(content) => updateDecisionContent(content)}
+                className="prose-sm min-h-[4rem] max-h-[8rem] overflow-y-auto"
+                minimal
+              />
+            </div>
+          </div>
         </div>
       )
     }
diff --git a/hooks/useDecisions.ts b/hooks/useDecisions.ts
@@ -225,6 +225,23 @@ export function useDecision(decisionId: string, organisationId: string) {
     }
   };
 
+  /**
+   * Updates the notes associated with a decision
+   * @param decisionNotes - The new notes content in HTML format
+   * @throws {Error} If the update fails or if no decision is loaded
+   */
+  const updateDecisionNotes = async (decisionNotes: string) => {
+    try {
+      if (!decision) return;
+      await decisionsRepository.update(
+        decision.with({ decisionNotes }),
+      );
+    } catch (error) {
+      setError(error as Error);
+      throw error;
+    }
+  };
+
   return {
     decision,
     loading,
@@ -243,5 +260,6 @@ export function useDecision(decisionId: string, organisationId: string) {
     addSupportingMaterial,
     removeSupportingMaterial,
     publishDecision,
+    updateDecisionNotes,
   };
 }
diff --git a/lib/domain/Decision.ts b/lib/domain/Decision.ts
@@ -115,6 +115,7 @@ export type DecisionProps = {
   teamIds: string[];
   projectIds: string[];
   relationships?: DecisionRelationshipMap;
+  decisionNotes?: string;
 };
 
 export class Decision {
@@ -175,6 +176,10 @@ export class Decision {
   @IsOptional()
   readonly relationships?: DecisionRelationshipMap;
 
+  @IsOptional()
+  @IsString()
+  readonly decisionNotes?: string;
+
   toDocumentReference(): DocumentReference {
     return {
       id: this.id,
@@ -368,6 +373,7 @@ export class Decision {
     this.teamIds = props.teamIds || [];
     this.projectIds = props.projectIds || [];
     this.relationships = props.relationships;
+    this.decisionNotes = props.decisionNotes;
     this.validate();
   }
 
diff --git a/lib/infrastructure/firestoreDecisionsRepository.ts b/lib/infrastructure/firestoreDecisionsRepository.ts
@@ -55,6 +55,7 @@ export class FirestoreDecisionsRepository implements DecisionsRepository {
       teamIds: data.teamIds || [],
       projectIds: data.projectIds || [],
       relationships: data.relationships || {},
+      decisionNotes: data.decisionNotes || '',
     };
     return Decision.create(props);
   }
@@ -94,10 +95,10 @@ export class FirestoreDecisionsRepository implements DecisionsRepository {
     return this.decisionFromFirestore(docSnap)
   }
 
-  async create(initialData: Partial<Omit<DecisionProps, "id">>, scope: DecisionScope): Promise<Decision> {
+  async create(scope: DecisionScope, initialData: Partial<DecisionProps> = {}): Promise<Decision> {
     const docRef = doc(collection(db, this.getDecisionPath(scope)))
 
-    const createData: Record<string, string | string[] | null | FieldValue | Record<string, unknown> | DecisionStakeholderRole[] | SupportingMaterial[]> = {
+    const data: Record<string, string | string[] | null | FieldValue | Record<string, unknown> | DecisionStakeholderRole[] | SupportingMaterial[]> = {
       title: initialData.title ?? '',
       description: initialData.description ?? '',
       cost: initialData.cost ?? 'low',
@@ -110,16 +111,17 @@ export class FirestoreDecisionsRepository implements DecisionsRepository {
       organisationId: scope.organisationId,
       teamIds: initialData.teamIds ?? [],
       projectIds: initialData.projectIds ?? [],
+      decisionNotes: initialData.decisionNotes ?? '',
       createdAt: serverTimestamp(),
       updatedAt: serverTimestamp(),
     }
 
     // Filter out any undefined values
-    const filteredCreateData = Object.fromEntries(
-      Object.entries(createData).filter(([, value]) => value !== undefined)
+    const filteredData = Object.fromEntries(
+      Object.entries(data).filter(([, value]) => value !== undefined)
     );
 
-    await setDoc(docRef, filteredCreateData)
+    await setDoc(docRef, filteredData)
 
     return this.getById(docRef.id, scope)
   }
@@ -131,7 +133,7 @@ export class FirestoreDecisionsRepository implements DecisionsRepository {
 
     const docRef = doc(db, this.getDecisionPath(scope), decision.id)
 
-    const updateData: Record<string, FieldValue | Partial<unknown> | undefined> = {
+    const data: Record<string, FieldValue | Partial<unknown> | undefined> = {
       title: decision.title,
       description: decision.description,
       cost: decision.cost,
@@ -145,15 +147,16 @@ export class FirestoreDecisionsRepository implements DecisionsRepository {
       teamIds: decision.teamIds,
       projectIds: decision.projectIds,
       publishDate: decision.publishDate,
+      decisionNotes: decision.decisionNotes,
       updatedAt: serverTimestamp()
     }
 
     // Filter out any undefined values
-    const filteredUpdateData = Object.fromEntries(
-      Object.entries(updateData).filter(([, value]) => value !== undefined)
+    const filteredData = Object.fromEntries(
+      Object.entries(data).filter(([, value]) => value !== undefined)
     );
 
-    await updateDoc(docRef, filteredUpdateData)
+    await updateDoc(docRef, filteredData)
   }
 
   async delete(id: string, scope: DecisionScope): Promise<void> {
