315 lines
11 KiB
TypeScript
315 lines
11 KiB
TypeScript
import Dexie, { type Table } from 'dexie';
|
|
|
|
import type { key_val } from '../ae_stores';
|
|
|
|
// li = list
|
|
// kv = key value list
|
|
// json = JSON string
|
|
// ux = user experience (mode)
|
|
// LLM = Large Language Model (AI)
|
|
// Updated 2025-03-15
|
|
|
|
|
|
export interface Journal {
|
|
id: string; // actually "id_random"
|
|
journal_id: string;
|
|
|
|
// Essentially this is a change log of journals
|
|
snapshot_id?: string; // This is the original journal ID. If deleted, then delete all children journals.
|
|
previous_id?: null|string; // This is the old or parent journal ID
|
|
next_id?: null|string; // This is the new or child journal ID
|
|
|
|
external_id?: null|string;
|
|
import_id?: null|string;
|
|
code?: null|string;
|
|
|
|
for_type?: null|string;
|
|
for_id?: null|string;
|
|
|
|
// template?: null|boolean; // Is this a template journal? If true, it can be used to create new journals.
|
|
|
|
type_code?: null|string;
|
|
|
|
account_id?: null|string; // Owner account of the journal
|
|
person_id?: null|string; // Owner person of the journal
|
|
// event_id?: null|string; // Assign to an event???
|
|
// location_id?: null|string; // Assign to a location???
|
|
|
|
name: string; // or the title
|
|
short_name?: null|string; // Short name for the journal, if any. Used for display purposes.
|
|
summary?: null|string; // LLM (AI) generated summary...???
|
|
outline?: null|string; // LLM (AI) generated outline...???
|
|
|
|
description?: null|string;
|
|
description_html?: null|string;
|
|
description_json?: null|string;
|
|
|
|
start_datetime?: null|Date;
|
|
end_datetime?: null|Date;
|
|
timezone?: null|string;
|
|
|
|
alert?: null|boolean; // LLM (AI) generated summary...???
|
|
alert_msg?: null|string; // LLM (AI) generated summary...???
|
|
|
|
sort_by?: null|string; // This is the sort by field
|
|
sort_by_desc?: null|string; // This is the sort by field description
|
|
|
|
cfg_json?: null|key_val; // This is the configuration JSON for the journal
|
|
|
|
data_json?: null|string; // We always need to store something extra...
|
|
|
|
ux_mode?: null|string; // 'mobile' or 'desktop'
|
|
|
|
// This only allows for basic access to the data.
|
|
passcode_read?: null|string; // For LLM (AI) generated summary...???
|
|
passcode_read_expire?: null|Date;
|
|
passcode_write?: null|string;
|
|
passcode_write_expire?: null|Date
|
|
|
|
passcode?: null|string;
|
|
passcode_timeout?: null|number; // Timeout in seconds
|
|
|
|
enable: null|boolean;
|
|
hide?: null|boolean;
|
|
priority?: null|boolean
|
|
sort?: null|number;
|
|
group?: null|string;
|
|
notes?: null|string;
|
|
created_on: Date;
|
|
updated_on?: null|Date;
|
|
|
|
// Additional fields for convenience (database views)
|
|
file_count?: null|number; // Only files directly under a journal
|
|
journal_file_id_li_json?: null|string;
|
|
|
|
// One person
|
|
person__given_name?: null|string;
|
|
person__family_name?: null|string;
|
|
person__full_name?: null|string;
|
|
person__primary_email?: null|string;
|
|
person__passcode?: null|string;
|
|
|
|
// JSON formatted key value pairs for multiple people: {id: name, email, etc.}
|
|
person__kv_json?: null|string;
|
|
|
|
journal_name?: null|string;
|
|
|
|
journal_location_code?: null|string;
|
|
journal_location_name?: null|string;
|
|
|
|
journal_entry_count?: null|number;
|
|
|
|
// A key value list of the entries
|
|
journal_entry_kv?: null|key_val;
|
|
journal_entry_li?: null|[];
|
|
// A key value list of the files
|
|
journal_file_kv?: null|key_val;
|
|
journal_file_li?: null|[];
|
|
|
|
// journal_collection_id?: null|string; // For a collection of journals?
|
|
|
|
// Future standard fields!!!
|
|
obj_id?: null|string;
|
|
obj_ext_uid?: null|string; // Probably not needed for journals
|
|
obj_ext_id?: null|string; // Probably not needed for journals
|
|
obj_import_id?: null|string; // Probably not needed for journals
|
|
obj_code?: null|string;
|
|
obj_account_id?: null|string;
|
|
obj_passcode?: null|string;
|
|
obj_type?: null|string; // Should always be 'journal' in this case
|
|
obj_type_ver_id?: null|string; // The ID from the table for the object type
|
|
obj_name?: null|string;
|
|
obj_summary?: null|string; // LLM (AI) generated summary...???
|
|
obj_outline?: null|string; // LLM (AI) generated outline...???
|
|
obj_description?: null|string; // Probably not needed for journals
|
|
obj_enable?: null|boolean;
|
|
obj_enable_on?: null|Date;
|
|
obj_archive_on?: null|Date;
|
|
obj_hide?: null|boolean;
|
|
obj_priority?: null|number;
|
|
obj_sort?: null|number;
|
|
obj_group?: null|string;
|
|
obj_cfg_json?: null|string;
|
|
obj_notes?: null|string;
|
|
obj_created_on?: Date;
|
|
obj_updated_on?: null|Date;
|
|
}
|
|
|
|
|
|
// Updated 2025-03-15
|
|
export interface Journal_Entry {
|
|
id: string; // actually "id_random"
|
|
journal_entry_id: string;
|
|
|
|
// journal_id: string; // This is the parent journal ID. If deleted, then delete all children journal entries.
|
|
|
|
// Essentially this is a change log of journal entries
|
|
snapshot_id?: string; // This is the original journal ID. If deleted, then delete all children journal entries.
|
|
previous_id?: null|string; // This is the old or parent journal ID
|
|
next_id?: null|string; // This is the new or child journal ID
|
|
|
|
external_id?: null|string;
|
|
import_id?: null|string;
|
|
code?: null|string;
|
|
|
|
for_type?: null|string;
|
|
for_id?: null|string;
|
|
|
|
template?: null|boolean; // Is this a template journal entry? If true, it can be used to create new journal entries.
|
|
|
|
activity_code?: null|string;
|
|
category_code?: null|string;
|
|
topic_code?: null|string;
|
|
type_code?: null|string;
|
|
tags?: null|string; // Comma separated tags
|
|
|
|
journal_entry_type?: null|string; // This is the type of journal entry
|
|
|
|
account_id?: null|string; // Owner account of the journal
|
|
person_id?: null|string; // Owner person of the journal
|
|
// event_id?: null|string; // Assign to an event???
|
|
// location_id?: null|string; // Assign to a location???
|
|
|
|
public?: null|boolean;
|
|
private?: null|boolean;
|
|
personal?: null|boolean;
|
|
professional?: null|boolean;
|
|
|
|
name: string; // or the title
|
|
short_name?: null|string; // Short name for the journal entry, if any. Used for display purposes. Most likely for the templates list.
|
|
summary?: null|string; // LLM (AI) generated summary...???
|
|
outline?: null|string; // LLM (AI) generated outline...???
|
|
// description?: null|string; // This is the description of the journal entry
|
|
|
|
content?: null|string;
|
|
content_md_html?: null|string; // Markdown converted to HTML based on content
|
|
content_html?: null|string;
|
|
content_json?: null|string;
|
|
|
|
start_datetime?: null|Date;
|
|
end_datetime?: null|Date;
|
|
timezone?: null|string;
|
|
seconds?: null|number; // Duration in seconds
|
|
|
|
location?: null|string; // Location of the journal entry
|
|
latitude?: null|number; // Latitude of the journal entry
|
|
longitude?: null|number; // Longitude of the journal entry
|
|
|
|
billable?: null|boolean; // Is this billable?
|
|
bill_to?: null|string; // Who to bill for this journal entry
|
|
bill_rate?: null|number; // Rate to bill for this journal entry
|
|
billable_minutes?: null|number; // Billable minutes for this journal entry
|
|
|
|
alert?: null|boolean; // LLM (AI) generated summary...???
|
|
alert_msg?: null|string; // LLM (AI) generated summary...???
|
|
|
|
parent_id?: null|string; // This is the parent journal entry ID. If deleted, then delete all children journal entries.
|
|
related_entry_id_li?: null|key_val; // List of related journal entry IDs
|
|
|
|
// cfg_json?: null|key_val; // This is the configuration JSON for the journal entry
|
|
data_json?: null|string; // We always need to store something extra...
|
|
|
|
// This only allows for basic access to the content.
|
|
passcode_read?: null|string; // For LLM (AI) generated summary...???
|
|
passcode_read_expire?: null|Date;
|
|
passcode_write?: null|string;
|
|
passcode_write_expire?: null|Date
|
|
|
|
enable: null|boolean;
|
|
hide?: null|boolean;
|
|
priority?: null|boolean
|
|
sort?: null|number;
|
|
group?: null|string;
|
|
notes?: null|string;
|
|
created_on: Date;
|
|
updated_on?: null|Date;
|
|
|
|
// Generated fields for sorting locally only
|
|
tmp_sort_1?: null|string;
|
|
tmp_sort_2?: null|string;
|
|
|
|
// Additional fields for convenience (database views)
|
|
file_count?: null|number; // Only files directly under a journal
|
|
journal_file_id_li_json?: null|string;
|
|
|
|
journal_code?: null|string; // This is the code for the journal entry
|
|
journal_name?: null|string; // This is the name for the journal entry
|
|
|
|
// One person
|
|
person__given_name?: null|string;
|
|
person__family_name?: null|string;
|
|
person__full_name?: null|string;
|
|
person__primary_email?: null|string;
|
|
person__passcode?: null|string;
|
|
|
|
// JSON formatted key value pairs for multiple people: {id: name, email, etc.}
|
|
person__kv_json?: null|string;
|
|
|
|
// A key value list of the files
|
|
journal_file_kv?: null|key_val;
|
|
journal_file_li?: null|[];
|
|
|
|
// journal_collection_id?: null|string; // For a collection of journal entries?
|
|
|
|
// Future standard fields!!!
|
|
obj_id?: null|string;
|
|
obj_ext_uid?: null|string; // Probably not needed for journal entries
|
|
obj_ext_id?: null|string; // Probably not needed for journal entries
|
|
obj_import_id?: null|string; // Probably not needed for journal entries
|
|
obj_code?: null|string;
|
|
obj_account_id?: null|string;
|
|
obj_passcode?: null|string;
|
|
obj_type?: null|string; // Should always be 'journal' in this case
|
|
obj_type_ver_id?: null|string; // The ID from the table for the object type
|
|
obj_name?: null|string;
|
|
obj_summary?: null|string; // LLM (AI) generated summary...???
|
|
obj_outline?: null|string; // LLM (AI) generated outline...???
|
|
obj_description?: null|string; // Probably not needed for journal entries
|
|
obj_enable?: null|boolean;
|
|
obj_enable_on?: null|Date;
|
|
obj_archive_on?: null|Date;
|
|
obj_hide?: null|boolean;
|
|
obj_priority?: null|number;
|
|
obj_sort?: null|number;
|
|
obj_group?: null|string;
|
|
obj_cfg_json?: null|string;
|
|
obj_notes?: null|string;
|
|
obj_created_on?: Date;
|
|
obj_updated_on?: null|Date;
|
|
}
|
|
|
|
|
|
// Updated 2024-06-10
|
|
export class MySubClassedDexie extends Dexie {
|
|
// We just tell the typing system this is the case
|
|
journal!: Table<Journal>;
|
|
journal_entry!: Table<Journal_Entry>;
|
|
|
|
constructor() {
|
|
super('ae_journals_db');
|
|
this.version(1).stores({
|
|
journal: `
|
|
id, journal_id,
|
|
code,
|
|
account_id,
|
|
conference, type,
|
|
name,
|
|
start_datetime, end_datetime,
|
|
timezone,
|
|
enable, hide, priority, sort, group, notes, created_on, updated_on`,
|
|
journal_entry: `
|
|
id, journal_entry_id,
|
|
journal_id,
|
|
code,
|
|
account_id,
|
|
template,
|
|
name,
|
|
start_datetime, end_datetime,
|
|
timezone,
|
|
enable, hide, priority, sort, group, notes, created_on, updated_on`,
|
|
});
|
|
}
|
|
}
|
|
|
|
export const db_journals = new MySubClassedDexie();
|