From 1e93d560a142dfa71c85a2189f2bf550017df183 Mon Sep 17 00:00:00 2001
From: ericscheid <ericscheid@users.noreply.github.com>
Date: Wed, 7 Feb 2024 12:21:42 +1100
Subject: [PATCH] Updated Folders etc (markdown)

---
 Folders-etc.md | 33 ++++++++++++++++++++-------------
 1 file changed, 20 insertions(+), 13 deletions(-)

diff --git a/Folders-etc.md b/Folders-etc.md
index a74ce19..4e030e2 100644
--- a/Folders-etc.md
+++ b/Folders-etc.md
@@ -57,9 +57,10 @@ Sub-folders are linked via a list of subfolderIds, in the same manner as how bre
 - `brewIds` (list of shareId)
 - `CreatedAt` (auto)
 - `UpdatedAt` (auto)
+- `isPublished` (boolean, or later: published/unpublished/hidden)
 
 #### More substantial data structure
-![ERD of folders, users, and brews](https://github.com/naturalcrit/homebrewery/assets/2605467/03b4a90b-3c7f-4923-91db-dc77264473fd)
+![ERD of folders, users, and brews](https://github.com/naturalcrit/homebrewery/assets/2605467/f399874c-b3d1-4233-a0a6-714a2eb67298)
 
 These folders should be displayed in the user page of the author of such folder <!-- could be a good idea to be able to copy someone else's folder, which should only copy published brews -->, opening the folder would bring the user to another page with the content of the folder displayed as if it was a user page.
 
@@ -74,7 +75,7 @@ So all unpublished files will still be invisible to unauthored accounts<!--altho
 
 are private folders publicly viewable?
 
-- thumnails
+- thumbnails
 - tags
 - view counts (useless?)
 - systems
@@ -96,17 +97,23 @@ We do want to facilitate sharing of folder views. That is, a user could share `/
 
 ### Data structure
 
-- parent folder (nanoid, optional)
-- password (string, optional, hashed)
-- view-count (integer, auto)
-- icon or image (string, optional) (#240)
-- styling (css-text-block, optional) (#240, #1843)
-- folder type (smart/dumb) ??
-- smart-rules (???)
-- tags
-- description
-- brewCount
-- authors
+Add these to the minimal data structure (above)
+
+- `description`
+- `tags`
+- `password` (string, optional, hashed)
+- `icon` or `image` (uri-string, optional) (#240)
+- `styling` (css-text-block, optional) (#240, #1843) ??
+- `background` (uri-string or color-code-string, optional)
+- `subFolderIds` [list of nanoids)
+- `pinnedBrewId` - one brew of `brewIds` which appears at top of folder, regardless of sort order
+
+- folder type (smart/dumb) ?? -- _or: absence of smart rules ⇒ dumb folder_
+- smart-rules
+- ~~authors~~ -- _brews have author(s), but folders are owner-specific_
+- ~~view-count (integer, auto)~~ -- _views are a in-browser experience only, no server hits involved, so no count to accumulate_
+- ~~`brewCount`~~ -- _can/should be calculated on the fly though_
+- ~~`folderCount`~~ -- _can/should be calculated on the fly though_