zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-07 19:26:12 +08:00
Code Issues Projects Releases Packages Wiki Activity

refactor(note_create): clarify type system

Browse source
This commit is contained in:
Jakob Schlanstedt 2025-10-22 01:12:56 +02:00 • committed by Jakob Schlanstedt
parent 24fe34aeaf
commit f38ff2340c
1 changed files with 24 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
apps/client/src/services/note_create.ts
View file

@ -21,6 +21,29 @@ export enum CreateNoteTarget {
IntoInbox,
}
/**
* validation of note creation options through type checking.
*
* If the typechecking returns no errors, then the inputs create a valid state,
* but only if the types are defined semantically correct.
*
* These definitions use discriminated unions (`BaseCreateNoteOpts`) built from composable
* `type` aliases (not `interface`) to ensure that only *logically valid* configurations
* of creation parameters can exist at compile time.
*
* Through the Curry–Howard correspondence, this acts as a lightweight proof system:
* if the code type-checks, then the provided options represent a valid state
* for note creation — i.e. the combination of fields cannot express an invalid
* or contradictory configuration.
*
* In other words:
* - Each variant of `BaseCreateNoteOpts` encodes one valid semantic path.
* - The type system statically eliminates impossible states.
* - The runtime logic can therefore assume the input is internally consistent.
*
* This is why `type` is used instead of `interface`: the goal is type-level proof
* of validity.
*/
export type BaseCreateNoteOpts =
| ({
promptForType: true;
@ -31,7 +54,7 @@ export type BaseCreateNoteOpts =
type?: string;
} & BaseCreateNoteSharedOpts);
export interface BaseCreateNoteSharedOpts {
export type BaseCreateNoteSharedOpts = {
target: CreateNoteTarget;
isProtected?: boolean;
saveSelection?: boolean;
@ -63,7 +86,6 @@ type CreateNoteSiblingURLOpts = Omit<CreateNoteAtURLOpts, "targetBranchId"> & {
export type CreateNoteBeforeURLOpts = CreateNoteSiblingURLOpts;
export type CreateNoteAfterURLOpts = CreateNoteSiblingURLOpts;
// For creating *in the inbox*
export type CreateNoteIntoInboxURLOpts = BaseCreateNoteSharedOpts & {
// disallowed
parentNoteUrl?: never;