add seach operator for complete annotation status (complete:true)

Author: dembim

core/api.ts

@@ -1,7 +1,7 @@
 // api.ts
 // implementation for the API
 
-import { config, emitter } from './commons.js';
+import { emitter, isAnnotated } from './commons.js';
 import type { Entry, Store, ToaduaConfig } from './commons.js';
 import { Search } from './search.js';
 import * as shared from '../frontend/shared/index.js';
@@ -15,9 +15,9 @@ import type { PresentedEntry } from './search.js';
 // Workaround for bcryptjs' broken types
 const bcrypt = bcryptjs as typeof bcryptjs_types;
 
-const PRONOMINAL_CLASSES = ['ho', 'maq', 'hoq', 'ta', 'raı'];
+export const PRONOMINAL_CLASSES = ['ho', 'maq', 'hoq', 'ta', 'raı'];
 
-const FRAMES = [
+export const FRAMES = [
 	'c',
 	'c c',
 	'c c c',
@@ -46,7 +46,7 @@ const FRAMES = [
 	'c c 2xx',
 ];
 
-const DISTRIBUTIONS = [
+export const DISTRIBUTIONS = [
 	'd',
 	'n',
 	'd d',
@@ -63,9 +63,16 @@ const DISTRIBUTIONS = [
 	'n n n',
 ];
 
-const SUBJECTS = ['agent', 'individual', 'event', 'predicate', 'shape', 'free'];
+export const SUBJECTS = [
+	'agent',
+	'individual',
+	'event',
+	'predicate',
+	'shape',
+	'free',
+];
 
-const FIXED_ANNOTATION_FIELDS = [
+export const FIXED_ANNOTATION_FIELDS = [
 	'pronominal_class',
 	'frame',
 	'distribution',
@@ -189,15 +196,10 @@ export class Api {
 	}
 
 	public async count(i: any, uname: string): Promise<ApiResponse> {
-		const count = this.store.db.entries.length;
-		const annotated = this.store.db.entries.filter(
-			e =>
-				(e.gloss || e.type === 'phrase') &&
-				(e.type === 'predicate' && e.body.includes('▯')
-					? FIXED_ANNOTATION_FIELDS.every(field => e[field])
-					: e.type),
-		).length;
-		return good({ count, annotated });
+		return good({
+			count: this.store.db.entries.length,
+			annotated: this.store.db.entries.filter(isAnnotated).length,
+		});
 	}
 
 	public async vote(i: any, uname: string): Promise<ApiResponse> {

core/commons.ts

@@ -7,6 +7,7 @@ import { existsSync, readFileSync } from 'node:fs';
 import * as yaml from 'js-yaml';
 import { EventEmitter } from 'node:events';
 import { cwd } from 'node:process';
+import { FIXED_ANNOTATION_FIELDS } from './api.js';
 
 const old_log = console.log;
 
@@ -47,6 +48,15 @@ export enum MatchMode {
 	Exact = 2,
 }
 
+export function isAnnotated(e: CommonEntry): boolean {
+	return (
+		(e.gloss || e.type === 'phrase') &&
+		(e.type === 'predicate' && e.body.includes('▯')
+			? FIXED_ANNOTATION_FIELDS.every(field => e[field])
+			: !!e.type)
+	);
+}
+
 export function deburrMatch(
 	what: string[],
 	where: string[],
@@ -118,27 +128,13 @@ export interface Note {
 	content: string;
 }
 
-export interface Entry {
-	/// An entry ID string like `AbCdEfGhI`.
-	id: string;
-	/// An ISO 8601 date string like `2022-12-28T21:38:31.682Z`.
-	date: string;
+export interface CommonEntry {
 	/// The Toaq word this entry is for.
 	head: string;
 	/// The gloss of the word.
 	gloss: string | undefined;
 	/// The definition of the word.
 	body: string;
-	/// The name of the user that added the entry.
-	user: string;
-	/// The scope (`en`, `toa`...) the entry is in.
-	scope: string;
-	/// Notes left on this entry.
-	notes: Note[];
-	/// Map from usernames to individual votes.
-	votes: Record<string, -1 | 0 | 1>;
-	/// Total score of the entry, aggregated from votes.
-	score: number;
 	/// The type of the entry, e.g. `"predicate"`.
 	type: string | undefined;
 	/// The pronominal class of the entry, e.g. `"maq"`.
@@ -151,6 +147,23 @@ export interface Entry {
 	subject: string | undefined;
 }
 
+export interface Entry extends CommonEntry {
+	/// An entry ID string like `AbCdEfGhI`.
+	id: string;
+	/// An ISO 8601 date string like `2022-12-28T21:38:31.682Z`.
+	date: string;
+	/// The name of the user that added the entry.
+	user: string;
+	/// The scope (`en`, `toa`...) the entry is in.
+	scope: string;
+	/// Notes left on this entry.
+	notes: Note[];
+	/// Map from usernames to individual votes.
+	votes: Record<string, -1 | 0 | 1>;
+	/// Total score of the entry, aggregated from votes.
+	score: number;
+}
+
 export interface Token {
 	/// Username the token is for.
 	name: string;

core/search.ts

@@ -11,7 +11,9 @@ import {
 	type Entry,
 	Note,
 	type Store,
+	isAnnotated,
 } from './commons.js';
+import { PRONOMINAL_CLASSES, SUBJECTS } from './api.js';
 
 // keep an own cache for entries
 interface CachedEntry {
@@ -67,9 +69,7 @@ export function extract_pronominal_class(notes: Note[]): string | undefined {
 				.normalize('NFD')
 				.replace(/[\u0300-\u036f]/g, '')
 				.replace('i', 'ı');
-			if (
-				['ho', 'maq', 'hoq', 'ta', 'raı', 'particle', 'phrase'].includes(value)
-			) {
+			if (PRONOMINAL_CLASSES.includes(value)) {
 				return value;
 			}
 		}
@@ -108,20 +108,12 @@ export function extract_distribution(notes: Note[]): string | undefined {
 }
 
 export function extract_subject(notes: Note[]): string | undefined {
-	const validSubjects = [
-		'agent',
-		'individual',
-		'event',
-		'predicate',
-		'shape',
-		'free',
-	];
 	for (let i = notes.length - 1; i >= 0; i--) {
 		const note = notes[i];
 		const match = note.content.toLowerCase().match(/subject\s*:\s*(.*)/);
 		if (match) {
 			const value = match[1].trim();
-			if (validSubjects.includes(value)) {
+			if (SUBJECTS.includes(value)) {
 				return value;
 			}
 		}
@@ -356,6 +348,14 @@ export class Search {
 					entry =>
 						uname ? (entry.$.votes[uname] || 0) === vote : false,
 			},
+			complete: {
+				type: OperationType.Other,
+				check: args => args.length === 1 && typeof args[0] === 'boolean',
+				build:
+					([b]) =>
+					entry =>
+						b === isAnnotated(entry.$),
+			},
 			before: {
 				type: OperationType.Other,
 				check: one_string,

frontend/App.vue

@@ -239,7 +239,7 @@
 				v-if="username"
 				style="float: right"
 				href="javascript:void(0)"
-				@click="navigate('pronoun:none')"
+				@click="navigate('complete:false')"
 				>help out</a
 			>
 		</span>

frontend/Result.vue

@@ -223,7 +223,12 @@ defineProps<{
 				spellcheck="true"
 				style="width: 100%; margin: 0"
 			></textarea>
-			<p v-else class="body" v-html="fancy_body" style="margin: 0"></p>
+			<p
+				v-else
+				class="body"
+				v-html="shared.replacements(new_body, false, false, theme)"
+				style="margin: 0"
+			></p>
 		</div>
 		<p v-else class="body" v-html="fancy_body"></p>
 
@@ -391,6 +396,8 @@ import * as shared from './shared/index';
 
 export default defineComponent({
 	methods: {
+		shared: () => shared,
+
 		score_color(score: number): string {
 			return shared.score_color(score, this.theme).css;
 		},

frontend/shared/index.ts

@@ -213,6 +213,8 @@ export function parse_query(query_string: string): {
 						parts[0],
 						['arity', 'myvote'].includes(parts[0])
 							? parseInt(parts[1], 10) || 0
+							: ['complete'].includes(parts[0])
+							? parts[1] === 'true'
 							: parts[1],
 					];
 			} else {