PocketBook/firebase-blueprint.json at main · devtmj1123/PocketBook · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
{
  "entities": {
    "userProfile": {
      "title": "UserProfile",
      "description": "User preferences, theme state, monthly income pools, and security PIN metadata.",
      "type": "object",
      "properties": {
        "uid": {
          "type": "string",
          "description": "Unique identifier of the verified user."
        },
        "email": {
          "type": "string",
          "description": "The user's registered email."
        },
        "displayName": {
          "type": "string",
          "description": "Display name of the user."
        },
        "theme": {
          "type": "string",
          "enum": ["light", "dark"],
          "description": "Visual visual theme toggle: light or dark."
        },
        "monthlyIncome": {
          "type": "number",
          "description": "Monthly incoming wage pool budget."
        },
        "encryptionCheck": {
          "type": "string",
          "description": "A check-key encrypted with the cryptographic PIN to verify decryption feasibility."
        },
        "salt": {
          "type": "string",
          "description": "The salt string used in PIN PBKDF2 derivative operations client-side."
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": ["uid", "email", "theme", "monthlyIncome"]
    },
    "transaction": {
      "title": "Transaction",
      "description": "A ledger checkout item. Sensitive fields may be encrypted.",
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "title": { "type": "string", "description": "Title, potentially AES-encrypted text string." },
        "amount": { "type": "number" },
        "category": { "type": "string" },
        "date": { "type": "string" },
        "tag": { "type": "string" },
        "notes": { "type": "string", "description": "Extended notes, potentially AES-encrypted text string." },
        "encrypted": { "type": "boolean", "description": "Flag indicating if title/notes are client-side encrypted." },
        "updatedAt": { "type": "string", "format": "date-time" }
      },
      "required": ["id", "title", "amount", "category", "date", "tag"]
    },
    "budget": {
      "title": "Budget",
      "description": "Aggregated category limits and expenditures.",
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "category": { "type": "string" },
        "limit": { "type": "number" },
        "spent": { "type": "number" },
        "updatedAt": { "type": "string", "format": "date-time" }
      },
      "required": ["id", "category", "limit", "spent"]
    },
    "savingsGoal": {
      "title": "SavingsGoal",
      "description": "Funding objectives and timelines. Sensitive fields may be encrypted.",
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "name": { "type": "string", "description": "Target name, potentially encrypted." },
        "target": { "type": "number" },
        "current": { "type": "number" },
        "targetDate": { "type": "string" },
        "description": { "type": "string", "description": "Description paragraph, potentially encrypted." },
        "encrypted": { "type": "boolean" },
        "updatedAt": { "type": "string", "format": "date-time" }
      },
      "required": ["id", "name", "target", "current", "targetDate"]
    },
    "note": {
      "title": "Note",
      "description": "Rich client notepad layout. Each block or final note state is encrypted if requested.",
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "title": { "type": "string", "description": "Page title, potentially encrypted." },
        "blocksJson": { "type": "string", "description": "JSON serialized notes blocks, potentially encrypted." },
        "tags": { "type": "array" },
        "encrypted": { "type": "boolean" },
        "updatedAt": { "type": "string", "format": "date-time" }
      },
      "required": ["id", "title", "blocksJson", "tags"]
    },
    "task": {
      "title": "Task",
      "description": "Schedule todo milestones.",
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "title": { "type": "string", "description": "Task label, potentially encrypted." },
        "completed": { "type": "boolean" },
        "dueDate": { "type": "string" },
        "amount": { "type": "number" },
        "category": { "type": "string" },
        "encrypted": { "type": "boolean" },
        "updatedAt": { "type": "string", "format": "date-time" }
      },
      "required": ["id", "title", "completed", "dueDate"]
    },
    "event": {
      "title": "Event",
      "description": "A calendar schedule event.",
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "title": { "type": "string", "description": "Event label, potentially encrypted." },
        "date": { "type": "string" },
        "amount": { "type": "number" },
        "type": { "type": "string", "enum": ["income", "expense", "reminder"] },
        "notes": { "type": "string", "description": "Context memo details, potentially encrypted." },
        "completed": { "type": "boolean" },
        "encrypted": { "type": "boolean" },
        "updatedAt": { "type": "string", "format": "date-time" }
      },
      "required": ["id", "title", "date", "type"]
    },
    "appNotification": {
      "title": "AppNotification",
      "description": "Real-time alerts and notification reminders",
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "title": { "type": "string", "description": "Alert title, potentially encrypted." },
        "message": { "type": "string", "description": "Notification details message, potentially encrypted." },
        "type": { "type": "string", "enum": ["reminder", "task", "event", "system"] },
        "date": { "type": "string" },
        "read": { "type": "boolean" },
        "referenceId": { "type": "string" },
        "encrypted": { "type": "boolean" }
      },
      "required": ["id", "title", "message", "type", "date", "read"]
    }
  },
  "firestore": {
    "/users/{userId}": {
      "schema": "userProfile",
      "description": "User specific accounts, preferences, income configuration, and salt vectors."
    },
    "/users/{userId}/transactions/{transactionId}": {
      "schema": "transaction",
      "description": "Transactional financial transactions for ledgers."
    },
    "/users/{userId}/budgets/{budgetId}": {
      "schema": "budget",
      "description": "Allocated limits for categories."
    },
    "/users/{userId}/savingsGoals/{goalId}": {
      "schema": "savingsGoal",
      "description": "Tracking goals and milestones."
    },
    "/users/{userId}/notes/{noteId}": {
      "schema": "note",
      "description": "Shared notebook entries."
    },
    "/users/{userId}/tasks/{taskId}": {
      "schema": "task",
      "description": "General financial/action items to check."
    },
    "/users/{userId}/events/{eventId}": {
      "schema": "event",
      "description": "Upcoming scheduled cash clearance dates."
    },
    "/users/{userId}/notifications/{notificationId}": {
      "schema": "appNotification",
      "description": "Triggered task deadlines and bill reminder alerts."
    }
  }
}